lustre/obdclass/cl_io.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * Client IO.
  37  *
  38  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  39  */
  40
  41 #define DEBUG_SUBSYSTEM S_CLASS
  42 #ifndef EXPORT_SYMTAB
  43 # define EXPORT_SYMTAB
  44 #endif
  45
  46 #include <obd_class.h>
  47 #include <obd_support.h>
  48 #include <lustre_fid.h>
  49 #include <libcfs/list.h>
  50 /* lu_time_global_{init,fini}() */
  51 #include <lu_time.h>
  52
  53 #include <cl_object.h>
  54 #include "cl_internal.h"
  55
  56 /*****************************************************************************
  57  *
  58  * cl_io interface.
  59  *
  60  */
  61
  62 #define cl_io_for_each(slice, io) \
  63         list_for_each_entry((slice), &io->ci_layers, cis_linkage)
  64 #define cl_io_for_each_reverse(slice, io)                 \
  65         list_for_each_entry_reverse((slice), &io->ci_layers, cis_linkage)
  66
  67 static inline int cl_io_type_is_valid(enum cl_io_type type)
  68 {
  69         return CIT_READ <= type && type < CIT_OP_NR;
  70 }
  71
  72 static inline int cl_io_is_loopable(const struct cl_io *io)
  73 {
  74         return cl_io_type_is_valid(io->ci_type) && io->ci_type != CIT_MISC;
  75 }
  76
  77 /**
  78  * True, iff \a io is a sendfile().
  79  */
  80 int cl_io_is_sendfile(const struct cl_io *io)
  81 {
  82         return io->ci_type == CIT_READ && io->u.ci_rd.rd_is_sendfile;
  83 }
  84 EXPORT_SYMBOL(cl_io_is_sendfile);
  85
  86 /**
  87  * Returns true iff there is an IO ongoing in the given environment.
  88  */
  89 int cl_io_is_going(const struct lu_env *env)
  90 {
  91         return cl_env_info(env)->clt_current_io != NULL;
  92 }
  93 EXPORT_SYMBOL(cl_io_is_going);
  94
  95 /**
  96  * cl_io invariant that holds at all times when exported cl_io_*() functions
  97  * are entered and left.
  98  */
  99 static int cl_io_invariant(const struct cl_io *io)
 100 {
 101         struct cl_io *up;
 102
 103         up = io->ci_parent;
 104         return
 105                 /*
 106                  * io can own pages only when it is ongoing. Sub-io might
 107                  * still be in CIS_LOCKED state when top-io is in
 108                  * CIS_IO_GOING.
 109                  */
 110                 ergo(io->ci_owned_nr > 0, io->ci_state == CIS_IO_GOING ||
 111                      (io->ci_state == CIS_LOCKED && up != NULL));
 112 }
 113
 114 /**
 115  * Finalize \a io, by calling cl_io_operations::cio_fini() bottom-to-top.
 116  */
 117 void cl_io_fini(const struct lu_env *env, struct cl_io *io)
 118 {
 119         struct cl_io_slice    *slice;
 120         struct cl_thread_info *info;
 121
 122         LINVRNT(cl_io_type_is_valid(io->ci_type));
 123         LINVRNT(cl_io_invariant(io));
 124         ENTRY;
 125
 126         while (!list_empty(&io->ci_layers)) {
 127                 slice = container_of(io->ci_layers.next, struct cl_io_slice,
 128                                      cis_linkage);
 129                 list_del_init(&slice->cis_linkage);
 130                 if (slice->cis_iop->op[io->ci_type].cio_fini != NULL)
 131                         slice->cis_iop->op[io->ci_type].cio_fini(env, slice);
 132                 /*
 133                  * Invalidate slice to catch use after free. This assumes that
 134                  * slices are allocated within session and can be touched
 135                  * after ->cio_fini() returns.
 136                  */
 137                 slice->cis_io = NULL;
 138         }
 139         io->ci_state = CIS_FINI;
 140         info = cl_env_info(env);
 141         if (info->clt_current_io == io)
 142                 info->clt_current_io = NULL;
 143         EXIT;
 144 }
 145 EXPORT_SYMBOL(cl_io_fini);
 146
 147 static int cl_io_init0(const struct lu_env *env, struct cl_io *io,
 148                        enum cl_io_type iot, struct cl_object *obj)
 149 {
 150         struct cl_object *scan;
 151         int result;
 152
 153         LINVRNT(io->ci_state == CIS_ZERO || io->ci_state == CIS_FINI);
 154         LINVRNT(cl_io_type_is_valid(iot));
 155         LINVRNT(cl_io_invariant(io));
 156         ENTRY;
 157
 158         io->ci_type = iot;
 159         CFS_INIT_LIST_HEAD(&io->ci_lockset.cls_todo);
 160         CFS_INIT_LIST_HEAD(&io->ci_lockset.cls_curr);
 161         CFS_INIT_LIST_HEAD(&io->ci_lockset.cls_done);
 162         CFS_INIT_LIST_HEAD(&io->ci_layers);
 163
 164         result = 0;
 165         cl_object_for_each(scan, obj) {
 166                 if (scan->co_ops->coo_io_init != NULL) {
 167                         result = scan->co_ops->coo_io_init(env, scan, io);
 168                         if (result != 0)
 169                                 break;
 170                 }
 171         }
 172         if (result == 0)
 173                 io->ci_state = CIS_INIT;
 174         RETURN(result);
 175 }
 176
 177 /**
 178  * Initialize sub-io, by calling cl_io_operations::cio_init() top-to-bottom.
 179  *
 180  * \pre obj != cl_object_top(obj)
 181  */
 182 int cl_io_sub_init(const struct lu_env *env, struct cl_io *io,
 183                    enum cl_io_type iot, struct cl_object *obj)
 184 {
 185         struct cl_thread_info *info = cl_env_info(env);
 186
 187         LASSERT(obj != cl_object_top(obj));
 188         if (info->clt_current_io == NULL)
 189                 info->clt_current_io = io;
 190         return cl_io_init0(env, io, iot, obj);
 191 }
 192 EXPORT_SYMBOL(cl_io_sub_init);
 193
 194 /**
 195  * Initialize \a io, by calling cl_io_operations::cio_init() top-to-bottom.
 196  *
 197  * Caller has to call cl_io_fini() after a call to cl_io_init(), no matter
 198  * what the latter returned.
 199  *
 200  * \pre obj == cl_object_top(obj)
 201  * \pre cl_io_type_is_valid(iot)
 202  * \post cl_io_type_is_valid(io->ci_type) && io->ci_type == iot
 203  */
 204 int cl_io_init(const struct lu_env *env, struct cl_io *io,
 205                enum cl_io_type iot, struct cl_object *obj)
 206 {
 207         struct cl_thread_info *info = cl_env_info(env);
 208
 209         LASSERT(obj == cl_object_top(obj));
 210         LASSERT(info->clt_current_io == NULL);
 211
 212         info->clt_current_io = io;
 213         return cl_io_init0(env, io, iot, obj);
 214 }
 215 EXPORT_SYMBOL(cl_io_init);
 216
 217 /**
 218  * Initialize read or write io.
 219  *
 220  * \pre iot == CIT_READ || iot == CIT_WRITE
 221  */
 222 int cl_io_rw_init(const struct lu_env *env, struct cl_io *io,
 223                   enum cl_io_type iot, loff_t pos, size_t count)
 224 {
 225         LINVRNT(iot == CIT_READ || iot == CIT_WRITE);
 226         LINVRNT(io->ci_obj != NULL);
 227         ENTRY;
 228
 229         LU_OBJECT_HEADER(D_VFSTRACE, env, &io->ci_obj->co_lu,
 230                          "io range: %u ["LPU64", "LPU64") %u %u\n",
 231                          iot, (__u64)pos, (__u64)pos + count,
 232                          io->u.ci_rw.crw_nonblock, io->u.ci_wr.wr_append);
 233         io->u.ci_rw.crw_pos    = pos;
 234         io->u.ci_rw.crw_count  = count;
 235         RETURN(cl_io_init(env, io, iot, io->ci_obj));
 236 }
 237 EXPORT_SYMBOL(cl_io_rw_init);
 238
 239 static inline const struct lu_fid *
 240 cl_lock_descr_fid(const struct cl_lock_descr *descr)
 241 {
 242         return lu_object_fid(&descr->cld_obj->co_lu);
 243 }
 244
 245 static int cl_lock_descr_cmp(const struct cl_lock_descr *d0,
 246                              const struct cl_lock_descr *d1)
 247 {
 248         return lu_fid_cmp(cl_lock_descr_fid(d0), cl_lock_descr_fid(d1)) ?:
 249                 __diff_normalize(d0->cld_start, d1->cld_start);
 250 }
 251
 252 /*
 253  * Sort locks in lexicographical order of their (fid, start-offset) pairs.
 254  */
 255 static void cl_io_locks_sort(struct cl_io *io)
 256 {
 257         int done = 0;
 258
 259         ENTRY;
 260         /* hidden treasure: bubble sort for now. */
 261         do {
 262                 struct cl_io_lock_link *curr;
 263                 struct cl_io_lock_link *prev;
 264                 struct cl_io_lock_link *temp;
 265
 266                 done = 1;
 267                 prev = NULL;
 268
 269                 list_for_each_entry_safe(curr, temp, &io->ci_lockset.cls_todo,
 270                                          cill_linkage) {
 271                         if (prev != NULL) {
 272                                 switch (cl_lock_descr_cmp(&prev->cill_descr,
 273                                                           &curr->cill_descr)) {
 274                                 case 0:
 275                                         /*
 276                                          * IMPOSSIBLE: Identical locks are
 277                                          *             already removed at
 278                                          *             this point.
 279                                          */
 280                                 default:
 281                                         LBUG();
 282                                 case +1:
 283                                         list_move_tail(&curr->cill_linkage,
 284                                                        &prev->cill_linkage);
 285                                         done = 0;
 286                                         continue; /* don't change prev: it's
 287                                                    * still "previous" */
 288                                 case -1: /* already in order */
 289                                         break;
 290                                 }
 291                         }
 292                         prev = curr;
 293                 }
 294         } while (!done);
 295         EXIT;
 296 }
 297
 298 /**
 299  * Check whether \a queue contains locks matching \a need.
 300  *
 301  * \retval +ve there is a matching lock in the \a queue
 302  * \retval   0 there are no matching locks in the \a queue
 303  */
 304 int cl_queue_match(const struct list_head *queue,
 305                    const struct cl_lock_descr *need)
 306 {
 307        struct cl_io_lock_link *scan;
 308
 309        ENTRY;
 310        list_for_each_entry(scan, queue, cill_linkage) {
 311                if (cl_lock_descr_match(&scan->cill_descr, need))
 312                        RETURN(+1);
 313        }
 314        return 0;
 315 }
 316 EXPORT_SYMBOL(cl_queue_match);
 317
 318 static int cl_lockset_match(const struct cl_lockset *set,
 319                             const struct cl_lock_descr *need, int all_queues)
 320 {
 321         return (all_queues ? cl_queue_match(&set->cls_todo, need) : 0) ||
 322                 cl_queue_match(&set->cls_curr, need) ||
 323                 cl_queue_match(&set->cls_done, need);
 324 }
 325
 326 static int cl_lockset_lock_one(const struct lu_env *env,
 327                                struct cl_io *io, struct cl_lockset *set,
 328                                struct cl_io_lock_link *link)
 329 {
 330         struct cl_lock *lock;
 331         int             result;
 332
 333         ENTRY;
 334
 335         lock = cl_lock_request(env, io, &link->cill_descr, link->cill_enq_flags,
 336                                "io", io);
 337         if (!IS_ERR(lock)) {
 338                 link->cill_lock = lock;
 339                 list_move(&link->cill_linkage, &set->cls_curr);
 340                 if (!(link->cill_enq_flags & CEF_ASYNC)) {
 341                         result = cl_wait(env, lock);
 342                         if (result == 0)
 343                                 list_move(&link->cill_linkage, &set->cls_done);
 344                 } else
 345                         result = 0;
 346         } else
 347                 result = PTR_ERR(lock);
 348         RETURN(result);
 349 }
 350
 351 static void cl_lock_link_fini(const struct lu_env *env, struct cl_io *io,
 352                               struct cl_io_lock_link *link)
 353 {
 354         struct cl_lock *lock = link->cill_lock;
 355
 356         ENTRY;
 357         list_del_init(&link->cill_linkage);
 358         if (lock != NULL) {
 359                 cl_lock_release(env, lock, "io", io);
 360                 link->cill_lock = NULL;
 361         }
 362         if (link->cill_fini != NULL)
 363                 link->cill_fini(env, link);
 364         EXIT;
 365 }
 366
 367 static int cl_lockset_lock(const struct lu_env *env, struct cl_io *io,
 368                            struct cl_lockset *set)
 369 {
 370         struct cl_io_lock_link *link;
 371         struct cl_io_lock_link *temp;
 372         struct cl_lock         *lock;
 373         int result;
 374
 375         ENTRY;
 376         result = 0;
 377         list_for_each_entry_safe(link, temp, &set->cls_todo, cill_linkage) {
 378                 if (!cl_lockset_match(set, &link->cill_descr, 0)) {
 379                         /* XXX some locking to guarantee that locks aren't
 380                          * expanded in between. */
 381                         result = cl_lockset_lock_one(env, io, set, link);
 382                         if (result != 0)
 383                                 break;
 384                 } else
 385                         cl_lock_link_fini(env, io, link);
 386         }
 387         if (result == 0) {
 388                 list_for_each_entry_safe(link, temp,
 389                                          &set->cls_curr, cill_linkage) {
 390                         lock = link->cill_lock;
 391                         result = cl_wait(env, lock);
 392                         if (result == 0)
 393                                 list_move(&link->cill_linkage, &set->cls_done);
 394                         else
 395                                 break;
 396                 }
 397         }
 398         RETURN(result);
 399 }
 400
 401 /**
 402  * Takes locks necessary for the current iteration of io.
 403  *
 404  * Calls cl_io_operations::cio_lock() top-to-bottom to collect locks required
 405  * by layers for the current iteration. Then sort locks (to avoid dead-locks),
 406  * and acquire them.
 407  */
 408 int cl_io_lock(const struct lu_env *env, struct cl_io *io)
 409 {
 410         const struct cl_io_slice *scan;
 411         int result = 0;
 412
 413         LINVRNT(cl_io_is_loopable(io));
 414         LINVRNT(io->ci_state == CIS_IT_STARTED);
 415         LINVRNT(cl_io_invariant(io));
 416
 417         ENTRY;
 418         cl_io_for_each(scan, io) {
 419                 if (scan->cis_iop->op[io->ci_type].cio_lock == NULL)
 420                         continue;
 421                 result = scan->cis_iop->op[io->ci_type].cio_lock(env, scan);
 422                 if (result != 0)
 423                         break;
 424         }
 425         if (result == 0) {
 426                 cl_io_locks_sort(io);
 427                 result = cl_lockset_lock(env, io, &io->ci_lockset);
 428         }
 429         if (result != 0)
 430                 cl_io_unlock(env, io);
 431         else
 432                 io->ci_state = CIS_LOCKED;
 433         RETURN(result);
 434 }
 435 EXPORT_SYMBOL(cl_io_lock);
 436
 437 /**
 438  * Release locks takes by io.
 439  */
 440 void cl_io_unlock(const struct lu_env *env, struct cl_io *io)
 441 {
 442         struct cl_lockset        *set;
 443         struct cl_io_lock_link   *link;
 444         struct cl_io_lock_link   *temp;
 445         const struct cl_io_slice *scan;
 446
 447         LASSERT(cl_io_is_loopable(io));
 448         LASSERT(CIS_IT_STARTED <= io->ci_state && io->ci_state < CIS_UNLOCKED);
 449         LINVRNT(cl_io_invariant(io));
 450
 451         ENTRY;
 452         set = &io->ci_lockset;
 453
 454         list_for_each_entry_safe(link, temp, &set->cls_todo, cill_linkage)
 455                 cl_lock_link_fini(env, io, link);
 456
 457         list_for_each_entry_safe(link, temp, &set->cls_curr, cill_linkage)
 458                 cl_lock_link_fini(env, io, link);
 459
 460         list_for_each_entry_safe(link, temp, &set->cls_done, cill_linkage) {
 461                 cl_unuse(env, link->cill_lock);
 462                 cl_lock_link_fini(env, io, link);
 463         }
 464         cl_io_for_each_reverse(scan, io) {
 465                 if (scan->cis_iop->op[io->ci_type].cio_unlock != NULL)
 466                         scan->cis_iop->op[io->ci_type].cio_unlock(env, scan);
 467         }
 468         io->ci_state = CIS_UNLOCKED;
 469         LASSERT(!cl_env_info(env)->clt_counters[CNL_TOP].ctc_nr_locks_acquired);
 470         EXIT;
 471 }
 472 EXPORT_SYMBOL(cl_io_unlock);
 473
 474 /**
 475  * Prepares next iteration of io.
 476  *
 477  * Calls cl_io_operations::cio_iter_init() top-to-bottom. This exists to give
 478  * layers a chance to modify io parameters, e.g., so that lov can restrict io
 479  * to a single stripe.
 480  */
 481 int cl_io_iter_init(const struct lu_env *env, struct cl_io *io)
 482 {
 483         const struct cl_io_slice *scan;
 484         int result;
 485
 486         LINVRNT(cl_io_is_loopable(io));
 487         LINVRNT(io->ci_state == CIS_INIT || io->ci_state == CIS_IT_ENDED);
 488         LINVRNT(cl_io_invariant(io));
 489
 490         ENTRY;
 491         result = 0;
 492         cl_io_for_each(scan, io) {
 493                 if (scan->cis_iop->op[io->ci_type].cio_iter_init == NULL)
 494                         continue;
 495                 result = scan->cis_iop->op[io->ci_type].cio_iter_init(env,
 496                                                                       scan);
 497                 if (result != 0)
 498                         break;
 499         }
 500         if (result == 0)
 501                 io->ci_state = CIS_IT_STARTED;
 502         RETURN(result);
 503 }
 504 EXPORT_SYMBOL(cl_io_iter_init);
 505
 506 /**
 507  * Finalizes io iteration.
 508  *
 509  * Calls cl_io_operations::cio_iter_fini() bottom-to-top.
 510  */
 511 void cl_io_iter_fini(const struct lu_env *env, struct cl_io *io)
 512 {
 513         const struct cl_io_slice *scan;
 514
 515         LINVRNT(cl_io_is_loopable(io));
 516         LINVRNT(io->ci_state == CIS_UNLOCKED);
 517         LINVRNT(cl_io_invariant(io));
 518
 519         ENTRY;
 520         cl_io_for_each_reverse(scan, io) {
 521                 if (scan->cis_iop->op[io->ci_type].cio_iter_fini != NULL)
 522                         scan->cis_iop->op[io->ci_type].cio_iter_fini(env, scan);
 523         }
 524         io->ci_state = CIS_IT_ENDED;
 525         EXIT;
 526 }
 527 EXPORT_SYMBOL(cl_io_iter_fini);
 528
 529 /**
 530  * Records that read or write io progressed \a nob bytes forward.
 531  */
 532 void cl_io_rw_advance(const struct lu_env *env, struct cl_io *io, size_t nob)
 533 {
 534         const struct cl_io_slice *scan;
 535
 536         LINVRNT(io->ci_type == CIT_READ || io->ci_type == CIT_WRITE ||
 537                 nob == 0);
 538         LINVRNT(cl_io_is_loopable(io));
 539         LINVRNT(cl_io_invariant(io));
 540
 541         ENTRY;
 542
 543         io->u.ci_rw.crw_pos   += nob;
 544         io->u.ci_rw.crw_count -= nob;
 545
 546         /* layers have to be notified. */
 547         cl_io_for_each_reverse(scan, io) {
 548                 if (scan->cis_iop->op[io->ci_type].cio_advance != NULL)
 549                         scan->cis_iop->op[io->ci_type].cio_advance(env, scan,
 550                                                                    nob);
 551         }
 552         EXIT;
 553 }
 554 EXPORT_SYMBOL(cl_io_rw_advance);
 555
 556 /**
 557  * Adds a lock to a lockset.
 558  */
 559 int cl_io_lock_add(const struct lu_env *env, struct cl_io *io,
 560                    struct cl_io_lock_link *link)
 561 {
 562         int result;
 563
 564         ENTRY;
 565         if (cl_lockset_match(&io->ci_lockset, &link->cill_descr, 1))
 566                 result = +1;
 567         else {
 568                 list_add(&link->cill_linkage, &io->ci_lockset.cls_todo);
 569                 result = 0;
 570         }
 571         RETURN(result);
 572 }
 573 EXPORT_SYMBOL(cl_io_lock_add);
 574
 575 static void cl_free_io_lock_link(const struct lu_env *env,
 576                                  struct cl_io_lock_link *link)
 577 {
 578         OBD_FREE_PTR(link);
 579 }
 580
 581 /**
 582  * Allocates new lock link, and uses it to add a lock to a lockset.
 583  */
 584 int cl_io_lock_alloc_add(const struct lu_env *env, struct cl_io *io,
 585                          struct cl_lock_descr *descr, int enqflags)
 586 {
 587         struct cl_io_lock_link *link;
 588         int result;
 589
 590         ENTRY;
 591         OBD_ALLOC_PTR(link);
 592         if (link != NULL) {
 593                 link->cill_descr     = *descr;
 594                 link->cill_enq_flags = enqflags;
 595                 link->cill_fini      = cl_free_io_lock_link;
 596                 result = cl_io_lock_add(env, io, link);
 597                 if (result) /* lock match */
 598                         link->cill_fini(env, link);
 599         } else
 600                 result = -ENOMEM;
 601
 602         RETURN(result);
 603 }
 604 EXPORT_SYMBOL(cl_io_lock_alloc_add);
 605
 606 /**
 607  * Starts io by calling cl_io_operations::cio_start() top-to-bottom.
 608  */
 609 int cl_io_start(const struct lu_env *env, struct cl_io *io)
 610 {
 611         const struct cl_io_slice *scan;
 612         int result = 0;
 613
 614         LINVRNT(cl_io_is_loopable(io));
 615         LINVRNT(io->ci_state == CIS_LOCKED);
 616         LINVRNT(cl_io_invariant(io));
 617         ENTRY;
 618
 619         io->ci_state = CIS_IO_GOING;
 620         cl_io_for_each(scan, io) {
 621                 if (scan->cis_iop->op[io->ci_type].cio_start == NULL)
 622                         continue;
 623                 result = scan->cis_iop->op[io->ci_type].cio_start(env, scan);
 624                 if (result != 0)
 625                         break;
 626         }
 627         if (result >= 0)
 628                 result = 0;
 629         RETURN(result);
 630 }
 631 EXPORT_SYMBOL(cl_io_start);
 632
 633 /**
 634  * Wait until current io iteration is finished by calling
 635  * cl_io_operations::cio_end() bottom-to-top.
 636  */
 637 void cl_io_end(const struct lu_env *env, struct cl_io *io)
 638 {
 639         const struct cl_io_slice *scan;
 640
 641         LINVRNT(cl_io_is_loopable(io));
 642         LINVRNT(io->ci_state == CIS_IO_GOING);
 643         LINVRNT(cl_io_invariant(io));
 644         ENTRY;
 645
 646         cl_io_for_each_reverse(scan, io) {
 647                 if (scan->cis_iop->op[io->ci_type].cio_end != NULL)
 648                         scan->cis_iop->op[io->ci_type].cio_end(env, scan);
 649                 /* TODO: error handling. */
 650         }
 651         io->ci_state = CIS_IO_FINISHED;
 652         EXIT;
 653 }
 654 EXPORT_SYMBOL(cl_io_end);
 655
 656 static const struct cl_page_slice *
 657 cl_io_slice_page(const struct cl_io_slice *ios, struct cl_page *page)
 658 {
 659         const struct cl_page_slice *slice;
 660
 661         slice = cl_page_at(page, ios->cis_obj->co_lu.lo_dev->ld_type);
 662         LINVRNT(slice != NULL);
 663         return slice;
 664 }
 665
 666 /**
 667  * True iff \a page is within \a io range.
 668  */
 669 static int cl_page_in_io(const struct cl_page *page, const struct cl_io *io)
 670 {
 671         int     result;
 672         loff_t  start;
 673         loff_t  end;
 674         pgoff_t idx;
 675
 676         idx = page->cp_index;
 677         switch (io->ci_type) {
 678         case CIT_READ:
 679         case CIT_WRITE:
 680                 /*
 681                  * check that [start, end) and [pos, pos + count) extents
 682                  * overlap.
 683                  */
 684                 start = cl_offset(page->cp_obj, idx);
 685                 end   = cl_offset(page->cp_obj, idx + 1);
 686                 result = io->u.ci_rw.crw_pos < end &&
 687                         start < io->u.ci_rw.crw_pos + io->u.ci_rw.crw_count;
 688                 break;
 689         case CIT_FAULT:
 690                 result = io->u.ci_fault.ft_index == idx;
 691                 break;
 692         default:
 693                 LBUG();
 694         }
 695         return result;
 696 }
 697
 698 /**
 699  * Called by read io, when page has to be read from the server.
 700  *
 701  * \see cl_io_operations::cio_read_page()
 702  */
 703 int cl_io_read_page(const struct lu_env *env, struct cl_io *io,
 704                     struct cl_page *page)
 705 {
 706         const struct cl_io_slice *scan;
 707         struct cl_2queue         *queue;
 708         int                       result = 0;
 709
 710         LINVRNT(io->ci_type == CIT_READ || io->ci_type == CIT_FAULT);
 711         LINVRNT(cl_page_is_owned(page, io));
 712         LINVRNT(io->ci_state == CIS_IO_GOING || io->ci_state == CIS_LOCKED);
 713         LINVRNT(cl_page_in_io(page, io));
 714         LINVRNT(cl_io_invariant(io));
 715         ENTRY;
 716
 717         queue = &io->ci_queue;
 718
 719         cl_2queue_init(queue);
 720         /*
 721          * ->cio_read_page() methods called in the loop below are supposed to
 722          * never block waiting for network (the only subtle point is the
 723          * creation of new pages for read-ahead that might result in cache
 724          * shrinking, but currently only clean pages are shrunk and this
 725          * requires no network io).
 726          *
 727          * Should this ever starts blocking, retry loop would be needed for
 728          * "parallel io" (see CLO_REPEAT loops in cl_lock.c).
 729          */
 730         cl_io_for_each(scan, io) {
 731                 if (scan->cis_iop->cio_read_page != NULL) {
 732                         const struct cl_page_slice *slice;
 733
 734                         slice = cl_io_slice_page(scan, page);
 735                         LINVRNT(slice != NULL);
 736                         result = scan->cis_iop->cio_read_page(env, scan, slice);
 737                         if (result != 0)
 738                                 break;
 739                 }
 740         }
 741         if (result == 0)
 742                 result = cl_io_submit_rw(env, io, CRT_READ, queue, CRP_NORMAL);
 743         /*
 744          * Unlock unsent pages in case of error.
 745          */
 746         cl_page_list_disown(env, io, &queue->c2_qin);
 747         cl_2queue_fini(env, queue);
 748         RETURN(result);
 749 }
 750 EXPORT_SYMBOL(cl_io_read_page);
 751
 752 /**
 753  * Called by write io to prepare page to receive data from user buffer.
 754  *
 755  * \see cl_io_operations::cio_prepare_write()
 756  */
 757 int cl_io_prepare_write(const struct lu_env *env, struct cl_io *io,
 758                         struct cl_page *page, unsigned from, unsigned to)
 759 {
 760         const struct cl_io_slice *scan;
 761         int result = 0;
 762
 763         LINVRNT(io->ci_type == CIT_WRITE);
 764         LINVRNT(cl_page_is_owned(page, io));
 765         LINVRNT(io->ci_state == CIS_IO_GOING || io->ci_state == CIS_LOCKED);
 766         LINVRNT(cl_io_invariant(io));
 767         LASSERT(cl_page_in_io(page, io));
 768         ENTRY;
 769
 770         cl_io_for_each_reverse(scan, io) {
 771                 if (scan->cis_iop->cio_prepare_write != NULL) {
 772                         const struct cl_page_slice *slice;
 773
 774                         slice = cl_io_slice_page(scan, page);
 775                         result = scan->cis_iop->cio_prepare_write(env, scan,
 776                                                                   slice,
 777                                                                   from, to);
 778                         if (result != 0)
 779                                 break;
 780                 }
 781         }
 782         RETURN(result);
 783 }
 784 EXPORT_SYMBOL(cl_io_prepare_write);
 785
 786 /**
 787  * Called by write io after user data were copied into a page.
 788  *
 789  * \see cl_io_operations::cio_commit_write()
 790  */
 791 int cl_io_commit_write(const struct lu_env *env, struct cl_io *io,
 792                        struct cl_page *page, unsigned from, unsigned to)
 793 {
 794         const struct cl_io_slice *scan;
 795         int result = 0;
 796
 797         LINVRNT(io->ci_type == CIT_WRITE);
 798         LINVRNT(io->ci_state == CIS_IO_GOING || io->ci_state == CIS_LOCKED);
 799         LINVRNT(cl_io_invariant(io));
 800         /*
 801          * XXX Uh... not nice. Top level cl_io_commit_write() call (vvp->lov)
 802          * already called cl_page_cache_add(), moving page into CPS_CACHED
 803          * state. Better (and more general) way of dealing with such situation
 804          * is needed.
 805          */
 806         LASSERT(cl_page_is_owned(page, io) || page->cp_parent != NULL);
 807         LASSERT(cl_page_in_io(page, io));
 808         ENTRY;
 809
 810         cl_io_for_each(scan, io) {
 811                 if (scan->cis_iop->cio_commit_write != NULL) {
 812                         const struct cl_page_slice *slice;
 813
 814                         slice = cl_io_slice_page(scan, page);
 815                         result = scan->cis_iop->cio_commit_write(env, scan,
 816                                                                  slice,
 817                                                                  from, to);
 818                         if (result != 0)
 819                                 break;
 820                 }
 821         }
 822         LINVRNT(result <= 0);
 823         RETURN(result);
 824 }
 825 EXPORT_SYMBOL(cl_io_commit_write);
 826
 827 /**
 828  * Submits a list of pages for immediate io.
 829  *
 830  * After the function gets returned, The submitted pages are moved to
 831  * queue->c2_qout queue, and queue->c2_qin contain both the pages don't need
 832  * to be submitted, and the pages are errant to submit.
 833  *
 834  * \returns 0 if at least one page was submitted, error code otherwise.
 835  * \see cl_io_operations::cio_submit()
 836  */
 837 int cl_io_submit_rw(const struct lu_env *env, struct cl_io *io,
 838                     enum cl_req_type crt, struct cl_2queue *queue,
 839                     enum cl_req_priority priority)
 840 {
 841         const struct cl_io_slice *scan;
 842         int result = 0;
 843
 844         LINVRNT(crt < ARRAY_SIZE(scan->cis_iop->req_op));
 845         ENTRY;
 846
 847         cl_io_for_each(scan, io) {
 848                 if (scan->cis_iop->req_op[crt].cio_submit == NULL)
 849                         continue;
 850                 result = scan->cis_iop->req_op[crt].cio_submit(env, scan, crt,
 851                                                                queue, priority);
 852                 if (result != 0)
 853                         break;
 854         }
 855         /*
 856          * If ->cio_submit() failed, no pages were sent.
 857          */
 858         LASSERT(ergo(result != 0, list_empty(&queue->c2_qout.pl_pages)));
 859         RETURN(result);
 860 }
 861 EXPORT_SYMBOL(cl_io_submit_rw);
 862
 863 /**
 864  * Submit a sync_io and wait for the IO to be finished, or error happens.
 865  * If @timeout is zero, it means to wait for the IO unconditionally.
 866  */
 867 int cl_io_submit_sync(const struct lu_env *env, struct cl_io *io,
 868                       enum cl_req_type iot, struct cl_2queue *queue,
 869                       enum cl_req_priority prio, long timeout)
 870 {
 871         struct cl_sync_io *anchor = &cl_env_info(env)->clt_anchor;
 872         struct cl_page *pg;
 873         int rc;
 874
 875         LASSERT(prio == CRP_NORMAL || prio == CRP_CANCEL);
 876
 877         cl_page_list_for_each(pg, &queue->c2_qin) {
 878                 LASSERT(pg->cp_sync_io == NULL);
 879                 pg->cp_sync_io = anchor;
 880         }
 881
 882         cl_sync_io_init(anchor, queue->c2_qin.pl_nr);
 883         rc = cl_io_submit_rw(env, io, iot, queue, prio);
 884         if (rc == 0) {
 885                 /*
 886                  * If some pages weren't sent for any reason (e.g.,
 887                  * read found up-to-date pages in the cache, or write found
 888                  * clean pages), count them as completed to avoid infinite
 889                  * wait.
 890                  */
 891                  cl_page_list_for_each(pg, &queue->c2_qin) {
 892                         pg->cp_sync_io = NULL;
 893                         cl_sync_io_note(anchor, +1);
 894                  }
 895
 896                  /* wait for the IO to be finished. */
 897                  rc = cl_sync_io_wait(env, io, &queue->c2_qout,
 898                                       anchor, timeout);
 899         } else {
 900                 LASSERT(list_empty(&queue->c2_qout.pl_pages));
 901                 cl_page_list_for_each(pg, &queue->c2_qin)
 902                         pg->cp_sync_io = NULL;
 903         }
 904         return rc;
 905 }
 906 EXPORT_SYMBOL(cl_io_submit_sync);
 907
 908 /**
 909  * Cancel an IO which has been submitted by cl_io_submit_rw.
 910  */
 911 int cl_io_cancel(const struct lu_env *env, struct cl_io *io,
 912                  struct cl_page_list *queue)
 913 {
 914         struct cl_page *page;
 915         int result = 0;
 916
 917         CERROR("Canceling ongoing page trasmission\n");
 918         cl_page_list_for_each(page, queue) {
 919                 int rc;
 920
 921                 LINVRNT(cl_page_in_io(page, io));
 922                 rc = cl_page_cancel(env, page);
 923                 result = result ?: rc;
 924         }
 925         return result;
 926 }
 927 EXPORT_SYMBOL(cl_io_cancel);
 928
 929 /**
 930  * Main io loop.
 931  *
 932  * Pumps io through iterations calling
 933  *
 934  *    - cl_io_iter_init()
 935  *
 936  *    - cl_io_lock()
 937  *
 938  *    - cl_io_start()
 939  *
 940  *    - cl_io_end()
 941  *
 942  *    - cl_io_unlock()
 943  *
 944  *    - cl_io_iter_fini()
 945  *
 946  * repeatedly until there is no more io to do.
 947  */
 948 int cl_io_loop(const struct lu_env *env, struct cl_io *io)
 949 {
 950         int result   = 0;
 951
 952         LINVRNT(cl_io_is_loopable(io));
 953         ENTRY;
 954
 955         do {
 956                 size_t nob;
 957
 958                 io->ci_continue = 0;
 959                 result = cl_io_iter_init(env, io);
 960                 if (result == 0) {
 961                         nob    = io->ci_nob;
 962                         result = cl_io_lock(env, io);
 963                         if (result == 0) {
 964                                 /*
 965                                  * Notify layers that locks has been taken,
 966                                  * and do actual i/o.
 967                                  *
 968                                  *   - llite: kms, short read;
 969                                  *   - llite: generic_file_read();
 970                                  */
 971                                 result = cl_io_start(env, io);
 972                                 /*
 973                                  * Send any remaining pending
 974                                  * io, etc.
 975                                  *
 976                                  *   - llite: ll_rw_stats_tally.
 977                                  */
 978                                 cl_io_end(env, io);
 979                                 cl_io_unlock(env, io);
 980                                 cl_io_rw_advance(env, io, io->ci_nob - nob);
 981                         }
 982                 }
 983                 cl_io_iter_fini(env, io);
 984         } while (result == 0 && io->ci_continue);
 985         RETURN(result < 0 ? result : 0);
 986 }
 987 EXPORT_SYMBOL(cl_io_loop);
 988
 989 /**
 990  * Adds io slice to the cl_io.
 991  *
 992  * This is called by cl_object_operations::coo_io_init() methods to add a
 993  * per-layer state to the io. New state is added at the end of
 994  * cl_io::ci_layers list, that is, it is at the bottom of the stack.
 995  *
 996  * \see cl_lock_slice_add(), cl_req_slice_add(), cl_page_slice_add()
 997  */
 998 void cl_io_slice_add(struct cl_io *io, struct cl_io_slice *slice,
 999                      struct cl_object *obj,
1000                      const struct cl_io_operations *ops)
1001 {
1002         struct list_head *linkage = &slice->cis_linkage;
1003
1004         LASSERT((linkage->prev == NULL && linkage->next == NULL) ||
1005                 list_empty(linkage));
1006         ENTRY;
1007
1008         list_add_tail(linkage, &io->ci_layers);
1009         slice->cis_io  = io;
1010         slice->cis_obj = obj;
1011         slice->cis_iop = ops;
1012         EXIT;
1013 }
1014 EXPORT_SYMBOL(cl_io_slice_add);
1015
1016
1017 /**
1018  * Initializes page list.
1019  */
1020 void cl_page_list_init(struct cl_page_list *plist)
1021 {
1022         ENTRY;
1023         plist->pl_nr = 0;
1024         CFS_INIT_LIST_HEAD(&plist->pl_pages);
1025         plist->pl_owner = cfs_current();
1026         EXIT;
1027 }
1028 EXPORT_SYMBOL(cl_page_list_init);
1029
1030 /**
1031  * Adds a page to a page list.
1032  */
1033 void cl_page_list_add(struct cl_page_list *plist, struct cl_page *page)
1034 {
1035         ENTRY;
1036         /* it would be better to check that page is owned by "current" io, but
1037          * it is not passed here. */
1038         LASSERT(page->cp_owner != NULL);
1039         LINVRNT(plist->pl_owner == cfs_current());
1040
1041         lockdep_off();
1042         mutex_lock(&page->cp_mutex);
1043         lockdep_on();
1044         LASSERT(list_empty(&page->cp_batch));
1045         list_add_tail(&page->cp_batch, &plist->pl_pages);
1046         ++plist->pl_nr;
1047         page->cp_queue_ref = lu_ref_add(&page->cp_reference, "queue", plist);
1048         cl_page_get(page);
1049         EXIT;
1050 }
1051 EXPORT_SYMBOL(cl_page_list_add);
1052
1053 /**
1054  * Removes a page from a page list.
1055  */
1056 void cl_page_list_del(const struct lu_env *env,
1057                       struct cl_page_list *plist, struct cl_page *page)
1058 {
1059         LASSERT(plist->pl_nr > 0);
1060         LINVRNT(plist->pl_owner == cfs_current());
1061
1062         ENTRY;
1063         list_del_init(&page->cp_batch);
1064         lockdep_off();
1065         mutex_unlock(&page->cp_mutex);
1066         lockdep_on();
1067         --plist->pl_nr;
1068         lu_ref_del_at(&page->cp_reference, page->cp_queue_ref, "queue", plist);
1069         cl_page_put(env, page);
1070         EXIT;
1071 }
1072 EXPORT_SYMBOL(cl_page_list_del);
1073
1074 /**
1075  * Moves a page from one page list to another.
1076  */
1077 void cl_page_list_move(struct cl_page_list *dst, struct cl_page_list *src,
1078                        struct cl_page *page)
1079 {
1080         LASSERT(src->pl_nr > 0);
1081         LINVRNT(dst->pl_owner == cfs_current());
1082         LINVRNT(src->pl_owner == cfs_current());
1083
1084         ENTRY;
1085         list_move_tail(&page->cp_batch, &dst->pl_pages);
1086         --src->pl_nr;
1087         ++dst->pl_nr;
1088         lu_ref_set_at(&page->cp_reference,
1089                       page->cp_queue_ref, "queue", src, dst);
1090         EXIT;
1091 }
1092 EXPORT_SYMBOL(cl_page_list_move);
1093
1094 /**
1095  * splice the cl_page_list, just as list head does
1096  */
1097 void cl_page_list_splice(struct cl_page_list *list, struct cl_page_list *head)
1098 {
1099         struct cl_page *page;
1100         struct cl_page *tmp;
1101
1102         LINVRNT(list->pl_owner == cfs_current());
1103         LINVRNT(head->pl_owner == cfs_current());
1104
1105         ENTRY;
1106         cl_page_list_for_each_safe(page, tmp, list)
1107                 cl_page_list_move(head, list, page);
1108         EXIT;
1109 }
1110 EXPORT_SYMBOL(cl_page_list_splice);
1111
1112 void cl_page_disown0(const struct lu_env *env,
1113                      struct cl_io *io, struct cl_page *pg);
1114
1115 /**
1116  * Disowns pages in a queue.
1117  */
1118 void cl_page_list_disown(const struct lu_env *env,
1119                          struct cl_io *io, struct cl_page_list *plist)
1120 {
1121         struct cl_page *page;
1122         struct cl_page *temp;
1123
1124         LINVRNT(plist->pl_owner == cfs_current());
1125
1126         ENTRY;
1127         cl_page_list_for_each_safe(page, temp, plist) {
1128                 LASSERT(plist->pl_nr > 0);
1129
1130                 list_del_init(&page->cp_batch);
1131                 lockdep_off();
1132                 mutex_unlock(&page->cp_mutex);
1133                 lockdep_on();
1134                 --plist->pl_nr;
1135                 /*
1136                  * cl_page_disown0 rather than usual cl_page_disown() is used,
1137                  * because pages are possibly in CPS_FREEING state already due
1138                  * to the call to cl_page_list_discard().
1139                  */
1140                 /*
1141                  * XXX cl_page_disown0() will fail if page is not locked.
1142                  */
1143                 cl_page_disown0(env, io, page);
1144                 lu_ref_del(&page->cp_reference, "queue", plist);
1145                 cl_page_put(env, page);
1146         }
1147         EXIT;
1148 }
1149 EXPORT_SYMBOL(cl_page_list_disown);
1150
1151 /**
1152  * Releases pages from queue.
1153  */
1154 void cl_page_list_fini(const struct lu_env *env, struct cl_page_list *plist)
1155 {
1156         struct cl_page *page;
1157         struct cl_page *temp;
1158
1159         LINVRNT(plist->pl_owner == cfs_current());
1160
1161         ENTRY;
1162         cl_page_list_for_each_safe(page, temp, plist)
1163                 cl_page_list_del(env, plist, page);
1164         LASSERT(plist->pl_nr == 0);
1165         EXIT;
1166 }
1167 EXPORT_SYMBOL(cl_page_list_fini);
1168
1169 /**
1170  * Owns all pages in a queue.
1171  */
1172 int cl_page_list_own(const struct lu_env *env,
1173                      struct cl_io *io, struct cl_page_list *plist)
1174 {
1175         struct cl_page *page;
1176         struct cl_page *temp;
1177         pgoff_t index = 0;
1178         int result;
1179
1180         LINVRNT(plist->pl_owner == cfs_current());
1181
1182         ENTRY;
1183         result = 0;
1184         cl_page_list_for_each_safe(page, temp, plist) {
1185                 LASSERT(index <= page->cp_index);
1186                 index = page->cp_index;
1187                 if (cl_page_own(env, io, page) == 0)
1188                         result = result ?: page->cp_error;
1189                 else
1190                         cl_page_list_del(env, plist, page);
1191         }
1192         RETURN(result);
1193 }
1194 EXPORT_SYMBOL(cl_page_list_own);
1195
1196 /**
1197  * Assumes all pages in a queue.
1198  */
1199 void cl_page_list_assume(const struct lu_env *env,
1200                          struct cl_io *io, struct cl_page_list *plist)
1201 {
1202         struct cl_page *page;
1203
1204         LINVRNT(plist->pl_owner == cfs_current());
1205
1206         cl_page_list_for_each(page, plist)
1207                 cl_page_assume(env, io, page);
1208 }
1209 EXPORT_SYMBOL(cl_page_list_assume);
1210
1211 /**
1212  * Discards all pages in a queue.
1213  */
1214 void cl_page_list_discard(const struct lu_env *env, struct cl_io *io,
1215                           struct cl_page_list *plist)
1216 {
1217         struct cl_page *page;
1218
1219         LINVRNT(plist->pl_owner == cfs_current());
1220         ENTRY;
1221         cl_page_list_for_each(page, plist)
1222                 cl_page_discard(env, io, page);
1223         EXIT;
1224 }
1225 EXPORT_SYMBOL(cl_page_list_discard);
1226
1227 /**
1228  * Unmaps all pages in a queue from user virtual memory.
1229  */
1230 int cl_page_list_unmap(const struct lu_env *env, struct cl_io *io,
1231                         struct cl_page_list *plist)
1232 {
1233         struct cl_page *page;
1234         int result;
1235
1236         LINVRNT(plist->pl_owner == cfs_current());
1237         ENTRY;
1238         result = 0;
1239         cl_page_list_for_each(page, plist) {
1240                 result = cl_page_unmap(env, io, page);
1241                 if (result != 0)
1242                         break;
1243         }
1244         RETURN(result);
1245 }
1246 EXPORT_SYMBOL(cl_page_list_unmap);
1247
1248 /**
1249  * Initialize dual page queue.
1250  */
1251 void cl_2queue_init(struct cl_2queue *queue)
1252 {
1253         ENTRY;
1254         cl_page_list_init(&queue->c2_qin);
1255         cl_page_list_init(&queue->c2_qout);
1256         EXIT;
1257 }
1258 EXPORT_SYMBOL(cl_2queue_init);
1259
1260 /**
1261  * Add a page to the incoming page list of 2-queue.
1262  */
1263 void cl_2queue_add(struct cl_2queue *queue, struct cl_page *page)
1264 {
1265         ENTRY;
1266         cl_page_list_add(&queue->c2_qin, page);
1267         EXIT;
1268 }
1269 EXPORT_SYMBOL(cl_2queue_add);
1270
1271 /**
1272  * Disown pages in both lists of a 2-queue.
1273  */
1274 void cl_2queue_disown(const struct lu_env *env,
1275                       struct cl_io *io, struct cl_2queue *queue)
1276 {
1277         ENTRY;
1278         cl_page_list_disown(env, io, &queue->c2_qin);
1279         cl_page_list_disown(env, io, &queue->c2_qout);
1280         EXIT;
1281 }
1282 EXPORT_SYMBOL(cl_2queue_disown);
1283
1284 /**
1285  * Discard (truncate) pages in both lists of a 2-queue.
1286  */
1287 void cl_2queue_discard(const struct lu_env *env,
1288                        struct cl_io *io, struct cl_2queue *queue)
1289 {
1290         ENTRY;
1291         cl_page_list_discard(env, io, &queue->c2_qin);
1292         cl_page_list_discard(env, io, &queue->c2_qout);
1293         EXIT;
1294 }
1295 EXPORT_SYMBOL(cl_2queue_discard);
1296
1297 /**
1298  * Assume to own the pages in cl_2queue
1299  */
1300 void cl_2queue_assume(const struct lu_env *env,
1301                       struct cl_io *io, struct cl_2queue *queue)
1302 {
1303         cl_page_list_assume(env, io, &queue->c2_qin);
1304         cl_page_list_assume(env, io, &queue->c2_qout);
1305 }
1306 EXPORT_SYMBOL(cl_2queue_assume);
1307
1308 /**
1309  * Finalize both page lists of a 2-queue.
1310  */
1311 void cl_2queue_fini(const struct lu_env *env, struct cl_2queue *queue)
1312 {
1313         ENTRY;
1314         cl_page_list_fini(env, &queue->c2_qout);
1315         cl_page_list_fini(env, &queue->c2_qin);
1316         EXIT;
1317 }
1318 EXPORT_SYMBOL(cl_2queue_fini);
1319
1320 /**
1321  * Initialize a 2-queue to contain \a page in its incoming page list.
1322  */
1323 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page)
1324 {
1325         ENTRY;
1326         cl_2queue_init(queue);
1327         cl_2queue_add(queue, page);
1328         EXIT;
1329 }
1330 EXPORT_SYMBOL(cl_2queue_init_page);
1331
1332 /**
1333  * Returns top-level io.
1334  *
1335  * \see cl_object_top(), cl_page_top().
1336  */
1337 struct cl_io *cl_io_top(struct cl_io *io)
1338 {
1339         ENTRY;
1340         while (io->ci_parent != NULL)
1341                 io = io->ci_parent;
1342         RETURN(io);
1343 }
1344 EXPORT_SYMBOL(cl_io_top);
1345
1346 /**
1347  * Prints human readable representation of \a io to the \a f.
1348  */
1349 void cl_io_print(const struct lu_env *env, void *cookie,
1350                  lu_printer_t printer, const struct cl_io *io)
1351 {
1352 }
1353
1354 /**
1355  * Adds request slice to the compound request.
1356  *
1357  * This is called by cl_device_operations::cdo_req_init() methods to add a
1358  * per-layer state to the request. New state is added at the end of
1359  * cl_req::crq_layers list, that is, it is at the bottom of the stack.
1360  *
1361  * \see cl_lock_slice_add(), cl_page_slice_add(), cl_io_slice_add()
1362  */
1363 void cl_req_slice_add(struct cl_req *req, struct cl_req_slice *slice,
1364                       struct cl_device *dev,
1365                       const struct cl_req_operations *ops)
1366 {
1367         ENTRY;
1368         list_add_tail(&slice->crs_linkage, &req->crq_layers);
1369         slice->crs_dev = dev;
1370         slice->crs_ops = ops;
1371         slice->crs_req = req;
1372         EXIT;
1373 }
1374 EXPORT_SYMBOL(cl_req_slice_add);
1375
1376 static void cl_req_free(const struct lu_env *env, struct cl_req *req)
1377 {
1378         unsigned i;
1379
1380         LASSERT(list_empty(&req->crq_pages));
1381         LASSERT(req->crq_nrpages == 0);
1382         LINVRNT(list_empty(&req->crq_layers));
1383         LINVRNT(equi(req->crq_nrobjs > 0, req->crq_o != NULL));
1384         ENTRY;
1385
1386         if (req->crq_o != NULL) {
1387                 for (i = 0; i < req->crq_nrobjs; ++i) {
1388                         struct cl_object *obj = req->crq_o[i].ro_obj;
1389                         if (obj != NULL) {
1390                                 lu_object_ref_del_at(&obj->co_lu,
1391                                                      req->crq_o[i].ro_obj_ref,
1392                                                      "cl_req", req);
1393                                 cl_object_put(env, obj);
1394                         }
1395                 }
1396                 OBD_FREE(req->crq_o, req->crq_nrobjs * sizeof req->crq_o[0]);
1397         }
1398         OBD_FREE_PTR(req);
1399         EXIT;
1400 }
1401
1402 static int cl_req_init(const struct lu_env *env, struct cl_req *req,
1403                        struct cl_page *page)
1404 {
1405         struct cl_device     *dev;
1406         struct cl_page_slice *slice;
1407         int result;
1408
1409         ENTRY;
1410         result = 0;
1411         page = cl_page_top(page);
1412         do {
1413                 list_for_each_entry(slice, &page->cp_layers, cpl_linkage) {
1414                         dev = lu2cl_dev(slice->cpl_obj->co_lu.lo_dev);
1415                         if (dev->cd_ops->cdo_req_init != NULL) {
1416                                 result = dev->cd_ops->cdo_req_init(env,
1417                                                                    dev, req);
1418                                 if (result != 0)
1419                                         break;
1420                         }
1421                 }
1422                 page = page->cp_child;
1423         } while (page != NULL && result == 0);
1424         RETURN(result);
1425 }
1426
1427 /**
1428  * Invokes per-request transfer completion call-backs
1429  * (cl_req_operations::cro_completion()) bottom-to-top.
1430  */
1431 void cl_req_completion(const struct lu_env *env, struct cl_req *req, int rc)
1432 {
1433         struct cl_req_slice *slice;
1434
1435         ENTRY;
1436         /*
1437          * for the lack of list_for_each_entry_reverse_safe()...
1438          */
1439         while (!list_empty(&req->crq_layers)) {
1440                 slice = list_entry(req->crq_layers.prev,
1441                                    struct cl_req_slice, crs_linkage);
1442                 list_del_init(&slice->crs_linkage);
1443                 if (slice->crs_ops->cro_completion != NULL)
1444                         slice->crs_ops->cro_completion(env, slice, rc);
1445         }
1446         cl_req_free(env, req);
1447         EXIT;
1448 }
1449 EXPORT_SYMBOL(cl_req_completion);
1450
1451 /**
1452  * Allocates new transfer request.
1453  */
1454 struct cl_req *cl_req_alloc(const struct lu_env *env, struct cl_page *page,
1455                             enum cl_req_type crt, int nr_objects)
1456 {
1457         struct cl_req *req;
1458
1459         LINVRNT(nr_objects > 0);
1460         ENTRY;
1461
1462         OBD_ALLOC_PTR(req);
1463         if (req != NULL) {
1464                 int result;
1465
1466                 OBD_ALLOC(req->crq_o, nr_objects * sizeof req->crq_o[0]);
1467                 if (req->crq_o != NULL) {
1468                         req->crq_nrobjs = nr_objects;
1469                         req->crq_type = crt;
1470                         CFS_INIT_LIST_HEAD(&req->crq_pages);
1471                         CFS_INIT_LIST_HEAD(&req->crq_layers);
1472                         result = cl_req_init(env, req, page);
1473                 } else
1474                         result = -ENOMEM;
1475                 if (result != 0) {
1476                         cl_req_completion(env, req, result);
1477                         req = ERR_PTR(result);
1478                 }
1479         } else
1480                 req = ERR_PTR(-ENOMEM);
1481         RETURN(req);
1482 }
1483 EXPORT_SYMBOL(cl_req_alloc);
1484
1485 /**
1486  * Adds a page to a request.
1487  */
1488 void cl_req_page_add(const struct lu_env *env,
1489                      struct cl_req *req, struct cl_page *page)
1490 {
1491         struct cl_object  *obj;
1492         struct cl_req_obj *rqo;
1493         int i;
1494
1495         ENTRY;
1496         page = cl_page_top(page);
1497
1498         LINVRNT(cl_page_is_vmlocked(env, page));
1499         LASSERT(list_empty(&page->cp_flight));
1500         LASSERT(page->cp_req == NULL);
1501
1502         list_add_tail(&page->cp_flight, &req->crq_pages);
1503         ++req->crq_nrpages;
1504         page->cp_req = req;
1505         obj = cl_object_top(page->cp_obj);
1506         for (i = 0, rqo = req->crq_o; obj != rqo->ro_obj; ++i, ++rqo) {
1507                 if (rqo->ro_obj == NULL) {
1508                         rqo->ro_obj = obj;
1509                         cl_object_get(obj);
1510                         rqo->ro_obj_ref = lu_object_ref_add(&obj->co_lu,
1511                                                             "cl_req", req);
1512                         break;
1513                 }
1514         }
1515         LASSERT(i < req->crq_nrobjs);
1516         EXIT;
1517 }
1518 EXPORT_SYMBOL(cl_req_page_add);
1519
1520 /**
1521  * Removes a page from a request.
1522  */
1523 void cl_req_page_done(const struct lu_env *env, struct cl_page *page)
1524 {
1525         struct cl_req *req = page->cp_req;
1526
1527         ENTRY;
1528         page = cl_page_top(page);
1529
1530         LINVRNT(cl_page_is_vmlocked(env, page));
1531         LASSERT(!list_empty(&page->cp_flight));
1532         LASSERT(req->crq_nrpages > 0);
1533
1534         list_del_init(&page->cp_flight);
1535         --req->crq_nrpages;
1536         page->cp_req = NULL;
1537         EXIT;
1538 }
1539 EXPORT_SYMBOL(cl_req_page_done);
1540
1541 /**
1542  * Notifies layers that request is about to depart by calling
1543  * cl_req_operations::cro_prep() top-to-bottom.
1544  */
1545 int cl_req_prep(const struct lu_env *env, struct cl_req *req)
1546 {
1547         int i;
1548         int result;
1549         const struct cl_req_slice *slice;
1550
1551         ENTRY;
1552         /*
1553          * Check that the caller of cl_req_alloc() didn't lie about the number
1554          * of objects.
1555          */
1556         for (i = 0; i < req->crq_nrobjs; ++i)
1557                 LASSERT(req->crq_o[i].ro_obj != NULL);
1558
1559         result = 0;
1560         list_for_each_entry(slice, &req->crq_layers, crs_linkage) {
1561                 if (slice->crs_ops->cro_prep != NULL) {
1562                         result = slice->crs_ops->cro_prep(env, slice);
1563                         if (result != 0)
1564                                 break;
1565                 }
1566         }
1567         RETURN(result);
1568 }
1569 EXPORT_SYMBOL(cl_req_prep);
1570
1571 /**
1572  * Fills in attributes that are passed to server together with transfer. Only
1573  * attributes from \a flags may be touched. This can be called multiple times
1574  * for the same request.
1575  */
1576 void cl_req_attr_set(const struct lu_env *env, struct cl_req *req,
1577                      struct cl_req_attr *attr, obd_valid flags)
1578 {
1579         const struct cl_req_slice *slice;
1580         struct cl_page            *page;
1581         int i;
1582
1583         LASSERT(!list_empty(&req->crq_pages));
1584         ENTRY;
1585
1586         /* Take any page to use as a model. */
1587         page = list_entry(req->crq_pages.next, struct cl_page, cp_flight);
1588
1589         for (i = 0; i < req->crq_nrobjs; ++i) {
1590                 list_for_each_entry(slice, &req->crq_layers, crs_linkage) {
1591                         const struct cl_page_slice *scan;
1592                         const struct cl_object     *obj;
1593
1594                         scan = cl_page_at(page,
1595                                           slice->crs_dev->cd_lu_dev.ld_type);
1596                         LASSERT(scan != NULL);
1597                         obj = scan->cpl_obj;
1598                         if (slice->crs_ops->cro_attr_set != NULL)
1599                                 slice->crs_ops->cro_attr_set(env, slice, obj,
1600                                                              attr + i, flags);
1601                 }
1602         }
1603         EXIT;
1604 }
1605 EXPORT_SYMBOL(cl_req_attr_set);
1606
1607 /* XXX complete(), init_completion(), and wait_for_completion(), until they are
1608  * implemented in libcfs. */
1609 #ifdef __KERNEL__
1610 # include <linux/sched.h>
1611 #else /* __KERNEL__ */
1612 # include <liblustre.h>
1613 #endif
1614
1615 /**
1616  * Initialize synchronous io wait anchor, for transfer of \a nrpages pages.
1617  */
1618 void cl_sync_io_init(struct cl_sync_io *anchor, int nrpages)
1619 {
1620         ENTRY;
1621         cfs_waitq_init(&anchor->csi_waitq);
1622         atomic_set(&anchor->csi_sync_nr, nrpages);
1623         anchor->csi_sync_rc  = 0;
1624         EXIT;
1625 }
1626 EXPORT_SYMBOL(cl_sync_io_init);
1627
1628 /**
1629  * Wait until all transfer completes. Transfer completion routine has to call
1630  * cl_sync_io_note() for every page.
1631  */
1632 int cl_sync_io_wait(const struct lu_env *env, struct cl_io *io,
1633                     struct cl_page_list *queue, struct cl_sync_io *anchor,
1634                     long timeout)
1635 {
1636         struct l_wait_info lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(timeout),
1637                                                   NULL, NULL, NULL);
1638         int rc;
1639         ENTRY;
1640
1641         LASSERT(timeout >= 0);
1642
1643         rc = l_wait_event(anchor->csi_waitq,
1644                           atomic_read(&anchor->csi_sync_nr) == 0,
1645                           &lwi);
1646         if (rc < 0) {
1647                 int rc2;
1648
1649                 CERROR("SYNC IO failed with error: %d, try to cancel "
1650                        "the remaining page\n", rc);
1651
1652                 rc2 = cl_io_cancel(env, io, queue);
1653                 if (rc2 < 0) {
1654                         lwi = (struct l_wait_info) { 0 };
1655                         /* Too bad, some pages are still in IO. */
1656                         CERROR("Failed to cancel transfer error: %d, mostly "
1657                                "because of they are still being transferred, "
1658                                "waiting for %i pages\n",
1659                                rc2, atomic_read(&anchor->csi_sync_nr));
1660                         (void)l_wait_event(anchor->csi_waitq,
1661                                      atomic_read(&anchor->csi_sync_nr) == 0,
1662                                      &lwi);
1663                 }
1664         } else {
1665                 rc = anchor->csi_sync_rc;
1666         }
1667         LASSERT(atomic_read(&anchor->csi_sync_nr) == 0);
1668         cl_page_list_assume(env, io, queue);
1669         POISON(anchor, 0x5a, sizeof *anchor);
1670         RETURN(rc);
1671 }
1672 EXPORT_SYMBOL(cl_sync_io_wait);
1673
1674 /**
1675  * Indicate that transfer of a single page completed.
1676  */
1677 void cl_sync_io_note(struct cl_sync_io *anchor, int ioret)
1678 {
1679         ENTRY;
1680         if (anchor->csi_sync_rc == 0 && ioret < 0)
1681                 anchor->csi_sync_rc = ioret;
1682         /*
1683          * Synchronous IO done without releasing page lock (e.g., as a part of
1684          * ->{prepare,commit}_write(). Completion is used to signal the end of
1685          * IO.
1686          */
1687         if (atomic_dec_and_test(&anchor->csi_sync_nr))
1688                 cfs_waitq_broadcast(&anchor->csi_waitq);
1689         EXIT;
1690 }
1691 EXPORT_SYMBOL(cl_sync_io_note);