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         m->ofd_dt_dev.dd_lu_dev.ld_ops = &ofd_lu_ops;
 344         m->ofd_dt_dev.dd_lu_dev.ld_obd = obd;
 345         /* set this lu_device to obd, because error handling need it */
 346         obd->obd_lu_dev = &m->ofd_dt_dev.dd_lu_dev;
 347
 348         /* No connection accepted until configurations will finish */
 349         obd->obd_no_conn = 1;
 350         obd->obd_replayable = 1;
 351         if (cfg->lcfg_bufcount > 4 && LUSTRE_CFG_BUFLEN(cfg, 4) > 0) {
 352                 char *str = lustre_cfg_string(cfg, 4);
 353
 354                 if (strchr(str, 'n')) {
 355                         CWARN("%s: recovery disabled\n", obd->obd_name);
 356                         obd->obd_replayable = 0;
 357                 }
 358         }
 359
 360         info = ofd_info_init(env, NULL);
 361         if (info == NULL)
 362                 RETURN(-EFAULT);
 363
 364         rc = lu_site_init(&m->ofd_site, &m->ofd_dt_dev.dd_lu_dev);
 365         if (rc)
 366                 GOTO(err_out, rc);
 367         m->ofd_site.ls_top_dev = &m->ofd_dt_dev.dd_lu_dev;
 368
 369         rc = ofd_stack_init(env, m, cfg);
 370         if (rc) {
 371                 CERROR("Can't init device stack, rc %d\n", rc);
 372                 GOTO(err_lu_site, rc);
 373         }
 374
 375         dt_conf_get(env, m->ofd_osd, &m->ofd_dt_conf);
 376
 377         rc = ofd_start(env, &m->ofd_dt_dev.dd_lu_dev);
 378         if (rc)
 379                 GOTO(err_fini_stack, rc);
 380
 381         rc = lut_init(env, &m->ofd_lut, obd, m->ofd_osd);
 382         if (rc)
 383                 GOTO(err_fini_stack, rc);
 384
 385         target_recovery_init(&m->ofd_lut, ost_handle);
 386
 387         rc = lu_site_init_finish(&m->ofd_site);
 388         if (rc)
 389                 GOTO(err_fini_lut, rc);
 390
 391         RETURN(0);
 392 err_fini_lut:
 393         lut_fini(env, &m->ofd_lut);
 394 err_fini_stack:
 395         ofd_stack_fini(env, m, &m->ofd_osd->dd_lu_dev);
 396 err_lu_site:
 397         lu_site_fini(&m->ofd_site);
 398 err_out:
 399         return rc;
 400 }
 401
 402 static void ofd_fini(const struct lu_env *env, struct ofd_device *m)
 403 {
 404         struct obd_device *obd = ofd_obd(m);
 405         struct lu_device  *d = &m->ofd_dt_dev.dd_lu_dev;
 406
 407         target_recovery_fini(obd);
 408         obd_exports_barrier(obd);
 409         obd_zombie_barrier();
 410
 411         lut_fini(env, &m->ofd_lut);
 412
 413         ofd_stack_fini(env, m, m->ofd_site.ls_top_dev);
 414         lu_site_fini(&m->ofd_site);
 415         LASSERT(cfs_atomic_read(&d->ld_ref) == 0);
 416         EXIT;
 417 }
 418
 419 static struct lu_device *ofd_device_fini(const struct lu_env *env,
 420                                          struct lu_device *d)
 421 {
 422         ENTRY;
 423         ofd_fini(env, ofd_dev(d));
 424         RETURN(NULL);
 425 }
 426
 427 static struct lu_device *ofd_device_free(const struct lu_env *env,
 428                                          struct lu_device *d)
 429 {
 430         struct ofd_device *m = ofd_dev(d);
 431
 432         dt_device_fini(&m->ofd_dt_dev);
 433         OBD_FREE_PTR(m);
 434         RETURN(NULL);
 435 }
 436
 437 static struct lu_device *ofd_device_alloc(const struct lu_env *env,
 438                                           struct lu_device_type *t,
 439                                           struct lustre_cfg *cfg)
 440 {
 441         struct ofd_device *m;
 442         struct lu_device  *l;
 443         int                rc;
 444
 445         OBD_ALLOC_PTR(m);
 446         if (m == NULL)
 447                 return ERR_PTR(-ENOMEM);
 448
 449         l = &m->ofd_dt_dev.dd_lu_dev;
 450         dt_device_init(&m->ofd_dt_dev, t);
 451         rc = ofd_init0(env, m, t, cfg);
 452         if (rc != 0) {
 453                 ofd_device_free(env, l);
 454                 l = ERR_PTR(rc);
 455         }
 456
 457         return l;
 458 }
 459
 460 /* thread context key constructor/destructor */
 461 LU_KEY_INIT_FINI(ofd, struct ofd_thread_info);
 462
 463 static void ofd_key_exit(const struct lu_context *ctx,
 464                          struct lu_context_key *key, void *data)
 465 {
 466         struct ofd_thread_info *info = data;
 467
 468         info->fti_env = NULL;
 469 }
 470
 471 struct lu_context_key ofd_thread_key = {
 472         .lct_tags = LCT_DT_THREAD,
 473         .lct_init = ofd_key_init,
 474         .lct_fini = ofd_key_fini,
 475         .lct_exit = ofd_key_exit
 476 };
 477
 478 /* type constructor/destructor: mdt_type_init, mdt_type_fini */
 479 LU_TYPE_INIT_FINI(ofd, &ofd_thread_key);
 480
 481 static struct lu_device_type_operations ofd_device_type_ops = {
 482         .ldto_init              = ofd_type_init,
 483         .ldto_fini              = ofd_type_fini,
 484
 485         .ldto_start             = ofd_type_start,
 486         .ldto_stop              = ofd_type_stop,
 487
 488         .ldto_device_alloc      = ofd_device_alloc,
 489         .ldto_device_free       = ofd_device_free,
 490         .ldto_device_fini       = ofd_device_fini
 491 };
 492
 493 static struct lu_device_type ofd_device_type = {
 494         .ldt_tags       = LU_DEVICE_DT,
 495         .ldt_name       = LUSTRE_OST_NAME,
 496         .ldt_ops        = &ofd_device_type_ops,
 497         .ldt_ctx_tags   = LCT_DT_THREAD
 498 };
 499
 500 int __init ofd_init(void)
 501 {
 502         struct lprocfs_static_vars      lvars;
 503         int                             rc;
 504
 505         rc = lu_kmem_init(ofd_caches);
 506         if (rc)
 507                 return rc;
 508
 509         lprocfs_ofd_init_vars(&lvars);
 510
 511         rc = class_register_type(&ofd_obd_ops, NULL, lvars.module_vars,
 512                                  LUSTRE_OST_NAME, &ofd_device_type);
 513         return rc;
 514 }
 515
 516 void __exit ofd_exit(void)
 517 {
 518         class_unregister_type(LUSTRE_OST_NAME);
 519         lu_kmem_fini(ofd_caches);
 520 }
 521
 522 MODULE_AUTHOR("Whamcloud, Inc. <http://www.whamcloud.com/>");
 523 MODULE_DESCRIPTION("Lustre Object Filtering Device");
 524 MODULE_LICENSE("GPL");
 525
 526 module_init(ofd_init);
 527 module_exit(ofd_exit);