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, 2017, 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 /**
 434  * Layer in the layered object.
 435  */
 436 struct lu_object {
 437         /**
 438          * Header for this object.
 439          */
 440         struct lu_object_header           *lo_header;
 441         /**
 442          * Device for this layer.
 443          */
 444         struct lu_device                  *lo_dev;
 445         /**
 446          * Operations for this object.
 447          */
 448         const struct lu_object_operations *lo_ops;
 449         /**
 450          * Linkage into list of all layers.
 451          */
 452         struct list_head                   lo_linkage;
 453         /**
 454          * Link to the device, for debugging.
 455          */
 456         struct lu_ref_link                 lo_dev_ref;
 457 };
 458
 459 enum lu_object_header_flags {
 460         /**
 461          * Don't keep this object in cache. Object will be destroyed as soon
 462          * as last reference to it is released. This flag cannot be cleared
 463          * once set.
 464          */
 465         LU_OBJECT_HEARD_BANSHEE = 0,
 466         /**
 467          * Mark this object has already been taken out of cache.
 468          */
 469         LU_OBJECT_UNHASHED = 1,
 470 };
 471
 472 enum lu_object_header_attr {
 473         LOHA_EXISTS             = 1 << 0,
 474         LOHA_REMOTE             = 1 << 1,
 475         LOHA_HAS_AGENT_ENTRY    = 1 << 2,
 476         /**
 477          * UNIX file type is stored in S_IFMT bits.
 478          */
 479         LOHA_FT_START           = 001 << 12, /**< S_IFIFO */
 480         LOHA_FT_END             = 017 << 12, /**< S_IFMT */
 481 };
 482
 483 /**
 484  * "Compound" object, consisting of multiple layers.
 485  *
 486  * Compound object with given fid is unique with given lu_site.
 487  *
 488  * Note, that object does *not* necessary correspond to the real object in the
 489  * persistent storage: object is an anchor for locking and method calling, so
 490  * it is created for things like not-yet-existing child created by mkdir or
 491  * create calls. lu_object_operations::loo_exists() can be used to check
 492  * whether object is backed by persistent storage entity.
 493  */
 494 struct lu_object_header {
 495         /**
 496          * Fid, uniquely identifying this object.
 497          */
 498         struct lu_fid           loh_fid;
 499         /**
 500          * Object flags from enum lu_object_header_flags. Set and checked
 501          * atomically.
 502          */
 503         unsigned long           loh_flags;
 504         /**
 505          * Object reference count. Protected by lu_site::ls_guard.
 506          */
 507         atomic_t                loh_ref;
 508         /**
 509          * Common object attributes, cached for efficiency. From enum
 510          * lu_object_header_attr.
 511          */
 512         __u32                   loh_attr;
 513         /**
 514          * Linkage into per-site hash table. Protected by lu_site::ls_guard.
 515          */
 516         struct hlist_node       loh_hash;
 517         /**
 518          * Linkage into per-site LRU list. Protected by lu_site::ls_guard.
 519          */
 520         struct list_head        loh_lru;
 521         /**
 522          * Linkage into list of layers. Never modified once set (except lately
 523          * during object destruction). No locking is necessary.
 524          */
 525         struct list_head        loh_layers;
 526         /**
 527          * A list of references to this object, for debugging.
 528          */
 529         struct lu_ref           loh_reference;
 530 };
 531
 532 struct fld;
 533
 534 struct lu_site_bkt_data {
 535         /**
 536          * number of object in this bucket on the lsb_lru list.
 537          */
 538         long                    lsb_lru_len;
 539         /**
 540          * LRU list, updated on each access to object. Protected by
 541          * bucket lock of lu_site::ls_obj_hash.
 542          *
 543          * "Cold" end of LRU is lu_site::ls_lru.next. Accessed object are
 544          * moved to the lu_site::ls_lru.prev (this is due to the non-existence
 545          * of list_for_each_entry_safe_reverse()).
 546          */
 547         struct list_head        lsb_lru;
 548         /**
 549          * Wait-queue signaled when an object in this site is ultimately
 550          * destroyed (lu_object_free()). It is used by lu_object_find() to
 551          * wait before re-trying when object in the process of destruction is
 552          * found in the hash table.
 553          *
 554          * \see htable_lookup().
 555          */
 556         wait_queue_head_t       lsb_marche_funebre;
 557 };
 558
 559 enum {
 560         LU_SS_CREATED           = 0,
 561         LU_SS_CACHE_HIT,
 562         LU_SS_CACHE_MISS,
 563         LU_SS_CACHE_RACE,
 564         LU_SS_CACHE_DEATH_RACE,
 565         LU_SS_LRU_PURGED,
 566         LU_SS_LAST_STAT
 567 };
 568
 569 /**
 570  * lu_site is a "compartment" within which objects are unique, and LRU
 571  * discipline is maintained.
 572  *
 573  * lu_site exists so that multiple layered stacks can co-exist in the same
 574  * address space.
 575  *
 576  * lu_site has the same relation to lu_device as lu_object_header to
 577  * lu_object.
 578  */
 579 struct lu_site {
 580         /**
 581          * objects hash table
 582          */
 583         struct cfs_hash         *ls_obj_hash;
 584         /**
 585          * index of bucket on hash table while purging
 586          */
 587         unsigned int            ls_purge_start;
 588         /**
 589          * Top-level device for this stack.
 590          */
 591         struct lu_device        *ls_top_dev;
 592         /**
 593          * Bottom-level device for this stack
 594          */
 595         struct lu_device        *ls_bottom_dev;
 596         /**
 597          * Linkage into global list of sites.
 598          */
 599         struct list_head        ls_linkage;
 600         /**
 601          * List for lu device for this site, protected
 602          * by ls_ld_lock.
 603          **/
 604         struct list_head        ls_ld_linkage;
 605         spinlock_t              ls_ld_lock;
 606         /**
 607          * Lock to serialize site purge.
 608          */
 609         struct mutex            ls_purge_mutex;
 610         /**
 611          * lu_site stats
 612          */
 613         struct lprocfs_stats    *ls_stats;
 614         /**
 615          * XXX: a hack! fld has to find md_site via site, remove when possible
 616          */
 617         struct seq_server_site  *ld_seq_site;
 618         /**
 619          * Pointer to the lu_target for this site.
 620          */
 621         struct lu_target        *ls_tgt;
 622
 623         /**
 624          * Number of objects in lsb_lru_lists - used for shrinking
 625          */
 626         struct percpu_counter   ls_lru_len_counter;
 627 };
 628
 629 static inline struct lu_site_bkt_data *
 630 lu_site_bkt_from_fid(struct lu_site *site, struct lu_fid *fid)
 631 {
 632         struct cfs_hash_bd bd;
 633
 634         cfs_hash_bd_get(site->ls_obj_hash, fid, &bd);
 635         return cfs_hash_bd_extra_get(site->ls_obj_hash, &bd);
 636 }
 637
 638 static inline struct seq_server_site *lu_site2seq(const struct lu_site *s)
 639 {
 640         return s->ld_seq_site;
 641 }
 642
 643 /** \name ctors
 644  * Constructors/destructors.
 645  * @{
 646  */
 647
 648 int  lu_site_init         (struct lu_site *s, struct lu_device *d);
 649 void lu_site_fini         (struct lu_site *s);
 650 int  lu_site_init_finish  (struct lu_site *s);
 651 void lu_stack_fini        (const struct lu_env *env, struct lu_device *top);
 652 void lu_device_get        (struct lu_device *d);
 653 void lu_device_put        (struct lu_device *d);
 654 int  lu_device_init       (struct lu_device *d, struct lu_device_type *t);
 655 void lu_device_fini       (struct lu_device *d);
 656 int  lu_object_header_init(struct lu_object_header *h);
 657 void lu_object_header_fini(struct lu_object_header *h);
 658 int  lu_object_init       (struct lu_object *o,
 659                            struct lu_object_header *h, struct lu_device *d);
 660 void lu_object_fini       (struct lu_object *o);
 661 void lu_object_add_top    (struct lu_object_header *h, struct lu_object *o);
 662 void lu_object_add        (struct lu_object *before, struct lu_object *o);
 663
 664 void lu_dev_add_linkage(struct lu_site *s, struct lu_device *d);
 665 void lu_dev_del_linkage(struct lu_site *s, struct lu_device *d);
 666
 667 /**
 668  * Helpers to initialize and finalize device types.
 669  */
 670
 671 int  lu_device_type_init(struct lu_device_type *ldt);
 672 void lu_device_type_fini(struct lu_device_type *ldt);
 673
 674 /** @} ctors */
 675
 676 /** \name caching
 677  * Caching and reference counting.
 678  * @{
 679  */
 680
 681 /**
 682  * Acquire additional reference to the given object. This function is used to
 683  * attain additional reference. To acquire initial reference use
 684  * lu_object_find().
 685  */
 686 static inline void lu_object_get(struct lu_object *o)
 687 {
 688         LASSERT(atomic_read(&o->lo_header->loh_ref) > 0);
 689         atomic_inc(&o->lo_header->loh_ref);
 690 }
 691
 692 /**
 693  * Return true if object will not be cached after last reference to it is
 694  * released.
 695  */
 696 static inline int lu_object_is_dying(const struct lu_object_header *h)
 697 {
 698         return test_bit(LU_OBJECT_HEARD_BANSHEE, &h->loh_flags);
 699 }
 700
 701 void lu_object_put(const struct lu_env *env, struct lu_object *o);
 702 void lu_object_put_nocache(const struct lu_env *env, struct lu_object *o);
 703 void lu_object_unhash(const struct lu_env *env, struct lu_object *o);
 704 int lu_site_purge_objects(const struct lu_env *env, struct lu_site *s, int nr,
 705                           int canblock);
 706
 707 static inline int lu_site_purge(const struct lu_env *env, struct lu_site *s,
 708                                 int nr)
 709 {
 710         return lu_site_purge_objects(env, s, nr, 1);
 711 }
 712
 713 void lu_site_print(const struct lu_env *env, struct lu_site *s, void *cookie,
 714                    lu_printer_t printer);
 715 struct lu_object *lu_object_find(const struct lu_env *env,
 716                                  struct lu_device *dev, const struct lu_fid *f,
 717                                  const struct lu_object_conf *conf);
 718 struct lu_object *lu_object_find_at(const struct lu_env *env,
 719                                     struct lu_device *dev,
 720                                     const struct lu_fid *f,
 721                                     const struct lu_object_conf *conf);
 722 struct lu_object *lu_object_find_slice(const struct lu_env *env,
 723                                        struct lu_device *dev,
 724                                        const struct lu_fid *f,
 725                                        const struct lu_object_conf *conf);
 726 /** @} caching */
 727
 728 /** \name helpers
 729  * Helpers.
 730  * @{
 731  */
 732
 733 /**
 734  * First (topmost) sub-object of given compound object
 735  */
 736 static inline struct lu_object *lu_object_top(struct lu_object_header *h)
 737 {
 738         LASSERT(!list_empty(&h->loh_layers));
 739         return container_of0(h->loh_layers.next, struct lu_object, lo_linkage);
 740 }
 741
 742 /**
 743  * Next sub-object in the layering
 744  */
 745 static inline struct lu_object *lu_object_next(const struct lu_object *o)
 746 {
 747         return container_of0(o->lo_linkage.next, struct lu_object, lo_linkage);
 748 }
 749
 750 /**
 751  * Pointer to the fid of this object.
 752  */
 753 static inline const struct lu_fid *lu_object_fid(const struct lu_object *o)
 754 {
 755         return &o->lo_header->loh_fid;
 756 }
 757
 758 /**
 759  * return device operations vector for this object
 760  */
 761 static const inline struct lu_device_operations *
 762 lu_object_ops(const struct lu_object *o)
 763 {
 764         return o->lo_dev->ld_ops;
 765 }
 766
 767 /**
 768  * Given a compound object, find its slice, corresponding to the device type
 769  * \a dtype.
 770  */
 771 struct lu_object *lu_object_locate(struct lu_object_header *h,
 772                                    const struct lu_device_type *dtype);
 773
 774 /**
 775  * Printer function emitting messages through libcfs_debug_msg().
 776  */
 777 int lu_cdebug_printer(const struct lu_env *env,
 778                       void *cookie, const char *format, ...);
 779
 780 /**
 781  * Print object description followed by a user-supplied message.
 782  */
 783 #define LU_OBJECT_DEBUG(mask, env, object, format, ...)                   \
 784 do {                                                                      \
 785         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                     \
 786                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);          \
 787                 lu_object_print(env, &msgdata, lu_cdebug_printer, object);\
 788                 CDEBUG(mask, format "\n", ## __VA_ARGS__);                \
 789         }                                                                 \
 790 } while (0)
 791
 792 /**
 793  * Print short object description followed by a user-supplied message.
 794  */
 795 #define LU_OBJECT_HEADER(mask, env, object, format, ...)                \
 796 do {                                                                    \
 797         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
 798                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);        \
 799                 lu_object_header_print(env, &msgdata, lu_cdebug_printer,\
 800                                        (object)->lo_header);            \
 801                 lu_cdebug_printer(env, &msgdata, "\n");                 \
 802                 CDEBUG(mask, format , ## __VA_ARGS__);                  \
 803         }                                                               \
 804 } while (0)
 805
 806 void lu_object_print       (const struct lu_env *env, void *cookie,
 807                             lu_printer_t printer, const struct lu_object *o);
 808 void lu_object_header_print(const struct lu_env *env, void *cookie,
 809                             lu_printer_t printer,
 810                             const struct lu_object_header *hdr);
 811
 812 /**
 813  * Check object consistency.
 814  */
 815 int lu_object_invariant(const struct lu_object *o);
 816
 817
 818 /**
 819  * Check whether object exists, no matter on local or remote storage.
 820  * Note: LOHA_EXISTS will be set once some one created the object,
 821  * and it does not needs to be committed to storage.
 822  */
 823 #define lu_object_exists(o) ((o)->lo_header->loh_attr & LOHA_EXISTS)
 824
 825 /**
 826  * Check whether object on the remote storage.
 827  */
 828 #define lu_object_remote(o) unlikely((o)->lo_header->loh_attr & LOHA_REMOTE)
 829
 830 /**
 831  * Check whether the object as agent entry on current target
 832  */
 833 #define lu_object_has_agent_entry(o) \
 834         unlikely((o)->lo_header->loh_attr & LOHA_HAS_AGENT_ENTRY)
 835
 836 static inline void lu_object_set_agent_entry(struct lu_object *o)
 837 {
 838         o->lo_header->loh_attr |= LOHA_HAS_AGENT_ENTRY;
 839 }
 840
 841 static inline void lu_object_clear_agent_entry(struct lu_object *o)
 842 {
 843         o->lo_header->loh_attr &= ~LOHA_HAS_AGENT_ENTRY;
 844 }
 845
 846 static inline int lu_object_assert_exists(const struct lu_object *o)
 847 {
 848         return lu_object_exists(o);
 849 }
 850
 851 static inline int lu_object_assert_not_exists(const struct lu_object *o)
 852 {
 853         return !lu_object_exists(o);
 854 }
 855
 856 /**
 857  * Attr of this object.
 858  */
 859 static inline __u32 lu_object_attr(const struct lu_object *o)
 860 {
 861         LASSERT(lu_object_exists(o) != 0);
 862
 863         return o->lo_header->loh_attr & S_IFMT;
 864 }
 865
 866 static inline void lu_object_ref_add(struct lu_object *o,
 867                                      const char *scope,
 868                                      const void *source)
 869 {
 870         lu_ref_add(&o->lo_header->loh_reference, scope, source);
 871 }
 872
 873 static inline void lu_object_ref_add_at(struct lu_object *o,
 874                                         struct lu_ref_link *link,
 875                                         const char *scope,
 876                                         const void *source)
 877 {
 878         lu_ref_add_at(&o->lo_header->loh_reference, link, scope, source);
 879 }
 880
 881 static inline void lu_object_ref_del(struct lu_object *o,
 882                                      const char *scope, const void *source)
 883 {
 884         lu_ref_del(&o->lo_header->loh_reference, scope, source);
 885 }
 886
 887 static inline void lu_object_ref_del_at(struct lu_object *o,
 888                                         struct lu_ref_link *link,
 889                                         const char *scope, const void *source)
 890 {
 891         lu_ref_del_at(&o->lo_header->loh_reference, link, scope, source);
 892 }
 893
 894 /** input params, should be filled out by mdt */
 895 struct lu_rdpg {
 896         /** hash */
 897         __u64                   rp_hash;
 898         /** count in bytes */
 899         unsigned int            rp_count;
 900         /** number of pages */
 901         unsigned int            rp_npages;
 902         /** requested attr */
 903         __u32                   rp_attrs;
 904         /** pointers to pages */
 905         struct page           **rp_pages;
 906 };
 907
 908 enum lu_xattr_flags {
 909         LU_XATTR_REPLACE = (1 << 0),
 910         LU_XATTR_CREATE  = (1 << 1),
 911         LU_XATTR_MERGE   = (1 << 2),
 912         LU_XATTR_SPLIT   = (1 << 3),
 913 };
 914
 915 /** @} helpers */
 916
 917 /** \name lu_context
 918  * @{ */
 919
 920 /** For lu_context health-checks */
 921 enum lu_context_state {
 922         LCS_INITIALIZED = 1,
 923         LCS_ENTERED,
 924         LCS_LEFT,
 925         LCS_FINALIZED
 926 };
 927
 928 /**
 929  * lu_context. Execution context for lu_object methods. Currently associated
 930  * with thread.
 931  *
 932  * All lu_object methods, except device and device type methods (called during
 933  * system initialization and shutdown) are executed "within" some
 934  * lu_context. This means, that pointer to some "current" lu_context is passed
 935  * as an argument to all methods.
 936  *
 937  * All service ptlrpc threads create lu_context as part of their
 938  * initialization. It is possible to create "stand-alone" context for other
 939  * execution environments (like system calls).
 940  *
 941  * lu_object methods mainly use lu_context through lu_context_key interface
 942  * that allows each layer to associate arbitrary pieces of data with each
 943  * context (see pthread_key_create(3) for similar interface).
 944  *
 945  * On a client, lu_context is bound to a thread, see cl_env_get().
 946  *
 947  * \see lu_context_key
 948  */
 949 struct lu_context {
 950         /**
 951          * lu_context is used on the client side too. Yet we don't want to
 952          * allocate values of server-side keys for the client contexts and
 953          * vice versa.
 954          *
 955          * To achieve this, set of tags in introduced. Contexts and keys are
 956          * marked with tags. Key value are created only for context whose set
 957          * of tags has non-empty intersection with one for key. Tags are taken
 958          * from enum lu_context_tag.
 959          */
 960         __u32                  lc_tags;
 961         enum lu_context_state  lc_state;
 962         /**
 963          * Pointer to the home service thread. NULL for other execution
 964          * contexts.
 965          */
 966         struct ptlrpc_thread  *lc_thread;
 967         /**
 968          * Pointer to an array with key values. Internal implementation
 969          * detail.
 970          */
 971         void                  **lc_value;
 972         /**
 973          * Linkage into a list of all remembered contexts. Only
 974          * `non-transient' contexts, i.e., ones created for service threads
 975          * are placed here.
 976          */
 977         struct list_head        lc_remember;
 978         /**
 979          * Version counter used to skip calls to lu_context_refill() when no
 980          * keys were registered.
 981          */
 982         unsigned                lc_version;
 983         /**
 984          * Debugging cookie.
 985          */
 986         unsigned                lc_cookie;
 987 };
 988
 989 /**
 990  * lu_context_key interface. Similar to pthread_key.
 991  */
 992
 993 enum lu_context_tag {
 994         /**
 995          * Thread on md server
 996          */
 997         LCT_MD_THREAD = 1 << 0,
 998         /**
 999          * Thread on dt server
1000          */
1001         LCT_DT_THREAD = 1 << 1,
1002         /**
1003          * Thread on client
1004          */
1005         LCT_CL_THREAD = 1 << 3,
1006         /**
1007          * A per-request session on a server, and a per-system-call session on
1008          * a client.
1009          */
1010         LCT_SESSION   = 1 << 4,
1011         /**
1012          * A per-request data on OSP device
1013          */
1014         LCT_OSP_THREAD = 1 << 5,
1015         /**
1016          * MGS device thread
1017          */
1018         LCT_MG_THREAD = 1 << 6,
1019         /**
1020          * Context for local operations
1021          */
1022         LCT_LOCAL = 1 << 7,
1023         /**
1024          * session for server thread
1025          **/
1026         LCT_SERVER_SESSION = 1 << 8,
1027         /**
1028          * Set when at least one of keys, having values in this context has
1029          * non-NULL lu_context_key::lct_exit() method. This is used to
1030          * optimize lu_context_exit() call.
1031          */
1032         LCT_HAS_EXIT  = 1 << 28,
1033         /**
1034          * Don't add references for modules creating key values in that context.
1035          * This is only for contexts used internally by lu_object framework.
1036          */
1037         LCT_NOREF     = 1 << 29,
1038         /**
1039          * Key is being prepared for retiring, don't create new values for it.
1040          */
1041         LCT_QUIESCENT = 1 << 30,
1042         /**
1043          * Context should be remembered.
1044          */
1045         LCT_REMEMBER  = 1 << 31,
1046         /**
1047          * Contexts usable in cache shrinker thread.
1048          */
1049         LCT_SHRINKER  = LCT_MD_THREAD|LCT_DT_THREAD|LCT_CL_THREAD|LCT_NOREF
1050 };
1051
1052 /**
1053  * Key. Represents per-context value slot.
1054  *
1055  * Keys are usually registered when module owning the key is initialized, and
1056  * de-registered when module is unloaded. Once key is registered, all new
1057  * contexts with matching tags, will get key value. "Old" contexts, already
1058  * initialized at the time of key registration, can be forced to get key value
1059  * by calling lu_context_refill().
1060  *
1061  * Every key value is counted in lu_context_key::lct_used and acquires a
1062  * reference on an owning module. This means, that all key values have to be
1063  * destroyed before module can be unloaded. This is usually achieved by
1064  * stopping threads started by the module, that created contexts in their
1065  * entry functions. Situation is complicated by the threads shared by multiple
1066  * modules, like ptlrpcd daemon on a client. To work around this problem,
1067  * contexts, created in such threads, are `remembered' (see
1068  * LCT_REMEMBER)---i.e., added into a global list. When module is preparing
1069  * for unloading it does the following:
1070  *
1071  *     - marks its keys as `quiescent' (lu_context_tag::LCT_QUIESCENT)
1072  *       preventing new key values from being allocated in the new contexts,
1073  *       and
1074  *
1075  *     - scans a list of remembered contexts, destroying values of module
1076  *       keys, thus releasing references to the module.
1077  *
1078  * This is done by lu_context_key_quiesce(). If module is re-activated
1079  * before key has been de-registered, lu_context_key_revive() call clears
1080  * `quiescent' marker.
1081  *
1082  * lu_context code doesn't provide any internal synchronization for these
1083  * activities---it's assumed that startup (including threads start-up) and
1084  * shutdown are serialized by some external means.
1085  *
1086  * \see lu_context
1087  */
1088 struct lu_context_key {
1089         /**
1090          * Set of tags for which values of this key are to be instantiated.
1091          */
1092         __u32 lct_tags;
1093         /**
1094          * Value constructor. This is called when new value is created for a
1095          * context. Returns pointer to new value of error pointer.
1096          */
1097         void  *(*lct_init)(const struct lu_context *ctx,
1098                            struct lu_context_key *key);
1099         /**
1100          * Value destructor. Called when context with previously allocated
1101          * value of this slot is destroyed. \a data is a value that was returned
1102          * by a matching call to lu_context_key::lct_init().
1103          */
1104         void   (*lct_fini)(const struct lu_context *ctx,
1105                            struct lu_context_key *key, void *data);
1106         /**
1107          * Optional method called on lu_context_exit() for all allocated
1108          * keys. Can be used by debugging code checking that locks are
1109          * released, etc.
1110          */
1111         void   (*lct_exit)(const struct lu_context *ctx,
1112                            struct lu_context_key *key, void *data);
1113         /**
1114          * Internal implementation detail: index within lu_context::lc_value[]
1115          * reserved for this key.
1116          */
1117         int             lct_index;
1118         /**
1119          * Internal implementation detail: number of values created for this
1120          * key.
1121          */
1122         atomic_t        lct_used;
1123         /**
1124          * Internal implementation detail: module for this key.
1125          */
1126         struct module   *lct_owner;
1127         /**
1128          * References to this key. For debugging.
1129          */
1130         struct lu_ref   lct_reference;
1131 };
1132
1133 #define LU_KEY_INIT(mod, type)                                    \
1134         static void *mod##_key_init(const struct lu_context *ctx, \
1135                                     struct lu_context_key *key)   \
1136         {                                                         \
1137                 type *value;                                      \
1138                                                                   \
1139                 CLASSERT(PAGE_SIZE >= sizeof(*value));            \
1140                                                                   \
1141                 OBD_ALLOC_PTR(value);                             \
1142                 if (value == NULL)                                \
1143                         value = ERR_PTR(-ENOMEM);                 \
1144                                                                   \
1145                 return value;                                     \
1146         }                                                         \
1147         struct __##mod##__dummy_init { ; } /* semicolon catcher */
1148
1149 #define LU_KEY_FINI(mod, type)                                              \
1150         static void mod##_key_fini(const struct lu_context *ctx,            \
1151                                     struct lu_context_key *key, void* data) \
1152         {                                                                   \
1153                 type *info = data;                                          \
1154                                                                             \
1155                 OBD_FREE_PTR(info);                                         \
1156         }                                                                   \
1157         struct __##mod##__dummy_fini {;} /* semicolon catcher */
1158
1159 #define LU_KEY_INIT_FINI(mod, type)   \
1160         LU_KEY_INIT(mod,type);        \
1161         LU_KEY_FINI(mod,type)
1162
1163 #define LU_CONTEXT_KEY_DEFINE(mod, tags)                \
1164         struct lu_context_key mod##_thread_key = {      \
1165                 .lct_tags = tags,                       \
1166                 .lct_init = mod##_key_init,             \
1167                 .lct_fini = mod##_key_fini              \
1168         }
1169
1170 #define LU_CONTEXT_KEY_INIT(key)                        \
1171 do {                                                    \
1172         (key)->lct_owner = THIS_MODULE;                 \
1173 } while (0)
1174
1175 int   lu_context_key_register(struct lu_context_key *key);
1176 void  lu_context_key_degister(struct lu_context_key *key);
1177 void *lu_context_key_get     (const struct lu_context *ctx,
1178                                const struct lu_context_key *key);
1179 void  lu_context_key_quiesce (struct lu_context_key *key);
1180 void  lu_context_key_revive  (struct lu_context_key *key);
1181
1182
1183 /*
1184  * LU_KEY_INIT_GENERIC() has to be a macro to correctly determine an
1185  * owning module.
1186  */
1187
1188 #define LU_KEY_INIT_GENERIC(mod)                                        \
1189         static void mod##_key_init_generic(struct lu_context_key *k, ...) \
1190         {                                                               \
1191                 struct lu_context_key *key = k;                         \
1192                 va_list args;                                           \
1193                                                                         \
1194                 va_start(args, k);                                      \
1195                 do {                                                    \
1196                         LU_CONTEXT_KEY_INIT(key);                       \
1197                         key = va_arg(args, struct lu_context_key *);    \
1198                 } while (key != NULL);                                  \
1199                 va_end(args);                                           \
1200         }
1201
1202 #define LU_TYPE_INIT(mod, ...)                                          \
1203         LU_KEY_INIT_GENERIC(mod)                                        \
1204         static int mod##_type_init(struct lu_device_type *t)            \
1205         {                                                               \
1206                 mod##_key_init_generic(__VA_ARGS__, NULL);              \
1207                 return lu_context_key_register_many(__VA_ARGS__, NULL); \
1208         }                                                               \
1209         struct __##mod##_dummy_type_init {;}
1210
1211 #define LU_TYPE_FINI(mod, ...)                                          \
1212         static void mod##_type_fini(struct lu_device_type *t)           \
1213         {                                                               \
1214                 lu_context_key_degister_many(__VA_ARGS__, NULL);        \
1215         }                                                               \
1216         struct __##mod##_dummy_type_fini {;}
1217
1218 #define LU_TYPE_START(mod, ...)                                 \
1219         static void mod##_type_start(struct lu_device_type *t)  \
1220         {                                                       \
1221                 lu_context_key_revive_many(__VA_ARGS__, NULL);  \
1222         }                                                       \
1223         struct __##mod##_dummy_type_start {;}
1224
1225 #define LU_TYPE_STOP(mod, ...)                                  \
1226         static void mod##_type_stop(struct lu_device_type *t)   \
1227         {                                                       \
1228                 lu_context_key_quiesce_many(__VA_ARGS__, NULL); \
1229         }                                                       \
1230         struct __##mod##_dummy_type_stop {;}
1231
1232
1233
1234 #define LU_TYPE_INIT_FINI(mod, ...)             \
1235         LU_TYPE_INIT(mod, __VA_ARGS__);         \
1236         LU_TYPE_FINI(mod, __VA_ARGS__);         \
1237         LU_TYPE_START(mod, __VA_ARGS__);        \
1238         LU_TYPE_STOP(mod, __VA_ARGS__)
1239
1240 int   lu_context_init  (struct lu_context *ctx, __u32 tags);
1241 void  lu_context_fini  (struct lu_context *ctx);
1242 void  lu_context_enter (struct lu_context *ctx);
1243 void  lu_context_exit  (struct lu_context *ctx);
1244 int   lu_context_refill(struct lu_context *ctx);
1245
1246 /*
1247  * Helper functions to operate on multiple keys. These are used by the default
1248  * device type operations, defined by LU_TYPE_INIT_FINI().
1249  */
1250
1251 int  lu_context_key_register_many(struct lu_context_key *k, ...);
1252 void lu_context_key_degister_many(struct lu_context_key *k, ...);
1253 void lu_context_key_revive_many  (struct lu_context_key *k, ...);
1254 void lu_context_key_quiesce_many (struct lu_context_key *k, ...);
1255
1256 /*
1257  * update/clear ctx/ses tags.
1258  */
1259 void lu_context_tags_update(__u32 tags);
1260 void lu_context_tags_clear(__u32 tags);
1261 void lu_session_tags_update(__u32 tags);
1262 void lu_session_tags_clear(__u32 tags);
1263
1264 /**
1265  * Environment.
1266  */
1267 struct lu_env {
1268         /**
1269          * "Local" context, used to store data instead of stack.
1270          */
1271         struct lu_context  le_ctx;
1272         /**
1273          * "Session" context for per-request data.
1274          */
1275         struct lu_context *le_ses;
1276 };
1277
1278 int  lu_env_init  (struct lu_env *env, __u32 tags);
1279 void lu_env_fini  (struct lu_env *env);
1280 int  lu_env_refill(struct lu_env *env);
1281 int  lu_env_refill_by_tags(struct lu_env *env, __u32 ctags, __u32 stags);
1282
1283 /** @} lu_context */
1284
1285 /**
1286  * Output site statistical counters into a buffer. Suitable for
1287  * ll_rd_*()-style functions.
1288  */
1289 int lu_site_stats_seq_print(const struct lu_site *s, struct seq_file *m);
1290
1291 /**
1292  * Common name structure to be passed around for various name related methods.
1293  */
1294 struct lu_name {
1295         const char    *ln_name;
1296         int            ln_namelen;
1297 };
1298
1299 /**
1300  * Validate names (path components)
1301  *
1302  * To be valid \a name must be non-empty, '\0' terminated of length \a
1303  * name_len, and not contain '/'. The maximum length of a name (before
1304  * say -ENAMETOOLONG will be returned) is really controlled by llite
1305  * and the server. We only check for something insane coming from bad
1306  * integer handling here.
1307  */
1308 static inline bool lu_name_is_valid_2(const char *name, size_t name_len)
1309 {
1310         return name != NULL &&
1311                name_len > 0 &&
1312                name_len < INT_MAX &&
1313                name[name_len] == '\0' &&
1314                strlen(name) == name_len &&
1315                memchr(name, '/', name_len) == NULL;
1316 }
1317
1318 static inline bool lu_name_is_valid(const struct lu_name *ln)
1319 {
1320         return lu_name_is_valid_2(ln->ln_name, ln->ln_namelen);
1321 }
1322
1323 #define DNAME "%.*s"
1324 #define PNAME(ln)                                       \
1325         (lu_name_is_valid(ln) ? (ln)->ln_namelen : 0),  \
1326         (lu_name_is_valid(ln) ? (ln)->ln_name : "")
1327
1328 /**
1329  * Common buffer structure to be passed around for various xattr_{s,g}et()
1330  * methods.
1331  */
1332 struct lu_buf {
1333         void   *lb_buf;
1334         size_t  lb_len;
1335 };
1336
1337 #define DLUBUF "(%p %zu)"
1338 #define PLUBUF(buf) (buf)->lb_buf, (buf)->lb_len
1339
1340 /* read buffer params, should be filled out by out */
1341 struct lu_rdbuf {
1342         /** number of buffers */
1343         unsigned int    rb_nbufs;
1344         /** pointers to buffers */
1345         struct lu_buf   rb_bufs[];
1346 };
1347
1348 /**
1349  * One-time initializers, called at obdclass module initialization, not
1350  * exported.
1351  */
1352
1353 /**
1354  * Initialization of global lu_* data.
1355  */
1356 int lu_global_init(void);
1357
1358 /**
1359  * Dual to lu_global_init().
1360  */
1361 void lu_global_fini(void);
1362
1363 struct lu_kmem_descr {
1364         struct kmem_cache **ckd_cache;
1365         const char       *ckd_name;
1366         const size_t      ckd_size;
1367 };
1368
1369 int  lu_kmem_init(struct lu_kmem_descr *caches);
1370 void lu_kmem_fini(struct lu_kmem_descr *caches);
1371
1372 void lu_object_assign_fid(const struct lu_env *env, struct lu_object *o,
1373                           const struct lu_fid *fid);
1374 struct lu_object *lu_object_anon(const struct lu_env *env,
1375                                  struct lu_device *dev,
1376                                  const struct lu_object_conf *conf);
1377
1378 /** null buffer */
1379 extern struct lu_buf LU_BUF_NULL;
1380
1381 void lu_buf_free(struct lu_buf *buf);
1382 void lu_buf_alloc(struct lu_buf *buf, size_t size);
1383 void lu_buf_realloc(struct lu_buf *buf, size_t size);
1384
1385 int lu_buf_check_and_grow(struct lu_buf *buf, size_t len);
1386 struct lu_buf *lu_buf_check_and_alloc(struct lu_buf *buf, size_t len);
1387
1388 extern __u32 lu_context_tags_default;
1389 extern __u32 lu_session_tags_default;
1390
1391 static inline bool lu_device_is_cl(const struct lu_device *d)
1392 {
1393         return d->ld_type->ldt_tags & LU_DEVICE_CL;
1394 }
1395
1396 static inline bool lu_object_is_cl(const struct lu_object *o)
1397 {
1398         return lu_device_is_cl(o->lo_dev);
1399 }
1400
1401 /** @} lu */
1402 #endif /* __LUSTRE_LU_OBJECT_H */