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 /** \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 struct md_quota {
  67         struct obd_export       *mq_exp;
  68 };
  69
  70 struct md_quota *md_quota(const struct lu_env *env);
  71
  72 /** metadata attributes */
  73 enum ma_valid {
  74         MA_INODE     = (1 << 0),
  75         MA_LOV       = (1 << 1),
  76         MA_COOKIE    = (1 << 2),
  77         MA_FLAGS     = (1 << 3),
  78         MA_LMV       = (1 << 4),
  79         MA_ACL_DEF   = (1 << 5),
  80         MA_LOV_DEF   = (1 << 6),
  81         MA_LAY_GEN   = (1 << 7),
  82         MA_HSM       = (1 << 8),
  83         MA_SOM       = (1 << 9),
  84         MA_PFID      = (1 << 10),
  85         MA_LMV_DEF   = (1 << 11)
  86 };
  87
  88 typedef enum {
  89         MDL_MINMODE  = 0,
  90         MDL_EX       = 1,
  91         MDL_PW       = 2,
  92         MDL_PR       = 4,
  93         MDL_CW       = 8,
  94         MDL_CR       = 16,
  95         MDL_NL       = 32,
  96         MDL_GROUP    = 64,
  97         MDL_MAXMODE
  98 } mdl_mode_t;
  99
 100 typedef enum {
 101         MDT_NUL_LOCK = 0,
 102         MDT_REG_LOCK = (1 << 0),
 103         MDT_PDO_LOCK = (1 << 1)
 104 } mdl_type_t;
 105
 106 /* memory structure for hsm attributes
 107  * for fields description see the on disk structure hsm_attrs
 108  * which is defined in lustre_idl.h
 109  */
 110 struct md_hsm {
 111         __u32   mh_compat;
 112         __u32   mh_flags;
 113         __u64   mh_arch_id;
 114         __u64   mh_arch_ver;
 115 };
 116
 117 #define IOEPOCH_INVAL 0
 118
 119 /* memory structure for som attributes
 120  * for fields description see the on disk structure som_attrs
 121  * which is defined in lustre_idl.h
 122  */
 123 struct md_som_data {
 124         __u32   msd_compat;
 125         __u32   msd_incompat;
 126         __u64   msd_ioepoch;
 127         __u64   msd_size;
 128         __u64   msd_blocks;
 129         __u64   msd_mountid;
 130 };
 131
 132 struct md_attr {
 133         __u64                   ma_valid;
 134         __u64                   ma_need;
 135         __u64                   ma_attr_flags;
 136         struct lu_attr          ma_attr;
 137         struct lu_fid           ma_pfid;
 138         struct md_hsm           ma_hsm;
 139         struct lov_mds_md      *ma_lmm;
 140         union lmv_mds_md       *ma_lmv;
 141         void                   *ma_acl;
 142         struct lustre_capa     *ma_capa;
 143         struct md_som_data     *ma_som;
 144         int                     ma_lmm_size;
 145         int                     ma_lmv_size;
 146         int                     ma_acl_size;
 147         __u16                   ma_layout_gen;
 148 };
 149
 150 /** Additional parameters for create */
 151 struct md_op_spec {
 152         union {
 153                 /** symlink target */
 154                 const char               *sp_symname;
 155                 /** parent FID for cross-ref mkdir */
 156                 const struct lu_fid      *sp_pfid;
 157                 /** eadata for regular files */
 158                 struct md_spec_reg {
 159                         /** lov objs exist already */
 160                         const struct lu_fid   *fid;
 161                         const void *eadata;
 162                         int  eadatalen;
 163                 } sp_ea;
 164         } u;
 165
 166         /** Create flag from client: such as MDS_OPEN_CREAT, and others. */
 167         __u64      sp_cr_flags;
 168
 169         /** don't create lov objects or llog cookie - this replay */
 170         unsigned int no_create:1,
 171                      sp_cr_lookup:1, /* do lookup sanity check or not. */
 172                      sp_rm_entry:1;  /* only remove name entry */
 173
 174         /** Current lock mode for parent dir where create is performing. */
 175         mdl_mode_t sp_cr_mode;
 176
 177         /** to create directory */
 178         const struct dt_index_features *sp_feat;
 179 };
 180
 181 union ldlm_policy_data;
 182 /**
 183  * Operations implemented for each md object (both directory and leaf).
 184  */
 185 struct md_object_operations {
 186         int (*moo_permission)(const struct lu_env *env,
 187                               struct md_object *pobj, struct md_object *cobj,
 188                               struct md_attr *attr, int mask);
 189
 190         int (*moo_attr_get)(const struct lu_env *env, struct md_object *obj,
 191                             struct md_attr *attr);
 192
 193         int (*moo_attr_set)(const struct lu_env *env, struct md_object *obj,
 194                             const struct md_attr *attr);
 195
 196         int (*moo_xattr_get)(const struct lu_env *env, struct md_object *obj,
 197                              struct lu_buf *buf, const char *name);
 198
 199         int (*moo_xattr_list)(const struct lu_env *env, struct md_object *obj,
 200                               struct lu_buf *buf);
 201
 202         int (*moo_xattr_set)(const struct lu_env *env, struct md_object *obj,
 203                              const struct lu_buf *buf, const char *name,
 204                              int fl);
 205
 206         int (*moo_xattr_del)(const struct lu_env *env, struct md_object *obj,
 207                              const char *name);
 208
 209         /** This method is used to swap the layouts between 2 objects */
 210         int (*moo_swap_layouts)(const struct lu_env *env,
 211                                struct md_object *obj1, struct md_object *obj2,
 212                                __u64 flags);
 213
 214         /** \retval number of bytes actually read upon success */
 215         int (*moo_readpage)(const struct lu_env *env, struct md_object *obj,
 216                             const struct lu_rdpg *rdpg);
 217
 218         int (*moo_readlink)(const struct lu_env *env, struct md_object *obj,
 219                             struct lu_buf *buf);
 220         int (*moo_changelog)(const struct lu_env *env,
 221                              enum changelog_rec_type type, int flags,
 222                              struct md_object *obj);
 223         /** part of cross-ref operation */
 224         int (*moo_object_create)(const struct lu_env *env,
 225                                  struct md_object *obj,
 226                                  const struct md_op_spec *spec,
 227                                  struct md_attr *ma);
 228
 229         int (*moo_ref_add)(const struct lu_env *env,
 230                            struct md_object *obj,
 231                            const struct md_attr *ma);
 232
 233         int (*moo_ref_del)(const struct lu_env *env,
 234                            struct md_object *obj,
 235                            struct md_attr *ma);
 236
 237         int (*moo_open)(const struct lu_env *env,
 238                         struct md_object *obj, int flag);
 239
 240         int (*moo_close)(const struct lu_env *env, struct md_object *obj,
 241                          struct md_attr *ma, int mode);
 242
 243         int (*moo_capa_get)(const struct lu_env *, struct md_object *,
 244                             struct lustre_capa *, int renewal);
 245
 246         int (*moo_object_sync)(const struct lu_env *, struct md_object *);
 247
 248         int (*moo_file_lock)(const struct lu_env *env, struct md_object *obj,
 249                              struct lov_mds_md *lmm, struct ldlm_extent *extent,
 250                              struct lustre_handle *lockh);
 251         int (*moo_file_unlock)(const struct lu_env *env, struct md_object *obj,
 252                                struct lov_mds_md *lmm,
 253                                struct lustre_handle *lockh);
 254         int (*moo_object_lock)(const struct lu_env *env, struct md_object *obj,
 255                                struct lustre_handle *lh,
 256                                struct ldlm_enqueue_info *einfo,
 257                                union ldlm_policy_data *policy);
 258         int (*moo_object_unlock)(const struct lu_env *env,
 259                                  struct md_object *obj,
 260                                  struct ldlm_enqueue_info *einfo,
 261                                  union ldlm_policy_data *policy);
 262 };
 263
 264 /**
 265  * Operations implemented for each directory object.
 266  */
 267 struct md_dir_operations {
 268         int (*mdo_is_subdir) (const struct lu_env *env, struct md_object *obj,
 269                               const struct lu_fid *fid, struct lu_fid *sfid);
 270
 271         int (*mdo_lookup)(const struct lu_env *env, struct md_object *obj,
 272                           const struct lu_name *lname, struct lu_fid *fid,
 273                           struct md_op_spec *spec);
 274
 275         mdl_mode_t (*mdo_lock_mode)(const struct lu_env *env,
 276                                     struct md_object *obj,
 277                                     mdl_mode_t mode);
 278
 279         int (*mdo_create)(const struct lu_env *env, struct md_object *pobj,
 280                           const struct lu_name *lname, struct md_object *child,
 281                           struct md_op_spec *spec,
 282                           struct md_attr *ma);
 283
 284         /** This method is used for creating data object for this meta object*/
 285         int (*mdo_create_data)(const struct lu_env *env, struct md_object *p,
 286                                struct md_object *o,
 287                                const struct md_op_spec *spec,
 288                                struct md_attr *ma);
 289
 290         int (*mdo_rename)(const struct lu_env *env, struct md_object *spobj,
 291                           struct md_object *tpobj, const struct lu_fid *lf,
 292                           const struct lu_name *lsname, struct md_object *tobj,
 293                           const struct lu_name *ltname, struct md_attr *ma);
 294
 295         int (*mdo_link)(const struct lu_env *env, struct md_object *tgt_obj,
 296                         struct md_object *src_obj, const struct lu_name *lname,
 297                         struct md_attr *ma);
 298
 299         int (*mdo_unlink)(const struct lu_env *env, struct md_object *pobj,
 300                           struct md_object *cobj, const struct lu_name *lname,
 301                           struct md_attr *ma, int no_name);
 302
 303         int (*mdo_migrate)(const struct lu_env *env, struct md_object *pobj,
 304                            struct md_object *sobj, const struct lu_name *lname,
 305                            struct md_object *tobj, struct md_attr *ma);
 306         /** This method is used to compare a requested layout to an existing
 307          * layout (struct lov_mds_md_v1/3 vs struct lov_mds_md_v1/3) */
 308         int (*mdo_lum_lmm_cmp)(const struct lu_env *env,
 309                                struct md_object *cobj,
 310                                const struct md_op_spec *spec,
 311                                struct md_attr *ma);
 312
 313         /** partial ops for cross-ref case */
 314         int (*mdo_name_insert)(const struct lu_env *env,
 315                                struct md_object *obj,
 316                                const struct lu_name *lname,
 317                                const struct lu_fid *fid,
 318                                const struct md_attr *ma);
 319
 320         int (*mdo_name_remove)(const struct lu_env *env,
 321                                struct md_object *obj,
 322                                const struct lu_name *lname,
 323                                const struct md_attr *ma);
 324
 325         int (*mdo_rename_tgt)(const struct lu_env *env, struct md_object *pobj,
 326                               struct md_object *tobj, const struct lu_fid *fid,
 327                               const struct lu_name *lname, struct md_attr *ma);
 328 };
 329
 330 struct md_device_operations {
 331         /** meta-data device related handlers. */
 332         int (*mdo_root_get)(const struct lu_env *env, struct md_device *m,
 333                             struct lu_fid *f);
 334
 335         int (*mdo_maxeasize_get)(const struct lu_env *env, struct md_device *m,
 336                                 int *easize);
 337
 338         int (*mdo_statfs)(const struct lu_env *env, struct md_device *m,
 339                           struct obd_statfs *sfs);
 340
 341         int (*mdo_init_capa_ctxt)(const struct lu_env *env, struct md_device *m,
 342                                   int mode, unsigned long timeout, __u32 alg,
 343                                   struct lustre_capa_key *keys);
 344
 345         int (*mdo_update_capa_key)(const struct lu_env *env,
 346                                    struct md_device *m,
 347                                    struct lustre_capa_key *key);
 348
 349         int (*mdo_llog_ctxt_get)(const struct lu_env *env,
 350                                  struct md_device *m, int idx, void **h);
 351
 352         int (*mdo_iocontrol)(const struct lu_env *env, struct md_device *m,
 353                              unsigned int cmd, int len, void *data);
 354 };
 355
 356 enum md_upcall_event {
 357         /** Sync the md layer*/
 358         MD_LOV_SYNC = (1 << 0),
 359         /** Just for split, no need trans, for replay */
 360         MD_NO_TRANS = (1 << 1),
 361         MD_LOV_CONFIG = (1 << 2),
 362         /** Trigger quota recovery */
 363         MD_LOV_QUOTA = (1 << 3)
 364 };
 365
 366 struct md_upcall {
 367         /** this lock protects upcall using against its removal
 368          * read lock is for usage the upcall, write - for init/fini */
 369         struct rw_semaphore     mu_upcall_sem;
 370         /** device to call, upper layer normally */
 371         struct md_device       *mu_upcall_dev;
 372         /** upcall function */
 373         int (*mu_upcall)(const struct lu_env *env, struct md_device *md,
 374                          enum md_upcall_event ev, void *data);
 375 };
 376
 377 struct md_device {
 378         struct lu_device                   md_lu_dev;
 379         const struct md_device_operations *md_ops;
 380         struct md_upcall                   md_upcall;
 381 };
 382
 383 static inline void md_upcall_init(struct md_device *m, void *upcl)
 384 {
 385         init_rwsem(&m->md_upcall.mu_upcall_sem);
 386         m->md_upcall.mu_upcall_dev = NULL;
 387         m->md_upcall.mu_upcall = upcl;
 388 }
 389
 390 static inline void md_upcall_dev_set(struct md_device *m, struct md_device *up)
 391 {
 392         down_write(&m->md_upcall.mu_upcall_sem);
 393         m->md_upcall.mu_upcall_dev = up;
 394         up_write(&m->md_upcall.mu_upcall_sem);
 395 }
 396
 397 static inline void md_upcall_fini(struct md_device *m)
 398 {
 399         down_write(&m->md_upcall.mu_upcall_sem);
 400         m->md_upcall.mu_upcall_dev = NULL;
 401         m->md_upcall.mu_upcall = NULL;
 402         up_write(&m->md_upcall.mu_upcall_sem);
 403 }
 404
 405 static inline int md_do_upcall(const struct lu_env *env, struct md_device *m,
 406                                 enum md_upcall_event ev, void *data)
 407 {
 408         int rc = 0;
 409         down_read(&m->md_upcall.mu_upcall_sem);
 410         if (m->md_upcall.mu_upcall_dev != NULL &&
 411             m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall != NULL) {
 412                 rc = m->md_upcall.mu_upcall_dev->md_upcall.mu_upcall(env,
 413                                               m->md_upcall.mu_upcall_dev,
 414                                               ev, data);
 415         }
 416         up_read(&m->md_upcall.mu_upcall_sem);
 417         return rc;
 418 }
 419
 420 struct md_object {
 421         struct lu_object                   mo_lu;
 422         const struct md_object_operations *mo_ops;
 423         const struct md_dir_operations    *mo_dir_ops;
 424 };
 425
 426 /**
 427  * seq-server site.
 428  */
 429 struct seq_server_site {
 430         struct lu_site       *ss_lu;
 431         /**
 432          * mds number of this site.
 433          */
 434         mdsno_t               ss_node_id;
 435         /**
 436          * Fid location database
 437          */
 438         struct lu_server_fld *ss_server_fld;
 439         struct lu_client_fld *ss_client_fld;
 440
 441         /**
 442          * Server Seq Manager
 443          */
 444         struct lu_server_seq *ss_server_seq;
 445
 446         /**
 447          * Controller Seq Manager
 448          */
 449         struct lu_server_seq *ss_control_seq;
 450         struct obd_export    *ss_control_exp;
 451
 452         /**
 453          * Client Seq Manager
 454          */
 455         struct lu_client_seq *ss_client_seq;
 456 };
 457
 458 static inline struct md_device *lu2md_dev(const struct lu_device *d)
 459 {
 460         LASSERT(IS_ERR(d) || lu_device_is_md(d));
 461         return container_of0(d, struct md_device, md_lu_dev);
 462 }
 463
 464 static inline struct lu_device *md2lu_dev(struct md_device *d)
 465 {
 466         return &d->md_lu_dev;
 467 }
 468
 469 static inline struct md_object *lu2md(const struct lu_object *o)
 470 {
 471         LASSERT(o == NULL || IS_ERR(o) || lu_device_is_md(o->lo_dev));
 472         return container_of0(o, struct md_object, mo_lu);
 473 }
 474
 475 static inline struct md_object *md_object_next(const struct md_object *obj)
 476 {
 477         return (obj ? lu2md(lu_object_next(&obj->mo_lu)) : NULL);
 478 }
 479
 480 static inline int md_device_init(struct md_device *md, struct lu_device_type *t)
 481 {
 482         return lu_device_init(&md->md_lu_dev, t);
 483 }
 484
 485 static inline void md_device_fini(struct md_device *md)
 486 {
 487         lu_device_fini(&md->md_lu_dev);
 488 }
 489
 490 static inline struct md_object *md_object_find_slice(const struct lu_env *env,
 491                                                      struct md_device *md,
 492                                                      const struct lu_fid *f)
 493 {
 494         return lu2md(lu_object_find_slice(env, md2lu_dev(md), f, NULL));
 495 }
 496
 497
 498 /** md operations */
 499 static inline int mo_permission(const struct lu_env *env,
 500                                 struct md_object *p,
 501                                 struct md_object *c,
 502                                 struct md_attr *at,
 503                                 int mask)
 504 {
 505         LASSERT(c->mo_ops->moo_permission);
 506         return c->mo_ops->moo_permission(env, p, c, at, mask);
 507 }
 508
 509 static inline int mo_attr_get(const struct lu_env *env,
 510                               struct md_object *m,
 511                               struct md_attr *at)
 512 {
 513         LASSERT(m->mo_ops->moo_attr_get);
 514         return m->mo_ops->moo_attr_get(env, m, at);
 515 }
 516
 517 static inline int mo_readlink(const struct lu_env *env,
 518                               struct md_object *m,
 519                               struct lu_buf *buf)
 520 {
 521         LASSERT(m->mo_ops->moo_readlink);
 522         return m->mo_ops->moo_readlink(env, m, buf);
 523 }
 524
 525 static inline int mo_changelog(const struct lu_env *env,
 526                                enum changelog_rec_type type,
 527                                int flags, struct md_object *m)
 528 {
 529         LASSERT(m->mo_ops->moo_changelog);
 530         return m->mo_ops->moo_changelog(env, type, flags, m);
 531 }
 532
 533 static inline int mo_attr_set(const struct lu_env *env,
 534                               struct md_object *m,
 535                               const struct md_attr *at)
 536 {
 537         LASSERT(m->mo_ops->moo_attr_set);
 538         return m->mo_ops->moo_attr_set(env, m, at);
 539 }
 540
 541 static inline int mo_xattr_get(const struct lu_env *env,
 542                                struct md_object *m,
 543                                struct lu_buf *buf,
 544                                const char *name)
 545 {
 546         LASSERT(m->mo_ops->moo_xattr_get);
 547         return m->mo_ops->moo_xattr_get(env, m, buf, name);
 548 }
 549
 550 static inline int mo_xattr_del(const struct lu_env *env,
 551                                struct md_object *m,
 552                                const char *name)
 553 {
 554         LASSERT(m->mo_ops->moo_xattr_del);
 555         return m->mo_ops->moo_xattr_del(env, m, name);
 556 }
 557
 558 static inline int mo_xattr_set(const struct lu_env *env,
 559                                struct md_object *m,
 560                                const struct lu_buf *buf,
 561                                const char *name,
 562                                int flags)
 563 {
 564         LASSERT(m->mo_ops->moo_xattr_set);
 565         return m->mo_ops->moo_xattr_set(env, m, buf, name, flags);
 566 }
 567
 568 static inline int mo_xattr_list(const struct lu_env *env,
 569                                 struct md_object *m,
 570                                 struct lu_buf *buf)
 571 {
 572         LASSERT(m->mo_ops->moo_xattr_list);
 573         return m->mo_ops->moo_xattr_list(env, m, buf);
 574 }
 575
 576 static inline int mo_swap_layouts(const struct lu_env *env,
 577                                   struct md_object *o1,
 578                                   struct md_object *o2, __u64 flags)
 579 {
 580         LASSERT(o1->mo_ops->moo_swap_layouts);
 581         LASSERT(o2->mo_ops->moo_swap_layouts);
 582         if (o1->mo_ops->moo_swap_layouts != o2->mo_ops->moo_swap_layouts)
 583                 return -EPERM;
 584         return o1->mo_ops->moo_swap_layouts(env, o1, o2, flags);
 585 }
 586
 587 static inline int mo_open(const struct lu_env *env,
 588                           struct md_object *m,
 589                           int flags)
 590 {
 591         LASSERT(m->mo_ops->moo_open);
 592         return m->mo_ops->moo_open(env, m, flags);
 593 }
 594
 595 static inline int mo_close(const struct lu_env *env,
 596                            struct md_object *m,
 597                            struct md_attr *ma,
 598                            int mode)
 599 {
 600         LASSERT(m->mo_ops->moo_close);
 601         return m->mo_ops->moo_close(env, m, ma, mode);
 602 }
 603
 604 static inline int mo_readpage(const struct lu_env *env,
 605                               struct md_object *m,
 606                               const struct lu_rdpg *rdpg)
 607 {
 608         LASSERT(m->mo_ops->moo_readpage);
 609         return m->mo_ops->moo_readpage(env, m, rdpg);
 610 }
 611
 612 static inline int mo_object_create(const struct lu_env *env,
 613                                    struct md_object *m,
 614                                    const struct md_op_spec *spc,
 615                                    struct md_attr *at)
 616 {
 617         LASSERT(m->mo_ops->moo_object_create);
 618         return m->mo_ops->moo_object_create(env, m, spc, at);
 619 }
 620
 621 static inline int mo_ref_add(const struct lu_env *env,
 622                              struct md_object *m,
 623                              const struct md_attr *ma)
 624 {
 625         LASSERT(m->mo_ops->moo_ref_add);
 626         return m->mo_ops->moo_ref_add(env, m, ma);
 627 }
 628
 629 static inline int mo_ref_del(const struct lu_env *env,
 630                              struct md_object *m,
 631                              struct md_attr *ma)
 632 {
 633         LASSERT(m->mo_ops->moo_ref_del);
 634         return m->mo_ops->moo_ref_del(env, m, ma);
 635 }
 636
 637 static inline int mo_capa_get(const struct lu_env *env,
 638                               struct md_object *m,
 639                               struct lustre_capa *c,
 640                               int renewal)
 641 {
 642         LASSERT(m->mo_ops->moo_capa_get);
 643         return m->mo_ops->moo_capa_get(env, m, c, renewal);
 644 }
 645
 646 static inline int mo_object_sync(const struct lu_env *env, struct md_object *m)
 647 {
 648         LASSERT(m->mo_ops->moo_object_sync);
 649         return m->mo_ops->moo_object_sync(env, m);
 650 }
 651
 652 static inline int mo_file_lock(const struct lu_env *env, struct md_object *m,
 653                                struct lov_mds_md *lmm,
 654                                struct ldlm_extent *extent,
 655                                struct lustre_handle *lockh)
 656 {
 657         LASSERT(m->mo_ops->moo_file_lock);
 658         return m->mo_ops->moo_file_lock(env, m, lmm, extent, lockh);
 659 }
 660
 661 static inline int mo_file_unlock(const struct lu_env *env, struct md_object *m,
 662                                  struct lov_mds_md *lmm,
 663                                  struct lustre_handle *lockh)
 664 {
 665         LASSERT(m->mo_ops->moo_file_unlock);
 666         return m->mo_ops->moo_file_unlock(env, m, lmm, lockh);
 667 }
 668
 669 static inline int mo_object_lock(const struct lu_env *env,
 670                                  struct md_object *m,
 671                                  struct lustre_handle *lh,
 672                                  struct ldlm_enqueue_info *einfo,
 673                                  union ldlm_policy_data *policy)
 674 {
 675         LASSERT(m->mo_ops->moo_object_lock);
 676         return m->mo_ops->moo_object_lock(env, m, lh, einfo, policy);
 677 }
 678
 679 static inline int mo_object_unlock(const struct lu_env *env,
 680                                    struct md_object *m,
 681                                    struct ldlm_enqueue_info *einfo,
 682                                    union ldlm_policy_data *policy)
 683 {
 684         LASSERT(m->mo_ops->moo_object_unlock);
 685         return m->mo_ops->moo_object_unlock(env, m, einfo, policy);
 686 }
 687
 688 static inline int mdo_lookup(const struct lu_env *env,
 689                              struct md_object *p,
 690                              const struct lu_name *lname,
 691                              struct lu_fid *f,
 692                              struct md_op_spec *spec)
 693 {
 694         LASSERT(p->mo_dir_ops->mdo_lookup);
 695         return p->mo_dir_ops->mdo_lookup(env, p, lname, f, spec);
 696 }
 697
 698 static inline mdl_mode_t mdo_lock_mode(const struct lu_env *env,
 699                                        struct md_object *mo,
 700                                        mdl_mode_t lm)
 701 {
 702         if (mo->mo_dir_ops->mdo_lock_mode == NULL)
 703                 return MDL_MINMODE;
 704         return mo->mo_dir_ops->mdo_lock_mode(env, mo, lm);
 705 }
 706
 707 static inline int mdo_create(const struct lu_env *env,
 708                              struct md_object *p,
 709                              const struct lu_name *lchild_name,
 710                              struct md_object *c,
 711                              struct md_op_spec *spc,
 712                              struct md_attr *at)
 713 {
 714         LASSERT(p->mo_dir_ops->mdo_create);
 715         return p->mo_dir_ops->mdo_create(env, p, lchild_name, c, spc, at);
 716 }
 717
 718 static inline int mdo_create_data(const struct lu_env *env,
 719                                   struct md_object *p,
 720                                   struct md_object *c,
 721                                   const struct md_op_spec *spec,
 722                                   struct md_attr *ma)
 723 {
 724         LASSERT(c->mo_dir_ops->mdo_create_data);
 725         return c->mo_dir_ops->mdo_create_data(env, p, c, spec, ma);
 726 }
 727
 728 static inline int mdo_rename(const struct lu_env *env,
 729                              struct md_object *sp,
 730                              struct md_object *tp,
 731                              const struct lu_fid *lf,
 732                              const struct lu_name *lsname,
 733                              struct md_object *t,
 734                              const struct lu_name *ltname,
 735                              struct md_attr *ma)
 736 {
 737         LASSERT(tp->mo_dir_ops->mdo_rename);
 738         return tp->mo_dir_ops->mdo_rename(env, sp, tp, lf, lsname, t, ltname,
 739                                           ma);
 740 }
 741
 742 static inline int mdo_migrate(const struct lu_env *env,
 743                              struct md_object *pobj,
 744                              struct md_object *sobj,
 745                              const struct lu_name *lname,
 746                              struct md_object *tobj,
 747                              struct md_attr *ma)
 748 {
 749         LASSERT(pobj->mo_dir_ops->mdo_migrate);
 750         return pobj->mo_dir_ops->mdo_migrate(env, pobj, sobj, lname, tobj, ma);
 751 }
 752
 753 static inline int mdo_is_subdir(const struct lu_env *env,
 754                                 struct md_object *mo,
 755                                 const struct lu_fid *fid,
 756                                 struct lu_fid *sfid)
 757 {
 758         LASSERT(mo->mo_dir_ops->mdo_is_subdir);
 759         return mo->mo_dir_ops->mdo_is_subdir(env, mo, fid, sfid);
 760 }
 761
 762 static inline int mdo_link(const struct lu_env *env,
 763                            struct md_object *p,
 764                            struct md_object *s,
 765                            const struct lu_name *lname,
 766                            struct md_attr *ma)
 767 {
 768         LASSERT(s->mo_dir_ops->mdo_link);
 769         return s->mo_dir_ops->mdo_link(env, p, s, lname, ma);
 770 }
 771
 772 static inline int mdo_unlink(const struct lu_env *env,
 773                              struct md_object *p,
 774                              struct md_object *c,
 775                              const struct lu_name *lname,
 776                              struct md_attr *ma, int no_name)
 777 {
 778         LASSERT(p->mo_dir_ops->mdo_unlink);
 779         return p->mo_dir_ops->mdo_unlink(env, p, c, lname, ma, no_name);
 780 }
 781
 782 static inline int mdo_lum_lmm_cmp(const struct lu_env *env,
 783                                   struct md_object *c,
 784                                   const struct md_op_spec *spec,
 785                                   struct md_attr *ma)
 786 {
 787         LASSERT(c->mo_dir_ops->mdo_lum_lmm_cmp);
 788         return c->mo_dir_ops->mdo_lum_lmm_cmp(env, c, spec, ma);
 789 }
 790
 791 static inline int mdo_name_insert(const struct lu_env *env,
 792                                   struct md_object *p,
 793                                   const struct lu_name *lname,
 794                                   const struct lu_fid *f,
 795                                   const struct md_attr *ma)
 796 {
 797         LASSERT(p->mo_dir_ops->mdo_name_insert);
 798         return p->mo_dir_ops->mdo_name_insert(env, p, lname, f, ma);
 799 }
 800
 801 static inline int mdo_name_remove(const struct lu_env *env,
 802                                   struct md_object *p,
 803                                   const struct lu_name *lname,
 804                                   const struct md_attr *ma)
 805 {
 806         LASSERT(p->mo_dir_ops->mdo_name_remove);
 807         return p->mo_dir_ops->mdo_name_remove(env, p, lname, ma);
 808 }
 809
 810 static inline int mdo_rename_tgt(const struct lu_env *env,
 811                                  struct md_object *p,
 812                                  struct md_object *t,
 813                                  const struct lu_fid *lf,
 814                                  const struct lu_name *lname,
 815                                  struct md_attr *ma)
 816 {
 817         if (t) {
 818                 LASSERT(t->mo_dir_ops->mdo_rename_tgt);
 819                 return t->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
 820         } else {
 821                 LASSERT(p->mo_dir_ops->mdo_rename_tgt);
 822                 return p->mo_dir_ops->mdo_rename_tgt(env, p, t, lf, lname, ma);
 823         }
 824 }
 825
 826 /**
 827  * Used in MDD/OUT layer for object lock rule
 828  **/
 829 enum mdd_object_role {
 830         MOR_SRC_PARENT,
 831         MOR_SRC_CHILD,
 832         MOR_TGT_PARENT,
 833         MOR_TGT_CHILD,
 834         MOR_TGT_ORPHAN
 835 };
 836
 837 struct dt_device;
 838 /**
 839  * Structure to hold object information. This is used to create object
 840  * \pre llod_dir exist
 841  */
 842 struct lu_local_obj_desc {
 843         const char                      *llod_dir;
 844         const char                      *llod_name;
 845         __u32                            llod_oid;
 846         int                              llod_is_index;
 847         const struct dt_index_features  *llod_feat;
 848         cfs_list_t                       llod_linkage;
 849 };
 850
 851 int lustre_buf2som(void *buf, int rc, struct md_som_data *msd);
 852 int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh);
 853 void lustre_hsm2buf(void *buf, const struct md_hsm *mh);
 854
 855 enum {
 856         UCRED_INVALID   = -1,
 857         UCRED_INIT      = 0,
 858         UCRED_OLD       = 1,
 859         UCRED_NEW       = 2,
 860 };
 861
 862 struct lu_ucred {
 863         __u32               uc_valid;
 864         __u32               uc_o_uid;
 865         __u32               uc_o_gid;
 866         __u32               uc_o_fsuid;
 867         __u32               uc_o_fsgid;
 868         __u32               uc_uid;
 869         __u32               uc_gid;
 870         __u32               uc_fsuid;
 871         __u32               uc_fsgid;
 872         __u32               uc_suppgids[2];
 873         cfs_cap_t           uc_cap;
 874         __u32               uc_umask;
 875         struct group_info   *uc_ginfo;
 876         struct md_identity *uc_identity;
 877 };
 878
 879 struct lu_ucred *lu_ucred(const struct lu_env *env);
 880
 881 struct lu_ucred *lu_ucred_check(const struct lu_env *env);
 882
 883 struct lu_ucred *lu_ucred_assert(const struct lu_env *env);
 884
 885 int lu_ucred_global_init(void);
 886
 887 void lu_ucred_global_fini(void);
 888
 889 #define md_cap_t(x) (x)
 890
 891 #define MD_CAP_TO_MASK(x) (1 << (x))
 892
 893 #define md_cap_raised(c, flag) (md_cap_t(c) & MD_CAP_TO_MASK(flag))
 894
 895 /* capable() is copied from linux kernel! */
 896 static inline int md_capable(struct lu_ucred *uc, cfs_cap_t cap)
 897 {
 898         if (md_cap_raised(uc->uc_cap, cap))
 899                 return 1;
 900         return 0;
 901 }
 902
 903 /** @} md */
 904 #endif /* _LINUX_MD_OBJECT_H */