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