1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
5 * Copyright (C) 2006 Cluster File Systems, Inc.
6 * Author: Wang Di <wangdi@clusterfs.com>
8 * This file is part of the Lustre file system, http://www.lustre.org
9 * Lustre is a trademark of Cluster File Systems, Inc.
11 * You may have signed or agreed to another license before downloading
12 * this software. If so, you are bound by the terms and conditions
13 * of that agreement, and the following does not apply to you. See the
14 * LICENSE file included with this distribution for more information.
16 * If you did not agree to a different license, then this copy of Lustre
17 * is open source software; you can redistribute it and/or modify it
18 * under the terms of version 2 of the GNU General Public License as
19 * published by the Free Software Foundation.
21 * In either case, Lustre is distributed in the hope that it will be
22 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
23 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * license text for more details.
27 #ifndef _MDD_INTERNAL_H
28 #define _MDD_INTERNAL_H
30 #include <asm/semaphore.h>
32 #include <linux/lustre_acl.h>
33 #include <lustre_eacl.h>
35 #include <md_object.h>
36 #include <dt_object.h>
37 #include <linux/sched.h>
38 #include <linux/capability.h>
39 #include <linux/dynlocks.h>
42 MDD_TXN_OBJECT_DESTROY_OP = 0,
43 MDD_TXN_OBJECT_CREATE_OP,
46 MDD_TXN_INDEX_INSERT_OP,
47 MDD_TXN_INDEX_DELETE_OP,
51 MDD_TXN_RENAME_TGT_OP,
52 MDD_TXN_CREATE_DATA_OP,
57 struct mdd_txn_op_descr {
58 enum mdd_txn_op mod_op;
59 unsigned int mod_credits;
63 struct md_device mdd_md_dev;
64 struct dt_device *mdd_child;
65 struct obd_device *mdd_obd_dev;
66 struct lu_fid mdd_root_fid;
67 struct dt_device_param mdd_dt_conf;
68 struct dt_object *mdd_orphans;
69 struct dt_txn_callback mdd_txn_cb;
70 cfs_proc_dir_entry_t *mdd_proc_entry;
71 struct lprocfs_stats *mdd_stats;
72 struct mdd_txn_op_descr mdd_tod[MDD_TXN_LAST_OP];
76 /* The dir object has been unlinked */
83 #define LUSTRE_APPEND_FL LDISKFS_APPEND_FL
84 #define LUSTRE_IMMUTABLE_FL LDISKFS_IMMUTABLE_FL
85 #define LUSTRE_DIRSYNC_FL LDISKFS_DIRSYNC_FL
88 struct md_object mod_obj;
92 unsigned long mod_flags;
93 struct dynlock mod_pdlock;
97 /* fid of the object*/
99 /* type of operation: unlink, truncate */
101 } __attribute__((packed));
103 struct mdd_thread_info {
104 struct txn_param mti_param;
105 struct lu_fid mti_fid;
106 struct lu_attr mti_la;
107 struct md_attr mti_ma;
108 struct lu_attr mti_la_for_fix;
109 struct obd_info mti_oi;
110 struct orph_key mti_orph_key;
111 struct obd_trans_info mti_oti;
112 struct lu_buf mti_buf;
114 char mti_xattr_buf[LUSTRE_POSIX_ACL_MAX_SIZE];
115 struct lu_fid mti_fid2; /* used for be & cpu converting */
116 struct lu_fid_pack mti_pack;
117 struct dt_allocation_hint mti_hint;
118 struct lov_mds_md *mti_max_lmm;
119 int mti_max_lmm_size;
120 struct llog_cookie *mti_max_cookie;
121 int mti_max_cookie_size;
124 struct lov_mds_md *mdd_max_lmm_get(const struct lu_env *env,
125 struct mdd_device *mdd);
127 struct llog_cookie *mdd_max_cookie_get(const struct lu_env *env,
128 struct mdd_device *mdd);
130 int mdd_init_obd(const struct lu_env *env, struct mdd_device *mdd,
131 struct lustre_cfg *cfg);
132 int mdd_fini_obd(const struct lu_env *env, struct mdd_device *mdd,
133 struct lustre_cfg *lcfg);
134 int mdd_xattr_set_txn(const struct lu_env *env, struct mdd_object *obj,
135 const struct lu_buf *buf, const char *name, int fl,
136 struct thandle *txn);
137 int mdd_lsm_sanity_check(const struct lu_env *env, struct mdd_object *obj);
138 int mdd_lov_set_md(const struct lu_env *env, struct mdd_object *pobj,
139 struct mdd_object *child, struct lov_mds_md *lmm,
140 int lmm_size, struct thandle *handle, int set_stripe);
141 int mdd_lov_create(const struct lu_env *env, struct mdd_device *mdd,
142 struct mdd_object *parent, struct mdd_object *child,
143 struct lov_mds_md **lmm, int *lmm_size,
144 const struct md_op_spec *spec, struct lu_attr *la);
145 void mdd_lov_objid_update(struct mdd_device *mdd, struct lov_mds_md *lmm);
146 void mdd_lov_create_finish(const struct lu_env *env, struct mdd_device *mdd,
147 struct lov_mds_md *lmm, int lmm_size,
148 const struct md_op_spec *spec);
149 int mdd_get_md(const struct lu_env *env, struct mdd_object *obj,
150 void *md, int *md_size, const char *name);
151 int mdd_get_md_locked(const struct lu_env *env, struct mdd_object *obj,
152 void *md, int *md_size, const char *name);
153 int mdd_la_get(const struct lu_env *env, struct mdd_object *obj,
154 struct lu_attr *la, struct lustre_capa *capa);
155 int mdd_attr_set_internal(const struct lu_env *env, struct mdd_object *o,
156 const struct lu_attr *attr, struct thandle *handle,
158 int mdd_object_kill(const struct lu_env *env, struct mdd_object *obj,
160 int mdd_iattr_get(const struct lu_env *env, struct mdd_object *mdd_obj,
162 int mdd_attr_get_internal_locked(const struct lu_env *env,
163 struct mdd_object *mdd_obj,
165 int mdd_object_create_internal(const struct lu_env *env, struct mdd_object *p,
166 struct mdd_object *c, struct md_attr *ma,
167 struct thandle *handle);
168 int mdd_attr_set_internal_locked(const struct lu_env *env,
169 struct mdd_object *o,
170 const struct lu_attr *attr,
171 struct thandle *handle, const int needacl);
172 int mdd_lmm_get_locked(const struct lu_env *env, struct mdd_object *mdd_obj,
175 void mdd_write_lock(const struct lu_env *env, struct mdd_object *obj);
176 void mdd_read_lock(const struct lu_env *env, struct mdd_object *obj);
177 void mdd_write_unlock(const struct lu_env *env, struct mdd_object *obj);
178 void mdd_read_unlock(const struct lu_env *env, struct mdd_object *obj);
180 void mdd_pdlock_init(struct mdd_object *obj);
181 unsigned long mdd_name2hash(const char *name);
182 struct dynlock_handle *mdd_pdo_write_lock(const struct lu_env *env,
183 struct mdd_object *obj,
185 struct dynlock_handle *mdd_pdo_read_lock(const struct lu_env *env,
186 struct mdd_object *obj,
188 void mdd_pdo_write_unlock(const struct lu_env *env, struct mdd_object *obj,
189 struct dynlock_handle *dlh);
190 void mdd_pdo_read_unlock(const struct lu_env *env, struct mdd_object *obj,
191 struct dynlock_handle *dlh);
193 int mdd_may_create(const struct lu_env *env, struct mdd_object *pobj,
194 struct mdd_object *cobj, int check_perm, int check_nlink);
195 int mdd_may_unlink(const struct lu_env *env, struct mdd_object *pobj,
196 const struct md_attr *ma);
197 int mdd_may_delete(const struct lu_env *env, struct mdd_object *pobj,
198 struct mdd_object *cobj, struct md_attr *ma,
199 int check_perm, int check_empty);
200 int mdd_unlink_sanity_check(const struct lu_env *env, struct mdd_object *pobj,
201 struct mdd_object *cobj, struct md_attr *ma);
202 int mdd_finish_unlink(const struct lu_env *env, struct mdd_object *obj,
203 struct md_attr *ma, struct thandle *th);
204 int mdd_object_initialize(const struct lu_env *env, const struct lu_fid *pfid,
205 struct mdd_object *child, struct md_attr *ma,
206 struct thandle *handle);
207 int mdd_link_sanity_check(const struct lu_env *env, struct mdd_object *tgt_obj,
208 const struct lu_name *lname, struct mdd_object *src_obj);
210 int mdd_unlink_log(const struct lu_env *env, struct mdd_device *mdd,
211 struct mdd_object *mdd_cobj, struct md_attr *ma);
213 int mdd_setattr_log(const struct lu_env *env, struct mdd_device *mdd,
214 const struct md_attr *ma,
215 struct lov_mds_md *lmm, int lmm_size,
216 struct llog_cookie *logcookies, int cookies_size);
218 int mdd_get_cookie_size(const struct lu_env *env, struct mdd_device *mdd,
219 struct lov_mds_md *lmm);
221 int mdd_lov_setattr_async(const struct lu_env *env, struct mdd_object *obj,
222 struct lov_mds_md *lmm, int lmm_size,
223 struct llog_cookie *logcookies);
225 struct mdd_thread_info *mdd_env_info(const struct lu_env *env);
227 struct lu_buf *mdd_buf_get(const struct lu_env *env, void *area, ssize_t len);
228 const struct lu_buf *mdd_buf_get_const(const struct lu_env *env,
229 const void *area, ssize_t len);
231 int __mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d);
232 int __mdd_orphan_add(const struct lu_env *, struct mdd_object *,
234 int __mdd_orphan_del(const struct lu_env *, struct mdd_object *,
236 int orph_index_init(const struct lu_env *env, struct mdd_device *mdd);
237 void orph_index_fini(const struct lu_env *env, struct mdd_device *mdd);
238 int mdd_txn_init_credits(const struct lu_env *env, struct mdd_device *mdd);
240 int mdd_procfs_init(struct mdd_device *mdd, const char *name);
241 int mdd_procfs_fini(struct mdd_device *mdd);
242 void mdd_lprocfs_time_start(const struct lu_env *env);
243 void mdd_lprocfs_time_end(const struct lu_env *env,
244 struct mdd_device *mdd, int op);
246 int mdd_get_flags(const struct lu_env *env, struct mdd_object *obj);
248 extern struct md_dir_operations mdd_dir_ops;
249 extern struct md_object_operations mdd_obj_ops;
252 void mdd_txn_param_build(const struct lu_env *env, struct mdd_device *mdd,
254 int mdd_log_txn_param_build(const struct lu_env *env, struct md_object *obj,
255 struct md_attr *ma, enum mdd_txn_op);
257 static inline void mdd_object_put(const struct lu_env *env,
258 struct mdd_object *o)
260 lu_object_put(env, &o->mod_obj.mo_lu);
263 struct thandle* mdd_trans_start(const struct lu_env *env,
264 struct mdd_device *);
266 void mdd_trans_stop(const struct lu_env *env, struct mdd_device *mdd,
267 int rc, struct thandle *handle);
269 int mdd_txn_start_cb(const struct lu_env *env, struct txn_param *param,
272 int mdd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
275 int mdd_txn_commit_cb(const struct lu_env *env, struct thandle *txn,
278 struct lu_object *mdd_object_alloc(const struct lu_env *env,
279 const struct lu_object_header *hdr,
280 struct lu_device *d);
283 int accmode(const struct lu_env *env, struct lu_attr *la, int flags);
284 extern struct lu_context_key mdd_thread_key;
285 extern struct lu_device_operations mdd_lu_ops;
287 struct mdd_object *mdd_object_find(const struct lu_env *env,
288 struct mdd_device *d,
289 const struct lu_fid *f);
290 /* mdd_permission.c */
291 #define mdd_cap_t(x) (x)
293 #define MDD_CAP_TO_MASK(x) (1 << (x))
295 #define mdd_cap_raised(c, flag) (mdd_cap_t(c) & MDD_CAP_TO_MASK(flag))
297 /* capable() is copied from linux kernel! */
298 static inline int mdd_capable(struct md_ucred *uc, int cap)
300 if (mdd_cap_raised(uc->mu_cap, cap))
305 int mdd_acl_def_get(const struct lu_env *env, struct mdd_object *mdd_obj,
307 int mdd_acl_chmod(const struct lu_env *env, struct mdd_object *o, __u32 mode,
308 struct thandle *handle);
309 int __mdd_acl_init(const struct lu_env *env, struct mdd_object *obj,
310 struct lu_buf *buf, __u32 *mode, struct thandle *handle);
311 int mdd_acl_init(const struct lu_env *env, struct mdd_object *pobj,
312 struct mdd_object *cobj, __u32 *mode, struct thandle *handle);
313 int __mdd_permission_internal(const struct lu_env *env, struct mdd_object *obj,
314 struct lu_attr *la, int mask, int needlock);
315 int mdd_permission(const struct lu_env *env,
316 struct md_object *pobj, struct md_object *cobj,
317 struct md_attr *ma, int mask);
318 int mdd_capa_get(const struct lu_env *env, struct md_object *obj,
319 struct lustre_capa *capa, int renewal);
321 static inline int lu_device_is_mdd(struct lu_device *d)
323 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdd_lu_ops);
326 static inline struct mdd_device* lu2mdd_dev(struct lu_device *d)
328 LASSERT(lu_device_is_mdd(d));
329 return container_of0(d, struct mdd_device, mdd_md_dev.md_lu_dev);
332 static inline struct lu_device *mdd2lu_dev(struct mdd_device *d)
334 return (&d->mdd_md_dev.md_lu_dev);
337 static inline struct mdd_object *lu2mdd_obj(struct lu_object *o)
339 LASSERT(ergo(o != NULL, lu_device_is_mdd(o->lo_dev)));
340 return container_of0(o, struct mdd_object, mod_obj.mo_lu);
343 static inline struct mdd_device* mdo2mdd(struct md_object *mdo)
345 return lu2mdd_dev(mdo->mo_lu.lo_dev);
348 static inline struct mdd_object* md2mdd_obj(struct md_object *mdo)
350 return container_of0(mdo, struct mdd_object, mod_obj);
353 static inline struct dt_device_operations *mdd_child_ops(struct mdd_device *d)
355 return d->mdd_child->dd_ops;
358 static inline struct lu_object *mdd2lu_obj(struct mdd_object *obj)
360 return &obj->mod_obj.mo_lu;
363 static inline struct dt_object* mdd_object_child(struct mdd_object *o)
365 return container_of0(lu_object_next(mdd2lu_obj(o)),
366 struct dt_object, do_lu);
369 static inline struct obd_device *mdd2obd_dev(struct mdd_device *mdd)
371 return mdd->mdd_obd_dev;
374 static inline struct mdd_device *mdd_obj2mdd_dev(struct mdd_object *obj)
376 return mdo2mdd(&obj->mod_obj);
379 static inline const struct lu_fid *mdo2fid(const struct mdd_object *obj)
381 return lu_object_fid(&obj->mod_obj.mo_lu);
384 static inline umode_t mdd_object_type(const struct mdd_object *obj)
386 return lu_object_attr(&obj->mod_obj.mo_lu);
389 static inline int mdd_lov_mdsize(const struct lu_env *env,
390 struct mdd_device *mdd)
392 struct obd_device *obd = mdd2obd_dev(mdd);
393 return obd->u.mds.mds_max_mdsize;
396 static inline int mdd_lov_cookiesize(const struct lu_env *env,
397 struct mdd_device *mdd)
399 struct obd_device *obd = mdd2obd_dev(mdd);
400 return obd->u.mds.mds_max_cookiesize;
403 static inline int mdd_is_immutable(struct mdd_object *obj)
405 return obj->mod_flags & IMMUTE_OBJ;
408 static inline int mdd_is_dead_obj(struct mdd_object *obj)
410 return obj && obj->mod_flags & DEAD_OBJ;
413 static inline int mdd_is_append(struct mdd_object *obj)
415 return obj->mod_flags & APPEND_OBJ;
418 static inline int mdd_object_exists(struct mdd_object *obj)
420 return lu_object_exists(mdd2lu_obj(obj));
423 static inline const struct lu_fid *mdd_object_fid(struct mdd_object *obj)
425 return lu_object_fid(mdd2lu_obj(obj));
428 static inline struct lustre_capa *mdd_object_capa(const struct lu_env *env,
429 const struct mdd_object *obj)
431 struct md_capainfo *ci = md_capainfo(env);
432 const struct lu_fid *fid = mdo2fid(obj);
435 /* NB: in mdt_init0 */
438 for (i = 0; i < MD_CAPAINFO_MAX; i++)
439 if (ci->mc_fid[i] && lu_fid_eq(ci->mc_fid[i], fid))
440 return ci->mc_capa[i];
444 static inline void mdd_set_capainfo(const struct lu_env *env, int offset,
445 const struct mdd_object *obj,
446 struct lustre_capa *capa)
448 struct md_capainfo *ci = md_capainfo(env);
449 const struct lu_fid *fid = mdo2fid(obj);
451 LASSERT(offset >= 0 && offset <= MD_CAPAINFO_MAX);
452 /* NB: in mdt_init0 */
455 ci->mc_fid[offset] = fid;
456 ci->mc_capa[offset] = capa;
463 static inline int mdd_permission_internal(const struct lu_env *env,
464 struct mdd_object *obj,
465 struct lu_attr *la, int mask)
467 return __mdd_permission_internal(env, obj, la, mask, 0);
470 static inline int mdd_permission_internal_locked(const struct lu_env *env,
471 struct mdd_object *obj,
472 struct lu_attr *la, int mask)
474 return __mdd_permission_internal(env, obj, la, mask, 1);
477 /* mdd inline func for calling osd_dt_object ops */
478 static inline int mdo_attr_get(const struct lu_env *env, struct mdd_object *obj,
479 struct lu_attr *la, struct lustre_capa *capa)
481 struct dt_object *next = mdd_object_child(obj);
482 return next->do_ops->do_attr_get(env, next, la, capa);
485 static inline int mdo_attr_set(const struct lu_env *env, struct mdd_object *obj,
486 const struct lu_attr *la, struct thandle *handle,
487 struct lustre_capa *capa)
489 struct dt_object *next = mdd_object_child(obj);
490 LASSERT(mdd_object_exists(obj));
491 return next->do_ops->do_attr_set(env, next, la, handle, capa);
494 static inline int mdo_xattr_get(const struct lu_env *env,struct mdd_object *obj,
495 struct lu_buf *buf, const char *name,
496 struct lustre_capa *capa)
498 struct dt_object *next = mdd_object_child(obj);
499 return next->do_ops->do_xattr_get(env, next, buf, name, capa);
502 static inline int mdo_xattr_set(const struct lu_env *env,struct mdd_object *obj,
503 const struct lu_buf *buf, const char *name,
504 int fl, struct thandle *handle,
505 struct lustre_capa *capa)
507 struct dt_object *next = mdd_object_child(obj);
508 LASSERT(mdd_object_exists(obj));
509 return next->do_ops->do_xattr_set(env, next, buf, name, fl, handle,
513 static inline int mdo_xattr_del(const struct lu_env *env,struct mdd_object *obj,
514 const char *name, struct thandle *handle,
515 struct lustre_capa *capa)
517 struct dt_object *next = mdd_object_child(obj);
518 LASSERT(mdd_object_exists(obj));
519 return next->do_ops->do_xattr_del(env, next, name, handle, capa);
523 int mdo_xattr_list(const struct lu_env *env, struct mdd_object *obj,
524 struct lu_buf *buf, struct lustre_capa *capa)
526 struct dt_object *next = mdd_object_child(obj);
527 LASSERT(mdd_object_exists(obj));
528 return next->do_ops->do_xattr_list(env, next, buf, capa);
532 int mdo_index_try(const struct lu_env *env, struct mdd_object *obj,
533 const struct dt_index_features *feat)
535 struct dt_object *next = mdd_object_child(obj);
536 return next->do_ops->do_index_try(env, next, feat);
539 static inline void mdo_ref_add(const struct lu_env *env, struct mdd_object *obj,
540 struct thandle *handle)
542 struct dt_object *next = mdd_object_child(obj);
543 LASSERT(mdd_object_exists(obj));
544 return next->do_ops->do_ref_add(env, next, handle);
547 static inline void mdo_ref_del(const struct lu_env *env, struct mdd_object *obj,
548 struct thandle *handle)
550 struct dt_object *next = mdd_object_child(obj);
551 LASSERT(mdd_object_exists(obj));
552 return next->do_ops->do_ref_del(env, next, handle);
556 int mdo_create_obj(const struct lu_env *env, struct mdd_object *o,
557 struct lu_attr *attr,
558 struct dt_allocation_hint *hint,
559 struct thandle *handle)
561 struct dt_object *next = mdd_object_child(o);
562 return next->do_ops->do_create(env, next, attr, hint, handle);
565 static inline struct obd_capa *mdo_capa_get(const struct lu_env *env,
566 struct mdd_object *obj,
567 struct lustre_capa *old,
570 struct dt_object *next = mdd_object_child(obj);
571 LASSERT(mdd_object_exists(obj));
572 return next->do_ops->do_capa_get(env, next, old, opc);