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