lustre/include/lu_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 (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * Copyright (c) 2011 Whamcloud, Inc.
  34  */
  35 /*
  36  * This file is part of Lustre, http://www.lustre.org/
  37  * Lustre is a trademark of Sun Microsystems, Inc.
  38  */
  39
  40 #ifndef __LUSTRE_LU_OBJECT_H
  41 #define __LUSTRE_LU_OBJECT_H
  42
  43 #include <stdarg.h>
  44
  45 /*
  46  * struct lu_fid
  47  */
  48 #include <libcfs/libcfs.h>
  49
  50 #include <lustre/lustre_idl.h>
  51
  52 #include <lu_ref.h>
  53
  54 struct seq_file;
  55 struct proc_dir_entry;
  56 struct lustre_cfg;
  57 struct lprocfs_stats;
  58
  59 /** \defgroup lu lu
  60  * lu_* data-types represent server-side entities shared by data and meta-data
  61  * stacks.
  62  *
  63  * Design goals:
  64  *
  65  * -# support for layering.
  66  *
  67  *     Server side object is split into layers, one per device in the
  68  *     corresponding device stack. Individual layer is represented by struct
  69  *     lu_object. Compound layered object --- by struct lu_object_header. Most
  70  *     interface functions take lu_object as an argument and operate on the
  71  *     whole compound object. This decision was made due to the following
  72  *     reasons:
  73  *
  74  *        - it's envisaged that lu_object will be used much more often than
  75  *        lu_object_header;
  76  *
  77  *        - we want lower (non-top) layers to be able to initiate operations
  78  *        on the whole object.
  79  *
  80  *     Generic code supports layering more complex than simple stacking, e.g.,
  81  *     it is possible that at some layer object "spawns" multiple sub-objects
  82  *     on the lower layer.
  83  *
  84  * -# fid-based identification.
  85  *
  86  *     Compound object is uniquely identified by its fid. Objects are indexed
  87  *     by their fids (hash table is used for index).
  88  *
  89  * -# caching and life-cycle management.
  90  *
  91  *     Object's life-time is controlled by reference counting. When reference
  92  *     count drops to 0, object is returned to cache. Cached objects still
  93  *     retain their identity (i.e., fid), and can be recovered from cache.
  94  *
  95  *     Objects are kept in the global LRU list, and lu_site_purge() function
  96  *     can be used to reclaim given number of unused objects from the tail of
  97  *     the LRU.
  98  *
  99  * -# avoiding recursion.
 100  *
 101  *     Generic code tries to replace recursion through layers by iterations
 102  *     where possible. Additionally to the end of reducing stack consumption,
 103  *     data, when practically possible, are allocated through lu_context_key
 104  *     interface rather than on stack.
 105  * @{
 106  */
 107
 108 struct lu_site;
 109 struct lu_object;
 110 struct lu_device;
 111 struct lu_object_header;
 112 struct lu_context;
 113 struct lu_env;
 114
 115 /**
 116  * Operations common for data and meta-data devices.
 117  */
 118 struct lu_device_operations {
 119         /**
 120          * Allocate object for the given device (without lower-layer
 121          * parts). This is called by lu_object_operations::loo_object_init()
 122          * from the parent layer, and should setup at least lu_object::lo_dev
 123          * and lu_object::lo_ops fields of resulting lu_object.
 124          *
 125          * Object creation protocol.
 126          *
 127          * Due to design goal of avoiding recursion, object creation (see
 128          * lu_object_alloc()) is somewhat involved:
 129          *
 130          *  - first, lu_device_operations::ldo_object_alloc() method of the
 131          *  top-level device in the stack is called. It should allocate top
 132          *  level object (including lu_object_header), but without any
 133          *  lower-layer sub-object(s).
 134          *
 135          *  - then lu_object_alloc() sets fid in the header of newly created
 136          *  object.
 137          *
 138          *  - then lu_object_operations::loo_object_init() is called. It has
 139          *  to allocate lower-layer object(s). To do this,
 140          *  lu_object_operations::loo_object_init() calls ldo_object_alloc()
 141          *  of the lower-layer device(s).
 142          *
 143          *  - for all new objects allocated by
 144          *  lu_object_operations::loo_object_init() (and inserted into object
 145          *  stack), lu_object_operations::loo_object_init() is called again
 146          *  repeatedly, until no new objects are created.
 147          *
 148          * \post ergo(!IS_ERR(result), result->lo_dev == d &&
 149          *                             result->lo_ops != NULL);
 150          */
 151         struct lu_object *(*ldo_object_alloc)(const struct lu_env *env,
 152                                               const struct lu_object_header *h,
 153                                               struct lu_device *d);
 154         /**
 155          * process config specific for device.
 156          */
 157         int (*ldo_process_config)(const struct lu_env *env,
 158                                   struct lu_device *, struct lustre_cfg *);
 159         int (*ldo_recovery_complete)(const struct lu_env *,
 160                                      struct lu_device *);
 161
 162         /**
 163          * initialize local objects for device. this method called after layer has
 164          * been initialized (after LCFG_SETUP stage) and before it starts serving
 165          * user requests.
 166          */
 167
 168         int (*ldo_prepare)(const struct lu_env *,
 169                            struct lu_device *parent,
 170                            struct lu_device *dev);
 171
 172 };
 173
 174 /**
 175  * For lu_object_conf flags
 176  */
 177 typedef enum {
 178         /* Currently, only used for client-side object initialization. */
 179         LOC_F_NEW = 0x1,
 180 } loc_flags_t;
 181
 182 /**
 183  * Object configuration, describing particulars of object being created. On
 184  * server this is not used, as server objects are full identified by fid. On
 185  * client configuration contains struct lustre_md.
 186  */
 187 struct lu_object_conf {
 188         /**
 189          * Some hints for obj find and alloc.
 190          */
 191         loc_flags_t     loc_flags;
 192 };
 193
 194 /**
 195  * Type of "printer" function used by lu_object_operations::loo_object_print()
 196  * method.
 197  *
 198  * Printer function is needed to provide some flexibility in (semi-)debugging
 199  * output: possible implementations: printk, CDEBUG, sysfs/seq_file
 200  */
 201 typedef int (*lu_printer_t)(const struct lu_env *env,
 202                             void *cookie, const char *format, ...)
 203         __attribute__ ((format (printf, 3, 4)));
 204
 205 /**
 206  * Operations specific for particular lu_object.
 207  */
 208 struct lu_object_operations {
 209
 210         /**
 211          * Allocate lower-layer parts of the object by calling
 212          * lu_device_operations::ldo_object_alloc() of the corresponding
 213          * underlying device.
 214          *
 215          * This method is called once for each object inserted into object
 216          * stack. It's responsibility of this method to insert lower-layer
 217          * object(s) it create into appropriate places of object stack.
 218          */
 219         int (*loo_object_init)(const struct lu_env *env,
 220                                struct lu_object *o,
 221                                const struct lu_object_conf *conf);
 222         /**
 223          * Called (in top-to-bottom order) during object allocation after all
 224          * layers were allocated and initialized. Can be used to perform
 225          * initialization depending on lower layers.
 226          */
 227         int (*loo_object_start)(const struct lu_env *env,
 228                                 struct lu_object *o);
 229         /**
 230          * Called before lu_object_operations::loo_object_free() to signal
 231          * that object is being destroyed. Dual to
 232          * lu_object_operations::loo_object_init().
 233          */
 234         void (*loo_object_delete)(const struct lu_env *env,
 235                                   struct lu_object *o);
 236         /**
 237          * Dual to lu_device_operations::ldo_object_alloc(). Called when
 238          * object is removed from memory.
 239          */
 240         void (*loo_object_free)(const struct lu_env *env,
 241                                 struct lu_object *o);
 242         /**
 243          * Called when last active reference to the object is released (and
 244          * object returns to the cache). This method is optional.
 245          */
 246         void (*loo_object_release)(const struct lu_env *env,
 247                                    struct lu_object *o);
 248         /**
 249          * Optional debugging helper. Print given object.
 250          */
 251         int (*loo_object_print)(const struct lu_env *env, void *cookie,
 252                                 lu_printer_t p, const struct lu_object *o);
 253         /**
 254          * Optional debugging method. Returns true iff method is internally
 255          * consistent.
 256          */
 257         int (*loo_object_invariant)(const struct lu_object *o);
 258 };
 259
 260 /**
 261  * Type of lu_device.
 262  */
 263 struct lu_device_type;
 264
 265 /**
 266  * Device: a layer in the server side abstraction stacking.
 267  */
 268 struct lu_device {
 269         /**
 270          * reference count. This is incremented, in particular, on each object
 271          * created at this layer.
 272          *
 273          * \todo XXX which means that atomic_t is probably too small.
 274          */
 275         cfs_atomic_t                       ld_ref;
 276         /**
 277          * Pointer to device type. Never modified once set.
 278          */
 279         struct lu_device_type       *ld_type;
 280         /**
 281          * Operation vector for this device.
 282          */
 283         const struct lu_device_operations *ld_ops;
 284         /**
 285          * Stack this device belongs to.
 286          */
 287         struct lu_site                    *ld_site;
 288         struct proc_dir_entry             *ld_proc_entry;
 289
 290         /** \todo XXX: temporary back pointer into obd. */
 291         struct obd_device                 *ld_obd;
 292         /**
 293          * A list of references to this object, for debugging.
 294          */
 295         struct lu_ref                      ld_reference;
 296 };
 297
 298 struct lu_device_type_operations;
 299
 300 /**
 301  * Tag bits for device type. They are used to distinguish certain groups of
 302  * device types.
 303  */
 304 enum lu_device_tag {
 305         /** this is meta-data device */
 306         LU_DEVICE_MD = (1 << 0),
 307         /** this is data device */
 308         LU_DEVICE_DT = (1 << 1),
 309         /** data device in the client stack */
 310         LU_DEVICE_CL = (1 << 2)
 311 };
 312
 313 /**
 314  * Type of device.
 315  */
 316 struct lu_device_type {
 317         /**
 318          * Tag bits. Taken from enum lu_device_tag. Never modified once set.
 319          */
 320         __u32                                   ldt_tags;
 321         /**
 322          * Name of this class. Unique system-wide. Never modified once set.
 323          */
 324         char                                   *ldt_name;
 325         /**
 326          * Operations for this type.
 327          */
 328         const struct lu_device_type_operations *ldt_ops;
 329         /**
 330          * \todo XXX: temporary pointer to associated obd_type.
 331          */
 332         struct obd_type                        *ldt_obd_type;
 333         /**
 334          * \todo XXX: temporary: context tags used by obd_*() calls.
 335          */
 336         __u32                                   ldt_ctx_tags;
 337         /**
 338          * Number of existing device type instances.
 339          */
 340         unsigned                                ldt_device_nr;
 341         /**
 342          * Linkage into a global list of all device types.
 343          *
 344          * \see lu_device_types.
 345          */
 346         cfs_list_t                              ldt_linkage;
 347 };
 348
 349 /**
 350  * Operations on a device type.
 351  */
 352 struct lu_device_type_operations {
 353         /**
 354          * Allocate new device.
 355          */
 356         struct lu_device *(*ldto_device_alloc)(const struct lu_env *env,
 357                                                struct lu_device_type *t,
 358                                                struct lustre_cfg *lcfg);
 359         /**
 360          * Free device. Dual to
 361          * lu_device_type_operations::ldto_device_alloc(). Returns pointer to
 362          * the next device in the stack.
 363          */
 364         struct lu_device *(*ldto_device_free)(const struct lu_env *,
 365                                               struct lu_device *);
 366
 367         /**
 368          * Initialize the devices after allocation
 369          */
 370         int  (*ldto_device_init)(const struct lu_env *env,
 371                                  struct lu_device *, const char *,
 372                                  struct lu_device *);
 373         /**
 374          * Finalize device. Dual to
 375          * lu_device_type_operations::ldto_device_init(). Returns pointer to
 376          * the next device in the stack.
 377          */
 378         struct lu_device *(*ldto_device_fini)(const struct lu_env *env,
 379                                               struct lu_device *);
 380         /**
 381          * Initialize device type. This is called on module load.
 382          */
 383         int  (*ldto_init)(struct lu_device_type *t);
 384         /**
 385          * Finalize device type. Dual to
 386          * lu_device_type_operations::ldto_init(). Called on module unload.
 387          */
 388         void (*ldto_fini)(struct lu_device_type *t);
 389         /**
 390          * Called when the first device is created.
 391          */
 392         void (*ldto_start)(struct lu_device_type *t);
 393         /**
 394          * Called when number of devices drops to 0.
 395          */
 396         void (*ldto_stop)(struct lu_device_type *t);
 397 };
 398
 399 /**
 400  * Flags for the object layers.
 401  */
 402 enum lu_object_flags {
 403         /**
 404          * this flags is set if lu_object_operations::loo_object_init() has
 405          * been called for this layer. Used by lu_object_alloc().
 406          */
 407         LU_OBJECT_ALLOCATED = (1 << 0)
 408 };
 409
 410 /**
 411  * Common object attributes.
 412  */
 413 struct lu_attr {
 414         /** size in bytes */
 415         __u64          la_size;
 416         /** modification time in seconds since Epoch */
 417         obd_time       la_mtime;
 418         /** access time in seconds since Epoch */
 419         obd_time       la_atime;
 420         /** change time in seconds since Epoch */
 421         obd_time       la_ctime;
 422         /** 512-byte blocks allocated to object */
 423         __u64          la_blocks;
 424         /** permission bits and file type */
 425         __u32          la_mode;
 426         /** owner id */
 427         __u32          la_uid;
 428         /** group id */
 429         __u32          la_gid;
 430         /** object flags */
 431         __u32          la_flags;
 432         /** number of persistent references to this object */
 433         __u32          la_nlink;
 434         /** blk bits of the object*/
 435         __u32          la_blkbits;
 436         /** blk size of the object*/
 437         __u32          la_blksize;
 438         /** real device */
 439         __u32          la_rdev;
 440         /**
 441          * valid bits
 442          *
 443          * \see enum la_valid
 444          */
 445         __u64          la_valid;
 446 };
 447
 448 /** Bit-mask of valid attributes */
 449 enum la_valid {
 450         LA_ATIME = 1 << 0,
 451         LA_MTIME = 1 << 1,
 452         LA_CTIME = 1 << 2,
 453         LA_SIZE  = 1 << 3,
 454         LA_MODE  = 1 << 4,
 455         LA_UID   = 1 << 5,
 456         LA_GID   = 1 << 6,
 457         LA_BLOCKS = 1 << 7,
 458         LA_TYPE   = 1 << 8,
 459         LA_FLAGS  = 1 << 9,
 460         LA_NLINK  = 1 << 10,
 461         LA_RDEV   = 1 << 11,
 462         LA_BLKSIZE = 1 << 12,
 463         LA_KILL_SUID = 1 << 13,
 464         LA_KILL_SGID = 1 << 14,
 465 };
 466
 467 /**
 468  * Layer in the layered object.
 469  */
 470 struct lu_object {
 471         /**
 472          * Header for this object.
 473          */
 474         struct lu_object_header           *lo_header;
 475         /**
 476          * Device for this layer.
 477          */
 478         struct lu_device                  *lo_dev;
 479         /**
 480          * Operations for this object.
 481          */
 482         const struct lu_object_operations *lo_ops;
 483         /**
 484          * Linkage into list of all layers.
 485          */
 486         cfs_list_t                         lo_linkage;
 487         /**
 488          * Depth. Top level layer depth is 0.
 489          */
 490         int                                lo_depth;
 491         /**
 492          * Flags from enum lu_object_flags.
 493          */
 494         unsigned long                      lo_flags;
 495         /**
 496          * Link to the device, for debugging.
 497          */
 498         struct lu_ref_link                *lo_dev_ref;
 499 };
 500
 501 enum lu_object_header_flags {
 502         /**
 503          * Don't keep this object in cache. Object will be destroyed as soon
 504          * as last reference to it is released. This flag cannot be cleared
 505          * once set.
 506          */
 507         LU_OBJECT_HEARD_BANSHEE = 0
 508 };
 509
 510 enum lu_object_header_attr {
 511         LOHA_EXISTS   = 1 << 0,
 512         LOHA_REMOTE   = 1 << 1,
 513         /**
 514          * UNIX file type is stored in S_IFMT bits.
 515          */
 516         LOHA_FT_START = 001 << 12, /**< S_IFIFO */
 517         LOHA_FT_END   = 017 << 12, /**< S_IFMT */
 518 };
 519
 520 /**
 521  * "Compound" object, consisting of multiple layers.
 522  *
 523  * Compound object with given fid is unique with given lu_site.
 524  *
 525  * Note, that object does *not* necessary correspond to the real object in the
 526  * persistent storage: object is an anchor for locking and method calling, so
 527  * it is created for things like not-yet-existing child created by mkdir or
 528  * create calls. lu_object_operations::loo_exists() can be used to check
 529  * whether object is backed by persistent storage entity.
 530  */
 531 struct lu_object_header {
 532         /**
 533          * Object flags from enum lu_object_header_flags. Set and checked
 534          * atomically.
 535          */
 536         unsigned long          loh_flags;
 537         /**
 538          * Object reference count. Protected by lu_site::ls_guard.
 539          */
 540         cfs_atomic_t           loh_ref;
 541         /**
 542          * Fid, uniquely identifying this object.
 543          */
 544         struct lu_fid          loh_fid;
 545         /**
 546          * Common object attributes, cached for efficiency. From enum
 547          * lu_object_header_attr.
 548          */
 549         __u32                  loh_attr;
 550         /**
 551          * Linkage into per-site hash table. Protected by lu_site::ls_guard.
 552          */
 553         cfs_hlist_node_t       loh_hash;
 554         /**
 555          * Linkage into per-site LRU list. Protected by lu_site::ls_guard.
 556          */
 557         cfs_list_t             loh_lru;
 558         /**
 559          * Linkage into list of layers. Never modified once set (except lately
 560          * during object destruction). No locking is necessary.
 561          */
 562         cfs_list_t             loh_layers;
 563         /**
 564          * A list of references to this object, for debugging.
 565          */
 566         struct lu_ref          loh_reference;
 567 };
 568
 569 struct fld;
 570
 571 struct lu_site_bkt_data {
 572         /**
 573          * number of busy object on this bucket
 574          */
 575         long                      lsb_busy;
 576         /**
 577          * LRU list, updated on each access to object. Protected by
 578          * bucket lock of lu_site::ls_obj_hash.
 579          *
 580          * "Cold" end of LRU is lu_site::ls_lru.next. Accessed object are
 581          * moved to the lu_site::ls_lru.prev (this is due to the non-existence
 582          * of list_for_each_entry_safe_reverse()).
 583          */
 584         cfs_list_t                lsb_lru;
 585         /**
 586          * Wait-queue signaled when an object in this site is ultimately
 587          * destroyed (lu_object_free()). It is used by lu_object_find() to
 588          * wait before re-trying when object in the process of destruction is
 589          * found in the hash table.
 590          *
 591          * \see htable_lookup().
 592          */
 593         cfs_waitq_t               lsb_marche_funebre;
 594 };
 595
 596 enum {
 597         LU_SS_CREATED         = 0,
 598         LU_SS_CACHE_HIT,
 599         LU_SS_CACHE_MISS,
 600         LU_SS_CACHE_RACE,
 601         LU_SS_CACHE_DEATH_RACE,
 602         LU_SS_LRU_PURGED,
 603         LU_SS_LAST_STAT
 604 };
 605
 606 /**
 607  * lu_site is a "compartment" within which objects are unique, and LRU
 608  * discipline is maintained.
 609  *
 610  * lu_site exists so that multiple layered stacks can co-exist in the same
 611  * address space.
 612  *
 613  * lu_site has the same relation to lu_device as lu_object_header to
 614  * lu_object.
 615  */
 616 struct lu_site {
 617         /**
 618          * objects hash table
 619          */
 620         cfs_hash_t               *ls_obj_hash;
 621         /**
 622          * index of bucket on hash table while purging
 623          */
 624         int                       ls_purge_start;
 625         /**
 626          * Top-level device for this stack.
 627          */
 628         struct lu_device         *ls_top_dev;
 629         /**
 630          * Linkage into global list of sites.
 631          */
 632         cfs_list_t                ls_linkage;
 633         /**
 634          * lu_site stats
 635          */
 636         struct lprocfs_stats     *ls_stats;
 637         struct lprocfs_stats     *ls_time_stats;
 638 };
 639
 640 static inline struct lu_site_bkt_data *
 641 lu_site_bkt_from_fid(struct lu_site *site, struct lu_fid *fid)
 642 {
 643         cfs_hash_bd_t bd;
 644
 645         cfs_hash_bd_get(site->ls_obj_hash, fid, &bd);
 646         return cfs_hash_bd_extra_get(site->ls_obj_hash, &bd);
 647 }
 648
 649 /** \name ctors
 650  * Constructors/destructors.
 651  * @{
 652  */
 653
 654 int  lu_site_init         (struct lu_site *s, struct lu_device *d);
 655 void lu_site_fini         (struct lu_site *s);
 656 int  lu_site_init_finish  (struct lu_site *s);
 657 void lu_stack_fini        (const struct lu_env *env, struct lu_device *top);
 658 void lu_device_get        (struct lu_device *d);
 659 void lu_device_put        (struct lu_device *d);
 660 int  lu_device_init       (struct lu_device *d, struct lu_device_type *t);
 661 void lu_device_fini       (struct lu_device *d);
 662 int  lu_object_header_init(struct lu_object_header *h);
 663 void lu_object_header_fini(struct lu_object_header *h);
 664 int  lu_object_init       (struct lu_object *o,
 665                            struct lu_object_header *h, struct lu_device *d);
 666 void lu_object_fini       (struct lu_object *o);
 667 void lu_object_add_top    (struct lu_object_header *h, struct lu_object *o);
 668 void lu_object_add        (struct lu_object *before, struct lu_object *o);
 669
 670 /**
 671  * Helpers to initialize and finalize device types.
 672  */
 673
 674 int  lu_device_type_init(struct lu_device_type *ldt);
 675 void lu_device_type_fini(struct lu_device_type *ldt);
 676 void lu_types_stop(void);
 677
 678 /** @} ctors */
 679
 680 /** \name caching
 681  * Caching and reference counting.
 682  * @{
 683  */
 684
 685 /**
 686  * Acquire additional reference to the given object. This function is used to
 687  * attain additional reference. To acquire initial reference use
 688  * lu_object_find().
 689  */
 690 static inline void lu_object_get(struct lu_object *o)
 691 {
 692         LASSERT(cfs_atomic_read(&o->lo_header->loh_ref) > 0);
 693         cfs_atomic_inc(&o->lo_header->loh_ref);
 694 }
 695
 696 /**
 697  * Return true of object will not be cached after last reference to it is
 698  * released.
 699  */
 700 static inline int lu_object_is_dying(const struct lu_object_header *h)
 701 {
 702         return cfs_test_bit(LU_OBJECT_HEARD_BANSHEE, &h->loh_flags);
 703 }
 704
 705 void lu_object_put(const struct lu_env *env, struct lu_object *o);
 706
 707 int lu_site_purge(const struct lu_env *env, struct lu_site *s, int nr);
 708
 709 void lu_site_print(const struct lu_env *env, struct lu_site *s, void *cookie,
 710                    lu_printer_t printer);
 711 struct lu_object *lu_object_find(const struct lu_env *env,
 712                                  struct lu_device *dev, const struct lu_fid *f,
 713                                  const struct lu_object_conf *conf);
 714 struct lu_object *lu_object_find_at(const struct lu_env *env,
 715                                     struct lu_device *dev,
 716                                     const struct lu_fid *f,
 717                                     const struct lu_object_conf *conf);
 718 struct lu_object *lu_object_find_slice(const struct lu_env *env,
 719                                        struct lu_device *dev,
 720                                        const struct lu_fid *f,
 721                                        const struct lu_object_conf *conf);
 722 /** @} caching */
 723
 724 /** \name helpers
 725  * Helpers.
 726  * @{
 727  */
 728
 729 /**
 730  * First (topmost) sub-object of given compound object
 731  */
 732 static inline struct lu_object *lu_object_top(struct lu_object_header *h)
 733 {
 734         LASSERT(!cfs_list_empty(&h->loh_layers));
 735         return container_of0(h->loh_layers.next, struct lu_object, lo_linkage);
 736 }
 737
 738 /**
 739  * Next sub-object in the layering
 740  */
 741 static inline struct lu_object *lu_object_next(const struct lu_object *o)
 742 {
 743         return container_of0(o->lo_linkage.next, struct lu_object, lo_linkage);
 744 }
 745
 746 /**
 747  * Pointer to the fid of this object.
 748  */
 749 static inline const struct lu_fid *lu_object_fid(const struct lu_object *o)
 750 {
 751         return &o->lo_header->loh_fid;
 752 }
 753
 754 /**
 755  * return device operations vector for this object
 756  */
 757 static const inline struct lu_device_operations *
 758 lu_object_ops(const struct lu_object *o)
 759 {
 760         return o->lo_dev->ld_ops;
 761 }
 762
 763 /**
 764  * Given a compound object, find its slice, corresponding to the device type
 765  * \a dtype.
 766  */
 767 struct lu_object *lu_object_locate(struct lu_object_header *h,
 768                                    const struct lu_device_type *dtype);
 769
 770 struct lu_cdebug_print_info {
 771         int         lpi_subsys;
 772         int         lpi_mask;
 773         const char *lpi_file;
 774         const char *lpi_fn;
 775         int         lpi_line;
 776 };
 777
 778 /**
 779  * Printer function emitting messages through libcfs_debug_msg().
 780  */
 781 int lu_cdebug_printer(const struct lu_env *env,
 782                       void *cookie, const char *format, ...);
 783
 784 #define DECLARE_LU_CDEBUG_PRINT_INFO(var, mask) \
 785         struct lu_cdebug_print_info var = {     \
 786                 .lpi_subsys = DEBUG_SUBSYSTEM,  \
 787                 .lpi_mask   = (mask),           \
 788                 .lpi_file   = __FILE__,         \
 789                 .lpi_fn     = __FUNCTION__,     \
 790                 .lpi_line   = __LINE__          \
 791         }
 792
 793 /**
 794  * Print object description followed by a user-supplied message.
 795  */
 796 #define LU_OBJECT_DEBUG(mask, env, object, format, ...)                 \
 797 do {                                                                    \
 798         static DECLARE_LU_CDEBUG_PRINT_INFO(__info, mask);              \
 799                                                                         \
 800         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
 801                 lu_object_print(env, &__info, lu_cdebug_printer, object); \
 802                 CDEBUG(mask, format , ## __VA_ARGS__);                  \
 803         }                                                               \
 804 } while (0)
 805
 806 /**
 807  * Print short object description followed by a user-supplied message.
 808  */
 809 #define LU_OBJECT_HEADER(mask, env, object, format, ...)                \
 810 do {                                                                    \
 811         static DECLARE_LU_CDEBUG_PRINT_INFO(__info, mask);              \
 812                                                                         \
 813         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
 814                 lu_object_header_print(env, &__info, lu_cdebug_printer, \
 815                                        (object)->lo_header);            \
 816                 lu_cdebug_printer(env, &__info, "\n");                  \
 817                 CDEBUG(mask, format , ## __VA_ARGS__);                  \
 818         }                                                               \
 819 } while (0)
 820
 821 void lu_object_print       (const struct lu_env *env, void *cookie,
 822                             lu_printer_t printer, const struct lu_object *o);
 823 void lu_object_header_print(const struct lu_env *env, void *cookie,
 824                             lu_printer_t printer,
 825                             const struct lu_object_header *hdr);
 826
 827 /**
 828  * Check object consistency.
 829  */
 830 int lu_object_invariant(const struct lu_object *o);
 831
 832
 833 /**
 834  * \retval  1 iff object \a o exists on stable storage,
 835  * \retval  0 iff object \a o not exists on stable storage.
 836  * \retval -1 iff object \a o is on remote server.
 837  */
 838 static inline int lu_object_exists(const struct lu_object *o)
 839 {
 840         __u32 attr;
 841
 842         attr = o->lo_header->loh_attr;
 843         if (attr & LOHA_REMOTE)
 844                 return -1;
 845         else if (attr & LOHA_EXISTS)
 846                 return +1;
 847         else
 848                 return 0;
 849 }
 850
 851 static inline int lu_object_assert_exists(const struct lu_object *o)
 852 {
 853         return lu_object_exists(o) != 0;
 854 }
 855
 856 static inline int lu_object_assert_not_exists(const struct lu_object *o)
 857 {
 858         return lu_object_exists(o) <= 0;
 859 }
 860
 861 /**
 862  * Attr of this object.
 863  */
 864 static inline __u32 lu_object_attr(const struct lu_object *o)
 865 {
 866         LASSERT(lu_object_exists(o) > 0);
 867         return o->lo_header->loh_attr;
 868 }
 869
 870 static inline struct lu_ref_link *lu_object_ref_add(struct lu_object *o,
 871                                                     const char *scope,
 872                                                     const void *source)
 873 {
 874         return lu_ref_add(&o->lo_header->loh_reference, scope, source);
 875 }
 876
 877 static inline void lu_object_ref_del(struct lu_object *o,
 878                                      const char *scope, const void *source)
 879 {
 880         lu_ref_del(&o->lo_header->loh_reference, scope, source);
 881 }
 882
 883 static inline void lu_object_ref_del_at(struct lu_object *o,
 884                                         struct lu_ref_link *link,
 885                                         const char *scope, const void *source)
 886 {
 887         lu_ref_del_at(&o->lo_header->loh_reference, link, scope, source);
 888 }
 889
 890 /** input params, should be filled out by mdt */
 891 struct lu_rdpg {
 892         /** hash */
 893         __u64                   rp_hash;
 894         /** count in bytes */
 895         unsigned int            rp_count;
 896         /** number of pages */
 897         unsigned int            rp_npages;
 898         /** requested attr */
 899         __u32                   rp_attrs;
 900         /** pointers to pages */
 901         struct page           **rp_pages;
 902 };
 903
 904 enum lu_xattr_flags {
 905         LU_XATTR_REPLACE = (1 << 0),
 906         LU_XATTR_CREATE  = (1 << 1)
 907 };
 908
 909 /** @} helpers */
 910
 911 /** \name lu_context
 912  * @{ */
 913
 914 /** For lu_context health-checks */
 915 enum lu_context_state {
 916         LCS_INITIALIZED = 1,
 917         LCS_ENTERED,
 918         LCS_LEFT,
 919         LCS_FINALIZED
 920 };
 921
 922 /**
 923  * lu_context. Execution context for lu_object methods. Currently associated
 924  * with thread.
 925  *
 926  * All lu_object methods, except device and device type methods (called during
 927  * system initialization and shutdown) are executed "within" some
 928  * lu_context. This means, that pointer to some "current" lu_context is passed
 929  * as an argument to all methods.
 930  *
 931  * All service ptlrpc threads create lu_context as part of their
 932  * initialization. It is possible to create "stand-alone" context for other
 933  * execution environments (like system calls).
 934  *
 935  * lu_object methods mainly use lu_context through lu_context_key interface
 936  * that allows each layer to associate arbitrary pieces of data with each
 937  * context (see pthread_key_create(3) for similar interface).
 938  *
 939  * On a client, lu_context is bound to a thread, see cl_env_get().
 940  *
 941  * \see lu_context_key
 942  */
 943 struct lu_context {
 944         /**
 945          * lu_context is used on the client side too. Yet we don't want to
 946          * allocate values of server-side keys for the client contexts and
 947          * vice versa.
 948          *
 949          * To achieve this, set of tags in introduced. Contexts and keys are
 950          * marked with tags. Key value are created only for context whose set
 951          * of tags has non-empty intersection with one for key. Tags are taken
 952          * from enum lu_context_tag.
 953          */
 954         __u32                  lc_tags;
 955         /**
 956          * Pointer to the home service thread. NULL for other execution
 957          * contexts.
 958          */
 959         struct ptlrpc_thread  *lc_thread;
 960         /**
 961          * Pointer to an array with key values. Internal implementation
 962          * detail.
 963          */
 964         void                 **lc_value;
 965         enum lu_context_state  lc_state;
 966         /**
 967          * Linkage into a list of all remembered contexts. Only
 968          * `non-transient' contexts, i.e., ones created for service threads
 969          * are placed here.
 970          */
 971         cfs_list_t             lc_remember;
 972         /**
 973          * Version counter used to skip calls to lu_context_refill() when no
 974          * keys were registered.
 975          */
 976         unsigned               lc_version;
 977         /**
 978          * Debugging cookie.
 979          */
 980         unsigned               lc_cookie;
 981 };
 982
 983 /**
 984  * lu_context_key interface. Similar to pthread_key.
 985  */
 986
 987 enum lu_context_tag {
 988         /**
 989          * Thread on md server
 990          */
 991         LCT_MD_THREAD = 1 << 0,
 992         /**
 993          * Thread on dt server
 994          */
 995         LCT_DT_THREAD = 1 << 1,
 996         /**
 997          * Context for transaction handle
 998          */
 999         LCT_TX_HANDLE = 1 << 2,
1000         /**
1001          * Thread on client
1002          */
1003         LCT_CL_THREAD = 1 << 3,
1004         /**
1005          * A per-request session on a server, and a per-system-call session on
1006          * a client.
1007          */
1008         LCT_SESSION   = 1 << 4,
1009
1010         /**
1011          * Set when at least one of keys, having values in this context has
1012          * non-NULL lu_context_key::lct_exit() method. This is used to
1013          * optimize lu_context_exit() call.
1014          */
1015         LCT_HAS_EXIT  = 1 << 28,
1016         /**
1017          * Don't add references for modules creating key values in that context.
1018          * This is only for contexts used internally by lu_object framework.
1019          */
1020         LCT_NOREF     = 1 << 29,
1021         /**
1022          * Key is being prepared for retiring, don't create new values for it.
1023          */
1024         LCT_QUIESCENT = 1 << 30,
1025         /**
1026          * Context should be remembered.
1027          */
1028         LCT_REMEMBER  = 1 << 31,
1029         /**
1030          * Contexts usable in cache shrinker thread.
1031          */
1032         LCT_SHRINKER  = LCT_MD_THREAD|LCT_DT_THREAD|LCT_CL_THREAD|LCT_NOREF
1033 };
1034
1035 /**
1036  * Key. Represents per-context value slot.
1037  *
1038  * Keys are usually registered when module owning the key is initialized, and
1039  * de-registered when module is unloaded. Once key is registered, all new
1040  * contexts with matching tags, will get key value. "Old" contexts, already
1041  * initialized at the time of key registration, can be forced to get key value
1042  * by calling lu_context_refill().
1043  *
1044  * Every key value is counted in lu_context_key::lct_used and acquires a
1045  * reference on an owning module. This means, that all key values have to be
1046  * destroyed before module can be unloaded. This is usually achieved by
1047  * stopping threads started by the module, that created contexts in their
1048  * entry functions. Situation is complicated by the threads shared by multiple
1049  * modules, like ptlrpcd daemon on a client. To work around this problem,
1050  * contexts, created in such threads, are `remembered' (see
1051  * LCT_REMEMBER)---i.e., added into a global list. When module is preparing
1052  * for unloading it does the following:
1053  *
1054  *     - marks its keys as `quiescent' (lu_context_tag::LCT_QUIESCENT)
1055  *       preventing new key values from being allocated in the new contexts,
1056  *       and
1057  *
1058  *     - scans a list of remembered contexts, destroying values of module
1059  *       keys, thus releasing references to the module.
1060  *
1061  * This is done by lu_context_key_quiesce(). If module is re-activated
1062  * before key has been de-registered, lu_context_key_revive() call clears
1063  * `quiescent' marker.
1064  *
1065  * lu_context code doesn't provide any internal synchronization for these
1066  * activities---it's assumed that startup (including threads start-up) and
1067  * shutdown are serialized by some external means.
1068  *
1069  * \see lu_context
1070  */
1071 struct lu_context_key {
1072         /**
1073          * Set of tags for which values of this key are to be instantiated.
1074          */
1075         __u32 lct_tags;
1076         /**
1077          * Value constructor. This is called when new value is created for a
1078          * context. Returns pointer to new value of error pointer.
1079          */
1080         void  *(*lct_init)(const struct lu_context *ctx,
1081                            struct lu_context_key *key);
1082         /**
1083          * Value destructor. Called when context with previously allocated
1084          * value of this slot is destroyed. \a data is a value that was returned
1085          * by a matching call to lu_context_key::lct_init().
1086          */
1087         void   (*lct_fini)(const struct lu_context *ctx,
1088                            struct lu_context_key *key, void *data);
1089         /**
1090          * Optional method called on lu_context_exit() for all allocated
1091          * keys. Can be used by debugging code checking that locks are
1092          * released, etc.
1093          */
1094         void   (*lct_exit)(const struct lu_context *ctx,
1095                            struct lu_context_key *key, void *data);
1096         /**
1097          * Internal implementation detail: index within lu_context::lc_value[]
1098          * reserved for this key.
1099          */
1100         int      lct_index;
1101         /**
1102          * Internal implementation detail: number of values created for this
1103          * key.
1104          */
1105         cfs_atomic_t lct_used;
1106         /**
1107          * Internal implementation detail: module for this key.
1108          */
1109         cfs_module_t *lct_owner;
1110         /**
1111          * References to this key. For debugging.
1112          */
1113         struct lu_ref  lct_reference;
1114 };
1115
1116 #define LU_KEY_INIT(mod, type)                                    \
1117         static void* mod##_key_init(const struct lu_context *ctx, \
1118                                     struct lu_context_key *key)   \
1119         {                                                         \
1120                 type *value;                                      \
1121                                                                   \
1122                 CLASSERT(CFS_PAGE_SIZE >= sizeof (*value));       \
1123                                                                   \
1124                 OBD_ALLOC_PTR(value);                             \
1125                 if (value == NULL)                                \
1126                         value = ERR_PTR(-ENOMEM);                 \
1127                                                                   \
1128                 return value;                                     \
1129         }                                                         \
1130         struct __##mod##__dummy_init {;} /* semicolon catcher */
1131
1132 #define LU_KEY_FINI(mod, type)                                              \
1133         static void mod##_key_fini(const struct lu_context *ctx,            \
1134                                     struct lu_context_key *key, void* data) \
1135         {                                                                   \
1136                 type *info = data;                                          \
1137                                                                             \
1138                 OBD_FREE_PTR(info);                                         \
1139         }                                                                   \
1140         struct __##mod##__dummy_fini {;} /* semicolon catcher */
1141
1142 #define LU_KEY_INIT_FINI(mod, type)   \
1143         LU_KEY_INIT(mod,type);        \
1144         LU_KEY_FINI(mod,type)
1145
1146 #define LU_CONTEXT_KEY_DEFINE(mod, tags)                \
1147         struct lu_context_key mod##_thread_key = {      \
1148                 .lct_tags = tags,                       \
1149                 .lct_init = mod##_key_init,             \
1150                 .lct_fini = mod##_key_fini              \
1151         }
1152
1153 #define LU_CONTEXT_KEY_INIT(key)                        \
1154 do {                                                    \
1155         (key)->lct_owner = THIS_MODULE;                 \
1156 } while (0)
1157
1158 int   lu_context_key_register(struct lu_context_key *key);
1159 void  lu_context_key_degister(struct lu_context_key *key);
1160 void *lu_context_key_get     (const struct lu_context *ctx,
1161                                const struct lu_context_key *key);
1162 void  lu_context_key_quiesce (struct lu_context_key *key);
1163 void  lu_context_key_revive  (struct lu_context_key *key);
1164
1165
1166 /*
1167  * LU_KEY_INIT_GENERIC() has to be a macro to correctly determine an
1168  * owning module.
1169  */
1170
1171 #define LU_KEY_INIT_GENERIC(mod)                                        \
1172         static void mod##_key_init_generic(struct lu_context_key *k, ...) \
1173         {                                                               \
1174                 struct lu_context_key *key = k;                         \
1175                 va_list args;                                           \
1176                                                                         \
1177                 va_start(args, k);                                      \
1178                 do {                                                    \
1179                         LU_CONTEXT_KEY_INIT(key);                       \
1180                         key = va_arg(args, struct lu_context_key *);    \
1181                 } while (key != NULL);                                  \
1182                 va_end(args);                                           \
1183         }
1184
1185 #define LU_TYPE_INIT(mod, ...)                                          \
1186         LU_KEY_INIT_GENERIC(mod)                                        \
1187         static int mod##_type_init(struct lu_device_type *t)            \
1188         {                                                               \
1189                 mod##_key_init_generic(__VA_ARGS__, NULL);              \
1190                 return lu_context_key_register_many(__VA_ARGS__, NULL); \
1191         }                                                               \
1192         struct __##mod##_dummy_type_init {;}
1193
1194 #define LU_TYPE_FINI(mod, ...)                                          \
1195         static void mod##_type_fini(struct lu_device_type *t)           \
1196         {                                                               \
1197                 lu_context_key_degister_many(__VA_ARGS__, NULL);        \
1198         }                                                               \
1199         struct __##mod##_dummy_type_fini {;}
1200
1201 #define LU_TYPE_START(mod, ...)                                 \
1202         static void mod##_type_start(struct lu_device_type *t)  \
1203         {                                                       \
1204                 lu_context_key_revive_many(__VA_ARGS__, NULL);  \
1205         }                                                       \
1206         struct __##mod##_dummy_type_start {;}
1207
1208 #define LU_TYPE_STOP(mod, ...)                                  \
1209         static void mod##_type_stop(struct lu_device_type *t)   \
1210         {                                                       \
1211                 lu_context_key_quiesce_many(__VA_ARGS__, NULL); \
1212         }                                                       \
1213         struct __##mod##_dummy_type_stop {;}
1214
1215
1216
1217 #define LU_TYPE_INIT_FINI(mod, ...)             \
1218         LU_TYPE_INIT(mod, __VA_ARGS__);         \
1219         LU_TYPE_FINI(mod, __VA_ARGS__);         \
1220         LU_TYPE_START(mod, __VA_ARGS__);        \
1221         LU_TYPE_STOP(mod, __VA_ARGS__)
1222
1223 int   lu_context_init  (struct lu_context *ctx, __u32 tags);
1224 void  lu_context_fini  (struct lu_context *ctx);
1225 void  lu_context_enter (struct lu_context *ctx);
1226 void  lu_context_exit  (struct lu_context *ctx);
1227 int   lu_context_refill(struct lu_context *ctx);
1228
1229 /*
1230  * Helper functions to operate on multiple keys. These are used by the default
1231  * device type operations, defined by LU_TYPE_INIT_FINI().
1232  */
1233
1234 int  lu_context_key_register_many(struct lu_context_key *k, ...);
1235 void lu_context_key_degister_many(struct lu_context_key *k, ...);
1236 void lu_context_key_revive_many  (struct lu_context_key *k, ...);
1237 void lu_context_key_quiesce_many (struct lu_context_key *k, ...);
1238
1239 /**
1240  * Environment.
1241  */
1242 struct lu_env {
1243         /**
1244          * "Local" context, used to store data instead of stack.
1245          */
1246         struct lu_context  le_ctx;
1247         /**
1248          * "Session" context for per-request data.
1249          */
1250         struct lu_context *le_ses;
1251 };
1252
1253 int  lu_env_init  (struct lu_env *env, __u32 tags);
1254 void lu_env_fini  (struct lu_env *env);
1255 int  lu_env_refill(struct lu_env *env);
1256
1257 /** @} lu_context */
1258
1259 /**
1260  * Output site statistical counters into a buffer. Suitable for
1261  * ll_rd_*()-style functions.
1262  */
1263 int lu_site_stats_print(const struct lu_site *s, char *page, int count);
1264
1265 /**
1266  * Common name structure to be passed around for various name related methods.
1267  */
1268 struct lu_name {
1269         const char    *ln_name;
1270         int            ln_namelen;
1271 };
1272
1273 /**
1274  * Common buffer structure to be passed around for various xattr_{s,g}et()
1275  * methods.
1276  */
1277 struct lu_buf {
1278         void   *lb_buf;
1279         ssize_t lb_len;
1280 };
1281
1282 /** null buffer */
1283 extern struct lu_buf LU_BUF_NULL;
1284
1285 #define DLUBUF "(%p %z)"
1286 #define PLUBUF(buf) (buf)->lb_buf, (buf)->lb_len
1287 /**
1288  * One-time initializers, called at obdclass module initialization, not
1289  * exported.
1290  */
1291
1292 /**
1293  * Initialization of global lu_* data.
1294  */
1295 int lu_global_init(void);
1296
1297 /**
1298  * Dual to lu_global_init().
1299  */
1300 void lu_global_fini(void);
1301
1302 enum {
1303         LU_TIME_FIND_LOOKUP,
1304         LU_TIME_FIND_ALLOC,
1305         LU_TIME_FIND_INSERT,
1306         LU_TIME_NR
1307 };
1308
1309 extern const char *lu_time_names[LU_TIME_NR];
1310
1311 struct lu_kmem_descr {
1312         cfs_mem_cache_t **ckd_cache;
1313         const char       *ckd_name;
1314         const size_t      ckd_size;
1315 };
1316
1317 int  lu_kmem_init(struct lu_kmem_descr *caches);
1318 void lu_kmem_fini(struct lu_kmem_descr *caches);
1319
1320 /** @} lu */
1321 #endif /* __LUSTRE_LU_OBJECT_H */