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 */
78 MA_FORCE_LOG = 1 << 10, /* forced close logged in mdt_mfd_close */
95 MDT_REG_LOCK = (1 << 0),
96 MDT_PDO_LOCK = (1 << 1)
99 /* lfs rgetfacl permission check */
100 #define MAY_RGETFACL (1 << 14)
102 /* memory structure for hsm attributes
103 * for fields description see the on disk structure hsm_attrs
104 * which is defined in lustre_idl.h
114 /* memory structure for SOM attributes
115 * for fields description see the on disk structure som_attrs
116 * which is defined in lustre_idl.h
128 struct lu_attr ma_attr;
129 struct lu_fid ma_pfid;
130 struct md_hsm ma_hsm;
131 struct md_som ma_som;
132 struct lov_mds_md *ma_lmm;
133 union lmv_mds_md *ma_lmv;
134 struct lmv_user_md *ma_default_lmv;
138 int ma_default_lmv_size;
140 int ma_enable_chprojid_gid;
143 /** Additional parameters for create */
146 /** symlink target */
147 const char *sp_symname;
148 /** eadata for regular files */
155 /** Open flags from client: such as MDS_OPEN_CREAT, and others. */
158 /* File security context for creates. */
159 const char *sp_cr_file_secctx_name; /* (security) xattr name */
160 void *sp_cr_file_secctx; /* xattr value */
161 size_t sp_cr_file_secctx_size; /* xattr value size */
163 /* Archive ID used for auto PCC attach when create newly files. */
166 /** don't create lov objects or llog cookie - this replay */
167 unsigned int no_create:1,
168 sp_cr_lookup:1, /* do lookup sanity check or not. */
169 sp_rm_entry:1, /* only remove name entry */
170 sp_permitted:1, /* do not check permission */
171 sp_migrate_close:1; /* close the file during migrate */
172 /** Current lock mode for parent dir where create is performing. */
173 mdl_mode_t sp_cr_mode;
175 /** to create directory */
176 const struct dt_index_features *sp_feat;
181 MD_LAYOUT_WRITE, /* FLR: write the file */
182 MD_LAYOUT_RESYNC, /* FLR: resync starts */
183 MD_LAYOUT_RESYNC_DONE, /* FLR: resync done */
187 * Parameters for layout change API.
189 struct md_layout_change {
190 enum md_layout_opc mlc_opc;
192 struct layout_intent *mlc_intent;
193 struct lu_buf mlc_buf;
194 struct lustre_som_attrs mlc_som;
195 size_t mlc_resync_count;
196 __u32 *mlc_resync_ids;
199 union ldlm_policy_data;
201 * Operations implemented for each md object (both directory and leaf).
203 struct md_object_operations {
204 int (*moo_permission)(const struct lu_env *env,
205 struct md_object *pobj, struct md_object *cobj,
206 struct md_attr *attr, int mask);
208 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
209 struct md_attr *attr);
211 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
212 const struct md_attr *attr);
214 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
215 struct lu_buf *buf, const char *name);
217 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
220 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
221 const struct lu_buf *buf, const char *name,
224 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
227 /** This method is used to swap the layouts between 2 objects */
228 int (*moo_swap_layouts)(const struct lu_env *env,
229 struct md_object *obj1, struct md_object *obj2,
232 /** \retval number of bytes actually read upon success */
233 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
234 const struct lu_rdpg *rdpg);
236 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
239 int (*moo_changelog)(const struct lu_env *env,
240 enum changelog_rec_type type,
241 enum changelog_rec_flags clf_flags,
242 struct md_device *m, const struct lu_fid *fid);
244 int (*moo_open)(const struct lu_env *env, struct md_object *obj,
245 u64 open_flags, struct md_op_spec*);
247 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
248 struct md_attr *ma, u64 open_flags);
250 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
252 int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
253 struct lustre_handle *lh,
254 struct ldlm_enqueue_info *einfo,
255 union ldlm_policy_data *policy);
256 int (*moo_object_unlock)(const struct lu_env *env,
257 struct md_object *obj,
258 struct ldlm_enqueue_info *einfo,
259 union ldlm_policy_data *policy);
261 int (*moo_invalidate)(const struct lu_env *env, struct md_object *obj);
263 * Trying to write to un-instantiated layout component.
265 * The caller should have held layout lock.
267 * This API can be extended to support every other layout changing
268 * operations, such as component {add,del,change}, layout swap,
269 * layout merge, etc. One of the benefits by doing this is that the MDT
270 * no longer needs to understand layout.
272 * However, layout creation, removal, and fetch should still use
273 * xattr_{get,set}() because they don't interpret layout on the
276 * \param[in] env execution environment
277 * \param[in] obj MD object
278 * \param[in] layout data structure to describe the changes to
279 * the MD object's layout
282 * \retval -ne error code
284 int (*moo_layout_change)(const struct lu_env *env,
285 struct md_object *obj,
286 struct md_layout_change *layout);
290 * Operations implemented for each directory object.
292 struct md_dir_operations {
293 int (*mdo_is_subdir)(const struct lu_env *env, struct md_object *obj,
294 const struct lu_fid *fid);
296 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
297 const struct lu_name *lname, struct lu_fid *fid,
298 struct md_op_spec *spec);
300 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
301 struct md_object *obj,
304 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
305 const struct lu_name *lname, struct md_object *child,
306 struct md_op_spec *spec,
309 /** This method is used for creating data object for this meta object*/
310 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
312 const struct md_op_spec *spec,
315 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
316 struct md_object *tpobj, const struct lu_fid *lf,
317 const struct lu_name *lsname, struct md_object *tobj,
318 const struct lu_name *ltname, struct md_attr *ma);
320 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
321 struct md_object *src_obj, const struct lu_name *lname,
324 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
325 struct md_object *cobj, const struct lu_name *lname,
326 struct md_attr *ma, int no_name);
328 int (*mdo_migrate)(const struct lu_env *env, struct md_object *pobj,
329 struct md_object *sobj, const struct lu_name *lname,
330 struct md_object *tobj, struct md_op_spec *spec,
334 struct md_device_operations {
335 /** meta-data device related handlers. */
336 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
339 const struct dt_device_param *(*mdo_dtconf_get)(const struct lu_env *e,
340 struct md_device *m);
342 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
343 struct obd_statfs *sfs);
345 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
346 struct md_device *m, int idx, void **h);
348 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
349 unsigned int cmd, int len, void *data);
353 struct lu_device md_lu_dev;
354 const struct md_device_operations *md_ops;
358 struct lu_object mo_lu;
359 const struct md_object_operations *mo_ops;
360 const struct md_dir_operations *mo_dir_ops;
363 static inline struct md_device *lu2md_dev(const struct lu_device *d)
365 LASSERT(IS_ERR(d) || lu_device_is_md(d));
366 return container_of0(d, struct md_device, md_lu_dev);
369 static inline struct lu_device *md2lu_dev(struct md_device *d)
371 return &d->md_lu_dev;
374 static inline struct md_object *lu2md(const struct lu_object *o)
376 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
377 return container_of0(o, struct md_object, mo_lu);
380 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
382 return lu_device_init(&md->md_lu_dev, t);
385 static inline void md_device_fini(struct md_device *md)
387 lu_device_fini(&md->md_lu_dev);
390 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
391 struct md_device *md,
392 const struct lu_fid *f)
394 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
399 static inline int mo_permission(const struct lu_env *env, struct md_object *p,
400 struct md_object *c, struct md_attr *at,
403 LASSERT(c->mo_ops->moo_permission);
404 return c->mo_ops->moo_permission(env, p, c, at, mask);
407 static inline int mo_attr_get(const struct lu_env *env, struct md_object *m,
410 LASSERT(m->mo_ops->moo_attr_get);
411 return m->mo_ops->moo_attr_get(env, m, at);
414 static inline int mo_readlink(const struct lu_env *env,
418 LASSERT(m->mo_ops->moo_readlink);
419 return m->mo_ops->moo_readlink(env, m, buf);
422 static inline int mo_changelog(const struct lu_env *env,
423 enum changelog_rec_type type,
424 enum changelog_rec_flags clf_flags,
425 struct md_device *m, const struct lu_fid *fid)
427 struct lu_fid rootfid;
428 struct md_object *root;
431 rc = m->md_ops->mdo_root_get(env, m, &rootfid);
435 root = md_object_find_slice(env, m, &rootfid);
437 RETURN(PTR_ERR(root));
439 LASSERT(root->mo_ops->moo_changelog);
440 rc = root->mo_ops->moo_changelog(env, type, clf_flags, m, fid);
442 lu_object_put(env, &root->mo_lu);
447 static inline int mo_attr_set(const struct lu_env *env,
449 const struct md_attr *at)
451 LASSERT(m->mo_ops->moo_attr_set);
452 return m->mo_ops->moo_attr_set(env, m, at);
455 static inline int mo_xattr_get(const struct lu_env *env,
460 LASSERT(m->mo_ops->moo_xattr_get);
461 return m->mo_ops->moo_xattr_get(env, m, buf, name);
464 static inline int mo_xattr_del(const struct lu_env *env,
468 LASSERT(m->mo_ops->moo_xattr_del);
469 return m->mo_ops->moo_xattr_del(env, m, name);
472 static inline int mo_xattr_set(const struct lu_env *env,
474 const struct lu_buf *buf,
478 LASSERT(m->mo_ops->moo_xattr_set);
479 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
482 static inline int mo_xattr_list(const struct lu_env *env,
486 LASSERT(m->mo_ops->moo_xattr_list);
487 return m->mo_ops->moo_xattr_list(env, m, buf);
490 static inline int mo_invalidate(const struct lu_env *env, struct md_object *m)
492 LASSERT(m->mo_ops->moo_invalidate);
493 return m->mo_ops->moo_invalidate(env, m);
496 static inline int mo_layout_change(const struct lu_env *env,
498 struct md_layout_change *layout)
500 /* need instantiate objects which in the access range */
501 LASSERT(m->mo_ops->moo_layout_change);
502 return m->mo_ops->moo_layout_change(env, m, layout);
505 static inline int mo_swap_layouts(const struct lu_env *env,
506 struct md_object *o1,
507 struct md_object *o2, __u64 flags)
509 LASSERT(o1->mo_ops->moo_swap_layouts);
510 LASSERT(o2->mo_ops->moo_swap_layouts);
511 if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
513 return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
516 static inline int mo_open(const struct lu_env *env, struct md_object *m,
517 u64 open_flags, struct md_op_spec *spec)
519 LASSERT(m->mo_ops->moo_open);
520 return m->mo_ops->moo_open(env, m, open_flags, spec);
523 static inline int mo_close(const struct lu_env *env, struct md_object *m,
524 struct md_attr *ma, u64 open_flags)
526 LASSERT(m->mo_ops->moo_close);
527 return m->mo_ops->moo_close(env, m, ma, open_flags);
530 static inline int mo_readpage(const struct lu_env *env,
532 const struct lu_rdpg *rdpg)
534 LASSERT(m->mo_ops->moo_readpage);
535 return m->mo_ops->moo_readpage(env, m, rdpg);
538 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
540 LASSERT(m->mo_ops->moo_object_sync);
541 return m->mo_ops->moo_object_sync(env, m);
544 static inline int mo_object_lock(const struct lu_env *env,
546 struct lustre_handle *lh,
547 struct ldlm_enqueue_info *einfo,
548 union ldlm_policy_data *policy)
550 LASSERT(m->mo_ops->moo_object_lock);
551 return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
554 static inline int mo_object_unlock(const struct lu_env *env,
556 struct ldlm_enqueue_info *einfo,
557 union ldlm_policy_data *policy)
559 LASSERT(m->mo_ops->moo_object_unlock);
560 return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
563 static inline int mdo_lookup(const struct lu_env *env,
565 const struct lu_name *lname,
567 struct md_op_spec *spec)
569 LASSERT(p->mo_dir_ops->mdo_lookup);
570 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
573 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
574 struct md_object *mo,
577 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
579 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
582 static inline int mdo_create(const struct lu_env *env,
584 const struct lu_name *lchild_name,
586 struct md_op_spec *spc,
589 LASSERT(p->mo_dir_ops->mdo_create);
590 return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
593 static inline int mdo_create_data(const struct lu_env *env,
596 const struct md_op_spec *spec,
599 LASSERT(c->mo_dir_ops->mdo_create_data);
600 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
603 static inline int mdo_rename(const struct lu_env *env,
604 struct md_object *sp,
605 struct md_object *tp,
606 const struct lu_fid *lf,
607 const struct lu_name *lsname,
609 const struct lu_name *ltname,
612 LASSERT(tp->mo_dir_ops->mdo_rename);
613 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
617 static inline int mdo_migrate(const struct lu_env *env,
618 struct md_object *pobj,
619 struct md_object *sobj,
620 const struct lu_name *lname,
621 struct md_object *tobj,
622 struct md_op_spec *spec,
625 LASSERT(pobj->mo_dir_ops->mdo_migrate);
626 return pobj->mo_dir_ops->mdo_migrate(env, pobj, sobj, lname, tobj, spec,
630 static inline int mdo_is_subdir(const struct lu_env *env,
631 struct md_object *mo,
632 const struct lu_fid *fid)
634 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
635 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid);
638 static inline int mdo_link(const struct lu_env *env,
641 const struct lu_name *lname,
644 LASSERT(s->mo_dir_ops->mdo_link);
645 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
648 static inline int mdo_unlink(const struct lu_env *env,
651 const struct lu_name *lname,
652 struct md_attr *ma, int no_name)
654 LASSERT(p->mo_dir_ops->mdo_unlink);
655 return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
658 static inline int mdo_statfs(const struct lu_env *env,
660 struct obd_statfs *sfs)
662 LASSERT(m->md_ops->mdo_statfs);
663 return m->md_ops->mdo_statfs(env, m, sfs);
668 void lustre_som_swab(struct lustre_som_attrs *attrs);
669 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
670 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
689 __u32 uc_suppgids[2];
692 struct group_info *uc_ginfo;
693 struct md_identity *uc_identity;
694 char uc_jobid[LUSTRE_JOBID_SIZE];
696 bool uc_enable_audit;
699 struct lu_ucred *lu_ucred(const struct lu_env *env);
701 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
703 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
705 int lu_ucred_global_init(void);
707 void lu_ucred_global_fini(void);
709 #define md_cap_t(x) (x)
711 #define MD_CAP_TO_MASK(x) (1 << (x))
713 #define md_cap_raised(c, flag) (md_cap_t(c) & MD_CAP_TO_MASK(flag))
715 /* capable() is copied from linux kernel! */
716 static inline int md_capable(struct lu_ucred *uc, cfs_cap_t cap)
718 if (md_cap_raised(uc->uc_cap, cap))
724 #endif /* _LINUX_MD_OBJECT_H */