lustre/include/lu_object.h

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