Whamcloud - gitweb
dae446f6731e2a91460bf2a8a69d9d62acb0f742
[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, 2014, 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 <linux/kthread.h>
78 #include <obd_class.h>
79 #include <lustre_ioctl.h>
80 #include <lustre_param.h>
81 #include <lustre_log.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 static 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);
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  * Initialize the osp_update structure in OSP device
488  *
489  * Allocate osp update structure and start update thread.
490  *
491  * \param[in] osp       OSP device
492  *
493  * \retval              0 if initialization succeeds.
494  * \retval              negative errno if initialization fails.
495  */
496 static int osp_update_init(struct osp_device *osp)
497 {
498         struct l_wait_info      lwi = { 0 };
499         struct task_struct      *task;
500
501         ENTRY;
502
503         LASSERT(osp->opd_connect_mdt);
504
505         OBD_ALLOC_PTR(osp->opd_update);
506         if (osp->opd_update == NULL)
507                 RETURN(-ENOMEM);
508
509         init_waitqueue_head(&osp->opd_update_thread.t_ctl_waitq);
510         init_waitqueue_head(&osp->opd_update->ou_waitq);
511         spin_lock_init(&osp->opd_update->ou_lock);
512         INIT_LIST_HEAD(&osp->opd_update->ou_list);
513         osp->opd_update->ou_rpc_version = 1;
514         osp->opd_update->ou_version = 1;
515
516         /* start thread handling sending updates to the remote MDT */
517         task = kthread_run(osp_send_update_thread, osp,
518                            "osp_up%u-%u", osp->opd_index, osp->opd_group);
519         if (IS_ERR(task)) {
520                 int rc = PTR_ERR(task);
521
522                 OBD_FREE_PTR(osp->opd_update);
523                 osp->opd_update = NULL;
524                 CERROR("%s: can't start precreate thread: rc = %d\n",
525                        osp->opd_obd->obd_name, rc);
526                 RETURN(rc);
527         }
528
529         l_wait_event(osp->opd_update_thread.t_ctl_waitq,
530                      osp_send_update_thread_running(osp) ||
531                      osp_send_update_thread_stopped(osp), &lwi);
532
533         RETURN(0);
534 }
535
536 /**
537  * Finialize osp_update structure in OSP device
538  *
539  * Stop the OSP update sending thread, then delete the left
540  * osp thandle in the sending list.
541  *
542  * \param [in] osp      OSP device.
543  */
544 static void osp_update_fini(const struct lu_env *env, struct osp_device *osp)
545 {
546         struct osp_update_request *our;
547         struct osp_update_request *tmp;
548         struct osp_updates *ou = osp->opd_update;
549
550         if (ou == NULL)
551                 return;
552
553         osp->opd_update_thread.t_flags = SVC_STOPPING;
554         wake_up(&ou->ou_waitq);
555
556         wait_event(osp->opd_update_thread.t_ctl_waitq,
557                    osp->opd_update_thread.t_flags & SVC_STOPPED);
558
559         /* Remove the left osp thandle from the list */
560         spin_lock(&ou->ou_lock);
561         list_for_each_entry_safe(our, tmp, &ou->ou_list,
562                                  our_list) {
563                 list_del_init(&our->our_list);
564                 LASSERT(our->our_th != NULL);
565                 osp_trans_callback(env, our->our_th, -EIO);
566                 /* our will be destroyed in osp_thandle_put() */
567                 osp_thandle_put(our->our_th);
568         }
569         spin_unlock(&ou->ou_lock);
570
571         OBD_FREE_PTR(ou);
572         osp->opd_update = NULL;
573 }
574
575 /**
576  * Cleanup OSP, which includes disconnect import, cleanup unlink log, stop
577  * precreate threads etc.
578  *
579  * \param[in] env       execution environment.
580  * \param[in] d         OSP device being disconnected.
581  *
582  * \retval 0            0 if cleanup succeed
583  * \retval negative     negative errno if cleanup failed
584  */
585 static int osp_shutdown(const struct lu_env *env, struct osp_device *d)
586 {
587         int                      rc = 0;
588         ENTRY;
589
590         LASSERT(env);
591
592         rc = osp_disconnect(d);
593
594         if (!d->opd_connect_mdt) {
595                 /* stop sync thread */
596                 osp_sync_fini(d);
597
598                 /* stop precreate thread */
599                 osp_precreate_fini(d);
600
601                 /* release last_used file */
602                 osp_last_used_fini(env, d);
603         }
604
605         obd_fid_fini(d->opd_obd);
606
607         RETURN(rc);
608 }
609
610 /**
611  * Implementation of osp_lu_ops::ldo_process_config
612  *
613  * This function processes config log records in OSP layer. It is usually
614  * called from the top layer of MDT stack, and goes through the stack by calling
615  * ldo_process_config of next layer.
616  *
617  * \param[in] env       execution environment
618  * \param[in] dev       lu_device of OSP
619  * \param[in] lcfg      config log
620  *
621  * \retval 0            0 if the config log record is executed correctly.
622  * \retval negative     negative errno if the record execution fails.
623  */
624 static int osp_process_config(const struct lu_env *env,
625                               struct lu_device *dev, struct lustre_cfg *lcfg)
626 {
627         struct osp_device               *d = lu2osp_dev(dev);
628         struct obd_device               *obd = d->opd_obd;
629         int                              rc;
630
631         ENTRY;
632
633         switch (lcfg->lcfg_command) {
634         case LCFG_PRE_CLEANUP:
635                 rc = osp_disconnect(d);
636                 osp_update_fini(env, d);
637                 break;
638         case LCFG_CLEANUP:
639                 lu_dev_del_linkage(dev->ld_site, dev);
640                 rc = osp_shutdown(env, d);
641                 break;
642         case LCFG_PARAM:
643                 LASSERT(obd);
644                 rc = class_process_proc_param(PARAM_OSC, obd->obd_vars,
645                                               lcfg, obd);
646                 if (rc > 0)
647                         rc = 0;
648                 if (rc == -ENOSYS) {
649                         /* class_process_proc_param() haven't found matching
650                          * parameter and returned ENOSYS so that layer(s)
651                          * below could use that. But OSP is the bottom, so
652                          * just ignore it */
653                         CERROR("%s: unknown param %s\n",
654                                (char *)lustre_cfg_string(lcfg, 0),
655                                (char *)lustre_cfg_string(lcfg, 1));
656                         rc = 0;
657                 }
658                 break;
659         default:
660                 CERROR("%s: unknown command %u\n",
661                        (char *)lustre_cfg_string(lcfg, 0), lcfg->lcfg_command);
662                 rc = 0;
663                 break;
664         }
665
666         RETURN(rc);
667 }
668
669 /**
670  * Implementation of osp_lu_ops::ldo_recovery_complete
671  *
672  * This function is called after recovery is finished, and OSP layer
673  * will wake up precreate thread here.
674  *
675  * \param[in] env       execution environment
676  * \param[in] dev       lu_device of OSP
677  *
678  * \retval 0            0 unconditionally
679  */
680 static int osp_recovery_complete(const struct lu_env *env,
681                                  struct lu_device *dev)
682 {
683         struct osp_device       *osp = lu2osp_dev(dev);
684
685         ENTRY;
686         osp->opd_recovery_completed = 1;
687
688         if (!osp->opd_connect_mdt && osp->opd_pre != NULL)
689                 wake_up(&osp->opd_pre_waitq);
690
691         RETURN(0);
692 }
693
694 const struct lu_device_operations osp_lu_ops = {
695         .ldo_object_alloc       = osp_object_alloc,
696         .ldo_process_config     = osp_process_config,
697         .ldo_recovery_complete  = osp_recovery_complete,
698 };
699
700 /**
701  * Implementation of dt_device_operations::dt_statfs
702  *
703  * This function provides statfs status (for precreation) from
704  * corresponding OST. Note: this function only retrieves the status
705  * from the OSP device, and the real statfs RPC happens inside
706  * precreate thread (\see osp_statfs_update). Note: OSP for MDT does
707  * not need to retrieve statfs data for now.
708  *
709  * \param[in] env       execution environment.
710  * \param[in] dev       dt_device of OSP.
711  * \param[out] sfs      holds the retrieved statfs data.
712  *
713  * \retval 0            0 statfs data was retrieved successfully or
714  *                      retrieval was not needed
715  * \retval negative     negative errno if get statfs failed.
716  */
717 static int osp_statfs(const struct lu_env *env, struct dt_device *dev,
718                       struct obd_statfs *sfs)
719 {
720         struct osp_device *d = dt2osp_dev(dev);
721
722         ENTRY;
723
724         if (unlikely(d->opd_imp_active == 0))
725                 RETURN(-ENOTCONN);
726
727         if (d->opd_pre == NULL)
728                 RETURN(0);
729
730         /* return recently updated data */
731         *sfs = d->opd_statfs;
732
733         /*
734          * layer above osp (usually lod) can use ffree to estimate
735          * how many objects are available for immediate creation
736          */
737         spin_lock(&d->opd_pre_lock);
738         LASSERTF(fid_seq(&d->opd_pre_last_created_fid) ==
739                  fid_seq(&d->opd_pre_used_fid),
740                  "last_created "DFID", next_fid "DFID"\n",
741                  PFID(&d->opd_pre_last_created_fid),
742                  PFID(&d->opd_pre_used_fid));
743         sfs->os_fprecreated = fid_oid(&d->opd_pre_last_created_fid) -
744                               fid_oid(&d->opd_pre_used_fid);
745         sfs->os_fprecreated -= d->opd_pre_reserved;
746         spin_unlock(&d->opd_pre_lock);
747
748         LASSERT(sfs->os_fprecreated <= OST_MAX_PRECREATE * 2);
749
750         CDEBUG(D_OTHER, "%s: "LPU64" blocks, "LPU64" free, "LPU64" avail, "
751                LPU64" files, "LPU64" free files\n", d->opd_obd->obd_name,
752                sfs->os_blocks, sfs->os_bfree, sfs->os_bavail,
753                sfs->os_files, sfs->os_ffree);
754         RETURN(0);
755 }
756
757 static int osp_sync_timeout(void *data)
758 {
759         return 1;
760 }
761
762 /**
763  * Implementation of dt_device_operations::dt_sync
764  *
765  * This function synchronizes the OSP cache to the remote target. It wakes
766  * up unlink log threads and sends out unlink records to the remote OST.
767  *
768  * \param[in] env       execution environment
769  * \param[in] dev       dt_device of OSP
770  *
771  * \retval 0            0 if synchronization succeeds
772  * \retval negative     negative errno if synchronization fails
773  */
774 static int osp_sync(const struct lu_env *env, struct dt_device *dev)
775 {
776         struct osp_device *d = dt2osp_dev(dev);
777         cfs_time_t         expire;
778         struct l_wait_info lwi = { 0 };
779         unsigned long      id, old;
780         int                rc = 0;
781         unsigned long      start = cfs_time_current();
782         ENTRY;
783
784         /* No Sync between MDTs yet. */
785         if (d->opd_connect_mdt)
786                 RETURN(0);
787
788         if (unlikely(d->opd_imp_active == 0))
789                 RETURN(-ENOTCONN);
790
791         id = d->opd_syn_last_used_id;
792         down_write(&d->opd_async_updates_rwsem);
793
794         CDEBUG(D_OTHER, "%s: async updates %d\n", d->opd_obd->obd_name,
795                atomic_read(&d->opd_async_updates_count));
796
797         /* make sure the connection is fine */
798         expire = cfs_time_shift(obd_timeout);
799         lwi = LWI_TIMEOUT(expire - cfs_time_current(), osp_sync_timeout, d);
800         rc = l_wait_event(d->opd_syn_barrier_waitq,
801                           atomic_read(&d->opd_async_updates_count) == 0,
802                           &lwi);
803         up_write(&d->opd_async_updates_rwsem);
804         if (rc != 0)
805                 GOTO(out, rc);
806
807         CDEBUG(D_CACHE, "%s: id: used %lu, processed %lu\n",
808                d->opd_obd->obd_name, id, d->opd_syn_last_processed_id);
809
810         /* wait till all-in-line are processed */
811         while (d->opd_syn_last_processed_id < id) {
812
813                 old = d->opd_syn_last_processed_id;
814
815                 /* make sure the connection is fine */
816                 expire = cfs_time_shift(obd_timeout);
817                 lwi = LWI_TIMEOUT(expire - cfs_time_current(),
818                                   osp_sync_timeout, d);
819                 l_wait_event(d->opd_syn_barrier_waitq,
820                              d->opd_syn_last_processed_id >= id,
821                              &lwi);
822
823                 if (d->opd_syn_last_processed_id >= id)
824                         break;
825
826                 if (d->opd_syn_last_processed_id != old) {
827                         /* some progress have been made,
828                          * keep trying... */
829                         continue;
830                 }
831
832                 /* no changes and expired, something is wrong */
833                 GOTO(out, rc = -ETIMEDOUT);
834         }
835
836         /* block new processing (barrier>0 - few callers are possible */
837         atomic_inc(&d->opd_syn_barrier);
838
839         CDEBUG(D_CACHE, "%s: %u in flight\n", d->opd_obd->obd_name,
840                d->opd_syn_rpc_in_flight);
841
842         /* wait till all-in-flight are replied, so executed by the target */
843         /* XXX: this is used by LFSCK at the moment, which doesn't require
844          *      all the changes to be committed, but in general it'd be
845          *      better to wait till commit */
846         while (d->opd_syn_rpc_in_flight > 0) {
847
848                 old = d->opd_syn_rpc_in_flight;
849
850                 expire = cfs_time_shift(obd_timeout);
851                 lwi = LWI_TIMEOUT(expire - cfs_time_current(),
852                                   osp_sync_timeout, d);
853                 l_wait_event(d->opd_syn_barrier_waitq,
854                                 d->opd_syn_rpc_in_flight == 0, &lwi);
855
856                 if (d->opd_syn_rpc_in_flight == 0)
857                         break;
858
859                 if (d->opd_syn_rpc_in_flight != old) {
860                         /* some progress have been made */
861                         continue;
862                 }
863
864                 /* no changes and expired, something is wrong */
865                 GOTO(out, rc = -ETIMEDOUT);
866         }
867
868 out:
869         /* resume normal processing (barrier=0) */
870         atomic_dec(&d->opd_syn_barrier);
871         __osp_sync_check_for_work(d);
872
873         CDEBUG(D_CACHE, "%s: done in %lu: rc = %d\n", d->opd_obd->obd_name,
874                cfs_time_current() - start, rc);
875
876         RETURN(rc);
877 }
878
879 const struct dt_device_operations osp_dt_ops = {
880         .dt_statfs       = osp_statfs,
881         .dt_sync         = osp_sync,
882         .dt_trans_create = osp_trans_create,
883         .dt_trans_start  = osp_trans_start,
884         .dt_trans_stop   = osp_trans_stop,
885         .dt_trans_cb_add   = osp_trans_cb_add,
886 };
887
888 /**
889  * Connect OSP to local OSD.
890  *
891  * Locate the local OSD referenced by \a nextdev and connect to it. Sometimes,
892  * OSP needs to access the local OSD to store some information. For example,
893  * during precreate, it needs to update last used OID and sequence file
894  * (LAST_SEQ) in local OSD.
895  *
896  * \param[in] env       execution environment
897  * \param[in] osp       OSP device
898  * \param[in] nextdev   the name of local OSD
899  *
900  * \retval 0            0 connection succeeded
901  * \retval negative     negative errno connection failed
902  */
903 static int osp_connect_to_osd(const struct lu_env *env, struct osp_device *osp,
904                               const char *nextdev)
905 {
906         struct obd_connect_data *data = NULL;
907         struct obd_device       *obd;
908         int                      rc;
909
910         ENTRY;
911
912         LASSERT(osp->opd_storage_exp == NULL);
913
914         OBD_ALLOC_PTR(data);
915         if (data == NULL)
916                 RETURN(-ENOMEM);
917
918         obd = class_name2obd(nextdev);
919         if (obd == NULL) {
920                 CERROR("%s: can't locate next device: %s\n",
921                        osp->opd_obd->obd_name, nextdev);
922                 GOTO(out, rc = -ENOTCONN);
923         }
924
925         rc = obd_connect(env, &osp->opd_storage_exp, obd, &obd->obd_uuid, data,
926                          NULL);
927         if (rc) {
928                 CERROR("%s: cannot connect to next dev %s: rc = %d\n",
929                        osp->opd_obd->obd_name, nextdev, rc);
930                 GOTO(out, rc);
931         }
932
933         osp->opd_dt_dev.dd_lu_dev.ld_site =
934                 osp->opd_storage_exp->exp_obd->obd_lu_dev->ld_site;
935         LASSERT(osp->opd_dt_dev.dd_lu_dev.ld_site);
936         osp->opd_storage = lu2dt_dev(osp->opd_storage_exp->exp_obd->obd_lu_dev);
937
938 out:
939         OBD_FREE_PTR(data);
940         RETURN(rc);
941 }
942
943 /**
944  * Determine if the lock needs to be cancelled
945  *
946  * Determine if the unused lock should be cancelled before replay, see
947  * (ldlm_cancel_no_wait_policy()). Currently, only inode bits lock exists
948  * between MDTs.
949  *
950  * \param[in] lock      lock to be checked.
951  *
952  * \retval              1 if the lock needs to be cancelled before replay.
953  * \retval              0 if the lock does not need to be cancelled before
954  *                      replay.
955  */
956 static int osp_cancel_weight(struct ldlm_lock *lock)
957 {
958         if (lock->l_resource->lr_type != LDLM_IBITS)
959                 RETURN(0);
960
961         RETURN(1);
962 }
963
964 /**
965  * Initialize OSP device according to the parameters in the configuration
966  * log \a cfg.
967  *
968  * Reconstruct the local device name from the configuration profile, and
969  * initialize necessary threads and structures according to the OSP type
970  * (MDT or OST).
971  *
972  * Since there is no record in the MDT configuration for the local disk
973  * device, we have to extract this from elsewhere in the profile.
974  * The only information we get at setup is from the OSC records:
975  * setup 0:{fsname}-OSTxxxx-osc[-MDTxxxx] 1:lustre-OST0000_UUID 2:NID
976  *
977  * Note: configs generated by Lustre 1.8 are missing the -MDTxxxx part,
978  * so, we need to reconstruct the name of the underlying OSD from this:
979  * {fsname}-{svname}-osd, for example "lustre-MDT0000-osd".
980  *
981  * \param[in] env       execution environment
982  * \param[in] osp       OSP device
983  * \param[in] ldt       lu device type of OSP
984  * \param[in] cfg       configuration log
985  *
986  * \retval 0            0 if OSP initialization succeeded.
987  * \retval negative     negative errno if OSP initialization failed.
988  */
989 static int osp_init0(const struct lu_env *env, struct osp_device *osp,
990                      struct lu_device_type *ldt, struct lustre_cfg *cfg)
991 {
992         struct obd_device       *obd;
993         struct obd_import       *imp;
994         class_uuid_t            uuid;
995         char                    *src, *tgt, *mdt, *osdname = NULL;
996         int                     rc;
997         long                    idx;
998
999         ENTRY;
1000
1001         mutex_init(&osp->opd_async_requests_mutex);
1002         INIT_LIST_HEAD(&osp->opd_async_updates);
1003         init_rwsem(&osp->opd_async_updates_rwsem);
1004         atomic_set(&osp->opd_async_updates_count, 0);
1005
1006         obd = class_name2obd(lustre_cfg_string(cfg, 0));
1007         if (obd == NULL) {
1008                 CERROR("Cannot find obd with name %s\n",
1009                        lustre_cfg_string(cfg, 0));
1010                 RETURN(-ENODEV);
1011         }
1012         osp->opd_obd = obd;
1013
1014         src = lustre_cfg_string(cfg, 0);
1015         if (src == NULL)
1016                 RETURN(-EINVAL);
1017
1018         tgt = strrchr(src, '-');
1019         if (tgt == NULL) {
1020                 CERROR("%s: invalid target name %s: rc = %d\n",
1021                        osp->opd_obd->obd_name, lustre_cfg_string(cfg, 0),
1022                        -EINVAL);
1023                 RETURN(-EINVAL);
1024         }
1025
1026         if (strncmp(tgt, "-osc", 4) == 0) {
1027                 /* Old OSC name fsname-OSTXXXX-osc */
1028                 for (tgt--; tgt > src && *tgt != '-'; tgt--)
1029                         ;
1030                 if (tgt == src) {
1031                         CERROR("%s: invalid target name %s: rc = %d\n",
1032                                osp->opd_obd->obd_name,
1033                                lustre_cfg_string(cfg, 0), -EINVAL);
1034                         RETURN(-EINVAL);
1035                 }
1036
1037                 if (strncmp(tgt, "-OST", 4) != 0) {
1038                         CERROR("%s: invalid target name %s: rc = %d\n",
1039                                osp->opd_obd->obd_name,
1040                                lustre_cfg_string(cfg, 0), -EINVAL);
1041                         RETURN(-EINVAL);
1042                 }
1043
1044                 idx = simple_strtol(tgt + 4, &mdt, 16);
1045                 if (mdt[0] != '-' || idx > INT_MAX || idx < 0) {
1046                         CERROR("%s: invalid OST index in '%s': rc = %d\n",
1047                                osp->opd_obd->obd_name, src, -EINVAL);
1048                         RETURN(-EINVAL);
1049                 }
1050                 osp->opd_index = idx;
1051                 osp->opd_group = 0;
1052                 idx = tgt - src;
1053         } else {
1054                 /* New OSC name fsname-OSTXXXX-osc-MDTXXXX */
1055                 if (strncmp(tgt, "-MDT", 4) != 0 &&
1056                     strncmp(tgt, "-OST", 4) != 0) {
1057                         CERROR("%s: invalid target name %s: rc = %d\n",
1058                                osp->opd_obd->obd_name,
1059                                lustre_cfg_string(cfg, 0), -EINVAL);
1060                         RETURN(-EINVAL);
1061                 }
1062
1063                 idx = simple_strtol(tgt + 4, &mdt, 16);
1064                 if (*mdt != '\0' || idx > INT_MAX || idx < 0) {
1065                         CERROR("%s: invalid OST index in '%s': rc = %d\n",
1066                                osp->opd_obd->obd_name, src, -EINVAL);
1067                         RETURN(-EINVAL);
1068                 }
1069
1070                 /* Get MDT index from the name and set it to opd_group,
1071                  * which will be used by OSP to connect with OST */
1072                 osp->opd_group = idx;
1073                 if (tgt - src <= 12) {
1074                         CERROR("%s: invalid mdt index from %s: rc =%d\n",
1075                                osp->opd_obd->obd_name,
1076                                lustre_cfg_string(cfg, 0), -EINVAL);
1077                         RETURN(-EINVAL);
1078                 }
1079
1080                 if (strncmp(tgt - 12, "-MDT", 4) == 0)
1081                         osp->opd_connect_mdt = 1;
1082
1083                 idx = simple_strtol(tgt - 8, &mdt, 16);
1084                 if (mdt[0] != '-' || idx > INT_MAX || idx < 0) {
1085                         CERROR("%s: invalid OST index in '%s': rc =%d\n",
1086                                osp->opd_obd->obd_name, src, -EINVAL);
1087                         RETURN(-EINVAL);
1088                 }
1089
1090                 osp->opd_index = idx;
1091                 idx = tgt - src - 12;
1092         }
1093         /* check the fsname length, and after this everything else will fit */
1094         if (idx > MTI_NAME_MAXLEN) {
1095                 CERROR("%s: fsname too long in '%s': rc = %d\n",
1096                        osp->opd_obd->obd_name, src, -EINVAL);
1097                 RETURN(-EINVAL);
1098         }
1099
1100         OBD_ALLOC(osdname, MAX_OBD_NAME);
1101         if (osdname == NULL)
1102                 RETURN(-ENOMEM);
1103
1104         memcpy(osdname, src, idx); /* copy just the fsname part */
1105         osdname[idx] = '\0';
1106
1107         mdt = strstr(mdt, "-MDT");
1108         if (mdt == NULL) /* 1.8 configs don't have "-MDT0000" at the end */
1109                 strcat(osdname, "-MDT0000");
1110         else
1111                 strcat(osdname, mdt);
1112         strcat(osdname, "-osd");
1113         CDEBUG(D_HA, "%s: connect to %s (%s)\n", obd->obd_name, osdname, src);
1114
1115         if (osp->opd_connect_mdt) {
1116                 struct client_obd *cli = &osp->opd_obd->u.cli;
1117
1118                 OBD_ALLOC(cli->cl_rpc_lock, sizeof(*cli->cl_rpc_lock));
1119                 if (!cli->cl_rpc_lock)
1120                         GOTO(out_fini, rc = -ENOMEM);
1121                 osp_init_rpc_lock(cli->cl_rpc_lock);
1122         }
1123
1124         osp->opd_dt_dev.dd_lu_dev.ld_ops = &osp_lu_ops;
1125         osp->opd_dt_dev.dd_ops = &osp_dt_ops;
1126
1127         obd->obd_lu_dev = &osp->opd_dt_dev.dd_lu_dev;
1128
1129         rc = osp_connect_to_osd(env, osp, osdname);
1130         if (rc)
1131                 GOTO(out_fini, rc);
1132
1133         rc = ptlrpcd_addref();
1134         if (rc)
1135                 GOTO(out_disconnect, rc);
1136
1137         rc = client_obd_setup(obd, cfg);
1138         if (rc) {
1139                 CERROR("%s: can't setup obd: rc = %d\n", osp->opd_obd->obd_name,
1140                        rc);
1141                 GOTO(out_ref, rc);
1142         }
1143
1144         osp_lprocfs_init(osp);
1145
1146         rc = obd_fid_init(osp->opd_obd, NULL, osp->opd_connect_mdt ?
1147                           LUSTRE_SEQ_METADATA : LUSTRE_SEQ_DATA);
1148         if (rc) {
1149                 CERROR("%s: fid init error: rc = %d\n",
1150                        osp->opd_obd->obd_name, rc);
1151                 GOTO(out_proc, rc);
1152         }
1153
1154         if (!osp->opd_connect_mdt) {
1155                 /* Initialize last id from the storage - will be
1156                  * used in orphan cleanup. */
1157                 rc = osp_last_used_init(env, osp);
1158                 if (rc)
1159                         GOTO(out_fid, rc);
1160
1161
1162                 /* Initialize precreation thread, it handles new
1163                  * connections as well. */
1164                 rc = osp_init_precreate(osp);
1165                 if (rc)
1166                         GOTO(out_last_used, rc);
1167
1168                 /*
1169                  * Initialize synhronization mechanism taking
1170                  * care of propogating changes to OST in near
1171                  * transactional manner.
1172                  */
1173                 rc = osp_sync_init(env, osp);
1174                 if (rc < 0)
1175                         GOTO(out_precreat, rc);
1176         } else {
1177                 rc = osp_update_init(osp);
1178                 if (rc != 0)
1179                         GOTO(out_fid, rc);
1180         }
1181
1182         ns_register_cancel(obd->obd_namespace, osp_cancel_weight);
1183
1184         /*
1185          * Initiate connect to OST
1186          */
1187         ll_generate_random_uuid(uuid);
1188         class_uuid_unparse(uuid, &osp->opd_cluuid);
1189
1190         imp = obd->u.cli.cl_import;
1191
1192         rc = ptlrpc_init_import(imp);
1193         if (rc)
1194                 GOTO(out, rc);
1195         if (osdname)
1196                 OBD_FREE(osdname, MAX_OBD_NAME);
1197         RETURN(0);
1198
1199 out:
1200         if (!osp->opd_connect_mdt)
1201                 /* stop sync thread */
1202                 osp_sync_fini(osp);
1203 out_precreat:
1204         /* stop precreate thread */
1205         if (!osp->opd_connect_mdt)
1206                 osp_precreate_fini(osp);
1207         else
1208                 osp_update_fini(env, osp);
1209 out_last_used:
1210         if (!osp->opd_connect_mdt)
1211                 osp_last_used_fini(env, osp);
1212 out_fid:
1213         obd_fid_fini(osp->opd_obd);
1214 out_proc:
1215         ptlrpc_lprocfs_unregister_obd(obd);
1216         lprocfs_obd_cleanup(obd);
1217         if (osp->opd_symlink)
1218                 lprocfs_remove(&osp->opd_symlink);
1219         client_obd_cleanup(obd);
1220 out_ref:
1221         ptlrpcd_decref();
1222 out_disconnect:
1223         if (osp->opd_connect_mdt) {
1224                 struct client_obd *cli = &osp->opd_obd->u.cli;
1225                 if (cli->cl_rpc_lock != NULL) {
1226                         OBD_FREE_PTR(cli->cl_rpc_lock);
1227                         cli->cl_rpc_lock = NULL;
1228                 }
1229         }
1230         obd_disconnect(osp->opd_storage_exp);
1231 out_fini:
1232         if (osdname)
1233                 OBD_FREE(osdname, MAX_OBD_NAME);
1234         RETURN(rc);
1235 }
1236
1237 /**
1238  * Implementation of lu_device_type_operations::ldto_device_free
1239  *
1240  * Free the OSP device in memory.  No return value is needed for now,
1241  * so always return NULL to comply with the interface.
1242  *
1243  * \param[in] env       execution environment
1244  * \param[in] lu        lu_device of OSP
1245  *
1246  * \retval NULL         NULL unconditionally
1247  */
1248 static struct lu_device *osp_device_free(const struct lu_env *env,
1249                                          struct lu_device *lu)
1250 {
1251         struct osp_device *osp = lu2osp_dev(lu);
1252
1253         if (atomic_read(&lu->ld_ref) && lu->ld_site) {
1254                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_ERROR, NULL);
1255                 lu_site_print(env, lu->ld_site, &msgdata, lu_cdebug_printer);
1256         }
1257         dt_device_fini(&osp->opd_dt_dev);
1258         OBD_FREE_PTR(osp);
1259
1260         return NULL;
1261 }
1262
1263 /**
1264  * Implementation of lu_device_type_operations::ldto_device_alloc
1265  *
1266  * This function allocates and initializes OSP device in memory according to
1267  * the config log.
1268  *
1269  * \param[in] env       execution environment
1270  * \param[in] type      device type of OSP
1271  * \param[in] lcfg      config log
1272  *
1273  * \retval pointer              the pointer of allocated OSP if succeed.
1274  * \retval ERR_PTR(errno)       ERR_PTR(errno) if failed.
1275  */
1276 static struct lu_device *osp_device_alloc(const struct lu_env *env,
1277                                           struct lu_device_type *type,
1278                                           struct lustre_cfg *lcfg)
1279 {
1280         struct osp_device *osp;
1281         struct lu_device  *ld;
1282
1283         OBD_ALLOC_PTR(osp);
1284         if (osp == NULL) {
1285                 ld = ERR_PTR(-ENOMEM);
1286         } else {
1287                 int rc;
1288
1289                 ld = osp2lu_dev(osp);
1290                 dt_device_init(&osp->opd_dt_dev, type);
1291                 rc = osp_init0(env, osp, type, lcfg);
1292                 if (rc != 0) {
1293                         osp_device_free(env, ld);
1294                         ld = ERR_PTR(rc);
1295                 }
1296         }
1297         return ld;
1298 }
1299
1300 /**
1301  * Implementation of lu_device_type_operations::ldto_device_fini
1302  *
1303  * This function cleans up the OSP device, i.e. release and free those
1304  * attached items in osp_device.
1305  *
1306  * \param[in] env       execution environment
1307  * \param[in] ld        lu_device of OSP
1308  *
1309  * \retval NULL                 NULL if cleanup succeeded.
1310  * \retval ERR_PTR(errno)       ERR_PTR(errno) if cleanup failed.
1311  */
1312 static struct lu_device *osp_device_fini(const struct lu_env *env,
1313                                          struct lu_device *ld)
1314 {
1315         struct osp_device *osp = lu2osp_dev(ld);
1316         struct obd_import *imp;
1317         int                rc;
1318
1319         ENTRY;
1320
1321         if (osp->opd_async_requests != NULL) {
1322                 osp_update_request_destroy(osp->opd_async_requests);
1323                 osp->opd_async_requests = NULL;
1324         }
1325
1326         if (osp->opd_storage_exp)
1327                 obd_disconnect(osp->opd_storage_exp);
1328
1329         imp = osp->opd_obd->u.cli.cl_import;
1330
1331         if (osp->opd_symlink)
1332                 lprocfs_remove(&osp->opd_symlink);
1333
1334         LASSERT(osp->opd_obd);
1335         ptlrpc_lprocfs_unregister_obd(osp->opd_obd);
1336         lprocfs_obd_cleanup(osp->opd_obd);
1337
1338         if (osp->opd_connect_mdt) {
1339                 struct client_obd *cli = &osp->opd_obd->u.cli;
1340                 if (cli->cl_rpc_lock != NULL) {
1341                         OBD_FREE_PTR(cli->cl_rpc_lock);
1342                         cli->cl_rpc_lock = NULL;
1343                 }
1344         }
1345
1346         rc = client_obd_cleanup(osp->opd_obd);
1347         if (rc != 0) {
1348                 ptlrpcd_decref();
1349                 RETURN(ERR_PTR(rc));
1350         }
1351
1352         ptlrpcd_decref();
1353
1354         RETURN(NULL);
1355 }
1356
1357 /**
1358  * Implementation of obd_ops::o_reconnect
1359  *
1360  * This function is empty and does not need to do anything for now.
1361  */
1362 static int osp_reconnect(const struct lu_env *env,
1363                          struct obd_export *exp, struct obd_device *obd,
1364                          struct obd_uuid *cluuid,
1365                          struct obd_connect_data *data,
1366                          void *localdata)
1367 {
1368         return 0;
1369 }
1370
1371 /*
1372  * Implementation of obd_ops::o_connect
1373  *
1374  * Connect OSP to the remote target (MDT or OST). Allocate the
1375  * export and return it to the LOD, which calls this function
1376  * for each OSP to connect it to the remote target. This function
1377  * is currently only called once per OSP.
1378  *
1379  * \param[in] env       execution environment
1380  * \param[out] exp      export connected to OSP
1381  * \param[in] obd       OSP device
1382  * \param[in] cluuid    OSP device client uuid
1383  * \param[in] data      connect_data to be used to connect to the remote
1384  *                      target
1385  * \param[in] localdata necessary for the API interface, but not used in
1386  *                      this function
1387  *
1388  * \retval 0            0 if the connection succeeded.
1389  * \retval negative     negative errno if the connection failed.
1390  */
1391 static int osp_obd_connect(const struct lu_env *env, struct obd_export **exp,
1392                            struct obd_device *obd, struct obd_uuid *cluuid,
1393                            struct obd_connect_data *data, void *localdata)
1394 {
1395         struct osp_device       *osp = lu2osp_dev(obd->obd_lu_dev);
1396         struct obd_connect_data *ocd;
1397         struct obd_import       *imp;
1398         struct lustre_handle     conn;
1399         int                      rc;
1400
1401         ENTRY;
1402
1403         CDEBUG(D_CONFIG, "connect #%d\n", osp->opd_connects);
1404
1405         rc = class_connect(&conn, obd, cluuid);
1406         if (rc)
1407                 RETURN(rc);
1408
1409         *exp = class_conn2export(&conn);
1410         /* Why should there ever be more than 1 connect? */
1411         osp->opd_connects++;
1412         LASSERT(osp->opd_connects == 1);
1413
1414         osp->opd_exp = *exp;
1415
1416         imp = osp->opd_obd->u.cli.cl_import;
1417         imp->imp_dlm_handle = conn;
1418
1419         LASSERT(data != NULL);
1420         LASSERT(data->ocd_connect_flags & OBD_CONNECT_INDEX);
1421         ocd = &imp->imp_connect_data;
1422         *ocd = *data;
1423
1424         imp->imp_connect_flags_orig = ocd->ocd_connect_flags;
1425
1426         ocd->ocd_version = LUSTRE_VERSION_CODE;
1427         ocd->ocd_index = data->ocd_index;
1428         imp->imp_connect_flags_orig = ocd->ocd_connect_flags;
1429
1430         rc = ptlrpc_connect_import(imp);
1431         if (rc) {
1432                 CERROR("%s: can't connect obd: rc = %d\n", obd->obd_name, rc);
1433                 GOTO(out, rc);
1434         } else {
1435                 osp->opd_obd->u.cli.cl_seq->lcs_exp =
1436                                 class_export_get(osp->opd_exp);
1437         }
1438
1439         ptlrpc_pinger_add_import(imp);
1440 out:
1441         RETURN(rc);
1442 }
1443
1444 /**
1445  * Implementation of obd_ops::o_disconnect
1446  *
1447  * Disconnect the export for the OSP.  This is called by LOD to release the
1448  * OSP during cleanup (\see lod_del_device()). The OSP will be released after
1449  * the export is released.
1450  *
1451  * \param[in] exp       export to be disconnected.
1452  *
1453  * \retval 0            0 if disconnection succeed
1454  * \retval negative     negative errno if disconnection failed
1455  */
1456 static int osp_obd_disconnect(struct obd_export *exp)
1457 {
1458         struct obd_device *obd = exp->exp_obd;
1459         struct osp_device *osp = lu2osp_dev(obd->obd_lu_dev);
1460         int                rc;
1461         ENTRY;
1462
1463         /* Only disconnect the underlying layers on the final disconnect. */
1464         LASSERT(osp->opd_connects == 1);
1465         osp->opd_connects--;
1466
1467         rc = class_disconnect(exp);
1468         if (rc) {
1469                 CERROR("%s: class disconnect error: rc = %d\n",
1470                        obd->obd_name, rc);
1471                 RETURN(rc);
1472         }
1473
1474         /* destroy the device */
1475         class_manual_cleanup(obd);
1476
1477         RETURN(rc);
1478 }
1479
1480 /**
1481  * Implementation of obd_ops::o_statfs
1482  *
1483  * Send a RPC to the remote target to get statfs status. This is only used
1484  * in lprocfs helpers by obd_statfs.
1485  *
1486  * \param[in] env       execution environment
1487  * \param[in] exp       connection state from this OSP to the parent (LOD)
1488  *                      device
1489  * \param[out] osfs     hold the statfs result
1490  * \param[in] unused    Not used in this function for now
1491  * \param[in] flags     flags to indicate how OSP will issue the RPC
1492  *
1493  * \retval 0            0 if statfs succeeded.
1494  * \retval negative     negative errno if statfs failed.
1495  */
1496 static int osp_obd_statfs(const struct lu_env *env, struct obd_export *exp,
1497                           struct obd_statfs *osfs, __u64 unused, __u32 flags)
1498 {
1499         struct obd_statfs       *msfs;
1500         struct ptlrpc_request   *req;
1501         struct obd_import       *imp = NULL;
1502         int                      rc;
1503
1504         ENTRY;
1505
1506         /* Since the request might also come from lprocfs, so we need
1507          * sync this with client_disconnect_export Bug15684 */
1508         down_read(&exp->exp_obd->u.cli.cl_sem);
1509         if (exp->exp_obd->u.cli.cl_import)
1510                 imp = class_import_get(exp->exp_obd->u.cli.cl_import);
1511         up_read(&exp->exp_obd->u.cli.cl_sem);
1512         if (!imp)
1513                 RETURN(-ENODEV);
1514
1515         req = ptlrpc_request_alloc(imp, &RQF_OST_STATFS);
1516
1517         class_import_put(imp);
1518
1519         if (req == NULL)
1520                 RETURN(-ENOMEM);
1521
1522         rc = ptlrpc_request_pack(req, LUSTRE_OST_VERSION, OST_STATFS);
1523         if (rc) {
1524                 ptlrpc_request_free(req);
1525                 RETURN(rc);
1526         }
1527         ptlrpc_request_set_replen(req);
1528         req->rq_request_portal = OST_CREATE_PORTAL;
1529         ptlrpc_at_set_req_timeout(req);
1530
1531         if (flags & OBD_STATFS_NODELAY) {
1532                 /* procfs requests not want stat in wait for avoid deadlock */
1533                 req->rq_no_resend = 1;
1534                 req->rq_no_delay = 1;
1535         }
1536
1537         rc = ptlrpc_queue_wait(req);
1538         if (rc)
1539                 GOTO(out, rc);
1540
1541         msfs = req_capsule_server_get(&req->rq_pill, &RMF_OBD_STATFS);
1542         if (msfs == NULL)
1543                 GOTO(out, rc = -EPROTO);
1544
1545         *osfs = *msfs;
1546
1547         EXIT;
1548 out:
1549         ptlrpc_req_finished(req);
1550         return rc;
1551 }
1552
1553 /**
1554  * Implementation of obd_ops::o_import_event
1555  *
1556  * This function is called when some related import event happens. It will
1557  * mark the necessary flags according to the event and notify the necessary
1558  * threads (mainly precreate thread).
1559  *
1560  * \param[in] obd       OSP OBD device
1561  * \param[in] imp       import attached from OSP to remote (OST/MDT) service
1562  * \param[in] event     event related to remote service (IMP_EVENT_*)
1563  *
1564  * \retval 0            0 if the event handling succeeded.
1565  * \retval negative     negative errno if the event handling failed.
1566  */
1567 static int osp_import_event(struct obd_device *obd, struct obd_import *imp,
1568                             enum obd_import_event event)
1569 {
1570         struct osp_device *d = lu2osp_dev(obd->obd_lu_dev);
1571
1572         switch (event) {
1573         case IMP_EVENT_DISCON:
1574                 d->opd_got_disconnected = 1;
1575                 d->opd_imp_connected = 0;
1576                 if (d->opd_connect_mdt)
1577                         break;
1578
1579                 if (d->opd_pre != NULL) {
1580                         osp_pre_update_status(d, -ENODEV);
1581                         wake_up(&d->opd_pre_waitq);
1582                 }
1583
1584                 CDEBUG(D_HA, "got disconnected\n");
1585                 break;
1586         case IMP_EVENT_INACTIVE:
1587                 d->opd_imp_active = 0;
1588                 if (d->opd_connect_mdt)
1589                         break;
1590
1591                 if (d->opd_pre != NULL) {
1592                         osp_pre_update_status(d, -ENODEV);
1593                         wake_up(&d->opd_pre_waitq);
1594                 }
1595
1596                 CDEBUG(D_HA, "got inactive\n");
1597                 break;
1598         case IMP_EVENT_ACTIVE:
1599                 d->opd_imp_active = 1;
1600
1601                 if (d->opd_got_disconnected)
1602                         d->opd_new_connection = 1;
1603                 d->opd_imp_connected = 1;
1604                 d->opd_imp_seen_connected = 1;
1605                 if (d->opd_connect_mdt)
1606                         break;
1607
1608                 if (d->opd_pre != NULL)
1609                         wake_up(&d->opd_pre_waitq);
1610
1611                 __osp_sync_check_for_work(d);
1612                 CDEBUG(D_HA, "got connected\n");
1613                 break;
1614         case IMP_EVENT_INVALIDATE:
1615                 if (obd->obd_namespace == NULL)
1616                         break;
1617                 ldlm_namespace_cleanup(obd->obd_namespace, LDLM_FL_LOCAL_ONLY);
1618                 break;
1619         case IMP_EVENT_OCD:
1620         case IMP_EVENT_DEACTIVATE:
1621         case IMP_EVENT_ACTIVATE:
1622                 break;
1623         default:
1624                 CERROR("%s: unsupported import event: %#x\n",
1625                        obd->obd_name, event);
1626         }
1627         return 0;
1628 }
1629
1630 /**
1631  * Implementation of obd_ops: o_iocontrol
1632  *
1633  * This function is the ioctl handler for OSP. Note: lctl will access the OSP
1634  * directly by ioctl, instead of through the MDS stack.
1635  *
1636  * param[in] cmd        ioctl command.
1637  * param[in] exp        export of this OSP.
1638  * param[in] len        data length of \a karg.
1639  * param[in] karg       input argument which is packed as
1640  *                      obd_ioctl_data
1641  * param[out] uarg      pointer to userspace buffer (must access by
1642  *                      copy_to_user()).
1643  *
1644  * \retval 0            0 if the ioctl handling succeeded.
1645  * \retval negative     negative errno if the ioctl handling failed.
1646  */
1647 static int osp_iocontrol(unsigned int cmd, struct obd_export *exp, int len,
1648                          void *karg, void *uarg)
1649 {
1650         struct obd_device       *obd = exp->exp_obd;
1651         struct osp_device       *d;
1652         struct obd_ioctl_data   *data = karg;
1653         int                      rc = 0;
1654
1655         ENTRY;
1656
1657         LASSERT(obd->obd_lu_dev);
1658         d = lu2osp_dev(obd->obd_lu_dev);
1659         LASSERT(d->opd_dt_dev.dd_ops == &osp_dt_ops);
1660
1661         if (!try_module_get(THIS_MODULE)) {
1662                 CERROR("%s: cannot get module '%s'\n", obd->obd_name,
1663                        module_name(THIS_MODULE));
1664                 return -EINVAL;
1665         }
1666
1667         switch (cmd) {
1668         case OBD_IOC_CLIENT_RECOVER:
1669                 rc = ptlrpc_recover_import(obd->u.cli.cl_import,
1670                                            data->ioc_inlbuf1, 0);
1671                 if (rc > 0)
1672                         rc = 0;
1673                 break;
1674         case IOC_OSC_SET_ACTIVE:
1675                 rc = ptlrpc_set_import_active(obd->u.cli.cl_import,
1676                                               data->ioc_offset);
1677                 break;
1678         case OBD_IOC_PING_TARGET:
1679                 rc = ptlrpc_obd_ping(obd);
1680                 break;
1681         default:
1682                 CERROR("%s: unrecognized ioctl %#x by %s\n", obd->obd_name,
1683                        cmd, current_comm());
1684                 rc = -ENOTTY;
1685         }
1686         module_put(THIS_MODULE);
1687         return rc;
1688 }
1689
1690 /**
1691  * Implementation of obd_ops::o_get_info
1692  *
1693  * Retrieve information by key. Retrieval starts from the top layer
1694  * (MDT) of the MDS stack and traverses the stack by calling the
1695  * obd_get_info() method of the next sub-layer.
1696  *
1697  * \param[in] env       execution environment
1698  * \param[in] exp       export of this OSP
1699  * \param[in] keylen    length of \a key
1700  * \param[in] key       the key
1701  * \param[out] vallen   length of \a val
1702  * \param[out] val      holds the value returned by the key
1703  *
1704  * \retval 0            0 if getting information succeeded.
1705  * \retval negative     negative errno if getting information failed.
1706  */
1707 static int osp_obd_get_info(const struct lu_env *env, struct obd_export *exp,
1708                             __u32 keylen, void *key, __u32 *vallen, void *val)
1709 {
1710         int rc = -EINVAL;
1711
1712         if (KEY_IS(KEY_OSP_CONNECTED)) {
1713                 struct obd_device       *obd = exp->exp_obd;
1714                 struct osp_device       *osp;
1715
1716                 if (!obd->obd_set_up || obd->obd_stopping)
1717                         RETURN(-EAGAIN);
1718
1719                 osp = lu2osp_dev(obd->obd_lu_dev);
1720                 LASSERT(osp);
1721                 /*
1722                  * 1.8/2.0 behaviour is that OST being connected once at least
1723                  * is considered "healthy". and one "healthy" OST is enough to
1724                  * allow lustre clients to connect to MDS
1725                  */
1726                 RETURN(!osp->opd_imp_seen_connected);
1727         }
1728
1729         RETURN(rc);
1730 }
1731
1732 /**
1733  * Implementation of obd_ops: o_fid_alloc
1734  *
1735  * Allocate a FID. There are two cases in which OSP performs
1736  * FID allocation.
1737  *
1738  * 1. FID precreation for data objects, which is done in
1739  *    osp_precreate_fids() instead of this function.
1740  * 2. FID allocation for each sub-stripe of a striped directory.
1741  *    Similar to other FID clients, OSP requests the sequence
1742  *    from its corresponding remote MDT, which in turn requests
1743  *    sequences from the sequence controller (MDT0).
1744  *
1745  * \param[in] env       execution environment
1746  * \param[in] exp       export of the OSP
1747  * \param[out] fid      FID being allocated
1748  * \param[in] unused    necessary for the interface but unused.
1749  *
1750  * \retval 0            0 FID allocated successfully.
1751  * \retval 1            1 FID allocated successfully and new sequence
1752  *                      requested from seq meta server
1753  * \retval negative     negative errno if FID allocation failed.
1754  */
1755 static int osp_fid_alloc(const struct lu_env *env, struct obd_export *exp,
1756                          struct lu_fid *fid, struct md_op_data *unused)
1757 {
1758         struct client_obd       *cli = &exp->exp_obd->u.cli;
1759         struct osp_device       *osp = lu2osp_dev(exp->exp_obd->obd_lu_dev);
1760         struct lu_client_seq    *seq = cli->cl_seq;
1761         ENTRY;
1762
1763         LASSERT(osp->opd_obd->u.cli.cl_seq != NULL);
1764         /* Sigh, fid client is not ready yet */
1765         LASSERT(osp->opd_obd->u.cli.cl_seq->lcs_exp != NULL);
1766
1767         RETURN(seq_client_alloc_fid(env, seq, fid));
1768 }
1769
1770 /* context key constructor/destructor: mdt_key_init, mdt_key_fini */
1771 LU_KEY_INIT_FINI(osp, struct osp_thread_info);
1772 static void osp_key_exit(const struct lu_context *ctx,
1773                          struct lu_context_key *key, void *data)
1774 {
1775         struct osp_thread_info *info = data;
1776
1777         info->osi_attr.la_valid = 0;
1778 }
1779
1780 struct lu_context_key osp_thread_key = {
1781         .lct_tags = LCT_MD_THREAD,
1782         .lct_init = osp_key_init,
1783         .lct_fini = osp_key_fini,
1784         .lct_exit = osp_key_exit
1785 };
1786
1787 /* context key constructor/destructor: mdt_txn_key_init, mdt_txn_key_fini */
1788 LU_KEY_INIT_FINI(osp_txn, struct osp_txn_info);
1789
1790 struct lu_context_key osp_txn_key = {
1791         .lct_tags = LCT_OSP_THREAD | LCT_TX_HANDLE,
1792         .lct_init = osp_txn_key_init,
1793         .lct_fini = osp_txn_key_fini
1794 };
1795 LU_TYPE_INIT_FINI(osp, &osp_thread_key, &osp_txn_key);
1796
1797 static struct lu_device_type_operations osp_device_type_ops = {
1798         .ldto_init           = osp_type_init,
1799         .ldto_fini           = osp_type_fini,
1800
1801         .ldto_start          = osp_type_start,
1802         .ldto_stop           = osp_type_stop,
1803
1804         .ldto_device_alloc   = osp_device_alloc,
1805         .ldto_device_free    = osp_device_free,
1806
1807         .ldto_device_fini    = osp_device_fini
1808 };
1809
1810 static struct lu_device_type osp_device_type = {
1811         .ldt_tags     = LU_DEVICE_DT,
1812         .ldt_name     = LUSTRE_OSP_NAME,
1813         .ldt_ops      = &osp_device_type_ops,
1814         .ldt_ctx_tags = LCT_MD_THREAD | LCT_DT_THREAD,
1815 };
1816
1817 static struct obd_ops osp_obd_device_ops = {
1818         .o_owner        = THIS_MODULE,
1819         .o_add_conn     = client_import_add_conn,
1820         .o_del_conn     = client_import_del_conn,
1821         .o_reconnect    = osp_reconnect,
1822         .o_connect      = osp_obd_connect,
1823         .o_disconnect   = osp_obd_disconnect,
1824         .o_get_info     = osp_obd_get_info,
1825         .o_import_event = osp_import_event,
1826         .o_iocontrol    = osp_iocontrol,
1827         .o_statfs       = osp_obd_statfs,
1828         .o_fid_init     = client_fid_init,
1829         .o_fid_fini     = client_fid_fini,
1830         .o_fid_alloc    = osp_fid_alloc,
1831 };
1832
1833 struct llog_operations osp_mds_ost_orig_logops;
1834
1835 /**
1836  * Initialize OSP module.
1837  *
1838  * Register device types OSP and Light Weight Proxy (LWP) (\see lwp_dev.c)
1839  * in obd_types (\see class_obd.c).  Initialize procfs for the
1840  * the OSP device.  Note: OSP was called OSC before Lustre 2.4,
1841  * so for compatibility it still uses the name "osc" in procfs.
1842  * This is called at module load time.
1843  *
1844  * \retval 0            0 if initialization succeeds.
1845  * \retval negative     negative errno if initialization failed.
1846  */
1847 static int __init osp_mod_init(void)
1848 {
1849         struct obd_type *type;
1850         int rc;
1851
1852         rc = lu_kmem_init(osp_caches);
1853         if (rc)
1854                 return rc;
1855
1856
1857         rc = class_register_type(&osp_obd_device_ops, NULL, true, NULL,
1858                                  LUSTRE_OSP_NAME, &osp_device_type);
1859         if (rc != 0) {
1860                 lu_kmem_fini(osp_caches);
1861                 return rc;
1862         }
1863
1864         rc = class_register_type(&lwp_obd_device_ops, NULL, true, NULL,
1865                                  LUSTRE_LWP_NAME, &lwp_device_type);
1866         if (rc != 0) {
1867                 class_unregister_type(LUSTRE_OSP_NAME);
1868                 lu_kmem_fini(osp_caches);
1869                 return rc;
1870         }
1871
1872         /* Note: add_rec/delcare_add_rec will be only used by catalogs */
1873         osp_mds_ost_orig_logops = llog_osd_ops;
1874         osp_mds_ost_orig_logops.lop_add = llog_cat_add_rec;
1875         osp_mds_ost_orig_logops.lop_declare_add = llog_cat_declare_add_rec;
1876
1877         /* create "osc" entry in procfs for compatibility purposes */
1878         type = class_search_type(LUSTRE_OSC_NAME);
1879         if (type != NULL && type->typ_procroot != NULL)
1880                 return rc;
1881
1882         type = class_search_type(LUSTRE_OSP_NAME);
1883         type->typ_procsym = lprocfs_register("osc", proc_lustre_root,
1884                                              NULL, NULL);
1885         if (IS_ERR(type->typ_procsym)) {
1886                 CERROR("osp: can't create compat entry \"osc\": %d\n",
1887                        (int) PTR_ERR(type->typ_procsym));
1888                 type->typ_procsym = NULL;
1889         }
1890         return rc;
1891 }
1892
1893 /**
1894  * Finalize OSP module.
1895  *
1896  * This callback is called when kernel unloads OSP module from memory, and
1897  * it will deregister OSP and LWP device type from obd_types (\see class_obd.c).
1898  */
1899 static void __exit osp_mod_exit(void)
1900 {
1901         class_unregister_type(LUSTRE_LWP_NAME);
1902         class_unregister_type(LUSTRE_OSP_NAME);
1903         lu_kmem_fini(osp_caches);
1904 }
1905
1906 MODULE_AUTHOR("Intel, Inc. <http://www.intel.com/>");
1907 MODULE_DESCRIPTION("Lustre OST Proxy Device ("LUSTRE_OSP_NAME")");
1908 MODULE_VERSION(LUSTRE_VERSION_STRING);
1909 MODULE_LICENSE("GPL");
1910
1911 module_init(osp_mod_init);
1912 module_exit(osp_mod_exit);