Whamcloud - gitweb
LU-13004 ptlrpc: Allow BULK_BUF_KIOV to accept a kvec
[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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/include/md_object.h
33  *
34  * Extention of lu_object.h for metadata objects
35  */
36
37 #ifndef _LUSTRE_MD_OBJECT_H
38 #define _LUSTRE_MD_OBJECT_H
39
40 #ifndef HAVE_SERVER_SUPPORT
41 # error "client code should not depend on md_object.h"
42 #endif /* !HAVE_SERVER_SUPPORT */
43
44 /** \defgroup md md
45  * Sub-class of lu_object with methods common for "meta-data" objects in MDT
46  * stack.
47  *
48  * Meta-data objects implement namespace operations: you can link, unlink
49  * them, and treat them as directories.
50  *
51  * Examples: mdt, cmm, and mdt are implementations of md interface.
52  * @{
53  */
54
55
56 /*
57  * super-class definitions.
58  */
59 #include <dt_object.h>
60
61 struct md_device;
62 struct md_device_operations;
63 struct md_object;
64 struct obd_export;
65
66 /** metadata attributes */
67 enum ma_valid {
68         MA_INODE     = 1 << 0,
69         MA_LOV       = 1 << 1,
70         MA_FLAGS     = 1 << 2,
71         MA_LMV       = 1 << 3,
72         MA_ACL_DEF   = 1 << 4,
73         MA_LOV_DEF   = 1 << 5,
74         MA_HSM       = 1 << 6,
75         MA_PFID      = 1 << 7,
76         MA_LMV_DEF   = 1 << 8,
77         MA_SOM       = 1 << 9,
78         MA_FORCE_LOG    = 1 << 10, /* forced close logged in mdt_mfd_close */
79 };
80
81 typedef enum {
82         MDL_MINMODE  = 0,
83         MDL_EX       = 1,
84         MDL_PW       = 2,
85         MDL_PR       = 4,
86         MDL_CW       = 8,
87         MDL_CR       = 16,
88         MDL_NL       = 32,
89         MDL_GROUP    = 64,
90         MDL_MAXMODE
91 } mdl_mode_t;
92
93 typedef enum {
94         MDT_NUL_LOCK = 0,
95         MDT_REG_LOCK = (1 << 0),
96         MDT_PDO_LOCK = (1 << 1)
97 } mdl_type_t;
98
99 /* lfs rgetfacl permission check */
100 #define MAY_RGETFACL    (1 << 14)
101
102 /* memory structure for hsm attributes
103  * for fields description see the on disk structure hsm_attrs
104  * which is defined in lustre_idl.h
105  */
106 struct md_hsm {
107         __u32   mh_compat;
108         __u32   mh_flags;
109         __u64   mh_arch_id;
110         __u64   mh_arch_ver;
111 };
112
113
114 /* memory structure for SOM attributes
115  * for fields description see the on disk structure som_attrs
116  * which is defined in lustre_idl.h
117  */
118 struct md_som {
119         __u16   ms_valid;
120         __u64   ms_size;
121         __u64   ms_blocks;
122 };
123
124 struct md_attr {
125         __u64                    ma_valid;
126         __u64                    ma_need;
127         __u64                    ma_attr_flags;
128         struct lu_attr           ma_attr;
129         struct lu_fid            ma_pfid;
130         struct md_hsm            ma_hsm;
131         struct md_som            ma_som;
132         struct lov_mds_md       *ma_lmm;
133         union lmv_mds_md        *ma_lmv;
134         struct lmv_user_md      *ma_default_lmv;
135         void                    *ma_acl;
136         int                      ma_lmm_size;
137         int                      ma_lmv_size;
138         int                      ma_default_lmv_size;
139         int                      ma_acl_size;
140         int                      ma_enable_chprojid_gid;
141 };
142
143 /** Additional parameters for create */
144 struct md_op_spec {
145         union {
146                 /** symlink target */
147                 const char *sp_symname;
148                 /** eadata for regular files */
149                 struct md_spec_reg {
150                         void *eadata;
151                         int  eadatalen;
152                 } sp_ea;
153         } u;
154
155         /** Open flags from client: such as MDS_OPEN_CREAT, and others. */
156         __u64      sp_cr_flags;
157
158         /* File security context for creates. */
159         const char      *sp_cr_file_secctx_name; /* (security) xattr name */
160         void            *sp_cr_file_secctx; /* xattr value */
161         size_t           sp_cr_file_secctx_size; /* xattr value size */
162
163         /* Archive ID used for auto PCC attach when create newly files. */
164         __u32            sp_archive_id;
165
166         /** don't create lov objects or llog cookie - this replay */
167         unsigned int no_create:1,
168                      sp_cr_lookup:1, /* do lookup sanity check or not. */
169                      sp_rm_entry:1,  /* only remove name entry */
170                      sp_permitted:1, /* do not check permission */
171                      sp_migrate_close:1; /* close the file during migrate */
172         /** Current lock mode for parent dir where create is performing. */
173         mdl_mode_t sp_cr_mode;
174
175         /** to create directory */
176         const struct dt_index_features *sp_feat;
177 };
178
179 enum md_layout_opc {
180         MD_LAYOUT_NOP   = 0,
181         MD_LAYOUT_WRITE,        /* FLR: write the file */
182         MD_LAYOUT_RESYNC,       /* FLR: resync starts */
183         MD_LAYOUT_RESYNC_DONE,  /* FLR: resync done */
184 };
185
186 /**
187  * Parameters for layout change API.
188  */
189 struct md_layout_change {
190         enum md_layout_opc       mlc_opc;
191         __u16                    mlc_mirror_id;
192         struct layout_intent    *mlc_intent;
193         struct lu_buf            mlc_buf;
194         struct lustre_som_attrs  mlc_som;
195         size_t                   mlc_resync_count;
196         __u32                   *mlc_resync_ids;
197 };
198
199 union ldlm_policy_data;
200 /**
201  * Operations implemented for each md object (both directory and leaf).
202  */
203 struct md_object_operations {
204         int (*moo_permission)(const struct lu_env *env,
205                               struct md_object *pobj, struct md_object *cobj,
206                               struct md_attr *attr, int mask);
207
208         int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
209                             struct md_attr *attr);
210
211         int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
212                             const struct md_attr *attr);
213
214         int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
215                              struct lu_buf *buf, const char *name);
216
217         int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
218                               struct lu_buf *buf);
219
220         int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
221                              const struct lu_buf *buf, const char *name,
222                              int fl);
223
224         int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
225                              const char *name);
226
227         /** This method is used to swap the layouts between 2 objects */
228         int (*moo_swap_layouts)(const struct lu_env *env,
229                                struct md_object *obj1, struct md_object *obj2,
230                                __u64 flags);
231
232         /** \retval number of bytes actually read upon success */
233         int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
234                             const struct lu_rdpg *rdpg);
235
236         int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
237                             struct lu_buf *buf);
238
239         int (*moo_changelog)(const struct lu_env *env,
240                              enum changelog_rec_type type,
241                              enum changelog_rec_flags clf_flags,
242                              struct md_device *m, const struct lu_fid *fid);
243
244         int (*moo_open)(const struct lu_env *env, struct md_object *obj,
245                         u64 open_flags, struct md_op_spec*);
246
247         int (*moo_close)(const struct lu_env *env, struct md_object *obj,
248                          struct md_attr *ma, u64 open_flags);
249
250         int (*moo_object_sync)(const struct lu_env *, struct md_object *);
251
252         int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
253                                struct lustre_handle *lh,
254                                struct ldlm_enqueue_info *einfo,
255                                union ldlm_policy_data *policy);
256         int (*moo_object_unlock)(const struct lu_env *env,
257                                  struct md_object *obj,
258                                  struct ldlm_enqueue_info *einfo,
259                                  union ldlm_policy_data *policy);
260
261         int (*moo_invalidate)(const struct lu_env *env, struct md_object *obj);
262         /**
263          * Trying to write to un-instantiated layout component.
264          *
265          * The caller should have held layout lock.
266          *
267          * This API can be extended to support every other layout changing
268          * operations, such as component {add,del,change}, layout swap,
269          * layout merge, etc. One of the benefits by doing this is that the MDT
270          * no longer needs to understand layout.
271          *
272          * However, layout creation, removal, and fetch should still use
273          * xattr_{get,set}() because they don't interpret layout on the
274          * MDT layer.
275          *
276          * \param[in] env       execution environment
277          * \param[in] obj       MD object
278          * \param[in] layout    data structure to describe the changes to
279          *                      the MD object's layout
280          *
281          * \retval 0            success
282          * \retval -ne          error code
283          */
284         int (*moo_layout_change)(const struct lu_env *env,
285                                  struct md_object *obj,
286                                  struct md_layout_change *layout);
287 };
288
289 /**
290  * Operations implemented for each directory object.
291  */
292 struct md_dir_operations {
293         int (*mdo_is_subdir)(const struct lu_env *env, struct md_object *obj,
294                              const struct lu_fid *fid);
295
296         int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
297                           const struct lu_name *lname, struct lu_fid *fid,
298                           struct md_op_spec *spec);
299
300         mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
301                                     struct md_object *obj,
302                                     mdl_mode_t mode);
303
304         int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
305                           const struct lu_name *lname, struct md_object *child,
306                           struct md_op_spec *spec,
307                           struct md_attr *ma);
308
309         /** This method is used for creating data object for this meta object*/
310         int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
311                                struct md_object *o,
312                                const struct md_op_spec *spec,
313                                struct md_attr *ma);
314
315         int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
316                           struct md_object *tpobj, const struct lu_fid *lf,
317                           const struct lu_name *lsname, struct md_object *tobj,
318                           const struct lu_name *ltname, struct md_attr *ma);
319
320         int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
321                         struct md_object *src_obj, const struct lu_name *lname,
322                         struct md_attr *ma);
323
324         int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
325                           struct md_object *cobj, const struct lu_name *lname,
326                           struct md_attr *ma, int no_name);
327
328         int (*mdo_migrate)(const struct lu_env *env, struct md_object *pobj,
329                            struct md_object *sobj, const struct lu_name *lname,
330                            struct md_object *tobj, struct md_op_spec *spec,
331                            struct md_attr *ma);
332 };
333
334 struct md_device_operations {
335         /** meta-data device related handlers. */
336         int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
337                             struct lu_fid *f);
338
339         const struct dt_device_param *(*mdo_dtconf_get)(const struct lu_env *e,
340                                                         struct md_device *m);
341
342         int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
343                           struct obd_statfs *sfs);
344
345         int (*mdo_llog_ctxt_get)(const struct lu_env *env,
346                                  struct md_device *m, int idx, void **h);
347
348         int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
349                              unsigned int cmd, int len, void *data);
350 };
351
352 struct md_device {
353         struct lu_device                   md_lu_dev;
354         const struct md_device_operations *md_ops;
355 };
356
357 struct md_object {
358         struct lu_object                   mo_lu;
359         const struct md_object_operations *mo_ops;
360         const struct md_dir_operations    *mo_dir_ops;
361 };
362
363 static inline struct md_device *lu2md_dev(const struct lu_device *d)
364 {
365         LASSERT(IS_ERR(d) || lu_device_is_md(d));
366         return container_of0(d, struct md_device, md_lu_dev);
367 }
368
369 static inline struct lu_device *md2lu_dev(struct md_device *d)
370 {
371         return &d->md_lu_dev;
372 }
373
374 static inline struct md_object *lu2md(const struct lu_object *o)
375 {
376         LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
377         return container_of0(o, struct md_object, mo_lu);
378 }
379
380 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
381 {
382         return lu_device_init(&md->md_lu_dev, t);
383 }
384
385 static inline void md_device_fini(struct md_device *md)
386 {
387         lu_device_fini(&md->md_lu_dev);
388 }
389
390 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
391                                                      struct md_device *md,
392                                                      const struct lu_fid *f)
393 {
394         return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
395 }
396
397
398 /** md operations */
399 static inline int mo_permission(const struct lu_env *env, struct md_object *p,
400                                 struct md_object *c, struct md_attr *at,
401                                 int mask)
402 {
403         LASSERT(c->mo_ops->moo_permission);
404         return c->mo_ops->moo_permission(env, p, c, at, mask);
405 }
406
407 static inline int mo_attr_get(const struct lu_env *env, struct md_object *m,
408                               struct md_attr *at)
409 {
410         LASSERT(m->mo_ops->moo_attr_get);
411         return m->mo_ops->moo_attr_get(env, m, at);
412 }
413
414 static inline int mo_readlink(const struct lu_env *env,
415                               struct md_object *m,
416                               struct lu_buf *buf)
417 {
418         LASSERT(m->mo_ops->moo_readlink);
419         return m->mo_ops->moo_readlink(env, m, buf);
420 }
421
422 static inline int mo_changelog(const struct lu_env *env,
423                                enum changelog_rec_type type,
424                                enum changelog_rec_flags clf_flags,
425                                struct md_device *m, const struct lu_fid *fid)
426 {
427         struct lu_fid rootfid;
428         struct md_object *root;
429         int rc;
430
431         rc = m->md_ops->mdo_root_get(env, m, &rootfid);
432         if (rc)
433                 return rc;
434
435         root = md_object_find_slice(env, m, &rootfid);
436         if (IS_ERR(root))
437                 RETURN(PTR_ERR(root));
438
439         LASSERT(root->mo_ops->moo_changelog);
440         rc = root->mo_ops->moo_changelog(env, type, clf_flags, m, fid);
441
442         lu_object_put(env, &root->mo_lu);
443
444         return rc;
445 }
446
447 static inline int mo_attr_set(const struct lu_env *env,
448                               struct md_object *m,
449                               const struct md_attr *at)
450 {
451         LASSERT(m->mo_ops->moo_attr_set);
452         return m->mo_ops->moo_attr_set(env, m, at);
453 }
454
455 static inline int mo_xattr_get(const struct lu_env *env,
456                                struct md_object *m,
457                                struct lu_buf *buf,
458                                const char *name)
459 {
460         LASSERT(m->mo_ops->moo_xattr_get);
461         return m->mo_ops->moo_xattr_get(env, m, buf, name);
462 }
463
464 static inline int mo_xattr_del(const struct lu_env *env,
465                                struct md_object *m,
466                                const char *name)
467 {
468         LASSERT(m->mo_ops->moo_xattr_del);
469         return m->mo_ops->moo_xattr_del(env, m, name);
470 }
471
472 static inline int mo_xattr_set(const struct lu_env *env,
473                                struct md_object *m,
474                                const struct lu_buf *buf,
475                                const char *name,
476                                int flags)
477 {
478         LASSERT(m->mo_ops->moo_xattr_set);
479         return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
480 }
481
482 static inline int mo_xattr_list(const struct lu_env *env,
483                                 struct md_object *m,
484                                 struct lu_buf *buf)
485 {
486         LASSERT(m->mo_ops->moo_xattr_list);
487         return m->mo_ops->moo_xattr_list(env, m, buf);
488 }
489
490 static inline int mo_invalidate(const struct lu_env *env, struct md_object *m)
491 {
492         LASSERT(m->mo_ops->moo_invalidate);
493         return m->mo_ops->moo_invalidate(env, m);
494 }
495
496 static inline int mo_layout_change(const struct lu_env *env,
497                                    struct md_object *m,
498                                    struct md_layout_change *layout)
499 {
500         /* need instantiate objects which in the access range */
501         LASSERT(m->mo_ops->moo_layout_change);
502         return m->mo_ops->moo_layout_change(env, m, layout);
503 }
504
505 static inline int mo_swap_layouts(const struct lu_env *env,
506                                   struct md_object *o1,
507                                   struct md_object *o2, __u64 flags)
508 {
509         LASSERT(o1->mo_ops->moo_swap_layouts);
510         LASSERT(o2->mo_ops->moo_swap_layouts);
511         if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
512                 return -EPERM;
513         return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
514 }
515
516 static inline int mo_open(const struct lu_env *env, struct md_object *m,
517                           u64 open_flags, struct md_op_spec *spec)
518 {
519         LASSERT(m->mo_ops->moo_open);
520         return m->mo_ops->moo_open(env, m, open_flags, spec);
521 }
522
523 static inline int mo_close(const struct lu_env *env, struct md_object *m,
524                            struct md_attr *ma, u64 open_flags)
525 {
526         LASSERT(m->mo_ops->moo_close);
527         return m->mo_ops->moo_close(env, m, ma, open_flags);
528 }
529
530 static inline int mo_readpage(const struct lu_env *env,
531                               struct md_object *m,
532                               const struct lu_rdpg *rdpg)
533 {
534         LASSERT(m->mo_ops->moo_readpage);
535         return m->mo_ops->moo_readpage(env, m, rdpg);
536 }
537
538 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
539 {
540         LASSERT(m->mo_ops->moo_object_sync);
541         return m->mo_ops->moo_object_sync(env, m);
542 }
543
544 static inline int mo_object_lock(const struct lu_env *env,
545                                  struct md_object *m,
546                                  struct lustre_handle *lh,
547                                  struct ldlm_enqueue_info *einfo,
548                                  union ldlm_policy_data *policy)
549 {
550         LASSERT(m->mo_ops->moo_object_lock);
551         return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
552 }
553
554 static inline int mo_object_unlock(const struct lu_env *env,
555                                    struct md_object *m,
556                                    struct ldlm_enqueue_info *einfo,
557                                    union ldlm_policy_data *policy)
558 {
559         LASSERT(m->mo_ops->moo_object_unlock);
560         return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
561 }
562
563 static inline int mdo_lookup(const struct lu_env *env,
564                              struct md_object *p,
565                              const struct lu_name *lname,
566                              struct lu_fid *f,
567                              struct md_op_spec *spec)
568 {
569         LASSERT(p->mo_dir_ops->mdo_lookup);
570         return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
571 }
572
573 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
574                                        struct md_object *mo,
575                                        mdl_mode_t lm)
576 {
577         if (mo->mo_dir_ops->mdo_lock_mode == NULL)
578                 return MDL_MINMODE;
579         return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
580 }
581
582 static inline int mdo_create(const struct lu_env *env,
583                              struct md_object *p,
584                              const struct lu_name *lchild_name,
585                              struct md_object *c,
586                              struct md_op_spec *spc,
587                              struct md_attr *at)
588 {
589         LASSERT(p->mo_dir_ops->mdo_create);
590         return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
591 }
592
593 static inline int mdo_create_data(const struct lu_env *env,
594                                   struct md_object *p,
595                                   struct md_object *c,
596                                   const struct md_op_spec *spec,
597                                   struct md_attr *ma)
598 {
599         LASSERT(c->mo_dir_ops->mdo_create_data);
600         return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
601 }
602
603 static inline int mdo_rename(const struct lu_env *env,
604                              struct md_object *sp,
605                              struct md_object *tp,
606                              const struct lu_fid *lf,
607                              const struct lu_name *lsname,
608                              struct md_object *t,
609                              const struct lu_name *ltname,
610                              struct md_attr *ma)
611 {
612         LASSERT(tp->mo_dir_ops->mdo_rename);
613         return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
614                                           ma);
615 }
616
617 static inline int mdo_migrate(const struct lu_env *env,
618                              struct md_object *pobj,
619                              struct md_object *sobj,
620                              const struct lu_name *lname,
621                              struct md_object *tobj,
622                              struct md_op_spec *spec,
623                              struct md_attr *ma)
624 {
625         LASSERT(pobj->mo_dir_ops->mdo_migrate);
626         return pobj->mo_dir_ops->mdo_migrate(env, pobj, sobj, lname, tobj, spec,
627                                              ma);
628 }
629
630 static inline int mdo_is_subdir(const struct lu_env *env,
631                                 struct md_object *mo,
632                                 const struct lu_fid *fid)
633 {
634         LASSERT(mo->mo_dir_ops->mdo_is_subdir);
635         return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid);
636 }
637
638 static inline int mdo_link(const struct lu_env *env,
639                            struct md_object *p,
640                            struct md_object *s,
641                            const struct lu_name *lname,
642                            struct md_attr *ma)
643 {
644         LASSERT(s->mo_dir_ops->mdo_link);
645         return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
646 }
647
648 static inline int mdo_unlink(const struct lu_env *env,
649                              struct md_object *p,
650                              struct md_object *c,
651                              const struct lu_name *lname,
652                              struct md_attr *ma, int no_name)
653 {
654         LASSERT(p->mo_dir_ops->mdo_unlink);
655         return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
656 }
657
658 static inline int mdo_statfs(const struct lu_env *env,
659                              struct md_device *m,
660                              struct obd_statfs *sfs)
661 {
662         LASSERT(m->md_ops->mdo_statfs);
663         return m->md_ops->mdo_statfs(env, m, sfs);
664 }
665
666 struct dt_device;
667
668 void lustre_som_swab(struct lustre_som_attrs *attrs);
669 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
670 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
671
672 enum {
673         UCRED_INVALID   = -1,
674         UCRED_INIT      = 0,
675         UCRED_OLD       = 1,
676         UCRED_NEW       = 2,
677 };
678
679 struct lu_ucred {
680         __u32                    uc_valid;
681         __u32                    uc_o_uid;
682         __u32                    uc_o_gid;
683         __u32                    uc_o_fsuid;
684         __u32                    uc_o_fsgid;
685         __u32                    uc_uid;
686         __u32                    uc_gid;
687         __u32                    uc_fsuid;
688         __u32                    uc_fsgid;
689         __u32                    uc_suppgids[2];
690         cfs_cap_t                uc_cap;
691         __u32                    uc_umask;
692         struct group_info       *uc_ginfo;
693         struct md_identity      *uc_identity;
694         char                     uc_jobid[LUSTRE_JOBID_SIZE];
695         lnet_nid_t               uc_nid;
696         bool                     uc_enable_audit;
697 };
698
699 struct lu_ucred *lu_ucred(const struct lu_env *env);
700
701 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
702
703 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
704
705 int lu_ucred_global_init(void);
706
707 void lu_ucred_global_fini(void);
708
709 #define md_cap_t(x) (x)
710
711 #define MD_CAP_TO_MASK(x) (1 << (x))
712
713 #define md_cap_raised(c, flag) (md_cap_t(c) & MD_CAP_TO_MASK(flag))
714
715 /* capable() is copied from linux kernel! */
716 static inline int md_capable(struct lu_ucred *uc, cfs_cap_t cap)
717 {
718         if (md_cap_raised(uc->uc_cap, cap))
719                 return 1;
720         return 0;
721 }
722
723 /** @} md */
724 #endif /* _LINUX_MD_OBJECT_H */