4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2015, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/md_object.h
38 * Extention of lu_object.h for metadata objects
41 #ifndef _LUSTRE_MD_OBJECT_H
42 #define _LUSTRE_MD_OBJECT_H
44 #ifndef HAVE_SERVER_SUPPORT
45 # error "client code should not depend on md_object.h"
46 #endif /* !HAVE_SERVER_SUPPORT */
49 * Sub-class of lu_object with methods common for "meta-data" objects in MDT
52 * Meta-data objects implement namespace operations: you can link, unlink
53 * them, and treat them as directories.
55 * Examples: mdt, cmm, and mdt are implementations of md interface.
61 * super-class definitions.
63 #include <dt_object.h>
66 struct md_device_operations;
70 /** metadata attributes */
97 MDT_REG_LOCK = (1 << 0),
98 MDT_PDO_LOCK = (1 << 1)
101 /* lfs rgetfacl permission check */
102 #define MAY_RGETFACL (1 << 14)
104 /* memory structure for hsm attributes
105 * for fields description see the on disk structure hsm_attrs
106 * which is defined in lustre_idl.h
119 struct lu_attr ma_attr;
120 struct lu_fid ma_pfid;
121 struct md_hsm ma_hsm;
122 struct lov_mds_md *ma_lmm;
123 union lmv_mds_md *ma_lmv;
130 /** Additional parameters for create */
133 /** symlink target */
134 const char *sp_symname;
135 /** eadata for regular files */
142 /** Create flag from client: such as MDS_OPEN_CREAT, and others. */
145 /** don't create lov objects or llog cookie - this replay */
146 unsigned int no_create:1,
147 sp_cr_lookup:1, /* do lookup sanity check or not. */
148 sp_rm_entry:1, /* only remove name entry */
149 sp_permitted:1, /* do not check permission */
150 sp_migrate_close:1; /* close the file during migrate */
151 /** Current lock mode for parent dir where create is performing. */
152 mdl_mode_t sp_cr_mode;
154 /** to create directory */
155 const struct dt_index_features *sp_feat;
158 union ldlm_policy_data;
160 * Operations implemented for each md object (both directory and leaf).
162 struct md_object_operations {
163 int (*moo_permission)(const struct lu_env *env,
164 struct md_object *pobj, struct md_object *cobj,
165 struct md_attr *attr, int mask);
167 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
168 struct md_attr *attr);
170 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
171 const struct md_attr *attr);
173 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
174 struct lu_buf *buf, const char *name);
176 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
179 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
180 const struct lu_buf *buf, const char *name,
183 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
186 /** This method is used to swap the layouts between 2 objects */
187 int (*moo_swap_layouts)(const struct lu_env *env,
188 struct md_object *obj1, struct md_object *obj2,
191 /** \retval number of bytes actually read upon success */
192 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
193 const struct lu_rdpg *rdpg);
195 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
197 int (*moo_changelog)(const struct lu_env *env,
198 enum changelog_rec_type type, int flags,
199 struct md_object *obj);
201 int (*moo_open)(const struct lu_env *env,
202 struct md_object *obj, int flag);
204 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
205 struct md_attr *ma, int mode);
207 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
209 int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
210 struct lustre_handle *lh,
211 struct ldlm_enqueue_info *einfo,
212 union ldlm_policy_data *policy);
213 int (*moo_object_unlock)(const struct lu_env *env,
214 struct md_object *obj,
215 struct ldlm_enqueue_info *einfo,
216 union ldlm_policy_data *policy);
220 * Operations implemented for each directory object.
222 struct md_dir_operations {
223 int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
224 const struct lu_fid *fid, struct lu_fid *sfid);
226 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
227 const struct lu_name *lname, struct lu_fid *fid,
228 struct md_op_spec *spec);
230 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
231 struct md_object *obj,
234 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
235 const struct lu_name *lname, struct md_object *child,
236 struct md_op_spec *spec,
239 /** This method is used for creating data object for this meta object*/
240 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
242 const struct md_op_spec *spec,
245 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
246 struct md_object *tpobj, const struct lu_fid *lf,
247 const struct lu_name *lsname, struct md_object *tobj,
248 const struct lu_name *ltname, struct md_attr *ma);
250 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
251 struct md_object *src_obj, const struct lu_name *lname,
254 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
255 struct md_object *cobj, const struct lu_name *lname,
256 struct md_attr *ma, int no_name);
258 int (*mdo_migrate)(const struct lu_env *env, struct md_object *pobj,
259 struct md_object *sobj, const struct lu_name *lname,
260 struct md_object *tobj, struct md_attr *ma);
263 struct md_device_operations {
264 /** meta-data device related handlers. */
265 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
268 int (*mdo_maxeasize_get)(const struct lu_env *env, struct md_device *m,
271 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
272 struct obd_statfs *sfs);
274 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
275 struct md_device *m, int idx, void **h);
277 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
278 unsigned int cmd, int len, void *data);
282 struct lu_device md_lu_dev;
283 const struct md_device_operations *md_ops;
287 struct lu_object mo_lu;
288 const struct md_object_operations *mo_ops;
289 const struct md_dir_operations *mo_dir_ops;
292 /* Mark the object to be dead, and can not be accessed anymore.
293 * XXX, right now, it will only be used for striped directory to
294 * mark the slave stripes dead, when deleting master object. It will be
295 * stored in slave LMV EA (see lod_mark_dead_object), which is only
296 * temporary, and will be removed later when we have proper way to mark
297 * the dead object. */
298 #define LUSTRE_SLAVE_DEAD_FL 0x80000000
300 static inline struct md_device *lu2md_dev(const struct lu_device *d)
302 LASSERT(IS_ERR(d) || lu_device_is_md(d));
303 return container_of0(d, struct md_device, md_lu_dev);
306 static inline struct lu_device *md2lu_dev(struct md_device *d)
308 return &d->md_lu_dev;
311 static inline struct md_object *lu2md(const struct lu_object *o)
313 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
314 return container_of0(o, struct md_object, mo_lu);
317 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
319 return lu_device_init(&md->md_lu_dev, t);
322 static inline void md_device_fini(struct md_device *md)
324 lu_device_fini(&md->md_lu_dev);
327 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
328 struct md_device *md,
329 const struct lu_fid *f)
331 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
336 static inline int mo_permission(const struct lu_env *env,
342 LASSERT(c->mo_ops->moo_permission);
343 return c->mo_ops->moo_permission(env, p, c, at, mask);
346 static inline int mo_attr_get(const struct lu_env *env,
350 LASSERT(m->mo_ops->moo_attr_get);
351 return m->mo_ops->moo_attr_get(env, m, at);
354 static inline int mo_readlink(const struct lu_env *env,
358 LASSERT(m->mo_ops->moo_readlink);
359 return m->mo_ops->moo_readlink(env, m, buf);
362 static inline int mo_changelog(const struct lu_env *env,
363 enum changelog_rec_type type,
364 int flags, struct md_object *m)
366 LASSERT(m->mo_ops->moo_changelog);
367 return m->mo_ops->moo_changelog(env, type, flags, m);
370 static inline int mo_attr_set(const struct lu_env *env,
372 const struct md_attr *at)
374 LASSERT(m->mo_ops->moo_attr_set);
375 return m->mo_ops->moo_attr_set(env, m, at);
378 static inline int mo_xattr_get(const struct lu_env *env,
383 LASSERT(m->mo_ops->moo_xattr_get);
384 return m->mo_ops->moo_xattr_get(env, m, buf, name);
387 static inline int mo_xattr_del(const struct lu_env *env,
391 LASSERT(m->mo_ops->moo_xattr_del);
392 return m->mo_ops->moo_xattr_del(env, m, name);
395 static inline int mo_xattr_set(const struct lu_env *env,
397 const struct lu_buf *buf,
401 LASSERT(m->mo_ops->moo_xattr_set);
402 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
405 static inline int mo_xattr_list(const struct lu_env *env,
409 LASSERT(m->mo_ops->moo_xattr_list);
410 return m->mo_ops->moo_xattr_list(env, m, buf);
413 static inline int mo_swap_layouts(const struct lu_env *env,
414 struct md_object *o1,
415 struct md_object *o2, __u64 flags)
417 LASSERT(o1->mo_ops->moo_swap_layouts);
418 LASSERT(o2->mo_ops->moo_swap_layouts);
419 if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
421 return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
424 static inline int mo_open(const struct lu_env *env,
428 LASSERT(m->mo_ops->moo_open);
429 return m->mo_ops->moo_open(env, m, flags);
432 static inline int mo_close(const struct lu_env *env,
437 LASSERT(m->mo_ops->moo_close);
438 return m->mo_ops->moo_close(env, m, ma, mode);
441 static inline int mo_readpage(const struct lu_env *env,
443 const struct lu_rdpg *rdpg)
445 LASSERT(m->mo_ops->moo_readpage);
446 return m->mo_ops->moo_readpage(env, m, rdpg);
449 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
451 LASSERT(m->mo_ops->moo_object_sync);
452 return m->mo_ops->moo_object_sync(env, m);
455 static inline int mo_object_lock(const struct lu_env *env,
457 struct lustre_handle *lh,
458 struct ldlm_enqueue_info *einfo,
459 union ldlm_policy_data *policy)
461 LASSERT(m->mo_ops->moo_object_lock);
462 return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
465 static inline int mo_object_unlock(const struct lu_env *env,
467 struct ldlm_enqueue_info *einfo,
468 union ldlm_policy_data *policy)
470 LASSERT(m->mo_ops->moo_object_unlock);
471 return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
474 static inline int mdo_lookup(const struct lu_env *env,
476 const struct lu_name *lname,
478 struct md_op_spec *spec)
480 LASSERT(p->mo_dir_ops->mdo_lookup);
481 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
484 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
485 struct md_object *mo,
488 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
490 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
493 static inline int mdo_create(const struct lu_env *env,
495 const struct lu_name *lchild_name,
497 struct md_op_spec *spc,
500 LASSERT(p->mo_dir_ops->mdo_create);
501 return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
504 static inline int mdo_create_data(const struct lu_env *env,
507 const struct md_op_spec *spec,
510 LASSERT(c->mo_dir_ops->mdo_create_data);
511 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
514 static inline int mdo_rename(const struct lu_env *env,
515 struct md_object *sp,
516 struct md_object *tp,
517 const struct lu_fid *lf,
518 const struct lu_name *lsname,
520 const struct lu_name *ltname,
523 LASSERT(tp->mo_dir_ops->mdo_rename);
524 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
528 static inline int mdo_migrate(const struct lu_env *env,
529 struct md_object *pobj,
530 struct md_object *sobj,
531 const struct lu_name *lname,
532 struct md_object *tobj,
535 LASSERT(pobj->mo_dir_ops->mdo_migrate);
536 return pobj->mo_dir_ops->mdo_migrate(env, pobj, sobj, lname, tobj, ma);
539 static inline int mdo_is_subdir(const struct lu_env *env,
540 struct md_object *mo,
541 const struct lu_fid *fid,
544 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
545 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
548 static inline int mdo_link(const struct lu_env *env,
551 const struct lu_name *lname,
554 LASSERT(s->mo_dir_ops->mdo_link);
555 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
558 static inline int mdo_unlink(const struct lu_env *env,
561 const struct lu_name *lname,
562 struct md_attr *ma, int no_name)
564 LASSERT(p->mo_dir_ops->mdo_unlink);
565 return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
569 * Used in MDD/OUT layer for object lock rule
571 enum mdd_object_role {
581 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
582 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
601 __u32 uc_suppgids[2];
604 struct group_info *uc_ginfo;
605 struct md_identity *uc_identity;
606 char uc_jobid[LUSTRE_JOBID_SIZE];
609 struct lu_ucred *lu_ucred(const struct lu_env *env);
611 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
613 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
615 int lu_ucred_global_init(void);
617 void lu_ucred_global_fini(void);
619 #define md_cap_t(x) (x)
621 #define MD_CAP_TO_MASK(x) (1 << (x))
623 #define md_cap_raised(c, flag) (md_cap_t(c) & MD_CAP_TO_MASK(flag))
625 /* capable() is copied from linux kernel! */
626 static inline int md_capable(struct lu_ucred *uc, cfs_cap_t cap)
628 if (md_cap_raised(uc->uc_cap, cap))
634 #endif /* _LINUX_MD_OBJECT_H */