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          * Link to the device, for debugging.
 470          */
 471         struct lu_ref_link                *lo_dev_ref;
 472 };
 473
 474 enum lu_object_header_flags {
 475         /*
 476          * Don't keep this object in cache. Object will be destroyed as soon
 477          * as last reference to it is released. This flag cannot be cleared
 478          * once set.
 479          */
 480         LU_OBJECT_HEARD_BANSHEE = 0
 481 };
 482
 483 enum lu_object_header_attr {
 484         LOHA_EXISTS   = 1 << 0,
 485         LOHA_REMOTE   = 1 << 1,
 486         /*
 487          * UNIX file type is stored in S_IFMT bits.
 488          */
 489         LOHA_FT_START = 1 << 12, /* S_IFIFO */
 490         LOHA_FT_END   = 1 << 15, /* S_IFREG */
 491 };
 492
 493 /*
 494  * "Compound" object, consisting of multiple layers.
 495  *
 496  * Compound object with given fid is unique with given lu_site.
 497  *
 498  * Note, that object does *not* necessary correspond to the real object in the
 499  * persistent storage: object is an anchor for locking and method calling, so
 500  * it is created for things like not-yet-existing child created by mkdir or
 501  * create calls. lu_object_operations::loo_exists() can be used to check
 502  * whether object is backed by persistent storage entity.
 503  */
 504 struct lu_object_header {
 505         /**
 506          * Object flags from enum lu_object_header_flags. Set and checked
 507          * atomically.
 508          */
 509         unsigned long     loh_flags;
 510         /**
 511          * Object reference count. Protected by lu_site::ls_guard.
 512          */
 513         atomic_t          loh_ref;
 514         /**
 515          * Fid, uniquely identifying this object.
 516          */
 517         struct lu_fid     loh_fid;
 518         /**
 519          * Common object attributes, cached for efficiency. From enum
 520          * lu_object_header_attr.
 521          */
 522         __u32             loh_attr;
 523         /**
 524          * Linkage into per-site hash table. Protected by lu_site::ls_guard.
 525          */
 526         struct hlist_node loh_hash;
 527         /**
 528          * Linkage into per-site LRU list. Protected by lu_site::ls_guard.
 529          */
 530         struct list_head  loh_lru;
 531         /**
 532          * Linkage into list of layers. Never modified once set (except lately
 533          * during object destruction). No locking is necessary.
 534          */
 535         struct list_head  loh_layers;
 536         /**
 537          * A list of references to this object, for debugging.
 538          */
 539         struct lu_ref       loh_reference;
 540 };
 541
 542 struct fld;
 543
 544 /**
 545  * lu_site is a "compartment" within which objects are unique, and LRU
 546  * discipline is maintained.
 547  *
 548  * lu_site exists so that multiple layered stacks can co-exist in the same
 549  * address space.
 550  *
 551  * lu_site has the same relation to lu_device as lu_object_header to
 552  * lu_object.
 553  */
 554 struct lu_site {
 555         /**
 556          * Site-wide lock.
 557          *
 558          * lock protecting:
 559          *
 560          *        - lu_site::ls_hash hash table (and its linkages in objects);
 561          *
 562          *        - lu_site::ls_lru list (and its linkages in objects);
 563          *
 564          *        - 0/1 transitions of object lu_object_header::loh_ref
 565          *        reference count;
 566          *
 567          * yes, it's heavy.
 568          */
 569         rwlock_t              ls_guard;
 570         /**
 571          * Hash-table where objects are indexed by fid.
 572          */
 573         struct hlist_head    *ls_hash;
 574         /**
 575          * Bit-mask for hash-table size.
 576          */
 577         int                   ls_hash_mask;
 578         /**
 579          * Order of hash-table.
 580          */
 581         int                   ls_hash_bits;
 582         /**
 583          * Number of buckets in the hash-table.
 584          */
 585         int                   ls_hash_size;
 586
 587         /**
 588          * LRU list, updated on each access to object. Protected by
 589          * lu_site::ls_guard.
 590          *
 591          * "Cold" end of LRU is lu_site::ls_lru.next. Accessed object are
 592          * moved to the lu_site::ls_lru.prev (this is due to the non-existence
 593          * of list_for_each_entry_safe_reverse()).
 594          */
 595         struct list_head      ls_lru;
 596         /**
 597          * Total number of objects in this site. Protected by
 598          * lu_site::ls_guard.
 599          */
 600         unsigned              ls_total;
 601         /**
 602          * Total number of objects in this site with reference counter greater
 603          * than 0. Protected by lu_site::ls_guard.
 604          */
 605         unsigned              ls_busy;
 606
 607         /**
 608          * Top-level device for this stack.
 609          */
 610         struct lu_device     *ls_top_dev;
 611         /*
 612          * mds number of this site.
 613          */
 614         mdsno_t               ls_node_id;
 615         /*
 616          * Fid location database
 617          */
 618         struct lu_server_fld *ls_server_fld;
 619         struct lu_client_fld *ls_client_fld;
 620
 621         /*
 622          * Server Seq Manager
 623          */
 624         struct lu_server_seq *ls_server_seq;
 625
 626         /*
 627          * Controller Seq Manager
 628          */
 629         struct lu_server_seq *ls_control_seq;
 630         struct obd_export    *ls_control_exp;
 631
 632         /*
 633          * Client Seq Manager
 634          */
 635         struct lu_client_seq *ls_client_seq;
 636
 637         /* statistical counters. Protected by nothing, races are accepted. */
 638         struct {
 639                 __u32 s_created;
 640                 __u32 s_cache_hit;
 641                 __u32 s_cache_miss;
 642                 /*
 643                  * Number of hash-table entry checks made.
 644                  *
 645                  *       ->s_cache_check / (->s_cache_miss + ->s_cache_hit)
 646                  *
 647                  * is an average number of hash slots inspected during single
 648                  * lookup.
 649                  */
 650                 __u32 s_cache_check;
 651                 /** Races with cache insertions. */
 652                 __u32 s_cache_race;
 653                 /**
 654                  * Races with object destruction.
 655                  *
 656                  * \see lu_site::ls_marche_funebre.
 657                  */
 658                 __u32 s_cache_death_race;
 659                 __u32 s_lru_purged;
 660         } ls_stats;
 661
 662         /**
 663          * Linkage into global list of sites.
 664          */
 665         struct list_head      ls_linkage;
 666         struct lprocfs_stats *ls_time_stats;
 667 };
 668
 669 /** \name ctors
 670  * Constructors/destructors.
 671  * @{
 672  */
 673
 674 int  lu_site_init         (struct lu_site *s, struct lu_device *d);
 675 void lu_site_fini         (struct lu_site *s);
 676 int  lu_site_init_finish  (struct lu_site *s);
 677 void lu_stack_fini        (const struct lu_env *env, struct lu_device *top);
 678 void lu_device_get        (struct lu_device *d);
 679 void lu_device_put        (struct lu_device *d);
 680 int  lu_device_init       (struct lu_device *d, struct lu_device_type *t);
 681 void lu_device_fini       (struct lu_device *d);
 682 int lu_object_header_init(struct lu_object_header *h);
 683 void lu_object_header_fini(struct lu_object_header *h);
 684 int  lu_object_init       (struct lu_object *o,
 685                    struct lu_object_header *h, struct lu_device *d);
 686 void lu_object_fini       (struct lu_object *o);
 687 void lu_object_add_top    (struct lu_object_header *h, struct lu_object *o);
 688 void lu_object_add        (struct lu_object *before, struct lu_object *o);
 689
 690 /**
 691  * Helpers to initialize and finalize device types.
 692  */
 693
 694 int  lu_device_type_init(struct lu_device_type *ldt);
 695 void lu_device_type_fini(struct lu_device_type *ldt);
 696 void lu_types_stop(void);
 697
 698 /** @} ctors */
 699
 700 /** \name caching
 701  * Caching and reference counting.
 702  * @{
 703  */
 704
 705 /**
 706  * Acquire additional reference to the given object. This function is used to
 707  * attain additional reference. To acquire initial reference use
 708  * lu_object_find().
 709  */
 710 static inline void lu_object_get(struct lu_object *o)
 711 {
 712         LASSERT(atomic_read(&o->lo_header->loh_ref) > 0);
 713         atomic_inc(&o->lo_header->loh_ref);
 714 }
 715
 716 /**
 717  * Return true of object will not be cached after last reference to it is
 718  * released.
 719  */
 720 static inline int lu_object_is_dying(const struct lu_object_header *h)
 721 {
 722         return test_bit(LU_OBJECT_HEARD_BANSHEE, &h->loh_flags);
 723 }
 724
 725 void lu_object_put(const struct lu_env *env, struct lu_object *o);
 726
 727 int lu_site_purge(const struct lu_env *env, struct lu_site *s, int nr);
 728
 729 void lu_site_print(const struct lu_env *env, struct lu_site *s, void *cookie,
 730                    lu_printer_t printer);
 731 struct lu_object *lu_object_find(const struct lu_env *env,
 732                                  struct lu_device *dev, const struct lu_fid *f,
 733                                  const struct lu_object_conf *conf);
 734 struct lu_object *lu_object_find_at(const struct lu_env *env,
 735                                     struct lu_device *dev,
 736                                     const struct lu_fid *f,
 737                                     const struct lu_object_conf *conf);
 738 struct lu_object *lu_object_find_slice(const struct lu_env *env,
 739                                        struct lu_device *dev,
 740                                        const struct lu_fid *f,
 741                                        const struct lu_object_conf *conf);
 742 /** @} caching */
 743
 744 /** \name helpers
 745  * Helpers.
 746  * @{
 747  */
 748
 749 /**
 750  * First (topmost) sub-object of given compound object
 751  */
 752 static inline struct lu_object *lu_object_top(struct lu_object_header *h)
 753 {
 754         LASSERT(!list_empty(&h->loh_layers));
 755         return container_of0(h->loh_layers.next, struct lu_object, lo_linkage);
 756 }
 757
 758 /**
 759  * Next sub-object in the layering
 760  */
 761 static inline struct lu_object *lu_object_next(const struct lu_object *o)
 762 {
 763         return container_of0(o->lo_linkage.next, struct lu_object, lo_linkage);
 764 }
 765
 766 /**
 767  * Pointer to the fid of this object.
 768  */
 769 static inline const struct lu_fid *lu_object_fid(const struct lu_object *o)
 770 {
 771         return &o->lo_header->loh_fid;
 772 }
 773
 774 /*
 775  * return device operations vector for this object
 776  */
 777 static inline struct lu_device_operations *
 778 lu_object_ops(const struct lu_object *o)
 779 {
 780         return o->lo_dev->ld_ops;
 781 }
 782
 783 /*
 784  * Given a compound object, find its slice, corresponding to the device type
 785  * @dtype.
 786  */
 787 struct lu_object *lu_object_locate(struct lu_object_header *h,
 788                                    struct lu_device_type *dtype);
 789
 790 struct lu_cdebug_print_info {
 791         int         lpi_subsys;
 792         int         lpi_mask;
 793         const char *lpi_file;
 794         const char *lpi_fn;
 795         int         lpi_line;
 796 };
 797
 798 /*
 799  * Printer function emitting messages through libcfs_debug_msg().
 800  */
 801 int lu_cdebug_printer(const struct lu_env *env,
 802                       void *cookie, const char *format, ...);
 803
 804 #define DECLARE_LU_CDEBUG_PRINT_INFO(var, mask) \
 805         struct lu_cdebug_print_info var = {     \
 806                 .lpi_subsys = DEBUG_SUBSYSTEM,  \
 807                 .lpi_mask   = (mask),           \
 808                 .lpi_file   = __FILE__,         \
 809                 .lpi_fn     = __FUNCTION__,     \
 810                 .lpi_line   = __LINE__          \
 811         };
 812
 813 /*
 814  * Print object description followed by user-supplied message.
 815  */
 816 #define LU_OBJECT_DEBUG(mask, env, object, format, ...)                 \
 817 ({                                                                      \
 818         static DECLARE_LU_CDEBUG_PRINT_INFO(__info, mask);              \
 819                                                                         \
 820         lu_object_print(env, &__info, lu_cdebug_printer, object);       \
 821         CDEBUG(mask, format , ## __VA_ARGS__);                          \
 822 })
 823
 824 /*
 825  * Print human readable representation of the @o to the @f.
 826  */
 827 void lu_object_print(const struct lu_env *env, void *cookie,
 828                      lu_printer_t printer, const struct lu_object *o);
 829
 830 /*
 831  * Check object consistency.
 832  */
 833 int lu_object_invariant(const struct lu_object *o);
 834
 835 /*
 836  * Finalize and free devices in the device stack.
 837  */
 838 void lu_stack_fini(const struct lu_env *env, struct lu_device *top);
 839
 840 /*
 841  * Returns 1 iff object @o exists on the stable storage,
 842  * returns -1 iff object @o is on remote server.
 843  */
 844 static inline int lu_object_exists(const struct lu_object *o)
 845 {
 846         __u32 attr;
 847
 848         attr = o->lo_header->loh_attr;
 849         if (attr & LOHA_REMOTE)
 850                 return -1;
 851         else if (attr & LOHA_EXISTS)
 852                 return +1;
 853         else
 854                 return 0;
 855 }
 856
 857 static inline int lu_object_assert_exists(const struct lu_object *o)
 858 {
 859         return lu_object_exists(o) != 0;
 860 }
 861
 862 static inline int lu_object_assert_not_exists(const struct lu_object *o)
 863 {
 864         return lu_object_exists(o) <= 0;
 865 }
 866
 867 /**
 868  * Attr of this object.
 869  */
 870 static inline __u32 lu_object_attr(const struct lu_object *o)
 871 {
 872         LASSERT(lu_object_exists(o) > 0);
 873         return o->lo_header->loh_attr;
 874 }
 875
 876 static inline struct lu_ref_link *lu_object_ref_add(struct lu_object *o,
 877                                                     const char *scope,
 878                                                     const void *source)
 879 {
 880         return lu_ref_add(&o->lo_header->loh_reference, scope, source);
 881 }
 882
 883 static inline void lu_object_ref_del(struct lu_object *o,
 884                                      const char *scope, const void *source)
 885 {
 886         lu_ref_del(&o->lo_header->loh_reference, scope, source);
 887 }
 888
 889 static inline void lu_object_ref_del_at(struct lu_object *o,
 890                                         struct lu_ref_link *link,
 891                                         const char *scope, const void *source)
 892 {
 893         lu_ref_del_at(&o->lo_header->loh_reference, link, scope, source);
 894 }
 895
 896 struct lu_rdpg {
 897         /* input params, should be filled out by mdt */
 898         __u64                   rp_hash;        /* hash */
 899         int                     rp_count;       /* count in bytes       */
 900         int                     rp_npages;      /* number of pages      */
 901         struct page           **rp_pages;       /* pointers to pages    */
 902 };
 903
 904 enum lu_xattr_flags {
 905         LU_XATTR_REPLACE = (1 << 0),
 906         LU_XATTR_CREATE  = (1 << 1)
 907 };
 908
 909 /** @} helpers */
 910
 911 /** \name lu_context
 912  * @{ */
 913
 914 /** For lu_context health-checks */
 915 enum lu_context_state {
 916         LCS_INITIALIZED = 1,
 917         LCS_ENTERED,
 918         LCS_LEFT,
 919         LCS_FINALIZED
 920 };
 921
 922 /**
 923  * lu_context. Execution context for lu_object methods. Currently associated
 924  * with thread.
 925  *
 926  * All lu_object methods, except device and device type methods (called during
 927  * system initialization and shutdown) are executed "within" some
 928  * lu_context. This means, that pointer to some "current" lu_context is passed
 929  * as an argument to all methods.
 930  *
 931  * All service ptlrpc threads create lu_context as part of their
 932  * initialization. It is possible to create "stand-alone" context for other
 933  * execution environments (like system calls).
 934  *
 935  * lu_object methods mainly use lu_context through lu_context_key interface
 936  * that allows each layer to associate arbitrary pieces of data with each
 937  * context (see pthread_key_create(3) for similar interface).
 938  *
 939  * On a client, lu_context is bound to a thread, see cl_env_get().
 940  *
 941  * \see lu_context_key
 942  */
 943 struct lu_context {
 944         /**
 945          * lu_context is used on the client side too. Yet we don't want to
 946          * allocate values of server-side keys for the client contexts and
 947          * vice versa.
 948          *
 949          * To achieve this, set of tags in introduced. Contexts and keys are
 950          * marked with tags. Key value are created only for context whose set
 951          * of tags has non-empty intersection with one for key. Tags are taken
 952          * from enum lu_context_tag.
 953          */
 954         __u32                  lc_tags;
 955         /**
 956          * Pointer to the home service thread. NULL for other execution
 957          * contexts.
 958          */
 959         struct ptlrpc_thread  *lc_thread;
 960         /**
 961          * Pointer to an array with key values. Internal implementation
 962          * detail.
 963          */
 964         void                 **lc_value;
 965         enum lu_context_state  lc_state;
 966         /**
 967          * Linkage into a list of all remembered contexts. Only
 968          * `non-transient' contexts, i.e., ones created for service threads
 969          * are placed here.
 970          */
 971         struct list_head       lc_remember;
 972         /**
 973          * Version counter used to skip calls to lu_context_refill() when no
 974          * keys were registered.
 975          */
 976         unsigned               lc_version;
 977 };
 978
 979 /**
 980  * lu_context_key interface. Similar to pthread_key.
 981  */
 982
 983 enum lu_context_tag {
 984         /**
 985          * Thread on md server
 986          */
 987         LCT_MD_THREAD = 1 << 0,
 988         /**
 989          * Thread on dt server
 990          */
 991         LCT_DT_THREAD = 1 << 1,
 992         /**
 993          * Context for transaction handle
 994          */
 995         LCT_TX_HANDLE = 1 << 2,
 996         /**
 997          * Thread on client
 998          */
 999         LCT_CL_THREAD = 1 << 3,
1000         /**
1001          * A per-request session on a server, and a per-system-call session on
1002          * a client.
1003          */
1004         LCT_SESSION   = 1 << 4,
1005
1006         /**
1007          * Set when at least one of keys, having values in this context has
1008          * non-NULL lu_context_key::lct_exit() method. This is used to
1009          * optimize lu_context_exit() call.
1010          */
1011         LCT_HAS_EXIT  = 1 << 28,
1012         /**
1013          * Don't add references for modules creating key values in that context.
1014          * This is only for contexts used internally by lu_object framework.
1015          */
1016         LCT_NOREF     = 1 << 29,
1017         /**
1018          * Key is being prepared for retiring, don't create new values for it.
1019          */
1020         LCT_QUIESCENT = 1 << 30,
1021         /**
1022          * Context should be remembered.
1023          */
1024         LCT_REMEMBER  = 1 << 31,
1025         /**
1026          * Contexts usable in cache shrinker thread.
1027          */
1028         LCT_SHRINKER  = LCT_MD_THREAD|LCT_DT_THREAD|LCT_CL_THREAD|LCT_NOREF
1029 };
1030
1031 /**
1032  * Key. Represents per-context value slot.
1033  *
1034  * Keys are usually registered when module owning the key is initialized, and
1035  * de-registered when module is unloaded. Once key is registered, all new
1036  * contexts with matching tags, will get key value. "Old" contexts, already
1037  * initialized at the time of key registration, can be forced to get key value
1038  * by calling lu_context_refill().
1039  *
1040  * Every key value is counted in lu_context_key::lct_used and acquires a
1041  * reference on an owning module. This means, that all key values have to be
1042  * destroyed before module can be unloaded. This is usually achieved by
1043  * stopping threads started by the module, that created contexts in their
1044  * entry functions. Situation is complicated by the threads shared by multiple
1045  * modules, like ptlrpcd daemon on a client. To work around this problem,
1046  * contexts, created in such threads, are `remembered' (see
1047  * LCT_REMEMBER)---i.e., added into a global list. When module is preparing
1048  * for unloading it does the following:
1049  *
1050  *     - marks its keys as `quiescent' (lu_context_tag::LCT_QUIESCENT)
1051  *       preventing new key values from being allocated in the new contexts,
1052  *       and
1053  *
1054  *     - scans a list of remembered contexts, destroying values of module
1055  *       keys, thus releasing references to the module.
1056  *
1057  * This is done by lu_context_key_quiesce(). If module is re-activated
1058  * before key has been de-registered, lu_context_key_revive() call clears
1059  * `quiescent' marker.
1060  *
1061  * lu_context code doesn't provide any internal synchronization for these
1062  * activities---it's assumed that startup (including threads start-up) and
1063  * shutdown are serialized by some external means.
1064  *
1065  * \see lu_context
1066  */
1067 struct lu_context_key {
1068         /**
1069          * Set of tags for which values of this key are to be instantiated.
1070          */
1071         __u32 lct_tags;
1072         /**
1073          * Value constructor. This is called when new value is created for a
1074          * context. Returns pointer to new value of error pointer.
1075          */
1076         void  *(*lct_init)(const struct lu_context *ctx,
1077                            struct lu_context_key *key);
1078         /**
1079          * Value destructor. Called when context with previously allocated
1080          * value of this slot is destroyed. \a data is a value that was returned
1081          * by a matching call to lu_context_key::lct_init().
1082          */
1083         void   (*lct_fini)(const struct lu_context *ctx,
1084                            struct lu_context_key *key, void *data);
1085         /**
1086          * Optional method called on lu_context_exit() for all allocated
1087          * keys. Can be used by debugging code checking that locks are
1088          * released, etc.
1089          */
1090         void   (*lct_exit)(const struct lu_context *ctx,
1091                            struct lu_context_key *key, void *data);
1092         /**
1093          * Internal implementation detail: index within lu_context::lc_value[]
1094          * reserved for this key.
1095          */
1096         int      lct_index;
1097         /**
1098          * Internal implementation detail: number of values created for this
1099          * key.
1100          */
1101         atomic_t lct_used;
1102         /**
1103          * Internal implementation detail: module for this key.
1104          */
1105         struct module *lct_owner;
1106         /**
1107          * References to this key. For debugging.
1108          */
1109         struct lu_ref  lct_reference;
1110 };
1111
1112 #define LU_KEY_INIT(mod, type)                                    \
1113         static void* mod##_key_init(const struct lu_context *ctx, \
1114                                     struct lu_context_key *key)   \
1115         {                                                         \
1116                 type *value;                                      \
1117                                                                   \
1118                 CLASSERT(CFS_PAGE_SIZE >= sizeof (*value));       \
1119                                                                   \
1120                 OBD_ALLOC_PTR(value);                             \
1121                 if (value == NULL)                                \
1122                         value = ERR_PTR(-ENOMEM);                 \
1123                                                                   \
1124                 return value;                                     \
1125         }                                                         \
1126         struct __##mod##__dummy_init {;} /* semicolon catcher */
1127
1128 #define LU_KEY_FINI(mod, type)                                              \
1129         static void mod##_key_fini(const struct lu_context *ctx,            \
1130                                     struct lu_context_key *key, void* data) \
1131         {                                                                   \
1132                 type *info = data;                                          \
1133                                                                             \
1134                 OBD_FREE_PTR(info);                                         \
1135         }                                                                   \
1136         struct __##mod##__dummy_fini {;} /* semicolon catcher */
1137
1138 #define LU_KEY_INIT_FINI(mod, type)   \
1139         LU_KEY_INIT(mod,type);        \
1140         LU_KEY_FINI(mod,type)
1141
1142 #define LU_CONTEXT_KEY_DEFINE(mod, tags)                \
1143         struct lu_context_key mod##_thread_key = {      \
1144                 .lct_tags = tags,                       \
1145                 .lct_init = mod##_key_init,             \
1146                 .lct_fini = mod##_key_fini              \
1147         }
1148
1149 #define LU_CONTEXT_KEY_INIT(key)                        \
1150 do {                                                    \
1151         (key)->lct_owner = THIS_MODULE;                 \
1152 } while (0)
1153
1154 int   lu_context_key_register(struct lu_context_key *key);
1155 void  lu_context_key_degister(struct lu_context_key *key);
1156 void *lu_context_key_get     (const struct lu_context *ctx,
1157                                const struct lu_context_key *key);
1158 void  lu_context_key_quiesce (struct lu_context_key *key);
1159 void  lu_context_key_revive  (struct lu_context_key *key);
1160
1161
1162 /*
1163  * LU_KEY_INIT_GENERIC() has to be a macro to correctly determine an
1164  * owning module.
1165  */
1166
1167 #define LU_KEY_INIT_GENERIC(mod)                                        \
1168         static void mod##_key_init_generic(struct lu_context_key *k, ...) \
1169         {                                                                        \
1170                 struct lu_context_key *key = k;                         \
1171                 va_list args;                                                    \
1172                                                                                  \
1173                 va_start(args, k);                                               \
1174                 do {                                                             \
1175                         LU_CONTEXT_KEY_INIT(key);                                \
1176                         key = va_arg(args, struct lu_context_key *);    \
1177                 } while (key != NULL);                                           \
1178                 va_end(args);                                                    \
1179         }
1180
1181 #define LU_TYPE_INIT(mod, ...)                                         \
1182         LU_KEY_INIT_GENERIC(mod)                                        \
1183         static int mod##_type_init(struct lu_device_type *t)           \
1184         {                                                              \
1185                 mod##_key_init_generic(__VA_ARGS__, NULL);              \
1186                 return lu_context_key_register_many(__VA_ARGS__, NULL); \
1187         }                                                              \
1188         struct __##mod##_dummy_type_init {;}
1189
1190 #define LU_TYPE_FINI(mod, ...)                                         \
1191         static void mod##_type_fini(struct lu_device_type *t)          \
1192         {                                                              \
1193                 lu_context_key_degister_many(__VA_ARGS__, NULL);        \
1194         }                                                              \
1195         struct __##mod##_dummy_type_fini {;}
1196
1197 #define LU_TYPE_START(mod, ...)                                 \
1198         static void mod##_type_start(struct lu_device_type *t)  \
1199         {                                                       \
1200         }                                                       \
1201         struct __##mod##_dummy_type_start {;}
1202
1203 #define LU_TYPE_STOP(mod, ...)                                  \
1204         static void mod##_type_stop(struct lu_device_type *t)   \
1205         {                                                       \
1206         }                                                       \
1207         struct __##mod##_dummy_type_stop {;}
1208
1209
1210
1211 #define LU_TYPE_INIT_FINI(mod, ...)                                 \
1212         LU_TYPE_INIT(mod, __VA_ARGS__);                             \
1213         LU_TYPE_FINI(mod, __VA_ARGS__);         \
1214         LU_TYPE_START(mod, __VA_ARGS__);        \
1215         LU_TYPE_STOP(mod, __VA_ARGS__)
1216
1217 int   lu_context_init  (struct lu_context *ctx, __u32 tags);
1218 void  lu_context_fini  (struct lu_context *ctx);
1219 void  lu_context_enter (struct lu_context *ctx);
1220 void  lu_context_exit  (struct lu_context *ctx);
1221 int   lu_context_refill(struct lu_context *ctx);
1222
1223 /*
1224  * Helper functions to operate on multiple keys. These are used by the default
1225  * device type operations, defined by LU_TYPE_INIT_FINI().
1226  */
1227
1228 int  lu_context_key_register_many(struct lu_context_key *k, ...);
1229 void lu_context_key_degister_many(struct lu_context_key *k, ...);
1230 void lu_context_key_revive_many  (struct lu_context_key *k, ...);
1231 void lu_context_key_quiesce_many (struct lu_context_key *k, ...);
1232
1233 /**
1234  * Environment.
1235  */
1236 struct lu_env {
1237         /**
1238          * "Local" context, used to store data instead of stack.
1239          */
1240         struct lu_context  le_ctx;
1241         /**
1242          * "Session" context for per-request data.
1243          */
1244         struct lu_context *le_ses;
1245 };
1246
1247 int  lu_env_init(struct lu_env *env, struct lu_context *ses, __u32 tags);
1248 void lu_env_fini(struct lu_env *env);
1249
1250 /** @} lu_context */
1251
1252 /**
1253  * Output site statistical counters into a buffer. Suitable for
1254  * ll_rd_*()-style functions.
1255  */
1256 int lu_site_stats_print(const struct lu_site *s, char *page, int count);
1257
1258 /**
1259  * Common name structure to be passed around for various name related methods.
1260  */
1261 struct lu_name {
1262         char    *ln_name;
1263         int      ln_namelen;
1264 };
1265
1266 /**
1267  * Common buffer structure to be passed around for various xattr_{s,g}et()
1268  * methods.
1269  */
1270 struct lu_buf {
1271         void   *lb_buf;
1272         ssize_t lb_len;
1273 };
1274
1275 /** null buffer */
1276 extern struct lu_buf LU_BUF_NULL;
1277
1278 #define DLUBUF "(%p %z)"
1279 #define PLUBUF(buf) (buf)->lb_buf, (buf)->lb_len
1280 /**
1281  * One-time initializers, called at obdclass module initialization, not
1282  * exported.
1283  */
1284
1285 /**
1286  * Initialization of global lu_* data.
1287  */
1288 int lu_global_init(void);
1289
1290 /**
1291  * Dual to lu_global_init().
1292  */
1293 void lu_global_fini(void);
1294
1295 enum {
1296         LU_TIME_FIND_LOOKUP,
1297         LU_TIME_FIND_ALLOC,
1298         LU_TIME_FIND_INSERT,
1299         LU_TIME_NR
1300 };
1301
1302 extern const char *lu_time_names[LU_TIME_NR];
1303
1304 #endif /* __LUSTRE_LU_OBJECT_H */