lustre/obdclass/cl_io.c

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