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 <linux/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
104 struct md_object mod_obj;
108 unsigned long mod_flags;
109 struct dynlock mod_pdlock;
113 /* fid of the object*/
114 struct lu_fid ok_fid;
115 /* type of operation: unlink, truncate */
117 } __attribute__((packed));
119 struct mdd_thread_info {
120 struct txn_param mti_param;
121 struct lu_fid mti_fid;
122 struct lu_attr mti_la;
123 struct md_attr mti_ma;
124 struct lu_attr mti_la_for_fix;
125 struct obd_info mti_oi;
126 struct orph_key mti_orph_key;
127 struct obd_trans_info mti_oti;
128 struct lu_buf mti_buf;
130 char mti_xattr_buf[LUSTRE_POSIX_ACL_MAX_SIZE];
131 struct lu_fid mti_fid2; /* used for be & cpu converting */
132 struct lu_fid_pack mti_pack;
133 struct dt_allocation_hint mti_hint;
134 struct lov_mds_md *mti_max_lmm;
135 int mti_max_lmm_size;
136 struct llog_cookie *mti_max_cookie;
137 int mti_max_cookie_size;
140 struct lov_mds_md *mdd_max_lmm_get(const struct lu_env *env,
141 struct mdd_device *mdd);
143 struct llog_cookie *mdd_max_cookie_get(const struct lu_env *env,
144 struct mdd_device *mdd);
146 int mdd_init_obd(const struct lu_env *env, struct mdd_device *mdd,
147 struct lustre_cfg *cfg);
148 int mdd_fini_obd(const struct lu_env *env, struct mdd_device *mdd,
149 struct lustre_cfg *lcfg);
150 int mdd_xattr_set_txn(const struct lu_env *env, struct mdd_object *obj,
151 const struct lu_buf *buf, const char *name, int fl,
152 struct thandle *txn);
153 int mdd_lsm_sanity_check(const struct lu_env *env, struct mdd_object *obj);
154 int mdd_lov_set_md(const struct lu_env *env, struct mdd_object *pobj,
155 struct mdd_object *child, struct lov_mds_md *lmm,
156 int lmm_size, struct thandle *handle, int set_stripe);
157 int mdd_lov_create(const struct lu_env *env, struct mdd_device *mdd,
158 struct mdd_object *parent, struct mdd_object *child,
159 struct lov_mds_md **lmm, int *lmm_size,
160 const struct md_op_spec *spec, struct lu_attr *la);
161 void mdd_lov_objid_update(struct mdd_device *mdd, struct lov_mds_md *lmm);
162 void mdd_lov_create_finish(const struct lu_env *env, struct mdd_device *mdd,
163 struct lov_mds_md *lmm, int lmm_size,
164 const struct md_op_spec *spec);
165 int mdd_get_md(const struct lu_env *env, struct mdd_object *obj,
166 void *md, int *md_size, const char *name);
167 int mdd_get_md_locked(const struct lu_env *env, struct mdd_object *obj,
168 void *md, int *md_size, const char *name);
169 int mdd_la_get(const struct lu_env *env, struct mdd_object *obj,
170 struct lu_attr *la, struct lustre_capa *capa);
171 int mdd_attr_set_internal(const struct lu_env *env,
172 struct mdd_object *obj,
173 struct lu_attr *attr,
174 struct thandle *handle,
176 int mdd_attr_check_set_internal(const struct lu_env *env,
177 struct mdd_object *obj,
178 struct lu_attr *attr,
179 struct thandle *handle,
181 int mdd_object_kill(const struct lu_env *env, struct mdd_object *obj,
183 int mdd_iattr_get(const struct lu_env *env, struct mdd_object *mdd_obj,
185 int mdd_attr_get_internal_locked(const struct lu_env *env,
186 struct mdd_object *mdd_obj,
188 int mdd_object_create_internal(const struct lu_env *env, struct mdd_object *p,
189 struct mdd_object *c, struct md_attr *ma,
190 struct thandle *handle);
191 int mdd_attr_check_set_internal_locked(const struct lu_env *env,
192 struct mdd_object *obj,
193 struct lu_attr *attr,
194 struct thandle *handle,
196 int mdd_lmm_get_locked(const struct lu_env *env, struct mdd_object *mdd_obj,
199 void mdd_write_lock(const struct lu_env *env, struct mdd_object *obj);
200 void mdd_read_lock(const struct lu_env *env, struct mdd_object *obj);
201 void mdd_write_unlock(const struct lu_env *env, struct mdd_object *obj);
202 void mdd_read_unlock(const struct lu_env *env, struct mdd_object *obj);
204 void mdd_pdlock_init(struct mdd_object *obj);
205 unsigned long mdd_name2hash(const char *name);
206 struct dynlock_handle *mdd_pdo_write_lock(const struct lu_env *env,
207 struct mdd_object *obj,
209 struct dynlock_handle *mdd_pdo_read_lock(const struct lu_env *env,
210 struct mdd_object *obj,
212 void mdd_pdo_write_unlock(const struct lu_env *env, struct mdd_object *obj,
213 struct dynlock_handle *dlh);
214 void mdd_pdo_read_unlock(const struct lu_env *env, struct mdd_object *obj,
215 struct dynlock_handle *dlh);
217 void __mdd_ref_add(const struct lu_env *env, struct mdd_object *obj,
218 struct thandle *handle);
219 void __mdd_ref_del(const struct lu_env *env, struct mdd_object *obj,
220 struct thandle *handle, int is_dot);
221 int mdd_may_create(const struct lu_env *env, struct mdd_object *pobj,
222 struct mdd_object *cobj, int check_perm, int check_nlink);
223 int mdd_may_unlink(const struct lu_env *env, struct mdd_object *pobj,
224 const struct md_attr *ma);
225 int mdd_may_delete(const struct lu_env *env, struct mdd_object *pobj,
226 struct mdd_object *cobj, struct md_attr *ma,
227 int check_perm, int check_empty);
228 int mdd_unlink_sanity_check(const struct lu_env *env, struct mdd_object *pobj,
229 struct mdd_object *cobj, struct md_attr *ma);
230 int mdd_finish_unlink(const struct lu_env *env, struct mdd_object *obj,
231 struct md_attr *ma, struct thandle *th);
232 int mdd_object_initialize(const struct lu_env *env, const struct lu_fid *pfid,
233 struct mdd_object *child, struct md_attr *ma,
234 struct thandle *handle);
235 int mdd_link_sanity_check(const struct lu_env *env, struct mdd_object *tgt_obj,
236 const struct lu_name *lname, struct mdd_object *src_obj);
238 int mdd_unlink_log(const struct lu_env *env, struct mdd_device *mdd,
239 struct mdd_object *mdd_cobj, struct md_attr *ma);
241 int mdd_setattr_log(const struct lu_env *env, struct mdd_device *mdd,
242 const struct md_attr *ma,
243 struct lov_mds_md *lmm, int lmm_size,
244 struct llog_cookie *logcookies, int cookies_size);
246 int mdd_get_cookie_size(const struct lu_env *env, struct mdd_device *mdd,
247 struct lov_mds_md *lmm);
249 int mdd_lov_setattr_async(const struct lu_env *env, struct mdd_object *obj,
250 struct lov_mds_md *lmm, int lmm_size,
251 struct llog_cookie *logcookies);
253 struct mdd_thread_info *mdd_env_info(const struct lu_env *env);
255 struct lu_buf *mdd_buf_get(const struct lu_env *env, void *area, ssize_t len);
256 const struct lu_buf *mdd_buf_get_const(const struct lu_env *env,
257 const void *area, ssize_t len);
259 int __mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d);
260 int __mdd_orphan_add(const struct lu_env *, struct mdd_object *,
262 int __mdd_orphan_del(const struct lu_env *, struct mdd_object *,
264 int orph_index_init(const struct lu_env *env, struct mdd_device *mdd);
265 void orph_index_fini(const struct lu_env *env, struct mdd_device *mdd);
266 int mdd_txn_init_credits(const struct lu_env *env, struct mdd_device *mdd);
269 void lprocfs_mdd_init_vars(struct lprocfs_static_vars *lvars);
270 int mdd_procfs_init(struct mdd_device *mdd, const char *name);
271 int mdd_procfs_fini(struct mdd_device *mdd);
272 void mdd_lprocfs_time_start(const struct lu_env *env);
273 void mdd_lprocfs_time_end(const struct lu_env *env,
274 struct mdd_device *mdd, int op);
276 int mdd_get_flags(const struct lu_env *env, struct mdd_object *obj);
278 extern struct md_dir_operations mdd_dir_ops;
279 extern struct md_object_operations mdd_obj_ops;
282 void mdd_txn_param_build(const struct lu_env *env, struct mdd_device *mdd,
284 int mdd_log_txn_param_build(const struct lu_env *env, struct md_object *obj,
285 struct md_attr *ma, enum mdd_txn_op);
287 static inline void mdd_object_put(const struct lu_env *env,
288 struct mdd_object *o)
290 lu_object_put(env, &o->mod_obj.mo_lu);
293 struct thandle* mdd_trans_start(const struct lu_env *env,
294 struct mdd_device *);
296 void mdd_trans_stop(const struct lu_env *env, struct mdd_device *mdd,
297 int rc, struct thandle *handle);
299 int mdd_txn_start_cb(const struct lu_env *env, struct txn_param *param,
302 int mdd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
305 int mdd_txn_commit_cb(const struct lu_env *env, struct thandle *txn,
308 struct lu_object *mdd_object_alloc(const struct lu_env *env,
309 const struct lu_object_header *hdr,
310 struct lu_device *d);
313 int accmode(const struct lu_env *env, struct lu_attr *la, int flags);
314 extern struct lu_context_key mdd_thread_key;
315 extern struct lu_device_operations mdd_lu_ops;
317 struct mdd_object *mdd_object_find(const struct lu_env *env,
318 struct mdd_device *d,
319 const struct lu_fid *f);
321 /* mdd_permission.c */
322 #define mdd_cap_t(x) (x)
324 #define MDD_CAP_TO_MASK(x) (1 << (x))
326 #define mdd_cap_raised(c, flag) (mdd_cap_t(c) & MDD_CAP_TO_MASK(flag))
328 /* capable() is copied from linux kernel! */
329 static inline int mdd_capable(struct md_ucred *uc, int cap)
331 if (mdd_cap_raised(uc->mu_cap, cap))
336 int mdd_acl_def_get(const struct lu_env *env, struct mdd_object *mdd_obj,
338 int mdd_acl_chmod(const struct lu_env *env, struct mdd_object *o, __u32 mode,
339 struct thandle *handle);
340 int __mdd_acl_init(const struct lu_env *env, struct mdd_object *obj,
341 struct lu_buf *buf, __u32 *mode, struct thandle *handle);
342 int mdd_acl_init(const struct lu_env *env, struct mdd_object *pobj,
343 struct mdd_object *cobj, __u32 *mode, struct thandle *handle);
344 int __mdd_permission_internal(const struct lu_env *env, struct mdd_object *obj,
345 struct lu_attr *la, int mask, int needlock);
346 int mdd_permission(const struct lu_env *env,
347 struct md_object *pobj, struct md_object *cobj,
348 struct md_attr *ma, int mask);
349 int mdd_capa_get(const struct lu_env *env, struct md_object *obj,
350 struct lustre_capa *capa, int renewal);
352 static inline int lu_device_is_mdd(struct lu_device *d)
354 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdd_lu_ops);
357 static inline struct mdd_device* lu2mdd_dev(struct lu_device *d)
359 LASSERT(lu_device_is_mdd(d));
360 return container_of0(d, struct mdd_device, mdd_md_dev.md_lu_dev);
363 static inline struct lu_device *mdd2lu_dev(struct mdd_device *d)
365 return (&d->mdd_md_dev.md_lu_dev);
368 static inline struct mdd_object *lu2mdd_obj(struct lu_object *o)
370 LASSERT(ergo(o != NULL, lu_device_is_mdd(o->lo_dev)));
371 return container_of0(o, struct mdd_object, mod_obj.mo_lu);
374 static inline struct mdd_device* mdo2mdd(struct md_object *mdo)
376 return lu2mdd_dev(mdo->mo_lu.lo_dev);
379 static inline struct mdd_object* md2mdd_obj(struct md_object *mdo)
381 return container_of0(mdo, struct mdd_object, mod_obj);
384 static inline struct dt_device_operations *mdd_child_ops(struct mdd_device *d)
386 return d->mdd_child->dd_ops;
389 static inline struct lu_object *mdd2lu_obj(struct mdd_object *obj)
391 return &obj->mod_obj.mo_lu;
394 static inline struct dt_object* mdd_object_child(struct mdd_object *o)
396 return container_of0(lu_object_next(mdd2lu_obj(o)),
397 struct dt_object, do_lu);
400 static inline struct obd_device *mdd2obd_dev(struct mdd_device *mdd)
402 return mdd->mdd_obd_dev;
405 static inline struct mdd_device *mdd_obj2mdd_dev(struct mdd_object *obj)
407 return mdo2mdd(&obj->mod_obj);
410 static inline const struct lu_fid *mdo2fid(const struct mdd_object *obj)
412 return lu_object_fid(&obj->mod_obj.mo_lu);
415 static inline umode_t mdd_object_type(const struct mdd_object *obj)
417 return lu_object_attr(&obj->mod_obj.mo_lu);
420 static inline int mdd_lov_mdsize(const struct lu_env *env,
421 struct mdd_device *mdd)
423 struct obd_device *obd = mdd2obd_dev(mdd);
424 return obd->u.mds.mds_max_mdsize;
427 static inline int mdd_lov_cookiesize(const struct lu_env *env,
428 struct mdd_device *mdd)
430 struct obd_device *obd = mdd2obd_dev(mdd);
431 return obd->u.mds.mds_max_cookiesize;
434 static inline int mdd_is_immutable(struct mdd_object *obj)
436 return obj->mod_flags & IMMUTE_OBJ;
439 static inline int mdd_is_dead_obj(struct mdd_object *obj)
441 return obj && obj->mod_flags & DEAD_OBJ;
444 static inline int mdd_is_append(struct mdd_object *obj)
446 return obj->mod_flags & APPEND_OBJ;
449 static inline int mdd_is_mnlink(struct mdd_object *obj)
451 return obj->mod_flags & MNLINK_OBJ;
454 static inline int mdd_object_exists(struct mdd_object *obj)
456 return lu_object_exists(mdd2lu_obj(obj));
459 static inline const struct lu_fid *mdd_object_fid(struct mdd_object *obj)
461 return lu_object_fid(mdd2lu_obj(obj));
464 static inline struct lustre_capa *mdd_object_capa(const struct lu_env *env,
465 const struct mdd_object *obj)
467 struct md_capainfo *ci = md_capainfo(env);
468 const struct lu_fid *fid = mdo2fid(obj);
471 /* NB: in mdt_init0 */
474 for (i = 0; i < MD_CAPAINFO_MAX; i++)
475 if (ci->mc_fid[i] && lu_fid_eq(ci->mc_fid[i], fid))
476 return ci->mc_capa[i];
480 static inline void mdd_set_capainfo(const struct lu_env *env, int offset,
481 const struct mdd_object *obj,
482 struct lustre_capa *capa)
484 struct md_capainfo *ci = md_capainfo(env);
485 const struct lu_fid *fid = mdo2fid(obj);
487 LASSERT(offset >= 0 && offset <= MD_CAPAINFO_MAX);
488 /* NB: in mdt_init0 */
491 ci->mc_fid[offset] = fid;
492 ci->mc_capa[offset] = capa;
495 #define MAX_ATIME_DIFF 60
501 static inline int mdd_permission_internal(const struct lu_env *env,
502 struct mdd_object *obj,
503 struct lu_attr *la, int mask)
505 return __mdd_permission_internal(env, obj, la, mask, 0);
508 static inline int mdd_permission_internal_locked(const struct lu_env *env,
509 struct mdd_object *obj,
510 struct lu_attr *la, int mask)
512 return __mdd_permission_internal(env, obj, la, mask, 1);
515 /* mdd inline func for calling osd_dt_object ops */
516 static inline int mdo_attr_get(const struct lu_env *env, struct mdd_object *obj,
517 struct lu_attr *la, struct lustre_capa *capa)
519 struct dt_object *next = mdd_object_child(obj);
520 return next->do_ops->do_attr_get(env, next, la, capa);
523 static inline int mdo_attr_set(const struct lu_env *env, struct mdd_object *obj,
524 const struct lu_attr *la, struct thandle *handle,
525 struct lustre_capa *capa)
527 struct dt_object *next = mdd_object_child(obj);
528 LASSERT(mdd_object_exists(obj));
529 return next->do_ops->do_attr_set(env, next, la, handle, capa);
532 static inline int mdo_xattr_get(const struct lu_env *env,struct mdd_object *obj,
533 struct lu_buf *buf, const char *name,
534 struct lustre_capa *capa)
536 struct dt_object *next = mdd_object_child(obj);
537 return next->do_ops->do_xattr_get(env, next, buf, name, capa);
540 static inline int mdo_xattr_set(const struct lu_env *env,struct mdd_object *obj,
541 const struct lu_buf *buf, const char *name,
542 int fl, struct thandle *handle,
543 struct lustre_capa *capa)
545 struct dt_object *next = mdd_object_child(obj);
546 LASSERT(mdd_object_exists(obj));
547 return next->do_ops->do_xattr_set(env, next, buf, name, fl, handle,
551 static inline int mdo_xattr_del(const struct lu_env *env,struct mdd_object *obj,
552 const char *name, struct thandle *handle,
553 struct lustre_capa *capa)
555 struct dt_object *next = mdd_object_child(obj);
556 LASSERT(mdd_object_exists(obj));
557 return next->do_ops->do_xattr_del(env, next, name, handle, capa);
561 int mdo_xattr_list(const struct lu_env *env, struct mdd_object *obj,
562 struct lu_buf *buf, struct lustre_capa *capa)
564 struct dt_object *next = mdd_object_child(obj);
565 LASSERT(mdd_object_exists(obj));
566 return next->do_ops->do_xattr_list(env, next, buf, capa);
570 int mdo_index_try(const struct lu_env *env, struct mdd_object *obj,
571 const struct dt_index_features *feat)
573 struct dt_object *next = mdd_object_child(obj);
574 return next->do_ops->do_index_try(env, next, feat);
577 static inline void mdo_ref_add(const struct lu_env *env, struct mdd_object *obj,
578 struct thandle *handle)
580 struct dt_object *next = mdd_object_child(obj);
581 LASSERT(mdd_object_exists(obj));
582 return next->do_ops->do_ref_add(env, next, handle);
585 static inline void mdo_ref_del(const struct lu_env *env, struct mdd_object *obj,
586 struct thandle *handle)
588 struct dt_object *next = mdd_object_child(obj);
589 LASSERT(mdd_object_exists(obj));
590 return next->do_ops->do_ref_del(env, next, handle);
594 int mdo_create_obj(const struct lu_env *env, struct mdd_object *o,
595 struct lu_attr *attr,
596 struct dt_allocation_hint *hint,
597 struct thandle *handle)
599 struct dt_object *next = mdd_object_child(o);
600 return next->do_ops->do_create(env, next, attr, hint, handle);
603 static inline struct obd_capa *mdo_capa_get(const struct lu_env *env,
604 struct mdd_object *obj,
605 struct lustre_capa *old,
608 struct dt_object *next = mdd_object_child(obj);
609 LASSERT(mdd_object_exists(obj));
610 return next->do_ops->do_capa_get(env, next, old, opc);