1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 #ifndef _LUSTRE_CL_OBJECT_H
37 #define _LUSTRE_CL_OBJECT_H
39 /** \defgroup clio clio
41 * Client objects implement io operations and cache pages.
43 * Examples: lov and osc are implementations of cl interface.
45 * Big Theory Statement.
49 * Client implementation is based on the following data-types:
55 * - cl_lock represents an extent lock on an object.
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).
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.
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"
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.
84 * - cl_object_header::coh_page_guard
85 * - cl_object_header::coh_lock_guard
88 * See the top comment in cl_object.c for the description of overall locking and
89 * reference-counting design.
91 * See comments below for the description of i/o, page, and dlm-locking
98 * super-class definitions.
100 #include <lu_object.h>
103 # include <linux/mutex.h>
104 # include <linux/radix-tree.h>
110 struct cl_device_operations;
113 struct cl_object_page_operations;
114 struct cl_object_lock_operations;
117 struct cl_page_slice;
119 struct cl_lock_slice;
121 struct cl_lock_operations;
122 struct cl_page_operations;
131 * Operations for each data device in the client stack.
133 * \see vvp_cl_ops, lov_cl_ops, lovsub_cl_ops, osc_cl_ops
135 struct cl_device_operations {
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().
142 * \see osc_req_init(), lov_req_init(), lovsub_req_init()
143 * \see ccc_req_init()
145 int (*cdo_req_init)(const struct lu_env *env, struct cl_device *dev,
150 * Device in the client stack.
152 * \see ccc_device, lov_device, lovsub_device, osc_device
156 struct lu_device cd_lu_dev;
157 /** Per-layer operation vector. */
158 const struct cl_device_operations *cd_ops;
161 /** \addtogroup cl_object cl_object
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.
169 /** Object size, in bytes */
172 * Known minimal size, in bytes.
174 * This is only valid when at least one DLM lock is held.
177 /** Modification time. Measured in seconds since epoch. */
179 /** Access time. Measured in seconds since epoch. */
181 /** Change time. Measured in seconds since epoch. */
184 * Blocks allocated to this cl_object on the server file system.
186 * \todo XXX An interface for block size is needed.
190 * User identifier for quota purposes.
194 * Group identifier for quota purposes.
200 * Fields in cl_attr that are being set.
214 * Sub-class of lu_object with methods common for objects on the client
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
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
235 * whereas its sub-objects are composed of
240 * layers. Here "lovsub" is a mostly dummy layer, whose purpose is to keep
241 * track of the object-subobject relationship.
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
247 * \see ccc_object, lov_object, lovsub_object, osc_object
251 struct lu_object co_lu;
252 /** per-object-layer operations */
253 const struct cl_object_operations *co_ops;
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
261 struct cl_object_conf {
263 struct lu_object_conf coc_lu;
266 * Object layout. This is consumed by lov.
268 struct lustre_md *coc_md;
270 * Description of particular stripe location in the
271 * cluster. This is consumed by osc.
273 struct lov_oinfo *coc_oinfo;
276 * VFS inode. This is consumed by vvp.
278 struct inode *coc_inode;
282 * Operations implemented for each cl object layer.
284 * \see vvp_ops, lov_ops, lovsub_ops, osc_ops
286 struct cl_object_operations {
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
295 * \retval NULL success.
297 * \retval ERR_PTR(errno) failure code.
299 * \retval valid-pointer pointer to already existing referenced page
300 * to be used instead of newly created.
302 struct cl_page *(*coo_page_init)(const struct lu_env *env,
303 struct cl_object *obj,
304 struct cl_page *page,
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.
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);
317 * Initialize io state for a given layer.
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.
325 int (*coo_io_init)(const struct lu_env *env,
326 struct cl_object *obj, struct cl_io *io);
328 * Fill portion of \a attr that this layer controls. This method is
329 * called top-to-bottom through all object layers.
331 * \pre cl_object_header::coh_attr_guard of the top-object is locked.
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
338 int (*coo_attr_get)(const struct lu_env *env, struct cl_object *obj,
339 struct cl_attr *attr);
343 * \a valid is a bitmask composed from enum #cl_attr_valid, and
344 * indicating what attributes are to be set.
346 * \pre cl_object_header::coh_attr_guard of the top-object is locked.
348 * \return the same convention as for
349 * cl_object_operations::coo_attr_get() is used.
351 int (*coo_attr_set)(const struct lu_env *env, struct cl_object *obj,
352 const struct cl_attr *attr, unsigned valid);
354 * Update object configuration. Called top-to-bottom to modify object
357 * XXX error conditions and handling.
359 int (*coo_conf_set)(const struct lu_env *env, struct cl_object *obj,
360 const struct cl_object_conf *conf);
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.
366 * \see ccc_object_glimpse(), lovsub_object_glimpse(),
367 * \see osc_object_glimpse()
369 int (*coo_glimpse)(const struct lu_env *env,
370 const struct cl_object *obj, struct ost_lvb *lvb);
374 * Extended header for client object.
376 struct cl_object_header {
377 /** Standard lu_object_header. cl_object::co_lu::lo_header points
379 struct lu_object_header coh_lu;
381 * \todo XXX move locks below to the separate cache-lines, they are
382 * mostly useless otherwise.
385 /** Lock protecting page tree. */
386 spinlock_t coh_page_guard;
387 /** Lock protecting lock list. */
388 spinlock_t coh_lock_guard;
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;
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.
404 struct cl_object_header *coh_parent;
406 * Protects consistency between cl_attr of parent object and
407 * attributes of sub-objects, that the former is calculated ("merged")
410 * \todo XXX this can be read/write lock if needed.
412 spinlock_t coh_attr_guard;
414 * Number of objects above this one: 0 for a top-object, 1 for its
417 unsigned coh_nesting;
421 * Helper macro: iterate over all layers of the object \a obj, assigning every
422 * layer top-to-bottom to \a slice.
424 #define cl_object_for_each(slice, obj) \
425 list_for_each_entry((slice), \
426 &(obj)->co_lu.lo_header->loh_layers, \
429 * Helper macro: iterate over all layers of the object \a obj, assigning every
430 * layer bottom-to-top to \a slice.
432 #define cl_object_for_each_reverse(slice, obj) \
433 list_for_each_entry_reverse((slice), \
434 &(obj)->co_lu.lo_header->loh_layers, \
439 #define pgoff_t unsigned long
442 #define CL_PAGE_EOF ((pgoff_t)~0ull)
444 /** \addtogroup cl_page cl_page
448 * Layered client page.
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.
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
464 * - intercepts per-VM-page call-backs made by the environment (e.g.,
467 * - translates state (page flag bits) and locking between lustre and
470 * The association between cl_page and cfs_page_t is immutable and
471 * established when cl_page is created.
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.
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:
491 * - client code explicitly and voluntary owns the page (cl_page_own());
493 * - VM locks a page and then calls the client, that has "to assume"
494 * the ownership from the VM (cl_page_assume()).
496 * Dual methods to release ownership are cl_page_disown() and
497 * cl_page_unassume().
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
504 * The general logic guaranteeing the absence of "existential races" for
505 * pages is the following:
507 * - there are fixed known ways for a thread to obtain a new reference
510 * - by doing a lookup in the cl_object radix tree, protected by the
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();
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());
521 * - entry into cl_page_state::CPS_FREEING is serialized by the VM page
524 * - no new references to the page in cl_page_state::CPS_FREEING state
525 * are allowed (checked in cl_page_get()).
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
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
538 * Linux Kernel implementation.
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).
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
552 * \warning *THIS IS NOT* the behavior expected by the Linux kernel, where
553 * write-out is "protected" by the special PG_writeback bit.
557 * States of cl_page. cl_page.c assumes particular order here.
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.
568 * Page is in the cache, un-owned. Page leaves cached state in the
571 * - [cl_page_state::CPS_OWNED] io comes across the page and
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;
578 * - [cl_page_state::CPS_FREEING] VM callback is executed to
579 * evict the page form the memory;
581 * \invariant cl_page::cp_owner == NULL && cl_page::cp_req == NULL
585 * Page is exclusively owned by some cl_io. Page may end up in this
586 * state as a result of
588 * - io creating new page and immediately owning it;
590 * - [cl_page_state::CPS_CACHED] io finding existing cached page
593 * - [cl_page_state::CPS_OWNED] io finding existing owned page
594 * and waiting for owner to release the page;
596 * Page leaves owned state in the following cases:
598 * - [cl_page_state::CPS_CACHED] io decides to leave the page in
599 * the cache, doing nothing;
601 * - [cl_page_state::CPS_PAGEIN] io starts read transfer for
604 * - [cl_page_state::CPS_PAGEOUT] io starts immediate write
605 * transfer for this page;
607 * - [cl_page_state::CPS_FREEING] io decides to destroy this
608 * page (e.g., as part of truncate or extent lock cancellation).
610 * \invariant cl_page::cp_owner != NULL && cl_page::cp_req == NULL
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
626 * - [cl_page_state::CPS_OWNED] an io requesting an immediate
627 * write-out of this page, or
629 * - [cl_page_state::CPS_CACHED] req-forming engine deciding
630 * that it has enough dirty pages cached to issue a "good"
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.
636 * Underlying VM page is locked for the duration of transfer.
638 * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req != NULL
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,
648 * Underlying VM page is locked for the duration of transfer.
650 * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req != NULL
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
658 * Once this state is reached, there is no way to escape it.
660 * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req == NULL
667 /** Host page, the page is from the host inode which the cl_page
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. */
678 * Flags maintained for every cl_page.
682 * Set when pagein completes. Used for debugging (read completes at
683 * most once for a page).
685 CPF_READ_COMPLETED = 1 << 0
689 * Fields are protected by the lock on cfs_page_t, except for atomics and
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).
698 /** Reference counter. */
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. */
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
710 struct cl_page *cp_child;
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.
715 const enum cl_page_state cp_state;
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. */
728 * Page type. Only CPT_TRANSIENT is used so far. Immutable after
731 enum cl_page_type cp_type;
734 * Owning IO in cl_page_state::CPS_OWNED state. Sub-page can be owned
735 * by sub-io. Protected by a VM lock.
737 struct cl_io *cp_owner;
739 * Owning IO request in cl_page_state::CPS_PAGEOUT and
740 * cl_page_state::CPS_PAGEIN states. This field is maintained only in
741 * the top-level pages. Protected by a VM lock.
743 struct cl_req *cp_req;
744 /** List of references to this page, for debugging. */
745 struct lu_ref cp_reference;
746 /** Link to an object, for debugging. */
747 struct lu_ref_link *cp_obj_ref;
748 /** Link to a queue, for debugging. */
749 struct lu_ref_link *cp_queue_ref;
750 /** Per-page flags from enum cl_page_flags. Protected by a VM lock. */
755 * Per-layer part of cl_page.
757 * \see ccc_page, lov_page, osc_page
759 struct cl_page_slice {
760 struct cl_page *cpl_page;
762 * Object slice corresponding to this page slice. Immutable after
765 struct cl_object *cpl_obj;
766 const struct cl_page_operations *cpl_ops;
767 /** Linkage into cl_page::cp_layers. Immutable after creation. */
768 struct list_head cpl_linkage;
772 * Lock mode. For the client extent locks.
774 * \warning: cl_lock_mode_match() assumes particular ordering here.
779 * Mode of a lock that protects no data, and exists only as a
780 * placeholder. This is used for `glimpse' requests. A phantom lock
781 * might get promoted to real lock at some point.
789 * Requested transfer type.
799 * Per-layer page operations.
801 * Methods taking an \a io argument are for the activity happening in the
802 * context of given \a io. Page is assumed to be owned by that io, except for
803 * the obvious cases (like cl_page_operations::cpo_own()).
805 * \see vvp_page_ops, lov_page_ops, osc_page_ops
807 struct cl_page_operations {
809 * cl_page<->cfs_page_t methods. Only one layer in the stack has to
810 * implement these. Current code assumes that this functionality is
811 * provided by the topmost layer, see cl_page_disown0() as an example.
815 * \return the underlying VM page. Optional.
817 cfs_page_t *(*cpo_vmpage)(const struct lu_env *env,
818 const struct cl_page_slice *slice);
820 * Called when \a io acquires this page into the exclusive
821 * ownership. When this method returns, it is guaranteed that the is
822 * not owned by other io, and no transfer is going on against
826 * \see vvp_page_own(), lov_page_own()
828 void (*cpo_own)(const struct lu_env *env,
829 const struct cl_page_slice *slice, struct cl_io *io);
830 /** Called when ownership it yielded. Optional.
832 * \see cl_page_disown()
833 * \see vvp_page_disown()
835 void (*cpo_disown)(const struct lu_env *env,
836 const struct cl_page_slice *slice, struct cl_io *io);
838 * Called for a page that is already "owned" by \a io from VM point of
841 * \see cl_page_assume()
842 * \see vvp_page_assume(), lov_page_assume()
844 void (*cpo_assume)(const struct lu_env *env,
845 const struct cl_page_slice *slice, struct cl_io *io);
846 /** Dual to cl_page_operations::cpo_assume(). Optional. Called
847 * bottom-to-top when IO releases a page without actually unlocking
850 * \see cl_page_unassume()
851 * \see vvp_page_unassume()
853 void (*cpo_unassume)(const struct lu_env *env,
854 const struct cl_page_slice *slice,
857 * Announces that page contains valid data and user space can look and
858 * them without client's involvement from now on. Effectively marks
859 * the page up-to-date. Optional.
861 * \see cl_page_export()
862 * \see vvp_page_export()
864 void (*cpo_export)(const struct lu_env *env,
865 const struct cl_page_slice *slice);
867 * Unmaps page from the user space (if it is mapped).
869 * \see cl_page_unmap()
870 * \see vvp_page_unmap()
872 int (*cpo_unmap)(const struct lu_env *env,
873 const struct cl_page_slice *slice, struct cl_io *io);
875 * Checks whether underlying VM page is locked (in the suitable
876 * sense). Used for assertions.
878 * \retval -EBUSY: page is protected by a lock of a given mode;
879 * \retval -ENODATA: page is not protected by a lock;
880 * \retval 0: this layer cannot decide. (Should never happen.)
882 int (*cpo_is_vmlocked)(const struct lu_env *env,
883 const struct cl_page_slice *slice);
889 * Called when page is truncated from the object. Optional.
891 * \see cl_page_discard()
892 * \see vvp_page_discard(), osc_page_discard()
894 void (*cpo_discard)(const struct lu_env *env,
895 const struct cl_page_slice *slice,
898 * Called when page is removed from the cache, and is about to being
899 * destroyed. Optional.
901 * \see cl_page_delete()
902 * \see vvp_page_delete(), osc_page_delete()
904 void (*cpo_delete)(const struct lu_env *env,
905 const struct cl_page_slice *slice);
906 /** Destructor. Frees resources and slice itself. */
907 void (*cpo_fini)(const struct lu_env *env,
908 struct cl_page_slice *slice);
911 * Checks whether the page is protected by a cl_lock. This is a
912 * per-layer method, because certain layers have ways to check for the
913 * lock much more efficiently than through the generic locks scan, or
914 * implement locking mechanisms separate from cl_lock, e.g.,
915 * LL_FILE_GROUP_LOCKED in vvp. If \a pending is true, check for locks
916 * being canceled, or scheduled for cancellation as soon as the last
917 * user goes away, too.
919 * \retval -EBUSY: page is protected by a lock of a given mode;
920 * \retval -ENODATA: page is not protected by a lock;
921 * \retval 0: this layer cannot decide.
923 * \see cl_page_is_under_lock()
925 int (*cpo_is_under_lock)(const struct lu_env *env,
926 const struct cl_page_slice *slice,
930 * Optional debugging helper. Prints given page slice.
932 * \see cl_page_print()
934 int (*cpo_print)(const struct lu_env *env,
935 const struct cl_page_slice *slice,
936 void *cookie, lu_printer_t p);
940 * Transfer methods. See comment on cl_req for a description of
941 * transfer formation and life-cycle.
946 * Request type dependent vector of operations.
948 * Transfer operations depend on transfer mode (cl_req_type). To avoid
949 * passing transfer mode to each and every of these methods, and to
950 * avoid branching on request type inside of the methods, separate
951 * methods for cl_req_type:CRT_READ and cl_req_type:CRT_WRITE are
952 * provided. That is, method invocation usually looks like
954 * slice->cp_ops.io[req->crq_type].cpo_method(env, slice, ...);
958 * Called when a page is submitted for a transfer as a part of
961 * \return 0 : page is eligible for submission;
962 * \return -EALREADY : skip this page;
963 * \return -ve : error.
965 * \see cl_page_prep()
967 int (*cpo_prep)(const struct lu_env *env,
968 const struct cl_page_slice *slice,
971 * Completion handler. This is guaranteed to be eventually
972 * fired after cl_page_operations::cpo_prep() or
973 * cl_page_operations::cpo_make_ready() call.
975 * This method can be called in a non-blocking context. It is
976 * guaranteed however, that the page involved and its object
977 * are pinned in memory (and, hence, calling cl_page_put() is
980 * \see cl_page_completion()
982 void (*cpo_completion)(const struct lu_env *env,
983 const struct cl_page_slice *slice,
986 * Called when cached page is about to be added to the
987 * cl_req as a part of req formation.
989 * \return 0 : proceed with this page;
990 * \return -EAGAIN : skip this page;
991 * \return -ve : error.
993 * \see cl_page_make_ready()
995 int (*cpo_make_ready)(const struct lu_env *env,
996 const struct cl_page_slice *slice);
998 * Announce that this page is to be written out
999 * opportunistically, that is, page is dirty, it is not
1000 * necessary to start write-out transfer right now, but
1001 * eventually page has to be written out.
1003 * Main caller of this is the write path (see
1004 * vvp_io_commit_write()), using this method to build a
1005 * "transfer cache" from which large transfers are then
1006 * constructed by the req-formation engine.
1008 * \todo XXX it would make sense to add page-age tracking
1009 * semantics here, and to oblige the req-formation engine to
1010 * send the page out not later than it is too old.
1012 * \see cl_page_cache_add()
1014 int (*cpo_cache_add)(const struct lu_env *env,
1015 const struct cl_page_slice *slice,
1019 * Tell transfer engine that only [to, from] part of a page should be
1022 * This is used for immediate transfers.
1024 * \todo XXX this is not very good interface. It would be much better
1025 * if all transfer parameters were supplied as arguments to
1026 * cl_io_operations::cio_submit() call, but it is not clear how to do
1027 * this for page queues.
1029 * \see cl_page_clip()
1031 void (*cpo_clip)(const struct lu_env *env,
1032 const struct cl_page_slice *slice,
1035 * \pre the page was queued for transferring.
1036 * \post page is removed from client's pending list, or -EBUSY
1037 * is returned if it has already been in transferring.
1039 * This is one of seldom page operation which is:
1040 * 0. called from top level;
1041 * 1. don't have vmpage locked;
1042 * 2. every layer should synchronize execution of its ->cpo_cancel()
1043 * with completion handlers. Osc uses client obd lock for this
1044 * purpose. Based on there is no vvp_page_cancel and
1045 * lov_page_cancel(), cpo_cancel is defacto protected by client lock.
1047 * \see osc_page_cancel().
1049 int (*cpo_cancel)(const struct lu_env *env,
1050 const struct cl_page_slice *slice);
1055 * Helper macro, dumping detailed information about \a page into a log.
1057 #define CL_PAGE_DEBUG(mask, env, page, format, ...) \
1059 static DECLARE_LU_CDEBUG_PRINT_INFO(__info, mask); \
1061 if (cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
1062 cl_page_print(env, &__info, lu_cdebug_printer, page); \
1063 CDEBUG(mask, format , ## __VA_ARGS__); \
1068 * Helper macro, dumping shorter information about \a page into a log.
1070 #define CL_PAGE_HEADER(mask, env, page, format, ...) \
1072 static DECLARE_LU_CDEBUG_PRINT_INFO(__info, mask); \
1074 if (cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
1075 cl_page_header_print(env, &__info, lu_cdebug_printer, page); \
1076 CDEBUG(mask, format , ## __VA_ARGS__); \
1082 /** \addtogroup cl_lock cl_lock
1086 * Extent locking on the client.
1090 * The locking model of the new client code is built around
1094 * data-type representing an extent lock on a regular file. cl_lock is a
1095 * layered object (much like cl_object and cl_page), it consists of a header
1096 * (struct cl_lock) and a list of layers (struct cl_lock_slice), linked to
1097 * cl_lock::cll_layers list through cl_lock_slice::cls_linkage.
1099 * All locks for a given object are linked into cl_object_header::coh_locks
1100 * list (protected by cl_object_header::coh_lock_guard spin-lock) through
1101 * cl_lock::cll_linkage. Currently this list is not sorted in any way. We can
1102 * sort it in starting lock offset, or use altogether different data structure
1105 * Typical cl_lock consists of the two layers:
1107 * - vvp_lock (vvp specific data), and
1108 * - lov_lock (lov specific data).
1110 * lov_lock contains an array of sub-locks. Each of these sub-locks is a
1111 * normal cl_lock: it has a header (struct cl_lock) and a list of layers:
1113 * - lovsub_lock, and
1116 * Each sub-lock is associated with a cl_object (representing stripe
1117 * sub-object or the file to which top-level cl_lock is associated to), and is
1118 * linked into that cl_object::coh_locks. In this respect cl_lock is similar to
1119 * cl_object (that at lov layer also fans out into multiple sub-objects), and
1120 * is different from cl_page, that doesn't fan out (there is usually exactly
1121 * one osc_page for every vvp_page). We shall call vvp-lov portion of the lock
1122 * a "top-lock" and its lovsub-osc portion a "sub-lock".
1126 * cl_lock is reference counted. When reference counter drops to 0, lock is
1127 * placed in the cache, except when lock is in CLS_FREEING state. CLS_FREEING
1128 * lock is destroyed when last reference is released. Referencing between
1129 * top-lock and its sub-locks is described in the lov documentation module.
1133 * Also, cl_lock is a state machine. This requires some clarification. One of
1134 * the goals of client IO re-write was to make IO path non-blocking, or at
1135 * least to make it easier to make it non-blocking in the future. Here
1136 * `non-blocking' means that when a system call (read, write, truncate)
1137 * reaches a situation where it has to wait for a communication with the
1138 * server, it should --instead of waiting-- remember its current state and
1139 * switch to some other work. E.g,. instead of waiting for a lock enqueue,
1140 * client should proceed doing IO on the next stripe, etc. Obviously this is
1141 * rather radical redesign, and it is not planned to be fully implemented at
1142 * this time, instead we are putting some infrastructure in place, that would
1143 * make it easier to do asynchronous non-blocking IO easier in the
1144 * future. Specifically, where old locking code goes to sleep (waiting for
1145 * enqueue, for example), new code returns cl_lock_transition::CLO_WAIT. When
1146 * enqueue reply comes, its completion handler signals that lock state-machine
1147 * is ready to transit to the next state. There is some generic code in
1148 * cl_lock.c that sleeps, waiting for these signals. As a result, for users of
1149 * this cl_lock.c code, it looks like locking is done in normal blocking
1150 * fashion, and it the same time it is possible to switch to the non-blocking
1151 * locking (simply by returning cl_lock_transition::CLO_WAIT from cl_lock.c
1154 * For a description of state machine states and transitions see enum
1157 * There are two ways to restrict a set of states which lock might move to:
1159 * - placing a "hold" on a lock guarantees that lock will not be moved
1160 * into cl_lock_state::CLS_FREEING state until hold is released. Hold
1161 * can be only acquired on a lock that is not in
1162 * cl_lock_state::CLS_FREEING. All holds on a lock are counted in
1163 * cl_lock::cll_holds. Hold protects lock from cancellation and
1164 * destruction. Requests to cancel and destroy a lock on hold will be
1165 * recorded, but only honored when last hold on a lock is released;
1167 * - placing a "user" on a lock guarantees that lock will not leave
1168 * cl_lock_state::CLS_NEW, cl_lock_state::CLS_QUEUING,
1169 * cl_lock_state::CLS_ENQUEUED and cl_lock_state::CLS_HELD set of
1170 * states, once it enters this set. That is, if a user is added onto a
1171 * lock in a state not from this set, it doesn't immediately enforce
1172 * lock to move to this set, but once lock enters this set it will
1173 * remain there until all users are removed. Lock users are counted in
1174 * cl_lock::cll_users.
1176 * User is used to assure that lock is not canceled or destroyed while
1177 * it is being enqueued, or actively used by some IO.
1179 * Currently, a user always comes with a hold (cl_lock_invariant()
1180 * checks that a number of holds is not less than a number of users).
1184 * This is how lock state-machine operates. struct cl_lock contains a mutex
1185 * cl_lock::cll_guard that protects struct fields.
1187 * - mutex is taken, and cl_lock::cll_state is examined.
1189 * - for every state there are possible target states where lock can move
1190 * into. They are tried in order. Attempts to move into next state are
1191 * done by _try() functions in cl_lock.c:cl_{enqueue,unlock,wait}_try().
1193 * - if the transition can be performed immediately, state is changed,
1194 * and mutex is released.
1196 * - if the transition requires blocking, _try() function returns
1197 * cl_lock_transition::CLO_WAIT. Caller unlocks mutex and goes to
1198 * sleep, waiting for possibility of lock state change. It is woken
1199 * up when some event occurs, that makes lock state change possible
1200 * (e.g., the reception of the reply from the server), and repeats
1203 * Top-lock and sub-lock has separate mutexes and the latter has to be taken
1204 * first to avoid dead-lock.
1206 * To see an example of interaction of all these issues, take a look at the
1207 * lov_cl.c:lov_lock_enqueue() function. It is called as a part of
1208 * cl_enqueue_try(), and tries to advance top-lock to ENQUEUED state, by
1209 * advancing state-machines of its sub-locks (lov_lock_enqueue_one()). Note
1210 * also, that it uses trylock to grab sub-lock mutex to avoid dead-lock. It
1211 * also has to handle CEF_ASYNC enqueue, when sub-locks enqueues have to be
1212 * done in parallel, rather than one after another (this is used for glimpse
1213 * locks, that cannot dead-lock).
1215 * INTERFACE AND USAGE
1217 * struct cl_lock_operations provide a number of call-backs that are invoked
1218 * when events of interest occurs. Layers can intercept and handle glimpse,
1219 * blocking, cancel ASTs and a reception of the reply from the server.
1221 * One important difference with the old client locking model is that new
1222 * client has a representation for the top-lock, whereas in the old code only
1223 * sub-locks existed as real data structures and file-level locks are
1224 * represented by "request sets" that are created and destroyed on each and
1225 * every lock creation.
1227 * Top-locks are cached, and can be found in the cache by the system calls. It
1228 * is possible that top-lock is in cache, but some of its sub-locks were
1229 * canceled and destroyed. In that case top-lock has to be enqueued again
1230 * before it can be used.
1232 * Overall process of the locking during IO operation is as following:
1234 * - once parameters for IO are setup in cl_io, cl_io_operations::cio_lock()
1235 * is called on each layer. Responsibility of this method is to add locks,
1236 * needed by a given layer into cl_io.ci_lockset.
1238 * - once locks for all layers were collected, they are sorted to avoid
1239 * dead-locks (cl_io_locks_sort()), and enqueued.
1241 * - when all locks are acquired, IO is performed;
1243 * - locks are released into cache.
1245 * Striping introduces major additional complexity into locking. The
1246 * fundamental problem is that it is generally unsafe to actively use (hold)
1247 * two locks on the different OST servers at the same time, as this introduces
1248 * inter-server dependency and can lead to cascading evictions.
1250 * Basic solution is to sub-divide large read/write IOs into smaller pieces so
1251 * that no multi-stripe locks are taken (note that this design abandons POSIX
1252 * read/write semantics). Such pieces ideally can be executed concurrently. At
1253 * the same time, certain types of IO cannot be sub-divived, without
1254 * sacrificing correctness. This includes:
1256 * - O_APPEND write, where [0, EOF] lock has to be taken, to guarantee
1259 * - ftruncate(fd, offset), where [offset, EOF] lock has to be taken.
1261 * Also, in the case of read(fd, buf, count) or write(fd, buf, count), where
1262 * buf is a part of memory mapped Lustre file, a lock or locks protecting buf
1263 * has to be held together with the usual lock on [offset, offset + count].
1265 * As multi-stripe locks have to be allowed, it makes sense to cache them, so
1266 * that, for example, a sequence of O_APPEND writes can proceed quickly
1267 * without going down to the individual stripes to do lock matching. On the
1268 * other hand, multi-stripe locks shouldn't be used by normal read/write
1269 * calls. To achieve this, every layer can implement ->clo_fits_into() method,
1270 * that is called by lock matching code (cl_lock_lookup()), and that can be
1271 * used to selectively disable matching of certain locks for certain IOs. For
1272 * exmaple, lov layer implements lov_lock_fits_into() that allow multi-stripe
1273 * locks to be matched only for truncates and O_APPEND writes.
1275 * Interaction with DLM
1277 * In the expected setup, cl_lock is ultimately backed up by a collection of
1278 * DLM locks (struct ldlm_lock). Association between cl_lock and DLM lock is
1279 * implemented in osc layer, that also matches DLM events (ASTs, cancellation,
1280 * etc.) into cl_lock_operation calls. See struct osc_lock for a more detailed
1281 * description of interaction with DLM.
1287 struct cl_lock_descr {
1288 /** Object this lock is granted for. */
1289 struct cl_object *cld_obj;
1290 /** Index of the first page protected by this lock. */
1292 /** Index of the last page (inclusive) protected by this lock. */
1295 enum cl_lock_mode cld_mode;
1298 #define DDESCR "%s(%d):[%lu, %lu]"
1299 #define PDESCR(descr) \
1300 cl_lock_mode_name((descr)->cld_mode), (descr)->cld_mode, \
1301 (descr)->cld_start, (descr)->cld_end
1303 const char *cl_lock_mode_name(const enum cl_lock_mode mode);
1306 * Lock state-machine states.
1311 * Possible state transitions:
1313 * +------------------>NEW
1315 * | | cl_enqueue_try()
1317 * | cl_unuse_try() V
1318 * | +--------------QUEUING (*)
1320 * | | | cl_enqueue_try()
1322 * | | cl_unuse_try() V
1323 * sub-lock | +-------------ENQUEUED (*)
1325 * | | | cl_wait_try()
1330 * | | HELD<---------+
1333 * | | cl_unuse_try() | |
1336 * | +------------>UNLOCKING (*) | lock found
1338 * | cl_unuse_try() | |
1340 * | | | cl_use_try()
1342 * +------------------CACHED---------+
1351 * In states marked with (*) transition to the same state (i.e., a loop
1352 * in the diagram) is possible.
1354 * (R) is the point where Receive call-back is invoked: it allows layers
1355 * to handle arrival of lock reply.
1357 * (C) is the point where Cancellation call-back is invoked.
1359 * Transition to FREEING state is possible from any other state in the
1360 * diagram in case of unrecoverable error.
1364 * These states are for individual cl_lock object. Top-lock and its sub-locks
1365 * can be in the different states. Another way to say this is that we have
1366 * nested state-machines.
1368 * Separate QUEUING and ENQUEUED states are needed to support non-blocking
1369 * operation for locks with multiple sub-locks. Imagine lock on a file F, that
1370 * intersects 3 stripes S0, S1, and S2. To enqueue F client has to send
1371 * enqueue to S0, wait for its completion, then send enqueue for S1, wait for
1372 * its completion and at last enqueue lock for S2, and wait for its
1373 * completion. In that case, top-lock is in QUEUING state while S0, S1 are
1374 * handled, and is in ENQUEUED state after enqueue to S2 has been sent (note
1375 * that in this case, sub-locks move from state to state, and top-lock remains
1376 * in the same state).
1378 * Separate UNLOCKING state is needed to maintain an invariant that in HELD
1379 * state lock is immediately ready for use.
1381 enum cl_lock_state {
1383 * Lock that wasn't yet enqueued
1387 * Enqueue is in progress, blocking for some intermediate interaction
1388 * with the other side.
1392 * Lock is fully enqueued, waiting for server to reply when it is
1397 * Lock granted, actively used by some IO.
1401 * Lock is in the transition from CLS_HELD to CLS_CACHED. Lock is in
1402 * this state only while cl_unuse() is executing against it.
1406 * Lock granted, not used.
1410 * Lock is being destroyed.
1416 enum cl_lock_flags {
1418 * lock has been cancelled. This flag is never cleared once set (by
1419 * cl_lock_cancel0()).
1421 CLF_CANCELLED = 1 << 0,
1422 /** cancellation is pending for this lock. */
1423 CLF_CANCELPEND = 1 << 1,
1424 /** destruction is pending for this lock. */
1425 CLF_DOOMED = 1 << 2,
1426 /** State update is pending. */
1433 * Lock closure is a collection of locks (both top-locks and sub-locks) that
1434 * might be updated in a result of an operation on a certain lock (which lock
1435 * this is a closure of).
1437 * Closures are needed to guarantee dead-lock freedom in the presence of
1439 * - nested state-machines (top-lock state-machine composed of sub-lock
1440 * state-machines), and
1442 * - shared sub-locks.
1444 * Specifically, many operations, such as lock enqueue, wait, unlock,
1445 * etc. start from a top-lock, and then operate on a sub-locks of this
1446 * top-lock, holding a top-lock mutex. When sub-lock state changes as a result
1447 * of such operation, this change has to be propagated to all top-locks that
1448 * share this sub-lock. Obviously, no natural lock ordering (e.g.,
1449 * top-to-bottom or bottom-to-top) captures this scenario, so try-locking has
1450 * to be used. Lock closure systematizes this try-and-repeat logic.
1452 struct cl_lock_closure {
1454 * Lock that is mutexed when closure construction is started. When
1455 * closure in is `wait' mode (cl_lock_closure::clc_wait), mutex on
1456 * origin is released before waiting.
1458 struct cl_lock *clc_origin;
1460 * List of enclosed locks, so far. Locks are linked here through
1461 * cl_lock::cll_inclosure.
1463 struct list_head clc_list;
1465 * True iff closure is in a `wait' mode. This determines what
1466 * cl_lock_enclosure() does when a lock L to be added to the closure
1467 * is currently mutexed by some other thread.
1469 * If cl_lock_closure::clc_wait is not set, then closure construction
1470 * fails with CLO_REPEAT immediately.
1472 * In wait mode, cl_lock_enclosure() waits until next attempt to build
1473 * a closure might succeed. To this end it releases an origin mutex
1474 * (cl_lock_closure::clc_origin), that has to be the only lock mutex
1475 * owned by the current thread, and then waits on L mutex (by grabbing
1476 * it and immediately releasing), before returning CLO_REPEAT to the
1480 /** Number of locks in the closure. */
1485 * Layered client lock.
1488 /** Reference counter. */
1490 /** List of slices. Immutable after creation. */
1491 struct list_head cll_layers;
1493 * Linkage into cl_lock::cll_descr::cld_obj::coh_locks list. Protected
1494 * by cl_lock::cll_descr::cld_obj::coh_lock_guard.
1496 struct list_head cll_linkage;
1498 * Parameters of this lock. Protected by
1499 * cl_lock::cll_descr::cld_obj::coh_lock_guard nested within
1500 * cl_lock::cll_guard. Modified only on lock creation and in
1503 struct cl_lock_descr cll_descr;
1504 /** Protected by cl_lock::cll_guard. */
1505 enum cl_lock_state cll_state;
1506 /** signals state changes. */
1509 * Recursive lock, most fields in cl_lock{} are protected by this.
1511 * Locking rules: this mutex is never held across network
1512 * communication, except when lock is being canceled.
1514 * Lock ordering: a mutex of a sub-lock is taken first, then a mutex
1515 * on a top-lock. Other direction is implemented through a
1516 * try-lock-repeat loop. Mutices of unrelated locks can be taken only
1519 * \see osc_lock_enqueue_wait(), lov_lock_cancel(), lov_sublock_wait().
1521 struct mutex cll_guard;
1522 cfs_task_t *cll_guarder;
1527 * Number of holds on a lock. A hold prevents a lock from being
1528 * canceled and destroyed. Protected by cl_lock::cll_guard.
1530 * \see cl_lock_hold(), cl_lock_unhold(), cl_lock_release()
1534 * Number of lock users. Valid in cl_lock_state::CLS_HELD state
1535 * only. Lock user pins lock in CLS_HELD state. Protected by
1536 * cl_lock::cll_guard.
1538 * \see cl_wait(), cl_unuse().
1542 * Flag bit-mask. Values from enum cl_lock_flags. Updates are
1543 * protected by cl_lock::cll_guard.
1545 unsigned long cll_flags;
1547 * A linkage into a list of locks in a closure.
1549 * \see cl_lock_closure
1551 struct list_head cll_inclosure;
1553 * A list of references to this lock, for debugging.
1555 struct lu_ref cll_reference;
1557 * A list of holds on this lock, for debugging.
1559 struct lu_ref cll_holders;
1561 * A reference for cl_lock::cll_descr::cld_obj. For debugging.
1563 struct lu_ref_link *cll_obj_ref;
1564 #ifdef CONFIG_LOCKDEP
1565 /* "dep_map" name is assumed by lockdep.h macros. */
1566 struct lockdep_map dep_map;
1571 * Per-layer part of cl_lock
1573 * \see ccc_lock, lov_lock, lovsub_lock, osc_lock
1575 struct cl_lock_slice {
1576 struct cl_lock *cls_lock;
1577 /** Object slice corresponding to this lock slice. Immutable after
1579 struct cl_object *cls_obj;
1580 const struct cl_lock_operations *cls_ops;
1581 /** Linkage into cl_lock::cll_layers. Immutable after creation. */
1582 struct list_head cls_linkage;
1586 * Possible (non-error) return values of ->clo_{enqueue,wait,unlock}().
1588 * NOTE: lov_subresult() depends on ordering here.
1590 enum cl_lock_transition {
1591 /** operation cannot be completed immediately. Wait for state change. */
1593 /** operation had to release lock mutex, restart. */
1599 * \see vvp_lock_ops, lov_lock_ops, lovsub_lock_ops, osc_lock_ops
1601 struct cl_lock_operations {
1603 * \name statemachine
1605 * State machine transitions. These 3 methods are called to transfer
1606 * lock from one state to another, as described in the commentary
1607 * above enum #cl_lock_state.
1609 * \retval 0 this layer has nothing more to do to before
1610 * transition to the target state happens;
1612 * \retval CLO_REPEAT method had to release and re-acquire cl_lock
1613 * mutex, repeat invocation of transition method
1614 * across all layers;
1616 * \retval CLO_WAIT this layer cannot move to the target state
1617 * immediately, as it has to wait for certain event
1618 * (e.g., the communication with the server). It
1619 * is guaranteed, that when the state transfer
1620 * becomes possible, cl_lock::cll_wq wait-queue
1621 * is signaled. Caller can wait for this event by
1622 * calling cl_lock_state_wait();
1624 * \retval -ve failure, abort state transition, move the lock
1625 * into cl_lock_state::CLS_FREEING state, and set
1626 * cl_lock::cll_error.
1628 * Once all layers voted to agree to transition (by returning 0), lock
1629 * is moved into corresponding target state. All state transition
1630 * methods are optional.
1634 * Attempts to enqueue the lock. Called top-to-bottom.
1636 * \see ccc_lock_enqueue(), lov_lock_enqueue(), lovsub_lock_enqueue(),
1637 * \see osc_lock_enqueue()
1639 int (*clo_enqueue)(const struct lu_env *env,
1640 const struct cl_lock_slice *slice,
1641 struct cl_io *io, __u32 enqflags);
1643 * Attempts to wait for enqueue result. Called top-to-bottom.
1645 * \see ccc_lock_wait(), lov_lock_wait(), osc_lock_wait()
1647 int (*clo_wait)(const struct lu_env *env,
1648 const struct cl_lock_slice *slice);
1650 * Attempts to unlock the lock. Called bottom-to-top. In addition to
1651 * usual return values of lock state-machine methods, this can return
1652 * -ESTALE to indicate that lock cannot be returned to the cache, and
1653 * has to be re-initialized.
1655 * \see ccc_lock_unlock(), lov_lock_unlock(), osc_lock_unlock()
1657 int (*clo_unuse)(const struct lu_env *env,
1658 const struct cl_lock_slice *slice);
1660 * Notifies layer that cached lock is started being used.
1662 * \pre lock->cll_state == CLS_CACHED
1664 * \see lov_lock_use(), osc_lock_use()
1666 int (*clo_use)(const struct lu_env *env,
1667 const struct cl_lock_slice *slice);
1668 /** @} statemachine */
1670 * A method invoked when lock state is changed (as a result of state
1671 * transition). This is used, for example, to track when the state of
1672 * a sub-lock changes, to propagate this change to the corresponding
1673 * top-lock. Optional
1675 * \see lovsub_lock_state()
1677 void (*clo_state)(const struct lu_env *env,
1678 const struct cl_lock_slice *slice,
1679 enum cl_lock_state st);
1681 * Returns true, iff given lock is suitable for the given io, idea
1682 * being, that there are certain "unsafe" locks, e.g., ones acquired
1683 * for O_APPEND writes, that we don't want to re-use for a normal
1684 * write, to avoid the danger of cascading evictions. Optional. Runs
1685 * under cl_object_header::coh_lock_guard.
1687 * XXX this should take more information about lock needed by
1688 * io. Probably lock description or something similar.
1690 * \see lov_fits_into()
1692 int (*clo_fits_into)(const struct lu_env *env,
1693 const struct cl_lock_slice *slice,
1694 const struct cl_lock_descr *need,
1695 const struct cl_io *io);
1698 * Asynchronous System Traps. All of then are optional, all are
1699 * executed bottom-to-top.
1704 * Cancellation callback. Cancel a lock voluntarily, or under
1705 * the request of server.
1707 void (*clo_cancel)(const struct lu_env *env,
1708 const struct cl_lock_slice *slice);
1710 * Lock weighting ast. Executed to estimate how precious this lock
1711 * is. The sum of results across all layers is used to determine
1712 * whether lock worth keeping in cache given present memory usage.
1714 * \see osc_lock_weigh(), vvp_lock_weigh(), lovsub_lock_weigh().
1716 unsigned long (*clo_weigh)(const struct lu_env *env,
1717 const struct cl_lock_slice *slice);
1721 * \see lovsub_lock_closure()
1723 int (*clo_closure)(const struct lu_env *env,
1724 const struct cl_lock_slice *slice,
1725 struct cl_lock_closure *closure);
1727 * Executed top-to-bottom when lock description changes (e.g., as a
1728 * result of server granting more generous lock than was requested).
1730 * \see lovsub_lock_modify()
1732 int (*clo_modify)(const struct lu_env *env,
1733 const struct cl_lock_slice *slice,
1734 const struct cl_lock_descr *updated);
1736 * Notifies layers (bottom-to-top) that lock is going to be
1737 * destroyed. Responsibility of layers is to prevent new references on
1738 * this lock from being acquired once this method returns.
1740 * This can be called multiple times due to the races.
1742 * \see cl_lock_delete()
1743 * \see osc_lock_delete(), lovsub_lock_delete()
1745 void (*clo_delete)(const struct lu_env *env,
1746 const struct cl_lock_slice *slice);
1748 * Destructor. Frees resources and the slice.
1750 * \see ccc_lock_fini(), lov_lock_fini(), lovsub_lock_fini(),
1751 * \see osc_lock_fini()
1753 void (*clo_fini)(const struct lu_env *env, struct cl_lock_slice *slice);
1755 * Optional debugging helper. Prints given lock slice.
1757 int (*clo_print)(const struct lu_env *env,
1758 void *cookie, lu_printer_t p,
1759 const struct cl_lock_slice *slice);
1762 #define CL_LOCK_DEBUG(mask, env, lock, format, ...) \
1764 static DECLARE_LU_CDEBUG_PRINT_INFO(__info, mask); \
1766 if (cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
1767 cl_lock_print(env, &__info, lu_cdebug_printer, lock); \
1768 CDEBUG(mask, format , ## __VA_ARGS__); \
1774 /** \addtogroup cl_page_list cl_page_list
1775 * Page list used to perform collective operations on a group of pages.
1777 * Pages are added to the list one by one. cl_page_list acquires a reference
1778 * for every page in it. Page list is used to perform collective operations on
1781 * - submit pages for an immediate transfer,
1783 * - own pages on behalf of certain io (waiting for each page in turn),
1787 * When list is finalized, it releases references on all pages it still has.
1789 * \todo XXX concurrency control.
1793 struct cl_page_list {
1795 struct list_head pl_pages;
1796 cfs_task_t *pl_owner;
1799 /** \addtogroup cl_page_list cl_page_list
1800 * A 2-queue of pages. A convenience data-type for common use case, 2-queue
1801 * contains an incoming page list and an outgoing page list.
1804 struct cl_page_list c2_qin;
1805 struct cl_page_list c2_qout;
1808 /** @} cl_page_list */
1810 /** \addtogroup cl_io cl_io
1815 * cl_io represents a high level I/O activity like
1816 * read(2)/write(2)/truncate(2) system call, or cancellation of an extent
1819 * cl_io is a layered object, much like cl_{object,page,lock} but with one
1820 * important distinction. We want to minimize number of calls to the allocator
1821 * in the fast path, e.g., in the case of read(2) when everything is cached:
1822 * client already owns the lock over region being read, and data are cached
1823 * due to read-ahead. To avoid allocation of cl_io layers in such situations,
1824 * per-layer io state is stored in the session, associated with the io, see
1825 * struct {vvp,lov,osc}_io for example. Sessions allocation is amortized
1826 * by using free-lists, see cl_env_get().
1828 * There is a small predefined number of possible io types, enumerated in enum
1831 * cl_io is a state machine, that can be advanced concurrently by the multiple
1832 * threads. It is up to these threads to control the concurrency and,
1833 * specifically, to detect when io is done, and its state can be safely
1836 * For read/write io overall execution plan is as following:
1838 * (0) initialize io state through all layers;
1840 * (1) loop: prepare chunk of work to do
1842 * (2) call all layers to collect locks they need to process current chunk
1844 * (3) sort all locks to avoid dead-locks, and acquire them
1846 * (4) process the chunk: call per-page methods
1847 * (cl_io_operations::cio_read_page() for read,
1848 * cl_io_operations::cio_prepare_write(),
1849 * cl_io_operations::cio_commit_write() for write)
1855 * To implement the "parallel IO mode", lov layer creates sub-io's (lazily to
1856 * address allocation efficiency issues mentioned above), and returns with the
1857 * special error condition from per-page method when current sub-io has to
1858 * block. This causes io loop to be repeated, and lov switches to the next
1859 * sub-io in its cl_io_operations::cio_iter_init() implementation.
1864 /** read system call */
1866 /** write system call */
1868 /** truncate system call */
1871 * page fault handling
1875 * Miscellaneous io. This is used for occasional io activity that
1876 * doesn't fit into other types. Currently this is used for:
1878 * - cancellation of an extent lock. This io exists as a context
1879 * to write dirty pages from under the lock being canceled back
1882 * - VM induced page write-out. An io context for writing page out
1883 * for memory cleansing;
1885 * - glimpse. An io context to acquire glimpse lock.
1887 * CIT_MISC io is used simply as a context in which locks and pages
1888 * are manipulated. Such io has no internal "process", that is,
1889 * cl_io_loop() is never called for it.
1896 * States of cl_io state machine
1899 /** Not initialized. */
1903 /** IO iteration started. */
1907 /** Actual IO is in progress. */
1909 /** IO for the current iteration finished. */
1911 /** Locks released. */
1913 /** Iteration completed. */
1915 /** cl_io finalized. */
1919 enum cl_req_priority {
1925 * IO state private for a layer.
1927 * This is usually embedded into layer session data, rather than allocated
1930 * \see vvp_io, lov_io, osc_io, ccc_io
1932 struct cl_io_slice {
1933 struct cl_io *cis_io;
1934 /** corresponding object slice. Immutable after creation. */
1935 struct cl_object *cis_obj;
1936 /** io operations. Immutable after creation. */
1937 const struct cl_io_operations *cis_iop;
1939 * linkage into a list of all slices for a given cl_io, hanging off
1940 * cl_io::ci_layers. Immutable after creation.
1942 struct list_head cis_linkage;
1947 * Per-layer io operations.
1948 * \see vvp_io_ops, lov_io_ops, lovsub_io_ops, osc_io_ops
1950 struct cl_io_operations {
1952 * Vector of io state transition methods for every io type.
1954 * \see cl_page_operations::io
1958 * Prepare io iteration at a given layer.
1960 * Called top-to-bottom at the beginning of each iteration of
1961 * "io loop" (if it makes sense for this type of io). Here
1962 * layer selects what work it will do during this iteration.
1964 * \see cl_io_operations::cio_iter_fini()
1966 int (*cio_iter_init) (const struct lu_env *env,
1967 const struct cl_io_slice *slice);
1969 * Finalize io iteration.
1971 * Called bottom-to-top at the end of each iteration of "io
1972 * loop". Here layers can decide whether IO has to be
1975 * \see cl_io_operations::cio_iter_init()
1977 void (*cio_iter_fini) (const struct lu_env *env,
1978 const struct cl_io_slice *slice);
1980 * Collect locks for the current iteration of io.
1982 * Called top-to-bottom to collect all locks necessary for
1983 * this iteration. This methods shouldn't actually enqueue
1984 * anything, instead it should post a lock through
1985 * cl_io_lock_add(). Once all locks are collected, they are
1986 * sorted and enqueued in the proper order.
1988 int (*cio_lock) (const struct lu_env *env,
1989 const struct cl_io_slice *slice);
1991 * Finalize unlocking.
1993 * Called bottom-to-top to finish layer specific unlocking
1994 * functionality, after generic code released all locks
1995 * acquired by cl_io_operations::cio_lock().
1997 void (*cio_unlock)(const struct lu_env *env,
1998 const struct cl_io_slice *slice);
2000 * Start io iteration.
2002 * Once all locks are acquired, called top-to-bottom to
2003 * commence actual IO. In the current implementation,
2004 * top-level vvp_io_{read,write}_start() does all the work
2005 * synchronously by calling generic_file_*(), so other layers
2006 * are called when everything is done.
2008 int (*cio_start)(const struct lu_env *env,
2009 const struct cl_io_slice *slice);
2011 * Called top-to-bottom at the end of io loop. Here layer
2012 * might wait for an unfinished asynchronous io.
2014 void (*cio_end) (const struct lu_env *env,
2015 const struct cl_io_slice *slice);
2017 * Called bottom-to-top to notify layers that read/write IO
2018 * iteration finished, with \a nob bytes transferred.
2020 void (*cio_advance)(const struct lu_env *env,
2021 const struct cl_io_slice *slice,
2024 * Called once per io, bottom-to-top to release io resources.
2026 void (*cio_fini) (const struct lu_env *env,
2027 const struct cl_io_slice *slice);
2031 * Submit pages from \a queue->c2_qin for IO, and move
2032 * successfully submitted pages into \a queue->c2_qout. Return
2033 * non-zero if failed to submit even the single page. If
2034 * submission failed after some pages were moved into \a
2035 * queue->c2_qout, completion callback with non-zero ioret is
2038 int (*cio_submit)(const struct lu_env *env,
2039 const struct cl_io_slice *slice,
2040 enum cl_req_type crt,
2041 struct cl_2queue *queue,
2042 enum cl_req_priority priority);
2045 * Read missing page.
2047 * Called by a top-level cl_io_operations::op[CIT_READ]::cio_start()
2048 * method, when it hits not-up-to-date page in the range. Optional.
2050 * \pre io->ci_type == CIT_READ
2052 int (*cio_read_page)(const struct lu_env *env,
2053 const struct cl_io_slice *slice,
2054 const struct cl_page_slice *page);
2056 * Prepare write of a \a page. Called bottom-to-top by a top-level
2057 * cl_io_operations::op[CIT_WRITE]::cio_start() to prepare page for
2058 * get data from user-level buffer.
2060 * \pre io->ci_type == CIT_WRITE
2062 * \see vvp_io_prepare_write(), lov_io_prepare_write(),
2063 * osc_io_prepare_write().
2065 int (*cio_prepare_write)(const struct lu_env *env,
2066 const struct cl_io_slice *slice,
2067 const struct cl_page_slice *page,
2068 unsigned from, unsigned to);
2071 * \pre io->ci_type == CIT_WRITE
2073 * \see vvp_io_commit_write(), lov_io_commit_write(),
2074 * osc_io_commit_write().
2076 int (*cio_commit_write)(const struct lu_env *env,
2077 const struct cl_io_slice *slice,
2078 const struct cl_page_slice *page,
2079 unsigned from, unsigned to);
2081 * Optional debugging helper. Print given io slice.
2083 int (*cio_print)(const struct lu_env *env, void *cookie,
2084 lu_printer_t p, const struct cl_io_slice *slice);
2088 * Flags to lock enqueue procedure.
2093 * instruct server to not block, if conflicting lock is found. Instead
2094 * -EWOULDBLOCK is returned immediately.
2096 CEF_NONBLOCK = 0x00000001,
2098 * take lock asynchronously (out of order), as it cannot
2099 * deadlock. This is for LDLM_FL_HAS_INTENT locks used for glimpsing.
2101 CEF_ASYNC = 0x00000002,
2103 * tell the server to instruct (though a flag in the blocking ast) an
2104 * owner of the conflicting lock, that it can drop dirty pages
2105 * protected by this lock, without sending them to the server.
2107 CEF_DISCARD_DATA = 0x00000004,
2109 * tell the sub layers that it must be a `real' lock. This is used for
2110 * mmapped-buffer locks and glimpse locks that must be never converted
2111 * into lockless mode.
2113 * \see vvp_mmap_locks(), cl_glimpse_lock().
2115 CEF_MUST = 0x00000008,
2117 * tell the sub layers that never request a `real' lock. This flag is
2118 * not used currently.
2120 * cl_io::ci_lockreq and CEF_{MUST,NEVER} flags specify lockless
2121 * conversion policy: ci_lockreq describes generic information of lock
2122 * requirement for this IO, especially for locks which belong to the
2123 * object doing IO; however, lock itself may have precise requirements
2124 * that are described by the enqueue flags.
2126 CEF_NEVER = 0x00000010,
2128 * mask of enq_flags.
2130 CEF_MASK = 0x0000001f
2134 * Link between lock and io. Intermediate structure is needed, because the
2135 * same lock can be part of multiple io's simultaneously.
2137 struct cl_io_lock_link {
2138 /** linkage into one of cl_lockset lists. */
2139 struct list_head cill_linkage;
2140 struct cl_lock_descr cill_descr;
2141 struct cl_lock *cill_lock;
2143 * flags to enqueue lock for this IO. A combination of bit-flags from
2144 * enum cl_enq_flags.
2146 __u32 cill_enq_flags;
2147 /** optional destructor */
2148 void (*cill_fini)(const struct lu_env *env,
2149 struct cl_io_lock_link *link);
2153 * Lock-set represents a collection of locks, that io needs at a
2154 * time. Generally speaking, client tries to avoid holding multiple locks when
2157 * - holding extent locks over multiple ost's introduces the danger of
2158 * "cascading timeouts";
2160 * - holding multiple locks over the same ost is still dead-lock prone,
2161 * see comment in osc_lock_enqueue(),
2163 * but there are certain situations where this is unavoidable:
2165 * - O_APPEND writes have to take [0, EOF] lock for correctness;
2167 * - truncate has to take [new-size, EOF] lock for correctness;
2169 * - SNS has to take locks across full stripe for correctness;
2171 * - in the case when user level buffer, supplied to {read,write}(file0),
2172 * is a part of a memory mapped lustre file, client has to take a dlm
2173 * locks on file0, and all files that back up the buffer (or a part of
2174 * the buffer, that is being processed in the current chunk, in any
2175 * case, there are situations where at least 2 locks are necessary).
2177 * In such cases we at least try to take locks in the same consistent
2178 * order. To this end, all locks are first collected, then sorted, and then
2182 /** locks to be acquired. */
2183 struct list_head cls_todo;
2184 /** locks currently being processed. */
2185 struct list_head cls_curr;
2186 /** locks acquired. */
2187 struct list_head cls_done;
2191 * Lock requirements(demand) for IO. It should be cl_io_lock_req,
2192 * but 'req' is always to be thought as 'request' :-)
2194 enum cl_io_lock_dmd {
2195 /** Always lock data (e.g., O_APPEND). */
2197 /** Layers are free to decide between local and global locking. */
2199 /** Never lock: there is no cache (e.g., liblustre). */
2203 struct cl_io_rw_common {
2212 * cl_io is shared by all threads participating in this IO (in current
2213 * implementation only one thread advances IO, but parallel IO design and
2214 * concurrent copy_*_user() require multiple threads acting on the same IO. It
2215 * is up to these threads to serialize their activities, including updates to
2216 * mutable cl_io fields.
2219 /** type of this IO. Immutable after creation. */
2220 enum cl_io_type ci_type;
2221 /** current state of cl_io state machine. */
2222 enum cl_io_state ci_state;
2223 /** main object this io is against. Immutable after creation. */
2224 struct cl_object *ci_obj;
2226 * Upper layer io, of which this io is a part of. Immutable after
2229 struct cl_io *ci_parent;
2230 /** List of slices. Immutable after creation. */
2231 struct list_head ci_layers;
2232 /** list of locks (to be) acquired by this io. */
2233 struct cl_lockset ci_lockset;
2234 /** lock requirements, this is just a help info for sublayers. */
2235 enum cl_io_lock_dmd ci_lockreq;
2238 struct cl_io_rw_common rd;
2242 struct cl_io_rw_common wr;
2245 struct cl_io_rw_common ci_rw;
2246 struct cl_truncate_io {
2247 /** new size to which file is truncated */
2249 struct obd_capa *tr_capa;
2251 struct cl_fault_io {
2252 /** page index within file. */
2254 /** bytes valid byte on a faulted page. */
2256 /** writable page? */
2258 /** page of an executable? */
2260 /** resulting page */
2261 struct cl_page *ft_page;
2264 struct cl_2queue ci_queue;
2269 * Number of pages owned by this IO. For invariant checking.
2271 unsigned ci_owned_nr;
2276 /** \addtogroup cl_req cl_req
2281 * There are two possible modes of transfer initiation on the client:
2283 * - immediate transfer: this is started when a high level io wants a page
2284 * or a collection of pages to be transferred right away. Examples:
2285 * read-ahead, synchronous read in the case of non-page aligned write,
2286 * page write-out as a part of extent lock cancellation, page write-out
2287 * as a part of memory cleansing. Immediate transfer can be both
2288 * cl_req_type::CRT_READ and cl_req_type::CRT_WRITE;
2290 * - opportunistic transfer (cl_req_type::CRT_WRITE only), that happens
2291 * when io wants to transfer a page to the server some time later, when
2292 * it can be done efficiently. Example: pages dirtied by the write(2)
2295 * In any case, transfer takes place in the form of a cl_req, which is a
2296 * representation for a network RPC.
2298 * Pages queued for an opportunistic transfer are cached until it is decided
2299 * that efficient RPC can be composed of them. This decision is made by "a
2300 * req-formation engine", currently implemented as a part of osc
2301 * layer. Req-formation depends on many factors: the size of the resulting
2302 * RPC, whether or not multi-object RPCs are supported by the server,
2303 * max-rpc-in-flight limitations, size of the dirty cache, etc.
2305 * For the immediate transfer io submits a cl_page_list, that req-formation
2306 * engine slices into cl_req's, possibly adding cached pages to some of
2307 * the resulting req's.
2309 * Whenever a page from cl_page_list is added to a newly constructed req, its
2310 * cl_page_operations::cpo_prep() layer methods are called. At that moment,
2311 * page state is atomically changed from cl_page_state::CPS_OWNED to
2312 * cl_page_state::CPS_PAGEOUT or cl_page_state::CPS_PAGEIN, cl_page::cp_owner
2313 * is zeroed, and cl_page::cp_req is set to the
2314 * req. cl_page_operations::cpo_prep() method at the particular layer might
2315 * return -EALREADY to indicate that it does not need to submit this page
2316 * at all. This is possible, for example, if page, submitted for read,
2317 * became up-to-date in the meantime; and for write, the page don't have
2318 * dirty bit marked. \see cl_io_submit_rw()
2320 * Whenever a cached page is added to a newly constructed req, its
2321 * cl_page_operations::cpo_make_ready() layer methods are called. At that
2322 * moment, page state is atomically changed from cl_page_state::CPS_CACHED to
2323 * cl_page_state::CPS_PAGEOUT, and cl_page::cp_req is set to
2324 * req. cl_page_operations::cpo_make_ready() method at the particular layer
2325 * might return -EAGAIN to indicate that this page is not eligible for the
2326 * transfer right now.
2330 * Plan is to divide transfers into "priority bands" (indicated when
2331 * submitting cl_page_list, and queuing a page for the opportunistic transfer)
2332 * and allow glueing of cached pages to immediate transfers only within single
2333 * band. This would make high priority transfers (like lock cancellation or
2334 * memory pressure induced write-out) really high priority.
2339 * Per-transfer attributes.
2341 struct cl_req_attr {
2342 /** Generic attributes for the server consumption. */
2343 struct obdo *cra_oa;
2345 struct obd_capa *cra_capa;
2349 * Transfer request operations definable at every layer.
2351 * Concurrency: transfer formation engine synchronizes calls to all transfer
2354 struct cl_req_operations {
2356 * Invoked top-to-bottom by cl_req_prep() when transfer formation is
2357 * complete (all pages are added).
2359 * \see osc_req_prep()
2361 int (*cro_prep)(const struct lu_env *env,
2362 const struct cl_req_slice *slice);
2364 * Called top-to-bottom to fill in \a oa fields. This is called twice
2365 * with different flags, see bug 10150 and osc_build_req().
2367 * \param obj an object from cl_req which attributes are to be set in
2370 * \param oa struct obdo where attributes are placed
2372 * \param flags \a oa fields to be filled.
2374 void (*cro_attr_set)(const struct lu_env *env,
2375 const struct cl_req_slice *slice,
2376 const struct cl_object *obj,
2377 struct cl_req_attr *attr, obd_valid flags);
2379 * Called top-to-bottom from cl_req_completion() to notify layers that
2380 * transfer completed. Has to free all state allocated by
2381 * cl_device_operations::cdo_req_init().
2383 void (*cro_completion)(const struct lu_env *env,
2384 const struct cl_req_slice *slice, int ioret);
2388 * A per-object state that (potentially multi-object) transfer request keeps.
2391 /** object itself */
2392 struct cl_object *ro_obj;
2393 /** reference to cl_req_obj::ro_obj. For debugging. */
2394 struct lu_ref_link *ro_obj_ref;
2395 /* something else? Number of pages for a given object? */
2401 * Transfer requests are not reference counted, because IO sub-system owns
2402 * them exclusively and knows when to free them.
2406 * cl_req is created by cl_req_alloc() that calls
2407 * cl_device_operations::cdo_req_init() device methods to allocate per-req
2408 * state in every layer.
2410 * Then pages are added (cl_req_page_add()), req keeps track of all objects it
2411 * contains pages for.
2413 * Once all pages were collected, cl_page_operations::cpo_prep() method is
2414 * called top-to-bottom. At that point layers can modify req, let it pass, or
2415 * deny it completely. This is to support things like SNS that have transfer
2416 * ordering requirements invisible to the individual req-formation engine.
2418 * On transfer completion (or transfer timeout, or failure to initiate the
2419 * transfer of an allocated req), cl_req_operations::cro_completion() method
2420 * is called, after execution of cl_page_operations::cpo_completion() of all
2424 enum cl_req_type crq_type;
2425 /** A list of pages being transfered */
2426 struct list_head crq_pages;
2427 /** Number of pages in cl_req::crq_pages */
2428 unsigned crq_nrpages;
2429 /** An array of objects which pages are in ->crq_pages */
2430 struct cl_req_obj *crq_o;
2431 /** Number of elements in cl_req::crq_objs[] */
2432 unsigned crq_nrobjs;
2433 struct list_head crq_layers;
2437 * Per-layer state for request.
2439 struct cl_req_slice {
2440 struct cl_req *crs_req;
2441 struct cl_device *crs_dev;
2442 struct list_head crs_linkage;
2443 const struct cl_req_operations *crs_ops;
2449 * Stats for a generic cache (similar to inode, lu_object, etc. caches).
2451 struct cache_stats {
2452 const char *cs_name;
2453 /** how many entities were created at all */
2454 atomic_t cs_created;
2455 /** how many cache lookups were performed */
2457 /** how many times cache lookup resulted in a hit */
2459 /** how many entities are in the cache right now */
2461 /** how many entities in the cache are actively used (and cannot be
2462 * evicted) right now */
2466 /** These are not exported so far */
2467 void cache_stats_init (struct cache_stats *cs, const char *name);
2468 int cache_stats_print(const struct cache_stats *cs,
2469 char *page, int count, int header);
2472 * Client-side site. This represents particular client stack. "Global"
2473 * variables should (directly or indirectly) be added here to allow multiple
2474 * clients to co-exist in the single address space.
2477 struct lu_site cs_lu;
2479 * Statistical counters. Atomics do not scale, something better like
2480 * per-cpu counters is needed.
2482 * These are exported as /proc/fs/lustre/llite/.../site
2484 * When interpreting keep in mind that both sub-locks (and sub-pages)
2485 * and top-locks (and top-pages) are accounted here.
2487 struct cache_stats cs_pages;
2488 struct cache_stats cs_locks;
2489 atomic_t cs_pages_state[CPS_NR];
2490 atomic_t cs_locks_state[CLS_NR];
2493 int cl_site_init (struct cl_site *s, struct cl_device *top);
2494 void cl_site_fini (struct cl_site *s);
2495 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl);
2498 * Output client site statistical counters into a buffer. Suitable for
2499 * ll_rd_*()-style functions.
2501 int cl_site_stats_print(const struct cl_site *s, char *page, int count);
2506 * Type conversion and accessory functions.
2510 static inline struct cl_site *lu2cl_site(const struct lu_site *site)
2512 return container_of(site, struct cl_site, cs_lu);
2515 static inline int lu_device_is_cl(const struct lu_device *d)
2517 return d->ld_type->ldt_tags & LU_DEVICE_CL;
2520 static inline struct cl_device *lu2cl_dev(const struct lu_device *d)
2522 LASSERT(d == NULL || IS_ERR(d) || lu_device_is_cl(d));
2523 return container_of0(d, struct cl_device, cd_lu_dev);
2526 static inline struct lu_device *cl2lu_dev(struct cl_device *d)
2528 return &d->cd_lu_dev;
2531 static inline struct cl_object *lu2cl(const struct lu_object *o)
2533 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_cl(o->lo_dev));
2534 return container_of0(o, struct cl_object, co_lu);
2537 static inline const struct cl_object_conf *
2538 lu2cl_conf(const struct lu_object_conf *conf)
2540 return container_of0(conf, struct cl_object_conf, coc_lu);
2543 static inline struct cl_object *cl_object_next(const struct cl_object *obj)
2545 return obj ? lu2cl(lu_object_next(&obj->co_lu)) : NULL;
2548 static inline struct cl_device *cl_object_device(const struct cl_object *o)
2550 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_cl(o->co_lu.lo_dev));
2551 return container_of0(o->co_lu.lo_dev, struct cl_device, cd_lu_dev);
2554 static inline struct cl_object_header *luh2coh(const struct lu_object_header *h)
2556 return container_of0(h, struct cl_object_header, coh_lu);
2559 static inline struct cl_site *cl_object_site(const struct cl_object *obj)
2561 return lu2cl_site(obj->co_lu.lo_dev->ld_site);
2565 struct cl_object_header *cl_object_header(const struct cl_object *obj)
2567 return luh2coh(obj->co_lu.lo_header);
2570 static inline int cl_device_init(struct cl_device *d, struct lu_device_type *t)
2572 return lu_device_init(&d->cd_lu_dev, t);
2575 static inline void cl_device_fini(struct cl_device *d)
2577 lu_device_fini(&d->cd_lu_dev);
2580 void cl_page_slice_add(struct cl_page *page, struct cl_page_slice *slice,
2581 struct cl_object *obj,
2582 const struct cl_page_operations *ops);
2583 void cl_lock_slice_add(struct cl_lock *lock, struct cl_lock_slice *slice,
2584 struct cl_object *obj,
2585 const struct cl_lock_operations *ops);
2586 void cl_io_slice_add(struct cl_io *io, struct cl_io_slice *slice,
2587 struct cl_object *obj, const struct cl_io_operations *ops);
2588 void cl_req_slice_add(struct cl_req *req, struct cl_req_slice *slice,
2589 struct cl_device *dev,
2590 const struct cl_req_operations *ops);
2593 /** \defgroup cl_object cl_object
2595 struct cl_object *cl_object_top (struct cl_object *o);
2596 struct cl_object *cl_object_find(const struct lu_env *env, struct cl_device *cd,
2597 const struct lu_fid *fid,
2598 const struct cl_object_conf *c);
2600 int cl_object_header_init(struct cl_object_header *h);
2601 void cl_object_header_fini(struct cl_object_header *h);
2602 void cl_object_put (const struct lu_env *env, struct cl_object *o);
2603 void cl_object_get (struct cl_object *o);
2604 void cl_object_attr_lock (struct cl_object *o);
2605 void cl_object_attr_unlock(struct cl_object *o);
2606 int cl_object_attr_get (const struct lu_env *env, struct cl_object *obj,
2607 struct cl_attr *attr);
2608 int cl_object_attr_set (const struct lu_env *env, struct cl_object *obj,
2609 const struct cl_attr *attr, unsigned valid);
2610 int cl_object_glimpse (const struct lu_env *env, struct cl_object *obj,
2611 struct ost_lvb *lvb);
2612 int cl_conf_set (const struct lu_env *env, struct cl_object *obj,
2613 const struct cl_object_conf *conf);
2614 void cl_object_prune (const struct lu_env *env, struct cl_object *obj);
2615 void cl_object_kill (const struct lu_env *env, struct cl_object *obj);
2618 * Returns true, iff \a o0 and \a o1 are slices of the same object.
2620 static inline int cl_object_same(struct cl_object *o0, struct cl_object *o1)
2622 return cl_object_header(o0) == cl_object_header(o1);
2627 /** \defgroup cl_page cl_page
2629 struct cl_page *cl_page_lookup(struct cl_object_header *hdr,
2631 void cl_page_gang_lookup(const struct lu_env *env,
2632 struct cl_object *obj,
2634 pgoff_t start, pgoff_t end,
2635 struct cl_page_list *plist);
2636 struct cl_page *cl_page_find (const struct lu_env *env,
2637 struct cl_object *obj,
2638 pgoff_t idx, struct page *vmpage,
2639 enum cl_page_type type);
2640 void cl_page_get (struct cl_page *page);
2641 void cl_page_put (const struct lu_env *env,
2642 struct cl_page *page);
2643 void cl_page_print (const struct lu_env *env, void *cookie,
2644 lu_printer_t printer,
2645 const struct cl_page *pg);
2646 void cl_page_header_print(const struct lu_env *env, void *cookie,
2647 lu_printer_t printer,
2648 const struct cl_page *pg);
2649 cfs_page_t *cl_page_vmpage (const struct lu_env *env,
2650 struct cl_page *page);
2651 struct cl_page *cl_vmpage_page (cfs_page_t *vmpage, struct cl_object *obj);
2652 struct cl_page *cl_page_top (struct cl_page *page);
2653 int cl_is_page (const void *addr);
2655 const struct cl_page_slice *cl_page_at(const struct cl_page *page,
2656 const struct lu_device_type *dtype);
2661 * Functions dealing with the ownership of page by io.
2665 int cl_page_own (const struct lu_env *env,
2666 struct cl_io *io, struct cl_page *page);
2667 void cl_page_assume (const struct lu_env *env,
2668 struct cl_io *io, struct cl_page *page);
2669 void cl_page_unassume (const struct lu_env *env,
2670 struct cl_io *io, struct cl_page *pg);
2671 void cl_page_disown (const struct lu_env *env,
2672 struct cl_io *io, struct cl_page *page);
2673 int cl_page_is_owned (const struct cl_page *pg, const struct cl_io *io);
2680 * Functions dealing with the preparation of a page for a transfer, and
2681 * tracking transfer state.
2684 int cl_page_prep (const struct lu_env *env, struct cl_io *io,
2685 struct cl_page *pg, enum cl_req_type crt);
2686 void cl_page_completion (const struct lu_env *env,
2687 struct cl_page *pg, enum cl_req_type crt, int ioret);
2688 int cl_page_make_ready (const struct lu_env *env, struct cl_page *pg,
2689 enum cl_req_type crt);
2690 int cl_page_cache_add (const struct lu_env *env, struct cl_io *io,
2691 struct cl_page *pg, enum cl_req_type crt);
2692 void cl_page_clip (const struct lu_env *env, struct cl_page *pg,
2694 int cl_page_cancel (const struct lu_env *env, struct cl_page *page);
2700 * \name helper routines
2701 * Functions to discard, delete and export a cl_page.
2704 void cl_page_discard (const struct lu_env *env, struct cl_io *io,
2705 struct cl_page *pg);
2706 void cl_page_delete (const struct lu_env *env, struct cl_page *pg);
2707 int cl_page_unmap (const struct lu_env *env, struct cl_io *io,
2708 struct cl_page *pg);
2709 int cl_page_is_vmlocked (const struct lu_env *env,
2710 const struct cl_page *pg);
2711 void cl_page_export (const struct lu_env *env, struct cl_page *pg);
2712 int cl_page_is_under_lock(const struct lu_env *env, struct cl_io *io,
2713 struct cl_page *page);
2714 loff_t cl_offset (const struct cl_object *obj, pgoff_t idx);
2715 pgoff_t cl_index (const struct cl_object *obj, loff_t offset);
2716 int cl_page_size (const struct cl_object *obj);
2717 int cl_pages_prune (const struct lu_env *env, struct cl_object *obj);
2719 void cl_lock_print (const struct lu_env *env, void *cookie,
2720 lu_printer_t printer, const struct cl_lock *lock);
2721 void cl_lock_descr_print(const struct lu_env *env, void *cookie,
2722 lu_printer_t printer,
2723 const struct cl_lock_descr *descr);
2728 /** \defgroup cl_lock cl_lock
2731 struct cl_lock *cl_lock_hold(const struct lu_env *env, const struct cl_io *io,
2732 const struct cl_lock_descr *need,
2733 const char *scope, const void *source);
2734 struct cl_lock *cl_lock_peek(const struct lu_env *env, const struct cl_io *io,
2735 const struct cl_lock_descr *need,
2736 const char *scope, const void *source);
2737 struct cl_lock *cl_lock_request(const struct lu_env *env, struct cl_io *io,
2738 const struct cl_lock_descr *need,
2740 const char *scope, const void *source);
2741 struct cl_lock *cl_lock_at_page(const struct lu_env *env, struct cl_object *obj,
2742 struct cl_page *page, struct cl_lock *except,
2743 int pending, int canceld);
2745 const struct cl_lock_slice *cl_lock_at(const struct cl_lock *lock,
2746 const struct lu_device_type *dtype);
2748 void cl_lock_get (struct cl_lock *lock);
2749 void cl_lock_get_trust (struct cl_lock *lock);
2750 void cl_lock_put (const struct lu_env *env, struct cl_lock *lock);
2751 void cl_lock_hold_add (const struct lu_env *env, struct cl_lock *lock,
2752 const char *scope, const void *source);
2753 void cl_lock_unhold (const struct lu_env *env, struct cl_lock *lock,
2754 const char *scope, const void *source);
2755 void cl_lock_release (const struct lu_env *env, struct cl_lock *lock,
2756 const char *scope, const void *source);
2757 void cl_lock_user_add (const struct lu_env *env, struct cl_lock *lock);
2758 int cl_lock_user_del (const struct lu_env *env, struct cl_lock *lock);
2759 int cl_lock_compatible(const struct cl_lock *lock1,
2760 const struct cl_lock *lock2);
2762 /** \name statemachine statemachine
2763 * Interface to lock state machine consists of 3 parts:
2765 * - "try" functions that attempt to effect a state transition. If state
2766 * transition is not possible right now (e.g., if it has to wait for some
2767 * asynchronous event to occur), these functions return
2768 * cl_lock_transition::CLO_WAIT.
2770 * - "non-try" functions that implement synchronous blocking interface on
2771 * top of non-blocking "try" functions. These functions repeatedly call
2772 * corresponding "try" versions, and if state transition is not possible
2773 * immediately, wait for lock state change.
2775 * - methods from cl_lock_operations, called by "try" functions. Lock can
2776 * be advanced to the target state only when all layers voted that they
2777 * are ready for this transition. "Try" functions call methods under lock
2778 * mutex. If a layer had to release a mutex, it re-acquires it and returns
2779 * cl_lock_transition::CLO_REPEAT, causing "try" function to call all
2782 * TRY NON-TRY METHOD FINAL STATE
2784 * cl_enqueue_try() cl_enqueue() cl_lock_operations::clo_enqueue() CLS_ENQUEUED
2786 * cl_wait_try() cl_wait() cl_lock_operations::clo_wait() CLS_HELD
2788 * cl_unuse_try() cl_unuse() cl_lock_operations::clo_unuse() CLS_CACHED
2790 * cl_use_try() NONE cl_lock_operations::clo_use() CLS_HELD
2794 int cl_enqueue (const struct lu_env *env, struct cl_lock *lock,
2795 struct cl_io *io, __u32 flags);
2796 int cl_wait (const struct lu_env *env, struct cl_lock *lock);
2797 void cl_unuse (const struct lu_env *env, struct cl_lock *lock);
2798 int cl_enqueue_try(const struct lu_env *env, struct cl_lock *lock,
2799 struct cl_io *io, __u32 flags);
2800 int cl_unuse_try (const struct lu_env *env, struct cl_lock *lock);
2801 int cl_wait_try (const struct lu_env *env, struct cl_lock *lock);
2802 int cl_use_try (const struct lu_env *env, struct cl_lock *lock);
2803 /** @} statemachine */
2805 void cl_lock_signal (const struct lu_env *env, struct cl_lock *lock);
2806 int cl_lock_state_wait (const struct lu_env *env, struct cl_lock *lock);
2807 void cl_lock_state_set (const struct lu_env *env, struct cl_lock *lock,
2808 enum cl_lock_state state);
2809 int cl_queue_match (const struct list_head *queue,
2810 const struct cl_lock_descr *need);
2812 void cl_lock_mutex_get (const struct lu_env *env, struct cl_lock *lock);
2813 int cl_lock_mutex_try (const struct lu_env *env, struct cl_lock *lock);
2814 void cl_lock_mutex_put (const struct lu_env *env, struct cl_lock *lock);
2815 int cl_lock_is_mutexed (struct cl_lock *lock);
2816 int cl_lock_nr_mutexed (const struct lu_env *env);
2817 int cl_lock_page_out (const struct lu_env *env, struct cl_lock *lock,
2819 int cl_lock_ext_match (const struct cl_lock_descr *has,
2820 const struct cl_lock_descr *need);
2821 int cl_lock_descr_match(const struct cl_lock_descr *has,
2822 const struct cl_lock_descr *need);
2823 int cl_lock_mode_match (enum cl_lock_mode has, enum cl_lock_mode need);
2824 int cl_lock_modify (const struct lu_env *env, struct cl_lock *lock,
2825 const struct cl_lock_descr *desc);
2827 void cl_lock_closure_init (const struct lu_env *env,
2828 struct cl_lock_closure *closure,
2829 struct cl_lock *origin, int wait);
2830 void cl_lock_closure_fini (struct cl_lock_closure *closure);
2831 int cl_lock_closure_build(const struct lu_env *env, struct cl_lock *lock,
2832 struct cl_lock_closure *closure);
2833 void cl_lock_disclosure (const struct lu_env *env,
2834 struct cl_lock_closure *closure);
2835 int cl_lock_enclosure (const struct lu_env *env, struct cl_lock *lock,
2836 struct cl_lock_closure *closure);
2838 void cl_lock_cancel(const struct lu_env *env, struct cl_lock *lock);
2839 void cl_lock_delete(const struct lu_env *env, struct cl_lock *lock);
2840 void cl_lock_error (const struct lu_env *env, struct cl_lock *lock, int error);
2841 void cl_locks_prune(const struct lu_env *env, struct cl_object *obj, int wait);
2842 int cl_is_lock (const void *addr);
2844 unsigned long cl_lock_weigh(const struct lu_env *env, struct cl_lock *lock);
2848 /** \defgroup cl_io cl_io
2851 int cl_io_init (const struct lu_env *env, struct cl_io *io,
2852 enum cl_io_type iot, struct cl_object *obj);
2853 int cl_io_sub_init (const struct lu_env *env, struct cl_io *io,
2854 enum cl_io_type iot, struct cl_object *obj);
2855 int cl_io_rw_init (const struct lu_env *env, struct cl_io *io,
2856 enum cl_io_type iot, loff_t pos, size_t count);
2857 int cl_io_loop (const struct lu_env *env, struct cl_io *io);
2859 void cl_io_fini (const struct lu_env *env, struct cl_io *io);
2860 int cl_io_iter_init (const struct lu_env *env, struct cl_io *io);
2861 void cl_io_iter_fini (const struct lu_env *env, struct cl_io *io);
2862 int cl_io_lock (const struct lu_env *env, struct cl_io *io);
2863 void cl_io_unlock (const struct lu_env *env, struct cl_io *io);
2864 int cl_io_start (const struct lu_env *env, struct cl_io *io);
2865 void cl_io_end (const struct lu_env *env, struct cl_io *io);
2866 int cl_io_lock_add (const struct lu_env *env, struct cl_io *io,
2867 struct cl_io_lock_link *link);
2868 int cl_io_lock_alloc_add(const struct lu_env *env, struct cl_io *io,
2869 struct cl_lock_descr *descr, int enqflags);
2870 int cl_io_read_page (const struct lu_env *env, struct cl_io *io,
2871 struct cl_page *page);
2872 int cl_io_prepare_write(const struct lu_env *env, struct cl_io *io,
2873 struct cl_page *page, unsigned from, unsigned to);
2874 int cl_io_commit_write (const struct lu_env *env, struct cl_io *io,
2875 struct cl_page *page, unsigned from, unsigned to);
2876 int cl_io_submit_rw (const struct lu_env *env, struct cl_io *io,
2877 enum cl_req_type iot, struct cl_2queue *queue,
2878 enum cl_req_priority priority);
2879 void cl_io_rw_advance (const struct lu_env *env, struct cl_io *io,
2881 int cl_io_cancel (const struct lu_env *env, struct cl_io *io,
2882 struct cl_page_list *queue);
2883 int cl_io_is_going (const struct lu_env *env);
2886 * True, iff \a io is an O_APPEND write(2).
2888 static inline int cl_io_is_append(const struct cl_io *io)
2890 return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_append;
2893 int cl_io_is_sendfile(const struct cl_io *io);
2895 struct cl_io *cl_io_top(struct cl_io *io);
2897 void cl_io_print(const struct lu_env *env, void *cookie,
2898 lu_printer_t printer, const struct cl_io *io);
2900 #define CL_IO_SLICE_CLEAN(foo_io, base) \
2902 typeof(foo_io) __foo_io = (foo_io); \
2904 CLASSERT(offsetof(typeof(*__foo_io), base) == 0); \
2905 memset(&__foo_io->base + 1, 0, \
2906 (sizeof *__foo_io) - sizeof __foo_io->base); \
2911 /** \defgroup cl_page_list cl_page_list
2915 * Iterate over pages in a page list.
2917 #define cl_page_list_for_each(page, list) \
2918 list_for_each_entry((page), &(list)->pl_pages, cp_batch)
2921 * Iterate over pages in a page list, taking possible removals into account.
2923 #define cl_page_list_for_each_safe(page, temp, list) \
2924 list_for_each_entry_safe((page), (temp), &(list)->pl_pages, cp_batch)
2926 void cl_page_list_init (struct cl_page_list *plist);
2927 void cl_page_list_add (struct cl_page_list *plist, struct cl_page *page);
2928 void cl_page_list_move (struct cl_page_list *dst, struct cl_page_list *src,
2929 struct cl_page *page);
2930 void cl_page_list_splice (struct cl_page_list *list,
2931 struct cl_page_list *head);
2932 void cl_page_list_del (const struct lu_env *env,
2933 struct cl_page_list *plist, struct cl_page *page);
2934 void cl_page_list_disown (const struct lu_env *env,
2935 struct cl_io *io, struct cl_page_list *plist);
2936 int cl_page_list_own (const struct lu_env *env,
2937 struct cl_io *io, struct cl_page_list *plist);
2938 void cl_page_list_assume (const struct lu_env *env,
2939 struct cl_io *io, struct cl_page_list *plist);
2940 void cl_page_list_discard(const struct lu_env *env,
2941 struct cl_io *io, struct cl_page_list *plist);
2942 int cl_page_list_unmap (const struct lu_env *env,
2943 struct cl_io *io, struct cl_page_list *plist);
2944 void cl_page_list_fini (const struct lu_env *env, struct cl_page_list *plist);
2946 void cl_2queue_init (struct cl_2queue *queue);
2947 void cl_2queue_add (struct cl_2queue *queue, struct cl_page *page);
2948 void cl_2queue_disown (const struct lu_env *env,
2949 struct cl_io *io, struct cl_2queue *queue);
2950 void cl_2queue_assume (const struct lu_env *env,
2951 struct cl_io *io, struct cl_2queue *queue);
2952 void cl_2queue_discard (const struct lu_env *env,
2953 struct cl_io *io, struct cl_2queue *queue);
2954 void cl_2queue_fini (const struct lu_env *env, struct cl_2queue *queue);
2955 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page);
2957 /** @} cl_page_list */
2959 /** \defgroup cl_req cl_req
2961 struct cl_req *cl_req_alloc(const struct lu_env *env, struct cl_page *page,
2962 enum cl_req_type crt, int nr_objects);
2964 void cl_req_page_add (const struct lu_env *env, struct cl_req *req,
2965 struct cl_page *page);
2966 void cl_req_page_done (const struct lu_env *env, struct cl_page *page);
2967 int cl_req_prep (const struct lu_env *env, struct cl_req *req);
2968 void cl_req_attr_set (const struct lu_env *env, struct cl_req *req,
2969 struct cl_req_attr *attr, obd_valid flags);
2970 void cl_req_completion(const struct lu_env *env, struct cl_req *req, int ioret);
2972 /** \defgroup cl_sync_io cl_sync_io
2976 * Anchor for synchronous transfer. This is allocated on a stack by thread
2977 * doing synchronous transfer, and a pointer to this structure is set up in
2978 * every page submitted for transfer. Transfer completion routine updates
2979 * anchor and wakes up waiting thread when transfer is complete.
2982 /** number of pages yet to be transferred. */
2983 atomic_t csi_sync_nr;
2984 /** completion to be signaled when transfer is complete. */
2985 struct completion csi_sync_completion;
2990 void cl_sync_io_init(struct cl_sync_io *anchor, int nrpages);
2991 int cl_sync_io_wait(const struct lu_env *env, struct cl_io *io,
2992 struct cl_page_list *queue, struct cl_sync_io *anchor);
2993 void cl_sync_io_note(struct cl_sync_io *anchor, int ioret);
2995 /** @} cl_sync_io */
2999 /** \defgroup cl_env cl_env
3001 * lu_env handling for a client.
3003 * lu_env is an environment within which lustre code executes. Its major part
3004 * is lu_context---a fast memory allocation mechanism that is used to conserve
3005 * precious kernel stack space. Originally lu_env was designed for a server,
3008 * - there is a (mostly) fixed number of threads, and
3010 * - call chains have no non-lustre portions inserted between lustre code.
3012 * On a client both these assumtpion fails, because every user thread can
3013 * potentially execute lustre code as part of a system call, and lustre calls
3014 * into VFS or MM that call back into lustre.
3016 * To deal with that, cl_env wrapper functions implement the following
3019 * - allocation and destruction of environment is amortized by caching no
3020 * longer used environments instead of destroying them;
3022 * - there is a notion of "current" environment, attached to the kernel
3023 * data structure representing current thread (current->journal_info in
3024 * Linux kernel). Top-level lustre code allocates an environment and makes
3025 * it current, then calls into non-lustre code, that in turn calls lustre
3026 * back. Low-level lustre code thus called can fetch environment created
3027 * by the top-level code and reuse it, avoiding additional environment
3030 * \see lu_env, lu_context, lu_context_key
3033 struct cl_env_nest {
3038 struct lu_env *cl_env_peek (int *refcheck);
3039 struct lu_env *cl_env_get (int *refcheck);
3040 struct lu_env *cl_env_alloc (int *refcheck, __u32 tags);
3041 struct lu_env *cl_env_nested_get (struct cl_env_nest *nest);
3042 void cl_env_put (struct lu_env *env, int *refcheck);
3043 void cl_env_nested_put (struct cl_env_nest *nest, struct lu_env *env);
3044 void *cl_env_reenter (void);
3045 void cl_env_reexit (void *cookie);
3046 void cl_env_implant (struct lu_env *env, int *refcheck);
3047 void cl_env_unplant (struct lu_env *env, int *refcheck);
3048 unsigned cl_env_cache_purge(unsigned nr);
3055 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr);
3056 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb);
3058 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
3059 struct lu_device_type *ldt,
3060 struct lu_device *next);
3063 #endif /* _LINUX_CL_OBJECT_H */