Whamcloud - gitweb
b475955e1c44dbdb10ad64ecd16f62a2b02a086b
[fs/lustre-release.git] / lustre / include / cl_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) 2008, 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 #ifndef _LUSTRE_CL_OBJECT_H
33 #define _LUSTRE_CL_OBJECT_H
34
35 /** \defgroup clio clio
36  *
37  * Client objects implement io operations and cache pages.
38  *
39  * Examples: lov and osc are implementations of cl interface.
40  *
41  * Big Theory Statement.
42  *
43  * Layered objects.
44  *
45  * Client implementation is based on the following data-types:
46  *
47  *   - cl_object
48  *
49  *   - cl_page
50  *
51  *   - cl_lock     represents an extent lock on an object.
52  *
53  *   - cl_io       represents high-level i/o activity such as whole read/write
54  *                 system call, or write-out of pages from under the lock being
55  *                 canceled. cl_io has sub-ios that can be stopped and resumed
56  *                 independently, thus achieving high degree of transfer
57  *                 parallelism. Single cl_io can be advanced forward by
58  *                 the multiple threads (although in the most usual case of
59  *                 read/write system call it is associated with the single user
60  *                 thread, that issued the system call).
61  *
62  * Terminology
63  *
64  *     - to avoid confusion high-level I/O operation like read or write system
65  *     call is referred to as "an io", whereas low-level I/O operation, like
66  *     RPC, is referred to as "a transfer"
67  *
68  *     - "generic code" means generic (not file system specific) code in the
69  *     hosting environment. "cl-code" means code (mostly in cl_*.c files) that
70  *     is not layer specific.
71  *
72  * Locking.
73  *
74  *  - i_mutex
75  *      - PG_locked
76  *          - cl_object_header::coh_page_guard
77  *          - lu_site::ls_guard
78  *
79  * See the top comment in cl_object.c for the description of overall locking and
80  * reference-counting design.
81  *
82  * See comments below for the description of i/o, page, and dlm-locking
83  * design.
84  *
85  * @{
86  */
87
88 /*
89  * super-class definitions.
90  */
91 #include <linux/aio.h>
92 #include <linux/fs.h>
93
94 #include <libcfs/libcfs.h>
95 #include <lu_object.h>
96 #include <linux/atomic.h>
97 #include <linux/mutex.h>
98 #include <linux/radix-tree.h>
99 #include <linux/spinlock.h>
100 #include <linux/wait.h>
101 #include <linux/pagevec.h>
102 #include <lustre_dlm.h>
103
104 struct obd_info;
105 struct inode;
106
107 struct cl_device;
108
109 struct cl_object;
110
111 struct cl_page;
112 struct cl_page_slice;
113 struct cl_lock;
114 struct cl_lock_slice;
115
116 struct cl_lock_operations;
117 struct cl_page_operations;
118
119 struct cl_io;
120 struct cl_io_slice;
121
122 struct cl_req_attr;
123
124 /**
125  * Device in the client stack.
126  *
127  * \see vvp_device, lov_device, lovsub_device, osc_device
128  */
129 struct cl_device {
130         /** Super-class. */
131         struct lu_device                   cd_lu_dev;
132 };
133
134 /** \addtogroup cl_object cl_object
135  * @{ */
136 /**
137  * "Data attributes" of cl_object. Data attributes can be updated
138  * independently for a sub-object, and top-object's attributes are calculated
139  * from sub-objects' ones.
140  */
141 struct cl_attr {
142         /** Object size, in bytes */
143         loff_t cat_size;
144         /**
145          * Known minimal size, in bytes.
146          *
147          * This is only valid when at least one DLM lock is held.
148          */
149         loff_t cat_kms;
150         /** Modification time. Measured in seconds since epoch. */
151         time64_t cat_mtime;
152         /** Access time. Measured in seconds since epoch. */
153         time64_t cat_atime;
154         /** Change time. Measured in seconds since epoch. */
155         time64_t cat_ctime;
156         /**
157          * Blocks allocated to this cl_object on the server file system.
158          *
159          * \todo XXX An interface for block size is needed.
160          */
161         __u64  cat_blocks;
162         /**
163          * User identifier for quota purposes.
164          */
165         uid_t  cat_uid;
166         /**
167          * Group identifier for quota purposes.
168          */
169         gid_t  cat_gid;
170
171         /* nlink of the directory */
172         __u64  cat_nlink;
173
174         /* Project identifier for quota purpose. */
175         __u32  cat_projid;
176 };
177
178 /**
179  * Fields in cl_attr that are being set.
180  */
181 enum cl_attr_valid {
182         CAT_SIZE   = 1 << 0,
183         CAT_KMS    = 1 << 1,
184         CAT_MTIME  = 1 << 3,
185         CAT_ATIME  = 1 << 4,
186         CAT_CTIME  = 1 << 5,
187         CAT_BLOCKS = 1 << 6,
188         CAT_UID    = 1 << 7,
189         CAT_GID    = 1 << 8,
190         CAT_PROJID = 1 << 9
191 };
192
193 /**
194  * Sub-class of lu_object with methods common for objects on the client
195  * stacks.
196  *
197  * cl_object: represents a regular file system object, both a file and a
198  *    stripe. cl_object is based on lu_object: it is identified by a fid,
199  *    layered, cached, hashed, and lrued. Important distinction with the server
200  *    side, where md_object and dt_object are used, is that cl_object "fans out"
201  *    at the lov/sns level: depending on the file layout, single file is
202  *    represented as a set of "sub-objects" (stripes). At the implementation
203  *    level, struct lov_object contains an array of cl_objects. Each sub-object
204  *    is a full-fledged cl_object, having its fid, living in the lru and hash
205  *    table.
206  *
207  *    This leads to the next important difference with the server side: on the
208  *    client, it's quite usual to have objects with the different sequence of
209  *    layers. For example, typical top-object is composed of the following
210  *    layers:
211  *
212  *        - vvp
213  *        - lov
214  *
215  *    whereas its sub-objects are composed of
216  *
217  *        - lovsub
218  *        - osc
219  *
220  *    layers. Here "lovsub" is a mostly dummy layer, whose purpose is to keep
221  *    track of the object-subobject relationship.
222  *
223  *    Sub-objects are not cached independently: when top-object is about to
224  *    be discarded from the memory, all its sub-objects are torn-down and
225  *    destroyed too.
226  *
227  * \see vvp_object, lov_object, lovsub_object, osc_object
228  */
229 struct cl_object {
230         /** super class */
231         struct lu_object                   co_lu;
232         /** per-object-layer operations */
233         const struct cl_object_operations *co_ops;
234         /** offset of page slice in cl_page buffer */
235         int                                co_slice_off;
236 };
237
238 /**
239  * Description of the client object configuration. This is used for the
240  * creation of a new client object that is identified by a more state than
241  * fid.
242  */
243 struct cl_object_conf {
244         /** Super-class. */
245         struct lu_object_conf     coc_lu;
246         union {
247                 /**
248                  * Object layout. This is consumed by lov.
249                  */
250                 struct lu_buf    coc_layout;
251                 /**
252                  * Description of particular stripe location in the
253                  * cluster. This is consumed by osc.
254                  */
255                 struct lov_oinfo *coc_oinfo;
256         } u;
257         /**
258          * VFS inode. This is consumed by vvp.
259          */
260         struct inode             *coc_inode;
261         /**
262          * Layout lock handle.
263          */
264         struct ldlm_lock         *coc_lock;
265         /**
266          * Operation to handle layout, OBJECT_CONF_XYZ.
267          */
268         int                       coc_opc;
269 };
270
271 enum {
272         /** configure layout, set up a new stripe, must be called while
273          * holding layout lock. */
274         OBJECT_CONF_SET = 0,
275         /** invalidate the current stripe configuration due to losing
276          * layout lock. */
277         OBJECT_CONF_INVALIDATE = 1,
278         /** wait for old layout to go away so that new layout can be
279          * set up. */
280         OBJECT_CONF_WAIT = 2
281 };
282
283 enum {
284         CL_LAYOUT_GEN_NONE      = (u32)-2,      /* layout lock was cancelled */
285         CL_LAYOUT_GEN_EMPTY     = (u32)-1,      /* for empty layout */
286 };
287
288 struct cl_layout {
289         /** the buffer to return the layout in lov_mds_md format. */
290         struct lu_buf   cl_buf;
291         /** size of layout in lov_mds_md format. */
292         size_t          cl_size;
293         /** size of DoM component if exists or zero otherwise */
294         u64             cl_dom_comp_size;
295         /** Layout generation. */
296         u32             cl_layout_gen;
297         /** whether layout is a composite one */
298         bool            cl_is_composite;
299         /** Whether layout is a HSM released one */
300         bool            cl_is_released;
301 };
302
303 /**
304  * Operations implemented for each cl object layer.
305  *
306  * \see vvp_ops, lov_ops, lovsub_ops, osc_ops
307  */
308 struct cl_object_operations {
309         /**
310          * Initialize page slice for this layer. Called top-to-bottom through
311          * every object layer when a new cl_page is instantiated. Layer
312          * keeping private per-page data, or requiring its own page operations
313          * vector should allocate these data here, and attach then to the page
314          * by calling cl_page_slice_add(). \a vmpage is locked (in the VM
315          * sense). Optional.
316          *
317          * \retval NULL success.
318          *
319          * \retval ERR_PTR(errno) failure code.
320          *
321          * \retval valid-pointer pointer to already existing referenced page
322          *         to be used instead of newly created.
323          */
324         int  (*coo_page_init)(const struct lu_env *env, struct cl_object *obj,
325                                 struct cl_page *page, pgoff_t index);
326         /**
327          * Initialize lock slice for this layer. Called top-to-bottom through
328          * every object layer when a new cl_lock is instantiated. Layer
329          * keeping private per-lock data, or requiring its own lock operations
330          * vector should allocate these data here, and attach then to the lock
331          * by calling cl_lock_slice_add(). Mandatory.
332          */
333         int  (*coo_lock_init)(const struct lu_env *env,
334                               struct cl_object *obj, struct cl_lock *lock,
335                               const struct cl_io *io);
336         /**
337          * Initialize io state for a given layer.
338          *
339          * called top-to-bottom once per io existence to initialize io
340          * state. If layer wants to keep some state for this type of io, it
341          * has to embed struct cl_io_slice in lu_env::le_ses, and register
342          * slice with cl_io_slice_add(). It is guaranteed that all threads
343          * participating in this io share the same session.
344          */
345         int  (*coo_io_init)(const struct lu_env *env,
346                             struct cl_object *obj, struct cl_io *io);
347         /**
348          * Fill portion of \a attr that this layer controls. This method is
349          * called top-to-bottom through all object layers.
350          *
351          * \pre cl_object_header::coh_attr_guard of the top-object is locked.
352          *
353          * \return   0: to continue
354          * \return +ve: to stop iterating through layers (but 0 is returned
355          *              from enclosing cl_object_attr_get())
356          * \return -ve: to signal error
357          */
358         int (*coo_attr_get)(const struct lu_env *env, struct cl_object *obj,
359                             struct cl_attr *attr);
360         /**
361          * Update attributes.
362          *
363          * \a valid is a bitmask composed from enum #cl_attr_valid, and
364          * indicating what attributes are to be set.
365          *
366          * \pre cl_object_header::coh_attr_guard of the top-object is locked.
367          *
368          * \return the same convention as for
369          * cl_object_operations::coo_attr_get() is used.
370          */
371         int (*coo_attr_update)(const struct lu_env *env, struct cl_object *obj,
372                                const struct cl_attr *attr, unsigned valid);
373         /**
374          * Update object configuration. Called top-to-bottom to modify object
375          * configuration.
376          *
377          * XXX error conditions and handling.
378          */
379         int (*coo_conf_set)(const struct lu_env *env, struct cl_object *obj,
380                             const struct cl_object_conf *conf);
381         /**
382          * Glimpse ast. Executed when glimpse ast arrives for a lock on this
383          * object. Layers are supposed to fill parts of \a lvb that will be
384          * shipped to the glimpse originator as a glimpse result.
385          *
386          * \see vvp_object_glimpse(), lovsub_object_glimpse(),
387          * \see osc_object_glimpse()
388          */
389         int (*coo_glimpse)(const struct lu_env *env,
390                            const struct cl_object *obj, struct ost_lvb *lvb);
391         /**
392          * Object prune method. Called when the layout is going to change on
393          * this object, therefore each layer has to clean up their cache,
394          * mainly pages and locks.
395          */
396         int (*coo_prune)(const struct lu_env *env, struct cl_object *obj);
397         /**
398          * Object getstripe method.
399          */
400         int (*coo_getstripe)(const struct lu_env *env, struct cl_object *obj,
401                              struct lov_user_md __user *lum, size_t size);
402         /**
403          * Get FIEMAP mapping from the object.
404          */
405         int (*coo_fiemap)(const struct lu_env *env, struct cl_object *obj,
406                           struct ll_fiemap_info_key *fmkey,
407                           struct fiemap *fiemap, size_t *buflen);
408         /**
409          * Get layout and generation of the object.
410          */
411         int (*coo_layout_get)(const struct lu_env *env, struct cl_object *obj,
412                               struct cl_layout *layout);
413         /**
414          * Get maximum size of the object.
415          */
416         loff_t (*coo_maxbytes)(struct cl_object *obj);
417         /**
418          * Set request attributes.
419          */
420         void (*coo_req_attr_set)(const struct lu_env *env,
421                                  struct cl_object *obj,
422                                  struct cl_req_attr *attr);
423         /**
424          * Flush \a obj data corresponding to \a lock. Used for DoM
425          * locks in llite's cancelling blocking ast callback.
426          */
427         int (*coo_object_flush)(const struct lu_env *env,
428                                 struct cl_object *obj,
429                                 struct ldlm_lock *lock);
430 };
431
432 /**
433  * Extended header for client object.
434  */
435 struct cl_object_header {
436         /** Standard lu_object_header. cl_object::co_lu::lo_header points
437          * here. */
438         struct lu_object_header coh_lu;
439
440         /**
441          * Parent object. It is assumed that an object has a well-defined
442          * parent, but not a well-defined child (there may be multiple
443          * sub-objects, for the same top-object). cl_object_header::coh_parent
444          * field allows certain code to be written generically, without
445          * limiting possible cl_object layouts unduly.
446          */
447         struct cl_object_header *coh_parent;
448         /**
449          * Protects consistency between cl_attr of parent object and
450          * attributes of sub-objects, that the former is calculated ("merged")
451          * from.
452          *
453          * \todo XXX this can be read/write lock if needed.
454          */
455         spinlock_t               coh_attr_guard;
456         /**
457          * Size of cl_page + page slices
458          */
459         unsigned short           coh_page_bufsize;
460         /**
461          * Number of objects above this one: 0 for a top-object, 1 for its
462          * sub-object, etc.
463          */
464         unsigned char            coh_nesting;
465 };
466
467 /**
468  * Helper macro: iterate over all layers of the object \a obj, assigning every
469  * layer top-to-bottom to \a slice.
470  */
471 #define cl_object_for_each(slice, obj)                          \
472         list_for_each_entry((slice),                            \
473                             &(obj)->co_lu.lo_header->loh_layers,\
474                             co_lu.lo_linkage)
475
476 /**
477  * Helper macro: iterate over all layers of the object \a obj, assigning every
478  * layer bottom-to-top to \a slice.
479  */
480 #define cl_object_for_each_reverse(slice, obj)                          \
481         list_for_each_entry_reverse((slice),                            \
482                                     &(obj)->co_lu.lo_header->loh_layers,\
483                                     co_lu.lo_linkage)
484
485 /** @} cl_object */
486
487 #define CL_PAGE_EOF ((pgoff_t)~0ull)
488
489 /** \addtogroup cl_page cl_page
490  * @{ */
491
492 /** \struct cl_page
493  * Layered client page.
494  *
495  * cl_page: represents a portion of a file, cached in the memory. All pages
496  *    of the given file are of the same size, and are kept in the radix tree
497  *    hanging off the cl_object. cl_page doesn't fan out, but as sub-objects
498  *    of the top-level file object are first class cl_objects, they have their
499  *    own radix trees of pages and hence page is implemented as a sequence of
500  *    struct cl_pages's, linked into double-linked list through
501  *    cl_page::cp_parent and cl_page::cp_child pointers, each residing in the
502  *    corresponding radix tree at the corresponding logical offset.
503  *
504  * cl_page is associated with VM page of the hosting environment (struct
505  *    page in Linux kernel, for example), struct page. It is assumed, that this
506  *    association is implemented by one of cl_page layers (top layer in the
507  *    current design) that
508  *
509  *        - intercepts per-VM-page call-backs made by the environment (e.g.,
510  *          memory pressure),
511  *
512  *        - translates state (page flag bits) and locking between lustre and
513  *          environment.
514  *
515  *    The association between cl_page and struct page is immutable and
516  *    established when cl_page is created.
517  *
518  * cl_page can be "owned" by a particular cl_io (see below), guaranteeing
519  *    this io an exclusive access to this page w.r.t. other io attempts and
520  *    various events changing page state (such as transfer completion, or
521  *    eviction of the page from the memory). Note, that in general cl_io
522  *    cannot be identified with a particular thread, and page ownership is not
523  *    exactly equal to the current thread holding a lock on the page. Layer
524  *    implementing association between cl_page and struct page has to implement
525  *    ownership on top of available synchronization mechanisms.
526  *
527  *    While lustre client maintains the notion of an page ownership by io,
528  *    hosting MM/VM usually has its own page concurrency control
529  *    mechanisms. For example, in Linux, page access is synchronized by the
530  *    per-page PG_locked bit-lock, and generic kernel code (generic_file_*())
531  *    takes care to acquire and release such locks as necessary around the
532  *    calls to the file system methods (->readpage(), ->prepare_write(),
533  *    ->commit_write(), etc.). This leads to the situation when there are two
534  *    different ways to own a page in the client:
535  *
536  *        - client code explicitly and voluntary owns the page (cl_page_own());
537  *
538  *        - VM locks a page and then calls the client, that has "to assume"
539  *          the ownership from the VM (cl_page_assume()).
540  *
541  *    Dual methods to release ownership are cl_page_disown() and
542  *    cl_page_unassume().
543  *
544  * cl_page is reference counted (cl_page::cp_ref). When reference counter
545  *    drops to 0, the page is returned to the cache, unless it is in
546  *    cl_page_state::CPS_FREEING state, in which case it is immediately
547  *    destroyed.
548  *
549  *    The general logic guaranteeing the absence of "existential races" for
550  *    pages is the following:
551  *
552  *        - there are fixed known ways for a thread to obtain a new reference
553  *          to a page:
554  *
555  *            - by doing a lookup in the cl_object radix tree, protected by the
556  *              spin-lock;
557  *
558  *            - by starting from VM-locked struct page and following some
559  *              hosting environment method (e.g., following ->private pointer in
560  *              the case of Linux kernel), see cl_vmpage_page();
561  *
562  *        - when the page enters cl_page_state::CPS_FREEING state, all these
563  *          ways are severed with the proper synchronization
564  *          (cl_page_delete());
565  *
566  *        - entry into cl_page_state::CPS_FREEING is serialized by the VM page
567  *          lock;
568  *
569  *        - no new references to the page in cl_page_state::CPS_FREEING state
570  *          are allowed (checked in cl_page_get()).
571  *
572  *    Together this guarantees that when last reference to a
573  *    cl_page_state::CPS_FREEING page is released, it is safe to destroy the
574  *    page, as neither references to it can be acquired at that point, nor
575  *    ones exist.
576  *
577  * cl_page is a state machine. States are enumerated in enum
578  *    cl_page_state. Possible state transitions are enumerated in
579  *    cl_page_state_set(). State transition process (i.e., actual changing of
580  *    cl_page::cp_state field) is protected by the lock on the underlying VM
581  *    page.
582  *
583  * Linux Kernel implementation.
584  *
585  *    Binding between cl_page and struct page (which is a typedef for
586  *    struct page) is implemented in the vvp layer. cl_page is attached to the
587  *    ->private pointer of the struct page, together with the setting of
588  *    PG_private bit in page->flags, and acquiring additional reference on the
589  *    struct page (much like struct buffer_head, or any similar file system
590  *    private data structures).
591  *
592  *    PG_locked lock is used to implement both ownership and transfer
593  *    synchronization, that is, page is VM-locked in CPS_{OWNED,PAGE{IN,OUT}}
594  *    states. No additional references are acquired for the duration of the
595  *    transfer.
596  *
597  * \warning *THIS IS NOT* the behavior expected by the Linux kernel, where
598  *          write-out is "protected" by the special PG_writeback bit.
599  */
600
601 /**
602  * States of cl_page. cl_page.c assumes particular order here.
603  *
604  * The page state machine is rather crude, as it doesn't recognize finer page
605  * states like "dirty" or "up to date". This is because such states are not
606  * always well defined for the whole stack (see, for example, the
607  * implementation of the read-ahead, that hides page up-to-dateness to track
608  * cache hits accurately). Such sub-states are maintained by the layers that
609  * are interested in them.
610  */
611 enum cl_page_state {
612         /**
613          * Page is in the cache, un-owned. Page leaves cached state in the
614          * following cases:
615          *
616          *     - [cl_page_state::CPS_OWNED] io comes across the page and
617          *     owns it;
618          *
619          *     - [cl_page_state::CPS_PAGEOUT] page is dirty, the
620          *     req-formation engine decides that it wants to include this page
621          *     into an RPC being constructed, and yanks it from the cache;
622          *
623          *     - [cl_page_state::CPS_FREEING] VM callback is executed to
624          *     evict the page form the memory;
625          *
626          * \invariant cl_page::cp_owner == NULL && cl_page::cp_req == NULL
627          */
628         CPS_CACHED,
629         /**
630          * Page is exclusively owned by some cl_io. Page may end up in this
631          * state as a result of
632          *
633          *     - io creating new page and immediately owning it;
634          *
635          *     - [cl_page_state::CPS_CACHED] io finding existing cached page
636          *     and owning it;
637          *
638          *     - [cl_page_state::CPS_OWNED] io finding existing owned page
639          *     and waiting for owner to release the page;
640          *
641          * Page leaves owned state in the following cases:
642          *
643          *     - [cl_page_state::CPS_CACHED] io decides to leave the page in
644          *     the cache, doing nothing;
645          *
646          *     - [cl_page_state::CPS_PAGEIN] io starts read transfer for
647          *     this page;
648          *
649          *     - [cl_page_state::CPS_PAGEOUT] io starts immediate write
650          *     transfer for this page;
651          *
652          *     - [cl_page_state::CPS_FREEING] io decides to destroy this
653          *     page (e.g., as part of truncate or extent lock cancellation).
654          *
655          * \invariant cl_page::cp_owner != NULL && cl_page::cp_req == NULL
656          */
657         CPS_OWNED,
658         /**
659          * Page is being written out, as a part of a transfer. This state is
660          * entered when req-formation logic decided that it wants this page to
661          * be sent through the wire _now_. Specifically, it means that once
662          * this state is achieved, transfer completion handler (with either
663          * success or failure indication) is guaranteed to be executed against
664          * this page independently of any locks and any scheduling decisions
665          * made by the hosting environment (that effectively means that the
666          * page is never put into cl_page_state::CPS_PAGEOUT state "in
667          * advance". This property is mentioned, because it is important when
668          * reasoning about possible dead-locks in the system). The page can
669          * enter this state as a result of
670          *
671          *     - [cl_page_state::CPS_OWNED] an io requesting an immediate
672          *     write-out of this page, or
673          *
674          *     - [cl_page_state::CPS_CACHED] req-forming engine deciding
675          *     that it has enough dirty pages cached to issue a "good"
676          *     transfer.
677          *
678          * The page leaves cl_page_state::CPS_PAGEOUT state when the transfer
679          * is completed---it is moved into cl_page_state::CPS_CACHED state.
680          *
681          * Underlying VM page is locked for the duration of transfer.
682          *
683          * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req != NULL
684          */
685         CPS_PAGEOUT,
686         /**
687          * Page is being read in, as a part of a transfer. This is quite
688          * similar to the cl_page_state::CPS_PAGEOUT state, except that
689          * read-in is always "immediate"---there is no such thing a sudden
690          * construction of read request from cached, presumably not up to date,
691          * pages.
692          *
693          * Underlying VM page is locked for the duration of transfer.
694          *
695          * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req != NULL
696          */
697         CPS_PAGEIN,
698         /**
699          * Page is being destroyed. This state is entered when client decides
700          * that page has to be deleted from its host object, as, e.g., a part
701          * of truncate.
702          *
703          * Once this state is reached, there is no way to escape it.
704          *
705          * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req == NULL
706          */
707         CPS_FREEING,
708         CPS_NR
709 };
710
711 enum cl_page_type {
712         /** Host page, the page is from the host inode which the cl_page
713          * belongs to. */
714         CPT_CACHEABLE = 1,
715
716         /** Transient page, the transient cl_page is used to bind a cl_page
717          *  to vmpage which is not belonging to the same object of cl_page.
718          *  it is used in DirectIO and lockless IO. */
719         CPT_TRANSIENT,
720 };
721
722 /**
723  * Fields are protected by the lock on struct page, except for atomics and
724  * immutables.
725  *
726  * \invariant Data type invariants are in cl_page_invariant(). Basically:
727  * cl_page::cp_parent and cl_page::cp_child are a well-formed double-linked
728  * list, consistent with the parent/child pointers in the cl_page::cp_obj and
729  * cl_page::cp_owner (when set).
730  */
731 struct cl_page {
732         /** Reference counter. */
733         atomic_t                 cp_ref;
734         /** An object this page is a part of. Immutable after creation. */
735         struct cl_object        *cp_obj;
736         /** vmpage */
737         struct page             *cp_vmpage;
738         /** Linkage of pages within group. Pages must be owned */
739         struct list_head         cp_batch;
740         /** List of slices. Immutable after creation. */
741         struct list_head         cp_layers;
742         /**
743          * Page state. This field is const to avoid accidental update, it is
744          * modified only internally within cl_page.c. Protected by a VM lock.
745          */
746         const enum cl_page_state cp_state;
747         /**
748          * Page type. Only CPT_TRANSIENT is used so far. Immutable after
749          * creation.
750          */
751         enum cl_page_type        cp_type;
752
753         /**
754          * Owning IO in cl_page_state::CPS_OWNED state. Sub-page can be owned
755          * by sub-io. Protected by a VM lock.
756          */
757         struct cl_io            *cp_owner;
758         /** List of references to this page, for debugging. */
759         struct lu_ref            cp_reference;
760         /** Link to an object, for debugging. */
761         struct lu_ref_link       cp_obj_ref;
762         /** Link to a queue, for debugging. */
763         struct lu_ref_link       cp_queue_ref;
764         /** Assigned if doing a sync_io */
765         struct cl_sync_io       *cp_sync_io;
766         /** layout_entry + stripe index, composed using lov_comp_index() */
767         unsigned int            cp_lov_index;
768 };
769
770 /**
771  * Per-layer part of cl_page.
772  *
773  * \see vvp_page, lov_page, osc_page
774  */
775 struct cl_page_slice {
776         struct cl_page                  *cpl_page;
777         pgoff_t                          cpl_index;
778         /**
779          * Object slice corresponding to this page slice. Immutable after
780          * creation.
781          */
782         struct cl_object                *cpl_obj;
783         const struct cl_page_operations *cpl_ops;
784         /** Linkage into cl_page::cp_layers. Immutable after creation. */
785         struct list_head                 cpl_linkage;
786 };
787
788 /**
789  * Lock mode. For the client extent locks.
790  *
791  * \ingroup cl_lock
792  */
793 enum cl_lock_mode {
794         CLM_READ,
795         CLM_WRITE,
796         CLM_GROUP,
797         CLM_MAX,
798 };
799
800 /**
801  * Requested transfer type.
802  */
803 enum cl_req_type {
804         CRT_READ,
805         CRT_WRITE,
806         CRT_NR
807 };
808
809 /**
810  * Per-layer page operations.
811  *
812  * Methods taking an \a io argument are for the activity happening in the
813  * context of given \a io. Page is assumed to be owned by that io, except for
814  * the obvious cases (like cl_page_operations::cpo_own()).
815  *
816  * \see vvp_page_ops, lov_page_ops, osc_page_ops
817  */
818 struct cl_page_operations {
819         /**
820          * cl_page<->struct page methods. Only one layer in the stack has to
821          * implement these. Current code assumes that this functionality is
822          * provided by the topmost layer, see cl_page_disown0() as an example.
823          */
824
825         /**
826          * Called when \a io acquires this page into the exclusive
827          * ownership. When this method returns, it is guaranteed that the is
828          * not owned by other io, and no transfer is going on against
829          * it. Optional.
830          *
831          * \see cl_page_own()
832          * \see vvp_page_own(), lov_page_own()
833          */
834         int  (*cpo_own)(const struct lu_env *env,
835                         const struct cl_page_slice *slice,
836                         struct cl_io *io, int nonblock);
837         /** Called when ownership it yielded. Optional.
838          *
839          * \see cl_page_disown()
840          * \see vvp_page_disown()
841          */
842         void (*cpo_disown)(const struct lu_env *env,
843                            const struct cl_page_slice *slice, struct cl_io *io);
844         /**
845          * Called for a page that is already "owned" by \a io from VM point of
846          * view. Optional.
847          *
848          * \see cl_page_assume()
849          * \see vvp_page_assume(), lov_page_assume()
850          */
851         void (*cpo_assume)(const struct lu_env *env,
852                            const struct cl_page_slice *slice, struct cl_io *io);
853         /** Dual to cl_page_operations::cpo_assume(). Optional. Called
854          * bottom-to-top when IO releases a page without actually unlocking
855          * it.
856          *
857          * \see cl_page_unassume()
858          * \see vvp_page_unassume()
859          */
860         void (*cpo_unassume)(const struct lu_env *env,
861                              const struct cl_page_slice *slice,
862                              struct cl_io *io);
863         /**
864          * Announces whether the page contains valid data or not by \a uptodate.
865          *
866          * \see cl_page_export()
867          * \see vvp_page_export()
868          */
869         void  (*cpo_export)(const struct lu_env *env,
870                             const struct cl_page_slice *slice, int uptodate);
871         /**
872          * Checks whether underlying VM page is locked (in the suitable
873          * sense). Used for assertions.
874          *
875          * \retval    -EBUSY: page is protected by a lock of a given mode;
876          * \retval  -ENODATA: page is not protected by a lock;
877          * \retval         0: this layer cannot decide. (Should never happen.)
878          */
879         int (*cpo_is_vmlocked)(const struct lu_env *env,
880                                const struct cl_page_slice *slice);
881
882         /**
883          * Update file attributes when all we have is this page.  Used for tiny
884          * writes to update attributes when we don't have a full cl_io.
885          */
886         void (*cpo_page_touch)(const struct lu_env *env,
887                                const struct cl_page_slice *slice, size_t to);
888         /**
889          * Page destruction.
890          */
891
892         /**
893          * Called when page is truncated from the object. Optional.
894          *
895          * \see cl_page_discard()
896          * \see vvp_page_discard(), osc_page_discard()
897          */
898         void (*cpo_discard)(const struct lu_env *env,
899                             const struct cl_page_slice *slice,
900                             struct cl_io *io);
901         /**
902          * Called when page is removed from the cache, and is about to being
903          * destroyed. Optional.
904          *
905          * \see cl_page_delete()
906          * \see vvp_page_delete(), osc_page_delete()
907          */
908         void (*cpo_delete)(const struct lu_env *env,
909                            const struct cl_page_slice *slice);
910         /** Destructor. Frees resources and slice itself. */
911         void (*cpo_fini)(const struct lu_env *env,
912                          struct cl_page_slice *slice,
913                          struct pagevec *pvec);
914         /**
915          * Optional debugging helper. Prints given page slice.
916          *
917          * \see cl_page_print()
918          */
919         int (*cpo_print)(const struct lu_env *env,
920                          const struct cl_page_slice *slice,
921                          void *cookie, lu_printer_t p);
922         /**
923          * \name transfer
924          *
925          * Transfer methods.
926          *
927          * @{
928          */
929         /**
930          * Request type dependent vector of operations.
931          *
932          * Transfer operations depend on transfer mode (cl_req_type). To avoid
933          * passing transfer mode to each and every of these methods, and to
934          * avoid branching on request type inside of the methods, separate
935          * methods for cl_req_type:CRT_READ and cl_req_type:CRT_WRITE are
936          * provided. That is, method invocation usually looks like
937          *
938          *         slice->cp_ops.io[req->crq_type].cpo_method(env, slice, ...);
939          */
940         struct {
941                 /**
942                  * Called when a page is submitted for a transfer as a part of
943                  * cl_page_list.
944                  *
945                  * \return    0         : page is eligible for submission;
946                  * \return    -EALREADY : skip this page;
947                  * \return    -ve       : error.
948                  *
949                  * \see cl_page_prep()
950                  */
951                 int  (*cpo_prep)(const struct lu_env *env,
952                                  const struct cl_page_slice *slice,
953                                  struct cl_io *io);
954                 /**
955                  * Completion handler. This is guaranteed to be eventually
956                  * fired after cl_page_operations::cpo_prep() or
957                  * cl_page_operations::cpo_make_ready() call.
958                  *
959                  * This method can be called in a non-blocking context. It is
960                  * guaranteed however, that the page involved and its object
961                  * are pinned in memory (and, hence, calling cl_page_put() is
962                  * safe).
963                  *
964                  * \see cl_page_completion()
965                  */
966                 void (*cpo_completion)(const struct lu_env *env,
967                                        const struct cl_page_slice *slice,
968                                        int ioret);
969                 /**
970                  * Called when cached page is about to be added to the
971                  * ptlrpc request as a part of req formation.
972                  *
973                  * \return    0       : proceed with this page;
974                  * \return    -EAGAIN : skip this page;
975                  * \return    -ve     : error.
976                  *
977                  * \see cl_page_make_ready()
978                  */
979                 int  (*cpo_make_ready)(const struct lu_env *env,
980                                        const struct cl_page_slice *slice);
981         } io[CRT_NR];
982         /**
983          * Tell transfer engine that only [to, from] part of a page should be
984          * transmitted.
985          *
986          * This is used for immediate transfers.
987          *
988          * \todo XXX this is not very good interface. It would be much better
989          * if all transfer parameters were supplied as arguments to
990          * cl_io_operations::cio_submit() call, but it is not clear how to do
991          * this for page queues.
992          *
993          * \see cl_page_clip()
994          */
995         void (*cpo_clip)(const struct lu_env *env,
996                          const struct cl_page_slice *slice,
997                          int from, int to);
998         /**
999          * \pre  the page was queued for transferring.
1000          * \post page is removed from client's pending list, or -EBUSY
1001          *       is returned if it has already been in transferring.
1002          *
1003          * This is one of seldom page operation which is:
1004          * 0. called from top level;
1005          * 1. don't have vmpage locked;
1006          * 2. every layer should synchronize execution of its ->cpo_cancel()
1007          *    with completion handlers. Osc uses client obd lock for this
1008          *    purpose. Based on there is no vvp_page_cancel and
1009          *    lov_page_cancel(), cpo_cancel is defacto protected by client lock.
1010          *
1011          * \see osc_page_cancel().
1012          */
1013         int (*cpo_cancel)(const struct lu_env *env,
1014                           const struct cl_page_slice *slice);
1015         /**
1016          * Write out a page by kernel. This is only called by ll_writepage
1017          * right now.
1018          *
1019          * \see cl_page_flush()
1020          */
1021         int (*cpo_flush)(const struct lu_env *env,
1022                          const struct cl_page_slice *slice,
1023                          struct cl_io *io);
1024         /** @} transfer */
1025 };
1026
1027 /**
1028  * Helper macro, dumping detailed information about \a page into a log.
1029  */
1030 #define CL_PAGE_DEBUG(mask, env, page, format, ...)                     \
1031 do {                                                                    \
1032         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
1033                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);        \
1034                 cl_page_print(env, &msgdata, lu_cdebug_printer, page);  \
1035                 CDEBUG(mask, format , ## __VA_ARGS__);                  \
1036         }                                                               \
1037 } while (0)
1038
1039 /**
1040  * Helper macro, dumping shorter information about \a page into a log.
1041  */
1042 #define CL_PAGE_HEADER(mask, env, page, format, ...)                          \
1043 do {                                                                          \
1044         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                         \
1045                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);              \
1046                 cl_page_header_print(env, &msgdata, lu_cdebug_printer, page); \
1047                 CDEBUG(mask, format , ## __VA_ARGS__);                        \
1048         }                                                                     \
1049 } while (0)
1050
1051 static inline struct page *cl_page_vmpage(const struct cl_page *page)
1052 {
1053         LASSERT(page->cp_vmpage != NULL);
1054         return page->cp_vmpage;
1055 }
1056
1057 /**
1058  * Check if a cl_page is in use.
1059  *
1060  * Client cache holds a refcount, this refcount will be dropped when
1061  * the page is taken out of cache, see vvp_page_delete().
1062  */
1063 static inline bool __page_in_use(const struct cl_page *page, int refc)
1064 {
1065         return (atomic_read(&page->cp_ref) > refc + 1);
1066 }
1067
1068 /**
1069  * Caller itself holds a refcount of cl_page.
1070  */
1071 #define cl_page_in_use(pg)       __page_in_use(pg, 1)
1072 /**
1073  * Caller doesn't hold a refcount.
1074  */
1075 #define cl_page_in_use_noref(pg) __page_in_use(pg, 0)
1076
1077 /** @} cl_page */
1078
1079 /** \addtogroup cl_lock cl_lock
1080  * @{ */
1081 /** \struct cl_lock
1082  *
1083  * Extent locking on the client.
1084  *
1085  * LAYERING
1086  *
1087  * The locking model of the new client code is built around
1088  *
1089  *        struct cl_lock
1090  *
1091  * data-type representing an extent lock on a regular file. cl_lock is a
1092  * layered object (much like cl_object and cl_page), it consists of a header
1093  * (struct cl_lock) and a list of layers (struct cl_lock_slice), linked to
1094  * cl_lock::cll_layers list through cl_lock_slice::cls_linkage.
1095  *
1096  * Typical cl_lock consists of one layer:
1097  *
1098  *     - lov_lock (lov specific data).
1099  *
1100  * lov_lock contains an array of sub-locks. Each of these sub-locks is a
1101  * normal cl_lock: it has a header (struct cl_lock) and a list of layers:
1102  *
1103  *     - osc_lock
1104  *
1105  * Each sub-lock is associated with a cl_object (representing stripe
1106  * sub-object or the file to which top-level cl_lock is associated to), and is
1107  * linked into that cl_object::coh_locks. In this respect cl_lock is similar to
1108  * cl_object (that at lov layer also fans out into multiple sub-objects), and
1109  * is different from cl_page, that doesn't fan out (there is usually exactly
1110  * one osc_page for every vvp_page). We shall call vvp-lov portion of the lock
1111  * a "top-lock" and its lovsub-osc portion a "sub-lock".
1112  *
1113  * LIFE CYCLE
1114  *
1115  * cl_lock is a cacheless data container for the requirements of locks to
1116  * complete the IO. cl_lock is created before I/O starts and destroyed when the
1117  * I/O is complete.
1118  *
1119  * cl_lock depends on LDLM lock to fulfill lock semantics. LDLM lock is attached
1120  * to cl_lock at OSC layer. LDLM lock is still cacheable.
1121  *
1122  * INTERFACE AND USAGE
1123  *
1124  * Two major methods are supported for cl_lock: clo_enqueue and clo_cancel.  A
1125  * cl_lock is enqueued by cl_lock_request(), which will call clo_enqueue()
1126  * methods for each layer to enqueue the lock. At the LOV layer, if a cl_lock
1127  * consists of multiple sub cl_locks, each sub locks will be enqueued
1128  * correspondingly. At OSC layer, the lock enqueue request will tend to reuse
1129  * cached LDLM lock; otherwise a new LDLM lock will have to be requested from
1130  * OST side.
1131  *
1132  * cl_lock_cancel() must be called to release a cl_lock after use. clo_cancel()
1133  * method will be called for each layer to release the resource held by this
1134  * lock. At OSC layer, the reference count of LDLM lock, which is held at
1135  * clo_enqueue time, is released.
1136  *
1137  * LDLM lock can only be canceled if there is no cl_lock using it.
1138  *
1139  * Overall process of the locking during IO operation is as following:
1140  *
1141  *     - once parameters for IO are setup in cl_io, cl_io_operations::cio_lock()
1142  *       is called on each layer. Responsibility of this method is to add locks,
1143  *       needed by a given layer into cl_io.ci_lockset.
1144  *
1145  *     - once locks for all layers were collected, they are sorted to avoid
1146  *       dead-locks (cl_io_locks_sort()), and enqueued.
1147  *
1148  *     - when all locks are acquired, IO is performed;
1149  *
1150  *     - locks are released after IO is complete.
1151  *
1152  * Striping introduces major additional complexity into locking. The
1153  * fundamental problem is that it is generally unsafe to actively use (hold)
1154  * two locks on the different OST servers at the same time, as this introduces
1155  * inter-server dependency and can lead to cascading evictions.
1156  *
1157  * Basic solution is to sub-divide large read/write IOs into smaller pieces so
1158  * that no multi-stripe locks are taken (note that this design abandons POSIX
1159  * read/write semantics). Such pieces ideally can be executed concurrently. At
1160  * the same time, certain types of IO cannot be sub-divived, without
1161  * sacrificing correctness. This includes:
1162  *
1163  *  - O_APPEND write, where [0, EOF] lock has to be taken, to guarantee
1164  *  atomicity;
1165  *
1166  *  - ftruncate(fd, offset), where [offset, EOF] lock has to be taken.
1167  *
1168  * Also, in the case of read(fd, buf, count) or write(fd, buf, count), where
1169  * buf is a part of memory mapped Lustre file, a lock or locks protecting buf
1170  * has to be held together with the usual lock on [offset, offset + count].
1171  *
1172  * Interaction with DLM
1173  *
1174  * In the expected setup, cl_lock is ultimately backed up by a collection of
1175  * DLM locks (struct ldlm_lock). Association between cl_lock and DLM lock is
1176  * implemented in osc layer, that also matches DLM events (ASTs, cancellation,
1177  * etc.) into cl_lock_operation calls. See struct osc_lock for a more detailed
1178  * description of interaction with DLM.
1179  */
1180
1181 /**
1182  * Lock description.
1183  */
1184 struct cl_lock_descr {
1185         /** Object this lock is granted for. */
1186         struct cl_object *cld_obj;
1187         /** Index of the first page protected by this lock. */
1188         pgoff_t           cld_start;
1189         /** Index of the last page (inclusive) protected by this lock. */
1190         pgoff_t           cld_end;
1191         /** Group ID, for group lock */
1192         __u64             cld_gid;
1193         /** Lock mode. */
1194         enum cl_lock_mode cld_mode;
1195         /**
1196          * flags to enqueue lock. A combination of bit-flags from
1197          * enum cl_enq_flags.
1198          */
1199         __u32             cld_enq_flags;
1200 };
1201
1202 #define DDESCR "%s(%d):[%lu, %lu]:%x"
1203 #define PDESCR(descr)                                                   \
1204         cl_lock_mode_name((descr)->cld_mode), (descr)->cld_mode,        \
1205         (descr)->cld_start, (descr)->cld_end, (descr)->cld_enq_flags
1206
1207 const char *cl_lock_mode_name(const enum cl_lock_mode mode);
1208
1209 /**
1210  * Layered client lock.
1211  */
1212 struct cl_lock {
1213         /** List of slices. Immutable after creation. */
1214         struct list_head      cll_layers;
1215         /** lock attribute, extent, cl_object, etc. */
1216         struct cl_lock_descr  cll_descr;
1217 };
1218
1219 /**
1220  * Per-layer part of cl_lock
1221  *
1222  * \see lov_lock, osc_lock
1223  */
1224 struct cl_lock_slice {
1225         struct cl_lock                  *cls_lock;
1226         /** Object slice corresponding to this lock slice. Immutable after
1227          * creation. */
1228         struct cl_object                *cls_obj;
1229         const struct cl_lock_operations *cls_ops;
1230         /** Linkage into cl_lock::cll_layers. Immutable after creation. */
1231         struct list_head                 cls_linkage;
1232 };
1233
1234 /**
1235  *
1236  * \see lov_lock_ops, osc_lock_ops
1237  */
1238 struct cl_lock_operations {
1239         /** @{ */
1240         /**
1241          * Attempts to enqueue the lock. Called top-to-bottom.
1242          *
1243          * \retval 0    this layer has enqueued the lock successfully
1244          * \retval >0   this layer has enqueued the lock, but need to wait on
1245          *              @anchor for resources
1246          * \retval -ve  failure
1247          *
1248          * \see lov_lock_enqueue(), osc_lock_enqueue()
1249          */
1250         int  (*clo_enqueue)(const struct lu_env *env,
1251                             const struct cl_lock_slice *slice,
1252                             struct cl_io *io, struct cl_sync_io *anchor);
1253         /**
1254          * Cancel a lock, release its DLM lock ref, while does not cancel the
1255          * DLM lock
1256          */
1257         void (*clo_cancel)(const struct lu_env *env,
1258                            const struct cl_lock_slice *slice);
1259         /** @} */
1260         /**
1261          * Destructor. Frees resources and the slice.
1262          *
1263          * \see lov_lock_fini(), osc_lock_fini()
1264          */
1265         void (*clo_fini)(const struct lu_env *env, struct cl_lock_slice *slice);
1266         /**
1267          * Optional debugging helper. Prints given lock slice.
1268          */
1269         int (*clo_print)(const struct lu_env *env,
1270                          void *cookie, lu_printer_t p,
1271                          const struct cl_lock_slice *slice);
1272 };
1273
1274 #define CL_LOCK_DEBUG(mask, env, lock, format, ...)                     \
1275 do {                                                                    \
1276         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
1277                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);        \
1278                 cl_lock_print(env, &msgdata, lu_cdebug_printer, lock);  \
1279                 CDEBUG(mask, format , ## __VA_ARGS__);                  \
1280         }                                                               \
1281 } while (0)
1282
1283 #define CL_LOCK_ASSERT(expr, env, lock) do {                            \
1284         if (likely(expr))                                               \
1285                 break;                                                  \
1286                                                                         \
1287         CL_LOCK_DEBUG(D_ERROR, env, lock, "failed at %s.\n", #expr);    \
1288         LBUG();                                                         \
1289 } while (0)
1290
1291 /** @} cl_lock */
1292
1293 /** \addtogroup cl_page_list cl_page_list
1294  * Page list used to perform collective operations on a group of pages.
1295  *
1296  * Pages are added to the list one by one. cl_page_list acquires a reference
1297  * for every page in it. Page list is used to perform collective operations on
1298  * pages:
1299  *
1300  *     - submit pages for an immediate transfer,
1301  *
1302  *     - own pages on behalf of certain io (waiting for each page in turn),
1303  *
1304  *     - discard pages.
1305  *
1306  * When list is finalized, it releases references on all pages it still has.
1307  *
1308  * \todo XXX concurrency control.
1309  *
1310  * @{
1311  */
1312 struct cl_page_list {
1313         unsigned                 pl_nr;
1314         struct list_head         pl_pages;
1315         struct task_struct      *pl_owner;
1316 };
1317
1318 /**
1319  * A 2-queue of pages. A convenience data-type for common use case, 2-queue
1320  * contains an incoming page list and an outgoing page list.
1321  */
1322 struct cl_2queue {
1323         struct cl_page_list c2_qin;
1324         struct cl_page_list c2_qout;
1325 };
1326
1327 /** @} cl_page_list */
1328
1329 /** \addtogroup cl_io cl_io
1330  * @{ */
1331 /** \struct cl_io
1332  * I/O
1333  *
1334  * cl_io represents a high level I/O activity like
1335  * read(2)/write(2)/truncate(2) system call, or cancellation of an extent
1336  * lock.
1337  *
1338  * cl_io is a layered object, much like cl_{object,page,lock} but with one
1339  * important distinction. We want to minimize number of calls to the allocator
1340  * in the fast path, e.g., in the case of read(2) when everything is cached:
1341  * client already owns the lock over region being read, and data are cached
1342  * due to read-ahead. To avoid allocation of cl_io layers in such situations,
1343  * per-layer io state is stored in the session, associated with the io, see
1344  * struct {vvp,lov,osc}_io for example. Sessions allocation is amortized
1345  * by using free-lists, see cl_env_get().
1346  *
1347  * There is a small predefined number of possible io types, enumerated in enum
1348  * cl_io_type.
1349  *
1350  * cl_io is a state machine, that can be advanced concurrently by the multiple
1351  * threads. It is up to these threads to control the concurrency and,
1352  * specifically, to detect when io is done, and its state can be safely
1353  * released.
1354  *
1355  * For read/write io overall execution plan is as following:
1356  *
1357  *     (0) initialize io state through all layers;
1358  *
1359  *     (1) loop: prepare chunk of work to do
1360  *
1361  *     (2) call all layers to collect locks they need to process current chunk
1362  *
1363  *     (3) sort all locks to avoid dead-locks, and acquire them
1364  *
1365  *     (4) process the chunk: call per-page methods
1366  *         cl_io_operations::cio_prepare_write(),
1367  *         cl_io_operations::cio_commit_write() for write)
1368  *
1369  *     (5) release locks
1370  *
1371  *     (6) repeat loop.
1372  *
1373  * To implement the "parallel IO mode", lov layer creates sub-io's (lazily to
1374  * address allocation efficiency issues mentioned above), and returns with the
1375  * special error condition from per-page method when current sub-io has to
1376  * block. This causes io loop to be repeated, and lov switches to the next
1377  * sub-io in its cl_io_operations::cio_iter_init() implementation.
1378  */
1379
1380 /** IO types */
1381 enum cl_io_type {
1382         /** read system call */
1383         CIT_READ = 1,
1384         /** write system call */
1385         CIT_WRITE,
1386         /** truncate, utime system calls */
1387         CIT_SETATTR,
1388         /** get data version */
1389         CIT_DATA_VERSION,
1390         /**
1391          * page fault handling
1392          */
1393         CIT_FAULT,
1394         /**
1395          * fsync system call handling
1396          * To write out a range of file
1397          */
1398         CIT_FSYNC,
1399         /**
1400          * glimpse. An io context to acquire glimpse lock.
1401          */
1402         CIT_GLIMPSE,
1403         /**
1404          * Miscellaneous io. This is used for occasional io activity that
1405          * doesn't fit into other types. Currently this is used for:
1406          *
1407          *     - cancellation of an extent lock. This io exists as a context
1408          *     to write dirty pages from under the lock being canceled back
1409          *     to the server;
1410          *
1411          *     - VM induced page write-out. An io context for writing page out
1412          *     for memory cleansing;
1413          *
1414          *     - grouplock. An io context to acquire group lock.
1415          *
1416          * CIT_MISC io is used simply as a context in which locks and pages
1417          * are manipulated. Such io has no internal "process", that is,
1418          * cl_io_loop() is never called for it.
1419          */
1420         CIT_MISC,
1421         /**
1422          * ladvise handling
1423          * To give advice about access of a file
1424          */
1425         CIT_LADVISE,
1426         CIT_OP_NR
1427 };
1428
1429 /**
1430  * States of cl_io state machine
1431  */
1432 enum cl_io_state {
1433         /** Not initialized. */
1434         CIS_ZERO,
1435         /** Initialized. */
1436         CIS_INIT,
1437         /** IO iteration started. */
1438         CIS_IT_STARTED,
1439         /** Locks taken. */
1440         CIS_LOCKED,
1441         /** Actual IO is in progress. */
1442         CIS_IO_GOING,
1443         /** IO for the current iteration finished. */
1444         CIS_IO_FINISHED,
1445         /** Locks released. */
1446         CIS_UNLOCKED,
1447         /** Iteration completed. */
1448         CIS_IT_ENDED,
1449         /** cl_io finalized. */
1450         CIS_FINI
1451 };
1452
1453 /**
1454  * IO state private for a layer.
1455  *
1456  * This is usually embedded into layer session data, rather than allocated
1457  * dynamically.
1458  *
1459  * \see vvp_io, lov_io, osc_io
1460  */
1461 struct cl_io_slice {
1462         struct cl_io                    *cis_io;
1463         /** corresponding object slice. Immutable after creation. */
1464         struct cl_object                *cis_obj;
1465         /** io operations. Immutable after creation. */
1466         const struct cl_io_operations   *cis_iop;
1467         /**
1468          * linkage into a list of all slices for a given cl_io, hanging off
1469          * cl_io::ci_layers. Immutable after creation.
1470          */
1471         struct list_head                cis_linkage;
1472 };
1473
1474 typedef void (*cl_commit_cbt)(const struct lu_env *, struct cl_io *,
1475                               struct pagevec *);
1476
1477 struct cl_read_ahead {
1478         /* Maximum page index the readahead window will end.
1479          * This is determined DLM lock coverage, RPC and stripe boundary.
1480          * cra_end is included. */
1481         pgoff_t cra_end;
1482         /* optimal RPC size for this read, by pages */
1483         unsigned long cra_rpc_size;
1484         /* Release callback. If readahead holds resources underneath, this
1485          * function should be called to release it. */
1486         void    (*cra_release)(const struct lu_env *env, void *cbdata);
1487         /* Callback data for cra_release routine */
1488         void    *cra_cbdata;
1489         /* whether lock is in contention */
1490         bool    cra_contention;
1491 };
1492
1493 static inline void cl_read_ahead_release(const struct lu_env *env,
1494                                          struct cl_read_ahead *ra)
1495 {
1496         if (ra->cra_release != NULL)
1497                 ra->cra_release(env, ra->cra_cbdata);
1498         memset(ra, 0, sizeof(*ra));
1499 }
1500
1501
1502 /**
1503  * Per-layer io operations.
1504  * \see vvp_io_ops, lov_io_ops, lovsub_io_ops, osc_io_ops
1505  */
1506 struct cl_io_operations {
1507         /**
1508          * Vector of io state transition methods for every io type.
1509          *
1510          * \see cl_page_operations::io
1511          */
1512         struct {
1513                 /**
1514                  * Prepare io iteration at a given layer.
1515                  *
1516                  * Called top-to-bottom at the beginning of each iteration of
1517                  * "io loop" (if it makes sense for this type of io). Here
1518                  * layer selects what work it will do during this iteration.
1519                  *
1520                  * \see cl_io_operations::cio_iter_fini()
1521                  */
1522                 int (*cio_iter_init) (const struct lu_env *env,
1523                                       const struct cl_io_slice *slice);
1524                 /**
1525                  * Finalize io iteration.
1526                  *
1527                  * Called bottom-to-top at the end of each iteration of "io
1528                  * loop". Here layers can decide whether IO has to be
1529                  * continued.
1530                  *
1531                  * \see cl_io_operations::cio_iter_init()
1532                  */
1533                 void (*cio_iter_fini) (const struct lu_env *env,
1534                                        const struct cl_io_slice *slice);
1535                 /**
1536                  * Collect locks for the current iteration of io.
1537                  *
1538                  * Called top-to-bottom to collect all locks necessary for
1539                  * this iteration. This methods shouldn't actually enqueue
1540                  * anything, instead it should post a lock through
1541                  * cl_io_lock_add(). Once all locks are collected, they are
1542                  * sorted and enqueued in the proper order.
1543                  */
1544                 int  (*cio_lock) (const struct lu_env *env,
1545                                   const struct cl_io_slice *slice);
1546                 /**
1547                  * Finalize unlocking.
1548                  *
1549                  * Called bottom-to-top to finish layer specific unlocking
1550                  * functionality, after generic code released all locks
1551                  * acquired by cl_io_operations::cio_lock().
1552                  */
1553                 void  (*cio_unlock)(const struct lu_env *env,
1554                                     const struct cl_io_slice *slice);
1555                 /**
1556                  * Start io iteration.
1557                  *
1558                  * Once all locks are acquired, called top-to-bottom to
1559                  * commence actual IO. In the current implementation,
1560                  * top-level vvp_io_{read,write}_start() does all the work
1561                  * synchronously by calling generic_file_*(), so other layers
1562                  * are called when everything is done.
1563                  */
1564                 int  (*cio_start)(const struct lu_env *env,
1565                                   const struct cl_io_slice *slice);
1566                 /**
1567                  * Called top-to-bottom at the end of io loop. Here layer
1568                  * might wait for an unfinished asynchronous io.
1569                  */
1570                 void (*cio_end)  (const struct lu_env *env,
1571                                   const struct cl_io_slice *slice);
1572                 /**
1573                  * Called bottom-to-top to notify layers that read/write IO
1574                  * iteration finished, with \a nob bytes transferred.
1575                  */
1576                 void (*cio_advance)(const struct lu_env *env,
1577                                     const struct cl_io_slice *slice,
1578                                     size_t nob);
1579                 /**
1580                  * Called once per io, bottom-to-top to release io resources.
1581                  */
1582                 void (*cio_fini) (const struct lu_env *env,
1583                                   const struct cl_io_slice *slice);
1584         } op[CIT_OP_NR];
1585
1586         /**
1587          * Submit pages from \a queue->c2_qin for IO, and move
1588          * successfully submitted pages into \a queue->c2_qout. Return
1589          * non-zero if failed to submit even the single page. If
1590          * submission failed after some pages were moved into \a
1591          * queue->c2_qout, completion callback with non-zero ioret is
1592          * executed on them.
1593          */
1594         int  (*cio_submit)(const struct lu_env *env,
1595                         const struct cl_io_slice *slice,
1596                         enum cl_req_type crt,
1597                         struct cl_2queue *queue);
1598         /**
1599          * Queue async page for write.
1600          * The difference between cio_submit and cio_queue is that
1601          * cio_submit is for urgent request.
1602          */
1603         int  (*cio_commit_async)(const struct lu_env *env,
1604                         const struct cl_io_slice *slice,
1605                         struct cl_page_list *queue, int from, int to,
1606                         cl_commit_cbt cb);
1607         /**
1608          * Decide maximum read ahead extent
1609          *
1610          * \pre io->ci_type == CIT_READ
1611          */
1612         int (*cio_read_ahead)(const struct lu_env *env,
1613                               const struct cl_io_slice *slice,
1614                               pgoff_t start, struct cl_read_ahead *ra);
1615         /**
1616          * Optional debugging helper. Print given io slice.
1617          */
1618         int (*cio_print)(const struct lu_env *env, void *cookie,
1619                          lu_printer_t p, const struct cl_io_slice *slice);
1620 };
1621
1622 /**
1623  * Flags to lock enqueue procedure.
1624  * \ingroup cl_lock
1625  */
1626 enum cl_enq_flags {
1627         /**
1628          * instruct server to not block, if conflicting lock is found. Instead
1629          * -EWOULDBLOCK is returned immediately.
1630          */
1631         CEF_NONBLOCK     = 0x00000001,
1632         /**
1633          * Tell lower layers this is a glimpse request, translated to
1634          * LDLM_FL_HAS_INTENT at LDLM layer.
1635          *
1636          * Also, because glimpse locks never block other locks, we count this
1637          * as automatically compatible with other osc locks.
1638          * (see osc_lock_compatible)
1639          */
1640         CEF_GLIMPSE        = 0x00000002,
1641         /**
1642          * tell the server to instruct (though a flag in the blocking ast) an
1643          * owner of the conflicting lock, that it can drop dirty pages
1644          * protected by this lock, without sending them to the server.
1645          */
1646         CEF_DISCARD_DATA = 0x00000004,
1647         /**
1648          * tell the sub layers that it must be a `real' lock. This is used for
1649          * mmapped-buffer locks, glimpse locks, manually requested locks
1650          * (LU_LADVISE_LOCKAHEAD) that must never be converted into lockless
1651          * mode.
1652          *
1653          * \see vvp_mmap_locks(), cl_glimpse_lock, cl_request_lock().
1654          */
1655         CEF_MUST         = 0x00000008,
1656         /**
1657          * tell the sub layers that never request a `real' lock. This flag is
1658          * not used currently.
1659          *
1660          * cl_io::ci_lockreq and CEF_{MUST,NEVER} flags specify lockless
1661          * conversion policy: ci_lockreq describes generic information of lock
1662          * requirement for this IO, especially for locks which belong to the
1663          * object doing IO; however, lock itself may have precise requirements
1664          * that are described by the enqueue flags.
1665          */
1666         CEF_NEVER        = 0x00000010,
1667         /**
1668          * tell the dlm layer this is a speculative lock request
1669          * speculative lock requests are locks which are not requested as part
1670          * of an I/O operation.  Instead, they are requested because we expect
1671          * to use them in the future.  They are requested asynchronously at the
1672          * ptlrpc layer.
1673          *
1674          * Currently used for asynchronous glimpse locks and manually requested
1675          * locks (LU_LADVISE_LOCKAHEAD).
1676          */
1677         CEF_SPECULATIVE          = 0x00000020,
1678         /**
1679          * enqueue a lock to test DLM lock existence.
1680          */
1681         CEF_PEEK        = 0x00000040,
1682         /**
1683          * Lock match only. Used by group lock in I/O as group lock
1684          * is known to exist.
1685          */
1686         CEF_LOCK_MATCH  = 0x00000080,
1687         /**
1688          * tell the DLM layer to lock only the requested range
1689          */
1690         CEF_LOCK_NO_EXPAND    = 0x00000100,
1691         /**
1692          * mask of enq_flags.
1693          */
1694         CEF_MASK         = 0x000001ff,
1695 };
1696
1697 /**
1698  * Link between lock and io. Intermediate structure is needed, because the
1699  * same lock can be part of multiple io's simultaneously.
1700  */
1701 struct cl_io_lock_link {
1702         /** linkage into one of cl_lockset lists. */
1703         struct list_head        cill_linkage;
1704         struct cl_lock          cill_lock;
1705         /** optional destructor */
1706         void                    (*cill_fini)(const struct lu_env *env,
1707                                              struct cl_io_lock_link *link);
1708 };
1709 #define cill_descr      cill_lock.cll_descr
1710
1711 /**
1712  * Lock-set represents a collection of locks, that io needs at a
1713  * time. Generally speaking, client tries to avoid holding multiple locks when
1714  * possible, because
1715  *
1716  *      - holding extent locks over multiple ost's introduces the danger of
1717  *        "cascading timeouts";
1718  *
1719  *      - holding multiple locks over the same ost is still dead-lock prone,
1720  *        see comment in osc_lock_enqueue(),
1721  *
1722  * but there are certain situations where this is unavoidable:
1723  *
1724  *      - O_APPEND writes have to take [0, EOF] lock for correctness;
1725  *
1726  *      - truncate has to take [new-size, EOF] lock for correctness;
1727  *
1728  *      - SNS has to take locks across full stripe for correctness;
1729  *
1730  *      - in the case when user level buffer, supplied to {read,write}(file0),
1731  *        is a part of a memory mapped lustre file, client has to take a dlm
1732  *        locks on file0, and all files that back up the buffer (or a part of
1733  *        the buffer, that is being processed in the current chunk, in any
1734  *        case, there are situations where at least 2 locks are necessary).
1735  *
1736  * In such cases we at least try to take locks in the same consistent
1737  * order. To this end, all locks are first collected, then sorted, and then
1738  * enqueued.
1739  */
1740 struct cl_lockset {
1741         /** locks to be acquired. */
1742         struct list_head  cls_todo;
1743         /** locks acquired. */
1744         struct list_head  cls_done;
1745 };
1746
1747 /**
1748  * Lock requirements(demand) for IO. It should be cl_io_lock_req,
1749  * but 'req' is always to be thought as 'request' :-)
1750  */
1751 enum cl_io_lock_dmd {
1752         /** Always lock data (e.g., O_APPEND). */
1753         CILR_MANDATORY = 0,
1754         /** Layers are free to decide between local and global locking. */
1755         CILR_MAYBE,
1756         /** Never lock: there is no cache (e.g., liblustre). */
1757         CILR_NEVER
1758 };
1759
1760 enum cl_fsync_mode {
1761         /** start writeback, do not wait for them to finish */
1762         CL_FSYNC_NONE  = 0,
1763         /** start writeback and wait for them to finish */
1764         CL_FSYNC_LOCAL = 1,
1765         /** discard all of dirty pages in a specific file range */
1766         CL_FSYNC_DISCARD = 2,
1767         /** start writeback and make sure they have reached storage before
1768          * return. OST_SYNC RPC must be issued and finished */
1769         CL_FSYNC_ALL   = 3
1770 };
1771
1772 struct cl_io_rw_common {
1773         loff_t  crw_pos;
1774         size_t  crw_count;
1775         int     crw_nonblock;
1776 };
1777
1778 /**
1779  * State for io.
1780  *
1781  * cl_io is shared by all threads participating in this IO (in current
1782  * implementation only one thread advances IO, but parallel IO design and
1783  * concurrent copy_*_user() require multiple threads acting on the same IO. It
1784  * is up to these threads to serialize their activities, including updates to
1785  * mutable cl_io fields.
1786  */
1787 struct cl_io {
1788         /** type of this IO. Immutable after creation. */
1789         enum cl_io_type                ci_type;
1790         /** current state of cl_io state machine. */
1791         enum cl_io_state               ci_state;
1792         /** main object this io is against. Immutable after creation. */
1793         struct cl_object              *ci_obj;
1794         /**
1795          * Upper layer io, of which this io is a part of. Immutable after
1796          * creation.
1797          */
1798         struct cl_io                  *ci_parent;
1799         /** List of slices. Immutable after creation. */
1800         struct list_head                ci_layers;
1801         /** list of locks (to be) acquired by this io. */
1802         struct cl_lockset              ci_lockset;
1803         /** lock requirements, this is just a help info for sublayers. */
1804         enum cl_io_lock_dmd            ci_lockreq;
1805         /** layout version when this IO occurs */
1806         __u32                           ci_layout_version;
1807         union {
1808                 struct cl_rd_io {
1809                         struct cl_io_rw_common rd;
1810                 } ci_rd;
1811                 struct cl_wr_io {
1812                         struct cl_io_rw_common wr;
1813                         int                    wr_append;
1814                         int                    wr_sync;
1815                 } ci_wr;
1816                 struct cl_io_rw_common ci_rw;
1817                 struct cl_setattr_io {
1818                         struct ost_lvb           sa_attr;
1819                         unsigned int             sa_attr_flags;
1820                         unsigned int             sa_avalid; /* ATTR_* */
1821                         unsigned int             sa_xvalid; /* OP_XVALID */
1822                         int                      sa_stripe_index;
1823                         struct ost_layout        sa_layout;
1824                         const struct lu_fid     *sa_parent_fid;
1825                 } ci_setattr;
1826                 struct cl_data_version_io {
1827                         u64 dv_data_version;
1828                         u32 dv_layout_version;
1829                         int dv_flags;
1830                 } ci_data_version;
1831                 struct cl_fault_io {
1832                         /** page index within file. */
1833                         pgoff_t         ft_index;
1834                         /** bytes valid byte on a faulted page. */
1835                         size_t          ft_nob;
1836                         /** writable page? for nopage() only */
1837                         int             ft_writable;
1838                         /** page of an executable? */
1839                         int             ft_executable;
1840                         /** page_mkwrite() */
1841                         int             ft_mkwrite;
1842                         /** resulting page */
1843                         struct cl_page *ft_page;
1844                 } ci_fault;
1845                 struct cl_fsync_io {
1846                         loff_t             fi_start;
1847                         loff_t             fi_end;
1848                         /** file system level fid */
1849                         struct lu_fid     *fi_fid;
1850                         enum cl_fsync_mode fi_mode;
1851                         /* how many pages were written/discarded */
1852                         unsigned int       fi_nr_written;
1853                 } ci_fsync;
1854                 struct cl_ladvise_io {
1855                         __u64                    li_start;
1856                         __u64                    li_end;
1857                         /** file system level fid */
1858                         struct lu_fid           *li_fid;
1859                         enum lu_ladvise_type     li_advice;
1860                         __u64                    li_flags;
1861                 } ci_ladvise;
1862         } u;
1863         struct cl_2queue     ci_queue;
1864         size_t               ci_nob;
1865         int                  ci_result;
1866         unsigned int         ci_continue:1,
1867         /**
1868          * This io has held grouplock, to inform sublayers that
1869          * don't do lockless i/o.
1870          */
1871                              ci_no_srvlock:1,
1872         /**
1873          * The whole IO need to be restarted because layout has been changed
1874          */
1875                              ci_need_restart:1,
1876         /**
1877          * to not refresh layout - the IO issuer knows that the layout won't
1878          * change(page operations, layout change causes all page to be
1879          * discarded), or it doesn't matter if it changes(sync).
1880          */
1881                              ci_ignore_layout:1,
1882         /**
1883          * Need MDS intervention to complete a write.
1884          * Write intent is required for the following cases:
1885          * 1. component being written is not initialized, or
1886          * 2. the mirrored files are NOT in WRITE_PENDING state.
1887          */
1888                              ci_need_write_intent:1,
1889         /**
1890          * Check if layout changed after the IO finishes. Mainly for HSM
1891          * requirement. If IO occurs to openning files, it doesn't need to
1892          * verify layout because HSM won't release openning files.
1893          * Right now, only two opertaions need to verify layout: glimpse
1894          * and setattr.
1895          */
1896                              ci_verify_layout:1,
1897         /**
1898          * file is released, restore has to to be triggered by vvp layer
1899          */
1900                              ci_restore_needed:1,
1901         /**
1902          * O_NOATIME
1903          */
1904                              ci_noatime:1,
1905         /* Tell sublayers not to expand LDLM locks requested for this IO */
1906                              ci_lock_no_expand:1,
1907         /**
1908          * Set if non-delay RPC should be used for this IO.
1909          *
1910          * If this file has multiple mirrors, and if the OSTs of the current
1911          * mirror is inaccessible, non-delay RPC would error out quickly so
1912          * that the upper layer can try to access the next mirror.
1913          */
1914                              ci_ndelay:1,
1915         /**
1916          * Set if IO is triggered by async workqueue readahead.
1917          */
1918                              ci_async_readahead:1;
1919         /**
1920          * How many times the read has retried before this one.
1921          * Set by the top level and consumed by the LOV.
1922          */
1923         unsigned             ci_ndelay_tried;
1924         /**
1925          * Designated mirror index for this I/O.
1926          */
1927         unsigned             ci_designated_mirror;
1928         /**
1929          * Number of pages owned by this IO. For invariant checking.
1930          */
1931         unsigned             ci_owned_nr;
1932         /**
1933          * Range of write intent. Valid if ci_need_write_intent is set.
1934          */
1935         struct lu_extent        ci_write_intent;
1936 };
1937
1938 /** @} cl_io */
1939
1940 /**
1941  * Per-transfer attributes.
1942  */
1943 struct cl_req_attr {
1944         enum cl_req_type cra_type;
1945         u64              cra_flags;
1946         struct cl_page  *cra_page;
1947         /** Generic attributes for the server consumption. */
1948         struct obdo     *cra_oa;
1949         /** Jobid */
1950         char             cra_jobid[LUSTRE_JOBID_SIZE];
1951 };
1952
1953 enum cache_stats_item {
1954         /** how many cache lookups were performed */
1955         CS_lookup = 0,
1956         /** how many times cache lookup resulted in a hit */
1957         CS_hit,
1958         /** how many entities are in the cache right now */
1959         CS_total,
1960         /** how many entities in the cache are actively used (and cannot be
1961          * evicted) right now */
1962         CS_busy,
1963         /** how many entities were created at all */
1964         CS_create,
1965         CS_NR
1966 };
1967
1968 #define CS_NAMES { "lookup", "hit", "total", "busy", "create" }
1969
1970 /**
1971  * Stats for a generic cache (similar to inode, lu_object, etc. caches).
1972  */
1973 struct cache_stats {
1974         const char      *cs_name;
1975         atomic_t        cs_stats[CS_NR];
1976 };
1977
1978 /** These are not exported so far */
1979 void cache_stats_init (struct cache_stats *cs, const char *name);
1980
1981 /**
1982  * Client-side site. This represents particular client stack. "Global"
1983  * variables should (directly or indirectly) be added here to allow multiple
1984  * clients to co-exist in the single address space.
1985  */
1986 struct cl_site {
1987         struct lu_site          cs_lu;
1988         /**
1989          * Statistical counters. Atomics do not scale, something better like
1990          * per-cpu counters is needed.
1991          *
1992          * These are exported as /proc/fs/lustre/llite/.../site
1993          *
1994          * When interpreting keep in mind that both sub-locks (and sub-pages)
1995          * and top-locks (and top-pages) are accounted here.
1996          */
1997         struct cache_stats      cs_pages;
1998         atomic_t                cs_pages_state[CPS_NR];
1999 };
2000
2001 int  cl_site_init(struct cl_site *s, struct cl_device *top);
2002 void cl_site_fini(struct cl_site *s);
2003 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl);
2004
2005 /**
2006  * Output client site statistical counters into a buffer. Suitable for
2007  * ll_rd_*()-style functions.
2008  */
2009 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m);
2010
2011 /**
2012  * \name helpers
2013  *
2014  * Type conversion and accessory functions.
2015  */
2016 /** @{ */
2017
2018 static inline struct cl_site *lu2cl_site(const struct lu_site *site)
2019 {
2020         return container_of(site, struct cl_site, cs_lu);
2021 }
2022
2023 static inline struct cl_device *lu2cl_dev(const struct lu_device *d)
2024 {
2025         LASSERT(d == NULL || IS_ERR(d) || lu_device_is_cl(d));
2026         return container_of0(d, struct cl_device, cd_lu_dev);
2027 }
2028
2029 static inline struct lu_device *cl2lu_dev(struct cl_device *d)
2030 {
2031         return &d->cd_lu_dev;
2032 }
2033
2034 static inline struct cl_object *lu2cl(const struct lu_object *o)
2035 {
2036         LASSERT(o == NULL || IS_ERR(o) || lu_device_is_cl(o->lo_dev));
2037         return container_of0(o, struct cl_object, co_lu);
2038 }
2039
2040 static inline const struct cl_object_conf *
2041 lu2cl_conf(const struct lu_object_conf *conf)
2042 {
2043         return container_of0(conf, struct cl_object_conf, coc_lu);
2044 }
2045
2046 static inline struct cl_object *cl_object_next(const struct cl_object *obj)
2047 {
2048         return obj ? lu2cl(lu_object_next(&obj->co_lu)) : NULL;
2049 }
2050
2051 static inline struct cl_object_header *luh2coh(const struct lu_object_header *h)
2052 {
2053         return container_of0(h, struct cl_object_header, coh_lu);
2054 }
2055
2056 static inline struct cl_site *cl_object_site(const struct cl_object *obj)
2057 {
2058         return lu2cl_site(obj->co_lu.lo_dev->ld_site);
2059 }
2060
2061 static inline
2062 struct cl_object_header *cl_object_header(const struct cl_object *obj)
2063 {
2064         return luh2coh(obj->co_lu.lo_header);
2065 }
2066
2067 static inline int cl_device_init(struct cl_device *d, struct lu_device_type *t)
2068 {
2069         return lu_device_init(&d->cd_lu_dev, t);
2070 }
2071
2072 static inline void cl_device_fini(struct cl_device *d)
2073 {
2074         lu_device_fini(&d->cd_lu_dev);
2075 }
2076
2077 void cl_page_slice_add(struct cl_page *page, struct cl_page_slice *slice,
2078                        struct cl_object *obj, pgoff_t index,
2079                        const struct cl_page_operations *ops);
2080 void cl_lock_slice_add(struct cl_lock *lock, struct cl_lock_slice *slice,
2081                        struct cl_object *obj,
2082                        const struct cl_lock_operations *ops);
2083 void cl_io_slice_add(struct cl_io *io, struct cl_io_slice *slice,
2084                      struct cl_object *obj, const struct cl_io_operations *ops);
2085 /** @} helpers */
2086
2087 /** \defgroup cl_object cl_object
2088  * @{ */
2089 struct cl_object *cl_object_top (struct cl_object *o);
2090 struct cl_object *cl_object_find(const struct lu_env *env, struct cl_device *cd,
2091                                  const struct lu_fid *fid,
2092                                  const struct cl_object_conf *c);
2093
2094 int  cl_object_header_init(struct cl_object_header *h);
2095 void cl_object_header_fini(struct cl_object_header *h);
2096 void cl_object_put        (const struct lu_env *env, struct cl_object *o);
2097 void cl_object_get        (struct cl_object *o);
2098 void cl_object_attr_lock  (struct cl_object *o);
2099 void cl_object_attr_unlock(struct cl_object *o);
2100 int  cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
2101                         struct cl_attr *attr);
2102 int  cl_object_attr_update(const struct lu_env *env, struct cl_object *obj,
2103                            const struct cl_attr *attr, unsigned valid);
2104 int  cl_object_glimpse    (const struct lu_env *env, struct cl_object *obj,
2105                            struct ost_lvb *lvb);
2106 int  cl_conf_set          (const struct lu_env *env, struct cl_object *obj,
2107                            const struct cl_object_conf *conf);
2108 int  cl_object_prune      (const struct lu_env *env, struct cl_object *obj);
2109 void cl_object_kill       (const struct lu_env *env, struct cl_object *obj);
2110 int cl_object_getstripe(const struct lu_env *env, struct cl_object *obj,
2111                         struct lov_user_md __user *lum, size_t size);
2112 int cl_object_fiemap(const struct lu_env *env, struct cl_object *obj,
2113                      struct ll_fiemap_info_key *fmkey, struct fiemap *fiemap,
2114                      size_t *buflen);
2115 int cl_object_layout_get(const struct lu_env *env, struct cl_object *obj,
2116                          struct cl_layout *cl);
2117 loff_t cl_object_maxbytes(struct cl_object *obj);
2118 int cl_object_flush(const struct lu_env *env, struct cl_object *obj,
2119                     struct ldlm_lock *lock);
2120
2121
2122 /**
2123  * Returns true, iff \a o0 and \a o1 are slices of the same object.
2124  */
2125 static inline int cl_object_same(struct cl_object *o0, struct cl_object *o1)
2126 {
2127         return cl_object_header(o0) == cl_object_header(o1);
2128 }
2129
2130 static inline void cl_object_page_init(struct cl_object *clob, int size)
2131 {
2132         clob->co_slice_off = cl_object_header(clob)->coh_page_bufsize;
2133         cl_object_header(clob)->coh_page_bufsize += cfs_size_round(size);
2134         WARN_ON(cl_object_header(clob)->coh_page_bufsize > 512);
2135 }
2136
2137 static inline void *cl_object_page_slice(struct cl_object *clob,
2138                                          struct cl_page *page)
2139 {
2140         return (void *)((char *)page + clob->co_slice_off);
2141 }
2142
2143 /**
2144  * Return refcount of cl_object.
2145  */
2146 static inline int cl_object_refc(struct cl_object *clob)
2147 {
2148         struct lu_object_header *header = clob->co_lu.lo_header;
2149         return atomic_read(&header->loh_ref);
2150 }
2151
2152 /** @} cl_object */
2153
2154 /** \defgroup cl_page cl_page
2155  * @{ */
2156 enum {
2157         CLP_GANG_OKAY = 0,
2158         CLP_GANG_RESCHED,
2159         CLP_GANG_AGAIN,
2160         CLP_GANG_ABORT
2161 };
2162 /* callback of cl_page_gang_lookup() */
2163
2164 struct cl_page *cl_page_find        (const struct lu_env *env,
2165                                      struct cl_object *obj,
2166                                      pgoff_t idx, struct page *vmpage,
2167                                      enum cl_page_type type);
2168 struct cl_page *cl_page_alloc       (const struct lu_env *env,
2169                                      struct cl_object *o, pgoff_t ind,
2170                                      struct page *vmpage,
2171                                      enum cl_page_type type);
2172 void            cl_page_get         (struct cl_page *page);
2173 void            cl_page_put         (const struct lu_env *env,
2174                                      struct cl_page *page);
2175 void            cl_pagevec_put      (const struct lu_env *env,
2176                                      struct cl_page *page,
2177                                      struct pagevec *pvec);
2178 void            cl_page_print       (const struct lu_env *env, void *cookie,
2179                                      lu_printer_t printer,
2180                                      const struct cl_page *pg);
2181 void            cl_page_header_print(const struct lu_env *env, void *cookie,
2182                                      lu_printer_t printer,
2183                                      const struct cl_page *pg);
2184 struct cl_page *cl_vmpage_page      (struct page *vmpage, struct cl_object *obj);
2185 struct cl_page *cl_page_top         (struct cl_page *page);
2186
2187 const struct cl_page_slice *cl_page_at(const struct cl_page *page,
2188                                        const struct lu_device_type *dtype);
2189
2190 /**
2191  * \name ownership
2192  *
2193  * Functions dealing with the ownership of page by io.
2194  */
2195 /** @{ */
2196
2197 int  cl_page_own        (const struct lu_env *env,
2198                          struct cl_io *io, struct cl_page *page);
2199 int  cl_page_own_try    (const struct lu_env *env,
2200                          struct cl_io *io, struct cl_page *page);
2201 void cl_page_assume     (const struct lu_env *env,
2202                          struct cl_io *io, struct cl_page *page);
2203 void cl_page_unassume   (const struct lu_env *env,
2204                          struct cl_io *io, struct cl_page *pg);
2205 void cl_page_disown     (const struct lu_env *env,
2206                          struct cl_io *io, struct cl_page *page);
2207 int  cl_page_is_owned   (const struct cl_page *pg, const struct cl_io *io);
2208
2209 /** @} ownership */
2210
2211 /**
2212  * \name transfer
2213  *
2214  * Functions dealing with the preparation of a page for a transfer, and
2215  * tracking transfer state.
2216  */
2217 /** @{ */
2218 int  cl_page_prep       (const struct lu_env *env, struct cl_io *io,
2219                          struct cl_page *pg, enum cl_req_type crt);
2220 void cl_page_completion (const struct lu_env *env,
2221                          struct cl_page *pg, enum cl_req_type crt, int ioret);
2222 int  cl_page_make_ready (const struct lu_env *env, struct cl_page *pg,
2223                          enum cl_req_type crt);
2224 int  cl_page_cache_add  (const struct lu_env *env, struct cl_io *io,
2225                          struct cl_page *pg, enum cl_req_type crt);
2226 void cl_page_clip       (const struct lu_env *env, struct cl_page *pg,
2227                          int from, int to);
2228 int  cl_page_cancel     (const struct lu_env *env, struct cl_page *page);
2229 int  cl_page_flush      (const struct lu_env *env, struct cl_io *io,
2230                          struct cl_page *pg);
2231
2232 /** @} transfer */
2233
2234
2235 /**
2236  * \name helper routines
2237  * Functions to discard, delete and export a cl_page.
2238  */
2239 /** @{ */
2240 void    cl_page_discard(const struct lu_env *env, struct cl_io *io,
2241                         struct cl_page *pg);
2242 void    cl_page_delete(const struct lu_env *env, struct cl_page *pg);
2243 int     cl_page_is_vmlocked(const struct lu_env *env,
2244                             const struct cl_page *pg);
2245 void    cl_page_touch(const struct lu_env *env, const struct cl_page *pg,
2246                       size_t to);
2247 void    cl_page_export(const struct lu_env *env,
2248                        struct cl_page *pg, int uptodate);
2249 loff_t  cl_offset(const struct cl_object *obj, pgoff_t idx);
2250 pgoff_t cl_index(const struct cl_object *obj, loff_t offset);
2251 size_t  cl_page_size(const struct cl_object *obj);
2252
2253 void cl_lock_print(const struct lu_env *env, void *cookie,
2254                    lu_printer_t printer, const struct cl_lock *lock);
2255 void cl_lock_descr_print(const struct lu_env *env, void *cookie,
2256                          lu_printer_t printer,
2257                          const struct cl_lock_descr *descr);
2258 /* @} helper */
2259
2260 /**
2261  * Data structure managing a client's cached pages. A count of
2262  * "unstable" pages is maintained, and an LRU of clean pages is
2263  * maintained. "unstable" pages are pages pinned by the ptlrpc
2264  * layer for recovery purposes.
2265  */
2266 struct cl_client_cache {
2267         /**
2268          * # of client cache refcount
2269          * # of users (OSCs) + 2 (held by llite and lov)
2270          */
2271         atomic_t                ccc_users;
2272         /**
2273          * # of threads are doing shrinking
2274          */
2275         unsigned int            ccc_lru_shrinkers;
2276         /**
2277          * # of LRU entries available
2278          */
2279         atomic_long_t           ccc_lru_left;
2280         /**
2281          * List of entities(OSCs) for this LRU cache
2282          */
2283         struct list_head        ccc_lru;
2284         /**
2285          * Max # of LRU entries
2286          */
2287         unsigned long           ccc_lru_max;
2288         /**
2289          * Lock to protect ccc_lru list
2290          */
2291         spinlock_t              ccc_lru_lock;
2292         /**
2293          * Set if unstable check is enabled
2294          */
2295         unsigned int            ccc_unstable_check:1;
2296         /**
2297          * # of unstable pages for this mount point
2298          */
2299         atomic_long_t           ccc_unstable_nr;
2300         /**
2301          * Waitq for awaiting unstable pages to reach zero.
2302          * Used at umounting time and signaled on BRW commit
2303          */
2304         wait_queue_head_t       ccc_unstable_waitq;
2305 };
2306 /**
2307  * cl_cache functions
2308  */
2309 struct cl_client_cache *cl_cache_init(unsigned long lru_page_max);
2310 void cl_cache_incref(struct cl_client_cache *cache);
2311 void cl_cache_decref(struct cl_client_cache *cache);
2312
2313 /** @} cl_page */
2314
2315 /** \defgroup cl_lock cl_lock
2316  * @{ */
2317 int cl_lock_request(const struct lu_env *env, struct cl_io *io,
2318                     struct cl_lock *lock);
2319 int cl_lock_init(const struct lu_env *env, struct cl_lock *lock,
2320                  const struct cl_io *io);
2321 void cl_lock_fini(const struct lu_env *env, struct cl_lock *lock);
2322 const struct cl_lock_slice *cl_lock_at(const struct cl_lock *lock,
2323                                        const struct lu_device_type *dtype);
2324 void cl_lock_release(const struct lu_env *env, struct cl_lock *lock);
2325
2326 int cl_lock_enqueue(const struct lu_env *env, struct cl_io *io,
2327                     struct cl_lock *lock, struct cl_sync_io *anchor);
2328 void cl_lock_cancel(const struct lu_env *env, struct cl_lock *lock);
2329
2330 /** @} cl_lock */
2331
2332 /** \defgroup cl_io cl_io
2333  * @{ */
2334
2335 int   cl_io_init         (const struct lu_env *env, struct cl_io *io,
2336                           enum cl_io_type iot, struct cl_object *obj);
2337 int   cl_io_sub_init     (const struct lu_env *env, struct cl_io *io,
2338                           enum cl_io_type iot, struct cl_object *obj);
2339 int   cl_io_rw_init      (const struct lu_env *env, struct cl_io *io,
2340                           enum cl_io_type iot, loff_t pos, size_t count);
2341 int   cl_io_loop         (const struct lu_env *env, struct cl_io *io);
2342
2343 void  cl_io_fini         (const struct lu_env *env, struct cl_io *io);
2344 int   cl_io_iter_init    (const struct lu_env *env, struct cl_io *io);
2345 void  cl_io_iter_fini    (const struct lu_env *env, struct cl_io *io);
2346 int   cl_io_lock         (const struct lu_env *env, struct cl_io *io);
2347 void  cl_io_unlock       (const struct lu_env *env, struct cl_io *io);
2348 int   cl_io_start        (const struct lu_env *env, struct cl_io *io);
2349 void  cl_io_end          (const struct lu_env *env, struct cl_io *io);
2350 int   cl_io_lock_add     (const struct lu_env *env, struct cl_io *io,
2351                           struct cl_io_lock_link *link);
2352 int   cl_io_lock_alloc_add(const struct lu_env *env, struct cl_io *io,
2353                            struct cl_lock_descr *descr);
2354 int   cl_io_submit_rw    (const struct lu_env *env, struct cl_io *io,
2355                           enum cl_req_type iot, struct cl_2queue *queue);
2356 int   cl_io_submit_sync  (const struct lu_env *env, struct cl_io *io,
2357                           enum cl_req_type iot, struct cl_2queue *queue,
2358                           long timeout);
2359 int   cl_io_commit_async (const struct lu_env *env, struct cl_io *io,
2360                           struct cl_page_list *queue, int from, int to,
2361                           cl_commit_cbt cb);
2362 int   cl_io_read_ahead   (const struct lu_env *env, struct cl_io *io,
2363                           pgoff_t start, struct cl_read_ahead *ra);
2364 void  cl_io_rw_advance   (const struct lu_env *env, struct cl_io *io,
2365                           size_t nob);
2366 int   cl_io_cancel       (const struct lu_env *env, struct cl_io *io,
2367                           struct cl_page_list *queue);
2368
2369 /**
2370  * True, iff \a io is an O_APPEND write(2).
2371  */
2372 static inline int cl_io_is_append(const struct cl_io *io)
2373 {
2374         return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_append;
2375 }
2376
2377 static inline int cl_io_is_sync_write(const struct cl_io *io)
2378 {
2379         return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_sync;
2380 }
2381
2382 static inline int cl_io_is_mkwrite(const struct cl_io *io)
2383 {
2384         return io->ci_type == CIT_FAULT && io->u.ci_fault.ft_mkwrite;
2385 }
2386
2387 /**
2388  * True, iff \a io is a truncate(2).
2389  */
2390 static inline int cl_io_is_trunc(const struct cl_io *io)
2391 {
2392         return io->ci_type == CIT_SETATTR &&
2393                 (io->u.ci_setattr.sa_avalid & ATTR_SIZE);
2394 }
2395
2396 struct cl_io *cl_io_top(struct cl_io *io);
2397
2398 void cl_io_print(const struct lu_env *env, void *cookie,
2399                  lu_printer_t printer, const struct cl_io *io);
2400
2401 #define CL_IO_SLICE_CLEAN(foo_io, base)                                 \
2402 do {                                                                    \
2403         typeof(foo_io) __foo_io = (foo_io);                             \
2404                                                                         \
2405         memset(&__foo_io->base, 0,                                      \
2406                sizeof(*__foo_io) - offsetof(typeof(*__foo_io), base));  \
2407 } while (0)
2408
2409 /** @} cl_io */
2410
2411 /** \defgroup cl_page_list cl_page_list
2412  * @{ */
2413
2414 /**
2415  * Last page in the page list.
2416  */
2417 static inline struct cl_page *cl_page_list_last(struct cl_page_list *plist)
2418 {
2419         LASSERT(plist->pl_nr > 0);
2420         return list_entry(plist->pl_pages.prev, struct cl_page, cp_batch);
2421 }
2422
2423 static inline struct cl_page *cl_page_list_first(struct cl_page_list *plist)
2424 {
2425         LASSERT(plist->pl_nr > 0);
2426         return list_entry(plist->pl_pages.next, struct cl_page, cp_batch);
2427 }
2428
2429 /**
2430  * Iterate over pages in a page list.
2431  */
2432 #define cl_page_list_for_each(page, list)                               \
2433         list_for_each_entry((page), &(list)->pl_pages, cp_batch)
2434
2435 /**
2436  * Iterate over pages in a page list, taking possible removals into account.
2437  */
2438 #define cl_page_list_for_each_safe(page, temp, list)                    \
2439         list_for_each_entry_safe((page), (temp), &(list)->pl_pages, cp_batch)
2440
2441 void cl_page_list_init   (struct cl_page_list *plist);
2442 void cl_page_list_add    (struct cl_page_list *plist, struct cl_page *page);
2443 void cl_page_list_move   (struct cl_page_list *dst, struct cl_page_list *src,
2444                           struct cl_page *page);
2445 void cl_page_list_move_head(struct cl_page_list *dst, struct cl_page_list *src,
2446                           struct cl_page *page);
2447 void cl_page_list_splice (struct cl_page_list *list,
2448                           struct cl_page_list *head);
2449 void cl_page_list_del    (const struct lu_env *env,
2450                           struct cl_page_list *plist, struct cl_page *page);
2451 void cl_page_list_disown (const struct lu_env *env,
2452                           struct cl_io *io, struct cl_page_list *plist);
2453 void cl_page_list_assume (const struct lu_env *env,
2454                           struct cl_io *io, struct cl_page_list *plist);
2455 void cl_page_list_discard(const struct lu_env *env,
2456                           struct cl_io *io, struct cl_page_list *plist);
2457 void cl_page_list_fini   (const struct lu_env *env, struct cl_page_list *plist);
2458
2459 void cl_2queue_init     (struct cl_2queue *queue);
2460 void cl_2queue_add      (struct cl_2queue *queue, struct cl_page *page);
2461 void cl_2queue_disown   (const struct lu_env *env,
2462                          struct cl_io *io, struct cl_2queue *queue);
2463 void cl_2queue_assume   (const struct lu_env *env,
2464                          struct cl_io *io, struct cl_2queue *queue);
2465 void cl_2queue_discard  (const struct lu_env *env,
2466                          struct cl_io *io, struct cl_2queue *queue);
2467 void cl_2queue_fini     (const struct lu_env *env, struct cl_2queue *queue);
2468 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page);
2469
2470 /** @} cl_page_list */
2471
2472 void cl_req_attr_set(const struct lu_env *env, struct cl_object *obj,
2473                      struct cl_req_attr *attr);
2474
2475 /** \defgroup cl_sync_io cl_sync_io
2476  * @{ */
2477
2478 struct cl_sync_io;
2479
2480 typedef void (cl_sync_io_end_t)(const struct lu_env *, struct cl_sync_io *);
2481
2482 void cl_sync_io_init_notify(struct cl_sync_io *anchor, int nr,
2483                             cl_sync_io_end_t *end);
2484
2485 int  cl_sync_io_wait(const struct lu_env *env, struct cl_sync_io *anchor,
2486                      long timeout);
2487 void cl_sync_io_note(const struct lu_env *env, struct cl_sync_io *anchor,
2488                      int ioret);
2489 static inline void cl_sync_io_init(struct cl_sync_io *anchor, int nr)
2490 {
2491         cl_sync_io_init_notify(anchor, nr, NULL);
2492 }
2493
2494 /**
2495  * Anchor for synchronous transfer. This is allocated on a stack by thread
2496  * doing synchronous transfer, and a pointer to this structure is set up in
2497  * every page submitted for transfer. Transfer completion routine updates
2498  * anchor and wakes up waiting thread when transfer is complete.
2499  */
2500 struct cl_sync_io {
2501         /** number of pages yet to be transferred. */
2502         atomic_t                csi_sync_nr;
2503         /** error code. */
2504         int                     csi_sync_rc;
2505         /** completion to be signaled when transfer is complete. */
2506         wait_queue_head_t       csi_waitq;
2507         /** callback to invoke when this IO is finished */
2508         cl_sync_io_end_t       *csi_end_io;
2509 };
2510
2511 /** @} cl_sync_io */
2512
2513 /** \defgroup cl_env cl_env
2514  *
2515  * lu_env handling for a client.
2516  *
2517  * lu_env is an environment within which lustre code executes. Its major part
2518  * is lu_context---a fast memory allocation mechanism that is used to conserve
2519  * precious kernel stack space. Originally lu_env was designed for a server,
2520  * where
2521  *
2522  *     - there is a (mostly) fixed number of threads, and
2523  *
2524  *     - call chains have no non-lustre portions inserted between lustre code.
2525  *
2526  * On a client both these assumtpion fails, because every user thread can
2527  * potentially execute lustre code as part of a system call, and lustre calls
2528  * into VFS or MM that call back into lustre.
2529  *
2530  * To deal with that, cl_env wrapper functions implement the following
2531  * optimizations:
2532  *
2533  *     - allocation and destruction of environment is amortized by caching no
2534  *     longer used environments instead of destroying them;
2535  *
2536  * \see lu_env, lu_context, lu_context_key
2537  * @{ */
2538
2539 struct lu_env *cl_env_get(__u16 *refcheck);
2540 struct lu_env *cl_env_alloc(__u16 *refcheck, __u32 tags);
2541 void cl_env_put(struct lu_env *env, __u16 *refcheck);
2542 unsigned cl_env_cache_purge(unsigned nr);
2543 struct lu_env *cl_env_percpu_get(void);
2544 void cl_env_percpu_put(struct lu_env *env);
2545
2546 /** @} cl_env */
2547
2548 /*
2549  * Misc
2550  */
2551 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr);
2552 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb);
2553
2554 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
2555                                 struct lu_device_type *ldt,
2556                                 struct lu_device *next);
2557 /** @} clio */
2558
2559 int cl_global_init(void);
2560 void cl_global_fini(void);
2561
2562 #endif /* _LINUX_CL_OBJECT_H */