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 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/mdd/mdd_internal.h
38 * Author: Wang Di <wangdi@clusterfs.com>
41 #ifndef _MDD_INTERNAL_H
42 #define _MDD_INTERNAL_H
44 #include <asm/semaphore.h>
46 #include <lustre_acl.h>
47 #include <lustre_eacl.h>
49 #include <md_object.h>
50 #include <dt_object.h>
51 #include <linux/sched.h>
52 #include <linux/capability.h>
53 #include <linux/dynlocks.h>
56 MDD_TXN_OBJECT_DESTROY_OP = 0,
57 MDD_TXN_OBJECT_CREATE_OP,
60 MDD_TXN_INDEX_INSERT_OP,
61 MDD_TXN_INDEX_DELETE_OP,
65 MDD_TXN_RENAME_TGT_OP,
66 MDD_TXN_CREATE_DATA_OP,
71 struct mdd_txn_op_descr {
72 enum mdd_txn_op mod_op;
73 unsigned int mod_credits;
77 struct md_device mdd_md_dev;
78 struct dt_device *mdd_child;
79 struct obd_device *mdd_obd_dev;
80 struct lu_fid mdd_root_fid;
81 struct dt_device_param mdd_dt_conf;
82 struct dt_object *mdd_orphans;
83 struct dt_txn_callback mdd_txn_cb;
84 cfs_proc_dir_entry_t *mdd_proc_entry;
85 struct lprocfs_stats *mdd_stats;
86 struct mdd_txn_op_descr mdd_tod[MDD_TXN_LAST_OP];
87 unsigned long mdd_atime_diff;
91 /* The dir object has been unlinked */
99 #define LUSTRE_APPEND_FL LDISKFS_APPEND_FL
100 #define LUSTRE_IMMUTABLE_FL LDISKFS_IMMUTABLE_FL
101 #define LUSTRE_DIRSYNC_FL LDISKFS_DIRSYNC_FL
103 enum mdd_object_role {
111 struct md_object mod_obj;
115 unsigned long mod_flags;
116 struct dynlock mod_pdlock;
117 #ifdef CONFIG_LOCKDEP
118 /* "dep_map" name is assumed by lockdep.h macros. */
119 struct lockdep_map dep_map;
124 /* fid of the object*/
125 struct lu_fid ok_fid;
126 /* type of operation: unlink, truncate */
128 } __attribute__((packed));
130 struct mdd_thread_info {
131 struct txn_param mti_param;
132 struct lu_fid mti_fid;
133 struct lu_attr mti_la;
134 struct md_attr mti_ma;
135 struct lu_attr mti_la_for_fix;
136 struct obd_info mti_oi;
137 struct orph_key mti_orph_key;
138 struct obd_trans_info mti_oti;
139 struct lu_buf mti_buf;
141 char mti_xattr_buf[LUSTRE_POSIX_ACL_MAX_SIZE];
142 struct lu_fid mti_fid2; /* used for be & cpu converting */
143 struct lu_fid_pack mti_pack;
144 struct dt_allocation_hint mti_hint;
145 struct lov_mds_md *mti_max_lmm;
146 int mti_max_lmm_size;
147 struct llog_cookie *mti_max_cookie;
148 int mti_max_cookie_size;
151 struct lov_mds_md *mdd_max_lmm_get(const struct lu_env *env,
152 struct mdd_device *mdd);
154 struct llog_cookie *mdd_max_cookie_get(const struct lu_env *env,
155 struct mdd_device *mdd);
157 int mdd_init_obd(const struct lu_env *env, struct mdd_device *mdd,
158 struct lustre_cfg *cfg);
159 int mdd_fini_obd(const struct lu_env *env, struct mdd_device *mdd,
160 struct lustre_cfg *lcfg);
161 int mdd_xattr_set_txn(const struct lu_env *env, struct mdd_object *obj,
162 const struct lu_buf *buf, const char *name, int fl,
163 struct thandle *txn);
164 int mdd_lsm_sanity_check(const struct lu_env *env, struct mdd_object *obj);
165 int mdd_lov_set_md(const struct lu_env *env, struct mdd_object *pobj,
166 struct mdd_object *child, struct lov_mds_md *lmm,
167 int lmm_size, struct thandle *handle, int set_stripe);
168 int mdd_lov_create(const struct lu_env *env, struct mdd_device *mdd,
169 struct mdd_object *parent, struct mdd_object *child,
170 struct lov_mds_md **lmm, int *lmm_size,
171 const struct md_op_spec *spec, struct lu_attr *la);
172 void mdd_lov_objid_update(struct mdd_device *mdd, struct lov_mds_md *lmm);
173 void mdd_lov_create_finish(const struct lu_env *env, struct mdd_device *mdd,
174 struct lov_mds_md *lmm, int lmm_size,
175 const struct md_op_spec *spec);
176 int mdd_get_md(const struct lu_env *env, struct mdd_object *obj,
177 void *md, int *md_size, const char *name);
178 int mdd_get_md_locked(const struct lu_env *env, struct mdd_object *obj,
179 void *md, int *md_size, const char *name);
180 int mdd_la_get(const struct lu_env *env, struct mdd_object *obj,
181 struct lu_attr *la, struct lustre_capa *capa);
182 int mdd_attr_set_internal(const struct lu_env *env,
183 struct mdd_object *obj,
184 struct lu_attr *attr,
185 struct thandle *handle,
187 int mdd_attr_check_set_internal(const struct lu_env *env,
188 struct mdd_object *obj,
189 struct lu_attr *attr,
190 struct thandle *handle,
192 int mdd_object_kill(const struct lu_env *env, struct mdd_object *obj,
194 int mdd_iattr_get(const struct lu_env *env, struct mdd_object *mdd_obj,
196 int mdd_attr_get_internal_locked(const struct lu_env *env,
197 struct mdd_object *mdd_obj,
199 int mdd_object_create_internal(const struct lu_env *env, struct mdd_object *p,
200 struct mdd_object *c, struct md_attr *ma,
201 struct thandle *handle);
202 int mdd_attr_check_set_internal_locked(const struct lu_env *env,
203 struct mdd_object *obj,
204 struct lu_attr *attr,
205 struct thandle *handle,
207 int mdd_lmm_get_locked(const struct lu_env *env, struct mdd_object *mdd_obj,
210 void mdd_write_lock(const struct lu_env *env, struct mdd_object *obj,
211 enum mdd_object_role role);
212 void mdd_read_lock(const struct lu_env *env, struct mdd_object *obj,
213 enum mdd_object_role role);
214 void mdd_write_unlock(const struct lu_env *env, struct mdd_object *obj);
215 void mdd_read_unlock(const struct lu_env *env, struct mdd_object *obj);
217 void mdd_pdlock_init(struct mdd_object *obj);
218 unsigned long mdd_name2hash(const char *name);
219 struct dynlock_handle *mdd_pdo_write_lock(const struct lu_env *env,
220 struct mdd_object *obj,
222 enum mdd_object_role role);
223 struct dynlock_handle *mdd_pdo_read_lock(const struct lu_env *env,
224 struct mdd_object *obj,
226 enum mdd_object_role role);
227 void mdd_pdo_write_unlock(const struct lu_env *env, struct mdd_object *obj,
228 struct dynlock_handle *dlh);
229 void mdd_pdo_read_unlock(const struct lu_env *env, struct mdd_object *obj,
230 struct dynlock_handle *dlh);
232 void __mdd_ref_add(const struct lu_env *env, struct mdd_object *obj,
233 struct thandle *handle);
234 void __mdd_ref_del(const struct lu_env *env, struct mdd_object *obj,
235 struct thandle *handle, int is_dot);
236 int mdd_may_create(const struct lu_env *env, struct mdd_object *pobj,
237 struct mdd_object *cobj, int check_perm, int check_nlink);
238 int mdd_may_unlink(const struct lu_env *env, struct mdd_object *pobj,
239 const struct md_attr *ma);
240 int mdd_may_delete(const struct lu_env *env, struct mdd_object *pobj,
241 struct mdd_object *cobj, struct md_attr *ma,
242 int check_perm, int check_empty);
243 int mdd_unlink_sanity_check(const struct lu_env *env, struct mdd_object *pobj,
244 struct mdd_object *cobj, struct md_attr *ma);
245 int mdd_finish_unlink(const struct lu_env *env, struct mdd_object *obj,
246 struct md_attr *ma, struct thandle *th);
247 int mdd_object_initialize(const struct lu_env *env, const struct lu_fid *pfid,
248 struct mdd_object *child, struct md_attr *ma,
249 struct thandle *handle);
250 int mdd_link_sanity_check(const struct lu_env *env, struct mdd_object *tgt_obj,
251 const struct lu_name *lname, struct mdd_object *src_obj);
253 int mdd_unlink_log(const struct lu_env *env, struct mdd_device *mdd,
254 struct mdd_object *mdd_cobj, struct md_attr *ma);
256 int mdd_setattr_log(const struct lu_env *env, struct mdd_device *mdd,
257 const struct md_attr *ma,
258 struct lov_mds_md *lmm, int lmm_size,
259 struct llog_cookie *logcookies, int cookies_size);
261 int mdd_get_cookie_size(const struct lu_env *env, struct mdd_device *mdd,
262 struct lov_mds_md *lmm);
264 int mdd_lov_setattr_async(const struct lu_env *env, struct mdd_object *obj,
265 struct lov_mds_md *lmm, int lmm_size,
266 struct llog_cookie *logcookies);
268 struct mdd_thread_info *mdd_env_info(const struct lu_env *env);
270 struct lu_buf *mdd_buf_get(const struct lu_env *env, void *area, ssize_t len);
271 const struct lu_buf *mdd_buf_get_const(const struct lu_env *env,
272 const void *area, ssize_t len);
274 int __mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d);
275 int __mdd_orphan_add(const struct lu_env *, struct mdd_object *,
277 int __mdd_orphan_del(const struct lu_env *, struct mdd_object *,
279 int orph_index_init(const struct lu_env *env, struct mdd_device *mdd);
280 void orph_index_fini(const struct lu_env *env, struct mdd_device *mdd);
281 int mdd_txn_init_credits(const struct lu_env *env, struct mdd_device *mdd);
284 void lprocfs_mdd_init_vars(struct lprocfs_static_vars *lvars);
285 int mdd_procfs_init(struct mdd_device *mdd, const char *name);
286 int mdd_procfs_fini(struct mdd_device *mdd);
287 void mdd_lprocfs_time_start(const struct lu_env *env);
288 void mdd_lprocfs_time_end(const struct lu_env *env,
289 struct mdd_device *mdd, int op);
291 int mdd_get_flags(const struct lu_env *env, struct mdd_object *obj);
293 extern const struct md_dir_operations mdd_dir_ops;
294 extern const struct md_object_operations mdd_obj_ops;
297 void mdd_txn_param_build(const struct lu_env *env, struct mdd_device *mdd,
299 int mdd_log_txn_param_build(const struct lu_env *env, struct md_object *obj,
300 struct md_attr *ma, enum mdd_txn_op);
302 static inline void mdd_object_put(const struct lu_env *env,
303 struct mdd_object *o)
305 lu_object_put(env, &o->mod_obj.mo_lu);
308 struct thandle* mdd_trans_start(const struct lu_env *env,
309 struct mdd_device *);
311 void mdd_trans_stop(const struct lu_env *env, struct mdd_device *mdd,
312 int rc, struct thandle *handle);
314 int mdd_txn_start_cb(const struct lu_env *env, struct txn_param *param,
317 int mdd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
320 int mdd_txn_commit_cb(const struct lu_env *env, struct thandle *txn,
323 struct lu_object *mdd_object_alloc(const struct lu_env *env,
324 const struct lu_object_header *hdr,
325 struct lu_device *d);
328 int accmode(const struct lu_env *env, struct lu_attr *la, int flags);
329 extern struct lu_context_key mdd_thread_key;
330 extern const struct lu_device_operations mdd_lu_ops;
332 struct mdd_object *mdd_object_find(const struct lu_env *env,
333 struct mdd_device *d,
334 const struct lu_fid *f);
336 /* mdd_permission.c */
337 #define mdd_cap_t(x) (x)
339 #define MDD_CAP_TO_MASK(x) (1 << (x))
341 #define mdd_cap_raised(c, flag) (mdd_cap_t(c) & MDD_CAP_TO_MASK(flag))
343 /* capable() is copied from linux kernel! */
344 static inline int mdd_capable(struct md_ucred *uc, cfs_cap_t cap)
346 if (mdd_cap_raised(uc->mu_cap, cap))
351 int mdd_def_acl_get(const struct lu_env *env, struct mdd_object *mdd_obj,
353 int mdd_acl_chmod(const struct lu_env *env, struct mdd_object *o, __u32 mode,
354 struct thandle *handle);
355 int __mdd_acl_init(const struct lu_env *env, struct mdd_object *obj,
356 struct lu_buf *buf, __u32 *mode, struct thandle *handle);
357 int __mdd_permission_internal(const struct lu_env *env, struct mdd_object *obj,
358 struct lu_attr *la, int mask, int role);
359 int mdd_permission(const struct lu_env *env,
360 struct md_object *pobj, struct md_object *cobj,
361 struct md_attr *ma, int mask);
362 int mdd_capa_get(const struct lu_env *env, struct md_object *obj,
363 struct lustre_capa *capa, int renewal);
365 static inline int lu_device_is_mdd(struct lu_device *d)
367 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdd_lu_ops);
370 static inline struct mdd_device* lu2mdd_dev(struct lu_device *d)
372 LASSERT(lu_device_is_mdd(d));
373 return container_of0(d, struct mdd_device, mdd_md_dev.md_lu_dev);
376 static inline struct lu_device *mdd2lu_dev(struct mdd_device *d)
378 return (&d->mdd_md_dev.md_lu_dev);
381 static inline struct mdd_object *lu2mdd_obj(struct lu_object *o)
383 LASSERT(ergo(o != NULL, lu_device_is_mdd(o->lo_dev)));
384 return container_of0(o, struct mdd_object, mod_obj.mo_lu);
387 static inline struct mdd_device* mdo2mdd(struct md_object *mdo)
389 return lu2mdd_dev(mdo->mo_lu.lo_dev);
392 static inline struct mdd_object* md2mdd_obj(struct md_object *mdo)
394 return container_of0(mdo, struct mdd_object, mod_obj);
397 static inline const struct dt_device_operations *
398 mdd_child_ops(struct mdd_device *d)
400 return d->mdd_child->dd_ops;
403 static inline struct lu_object *mdd2lu_obj(struct mdd_object *obj)
405 return &obj->mod_obj.mo_lu;
408 static inline struct dt_object* mdd_object_child(struct mdd_object *o)
410 return container_of0(lu_object_next(mdd2lu_obj(o)),
411 struct dt_object, do_lu);
414 static inline struct obd_device *mdd2obd_dev(struct mdd_device *mdd)
416 return mdd->mdd_obd_dev;
419 static inline struct mdd_device *mdd_obj2mdd_dev(struct mdd_object *obj)
421 return mdo2mdd(&obj->mod_obj);
424 static inline const struct lu_fid *mdo2fid(const struct mdd_object *obj)
426 return lu_object_fid(&obj->mod_obj.mo_lu);
429 static inline umode_t mdd_object_type(const struct mdd_object *obj)
431 return lu_object_attr(&obj->mod_obj.mo_lu);
434 static inline int mdd_lov_mdsize(const struct lu_env *env,
435 struct mdd_device *mdd)
437 struct obd_device *obd = mdd2obd_dev(mdd);
438 return obd->u.mds.mds_max_mdsize;
441 static inline int mdd_lov_cookiesize(const struct lu_env *env,
442 struct mdd_device *mdd)
444 struct obd_device *obd = mdd2obd_dev(mdd);
445 return obd->u.mds.mds_max_cookiesize;
448 static inline int mdd_is_immutable(struct mdd_object *obj)
450 return obj->mod_flags & IMMUTE_OBJ;
453 static inline int mdd_is_dead_obj(struct mdd_object *obj)
455 return obj && obj->mod_flags & DEAD_OBJ;
458 static inline int mdd_is_append(struct mdd_object *obj)
460 return obj->mod_flags & APPEND_OBJ;
463 static inline int mdd_is_mnlink(struct mdd_object *obj)
465 return obj->mod_flags & MNLINK_OBJ;
468 static inline int mdd_object_exists(struct mdd_object *obj)
470 return lu_object_exists(mdd2lu_obj(obj));
473 static inline const struct lu_fid *mdd_object_fid(struct mdd_object *obj)
475 return lu_object_fid(mdd2lu_obj(obj));
478 static inline struct lustre_capa *mdd_object_capa(const struct lu_env *env,
479 const struct mdd_object *obj)
481 struct md_capainfo *ci = md_capainfo(env);
482 const struct lu_fid *fid = mdo2fid(obj);
485 /* NB: in mdt_init0 */
488 for (i = 0; i < MD_CAPAINFO_MAX; i++)
489 if (ci->mc_fid[i] && lu_fid_eq(ci->mc_fid[i], fid))
490 return ci->mc_capa[i];
494 static inline void mdd_set_capainfo(const struct lu_env *env, int offset,
495 const struct mdd_object *obj,
496 struct lustre_capa *capa)
498 struct md_capainfo *ci = md_capainfo(env);
499 const struct lu_fid *fid = mdo2fid(obj);
501 LASSERT(offset >= 0 && offset <= MD_CAPAINFO_MAX);
502 /* NB: in mdt_init0 */
505 ci->mc_fid[offset] = fid;
506 ci->mc_capa[offset] = capa;
509 #define MAX_ATIME_DIFF 60
515 static inline int mdd_permission_internal(const struct lu_env *env,
516 struct mdd_object *obj,
517 struct lu_attr *la, int mask)
519 return __mdd_permission_internal(env, obj, la, mask, -1);
522 static inline int mdd_permission_internal_locked(const struct lu_env *env,
523 struct mdd_object *obj,
524 struct lu_attr *la, int mask,
525 enum mdd_object_role role)
527 return __mdd_permission_internal(env, obj, la, mask, role);
530 /* mdd inline func for calling osd_dt_object ops */
531 static inline int mdo_attr_get(const struct lu_env *env, struct mdd_object *obj,
532 struct lu_attr *la, struct lustre_capa *capa)
534 struct dt_object *next = mdd_object_child(obj);
535 return next->do_ops->do_attr_get(env, next, la, capa);
538 static inline int mdo_attr_set(const struct lu_env *env, struct mdd_object *obj,
539 const struct lu_attr *la, struct thandle *handle,
540 struct lustre_capa *capa)
542 struct dt_object *next = mdd_object_child(obj);
543 LASSERT(mdd_object_exists(obj));
544 return next->do_ops->do_attr_set(env, next, la, handle, capa);
547 static inline int mdo_xattr_get(const struct lu_env *env,struct mdd_object *obj,
548 struct lu_buf *buf, const char *name,
549 struct lustre_capa *capa)
551 struct dt_object *next = mdd_object_child(obj);
552 return next->do_ops->do_xattr_get(env, next, buf, name, capa);
555 static inline int mdo_xattr_set(const struct lu_env *env,struct mdd_object *obj,
556 const struct lu_buf *buf, const char *name,
557 int fl, struct thandle *handle,
558 struct lustre_capa *capa)
560 struct dt_object *next = mdd_object_child(obj);
561 LASSERT(mdd_object_exists(obj));
562 return next->do_ops->do_xattr_set(env, next, buf, name, fl, handle,
566 static inline int mdo_xattr_del(const struct lu_env *env,struct mdd_object *obj,
567 const char *name, struct thandle *handle,
568 struct lustre_capa *capa)
570 struct dt_object *next = mdd_object_child(obj);
571 LASSERT(mdd_object_exists(obj));
572 return next->do_ops->do_xattr_del(env, next, name, handle, capa);
576 int mdo_xattr_list(const struct lu_env *env, struct mdd_object *obj,
577 struct lu_buf *buf, struct lustre_capa *capa)
579 struct dt_object *next = mdd_object_child(obj);
580 LASSERT(mdd_object_exists(obj));
581 return next->do_ops->do_xattr_list(env, next, buf, capa);
585 int mdo_index_try(const struct lu_env *env, struct mdd_object *obj,
586 const struct dt_index_features *feat)
588 struct dt_object *next = mdd_object_child(obj);
589 return next->do_ops->do_index_try(env, next, feat);
592 static inline void mdo_ref_add(const struct lu_env *env, struct mdd_object *obj,
593 struct thandle *handle)
595 struct dt_object *next = mdd_object_child(obj);
596 LASSERT(mdd_object_exists(obj));
597 return next->do_ops->do_ref_add(env, next, handle);
600 static inline void mdo_ref_del(const struct lu_env *env, struct mdd_object *obj,
601 struct thandle *handle)
603 struct dt_object *next = mdd_object_child(obj);
604 LASSERT(mdd_object_exists(obj));
605 return next->do_ops->do_ref_del(env, next, handle);
609 int mdo_create_obj(const struct lu_env *env, struct mdd_object *o,
610 struct lu_attr *attr,
611 struct dt_allocation_hint *hint,
612 struct thandle *handle)
614 struct dt_object *next = mdd_object_child(o);
615 return next->do_ops->do_create(env, next, attr, hint, handle);
618 static inline struct obd_capa *mdo_capa_get(const struct lu_env *env,
619 struct mdd_object *obj,
620 struct lustre_capa *old,
623 struct dt_object *next = mdd_object_child(obj);
624 LASSERT(mdd_object_exists(obj));
625 return next->do_ops->do_capa_get(env, next, old, opc);