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