lustre/obdclass/cl_io.c

   1 // SPDX-License-Identifier: GPL-2.0
   2
   3 /*
   4  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
   5  * Use is subject to license terms.
   6  *
   7  * Copyright (c) 2011, 2017, Intel Corporation.
   8  *
   9  */
  10
  11 /*
  12  * This file is part of Lustre, http://www.lustre.org/
  13  *
  14  * Client IO.
  15  *
  16  * Author: Nikita Danilov <nikita.danilov@sun.com>
  17  * Author: Jinshan Xiong <jinshan.xiong@intel.com>
  18  *
  19  */
  20
  21 #define DEBUG_SUBSYSTEM S_CLASS
  22
  23 #include <linux/sched.h>
  24 #include <linux/list.h>
  25 #include <linux/list_sort.h>
  26 #include <linux/mmu_context.h>
  27 #include <obd_class.h>
  28 #include <obd_support.h>
  29 #include <lustre_fid.h>
  30 #include <cl_object.h>
  31 #include "cl_internal.h"
  32
  33 /*
  34  * cl_io interface.
  35  */
  36
  37 static inline int cl_io_type_is_valid(enum cl_io_type type)
  38 {
  39         return CIT_READ <= type && type < CIT_OP_NR;
  40 }
  41
  42 static inline int cl_io_is_loopable(const struct cl_io *io)
  43 {
  44         return cl_io_type_is_valid(io->ci_type) && io->ci_type != CIT_MISC;
  45 }
  46
  47 /**
  48  * cl_io invariant that holds at all times when exported cl_io_*() functions
  49  * are entered and left.
  50  */
  51 static inline int cl_io_invariant(const struct cl_io *io)
  52 {
  53         /*
  54          * io can own pages only when it is ongoing. Sub-io might
  55          * still be in CIS_LOCKED state when top-io is in
  56          * CIS_IO_GOING.
  57          */
  58         return ergo(io->ci_owned_nr > 0, io->ci_state == CIS_IO_GOING ||
  59                     (io->ci_state == CIS_LOCKED && io->ci_parent != NULL));
  60 }
  61
  62 /**
  63  * Finalize \a io, by calling cl_io_operations::cio_fini() bottom-to-top.
  64  */
  65 void cl_io_fini(const struct lu_env *env, struct cl_io *io)
  66 {
  67         struct cl_io_slice    *slice;
  68
  69         LINVRNT(cl_io_type_is_valid(io->ci_type));
  70         LINVRNT(cl_io_invariant(io));
  71         ENTRY;
  72
  73         while (!list_empty(&io->ci_layers)) {
  74                 slice = container_of(io->ci_layers.prev, struct cl_io_slice,
  75                                      cis_linkage);
  76                 list_del_init(&slice->cis_linkage);
  77                 if (slice->cis_iop->op[io->ci_type].cio_fini != NULL)
  78                         slice->cis_iop->op[io->ci_type].cio_fini(env, slice);
  79                 /*
  80                  * Invalidate slice to catch use after free. This assumes that
  81                  * slices are allocated within session and can be touched
  82                  * after ->cio_fini() returns.
  83                  */
  84                 slice->cis_io = NULL;
  85         }
  86         io->ci_state = CIS_FINI;
  87
  88         /* sanity check for layout change */
  89         switch(io->ci_type) {
  90         case CIT_READ:
  91         case CIT_WRITE:
  92         case CIT_DATA_VERSION:
  93         case CIT_FAULT:
  94                 break;
  95         case CIT_FSYNC:
  96                 LASSERT(!io->ci_need_restart);
  97                 break;
  98         case CIT_SETATTR:
  99         case CIT_MISC:
 100                 /* Check ignore layout change conf */
 101                 LASSERT(ergo(io->ci_ignore_layout || !io->ci_verify_layout,
 102                                 !io->ci_need_restart));
 103         case CIT_GLIMPSE:
 104                 break;
 105         case CIT_LADVISE:
 106         case CIT_LSEEK:
 107                 break;
 108         default:
 109                 LBUG();
 110         }
 111         EXIT;
 112 }
 113 EXPORT_SYMBOL(cl_io_fini);
 114
 115 static int __cl_io_init(const struct lu_env *env, struct cl_io *io,
 116                         enum cl_io_type iot, struct cl_object *obj)
 117 {
 118         struct cl_object *scan;
 119         int result;
 120
 121         LINVRNT(io->ci_state == CIS_ZERO || io->ci_state == CIS_FINI);
 122         LINVRNT(cl_io_type_is_valid(iot));
 123         LINVRNT(cl_io_invariant(io));
 124         ENTRY;
 125
 126         io->ci_type = iot;
 127         INIT_LIST_HEAD(&io->ci_lockset.cls_todo);
 128         INIT_LIST_HEAD(&io->ci_lockset.cls_done);
 129         INIT_LIST_HEAD(&io->ci_layers);
 130
 131         result = 0;
 132         cl_object_for_each(scan, obj) {
 133                 if (scan->co_ops->coo_io_init != NULL) {
 134                         result = scan->co_ops->coo_io_init(env, scan, io);
 135                         if (result != 0)
 136                                 break;
 137                 }
 138         }
 139         if (result == 0)
 140                 io->ci_state = CIS_INIT;
 141         RETURN(result);
 142 }
 143
 144 /**
 145  * Initialize sub-io, by calling cl_io_operations::cio_init() top-to-bottom.
 146  *
 147  * \pre obj != cl_object_top(obj)
 148  */
 149 int cl_io_sub_init(const struct lu_env *env, struct cl_io *io,
 150                    enum cl_io_type iot, struct cl_object *obj)
 151 {
 152         LASSERT(obj != cl_object_top(obj));
 153
 154         return __cl_io_init(env, io, iot, obj);
 155 }
 156 EXPORT_SYMBOL(cl_io_sub_init);
 157
 158 /**
 159  * Initialize \a io, by calling cl_io_operations::cio_init() top-to-bottom.
 160  *
 161  * Caller has to call cl_io_fini() after a call to cl_io_init(), no matter
 162  * what the latter returned.
 163  *
 164  * \pre obj == cl_object_top(obj)
 165  * \pre cl_io_type_is_valid(iot)
 166  * \post cl_io_type_is_valid(io->ci_type) && io->ci_type == iot
 167  */
 168 int cl_io_init(const struct lu_env *env, struct cl_io *io,
 169                enum cl_io_type iot, struct cl_object *obj)
 170 {
 171         LASSERT(obj == cl_object_top(obj));
 172
 173         /* clear I/O restart from previous instance */
 174         io->ci_need_restart = 0;
 175
 176         return __cl_io_init(env, io, iot, obj);
 177 }
 178 EXPORT_SYMBOL(cl_io_init);
 179
 180 /**
 181  * Initialize read or write io.
 182  *
 183  * \pre iot == CIT_READ || iot == CIT_WRITE
 184  */
 185 int cl_io_rw_init(const struct lu_env *env, struct cl_io *io,
 186                   enum cl_io_type iot, loff_t pos, size_t bytes)
 187 {
 188         LINVRNT(iot == CIT_READ || iot == CIT_WRITE);
 189         LINVRNT(io->ci_obj != NULL);
 190         ENTRY;
 191
 192         LU_OBJECT_HEADER(D_VFSTRACE, env, &io->ci_obj->co_lu,
 193                          "io range: %u [%llu, %llu) %u %u\n",
 194                          iot, (__u64)pos, (__u64)pos + bytes,
 195                          io->u.ci_rw.crw_nonblock, io->u.ci_wr.wr_append);
 196         io->u.ci_rw.crw_pos    = pos;
 197         io->u.ci_rw.crw_bytes  = bytes;
 198         RETURN(cl_io_init(env, io, iot, io->ci_obj));
 199 }
 200 EXPORT_SYMBOL(cl_io_rw_init);
 201
 202 #ifdef HAVE_LIST_CMP_FUNC_T
 203 static int cl_lock_descr_cmp(void *priv,
 204                              const struct list_head *a,
 205                              const struct list_head *b)
 206 #else /* !HAVE_LIST_CMP_FUNC_T */
 207 static int cl_lock_descr_cmp(void *priv,
 208                              struct list_head *a, struct list_head *b)
 209 #endif /* HAVE_LIST_CMP_FUNC_T */
 210 {
 211         const struct cl_io_lock_link *l0 = list_entry(a, struct cl_io_lock_link,
 212                                                       cill_linkage);
 213         const struct cl_io_lock_link *l1 = list_entry(b, struct cl_io_lock_link,
 214                                                       cill_linkage);
 215         const struct cl_lock_descr *d0 = &l0->cill_descr;
 216         const struct cl_lock_descr *d1 = &l1->cill_descr;
 217
 218         return lu_fid_cmp(lu_object_fid(&d0->cld_obj->co_lu),
 219                           lu_object_fid(&d1->cld_obj->co_lu));
 220 }
 221
 222 static void cl_lock_descr_merge(struct cl_lock_descr *d0,
 223                                 const struct cl_lock_descr *d1)
 224 {
 225         d0->cld_start = min(d0->cld_start, d1->cld_start);
 226         d0->cld_end = max(d0->cld_end, d1->cld_end);
 227
 228         if (d1->cld_mode == CLM_WRITE && d0->cld_mode != CLM_WRITE)
 229                 d0->cld_mode = CLM_WRITE;
 230
 231         if (d1->cld_mode == CLM_GROUP && d0->cld_mode != CLM_GROUP)
 232                 d0->cld_mode = CLM_GROUP;
 233 }
 234
 235 static int cl_lockset_merge(const struct cl_lockset *set,
 236                             const struct cl_lock_descr *need)
 237 {
 238         struct cl_io_lock_link *scan;
 239
 240         ENTRY;
 241         list_for_each_entry(scan, &set->cls_todo, cill_linkage) {
 242                 if (!cl_object_same(scan->cill_descr.cld_obj, need->cld_obj))
 243                         continue;
 244
 245                 /* Merge locks for the same object because ldlm lock server
 246                  * may expand the lock extent, otherwise there is a deadlock
 247                  * case if two conflicted locks are queueud for the same object
 248                  * and lock server expands one lock to overlap the another.
 249                  * The side effect is that it can generate a multi-stripe lock
 250                  * that may cause casacading problem */
 251                 cl_lock_descr_merge(&scan->cill_descr, need);
 252                 CDEBUG(D_VFSTRACE, "lock: %d: [%lu, %lu]\n",
 253                        scan->cill_descr.cld_mode, scan->cill_descr.cld_start,
 254                        scan->cill_descr.cld_end);
 255                 RETURN(+1);
 256         }
 257         RETURN(0);
 258 }
 259
 260 static int cl_lockset_lock(const struct lu_env *env, struct cl_io *io,
 261                            struct cl_lockset *set)
 262 {
 263         struct cl_io_lock_link *link;
 264         struct cl_io_lock_link *temp;
 265         int result;
 266
 267         ENTRY;
 268         result = 0;
 269         list_for_each_entry_safe(link, temp, &set->cls_todo, cill_linkage) {
 270                 result = cl_lock_request(env, io, &link->cill_lock);
 271                 if (result < 0)
 272                         break;
 273
 274                 list_move(&link->cill_linkage, &set->cls_done);
 275         }
 276         RETURN(result);
 277 }
 278
 279 /**
 280  * Takes locks necessary for the current iteration of io.
 281  *
 282  * Calls cl_io_operations::cio_lock() top-to-bottom to collect locks required
 283  * by layers for the current iteration. Then sort locks (to avoid dead-locks),
 284  * and acquire them.
 285  */
 286 int cl_io_lock(const struct lu_env *env, struct cl_io *io)
 287 {
 288         const struct cl_io_slice *scan;
 289         int result = 0;
 290
 291         LINVRNT(cl_io_is_loopable(io));
 292         LINVRNT(io->ci_state == CIS_IT_STARTED);
 293         LINVRNT(cl_io_invariant(io));
 294
 295         ENTRY;
 296         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
 297                 if (scan->cis_iop->op[io->ci_type].cio_lock == NULL)
 298                         continue;
 299                 result = scan->cis_iop->op[io->ci_type].cio_lock(env, scan);
 300                 if (result != 0)
 301                         break;
 302         }
 303         if (result == 0) {
 304                 /*
 305                  * Sort locks in lexicographical order of their (fid,
 306                  * start-offset) pairs to avoid deadlocks.
 307                  */
 308                 list_sort(NULL, &io->ci_lockset.cls_todo, cl_lock_descr_cmp);
 309                 result = cl_lockset_lock(env, io, &io->ci_lockset);
 310         }
 311         if (result != 0)
 312                 cl_io_unlock(env, io);
 313         else
 314                 io->ci_state = CIS_LOCKED;
 315         RETURN(result);
 316 }
 317 EXPORT_SYMBOL(cl_io_lock);
 318
 319 /**
 320  * Release locks takes by io.
 321  */
 322 void cl_io_unlock(const struct lu_env *env, struct cl_io *io)
 323 {
 324         struct cl_lockset *set;
 325         struct cl_io_lock_link *link;
 326         struct cl_io_lock_link *temp;
 327         const struct cl_io_slice *scan;
 328
 329         LASSERT(cl_io_is_loopable(io));
 330         LASSERT(CIS_IT_STARTED <= io->ci_state && io->ci_state < CIS_UNLOCKED);
 331         LINVRNT(cl_io_invariant(io));
 332
 333         ENTRY;
 334         set = &io->ci_lockset;
 335
 336         list_for_each_entry_safe(link, temp, &set->cls_todo, cill_linkage) {
 337                 list_del_init(&link->cill_linkage);
 338                 if (link->cill_fini != NULL)
 339                         link->cill_fini(env, link);
 340         }
 341
 342         list_for_each_entry_safe(link, temp, &set->cls_done, cill_linkage) {
 343                 list_del_init(&link->cill_linkage);
 344                 cl_lock_release(env, &link->cill_lock);
 345                 if (link->cill_fini != NULL)
 346                         link->cill_fini(env, link);
 347         }
 348
 349         list_for_each_entry_reverse(scan, &io->ci_layers, cis_linkage) {
 350                 if (scan->cis_iop->op[io->ci_type].cio_unlock != NULL)
 351                         scan->cis_iop->op[io->ci_type].cio_unlock(env, scan);
 352         }
 353         io->ci_state = CIS_UNLOCKED;
 354         EXIT;
 355 }
 356 EXPORT_SYMBOL(cl_io_unlock);
 357
 358 /**
 359  * Prepares next iteration of io.
 360  *
 361  * Calls cl_io_operations::cio_iter_init() top-to-bottom. This exists to give
 362  * layers a chance to modify io parameters, e.g., so that lov can restrict io
 363  * to a single stripe.
 364  */
 365 int cl_io_iter_init(const struct lu_env *env, struct cl_io *io)
 366 {
 367         const struct cl_io_slice *scan;
 368         int result;
 369
 370         LINVRNT(cl_io_is_loopable(io));
 371         LINVRNT(io->ci_state == CIS_INIT || io->ci_state == CIS_IT_ENDED);
 372         LINVRNT(cl_io_invariant(io));
 373
 374         ENTRY;
 375         result = 0;
 376         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
 377                 if (scan->cis_iop->op[io->ci_type].cio_iter_init == NULL)
 378                         continue;
 379                 result = scan->cis_iop->op[io->ci_type].cio_iter_init(env,
 380                                                                       scan);
 381                 if (result != 0)
 382                         break;
 383         }
 384         if (result == 0)
 385                 io->ci_state = CIS_IT_STARTED;
 386         RETURN(result);
 387 }
 388 EXPORT_SYMBOL(cl_io_iter_init);
 389
 390 /**
 391  * Finalizes io iteration.
 392  *
 393  * Calls cl_io_operations::cio_iter_fini() bottom-to-top.
 394  */
 395 void cl_io_iter_fini(const struct lu_env *env, struct cl_io *io)
 396 {
 397         const struct cl_io_slice *scan;
 398
 399         LINVRNT(cl_io_is_loopable(io));
 400         LINVRNT(io->ci_state <= CIS_IT_STARTED ||
 401                 io->ci_state > CIS_IO_FINISHED);
 402         LINVRNT(cl_io_invariant(io));
 403
 404         ENTRY;
 405         list_for_each_entry_reverse(scan, &io->ci_layers, cis_linkage) {
 406                 if (scan->cis_iop->op[io->ci_type].cio_iter_fini != NULL)
 407                         scan->cis_iop->op[io->ci_type].cio_iter_fini(env, scan);
 408         }
 409         io->ci_state = CIS_IT_ENDED;
 410         EXIT;
 411 }
 412 EXPORT_SYMBOL(cl_io_iter_fini);
 413
 414 /**
 415  * Records that read or write io progressed \a bytes forward.
 416  */
 417 void cl_io_rw_advance(const struct lu_env *env, struct cl_io *io, size_t bytes)
 418 {
 419         const struct cl_io_slice *scan;
 420
 421         ENTRY;
 422
 423         LINVRNT(io->ci_type == CIT_READ || io->ci_type == CIT_WRITE ||
 424                 bytes == 0);
 425         LINVRNT(cl_io_is_loopable(io));
 426         LINVRNT(cl_io_invariant(io));
 427
 428         io->u.ci_rw.crw_pos   += bytes;
 429         io->u.ci_rw.crw_bytes -= bytes;
 430
 431         /* layers have to be notified. */
 432         list_for_each_entry_reverse(scan, &io->ci_layers, cis_linkage) {
 433                 if (scan->cis_iop->op[io->ci_type].cio_advance != NULL)
 434                         scan->cis_iop->op[io->ci_type].cio_advance(env, scan,
 435                                                                    bytes);
 436         }
 437         EXIT;
 438 }
 439
 440 /**
 441  * Adds a lock to a lockset.
 442  */
 443 int cl_io_lock_add(const struct lu_env *env, struct cl_io *io,
 444                    struct cl_io_lock_link *link)
 445 {
 446         int result;
 447
 448         ENTRY;
 449         if (cl_lockset_merge(&io->ci_lockset, &link->cill_descr))
 450                 result = +1;
 451         else {
 452                 list_add(&link->cill_linkage, &io->ci_lockset.cls_todo);
 453                 result = 0;
 454         }
 455         RETURN(result);
 456 }
 457 EXPORT_SYMBOL(cl_io_lock_add);
 458
 459 static void cl_free_io_lock_link(const struct lu_env *env,
 460                                  struct cl_io_lock_link *link)
 461 {
 462         OBD_FREE_PTR(link);
 463 }
 464
 465 /**
 466  * Allocates new lock link, and uses it to add a lock to a lockset.
 467  */
 468 int cl_io_lock_alloc_add(const struct lu_env *env, struct cl_io *io,
 469                          struct cl_lock_descr *descr)
 470 {
 471         struct cl_io_lock_link *link;
 472         int result;
 473
 474         ENTRY;
 475         OBD_ALLOC_PTR(link);
 476         if (link != NULL) {
 477                 link->cill_descr = *descr;
 478                 link->cill_fini  = cl_free_io_lock_link;
 479                 result = cl_io_lock_add(env, io, link);
 480                 if (result) /* lock match */
 481                         link->cill_fini(env, link);
 482         } else
 483                 result = -ENOMEM;
 484
 485         RETURN(result);
 486 }
 487 EXPORT_SYMBOL(cl_io_lock_alloc_add);
 488
 489 /**
 490  * Starts io by calling cl_io_operations::cio_start() top-to-bottom.
 491  */
 492 int cl_io_start(const struct lu_env *env, struct cl_io *io)
 493 {
 494         const struct cl_io_slice *scan;
 495         int result = 0;
 496
 497         LINVRNT(cl_io_is_loopable(io));
 498         LINVRNT(io->ci_state == CIS_LOCKED);
 499         LINVRNT(cl_io_invariant(io));
 500         ENTRY;
 501
 502         io->ci_state = CIS_IO_GOING;
 503         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
 504                 if (scan->cis_iop->op[io->ci_type].cio_start == NULL)
 505                         continue;
 506                 result = scan->cis_iop->op[io->ci_type].cio_start(env, scan);
 507                 if (result != 0)
 508                         break;
 509         }
 510         if (result >= 0)
 511                 result = 0;
 512         RETURN(result);
 513 }
 514 EXPORT_SYMBOL(cl_io_start);
 515
 516 /**
 517  * Wait until current io iteration is finished by calling
 518  * cl_io_operations::cio_end() bottom-to-top.
 519  */
 520 void cl_io_end(const struct lu_env *env, struct cl_io *io)
 521 {
 522         const struct cl_io_slice *scan;
 523
 524         LINVRNT(cl_io_is_loopable(io));
 525         LINVRNT(io->ci_state == CIS_IO_GOING);
 526         LINVRNT(cl_io_invariant(io));
 527         ENTRY;
 528
 529         list_for_each_entry_reverse(scan, &io->ci_layers, cis_linkage) {
 530                 if (scan->cis_iop->op[io->ci_type].cio_end != NULL)
 531                         scan->cis_iop->op[io->ci_type].cio_end(env, scan);
 532                 /* TODO: error handling. */
 533         }
 534         io->ci_state = CIS_IO_FINISHED;
 535         EXIT;
 536 }
 537 EXPORT_SYMBOL(cl_io_end);
 538
 539 /**
 540  * Called by read io, to decide the readahead extent
 541  *
 542  * \see cl_io_operations::cio_read_ahead()
 543  */
 544 int cl_io_read_ahead(const struct lu_env *env, struct cl_io *io,
 545                      pgoff_t start, struct cl_read_ahead *ra)
 546 {
 547         const struct cl_io_slice *scan;
 548         int result = 0;
 549
 550         LINVRNT(io->ci_type == CIT_READ ||
 551                 io->ci_type == CIT_FAULT ||
 552                 io->ci_type == CIT_WRITE);
 553         LINVRNT(io->ci_state == CIS_IO_GOING || io->ci_state == CIS_LOCKED);
 554         LINVRNT(cl_io_invariant(io));
 555         ENTRY;
 556
 557         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
 558                 if (scan->cis_iop->cio_read_ahead == NULL)
 559                         continue;
 560
 561                 result = scan->cis_iop->cio_read_ahead(env, scan, start, ra);
 562                 if (result != 0)
 563                         break;
 564         }
 565         RETURN(result > 0 ? 0 : result);
 566 }
 567 EXPORT_SYMBOL(cl_io_read_ahead);
 568
 569 /**
 570  * Called before io start, to reserve enough LRU slots to avoid
 571  * deadlock.
 572  *
 573  * \see cl_io_operations::cio_lru_reserve()
 574  */
 575 int cl_io_lru_reserve(const struct lu_env *env, struct cl_io *io,
 576                       loff_t pos, size_t bytes)
 577 {
 578         const struct cl_io_slice *scan;
 579         int result = 0;
 580
 581         LINVRNT(io->ci_type == CIT_READ || io->ci_type == CIT_WRITE);
 582         LINVRNT(cl_io_invariant(io));
 583         ENTRY;
 584
 585         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
 586                 if (scan->cis_iop->cio_lru_reserve) {
 587                         result = scan->cis_iop->cio_lru_reserve(env, scan,
 588                                                                 pos, bytes);
 589                         if (result)
 590                                 break;
 591                 }
 592         }
 593
 594         RETURN(result);
 595 }
 596 EXPORT_SYMBOL(cl_io_lru_reserve);
 597
 598 /**
 599  * Commit a list of contiguous pages into writeback cache.
 600  *
 601  * \returns 0 if all pages committed, or errcode if error occurred.
 602  * \see cl_io_operations::cio_commit_async()
 603  */
 604 int cl_io_commit_async(const struct lu_env *env, struct cl_io *io,
 605                        struct cl_page_list *queue, int from, int to,
 606                        cl_commit_cbt cb)
 607 {
 608         const struct cl_io_slice *scan;
 609         int result = 0;
 610         ENTRY;
 611
 612         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
 613                 if (scan->cis_iop->cio_commit_async == NULL)
 614                         continue;
 615                 result = scan->cis_iop->cio_commit_async(env, scan, queue,
 616                                                          from, to, cb);
 617                 if (result != 0)
 618                         break;
 619         }
 620         RETURN(result);
 621 }
 622 EXPORT_SYMBOL(cl_io_commit_async);
 623
 624 void cl_io_extent_release(const struct lu_env *env, struct cl_io *io)
 625 {
 626         const struct cl_io_slice *scan;
 627         ENTRY;
 628
 629         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
 630                 if (scan->cis_iop->cio_extent_release == NULL)
 631                         continue;
 632                 scan->cis_iop->cio_extent_release(env, scan);
 633         }
 634         EXIT;
 635 }
 636 EXPORT_SYMBOL(cl_io_extent_release);
 637
 638 /**
 639  * Submits a list of pages for immediate io.
 640  *
 641  * After the function gets returned, The submitted pages are moved to
 642  * queue->c2_qout queue, and queue->c2_qin contain both the pages don't need
 643  * to be submitted, and the pages are errant to submit.
 644  *
 645  * \returns 0 if at least one page was submitted, error code otherwise.
 646  * \see cl_io_operations::cio_submit()
 647  */
 648 int cl_io_submit_rw(const struct lu_env *env, struct cl_io *io,
 649                     enum cl_req_type crt, struct cl_2queue *queue)
 650 {
 651         const struct cl_io_slice *scan;
 652         int result = 0;
 653         ENTRY;
 654
 655         list_for_each_entry(scan, &io->ci_layers, cis_linkage) {
 656                 if (scan->cis_iop->cio_submit == NULL)
 657                         continue;
 658                 result = scan->cis_iop->cio_submit(env, io, scan, crt, queue);
 659                 if (result != 0)
 660                         break;
 661         }
 662         /*
 663          * If ->cio_submit() failed, no pages were sent.
 664          */
 665         LASSERT(ergo(result != 0, list_empty(&queue->c2_qout.pl_pages)));
 666         RETURN(result);
 667 }
 668 EXPORT_SYMBOL(cl_io_submit_rw);
 669
 670 /**
 671  * Submit a sync_io and wait for the IO to be finished, or error happens.
 672  * If \a timeout is zero, it means to wait for the IO unconditionally.
 673  *
 674  * This is used for synchronous submission of an async IO, so the waiting is
 675  * done here in this function and the IO is done when this function returns.
 676  */
 677 int cl_io_submit_sync(const struct lu_env *env, struct cl_io *io,
 678                       enum cl_req_type iot, struct cl_2queue *queue,
 679                       long timeout)
 680 {
 681         struct cl_sync_io *anchor = &cl_env_info(env)->clt_anchor;
 682         struct cl_page *pg;
 683         int rc;
 684         ENTRY;
 685
 686         cl_page_list_for_each(pg, &queue->c2_qin) {
 687                 LASSERT(pg->cp_sync_io == NULL);
 688                 /* this is for sync submission of async IO, IO that was always
 689                  * sync (like DIO) is handled differently
 690                  */
 691                 LASSERT(pg->cp_type != CPT_TRANSIENT);
 692                 pg->cp_sync_io = anchor;
 693         }
 694
 695         cl_sync_io_init(anchor, queue->c2_qin.pl_nr);
 696         rc = cl_io_submit_rw(env, io, iot, queue);
 697         if (rc == 0) {
 698                 /*
 699                  * If some pages weren't sent for any reason (e.g.,
 700                  * read found up-to-date pages in the cache, or write found
 701                  * clean pages), count them as completed to avoid infinite
 702                  * wait.
 703                  */
 704                 cl_page_list_for_each(pg, &queue->c2_qin) {
 705                         pg->cp_sync_io = NULL;
 706                         cl_sync_io_note(env, anchor, 1);
 707                 }
 708
 709                 /* wait for the IO to be finished. */
 710                 rc = cl_sync_io_wait(env, anchor, timeout);
 711                 cl_page_list_assume(env, io, &queue->c2_qout);
 712         } else {
 713                 LASSERT(list_empty(&queue->c2_qout.pl_pages));
 714                 cl_page_list_for_each(pg, &queue->c2_qin)
 715                         pg->cp_sync_io = NULL;
 716         }
 717         RETURN(rc);
 718 }
 719 EXPORT_SYMBOL(cl_io_submit_sync);
 720
 721 /**
 722  * Main io loop.
 723  *
 724  * Pumps io through iterations calling
 725  *
 726  *    - cl_io_iter_init()
 727  *
 728  *    - cl_io_lock()
 729  *
 730  *    - cl_io_start()
 731  *
 732  *    - cl_io_end()
 733  *
 734  *    - cl_io_unlock()
 735  *
 736  *    - cl_io_iter_fini()
 737  *
 738  * repeatedly until there is no more io to do.
 739  */
 740 int cl_io_loop(const struct lu_env *env, struct cl_io *io)
 741 {
 742         int result = 0;
 743         int rc = 0;
 744
 745         LINVRNT(cl_io_is_loopable(io));
 746         ENTRY;
 747
 748         do {
 749                 size_t bytes;
 750
 751                 io->ci_continue = 0;
 752                 result = cl_io_iter_init(env, io);
 753                 if (result == 0) {
 754                         bytes = io->ci_bytes;
 755                         result = cl_io_lock(env, io);
 756                         if (result == 0) {
 757                                 /*
 758                                  * Notify layers that locks has been taken,
 759                                  * and do actual i/o.
 760                                  *
 761                                  *   - llite: kms, short read;
 762                                  *   - llite: generic_file_read();
 763                                  */
 764                                 result = cl_io_start(env, io);
 765                                 /*
 766                                  * Send any remaining pending
 767                                  * io, etc.
 768                                  *
 769                                  **   - llite: ll_rw_stats_tally.
 770                                  */
 771                                 cl_io_end(env, io);
 772                                 cl_io_unlock(env, io);
 773                                 cl_io_rw_advance(env, io, io->ci_bytes - bytes);
 774                         }
 775                 }
 776                 cl_io_iter_fini(env, io);
 777                 if (result)
 778                         rc = result;
 779         } while ((result == 0 || result == -EIOCBQUEUED) &&
 780                  io->ci_continue);
 781
 782         if (rc && !result)
 783                 result = rc;
 784
 785         if (result == -EAGAIN && io->ci_ndelay && !io->ci_iocb_nowait) {
 786                 if (!io->ci_tried_all_mirrors) {
 787                         io->ci_need_restart = 1;
 788                         result = 0;
 789                 } else {
 790                         result = -EIO;
 791                 }
 792         }
 793
 794         if (result == 0)
 795                 result = io->ci_result;
 796         RETURN(result < 0 ? result : 0);
 797 }
 798 EXPORT_SYMBOL(cl_io_loop);
 799
 800 /**
 801  * Adds io slice to the cl_io.
 802  *
 803  * This is called by cl_object_operations::coo_io_init() methods to add a
 804  * per-layer state to the io. New state is added at the end of
 805  * cl_io::ci_layers list, that is, it is at the bottom of the stack.
 806  *
 807  * \see cl_lock_slice_add(), cl_req_slice_add(), cl_page_slice_add()
 808  */
 809 void cl_io_slice_add(struct cl_io *io, struct cl_io_slice *slice,
 810                      struct cl_object *obj,
 811                      const struct cl_io_operations *ops)
 812 {
 813         struct list_head *linkage = &slice->cis_linkage;
 814
 815         LASSERT((linkage->prev == NULL && linkage->next == NULL) ||
 816                 list_empty(linkage));
 817         ENTRY;
 818
 819         list_add_tail(linkage, &io->ci_layers);
 820         slice->cis_io  = io;
 821         slice->cis_obj = obj;
 822         slice->cis_iop = ops;
 823         EXIT;
 824 }
 825 EXPORT_SYMBOL(cl_io_slice_add);
 826
 827
 828 /**
 829  * Initializes page list.
 830  */
 831 void cl_page_list_init(struct cl_page_list *plist)
 832 {
 833         ENTRY;
 834         plist->pl_nr = 0;
 835         INIT_LIST_HEAD(&plist->pl_pages);
 836         EXIT;
 837 }
 838 EXPORT_SYMBOL(cl_page_list_init);
 839
 840 /**
 841  * Adds a page to a page list.
 842  */
 843 void cl_page_list_add(struct cl_page_list *plist, struct cl_page *page,
 844                       bool getref)
 845 {
 846         ENTRY;
 847         /* it would be better to check that page is owned by "current" io, but
 848          * it is not passed here. */
 849         if (page->cp_type != CPT_TRANSIENT)
 850                 LASSERT(page->cp_owner != NULL);
 851
 852         LASSERT(list_empty(&page->cp_batch));
 853         list_add_tail(&page->cp_batch, &plist->pl_pages);
 854         ++plist->pl_nr;
 855         if (getref)
 856                 cl_page_get(page);
 857         EXIT;
 858 }
 859 EXPORT_SYMBOL(cl_page_list_add);
 860
 861 /**
 862  * Removes a page from a page list.
 863  */
 864 void cl_page_list_del(const struct lu_env *env,
 865                       struct cl_page_list *plist, struct cl_page *page,
 866                       bool putref)
 867 {
 868         LASSERT(plist->pl_nr > 0);
 869
 870         ENTRY;
 871         list_del_init(&page->cp_batch);
 872         --plist->pl_nr;
 873         if (putref)
 874                 cl_page_put(env, page);
 875         EXIT;
 876 }
 877 EXPORT_SYMBOL(cl_page_list_del);
 878
 879 /**
 880  * Moves a page from one page list to another.
 881  */
 882 void cl_page_list_move(struct cl_page_list *dst, struct cl_page_list *src,
 883                        struct cl_page *page)
 884 {
 885         LASSERT(src->pl_nr > 0);
 886
 887         ENTRY;
 888         list_move_tail(&page->cp_batch, &dst->pl_pages);
 889         --src->pl_nr;
 890         ++dst->pl_nr;
 891         EXIT;
 892 }
 893 EXPORT_SYMBOL(cl_page_list_move);
 894
 895 /**
 896  * Moves a page from one page list to the head of another list.
 897  */
 898 void cl_page_list_move_head(struct cl_page_list *dst, struct cl_page_list *src,
 899                             struct cl_page *page)
 900 {
 901         LASSERT(src->pl_nr > 0);
 902
 903         ENTRY;
 904         list_move(&page->cp_batch, &dst->pl_pages);
 905         --src->pl_nr;
 906         ++dst->pl_nr;
 907         EXIT;
 908 }
 909 EXPORT_SYMBOL(cl_page_list_move_head);
 910
 911 /**
 912  * splice the cl_page_list, just as list head does
 913  */
 914 void cl_page_list_splice(struct cl_page_list *src, struct cl_page_list *dst)
 915 {
 916         ENTRY;
 917         dst->pl_nr += src->pl_nr;
 918         src->pl_nr = 0;
 919         list_splice_tail_init(&src->pl_pages, &dst->pl_pages);
 920
 921         EXIT;
 922 }
 923 EXPORT_SYMBOL(cl_page_list_splice);
 924
 925 /**
 926  * Disowns pages in a queue.
 927  */
 928 void cl_page_list_disown(const struct lu_env *env, struct cl_page_list *plist)
 929 {
 930         struct cl_page *page;
 931         struct cl_page *temp;
 932
 933         ENTRY;
 934         cl_page_list_for_each_safe(page, temp, plist) {
 935                 LASSERT(plist->pl_nr > 0);
 936
 937                 list_del_init(&page->cp_batch);
 938                 --plist->pl_nr;
 939                 /*
 940                  * __cl_page_disown rather than usual cl_page_disown() is used,
 941                  * because pages are possibly in CPS_FREEING state already due
 942                  * to the call to cl_page_list_discard().
 943                  */
 944                 /*
 945                  * XXX __cl_page_disown() will fail if page is not locked.
 946                  */
 947                 if (page->cp_type == CPT_CACHEABLE)
 948                         __cl_page_disown(env, page);
 949                 cl_page_put(env, page);
 950         }
 951         EXIT;
 952 }
 953 EXPORT_SYMBOL(cl_page_list_disown);
 954
 955 /**
 956  * Releases pages from queue.
 957  */
 958 void cl_page_list_fini(const struct lu_env *env, struct cl_page_list *plist)
 959 {
 960         struct cl_page *page;
 961         struct cl_page *temp;
 962
 963         ENTRY;
 964         cl_page_list_for_each_safe(page, temp, plist)
 965                 cl_page_list_del(env, plist, page, true);
 966         LASSERT(plist->pl_nr == 0);
 967         EXIT;
 968 }
 969 EXPORT_SYMBOL(cl_page_list_fini);
 970
 971 /**
 972  * Assumes all pages in a queue.
 973  */
 974 void cl_page_list_assume(const struct lu_env *env,
 975                          struct cl_io *io, struct cl_page_list *plist)
 976 {
 977         struct cl_page *page;
 978
 979         cl_page_list_for_each(page, plist)
 980                 cl_page_assume(env, io, page);
 981 }
 982
 983 /**
 984  * Discards all pages in a queue.
 985  */
 986 void cl_page_list_discard(const struct lu_env *env, struct cl_io *io,
 987                           struct cl_page_list *plist)
 988 {
 989         struct cl_page *page;
 990
 991         ENTRY;
 992         cl_page_list_for_each(page, plist)
 993                 cl_page_discard(env, io, page);
 994         EXIT;
 995 }
 996 EXPORT_SYMBOL(cl_page_list_discard);
 997
 998 /**
 999  * Initialize dual page queue.
1000  */
1001 void cl_2queue_init(struct cl_2queue *queue)
1002 {
1003         ENTRY;
1004         cl_page_list_init(&queue->c2_qin);
1005         cl_page_list_init(&queue->c2_qout);
1006         EXIT;
1007 }
1008 EXPORT_SYMBOL(cl_2queue_init);
1009
1010 /**
1011  * Disown pages in both lists of a 2-queue.
1012  */
1013 void cl_2queue_disown(const struct lu_env *env, struct cl_2queue *queue)
1014 {
1015         ENTRY;
1016         cl_page_list_disown(env, &queue->c2_qin);
1017         cl_page_list_disown(env, &queue->c2_qout);
1018         EXIT;
1019 }
1020 EXPORT_SYMBOL(cl_2queue_disown);
1021
1022 /**
1023  * Discard (truncate) pages in both lists of a 2-queue.
1024  */
1025 void cl_2queue_discard(const struct lu_env *env,
1026                        struct cl_io *io, struct cl_2queue *queue)
1027 {
1028         ENTRY;
1029         cl_page_list_discard(env, io, &queue->c2_qin);
1030         cl_page_list_discard(env, io, &queue->c2_qout);
1031         EXIT;
1032 }
1033 EXPORT_SYMBOL(cl_2queue_discard);
1034
1035 /**
1036  * Assume to own the pages in cl_2queue
1037  */
1038 void cl_2queue_assume(const struct lu_env *env,
1039                       struct cl_io *io, struct cl_2queue *queue)
1040 {
1041         cl_page_list_assume(env, io, &queue->c2_qin);
1042         cl_page_list_assume(env, io, &queue->c2_qout);
1043 }
1044
1045 /**
1046  * Finalize both page lists of a 2-queue.
1047  */
1048 void cl_2queue_fini(const struct lu_env *env, struct cl_2queue *queue)
1049 {
1050         ENTRY;
1051         cl_page_list_fini(env, &queue->c2_qout);
1052         cl_page_list_fini(env, &queue->c2_qin);
1053         EXIT;
1054 }
1055 EXPORT_SYMBOL(cl_2queue_fini);
1056
1057 /**
1058  * Initialize a 2-queue to contain \a page in its incoming page list.
1059  */
1060 void cl_2queue_init_page(struct cl_2queue *queue, struct cl_page *page)
1061 {
1062         ENTRY;
1063         cl_2queue_init(queue);
1064         /*
1065          * Add a page to the incoming page list of 2-queue.
1066          */
1067         cl_page_list_add(&queue->c2_qin, page, true);
1068         EXIT;
1069 }
1070 EXPORT_SYMBOL(cl_2queue_init_page);
1071
1072 /**
1073  * Returns top-level io.
1074  *
1075  * \see cl_object_top()
1076  */
1077 struct cl_io *cl_io_top(struct cl_io *io)
1078 {
1079         ENTRY;
1080         while (io->ci_parent != NULL)
1081                 io = io->ci_parent;
1082         RETURN(io);
1083 }
1084 EXPORT_SYMBOL(cl_io_top);
1085
1086 /**
1087  * Fills in attributes that are passed to server together with transfer. Only
1088  * attributes from \a flags may be touched. This can be called multiple times
1089  * for the same request.
1090  */
1091 void cl_req_attr_set(const struct lu_env *env, struct cl_object *obj,
1092                      struct cl_req_attr *attr)
1093 {
1094         struct cl_object *scan;
1095         ENTRY;
1096
1097         cl_object_for_each(scan, obj) {
1098                 if (scan->co_ops->coo_req_attr_set != NULL)
1099                         scan->co_ops->coo_req_attr_set(env, scan, attr);
1100         }
1101         EXIT;
1102 }
1103 EXPORT_SYMBOL(cl_req_attr_set);
1104
1105 /**
1106  * Initialize synchronous io wait \a anchor for \a nr pages with optional
1107  * \a end handler.
1108  * \param anchor owned by caller, initialzied here.
1109  * \param nr number of pages initally pending in sync.
1110  * \param end optional callback sync_io completion, can be used to
1111  *  trigger erasure coding, integrity, dedupe, or similar operation.
1112  * \q end is called with a spinlock on anchor->csi_waitq.lock
1113  */
1114 void cl_sync_io_init_notify(struct cl_sync_io *anchor, int nr,
1115                             void *dio_aio, cl_sync_io_end_t *end)
1116 {
1117         ENTRY;
1118         memset(anchor, 0, sizeof(*anchor));
1119         init_waitqueue_head(&anchor->csi_waitq);
1120         atomic_set(&anchor->csi_sync_nr, nr);
1121         atomic_set(&anchor->csi_complete, 0);
1122         anchor->csi_sync_rc = 0;
1123         anchor->csi_end_io = end;
1124         anchor->csi_dio_aio = dio_aio;
1125         EXIT;
1126 }
1127 EXPORT_SYMBOL(cl_sync_io_init_notify);
1128
1129 /**
1130  * Wait until all IO completes. Transfer completion routine has to call
1131  * cl_sync_io_note() for every entity.
1132  */
1133 int cl_sync_io_wait(const struct lu_env *env, struct cl_sync_io *anchor,
1134                     long timeout)
1135 {
1136         int rc = 0;
1137         ENTRY;
1138
1139         LASSERT(timeout >= 0);
1140
1141         if (timeout > 0 &&
1142             wait_event_idle_timeout(anchor->csi_waitq,
1143                                     atomic_read(&anchor->csi_complete) == 1,
1144                                     cfs_time_seconds(timeout)) == 0) {
1145                 rc = -ETIMEDOUT;
1146                 CERROR("IO failed: %d, still wait for %d remaining entries\n",
1147                        rc, atomic_read(&anchor->csi_complete));
1148         }
1149
1150         wait_event_idle(anchor->csi_waitq,
1151                         atomic_read(&anchor->csi_complete) == 1);
1152         if (!rc)
1153                 rc = anchor->csi_sync_rc;
1154
1155         /* We take the lock to ensure that cl_sync_io_note() has finished */
1156         spin_lock(&anchor->csi_waitq.lock);
1157         LASSERT(atomic_read(&anchor->csi_sync_nr) == 0);
1158         LASSERT(atomic_read(&anchor->csi_complete) == 1);
1159         spin_unlock(&anchor->csi_waitq.lock);
1160
1161         RETURN(rc);
1162 }
1163 EXPORT_SYMBOL(cl_sync_io_wait);
1164
1165 static inline void dio_aio_complete(struct kiocb *iocb, ssize_t res)
1166 {
1167 #ifdef HAVE_AIO_COMPLETE
1168         aio_complete(iocb, res, 0);
1169 #else
1170         if (iocb->ki_complete)
1171 # ifdef HAVE_KIOCB_COMPLETE_2ARGS
1172                 iocb->ki_complete(iocb, res);
1173 # else
1174                 iocb->ki_complete(iocb, res, 0);
1175 # endif
1176 #endif
1177 }
1178
1179 static void cl_dio_aio_end(const struct lu_env *env, struct cl_sync_io *anchor)
1180 {
1181         struct cl_dio_aio *aio = container_of(anchor, typeof(*aio), cda_sync);
1182         ssize_t ret = anchor->csi_sync_rc;
1183
1184         ENTRY;
1185
1186         if (!aio->cda_no_aio_complete)
1187                 dio_aio_complete(aio->cda_iocb, ret ?: aio->cda_bytes);
1188
1189         EXIT;
1190 }
1191
1192 static inline void csd_dup_free(struct cl_iter_dup *dup)
1193 {
1194         void *tmp = dup->id_vec;
1195
1196         dup->id_vec = NULL;
1197         OBD_FREE(tmp, dup->id_vec_size);
1198 }
1199
1200 static void cl_sub_dio_end(const struct lu_env *env, struct cl_sync_io *anchor)
1201 {
1202         struct cl_sub_dio *sdio = container_of(anchor, typeof(*sdio), csd_sync);
1203         ssize_t ret = anchor->csi_sync_rc;
1204
1205         ENTRY;
1206
1207         /* release pages */
1208         while (sdio->csd_pages.pl_nr > 0) {
1209                 struct cl_page *page = cl_page_list_first(&sdio->csd_pages);
1210
1211                 cl_page_delete(env, page);
1212                 cl_page_list_del(env, &sdio->csd_pages, page, false);
1213                 cl_page_put(env, page);
1214         }
1215
1216         if (sdio->csd_unaligned) {
1217                 CDEBUG(D_VFSTRACE,
1218                        "finishing unaligned dio %s aio->cda_bytes %ld\n",
1219                        sdio->csd_write ? "write" : "read", sdio->csd_bytes);
1220                 /* read copies *from* the kernel buffer *to* userspace
1221                  * here at the end, write copies *to* the kernel
1222                  * buffer from userspace at the start
1223                  */
1224                 if (!sdio->csd_write && sdio->csd_bytes > 0)
1225                         ret = ll_dio_user_copy(sdio);
1226                 ll_free_dio_buffer(&sdio->csd_dio_pages);
1227                 /* handle the freeing here rather than in cl_sub_dio_free
1228                  * because we have the unmodified iovec pointer
1229                  */
1230                 csd_dup_free(&sdio->csd_dup);
1231         } else {
1232                 /* unaligned DIO does not get user pages, so it doesn't have to
1233                  * release them, but aligned I/O must
1234                  */
1235                 ll_release_user_pages(sdio->csd_dio_pages.ldp_pages,
1236                                       sdio->csd_dio_pages.ldp_count);
1237         }
1238         cl_sync_io_note(env, &sdio->csd_ll_aio->cda_sync, ret);
1239
1240         EXIT;
1241 }
1242
1243 struct cl_dio_aio *cl_dio_aio_alloc(struct kiocb *iocb, struct cl_object *obj,
1244                                     bool is_aio)
1245 {
1246         struct cl_dio_aio *aio;
1247
1248         OBD_SLAB_ALLOC_PTR_GFP(aio, cl_dio_aio_kmem, GFP_NOFS);
1249         if (aio != NULL) {
1250                 /*
1251                  * Hold one ref so that it won't be released until
1252                  * every pages is added.
1253                  */
1254                 cl_sync_io_init_notify(&aio->cda_sync, 1, aio, cl_dio_aio_end);
1255                 aio->cda_iocb = iocb;
1256                 aio->cda_no_aio_complete = !is_aio;
1257                 /* if this is true AIO, the memory is freed by the last call
1258                  * to cl_sync_io_note (when all the I/O is complete), because
1259                  * no one is waiting (in the kernel) for this to complete
1260                  *
1261                  * in other cases, the last user is cl_sync_io_wait, and in
1262                  * that case, the creator frees the struct after that call
1263                  */
1264                 aio->cda_creator_free = !is_aio;
1265
1266                 cl_object_get(obj);
1267                 aio->cda_obj = obj;
1268                 aio->cda_mm = get_task_mm(current);
1269         }
1270         return aio;
1271 }
1272 EXPORT_SYMBOL(cl_dio_aio_alloc);
1273
1274 struct cl_sub_dio *cl_sub_dio_alloc(struct cl_dio_aio *ll_aio,
1275                                     struct iov_iter *iter, bool write,
1276                                     bool unaligned, bool sync)
1277 {
1278         struct cl_sub_dio *sdio;
1279
1280         OBD_SLAB_ALLOC_PTR_GFP(sdio, cl_sub_dio_kmem, GFP_NOFS);
1281         if (sdio != NULL) {
1282                 /*
1283                  * Hold one ref so that it won't be released until
1284                  * every pages is added.
1285                  */
1286                 cl_sync_io_init_notify(&sdio->csd_sync, 1, sdio,
1287                                        cl_sub_dio_end);
1288                 cl_page_list_init(&sdio->csd_pages);
1289
1290                 sdio->csd_ll_aio = ll_aio;
1291                 sdio->csd_creator_free = sync;
1292                 sdio->csd_write = write;
1293                 sdio->csd_unaligned = unaligned;
1294
1295                 atomic_add(1,  &ll_aio->cda_sync.csi_sync_nr);
1296
1297                 if (sdio->csd_unaligned) {
1298                         size_t v_sz = 0;
1299
1300                         /* we need to make a copy of the user iovec at this
1301                          * point in time, in order to:
1302                          *
1303                          * A) have the correct state of the iovec for this
1304                          * chunk of I/O, ie, the main iovec is altered as we do
1305                          * I/O and this chunk needs the current state
1306                          * B) have a chunk-local copy; doing the IO later
1307                          * modifies the iovec, so to process each chunk from a
1308                          * separate thread requires a local copy of the iovec
1309                          */
1310                         sdio->csd_iter = *iter;
1311                         if (iov_iter_is_bvec(iter))
1312                                 v_sz = iter->nr_segs * sizeof(struct bio_vec);
1313                         else if (iov_iter_is_kvec(iter) || iter_is_iovec(iter))
1314                                 v_sz = iter->nr_segs * sizeof(struct iovec);
1315
1316                         /* xarray and discard do not need vec to be dup'd */
1317                         if (!v_sz)
1318                                 goto out;
1319
1320                         OBD_ALLOC(sdio->csd_dup.id_vec, v_sz);
1321                         if (!sdio->csd_dup.id_vec) {
1322                                 cl_sub_dio_free(sdio);
1323                                 sdio = NULL;
1324                                 goto out;
1325                         }
1326                         memcpy(sdio->csd_dup.id_vec, iter->__iov, v_sz);
1327                         sdio->csd_dup.id_vec_size = v_sz;
1328                         sdio->csd_iter.__iov = sdio->csd_dup.id_vec;
1329                 }
1330         }
1331 out:
1332         return sdio;
1333 }
1334 EXPORT_SYMBOL(cl_sub_dio_alloc);
1335
1336 void cl_dio_aio_free(const struct lu_env *env, struct cl_dio_aio *aio)
1337 {
1338         if (aio) {
1339                 if (aio->cda_mm)
1340                         mmput(aio->cda_mm);
1341                 cl_object_put(env, aio->cda_obj);
1342                 OBD_SLAB_FREE_PTR(aio, cl_dio_aio_kmem);
1343         }
1344 }
1345 EXPORT_SYMBOL(cl_dio_aio_free);
1346
1347 void cl_sub_dio_free(struct cl_sub_dio *sdio)
1348 {
1349         if (sdio) {
1350                 if (sdio->csd_dup.id_vec) {
1351                         LASSERT(sdio->csd_unaligned);
1352                         csd_dup_free(&sdio->csd_dup);
1353                         sdio->csd_iter.__iov = NULL;
1354                 }
1355                 OBD_SLAB_FREE_PTR(sdio, cl_sub_dio_kmem);
1356         }
1357 }
1358 EXPORT_SYMBOL(cl_sub_dio_free);
1359
1360 /*
1361  * For unaligned DIO.
1362  *
1363  * Allocate the internal buffer from/to which we will perform DIO.  This takes
1364  * the user I/O parameters and allocates an internal buffer large enough to
1365  * hold it.  The pages in this buffer are aligned with pages in the file (ie,
1366  * they have a 1-to-1 mapping with file pages).
1367  */
1368 int ll_allocate_dio_buffer(struct ll_dio_pages *pvec, size_t io_size)
1369 {
1370         size_t pg_offset;
1371         int result = 0;
1372
1373         ENTRY;
1374
1375         /* page level offset in the file where the I/O starts */
1376         pg_offset = pvec->ldp_file_offset & ~PAGE_MASK;
1377         /* this adds 1 for the first page and removes the bytes in it from the
1378          * io_size, making the rest of the calculation aligned
1379          */
1380         if (pg_offset) {
1381                 pvec->ldp_count++;
1382                 io_size -= min_t(size_t, PAGE_SIZE - pg_offset, io_size);
1383         }
1384
1385         /* calculate pages for the rest of the buffer */
1386         pvec->ldp_count += (io_size + PAGE_SIZE - 1) >> PAGE_SHIFT;
1387
1388 #ifdef HAVE_DIO_ITER
1389         pvec->ldp_pages = kvzalloc(pvec->ldp_count * sizeof(struct page *),
1390                                     GFP_NOFS);
1391 #else
1392         OBD_ALLOC_PTR_ARRAY_LARGE(pvec->ldp_pages, pvec->ldp_count);
1393 #endif
1394         if (pvec->ldp_pages == NULL)
1395                 GOTO(out, result = -ENOMEM);
1396
1397         result = obd_pool_get_pages_array(pvec->ldp_pages, pvec->ldp_count);
1398         if (result)
1399                 GOTO(out, result);
1400
1401 out:
1402         if (result) {
1403                 if (pvec->ldp_pages)
1404                         ll_free_dio_buffer(pvec);
1405         }
1406
1407         if (result == 0)
1408                 result = pvec->ldp_count;
1409
1410         RETURN(result);
1411 }
1412 EXPORT_SYMBOL(ll_allocate_dio_buffer);
1413
1414 void ll_free_dio_buffer(struct ll_dio_pages *pvec)
1415 {
1416         obd_pool_put_pages_array(pvec->ldp_pages, pvec->ldp_count);
1417
1418 #ifdef HAVE_DIO_ITER
1419         kvfree(pvec->ldp_pages);
1420 #else
1421         OBD_FREE_PTR_ARRAY_LARGE(pvec->ldp_pages, pvec->ldp_count);
1422 #endif
1423 }
1424 EXPORT_SYMBOL(ll_free_dio_buffer);
1425
1426 /*
1427  * ll_release_user_pages - tear down page struct array
1428  * @pages: array of page struct pointers underlying target buffer
1429  */
1430 void ll_release_user_pages(struct page **pages, int npages)
1431 {
1432         int i;
1433
1434         if (npages == 0) {
1435                 LASSERT(!pages);
1436                 return;
1437         }
1438
1439         for (i = 0; i < npages; i++) {
1440                 if (!pages[i])
1441                         break;
1442                 put_page(pages[i]);
1443         }
1444
1445 #if defined(HAVE_DIO_ITER)
1446         kvfree(pages);
1447 #else
1448         OBD_FREE_PTR_ARRAY_LARGE(pages, npages);
1449 #endif
1450 }
1451 EXPORT_SYMBOL(ll_release_user_pages);
1452
1453 #ifdef HAVE_FAULT_IN_IOV_ITER_READABLE
1454 #define ll_iov_iter_fault_in_readable(iov, bytes) \
1455         fault_in_iov_iter_readable(iov, bytes)
1456 #else
1457 #define ll_iov_iter_fault_in_readable(iov, bytes) \
1458         iov_iter_fault_in_readable(iov, bytes)
1459 #endif
1460
1461 #ifndef HAVE_KTHREAD_USE_MM
1462 #define kthread_use_mm(mm) use_mm(mm)
1463 #define kthread_unuse_mm(mm) unuse_mm(mm)
1464 #endif
1465
1466 /* copy IO data to/from internal buffer and userspace iovec */
1467 ssize_t ll_dio_user_copy(struct cl_sub_dio *sdio)
1468 {
1469         struct iov_iter *iter = &sdio->csd_iter;
1470         struct ll_dio_pages *pvec = &sdio->csd_dio_pages;
1471         struct mm_struct *mm = sdio->csd_ll_aio->cda_mm;
1472         loff_t pos = pvec->ldp_file_offset;
1473         size_t count = sdio->csd_bytes;
1474         size_t original_count = count;
1475         int short_copies = 0;
1476         bool mm_used = false;
1477         int status = 0;
1478         int i = 0;
1479         int rw;
1480
1481         ENTRY;
1482
1483         LASSERT(sdio->csd_unaligned);
1484
1485         if (sdio->csd_write)
1486                 rw = WRITE;
1487         else
1488                 rw = READ;
1489
1490         /* if there's no mm, io is being done from a kernel thread, so there's
1491          * no need to transition to its mm context anyway.
1492          *
1493          * Also, if mm == current->mm, that means this is being handled in the
1494          * thread which created it, and not in a separate kthread - so it is
1495          * unnecessary (and incorrect) to do a use_mm here
1496          */
1497         if (mm && mm != current->mm) {
1498                 kthread_use_mm(mm);
1499                 mm_used = true;
1500         }
1501
1502         /* fault in the entire userspace iovec */
1503         if (rw == WRITE) {
1504                 if (unlikely(ll_iov_iter_fault_in_readable(iter, count)))
1505                         GOTO(out, status = -EFAULT);
1506         }
1507
1508         /* modeled on kernel generic_file_buffered_read/write()
1509          *
1510          * note we only have one 'chunk' of i/o here, so we do not copy the
1511          * whole iovec here (except when the chunk is the whole iovec) so we
1512          * use the count of bytes in the chunk, csd_bytes, instead of looking
1513          * at the iovec
1514          */
1515         while (true) {
1516                 struct page *page = pvec->ldp_pages[i];
1517                 unsigned long offset; /* offset into kernel buffer page */
1518                 size_t copied; /* bytes successfully copied */
1519                 size_t bytes; /* bytes to copy for this page */
1520
1521                 LASSERT(i < pvec->ldp_count);
1522
1523                 offset = pos & ~PAGE_MASK;
1524                 bytes = min_t(unsigned long, PAGE_SIZE - offset, count);
1525
1526                 CDEBUG(D_VFSTRACE,
1527                        "count %zd, offset %lu, pos %lld, ldp_count %lu\n",
1528                        count, offset, pos, pvec->ldp_count);
1529
1530                 if (fatal_signal_pending(current)) {
1531                         status = -EINTR;
1532                         break;
1533                 }
1534
1535                 /* like btrfs, we do not have a mapping since this isn't
1536                  * a page cache page, so we must do this flush
1537                  * unconditionally
1538                  *
1539                  * NB: This is a noop on x86 but active on other
1540                  * architectures
1541                  */
1542                 flush_dcache_page(page);
1543
1544                 /* write requires a few extra steps */
1545                 if (rw == WRITE) {
1546 #ifndef HAVE_COPY_PAGE_FROM_ITER_ATOMIC
1547                         copied = iov_iter_copy_from_user_atomic(page, iter,
1548                                                                 offset, bytes);
1549                         iov_iter_advance(iter, copied);
1550 #else
1551                         copied = copy_page_from_iter_atomic(page, offset, bytes,
1552                                                             iter);
1553 #endif
1554                         flush_dcache_page(page);
1555
1556                 } else /* READ */ {
1557                         copied = copy_page_to_iter(page, offset, bytes, iter);
1558                 }
1559
1560                 pos += copied;
1561                 count -= copied;
1562
1563                 if (unlikely(copied < bytes)) {
1564                         short_copies++;
1565
1566                         CDEBUG(D_VFSTRACE,
1567                                "short copy - copied only %zd of %lu, short %d times\n",
1568                                copied, bytes, short_copies);
1569                         /* copies will very rarely be interrupted, but we
1570                          * should retry in those cases, since the other option
1571                          * is giving an IO error and this can occur in normal
1572                          * operation such as with racing unaligned AIOs
1573                          *
1574                          * but of course we should not retry indefinitely
1575                          */
1576                         if (short_copies > 2) {
1577                                 CERROR("Unaligned DIO copy repeatedly short, count %zd, offset %lu, bytes %lu, copied %zd, pos %lld\n",
1578                                 count, offset, bytes, copied, pos);
1579
1580                                 status = -EFAULT;
1581                                 break;
1582                         }
1583
1584                         continue;
1585                 }
1586
1587                 if (count == 0)
1588                         break;
1589
1590                 i++;
1591         }
1592
1593 out:
1594         /* if we complete successfully, we should reach all of the pages */
1595         LASSERTF(ergo(status == 0, i == pvec->ldp_count - 1),
1596                  "status: %d, i: %d, pvec->ldp_count %zu, count %zu\n",
1597                   status, i, pvec->ldp_count, count);
1598
1599         if (mm_used)
1600                 kthread_unuse_mm(mm);
1601
1602         /* the total bytes copied, or status */
1603         RETURN(original_count - count ? original_count - count : status);
1604 }
1605 EXPORT_SYMBOL(ll_dio_user_copy);
1606
1607 /**
1608  * Indicate that transfer of a single page completed.
1609  */
1610 void cl_sync_io_note(const struct lu_env *env, struct cl_sync_io *anchor,
1611                      int ioret)
1612 {
1613         ENTRY;
1614
1615         if (anchor->csi_sync_rc == 0 && ioret < 0)
1616                 anchor->csi_sync_rc = ioret;
1617         /*
1618          * Synchronous IO done without releasing page lock (e.g., as a part of
1619          * ->{prepare,commit}_write(). Completion is used to signal the end of
1620          * IO.
1621          */
1622         LASSERT(atomic_read(&anchor->csi_sync_nr) > 0);
1623         LASSERT(atomic_read(&anchor->csi_complete) == 0);
1624         if (atomic_dec_and_lock(&anchor->csi_sync_nr,
1625                                 &anchor->csi_waitq.lock)) {
1626                 struct cl_sub_dio *sub_dio_aio = NULL;
1627                 struct cl_dio_aio *dio_aio = NULL;
1628                 void *csi_dio_aio = NULL;
1629                 bool creator_free = true;
1630
1631                 cl_sync_io_end_t *end_io = anchor->csi_end_io;
1632
1633                 spin_unlock(&anchor->csi_waitq.lock);
1634                 /* we cannot do end_io while holding a spin lock, because
1635                  * end_io may sleep
1636                  */
1637                 if (end_io)
1638                         end_io(env, anchor);
1639
1640                 spin_lock(&anchor->csi_waitq.lock);
1641                 /* this tells the waiters we've completed, and can only be set
1642                  * after end_io() has been called and while we're holding the
1643                  * spinlock
1644                  */
1645                 atomic_set(&anchor->csi_complete, 1);
1646                 /*
1647                  * Holding the lock across both the decrement and
1648                  * the wakeup ensures cl_sync_io_wait() doesn't complete
1649                  * before the wakeup completes and the contents of
1650                  * of anchor become unsafe to access as the owner is free
1651                  * to immediately reclaim anchor when cl_sync_io_wait()
1652                  * completes.
1653                  */
1654                 wake_up_locked(&anchor->csi_waitq);
1655
1656                 csi_dio_aio = anchor->csi_dio_aio;
1657                 sub_dio_aio = csi_dio_aio;
1658                 dio_aio = csi_dio_aio;
1659
1660                 if (csi_dio_aio && end_io == cl_dio_aio_end)
1661                         creator_free = dio_aio->cda_creator_free;
1662                 else if (csi_dio_aio && end_io == cl_sub_dio_end)
1663                         creator_free = sub_dio_aio->csd_creator_free;
1664
1665                 spin_unlock(&anchor->csi_waitq.lock);
1666
1667                 if (csi_dio_aio && !creator_free) {
1668                         if (end_io == cl_dio_aio_end)
1669                                 cl_dio_aio_free(env, dio_aio);
1670                         else if (end_io == cl_sub_dio_end)
1671                                 cl_sub_dio_free(sub_dio_aio);
1672                 }
1673         }
1674         EXIT;
1675 }
1676 EXPORT_SYMBOL(cl_sync_io_note);
1677
1678 /* this function waits for completion of outstanding io and then re-initializes
1679  * the anchor used to track it.  This is used to wait to complete DIO before
1680  * returning to userspace, and is never called for true AIO
1681  */
1682 int cl_sync_io_wait_recycle(const struct lu_env *env, struct cl_sync_io *anchor,
1683                             long timeout, int ioret)
1684 {
1685         int rc = 0;
1686
1687         /*
1688          * @anchor was inited as 1 to prevent end_io to be
1689          * called before we add all pages for IO, so drop
1690          * one extra reference to make sure we could wait
1691          * count to be zero.
1692          */
1693         cl_sync_io_note(env, anchor, ioret);
1694         /* Wait for completion of outstanding dio before re-initializing for
1695          * possible restart
1696          */
1697         rc = cl_sync_io_wait(env, anchor, timeout);
1698         /**
1699          * One extra reference again, as if @anchor is
1700          * reused we assume it as 1 before using.
1701          */
1702         atomic_add(1, &anchor->csi_sync_nr);
1703         /* we must also set this anchor as incomplete */
1704         atomic_set(&anchor->csi_complete, 0);
1705
1706         return rc;
1707 }
1708 EXPORT_SYMBOL(cl_sync_io_wait_recycle);