Whamcloud - gitweb
LU-1406 ofd: OFD device methods
[fs/lustre-release.git] / lustre / ofd / ofd_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) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2012, Whamcloud, Inc.
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/ofd/ofd.c
37  *
38  * Author: Alex Zhuravlev <bzzz@whamcloud.com>
39  * Author: Mike Pershin <tappro@whamcloud.com>
40  * Author: Johann Lombardi <johann@whamcloud.com>
41  */
42
43 #define DEBUG_SUBSYSTEM S_FILTER
44
45 #include <obd_class.h>
46 #include <lustre_param.h>
47
48 #include "ofd_internal.h"
49
50 /* Slab for OFD object allocation */
51 static cfs_mem_cache_t *ofd_object_kmem;
52
53 static struct lu_kmem_descr ofd_caches[] = {
54         {
55                 .ckd_cache = &ofd_object_kmem,
56                 .ckd_name  = "ofd_obj",
57                 .ckd_size  = sizeof(struct ofd_object)
58         },
59         {
60                 .ckd_cache = NULL
61         }
62 };
63
64 static int ofd_stack_init(const struct lu_env *env,
65                           struct ofd_device *m, struct lustre_cfg *cfg)
66 {
67         struct lu_device        *ofd_lu = &m->ofd_dt_dev.dd_lu_dev;
68         const char              *dev = lustre_cfg_string(cfg, 0);
69         struct obd_type         *type;
70         struct lu_device_type   *ldt;
71         struct lu_device        *d;
72         struct ofd_thread_info  *info = ofd_info(env);
73         int                      rc;
74
75         ENTRY;
76
77         /* XXX: we should be able to use different OSDs here */
78         type = class_get_type(LUSTRE_OSD_NAME);
79         if (!type) {
80                 CERROR("Unknown type: '%s'\n", LUSTRE_OSD_NAME);
81                 RETURN(-ENODEV);
82         }
83
84         rc = lu_env_refill((struct lu_env *)env);
85         if (rc != 0) {
86                 CERROR("Failure to refill session: '%d'\n", rc);
87                 GOTO(out_type, rc);
88         }
89
90         ldt = type->typ_lu;
91         if (ldt == NULL) {
92                 CERROR("type: '%s'\n", LUSTRE_OSD_NAME);
93                 GOTO(out_type, rc = -EINVAL);
94         }
95
96         ldt->ldt_obd_type = type;
97         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, cfg);
98         if (IS_ERR(d)) {
99                 CERROR("Cannot allocate device: '%s'\n", LUSTRE_OSD_NAME);
100                 GOTO(out_type, rc = -ENODEV);
101         }
102
103         LASSERT(ofd_lu->ld_site);
104         d->ld_site = ofd_lu->ld_site;
105
106         snprintf(info->fti_u.name, sizeof(info->fti_u.name),
107                  "%s-osd", lustre_cfg_string(cfg, 0));
108
109         type->typ_refcnt++;
110         rc = ldt->ldt_ops->ldto_device_init(env, d, dev, NULL);
111         if (rc) {
112                 CERROR("can't init device '%s', rc %d\n", LUSTRE_OSD_NAME, rc);
113                 GOTO(out_free, rc);
114         }
115         lu_device_get(d);
116         lu_ref_add(&d->ld_reference, "lu-stack", &lu_site_init);
117
118         m->ofd_osd = lu2dt_dev(d);
119
120         /* process setup config */
121         rc = d->ld_ops->ldo_process_config(env, d, cfg);
122         if (rc)
123                 GOTO(out_fini, rc);
124
125         RETURN(rc);
126
127 out_fini:
128         ldt->ldt_ops->ldto_device_fini(env, d);
129 out_free:
130         type->typ_refcnt--;
131         ldt->ldt_ops->ldto_device_free(env, d);
132 out_type:
133         class_put_type(type);
134         RETURN(rc);
135 }
136
137 static void ofd_stack_fini(const struct lu_env *env, struct ofd_device *m,
138                            struct lu_device *top)
139 {
140         struct obd_device       *obd = ofd_obd(m);
141         struct lustre_cfg_bufs   bufs;
142         struct lustre_cfg       *lcfg;
143         char                     flags[3] = "";
144
145         ENTRY;
146
147         lu_site_purge(env, top->ld_site, ~0);
148
149         /* process cleanup, pass mdt obd name to get obd umount flags */
150         lustre_cfg_bufs_reset(&bufs, obd->obd_name);
151         if (obd->obd_force)
152                 strcat(flags, "F");
153         if (obd->obd_fail)
154                 strcat(flags, "A");
155         lustre_cfg_bufs_set_string(&bufs, 1, flags);
156         lcfg = lustre_cfg_new(LCFG_CLEANUP, &bufs);
157         if (!lcfg) {
158                 CERROR("Cannot alloc lcfg!\n");
159                 RETURN_EXIT;
160         }
161
162         LASSERT(top);
163         top->ld_ops->ldo_process_config(env, top, lcfg);
164         lustre_cfg_free(lcfg);
165
166         lu_stack_fini(env, &m->ofd_osd->dd_lu_dev);
167         m->ofd_osd = NULL;
168
169         EXIT;
170 }
171
172 /* used by MGS to process specific configurations */
173 static int ofd_process_config(const struct lu_env *env, struct lu_device *d,
174                               struct lustre_cfg *cfg)
175 {
176         struct ofd_device       *m = ofd_dev(d);
177         struct dt_device        *dt_next = m->ofd_osd;
178         struct lu_device        *next = &dt_next->dd_lu_dev;
179         int                      rc;
180
181         ENTRY;
182
183         switch (cfg->lcfg_command) {
184         case LCFG_PARAM: {
185                 struct lprocfs_static_vars lvars;
186
187                 lprocfs_ofd_init_vars(&lvars);
188                 rc = class_process_proc_param(PARAM_OST, lvars.obd_vars, cfg,
189                                               d->ld_obd);
190                 if (rc > 0 || rc == -ENOSYS)
191                         /* we don't understand; pass it on */
192                         rc = next->ld_ops->ldo_process_config(env, next, cfg);
193                 break;
194         }
195         case LCFG_SPTLRPC_CONF: {
196                 rc = -ENOTSUPP;
197                 break;
198         }
199         default:
200                 /* others are passed further */
201                 rc = next->ld_ops->ldo_process_config(env, next, cfg);
202                 break;
203         }
204         RETURN(rc);
205 }
206
207 static int ofd_object_init(const struct lu_env *env, struct lu_object *o,
208                            const struct lu_object_conf *conf)
209 {
210         struct ofd_device       *d = ofd_dev(o->lo_dev);
211         struct lu_device        *under;
212         struct lu_object        *below;
213         int                      rc = 0;
214
215         ENTRY;
216
217         CDEBUG(D_INFO, "object init, fid = "DFID"\n",
218                PFID(lu_object_fid(o)));
219
220         under = &d->ofd_osd->dd_lu_dev;
221         below = under->ld_ops->ldo_object_alloc(env, o->lo_header, under);
222         if (below != NULL)
223                 lu_object_add(o, below);
224         else
225                 rc = -ENOMEM;
226
227         RETURN(rc);
228 }
229
230 static void ofd_object_free(const struct lu_env *env, struct lu_object *o)
231 {
232         struct ofd_object       *of = ofd_obj(o);
233         struct lu_object_header *h;
234
235         ENTRY;
236
237         h = o->lo_header;
238         CDEBUG(D_INFO, "object free, fid = "DFID"\n",
239                PFID(lu_object_fid(o)));
240
241         lu_object_fini(o);
242         lu_object_header_fini(h);
243         OBD_SLAB_FREE_PTR(of, ofd_object_kmem);
244         EXIT;
245 }
246
247 static int ofd_object_print(const struct lu_env *env, void *cookie,
248                             lu_printer_t p, const struct lu_object *o)
249 {
250         return (*p)(env, cookie, LUSTRE_OST_NAME"-object@%p", o);
251 }
252
253 struct lu_object_operations ofd_obj_ops = {
254         .loo_object_init        = ofd_object_init,
255         .loo_object_free        = ofd_object_free,
256         .loo_object_print       = ofd_object_print
257 };
258
259 static struct lu_object *ofd_object_alloc(const struct lu_env *env,
260                                           const struct lu_object_header *hdr,
261                                           struct lu_device *d)
262 {
263         struct ofd_object *of;
264
265         ENTRY;
266
267         OBD_SLAB_ALLOC_PTR_GFP(of, ofd_object_kmem, CFS_ALLOC_IO);
268         if (of != NULL) {
269                 struct lu_object        *o;
270                 struct lu_object_header *h;
271
272                 o = &of->ofo_obj.do_lu;
273                 h = &of->ofo_header;
274                 lu_object_header_init(h);
275                 lu_object_init(o, h, d);
276                 lu_object_add_top(h, o);
277                 o->lo_ops = &ofd_obj_ops;
278                 RETURN(o);
279         } else {
280                 RETURN(NULL);
281         }
282 }
283
284 extern int ost_handle(struct ptlrpc_request *req);
285
286 static int ofd_start(const struct lu_env *env, struct lu_device *dev)
287 {
288         struct ofd_device       *ofd = ofd_dev(dev);
289         struct lu_device        *next = &ofd->ofd_osd->dd_lu_dev;
290         int                      rc;
291
292         ENTRY;
293
294         /* initialize lower device */
295         rc = next->ld_ops->ldo_prepare(env, dev, next);
296
297         RETURN(rc);
298 }
299
300 static int ofd_recovery_complete(const struct lu_env *env,
301                                  struct lu_device *dev)
302 {
303         struct ofd_device       *ofd = ofd_dev(dev);
304         struct lu_device        *next = &ofd->ofd_osd->dd_lu_dev;
305         int                      rc = 0;
306
307         ENTRY;
308
309         rc = next->ld_ops->ldo_recovery_complete(env, next);
310         RETURN(rc);
311 }
312
313 static struct lu_device_operations ofd_lu_ops = {
314         .ldo_object_alloc       = ofd_object_alloc,
315         .ldo_process_config     = ofd_process_config,
316         .ldo_recovery_complete  = ofd_recovery_complete,
317 };
318
319 extern int ost_handle(struct ptlrpc_request *req);
320
321 static int ofd_init0(const struct lu_env *env, struct ofd_device *m,
322                      struct lu_device_type *ldt, struct lustre_cfg *cfg)
323 {
324         const char              *dev = lustre_cfg_string(cfg, 0);
325         struct ofd_thread_info  *info = NULL;
326         struct obd_device       *obd;
327         int                      rc;
328
329         ENTRY;
330
331         obd = class_name2obd(dev);
332         if (obd == NULL) {
333                 CERROR("Cannot find obd with name %s\n", dev);
334                 RETURN(-ENODEV);
335         }
336
337         rc = lu_env_refill((struct lu_env *)env);
338         if (rc != 0)
339                 RETURN(rc);
340
341         obd->u.obt.obt_magic = OBT_MAGIC;
342
343         cfs_rwlock_init(&obd->u.filter.fo_sptlrpc_lock);
344         sptlrpc_rule_set_init(&obd->u.filter.fo_sptlrpc_rset);
345
346         obd->u.filter.fo_fl_oss_capa = 0;
347         CFS_INIT_LIST_HEAD(&obd->u.filter.fo_capa_keys);
348         obd->u.filter.fo_capa_hash = init_capa_hash();
349         if (obd->u.filter.fo_capa_hash == NULL)
350                 RETURN(-ENOMEM);
351
352         m->ofd_dt_dev.dd_lu_dev.ld_ops = &ofd_lu_ops;
353         m->ofd_dt_dev.dd_lu_dev.ld_obd = obd;
354         /* set this lu_device to obd, because error handling need it */
355         obd->obd_lu_dev = &m->ofd_dt_dev.dd_lu_dev;
356
357         /* No connection accepted until configurations will finish */
358         obd->obd_no_conn = 1;
359         obd->obd_replayable = 1;
360         if (cfg->lcfg_bufcount > 4 && LUSTRE_CFG_BUFLEN(cfg, 4) > 0) {
361                 char *str = lustre_cfg_string(cfg, 4);
362
363                 if (strchr(str, 'n')) {
364                         CWARN("%s: recovery disabled\n", obd->obd_name);
365                         obd->obd_replayable = 0;
366                 }
367         }
368
369         info = ofd_info_init(env, NULL);
370         if (info == NULL)
371                 RETURN(-EFAULT);
372
373         rc = lu_site_init(&m->ofd_site, &m->ofd_dt_dev.dd_lu_dev);
374         if (rc)
375                 GOTO(err_out, rc);
376         m->ofd_site.ls_top_dev = &m->ofd_dt_dev.dd_lu_dev;
377
378         rc = ofd_stack_init(env, m, cfg);
379         if (rc) {
380                 CERROR("Can't init device stack, rc %d\n", rc);
381                 GOTO(err_lu_site, rc);
382         }
383
384         m->ofd_namespace = ldlm_namespace_new(obd, info->fti_u.name,
385                                               LDLM_NAMESPACE_SERVER,
386                                               LDLM_NAMESPACE_GREEDY,
387                                               LDLM_NS_TYPE_OST);
388         if (m->ofd_namespace == NULL)
389                 GOTO(err_fini_stack, rc = -ENOMEM);
390         /* set obd_namespace for compatibility with old code */
391         obd->obd_namespace = m->ofd_namespace;
392
393         dt_conf_get(env, m->ofd_osd, &m->ofd_dt_conf);
394
395         rc = ofd_start(env, &m->ofd_dt_dev.dd_lu_dev);
396         if (rc)
397                 GOTO(err_fini_stack, rc);
398
399         rc = lut_init(env, &m->ofd_lut, obd, m->ofd_osd);
400         if (rc)
401                 GOTO(err_free_ns, rc);
402
403         rc = ofd_fs_setup(env, m, obd);
404         if (rc)
405                 GOTO(err_fini_lut, rc);
406
407         target_recovery_init(&m->ofd_lut, ost_handle);
408
409         rc = lu_site_init_finish(&m->ofd_site);
410         if (rc)
411                 GOTO(err_fs_cleanup, rc);
412
413         RETURN(0);
414 err_fs_cleanup:
415         target_recovery_fini(obd);
416         ofd_fs_cleanup(env, m);
417 err_fini_lut:
418         lut_fini(env, &m->ofd_lut);
419 err_free_ns:
420         ldlm_namespace_free(m->ofd_namespace, 0, obd->obd_force);
421         obd->obd_namespace = m->ofd_namespace = NULL;
422 err_fini_stack:
423         ofd_stack_fini(env, m, &m->ofd_osd->dd_lu_dev);
424 err_lu_site:
425         lu_site_fini(&m->ofd_site);
426 err_out:
427         return rc;
428 }
429
430 static void ofd_fini(const struct lu_env *env, struct ofd_device *m)
431 {
432         struct obd_device *obd = ofd_obd(m);
433         struct lu_device  *d = &m->ofd_dt_dev.dd_lu_dev;
434
435         target_recovery_fini(obd);
436         obd_exports_barrier(obd);
437         obd_zombie_barrier();
438
439         lut_fini(env, &m->ofd_lut);
440         ofd_fs_cleanup(env, m);
441
442         ofd_free_capa_keys(m);
443         cleanup_capa_hash(obd->u.filter.fo_capa_hash);
444
445         if (m->ofd_namespace != NULL) {
446                 ldlm_namespace_free(m->ofd_namespace, NULL,
447                                     d->ld_obd->obd_force);
448                 d->ld_obd->obd_namespace = m->ofd_namespace = NULL;
449         }
450
451         ofd_stack_fini(env, m, m->ofd_site.ls_top_dev);
452         lu_site_fini(&m->ofd_site);
453         LASSERT(cfs_atomic_read(&d->ld_ref) == 0);
454         EXIT;
455 }
456
457 static struct lu_device *ofd_device_fini(const struct lu_env *env,
458                                          struct lu_device *d)
459 {
460         ENTRY;
461         ofd_fini(env, ofd_dev(d));
462         RETURN(NULL);
463 }
464
465 static struct lu_device *ofd_device_free(const struct lu_env *env,
466                                          struct lu_device *d)
467 {
468         struct ofd_device *m = ofd_dev(d);
469
470         dt_device_fini(&m->ofd_dt_dev);
471         OBD_FREE_PTR(m);
472         RETURN(NULL);
473 }
474
475 static struct lu_device *ofd_device_alloc(const struct lu_env *env,
476                                           struct lu_device_type *t,
477                                           struct lustre_cfg *cfg)
478 {
479         struct ofd_device *m;
480         struct lu_device  *l;
481         int                rc;
482
483         OBD_ALLOC_PTR(m);
484         if (m == NULL)
485                 return ERR_PTR(-ENOMEM);
486
487         l = &m->ofd_dt_dev.dd_lu_dev;
488         dt_device_init(&m->ofd_dt_dev, t);
489         rc = ofd_init0(env, m, t, cfg);
490         if (rc != 0) {
491                 ofd_device_free(env, l);
492                 l = ERR_PTR(rc);
493         }
494
495         return l;
496 }
497
498 /* thread context key constructor/destructor */
499 LU_KEY_INIT_FINI(ofd, struct ofd_thread_info);
500
501 static void ofd_key_exit(const struct lu_context *ctx,
502                          struct lu_context_key *key, void *data)
503 {
504         struct ofd_thread_info *info = data;
505
506         info->fti_env = NULL;
507         info->fti_exp = NULL;
508 }
509
510 struct lu_context_key ofd_thread_key = {
511         .lct_tags = LCT_DT_THREAD,
512         .lct_init = ofd_key_init,
513         .lct_fini = ofd_key_fini,
514         .lct_exit = ofd_key_exit
515 };
516
517 /* type constructor/destructor: mdt_type_init, mdt_type_fini */
518 LU_TYPE_INIT_FINI(ofd, &ofd_thread_key);
519
520 static struct lu_device_type_operations ofd_device_type_ops = {
521         .ldto_init              = ofd_type_init,
522         .ldto_fini              = ofd_type_fini,
523
524         .ldto_start             = ofd_type_start,
525         .ldto_stop              = ofd_type_stop,
526
527         .ldto_device_alloc      = ofd_device_alloc,
528         .ldto_device_free       = ofd_device_free,
529         .ldto_device_fini       = ofd_device_fini
530 };
531
532 static struct lu_device_type ofd_device_type = {
533         .ldt_tags       = LU_DEVICE_DT,
534         .ldt_name       = LUSTRE_OST_NAME,
535         .ldt_ops        = &ofd_device_type_ops,
536         .ldt_ctx_tags   = LCT_DT_THREAD
537 };
538
539 int __init ofd_init(void)
540 {
541         struct lprocfs_static_vars      lvars;
542         int                             rc;
543
544         rc = lu_kmem_init(ofd_caches);
545         if (rc)
546                 return rc;
547
548         lprocfs_ofd_init_vars(&lvars);
549
550         rc = class_register_type(&ofd_obd_ops, NULL, lvars.module_vars,
551                                  LUSTRE_OST_NAME, &ofd_device_type);
552         return rc;
553 }
554
555 void __exit ofd_exit(void)
556 {
557         class_unregister_type(LUSTRE_OST_NAME);
558         lu_kmem_fini(ofd_caches);
559 }
560
561 MODULE_AUTHOR("Whamcloud, Inc. <http://www.whamcloud.com/>");
562 MODULE_DESCRIPTION("Lustre Object Filtering Device");
563 MODULE_LICENSE("GPL");
564
565 module_init(ofd_init);
566 module_exit(ofd_exit);