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.
56 * super-class definitions.
58 #include <lu_object.h>
62 struct md_device_operations;
86 struct group_info *mu_ginfo;
87 struct md_identity *mu_identity;
90 #define MD_CAPAINFO_MAX 5
92 /* there are at most 5 fids in one operation, see rename, NOTE the last one
93 * is a temporary one used for is_subdir() */
95 const struct lu_fid *mc_fid[MD_CAPAINFO_MAX];
96 struct lustre_capa *mc_capa[MD_CAPAINFO_MAX];
100 * Implemented in mdd/mdd_handler.c.
102 * XXX should be moved into separate .h/.c together with all md security
103 * related definitions.
105 struct md_ucred *md_ucred(const struct lu_env *env);
106 struct md_capainfo *md_capainfo(const struct lu_env *env);
108 /* metadata attributes */
112 MA_COOKIE = (1 << 2),
115 MA_ACL_DEF = (1 << 5),
116 MA_LOV_DEF = (1 << 6)
133 MDT_REG_LOCK = (1 << 0),
134 MDT_PDO_LOCK = (1 << 1)
141 struct lu_attr ma_attr;
142 struct lov_mds_md *ma_lmm;
144 struct lmv_stripe_md *ma_lmv;
148 struct llog_cookie *ma_cookie;
150 struct lustre_capa *ma_capa;
153 /* Additional parameters for create */
157 const char *sp_symname;
158 /* parent FID for cross-ref mkdir */
159 const struct lu_fid *sp_pfid;
160 /* eadata for regular files */
162 /* lov objs exist already */
163 const struct lu_fid *fid;
170 /* Create flag from client: such as MDS_OPEN_CREAT, and others. */
173 /* Should mdd do lookup sanity check or not. */
176 /* Current lock mode for parent dir where create is performing. */
177 mdl_mode_t sp_cr_mode;
179 /* Check for split */
184 * Operations implemented for each md object (both directory and leaf).
186 struct md_object_operations {
187 int (*moo_permission)(const struct lu_env *env,
188 struct md_object *pobj, struct md_object *cobj,
189 struct md_attr *attr, int mask);
191 int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
192 struct md_attr *attr);
194 int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
195 const struct md_attr *attr);
197 int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
198 struct lu_buf *buf, const char *name);
200 int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
203 int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
204 const struct lu_buf *buf, const char *name,
207 int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
210 int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
211 const struct lu_rdpg *rdpg);
213 int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
216 /* part of cross-ref operation */
217 int (*moo_object_create)(const struct lu_env *env,
218 struct md_object *obj,
219 const struct md_op_spec *spec,
222 int (*moo_ref_add)(const struct lu_env *env,
223 struct md_object *obj,
224 const struct md_attr *ma);
226 int (*moo_ref_del)(const struct lu_env *env,
227 struct md_object *obj,
230 int (*moo_open)(const struct lu_env *env,
231 struct md_object *obj, int flag);
233 int (*moo_close)(const struct lu_env *env, struct md_object *obj,
236 int (*moo_capa_get)(const struct lu_env *, struct md_object *,
237 struct lustre_capa *, int renewal);
238 int (*moo_object_sync)(const struct lu_env *, struct md_object *);
242 * Operations implemented for each directory object.
244 struct md_dir_operations {
245 int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
246 const struct lu_fid *fid, struct lu_fid *sfid);
248 int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
249 const struct lu_name *lname, struct lu_fid *fid,
250 struct md_op_spec *spec);
252 mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
253 struct md_object *obj,
256 int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
257 const struct lu_name *lname, struct md_object *child,
258 struct md_op_spec *spec,
261 /* This method is used for creating data object for this meta object*/
262 int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
264 const struct md_op_spec *spec,
267 int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
268 struct md_object *tpobj, const struct lu_fid *lf,
269 const struct lu_name *lsname, struct md_object *tobj,
270 const struct lu_name *ltname, struct md_attr *ma);
272 int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
273 struct md_object *src_obj, const struct lu_name *lname,
276 int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
277 struct md_object *cobj, const struct lu_name *lname,
280 /* partial ops for cross-ref case */
281 int (*mdo_name_insert)(const struct lu_env *env,
282 struct md_object *obj,
283 const struct lu_name *lname,
284 const struct lu_fid *fid,
285 const struct md_attr *ma);
287 int (*mdo_name_remove)(const struct lu_env *env,
288 struct md_object *obj,
289 const struct lu_name *lname,
290 const struct md_attr *ma);
292 int (*mdo_rename_tgt)(const struct lu_env *env, struct md_object *pobj,
293 struct md_object *tobj, const struct lu_fid *fid,
294 const struct lu_name *lname, struct md_attr *ma);
297 struct md_device_operations {
298 /* meta-data device related handlers. */
299 int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
302 int (*mdo_maxsize_get)(const struct lu_env *env, struct md_device *m,
303 int *md_size, int *cookie_size);
305 int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
306 struct kstatfs *sfs);
308 int (*mdo_init_capa_ctxt)(const struct lu_env *env, struct md_device *m,
309 int mode, unsigned long timeout, __u32 alg,
310 struct lustre_capa_key *keys);
312 int (*mdo_update_capa_key)(const struct lu_env *env,
314 struct lustre_capa_key *key);
317 enum md_upcall_event {
318 /*sync the md layer*/
319 MD_LOV_SYNC = (1 << 0),
320 MD_NO_TRANS = (1 << 1), /* Just for split, no need trans, for replay */
321 MD_LOV_CONFIG = (1 << 2)
325 /* this lock protects upcall using against its removal
326 * read lock is for usage the upcall, write - for init/fini */
327 struct rw_semaphore mu_upcall_sem;
328 /* device to call, upper layer normally */
329 struct md_device *mu_upcall_dev;
330 /* upcall function */
331 int (*mu_upcall)(const struct lu_env *env, struct md_device *md,
332 enum md_upcall_event ev);
336 struct lu_device md_lu_dev;
337 struct md_device_operations *md_ops;
338 struct md_upcall md_upcall;
341 static inline void md_upcall_init(struct md_device *m, void *upcl)
343 init_rwsem(&m->md_upcall.mu_upcall_sem);
344 m->md_upcall.mu_upcall_dev = NULL;
345 m->md_upcall.mu_upcall = upcl;
348 static inline void md_upcall_dev_set(struct md_device *m, struct md_device *up)
350 down_write(&m->md_upcall.mu_upcall_sem);
351 m->md_upcall.mu_upcall_dev = up;
352 up_write(&m->md_upcall.mu_upcall_sem);
355 static inline void md_upcall_fini(struct md_device *m)
357 down_write(&m->md_upcall.mu_upcall_sem);
358 m->md_upcall.mu_upcall_dev = NULL;
359 m->md_upcall.mu_upcall = NULL;
360 up_write(&m->md_upcall.mu_upcall_sem);
363 static inline int md_do_upcall(const struct lu_env *env, struct md_device *m,
364 enum md_upcall_event ev)
367 down_read(&m->md_upcall.mu_upcall_sem);
368 if (m->md_upcall.mu_upcall_dev != NULL &&
369 m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall != NULL) {
370 rc = m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall(env,
371 m->md_upcall.mu_upcall_dev, ev);
373 up_read(&m->md_upcall.mu_upcall_sem);
378 struct lu_object mo_lu;
379 struct md_object_operations *mo_ops;
380 struct md_dir_operations *mo_dir_ops;
383 static inline int lu_device_is_md(const struct lu_device *d)
385 return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_MD);
388 static inline struct md_device *lu2md_dev(const struct lu_device *d)
390 LASSERT(lu_device_is_md(d));
391 return container_of0(d, struct md_device, md_lu_dev);
394 static inline struct lu_device *md2lu_dev(struct md_device *d)
396 return &d->md_lu_dev;
399 static inline struct md_object *lu2md(const struct lu_object *o)
401 LASSERT(lu_device_is_md(o->lo_dev));
402 return container_of0(o, struct md_object, mo_lu);
405 static inline struct md_object *md_object_next(const struct md_object *obj)
407 return (obj ? lu2md(lu_object_next(&obj->mo_lu)) : NULL);
410 static inline struct md_device *md_obj2dev(const struct md_object *o)
412 LASSERT(lu_device_is_md(o->mo_lu.lo_dev));
413 return container_of0(o->mo_lu.lo_dev, struct md_device, md_lu_dev);
416 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
418 return lu_device_init(&md->md_lu_dev, t);
421 static inline void md_device_fini(struct md_device *md)
423 lu_device_fini(&md->md_lu_dev);
427 static inline int mo_permission(const struct lu_env *env,
433 LASSERT(c->mo_ops->moo_permission);
434 return c->mo_ops->moo_permission(env, p, c, at, mask);
437 static inline int mo_attr_get(const struct lu_env *env,
441 LASSERT(m->mo_ops->moo_attr_get);
442 return m->mo_ops->moo_attr_get(env, m, at);
445 static inline int mo_readlink(const struct lu_env *env,
449 LASSERT(m->mo_ops->moo_readlink);
450 return m->mo_ops->moo_readlink(env, m, buf);
453 static inline int mo_attr_set(const struct lu_env *env,
455 const struct md_attr *at)
457 LASSERT(m->mo_ops->moo_attr_set);
458 return m->mo_ops->moo_attr_set(env, m, at);
461 static inline int mo_xattr_get(const struct lu_env *env,
466 LASSERT(m->mo_ops->moo_xattr_get);
467 return m->mo_ops->moo_xattr_get(env, m, buf, name);
470 static inline int mo_xattr_del(const struct lu_env *env,
474 LASSERT(m->mo_ops->moo_xattr_del);
475 return m->mo_ops->moo_xattr_del(env, m, name);
478 static inline int mo_xattr_set(const struct lu_env *env,
480 const struct lu_buf *buf,
484 LASSERT(m->mo_ops->moo_xattr_set);
485 return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
488 static inline int mo_xattr_list(const struct lu_env *env,
492 LASSERT(m->mo_ops->moo_xattr_list);
493 return m->mo_ops->moo_xattr_list(env, m, buf);
496 static inline int mo_open(const struct lu_env *env,
500 LASSERT(m->mo_ops->moo_open);
501 return m->mo_ops->moo_open(env, m, flags);
504 static inline int mo_close(const struct lu_env *env,
508 LASSERT(m->mo_ops->moo_close);
509 return m->mo_ops->moo_close(env, m, ma);
512 static inline int mo_readpage(const struct lu_env *env,
514 const struct lu_rdpg *rdpg)
516 LASSERT(m->mo_ops->moo_readpage);
517 return m->mo_ops->moo_readpage(env, m, rdpg);
520 static inline int mo_object_create(const struct lu_env *env,
522 const struct md_op_spec *spc,
525 LASSERT(m->mo_ops->moo_object_create);
526 return m->mo_ops->moo_object_create(env, m, spc, at);
529 static inline int mo_ref_add(const struct lu_env *env,
531 const struct md_attr *ma)
533 LASSERT(m->mo_ops->moo_ref_add);
534 return m->mo_ops->moo_ref_add(env, m, ma);
537 static inline int mo_ref_del(const struct lu_env *env,
541 LASSERT(m->mo_ops->moo_ref_del);
542 return m->mo_ops->moo_ref_del(env, m, ma);
545 static inline int mo_capa_get(const struct lu_env *env,
547 struct lustre_capa *c,
550 LASSERT(m->mo_ops->moo_capa_get);
551 return m->mo_ops->moo_capa_get(env, m, c, renewal);
554 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
556 LASSERT(m->mo_ops->moo_object_sync);
557 return m->mo_ops->moo_object_sync(env, m);
560 static inline int mdo_lookup(const struct lu_env *env,
562 const struct lu_name *lname,
564 struct md_op_spec *spec)
566 LASSERT(p->mo_dir_ops->mdo_lookup);
567 return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
570 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
571 struct md_object *mo,
574 if (mo->mo_dir_ops->mdo_lock_mode == NULL)
576 return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
579 static inline int mdo_create(const struct lu_env *env,
581 const struct lu_name *lchild_name,
583 struct md_op_spec *spc,
586 LASSERT(c->mo_dir_ops->mdo_create);
587 return c->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
590 static inline int mdo_create_data(const struct lu_env *env,
593 const struct md_op_spec *spec,
596 LASSERT(c->mo_dir_ops->mdo_create_data);
597 return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
600 static inline int mdo_rename(const struct lu_env *env,
601 struct md_object *sp,
602 struct md_object *tp,
603 const struct lu_fid *lf,
604 const struct lu_name *lsname,
606 const struct lu_name *ltname,
609 LASSERT(tp->mo_dir_ops->mdo_rename);
610 return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
614 static inline int mdo_is_subdir(const struct lu_env *env,
615 struct md_object *mo,
616 const struct lu_fid *fid,
619 LASSERT(mo->mo_dir_ops->mdo_is_subdir);
620 return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
623 static inline int mdo_link(const struct lu_env *env,
626 const struct lu_name *lname,
629 LASSERT(s->mo_dir_ops->mdo_link);
630 return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
633 static inline int mdo_unlink(const struct lu_env *env,
636 const struct lu_name *lname,
639 LASSERT(c->mo_dir_ops->mdo_unlink);
640 return c->mo_dir_ops->mdo_unlink(env, p, c, lname, ma);
643 static inline int mdo_name_insert(const struct lu_env *env,
645 const struct lu_name *lname,
646 const struct lu_fid *f,
647 const struct md_attr *ma)
649 LASSERT(p->mo_dir_ops->mdo_name_insert);
650 return p->mo_dir_ops->mdo_name_insert(env, p, lname, f, ma);
653 static inline int mdo_name_remove(const struct lu_env *env,
655 const struct lu_name *lname,
656 const struct md_attr *ma)
658 LASSERT(p->mo_dir_ops->mdo_name_remove);
659 return p->mo_dir_ops->mdo_name_remove(env, p, lname, ma);
662 static inline int mdo_rename_tgt(const struct lu_env *env,
665 const struct lu_fid *lf,
666 const struct lu_name *lname,
670 LASSERT(t->mo_dir_ops->mdo_rename_tgt);
671 return t->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
673 LASSERT(p->mo_dir_ops->mdo_rename_tgt);
674 return p->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
678 #endif /* _LINUX_MD_OBJECT_H */