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, 2014, Intel Corporation.
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
87 * See the top comment in cl_object.c for the description of overall locking and
88 * reference-counting design.
90 * See comments below for the description of i/o, page, and dlm-locking
97 * super-class definitions.
99 #include <libcfs/libcfs.h>
100 #include <lu_object.h>
101 #include <linux/atomic.h>
102 #include <linux/mutex.h>
103 #include <linux/radix-tree.h>
104 #include <linux/spinlock.h>
105 #include <linux/wait.h>
106 #include <lustre_dlm.h>
111 struct cl_device_operations;
114 struct cl_object_page_operations;
115 struct cl_object_lock_operations;
118 struct cl_page_slice;
120 struct cl_lock_slice;
122 struct cl_lock_operations;
123 struct cl_page_operations;
132 * Operations for each data device in the client stack.
134 * \see vvp_cl_ops, lov_cl_ops, lovsub_cl_ops, osc_cl_ops
136 struct cl_device_operations {
138 * Initialize cl_req. This method is called top-to-bottom on all
139 * devices in the stack to get them a chance to allocate layer-private
140 * data, and to attach them to the cl_req by calling
141 * cl_req_slice_add().
143 * \see osc_req_init(), lov_req_init(), lovsub_req_init()
144 * \see vvp_req_init()
146 int (*cdo_req_init)(const struct lu_env *env, struct cl_device *dev,
151 * Device in the client stack.
153 * \see vvp_device, lov_device, lovsub_device, osc_device
157 struct lu_device cd_lu_dev;
158 /** Per-layer operation vector. */
159 const struct cl_device_operations *cd_ops;
162 /** \addtogroup cl_object cl_object
165 * "Data attributes" of cl_object. Data attributes can be updated
166 * independently for a sub-object, and top-object's attributes are calculated
167 * from sub-objects' ones.
170 /** Object size, in bytes */
173 * Known minimal size, in bytes.
175 * This is only valid when at least one DLM lock is held.
178 /** Modification time. Measured in seconds since epoch. */
180 /** Access time. Measured in seconds since epoch. */
182 /** Change time. Measured in seconds since epoch. */
185 * Blocks allocated to this cl_object on the server file system.
187 * \todo XXX An interface for block size is needed.
191 * User identifier for quota purposes.
195 * Group identifier for quota purposes.
199 /* nlink of the directory */
204 * Fields in cl_attr that are being set.
218 * Sub-class of lu_object with methods common for objects on the client
221 * cl_object: represents a regular file system object, both a file and a
222 * stripe. cl_object is based on lu_object: it is identified by a fid,
223 * layered, cached, hashed, and lrued. Important distinction with the server
224 * side, where md_object and dt_object are used, is that cl_object "fans out"
225 * at the lov/sns level: depending on the file layout, single file is
226 * represented as a set of "sub-objects" (stripes). At the implementation
227 * level, struct lov_object contains an array of cl_objects. Each sub-object
228 * is a full-fledged cl_object, having its fid, living in the lru and hash
231 * This leads to the next important difference with the server side: on the
232 * client, it's quite usual to have objects with the different sequence of
233 * layers. For example, typical top-object is composed of the following
239 * whereas its sub-objects are composed of
244 * layers. Here "lovsub" is a mostly dummy layer, whose purpose is to keep
245 * track of the object-subobject relationship.
247 * Sub-objects are not cached independently: when top-object is about to
248 * be discarded from the memory, all its sub-objects are torn-down and
251 * \see vvp_object, lov_object, lovsub_object, osc_object
255 struct lu_object co_lu;
256 /** per-object-layer operations */
257 const struct cl_object_operations *co_ops;
258 /** offset of page slice in cl_page buffer */
263 * Description of the client object configuration. This is used for the
264 * creation of a new client object that is identified by a more state than
267 struct cl_object_conf {
269 struct lu_object_conf coc_lu;
272 * Object layout. This is consumed by lov.
274 struct lustre_md *coc_md;
276 * Description of particular stripe location in the
277 * cluster. This is consumed by osc.
279 struct lov_oinfo *coc_oinfo;
282 * VFS inode. This is consumed by vvp.
284 struct inode *coc_inode;
286 * Layout lock handle.
288 struct ldlm_lock *coc_lock;
290 * Operation to handle layout, OBJECT_CONF_XYZ.
296 /** configure layout, set up a new stripe, must be called while
297 * holding layout lock. */
299 /** invalidate the current stripe configuration due to losing
301 OBJECT_CONF_INVALIDATE = 1,
302 /** wait for old layout to go away so that new layout can be
308 * Operations implemented for each cl object layer.
310 * \see vvp_ops, lov_ops, lovsub_ops, osc_ops
312 struct cl_object_operations {
314 * Initialize page slice for this layer. Called top-to-bottom through
315 * every object layer when a new cl_page is instantiated. Layer
316 * keeping private per-page data, or requiring its own page operations
317 * vector should allocate these data here, and attach then to the page
318 * by calling cl_page_slice_add(). \a vmpage is locked (in the VM
321 * \retval NULL success.
323 * \retval ERR_PTR(errno) failure code.
325 * \retval valid-pointer pointer to already existing referenced page
326 * to be used instead of newly created.
328 int (*coo_page_init)(const struct lu_env *env, struct cl_object *obj,
329 struct cl_page *page, pgoff_t index);
331 * Initialize lock slice for this layer. Called top-to-bottom through
332 * every object layer when a new cl_lock is instantiated. Layer
333 * keeping private per-lock data, or requiring its own lock operations
334 * vector should allocate these data here, and attach then to the lock
335 * by calling cl_lock_slice_add(). Mandatory.
337 int (*coo_lock_init)(const struct lu_env *env,
338 struct cl_object *obj, struct cl_lock *lock,
339 const struct cl_io *io);
341 * Initialize io state for a given layer.
343 * called top-to-bottom once per io existence to initialize io
344 * state. If layer wants to keep some state for this type of io, it
345 * has to embed struct cl_io_slice in lu_env::le_ses, and register
346 * slice with cl_io_slice_add(). It is guaranteed that all threads
347 * participating in this io share the same session.
349 int (*coo_io_init)(const struct lu_env *env,
350 struct cl_object *obj, struct cl_io *io);
352 * Fill portion of \a attr that this layer controls. This method is
353 * called top-to-bottom through all object layers.
355 * \pre cl_object_header::coh_attr_guard of the top-object is locked.
357 * \return 0: to continue
358 * \return +ve: to stop iterating through layers (but 0 is returned
359 * from enclosing cl_object_attr_get())
360 * \return -ve: to signal error
362 int (*coo_attr_get)(const struct lu_env *env, struct cl_object *obj,
363 struct cl_attr *attr);
367 * \a valid is a bitmask composed from enum #cl_attr_valid, and
368 * indicating what attributes are to be set.
370 * \pre cl_object_header::coh_attr_guard of the top-object is locked.
372 * \return the same convention as for
373 * cl_object_operations::coo_attr_get() is used.
375 int (*coo_attr_update)(const struct lu_env *env, struct cl_object *obj,
376 const struct cl_attr *attr, unsigned valid);
378 * Update object configuration. Called top-to-bottom to modify object
381 * XXX error conditions and handling.
383 int (*coo_conf_set)(const struct lu_env *env, struct cl_object *obj,
384 const struct cl_object_conf *conf);
386 * Glimpse ast. Executed when glimpse ast arrives for a lock on this
387 * object. Layers are supposed to fill parts of \a lvb that will be
388 * shipped to the glimpse originator as a glimpse result.
390 * \see vvp_object_glimpse(), lovsub_object_glimpse(),
391 * \see osc_object_glimpse()
393 int (*coo_glimpse)(const struct lu_env *env,
394 const struct cl_object *obj, struct ost_lvb *lvb);
396 * Object prune method. Called when the layout is going to change on
397 * this object, therefore each layer has to clean up their cache,
398 * mainly pages and locks.
400 int (*coo_prune)(const struct lu_env *env, struct cl_object *obj);
402 * Object getstripe method.
404 int (*coo_getstripe)(const struct lu_env *env, struct cl_object *obj,
405 struct lov_user_md __user *lum);
407 * Find whether there is any callback data (ldlm lock) attached upon
410 int (*coo_find_cbdata)(const struct lu_env *env, struct cl_object *obj,
411 ldlm_iterator_t iter, void *data);
415 * Extended header for client object.
417 struct cl_object_header {
418 /** Standard lu_object_header. cl_object::co_lu::lo_header points
420 struct lu_object_header coh_lu;
423 * Parent object. It is assumed that an object has a well-defined
424 * parent, but not a well-defined child (there may be multiple
425 * sub-objects, for the same top-object). cl_object_header::coh_parent
426 * field allows certain code to be written generically, without
427 * limiting possible cl_object layouts unduly.
429 struct cl_object_header *coh_parent;
431 * Protects consistency between cl_attr of parent object and
432 * attributes of sub-objects, that the former is calculated ("merged")
435 * \todo XXX this can be read/write lock if needed.
437 spinlock_t coh_attr_guard;
439 * Size of cl_page + page slices
441 unsigned short coh_page_bufsize;
443 * Number of objects above this one: 0 for a top-object, 1 for its
446 unsigned char coh_nesting;
450 * Helper macro: iterate over all layers of the object \a obj, assigning every
451 * layer top-to-bottom to \a slice.
453 #define cl_object_for_each(slice, obj) \
454 list_for_each_entry((slice), \
455 &(obj)->co_lu.lo_header->loh_layers,\
459 * Helper macro: iterate over all layers of the object \a obj, assigning every
460 * layer bottom-to-top to \a slice.
462 #define cl_object_for_each_reverse(slice, obj) \
463 list_for_each_entry_reverse((slice), \
464 &(obj)->co_lu.lo_header->loh_layers,\
469 #define CL_PAGE_EOF ((pgoff_t)~0ull)
471 /** \addtogroup cl_page cl_page
475 * Layered client page.
477 * cl_page: represents a portion of a file, cached in the memory. All pages
478 * of the given file are of the same size, and are kept in the radix tree
479 * hanging off the cl_object. cl_page doesn't fan out, but as sub-objects
480 * of the top-level file object are first class cl_objects, they have their
481 * own radix trees of pages and hence page is implemented as a sequence of
482 * struct cl_pages's, linked into double-linked list through
483 * cl_page::cp_parent and cl_page::cp_child pointers, each residing in the
484 * corresponding radix tree at the corresponding logical offset.
486 * cl_page is associated with VM page of the hosting environment (struct
487 * page in Linux kernel, for example), struct page. It is assumed, that this
488 * association is implemented by one of cl_page layers (top layer in the
489 * current design) that
491 * - intercepts per-VM-page call-backs made by the environment (e.g.,
494 * - translates state (page flag bits) and locking between lustre and
497 * The association between cl_page and struct page is immutable and
498 * established when cl_page is created.
500 * cl_page can be "owned" by a particular cl_io (see below), guaranteeing
501 * this io an exclusive access to this page w.r.t. other io attempts and
502 * various events changing page state (such as transfer completion, or
503 * eviction of the page from the memory). Note, that in general cl_io
504 * cannot be identified with a particular thread, and page ownership is not
505 * exactly equal to the current thread holding a lock on the page. Layer
506 * implementing association between cl_page and struct page has to implement
507 * ownership on top of available synchronization mechanisms.
509 * While lustre client maintains the notion of an page ownership by io,
510 * hosting MM/VM usually has its own page concurrency control
511 * mechanisms. For example, in Linux, page access is synchronized by the
512 * per-page PG_locked bit-lock, and generic kernel code (generic_file_*())
513 * takes care to acquire and release such locks as necessary around the
514 * calls to the file system methods (->readpage(), ->prepare_write(),
515 * ->commit_write(), etc.). This leads to the situation when there are two
516 * different ways to own a page in the client:
518 * - client code explicitly and voluntary owns the page (cl_page_own());
520 * - VM locks a page and then calls the client, that has "to assume"
521 * the ownership from the VM (cl_page_assume()).
523 * Dual methods to release ownership are cl_page_disown() and
524 * cl_page_unassume().
526 * cl_page is reference counted (cl_page::cp_ref). When reference counter
527 * drops to 0, the page is returned to the cache, unless it is in
528 * cl_page_state::CPS_FREEING state, in which case it is immediately
531 * The general logic guaranteeing the absence of "existential races" for
532 * pages is the following:
534 * - there are fixed known ways for a thread to obtain a new reference
537 * - by doing a lookup in the cl_object radix tree, protected by the
540 * - by starting from VM-locked struct page and following some
541 * hosting environment method (e.g., following ->private pointer in
542 * the case of Linux kernel), see cl_vmpage_page();
544 * - when the page enters cl_page_state::CPS_FREEING state, all these
545 * ways are severed with the proper synchronization
546 * (cl_page_delete());
548 * - entry into cl_page_state::CPS_FREEING is serialized by the VM page
551 * - no new references to the page in cl_page_state::CPS_FREEING state
552 * are allowed (checked in cl_page_get()).
554 * Together this guarantees that when last reference to a
555 * cl_page_state::CPS_FREEING page is released, it is safe to destroy the
556 * page, as neither references to it can be acquired at that point, nor
559 * cl_page is a state machine. States are enumerated in enum
560 * cl_page_state. Possible state transitions are enumerated in
561 * cl_page_state_set(). State transition process (i.e., actual changing of
562 * cl_page::cp_state field) is protected by the lock on the underlying VM
565 * Linux Kernel implementation.
567 * Binding between cl_page and struct page (which is a typedef for
568 * struct page) is implemented in the vvp layer. cl_page is attached to the
569 * ->private pointer of the struct page, together with the setting of
570 * PG_private bit in page->flags, and acquiring additional reference on the
571 * struct page (much like struct buffer_head, or any similar file system
572 * private data structures).
574 * PG_locked lock is used to implement both ownership and transfer
575 * synchronization, that is, page is VM-locked in CPS_{OWNED,PAGE{IN,OUT}}
576 * states. No additional references are acquired for the duration of the
579 * \warning *THIS IS NOT* the behavior expected by the Linux kernel, where
580 * write-out is "protected" by the special PG_writeback bit.
584 * States of cl_page. cl_page.c assumes particular order here.
586 * The page state machine is rather crude, as it doesn't recognize finer page
587 * states like "dirty" or "up to date". This is because such states are not
588 * always well defined for the whole stack (see, for example, the
589 * implementation of the read-ahead, that hides page up-to-dateness to track
590 * cache hits accurately). Such sub-states are maintained by the layers that
591 * are interested in them.
595 * Page is in the cache, un-owned. Page leaves cached state in the
598 * - [cl_page_state::CPS_OWNED] io comes across the page and
601 * - [cl_page_state::CPS_PAGEOUT] page is dirty, the
602 * req-formation engine decides that it wants to include this page
603 * into an cl_req being constructed, and yanks it from the cache;
605 * - [cl_page_state::CPS_FREEING] VM callback is executed to
606 * evict the page form the memory;
608 * \invariant cl_page::cp_owner == NULL && cl_page::cp_req == NULL
612 * Page is exclusively owned by some cl_io. Page may end up in this
613 * state as a result of
615 * - io creating new page and immediately owning it;
617 * - [cl_page_state::CPS_CACHED] io finding existing cached page
620 * - [cl_page_state::CPS_OWNED] io finding existing owned page
621 * and waiting for owner to release the page;
623 * Page leaves owned state in the following cases:
625 * - [cl_page_state::CPS_CACHED] io decides to leave the page in
626 * the cache, doing nothing;
628 * - [cl_page_state::CPS_PAGEIN] io starts read transfer for
631 * - [cl_page_state::CPS_PAGEOUT] io starts immediate write
632 * transfer for this page;
634 * - [cl_page_state::CPS_FREEING] io decides to destroy this
635 * page (e.g., as part of truncate or extent lock cancellation).
637 * \invariant cl_page::cp_owner != NULL && cl_page::cp_req == NULL
641 * Page is being written out, as a part of a transfer. This state is
642 * entered when req-formation logic decided that it wants this page to
643 * be sent through the wire _now_. Specifically, it means that once
644 * this state is achieved, transfer completion handler (with either
645 * success or failure indication) is guaranteed to be executed against
646 * this page independently of any locks and any scheduling decisions
647 * made by the hosting environment (that effectively means that the
648 * page is never put into cl_page_state::CPS_PAGEOUT state "in
649 * advance". This property is mentioned, because it is important when
650 * reasoning about possible dead-locks in the system). The page can
651 * enter this state as a result of
653 * - [cl_page_state::CPS_OWNED] an io requesting an immediate
654 * write-out of this page, or
656 * - [cl_page_state::CPS_CACHED] req-forming engine deciding
657 * that it has enough dirty pages cached to issue a "good"
660 * The page leaves cl_page_state::CPS_PAGEOUT state when the transfer
661 * is completed---it is moved into cl_page_state::CPS_CACHED state.
663 * Underlying VM page is locked for the duration of transfer.
665 * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req != NULL
669 * Page is being read in, as a part of a transfer. This is quite
670 * similar to the cl_page_state::CPS_PAGEOUT state, except that
671 * read-in is always "immediate"---there is no such thing a sudden
672 * construction of read cl_req from cached, presumably not up to date,
675 * Underlying VM page is locked for the duration of transfer.
677 * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req != NULL
681 * Page is being destroyed. This state is entered when client decides
682 * that page has to be deleted from its host object, as, e.g., a part
685 * Once this state is reached, there is no way to escape it.
687 * \invariant: cl_page::cp_owner == NULL && cl_page::cp_req == NULL
694 /** Host page, the page is from the host inode which the cl_page
698 /** Transient page, the transient cl_page is used to bind a cl_page
699 * to vmpage which is not belonging to the same object of cl_page.
700 * it is used in DirectIO, lockless IO and liblustre. */
705 * Fields are protected by the lock on struct page, except for atomics and
708 * \invariant Data type invariants are in cl_page_invariant(). Basically:
709 * cl_page::cp_parent and cl_page::cp_child are a well-formed double-linked
710 * list, consistent with the parent/child pointers in the cl_page::cp_obj and
711 * cl_page::cp_owner (when set).
714 /** Reference counter. */
716 /** Transfer error. */
718 /** An object this page is a part of. Immutable after creation. */
719 struct cl_object *cp_obj;
721 struct page *cp_vmpage;
722 /** Linkage of pages within group. Pages must be owned */
723 struct list_head cp_batch;
724 /** List of slices. Immutable after creation. */
725 struct list_head cp_layers;
726 /** Linkage of pages within cl_req. */
727 struct list_head cp_flight;
729 * Page state. This field is const to avoid accidental update, it is
730 * modified only internally within cl_page.c. Protected by a VM lock.
732 const enum cl_page_state cp_state;
734 * Page type. Only CPT_TRANSIENT is used so far. Immutable after
737 enum cl_page_type cp_type;
740 * Owning IO in cl_page_state::CPS_OWNED state. Sub-page can be owned
741 * by sub-io. Protected by a VM lock.
743 struct cl_io *cp_owner;
745 * Owning IO request in cl_page_state::CPS_PAGEOUT and
746 * cl_page_state::CPS_PAGEIN states. This field is maintained only in
747 * the top-level pages. Protected by a VM lock.
749 struct cl_req *cp_req;
750 /** List of references to this page, for debugging. */
751 struct lu_ref cp_reference;
752 /** Link to an object, for debugging. */
753 struct lu_ref_link cp_obj_ref;
754 /** Link to a queue, for debugging. */
755 struct lu_ref_link cp_queue_ref;
756 /** Assigned if doing a sync_io */
757 struct cl_sync_io *cp_sync_io;
761 * Per-layer part of cl_page.
763 * \see vvp_page, lov_page, osc_page
765 struct cl_page_slice {
766 struct cl_page *cpl_page;
769 * Object slice corresponding to this page slice. Immutable after
772 struct cl_object *cpl_obj;
773 const struct cl_page_operations *cpl_ops;
774 /** Linkage into cl_page::cp_layers. Immutable after creation. */
775 struct list_head cpl_linkage;
779 * Lock mode. For the client extent locks.
791 * Requested transfer type.
801 * Per-layer page operations.
803 * Methods taking an \a io argument are for the activity happening in the
804 * context of given \a io. Page is assumed to be owned by that io, except for
805 * the obvious cases (like cl_page_operations::cpo_own()).
807 * \see vvp_page_ops, lov_page_ops, osc_page_ops
809 struct cl_page_operations {
811 * cl_page<->struct page methods. Only one layer in the stack has to
812 * implement these. Current code assumes that this functionality is
813 * provided by the topmost layer, see cl_page_disown0() as an example.
817 * Called when \a io acquires this page into the exclusive
818 * ownership. When this method returns, it is guaranteed that the is
819 * not owned by other io, and no transfer is going on against
823 * \see vvp_page_own(), lov_page_own()
825 int (*cpo_own)(const struct lu_env *env,
826 const struct cl_page_slice *slice,
827 struct cl_io *io, int nonblock);
828 /** Called when ownership it yielded. Optional.
830 * \see cl_page_disown()
831 * \see vvp_page_disown()
833 void (*cpo_disown)(const struct lu_env *env,
834 const struct cl_page_slice *slice, struct cl_io *io);
836 * Called for a page that is already "owned" by \a io from VM point of
839 * \see cl_page_assume()
840 * \see vvp_page_assume(), lov_page_assume()
842 void (*cpo_assume)(const struct lu_env *env,
843 const struct cl_page_slice *slice, struct cl_io *io);
844 /** Dual to cl_page_operations::cpo_assume(). Optional. Called
845 * bottom-to-top when IO releases a page without actually unlocking
848 * \see cl_page_unassume()
849 * \see vvp_page_unassume()
851 void (*cpo_unassume)(const struct lu_env *env,
852 const struct cl_page_slice *slice,
855 * Announces whether the page contains valid data or not by \a uptodate.
857 * \see cl_page_export()
858 * \see vvp_page_export()
860 void (*cpo_export)(const struct lu_env *env,
861 const struct cl_page_slice *slice, int uptodate);
863 * Checks whether underlying VM page is locked (in the suitable
864 * sense). Used for assertions.
866 * \retval -EBUSY: page is protected by a lock of a given mode;
867 * \retval -ENODATA: page is not protected by a lock;
868 * \retval 0: this layer cannot decide. (Should never happen.)
870 int (*cpo_is_vmlocked)(const struct lu_env *env,
871 const struct cl_page_slice *slice);
877 * Called when page is truncated from the object. Optional.
879 * \see cl_page_discard()
880 * \see vvp_page_discard(), osc_page_discard()
882 void (*cpo_discard)(const struct lu_env *env,
883 const struct cl_page_slice *slice,
886 * Called when page is removed from the cache, and is about to being
887 * destroyed. Optional.
889 * \see cl_page_delete()
890 * \see vvp_page_delete(), osc_page_delete()
892 void (*cpo_delete)(const struct lu_env *env,
893 const struct cl_page_slice *slice);
894 /** Destructor. Frees resources and slice itself. */
895 void (*cpo_fini)(const struct lu_env *env,
896 struct cl_page_slice *slice);
898 * Optional debugging helper. Prints given page slice.
900 * \see cl_page_print()
902 int (*cpo_print)(const struct lu_env *env,
903 const struct cl_page_slice *slice,
904 void *cookie, lu_printer_t p);
908 * Transfer methods. See comment on cl_req for a description of
909 * transfer formation and life-cycle.
914 * Request type dependent vector of operations.
916 * Transfer operations depend on transfer mode (cl_req_type). To avoid
917 * passing transfer mode to each and every of these methods, and to
918 * avoid branching on request type inside of the methods, separate
919 * methods for cl_req_type:CRT_READ and cl_req_type:CRT_WRITE are
920 * provided. That is, method invocation usually looks like
922 * slice->cp_ops.io[req->crq_type].cpo_method(env, slice, ...);
926 * Called when a page is submitted for a transfer as a part of
929 * \return 0 : page is eligible for submission;
930 * \return -EALREADY : skip this page;
931 * \return -ve : error.
933 * \see cl_page_prep()
935 int (*cpo_prep)(const struct lu_env *env,
936 const struct cl_page_slice *slice,
939 * Completion handler. This is guaranteed to be eventually
940 * fired after cl_page_operations::cpo_prep() or
941 * cl_page_operations::cpo_make_ready() call.
943 * This method can be called in a non-blocking context. It is
944 * guaranteed however, that the page involved and its object
945 * are pinned in memory (and, hence, calling cl_page_put() is
948 * \see cl_page_completion()
950 void (*cpo_completion)(const struct lu_env *env,
951 const struct cl_page_slice *slice,
954 * Called when cached page is about to be added to the
955 * cl_req as a part of req formation.
957 * \return 0 : proceed with this page;
958 * \return -EAGAIN : skip this page;
959 * \return -ve : error.
961 * \see cl_page_make_ready()
963 int (*cpo_make_ready)(const struct lu_env *env,
964 const struct cl_page_slice *slice);
967 * Tell transfer engine that only [to, from] part of a page should be
970 * This is used for immediate transfers.
972 * \todo XXX this is not very good interface. It would be much better
973 * if all transfer parameters were supplied as arguments to
974 * cl_io_operations::cio_submit() call, but it is not clear how to do
975 * this for page queues.
977 * \see cl_page_clip()
979 void (*cpo_clip)(const struct lu_env *env,
980 const struct cl_page_slice *slice,
983 * \pre the page was queued for transferring.
984 * \post page is removed from client's pending list, or -EBUSY
985 * is returned if it has already been in transferring.
987 * This is one of seldom page operation which is:
988 * 0. called from top level;
989 * 1. don't have vmpage locked;
990 * 2. every layer should synchronize execution of its ->cpo_cancel()
991 * with completion handlers. Osc uses client obd lock for this
992 * purpose. Based on there is no vvp_page_cancel and
993 * lov_page_cancel(), cpo_cancel is defacto protected by client lock.
995 * \see osc_page_cancel().
997 int (*cpo_cancel)(const struct lu_env *env,
998 const struct cl_page_slice *slice);
1000 * Write out a page by kernel. This is only called by ll_writepage
1003 * \see cl_page_flush()
1005 int (*cpo_flush)(const struct lu_env *env,
1006 const struct cl_page_slice *slice,
1012 * Helper macro, dumping detailed information about \a page into a log.
1014 #define CL_PAGE_DEBUG(mask, env, page, format, ...) \
1016 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
1017 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL); \
1018 cl_page_print(env, &msgdata, lu_cdebug_printer, page); \
1019 CDEBUG(mask, format , ## __VA_ARGS__); \
1024 * Helper macro, dumping shorter information about \a page into a log.
1026 #define CL_PAGE_HEADER(mask, env, page, format, ...) \
1028 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
1029 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL); \
1030 cl_page_header_print(env, &msgdata, lu_cdebug_printer, page); \
1031 CDEBUG(mask, format , ## __VA_ARGS__); \
1035 static inline struct page *cl_page_vmpage(const struct cl_page *page)
1037 LASSERT(page->cp_vmpage != NULL);
1038 return page->cp_vmpage;
1042 * Check if a cl_page is in use.
1044 * Client cache holds a refcount, this refcount will be dropped when
1045 * the page is taken out of cache, see vvp_page_delete().
1047 static inline bool __page_in_use(const struct cl_page *page, int refc)
1049 return (atomic_read(&page->cp_ref) > refc + 1);
1053 * Caller itself holds a refcount of cl_page.
1055 #define cl_page_in_use(pg) __page_in_use(pg, 1)
1057 * Caller doesn't hold a refcount.
1059 #define cl_page_in_use_noref(pg) __page_in_use(pg, 0)
1063 /** \addtogroup cl_lock cl_lock
1067 * Extent locking on the client.
1071 * The locking model of the new client code is built around
1075 * data-type representing an extent lock on a regular file. cl_lock is a
1076 * layered object (much like cl_object and cl_page), it consists of a header
1077 * (struct cl_lock) and a list of layers (struct cl_lock_slice), linked to
1078 * cl_lock::cll_layers list through cl_lock_slice::cls_linkage.
1080 * Typical cl_lock consists of the two layers:
1082 * - vvp_lock (vvp specific data), and
1083 * - lov_lock (lov specific data).
1085 * lov_lock contains an array of sub-locks. Each of these sub-locks is a
1086 * normal cl_lock: it has a header (struct cl_lock) and a list of layers:
1088 * - lovsub_lock, and
1091 * Each sub-lock is associated with a cl_object (representing stripe
1092 * sub-object or the file to which top-level cl_lock is associated to), and is
1093 * linked into that cl_object::coh_locks. In this respect cl_lock is similar to
1094 * cl_object (that at lov layer also fans out into multiple sub-objects), and
1095 * is different from cl_page, that doesn't fan out (there is usually exactly
1096 * one osc_page for every vvp_page). We shall call vvp-lov portion of the lock
1097 * a "top-lock" and its lovsub-osc portion a "sub-lock".
1101 * cl_lock is a cacheless data container for the requirements of locks to
1102 * complete the IO. cl_lock is created before I/O starts and destroyed when the
1105 * cl_lock depends on LDLM lock to fulfill lock semantics. LDLM lock is attached
1106 * to cl_lock at OSC layer. LDLM lock is still cacheable.
1108 * INTERFACE AND USAGE
1110 * Two major methods are supported for cl_lock: clo_enqueue and clo_cancel. A
1111 * cl_lock is enqueued by cl_lock_request(), which will call clo_enqueue()
1112 * methods for each layer to enqueue the lock. At the LOV layer, if a cl_lock
1113 * consists of multiple sub cl_locks, each sub locks will be enqueued
1114 * correspondingly. At OSC layer, the lock enqueue request will tend to reuse
1115 * cached LDLM lock; otherwise a new LDLM lock will have to be requested from
1118 * cl_lock_cancel() must be called to release a cl_lock after use. clo_cancel()
1119 * method will be called for each layer to release the resource held by this
1120 * lock. At OSC layer, the reference count of LDLM lock, which is held at
1121 * clo_enqueue time, is released.
1123 * LDLM lock can only be canceled if there is no cl_lock using it.
1125 * Overall process of the locking during IO operation is as following:
1127 * - once parameters for IO are setup in cl_io, cl_io_operations::cio_lock()
1128 * is called on each layer. Responsibility of this method is to add locks,
1129 * needed by a given layer into cl_io.ci_lockset.
1131 * - once locks for all layers were collected, they are sorted to avoid
1132 * dead-locks (cl_io_locks_sort()), and enqueued.
1134 * - when all locks are acquired, IO is performed;
1136 * - locks are released after IO is complete.
1138 * Striping introduces major additional complexity into locking. The
1139 * fundamental problem is that it is generally unsafe to actively use (hold)
1140 * two locks on the different OST servers at the same time, as this introduces
1141 * inter-server dependency and can lead to cascading evictions.
1143 * Basic solution is to sub-divide large read/write IOs into smaller pieces so
1144 * that no multi-stripe locks are taken (note that this design abandons POSIX
1145 * read/write semantics). Such pieces ideally can be executed concurrently. At
1146 * the same time, certain types of IO cannot be sub-divived, without
1147 * sacrificing correctness. This includes:
1149 * - O_APPEND write, where [0, EOF] lock has to be taken, to guarantee
1152 * - ftruncate(fd, offset), where [offset, EOF] lock has to be taken.
1154 * Also, in the case of read(fd, buf, count) or write(fd, buf, count), where
1155 * buf is a part of memory mapped Lustre file, a lock or locks protecting buf
1156 * has to be held together with the usual lock on [offset, offset + count].
1158 * Interaction with DLM
1160 * In the expected setup, cl_lock is ultimately backed up by a collection of
1161 * DLM locks (struct ldlm_lock). Association between cl_lock and DLM lock is
1162 * implemented in osc layer, that also matches DLM events (ASTs, cancellation,
1163 * etc.) into cl_lock_operation calls. See struct osc_lock for a more detailed
1164 * description of interaction with DLM.
1170 struct cl_lock_descr {
1171 /** Object this lock is granted for. */
1172 struct cl_object *cld_obj;
1173 /** Index of the first page protected by this lock. */
1175 /** Index of the last page (inclusive) protected by this lock. */
1177 /** Group ID, for group lock */
1180 enum cl_lock_mode cld_mode;
1182 * flags to enqueue lock. A combination of bit-flags from
1183 * enum cl_enq_flags.
1185 __u32 cld_enq_flags;
1188 #define DDESCR "%s(%d):[%lu, %lu]:%x"
1189 #define PDESCR(descr) \
1190 cl_lock_mode_name((descr)->cld_mode), (descr)->cld_mode, \
1191 (descr)->cld_start, (descr)->cld_end, (descr)->cld_enq_flags
1193 const char *cl_lock_mode_name(const enum cl_lock_mode mode);
1196 * Layered client lock.
1199 /** List of slices. Immutable after creation. */
1200 struct list_head cll_layers;
1201 /** lock attribute, extent, cl_object, etc. */
1202 struct cl_lock_descr cll_descr;
1206 * Per-layer part of cl_lock
1208 * \see vvp_lock, lov_lock, lovsub_lock, osc_lock
1210 struct cl_lock_slice {
1211 struct cl_lock *cls_lock;
1212 /** Object slice corresponding to this lock slice. Immutable after
1214 struct cl_object *cls_obj;
1215 const struct cl_lock_operations *cls_ops;
1216 /** Linkage into cl_lock::cll_layers. Immutable after creation. */
1217 struct list_head cls_linkage;
1222 * \see vvp_lock_ops, lov_lock_ops, lovsub_lock_ops, osc_lock_ops
1224 struct cl_lock_operations {
1227 * Attempts to enqueue the lock. Called top-to-bottom.
1229 * \retval 0 this layer has enqueued the lock successfully
1230 * \retval >0 this layer has enqueued the lock, but need to wait on
1231 * @anchor for resources
1232 * \retval -ve failure
1234 * \see vvp_lock_enqueue(), lov_lock_enqueue(), lovsub_lock_enqueue(),
1235 * \see osc_lock_enqueue()
1237 int (*clo_enqueue)(const struct lu_env *env,
1238 const struct cl_lock_slice *slice,
1239 struct cl_io *io, struct cl_sync_io *anchor);
1241 * Cancel a lock, release its DLM lock ref, while does not cancel the
1244 void (*clo_cancel)(const struct lu_env *env,
1245 const struct cl_lock_slice *slice);
1248 * Destructor. Frees resources and the slice.
1250 * \see vvp_lock_fini(), lov_lock_fini(), lovsub_lock_fini(),
1251 * \see osc_lock_fini()
1253 void (*clo_fini)(const struct lu_env *env, struct cl_lock_slice *slice);
1255 * Optional debugging helper. Prints given lock slice.
1257 int (*clo_print)(const struct lu_env *env,
1258 void *cookie, lu_printer_t p,
1259 const struct cl_lock_slice *slice);
1262 #define CL_LOCK_DEBUG(mask, env, lock, format, ...) \
1264 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
1265 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL); \
1266 cl_lock_print(env, &msgdata, lu_cdebug_printer, lock); \
1267 CDEBUG(mask, format , ## __VA_ARGS__); \
1271 #define CL_LOCK_ASSERT(expr, env, lock) do { \
1275 CL_LOCK_DEBUG(D_ERROR, env, lock, "failed at %s.\n", #expr); \
1281 /** \addtogroup cl_page_list cl_page_list
1282 * Page list used to perform collective operations on a group of pages.
1284 * Pages are added to the list one by one. cl_page_list acquires a reference
1285 * for every page in it. Page list is used to perform collective operations on
1288 * - submit pages for an immediate transfer,
1290 * - own pages on behalf of certain io (waiting for each page in turn),
1294 * When list is finalized, it releases references on all pages it still has.
1296 * \todo XXX concurrency control.
1300 struct cl_page_list {
1302 struct list_head pl_pages;
1303 struct task_struct *pl_owner;
1307 * A 2-queue of pages. A convenience data-type for common use case, 2-queue
1308 * contains an incoming page list and an outgoing page list.
1311 struct cl_page_list c2_qin;
1312 struct cl_page_list c2_qout;
1315 /** @} cl_page_list */
1317 /** \addtogroup cl_io cl_io
1322 * cl_io represents a high level I/O activity like
1323 * read(2)/write(2)/truncate(2) system call, or cancellation of an extent
1326 * cl_io is a layered object, much like cl_{object,page,lock} but with one
1327 * important distinction. We want to minimize number of calls to the allocator
1328 * in the fast path, e.g., in the case of read(2) when everything is cached:
1329 * client already owns the lock over region being read, and data are cached
1330 * due to read-ahead. To avoid allocation of cl_io layers in such situations,
1331 * per-layer io state is stored in the session, associated with the io, see
1332 * struct {vvp,lov,osc}_io for example. Sessions allocation is amortized
1333 * by using free-lists, see cl_env_get().
1335 * There is a small predefined number of possible io types, enumerated in enum
1338 * cl_io is a state machine, that can be advanced concurrently by the multiple
1339 * threads. It is up to these threads to control the concurrency and,
1340 * specifically, to detect when io is done, and its state can be safely
1343 * For read/write io overall execution plan is as following:
1345 * (0) initialize io state through all layers;
1347 * (1) loop: prepare chunk of work to do
1349 * (2) call all layers to collect locks they need to process current chunk
1351 * (3) sort all locks to avoid dead-locks, and acquire them
1353 * (4) process the chunk: call per-page methods
1354 * cl_io_operations::cio_prepare_write(),
1355 * cl_io_operations::cio_commit_write() for write)
1361 * To implement the "parallel IO mode", lov layer creates sub-io's (lazily to
1362 * address allocation efficiency issues mentioned above), and returns with the
1363 * special error condition from per-page method when current sub-io has to
1364 * block. This causes io loop to be repeated, and lov switches to the next
1365 * sub-io in its cl_io_operations::cio_iter_init() implementation.
1370 /** read system call */
1372 /** write system call */
1374 /** truncate, utime system calls */
1377 * page fault handling
1381 * fsync system call handling
1382 * To write out a range of file
1386 * Miscellaneous io. This is used for occasional io activity that
1387 * doesn't fit into other types. Currently this is used for:
1389 * - cancellation of an extent lock. This io exists as a context
1390 * to write dirty pages from under the lock being canceled back
1393 * - VM induced page write-out. An io context for writing page out
1394 * for memory cleansing;
1396 * - glimpse. An io context to acquire glimpse lock.
1398 * - grouplock. An io context to acquire group lock.
1400 * CIT_MISC io is used simply as a context in which locks and pages
1401 * are manipulated. Such io has no internal "process", that is,
1402 * cl_io_loop() is never called for it.
1409 * States of cl_io state machine
1412 /** Not initialized. */
1416 /** IO iteration started. */
1420 /** Actual IO is in progress. */
1422 /** IO for the current iteration finished. */
1424 /** Locks released. */
1426 /** Iteration completed. */
1428 /** cl_io finalized. */
1433 * IO state private for a layer.
1435 * This is usually embedded into layer session data, rather than allocated
1438 * \see vvp_io, lov_io, osc_io
1440 struct cl_io_slice {
1441 struct cl_io *cis_io;
1442 /** corresponding object slice. Immutable after creation. */
1443 struct cl_object *cis_obj;
1444 /** io operations. Immutable after creation. */
1445 const struct cl_io_operations *cis_iop;
1447 * linkage into a list of all slices for a given cl_io, hanging off
1448 * cl_io::ci_layers. Immutable after creation.
1450 struct list_head cis_linkage;
1453 typedef void (*cl_commit_cbt)(const struct lu_env *, struct cl_io *,
1456 struct cl_read_ahead {
1457 /* Maximum page index the readahead window will end.
1458 * This is determined DLM lock coverage, RPC and stripe boundary.
1459 * cra_end is included. */
1461 /* Release routine. If readahead holds resources underneath, this
1462 * function should be called to release it. */
1463 void (*cra_release)(const struct lu_env *env, void *cbdata);
1464 /* Callback data for cra_release routine */
1468 static inline void cl_read_ahead_release(const struct lu_env *env,
1469 struct cl_read_ahead *ra)
1471 if (ra->cra_release != NULL)
1472 ra->cra_release(env, ra->cra_cbdata);
1473 memset(ra, 0, sizeof(*ra));
1478 * Per-layer io operations.
1479 * \see vvp_io_ops, lov_io_ops, lovsub_io_ops, osc_io_ops
1481 struct cl_io_operations {
1483 * Vector of io state transition methods for every io type.
1485 * \see cl_page_operations::io
1489 * Prepare io iteration at a given layer.
1491 * Called top-to-bottom at the beginning of each iteration of
1492 * "io loop" (if it makes sense for this type of io). Here
1493 * layer selects what work it will do during this iteration.
1495 * \see cl_io_operations::cio_iter_fini()
1497 int (*cio_iter_init) (const struct lu_env *env,
1498 const struct cl_io_slice *slice);
1500 * Finalize io iteration.
1502 * Called bottom-to-top at the end of each iteration of "io
1503 * loop". Here layers can decide whether IO has to be
1506 * \see cl_io_operations::cio_iter_init()
1508 void (*cio_iter_fini) (const struct lu_env *env,
1509 const struct cl_io_slice *slice);
1511 * Collect locks for the current iteration of io.
1513 * Called top-to-bottom to collect all locks necessary for
1514 * this iteration. This methods shouldn't actually enqueue
1515 * anything, instead it should post a lock through
1516 * cl_io_lock_add(). Once all locks are collected, they are
1517 * sorted and enqueued in the proper order.
1519 int (*cio_lock) (const struct lu_env *env,
1520 const struct cl_io_slice *slice);
1522 * Finalize unlocking.
1524 * Called bottom-to-top to finish layer specific unlocking
1525 * functionality, after generic code released all locks
1526 * acquired by cl_io_operations::cio_lock().
1528 void (*cio_unlock)(const struct lu_env *env,
1529 const struct cl_io_slice *slice);
1531 * Start io iteration.
1533 * Once all locks are acquired, called top-to-bottom to
1534 * commence actual IO. In the current implementation,
1535 * top-level vvp_io_{read,write}_start() does all the work
1536 * synchronously by calling generic_file_*(), so other layers
1537 * are called when everything is done.
1539 int (*cio_start)(const struct lu_env *env,
1540 const struct cl_io_slice *slice);
1542 * Called top-to-bottom at the end of io loop. Here layer
1543 * might wait for an unfinished asynchronous io.
1545 void (*cio_end) (const struct lu_env *env,
1546 const struct cl_io_slice *slice);
1548 * Called bottom-to-top to notify layers that read/write IO
1549 * iteration finished, with \a nob bytes transferred.
1551 void (*cio_advance)(const struct lu_env *env,
1552 const struct cl_io_slice *slice,
1555 * Called once per io, bottom-to-top to release io resources.
1557 void (*cio_fini) (const struct lu_env *env,
1558 const struct cl_io_slice *slice);
1562 * Submit pages from \a queue->c2_qin for IO, and move
1563 * successfully submitted pages into \a queue->c2_qout. Return
1564 * non-zero if failed to submit even the single page. If
1565 * submission failed after some pages were moved into \a
1566 * queue->c2_qout, completion callback with non-zero ioret is
1569 int (*cio_submit)(const struct lu_env *env,
1570 const struct cl_io_slice *slice,
1571 enum cl_req_type crt,
1572 struct cl_2queue *queue);
1574 * Queue async page for write.
1575 * The difference between cio_submit and cio_queue is that
1576 * cio_submit is for urgent request.
1578 int (*cio_commit_async)(const struct lu_env *env,
1579 const struct cl_io_slice *slice,
1580 struct cl_page_list *queue, int from, int to,
1583 * Decide maximum read ahead extent
1585 * \pre io->ci_type == CIT_READ
1587 int (*cio_read_ahead)(const struct lu_env *env,
1588 const struct cl_io_slice *slice,
1589 pgoff_t start, struct cl_read_ahead *ra);
1591 * Optional debugging helper. Print given io slice.
1593 int (*cio_print)(const struct lu_env *env, void *cookie,
1594 lu_printer_t p, const struct cl_io_slice *slice);
1598 * Flags to lock enqueue procedure.
1603 * instruct server to not block, if conflicting lock is found. Instead
1604 * -EWOULDBLOCK is returned immediately.
1606 CEF_NONBLOCK = 0x00000001,
1608 * take lock asynchronously (out of order), as it cannot
1609 * deadlock. This is for LDLM_FL_HAS_INTENT locks used for glimpsing.
1611 CEF_ASYNC = 0x00000002,
1613 * tell the server to instruct (though a flag in the blocking ast) an
1614 * owner of the conflicting lock, that it can drop dirty pages
1615 * protected by this lock, without sending them to the server.
1617 CEF_DISCARD_DATA = 0x00000004,
1619 * tell the sub layers that it must be a `real' lock. This is used for
1620 * mmapped-buffer locks and glimpse locks that must be never converted
1621 * into lockless mode.
1623 * \see vvp_mmap_locks(), cl_glimpse_lock().
1625 CEF_MUST = 0x00000008,
1627 * tell the sub layers that never request a `real' lock. This flag is
1628 * not used currently.
1630 * cl_io::ci_lockreq and CEF_{MUST,NEVER} flags specify lockless
1631 * conversion policy: ci_lockreq describes generic information of lock
1632 * requirement for this IO, especially for locks which belong to the
1633 * object doing IO; however, lock itself may have precise requirements
1634 * that are described by the enqueue flags.
1636 CEF_NEVER = 0x00000010,
1638 * for async glimpse lock.
1640 CEF_AGL = 0x00000020,
1642 * enqueue a lock to test DLM lock existence.
1644 CEF_PEEK = 0x00000040,
1646 * mask of enq_flags.
1648 CEF_MASK = 0x0000007f,
1652 * Link between lock and io. Intermediate structure is needed, because the
1653 * same lock can be part of multiple io's simultaneously.
1655 struct cl_io_lock_link {
1656 /** linkage into one of cl_lockset lists. */
1657 struct list_head cill_linkage;
1658 struct cl_lock cill_lock;
1659 /** optional destructor */
1660 void (*cill_fini)(const struct lu_env *env,
1661 struct cl_io_lock_link *link);
1663 #define cill_descr cill_lock.cll_descr
1666 * Lock-set represents a collection of locks, that io needs at a
1667 * time. Generally speaking, client tries to avoid holding multiple locks when
1670 * - holding extent locks over multiple ost's introduces the danger of
1671 * "cascading timeouts";
1673 * - holding multiple locks over the same ost is still dead-lock prone,
1674 * see comment in osc_lock_enqueue(),
1676 * but there are certain situations where this is unavoidable:
1678 * - O_APPEND writes have to take [0, EOF] lock for correctness;
1680 * - truncate has to take [new-size, EOF] lock for correctness;
1682 * - SNS has to take locks across full stripe for correctness;
1684 * - in the case when user level buffer, supplied to {read,write}(file0),
1685 * is a part of a memory mapped lustre file, client has to take a dlm
1686 * locks on file0, and all files that back up the buffer (or a part of
1687 * the buffer, that is being processed in the current chunk, in any
1688 * case, there are situations where at least 2 locks are necessary).
1690 * In such cases we at least try to take locks in the same consistent
1691 * order. To this end, all locks are first collected, then sorted, and then
1695 /** locks to be acquired. */
1696 struct list_head cls_todo;
1697 /** locks acquired. */
1698 struct list_head cls_done;
1702 * Lock requirements(demand) for IO. It should be cl_io_lock_req,
1703 * but 'req' is always to be thought as 'request' :-)
1705 enum cl_io_lock_dmd {
1706 /** Always lock data (e.g., O_APPEND). */
1708 /** Layers are free to decide between local and global locking. */
1710 /** Never lock: there is no cache (e.g., liblustre). */
1714 enum cl_fsync_mode {
1715 /** start writeback, do not wait for them to finish */
1717 /** start writeback and wait for them to finish */
1719 /** discard all of dirty pages in a specific file range */
1720 CL_FSYNC_DISCARD = 2,
1721 /** start writeback and make sure they have reached storage before
1722 * return. OST_SYNC RPC must be issued and finished */
1726 struct cl_io_rw_common {
1736 * cl_io is shared by all threads participating in this IO (in current
1737 * implementation only one thread advances IO, but parallel IO design and
1738 * concurrent copy_*_user() require multiple threads acting on the same IO. It
1739 * is up to these threads to serialize their activities, including updates to
1740 * mutable cl_io fields.
1743 /** type of this IO. Immutable after creation. */
1744 enum cl_io_type ci_type;
1745 /** current state of cl_io state machine. */
1746 enum cl_io_state ci_state;
1747 /** main object this io is against. Immutable after creation. */
1748 struct cl_object *ci_obj;
1750 * Upper layer io, of which this io is a part of. Immutable after
1753 struct cl_io *ci_parent;
1754 /** List of slices. Immutable after creation. */
1755 struct list_head ci_layers;
1756 /** list of locks (to be) acquired by this io. */
1757 struct cl_lockset ci_lockset;
1758 /** lock requirements, this is just a help info for sublayers. */
1759 enum cl_io_lock_dmd ci_lockreq;
1762 struct cl_io_rw_common rd;
1765 struct cl_io_rw_common wr;
1769 struct cl_io_rw_common ci_rw;
1770 struct cl_setattr_io {
1771 struct ost_lvb sa_attr;
1772 unsigned int sa_valid;
1773 int sa_stripe_index;
1774 struct lu_fid *sa_parent_fid;
1775 struct obd_capa *sa_capa;
1777 struct cl_fault_io {
1778 /** page index within file. */
1780 /** bytes valid byte on a faulted page. */
1782 /** writable page? for nopage() only */
1784 /** page of an executable? */
1786 /** page_mkwrite() */
1788 /** resulting page */
1789 struct cl_page *ft_page;
1791 struct cl_fsync_io {
1794 struct obd_capa *fi_capa;
1795 /** file system level fid */
1796 struct lu_fid *fi_fid;
1797 enum cl_fsync_mode fi_mode;
1798 /* how many pages were written/discarded */
1799 unsigned int fi_nr_written;
1802 struct cl_2queue ci_queue;
1805 unsigned int ci_continue:1,
1807 * This io has held grouplock, to inform sublayers that
1808 * don't do lockless i/o.
1812 * The whole IO need to be restarted because layout has been changed
1816 * to not refresh layout - the IO issuer knows that the layout won't
1817 * change(page operations, layout change causes all page to be
1818 * discarded), or it doesn't matter if it changes(sync).
1822 * Check if layout changed after the IO finishes. Mainly for HSM
1823 * requirement. If IO occurs to openning files, it doesn't need to
1824 * verify layout because HSM won't release openning files.
1825 * Right now, only two opertaions need to verify layout: glimpse
1830 * file is released, restore has to to be triggered by vvp layer
1832 ci_restore_needed:1,
1838 * Number of pages owned by this IO. For invariant checking.
1840 unsigned ci_owned_nr;
1845 /** \addtogroup cl_req cl_req
1850 * There are two possible modes of transfer initiation on the client:
1852 * - immediate transfer: this is started when a high level io wants a page
1853 * or a collection of pages to be transferred right away. Examples:
1854 * read-ahead, synchronous read in the case of non-page aligned write,
1855 * page write-out as a part of extent lock cancellation, page write-out
1856 * as a part of memory cleansing. Immediate transfer can be both
1857 * cl_req_type::CRT_READ and cl_req_type::CRT_WRITE;
1859 * - opportunistic transfer (cl_req_type::CRT_WRITE only), that happens
1860 * when io wants to transfer a page to the server some time later, when
1861 * it can be done efficiently. Example: pages dirtied by the write(2)
1864 * In any case, transfer takes place in the form of a cl_req, which is a
1865 * representation for a network RPC.
1867 * Pages queued for an opportunistic transfer are cached until it is decided
1868 * that efficient RPC can be composed of them. This decision is made by "a
1869 * req-formation engine", currently implemented as a part of osc
1870 * layer. Req-formation depends on many factors: the size of the resulting
1871 * RPC, whether or not multi-object RPCs are supported by the server,
1872 * max-rpc-in-flight limitations, size of the dirty cache, etc.
1874 * For the immediate transfer io submits a cl_page_list, that req-formation
1875 * engine slices into cl_req's, possibly adding cached pages to some of
1876 * the resulting req's.
1878 * Whenever a page from cl_page_list is added to a newly constructed req, its
1879 * cl_page_operations::cpo_prep() layer methods are called. At that moment,
1880 * page state is atomically changed from cl_page_state::CPS_OWNED to
1881 * cl_page_state::CPS_PAGEOUT or cl_page_state::CPS_PAGEIN, cl_page::cp_owner
1882 * is zeroed, and cl_page::cp_req is set to the
1883 * req. cl_page_operations::cpo_prep() method at the particular layer might
1884 * return -EALREADY to indicate that it does not need to submit this page
1885 * at all. This is possible, for example, if page, submitted for read,
1886 * became up-to-date in the meantime; and for write, the page don't have
1887 * dirty bit marked. \see cl_io_submit_rw()
1889 * Whenever a cached page is added to a newly constructed req, its
1890 * cl_page_operations::cpo_make_ready() layer methods are called. At that
1891 * moment, page state is atomically changed from cl_page_state::CPS_CACHED to
1892 * cl_page_state::CPS_PAGEOUT, and cl_page::cp_req is set to
1893 * req. cl_page_operations::cpo_make_ready() method at the particular layer
1894 * might return -EAGAIN to indicate that this page is not eligible for the
1895 * transfer right now.
1899 * Plan is to divide transfers into "priority bands" (indicated when
1900 * submitting cl_page_list, and queuing a page for the opportunistic transfer)
1901 * and allow glueing of cached pages to immediate transfers only within single
1902 * band. This would make high priority transfers (like lock cancellation or
1903 * memory pressure induced write-out) really high priority.
1908 * Per-transfer attributes.
1910 struct cl_req_attr {
1911 /** Generic attributes for the server consumption. */
1912 struct obdo *cra_oa;
1914 struct obd_capa *cra_capa;
1916 char cra_jobid[LUSTRE_JOBID_SIZE];
1920 * Transfer request operations definable at every layer.
1922 * Concurrency: transfer formation engine synchronizes calls to all transfer
1925 struct cl_req_operations {
1927 * Invoked top-to-bottom by cl_req_prep() when transfer formation is
1928 * complete (all pages are added).
1930 * \see osc_req_prep()
1932 int (*cro_prep)(const struct lu_env *env,
1933 const struct cl_req_slice *slice);
1935 * Called top-to-bottom to fill in \a oa fields. This is called twice
1936 * with different flags, see bug 10150 and osc_build_req().
1938 * \param obj an object from cl_req which attributes are to be set in
1941 * \param oa struct obdo where attributes are placed
1943 * \param flags \a oa fields to be filled.
1945 void (*cro_attr_set)(const struct lu_env *env,
1946 const struct cl_req_slice *slice,
1947 const struct cl_object *obj,
1948 struct cl_req_attr *attr, u64 flags);
1950 * Called top-to-bottom from cl_req_completion() to notify layers that
1951 * transfer completed. Has to free all state allocated by
1952 * cl_device_operations::cdo_req_init().
1954 void (*cro_completion)(const struct lu_env *env,
1955 const struct cl_req_slice *slice, int ioret);
1959 * A per-object state that (potentially multi-object) transfer request keeps.
1962 /** object itself */
1963 struct cl_object *ro_obj;
1964 /** reference to cl_req_obj::ro_obj. For debugging. */
1965 struct lu_ref_link ro_obj_ref;
1966 /* something else? Number of pages for a given object? */
1972 * Transfer requests are not reference counted, because IO sub-system owns
1973 * them exclusively and knows when to free them.
1977 * cl_req is created by cl_req_alloc() that calls
1978 * cl_device_operations::cdo_req_init() device methods to allocate per-req
1979 * state in every layer.
1981 * Then pages are added (cl_req_page_add()), req keeps track of all objects it
1982 * contains pages for.
1984 * Once all pages were collected, cl_page_operations::cpo_prep() method is
1985 * called top-to-bottom. At that point layers can modify req, let it pass, or
1986 * deny it completely. This is to support things like SNS that have transfer
1987 * ordering requirements invisible to the individual req-formation engine.
1989 * On transfer completion (or transfer timeout, or failure to initiate the
1990 * transfer of an allocated req), cl_req_operations::cro_completion() method
1991 * is called, after execution of cl_page_operations::cpo_completion() of all
1995 enum cl_req_type crq_type;
1996 /** A list of pages being transfered */
1997 struct list_head crq_pages;
1998 /** Number of pages in cl_req::crq_pages */
1999 unsigned crq_nrpages;
2000 /** An array of objects which pages are in ->crq_pages */
2001 struct cl_req_obj *crq_o;
2002 /** Number of elements in cl_req::crq_objs[] */
2003 unsigned crq_nrobjs;
2004 struct list_head crq_layers;
2008 * Per-layer state for request.
2010 struct cl_req_slice {
2011 struct cl_req *crs_req;
2012 struct cl_device *crs_dev;
2013 struct list_head crs_linkage;
2014 const struct cl_req_operations *crs_ops;
2019 enum cache_stats_item {
2020 /** how many cache lookups were performed */
2022 /** how many times cache lookup resulted in a hit */
2024 /** how many entities are in the cache right now */
2026 /** how many entities in the cache are actively used (and cannot be
2027 * evicted) right now */
2029 /** how many entities were created at all */
2034 #define CS_NAMES { "lookup", "hit", "total", "busy", "create" }
2037 * Stats for a generic cache (similar to inode, lu_object, etc. caches).
2039 struct cache_stats {
2040 const char *cs_name;
2041 atomic_t cs_stats[CS_NR];
2044 /** These are not exported so far */
2045 void cache_stats_init (struct cache_stats *cs, const char *name);
2048 * Client-side site. This represents particular client stack. "Global"
2049 * variables should (directly or indirectly) be added here to allow multiple
2050 * clients to co-exist in the single address space.
2053 struct lu_site cs_lu;
2055 * Statistical counters. Atomics do not scale, something better like
2056 * per-cpu counters is needed.
2058 * These are exported as /proc/fs/lustre/llite/.../site
2060 * When interpreting keep in mind that both sub-locks (and sub-pages)
2061 * and top-locks (and top-pages) are accounted here.
2063 struct cache_stats cs_pages;
2064 atomic_t cs_pages_state[CPS_NR];
2067 int cl_site_init(struct cl_site *s, struct cl_device *top);
2068 void cl_site_fini(struct cl_site *s);
2069 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl);
2072 * Output client site statistical counters into a buffer. Suitable for
2073 * ll_rd_*()-style functions.
2075 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m);
2080 * Type conversion and accessory functions.
2084 static inline struct cl_site *lu2cl_site(const struct lu_site *site)
2086 return container_of(site, struct cl_site, cs_lu);
2089 static inline struct cl_device *lu2cl_dev(const struct lu_device *d)
2091 LASSERT(d == NULL || IS_ERR(d) || lu_device_is_cl(d));
2092 return container_of0(d, struct cl_device, cd_lu_dev);
2095 static inline struct lu_device *cl2lu_dev(struct cl_device *d)
2097 return &d->cd_lu_dev;
2100 static inline struct cl_object *lu2cl(const struct lu_object *o)
2102 LASSERT(o == NULL || IS_ERR(o) || lu_device_is_cl(o->lo_dev));
2103 return container_of0(o, struct cl_object, co_lu);
2106 static inline const struct cl_object_conf *
2107 lu2cl_conf(const struct lu_object_conf *conf)
2109 return container_of0(conf, struct cl_object_conf, coc_lu);
2112 static inline struct cl_object *cl_object_next(const struct cl_object *obj)
2114 return obj ? lu2cl(lu_object_next(&obj->co_lu)) : NULL;
2117 static inline struct cl_object_header *luh2coh(const struct lu_object_header *h)
2119 return container_of0(h, struct cl_object_header, coh_lu);
2122 static inline struct cl_site *cl_object_site(const struct cl_object *obj)
2124 return lu2cl_site(obj->co_lu.lo_dev->ld_site);
2128 struct cl_object_header *cl_object_header(const struct cl_object *obj)
2130 return luh2coh(obj->co_lu.lo_header);
2133 static inline int cl_device_init(struct cl_device *d, struct lu_device_type *t)
2135 return lu_device_init(&d->cd_lu_dev, t);
2138 static inline void cl_device_fini(struct cl_device *d)
2140 lu_device_fini(&d->cd_lu_dev);
2143 void cl_page_slice_add(struct cl_page *page, struct cl_page_slice *slice,
2144 struct cl_object *obj, pgoff_t index,
2145 const struct cl_page_operations *ops);
2146 void cl_lock_slice_add(struct cl_lock *lock, struct cl_lock_slice *slice,
2147 struct cl_object *obj,
2148 const struct cl_lock_operations *ops);
2149 void cl_io_slice_add(struct cl_io *io, struct cl_io_slice *slice,
2150 struct cl_object *obj, const struct cl_io_operations *ops);
2151 void cl_req_slice_add(struct cl_req *req, struct cl_req_slice *slice,
2152 struct cl_device *dev,
2153 const struct cl_req_operations *ops);
2156 /** \defgroup cl_object cl_object
2158 struct cl_object *cl_object_top (struct cl_object *o);
2159 struct cl_object *cl_object_find(const struct lu_env *env, struct cl_device *cd,
2160 const struct lu_fid *fid,
2161 const struct cl_object_conf *c);
2163 int cl_object_header_init(struct cl_object_header *h);
2164 void cl_object_header_fini(struct cl_object_header *h);
2165 void cl_object_put (const struct lu_env *env, struct cl_object *o);
2166 void cl_object_get (struct cl_object *o);
2167 void cl_object_attr_lock (struct cl_object *o);
2168 void cl_object_attr_unlock(struct cl_object *o);
2169 int cl_object_attr_get (const struct lu_env *env, struct cl_object *obj,
2170 struct cl_attr *attr);
2171 int cl_object_attr_update(const struct lu_env *env, struct cl_object *obj,
2172 const struct cl_attr *attr, unsigned valid);
2173 int cl_object_glimpse (const struct lu_env *env, struct cl_object *obj,
2174 struct ost_lvb *lvb);
2175 int cl_conf_set (const struct lu_env *env, struct cl_object *obj,
2176 const struct cl_object_conf *conf);
2177 int cl_object_prune (const struct lu_env *env, struct cl_object *obj);
2178 void cl_object_kill (const struct lu_env *env, struct cl_object *obj);
2179 int cl_object_getstripe(const struct lu_env *env, struct cl_object *obj,
2180 struct lov_user_md __user *lum);
2181 int cl_object_find_cbdata(const struct lu_env *env, struct cl_object *obj,
2182 ldlm_iterator_t iter, void *data);
2185 * Returns true, iff \a o0 and \a o1 are slices of the same object.
2187 static inline int cl_object_same(struct cl_object *o0, struct cl_object *o1)
2189 return cl_object_header(o0) == cl_object_header(o1);
2192 static inline void cl_object_page_init(struct cl_object *clob, int size)
2194 clob->co_slice_off = cl_object_header(clob)->coh_page_bufsize;
2195 cl_object_header(clob)->coh_page_bufsize += cfs_size_round(size);
2196 WARN_ON(cl_object_header(clob)->coh_page_bufsize > 512);
2199 static inline void *cl_object_page_slice(struct cl_object *clob,
2200 struct cl_page *page)
2202 return (void *)((char *)page + clob->co_slice_off);
2206 * Return refcount of cl_object.
2208 static inline int cl_object_refc(struct cl_object *clob)
2210 struct lu_object_header *header = clob->co_lu.lo_header;
2211 return atomic_read(&header->loh_ref);
2216 /** \defgroup cl_page cl_page
2224 /* callback of cl_page_gang_lookup() */
2226 struct cl_page *cl_page_find (const struct lu_env *env,
2227 struct cl_object *obj,
2228 pgoff_t idx, struct page *vmpage,
2229 enum cl_page_type type);
2230 struct cl_page *cl_page_alloc (const struct lu_env *env,
2231 struct cl_object *o, pgoff_t ind,
2232 struct page *vmpage,
2233 enum cl_page_type type);
2234 void cl_page_get (struct cl_page *page);
2235 void cl_page_put (const struct lu_env *env,
2236 struct cl_page *page);
2237 void cl_page_print (const struct lu_env *env, void *cookie,
2238 lu_printer_t printer,
2239 const struct cl_page *pg);
2240 void cl_page_header_print(const struct lu_env *env, void *cookie,
2241 lu_printer_t printer,
2242 const struct cl_page *pg);
2243 struct cl_page *cl_vmpage_page (struct page *vmpage, struct cl_object *obj);
2244 struct cl_page *cl_page_top (struct cl_page *page);
2246 const struct cl_page_slice *cl_page_at(const struct cl_page *page,
2247 const struct lu_device_type *dtype);
2252 * Functions dealing with the ownership of page by io.
2256 int cl_page_own (const struct lu_env *env,
2257 struct cl_io *io, struct cl_page *page);
2258 int cl_page_own_try (const struct lu_env *env,
2259 struct cl_io *io, struct cl_page *page);
2260 void cl_page_assume (const struct lu_env *env,
2261 struct cl_io *io, struct cl_page *page);
2262 void cl_page_unassume (const struct lu_env *env,
2263 struct cl_io *io, struct cl_page *pg);
2264 void cl_page_disown (const struct lu_env *env,
2265 struct cl_io *io, struct cl_page *page);
2266 int cl_page_is_owned (const struct cl_page *pg, const struct cl_io *io);
2273 * Functions dealing with the preparation of a page for a transfer, and
2274 * tracking transfer state.
2277 int cl_page_prep (const struct lu_env *env, struct cl_io *io,
2278 struct cl_page *pg, enum cl_req_type crt);
2279 void cl_page_completion (const struct lu_env *env,
2280 struct cl_page *pg, enum cl_req_type crt, int ioret);
2281 int cl_page_make_ready (const struct lu_env *env, struct cl_page *pg,
2282 enum cl_req_type crt);
2283 int cl_page_cache_add (const struct lu_env *env, struct cl_io *io,
2284 struct cl_page *pg, enum cl_req_type crt);
2285 void cl_page_clip (const struct lu_env *env, struct cl_page *pg,
2287 int cl_page_cancel (const struct lu_env *env, struct cl_page *page);
2288 int cl_page_flush (const struct lu_env *env, struct cl_io *io,
2289 struct cl_page *pg);
2295 * \name helper routines
2296 * Functions to discard, delete and export a cl_page.
2299 void cl_page_discard(const struct lu_env *env, struct cl_io *io,
2300 struct cl_page *pg);
2301 void cl_page_delete(const struct lu_env *env, struct cl_page *pg);
2302 int cl_page_is_vmlocked(const struct lu_env *env,
2303 const struct cl_page *pg);
2304 void cl_page_export(const struct lu_env *env,
2305 struct cl_page *pg, int uptodate);
2306 loff_t cl_offset(const struct cl_object *obj, pgoff_t idx);
2307 pgoff_t cl_index(const struct cl_object *obj, loff_t offset);
2308 size_t cl_page_size(const struct cl_object *obj);
2310 void cl_lock_print(const struct lu_env *env, void *cookie,
2311 lu_printer_t printer, const struct cl_lock *lock);
2312 void cl_lock_descr_print(const struct lu_env *env, void *cookie,
2313 lu_printer_t printer,
2314 const struct cl_lock_descr *descr);
2318 * Data structure managing a client's cached pages. A count of
2319 * "unstable" pages is maintained, and an LRU of clean pages is
2320 * maintained. "unstable" pages are pages pinned by the ptlrpc
2321 * layer for recovery purposes.
2323 struct cl_client_cache {
2325 * # of client cache refcount
2326 * # of users (OSCs) + 2 (held by llite and lov)
2330 * # of threads are doing shrinking
2332 unsigned int ccc_lru_shrinkers;
2334 * # of LRU entries available
2336 atomic_long_t ccc_lru_left;
2338 * List of entities(OSCs) for this LRU cache
2340 struct list_head ccc_lru;
2342 * Max # of LRU entries
2344 unsigned long ccc_lru_max;
2346 * Lock to protect ccc_lru list
2348 spinlock_t ccc_lru_lock;
2350 * Set if unstable check is enabled
2352 unsigned int ccc_unstable_check:1;
2354 * # of unstable pages for this mount point
2356 atomic_long_t ccc_unstable_nr;
2358 * Waitq for awaiting unstable pages to reach zero.
2359 * Used at umounting time and signaled on BRW commit
2361 wait_queue_head_t ccc_unstable_waitq;
2364 * cl_cache functions
2366 struct cl_client_cache *cl_cache_init(unsigned long lru_page_max);
2367 void cl_cache_incref(struct cl_client_cache *cache);
2368 void cl_cache_decref(struct cl_client_cache *cache);
2372 /** \defgroup cl_lock cl_lock
2374 int cl_lock_request(const struct lu_env *env, struct cl_io *io,
2375 struct cl_lock *lock);
2376 int cl_lock_init(const struct lu_env *env, struct cl_lock *lock,
2377 const struct cl_io *io);
2378 void cl_lock_fini(const struct lu_env *env, struct cl_lock *lock);
2379 const struct cl_lock_slice *cl_lock_at(const struct cl_lock *lock,
2380 const struct lu_device_type *dtype);
2381 void cl_lock_release(const struct lu_env *env, struct cl_lock *lock);
2383 int cl_lock_enqueue(const struct lu_env *env, struct cl_io *io,
2384 struct cl_lock *lock, struct cl_sync_io *anchor);
2385 void cl_lock_cancel(const struct lu_env *env, struct cl_lock *lock);
2389 /** \defgroup cl_io cl_io
2392 int cl_io_init (const struct lu_env *env, struct cl_io *io,
2393 enum cl_io_type iot, struct cl_object *obj);
2394 int cl_io_sub_init (const struct lu_env *env, struct cl_io *io,
2395 enum cl_io_type iot, struct cl_object *obj);
2396 int cl_io_rw_init (const struct lu_env *env, struct cl_io *io,
2397 enum cl_io_type iot, loff_t pos, size_t count);
2398 int cl_io_loop (const struct lu_env *env, struct cl_io *io);
2400 void cl_io_fini (const struct lu_env *env, struct cl_io *io);
2401 int cl_io_iter_init (const struct lu_env *env, struct cl_io *io);
2402 void cl_io_iter_fini (const struct lu_env *env, struct cl_io *io);
2403 int cl_io_lock (const struct lu_env *env, struct cl_io *io);
2404 void cl_io_unlock (const struct lu_env *env, struct cl_io *io);
2405 int cl_io_start (const struct lu_env *env, struct cl_io *io);
2406 void cl_io_end (const struct lu_env *env, struct cl_io *io);
2407 int cl_io_lock_add (const struct lu_env *env, struct cl_io *io,
2408 struct cl_io_lock_link *link);
2409 int cl_io_lock_alloc_add(const struct lu_env *env, struct cl_io *io,
2410 struct cl_lock_descr *descr);
2411 int cl_io_submit_rw (const struct lu_env *env, struct cl_io *io,
2412 enum cl_req_type iot, struct cl_2queue *queue);
2413 int cl_io_submit_sync (const struct lu_env *env, struct cl_io *io,
2414 enum cl_req_type iot, struct cl_2queue *queue,
2416 int cl_io_commit_async (const struct lu_env *env, struct cl_io *io,
2417 struct cl_page_list *queue, int from, int to,
2419 int cl_io_read_ahead (const struct lu_env *env, struct cl_io *io,
2420 pgoff_t start, struct cl_read_ahead *ra);
2421 void cl_io_rw_advance (const struct lu_env *env, struct cl_io *io,
2423 int cl_io_cancel (const struct lu_env *env, struct cl_io *io,
2424 struct cl_page_list *queue);
2425 int cl_io_is_going (const struct lu_env *env);
2428 * True, iff \a io is an O_APPEND write(2).
2430 static inline int cl_io_is_append(const struct cl_io *io)
2432 return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_append;
2435 static inline int cl_io_is_sync_write(const struct cl_io *io)
2437 return io->ci_type == CIT_WRITE && io->u.ci_wr.wr_sync;
2440 static inline int cl_io_is_mkwrite(const struct cl_io *io)
2442 return io->ci_type == CIT_FAULT && io->u.ci_fault.ft_mkwrite;
2446 * True, iff \a io is a truncate(2).
2448 static inline int cl_io_is_trunc(const struct cl_io *io)
2450 return io->ci_type == CIT_SETATTR &&
2451 (io->u.ci_setattr.sa_valid & ATTR_SIZE);
2454 struct cl_io *cl_io_top(struct cl_io *io);
2456 void cl_io_print(const struct lu_env *env, void *cookie,
2457 lu_printer_t printer, const struct cl_io *io);
2459 #define CL_IO_SLICE_CLEAN(foo_io, base) \
2461 typeof(foo_io) __foo_io = (foo_io); \
2463 CLASSERT(offsetof(typeof(*__foo_io), base) == 0); \
2464 memset(&__foo_io->base + 1, 0, \
2465 (sizeof *__foo_io) - sizeof __foo_io->base); \
2470 /** \defgroup cl_page_list cl_page_list
2474 * Last page in the page list.
2476 static inline struct cl_page *cl_page_list_last(struct cl_page_list *plist)
2478 LASSERT(plist->pl_nr > 0);
2479 return list_entry(plist->pl_pages.prev, struct cl_page, cp_batch);
2482 static inline struct cl_page *cl_page_list_first(struct cl_page_list *plist)
2484 LASSERT(plist->pl_nr > 0);
2485 return list_entry(plist->pl_pages.next, struct cl_page, cp_batch);
2489 * Iterate over pages in a page list.
2491 #define cl_page_list_for_each(page, list) \
2492 list_for_each_entry((page), &(list)->pl_pages, cp_batch)
2495 * Iterate over pages in a page list, taking possible removals into account.
2497 #define cl_page_list_for_each_safe(page, temp, list) \
2498 list_for_each_entry_safe((page), (temp), &(list)->pl_pages, cp_batch)
2500 void cl_page_list_init (struct cl_page_list *plist);
2501 void cl_page_list_add (struct cl_page_list *plist, struct cl_page *page);
2502 void cl_page_list_move (struct cl_page_list *dst, struct cl_page_list *src,
2503 struct cl_page *page);
2504 void cl_page_list_move_head(struct cl_page_list *dst, struct cl_page_list *src,
2505 struct cl_page *page);
2506 void cl_page_list_splice (struct cl_page_list *list,
2507 struct cl_page_list *head);
2508 void cl_page_list_del (const struct lu_env *env,
2509 struct cl_page_list *plist, struct cl_page *page);
2510 void cl_page_list_disown (const struct lu_env *env,
2511 struct cl_io *io, struct cl_page_list *plist);
2512 int cl_page_list_own (const struct lu_env *env,
2513 struct cl_io *io, struct cl_page_list *plist);
2514 void cl_page_list_assume (const struct lu_env *env,
2515 struct cl_io *io, struct cl_page_list *plist);
2516 void cl_page_list_discard(const struct lu_env *env,
2517 struct cl_io *io, struct cl_page_list *plist);
2518 void cl_page_list_fini (const struct lu_env *env, struct cl_page_list *plist);
2520 void cl_2queue_init (struct cl_2queue *queue);
2521 void cl_2queue_add (struct cl_2queue *queue, struct cl_page *page);
2522 void cl_2queue_disown (const struct lu_env *env,
2523 struct cl_io *io, struct cl_2queue *queue);
2524 void cl_2queue_assume (const struct lu_env *env,
2525 struct cl_io *io, struct cl_2queue *queue);
2526 void cl_2queue_discard (const struct lu_env *env,
2527 struct cl_io *io, struct cl_2queue *queue);
2528 void cl_2queue_fini (const struct lu_env *env, struct cl_2queue *queue);
2529 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page);
2531 /** @} cl_page_list */
2533 /** \defgroup cl_req cl_req
2535 struct cl_req *cl_req_alloc(const struct lu_env *env, struct cl_page *page,
2536 enum cl_req_type crt, int nr_objects);
2538 void cl_req_page_add (const struct lu_env *env, struct cl_req *req,
2539 struct cl_page *page);
2540 void cl_req_page_done (const struct lu_env *env, struct cl_page *page);
2541 int cl_req_prep (const struct lu_env *env, struct cl_req *req);
2542 void cl_req_attr_set(const struct lu_env *env, struct cl_req *req,
2543 struct cl_req_attr *attr, u64 flags);
2544 void cl_req_completion(const struct lu_env *env, struct cl_req *req, int ioret);
2546 /** \defgroup cl_sync_io cl_sync_io
2550 * Anchor for synchronous transfer. This is allocated on a stack by thread
2551 * doing synchronous transfer, and a pointer to this structure is set up in
2552 * every page submitted for transfer. Transfer completion routine updates
2553 * anchor and wakes up waiting thread when transfer is complete.
2556 /** number of pages yet to be transferred. */
2557 atomic_t csi_sync_nr;
2560 /** barrier of destroy this structure */
2561 atomic_t csi_barrier;
2562 /** completion to be signaled when transfer is complete. */
2563 wait_queue_head_t csi_waitq;
2564 /** callback to invoke when this IO is finished */
2565 void (*csi_end_io)(const struct lu_env *,
2566 struct cl_sync_io *);
2569 void cl_sync_io_init(struct cl_sync_io *anchor, int nr,
2570 void (*end)(const struct lu_env *, struct cl_sync_io *));
2571 int cl_sync_io_wait(const struct lu_env *env, struct cl_sync_io *anchor,
2573 void cl_sync_io_note(const struct lu_env *env, struct cl_sync_io *anchor,
2575 void cl_sync_io_end(const struct lu_env *env, struct cl_sync_io *anchor);
2577 /** @} cl_sync_io */
2581 /** \defgroup cl_env cl_env
2583 * lu_env handling for a client.
2585 * lu_env is an environment within which lustre code executes. Its major part
2586 * is lu_context---a fast memory allocation mechanism that is used to conserve
2587 * precious kernel stack space. Originally lu_env was designed for a server,
2590 * - there is a (mostly) fixed number of threads, and
2592 * - call chains have no non-lustre portions inserted between lustre code.
2594 * On a client both these assumtpion fails, because every user thread can
2595 * potentially execute lustre code as part of a system call, and lustre calls
2596 * into VFS or MM that call back into lustre.
2598 * To deal with that, cl_env wrapper functions implement the following
2601 * - allocation and destruction of environment is amortized by caching no
2602 * longer used environments instead of destroying them;
2604 * - there is a notion of "current" environment, attached to the kernel
2605 * data structure representing current thread Top-level lustre code
2606 * allocates an environment and makes it current, then calls into
2607 * non-lustre code, that in turn calls lustre back. Low-level lustre
2608 * code thus called can fetch environment created by the top-level code
2609 * and reuse it, avoiding additional environment allocation.
2610 * Right now, three interfaces can attach the cl_env to running thread:
2613 * - cl_env_reexit(cl_env_reenter had to be called priorly)
2615 * \see lu_env, lu_context, lu_context_key
2618 struct cl_env_nest {
2623 struct lu_env *cl_env_peek (int *refcheck);
2624 struct lu_env *cl_env_get (int *refcheck);
2625 struct lu_env *cl_env_alloc (int *refcheck, __u32 tags);
2626 struct lu_env *cl_env_nested_get (struct cl_env_nest *nest);
2627 void cl_env_put (struct lu_env *env, int *refcheck);
2628 void cl_env_nested_put (struct cl_env_nest *nest, struct lu_env *env);
2629 void *cl_env_reenter (void);
2630 void cl_env_reexit (void *cookie);
2631 void cl_env_implant (struct lu_env *env, int *refcheck);
2632 void cl_env_unplant (struct lu_env *env, int *refcheck);
2633 unsigned cl_env_cache_purge(unsigned nr);
2634 struct lu_env *cl_env_percpu_get (void);
2635 void cl_env_percpu_put (struct lu_env *env);
2642 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr);
2643 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb);
2645 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
2646 struct lu_device_type *ldt,
2647 struct lu_device *next);
2650 int cl_global_init(void);
2651 void cl_global_fini(void);
2653 #endif /* _LINUX_CL_OBJECT_H */