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