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 * 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);
248 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
249 dt_obj_version_t (*moo_version_get)(const struct lu_env *,
251 void (*moo_version_set)(const struct lu_env *, struct md_object *,
253 int (*moo_path)(const struct lu_env *env, struct md_object *obj,
254 char *path, int pathlen, __u64 *recno, int *linkno);
258 * Operations implemented for each directory object.
260 struct md_dir_operations {
261 int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
262 const struct lu_fid *fid, struct lu_fid *sfid);
264 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
265 const struct lu_name *lname, struct lu_fid *fid,
266 struct md_op_spec *spec);
268 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
269 struct md_object *obj,
272 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
273 const struct lu_name *lname, struct md_object *child,
274 struct md_op_spec *spec,
277 /** This method is used for creating data object for this meta object*/
278 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
280 const struct md_op_spec *spec,
283 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
284 struct md_object *tpobj, const struct lu_fid *lf,
285 const struct lu_name *lsname, struct md_object *tobj,
286 const struct lu_name *ltname, struct md_attr *ma);
288 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
289 struct md_object *src_obj, const struct lu_name *lname,
292 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
293 struct md_object *cobj, const struct lu_name *lname,
296 /** partial ops for cross-ref case */
297 int (*mdo_name_insert)(const struct lu_env *env,
298 struct md_object *obj,
299 const struct lu_name *lname,
300 const struct lu_fid *fid,
301 const struct md_attr *ma);
303 int (*mdo_name_remove)(const struct lu_env *env,
304 struct md_object *obj,
305 const struct lu_name *lname,
306 const struct md_attr *ma);
308 int (*mdo_rename_tgt)(const struct lu_env *env, struct md_object *pobj,
309 struct md_object *tobj, const struct lu_fid *fid,
310 const struct lu_name *lname, struct md_attr *ma);
313 struct md_device_operations {
314 /** meta-data device related handlers. */
315 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
318 int (*mdo_maxsize_get)(const struct lu_env *env, struct md_device *m,
319 int *md_size, int *cookie_size);
321 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
322 struct kstatfs *sfs);
324 int (*mdo_init_capa_ctxt)(const struct lu_env *env, struct md_device *m,
325 int mode, unsigned long timeout, __u32 alg,
326 struct lustre_capa_key *keys);
328 int (*mdo_update_capa_key)(const struct lu_env *env,
330 struct lustre_capa_key *key);
332 int (*mdo_llog_ctxt_get)(const struct lu_env *env,
333 struct md_device *m, int idx, void **h);
335 int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
336 unsigned int cmd, int len, void *data);
338 #ifdef HAVE_QUOTA_SUPPORT
339 struct md_quota_operations {
340 int (*mqo_notify)(const struct lu_env *env,
341 struct md_device *m);
343 int (*mqo_setup)(const struct lu_env *env,
347 int (*mqo_cleanup)(const struct lu_env *env,
348 struct md_device *m);
350 int (*mqo_recovery)(const struct lu_env *env,
351 struct md_device *m);
353 int (*mqo_check)(const struct lu_env *env,
355 struct obd_export *exp,
358 int (*mqo_on)(const struct lu_env *env,
362 int (*mqo_off)(const struct lu_env *env,
366 int (*mqo_setinfo)(const struct lu_env *env,
370 struct obd_dqinfo *dqinfo);
372 int (*mqo_getinfo)(const struct lu_env *env,
373 const struct md_device *m,
376 struct obd_dqinfo *dqinfo);
378 int (*mqo_setquota)(const struct lu_env *env,
382 struct obd_dqblk *dqblk);
384 int (*mqo_getquota)(const struct lu_env *env,
385 const struct md_device *m,
388 struct obd_dqblk *dqblk);
390 int (*mqo_getoinfo)(const struct lu_env *env,
391 const struct md_device *m,
394 struct obd_dqinfo *dqinfo);
396 int (*mqo_getoquota)(const struct lu_env *env,
397 const struct md_device *m,
400 struct obd_dqblk *dqblk);
402 int (*mqo_invalidate)(const struct lu_env *env,
406 int (*mqo_finvalidate)(const struct lu_env *env,
413 enum md_upcall_event {
414 /**sync the md layer*/
415 MD_LOV_SYNC = (1 << 0),
416 /** Just for split, no need trans, for replay */
417 MD_NO_TRANS = (1 << 1),
418 MD_LOV_CONFIG = (1 << 2)
422 /** this lock protects upcall using against its removal
423 * read lock is for usage the upcall, write - for init/fini */
424 struct rw_semaphore mu_upcall_sem;
425 /** device to call, upper layer normally */
426 struct md_device *mu_upcall_dev;
427 /** upcall function */
428 int (*mu_upcall)(const struct lu_env *env, struct md_device *md,
429 enum md_upcall_event ev);
433 struct lu_device md_lu_dev;
434 const struct md_device_operations *md_ops;
435 struct md_upcall md_upcall;
438 static inline void md_upcall_init(struct md_device *m, void *upcl)
440 init_rwsem(&m->md_upcall.mu_upcall_sem);
441 m->md_upcall.mu_upcall_dev = NULL;
442 m->md_upcall.mu_upcall = upcl;
445 static inline void md_upcall_dev_set(struct md_device *m, struct md_device *up)
447 down_write(&m->md_upcall.mu_upcall_sem);
448 m->md_upcall.mu_upcall_dev = up;
449 up_write(&m->md_upcall.mu_upcall_sem);
452 static inline void md_upcall_fini(struct md_device *m)
454 down_write(&m->md_upcall.mu_upcall_sem);
455 m->md_upcall.mu_upcall_dev = NULL;
456 m->md_upcall.mu_upcall = NULL;
457 up_write(&m->md_upcall.mu_upcall_sem);
460 static inline int md_do_upcall(const struct lu_env *env, struct md_device *m,
461 enum md_upcall_event ev)
464 down_read(&m->md_upcall.mu_upcall_sem);
465 if (m->md_upcall.mu_upcall_dev != NULL &&
466 m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall != NULL) {
467 rc = m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall(env,
468 m->md_upcall.mu_upcall_dev, ev);
470 up_read(&m->md_upcall.mu_upcall_sem);
475 struct lu_object mo_lu;
476 const struct md_object_operations *mo_ops;
477 const struct md_dir_operations *mo_dir_ops;
484 struct lu_site ms_lu;
486 * mds number of this site.
490 * Fid location database
492 struct lu_server_fld *ms_server_fld;
493 struct lu_client_fld *ms_client_fld;
498 struct lu_server_seq *ms_server_seq;
501 * Controller Seq Manager
503 struct lu_server_seq *ms_control_seq;
504 struct obd_export *ms_control_exp;
509 struct lu_client_seq *ms_client_seq;
512 static inline int lu_device_is_md(const struct lu_device *d)
514 return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_MD);
517 static inline struct md_device *lu2md_dev(const struct lu_device *d)
519 LASSERT(IS_ERR(d) || lu_device_is_md(d));
520 return container_of0(d, struct md_device, md_lu_dev);
523 static inline struct lu_device *md2lu_dev(struct md_device *d)
525 return &d->md_lu_dev;
528 static inline struct md_object *lu2md(const struct lu_object *o)
530 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
531 return container_of0(o, struct md_object, mo_lu);
534 static inline struct md_object *md_object_next(const struct md_object *obj)
536 return (obj ? lu2md(lu_object_next(&obj->mo_lu)) : NULL);
539 static inline struct md_device *md_obj2dev(const struct md_object *o)
541 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->mo_lu.lo_dev));
542 return container_of0(o->mo_lu.lo_dev, struct md_device, md_lu_dev);
545 static inline struct md_site *lu_site2md(const struct lu_site *s)
547 return container_of0(s, struct md_site, ms_lu);
550 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
552 return lu_device_init(&md->md_lu_dev, t);
555 static inline void md_device_fini(struct md_device *md)
557 lu_device_fini(&md->md_lu_dev);
560 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
561 struct md_device *md,
562 const struct lu_fid *f)
564 return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
569 static inline int mo_permission(const struct lu_env *env,
575 LASSERT(c->mo_ops->moo_permission);
576 return c->mo_ops->moo_permission(env, p, c, at, mask);
579 static inline int mo_attr_get(const struct lu_env *env,
583 LASSERT(m->mo_ops->moo_attr_get);
584 return m->mo_ops->moo_attr_get(env, m, at);
587 static inline int mo_readlink(const struct lu_env *env,
591 LASSERT(m->mo_ops->moo_readlink);
592 return m->mo_ops->moo_readlink(env, m, buf);
595 static inline int mo_attr_set(const struct lu_env *env,
597 const struct md_attr *at)
599 LASSERT(m->mo_ops->moo_attr_set);
600 return m->mo_ops->moo_attr_set(env, m, at);
603 static inline int mo_xattr_get(const struct lu_env *env,
608 LASSERT(m->mo_ops->moo_xattr_get);
609 return m->mo_ops->moo_xattr_get(env, m, buf, name);
612 static inline int mo_xattr_del(const struct lu_env *env,
616 LASSERT(m->mo_ops->moo_xattr_del);
617 return m->mo_ops->moo_xattr_del(env, m, name);
620 static inline int mo_xattr_set(const struct lu_env *env,
622 const struct lu_buf *buf,
626 LASSERT(m->mo_ops->moo_xattr_set);
627 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
630 static inline int mo_xattr_list(const struct lu_env *env,
634 LASSERT(m->mo_ops->moo_xattr_list);
635 return m->mo_ops->moo_xattr_list(env, m, buf);
638 static inline int mo_open(const struct lu_env *env,
642 LASSERT(m->mo_ops->moo_open);
643 return m->mo_ops->moo_open(env, m, flags);
646 static inline int mo_close(const struct lu_env *env,
650 LASSERT(m->mo_ops->moo_close);
651 return m->mo_ops->moo_close(env, m, ma);
654 static inline int mo_readpage(const struct lu_env *env,
656 const struct lu_rdpg *rdpg)
658 LASSERT(m->mo_ops->moo_readpage);
659 return m->mo_ops->moo_readpage(env, m, rdpg);
662 static inline int mo_object_create(const struct lu_env *env,
664 const struct md_op_spec *spc,
667 LASSERT(m->mo_ops->moo_object_create);
668 return m->mo_ops->moo_object_create(env, m, spc, at);
671 static inline int mo_ref_add(const struct lu_env *env,
673 const struct md_attr *ma)
675 LASSERT(m->mo_ops->moo_ref_add);
676 return m->mo_ops->moo_ref_add(env, m, ma);
679 static inline int mo_ref_del(const struct lu_env *env,
683 LASSERT(m->mo_ops->moo_ref_del);
684 return m->mo_ops->moo_ref_del(env, m, ma);
687 static inline int mo_capa_get(const struct lu_env *env,
689 struct lustre_capa *c,
692 LASSERT(m->mo_ops->moo_capa_get);
693 return m->mo_ops->moo_capa_get(env, m, c, renewal);
696 static inline int mo_path(const struct lu_env *env, struct md_object *m,
697 char *path, int pathlen, __u64 *recno, int *linkno)
699 if (m->mo_ops->moo_path == NULL)
701 return m->mo_ops->moo_path(env, m, path, pathlen, recno, linkno);
704 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
706 LASSERT(m->mo_ops->moo_object_sync);
707 return m->mo_ops->moo_object_sync(env, m);
710 static inline dt_obj_version_t mo_version_get(const struct lu_env *env,
713 LASSERT(m->mo_ops->moo_version_get);
714 return m->mo_ops->moo_version_get(env, m);
717 static inline void mo_version_set(const struct lu_env *env,
718 struct md_object *m, dt_obj_version_t ver)
720 LASSERT(m->mo_ops->moo_version_set);
721 return m->mo_ops->moo_version_set(env, m, ver);
724 static inline int mdo_lookup(const struct lu_env *env,
726 const struct lu_name *lname,
728 struct md_op_spec *spec)
730 LASSERT(p->mo_dir_ops->mdo_lookup);
731 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
734 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
735 struct md_object *mo,
738 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
740 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
743 static inline int mdo_create(const struct lu_env *env,
745 const struct lu_name *lchild_name,
747 struct md_op_spec *spc,
750 LASSERT(c->mo_dir_ops->mdo_create);
751 return c->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
754 static inline int mdo_create_data(const struct lu_env *env,
757 const struct md_op_spec *spec,
760 LASSERT(c->mo_dir_ops->mdo_create_data);
761 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
764 static inline int mdo_rename(const struct lu_env *env,
765 struct md_object *sp,
766 struct md_object *tp,
767 const struct lu_fid *lf,
768 const struct lu_name *lsname,
770 const struct lu_name *ltname,
773 LASSERT(tp->mo_dir_ops->mdo_rename);
774 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
778 static inline int mdo_is_subdir(const struct lu_env *env,
779 struct md_object *mo,
780 const struct lu_fid *fid,
783 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
784 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
787 static inline int mdo_link(const struct lu_env *env,
790 const struct lu_name *lname,
793 LASSERT(s->mo_dir_ops->mdo_link);
794 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
797 static inline int mdo_unlink(const struct lu_env *env,
800 const struct lu_name *lname,
803 LASSERT(c->mo_dir_ops->mdo_unlink);
804 return c->mo_dir_ops->mdo_unlink(env, p, c, lname, ma);
807 static inline int mdo_name_insert(const struct lu_env *env,
809 const struct lu_name *lname,
810 const struct lu_fid *f,
811 const struct md_attr *ma)
813 LASSERT(p->mo_dir_ops->mdo_name_insert);
814 return p->mo_dir_ops->mdo_name_insert(env, p, lname, f, ma);
817 static inline int mdo_name_remove(const struct lu_env *env,
819 const struct lu_name *lname,
820 const struct md_attr *ma)
822 LASSERT(p->mo_dir_ops->mdo_name_remove);
823 return p->mo_dir_ops->mdo_name_remove(env, p, lname, ma);
826 static inline int mdo_rename_tgt(const struct lu_env *env,
829 const struct lu_fid *lf,
830 const struct lu_name *lname,
834 LASSERT(t->mo_dir_ops->mdo_rename_tgt);
835 return t->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
837 LASSERT(p->mo_dir_ops->mdo_rename_tgt);
838 return p->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
844 * Structure to hold object information. This is used to create object
845 * \pre llod_dir exist
847 struct lu_local_obj_desc {
848 const char *llod_dir;
849 const char *llod_name;
852 const struct dt_index_features * llod_feat;
853 struct list_head llod_linkage;
856 struct md_object *llo_store_resolve(const struct lu_env *env,
857 struct md_device *md,
858 struct dt_device *dt,
862 struct md_object *llo_store_open(const struct lu_env *env,
863 struct md_device *md,
864 struct dt_device *dt,
869 struct md_object *llo_store_create_index(const struct lu_env *env,
870 struct md_device *md,
871 struct dt_device *dt,
874 const struct lu_fid *fid,
875 const struct dt_index_features *feat);
877 struct md_object *llo_store_create(const struct lu_env *env,
878 struct md_device *md,
879 struct dt_device *dt,
882 const struct lu_fid *fid);
884 void llo_local_obj_register(struct lu_local_obj_desc *);
885 void llo_local_obj_unregister(struct lu_local_obj_desc *);
887 int llo_local_objects_setup(const struct lu_env *env,
888 struct md_device * md,
889 struct dt_device * dt);
892 #endif /* _LINUX_MD_OBJECT_H */