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