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
154 #define HSM_FLAGS_MASK 0
156 #define IOEPOCH_INVAL 0
169 struct lu_attr ma_attr;
170 struct lov_mds_md *ma_lmm;
172 struct lmv_stripe_md *ma_lmv;
176 struct llog_cookie *ma_cookie;
178 struct lustre_capa *ma_capa;
179 struct md_hsm ma_hsm;
180 struct md_som_data *ma_som;
183 /** Additional parameters for create */
186 /** symlink target */
187 const char *sp_symname;
188 /** parent FID for cross-ref mkdir */
189 const struct lu_fid *sp_pfid;
190 /** eadata for regular files */
192 /** lov objs exist already */
193 const struct lu_fid *fid;
198 /** don't create lov objects or llog cookie - this replay */
201 /** Create flag from client: such as MDS_OPEN_CREAT, and others. */
204 /** Should mdd do lookup sanity check or not. */
207 /** Current lock mode for parent dir where create is performing. */
208 mdl_mode_t sp_cr_mode;
210 /** Check for split */
213 /** to create directory */
214 const struct dt_index_features *sp_feat;
218 * Operations implemented for each md object (both directory and leaf).
220 struct md_object_operations {
221 int (*moo_permission)(const struct lu_env *env,
222 struct md_object *pobj, struct md_object *cobj,
223 struct md_attr *attr, int mask);
225 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
226 struct md_attr *attr);
228 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
229 const struct md_attr *attr);
231 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
232 struct lu_buf *buf, const char *name);
234 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
237 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
238 const struct lu_buf *buf, const char *name,
241 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
244 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
245 const struct lu_rdpg *rdpg);
247 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
250 /** part of cross-ref operation */
251 int (*moo_object_create)(const struct lu_env *env,
252 struct md_object *obj,
253 const struct md_op_spec *spec,
256 int (*moo_ref_add)(const struct lu_env *env,
257 struct md_object *obj,
258 const struct md_attr *ma);
260 int (*moo_ref_del)(const struct lu_env *env,
261 struct md_object *obj,
264 int (*moo_open)(const struct lu_env *env,
265 struct md_object *obj, int flag);
267 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
270 int (*moo_capa_get)(const struct lu_env *, struct md_object *,
271 struct lustre_capa *, int renewal);
273 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
274 dt_obj_version_t (*moo_version_get)(const struct lu_env *,
276 void (*moo_version_set)(const struct lu_env *, struct md_object *,
278 int (*moo_path)(const struct lu_env *env, struct md_object *obj,
279 char *path, int pathlen, __u64 *recno, int *linkno);
283 * Operations implemented for each directory object.
285 struct md_dir_operations {
286 int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
287 const struct lu_fid *fid, struct lu_fid *sfid);
289 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
290 const struct lu_name *lname, struct lu_fid *fid,
291 struct md_op_spec *spec);
293 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
294 struct md_object *obj,
297 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
298 const struct lu_name *lname, struct md_object *child,
299 struct md_op_spec *spec,
302 /** This method is used for creating data object for this meta object*/
303 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
305 const struct md_op_spec *spec,
308 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
309 struct md_object *tpobj, const struct lu_fid *lf,
310 const struct lu_name *lsname, struct md_object *tobj,
311 const struct lu_name *ltname, struct md_attr *ma);
313 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
314 struct md_object *src_obj, const struct lu_name *lname,
317 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
318 struct md_object *cobj, const struct lu_name *lname,
321 /** partial ops for cross-ref case */
322 int (*mdo_name_insert)(const struct lu_env *env,
323 struct md_object *obj,
324 const struct lu_name *lname,
325 const struct lu_fid *fid,
326 const struct md_attr *ma);
328 int (*mdo_name_remove)(const struct lu_env *env,
329 struct md_object *obj,
330 const struct lu_name *lname,
331 const struct md_attr *ma);
333 int (*mdo_rename_tgt)(const struct lu_env *env, struct md_object *pobj,
334 struct md_object *tobj, const struct lu_fid *fid,
335 const struct lu_name *lname, struct md_attr *ma);
338 struct md_device_operations {
339 /** meta-data device related handlers. */
340 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
343 int (*mdo_maxsize_get)(const struct lu_env *env, struct md_device *m,
344 int *md_size, int *cookie_size);
346 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
347 struct kstatfs *sfs);
349 int (*mdo_init_capa_ctxt)(const struct lu_env *env, struct md_device *m,
350 int mode, unsigned long timeout, __u32 alg,
351 struct lustre_capa_key *keys);
353 int (*mdo_update_capa_key)(const struct lu_env *env,
355 struct lustre_capa_key *key);
357 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
358 struct md_device *m, int idx, void **h);
360 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
361 unsigned int cmd, int len, void *data);
363 #ifdef HAVE_QUOTA_SUPPORT
364 struct md_quota_operations {
365 int (*mqo_notify)(const struct lu_env *env,
366 struct md_device *m);
368 int (*mqo_setup)(const struct lu_env *env,
372 int (*mqo_cleanup)(const struct lu_env *env,
373 struct md_device *m);
375 int (*mqo_recovery)(const struct lu_env *env,
376 struct md_device *m);
378 int (*mqo_check)(const struct lu_env *env,
382 int (*mqo_on)(const struct lu_env *env,
386 int (*mqo_off)(const struct lu_env *env,
390 int (*mqo_setinfo)(const struct lu_env *env,
394 struct obd_dqinfo *dqinfo);
396 int (*mqo_getinfo)(const struct lu_env *env,
397 const struct md_device *m,
400 struct obd_dqinfo *dqinfo);
402 int (*mqo_setquota)(const struct lu_env *env,
406 struct obd_dqblk *dqblk);
408 int (*mqo_getquota)(const struct lu_env *env,
409 const struct md_device *m,
412 struct obd_dqblk *dqblk);
414 int (*mqo_getoinfo)(const struct lu_env *env,
415 const struct md_device *m,
418 struct obd_dqinfo *dqinfo);
420 int (*mqo_getoquota)(const struct lu_env *env,
421 const struct md_device *m,
424 struct obd_dqblk *dqblk);
426 int (*mqo_invalidate)(const struct lu_env *env,
430 int (*mqo_finvalidate)(const struct lu_env *env,
437 enum md_upcall_event {
438 /** Sync the md layer*/
439 MD_LOV_SYNC = (1 << 0),
440 /** Just for split, no need trans, for replay */
441 MD_NO_TRANS = (1 << 1),
442 MD_LOV_CONFIG = (1 << 2),
443 /** Trigger quota recovery */
444 MD_LOV_QUOTA = (1 << 3)
448 /** this lock protects upcall using against its removal
449 * read lock is for usage the upcall, write - for init/fini */
450 struct rw_semaphore mu_upcall_sem;
451 /** device to call, upper layer normally */
452 struct md_device *mu_upcall_dev;
453 /** upcall function */
454 int (*mu_upcall)(const struct lu_env *env, struct md_device *md,
455 enum md_upcall_event ev, void *data);
459 struct lu_device md_lu_dev;
460 const struct md_device_operations *md_ops;
461 struct md_upcall md_upcall;
464 static inline void md_upcall_init(struct md_device *m, void *upcl)
466 init_rwsem(&m->md_upcall.mu_upcall_sem);
467 m->md_upcall.mu_upcall_dev = NULL;
468 m->md_upcall.mu_upcall = upcl;
471 static inline void md_upcall_dev_set(struct md_device *m, struct md_device *up)
473 down_write(&m->md_upcall.mu_upcall_sem);
474 m->md_upcall.mu_upcall_dev = up;
475 up_write(&m->md_upcall.mu_upcall_sem);
478 static inline void md_upcall_fini(struct md_device *m)
480 down_write(&m->md_upcall.mu_upcall_sem);
481 m->md_upcall.mu_upcall_dev = NULL;
482 m->md_upcall.mu_upcall = NULL;
483 up_write(&m->md_upcall.mu_upcall_sem);
486 static inline int md_do_upcall(const struct lu_env *env, struct md_device *m,
487 enum md_upcall_event ev, void *data)
490 down_read(&m->md_upcall.mu_upcall_sem);
491 if (m->md_upcall.mu_upcall_dev != NULL &&
492 m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall != NULL) {
493 rc = m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall(env,
494 m->md_upcall.mu_upcall_dev,
497 up_read(&m->md_upcall.mu_upcall_sem);
502 struct lu_object mo_lu;
503 const struct md_object_operations *mo_ops;
504 const struct md_dir_operations *mo_dir_ops;
511 struct lu_site ms_lu;
513 * mds number of this site.
517 * Fid location database
519 struct lu_server_fld *ms_server_fld;
520 struct lu_client_fld *ms_client_fld;
525 struct lu_server_seq *ms_server_seq;
528 * Controller Seq Manager
530 struct lu_server_seq *ms_control_seq;
531 struct obd_export *ms_control_exp;
536 struct lu_client_seq *ms_client_seq;
539 static inline int lu_device_is_md(const struct lu_device *d)
541 return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_MD);
544 static inline struct md_device *lu2md_dev(const struct lu_device *d)
546 LASSERT(IS_ERR(d) || lu_device_is_md(d));
547 return container_of0(d, struct md_device, md_lu_dev);
550 static inline struct lu_device *md2lu_dev(struct md_device *d)
552 return &d->md_lu_dev;
555 static inline struct md_object *lu2md(const struct lu_object *o)
557 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
558 return container_of0(o, struct md_object, mo_lu);
561 static inline struct md_object *md_object_next(const struct md_object *obj)
563 return (obj ? lu2md(lu_object_next(&obj->mo_lu)) : NULL);
566 static inline struct md_device *md_obj2dev(const struct md_object *o)
568 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->mo_lu.lo_dev));
569 return container_of0(o->mo_lu.lo_dev, struct md_device, md_lu_dev);
572 static inline struct md_site *lu_site2md(const struct lu_site *s)
574 return container_of0(s, struct md_site, ms_lu);
577 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
579 return lu_device_init(&md->md_lu_dev, t);
582 static inline void md_device_fini(struct md_device *md)
584 lu_device_fini(&md->md_lu_dev);
587 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
588 struct md_device *md,
589 const struct lu_fid *f)
591 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
596 static inline int mo_permission(const struct lu_env *env,
602 LASSERT(c->mo_ops->moo_permission);
603 return c->mo_ops->moo_permission(env, p, c, at, mask);
606 static inline int mo_attr_get(const struct lu_env *env,
610 LASSERT(m->mo_ops->moo_attr_get);
611 return m->mo_ops->moo_attr_get(env, m, at);
614 static inline int mo_readlink(const struct lu_env *env,
618 LASSERT(m->mo_ops->moo_readlink);
619 return m->mo_ops->moo_readlink(env, m, buf);
622 static inline int mo_attr_set(const struct lu_env *env,
624 const struct md_attr *at)
626 LASSERT(m->mo_ops->moo_attr_set);
627 return m->mo_ops->moo_attr_set(env, m, at);
630 static inline int mo_xattr_get(const struct lu_env *env,
635 LASSERT(m->mo_ops->moo_xattr_get);
636 return m->mo_ops->moo_xattr_get(env, m, buf, name);
639 static inline int mo_xattr_del(const struct lu_env *env,
643 LASSERT(m->mo_ops->moo_xattr_del);
644 return m->mo_ops->moo_xattr_del(env, m, name);
647 static inline int mo_xattr_set(const struct lu_env *env,
649 const struct lu_buf *buf,
653 LASSERT(m->mo_ops->moo_xattr_set);
654 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
657 static inline int mo_xattr_list(const struct lu_env *env,
661 LASSERT(m->mo_ops->moo_xattr_list);
662 return m->mo_ops->moo_xattr_list(env, m, buf);
665 static inline int mo_open(const struct lu_env *env,
669 LASSERT(m->mo_ops->moo_open);
670 return m->mo_ops->moo_open(env, m, flags);
673 static inline int mo_close(const struct lu_env *env,
677 LASSERT(m->mo_ops->moo_close);
678 return m->mo_ops->moo_close(env, m, ma);
681 static inline int mo_readpage(const struct lu_env *env,
683 const struct lu_rdpg *rdpg)
685 LASSERT(m->mo_ops->moo_readpage);
686 return m->mo_ops->moo_readpage(env, m, rdpg);
689 static inline int mo_object_create(const struct lu_env *env,
691 const struct md_op_spec *spc,
694 LASSERT(m->mo_ops->moo_object_create);
695 return m->mo_ops->moo_object_create(env, m, spc, at);
698 static inline int mo_ref_add(const struct lu_env *env,
700 const struct md_attr *ma)
702 LASSERT(m->mo_ops->moo_ref_add);
703 return m->mo_ops->moo_ref_add(env, m, ma);
706 static inline int mo_ref_del(const struct lu_env *env,
710 LASSERT(m->mo_ops->moo_ref_del);
711 return m->mo_ops->moo_ref_del(env, m, ma);
714 static inline int mo_capa_get(const struct lu_env *env,
716 struct lustre_capa *c,
719 LASSERT(m->mo_ops->moo_capa_get);
720 return m->mo_ops->moo_capa_get(env, m, c, renewal);
723 static inline int mo_path(const struct lu_env *env, struct md_object *m,
724 char *path, int pathlen, __u64 *recno, int *linkno)
726 if (m->mo_ops->moo_path == NULL)
728 return m->mo_ops->moo_path(env, m, path, pathlen, recno, linkno);
731 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
733 LASSERT(m->mo_ops->moo_object_sync);
734 return m->mo_ops->moo_object_sync(env, m);
737 static inline dt_obj_version_t mo_version_get(const struct lu_env *env,
740 LASSERT(m->mo_ops->moo_version_get);
741 return m->mo_ops->moo_version_get(env, m);
744 static inline void mo_version_set(const struct lu_env *env,
745 struct md_object *m, dt_obj_version_t ver)
747 LASSERT(m->mo_ops->moo_version_set);
748 return m->mo_ops->moo_version_set(env, m, ver);
751 static inline int mdo_lookup(const struct lu_env *env,
753 const struct lu_name *lname,
755 struct md_op_spec *spec)
757 LASSERT(p->mo_dir_ops->mdo_lookup);
758 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
761 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
762 struct md_object *mo,
765 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
767 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
770 static inline int mdo_create(const struct lu_env *env,
772 const struct lu_name *lchild_name,
774 struct md_op_spec *spc,
777 LASSERT(c->mo_dir_ops->mdo_create);
778 return c->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
781 static inline int mdo_create_data(const struct lu_env *env,
784 const struct md_op_spec *spec,
787 LASSERT(c->mo_dir_ops->mdo_create_data);
788 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
791 static inline int mdo_rename(const struct lu_env *env,
792 struct md_object *sp,
793 struct md_object *tp,
794 const struct lu_fid *lf,
795 const struct lu_name *lsname,
797 const struct lu_name *ltname,
800 LASSERT(tp->mo_dir_ops->mdo_rename);
801 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
805 static inline int mdo_is_subdir(const struct lu_env *env,
806 struct md_object *mo,
807 const struct lu_fid *fid,
810 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
811 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
814 static inline int mdo_link(const struct lu_env *env,
817 const struct lu_name *lname,
820 LASSERT(s->mo_dir_ops->mdo_link);
821 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
824 static inline int mdo_unlink(const struct lu_env *env,
827 const struct lu_name *lname,
830 LASSERT(c->mo_dir_ops->mdo_unlink);
831 return c->mo_dir_ops->mdo_unlink(env, p, c, lname, ma);
834 static inline int mdo_name_insert(const struct lu_env *env,
836 const struct lu_name *lname,
837 const struct lu_fid *f,
838 const struct md_attr *ma)
840 LASSERT(p->mo_dir_ops->mdo_name_insert);
841 return p->mo_dir_ops->mdo_name_insert(env, p, lname, f, ma);
844 static inline int mdo_name_remove(const struct lu_env *env,
846 const struct lu_name *lname,
847 const struct md_attr *ma)
849 LASSERT(p->mo_dir_ops->mdo_name_remove);
850 return p->mo_dir_ops->mdo_name_remove(env, p, lname, ma);
853 static inline int mdo_rename_tgt(const struct lu_env *env,
856 const struct lu_fid *lf,
857 const struct lu_name *lname,
861 LASSERT(t->mo_dir_ops->mdo_rename_tgt);
862 return t->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
864 LASSERT(p->mo_dir_ops->mdo_rename_tgt);
865 return p->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
871 * Structure to hold object information. This is used to create object
872 * \pre llod_dir exist
874 struct lu_local_obj_desc {
875 const char *llod_dir;
876 const char *llod_name;
879 const struct dt_index_features * llod_feat;
880 struct list_head llod_linkage;
883 struct md_object *llo_store_resolve(const struct lu_env *env,
884 struct md_device *md,
885 struct dt_device *dt,
889 struct md_object *llo_store_open(const struct lu_env *env,
890 struct md_device *md,
891 struct dt_device *dt,
896 struct md_object *llo_store_create_index(const struct lu_env *env,
897 struct md_device *md,
898 struct dt_device *dt,
901 const struct lu_fid *fid,
902 const struct dt_index_features *feat);
904 struct md_object *llo_store_create(const struct lu_env *env,
905 struct md_device *md,
906 struct dt_device *dt,
909 const struct lu_fid *fid);
911 void llo_local_obj_register(struct lu_local_obj_desc *);
912 void llo_local_obj_unregister(struct lu_local_obj_desc *);
914 int llo_local_objects_setup(const struct lu_env *env,
915 struct md_device * md,
916 struct dt_device * dt);
919 #endif /* _LINUX_MD_OBJECT_H */