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