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