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;
185 struct layout_intent *mlc_intent;
186 struct lu_buf mlc_buf;
187 struct lustre_som_attrs mlc_som;
188 size_t mlc_resync_count;
189 __u32 *mlc_resync_ids;
192 union ldlm_policy_data;
194 * Operations implemented for each md object (both directory and leaf).
196 struct md_object_operations {
197 int (*moo_permission)(const struct lu_env *env,
198 struct md_object *pobj, struct md_object *cobj,
199 struct md_attr *attr, int mask);
201 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
202 struct md_attr *attr);
204 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
205 const struct md_attr *attr);
207 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
208 struct lu_buf *buf, const char *name);
210 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
213 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
214 const struct lu_buf *buf, const char *name,
217 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
220 /** This method is used to swap the layouts between 2 objects */
221 int (*moo_swap_layouts)(const struct lu_env *env,
222 struct md_object *obj1, struct md_object *obj2,
225 /** \retval number of bytes actually read upon success */
226 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
227 const struct lu_rdpg *rdpg);
229 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
232 int (*moo_changelog)(const struct lu_env *env,
233 enum changelog_rec_type type, int flags,
234 struct md_device *m, const struct lu_fid *fid);
236 int (*moo_open)(const struct lu_env *env,
237 struct md_object *obj, u64 open_flags);
239 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
240 struct md_attr *ma, u64 open_flags);
242 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
244 int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
245 struct lustre_handle *lh,
246 struct ldlm_enqueue_info *einfo,
247 union ldlm_policy_data *policy);
248 int (*moo_object_unlock)(const struct lu_env *env,
249 struct md_object *obj,
250 struct ldlm_enqueue_info *einfo,
251 union ldlm_policy_data *policy);
253 int (*moo_invalidate)(const struct lu_env *env, struct md_object *obj);
255 * Trying to write to un-instantiated layout component.
257 * The caller should have held layout lock.
259 * This API can be extended to support every other layout changing
260 * operations, such as component {add,del,change}, layout swap,
261 * layout merge, etc. One of the benefits by doing this is that the MDT
262 * no longer needs to understand layout.
264 * However, layout creation, removal, and fetch should still use
265 * xattr_{get,set}() because they don't interpret layout on the
268 * \param[in] env execution environment
269 * \param[in] obj MD object
270 * \param[in] layout data structure to describe the changes to
271 * the MD object's layout
274 * \retval -ne error code
276 int (*moo_layout_change)(const struct lu_env *env,
277 struct md_object *obj,
278 struct md_layout_change *layout);
282 * Operations implemented for each directory object.
284 struct md_dir_operations {
285 int (*mdo_is_subdir)(const struct lu_env *env, struct md_object *obj,
286 const struct lu_fid *fid);
288 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
289 const struct lu_name *lname, struct lu_fid *fid,
290 struct md_op_spec *spec);
292 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
293 struct md_object *obj,
296 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
297 const struct lu_name *lname, struct md_object *child,
298 struct md_op_spec *spec,
301 /** This method is used for creating data object for this meta object*/
302 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
304 const struct md_op_spec *spec,
307 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
308 struct md_object *tpobj, const struct lu_fid *lf,
309 const struct lu_name *lsname, struct md_object *tobj,
310 const struct lu_name *ltname, struct md_attr *ma);
312 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
313 struct md_object *src_obj, const struct lu_name *lname,
316 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
317 struct md_object *cobj, const struct lu_name *lname,
318 struct md_attr *ma, int no_name);
320 int (*mdo_migrate)(const struct lu_env *env, struct md_object *pobj,
321 struct md_object *sobj, const struct lu_name *lname,
322 struct md_object *tobj, struct md_op_spec *spec,
326 struct md_device_operations {
327 /** meta-data device related handlers. */
328 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
331 const struct dt_device_param *(*mdo_dtconf_get)(const struct lu_env *e,
332 struct md_device *m);
334 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
335 struct obd_statfs *sfs);
337 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
338 struct md_device *m, int idx, void **h);
340 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
341 unsigned int cmd, int len, void *data);
345 struct lu_device md_lu_dev;
346 const struct md_device_operations *md_ops;
350 struct lu_object mo_lu;
351 const struct md_object_operations *mo_ops;
352 const struct md_dir_operations *mo_dir_ops;
355 static inline struct md_device *lu2md_dev(const struct lu_device *d)
357 LASSERT(IS_ERR(d) || lu_device_is_md(d));
358 return container_of0(d, struct md_device, md_lu_dev);
361 static inline struct lu_device *md2lu_dev(struct md_device *d)
363 return &d->md_lu_dev;
366 static inline struct md_object *lu2md(const struct lu_object *o)
368 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
369 return container_of0(o, struct md_object, mo_lu);
372 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
374 return lu_device_init(&md->md_lu_dev, t);
377 static inline void md_device_fini(struct md_device *md)
379 lu_device_fini(&md->md_lu_dev);
382 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
383 struct md_device *md,
384 const struct lu_fid *f)
386 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
391 static inline int mo_permission(const struct lu_env *env, struct md_object *p,
392 struct md_object *c, struct md_attr *at,
395 LASSERT(c->mo_ops->moo_permission);
396 return c->mo_ops->moo_permission(env, p, c, at, mask);
399 static inline int mo_attr_get(const struct lu_env *env, struct md_object *m,
402 LASSERT(m->mo_ops->moo_attr_get);
403 return m->mo_ops->moo_attr_get(env, m, at);
406 static inline int mo_readlink(const struct lu_env *env,
410 LASSERT(m->mo_ops->moo_readlink);
411 return m->mo_ops->moo_readlink(env, m, buf);
414 static inline int mo_changelog(const struct lu_env *env,
415 enum changelog_rec_type type,
416 int flags, struct md_device *m,
417 const struct lu_fid *fid)
419 struct lu_fid rootfid;
420 struct md_object *root;
423 rc = m->md_ops->mdo_root_get(env, m, &rootfid);
427 root = md_object_find_slice(env, m, &rootfid);
429 RETURN(PTR_ERR(root));
431 LASSERT(root->mo_ops->moo_changelog);
432 rc = root->mo_ops->moo_changelog(env, type, flags, m, fid);
434 lu_object_put(env, &root->mo_lu);
439 static inline int mo_attr_set(const struct lu_env *env,
441 const struct md_attr *at)
443 LASSERT(m->mo_ops->moo_attr_set);
444 return m->mo_ops->moo_attr_set(env, m, at);
447 static inline int mo_xattr_get(const struct lu_env *env,
452 LASSERT(m->mo_ops->moo_xattr_get);
453 return m->mo_ops->moo_xattr_get(env, m, buf, name);
456 static inline int mo_xattr_del(const struct lu_env *env,
460 LASSERT(m->mo_ops->moo_xattr_del);
461 return m->mo_ops->moo_xattr_del(env, m, name);
464 static inline int mo_xattr_set(const struct lu_env *env,
466 const struct lu_buf *buf,
470 LASSERT(m->mo_ops->moo_xattr_set);
471 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
474 static inline int mo_xattr_list(const struct lu_env *env,
478 LASSERT(m->mo_ops->moo_xattr_list);
479 return m->mo_ops->moo_xattr_list(env, m, buf);
482 static inline int mo_invalidate(const struct lu_env *env, struct md_object *m)
484 LASSERT(m->mo_ops->moo_invalidate);
485 return m->mo_ops->moo_invalidate(env, m);
488 static inline int mo_layout_change(const struct lu_env *env,
490 struct md_layout_change *layout)
492 /* need instantiate objects which in the access range */
493 LASSERT(m->mo_ops->moo_layout_change);
494 return m->mo_ops->moo_layout_change(env, m, layout);
497 static inline int mo_swap_layouts(const struct lu_env *env,
498 struct md_object *o1,
499 struct md_object *o2, __u64 flags)
501 LASSERT(o1->mo_ops->moo_swap_layouts);
502 LASSERT(o2->mo_ops->moo_swap_layouts);
503 if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
505 return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
508 static inline int mo_open(const struct lu_env *env, struct md_object *m,
511 LASSERT(m->mo_ops->moo_open);
512 return m->mo_ops->moo_open(env, m, open_flags);
515 static inline int mo_close(const struct lu_env *env, struct md_object *m,
516 struct md_attr *ma, u64 open_flags)
518 LASSERT(m->mo_ops->moo_close);
519 return m->mo_ops->moo_close(env, m, ma, open_flags);
522 static inline int mo_readpage(const struct lu_env *env,
524 const struct lu_rdpg *rdpg)
526 LASSERT(m->mo_ops->moo_readpage);
527 return m->mo_ops->moo_readpage(env, m, rdpg);
530 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
532 LASSERT(m->mo_ops->moo_object_sync);
533 return m->mo_ops->moo_object_sync(env, m);
536 static inline int mo_object_lock(const struct lu_env *env,
538 struct lustre_handle *lh,
539 struct ldlm_enqueue_info *einfo,
540 union ldlm_policy_data *policy)
542 LASSERT(m->mo_ops->moo_object_lock);
543 return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
546 static inline int mo_object_unlock(const struct lu_env *env,
548 struct ldlm_enqueue_info *einfo,
549 union ldlm_policy_data *policy)
551 LASSERT(m->mo_ops->moo_object_unlock);
552 return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
555 static inline int mdo_lookup(const struct lu_env *env,
557 const struct lu_name *lname,
559 struct md_op_spec *spec)
561 LASSERT(p->mo_dir_ops->mdo_lookup);
562 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
565 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
566 struct md_object *mo,
569 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
571 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
574 static inline int mdo_create(const struct lu_env *env,
576 const struct lu_name *lchild_name,
578 struct md_op_spec *spc,
581 LASSERT(p->mo_dir_ops->mdo_create);
582 return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
585 static inline int mdo_create_data(const struct lu_env *env,
588 const struct md_op_spec *spec,
591 LASSERT(c->mo_dir_ops->mdo_create_data);
592 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
595 static inline int mdo_rename(const struct lu_env *env,
596 struct md_object *sp,
597 struct md_object *tp,
598 const struct lu_fid *lf,
599 const struct lu_name *lsname,
601 const struct lu_name *ltname,
604 LASSERT(tp->mo_dir_ops->mdo_rename);
605 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
609 static inline int mdo_migrate(const struct lu_env *env,
610 struct md_object *pobj,
611 struct md_object *sobj,
612 const struct lu_name *lname,
613 struct md_object *tobj,
614 struct md_op_spec *spec,
617 LASSERT(pobj->mo_dir_ops->mdo_migrate);
618 return pobj->mo_dir_ops->mdo_migrate(env, pobj, sobj, lname, tobj, spec,
622 static inline int mdo_is_subdir(const struct lu_env *env,
623 struct md_object *mo,
624 const struct lu_fid *fid)
626 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
627 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid);
630 static inline int mdo_link(const struct lu_env *env,
633 const struct lu_name *lname,
636 LASSERT(s->mo_dir_ops->mdo_link);
637 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
640 static inline int mdo_unlink(const struct lu_env *env,
643 const struct lu_name *lname,
644 struct md_attr *ma, int no_name)
646 LASSERT(p->mo_dir_ops->mdo_unlink);
647 return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
650 static inline int mdo_statfs(const struct lu_env *env,
652 struct obd_statfs *sfs)
654 LASSERT(m->md_ops->mdo_statfs);
655 return m->md_ops->mdo_statfs(env, m, sfs);
659 * Used in MDD/OUT layer for object lock rule
661 enum mdd_object_role {
671 void lustre_som_swab(struct lustre_som_attrs *attrs);
672 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
673 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
692 __u32 uc_suppgids[2];
695 struct group_info *uc_ginfo;
696 struct md_identity *uc_identity;
697 char uc_jobid[LUSTRE_JOBID_SIZE];
699 bool uc_enable_audit;
702 struct lu_ucred *lu_ucred(const struct lu_env *env);
704 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
706 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
708 int lu_ucred_global_init(void);
710 void lu_ucred_global_fini(void);
712 #define md_cap_t(x) (x)
714 #define MD_CAP_TO_MASK(x) (1 << (x))
716 #define md_cap_raised(c, flag) (md_cap_t(c) & MD_CAP_TO_MASK(flag))
718 /* capable() is copied from linux kernel! */
719 static inline int md_capable(struct lu_ucred *uc, cfs_cap_t cap)
721 if (md_cap_raised(uc->uc_cap, cap))
727 #endif /* _LINUX_MD_OBJECT_H */