Whamcloud - gitweb
LU-12718 obdclass: Allow read-ahead for write requests
[fs/lustre-release.git] / lustre / obdclass / cl_io.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * Client IO.
33  *
34  *   Author: Nikita Danilov <nikita.danilov@sun.com>
35  *   Author: Jinshan Xiong <jinshan.xiong@intel.com>
36  */
37
38 #define DEBUG_SUBSYSTEM S_CLASS
39
40 #include <linux/sched.h>
41 #include <linux/list.h>
42 #include <linux/list_sort.h>
43 #include <obd_class.h>
44 #include <obd_support.h>
45 #include <lustre_fid.h>
46 #include <cl_object.h>
47 #include "cl_internal.h"
48
49 /*****************************************************************************
50  *
51  * cl_io interface.
52  *
53  */
54
55 static inline int cl_io_type_is_valid(enum cl_io_type type)
56 {
57         return CIT_READ <= type && type < CIT_OP_NR;
58 }
59
60 static inline int cl_io_is_loopable(const struct cl_io *io)
61 {
62         return cl_io_type_is_valid(io->ci_type) && io->ci_type != CIT_MISC;
63 }
64
65 /**
66  * cl_io invariant that holds at all times when exported cl_io_*() functions
67  * are entered and left.
68  */
69 static int cl_io_invariant(const struct cl_io *io)
70 {
71         struct cl_io *up;
72
73         up = io->ci_parent;
74         return
75                 /*
76                  * io can own pages only when it is ongoing. Sub-io might
77                  * still be in CIS_LOCKED state when top-io is in
78                  * CIS_IO_GOING.
79                  */
80                 ergo(io->ci_owned_nr > 0, io->ci_state == CIS_IO_GOING ||
81                      (io->ci_state == CIS_LOCKED && up != NULL));
82 }
83
84 /**
85  * Finalize \a io, by calling cl_io_operations::cio_fini() bottom-to-top.
86  */
87 void cl_io_fini(const struct lu_env *env, struct cl_io *io)
88 {
89         struct cl_io_slice    *slice;
90
91         LINVRNT(cl_io_type_is_valid(io->ci_type));
92         LINVRNT(cl_io_invariant(io));
93         ENTRY;
94
95         while (!list_empty(&io->ci_layers)) {
96                 slice = container_of(io->ci_layers.prev, struct cl_io_slice,
97                                      cis_linkage);
98                 list_del_init(&slice->cis_linkage);
99                 if (slice->cis_iop->op[io->ci_type].cio_fini != NULL)
100                         slice->cis_iop->op[io->ci_type].cio_fini(env, slice);
101                 /*
102                  * Invalidate slice to catch use after free. This assumes that
103                  * slices are allocated within session and can be touched
104                  * after ->cio_fini() returns.
105                  */
106                 slice->cis_io = NULL;
107         }
108         io->ci_state = CIS_FINI;
109
110         /* sanity check for layout change */
111         switch(io->ci_type) {
112         case CIT_READ:
113         case CIT_WRITE:
114         case CIT_DATA_VERSION:
115         case CIT_FAULT:
116                 break;
117         case CIT_FSYNC:
118                 LASSERT(!io->ci_need_restart);
119                 break;
120         case CIT_SETATTR:
121         case CIT_MISC:
122                 /* Check ignore layout change conf */
123                 LASSERT(ergo(io->ci_ignore_layout || !io->ci_verify_layout,
124                                 !io->ci_need_restart));
125         case CIT_GLIMPSE:
126                 break;
127         case CIT_LADVISE:
128                 break;
129         default:
130                 LBUG();
131         }
132         EXIT;
133 }
134 EXPORT_SYMBOL(cl_io_fini);
135
136 static int cl_io_init0(const struct lu_env *env, struct cl_io *io,
137                        enum cl_io_type iot, struct cl_object *obj)
138 {
139         struct cl_object *scan;
140         int result;
141
142         LINVRNT(io->ci_state == CIS_ZERO || io->ci_state == CIS_FINI);
143         LINVRNT(cl_io_type_is_valid(iot));
144         LINVRNT(cl_io_invariant(io));
145         ENTRY;
146
147         io->ci_type = iot;
148         INIT_LIST_HEAD(&io->ci_lockset.cls_todo);
149         INIT_LIST_HEAD(&io->ci_lockset.cls_done);
150         INIT_LIST_HEAD(&io->ci_layers);
151
152         result = 0;
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);
156                         if (result != 0)
157                                 break;
158                 }
159         }
160         if (result == 0)
161                 io->ci_state = CIS_INIT;
162         RETURN(result);
163 }
164
165 /**
166  * Initialize sub-io, by calling cl_io_operations::cio_init() top-to-bottom.
167  *
168  * \pre obj != cl_object_top(obj)
169  */
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)
172 {
173         LASSERT(obj != cl_object_top(obj));
174
175         return cl_io_init0(env, io, iot, obj);
176 }
177 EXPORT_SYMBOL(cl_io_sub_init);
178
179 /**
180  * Initialize \a io, by calling cl_io_operations::cio_init() top-to-bottom.
181  *
182  * Caller has to call cl_io_fini() after a call to cl_io_init(), no matter
183  * what the latter returned.
184  *
185  * \pre obj == cl_object_top(obj)
186  * \pre cl_io_type_is_valid(iot)
187  * \post cl_io_type_is_valid(io->ci_type) && io->ci_type == iot
188  */
189 int cl_io_init(const struct lu_env *env, struct cl_io *io,
190                enum cl_io_type iot, struct cl_object *obj)
191 {
192         LASSERT(obj == cl_object_top(obj));
193
194         /* clear I/O restart from previous instance */
195         io->ci_need_restart = 0;
196
197         return cl_io_init0(env, io, iot, obj);
198 }
199 EXPORT_SYMBOL(cl_io_init);
200
201 /**
202  * Initialize read or write io.
203  *
204  * \pre iot == CIT_READ || iot == CIT_WRITE
205  */
206 int cl_io_rw_init(const struct lu_env *env, struct cl_io *io,
207                   enum cl_io_type iot, loff_t pos, size_t count)
208 {
209         LINVRNT(iot == CIT_READ || iot == CIT_WRITE);
210         LINVRNT(io->ci_obj != NULL);
211         ENTRY;
212
213         LU_OBJECT_HEADER(D_VFSTRACE, env, &io->ci_obj->co_lu,
214                          "io range: %u [%llu, %llu) %u %u\n",
215                          iot, (__u64)pos, (__u64)pos + count,
216                          io->u.ci_rw.crw_nonblock, io->u.ci_wr.wr_append);
217         io->u.ci_rw.crw_pos    = pos;
218         io->u.ci_rw.crw_count  = count;
219         RETURN(cl_io_init(env, io, iot, io->ci_obj));
220 }
221 EXPORT_SYMBOL(cl_io_rw_init);
222
223 static int cl_lock_descr_cmp(void *priv,
224                              struct list_head *a, struct list_head *b)
225 {
226         const struct cl_io_lock_link *l0 = list_entry(a, struct cl_io_lock_link,
227                                                       cill_linkage);
228         const struct cl_io_lock_link *l1 = list_entry(b, struct cl_io_lock_link,
229                                                       cill_linkage);
230         const struct cl_lock_descr *d0 = &l0->cill_descr;
231         const struct cl_lock_descr *d1 = &l1->cill_descr;
232
233         return lu_fid_cmp(lu_object_fid(&d0->cld_obj->co_lu),
234                           lu_object_fid(&d1->cld_obj->co_lu));
235 }
236
237 static void cl_lock_descr_merge(struct cl_lock_descr *d0,
238                                 const struct cl_lock_descr *d1)
239 {
240         d0->cld_start = min(d0->cld_start, d1->cld_start);
241         d0->cld_end = max(d0->cld_end, d1->cld_end);
242
243         if (d1->cld_mode == CLM_WRITE && d0->cld_mode != CLM_WRITE)
244                 d0->cld_mode = CLM_WRITE;
245
246         if (d1->cld_mode == CLM_GROUP && d0->cld_mode != CLM_GROUP)
247                 d0->cld_mode = CLM_GROUP;
248 }
249
250 static int cl_lockset_merge(const struct cl_lockset *set,
251                             const struct cl_lock_descr *need)
252 {
253         struct cl_io_lock_link *scan;
254
255         ENTRY;
256         list_for_each_entry(scan, &set->cls_todo, cill_linkage) {
257                 if (!cl_object_same(scan->cill_descr.cld_obj, need->cld_obj))
258                         continue;
259
260                 /* Merge locks for the same object because ldlm lock server
261                  * may expand the lock extent, otherwise there is a deadlock
262                  * case if two conflicted locks are queueud for the same object
263                  * and lock server expands one lock to overlap the another.
264                  * The side effect is that it can generate a multi-stripe lock
265                  * that may cause casacading problem */
266                 cl_lock_descr_merge(&scan->cill_descr, need);
267                 CDEBUG(D_VFSTRACE, "lock: %d: [%lu, %lu]\n",
268                        scan->cill_descr.cld_mode, scan->cill_descr.cld_start,
269                        scan->cill_descr.cld_end);
270                 RETURN(+1);
271         }
272         RETURN(0);
273 }
274
275 static int cl_lockset_lock(const struct lu_env *env, struct cl_io *io,
276                            struct cl_lockset *set)
277 {
278         struct cl_io_lock_link *link;
279         struct cl_io_lock_link *temp;
280         int result;
281
282         ENTRY;
283         result = 0;
284         list_for_each_entry_safe(link, temp, &set->cls_todo, cill_linkage) {
285                 result = cl_lock_request(env, io, &link->cill_lock);
286                 if (result < 0)
287                         break;
288
289                 list_move(&link->cill_linkage, &set->cls_done);
290         }
291         RETURN(result);
292 }
293
294 /**
295  * Takes locks necessary for the current iteration of io.
296  *
297  * Calls cl_io_operations::cio_lock() top-to-bottom to collect locks required
298  * by layers for the current iteration. Then sort locks (to avoid dead-locks),
299  * and acquire them.
300  */
301 int cl_io_lock(const struct lu_env *env, struct cl_io *io)
302 {
303         const struct cl_io_slice *scan;
304         int result = 0;
305
306         LINVRNT(cl_io_is_loopable(io));
307         LINVRNT(io->ci_state == CIS_IT_STARTED);
308         LINVRNT(cl_io_invariant(io));
309
310         ENTRY;
311         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
312                 if (scan->cis_iop->op[io->ci_type].cio_lock == NULL)
313                         continue;
314                 result = scan->cis_iop->op[io->ci_type].cio_lock(env, scan);
315                 if (result != 0)
316                         break;
317         }
318         if (result == 0) {
319                 /*
320                  * Sort locks in lexicographical order of their (fid,
321                  * start-offset) pairs to avoid deadlocks.
322                  */
323                 list_sort(NULL, &io->ci_lockset.cls_todo, cl_lock_descr_cmp);
324                 result = cl_lockset_lock(env, io, &io->ci_lockset);
325         }
326         if (result != 0)
327                 cl_io_unlock(env, io);
328         else
329                 io->ci_state = CIS_LOCKED;
330         RETURN(result);
331 }
332 EXPORT_SYMBOL(cl_io_lock);
333
334 /**
335  * Release locks takes by io.
336  */
337 void cl_io_unlock(const struct lu_env *env, struct cl_io *io)
338 {
339         struct cl_lockset        *set;
340         struct cl_io_lock_link   *link;
341         struct cl_io_lock_link   *temp;
342         const struct cl_io_slice *scan;
343
344         LASSERT(cl_io_is_loopable(io));
345         LASSERT(CIS_IT_STARTED <= io->ci_state && io->ci_state < CIS_UNLOCKED);
346         LINVRNT(cl_io_invariant(io));
347
348         ENTRY;
349         set = &io->ci_lockset;
350
351         list_for_each_entry_safe(link, temp, &set->cls_todo, cill_linkage) {
352                 list_del_init(&link->cill_linkage);
353                 if (link->cill_fini != NULL)
354                         link->cill_fini(env, link);
355         }
356
357         list_for_each_entry_safe(link, temp, &set->cls_done, cill_linkage) {
358                 list_del_init(&link->cill_linkage);
359                 cl_lock_release(env, &link->cill_lock);
360                 if (link->cill_fini != NULL)
361                         link->cill_fini(env, link);
362         }
363
364         list_for_each_entry_reverse(scan, &io->ci_layers, cis_linkage) {
365                 if (scan->cis_iop->op[io->ci_type].cio_unlock != NULL)
366                         scan->cis_iop->op[io->ci_type].cio_unlock(env, scan);
367         }
368         io->ci_state = CIS_UNLOCKED;
369         EXIT;
370 }
371 EXPORT_SYMBOL(cl_io_unlock);
372
373 /**
374  * Prepares next iteration of io.
375  *
376  * Calls cl_io_operations::cio_iter_init() top-to-bottom. This exists to give
377  * layers a chance to modify io parameters, e.g., so that lov can restrict io
378  * to a single stripe.
379  */
380 int cl_io_iter_init(const struct lu_env *env, struct cl_io *io)
381 {
382         const struct cl_io_slice *scan;
383         int result;
384
385         LINVRNT(cl_io_is_loopable(io));
386         LINVRNT(io->ci_state == CIS_INIT || io->ci_state == CIS_IT_ENDED);
387         LINVRNT(cl_io_invariant(io));
388
389         ENTRY;
390         result = 0;
391         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
392                 if (scan->cis_iop->op[io->ci_type].cio_iter_init == NULL)
393                         continue;
394                 result = scan->cis_iop->op[io->ci_type].cio_iter_init(env,
395                                                                       scan);
396                 if (result != 0)
397                         break;
398         }
399         if (result == 0)
400                 io->ci_state = CIS_IT_STARTED;
401         RETURN(result);
402 }
403 EXPORT_SYMBOL(cl_io_iter_init);
404
405 /**
406  * Finalizes io iteration.
407  *
408  * Calls cl_io_operations::cio_iter_fini() bottom-to-top.
409  */
410 void cl_io_iter_fini(const struct lu_env *env, struct cl_io *io)
411 {
412         const struct cl_io_slice *scan;
413
414         LINVRNT(cl_io_is_loopable(io));
415         LINVRNT(io->ci_state <= CIS_IT_STARTED ||
416                 io->ci_state > CIS_IO_FINISHED);
417         LINVRNT(cl_io_invariant(io));
418
419         ENTRY;
420         list_for_each_entry_reverse(scan, &io->ci_layers, cis_linkage) {
421                 if (scan->cis_iop->op[io->ci_type].cio_iter_fini != NULL)
422                         scan->cis_iop->op[io->ci_type].cio_iter_fini(env, scan);
423         }
424         io->ci_state = CIS_IT_ENDED;
425         EXIT;
426 }
427 EXPORT_SYMBOL(cl_io_iter_fini);
428
429 /**
430  * Records that read or write io progressed \a nob bytes forward.
431  */
432 void cl_io_rw_advance(const struct lu_env *env, struct cl_io *io, size_t nob)
433 {
434         const struct cl_io_slice *scan;
435
436         ENTRY;
437
438         LINVRNT(io->ci_type == CIT_READ || io->ci_type == CIT_WRITE ||
439                 nob == 0);
440         LINVRNT(cl_io_is_loopable(io));
441         LINVRNT(cl_io_invariant(io));
442
443         io->u.ci_rw.crw_pos   += nob;
444         io->u.ci_rw.crw_count -= nob;
445
446         /* layers have to be notified. */
447         list_for_each_entry_reverse(scan, &io->ci_layers, cis_linkage) {
448                 if (scan->cis_iop->op[io->ci_type].cio_advance != NULL)
449                         scan->cis_iop->op[io->ci_type].cio_advance(env, scan,
450                                                                    nob);
451         }
452         EXIT;
453 }
454
455 /**
456  * Adds a lock to a lockset.
457  */
458 int cl_io_lock_add(const struct lu_env *env, struct cl_io *io,
459                    struct cl_io_lock_link *link)
460 {
461         int result;
462
463         ENTRY;
464         if (cl_lockset_merge(&io->ci_lockset, &link->cill_descr))
465                 result = +1;
466         else {
467                 list_add(&link->cill_linkage, &io->ci_lockset.cls_todo);
468                 result = 0;
469         }
470         RETURN(result);
471 }
472 EXPORT_SYMBOL(cl_io_lock_add);
473
474 static void cl_free_io_lock_link(const struct lu_env *env,
475                                  struct cl_io_lock_link *link)
476 {
477         OBD_FREE_PTR(link);
478 }
479
480 /**
481  * Allocates new lock link, and uses it to add a lock to a lockset.
482  */
483 int cl_io_lock_alloc_add(const struct lu_env *env, struct cl_io *io,
484                          struct cl_lock_descr *descr)
485 {
486         struct cl_io_lock_link *link;
487         int result;
488
489         ENTRY;
490         OBD_ALLOC_PTR(link);
491         if (link != NULL) {
492                 link->cill_descr = *descr;
493                 link->cill_fini  = cl_free_io_lock_link;
494                 result = cl_io_lock_add(env, io, link);
495                 if (result) /* lock match */
496                         link->cill_fini(env, link);
497         } else
498                 result = -ENOMEM;
499
500         RETURN(result);
501 }
502 EXPORT_SYMBOL(cl_io_lock_alloc_add);
503
504 /**
505  * Starts io by calling cl_io_operations::cio_start() top-to-bottom.
506  */
507 int cl_io_start(const struct lu_env *env, struct cl_io *io)
508 {
509         const struct cl_io_slice *scan;
510         int result = 0;
511
512         LINVRNT(cl_io_is_loopable(io));
513         LINVRNT(io->ci_state == CIS_LOCKED);
514         LINVRNT(cl_io_invariant(io));
515         ENTRY;
516
517         io->ci_state = CIS_IO_GOING;
518         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
519                 if (scan->cis_iop->op[io->ci_type].cio_start == NULL)
520                         continue;
521                 result = scan->cis_iop->op[io->ci_type].cio_start(env, scan);
522                 if (result != 0)
523                         break;
524         }
525         if (result >= 0)
526                 result = 0;
527         RETURN(result);
528 }
529 EXPORT_SYMBOL(cl_io_start);
530
531 /**
532  * Wait until current io iteration is finished by calling
533  * cl_io_operations::cio_end() bottom-to-top.
534  */
535 void cl_io_end(const struct lu_env *env, struct cl_io *io)
536 {
537         const struct cl_io_slice *scan;
538
539         LINVRNT(cl_io_is_loopable(io));
540         LINVRNT(io->ci_state == CIS_IO_GOING);
541         LINVRNT(cl_io_invariant(io));
542         ENTRY;
543
544         list_for_each_entry_reverse(scan, &io->ci_layers, cis_linkage) {
545                 if (scan->cis_iop->op[io->ci_type].cio_end != NULL)
546                         scan->cis_iop->op[io->ci_type].cio_end(env, scan);
547                 /* TODO: error handling. */
548         }
549         io->ci_state = CIS_IO_FINISHED;
550         EXIT;
551 }
552 EXPORT_SYMBOL(cl_io_end);
553
554 /**
555  * Called by read io, to decide the readahead extent
556  *
557  * \see cl_io_operations::cio_read_ahead()
558  */
559 int cl_io_read_ahead(const struct lu_env *env, struct cl_io *io,
560                      pgoff_t start, struct cl_read_ahead *ra)
561 {
562         const struct cl_io_slice *scan;
563         int                       result = 0;
564
565         LINVRNT(io->ci_type == CIT_READ ||
566                 io->ci_type == CIT_FAULT ||
567                 io->ci_type == CIT_WRITE);
568         LINVRNT(io->ci_state == CIS_IO_GOING || io->ci_state == CIS_LOCKED);
569         LINVRNT(cl_io_invariant(io));
570         ENTRY;
571
572         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
573                 if (scan->cis_iop->cio_read_ahead == NULL)
574                         continue;
575
576                 result = scan->cis_iop->cio_read_ahead(env, scan, start, ra);
577                 if (result != 0)
578                         break;
579         }
580         RETURN(result > 0 ? 0 : result);
581 }
582 EXPORT_SYMBOL(cl_io_read_ahead);
583
584 /**
585  * Commit a list of contiguous pages into writeback cache.
586  *
587  * \returns 0 if all pages committed, or errcode if error occurred.
588  * \see cl_io_operations::cio_commit_async()
589  */
590 int cl_io_commit_async(const struct lu_env *env, struct cl_io *io,
591                        struct cl_page_list *queue, int from, int to,
592                        cl_commit_cbt cb)
593 {
594         const struct cl_io_slice *scan;
595         int result = 0;
596         ENTRY;
597
598         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
599                 if (scan->cis_iop->cio_commit_async == NULL)
600                         continue;
601                 result = scan->cis_iop->cio_commit_async(env, scan, queue,
602                                                          from, to, cb);
603                 if (result != 0)
604                         break;
605         }
606         RETURN(result);
607 }
608 EXPORT_SYMBOL(cl_io_commit_async);
609
610 /**
611  * Submits a list of pages for immediate io.
612  *
613  * After the function gets returned, The submitted pages are moved to
614  * queue->c2_qout queue, and queue->c2_qin contain both the pages don't need
615  * to be submitted, and the pages are errant to submit.
616  *
617  * \returns 0 if at least one page was submitted, error code otherwise.
618  * \see cl_io_operations::cio_submit()
619  */
620 int cl_io_submit_rw(const struct lu_env *env, struct cl_io *io,
621                     enum cl_req_type crt, struct cl_2queue *queue)
622 {
623         const struct cl_io_slice *scan;
624         int result = 0;
625         ENTRY;
626
627         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
628                 if (scan->cis_iop->cio_submit == NULL)
629                         continue;
630                 result = scan->cis_iop->cio_submit(env, scan, crt, queue);
631                 if (result != 0)
632                         break;
633         }
634         /*
635          * If ->cio_submit() failed, no pages were sent.
636          */
637         LASSERT(ergo(result != 0, list_empty(&queue->c2_qout.pl_pages)));
638         RETURN(result);
639 }
640 EXPORT_SYMBOL(cl_io_submit_rw);
641
642 /**
643  * Submit a sync_io and wait for the IO to be finished, or error happens.
644  * If \a timeout is zero, it means to wait for the IO unconditionally.
645  */
646 int cl_io_submit_sync(const struct lu_env *env, struct cl_io *io,
647                       enum cl_req_type iot, struct cl_2queue *queue,
648                       long timeout)
649 {
650         struct cl_sync_io *anchor = &cl_env_info(env)->clt_anchor;
651         struct cl_page *pg;
652         int rc;
653
654         cl_page_list_for_each(pg, &queue->c2_qin) {
655                 LASSERT(pg->cp_sync_io == NULL);
656                 pg->cp_sync_io = anchor;
657         }
658
659         cl_sync_io_init(anchor, queue->c2_qin.pl_nr);
660         rc = cl_io_submit_rw(env, io, iot, queue);
661         if (rc == 0) {
662                 /*
663                  * If some pages weren't sent for any reason (e.g.,
664                  * read found up-to-date pages in the cache, or write found
665                  * clean pages), count them as completed to avoid infinite
666                  * wait.
667                  */
668                 cl_page_list_for_each(pg, &queue->c2_qin) {
669                         pg->cp_sync_io = NULL;
670                         cl_sync_io_note(env, anchor, 1);
671                 }
672
673                 /* wait for the IO to be finished. */
674                 rc = cl_sync_io_wait(env, anchor, timeout);
675                 cl_page_list_assume(env, io, &queue->c2_qout);
676         } else {
677                 LASSERT(list_empty(&queue->c2_qout.pl_pages));
678                 cl_page_list_for_each(pg, &queue->c2_qin)
679                         pg->cp_sync_io = NULL;
680         }
681         return rc;
682 }
683 EXPORT_SYMBOL(cl_io_submit_sync);
684
685 /**
686  * Cancel an IO which has been submitted by cl_io_submit_rw.
687  */
688 int cl_io_cancel(const struct lu_env *env, struct cl_io *io,
689                  struct cl_page_list *queue)
690 {
691         struct cl_page *page;
692         int result = 0;
693
694         CERROR("Canceling ongoing page trasmission\n");
695         cl_page_list_for_each(page, queue) {
696                 int rc;
697
698                 rc = cl_page_cancel(env, page);
699                 result = result ?: rc;
700         }
701         return result;
702 }
703
704 /**
705  * Main io loop.
706  *
707  * Pumps io through iterations calling
708  *
709  *    - cl_io_iter_init()
710  *
711  *    - cl_io_lock()
712  *
713  *    - cl_io_start()
714  *
715  *    - cl_io_end()
716  *
717  *    - cl_io_unlock()
718  *
719  *    - cl_io_iter_fini()
720  *
721  * repeatedly until there is no more io to do.
722  */
723 int cl_io_loop(const struct lu_env *env, struct cl_io *io)
724 {
725         int result   = 0;
726
727         LINVRNT(cl_io_is_loopable(io));
728         ENTRY;
729
730         do {
731                 size_t nob;
732
733                 io->ci_continue = 0;
734                 result = cl_io_iter_init(env, io);
735                 if (result == 0) {
736                         nob    = io->ci_nob;
737                         result = cl_io_lock(env, io);
738                         if (result == 0) {
739                                 /*
740                                  * Notify layers that locks has been taken,
741                                  * and do actual i/o.
742                                  *
743                                  *   - llite: kms, short read;
744                                  *   - llite: generic_file_read();
745                                  */
746                                 result = cl_io_start(env, io);
747                                 /*
748                                  * Send any remaining pending
749                                  * io, etc.
750                                  *
751                                  **   - llite: ll_rw_stats_tally.
752                                  */
753                                 cl_io_end(env, io);
754                                 cl_io_unlock(env, io);
755                                 cl_io_rw_advance(env, io, io->ci_nob - nob);
756                         }
757                 }
758                 cl_io_iter_fini(env, io);
759         } while (result == 0 && io->ci_continue);
760
761         if (result == -EWOULDBLOCK && io->ci_ndelay) {
762                 io->ci_need_restart = 1;
763                 result = 0;
764         }
765
766         if (result == 0)
767                 result = io->ci_result;
768         RETURN(result < 0 ? result : 0);
769 }
770 EXPORT_SYMBOL(cl_io_loop);
771
772 /**
773  * Adds io slice to the cl_io.
774  *
775  * This is called by cl_object_operations::coo_io_init() methods to add a
776  * per-layer state to the io. New state is added at the end of
777  * cl_io::ci_layers list, that is, it is at the bottom of the stack.
778  *
779  * \see cl_lock_slice_add(), cl_req_slice_add(), cl_page_slice_add()
780  */
781 void cl_io_slice_add(struct cl_io *io, struct cl_io_slice *slice,
782                      struct cl_object *obj,
783                      const struct cl_io_operations *ops)
784 {
785         struct list_head *linkage = &slice->cis_linkage;
786
787         LASSERT((linkage->prev == NULL && linkage->next == NULL) ||
788                 list_empty(linkage));
789         ENTRY;
790
791         list_add_tail(linkage, &io->ci_layers);
792         slice->cis_io  = io;
793         slice->cis_obj = obj;
794         slice->cis_iop = ops;
795         EXIT;
796 }
797 EXPORT_SYMBOL(cl_io_slice_add);
798
799
800 /**
801  * Initializes page list.
802  */
803 void cl_page_list_init(struct cl_page_list *plist)
804 {
805         ENTRY;
806         plist->pl_nr = 0;
807         INIT_LIST_HEAD(&plist->pl_pages);
808         plist->pl_owner = current;
809         EXIT;
810 }
811 EXPORT_SYMBOL(cl_page_list_init);
812
813 /**
814  * Adds a page to a page list.
815  */
816 void cl_page_list_add(struct cl_page_list *plist, struct cl_page *page)
817 {
818         ENTRY;
819         /* it would be better to check that page is owned by "current" io, but
820          * it is not passed here. */
821         LASSERT(page->cp_owner != NULL);
822         LINVRNT(plist->pl_owner == current);
823
824         LASSERT(list_empty(&page->cp_batch));
825         list_add_tail(&page->cp_batch, &plist->pl_pages);
826         ++plist->pl_nr;
827         lu_ref_add_at(&page->cp_reference, &page->cp_queue_ref, "queue", plist);
828         cl_page_get(page);
829         EXIT;
830 }
831 EXPORT_SYMBOL(cl_page_list_add);
832
833 /**
834  * Removes a page from a page list.
835  */
836 void cl_page_list_del(const struct lu_env *env,
837                       struct cl_page_list *plist, struct cl_page *page)
838 {
839         LASSERT(plist->pl_nr > 0);
840         LASSERT(cl_page_is_vmlocked(env, page));
841         LINVRNT(plist->pl_owner == current);
842
843         ENTRY;
844         list_del_init(&page->cp_batch);
845         --plist->pl_nr;
846         lu_ref_del_at(&page->cp_reference, &page->cp_queue_ref, "queue", plist);
847         cl_page_put(env, page);
848         EXIT;
849 }
850 EXPORT_SYMBOL(cl_page_list_del);
851
852 /**
853  * Moves a page from one page list to another.
854  */
855 void cl_page_list_move(struct cl_page_list *dst, struct cl_page_list *src,
856                        struct cl_page *page)
857 {
858         LASSERT(src->pl_nr > 0);
859         LINVRNT(dst->pl_owner == current);
860         LINVRNT(src->pl_owner == current);
861
862         ENTRY;
863         list_move_tail(&page->cp_batch, &dst->pl_pages);
864         --src->pl_nr;
865         ++dst->pl_nr;
866         lu_ref_set_at(&page->cp_reference, &page->cp_queue_ref, "queue",
867                       src, dst);
868         EXIT;
869 }
870 EXPORT_SYMBOL(cl_page_list_move);
871
872 /**
873  * Moves a page from one page list to the head of another list.
874  */
875 void cl_page_list_move_head(struct cl_page_list *dst, struct cl_page_list *src,
876                             struct cl_page *page)
877 {
878         LASSERT(src->pl_nr > 0);
879         LINVRNT(dst->pl_owner == current);
880         LINVRNT(src->pl_owner == current);
881
882         ENTRY;
883         list_move(&page->cp_batch, &dst->pl_pages);
884         --src->pl_nr;
885         ++dst->pl_nr;
886         lu_ref_set_at(&page->cp_reference, &page->cp_queue_ref, "queue",
887                         src, dst);
888         EXIT;
889 }
890 EXPORT_SYMBOL(cl_page_list_move_head);
891
892 /**
893  * splice the cl_page_list, just as list head does
894  */
895 void cl_page_list_splice(struct cl_page_list *list, struct cl_page_list *head)
896 {
897         struct cl_page *page;
898         struct cl_page *tmp;
899
900         LINVRNT(list->pl_owner == current);
901         LINVRNT(head->pl_owner == current);
902
903         ENTRY;
904         cl_page_list_for_each_safe(page, tmp, list)
905                 cl_page_list_move(head, list, page);
906         EXIT;
907 }
908 EXPORT_SYMBOL(cl_page_list_splice);
909
910 /**
911  * Disowns pages in a queue.
912  */
913 void cl_page_list_disown(const struct lu_env *env,
914                          struct cl_io *io, struct cl_page_list *plist)
915 {
916         struct cl_page *page;
917         struct cl_page *temp;
918
919         LINVRNT(plist->pl_owner == current);
920
921         ENTRY;
922         cl_page_list_for_each_safe(page, temp, plist) {
923                 LASSERT(plist->pl_nr > 0);
924
925                 list_del_init(&page->cp_batch);
926                 --plist->pl_nr;
927                 /*
928                  * cl_page_disown0 rather than usual cl_page_disown() is used,
929                  * because pages are possibly in CPS_FREEING state already due
930                  * to the call to cl_page_list_discard().
931                  */
932                 /*
933                  * XXX cl_page_disown0() will fail if page is not locked.
934                  */
935                 cl_page_disown0(env, io, page);
936                 lu_ref_del_at(&page->cp_reference, &page->cp_queue_ref, "queue",
937                               plist);
938                 cl_page_put(env, page);
939         }
940         EXIT;
941 }
942 EXPORT_SYMBOL(cl_page_list_disown);
943
944 /**
945  * Releases pages from queue.
946  */
947 void cl_page_list_fini(const struct lu_env *env, struct cl_page_list *plist)
948 {
949         struct cl_page *page;
950         struct cl_page *temp;
951
952         LINVRNT(plist->pl_owner == current);
953
954         ENTRY;
955         cl_page_list_for_each_safe(page, temp, plist)
956                 cl_page_list_del(env, plist, page);
957         LASSERT(plist->pl_nr == 0);
958         EXIT;
959 }
960 EXPORT_SYMBOL(cl_page_list_fini);
961
962 /**
963  * Assumes all pages in a queue.
964  */
965 void cl_page_list_assume(const struct lu_env *env,
966                          struct cl_io *io, struct cl_page_list *plist)
967 {
968         struct cl_page *page;
969
970         LINVRNT(plist->pl_owner == current);
971
972         cl_page_list_for_each(page, plist)
973                 cl_page_assume(env, io, page);
974 }
975
976 /**
977  * Discards all pages in a queue.
978  */
979 void cl_page_list_discard(const struct lu_env *env, struct cl_io *io,
980                           struct cl_page_list *plist)
981 {
982         struct cl_page *page;
983
984         LINVRNT(plist->pl_owner == current);
985         ENTRY;
986         cl_page_list_for_each(page, plist)
987                 cl_page_discard(env, io, page);
988         EXIT;
989 }
990 EXPORT_SYMBOL(cl_page_list_discard);
991
992 /**
993  * Initialize dual page queue.
994  */
995 void cl_2queue_init(struct cl_2queue *queue)
996 {
997         ENTRY;
998         cl_page_list_init(&queue->c2_qin);
999         cl_page_list_init(&queue->c2_qout);
1000         EXIT;
1001 }
1002 EXPORT_SYMBOL(cl_2queue_init);
1003
1004 /**
1005  * Add a page to the incoming page list of 2-queue.
1006  */
1007 void cl_2queue_add(struct cl_2queue *queue, struct cl_page *page)
1008 {
1009         ENTRY;
1010         cl_page_list_add(&queue->c2_qin, page);
1011         EXIT;
1012 }
1013 EXPORT_SYMBOL(cl_2queue_add);
1014
1015 /**
1016  * Disown pages in both lists of a 2-queue.
1017  */
1018 void cl_2queue_disown(const struct lu_env *env,
1019                       struct cl_io *io, struct cl_2queue *queue)
1020 {
1021         ENTRY;
1022         cl_page_list_disown(env, io, &queue->c2_qin);
1023         cl_page_list_disown(env, io, &queue->c2_qout);
1024         EXIT;
1025 }
1026 EXPORT_SYMBOL(cl_2queue_disown);
1027
1028 /**
1029  * Discard (truncate) pages in both lists of a 2-queue.
1030  */
1031 void cl_2queue_discard(const struct lu_env *env,
1032                        struct cl_io *io, struct cl_2queue *queue)
1033 {
1034         ENTRY;
1035         cl_page_list_discard(env, io, &queue->c2_qin);
1036         cl_page_list_discard(env, io, &queue->c2_qout);
1037         EXIT;
1038 }
1039 EXPORT_SYMBOL(cl_2queue_discard);
1040
1041 /**
1042  * Assume to own the pages in cl_2queue
1043  */
1044 void cl_2queue_assume(const struct lu_env *env,
1045                       struct cl_io *io, struct cl_2queue *queue)
1046 {
1047         cl_page_list_assume(env, io, &queue->c2_qin);
1048         cl_page_list_assume(env, io, &queue->c2_qout);
1049 }
1050
1051 /**
1052  * Finalize both page lists of a 2-queue.
1053  */
1054 void cl_2queue_fini(const struct lu_env *env, struct cl_2queue *queue)
1055 {
1056         ENTRY;
1057         cl_page_list_fini(env, &queue->c2_qout);
1058         cl_page_list_fini(env, &queue->c2_qin);
1059         EXIT;
1060 }
1061 EXPORT_SYMBOL(cl_2queue_fini);
1062
1063 /**
1064  * Initialize a 2-queue to contain \a page in its incoming page list.
1065  */
1066 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page)
1067 {
1068         ENTRY;
1069         cl_2queue_init(queue);
1070         cl_2queue_add(queue, page);
1071         EXIT;
1072 }
1073 EXPORT_SYMBOL(cl_2queue_init_page);
1074
1075 /**
1076  * Returns top-level io.
1077  *
1078  * \see cl_object_top()
1079  */
1080 struct cl_io *cl_io_top(struct cl_io *io)
1081 {
1082         ENTRY;
1083         while (io->ci_parent != NULL)
1084                 io = io->ci_parent;
1085         RETURN(io);
1086 }
1087 EXPORT_SYMBOL(cl_io_top);
1088
1089 /**
1090  * Prints human readable representation of \a io to the \a f.
1091  */
1092 void cl_io_print(const struct lu_env *env, void *cookie,
1093                  lu_printer_t printer, const struct cl_io *io)
1094 {
1095 }
1096
1097 /**
1098  * Fills in attributes that are passed to server together with transfer. Only
1099  * attributes from \a flags may be touched. This can be called multiple times
1100  * for the same request.
1101  */
1102 void cl_req_attr_set(const struct lu_env *env, struct cl_object *obj,
1103                      struct cl_req_attr *attr)
1104 {
1105         struct cl_object *scan;
1106         ENTRY;
1107
1108         cl_object_for_each(scan, obj) {
1109                 if (scan->co_ops->coo_req_attr_set != NULL)
1110                         scan->co_ops->coo_req_attr_set(env, scan, attr);
1111         }
1112         EXIT;
1113 }
1114 EXPORT_SYMBOL(cl_req_attr_set);
1115
1116 /**
1117  * Initialize synchronous io wait \a anchor for \a nr pages with optional
1118  * \a end handler.
1119  * \param anchor owned by caller, initialzied here.
1120  * \param nr number of pages initally pending in sync.
1121  * \param end optional callback sync_io completion, can be used to
1122  *  trigger erasure coding, integrity, dedupe, or similar operation.
1123  * \q end is called with a spinlock on anchor->csi_waitq.lock
1124  */
1125
1126 void cl_sync_io_init_notify(struct cl_sync_io *anchor, int nr,
1127                             cl_sync_io_end_t *end)
1128 {
1129         ENTRY;
1130         memset(anchor, 0, sizeof(*anchor));
1131         init_waitqueue_head(&anchor->csi_waitq);
1132         atomic_set(&anchor->csi_sync_nr, nr);
1133         anchor->csi_sync_rc = 0;
1134         anchor->csi_end_io = end;
1135         EXIT;
1136 }
1137 EXPORT_SYMBOL(cl_sync_io_init_notify);
1138
1139 /**
1140  * Wait until all IO completes. Transfer completion routine has to call
1141  * cl_sync_io_note() for every entity.
1142  */
1143 int cl_sync_io_wait(const struct lu_env *env, struct cl_sync_io *anchor,
1144                     long timeout)
1145 {
1146         struct l_wait_info lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(timeout),
1147                                                   NULL, NULL, NULL);
1148         int rc;
1149         ENTRY;
1150
1151         LASSERT(timeout >= 0);
1152
1153         rc = l_wait_event(anchor->csi_waitq,
1154                           atomic_read(&anchor->csi_sync_nr) == 0,
1155                           &lwi);
1156         if (rc < 0) {
1157                 CERROR("IO failed: %d, still wait for %d remaining entries\n",
1158                        rc, atomic_read(&anchor->csi_sync_nr));
1159
1160                 wait_event_idle(anchor->csi_waitq,
1161                                 atomic_read(&anchor->csi_sync_nr) == 0);
1162         } else {
1163                 rc = anchor->csi_sync_rc;
1164         }
1165         /* We take the lock to ensure that cl_sync_io_note() has finished */
1166         spin_lock(&anchor->csi_waitq.lock);
1167         LASSERT(atomic_read(&anchor->csi_sync_nr) == 0);
1168         spin_unlock(&anchor->csi_waitq.lock);
1169
1170         RETURN(rc);
1171 }
1172 EXPORT_SYMBOL(cl_sync_io_wait);
1173
1174 /**
1175  * Indicate that transfer of a single page completed.
1176  */
1177 void cl_sync_io_note(const struct lu_env *env, struct cl_sync_io *anchor,
1178                      int ioret)
1179 {
1180         ENTRY;
1181         if (anchor->csi_sync_rc == 0 && ioret < 0)
1182                 anchor->csi_sync_rc = ioret;
1183         /*
1184          * Synchronous IO done without releasing page lock (e.g., as a part of
1185          * ->{prepare,commit}_write(). Completion is used to signal the end of
1186          * IO.
1187          */
1188         LASSERT(atomic_read(&anchor->csi_sync_nr) > 0);
1189         if (atomic_dec_and_lock(&anchor->csi_sync_nr,
1190                                 &anchor->csi_waitq.lock)) {
1191                 cl_sync_io_end_t *end_io = anchor->csi_end_io;
1192
1193                 /*
1194                  * Holding the lock across both the decrement and
1195                  * the wakeup ensures cl_sync_io_wait() doesn't complete
1196                  * before the wakeup completes and the contents of
1197                  * of anchor become unsafe to access as the owner is free
1198                  * to immediately reclaim anchor when cl_sync_io_wait()
1199                  * completes.
1200                  */
1201                 wake_up_all_locked(&anchor->csi_waitq);
1202                 if (end_io)
1203                         end_io(env, anchor);
1204                 spin_unlock(&anchor->csi_waitq.lock);
1205
1206                 /* Can't access anchor any more */
1207         }
1208         EXIT;
1209 }
1210 EXPORT_SYMBOL(cl_sync_io_note);