Whamcloud - gitweb
LU-5654 osp: Call obd_fid_fini() on osp_init0() error path
[fs/lustre-release.git] / lustre / osp / osp_dev.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2012, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/osp/osp_dev.c
37  *
38  * Author: Alex Zhuravlev <alexey.zhuravlev@intel.com>
39  * Author: Mikhail Pershin <mike.pershin@intel.com>
40  * Author: Di Wang <di.wang@intel.com>
41  */
42 /*
43  * The Object Storage Proxy (OSP) module provides an implementation of
44  * the DT API for remote MDTs and OSTs. Every local OSP device (or
45  * object) is a proxy for a remote OSD device (or object). Thus OSP
46  * converts DT operations into RPCs, which are sent to the OUT service
47  * on a remote target, converted back to DT operations, and
48  * executed. Of course there are many ways in which this description
49  * is inaccurate but it's a good enough mental model. OSP is used by
50  * the MDT stack in several ways:
51  *
52  * - OSP devices allocate FIDs for the stripe sub-objects of a striped
53  *   file or directory.
54  *
55  * - OSP objects represent the remote MDT and OST objects that are
56  *   the stripes of a striped object.
57  *
58  * - OSP devices log, send, and track synchronous operations (setattr
59  *   and unlink) to remote targets.
60  *
61  * - OSP objects are the bottom slice of the compound LU object
62  *   representing a remote MDT object: MDT/MDD/LOD/OSP.
63  *
64  * - OSP objects are used by LFSCK to represent remote OST objects
65  *   during the verification of MDT-OST consistency.
66  *
67  * - OSP devices batch idempotent requests (declare_attr_get() and
68  *   declare_xattr_get()) to the remote target and cache their results.
69  *
70  * In addition the OSP layer implements a subset of the OBD device API
71  * to support being a client of a remote target, connecting to other
72  * layers, and FID allocation.
73  */
74
75 #define DEBUG_SUBSYSTEM S_MDS
76
77 #include <obd_class.h>
78 #include <lustre_ioctl.h>
79 #include <lustre_param.h>
80 #include <lustre_log.h>
81 #include <lustre_mdc.h>
82
83 #include "osp_internal.h"
84
85 /* Slab for OSP object allocation */
86 struct kmem_cache *osp_object_kmem;
87
88 static struct lu_kmem_descr osp_caches[] = {
89         {
90                 .ckd_cache = &osp_object_kmem,
91                 .ckd_name  = "osp_obj",
92                 .ckd_size  = sizeof(struct osp_object)
93         },
94         {
95                 .ckd_cache = NULL
96         }
97 };
98
99 /**
100  * Implementation of lu_device_operations::ldo_object_alloc
101  *
102  * Allocates an OSP object in memory, whose FID is on the remote target.
103  *
104  * \param[in] env       execution environment
105  * \param[in] hdr       The header of the object stack. If it is NULL, it
106  *                      means the object is not built from top device, i.e.
107  *                      it is a sub-stripe object of striped directory or
108  *                      an OST object.
109  * \param[in] d         OSP device
110  *
111  * \retval object       object being created if the creation succeed.
112  * \retval NULL         NULL if the creation failed.
113  */
114 struct lu_object *osp_object_alloc(const struct lu_env *env,
115                                    const struct lu_object_header *hdr,
116                                    struct lu_device *d)
117 {
118         struct lu_object_header *h = NULL;
119         struct osp_object       *o;
120         struct lu_object        *l;
121
122         OBD_SLAB_ALLOC_PTR_GFP(o, osp_object_kmem, GFP_NOFS);
123         if (o != NULL) {
124                 l = &o->opo_obj.do_lu;
125
126                 /* If hdr is NULL, it means the object is not built
127                  * from the top dev(MDT/OST), usually it happens when
128                  * building striped object, like data object on MDT or
129                  * striped object for directory */
130                 if (hdr == NULL) {
131                         h = &o->opo_header;
132                         lu_object_header_init(h);
133                         dt_object_init(&o->opo_obj, h, d);
134                         lu_object_add_top(h, l);
135                 } else {
136                         dt_object_init(&o->opo_obj, h, d);
137                 }
138
139                 l->lo_ops = &osp_lu_obj_ops;
140
141                 return l;
142         } else {
143                 return NULL;
144         }
145 }
146
147 /**
148  * Find or create the local object
149  *
150  * Finds or creates the local file referenced by \a reg_id and return the
151  * attributes of the local file.
152  *
153  * \param[in] env       execution environment
154  * \param[in] osp       OSP device
155  * \param[out] attr     attributes of the object
156  * \param[in] reg_id    the local object ID of the file. It will be used
157  *                      to compose a local FID{FID_SEQ_LOCAL_FILE, reg_id, 0}
158  *                      to identify the object.
159  *
160  * \retval object               object(dt_object) found or created
161  * \retval ERR_PTR(errno)       ERR_PTR(errno) if not get the object.
162  */
163 static struct dt_object
164 *osp_find_or_create_local_file(const struct lu_env *env, struct osp_device *osp,
165                                struct lu_attr *attr, __u32 reg_id)
166 {
167         struct osp_thread_info *osi = osp_env_info(env);
168         struct dt_object_format dof = { 0 };
169         struct dt_object       *dto;
170         int                  rc;
171         ENTRY;
172
173         lu_local_obj_fid(&osi->osi_fid, reg_id);
174         attr->la_valid = LA_MODE;
175         attr->la_mode = S_IFREG | 0644;
176         dof.dof_type = DFT_REGULAR;
177         /* Find or create the local object by osi_fid. */
178         dto = dt_find_or_create(env, osp->opd_storage, &osi->osi_fid,
179                                 &dof, attr);
180         if (IS_ERR(dto))
181                 RETURN(dto);
182
183         /* Get attributes of the local object. */
184         rc = dt_attr_get(env, dto, attr, NULL);
185         if (rc) {
186                 CERROR("%s: can't be initialized: rc = %d\n",
187                        osp->opd_obd->obd_name, rc);
188                 lu_object_put(env, &dto->do_lu);
189                 RETURN(ERR_PTR(rc));
190         }
191         RETURN(dto);
192 }
193
194 /**
195  * Write data buffer to a local file object.
196  *
197  * \param[in] env       execution environment
198  * \param[in] osp       OSP device
199  * \param[in] dt_obj    object written to
200  * \param[in] buf       buffer containing byte array and length
201  * \param[in] offset    write offset in the object in bytes
202  *
203  * \retval 0            0 if write succeed
204  * \retval -EFAULT      -EFAULT if only part of buffer is written.
205  * \retval negative             other negative errno if write failed.
206  */
207 static int osp_write_local_file(const struct lu_env *env,
208                                 struct osp_device *osp,
209                                 struct dt_object *dt_obj,
210                                 struct lu_buf *buf,
211                                 loff_t offset)
212 {
213         struct thandle *th;
214         int rc;
215
216         th = dt_trans_create(env, osp->opd_storage);
217         if (IS_ERR(th))
218                 RETURN(PTR_ERR(th));
219
220         rc = dt_declare_record_write(env, dt_obj, buf, offset, th);
221         if (rc)
222                 GOTO(out, rc);
223         rc = dt_trans_start_local(env, osp->opd_storage, th);
224         if (rc)
225                 GOTO(out, rc);
226
227         rc = dt_record_write(env, dt_obj, buf, &offset, th);
228 out:
229         dt_trans_stop(env, osp->opd_storage, th);
230         RETURN(rc);
231 }
232
233 /**
234  * Initialize last ID object.
235  *
236  * This function initializes the LAST_ID file, which stores the current last
237  * used id of data objects. The MDT will use the last used id and the last_seq
238  * (\see osp_init_last_seq()) to synchronize the precreate object cache with
239  * OSTs.
240  *
241  * \param[in] env       execution environment
242  * \param[in] osp       OSP device
243  *
244  * \retval 0            0 if initialization succeed
245  * \retval negative     negative errno if initialization failed
246  */
247 static int osp_init_last_objid(const struct lu_env *env, struct osp_device *osp)
248 {
249         struct osp_thread_info  *osi = osp_env_info(env);
250         struct lu_fid           *fid = &osp->opd_last_used_fid;
251         struct dt_object        *dto;
252         int                     rc = -EFAULT;
253         ENTRY;
254
255         dto = osp_find_or_create_local_file(env, osp, &osi->osi_attr,
256                                             MDD_LOV_OBJ_OID);
257         if (IS_ERR(dto))
258                 RETURN(PTR_ERR(dto));
259
260         /* object will be released in device cleanup path */
261         if (osi->osi_attr.la_size >=
262             sizeof(osi->osi_id) * (osp->opd_index + 1)) {
263                 osp_objid_buf_prep(&osi->osi_lb, &osi->osi_off, &fid->f_oid,
264                                    osp->opd_index);
265                 rc = dt_record_read(env, dto, &osi->osi_lb, &osi->osi_off);
266                 if (rc != 0 && rc != -EFAULT)
267                         GOTO(out, rc);
268         }
269
270         if (rc == -EFAULT) { /* fresh LAST_ID */
271                 fid->f_oid = 0;
272                 osp_objid_buf_prep(&osi->osi_lb, &osi->osi_off, &fid->f_oid,
273                                    osp->opd_index);
274                 rc = osp_write_local_file(env, osp, dto, &osi->osi_lb,
275                                           osi->osi_off);
276                 if (rc != 0)
277                         GOTO(out, rc);
278         }
279         osp->opd_last_used_oid_file = dto;
280         RETURN(0);
281 out:
282         /* object will be released in device cleanup path */
283         CERROR("%s: can't initialize lov_objid: rc = %d\n",
284                osp->opd_obd->obd_name, rc);
285         lu_object_put(env, &dto->do_lu);
286         osp->opd_last_used_oid_file = NULL;
287         RETURN(rc);
288 }
289
290 /**
291  * Initialize last sequence object.
292  *
293  * This function initializes the LAST_SEQ file in the local OSD, which stores
294  * the current last used sequence of data objects. The MDT will use the last
295  * sequence and last id (\see osp_init_last_objid()) to synchronize the
296  * precreate object cache with OSTs.
297  *
298  * \param[in] env       execution environment
299  * \param[in] osp       OSP device
300  *
301  * \retval 0            0 if initialization succeed
302  * \retval negative     negative errno if initialization failed
303  */
304 static int osp_init_last_seq(const struct lu_env *env, struct osp_device *osp)
305 {
306         struct osp_thread_info  *osi = osp_env_info(env);
307         struct lu_fid           *fid = &osp->opd_last_used_fid;
308         struct dt_object        *dto;
309         int                     rc = -EFAULT;
310         ENTRY;
311
312         dto = osp_find_or_create_local_file(env, osp, &osi->osi_attr,
313                                             MDD_LOV_OBJ_OSEQ);
314         if (IS_ERR(dto))
315                 RETURN(PTR_ERR(dto));
316
317         /* object will be released in device cleanup path */
318         if (osi->osi_attr.la_size >=
319             sizeof(osi->osi_id) * (osp->opd_index + 1)) {
320                 osp_objseq_buf_prep(&osi->osi_lb, &osi->osi_off, &fid->f_seq,
321                                    osp->opd_index);
322                 rc = dt_record_read(env, dto, &osi->osi_lb, &osi->osi_off);
323                 if (rc != 0 && rc != -EFAULT)
324                         GOTO(out, rc);
325         }
326
327         if (rc == -EFAULT) { /* fresh OSP */
328                 fid->f_seq = 0;
329                 osp_objseq_buf_prep(&osi->osi_lb, &osi->osi_off, &fid->f_seq,
330                                     osp->opd_index);
331                 rc = osp_write_local_file(env, osp, dto, &osi->osi_lb,
332                                           osi->osi_off);
333                 if (rc != 0)
334                         GOTO(out, rc);
335         }
336         osp->opd_last_used_seq_file = dto;
337         RETURN(0);
338 out:
339         /* object will be released in device cleanup path */
340         CERROR("%s: can't initialize lov_seq: rc = %d\n",
341                osp->opd_obd->obd_name, rc);
342         lu_object_put(env, &dto->do_lu);
343         osp->opd_last_used_seq_file = NULL;
344         RETURN(rc);
345 }
346
347 /**
348  * Initialize last OID and sequence object.
349  *
350  * If the MDT is just upgraded to 2.4 from the lower version, where the
351  * LAST_SEQ file does not exist, the file will be created and IDIF sequence
352  * will be written into the file.
353  *
354  * \param[in] env       execution environment
355  * \param[in] osp       OSP device
356  *
357  * \retval 0            0 if initialization succeed
358  * \retval negative     negative error if initialization failed
359  */
360 static int osp_last_used_init(const struct lu_env *env, struct osp_device *osp)
361 {
362         struct osp_thread_info *osi = osp_env_info(env);
363         int                  rc;
364         ENTRY;
365
366         fid_zero(&osp->opd_last_used_fid);
367         rc = osp_init_last_objid(env, osp);
368         if (rc < 0) {
369                 CERROR("%s: Can not get ids %d from old objid!\n",
370                        osp->opd_obd->obd_name, rc);
371                 RETURN(rc);
372         }
373
374         rc = osp_init_last_seq(env, osp);
375         if (rc < 0) {
376                 CERROR("%s: Can not get ids %d from old objid!\n",
377                        osp->opd_obd->obd_name, rc);
378                 GOTO(out, rc);
379         }
380
381         if (fid_oid(&osp->opd_last_used_fid) != 0 &&
382             fid_seq(&osp->opd_last_used_fid) == 0) {
383                 /* Just upgrade from the old version,
384                  * set the seq to be IDIF */
385                 osp->opd_last_used_fid.f_seq =
386                    fid_idif_seq(fid_oid(&osp->opd_last_used_fid),
387                                 osp->opd_index);
388                 osp_objseq_buf_prep(&osi->osi_lb, &osi->osi_off,
389                                     &osp->opd_last_used_fid.f_seq,
390                                     osp->opd_index);
391                 rc = osp_write_local_file(env, osp, osp->opd_last_used_seq_file,
392                                           &osi->osi_lb, osi->osi_off);
393                 if (rc) {
394                         CERROR("%s : Can not write seq file: rc = %d\n",
395                                osp->opd_obd->obd_name, rc);
396                         GOTO(out, rc);
397                 }
398         }
399
400         if (!fid_is_zero(&osp->opd_last_used_fid) &&
401                  !fid_is_sane(&osp->opd_last_used_fid)) {
402                 CERROR("%s: Got invalid FID "DFID"\n", osp->opd_obd->obd_name,
403                         PFID(&osp->opd_last_used_fid));
404                 GOTO(out, rc = -EINVAL);
405         }
406
407         CDEBUG(D_INFO, "%s: Init last used fid "DFID"\n",
408                osp->opd_obd->obd_name, PFID(&osp->opd_last_used_fid));
409 out:
410         if (rc != 0) {
411                 if (osp->opd_last_used_oid_file != NULL) {
412                         lu_object_put(env, &osp->opd_last_used_oid_file->do_lu);
413                         osp->opd_last_used_oid_file = NULL;
414                 }
415                 if (osp->opd_last_used_seq_file != NULL) {
416                         lu_object_put(env, &osp->opd_last_used_seq_file->do_lu);
417                         osp->opd_last_used_seq_file = NULL;
418                 }
419         }
420
421         RETURN(rc);
422 }
423
424 /**
425  * Release the last sequence and OID file objects in OSP device.
426  *
427  * \param[in] env       execution environment
428  * \param[in] osp       OSP device
429  */
430 static void osp_last_used_fini(const struct lu_env *env, struct osp_device *osp)
431 {
432         /* release last_used file */
433         if (osp->opd_last_used_oid_file != NULL) {
434                 lu_object_put(env, &osp->opd_last_used_oid_file->do_lu);
435                 osp->opd_last_used_oid_file = NULL;
436         }
437
438         if (osp->opd_last_used_seq_file != NULL) {
439                 lu_object_put(env, &osp->opd_last_used_seq_file->do_lu);
440                 osp->opd_last_used_seq_file = NULL;
441         }
442 }
443
444 /**
445  * Disconnects the connection between OSP and its correspondent MDT or OST, and
446  * the import will be marked as inactive. It will only be called during OSP
447  * cleanup process.
448  *
449  * \param[in] d         OSP device being disconnected
450  *
451  * \retval 0            0 if disconnection succeed
452  * \retval negative     negative errno if disconnection failed
453  */
454 static int osp_disconnect(struct osp_device *d)
455 {
456         struct obd_import *imp;
457         int rc = 0;
458
459         imp = d->opd_obd->u.cli.cl_import;
460
461         /* Mark import deactivated now, so we don't try to reconnect if any
462          * of the cleanup RPCs fails (e.g. ldlm cancel, etc).  We don't
463          * fully deactivate the import, or that would drop all requests. */
464         LASSERT(imp != NULL);
465         spin_lock(&imp->imp_lock);
466         imp->imp_deactive = 1;
467         spin_unlock(&imp->imp_lock);
468
469         ptlrpc_deactivate_import(imp);
470
471         /* Some non-replayable imports (MDS's OSCs) are pinged, so just
472          * delete it regardless.  (It's safe to delete an import that was
473          * never added.) */
474         (void)ptlrpc_pinger_del_import(imp);
475
476         rc = ptlrpc_disconnect_import(imp, 0);
477         if (rc != 0)
478                 CERROR("%s: can't disconnect: rc = %d\n",
479                        d->opd_obd->obd_name, rc);
480
481         ptlrpc_invalidate_import(imp);
482
483         RETURN(rc);
484 }
485
486 /**
487  * Cleanup OSP, which includes disconnect import, cleanup unlink log, stop
488  * precreate threads etc.
489  *
490  * \param[in] env       execution environment.
491  * \param[in] d         OSP device being disconnected.
492  *
493  * \retval 0            0 if cleanup succeed
494  * \retval negative     negative errno if cleanup failed
495  */
496 static int osp_shutdown(const struct lu_env *env, struct osp_device *d)
497 {
498         int                      rc = 0;
499         ENTRY;
500
501         LASSERT(env);
502
503         rc = osp_disconnect(d);
504
505         osp_sync_fini(d);
506
507         if (!d->opd_connect_mdt) {
508                 /* stop precreate thread */
509                 osp_precreate_fini(d);
510
511                 /* release last_used file */
512                 osp_last_used_fini(env, d);
513         }
514
515         obd_fid_fini(d->opd_obd);
516
517         RETURN(rc);
518 }
519
520 /**
521  * Implementation of osp_lu_ops::ldo_process_config
522  *
523  * This function processes config log records in OSP layer. It is usually
524  * called from the top layer of MDT stack, and goes through the stack by calling
525  * ldo_process_config of next layer.
526  *
527  * \param[in] env       execution environment
528  * \param[in] dev       lu_device of OSP
529  * \param[in] lcfg      config log
530  *
531  * \retval 0            0 if the config log record is executed correctly.
532  * \retval negative     negative errno if the record execution fails.
533  */
534 static int osp_process_config(const struct lu_env *env,
535                               struct lu_device *dev, struct lustre_cfg *lcfg)
536 {
537         struct osp_device               *d = lu2osp_dev(dev);
538         struct obd_device               *obd = d->opd_obd;
539         int                              rc;
540
541         ENTRY;
542
543         switch (lcfg->lcfg_command) {
544         case LCFG_PRE_CLEANUP:
545                 rc = osp_disconnect(d);
546                 break;
547         case LCFG_CLEANUP:
548                 lu_dev_del_linkage(dev->ld_site, dev);
549                 rc = osp_shutdown(env, d);
550                 break;
551         case LCFG_PARAM:
552                 LASSERT(obd);
553                 rc = class_process_proc_param(PARAM_OSC, obd->obd_vars,
554                                               lcfg, obd);
555                 if (rc > 0)
556                         rc = 0;
557                 if (rc == -ENOSYS) {
558                         /* class_process_proc_param() haven't found matching
559                          * parameter and returned ENOSYS so that layer(s)
560                          * below could use that. But OSP is the bottom, so
561                          * just ignore it */
562                         CERROR("%s: unknown param %s\n",
563                                (char *)lustre_cfg_string(lcfg, 0),
564                                (char *)lustre_cfg_string(lcfg, 1));
565                         rc = 0;
566                 }
567                 break;
568         default:
569                 CERROR("%s: unknown command %u\n",
570                        (char *)lustre_cfg_string(lcfg, 0), lcfg->lcfg_command);
571                 rc = 0;
572                 break;
573         }
574
575         RETURN(rc);
576 }
577
578 /**
579  * Implementation of osp_lu_ops::ldo_recovery_complete
580  *
581  * This function is called after recovery is finished, and OSP layer
582  * will wake up precreate thread here.
583  *
584  * \param[in] env       execution environment
585  * \param[in] dev       lu_device of OSP
586  *
587  * \retval 0            0 unconditionally
588  */
589 static int osp_recovery_complete(const struct lu_env *env,
590                                  struct lu_device *dev)
591 {
592         struct osp_device       *osp = lu2osp_dev(dev);
593
594         ENTRY;
595         osp->opd_recovery_completed = 1;
596
597         if (!osp->opd_connect_mdt && osp->opd_pre != NULL)
598                 wake_up(&osp->opd_pre_waitq);
599
600         RETURN(0);
601 }
602
603 const struct lu_device_operations osp_lu_ops = {
604         .ldo_object_alloc       = osp_object_alloc,
605         .ldo_process_config     = osp_process_config,
606         .ldo_recovery_complete  = osp_recovery_complete,
607 };
608
609 /**
610  * Implementation of dt_device_operations::dt_statfs
611  *
612  * This function provides statfs status (for precreation) from
613  * corresponding OST. Note: this function only retrieves the status
614  * from the OSP device, and the real statfs RPC happens inside
615  * precreate thread (\see osp_statfs_update). Note: OSP for MDT does
616  * not need to retrieve statfs data for now.
617  *
618  * \param[in] env       execution environment.
619  * \param[in] dev       dt_device of OSP.
620  * \param[out] sfs      holds the retrieved statfs data.
621  *
622  * \retval 0            0 statfs data was retrieved successfully or
623  *                      retrieval was not needed
624  * \retval negative     negative errno if get statfs failed.
625  */
626 static int osp_statfs(const struct lu_env *env, struct dt_device *dev,
627                       struct obd_statfs *sfs)
628 {
629         struct osp_device *d = dt2osp_dev(dev);
630
631         ENTRY;
632
633         if (unlikely(d->opd_imp_active == 0))
634                 RETURN(-ENOTCONN);
635
636         if (d->opd_pre == NULL)
637                 RETURN(0);
638
639         /* return recently updated data */
640         *sfs = d->opd_statfs;
641
642         /*
643          * layer above osp (usually lod) can use ffree to estimate
644          * how many objects are available for immediate creation
645          */
646         spin_lock(&d->opd_pre_lock);
647         LASSERTF(fid_seq(&d->opd_pre_last_created_fid) ==
648                  fid_seq(&d->opd_pre_used_fid),
649                  "last_created "DFID", next_fid "DFID"\n",
650                  PFID(&d->opd_pre_last_created_fid),
651                  PFID(&d->opd_pre_used_fid));
652         sfs->os_fprecreated = fid_oid(&d->opd_pre_last_created_fid) -
653                               fid_oid(&d->opd_pre_used_fid);
654         sfs->os_fprecreated -= d->opd_pre_reserved;
655         spin_unlock(&d->opd_pre_lock);
656
657         LASSERT(sfs->os_fprecreated <= OST_MAX_PRECREATE * 2);
658
659         CDEBUG(D_OTHER, "%s: "LPU64" blocks, "LPU64" free, "LPU64" avail, "
660                LPU64" files, "LPU64" free files\n", d->opd_obd->obd_name,
661                sfs->os_blocks, sfs->os_bfree, sfs->os_bavail,
662                sfs->os_files, sfs->os_ffree);
663         RETURN(0);
664 }
665
666 static int osp_sync_timeout(void *data)
667 {
668         return 1;
669 }
670
671 /**
672  * Implementation of dt_device_operations::dt_sync
673  *
674  * This function synchronizes the OSP cache to the remote target. It wakes
675  * up unlink log threads and sends out unlink records to the remote OST.
676  *
677  * \param[in] env       execution environment
678  * \param[in] dev       dt_device of OSP
679  *
680  * \retval 0            0 if synchronization succeeds
681  * \retval negative     negative errno if synchronization fails
682  */
683 static int osp_sync(const struct lu_env *env, struct dt_device *dev)
684 {
685         struct osp_device *d = dt2osp_dev(dev);
686         cfs_time_t         expire;
687         struct l_wait_info lwi = { 0 };
688         unsigned long      id, old;
689         int                rc = 0;
690         unsigned long      start = cfs_time_current();
691         ENTRY;
692
693         if (unlikely(d->opd_imp_active == 0))
694                 RETURN(-ENOTCONN);
695
696         id = d->opd_syn_last_used_id;
697
698         CDEBUG(D_OTHER, "%s: id: used %lu, processed %lu\n",
699                d->opd_obd->obd_name, id, d->opd_syn_last_processed_id);
700
701         /* wait till all-in-line are processed */
702         while (d->opd_syn_last_processed_id < id) {
703
704                 old = d->opd_syn_last_processed_id;
705
706                 /* make sure the connection is fine */
707                 expire = cfs_time_shift(obd_timeout);
708                 lwi = LWI_TIMEOUT(expire - cfs_time_current(),
709                                   osp_sync_timeout, d);
710                 l_wait_event(d->opd_syn_barrier_waitq,
711                              d->opd_syn_last_processed_id >= id,
712                              &lwi);
713
714                 if (d->opd_syn_last_processed_id >= id)
715                         break;
716
717                 if (d->opd_syn_last_processed_id != old) {
718                         /* some progress have been made,
719                          * keep trying... */
720                         continue;
721                 }
722
723                 /* no changes and expired, something is wrong */
724                 GOTO(out, rc = -ETIMEDOUT);
725         }
726
727         /* block new processing (barrier>0 - few callers are possible */
728         atomic_inc(&d->opd_syn_barrier);
729
730         CDEBUG(D_OTHER, "%s: %u in flight\n", d->opd_obd->obd_name,
731                d->opd_syn_rpc_in_flight);
732
733         /* wait till all-in-flight are replied, so executed by the target */
734         /* XXX: this is used by LFSCK at the moment, which doesn't require
735          *      all the changes to be committed, but in general it'd be
736          *      better to wait till commit */
737         while (d->opd_syn_rpc_in_flight > 0) {
738
739                 old = d->opd_syn_rpc_in_flight;
740
741                 expire = cfs_time_shift(obd_timeout);
742                 lwi = LWI_TIMEOUT(expire - cfs_time_current(),
743                                   osp_sync_timeout, d);
744                 l_wait_event(d->opd_syn_barrier_waitq,
745                                 d->opd_syn_rpc_in_flight == 0, &lwi);
746
747                 if (d->opd_syn_rpc_in_flight == 0)
748                         break;
749
750                 if (d->opd_syn_rpc_in_flight != old) {
751                         /* some progress have been made */
752                         continue;
753                 }
754
755                 /* no changes and expired, something is wrong */
756                 GOTO(out, rc = -ETIMEDOUT);
757         }
758
759         CDEBUG(D_OTHER, "%s: done in %lu\n", d->opd_obd->obd_name,
760                cfs_time_current() - start);
761 out:
762         /* resume normal processing (barrier=0) */
763         atomic_dec(&d->opd_syn_barrier);
764         __osp_sync_check_for_work(d);
765
766         RETURN(rc);
767 }
768
769 const struct dt_device_operations osp_dt_ops = {
770         .dt_statfs       = osp_statfs,
771         .dt_sync         = osp_sync,
772         .dt_trans_create = osp_trans_create,
773         .dt_trans_start  = osp_trans_start,
774         .dt_trans_stop   = osp_trans_stop,
775 };
776
777 /**
778  * Connect OSP to local OSD.
779  *
780  * Locate the local OSD referenced by \a nextdev and connect to it. Sometimes,
781  * OSP needs to access the local OSD to store some information. For example,
782  * during precreate, it needs to update last used OID and sequence file
783  * (LAST_SEQ) in local OSD.
784  *
785  * \param[in] env       execution environment
786  * \param[in] osp       OSP device
787  * \param[in] nextdev   the name of local OSD
788  *
789  * \retval 0            0 connection succeeded
790  * \retval negative     negative errno connection failed
791  */
792 static int osp_connect_to_osd(const struct lu_env *env, struct osp_device *osp,
793                               const char *nextdev)
794 {
795         struct obd_connect_data *data = NULL;
796         struct obd_device       *obd;
797         int                      rc;
798
799         ENTRY;
800
801         LASSERT(osp->opd_storage_exp == NULL);
802
803         OBD_ALLOC_PTR(data);
804         if (data == NULL)
805                 RETURN(-ENOMEM);
806
807         obd = class_name2obd(nextdev);
808         if (obd == NULL) {
809                 CERROR("%s: can't locate next device: %s\n",
810                        osp->opd_obd->obd_name, nextdev);
811                 GOTO(out, rc = -ENOTCONN);
812         }
813
814         rc = obd_connect(env, &osp->opd_storage_exp, obd, &obd->obd_uuid, data,
815                          NULL);
816         if (rc) {
817                 CERROR("%s: cannot connect to next dev %s: rc = %d\n",
818                        osp->opd_obd->obd_name, nextdev, rc);
819                 GOTO(out, rc);
820         }
821
822         osp->opd_dt_dev.dd_lu_dev.ld_site =
823                 osp->opd_storage_exp->exp_obd->obd_lu_dev->ld_site;
824         LASSERT(osp->opd_dt_dev.dd_lu_dev.ld_site);
825         osp->opd_storage = lu2dt_dev(osp->opd_storage_exp->exp_obd->obd_lu_dev);
826
827 out:
828         OBD_FREE_PTR(data);
829         RETURN(rc);
830 }
831
832 /**
833  * Initialize OSP device according to the parameters in the configuration
834  * log \a cfg.
835  *
836  * Reconstruct the local device name from the configuration profile, and
837  * initialize necessary threads and structures according to the OSP type
838  * (MDT or OST).
839  *
840  * Since there is no record in the MDT configuration for the local disk
841  * device, we have to extract this from elsewhere in the profile.
842  * The only information we get at setup is from the OSC records:
843  * setup 0:{fsname}-OSTxxxx-osc[-MDTxxxx] 1:lustre-OST0000_UUID 2:NID
844  *
845  * Note: configs generated by Lustre 1.8 are missing the -MDTxxxx part,
846  * so, we need to reconstruct the name of the underlying OSD from this:
847  * {fsname}-{svname}-osd, for example "lustre-MDT0000-osd".
848  *
849  * \param[in] env       execution environment
850  * \param[in] osp       OSP device
851  * \param[in] ldt       lu device type of OSP
852  * \param[in] cfg       configuration log
853  *
854  * \retval 0            0 if OSP initialization succeeded.
855  * \retval negative     negative errno if OSP initialization failed.
856  */
857 static int osp_init0(const struct lu_env *env, struct osp_device *osp,
858                      struct lu_device_type *ldt, struct lustre_cfg *cfg)
859 {
860         struct obd_device       *obd;
861         struct obd_import       *imp;
862         class_uuid_t            uuid;
863         char                    *src, *tgt, *mdt, *osdname = NULL;
864         int                     rc;
865         long                    idx;
866
867         ENTRY;
868
869         mutex_init(&osp->opd_async_requests_mutex);
870
871         obd = class_name2obd(lustre_cfg_string(cfg, 0));
872         if (obd == NULL) {
873                 CERROR("Cannot find obd with name %s\n",
874                        lustre_cfg_string(cfg, 0));
875                 RETURN(-ENODEV);
876         }
877         osp->opd_obd = obd;
878
879         src = lustre_cfg_string(cfg, 0);
880         if (src == NULL)
881                 RETURN(-EINVAL);
882
883         tgt = strrchr(src, '-');
884         if (tgt == NULL) {
885                 CERROR("%s: invalid target name %s: rc = %d\n",
886                        osp->opd_obd->obd_name, lustre_cfg_string(cfg, 0),
887                        -EINVAL);
888                 RETURN(-EINVAL);
889         }
890
891         if (strncmp(tgt, "-osc", 4) == 0) {
892                 /* Old OSC name fsname-OSTXXXX-osc */
893                 for (tgt--; tgt > src && *tgt != '-'; tgt--)
894                         ;
895                 if (tgt == src) {
896                         CERROR("%s: invalid target name %s: rc = %d\n",
897                                osp->opd_obd->obd_name,
898                                lustre_cfg_string(cfg, 0), -EINVAL);
899                         RETURN(-EINVAL);
900                 }
901
902                 if (strncmp(tgt, "-OST", 4) != 0) {
903                         CERROR("%s: invalid target name %s: rc = %d\n",
904                                osp->opd_obd->obd_name,
905                                lustre_cfg_string(cfg, 0), -EINVAL);
906                         RETURN(-EINVAL);
907                 }
908
909                 idx = simple_strtol(tgt + 4, &mdt, 16);
910                 if (mdt[0] != '-' || idx > INT_MAX || idx < 0) {
911                         CERROR("%s: invalid OST index in '%s': rc = %d\n",
912                                osp->opd_obd->obd_name, src, -EINVAL);
913                         RETURN(-EINVAL);
914                 }
915                 osp->opd_index = idx;
916                 osp->opd_group = 0;
917                 idx = tgt - src;
918         } else {
919                 /* New OSC name fsname-OSTXXXX-osc-MDTXXXX */
920                 if (strncmp(tgt, "-MDT", 4) != 0 &&
921                     strncmp(tgt, "-OST", 4) != 0) {
922                         CERROR("%s: invalid target name %s: rc = %d\n",
923                                osp->opd_obd->obd_name,
924                                lustre_cfg_string(cfg, 0), -EINVAL);
925                         RETURN(-EINVAL);
926                 }
927
928                 idx = simple_strtol(tgt + 4, &mdt, 16);
929                 if (*mdt != '\0' || idx > INT_MAX || idx < 0) {
930                         CERROR("%s: invalid OST index in '%s': rc = %d\n",
931                                osp->opd_obd->obd_name, src, -EINVAL);
932                         RETURN(-EINVAL);
933                 }
934
935                 /* Get MDT index from the name and set it to opd_group,
936                  * which will be used by OSP to connect with OST */
937                 osp->opd_group = idx;
938                 if (tgt - src <= 12) {
939                         CERROR("%s: invalid mdt index from %s: rc =%d\n",
940                                osp->opd_obd->obd_name,
941                                lustre_cfg_string(cfg, 0), -EINVAL);
942                         RETURN(-EINVAL);
943                 }
944
945                 if (strncmp(tgt - 12, "-MDT", 4) == 0)
946                         osp->opd_connect_mdt = 1;
947
948                 idx = simple_strtol(tgt - 8, &mdt, 16);
949                 if (mdt[0] != '-' || idx > INT_MAX || idx < 0) {
950                         CERROR("%s: invalid OST index in '%s': rc =%d\n",
951                                osp->opd_obd->obd_name, src, -EINVAL);
952                         RETURN(-EINVAL);
953                 }
954
955                 osp->opd_index = idx;
956                 idx = tgt - src - 12;
957         }
958         /* check the fsname length, and after this everything else will fit */
959         if (idx > MTI_NAME_MAXLEN) {
960                 CERROR("%s: fsname too long in '%s': rc = %d\n",
961                        osp->opd_obd->obd_name, src, -EINVAL);
962                 RETURN(-EINVAL);
963         }
964
965         OBD_ALLOC(osdname, MAX_OBD_NAME);
966         if (osdname == NULL)
967                 RETURN(-ENOMEM);
968
969         memcpy(osdname, src, idx); /* copy just the fsname part */
970         osdname[idx] = '\0';
971
972         mdt = strstr(mdt, "-MDT");
973         if (mdt == NULL) /* 1.8 configs don't have "-MDT0000" at the end */
974                 strcat(osdname, "-MDT0000");
975         else
976                 strcat(osdname, mdt);
977         strcat(osdname, "-osd");
978         CDEBUG(D_HA, "%s: connect to %s (%s)\n", obd->obd_name, osdname, src);
979
980         if (osp->opd_connect_mdt) {
981                 struct client_obd *cli = &osp->opd_obd->u.cli;
982
983                 OBD_ALLOC(cli->cl_rpc_lock, sizeof(*cli->cl_rpc_lock));
984                 if (!cli->cl_rpc_lock)
985                         GOTO(out_fini, rc = -ENOMEM);
986                 osp_init_rpc_lock(cli->cl_rpc_lock);
987         }
988
989         osp->opd_dt_dev.dd_lu_dev.ld_ops = &osp_lu_ops;
990         osp->opd_dt_dev.dd_ops = &osp_dt_ops;
991
992         obd->obd_lu_dev = &osp->opd_dt_dev.dd_lu_dev;
993
994         rc = osp_connect_to_osd(env, osp, osdname);
995         if (rc)
996                 GOTO(out_fini, rc);
997
998         rc = ptlrpcd_addref();
999         if (rc)
1000                 GOTO(out_disconnect, rc);
1001
1002         rc = client_obd_setup(obd, cfg);
1003         if (rc) {
1004                 CERROR("%s: can't setup obd: rc = %d\n", osp->opd_obd->obd_name,
1005                        rc);
1006                 GOTO(out_ref, rc);
1007         }
1008
1009         osp_lprocfs_init(osp);
1010
1011         rc = obd_fid_init(osp->opd_obd, NULL, osp->opd_connect_mdt ?
1012                           LUSTRE_SEQ_METADATA : LUSTRE_SEQ_DATA);
1013         if (rc) {
1014                 CERROR("%s: fid init error: rc = %d\n",
1015                        osp->opd_obd->obd_name, rc);
1016                 GOTO(out_proc, rc);
1017         }
1018
1019         if (!osp->opd_connect_mdt) {
1020                 /* Initialize last id from the storage - will be
1021                  * used in orphan cleanup. */
1022                 rc = osp_last_used_init(env, osp);
1023                 if (rc)
1024                         GOTO(out_fid, rc);
1025
1026
1027                 /* Initialize precreation thread, it handles new
1028                  * connections as well. */
1029                 rc = osp_init_precreate(osp);
1030                 if (rc)
1031                         GOTO(out_last_used, rc);
1032         }
1033
1034         /*
1035          * Initialize synhronization mechanism taking
1036          * care of propogating changes to OST in near
1037          * transactional manner.
1038          */
1039         rc = osp_sync_init(env, osp);
1040         if (rc)
1041                 GOTO(out_precreat, rc);
1042
1043         /*
1044          * Initiate connect to OST
1045          */
1046         ll_generate_random_uuid(uuid);
1047         class_uuid_unparse(uuid, &osp->opd_cluuid);
1048
1049         imp = obd->u.cli.cl_import;
1050
1051         rc = ptlrpc_init_import(imp);
1052         if (rc)
1053                 GOTO(out, rc);
1054         if (osdname)
1055                 OBD_FREE(osdname, MAX_OBD_NAME);
1056         RETURN(0);
1057
1058 out:
1059         /* stop sync thread */
1060         osp_sync_fini(osp);
1061 out_precreat:
1062         /* stop precreate thread */
1063         if (!osp->opd_connect_mdt)
1064                 osp_precreate_fini(osp);
1065 out_last_used:
1066         if (!osp->opd_connect_mdt)
1067                 osp_last_used_fini(env, osp);
1068 out_fid:
1069         obd_fid_fini(osp->opd_obd);
1070 out_proc:
1071         ptlrpc_lprocfs_unregister_obd(obd);
1072         lprocfs_obd_cleanup(obd);
1073         if (osp->opd_symlink)
1074                 lprocfs_remove(&osp->opd_symlink);
1075         client_obd_cleanup(obd);
1076 out_ref:
1077         ptlrpcd_decref();
1078 out_disconnect:
1079         if (osp->opd_connect_mdt) {
1080                 struct client_obd *cli = &osp->opd_obd->u.cli;
1081                 if (cli->cl_rpc_lock != NULL) {
1082                         OBD_FREE_PTR(cli->cl_rpc_lock);
1083                         cli->cl_rpc_lock = NULL;
1084                 }
1085         }
1086         obd_disconnect(osp->opd_storage_exp);
1087 out_fini:
1088         if (osdname)
1089                 OBD_FREE(osdname, MAX_OBD_NAME);
1090         RETURN(rc);
1091 }
1092
1093 /**
1094  * Implementation of lu_device_type_operations::ldto_device_free
1095  *
1096  * Free the OSP device in memory.  No return value is needed for now,
1097  * so always return NULL to comply with the interface.
1098  *
1099  * \param[in] env       execution environment
1100  * \param[in] lu        lu_device of OSP
1101  *
1102  * \retval NULL         NULL unconditionally
1103  */
1104 static struct lu_device *osp_device_free(const struct lu_env *env,
1105                                          struct lu_device *lu)
1106 {
1107         struct osp_device *osp = lu2osp_dev(lu);
1108
1109         if (atomic_read(&lu->ld_ref) && lu->ld_site) {
1110                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_ERROR, NULL);
1111                 lu_site_print(env, lu->ld_site, &msgdata, lu_cdebug_printer);
1112         }
1113         dt_device_fini(&osp->opd_dt_dev);
1114         OBD_FREE_PTR(osp);
1115
1116         return NULL;
1117 }
1118
1119 /**
1120  * Implementation of lu_device_type_operations::ldto_device_alloc
1121  *
1122  * This function allocates and initializes OSP device in memory according to
1123  * the config log.
1124  *
1125  * \param[in] env       execution environment
1126  * \param[in] type      device type of OSP
1127  * \param[in] lcfg      config log
1128  *
1129  * \retval pointer              the pointer of allocated OSP if succeed.
1130  * \retval ERR_PTR(errno)       ERR_PTR(errno) if failed.
1131  */
1132 static struct lu_device *osp_device_alloc(const struct lu_env *env,
1133                                           struct lu_device_type *type,
1134                                           struct lustre_cfg *lcfg)
1135 {
1136         struct osp_device *osp;
1137         struct lu_device  *ld;
1138
1139         OBD_ALLOC_PTR(osp);
1140         if (osp == NULL) {
1141                 ld = ERR_PTR(-ENOMEM);
1142         } else {
1143                 int rc;
1144
1145                 ld = osp2lu_dev(osp);
1146                 dt_device_init(&osp->opd_dt_dev, type);
1147                 rc = osp_init0(env, osp, type, lcfg);
1148                 if (rc != 0) {
1149                         osp_device_free(env, ld);
1150                         ld = ERR_PTR(rc);
1151                 }
1152         }
1153         return ld;
1154 }
1155
1156 /**
1157  * Implementation of lu_device_type_operations::ldto_device_fini
1158  *
1159  * This function cleans up the OSP device, i.e. release and free those
1160  * attached items in osp_device.
1161  *
1162  * \param[in] env       execution environment
1163  * \param[in] ld        lu_device of OSP
1164  *
1165  * \retval NULL                 NULL if cleanup succeeded.
1166  * \retval ERR_PTR(errno)       ERR_PTR(errno) if cleanup failed.
1167  */
1168 static struct lu_device *osp_device_fini(const struct lu_env *env,
1169                                          struct lu_device *ld)
1170 {
1171         struct osp_device *osp = lu2osp_dev(ld);
1172         struct obd_import *imp;
1173         int                rc;
1174
1175         ENTRY;
1176
1177         if (osp->opd_async_requests != NULL) {
1178                 dt_update_request_destroy(osp->opd_async_requests);
1179                 osp->opd_async_requests = NULL;
1180         }
1181
1182         if (osp->opd_storage_exp)
1183                 obd_disconnect(osp->opd_storage_exp);
1184
1185         imp = osp->opd_obd->u.cli.cl_import;
1186
1187         if (imp->imp_rq_pool) {
1188                 ptlrpc_free_rq_pool(imp->imp_rq_pool);
1189                 imp->imp_rq_pool = NULL;
1190         }
1191
1192         if (osp->opd_symlink)
1193                 lprocfs_remove(&osp->opd_symlink);
1194
1195         LASSERT(osp->opd_obd);
1196         ptlrpc_lprocfs_unregister_obd(osp->opd_obd);
1197         lprocfs_obd_cleanup(osp->opd_obd);
1198
1199         if (osp->opd_connect_mdt) {
1200                 struct client_obd *cli = &osp->opd_obd->u.cli;
1201                 if (cli->cl_rpc_lock != NULL) {
1202                         OBD_FREE_PTR(cli->cl_rpc_lock);
1203                         cli->cl_rpc_lock = NULL;
1204                 }
1205         }
1206
1207         rc = client_obd_cleanup(osp->opd_obd);
1208         if (rc != 0) {
1209                 ptlrpcd_decref();
1210                 RETURN(ERR_PTR(rc));
1211         }
1212
1213         ptlrpcd_decref();
1214
1215         RETURN(NULL);
1216 }
1217
1218 /**
1219  * Implementation of obd_ops::o_reconnect
1220  *
1221  * This function is empty and does not need to do anything for now.
1222  */
1223 static int osp_reconnect(const struct lu_env *env,
1224                          struct obd_export *exp, struct obd_device *obd,
1225                          struct obd_uuid *cluuid,
1226                          struct obd_connect_data *data,
1227                          void *localdata)
1228 {
1229         return 0;
1230 }
1231
1232 /*
1233  * Implementation of obd_ops::o_connect
1234  *
1235  * Connect OSP to the remote target (MDT or OST). Allocate the
1236  * export and return it to the LOD, which calls this function
1237  * for each OSP to connect it to the remote target. This function
1238  * is currently only called once per OSP.
1239  *
1240  * \param[in] env       execution environment
1241  * \param[out] exp      export connected to OSP
1242  * \param[in] obd       OSP device
1243  * \param[in] cluuid    OSP device client uuid
1244  * \param[in] data      connect_data to be used to connect to the remote
1245  *                      target
1246  * \param[in] localdata necessary for the API interface, but not used in
1247  *                      this function
1248  *
1249  * \retval 0            0 if the connection succeeded.
1250  * \retval negative     negative errno if the connection failed.
1251  */
1252 static int osp_obd_connect(const struct lu_env *env, struct obd_export **exp,
1253                            struct obd_device *obd, struct obd_uuid *cluuid,
1254                            struct obd_connect_data *data, void *localdata)
1255 {
1256         struct osp_device       *osp = lu2osp_dev(obd->obd_lu_dev);
1257         struct obd_connect_data *ocd;
1258         struct obd_import       *imp;
1259         struct lustre_handle     conn;
1260         int                      rc;
1261
1262         ENTRY;
1263
1264         CDEBUG(D_CONFIG, "connect #%d\n", osp->opd_connects);
1265
1266         rc = class_connect(&conn, obd, cluuid);
1267         if (rc)
1268                 RETURN(rc);
1269
1270         *exp = class_conn2export(&conn);
1271         /* Why should there ever be more than 1 connect? */
1272         osp->opd_connects++;
1273         LASSERT(osp->opd_connects == 1);
1274
1275         osp->opd_exp = *exp;
1276
1277         imp = osp->opd_obd->u.cli.cl_import;
1278         imp->imp_dlm_handle = conn;
1279
1280         LASSERT(data != NULL);
1281         LASSERT(data->ocd_connect_flags & OBD_CONNECT_INDEX);
1282         ocd = &imp->imp_connect_data;
1283         *ocd = *data;
1284
1285         imp->imp_connect_flags_orig = ocd->ocd_connect_flags;
1286
1287         ocd->ocd_version = LUSTRE_VERSION_CODE;
1288         ocd->ocd_index = data->ocd_index;
1289         imp->imp_connect_flags_orig = ocd->ocd_connect_flags;
1290
1291         rc = ptlrpc_connect_import(imp);
1292         if (rc) {
1293                 CERROR("%s: can't connect obd: rc = %d\n", obd->obd_name, rc);
1294                 GOTO(out, rc);
1295         }
1296
1297         ptlrpc_pinger_add_import(imp);
1298 out:
1299         RETURN(rc);
1300 }
1301
1302 /**
1303  * Implementation of obd_ops::o_disconnect
1304  *
1305  * Disconnect the export for the OSP.  This is called by LOD to release the
1306  * OSP during cleanup (\see lod_del_device()). The OSP will be released after
1307  * the export is released.
1308  *
1309  * \param[in] exp       export to be disconnected.
1310  *
1311  * \retval 0            0 if disconnection succeed
1312  * \retval negative     negative errno if disconnection failed
1313  */
1314 static int osp_obd_disconnect(struct obd_export *exp)
1315 {
1316         struct obd_device *obd = exp->exp_obd;
1317         struct osp_device *osp = lu2osp_dev(obd->obd_lu_dev);
1318         int                rc;
1319         ENTRY;
1320
1321         /* Only disconnect the underlying layers on the final disconnect. */
1322         LASSERT(osp->opd_connects == 1);
1323         osp->opd_connects--;
1324
1325         rc = class_disconnect(exp);
1326         if (rc) {
1327                 CERROR("%s: class disconnect error: rc = %d\n",
1328                        obd->obd_name, rc);
1329                 RETURN(rc);
1330         }
1331
1332         /* destroy the device */
1333         class_manual_cleanup(obd);
1334
1335         RETURN(rc);
1336 }
1337
1338 /**
1339  * Implementation of obd_ops::o_statfs
1340  *
1341  * Send a RPC to the remote target to get statfs status. This is only used
1342  * in lprocfs helpers by obd_statfs.
1343  *
1344  * \param[in] env       execution environment
1345  * \param[in] exp       connection state from this OSP to the parent (LOD)
1346  *                      device
1347  * \param[out] osfs     hold the statfs result
1348  * \param[in] unused    Not used in this function for now
1349  * \param[in] flags     flags to indicate how OSP will issue the RPC
1350  *
1351  * \retval 0            0 if statfs succeeded.
1352  * \retval negative     negative errno if statfs failed.
1353  */
1354 static int osp_obd_statfs(const struct lu_env *env, struct obd_export *exp,
1355                           struct obd_statfs *osfs, __u64 unused, __u32 flags)
1356 {
1357         struct obd_statfs       *msfs;
1358         struct ptlrpc_request   *req;
1359         struct obd_import       *imp = NULL;
1360         int                      rc;
1361
1362         ENTRY;
1363
1364         /* Since the request might also come from lprocfs, so we need
1365          * sync this with client_disconnect_export Bug15684 */
1366         down_read(&exp->exp_obd->u.cli.cl_sem);
1367         if (exp->exp_obd->u.cli.cl_import)
1368                 imp = class_import_get(exp->exp_obd->u.cli.cl_import);
1369         up_read(&exp->exp_obd->u.cli.cl_sem);
1370         if (!imp)
1371                 RETURN(-ENODEV);
1372
1373         req = ptlrpc_request_alloc(imp, &RQF_OST_STATFS);
1374
1375         class_import_put(imp);
1376
1377         if (req == NULL)
1378                 RETURN(-ENOMEM);
1379
1380         rc = ptlrpc_request_pack(req, LUSTRE_OST_VERSION, OST_STATFS);
1381         if (rc) {
1382                 ptlrpc_request_free(req);
1383                 RETURN(rc);
1384         }
1385         ptlrpc_request_set_replen(req);
1386         req->rq_request_portal = OST_CREATE_PORTAL;
1387         ptlrpc_at_set_req_timeout(req);
1388
1389         if (flags & OBD_STATFS_NODELAY) {
1390                 /* procfs requests not want stat in wait for avoid deadlock */
1391                 req->rq_no_resend = 1;
1392                 req->rq_no_delay = 1;
1393         }
1394
1395         rc = ptlrpc_queue_wait(req);
1396         if (rc)
1397                 GOTO(out, rc);
1398
1399         msfs = req_capsule_server_get(&req->rq_pill, &RMF_OBD_STATFS);
1400         if (msfs == NULL)
1401                 GOTO(out, rc = -EPROTO);
1402
1403         *osfs = *msfs;
1404
1405         EXIT;
1406 out:
1407         ptlrpc_req_finished(req);
1408         return rc;
1409 }
1410
1411 /**
1412  * Prepare fid client.
1413  *
1414  * This function prepares the FID client for the OSP. It will check and assign
1415  * the export (to MDT0) for its FID client, so OSP can allocate super sequence
1416  * or lookup sequence in FLDB of MDT0.
1417  *
1418  * \param[in] osp       OSP device
1419  */
1420 static void osp_prepare_fid_client(struct osp_device *osp)
1421 {
1422         LASSERT(osp->opd_obd->u.cli.cl_seq != NULL);
1423         if (osp->opd_obd->u.cli.cl_seq->lcs_exp != NULL)
1424                 return;
1425
1426         LASSERT(osp->opd_exp != NULL);
1427         osp->opd_obd->u.cli.cl_seq->lcs_exp =
1428                                 class_export_get(osp->opd_exp);
1429 }
1430
1431 /**
1432  * Implementation of obd_ops::o_import_event
1433  *
1434  * This function is called when some related import event happens. It will
1435  * mark the necessary flags according to the event and notify the necessary
1436  * threads (mainly precreate thread).
1437  *
1438  * \param[in] obd       OSP OBD device
1439  * \param[in] imp       import attached from OSP to remote (OST/MDT) service
1440  * \param[in] event     event related to remote service (IMP_EVENT_*)
1441  *
1442  * \retval 0            0 if the event handling succeeded.
1443  * \retval negative     negative errno if the event handling failed.
1444  */
1445 static int osp_import_event(struct obd_device *obd, struct obd_import *imp,
1446                             enum obd_import_event event)
1447 {
1448         struct osp_device *d = lu2osp_dev(obd->obd_lu_dev);
1449
1450         switch (event) {
1451         case IMP_EVENT_DISCON:
1452                 d->opd_got_disconnected = 1;
1453                 d->opd_imp_connected = 0;
1454                 if (d->opd_connect_mdt)
1455                         break;
1456
1457                 if (d->opd_pre != NULL) {
1458                         osp_pre_update_status(d, -ENODEV);
1459                         wake_up(&d->opd_pre_waitq);
1460                 }
1461
1462                 CDEBUG(D_HA, "got disconnected\n");
1463                 break;
1464         case IMP_EVENT_INACTIVE:
1465                 d->opd_imp_active = 0;
1466                 if (d->opd_connect_mdt)
1467                         break;
1468
1469                 if (d->opd_pre != NULL) {
1470                         osp_pre_update_status(d, -ENODEV);
1471                         wake_up(&d->opd_pre_waitq);
1472                 }
1473
1474                 CDEBUG(D_HA, "got inactive\n");
1475                 break;
1476         case IMP_EVENT_ACTIVE:
1477                 d->opd_imp_active = 1;
1478
1479                 osp_prepare_fid_client(d);
1480                 if (d->opd_got_disconnected)
1481                         d->opd_new_connection = 1;
1482                 d->opd_imp_connected = 1;
1483                 d->opd_imp_seen_connected = 1;
1484                 if (d->opd_connect_mdt)
1485                         break;
1486
1487                 if (d->opd_pre != NULL)
1488                         wake_up(&d->opd_pre_waitq);
1489
1490                 __osp_sync_check_for_work(d);
1491                 CDEBUG(D_HA, "got connected\n");
1492                 break;
1493         case IMP_EVENT_INVALIDATE:
1494                 if (obd->obd_namespace == NULL)
1495                         break;
1496                 ldlm_namespace_cleanup(obd->obd_namespace, LDLM_FL_LOCAL_ONLY);
1497                 break;
1498         case IMP_EVENT_OCD:
1499         case IMP_EVENT_DEACTIVATE:
1500         case IMP_EVENT_ACTIVATE:
1501                 break;
1502         default:
1503                 CERROR("%s: unsupported import event: %#x\n",
1504                        obd->obd_name, event);
1505         }
1506         return 0;
1507 }
1508
1509 /**
1510  * Implementation of obd_ops: o_iocontrol
1511  *
1512  * This function is the ioctl handler for OSP. Note: lctl will access the OSP
1513  * directly by ioctl, instead of through the MDS stack.
1514  *
1515  * param[in] cmd        ioctl command.
1516  * param[in] exp        export of this OSP.
1517  * param[in] len        data length of \a karg.
1518  * param[in] karg       input argument which is packed as
1519  *                      obd_ioctl_data
1520  * param[out] uarg      pointer to userspace buffer (must access by
1521  *                      copy_to_user()).
1522  *
1523  * \retval 0            0 if the ioctl handling succeeded.
1524  * \retval negative     negative errno if the ioctl handling failed.
1525  */
1526 static int osp_iocontrol(unsigned int cmd, struct obd_export *exp, int len,
1527                          void *karg, void *uarg)
1528 {
1529         struct obd_device       *obd = exp->exp_obd;
1530         struct osp_device       *d;
1531         struct obd_ioctl_data   *data = karg;
1532         int                      rc = 0;
1533
1534         ENTRY;
1535
1536         LASSERT(obd->obd_lu_dev);
1537         d = lu2osp_dev(obd->obd_lu_dev);
1538         LASSERT(d->opd_dt_dev.dd_ops == &osp_dt_ops);
1539
1540         if (!try_module_get(THIS_MODULE)) {
1541                 CERROR("%s: cannot get module '%s'\n", obd->obd_name,
1542                        module_name(THIS_MODULE));
1543                 return -EINVAL;
1544         }
1545
1546         switch (cmd) {
1547         case OBD_IOC_CLIENT_RECOVER:
1548                 rc = ptlrpc_recover_import(obd->u.cli.cl_import,
1549                                            data->ioc_inlbuf1, 0);
1550                 if (rc > 0)
1551                         rc = 0;
1552                 break;
1553         case IOC_OSC_SET_ACTIVE:
1554                 rc = ptlrpc_set_import_active(obd->u.cli.cl_import,
1555                                               data->ioc_offset);
1556                 break;
1557         case OBD_IOC_PING_TARGET:
1558                 rc = ptlrpc_obd_ping(obd);
1559                 break;
1560         default:
1561                 CERROR("%s: unrecognized ioctl %#x by %s\n", obd->obd_name,
1562                        cmd, current_comm());
1563                 rc = -ENOTTY;
1564         }
1565         module_put(THIS_MODULE);
1566         return rc;
1567 }
1568
1569 /**
1570  * Implementation of obd_ops::o_get_info
1571  *
1572  * Retrieve information by key. Retrieval starts from the top layer
1573  * (MDT) of the MDS stack and traverses the stack by calling the
1574  * obd_get_info() method of the next sub-layer.
1575  *
1576  * \param[in] env       execution environment
1577  * \param[in] exp       export of this OSP
1578  * \param[in] keylen    length of \a key
1579  * \param[in] key       the key
1580  * \param[out] vallen   length of \a val
1581  * \param[out] val      holds the value returned by the key
1582  * \param[in] unused    necessary for the interface but unused
1583  *
1584  * \retval 0            0 if getting information succeeded.
1585  * \retval negative     negative errno if getting information failed.
1586  */
1587 static int osp_obd_get_info(const struct lu_env *env, struct obd_export *exp,
1588                             __u32 keylen, void *key, __u32 *vallen, void *val,
1589                             struct lov_stripe_md *unused)
1590 {
1591         int rc = -EINVAL;
1592
1593         if (KEY_IS(KEY_OSP_CONNECTED)) {
1594                 struct obd_device       *obd = exp->exp_obd;
1595                 struct osp_device       *osp;
1596
1597                 if (!obd->obd_set_up || obd->obd_stopping)
1598                         RETURN(-EAGAIN);
1599
1600                 osp = lu2osp_dev(obd->obd_lu_dev);
1601                 LASSERT(osp);
1602                 /*
1603                  * 1.8/2.0 behaviour is that OST being connected once at least
1604                  * is considered "healthy". and one "healthy" OST is enough to
1605                  * allow lustre clients to connect to MDS
1606                  */
1607                 RETURN(!osp->opd_imp_seen_connected);
1608         }
1609
1610         RETURN(rc);
1611 }
1612
1613 /**
1614  * Implementation of obd_ops: o_fid_alloc
1615  *
1616  * Allocate a FID. There are two cases in which OSP performs
1617  * FID allocation.
1618  *
1619  * 1. FID precreation for data objects, which is done in
1620  *    osp_precreate_fids() instead of this function.
1621  * 2. FID allocation for each sub-stripe of a striped directory.
1622  *    Similar to other FID clients, OSP requests the sequence
1623  *    from its corresponding remote MDT, which in turn requests
1624  *    sequences from the sequence controller (MDT0).
1625  *
1626  * \param[in] env       execution environment
1627  * \param[in] exp       export of the OSP
1628  * \param[out] fid      FID being allocated
1629  * \param[in] unused    necessary for the interface but unused.
1630  *
1631  * \retval 0            0 FID allocated successfully.
1632  * \retval 1            1 FID allocated successfully and new sequence
1633  *                      requested from seq meta server
1634  * \retval negative     negative errno if FID allocation failed.
1635  */
1636 int osp_fid_alloc(const struct lu_env *env, struct obd_export *exp,
1637                   struct lu_fid *fid, struct md_op_data *unused)
1638 {
1639         struct client_obd       *cli = &exp->exp_obd->u.cli;
1640         struct osp_device       *osp = lu2osp_dev(exp->exp_obd->obd_lu_dev);
1641         struct lu_client_seq    *seq = cli->cl_seq;
1642         ENTRY;
1643
1644         LASSERT(osp->opd_obd->u.cli.cl_seq != NULL);
1645         /* Sigh, fid client is not ready yet */
1646         if (osp->opd_obd->u.cli.cl_seq->lcs_exp == NULL)
1647                 RETURN(-ENOTCONN);
1648
1649         RETURN(seq_client_alloc_fid(env, seq, fid));
1650 }
1651
1652 /* context key constructor/destructor: mdt_key_init, mdt_key_fini */
1653 LU_KEY_INIT_FINI(osp, struct osp_thread_info);
1654 static void osp_key_exit(const struct lu_context *ctx,
1655                          struct lu_context_key *key, void *data)
1656 {
1657         struct osp_thread_info *info = data;
1658
1659         info->osi_attr.la_valid = 0;
1660 }
1661
1662 struct lu_context_key osp_thread_key = {
1663         .lct_tags = LCT_MD_THREAD,
1664         .lct_init = osp_key_init,
1665         .lct_fini = osp_key_fini,
1666         .lct_exit = osp_key_exit
1667 };
1668
1669 /* context key constructor/destructor: mdt_txn_key_init, mdt_txn_key_fini */
1670 LU_KEY_INIT_FINI(osp_txn, struct osp_txn_info);
1671
1672 struct lu_context_key osp_txn_key = {
1673         .lct_tags = LCT_OSP_THREAD | LCT_TX_HANDLE,
1674         .lct_init = osp_txn_key_init,
1675         .lct_fini = osp_txn_key_fini
1676 };
1677 LU_TYPE_INIT_FINI(osp, &osp_thread_key, &osp_txn_key);
1678
1679 static struct lu_device_type_operations osp_device_type_ops = {
1680         .ldto_init           = osp_type_init,
1681         .ldto_fini           = osp_type_fini,
1682
1683         .ldto_start          = osp_type_start,
1684         .ldto_stop           = osp_type_stop,
1685
1686         .ldto_device_alloc   = osp_device_alloc,
1687         .ldto_device_free    = osp_device_free,
1688
1689         .ldto_device_fini    = osp_device_fini
1690 };
1691
1692 static struct lu_device_type osp_device_type = {
1693         .ldt_tags     = LU_DEVICE_DT,
1694         .ldt_name     = LUSTRE_OSP_NAME,
1695         .ldt_ops      = &osp_device_type_ops,
1696         .ldt_ctx_tags = LCT_MD_THREAD | LCT_DT_THREAD,
1697 };
1698
1699 static struct obd_ops osp_obd_device_ops = {
1700         .o_owner        = THIS_MODULE,
1701         .o_add_conn     = client_import_add_conn,
1702         .o_del_conn     = client_import_del_conn,
1703         .o_reconnect    = osp_reconnect,
1704         .o_connect      = osp_obd_connect,
1705         .o_disconnect   = osp_obd_disconnect,
1706         .o_get_info     = osp_obd_get_info,
1707         .o_import_event = osp_import_event,
1708         .o_iocontrol    = osp_iocontrol,
1709         .o_statfs       = osp_obd_statfs,
1710         .o_fid_init     = client_fid_init,
1711         .o_fid_fini     = client_fid_fini,
1712         .o_fid_alloc    = osp_fid_alloc,
1713 };
1714
1715 struct llog_operations osp_mds_ost_orig_logops;
1716
1717 /**
1718  * Initialize OSP module.
1719  *
1720  * Register device types OSP and Light Weight Proxy (LWP) (\see lwp_dev.c)
1721  * in obd_types (\see class_obd.c).  Initialize procfs for the
1722  * the OSP device.  Note: OSP was called OSC before Lustre 2.4,
1723  * so for compatibility it still uses the name "osc" in procfs.
1724  * This is called at module load time.
1725  *
1726  * \retval 0            0 if initialization succeeds.
1727  * \retval negative     negative errno if initialization failed.
1728  */
1729 static int __init osp_mod_init(void)
1730 {
1731         struct obd_type *type;
1732         int rc;
1733
1734         rc = lu_kmem_init(osp_caches);
1735         if (rc)
1736                 return rc;
1737
1738
1739         rc = class_register_type(&osp_obd_device_ops, NULL, true, NULL,
1740                                  LUSTRE_OSP_NAME, &osp_device_type);
1741         if (rc != 0) {
1742                 lu_kmem_fini(osp_caches);
1743                 return rc;
1744         }
1745
1746         rc = class_register_type(&lwp_obd_device_ops, NULL, true, NULL,
1747                                  LUSTRE_LWP_NAME, &lwp_device_type);
1748         if (rc != 0) {
1749                 class_unregister_type(LUSTRE_OSP_NAME);
1750                 lu_kmem_fini(osp_caches);
1751                 return rc;
1752         }
1753
1754         /* Note: add_rec/delcare_add_rec will be only used by catalogs */
1755         osp_mds_ost_orig_logops = llog_osd_ops;
1756         osp_mds_ost_orig_logops.lop_add = llog_cat_add_rec;
1757         osp_mds_ost_orig_logops.lop_declare_add = llog_cat_declare_add_rec;
1758
1759         /* create "osc" entry in procfs for compatibility purposes */
1760         type = class_search_type(LUSTRE_OSC_NAME);
1761         if (type != NULL && type->typ_procroot != NULL)
1762                 return rc;
1763
1764         type = class_search_type(LUSTRE_OSP_NAME);
1765         type->typ_procsym = lprocfs_seq_register("osc", proc_lustre_root,
1766                                                  NULL, NULL);
1767         if (IS_ERR(type->typ_procsym)) {
1768                 CERROR("osp: can't create compat entry \"osc\": %d\n",
1769                        (int) PTR_ERR(type->typ_procsym));
1770                 type->typ_procsym = NULL;
1771         }
1772         return rc;
1773 }
1774
1775 /**
1776  * Finalize OSP module.
1777  *
1778  * This callback is called when kernel unloads OSP module from memory, and
1779  * it will deregister OSP and LWP device type from obd_types (\see class_obd.c).
1780  */
1781 static void __exit osp_mod_exit(void)
1782 {
1783         class_unregister_type(LUSTRE_LWP_NAME);
1784         class_unregister_type(LUSTRE_OSP_NAME);
1785         lu_kmem_fini(osp_caches);
1786 }
1787
1788 MODULE_AUTHOR("Intel, Inc. <http://www.intel.com/>");
1789 MODULE_DESCRIPTION("Lustre OST Proxy Device ("LUSTRE_OSP_NAME")");
1790 MODULE_LICENSE("GPL");
1791
1792 cfs_module(osp, LUSTRE_VERSION_STRING, osp_mod_init, osp_mod_exit);