lustre/include/dt_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
  37 #ifndef __LUSTRE_DT_OBJECT_H
  38 #define __LUSTRE_DT_OBJECT_H
  39
  40 /** \defgroup dt dt
  41  * Sub-class of lu_object with methods common for "data" objects in OST stack.
  42  *
  43  * Data objects behave like regular files: you can read/write them, get and
  44  * set their attributes. Implementation of dt interface is supposed to
  45  * implement some form of garbage collection, normally reference counting
  46  * (nlink) based one.
  47  *
  48  * Examples: osd (lustre/osd) is an implementation of dt interface.
  49  * @{
  50  */
  51
  52 #include <obd_support.h>
  53 /*
  54  * super-class definitions.
  55  */
  56 #include <lu_object.h>
  57
  58 #include <libcfs/libcfs.h>
  59
  60 struct seq_file;
  61 struct proc_dir_entry;
  62 struct lustre_cfg;
  63
  64 struct thandle;
  65 struct dt_device;
  66 struct dt_object;
  67 struct dt_index_features;
  68 struct niobuf_local;
  69 struct niobuf_remote;
  70 struct ldlm_enqueue_info;
  71
  72 typedef enum {
  73         MNTOPT_USERXATTR        = 0x00000001,
  74         MNTOPT_ACL              = 0x00000002,
  75 } mntopt_t;
  76
  77 struct dt_device_param {
  78         unsigned           ddp_max_name_len;
  79         unsigned           ddp_max_nlink;
  80         unsigned           ddp_block_shift;
  81         mntopt_t           ddp_mntopts;
  82         unsigned           ddp_max_ea_size;
  83         int                ddp_mount_type;
  84         unsigned long long ddp_maxbytes;
  85         /* percentage of available space to reserve for grant error margin */
  86         int                ddp_grant_reserved;
  87         /* per-inode space consumption */
  88         short              ddp_inodespace;
  89         /* per-fragment grant overhead to be used by client for grant
  90          * calculation */
  91         int                ddp_grant_frag;
  92 };
  93
  94 /**
  95  * Per-transaction commit callback function
  96  */
  97 struct dt_txn_commit_cb;
  98 typedef void (*dt_cb_t)(struct lu_env *env, struct thandle *th,
  99                         struct dt_txn_commit_cb *cb, int err);
 100 /**
 101  * Special per-transaction callback for cases when just commit callback
 102  * is needed and per-device callback are not convenient to use
 103  */
 104 #define TRANS_COMMIT_CB_MAGIC   0xa0a00a0a
 105 #define MAX_COMMIT_CB_STR_LEN   32
 106
 107 struct dt_txn_commit_cb {
 108         cfs_list_t      dcb_linkage;
 109         dt_cb_t         dcb_func;
 110         __u32           dcb_magic;
 111         char            dcb_name[MAX_COMMIT_CB_STR_LEN];
 112 };
 113
 114 /**
 115  * Operations on dt device.
 116  */
 117 struct dt_device_operations {
 118         /**
 119          * Return device-wide statistics.
 120          */
 121         int   (*dt_statfs)(const struct lu_env *env,
 122                            struct dt_device *dev, struct obd_statfs *osfs);
 123         /**
 124          * Create transaction, described by \a param.
 125          */
 126         struct thandle *(*dt_trans_create)(const struct lu_env *env,
 127                                            struct dt_device *dev);
 128         /**
 129          * Start transaction, described by \a param.
 130          */
 131         int   (*dt_trans_start)(const struct lu_env *env,
 132                                 struct dt_device *dev, struct thandle *th);
 133         /**
 134          * Finish previously started transaction.
 135          */
 136         int   (*dt_trans_stop)(const struct lu_env *env, struct dt_device *dev,
 137                                struct thandle *th);
 138         /**
 139          * Add commit callback to the transaction.
 140          */
 141         int   (*dt_trans_cb_add)(struct thandle *th,
 142                                  struct dt_txn_commit_cb *dcb);
 143         /**
 144          * Return fid of root index object.
 145          */
 146         int   (*dt_root_get)(const struct lu_env *env,
 147                              struct dt_device *dev, struct lu_fid *f);
 148         /**
 149          * Return device configuration data.
 150          */
 151         void  (*dt_conf_get)(const struct lu_env *env,
 152                              const struct dt_device *dev,
 153                              struct dt_device_param *param);
 154         /**
 155          *  handling device state, mostly for tests
 156          */
 157         int   (*dt_sync)(const struct lu_env *env, struct dt_device *dev);
 158         int   (*dt_ro)(const struct lu_env *env, struct dt_device *dev);
 159         /**
 160           * Start a transaction commit asynchronously
 161           *
 162           * \param env environment
 163           * \param dev dt_device to start commit on
 164           *
 165           * \return 0 success, negative value if error
 166           */
 167          int   (*dt_commit_async)(const struct lu_env *env,
 168                                   struct dt_device *dev);
 169         /**
 170          * Initialize capability context.
 171          */
 172         int   (*dt_init_capa_ctxt)(const struct lu_env *env,
 173                                    struct dt_device *dev,
 174                                    int mode, unsigned long timeout,
 175                                    __u32 alg, struct lustre_capa_key *keys);
 176 };
 177
 178 struct dt_index_features {
 179         /** required feature flags from enum dt_index_flags */
 180         __u32 dif_flags;
 181         /** minimal required key size */
 182         size_t dif_keysize_min;
 183         /** maximal required key size, 0 if no limit */
 184         size_t dif_keysize_max;
 185         /** minimal required record size */
 186         size_t dif_recsize_min;
 187         /** maximal required record size, 0 if no limit */
 188         size_t dif_recsize_max;
 189         /** pointer size for record */
 190         size_t dif_ptrsize;
 191 };
 192
 193 enum dt_index_flags {
 194         /** index supports variable sized keys */
 195         DT_IND_VARKEY = 1 << 0,
 196         /** index supports variable sized records */
 197         DT_IND_VARREC = 1 << 1,
 198         /** index can be modified */
 199         DT_IND_UPDATE = 1 << 2,
 200         /** index supports records with non-unique (duplicate) keys */
 201         DT_IND_NONUNQ = 1 << 3,
 202         /**
 203          * index support fixed-size keys sorted with natural numerical way
 204          * and is able to return left-side value if no exact value found
 205          */
 206         DT_IND_RANGE = 1 << 4,
 207 };
 208
 209 /**
 210  * Features, required from index to support file system directories (mapping
 211  * names to fids).
 212  */
 213 extern const struct dt_index_features dt_directory_features;
 214 extern const struct dt_index_features dt_otable_features;
 215 extern const struct dt_index_features dt_lfsck_features;
 216
 217 /* index features supported by the accounting objects */
 218 extern const struct dt_index_features dt_acct_features;
 219
 220 /* index features supported by the quota global indexes */
 221 extern const struct dt_index_features dt_quota_glb_features;
 222
 223 /* index features supported by the quota slave indexes */
 224 extern const struct dt_index_features dt_quota_slv_features;
 225
 226 /**
 227  * This is a general purpose dt allocation hint.
 228  * It now contains the parent object.
 229  * It can contain any allocation hint in the future.
 230  */
 231 struct dt_allocation_hint {
 232         struct dt_object        *dah_parent;
 233         const void              *dah_eadata;
 234         int                     dah_eadata_len;
 235         __u32                   dah_mode;
 236 };
 237
 238 /**
 239  * object type specifier.
 240  */
 241
 242 enum dt_format_type {
 243         DFT_REGULAR,
 244         DFT_DIR,
 245         /** for mknod */
 246         DFT_NODE,
 247         /** for special index */
 248         DFT_INDEX,
 249         /** for symbolic link */
 250         DFT_SYM,
 251 };
 252
 253 /**
 254  * object format specifier.
 255  */
 256 struct dt_object_format {
 257         /** type for dt object */
 258         enum dt_format_type dof_type;
 259         union {
 260                 struct dof_regular {
 261                         int striped;
 262                 } dof_reg;
 263                 struct dof_dir {
 264                 } dof_dir;
 265                 struct dof_node {
 266                 } dof_node;
 267                 /**
 268                  * special index need feature as parameter to create
 269                  * special idx
 270                  */
 271                 struct dof_index {
 272                         const struct dt_index_features *di_feat;
 273                 } dof_idx;
 274         } u;
 275 };
 276
 277 enum dt_format_type dt_mode_to_dft(__u32 mode);
 278
 279 typedef __u64 dt_obj_version_t;
 280
 281 /**
 282  * Per-dt-object operations.
 283  */
 284 struct dt_object_operations {
 285         void  (*do_read_lock)(const struct lu_env *env,
 286                               struct dt_object *dt, unsigned role);
 287         void  (*do_write_lock)(const struct lu_env *env,
 288                                struct dt_object *dt, unsigned role);
 289         void  (*do_read_unlock)(const struct lu_env *env,
 290                                 struct dt_object *dt);
 291         void  (*do_write_unlock)(const struct lu_env *env,
 292                                  struct dt_object *dt);
 293         int  (*do_write_locked)(const struct lu_env *env,
 294                                 struct dt_object *dt);
 295         /**
 296          * Note: following ->do_{x,}attr_{set,get}() operations are very
 297          * similar to ->moo_{x,}attr_{set,get}() operations in struct
 298          * md_object_operations (see md_object.h). These operations are not in
 299          * lu_object_operations, because ->do_{x,}attr_set() versions take
 300          * transaction handle as an argument (this transaction is started by
 301          * caller). We might factor ->do_{x,}attr_get() into
 302          * lu_object_operations, but that would break existing symmetry.
 303          */
 304
 305         int   (*do_declare_attr_get)(const struct lu_env *env,
 306                                      struct dt_object *dt,
 307                                      struct lustre_capa *capa);
 308         /**
 309          * Return standard attributes.
 310          *
 311          * precondition: lu_object_exists(&dt->do_lu);
 312          */
 313         int   (*do_attr_get)(const struct lu_env *env,
 314                              struct dt_object *dt, struct lu_attr *attr,
 315                              struct lustre_capa *capa);
 316         /**
 317          * Set standard attributes.
 318          *
 319          * precondition: dt_object_exists(dt);
 320          */
 321         int   (*do_declare_attr_set)(const struct lu_env *env,
 322                                      struct dt_object *dt,
 323                                      const struct lu_attr *attr,
 324                                      struct thandle *handle);
 325         int   (*do_attr_set)(const struct lu_env *env,
 326                              struct dt_object *dt,
 327                              const struct lu_attr *attr,
 328                              struct thandle *handle,
 329                              struct lustre_capa *capa);
 330
 331         int   (*do_declare_xattr_get)(const struct lu_env *env,
 332                                       struct dt_object *dt,
 333                                       struct lu_buf *buf,
 334                                       const char *name,
 335                                       struct lustre_capa *capa);
 336
 337         /**
 338          * Return a value of an extended attribute.
 339          *
 340          * precondition: dt_object_exists(dt);
 341          */
 342         int   (*do_xattr_get)(const struct lu_env *env, struct dt_object *dt,
 343                               struct lu_buf *buf, const char *name,
 344                               struct lustre_capa *capa);
 345         /**
 346          * Set value of an extended attribute.
 347          *
 348          * \a fl - flags from enum lu_xattr_flags
 349          *
 350          * precondition: dt_object_exists(dt);
 351          */
 352         int   (*do_declare_xattr_set)(const struct lu_env *env,
 353                                       struct dt_object *dt,
 354                                       const struct lu_buf *buf,
 355                                       const char *name, int fl,
 356                                       struct thandle *handle);
 357         int   (*do_xattr_set)(const struct lu_env *env,
 358                               struct dt_object *dt, const struct lu_buf *buf,
 359                               const char *name, int fl, struct thandle *handle,
 360                               struct lustre_capa *capa);
 361         /**
 362          * Delete existing extended attribute.
 363          *
 364          * precondition: dt_object_exists(dt);
 365          */
 366         int   (*do_declare_xattr_del)(const struct lu_env *env,
 367                                       struct dt_object *dt,
 368                                       const char *name, struct thandle *handle);
 369         int   (*do_xattr_del)(const struct lu_env *env,
 370                               struct dt_object *dt,
 371                               const char *name, struct thandle *handle,
 372                               struct lustre_capa *capa);
 373         /**
 374          * Place list of existing extended attributes into \a buf (which has
 375          * length len).
 376          *
 377          * precondition: dt_object_exists(dt);
 378          */
 379         int   (*do_xattr_list)(const struct lu_env *env,
 380                                struct dt_object *dt, struct lu_buf *buf,
 381                                struct lustre_capa *capa);
 382         /**
 383          * Init allocation hint using parent object and child mode.
 384          * (1) The \a parent might be NULL if this is a partial creation for
 385          *     remote object.
 386          * (2) The type of child is in \a child_mode.
 387          * (3) The result hint is stored in \a ah;
 388          */
 389         void  (*do_ah_init)(const struct lu_env *env,
 390                             struct dt_allocation_hint *ah,
 391                             struct dt_object *parent,
 392                             struct dt_object *child,
 393                             umode_t child_mode);
 394         /**
 395          * Create new object on this device.
 396          *
 397          * precondition: !dt_object_exists(dt);
 398          * postcondition: ergo(result == 0, dt_object_exists(dt));
 399          */
 400         int   (*do_declare_create)(const struct lu_env *env,
 401                                    struct dt_object *dt,
 402                                    struct lu_attr *attr,
 403                                    struct dt_allocation_hint *hint,
 404                                    struct dt_object_format *dof,
 405                                    struct thandle *th);
 406         int   (*do_create)(const struct lu_env *env, struct dt_object *dt,
 407                            struct lu_attr *attr,
 408                            struct dt_allocation_hint *hint,
 409                            struct dt_object_format *dof,
 410                            struct thandle *th);
 411
 412         /**
 413           Destroy object on this device
 414          * precondition: !dt_object_exists(dt);
 415          * postcondition: ergo(result == 0, dt_object_exists(dt));
 416          */
 417         int   (*do_declare_destroy)(const struct lu_env *env,
 418                                     struct dt_object *dt,
 419                                     struct thandle *th);
 420         int   (*do_destroy)(const struct lu_env *env, struct dt_object *dt,
 421                             struct thandle *th);
 422
 423         /**
 424          * Announce that this object is going to be used as an index. This
 425          * operation check that object supports indexing operations and
 426          * installs appropriate dt_index_operations vector on success.
 427          *
 428          * Also probes for features. Operation is successful if all required
 429          * features are supported.
 430          */
 431         int   (*do_index_try)(const struct lu_env *env,
 432                               struct dt_object *dt,
 433                               const struct dt_index_features *feat);
 434         /**
 435          * Add nlink of the object
 436          * precondition: dt_object_exists(dt);
 437          */
 438         int   (*do_declare_ref_add)(const struct lu_env *env,
 439                                     struct dt_object *dt, struct thandle *th);
 440         int   (*do_ref_add)(const struct lu_env *env,
 441                             struct dt_object *dt, struct thandle *th);
 442         /**
 443          * Del nlink of the object
 444          * precondition: dt_object_exists(dt);
 445          */
 446         int   (*do_declare_ref_del)(const struct lu_env *env,
 447                                     struct dt_object *dt, struct thandle *th);
 448         int   (*do_ref_del)(const struct lu_env *env,
 449                             struct dt_object *dt, struct thandle *th);
 450
 451         struct obd_capa *(*do_capa_get)(const struct lu_env *env,
 452                                         struct dt_object *dt,
 453                                         struct lustre_capa *old,
 454                                         __u64 opc);
 455         int (*do_object_sync)(const struct lu_env *, struct dt_object *);
 456         /**
 457          * Get object info of next level. Currently, only get inode from osd.
 458          * This is only used by quota b=16542
 459          * precondition: dt_object_exists(dt);
 460          */
 461         int (*do_data_get)(const struct lu_env *env, struct dt_object *dt,
 462                            void **data);
 463
 464         /**
 465          * Lock object.
 466          */
 467         int (*do_object_lock)(const struct lu_env *env, struct dt_object *dt,
 468                               struct lustre_handle *lh,
 469                               struct ldlm_enqueue_info *einfo,
 470                               void *policy);
 471 };
 472
 473 /**
 474  * Per-dt-object operations on "file body".
 475  */
 476 struct dt_body_operations {
 477         /**
 478          * precondition: dt_object_exists(dt);
 479          */
 480         ssize_t (*dbo_read)(const struct lu_env *env, struct dt_object *dt,
 481                             struct lu_buf *buf, loff_t *pos,
 482                             struct lustre_capa *capa);
 483         /**
 484          * precondition: dt_object_exists(dt);
 485          */
 486         ssize_t (*dbo_declare_write)(const struct lu_env *env,
 487                                      struct dt_object *dt,
 488                                      const loff_t size, loff_t pos,
 489                                      struct thandle *handle);
 490         ssize_t (*dbo_write)(const struct lu_env *env, struct dt_object *dt,
 491                              const struct lu_buf *buf, loff_t *pos,
 492                              struct thandle *handle, struct lustre_capa *capa,
 493                              int ignore_quota);
 494         /*
 495          * methods for zero-copy IO
 496          */
 497
 498         /*
 499          * precondition: dt_object_exists(dt);
 500          * returns:
 501          * < 0 - error code
 502          * = 0 - illegal
 503          * > 0 - number of local buffers prepared
 504          */
 505         int (*dbo_bufs_get)(const struct lu_env *env, struct dt_object *dt,
 506                             loff_t pos, ssize_t len, struct niobuf_local *lb,
 507                             int rw, struct lustre_capa *capa);
 508         /*
 509          * precondition: dt_object_exists(dt);
 510          */
 511         int (*dbo_bufs_put)(const struct lu_env *env, struct dt_object *dt,
 512                             struct niobuf_local *lb, int nr);
 513         /*
 514          * precondition: dt_object_exists(dt);
 515          */
 516         int (*dbo_write_prep)(const struct lu_env *env, struct dt_object *dt,
 517                               struct niobuf_local *lb, int nr);
 518         /*
 519          * precondition: dt_object_exists(dt);
 520          */
 521         int (*dbo_declare_write_commit)(const struct lu_env *env,
 522                                         struct dt_object *dt,
 523                                         struct niobuf_local *,
 524                                         int, struct thandle *);
 525         /*
 526          * precondition: dt_object_exists(dt);
 527          */
 528         int (*dbo_write_commit)(const struct lu_env *env, struct dt_object *dt,
 529                                 struct niobuf_local *, int, struct thandle *);
 530         /*
 531          * precondition: dt_object_exists(dt);
 532          */
 533         int (*dbo_read_prep)(const struct lu_env *env, struct dt_object *dt,
 534                              struct niobuf_local *lnb, int nr);
 535         int (*dbo_fiemap_get)(const struct lu_env *env, struct dt_object *dt,
 536                               struct ll_user_fiemap *fm);
 537         /**
 538          * Punch object's content
 539          * precondition: regular object, not index
 540          */
 541         int   (*dbo_declare_punch)(const struct lu_env *, struct dt_object *,
 542                                   __u64, __u64, struct thandle *th);
 543         int   (*dbo_punch)(const struct lu_env *env, struct dt_object *dt,
 544                           __u64 start, __u64 end, struct thandle *th,
 545                           struct lustre_capa *capa);
 546 };
 547
 548 /**
 549  * Incomplete type of index record.
 550  */
 551 struct dt_rec;
 552
 553 /**
 554  * Incomplete type of index key.
 555  */
 556 struct dt_key;
 557
 558 /**
 559  * Incomplete type of dt iterator.
 560  */
 561 struct dt_it;
 562
 563 /**
 564  * Per-dt-object operations on object as index.
 565  */
 566 struct dt_index_operations {
 567         /**
 568          * precondition: dt_object_exists(dt);
 569          */
 570         int (*dio_lookup)(const struct lu_env *env, struct dt_object *dt,
 571                           struct dt_rec *rec, const struct dt_key *key,
 572                           struct lustre_capa *capa);
 573         /**
 574          * precondition: dt_object_exists(dt);
 575          */
 576         int (*dio_declare_insert)(const struct lu_env *env,
 577                                   struct dt_object *dt,
 578                                   const struct dt_rec *rec,
 579                                   const struct dt_key *key,
 580                                   struct thandle *handle);
 581         int (*dio_insert)(const struct lu_env *env, struct dt_object *dt,
 582                           const struct dt_rec *rec, const struct dt_key *key,
 583                           struct thandle *handle, struct lustre_capa *capa,
 584                           int ignore_quota);
 585         /**
 586          * precondition: dt_object_exists(dt);
 587          */
 588         int (*dio_declare_delete)(const struct lu_env *env,
 589                                   struct dt_object *dt,
 590                                   const struct dt_key *key,
 591                                   struct thandle *handle);
 592         int (*dio_delete)(const struct lu_env *env, struct dt_object *dt,
 593                           const struct dt_key *key, struct thandle *handle,
 594                           struct lustre_capa *capa);
 595         /**
 596          * Iterator interface
 597          */
 598         struct dt_it_ops {
 599                 /**
 600                  * Allocate and initialize new iterator.
 601                  *
 602                  * precondition: dt_object_exists(dt);
 603                  */
 604                 struct dt_it *(*init)(const struct lu_env *env,
 605                                       struct dt_object *dt,
 606                                       __u32 attr,
 607                                       struct lustre_capa *capa);
 608                 void          (*fini)(const struct lu_env *env,
 609                                       struct dt_it *di);
 610                 int            (*get)(const struct lu_env *env,
 611                                       struct dt_it *di,
 612                                       const struct dt_key *key);
 613                 void           (*put)(const struct lu_env *env,
 614                                       struct dt_it *di);
 615                 int           (*next)(const struct lu_env *env,
 616                                       struct dt_it *di);
 617                 struct dt_key *(*key)(const struct lu_env *env,
 618                                       const struct dt_it *di);
 619                 int       (*key_size)(const struct lu_env *env,
 620                                       const struct dt_it *di);
 621                 int            (*rec)(const struct lu_env *env,
 622                                       const struct dt_it *di,
 623                                       struct dt_rec *rec,
 624                                       __u32 attr);
 625                 __u64        (*store)(const struct lu_env *env,
 626                                       const struct dt_it *di);
 627                 int           (*load)(const struct lu_env *env,
 628                                       const struct dt_it *di, __u64 hash);
 629                 int        (*key_rec)(const struct lu_env *env,
 630                                       const struct dt_it *di, void* key_rec);
 631         } dio_it;
 632 };
 633
 634 enum dt_otable_it_valid {
 635         DOIV_ERROR_HANDLE       = 0x0001,
 636         DOIV_DRYRUN             = 0x0002,
 637 };
 638
 639 enum dt_otable_it_flags {
 640         /* Exit when fail. */
 641         DOIF_FAILOUT    = 0x0001,
 642
 643         /* Reset iteration position to the device beginning. */
 644         DOIF_RESET      = 0x0002,
 645
 646         /* There is up layer component uses the iteration. */
 647         DOIF_OUTUSED    = 0x0004,
 648
 649         /* Check only without repairing. */
 650         DOIF_DRYRUN     = 0x0008,
 651 };
 652
 653 /* otable based iteration needs to use the common DT interation APIs.
 654  * To initialize the iteration, it needs call dio_it::init() firstly.
 655  * Here is how the otable based iteration should prepare arguments to
 656  * call dt_it_ops::init().
 657  *
 658  * For otable based iteration, the 32-bits 'attr' for dt_it_ops::init()
 659  * is composed of two parts:
 660  * low 16-bits is for valid bits, high 16-bits is for flags bits. */
 661 #define DT_OTABLE_IT_FLAGS_SHIFT        16
 662 #define DT_OTABLE_IT_FLAGS_MASK         0xffff0000
 663
 664 struct dt_device {
 665         struct lu_device                   dd_lu_dev;
 666         const struct dt_device_operations *dd_ops;
 667
 668         /**
 669          * List of dt_txn_callback (see below). This is not protected in any
 670          * way, because callbacks are supposed to be added/deleted only during
 671          * single-threaded start-up shut-down procedures.
 672          */
 673         cfs_list_t                         dd_txn_callbacks;
 674 };
 675
 676 int  dt_device_init(struct dt_device *dev, struct lu_device_type *t);
 677 void dt_device_fini(struct dt_device *dev);
 678
 679 static inline int lu_device_is_dt(const struct lu_device *d)
 680 {
 681         return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_DT);
 682 }
 683
 684 static inline struct dt_device * lu2dt_dev(struct lu_device *l)
 685 {
 686         LASSERT(lu_device_is_dt(l));
 687         return container_of0(l, struct dt_device, dd_lu_dev);
 688 }
 689
 690 struct dt_object {
 691         struct lu_object                   do_lu;
 692         const struct dt_object_operations *do_ops;
 693         const struct dt_body_operations   *do_body_ops;
 694         const struct dt_index_operations  *do_index_ops;
 695 };
 696
 697 /*
 698  * In-core representation of per-device local object OID storage
 699  */
 700 struct local_oid_storage {
 701         /* all initialized llog systems on this node linked by this */
 702         cfs_list_t        los_list;
 703
 704         /* how many handle's reference this los has */
 705         atomic_t          los_refcount;
 706         struct dt_device *los_dev;
 707         struct dt_object *los_obj;
 708
 709         /* data used to generate new fids */
 710         struct mutex      los_id_lock;
 711         __u64             los_seq;
 712         __u32             los_last_oid;
 713 };
 714
 715 static inline struct lu_device *dt2lu_dev(struct dt_device *d)
 716 {
 717         return &d->dd_lu_dev;
 718 }
 719
 720 static inline struct dt_object *lu2dt(struct lu_object *l)
 721 {
 722         LASSERT(l == NULL || IS_ERR(l) || lu_device_is_dt(l->lo_dev));
 723         return container_of0(l, struct dt_object, do_lu);
 724 }
 725
 726 int  dt_object_init(struct dt_object *obj,
 727                     struct lu_object_header *h, struct lu_device *d);
 728
 729 void dt_object_fini(struct dt_object *obj);
 730
 731 static inline int dt_object_exists(const struct dt_object *dt)
 732 {
 733         return lu_object_exists(&dt->do_lu);
 734 }
 735
 736 static inline int dt_object_remote(const struct dt_object *dt)
 737 {
 738         return lu_object_remote(&dt->do_lu);
 739 }
 740
 741 static inline struct dt_object *lu2dt_obj(struct lu_object *o)
 742 {
 743         LASSERT(ergo(o != NULL, lu_device_is_dt(o->lo_dev)));
 744         return container_of0(o, struct dt_object, do_lu);
 745 }
 746
 747 struct thandle_update {
 748         /* In DNE, one transaction can be disassembled into
 749          * updates on several different MDTs, and these updates
 750          * will be attached to tu_remote_update_list per target.
 751          * Only single thread will access the list, no need lock
 752          */
 753         struct list_head        tu_remote_update_list;
 754
 755         /* sent after or before local transaction */
 756         unsigned int            tu_sent_after_local_trans:1,
 757                                 tu_only_remote_trans:1;
 758 };
 759
 760 /**
 761  * This is the general purpose transaction handle.
 762  * 1. Transaction Life Cycle
 763  *      This transaction handle is allocated upon starting a new transaction,
 764  *      and deallocated after this transaction is committed.
 765  * 2. Transaction Nesting
 766  *      We do _NOT_ support nested transaction. So, every thread should only
 767  *      have one active transaction, and a transaction only belongs to one
 768  *      thread. Due to this, transaction handle need no reference count.
 769  * 3. Transaction & dt_object locking
 770  *      dt_object locks should be taken inside transaction.
 771  * 4. Transaction & RPC
 772  *      No RPC request should be issued inside transaction.
 773  */
 774 struct thandle {
 775         /** the dt device on which the transactions are executed */
 776         struct dt_device *th_dev;
 777
 778         atomic_t        th_refc;
 779         /* the size of transaction */
 780         int             th_alloc_size;
 781
 782         /** context for this transaction, tag is LCT_TX_HANDLE */
 783         struct lu_context th_ctx;
 784
 785         /** additional tags (layers can add in declare) */
 786         __u32             th_tags;
 787
 788         /** the last operation result in this transaction.
 789          * this value is used in recovery */
 790         __s32             th_result;
 791
 792         /** whether we need sync commit */
 793         unsigned int            th_sync:1;
 794
 795         /* local transation, no need to inform other layers */
 796         unsigned int            th_local:1;
 797
 798         struct thandle_update   *th_update;
 799 };
 800
 801 static inline void thandle_get(struct thandle *thandle)
 802 {
 803         atomic_inc(&thandle->th_refc);
 804 }
 805
 806 static inline void thandle_put(struct thandle *thandle)
 807 {
 808         if (atomic_dec_and_test(&thandle->th_refc)) {
 809                 if (thandle->th_update != NULL)
 810                         OBD_FREE_PTR(thandle->th_update);
 811                 OBD_FREE(thandle, thandle->th_alloc_size);
 812         }
 813 }
 814 /**
 815  * Transaction call-backs.
 816  *
 817  * These are invoked by osd (or underlying transaction engine) when
 818  * transaction changes state.
 819  *
 820  * Call-backs are used by upper layers to modify transaction parameters and to
 821  * perform some actions on for each transaction state transition. Typical
 822  * example is mdt registering call-back to write into last-received file
 823  * before each transaction commit.
 824  */
 825 struct dt_txn_callback {
 826         int (*dtc_txn_start)(const struct lu_env *env,
 827                              struct thandle *txn, void *cookie);
 828         int (*dtc_txn_stop)(const struct lu_env *env,
 829                             struct thandle *txn, void *cookie);
 830         void (*dtc_txn_commit)(struct thandle *txn, void *cookie);
 831         void                *dtc_cookie;
 832         __u32                dtc_tag;
 833         cfs_list_t           dtc_linkage;
 834 };
 835
 836 void dt_txn_callback_add(struct dt_device *dev, struct dt_txn_callback *cb);
 837 void dt_txn_callback_del(struct dt_device *dev, struct dt_txn_callback *cb);
 838
 839 int dt_txn_hook_start(const struct lu_env *env,
 840                       struct dt_device *dev, struct thandle *txn);
 841 int dt_txn_hook_stop(const struct lu_env *env, struct thandle *txn);
 842 void dt_txn_hook_commit(struct thandle *txn);
 843
 844 int dt_try_as_dir(const struct lu_env *env, struct dt_object *obj);
 845
 846 /**
 847  * Callback function used for parsing path.
 848  * \see llo_store_resolve
 849  */
 850 typedef int (*dt_entry_func_t)(const struct lu_env *env,
 851                             const char *name,
 852                             void *pvt);
 853
 854 #define DT_MAX_PATH 1024
 855
 856 int dt_path_parser(const struct lu_env *env,
 857                    char *local, dt_entry_func_t entry_func,
 858                    void *data);
 859
 860 struct dt_object *
 861 dt_store_resolve(const struct lu_env *env, struct dt_device *dt,
 862                  const char *path, struct lu_fid *fid);
 863
 864 struct dt_object *dt_store_open(const struct lu_env *env,
 865                                 struct dt_device *dt,
 866                                 const char *dirname,
 867                                 const char *filename,
 868                                 struct lu_fid *fid);
 869
 870 struct dt_object *dt_find_or_create(const struct lu_env *env,
 871                                     struct dt_device *dt,
 872                                     const struct lu_fid *fid,
 873                                     struct dt_object_format *dof,
 874                                     struct lu_attr *attr);
 875
 876 struct dt_object *dt_locate_at(const struct lu_env *env,
 877                                struct dt_device *dev,
 878                                const struct lu_fid *fid,
 879                                struct lu_device *top_dev,
 880                                const struct lu_object_conf *conf);
 881
 882 static inline struct dt_object *
 883 dt_locate(const struct lu_env *env, struct dt_device *dev,
 884           const struct lu_fid *fid)
 885 {
 886         return dt_locate_at(env, dev, fid,
 887                             dev->dd_lu_dev.ld_site->ls_top_dev, NULL);
 888 }
 889
 890 int local_oid_storage_init(const struct lu_env *env, struct dt_device *dev,
 891                            const struct lu_fid *first_fid,
 892                            struct local_oid_storage **los);
 893 void local_oid_storage_fini(const struct lu_env *env,
 894                             struct local_oid_storage *los);
 895 int local_object_fid_generate(const struct lu_env *env,
 896                               struct local_oid_storage *los,
 897                               struct lu_fid *fid);
 898 int local_object_declare_create(const struct lu_env *env,
 899                                 struct local_oid_storage *los,
 900                                 struct dt_object *o,
 901                                 struct lu_attr *attr,
 902                                 struct dt_object_format *dof,
 903                                 struct thandle *th);
 904 int local_object_create(const struct lu_env *env,
 905                         struct local_oid_storage *los,
 906                         struct dt_object *o,
 907                         struct lu_attr *attr, struct dt_object_format *dof,
 908                         struct thandle *th);
 909 struct dt_object *local_file_find_or_create(const struct lu_env *env,
 910                                             struct local_oid_storage *los,
 911                                             struct dt_object *parent,
 912                                             const char *name, __u32 mode);
 913 struct dt_object *local_file_find_or_create_with_fid(const struct lu_env *env,
 914                                                      struct dt_device *dt,
 915                                                      const struct lu_fid *fid,
 916                                                      struct dt_object *parent,
 917                                                      const char *name,
 918                                                      __u32 mode);
 919 struct dt_object *
 920 local_index_find_or_create(const struct lu_env *env,
 921                            struct local_oid_storage *los,
 922                            struct dt_object *parent,
 923                            const char *name, __u32 mode,
 924                            const struct dt_index_features *ft);
 925 struct dt_object *
 926 local_index_find_or_create_with_fid(const struct lu_env *env,
 927                                     struct dt_device *dt,
 928                                     const struct lu_fid *fid,
 929                                     struct dt_object *parent,
 930                                     const char *name, __u32 mode,
 931                                     const struct dt_index_features *ft);
 932 int local_object_unlink(const struct lu_env *env, struct dt_device *dt,
 933                         struct dt_object *parent, const char *name);
 934
 935 static inline int dt_object_lock(const struct lu_env *env,
 936                                  struct dt_object *o, struct lustre_handle *lh,
 937                                  struct ldlm_enqueue_info *einfo,
 938                                  void *policy)
 939 {
 940         LASSERT(o);
 941         LASSERT(o->do_ops);
 942         LASSERT(o->do_ops->do_object_lock);
 943         return o->do_ops->do_object_lock(env, o, lh, einfo, policy);
 944 }
 945
 946 int dt_lookup_dir(const struct lu_env *env, struct dt_object *dir,
 947                   const char *name, struct lu_fid *fid);
 948
 949 static inline int dt_object_sync(const struct lu_env *env,
 950                                  struct dt_object *o)
 951 {
 952         LASSERT(o);
 953         LASSERT(o->do_ops);
 954         LASSERT(o->do_ops->do_object_sync);
 955         return o->do_ops->do_object_sync(env, o);
 956 }
 957
 958 int dt_declare_version_set(const struct lu_env *env, struct dt_object *o,
 959                            struct thandle *th);
 960 void dt_version_set(const struct lu_env *env, struct dt_object *o,
 961                     dt_obj_version_t version, struct thandle *th);
 962 dt_obj_version_t dt_version_get(const struct lu_env *env, struct dt_object *o);
 963
 964
 965 int dt_read(const struct lu_env *env, struct dt_object *dt,
 966             struct lu_buf *buf, loff_t *pos);
 967 int dt_record_read(const struct lu_env *env, struct dt_object *dt,
 968                    struct lu_buf *buf, loff_t *pos);
 969 int dt_record_write(const struct lu_env *env, struct dt_object *dt,
 970                     const struct lu_buf *buf, loff_t *pos, struct thandle *th);
 971 typedef int (*dt_index_page_build_t)(const struct lu_env *env,
 972                                      union lu_page *lp, int nob,
 973                                      const struct dt_it_ops *iops,
 974                                      struct dt_it *it, __u32 attr, void *arg);
 975 int dt_index_walk(const struct lu_env *env, struct dt_object *obj,
 976                   const struct lu_rdpg *rdpg, dt_index_page_build_t filler,
 977                   void *arg);
 978 int dt_index_read(const struct lu_env *env, struct dt_device *dev,
 979                   struct idx_info *ii, const struct lu_rdpg *rdpg);
 980
 981 static inline struct thandle *dt_trans_create(const struct lu_env *env,
 982                                               struct dt_device *d)
 983 {
 984         LASSERT(d->dd_ops->dt_trans_create);
 985         return d->dd_ops->dt_trans_create(env, d);
 986 }
 987
 988 static inline int dt_trans_start(const struct lu_env *env,
 989                                  struct dt_device *d, struct thandle *th)
 990 {
 991         LASSERT(d->dd_ops->dt_trans_start);
 992         return d->dd_ops->dt_trans_start(env, d, th);
 993 }
 994
 995 /* for this transaction hooks shouldn't be called */
 996 static inline int dt_trans_start_local(const struct lu_env *env,
 997                                        struct dt_device *d, struct thandle *th)
 998 {
 999         LASSERT(d->dd_ops->dt_trans_start);
1000         th->th_local = 1;
1001         return d->dd_ops->dt_trans_start(env, d, th);
1002 }
1003
1004 static inline int dt_trans_stop(const struct lu_env *env,
1005                                 struct dt_device *d, struct thandle *th)
1006 {
1007         LASSERT(d->dd_ops->dt_trans_stop);
1008         return d->dd_ops->dt_trans_stop(env, d, th);
1009 }
1010
1011 static inline int dt_trans_cb_add(struct thandle *th,
1012                                   struct dt_txn_commit_cb *dcb)
1013 {
1014         LASSERT(th->th_dev->dd_ops->dt_trans_cb_add);
1015         dcb->dcb_magic = TRANS_COMMIT_CB_MAGIC;
1016         return th->th_dev->dd_ops->dt_trans_cb_add(th, dcb);
1017 }
1018 /** @} dt */
1019
1020
1021 static inline int dt_declare_record_write(const struct lu_env *env,
1022                                           struct dt_object *dt,
1023                                           int size, loff_t pos,
1024                                           struct thandle *th)
1025 {
1026         int rc;
1027
1028         LASSERTF(dt != NULL, "dt is NULL when we want to write record\n");
1029         LASSERT(th != NULL);
1030         LASSERT(dt->do_body_ops);
1031         LASSERT(dt->do_body_ops->dbo_declare_write);
1032         rc = dt->do_body_ops->dbo_declare_write(env, dt, size, pos, th);
1033         return rc;
1034 }
1035
1036 static inline int dt_declare_create(const struct lu_env *env,
1037                                     struct dt_object *dt,
1038                                     struct lu_attr *attr,
1039                                     struct dt_allocation_hint *hint,
1040                                     struct dt_object_format *dof,
1041                                     struct thandle *th)
1042 {
1043         LASSERT(dt);
1044         LASSERT(dt->do_ops);
1045         LASSERT(dt->do_ops->do_declare_create);
1046         return dt->do_ops->do_declare_create(env, dt, attr, hint, dof, th);
1047 }
1048
1049 static inline int dt_create(const struct lu_env *env,
1050                                     struct dt_object *dt,
1051                                     struct lu_attr *attr,
1052                                     struct dt_allocation_hint *hint,
1053                                     struct dt_object_format *dof,
1054                                     struct thandle *th)
1055 {
1056         LASSERT(dt);
1057         LASSERT(dt->do_ops);
1058         LASSERT(dt->do_ops->do_create);
1059         return dt->do_ops->do_create(env, dt, attr, hint, dof, th);
1060 }
1061
1062 static inline int dt_declare_destroy(const struct lu_env *env,
1063                                      struct dt_object *dt,
1064                                      struct thandle *th)
1065 {
1066         LASSERT(dt);
1067         LASSERT(dt->do_ops);
1068         LASSERT(dt->do_ops->do_declare_destroy);
1069         return dt->do_ops->do_declare_destroy(env, dt, th);
1070 }
1071
1072 static inline int dt_destroy(const struct lu_env *env,
1073                              struct dt_object *dt,
1074                              struct thandle *th)
1075 {
1076         LASSERT(dt);
1077         LASSERT(dt->do_ops);
1078         LASSERT(dt->do_ops->do_destroy);
1079         return dt->do_ops->do_destroy(env, dt, th);
1080 }
1081
1082 static inline void dt_read_lock(const struct lu_env *env,
1083                                 struct dt_object *dt,
1084                                 unsigned role)
1085 {
1086         LASSERT(dt);
1087         LASSERT(dt->do_ops);
1088         LASSERT(dt->do_ops->do_read_lock);
1089         dt->do_ops->do_read_lock(env, dt, role);
1090 }
1091
1092 static inline void dt_write_lock(const struct lu_env *env,
1093                                 struct dt_object *dt,
1094                                 unsigned role)
1095 {
1096         LASSERT(dt);
1097         LASSERT(dt->do_ops);
1098         LASSERT(dt->do_ops->do_write_lock);
1099         dt->do_ops->do_write_lock(env, dt, role);
1100 }
1101
1102 static inline void dt_read_unlock(const struct lu_env *env,
1103                                 struct dt_object *dt)
1104 {
1105         LASSERT(dt);
1106         LASSERT(dt->do_ops);
1107         LASSERT(dt->do_ops->do_read_unlock);
1108         dt->do_ops->do_read_unlock(env, dt);
1109 }
1110
1111 static inline void dt_write_unlock(const struct lu_env *env,
1112                                 struct dt_object *dt)
1113 {
1114         LASSERT(dt);
1115         LASSERT(dt->do_ops);
1116         LASSERT(dt->do_ops->do_write_unlock);
1117         dt->do_ops->do_write_unlock(env, dt);
1118 }
1119
1120 static inline int dt_write_locked(const struct lu_env *env,
1121                                   struct dt_object *dt)
1122 {
1123         LASSERT(dt);
1124         LASSERT(dt->do_ops);
1125         LASSERT(dt->do_ops->do_write_locked);
1126         return dt->do_ops->do_write_locked(env, dt);
1127 }
1128
1129 static inline int dt_declare_attr_get(const struct lu_env *env,
1130                                       struct dt_object *dt,
1131                                       struct lustre_capa *capa)
1132 {
1133         LASSERT(dt);
1134         LASSERT(dt->do_ops);
1135         LASSERT(dt->do_ops->do_declare_attr_get);
1136         return dt->do_ops->do_declare_attr_get(env, dt, capa);
1137 }
1138
1139 static inline int dt_attr_get(const struct lu_env *env, struct dt_object *dt,
1140                               struct lu_attr *la, void *arg)
1141 {
1142         LASSERT(dt);
1143         LASSERT(dt->do_ops);
1144         LASSERT(dt->do_ops->do_attr_get);
1145         return dt->do_ops->do_attr_get(env, dt, la, arg);
1146 }
1147
1148 static inline int dt_declare_attr_set(const struct lu_env *env,
1149                                       struct dt_object *dt,
1150                                       const struct lu_attr *la,
1151                                       struct thandle *th)
1152 {
1153         LASSERT(dt);
1154         LASSERT(dt->do_ops);
1155         LASSERT(dt->do_ops->do_declare_attr_set);
1156         return dt->do_ops->do_declare_attr_set(env, dt, la, th);
1157 }
1158
1159 static inline int dt_attr_set(const struct lu_env *env, struct dt_object *dt,
1160                               const struct lu_attr *la, struct thandle *th,
1161                               struct lustre_capa *capa)
1162 {
1163         LASSERT(dt);
1164         LASSERT(dt->do_ops);
1165         LASSERT(dt->do_ops->do_attr_set);
1166         return dt->do_ops->do_attr_set(env, dt, la, th, capa);
1167 }
1168
1169 static inline int dt_declare_ref_add(const struct lu_env *env,
1170                                      struct dt_object *dt, struct thandle *th)
1171 {
1172         LASSERT(dt);
1173         LASSERT(dt->do_ops);
1174         LASSERT(dt->do_ops->do_declare_ref_add);
1175         return dt->do_ops->do_declare_ref_add(env, dt, th);
1176 }
1177
1178 static inline int dt_ref_add(const struct lu_env *env,
1179                              struct dt_object *dt, struct thandle *th)
1180 {
1181         LASSERT(dt);
1182         LASSERT(dt->do_ops);
1183         LASSERT(dt->do_ops->do_ref_add);
1184         return dt->do_ops->do_ref_add(env, dt, th);
1185 }
1186
1187 static inline int dt_declare_ref_del(const struct lu_env *env,
1188                                      struct dt_object *dt, struct thandle *th)
1189 {
1190         LASSERT(dt);
1191         LASSERT(dt->do_ops);
1192         LASSERT(dt->do_ops->do_declare_ref_del);
1193         return dt->do_ops->do_declare_ref_del(env, dt, th);
1194 }
1195
1196 static inline int dt_ref_del(const struct lu_env *env,
1197                              struct dt_object *dt, struct thandle *th)
1198 {
1199         LASSERT(dt);
1200         LASSERT(dt->do_ops);
1201         LASSERT(dt->do_ops->do_ref_del);
1202         return dt->do_ops->do_ref_del(env, dt, th);
1203 }
1204
1205 static inline struct obd_capa *dt_capa_get(const struct lu_env *env,
1206                                            struct dt_object *dt,
1207                                            struct lustre_capa *old, __u64 opc)
1208 {
1209         LASSERT(dt);
1210         LASSERT(dt->do_ops);
1211         LASSERT(dt->do_ops->do_capa_get);
1212         return dt->do_ops->do_capa_get(env, dt, old, opc);
1213 }
1214
1215 static inline int dt_bufs_get(const struct lu_env *env, struct dt_object *d,
1216                               struct niobuf_remote *rnb,
1217                               struct niobuf_local *lnb, int rw,
1218                               struct lustre_capa *capa)
1219 {
1220         LASSERT(d);
1221         LASSERT(d->do_body_ops);
1222         LASSERT(d->do_body_ops->dbo_bufs_get);
1223         return d->do_body_ops->dbo_bufs_get(env, d, rnb->offset,
1224                                             rnb->len, lnb, rw, capa);
1225 }
1226
1227 static inline int dt_bufs_put(const struct lu_env *env, struct dt_object *d,
1228                               struct niobuf_local *lnb, int n)
1229 {
1230         LASSERT(d);
1231         LASSERT(d->do_body_ops);
1232         LASSERT(d->do_body_ops->dbo_bufs_put);
1233         return d->do_body_ops->dbo_bufs_put(env, d, lnb, n);
1234 }
1235
1236 static inline int dt_write_prep(const struct lu_env *env, struct dt_object *d,
1237                                 struct niobuf_local *lnb, int n)
1238 {
1239         LASSERT(d);
1240         LASSERT(d->do_body_ops);
1241         LASSERT(d->do_body_ops->dbo_write_prep);
1242         return d->do_body_ops->dbo_write_prep(env, d, lnb, n);
1243 }
1244
1245 static inline int dt_declare_write_commit(const struct lu_env *env,
1246                                           struct dt_object *d,
1247                                           struct niobuf_local *lnb,
1248                                           int n, struct thandle *th)
1249 {
1250         LASSERTF(d != NULL, "dt is NULL when we want to declare write\n");
1251         LASSERT(th != NULL);
1252         return d->do_body_ops->dbo_declare_write_commit(env, d, lnb, n, th);
1253 }
1254
1255
1256 static inline int dt_write_commit(const struct lu_env *env,
1257                                   struct dt_object *d, struct niobuf_local *lnb,
1258                                   int n, struct thandle *th)
1259 {
1260         LASSERT(d);
1261         LASSERT(d->do_body_ops);
1262         LASSERT(d->do_body_ops->dbo_write_commit);
1263         return d->do_body_ops->dbo_write_commit(env, d, lnb, n, th);
1264 }
1265
1266 static inline int dt_read_prep(const struct lu_env *env, struct dt_object *d,
1267                                struct niobuf_local *lnb, int n)
1268 {
1269         LASSERT(d);
1270         LASSERT(d->do_body_ops);
1271         LASSERT(d->do_body_ops->dbo_read_prep);
1272         return d->do_body_ops->dbo_read_prep(env, d, lnb, n);
1273 }
1274
1275 static inline int dt_declare_punch(const struct lu_env *env,
1276                                    struct dt_object *dt, __u64 start,
1277                                    __u64 end, struct thandle *th)
1278 {
1279         LASSERT(dt);
1280         LASSERT(dt->do_body_ops);
1281         LASSERT(dt->do_body_ops->dbo_declare_punch);
1282         return dt->do_body_ops->dbo_declare_punch(env, dt, start, end, th);
1283 }
1284
1285 static inline int dt_punch(const struct lu_env *env, struct dt_object *dt,
1286                            __u64 start, __u64 end, struct thandle *th,
1287                            struct lustre_capa *capa)
1288 {
1289         LASSERT(dt);
1290         LASSERT(dt->do_body_ops);
1291         LASSERT(dt->do_body_ops->dbo_punch);
1292         return dt->do_body_ops->dbo_punch(env, dt, start, end, th, capa);
1293 }
1294
1295 static inline int dt_fiemap_get(const struct lu_env *env, struct dt_object *d,
1296                                 struct ll_user_fiemap *fm)
1297 {
1298         LASSERT(d);
1299         if (d->do_body_ops == NULL)
1300                 return -EPROTO;
1301         if (d->do_body_ops->dbo_fiemap_get == NULL)
1302                 return -EOPNOTSUPP;
1303         return d->do_body_ops->dbo_fiemap_get(env, d, fm);
1304 }
1305
1306 static inline int dt_statfs(const struct lu_env *env, struct dt_device *dev,
1307                             struct obd_statfs *osfs)
1308 {
1309         LASSERT(dev);
1310         LASSERT(dev->dd_ops);
1311         LASSERT(dev->dd_ops->dt_statfs);
1312         return dev->dd_ops->dt_statfs(env, dev, osfs);
1313 }
1314
1315 static inline int dt_root_get(const struct lu_env *env, struct dt_device *dev,
1316                               struct lu_fid *f)
1317 {
1318         LASSERT(dev);
1319         LASSERT(dev->dd_ops);
1320         LASSERT(dev->dd_ops->dt_root_get);
1321         return dev->dd_ops->dt_root_get(env, dev, f);
1322 }
1323
1324 static inline void dt_conf_get(const struct lu_env *env,
1325                                const struct dt_device *dev,
1326                                struct dt_device_param *param)
1327 {
1328         LASSERT(dev);
1329         LASSERT(dev->dd_ops);
1330         LASSERT(dev->dd_ops->dt_conf_get);
1331         return dev->dd_ops->dt_conf_get(env, dev, param);
1332 }
1333
1334 static inline int dt_sync(const struct lu_env *env, struct dt_device *dev)
1335 {
1336         LASSERT(dev);
1337         LASSERT(dev->dd_ops);
1338         LASSERT(dev->dd_ops->dt_sync);
1339         return dev->dd_ops->dt_sync(env, dev);
1340 }
1341
1342 static inline int dt_ro(const struct lu_env *env, struct dt_device *dev)
1343 {
1344         LASSERT(dev);
1345         LASSERT(dev->dd_ops);
1346         LASSERT(dev->dd_ops->dt_ro);
1347         return dev->dd_ops->dt_ro(env, dev);
1348 }
1349
1350 static inline int dt_declare_insert(const struct lu_env *env,
1351                                     struct dt_object *dt,
1352                                     const struct dt_rec *rec,
1353                                     const struct dt_key *key,
1354                                     struct thandle *th)
1355 {
1356         LASSERT(dt);
1357         LASSERT(dt->do_index_ops);
1358         LASSERT(dt->do_index_ops->dio_declare_insert);
1359         return dt->do_index_ops->dio_declare_insert(env, dt, rec, key, th);
1360 }
1361
1362 static inline int dt_insert(const struct lu_env *env,
1363                                     struct dt_object *dt,
1364                                     const struct dt_rec *rec,
1365                                     const struct dt_key *key,
1366                                     struct thandle *th,
1367                                     struct lustre_capa *capa,
1368                                     int noquota)
1369 {
1370         LASSERT(dt);
1371         LASSERT(dt->do_index_ops);
1372         LASSERT(dt->do_index_ops->dio_insert);
1373         return dt->do_index_ops->dio_insert(env, dt, rec, key, th,
1374                                             capa, noquota);
1375 }
1376
1377 static inline int dt_declare_xattr_del(const struct lu_env *env,
1378                                        struct dt_object *dt,
1379                                        const char *name,
1380                                        struct thandle *th)
1381 {
1382         LASSERT(dt);
1383         LASSERT(dt->do_ops);
1384         LASSERT(dt->do_ops->do_declare_xattr_del);
1385         return dt->do_ops->do_declare_xattr_del(env, dt, name, th);
1386 }
1387
1388 static inline int dt_xattr_del(const struct lu_env *env,
1389                                struct dt_object *dt, const char *name,
1390                                struct thandle *th,
1391                                struct lustre_capa *capa)
1392 {
1393         LASSERT(dt);
1394         LASSERT(dt->do_ops);
1395         LASSERT(dt->do_ops->do_xattr_del);
1396         return dt->do_ops->do_xattr_del(env, dt, name, th, capa);
1397 }
1398
1399 static inline int dt_declare_xattr_set(const struct lu_env *env,
1400                                       struct dt_object *dt,
1401                                       const struct lu_buf *buf,
1402                                       const char *name, int fl,
1403                                       struct thandle *th)
1404 {
1405         LASSERT(dt);
1406         LASSERT(dt->do_ops);
1407         LASSERT(dt->do_ops->do_declare_xattr_set);
1408         return dt->do_ops->do_declare_xattr_set(env, dt, buf, name, fl, th);
1409 }
1410
1411 static inline int dt_xattr_set(const struct lu_env *env,
1412                               struct dt_object *dt, const struct lu_buf *buf,
1413                               const char *name, int fl, struct thandle *th,
1414                               struct lustre_capa *capa)
1415 {
1416         LASSERT(dt);
1417         LASSERT(dt->do_ops);
1418         LASSERT(dt->do_ops->do_xattr_set);
1419         return dt->do_ops->do_xattr_set(env, dt, buf, name, fl, th, capa);
1420 }
1421
1422 static inline int dt_declare_xattr_get(const struct lu_env *env,
1423                                        struct dt_object *dt,
1424                                        struct lu_buf *buf,
1425                                        const char *name,
1426                                        struct lustre_capa *capa)
1427 {
1428         LASSERT(dt);
1429         LASSERT(dt->do_ops);
1430         LASSERT(dt->do_ops->do_declare_xattr_get);
1431         return dt->do_ops->do_declare_xattr_get(env, dt, buf, name, capa);
1432 }
1433
1434 static inline int dt_xattr_get(const struct lu_env *env,
1435                               struct dt_object *dt, struct lu_buf *buf,
1436                               const char *name, struct lustre_capa *capa)
1437 {
1438         LASSERT(dt);
1439         LASSERT(dt->do_ops);
1440         LASSERT(dt->do_ops->do_xattr_get);
1441         return dt->do_ops->do_xattr_get(env, dt, buf, name, capa);
1442 }
1443
1444 static inline int dt_xattr_list(const struct lu_env *env,
1445                                struct dt_object *dt, struct lu_buf *buf,
1446                                struct lustre_capa *capa)
1447 {
1448         LASSERT(dt);
1449         LASSERT(dt->do_ops);
1450         LASSERT(dt->do_ops->do_xattr_list);
1451         return dt->do_ops->do_xattr_list(env, dt, buf, capa);
1452 }
1453
1454 static inline int dt_declare_delete(const struct lu_env *env,
1455                                     struct dt_object *dt,
1456                                     const struct dt_key *key,
1457                                     struct thandle *th)
1458 {
1459         LASSERT(dt);
1460         LASSERT(dt->do_index_ops);
1461         LASSERT(dt->do_index_ops->dio_declare_delete);
1462         return dt->do_index_ops->dio_declare_delete(env, dt, key, th);
1463 }
1464
1465 static inline int dt_delete(const struct lu_env *env,
1466                             struct dt_object *dt,
1467                             const struct dt_key *key,
1468                             struct thandle *th,
1469                             struct lustre_capa *capa)
1470 {
1471         LASSERT(dt);
1472         LASSERT(dt->do_index_ops);
1473         LASSERT(dt->do_index_ops->dio_delete);
1474         return dt->do_index_ops->dio_delete(env, dt, key, th, capa);
1475 }
1476
1477 static inline int dt_commit_async(const struct lu_env *env,
1478                                   struct dt_device *dev)
1479 {
1480         LASSERT(dev);
1481         LASSERT(dev->dd_ops);
1482         LASSERT(dev->dd_ops->dt_commit_async);
1483         return dev->dd_ops->dt_commit_async(env, dev);
1484 }
1485
1486 static inline int dt_init_capa_ctxt(const struct lu_env *env,
1487                                     struct dt_device *dev,
1488                                     int mode, unsigned long timeout,
1489                                     __u32 alg, struct lustre_capa_key *keys)
1490 {
1491         LASSERT(dev);
1492         LASSERT(dev->dd_ops);
1493         LASSERT(dev->dd_ops->dt_init_capa_ctxt);
1494         return dev->dd_ops->dt_init_capa_ctxt(env, dev, mode,
1495                                               timeout, alg, keys);
1496 }
1497
1498 static inline int dt_lookup(const struct lu_env *env,
1499                             struct dt_object *dt,
1500                             struct dt_rec *rec,
1501                             const struct dt_key *key,
1502                             struct lustre_capa *capa)
1503 {
1504         int ret;
1505
1506         LASSERT(dt);
1507         LASSERT(dt->do_index_ops);
1508         LASSERT(dt->do_index_ops->dio_lookup);
1509
1510         ret = dt->do_index_ops->dio_lookup(env, dt, rec, key, capa);
1511         if (ret > 0)
1512                 ret = 0;
1513         else if (ret == 0)
1514                 ret = -ENOENT;
1515         return ret;
1516 }
1517
1518 #define LU221_BAD_TIME (0x80000000U + 24 * 3600)
1519
1520 struct dt_find_hint {
1521         struct lu_fid        *dfh_fid;
1522         struct dt_device     *dfh_dt;
1523         struct dt_object     *dfh_o;
1524 };
1525
1526 struct dt_thread_info {
1527         char                     dti_buf[DT_MAX_PATH];
1528         struct dt_find_hint      dti_dfh;
1529         struct lu_attr           dti_attr;
1530         struct lu_fid            dti_fid;
1531         struct dt_object_format  dti_dof;
1532         struct lustre_mdt_attrs  dti_lma;
1533         struct lu_buf            dti_lb;
1534         struct lu_object_conf    dti_conf;
1535         loff_t                   dti_off;
1536 };
1537
1538 extern struct lu_context_key dt_key;
1539
1540 static inline struct dt_thread_info *dt_info(const struct lu_env *env)
1541 {
1542         struct dt_thread_info *dti;
1543
1544         dti = lu_context_key_get(&env->le_ctx, &dt_key);
1545         LASSERT(dti);
1546         return dti;
1547 }
1548
1549 int dt_global_init(void);
1550 void dt_global_fini(void);
1551
1552 # ifdef LPROCFS
1553 #ifndef HAVE_ONLY_PROCFS_SEQ
1554 int lprocfs_dt_rd_blksize(char *page, char **start, off_t off,
1555                           int count, int *eof, void *data);
1556 int lprocfs_dt_rd_kbytestotal(char *page, char **start, off_t off,
1557                               int count, int *eof, void *data);
1558 int lprocfs_dt_rd_kbytesfree(char *page, char **start, off_t off,
1559                              int count, int *eof, void *data);
1560 int lprocfs_dt_rd_kbytesavail(char *page, char **start, off_t off,
1561                               int count, int *eof, void *data);
1562 int lprocfs_dt_rd_filestotal(char *page, char **start, off_t off,
1563                              int count, int *eof, void *data);
1564 int lprocfs_dt_rd_filesfree(char *page, char **start, off_t off,
1565                             int count, int *eof, void *data);
1566 #endif
1567 int lprocfs_dt_blksize_seq_show(struct seq_file *m, void *v);
1568 int lprocfs_dt_kbytestotal_seq_show(struct seq_file *m, void *v);
1569 int lprocfs_dt_kbytesfree_seq_show(struct seq_file *m, void *v);
1570 int lprocfs_dt_kbytesavail_seq_show(struct seq_file *m, void *v);
1571 int lprocfs_dt_filestotal_seq_show(struct seq_file *m, void *v);
1572 int lprocfs_dt_filesfree_seq_show(struct seq_file *m, void *v);
1573 # endif /* LPROCFS */
1574
1575 #endif /* __LUSTRE_DT_OBJECT_H */