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