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