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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/include/md_object.h
34 * Extention of lu_object.h for metadata objects
37 #ifndef _LUSTRE_MD_OBJECT_H
38 #define _LUSTRE_MD_OBJECT_H
40 #ifndef HAVE_SERVER_SUPPORT
41 # error "client code should not depend on md_object.h"
42 #endif /* !HAVE_SERVER_SUPPORT */
45 * Sub-class of lu_object with methods common for "meta-data" objects in MDT
48 * Meta-data objects implement namespace operations: you can link, unlink
49 * them, and treat them as directories.
51 * Examples: mdt, cmm, and mdt are implementations of md interface.
57 * super-class definitions.
59 #include <dt_object.h>
62 struct md_device_operations;
66 /** metadata attributes */
94 MDT_REG_LOCK = (1 << 0),
95 MDT_PDO_LOCK = (1 << 1)
98 /* lfs rgetfacl permission check */
99 #define MAY_RGETFACL (1 << 14)
101 /* memory structure for hsm attributes
102 * for fields description see the on disk structure hsm_attrs
103 * which is defined in lustre_idl.h
113 /* memory structure for SOM attributes
114 * for fields description see the on disk structure som_attrs
115 * which is defined in lustre_idl.h
127 struct lu_attr ma_attr;
128 struct lu_fid ma_pfid;
129 struct md_hsm ma_hsm;
130 struct md_som ma_som;
131 struct lov_mds_md *ma_lmm;
132 union lmv_mds_md *ma_lmv;
133 struct lmv_user_md *ma_default_lmv;
137 int ma_default_lmv_size;
141 /** Additional parameters for create */
144 /** symlink target */
145 const char *sp_symname;
146 /** eadata for regular files */
153 /** Open flags from client: such as MDS_OPEN_CREAT, and others. */
156 /* File security context for creates. */
157 const char *sp_cr_file_secctx_name; /* (security) xattr name */
158 void *sp_cr_file_secctx; /* xattr value */
159 size_t sp_cr_file_secctx_size; /* xattr value size */
161 /** don't create lov objects or llog cookie - this replay */
162 unsigned int no_create:1,
163 sp_cr_lookup:1, /* do lookup sanity check or not. */
164 sp_rm_entry:1, /* only remove name entry */
165 sp_permitted:1, /* do not check permission */
166 sp_migrate_close:1; /* close the file during migrate */
167 /** Current lock mode for parent dir where create is performing. */
168 mdl_mode_t sp_cr_mode;
170 /** to create directory */
171 const struct dt_index_features *sp_feat;
176 MD_LAYOUT_WRITE, /* FLR: write the file */
177 MD_LAYOUT_RESYNC, /* FLR: resync starts */
178 MD_LAYOUT_RESYNC_DONE, /* FLR: resync done */
182 * Parameters for layout change API.
184 struct md_layout_change {
185 enum md_layout_opc mlc_opc;
187 struct layout_intent *mlc_intent;
188 struct lu_buf mlc_buf;
189 struct lustre_som_attrs mlc_som;
190 size_t mlc_resync_count;
191 __u32 *mlc_resync_ids;
194 union ldlm_policy_data;
196 * Operations implemented for each md object (both directory and leaf).
198 struct md_object_operations {
199 int (*moo_permission)(const struct lu_env *env,
200 struct md_object *pobj, struct md_object *cobj,
201 struct md_attr *attr, int mask);
203 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
204 struct md_attr *attr);
206 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
207 const struct md_attr *attr);
209 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
210 struct lu_buf *buf, const char *name);
212 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
215 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
216 const struct lu_buf *buf, const char *name,
219 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
222 /** This method is used to swap the layouts between 2 objects */
223 int (*moo_swap_layouts)(const struct lu_env *env,
224 struct md_object *obj1, struct md_object *obj2,
227 /** \retval number of bytes actually read upon success */
228 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
229 const struct lu_rdpg *rdpg);
231 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
234 int (*moo_changelog)(const struct lu_env *env,
235 enum changelog_rec_type type,
236 enum changelog_rec_flags clf_flags,
237 struct md_device *m, const struct lu_fid *fid);
239 int (*moo_open)(const struct lu_env *env,
240 struct md_object *obj, u64 open_flags);
242 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
243 struct md_attr *ma, u64 open_flags);
245 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
247 int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
248 struct lustre_handle *lh,
249 struct ldlm_enqueue_info *einfo,
250 union ldlm_policy_data *policy);
251 int (*moo_object_unlock)(const struct lu_env *env,
252 struct md_object *obj,
253 struct ldlm_enqueue_info *einfo,
254 union ldlm_policy_data *policy);
256 int (*moo_invalidate)(const struct lu_env *env, struct md_object *obj);
258 * Trying to write to un-instantiated layout component.
260 * The caller should have held layout lock.
262 * This API can be extended to support every other layout changing
263 * operations, such as component {add,del,change}, layout swap,
264 * layout merge, etc. One of the benefits by doing this is that the MDT
265 * no longer needs to understand layout.
267 * However, layout creation, removal, and fetch should still use
268 * xattr_{get,set}() because they don't interpret layout on the
271 * \param[in] env execution environment
272 * \param[in] obj MD object
273 * \param[in] layout data structure to describe the changes to
274 * the MD object's layout
277 * \retval -ne error code
279 int (*moo_layout_change)(const struct lu_env *env,
280 struct md_object *obj,
281 struct md_layout_change *layout);
285 * Operations implemented for each directory object.
287 struct md_dir_operations {
288 int (*mdo_is_subdir)(const struct lu_env *env, struct md_object *obj,
289 const struct lu_fid *fid);
291 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
292 const struct lu_name *lname, struct lu_fid *fid,
293 struct md_op_spec *spec);
295 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
296 struct md_object *obj,
299 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
300 const struct lu_name *lname, struct md_object *child,
301 struct md_op_spec *spec,
304 /** This method is used for creating data object for this meta object*/
305 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
307 const struct md_op_spec *spec,
310 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
311 struct md_object *tpobj, const struct lu_fid *lf,
312 const struct lu_name *lsname, struct md_object *tobj,
313 const struct lu_name *ltname, struct md_attr *ma);
315 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
316 struct md_object *src_obj, const struct lu_name *lname,
319 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
320 struct md_object *cobj, const struct lu_name *lname,
321 struct md_attr *ma, int no_name);
323 int (*mdo_migrate)(const struct lu_env *env, struct md_object *pobj,
324 struct md_object *sobj, const struct lu_name *lname,
325 struct md_object *tobj, struct md_op_spec *spec,
329 struct md_device_operations {
330 /** meta-data device related handlers. */
331 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
334 const struct dt_device_param *(*mdo_dtconf_get)(const struct lu_env *e,
335 struct md_device *m);
337 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
338 struct obd_statfs *sfs);
340 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
341 struct md_device *m, int idx, void **h);
343 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
344 unsigned int cmd, int len, void *data);
348 struct lu_device md_lu_dev;
349 const struct md_device_operations *md_ops;
353 struct lu_object mo_lu;
354 const struct md_object_operations *mo_ops;
355 const struct md_dir_operations *mo_dir_ops;
358 static inline struct md_device *lu2md_dev(const struct lu_device *d)
360 LASSERT(IS_ERR(d) || lu_device_is_md(d));
361 return container_of0(d, struct md_device, md_lu_dev);
364 static inline struct lu_device *md2lu_dev(struct md_device *d)
366 return &d->md_lu_dev;
369 static inline struct md_object *lu2md(const struct lu_object *o)
371 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
372 return container_of0(o, struct md_object, mo_lu);
375 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
377 return lu_device_init(&md->md_lu_dev, t);
380 static inline void md_device_fini(struct md_device *md)
382 lu_device_fini(&md->md_lu_dev);
385 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
386 struct md_device *md,
387 const struct lu_fid *f)
389 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
394 static inline int mo_permission(const struct lu_env *env, struct md_object *p,
395 struct md_object *c, struct md_attr *at,
398 LASSERT(c->mo_ops->moo_permission);
399 return c->mo_ops->moo_permission(env, p, c, at, mask);
402 static inline int mo_attr_get(const struct lu_env *env, struct md_object *m,
405 LASSERT(m->mo_ops->moo_attr_get);
406 return m->mo_ops->moo_attr_get(env, m, at);
409 static inline int mo_readlink(const struct lu_env *env,
413 LASSERT(m->mo_ops->moo_readlink);
414 return m->mo_ops->moo_readlink(env, m, buf);
417 static inline int mo_changelog(const struct lu_env *env,
418 enum changelog_rec_type type,
419 enum changelog_rec_flags clf_flags,
420 struct md_device *m, const struct lu_fid *fid)
422 struct lu_fid rootfid;
423 struct md_object *root;
426 rc = m->md_ops->mdo_root_get(env, m, &rootfid);
430 root = md_object_find_slice(env, m, &rootfid);
432 RETURN(PTR_ERR(root));
434 LASSERT(root->mo_ops->moo_changelog);
435 rc = root->mo_ops->moo_changelog(env, type, clf_flags, m, fid);
437 lu_object_put(env, &root->mo_lu);
442 static inline int mo_attr_set(const struct lu_env *env,
444 const struct md_attr *at)
446 LASSERT(m->mo_ops->moo_attr_set);
447 return m->mo_ops->moo_attr_set(env, m, at);
450 static inline int mo_xattr_get(const struct lu_env *env,
455 LASSERT(m->mo_ops->moo_xattr_get);
456 return m->mo_ops->moo_xattr_get(env, m, buf, name);
459 static inline int mo_xattr_del(const struct lu_env *env,
463 LASSERT(m->mo_ops->moo_xattr_del);
464 return m->mo_ops->moo_xattr_del(env, m, name);
467 static inline int mo_xattr_set(const struct lu_env *env,
469 const struct lu_buf *buf,
473 LASSERT(m->mo_ops->moo_xattr_set);
474 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
477 static inline int mo_xattr_list(const struct lu_env *env,
481 LASSERT(m->mo_ops->moo_xattr_list);
482 return m->mo_ops->moo_xattr_list(env, m, buf);
485 static inline int mo_invalidate(const struct lu_env *env, struct md_object *m)
487 LASSERT(m->mo_ops->moo_invalidate);
488 return m->mo_ops->moo_invalidate(env, m);
491 static inline int mo_layout_change(const struct lu_env *env,
493 struct md_layout_change *layout)
495 /* need instantiate objects which in the access range */
496 LASSERT(m->mo_ops->moo_layout_change);
497 return m->mo_ops->moo_layout_change(env, m, layout);
500 static inline int mo_swap_layouts(const struct lu_env *env,
501 struct md_object *o1,
502 struct md_object *o2, __u64 flags)
504 LASSERT(o1->mo_ops->moo_swap_layouts);
505 LASSERT(o2->mo_ops->moo_swap_layouts);
506 if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
508 return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
511 static inline int mo_open(const struct lu_env *env, struct md_object *m,
514 LASSERT(m->mo_ops->moo_open);
515 return m->mo_ops->moo_open(env, m, open_flags);
518 static inline int mo_close(const struct lu_env *env, struct md_object *m,
519 struct md_attr *ma, u64 open_flags)
521 LASSERT(m->mo_ops->moo_close);
522 return m->mo_ops->moo_close(env, m, ma, open_flags);
525 static inline int mo_readpage(const struct lu_env *env,
527 const struct lu_rdpg *rdpg)
529 LASSERT(m->mo_ops->moo_readpage);
530 return m->mo_ops->moo_readpage(env, m, rdpg);
533 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
535 LASSERT(m->mo_ops->moo_object_sync);
536 return m->mo_ops->moo_object_sync(env, m);
539 static inline int mo_object_lock(const struct lu_env *env,
541 struct lustre_handle *lh,
542 struct ldlm_enqueue_info *einfo,
543 union ldlm_policy_data *policy)
545 LASSERT(m->mo_ops->moo_object_lock);
546 return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
549 static inline int mo_object_unlock(const struct lu_env *env,
551 struct ldlm_enqueue_info *einfo,
552 union ldlm_policy_data *policy)
554 LASSERT(m->mo_ops->moo_object_unlock);
555 return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
558 static inline int mdo_lookup(const struct lu_env *env,
560 const struct lu_name *lname,
562 struct md_op_spec *spec)
564 LASSERT(p->mo_dir_ops->mdo_lookup);
565 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
568 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
569 struct md_object *mo,
572 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
574 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
577 static inline int mdo_create(const struct lu_env *env,
579 const struct lu_name *lchild_name,
581 struct md_op_spec *spc,
584 LASSERT(p->mo_dir_ops->mdo_create);
585 return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
588 static inline int mdo_create_data(const struct lu_env *env,
591 const struct md_op_spec *spec,
594 LASSERT(c->mo_dir_ops->mdo_create_data);
595 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
598 static inline int mdo_rename(const struct lu_env *env,
599 struct md_object *sp,
600 struct md_object *tp,
601 const struct lu_fid *lf,
602 const struct lu_name *lsname,
604 const struct lu_name *ltname,
607 LASSERT(tp->mo_dir_ops->mdo_rename);
608 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
612 static inline int mdo_migrate(const struct lu_env *env,
613 struct md_object *pobj,
614 struct md_object *sobj,
615 const struct lu_name *lname,
616 struct md_object *tobj,
617 struct md_op_spec *spec,
620 LASSERT(pobj->mo_dir_ops->mdo_migrate);
621 return pobj->mo_dir_ops->mdo_migrate(env, pobj, sobj, lname, tobj, spec,
625 static inline int mdo_is_subdir(const struct lu_env *env,
626 struct md_object *mo,
627 const struct lu_fid *fid)
629 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
630 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid);
633 static inline int mdo_link(const struct lu_env *env,
636 const struct lu_name *lname,
639 LASSERT(s->mo_dir_ops->mdo_link);
640 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
643 static inline int mdo_unlink(const struct lu_env *env,
646 const struct lu_name *lname,
647 struct md_attr *ma, int no_name)
649 LASSERT(p->mo_dir_ops->mdo_unlink);
650 return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
653 static inline int mdo_statfs(const struct lu_env *env,
655 struct obd_statfs *sfs)
657 LASSERT(m->md_ops->mdo_statfs);
658 return m->md_ops->mdo_statfs(env, m, sfs);
662 * Used in MDD/OUT layer for object lock rule
664 enum mdd_object_role {
674 void lustre_som_swab(struct lustre_som_attrs *attrs);
675 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
676 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
695 __u32 uc_suppgids[2];
698 struct group_info *uc_ginfo;
699 struct md_identity *uc_identity;
700 char uc_jobid[LUSTRE_JOBID_SIZE];
702 bool uc_enable_audit;
705 struct lu_ucred *lu_ucred(const struct lu_env *env);
707 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
709 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
711 int lu_ucred_global_init(void);
713 void lu_ucred_global_fini(void);
715 #define md_cap_t(x) (x)
717 #define MD_CAP_TO_MASK(x) (1 << (x))
719 #define md_cap_raised(c, flag) (md_cap_t(c) & MD_CAP_TO_MASK(flag))
721 /* capable() is copied from linux kernel! */
722 static inline int md_capable(struct lu_ucred *uc, cfs_cap_t cap)
724 if (md_cap_raised(uc->uc_cap, cap))
730 #endif /* _LINUX_MD_OBJECT_H */