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         const 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          * Wait-queue signaled when an object in this site is ultimately
 636          * destroyed (lu_object_free()). It is used by lu_object_find() to
 637          * wait before re-trying when object in the process of destruction is
 638          * found in the hash table.
 639          *
 640          * If having a single wait-queue turns out to be a problem, a
 641          * wait-queue per hash-table bucket can be easily implemented.
 642          *
 643          * \see htable_lookup().
 644          */
 645         cfs_waitq_t           ls_marche_funebre;
 646
 647         /** statistical counters. Protected by nothing, races are accepted. */
 648         struct {
 649                 __u32 s_created;
 650                 __u32 s_cache_hit;
 651                 __u32 s_cache_miss;
 652                 /**
 653                  * Number of hash-table entry checks made.
 654                  *
 655                  *       ->s_cache_check / (->s_cache_miss + ->s_cache_hit)
 656                  *
 657                  * is an average number of hash slots inspected during single
 658                  * lookup.
 659                  */
 660                 __u32 s_cache_check;
 661                 /** Races with cache insertions. */
 662                 __u32 s_cache_race;
 663                 /**
 664                  * Races with object destruction.
 665                  *
 666                  * \see lu_site::ls_marche_funebre.
 667                  */
 668                 __u32 s_cache_death_race;
 669                 __u32 s_lru_purged;
 670         } ls_stats;
 671
 672         /**
 673          * Linkage into global list of sites.
 674          */
 675         struct list_head      ls_linkage;
 676         struct lprocfs_stats *ls_time_stats;
 677 };
 678
 679 /** \name ctors
 680  * Constructors/destructors.
 681  * @{
 682  */
 683
 684 int  lu_site_init         (struct lu_site *s, struct lu_device *d);
 685 void lu_site_fini         (struct lu_site *s);
 686 int  lu_site_init_finish  (struct lu_site *s);
 687 void lu_stack_fini        (const struct lu_env *env, struct lu_device *top);
 688 void lu_device_get        (struct lu_device *d);
 689 void lu_device_put        (struct lu_device *d);
 690 int  lu_device_init       (struct lu_device *d, struct lu_device_type *t);
 691 void lu_device_fini       (struct lu_device *d);
 692 int lu_object_header_init(struct lu_object_header *h);
 693 void lu_object_header_fini(struct lu_object_header *h);
 694 int  lu_object_init       (struct lu_object *o,
 695                    struct lu_object_header *h, struct lu_device *d);
 696 void lu_object_fini       (struct lu_object *o);
 697 void lu_object_add_top    (struct lu_object_header *h, struct lu_object *o);
 698 void lu_object_add        (struct lu_object *before, struct lu_object *o);
 699
 700 /**
 701  * Helpers to initialize and finalize device types.
 702  */
 703
 704 int  lu_device_type_init(struct lu_device_type *ldt);
 705 void lu_device_type_fini(struct lu_device_type *ldt);
 706 void lu_types_stop(void);
 707
 708 /** @} ctors */
 709
 710 /** \name caching
 711  * Caching and reference counting.
 712  * @{
 713  */
 714
 715 /**
 716  * Acquire additional reference to the given object. This function is used to
 717  * attain additional reference. To acquire initial reference use
 718  * lu_object_find().
 719  */
 720 static inline void lu_object_get(struct lu_object *o)
 721 {
 722         LASSERT(atomic_read(&o->lo_header->loh_ref) > 0);
 723         atomic_inc(&o->lo_header->loh_ref);
 724 }
 725
 726 /**
 727  * Return true of object will not be cached after last reference to it is
 728  * released.
 729  */
 730 static inline int lu_object_is_dying(const struct lu_object_header *h)
 731 {
 732         return test_bit(LU_OBJECT_HEARD_BANSHEE, &h->loh_flags);
 733 }
 734
 735 void lu_object_put(const struct lu_env *env, struct lu_object *o);
 736
 737 int lu_site_purge(const struct lu_env *env, struct lu_site *s, int nr);
 738
 739 void lu_site_print(const struct lu_env *env, struct lu_site *s, void *cookie,
 740                    lu_printer_t printer);
 741 struct lu_object *lu_object_find(const struct lu_env *env,
 742                                  struct lu_device *dev, const struct lu_fid *f,
 743                                  const struct lu_object_conf *conf);
 744 struct lu_object *lu_object_find_at(const struct lu_env *env,
 745                                     struct lu_device *dev,
 746                                     const struct lu_fid *f,
 747                                     const struct lu_object_conf *conf);
 748 struct lu_object *lu_object_find_slice(const struct lu_env *env,
 749                                        struct lu_device *dev,
 750                                        const struct lu_fid *f,
 751                                        const struct lu_object_conf *conf);
 752 /** @} caching */
 753
 754 /** \name helpers
 755  * Helpers.
 756  * @{
 757  */
 758
 759 /**
 760  * First (topmost) sub-object of given compound object
 761  */
 762 static inline struct lu_object *lu_object_top(struct lu_object_header *h)
 763 {
 764         LASSERT(!list_empty(&h->loh_layers));
 765         return container_of0(h->loh_layers.next, struct lu_object, lo_linkage);
 766 }
 767
 768 /**
 769  * Next sub-object in the layering
 770  */
 771 static inline struct lu_object *lu_object_next(const struct lu_object *o)
 772 {
 773         return container_of0(o->lo_linkage.next, struct lu_object, lo_linkage);
 774 }
 775
 776 /**
 777  * Pointer to the fid of this object.
 778  */
 779 static inline const struct lu_fid *lu_object_fid(const struct lu_object *o)
 780 {
 781         return &o->lo_header->loh_fid;
 782 }
 783
 784 /**
 785  * return device operations vector for this object
 786  */
 787 static const inline struct lu_device_operations *
 788 lu_object_ops(const struct lu_object *o)
 789 {
 790         return o->lo_dev->ld_ops;
 791 }
 792
 793 /**
 794  * Given a compound object, find its slice, corresponding to the device type
 795  * \a dtype.
 796  */
 797 struct lu_object *lu_object_locate(struct lu_object_header *h,
 798                                    const struct lu_device_type *dtype);
 799
 800 struct lu_cdebug_print_info {
 801         int         lpi_subsys;
 802         int         lpi_mask;
 803         const char *lpi_file;
 804         const char *lpi_fn;
 805         int         lpi_line;
 806 };
 807
 808 /*
 809  * Printer function emitting messages through libcfs_debug_msg().
 810  */
 811 int lu_cdebug_printer(const struct lu_env *env,
 812                       void *cookie, const char *format, ...);
 813
 814 #define DECLARE_LU_CDEBUG_PRINT_INFO(var, mask) \
 815         struct lu_cdebug_print_info var = {     \
 816                 .lpi_subsys = DEBUG_SUBSYSTEM,  \
 817                 .lpi_mask   = (mask),           \
 818                 .lpi_file   = __FILE__,         \
 819                 .lpi_fn     = __FUNCTION__,     \
 820                 .lpi_line   = __LINE__          \
 821         };
 822
 823 /*
 824  * Print object description followed by user-supplied message.
 825  */
 826 #define LU_OBJECT_DEBUG(mask, env, object, format, ...)                 \
 827 ({                                                                      \
 828         static DECLARE_LU_CDEBUG_PRINT_INFO(__info, mask);              \
 829                                                                         \
 830         lu_object_print(env, &__info, lu_cdebug_printer, object);       \
 831         CDEBUG(mask, format , ## __VA_ARGS__);                          \
 832 })
 833
 834 /*
 835  * Print human readable representation of the @o to the @f.
 836  */
 837 void lu_object_print(const struct lu_env *env, void *cookie,
 838                      lu_printer_t printer, const struct lu_object *o);
 839
 840 /*
 841  * Check object consistency.
 842  */
 843 int lu_object_invariant(const struct lu_object *o);
 844
 845 /*
 846  * Finalize and free devices in the device stack.
 847  */
 848 void lu_stack_fini(const struct lu_env *env, struct lu_device *top);
 849
 850 /*
 851  * Returns 1 iff object @o exists on the stable storage,
 852  * returns -1 iff object @o is on remote server.
 853  */
 854 static inline int lu_object_exists(const struct lu_object *o)
 855 {
 856         __u32 attr;
 857
 858         attr = o->lo_header->loh_attr;
 859         if (attr & LOHA_REMOTE)
 860                 return -1;
 861         else if (attr & LOHA_EXISTS)
 862                 return +1;
 863         else
 864                 return 0;
 865 }
 866
 867 static inline int lu_object_assert_exists(const struct lu_object *o)
 868 {
 869         return lu_object_exists(o) != 0;
 870 }
 871
 872 static inline int lu_object_assert_not_exists(const struct lu_object *o)
 873 {
 874         return lu_object_exists(o) <= 0;
 875 }
 876
 877 /**
 878  * Attr of this object.
 879  */
 880 static inline __u32 lu_object_attr(const struct lu_object *o)
 881 {
 882         LASSERT(lu_object_exists(o) > 0);
 883         return o->lo_header->loh_attr;
 884 }
 885
 886 static inline struct lu_ref_link *lu_object_ref_add(struct lu_object *o,
 887                                                     const char *scope,
 888                                                     const void *source)
 889 {
 890         return lu_ref_add(&o->lo_header->loh_reference, scope, source);
 891 }
 892
 893 static inline void lu_object_ref_del(struct lu_object *o,
 894                                      const char *scope, const void *source)
 895 {
 896         lu_ref_del(&o->lo_header->loh_reference, scope, source);
 897 }
 898
 899 static inline void lu_object_ref_del_at(struct lu_object *o,
 900                                         struct lu_ref_link *link,
 901                                         const char *scope, const void *source)
 902 {
 903         lu_ref_del_at(&o->lo_header->loh_reference, link, scope, source);
 904 }
 905
 906 struct lu_rdpg {
 907         /* input params, should be filled out by mdt */
 908         __u64                   rp_hash;        /* hash */
 909         int                     rp_count;       /* count in bytes       */
 910         int                     rp_npages;      /* number of pages      */
 911         struct page           **rp_pages;       /* pointers to pages    */
 912 };
 913
 914 enum lu_xattr_flags {
 915         LU_XATTR_REPLACE = (1 << 0),
 916         LU_XATTR_CREATE  = (1 << 1)
 917 };
 918
 919 /** @} helpers */
 920
 921 /** \name lu_context
 922  * @{ */
 923
 924 /** For lu_context health-checks */
 925 enum lu_context_state {
 926         LCS_INITIALIZED = 1,
 927         LCS_ENTERED,
 928         LCS_LEFT,
 929         LCS_FINALIZED
 930 };
 931
 932 /**
 933  * lu_context. Execution context for lu_object methods. Currently associated
 934  * with thread.
 935  *
 936  * All lu_object methods, except device and device type methods (called during
 937  * system initialization and shutdown) are executed "within" some
 938  * lu_context. This means, that pointer to some "current" lu_context is passed
 939  * as an argument to all methods.
 940  *
 941  * All service ptlrpc threads create lu_context as part of their
 942  * initialization. It is possible to create "stand-alone" context for other
 943  * execution environments (like system calls).
 944  *
 945  * lu_object methods mainly use lu_context through lu_context_key interface
 946  * that allows each layer to associate arbitrary pieces of data with each
 947  * context (see pthread_key_create(3) for similar interface).
 948  *
 949  * On a client, lu_context is bound to a thread, see cl_env_get().
 950  *
 951  * \see lu_context_key
 952  */
 953 struct lu_context {
 954         /**
 955          * lu_context is used on the client side too. Yet we don't want to
 956          * allocate values of server-side keys for the client contexts and
 957          * vice versa.
 958          *
 959          * To achieve this, set of tags in introduced. Contexts and keys are
 960          * marked with tags. Key value are created only for context whose set
 961          * of tags has non-empty intersection with one for key. Tags are taken
 962          * from enum lu_context_tag.
 963          */
 964         __u32                  lc_tags;
 965         /**
 966          * Pointer to the home service thread. NULL for other execution
 967          * contexts.
 968          */
 969         struct ptlrpc_thread  *lc_thread;
 970         /**
 971          * Pointer to an array with key values. Internal implementation
 972          * detail.
 973          */
 974         void                 **lc_value;
 975         enum lu_context_state  lc_state;
 976         /**
 977          * Linkage into a list of all remembered contexts. Only
 978          * `non-transient' contexts, i.e., ones created for service threads
 979          * are placed here.
 980          */
 981         struct list_head       lc_remember;
 982         /**
 983          * Version counter used to skip calls to lu_context_refill() when no
 984          * keys were registered.
 985          */
 986         unsigned               lc_version;
 987 };
 988
 989 /**
 990  * lu_context_key interface. Similar to pthread_key.
 991  */
 992
 993 enum lu_context_tag {
 994         /**
 995          * Thread on md server
 996          */
 997         LCT_MD_THREAD = 1 << 0,
 998         /**
 999          * Thread on dt server
1000          */
1001         LCT_DT_THREAD = 1 << 1,
1002         /**
1003          * Context for transaction handle
1004          */
1005         LCT_TX_HANDLE = 1 << 2,
1006         /**
1007          * Thread on client
1008          */
1009         LCT_CL_THREAD = 1 << 3,
1010         /**
1011          * A per-request session on a server, and a per-system-call session on
1012          * a client.
1013          */
1014         LCT_SESSION   = 1 << 4,
1015
1016         /**
1017          * Set when at least one of keys, having values in this context has
1018          * non-NULL lu_context_key::lct_exit() method. This is used to
1019          * optimize lu_context_exit() call.
1020          */
1021         LCT_HAS_EXIT  = 1 << 28,
1022         /**
1023          * Don't add references for modules creating key values in that context.
1024          * This is only for contexts used internally by lu_object framework.
1025          */
1026         LCT_NOREF     = 1 << 29,
1027         /**
1028          * Key is being prepared for retiring, don't create new values for it.
1029          */
1030         LCT_QUIESCENT = 1 << 30,
1031         /**
1032          * Context should be remembered.
1033          */
1034         LCT_REMEMBER  = 1 << 31,
1035         /**
1036          * Contexts usable in cache shrinker thread.
1037          */
1038         LCT_SHRINKER  = LCT_MD_THREAD|LCT_DT_THREAD|LCT_CL_THREAD|LCT_NOREF
1039 };
1040
1041 /**
1042  * Key. Represents per-context value slot.
1043  *
1044  * Keys are usually registered when module owning the key is initialized, and
1045  * de-registered when module is unloaded. Once key is registered, all new
1046  * contexts with matching tags, will get key value. "Old" contexts, already
1047  * initialized at the time of key registration, can be forced to get key value
1048  * by calling lu_context_refill().
1049  *
1050  * Every key value is counted in lu_context_key::lct_used and acquires a
1051  * reference on an owning module. This means, that all key values have to be
1052  * destroyed before module can be unloaded. This is usually achieved by
1053  * stopping threads started by the module, that created contexts in their
1054  * entry functions. Situation is complicated by the threads shared by multiple
1055  * modules, like ptlrpcd daemon on a client. To work around this problem,
1056  * contexts, created in such threads, are `remembered' (see
1057  * LCT_REMEMBER)---i.e., added into a global list. When module is preparing
1058  * for unloading it does the following:
1059  *
1060  *     - marks its keys as `quiescent' (lu_context_tag::LCT_QUIESCENT)
1061  *       preventing new key values from being allocated in the new contexts,
1062  *       and
1063  *
1064  *     - scans a list of remembered contexts, destroying values of module
1065  *       keys, thus releasing references to the module.
1066  *
1067  * This is done by lu_context_key_quiesce(). If module is re-activated
1068  * before key has been de-registered, lu_context_key_revive() call clears
1069  * `quiescent' marker.
1070  *
1071  * lu_context code doesn't provide any internal synchronization for these
1072  * activities---it's assumed that startup (including threads start-up) and
1073  * shutdown are serialized by some external means.
1074  *
1075  * \see lu_context
1076  */
1077 struct lu_context_key {
1078         /**
1079          * Set of tags for which values of this key are to be instantiated.
1080          */
1081         __u32 lct_tags;
1082         /**
1083          * Value constructor. This is called when new value is created for a
1084          * context. Returns pointer to new value of error pointer.
1085          */
1086         void  *(*lct_init)(const struct lu_context *ctx,
1087                            struct lu_context_key *key);
1088         /**
1089          * Value destructor. Called when context with previously allocated
1090          * value of this slot is destroyed. \a data is a value that was returned
1091          * by a matching call to lu_context_key::lct_init().
1092          */
1093         void   (*lct_fini)(const struct lu_context *ctx,
1094                            struct lu_context_key *key, void *data);
1095         /**
1096          * Optional method called on lu_context_exit() for all allocated
1097          * keys. Can be used by debugging code checking that locks are
1098          * released, etc.
1099          */
1100         void   (*lct_exit)(const struct lu_context *ctx,
1101                            struct lu_context_key *key, void *data);
1102         /**
1103          * Internal implementation detail: index within lu_context::lc_value[]
1104          * reserved for this key.
1105          */
1106         int      lct_index;
1107         /**
1108          * Internal implementation detail: number of values created for this
1109          * key.
1110          */
1111         atomic_t lct_used;
1112         /**
1113          * Internal implementation detail: module for this key.
1114          */
1115         struct module *lct_owner;
1116         /**
1117          * References to this key. For debugging.
1118          */
1119         struct lu_ref  lct_reference;
1120 };
1121
1122 #define LU_KEY_INIT(mod, type)                                    \
1123         static void* mod##_key_init(const struct lu_context *ctx, \
1124                                     struct lu_context_key *key)   \
1125         {                                                         \
1126                 type *value;                                      \
1127                                                                   \
1128                 CLASSERT(CFS_PAGE_SIZE >= sizeof (*value));       \
1129                                                                   \
1130                 OBD_ALLOC_PTR(value);                             \
1131                 if (value == NULL)                                \
1132                         value = ERR_PTR(-ENOMEM);                 \
1133                                                                   \
1134                 return value;                                     \
1135         }                                                         \
1136         struct __##mod##__dummy_init {;} /* semicolon catcher */
1137
1138 #define LU_KEY_FINI(mod, type)                                              \
1139         static void mod##_key_fini(const struct lu_context *ctx,            \
1140                                     struct lu_context_key *key, void* data) \
1141         {                                                                   \
1142                 type *info = data;                                          \
1143                                                                             \
1144                 OBD_FREE_PTR(info);                                         \
1145         }                                                                   \
1146         struct __##mod##__dummy_fini {;} /* semicolon catcher */
1147
1148 #define LU_KEY_INIT_FINI(mod, type)   \
1149         LU_KEY_INIT(mod,type);        \
1150         LU_KEY_FINI(mod,type)
1151
1152 #define LU_CONTEXT_KEY_DEFINE(mod, tags)                \
1153         struct lu_context_key mod##_thread_key = {      \
1154                 .lct_tags = tags,                       \
1155                 .lct_init = mod##_key_init,             \
1156                 .lct_fini = mod##_key_fini              \
1157         }
1158
1159 #define LU_CONTEXT_KEY_INIT(key)                        \
1160 do {                                                    \
1161         (key)->lct_owner = THIS_MODULE;                 \
1162 } while (0)
1163
1164 int   lu_context_key_register(struct lu_context_key *key);
1165 void  lu_context_key_degister(struct lu_context_key *key);
1166 void *lu_context_key_get     (const struct lu_context *ctx,
1167                                const struct lu_context_key *key);
1168 void  lu_context_key_quiesce (struct lu_context_key *key);
1169 void  lu_context_key_revive  (struct lu_context_key *key);
1170
1171
1172 /*
1173  * LU_KEY_INIT_GENERIC() has to be a macro to correctly determine an
1174  * owning module.
1175  */
1176
1177 #define LU_KEY_INIT_GENERIC(mod)                                        \
1178         static void mod##_key_init_generic(struct lu_context_key *k, ...) \
1179         {                                                                        \
1180                 struct lu_context_key *key = k;                         \
1181                 va_list args;                                                    \
1182                                                                                  \
1183                 va_start(args, k);                                               \
1184                 do {                                                             \
1185                         LU_CONTEXT_KEY_INIT(key);                                \
1186                         key = va_arg(args, struct lu_context_key *);    \
1187                 } while (key != NULL);                                           \
1188                 va_end(args);                                                    \
1189         }
1190
1191 #define LU_TYPE_INIT(mod, ...)                                         \
1192         LU_KEY_INIT_GENERIC(mod)                                        \
1193         static int mod##_type_init(struct lu_device_type *t)           \
1194         {                                                              \
1195                 mod##_key_init_generic(__VA_ARGS__, NULL);              \
1196                 return lu_context_key_register_many(__VA_ARGS__, NULL); \
1197         }                                                              \
1198         struct __##mod##_dummy_type_init {;}
1199
1200 #define LU_TYPE_FINI(mod, ...)                                         \
1201         static void mod##_type_fini(struct lu_device_type *t)          \
1202         {                                                              \
1203                 lu_context_key_degister_many(__VA_ARGS__, NULL);        \
1204         }                                                              \
1205         struct __##mod##_dummy_type_fini {;}
1206
1207 #define LU_TYPE_START(mod, ...)                                 \
1208         static void mod##_type_start(struct lu_device_type *t)  \
1209         {                                                       \
1210         }                                                       \
1211         struct __##mod##_dummy_type_start {;}
1212
1213 #define LU_TYPE_STOP(mod, ...)                                  \
1214         static void mod##_type_stop(struct lu_device_type *t)   \
1215         {                                                       \
1216         }                                                       \
1217         struct __##mod##_dummy_type_stop {;}
1218
1219
1220
1221 #define LU_TYPE_INIT_FINI(mod, ...)                                 \
1222         LU_TYPE_INIT(mod, __VA_ARGS__);                             \
1223         LU_TYPE_FINI(mod, __VA_ARGS__);         \
1224         LU_TYPE_START(mod, __VA_ARGS__);        \
1225         LU_TYPE_STOP(mod, __VA_ARGS__)
1226
1227 int   lu_context_init  (struct lu_context *ctx, __u32 tags);
1228 void  lu_context_fini  (struct lu_context *ctx);
1229 void  lu_context_enter (struct lu_context *ctx);
1230 void  lu_context_exit  (struct lu_context *ctx);
1231 int   lu_context_refill(struct lu_context *ctx);
1232
1233 /*
1234  * Helper functions to operate on multiple keys. These are used by the default
1235  * device type operations, defined by LU_TYPE_INIT_FINI().
1236  */
1237
1238 int  lu_context_key_register_many(struct lu_context_key *k, ...);
1239 void lu_context_key_degister_many(struct lu_context_key *k, ...);
1240 void lu_context_key_revive_many  (struct lu_context_key *k, ...);
1241 void lu_context_key_quiesce_many (struct lu_context_key *k, ...);
1242
1243 /**
1244  * Environment.
1245  */
1246 struct lu_env {
1247         /**
1248          * "Local" context, used to store data instead of stack.
1249          */
1250         struct lu_context  le_ctx;
1251         /**
1252          * "Session" context for per-request data.
1253          */
1254         struct lu_context *le_ses;
1255 };
1256
1257 int  lu_env_init(struct lu_env *env, struct lu_context *ses, __u32 tags);
1258 void lu_env_fini(struct lu_env *env);
1259
1260 /** @} lu_context */
1261
1262 /**
1263  * Output site statistical counters into a buffer. Suitable for
1264  * ll_rd_*()-style functions.
1265  */
1266 int lu_site_stats_print(const struct lu_site *s, char *page, int count);
1267
1268 /**
1269  * Common name structure to be passed around for various name related methods.
1270  */
1271 struct lu_name {
1272         char    *ln_name;
1273         int      ln_namelen;
1274 };
1275
1276 /**
1277  * Common buffer structure to be passed around for various xattr_{s,g}et()
1278  * methods.
1279  */
1280 struct lu_buf {
1281         void   *lb_buf;
1282         ssize_t lb_len;
1283 };
1284
1285 /** null buffer */
1286 extern struct lu_buf LU_BUF_NULL;
1287
1288 #define DLUBUF "(%p %z)"
1289 #define PLUBUF(buf) (buf)->lb_buf, (buf)->lb_len
1290 /**
1291  * One-time initializers, called at obdclass module initialization, not
1292  * exported.
1293  */
1294
1295 /**
1296  * Initialization of global lu_* data.
1297  */
1298 int lu_global_init(void);
1299
1300 /**
1301  * Dual to lu_global_init().
1302  */
1303 void lu_global_fini(void);
1304
1305 enum {
1306         LU_TIME_FIND_LOOKUP,
1307         LU_TIME_FIND_ALLOC,
1308         LU_TIME_FIND_INSERT,
1309         LU_TIME_NR
1310 };
1311
1312 extern const char *lu_time_names[LU_TIME_NR];
1313
1314 struct lu_kmem_descr {
1315         cfs_mem_cache_t **ckd_cache;
1316         const char       *ckd_name;
1317         const size_t      ckd_size;
1318 };
1319
1320 int  lu_kmem_init(struct lu_kmem_descr *caches);
1321 void lu_kmem_fini(struct lu_kmem_descr *caches);
1322
1323 /** @} lu */
1324
1325 #endif /* __LUSTRE_LU_OBJECT_H */