1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
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>
63 struct md_device_operations;
87 struct group_info *mu_ginfo;
88 struct md_identity *mu_identity;
95 /** there are at most 5 fids in one operation, see rename, NOTE the last one
96 * is a temporary one used for is_subdir() */
100 const struct lu_fid *mc_fid[MD_CAPAINFO_MAX];
101 struct lustre_capa *mc_capa[MD_CAPAINFO_MAX];
105 struct obd_export *mq_exp;
109 * Implemented in mdd/mdd_handler.c.
111 * XXX should be moved into separate .h/.c together with all md security
112 * related definitions.
114 struct md_ucred *md_ucred(const struct lu_env *env);
115 struct md_capainfo *md_capainfo(const struct lu_env *env);
116 struct md_quota *md_quota(const struct lu_env *env);
118 /** metadata attributes */
122 MA_COOKIE = (1 << 2),
125 MA_ACL_DEF = (1 << 5),
126 MA_LOV_DEF = (1 << 6),
127 /* (Layout lock will used #7 here) */
146 MDT_REG_LOCK = (1 << 0),
147 MDT_PDO_LOCK = (1 << 1)
153 #define ma_hsm_flags ma_hsm.mh_flags
159 struct lu_attr ma_attr;
160 struct lov_mds_md *ma_lmm;
162 struct lmv_stripe_md *ma_lmv;
166 struct llog_cookie *ma_cookie;
168 struct lustre_capa *ma_capa;
169 struct md_hsm ma_hsm;
170 /* XXX: struct md_som_data *ma_som; */
173 /** Additional parameters for create */
176 /** symlink target */
177 const char *sp_symname;
178 /** parent FID for cross-ref mkdir */
179 const struct lu_fid *sp_pfid;
180 /** eadata for regular files */
182 /** lov objs exist already */
183 const struct lu_fid *fid;
188 /** don't create lov objects or llog cookie - this replay */
191 /** Create flag from client: such as MDS_OPEN_CREAT, and others. */
194 /** Should mdd do lookup sanity check or not. */
197 /** Current lock mode for parent dir where create is performing. */
198 mdl_mode_t sp_cr_mode;
200 /** Check for split */
203 /** to create directory */
204 const struct dt_index_features *sp_feat;
208 * Operations implemented for each md object (both directory and leaf).
210 struct md_object_operations {
211 int (*moo_permission)(const struct lu_env *env,
212 struct md_object *pobj, struct md_object *cobj,
213 struct md_attr *attr, int mask);
215 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
216 struct md_attr *attr);
218 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
219 const struct md_attr *attr);
221 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
222 struct lu_buf *buf, const char *name);
224 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
227 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
228 const struct lu_buf *buf, const char *name,
231 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
234 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
235 const struct lu_rdpg *rdpg);
237 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
240 /** part of cross-ref operation */
241 int (*moo_object_create)(const struct lu_env *env,
242 struct md_object *obj,
243 const struct md_op_spec *spec,
246 int (*moo_ref_add)(const struct lu_env *env,
247 struct md_object *obj,
248 const struct md_attr *ma);
250 int (*moo_ref_del)(const struct lu_env *env,
251 struct md_object *obj,
254 int (*moo_open)(const struct lu_env *env,
255 struct md_object *obj, int flag);
257 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
260 int (*moo_capa_get)(const struct lu_env *, struct md_object *,
261 struct lustre_capa *, int renewal);
263 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
264 dt_obj_version_t (*moo_version_get)(const struct lu_env *,
266 void (*moo_version_set)(const struct lu_env *, struct md_object *,
268 int (*moo_path)(const struct lu_env *env, struct md_object *obj,
269 char *path, int pathlen, __u64 *recno, int *linkno);
273 * Operations implemented for each directory object.
275 struct md_dir_operations {
276 int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
277 const struct lu_fid *fid, struct lu_fid *sfid);
279 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
280 const struct lu_name *lname, struct lu_fid *fid,
281 struct md_op_spec *spec);
283 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
284 struct md_object *obj,
287 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
288 const struct lu_name *lname, struct md_object *child,
289 struct md_op_spec *spec,
292 /** This method is used for creating data object for this meta object*/
293 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
295 const struct md_op_spec *spec,
298 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
299 struct md_object *tpobj, const struct lu_fid *lf,
300 const struct lu_name *lsname, struct md_object *tobj,
301 const struct lu_name *ltname, struct md_attr *ma);
303 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
304 struct md_object *src_obj, const struct lu_name *lname,
307 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
308 struct md_object *cobj, const struct lu_name *lname,
311 /** partial ops for cross-ref case */
312 int (*mdo_name_insert)(const struct lu_env *env,
313 struct md_object *obj,
314 const struct lu_name *lname,
315 const struct lu_fid *fid,
316 const struct md_attr *ma);
318 int (*mdo_name_remove)(const struct lu_env *env,
319 struct md_object *obj,
320 const struct lu_name *lname,
321 const struct md_attr *ma);
323 int (*mdo_rename_tgt)(const struct lu_env *env, struct md_object *pobj,
324 struct md_object *tobj, const struct lu_fid *fid,
325 const struct lu_name *lname, struct md_attr *ma);
328 struct md_device_operations {
329 /** meta-data device related handlers. */
330 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
333 int (*mdo_maxsize_get)(const struct lu_env *env, struct md_device *m,
334 int *md_size, int *cookie_size);
336 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
337 struct kstatfs *sfs);
339 int (*mdo_init_capa_ctxt)(const struct lu_env *env, struct md_device *m,
340 int mode, unsigned long timeout, __u32 alg,
341 struct lustre_capa_key *keys);
343 int (*mdo_update_capa_key)(const struct lu_env *env,
345 struct lustre_capa_key *key);
347 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
348 struct md_device *m, int idx, void **h);
350 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
351 unsigned int cmd, int len, void *data);
353 #ifdef HAVE_QUOTA_SUPPORT
354 struct md_quota_operations {
355 int (*mqo_notify)(const struct lu_env *env,
356 struct md_device *m);
358 int (*mqo_setup)(const struct lu_env *env,
362 int (*mqo_cleanup)(const struct lu_env *env,
363 struct md_device *m);
365 int (*mqo_recovery)(const struct lu_env *env,
366 struct md_device *m);
368 int (*mqo_check)(const struct lu_env *env,
372 int (*mqo_on)(const struct lu_env *env,
376 int (*mqo_off)(const struct lu_env *env,
380 int (*mqo_setinfo)(const struct lu_env *env,
384 struct obd_dqinfo *dqinfo);
386 int (*mqo_getinfo)(const struct lu_env *env,
387 const struct md_device *m,
390 struct obd_dqinfo *dqinfo);
392 int (*mqo_setquota)(const struct lu_env *env,
396 struct obd_dqblk *dqblk);
398 int (*mqo_getquota)(const struct lu_env *env,
399 const struct md_device *m,
402 struct obd_dqblk *dqblk);
404 int (*mqo_getoinfo)(const struct lu_env *env,
405 const struct md_device *m,
408 struct obd_dqinfo *dqinfo);
410 int (*mqo_getoquota)(const struct lu_env *env,
411 const struct md_device *m,
414 struct obd_dqblk *dqblk);
416 int (*mqo_invalidate)(const struct lu_env *env,
420 int (*mqo_finvalidate)(const struct lu_env *env,
427 enum md_upcall_event {
428 /** Sync the md layer*/
429 MD_LOV_SYNC = (1 << 0),
430 /** Just for split, no need trans, for replay */
431 MD_NO_TRANS = (1 << 1),
432 MD_LOV_CONFIG = (1 << 2),
433 /** Trigger quota recovery */
434 MD_LOV_QUOTA = (1 << 3)
438 /** this lock protects upcall using against its removal
439 * read lock is for usage the upcall, write - for init/fini */
440 struct rw_semaphore mu_upcall_sem;
441 /** device to call, upper layer normally */
442 struct md_device *mu_upcall_dev;
443 /** upcall function */
444 int (*mu_upcall)(const struct lu_env *env, struct md_device *md,
445 enum md_upcall_event ev, void *data);
449 struct lu_device md_lu_dev;
450 const struct md_device_operations *md_ops;
451 struct md_upcall md_upcall;
454 static inline void md_upcall_init(struct md_device *m, void *upcl)
456 init_rwsem(&m->md_upcall.mu_upcall_sem);
457 m->md_upcall.mu_upcall_dev = NULL;
458 m->md_upcall.mu_upcall = upcl;
461 static inline void md_upcall_dev_set(struct md_device *m, struct md_device *up)
463 down_write(&m->md_upcall.mu_upcall_sem);
464 m->md_upcall.mu_upcall_dev = up;
465 up_write(&m->md_upcall.mu_upcall_sem);
468 static inline void md_upcall_fini(struct md_device *m)
470 down_write(&m->md_upcall.mu_upcall_sem);
471 m->md_upcall.mu_upcall_dev = NULL;
472 m->md_upcall.mu_upcall = NULL;
473 up_write(&m->md_upcall.mu_upcall_sem);
476 static inline int md_do_upcall(const struct lu_env *env, struct md_device *m,
477 enum md_upcall_event ev, void *data)
480 down_read(&m->md_upcall.mu_upcall_sem);
481 if (m->md_upcall.mu_upcall_dev != NULL &&
482 m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall != NULL) {
483 rc = m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall(env,
484 m->md_upcall.mu_upcall_dev,
487 up_read(&m->md_upcall.mu_upcall_sem);
492 struct lu_object mo_lu;
493 const struct md_object_operations *mo_ops;
494 const struct md_dir_operations *mo_dir_ops;
501 struct lu_site ms_lu;
503 * mds number of this site.
507 * Fid location database
509 struct lu_server_fld *ms_server_fld;
510 struct lu_client_fld *ms_client_fld;
515 struct lu_server_seq *ms_server_seq;
518 * Controller Seq Manager
520 struct lu_server_seq *ms_control_seq;
521 struct obd_export *ms_control_exp;
526 struct lu_client_seq *ms_client_seq;
529 static inline int lu_device_is_md(const struct lu_device *d)
531 return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_MD);
534 static inline struct md_device *lu2md_dev(const struct lu_device *d)
536 LASSERT(IS_ERR(d) || lu_device_is_md(d));
537 return container_of0(d, struct md_device, md_lu_dev);
540 static inline struct lu_device *md2lu_dev(struct md_device *d)
542 return &d->md_lu_dev;
545 static inline struct md_object *lu2md(const struct lu_object *o)
547 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
548 return container_of0(o, struct md_object, mo_lu);
551 static inline struct md_object *md_object_next(const struct md_object *obj)
553 return (obj ? lu2md(lu_object_next(&obj->mo_lu)) : NULL);
556 static inline struct md_device *md_obj2dev(const struct md_object *o)
558 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->mo_lu.lo_dev));
559 return container_of0(o->mo_lu.lo_dev, struct md_device, md_lu_dev);
562 static inline struct md_site *lu_site2md(const struct lu_site *s)
564 return container_of0(s, struct md_site, ms_lu);
567 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
569 return lu_device_init(&md->md_lu_dev, t);
572 static inline void md_device_fini(struct md_device *md)
574 lu_device_fini(&md->md_lu_dev);
577 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
578 struct md_device *md,
579 const struct lu_fid *f)
581 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
586 static inline int mo_permission(const struct lu_env *env,
592 LASSERT(c->mo_ops->moo_permission);
593 return c->mo_ops->moo_permission(env, p, c, at, mask);
596 static inline int mo_attr_get(const struct lu_env *env,
600 LASSERT(m->mo_ops->moo_attr_get);
601 return m->mo_ops->moo_attr_get(env, m, at);
604 static inline int mo_readlink(const struct lu_env *env,
608 LASSERT(m->mo_ops->moo_readlink);
609 return m->mo_ops->moo_readlink(env, m, buf);
612 static inline int mo_attr_set(const struct lu_env *env,
614 const struct md_attr *at)
616 LASSERT(m->mo_ops->moo_attr_set);
617 return m->mo_ops->moo_attr_set(env, m, at);
620 static inline int mo_xattr_get(const struct lu_env *env,
625 LASSERT(m->mo_ops->moo_xattr_get);
626 return m->mo_ops->moo_xattr_get(env, m, buf, name);
629 static inline int mo_xattr_del(const struct lu_env *env,
633 LASSERT(m->mo_ops->moo_xattr_del);
634 return m->mo_ops->moo_xattr_del(env, m, name);
637 static inline int mo_xattr_set(const struct lu_env *env,
639 const struct lu_buf *buf,
643 LASSERT(m->mo_ops->moo_xattr_set);
644 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
647 static inline int mo_xattr_list(const struct lu_env *env,
651 LASSERT(m->mo_ops->moo_xattr_list);
652 return m->mo_ops->moo_xattr_list(env, m, buf);
655 static inline int mo_open(const struct lu_env *env,
659 LASSERT(m->mo_ops->moo_open);
660 return m->mo_ops->moo_open(env, m, flags);
663 static inline int mo_close(const struct lu_env *env,
667 LASSERT(m->mo_ops->moo_close);
668 return m->mo_ops->moo_close(env, m, ma);
671 static inline int mo_readpage(const struct lu_env *env,
673 const struct lu_rdpg *rdpg)
675 LASSERT(m->mo_ops->moo_readpage);
676 return m->mo_ops->moo_readpage(env, m, rdpg);
679 static inline int mo_object_create(const struct lu_env *env,
681 const struct md_op_spec *spc,
684 LASSERT(m->mo_ops->moo_object_create);
685 return m->mo_ops->moo_object_create(env, m, spc, at);
688 static inline int mo_ref_add(const struct lu_env *env,
690 const struct md_attr *ma)
692 LASSERT(m->mo_ops->moo_ref_add);
693 return m->mo_ops->moo_ref_add(env, m, ma);
696 static inline int mo_ref_del(const struct lu_env *env,
700 LASSERT(m->mo_ops->moo_ref_del);
701 return m->mo_ops->moo_ref_del(env, m, ma);
704 static inline int mo_capa_get(const struct lu_env *env,
706 struct lustre_capa *c,
709 LASSERT(m->mo_ops->moo_capa_get);
710 return m->mo_ops->moo_capa_get(env, m, c, renewal);
713 static inline int mo_path(const struct lu_env *env, struct md_object *m,
714 char *path, int pathlen, __u64 *recno, int *linkno)
716 if (m->mo_ops->moo_path == NULL)
718 return m->mo_ops->moo_path(env, m, path, pathlen, recno, linkno);
721 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
723 LASSERT(m->mo_ops->moo_object_sync);
724 return m->mo_ops->moo_object_sync(env, m);
727 static inline dt_obj_version_t mo_version_get(const struct lu_env *env,
730 LASSERT(m->mo_ops->moo_version_get);
731 return m->mo_ops->moo_version_get(env, m);
734 static inline void mo_version_set(const struct lu_env *env,
735 struct md_object *m, dt_obj_version_t ver)
737 LASSERT(m->mo_ops->moo_version_set);
738 return m->mo_ops->moo_version_set(env, m, ver);
741 static inline int mdo_lookup(const struct lu_env *env,
743 const struct lu_name *lname,
745 struct md_op_spec *spec)
747 LASSERT(p->mo_dir_ops->mdo_lookup);
748 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
751 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
752 struct md_object *mo,
755 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
757 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
760 static inline int mdo_create(const struct lu_env *env,
762 const struct lu_name *lchild_name,
764 struct md_op_spec *spc,
767 LASSERT(c->mo_dir_ops->mdo_create);
768 return c->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
771 static inline int mdo_create_data(const struct lu_env *env,
774 const struct md_op_spec *spec,
777 LASSERT(c->mo_dir_ops->mdo_create_data);
778 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
781 static inline int mdo_rename(const struct lu_env *env,
782 struct md_object *sp,
783 struct md_object *tp,
784 const struct lu_fid *lf,
785 const struct lu_name *lsname,
787 const struct lu_name *ltname,
790 LASSERT(tp->mo_dir_ops->mdo_rename);
791 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
795 static inline int mdo_is_subdir(const struct lu_env *env,
796 struct md_object *mo,
797 const struct lu_fid *fid,
800 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
801 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
804 static inline int mdo_link(const struct lu_env *env,
807 const struct lu_name *lname,
810 LASSERT(s->mo_dir_ops->mdo_link);
811 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
814 static inline int mdo_unlink(const struct lu_env *env,
817 const struct lu_name *lname,
820 LASSERT(c->mo_dir_ops->mdo_unlink);
821 return c->mo_dir_ops->mdo_unlink(env, p, c, lname, ma);
824 static inline int mdo_name_insert(const struct lu_env *env,
826 const struct lu_name *lname,
827 const struct lu_fid *f,
828 const struct md_attr *ma)
830 LASSERT(p->mo_dir_ops->mdo_name_insert);
831 return p->mo_dir_ops->mdo_name_insert(env, p, lname, f, ma);
834 static inline int mdo_name_remove(const struct lu_env *env,
836 const struct lu_name *lname,
837 const struct md_attr *ma)
839 LASSERT(p->mo_dir_ops->mdo_name_remove);
840 return p->mo_dir_ops->mdo_name_remove(env, p, lname, ma);
843 static inline int mdo_rename_tgt(const struct lu_env *env,
846 const struct lu_fid *lf,
847 const struct lu_name *lname,
851 LASSERT(t->mo_dir_ops->mdo_rename_tgt);
852 return t->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
854 LASSERT(p->mo_dir_ops->mdo_rename_tgt);
855 return p->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
861 * Structure to hold object information. This is used to create object
862 * \pre llod_dir exist
864 struct lu_local_obj_desc {
865 const char *llod_dir;
866 const char *llod_name;
869 const struct dt_index_features * llod_feat;
870 struct list_head llod_linkage;
873 struct md_object *llo_store_resolve(const struct lu_env *env,
874 struct md_device *md,
875 struct dt_device *dt,
879 struct md_object *llo_store_open(const struct lu_env *env,
880 struct md_device *md,
881 struct dt_device *dt,
886 struct md_object *llo_store_create_index(const struct lu_env *env,
887 struct md_device *md,
888 struct dt_device *dt,
891 const struct lu_fid *fid,
892 const struct dt_index_features *feat);
894 struct md_object *llo_store_create(const struct lu_env *env,
895 struct md_device *md,
896 struct dt_device *dt,
899 const struct lu_fid *fid);
901 void llo_local_obj_register(struct lu_local_obj_desc *);
902 void llo_local_obj_unregister(struct lu_local_obj_desc *);
904 int llo_local_objects_setup(const struct lu_env *env,
905 struct md_device * md,
906 struct dt_device * dt);
909 #endif /* _LINUX_MD_OBJECT_H */