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