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