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.
31 * This file is part of Lustre, http://www.lustre.org/
32 * Lustre is a trademark of Sun Microsystems, Inc.
34 * lustre/obdclass/md_local_object.c
36 * Lustre Local Object create APIs
37 * 'create on first mount' facility. Files registed under llo module will
38 * be created on first mount.
40 * Author: Pravin Shelar <pravin.shelar@sun.com>
43 #define DEBUG_SUBSYSTEM S_CLASS
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>
53 /** List head to hold list of objects to be created. */
54 static cfs_list_t llo_lobj_list;
56 /** Lock to protect list manipulations */
57 static cfs_mutex_t llo_lock;
60 * Structure used to maintain state of path parsing.
61 * \see llo_find_entry, llo_store_resolve
63 struct llo_find_hint {
64 struct lu_fid *lfh_cfid;
65 struct md_device *lfh_md;
66 struct md_object *lfh_pobj;
70 * Thread Local storage for this module.
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;
85 LU_KEY_INIT(llod_global, struct llo_thread_info);
86 LU_KEY_FINI(llod_global, struct llo_thread_info);
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
94 static inline struct llo_thread_info * llo_env_info(const struct lu_env *env)
96 return lu_context_key_get(&env->le_ctx, &llod_key);
100 * Search md object for given fid.
102 static struct md_object *llo_locate(const struct lu_env *env,
103 struct md_device *md,
104 const struct lu_fid *fid)
106 struct lu_object *obj;
107 struct md_object *mdo;
109 obj = lu_object_find(env, &md->md_lu_dev, fid, NULL);
111 obj = lu_object_locate(obj->lo_header, md->md_lu_dev.ld_type);
112 LASSERT(obj != NULL);
113 mdo = (struct md_object *) obj;
115 mdo = (struct md_object *)obj;
120 * Lookup FID for object named \a name in directory \a pobj.
122 static int llo_lookup(const struct lu_env *env,
123 struct md_object *pobj,
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;
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;
137 lname->ln_name = name;
138 lname->ln_namelen = strlen(name);
140 return mdo_lookup(env, pobj, lname, fid, spec);
144 * Function to look up path component, this is passed to parsing
145 * function. \see llo_store_resolve
147 * \retval rc returns error code for lookup or locate operation
149 * pointer to object is returned in data (lfh->lfh_pobj)
151 static int llo_find_entry(const struct lu_env *env,
152 const char *name, void *data)
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;
160 /* lookup fid for object */
161 result = llo_lookup(env, obj, name, fid);
162 lu_object_put(env, &obj->mo_lu);
165 /* get md object for fid that we got in lookup */
166 obj = llo_locate(env, md, fid);
168 result = PTR_ERR(obj);
175 static struct md_object *llo_reg_open(const struct lu_env *env,
176 struct md_device *md,
184 result = llo_lookup(env, p, name, fid);
186 o = llo_locate(env, md, fid);
194 * Resolve given \a path, on success function returns
195 * md object for last directory and \a fid points to
198 struct md_object *llo_store_resolve(const struct lu_env *env,
199 struct md_device *md,
200 struct dt_device *dt,
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;
210 strncpy(local, path, DT_MAX_PATH);
211 local[DT_MAX_PATH - 1] = '\0';
215 /* start path resolution from backend fs root. */
216 result = dt->dd_ops->dt_root_get(env, dt, fid);
218 /* get md object for root */
219 obj = llo_locate(env, md, fid);
221 /* start path parser from root md */
223 result = dt_path_parser(env, local, llo_find_entry, lfh);
225 obj = ERR_PTR(result);
230 obj = ERR_PTR(result);
234 EXPORT_SYMBOL(llo_store_resolve);
237 * Returns md object for \a objname in given \a dirname.
239 struct md_object *llo_store_open(const struct lu_env *env,
240 struct md_device *md,
241 struct dt_device *dt,
246 struct md_object *obj;
247 struct md_object *dir;
249 /* search md object for parent dir */
250 dir = llo_store_resolve(env, md, dt, dirname, fid);
252 obj = llo_reg_open(env, md, dir, objname, fid);
253 lu_object_put(env, &dir->mo_lu);
259 EXPORT_SYMBOL(llo_store_open);
261 static struct md_object *llo_create_obj(const struct lu_env *env,
262 struct md_device *md,
263 struct md_object *dir,
265 const struct lu_fid *fid,
266 const struct dt_index_features *feat)
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;
276 mdo = llo_locate(env, md, fid);
280 lname->ln_name = objname;
281 lname->ln_namelen = strlen(objname);
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;
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 cfs_mutex_lock(&llo_lock);
377 cfs_list_add_tail(&llod->llod_linkage, &llo_lobj_list);
378 cfs_mutex_unlock(&llo_lock);
381 EXPORT_SYMBOL(llo_local_obj_register);
383 void llo_local_obj_unregister(struct lu_local_obj_desc *llod)
385 cfs_mutex_lock(&llo_lock);
386 cfs_list_del(&llod->llod_linkage);
387 cfs_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 cfs_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 cfs_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 cfs_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));