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/
31 * lustre/include/md_object.h
33 * Extention of lu_object.h for metadata objects
36 #ifndef _LUSTRE_MD_OBJECT_H
37 #define _LUSTRE_MD_OBJECT_H
39 #ifndef HAVE_SERVER_SUPPORT
40 # error "client code should not depend on md_object.h"
41 #endif /* !HAVE_SERVER_SUPPORT */
44 * Sub-class of lu_object with methods common for "meta-data" objects in MDT
47 * Meta-data objects implement namespace operations: you can link, unlink
48 * them, and treat them as directories.
50 * Examples: mdt, cmm, and mdt are implementations of md interface.
56 * super-class definitions.
58 #include <dt_object.h>
61 struct md_device_operations;
65 /** metadata attributes */
77 MA_FORCE_LOG = BIT(10), /* forced close logged in mdt_mfd_close */
94 MDT_REG_LOCK = BIT(0),
95 MDT_PDO_LOCK = BIT(1),
98 /* lfs rgetfacl permission check */
99 #define MAY_RGETFACL BIT(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;
139 int ma_enable_chprojid_gid;
142 /** Additional parameters for create */
145 /** symlink target */
146 struct lu_name sp_symname;
147 /** eadata for regular files */
154 /** Open flags from client: such as MDS_OPEN_CREAT, and others. */
157 /* File security context for creates. */
158 const char *sp_cr_file_secctx_name; /* (security) xattr name */
159 void *sp_cr_file_secctx; /* xattr value */
160 size_t sp_cr_file_secctx_size; /* xattr value size */
162 /* File encryption context for creates. */
163 void *sp_cr_file_encctx; /* enc ctx value */
164 size_t sp_cr_file_encctx_size; /* enc ctx size */
166 /* Archive ID used for auto PCC attach when create newly files. */
169 /** don't create lov objects or llog cookie - this replay */
170 unsigned int no_create:1,
171 sp_cr_lookup:1, /* do lookup sanity check or not. */
172 sp_rm_entry:1, /* only remove name entry */
173 sp_permitted:1, /* do not check permission */
174 sp_migrate_close:1, /* close the file during migrate */
175 sp_migrate_nsonly:1, /* migrate dirent only */
176 sp_dmv_imp_inherit:1, /* implicit default LMV inherit */
177 sp_replay:1; /* replay, op may be partially executed */
179 /** to create directory */
180 const struct dt_index_features *sp_feat;
182 /* name of xattr used to store jobid in inode, or empty if disabled */
183 char sp_cr_job_xattr[XATTR_JOB_MAX_LEN];
188 MD_LAYOUT_WRITE, /* FLR: write the file */
189 MD_LAYOUT_RESYNC, /* FLR: resync starts */
190 MD_LAYOUT_RESYNC_DONE, /* FLR: resync done */
191 MD_LAYOUT_ATTACH, /* attach stripes */
192 MD_LAYOUT_DETACH, /* detach stripes */
193 MD_LAYOUT_SHRINK, /* shrink striped directory (destroy stripes) */
194 MD_LAYOUT_SPLIT, /* split directory (allocate new stripes) */
199 * Parameters for layout change API.
201 struct md_layout_change {
202 enum md_layout_opc mlc_opc;
203 struct lu_buf mlc_buf;
207 struct layout_intent *mlc_intent;
208 struct lustre_som_attrs mlc_som;
209 size_t mlc_resync_count;
210 __u32 *mlc_resync_ids;
213 /* parent obj in plain dir split */
214 struct md_object *mlc_parent;
215 /* target obj in plain dir split */
216 struct md_object *mlc_target;
217 /* target attr in plain dir split */
218 struct lu_attr *mlc_attr;
219 /* target name in plain dir split */
220 const struct lu_name *mlc_name;
222 struct md_op_spec *mlc_spec;
227 union ldlm_policy_data;
229 * Operations implemented for each md object (both directory and leaf).
231 struct md_object_operations {
232 int (*moo_permission)(const struct lu_env *env,
233 struct md_object *pobj, struct md_object *cobj,
234 struct md_attr *attr, unsigned int may_mask);
236 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
237 struct md_attr *attr);
239 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
240 const struct md_attr *attr);
242 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
243 struct lu_buf *buf, const char *name);
245 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
248 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
249 const struct lu_buf *buf, const char *name,
252 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
255 /** This method is used to swap the layouts between 2 objects */
256 int (*moo_swap_layouts)(const struct lu_env *env,
257 struct md_object *obj1, struct md_object *obj2,
260 /** \retval number of bytes actually read upon success */
261 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
262 const struct lu_rdpg *rdpg);
264 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
267 int (*moo_changelog)(const struct lu_env *env,
268 enum changelog_rec_type type,
269 enum changelog_rec_flags clf_flags,
270 struct md_device *m, const struct lu_fid *fid);
272 int (*moo_open)(const struct lu_env *env, struct md_object *obj,
273 u64 open_flags, struct md_op_spec*);
275 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
276 struct md_attr *ma, u64 open_flags);
278 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
280 int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
281 struct lustre_handle *lh,
282 struct ldlm_enqueue_info *einfo,
283 union ldlm_policy_data *policy);
284 int (*moo_object_unlock)(const struct lu_env *env,
285 struct md_object *obj,
286 struct ldlm_enqueue_info *einfo,
287 union ldlm_policy_data *policy);
289 int (*moo_invalidate)(const struct lu_env *env, struct md_object *obj);
291 * Trying to write to un-instantiated layout component.
293 * The caller should have held layout lock.
295 * This API can be extended to support every other layout changing
296 * operations, such as component {add,del,change}, layout swap,
297 * layout merge, etc. One of the benefits by doing this is that the MDT
298 * no longer needs to understand layout.
300 * However, layout creation, removal, and fetch should still use
301 * xattr_{get,set}() because they don't interpret layout on the
304 * \param[in] env execution environment
305 * \param[in] obj MD object
306 * \param[in] layout data structure to describe the changes to
307 * the MD object's layout
310 * \retval -ne error code
312 int (*moo_layout_change)(const struct lu_env *env,
313 struct md_object *obj,
314 struct md_layout_change *layout);
318 * Operations implemented for each directory object.
320 struct md_dir_operations {
321 int (*mdo_is_subdir)(const struct lu_env *env, struct md_object *obj,
322 const struct lu_fid *fid);
324 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
325 const struct lu_name *lname, struct lu_fid *fid,
326 struct md_op_spec *spec);
328 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
329 struct md_object *obj,
332 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
333 const struct lu_name *lname, struct md_object *child,
334 struct md_op_spec *spec,
337 /** This method is used for creating data object for this meta object*/
338 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
340 const struct md_op_spec *spec,
343 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
344 struct md_object *tpobj, const struct lu_fid *lf,
345 const struct lu_name *lsname, struct md_object *tobj,
346 const struct lu_name *ltname, struct md_attr *ma);
348 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
349 struct md_object *src_obj, const struct lu_name *lname,
352 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
353 struct md_object *cobj, const struct lu_name *lname,
354 struct md_attr *ma, int no_name);
356 int (*mdo_migrate)(const struct lu_env *env, struct md_object *spobj,
357 struct md_object *tpobj, struct md_object *sobj,
358 struct md_object *tobj, const struct lu_name *lname,
359 struct md_op_spec *spec, struct md_attr *ma);
362 struct md_device_operations {
363 /** meta-data device related handlers. */
364 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
367 const struct dt_device_param *(*mdo_dtconf_get)(const struct lu_env *e,
368 struct md_device *m);
370 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
371 struct obd_statfs *sfs);
373 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
374 struct md_device *m, int idx, void **h);
376 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
377 unsigned int cmd, int len, void *data);
381 struct lu_device md_lu_dev;
382 const struct md_device_operations *md_ops;
386 struct lu_object mo_lu;
387 const struct md_object_operations *mo_ops;
388 const struct md_dir_operations *mo_dir_ops;
391 static inline struct md_device *lu2md_dev(const struct lu_device *d)
393 LASSERT(IS_ERR(d) || lu_device_is_md(d));
394 return container_of_safe(d, struct md_device, md_lu_dev);
397 static inline struct lu_device *md2lu_dev(struct md_device *d)
399 return &d->md_lu_dev;
402 static inline struct md_object *lu2md(const struct lu_object *o)
404 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
405 return container_of_safe(o, struct md_object, mo_lu);
408 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
410 return lu_device_init(&md->md_lu_dev, t);
413 static inline void md_device_fini(struct md_device *md)
415 lu_device_fini(&md->md_lu_dev);
418 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
419 struct md_device *md,
420 const struct lu_fid *f)
422 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
427 static inline int mo_permission(const struct lu_env *env, struct md_object *p,
428 struct md_object *c, struct md_attr *at,
429 unsigned int may_mask)
431 LASSERT(c->mo_ops->moo_permission);
432 return c->mo_ops->moo_permission(env, p, c, at, may_mask);
435 static inline int mo_attr_get(const struct lu_env *env, struct md_object *m,
438 LASSERT(m->mo_ops->moo_attr_get);
439 return m->mo_ops->moo_attr_get(env, m, at);
442 static inline int mo_readlink(const struct lu_env *env,
446 LASSERT(m->mo_ops->moo_readlink);
447 return m->mo_ops->moo_readlink(env, m, buf);
450 static inline int mo_changelog(const struct lu_env *env,
451 enum changelog_rec_type type,
452 enum changelog_rec_flags clf_flags,
453 struct md_device *m, const struct lu_fid *fid)
455 struct lu_fid rootfid;
456 struct md_object *root;
459 rc = m->md_ops->mdo_root_get(env, m, &rootfid);
463 root = md_object_find_slice(env, m, &rootfid);
465 RETURN(PTR_ERR(root));
467 LASSERT(root->mo_ops->moo_changelog);
468 rc = root->mo_ops->moo_changelog(env, type, clf_flags, m, fid);
470 lu_object_put(env, &root->mo_lu);
475 static inline int mo_attr_set(const struct lu_env *env,
477 const struct md_attr *at)
479 LASSERT(m->mo_ops->moo_attr_set);
480 return m->mo_ops->moo_attr_set(env, m, at);
483 static inline int mo_xattr_get(const struct lu_env *env,
488 LASSERT(m->mo_ops->moo_xattr_get);
489 return m->mo_ops->moo_xattr_get(env, m, buf, name);
492 static inline int mo_xattr_del(const struct lu_env *env,
496 LASSERT(m->mo_ops->moo_xattr_del);
497 return m->mo_ops->moo_xattr_del(env, m, name);
500 static inline int mo_xattr_set(const struct lu_env *env,
502 const struct lu_buf *buf,
506 LASSERT(m->mo_ops->moo_xattr_set);
507 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
510 static inline int mo_xattr_list(const struct lu_env *env,
514 LASSERT(m->mo_ops->moo_xattr_list);
515 return m->mo_ops->moo_xattr_list(env, m, buf);
518 static inline int mo_invalidate(const struct lu_env *env, struct md_object *m)
520 LASSERT(m->mo_ops->moo_invalidate);
521 return m->mo_ops->moo_invalidate(env, m);
524 static inline int mo_layout_change(const struct lu_env *env,
526 struct md_layout_change *layout)
528 /* need instantiate objects which in the access range */
529 LASSERT(m->mo_ops->moo_layout_change);
530 return m->mo_ops->moo_layout_change(env, m, layout);
533 static inline int mo_swap_layouts(const struct lu_env *env,
534 struct md_object *o1,
535 struct md_object *o2, __u64 flags)
537 LASSERT(o1->mo_ops->moo_swap_layouts);
538 LASSERT(o2->mo_ops->moo_swap_layouts);
539 if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
541 return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
544 static inline int mo_open(const struct lu_env *env, struct md_object *m,
545 u64 open_flags, struct md_op_spec *spec)
547 LASSERT(m->mo_ops->moo_open);
548 return m->mo_ops->moo_open(env, m, open_flags, spec);
551 static inline int mo_close(const struct lu_env *env, struct md_object *m,
552 struct md_attr *ma, u64 open_flags)
554 LASSERT(m->mo_ops->moo_close);
555 return m->mo_ops->moo_close(env, m, ma, open_flags);
558 static inline int mo_readpage(const struct lu_env *env,
560 const struct lu_rdpg *rdpg)
562 LASSERT(m->mo_ops->moo_readpage);
563 return m->mo_ops->moo_readpage(env, m, rdpg);
566 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
568 LASSERT(m->mo_ops->moo_object_sync);
569 return m->mo_ops->moo_object_sync(env, m);
572 static inline int mo_object_lock(const struct lu_env *env,
574 struct lustre_handle *lh,
575 struct ldlm_enqueue_info *einfo,
576 union ldlm_policy_data *policy)
578 LASSERT(m->mo_ops->moo_object_lock);
579 return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
582 static inline int mo_object_unlock(const struct lu_env *env,
584 struct ldlm_enqueue_info *einfo,
585 union ldlm_policy_data *policy)
587 LASSERT(m->mo_ops->moo_object_unlock);
588 return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
591 static inline int mdo_lookup(const struct lu_env *env,
593 const struct lu_name *lname,
595 struct md_op_spec *spec)
597 LASSERT(p->mo_dir_ops->mdo_lookup);
598 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
601 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
602 struct md_object *mo,
605 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
607 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
610 static inline int mdo_create(const struct lu_env *env,
612 const struct lu_name *lchild_name,
614 struct md_op_spec *spc,
617 LASSERT(p->mo_dir_ops->mdo_create);
618 return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
621 static inline int mdo_create_data(const struct lu_env *env,
624 const struct md_op_spec *spec,
627 LASSERT(c->mo_dir_ops->mdo_create_data);
628 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
631 static inline int mdo_rename(const struct lu_env *env,
632 struct md_object *sp,
633 struct md_object *tp,
634 const struct lu_fid *lf,
635 const struct lu_name *lsname,
637 const struct lu_name *ltname,
640 LASSERT(tp->mo_dir_ops->mdo_rename);
641 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
645 static inline int mdo_migrate(const struct lu_env *env,
646 struct md_object *spobj,
647 struct md_object *tpobj,
648 struct md_object *sobj,
649 struct md_object *tobj,
650 const struct lu_name *lname,
651 struct md_op_spec *spec,
654 LASSERT(spobj->mo_dir_ops->mdo_migrate);
655 return spobj->mo_dir_ops->mdo_migrate(env, spobj, tpobj, sobj, tobj,
659 static inline int mdo_is_subdir(const struct lu_env *env,
660 struct md_object *mo,
661 const struct lu_fid *fid)
663 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
664 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid);
667 static inline int mdo_link(const struct lu_env *env,
670 const struct lu_name *lname,
673 LASSERT(s->mo_dir_ops->mdo_link);
674 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
677 static inline int mdo_unlink(const struct lu_env *env,
680 const struct lu_name *lname,
681 struct md_attr *ma, int no_name)
683 LASSERT(p->mo_dir_ops->mdo_unlink);
684 return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
687 static inline int mdo_statfs(const struct lu_env *env,
689 struct obd_statfs *sfs)
691 LASSERT(m->md_ops->mdo_statfs);
692 return m->md_ops->mdo_statfs(env, m, sfs);
697 void lustre_som_swab(struct lustre_som_attrs *attrs);
698 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
699 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
718 __u32 uc_suppgids[2];
721 struct group_info *uc_ginfo;
722 struct md_identity *uc_identity;
723 char uc_jobid[LUSTRE_JOBID_SIZE];
725 bool uc_enable_audit;
726 int uc_rbac_file_perms:1;
727 int uc_rbac_dne_ops:1;
728 int uc_rbac_quota_ops:1;
729 int uc_rbac_byfid_ops:1;
730 int uc_rbac_chlg_ops:1;
731 int uc_rbac_fscrypt_admin:1;
734 struct lu_ucred *lu_ucred(const struct lu_env *env);
736 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
738 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
740 int lu_ucred_global_init(void);
742 void lu_ucred_global_fini(void);
745 #endif /* _LINUX_MD_OBJECT_H */