lustre/include/dt_object.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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
  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 txn_param;
  66 struct dt_device;
  67 struct dt_object;
  68 struct dt_index_features;
  69 struct dt_quota_ctxt;
  70
  71 struct dt_device_param {
  72         unsigned           ddp_max_name_len;
  73         unsigned           ddp_max_nlink;
  74         unsigned           ddp_block_shift;
  75 };
  76
  77 /**
  78  * Basic transaction credit op
  79  */
  80 enum dt_txn_op {
  81         DTO_INDEX_INSERT,
  82         DTO_INDEX_DELETE,
  83         DTO_IDNEX_UPDATE,
  84         DTO_OBJECT_CREATE,
  85         DTO_OBJECT_DELETE,
  86         DTO_ATTR_SET_BASE,
  87         DTO_XATTR_SET,
  88         DTO_LOG_REC, /**< XXX temporary: dt layer knows nothing about llog. */
  89         DTO_WRITE_BASE,
  90         DTO_WRITE_BLOCK,
  91         DTO_ATTR_SET_CHOWN,
  92
  93         DTO_NR
  94 };
  95
  96 /**
  97  * Operations on dt device.
  98  */
  99 struct dt_device_operations {
 100         /**
 101          * Return device-wide statistics.
 102          */
 103         int   (*dt_statfs)(const struct lu_env *env,
 104                            struct dt_device *dev, struct kstatfs *sfs);
 105         /**
 106          * Start transaction, described by \a param.
 107          */
 108         struct thandle *(*dt_trans_start)(const struct lu_env *env,
 109                                           struct dt_device *dev,
 110                                           struct txn_param *param);
 111         /**
 112          * Finish previously started transaction.
 113          */
 114         void  (*dt_trans_stop)(const struct lu_env *env,
 115                                struct thandle *th);
 116         /**
 117          * Return fid of root index object.
 118          */
 119         int   (*dt_root_get)(const struct lu_env *env,
 120                              struct dt_device *dev, struct lu_fid *f);
 121         /**
 122          * Return device configuration data.
 123          */
 124         void  (*dt_conf_get)(const struct lu_env *env,
 125                              const struct dt_device *dev,
 126                              struct dt_device_param *param);
 127         /**
 128          *  handling device state, mostly for tests
 129          */
 130         int   (*dt_sync)(const struct lu_env *env, struct dt_device *dev);
 131         void  (*dt_ro)(const struct lu_env *env, struct dt_device *dev);
 132         /**
 133           * Start a transaction commit asynchronously
 134           *
 135           * \param env environment
 136           * \param dev dt_device to start commit on
 137           *
 138           * \return 0 success, negative value if error
 139           */
 140          int   (*dt_commit_async)(const struct lu_env *env,
 141                                   struct dt_device *dev);
 142         /**
 143          * Initialize capability context.
 144          */
 145         int   (*dt_init_capa_ctxt)(const struct lu_env *env,
 146                                    struct dt_device *dev,
 147                                    int mode, unsigned long timeout,
 148                                    __u32 alg, struct lustre_capa_key *keys);
 149         /**
 150          * Initialize quota context.
 151          */
 152         void (*dt_init_quota_ctxt)(const struct lu_env *env,
 153                                    struct dt_device *dev,
 154                                    struct dt_quota_ctxt *ctxt, void *data);
 155
 156         /**
 157          *  get transaction credits for given \a op.
 158          */
 159         int (*dt_credit_get)(const struct lu_env *env, struct dt_device *dev,
 160                              enum dt_txn_op);
 161 };
 162
 163 struct dt_index_features {
 164         /** required feature flags from enum dt_index_flags */
 165         __u32 dif_flags;
 166         /** minimal required key size */
 167         size_t dif_keysize_min;
 168         /** maximal required key size, 0 if no limit */
 169         size_t dif_keysize_max;
 170         /** minimal required record size */
 171         size_t dif_recsize_min;
 172         /** maximal required record size, 0 if no limit */
 173         size_t dif_recsize_max;
 174         /** pointer size for record */
 175         size_t dif_ptrsize;
 176 };
 177
 178 enum dt_index_flags {
 179         /** index supports variable sized keys */
 180         DT_IND_VARKEY = 1 << 0,
 181         /** index supports variable sized records */
 182         DT_IND_VARREC = 1 << 1,
 183         /** index can be modified */
 184         DT_IND_UPDATE = 1 << 2,
 185         /** index supports records with non-unique (duplicate) keys */
 186         DT_IND_NONUNQ = 1 << 3
 187 };
 188
 189 /**
 190  * Features, required from index to support file system directories (mapping
 191  * names to fids).
 192  */
 193 extern const struct dt_index_features dt_directory_features;
 194
 195 /**
 196  * This is a general purpose dt allocation hint.
 197  * It now contains the parent object.
 198  * It can contain any allocation hint in the future.
 199  */
 200 struct dt_allocation_hint {
 201         struct dt_object           *dah_parent;
 202         __u32                       dah_mode;
 203 };
 204
 205 /**
 206  * object type specifier.
 207  */
 208
 209 enum dt_format_type {
 210         DFT_REGULAR,
 211         DFT_DIR,
 212         /** for mknod */
 213         DFT_NODE,
 214         /** for special index */
 215         DFT_INDEX,
 216         /** for symbolic link */
 217         DFT_SYM,
 218 };
 219
 220 /**
 221  * object format specifier.
 222  */
 223 struct dt_object_format {
 224         /** type for dt object */
 225         enum dt_format_type dof_type;
 226         union {
 227                 struct dof_regular {
 228                 } dof_reg;
 229                 struct dof_dir {
 230                 } dof_dir;
 231                 struct dof_node {
 232                 } dof_node;
 233                 /**
 234                  * special index need feature as parameter to create
 235                  * special idx
 236                  */
 237                 struct dof_index {
 238                         const struct dt_index_features *di_feat;
 239                 } dof_idx;
 240         } u;
 241 };
 242
 243 enum dt_format_type dt_mode_to_dft(__u32 mode);
 244
 245 /**
 246  * Per-dt-object operations.
 247  */
 248 struct dt_object_operations {
 249         void  (*do_read_lock)(const struct lu_env *env,
 250                               struct dt_object *dt, unsigned role);
 251         void  (*do_write_lock)(const struct lu_env *env,
 252                                struct dt_object *dt, unsigned role);
 253         void  (*do_read_unlock)(const struct lu_env *env,
 254                                 struct dt_object *dt);
 255         void  (*do_write_unlock)(const struct lu_env *env,
 256                                  struct dt_object *dt);
 257         /**
 258          * Note: following ->do_{x,}attr_{set,get}() operations are very
 259          * similar to ->moo_{x,}attr_{set,get}() operations in struct
 260          * md_object_operations (see md_object.h). These operations are not in
 261          * lu_object_operations, because ->do_{x,}attr_set() versions take
 262          * transaction handle as an argument (this transaction is started by
 263          * caller). We might factor ->do_{x,}attr_get() into
 264          * lu_object_operations, but that would break existing symmetry.
 265          */
 266
 267         /**
 268          * Return standard attributes.
 269          *
 270          * precondition: lu_object_exists(&dt->do_lu);
 271          */
 272         int   (*do_attr_get)(const struct lu_env *env,
 273                              struct dt_object *dt, struct lu_attr *attr,
 274                              struct lustre_capa *capa);
 275         /**
 276          * Set standard attributes.
 277          *
 278          * precondition: dt_object_exists(dt);
 279          */
 280         int   (*do_attr_set)(const struct lu_env *env,
 281                              struct dt_object *dt,
 282                              const struct lu_attr *attr,
 283                              struct thandle *handle,
 284                              struct lustre_capa *capa);
 285         /**
 286          * Return a value of an extended attribute.
 287          *
 288          * precondition: dt_object_exists(dt);
 289          */
 290         int   (*do_xattr_get)(const struct lu_env *env, struct dt_object *dt,
 291                               struct lu_buf *buf, const char *name,
 292                               struct lustre_capa *capa);
 293         /**
 294          * Set value of an extended attribute.
 295          *
 296          * \a fl - flags from enum lu_xattr_flags
 297          *
 298          * precondition: dt_object_exists(dt);
 299          */
 300         int   (*do_xattr_set)(const struct lu_env *env,
 301                               struct dt_object *dt, const struct lu_buf *buf,
 302                               const char *name, int fl, struct thandle *handle,
 303                               struct lustre_capa *capa);
 304         /**
 305          * Delete existing extended attribute.
 306          *
 307          * precondition: dt_object_exists(dt);
 308          */
 309         int   (*do_xattr_del)(const struct lu_env *env,
 310                               struct dt_object *dt,
 311                               const char *name, struct thandle *handle,
 312                               struct lustre_capa *capa);
 313         /**
 314          * Place list of existing extended attributes into \a buf (which has
 315          * length len).
 316          *
 317          * precondition: dt_object_exists(dt);
 318          */
 319         int   (*do_xattr_list)(const struct lu_env *env,
 320                                struct dt_object *dt, struct lu_buf *buf,
 321                                struct lustre_capa *capa);
 322         /**
 323          * Init allocation hint using parent object and child mode.
 324          * (1) The \a parent might be NULL if this is a partial creation for
 325          *     remote object.
 326          * (2) The type of child is in \a child_mode.
 327          * (3) The result hint is stored in \a ah;
 328          */
 329         void  (*do_ah_init)(const struct lu_env *env,
 330                             struct dt_allocation_hint *ah,
 331                             struct dt_object *parent,
 332                             umode_t child_mode);
 333         /**
 334          * Create new object on this device.
 335          *
 336          * precondition: !dt_object_exists(dt);
 337          * postcondition: ergo(result == 0, dt_object_exists(dt));
 338          */
 339         int   (*do_create)(const struct lu_env *env, struct dt_object *dt,
 340                            struct lu_attr *attr,
 341                            struct dt_allocation_hint *hint,
 342                            struct dt_object_format *dof,
 343                            struct thandle *th);
 344
 345         /**
 346          * Announce that this object is going to be used as an index. This
 347          * operation check that object supports indexing operations and
 348          * installs appropriate dt_index_operations vector on success.
 349          *
 350          * Also probes for features. Operation is successful if all required
 351          * features are supported.
 352          */
 353         int   (*do_index_try)(const struct lu_env *env,
 354                               struct dt_object *dt,
 355                               const struct dt_index_features *feat);
 356         /**
 357          * Add nlink of the object
 358          * precondition: dt_object_exists(dt);
 359          */
 360         void  (*do_ref_add)(const struct lu_env *env,
 361                             struct dt_object *dt, struct thandle *th);
 362         /**
 363          * Del nlink of the object
 364          * precondition: dt_object_exists(dt);
 365          */
 366         void  (*do_ref_del)(const struct lu_env *env,
 367                             struct dt_object *dt, struct thandle *th);
 368
 369         struct obd_capa *(*do_capa_get)(const struct lu_env *env,
 370                                         struct dt_object *dt,
 371                                         struct lustre_capa *old,
 372                                         __u64 opc);
 373         int (*do_object_sync)(const struct lu_env *, struct dt_object *);
 374 };
 375
 376 /**
 377  * Per-dt-object operations on "file body".
 378  */
 379 struct dt_body_operations {
 380         /**
 381          * precondition: dt_object_exists(dt);
 382          */
 383         ssize_t (*dbo_read)(const struct lu_env *env, struct dt_object *dt,
 384                             struct lu_buf *buf, loff_t *pos,
 385                             struct lustre_capa *capa);
 386         /**
 387          * precondition: dt_object_exists(dt);
 388          */
 389         ssize_t (*dbo_write)(const struct lu_env *env, struct dt_object *dt,
 390                              const struct lu_buf *buf, loff_t *pos,
 391                              struct thandle *handle, struct lustre_capa *capa,
 392                              int ignore_quota);
 393 };
 394
 395 /**
 396  * Incomplete type of index record.
 397  */
 398 struct dt_rec;
 399
 400 /**
 401  * Incomplete type of index key.
 402  */
 403 struct dt_key;
 404
 405 /**
 406  * Incomplete type of dt iterator.
 407  */
 408 struct dt_it;
 409
 410 /**
 411  * Per-dt-object operations on object as index.
 412  */
 413 struct dt_index_operations {
 414         /**
 415          * precondition: dt_object_exists(dt);
 416          */
 417         int (*dio_lookup)(const struct lu_env *env, struct dt_object *dt,
 418                           struct dt_rec *rec, const struct dt_key *key,
 419                           struct lustre_capa *capa);
 420         /**
 421          * precondition: dt_object_exists(dt);
 422          */
 423         int (*dio_insert)(const struct lu_env *env, struct dt_object *dt,
 424                           const struct dt_rec *rec, const struct dt_key *key,
 425                           struct thandle *handle, struct lustre_capa *capa,
 426                           int ignore_quota);
 427         /**
 428          * precondition: dt_object_exists(dt);
 429          */
 430         int (*dio_delete)(const struct lu_env *env, struct dt_object *dt,
 431                           const struct dt_key *key, struct thandle *handle,
 432                           struct lustre_capa *capa);
 433         /**
 434          * Iterator interface
 435          */
 436         struct dt_it_ops {
 437                 /**
 438                  * Allocate and initialize new iterator.
 439                  *
 440                  * precondition: dt_object_exists(dt);
 441                  */
 442                 struct dt_it *(*init)(const struct lu_env *env,
 443                                       struct dt_object *dt,
 444                                       struct lustre_capa *capa);
 445                 void          (*fini)(const struct lu_env *env,
 446                                       struct dt_it *di);
 447                 int            (*get)(const struct lu_env *env,
 448                                       struct dt_it *di,
 449                                       const struct dt_key *key);
 450                 void           (*put)(const struct lu_env *env,
 451                                       struct dt_it *di);
 452                 int           (*next)(const struct lu_env *env,
 453                                       struct dt_it *di);
 454                 struct dt_key *(*key)(const struct lu_env *env,
 455                                       const struct dt_it *di);
 456                 int       (*key_size)(const struct lu_env *env,
 457                                       const struct dt_it *di);
 458                 struct dt_rec *(*rec)(const struct lu_env *env,
 459                                       const struct dt_it *di);
 460                 __u64        (*store)(const struct lu_env *env,
 461                                       const struct dt_it *di);
 462                 int           (*load)(const struct lu_env *env,
 463                                       const struct dt_it *di, __u64 hash);
 464         } dio_it;
 465 };
 466
 467 struct dt_device {
 468         struct lu_device                   dd_lu_dev;
 469         const struct dt_device_operations *dd_ops;
 470
 471         /**
 472          * List of dt_txn_callback (see below). This is not protected in any
 473          * way, because callbacks are supposed to be added/deleted only during
 474          * single-threaded start-up shut-down procedures.
 475          */
 476         struct list_head                   dd_txn_callbacks;
 477 };
 478
 479 int  dt_device_init(struct dt_device *dev, struct lu_device_type *t);
 480 void dt_device_fini(struct dt_device *dev);
 481
 482 static inline int lu_device_is_dt(const struct lu_device *d)
 483 {
 484         return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_DT);
 485 }
 486
 487 static inline struct dt_device * lu2dt_dev(struct lu_device *l)
 488 {
 489         LASSERT(lu_device_is_dt(l));
 490         return container_of0(l, struct dt_device, dd_lu_dev);
 491 }
 492
 493 struct dt_object {
 494         struct lu_object                   do_lu;
 495         const struct dt_object_operations *do_ops;
 496         const struct dt_body_operations   *do_body_ops;
 497         const struct dt_index_operations  *do_index_ops;
 498 };
 499
 500 int  dt_object_init(struct dt_object *obj,
 501                     struct lu_object_header *h, struct lu_device *d);
 502
 503 void dt_object_fini(struct dt_object *obj);
 504
 505 static inline int dt_object_exists(const struct dt_object *dt)
 506 {
 507         return lu_object_exists(&dt->do_lu);
 508 }
 509
 510 struct txn_param {
 511         /** number of blocks this transaction will modify */
 512         unsigned int tp_credits;
 513         /** sync transaction is needed */
 514         __u32        tp_sync:1;
 515 };
 516
 517 static inline void txn_param_init(struct txn_param *p, unsigned int credits)
 518 {
 519         memset(p, 0, sizeof(*p));
 520         p->tp_credits = credits;
 521 }
 522
 523 /**
 524  * This is the general purpose transaction handle.
 525  * 1. Transaction Life Cycle
 526  *      This transaction handle is allocated upon starting a new transaction,
 527  *      and deallocated after this transaction is committed.
 528  * 2. Transaction Nesting
 529  *      We do _NOT_ support nested transaction. So, every thread should only
 530  *      have one active transaction, and a transaction only belongs to one
 531  *      thread. Due to this, transaction handle need no reference count.
 532  * 3. Transaction & dt_object locking
 533  *      dt_object locks should be taken inside transaction.
 534  * 4. Transaction & RPC
 535  *      No RPC request should be issued inside transaction.
 536  */
 537 struct thandle {
 538         /** the dt device on which the transactions are executed */
 539         struct dt_device *th_dev;
 540
 541         /** context for this transaction, tag is LCT_TX_HANDLE */
 542         struct lu_context th_ctx;
 543
 544         /** the last operation result in this transaction.
 545          * this value is used in recovery */
 546         __s32             th_result;
 547 };
 548
 549 /**
 550  * Transaction call-backs.
 551  *
 552  * These are invoked by osd (or underlying transaction engine) when
 553  * transaction changes state.
 554  *
 555  * Call-backs are used by upper layers to modify transaction parameters and to
 556  * perform some actions on for each transaction state transition. Typical
 557  * example is mdt registering call-back to write into last-received file
 558  * before each transaction commit.
 559  */
 560 struct dt_txn_callback {
 561         int (*dtc_txn_start)(const struct lu_env *env,
 562                              struct txn_param *param, void *cookie);
 563         int (*dtc_txn_stop)(const struct lu_env *env,
 564                             struct thandle *txn, void *cookie);
 565         int (*dtc_txn_commit)(const struct lu_env *env,
 566                               struct thandle *txn, void *cookie);
 567         void            *dtc_cookie;
 568         struct list_head dtc_linkage;
 569 };
 570
 571 void dt_txn_callback_add(struct dt_device *dev, struct dt_txn_callback *cb);
 572 void dt_txn_callback_del(struct dt_device *dev, struct dt_txn_callback *cb);
 573
 574 int dt_txn_hook_start(const struct lu_env *env,
 575                       struct dt_device *dev, struct txn_param *param);
 576 int dt_txn_hook_stop(const struct lu_env *env, struct thandle *txn);
 577 int dt_txn_hook_commit(const struct lu_env *env, struct thandle *txn);
 578
 579 int dt_try_as_dir(const struct lu_env *env, struct dt_object *obj);
 580
 581 /**
 582  * Callback function used for parsing path.
 583  * \see llo_store_resolve
 584  */
 585 typedef int (*dt_entry_func_t)(const struct lu_env *env,
 586                             const char *name,
 587                             void *pvt);
 588
 589 #define DT_MAX_PATH 1024
 590
 591 int dt_path_parser(const struct lu_env *env,
 592                    char *local, dt_entry_func_t entry_func,
 593                    void *data);
 594
 595 struct dt_object *dt_store_open(const struct lu_env *env,
 596                                 struct dt_device *dt,
 597                                 const char *dirname,
 598                                 const char *filename,
 599                                 struct lu_fid *fid);
 600
 601 struct dt_object *dt_locate(const struct lu_env *env,
 602                             struct dt_device *dev,
 603                             const struct lu_fid *fid);
 604
 605 /** @} dt */
 606 #endif /* __LUSTRE_DT_OBJECT_H */