lustre/include/lu_object.h

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