4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Whamcloud, Inc.
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;
280 * Invalidate the current stripe configuration due to losing
287 * Operations implemented for each cl object layer.
289 * \see vvp_ops, lov_ops, lovsub_ops, osc_ops
291 struct cl_object_operations {
293 * Initialize page slice for this layer. Called top-to-bottom through
294 * every object layer when a new cl_page is instantiated. Layer
295 * keeping private per-page data, or requiring its own page operations
296 * vector should allocate these data here, and attach then to the page
297 * by calling cl_page_slice_add(). \a vmpage is locked (in the VM
300 * \retval NULL success.
302 * \retval ERR_PTR(errno) failure code.
304 * \retval valid-pointer pointer to already existing referenced page
305 * to be used instead of newly created.
307 struct cl_page *(*coo_page_init)(const struct lu_env *env,
308 struct cl_object *obj,
309 struct cl_page *page,
312 * Initialize lock slice for this layer. Called top-to-bottom through
313 * every object layer when a new cl_lock is instantiated. Layer
314 * keeping private per-lock data, or requiring its own lock operations
315 * vector should allocate these data here, and attach then to the lock
316 * by calling cl_lock_slice_add(). Mandatory.
318 int (*coo_lock_init)(const struct lu_env *env,
319 struct cl_object *obj, struct cl_lock *lock,
320 const struct cl_io *io);
322 * Initialize io state for a given layer.
324 * called top-to-bottom once per io existence to initialize io
325 * state. If layer wants to keep some state for this type of io, it
326 * has to embed struct cl_io_slice in lu_env::le_ses, and register
327 * slice with cl_io_slice_add(). It is guaranteed that all threads
328 * participating in this io share the same session.
330 int (*coo_io_init)(const struct lu_env *env,
331 struct cl_object *obj, struct cl_io *io);
333 * Fill portion of \a attr that this layer controls. This method is
334 * called top-to-bottom through all object layers.
336 * \pre cl_object_header::coh_attr_guard of the top-object is locked.
338 * \return 0: to continue
339 * \return +ve: to stop iterating through layers (but 0 is returned
340 * from enclosing cl_object_attr_get())
341 * \return -ve: to signal error
343 int (*coo_attr_get)(const struct lu_env *env, struct cl_object *obj,
344 struct cl_attr *attr);
348 * \a valid is a bitmask composed from enum #cl_attr_valid, and
349 * indicating what attributes are to be set.
351 * \pre cl_object_header::coh_attr_guard of the top-object is locked.
353 * \return the same convention as for
354 * cl_object_operations::coo_attr_get() is used.
356 int (*coo_attr_set)(const struct lu_env *env, struct cl_object *obj,
357 const struct cl_attr *attr, unsigned valid);
359 * Update object configuration. Called top-to-bottom to modify object
362 * XXX error conditions and handling.
364 int (*coo_conf_set)(const struct lu_env *env, struct cl_object *obj,
365 const struct cl_object_conf *conf);
367 * Glimpse ast. Executed when glimpse ast arrives for a lock on this
368 * object. Layers are supposed to fill parts of \a lvb that will be
369 * shipped to the glimpse originator as a glimpse result.
371 * \see ccc_object_glimpse(), lovsub_object_glimpse(),
372 * \see osc_object_glimpse()
374 int (*coo_glimpse)(const struct lu_env *env,
375 const struct cl_object *obj, struct ost_lvb *lvb);
379 * Extended header for client object.
381 struct cl_object_header {
382 /** Standard lu_object_header. cl_object::co_lu::lo_header points
384 struct lu_object_header coh_lu;
386 * \todo XXX move locks below to the separate cache-lines, they are
387 * mostly useless otherwise.
390 /** Lock protecting page tree. */
391 cfs_spinlock_t coh_page_guard;
392 /** Lock protecting lock list. */
393 cfs_spinlock_t coh_lock_guard;
395 /** Radix tree of cl_page's, cached for this object. */
396 struct radix_tree_root coh_tree;
397 /** # of pages in radix tree. */
398 unsigned long coh_pages;
399 /** List of cl_lock's granted for this object. */
400 cfs_list_t coh_locks;
403 * Parent object. It is assumed that an object has a well-defined
404 * parent, but not a well-defined child (there may be multiple
405 * sub-objects, for the same top-object). cl_object_header::coh_parent
406 * field allows certain code to be written generically, without
407 * limiting possible cl_object layouts unduly.
409 struct cl_object_header *coh_parent;
411 * Protects consistency between cl_attr of parent object and
412 * attributes of sub-objects, that the former is calculated ("merged")
415 * \todo XXX this can be read/write lock if needed.
417 cfs_spinlock_t coh_attr_guard;
419 * Number of objects above this one: 0 for a top-object, 1 for its
422 unsigned coh_nesting;
426 * Helper macro: iterate over all layers of the object \a obj, assigning every
427 * layer top-to-bottom to \a slice.
429 #define cl_object_for_each(slice, obj) \
430 cfs_list_for_each_entry((slice), \
431 &(obj)->co_lu.lo_header->loh_layers, \
434 * Helper macro: iterate over all layers of the object \a obj, assigning every
435 * layer bottom-to-top to \a slice.
437 #define cl_object_for_each_reverse(slice, obj) \
438 cfs_list_for_each_entry_reverse((slice), \
439 &(obj)->co_lu.lo_header->loh_layers, \
444 #define pgoff_t unsigned long
447 #define CL_PAGE_EOF ((pgoff_t)~0ull)
449 /** \addtogroup cl_page cl_page
453 * Layered client page.
455 * cl_page: represents a portion of a file, cached in the memory. All pages
456 * of the given file are of the same size, and are kept in the radix tree
457 * hanging off the cl_object. cl_page doesn't fan out, but as sub-objects
458 * of the top-level file object are first class cl_objects, they have their
459 * own radix trees of pages and hence page is implemented as a sequence of
460 * struct cl_pages's, linked into double-linked list through
461 * cl_page::cp_parent and cl_page::cp_child pointers, each residing in the
462 * corresponding radix tree at the corresponding logical offset.
464 * cl_page is associated with VM page of the hosting environment (struct
465 * page in Linux kernel, for example), cfs_page_t. It is assumed, that this
466 * association is implemented by one of cl_page layers (top layer in the
467 * current design) that
469 * - intercepts per-VM-page call-backs made by the environment (e.g.,
472 * - translates state (page flag bits) and locking between lustre and
475 * The association between cl_page and cfs_page_t is immutable and
476 * established when cl_page is created.
478 * cl_page can be "owned" by a particular cl_io (see below), guaranteeing
479 * this io an exclusive access to this page w.r.t. other io attempts and
480 * various events changing page state (such as transfer completion, or
481 * eviction of the page from the memory). Note, that in general cl_io
482 * cannot be identified with a particular thread, and page ownership is not
483 * exactly equal to the current thread holding a lock on the page. Layer
484 * implementing association between cl_page and cfs_page_t has to implement
485 * ownership on top of available synchronization mechanisms.
487 * While lustre client maintains the notion of an page ownership by io,
488 * hosting MM/VM usually has its own page concurrency control
489 * mechanisms. For example, in Linux, page access is synchronized by the
490 * per-page PG_locked bit-lock, and generic kernel code (generic_file_*())
491 * takes care to acquire and release such locks as necessary around the
492 * calls to the file system methods (->readpage(), ->prepare_write(),
493 * ->commit_write(), etc.). This leads to the situation when there are two
494 * different ways to own a page in the client:
496 * - client code explicitly and voluntary owns the page (cl_page_own());
498 * - VM locks a page and then calls the client, that has "to assume"
499 * the ownership from the VM (cl_page_assume()).
501 * Dual methods to release ownership are cl_page_disown() and
502 * cl_page_unassume().
504 * cl_page is reference counted (cl_page::cp_ref). When reference counter
505 * drops to 0, the page is returned to the cache, unless it is in
506 * cl_page_state::CPS_FREEING state, in which case it is immediately
509 * The general logic guaranteeing the absence of "existential races" for
510 * pages is the following:
512 * - there are fixed known ways for a thread to obtain a new reference
515 * - by doing a lookup in the cl_object radix tree, protected by the
518 * - by starting from VM-locked cfs_page_t and following some
519 * hosting environment method (e.g., following ->private pointer in
520 * the case of Linux kernel), see cl_vmpage_page();
522 * - when the page enters cl_page_state::CPS_FREEING state, all these
523 * ways are severed with the proper synchronization
524 * (cl_page_delete());
526 * - entry into cl_page_state::CPS_FREEING is serialized by the VM page
529 * - no new references to the page in cl_page_state::CPS_FREEING state
530 * are allowed (checked in cl_page_get()).
532 * Together this guarantees that when last reference to a
533 * cl_page_state::CPS_FREEING page is released, it is safe to destroy the
534 * page, as neither references to it can be acquired at that point, nor
537 * cl_page is a state machine. States are enumerated in enum
538 * cl_page_state. Possible state transitions are enumerated in
539 * cl_page_state_set(). State transition process (i.e., actual changing of
540 * cl_page::cp_state field) is protected by the lock on the underlying VM
543 * Linux Kernel implementation.
545 * Binding between cl_page and cfs_page_t (which is a typedef for
546 * struct page) is implemented in the vvp layer. cl_page is attached to the
547 * ->private pointer of the struct page, together with the setting of
548 * PG_private bit in page->flags, and acquiring additional reference on the
549 * struct page (much like struct buffer_head, or any similar file system
550 * private data structures).
552 * PG_locked lock is used to implement both ownership and transfer
553 * synchronization, that is, page is VM-locked in CPS_{OWNED,PAGE{IN,OUT}}
554 * states. No additional references are acquired for the duration of the
557 * \warning *THIS IS NOT* the behavior expected by the Linux kernel, where
558 * write-out is "protected" by the special PG_writeback bit.
562 * States of cl_page. cl_page.c assumes particular order here.
564 * The page state machine is rather crude, as it doesn't recognize finer page
565 * states like "dirty" or "up to date". This is because such states are not
566 * always well defined for the whole stack (see, for example, the
567 * implementation of the read-ahead, that hides page up-to-dateness to track
568 * cache hits accurately). Such sub-states are maintained by the layers that
569 * are interested in them.
573 * Page is in the cache, un-owned. Page leaves cached state in the
576 * - [cl_page_state::CPS_OWNED] io comes across the page and
579 * - [cl_page_state::CPS_PAGEOUT] page is dirty, the
580 * req-formation engine decides that it wants to include this page
581 * into an cl_req being constructed, and yanks it from the cache;
583 * - [cl_page_state::CPS_FREEING] VM callback is executed to
584 * evict the page form the memory;
586 * \invariant cl_page::cp_owner == NULL && cl_page::cp_req == NULL
590 * Page is exclusively owned by some cl_io. Page may end up in this
591 * state as a result of
593 * - io creating new page and immediately owning it;
595 * - [cl_page_state::CPS_CACHED] io finding existing cached page
598 * - [cl_page_state::CPS_OWNED] io finding existing owned page
599 * and waiting for owner to release the page;
601 * Page leaves owned state in the following cases:
603 * - [cl_page_state::CPS_CACHED] io decides to leave the page in
604 * the cache, doing nothing;
606 * - [cl_page_state::CPS_PAGEIN] io starts read transfer for
609 * - [cl_page_state::CPS_PAGEOUT] io starts immediate write
610 * transfer for this page;
612 * - [cl_page_state::CPS_FREEING] io decides to destroy this
613 * page (e.g., as part of truncate or extent lock cancellation).
615 * \invariant cl_page::cp_owner != NULL && cl_page::cp_req == NULL
619 * Page is being written out, as a part of a transfer. This state is
620 * entered when req-formation logic decided that it wants this page to
621 * be sent through the wire _now_. Specifically, it means that once
622 * this state is achieved, transfer completion handler (with either
623 * success or failure indication) is guaranteed to be executed against
624 * this page independently of any locks and any scheduling decisions
625 * made by the hosting environment (that effectively means that the
626 * page is never put into cl_page_state::CPS_PAGEOUT state "in
627 * advance". This property is mentioned, because it is important when
628 * reasoning about possible dead-locks in the system). The page can
629 * enter this state as a result of
631 * - [cl_page_state::CPS_OWNED] an io requesting an immediate
632 * write-out of this page, or
634 * - [cl_page_state::CPS_CACHED] req-forming engine deciding
635 * that it has enough dirty pages cached to issue a "good"
638 * The page leaves cl_page_state::CPS_PAGEOUT state when the transfer
639 * is completed---it is moved into cl_page_state::CPS_CACHED state.
641 * Underlying VM page is locked for the duration of transfer.
643 * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req != NULL
647 * Page is being read in, as a part of a transfer. This is quite
648 * similar to the cl_page_state::CPS_PAGEOUT state, except that
649 * read-in is always "immediate"---there is no such thing a sudden
650 * construction of read cl_req from cached, presumably not up to date,
653 * Underlying VM page is locked for the duration of transfer.
655 * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req != NULL
659 * Page is being destroyed. This state is entered when client decides
660 * that page has to be deleted from its host object, as, e.g., a part
663 * Once this state is reached, there is no way to escape it.
665 * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req == NULL
672 /** Host page, the page is from the host inode which the cl_page
676 /** Transient page, the transient cl_page is used to bind a cl_page
677 * to vmpage which is not belonging to the same object of cl_page.
678 * it is used in DirectIO, lockless IO and liblustre. */
683 * Flags maintained for every cl_page.
687 * Set when pagein completes. Used for debugging (read completes at
688 * most once for a page).
690 CPF_READ_COMPLETED = 1 << 0
694 * Fields are protected by the lock on cfs_page_t, except for atomics and
697 * \invariant Data type invariants are in cl_page_invariant(). Basically:
698 * cl_page::cp_parent and cl_page::cp_child are a well-formed double-linked
699 * list, consistent with the parent/child pointers in the cl_page::cp_obj and
700 * cl_page::cp_owner (when set).
703 /** Reference counter. */
705 /** An object this page is a part of. Immutable after creation. */
706 struct cl_object *cp_obj;
707 /** Logical page index within the object. Immutable after creation. */
709 /** List of slices. Immutable after creation. */
710 cfs_list_t cp_layers;
711 /** Parent page, NULL for top-level page. Immutable after creation. */
712 struct cl_page *cp_parent;
713 /** Lower-layer page. NULL for bottommost page. Immutable after
715 struct cl_page *cp_child;
717 * Page state. This field is const to avoid accidental update, it is
718 * modified only internally within cl_page.c. Protected by a VM lock.
720 const enum cl_page_state cp_state;
721 /** Protect to get and put page, see cl_page_put and cl_vmpage_page */
722 cfs_spinlock_t cp_lock;
724 * Linkage of pages within some group. Protected by
725 * cl_page::cp_mutex. */
727 /** Mutex serializing membership of a page in a batch. */
728 cfs_mutex_t cp_mutex;
729 /** Linkage of pages within cl_req. */
730 cfs_list_t cp_flight;
731 /** Transfer error. */
735 * Page type. Only CPT_TRANSIENT is used so far. Immutable after
738 enum cl_page_type cp_type;
741 * Owning IO in cl_page_state::CPS_OWNED state. Sub-page can be owned
742 * by sub-io. Protected by a VM lock.
744 struct cl_io *cp_owner;
746 * Debug information, the task is owning the page.
750 * Owning IO request in cl_page_state::CPS_PAGEOUT and
751 * cl_page_state::CPS_PAGEIN states. This field is maintained only in
752 * the top-level pages. Protected by a VM lock.
754 struct cl_req *cp_req;
755 /** List of references to this page, for debugging. */
756 struct lu_ref cp_reference;
757 /** Link to an object, for debugging. */
758 struct lu_ref_link *cp_obj_ref;
759 /** Link to a queue, for debugging. */
760 struct lu_ref_link *cp_queue_ref;
761 /** Per-page flags from enum cl_page_flags. Protected by a VM lock. */
763 /** Assigned if doing a sync_io */
764 struct cl_sync_io *cp_sync_io;
768 * Per-layer part of cl_page.
770 * \see ccc_page, lov_page, osc_page
772 struct cl_page_slice {
773 struct cl_page *cpl_page;
775 * Object slice corresponding to this page slice. Immutable after
778 struct cl_object *cpl_obj;
779 const struct cl_page_operations *cpl_ops;
780 /** Linkage into cl_page::cp_layers. Immutable after creation. */
781 cfs_list_t cpl_linkage;
785 * Lock mode. For the client extent locks.
787 * \warning: cl_lock_mode_match() assumes particular ordering here.
792 * Mode of a lock that protects no data, and exists only as a
793 * placeholder. This is used for `glimpse' requests. A phantom lock
794 * might get promoted to real lock at some point.
803 * Requested transfer type.
813 * Per-layer page operations.
815 * Methods taking an \a io argument are for the activity happening in the
816 * context of given \a io. Page is assumed to be owned by that io, except for
817 * the obvious cases (like cl_page_operations::cpo_own()).
819 * \see vvp_page_ops, lov_page_ops, osc_page_ops
821 struct cl_page_operations {
823 * cl_page<->cfs_page_t methods. Only one layer in the stack has to
824 * implement these. Current code assumes that this functionality is
825 * provided by the topmost layer, see cl_page_disown0() as an example.
829 * \return the underlying VM page. Optional.
831 cfs_page_t *(*cpo_vmpage)(const struct lu_env *env,
832 const struct cl_page_slice *slice);
834 * Called when \a io acquires this page into the exclusive
835 * ownership. When this method returns, it is guaranteed that the is
836 * not owned by other io, and no transfer is going on against
840 * \see vvp_page_own(), lov_page_own()
842 int (*cpo_own)(const struct lu_env *env,
843 const struct cl_page_slice *slice,
844 struct cl_io *io, int nonblock);
845 /** Called when ownership it yielded. Optional.
847 * \see cl_page_disown()
848 * \see vvp_page_disown()
850 void (*cpo_disown)(const struct lu_env *env,
851 const struct cl_page_slice *slice, struct cl_io *io);
853 * Called for a page that is already "owned" by \a io from VM point of
856 * \see cl_page_assume()
857 * \see vvp_page_assume(), lov_page_assume()
859 void (*cpo_assume)(const struct lu_env *env,
860 const struct cl_page_slice *slice, struct cl_io *io);
861 /** Dual to cl_page_operations::cpo_assume(). Optional. Called
862 * bottom-to-top when IO releases a page without actually unlocking
865 * \see cl_page_unassume()
866 * \see vvp_page_unassume()
868 void (*cpo_unassume)(const struct lu_env *env,
869 const struct cl_page_slice *slice,
872 * Announces whether the page contains valid data or not by \a uptodate.
874 * \see cl_page_export()
875 * \see vvp_page_export()
877 void (*cpo_export)(const struct lu_env *env,
878 const struct cl_page_slice *slice, int uptodate);
880 * Unmaps page from the user space (if it is mapped).
882 * \see cl_page_unmap()
883 * \see vvp_page_unmap()
885 int (*cpo_unmap)(const struct lu_env *env,
886 const struct cl_page_slice *slice, struct cl_io *io);
888 * Checks whether underlying VM page is locked (in the suitable
889 * sense). Used for assertions.
891 * \retval -EBUSY: page is protected by a lock of a given mode;
892 * \retval -ENODATA: page is not protected by a lock;
893 * \retval 0: this layer cannot decide. (Should never happen.)
895 int (*cpo_is_vmlocked)(const struct lu_env *env,
896 const struct cl_page_slice *slice);
902 * Called when page is truncated from the object. Optional.
904 * \see cl_page_discard()
905 * \see vvp_page_discard(), osc_page_discard()
907 void (*cpo_discard)(const struct lu_env *env,
908 const struct cl_page_slice *slice,
911 * Called when page is removed from the cache, and is about to being
912 * destroyed. Optional.
914 * \see cl_page_delete()
915 * \see vvp_page_delete(), osc_page_delete()
917 void (*cpo_delete)(const struct lu_env *env,
918 const struct cl_page_slice *slice);
919 /** Destructor. Frees resources and slice itself. */
920 void (*cpo_fini)(const struct lu_env *env,
921 struct cl_page_slice *slice);
924 * Checks whether the page is protected by a cl_lock. This is a
925 * per-layer method, because certain layers have ways to check for the
926 * lock much more efficiently than through the generic locks scan, or
927 * implement locking mechanisms separate from cl_lock, e.g.,
928 * LL_FILE_GROUP_LOCKED in vvp. If \a pending is true, check for locks
929 * being canceled, or scheduled for cancellation as soon as the last
930 * user goes away, too.
932 * \retval -EBUSY: page is protected by a lock of a given mode;
933 * \retval -ENODATA: page is not protected by a lock;
934 * \retval 0: this layer cannot decide.
936 * \see cl_page_is_under_lock()
938 int (*cpo_is_under_lock)(const struct lu_env *env,
939 const struct cl_page_slice *slice,
943 * Optional debugging helper. Prints given page slice.
945 * \see cl_page_print()
947 int (*cpo_print)(const struct lu_env *env,
948 const struct cl_page_slice *slice,
949 void *cookie, lu_printer_t p);
953 * Transfer methods. See comment on cl_req for a description of
954 * transfer formation and life-cycle.
959 * Request type dependent vector of operations.
961 * Transfer operations depend on transfer mode (cl_req_type). To avoid
962 * passing transfer mode to each and every of these methods, and to
963 * avoid branching on request type inside of the methods, separate
964 * methods for cl_req_type:CRT_READ and cl_req_type:CRT_WRITE are
965 * provided. That is, method invocation usually looks like
967 * slice->cp_ops.io[req->crq_type].cpo_method(env, slice, ...);
971 * Called when a page is submitted for a transfer as a part of
974 * \return 0 : page is eligible for submission;
975 * \return -EALREADY : skip this page;
976 * \return -ve : error.
978 * \see cl_page_prep()
980 int (*cpo_prep)(const struct lu_env *env,
981 const struct cl_page_slice *slice,
984 * Completion handler. This is guaranteed to be eventually
985 * fired after cl_page_operations::cpo_prep() or
986 * cl_page_operations::cpo_make_ready() call.
988 * This method can be called in a non-blocking context. It is
989 * guaranteed however, that the page involved and its object
990 * are pinned in memory (and, hence, calling cl_page_put() is
993 * \see cl_page_completion()
995 void (*cpo_completion)(const struct lu_env *env,
996 const struct cl_page_slice *slice,
999 * Called when cached page is about to be added to the
1000 * cl_req as a part of req formation.
1002 * \return 0 : proceed with this page;
1003 * \return -EAGAIN : skip this page;
1004 * \return -ve : error.
1006 * \see cl_page_make_ready()
1008 int (*cpo_make_ready)(const struct lu_env *env,
1009 const struct cl_page_slice *slice);
1011 * Announce that this page is to be written out
1012 * opportunistically, that is, page is dirty, it is not
1013 * necessary to start write-out transfer right now, but
1014 * eventually page has to be written out.
1016 * Main caller of this is the write path (see
1017 * vvp_io_commit_write()), using this method to build a
1018 * "transfer cache" from which large transfers are then
1019 * constructed by the req-formation engine.
1021 * \todo XXX it would make sense to add page-age tracking
1022 * semantics here, and to oblige the req-formation engine to
1023 * send the page out not later than it is too old.
1025 * \see cl_page_cache_add()
1027 int (*cpo_cache_add)(const struct lu_env *env,
1028 const struct cl_page_slice *slice,
1032 * Tell transfer engine that only [to, from] part of a page should be
1035 * This is used for immediate transfers.
1037 * \todo XXX this is not very good interface. It would be much better
1038 * if all transfer parameters were supplied as arguments to
1039 * cl_io_operations::cio_submit() call, but it is not clear how to do
1040 * this for page queues.
1042 * \see cl_page_clip()
1044 void (*cpo_clip)(const struct lu_env *env,
1045 const struct cl_page_slice *slice,
1048 * \pre the page was queued for transferring.
1049 * \post page is removed from client's pending list, or -EBUSY
1050 * is returned if it has already been in transferring.
1052 * This is one of seldom page operation which is:
1053 * 0. called from top level;
1054 * 1. don't have vmpage locked;
1055 * 2. every layer should synchronize execution of its ->cpo_cancel()
1056 * with completion handlers. Osc uses client obd lock for this
1057 * purpose. Based on there is no vvp_page_cancel and
1058 * lov_page_cancel(), cpo_cancel is defacto protected by client lock.
1060 * \see osc_page_cancel().
1062 int (*cpo_cancel)(const struct lu_env *env,
1063 const struct cl_page_slice *slice);
1065 * Write out a page by kernel. This is only called by ll_writepage
1068 * \see cl_page_flush()
1070 int (*cpo_flush)(const struct lu_env *env,
1071 const struct cl_page_slice *slice,
1077 * Helper macro, dumping detailed information about \a page into a log.
1079 #define CL_PAGE_DEBUG(mask, env, page, format, ...) \
1081 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL); \
1083 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
1084 cl_page_print(env, &msgdata, lu_cdebug_printer, page); \
1085 CDEBUG(mask, format , ## __VA_ARGS__); \
1090 * Helper macro, dumping shorter information about \a page into a log.
1092 #define CL_PAGE_HEADER(mask, env, page, format, ...) \
1094 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL); \
1096 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
1097 cl_page_header_print(env, &msgdata, lu_cdebug_printer, page); \
1098 CDEBUG(mask, format , ## __VA_ARGS__); \
1104 /** \addtogroup cl_lock cl_lock
1108 * Extent locking on the client.
1112 * The locking model of the new client code is built around
1116 * data-type representing an extent lock on a regular file. cl_lock is a
1117 * layered object (much like cl_object and cl_page), it consists of a header
1118 * (struct cl_lock) and a list of layers (struct cl_lock_slice), linked to
1119 * cl_lock::cll_layers list through cl_lock_slice::cls_linkage.
1121 * All locks for a given object are linked into cl_object_header::coh_locks
1122 * list (protected by cl_object_header::coh_lock_guard spin-lock) through
1123 * cl_lock::cll_linkage. Currently this list is not sorted in any way. We can
1124 * sort it in starting lock offset, or use altogether different data structure
1127 * Typical cl_lock consists of the two layers:
1129 * - vvp_lock (vvp specific data), and
1130 * - lov_lock (lov specific data).
1132 * lov_lock contains an array of sub-locks. Each of these sub-locks is a
1133 * normal cl_lock: it has a header (struct cl_lock) and a list of layers:
1135 * - lovsub_lock, and
1138 * Each sub-lock is associated with a cl_object (representing stripe
1139 * sub-object or the file to which top-level cl_lock is associated to), and is
1140 * linked into that cl_object::coh_locks. In this respect cl_lock is similar to
1141 * cl_object (that at lov layer also fans out into multiple sub-objects), and
1142 * is different from cl_page, that doesn't fan out (there is usually exactly
1143 * one osc_page for every vvp_page). We shall call vvp-lov portion of the lock
1144 * a "top-lock" and its lovsub-osc portion a "sub-lock".
1148 * cl_lock is reference counted. When reference counter drops to 0, lock is
1149 * placed in the cache, except when lock is in CLS_FREEING state. CLS_FREEING
1150 * lock is destroyed when last reference is released. Referencing between
1151 * top-lock and its sub-locks is described in the lov documentation module.
1155 * Also, cl_lock is a state machine. This requires some clarification. One of
1156 * the goals of client IO re-write was to make IO path non-blocking, or at
1157 * least to make it easier to make it non-blocking in the future. Here
1158 * `non-blocking' means that when a system call (read, write, truncate)
1159 * reaches a situation where it has to wait for a communication with the
1160 * server, it should --instead of waiting-- remember its current state and
1161 * switch to some other work. E.g,. instead of waiting for a lock enqueue,
1162 * client should proceed doing IO on the next stripe, etc. Obviously this is
1163 * rather radical redesign, and it is not planned to be fully implemented at
1164 * this time, instead we are putting some infrastructure in place, that would
1165 * make it easier to do asynchronous non-blocking IO easier in the
1166 * future. Specifically, where old locking code goes to sleep (waiting for
1167 * enqueue, for example), new code returns cl_lock_transition::CLO_WAIT. When
1168 * enqueue reply comes, its completion handler signals that lock state-machine
1169 * is ready to transit to the next state. There is some generic code in
1170 * cl_lock.c that sleeps, waiting for these signals. As a result, for users of
1171 * this cl_lock.c code, it looks like locking is done in normal blocking
1172 * fashion, and it the same time it is possible to switch to the non-blocking
1173 * locking (simply by returning cl_lock_transition::CLO_WAIT from cl_lock.c
1176 * For a description of state machine states and transitions see enum
1179 * There are two ways to restrict a set of states which lock might move to:
1181 * - placing a "hold" on a lock guarantees that lock will not be moved
1182 * into cl_lock_state::CLS_FREEING state until hold is released. Hold
1183 * can be only acquired on a lock that is not in
1184 * cl_lock_state::CLS_FREEING. All holds on a lock are counted in
1185 * cl_lock::cll_holds. Hold protects lock from cancellation and
1186 * destruction. Requests to cancel and destroy a lock on hold will be
1187 * recorded, but only honored when last hold on a lock is released;
1189 * - placing a "user" on a lock guarantees that lock will not leave
1190 * cl_lock_state::CLS_NEW, cl_lock_state::CLS_QUEUING,
1191 * cl_lock_state::CLS_ENQUEUED and cl_lock_state::CLS_HELD set of
1192 * states, once it enters this set. That is, if a user is added onto a
1193 * lock in a state not from this set, it doesn't immediately enforce
1194 * lock to move to this set, but once lock enters this set it will
1195 * remain there until all users are removed. Lock users are counted in
1196 * cl_lock::cll_users.
1198 * User is used to assure that lock is not canceled or destroyed while
1199 * it is being enqueued, or actively used by some IO.
1201 * Currently, a user always comes with a hold (cl_lock_invariant()
1202 * checks that a number of holds is not less than a number of users).
1206 * This is how lock state-machine operates. struct cl_lock contains a mutex
1207 * cl_lock::cll_guard that protects struct fields.
1209 * - mutex is taken, and cl_lock::cll_state is examined.
1211 * - for every state there are possible target states where lock can move
1212 * into. They are tried in order. Attempts to move into next state are
1213 * done by _try() functions in cl_lock.c:cl_{enqueue,unlock,wait}_try().
1215 * - if the transition can be performed immediately, state is changed,
1216 * and mutex is released.
1218 * - if the transition requires blocking, _try() function returns
1219 * cl_lock_transition::CLO_WAIT. Caller unlocks mutex and goes to
1220 * sleep, waiting for possibility of lock state change. It is woken
1221 * up when some event occurs, that makes lock state change possible
1222 * (e.g., the reception of the reply from the server), and repeats
1225 * Top-lock and sub-lock has separate mutexes and the latter has to be taken
1226 * first to avoid dead-lock.
1228 * To see an example of interaction of all these issues, take a look at the
1229 * lov_cl.c:lov_lock_enqueue() function. It is called as a part of
1230 * cl_enqueue_try(), and tries to advance top-lock to ENQUEUED state, by
1231 * advancing state-machines of its sub-locks (lov_lock_enqueue_one()). Note
1232 * also, that it uses trylock to grab sub-lock mutex to avoid dead-lock. It
1233 * also has to handle CEF_ASYNC enqueue, when sub-locks enqueues have to be
1234 * done in parallel, rather than one after another (this is used for glimpse
1235 * locks, that cannot dead-lock).
1237 * INTERFACE AND USAGE
1239 * struct cl_lock_operations provide a number of call-backs that are invoked
1240 * when events of interest occurs. Layers can intercept and handle glimpse,
1241 * blocking, cancel ASTs and a reception of the reply from the server.
1243 * One important difference with the old client locking model is that new
1244 * client has a representation for the top-lock, whereas in the old code only
1245 * sub-locks existed as real data structures and file-level locks are
1246 * represented by "request sets" that are created and destroyed on each and
1247 * every lock creation.
1249 * Top-locks are cached, and can be found in the cache by the system calls. It
1250 * is possible that top-lock is in cache, but some of its sub-locks were
1251 * canceled and destroyed. In that case top-lock has to be enqueued again
1252 * before it can be used.
1254 * Overall process of the locking during IO operation is as following:
1256 * - once parameters for IO are setup in cl_io, cl_io_operations::cio_lock()
1257 * is called on each layer. Responsibility of this method is to add locks,
1258 * needed by a given layer into cl_io.ci_lockset.
1260 * - once locks for all layers were collected, they are sorted to avoid
1261 * dead-locks (cl_io_locks_sort()), and enqueued.
1263 * - when all locks are acquired, IO is performed;
1265 * - locks are released into cache.
1267 * Striping introduces major additional complexity into locking. The
1268 * fundamental problem is that it is generally unsafe to actively use (hold)
1269 * two locks on the different OST servers at the same time, as this introduces
1270 * inter-server dependency and can lead to cascading evictions.
1272 * Basic solution is to sub-divide large read/write IOs into smaller pieces so
1273 * that no multi-stripe locks are taken (note that this design abandons POSIX
1274 * read/write semantics). Such pieces ideally can be executed concurrently. At
1275 * the same time, certain types of IO cannot be sub-divived, without
1276 * sacrificing correctness. This includes:
1278 * - O_APPEND write, where [0, EOF] lock has to be taken, to guarantee
1281 * - ftruncate(fd, offset), where [offset, EOF] lock has to be taken.
1283 * Also, in the case of read(fd, buf, count) or write(fd, buf, count), where
1284 * buf is a part of memory mapped Lustre file, a lock or locks protecting buf
1285 * has to be held together with the usual lock on [offset, offset + count].
1287 * As multi-stripe locks have to be allowed, it makes sense to cache them, so
1288 * that, for example, a sequence of O_APPEND writes can proceed quickly
1289 * without going down to the individual stripes to do lock matching. On the
1290 * other hand, multi-stripe locks shouldn't be used by normal read/write
1291 * calls. To achieve this, every layer can implement ->clo_fits_into() method,
1292 * that is called by lock matching code (cl_lock_lookup()), and that can be
1293 * used to selectively disable matching of certain locks for certain IOs. For
1294 * exmaple, lov layer implements lov_lock_fits_into() that allow multi-stripe
1295 * locks to be matched only for truncates and O_APPEND writes.
1297 * Interaction with DLM
1299 * In the expected setup, cl_lock is ultimately backed up by a collection of
1300 * DLM locks (struct ldlm_lock). Association between cl_lock and DLM lock is
1301 * implemented in osc layer, that also matches DLM events (ASTs, cancellation,
1302 * etc.) into cl_lock_operation calls. See struct osc_lock for a more detailed
1303 * description of interaction with DLM.
1309 struct cl_lock_descr {
1310 /** Object this lock is granted for. */
1311 struct cl_object *cld_obj;
1312 /** Index of the first page protected by this lock. */
1314 /** Index of the last page (inclusive) protected by this lock. */
1316 /** Group ID, for group lock */
1319 enum cl_lock_mode cld_mode;
1321 * flags to enqueue lock. A combination of bit-flags from
1322 * enum cl_enq_flags.
1324 __u32 cld_enq_flags;
1327 #define DDESCR "%s(%d):[%lu, %lu]"
1328 #define PDESCR(descr) \
1329 cl_lock_mode_name((descr)->cld_mode), (descr)->cld_mode, \
1330 (descr)->cld_start, (descr)->cld_end
1332 const char *cl_lock_mode_name(const enum cl_lock_mode mode);
1335 * Lock state-machine states.
1340 * Possible state transitions:
1342 * +------------------>NEW
1344 * | | cl_enqueue_try()
1346 * | cl_unuse_try() V
1347 * | +--------------QUEUING (*)
1349 * | | | cl_enqueue_try()
1351 * | | cl_unuse_try() V
1352 * sub-lock | +-------------ENQUEUED (*)
1354 * | | | cl_wait_try()
1359 * | | HELD<---------+
1361 * | | | | cl_use_try()
1362 * | | cl_unuse_try() | |
1365 * | +------------>INTRANSIT (D) <--+
1367 * | cl_unuse_try() | | cached lock found
1368 * | | | cl_use_try()
1371 * +------------------CACHED---------+
1380 * In states marked with (*) transition to the same state (i.e., a loop
1381 * in the diagram) is possible.
1383 * (R) is the point where Receive call-back is invoked: it allows layers
1384 * to handle arrival of lock reply.
1386 * (C) is the point where Cancellation call-back is invoked.
1388 * (D) is the transit state which means the lock is changing.
1390 * Transition to FREEING state is possible from any other state in the
1391 * diagram in case of unrecoverable error.
1395 * These states are for individual cl_lock object. Top-lock and its sub-locks
1396 * can be in the different states. Another way to say this is that we have
1397 * nested state-machines.
1399 * Separate QUEUING and ENQUEUED states are needed to support non-blocking
1400 * operation for locks with multiple sub-locks. Imagine lock on a file F, that
1401 * intersects 3 stripes S0, S1, and S2. To enqueue F client has to send
1402 * enqueue to S0, wait for its completion, then send enqueue for S1, wait for
1403 * its completion and at last enqueue lock for S2, and wait for its
1404 * completion. In that case, top-lock is in QUEUING state while S0, S1 are
1405 * handled, and is in ENQUEUED state after enqueue to S2 has been sent (note
1406 * that in this case, sub-locks move from state to state, and top-lock remains
1407 * in the same state).
1409 enum cl_lock_state {
1411 * Lock that wasn't yet enqueued
1415 * Enqueue is in progress, blocking for some intermediate interaction
1416 * with the other side.
1420 * Lock is fully enqueued, waiting for server to reply when it is
1425 * Lock granted, actively used by some IO.
1429 * This state is used to mark the lock is being used, or unused.
1430 * We need this state because the lock may have several sublocks,
1431 * so it's impossible to have an atomic way to bring all sublocks
1432 * into CLS_HELD state at use case, or all sublocks to CLS_CACHED
1434 * If a thread is referring to a lock, and it sees the lock is in this
1435 * state, it must wait for the lock.
1436 * See state diagram for details.
1440 * Lock granted, not used.
1444 * Lock is being destroyed.
1450 enum cl_lock_flags {
1452 * lock has been cancelled. This flag is never cleared once set (by
1453 * cl_lock_cancel0()).
1455 CLF_CANCELLED = 1 << 0,
1456 /** cancellation is pending for this lock. */
1457 CLF_CANCELPEND = 1 << 1,
1458 /** destruction is pending for this lock. */
1459 CLF_DOOMED = 1 << 2,
1460 /** from enqueue RPC reply upcall. */
1461 CLF_FROM_UPCALL= 1 << 3,
1467 * Lock closure is a collection of locks (both top-locks and sub-locks) that
1468 * might be updated in a result of an operation on a certain lock (which lock
1469 * this is a closure of).
1471 * Closures are needed to guarantee dead-lock freedom in the presence of
1473 * - nested state-machines (top-lock state-machine composed of sub-lock
1474 * state-machines), and
1476 * - shared sub-locks.
1478 * Specifically, many operations, such as lock enqueue, wait, unlock,
1479 * etc. start from a top-lock, and then operate on a sub-locks of this
1480 * top-lock, holding a top-lock mutex. When sub-lock state changes as a result
1481 * of such operation, this change has to be propagated to all top-locks that
1482 * share this sub-lock. Obviously, no natural lock ordering (e.g.,
1483 * top-to-bottom or bottom-to-top) captures this scenario, so try-locking has
1484 * to be used. Lock closure systematizes this try-and-repeat logic.
1486 struct cl_lock_closure {
1488 * Lock that is mutexed when closure construction is started. When
1489 * closure in is `wait' mode (cl_lock_closure::clc_wait), mutex on
1490 * origin is released before waiting.
1492 struct cl_lock *clc_origin;
1494 * List of enclosed locks, so far. Locks are linked here through
1495 * cl_lock::cll_inclosure.
1497 cfs_list_t clc_list;
1499 * True iff closure is in a `wait' mode. This determines what
1500 * cl_lock_enclosure() does when a lock L to be added to the closure
1501 * is currently mutexed by some other thread.
1503 * If cl_lock_closure::clc_wait is not set, then closure construction
1504 * fails with CLO_REPEAT immediately.
1506 * In wait mode, cl_lock_enclosure() waits until next attempt to build
1507 * a closure might succeed. To this end it releases an origin mutex
1508 * (cl_lock_closure::clc_origin), that has to be the only lock mutex
1509 * owned by the current thread, and then waits on L mutex (by grabbing
1510 * it and immediately releasing), before returning CLO_REPEAT to the
1514 /** Number of locks in the closure. */
1519 * Layered client lock.
1522 /** Reference counter. */
1523 cfs_atomic_t cll_ref;
1524 /** List of slices. Immutable after creation. */
1525 cfs_list_t cll_layers;
1527 * Linkage into cl_lock::cll_descr::cld_obj::coh_locks list. Protected
1528 * by cl_lock::cll_descr::cld_obj::coh_lock_guard.
1530 cfs_list_t cll_linkage;
1532 * Parameters of this lock. Protected by
1533 * cl_lock::cll_descr::cld_obj::coh_lock_guard nested within
1534 * cl_lock::cll_guard. Modified only on lock creation and in
1537 struct cl_lock_descr cll_descr;
1538 /** Protected by cl_lock::cll_guard. */
1539 enum cl_lock_state cll_state;
1540 /** signals state changes. */
1543 * Recursive lock, most fields in cl_lock{} are protected by this.
1545 * Locking rules: this mutex is never held across network
1546 * communication, except when lock is being canceled.
1548 * Lock ordering: a mutex of a sub-lock is taken first, then a mutex
1549 * on a top-lock. Other direction is implemented through a
1550 * try-lock-repeat loop. Mutices of unrelated locks can be taken only
1553 * \see osc_lock_enqueue_wait(), lov_lock_cancel(), lov_sublock_wait().
1555 cfs_mutex_t cll_guard;
1556 cfs_task_t *cll_guarder;
1560 * the owner for INTRANSIT state
1562 cfs_task_t *cll_intransit_owner;
1565 * Number of holds on a lock. A hold prevents a lock from being
1566 * canceled and destroyed. Protected by cl_lock::cll_guard.
1568 * \see cl_lock_hold(), cl_lock_unhold(), cl_lock_release()
1572 * Number of lock users. Valid in cl_lock_state::CLS_HELD state
1573 * only. Lock user pins lock in CLS_HELD state. Protected by
1574 * cl_lock::cll_guard.
1576 * \see cl_wait(), cl_unuse().
1580 * Flag bit-mask. Values from enum cl_lock_flags. Updates are
1581 * protected by cl_lock::cll_guard.
1583 unsigned long cll_flags;
1585 * A linkage into a list of locks in a closure.
1587 * \see cl_lock_closure
1589 cfs_list_t cll_inclosure;
1591 * Confict lock at queuing time.
1593 struct cl_lock *cll_conflict;
1595 * A list of references to this lock, for debugging.
1597 struct lu_ref cll_reference;
1599 * A list of holds on this lock, for debugging.
1601 struct lu_ref cll_holders;
1603 * A reference for cl_lock::cll_descr::cld_obj. For debugging.
1605 struct lu_ref_link *cll_obj_ref;
1606 #ifdef CONFIG_LOCKDEP
1607 /* "dep_map" name is assumed by lockdep.h macros. */
1608 struct lockdep_map dep_map;
1613 * Per-layer part of cl_lock
1615 * \see ccc_lock, lov_lock, lovsub_lock, osc_lock
1617 struct cl_lock_slice {
1618 struct cl_lock *cls_lock;
1619 /** Object slice corresponding to this lock slice. Immutable after
1621 struct cl_object *cls_obj;
1622 const struct cl_lock_operations *cls_ops;
1623 /** Linkage into cl_lock::cll_layers. Immutable after creation. */
1624 cfs_list_t cls_linkage;
1628 * Possible (non-error) return values of ->clo_{enqueue,wait,unlock}().
1630 * NOTE: lov_subresult() depends on ordering here.
1632 enum cl_lock_transition {
1633 /** operation cannot be completed immediately. Wait for state change. */
1635 /** operation had to release lock mutex, restart. */
1637 /** lower layer re-enqueued. */
1643 * \see vvp_lock_ops, lov_lock_ops, lovsub_lock_ops, osc_lock_ops
1645 struct cl_lock_operations {
1647 * \name statemachine
1649 * State machine transitions. These 3 methods are called to transfer
1650 * lock from one state to another, as described in the commentary
1651 * above enum #cl_lock_state.
1653 * \retval 0 this layer has nothing more to do to before
1654 * transition to the target state happens;
1656 * \retval CLO_REPEAT method had to release and re-acquire cl_lock
1657 * mutex, repeat invocation of transition method
1658 * across all layers;
1660 * \retval CLO_WAIT this layer cannot move to the target state
1661 * immediately, as it has to wait for certain event
1662 * (e.g., the communication with the server). It
1663 * is guaranteed, that when the state transfer
1664 * becomes possible, cl_lock::cll_wq wait-queue
1665 * is signaled. Caller can wait for this event by
1666 * calling cl_lock_state_wait();
1668 * \retval -ve failure, abort state transition, move the lock
1669 * into cl_lock_state::CLS_FREEING state, and set
1670 * cl_lock::cll_error.
1672 * Once all layers voted to agree to transition (by returning 0), lock
1673 * is moved into corresponding target state. All state transition
1674 * methods are optional.
1678 * Attempts to enqueue the lock. Called top-to-bottom.
1680 * \see ccc_lock_enqueue(), lov_lock_enqueue(), lovsub_lock_enqueue(),
1681 * \see osc_lock_enqueue()
1683 int (*clo_enqueue)(const struct lu_env *env,
1684 const struct cl_lock_slice *slice,
1685 struct cl_io *io, __u32 enqflags);
1687 * Attempts to wait for enqueue result. Called top-to-bottom.
1689 * \see ccc_lock_wait(), lov_lock_wait(), osc_lock_wait()
1691 int (*clo_wait)(const struct lu_env *env,
1692 const struct cl_lock_slice *slice);
1694 * Attempts to unlock the lock. Called bottom-to-top. In addition to
1695 * usual return values of lock state-machine methods, this can return
1696 * -ESTALE to indicate that lock cannot be returned to the cache, and
1697 * has to be re-initialized.
1698 * unuse is a one-shot operation, so it must NOT return CLO_WAIT.
1700 * \see ccc_lock_unuse(), lov_lock_unuse(), osc_lock_unuse()
1702 int (*clo_unuse)(const struct lu_env *env,
1703 const struct cl_lock_slice *slice);
1705 * Notifies layer that cached lock is started being used.
1707 * \pre lock->cll_state == CLS_CACHED
1709 * \see lov_lock_use(), osc_lock_use()
1711 int (*clo_use)(const struct lu_env *env,
1712 const struct cl_lock_slice *slice);
1713 /** @} statemachine */
1715 * A method invoked when lock state is changed (as a result of state
1716 * transition). This is used, for example, to track when the state of
1717 * a sub-lock changes, to propagate this change to the corresponding
1718 * top-lock. Optional
1720 * \see lovsub_lock_state()
1722 void (*clo_state)(const struct lu_env *env,
1723 const struct cl_lock_slice *slice,
1724 enum cl_lock_state st);
1726 * Returns true, iff given lock is suitable for the given io, idea
1727 * being, that there are certain "unsafe" locks, e.g., ones acquired
1728 * for O_APPEND writes, that we don't want to re-use for a normal
1729 * write, to avoid the danger of cascading evictions. Optional. Runs
1730 * under cl_object_header::coh_lock_guard.
1732 * XXX this should take more information about lock needed by
1733 * io. Probably lock description or something similar.
1735 * \see lov_fits_into()
1737 int (*clo_fits_into)(const struct lu_env *env,
1738 const struct cl_lock_slice *slice,
1739 const struct cl_lock_descr *need,
1740 const struct cl_io *io);
1743 * Asynchronous System Traps. All of then are optional, all are
1744 * executed bottom-to-top.
1749 * Cancellation callback. Cancel a lock voluntarily, or under
1750 * the request of server.
1752 void (*clo_cancel)(const struct lu_env *env,
1753 const struct cl_lock_slice *slice);
1755 * Lock weighting ast. Executed to estimate how precious this lock
1756 * is. The sum of results across all layers is used to determine
1757 * whether lock worth keeping in cache given present memory usage.
1759 * \see osc_lock_weigh(), vvp_lock_weigh(), lovsub_lock_weigh().
1761 unsigned long (*clo_weigh)(const struct lu_env *env,
1762 const struct cl_lock_slice *slice);
1766 * \see lovsub_lock_closure()
1768 int (*clo_closure)(const struct lu_env *env,
1769 const struct cl_lock_slice *slice,
1770 struct cl_lock_closure *closure);
1772 * Executed bottom-to-top when lock description changes (e.g., as a
1773 * result of server granting more generous lock than was requested).
1775 * \see lovsub_lock_modify()
1777 int (*clo_modify)(const struct lu_env *env,
1778 const struct cl_lock_slice *slice,
1779 const struct cl_lock_descr *updated);
1781 * Notifies layers (bottom-to-top) that lock is going to be
1782 * destroyed. Responsibility of layers is to prevent new references on
1783 * this lock from being acquired once this method returns.
1785 * This can be called multiple times due to the races.
1787 * \see cl_lock_delete()
1788 * \see osc_lock_delete(), lovsub_lock_delete()
1790 void (*clo_delete)(const struct lu_env *env,
1791 const struct cl_lock_slice *slice);
1793 * Destructor. Frees resources and the slice.
1795 * \see ccc_lock_fini(), lov_lock_fini(), lovsub_lock_fini(),
1796 * \see osc_lock_fini()
1798 void (*clo_fini)(const struct lu_env *env, struct cl_lock_slice *slice);
1800 * Optional debugging helper. Prints given lock slice.
1802 int (*clo_print)(const struct lu_env *env,
1803 void *cookie, lu_printer_t p,
1804 const struct cl_lock_slice *slice);
1807 #define CL_LOCK_DEBUG(mask, env, lock, format, ...) \
1809 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL); \
1811 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
1812 cl_lock_print(env, &msgdata, lu_cdebug_printer, lock); \
1813 CDEBUG(mask, format , ## __VA_ARGS__); \
1817 #define CL_LOCK_ASSERT(expr, env, lock) do { \
1821 CL_LOCK_DEBUG(D_ERROR, env, lock, "failed at %s.\n", #expr); \
1827 /** \addtogroup cl_page_list cl_page_list
1828 * Page list used to perform collective operations on a group of pages.
1830 * Pages are added to the list one by one. cl_page_list acquires a reference
1831 * for every page in it. Page list is used to perform collective operations on
1834 * - submit pages for an immediate transfer,
1836 * - own pages on behalf of certain io (waiting for each page in turn),
1840 * When list is finalized, it releases references on all pages it still has.
1842 * \todo XXX concurrency control.
1846 struct cl_page_list {
1848 cfs_list_t pl_pages;
1849 cfs_task_t *pl_owner;
1853 * A 2-queue of pages. A convenience data-type for common use case, 2-queue
1854 * contains an incoming page list and an outgoing page list.
1857 struct cl_page_list c2_qin;
1858 struct cl_page_list c2_qout;
1861 /** @} cl_page_list */
1863 /** \addtogroup cl_io cl_io
1868 * cl_io represents a high level I/O activity like
1869 * read(2)/write(2)/truncate(2) system call, or cancellation of an extent
1872 * cl_io is a layered object, much like cl_{object,page,lock} but with one
1873 * important distinction. We want to minimize number of calls to the allocator
1874 * in the fast path, e.g., in the case of read(2) when everything is cached:
1875 * client already owns the lock over region being read, and data are cached
1876 * due to read-ahead. To avoid allocation of cl_io layers in such situations,
1877 * per-layer io state is stored in the session, associated with the io, see
1878 * struct {vvp,lov,osc}_io for example. Sessions allocation is amortized
1879 * by using free-lists, see cl_env_get().
1881 * There is a small predefined number of possible io types, enumerated in enum
1884 * cl_io is a state machine, that can be advanced concurrently by the multiple
1885 * threads. It is up to these threads to control the concurrency and,
1886 * specifically, to detect when io is done, and its state can be safely
1889 * For read/write io overall execution plan is as following:
1891 * (0) initialize io state through all layers;
1893 * (1) loop: prepare chunk of work to do
1895 * (2) call all layers to collect locks they need to process current chunk
1897 * (3) sort all locks to avoid dead-locks, and acquire them
1899 * (4) process the chunk: call per-page methods
1900 * (cl_io_operations::cio_read_page() for read,
1901 * cl_io_operations::cio_prepare_write(),
1902 * cl_io_operations::cio_commit_write() for write)
1908 * To implement the "parallel IO mode", lov layer creates sub-io's (lazily to
1909 * address allocation efficiency issues mentioned above), and returns with the
1910 * special error condition from per-page method when current sub-io has to
1911 * block. This causes io loop to be repeated, and lov switches to the next
1912 * sub-io in its cl_io_operations::cio_iter_init() implementation.
1917 /** read system call */
1919 /** write system call */
1921 /** truncate, utime system calls */
1924 * page fault handling
1928 * fsync system call handling
1929 * To write out a range of file
1933 * Miscellaneous io. This is used for occasional io activity that
1934 * doesn't fit into other types. Currently this is used for:
1936 * - cancellation of an extent lock. This io exists as a context
1937 * to write dirty pages from under the lock being canceled back
1940 * - VM induced page write-out. An io context for writing page out
1941 * for memory cleansing;
1943 * - glimpse. An io context to acquire glimpse lock.
1945 * - grouplock. An io context to acquire group lock.
1947 * CIT_MISC io is used simply as a context in which locks and pages
1948 * are manipulated. Such io has no internal "process", that is,
1949 * cl_io_loop() is never called for it.
1956 * States of cl_io state machine
1959 /** Not initialized. */
1963 /** IO iteration started. */
1967 /** Actual IO is in progress. */
1969 /** IO for the current iteration finished. */
1971 /** Locks released. */
1973 /** Iteration completed. */
1975 /** cl_io finalized. */
1980 * IO state private for a layer.
1982 * This is usually embedded into layer session data, rather than allocated
1985 * \see vvp_io, lov_io, osc_io, ccc_io
1987 struct cl_io_slice {
1988 struct cl_io *cis_io;
1989 /** corresponding object slice. Immutable after creation. */
1990 struct cl_object *cis_obj;
1991 /** io operations. Immutable after creation. */
1992 const struct cl_io_operations *cis_iop;
1994 * linkage into a list of all slices for a given cl_io, hanging off
1995 * cl_io::ci_layers. Immutable after creation.
1997 cfs_list_t cis_linkage;
2002 * Per-layer io operations.
2003 * \see vvp_io_ops, lov_io_ops, lovsub_io_ops, osc_io_ops
2005 struct cl_io_operations {
2007 * Vector of io state transition methods for every io type.
2009 * \see cl_page_operations::io
2013 * Prepare io iteration at a given layer.
2015 * Called top-to-bottom at the beginning of each iteration of
2016 * "io loop" (if it makes sense for this type of io). Here
2017 * layer selects what work it will do during this iteration.
2019 * \see cl_io_operations::cio_iter_fini()
2021 int (*cio_iter_init) (const struct lu_env *env,
2022 const struct cl_io_slice *slice);
2024 * Finalize io iteration.
2026 * Called bottom-to-top at the end of each iteration of "io
2027 * loop". Here layers can decide whether IO has to be
2030 * \see cl_io_operations::cio_iter_init()
2032 void (*cio_iter_fini) (const struct lu_env *env,
2033 const struct cl_io_slice *slice);
2035 * Collect locks for the current iteration of io.
2037 * Called top-to-bottom to collect all locks necessary for
2038 * this iteration. This methods shouldn't actually enqueue
2039 * anything, instead it should post a lock through
2040 * cl_io_lock_add(). Once all locks are collected, they are
2041 * sorted and enqueued in the proper order.
2043 int (*cio_lock) (const struct lu_env *env,
2044 const struct cl_io_slice *slice);
2046 * Finalize unlocking.
2048 * Called bottom-to-top to finish layer specific unlocking
2049 * functionality, after generic code released all locks
2050 * acquired by cl_io_operations::cio_lock().
2052 void (*cio_unlock)(const struct lu_env *env,
2053 const struct cl_io_slice *slice);
2055 * Start io iteration.
2057 * Once all locks are acquired, called top-to-bottom to
2058 * commence actual IO. In the current implementation,
2059 * top-level vvp_io_{read,write}_start() does all the work
2060 * synchronously by calling generic_file_*(), so other layers
2061 * are called when everything is done.
2063 int (*cio_start)(const struct lu_env *env,
2064 const struct cl_io_slice *slice);
2066 * Called top-to-bottom at the end of io loop. Here layer
2067 * might wait for an unfinished asynchronous io.
2069 void (*cio_end) (const struct lu_env *env,
2070 const struct cl_io_slice *slice);
2072 * Called bottom-to-top to notify layers that read/write IO
2073 * iteration finished, with \a nob bytes transferred.
2075 void (*cio_advance)(const struct lu_env *env,
2076 const struct cl_io_slice *slice,
2079 * Called once per io, bottom-to-top to release io resources.
2081 void (*cio_fini) (const struct lu_env *env,
2082 const struct cl_io_slice *slice);
2086 * Submit pages from \a queue->c2_qin for IO, and move
2087 * successfully submitted pages into \a queue->c2_qout. Return
2088 * non-zero if failed to submit even the single page. If
2089 * submission failed after some pages were moved into \a
2090 * queue->c2_qout, completion callback with non-zero ioret is
2093 int (*cio_submit)(const struct lu_env *env,
2094 const struct cl_io_slice *slice,
2095 enum cl_req_type crt,
2096 struct cl_2queue *queue);
2099 * Read missing page.
2101 * Called by a top-level cl_io_operations::op[CIT_READ]::cio_start()
2102 * method, when it hits not-up-to-date page in the range. Optional.
2104 * \pre io->ci_type == CIT_READ
2106 int (*cio_read_page)(const struct lu_env *env,
2107 const struct cl_io_slice *slice,
2108 const struct cl_page_slice *page);
2110 * Prepare write of a \a page. Called bottom-to-top by a top-level
2111 * cl_io_operations::op[CIT_WRITE]::cio_start() to prepare page for
2112 * get data from user-level buffer.
2114 * \pre io->ci_type == CIT_WRITE
2116 * \see vvp_io_prepare_write(), lov_io_prepare_write(),
2117 * osc_io_prepare_write().
2119 int (*cio_prepare_write)(const struct lu_env *env,
2120 const struct cl_io_slice *slice,
2121 const struct cl_page_slice *page,
2122 unsigned from, unsigned to);
2125 * \pre io->ci_type == CIT_WRITE
2127 * \see vvp_io_commit_write(), lov_io_commit_write(),
2128 * osc_io_commit_write().
2130 int (*cio_commit_write)(const struct lu_env *env,
2131 const struct cl_io_slice *slice,
2132 const struct cl_page_slice *page,
2133 unsigned from, unsigned to);
2135 * Optional debugging helper. Print given io slice.
2137 int (*cio_print)(const struct lu_env *env, void *cookie,
2138 lu_printer_t p, const struct cl_io_slice *slice);
2142 * Flags to lock enqueue procedure.
2147 * instruct server to not block, if conflicting lock is found. Instead
2148 * -EWOULDBLOCK is returned immediately.
2150 CEF_NONBLOCK = 0x00000001,
2152 * take lock asynchronously (out of order), as it cannot
2153 * deadlock. This is for LDLM_FL_HAS_INTENT locks used for glimpsing.
2155 CEF_ASYNC = 0x00000002,
2157 * tell the server to instruct (though a flag in the blocking ast) an
2158 * owner of the conflicting lock, that it can drop dirty pages
2159 * protected by this lock, without sending them to the server.
2161 CEF_DISCARD_DATA = 0x00000004,
2163 * tell the sub layers that it must be a `real' lock. This is used for
2164 * mmapped-buffer locks and glimpse locks that must be never converted
2165 * into lockless mode.
2167 * \see vvp_mmap_locks(), cl_glimpse_lock().
2169 CEF_MUST = 0x00000008,
2171 * tell the sub layers that never request a `real' lock. This flag is
2172 * not used currently.
2174 * cl_io::ci_lockreq and CEF_{MUST,NEVER} flags specify lockless
2175 * conversion policy: ci_lockreq describes generic information of lock
2176 * requirement for this IO, especially for locks which belong to the
2177 * object doing IO; however, lock itself may have precise requirements
2178 * that are described by the enqueue flags.
2180 CEF_NEVER = 0x00000010,
2182 * for async glimpse lock.
2184 CEF_AGL = 0x00000020,
2186 * mask of enq_flags.
2188 CEF_MASK = 0x0000003f,
2192 * Link between lock and io. Intermediate structure is needed, because the
2193 * same lock can be part of multiple io's simultaneously.
2195 struct cl_io_lock_link {
2196 /** linkage into one of cl_lockset lists. */
2197 cfs_list_t cill_linkage;
2198 struct cl_lock_descr cill_descr;
2199 struct cl_lock *cill_lock;
2200 /** optional destructor */
2201 void (*cill_fini)(const struct lu_env *env,
2202 struct cl_io_lock_link *link);
2206 * Lock-set represents a collection of locks, that io needs at a
2207 * time. Generally speaking, client tries to avoid holding multiple locks when
2210 * - holding extent locks over multiple ost's introduces the danger of
2211 * "cascading timeouts";
2213 * - holding multiple locks over the same ost is still dead-lock prone,
2214 * see comment in osc_lock_enqueue(),
2216 * but there are certain situations where this is unavoidable:
2218 * - O_APPEND writes have to take [0, EOF] lock for correctness;
2220 * - truncate has to take [new-size, EOF] lock for correctness;
2222 * - SNS has to take locks across full stripe for correctness;
2224 * - in the case when user level buffer, supplied to {read,write}(file0),
2225 * is a part of a memory mapped lustre file, client has to take a dlm
2226 * locks on file0, and all files that back up the buffer (or a part of
2227 * the buffer, that is being processed in the current chunk, in any
2228 * case, there are situations where at least 2 locks are necessary).
2230 * In such cases we at least try to take locks in the same consistent
2231 * order. To this end, all locks are first collected, then sorted, and then
2235 /** locks to be acquired. */
2236 cfs_list_t cls_todo;
2237 /** locks currently being processed. */
2238 cfs_list_t cls_curr;
2239 /** locks acquired. */
2240 cfs_list_t cls_done;
2244 * Lock requirements(demand) for IO. It should be cl_io_lock_req,
2245 * but 'req' is always to be thought as 'request' :-)
2247 enum cl_io_lock_dmd {
2248 /** Always lock data (e.g., O_APPEND). */
2250 /** Layers are free to decide between local and global locking. */
2252 /** Never lock: there is no cache (e.g., liblustre). */
2254 /** Peek lock: use existing locks, don't queue new ones */
2258 enum cl_fsync_mode {
2259 /** start writeback, do not wait for them to finish */
2261 /** start writeback and wait for them to finish */
2263 /** discard all of dirty pages in a specific file range */
2264 CL_FSYNC_DISCARD = 2,
2265 /** start writeback and make sure they have reached storage before
2266 * return. OST_SYNC RPC must be issued and finished */
2270 struct cl_io_rw_common {
2280 * cl_io is shared by all threads participating in this IO (in current
2281 * implementation only one thread advances IO, but parallel IO design and
2282 * concurrent copy_*_user() require multiple threads acting on the same IO. It
2283 * is up to these threads to serialize their activities, including updates to
2284 * mutable cl_io fields.
2287 /** type of this IO. Immutable after creation. */
2288 enum cl_io_type ci_type;
2289 /** current state of cl_io state machine. */
2290 enum cl_io_state ci_state;
2291 /** main object this io is against. Immutable after creation. */
2292 struct cl_object *ci_obj;
2294 * Upper layer io, of which this io is a part of. Immutable after
2297 struct cl_io *ci_parent;
2298 /** List of slices. Immutable after creation. */
2299 cfs_list_t ci_layers;
2300 /** list of locks (to be) acquired by this io. */
2301 struct cl_lockset ci_lockset;
2302 /** lock requirements, this is just a help info for sublayers. */
2303 enum cl_io_lock_dmd ci_lockreq;
2306 struct cl_io_rw_common rd;
2309 struct cl_io_rw_common wr;
2313 struct cl_io_rw_common ci_rw;
2314 struct cl_setattr_io {
2315 struct ost_lvb sa_attr;
2316 unsigned int sa_valid;
2317 struct obd_capa *sa_capa;
2319 struct cl_fault_io {
2320 /** page index within file. */
2322 /** bytes valid byte on a faulted page. */
2324 /** writable page? for nopage() only */
2326 /** page of an executable? */
2328 /** page_mkwrite() */
2330 /** resulting page */
2331 struct cl_page *ft_page;
2333 struct cl_fsync_io {
2336 struct obd_capa *fi_capa;
2337 /** file system level fid */
2338 struct lu_fid *fi_fid;
2339 enum cl_fsync_mode fi_mode;
2340 /* how many pages were written/discarded */
2341 unsigned int fi_nr_written;
2344 struct cl_2queue ci_queue;
2347 unsigned int ci_continue:1,
2349 * This io has held grouplock, to inform sublayers that
2350 * don't do lockless i/o.
2354 * The whole IO need to be restarted because layout has been changed
2358 * to not refresh layout - the IO issuer knows that the layout won't
2359 * change(page operations, layout change causes all page to be
2360 * discarded), or it doesn't matter if it changes(sync).
2364 * Check if layout changed after the IO finishes. Mainly for HSM
2365 * requirement. If IO occurs to openning files, it doesn't need to
2366 * verify layout because HSM won't release openning files.
2367 * Right now, only two opertaions need to verify layout: glimpse
2372 * Number of pages owned by this IO. For invariant checking.
2374 unsigned ci_owned_nr;
2379 /** \addtogroup cl_req cl_req
2384 * There are two possible modes of transfer initiation on the client:
2386 * - immediate transfer: this is started when a high level io wants a page
2387 * or a collection of pages to be transferred right away. Examples:
2388 * read-ahead, synchronous read in the case of non-page aligned write,
2389 * page write-out as a part of extent lock cancellation, page write-out
2390 * as a part of memory cleansing. Immediate transfer can be both
2391 * cl_req_type::CRT_READ and cl_req_type::CRT_WRITE;
2393 * - opportunistic transfer (cl_req_type::CRT_WRITE only), that happens
2394 * when io wants to transfer a page to the server some time later, when
2395 * it can be done efficiently. Example: pages dirtied by the write(2)
2398 * In any case, transfer takes place in the form of a cl_req, which is a
2399 * representation for a network RPC.
2401 * Pages queued for an opportunistic transfer are cached until it is decided
2402 * that efficient RPC can be composed of them. This decision is made by "a
2403 * req-formation engine", currently implemented as a part of osc
2404 * layer. Req-formation depends on many factors: the size of the resulting
2405 * RPC, whether or not multi-object RPCs are supported by the server,
2406 * max-rpc-in-flight limitations, size of the dirty cache, etc.
2408 * For the immediate transfer io submits a cl_page_list, that req-formation
2409 * engine slices into cl_req's, possibly adding cached pages to some of
2410 * the resulting req's.
2412 * Whenever a page from cl_page_list is added to a newly constructed req, its
2413 * cl_page_operations::cpo_prep() layer methods are called. At that moment,
2414 * page state is atomically changed from cl_page_state::CPS_OWNED to
2415 * cl_page_state::CPS_PAGEOUT or cl_page_state::CPS_PAGEIN, cl_page::cp_owner
2416 * is zeroed, and cl_page::cp_req is set to the
2417 * req. cl_page_operations::cpo_prep() method at the particular layer might
2418 * return -EALREADY to indicate that it does not need to submit this page
2419 * at all. This is possible, for example, if page, submitted for read,
2420 * became up-to-date in the meantime; and for write, the page don't have
2421 * dirty bit marked. \see cl_io_submit_rw()
2423 * Whenever a cached page is added to a newly constructed req, its
2424 * cl_page_operations::cpo_make_ready() layer methods are called. At that
2425 * moment, page state is atomically changed from cl_page_state::CPS_CACHED to
2426 * cl_page_state::CPS_PAGEOUT, and cl_page::cp_req is set to
2427 * req. cl_page_operations::cpo_make_ready() method at the particular layer
2428 * might return -EAGAIN to indicate that this page is not eligible for the
2429 * transfer right now.
2433 * Plan is to divide transfers into "priority bands" (indicated when
2434 * submitting cl_page_list, and queuing a page for the opportunistic transfer)
2435 * and allow glueing of cached pages to immediate transfers only within single
2436 * band. This would make high priority transfers (like lock cancellation or
2437 * memory pressure induced write-out) really high priority.
2442 * Per-transfer attributes.
2444 struct cl_req_attr {
2445 /** Generic attributes for the server consumption. */
2446 struct obdo *cra_oa;
2448 struct obd_capa *cra_capa;
2450 char cra_jobid[JOBSTATS_JOBID_SIZE];
2454 * Transfer request operations definable at every layer.
2456 * Concurrency: transfer formation engine synchronizes calls to all transfer
2459 struct cl_req_operations {
2461 * Invoked top-to-bottom by cl_req_prep() when transfer formation is
2462 * complete (all pages are added).
2464 * \see osc_req_prep()
2466 int (*cro_prep)(const struct lu_env *env,
2467 const struct cl_req_slice *slice);
2469 * Called top-to-bottom to fill in \a oa fields. This is called twice
2470 * with different flags, see bug 10150 and osc_build_req().
2472 * \param obj an object from cl_req which attributes are to be set in
2475 * \param oa struct obdo where attributes are placed
2477 * \param flags \a oa fields to be filled.
2479 void (*cro_attr_set)(const struct lu_env *env,
2480 const struct cl_req_slice *slice,
2481 const struct cl_object *obj,
2482 struct cl_req_attr *attr, obd_valid flags);
2484 * Called top-to-bottom from cl_req_completion() to notify layers that
2485 * transfer completed. Has to free all state allocated by
2486 * cl_device_operations::cdo_req_init().
2488 void (*cro_completion)(const struct lu_env *env,
2489 const struct cl_req_slice *slice, int ioret);
2493 * A per-object state that (potentially multi-object) transfer request keeps.
2496 /** object itself */
2497 struct cl_object *ro_obj;
2498 /** reference to cl_req_obj::ro_obj. For debugging. */
2499 struct lu_ref_link *ro_obj_ref;
2500 /* something else? Number of pages for a given object? */
2506 * Transfer requests are not reference counted, because IO sub-system owns
2507 * them exclusively and knows when to free them.
2511 * cl_req is created by cl_req_alloc() that calls
2512 * cl_device_operations::cdo_req_init() device methods to allocate per-req
2513 * state in every layer.
2515 * Then pages are added (cl_req_page_add()), req keeps track of all objects it
2516 * contains pages for.
2518 * Once all pages were collected, cl_page_operations::cpo_prep() method is
2519 * called top-to-bottom. At that point layers can modify req, let it pass, or
2520 * deny it completely. This is to support things like SNS that have transfer
2521 * ordering requirements invisible to the individual req-formation engine.
2523 * On transfer completion (or transfer timeout, or failure to initiate the
2524 * transfer of an allocated req), cl_req_operations::cro_completion() method
2525 * is called, after execution of cl_page_operations::cpo_completion() of all
2529 enum cl_req_type crq_type;
2530 /** A list of pages being transfered */
2531 cfs_list_t crq_pages;
2532 /** Number of pages in cl_req::crq_pages */
2533 unsigned crq_nrpages;
2534 /** An array of objects which pages are in ->crq_pages */
2535 struct cl_req_obj *crq_o;
2536 /** Number of elements in cl_req::crq_objs[] */
2537 unsigned crq_nrobjs;
2538 cfs_list_t crq_layers;
2542 * Per-layer state for request.
2544 struct cl_req_slice {
2545 struct cl_req *crs_req;
2546 struct cl_device *crs_dev;
2547 cfs_list_t crs_linkage;
2548 const struct cl_req_operations *crs_ops;
2554 * Stats for a generic cache (similar to inode, lu_object, etc. caches).
2556 struct cache_stats {
2557 const char *cs_name;
2558 /** how many entities were created at all */
2559 cfs_atomic_t cs_created;
2560 /** how many cache lookups were performed */
2561 cfs_atomic_t cs_lookup;
2562 /** how many times cache lookup resulted in a hit */
2563 cfs_atomic_t cs_hit;
2564 /** how many entities are in the cache right now */
2565 cfs_atomic_t cs_total;
2566 /** how many entities in the cache are actively used (and cannot be
2567 * evicted) right now */
2568 cfs_atomic_t cs_busy;
2571 /** These are not exported so far */
2572 void cache_stats_init (struct cache_stats *cs, const char *name);
2573 int cache_stats_print(const struct cache_stats *cs,
2574 char *page, int count, int header);
2577 * Client-side site. This represents particular client stack. "Global"
2578 * variables should (directly or indirectly) be added here to allow multiple
2579 * clients to co-exist in the single address space.
2582 struct lu_site cs_lu;
2584 * Statistical counters. Atomics do not scale, something better like
2585 * per-cpu counters is needed.
2587 * These are exported as /proc/fs/lustre/llite/.../site
2589 * When interpreting keep in mind that both sub-locks (and sub-pages)
2590 * and top-locks (and top-pages) are accounted here.
2592 struct cache_stats cs_pages;
2593 struct cache_stats cs_locks;
2594 cfs_atomic_t cs_pages_state[CPS_NR];
2595 cfs_atomic_t cs_locks_state[CLS_NR];
2598 int cl_site_init (struct cl_site *s, struct cl_device *top);
2599 void cl_site_fini (struct cl_site *s);
2600 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl);
2603 * Output client site statistical counters into a buffer. Suitable for
2604 * ll_rd_*()-style functions.
2606 int cl_site_stats_print(const struct cl_site *s, char *page, int count);
2611 * Type conversion and accessory functions.
2615 static inline struct cl_site *lu2cl_site(const struct lu_site *site)
2617 return container_of(site, struct cl_site, cs_lu);
2620 static inline int lu_device_is_cl(const struct lu_device *d)
2622 return d->ld_type->ldt_tags & LU_DEVICE_CL;
2625 static inline struct cl_device *lu2cl_dev(const struct lu_device *d)
2627 LASSERT(d == NULL || IS_ERR(d) || lu_device_is_cl(d));
2628 return container_of0(d, struct cl_device, cd_lu_dev);
2631 static inline struct lu_device *cl2lu_dev(struct cl_device *d)
2633 return &d->cd_lu_dev;
2636 static inline struct cl_object *lu2cl(const struct lu_object *o)
2638 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_cl(o->lo_dev));
2639 return container_of0(o, struct cl_object, co_lu);
2642 static inline const struct cl_object_conf *
2643 lu2cl_conf(const struct lu_object_conf *conf)
2645 return container_of0(conf, struct cl_object_conf, coc_lu);
2648 static inline struct cl_object *cl_object_next(const struct cl_object *obj)
2650 return obj ? lu2cl(lu_object_next(&obj->co_lu)) : NULL;
2653 static inline struct cl_device *cl_object_device(const struct cl_object *o)
2655 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_cl(o->co_lu.lo_dev));
2656 return container_of0(o->co_lu.lo_dev, struct cl_device, cd_lu_dev);
2659 static inline struct cl_object_header *luh2coh(const struct lu_object_header *h)
2661 return container_of0(h, struct cl_object_header, coh_lu);
2664 static inline struct cl_site *cl_object_site(const struct cl_object *obj)
2666 return lu2cl_site(obj->co_lu.lo_dev->ld_site);
2670 struct cl_object_header *cl_object_header(const struct cl_object *obj)
2672 return luh2coh(obj->co_lu.lo_header);
2675 static inline int cl_device_init(struct cl_device *d, struct lu_device_type *t)
2677 return lu_device_init(&d->cd_lu_dev, t);
2680 static inline void cl_device_fini(struct cl_device *d)
2682 lu_device_fini(&d->cd_lu_dev);
2685 void cl_page_slice_add(struct cl_page *page, struct cl_page_slice *slice,
2686 struct cl_object *obj,
2687 const struct cl_page_operations *ops);
2688 void cl_lock_slice_add(struct cl_lock *lock, struct cl_lock_slice *slice,
2689 struct cl_object *obj,
2690 const struct cl_lock_operations *ops);
2691 void cl_io_slice_add(struct cl_io *io, struct cl_io_slice *slice,
2692 struct cl_object *obj, const struct cl_io_operations *ops);
2693 void cl_req_slice_add(struct cl_req *req, struct cl_req_slice *slice,
2694 struct cl_device *dev,
2695 const struct cl_req_operations *ops);
2698 /** \defgroup cl_object cl_object
2700 struct cl_object *cl_object_top (struct cl_object *o);
2701 struct cl_object *cl_object_find(const struct lu_env *env, struct cl_device *cd,
2702 const struct lu_fid *fid,
2703 const struct cl_object_conf *c);
2705 int cl_object_header_init(struct cl_object_header *h);
2706 void cl_object_header_fini(struct cl_object_header *h);
2707 void cl_object_put (const struct lu_env *env, struct cl_object *o);
2708 void cl_object_get (struct cl_object *o);
2709 void cl_object_attr_lock (struct cl_object *o);
2710 void cl_object_attr_unlock(struct cl_object *o);
2711 int cl_object_attr_get (const struct lu_env *env, struct cl_object *obj,
2712 struct cl_attr *attr);
2713 int cl_object_attr_set (const struct lu_env *env, struct cl_object *obj,
2714 const struct cl_attr *attr, unsigned valid);
2715 int cl_object_glimpse (const struct lu_env *env, struct cl_object *obj,
2716 struct ost_lvb *lvb);
2717 int cl_conf_set (const struct lu_env *env, struct cl_object *obj,
2718 const struct cl_object_conf *conf);
2719 void cl_object_prune (const struct lu_env *env, struct cl_object *obj);
2720 void cl_object_kill (const struct lu_env *env, struct cl_object *obj);
2721 int cl_object_has_locks (struct cl_object *obj);
2724 * Returns true, iff \a o0 and \a o1 are slices of the same object.
2726 static inline int cl_object_same(struct cl_object *o0, struct cl_object *o1)
2728 return cl_object_header(o0) == cl_object_header(o1);
2733 /** \defgroup cl_page cl_page
2742 /* callback of cl_page_gang_lookup() */
2743 typedef int (*cl_page_gang_cb_t) (const struct lu_env *, struct cl_io *,
2744 struct cl_page *, void *);
2745 int cl_page_gang_lookup (const struct lu_env *env,
2746 struct cl_object *obj,
2748 pgoff_t start, pgoff_t end,
2749 cl_page_gang_cb_t cb, void *cbdata);
2750 struct cl_page *cl_page_lookup (struct cl_object_header *hdr,
2752 struct cl_page *cl_page_find (const struct lu_env *env,
2753 struct cl_object *obj,
2754 pgoff_t idx, struct page *vmpage,
2755 enum cl_page_type type);
2756 struct cl_page *cl_page_find_sub (const struct lu_env *env,
2757 struct cl_object *obj,
2758 pgoff_t idx, struct page *vmpage,
2759 struct cl_page *parent);
2760 void cl_page_get (struct cl_page *page);
2761 void cl_page_put (const struct lu_env *env,
2762 struct cl_page *page);
2763 void cl_page_print (const struct lu_env *env, void *cookie,
2764 lu_printer_t printer,
2765 const struct cl_page *pg);
2766 void cl_page_header_print(const struct lu_env *env, void *cookie,
2767 lu_printer_t printer,
2768 const struct cl_page *pg);
2769 cfs_page_t *cl_page_vmpage (const struct lu_env *env,
2770 struct cl_page *page);
2771 struct cl_page *cl_vmpage_page (cfs_page_t *vmpage, struct cl_object *obj);
2772 struct cl_page *cl_page_top (struct cl_page *page);
2774 const struct cl_page_slice *cl_page_at(const struct cl_page *page,
2775 const struct lu_device_type *dtype);
2780 * Functions dealing with the ownership of page by io.
2784 int cl_page_own (const struct lu_env *env,
2785 struct cl_io *io, struct cl_page *page);
2786 int cl_page_own_try (const struct lu_env *env,
2787 struct cl_io *io, struct cl_page *page);
2788 void cl_page_assume (const struct lu_env *env,
2789 struct cl_io *io, struct cl_page *page);
2790 void cl_page_unassume (const struct lu_env *env,
2791 struct cl_io *io, struct cl_page *pg);
2792 void cl_page_disown (const struct lu_env *env,
2793 struct cl_io *io, struct cl_page *page);
2794 int cl_page_is_owned (const struct cl_page *pg, const struct cl_io *io);
2801 * Functions dealing with the preparation of a page for a transfer, and
2802 * tracking transfer state.
2805 int cl_page_prep (const struct lu_env *env, struct cl_io *io,
2806 struct cl_page *pg, enum cl_req_type crt);
2807 void cl_page_completion (const struct lu_env *env,
2808 struct cl_page *pg, enum cl_req_type crt, int ioret);
2809 int cl_page_make_ready (const struct lu_env *env, struct cl_page *pg,
2810 enum cl_req_type crt);
2811 int cl_page_cache_add (const struct lu_env *env, struct cl_io *io,
2812 struct cl_page *pg, enum cl_req_type crt);
2813 void cl_page_clip (const struct lu_env *env, struct cl_page *pg,
2815 int cl_page_cancel (const struct lu_env *env, struct cl_page *page);
2816 int cl_page_flush (const struct lu_env *env, struct cl_io *io,
2817 struct cl_page *pg);
2823 * \name helper routines
2824 * Functions to discard, delete and export a cl_page.
2827 void cl_page_discard (const struct lu_env *env, struct cl_io *io,
2828 struct cl_page *pg);
2829 void cl_page_delete (const struct lu_env *env, struct cl_page *pg);
2830 int cl_page_unmap (const struct lu_env *env, struct cl_io *io,
2831 struct cl_page *pg);
2832 int cl_page_is_vmlocked (const struct lu_env *env,
2833 const struct cl_page *pg);
2834 void cl_page_export (const struct lu_env *env,
2835 struct cl_page *pg, int uptodate);
2836 int cl_page_is_under_lock(const struct lu_env *env, struct cl_io *io,
2837 struct cl_page *page);
2838 loff_t cl_offset (const struct cl_object *obj, pgoff_t idx);
2839 pgoff_t cl_index (const struct cl_object *obj, loff_t offset);
2840 int cl_page_size (const struct cl_object *obj);
2841 int cl_pages_prune (const struct lu_env *env, struct cl_object *obj);
2843 void cl_lock_print (const struct lu_env *env, void *cookie,
2844 lu_printer_t printer, const struct cl_lock *lock);
2845 void cl_lock_descr_print(const struct lu_env *env, void *cookie,
2846 lu_printer_t printer,
2847 const struct cl_lock_descr *descr);
2852 /** \defgroup cl_lock cl_lock
2855 struct cl_lock *cl_lock_hold(const struct lu_env *env, const struct cl_io *io,
2856 const struct cl_lock_descr *need,
2857 const char *scope, const void *source);
2858 struct cl_lock *cl_lock_peek(const struct lu_env *env, const struct cl_io *io,
2859 const struct cl_lock_descr *need,
2860 const char *scope, const void *source);
2861 struct cl_lock *cl_lock_request(const struct lu_env *env, struct cl_io *io,
2862 const struct cl_lock_descr *need,
2863 const char *scope, const void *source);
2864 struct cl_lock *cl_lock_at_pgoff(const struct lu_env *env,
2865 struct cl_object *obj, pgoff_t index,
2866 struct cl_lock *except, int pending,
2868 static inline struct cl_lock *cl_lock_at_page(const struct lu_env *env,
2869 struct cl_object *obj,
2870 struct cl_page *page,
2871 struct cl_lock *except,
2872 int pending, int canceld)
2874 LASSERT(cl_object_header(obj) == cl_object_header(page->cp_obj));
2875 return cl_lock_at_pgoff(env, obj, page->cp_index, except,
2879 const struct cl_lock_slice *cl_lock_at(const struct cl_lock *lock,
2880 const struct lu_device_type *dtype);
2882 void cl_lock_get (struct cl_lock *lock);
2883 void cl_lock_get_trust (struct cl_lock *lock);
2884 void cl_lock_put (const struct lu_env *env, struct cl_lock *lock);
2885 void cl_lock_hold_add (const struct lu_env *env, struct cl_lock *lock,
2886 const char *scope, const void *source);
2887 void cl_lock_hold_release(const struct lu_env *env, struct cl_lock *lock,
2888 const char *scope, const void *source);
2889 void cl_lock_unhold (const struct lu_env *env, struct cl_lock *lock,
2890 const char *scope, const void *source);
2891 void cl_lock_release (const struct lu_env *env, struct cl_lock *lock,
2892 const char *scope, const void *source);
2893 void cl_lock_user_add (const struct lu_env *env, struct cl_lock *lock);
2894 void cl_lock_user_del (const struct lu_env *env, struct cl_lock *lock);
2896 enum cl_lock_state cl_lock_intransit(const struct lu_env *env,
2897 struct cl_lock *lock);
2898 void cl_lock_extransit(const struct lu_env *env, struct cl_lock *lock,
2899 enum cl_lock_state state);
2900 int cl_lock_is_intransit(struct cl_lock *lock);
2902 int cl_lock_enqueue_wait(const struct lu_env *env, struct cl_lock *lock,
2905 /** \name statemachine statemachine
2906 * Interface to lock state machine consists of 3 parts:
2908 * - "try" functions that attempt to effect a state transition. If state
2909 * transition is not possible right now (e.g., if it has to wait for some
2910 * asynchronous event to occur), these functions return
2911 * cl_lock_transition::CLO_WAIT.
2913 * - "non-try" functions that implement synchronous blocking interface on
2914 * top of non-blocking "try" functions. These functions repeatedly call
2915 * corresponding "try" versions, and if state transition is not possible
2916 * immediately, wait for lock state change.
2918 * - methods from cl_lock_operations, called by "try" functions. Lock can
2919 * be advanced to the target state only when all layers voted that they
2920 * are ready for this transition. "Try" functions call methods under lock
2921 * mutex. If a layer had to release a mutex, it re-acquires it and returns
2922 * cl_lock_transition::CLO_REPEAT, causing "try" function to call all
2925 * TRY NON-TRY METHOD FINAL STATE
2927 * cl_enqueue_try() cl_enqueue() cl_lock_operations::clo_enqueue() CLS_ENQUEUED
2929 * cl_wait_try() cl_wait() cl_lock_operations::clo_wait() CLS_HELD
2931 * cl_unuse_try() cl_unuse() cl_lock_operations::clo_unuse() CLS_CACHED
2933 * cl_use_try() NONE cl_lock_operations::clo_use() CLS_HELD
2937 int cl_enqueue (const struct lu_env *env, struct cl_lock *lock,
2938 struct cl_io *io, __u32 flags);
2939 int cl_wait (const struct lu_env *env, struct cl_lock *lock);
2940 void cl_unuse (const struct lu_env *env, struct cl_lock *lock);
2941 int cl_enqueue_try(const struct lu_env *env, struct cl_lock *lock,
2942 struct cl_io *io, __u32 flags);
2943 int cl_unuse_try (const struct lu_env *env, struct cl_lock *lock);
2944 int cl_wait_try (const struct lu_env *env, struct cl_lock *lock);
2945 int cl_use_try (const struct lu_env *env, struct cl_lock *lock, int atomic);
2947 /** @} statemachine */
2949 void cl_lock_signal (const struct lu_env *env, struct cl_lock *lock);
2950 int cl_lock_state_wait (const struct lu_env *env, struct cl_lock *lock);
2951 void cl_lock_state_set (const struct lu_env *env, struct cl_lock *lock,
2952 enum cl_lock_state state);
2953 int cl_queue_match (const cfs_list_t *queue,
2954 const struct cl_lock_descr *need);
2956 void cl_lock_mutex_get (const struct lu_env *env, struct cl_lock *lock);
2957 int cl_lock_mutex_try (const struct lu_env *env, struct cl_lock *lock);
2958 void cl_lock_mutex_put (const struct lu_env *env, struct cl_lock *lock);
2959 int cl_lock_is_mutexed (struct cl_lock *lock);
2960 int cl_lock_nr_mutexed (const struct lu_env *env);
2961 int cl_lock_discard_pages(const struct lu_env *env, struct cl_lock *lock);
2962 int cl_lock_ext_match (const struct cl_lock_descr *has,
2963 const struct cl_lock_descr *need);
2964 int cl_lock_descr_match(const struct cl_lock_descr *has,
2965 const struct cl_lock_descr *need);
2966 int cl_lock_mode_match (enum cl_lock_mode has, enum cl_lock_mode need);
2967 int cl_lock_modify (const struct lu_env *env, struct cl_lock *lock,
2968 const struct cl_lock_descr *desc);
2970 void cl_lock_closure_init (const struct lu_env *env,
2971 struct cl_lock_closure *closure,
2972 struct cl_lock *origin, int wait);
2973 void cl_lock_closure_fini (struct cl_lock_closure *closure);
2974 int cl_lock_closure_build(const struct lu_env *env, struct cl_lock *lock,
2975 struct cl_lock_closure *closure);
2976 void cl_lock_disclosure (const struct lu_env *env,
2977 struct cl_lock_closure *closure);
2978 int cl_lock_enclosure (const struct lu_env *env, struct cl_lock *lock,
2979 struct cl_lock_closure *closure);
2981 void cl_lock_cancel(const struct lu_env *env, struct cl_lock *lock);
2982 void cl_lock_delete(const struct lu_env *env, struct cl_lock *lock);
2983 void cl_lock_error (const struct lu_env *env, struct cl_lock *lock, int error);
2984 void cl_locks_prune(const struct lu_env *env, struct cl_object *obj, int wait);
2986 unsigned long cl_lock_weigh(const struct lu_env *env, struct cl_lock *lock);
2990 /** \defgroup cl_io cl_io
2993 int cl_io_init (const struct lu_env *env, struct cl_io *io,
2994 enum cl_io_type iot, struct cl_object *obj);
2995 int cl_io_sub_init (const struct lu_env *env, struct cl_io *io,
2996 enum cl_io_type iot, struct cl_object *obj);
2997 int cl_io_rw_init (const struct lu_env *env, struct cl_io *io,
2998 enum cl_io_type iot, loff_t pos, size_t count);
2999 int cl_io_loop (const struct lu_env *env, struct cl_io *io);
3001 void cl_io_fini (const struct lu_env *env, struct cl_io *io);
3002 int cl_io_iter_init (const struct lu_env *env, struct cl_io *io);
3003 void cl_io_iter_fini (const struct lu_env *env, struct cl_io *io);
3004 int cl_io_lock (const struct lu_env *env, struct cl_io *io);
3005 void cl_io_unlock (const struct lu_env *env, struct cl_io *io);
3006 int cl_io_start (const struct lu_env *env, struct cl_io *io);
3007 void cl_io_end (const struct lu_env *env, struct cl_io *io);
3008 int cl_io_lock_add (const struct lu_env *env, struct cl_io *io,
3009 struct cl_io_lock_link *link);
3010 int cl_io_lock_alloc_add(const struct lu_env *env, struct cl_io *io,
3011 struct cl_lock_descr *descr);
3012 int cl_io_read_page (const struct lu_env *env, struct cl_io *io,
3013 struct cl_page *page);
3014 int cl_io_prepare_write(const struct lu_env *env, struct cl_io *io,
3015 struct cl_page *page, unsigned from, unsigned to);
3016 int cl_io_commit_write (const struct lu_env *env, struct cl_io *io,
3017 struct cl_page *page, unsigned from, unsigned to);
3018 int cl_io_submit_rw (const struct lu_env *env, struct cl_io *io,
3019 enum cl_req_type iot, struct cl_2queue *queue);
3020 int cl_io_submit_sync (const struct lu_env *env, struct cl_io *io,
3021 enum cl_req_type iot, struct cl_2queue *queue,
3023 void cl_io_rw_advance (const struct lu_env *env, struct cl_io *io,
3025 int cl_io_cancel (const struct lu_env *env, struct cl_io *io,
3026 struct cl_page_list *queue);
3027 int cl_io_is_going (const struct lu_env *env);
3030 * True, iff \a io is an O_APPEND write(2).
3032 static inline int cl_io_is_append(const struct cl_io *io)
3034 return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_append;
3037 static inline int cl_io_is_sync_write(const struct cl_io *io)
3039 return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_sync;
3042 static inline int cl_io_is_mkwrite(const struct cl_io *io)
3044 return io->ci_type == CIT_FAULT && io->u.ci_fault.ft_mkwrite;
3048 * True, iff \a io is a truncate(2).
3050 static inline int cl_io_is_trunc(const struct cl_io *io)
3052 return io->ci_type == CIT_SETATTR &&
3053 (io->u.ci_setattr.sa_valid & ATTR_SIZE);
3056 struct cl_io *cl_io_top(struct cl_io *io);
3058 void cl_io_print(const struct lu_env *env, void *cookie,
3059 lu_printer_t printer, const struct cl_io *io);
3061 #define CL_IO_SLICE_CLEAN(foo_io, base) \
3063 typeof(foo_io) __foo_io = (foo_io); \
3065 CLASSERT(offsetof(typeof(*__foo_io), base) == 0); \
3066 memset(&__foo_io->base + 1, 0, \
3067 (sizeof *__foo_io) - sizeof __foo_io->base); \
3072 /** \defgroup cl_page_list cl_page_list
3076 * Last page in the page list.
3078 static inline struct cl_page *cl_page_list_last(struct cl_page_list *plist)
3080 LASSERT(plist->pl_nr > 0);
3081 return cfs_list_entry(plist->pl_pages.prev, struct cl_page, cp_batch);
3085 * Iterate over pages in a page list.
3087 #define cl_page_list_for_each(page, list) \
3088 cfs_list_for_each_entry((page), &(list)->pl_pages, cp_batch)
3091 * Iterate over pages in a page list, taking possible removals into account.
3093 #define cl_page_list_for_each_safe(page, temp, list) \
3094 cfs_list_for_each_entry_safe((page), (temp), &(list)->pl_pages, cp_batch)
3096 void cl_page_list_init (struct cl_page_list *plist);
3097 void cl_page_list_add (struct cl_page_list *plist, struct cl_page *page);
3098 void cl_page_list_move (struct cl_page_list *dst, struct cl_page_list *src,
3099 struct cl_page *page);
3100 void cl_page_list_splice (struct cl_page_list *list,
3101 struct cl_page_list *head);
3102 void cl_page_list_del (const struct lu_env *env,
3103 struct cl_page_list *plist, struct cl_page *page);
3104 void cl_page_list_disown (const struct lu_env *env,
3105 struct cl_io *io, struct cl_page_list *plist);
3106 int cl_page_list_own (const struct lu_env *env,
3107 struct cl_io *io, struct cl_page_list *plist);
3108 void cl_page_list_assume (const struct lu_env *env,
3109 struct cl_io *io, struct cl_page_list *plist);
3110 void cl_page_list_discard(const struct lu_env *env,
3111 struct cl_io *io, struct cl_page_list *plist);
3112 int cl_page_list_unmap (const struct lu_env *env,
3113 struct cl_io *io, struct cl_page_list *plist);
3114 void cl_page_list_fini (const struct lu_env *env, struct cl_page_list *plist);
3116 void cl_2queue_init (struct cl_2queue *queue);
3117 void cl_2queue_add (struct cl_2queue *queue, struct cl_page *page);
3118 void cl_2queue_disown (const struct lu_env *env,
3119 struct cl_io *io, struct cl_2queue *queue);
3120 void cl_2queue_assume (const struct lu_env *env,
3121 struct cl_io *io, struct cl_2queue *queue);
3122 void cl_2queue_discard (const struct lu_env *env,
3123 struct cl_io *io, struct cl_2queue *queue);
3124 void cl_2queue_fini (const struct lu_env *env, struct cl_2queue *queue);
3125 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page);
3127 /** @} cl_page_list */
3129 /** \defgroup cl_req cl_req
3131 struct cl_req *cl_req_alloc(const struct lu_env *env, struct cl_page *page,
3132 enum cl_req_type crt, int nr_objects);
3134 void cl_req_page_add (const struct lu_env *env, struct cl_req *req,
3135 struct cl_page *page);
3136 void cl_req_page_done (const struct lu_env *env, struct cl_page *page);
3137 int cl_req_prep (const struct lu_env *env, struct cl_req *req);
3138 void cl_req_attr_set (const struct lu_env *env, struct cl_req *req,
3139 struct cl_req_attr *attr, obd_valid flags);
3140 void cl_req_completion(const struct lu_env *env, struct cl_req *req, int ioret);
3142 /** \defgroup cl_sync_io cl_sync_io
3146 * Anchor for synchronous transfer. This is allocated on a stack by thread
3147 * doing synchronous transfer, and a pointer to this structure is set up in
3148 * every page submitted for transfer. Transfer completion routine updates
3149 * anchor and wakes up waiting thread when transfer is complete.
3152 /** number of pages yet to be transferred. */
3153 cfs_atomic_t csi_sync_nr;
3154 /** completion to be signaled when transfer is complete. */
3155 cfs_waitq_t csi_waitq;
3160 void cl_sync_io_init(struct cl_sync_io *anchor, int nrpages);
3161 int cl_sync_io_wait(const struct lu_env *env, struct cl_io *io,
3162 struct cl_page_list *queue, struct cl_sync_io *anchor,
3164 void cl_sync_io_note(struct cl_sync_io *anchor, int ioret);
3166 /** @} cl_sync_io */
3170 /** \defgroup cl_env cl_env
3172 * lu_env handling for a client.
3174 * lu_env is an environment within which lustre code executes. Its major part
3175 * is lu_context---a fast memory allocation mechanism that is used to conserve
3176 * precious kernel stack space. Originally lu_env was designed for a server,
3179 * - there is a (mostly) fixed number of threads, and
3181 * - call chains have no non-lustre portions inserted between lustre code.
3183 * On a client both these assumtpion fails, because every user thread can
3184 * potentially execute lustre code as part of a system call, and lustre calls
3185 * into VFS or MM that call back into lustre.
3187 * To deal with that, cl_env wrapper functions implement the following
3190 * - allocation and destruction of environment is amortized by caching no
3191 * longer used environments instead of destroying them;
3193 * - there is a notion of "current" environment, attached to the kernel
3194 * data structure representing current thread Top-level lustre code
3195 * allocates an environment and makes it current, then calls into
3196 * non-lustre code, that in turn calls lustre back. Low-level lustre
3197 * code thus called can fetch environment created by the top-level code
3198 * and reuse it, avoiding additional environment allocation.
3199 * Right now, three interfaces can attach the cl_env to running thread:
3202 * - cl_env_reexit(cl_env_reenter had to be called priorly)
3204 * \see lu_env, lu_context, lu_context_key
3207 struct cl_env_nest {
3212 struct lu_env *cl_env_peek (int *refcheck);
3213 struct lu_env *cl_env_get (int *refcheck);
3214 struct lu_env *cl_env_alloc (int *refcheck, __u32 tags);
3215 struct lu_env *cl_env_nested_get (struct cl_env_nest *nest);
3216 void cl_env_put (struct lu_env *env, int *refcheck);
3217 void cl_env_nested_put (struct cl_env_nest *nest, struct lu_env *env);
3218 void *cl_env_reenter (void);
3219 void cl_env_reexit (void *cookie);
3220 void cl_env_implant (struct lu_env *env, int *refcheck);
3221 void cl_env_unplant (struct lu_env *env, int *refcheck);
3222 unsigned cl_env_cache_purge(unsigned nr);
3229 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr);
3230 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb);
3232 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
3233 struct lu_device_type *ldt,
3234 struct lu_device *next);
3237 #endif /* _LINUX_CL_OBJECT_H */