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