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