4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/obdclass/md_local_object.c
38 * Lustre Local Object create APIs
39 * 'create on first mount' facility. Files registed under llo module will
40 * be created on first mount.
42 * Author: Pravin Shelar <pravin.shelar@sun.com>
45 #define DEBUG_SUBSYSTEM S_CLASS
47 #include <obd_support.h>
48 #include <lustre_disk.h>
49 #include <lustre_fid.h>
50 #include <lu_object.h>
51 #include <libcfs/list.h>
52 #include <md_object.h>
55 /** List head to hold list of objects to be created. */
56 static cfs_list_t llo_lobj_list;
58 /** Lock to protect list manipulations */
59 static struct mutex llo_lock;
62 * Structure used to maintain state of path parsing.
63 * \see llo_find_entry, llo_store_resolve
65 struct llo_find_hint {
66 struct lu_fid *lfh_cfid;
67 struct md_device *lfh_md;
68 struct md_object *lfh_pobj;
72 * Thread Local storage for this module.
74 struct llo_thread_info {
75 /** buffer to resolve path */
76 char lti_buf[DT_MAX_PATH];
77 /** used for path resolve */
78 struct lu_fid lti_fid;
79 /** used to pass child object fid */
80 struct lu_fid lti_cfid;
81 struct llo_find_hint lti_lfh;
82 struct md_op_spec lti_spc;
83 struct md_attr lti_ma;
84 struct lu_name lti_lname;
87 LU_KEY_INIT(llod_global, struct llo_thread_info);
88 LU_KEY_FINI(llod_global, struct llo_thread_info);
90 static struct lu_context_key llod_key = {
91 .lct_tags = LCT_MD_THREAD,
92 .lct_init = llod_global_key_init,
93 .lct_fini = llod_global_key_fini
96 static inline struct llo_thread_info * llo_env_info(const struct lu_env *env)
98 return lu_context_key_get(&env->le_ctx, &llod_key);
102 * Search md object for given fid.
104 static struct md_object *llo_locate(const struct lu_env *env,
105 struct md_device *md,
106 const struct lu_fid *fid)
108 struct lu_object *obj;
109 struct md_object *mdo;
111 obj = lu_object_find(env, &md->md_lu_dev, fid, NULL);
113 obj = lu_object_locate(obj->lo_header, md->md_lu_dev.ld_type);
114 LASSERT(obj != NULL);
115 mdo = (struct md_object *) obj;
117 mdo = (struct md_object *)obj;
122 * Lookup FID for object named \a name in directory \a pobj.
124 static int llo_lookup(const struct lu_env *env,
125 struct md_object *pobj,
129 struct llo_thread_info *info = llo_env_info(env);
130 struct lu_name *lname = &info->lti_lname;
131 struct md_op_spec *spec = &info->lti_spc;
133 spec->sp_feat = NULL;
134 spec->sp_cr_flags = 0;
135 spec->sp_cr_lookup = 0;
136 spec->sp_cr_mode = 0;
138 lname->ln_name = name;
139 lname->ln_namelen = strlen(name);
141 return mdo_lookup(env, pobj, lname, fid, spec);
145 * Function to look up path component, this is passed to parsing
146 * function. \see llo_store_resolve
148 * \retval rc returns error code for lookup or locate operation
150 * pointer to object is returned in data (lfh->lfh_pobj)
152 static int llo_find_entry(const struct lu_env *env,
153 const char *name, void *data)
155 struct llo_find_hint *lfh = data;
156 struct md_device *md = lfh->lfh_md;
157 struct lu_fid *fid = lfh->lfh_cfid;
158 struct md_object *obj = lfh->lfh_pobj;
161 /* lookup fid for object */
162 result = llo_lookup(env, obj, name, fid);
163 lu_object_put(env, &obj->mo_lu);
166 /* get md object for fid that we got in lookup */
167 obj = llo_locate(env, md, fid);
169 result = PTR_ERR(obj);
176 static struct md_object *llo_reg_open(const struct lu_env *env,
177 struct md_device *md,
185 result = llo_lookup(env, p, name, fid);
187 o = llo_locate(env, md, fid);
195 * Resolve given \a path, on success function returns
196 * md object for last directory and \a fid points to
199 struct md_object *llo_store_resolve(const struct lu_env *env,
200 struct md_device *md,
201 struct dt_device *dt,
205 struct llo_thread_info *info = llo_env_info(env);
206 struct llo_find_hint *lfh = &info->lti_lfh;
207 char *local = info->lti_buf;
208 struct md_object *obj;
211 strncpy(local, path, DT_MAX_PATH);
212 local[DT_MAX_PATH - 1] = '\0';
216 /* start path resolution from backend fs root. */
217 result = dt->dd_ops->dt_root_get(env, dt, fid);
219 /* get md object for root */
220 obj = llo_locate(env, md, fid);
222 /* start path parser from root md */
224 result = dt_path_parser(env, local, llo_find_entry, lfh);
226 obj = ERR_PTR(result);
231 obj = ERR_PTR(result);
235 EXPORT_SYMBOL(llo_store_resolve);
238 * Returns md object for \a objname in given \a dirname.
240 struct md_object *llo_store_open(const struct lu_env *env,
241 struct md_device *md,
242 struct dt_device *dt,
247 struct md_object *obj;
248 struct md_object *dir;
250 /* search md object for parent dir */
251 dir = llo_store_resolve(env, md, dt, dirname, fid);
253 obj = llo_reg_open(env, md, dir, objname, fid);
254 lu_object_put(env, &dir->mo_lu);
260 EXPORT_SYMBOL(llo_store_open);
262 static struct md_object *llo_create_obj(const struct lu_env *env,
263 struct md_device *md,
264 struct md_object *dir,
266 const struct lu_fid *fid,
267 const struct dt_index_features *feat)
269 struct llo_thread_info *info = llo_env_info(env);
270 struct md_object *mdo;
271 struct md_attr *ma = &info->lti_ma;
272 struct md_op_spec *spec = &info->lti_spc;
273 struct lu_name *lname = &info->lti_lname;
274 struct lu_attr *la = &ma->ma_attr;
277 mdo = llo_locate(env, md, fid);
281 lname->ln_name = objname;
282 lname->ln_namelen = strlen(objname);
284 spec->sp_feat = feat;
285 spec->sp_cr_flags = 0;
286 spec->sp_cr_lookup = 1;
287 spec->sp_cr_mode = 0;
289 if (feat == &dt_directory_features)
290 la->la_mode = S_IFDIR | S_IXUGO;
292 la->la_mode = S_IFREG;
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;
301 rc = mdo_create(env, dir, lname, mdo, spec, ma);
304 lu_object_put(env, &mdo->mo_lu);
312 * Create md object, object could be diretcory or
313 * special index defined by \a feat in \a directory.
316 * \param dirname parent directory
317 * \param objname file name
318 * \param fid object fid
319 * \param feat index features required for directory create
322 struct md_object *llo_store_create_index(const struct lu_env *env,
323 struct md_device *md,
324 struct dt_device *dt,
327 const struct lu_fid *fid,
328 const struct dt_index_features *feat)
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;
335 dir = llo_store_resolve(env, md, dt, dirname, ignore);
337 obj = llo_create_obj(env, md, dir, objname, fid, feat);
338 lu_object_put(env, &dir->mo_lu);
345 EXPORT_SYMBOL(llo_store_create_index);
348 * Create md object for regular file in \a directory.
351 * \param dirname parent directory
352 * \param objname file name
353 * \param fid object fid.
356 struct md_object *llo_store_create(const struct lu_env *env,
357 struct md_device *md,
358 struct dt_device *dt,
361 const struct lu_fid *fid)
363 return llo_store_create_index(env, md, dt, dirname,
367 EXPORT_SYMBOL(llo_store_create);
370 * Register object for 'create on first mount' facility.
371 * objects are created in order of registration.
374 void llo_local_obj_register(struct lu_local_obj_desc *llod)
376 mutex_lock(&llo_lock);
377 cfs_list_add_tail(&llod->llod_linkage, &llo_lobj_list);
378 mutex_unlock(&llo_lock);
381 EXPORT_SYMBOL(llo_local_obj_register);
383 void llo_local_obj_unregister(struct lu_local_obj_desc *llod)
385 mutex_lock(&llo_lock);
386 cfs_list_del(&llod->llod_linkage);
387 mutex_unlock(&llo_lock);
390 EXPORT_SYMBOL(llo_local_obj_unregister);
393 * Created registed objects.
396 int llo_local_objects_setup(const struct lu_env *env,
397 struct md_device * md,
398 struct dt_device *dt)
400 struct llo_thread_info *info = llo_env_info(env);
402 struct lu_local_obj_desc *scan;
403 struct md_object *mdo;
407 fid = &info->lti_cfid;
408 mutex_lock(&llo_lock);
410 cfs_list_for_each_entry(scan, &llo_lobj_list, llod_linkage) {
411 lu_local_obj_fid(fid, scan->llod_oid);
414 dir = scan->llod_dir;
416 if (scan->llod_is_index)
417 mdo = llo_store_create_index(env, md, dt ,
418 dir, scan->llod_name,
422 mdo = llo_store_create(env, md, dt,
423 dir, scan->llod_name,
425 if (IS_ERR(mdo) && PTR_ERR(mdo) != -EEXIST) {
427 CERROR("creating obj [%s] fid = "DFID" rc = %d\n",
428 scan->llod_name, PFID(fid), rc);
433 lu_object_put(env, &mdo->mo_lu);
437 mutex_unlock(&llo_lock);
441 EXPORT_SYMBOL(llo_local_objects_setup);
443 int llo_global_init(void)
447 CFS_INIT_LIST_HEAD(&llo_lobj_list);
448 mutex_init(&llo_lock);
450 LU_CONTEXT_KEY_INIT(&llod_key);
451 result = lu_context_key_register(&llod_key);
455 void llo_global_fini(void)
457 lu_context_key_degister(&llod_key);
458 LASSERT(cfs_list_empty(&llo_lobj_list));