Whamcloud - gitweb
LU-5710 all: second batch of corrected typos and grammar errors
[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, 2014, 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 md_som_data     *ma_som;
140         int                     ma_lmm_size;
141         int                     ma_lmv_size;
142         int                     ma_acl_size;
143 };
144
145 /** Additional parameters for create */
146 struct md_op_spec {
147         union {
148                 /** symlink target */
149                 const char               *sp_symname;
150                 /** eadata for regular files */
151                 struct md_spec_reg {
152                         const void *eadata;
153                         int  eadatalen;
154                 } sp_ea;
155         } u;
156
157         /** Create flag from client: such as MDS_OPEN_CREAT, and others. */
158         __u64      sp_cr_flags;
159
160         /** don't create lov objects or llog cookie - this replay */
161         unsigned int no_create:1,
162                      sp_cr_lookup:1, /* do lookup sanity check or not. */
163                      sp_rm_entry:1,  /* only remove name entry */
164                      sp_permitted:1; /* do not check permission */
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_object_sync)(const struct lu_env *, struct md_object *);
223
224         int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
225                                struct lustre_handle *lh,
226                                struct ldlm_enqueue_info *einfo,
227                                union ldlm_policy_data *policy);
228         int (*moo_object_unlock)(const struct lu_env *env,
229                                  struct md_object *obj,
230                                  struct ldlm_enqueue_info *einfo,
231                                  union ldlm_policy_data *policy);
232 };
233
234 /**
235  * Operations implemented for each directory object.
236  */
237 struct md_dir_operations {
238         int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
239                               const struct lu_fid *fid, struct lu_fid *sfid);
240
241         int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
242                           const struct lu_name *lname, struct lu_fid *fid,
243                           struct md_op_spec *spec);
244
245         mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
246                                     struct md_object *obj,
247                                     mdl_mode_t mode);
248
249         int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
250                           const struct lu_name *lname, struct md_object *child,
251                           struct md_op_spec *spec,
252                           struct md_attr *ma);
253
254         /** This method is used for creating data object for this meta object*/
255         int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
256                                struct md_object *o,
257                                const struct md_op_spec *spec,
258                                struct md_attr *ma);
259
260         int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
261                           struct md_object *tpobj, const struct lu_fid *lf,
262                           const struct lu_name *lsname, struct md_object *tobj,
263                           const struct lu_name *ltname, struct md_attr *ma);
264
265         int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
266                         struct md_object *src_obj, const struct lu_name *lname,
267                         struct md_attr *ma);
268
269         int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
270                           struct md_object *cobj, const struct lu_name *lname,
271                           struct md_attr *ma, int no_name);
272
273         int (*mdo_migrate)(const struct lu_env *env, struct md_object *pobj,
274                            struct md_object *sobj, const struct lu_name *lname,
275                            struct md_object *tobj, struct md_attr *ma);
276 };
277
278 struct md_device_operations {
279         /** meta-data device related handlers. */
280         int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
281                             struct lu_fid *f);
282
283         int (*mdo_maxeasize_get)(const struct lu_env *env, struct md_device *m,
284                                 int *easize);
285
286         int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
287                           struct obd_statfs *sfs);
288
289         int (*mdo_llog_ctxt_get)(const struct lu_env *env,
290                                  struct md_device *m, int idx, void **h);
291
292         int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
293                              unsigned int cmd, int len, void *data);
294 };
295
296 struct md_device {
297         struct lu_device                   md_lu_dev;
298         const struct md_device_operations *md_ops;
299 };
300
301 struct md_object {
302         struct lu_object                   mo_lu;
303         const struct md_object_operations *mo_ops;
304         const struct md_dir_operations    *mo_dir_ops;
305 };
306
307 /* Mark the object to be dead, and can not be accessed anymore.
308  * XXX, right now, it will only be used for striped directory to
309  * mark the slave stripes dead, when deleting master object. It will be
310  * stored in slave LMV EA (see lod_mark_dead_object), which is only
311  * temporary, and will be removed later when we have proper way to mark
312  * the dead object. */
313 #define LUSTRE_SLAVE_DEAD_FL            0x80000000
314
315 static inline struct md_device *lu2md_dev(const struct lu_device *d)
316 {
317         LASSERT(IS_ERR(d) || lu_device_is_md(d));
318         return container_of0(d, struct md_device, md_lu_dev);
319 }
320
321 static inline struct lu_device *md2lu_dev(struct md_device *d)
322 {
323         return &d->md_lu_dev;
324 }
325
326 static inline struct md_object *lu2md(const struct lu_object *o)
327 {
328         LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
329         return container_of0(o, struct md_object, mo_lu);
330 }
331
332 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
333 {
334         return lu_device_init(&md->md_lu_dev, t);
335 }
336
337 static inline void md_device_fini(struct md_device *md)
338 {
339         lu_device_fini(&md->md_lu_dev);
340 }
341
342 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
343                                                      struct md_device *md,
344                                                      const struct lu_fid *f)
345 {
346         return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
347 }
348
349
350 /** md operations */
351 static inline int mo_permission(const struct lu_env *env,
352                                 struct md_object *p,
353                                 struct md_object *c,
354                                 struct md_attr *at,
355                                 int mask)
356 {
357         LASSERT(c->mo_ops->moo_permission);
358         return c->mo_ops->moo_permission(env, p, c, at, mask);
359 }
360
361 static inline int mo_attr_get(const struct lu_env *env,
362                               struct md_object *m,
363                               struct md_attr *at)
364 {
365         LASSERT(m->mo_ops->moo_attr_get);
366         return m->mo_ops->moo_attr_get(env, m, at);
367 }
368
369 static inline int mo_readlink(const struct lu_env *env,
370                               struct md_object *m,
371                               struct lu_buf *buf)
372 {
373         LASSERT(m->mo_ops->moo_readlink);
374         return m->mo_ops->moo_readlink(env, m, buf);
375 }
376
377 static inline int mo_changelog(const struct lu_env *env,
378                                enum changelog_rec_type type,
379                                int flags, struct md_object *m)
380 {
381         LASSERT(m->mo_ops->moo_changelog);
382         return m->mo_ops->moo_changelog(env, type, flags, m);
383 }
384
385 static inline int mo_attr_set(const struct lu_env *env,
386                               struct md_object *m,
387                               const struct md_attr *at)
388 {
389         LASSERT(m->mo_ops->moo_attr_set);
390         return m->mo_ops->moo_attr_set(env, m, at);
391 }
392
393 static inline int mo_xattr_get(const struct lu_env *env,
394                                struct md_object *m,
395                                struct lu_buf *buf,
396                                const char *name)
397 {
398         LASSERT(m->mo_ops->moo_xattr_get);
399         return m->mo_ops->moo_xattr_get(env, m, buf, name);
400 }
401
402 static inline int mo_xattr_del(const struct lu_env *env,
403                                struct md_object *m,
404                                const char *name)
405 {
406         LASSERT(m->mo_ops->moo_xattr_del);
407         return m->mo_ops->moo_xattr_del(env, m, name);
408 }
409
410 static inline int mo_xattr_set(const struct lu_env *env,
411                                struct md_object *m,
412                                const struct lu_buf *buf,
413                                const char *name,
414                                int flags)
415 {
416         LASSERT(m->mo_ops->moo_xattr_set);
417         return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
418 }
419
420 static inline int mo_xattr_list(const struct lu_env *env,
421                                 struct md_object *m,
422                                 struct lu_buf *buf)
423 {
424         LASSERT(m->mo_ops->moo_xattr_list);
425         return m->mo_ops->moo_xattr_list(env, m, buf);
426 }
427
428 static inline int mo_swap_layouts(const struct lu_env *env,
429                                   struct md_object *o1,
430                                   struct md_object *o2, __u64 flags)
431 {
432         LASSERT(o1->mo_ops->moo_swap_layouts);
433         LASSERT(o2->mo_ops->moo_swap_layouts);
434         if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
435                 return -EPERM;
436         return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
437 }
438
439 static inline int mo_open(const struct lu_env *env,
440                           struct md_object *m,
441                           int flags)
442 {
443         LASSERT(m->mo_ops->moo_open);
444         return m->mo_ops->moo_open(env, m, flags);
445 }
446
447 static inline int mo_close(const struct lu_env *env,
448                            struct md_object *m,
449                            struct md_attr *ma,
450                            int mode)
451 {
452         LASSERT(m->mo_ops->moo_close);
453         return m->mo_ops->moo_close(env, m, ma, mode);
454 }
455
456 static inline int mo_readpage(const struct lu_env *env,
457                               struct md_object *m,
458                               const struct lu_rdpg *rdpg)
459 {
460         LASSERT(m->mo_ops->moo_readpage);
461         return m->mo_ops->moo_readpage(env, m, rdpg);
462 }
463
464 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
465 {
466         LASSERT(m->mo_ops->moo_object_sync);
467         return m->mo_ops->moo_object_sync(env, m);
468 }
469
470 static inline int mo_object_lock(const struct lu_env *env,
471                                  struct md_object *m,
472                                  struct lustre_handle *lh,
473                                  struct ldlm_enqueue_info *einfo,
474                                  union ldlm_policy_data *policy)
475 {
476         LASSERT(m->mo_ops->moo_object_lock);
477         return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
478 }
479
480 static inline int mo_object_unlock(const struct lu_env *env,
481                                    struct md_object *m,
482                                    struct ldlm_enqueue_info *einfo,
483                                    union ldlm_policy_data *policy)
484 {
485         LASSERT(m->mo_ops->moo_object_unlock);
486         return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
487 }
488
489 static inline int mdo_lookup(const struct lu_env *env,
490                              struct md_object *p,
491                              const struct lu_name *lname,
492                              struct lu_fid *f,
493                              struct md_op_spec *spec)
494 {
495         LASSERT(p->mo_dir_ops->mdo_lookup);
496         return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
497 }
498
499 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
500                                        struct md_object *mo,
501                                        mdl_mode_t lm)
502 {
503         if (mo->mo_dir_ops->mdo_lock_mode == NULL)
504                 return MDL_MINMODE;
505         return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
506 }
507
508 static inline int mdo_create(const struct lu_env *env,
509                              struct md_object *p,
510                              const struct lu_name *lchild_name,
511                              struct md_object *c,
512                              struct md_op_spec *spc,
513                              struct md_attr *at)
514 {
515         LASSERT(p->mo_dir_ops->mdo_create);
516         return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
517 }
518
519 static inline int mdo_create_data(const struct lu_env *env,
520                                   struct md_object *p,
521                                   struct md_object *c,
522                                   const struct md_op_spec *spec,
523                                   struct md_attr *ma)
524 {
525         LASSERT(c->mo_dir_ops->mdo_create_data);
526         return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
527 }
528
529 static inline int mdo_rename(const struct lu_env *env,
530                              struct md_object *sp,
531                              struct md_object *tp,
532                              const struct lu_fid *lf,
533                              const struct lu_name *lsname,
534                              struct md_object *t,
535                              const struct lu_name *ltname,
536                              struct md_attr *ma)
537 {
538         LASSERT(tp->mo_dir_ops->mdo_rename);
539         return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
540                                           ma);
541 }
542
543 static inline int mdo_migrate(const struct lu_env *env,
544                              struct md_object *pobj,
545                              struct md_object *sobj,
546                              const struct lu_name *lname,
547                              struct md_object *tobj,
548                              struct md_attr *ma)
549 {
550         LASSERT(pobj->mo_dir_ops->mdo_migrate);
551         return pobj->mo_dir_ops->mdo_migrate(env, pobj, sobj, lname, tobj, ma);
552 }
553
554 static inline int mdo_is_subdir(const struct lu_env *env,
555                                 struct md_object *mo,
556                                 const struct lu_fid *fid,
557                                 struct lu_fid *sfid)
558 {
559         LASSERT(mo->mo_dir_ops->mdo_is_subdir);
560         return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
561 }
562
563 static inline int mdo_link(const struct lu_env *env,
564                            struct md_object *p,
565                            struct md_object *s,
566                            const struct lu_name *lname,
567                            struct md_attr *ma)
568 {
569         LASSERT(s->mo_dir_ops->mdo_link);
570         return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
571 }
572
573 static inline int mdo_unlink(const struct lu_env *env,
574                              struct md_object *p,
575                              struct md_object *c,
576                              const struct lu_name *lname,
577                              struct md_attr *ma, int no_name)
578 {
579         LASSERT(p->mo_dir_ops->mdo_unlink);
580         return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
581 }
582
583 /**
584  * Used in MDD/OUT layer for object lock rule
585  **/
586 enum mdd_object_role {
587         MOR_SRC_PARENT,
588         MOR_SRC_CHILD,
589         MOR_TGT_PARENT,
590         MOR_TGT_CHILD,
591         MOR_TGT_ORPHAN
592 };
593
594 struct dt_device;
595
596 int lustre_buf2som(void *buf, int rc, struct md_som_data *msd);
597 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
598 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
599
600 enum {
601         UCRED_INVALID   = -1,
602         UCRED_INIT      = 0,
603         UCRED_OLD       = 1,
604         UCRED_NEW       = 2,
605 };
606
607 struct lu_ucred {
608         __u32                    uc_valid;
609         __u32                    uc_o_uid;
610         __u32                    uc_o_gid;
611         __u32                    uc_o_fsuid;
612         __u32                    uc_o_fsgid;
613         __u32                    uc_uid;
614         __u32                    uc_gid;
615         __u32                    uc_fsuid;
616         __u32                    uc_fsgid;
617         __u32                    uc_suppgids[2];
618         cfs_cap_t                uc_cap;
619         __u32                    uc_umask;
620         struct group_info       *uc_ginfo;
621         struct md_identity      *uc_identity;
622         char                     uc_jobid[LUSTRE_JOBID_SIZE];
623 };
624
625 struct lu_ucred *lu_ucred(const struct lu_env *env);
626
627 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
628
629 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
630
631 int lu_ucred_global_init(void);
632
633 void lu_ucred_global_fini(void);
634
635 #define md_cap_t(x) (x)
636
637 #define MD_CAP_TO_MASK(x) (1 << (x))
638
639 #define md_cap_raised(c, flag) (md_cap_t(c) & MD_CAP_TO_MASK(flag))
640
641 /* capable() is copied from linux kernel! */
642 static inline int md_capable(struct lu_ucred *uc, cfs_cap_t cap)
643 {
644         if (md_cap_raised(uc->uc_cap, cap))
645                 return 1;
646         return 0;
647 }
648
649 /** @} md */
650 #endif /* _LINUX_MD_OBJECT_H */