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)
143 MDT_REG_LOCK = (1 << 0),
144 MDT_PDO_LOCK = (1 << 1)
151 struct lu_attr ma_attr;
152 struct lov_mds_md *ma_lmm;
154 struct lmv_stripe_md *ma_lmv;
158 struct llog_cookie *ma_cookie;
160 struct lustre_capa *ma_capa;
163 /** Additional parameters for create */
166 /** symlink target */
167 const char *sp_symname;
168 /** parent FID for cross-ref mkdir */
169 const struct lu_fid *sp_pfid;
170 /** eadata for regular files */
172 /** lov objs exist already */
173 const struct lu_fid *fid;
178 /** don't create lov objects or llog cookie - this replay */
181 /** Create flag from client: such as MDS_OPEN_CREAT, and others. */
184 /** Should mdd do lookup sanity check or not. */
187 /** Current lock mode for parent dir where create is performing. */
188 mdl_mode_t sp_cr_mode;
190 /** Check for split */
193 /** to create directory */
194 const struct dt_index_features *sp_feat;
198 * Operations implemented for each md object (both directory and leaf).
200 struct md_object_operations {
201 int (*moo_permission)(const struct lu_env *env,
202 struct md_object *pobj, struct md_object *cobj,
203 struct md_attr *attr, int mask);
205 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
206 struct md_attr *attr);
208 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
209 const struct md_attr *attr);
211 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
212 struct lu_buf *buf, const char *name);
214 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
217 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
218 const struct lu_buf *buf, const char *name,
221 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
224 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
225 const struct lu_rdpg *rdpg);
227 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
230 /** part of cross-ref operation */
231 int (*moo_object_create)(const struct lu_env *env,
232 struct md_object *obj,
233 const struct md_op_spec *spec,
236 int (*moo_ref_add)(const struct lu_env *env,
237 struct md_object *obj,
238 const struct md_attr *ma);
240 int (*moo_ref_del)(const struct lu_env *env,
241 struct md_object *obj,
244 int (*moo_open)(const struct lu_env *env,
245 struct md_object *obj, int flag);
247 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
250 int (*moo_capa_get)(const struct lu_env *, struct md_object *,
251 struct lustre_capa *, int renewal);
253 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
254 dt_obj_version_t (*moo_version_get)(const struct lu_env *,
256 void (*moo_version_set)(const struct lu_env *, struct md_object *,
258 int (*moo_path)(const struct lu_env *env, struct md_object *obj,
259 char *path, int pathlen, __u64 *recno, int *linkno);
263 * Operations implemented for each directory object.
265 struct md_dir_operations {
266 int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
267 const struct lu_fid *fid, struct lu_fid *sfid);
269 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
270 const struct lu_name *lname, struct lu_fid *fid,
271 struct md_op_spec *spec);
273 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
274 struct md_object *obj,
277 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
278 const struct lu_name *lname, struct md_object *child,
279 struct md_op_spec *spec,
282 /** This method is used for creating data object for this meta object*/
283 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
285 const struct md_op_spec *spec,
288 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
289 struct md_object *tpobj, const struct lu_fid *lf,
290 const struct lu_name *lsname, struct md_object *tobj,
291 const struct lu_name *ltname, struct md_attr *ma);
293 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
294 struct md_object *src_obj, const struct lu_name *lname,
297 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
298 struct md_object *cobj, const struct lu_name *lname,
301 /** partial ops for cross-ref case */
302 int (*mdo_name_insert)(const struct lu_env *env,
303 struct md_object *obj,
304 const struct lu_name *lname,
305 const struct lu_fid *fid,
306 const struct md_attr *ma);
308 int (*mdo_name_remove)(const struct lu_env *env,
309 struct md_object *obj,
310 const struct lu_name *lname,
311 const struct md_attr *ma);
313 int (*mdo_rename_tgt)(const struct lu_env *env, struct md_object *pobj,
314 struct md_object *tobj, const struct lu_fid *fid,
315 const struct lu_name *lname, struct md_attr *ma);
318 struct md_device_operations {
319 /** meta-data device related handlers. */
320 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
323 int (*mdo_maxsize_get)(const struct lu_env *env, struct md_device *m,
324 int *md_size, int *cookie_size);
326 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
327 struct kstatfs *sfs);
329 int (*mdo_init_capa_ctxt)(const struct lu_env *env, struct md_device *m,
330 int mode, unsigned long timeout, __u32 alg,
331 struct lustre_capa_key *keys);
333 int (*mdo_update_capa_key)(const struct lu_env *env,
335 struct lustre_capa_key *key);
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);
343 #ifdef HAVE_QUOTA_SUPPORT
344 struct md_quota_operations {
345 int (*mqo_notify)(const struct lu_env *env,
346 struct md_device *m);
348 int (*mqo_setup)(const struct lu_env *env,
352 int (*mqo_cleanup)(const struct lu_env *env,
353 struct md_device *m);
355 int (*mqo_recovery)(const struct lu_env *env,
356 struct md_device *m);
358 int (*mqo_check)(const struct lu_env *env,
362 int (*mqo_on)(const struct lu_env *env,
366 int (*mqo_off)(const struct lu_env *env,
370 int (*mqo_setinfo)(const struct lu_env *env,
374 struct obd_dqinfo *dqinfo);
376 int (*mqo_getinfo)(const struct lu_env *env,
377 const struct md_device *m,
380 struct obd_dqinfo *dqinfo);
382 int (*mqo_setquota)(const struct lu_env *env,
386 struct obd_dqblk *dqblk);
388 int (*mqo_getquota)(const struct lu_env *env,
389 const struct md_device *m,
392 struct obd_dqblk *dqblk);
394 int (*mqo_getoinfo)(const struct lu_env *env,
395 const struct md_device *m,
398 struct obd_dqinfo *dqinfo);
400 int (*mqo_getoquota)(const struct lu_env *env,
401 const struct md_device *m,
404 struct obd_dqblk *dqblk);
406 int (*mqo_invalidate)(const struct lu_env *env,
410 int (*mqo_finvalidate)(const struct lu_env *env,
417 enum md_upcall_event {
418 /** Sync the md layer*/
419 MD_LOV_SYNC = (1 << 0),
420 /** Just for split, no need trans, for replay */
421 MD_NO_TRANS = (1 << 1),
422 MD_LOV_CONFIG = (1 << 2),
423 /** Trigger quota recovery */
424 MD_LOV_QUOTA = (1 << 3)
428 /** this lock protects upcall using against its removal
429 * read lock is for usage the upcall, write - for init/fini */
430 struct rw_semaphore mu_upcall_sem;
431 /** device to call, upper layer normally */
432 struct md_device *mu_upcall_dev;
433 /** upcall function */
434 int (*mu_upcall)(const struct lu_env *env, struct md_device *md,
435 enum md_upcall_event ev, void *data);
439 struct lu_device md_lu_dev;
440 const struct md_device_operations *md_ops;
441 struct md_upcall md_upcall;
444 static inline void md_upcall_init(struct md_device *m, void *upcl)
446 init_rwsem(&m->md_upcall.mu_upcall_sem);
447 m->md_upcall.mu_upcall_dev = NULL;
448 m->md_upcall.mu_upcall = upcl;
451 static inline void md_upcall_dev_set(struct md_device *m, struct md_device *up)
453 down_write(&m->md_upcall.mu_upcall_sem);
454 m->md_upcall.mu_upcall_dev = up;
455 up_write(&m->md_upcall.mu_upcall_sem);
458 static inline void md_upcall_fini(struct md_device *m)
460 down_write(&m->md_upcall.mu_upcall_sem);
461 m->md_upcall.mu_upcall_dev = NULL;
462 m->md_upcall.mu_upcall = NULL;
463 up_write(&m->md_upcall.mu_upcall_sem);
466 static inline int md_do_upcall(const struct lu_env *env, struct md_device *m,
467 enum md_upcall_event ev, void *data)
470 down_read(&m->md_upcall.mu_upcall_sem);
471 if (m->md_upcall.mu_upcall_dev != NULL &&
472 m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall != NULL) {
473 rc = m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall(env,
474 m->md_upcall.mu_upcall_dev,
477 up_read(&m->md_upcall.mu_upcall_sem);
482 struct lu_object mo_lu;
483 const struct md_object_operations *mo_ops;
484 const struct md_dir_operations *mo_dir_ops;
491 struct lu_site ms_lu;
493 * mds number of this site.
497 * Fid location database
499 struct lu_server_fld *ms_server_fld;
500 struct lu_client_fld *ms_client_fld;
505 struct lu_server_seq *ms_server_seq;
508 * Controller Seq Manager
510 struct lu_server_seq *ms_control_seq;
511 struct obd_export *ms_control_exp;
516 struct lu_client_seq *ms_client_seq;
519 static inline int lu_device_is_md(const struct lu_device *d)
521 return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_MD);
524 static inline struct md_device *lu2md_dev(const struct lu_device *d)
526 LASSERT(IS_ERR(d) || lu_device_is_md(d));
527 return container_of0(d, struct md_device, md_lu_dev);
530 static inline struct lu_device *md2lu_dev(struct md_device *d)
532 return &d->md_lu_dev;
535 static inline struct md_object *lu2md(const struct lu_object *o)
537 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
538 return container_of0(o, struct md_object, mo_lu);
541 static inline struct md_object *md_object_next(const struct md_object *obj)
543 return (obj ? lu2md(lu_object_next(&obj->mo_lu)) : NULL);
546 static inline struct md_device *md_obj2dev(const struct md_object *o)
548 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->mo_lu.lo_dev));
549 return container_of0(o->mo_lu.lo_dev, struct md_device, md_lu_dev);
552 static inline struct md_site *lu_site2md(const struct lu_site *s)
554 return container_of0(s, struct md_site, ms_lu);
557 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
559 return lu_device_init(&md->md_lu_dev, t);
562 static inline void md_device_fini(struct md_device *md)
564 lu_device_fini(&md->md_lu_dev);
567 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
568 struct md_device *md,
569 const struct lu_fid *f)
571 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
576 static inline int mo_permission(const struct lu_env *env,
582 LASSERT(c->mo_ops->moo_permission);
583 return c->mo_ops->moo_permission(env, p, c, at, mask);
586 static inline int mo_attr_get(const struct lu_env *env,
590 LASSERT(m->mo_ops->moo_attr_get);
591 return m->mo_ops->moo_attr_get(env, m, at);
594 static inline int mo_readlink(const struct lu_env *env,
598 LASSERT(m->mo_ops->moo_readlink);
599 return m->mo_ops->moo_readlink(env, m, buf);
602 static inline int mo_attr_set(const struct lu_env *env,
604 const struct md_attr *at)
606 LASSERT(m->mo_ops->moo_attr_set);
607 return m->mo_ops->moo_attr_set(env, m, at);
610 static inline int mo_xattr_get(const struct lu_env *env,
615 LASSERT(m->mo_ops->moo_xattr_get);
616 return m->mo_ops->moo_xattr_get(env, m, buf, name);
619 static inline int mo_xattr_del(const struct lu_env *env,
623 LASSERT(m->mo_ops->moo_xattr_del);
624 return m->mo_ops->moo_xattr_del(env, m, name);
627 static inline int mo_xattr_set(const struct lu_env *env,
629 const struct lu_buf *buf,
633 LASSERT(m->mo_ops->moo_xattr_set);
634 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
637 static inline int mo_xattr_list(const struct lu_env *env,
641 LASSERT(m->mo_ops->moo_xattr_list);
642 return m->mo_ops->moo_xattr_list(env, m, buf);
645 static inline int mo_open(const struct lu_env *env,
649 LASSERT(m->mo_ops->moo_open);
650 return m->mo_ops->moo_open(env, m, flags);
653 static inline int mo_close(const struct lu_env *env,
657 LASSERT(m->mo_ops->moo_close);
658 return m->mo_ops->moo_close(env, m, ma);
661 static inline int mo_readpage(const struct lu_env *env,
663 const struct lu_rdpg *rdpg)
665 LASSERT(m->mo_ops->moo_readpage);
666 return m->mo_ops->moo_readpage(env, m, rdpg);
669 static inline int mo_object_create(const struct lu_env *env,
671 const struct md_op_spec *spc,
674 LASSERT(m->mo_ops->moo_object_create);
675 return m->mo_ops->moo_object_create(env, m, spc, at);
678 static inline int mo_ref_add(const struct lu_env *env,
680 const struct md_attr *ma)
682 LASSERT(m->mo_ops->moo_ref_add);
683 return m->mo_ops->moo_ref_add(env, m, ma);
686 static inline int mo_ref_del(const struct lu_env *env,
690 LASSERT(m->mo_ops->moo_ref_del);
691 return m->mo_ops->moo_ref_del(env, m, ma);
694 static inline int mo_capa_get(const struct lu_env *env,
696 struct lustre_capa *c,
699 LASSERT(m->mo_ops->moo_capa_get);
700 return m->mo_ops->moo_capa_get(env, m, c, renewal);
703 static inline int mo_path(const struct lu_env *env, struct md_object *m,
704 char *path, int pathlen, __u64 *recno, int *linkno)
706 if (m->mo_ops->moo_path == NULL)
708 return m->mo_ops->moo_path(env, m, path, pathlen, recno, linkno);
711 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
713 LASSERT(m->mo_ops->moo_object_sync);
714 return m->mo_ops->moo_object_sync(env, m);
717 static inline dt_obj_version_t mo_version_get(const struct lu_env *env,
720 LASSERT(m->mo_ops->moo_version_get);
721 return m->mo_ops->moo_version_get(env, m);
724 static inline void mo_version_set(const struct lu_env *env,
725 struct md_object *m, dt_obj_version_t ver)
727 LASSERT(m->mo_ops->moo_version_set);
728 return m->mo_ops->moo_version_set(env, m, ver);
731 static inline int mdo_lookup(const struct lu_env *env,
733 const struct lu_name *lname,
735 struct md_op_spec *spec)
737 LASSERT(p->mo_dir_ops->mdo_lookup);
738 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
741 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
742 struct md_object *mo,
745 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
747 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
750 static inline int mdo_create(const struct lu_env *env,
752 const struct lu_name *lchild_name,
754 struct md_op_spec *spc,
757 LASSERT(c->mo_dir_ops->mdo_create);
758 return c->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
761 static inline int mdo_create_data(const struct lu_env *env,
764 const struct md_op_spec *spec,
767 LASSERT(c->mo_dir_ops->mdo_create_data);
768 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
771 static inline int mdo_rename(const struct lu_env *env,
772 struct md_object *sp,
773 struct md_object *tp,
774 const struct lu_fid *lf,
775 const struct lu_name *lsname,
777 const struct lu_name *ltname,
780 LASSERT(tp->mo_dir_ops->mdo_rename);
781 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
785 static inline int mdo_is_subdir(const struct lu_env *env,
786 struct md_object *mo,
787 const struct lu_fid *fid,
790 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
791 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
794 static inline int mdo_link(const struct lu_env *env,
797 const struct lu_name *lname,
800 LASSERT(s->mo_dir_ops->mdo_link);
801 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
804 static inline int mdo_unlink(const struct lu_env *env,
807 const struct lu_name *lname,
810 LASSERT(c->mo_dir_ops->mdo_unlink);
811 return c->mo_dir_ops->mdo_unlink(env, p, c, lname, ma);
814 static inline int mdo_name_insert(const struct lu_env *env,
816 const struct lu_name *lname,
817 const struct lu_fid *f,
818 const struct md_attr *ma)
820 LASSERT(p->mo_dir_ops->mdo_name_insert);
821 return p->mo_dir_ops->mdo_name_insert(env, p, lname, f, ma);
824 static inline int mdo_name_remove(const struct lu_env *env,
826 const struct lu_name *lname,
827 const struct md_attr *ma)
829 LASSERT(p->mo_dir_ops->mdo_name_remove);
830 return p->mo_dir_ops->mdo_name_remove(env, p, lname, ma);
833 static inline int mdo_rename_tgt(const struct lu_env *env,
836 const struct lu_fid *lf,
837 const struct lu_name *lname,
841 LASSERT(t->mo_dir_ops->mdo_rename_tgt);
842 return t->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
844 LASSERT(p->mo_dir_ops->mdo_rename_tgt);
845 return p->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
851 * Structure to hold object information. This is used to create object
852 * \pre llod_dir exist
854 struct lu_local_obj_desc {
855 const char *llod_dir;
856 const char *llod_name;
859 const struct dt_index_features * llod_feat;
860 struct list_head llod_linkage;
863 struct md_object *llo_store_resolve(const struct lu_env *env,
864 struct md_device *md,
865 struct dt_device *dt,
869 struct md_object *llo_store_open(const struct lu_env *env,
870 struct md_device *md,
871 struct dt_device *dt,
876 struct md_object *llo_store_create_index(const struct lu_env *env,
877 struct md_device *md,
878 struct dt_device *dt,
881 const struct lu_fid *fid,
882 const struct dt_index_features *feat);
884 struct md_object *llo_store_create(const struct lu_env *env,
885 struct md_device *md,
886 struct dt_device *dt,
889 const struct lu_fid *fid);
891 void llo_local_obj_register(struct lu_local_obj_desc *);
892 void llo_local_obj_unregister(struct lu_local_obj_desc *);
894 int llo_local_objects_setup(const struct lu_env *env,
895 struct md_device * md,
896 struct dt_device * dt);
899 #endif /* _LINUX_MD_OBJECT_H */