1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
31 * Copyright (c) 2011 Whamcloud, Inc.
34 * This file is part of Lustre, http://www.lustre.org/
35 * Lustre is a trademark of Sun Microsystems, Inc.
37 * lustre/obdclass/dt_object.c
40 * Generic functions from dt_object.h
42 * Author: Nikita Danilov <nikita@clusterfs.com>
45 #define DEBUG_SUBSYSTEM S_CLASS
47 # define EXPORT_SYMTAB
51 #include <dt_object.h>
52 #include <libcfs/list.h>
54 #include <lustre_fid.h>
57 struct lu_fid *dfh_fid;
58 struct dt_device *dfh_dt;
59 struct dt_object *dfh_o;
62 struct dt_thread_info {
63 char dti_buf[DT_MAX_PATH];
64 struct dt_find_hint dti_dfh;
67 /* context key constructor/destructor: dt_global_key_init, dt_global_key_fini */
68 LU_KEY_INIT(dt_global, struct dt_thread_info);
69 LU_KEY_FINI(dt_global, struct dt_thread_info);
71 static struct lu_context_key dt_key = {
72 .lct_tags = LCT_MD_THREAD|LCT_DT_THREAD,
73 .lct_init = dt_global_key_init,
74 .lct_fini = dt_global_key_fini
77 /* no lock is necessary to protect the list, because call-backs
78 * are added during system startup. Please refer to "struct dt_device".
80 void dt_txn_callback_add(struct dt_device *dev, struct dt_txn_callback *cb)
82 cfs_list_add(&cb->dtc_linkage, &dev->dd_txn_callbacks);
84 EXPORT_SYMBOL(dt_txn_callback_add);
86 void dt_txn_callback_del(struct dt_device *dev, struct dt_txn_callback *cb)
88 cfs_list_del_init(&cb->dtc_linkage);
90 EXPORT_SYMBOL(dt_txn_callback_del);
92 int dt_txn_hook_start(const struct lu_env *env,
93 struct dt_device *dev, struct thandle *th)
96 struct dt_txn_callback *cb;
101 cfs_list_for_each_entry(cb, &dev->dd_txn_callbacks, dtc_linkage) {
102 if (cb->dtc_txn_start == NULL ||
103 !(cb->dtc_tag & env->le_ctx.lc_tags))
105 rc = cb->dtc_txn_start(env, th, cb->dtc_cookie);
111 EXPORT_SYMBOL(dt_txn_hook_start);
113 int dt_txn_hook_stop(const struct lu_env *env, struct thandle *txn)
115 struct dt_device *dev = txn->th_dev;
116 struct dt_txn_callback *cb;
122 cfs_list_for_each_entry(cb, &dev->dd_txn_callbacks, dtc_linkage) {
123 if (cb->dtc_txn_stop == NULL ||
124 !(cb->dtc_tag & env->le_ctx.lc_tags))
126 rc = cb->dtc_txn_stop(env, txn, cb->dtc_cookie);
132 EXPORT_SYMBOL(dt_txn_hook_stop);
134 void dt_txn_hook_commit(struct thandle *txn)
136 struct dt_txn_callback *cb;
141 cfs_list_for_each_entry(cb, &txn->th_dev->dd_txn_callbacks,
143 if (cb->dtc_txn_commit)
144 cb->dtc_txn_commit(txn, cb->dtc_cookie);
147 EXPORT_SYMBOL(dt_txn_hook_commit);
149 int dt_device_init(struct dt_device *dev, struct lu_device_type *t)
152 CFS_INIT_LIST_HEAD(&dev->dd_txn_callbacks);
153 return lu_device_init(&dev->dd_lu_dev, t);
155 EXPORT_SYMBOL(dt_device_init);
157 void dt_device_fini(struct dt_device *dev)
159 lu_device_fini(&dev->dd_lu_dev);
161 EXPORT_SYMBOL(dt_device_fini);
163 int dt_object_init(struct dt_object *obj,
164 struct lu_object_header *h, struct lu_device *d)
167 return lu_object_init(&obj->do_lu, h, d);
169 EXPORT_SYMBOL(dt_object_init);
171 void dt_object_fini(struct dt_object *obj)
173 lu_object_fini(&obj->do_lu);
175 EXPORT_SYMBOL(dt_object_fini);
177 int dt_try_as_dir(const struct lu_env *env, struct dt_object *obj)
179 if (obj->do_index_ops == NULL)
180 obj->do_ops->do_index_try(env, obj, &dt_directory_features);
181 return obj->do_index_ops != NULL;
183 EXPORT_SYMBOL(dt_try_as_dir);
185 enum dt_format_type dt_mode_to_dft(__u32 mode)
187 enum dt_format_type result;
189 switch (mode & S_IFMT) {
194 result = DFT_REGULAR;
211 EXPORT_SYMBOL(dt_mode_to_dft);
214 * lookup fid for object named \a name in directory \a dir.
217 int dt_lookup_dir(const struct lu_env *env, struct dt_object *dir,
218 const char *name, struct lu_fid *fid)
220 if (dt_try_as_dir(env, dir))
221 return dt_lookup(env, dir, (struct dt_rec *)fid,
222 (const struct dt_key *)name, BYPASS_CAPA);
225 EXPORT_SYMBOL(dt_lookup_dir);
227 * get object for given \a fid.
229 struct dt_object *dt_locate(const struct lu_env *env,
230 struct dt_device *dev,
231 const struct lu_fid *fid)
233 struct lu_object *obj;
234 struct dt_object *dt;
236 obj = lu_object_find(env, &dev->dd_lu_dev, fid, NULL);
238 obj = lu_object_locate(obj->lo_header, dev->dd_lu_dev.ld_type);
239 LASSERT(obj != NULL);
240 dt = container_of(obj, struct dt_object, do_lu);
242 dt = (struct dt_object *)obj;
245 EXPORT_SYMBOL(dt_locate);
248 * find a object named \a entry in given \a dfh->dfh_o directory.
250 static int dt_find_entry(const struct lu_env *env, const char *entry, void *data)
252 struct dt_find_hint *dfh = data;
253 struct dt_device *dt = dfh->dfh_dt;
254 struct lu_fid *fid = dfh->dfh_fid;
255 struct dt_object *obj = dfh->dfh_o;
258 result = dt_lookup_dir(env, obj, entry, fid);
259 lu_object_put(env, &obj->do_lu);
261 obj = dt_locate(env, dt, fid);
263 result = PTR_ERR(obj);
270 * Abstract function which parses path name. This function feeds
271 * path component to \a entry_func.
273 int dt_path_parser(const struct lu_env *env,
274 char *path, dt_entry_func_t entry_func,
281 e = strsep(&path, "/");
286 if (!path || path[0] == '\0')
290 rc = entry_func(env, e, data);
298 static struct dt_object *dt_store_resolve(const struct lu_env *env,
299 struct dt_device *dt,
303 struct dt_thread_info *info = lu_context_key_get(&env->le_ctx,
305 struct dt_find_hint *dfh = &info->dti_dfh;
306 struct dt_object *obj;
307 char *local = info->dti_buf;
313 strncpy(local, path, DT_MAX_PATH);
314 local[DT_MAX_PATH - 1] = '\0';
316 result = dt->dd_ops->dt_root_get(env, dt, fid);
318 obj = dt_locate(env, dt, fid);
321 result = dt_path_parser(env, local, dt_find_entry, dfh);
323 obj = ERR_PTR(result);
328 obj = ERR_PTR(result);
333 static struct dt_object *dt_reg_open(const struct lu_env *env,
334 struct dt_device *dt,
342 result = dt_lookup_dir(env, p, name, fid);
344 o = dt_locate(env, dt, fid);
353 * Open dt object named \a filename from \a dirname directory.
354 * \param dt dt device
355 * \param fid on success, object fid is stored in *fid
357 struct dt_object *dt_store_open(const struct lu_env *env,
358 struct dt_device *dt,
360 const char *filename,
363 struct dt_object *file;
364 struct dt_object *dir;
366 dir = dt_store_resolve(env, dt, dirname, fid);
368 file = dt_reg_open(env, dt, dir,
370 lu_object_put(env, &dir->do_lu);
376 EXPORT_SYMBOL(dt_store_open);
378 /* dt class init function. */
379 int dt_global_init(void)
383 LU_CONTEXT_KEY_INIT(&dt_key);
384 result = lu_context_key_register(&dt_key);
388 void dt_global_fini(void)
390 lu_context_key_degister(&dt_key);
393 int dt_record_read(const struct lu_env *env, struct dt_object *dt,
394 struct lu_buf *buf, loff_t *pos)
398 LASSERTF(dt != NULL, "dt is NULL when we want to read record\n");
400 rc = dt->do_body_ops->dbo_read(env, dt, buf, pos, BYPASS_CAPA);
402 if (rc == buf->lb_len)
408 EXPORT_SYMBOL(dt_record_read);
410 int dt_record_write(const struct lu_env *env, struct dt_object *dt,
411 const struct lu_buf *buf, loff_t *pos, struct thandle *th)
415 LASSERTF(dt != NULL, "dt is NULL when we want to write record\n");
417 LASSERT(dt->do_body_ops);
418 LASSERT(dt->do_body_ops->dbo_write);
419 rc = dt->do_body_ops->dbo_write(env, dt, buf, pos, th, BYPASS_CAPA, 1);
420 if (rc == buf->lb_len)
426 EXPORT_SYMBOL(dt_record_write);
428 int dt_declare_version_set(const struct lu_env *env, struct dt_object *o,
432 char *xname = XATTR_NAME_VERSION;
436 vbuf.lb_len = sizeof(dt_obj_version_t);
437 return dt_declare_xattr_set(env, o, &vbuf, xname, 0, th);
440 EXPORT_SYMBOL(dt_declare_version_set);
442 void dt_version_set(const struct lu_env *env, struct dt_object *o,
443 dt_obj_version_t version, struct thandle *th)
446 char *xname = XATTR_NAME_VERSION;
450 vbuf.lb_buf = &version;
451 vbuf.lb_len = sizeof(version);
453 rc = dt_xattr_set(env, o, &vbuf, xname, 0, th, BYPASS_CAPA);
455 CDEBUG(D_INODE, "Can't set version, rc %d\n", rc);
458 EXPORT_SYMBOL(dt_version_set);
460 dt_obj_version_t dt_version_get(const struct lu_env *env, struct dt_object *o)
463 char *xname = XATTR_NAME_VERSION;
464 dt_obj_version_t version;
468 vbuf.lb_buf = &version;
469 vbuf.lb_len = sizeof(version);
470 rc = dt_xattr_get(env, o, &vbuf, xname, BYPASS_CAPA);
471 if (rc != sizeof(version)) {
472 CDEBUG(D_INODE, "Can't get version, rc %d\n", rc);
477 EXPORT_SYMBOL(dt_version_get);
479 const struct dt_index_features dt_directory_features;
480 EXPORT_SYMBOL(dt_directory_features);