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;
175 /** Create flag from client: such as MDS_OPEN_CREAT, and others. */
178 /** Should mdd do lookup sanity check or not. */
181 /** Current lock mode for parent dir where create is performing. */
182 mdl_mode_t sp_cr_mode;
184 /** Check for split */
189 * Operations implemented for each md object (both directory and leaf).
191 struct md_object_operations {
192 int (*moo_permission)(const struct lu_env *env,
193 struct md_object *pobj, struct md_object *cobj,
194 struct md_attr *attr, int mask);
196 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
197 struct md_attr *attr);
199 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
200 const struct md_attr *attr);
202 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
203 struct lu_buf *buf, const char *name);
205 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
208 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
209 const struct lu_buf *buf, const char *name,
212 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
215 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
216 const struct lu_rdpg *rdpg);
218 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
221 /** part of cross-ref operation */
222 int (*moo_object_create)(const struct lu_env *env,
223 struct md_object *obj,
224 const struct md_op_spec *spec,
227 int (*moo_ref_add)(const struct lu_env *env,
228 struct md_object *obj,
229 const struct md_attr *ma);
231 int (*moo_ref_del)(const struct lu_env *env,
232 struct md_object *obj,
235 int (*moo_open)(const struct lu_env *env,
236 struct md_object *obj, int flag);
238 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
241 int (*moo_capa_get)(const struct lu_env *, struct md_object *,
242 struct lustre_capa *, int renewal);
243 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
247 * Operations implemented for each directory object.
249 struct md_dir_operations {
250 int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
251 const struct lu_fid *fid, struct lu_fid *sfid);
253 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
254 const struct lu_name *lname, struct lu_fid *fid,
255 struct md_op_spec *spec);
257 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
258 struct md_object *obj,
261 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
262 const struct lu_name *lname, struct md_object *child,
263 struct md_op_spec *spec,
266 /** This method is used for creating data object for this meta object*/
267 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
269 const struct md_op_spec *spec,
272 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
273 struct md_object *tpobj, const struct lu_fid *lf,
274 const struct lu_name *lsname, struct md_object *tobj,
275 const struct lu_name *ltname, struct md_attr *ma);
277 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
278 struct md_object *src_obj, const struct lu_name *lname,
281 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
282 struct md_object *cobj, const struct lu_name *lname,
285 /** partial ops for cross-ref case */
286 int (*mdo_name_insert)(const struct lu_env *env,
287 struct md_object *obj,
288 const struct lu_name *lname,
289 const struct lu_fid *fid,
290 const struct md_attr *ma);
292 int (*mdo_name_remove)(const struct lu_env *env,
293 struct md_object *obj,
294 const struct lu_name *lname,
295 const struct md_attr *ma);
297 int (*mdo_rename_tgt)(const struct lu_env *env, struct md_object *pobj,
298 struct md_object *tobj, const struct lu_fid *fid,
299 const struct lu_name *lname, struct md_attr *ma);
302 struct md_device_operations {
303 /** meta-data device related handlers. */
304 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
307 int (*mdo_maxsize_get)(const struct lu_env *env, struct md_device *m,
308 int *md_size, int *cookie_size);
310 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
311 struct kstatfs *sfs);
313 int (*mdo_init_capa_ctxt)(const struct lu_env *env, struct md_device *m,
314 int mode, unsigned long timeout, __u32 alg,
315 struct lustre_capa_key *keys);
317 int (*mdo_update_capa_key)(const struct lu_env *env,
319 struct lustre_capa_key *key);
321 #ifdef HAVE_QUOTA_SUPPORT
322 struct md_quota_operations {
323 int (*mqo_notify)(const struct lu_env *env,
324 struct md_device *m);
326 int (*mqo_setup)(const struct lu_env *env,
330 int (*mqo_cleanup)(const struct lu_env *env,
331 struct md_device *m);
333 int (*mqo_recovery)(const struct lu_env *env,
334 struct md_device *m);
336 int (*mqo_check)(const struct lu_env *env,
338 struct obd_export *exp,
341 int (*mqo_on)(const struct lu_env *env,
346 int (*mqo_off)(const struct lu_env *env,
351 int (*mqo_setinfo)(const struct lu_env *env,
355 struct obd_dqinfo *dqinfo);
357 int (*mqo_getinfo)(const struct lu_env *env,
358 const struct md_device *m,
361 struct obd_dqinfo *dqinfo);
363 int (*mqo_setquota)(const struct lu_env *env,
367 struct obd_dqblk *dqblk);
369 int (*mqo_getquota)(const struct lu_env *env,
370 const struct md_device *m,
373 struct obd_dqblk *dqblk);
375 int (*mqo_getoinfo)(const struct lu_env *env,
376 const struct md_device *m,
379 struct obd_dqinfo *dqinfo);
381 int (*mqo_getoquota)(const struct lu_env *env,
382 const struct md_device *m,
385 struct obd_dqblk *dqblk);
387 int (*mqo_invalidate)(const struct lu_env *env,
391 int (*mqo_finvalidate)(const struct lu_env *env,
398 enum md_upcall_event {
399 /**sync the md layer*/
400 MD_LOV_SYNC = (1 << 0),
401 /** Just for split, no need trans, for replay */
402 MD_NO_TRANS = (1 << 1),
403 MD_LOV_CONFIG = (1 << 2)
407 /** this lock protects upcall using against its removal
408 * read lock is for usage the upcall, write - for init/fini */
409 struct rw_semaphore mu_upcall_sem;
410 /** device to call, upper layer normally */
411 struct md_device *mu_upcall_dev;
412 /** upcall function */
413 int (*mu_upcall)(const struct lu_env *env, struct md_device *md,
414 enum md_upcall_event ev);
418 struct lu_device md_lu_dev;
419 const struct md_device_operations *md_ops;
420 struct md_upcall md_upcall;
423 static inline void md_upcall_init(struct md_device *m, void *upcl)
425 init_rwsem(&m->md_upcall.mu_upcall_sem);
426 m->md_upcall.mu_upcall_dev = NULL;
427 m->md_upcall.mu_upcall = upcl;
430 static inline void md_upcall_dev_set(struct md_device *m, struct md_device *up)
432 down_write(&m->md_upcall.mu_upcall_sem);
433 m->md_upcall.mu_upcall_dev = up;
434 up_write(&m->md_upcall.mu_upcall_sem);
437 static inline void md_upcall_fini(struct md_device *m)
439 down_write(&m->md_upcall.mu_upcall_sem);
440 m->md_upcall.mu_upcall_dev = NULL;
441 m->md_upcall.mu_upcall = NULL;
442 up_write(&m->md_upcall.mu_upcall_sem);
445 static inline int md_do_upcall(const struct lu_env *env, struct md_device *m,
446 enum md_upcall_event ev)
449 down_read(&m->md_upcall.mu_upcall_sem);
450 if (m->md_upcall.mu_upcall_dev != NULL &&
451 m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall != NULL) {
452 rc = m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall(env,
453 m->md_upcall.mu_upcall_dev, ev);
455 up_read(&m->md_upcall.mu_upcall_sem);
460 struct lu_object mo_lu;
461 const struct md_object_operations *mo_ops;
462 const struct md_dir_operations *mo_dir_ops;
469 struct lu_site ms_lu;
471 * mds number of this site.
475 * Fid location database
477 struct lu_server_fld *ms_server_fld;
478 struct lu_client_fld *ms_client_fld;
483 struct lu_server_seq *ms_server_seq;
486 * Controller Seq Manager
488 struct lu_server_seq *ms_control_seq;
489 struct obd_export *ms_control_exp;
494 struct lu_client_seq *ms_client_seq;
497 static inline int lu_device_is_md(const struct lu_device *d)
499 return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_MD);
502 static inline struct md_device *lu2md_dev(const struct lu_device *d)
504 LASSERT(IS_ERR(d) || lu_device_is_md(d));
505 return container_of0(d, struct md_device, md_lu_dev);
508 static inline struct lu_device *md2lu_dev(struct md_device *d)
510 return &d->md_lu_dev;
513 static inline struct md_object *lu2md(const struct lu_object *o)
515 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
516 return container_of0(o, struct md_object, mo_lu);
519 static inline struct md_object *md_object_next(const struct md_object *obj)
521 return (obj ? lu2md(lu_object_next(&obj->mo_lu)) : NULL);
524 static inline struct md_device *md_obj2dev(const struct md_object *o)
526 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->mo_lu.lo_dev));
527 return container_of0(o->mo_lu.lo_dev, struct md_device, md_lu_dev);
530 static inline struct md_site *lu_site2md(const struct lu_site *s)
532 return container_of0(s, struct md_site, ms_lu);
535 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
537 return lu_device_init(&md->md_lu_dev, t);
540 static inline void md_device_fini(struct md_device *md)
542 lu_device_fini(&md->md_lu_dev);
545 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
546 struct md_device *md,
547 const struct lu_fid *f)
549 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
554 static inline int mo_permission(const struct lu_env *env,
560 LASSERT(c->mo_ops->moo_permission);
561 return c->mo_ops->moo_permission(env, p, c, at, mask);
564 static inline int mo_attr_get(const struct lu_env *env,
568 LASSERT(m->mo_ops->moo_attr_get);
569 return m->mo_ops->moo_attr_get(env, m, at);
572 static inline int mo_readlink(const struct lu_env *env,
576 LASSERT(m->mo_ops->moo_readlink);
577 return m->mo_ops->moo_readlink(env, m, buf);
580 static inline int mo_attr_set(const struct lu_env *env,
582 const struct md_attr *at)
584 LASSERT(m->mo_ops->moo_attr_set);
585 return m->mo_ops->moo_attr_set(env, m, at);
588 static inline int mo_xattr_get(const struct lu_env *env,
593 LASSERT(m->mo_ops->moo_xattr_get);
594 return m->mo_ops->moo_xattr_get(env, m, buf, name);
597 static inline int mo_xattr_del(const struct lu_env *env,
601 LASSERT(m->mo_ops->moo_xattr_del);
602 return m->mo_ops->moo_xattr_del(env, m, name);
605 static inline int mo_xattr_set(const struct lu_env *env,
607 const struct lu_buf *buf,
611 LASSERT(m->mo_ops->moo_xattr_set);
612 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
615 static inline int mo_xattr_list(const struct lu_env *env,
619 LASSERT(m->mo_ops->moo_xattr_list);
620 return m->mo_ops->moo_xattr_list(env, m, buf);
623 static inline int mo_open(const struct lu_env *env,
627 LASSERT(m->mo_ops->moo_open);
628 return m->mo_ops->moo_open(env, m, flags);
631 static inline int mo_close(const struct lu_env *env,
635 LASSERT(m->mo_ops->moo_close);
636 return m->mo_ops->moo_close(env, m, ma);
639 static inline int mo_readpage(const struct lu_env *env,
641 const struct lu_rdpg *rdpg)
643 LASSERT(m->mo_ops->moo_readpage);
644 return m->mo_ops->moo_readpage(env, m, rdpg);
647 static inline int mo_object_create(const struct lu_env *env,
649 const struct md_op_spec *spc,
652 LASSERT(m->mo_ops->moo_object_create);
653 return m->mo_ops->moo_object_create(env, m, spc, at);
656 static inline int mo_ref_add(const struct lu_env *env,
658 const struct md_attr *ma)
660 LASSERT(m->mo_ops->moo_ref_add);
661 return m->mo_ops->moo_ref_add(env, m, ma);
664 static inline int mo_ref_del(const struct lu_env *env,
668 LASSERT(m->mo_ops->moo_ref_del);
669 return m->mo_ops->moo_ref_del(env, m, ma);
672 static inline int mo_capa_get(const struct lu_env *env,
674 struct lustre_capa *c,
677 LASSERT(m->mo_ops->moo_capa_get);
678 return m->mo_ops->moo_capa_get(env, m, c, renewal);
681 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
683 LASSERT(m->mo_ops->moo_object_sync);
684 return m->mo_ops->moo_object_sync(env, m);
687 static inline int mdo_lookup(const struct lu_env *env,
689 const struct lu_name *lname,
691 struct md_op_spec *spec)
693 LASSERT(p->mo_dir_ops->mdo_lookup);
694 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
697 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
698 struct md_object *mo,
701 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
703 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
706 static inline int mdo_create(const struct lu_env *env,
708 const struct lu_name *lchild_name,
710 struct md_op_spec *spc,
713 LASSERT(c->mo_dir_ops->mdo_create);
714 return c->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
717 static inline int mdo_create_data(const struct lu_env *env,
720 const struct md_op_spec *spec,
723 LASSERT(c->mo_dir_ops->mdo_create_data);
724 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
727 static inline int mdo_rename(const struct lu_env *env,
728 struct md_object *sp,
729 struct md_object *tp,
730 const struct lu_fid *lf,
731 const struct lu_name *lsname,
733 const struct lu_name *ltname,
736 LASSERT(tp->mo_dir_ops->mdo_rename);
737 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
741 static inline int mdo_is_subdir(const struct lu_env *env,
742 struct md_object *mo,
743 const struct lu_fid *fid,
746 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
747 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
750 static inline int mdo_link(const struct lu_env *env,
753 const struct lu_name *lname,
756 LASSERT(s->mo_dir_ops->mdo_link);
757 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
760 static inline int mdo_unlink(const struct lu_env *env,
763 const struct lu_name *lname,
766 LASSERT(c->mo_dir_ops->mdo_unlink);
767 return c->mo_dir_ops->mdo_unlink(env, p, c, lname, ma);
770 static inline int mdo_name_insert(const struct lu_env *env,
772 const struct lu_name *lname,
773 const struct lu_fid *f,
774 const struct md_attr *ma)
776 LASSERT(p->mo_dir_ops->mdo_name_insert);
777 return p->mo_dir_ops->mdo_name_insert(env, p, lname, f, ma);
780 static inline int mdo_name_remove(const struct lu_env *env,
782 const struct lu_name *lname,
783 const struct md_attr *ma)
785 LASSERT(p->mo_dir_ops->mdo_name_remove);
786 return p->mo_dir_ops->mdo_name_remove(env, p, lname, ma);
789 static inline int mdo_rename_tgt(const struct lu_env *env,
792 const struct lu_fid *lf,
793 const struct lu_name *lname,
797 LASSERT(t->mo_dir_ops->mdo_rename_tgt);
798 return t->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
800 LASSERT(p->mo_dir_ops->mdo_rename_tgt);
801 return p->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
807 #endif /* _LINUX_MD_OBJECT_H */