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