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