Whamcloud - gitweb
LU-1666 obdclass: reduce lock contention on coh_page_guard
[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         /** Protect to get and put page, see cl_page_put and cl_vmpage_page */
727         cfs_spinlock_t           cp_lock;
728         /**
729          * Linkage of pages within some group. Protected by
730          * cl_page::cp_mutex. */
731         cfs_list_t               cp_batch;
732         /** Mutex serializing membership of a page in a batch. */
733         cfs_mutex_t              cp_mutex;
734         /** Linkage of pages within cl_req. */
735         cfs_list_t               cp_flight;
736         /** Transfer error. */
737         int                      cp_error;
738
739         /**
740          * Page type. Only CPT_TRANSIENT is used so far. Immutable after
741          * creation.
742          */
743         enum cl_page_type        cp_type;
744
745         /**
746          * Owning IO in cl_page_state::CPS_OWNED state. Sub-page can be owned
747          * by sub-io. Protected by a VM lock.
748          */
749         struct cl_io            *cp_owner;
750         /**
751          * Debug information, the task is owning the page.
752          */
753         cfs_task_t              *cp_task;
754         /**
755          * Owning IO request in cl_page_state::CPS_PAGEOUT and
756          * cl_page_state::CPS_PAGEIN states. This field is maintained only in
757          * the top-level pages. Protected by a VM lock.
758          */
759         struct cl_req           *cp_req;
760         /** List of references to this page, for debugging. */
761         struct lu_ref            cp_reference;
762         /** Link to an object, for debugging. */
763         struct lu_ref_link      *cp_obj_ref;
764         /** Link to a queue, for debugging. */
765         struct lu_ref_link      *cp_queue_ref;
766         /** Per-page flags from enum cl_page_flags. Protected by a VM lock. */
767         unsigned                 cp_flags;
768         /** Assigned if doing a sync_io */
769         struct cl_sync_io       *cp_sync_io;
770 };
771
772 /**
773  * Per-layer part of cl_page.
774  *
775  * \see ccc_page, lov_page, osc_page
776  */
777 struct cl_page_slice {
778         struct cl_page                  *cpl_page;
779         /**
780          * Object slice corresponding to this page slice. Immutable after
781          * creation.
782          */
783         struct cl_object                *cpl_obj;
784         const struct cl_page_operations *cpl_ops;
785         /** Linkage into cl_page::cp_layers. Immutable after creation. */
786         cfs_list_t                       cpl_linkage;
787 };
788
789 /**
790  * Lock mode. For the client extent locks.
791  *
792  * \warning: cl_lock_mode_match() assumes particular ordering here.
793  * \ingroup cl_lock
794  */
795 enum cl_lock_mode {
796         /**
797          * Mode of a lock that protects no data, and exists only as a
798          * placeholder. This is used for `glimpse' requests. A phantom lock
799          * might get promoted to real lock at some point.
800          */
801         CLM_PHANTOM,
802         CLM_READ,
803         CLM_WRITE,
804         CLM_GROUP
805 };
806
807 /**
808  * Requested transfer type.
809  * \ingroup cl_req
810  */
811 enum cl_req_type {
812         CRT_READ,
813         CRT_WRITE,
814         CRT_NR
815 };
816
817 /**
818  * Per-layer page operations.
819  *
820  * Methods taking an \a io argument are for the activity happening in the
821  * context of given \a io. Page is assumed to be owned by that io, except for
822  * the obvious cases (like cl_page_operations::cpo_own()).
823  *
824  * \see vvp_page_ops, lov_page_ops, osc_page_ops
825  */
826 struct cl_page_operations {
827         /**
828          * cl_page<->cfs_page_t methods. Only one layer in the stack has to
829          * implement these. Current code assumes that this functionality is
830          * provided by the topmost layer, see cl_page_disown0() as an example.
831          */
832
833         /**
834          * \return the underlying VM page. Optional.
835          */
836         cfs_page_t *(*cpo_vmpage)(const struct lu_env *env,
837                                   const struct cl_page_slice *slice);
838         /**
839          * Called when \a io acquires this page into the exclusive
840          * ownership. When this method returns, it is guaranteed that the is
841          * not owned by other io, and no transfer is going on against
842          * it. Optional.
843          *
844          * \see cl_page_own()
845          * \see vvp_page_own(), lov_page_own()
846          */
847         int  (*cpo_own)(const struct lu_env *env,
848                         const struct cl_page_slice *slice,
849                         struct cl_io *io, int nonblock);
850         /** Called when ownership it yielded. Optional.
851          *
852          * \see cl_page_disown()
853          * \see vvp_page_disown()
854          */
855         void (*cpo_disown)(const struct lu_env *env,
856                            const struct cl_page_slice *slice, struct cl_io *io);
857         /**
858          * Called for a page that is already "owned" by \a io from VM point of
859          * view. Optional.
860          *
861          * \see cl_page_assume()
862          * \see vvp_page_assume(), lov_page_assume()
863          */
864         void (*cpo_assume)(const struct lu_env *env,
865                            const struct cl_page_slice *slice, struct cl_io *io);
866         /** Dual to cl_page_operations::cpo_assume(). Optional. Called
867          * bottom-to-top when IO releases a page without actually unlocking
868          * it.
869          *
870          * \see cl_page_unassume()
871          * \see vvp_page_unassume()
872          */
873         void (*cpo_unassume)(const struct lu_env *env,
874                              const struct cl_page_slice *slice,
875                              struct cl_io *io);
876         /**
877          * Announces whether the page contains valid data or not by \a uptodate.
878          *
879          * \see cl_page_export()
880          * \see vvp_page_export()
881          */
882         void  (*cpo_export)(const struct lu_env *env,
883                             const struct cl_page_slice *slice, int uptodate);
884         /**
885          * Unmaps page from the user space (if it is mapped).
886          *
887          * \see cl_page_unmap()
888          * \see vvp_page_unmap()
889          */
890         int (*cpo_unmap)(const struct lu_env *env,
891                          const struct cl_page_slice *slice, struct cl_io *io);
892         /**
893          * Checks whether underlying VM page is locked (in the suitable
894          * sense). Used for assertions.
895          *
896          * \retval    -EBUSY: page is protected by a lock of a given mode;
897          * \retval  -ENODATA: page is not protected by a lock;
898          * \retval         0: this layer cannot decide. (Should never happen.)
899          */
900         int (*cpo_is_vmlocked)(const struct lu_env *env,
901                                const struct cl_page_slice *slice);
902         /**
903          * Page destruction.
904          */
905
906         /**
907          * Called when page is truncated from the object. Optional.
908          *
909          * \see cl_page_discard()
910          * \see vvp_page_discard(), osc_page_discard()
911          */
912         void (*cpo_discard)(const struct lu_env *env,
913                             const struct cl_page_slice *slice,
914                             struct cl_io *io);
915         /**
916          * Called when page is removed from the cache, and is about to being
917          * destroyed. Optional.
918          *
919          * \see cl_page_delete()
920          * \see vvp_page_delete(), osc_page_delete()
921          */
922         void (*cpo_delete)(const struct lu_env *env,
923                            const struct cl_page_slice *slice);
924         /** Destructor. Frees resources and slice itself. */
925         void (*cpo_fini)(const struct lu_env *env,
926                          struct cl_page_slice *slice);
927
928         /**
929          * Checks whether the page is protected by a cl_lock. This is a
930          * per-layer method, because certain layers have ways to check for the
931          * lock much more efficiently than through the generic locks scan, or
932          * implement locking mechanisms separate from cl_lock, e.g.,
933          * LL_FILE_GROUP_LOCKED in vvp. If \a pending is true, check for locks
934          * being canceled, or scheduled for cancellation as soon as the last
935          * user goes away, too.
936          *
937          * \retval    -EBUSY: page is protected by a lock of a given mode;
938          * \retval  -ENODATA: page is not protected by a lock;
939          * \retval         0: this layer cannot decide.
940          *
941          * \see cl_page_is_under_lock()
942          */
943         int (*cpo_is_under_lock)(const struct lu_env *env,
944                                  const struct cl_page_slice *slice,
945                                  struct cl_io *io);
946
947         /**
948          * Optional debugging helper. Prints given page slice.
949          *
950          * \see cl_page_print()
951          */
952         int (*cpo_print)(const struct lu_env *env,
953                          const struct cl_page_slice *slice,
954                          void *cookie, lu_printer_t p);
955         /**
956          * \name transfer
957          *
958          * Transfer methods. See comment on cl_req for a description of
959          * transfer formation and life-cycle.
960          *
961          * @{
962          */
963         /**
964          * Request type dependent vector of operations.
965          *
966          * Transfer operations depend on transfer mode (cl_req_type). To avoid
967          * passing transfer mode to each and every of these methods, and to
968          * avoid branching on request type inside of the methods, separate
969          * methods for cl_req_type:CRT_READ and cl_req_type:CRT_WRITE are
970          * provided. That is, method invocation usually looks like
971          *
972          *         slice->cp_ops.io[req->crq_type].cpo_method(env, slice, ...);
973          */
974         struct {
975                 /**
976                  * Called when a page is submitted for a transfer as a part of
977                  * cl_page_list.
978                  *
979                  * \return    0         : page is eligible for submission;
980                  * \return    -EALREADY : skip this page;
981                  * \return    -ve       : error.
982                  *
983                  * \see cl_page_prep()
984                  */
985                 int  (*cpo_prep)(const struct lu_env *env,
986                                  const struct cl_page_slice *slice,
987                                  struct cl_io *io);
988                 /**
989                  * Completion handler. This is guaranteed to be eventually
990                  * fired after cl_page_operations::cpo_prep() or
991                  * cl_page_operations::cpo_make_ready() call.
992                  *
993                  * This method can be called in a non-blocking context. It is
994                  * guaranteed however, that the page involved and its object
995                  * are pinned in memory (and, hence, calling cl_page_put() is
996                  * safe).
997                  *
998                  * \see cl_page_completion()
999                  */
1000                 void (*cpo_completion)(const struct lu_env *env,
1001                                        const struct cl_page_slice *slice,
1002                                        int ioret);
1003                 /**
1004                  * Called when cached page is about to be added to the
1005                  * cl_req as a part of req formation.
1006                  *
1007                  * \return    0       : proceed with this page;
1008                  * \return    -EAGAIN : skip this page;
1009                  * \return    -ve     : error.
1010                  *
1011                  * \see cl_page_make_ready()
1012                  */
1013                 int  (*cpo_make_ready)(const struct lu_env *env,
1014                                        const struct cl_page_slice *slice);
1015                 /**
1016                  * Announce that this page is to be written out
1017                  * opportunistically, that is, page is dirty, it is not
1018                  * necessary to start write-out transfer right now, but
1019                  * eventually page has to be written out.
1020                  *
1021                  * Main caller of this is the write path (see
1022                  * vvp_io_commit_write()), using this method to build a
1023                  * "transfer cache" from which large transfers are then
1024                  * constructed by the req-formation engine.
1025                  *
1026                  * \todo XXX it would make sense to add page-age tracking
1027                  * semantics here, and to oblige the req-formation engine to
1028                  * send the page out not later than it is too old.
1029                  *
1030                  * \see cl_page_cache_add()
1031                  */
1032                 int  (*cpo_cache_add)(const struct lu_env *env,
1033                                       const struct cl_page_slice *slice,
1034                                       struct cl_io *io);
1035         } io[CRT_NR];
1036         /**
1037          * Tell transfer engine that only [to, from] part of a page should be
1038          * transmitted.
1039          *
1040          * This is used for immediate transfers.
1041          *
1042          * \todo XXX this is not very good interface. It would be much better
1043          * if all transfer parameters were supplied as arguments to
1044          * cl_io_operations::cio_submit() call, but it is not clear how to do
1045          * this for page queues.
1046          *
1047          * \see cl_page_clip()
1048          */
1049         void (*cpo_clip)(const struct lu_env *env,
1050                          const struct cl_page_slice *slice,
1051                          int from, int to);
1052         /**
1053          * \pre  the page was queued for transferring.
1054          * \post page is removed from client's pending list, or -EBUSY
1055          *       is returned if it has already been in transferring.
1056          *
1057          * This is one of seldom page operation which is:
1058          * 0. called from top level;
1059          * 1. don't have vmpage locked;
1060          * 2. every layer should synchronize execution of its ->cpo_cancel()
1061          *    with completion handlers. Osc uses client obd lock for this
1062          *    purpose. Based on there is no vvp_page_cancel and
1063          *    lov_page_cancel(), cpo_cancel is defacto protected by client lock.
1064          *
1065          * \see osc_page_cancel().
1066          */
1067         int (*cpo_cancel)(const struct lu_env *env,
1068                           const struct cl_page_slice *slice);
1069         /**
1070          * Write out a page by kernel. This is only called by ll_writepage
1071          * right now.
1072          *
1073          * \see cl_page_flush()
1074          */
1075         int (*cpo_flush)(const struct lu_env *env,
1076                          const struct cl_page_slice *slice,
1077                          struct cl_io *io);
1078         /** @} transfer */
1079 };
1080
1081 /**
1082  * Helper macro, dumping detailed information about \a page into a log.
1083  */
1084 #define CL_PAGE_DEBUG(mask, env, page, format, ...)                     \
1085 do {                                                                    \
1086         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);                \
1087                                                                         \
1088         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
1089                 cl_page_print(env, &msgdata, lu_cdebug_printer, page);  \
1090                 CDEBUG(mask, format , ## __VA_ARGS__);                  \
1091         }                                                               \
1092 } while (0)
1093
1094 /**
1095  * Helper macro, dumping shorter information about \a page into a log.
1096  */
1097 #define CL_PAGE_HEADER(mask, env, page, format, ...)                          \
1098 do {                                                                          \
1099         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);                      \
1100                                                                               \
1101         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                         \
1102                 cl_page_header_print(env, &msgdata, lu_cdebug_printer, page); \
1103                 CDEBUG(mask, format , ## __VA_ARGS__);                        \
1104         }                                                                     \
1105 } while (0)
1106
1107 /** @} cl_page */
1108
1109 /** \addtogroup cl_lock cl_lock
1110  * @{ */
1111 /** \struct cl_lock
1112  *
1113  * Extent locking on the client.
1114  *
1115  * LAYERING
1116  *
1117  * The locking model of the new client code is built around
1118  *
1119  *        struct cl_lock
1120  *
1121  * data-type representing an extent lock on a regular file. cl_lock is a
1122  * layered object (much like cl_object and cl_page), it consists of a header
1123  * (struct cl_lock) and a list of layers (struct cl_lock_slice), linked to
1124  * cl_lock::cll_layers list through cl_lock_slice::cls_linkage.
1125  *
1126  * All locks for a given object are linked into cl_object_header::coh_locks
1127  * list (protected by cl_object_header::coh_lock_guard spin-lock) through
1128  * cl_lock::cll_linkage. Currently this list is not sorted in any way. We can
1129  * sort it in starting lock offset, or use altogether different data structure
1130  * like a tree.
1131  *
1132  * Typical cl_lock consists of the two layers:
1133  *
1134  *     - vvp_lock (vvp specific data), and
1135  *     - lov_lock (lov specific data).
1136  *
1137  * lov_lock contains an array of sub-locks. Each of these sub-locks is a
1138  * normal cl_lock: it has a header (struct cl_lock) and a list of layers:
1139  *
1140  *     - lovsub_lock, and
1141  *     - osc_lock
1142  *
1143  * Each sub-lock is associated with a cl_object (representing stripe
1144  * sub-object or the file to which top-level cl_lock is associated to), and is
1145  * linked into that cl_object::coh_locks. In this respect cl_lock is similar to
1146  * cl_object (that at lov layer also fans out into multiple sub-objects), and
1147  * is different from cl_page, that doesn't fan out (there is usually exactly
1148  * one osc_page for every vvp_page). We shall call vvp-lov portion of the lock
1149  * a "top-lock" and its lovsub-osc portion a "sub-lock".
1150  *
1151  * LIFE CYCLE
1152  *
1153  * cl_lock is reference counted. When reference counter drops to 0, lock is
1154  * placed in the cache, except when lock is in CLS_FREEING state. CLS_FREEING
1155  * lock is destroyed when last reference is released. Referencing between
1156  * top-lock and its sub-locks is described in the lov documentation module.
1157  *
1158  * STATE MACHINE
1159  *
1160  * Also, cl_lock is a state machine. This requires some clarification. One of
1161  * the goals of client IO re-write was to make IO path non-blocking, or at
1162  * least to make it easier to make it non-blocking in the future. Here
1163  * `non-blocking' means that when a system call (read, write, truncate)
1164  * reaches a situation where it has to wait for a communication with the
1165  * server, it should --instead of waiting-- remember its current state and
1166  * switch to some other work.  E.g,. instead of waiting for a lock enqueue,
1167  * client should proceed doing IO on the next stripe, etc. Obviously this is
1168  * rather radical redesign, and it is not planned to be fully implemented at
1169  * this time, instead we are putting some infrastructure in place, that would
1170  * make it easier to do asynchronous non-blocking IO easier in the
1171  * future. Specifically, where old locking code goes to sleep (waiting for
1172  * enqueue, for example), new code returns cl_lock_transition::CLO_WAIT. When
1173  * enqueue reply comes, its completion handler signals that lock state-machine
1174  * is ready to transit to the next state. There is some generic code in
1175  * cl_lock.c that sleeps, waiting for these signals. As a result, for users of
1176  * this cl_lock.c code, it looks like locking is done in normal blocking
1177  * fashion, and it the same time it is possible to switch to the non-blocking
1178  * locking (simply by returning cl_lock_transition::CLO_WAIT from cl_lock.c
1179  * functions).
1180  *
1181  * For a description of state machine states and transitions see enum
1182  * cl_lock_state.
1183  *
1184  * There are two ways to restrict a set of states which lock might move to:
1185  *
1186  *     - placing a "hold" on a lock guarantees that lock will not be moved
1187  *       into cl_lock_state::CLS_FREEING state until hold is released. Hold
1188  *       can be only acquired on a lock that is not in
1189  *       cl_lock_state::CLS_FREEING. All holds on a lock are counted in
1190  *       cl_lock::cll_holds. Hold protects lock from cancellation and
1191  *       destruction. Requests to cancel and destroy a lock on hold will be
1192  *       recorded, but only honored when last hold on a lock is released;
1193  *
1194  *     - placing a "user" on a lock guarantees that lock will not leave
1195  *       cl_lock_state::CLS_NEW, cl_lock_state::CLS_QUEUING,
1196  *       cl_lock_state::CLS_ENQUEUED and cl_lock_state::CLS_HELD set of
1197  *       states, once it enters this set. That is, if a user is added onto a
1198  *       lock in a state not from this set, it doesn't immediately enforce
1199  *       lock to move to this set, but once lock enters this set it will
1200  *       remain there until all users are removed. Lock users are counted in
1201  *       cl_lock::cll_users.
1202  *
1203  *       User is used to assure that lock is not canceled or destroyed while
1204  *       it is being enqueued, or actively used by some IO.
1205  *
1206  *       Currently, a user always comes with a hold (cl_lock_invariant()
1207  *       checks that a number of holds is not less than a number of users).
1208  *
1209  * CONCURRENCY
1210  *
1211  * This is how lock state-machine operates. struct cl_lock contains a mutex
1212  * cl_lock::cll_guard that protects struct fields.
1213  *
1214  *     - mutex is taken, and cl_lock::cll_state is examined.
1215  *
1216  *     - for every state there are possible target states where lock can move
1217  *       into. They are tried in order. Attempts to move into next state are
1218  *       done by _try() functions in cl_lock.c:cl_{enqueue,unlock,wait}_try().
1219  *
1220  *     - if the transition can be performed immediately, state is changed,
1221  *       and mutex is released.
1222  *
1223  *     - if the transition requires blocking, _try() function returns
1224  *       cl_lock_transition::CLO_WAIT. Caller unlocks mutex and goes to
1225  *       sleep, waiting for possibility of lock state change. It is woken
1226  *       up when some event occurs, that makes lock state change possible
1227  *       (e.g., the reception of the reply from the server), and repeats
1228  *       the loop.
1229  *
1230  * Top-lock and sub-lock has separate mutexes and the latter has to be taken
1231  * first to avoid dead-lock.
1232  *
1233  * To see an example of interaction of all these issues, take a look at the
1234  * lov_cl.c:lov_lock_enqueue() function. It is called as a part of
1235  * cl_enqueue_try(), and tries to advance top-lock to ENQUEUED state, by
1236  * advancing state-machines of its sub-locks (lov_lock_enqueue_one()). Note
1237  * also, that it uses trylock to grab sub-lock mutex to avoid dead-lock. It
1238  * also has to handle CEF_ASYNC enqueue, when sub-locks enqueues have to be
1239  * done in parallel, rather than one after another (this is used for glimpse
1240  * locks, that cannot dead-lock).
1241  *
1242  * INTERFACE AND USAGE
1243  *
1244  * struct cl_lock_operations provide a number of call-backs that are invoked
1245  * when events of interest occurs. Layers can intercept and handle glimpse,
1246  * blocking, cancel ASTs and a reception of the reply from the server.
1247  *
1248  * One important difference with the old client locking model is that new
1249  * client has a representation for the top-lock, whereas in the old code only
1250  * sub-locks existed as real data structures and file-level locks are
1251  * represented by "request sets" that are created and destroyed on each and
1252  * every lock creation.
1253  *
1254  * Top-locks are cached, and can be found in the cache by the system calls. It
1255  * is possible that top-lock is in cache, but some of its sub-locks were
1256  * canceled and destroyed. In that case top-lock has to be enqueued again
1257  * before it can be used.
1258  *
1259  * Overall process of the locking during IO operation is as following:
1260  *
1261  *     - once parameters for IO are setup in cl_io, cl_io_operations::cio_lock()
1262  *       is called on each layer. Responsibility of this method is to add locks,
1263  *       needed by a given layer into cl_io.ci_lockset.
1264  *
1265  *     - once locks for all layers were collected, they are sorted to avoid
1266  *       dead-locks (cl_io_locks_sort()), and enqueued.
1267  *
1268  *     - when all locks are acquired, IO is performed;
1269  *
1270  *     - locks are released into cache.
1271  *
1272  * Striping introduces major additional complexity into locking. The
1273  * fundamental problem is that it is generally unsafe to actively use (hold)
1274  * two locks on the different OST servers at the same time, as this introduces
1275  * inter-server dependency and can lead to cascading evictions.
1276  *
1277  * Basic solution is to sub-divide large read/write IOs into smaller pieces so
1278  * that no multi-stripe locks are taken (note that this design abandons POSIX
1279  * read/write semantics). Such pieces ideally can be executed concurrently. At
1280  * the same time, certain types of IO cannot be sub-divived, without
1281  * sacrificing correctness. This includes:
1282  *
1283  *  - O_APPEND write, where [0, EOF] lock has to be taken, to guarantee
1284  *  atomicity;
1285  *
1286  *  - ftruncate(fd, offset), where [offset, EOF] lock has to be taken.
1287  *
1288  * Also, in the case of read(fd, buf, count) or write(fd, buf, count), where
1289  * buf is a part of memory mapped Lustre file, a lock or locks protecting buf
1290  * has to be held together with the usual lock on [offset, offset + count].
1291  *
1292  * As multi-stripe locks have to be allowed, it makes sense to cache them, so
1293  * that, for example, a sequence of O_APPEND writes can proceed quickly
1294  * without going down to the individual stripes to do lock matching. On the
1295  * other hand, multi-stripe locks shouldn't be used by normal read/write
1296  * calls. To achieve this, every layer can implement ->clo_fits_into() method,
1297  * that is called by lock matching code (cl_lock_lookup()), and that can be
1298  * used to selectively disable matching of certain locks for certain IOs. For
1299  * exmaple, lov layer implements lov_lock_fits_into() that allow multi-stripe
1300  * locks to be matched only for truncates and O_APPEND writes.
1301  *
1302  * Interaction with DLM
1303  *
1304  * In the expected setup, cl_lock is ultimately backed up by a collection of
1305  * DLM locks (struct ldlm_lock). Association between cl_lock and DLM lock is
1306  * implemented in osc layer, that also matches DLM events (ASTs, cancellation,
1307  * etc.) into cl_lock_operation calls. See struct osc_lock for a more detailed
1308  * description of interaction with DLM.
1309  */
1310
1311 /**
1312  * Lock description.
1313  */
1314 struct cl_lock_descr {
1315         /** Object this lock is granted for. */
1316         struct cl_object *cld_obj;
1317         /** Index of the first page protected by this lock. */
1318         pgoff_t           cld_start;
1319         /** Index of the last page (inclusive) protected by this lock. */
1320         pgoff_t           cld_end;
1321         /** Group ID, for group lock */
1322         __u64             cld_gid;
1323         /** Lock mode. */
1324         enum cl_lock_mode cld_mode;
1325         /**
1326          * flags to enqueue lock. A combination of bit-flags from
1327          * enum cl_enq_flags.
1328          */
1329         __u32             cld_enq_flags;
1330 };
1331
1332 #define DDESCR "%s(%d):[%lu, %lu]"
1333 #define PDESCR(descr)                                                   \
1334         cl_lock_mode_name((descr)->cld_mode), (descr)->cld_mode,        \
1335         (descr)->cld_start, (descr)->cld_end
1336
1337 const char *cl_lock_mode_name(const enum cl_lock_mode mode);
1338
1339 /**
1340  * Lock state-machine states.
1341  *
1342  * \htmlonly
1343  * <pre>
1344  *
1345  * Possible state transitions:
1346  *
1347  *              +------------------>NEW
1348  *              |                    |
1349  *              |                    | cl_enqueue_try()
1350  *              |                    |
1351  *              |    cl_unuse_try()  V
1352  *              |  +--------------QUEUING (*)
1353  *              |  |                 |
1354  *              |  |                 | cl_enqueue_try()
1355  *              |  |                 |
1356  *              |  | cl_unuse_try()  V
1357  *    sub-lock  |  +-------------ENQUEUED (*)
1358  *    canceled  |  |                 |
1359  *              |  |                 | cl_wait_try()
1360  *              |  |                 |
1361  *              |  |                (R)
1362  *              |  |                 |
1363  *              |  |                 V
1364  *              |  |                HELD<---------+
1365  *              |  |                 |            |
1366  *              |  |                 |            | cl_use_try()
1367  *              |  |  cl_unuse_try() |            |
1368  *              |  |                 |            |
1369  *              |  |                 V         ---+ 
1370  *              |  +------------>INTRANSIT (D) <--+
1371  *              |                    |            |
1372  *              |     cl_unuse_try() |            | cached lock found
1373  *              |                    |            | cl_use_try()
1374  *              |                    |            |
1375  *              |                    V            |
1376  *              +------------------CACHED---------+
1377  *                                   |
1378  *                                  (C)
1379  *                                   |
1380  *                                   V
1381  *                                FREEING
1382  *
1383  * Legend:
1384  *
1385  *         In states marked with (*) transition to the same state (i.e., a loop
1386  *         in the diagram) is possible.
1387  *
1388  *         (R) is the point where Receive call-back is invoked: it allows layers
1389  *         to handle arrival of lock reply.
1390  *
1391  *         (C) is the point where Cancellation call-back is invoked.
1392  *
1393  *         (D) is the transit state which means the lock is changing.
1394  *
1395  *         Transition to FREEING state is possible from any other state in the
1396  *         diagram in case of unrecoverable error.
1397  * </pre>
1398  * \endhtmlonly
1399  *
1400  * These states are for individual cl_lock object. Top-lock and its sub-locks
1401  * can be in the different states. Another way to say this is that we have
1402  * nested state-machines.
1403  *
1404  * Separate QUEUING and ENQUEUED states are needed to support non-blocking
1405  * operation for locks with multiple sub-locks. Imagine lock on a file F, that
1406  * intersects 3 stripes S0, S1, and S2. To enqueue F client has to send
1407  * enqueue to S0, wait for its completion, then send enqueue for S1, wait for
1408  * its completion and at last enqueue lock for S2, and wait for its
1409  * completion. In that case, top-lock is in QUEUING state while S0, S1 are
1410  * handled, and is in ENQUEUED state after enqueue to S2 has been sent (note
1411  * that in this case, sub-locks move from state to state, and top-lock remains
1412  * in the same state).
1413  */
1414 enum cl_lock_state {
1415         /**
1416          * Lock that wasn't yet enqueued
1417          */
1418         CLS_NEW,
1419         /**
1420          * Enqueue is in progress, blocking for some intermediate interaction
1421          * with the other side.
1422          */
1423         CLS_QUEUING,
1424         /**
1425          * Lock is fully enqueued, waiting for server to reply when it is
1426          * granted.
1427          */
1428         CLS_ENQUEUED,
1429         /**
1430          * Lock granted, actively used by some IO.
1431          */
1432         CLS_HELD,
1433         /**
1434          * This state is used to mark the lock is being used, or unused.
1435          * We need this state because the lock may have several sublocks,
1436          * so it's impossible to have an atomic way to bring all sublocks
1437          * into CLS_HELD state at use case, or all sublocks to CLS_CACHED
1438          * at unuse case.
1439          * If a thread is referring to a lock, and it sees the lock is in this
1440          * state, it must wait for the lock.
1441          * See state diagram for details.
1442          */
1443         CLS_INTRANSIT,
1444         /**
1445          * Lock granted, not used.
1446          */
1447         CLS_CACHED,
1448         /**
1449          * Lock is being destroyed.
1450          */
1451         CLS_FREEING,
1452         CLS_NR
1453 };
1454
1455 enum cl_lock_flags {
1456         /**
1457          * lock has been cancelled. This flag is never cleared once set (by
1458          * cl_lock_cancel0()).
1459          */
1460         CLF_CANCELLED  = 1 << 0,
1461         /** cancellation is pending for this lock. */
1462         CLF_CANCELPEND = 1 << 1,
1463         /** destruction is pending for this lock. */
1464         CLF_DOOMED     = 1 << 2,
1465         /** from enqueue RPC reply upcall. */
1466         CLF_FROM_UPCALL= 1 << 3,
1467 };
1468
1469 /**
1470  * Lock closure.
1471  *
1472  * Lock closure is a collection of locks (both top-locks and sub-locks) that
1473  * might be updated in a result of an operation on a certain lock (which lock
1474  * this is a closure of).
1475  *
1476  * Closures are needed to guarantee dead-lock freedom in the presence of
1477  *
1478  *     - nested state-machines (top-lock state-machine composed of sub-lock
1479  *       state-machines), and
1480  *
1481  *     - shared sub-locks.
1482  *
1483  * Specifically, many operations, such as lock enqueue, wait, unlock,
1484  * etc. start from a top-lock, and then operate on a sub-locks of this
1485  * top-lock, holding a top-lock mutex. When sub-lock state changes as a result
1486  * of such operation, this change has to be propagated to all top-locks that
1487  * share this sub-lock. Obviously, no natural lock ordering (e.g.,
1488  * top-to-bottom or bottom-to-top) captures this scenario, so try-locking has
1489  * to be used. Lock closure systematizes this try-and-repeat logic.
1490  */
1491 struct cl_lock_closure {
1492         /**
1493          * Lock that is mutexed when closure construction is started. When
1494          * closure in is `wait' mode (cl_lock_closure::clc_wait), mutex on
1495          * origin is released before waiting.
1496          */
1497         struct cl_lock   *clc_origin;
1498         /**
1499          * List of enclosed locks, so far. Locks are linked here through
1500          * cl_lock::cll_inclosure.
1501          */
1502         cfs_list_t        clc_list;
1503         /**
1504          * True iff closure is in a `wait' mode. This determines what
1505          * cl_lock_enclosure() does when a lock L to be added to the closure
1506          * is currently mutexed by some other thread.
1507          *
1508          * If cl_lock_closure::clc_wait is not set, then closure construction
1509          * fails with CLO_REPEAT immediately.
1510          *
1511          * In wait mode, cl_lock_enclosure() waits until next attempt to build
1512          * a closure might succeed. To this end it releases an origin mutex
1513          * (cl_lock_closure::clc_origin), that has to be the only lock mutex
1514          * owned by the current thread, and then waits on L mutex (by grabbing
1515          * it and immediately releasing), before returning CLO_REPEAT to the
1516          * caller.
1517          */
1518         int               clc_wait;
1519         /** Number of locks in the closure. */
1520         int               clc_nr;
1521 };
1522
1523 /**
1524  * Layered client lock.
1525  */
1526 struct cl_lock {
1527         /** Reference counter. */
1528         cfs_atomic_t          cll_ref;
1529         /** List of slices. Immutable after creation. */
1530         cfs_list_t            cll_layers;
1531         /**
1532          * Linkage into cl_lock::cll_descr::cld_obj::coh_locks list. Protected
1533          * by cl_lock::cll_descr::cld_obj::coh_lock_guard.
1534          */
1535         cfs_list_t            cll_linkage;
1536         /**
1537          * Parameters of this lock. Protected by
1538          * cl_lock::cll_descr::cld_obj::coh_lock_guard nested within
1539          * cl_lock::cll_guard. Modified only on lock creation and in
1540          * cl_lock_modify().
1541          */
1542         struct cl_lock_descr  cll_descr;
1543         /** Protected by cl_lock::cll_guard. */
1544         enum cl_lock_state    cll_state;
1545         /** signals state changes. */
1546         cfs_waitq_t           cll_wq;
1547         /**
1548          * Recursive lock, most fields in cl_lock{} are protected by this.
1549          *
1550          * Locking rules: this mutex is never held across network
1551          * communication, except when lock is being canceled.
1552          *
1553          * Lock ordering: a mutex of a sub-lock is taken first, then a mutex
1554          * on a top-lock. Other direction is implemented through a
1555          * try-lock-repeat loop. Mutices of unrelated locks can be taken only
1556          * by try-locking.
1557          *
1558          * \see osc_lock_enqueue_wait(), lov_lock_cancel(), lov_sublock_wait().
1559          */
1560         cfs_mutex_t           cll_guard;
1561         cfs_task_t           *cll_guarder;
1562         int                   cll_depth;
1563
1564         /**
1565          * the owner for INTRANSIT state
1566          */
1567         cfs_task_t           *cll_intransit_owner;
1568         int                   cll_error;
1569         /**
1570          * Number of holds on a lock. A hold prevents a lock from being
1571          * canceled and destroyed. Protected by cl_lock::cll_guard.
1572          *
1573          * \see cl_lock_hold(), cl_lock_unhold(), cl_lock_release()
1574          */
1575         int                   cll_holds;
1576          /**
1577           * Number of lock users. Valid in cl_lock_state::CLS_HELD state
1578           * only. Lock user pins lock in CLS_HELD state. Protected by
1579           * cl_lock::cll_guard.
1580           *
1581           * \see cl_wait(), cl_unuse().
1582           */
1583         int                   cll_users;
1584         /**
1585          * Flag bit-mask. Values from enum cl_lock_flags. Updates are
1586          * protected by cl_lock::cll_guard.
1587          */
1588         unsigned long         cll_flags;
1589         /**
1590          * A linkage into a list of locks in a closure.
1591          *
1592          * \see cl_lock_closure
1593          */
1594         cfs_list_t            cll_inclosure;
1595         /**
1596          * Confict lock at queuing time.
1597          */
1598         struct cl_lock       *cll_conflict;
1599         /**
1600          * A list of references to this lock, for debugging.
1601          */
1602         struct lu_ref         cll_reference;
1603         /**
1604          * A list of holds on this lock, for debugging.
1605          */
1606         struct lu_ref         cll_holders;
1607         /**
1608          * A reference for cl_lock::cll_descr::cld_obj. For debugging.
1609          */
1610         struct lu_ref_link   *cll_obj_ref;
1611 #ifdef CONFIG_LOCKDEP
1612         /* "dep_map" name is assumed by lockdep.h macros. */
1613         struct lockdep_map    dep_map;
1614 #endif
1615 };
1616
1617 /**
1618  * Per-layer part of cl_lock
1619  *
1620  * \see ccc_lock, lov_lock, lovsub_lock, osc_lock
1621  */
1622 struct cl_lock_slice {
1623         struct cl_lock                  *cls_lock;
1624         /** Object slice corresponding to this lock slice. Immutable after
1625          * creation. */
1626         struct cl_object                *cls_obj;
1627         const struct cl_lock_operations *cls_ops;
1628         /** Linkage into cl_lock::cll_layers. Immutable after creation. */
1629         cfs_list_t                       cls_linkage;
1630 };
1631
1632 /**
1633  * Possible (non-error) return values of ->clo_{enqueue,wait,unlock}().
1634  *
1635  * NOTE: lov_subresult() depends on ordering here.
1636  */
1637 enum cl_lock_transition {
1638         /** operation cannot be completed immediately. Wait for state change. */
1639         CLO_WAIT        = 1,
1640         /** operation had to release lock mutex, restart. */
1641         CLO_REPEAT      = 2,
1642         /** lower layer re-enqueued. */
1643         CLO_REENQUEUED  = 3,
1644 };
1645
1646 /**
1647  *
1648  * \see vvp_lock_ops, lov_lock_ops, lovsub_lock_ops, osc_lock_ops
1649  */
1650 struct cl_lock_operations {
1651         /**
1652          * \name statemachine
1653          *
1654          * State machine transitions. These 3 methods are called to transfer
1655          * lock from one state to another, as described in the commentary
1656          * above enum #cl_lock_state.
1657          *
1658          * \retval 0          this layer has nothing more to do to before
1659          *                       transition to the target state happens;
1660          *
1661          * \retval CLO_REPEAT method had to release and re-acquire cl_lock
1662          *                    mutex, repeat invocation of transition method
1663          *                    across all layers;
1664          *
1665          * \retval CLO_WAIT   this layer cannot move to the target state
1666          *                    immediately, as it has to wait for certain event
1667          *                    (e.g., the communication with the server). It
1668          *                    is guaranteed, that when the state transfer
1669          *                    becomes possible, cl_lock::cll_wq wait-queue
1670          *                    is signaled. Caller can wait for this event by
1671          *                    calling cl_lock_state_wait();
1672          *
1673          * \retval -ve        failure, abort state transition, move the lock
1674          *                    into cl_lock_state::CLS_FREEING state, and set
1675          *                    cl_lock::cll_error.
1676          *
1677          * Once all layers voted to agree to transition (by returning 0), lock
1678          * is moved into corresponding target state. All state transition
1679          * methods are optional.
1680          */
1681         /** @{ */
1682         /**
1683          * Attempts to enqueue the lock. Called top-to-bottom.
1684          *
1685          * \see ccc_lock_enqueue(), lov_lock_enqueue(), lovsub_lock_enqueue(),
1686          * \see osc_lock_enqueue()
1687          */
1688         int  (*clo_enqueue)(const struct lu_env *env,
1689                             const struct cl_lock_slice *slice,
1690                             struct cl_io *io, __u32 enqflags);
1691         /**
1692          * Attempts to wait for enqueue result. Called top-to-bottom.
1693          *
1694          * \see ccc_lock_wait(), lov_lock_wait(), osc_lock_wait()
1695          */
1696         int  (*clo_wait)(const struct lu_env *env,
1697                          const struct cl_lock_slice *slice);
1698         /**
1699          * Attempts to unlock the lock. Called bottom-to-top. In addition to
1700          * usual return values of lock state-machine methods, this can return
1701          * -ESTALE to indicate that lock cannot be returned to the cache, and
1702          * has to be re-initialized.
1703          * unuse is a one-shot operation, so it must NOT return CLO_WAIT.
1704          *
1705          * \see ccc_lock_unuse(), lov_lock_unuse(), osc_lock_unuse()
1706          */
1707         int  (*clo_unuse)(const struct lu_env *env,
1708                           const struct cl_lock_slice *slice);
1709         /**
1710          * Notifies layer that cached lock is started being used.
1711          *
1712          * \pre lock->cll_state == CLS_CACHED
1713          *
1714          * \see lov_lock_use(), osc_lock_use()
1715          */
1716         int  (*clo_use)(const struct lu_env *env,
1717                         const struct cl_lock_slice *slice);
1718         /** @} statemachine */
1719         /**
1720          * A method invoked when lock state is changed (as a result of state
1721          * transition). This is used, for example, to track when the state of
1722          * a sub-lock changes, to propagate this change to the corresponding
1723          * top-lock. Optional
1724          *
1725          * \see lovsub_lock_state()
1726          */
1727         void (*clo_state)(const struct lu_env *env,
1728                           const struct cl_lock_slice *slice,
1729                           enum cl_lock_state st);
1730         /**
1731          * Returns true, iff given lock is suitable for the given io, idea
1732          * being, that there are certain "unsafe" locks, e.g., ones acquired
1733          * for O_APPEND writes, that we don't want to re-use for a normal
1734          * write, to avoid the danger of cascading evictions. Optional. Runs
1735          * under cl_object_header::coh_lock_guard.
1736          *
1737          * XXX this should take more information about lock needed by
1738          * io. Probably lock description or something similar.
1739          *
1740          * \see lov_fits_into()
1741          */
1742         int (*clo_fits_into)(const struct lu_env *env,
1743                              const struct cl_lock_slice *slice,
1744                              const struct cl_lock_descr *need,
1745                              const struct cl_io *io);
1746         /**
1747          * \name ast
1748          * Asynchronous System Traps. All of then are optional, all are
1749          * executed bottom-to-top.
1750          */
1751         /** @{ */
1752
1753         /**
1754          * Cancellation callback. Cancel a lock voluntarily, or under
1755          * the request of server.
1756          */
1757         void (*clo_cancel)(const struct lu_env *env,
1758                            const struct cl_lock_slice *slice);
1759         /**
1760          * Lock weighting ast. Executed to estimate how precious this lock
1761          * is. The sum of results across all layers is used to determine
1762          * whether lock worth keeping in cache given present memory usage.
1763          *
1764          * \see osc_lock_weigh(), vvp_lock_weigh(), lovsub_lock_weigh().
1765          */
1766         unsigned long (*clo_weigh)(const struct lu_env *env,
1767                                    const struct cl_lock_slice *slice);
1768         /** @} ast */
1769
1770         /**
1771          * \see lovsub_lock_closure()
1772          */
1773         int (*clo_closure)(const struct lu_env *env,
1774                            const struct cl_lock_slice *slice,
1775                            struct cl_lock_closure *closure);
1776         /**
1777          * Executed bottom-to-top when lock description changes (e.g., as a
1778          * result of server granting more generous lock than was requested).
1779          *
1780          * \see lovsub_lock_modify()
1781          */
1782         int (*clo_modify)(const struct lu_env *env,
1783                           const struct cl_lock_slice *slice,
1784                           const struct cl_lock_descr *updated);
1785         /**
1786          * Notifies layers (bottom-to-top) that lock is going to be
1787          * destroyed. Responsibility of layers is to prevent new references on
1788          * this lock from being acquired once this method returns.
1789          *
1790          * This can be called multiple times due to the races.
1791          *
1792          * \see cl_lock_delete()
1793          * \see osc_lock_delete(), lovsub_lock_delete()
1794          */
1795         void (*clo_delete)(const struct lu_env *env,
1796                            const struct cl_lock_slice *slice);
1797         /**
1798          * Destructor. Frees resources and the slice.
1799          *
1800          * \see ccc_lock_fini(), lov_lock_fini(), lovsub_lock_fini(),
1801          * \see osc_lock_fini()
1802          */
1803         void (*clo_fini)(const struct lu_env *env, struct cl_lock_slice *slice);
1804         /**
1805          * Optional debugging helper. Prints given lock slice.
1806          */
1807         int (*clo_print)(const struct lu_env *env,
1808                          void *cookie, lu_printer_t p,
1809                          const struct cl_lock_slice *slice);
1810 };
1811
1812 #define CL_LOCK_DEBUG(mask, env, lock, format, ...)                     \
1813 do {                                                                    \
1814         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);                \
1815                                                                         \
1816         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
1817                 cl_lock_print(env, &msgdata, lu_cdebug_printer, lock);  \
1818                 CDEBUG(mask, format , ## __VA_ARGS__);                  \
1819         }                                                               \
1820 } while (0)
1821
1822 #define CL_LOCK_ASSERT(expr, env, lock) do {                            \
1823         if (likely(expr))                                               \
1824                 break;                                                  \
1825                                                                         \
1826         CL_LOCK_DEBUG(D_ERROR, env, lock, "failed at %s.\n", #expr);    \
1827         LBUG();                                                         \
1828 } while (0)
1829
1830 /** @} cl_lock */
1831
1832 /** \addtogroup cl_page_list cl_page_list
1833  * Page list used to perform collective operations on a group of pages.
1834  *
1835  * Pages are added to the list one by one. cl_page_list acquires a reference
1836  * for every page in it. Page list is used to perform collective operations on
1837  * pages:
1838  *
1839  *     - submit pages for an immediate transfer,
1840  *
1841  *     - own pages on behalf of certain io (waiting for each page in turn),
1842  *
1843  *     - discard pages.
1844  *
1845  * When list is finalized, it releases references on all pages it still has.
1846  *
1847  * \todo XXX concurrency control.
1848  *
1849  * @{
1850  */
1851 struct cl_page_list {
1852         unsigned             pl_nr;
1853         cfs_list_t           pl_pages;
1854         cfs_task_t          *pl_owner;
1855 };
1856
1857 /** 
1858  * A 2-queue of pages. A convenience data-type for common use case, 2-queue
1859  * contains an incoming page list and an outgoing page list.
1860  */
1861 struct cl_2queue {
1862         struct cl_page_list c2_qin;
1863         struct cl_page_list c2_qout;
1864 };
1865
1866 /** @} cl_page_list */
1867
1868 /** \addtogroup cl_io cl_io
1869  * @{ */
1870 /** \struct cl_io
1871  * I/O
1872  *
1873  * cl_io represents a high level I/O activity like
1874  * read(2)/write(2)/truncate(2) system call, or cancellation of an extent
1875  * lock.
1876  *
1877  * cl_io is a layered object, much like cl_{object,page,lock} but with one
1878  * important distinction. We want to minimize number of calls to the allocator
1879  * in the fast path, e.g., in the case of read(2) when everything is cached:
1880  * client already owns the lock over region being read, and data are cached
1881  * due to read-ahead. To avoid allocation of cl_io layers in such situations,
1882  * per-layer io state is stored in the session, associated with the io, see
1883  * struct {vvp,lov,osc}_io for example. Sessions allocation is amortized
1884  * by using free-lists, see cl_env_get().
1885  *
1886  * There is a small predefined number of possible io types, enumerated in enum
1887  * cl_io_type.
1888  *
1889  * cl_io is a state machine, that can be advanced concurrently by the multiple
1890  * threads. It is up to these threads to control the concurrency and,
1891  * specifically, to detect when io is done, and its state can be safely
1892  * released.
1893  *
1894  * For read/write io overall execution plan is as following:
1895  *
1896  *     (0) initialize io state through all layers;
1897  *
1898  *     (1) loop: prepare chunk of work to do
1899  *
1900  *     (2) call all layers to collect locks they need to process current chunk
1901  *
1902  *     (3) sort all locks to avoid dead-locks, and acquire them
1903  *
1904  *     (4) process the chunk: call per-page methods
1905  *         (cl_io_operations::cio_read_page() for read,
1906  *         cl_io_operations::cio_prepare_write(),
1907  *         cl_io_operations::cio_commit_write() for write)
1908  *
1909  *     (5) release locks
1910  *
1911  *     (6) repeat loop.
1912  *
1913  * To implement the "parallel IO mode", lov layer creates sub-io's (lazily to
1914  * address allocation efficiency issues mentioned above), and returns with the
1915  * special error condition from per-page method when current sub-io has to
1916  * block. This causes io loop to be repeated, and lov switches to the next
1917  * sub-io in its cl_io_operations::cio_iter_init() implementation.
1918  */
1919
1920 /** IO types */
1921 enum cl_io_type {
1922         /** read system call */
1923         CIT_READ,
1924         /** write system call */
1925         CIT_WRITE,
1926         /** truncate, utime system calls */
1927         CIT_SETATTR,
1928         /**
1929          * page fault handling
1930          */
1931         CIT_FAULT,
1932         /**
1933          * fsync system call handling
1934          * To write out a range of file
1935          */
1936         CIT_FSYNC,
1937         /**
1938          * Miscellaneous io. This is used for occasional io activity that
1939          * doesn't fit into other types. Currently this is used for:
1940          *
1941          *     - cancellation of an extent lock. This io exists as a context
1942          *     to write dirty pages from under the lock being canceled back
1943          *     to the server;
1944          *
1945          *     - VM induced page write-out. An io context for writing page out
1946          *     for memory cleansing;
1947          *
1948          *     - glimpse. An io context to acquire glimpse lock.
1949          *
1950          *     - grouplock. An io context to acquire group lock.
1951          *
1952          * CIT_MISC io is used simply as a context in which locks and pages
1953          * are manipulated. Such io has no internal "process", that is,
1954          * cl_io_loop() is never called for it.
1955          */
1956         CIT_MISC,
1957         CIT_OP_NR
1958 };
1959
1960 /**
1961  * States of cl_io state machine
1962  */
1963 enum cl_io_state {
1964         /** Not initialized. */
1965         CIS_ZERO,
1966         /** Initialized. */
1967         CIS_INIT,
1968         /** IO iteration started. */
1969         CIS_IT_STARTED,
1970         /** Locks taken. */
1971         CIS_LOCKED,
1972         /** Actual IO is in progress. */
1973         CIS_IO_GOING,
1974         /** IO for the current iteration finished. */
1975         CIS_IO_FINISHED,
1976         /** Locks released. */
1977         CIS_UNLOCKED,
1978         /** Iteration completed. */
1979         CIS_IT_ENDED,
1980         /** cl_io finalized. */
1981         CIS_FINI
1982 };
1983
1984 /**
1985  * IO state private for a layer.
1986  *
1987  * This is usually embedded into layer session data, rather than allocated
1988  * dynamically.
1989  *
1990  * \see vvp_io, lov_io, osc_io, ccc_io
1991  */
1992 struct cl_io_slice {
1993         struct cl_io                  *cis_io;
1994         /** corresponding object slice. Immutable after creation. */
1995         struct cl_object              *cis_obj;
1996         /** io operations. Immutable after creation. */
1997         const struct cl_io_operations *cis_iop;
1998         /**
1999          * linkage into a list of all slices for a given cl_io, hanging off
2000          * cl_io::ci_layers. Immutable after creation.
2001          */
2002         cfs_list_t                     cis_linkage;
2003 };
2004
2005
2006 /**
2007  * Per-layer io operations.
2008  * \see vvp_io_ops, lov_io_ops, lovsub_io_ops, osc_io_ops
2009  */
2010 struct cl_io_operations {
2011         /**
2012          * Vector of io state transition methods for every io type.
2013          *
2014          * \see cl_page_operations::io
2015          */
2016         struct {
2017                 /**
2018                  * Prepare io iteration at a given layer.
2019                  *
2020                  * Called top-to-bottom at the beginning of each iteration of
2021                  * "io loop" (if it makes sense for this type of io). Here
2022                  * layer selects what work it will do during this iteration.
2023                  *
2024                  * \see cl_io_operations::cio_iter_fini()
2025                  */
2026                 int (*cio_iter_init) (const struct lu_env *env,
2027                                       const struct cl_io_slice *slice);
2028                 /**
2029                  * Finalize io iteration.
2030                  *
2031                  * Called bottom-to-top at the end of each iteration of "io
2032                  * loop". Here layers can decide whether IO has to be
2033                  * continued.
2034                  *
2035                  * \see cl_io_operations::cio_iter_init()
2036                  */
2037                 void (*cio_iter_fini) (const struct lu_env *env,
2038                                        const struct cl_io_slice *slice);
2039                 /**
2040                  * Collect locks for the current iteration of io.
2041                  *
2042                  * Called top-to-bottom to collect all locks necessary for
2043                  * this iteration. This methods shouldn't actually enqueue
2044                  * anything, instead it should post a lock through
2045                  * cl_io_lock_add(). Once all locks are collected, they are
2046                  * sorted and enqueued in the proper order.
2047                  */
2048                 int  (*cio_lock) (const struct lu_env *env,
2049                                   const struct cl_io_slice *slice);
2050                 /**
2051                  * Finalize unlocking.
2052                  *
2053                  * Called bottom-to-top to finish layer specific unlocking
2054                  * functionality, after generic code released all locks
2055                  * acquired by cl_io_operations::cio_lock().
2056                  */
2057                 void  (*cio_unlock)(const struct lu_env *env,
2058                                     const struct cl_io_slice *slice);
2059                 /**
2060                  * Start io iteration.
2061                  *
2062                  * Once all locks are acquired, called top-to-bottom to
2063                  * commence actual IO. In the current implementation,
2064                  * top-level vvp_io_{read,write}_start() does all the work
2065                  * synchronously by calling generic_file_*(), so other layers
2066                  * are called when everything is done.
2067                  */
2068                 int  (*cio_start)(const struct lu_env *env,
2069                                   const struct cl_io_slice *slice);
2070                 /**
2071                  * Called top-to-bottom at the end of io loop. Here layer
2072                  * might wait for an unfinished asynchronous io.
2073                  */
2074                 void (*cio_end)  (const struct lu_env *env,
2075                                   const struct cl_io_slice *slice);
2076                 /**
2077                  * Called bottom-to-top to notify layers that read/write IO
2078                  * iteration finished, with \a nob bytes transferred.
2079                  */
2080                 void (*cio_advance)(const struct lu_env *env,
2081                                     const struct cl_io_slice *slice,
2082                                     size_t nob);
2083                 /**
2084                  * Called once per io, bottom-to-top to release io resources.
2085                  */
2086                 void (*cio_fini) (const struct lu_env *env,
2087                                   const struct cl_io_slice *slice);
2088         } op[CIT_OP_NR];
2089         struct {
2090                 /**
2091                  * Submit pages from \a queue->c2_qin for IO, and move
2092                  * successfully submitted pages into \a queue->c2_qout. Return
2093                  * non-zero if failed to submit even the single page. If
2094                  * submission failed after some pages were moved into \a
2095                  * queue->c2_qout, completion callback with non-zero ioret is
2096                  * executed on them.
2097                  */
2098                 int  (*cio_submit)(const struct lu_env *env,
2099                                    const struct cl_io_slice *slice,
2100                                    enum cl_req_type crt,
2101                                    struct cl_2queue *queue);
2102         } req_op[CRT_NR];
2103         /**
2104          * Read missing page.
2105          *
2106          * Called by a top-level cl_io_operations::op[CIT_READ]::cio_start()
2107          * method, when it hits not-up-to-date page in the range. Optional.
2108          *
2109          * \pre io->ci_type == CIT_READ
2110          */
2111         int (*cio_read_page)(const struct lu_env *env,
2112                              const struct cl_io_slice *slice,
2113                              const struct cl_page_slice *page);
2114         /**
2115          * Prepare write of a \a page. Called bottom-to-top by a top-level
2116          * cl_io_operations::op[CIT_WRITE]::cio_start() to prepare page for
2117          * get data from user-level buffer.
2118          *
2119          * \pre io->ci_type == CIT_WRITE
2120          *
2121          * \see vvp_io_prepare_write(), lov_io_prepare_write(),
2122          * osc_io_prepare_write().
2123          */
2124         int (*cio_prepare_write)(const struct lu_env *env,
2125                                  const struct cl_io_slice *slice,
2126                                  const struct cl_page_slice *page,
2127                                  unsigned from, unsigned to);
2128         /**
2129          *
2130          * \pre io->ci_type == CIT_WRITE
2131          *
2132          * \see vvp_io_commit_write(), lov_io_commit_write(),
2133          * osc_io_commit_write().
2134          */
2135         int (*cio_commit_write)(const struct lu_env *env,
2136                                 const struct cl_io_slice *slice,
2137                                 const struct cl_page_slice *page,
2138                                 unsigned from, unsigned to);
2139         /**
2140          * Optional debugging helper. Print given io slice.
2141          */
2142         int (*cio_print)(const struct lu_env *env, void *cookie,
2143                          lu_printer_t p, const struct cl_io_slice *slice);
2144 };
2145
2146 /**
2147  * Flags to lock enqueue procedure.
2148  * \ingroup cl_lock
2149  */
2150 enum cl_enq_flags {
2151         /**
2152          * instruct server to not block, if conflicting lock is found. Instead
2153          * -EWOULDBLOCK is returned immediately.
2154          */
2155         CEF_NONBLOCK     = 0x00000001,
2156         /**
2157          * take lock asynchronously (out of order), as it cannot
2158          * deadlock. This is for LDLM_FL_HAS_INTENT locks used for glimpsing.
2159          */
2160         CEF_ASYNC        = 0x00000002,
2161         /**
2162          * tell the server to instruct (though a flag in the blocking ast) an
2163          * owner of the conflicting lock, that it can drop dirty pages
2164          * protected by this lock, without sending them to the server.
2165          */
2166         CEF_DISCARD_DATA = 0x00000004,
2167         /**
2168          * tell the sub layers that it must be a `real' lock. This is used for
2169          * mmapped-buffer locks and glimpse locks that must be never converted
2170          * into lockless mode.
2171          *
2172          * \see vvp_mmap_locks(), cl_glimpse_lock().
2173          */
2174         CEF_MUST         = 0x00000008,
2175         /**
2176          * tell the sub layers that never request a `real' lock. This flag is
2177          * not used currently.
2178          *
2179          * cl_io::ci_lockreq and CEF_{MUST,NEVER} flags specify lockless
2180          * conversion policy: ci_lockreq describes generic information of lock
2181          * requirement for this IO, especially for locks which belong to the
2182          * object doing IO; however, lock itself may have precise requirements
2183          * that are described by the enqueue flags.
2184          */
2185         CEF_NEVER        = 0x00000010,
2186         /**
2187          * for async glimpse lock.
2188          */
2189         CEF_AGL          = 0x00000020,
2190         /**
2191          * mask of enq_flags.
2192          */
2193         CEF_MASK         = 0x0000003f,
2194 };
2195
2196 /**
2197  * Link between lock and io. Intermediate structure is needed, because the
2198  * same lock can be part of multiple io's simultaneously.
2199  */
2200 struct cl_io_lock_link {
2201         /** linkage into one of cl_lockset lists. */
2202         cfs_list_t           cill_linkage;
2203         struct cl_lock_descr cill_descr;
2204         struct cl_lock      *cill_lock;
2205         /** optional destructor */
2206         void               (*cill_fini)(const struct lu_env *env,
2207                                         struct cl_io_lock_link *link);
2208 };
2209
2210 /**
2211  * Lock-set represents a collection of locks, that io needs at a
2212  * time. Generally speaking, client tries to avoid holding multiple locks when
2213  * possible, because
2214  *
2215  *      - holding extent locks over multiple ost's introduces the danger of
2216  *        "cascading timeouts";
2217  *
2218  *      - holding multiple locks over the same ost is still dead-lock prone,
2219  *        see comment in osc_lock_enqueue(),
2220  *
2221  * but there are certain situations where this is unavoidable:
2222  *
2223  *      - O_APPEND writes have to take [0, EOF] lock for correctness;
2224  *
2225  *      - truncate has to take [new-size, EOF] lock for correctness;
2226  *
2227  *      - SNS has to take locks across full stripe for correctness;
2228  *
2229  *      - in the case when user level buffer, supplied to {read,write}(file0),
2230  *        is a part of a memory mapped lustre file, client has to take a dlm
2231  *        locks on file0, and all files that back up the buffer (or a part of
2232  *        the buffer, that is being processed in the current chunk, in any
2233  *        case, there are situations where at least 2 locks are necessary).
2234  *
2235  * In such cases we at least try to take locks in the same consistent
2236  * order. To this end, all locks are first collected, then sorted, and then
2237  * enqueued.
2238  */
2239 struct cl_lockset {
2240         /** locks to be acquired. */
2241         cfs_list_t  cls_todo;
2242         /** locks currently being processed. */
2243         cfs_list_t  cls_curr;
2244         /** locks acquired. */
2245         cfs_list_t  cls_done;
2246 };
2247
2248 /**
2249  * Lock requirements(demand) for IO. It should be cl_io_lock_req,
2250  * but 'req' is always to be thought as 'request' :-)
2251  */
2252 enum cl_io_lock_dmd {
2253         /** Always lock data (e.g., O_APPEND). */
2254         CILR_MANDATORY = 0,
2255         /** Layers are free to decide between local and global locking. */
2256         CILR_MAYBE,
2257         /** Never lock: there is no cache (e.g., liblustre). */
2258         CILR_NEVER,
2259         /** Peek lock: use existing locks, don't queue new ones */
2260         CILR_PEEK
2261 };
2262
2263 enum cl_fsync_mode {
2264         /** start writeback, do not wait for them to finish */
2265         CL_FSYNC_NONE  = 0,
2266         /** start writeback and wait for them to finish */
2267         CL_FSYNC_LOCAL = 1,
2268         /** discard all of dirty pages in a specific file range */
2269         CL_FSYNC_DISCARD = 2,
2270         /** start writeback and make sure they have reached storage before
2271          * return. OST_SYNC RPC must be issued and finished */
2272         CL_FSYNC_ALL   = 3
2273 };
2274
2275 struct cl_io_rw_common {
2276         loff_t      crw_pos;
2277         size_t      crw_count;
2278         int         crw_nonblock;
2279 };
2280
2281
2282 /**
2283  * State for io.
2284  *
2285  * cl_io is shared by all threads participating in this IO (in current
2286  * implementation only one thread advances IO, but parallel IO design and
2287  * concurrent copy_*_user() require multiple threads acting on the same IO. It
2288  * is up to these threads to serialize their activities, including updates to
2289  * mutable cl_io fields.
2290  */
2291 struct cl_io {
2292         /** type of this IO. Immutable after creation. */
2293         enum cl_io_type                ci_type;
2294         /** current state of cl_io state machine. */
2295         enum cl_io_state               ci_state;
2296         /** main object this io is against. Immutable after creation. */
2297         struct cl_object              *ci_obj;
2298         /**
2299          * Upper layer io, of which this io is a part of. Immutable after
2300          * creation.
2301          */
2302         struct cl_io                  *ci_parent;
2303         /** List of slices. Immutable after creation. */
2304         cfs_list_t                     ci_layers;
2305         /** list of locks (to be) acquired by this io. */
2306         struct cl_lockset              ci_lockset;
2307         /** lock requirements, this is just a help info for sublayers. */
2308         enum cl_io_lock_dmd            ci_lockreq;
2309         union {
2310                 struct cl_rd_io {
2311                         struct cl_io_rw_common rd;
2312                 } ci_rd;
2313                 struct cl_wr_io {
2314                         struct cl_io_rw_common wr;
2315                         int                    wr_append;
2316                         int                    wr_sync;
2317                 } ci_wr;
2318                 struct cl_io_rw_common ci_rw;
2319                 struct cl_setattr_io {
2320                         struct ost_lvb   sa_attr;
2321                         unsigned int     sa_valid;
2322                         struct obd_capa *sa_capa;
2323                 } ci_setattr;
2324                 struct cl_fault_io {
2325                         /** page index within file. */
2326                         pgoff_t         ft_index;
2327                         /** bytes valid byte on a faulted page. */
2328                         int             ft_nob;
2329                         /** writable page? for nopage() only */
2330                         int             ft_writable;
2331                         /** page of an executable? */
2332                         int             ft_executable;
2333                         /** page_mkwrite() */
2334                         int             ft_mkwrite;
2335                         /** resulting page */
2336                         struct cl_page *ft_page;
2337                 } ci_fault;
2338                 struct cl_fsync_io {
2339                         loff_t             fi_start;
2340                         loff_t             fi_end;
2341                         struct obd_capa   *fi_capa;
2342                         /** file system level fid */
2343                         struct lu_fid     *fi_fid;
2344                         enum cl_fsync_mode fi_mode;
2345                         /* how many pages were written/discarded */
2346                         unsigned int       fi_nr_written;
2347                 } ci_fsync;
2348         } u;
2349         struct cl_2queue     ci_queue;
2350         size_t               ci_nob;
2351         int                  ci_result;
2352         unsigned int         ci_continue:1,
2353         /**
2354          * This io has held grouplock, to inform sublayers that
2355          * don't do lockless i/o.
2356          */
2357                              ci_no_srvlock:1,
2358         /**
2359          * The whole IO need to be restarted because layout has been changed
2360          */
2361                              ci_need_restart:1,
2362         /**
2363          * Ignore layout change.
2364          * Most of the CIT_MISC operations can ignore layout change, because
2365          * the purpose to create this kind of cl_io is to give an environment
2366          * to run clio methods, for example:
2367          *   1. request group lock;
2368          *   2. flush caching pages by osc;
2369          *   3. writepage
2370          *   4. echo client
2371          * So far, only direct IO and glimpse clio need restart if layout
2372          * change during IO time.
2373          */
2374                              ci_ignore_layout:1;
2375         /**
2376          * Number of pages owned by this IO. For invariant checking.
2377          */
2378         unsigned             ci_owned_nr;
2379 };
2380
2381 /** @} cl_io */
2382
2383 /** \addtogroup cl_req cl_req
2384  * @{ */
2385 /** \struct cl_req
2386  * Transfer.
2387  *
2388  * There are two possible modes of transfer initiation on the client:
2389  *
2390  *     - immediate transfer: this is started when a high level io wants a page
2391  *       or a collection of pages to be transferred right away. Examples:
2392  *       read-ahead, synchronous read in the case of non-page aligned write,
2393  *       page write-out as a part of extent lock cancellation, page write-out
2394  *       as a part of memory cleansing. Immediate transfer can be both
2395  *       cl_req_type::CRT_READ and cl_req_type::CRT_WRITE;
2396  *
2397  *     - opportunistic transfer (cl_req_type::CRT_WRITE only), that happens
2398  *       when io wants to transfer a page to the server some time later, when
2399  *       it can be done efficiently. Example: pages dirtied by the write(2)
2400  *       path.
2401  *
2402  * In any case, transfer takes place in the form of a cl_req, which is a
2403  * representation for a network RPC.
2404  *
2405  * Pages queued for an opportunistic transfer are cached until it is decided
2406  * that efficient RPC can be composed of them. This decision is made by "a
2407  * req-formation engine", currently implemented as a part of osc
2408  * layer. Req-formation depends on many factors: the size of the resulting
2409  * RPC, whether or not multi-object RPCs are supported by the server,
2410  * max-rpc-in-flight limitations, size of the dirty cache, etc.
2411  *
2412  * For the immediate transfer io submits a cl_page_list, that req-formation
2413  * engine slices into cl_req's, possibly adding cached pages to some of
2414  * the resulting req's.
2415  *
2416  * Whenever a page from cl_page_list is added to a newly constructed req, its
2417  * cl_page_operations::cpo_prep() layer methods are called. At that moment,
2418  * page state is atomically changed from cl_page_state::CPS_OWNED to
2419  * cl_page_state::CPS_PAGEOUT or cl_page_state::CPS_PAGEIN, cl_page::cp_owner
2420  * is zeroed, and cl_page::cp_req is set to the
2421  * req. cl_page_operations::cpo_prep() method at the particular layer might
2422  * return -EALREADY to indicate that it does not need to submit this page
2423  * at all. This is possible, for example, if page, submitted for read,
2424  * became up-to-date in the meantime; and for write, the page don't have
2425  * dirty bit marked. \see cl_io_submit_rw()
2426  *
2427  * Whenever a cached page is added to a newly constructed req, its
2428  * cl_page_operations::cpo_make_ready() layer methods are called. At that
2429  * moment, page state is atomically changed from cl_page_state::CPS_CACHED to
2430  * cl_page_state::CPS_PAGEOUT, and cl_page::cp_req is set to
2431  * req. cl_page_operations::cpo_make_ready() method at the particular layer
2432  * might return -EAGAIN to indicate that this page is not eligible for the
2433  * transfer right now.
2434  *
2435  * FUTURE
2436  *
2437  * Plan is to divide transfers into "priority bands" (indicated when
2438  * submitting cl_page_list, and queuing a page for the opportunistic transfer)
2439  * and allow glueing of cached pages to immediate transfers only within single
2440  * band. This would make high priority transfers (like lock cancellation or
2441  * memory pressure induced write-out) really high priority.
2442  *
2443  */
2444
2445 /**
2446  * Per-transfer attributes.
2447  */
2448 struct cl_req_attr {
2449         /** Generic attributes for the server consumption. */
2450         struct obdo     *cra_oa;
2451         /** Capability. */
2452         struct obd_capa *cra_capa;
2453         /** Jobid */
2454         char             cra_jobid[JOBSTATS_JOBID_SIZE];
2455 };
2456
2457 /**
2458  * Transfer request operations definable at every layer.
2459  *
2460  * Concurrency: transfer formation engine synchronizes calls to all transfer
2461  * methods.
2462  */
2463 struct cl_req_operations {
2464         /**
2465          * Invoked top-to-bottom by cl_req_prep() when transfer formation is
2466          * complete (all pages are added).
2467          *
2468          * \see osc_req_prep()
2469          */
2470         int  (*cro_prep)(const struct lu_env *env,
2471                          const struct cl_req_slice *slice);
2472         /**
2473          * Called top-to-bottom to fill in \a oa fields. This is called twice
2474          * with different flags, see bug 10150 and osc_build_req().
2475          *
2476          * \param obj an object from cl_req which attributes are to be set in
2477          *            \a oa.
2478          *
2479          * \param oa struct obdo where attributes are placed
2480          *
2481          * \param flags \a oa fields to be filled.
2482          */
2483         void (*cro_attr_set)(const struct lu_env *env,
2484                              const struct cl_req_slice *slice,
2485                              const struct cl_object *obj,
2486                              struct cl_req_attr *attr, obd_valid flags);
2487         /**
2488          * Called top-to-bottom from cl_req_completion() to notify layers that
2489          * transfer completed. Has to free all state allocated by
2490          * cl_device_operations::cdo_req_init().
2491          */
2492         void (*cro_completion)(const struct lu_env *env,
2493                                const struct cl_req_slice *slice, int ioret);
2494 };
2495
2496 /**
2497  * A per-object state that (potentially multi-object) transfer request keeps.
2498  */
2499 struct cl_req_obj {
2500         /** object itself */
2501         struct cl_object   *ro_obj;
2502         /** reference to cl_req_obj::ro_obj. For debugging. */
2503         struct lu_ref_link *ro_obj_ref;
2504         /* something else? Number of pages for a given object? */
2505 };
2506
2507 /**
2508  * Transfer request.
2509  *
2510  * Transfer requests are not reference counted, because IO sub-system owns
2511  * them exclusively and knows when to free them.
2512  *
2513  * Life cycle.
2514  *
2515  * cl_req is created by cl_req_alloc() that calls
2516  * cl_device_operations::cdo_req_init() device methods to allocate per-req
2517  * state in every layer.
2518  *
2519  * Then pages are added (cl_req_page_add()), req keeps track of all objects it
2520  * contains pages for.
2521  *
2522  * Once all pages were collected, cl_page_operations::cpo_prep() method is
2523  * called top-to-bottom. At that point layers can modify req, let it pass, or
2524  * deny it completely. This is to support things like SNS that have transfer
2525  * ordering requirements invisible to the individual req-formation engine.
2526  *
2527  * On transfer completion (or transfer timeout, or failure to initiate the
2528  * transfer of an allocated req), cl_req_operations::cro_completion() method
2529  * is called, after execution of cl_page_operations::cpo_completion() of all
2530  * req's pages.
2531  */
2532 struct cl_req {
2533         enum cl_req_type      crq_type;
2534         /** A list of pages being transfered */
2535         cfs_list_t            crq_pages;
2536         /** Number of pages in cl_req::crq_pages */
2537         unsigned              crq_nrpages;
2538         /** An array of objects which pages are in ->crq_pages */
2539         struct cl_req_obj    *crq_o;
2540         /** Number of elements in cl_req::crq_objs[] */
2541         unsigned              crq_nrobjs;
2542         cfs_list_t            crq_layers;
2543 };
2544
2545 /**
2546  * Per-layer state for request.
2547  */
2548 struct cl_req_slice {
2549         struct cl_req    *crs_req;
2550         struct cl_device *crs_dev;
2551         cfs_list_t        crs_linkage;
2552         const struct cl_req_operations *crs_ops;
2553 };
2554
2555 /* @} cl_req */
2556
2557 /**
2558  * Stats for a generic cache (similar to inode, lu_object, etc. caches).
2559  */
2560 struct cache_stats {
2561         const char    *cs_name;
2562         /** how many entities were created at all */
2563         cfs_atomic_t   cs_created;
2564         /** how many cache lookups were performed */
2565         cfs_atomic_t   cs_lookup;
2566         /** how many times cache lookup resulted in a hit */
2567         cfs_atomic_t   cs_hit;
2568         /** how many entities are in the cache right now */
2569         cfs_atomic_t   cs_total;
2570         /** how many entities in the cache are actively used (and cannot be
2571          * evicted) right now */
2572         cfs_atomic_t   cs_busy;
2573 };
2574
2575 /** These are not exported so far */
2576 void cache_stats_init (struct cache_stats *cs, const char *name);
2577 int  cache_stats_print(const struct cache_stats *cs,
2578                        char *page, int count, int header);
2579
2580 /**
2581  * Client-side site. This represents particular client stack. "Global"
2582  * variables should (directly or indirectly) be added here to allow multiple
2583  * clients to co-exist in the single address space.
2584  */
2585 struct cl_site {
2586         struct lu_site        cs_lu;
2587         /**
2588          * Statistical counters. Atomics do not scale, something better like
2589          * per-cpu counters is needed.
2590          *
2591          * These are exported as /proc/fs/lustre/llite/.../site
2592          *
2593          * When interpreting keep in mind that both sub-locks (and sub-pages)
2594          * and top-locks (and top-pages) are accounted here.
2595          */
2596         struct cache_stats    cs_pages;
2597         struct cache_stats    cs_locks;
2598         cfs_atomic_t          cs_pages_state[CPS_NR];
2599         cfs_atomic_t          cs_locks_state[CLS_NR];
2600 };
2601
2602 int  cl_site_init (struct cl_site *s, struct cl_device *top);
2603 void cl_site_fini (struct cl_site *s);
2604 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl);
2605
2606 /**
2607  * Output client site statistical counters into a buffer. Suitable for
2608  * ll_rd_*()-style functions.
2609  */
2610 int cl_site_stats_print(const struct cl_site *s, char *page, int count);
2611
2612 /**
2613  * \name helpers
2614  *
2615  * Type conversion and accessory functions.
2616  */
2617 /** @{ */
2618
2619 static inline struct cl_site *lu2cl_site(const struct lu_site *site)
2620 {
2621         return container_of(site, struct cl_site, cs_lu);
2622 }
2623
2624 static inline int lu_device_is_cl(const struct lu_device *d)
2625 {
2626         return d->ld_type->ldt_tags & LU_DEVICE_CL;
2627 }
2628
2629 static inline struct cl_device *lu2cl_dev(const struct lu_device *d)
2630 {
2631         LASSERT(d == NULL || IS_ERR(d) || lu_device_is_cl(d));
2632         return container_of0(d, struct cl_device, cd_lu_dev);
2633 }
2634
2635 static inline struct lu_device *cl2lu_dev(struct cl_device *d)
2636 {
2637         return &d->cd_lu_dev;
2638 }
2639
2640 static inline struct cl_object *lu2cl(const struct lu_object *o)
2641 {
2642         LASSERT(o == NULL || IS_ERR(o) || lu_device_is_cl(o->lo_dev));
2643         return container_of0(o, struct cl_object, co_lu);
2644 }
2645
2646 static inline const struct cl_object_conf *
2647 lu2cl_conf(const struct lu_object_conf *conf)
2648 {
2649         return container_of0(conf, struct cl_object_conf, coc_lu);
2650 }
2651
2652 static inline struct cl_object *cl_object_next(const struct cl_object *obj)
2653 {
2654         return obj ? lu2cl(lu_object_next(&obj->co_lu)) : NULL;
2655 }
2656
2657 static inline struct cl_device *cl_object_device(const struct cl_object *o)
2658 {
2659         LASSERT(o == NULL || IS_ERR(o) || lu_device_is_cl(o->co_lu.lo_dev));
2660         return container_of0(o->co_lu.lo_dev, struct cl_device, cd_lu_dev);
2661 }
2662
2663 static inline struct cl_object_header *luh2coh(const struct lu_object_header *h)
2664 {
2665         return container_of0(h, struct cl_object_header, coh_lu);
2666 }
2667
2668 static inline struct cl_site *cl_object_site(const struct cl_object *obj)
2669 {
2670         return lu2cl_site(obj->co_lu.lo_dev->ld_site);
2671 }
2672
2673 static inline
2674 struct cl_object_header *cl_object_header(const struct cl_object *obj)
2675 {
2676         return luh2coh(obj->co_lu.lo_header);
2677 }
2678
2679 static inline int cl_device_init(struct cl_device *d, struct lu_device_type *t)
2680 {
2681         return lu_device_init(&d->cd_lu_dev, t);
2682 }
2683
2684 static inline void cl_device_fini(struct cl_device *d)
2685 {
2686         lu_device_fini(&d->cd_lu_dev);
2687 }
2688
2689 void cl_page_slice_add(struct cl_page *page, struct cl_page_slice *slice,
2690                        struct cl_object *obj,
2691                        const struct cl_page_operations *ops);
2692 void cl_lock_slice_add(struct cl_lock *lock, struct cl_lock_slice *slice,
2693                        struct cl_object *obj,
2694                        const struct cl_lock_operations *ops);
2695 void cl_io_slice_add(struct cl_io *io, struct cl_io_slice *slice,
2696                      struct cl_object *obj, const struct cl_io_operations *ops);
2697 void cl_req_slice_add(struct cl_req *req, struct cl_req_slice *slice,
2698                       struct cl_device *dev,
2699                       const struct cl_req_operations *ops);
2700 /** @} helpers */
2701
2702 /** \defgroup cl_object cl_object
2703  * @{ */
2704 struct cl_object *cl_object_top (struct cl_object *o);
2705 struct cl_object *cl_object_find(const struct lu_env *env, struct cl_device *cd,
2706                                  const struct lu_fid *fid,
2707                                  const struct cl_object_conf *c);
2708
2709 int  cl_object_header_init(struct cl_object_header *h);
2710 void cl_object_header_fini(struct cl_object_header *h);
2711 void cl_object_put        (const struct lu_env *env, struct cl_object *o);
2712 void cl_object_get        (struct cl_object *o);
2713 void cl_object_attr_lock  (struct cl_object *o);
2714 void cl_object_attr_unlock(struct cl_object *o);
2715 int  cl_object_attr_get   (const struct lu_env *env, struct cl_object *obj,
2716                            struct cl_attr *attr);
2717 int  cl_object_attr_set   (const struct lu_env *env, struct cl_object *obj,
2718                            const struct cl_attr *attr, unsigned valid);
2719 int  cl_object_glimpse    (const struct lu_env *env, struct cl_object *obj,
2720                            struct ost_lvb *lvb);
2721 int  cl_conf_set          (const struct lu_env *env, struct cl_object *obj,
2722                            const struct cl_object_conf *conf);
2723 void cl_object_prune      (const struct lu_env *env, struct cl_object *obj);
2724 void cl_object_kill       (const struct lu_env *env, struct cl_object *obj);
2725 int  cl_object_has_locks  (struct cl_object *obj);
2726
2727 /**
2728  * Returns true, iff \a o0 and \a o1 are slices of the same object.
2729  */
2730 static inline int cl_object_same(struct cl_object *o0, struct cl_object *o1)
2731 {
2732         return cl_object_header(o0) == cl_object_header(o1);
2733 }
2734
2735 /** @} cl_object */
2736
2737 /** \defgroup cl_page cl_page
2738  * @{ */
2739 enum {
2740         CLP_GANG_OKAY = 0,
2741         CLP_GANG_RESCHED,
2742         CLP_GANG_AGAIN,
2743         CLP_GANG_ABORT
2744 };
2745
2746 /* callback of cl_page_gang_lookup() */
2747 typedef int   (*cl_page_gang_cb_t)  (const struct lu_env *, struct cl_io *,
2748                                      struct cl_page *, void *);
2749 int             cl_page_gang_lookup (const struct lu_env *env,
2750                                      struct cl_object *obj,
2751                                      struct cl_io *io,
2752                                      pgoff_t start, pgoff_t end,
2753                                      cl_page_gang_cb_t cb, void *cbdata);
2754 struct cl_page *cl_page_lookup      (struct cl_object_header *hdr,
2755                                      pgoff_t index);
2756 struct cl_page *cl_page_find        (const struct lu_env *env,
2757                                      struct cl_object *obj,
2758                                      pgoff_t idx, struct page *vmpage,
2759                                      enum cl_page_type type);
2760 struct cl_page *cl_page_find_sub    (const struct lu_env *env,
2761                                      struct cl_object *obj,
2762                                      pgoff_t idx, struct page *vmpage,
2763                                      struct cl_page *parent);
2764 void            cl_page_get         (struct cl_page *page);
2765 void            cl_page_put         (const struct lu_env *env,
2766                                      struct cl_page *page);
2767 void            cl_page_print       (const struct lu_env *env, void *cookie,
2768                                      lu_printer_t printer,
2769                                      const struct cl_page *pg);
2770 void            cl_page_header_print(const struct lu_env *env, void *cookie,
2771                                      lu_printer_t printer,
2772                                      const struct cl_page *pg);
2773 cfs_page_t     *cl_page_vmpage      (const struct lu_env *env,
2774                                      struct cl_page *page);
2775 struct cl_page *cl_vmpage_page      (cfs_page_t *vmpage, struct cl_object *obj);
2776 struct cl_page *cl_page_top         (struct cl_page *page);
2777
2778 const struct cl_page_slice *cl_page_at(const struct cl_page *page,
2779                                        const struct lu_device_type *dtype);
2780
2781 /**
2782  * \name ownership
2783  *
2784  * Functions dealing with the ownership of page by io.
2785  */
2786 /** @{ */
2787
2788 int  cl_page_own        (const struct lu_env *env,
2789                          struct cl_io *io, struct cl_page *page);
2790 int  cl_page_own_try    (const struct lu_env *env,
2791                          struct cl_io *io, struct cl_page *page);
2792 void cl_page_assume     (const struct lu_env *env,
2793                          struct cl_io *io, struct cl_page *page);
2794 void cl_page_unassume   (const struct lu_env *env,
2795                          struct cl_io *io, struct cl_page *pg);
2796 void cl_page_disown     (const struct lu_env *env,
2797                          struct cl_io *io, struct cl_page *page);
2798 int  cl_page_is_owned   (const struct cl_page *pg, const struct cl_io *io);
2799
2800 /** @} ownership */
2801
2802 /**
2803  * \name transfer
2804  *
2805  * Functions dealing with the preparation of a page for a transfer, and
2806  * tracking transfer state.
2807  */
2808 /** @{ */
2809 int  cl_page_prep       (const struct lu_env *env, struct cl_io *io,
2810                          struct cl_page *pg, enum cl_req_type crt);
2811 void cl_page_completion (const struct lu_env *env,
2812                          struct cl_page *pg, enum cl_req_type crt, int ioret);
2813 int  cl_page_make_ready (const struct lu_env *env, struct cl_page *pg,
2814                          enum cl_req_type crt);
2815 int  cl_page_cache_add  (const struct lu_env *env, struct cl_io *io,
2816                          struct cl_page *pg, enum cl_req_type crt);
2817 void cl_page_clip       (const struct lu_env *env, struct cl_page *pg,
2818                          int from, int to);
2819 int  cl_page_cancel     (const struct lu_env *env, struct cl_page *page);
2820 int  cl_page_flush      (const struct lu_env *env, struct cl_io *io,
2821                          struct cl_page *pg);
2822
2823 /** @} transfer */
2824
2825
2826 /**
2827  * \name helper routines
2828  * Functions to discard, delete and export a cl_page.
2829  */
2830 /** @{ */
2831 void    cl_page_discard      (const struct lu_env *env, struct cl_io *io,
2832                               struct cl_page *pg);
2833 void    cl_page_delete       (const struct lu_env *env, struct cl_page *pg);
2834 int     cl_page_unmap        (const struct lu_env *env, struct cl_io *io,
2835                               struct cl_page *pg);
2836 int     cl_page_is_vmlocked  (const struct lu_env *env,
2837                               const struct cl_page *pg);
2838 void    cl_page_export       (const struct lu_env *env,
2839                               struct cl_page *pg, int uptodate);
2840 int     cl_page_is_under_lock(const struct lu_env *env, struct cl_io *io,
2841                               struct cl_page *page);
2842 loff_t  cl_offset            (const struct cl_object *obj, pgoff_t idx);
2843 pgoff_t cl_index             (const struct cl_object *obj, loff_t offset);
2844 int     cl_page_size         (const struct cl_object *obj);
2845 int     cl_pages_prune       (const struct lu_env *env, struct cl_object *obj);
2846
2847 void cl_lock_print      (const struct lu_env *env, void *cookie,
2848                          lu_printer_t printer, const struct cl_lock *lock);
2849 void cl_lock_descr_print(const struct lu_env *env, void *cookie,
2850                          lu_printer_t printer,
2851                          const struct cl_lock_descr *descr);
2852 /* @} helper */
2853
2854 /** @} cl_page */
2855
2856 /** \defgroup cl_lock cl_lock
2857  * @{ */
2858
2859 struct cl_lock *cl_lock_hold(const struct lu_env *env, const struct cl_io *io,
2860                              const struct cl_lock_descr *need,
2861                              const char *scope, const void *source);
2862 struct cl_lock *cl_lock_peek(const struct lu_env *env, const struct cl_io *io,
2863                              const struct cl_lock_descr *need,
2864                              const char *scope, const void *source);
2865 struct cl_lock *cl_lock_request(const struct lu_env *env, struct cl_io *io,
2866                                 const struct cl_lock_descr *need,
2867                                 const char *scope, const void *source);
2868 struct cl_lock *cl_lock_at_pgoff(const struct lu_env *env,
2869                                  struct cl_object *obj, pgoff_t index,
2870                                  struct cl_lock *except, int pending,
2871                                  int canceld);
2872 static inline struct cl_lock *cl_lock_at_page(const struct lu_env *env,
2873                                               struct cl_object *obj,
2874                                               struct cl_page *page,
2875                                               struct cl_lock *except,
2876                                               int pending, int canceld)
2877 {
2878         return cl_lock_at_pgoff(env, obj, page->cp_index, except,
2879                                 pending, canceld);
2880 }
2881
2882 const struct cl_lock_slice *cl_lock_at(const struct cl_lock *lock,
2883                                        const struct lu_device_type *dtype);
2884
2885 void  cl_lock_get       (struct cl_lock *lock);
2886 void  cl_lock_get_trust (struct cl_lock *lock);
2887 void  cl_lock_put       (const struct lu_env *env, struct cl_lock *lock);
2888 void  cl_lock_hold_add  (const struct lu_env *env, struct cl_lock *lock,
2889                          const char *scope, const void *source);
2890 void cl_lock_hold_release(const struct lu_env *env, struct cl_lock *lock,
2891                           const char *scope, const void *source);
2892 void  cl_lock_unhold    (const struct lu_env *env, struct cl_lock *lock,
2893                          const char *scope, const void *source);
2894 void  cl_lock_release   (const struct lu_env *env, struct cl_lock *lock,
2895                          const char *scope, const void *source);
2896 void  cl_lock_user_add  (const struct lu_env *env, struct cl_lock *lock);
2897 void  cl_lock_user_del  (const struct lu_env *env, struct cl_lock *lock);
2898
2899 enum cl_lock_state cl_lock_intransit(const struct lu_env *env,
2900                                      struct cl_lock *lock);
2901 void cl_lock_extransit(const struct lu_env *env, struct cl_lock *lock,
2902                        enum cl_lock_state state);
2903 int cl_lock_is_intransit(struct cl_lock *lock);
2904
2905 int cl_lock_enqueue_wait(const struct lu_env *env, struct cl_lock *lock,
2906                          int keep_mutex);
2907
2908 /** \name statemachine statemachine
2909  * Interface to lock state machine consists of 3 parts:
2910  *
2911  *     - "try" functions that attempt to effect a state transition. If state
2912  *     transition is not possible right now (e.g., if it has to wait for some
2913  *     asynchronous event to occur), these functions return
2914  *     cl_lock_transition::CLO_WAIT.
2915  *
2916  *     - "non-try" functions that implement synchronous blocking interface on
2917  *     top of non-blocking "try" functions. These functions repeatedly call
2918  *     corresponding "try" versions, and if state transition is not possible
2919  *     immediately, wait for lock state change.
2920  *
2921  *     - methods from cl_lock_operations, called by "try" functions. Lock can
2922  *     be advanced to the target state only when all layers voted that they
2923  *     are ready for this transition. "Try" functions call methods under lock
2924  *     mutex. If a layer had to release a mutex, it re-acquires it and returns
2925  *     cl_lock_transition::CLO_REPEAT, causing "try" function to call all
2926  *     layers again.
2927  *
2928  * TRY              NON-TRY      METHOD                            FINAL STATE
2929  *
2930  * cl_enqueue_try() cl_enqueue() cl_lock_operations::clo_enqueue() CLS_ENQUEUED
2931  *
2932  * cl_wait_try()    cl_wait()    cl_lock_operations::clo_wait()    CLS_HELD
2933  *
2934  * cl_unuse_try()   cl_unuse()   cl_lock_operations::clo_unuse()   CLS_CACHED
2935  *
2936  * cl_use_try()     NONE         cl_lock_operations::clo_use()     CLS_HELD
2937  *
2938  * @{ */
2939
2940 int   cl_enqueue    (const struct lu_env *env, struct cl_lock *lock,
2941                      struct cl_io *io, __u32 flags);
2942 int   cl_wait       (const struct lu_env *env, struct cl_lock *lock);
2943 void  cl_unuse      (const struct lu_env *env, struct cl_lock *lock);
2944 int   cl_enqueue_try(const struct lu_env *env, struct cl_lock *lock,
2945                      struct cl_io *io, __u32 flags);
2946 int   cl_unuse_try  (const struct lu_env *env, struct cl_lock *lock);
2947 int   cl_wait_try   (const struct lu_env *env, struct cl_lock *lock);
2948 int   cl_use_try    (const struct lu_env *env, struct cl_lock *lock, int atomic);
2949
2950 /** @} statemachine */
2951
2952 void cl_lock_signal      (const struct lu_env *env, struct cl_lock *lock);
2953 int  cl_lock_state_wait  (const struct lu_env *env, struct cl_lock *lock);
2954 void cl_lock_state_set   (const struct lu_env *env, struct cl_lock *lock,
2955                           enum cl_lock_state state);
2956 int  cl_queue_match      (const cfs_list_t *queue,
2957                           const struct cl_lock_descr *need);
2958
2959 void cl_lock_mutex_get  (const struct lu_env *env, struct cl_lock *lock);
2960 int  cl_lock_mutex_try  (const struct lu_env *env, struct cl_lock *lock);
2961 void cl_lock_mutex_put  (const struct lu_env *env, struct cl_lock *lock);
2962 int  cl_lock_is_mutexed (struct cl_lock *lock);
2963 int  cl_lock_nr_mutexed (const struct lu_env *env);
2964 int  cl_lock_discard_pages(const struct lu_env *env, struct cl_lock *lock);
2965 int  cl_lock_ext_match  (const struct cl_lock_descr *has,
2966                          const struct cl_lock_descr *need);
2967 int  cl_lock_descr_match(const struct cl_lock_descr *has,
2968                          const struct cl_lock_descr *need);
2969 int  cl_lock_mode_match (enum cl_lock_mode has, enum cl_lock_mode need);
2970 int  cl_lock_modify     (const struct lu_env *env, struct cl_lock *lock,
2971                          const struct cl_lock_descr *desc);
2972
2973 void cl_lock_closure_init (const struct lu_env *env,
2974                            struct cl_lock_closure *closure,
2975                            struct cl_lock *origin, int wait);
2976 void cl_lock_closure_fini (struct cl_lock_closure *closure);
2977 int  cl_lock_closure_build(const struct lu_env *env, struct cl_lock *lock,
2978                            struct cl_lock_closure *closure);
2979 void cl_lock_disclosure   (const struct lu_env *env,
2980                            struct cl_lock_closure *closure);
2981 int  cl_lock_enclosure    (const struct lu_env *env, struct cl_lock *lock,
2982                            struct cl_lock_closure *closure);
2983
2984 void cl_lock_cancel(const struct lu_env *env, struct cl_lock *lock);
2985 void cl_lock_delete(const struct lu_env *env, struct cl_lock *lock);
2986 void cl_lock_error (const struct lu_env *env, struct cl_lock *lock, int error);
2987 void cl_locks_prune(const struct lu_env *env, struct cl_object *obj, int wait);
2988
2989 unsigned long cl_lock_weigh(const struct lu_env *env, struct cl_lock *lock);
2990
2991 /** @} cl_lock */
2992
2993 /** \defgroup cl_io cl_io
2994  * @{ */
2995
2996 int   cl_io_init         (const struct lu_env *env, struct cl_io *io,
2997                           enum cl_io_type iot, struct cl_object *obj);
2998 int   cl_io_sub_init     (const struct lu_env *env, struct cl_io *io,
2999                           enum cl_io_type iot, struct cl_object *obj);
3000 int   cl_io_rw_init      (const struct lu_env *env, struct cl_io *io,
3001                           enum cl_io_type iot, loff_t pos, size_t count);
3002 int   cl_io_loop         (const struct lu_env *env, struct cl_io *io);
3003
3004 void  cl_io_fini         (const struct lu_env *env, struct cl_io *io);
3005 int   cl_io_iter_init    (const struct lu_env *env, struct cl_io *io);
3006 void  cl_io_iter_fini    (const struct lu_env *env, struct cl_io *io);
3007 int   cl_io_lock         (const struct lu_env *env, struct cl_io *io);
3008 void  cl_io_unlock       (const struct lu_env *env, struct cl_io *io);
3009 int   cl_io_start        (const struct lu_env *env, struct cl_io *io);
3010 void  cl_io_end          (const struct lu_env *env, struct cl_io *io);
3011 int   cl_io_lock_add     (const struct lu_env *env, struct cl_io *io,
3012                           struct cl_io_lock_link *link);
3013 int   cl_io_lock_alloc_add(const struct lu_env *env, struct cl_io *io,
3014                            struct cl_lock_descr *descr);
3015 int   cl_io_read_page    (const struct lu_env *env, struct cl_io *io,
3016                           struct cl_page *page);
3017 int   cl_io_prepare_write(const struct lu_env *env, struct cl_io *io,
3018                           struct cl_page *page, unsigned from, unsigned to);
3019 int   cl_io_commit_write (const struct lu_env *env, struct cl_io *io,
3020                           struct cl_page *page, unsigned from, unsigned to);
3021 int   cl_io_submit_rw    (const struct lu_env *env, struct cl_io *io,
3022                           enum cl_req_type iot, struct cl_2queue *queue);
3023 int   cl_io_submit_sync  (const struct lu_env *env, struct cl_io *io,
3024                           enum cl_req_type iot, struct cl_2queue *queue,
3025                           long timeout);
3026 void  cl_io_rw_advance   (const struct lu_env *env, struct cl_io *io,
3027                           size_t nob);
3028 int   cl_io_cancel       (const struct lu_env *env, struct cl_io *io,
3029                           struct cl_page_list *queue);
3030 int   cl_io_is_going     (const struct lu_env *env);
3031
3032 /**
3033  * True, iff \a io is an O_APPEND write(2).
3034  */
3035 static inline int cl_io_is_append(const struct cl_io *io)
3036 {
3037         return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_append;
3038 }
3039
3040 static inline int cl_io_is_sync_write(const struct cl_io *io)
3041 {
3042         return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_sync;
3043 }
3044
3045 static inline int cl_io_is_mkwrite(const struct cl_io *io)
3046 {
3047         return io->ci_type == CIT_FAULT && io->u.ci_fault.ft_mkwrite;
3048 }
3049
3050 /**
3051  * True, iff \a io is a truncate(2).
3052  */
3053 static inline int cl_io_is_trunc(const struct cl_io *io)
3054 {
3055         return io->ci_type == CIT_SETATTR &&
3056                 (io->u.ci_setattr.sa_valid & ATTR_SIZE);
3057 }
3058
3059 struct cl_io *cl_io_top(struct cl_io *io);
3060
3061 void cl_io_print(const struct lu_env *env, void *cookie,
3062                  lu_printer_t printer, const struct cl_io *io);
3063
3064 #define CL_IO_SLICE_CLEAN(foo_io, base)                                 \
3065 do {                                                                    \
3066         typeof(foo_io) __foo_io = (foo_io);                             \
3067                                                                         \
3068         CLASSERT(offsetof(typeof(*__foo_io), base) == 0);               \
3069         memset(&__foo_io->base + 1, 0,                                  \
3070                (sizeof *__foo_io) - sizeof __foo_io->base);             \
3071 } while (0)
3072
3073 /** @} cl_io */
3074
3075 /** \defgroup cl_page_list cl_page_list
3076  * @{ */
3077
3078 /**
3079  * Last page in the page list.
3080  */
3081 static inline struct cl_page *cl_page_list_last(struct cl_page_list *plist)
3082 {
3083         LASSERT(plist->pl_nr > 0);
3084         return cfs_list_entry(plist->pl_pages.prev, struct cl_page, cp_batch);
3085 }
3086
3087 /**
3088  * Iterate over pages in a page list.
3089  */
3090 #define cl_page_list_for_each(page, list)                               \
3091         cfs_list_for_each_entry((page), &(list)->pl_pages, cp_batch)
3092
3093 /**
3094  * Iterate over pages in a page list, taking possible removals into account.
3095  */
3096 #define cl_page_list_for_each_safe(page, temp, list)                    \
3097         cfs_list_for_each_entry_safe((page), (temp), &(list)->pl_pages, cp_batch)
3098
3099 void cl_page_list_init   (struct cl_page_list *plist);
3100 void cl_page_list_add    (struct cl_page_list *plist, struct cl_page *page);
3101 void cl_page_list_move   (struct cl_page_list *dst, struct cl_page_list *src,
3102                           struct cl_page *page);
3103 void cl_page_list_splice (struct cl_page_list *list,
3104                           struct cl_page_list *head);
3105 void cl_page_list_del    (const struct lu_env *env,
3106                           struct cl_page_list *plist, struct cl_page *page);
3107 void cl_page_list_disown (const struct lu_env *env,
3108                           struct cl_io *io, struct cl_page_list *plist);
3109 int  cl_page_list_own    (const struct lu_env *env,
3110                           struct cl_io *io, struct cl_page_list *plist);
3111 void cl_page_list_assume (const struct lu_env *env,
3112                           struct cl_io *io, struct cl_page_list *plist);
3113 void cl_page_list_discard(const struct lu_env *env,
3114                           struct cl_io *io, struct cl_page_list *plist);
3115 int  cl_page_list_unmap  (const struct lu_env *env,
3116                           struct cl_io *io, struct cl_page_list *plist);
3117 void cl_page_list_fini   (const struct lu_env *env, struct cl_page_list *plist);
3118
3119 void cl_2queue_init     (struct cl_2queue *queue);
3120 void cl_2queue_add      (struct cl_2queue *queue, struct cl_page *page);
3121 void cl_2queue_disown   (const struct lu_env *env,
3122                          struct cl_io *io, struct cl_2queue *queue);
3123 void cl_2queue_assume   (const struct lu_env *env,
3124                          struct cl_io *io, struct cl_2queue *queue);
3125 void cl_2queue_discard  (const struct lu_env *env,
3126                          struct cl_io *io, struct cl_2queue *queue);
3127 void cl_2queue_fini     (const struct lu_env *env, struct cl_2queue *queue);
3128 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page);
3129
3130 /** @} cl_page_list */
3131
3132 /** \defgroup cl_req cl_req
3133  * @{ */
3134 struct cl_req *cl_req_alloc(const struct lu_env *env, struct cl_page *page,
3135                             enum cl_req_type crt, int nr_objects);
3136
3137 void cl_req_page_add  (const struct lu_env *env, struct cl_req *req,
3138                        struct cl_page *page);
3139 void cl_req_page_done (const struct lu_env *env, struct cl_page *page);
3140 int  cl_req_prep      (const struct lu_env *env, struct cl_req *req);
3141 void cl_req_attr_set  (const struct lu_env *env, struct cl_req *req,
3142                        struct cl_req_attr *attr, obd_valid flags);
3143 void cl_req_completion(const struct lu_env *env, struct cl_req *req, int ioret);
3144
3145 /** \defgroup cl_sync_io cl_sync_io
3146  * @{ */
3147
3148 /**
3149  * Anchor for synchronous transfer. This is allocated on a stack by thread
3150  * doing synchronous transfer, and a pointer to this structure is set up in
3151  * every page submitted for transfer. Transfer completion routine updates
3152  * anchor and wakes up waiting thread when transfer is complete.
3153  */
3154 struct cl_sync_io {
3155         /** number of pages yet to be transferred. */
3156         cfs_atomic_t          csi_sync_nr;
3157         /** completion to be signaled when transfer is complete. */
3158         cfs_waitq_t          csi_waitq;
3159         /** error code. */
3160         int                   csi_sync_rc;
3161 };
3162
3163 void cl_sync_io_init(struct cl_sync_io *anchor, int nrpages);
3164 int  cl_sync_io_wait(const struct lu_env *env, struct cl_io *io,
3165                      struct cl_page_list *queue, struct cl_sync_io *anchor,
3166                      long timeout);
3167 void cl_sync_io_note(struct cl_sync_io *anchor, int ioret);
3168
3169 /** @} cl_sync_io */
3170
3171 /** @} cl_req */
3172
3173 /** \defgroup cl_env cl_env
3174  *
3175  * lu_env handling for a client.
3176  *
3177  * lu_env is an environment within which lustre code executes. Its major part
3178  * is lu_context---a fast memory allocation mechanism that is used to conserve
3179  * precious kernel stack space. Originally lu_env was designed for a server,
3180  * where
3181  *
3182  *     - there is a (mostly) fixed number of threads, and
3183  *
3184  *     - call chains have no non-lustre portions inserted between lustre code.
3185  *
3186  * On a client both these assumtpion fails, because every user thread can
3187  * potentially execute lustre code as part of a system call, and lustre calls
3188  * into VFS or MM that call back into lustre.
3189  *
3190  * To deal with that, cl_env wrapper functions implement the following
3191  * optimizations:
3192  *
3193  *     - allocation and destruction of environment is amortized by caching no
3194  *     longer used environments instead of destroying them;
3195  *
3196  *     - there is a notion of "current" environment, attached to the kernel
3197  *     data structure representing current thread Top-level lustre code
3198  *     allocates an environment and makes it current, then calls into