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