Whamcloud - gitweb
12c224ccacd1acbca2e3e859e0474d1efb7117be
[fs/lustre-release.git] / lustre / include / md_object.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/include/md_object.h
37  *
38  * Extention of lu_object.h for metadata objects
39  */
40
41 #ifndef _LUSTRE_MD_OBJECT_H
42 #define _LUSTRE_MD_OBJECT_H
43
44 #ifndef HAVE_SERVER_SUPPORT
45 # error "client code should not depend on md_object.h"
46 #endif /* !HAVE_SERVER_SUPPORT */
47
48 /** \defgroup md md
49  * Sub-class of lu_object with methods common for "meta-data" objects in MDT
50  * stack.
51  *
52  * Meta-data objects implement namespace operations: you can link, unlink
53  * them, and treat them as directories.
54  *
55  * Examples: mdt, cmm, and mdt are implementations of md interface.
56  * @{
57  */
58
59
60 /*
61  * super-class definitions.
62  */
63 #include <dt_object.h>
64
65 struct md_device;
66 struct md_device_operations;
67 struct md_object;
68 struct obd_export;
69
70 /** metadata attributes */
71 enum ma_valid {
72         MA_INODE     = (1 << 0),
73         MA_LOV       = (1 << 1),
74         MA_COOKIE    = (1 << 2),
75         MA_FLAGS     = (1 << 3),
76         MA_LMV       = (1 << 4),
77         MA_ACL_DEF   = (1 << 5),
78         MA_LOV_DEF   = (1 << 6),
79         MA_HSM       = (1 << 7),
80         MA_SOM       = (1 << 8),
81         MA_PFID      = (1 << 9),
82         MA_LMV_DEF   = (1 << 10)
83 };
84
85 typedef enum {
86         MDL_MINMODE  = 0,
87         MDL_EX       = 1,
88         MDL_PW       = 2,
89         MDL_PR       = 4,
90         MDL_CW       = 8,
91         MDL_CR       = 16,
92         MDL_NL       = 32,
93         MDL_GROUP    = 64,
94         MDL_MAXMODE
95 } mdl_mode_t;
96
97 typedef enum {
98         MDT_NUL_LOCK = 0,
99         MDT_REG_LOCK = (1 << 0),
100         MDT_PDO_LOCK = (1 << 1)
101 } mdl_type_t;
102
103 /* memory structure for hsm attributes
104  * for fields description see the on disk structure hsm_attrs
105  * which is defined in lustre_idl.h
106  */
107 struct md_hsm {
108         __u32   mh_compat;
109         __u32   mh_flags;
110         __u64   mh_arch_id;
111         __u64   mh_arch_ver;
112 };
113
114 #define IOEPOCH_INVAL 0
115
116 /* memory structure for som attributes
117  * for fields description see the on disk structure som_attrs
118  * which is defined in lustre_idl.h
119  */
120 struct md_som_data {
121         __u32   msd_compat;
122         __u32   msd_incompat;
123         __u64   msd_ioepoch;
124         __u64   msd_size;
125         __u64   msd_blocks;
126         __u64   msd_mountid;
127 };
128
129 struct md_attr {
130         __u64                   ma_valid;
131         __u64                   ma_need;
132         __u64                   ma_attr_flags;
133         struct lu_attr          ma_attr;
134         struct lu_fid           ma_pfid;
135         struct md_hsm           ma_hsm;
136         struct lov_mds_md      *ma_lmm;
137         union lmv_mds_md       *ma_lmv;
138         void                   *ma_acl;
139         struct lustre_capa     *ma_capa;
140         struct md_som_data     *ma_som;
141         int                     ma_lmm_size;
142         int                     ma_lmv_size;
143         int                     ma_acl_size;
144 };
145
146 /** Additional parameters for create */
147 struct md_op_spec {
148         union {
149                 /** symlink target */
150                 const char               *sp_symname;
151                 /** eadata for regular files */
152                 struct md_spec_reg {
153                         const void *eadata;
154                         int  eadatalen;
155                 } sp_ea;
156         } u;
157
158         /** Create flag from client: such as MDS_OPEN_CREAT, and others. */
159         __u64      sp_cr_flags;
160
161         /** don't create lov objects or llog cookie - this replay */
162         unsigned int no_create:1,
163                      sp_cr_lookup:1, /* do lookup sanity check or not. */
164                      sp_rm_entry:1;  /* only remove name entry */
165
166         /** Current lock mode for parent dir where create is performing. */
167         mdl_mode_t sp_cr_mode;
168
169         /** to create directory */
170         const struct dt_index_features *sp_feat;
171 };
172
173 union ldlm_policy_data;
174 /**
175  * Operations implemented for each md object (both directory and leaf).
176  */
177 struct md_object_operations {
178         int (*moo_permission)(const struct lu_env *env,
179                               struct md_object *pobj, struct md_object *cobj,
180                               struct md_attr *attr, int mask);
181
182         int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
183                             struct md_attr *attr);
184
185         int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
186                             const struct md_attr *attr);
187
188         int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
189                              struct lu_buf *buf, const char *name);
190
191         int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
192                               struct lu_buf *buf);
193
194         int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
195                              const struct lu_buf *buf, const char *name,
196                              int fl);
197
198         int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
199                              const char *name);
200
201         /** This method is used to swap the layouts between 2 objects */
202         int (*moo_swap_layouts)(const struct lu_env *env,
203                                struct md_object *obj1, struct md_object *obj2,
204                                __u64 flags);
205
206         /** \retval number of bytes actually read upon success */
207         int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
208                             const struct lu_rdpg *rdpg);
209
210         int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
211                             struct lu_buf *buf);
212         int (*moo_changelog)(const struct lu_env *env,
213                              enum changelog_rec_type type, int flags,
214                              struct md_object *obj);
215
216         int (*moo_open)(const struct lu_env *env,
217                         struct md_object *obj, int flag);
218
219         int (*moo_close)(const struct lu_env *env, struct md_object *obj,
220                          struct md_attr *ma, int mode);
221
222         int (*moo_capa_get)(const struct lu_env *, struct md_object *,
223                             struct lustre_capa *, int renewal);
224
225         int (*moo_object_sync)(const struct lu_env *, struct md_object *);
226
227         int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
228                                struct lustre_handle *lh,
229                                struct ldlm_enqueue_info *einfo,
230                                union ldlm_policy_data *policy);
231         int (*moo_object_unlock)(const struct lu_env *env,
232                                  struct md_object *obj,
233                                  struct ldlm_enqueue_info *einfo,
234                                  union ldlm_policy_data *policy);
235 };
236
237 /**
238  * Operations implemented for each directory object.
239  */
240 struct md_dir_operations {
241         int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
242                               const struct lu_fid *fid, struct lu_fid *sfid);
243
244         int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
245                           const struct lu_name *lname, struct lu_fid *fid,
246                           struct md_op_spec *spec);
247
248         mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
249                                     struct md_object *obj,
250                                     mdl_mode_t mode);
251
252         int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
253                           const struct lu_name *lname, struct md_object *child,
254                           struct md_op_spec *spec,
255                           struct md_attr *ma);
256
257         /** This method is used for creating data object for this meta object*/
258         int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
259                                struct md_object *o,
260                                const struct md_op_spec *spec,
261                                struct md_attr *ma);
262
263         int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
264                           struct md_object *tpobj, const struct lu_fid *lf,
265                           const struct lu_name *lsname, struct md_object *tobj,
266                           const struct lu_name *ltname, struct md_attr *ma);
267
268         int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
269                         struct md_object *src_obj, const struct lu_name *lname,
270                         struct md_attr *ma);
271
272         int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
273                           struct md_object *cobj, const struct lu_name *lname,
274                           struct md_attr *ma, int no_name);
275
276         int (*mdo_migrate)(const struct lu_env *env, struct md_object *pobj,
277                            struct md_object *sobj, const struct lu_name *lname,
278                            struct md_object *tobj, struct md_attr *ma);
279 };
280
281 struct md_device_operations {
282         /** meta-data device related handlers. */
283         int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
284                             struct lu_fid *f);
285
286         int (*mdo_maxeasize_get)(const struct lu_env *env, struct md_device *m,
287                                 int *easize);
288
289         int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
290                           struct obd_statfs *sfs);
291
292         int (*mdo_init_capa_ctxt)(const struct lu_env *env, struct md_device *m,
293                                   int mode, unsigned long timeout, __u32 alg,
294                                   struct lustre_capa_key *keys);
295
296         int (*mdo_update_capa_key)(const struct lu_env *env,
297                                    struct md_device *m,
298                                    struct lustre_capa_key *key);
299
300         int (*mdo_llog_ctxt_get)(const struct lu_env *env,
301                                  struct md_device *m, int idx, void **h);
302
303         int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
304                              unsigned int cmd, int len, void *data);
305 };
306
307 struct md_device {
308         struct lu_device                   md_lu_dev;
309         const struct md_device_operations *md_ops;
310 };
311
312 struct md_object {
313         struct lu_object                   mo_lu;
314         const struct md_object_operations *mo_ops;
315         const struct md_dir_operations    *mo_dir_ops;
316 };
317
318 /* Mark the object to be dead, and can not be accessed anymore.
319  * XXX, right now, it will only be used for striped directory to
320  * mark the slave stripes dead, when deleting master object. It will be
321  * stored in slave LMV EA (see lod_mark_dead_object), which is only
322  * temporary, and will be removed later when we have proper way to mark
323  * the dead object. */
324 #define LUSTRE_SLAVE_DEAD_FL            0x80000000
325
326 static inline struct md_device *lu2md_dev(const struct lu_device *d)
327 {
328         LASSERT(IS_ERR(d) || lu_device_is_md(d));
329         return container_of0(d, struct md_device, md_lu_dev);
330 }
331
332 static inline struct lu_device *md2lu_dev(struct md_device *d)
333 {
334         return &d->md_lu_dev;
335 }
336
337 static inline struct md_object *lu2md(const struct lu_object *o)
338 {
339         LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
340         return container_of0(o, struct md_object, mo_lu);
341 }
342
343 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
344 {
345         return lu_device_init(&md->md_lu_dev, t);
346 }
347
348 static inline void md_device_fini(struct md_device *md)
349 {
350         lu_device_fini(&md->md_lu_dev);
351 }
352
353 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
354                                                      struct md_device *md,
355                                                      const struct lu_fid *f)
356 {
357         return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
358 }
359
360
361 /** md operations */
362 static inline int mo_permission(const struct lu_env *env,
363                                 struct md_object *p,
364                                 struct md_object *c,
365                                 struct md_attr *at,
366                                 int mask)
367 {
368         LASSERT(c->mo_ops->moo_permission);
369         return c->mo_ops->moo_permission(env, p, c, at, mask);
370 }
371
372 static inline int mo_attr_get(const struct lu_env *env,
373                               struct md_object *m,
374                               struct md_attr *at)
375 {
376         LASSERT(m->mo_ops->moo_attr_get);
377         return m->mo_ops->moo_attr_get(env, m, at);
378 }
379
380 static inline int mo_readlink(const struct lu_env *env,
381                               struct md_object *m,
382                               struct lu_buf *buf)
383 {
384         LASSERT(m->mo_ops->moo_readlink);
385         return m->mo_ops->moo_readlink(env, m, buf);
386 }
387
388 static inline int mo_changelog(const struct lu_env *env,
389                                enum changelog_rec_type type,
390                                int flags, struct md_object *m)
391 {
392         LASSERT(m->mo_ops->moo_changelog);
393         return m->mo_ops->moo_changelog(env, type, flags, m);
394 }
395
396 static inline int mo_attr_set(const struct lu_env *env,
397                               struct md_object *m,
398                               const struct md_attr *at)
399 {
400         LASSERT(m->mo_ops->moo_attr_set);
401         return m->mo_ops->moo_attr_set(env, m, at);
402 }
403
404 static inline int mo_xattr_get(const struct lu_env *env,
405                                struct md_object *m,
406                                struct lu_buf *buf,
407                                const char *name)
408 {
409         LASSERT(m->mo_ops->moo_xattr_get);
410         return m->mo_ops->moo_xattr_get(env, m, buf, name);
411 }
412
413 static inline int mo_xattr_del(const struct lu_env *env,
414                                struct md_object *m,
415                                const char *name)
416 {
417         LASSERT(m->mo_ops->moo_xattr_del);
418         return m->mo_ops->moo_xattr_del(env, m, name);
419 }
420
421 static inline int mo_xattr_set(const struct lu_env *env,
422                                struct md_object *m,
423                                const struct lu_buf *buf,
424                                const char *name,
425                                int flags)
426 {
427         LASSERT(m->mo_ops->moo_xattr_set);
428         return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
429 }
430
431 static inline int mo_xattr_list(const struct lu_env *env,
432                                 struct md_object *m,
433                                 struct lu_buf *buf)
434 {
435         LASSERT(m->mo_ops->moo_xattr_list);
436         return m->mo_ops->moo_xattr_list(env, m, buf);
437 }
438
439 static inline int mo_swap_layouts(const struct lu_env *env,
440                                   struct md_object *o1,
441                                   struct md_object *o2, __u64 flags)
442 {
443         LASSERT(o1->mo_ops->moo_swap_layouts);
444         LASSERT(o2->mo_ops->moo_swap_layouts);
445         if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
446                 return -EPERM;
447         return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
448 }
449
450 static inline int mo_open(const struct lu_env *env,
451                           struct md_object *m,
452                           int flags)
453 {
454         LASSERT(m->mo_ops->moo_open);
455         return m->mo_ops->moo_open(env, m, flags);
456 }
457
458 static inline int mo_close(const struct lu_env *env,
459                            struct md_object *m,
460                            struct md_attr *ma,
461                            int mode)
462 {
463         LASSERT(m->mo_ops->moo_close);
464         return m->mo_ops->moo_close(env, m, ma, mode);
465 }
466
467 static inline int mo_readpage(const struct lu_env *env,
468                               struct md_object *m,
469                               const struct lu_rdpg *rdpg)
470 {
471         LASSERT(m->mo_ops->moo_readpage);
472         return m->mo_ops->moo_readpage(env, m, rdpg);
473 }
474
475 static inline int mo_capa_get(const struct lu_env *env,
476                               struct md_object *m,
477                               struct lustre_capa *c,
478                               int renewal)
479 {
480         LASSERT(m->mo_ops->moo_capa_get);
481         return m->mo_ops->moo_capa_get(env, m, c, renewal);
482 }
483
484 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
485 {
486         LASSERT(m->mo_ops->moo_object_sync);
487         return m->mo_ops->moo_object_sync(env, m);
488 }
489
490 static inline int mo_object_lock(const struct lu_env *env,
491                                  struct md_object *m,
492                                  struct lustre_handle *lh,
493                                  struct ldlm_enqueue_info *einfo,
494                                  union ldlm_policy_data *policy)
495 {
496         LASSERT(m->mo_ops->moo_object_lock);
497         return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
498 }
499
500 static inline int mo_object_unlock(const struct lu_env *env,
501                                    struct md_object *m,
502                                    struct ldlm_enqueue_info *einfo,
503                                    union ldlm_policy_data *policy)
504 {
505         LASSERT(m->mo_ops->moo_object_unlock);
506         return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
507 }
508
509 static inline int mdo_lookup(const struct lu_env *env,
510                              struct md_object *p,
511                              const struct lu_name *lname,
512                              struct lu_fid *f,
513                              struct md_op_spec *spec)
514 {
515         LASSERT(p->mo_dir_ops->mdo_lookup);
516         return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
517 }
518
519 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
520                                        struct md_object *mo,
521                                        mdl_mode_t lm)
522 {
523         if (mo->mo_dir_ops->mdo_lock_mode == NULL)
524                 return MDL_MINMODE;
525         return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
526 }
527
528 static inline int mdo_create(const struct lu_env *env,
529                              struct md_object *p,
530                              const struct lu_name *lchild_name,
531                              struct md_object *c,
532                              struct md_op_spec *spc,
533                              struct md_attr *at)
534 {
535         LASSERT(p->mo_dir_ops->mdo_create);
536         return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
537 }
538
539 static inline int mdo_create_data(const struct lu_env *env,
540                                   struct md_object *p,
541                                   struct md_object *c,
542                                   const struct md_op_spec *spec,
543                                   struct md_attr *ma)
544 {
545         LASSERT(c->mo_dir_ops->mdo_create_data);
546         return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
547 }
548
549 static inline int mdo_rename(const struct lu_env *env,
550                              struct md_object *sp,
551                              struct md_object *tp,
552                              const struct lu_fid *lf,
553                              const struct lu_name *lsname,
554                              struct md_object *t,
555                              const struct lu_name *ltname,
556                              struct md_attr *ma)
557 {
558         LASSERT(tp->mo_dir_ops->mdo_rename);
559         return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
560                                           ma);
561 }
562
563 static inline int mdo_migrate(const struct lu_env *env,
564                              struct md_object *pobj,
565                              struct md_object *sobj,
566                              const struct lu_name *lname,
567                              struct md_object *tobj,
568                              struct md_attr *ma)
569 {
570         LASSERT(pobj->mo_dir_ops->mdo_migrate);
571         return pobj->mo_dir_ops->mdo_migrate(env, pobj, sobj, lname, tobj, ma);
572 }
573
574 static inline int mdo_is_subdir(const struct lu_env *env,
575                                 struct md_object *mo,
576                                 const struct lu_fid *fid,
577                                 struct lu_fid *sfid)
578 {
579         LASSERT(mo->mo_dir_ops->mdo_is_subdir);
580         return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
581 }
582
583 static inline int mdo_link(const struct lu_env *env,
584                            struct md_object *p,
585                            struct md_object *s,
586                            const struct lu_name *lname,
587                            struct md_attr *ma)
588 {
589         LASSERT(s->mo_dir_ops->mdo_link);
590         return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
591 }
592
593 static inline int mdo_unlink(const struct lu_env *env,
594                              struct md_object *p,
595                              struct md_object *c,
596                              const struct lu_name *lname,
597                              struct md_attr *ma, int no_name)
598 {
599         LASSERT(p->mo_dir_ops->mdo_unlink);
600         return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
601 }
602
603 /**
604  * Used in MDD/OUT layer for object lock rule
605  **/
606 enum mdd_object_role {
607         MOR_SRC_PARENT,
608         MOR_SRC_CHILD,
609         MOR_TGT_PARENT,
610         MOR_TGT_CHILD,
611         MOR_TGT_ORPHAN
612 };
613
614 struct dt_device;
615
616 int lustre_buf2som(void *buf, int rc, struct md_som_data *msd);
617 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
618 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
619
620 enum {
621         UCRED_INVALID   = -1,
622         UCRED_INIT      = 0,
623         UCRED_OLD       = 1,
624         UCRED_NEW       = 2,
625 };
626
627 struct lu_ucred {
628         __u32                    uc_valid;
629         __u32                    uc_o_uid;
630         __u32                    uc_o_gid;
631         __u32                    uc_o_fsuid;
632         __u32                    uc_o_fsgid;
633         __u32                    uc_uid;
634         __u32                    uc_gid;
635         __u32                    uc_fsuid;
636         __u32                    uc_fsgid;
637         __u32                    uc_suppgids[2];
638         cfs_cap_t                uc_cap;
639         __u32                    uc_umask;
640         struct group_info       *uc_ginfo;
641         struct md_identity      *uc_identity;
642         char                     uc_jobid[LUSTRE_JOBID_SIZE];
643 };
644
645 struct lu_ucred *lu_ucred(const struct lu_env *env);
646
647 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
648
649 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
650
651 int lu_ucred_global_init(void);
652
653 void lu_ucred_global_fini(void);
654
655 #define md_cap_t(x) (x)
656
657 #define MD_CAP_TO_MASK(x) (1 << (x))
658
659 #define md_cap_raised(c, flag) (md_cap_t(c) & MD_CAP_TO_MASK(flag))
660
661 /* capable() is copied from linux kernel! */
662 static inline int md_capable(struct lu_ucred *uc, cfs_cap_t cap)
663 {
664         if (md_cap_raised(uc->uc_cap, cap))
665                 return 1;
666         return 0;
667 }
668
669 /** @} md */
670 #endif /* _LINUX_MD_OBJECT_H */