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 */
177 /** to create directory */
178 const struct dt_index_features *sp_feat;
183 MD_LAYOUT_WRITE, /* FLR: write the file */
184 MD_LAYOUT_RESYNC, /* FLR: resync starts */
185 MD_LAYOUT_RESYNC_DONE, /* FLR: resync done */
186 MD_LAYOUT_ATTACH, /* attach stripes */
187 MD_LAYOUT_DETACH, /* detach stripes */
188 MD_LAYOUT_SHRINK, /* shrink striped directory (destroy stripes) */
189 MD_LAYOUT_SPLIT, /* split directory (allocate new stripes) */
194 * Parameters for layout change API.
196 struct md_layout_change {
197 enum md_layout_opc mlc_opc;
198 struct lu_buf mlc_buf;
202 struct layout_intent *mlc_intent;
203 struct lustre_som_attrs mlc_som;
204 size_t mlc_resync_count;
205 __u32 *mlc_resync_ids;
208 /* parent obj in plain dir split */
209 struct md_object *mlc_parent;
210 /* target obj in plain dir split */
211 struct md_object *mlc_target;
212 /* target attr in plain dir split */
213 struct lu_attr *mlc_attr;
214 /* target name in plain dir split */
215 const struct lu_name *mlc_name;
217 struct md_op_spec *mlc_spec;
222 union ldlm_policy_data;
224 * Operations implemented for each md object (both directory and leaf).
226 struct md_object_operations {
227 int (*moo_permission)(const struct lu_env *env,
228 struct md_object *pobj, struct md_object *cobj,
229 struct md_attr *attr, unsigned int may_mask);
231 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
232 struct md_attr *attr);
234 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
235 const struct md_attr *attr);
237 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
238 struct lu_buf *buf, const char *name);
240 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
243 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
244 const struct lu_buf *buf, const char *name,
247 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
250 /** This method is used to swap the layouts between 2 objects */
251 int (*moo_swap_layouts)(const struct lu_env *env,
252 struct md_object *obj1, struct md_object *obj2,
255 /** \retval number of bytes actually read upon success */
256 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
257 const struct lu_rdpg *rdpg);
259 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
262 int (*moo_changelog)(const struct lu_env *env,
263 enum changelog_rec_type type,
264 enum changelog_rec_flags clf_flags,
265 struct md_device *m, const struct lu_fid *fid);
267 int (*moo_open)(const struct lu_env *env, struct md_object *obj,
268 u64 open_flags, struct md_op_spec*);
270 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
271 struct md_attr *ma, u64 open_flags);
273 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
275 int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
276 struct lustre_handle *lh,
277 struct ldlm_enqueue_info *einfo,
278 union ldlm_policy_data *policy);
279 int (*moo_object_unlock)(const struct lu_env *env,
280 struct md_object *obj,
281 struct ldlm_enqueue_info *einfo,
282 union ldlm_policy_data *policy);
284 int (*moo_invalidate)(const struct lu_env *env, struct md_object *obj);
286 * Trying to write to un-instantiated layout component.
288 * The caller should have held layout lock.
290 * This API can be extended to support every other layout changing
291 * operations, such as component {add,del,change}, layout swap,
292 * layout merge, etc. One of the benefits by doing this is that the MDT
293 * no longer needs to understand layout.
295 * However, layout creation, removal, and fetch should still use
296 * xattr_{get,set}() because they don't interpret layout on the
299 * \param[in] env execution environment
300 * \param[in] obj MD object
301 * \param[in] layout data structure to describe the changes to
302 * the MD object's layout
305 * \retval -ne error code
307 int (*moo_layout_change)(const struct lu_env *env,
308 struct md_object *obj,
309 struct md_layout_change *layout);
313 * Operations implemented for each directory object.
315 struct md_dir_operations {
316 int (*mdo_is_subdir)(const struct lu_env *env, struct md_object *obj,
317 const struct lu_fid *fid);
319 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
320 const struct lu_name *lname, struct lu_fid *fid,
321 struct md_op_spec *spec);
323 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
324 struct md_object *obj,
327 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
328 const struct lu_name *lname, struct md_object *child,
329 struct md_op_spec *spec,
332 /** This method is used for creating data object for this meta object*/
333 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
335 const struct md_op_spec *spec,
338 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
339 struct md_object *tpobj, const struct lu_fid *lf,
340 const struct lu_name *lsname, struct md_object *tobj,
341 const struct lu_name *ltname, struct md_attr *ma);
343 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
344 struct md_object *src_obj, const struct lu_name *lname,
347 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
348 struct md_object *cobj, const struct lu_name *lname,
349 struct md_attr *ma, int no_name);
351 int (*mdo_migrate)(const struct lu_env *env, struct md_object *pobj,
352 struct md_object *sobj, const struct lu_name *lname,
353 struct md_object *tobj, struct md_op_spec *spec,
357 struct md_device_operations {
358 /** meta-data device related handlers. */
359 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
362 const struct dt_device_param *(*mdo_dtconf_get)(const struct lu_env *e,
363 struct md_device *m);
365 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
366 struct obd_statfs *sfs);
368 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
369 struct md_device *m, int idx, void **h);
371 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
372 unsigned int cmd, int len, void *data);
376 struct lu_device md_lu_dev;
377 const struct md_device_operations *md_ops;
381 struct lu_object mo_lu;
382 const struct md_object_operations *mo_ops;
383 const struct md_dir_operations *mo_dir_ops;
386 static inline struct md_device *lu2md_dev(const struct lu_device *d)
388 LASSERT(IS_ERR(d) || lu_device_is_md(d));
389 return container_of_safe(d, struct md_device, md_lu_dev);
392 static inline struct lu_device *md2lu_dev(struct md_device *d)
394 return &d->md_lu_dev;
397 static inline struct md_object *lu2md(const struct lu_object *o)
399 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
400 return container_of_safe(o, struct md_object, mo_lu);
403 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
405 return lu_device_init(&md->md_lu_dev, t);
408 static inline void md_device_fini(struct md_device *md)
410 lu_device_fini(&md->md_lu_dev);
413 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
414 struct md_device *md,
415 const struct lu_fid *f)
417 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
422 static inline int mo_permission(const struct lu_env *env, struct md_object *p,
423 struct md_object *c, struct md_attr *at,
424 unsigned int may_mask)
426 LASSERT(c->mo_ops->moo_permission);
427 return c->mo_ops->moo_permission(env, p, c, at, may_mask);
430 static inline int mo_attr_get(const struct lu_env *env, struct md_object *m,
433 LASSERT(m->mo_ops->moo_attr_get);
434 return m->mo_ops->moo_attr_get(env, m, at);
437 static inline int mo_readlink(const struct lu_env *env,
441 LASSERT(m->mo_ops->moo_readlink);
442 return m->mo_ops->moo_readlink(env, m, buf);
445 static inline int mo_changelog(const struct lu_env *env,
446 enum changelog_rec_type type,
447 enum changelog_rec_flags clf_flags,
448 struct md_device *m, const struct lu_fid *fid)
450 struct lu_fid rootfid;
451 struct md_object *root;
454 rc = m->md_ops->mdo_root_get(env, m, &rootfid);
458 root = md_object_find_slice(env, m, &rootfid);
460 RETURN(PTR_ERR(root));
462 LASSERT(root->mo_ops->moo_changelog);
463 rc = root->mo_ops->moo_changelog(env, type, clf_flags, m, fid);
465 lu_object_put(env, &root->mo_lu);
470 static inline int mo_attr_set(const struct lu_env *env,
472 const struct md_attr *at)
474 LASSERT(m->mo_ops->moo_attr_set);
475 return m->mo_ops->moo_attr_set(env, m, at);
478 static inline int mo_xattr_get(const struct lu_env *env,
483 LASSERT(m->mo_ops->moo_xattr_get);
484 return m->mo_ops->moo_xattr_get(env, m, buf, name);
487 static inline int mo_xattr_del(const struct lu_env *env,
491 LASSERT(m->mo_ops->moo_xattr_del);
492 return m->mo_ops->moo_xattr_del(env, m, name);
495 static inline int mo_xattr_set(const struct lu_env *env,
497 const struct lu_buf *buf,
501 LASSERT(m->mo_ops->moo_xattr_set);
502 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
505 static inline int mo_xattr_list(const struct lu_env *env,
509 LASSERT(m->mo_ops->moo_xattr_list);
510 return m->mo_ops->moo_xattr_list(env, m, buf);
513 static inline int mo_invalidate(const struct lu_env *env, struct md_object *m)
515 LASSERT(m->mo_ops->moo_invalidate);
516 return m->mo_ops->moo_invalidate(env, m);
519 static inline int mo_layout_change(const struct lu_env *env,
521 struct md_layout_change *layout)
523 /* need instantiate objects which in the access range */
524 LASSERT(m->mo_ops->moo_layout_change);
525 return m->mo_ops->moo_layout_change(env, m, layout);
528 static inline int mo_swap_layouts(const struct lu_env *env,
529 struct md_object *o1,
530 struct md_object *o2, __u64 flags)
532 LASSERT(o1->mo_ops->moo_swap_layouts);
533 LASSERT(o2->mo_ops->moo_swap_layouts);
534 if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
536 return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
539 static inline int mo_open(const struct lu_env *env, struct md_object *m,
540 u64 open_flags, struct md_op_spec *spec)
542 LASSERT(m->mo_ops->moo_open);
543 return m->mo_ops->moo_open(env, m, open_flags, spec);
546 static inline int mo_close(const struct lu_env *env, struct md_object *m,
547 struct md_attr *ma, u64 open_flags)
549 LASSERT(m->mo_ops->moo_close);
550 return m->mo_ops->moo_close(env, m, ma, open_flags);
553 static inline int mo_readpage(const struct lu_env *env,
555 const struct lu_rdpg *rdpg)
557 LASSERT(m->mo_ops->moo_readpage);
558 return m->mo_ops->moo_readpage(env, m, rdpg);
561 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
563 LASSERT(m->mo_ops->moo_object_sync);
564 return m->mo_ops->moo_object_sync(env, m);
567 static inline int mo_object_lock(const struct lu_env *env,
569 struct lustre_handle *lh,
570 struct ldlm_enqueue_info *einfo,
571 union ldlm_policy_data *policy)
573 LASSERT(m->mo_ops->moo_object_lock);
574 return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
577 static inline int mo_object_unlock(const struct lu_env *env,
579 struct ldlm_enqueue_info *einfo,
580 union ldlm_policy_data *policy)
582 LASSERT(m->mo_ops->moo_object_unlock);
583 return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
586 static inline int mdo_lookup(const struct lu_env *env,
588 const struct lu_name *lname,
590 struct md_op_spec *spec)
592 LASSERT(p->mo_dir_ops->mdo_lookup);
593 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
596 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
597 struct md_object *mo,
600 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
602 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
605 static inline int mdo_create(const struct lu_env *env,
607 const struct lu_name *lchild_name,
609 struct md_op_spec *spc,
612 LASSERT(p->mo_dir_ops->mdo_create);
613 return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
616 static inline int mdo_create_data(const struct lu_env *env,
619 const struct md_op_spec *spec,
622 LASSERT(c->mo_dir_ops->mdo_create_data);
623 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
626 static inline int mdo_rename(const struct lu_env *env,
627 struct md_object *sp,
628 struct md_object *tp,
629 const struct lu_fid *lf,
630 const struct lu_name *lsname,
632 const struct lu_name *ltname,
635 LASSERT(tp->mo_dir_ops->mdo_rename);
636 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
640 static inline int mdo_migrate(const struct lu_env *env,
641 struct md_object *pobj,
642 struct md_object *sobj,
643 const struct lu_name *lname,
644 struct md_object *tobj,
645 struct md_op_spec *spec,
648 LASSERT(pobj->mo_dir_ops->mdo_migrate);
649 return pobj->mo_dir_ops->mdo_migrate(env, pobj, sobj, lname, tobj, spec,
653 static inline int mdo_is_subdir(const struct lu_env *env,
654 struct md_object *mo,
655 const struct lu_fid *fid)
657 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
658 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid);
661 static inline int mdo_link(const struct lu_env *env,
664 const struct lu_name *lname,
667 LASSERT(s->mo_dir_ops->mdo_link);
668 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
671 static inline int mdo_unlink(const struct lu_env *env,
674 const struct lu_name *lname,
675 struct md_attr *ma, int no_name)
677 LASSERT(p->mo_dir_ops->mdo_unlink);
678 return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
681 static inline int mdo_statfs(const struct lu_env *env,
683 struct obd_statfs *sfs)
685 LASSERT(m->md_ops->mdo_statfs);
686 return m->md_ops->mdo_statfs(env, m, sfs);
691 void lustre_som_swab(struct lustre_som_attrs *attrs);
692 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
693 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
712 __u32 uc_suppgids[2];
715 struct group_info *uc_ginfo;
716 struct md_identity *uc_identity;
717 char uc_jobid[LUSTRE_JOBID_SIZE];
719 bool uc_enable_audit;
720 int uc_rbac_file_perms:1;
721 int uc_rbac_dne_ops:1;
722 int uc_rbac_quota_ops:1;
723 int uc_rbac_byfid_ops:1;
724 int uc_rbac_chlg_ops:1;
725 int uc_rbac_fscrypt_admin:1;
728 struct lu_ucred *lu_ucred(const struct lu_env *env);
730 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
732 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
734 int lu_ucred_global_init(void);
736 void lu_ucred_global_fini(void);
739 #endif /* _LINUX_MD_OBJECT_H */