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