lustre/include/lu_object.h

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