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