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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/md_object.h
38 * Extention of lu_object.h for metadata objects
41 #ifndef _LUSTRE_MD_OBJECT_H
42 #define _LUSTRE_MD_OBJECT_H
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 /* LU-1051, temperary solution to reduce llog credits */
63 #define DECLARE_LLOG_REWRITE 0
64 #define DECLARE_LLOG_WRITE INT_MAX
67 struct md_device_operations;
82 /** there are at most 5 fids in one operation, see rename, NOTE the last one
83 * is a temporary one used for is_subdir() */
87 struct lu_fid mc_fid[MD_CAPAINFO_MAX];
88 struct lustre_capa *mc_capa[MD_CAPAINFO_MAX];
92 struct obd_export *mq_exp;
96 * Implemented in mdd/mdd_handler.c.
98 * XXX should be moved into separate .h/.c together with all md security
99 * related definitions.
101 struct md_capainfo *md_capainfo(const struct lu_env *env);
102 struct md_quota *md_quota(const struct lu_env *env);
104 /** metadata attributes */
108 MA_COOKIE = (1 << 2),
111 MA_ACL_DEF = (1 << 5),
112 MA_LOV_DEF = (1 << 6),
113 MA_LAY_GEN = (1 << 7),
133 MDT_REG_LOCK = (1 << 0),
134 MDT_PDO_LOCK = (1 << 1)
137 /* memory structure for hsm attributes
138 * for fields description see the on disk structure hsm_attrs
139 * which is defined in lustre_idl.h
148 #define IOEPOCH_INVAL 0
150 /* memory structure for som attributes
151 * for fields description see the on disk structure som_attrs
152 * which is defined in lustre_idl.h
167 struct lu_attr ma_attr;
168 struct lu_fid ma_pfid;
169 struct md_hsm ma_hsm;
170 struct lov_mds_md *ma_lmm;
171 struct lmv_stripe_md *ma_lmv;
173 struct llog_cookie *ma_cookie;
174 struct lustre_capa *ma_capa;
175 struct md_som_data *ma_som;
177 int ma_big_lmm_used:1;
184 /** Additional parameters for create */
187 /** symlink target */
188 const char *sp_symname;
189 /** parent FID for cross-ref mkdir */
190 const struct lu_fid *sp_pfid;
191 /** eadata for regular files */
193 /** lov objs exist already */
194 const struct lu_fid *fid;
199 /** don't create lov objects or llog cookie - this replay */
202 /** Create flag from client: such as MDS_OPEN_CREAT, and others. */
205 /** Should mdd do lookup sanity check or not. */
208 /** Current lock mode for parent dir where create is performing. */
209 mdl_mode_t sp_cr_mode;
211 /** to create directory */
212 const struct dt_index_features *sp_feat;
216 * Operations implemented for each md object (both directory and leaf).
218 struct md_object_operations {
219 int (*moo_permission)(const struct lu_env *env,
220 struct md_object *pobj, struct md_object *cobj,
221 struct md_attr *attr, int mask);
223 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
224 struct md_attr *attr);
226 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
227 const struct md_attr *attr);
229 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
230 struct lu_buf *buf, const char *name);
232 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
235 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
236 const struct lu_buf *buf, const char *name,
239 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
242 /** This method is used to swap the layouts between 2 objects */
243 int (*moo_swap_layouts)(const struct lu_env *env,
244 struct md_object *obj1, struct md_object *obj2,
247 /** \retval number of bytes actually read upon success */
248 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
249 const struct lu_rdpg *rdpg);
251 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
253 int (*moo_changelog)(const struct lu_env *env,
254 enum changelog_rec_type type, int flags,
255 struct md_object *obj);
256 /** part of cross-ref operation */
257 int (*moo_object_create)(const struct lu_env *env,
258 struct md_object *obj,
259 const struct md_op_spec *spec,
262 int (*moo_ref_add)(const struct lu_env *env,
263 struct md_object *obj,
264 const struct md_attr *ma);
266 int (*moo_ref_del)(const struct lu_env *env,
267 struct md_object *obj,
270 int (*moo_open)(const struct lu_env *env,
271 struct md_object *obj, int flag);
273 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
274 struct md_attr *ma, int mode);
276 int (*moo_capa_get)(const struct lu_env *, struct md_object *,
277 struct lustre_capa *, int renewal);
279 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
280 int (*moo_path)(const struct lu_env *env, struct md_object *obj,
281 char *path, int pathlen, __u64 *recno, int *linkno);
282 int (*moo_file_lock)(const struct lu_env *env, struct md_object *obj,
283 struct lov_mds_md *lmm, struct ldlm_extent *extent,
284 struct lustre_handle *lockh);
285 int (*moo_file_unlock)(const struct lu_env *env, struct md_object *obj,
286 struct lov_mds_md *lmm,
287 struct lustre_handle *lockh);
291 * Operations implemented for each directory object.
293 struct md_dir_operations {
294 int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
295 const struct lu_fid *fid, struct lu_fid *sfid);
297 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
298 const struct lu_name *lname, struct lu_fid *fid,
299 struct md_op_spec *spec);
301 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
302 struct md_object *obj,
305 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
306 const struct lu_name *lname, struct md_object *child,
307 struct md_op_spec *spec,
310 /** This method is used for creating data object for this meta object*/
311 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
313 const struct md_op_spec *spec,
316 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
317 struct md_object *tpobj, const struct lu_fid *lf,
318 const struct lu_name *lsname, struct md_object *tobj,
319 const struct lu_name *ltname, struct md_attr *ma);
321 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
322 struct md_object *src_obj, const struct lu_name *lname,
325 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
326 struct md_object *cobj, const struct lu_name *lname,
329 /** This method is used to compare a requested layout to an existing
330 * layout (struct lov_mds_md_v1/3 vs struct lov_mds_md_v1/3) */
331 int (*mdo_lum_lmm_cmp)(const struct lu_env *env,
332 struct md_object *cobj,
333 const struct md_op_spec *spec,
336 /** partial ops for cross-ref case */
337 int (*mdo_name_insert)(const struct lu_env *env,
338 struct md_object *obj,
339 const struct lu_name *lname,
340 const struct lu_fid *fid,
341 const struct md_attr *ma);
343 int (*mdo_name_remove)(const struct lu_env *env,
344 struct md_object *obj,
345 const struct lu_name *lname,
346 const struct md_attr *ma);
348 int (*mdo_rename_tgt)(const struct lu_env *env, struct md_object *pobj,
349 struct md_object *tobj, const struct lu_fid *fid,
350 const struct lu_name *lname, struct md_attr *ma);
353 struct md_device_operations {
354 /** meta-data device related handlers. */
355 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
358 int (*mdo_maxsize_get)(const struct lu_env *env, struct md_device *m,
359 int *md_size, int *cookie_size);
361 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
362 struct obd_statfs *sfs);
364 int (*mdo_init_capa_ctxt)(const struct lu_env *env, struct md_device *m,
365 int mode, unsigned long timeout, __u32 alg,
366 struct lustre_capa_key *keys);
368 int (*mdo_update_capa_key)(const struct lu_env *env,
370 struct lustre_capa_key *key);
372 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
373 struct md_device *m, int idx, void **h);
375 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
376 unsigned int cmd, int len, void *data);
379 enum md_upcall_event {
380 /** Sync the md layer*/
381 MD_LOV_SYNC = (1 << 0),
382 /** Just for split, no need trans, for replay */
383 MD_NO_TRANS = (1 << 1),
384 MD_LOV_CONFIG = (1 << 2),
385 /** Trigger quota recovery */
386 MD_LOV_QUOTA = (1 << 3)
390 /** this lock protects upcall using against its removal
391 * read lock is for usage the upcall, write - for init/fini */
392 struct rw_semaphore mu_upcall_sem;
393 /** device to call, upper layer normally */
394 struct md_device *mu_upcall_dev;
395 /** upcall function */
396 int (*mu_upcall)(const struct lu_env *env, struct md_device *md,
397 enum md_upcall_event ev, void *data);
401 struct lu_device md_lu_dev;
402 const struct md_device_operations *md_ops;
403 struct md_upcall md_upcall;
406 static inline void md_upcall_init(struct md_device *m, void *upcl)
408 init_rwsem(&m->md_upcall.mu_upcall_sem);
409 m->md_upcall.mu_upcall_dev = NULL;
410 m->md_upcall.mu_upcall = upcl;
413 static inline void md_upcall_dev_set(struct md_device *m, struct md_device *up)
415 down_write(&m->md_upcall.mu_upcall_sem);
416 m->md_upcall.mu_upcall_dev = up;
417 up_write(&m->md_upcall.mu_upcall_sem);
420 static inline void md_upcall_fini(struct md_device *m)
422 down_write(&m->md_upcall.mu_upcall_sem);
423 m->md_upcall.mu_upcall_dev = NULL;
424 m->md_upcall.mu_upcall = NULL;
425 up_write(&m->md_upcall.mu_upcall_sem);
428 static inline int md_do_upcall(const struct lu_env *env, struct md_device *m,
429 enum md_upcall_event ev, void *data)
432 down_read(&m->md_upcall.mu_upcall_sem);
433 if (m->md_upcall.mu_upcall_dev != NULL &&
434 m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall != NULL) {
435 rc = m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall(env,
436 m->md_upcall.mu_upcall_dev,
439 up_read(&m->md_upcall.mu_upcall_sem);
444 struct lu_object mo_lu;
445 const struct md_object_operations *mo_ops;
446 const struct md_dir_operations *mo_dir_ops;
452 struct seq_server_site {
453 struct lu_site *ss_lu;
455 * mds number of this site.
459 * Fid location database
461 struct lu_server_fld *ss_server_fld;
462 struct lu_client_fld *ss_client_fld;
467 struct lu_server_seq *ss_server_seq;
470 * Controller Seq Manager
472 struct lu_server_seq *ss_control_seq;
473 struct obd_export *ss_control_exp;
478 struct lu_client_seq *ss_client_seq;
481 static inline int lu_device_is_md(const struct lu_device *d)
483 return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_MD);
486 static inline struct md_device *lu2md_dev(const struct lu_device *d)
488 LASSERT(IS_ERR(d) || lu_device_is_md(d));
489 return container_of0(d, struct md_device, md_lu_dev);
492 static inline struct lu_device *md2lu_dev(struct md_device *d)
494 return &d->md_lu_dev;
497 static inline struct md_object *lu2md(const struct lu_object *o)
499 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
500 return container_of0(o, struct md_object, mo_lu);
503 static inline struct md_object *md_object_next(const struct md_object *obj)
505 return (obj ? lu2md(lu_object_next(&obj->mo_lu)) : NULL);
508 static inline struct md_device *md_obj2dev(const struct md_object *o)
510 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->mo_lu.lo_dev));
511 return container_of0(o->mo_lu.lo_dev, struct md_device, md_lu_dev);
514 static inline struct seq_server_site *lu_site2seq(const struct lu_site *s)
516 return s->ld_seq_site;
519 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
521 return lu_device_init(&md->md_lu_dev, t);
524 static inline void md_device_fini(struct md_device *md)
526 lu_device_fini(&md->md_lu_dev);
529 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
530 struct md_device *md,
531 const struct lu_fid *f)
533 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
538 static inline int mo_permission(const struct lu_env *env,
544 LASSERT(c->mo_ops->moo_permission);
545 return c->mo_ops->moo_permission(env, p, c, at, mask);
548 static inline int mo_attr_get(const struct lu_env *env,
552 LASSERT(m->mo_ops->moo_attr_get);
553 return m->mo_ops->moo_attr_get(env, m, at);
556 static inline int mo_readlink(const struct lu_env *env,
560 LASSERT(m->mo_ops->moo_readlink);
561 return m->mo_ops->moo_readlink(env, m, buf);
564 static inline int mo_changelog(const struct lu_env *env,
565 enum changelog_rec_type type,
566 int flags, struct md_object *m)
568 LASSERT(m->mo_ops->moo_changelog);
569 return m->mo_ops->moo_changelog(env, type, flags, m);
572 static inline int mo_attr_set(const struct lu_env *env,
574 const struct md_attr *at)
576 LASSERT(m->mo_ops->moo_attr_set);
577 return m->mo_ops->moo_attr_set(env, m, at);
580 static inline int mo_xattr_get(const struct lu_env *env,
585 LASSERT(m->mo_ops->moo_xattr_get);
586 return m->mo_ops->moo_xattr_get(env, m, buf, name);
589 static inline int mo_xattr_del(const struct lu_env *env,
593 LASSERT(m->mo_ops->moo_xattr_del);
594 return m->mo_ops->moo_xattr_del(env, m, name);
597 static inline int mo_xattr_set(const struct lu_env *env,
599 const struct lu_buf *buf,
603 LASSERT(m->mo_ops->moo_xattr_set);
604 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
607 static inline int mo_xattr_list(const struct lu_env *env,
611 LASSERT(m->mo_ops->moo_xattr_list);
612 return m->mo_ops->moo_xattr_list(env, m, buf);
615 static inline int mo_swap_layouts(const struct lu_env *env,
616 struct md_object *o1,
617 struct md_object *o2, __u64 flags)
619 LASSERT(o1->mo_ops->moo_swap_layouts);
620 LASSERT(o2->mo_ops->moo_swap_layouts);
621 if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
623 return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
626 static inline int mo_open(const struct lu_env *env,
630 LASSERT(m->mo_ops->moo_open);
631 return m->mo_ops->moo_open(env, m, flags);
634 static inline int mo_close(const struct lu_env *env,
639 LASSERT(m->mo_ops->moo_close);
640 return m->mo_ops->moo_close(env, m, ma, mode);
643 static inline int mo_readpage(const struct lu_env *env,
645 const struct lu_rdpg *rdpg)
647 LASSERT(m->mo_ops->moo_readpage);
648 return m->mo_ops->moo_readpage(env, m, rdpg);
651 static inline int mo_object_create(const struct lu_env *env,
653 const struct md_op_spec *spc,
656 LASSERT(m->mo_ops->moo_object_create);
657 return m->mo_ops->moo_object_create(env, m, spc, at);
660 static inline int mo_ref_add(const struct lu_env *env,
662 const struct md_attr *ma)
664 LASSERT(m->mo_ops->moo_ref_add);
665 return m->mo_ops->moo_ref_add(env, m, ma);
668 static inline int mo_ref_del(const struct lu_env *env,
672 LASSERT(m->mo_ops->moo_ref_del);
673 return m->mo_ops->moo_ref_del(env, m, ma);
676 static inline int mo_capa_get(const struct lu_env *env,
678 struct lustre_capa *c,
681 LASSERT(m->mo_ops->moo_capa_get);
682 return m->mo_ops->moo_capa_get(env, m, c, renewal);
685 static inline int mo_path(const struct lu_env *env, struct md_object *m,
686 char *path, int pathlen, __u64 *recno, int *linkno)
688 if (m->mo_ops->moo_path == NULL)
690 return m->mo_ops->moo_path(env, m, path, pathlen, recno, linkno);
693 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
695 LASSERT(m->mo_ops->moo_object_sync);
696 return m->mo_ops->moo_object_sync(env, m);
699 static inline int mo_file_lock(const struct lu_env *env, struct md_object *m,
700 struct lov_mds_md *lmm,
701 struct ldlm_extent *extent,
702 struct lustre_handle *lockh)
704 LASSERT(m->mo_ops->moo_file_lock);
705 return m->mo_ops->moo_file_lock(env, m, lmm, extent, lockh);
708 static inline int mo_file_unlock(const struct lu_env *env, struct md_object *m,
709 struct lov_mds_md *lmm,
710 struct lustre_handle *lockh)
712 LASSERT(m->mo_ops->moo_file_unlock);
713 return m->mo_ops->moo_file_unlock(env, m, lmm, lockh);
716 static inline int mdo_lookup(const struct lu_env *env,
718 const struct lu_name *lname,
720 struct md_op_spec *spec)
722 LASSERT(p->mo_dir_ops->mdo_lookup);
723 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
726 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
727 struct md_object *mo,
730 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
732 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
735 static inline int mdo_create(const struct lu_env *env,
737 const struct lu_name *lchild_name,
739 struct md_op_spec *spc,
742 LASSERT(p->mo_dir_ops->mdo_create);
743 return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
746 static inline int mdo_create_data(const struct lu_env *env,
749 const struct md_op_spec *spec,
752 LASSERT(c->mo_dir_ops->mdo_create_data);
753 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
756 static inline int mdo_rename(const struct lu_env *env,
757 struct md_object *sp,
758 struct md_object *tp,
759 const struct lu_fid *lf,
760 const struct lu_name *lsname,
762 const struct lu_name *ltname,
765 LASSERT(tp->mo_dir_ops->mdo_rename);
766 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
770 static inline int mdo_is_subdir(const struct lu_env *env,
771 struct md_object *mo,
772 const struct lu_fid *fid,
775 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
776 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
779 static inline int mdo_link(const struct lu_env *env,
782 const struct lu_name *lname,
785 LASSERT(s->mo_dir_ops->mdo_link);
786 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
789 static inline int mdo_unlink(const struct lu_env *env,
792 const struct lu_name *lname,
795 LASSERT(c->mo_dir_ops->mdo_unlink);
796 return c->mo_dir_ops->mdo_unlink(env, p, c, lname, ma);
799 static inline int mdo_lum_lmm_cmp(const struct lu_env *env,
801 const struct md_op_spec *spec,
804 LASSERT(c->mo_dir_ops->mdo_lum_lmm_cmp);
805 return c->mo_dir_ops->mdo_lum_lmm_cmp(env, c, spec, ma);
808 static inline int mdo_name_insert(const struct lu_env *env,
810 const struct lu_name *lname,
811 const struct lu_fid *f,
812 const struct md_attr *ma)
814 LASSERT(p->mo_dir_ops->mdo_name_insert);
815 return p->mo_dir_ops->mdo_name_insert(env, p, lname, f, ma);
818 static inline int mdo_name_remove(const struct lu_env *env,
820 const struct lu_name *lname,
821 const struct md_attr *ma)
823 LASSERT(p->mo_dir_ops->mdo_name_remove);
824 return p->mo_dir_ops->mdo_name_remove(env, p, lname, ma);
827 static inline int mdo_rename_tgt(const struct lu_env *env,
830 const struct lu_fid *lf,
831 const struct lu_name *lname,
835 LASSERT(t->mo_dir_ops->mdo_rename_tgt);
836 return t->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
838 LASSERT(p->mo_dir_ops->mdo_rename_tgt);
839 return p->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
845 * Structure to hold object information. This is used to create object
846 * \pre llod_dir exist
848 struct lu_local_obj_desc {
849 const char *llod_dir;
850 const char *llod_name;
853 const struct dt_index_features *llod_feat;
854 cfs_list_t llod_linkage;
857 struct md_object *llo_store_resolve(const struct lu_env *env,
858 struct md_device *md,
859 struct dt_device *dt,
863 struct md_object *llo_store_open(const struct lu_env *env,
864 struct md_device *md,
865 struct dt_device *dt,
870 struct md_object *llo_store_create_index(const struct lu_env *env,
871 struct md_device *md,
872 struct dt_device *dt,
875 const struct lu_fid *fid,
876 const struct dt_index_features *feat);
878 struct md_object *llo_store_create(const struct lu_env *env,
879 struct md_device *md,
880 struct dt_device *dt,
883 const struct lu_fid *fid);
885 void llo_local_obj_register(struct lu_local_obj_desc *);
886 void llo_local_obj_unregister(struct lu_local_obj_desc *);
888 int llo_local_objects_setup(const struct lu_env *env,
889 struct md_device * md,
890 struct dt_device * dt);
892 int lustre_buf2som(void *buf, int rc, struct md_som_data *msd);
893 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
894 void lustre_hsm2buf(void *buf, struct md_hsm *mh);
896 #endif /* _LINUX_MD_OBJECT_H */