Whamcloud - gitweb
LU-1408 debug: initialize debug_msg_data if needed
[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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36 #ifndef _LUSTRE_CL_OBJECT_H
37 #define _LUSTRE_CL_OBJECT_H
38
39 /** \defgroup clio clio
40  *
41  * Client objects implement io operations and cache pages.
42  *
43  * Examples: lov and osc are implementations of cl interface.
44  *
45  * Big Theory Statement.
46  *
47  * Layered objects.
48  *
49  * Client implementation is based on the following data-types:
50  *
51  *   - cl_object
52  *
53  *   - cl_page
54  *
55  *   - cl_lock     represents an extent lock on an object.
56  *
57  *   - cl_io       represents high-level i/o activity such as whole read/write
58  *                 system call, or write-out of pages from under the lock being
59  *                 canceled. cl_io has sub-ios that can be stopped and resumed
60  *                 independently, thus achieving high degree of transfer
61  *                 parallelism. Single cl_io can be advanced forward by
62  *                 the multiple threads (although in the most usual case of
63  *                 read/write system call it is associated with the single user
64  *                 thread, that issued the system call).
65  *
66  *   - cl_req      represents a collection of pages for a transfer. cl_req is
67  *                 constructed by req-forming engine that tries to saturate
68  *                 transport with large and continuous transfers.
69  *
70  * Terminology
71  *
72  *     - to avoid confusion high-level I/O operation like read or write system
73  *     call is referred to as "an io", whereas low-level I/O operation, like
74  *     RPC, is referred to as "a transfer"
75  *
76  *     - "generic code" means generic (not file system specific) code in the
77  *     hosting environment. "cl-code" means code (mostly in cl_*.c files) that
78  *     is not layer specific.
79  *
80  * Locking.
81  *
82  *  - i_mutex
83  *      - PG_locked
84  *          - cl_object_header::coh_page_guard
85  *          - cl_object_header::coh_lock_guard
86  *          - lu_site::ls_guard
87  *
88  * See the top comment in cl_object.c for the description of overall locking and
89  * reference-counting design.
90  *
91  * See comments below for the description of i/o, page, and dlm-locking
92  * design.
93  *
94  * @{
95  */
96
97 /*
98  * super-class definitions.
99  */
100 #include <lu_object.h>
101 #ifdef __KERNEL__
102 #        include <linux/mutex.h>
103 #        include <linux/radix-tree.h>
104 #endif
105
106 struct inode;
107
108 struct cl_device;
109 struct cl_device_operations;
110
111 struct cl_object;
112 struct cl_object_page_operations;
113 struct cl_object_lock_operations;
114
115 struct cl_page;
116 struct cl_page_slice;
117 struct cl_lock;
118 struct cl_lock_slice;
119
120 struct cl_lock_operations;
121 struct cl_page_operations;
122
123 struct cl_io;
124 struct cl_io_slice;
125
126 struct cl_req;
127 struct cl_req_slice;
128
129 /**
130  * Operations for each data device in the client stack.
131  *
132  * \see vvp_cl_ops, lov_cl_ops, lovsub_cl_ops, osc_cl_ops
133  */
134 struct cl_device_operations {
135         /**
136          * Initialize cl_req. This method is called top-to-bottom on all
137          * devices in the stack to get them a chance to allocate layer-private
138          * data, and to attach them to the cl_req by calling
139          * cl_req_slice_add().
140          *
141          * \see osc_req_init(), lov_req_init(), lovsub_req_init()
142          * \see ccc_req_init()
143          */
144         int (*cdo_req_init)(const struct lu_env *env, struct cl_device *dev,
145                             struct cl_req *req);
146 };
147
148 /**
149  * Device in the client stack.
150  *
151  * \see ccc_device, lov_device, lovsub_device, osc_device
152  */
153 struct cl_device {
154         /** Super-class. */
155         struct lu_device                   cd_lu_dev;
156         /** Per-layer operation vector. */
157         const struct cl_device_operations *cd_ops;
158 };
159
160 /** \addtogroup cl_object cl_object
161  * @{ */
162 /**
163  * "Data attributes" of cl_object. Data attributes can be updated
164  * independently for a sub-object, and top-object's attributes are calculated
165  * from sub-objects' ones.
166  */
167 struct cl_attr {
168         /** Object size, in bytes */
169         loff_t cat_size;
170         /**
171          * Known minimal size, in bytes.
172          *
173          * This is only valid when at least one DLM lock is held.
174          */
175         loff_t cat_kms;
176         /** Modification time. Measured in seconds since epoch. */
177         time_t cat_mtime;
178         /** Access time. Measured in seconds since epoch. */
179         time_t cat_atime;
180         /** Change time. Measured in seconds since epoch. */
181         time_t cat_ctime;
182         /**
183          * Blocks allocated to this cl_object on the server file system.
184          *
185          * \todo XXX An interface for block size is needed.
186          */
187         __u64  cat_blocks;
188         /**
189          * User identifier for quota purposes.
190          */
191         uid_t  cat_uid;
192         /**
193          * Group identifier for quota purposes.
194          */
195         gid_t  cat_gid;
196 };
197
198 /**
199  * Fields in cl_attr that are being set.
200  */
201 enum cl_attr_valid {
202         CAT_SIZE   = 1 << 0,
203         CAT_KMS    = 1 << 1,
204         CAT_MTIME  = 1 << 3,
205         CAT_ATIME  = 1 << 4,
206         CAT_CTIME  = 1 << 5,
207         CAT_BLOCKS = 1 << 6,
208         CAT_UID    = 1 << 7,
209         CAT_GID    = 1 << 8
210 };
211
212 /**
213  * Sub-class of lu_object with methods common for objects on the client
214  * stacks.
215  *
216  * cl_object: represents a regular file system object, both a file and a
217  *    stripe. cl_object is based on lu_object: it is identified by a fid,
218  *    layered, cached, hashed, and lrued. Important distinction with the server
219  *    side, where md_object and dt_object are used, is that cl_object "fans out"
220  *    at the lov/sns level: depending on the file layout, single file is
221  *    represented as a set of "sub-objects" (stripes). At the implementation
222  *    level, struct lov_object contains an array of cl_objects. Each sub-object
223  *    is a full-fledged cl_object, having its fid, living in the lru and hash
224  *    table.
225  *
226  *    This leads to the next important difference with the server side: on the
227  *    client, it's quite usual to have objects with the different sequence of
228  *    layers. For example, typical top-object is composed of the following
229  *    layers:
230  *
231  *        - vvp
232  *        - lov
233  *
234  *    whereas its sub-objects are composed of
235  *
236  *        - lovsub
237  *        - osc
238  *
239  *    layers. Here "lovsub" is a mostly dummy layer, whose purpose is to keep
240  *    track of the object-subobject relationship.
241  *
242  *    Sub-objects are not cached independently: when top-object is about to
243  *    be discarded from the memory, all its sub-objects are torn-down and
244  *    destroyed too.
245  *
246  * \see ccc_object, lov_object, lovsub_object, osc_object
247  */
248 struct cl_object {
249         /** super class */
250         struct lu_object                   co_lu;
251         /** per-object-layer operations */
252         const struct cl_object_operations *co_ops;
253         /** offset of page slice in cl_page buffer */
254         int                                co_slice_off;
255 };
256
257 /**
258  * Description of the client object configuration. This is used for the
259  * creation of a new client object that is identified by a more state than
260  * fid.
261  */
262 struct cl_object_conf {
263         /** Super-class. */
264         struct lu_object_conf     coc_lu;
265         union {
266                 /**
267                  * Object layout. This is consumed by lov.
268                  */
269                 struct lustre_md *coc_md;
270                 /**
271                  * Description of particular stripe location in the
272                  * cluster. This is consumed by osc.
273                  */
274                 struct lov_oinfo *coc_oinfo;
275         } u;
276         /**
277          * VFS inode. This is consumed by vvp.
278          */
279         struct inode             *coc_inode;
280         /**
281          * Layout lock handle.
282          */
283         struct ldlm_lock         *coc_lock;
284         /**
285          * Operation to handle layout, OBJECT_CONF_XYZ.
286          */
287         int                       coc_opc;
288 };
289
290 enum {
291         /** configure layout, set up a new stripe, must be called while
292          * holding layout lock. */
293         OBJECT_CONF_SET = 0,
294         /** invalidate the current stripe configuration due to losing
295          * layout lock. */
296         OBJECT_CONF_INVALIDATE = 1,
297         /** wait for old layout to go away so that new layout can be
298          * set up. */
299         OBJECT_CONF_WAIT = 2
300 };
301
302 /**
303  * Operations implemented for each cl object layer.
304  *
305  * \see vvp_ops, lov_ops, lovsub_ops, osc_ops
306  */
307 struct cl_object_operations {
308         /**
309          * Initialize page slice for this layer. Called top-to-bottom through
310          * every object layer when a new cl_page is instantiated. Layer
311          * keeping private per-page data, or requiring its own page operations
312          * vector should allocate these data here, and attach then to the page
313          * by calling cl_page_slice_add(). \a vmpage is locked (in the VM
314          * sense). Optional.
315          *
316          * \retval NULL success.
317          *
318          * \retval ERR_PTR(errno) failure code.
319          *
320          * \retval valid-pointer pointer to already existing referenced page
321          *         to be used instead of newly created.
322          */
323         int  (*coo_page_init)(const struct lu_env *env, struct cl_object *obj,
324                                 struct cl_page *page, struct page *vmpage);
325         /**
326          * Initialize lock slice for this layer. Called top-to-bottom through
327          * every object layer when a new cl_lock is instantiated. Layer
328          * keeping private per-lock data, or requiring its own lock operations
329          * vector should allocate these data here, and attach then to the lock
330          * by calling cl_lock_slice_add(). Mandatory.
331          */
332         int  (*coo_lock_init)(const struct lu_env *env,
333                               struct cl_object *obj, struct cl_lock *lock,
334                               const struct cl_io *io);
335         /**
336          * Initialize io state for a given layer.
337          *
338          * called top-to-bottom once per io existence to initialize io
339          * state. If layer wants to keep some state for this type of io, it
340          * has to embed struct cl_io_slice in lu_env::le_ses, and register
341          * slice with cl_io_slice_add(). It is guaranteed that all threads
342          * participating in this io share the same session.
343          */
344         int  (*coo_io_init)(const struct lu_env *env,
345                             struct cl_object *obj, struct cl_io *io);
346         /**
347          * Fill portion of \a attr that this layer controls. This method is
348          * called top-to-bottom through all object layers.
349          *
350          * \pre cl_object_header::coh_attr_guard of the top-object is locked.
351          *
352          * \return   0: to continue
353          * \return +ve: to stop iterating through layers (but 0 is returned
354          * from enclosing cl_object_attr_get())
355          * \return -ve: to signal error
356          */
357         int (*coo_attr_get)(const struct lu_env *env, struct cl_object *obj,
358                             struct cl_attr *attr);
359         /**
360          * Update attributes.
361          *
362          * \a valid is a bitmask composed from enum #cl_attr_valid, and
363          * indicating what attributes are to be set.
364          *
365          * \pre cl_object_header::coh_attr_guard of the top-object is locked.
366          *
367          * \return the same convention as for
368          * cl_object_operations::coo_attr_get() is used.
369          */
370         int (*coo_attr_set)(const struct lu_env *env, struct cl_object *obj,
371                             const struct cl_attr *attr, unsigned valid);
372         /**
373          * Update object configuration. Called top-to-bottom to modify object
374          * configuration.
375          *
376          * XXX error conditions and handling.
377          */
378         int (*coo_conf_set)(const struct lu_env *env, struct cl_object *obj,
379                             const struct cl_object_conf *conf);
380         /**
381          * Glimpse ast. Executed when glimpse ast arrives for a lock on this
382          * object. Layers are supposed to fill parts of \a lvb that will be
383          * shipped to the glimpse originator as a glimpse result.
384          *
385          * \see ccc_object_glimpse(), lovsub_object_glimpse(),
386          * \see osc_object_glimpse()
387          */
388         int (*coo_glimpse)(const struct lu_env *env,
389                            const struct cl_object *obj, struct ost_lvb *lvb);
390         /**
391          * Object prune method. Called when the layout is going to change on
392          * this object, therefore each layer has to clean up their cache,
393          * mainly pages and locks.
394          */
395         int (*coo_prune)(const struct lu_env *env, struct cl_object *obj);
396 };
397
398 /**
399  * Extended header for client object.
400  */
401 struct cl_object_header {
402         /** Standard lu_object_header. cl_object::co_lu::lo_header points
403          * here. */
404         struct lu_object_header  coh_lu;
405         /** \name locks
406          * \todo XXX move locks below to the separate cache-lines, they are
407          * mostly useless otherwise.
408          */
409         /** @{ */
410         /** Lock protecting lock list. */
411         spinlock_t               coh_lock_guard;
412         /** @} locks */
413         /** List of cl_lock's granted for this object. */
414         cfs_list_t               coh_locks;
415
416         /**
417          * Parent object. It is assumed that an object has a well-defined
418          * parent, but not a well-defined child (there may be multiple
419          * sub-objects, for the same top-object). cl_object_header::coh_parent
420          * field allows certain code to be written generically, without
421          * limiting possible cl_object layouts unduly.
422          */
423         struct cl_object_header *coh_parent;
424         /**
425          * Protects consistency between cl_attr of parent object and
426          * attributes of sub-objects, that the former is calculated ("merged")
427          * from.
428          *
429          * \todo XXX this can be read/write lock if needed.
430          */
431         spinlock_t               coh_attr_guard;
432         /**
433          * Size of cl_page + page slices
434          */
435         unsigned short           coh_page_bufsize;
436         /**
437          * Number of objects above this one: 0 for a top-object, 1 for its
438          * sub-object, etc.
439          */
440         unsigned char            coh_nesting;
441 };
442
443 /**
444  * Helper macro: iterate over all layers of the object \a obj, assigning every
445  * layer top-to-bottom to \a slice.
446  */
447 #define cl_object_for_each(slice, obj)                                      \
448         cfs_list_for_each_entry((slice),                                    \
449                                 &(obj)->co_lu.lo_header->loh_layers,        \
450                                 co_lu.lo_linkage)
451 /**
452  * Helper macro: iterate over all layers of the object \a obj, assigning every
453  * layer bottom-to-top to \a slice.
454  */
455 #define cl_object_for_each_reverse(slice, obj)                               \
456         cfs_list_for_each_entry_reverse((slice),                             \
457                                         &(obj)->co_lu.lo_header->loh_layers, \
458                                         co_lu.lo_linkage)
459 /** @} cl_object */
460
461 #ifndef pgoff_t
462 #define pgoff_t unsigned long
463 #endif
464
465 #define CL_PAGE_EOF ((pgoff_t)~0ull)
466
467 /** \addtogroup cl_page cl_page
468  * @{ */
469
470 /** \struct cl_page
471  * Layered client page.
472  *
473  * cl_page: represents a portion of a file, cached in the memory. All pages
474  *    of the given file are of the same size, and are kept in the radix tree
475  *    hanging off the cl_object. cl_page doesn't fan out, but as sub-objects
476  *    of the top-level file object are first class cl_objects, they have their
477  *    own radix trees of pages and hence page is implemented as a sequence of
478  *    struct cl_pages's, linked into double-linked list through
479  *    cl_page::cp_parent and cl_page::cp_child pointers, each residing in the
480  *    corresponding radix tree at the corresponding logical offset.
481  *
482  * cl_page is associated with VM page of the hosting environment (struct
483  *    page in Linux kernel, for example), struct page. It is assumed, that this
484  *    association is implemented by one of cl_page layers (top layer in the
485  *    current design) that
486  *
487  *        - intercepts per-VM-page call-backs made by the environment (e.g.,
488  *          memory pressure),
489  *
490  *        - translates state (page flag bits) and locking between lustre and
491  *          environment.
492  *
493  *    The association between cl_page and struct page is immutable and
494  *    established when cl_page is created.
495  *
496  * cl_page can be "owned" by a particular cl_io (see below), guaranteeing
497  *    this io an exclusive access to this page w.r.t. other io attempts and
498  *    various events changing page state (such as transfer completion, or
499  *    eviction of the page from the memory). Note, that in general cl_io
500  *    cannot be identified with a particular thread, and page ownership is not
501  *    exactly equal to the current thread holding a lock on the page. Layer
502  *    implementing association between cl_page and struct page has to implement
503  *    ownership on top of available synchronization mechanisms.
504  *
505  *    While lustre client maintains the notion of an page ownership by io,
506  *    hosting MM/VM usually has its own page concurrency control
507  *    mechanisms. For example, in Linux, page access is synchronized by the
508  *    per-page PG_locked bit-lock, and generic kernel code (generic_file_*())
509  *    takes care to acquire and release such locks as necessary around the
510  *    calls to the file system methods (->readpage(), ->prepare_write(),
511  *    ->commit_write(), etc.). This leads to the situation when there are two
512  *    different ways to own a page in the client:
513  *
514  *        - client code explicitly and voluntary owns the page (cl_page_own());
515  *
516  *        - VM locks a page and then calls the client, that has "to assume"
517  *          the ownership from the VM (cl_page_assume()).
518  *
519  *    Dual methods to release ownership are cl_page_disown() and
520  *    cl_page_unassume().
521  *
522  * cl_page is reference counted (cl_page::cp_ref). When reference counter
523  *    drops to 0, the page is returned to the cache, unless it is in
524  *    cl_page_state::CPS_FREEING state, in which case it is immediately
525  *    destroyed.
526  *
527  *    The general logic guaranteeing the absence of "existential races" for
528  *    pages is the following:
529  *
530  *        - there are fixed known ways for a thread to obtain a new reference
531  *          to a page:
532  *
533  *            - by doing a lookup in the cl_object radix tree, protected by the
534  *              spin-lock;
535  *
536  *            - by starting from VM-locked struct page and following some
537  *              hosting environment method (e.g., following ->private pointer in
538  *              the case of Linux kernel), see cl_vmpage_page();
539  *
540  *        - when the page enters cl_page_state::CPS_FREEING state, all these
541  *          ways are severed with the proper synchronization
542  *          (cl_page_delete());
543  *
544  *        - entry into cl_page_state::CPS_FREEING is serialized by the VM page
545  *          lock;
546  *
547  *        - no new references to the page in cl_page_state::CPS_FREEING state
548  *          are allowed (checked in cl_page_get()).
549  *
550  *    Together this guarantees that when last reference to a
551  *    cl_page_state::CPS_FREEING page is released, it is safe to destroy the
552  *    page, as neither references to it can be acquired at that point, nor
553  *    ones exist.
554  *
555  * cl_page is a state machine. States are enumerated in enum
556  *    cl_page_state. Possible state transitions are enumerated in
557  *    cl_page_state_set(). State transition process (i.e., actual changing of
558  *    cl_page::cp_state field) is protected by the lock on the underlying VM
559  *    page.
560  *
561  * Linux Kernel implementation.
562  *
563  *    Binding between cl_page and struct page (which is a typedef for
564  *    struct page) is implemented in the vvp layer. cl_page is attached to the
565  *    ->private pointer of the struct page, together with the setting of
566  *    PG_private bit in page->flags, and acquiring additional reference on the
567  *    struct page (much like struct buffer_head, or any similar file system
568  *    private data structures).
569  *
570  *    PG_locked lock is used to implement both ownership and transfer
571  *    synchronization, that is, page is VM-locked in CPS_{OWNED,PAGE{IN,OUT}}
572  *    states. No additional references are acquired for the duration of the
573  *    transfer.
574  *
575  * \warning *THIS IS NOT* the behavior expected by the Linux kernel, where
576  *          write-out is "protected" by the special PG_writeback bit.
577  */
578
579 /**
580  * States of cl_page. cl_page.c assumes particular order here.
581  *
582  * The page state machine is rather crude, as it doesn't recognize finer page
583  * states like "dirty" or "up to date". This is because such states are not
584  * always well defined for the whole stack (see, for example, the
585  * implementation of the read-ahead, that hides page up-to-dateness to track
586  * cache hits accurately). Such sub-states are maintained by the layers that
587  * are interested in them.
588  */
589 enum cl_page_state {
590         /**
591          * Page is in the cache, un-owned. Page leaves cached state in the
592          * following cases:
593          *
594          *     - [cl_page_state::CPS_OWNED] io comes across the page and
595          *     owns it;
596          *
597          *     - [cl_page_state::CPS_PAGEOUT] page is dirty, the
598          *     req-formation engine decides that it wants to include this page
599          *     into an cl_req being constructed, and yanks it from the cache;
600          *
601          *     - [cl_page_state::CPS_FREEING] VM callback is executed to
602          *     evict the page form the memory;
603          *
604          * \invariant cl_page::cp_owner == NULL && cl_page::cp_req == NULL
605          */
606         CPS_CACHED,
607         /**
608          * Page is exclusively owned by some cl_io. Page may end up in this
609          * state as a result of
610          *
611          *     - io creating new page and immediately owning it;
612          *
613          *     - [cl_page_state::CPS_CACHED] io finding existing cached page
614          *     and owning it;
615          *
616          *     - [cl_page_state::CPS_OWNED] io finding existing owned page
617          *     and waiting for owner to release the page;
618          *
619          * Page leaves owned state in the following cases:
620          *
621          *     - [cl_page_state::CPS_CACHED] io decides to leave the page in
622          *     the cache, doing nothing;
623          *
624          *     - [cl_page_state::CPS_PAGEIN] io starts read transfer for
625          *     this page;
626          *
627          *     - [cl_page_state::CPS_PAGEOUT] io starts immediate write
628          *     transfer for this page;
629          *
630          *     - [cl_page_state::CPS_FREEING] io decides to destroy this
631          *     page (e.g., as part of truncate or extent lock cancellation).
632          *
633          * \invariant cl_page::cp_owner != NULL && cl_page::cp_req == NULL
634          */
635         CPS_OWNED,
636         /**
637          * Page is being written out, as a part of a transfer. This state is
638          * entered when req-formation logic decided that it wants this page to
639          * be sent through the wire _now_. Specifically, it means that once
640          * this state is achieved, transfer completion handler (with either
641          * success or failure indication) is guaranteed to be executed against
642          * this page independently of any locks and any scheduling decisions
643          * made by the hosting environment (that effectively means that the
644          * page is never put into cl_page_state::CPS_PAGEOUT state "in
645          * advance". This property is mentioned, because it is important when
646          * reasoning about possible dead-locks in the system). The page can
647          * enter this state as a result of
648          *
649          *     - [cl_page_state::CPS_OWNED] an io requesting an immediate
650          *     write-out of this page, or
651          *
652          *     - [cl_page_state::CPS_CACHED] req-forming engine deciding
653          *     that it has enough dirty pages cached to issue a "good"
654          *     transfer.
655          *
656          * The page leaves cl_page_state::CPS_PAGEOUT state when the transfer
657          * is completed---it is moved into cl_page_state::CPS_CACHED state.
658          *
659          * Underlying VM page is locked for the duration of transfer.
660          *
661          * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req != NULL
662          */
663         CPS_PAGEOUT,
664         /**
665          * Page is being read in, as a part of a transfer. This is quite
666          * similar to the cl_page_state::CPS_PAGEOUT state, except that
667          * read-in is always "immediate"---there is no such thing a sudden
668          * construction of read cl_req from cached, presumably not up to date,
669          * pages.
670          *
671          * Underlying VM page is locked for the duration of transfer.
672          *
673          * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req != NULL
674          */
675         CPS_PAGEIN,
676         /**
677          * Page is being destroyed. This state is entered when client decides
678          * that page has to be deleted from its host object, as, e.g., a part
679          * of truncate.
680          *
681          * Once this state is reached, there is no way to escape it.
682          *
683          * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req == NULL
684          */
685         CPS_FREEING,
686         CPS_NR
687 };
688
689 enum cl_page_type {
690         /** Host page, the page is from the host inode which the cl_page
691          * belongs to. */
692         CPT_CACHEABLE = 1,
693
694         /** Transient page, the transient cl_page is used to bind a cl_page
695          *  to vmpage which is not belonging to the same object of cl_page.
696          *  it is used in DirectIO, lockless IO and liblustre. */
697         CPT_TRANSIENT,
698 };
699
700 /**
701  * Flags maintained for every cl_page.
702  */
703 enum cl_page_flags {
704         /**
705          * Set when pagein completes. Used for debugging (read completes at
706          * most once for a page).
707          */
708         CPF_READ_COMPLETED = 1 << 0
709 };
710
711 /**
712  * Fields are protected by the lock on struct page, except for atomics and
713  * immutables.
714  *
715  * \invariant Data type invariants are in cl_page_invariant(). Basically:
716  * cl_page::cp_parent and cl_page::cp_child are a well-formed double-linked
717  * list, consistent with the parent/child pointers in the cl_page::cp_obj and
718  * cl_page::cp_owner (when set).
719  */
720 struct cl_page {
721         /** Reference counter. */
722         cfs_atomic_t             cp_ref;
723         /** An object this page is a part of. Immutable after creation. */
724         struct cl_object        *cp_obj;
725         /** Logical page index within the object. Immutable after creation. */
726         pgoff_t                  cp_index;
727         /** List of slices. Immutable after creation. */
728         cfs_list_t               cp_layers;
729         /** Parent page, NULL for top-level page. Immutable after creation. */
730         struct cl_page          *cp_parent;
731         /** Lower-layer page. NULL for bottommost page. Immutable after
732          * creation. */
733         struct cl_page          *cp_child;
734         /**
735          * Page state. This field is const to avoid accidental update, it is
736          * modified only internally within cl_page.c. Protected by a VM lock.
737          */
738         const enum cl_page_state cp_state;
739         /** Linkage of pages within group. Protected by cl_page::cp_mutex. */
740         cfs_list_t              cp_batch;
741         /** Mutex serializing membership of a page in a batch. */
742         struct mutex            cp_mutex;
743         /** Linkage of pages within cl_req. */
744         cfs_list_t               cp_flight;
745         /** Transfer error. */
746         int                      cp_error;
747
748         /**
749          * Page type. Only CPT_TRANSIENT is used so far. Immutable after
750          * creation.
751          */
752         enum cl_page_type        cp_type;
753
754         /**
755          * Owning IO in cl_page_state::CPS_OWNED state. Sub-page can be owned
756          * by sub-io. Protected by a VM lock.
757          */
758         struct cl_io            *cp_owner;
759         /**
760          * Debug information, the task is owning the page.
761          */
762         struct task_struct      *cp_task;
763         /**
764          * Owning IO request in cl_page_state::CPS_PAGEOUT and
765          * cl_page_state::CPS_PAGEIN states. This field is maintained only in
766          * the top-level pages. Protected by a VM lock.
767          */
768         struct cl_req           *cp_req;
769         /** List of references to this page, for debugging. */
770         struct lu_ref            cp_reference;
771         /** Link to an object, for debugging. */
772         struct lu_ref_link       cp_obj_ref;
773         /** Link to a queue, for debugging. */
774         struct lu_ref_link       cp_queue_ref;
775         /** Per-page flags from enum cl_page_flags. Protected by a VM lock. */
776         unsigned                 cp_flags;
777         /** Assigned if doing a sync_io */
778         struct cl_sync_io       *cp_sync_io;
779 };
780
781 /**
782  * Per-layer part of cl_page.
783  *
784  * \see ccc_page, lov_page, osc_page
785  */
786 struct cl_page_slice {
787         struct cl_page                  *cpl_page;
788         /**
789          * Object slice corresponding to this page slice. Immutable after
790          * creation.
791          */
792         struct cl_object                *cpl_obj;
793         const struct cl_page_operations *cpl_ops;
794         /** Linkage into cl_page::cp_layers. Immutable after creation. */
795         cfs_list_t                       cpl_linkage;
796 };
797
798 /**
799  * Lock mode. For the client extent locks.
800  *
801  * \warning: cl_lock_mode_match() assumes particular ordering here.
802  * \ingroup cl_lock
803  */
804 enum cl_lock_mode {
805         /**
806          * Mode of a lock that protects no data, and exists only as a
807          * placeholder. This is used for `glimpse' requests. A phantom lock
808          * might get promoted to real lock at some point.
809          */
810         CLM_PHANTOM,
811         CLM_READ,
812         CLM_WRITE,
813         CLM_GROUP
814 };
815
816 /**
817  * Requested transfer type.
818  * \ingroup cl_req
819  */
820 enum cl_req_type {
821         CRT_READ,
822         CRT_WRITE,
823         CRT_NR
824 };
825
826 /**
827  * Per-layer page operations.
828  *
829  * Methods taking an \a io argument are for the activity happening in the
830  * context of given \a io. Page is assumed to be owned by that io, except for
831  * the obvious cases (like cl_page_operations::cpo_own()).
832  *
833  * \see vvp_page_ops, lov_page_ops, osc_page_ops
834  */
835 struct cl_page_operations {
836         /**
837          * cl_page<->struct page methods. Only one layer in the stack has to
838          * implement these. Current code assumes that this functionality is
839          * provided by the topmost layer, see cl_page_disown0() as an example.
840          */
841
842         /**
843          * \return the underlying VM page. Optional.
844          */
845         struct page *(*cpo_vmpage)(const struct lu_env *env,
846                                   const struct cl_page_slice *slice);
847         /**
848          * Called when \a io acquires this page into the exclusive
849          * ownership. When this method returns, it is guaranteed that the is
850          * not owned by other io, and no transfer is going on against
851          * it. Optional.
852          *
853          * \see cl_page_own()
854          * \see vvp_page_own(), lov_page_own()
855          */
856         int  (*cpo_own)(const struct lu_env *env,
857                         const struct cl_page_slice *slice,
858                         struct cl_io *io, int nonblock);
859         /** Called when ownership it yielded. Optional.
860          *
861          * \see cl_page_disown()
862          * \see vvp_page_disown()
863          */
864         void (*cpo_disown)(const struct lu_env *env,
865                            const struct cl_page_slice *slice, struct cl_io *io);
866         /**
867          * Called for a page that is already "owned" by \a io from VM point of
868          * view. Optional.
869          *
870          * \see cl_page_assume()
871          * \see vvp_page_assume(), lov_page_assume()
872          */
873         void (*cpo_assume)(const struct lu_env *env,
874                            const struct cl_page_slice *slice, struct cl_io *io);
875         /** Dual to cl_page_operations::cpo_assume(). Optional. Called
876          * bottom-to-top when IO releases a page without actually unlocking
877          * it.
878          *
879          * \see cl_page_unassume()
880          * \see vvp_page_unassume()
881          */
882         void (*cpo_unassume)(const struct lu_env *env,
883                              const struct cl_page_slice *slice,
884                              struct cl_io *io);
885         /**
886          * Announces whether the page contains valid data or not by \a uptodate.
887          *
888          * \see cl_page_export()
889          * \see vvp_page_export()
890          */
891         void  (*cpo_export)(const struct lu_env *env,
892                             const struct cl_page_slice *slice, int uptodate);
893         /**
894          * Checks whether underlying VM page is locked (in the suitable
895          * sense). Used for assertions.
896          *
897          * \retval    -EBUSY: page is protected by a lock of a given mode;
898          * \retval  -ENODATA: page is not protected by a lock;
899          * \retval         0: this layer cannot decide. (Should never happen.)
900          */
901         int (*cpo_is_vmlocked)(const struct lu_env *env,
902                                const struct cl_page_slice *slice);
903         /**
904          * Page destruction.
905          */
906
907         /**
908          * Called when page is truncated from the object. Optional.
909          *
910          * \see cl_page_discard()
911          * \see vvp_page_discard(), osc_page_discard()
912          */
913         void (*cpo_discard)(const struct lu_env *env,
914                             const struct cl_page_slice *slice,
915                             struct cl_io *io);
916         /**
917          * Called when page is removed from the cache, and is about to being
918          * destroyed. Optional.
919          *
920          * \see cl_page_delete()
921          * \see vvp_page_delete(), osc_page_delete()
922          */
923         void (*cpo_delete)(const struct lu_env *env,
924                            const struct cl_page_slice *slice);
925         /** Destructor. Frees resources and slice itself. */
926         void (*cpo_fini)(const struct lu_env *env,
927                          struct cl_page_slice *slice);
928
929         /**
930          * Checks whether the page is protected by a cl_lock. This is a
931          * per-layer method, because certain layers have ways to check for the
932          * lock much more efficiently than through the generic locks scan, or
933          * implement locking mechanisms separate from cl_lock, e.g.,
934          * LL_FILE_GROUP_LOCKED in vvp. If \a pending is true, check for locks
935          * being canceled, or scheduled for cancellation as soon as the last
936          * user goes away, too.
937          *
938          * \retval    -EBUSY: page is protected by a lock of a given mode;
939          * \retval  -ENODATA: page is not protected by a lock;
940          * \retval         0: this layer cannot decide.
941          *
942          * \see cl_page_is_under_lock()
943          */
944         int (*cpo_is_under_lock)(const struct lu_env *env,
945                                  const struct cl_page_slice *slice,
946                                  struct cl_io *io);
947
948         /**
949          * Optional debugging helper. Prints given page slice.
950          *
951          * \see cl_page_print()
952          */
953         int (*cpo_print)(const struct lu_env *env,
954                          const struct cl_page_slice *slice,
955                          void *cookie, lu_printer_t p);
956         /**
957          * \name transfer
958          *
959          * Transfer methods. See comment on cl_req for a description of
960          * transfer formation and life-cycle.
961          *
962          * @{
963          */
964         /**
965          * Request type dependent vector of operations.
966          *
967          * Transfer operations depend on transfer mode (cl_req_type). To avoid
968          * passing transfer mode to each and every of these methods, and to
969          * avoid branching on request type inside of the methods, separate
970          * methods for cl_req_type:CRT_READ and cl_req_type:CRT_WRITE are
971          * provided. That is, method invocation usually looks like
972          *
973          *         slice->cp_ops.io[req->crq_type].cpo_method(env, slice, ...);
974          */
975         struct {
976                 /**
977                  * Called when a page is submitted for a transfer as a part of
978                  * cl_page_list.
979                  *
980                  * \return    0         : page is eligible for submission;
981                  * \return    -EALREADY : skip this page;
982                  * \return    -ve       : error.
983                  *
984                  * \see cl_page_prep()
985                  */
986                 int  (*cpo_prep)(const struct lu_env *env,
987                                  const struct cl_page_slice *slice,
988                                  struct cl_io *io);
989                 /**
990                  * Completion handler. This is guaranteed to be eventually
991                  * fired after cl_page_operations::cpo_prep() or
992                  * cl_page_operations::cpo_make_ready() call.
993                  *
994                  * This method can be called in a non-blocking context. It is
995                  * guaranteed however, that the page involved and its object
996                  * are pinned in memory (and, hence, calling cl_page_put() is
997                  * safe).
998                  *
999                  * \see cl_page_completion()
1000                  */
1001                 void (*cpo_completion)(const struct lu_env *env,
1002                                        const struct cl_page_slice *slice,
1003                                        int ioret);
1004                 /**
1005                  * Called when cached page is about to be added to the
1006                  * cl_req as a part of req formation.
1007                  *
1008                  * \return    0       : proceed with this page;
1009                  * \return    -EAGAIN : skip this page;
1010                  * \return    -ve     : error.
1011                  *
1012                  * \see cl_page_make_ready()
1013                  */
1014                 int  (*cpo_make_ready)(const struct lu_env *env,
1015                                        const struct cl_page_slice *slice);
1016         } io[CRT_NR];
1017         /**
1018          * Tell transfer engine that only [to, from] part of a page should be
1019          * transmitted.
1020          *
1021          * This is used for immediate transfers.
1022          *
1023          * \todo XXX this is not very good interface. It would be much better
1024          * if all transfer parameters were supplied as arguments to
1025          * cl_io_operations::cio_submit() call, but it is not clear how to do
1026          * this for page queues.
1027          *
1028          * \see cl_page_clip()
1029          */
1030         void (*cpo_clip)(const struct lu_env *env,
1031                          const struct cl_page_slice *slice,
1032                          int from, int to);
1033         /**
1034          * \pre  the page was queued for transferring.
1035          * \post page is removed from client's pending list, or -EBUSY
1036          *       is returned if it has already been in transferring.
1037          *
1038          * This is one of seldom page operation which is:
1039          * 0. called from top level;
1040          * 1. don't have vmpage locked;
1041          * 2. every layer should synchronize execution of its ->cpo_cancel()
1042          *    with completion handlers. Osc uses client obd lock for this
1043          *    purpose. Based on there is no vvp_page_cancel and
1044          *    lov_page_cancel(), cpo_cancel is defacto protected by client lock.
1045          *
1046          * \see osc_page_cancel().
1047          */
1048         int (*cpo_cancel)(const struct lu_env *env,
1049                           const struct cl_page_slice *slice);
1050         /**
1051          * Write out a page by kernel. This is only called by ll_writepage
1052          * right now.
1053          *
1054          * \see cl_page_flush()
1055          */
1056         int (*cpo_flush)(const struct lu_env *env,
1057                          const struct cl_page_slice *slice,
1058                          struct cl_io *io);
1059         /** @} transfer */
1060 };
1061
1062 /**
1063  * Helper macro, dumping detailed information about \a page into a log.
1064  */
1065 #define CL_PAGE_DEBUG(mask, env, page, format, ...)                     \
1066 do {                                                                    \
1067         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
1068                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);        \
1069                 cl_page_print(env, &msgdata, lu_cdebug_printer, page);  \
1070                 CDEBUG(mask, format , ## __VA_ARGS__);                  \
1071         }                                                               \
1072 } while (0)
1073
1074 /**
1075  * Helper macro, dumping shorter information about \a page into a log.
1076  */
1077 #define CL_PAGE_HEADER(mask, env, page, format, ...)                          \
1078 do {                                                                          \
1079         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                         \
1080                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);              \
1081                 cl_page_header_print(env, &msgdata, lu_cdebug_printer, page); \
1082                 CDEBUG(mask, format , ## __VA_ARGS__);                        \
1083         }                                                                     \
1084 } while (0)
1085
1086 static inline int __page_in_use(const struct cl_page *page, int refc)
1087 {
1088         if (page->cp_type == CPT_CACHEABLE)
1089                 ++refc;
1090         LASSERT(cfs_atomic_read(&page->cp_ref) > 0);
1091         return (cfs_atomic_read(&page->cp_ref) > refc);
1092 }
1093 #define cl_page_in_use(pg)       __page_in_use(pg, 1)
1094 #define cl_page_in_use_noref(pg) __page_in_use(pg, 0)
1095
1096 /** @} cl_page */
1097
1098 /** \addtogroup cl_lock cl_lock
1099  * @{ */
1100 /** \struct cl_lock
1101  *
1102  * Extent locking on the client.
1103  *
1104  * LAYERING
1105  *
1106  * The locking model of the new client code is built around
1107  *
1108  *        struct cl_lock
1109  *
1110  * data-type representing an extent lock on a regular file. cl_lock is a
1111  * layered object (much like cl_object and cl_page), it consists of a header
1112  * (struct cl_lock) and a list of layers (struct cl_lock_slice), linked to
1113  * cl_lock::cll_layers list through cl_lock_slice::cls_linkage.
1114  *
1115  * All locks for a given object are linked into cl_object_header::coh_locks
1116  * list (protected by cl_object_header::coh_lock_guard spin-lock) through
1117  * cl_lock::cll_linkage. Currently this list is not sorted in any way. We can
1118  * sort it in starting lock offset, or use altogether different data structure
1119  * like a tree.
1120  *
1121  * Typical cl_lock consists of the two layers:
1122  *
1123  *     - vvp_lock (vvp specific data), and
1124  *     - lov_lock (lov specific data).
1125  *
1126  * lov_lock contains an array of sub-locks. Each of these sub-locks is a
1127  * normal cl_lock: it has a header (struct cl_lock) and a list of layers:
1128  *
1129  *     - lovsub_lock, and
1130  *     - osc_lock
1131  *
1132  * Each sub-lock is associated with a cl_object (representing stripe
1133  * sub-object or the file to which top-level cl_lock is associated to), and is
1134  * linked into that cl_object::coh_locks. In this respect cl_lock is similar to
1135  * cl_object (that at lov layer also fans out into multiple sub-objects), and
1136  * is different from cl_page, that doesn't fan out (there is usually exactly
1137  * one osc_page for every vvp_page). We shall call vvp-lov portion of the lock
1138  * a "top-lock" and its lovsub-osc portion a "sub-lock".
1139  *
1140  * LIFE CYCLE
1141  *
1142  * cl_lock is reference counted. When reference counter drops to 0, lock is
1143  * placed in the cache, except when lock is in CLS_FREEING state. CLS_FREEING
1144  * lock is destroyed when last reference is released. Referencing between
1145  * top-lock and its sub-locks is described in the lov documentation module.
1146  *
1147  * STATE MACHINE
1148  *
1149  * Also, cl_lock is a state machine. This requires some clarification. One of
1150  * the goals of client IO re-write was to make IO path non-blocking, or at
1151  * least to make it easier to make it non-blocking in the future. Here
1152  * `non-blocking' means that when a system call (read, write, truncate)
1153  * reaches a situation where it has to wait for a communication with the
1154  * server, it should --instead of waiting-- remember its current state and
1155  * switch to some other work.  E.g,. instead of waiting for a lock enqueue,
1156  * client should proceed doing IO on the next stripe, etc. Obviously this is
1157  * rather radical redesign, and it is not planned to be fully implemented at
1158  * this time, instead we are putting some infrastructure in place, that would
1159  * make it easier to do asynchronous non-blocking IO easier in the
1160  * future. Specifically, where old locking code goes to sleep (waiting for
1161  * enqueue, for example), new code returns cl_lock_transition::CLO_WAIT. When
1162  * enqueue reply comes, its completion handler signals that lock state-machine
1163  * is ready to transit to the next state. There is some generic code in
1164  * cl_lock.c that sleeps, waiting for these signals. As a result, for users of
1165  * this cl_lock.c code, it looks like locking is done in normal blocking
1166  * fashion, and it the same time it is possible to switch to the non-blocking
1167  * locking (simply by returning cl_lock_transition::CLO_WAIT from cl_lock.c
1168  * functions).
1169  *
1170  * For a description of state machine states and transitions see enum
1171  * cl_lock_state.
1172  *
1173  * There are two ways to restrict a set of states which lock might move to:
1174  *
1175  *     - placing a "hold" on a lock guarantees that lock will not be moved
1176  *       into cl_lock_state::CLS_FREEING state until hold is released. Hold
1177  *       can be only acquired on a lock that is not in
1178  *       cl_lock_state::CLS_FREEING. All holds on a lock are counted in
1179  *       cl_lock::cll_holds. Hold protects lock from cancellation and
1180  *       destruction. Requests to cancel and destroy a lock on hold will be
1181  *       recorded, but only honored when last hold on a lock is released;
1182  *
1183  *     - placing a "user" on a lock guarantees that lock will not leave
1184  *       cl_lock_state::CLS_NEW, cl_lock_state::CLS_QUEUING,
1185  *       cl_lock_state::CLS_ENQUEUED and cl_lock_state::CLS_HELD set of
1186  *       states, once it enters this set. That is, if a user is added onto a
1187  *       lock in a state not from this set, it doesn't immediately enforce
1188  *       lock to move to this set, but once lock enters this set it will
1189  *       remain there until all users are removed. Lock users are counted in
1190  *       cl_lock::cll_users.
1191  *
1192  *       User is used to assure that lock is not canceled or destroyed while
1193  *       it is being enqueued, or actively used by some IO.
1194  *
1195  *       Currently, a user always comes with a hold (cl_lock_invariant()
1196  *       checks that a number of holds is not less than a number of users).
1197  *
1198  * CONCURRENCY
1199  *
1200  * This is how lock state-machine operates. struct cl_lock contains a mutex
1201  * cl_lock::cll_guard that protects struct fields.
1202  *
1203  *     - mutex is taken, and cl_lock::cll_state is examined.
1204  *
1205  *     - for every state there are possible target states where lock can move
1206  *       into. They are tried in order. Attempts to move into next state are
1207  *       done by _try() functions in cl_lock.c:cl_{enqueue,unlock,wait}_try().
1208  *
1209  *     - if the transition can be performed immediately, state is changed,
1210  *       and mutex is released.
1211  *
1212  *     - if the transition requires blocking, _try() function returns
1213  *       cl_lock_transition::CLO_WAIT. Caller unlocks mutex and goes to
1214  *       sleep, waiting for possibility of lock state change. It is woken
1215  *       up when some event occurs, that makes lock state change possible
1216  *       (e.g., the reception of the reply from the server), and repeats
1217  *       the loop.
1218  *
1219  * Top-lock and sub-lock has separate mutexes and the latter has to be taken
1220  * first to avoid dead-lock.
1221  *
1222  * To see an example of interaction of all these issues, take a look at the
1223  * lov_cl.c:lov_lock_enqueue() function. It is called as a part of
1224  * cl_enqueue_try(), and tries to advance top-lock to ENQUEUED state, by
1225  * advancing state-machines of its sub-locks (lov_lock_enqueue_one()). Note
1226  * also, that it uses trylock to grab sub-lock mutex to avoid dead-lock. It
1227  * also has to handle CEF_ASYNC enqueue, when sub-locks enqueues have to be
1228  * done in parallel, rather than one after another (this is used for glimpse
1229  * locks, that cannot dead-lock).
1230  *
1231  * INTERFACE AND USAGE
1232  *
1233  * struct cl_lock_operations provide a number of call-backs that are invoked
1234  * when events of interest occurs. Layers can intercept and handle glimpse,
1235  * blocking, cancel ASTs and a reception of the reply from the server.
1236  *
1237  * One important difference with the old client locking model is that new
1238  * client has a representation for the top-lock, whereas in the old code only
1239  * sub-locks existed as real data structures and file-level locks are
1240  * represented by "request sets" that are created and destroyed on each and
1241  * every lock creation.
1242  *
1243  * Top-locks are cached, and can be found in the cache by the system calls. It
1244  * is possible that top-lock is in cache, but some of its sub-locks were
1245  * canceled and destroyed. In that case top-lock has to be enqueued again
1246  * before it can be used.
1247  *
1248  * Overall process of the locking during IO operation is as following:
1249  *
1250  *     - once parameters for IO are setup in cl_io, cl_io_operations::cio_lock()
1251  *       is called on each layer. Responsibility of this method is to add locks,
1252  *       needed by a given layer into cl_io.ci_lockset.
1253  *
1254  *     - once locks for all layers were collected, they are sorted to avoid
1255  *       dead-locks (cl_io_locks_sort()), and enqueued.
1256  *
1257  *     - when all locks are acquired, IO is performed;
1258  *
1259  *     - locks are released into cache.
1260  *
1261  * Striping introduces major additional complexity into locking. The
1262  * fundamental problem is that it is generally unsafe to actively use (hold)
1263  * two locks on the different OST servers at the same time, as this introduces
1264  * inter-server dependency and can lead to cascading evictions.
1265  *
1266  * Basic solution is to sub-divide large read/write IOs into smaller pieces so
1267  * that no multi-stripe locks are taken (note that this design abandons POSIX
1268  * read/write semantics). Such pieces ideally can be executed concurrently. At
1269  * the same time, certain types of IO cannot be sub-divived, without
1270  * sacrificing correctness. This includes:
1271  *
1272  *  - O_APPEND write, where [0, EOF] lock has to be taken, to guarantee
1273  *  atomicity;
1274  *
1275  *  - ftruncate(fd, offset), where [offset, EOF] lock has to be taken.
1276  *
1277  * Also, in the case of read(fd, buf, count) or write(fd, buf, count), where
1278  * buf is a part of memory mapped Lustre file, a lock or locks protecting buf
1279  * has to be held together with the usual lock on [offset, offset + count].
1280  *
1281  * As multi-stripe locks have to be allowed, it makes sense to cache them, so
1282  * that, for example, a sequence of O_APPEND writes can proceed quickly
1283  * without going down to the individual stripes to do lock matching. On the
1284  * other hand, multi-stripe locks shouldn't be used by normal read/write
1285  * calls. To achieve this, every layer can implement ->clo_fits_into() method,
1286  * that is called by lock matching code (cl_lock_lookup()), and that can be
1287  * used to selectively disable matching of certain locks for certain IOs. For
1288  * exmaple, lov layer implements lov_lock_fits_into() that allow multi-stripe
1289  * locks to be matched only for truncates and O_APPEND writes.
1290  *
1291  * Interaction with DLM
1292  *
1293  * In the expected setup, cl_lock is ultimately backed up by a collection of
1294  * DLM locks (struct ldlm_lock). Association between cl_lock and DLM lock is
1295  * implemented in osc layer, that also matches DLM events (ASTs, cancellation,
1296  * etc.) into cl_lock_operation calls. See struct osc_lock for a more detailed
1297  * description of interaction with DLM.
1298  */
1299
1300 /**
1301  * Lock description.
1302  */
1303 struct cl_lock_descr {
1304         /** Object this lock is granted for. */
1305         struct cl_object *cld_obj;
1306         /** Index of the first page protected by this lock. */
1307         pgoff_t           cld_start;
1308         /** Index of the last page (inclusive) protected by this lock. */
1309         pgoff_t           cld_end;
1310         /** Group ID, for group lock */
1311         __u64             cld_gid;
1312         /** Lock mode. */
1313         enum cl_lock_mode cld_mode;
1314         /**
1315          * flags to enqueue lock. A combination of bit-flags from
1316          * enum cl_enq_flags.
1317          */
1318         __u32             cld_enq_flags;
1319 };
1320
1321 #define DDESCR "%s(%d):[%lu, %lu]"
1322 #define PDESCR(descr)                                                   \
1323         cl_lock_mode_name((descr)->cld_mode), (descr)->cld_mode,        \
1324         (descr)->cld_start, (descr)->cld_end
1325
1326 const char *cl_lock_mode_name(const enum cl_lock_mode mode);
1327
1328 /**
1329  * Lock state-machine states.
1330  *
1331  * \htmlonly
1332  * <pre>
1333  *
1334  * Possible state transitions:
1335  *
1336  *              +------------------>NEW
1337  *              |                    |
1338  *              |                    | cl_enqueue_try()
1339  *              |                    |
1340  *              |    cl_unuse_try()  V
1341  *              |  +--------------QUEUING (*)
1342  *              |  |                 |
1343  *              |  |                 | cl_enqueue_try()
1344  *              |  |                 |
1345  *              |  | cl_unuse_try()  V
1346  *    sub-lock  |  +-------------ENQUEUED (*)
1347  *    canceled  |  |                 |
1348  *              |  |                 | cl_wait_try()
1349  *              |  |                 |
1350  *              |  |                (R)
1351  *              |  |                 |
1352  *              |  |                 V
1353  *              |  |                HELD<---------+
1354  *              |  |                 |            |
1355  *              |  |                 |            | cl_use_try()
1356  *              |  |  cl_unuse_try() |            |
1357  *              |  |                 |            |
1358  *              |  |                 V         ---+ 
1359  *              |  +------------>INTRANSIT (D) <--+
1360  *              |                    |            |
1361  *              |     cl_unuse_try() |            | cached lock found
1362  *              |                    |            | cl_use_try()
1363  *              |                    |            |
1364  *              |                    V            |
1365  *              +------------------CACHED---------+
1366  *                                   |
1367  *                                  (C)
1368  *                                   |
1369  *                                   V
1370  *                                FREEING
1371  *
1372  * Legend:
1373  *
1374  *         In states marked with (*) transition to the same state (i.e., a loop
1375  *         in the diagram) is possible.
1376  *
1377  *         (R) is the point where Receive call-back is invoked: it allows layers
1378  *         to handle arrival of lock reply.
1379  *
1380  *         (C) is the point where Cancellation call-back is invoked.
1381  *
1382  *         (D) is the transit state which means the lock is changing.
1383  *
1384  *         Transition to FREEING state is possible from any other state in the
1385  *         diagram in case of unrecoverable error.
1386  * </pre>
1387  * \endhtmlonly
1388  *
1389  * These states are for individual cl_lock object. Top-lock and its sub-locks
1390  * can be in the different states. Another way to say this is that we have
1391  * nested state-machines.
1392  *
1393  * Separate QUEUING and ENQUEUED states are needed to support non-blocking
1394  * operation for locks with multiple sub-locks. Imagine lock on a file F, that
1395  * intersects 3 stripes S0, S1, and S2. To enqueue F client has to send
1396  * enqueue to S0, wait for its completion, then send enqueue for S1, wait for
1397  * its completion and at last enqueue lock for S2, and wait for its
1398  * completion. In that case, top-lock is in QUEUING state while S0, S1 are
1399  * handled, and is in ENQUEUED state after enqueue to S2 has been sent (note
1400  * that in this case, sub-locks move from state to state, and top-lock remains
1401  * in the same state).
1402  */
1403 enum cl_lock_state {
1404         /**
1405          * Lock that wasn't yet enqueued
1406          */
1407         CLS_NEW,
1408         /**
1409          * Enqueue is in progress, blocking for some intermediate interaction
1410          * with the other side.
1411          */
1412         CLS_QUEUING,
1413         /**
1414          * Lock is fully enqueued, waiting for server to reply when it is
1415          * granted.
1416          */
1417         CLS_ENQUEUED,
1418         /**
1419          * Lock granted, actively used by some IO.
1420          */
1421         CLS_HELD,
1422         /**
1423          * This state is used to mark the lock is being used, or unused.
1424          * We need this state because the lock may have several sublocks,
1425          * so it's impossible to have an atomic way to bring all sublocks
1426          * into CLS_HELD state at use case, or all sublocks to CLS_CACHED
1427          * at unuse case.
1428          * If a thread is referring to a lock, and it sees the lock is in this
1429          * state, it must wait for the lock.
1430          * See state diagram for details.
1431          */
1432         CLS_INTRANSIT,
1433         /**
1434          * Lock granted, not used.
1435          */
1436         CLS_CACHED,
1437         /**
1438          * Lock is being destroyed.
1439          */
1440         CLS_FREEING,
1441         CLS_NR
1442 };
1443
1444 enum cl_lock_flags {
1445         /**
1446          * lock has been cancelled. This flag is never cleared once set (by
1447          * cl_lock_cancel0()).
1448          */
1449         CLF_CANCELLED  = 1 << 0,
1450         /** cancellation is pending for this lock. */
1451         CLF_CANCELPEND = 1 << 1,
1452         /** destruction is pending for this lock. */
1453         CLF_DOOMED     = 1 << 2,
1454         /** from enqueue RPC reply upcall. */
1455         CLF_FROM_UPCALL= 1 << 3,
1456 };
1457
1458 /**
1459  * Lock closure.
1460  *
1461  * Lock closure is a collection of locks (both top-locks and sub-locks) that
1462  * might be updated in a result of an operation on a certain lock (which lock
1463  * this is a closure of).
1464  *
1465  * Closures are needed to guarantee dead-lock freedom in the presence of
1466  *
1467  *     - nested state-machines (top-lock state-machine composed of sub-lock
1468  *       state-machines), and
1469  *
1470  *     - shared sub-locks.
1471  *
1472  * Specifically, many operations, such as lock enqueue, wait, unlock,
1473  * etc. start from a top-lock, and then operate on a sub-locks of this
1474  * top-lock, holding a top-lock mutex. When sub-lock state changes as a result
1475  * of such operation, this change has to be propagated to all top-locks that
1476  * share this sub-lock. Obviously, no natural lock ordering (e.g.,
1477  * top-to-bottom or bottom-to-top) captures this scenario, so try-locking has
1478  * to be used. Lock closure systematizes this try-and-repeat logic.
1479  */
1480 struct cl_lock_closure {
1481         /**
1482          * Lock that is mutexed when closure construction is started. When
1483          * closure in is `wait' mode (cl_lock_closure::clc_wait), mutex on
1484          * origin is released before waiting.
1485          */
1486         struct cl_lock   *clc_origin;
1487         /**
1488          * List of enclosed locks, so far. Locks are linked here through
1489          * cl_lock::cll_inclosure.
1490          */
1491         cfs_list_t        clc_list;
1492         /**
1493          * True iff closure is in a `wait' mode. This determines what
1494          * cl_lock_enclosure() does when a lock L to be added to the closure
1495          * is currently mutexed by some other thread.
1496          *
1497          * If cl_lock_closure::clc_wait is not set, then closure construction
1498          * fails with CLO_REPEAT immediately.
1499          *
1500          * In wait mode, cl_lock_enclosure() waits until next attempt to build
1501          * a closure might succeed. To this end it releases an origin mutex
1502          * (cl_lock_closure::clc_origin), that has to be the only lock mutex
1503          * owned by the current thread, and then waits on L mutex (by grabbing
1504          * it and immediately releasing), before returning CLO_REPEAT to the
1505          * caller.
1506          */
1507         int               clc_wait;
1508         /** Number of locks in the closure. */
1509         int               clc_nr;
1510 };
1511
1512 /**
1513  * Layered client lock.
1514  */
1515 struct cl_lock {
1516         /** Reference counter. */
1517         cfs_atomic_t          cll_ref;
1518         /** List of slices. Immutable after creation. */
1519         cfs_list_t            cll_layers;
1520         /**
1521          * Linkage into cl_lock::cll_descr::cld_obj::coh_locks list. Protected
1522          * by cl_lock::cll_descr::cld_obj::coh_lock_guard.
1523          */
1524         cfs_list_t            cll_linkage;
1525         /**
1526          * Parameters of this lock. Protected by
1527          * cl_lock::cll_descr::cld_obj::coh_lock_guard nested within
1528          * cl_lock::cll_guard. Modified only on lock creation and in
1529          * cl_lock_modify().
1530          */
1531         struct cl_lock_descr  cll_descr;
1532         /** Protected by cl_lock::cll_guard. */
1533         enum cl_lock_state    cll_state;
1534         /** signals state changes. */
1535         wait_queue_head_t     cll_wq;
1536         /**
1537          * Recursive lock, most fields in cl_lock{} are protected by this.
1538          *
1539          * Locking rules: this mutex is never held across network
1540          * communication, except when lock is being canceled.
1541          *
1542          * Lock ordering: a mutex of a sub-lock is taken first, then a mutex
1543          * on a top-lock. Other direction is implemented through a
1544          * try-lock-repeat loop. Mutices of unrelated locks can be taken only
1545          * by try-locking.
1546          *
1547          * \see osc_lock_enqueue_wait(), lov_lock_cancel(), lov_sublock_wait().
1548          */
1549         struct mutex            cll_guard;
1550         struct task_struct    *cll_guarder;
1551         int                   cll_depth;
1552
1553         /**
1554          * the owner for INTRANSIT state
1555          */
1556         struct task_struct    *cll_intransit_owner;
1557         int                   cll_error;
1558         /**
1559          * Number of holds on a lock. A hold prevents a lock from being
1560          * canceled and destroyed. Protected by cl_lock::cll_guard.
1561          *
1562          * \see cl_lock_hold(), cl_lock_unhold(), cl_lock_release()
1563          */
1564         int                   cll_holds;
1565          /**
1566           * Number of lock users. Valid in cl_lock_state::CLS_HELD state
1567           * only. Lock user pins lock in CLS_HELD state. Protected by
1568           * cl_lock::cll_guard.
1569           *
1570           * \see cl_wait(), cl_unuse().
1571           */
1572         int                   cll_users;
1573         /**
1574          * Flag bit-mask. Values from enum cl_lock_flags. Updates are
1575          * protected by cl_lock::cll_guard.
1576          */
1577         unsigned long         cll_flags;
1578         /**
1579          * A linkage into a list of locks in a closure.
1580          *
1581          * \see cl_lock_closure
1582          */
1583         cfs_list_t            cll_inclosure;
1584         /**
1585          * Confict lock at queuing time.
1586          */
1587         struct cl_lock       *cll_conflict;
1588         /**
1589          * A list of references to this lock, for debugging.
1590          */
1591         struct lu_ref         cll_reference;
1592         /**
1593          * A list of holds on this lock, for debugging.
1594          */
1595         struct lu_ref         cll_holders;
1596         /**
1597          * A reference for cl_lock::cll_descr::cld_obj. For debugging.
1598          */
1599         struct lu_ref_link    cll_obj_ref;
1600 #ifdef CONFIG_LOCKDEP
1601         /* "dep_map" name is assumed by lockdep.h macros. */
1602         struct lockdep_map    dep_map;
1603 #endif
1604 };
1605
1606 /**
1607  * Per-layer part of cl_lock
1608  *
1609  * \see ccc_lock, lov_lock, lovsub_lock, osc_lock
1610  */
1611 struct cl_lock_slice {
1612         struct cl_lock                  *cls_lock;
1613         /** Object slice corresponding to this lock slice. Immutable after
1614          * creation. */
1615         struct cl_object                *cls_obj;
1616         const struct cl_lock_operations *cls_ops;
1617         /** Linkage into cl_lock::cll_layers. Immutable after creation. */
1618         cfs_list_t                       cls_linkage;
1619 };
1620
1621 /**
1622  * Possible (non-error) return values of ->clo_{enqueue,wait,unlock}().
1623  *
1624  * NOTE: lov_subresult() depends on ordering here.
1625  */
1626 enum cl_lock_transition {
1627         /** operation cannot be completed immediately. Wait for state change. */
1628         CLO_WAIT        = 1,
1629         /** operation had to release lock mutex, restart. */
1630         CLO_REPEAT      = 2,
1631         /** lower layer re-enqueued. */
1632         CLO_REENQUEUED  = 3,
1633 };
1634
1635 /**
1636  *
1637  * \see vvp_lock_ops, lov_lock_ops, lovsub_lock_ops, osc_lock_ops
1638  */
1639 struct cl_lock_operations {
1640         /**
1641          * \name statemachine
1642          *
1643          * State machine transitions. These 3 methods are called to transfer
1644          * lock from one state to another, as described in the commentary
1645          * above enum #cl_lock_state.
1646          *
1647          * \retval 0          this layer has nothing more to do to before
1648          *                       transition to the target state happens;
1649          *
1650          * \retval CLO_REPEAT method had to release and re-acquire cl_lock
1651          *                    mutex, repeat invocation of transition method
1652          *                    across all layers;
1653          *
1654          * \retval CLO_WAIT   this layer cannot move to the target state
1655          *                    immediately, as it has to wait for certain event
1656          *                    (e.g., the communication with the server). It
1657          *                    is guaranteed, that when the state transfer
1658          *                    becomes possible, cl_lock::cll_wq wait-queue
1659          *                    is signaled. Caller can wait for this event by
1660          *                    calling cl_lock_state_wait();
1661          *
1662          * \retval -ve        failure, abort state transition, move the lock
1663          *                    into cl_lock_state::CLS_FREEING state, and set
1664          *                    cl_lock::cll_error.
1665          *
1666          * Once all layers voted to agree to transition (by returning 0), lock
1667          * is moved into corresponding target state. All state transition
1668          * methods are optional.
1669          */
1670         /** @{ */
1671         /**
1672          * Attempts to enqueue the lock. Called top-to-bottom.
1673          *
1674          * \see ccc_lock_enqueue(), lov_lock_enqueue(), lovsub_lock_enqueue(),
1675          * \see osc_lock_enqueue()
1676          */
1677         int  (*clo_enqueue)(const struct lu_env *env,
1678                             const struct cl_lock_slice *slice,
1679                             struct cl_io *io, __u32 enqflags);
1680         /**
1681          * Attempts to wait for enqueue result. Called top-to-bottom.
1682          *
1683          * \see ccc_lock_wait(), lov_lock_wait(), osc_lock_wait()
1684          */
1685         int  (*clo_wait)(const struct lu_env *env,
1686                          const struct cl_lock_slice *slice);
1687         /**
1688          * Attempts to unlock the lock. Called bottom-to-top. In addition to
1689          * usual return values of lock state-machine methods, this can return
1690          * -ESTALE to indicate that lock cannot be returned to the cache, and
1691          * has to be re-initialized.
1692          * unuse is a one-shot operation, so it must NOT return CLO_WAIT.
1693          *
1694          * \see ccc_lock_unuse(), lov_lock_unuse(), osc_lock_unuse()
1695          */
1696         int  (*clo_unuse)(const struct lu_env *env,
1697                           const struct cl_lock_slice *slice);
1698         /**
1699          * Notifies layer that cached lock is started being used.
1700          *
1701          * \pre lock->cll_state == CLS_CACHED
1702          *
1703          * \see lov_lock_use(), osc_lock_use()
1704          */
1705         int  (*clo_use)(const struct lu_env *env,
1706                         const struct cl_lock_slice *slice);
1707         /** @} statemachine */
1708         /**
1709          * A method invoked when lock state is changed (as a result of state
1710          * transition). This is used, for example, to track when the state of
1711          * a sub-lock changes, to propagate this change to the corresponding
1712          * top-lock. Optional
1713          *
1714          * \see lovsub_lock_state()
1715          */
1716         void (*clo_state)(const struct lu_env *env,
1717                           const struct cl_lock_slice *slice,
1718                           enum cl_lock_state st);
1719         /**
1720          * Returns true, iff given lock is suitable for the given io, idea
1721          * being, that there are certain "unsafe" locks, e.g., ones acquired
1722          * for O_APPEND writes, that we don't want to re-use for a normal
1723          * write, to avoid the danger of cascading evictions. Optional. Runs
1724          * under cl_object_header::coh_lock_guard.
1725          *
1726          * XXX this should take more information about lock needed by
1727          * io. Probably lock description or something similar.
1728          *
1729          * \see lov_fits_into()
1730          */
1731         int (*clo_fits_into)(const struct lu_env *env,
1732                              const struct cl_lock_slice *slice,
1733                              const struct cl_lock_descr *need,
1734                              const struct cl_io *io);
1735         /**
1736          * \name ast
1737          * Asynchronous System Traps. All of then are optional, all are
1738          * executed bottom-to-top.
1739          */
1740         /** @{ */
1741
1742         /**
1743          * Cancellation callback. Cancel a lock voluntarily, or under
1744          * the request of server.
1745          */
1746         void (*clo_cancel)(const struct lu_env *env,
1747                            const struct cl_lock_slice *slice);
1748         /**
1749          * Lock weighting ast. Executed to estimate how precious this lock
1750          * is. The sum of results across all layers is used to determine
1751          * whether lock worth keeping in cache given present memory usage.
1752          *
1753          * \see osc_lock_weigh(), vvp_lock_weigh(), lovsub_lock_weigh().
1754          */
1755         unsigned long (*clo_weigh)(const struct lu_env *env,
1756                                    const struct cl_lock_slice *slice);
1757         /** @} ast */
1758
1759         /**
1760          * \see lovsub_lock_closure()
1761          */
1762         int (*clo_closure)(const struct lu_env *env,
1763                            const struct cl_lock_slice *slice,
1764                            struct cl_lock_closure *closure);
1765         /**
1766          * Executed bottom-to-top when lock description changes (e.g., as a
1767          * result of server granting more generous lock than was requested).
1768          *
1769          * \see lovsub_lock_modify()
1770          */
1771         int (*clo_modify)(const struct lu_env *env,
1772                           const struct cl_lock_slice *slice,
1773                           const struct cl_lock_descr *updated);
1774         /**
1775          * Notifies layers (bottom-to-top) that lock is going to be
1776          * destroyed. Responsibility of layers is to prevent new references on
1777          * this lock from being acquired once this method returns.
1778          *
1779          * This can be called multiple times due to the races.
1780          *
1781          * \see cl_lock_delete()
1782          * \see osc_lock_delete(), lovsub_lock_delete()
1783          */
1784         void (*clo_delete)(const struct lu_env *env,
1785                            const struct cl_lock_slice *slice);
1786         /**
1787          * Destructor. Frees resources and the slice.
1788          *
1789          * \see ccc_lock_fini(), lov_lock_fini(), lovsub_lock_fini(),
1790          * \see osc_lock_fini()
1791          */
1792         void (*clo_fini)(const struct lu_env *env, struct cl_lock_slice *slice);
1793         /**
1794          * Optional debugging helper. Prints given lock slice.
1795          */
1796         int (*clo_print)(const struct lu_env *env,
1797                          void *cookie, lu_printer_t p,
1798                          const struct cl_lock_slice *slice);
1799 };
1800
1801 #define CL_LOCK_DEBUG(mask, env, lock, format, ...)                     \
1802 do {                                                                    \
1803         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
1804                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);        \
1805                 cl_lock_print(env, &msgdata, lu_cdebug_printer, lock);  \
1806                 CDEBUG(mask, format , ## __VA_ARGS__);                  \
1807         }                                                               \
1808 } while (0)
1809
1810 #define CL_LOCK_ASSERT(expr, env, lock) do {                            \
1811         if (likely(expr))                                               \
1812                 break;                                                  \
1813                                                                         \
1814         CL_LOCK_DEBUG(D_ERROR, env, lock, "failed at %s.\n", #expr);    \
1815         LBUG();                                                         \
1816 } while (0)
1817
1818 /** @} cl_lock */
1819
1820 /** \addtogroup cl_page_list cl_page_list
1821  * Page list used to perform collective operations on a group of pages.
1822  *
1823  * Pages are added to the list one by one. cl_page_list acquires a reference
1824  * for every page in it. Page list is used to perform collective operations on
1825  * pages:
1826  *
1827  *     - submit pages for an immediate transfer,
1828  *
1829  *     - own pages on behalf of certain io (waiting for each page in turn),
1830  *
1831  *     - discard pages.
1832  *
1833  * When list is finalized, it releases references on all pages it still has.
1834  *
1835  * \todo XXX concurrency control.
1836  *
1837  * @{
1838  */
1839 struct cl_page_list {
1840         unsigned             pl_nr;
1841         cfs_list_t           pl_pages;
1842         struct task_struct   *pl_owner;
1843 };
1844
1845 /** 
1846  * A 2-queue of pages. A convenience data-type for common use case, 2-queue
1847  * contains an incoming page list and an outgoing page list.
1848  */
1849 struct cl_2queue {
1850         struct cl_page_list c2_qin;
1851         struct cl_page_list c2_qout;
1852 };
1853
1854 /** @} cl_page_list */
1855
1856 /** \addtogroup cl_io cl_io
1857  * @{ */
1858 /** \struct cl_io
1859  * I/O
1860  *
1861  * cl_io represents a high level I/O activity like
1862  * read(2)/write(2)/truncate(2) system call, or cancellation of an extent
1863  * lock.
1864  *
1865  * cl_io is a layered object, much like cl_{object,page,lock} but with one
1866  * important distinction. We want to minimize number of calls to the allocator
1867  * in the fast path, e.g., in the case of read(2) when everything is cached:
1868  * client already owns the lock over region being read, and data are cached
1869  * due to read-ahead. To avoid allocation of cl_io layers in such situations,
1870  * per-layer io state is stored in the session, associated with the io, see
1871  * struct {vvp,lov,osc}_io for example. Sessions allocation is amortized
1872  * by using free-lists, see cl_env_get().
1873  *
1874  * There is a small predefined number of possible io types, enumerated in enum
1875  * cl_io_type.
1876  *
1877  * cl_io is a state machine, that can be advanced concurrently by the multiple
1878  * threads. It is up to these threads to control the concurrency and,
1879  * specifically, to detect when io is done, and its state can be safely
1880  * released.
1881  *
1882  * For read/write io overall execution plan is as following:
1883  *
1884  *     (0) initialize io state through all layers;
1885  *
1886  *     (1) loop: prepare chunk of work to do
1887  *
1888  *     (2) call all layers to collect locks they need to process current chunk
1889  *
1890  *     (3) sort all locks to avoid dead-locks, and acquire them
1891  *
1892  *     (4) process the chunk: call per-page methods
1893  *         (cl_io_operations::cio_read_page() for read,
1894  *         cl_io_operations::cio_prepare_write(),
1895  *         cl_io_operations::cio_commit_write() for write)
1896  *
1897  *     (5) release locks
1898  *
1899  *     (6) repeat loop.
1900  *
1901  * To implement the "parallel IO mode", lov layer creates sub-io's (lazily to
1902  * address allocation efficiency issues mentioned above), and returns with the
1903  * special error condition from per-page method when current sub-io has to
1904  * block. This causes io loop to be repeated, and lov switches to the next
1905  * sub-io in its cl_io_operations::cio_iter_init() implementation.
1906  */
1907
1908 /** IO types */
1909 enum cl_io_type {
1910         /** read system call */
1911         CIT_READ,
1912         /** write system call */
1913         CIT_WRITE,
1914         /** truncate, utime system calls */
1915         CIT_SETATTR,
1916         /**
1917          * page fault handling
1918          */
1919         CIT_FAULT,
1920         /**
1921          * fsync system call handling
1922          * To write out a range of file
1923          */
1924         CIT_FSYNC,
1925         /**
1926          * Miscellaneous io. This is used for occasional io activity that
1927          * doesn't fit into other types. Currently this is used for:
1928          *
1929          *     - cancellation of an extent lock. This io exists as a context
1930          *     to write dirty pages from under the lock being canceled back
1931          *     to the server;
1932          *
1933          *     - VM induced page write-out. An io context for writing page out
1934          *     for memory cleansing;
1935          *
1936          *     - glimpse. An io context to acquire glimpse lock.
1937          *
1938          *     - grouplock. An io context to acquire group lock.
1939          *
1940          * CIT_MISC io is used simply as a context in which locks and pages
1941          * are manipulated. Such io has no internal "process", that is,
1942          * cl_io_loop() is never called for it.
1943          */
1944         CIT_MISC,
1945         CIT_OP_NR
1946 };
1947
1948 /**
1949  * States of cl_io state machine
1950  */
1951 enum cl_io_state {
1952         /** Not initialized. */
1953         CIS_ZERO,
1954         /** Initialized. */
1955         CIS_INIT,
1956         /** IO iteration started. */
1957         CIS_IT_STARTED,
1958         /** Locks taken. */
1959         CIS_LOCKED,
1960         /** Actual IO is in progress. */
1961         CIS_IO_GOING,
1962         /** IO for the current iteration finished. */
1963         CIS_IO_FINISHED,
1964         /** Locks released. */
1965         CIS_UNLOCKED,
1966         /** Iteration completed. */
1967         CIS_IT_ENDED,
1968         /** cl_io finalized. */
1969         CIS_FINI
1970 };
1971
1972 /**
1973  * IO state private for a layer.
1974  *
1975  * This is usually embedded into layer session data, rather than allocated
1976  * dynamically.
1977  *
1978  * \see vvp_io, lov_io, osc_io, ccc_io
1979  */
1980 struct cl_io_slice {
1981         struct cl_io                  *cis_io;
1982         /** corresponding object slice. Immutable after creation. */
1983         struct cl_object              *cis_obj;
1984         /** io operations. Immutable after creation. */
1985         const struct cl_io_operations *cis_iop;
1986         /**
1987          * linkage into a list of all slices for a given cl_io, hanging off
1988          * cl_io::ci_layers. Immutable after creation.
1989          */
1990         cfs_list_t                     cis_linkage;
1991 };
1992
1993 typedef void (*cl_commit_cbt)(const struct lu_env *, struct cl_io *,
1994                                 struct cl_page *);
1995
1996 /**
1997  * Per-layer io operations.
1998  * \see vvp_io_ops, lov_io_ops, lovsub_io_ops, osc_io_ops
1999  */
2000 struct cl_io_operations {
2001         /**
2002          * Vector of io state transition methods for every io type.
2003          *
2004          * \see cl_page_operations::io
2005          */
2006         struct {
2007                 /**
2008                  * Prepare io iteration at a given layer.
2009                  *
2010                  * Called top-to-bottom at the beginning of each iteration of
2011                  * "io loop" (if it makes sense for this type of io). Here
2012                  * layer selects what work it will do during this iteration.
2013                  *
2014                  * \see cl_io_operations::cio_iter_fini()
2015                  */
2016                 int (*cio_iter_init) (const struct lu_env *env,
2017                                       const struct cl_io_slice *slice);
2018                 /**
2019                  * Finalize io iteration.
2020                  *
2021                  * Called bottom-to-top at the end of each iteration of "io
2022                  * loop". Here layers can decide whether IO has to be
2023                  * continued.
2024                  *
2025                  * \see cl_io_operations::cio_iter_init()
2026                  */
2027                 void (*cio_iter_fini) (const struct lu_env *env,
2028                                        const struct cl_io_slice *slice);
2029                 /**
2030                  * Collect locks for the current iteration of io.
2031                  *
2032                  * Called top-to-bottom to collect all locks necessary for
2033                  * this iteration. This methods shouldn't actually enqueue
2034                  * anything, instead it should post a lock through
2035                  * cl_io_lock_add(). Once all locks are collected, they are
2036                  * sorted and enqueued in the proper order.
2037                  */
2038                 int  (*cio_lock) (const struct lu_env *env,
2039                                   const struct cl_io_slice *slice);
2040                 /**
2041                  * Finalize unlocking.
2042                  *
2043                  * Called bottom-to-top to finish layer specific unlocking
2044                  * functionality, after generic code released all locks
2045                  * acquired by cl_io_operations::cio_lock().
2046                  */
2047                 void  (*cio_unlock)(const struct lu_env *env,
2048                                     const struct cl_io_slice *slice);
2049                 /**
2050                  * Start io iteration.
2051                  *
2052                  * Once all locks are acquired, called top-to-bottom to
2053                  * commence actual IO. In the current implementation,
2054                  * top-level vvp_io_{read,write}_start() does all the work
2055                  * synchronously by calling generic_file_*(), so other layers
2056                  * are called when everything is done.
2057                  */
2058                 int  (*cio_start)(const struct lu_env *env,
2059                                   const struct cl_io_slice *slice);
2060                 /**
2061                  * Called top-to-bottom at the end of io loop. Here layer
2062                  * might wait for an unfinished asynchronous io.
2063                  */
2064                 void (*cio_end)  (const struct lu_env *env,
2065                                   const struct cl_io_slice *slice);
2066                 /**
2067                  * Called bottom-to-top to notify layers that read/write IO
2068                  * iteration finished, with \a nob bytes transferred.
2069                  */
2070                 void (*cio_advance)(const struct lu_env *env,
2071                                     const struct cl_io_slice *slice,
2072                                     size_t nob);
2073                 /**
2074                  * Called once per io, bottom-to-top to release io resources.
2075                  */
2076                 void (*cio_fini) (const struct lu_env *env,
2077                                   const struct cl_io_slice *slice);
2078         } op[CIT_OP_NR];
2079
2080         /**
2081          * Submit pages from \a queue->c2_qin for IO, and move
2082          * successfully submitted pages into \a queue->c2_qout. Return
2083          * non-zero if failed to submit even the single page. If
2084          * submission failed after some pages were moved into \a
2085          * queue->c2_qout, completion callback with non-zero ioret is
2086          * executed on them.
2087          */
2088         int  (*cio_submit)(const struct lu_env *env,
2089                         const struct cl_io_slice *slice,
2090                         enum cl_req_type crt,
2091                         struct cl_2queue *queue);
2092         /**
2093          * Queue async page for write.
2094          * The difference between cio_submit and cio_queue is that
2095          * cio_submit is for urgent request.
2096          */
2097         int  (*cio_commit_async)(const struct lu_env *env,
2098                         const struct cl_io_slice *slice,
2099                         struct cl_page_list *queue, int from, int to,
2100                         cl_commit_cbt cb);
2101         /**
2102          * Read missing page.
2103          *
2104          * Called by a top-level cl_io_operations::op[CIT_READ]::cio_start()
2105          * method, when it hits not-up-to-date page in the range. Optional.
2106          *
2107          * \pre io->ci_type == CIT_READ
2108          */
2109         int (*cio_read_page)(const struct lu_env *env,
2110                              const struct cl_io_slice *slice,
2111                              const struct cl_page_slice *page);
2112         /**
2113          * Optional debugging helper. Print given io slice.
2114          */
2115         int (*cio_print)(const struct lu_env *env, void *cookie,
2116                          lu_printer_t p, const struct cl_io_slice *slice);
2117 };
2118
2119 /**
2120  * Flags to lock enqueue procedure.
2121  * \ingroup cl_lock
2122  */
2123 enum cl_enq_flags {
2124         /**
2125          * instruct server to not block, if conflicting lock is found. Instead
2126          * -EWOULDBLOCK is returned immediately.
2127          */
2128         CEF_NONBLOCK     = 0x00000001,
2129         /**
2130          * take lock asynchronously (out of order), as it cannot
2131          * deadlock. This is for LDLM_FL_HAS_INTENT locks used for glimpsing.
2132          */
2133         CEF_ASYNC        = 0x00000002,
2134         /**
2135          * tell the server to instruct (though a flag in the blocking ast) an
2136          * owner of the conflicting lock, that it can drop dirty pages
2137          * protected by this lock, without sending them to the server.
2138          */
2139         CEF_DISCARD_DATA = 0x00000004,
2140         /**
2141          * tell the sub layers that it must be a `real' lock. This is used for
2142          * mmapped-buffer locks and glimpse locks that must be never converted
2143          * into lockless mode.
2144          *
2145          * \see vvp_mmap_locks(), cl_glimpse_lock().
2146          */
2147         CEF_MUST         = 0x00000008,
2148         /**
2149          * tell the sub layers that never request a `real' lock. This flag is
2150          * not used currently.
2151          *
2152          * cl_io::ci_lockreq and CEF_{MUST,NEVER} flags specify lockless
2153          * conversion policy: ci_lockreq describes generic information of lock
2154          * requirement for this IO, especially for locks which belong to the
2155          * object doing IO; however, lock itself may have precise requirements
2156          * that are described by the enqueue flags.
2157          */
2158         CEF_NEVER        = 0x00000010,
2159         /**
2160          * for async glimpse lock.
2161          */
2162         CEF_AGL          = 0x00000020,
2163         /**
2164          * mask of enq_flags.
2165          */
2166         CEF_MASK         = 0x0000003f,
2167 };
2168
2169 /**
2170  * Link between lock and io. Intermediate structure is needed, because the
2171  * same lock can be part of multiple io's simultaneously.
2172  */
2173 struct cl_io_lock_link {
2174         /** linkage into one of cl_lockset lists. */
2175         cfs_list_t           cill_linkage;
2176         struct cl_lock_descr cill_descr;
2177         struct cl_lock      *cill_lock;
2178         /** optional destructor */
2179         void               (*cill_fini)(const struct lu_env *env,
2180                                         struct cl_io_lock_link *link);
2181 };
2182
2183 /**
2184  * Lock-set represents a collection of locks, that io needs at a
2185  * time. Generally speaking, client tries to avoid holding multiple locks when
2186  * possible, because
2187  *
2188  *      - holding extent locks over multiple ost's introduces the danger of
2189  *        "cascading timeouts";
2190  *
2191  *      - holding multiple locks over the same ost is still dead-lock prone,
2192  *        see comment in osc_lock_enqueue(),
2193  *
2194  * but there are certain situations where this is unavoidable:
2195  *
2196  *      - O_APPEND writes have to take [0, EOF] lock for correctness;
2197  *
2198  *      - truncate has to take [new-size, EOF] lock for correctness;
2199  *
2200  *      - SNS has to take locks across full stripe for correctness;
2201  *
2202  *      - in the case when user level buffer, supplied to {read,write}(file0),
2203  *        is a part of a memory mapped lustre file, client has to take a dlm
2204  *        locks on file0, and all files that back up the buffer (or a part of
2205  *        the buffer, that is being processed in the current chunk, in any
2206  *        case, there are situations where at least 2 locks are necessary).
2207  *
2208  * In such cases we at least try to take locks in the same consistent
2209  * order. To this end, all locks are first collected, then sorted, and then
2210  * enqueued.
2211  */
2212 struct cl_lockset {
2213         /** locks to be acquired. */
2214         cfs_list_t  cls_todo;
2215         /** locks currently being processed. */
2216         cfs_list_t  cls_curr;
2217         /** locks acquired. */
2218         cfs_list_t  cls_done;
2219 };
2220
2221 /**
2222  * Lock requirements(demand) for IO. It should be cl_io_lock_req,
2223  * but 'req' is always to be thought as 'request' :-)
2224  */
2225 enum cl_io_lock_dmd {
2226         /** Always lock data (e.g., O_APPEND). */
2227         CILR_MANDATORY = 0,
2228         /** Layers are free to decide between local and global locking. */
2229         CILR_MAYBE,
2230         /** Never lock: there is no cache (e.g., liblustre). */
2231         CILR_NEVER
2232 };
2233
2234 enum cl_fsync_mode {
2235         /** start writeback, do not wait for them to finish */
2236         CL_FSYNC_NONE  = 0,
2237         /** start writeback and wait for them to finish */
2238         CL_FSYNC_LOCAL = 1,
2239         /** discard all of dirty pages in a specific file range */
2240         CL_FSYNC_DISCARD = 2,
2241         /** start writeback and make sure they have reached storage before
2242          * return. OST_SYNC RPC must be issued and finished */
2243         CL_FSYNC_ALL   = 3
2244 };
2245
2246 struct cl_io_rw_common {
2247         loff_t      crw_pos;
2248         size_t      crw_count;
2249         int         crw_nonblock;
2250 };
2251
2252
2253 /**
2254  * State for io.
2255  *
2256  * cl_io is shared by all threads participating in this IO (in current
2257  * implementation only one thread advances IO, but parallel IO design and
2258  * concurrent copy_*_user() require multiple threads acting on the same IO. It
2259  * is up to these threads to serialize their activities, including updates to
2260  * mutable cl_io fields.
2261  */
2262 struct cl_io {
2263         /** type of this IO. Immutable after creation. */
2264         enum cl_io_type                ci_type;
2265         /** current state of cl_io state machine. */
2266         enum cl_io_state               ci_state;
2267         /** main object this io is against. Immutable after creation. */
2268         struct cl_object              *ci_obj;
2269         /**
2270          * Upper layer io, of which this io is a part of. Immutable after
2271          * creation.
2272          */
2273         struct cl_io                  *ci_parent;
2274         /** List of slices. Immutable after creation. */
2275         cfs_list_t                     ci_layers;
2276         /** list of locks (to be) acquired by this io. */
2277         struct cl_lockset              ci_lockset;
2278         /** lock requirements, this is just a help info for sublayers. */
2279         enum cl_io_lock_dmd            ci_lockreq;
2280         union {
2281                 struct cl_rd_io {
2282                         struct cl_io_rw_common rd;
2283                 } ci_rd;
2284                 struct cl_wr_io {
2285                         struct cl_io_rw_common wr;
2286                         int                    wr_append;
2287                         int                    wr_sync;
2288                 } ci_wr;
2289                 struct cl_io_rw_common ci_rw;
2290                 struct cl_setattr_io {
2291                         struct ost_lvb   sa_attr;
2292                         unsigned int     sa_valid;
2293                         struct obd_capa *sa_capa;
2294                 } ci_setattr;
2295                 struct cl_fault_io {
2296                         /** page index within file. */
2297                         pgoff_t         ft_index;
2298                         /** bytes valid byte on a faulted page. */
2299                         int             ft_nob;
2300                         /** writable page? for nopage() only */
2301                         int             ft_writable;
2302                         /** page of an executable? */
2303                         int             ft_executable;
2304                         /** page_mkwrite() */
2305                         int             ft_mkwrite;
2306                         /** resulting page */
2307                         struct cl_page *ft_page;
2308                 } ci_fault;
2309                 struct cl_fsync_io {
2310                         loff_t             fi_start;
2311                         loff_t             fi_end;
2312                         struct obd_capa   *fi_capa;
2313                         /** file system level fid */
2314                         struct lu_fid     *fi_fid;
2315                         enum cl_fsync_mode fi_mode;
2316                         /* how many pages were written/discarded */
2317                         unsigned int       fi_nr_written;
2318                 } ci_fsync;
2319         } u;
2320         struct cl_2queue     ci_queue;
2321         size_t               ci_nob;
2322         int                  ci_result;
2323         unsigned int         ci_continue:1,
2324         /**
2325          * This io has held grouplock, to inform sublayers that
2326          * don't do lockless i/o.
2327          */
2328                              ci_no_srvlock:1,
2329         /**
2330          * The whole IO need to be restarted because layout has been changed
2331          */
2332                              ci_need_restart:1,
2333         /**
2334          * to not refresh layout - the IO issuer knows that the layout won't
2335          * change(page operations, layout change causes all page to be
2336          * discarded), or it doesn't matter if it changes(sync).
2337          */
2338                              ci_ignore_layout:1,
2339         /**
2340          * Check if layout changed after the IO finishes. Mainly for HSM
2341          * requirement. If IO occurs to openning files, it doesn't need to
2342          * verify layout because HSM won't release openning files.
2343          * Right now, only two opertaions need to verify layout: glimpse
2344          * and setattr.
2345          */
2346                              ci_verify_layout:1,
2347         /**
2348          * file is released, restore has to to be triggered by vvp layer
2349          */
2350                              ci_restore_needed:1,
2351         /**
2352          * O_NOATIME
2353          */
2354                              ci_noatime:1;
2355         /**
2356          * Number of pages owned by this IO. For invariant checking.
2357          */
2358         unsigned             ci_owned_nr;
2359 };
2360
2361 /** @} cl_io */
2362
2363 /** \addtogroup cl_req cl_req
2364  * @{ */
2365 /** \struct cl_req
2366  * Transfer.
2367  *
2368  * There are two possible modes of transfer initiation on the client:
2369  *
2370  *     - immediate transfer: this is started when a high level io wants a page
2371  *       or a collection of pages to be transferred right away. Examples:
2372  *       read-ahead, synchronous read in the case of non-page aligned write,
2373  *       page write-out as a part of extent lock cancellation, page write-out
2374  *       as a part of memory cleansing. Immediate transfer can be both
2375  *       cl_req_type::CRT_READ and cl_req_type::CRT_WRITE;
2376  *
2377  *     - opportunistic transfer (cl_req_type::CRT_WRITE only), that happens
2378  *       when io wants to transfer a page to the server some time later, when
2379  *       it can be done efficiently. Example: pages dirtied by the write(2)
2380  *       path.
2381  *
2382  * In any case, transfer takes place in the form of a cl_req, which is a
2383  * representation for a network RPC.
2384  *
2385  * Pages queued for an opportunistic transfer are cached until it is decided
2386  * that efficient RPC can be composed of them. This decision is made by "a
2387  * req-formation engine", currently implemented as a part of osc
2388  * layer. Req-formation depends on many factors: the size of the resulting
2389  * RPC, whether or not multi-object RPCs are supported by the server,
2390  * max-rpc-in-flight limitations, size of the dirty cache, etc.
2391  *
2392  * For the immediate transfer io submits a cl_page_list, that req-formation
2393  * engine slices into cl_req's, possibly adding cached pages to some of
2394  * the resulting req's.
2395  *
2396  * Whenever a page from cl_page_list is added to a newly constructed req, its
2397  * cl_page_operations::cpo_prep() layer methods are called. At that moment,
2398  * page state is atomically changed from cl_page_state::CPS_OWNED to
2399  * cl_page_state::CPS_PAGEOUT or cl_page_state::CPS_PAGEIN, cl_page::cp_owner
2400  * is zeroed, and cl_page::cp_req is set to the
2401  * req. cl_page_operations::cpo_prep() method at the particular layer might
2402  * return -EALREADY to indicate that it does not need to submit this page
2403  * at all. This is possible, for example, if page, submitted for read,
2404  * became up-to-date in the meantime; and for write, the page don't have
2405  * dirty bit marked. \see cl_io_submit_rw()
2406  *
2407  * Whenever a cached page is added to a newly constructed req, its
2408  * cl_page_operations::cpo_make_ready() layer methods are called. At that
2409  * moment, page state is atomically changed from cl_page_state::CPS_CACHED to
2410  * cl_page_state::CPS_PAGEOUT, and cl_page::cp_req is set to
2411  * req. cl_page_operations::cpo_make_ready() method at the particular layer
2412  * might return -EAGAIN to indicate that this page is not eligible for the
2413  * transfer right now.
2414  *
2415  * FUTURE
2416  *
2417  * Plan is to divide transfers into "priority bands" (indicated when
2418  * submitting cl_page_list, and queuing a page for the opportunistic transfer)
2419  * and allow glueing of cached pages to immediate transfers only within single
2420  * band. This would make high priority transfers (like lock cancellation or
2421  * memory pressure induced write-out) really high priority.
2422  *
2423  */
2424
2425 /**
2426  * Per-transfer attributes.
2427  */
2428 struct cl_req_attr {
2429         /** Generic attributes for the server consumption. */
2430         struct obdo     *cra_oa;
2431         /** Capability. */
2432         struct obd_capa *cra_capa;
2433         /** Jobid */
2434         char             cra_jobid[JOBSTATS_JOBID_SIZE];
2435 };
2436
2437 /**
2438  * Transfer request operations definable at every layer.
2439  *
2440  * Concurrency: transfer formation engine synchronizes calls to all transfer
2441  * methods.
2442  */
2443 struct cl_req_operations {
2444         /**
2445          * Invoked top-to-bottom by cl_req_prep() when transfer formation is
2446          * complete (all pages are added).
2447          *
2448          * \see osc_req_prep()
2449          */
2450         int  (*cro_prep)(const struct lu_env *env,
2451                          const struct cl_req_slice *slice);
2452         /**
2453          * Called top-to-bottom to fill in \a oa fields. This is called twice
2454          * with different flags, see bug 10150 and osc_build_req().
2455          *
2456          * \param obj an object from cl_req which attributes are to be set in
2457          *            \a oa.
2458          *
2459          * \param oa struct obdo where attributes are placed
2460          *
2461          * \param flags \a oa fields to be filled.
2462          */
2463         void (*cro_attr_set)(const struct lu_env *env,
2464                              const struct cl_req_slice *slice,
2465                              const struct cl_object *obj,
2466                              struct cl_req_attr *attr, obd_valid flags);
2467         /**
2468          * Called top-to-bottom from cl_req_completion() to notify layers that
2469          * transfer completed. Has to free all state allocated by
2470          * cl_device_operations::cdo_req_init().
2471          */
2472         void (*cro_completion)(const struct lu_env *env,
2473                                const struct cl_req_slice *slice, int ioret);
2474 };
2475
2476 /**
2477  * A per-object state that (potentially multi-object) transfer request keeps.
2478  */
2479 struct cl_req_obj {
2480         /** object itself */
2481         struct cl_object   *ro_obj;
2482         /** reference to cl_req_obj::ro_obj. For debugging. */
2483         struct lu_ref_link  ro_obj_ref;
2484         /* something else? Number of pages for a given object? */
2485 };
2486
2487 /**
2488  * Transfer request.
2489  *
2490  * Transfer requests are not reference counted, because IO sub-system owns
2491  * them exclusively and knows when to free them.
2492  *
2493  * Life cycle.
2494  *
2495  * cl_req is created by cl_req_alloc() that calls
2496  * cl_device_operations::cdo_req_init() device methods to allocate per-req
2497  * state in every layer.
2498  *
2499  * Then pages are added (cl_req_page_add()), req keeps track of all objects it
2500  * contains pages for.
2501  *
2502  * Once all pages were collected, cl_page_operations::cpo_prep() method is
2503  * called top-to-bottom. At that point layers can modify req, let it pass, or
2504  * deny it completely. This is to support things like SNS that have transfer
2505  * ordering requirements invisible to the individual req-formation engine.
2506  *
2507  * On transfer completion (or transfer timeout, or failure to initiate the
2508  * transfer of an allocated req), cl_req_operations::cro_completion() method
2509  * is called, after execution of cl_page_operations::cpo_completion() of all
2510  * req's pages.
2511  */
2512 struct cl_req {
2513         enum cl_req_type      crq_type;
2514         /** A list of pages being transfered */
2515         cfs_list_t            crq_pages;
2516         /** Number of pages in cl_req::crq_pages */
2517         unsigned              crq_nrpages;
2518         /** An array of objects which pages are in ->crq_pages */
2519         struct cl_req_obj    *crq_o;
2520         /** Number of elements in cl_req::crq_objs[] */
2521         unsigned              crq_nrobjs;
2522         cfs_list_t            crq_layers;
2523 };
2524
2525 /**
2526  * Per-layer state for request.
2527  */
2528 struct cl_req_slice {
2529         struct cl_req    *crs_req;
2530         struct cl_device *crs_dev;
2531         cfs_list_t        crs_linkage;
2532         const struct cl_req_operations *crs_ops;
2533 };
2534
2535 /* @} cl_req */
2536
2537 enum cache_stats_item {
2538         /** how many cache lookups were performed */
2539         CS_lookup = 0,
2540         /** how many times cache lookup resulted in a hit */
2541         CS_hit,
2542         /** how many entities are in the cache right now */
2543         CS_total,
2544         /** how many entities in the cache are actively used (and cannot be
2545          * evicted) right now */
2546         CS_busy,
2547         /** how many entities were created at all */
2548         CS_create,
2549         CS_NR
2550 };
2551
2552 #define CS_NAMES { "lookup", "hit", "total", "busy", "create" }
2553
2554 /**
2555  * Stats for a generic cache (similar to inode, lu_object, etc. caches).
2556  */
2557 struct cache_stats {
2558         const char    *cs_name;
2559         cfs_atomic_t   cs_stats[CS_NR];
2560 };
2561
2562 /** These are not exported so far */
2563 void cache_stats_init (struct cache_stats *cs, const char *name);
2564 int  cache_stats_print(const struct cache_stats *cs,
2565                        char *page, int count, int header);
2566
2567 /**
2568  * Client-side site. This represents particular client stack. "Global"
2569  * variables should (directly or indirectly) be added here to allow multiple
2570  * clients to co-exist in the single address space.
2571  */
2572 struct cl_site {
2573         struct lu_site        cs_lu;
2574         /**
2575          * Statistical counters. Atomics do not scale, something better like
2576          * per-cpu counters is needed.
2577          *
2578          * These are exported as /proc/fs/lustre/llite/.../site
2579          *
2580          * When interpreting keep in mind that both sub-locks (and sub-pages)
2581          * and top-locks (and top-pages) are accounted here.
2582          */
2583         struct cache_stats    cs_pages;
2584         struct cache_stats    cs_locks;
2585         cfs_atomic_t          cs_pages_state[CPS_NR];
2586         cfs_atomic_t          cs_locks_state[CLS_NR];
2587 };
2588
2589 int  cl_site_init (struct cl_site *s, struct cl_device *top);
2590 void cl_site_fini (struct cl_site *s);
2591 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl);
2592
2593 /**
2594  * Output client site statistical counters into a buffer. Suitable for
2595  * ll_rd_*()-style functions.
2596  */
2597 int cl_site_stats_print(const struct cl_site *s, char *page, int count);
2598
2599 /**
2600  * \name helpers
2601  *
2602  * Type conversion and accessory functions.
2603  */
2604 /** @{ */
2605
2606 static inline struct cl_site *lu2cl_site(const struct lu_site *site)
2607 {
2608         return container_of(site, struct cl_site, cs_lu);
2609 }
2610
2611 static inline int lu_device_is_cl(const struct lu_device *d)
2612 {
2613         return d->ld_type->ldt_tags & LU_DEVICE_CL;
2614 }
2615
2616 static inline struct cl_device *lu2cl_dev(const struct lu_device *d)
2617 {
2618         LASSERT(d == NULL || IS_ERR(d) || lu_device_is_cl(d));
2619         return container_of0(d, struct cl_device, cd_lu_dev);
2620 }
2621
2622 static inline struct lu_device *cl2lu_dev(struct cl_device *d)
2623 {
2624         return &d->cd_lu_dev;
2625 }
2626
2627 static inline struct cl_object *lu2cl(const struct lu_object *o)
2628 {
2629         LASSERT(o == NULL || IS_ERR(o) || lu_device_is_cl(o->lo_dev));
2630         return container_of0(o, struct cl_object, co_lu);
2631 }
2632
2633 static inline const struct cl_object_conf *
2634 lu2cl_conf(const struct lu_object_conf *conf)
2635 {
2636         return container_of0(conf, struct cl_object_conf, coc_lu);
2637 }
2638
2639 static inline struct cl_object *cl_object_next(const struct cl_object *obj)
2640 {
2641         return obj ? lu2cl(lu_object_next(&obj->co_lu)) : NULL;
2642 }
2643
2644 static inline struct cl_device *cl_object_device(const struct cl_object *o)
2645 {
2646         LASSERT(o == NULL || IS_ERR(o) || lu_device_is_cl(o->co_lu.lo_dev));
2647         return container_of0(o->co_lu.lo_dev, struct cl_device, cd_lu_dev);
2648 }
2649
2650 static inline struct cl_object_header *luh2coh(const struct lu_object_header *h)
2651 {
2652         return container_of0(h, struct cl_object_header, coh_lu);
2653 }
2654
2655 static inline struct cl_site *cl_object_site(const struct cl_object *obj)
2656 {
2657         return lu2cl_site(obj->co_lu.lo_dev->ld_site);
2658 }
2659
2660 static inline
2661 struct cl_object_header *cl_object_header(const struct cl_object *obj)
2662 {
2663         return luh2coh(obj->co_lu.lo_header);
2664 }
2665
2666 static inline int cl_device_init(struct cl_device *d, struct lu_device_type *t)
2667 {
2668         return lu_device_init(&d->cd_lu_dev, t);
2669 }
2670
2671 static inline void cl_device_fini(struct cl_device *d)
2672 {
2673         lu_device_fini(&d->cd_lu_dev);
2674 }
2675
2676 void cl_page_slice_add(struct cl_page *page, struct cl_page_slice *slice,
2677                        struct cl_object *obj,
2678                        const struct cl_page_operations *ops);
2679 void cl_lock_slice_add(struct cl_lock *lock, struct cl_lock_slice *slice,
2680                        struct cl_object *obj,
2681                        const struct cl_lock_operations *ops);
2682 void cl_io_slice_add(struct cl_io *io, struct cl_io_slice *slice,
2683                      struct cl_object *obj, const struct cl_io_operations *ops);
2684 void cl_req_slice_add(struct cl_req *req, struct cl_req_slice *slice,
2685                       struct cl_device *dev,
2686                       const struct cl_req_operations *ops);
2687 /** @} helpers */
2688
2689 /** \defgroup cl_object cl_object
2690  * @{ */
2691 struct cl_object *cl_object_top (struct cl_object *o);
2692 struct cl_object *cl_object_find(const struct lu_env *env, struct cl_device *cd,
2693                                  const struct lu_fid *fid,
2694                                  const struct cl_object_conf *c);
2695
2696 int  cl_object_header_init(struct cl_object_header *h);
2697 void cl_object_header_fini(struct cl_object_header *h);
2698 void cl_object_put        (const struct lu_env *env, struct cl_object *o);
2699 void cl_object_get        (struct cl_object *o);
2700 void cl_object_attr_lock  (struct cl_object *o);
2701 void cl_object_attr_unlock(struct cl_object *o);
2702 int  cl_object_attr_get   (const struct lu_env *env, struct cl_object *obj,
2703                            struct cl_attr *attr);
2704 int  cl_object_attr_set   (const struct lu_env *env, struct cl_object *obj,
2705                            const struct cl_attr *attr, unsigned valid);
2706 int  cl_object_glimpse    (const struct lu_env *env, struct cl_object *obj,
2707                            struct ost_lvb *lvb);
2708 int  cl_conf_set          (const struct lu_env *env, struct cl_object *obj,
2709                            const struct cl_object_conf *conf);
2710 void cl_object_prune      (const struct lu_env *env, struct cl_object *obj);
2711 void cl_object_kill       (const struct lu_env *env, struct cl_object *obj);
2712 int  cl_object_has_locks  (struct cl_object *obj);
2713
2714 /**
2715  * Returns true, iff \a o0 and \a o1 are slices of the same object.
2716  */
2717 static inline int cl_object_same(struct cl_object *o0, struct cl_object *o1)
2718 {
2719         return cl_object_header(o0) == cl_object_header(o1);
2720 }
2721
2722 static inline void cl_object_page_init(struct cl_object *clob, int size)
2723 {
2724         clob->co_slice_off = cl_object_header(clob)->coh_page_bufsize;
2725         cl_object_header(clob)->coh_page_bufsize += ALIGN(size, 8);
2726 }
2727
2728 static inline void *cl_object_page_slice(struct cl_object *clob,
2729                                          struct cl_page *page)
2730 {
2731         return (void *)((char *)page + clob->co_slice_off);
2732 }
2733
2734 /**
2735  * Return refcount of cl_object.
2736  */
2737 static inline int cl_object_refc(struct cl_object *clob)
2738 {
2739         struct lu_object_header *header = clob->co_lu.lo_header;
2740         return cfs_atomic_read(&header->loh_ref);
2741 }
2742
2743 /** @} cl_object */
2744
2745 /** \defgroup cl_page cl_page
2746  * @{ */
2747 enum {
2748         CLP_GANG_OKAY = 0,
2749         CLP_GANG_RESCHED,
2750         CLP_GANG_AGAIN,
2751         CLP_GANG_ABORT
2752 };
2753 /* callback of cl_page_gang_lookup() */
2754
2755 struct cl_page *cl_page_find        (const struct lu_env *env,
2756                                      struct cl_object *obj,
2757                                      pgoff_t idx, struct page *vmpage,
2758                                      enum cl_page_type type);
2759 struct cl_page *cl_page_alloc       (const struct lu_env *env,
2760                                      struct cl_object *o, pgoff_t ind,
2761                                      struct page *vmpage,
2762                                      enum cl_page_type type);
2763 void            cl_page_get         (struct cl_page *page);
2764 void            cl_page_put         (const struct lu_env *env,
2765                                      struct cl_page *page);
2766 void            cl_page_print       (const struct lu_env *env, void *cookie,
2767                                      lu_printer_t printer,
2768                                      const struct cl_page *pg);
2769 void            cl_page_header_print(const struct lu_env *env, void *cookie,
2770                                      lu_printer_t printer,
2771                                      const struct cl_page *pg);
2772 struct page     *cl_page_vmpage      (const struct lu_env *env,
2773                                      struct cl_page *page);
2774 struct cl_page *cl_vmpage_page      (struct page *vmpage, struct cl_object *obj);
2775 struct cl_page *cl_page_top         (struct cl_page *page);
2776
2777 const struct cl_page_slice *cl_page_at(const struct cl_page *page,
2778                                        const struct lu_device_type *dtype);
2779
2780 /**
2781  * \name ownership
2782  *
2783  * Functions dealing with the ownership of page by io.
2784  */
2785 /** @{ */
2786
2787 int  cl_page_own        (const struct lu_env *env,
2788                          struct cl_io *io, struct cl_page *page);
2789 int  cl_page_own_try    (const struct lu_env *env,
2790                          struct cl_io *io, struct cl_page *page);
2791 void cl_page_assume     (const struct lu_env *env,
2792                          struct cl_io *io, struct cl_page *page);
2793 void cl_page_unassume   (const struct lu_env *env,
2794                          struct cl_io *io, struct cl_page *pg);
2795 void cl_page_disown     (const struct lu_env *env,
2796                          struct cl_io *io, struct cl_page *page);
2797 int  cl_page_is_owned   (const struct cl_page *pg, const struct cl_io *io);
2798
2799 /** @} ownership */
2800
2801 /**
2802  * \name transfer
2803  *
2804  * Functions dealing with the preparation of a page for a transfer, and
2805  * tracking transfer state.
2806  */
2807 /** @{ */
2808 int  cl_page_prep       (const struct lu_env *env, struct cl_io *io,
2809                          struct cl_page *pg, enum cl_req_type crt);
2810 void cl_page_completion (const struct lu_env *env,
2811                          struct cl_page *pg, enum cl_req_type crt, int ioret);
2812 int  cl_page_make_ready (const struct lu_env *env, struct cl_page *pg,
2813                          enum cl_req_type crt);
2814 int  cl_page_cache_add  (const struct lu_env *env, struct cl_io *io,
2815                          struct cl_page *pg, enum cl_req_type crt);
2816 void cl_page_clip       (const struct lu_env *env, struct cl_page *pg,
2817                          int from, int to);
2818 int  cl_page_cancel     (const struct lu_env *env, struct cl_page *page);
2819 int  cl_page_flush      (const struct lu_env *env, struct cl_io *io,
2820                          struct cl_page *pg);
2821
2822 /** @} transfer */
2823
2824
2825 /**
2826  * \name helper routines
2827  * Functions to discard, delete and export a cl_page.
2828  */
2829 /** @{ */
2830 void    cl_page_discard      (const struct lu_env *env, struct cl_io *io,
2831                               struct cl_page *pg);
2832 void    cl_page_delete       (const struct lu_env *env, struct cl_page *pg);
2833 int     cl_page_is_vmlocked  (const struct lu_env *env,
2834                               const struct cl_page *pg);
2835 void    cl_page_export       (const struct lu_env *env,
2836                               struct cl_page *pg, int uptodate);
2837 int     cl_page_is_under_lock(const struct lu_env *env, struct cl_io *io,
2838                               struct cl_page *page);
2839 loff_t  cl_offset            (const struct cl_object *obj, pgoff_t idx);
2840 pgoff_t cl_index             (const struct cl_object *obj, loff_t offset);
2841 int     cl_page_size         (const struct cl_object *obj);
2842 int     cl_pages_prune       (const struct lu_env *env, struct cl_object *obj);
2843
2844 void cl_lock_print      (const struct lu_env *env, void *cookie,
2845                          lu_printer_t printer, const struct cl_lock *lock);
2846 void cl_lock_descr_print(const struct lu_env *env, void *cookie,
2847                          lu_printer_t printer,
2848                          const struct cl_lock_descr *descr);
2849 /* @} helper */
2850
2851 /** @} cl_page */
2852
2853 /** \defgroup cl_lock cl_lock
2854  * @{ */
2855
2856 struct cl_lock *cl_lock_hold(const struct lu_env *env, const struct cl_io *io,
2857                              const struct cl_lock_descr *need,
2858                              const char *scope, const void *source);
2859 struct cl_lock *cl_lock_peek(const struct lu_env *env, const struct cl_io *io,
2860                              const struct cl_lock_descr *need,
2861                              const char *scope, const void *source);
2862 struct cl_lock *cl_lock_request(const struct lu_env *env, struct cl_io *io,
2863                                 const struct cl_lock_descr *need,
2864                                 const char *scope, const void *source);
2865 struct cl_lock *cl_lock_at_pgoff(const struct lu_env *env,
2866                                  struct cl_object *obj, pgoff_t index,
2867                                  struct cl_lock *except, int pending,
2868                                  int canceld);
2869 static inline struct cl_lock *cl_lock_at_page(const struct lu_env *env,
2870                                               struct cl_object *obj,
2871                                               struct cl_page *page,
2872                                               struct cl_lock *except,
2873                                               int pending, int canceld)
2874 {
2875         LASSERT(cl_object_header(obj) == cl_object_header(page->cp_obj));
2876         return cl_lock_at_pgoff(env, obj, page->cp_index, except,
2877                                 pending, canceld);
2878 }
2879
2880 const struct cl_lock_slice *cl_lock_at(const struct cl_lock *lock,
2881                                        const struct lu_device_type *dtype);
2882
2883 void  cl_lock_get       (struct cl_lock *lock);
2884 void  cl_lock_get_trust (struct cl_lock *lock);
2885 void  cl_lock_put       (const struct lu_env *env, struct cl_lock *lock);
2886 void  cl_lock_hold_add  (const struct lu_env *env, struct cl_lock *lock,
2887                          const char *scope, const void *source);
2888 void cl_lock_hold_release(const struct lu_env *env, struct cl_lock *lock,
2889                           const char *scope, const void *source);
2890 void  cl_lock_unhold    (const struct lu_env *env, struct cl_lock *lock,
2891                          const char *scope, const void *source);
2892 void  cl_lock_release   (const struct lu_env *env, struct cl_lock *lock,
2893                          const char *scope, const void *source);
2894 void  cl_lock_user_add  (const struct lu_env *env, struct cl_lock *lock);
2895 void  cl_lock_user_del  (const struct lu_env *env, struct cl_lock *lock);
2896
2897 enum cl_lock_state cl_lock_intransit(const struct lu_env *env,
2898                                      struct cl_lock *lock);
2899 void cl_lock_extransit(const struct lu_env *env, struct cl_lock *lock,
2900                        enum cl_lock_state state);
2901 int cl_lock_is_intransit(struct cl_lock *lock);
2902
2903 int cl_lock_enqueue_wait(const struct lu_env *env, struct cl_lock *lock,
2904                          int keep_mutex);
2905
2906 /** \name statemachine statemachine
2907  * Interface to lock state machine consists of 3 parts:
2908  *
2909  *     - "try" functions that attempt to effect a state transition. If state
2910  *     transition is not possible right now (e.g., if it has to wait for some
2911  *     asynchronous event to occur), these functions return
2912  *     cl_lock_transition::CLO_WAIT.
2913  *
2914  *     - "non-try" functions that implement synchronous blocking interface on
2915  *     top of non-blocking "try" functions. These functions repeatedly call
2916  *     corresponding "try" versions, and if state transition is not possible
2917  *     immediately, wait for lock state change.
2918  *
2919  *     - methods from cl_lock_operations, called by "try" functions. Lock can
2920  *     be advanced to the target state only when all layers voted that they
2921  *     are ready for this transition. "Try" functions call methods under lock
2922  *     mutex. If a layer had to release a mutex, it re-acquires it and returns
2923  *     cl_lock_transition::CLO_REPEAT, causing "try" function to call all
2924  *     layers again.
2925  *
2926  * TRY              NON-TRY      METHOD                            FINAL STATE
2927  *
2928  * cl_enqueue_try() cl_enqueue() cl_lock_operations::clo_enqueue() CLS_ENQUEUED
2929  *
2930  * cl_wait_try()    cl_wait()    cl_lock_operations::clo_wait()    CLS_HELD
2931  *
2932  * cl_unuse_try()   cl_unuse()   cl_lock_operations::clo_unuse()   CLS_CACHED
2933  *
2934  * cl_use_try()     NONE         cl_lock_operations::clo_use()     CLS_HELD
2935  *
2936  * @{ */
2937
2938 int   cl_enqueue    (const struct lu_env *env, struct cl_lock *lock,
2939                      struct cl_io *io, __u32 flags);
2940 int   cl_wait       (const struct lu_env *env, struct cl_lock *lock);
2941 void  cl_unuse      (const struct lu_env *env, struct cl_lock *lock);
2942 int   cl_enqueue_try(const struct lu_env *env, struct cl_lock *lock,
2943                      struct cl_io *io, __u32 flags);
2944 int   cl_unuse_try  (const struct lu_env *env, struct cl_lock *lock);
2945 int   cl_wait_try   (const struct lu_env *env, struct cl_lock *lock);
2946 int   cl_use_try    (const struct lu_env *env, struct cl_lock *lock, int atomic);
2947
2948 /** @} statemachine */
2949
2950 void cl_lock_signal      (const struct lu_env *env, struct cl_lock *lock);
2951 int  cl_lock_state_wait  (const struct lu_env *env, struct cl_lock *lock);
2952 void cl_lock_state_set   (const struct lu_env *env, struct cl_lock *lock,
2953                           enum cl_lock_state state);
2954 int  cl_queue_match      (const cfs_list_t *queue,
2955                           const struct cl_lock_descr *need);
2956
2957 void cl_lock_mutex_get  (const struct lu_env *env, struct cl_lock *lock);
2958 int  cl_lock_mutex_try  (const struct lu_env *env, struct cl_lock *lock);
2959 void cl_lock_mutex_put  (const struct lu_env *env, struct cl_lock *lock);
2960 int  cl_lock_is_mutexed (struct cl_lock *lock);
2961 int  cl_lock_nr_mutexed (const struct lu_env *env);
2962 int  cl_lock_discard_pages(const struct lu_env *env, struct cl_lock *lock);
2963 int  cl_lock_ext_match  (const struct cl_lock_descr *has,
2964                          const struct cl_lock_descr *need);
2965 int  cl_lock_descr_match(const struct cl_lock_descr *has,
2966                          const struct cl_lock_descr *need);
2967 int  cl_lock_mode_match (enum cl_lock_mode has, enum cl_lock_mode need);
2968 int  cl_lock_modify     (const struct lu_env *env, struct cl_lock *lock,
2969                          const struct cl_lock_descr *desc);
2970
2971 void cl_lock_closure_init (const struct lu_env *env,
2972                            struct cl_lock_closure *closure,
2973                            struct cl_lock *origin, int wait);
2974 void cl_lock_closure_fini (struct cl_lock_closure *closure);
2975 int  cl_lock_closure_build(const struct lu_env *env, struct cl_lock *lock,
2976                            struct cl_lock_closure *closure);
2977 void cl_lock_disclosure   (const struct lu_env *env,
2978                            struct cl_lock_closure *closure);
2979 int  cl_lock_enclosure    (const struct lu_env *env, struct cl_lock *lock,
2980                            struct cl_lock_closure *closure);
2981
2982 void cl_lock_cancel(const struct lu_env *env, struct cl_lock *lock);
2983 void cl_lock_delete(const struct lu_env *env, struct cl_lock *lock);
2984 void cl_lock_error (const struct lu_env *env, struct cl_lock *lock, int error);
2985 void cl_locks_prune(const struct lu_env *env, struct cl_object *obj, int wait);
2986
2987 unsigned long cl_lock_weigh(const struct lu_env *env, struct cl_lock *lock);
2988
2989 /** @} cl_lock */
2990
2991 /** \defgroup cl_io cl_io
2992  * @{ */
2993
2994 int   cl_io_init         (const struct lu_env *env, struct cl_io *io,
2995                           enum cl_io_type iot, struct cl_object *obj);
2996 int   cl_io_sub_init     (const struct lu_env *env, struct cl_io *io,
2997                           enum cl_io_type iot, struct cl_object *obj);
2998 int   cl_io_rw_init      (const struct lu_env *env, struct cl_io *io,
2999                           enum cl_io_type iot, loff_t pos, size_t count);
3000 int   cl_io_loop         (const struct lu_env *env, struct cl_io *io);
3001
3002 void  cl_io_fini         (const struct lu_env *env, struct cl_io *io);
3003 int   cl_io_iter_init    (const struct lu_env *env, struct cl_io *io);
3004 void  cl_io_iter_fini    (const struct lu_env *env, struct cl_io *io);
3005 int   cl_io_lock         (const struct lu_env *env, struct cl_io *io);
3006 void  cl_io_unlock       (const struct lu_env *env, struct cl_io *io);
3007 int   cl_io_start        (const struct lu_env *env, struct cl_io *io);
3008 void  cl_io_end          (const struct lu_env *env, struct cl_io *io);
3009 int   cl_io_lock_add     (const struct lu_env *env, struct cl_io *io,
3010                           struct cl_io_lock_link *link);
3011 int   cl_io_lock_alloc_add(const struct lu_env *env, struct cl_io *io,
3012                            struct cl_lock_descr *descr);
3013 int   cl_io_read_page    (const struct lu_env *env, struct cl_io *io,
3014                           struct cl_page *page);
3015 int   cl_io_submit_rw    (const struct lu_env *env, struct cl_io *io,
3016                           enum cl_req_type iot, struct cl_2queue *queue);
3017 int   cl_io_submit_sync  (const struct lu_env *env, struct cl_io *io,
3018                           enum cl_req_type iot, struct cl_2queue *queue,
3019                           long timeout);
3020 int   cl_io_commit_async (const struct lu_env *env, struct cl_io *io,
3021                           struct cl_page_list *queue, int from, int to,
3022                           cl_commit_cbt cb);
3023 void  cl_io_rw_advance   (const struct lu_env *env, struct cl_io *io,
3024                           size_t nob);
3025 int   cl_io_cancel       (const struct lu_env *env, struct cl_io *io,
3026                           struct cl_page_list *queue);
3027 int   cl_io_is_going     (const struct lu_env *env);
3028
3029 /**
3030  * True, iff \a io is an O_APPEND write(2).
3031  */
3032 static inline int cl_io_is_append(const struct cl_io *io)
3033 {
3034         return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_append;
3035 }
3036
3037 static inline int cl_io_is_sync_write(const struct cl_io *io)
3038 {
3039         return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_sync;
3040 }
3041
3042 static inline int cl_io_is_mkwrite(const struct cl_io *io)
3043 {
3044         return io->ci_type == CIT_FAULT && io->u.ci_fault.ft_mkwrite;
3045 }
3046
3047 /**
3048  * True, iff \a io is a truncate(2).
3049  */
3050 static inline int cl_io_is_trunc(const struct cl_io *io)
3051 {
3052         return io->ci_type == CIT_SETATTR &&
3053                 (io->u.ci_setattr.sa_valid & ATTR_SIZE);
3054 }
3055
3056 struct cl_io *cl_io_top(struct cl_io *io);
3057
3058 void cl_io_print(const struct lu_env *env, void *cookie,
3059                  lu_printer_t printer, const struct cl_io *io);
3060
3061 #define CL_IO_SLICE_CLEAN(foo_io, base)                                 \
3062 do {                                                                    \
3063         typeof(foo_io) __foo_io = (foo_io);                             \
3064                                                                         \
3065         CLASSERT(offsetof(typeof(*__foo_io), base) == 0);               \
3066         memset(&__foo_io->base + 1, 0,                                  \
3067                (sizeof *__foo_io) - sizeof __foo_io->base);             \
3068 } while (0)
3069
3070 /** @} cl_io */
3071
3072 /** \defgroup cl_page_list cl_page_list
3073  * @{ */
3074
3075 /**
3076  * Last page in the page list.
3077  */
3078 static inline struct cl_page *cl_page_list_last(struct cl_page_list *plist)
3079 {
3080         LASSERT(plist->pl_nr > 0);
3081         return cfs_list_entry(plist->pl_pages.prev, struct cl_page, cp_batch);
3082 }
3083
3084 static inline struct cl_page *cl_page_list_first(struct cl_page_list *plist)
3085 {
3086         LASSERT(plist->pl_nr > 0);
3087         return cfs_list_entry(plist->pl_pages.next, struct cl_page, cp_batch);
3088 }
3089
3090 /**
3091  * Iterate over pages in a page list.
3092  */
3093 #define cl_page_list_for_each(page, list)                               \
3094         cfs_list_for_each_entry((page), &(list)->pl_pages, cp_batch)
3095
3096 /**
3097  * Iterate over pages in a page list, taking possible removals into account.
3098  */
3099 #define cl_page_list_for_each_safe(page, temp, list)                    \
3100         cfs_list_for_each_entry_safe((page), (temp), &(list)->pl_pages, cp_batch)
3101
3102 void cl_page_list_init   (struct cl_page_list *plist);
3103 void cl_page_list_add    (struct cl_page_list *plist, struct cl_page *page);
3104 void cl_page_list_move   (struct cl_page_list *dst, struct cl_page_list *src,
3105                           struct cl_page *page);
3106 void cl_page_list_move_head(struct cl_page_list *dst, struct cl_page_list *src,
3107                           struct cl_page *page);
3108 void cl_page_list_splice (struct cl_page_list *list,
3109                           struct cl_page_list *head);
3110 void cl_page_list_del    (const struct lu_env *env,
3111                           struct cl_page_list *plist, struct cl_page *page);
3112 void cl_page_list_disown (const struct lu_env *env,
3113                           struct cl_io *io, struct cl_page_list *plist);
3114 int  cl_page_list_own    (const struct lu_env *env,
3115                           struct cl_io *io, struct cl_page_list *plist);
3116 void cl_page_list_assume (const struct lu_env *env,
3117                           struct cl_io *io, struct cl_page_list *plist);
3118 void cl_page_list_discard(const struct lu_env *env,
3119                           struct cl_io *io, struct cl_page_list *plist);
3120 void cl_page_list_fini   (const struct lu_env *env, struct cl_page_list *plist);
3121
3122 void cl_2queue_init     (struct cl_2queue *queue);
3123 void cl_2queue_add      (struct cl_2queue *queue, struct cl_page *page);
3124 void cl_2queue_disown   (const struct lu_env *env,
3125                          struct cl_io *io, struct cl_2queue *queue);
3126 void cl_2queue_assume   (const struct lu_env *env,
3127                          struct cl_io *io, struct cl_2queue *queue);
3128 void cl_2queue_discard  (const struct lu_env *env,
3129                          struct cl_io *io, struct cl_2queue *queue);
3130 void cl_2queue_fini     (const struct lu_env *env, struct cl_2queue *queue);
3131 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page);
3132
3133 /** @} cl_page_list */
3134
3135 /** \defgroup cl_req cl_req
3136  * @{ */
3137 struct cl_req *cl_req_alloc(const struct lu_env *env, struct cl_page *page,
3138                             enum cl_req_type crt, int nr_objects);
3139
3140 void cl_req_page_add  (const struct lu_env *env, struct cl_req *req,
3141                        struct cl_page *page);
3142 void cl_req_page_done (const struct lu_env *env, struct cl_page *page);
3143 int  cl_req_prep      (const struct lu_env *env, struct cl_req *req);
3144 void cl_req_attr_set  (const struct lu_env *env, struct cl_req *req,
3145                        struct cl_req_attr *attr, obd_valid flags);
3146 void cl_req_completion(const struct lu_env *env, struct cl_req *req, int ioret);
3147
3148 /** \defgroup cl_sync_io cl_sync_io
3149  * @{ */
3150
3151 /**
3152  * Anchor for synchronous transfer. This is allocated on a stack by thread
3153  * doing synchronous transfer, and a pointer to this structure is set up in
3154  * every page submitted for transfer. Transfer completion routine updates
3155  * anchor and wakes up waiting thread when transfer is complete.
3156  */
3157 struct cl_sync_io {
3158         /** number of pages yet to be transferred. */
3159         cfs_atomic_t            csi_sync_nr;
3160         /** error code. */
3161         int                     csi_sync_rc;
3162         /** barrier of destroy this structure */
3163         cfs_atomic_t            csi_barrier;
3164         /** completion to be signaled when transfer is complete. */
3165         wait_queue_head_t       csi_waitq;
3166 };
3167
3168 void cl_sync_io_init(struct cl_sync_io *anchor, int nrpages);
3169 int  cl_sync_io_wait(const struct lu_env *env, struct cl_io *io,
3170                      struct cl_page_list *queue, struct cl_sync_io *anchor,
3171                      long timeout);
3172 void cl_sync_io_note(struct cl_sync_io *anchor, int ioret);
3173
3174 /** @} cl_sync_io */
3175
3176 /** @} cl_req */
3177
3178 /** \defgroup cl_env cl_env
3179  *
3180  * lu_env handling for a client.
3181  *
3182  * lu_env is an environment within which lustre code executes. Its major part
3183  * is lu_context---a fast memory allocation mechanism that is used to conserve
3184  * precious kernel stack space. Originally lu_env was designed for a server,
3185  * where
3186  *
3187  *     - there is a (mostly) fixed number of threads, and
3188  *
3189  *     - call chains have no non-lustre portions inserted between lustre code.
3190  *
3191  * On a client both these assumtpion fails, because every user thread can
3192  * potentially execute lustre code as part of a system call, and lustre calls
3193  * into VFS or MM that call back into lustre.
3194  *
3195  * To deal with that, cl_env wrapper functions implement the following
3196  * optimizations:
3197  *
3198  *     - allocation and destruction of environment is amortized by caching no
3199  *     longer used environments instead of destroying them;
3200  *
3201  *     - there is a notion of "current" environment, attached to the kernel
3202  *     data structure representing current thread Top-level lustre code
3203  *     allocates an environment and makes it current, then calls into
3204  *     non-lustre code, that in turn calls lustre back. Low-level lustre
3205  *     code thus called can fetch environment created by the top-level code
3206  *     and reuse it, avoiding additional environment allocation.
3207  *       Right now, three interfaces can attach the cl_env to running thread:
3208  *       - cl_env_get
3209  *       - cl_env_implant
3210  *       - cl_env_reexit(cl_env_reenter had to be called priorly)
3211  *
3212  * \see lu_env, lu_context, lu_context_key
3213  * @{ */
3214
3215 struct cl_env_nest {
3216         int   cen_refcheck;
3217         void *cen_cookie;
3218 };
3219
3220 struct lu_env *cl_env_peek       (int *refcheck);
3221 struct lu_env *cl_env_get        (int *refcheck);