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 <lu_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 * Implemented in mdd/mdd_handler.c.
107 * XXX should be moved into separate .h/.c together with all md security
108 * related definitions.
110 struct md_ucred *md_ucred(const struct lu_env *env);
111 struct md_capainfo *md_capainfo(const struct lu_env *env);
113 /** metadata attributes */
117 MA_COOKIE = (1 << 2),
120 MA_ACL_DEF = (1 << 5),
121 MA_LOV_DEF = (1 << 6)
138 MDT_REG_LOCK = (1 << 0),
139 MDT_PDO_LOCK = (1 << 1)
146 struct lu_attr ma_attr;
147 struct lov_mds_md *ma_lmm;
149 struct lmv_stripe_md *ma_lmv;
153 struct llog_cookie *ma_cookie;
155 struct lustre_capa *ma_capa;
158 /** Additional parameters for create */
161 /** symlink target */
162 const char *sp_symname;
163 /** parent FID for cross-ref mkdir */
164 const struct lu_fid *sp_pfid;
165 /** eadata for regular files */
167 /** lov objs exist already */
168 const struct lu_fid *fid;
173 /** don't create lov objects or llog cookie - this replay */
176 /** Create flag from client: such as MDS_OPEN_CREAT, and others. */
179 /** Should mdd do lookup sanity check or not. */
182 /** Current lock mode for parent dir where create is performing. */
183 mdl_mode_t sp_cr_mode;
185 /** Check for split */
188 /** to create directory */
189 const struct dt_index_features *sp_feat;
193 * Operations implemented for each md object (both directory and leaf).
195 struct md_object_operations {
196 int (*moo_permission)(const struct lu_env *env,
197 struct md_object *pobj, struct md_object *cobj,
198 struct md_attr *attr, int mask);
200 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
201 struct md_attr *attr);
203 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
204 const struct md_attr *attr);
206 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
207 struct lu_buf *buf, const char *name);
209 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
212 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
213 const struct lu_buf *buf, const char *name,
216 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
219 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
220 const struct lu_rdpg *rdpg);
222 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
225 /** part of cross-ref operation */
226 int (*moo_object_create)(const struct lu_env *env,
227 struct md_object *obj,
228 const struct md_op_spec *spec,
231 int (*moo_ref_add)(const struct lu_env *env,
232 struct md_object *obj,
233 const struct md_attr *ma);
235 int (*moo_ref_del)(const struct lu_env *env,
236 struct md_object *obj,
239 int (*moo_open)(const struct lu_env *env,
240 struct md_object *obj, int flag);
242 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
245 int (*moo_capa_get)(const struct lu_env *, struct md_object *,
246 struct lustre_capa *, int renewal);
247 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
251 * Operations implemented for each directory object.
253 struct md_dir_operations {
254 int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
255 const struct lu_fid *fid, struct lu_fid *sfid);
257 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
258 const struct lu_name *lname, struct lu_fid *fid,
259 struct md_op_spec *spec);
261 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
262 struct md_object *obj,
265 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
266 const struct lu_name *lname, struct md_object *child,
267 struct md_op_spec *spec,
270 /** This method is used for creating data object for this meta object*/
271 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
273 const struct md_op_spec *spec,
276 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
277 struct md_object *tpobj, const struct lu_fid *lf,
278 const struct lu_name *lsname, struct md_object *tobj,
279 const struct lu_name *ltname, struct md_attr *ma);
281 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
282 struct md_object *src_obj, const struct lu_name *lname,
285 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
286 struct md_object *cobj, const struct lu_name *lname,
289 /** partial ops for cross-ref case */
290 int (*mdo_name_insert)(const struct lu_env *env,
291 struct md_object *obj,
292 const struct lu_name *lname,
293 const struct lu_fid *fid,
294 const struct md_attr *ma);
296 int (*mdo_name_remove)(const struct lu_env *env,
297 struct md_object *obj,
298 const struct lu_name *lname,
299 const struct md_attr *ma);
301 int (*mdo_rename_tgt)(const struct lu_env *env, struct md_object *pobj,
302 struct md_object *tobj, const struct lu_fid *fid,
303 const struct lu_name *lname, struct md_attr *ma);
306 struct md_device_operations {
307 /** meta-data device related handlers. */
308 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
311 int (*mdo_maxsize_get)(const struct lu_env *env, struct md_device *m,
312 int *md_size, int *cookie_size);
314 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
315 struct kstatfs *sfs);
317 int (*mdo_init_capa_ctxt)(const struct lu_env *env, struct md_device *m,
318 int mode, unsigned long timeout, __u32 alg,
319 struct lustre_capa_key *keys);
321 int (*mdo_update_capa_key)(const struct lu_env *env,
323 struct lustre_capa_key *key);
325 #ifdef HAVE_QUOTA_SUPPORT
326 struct md_quota_operations {
327 int (*mqo_notify)(const struct lu_env *env,
328 struct md_device *m);
330 int (*mqo_setup)(const struct lu_env *env,
334 int (*mqo_cleanup)(const struct lu_env *env,
335 struct md_device *m);
337 int (*mqo_recovery)(const struct lu_env *env,
338 struct md_device *m);
340 int (*mqo_check)(const struct lu_env *env,
342 struct obd_export *exp,
345 int (*mqo_on)(const struct lu_env *env,
350 int (*mqo_off)(const struct lu_env *env,
355 int (*mqo_setinfo)(const struct lu_env *env,
359 struct obd_dqinfo *dqinfo);
361 int (*mqo_getinfo)(const struct lu_env *env,
362 const struct md_device *m,
365 struct obd_dqinfo *dqinfo);
367 int (*mqo_setquota)(const struct lu_env *env,
371 struct obd_dqblk *dqblk);
373 int (*mqo_getquota)(const struct lu_env *env,
374 const struct md_device *m,
377 struct obd_dqblk *dqblk);
379 int (*mqo_getoinfo)(const struct lu_env *env,
380 const struct md_device *m,
383 struct obd_dqinfo *dqinfo);
385 int (*mqo_getoquota)(const struct lu_env *env,
386 const struct md_device *m,
389 struct obd_dqblk *dqblk);
391 int (*mqo_invalidate)(const struct lu_env *env,
395 int (*mqo_finvalidate)(const struct lu_env *env,
402 enum md_upcall_event {
403 /**sync the md layer*/
404 MD_LOV_SYNC = (1 << 0),
405 /** Just for split, no need trans, for replay */
406 MD_NO_TRANS = (1 << 1),
407 MD_LOV_CONFIG = (1 << 2)
411 /** this lock protects upcall using against its removal
412 * read lock is for usage the upcall, write - for init/fini */
413 struct rw_semaphore mu_upcall_sem;
414 /** device to call, upper layer normally */
415 struct md_device *mu_upcall_dev;
416 /** upcall function */
417 int (*mu_upcall)(const struct lu_env *env, struct md_device *md,
418 enum md_upcall_event ev);
422 struct lu_device md_lu_dev;
423 const struct md_device_operations *md_ops;
424 struct md_upcall md_upcall;
427 static inline void md_upcall_init(struct md_device *m, void *upcl)
429 init_rwsem(&m->md_upcall.mu_upcall_sem);
430 m->md_upcall.mu_upcall_dev = NULL;
431 m->md_upcall.mu_upcall = upcl;
434 static inline void md_upcall_dev_set(struct md_device *m, struct md_device *up)
436 down_write(&m->md_upcall.mu_upcall_sem);
437 m->md_upcall.mu_upcall_dev = up;
438 up_write(&m->md_upcall.mu_upcall_sem);
441 static inline void md_upcall_fini(struct md_device *m)
443 down_write(&m->md_upcall.mu_upcall_sem);
444 m->md_upcall.mu_upcall_dev = NULL;
445 m->md_upcall.mu_upcall = NULL;
446 up_write(&m->md_upcall.mu_upcall_sem);
449 static inline int md_do_upcall(const struct lu_env *env, struct md_device *m,
450 enum md_upcall_event ev)
453 down_read(&m->md_upcall.mu_upcall_sem);
454 if (m->md_upcall.mu_upcall_dev != NULL &&
455 m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall != NULL) {
456 rc = m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall(env,
457 m->md_upcall.mu_upcall_dev, ev);
459 up_read(&m->md_upcall.mu_upcall_sem);
464 struct lu_object mo_lu;
465 const struct md_object_operations *mo_ops;
466 const struct md_dir_operations *mo_dir_ops;
473 struct lu_site ms_lu;
475 * mds number of this site.
479 * Fid location database
481 struct lu_server_fld *ms_server_fld;
482 struct lu_client_fld *ms_client_fld;
487 struct lu_server_seq *ms_server_seq;
490 * Controller Seq Manager
492 struct lu_server_seq *ms_control_seq;
493 struct obd_export *ms_control_exp;
498 struct lu_client_seq *ms_client_seq;
501 static inline int lu_device_is_md(const struct lu_device *d)
503 return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_MD);
506 static inline struct md_device *lu2md_dev(const struct lu_device *d)
508 LASSERT(IS_ERR(d) || lu_device_is_md(d));
509 return container_of0(d, struct md_device, md_lu_dev);
512 static inline struct lu_device *md2lu_dev(struct md_device *d)
514 return &d->md_lu_dev;
517 static inline struct md_object *lu2md(const struct lu_object *o)
519 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
520 return container_of0(o, struct md_object, mo_lu);
523 static inline struct md_object *md_object_next(const struct md_object *obj)
525 return (obj ? lu2md(lu_object_next(&obj->mo_lu)) : NULL);
528 static inline struct md_device *md_obj2dev(const struct md_object *o)
530 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->mo_lu.lo_dev));
531 return container_of0(o->mo_lu.lo_dev, struct md_device, md_lu_dev);
534 static inline struct md_site *lu_site2md(const struct lu_site *s)
536 return container_of0(s, struct md_site, ms_lu);
539 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
541 return lu_device_init(&md->md_lu_dev, t);
544 static inline void md_device_fini(struct md_device *md)
546 lu_device_fini(&md->md_lu_dev);
549 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
550 struct md_device *md,
551 const struct lu_fid *f)
553 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
558 static inline int mo_permission(const struct lu_env *env,
564 LASSERT(c->mo_ops->moo_permission);
565 return c->mo_ops->moo_permission(env, p, c, at, mask);
568 static inline int mo_attr_get(const struct lu_env *env,
572 LASSERT(m->mo_ops->moo_attr_get);
573 return m->mo_ops->moo_attr_get(env, m, at);
576 static inline int mo_readlink(const struct lu_env *env,
580 LASSERT(m->mo_ops->moo_readlink);
581 return m->mo_ops->moo_readlink(env, m, buf);
584 static inline int mo_attr_set(const struct lu_env *env,
586 const struct md_attr *at)
588 LASSERT(m->mo_ops->moo_attr_set);
589 return m->mo_ops->moo_attr_set(env, m, at);
592 static inline int mo_xattr_get(const struct lu_env *env,
597 LASSERT(m->mo_ops->moo_xattr_get);
598 return m->mo_ops->moo_xattr_get(env, m, buf, name);
601 static inline int mo_xattr_del(const struct lu_env *env,
605 LASSERT(m->mo_ops->moo_xattr_del);
606 return m->mo_ops->moo_xattr_del(env, m, name);
609 static inline int mo_xattr_set(const struct lu_env *env,
611 const struct lu_buf *buf,
615 LASSERT(m->mo_ops->moo_xattr_set);
616 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
619 static inline int mo_xattr_list(const struct lu_env *env,
623 LASSERT(m->mo_ops->moo_xattr_list);
624 return m->mo_ops->moo_xattr_list(env, m, buf);
627 static inline int mo_open(const struct lu_env *env,
631 LASSERT(m->mo_ops->moo_open);
632 return m->mo_ops->moo_open(env, m, flags);
635 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);
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_object_sync(const struct lu_env *env, struct md_object *m)
687 LASSERT(m->mo_ops->moo_object_sync);
688 return m->mo_ops->moo_object_sync(env, m);
691 static inline int mdo_lookup(const struct lu_env *env,
693 const struct lu_name *lname,
695 struct md_op_spec *spec)
697 LASSERT(p->mo_dir_ops->mdo_lookup);
698 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
701 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
702 struct md_object *mo,
705 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
707 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
710 static inline int mdo_create(const struct lu_env *env,
712 const struct lu_name *lchild_name,
714 struct md_op_spec *spc,
717 LASSERT(c->mo_dir_ops->mdo_create);
718 return c->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
721 static inline int mdo_create_data(const struct lu_env *env,
724 const struct md_op_spec *spec,
727 LASSERT(c->mo_dir_ops->mdo_create_data);
728 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
731 static inline int mdo_rename(const struct lu_env *env,
732 struct md_object *sp,
733 struct md_object *tp,
734 const struct lu_fid *lf,
735 const struct lu_name *lsname,
737 const struct lu_name *ltname,
740 LASSERT(tp->mo_dir_ops->mdo_rename);
741 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
745 static inline int mdo_is_subdir(const struct lu_env *env,
746 struct md_object *mo,
747 const struct lu_fid *fid,
750 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
751 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
754 static inline int mdo_link(const struct lu_env *env,
757 const struct lu_name *lname,
760 LASSERT(s->mo_dir_ops->mdo_link);
761 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
764 static inline int mdo_unlink(const struct lu_env *env,
767 const struct lu_name *lname,
770 LASSERT(c->mo_dir_ops->mdo_unlink);
771 return c->mo_dir_ops->mdo_unlink(env, p, c, lname, ma);
774 static inline int mdo_name_insert(const struct lu_env *env,
776 const struct lu_name *lname,
777 const struct lu_fid *f,
778 const struct md_attr *ma)
780 LASSERT(p->mo_dir_ops->mdo_name_insert);
781 return p->mo_dir_ops->mdo_name_insert(env, p, lname, f, ma);
784 static inline int mdo_name_remove(const struct lu_env *env,
786 const struct lu_name *lname,
787 const struct md_attr *ma)
789 LASSERT(p->mo_dir_ops->mdo_name_remove);
790 return p->mo_dir_ops->mdo_name_remove(env, p, lname, ma);
793 static inline int mdo_rename_tgt(const struct lu_env *env,
796 const struct lu_fid *lf,
797 const struct lu_name *lname,
801 LASSERT(t->mo_dir_ops->mdo_rename_tgt);
802 return t->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
804 LASSERT(p->mo_dir_ops->mdo_rename_tgt);
805 return p->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
811 * Structure to hold object information. This is used to create object
813 struct lu_local_obj_desc {
814 const char *llod_name;
817 const struct dt_index_features * llod_feat;
818 struct list_head llod_linkage;
821 struct md_object *llo_store_resolve(const struct lu_env *env,
822 struct md_device *md,
823 struct dt_device *dt,
827 struct md_object *llo_store_open(const struct lu_env *env,
828 struct md_device *md,
829 struct dt_device *dt,
834 struct md_object *llo_store_create_index(const struct lu_env *env,
835 struct md_device *md,
836 struct dt_device *dt,
839 const struct lu_fid *fid,
840 const struct dt_index_features *feat);
842 struct md_object *llo_store_create(const struct lu_env *env,
843 struct md_device *md,
844 struct dt_device *dt,
847 const struct lu_fid *fid);
849 int llo_local_obj_register(struct lu_local_obj_desc *);
851 int llo_local_objects_setup(const struct lu_env *env,
852 struct md_device * md,
853 struct dt_device * dt);
856 #endif /* _LINUX_MD_OBJECT_H */