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.
38 * Author: Nikita Danilov <nikita.danilov@sun.com>
41 #define DEBUG_SUBSYSTEM S_CLASS
43 #include <obd_class.h>
44 #include <obd_support.h>
45 #include <lustre_fid.h>
46 #include <libcfs/list.h>
47 /* lu_time_global_{init,fini}() */
50 #include <cl_object.h>
51 #include "cl_internal.h"
53 /*****************************************************************************
59 #define cl_io_for_each(slice, io) \
60 cfs_list_for_each_entry((slice), &io->ci_layers, cis_linkage)
61 #define cl_io_for_each_reverse(slice, io) \
62 cfs_list_for_each_entry_reverse((slice), &io->ci_layers, cis_linkage)
64 static inline int cl_io_type_is_valid(enum cl_io_type type)
66 return CIT_READ <= type && type < CIT_OP_NR;
69 static inline int cl_io_is_loopable(const struct cl_io *io)
71 return cl_io_type_is_valid(io->ci_type) && io->ci_type != CIT_MISC;
75 * Returns true iff there is an IO ongoing in the given environment.
77 int cl_io_is_going(const struct lu_env *env)
79 return cl_env_info(env)->clt_current_io != NULL;
81 EXPORT_SYMBOL(cl_io_is_going);
84 * cl_io invariant that holds at all times when exported cl_io_*() functions
85 * are entered and left.
87 static int cl_io_invariant(const struct cl_io *io)
94 * io can own pages only when it is ongoing. Sub-io might
95 * still be in CIS_LOCKED state when top-io is in
98 ergo(io->ci_owned_nr > 0, io->ci_state == CIS_IO_GOING ||
99 (io->ci_state == CIS_LOCKED && up != NULL));
103 * Finalize \a io, by calling cl_io_operations::cio_fini() bottom-to-top.
105 void cl_io_fini(const struct lu_env *env, struct cl_io *io)
107 struct cl_io_slice *slice;
108 struct cl_thread_info *info;
110 LINVRNT(cl_io_type_is_valid(io->ci_type));
111 LINVRNT(cl_io_invariant(io));
114 while (!cfs_list_empty(&io->ci_layers)) {
115 slice = container_of(io->ci_layers.next, struct cl_io_slice,
117 cfs_list_del_init(&slice->cis_linkage);
118 if (slice->cis_iop->op[io->ci_type].cio_fini != NULL)
119 slice->cis_iop->op[io->ci_type].cio_fini(env, slice);
121 * Invalidate slice to catch use after free. This assumes that
122 * slices are allocated within session and can be touched
123 * after ->cio_fini() returns.
125 slice->cis_io = NULL;
127 io->ci_state = CIS_FINI;
128 info = cl_env_info(env);
129 if (info->clt_current_io == io)
130 info->clt_current_io = NULL;
133 EXPORT_SYMBOL(cl_io_fini);
135 static int cl_io_init0(const struct lu_env *env, struct cl_io *io,
136 enum cl_io_type iot, struct cl_object *obj)
138 struct cl_object *scan;
141 LINVRNT(io->ci_state == CIS_ZERO || io->ci_state == CIS_FINI);
142 LINVRNT(cl_io_type_is_valid(iot));
143 LINVRNT(cl_io_invariant(io));
147 CFS_INIT_LIST_HEAD(&io->ci_lockset.cls_todo);
148 CFS_INIT_LIST_HEAD(&io->ci_lockset.cls_curr);
149 CFS_INIT_LIST_HEAD(&io->ci_lockset.cls_done);
150 CFS_INIT_LIST_HEAD(&io->ci_layers);
153 cl_object_for_each(scan, obj) {
154 if (scan->co_ops->coo_io_init != NULL) {
155 result = scan->co_ops->coo_io_init(env, scan, io);
161 io->ci_state = CIS_INIT;
166 * Initialize sub-io, by calling cl_io_operations::cio_init() top-to-bottom.
168 * \pre obj != cl_object_top(obj)
170 int cl_io_sub_init(const struct lu_env *env, struct cl_io *io,
171 enum cl_io_type iot, struct cl_object *obj)
173 struct cl_thread_info *info = cl_env_info(env);
175 LASSERT(obj != cl_object_top(obj));
176 if (info->clt_current_io == NULL)
177 info->clt_current_io = io;
178 return cl_io_init0(env, io, iot, obj);
180 EXPORT_SYMBOL(cl_io_sub_init);
183 * Initialize \a io, by calling cl_io_operations::cio_init() top-to-bottom.
185 * Caller has to call cl_io_fini() after a call to cl_io_init(), no matter
186 * what the latter returned.
188 * \pre obj == cl_object_top(obj)
189 * \pre cl_io_type_is_valid(iot)
190 * \post cl_io_type_is_valid(io->ci_type) && io->ci_type == iot
192 int cl_io_init(const struct lu_env *env, struct cl_io *io,
193 enum cl_io_type iot, struct cl_object *obj)
195 struct cl_thread_info *info = cl_env_info(env);
197 LASSERT(obj == cl_object_top(obj));
198 LASSERT(info->clt_current_io == NULL);
200 info->clt_current_io = io;
201 return cl_io_init0(env, io, iot, obj);
203 EXPORT_SYMBOL(cl_io_init);
206 * Initialize read or write io.
208 * \pre iot == CIT_READ || iot == CIT_WRITE
210 int cl_io_rw_init(const struct lu_env *env, struct cl_io *io,
211 enum cl_io_type iot, loff_t pos, size_t count)
213 LINVRNT(iot == CIT_READ || iot == CIT_WRITE);
214 LINVRNT(io->ci_obj != NULL);
217 LU_OBJECT_HEADER(D_VFSTRACE, env, &io->ci_obj->co_lu,
218 "io range: %u ["LPU64", "LPU64") %u %u\n",
219 iot, (__u64)pos, (__u64)pos + count,
220 io->u.ci_rw.crw_nonblock, io->u.ci_wr.wr_append);
221 io->u.ci_rw.crw_pos = pos;
222 io->u.ci_rw.crw_count = count;
223 RETURN(cl_io_init(env, io, iot, io->ci_obj));
225 EXPORT_SYMBOL(cl_io_rw_init);
227 static inline const struct lu_fid *
228 cl_lock_descr_fid(const struct cl_lock_descr *descr)
230 return lu_object_fid(&descr->cld_obj->co_lu);
233 static int cl_lock_descr_sort(const struct cl_lock_descr *d0,
234 const struct cl_lock_descr *d1)
236 return lu_fid_cmp(cl_lock_descr_fid(d0), cl_lock_descr_fid(d1)) ?:
237 __diff_normalize(d0->cld_start, d1->cld_start);
240 static int cl_lock_descr_cmp(const struct cl_lock_descr *d0,
241 const struct cl_lock_descr *d1)
245 ret = lu_fid_cmp(cl_lock_descr_fid(d0), cl_lock_descr_fid(d1));
248 if (d0->cld_end < d1->cld_start)
250 if (d0->cld_start > d0->cld_end)
255 static void cl_lock_descr_merge(struct cl_lock_descr *d0,
256 const struct cl_lock_descr *d1)
258 d0->cld_start = min(d0->cld_start, d1->cld_start);
259 d0->cld_end = max(d0->cld_end, d1->cld_end);
261 if (d1->cld_mode == CLM_WRITE && d0->cld_mode != CLM_WRITE)
262 d0->cld_mode = CLM_WRITE;
264 if (d1->cld_mode == CLM_GROUP && d0->cld_mode != CLM_GROUP)
265 d0->cld_mode = CLM_GROUP;
269 * Sort locks in lexicographical order of their (fid, start-offset) pairs.
271 static void cl_io_locks_sort(struct cl_io *io)
276 /* hidden treasure: bubble sort for now. */
278 struct cl_io_lock_link *curr;
279 struct cl_io_lock_link *prev;
280 struct cl_io_lock_link *temp;
285 cfs_list_for_each_entry_safe(curr, temp,
286 &io->ci_lockset.cls_todo,
289 switch (cl_lock_descr_sort(&prev->cill_descr,
290 &curr->cill_descr)) {
293 * IMPOSSIBLE: Identical locks are
300 cfs_list_move_tail(&curr->cill_linkage,
301 &prev->cill_linkage);
303 continue; /* don't change prev: it's
304 * still "previous" */
305 case -1: /* already in order */
316 * Check whether \a queue contains locks matching \a need.
318 * \retval +ve there is a matching lock in the \a queue
319 * \retval 0 there are no matching locks in the \a queue
321 int cl_queue_match(const cfs_list_t *queue,
322 const struct cl_lock_descr *need)
324 struct cl_io_lock_link *scan;
327 cfs_list_for_each_entry(scan, queue, cill_linkage) {
328 if (cl_lock_descr_match(&scan->cill_descr, need))
333 EXPORT_SYMBOL(cl_queue_match);
335 static int cl_queue_merge(const cfs_list_t *queue,
336 const struct cl_lock_descr *need)
338 struct cl_io_lock_link *scan;
341 cfs_list_for_each_entry(scan, queue, cill_linkage) {
342 if (cl_lock_descr_cmp(&scan->cill_descr, need))
344 cl_lock_descr_merge(&scan->cill_descr, need);
345 CDEBUG(D_VFSTRACE, "lock: %d: [%lu, %lu]\n",
346 scan->cill_descr.cld_mode, scan->cill_descr.cld_start,
347 scan->cill_descr.cld_end);
354 static int cl_lockset_match(const struct cl_lockset *set,
355 const struct cl_lock_descr *need)
357 return cl_queue_match(&set->cls_curr, need) ||
358 cl_queue_match(&set->cls_done, need);
361 static int cl_lockset_merge(const struct cl_lockset *set,
362 const struct cl_lock_descr *need)
364 return cl_queue_merge(&set->cls_todo, need) ||
365 cl_lockset_match(set, need);
368 static int cl_lockset_lock_one(const struct lu_env *env,
369 struct cl_io *io, struct cl_lockset *set,
370 struct cl_io_lock_link *link)
372 struct cl_lock *lock;
377 if (io->ci_lockreq == CILR_PEEK) {
378 lock = cl_lock_peek(env, io, &link->cill_descr, "io", io);
380 lock = ERR_PTR(-ENODATA);
382 lock = cl_lock_request(env, io, &link->cill_descr, "io", io);
385 link->cill_lock = lock;
386 cfs_list_move(&link->cill_linkage, &set->cls_curr);
387 if (!(link->cill_descr.cld_enq_flags & CEF_ASYNC)) {
388 result = cl_wait(env, lock);
390 cfs_list_move(&link->cill_linkage,
395 result = PTR_ERR(lock);
399 static void cl_lock_link_fini(const struct lu_env *env, struct cl_io *io,
400 struct cl_io_lock_link *link)
402 struct cl_lock *lock = link->cill_lock;
405 cfs_list_del_init(&link->cill_linkage);
407 cl_lock_release(env, lock, "io", io);
408 link->cill_lock = NULL;
410 if (link->cill_fini != NULL)
411 link->cill_fini(env, link);
415 static int cl_lockset_lock(const struct lu_env *env, struct cl_io *io,
416 struct cl_lockset *set)
418 struct cl_io_lock_link *link;
419 struct cl_io_lock_link *temp;
420 struct cl_lock *lock;
425 cfs_list_for_each_entry_safe(link, temp, &set->cls_todo, cill_linkage) {
426 if (!cl_lockset_match(set, &link->cill_descr)) {
427 /* XXX some locking to guarantee that locks aren't
428 * expanded in between. */
429 result = cl_lockset_lock_one(env, io, set, link);
433 cl_lock_link_fini(env, io, link);
436 cfs_list_for_each_entry_safe(link, temp,
437 &set->cls_curr, cill_linkage) {
438 lock = link->cill_lock;
439 result = cl_wait(env, lock);
441 cfs_list_move(&link->cill_linkage,
451 * Takes locks necessary for the current iteration of io.
453 * Calls cl_io_operations::cio_lock() top-to-bottom to collect locks required
454 * by layers for the current iteration. Then sort locks (to avoid dead-locks),
457 int cl_io_lock(const struct lu_env *env, struct cl_io *io)
459 const struct cl_io_slice *scan;
462 LINVRNT(cl_io_is_loopable(io));
463 LINVRNT(io->ci_state == CIS_IT_STARTED);
464 LINVRNT(cl_io_invariant(io));
467 cl_io_for_each(scan, io) {
468 if (scan->cis_iop->op[io->ci_type].cio_lock == NULL)
470 result = scan->cis_iop->op[io->ci_type].cio_lock(env, scan);
475 cl_io_locks_sort(io);
476 result = cl_lockset_lock(env, io, &io->ci_lockset);
479 cl_io_unlock(env, io);
481 io->ci_state = CIS_LOCKED;
484 EXPORT_SYMBOL(cl_io_lock);
487 * Release locks takes by io.
489 void cl_io_unlock(const struct lu_env *env, struct cl_io *io)
491 struct cl_lockset *set;
492 struct cl_io_lock_link *link;
493 struct cl_io_lock_link *temp;
494 const struct cl_io_slice *scan;
496 LASSERT(cl_io_is_loopable(io));
497 LASSERT(CIS_IT_STARTED <= io->ci_state && io->ci_state < CIS_UNLOCKED);
498 LINVRNT(cl_io_invariant(io));
501 set = &io->ci_lockset;
503 cfs_list_for_each_entry_safe(link, temp, &set->cls_todo, cill_linkage)
504 cl_lock_link_fini(env, io, link);
506 cfs_list_for_each_entry_safe(link, temp, &set->cls_curr, cill_linkage)
507 cl_lock_link_fini(env, io, link);
509 cfs_list_for_each_entry_safe(link, temp, &set->cls_done, cill_linkage) {
510 cl_unuse(env, link->cill_lock);
511 cl_lock_link_fini(env, io, link);
513 cl_io_for_each_reverse(scan, io) {
514 if (scan->cis_iop->op[io->ci_type].cio_unlock != NULL)
515 scan->cis_iop->op[io->ci_type].cio_unlock(env, scan);
517 io->ci_state = CIS_UNLOCKED;
518 LASSERT(!cl_env_info(env)->clt_counters[CNL_TOP].ctc_nr_locks_acquired);
521 EXPORT_SYMBOL(cl_io_unlock);
524 * Prepares next iteration of io.
526 * Calls cl_io_operations::cio_iter_init() top-to-bottom. This exists to give
527 * layers a chance to modify io parameters, e.g., so that lov can restrict io
528 * to a single stripe.
530 int cl_io_iter_init(const struct lu_env *env, struct cl_io *io)
532 const struct cl_io_slice *scan;
535 LINVRNT(cl_io_is_loopable(io));
536 LINVRNT(io->ci_state == CIS_INIT || io->ci_state == CIS_IT_ENDED);
537 LINVRNT(cl_io_invariant(io));
541 cl_io_for_each(scan, io) {
542 if (scan->cis_iop->op[io->ci_type].cio_iter_init == NULL)
544 result = scan->cis_iop->op[io->ci_type].cio_iter_init(env,
550 io->ci_state = CIS_IT_STARTED;
553 EXPORT_SYMBOL(cl_io_iter_init);
556 * Finalizes io iteration.
558 * Calls cl_io_operations::cio_iter_fini() bottom-to-top.
560 void cl_io_iter_fini(const struct lu_env *env, struct cl_io *io)
562 const struct cl_io_slice *scan;
564 LINVRNT(cl_io_is_loopable(io));
565 LINVRNT(io->ci_state == CIS_UNLOCKED);
566 LINVRNT(cl_io_invariant(io));
569 cl_io_for_each_reverse(scan, io) {
570 if (scan->cis_iop->op[io->ci_type].cio_iter_fini != NULL)
571 scan->cis_iop->op[io->ci_type].cio_iter_fini(env, scan);
573 io->ci_state = CIS_IT_ENDED;
576 EXPORT_SYMBOL(cl_io_iter_fini);
579 * Records that read or write io progressed \a nob bytes forward.
581 void cl_io_rw_advance(const struct lu_env *env, struct cl_io *io, size_t nob)
583 const struct cl_io_slice *scan;
585 LINVRNT(io->ci_type == CIT_READ || io->ci_type == CIT_WRITE ||
587 LINVRNT(cl_io_is_loopable(io));
588 LINVRNT(cl_io_invariant(io));
592 io->u.ci_rw.crw_pos += nob;
593 io->u.ci_rw.crw_count -= nob;
595 /* layers have to be notified. */
596 cl_io_for_each_reverse(scan, io) {
597 if (scan->cis_iop->op[io->ci_type].cio_advance != NULL)
598 scan->cis_iop->op[io->ci_type].cio_advance(env, scan,
603 EXPORT_SYMBOL(cl_io_rw_advance);
606 * Adds a lock to a lockset.
608 int cl_io_lock_add(const struct lu_env *env, struct cl_io *io,
609 struct cl_io_lock_link *link)
614 if (cl_lockset_merge(&io->ci_lockset, &link->cill_descr))
617 cfs_list_add(&link->cill_linkage, &io->ci_lockset.cls_todo);
622 EXPORT_SYMBOL(cl_io_lock_add);
624 static void cl_free_io_lock_link(const struct lu_env *env,
625 struct cl_io_lock_link *link)
631 * Allocates new lock link, and uses it to add a lock to a lockset.
633 int cl_io_lock_alloc_add(const struct lu_env *env, struct cl_io *io,
634 struct cl_lock_descr *descr)
636 struct cl_io_lock_link *link;
642 link->cill_descr = *descr;
643 link->cill_fini = cl_free_io_lock_link;
644 result = cl_io_lock_add(env, io, link);
645 if (result) /* lock match */
646 link->cill_fini(env, link);
652 EXPORT_SYMBOL(cl_io_lock_alloc_add);
655 * Starts io by calling cl_io_operations::cio_start() top-to-bottom.
657 int cl_io_start(const struct lu_env *env, struct cl_io *io)
659 const struct cl_io_slice *scan;
662 LINVRNT(cl_io_is_loopable(io));
663 LINVRNT(io->ci_state == CIS_LOCKED);
664 LINVRNT(cl_io_invariant(io));
667 io->ci_state = CIS_IO_GOING;
668 cl_io_for_each(scan, io) {
669 if (scan->cis_iop->op[io->ci_type].cio_start == NULL)
671 result = scan->cis_iop->op[io->ci_type].cio_start(env, scan);
679 EXPORT_SYMBOL(cl_io_start);
682 * Wait until current io iteration is finished by calling
683 * cl_io_operations::cio_end() bottom-to-top.
685 void cl_io_end(const struct lu_env *env, struct cl_io *io)
687 const struct cl_io_slice *scan;
689 LINVRNT(cl_io_is_loopable(io));
690 LINVRNT(io->ci_state == CIS_IO_GOING);
691 LINVRNT(cl_io_invariant(io));
694 cl_io_for_each_reverse(scan, io) {
695 if (scan->cis_iop->op[io->ci_type].cio_end != NULL)
696 scan->cis_iop->op[io->ci_type].cio_end(env, scan);
697 /* TODO: error handling. */
699 io->ci_state = CIS_IO_FINISHED;
702 EXPORT_SYMBOL(cl_io_end);
704 static const struct cl_page_slice *
705 cl_io_slice_page(const struct cl_io_slice *ios, struct cl_page *page)
707 const struct cl_page_slice *slice;
709 slice = cl_page_at(page, ios->cis_obj->co_lu.lo_dev->ld_type);
710 LINVRNT(slice != NULL);
715 * True iff \a page is within \a io range.
717 static int cl_page_in_io(const struct cl_page *page, const struct cl_io *io)
724 idx = page->cp_index;
725 switch (io->ci_type) {
729 * check that [start, end) and [pos, pos + count) extents
732 if (!cl_io_is_append(io)) {
733 const struct cl_io_rw_common *crw = &(io->u.ci_rw);
734 start = cl_offset(page->cp_obj, idx);
735 end = cl_offset(page->cp_obj, idx + 1);
736 result = crw->crw_pos < end &&
737 start < crw->crw_pos + crw->crw_count;
741 result = io->u.ci_fault.ft_index == idx;
750 * Called by read io, when page has to be read from the server.
752 * \see cl_io_operations::cio_read_page()
754 int cl_io_read_page(const struct lu_env *env, struct cl_io *io,
755 struct cl_page *page)
757 const struct cl_io_slice *scan;
758 struct cl_2queue *queue;
761 LINVRNT(io->ci_type == CIT_READ || io->ci_type == CIT_FAULT);
762 LINVRNT(cl_page_is_owned(page, io));
763 LINVRNT(io->ci_state == CIS_IO_GOING || io->ci_state == CIS_LOCKED);
764 LINVRNT(cl_page_in_io(page, io));
765 LINVRNT(cl_io_invariant(io));
768 queue = &io->ci_queue;
770 cl_2queue_init(queue);
772 * ->cio_read_page() methods called in the loop below are supposed to
773 * never block waiting for network (the only subtle point is the
774 * creation of new pages for read-ahead that might result in cache
775 * shrinking, but currently only clean pages are shrunk and this
776 * requires no network io).
778 * Should this ever starts blocking, retry loop would be needed for
779 * "parallel io" (see CLO_REPEAT loops in cl_lock.c).
781 cl_io_for_each(scan, io) {
782 if (scan->cis_iop->cio_read_page != NULL) {
783 const struct cl_page_slice *slice;
785 slice = cl_io_slice_page(scan, page);
786 LINVRNT(slice != NULL);
787 result = scan->cis_iop->cio_read_page(env, scan, slice);
793 result = cl_io_submit_rw(env, io, CRT_READ, queue);
795 * Unlock unsent pages in case of error.
797 cl_page_list_disown(env, io, &queue->c2_qin);
798 cl_2queue_fini(env, queue);
801 EXPORT_SYMBOL(cl_io_read_page);
804 * Called by write io to prepare page to receive data from user buffer.
806 * \see cl_io_operations::cio_prepare_write()
808 int cl_io_prepare_write(const struct lu_env *env, struct cl_io *io,
809 struct cl_page *page, unsigned from, unsigned to)
811 const struct cl_io_slice *scan;
814 LINVRNT(io->ci_type == CIT_WRITE);
815 LINVRNT(cl_page_is_owned(page, io));
816 LINVRNT(io->ci_state == CIS_IO_GOING || io->ci_state == CIS_LOCKED);
817 LINVRNT(cl_io_invariant(io));
818 LASSERT(cl_page_in_io(page, io));
821 cl_io_for_each_reverse(scan, io) {
822 if (scan->cis_iop->cio_prepare_write != NULL) {
823 const struct cl_page_slice *slice;
825 slice = cl_io_slice_page(scan, page);
826 result = scan->cis_iop->cio_prepare_write(env, scan,
835 EXPORT_SYMBOL(cl_io_prepare_write);
838 * Called by write io after user data were copied into a page.
840 * \see cl_io_operations::cio_commit_write()
842 int cl_io_commit_write(const struct lu_env *env, struct cl_io *io,
843 struct cl_page *page, unsigned from, unsigned to)
845 const struct cl_io_slice *scan;
848 LINVRNT(io->ci_type == CIT_WRITE);
849 LINVRNT(io->ci_state == CIS_IO_GOING || io->ci_state == CIS_LOCKED);
850 LINVRNT(cl_io_invariant(io));
852 * XXX Uh... not nice. Top level cl_io_commit_write() call (vvp->lov)
853 * already called cl_page_cache_add(), moving page into CPS_CACHED
854 * state. Better (and more general) way of dealing with such situation
857 LASSERT(cl_page_is_owned(page, io) || page->cp_parent != NULL);
858 LASSERT(cl_page_in_io(page, io));
861 cl_io_for_each(scan, io) {
862 if (scan->cis_iop->cio_commit_write != NULL) {
863 const struct cl_page_slice *slice;
865 slice = cl_io_slice_page(scan, page);
866 result = scan->cis_iop->cio_commit_write(env, scan,
873 LINVRNT(result <= 0);
876 EXPORT_SYMBOL(cl_io_commit_write);
879 * Submits a list of pages for immediate io.
881 * After the function gets returned, The submitted pages are moved to
882 * queue->c2_qout queue, and queue->c2_qin contain both the pages don't need
883 * to be submitted, and the pages are errant to submit.
885 * \returns 0 if at least one page was submitted, error code otherwise.
886 * \see cl_io_operations::cio_submit()
888 int cl_io_submit_rw(const struct lu_env *env, struct cl_io *io,
889 enum cl_req_type crt, struct cl_2queue *queue)
891 const struct cl_io_slice *scan;
894 LINVRNT(crt < ARRAY_SIZE(scan->cis_iop->req_op));
897 cl_io_for_each(scan, io) {
898 if (scan->cis_iop->req_op[crt].cio_submit == NULL)
900 result = scan->cis_iop->req_op[crt].cio_submit(env, scan, crt,
906 * If ->cio_submit() failed, no pages were sent.
908 LASSERT(ergo(result != 0, cfs_list_empty(&queue->c2_qout.pl_pages)));
911 EXPORT_SYMBOL(cl_io_submit_rw);
914 * Submit a sync_io and wait for the IO to be finished, or error happens.
915 * If \a timeout is zero, it means to wait for the IO unconditionally.
917 int cl_io_submit_sync(const struct lu_env *env, struct cl_io *io,
918 enum cl_req_type iot, struct cl_2queue *queue,
921 struct cl_sync_io *anchor = &cl_env_info(env)->clt_anchor;
925 cl_page_list_for_each(pg, &queue->c2_qin) {
926 LASSERT(pg->cp_sync_io == NULL);
927 pg->cp_sync_io = anchor;
930 cl_sync_io_init(anchor, queue->c2_qin.pl_nr);
931 rc = cl_io_submit_rw(env, io, iot, queue);
934 * If some pages weren't sent for any reason (e.g.,
935 * read found up-to-date pages in the cache, or write found
936 * clean pages), count them as completed to avoid infinite
939 cl_page_list_for_each(pg, &queue->c2_qin) {
940 pg->cp_sync_io = NULL;
941 cl_sync_io_note(anchor, +1);
944 /* wait for the IO to be finished. */
945 rc = cl_sync_io_wait(env, io, &queue->c2_qout,
948 LASSERT(cfs_list_empty(&queue->c2_qout.pl_pages));
949 cl_page_list_for_each(pg, &queue->c2_qin)
950 pg->cp_sync_io = NULL;
954 EXPORT_SYMBOL(cl_io_submit_sync);
957 * Cancel an IO which has been submitted by cl_io_submit_rw.
959 int cl_io_cancel(const struct lu_env *env, struct cl_io *io,
960 struct cl_page_list *queue)
962 struct cl_page *page;
965 CERROR("Canceling ongoing page trasmission\n");
966 cl_page_list_for_each(page, queue) {
969 LINVRNT(cl_page_in_io(page, io));
970 rc = cl_page_cancel(env, page);
971 result = result ?: rc;
975 EXPORT_SYMBOL(cl_io_cancel);
980 * Pumps io through iterations calling
982 * - cl_io_iter_init()
992 * - cl_io_iter_fini()
994 * repeatedly until there is no more io to do.
996 int cl_io_loop(const struct lu_env *env, struct cl_io *io)
1000 LINVRNT(cl_io_is_loopable(io));
1006 io->ci_continue = 0;
1007 result = cl_io_iter_init(env, io);
1010 result = cl_io_lock(env, io);
1013 * Notify layers that locks has been taken,
1014 * and do actual i/o.
1016 * - llite: kms, short read;
1017 * - llite: generic_file_read();
1019 result = cl_io_start(env, io);
1021 * Send any remaining pending
1024 * - llite: ll_rw_stats_tally.
1027 cl_io_unlock(env, io);
1028 cl_io_rw_advance(env, io, io->ci_nob - nob);
1031 cl_io_iter_fini(env, io);
1032 } while (result == 0 && io->ci_continue);
1034 result = io->ci_result;
1035 RETURN(result < 0 ? result : 0);
1037 EXPORT_SYMBOL(cl_io_loop);
1040 * Adds io slice to the cl_io.
1042 * This is called by cl_object_operations::coo_io_init() methods to add a
1043 * per-layer state to the io. New state is added at the end of
1044 * cl_io::ci_layers list, that is, it is at the bottom of the stack.
1046 * \see cl_lock_slice_add(), cl_req_slice_add(), cl_page_slice_add()
1048 void cl_io_slice_add(struct cl_io *io, struct cl_io_slice *slice,
1049 struct cl_object *obj,
1050 const struct cl_io_operations *ops)
1052 cfs_list_t *linkage = &slice->cis_linkage;
1054 LASSERT((linkage->prev == NULL && linkage->next == NULL) ||
1055 cfs_list_empty(linkage));
1058 cfs_list_add_tail(linkage, &io->ci_layers);
1060 slice->cis_obj = obj;
1061 slice->cis_iop = ops;
1064 EXPORT_SYMBOL(cl_io_slice_add);
1068 * Initializes page list.
1070 void cl_page_list_init(struct cl_page_list *plist)
1074 CFS_INIT_LIST_HEAD(&plist->pl_pages);
1075 plist->pl_owner = cfs_current();
1078 EXPORT_SYMBOL(cl_page_list_init);
1081 * Adds a page to a page list.
1083 void cl_page_list_add(struct cl_page_list *plist, struct cl_page *page)
1086 /* it would be better to check that page is owned by "current" io, but
1087 * it is not passed here. */
1088 LASSERT(page->cp_owner != NULL);
1089 LINVRNT(plist->pl_owner == cfs_current());
1092 cfs_mutex_lock(&page->cp_mutex);
1094 LASSERT(cfs_list_empty(&page->cp_batch));
1095 cfs_list_add_tail(&page->cp_batch, &plist->pl_pages);
1097 page->cp_queue_ref = lu_ref_add(&page->cp_reference, "queue", plist);
1101 EXPORT_SYMBOL(cl_page_list_add);
1104 * Removes a page from a page list.
1106 void cl_page_list_del(const struct lu_env *env,
1107 struct cl_page_list *plist, struct cl_page *page)
1109 LASSERT(plist->pl_nr > 0);
1110 LINVRNT(plist->pl_owner == cfs_current());
1113 cfs_list_del_init(&page->cp_batch);
1115 cfs_mutex_unlock(&page->cp_mutex);
1118 lu_ref_del_at(&page->cp_reference, page->cp_queue_ref, "queue", plist);
1119 cl_page_put(env, page);
1122 EXPORT_SYMBOL(cl_page_list_del);
1125 * Moves a page from one page list to another.
1127 void cl_page_list_move(struct cl_page_list *dst, struct cl_page_list *src,
1128 struct cl_page *page)
1130 LASSERT(src->pl_nr > 0);
1131 LINVRNT(dst->pl_owner == cfs_current());
1132 LINVRNT(src->pl_owner == cfs_current());
1135 cfs_list_move_tail(&page->cp_batch, &dst->pl_pages);
1138 lu_ref_set_at(&page->cp_reference,
1139 page->cp_queue_ref, "queue", src, dst);
1142 EXPORT_SYMBOL(cl_page_list_move);
1145 * splice the cl_page_list, just as list head does
1147 void cl_page_list_splice(struct cl_page_list *list, struct cl_page_list *head)
1149 struct cl_page *page;
1150 struct cl_page *tmp;
1152 LINVRNT(list->pl_owner == cfs_current());
1153 LINVRNT(head->pl_owner == cfs_current());
1156 cl_page_list_for_each_safe(page, tmp, list)
1157 cl_page_list_move(head, list, page);
1160 EXPORT_SYMBOL(cl_page_list_splice);
1162 void cl_page_disown0(const struct lu_env *env,
1163 struct cl_io *io, struct cl_page *pg);
1166 * Disowns pages in a queue.
1168 void cl_page_list_disown(const struct lu_env *env,
1169 struct cl_io *io, struct cl_page_list *plist)
1171 struct cl_page *page;
1172 struct cl_page *temp;
1174 LINVRNT(plist->pl_owner == cfs_current());
1177 cl_page_list_for_each_safe(page, temp, plist) {
1178 LASSERT(plist->pl_nr > 0);
1180 cfs_list_del_init(&page->cp_batch);
1182 cfs_mutex_unlock(&page->cp_mutex);
1186 * cl_page_disown0 rather than usual cl_page_disown() is used,
1187 * because pages are possibly in CPS_FREEING state already due
1188 * to the call to cl_page_list_discard().
1191 * XXX cl_page_disown0() will fail if page is not locked.
1193 cl_page_disown0(env, io, page);
1194 lu_ref_del(&page->cp_reference, "queue", plist);
1195 cl_page_put(env, page);
1199 EXPORT_SYMBOL(cl_page_list_disown);
1202 * Releases pages from queue.
1204 void cl_page_list_fini(const struct lu_env *env, struct cl_page_list *plist)
1206 struct cl_page *page;
1207 struct cl_page *temp;
1209 LINVRNT(plist->pl_owner == cfs_current());
1212 cl_page_list_for_each_safe(page, temp, plist)
1213 cl_page_list_del(env, plist, page);
1214 LASSERT(plist->pl_nr == 0);
1217 EXPORT_SYMBOL(cl_page_list_fini);
1220 * Owns all pages in a queue.
1222 int cl_page_list_own(const struct lu_env *env,
1223 struct cl_io *io, struct cl_page_list *plist)
1225 struct cl_page *page;
1226 struct cl_page *temp;
1230 LINVRNT(plist->pl_owner == cfs_current());
1234 cl_page_list_for_each_safe(page, temp, plist) {
1235 LASSERT(index <= page->cp_index);
1236 index = page->cp_index;
1237 if (cl_page_own(env, io, page) == 0)
1238 result = result ?: page->cp_error;
1240 cl_page_list_del(env, plist, page);
1244 EXPORT_SYMBOL(cl_page_list_own);
1247 * Assumes all pages in a queue.
1249 void cl_page_list_assume(const struct lu_env *env,
1250 struct cl_io *io, struct cl_page_list *plist)
1252 struct cl_page *page;
1254 LINVRNT(plist->pl_owner == cfs_current());
1256 cl_page_list_for_each(page, plist)
1257 cl_page_assume(env, io, page);
1259 EXPORT_SYMBOL(cl_page_list_assume);
1262 * Discards all pages in a queue.
1264 void cl_page_list_discard(const struct lu_env *env, struct cl_io *io,
1265 struct cl_page_list *plist)
1267 struct cl_page *page;
1269 LINVRNT(plist->pl_owner == cfs_current());
1271 cl_page_list_for_each(page, plist)
1272 cl_page_discard(env, io, page);
1275 EXPORT_SYMBOL(cl_page_list_discard);
1278 * Unmaps all pages in a queue from user virtual memory.
1280 int cl_page_list_unmap(const struct lu_env *env, struct cl_io *io,
1281 struct cl_page_list *plist)
1283 struct cl_page *page;
1286 LINVRNT(plist->pl_owner == cfs_current());
1289 cl_page_list_for_each(page, plist) {
1290 result = cl_page_unmap(env, io, page);
1296 EXPORT_SYMBOL(cl_page_list_unmap);
1299 * Initialize dual page queue.
1301 void cl_2queue_init(struct cl_2queue *queue)
1304 cl_page_list_init(&queue->c2_qin);
1305 cl_page_list_init(&queue->c2_qout);
1308 EXPORT_SYMBOL(cl_2queue_init);
1311 * Add a page to the incoming page list of 2-queue.
1313 void cl_2queue_add(struct cl_2queue *queue, struct cl_page *page)
1316 cl_page_list_add(&queue->c2_qin, page);
1319 EXPORT_SYMBOL(cl_2queue_add);
1322 * Disown pages in both lists of a 2-queue.
1324 void cl_2queue_disown(const struct lu_env *env,
1325 struct cl_io *io, struct cl_2queue *queue)
1328 cl_page_list_disown(env, io, &queue->c2_qin);
1329 cl_page_list_disown(env, io, &queue->c2_qout);
1332 EXPORT_SYMBOL(cl_2queue_disown);
1335 * Discard (truncate) pages in both lists of a 2-queue.
1337 void cl_2queue_discard(const struct lu_env *env,
1338 struct cl_io *io, struct cl_2queue *queue)
1341 cl_page_list_discard(env, io, &queue->c2_qin);
1342 cl_page_list_discard(env, io, &queue->c2_qout);
1345 EXPORT_SYMBOL(cl_2queue_discard);
1348 * Assume to own the pages in cl_2queue
1350 void cl_2queue_assume(const struct lu_env *env,
1351 struct cl_io *io, struct cl_2queue *queue)
1353 cl_page_list_assume(env, io, &queue->c2_qin);
1354 cl_page_list_assume(env, io, &queue->c2_qout);
1356 EXPORT_SYMBOL(cl_2queue_assume);
1359 * Finalize both page lists of a 2-queue.
1361 void cl_2queue_fini(const struct lu_env *env, struct cl_2queue *queue)
1364 cl_page_list_fini(env, &queue->c2_qout);
1365 cl_page_list_fini(env, &queue->c2_qin);
1368 EXPORT_SYMBOL(cl_2queue_fini);
1371 * Initialize a 2-queue to contain \a page in its incoming page list.
1373 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page)
1376 cl_2queue_init(queue);
1377 cl_2queue_add(queue, page);
1380 EXPORT_SYMBOL(cl_2queue_init_page);
1383 * Returns top-level io.
1385 * \see cl_object_top(), cl_page_top().
1387 struct cl_io *cl_io_top(struct cl_io *io)
1390 while (io->ci_parent != NULL)
1394 EXPORT_SYMBOL(cl_io_top);
1397 * Prints human readable representation of \a io to the \a f.
1399 void cl_io_print(const struct lu_env *env, void *cookie,
1400 lu_printer_t printer, const struct cl_io *io)
1405 * Adds request slice to the compound request.
1407 * This is called by cl_device_operations::cdo_req_init() methods to add a
1408 * per-layer state to the request. New state is added at the end of
1409 * cl_req::crq_layers list, that is, it is at the bottom of the stack.
1411 * \see cl_lock_slice_add(), cl_page_slice_add(), cl_io_slice_add()
1413 void cl_req_slice_add(struct cl_req *req, struct cl_req_slice *slice,
1414 struct cl_device *dev,
1415 const struct cl_req_operations *ops)
1418 cfs_list_add_tail(&slice->crs_linkage, &req->crq_layers);
1419 slice->crs_dev = dev;
1420 slice->crs_ops = ops;
1421 slice->crs_req = req;
1424 EXPORT_SYMBOL(cl_req_slice_add);
1426 static void cl_req_free(const struct lu_env *env, struct cl_req *req)
1430 LASSERT(cfs_list_empty(&req->crq_pages));
1431 LASSERT(req->crq_nrpages == 0);
1432 LINVRNT(cfs_list_empty(&req->crq_layers));
1433 LINVRNT(equi(req->crq_nrobjs > 0, req->crq_o != NULL));
1436 if (req->crq_o != NULL) {
1437 for (i = 0; i < req->crq_nrobjs; ++i) {
1438 struct cl_object *obj = req->crq_o[i].ro_obj;
1440 lu_object_ref_del_at(&obj->co_lu,
1441 req->crq_o[i].ro_obj_ref,
1443 cl_object_put(env, obj);
1446 OBD_FREE(req->crq_o, req->crq_nrobjs * sizeof req->crq_o[0]);
1452 static int cl_req_init(const struct lu_env *env, struct cl_req *req,
1453 struct cl_page *page)
1455 struct cl_device *dev;
1456 struct cl_page_slice *slice;
1461 page = cl_page_top(page);
1463 cfs_list_for_each_entry(slice, &page->cp_layers, cpl_linkage) {
1464 dev = lu2cl_dev(slice->cpl_obj->co_lu.lo_dev);
1465 if (dev->cd_ops->cdo_req_init != NULL) {
1466 result = dev->cd_ops->cdo_req_init(env,
1472 page = page->cp_child;
1473 } while (page != NULL && result == 0);
1478 * Invokes per-request transfer completion call-backs
1479 * (cl_req_operations::cro_completion()) bottom-to-top.
1481 void cl_req_completion(const struct lu_env *env, struct cl_req *req, int rc)
1483 struct cl_req_slice *slice;
1487 * for the lack of list_for_each_entry_reverse_safe()...
1489 while (!cfs_list_empty(&req->crq_layers)) {
1490 slice = cfs_list_entry(req->crq_layers.prev,
1491 struct cl_req_slice, crs_linkage);
1492 cfs_list_del_init(&slice->crs_linkage);
1493 if (slice->crs_ops->cro_completion != NULL)
1494 slice->crs_ops->cro_completion(env, slice, rc);
1496 cl_req_free(env, req);
1499 EXPORT_SYMBOL(cl_req_completion);
1502 * Allocates new transfer request.
1504 struct cl_req *cl_req_alloc(const struct lu_env *env, struct cl_page *page,
1505 enum cl_req_type crt, int nr_objects)
1509 LINVRNT(nr_objects > 0);
1516 OBD_ALLOC(req->crq_o, nr_objects * sizeof req->crq_o[0]);
1517 if (req->crq_o != NULL) {
1518 req->crq_nrobjs = nr_objects;
1519 req->crq_type = crt;
1520 CFS_INIT_LIST_HEAD(&req->crq_pages);
1521 CFS_INIT_LIST_HEAD(&req->crq_layers);
1522 result = cl_req_init(env, req, page);
1526 cl_req_completion(env, req, result);
1527 req = ERR_PTR(result);
1530 req = ERR_PTR(-ENOMEM);
1533 EXPORT_SYMBOL(cl_req_alloc);
1536 * Adds a page to a request.
1538 void cl_req_page_add(const struct lu_env *env,
1539 struct cl_req *req, struct cl_page *page)
1541 struct cl_object *obj;
1542 struct cl_req_obj *rqo;
1546 page = cl_page_top(page);
1548 LASSERT(cfs_list_empty(&page->cp_flight));
1549 LASSERT(page->cp_req == NULL);
1551 CL_PAGE_DEBUG(D_PAGE, env, page, "req %p, %d, %u\n",
1552 req, req->crq_type, req->crq_nrpages);
1554 cfs_list_add_tail(&page->cp_flight, &req->crq_pages);
1557 obj = cl_object_top(page->cp_obj);
1558 for (i = 0, rqo = req->crq_o; obj != rqo->ro_obj; ++i, ++rqo) {
1559 if (rqo->ro_obj == NULL) {
1562 rqo->ro_obj_ref = lu_object_ref_add(&obj->co_lu,
1567 LASSERT(i < req->crq_nrobjs);
1570 EXPORT_SYMBOL(cl_req_page_add);
1573 * Removes a page from a request.
1575 void cl_req_page_done(const struct lu_env *env, struct cl_page *page)
1577 struct cl_req *req = page->cp_req;
1580 page = cl_page_top(page);
1582 LASSERT(!cfs_list_empty(&page->cp_flight));
1583 LASSERT(req->crq_nrpages > 0);
1585 cfs_list_del_init(&page->cp_flight);
1587 page->cp_req = NULL;
1590 EXPORT_SYMBOL(cl_req_page_done);
1593 * Notifies layers that request is about to depart by calling
1594 * cl_req_operations::cro_prep() top-to-bottom.
1596 int cl_req_prep(const struct lu_env *env, struct cl_req *req)
1600 const struct cl_req_slice *slice;
1604 * Check that the caller of cl_req_alloc() didn't lie about the number
1607 for (i = 0; i < req->crq_nrobjs; ++i)
1608 LASSERT(req->crq_o[i].ro_obj != NULL);
1611 cfs_list_for_each_entry(slice, &req->crq_layers, crs_linkage) {
1612 if (slice->crs_ops->cro_prep != NULL) {
1613 result = slice->crs_ops->cro_prep(env, slice);
1620 EXPORT_SYMBOL(cl_req_prep);
1623 * Fills in attributes that are passed to server together with transfer. Only
1624 * attributes from \a flags may be touched. This can be called multiple times
1625 * for the same request.
1627 void cl_req_attr_set(const struct lu_env *env, struct cl_req *req,
1628 struct cl_req_attr *attr, obd_valid flags)
1630 const struct cl_req_slice *slice;
1631 struct cl_page *page;
1634 LASSERT(!cfs_list_empty(&req->crq_pages));
1637 /* Take any page to use as a model. */
1638 page = cfs_list_entry(req->crq_pages.next, struct cl_page, cp_flight);
1640 for (i = 0; i < req->crq_nrobjs; ++i) {
1641 cfs_list_for_each_entry(slice, &req->crq_layers, crs_linkage) {
1642 const struct cl_page_slice *scan;
1643 const struct cl_object *obj;
1645 scan = cl_page_at(page,
1646 slice->crs_dev->cd_lu_dev.ld_type);
1647 LASSERT(scan != NULL);
1648 obj = scan->cpl_obj;
1649 if (slice->crs_ops->cro_attr_set != NULL)
1650 slice->crs_ops->cro_attr_set(env, slice, obj,
1656 EXPORT_SYMBOL(cl_req_attr_set);
1658 /* XXX complete(), init_completion(), and wait_for_completion(), until they are
1659 * implemented in libcfs. */
1661 # include <linux/sched.h>
1662 #else /* __KERNEL__ */
1663 # include <liblustre.h>
1667 * Initialize synchronous io wait anchor, for transfer of \a nrpages pages.
1669 void cl_sync_io_init(struct cl_sync_io *anchor, int nrpages)
1672 cfs_waitq_init(&anchor->csi_waitq);
1673 cfs_atomic_set(&anchor->csi_sync_nr, nrpages);
1674 anchor->csi_sync_rc = 0;
1677 EXPORT_SYMBOL(cl_sync_io_init);
1680 * Wait until all transfer completes. Transfer completion routine has to call
1681 * cl_sync_io_note() for every page.
1683 int cl_sync_io_wait(const struct lu_env *env, struct cl_io *io,
1684 struct cl_page_list *queue, struct cl_sync_io *anchor,
1687 struct l_wait_info lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(timeout),
1692 LASSERT(timeout >= 0);
1694 rc = l_wait_event(anchor->csi_waitq,
1695 cfs_atomic_read(&anchor->csi_sync_nr) == 0,
1698 CERROR("SYNC IO failed with error: %d, try to cancel "
1699 "%d remaining pages\n",
1700 rc, cfs_atomic_read(&anchor->csi_sync_nr));
1702 (void)cl_io_cancel(env, io, queue);
1704 lwi = (struct l_wait_info) { 0 };
1705 (void)l_wait_event(anchor->csi_waitq,
1706 cfs_atomic_read(&anchor->csi_sync_nr) == 0,
1709 rc = anchor->csi_sync_rc;
1711 LASSERT(cfs_atomic_read(&anchor->csi_sync_nr) == 0);
1712 cl_page_list_assume(env, io, queue);
1713 POISON(anchor, 0x5a, sizeof *anchor);
1716 EXPORT_SYMBOL(cl_sync_io_wait);
1719 * Indicate that transfer of a single page completed.
1721 void cl_sync_io_note(struct cl_sync_io *anchor, int ioret)
1724 if (anchor->csi_sync_rc == 0 && ioret < 0)
1725 anchor->csi_sync_rc = ioret;
1727 * Synchronous IO done without releasing page lock (e.g., as a part of
1728 * ->{prepare,commit}_write(). Completion is used to signal the end of
1731 LASSERT(cfs_atomic_read(&anchor->csi_sync_nr) > 0);
1732 if (cfs_atomic_dec_and_test(&anchor->csi_sync_nr))
1733 cfs_waitq_broadcast(&anchor->csi_waitq);
1736 EXPORT_SYMBOL(cl_sync_io_note);