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