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 struct lockdep_map mod_dep_map_pdlock;
123 /* fid of the object*/
124 struct lu_fid ok_fid;
125 /* type of operation: unlink, truncate */
127 } __attribute__((packed));
129 struct mdd_thread_info {
130 struct txn_param mti_param;
131 struct lu_fid mti_fid;
132 struct lu_attr mti_la;
133 struct md_attr mti_ma;
134 struct lu_attr mti_la_for_fix;
135 struct obd_info mti_oi;
136 struct orph_key mti_orph_key;
137 struct obd_trans_info mti_oti;
138 struct lu_buf mti_buf;
140 char mti_xattr_buf[LUSTRE_POSIX_ACL_MAX_SIZE];
141 struct lu_fid mti_fid2; /* used for be & cpu converting */
142 struct lu_fid_pack mti_pack;
143 struct dt_allocation_hint mti_hint;
144 struct lov_mds_md *mti_max_lmm;
145 int mti_max_lmm_size;
146 struct llog_cookie *mti_max_cookie;
147 int mti_max_cookie_size;
150 struct lov_mds_md *mdd_max_lmm_get(const struct lu_env *env,
151 struct mdd_device *mdd);
153 struct llog_cookie *mdd_max_cookie_get(const struct lu_env *env,
154 struct mdd_device *mdd);
156 int mdd_init_obd(const struct lu_env *env, struct mdd_device *mdd,
157 struct lustre_cfg *cfg);
158 int mdd_fini_obd(const struct lu_env *env, struct mdd_device *mdd,
159 struct lustre_cfg *lcfg);
160 int mdd_xattr_set_txn(const struct lu_env *env, struct mdd_object *obj,
161 const struct lu_buf *buf, const char *name, int fl,
162 struct thandle *txn);
163 int mdd_lsm_sanity_check(const struct lu_env *env, struct mdd_object *obj);
164 int mdd_lov_set_md(const struct lu_env *env, struct mdd_object *pobj,
165 struct mdd_object *child, struct lov_mds_md *lmm,
166 int lmm_size, struct thandle *handle, int set_stripe);
167 int mdd_lov_create(const struct lu_env *env, struct mdd_device *mdd,
168 struct mdd_object *parent, struct mdd_object *child,
169 struct lov_mds_md **lmm, int *lmm_size,
170 const struct md_op_spec *spec, struct lu_attr *la);
171 void mdd_lov_objid_update(struct mdd_device *mdd, struct lov_mds_md *lmm);
172 void mdd_lov_create_finish(const struct lu_env *env, struct mdd_device *mdd,
173 struct lov_mds_md *lmm, int lmm_size,
174 const struct md_op_spec *spec);
175 int mdd_get_md(const struct lu_env *env, struct mdd_object *obj,
176 void *md, int *md_size, const char *name);
177 int mdd_get_md_locked(const struct lu_env *env, struct mdd_object *obj,
178 void *md, int *md_size, const char *name);
179 int mdd_la_get(const struct lu_env *env, struct mdd_object *obj,
180 struct lu_attr *la, struct lustre_capa *capa);
181 int mdd_attr_set_internal(const struct lu_env *env,
182 struct mdd_object *obj,
183 struct lu_attr *attr,
184 struct thandle *handle,
186 int mdd_attr_check_set_internal(const struct lu_env *env,
187 struct mdd_object *obj,
188 struct lu_attr *attr,
189 struct thandle *handle,
191 int mdd_object_kill(const struct lu_env *env, struct mdd_object *obj,
193 int mdd_iattr_get(const struct lu_env *env, struct mdd_object *mdd_obj,
195 int mdd_attr_get_internal_locked(const struct lu_env *env,
196 struct mdd_object *mdd_obj,
198 int mdd_object_create_internal(const struct lu_env *env, struct mdd_object *p,
199 struct mdd_object *c, struct md_attr *ma,
200 struct thandle *handle);
201 int mdd_attr_check_set_internal_locked(const struct lu_env *env,
202 struct mdd_object *obj,
203 struct lu_attr *attr,
204 struct thandle *handle,
206 int mdd_lmm_get_locked(const struct lu_env *env, struct mdd_object *mdd_obj,
209 void mdd_write_lock(const struct lu_env *env, struct mdd_object *obj,
210 enum mdd_object_role role);
211 void mdd_read_lock(const struct lu_env *env, struct mdd_object *obj,
212 enum mdd_object_role role);
213 void mdd_write_unlock(const struct lu_env *env, struct mdd_object *obj);
214 void mdd_read_unlock(const struct lu_env *env, struct mdd_object *obj);
216 void mdd_pdlock_init(struct mdd_object *obj);
217 unsigned long mdd_name2hash(const char *name);
218 struct dynlock_handle *mdd_pdo_write_lock(const struct lu_env *env,
219 struct mdd_object *obj,
221 enum mdd_object_role role);
222 struct dynlock_handle *mdd_pdo_read_lock(const struct lu_env *env,
223 struct mdd_object *obj,
225 enum mdd_object_role role);
226 void mdd_pdo_write_unlock(const struct lu_env *env, struct mdd_object *obj,
227 struct dynlock_handle *dlh);
228 void mdd_pdo_read_unlock(const struct lu_env *env, struct mdd_object *obj,
229 struct dynlock_handle *dlh);
231 void __mdd_ref_add(const struct lu_env *env, struct mdd_object *obj,
232 struct thandle *handle);
233 void __mdd_ref_del(const struct lu_env *env, struct mdd_object *obj,
234 struct thandle *handle, int is_dot);
235 int mdd_may_create(const struct lu_env *env, struct mdd_object *pobj,
236 struct mdd_object *cobj, int check_perm, int check_nlink);
237 int mdd_may_unlink(const struct lu_env *env, struct mdd_object *pobj,
238 const struct md_attr *ma);
239 int mdd_may_delete(const struct lu_env *env, struct mdd_object *pobj,
240 struct mdd_object *cobj, struct md_attr *ma,
241 int check_perm, int check_empty);
242 int mdd_unlink_sanity_check(const struct lu_env *env, struct mdd_object *pobj,
243 struct mdd_object *cobj, struct md_attr *ma);
244 int mdd_finish_unlink(const struct lu_env *env, struct mdd_object *obj,
245 struct md_attr *ma, struct thandle *th);
246 int mdd_object_initialize(const struct lu_env *env, const struct lu_fid *pfid,
247 struct mdd_object *child, struct md_attr *ma,
248 struct thandle *handle);
249 int mdd_link_sanity_check(const struct lu_env *env, struct mdd_object *tgt_obj,
250 const struct lu_name *lname, struct mdd_object *src_obj);
252 int mdd_unlink_log(const struct lu_env *env, struct mdd_device *mdd,
253 struct mdd_object *mdd_cobj, struct md_attr *ma);
255 int mdd_setattr_log(const struct lu_env *env, struct mdd_device *mdd,
256 const struct md_attr *ma,
257 struct lov_mds_md *lmm, int lmm_size,
258 struct llog_cookie *logcookies, int cookies_size);
260 int mdd_get_cookie_size(const struct lu_env *env, struct mdd_device *mdd,
261 struct lov_mds_md *lmm);
263 int mdd_lov_setattr_async(const struct lu_env *env, struct mdd_object *obj,
264 struct lov_mds_md *lmm, int lmm_size,
265 struct llog_cookie *logcookies);
267 struct mdd_thread_info *mdd_env_info(const struct lu_env *env);
269 struct lu_buf *mdd_buf_get(const struct lu_env *env, void *area, ssize_t len);
270 const struct lu_buf *mdd_buf_get_const(const struct lu_env *env,
271 const void *area, ssize_t len);
273 int __mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d);
274 int __mdd_orphan_add(const struct lu_env *, struct mdd_object *,
276 int __mdd_orphan_del(const struct lu_env *, struct mdd_object *,
278 int orph_index_init(const struct lu_env *env, struct mdd_device *mdd);
279 void orph_index_fini(const struct lu_env *env, struct mdd_device *mdd);
280 int mdd_txn_init_credits(const struct lu_env *env, struct mdd_device *mdd);
283 void lprocfs_mdd_init_vars(struct lprocfs_static_vars *lvars);
284 int mdd_procfs_init(struct mdd_device *mdd, const char *name);
285 int mdd_procfs_fini(struct mdd_device *mdd);
286 void mdd_lprocfs_time_start(const struct lu_env *env);
287 void mdd_lprocfs_time_end(const struct lu_env *env,
288 struct mdd_device *mdd, int op);
290 int mdd_get_flags(const struct lu_env *env, struct mdd_object *obj);
292 extern struct md_dir_operations mdd_dir_ops;
293 extern struct md_object_operations mdd_obj_ops;
296 void mdd_txn_param_build(const struct lu_env *env, struct mdd_device *mdd,
298 int mdd_log_txn_param_build(const struct lu_env *env, struct md_object *obj,
299 struct md_attr *ma, enum mdd_txn_op);
301 static inline void mdd_object_put(const struct lu_env *env,
302 struct mdd_object *o)
304 lu_object_put(env, &o->mod_obj.mo_lu);
307 struct thandle* mdd_trans_start(const struct lu_env *env,
308 struct mdd_device *);
310 void mdd_trans_stop(const struct lu_env *env, struct mdd_device *mdd,
311 int rc, struct thandle *handle);
313 int mdd_txn_start_cb(const struct lu_env *env, struct txn_param *param,
316 int mdd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
319 int mdd_txn_commit_cb(const struct lu_env *env, struct thandle *txn,
322 struct lu_object *mdd_object_alloc(const struct lu_env *env,
323 const struct lu_object_header *hdr,
324 struct lu_device *d);
327 int accmode(const struct lu_env *env, struct lu_attr *la, int flags);
328 extern struct lu_context_key mdd_thread_key;
329 extern struct lu_device_operations mdd_lu_ops;
331 struct mdd_object *mdd_object_find(const struct lu_env *env,
332 struct mdd_device *d,
333 const struct lu_fid *f);
335 /* mdd_permission.c */
336 #define mdd_cap_t(x) (x)
338 #define MDD_CAP_TO_MASK(x) (1 << (x))
340 #define mdd_cap_raised(c, flag) (mdd_cap_t(c) & MDD_CAP_TO_MASK(flag))
342 /* capable() is copied from linux kernel! */
343 static inline int mdd_capable(struct md_ucred *uc, cfs_cap_t cap)
345 if (mdd_cap_raised(uc->mu_cap, cap))
350 int mdd_def_acl_get(const struct lu_env *env, struct mdd_object *mdd_obj,
352 int mdd_acl_chmod(const struct lu_env *env, struct mdd_object *o, __u32 mode,
353 struct thandle *handle);
354 int __mdd_acl_init(const struct lu_env *env, struct mdd_object *obj,
355 struct lu_buf *buf, __u32 *mode, struct thandle *handle);
356 int __mdd_permission_internal(const struct lu_env *env, struct mdd_object *obj,
357 struct lu_attr *la, int mask, int role);
358 int mdd_permission(const struct lu_env *env,
359 struct md_object *pobj, struct md_object *cobj,
360 struct md_attr *ma, int mask);
361 int mdd_capa_get(const struct lu_env *env, struct md_object *obj,
362 struct lustre_capa *capa, int renewal);
364 static inline int lu_device_is_mdd(struct lu_device *d)
366 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdd_lu_ops);
369 static inline struct mdd_device* lu2mdd_dev(struct lu_device *d)
371 LASSERT(lu_device_is_mdd(d));
372 return container_of0(d, struct mdd_device, mdd_md_dev.md_lu_dev);
375 static inline struct lu_device *mdd2lu_dev(struct mdd_device *d)
377 return (&d->mdd_md_dev.md_lu_dev);
380 static inline struct mdd_object *lu2mdd_obj(struct lu_object *o)
382 LASSERT(ergo(o != NULL, lu_device_is_mdd(o->lo_dev)));
383 return container_of0(o, struct mdd_object, mod_obj.mo_lu);
386 static inline struct mdd_device* mdo2mdd(struct md_object *mdo)
388 return lu2mdd_dev(mdo->mo_lu.lo_dev);
391 static inline struct mdd_object* md2mdd_obj(struct md_object *mdo)
393 return container_of0(mdo, struct mdd_object, mod_obj);
396 static inline struct dt_device_operations *mdd_child_ops(struct mdd_device *d)
398 return d->mdd_child->dd_ops;
401 static inline struct lu_object *mdd2lu_obj(struct mdd_object *obj)
403 return &obj->mod_obj.mo_lu;
406 static inline struct dt_object* mdd_object_child(struct mdd_object *o)
408 return container_of0(lu_object_next(mdd2lu_obj(o)),
409 struct dt_object, do_lu);
412 static inline struct obd_device *mdd2obd_dev(struct mdd_device *mdd)
414 return mdd->mdd_obd_dev;
417 static inline struct mdd_device *mdd_obj2mdd_dev(struct mdd_object *obj)
419 return mdo2mdd(&obj->mod_obj);
422 static inline const struct lu_fid *mdo2fid(const struct mdd_object *obj)
424 return lu_object_fid(&obj->mod_obj.mo_lu);
427 static inline umode_t mdd_object_type(const struct mdd_object *obj)
429 return lu_object_attr(&obj->mod_obj.mo_lu);
432 static inline int mdd_lov_mdsize(const struct lu_env *env,
433 struct mdd_device *mdd)
435 struct obd_device *obd = mdd2obd_dev(mdd);
436 return obd->u.mds.mds_max_mdsize;
439 static inline int mdd_lov_cookiesize(const struct lu_env *env,
440 struct mdd_device *mdd)
442 struct obd_device *obd = mdd2obd_dev(mdd);
443 return obd->u.mds.mds_max_cookiesize;
446 static inline int mdd_is_immutable(struct mdd_object *obj)
448 return obj->mod_flags & IMMUTE_OBJ;
451 static inline int mdd_is_dead_obj(struct mdd_object *obj)
453 return obj && obj->mod_flags & DEAD_OBJ;
456 static inline int mdd_is_append(struct mdd_object *obj)
458 return obj->mod_flags & APPEND_OBJ;
461 static inline int mdd_is_mnlink(struct mdd_object *obj)
463 return obj->mod_flags & MNLINK_OBJ;
466 static inline int mdd_object_exists(struct mdd_object *obj)
468 return lu_object_exists(mdd2lu_obj(obj));
471 static inline const struct lu_fid *mdd_object_fid(struct mdd_object *obj)
473 return lu_object_fid(mdd2lu_obj(obj));
476 static inline struct lustre_capa *mdd_object_capa(const struct lu_env *env,
477 const struct mdd_object *obj)
479 struct md_capainfo *ci = md_capainfo(env);
480 const struct lu_fid *fid = mdo2fid(obj);
483 /* NB: in mdt_init0 */
486 for (i = 0; i < MD_CAPAINFO_MAX; i++)
487 if (ci->mc_fid[i] && lu_fid_eq(ci->mc_fid[i], fid))
488 return ci->mc_capa[i];
492 static inline void mdd_set_capainfo(const struct lu_env *env, int offset,
493 const struct mdd_object *obj,
494 struct lustre_capa *capa)
496 struct md_capainfo *ci = md_capainfo(env);
497 const struct lu_fid *fid = mdo2fid(obj);
499 LASSERT(offset >= 0 && offset <= MD_CAPAINFO_MAX);
500 /* NB: in mdt_init0 */
503 ci->mc_fid[offset] = fid;
504 ci->mc_capa[offset] = capa;
507 #define MAX_ATIME_DIFF 60
513 static inline int mdd_permission_internal(const struct lu_env *env,
514 struct mdd_object *obj,
515 struct lu_attr *la, int mask)
517 return __mdd_permission_internal(env, obj, la, mask, -1);
520 static inline int mdd_permission_internal_locked(const struct lu_env *env,
521 struct mdd_object *obj,
522 struct lu_attr *la, int mask,
523 enum mdd_object_role role)
525 return __mdd_permission_internal(env, obj, la, mask, role);
528 /* mdd inline func for calling osd_dt_object ops */
529 static inline int mdo_attr_get(const struct lu_env *env, struct mdd_object *obj,
530 struct lu_attr *la, struct lustre_capa *capa)
532 struct dt_object *next = mdd_object_child(obj);
533 return next->do_ops->do_attr_get(env, next, la, capa);
536 static inline int mdo_attr_set(const struct lu_env *env, struct mdd_object *obj,
537 const struct lu_attr *la, struct thandle *handle,
538 struct lustre_capa *capa)
540 struct dt_object *next = mdd_object_child(obj);
541 LASSERT(mdd_object_exists(obj));
542 return next->do_ops->do_attr_set(env, next, la, handle, capa);
545 static inline int mdo_xattr_get(const struct lu_env *env,struct mdd_object *obj,
546 struct lu_buf *buf, const char *name,
547 struct lustre_capa *capa)
549 struct dt_object *next = mdd_object_child(obj);
550 return next->do_ops->do_xattr_get(env, next, buf, name, capa);
553 static inline int mdo_xattr_set(const struct lu_env *env,struct mdd_object *obj,
554 const struct lu_buf *buf, const char *name,
555 int fl, struct thandle *handle,
556 struct lustre_capa *capa)
558 struct dt_object *next = mdd_object_child(obj);
559 LASSERT(mdd_object_exists(obj));
560 return next->do_ops->do_xattr_set(env, next, buf, name, fl, handle,
564 static inline int mdo_xattr_del(const struct lu_env *env,struct mdd_object *obj,
565 const char *name, struct thandle *handle,
566 struct lustre_capa *capa)
568 struct dt_object *next = mdd_object_child(obj);
569 LASSERT(mdd_object_exists(obj));
570 return next->do_ops->do_xattr_del(env, next, name, handle, capa);
574 int mdo_xattr_list(const struct lu_env *env, struct mdd_object *obj,
575 struct lu_buf *buf, struct lustre_capa *capa)
577 struct dt_object *next = mdd_object_child(obj);
578 LASSERT(mdd_object_exists(obj));
579 return next->do_ops->do_xattr_list(env, next, buf, capa);
583 int mdo_index_try(const struct lu_env *env, struct mdd_object *obj,
584 const struct dt_index_features *feat)
586 struct dt_object *next = mdd_object_child(obj);
587 return next->do_ops->do_index_try(env, next, feat);
590 static inline void mdo_ref_add(const struct lu_env *env, struct mdd_object *obj,
591 struct thandle *handle)
593 struct dt_object *next = mdd_object_child(obj);
594 LASSERT(mdd_object_exists(obj));
595 return next->do_ops->do_ref_add(env, next, handle);
598 static inline void mdo_ref_del(const struct lu_env *env, struct mdd_object *obj,
599 struct thandle *handle)
601 struct dt_object *next = mdd_object_child(obj);
602 LASSERT(mdd_object_exists(obj));
603 return next->do_ops->do_ref_del(env, next, handle);
607 int mdo_create_obj(const struct lu_env *env, struct mdd_object *o,
608 struct lu_attr *attr,
609 struct dt_allocation_hint *hint,
610 struct thandle *handle)
612 struct dt_object *next = mdd_object_child(o);
613 return next->do_ops->do_create(env, next, attr, hint, handle);
616 static inline struct obd_capa *mdo_capa_get(const struct lu_env *env,
617 struct mdd_object *obj,
618 struct lustre_capa *old,
621 struct dt_object *next = mdd_object_child(obj);
622 LASSERT(mdd_object_exists(obj));
623 return next->do_ops->do_capa_get(env, next, old, opc);