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;
139 /** Additional parameters for create */
142 /** symlink target */
143 const char *sp_symname;
144 /** eadata for regular files */
151 /** Open flags from client: such as MDS_OPEN_CREAT, and others. */
154 /* File security context for creates. */
155 const char *sp_cr_file_secctx_name; /* (security) xattr name */
156 void *sp_cr_file_secctx; /* xattr value */
157 size_t sp_cr_file_secctx_size; /* xattr value size */
159 /** don't create lov objects or llog cookie - this replay */
160 unsigned int no_create:1,
161 sp_cr_lookup:1, /* do lookup sanity check or not. */
162 sp_rm_entry:1, /* only remove name entry */
163 sp_permitted:1, /* do not check permission */
164 sp_migrate_close:1; /* close the file during migrate */
165 /** Current lock mode for parent dir where create is performing. */
166 mdl_mode_t sp_cr_mode;
168 /** to create directory */
169 const struct dt_index_features *sp_feat;
174 MD_LAYOUT_WRITE, /* FLR: write the file */
175 MD_LAYOUT_RESYNC, /* FLR: resync starts */
176 MD_LAYOUT_RESYNC_DONE, /* FLR: resync done */
180 * Parameters for layout change API.
182 struct md_layout_change {
183 enum md_layout_opc mlc_opc;
184 struct layout_intent *mlc_intent;
185 struct lu_buf mlc_buf;
186 struct lustre_som_attrs mlc_som;
187 size_t mlc_resync_count;
188 __u32 *mlc_resync_ids;
191 union ldlm_policy_data;
193 * Operations implemented for each md object (both directory and leaf).
195 struct md_object_operations {
196 int (*moo_permission)(const struct lu_env *env,
197 struct md_object *pobj, struct md_object *cobj,
198 struct md_attr *attr, int mask);
200 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
201 struct md_attr *attr);
203 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
204 const struct md_attr *attr);
206 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
207 struct lu_buf *buf, const char *name);
209 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
212 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
213 const struct lu_buf *buf, const char *name,
216 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
219 /** This method is used to swap the layouts between 2 objects */
220 int (*moo_swap_layouts)(const struct lu_env *env,
221 struct md_object *obj1, struct md_object *obj2,
224 /** \retval number of bytes actually read upon success */
225 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
226 const struct lu_rdpg *rdpg);
228 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
231 int (*moo_changelog)(const struct lu_env *env,
232 enum changelog_rec_type type, int flags,
233 struct md_device *m, const struct lu_fid *fid);
235 int (*moo_open)(const struct lu_env *env,
236 struct md_object *obj, u64 open_flags);
238 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
239 struct md_attr *ma, u64 open_flags);
241 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
243 int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
244 struct lustre_handle *lh,
245 struct ldlm_enqueue_info *einfo,
246 union ldlm_policy_data *policy);
247 int (*moo_object_unlock)(const struct lu_env *env,
248 struct md_object *obj,
249 struct ldlm_enqueue_info *einfo,
250 union ldlm_policy_data *policy);
252 int (*moo_invalidate)(const struct lu_env *env, struct md_object *obj);
254 * Trying to write to un-instantiated layout component.
256 * The caller should have held layout lock.
258 * This API can be extended to support every other layout changing
259 * operations, such as component {add,del,change}, layout swap,
260 * layout merge, etc. One of the benefits by doing this is that the MDT
261 * no longer needs to understand layout.
263 * However, layout creation, removal, and fetch should still use
264 * xattr_{get,set}() because they don't interpret layout on the
267 * \param[in] env execution environment
268 * \param[in] obj MD object
269 * \param[in] layout data structure to describe the changes to
270 * the MD object's layout
273 * \retval -ne error code
275 int (*moo_layout_change)(const struct lu_env *env,
276 struct md_object *obj,
277 struct md_layout_change *layout);
281 * Operations implemented for each directory object.
283 struct md_dir_operations {
284 int (*mdo_is_subdir)(const struct lu_env *env, struct md_object *obj,
285 const struct lu_fid *fid);
287 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
288 const struct lu_name *lname, struct lu_fid *fid,
289 struct md_op_spec *spec);
291 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
292 struct md_object *obj,
295 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
296 const struct lu_name *lname, struct md_object *child,
297 struct md_op_spec *spec,
300 /** This method is used for creating data object for this meta object*/
301 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
303 const struct md_op_spec *spec,
306 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
307 struct md_object *tpobj, const struct lu_fid *lf,
308 const struct lu_name *lsname, struct md_object *tobj,
309 const struct lu_name *ltname, struct md_attr *ma);
311 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
312 struct md_object *src_obj, const struct lu_name *lname,
315 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
316 struct md_object *cobj, const struct lu_name *lname,
317 struct md_attr *ma, int no_name);
319 int (*mdo_migrate)(const struct lu_env *env, struct md_object *pobj,
320 struct md_object *sobj, const struct lu_name *lname,
321 struct md_object *tobj, struct md_op_spec *spec,
325 struct md_device_operations {
326 /** meta-data device related handlers. */
327 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
330 const struct dt_device_param *(*mdo_dtconf_get)(const struct lu_env *e,
331 struct md_device *m);
333 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
334 struct obd_statfs *sfs);
336 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
337 struct md_device *m, int idx, void **h);
339 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
340 unsigned int cmd, int len, void *data);
344 struct lu_device md_lu_dev;
345 const struct md_device_operations *md_ops;
349 struct lu_object mo_lu;
350 const struct md_object_operations *mo_ops;
351 const struct md_dir_operations *mo_dir_ops;
354 static inline struct md_device *lu2md_dev(const struct lu_device *d)
356 LASSERT(IS_ERR(d) || lu_device_is_md(d));
357 return container_of0(d, struct md_device, md_lu_dev);
360 static inline struct lu_device *md2lu_dev(struct md_device *d)
362 return &d->md_lu_dev;
365 static inline struct md_object *lu2md(const struct lu_object *o)
367 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
368 return container_of0(o, struct md_object, mo_lu);
371 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
373 return lu_device_init(&md->md_lu_dev, t);
376 static inline void md_device_fini(struct md_device *md)
378 lu_device_fini(&md->md_lu_dev);
381 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
382 struct md_device *md,
383 const struct lu_fid *f)
385 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
390 static inline int mo_permission(const struct lu_env *env, struct md_object *p,
391 struct md_object *c, struct md_attr *at,
394 LASSERT(c->mo_ops->moo_permission);
395 return c->mo_ops->moo_permission(env, p, c, at, mask);
398 static inline int mo_attr_get(const struct lu_env *env, struct md_object *m,
401 LASSERT(m->mo_ops->moo_attr_get);
402 return m->mo_ops->moo_attr_get(env, m, at);
405 static inline int mo_readlink(const struct lu_env *env,
409 LASSERT(m->mo_ops->moo_readlink);
410 return m->mo_ops->moo_readlink(env, m, buf);
413 static inline int mo_changelog(const struct lu_env *env,
414 enum changelog_rec_type type,
415 int flags, struct md_device *m,
416 const struct lu_fid *fid)
418 struct lu_fid rootfid;
419 struct md_object *root;
422 rc = m->md_ops->mdo_root_get(env, m, &rootfid);
426 root = md_object_find_slice(env, m, &rootfid);
428 RETURN(PTR_ERR(root));
430 LASSERT(root->mo_ops->moo_changelog);
431 rc = root->mo_ops->moo_changelog(env, type, flags, m, fid);
433 lu_object_put(env, &root->mo_lu);
438 static inline int mo_attr_set(const struct lu_env *env,
440 const struct md_attr *at)
442 LASSERT(m->mo_ops->moo_attr_set);
443 return m->mo_ops->moo_attr_set(env, m, at);
446 static inline int mo_xattr_get(const struct lu_env *env,
451 LASSERT(m->mo_ops->moo_xattr_get);
452 return m->mo_ops->moo_xattr_get(env, m, buf, name);
455 static inline int mo_xattr_del(const struct lu_env *env,
459 LASSERT(m->mo_ops->moo_xattr_del);
460 return m->mo_ops->moo_xattr_del(env, m, name);
463 static inline int mo_xattr_set(const struct lu_env *env,
465 const struct lu_buf *buf,
469 LASSERT(m->mo_ops->moo_xattr_set);
470 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
473 static inline int mo_xattr_list(const struct lu_env *env,
477 LASSERT(m->mo_ops->moo_xattr_list);
478 return m->mo_ops->moo_xattr_list(env, m, buf);
481 static inline int mo_invalidate(const struct lu_env *env, struct md_object *m)
483 LASSERT(m->mo_ops->moo_invalidate);
484 return m->mo_ops->moo_invalidate(env, m);
487 static inline int mo_layout_change(const struct lu_env *env,
489 struct md_layout_change *layout)
491 /* need instantiate objects which in the access range */
492 LASSERT(m->mo_ops->moo_layout_change);
493 return m->mo_ops->moo_layout_change(env, m, layout);
496 static inline int mo_swap_layouts(const struct lu_env *env,
497 struct md_object *o1,
498 struct md_object *o2, __u64 flags)
500 LASSERT(o1->mo_ops->moo_swap_layouts);
501 LASSERT(o2->mo_ops->moo_swap_layouts);
502 if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
504 return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
507 static inline int mo_open(const struct lu_env *env, struct md_object *m,
510 LASSERT(m->mo_ops->moo_open);
511 return m->mo_ops->moo_open(env, m, open_flags);
514 static inline int mo_close(const struct lu_env *env, struct md_object *m,
515 struct md_attr *ma, u64 open_flags)
517 LASSERT(m->mo_ops->moo_close);
518 return m->mo_ops->moo_close(env, m, ma, open_flags);
521 static inline int mo_readpage(const struct lu_env *env,
523 const struct lu_rdpg *rdpg)
525 LASSERT(m->mo_ops->moo_readpage);
526 return m->mo_ops->moo_readpage(env, m, rdpg);
529 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
531 LASSERT(m->mo_ops->moo_object_sync);
532 return m->mo_ops->moo_object_sync(env, m);
535 static inline int mo_object_lock(const struct lu_env *env,
537 struct lustre_handle *lh,
538 struct ldlm_enqueue_info *einfo,
539 union ldlm_policy_data *policy)
541 LASSERT(m->mo_ops->moo_object_lock);
542 return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
545 static inline int mo_object_unlock(const struct lu_env *env,
547 struct ldlm_enqueue_info *einfo,
548 union ldlm_policy_data *policy)
550 LASSERT(m->mo_ops->moo_object_unlock);
551 return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
554 static inline int mdo_lookup(const struct lu_env *env,
556 const struct lu_name *lname,
558 struct md_op_spec *spec)
560 LASSERT(p->mo_dir_ops->mdo_lookup);
561 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
564 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
565 struct md_object *mo,
568 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
570 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
573 static inline int mdo_create(const struct lu_env *env,
575 const struct lu_name *lchild_name,
577 struct md_op_spec *spc,
580 LASSERT(p->mo_dir_ops->mdo_create);
581 return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
584 static inline int mdo_create_data(const struct lu_env *env,
587 const struct md_op_spec *spec,
590 LASSERT(c->mo_dir_ops->mdo_create_data);
591 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
594 static inline int mdo_rename(const struct lu_env *env,
595 struct md_object *sp,
596 struct md_object *tp,
597 const struct lu_fid *lf,
598 const struct lu_name *lsname,
600 const struct lu_name *ltname,
603 LASSERT(tp->mo_dir_ops->mdo_rename);
604 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
608 static inline int mdo_migrate(const struct lu_env *env,
609 struct md_object *pobj,
610 struct md_object *sobj,
611 const struct lu_name *lname,
612 struct md_object *tobj,
613 struct md_op_spec *spec,
616 LASSERT(pobj->mo_dir_ops->mdo_migrate);
617 return pobj->mo_dir_ops->mdo_migrate(env, pobj, sobj, lname, tobj, spec,
621 static inline int mdo_is_subdir(const struct lu_env *env,
622 struct md_object *mo,
623 const struct lu_fid *fid)
625 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
626 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid);
629 static inline int mdo_link(const struct lu_env *env,
632 const struct lu_name *lname,
635 LASSERT(s->mo_dir_ops->mdo_link);
636 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
639 static inline int mdo_unlink(const struct lu_env *env,
642 const struct lu_name *lname,
643 struct md_attr *ma, int no_name)
645 LASSERT(p->mo_dir_ops->mdo_unlink);
646 return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
649 static inline int mdo_statfs(const struct lu_env *env,
651 struct obd_statfs *sfs)
653 LASSERT(m->md_ops->mdo_statfs);
654 return m->md_ops->mdo_statfs(env, m, sfs);
658 * Used in MDD/OUT layer for object lock rule
660 enum mdd_object_role {
670 void lustre_som_swab(struct lustre_som_attrs *attrs);
671 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
672 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
691 __u32 uc_suppgids[2];
694 struct group_info *uc_ginfo;
695 struct md_identity *uc_identity;
696 char uc_jobid[LUSTRE_JOBID_SIZE];
698 bool uc_enable_audit;
701 struct lu_ucred *lu_ucred(const struct lu_env *env);
703 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
705 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
707 int lu_ucred_global_init(void);
709 void lu_ucred_global_fini(void);
711 #define md_cap_t(x) (x)
713 #define MD_CAP_TO_MASK(x) (1 << (x))
715 #define md_cap_raised(c, flag) (md_cap_t(c) & MD_CAP_TO_MASK(flag))
717 /* capable() is copied from linux kernel! */
718 static inline int md_capable(struct lu_ucred *uc, cfs_cap_t cap)
720 if (md_cap_raised(uc->uc_cap, cap))
726 #endif /* _LINUX_MD_OBJECT_H */