lustre/obdclass/md_local_object.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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  */
  30 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  *
  34  * lustre/obdclass/md_local_object.c
  35  *
  36  * Lustre Local Object create APIs
  37  * 'create on first mount' facility. Files registed under llo module will
  38  * be created on first mount.
  39  *
  40  * Author: Pravin Shelar  <pravin.shelar@sun.com>
  41  */
  42
  43 #define DEBUG_SUBSYSTEM S_CLASS
  44
  45 #include <obd_support.h>
  46 #include <lustre_disk.h>
  47 #include <lustre_fid.h>
  48 #include <lu_object.h>
  49 #include <libcfs/list.h>
  50 #include <md_object.h>
  51
  52
  53 /** List head to hold list of objects to be created. */
  54 static cfs_list_t llo_lobj_list;
  55
  56 /** Lock to protect list manipulations */
  57 static cfs_mutex_t     llo_lock;
  58
  59 /**
  60  * Structure used to maintain state of path parsing.
  61  * \see llo_find_entry, llo_store_resolve
  62  */
  63 struct llo_find_hint {
  64         struct lu_fid        *lfh_cfid;
  65         struct md_device     *lfh_md;
  66         struct md_object     *lfh_pobj;
  67 };
  68
  69 /**
  70  * Thread Local storage for this module.
  71  */
  72 struct llo_thread_info {
  73         /** buffer to resolve path */
  74         char                    lti_buf[DT_MAX_PATH];
  75         /** used for path resolve */
  76         struct lu_fid           lti_fid;
  77         /** used to pass child object fid */
  78         struct lu_fid           lti_cfid;
  79         struct llo_find_hint    lti_lfh;
  80         struct md_op_spec       lti_spc;
  81         struct md_attr          lti_ma;
  82         struct lu_name          lti_lname;
  83 };
  84
  85 LU_KEY_INIT(llod_global, struct llo_thread_info);
  86 LU_KEY_FINI(llod_global, struct llo_thread_info);
  87
  88 static struct lu_context_key llod_key = {
  89         .lct_tags = LCT_MD_THREAD,
  90         .lct_init = llod_global_key_init,
  91         .lct_fini = llod_global_key_fini
  92 };
  93
  94 static inline struct llo_thread_info * llo_env_info(const struct lu_env *env)
  95 {
  96         return lu_context_key_get(&env->le_ctx,  &llod_key);
  97 }
  98
  99 /**
 100  * Search md object for given fid.
 101  */
 102 static struct md_object *llo_locate(const struct lu_env *env,
 103                                     struct md_device *md,
 104                                     const struct lu_fid *fid)
 105 {
 106         struct lu_object *obj;
 107         struct md_object *mdo;
 108
 109         obj = lu_object_find(env, &md->md_lu_dev, fid, NULL);
 110         if (!IS_ERR(obj)) {
 111                 obj = lu_object_locate(obj->lo_header, md->md_lu_dev.ld_type);
 112                 LASSERT(obj != NULL);
 113                 mdo = (struct md_object *) obj;
 114         } else
 115                 mdo = (struct md_object *)obj;
 116         return mdo;
 117 }
 118
 119 /**
 120  * Lookup FID for object named \a name in directory \a pobj.
 121  */
 122 static int llo_lookup(const struct lu_env  *env,
 123                       struct md_object *pobj,
 124                       const char *name,
 125                       struct lu_fid *fid)
 126 {
 127         struct llo_thread_info *info = llo_env_info(env);
 128         struct lu_name          *lname = &info->lti_lname;
 129         struct md_op_spec       *spec = &info->lti_spc;
 130
 131         spec->sp_feat = NULL;
 132         spec->sp_cr_flags = 0;
 133         spec->sp_cr_lookup = 0;
 134         spec->sp_cr_mode = 0;
 135         spec->sp_ck_split = 0;
 136
 137         lname->ln_name = name;
 138         lname->ln_namelen = strlen(name);
 139
 140         return mdo_lookup(env, pobj, lname, fid, spec);
 141 }
 142
 143 /**
 144  * Function to look up path component, this is passed to parsing
 145  * function. \see llo_store_resolve
 146  *
 147  * \retval      rc returns error code for lookup or locate operation
 148  *
 149  * pointer to object is returned in data (lfh->lfh_pobj)
 150  */
 151 static int llo_find_entry(const struct lu_env  *env,
 152                           const char *name, void *data)
 153 {
 154         struct llo_find_hint    *lfh = data;
 155         struct md_device        *md = lfh->lfh_md;
 156         struct lu_fid           *fid = lfh->lfh_cfid;
 157         struct md_object        *obj = lfh->lfh_pobj;
 158         int                     result;
 159
 160         /* lookup fid for object */
 161         result = llo_lookup(env, obj, name, fid);
 162         lu_object_put(env, &obj->mo_lu);
 163
 164         if (result == 0) {
 165                 /* get md object for fid that we got in lookup */
 166                 obj = llo_locate(env, md, fid);
 167                 if (IS_ERR(obj))
 168                         result = PTR_ERR(obj);
 169         }
 170
 171         lfh->lfh_pobj = obj;
 172         return result;
 173 }
 174
 175 static struct md_object *llo_reg_open(const struct lu_env *env,
 176                                       struct md_device *md,
 177                                       struct md_object *p,
 178                                       const char *name,
 179                                       struct lu_fid *fid)
 180 {
 181         struct md_object *o;
 182         int result;
 183
 184         result = llo_lookup(env, p, name, fid);
 185         if (result == 0)
 186                 o = llo_locate(env, md, fid);
 187         else
 188                 o = ERR_PTR(result);
 189
 190         return o;
 191 }
 192
 193 /**
 194  * Resolve given \a path, on success function returns
 195  * md object for last directory and \a fid points to
 196  * its fid.
 197  */
 198 struct md_object *llo_store_resolve(const struct lu_env *env,
 199                                     struct md_device *md,
 200                                     struct dt_device *dt,
 201                                     const char *path,
 202                                     struct lu_fid *fid)
 203 {
 204         struct llo_thread_info *info = llo_env_info(env);
 205         struct llo_find_hint *lfh = &info->lti_lfh;
 206         char *local = info->lti_buf;
 207         struct md_object        *obj;
 208         int result;
 209
 210         strncpy(local, path, DT_MAX_PATH);
 211         local[DT_MAX_PATH - 1] = '\0';
 212
 213         lfh->lfh_md = md;
 214         lfh->lfh_cfid = fid;
 215         /* start path resolution from backend fs root. */
 216         result = dt->dd_ops->dt_root_get(env, dt, fid);
 217         if (result == 0) {
 218                 /* get md object for root */
 219                 obj = llo_locate(env, md, fid);
 220                 if (!IS_ERR(obj)) {
 221                         /* start path parser from root md */
 222                         lfh->lfh_pobj = obj;
 223                         result = dt_path_parser(env, local, llo_find_entry, lfh);
 224                         if (result != 0)
 225                                 obj = ERR_PTR(result);
 226                         else
 227                                 obj = lfh->lfh_pobj;
 228                 }
 229         } else {
 230                 obj = ERR_PTR(result);
 231         }
 232         return obj;
 233 }
 234 EXPORT_SYMBOL(llo_store_resolve);
 235
 236 /**
 237  * Returns md object for \a objname in given \a dirname.
 238  */
 239 struct md_object *llo_store_open(const struct lu_env *env,
 240                                  struct md_device *md,
 241                                  struct dt_device *dt,
 242                                  const char *dirname,
 243                                  const char *objname,
 244                                  struct lu_fid *fid)
 245 {
 246         struct md_object *obj;
 247         struct md_object *dir;
 248
 249         /* search md object for parent dir */
 250         dir = llo_store_resolve(env, md, dt, dirname, fid);
 251         if (!IS_ERR(dir)) {
 252                 obj = llo_reg_open(env, md, dir, objname, fid);
 253                 lu_object_put(env, &dir->mo_lu);
 254         } else
 255                 obj = dir;
 256
 257         return obj;
 258 }
 259 EXPORT_SYMBOL(llo_store_open);
 260
 261 static struct md_object *llo_create_obj(const struct lu_env *env,
 262                                         struct md_device *md,
 263                                         struct md_object *dir,
 264                                         const char *objname,
 265                                         const struct lu_fid *fid,
 266                                         const struct dt_index_features *feat)
 267 {
 268         struct llo_thread_info *info = llo_env_info(env);
 269         struct md_object        *mdo;
 270         struct md_attr          *ma = &info->lti_ma;
 271         struct md_op_spec       *spec = &info->lti_spc;
 272         struct lu_name          *lname = &info->lti_lname;
 273         struct lu_attr          *la = &ma->ma_attr;
 274         int rc;
 275
 276         mdo = llo_locate(env, md, fid);
 277         if (IS_ERR(mdo))
 278                 return mdo;
 279
 280         lname->ln_name = objname;
 281         lname->ln_namelen = strlen(objname);
 282
 283         spec->sp_feat = feat;
 284         spec->sp_cr_flags = 0;
 285         spec->sp_cr_lookup = 1;
 286         spec->sp_cr_mode = 0;
 287         spec->sp_ck_split = 0;
 288
 289         if (feat == &dt_directory_features)
 290                 la->la_mode = S_IFDIR | S_IXUGO;
 291         else
 292                 la->la_mode = S_IFREG;
 293
 294         la->la_mode |= S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH;
 295         la->la_uid = la->la_gid = 0;
 296         la->la_valid = LA_MODE | LA_UID | LA_GID;
 297
 298         ma->ma_valid = 0;
 299         ma->ma_need = 0;
 300
 301         rc = mdo_create(env, dir, lname, mdo, spec, ma);
 302
 303         if (rc) {
 304                 lu_object_put(env, &mdo->mo_lu);
 305                 mdo = ERR_PTR(rc);
 306         }
 307
 308         return mdo;
 309 }
 310
 311 /**
 312  * Create md object, object could be diretcory or
 313  * special index defined by \a feat in \a directory.
 314  *
 315  *       \param  md       device
 316  *       \param  dirname  parent directory
 317  *       \param  objname  file name
 318  *       \param  fid      object fid
 319  *       \param  feat     index features required for directory create
 320  */
 321
 322 struct md_object *llo_store_create_index(const struct lu_env *env,
 323                                          struct md_device *md,
 324                                          struct dt_device *dt,
 325                                          const char *dirname,
 326                                          const char *objname,
 327                                          const struct lu_fid *fid,
 328                                          const struct dt_index_features *feat)
 329 {
 330         struct llo_thread_info *info = llo_env_info(env);
 331         struct md_object *obj;
 332         struct md_object *dir;
 333         struct lu_fid *ignore = &info->lti_fid;
 334
 335         dir = llo_store_resolve(env, md, dt, dirname, ignore);
 336         if (!IS_ERR(dir)) {
 337                 obj = llo_create_obj(env, md, dir, objname, fid, feat);
 338                 lu_object_put(env, &dir->mo_lu);
 339         } else {
 340                 obj = dir;
 341         }
 342         return obj;
 343 }
 344
 345 EXPORT_SYMBOL(llo_store_create_index);
 346
 347 /**
 348  * Create md object for regular file in \a directory.
 349  *
 350  *       \param  md       device
 351  *       \param  dirname  parent directory
 352  *       \param  objname  file name
 353  *       \param  fid      object fid.
 354  */
 355
 356 struct md_object *llo_store_create(const struct lu_env *env,
 357                                    struct md_device *md,
 358                                    struct dt_device *dt,
 359                                    const char *dirname,
 360                                    const char *objname,
 361                                    const struct lu_fid *fid)
 362 {
 363         return llo_store_create_index(env, md, dt, dirname,
 364                                       objname, fid, NULL);
 365 }
 366
 367 EXPORT_SYMBOL(llo_store_create);
 368
 369 /**
 370  * Register object for 'create on first mount' facility.
 371  * objects are created in order of registration.
 372  */
 373
 374 void llo_local_obj_register(struct lu_local_obj_desc *llod)
 375 {
 376         cfs_mutex_lock(&llo_lock);
 377         cfs_list_add_tail(&llod->llod_linkage, &llo_lobj_list);
 378         cfs_mutex_unlock(&llo_lock);
 379 }
 380
 381 EXPORT_SYMBOL(llo_local_obj_register);
 382
 383 void llo_local_obj_unregister(struct lu_local_obj_desc *llod)
 384 {
 385         cfs_mutex_lock(&llo_lock);
 386         cfs_list_del(&llod->llod_linkage);
 387         cfs_mutex_unlock(&llo_lock);
 388 }
 389
 390 EXPORT_SYMBOL(llo_local_obj_unregister);
 391
 392 /**
 393  * Created registed objects.
 394  */
 395
 396 int llo_local_objects_setup(const struct lu_env *env,
 397                              struct md_device * md,
 398                              struct dt_device *dt)
 399 {
 400         struct llo_thread_info *info = llo_env_info(env);
 401         struct lu_fid *fid;
 402         struct lu_local_obj_desc *scan;
 403         struct md_object *mdo;
 404         const char *dir;
 405         int rc = 0;
 406
 407         fid = &info->lti_cfid;
 408         cfs_mutex_lock(&llo_lock);
 409
 410         cfs_list_for_each_entry(scan, &llo_lobj_list, llod_linkage) {
 411                 lu_local_obj_fid(fid, scan->llod_oid);
 412                 dir = "";
 413                 if (scan->llod_dir)
 414                         dir = scan->llod_dir;
 415
 416                 if (scan->llod_is_index)
 417                         mdo = llo_store_create_index(env, md, dt ,
 418                                                      dir, scan->llod_name,
 419                                                      fid,
 420                                                      scan->llod_feat);
 421                 else
 422                         mdo = llo_store_create(env, md, dt,
 423                                                dir, scan->llod_name,
 424                                                fid);
 425                 if (IS_ERR(mdo) && PTR_ERR(mdo) != -EEXIST) {
 426                         rc = PTR_ERR(mdo);
 427                         CERROR("creating obj [%s] fid = "DFID" rc = %d\n",
 428                                scan->llod_name, PFID(fid), rc);
 429                         goto out;
 430                 }
 431
 432                 if (!IS_ERR(mdo))
 433                         lu_object_put(env, &mdo->mo_lu);
 434         }
 435
 436 out:
 437         cfs_mutex_unlock(&llo_lock);
 438         return rc;
 439 }
 440
 441 EXPORT_SYMBOL(llo_local_objects_setup);
 442
 443 int llo_global_init(void)
 444 {
 445         int result;
 446
 447         CFS_INIT_LIST_HEAD(&llo_lobj_list);
 448         cfs_mutex_init(&llo_lock);
 449
 450         LU_CONTEXT_KEY_INIT(&llod_key);
 451         result = lu_context_key_register(&llod_key);
 452         return result;
 453 }
 454
 455 void llo_global_fini(void)
 456 {
 457         lu_context_key_degister(&llod_key);
 458         LASSERT(cfs_list_empty(&llo_lobj_list));
 459 }