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         lockdep_off();
1015         mutex_lock(&page->cp_mutex);
1016         lockdep_on();
1017         LASSERT(cfs_list_empty(&page->cp_batch));
1018         cfs_list_add_tail(&page->cp_batch, &plist->pl_pages);
1019         ++plist->pl_nr;
1020         lu_ref_add_at(&page->cp_reference, &page->cp_queue_ref, "queue", plist);
1021         cl_page_get(page);
1022         EXIT;
1023 }
1024 EXPORT_SYMBOL(cl_page_list_add);
1025
1026 /**
1027  * Removes a page from a page list.
1028  */
1029 void cl_page_list_del(const struct lu_env *env,
1030                       struct cl_page_list *plist, struct cl_page *page)
1031 {
1032         LASSERT(plist->pl_nr > 0);
1033         LINVRNT(plist->pl_owner == current);
1034
1035         ENTRY;
1036         cfs_list_del_init(&page->cp_batch);
1037         lockdep_off();
1038         mutex_unlock(&page->cp_mutex);
1039         lockdep_on();
1040         --plist->pl_nr;
1041         lu_ref_del_at(&page->cp_reference, &page->cp_queue_ref, "queue", plist);
1042         cl_page_put(env, page);
1043         EXIT;
1044 }
1045 EXPORT_SYMBOL(cl_page_list_del);
1046
1047 /**
1048  * Moves a page from one page list to another.
1049  */
1050 void cl_page_list_move(struct cl_page_list *dst, struct cl_page_list *src,
1051                        struct cl_page *page)
1052 {
1053         LASSERT(src->pl_nr > 0);
1054         LINVRNT(dst->pl_owner == current);
1055         LINVRNT(src->pl_owner == current);
1056
1057         ENTRY;
1058         cfs_list_move_tail(&page->cp_batch, &dst->pl_pages);
1059         --src->pl_nr;
1060         ++dst->pl_nr;
1061         lu_ref_set_at(&page->cp_reference, &page->cp_queue_ref, "queue",
1062                       src, dst);
1063         EXIT;
1064 }
1065 EXPORT_SYMBOL(cl_page_list_move);
1066
1067 /**
1068  * Moves a page from one page list to the head of another list.
1069  */
1070 void cl_page_list_move_head(struct cl_page_list *dst, struct cl_page_list *src,
1071                             struct cl_page *page)
1072 {
1073         LASSERT(src->pl_nr > 0);
1074         LINVRNT(dst->pl_owner == current);
1075         LINVRNT(src->pl_owner == current);
1076
1077         ENTRY;
1078         cfs_list_move(&page->cp_batch, &dst->pl_pages);
1079         --src->pl_nr;
1080         ++dst->pl_nr;
1081         lu_ref_set_at(&page->cp_reference, &page->cp_queue_ref, "queue",
1082                         src, dst);
1083         EXIT;
1084 }
1085 EXPORT_SYMBOL(cl_page_list_move_head);
1086
1087 /**
1088  * splice the cl_page_list, just as list head does
1089  */
1090 void cl_page_list_splice(struct cl_page_list *list, struct cl_page_list *head)
1091 {
1092         struct cl_page *page;
1093         struct cl_page *tmp;
1094
1095         LINVRNT(list->pl_owner == current);
1096         LINVRNT(head->pl_owner == current);
1097
1098         ENTRY;
1099         cl_page_list_for_each_safe(page, tmp, list)
1100                 cl_page_list_move(head, list, page);
1101         EXIT;
1102 }
1103 EXPORT_SYMBOL(cl_page_list_splice);
1104
1105 void cl_page_disown0(const struct lu_env *env,
1106                      struct cl_io *io, struct cl_page *pg);
1107
1108 /**
1109  * Disowns pages in a queue.
1110  */
1111 void cl_page_list_disown(const struct lu_env *env,
1112                          struct cl_io *io, struct cl_page_list *plist)
1113 {
1114         struct cl_page *page;
1115         struct cl_page *temp;
1116
1117         LINVRNT(plist->pl_owner == current);
1118
1119         ENTRY;
1120         cl_page_list_for_each_safe(page, temp, plist) {
1121                 LASSERT(plist->pl_nr > 0);
1122
1123                 cfs_list_del_init(&page->cp_batch);
1124                 lockdep_off();
1125                 mutex_unlock(&page->cp_mutex);
1126                 lockdep_on();
1127                 --plist->pl_nr;
1128                 /*
1129                  * cl_page_disown0 rather than usual cl_page_disown() is used,
1130                  * because pages are possibly in CPS_FREEING state already due
1131                  * to the call to cl_page_list_discard().
1132                  */
1133                 /*
1134                  * XXX cl_page_disown0() will fail if page is not locked.
1135                  */
1136                 cl_page_disown0(env, io, page);
1137                 lu_ref_del_at(&page->cp_reference, &page->cp_queue_ref, "queue",
1138                               plist);
1139                 cl_page_put(env, page);
1140         }
1141         EXIT;
1142 }
1143 EXPORT_SYMBOL(cl_page_list_disown);
1144
1145 /**
1146  * Releases pages from queue.
1147  */
1148 void cl_page_list_fini(const struct lu_env *env, struct cl_page_list *plist)
1149 {
1150         struct cl_page *page;
1151         struct cl_page *temp;
1152
1153         LINVRNT(plist->pl_owner == current);
1154
1155         ENTRY;
1156         cl_page_list_for_each_safe(page, temp, plist)
1157                 cl_page_list_del(env, plist, page);
1158         LASSERT(plist->pl_nr == 0);
1159         EXIT;
1160 }
1161 EXPORT_SYMBOL(cl_page_list_fini);
1162
1163 /**
1164  * Owns all pages in a queue.
1165  */
1166 int cl_page_list_own(const struct lu_env *env,
1167                      struct cl_io *io, struct cl_page_list *plist)
1168 {
1169         struct cl_page *page;
1170         struct cl_page *temp;
1171         int result;
1172
1173         LINVRNT(plist->pl_owner == current);
1174
1175         ENTRY;
1176         result = 0;
1177         cl_page_list_for_each_safe(page, temp, plist) {
1178                 if (cl_page_own(env, io, page) == 0)
1179                         result = result ?: page->cp_error;
1180                 else
1181                         cl_page_list_del(env, plist, page);
1182         }
1183         RETURN(result);
1184 }
1185 EXPORT_SYMBOL(cl_page_list_own);
1186
1187 /**
1188  * Assumes all pages in a queue.
1189  */
1190 void cl_page_list_assume(const struct lu_env *env,
1191                          struct cl_io *io, struct cl_page_list *plist)
1192 {
1193         struct cl_page *page;
1194
1195         LINVRNT(plist->pl_owner == current);
1196
1197         cl_page_list_for_each(page, plist)
1198                 cl_page_assume(env, io, page);
1199 }
1200 EXPORT_SYMBOL(cl_page_list_assume);
1201
1202 /**
1203  * Discards all pages in a queue.
1204  */
1205 void cl_page_list_discard(const struct lu_env *env, struct cl_io *io,
1206                           struct cl_page_list *plist)
1207 {
1208         struct cl_page *page;
1209
1210         LINVRNT(plist->pl_owner == current);
1211         ENTRY;
1212         cl_page_list_for_each(page, plist)
1213                 cl_page_discard(env, io, page);
1214         EXIT;
1215 }
1216 EXPORT_SYMBOL(cl_page_list_discard);
1217
1218 /**
1219  * Initialize dual page queue.
1220  */
1221 void cl_2queue_init(struct cl_2queue *queue)
1222 {
1223         ENTRY;
1224         cl_page_list_init(&queue->c2_qin);
1225         cl_page_list_init(&queue->c2_qout);
1226         EXIT;
1227 }
1228 EXPORT_SYMBOL(cl_2queue_init);
1229
1230 /**
1231  * Add a page to the incoming page list of 2-queue.
1232  */
1233 void cl_2queue_add(struct cl_2queue *queue, struct cl_page *page)
1234 {
1235         ENTRY;
1236         cl_page_list_add(&queue->c2_qin, page);
1237         EXIT;
1238 }
1239 EXPORT_SYMBOL(cl_2queue_add);
1240
1241 /**
1242  * Disown pages in both lists of a 2-queue.
1243  */
1244 void cl_2queue_disown(const struct lu_env *env,
1245                       struct cl_io *io, struct cl_2queue *queue)
1246 {
1247         ENTRY;
1248         cl_page_list_disown(env, io, &queue->c2_qin);
1249         cl_page_list_disown(env, io, &queue->c2_qout);
1250         EXIT;
1251 }
1252 EXPORT_SYMBOL(cl_2queue_disown);
1253
1254 /**
1255  * Discard (truncate) pages in both lists of a 2-queue.
1256  */
1257 void cl_2queue_discard(const struct lu_env *env,
1258                        struct cl_io *io, struct cl_2queue *queue)
1259 {
1260         ENTRY;
1261         cl_page_list_discard(env, io, &queue->c2_qin);
1262         cl_page_list_discard(env, io, &queue->c2_qout);
1263         EXIT;
1264 }
1265 EXPORT_SYMBOL(cl_2queue_discard);
1266
1267 /**
1268  * Assume to own the pages in cl_2queue
1269  */
1270 void cl_2queue_assume(const struct lu_env *env,
1271                       struct cl_io *io, struct cl_2queue *queue)
1272 {
1273         cl_page_list_assume(env, io, &queue->c2_qin);
1274         cl_page_list_assume(env, io, &queue->c2_qout);
1275 }
1276 EXPORT_SYMBOL(cl_2queue_assume);
1277
1278 /**
1279  * Finalize both page lists of a 2-queue.
1280  */
1281 void cl_2queue_fini(const struct lu_env *env, struct cl_2queue *queue)
1282 {
1283         ENTRY;
1284         cl_page_list_fini(env, &queue->c2_qout);
1285         cl_page_list_fini(env, &queue->c2_qin);
1286         EXIT;
1287 }
1288 EXPORT_SYMBOL(cl_2queue_fini);
1289
1290 /**
1291  * Initialize a 2-queue to contain \a page in its incoming page list.
1292  */
1293 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page)
1294 {
1295         ENTRY;
1296         cl_2queue_init(queue);
1297         cl_2queue_add(queue, page);
1298         EXIT;
1299 }
1300 EXPORT_SYMBOL(cl_2queue_init_page);
1301
1302 /**
1303  * Returns top-level io.
1304  *
1305  * \see cl_object_top()
1306  */
1307 struct cl_io *cl_io_top(struct cl_io *io)
1308 {
1309         ENTRY;
1310         while (io->ci_parent != NULL)
1311                 io = io->ci_parent;
1312         RETURN(io);
1313 }
1314 EXPORT_SYMBOL(cl_io_top);
1315
1316 /**
1317  * Prints human readable representation of \a io to the \a f.
1318  */
1319 void cl_io_print(const struct lu_env *env, void *cookie,
1320                  lu_printer_t printer, const struct cl_io *io)
1321 {
1322 }
1323
1324 /**
1325  * Adds request slice to the compound request.
1326  *
1327  * This is called by cl_device_operations::cdo_req_init() methods to add a
1328  * per-layer state to the request. New state is added at the end of
1329  * cl_req::crq_layers list, that is, it is at the bottom of the stack.
1330  *
1331  * \see cl_lock_slice_add(), cl_page_slice_add(), cl_io_slice_add()
1332  */
1333 void cl_req_slice_add(struct cl_req *req, struct cl_req_slice *slice,
1334                       struct cl_device *dev,
1335                       const struct cl_req_operations *ops)
1336 {
1337         ENTRY;
1338         cfs_list_add_tail(&slice->crs_linkage, &req->crq_layers);
1339         slice->crs_dev = dev;
1340         slice->crs_ops = ops;
1341         slice->crs_req = req;
1342         EXIT;
1343 }
1344 EXPORT_SYMBOL(cl_req_slice_add);
1345
1346 static void cl_req_free(const struct lu_env *env, struct cl_req *req)
1347 {
1348         unsigned i;
1349
1350         LASSERT(cfs_list_empty(&req->crq_pages));
1351         LASSERT(req->crq_nrpages == 0);
1352         LINVRNT(cfs_list_empty(&req->crq_layers));
1353         LINVRNT(equi(req->crq_nrobjs > 0, req->crq_o != NULL));
1354         ENTRY;
1355
1356         if (req->crq_o != NULL) {
1357                 for (i = 0; i < req->crq_nrobjs; ++i) {
1358                         struct cl_object *obj = req->crq_o[i].ro_obj;
1359                         if (obj != NULL) {
1360                                 lu_object_ref_del_at(&obj->co_lu,
1361                                                      &req->crq_o[i].ro_obj_ref,
1362                                                      "cl_req", req);
1363                                 cl_object_put(env, obj);
1364                         }
1365                 }
1366                 OBD_FREE(req->crq_o, req->crq_nrobjs * sizeof req->crq_o[0]);
1367         }
1368         OBD_FREE_PTR(req);
1369         EXIT;
1370 }
1371
1372 static int cl_req_init(const struct lu_env *env, struct cl_req *req,
1373                        struct cl_page *page)
1374 {
1375         struct cl_device     *dev;
1376         struct cl_page_slice *slice;
1377         int result;
1378
1379         ENTRY;
1380         result = 0;
1381         cfs_list_for_each_entry(slice, &page->cp_layers, cpl_linkage) {
1382                 dev = lu2cl_dev(slice->cpl_obj->co_lu.lo_dev);
1383                 if (dev->cd_ops->cdo_req_init != NULL) {
1384                         result = dev->cd_ops->cdo_req_init(env,
1385                                         dev, req);
1386                         if (result != 0)
1387                                 break;
1388                 }
1389         }
1390         RETURN(result);
1391 }
1392
1393 /**
1394  * Invokes per-request transfer completion call-backs
1395  * (cl_req_operations::cro_completion()) bottom-to-top.
1396  */
1397 void cl_req_completion(const struct lu_env *env, struct cl_req *req, int rc)
1398 {
1399         struct cl_req_slice *slice;
1400
1401         ENTRY;
1402         /*
1403          * for the lack of list_for_each_entry_reverse_safe()...
1404          */
1405         while (!cfs_list_empty(&req->crq_layers)) {
1406                 slice = cfs_list_entry(req->crq_layers.prev,
1407                                        struct cl_req_slice, crs_linkage);
1408                 cfs_list_del_init(&slice->crs_linkage);
1409                 if (slice->crs_ops->cro_completion != NULL)
1410                         slice->crs_ops->cro_completion(env, slice, rc);
1411         }
1412         cl_req_free(env, req);
1413         EXIT;
1414 }
1415 EXPORT_SYMBOL(cl_req_completion);
1416
1417 /**
1418  * Allocates new transfer request.
1419  */
1420 struct cl_req *cl_req_alloc(const struct lu_env *env, struct cl_page *page,
1421                             enum cl_req_type crt, int nr_objects)
1422 {
1423         struct cl_req *req;
1424
1425         LINVRNT(nr_objects > 0);
1426         ENTRY;
1427
1428         OBD_ALLOC_PTR(req);
1429         if (req != NULL) {
1430                 int result;
1431
1432                 OBD_ALLOC(req->crq_o, nr_objects * sizeof req->crq_o[0]);
1433                 if (req->crq_o != NULL) {
1434                         req->crq_nrobjs = nr_objects;
1435                         req->crq_type = crt;
1436                         CFS_INIT_LIST_HEAD(&req->crq_pages);
1437                         CFS_INIT_LIST_HEAD(&req->crq_layers);
1438                         result = cl_req_init(env, req, page);
1439                 } else
1440                         result = -ENOMEM;
1441                 if (result != 0) {
1442                         cl_req_completion(env, req, result);
1443                         req = ERR_PTR(result);
1444                 }
1445         } else
1446                 req = ERR_PTR(-ENOMEM);
1447         RETURN(req);
1448 }
1449 EXPORT_SYMBOL(cl_req_alloc);
1450
1451 /**
1452  * Adds a page to a request.
1453  */
1454 void cl_req_page_add(const struct lu_env *env,
1455                      struct cl_req *req, struct cl_page *page)
1456 {
1457         struct cl_object  *obj;
1458         struct cl_req_obj *rqo;
1459         int i;
1460
1461         ENTRY;
1462
1463         LASSERT(cfs_list_empty(&page->cp_flight));
1464         LASSERT(page->cp_req == NULL);
1465
1466         CL_PAGE_DEBUG(D_PAGE, env, page, "req %p, %d, %u\n",
1467                       req, req->crq_type, req->crq_nrpages);
1468
1469         cfs_list_add_tail(&page->cp_flight, &req->crq_pages);
1470         ++req->crq_nrpages;
1471         page->cp_req = req;
1472         obj = cl_object_top(page->cp_obj);
1473         for (i = 0, rqo = req->crq_o; obj != rqo->ro_obj; ++i, ++rqo) {
1474                 if (rqo->ro_obj == NULL) {
1475                         rqo->ro_obj = obj;
1476                         cl_object_get(obj);
1477                         lu_object_ref_add_at(&obj->co_lu, &rqo->ro_obj_ref,
1478                                              "cl_req", req);
1479                         break;
1480                 }
1481         }
1482         LASSERT(i < req->crq_nrobjs);
1483         EXIT;
1484 }
1485 EXPORT_SYMBOL(cl_req_page_add);
1486
1487 /**
1488  * Removes a page from a request.
1489  */
1490 void cl_req_page_done(const struct lu_env *env, struct cl_page *page)
1491 {
1492         struct cl_req *req = page->cp_req;
1493
1494         ENTRY;
1495
1496         LASSERT(!cfs_list_empty(&page->cp_flight));
1497         LASSERT(req->crq_nrpages > 0);
1498
1499         cfs_list_del_init(&page->cp_flight);
1500         --req->crq_nrpages;
1501         page->cp_req = NULL;
1502         EXIT;
1503 }
1504 EXPORT_SYMBOL(cl_req_page_done);
1505
1506 /**
1507  * Notifies layers that request is about to depart by calling
1508  * cl_req_operations::cro_prep() top-to-bottom.
1509  */
1510 int cl_req_prep(const struct lu_env *env, struct cl_req *req)
1511 {
1512         int i;
1513         int result;
1514         const struct cl_req_slice *slice;
1515
1516         ENTRY;
1517         /*
1518          * Check that the caller of cl_req_alloc() didn't lie about the number
1519          * of objects.
1520          */
1521         for (i = 0; i < req->crq_nrobjs; ++i)
1522                 LASSERT(req->crq_o[i].ro_obj != NULL);
1523
1524         result = 0;
1525         cfs_list_for_each_entry(slice, &req->crq_layers, crs_linkage) {
1526                 if (slice->crs_ops->cro_prep != NULL) {
1527                         result = slice->crs_ops->cro_prep(env, slice);
1528                         if (result != 0)
1529                                 break;
1530                 }
1531         }
1532         RETURN(result);
1533 }
1534 EXPORT_SYMBOL(cl_req_prep);
1535
1536 /**
1537  * Fills in attributes that are passed to server together with transfer. Only
1538  * attributes from \a flags may be touched. This can be called multiple times
1539  * for the same request.
1540  */
1541 void cl_req_attr_set(const struct lu_env *env, struct cl_req *req,
1542                      struct cl_req_attr *attr, obd_valid flags)
1543 {
1544         const struct cl_req_slice *slice;
1545         struct cl_page            *page;
1546         int i;
1547
1548         LASSERT(!cfs_list_empty(&req->crq_pages));
1549         ENTRY;
1550
1551         /* Take any page to use as a model. */
1552         page = cfs_list_entry(req->crq_pages.next, struct cl_page, cp_flight);
1553
1554         for (i = 0; i < req->crq_nrobjs; ++i) {
1555                 cfs_list_for_each_entry(slice, &req->crq_layers, crs_linkage) {
1556                         const struct cl_page_slice *scan;
1557                         const struct cl_object     *obj;
1558
1559                         scan = cl_page_at(page,
1560                                           slice->crs_dev->cd_lu_dev.ld_type);
1561                         LASSERT(scan != NULL);
1562                         obj = scan->cpl_obj;
1563                         if (slice->crs_ops->cro_attr_set != NULL)
1564                                 slice->crs_ops->cro_attr_set(env, slice, obj,
1565                                                              attr + i, flags);
1566                 }
1567         }
1568         EXIT;
1569 }
1570 EXPORT_SYMBOL(cl_req_attr_set);
1571
1572 /* XXX complete(), init_completion(), and wait_for_completion(), until they are
1573  * implemented in libcfs. */
1574 #ifdef __KERNEL__
1575 # include <linux/sched.h>
1576 #else /* __KERNEL__ */
1577 # include <liblustre.h>
1578 #endif
1579
1580 /**
1581  * Initialize synchronous io wait anchor, for transfer of \a nrpages pages.
1582  */
1583 void cl_sync_io_init(struct cl_sync_io *anchor, int nrpages)
1584 {
1585         ENTRY;
1586         init_waitqueue_head(&anchor->csi_waitq);
1587         atomic_set(&anchor->csi_sync_nr, nrpages);
1588         atomic_set(&anchor->csi_barrier, nrpages > 0);
1589         anchor->csi_sync_rc = 0;
1590         EXIT;
1591 }
1592 EXPORT_SYMBOL(cl_sync_io_init);
1593
1594 /**
1595  * Wait until all transfer completes. Transfer completion routine has to call
1596  * cl_sync_io_note() for every page.
1597  */
1598 int cl_sync_io_wait(const struct lu_env *env, struct cl_io *io,
1599                     struct cl_page_list *queue, struct cl_sync_io *anchor,
1600                     long timeout)
1601 {
1602         struct l_wait_info lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(timeout),
1603                                                   NULL, NULL, NULL);
1604         int rc;
1605         ENTRY;
1606
1607         LASSERT(timeout >= 0);
1608
1609         rc = l_wait_event(anchor->csi_waitq,
1610                           atomic_read(&anchor->csi_sync_nr) == 0,
1611                           &lwi);
1612         if (rc < 0) {
1613                 CERROR("SYNC IO failed with error: %d, try to cancel "
1614                        "%d remaining pages\n",
1615                        rc, atomic_read(&anchor->csi_sync_nr));
1616
1617                 (void)cl_io_cancel(env, io, queue);
1618
1619                 lwi = (struct l_wait_info) { 0 };
1620                 (void)l_wait_event(anchor->csi_waitq,
1621                                    atomic_read(&anchor->csi_sync_nr) == 0,
1622                                    &lwi);
1623         } else {
1624                 rc = anchor->csi_sync_rc;
1625         }
1626         LASSERT(atomic_read(&anchor->csi_sync_nr) == 0);
1627         cl_page_list_assume(env, io, queue);
1628
1629         /* wait until cl_sync_io_note() has done wakeup */
1630         while (unlikely(atomic_read(&anchor->csi_barrier) != 0)) {
1631 #ifdef __KERNEL__
1632                 cpu_relax();
1633 #endif
1634         }
1635
1636         POISON(anchor, 0x5a, sizeof *anchor);
1637         RETURN(rc);
1638 }
1639 EXPORT_SYMBOL(cl_sync_io_wait);
1640
1641 /**
1642  * Indicate that transfer of a single page completed.
1643  */
1644 void cl_sync_io_note(struct cl_sync_io *anchor, int ioret)
1645 {
1646         ENTRY;
1647         if (anchor->csi_sync_rc == 0 && ioret < 0)
1648                 anchor->csi_sync_rc = ioret;
1649         /*
1650          * Synchronous IO done without releasing page lock (e.g., as a part of
1651          * ->{prepare,commit}_write(). Completion is used to signal the end of
1652          * IO.
1653          */
1654         LASSERT(atomic_read(&anchor->csi_sync_nr) > 0);
1655         if (atomic_dec_and_test(&anchor->csi_sync_nr)) {
1656                 wake_up_all(&anchor->csi_waitq);
1657                 /* it's safe to nuke or reuse anchor now */
1658                 atomic_set(&anchor->csi_barrier, 0);
1659         }
1660         EXIT;
1661 }
1662 EXPORT_SYMBOL(cl_sync_io_note);