lustre/llite/lcommon_cl.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2013, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * cl code shared between vvp and liblustre (and other Lustre clients in the
  37  * future).
  38  *
  39  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  40  */
  41
  42 #define DEBUG_SUBSYSTEM S_LLITE
  43
  44 #include <libcfs/libcfs.h>
  45 #include <linux/fs.h>
  46 #include <linux/sched.h>
  47 #include <linux/mm.h>
  48 #include <linux/quotaops.h>
  49 #include <linux/highmem.h>
  50 #include <linux/pagemap.h>
  51 #include <linux/rbtree.h>
  52
  53 #include <obd.h>
  54 #include <obd_support.h>
  55 #include <lustre_fid.h>
  56 #include <lustre_dlm.h>
  57 #include <lustre_ver.h>
  58 #include <lustre_mdc.h>
  59 #include <cl_object.h>
  60
  61 #include "llite_internal.h"
  62
  63 static const struct cl_req_operations ccc_req_ops;
  64
  65 /*
  66  * ccc_ prefix stands for "Common Client Code".
  67  */
  68
  69 static struct kmem_cache *ccc_lock_kmem;
  70 static struct kmem_cache *ccc_object_kmem;
  71 static struct kmem_cache *ccc_thread_kmem;
  72 static struct kmem_cache *ccc_session_kmem;
  73 static struct kmem_cache *ccc_req_kmem;
  74
  75 static struct lu_kmem_descr ccc_caches[] = {
  76         {
  77                 .ckd_cache = &ccc_lock_kmem,
  78                 .ckd_name  = "ccc_lock_kmem",
  79                 .ckd_size  = sizeof (struct ccc_lock)
  80         },
  81         {
  82                 .ckd_cache = &ccc_object_kmem,
  83                 .ckd_name  = "ccc_object_kmem",
  84                 .ckd_size  = sizeof (struct ccc_object)
  85         },
  86         {
  87                 .ckd_cache = &ccc_thread_kmem,
  88                 .ckd_name  = "ccc_thread_kmem",
  89                 .ckd_size  = sizeof (struct ccc_thread_info),
  90         },
  91         {
  92                 .ckd_cache = &ccc_session_kmem,
  93                 .ckd_name  = "ccc_session_kmem",
  94                 .ckd_size  = sizeof (struct ccc_session)
  95         },
  96         {
  97                 .ckd_cache = &ccc_req_kmem,
  98                 .ckd_name  = "ccc_req_kmem",
  99                 .ckd_size  = sizeof (struct ccc_req)
 100         },
 101         {
 102                 .ckd_cache = NULL
 103         }
 104 };
 105
 106 /*****************************************************************************
 107  *
 108  * Vvp device and device type functions.
 109  *
 110  */
 111
 112 void *ccc_key_init(const struct lu_context *ctx, struct lu_context_key *key)
 113 {
 114         struct ccc_thread_info *info;
 115
 116         OBD_SLAB_ALLOC_PTR_GFP(info, ccc_thread_kmem, GFP_NOFS);
 117         if (info == NULL)
 118                 info = ERR_PTR(-ENOMEM);
 119         return info;
 120 }
 121
 122 void ccc_key_fini(const struct lu_context *ctx,
 123                          struct lu_context_key *key, void *data)
 124 {
 125         struct ccc_thread_info *info = data;
 126         OBD_SLAB_FREE_PTR(info, ccc_thread_kmem);
 127 }
 128
 129 void *ccc_session_key_init(const struct lu_context *ctx,
 130                            struct lu_context_key *key)
 131 {
 132         struct ccc_session *session;
 133
 134         OBD_SLAB_ALLOC_PTR_GFP(session, ccc_session_kmem, GFP_NOFS);
 135         if (session == NULL)
 136                 session = ERR_PTR(-ENOMEM);
 137         return session;
 138 }
 139
 140 void ccc_session_key_fini(const struct lu_context *ctx,
 141                                  struct lu_context_key *key, void *data)
 142 {
 143         struct ccc_session *session = data;
 144         OBD_SLAB_FREE_PTR(session, ccc_session_kmem);
 145 }
 146
 147 struct lu_context_key ccc_key = {
 148         .lct_tags = LCT_CL_THREAD,
 149         .lct_init = ccc_key_init,
 150         .lct_fini = ccc_key_fini
 151 };
 152
 153 struct lu_context_key ccc_session_key = {
 154         .lct_tags = LCT_SESSION,
 155         .lct_init = ccc_session_key_init,
 156         .lct_fini = ccc_session_key_fini
 157 };
 158
 159
 160 /* type constructor/destructor: ccc_type_{init,fini,start,stop}(). */
 161 // LU_TYPE_INIT_FINI(ccc, &ccc_key, &ccc_session_key);
 162
 163 int ccc_device_init(const struct lu_env *env, struct lu_device *d,
 164                            const char *name, struct lu_device *next)
 165 {
 166         struct ccc_device  *vdv;
 167         int rc;
 168         ENTRY;
 169
 170         vdv = lu2ccc_dev(d);
 171         vdv->cdv_next = lu2cl_dev(next);
 172
 173         LASSERT(d->ld_site != NULL && next->ld_type != NULL);
 174         next->ld_site = d->ld_site;
 175         rc = next->ld_type->ldt_ops->ldto_device_init(
 176                         env, next, next->ld_type->ldt_name, NULL);
 177         if (rc == 0) {
 178                 lu_device_get(next);
 179                 lu_ref_add(&next->ld_reference, "lu-stack", &lu_site_init);
 180         }
 181         RETURN(rc);
 182 }
 183
 184 struct lu_device *ccc_device_fini(const struct lu_env *env,
 185                                          struct lu_device *d)
 186 {
 187         return cl2lu_dev(lu2ccc_dev(d)->cdv_next);
 188 }
 189
 190 struct lu_device *ccc_device_alloc(const struct lu_env *env,
 191                                    struct lu_device_type *t,
 192                                    struct lustre_cfg *cfg,
 193                                    const struct lu_device_operations *luops,
 194                                    const struct cl_device_operations *clops)
 195 {
 196         struct ccc_device *vdv;
 197         struct lu_device  *lud;
 198         struct cl_site    *site;
 199         int rc;
 200         ENTRY;
 201
 202         OBD_ALLOC_PTR(vdv);
 203         if (vdv == NULL)
 204                 RETURN(ERR_PTR(-ENOMEM));
 205
 206         lud = &vdv->cdv_cl.cd_lu_dev;
 207         cl_device_init(&vdv->cdv_cl, t);
 208         ccc2lu_dev(vdv)->ld_ops = luops;
 209         vdv->cdv_cl.cd_ops = clops;
 210
 211         OBD_ALLOC_PTR(site);
 212         if (site != NULL) {
 213                 rc = cl_site_init(site, &vdv->cdv_cl);
 214                 if (rc == 0)
 215                         rc = lu_site_init_finish(&site->cs_lu);
 216                 else {
 217                         LASSERT(lud->ld_site == NULL);
 218                         CERROR("Cannot init lu_site, rc %d.\n", rc);
 219                         OBD_FREE_PTR(site);
 220                 }
 221         } else
 222                 rc = -ENOMEM;
 223         if (rc != 0) {
 224                 ccc_device_free(env, lud);
 225                 lud = ERR_PTR(rc);
 226         }
 227         RETURN(lud);
 228 }
 229
 230 struct lu_device *ccc_device_free(const struct lu_env *env,
 231                                          struct lu_device *d)
 232 {
 233         struct ccc_device *vdv  = lu2ccc_dev(d);
 234         struct cl_site    *site = lu2cl_site(d->ld_site);
 235         struct lu_device  *next = cl2lu_dev(vdv->cdv_next);
 236
 237         if (d->ld_site != NULL) {
 238                 cl_site_fini(site);
 239                 OBD_FREE_PTR(site);
 240         }
 241         cl_device_fini(lu2cl_dev(d));
 242         OBD_FREE_PTR(vdv);
 243         return next;
 244 }
 245
 246 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
 247                  struct cl_req *req)
 248 {
 249         struct ccc_req *vrq;
 250         int result;
 251
 252         OBD_SLAB_ALLOC_PTR_GFP(vrq, ccc_req_kmem, GFP_NOFS);
 253         if (vrq != NULL) {
 254                 cl_req_slice_add(req, &vrq->crq_cl, dev, &ccc_req_ops);
 255                 result = 0;
 256         } else
 257                 result = -ENOMEM;
 258         return result;
 259 }
 260
 261 /**
 262  * An `emergency' environment used by ccc_inode_fini() when cl_env_get()
 263  * fails. Access to this environment is serialized by ccc_inode_fini_guard
 264  * mutex.
 265  */
 266 static struct lu_env *ccc_inode_fini_env = NULL;
 267
 268 /**
 269  * A mutex serializing calls to slp_inode_fini() under extreme memory
 270  * pressure, when environments cannot be allocated.
 271  */
 272 static DEFINE_MUTEX(ccc_inode_fini_guard);
 273 static int dummy_refcheck;
 274
 275 int ccc_global_init(struct lu_device_type *device_type)
 276 {
 277         int result;
 278
 279         result = lu_kmem_init(ccc_caches);
 280         if (result)
 281                 return result;
 282
 283         result = lu_device_type_init(device_type);
 284         if (result)
 285                 goto out_kmem;
 286
 287         ccc_inode_fini_env = cl_env_alloc(&dummy_refcheck,
 288                                           LCT_REMEMBER|LCT_NOREF);
 289         if (IS_ERR(ccc_inode_fini_env)) {
 290                 result = PTR_ERR(ccc_inode_fini_env);
 291                 goto out_device;
 292         }
 293
 294         ccc_inode_fini_env->le_ctx.lc_cookie = 0x4;
 295         return 0;
 296 out_device:
 297         lu_device_type_fini(device_type);
 298 out_kmem:
 299         lu_kmem_fini(ccc_caches);
 300         return result;
 301 }
 302
 303 void ccc_global_fini(struct lu_device_type *device_type)
 304 {
 305         if (ccc_inode_fini_env != NULL) {
 306                 cl_env_put(ccc_inode_fini_env, &dummy_refcheck);
 307                 ccc_inode_fini_env = NULL;
 308         }
 309         lu_device_type_fini(device_type);
 310         lu_kmem_fini(ccc_caches);
 311 }
 312
 313 /*****************************************************************************
 314  *
 315  * Object operations.
 316  *
 317  */
 318
 319 struct lu_object *ccc_object_alloc(const struct lu_env *env,
 320                                    const struct lu_object_header *unused,
 321                                    struct lu_device *dev,
 322                                    const struct cl_object_operations *clops,
 323                                    const struct lu_object_operations *luops)
 324 {
 325         struct ccc_object *vob;
 326         struct lu_object  *obj;
 327
 328         OBD_SLAB_ALLOC_PTR_GFP(vob, ccc_object_kmem, GFP_NOFS);
 329         if (vob != NULL) {
 330                 struct cl_object_header *hdr;
 331
 332                 obj = ccc2lu(vob);
 333                 hdr = &vob->cob_header;
 334                 cl_object_header_init(hdr);
 335                 hdr->coh_page_bufsize = cfs_size_round(sizeof(struct cl_page));
 336
 337                 lu_object_init(obj, &hdr->coh_lu, dev);
 338                 lu_object_add_top(&hdr->coh_lu, obj);
 339
 340                 vob->cob_cl.co_ops = clops;
 341                 obj->lo_ops = luops;
 342         } else
 343                 obj = NULL;
 344         return obj;
 345 }
 346
 347 int ccc_object_init0(const struct lu_env *env,
 348                      struct ccc_object *vob,
 349                      const struct cl_object_conf *conf)
 350 {
 351         vob->cob_inode = conf->coc_inode;
 352         atomic_set(&vob->cob_transient_pages, 0);
 353         cl_object_page_init(&vob->cob_cl, sizeof(struct ccc_page));
 354         return 0;
 355 }
 356
 357 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
 358                            const struct lu_object_conf *conf)
 359 {
 360         struct ccc_device *dev = lu2ccc_dev(obj->lo_dev);
 361         struct ccc_object *vob = lu2ccc(obj);
 362         struct lu_object  *below;
 363         struct lu_device  *under;
 364         int result;
 365
 366         under = &dev->cdv_next->cd_lu_dev;
 367         below = under->ld_ops->ldo_object_alloc(env, obj->lo_header, under);
 368         if (below != NULL) {
 369                 const struct cl_object_conf *cconf;
 370
 371                 cconf = lu2cl_conf(conf);
 372                 INIT_LIST_HEAD(&vob->cob_pending_list);
 373                 lu_object_add(obj, below);
 374                 result = ccc_object_init0(env, vob, cconf);
 375         } else
 376                 result = -ENOMEM;
 377         return result;
 378 }
 379
 380 void ccc_object_free(const struct lu_env *env, struct lu_object *obj)
 381 {
 382         struct ccc_object *vob = lu2ccc(obj);
 383
 384         lu_object_fini(obj);
 385         lu_object_header_fini(obj->lo_header);
 386         OBD_SLAB_FREE_PTR(vob, ccc_object_kmem);
 387 }
 388
 389 int ccc_lock_init(const struct lu_env *env,
 390                   struct cl_object *obj, struct cl_lock *lock,
 391                   const struct cl_io *unused,
 392                   const struct cl_lock_operations *lkops)
 393 {
 394         struct ccc_lock *clk;
 395         int result;
 396
 397         CLOBINVRNT(env, obj, ccc_object_invariant(obj));
 398
 399         OBD_SLAB_ALLOC_PTR_GFP(clk, ccc_lock_kmem, GFP_NOFS);
 400         if (clk != NULL) {
 401                 cl_lock_slice_add(lock, &clk->clk_cl, obj, lkops);
 402                 result = 0;
 403         } else
 404                 result = -ENOMEM;
 405         return result;
 406 }
 407
 408 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
 409                  const struct cl_attr *attr, unsigned valid)
 410 {
 411         return 0;
 412 }
 413
 414 int ccc_object_glimpse(const struct lu_env *env,
 415                        const struct cl_object *obj, struct ost_lvb *lvb)
 416 {
 417         struct inode *inode = ccc_object_inode(obj);
 418
 419         ENTRY;
 420         lvb->lvb_mtime = cl_inode_mtime(inode);
 421         lvb->lvb_atime = cl_inode_atime(inode);
 422         lvb->lvb_ctime = cl_inode_ctime(inode);
 423         /*
 424          * LU-417: Add dirty pages block count lest i_blocks reports 0, some
 425          * "cp" or "tar" on remote node may think it's a completely sparse file
 426          * and skip it.
 427          */
 428         if (lvb->lvb_size > 0 && lvb->lvb_blocks == 0)
 429                 lvb->lvb_blocks = dirty_cnt(inode);
 430         RETURN(0);
 431 }
 432
 433
 434
 435 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
 436                         const struct cl_object_conf *conf)
 437 {
 438         /* TODO: destroy all pages attached to this object. */
 439         return 0;
 440 }
 441
 442 static void ccc_object_size_lock(struct cl_object *obj)
 443 {
 444         struct inode *inode = ccc_object_inode(obj);
 445
 446         cl_isize_lock(inode);
 447         cl_object_attr_lock(obj);
 448 }
 449
 450 static void ccc_object_size_unlock(struct cl_object *obj)
 451 {
 452         struct inode *inode = ccc_object_inode(obj);
 453
 454         cl_object_attr_unlock(obj);
 455         cl_isize_unlock(inode);
 456 }
 457
 458 /*****************************************************************************
 459  *
 460  * Page operations.
 461  *
 462  */
 463
 464 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice)
 465 {
 466         /*
 467          * Cached read?
 468          */
 469         LBUG();
 470         return 0;
 471 }
 472
 473 void ccc_transient_page_verify(const struct cl_page *page)
 474 {
 475 }
 476
 477 int ccc_transient_page_own(const struct lu_env *env,
 478                                    const struct cl_page_slice *slice,
 479                                    struct cl_io *unused,
 480                                    int nonblock)
 481 {
 482         ccc_transient_page_verify(slice->cpl_page);
 483         return 0;
 484 }
 485
 486 void ccc_transient_page_assume(const struct lu_env *env,
 487                                       const struct cl_page_slice *slice,
 488                                       struct cl_io *unused)
 489 {
 490         ccc_transient_page_verify(slice->cpl_page);
 491 }
 492
 493 void ccc_transient_page_unassume(const struct lu_env *env,
 494                                         const struct cl_page_slice *slice,
 495                                         struct cl_io *unused)
 496 {
 497         ccc_transient_page_verify(slice->cpl_page);
 498 }
 499
 500 void ccc_transient_page_disown(const struct lu_env *env,
 501                                       const struct cl_page_slice *slice,
 502                                       struct cl_io *unused)
 503 {
 504         ccc_transient_page_verify(slice->cpl_page);
 505 }
 506
 507 void ccc_transient_page_discard(const struct lu_env *env,
 508                                        const struct cl_page_slice *slice,
 509                                        struct cl_io *unused)
 510 {
 511         struct cl_page *page = slice->cpl_page;
 512
 513         ccc_transient_page_verify(slice->cpl_page);
 514
 515         /*
 516          * For transient pages, remove it from the radix tree.
 517          */
 518         cl_page_delete(env, page);
 519 }
 520
 521 int ccc_transient_page_prep(const struct lu_env *env,
 522                                    const struct cl_page_slice *slice,
 523                                    struct cl_io *unused)
 524 {
 525         ENTRY;
 526         /* transient page should always be sent. */
 527         RETURN(0);
 528 }
 529
 530 /*****************************************************************************
 531  *
 532  * Lock operations.
 533  *
 534  */
 535
 536 void ccc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice)
 537 {
 538         struct ccc_lock *clk = cl2ccc_lock(slice);
 539         OBD_SLAB_FREE_PTR(clk, ccc_lock_kmem);
 540 }
 541
 542 int ccc_lock_enqueue(const struct lu_env *env,
 543                      const struct cl_lock_slice *slice,
 544                      struct cl_io *unused, struct cl_sync_io *anchor)
 545 {
 546         CLOBINVRNT(env, slice->cls_obj, ccc_object_invariant(slice->cls_obj));
 547         return 0;
 548 }
 549
 550 /*****************************************************************************
 551  *
 552  * io operations.
 553  *
 554  */
 555
 556 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios)
 557 {
 558         struct cl_io *io = ios->cis_io;
 559
 560         CLOBINVRNT(env, io->ci_obj, ccc_object_invariant(io->ci_obj));
 561 }
 562
 563 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
 564                           __u32 enqflags, enum cl_lock_mode mode,
 565                           pgoff_t start, pgoff_t end)
 566 {
 567         struct ccc_io          *cio   = ccc_env_io(env);
 568         struct cl_lock_descr   *descr = &cio->cui_link.cill_descr;
 569         struct cl_object       *obj   = io->ci_obj;
 570
 571         CLOBINVRNT(env, obj, ccc_object_invariant(obj));
 572         ENTRY;
 573
 574         CDEBUG(D_VFSTRACE, "lock: %d [%lu, %lu]\n", mode, start, end);
 575
 576         memset(&cio->cui_link, 0, sizeof cio->cui_link);
 577
 578         if (cio->cui_fd && (cio->cui_fd->fd_flags & LL_FILE_GROUP_LOCKED)) {
 579                 descr->cld_mode = CLM_GROUP;
 580                 descr->cld_gid  = cio->cui_fd->fd_grouplock.cg_gid;
 581         } else {
 582                 descr->cld_mode  = mode;
 583         }
 584         descr->cld_obj   = obj;
 585         descr->cld_start = start;
 586         descr->cld_end   = end;
 587         descr->cld_enq_flags = enqflags;
 588
 589         cl_io_lock_add(env, io, &cio->cui_link);
 590         RETURN(0);
 591 }
 592
 593 void ccc_io_update_iov(const struct lu_env *env,
 594                        struct ccc_io *cio, struct cl_io *io)
 595 {
 596         int i;
 597         size_t size = io->u.ci_rw.crw_count;
 598
 599         cio->cui_iov_olen = 0;
 600         if (!cl_is_normalio(env, io) || cio->cui_tot_nrsegs == 0)
 601                 return;
 602
 603         for (i = 0; i < cio->cui_tot_nrsegs; i++) {
 604                 struct iovec *iv = &cio->cui_iov[i];
 605
 606                 if (iv->iov_len < size)
 607                         size -= iv->iov_len;
 608                 else {
 609                         if (iv->iov_len > size) {
 610                                 cio->cui_iov_olen = iv->iov_len;
 611                                 iv->iov_len = size;
 612                         }
 613                         break;
 614                 }
 615         }
 616
 617         cio->cui_nrsegs = i + 1;
 618         LASSERTF(cio->cui_tot_nrsegs >= cio->cui_nrsegs,
 619                  "tot_nrsegs: %lu, nrsegs: %lu\n",
 620                  cio->cui_tot_nrsegs, cio->cui_nrsegs);
 621 }
 622
 623 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
 624                     __u32 enqflags, enum cl_lock_mode mode,
 625                     loff_t start, loff_t end)
 626 {
 627         struct cl_object *obj = io->ci_obj;
 628         return ccc_io_one_lock_index(env, io, enqflags, mode,
 629                                      cl_index(obj, start), cl_index(obj, end));
 630 }
 631
 632 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios)
 633 {
 634         CLOBINVRNT(env, ios->cis_io->ci_obj,
 635                    ccc_object_invariant(ios->cis_io->ci_obj));
 636 }
 637
 638 void ccc_io_advance(const struct lu_env *env,
 639                     const struct cl_io_slice *ios,
 640                     size_t nob)
 641 {
 642         struct ccc_io    *cio = cl2ccc_io(env, ios);
 643         struct cl_io     *io  = ios->cis_io;
 644         struct cl_object *obj = ios->cis_io->ci_obj;
 645
 646         CLOBINVRNT(env, obj, ccc_object_invariant(obj));
 647
 648         if (!cl_is_normalio(env, io))
 649                 return;
 650
 651         LASSERT(cio->cui_tot_nrsegs >= cio->cui_nrsegs);
 652         LASSERT(cio->cui_tot_count  >= nob);
 653
 654         cio->cui_iov        += cio->cui_nrsegs;
 655         cio->cui_tot_nrsegs -= cio->cui_nrsegs;
 656         cio->cui_tot_count  -= nob;
 657
 658         /* update the iov */
 659         if (cio->cui_iov_olen > 0) {
 660                 struct iovec *iv;
 661
 662                 cio->cui_iov--;
 663                 cio->cui_tot_nrsegs++;
 664                 iv = &cio->cui_iov[0];
 665                 if (io->ci_continue) {
 666                         iv->iov_base += iv->iov_len;
 667                         LASSERT(cio->cui_iov_olen > iv->iov_len);
 668                         iv->iov_len = cio->cui_iov_olen - iv->iov_len;
 669                 } else {
 670                         /* restore the iov_len, in case of restart io. */
 671                         iv->iov_len = cio->cui_iov_olen;
 672                 }
 673                 cio->cui_iov_olen = 0;
 674         }
 675 }
 676
 677 /**
 678  * Helper function that if necessary adjusts file size (inode->i_size), when
 679  * position at the offset \a pos is accessed. File size can be arbitrary stale
 680  * on a Lustre client, but client at least knows KMS. If accessed area is
 681  * inside [0, KMS], set file size to KMS, otherwise glimpse file size.
 682  *
 683  * Locking: cl_isize_lock is used to serialize changes to inode size and to
 684  * protect consistency between inode size and cl_object
 685  * attributes. cl_object_size_lock() protects consistency between cl_attr's of
 686  * top-object and sub-objects.
 687  */
 688 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
 689                   struct cl_io *io, loff_t start, size_t count, int *exceed)
 690 {
 691         struct cl_attr *attr  = ccc_env_thread_attr(env);
 692         struct inode   *inode = ccc_object_inode(obj);
 693         loff_t          pos   = start + count - 1;
 694         loff_t kms;
 695         int result;
 696
 697         /*
 698          * Consistency guarantees: following possibilities exist for the
 699          * relation between region being accessed and real file size at this
 700          * moment:
 701          *
 702          *  (A): the region is completely inside of the file;
 703          *
 704          *  (B-x): x bytes of region are inside of the file, the rest is
 705          *  outside;
 706          *
 707          *  (C): the region is completely outside of the file.
 708          *
 709          * This classification is stable under DLM lock already acquired by
 710          * the caller, because to change the class, other client has to take
 711          * DLM lock conflicting with our lock. Also, any updates to ->i_size
 712          * by other threads on this client are serialized by
 713          * ll_inode_size_lock(). This guarantees that short reads are handled
 714          * correctly in the face of concurrent writes and truncates.
 715          */
 716         ccc_object_size_lock(obj);
 717         result = cl_object_attr_get(env, obj, attr);
 718         if (result == 0) {
 719                 kms = attr->cat_kms;
 720                 if (pos > kms) {
 721                         /*
 722                          * A glimpse is necessary to determine whether we
 723                          * return a short read (B) or some zeroes at the end
 724                          * of the buffer (C)
 725                          */
 726                         ccc_object_size_unlock(obj);
 727                         result = cl_glimpse_lock(env, io, inode, obj, 0);
 728                         if (result == 0 && exceed != NULL) {
 729                                 /* If objective page index exceed end-of-file
 730                                  * page index, return directly. Do not expect
 731                                  * kernel will check such case correctly.
 732                                  * linux-2.6.18-128.1.1 miss to do that.
 733                                  * --bug 17336 */
 734                                 loff_t size = cl_isize_read(inode);
 735                                 unsigned long cur_index = start >>
 736                                                           PAGE_CACHE_SHIFT;
 737
 738                                 if ((size == 0 && cur_index != 0) ||
 739                                     (((size - 1) >> PAGE_CACHE_SHIFT) <
 740                                      cur_index))
 741                                 *exceed = 1;
 742                         }
 743                         return result;
 744                 } else {
 745                         /*
 746                          * region is within kms and, hence, within real file
 747                          * size (A). We need to increase i_size to cover the
 748                          * read region so that generic_file_read() will do its
 749                          * job, but that doesn't mean the kms size is
 750                          * _correct_, it is only the _minimum_ size. If
 751                          * someone does a stat they will get the correct size
 752                          * which will always be >= the kms value here.
 753                          * b=11081
 754                          */
 755                         if (cl_isize_read(inode) < kms) {
 756                                 cl_isize_write_nolock(inode, kms);
 757                                 CDEBUG(D_VFSTRACE,
 758                                        DFID" updating i_size "LPU64"\n",
 759                                        PFID(lu_object_fid(&obj->co_lu)),
 760                                        (__u64)cl_isize_read(inode));
 761
 762                         }
 763                 }
 764         }
 765         ccc_object_size_unlock(obj);
 766         return result;
 767 }
 768
 769 /*****************************************************************************
 770  *
 771  * Transfer operations.
 772  *
 773  */
 774
 775 void ccc_req_completion(const struct lu_env *env,
 776                         const struct cl_req_slice *slice, int ioret)
 777 {
 778         struct ccc_req *vrq;
 779
 780         if (ioret > 0)
 781                 cl_stats_tally(slice->crs_dev, slice->crs_req->crq_type, ioret);
 782
 783         vrq = cl2ccc_req(slice);
 784         OBD_SLAB_FREE_PTR(vrq, ccc_req_kmem);
 785 }
 786
 787 /**
 788  * Implementation of struct cl_req_operations::cro_attr_set() for ccc
 789  * layer. ccc is responsible for
 790  *
 791  *    - o_[mac]time
 792  *
 793  *    - o_mode
 794  *
 795  *    - o_parent_seq
 796  *
 797  *    - o_[ug]id
 798  *
 799  *    - o_parent_oid
 800  *
 801  *    - o_parent_ver
 802  *
 803  *    - o_ioepoch,
 804  *
 805  *  and capability.
 806  */
 807 void ccc_req_attr_set(const struct lu_env *env,
 808                       const struct cl_req_slice *slice,
 809                       const struct cl_object *obj,
 810                       struct cl_req_attr *attr, obd_valid flags)
 811 {
 812         struct inode *inode;
 813         struct obdo  *oa;
 814         obd_flag      valid_flags;
 815
 816         oa = attr->cra_oa;
 817         inode = ccc_object_inode(obj);
 818         valid_flags = OBD_MD_FLTYPE;
 819
 820         if ((flags & OBD_MD_FLOSSCAPA) != 0) {
 821                 LASSERT(attr->cra_capa == NULL);
 822                 attr->cra_capa = cl_capa_lookup(inode,
 823                                                 slice->crs_req->crq_type);
 824         }
 825
 826         if (slice->crs_req->crq_type == CRT_WRITE) {
 827                 if (flags & OBD_MD_FLEPOCH) {
 828                         oa->o_valid |= OBD_MD_FLEPOCH;
 829                         oa->o_ioepoch = cl_i2info(inode)->lli_ioepoch;
 830                         valid_flags |= OBD_MD_FLMTIME | OBD_MD_FLCTIME |
 831                                        OBD_MD_FLUID | OBD_MD_FLGID;
 832                 }
 833         }
 834         obdo_from_inode(oa, inode, valid_flags & flags);
 835         obdo_set_parent_fid(oa, &cl_i2info(inode)->lli_fid);
 836         if (OBD_FAIL_CHECK(OBD_FAIL_LFSCK_INVALID_PFID))
 837                 oa->o_parent_oid++;
 838         memcpy(attr->cra_jobid, cl_i2info(inode)->lli_jobid,
 839                LUSTRE_JOBID_SIZE);
 840 }
 841
 842 static const struct cl_req_operations ccc_req_ops = {
 843         .cro_attr_set   = ccc_req_attr_set,
 844         .cro_completion = ccc_req_completion
 845 };
 846
 847 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
 848                    struct obd_capa *capa)
 849 {
 850         struct lu_env *env;
 851         struct cl_io  *io;
 852         int            result;
 853         int            refcheck;
 854
 855         ENTRY;
 856
 857         env = cl_env_get(&refcheck);
 858         if (IS_ERR(env))
 859                 RETURN(PTR_ERR(env));
 860
 861         io = ccc_env_thread_io(env);
 862         io->ci_obj = cl_i2info(inode)->lli_clob;
 863
 864         io->u.ci_setattr.sa_attr.lvb_atime = LTIME_S(attr->ia_atime);
 865         io->u.ci_setattr.sa_attr.lvb_mtime = LTIME_S(attr->ia_mtime);
 866         io->u.ci_setattr.sa_attr.lvb_ctime = LTIME_S(attr->ia_ctime);
 867         io->u.ci_setattr.sa_attr.lvb_size = attr->ia_size;
 868         io->u.ci_setattr.sa_valid = attr->ia_valid;
 869         io->u.ci_setattr.sa_capa = capa;
 870
 871 again:
 872         if (cl_io_init(env, io, CIT_SETATTR, io->ci_obj) == 0) {
 873                 struct ccc_io *cio = ccc_env_io(env);
 874
 875                 if (attr->ia_valid & ATTR_FILE)
 876                         /* populate the file descriptor for ftruncate to honor
 877                          * group lock - see LU-787 */
 878                         cio->cui_fd = cl_iattr2fd(inode, attr);
 879
 880                 result = cl_io_loop(env, io);
 881         } else {
 882                 result = io->ci_result;
 883         }
 884         cl_io_fini(env, io);
 885         if (unlikely(io->ci_need_restart))
 886                 goto again;
 887         /* HSM import case: file is released, cannot be restored
 888          * no need to fail except if restore registration failed
 889          * with -ENODATA */
 890         if (result == -ENODATA && io->ci_restore_needed &&
 891             io->ci_result != -ENODATA)
 892                 result = 0;
 893         cl_env_put(env, &refcheck);
 894         RETURN(result);
 895 }
 896
 897 /*****************************************************************************
 898  *
 899  * Type conversions.
 900  *
 901  */
 902
 903 struct lu_device *ccc2lu_dev(struct ccc_device *vdv)
 904 {
 905         return &vdv->cdv_cl.cd_lu_dev;
 906 }
 907
 908 struct ccc_device *lu2ccc_dev(const struct lu_device *d)
 909 {
 910         return container_of0(d, struct ccc_device, cdv_cl.cd_lu_dev);
 911 }
 912
 913 struct ccc_device *cl2ccc_dev(const struct cl_device *d)
 914 {
 915         return container_of0(d, struct ccc_device, cdv_cl);
 916 }
 917
 918 struct lu_object *ccc2lu(struct ccc_object *vob)
 919 {
 920         return &vob->cob_cl.co_lu;
 921 }
 922
 923 struct ccc_object *lu2ccc(const struct lu_object *obj)
 924 {
 925         return container_of0(obj, struct ccc_object, cob_cl.co_lu);
 926 }
 927
 928 struct ccc_object *cl2ccc(const struct cl_object *obj)
 929 {
 930         return container_of0(obj, struct ccc_object, cob_cl);
 931 }
 932
 933 struct ccc_lock *cl2ccc_lock(const struct cl_lock_slice *slice)
 934 {
 935         return container_of(slice, struct ccc_lock, clk_cl);
 936 }
 937
 938 struct ccc_io *cl2ccc_io(const struct lu_env *env,
 939                          const struct cl_io_slice *slice)
 940 {
 941         struct ccc_io *cio;
 942
 943         cio = container_of(slice, struct ccc_io, cui_cl);
 944         LASSERT(cio == ccc_env_io(env));
 945         return cio;
 946 }
 947
 948 struct ccc_req *cl2ccc_req(const struct cl_req_slice *slice)
 949 {
 950         return container_of0(slice, struct ccc_req, crq_cl);
 951 }
 952
 953 struct page *cl2vm_page(const struct cl_page_slice *slice)
 954 {
 955         return cl2ccc_page(slice)->cpg_page;
 956 }
 957
 958 /*****************************************************************************
 959  *
 960  * Accessors.
 961  *
 962  */
 963 int ccc_object_invariant(const struct cl_object *obj)
 964 {
 965         struct inode         *inode = ccc_object_inode(obj);
 966         struct cl_inode_info *lli   = cl_i2info(inode);
 967
 968         return (S_ISREG(cl_inode_mode(inode)) ||
 969                 /* i_mode of unlinked inode is zeroed. */
 970                 cl_inode_mode(inode) == 0) && lli->lli_clob == obj;
 971 }
 972
 973 struct inode *ccc_object_inode(const struct cl_object *obj)
 974 {
 975         return cl2ccc(obj)->cob_inode;
 976 }
 977
 978 /**
 979  * Returns a pointer to cl_page associated with \a vmpage, without acquiring
 980  * additional reference to the resulting page. This is an unsafe version of
 981  * cl_vmpage_page() that can only be used under vmpage lock.
 982  */
 983 struct cl_page *ccc_vmpage_page_transient(struct page *vmpage)
 984 {
 985         KLASSERT(PageLocked(vmpage));
 986         return (struct cl_page *)vmpage->private;
 987 }
 988
 989 /**
 990  * Initialize or update CLIO structures for regular files when new
 991  * meta-data arrives from the server.
 992  *
 993  * \param inode regular file inode
 994  * \param md    new file metadata from MDS
 995  * - allocates cl_object if necessary,
 996  * - updated layout, if object was already here.
 997  */
 998 int cl_file_inode_init(struct inode *inode, struct lustre_md *md)
 999 {
1000         struct lu_env        *env;
1001         struct cl_inode_info *lli;
1002         struct cl_object     *clob;
1003         struct lu_site       *site;
1004         struct lu_fid        *fid;
1005         struct cl_object_conf conf = {
1006                 .coc_inode = inode,
1007                 .u = {
1008                         .coc_md    = md
1009                 }
1010         };
1011         int result = 0;
1012         int refcheck;
1013
1014         LASSERT(md->body->mbo_valid & OBD_MD_FLID);
1015         LASSERT(S_ISREG(cl_inode_mode(inode)));
1016
1017         env = cl_env_get(&refcheck);
1018         if (IS_ERR(env))
1019                 return PTR_ERR(env);
1020
1021         site = cl_i2sbi(inode)->ll_site;
1022         lli  = cl_i2info(inode);
1023         fid  = &lli->lli_fid;
1024         LASSERT(fid_is_sane(fid));
1025
1026         if (lli->lli_clob == NULL) {
1027                 /* clob is slave of inode, empty lli_clob means for new inode,
1028                  * there is no clob in cache with the given fid, so it is
1029                  * unnecessary to perform lookup-alloc-lookup-insert, just
1030                  * alloc and insert directly. */
1031                 LASSERT(inode->i_state & I_NEW);
1032                 conf.coc_lu.loc_flags = LOC_F_NEW;
1033                 clob = cl_object_find(env, lu2cl_dev(site->ls_top_dev),
1034                                       fid, &conf);
1035                 if (!IS_ERR(clob)) {
1036                         /*
1037                          * No locking is necessary, as new inode is
1038                          * locked by I_NEW bit.
1039                          */
1040                         lli->lli_clob = clob;
1041                         lli->lli_has_smd = lsm_has_objects(md->lsm);
1042                         lu_object_ref_add(&clob->co_lu, "inode", inode);
1043                 } else
1044                         result = PTR_ERR(clob);
1045         } else {
1046                 result = cl_conf_set(env, lli->lli_clob, &conf);
1047         }
1048
1049         cl_env_put(env, &refcheck);
1050
1051         if (result != 0)
1052                 CERROR("Failure to initialize cl object "DFID": %d\n",
1053                        PFID(fid), result);
1054         return result;
1055 }
1056
1057 /**
1058  * Wait for others drop their references of the object at first, then we drop
1059  * the last one, which will lead to the object be destroyed immediately.
1060  * Must be called after cl_object_kill() against this object.
1061  *
1062  * The reason we want to do this is: destroying top object will wait for sub
1063  * objects being destroyed first, so we can't let bottom layer (e.g. from ASTs)
1064  * to initiate top object destroying which may deadlock. See bz22520.
1065  */
1066 static void cl_object_put_last(struct lu_env *env, struct cl_object *obj)
1067 {
1068         struct lu_object_header *header = obj->co_lu.lo_header;
1069         wait_queue_t           waiter;
1070
1071         if (unlikely(atomic_read(&header->loh_ref) != 1)) {
1072                 struct lu_site *site = obj->co_lu.lo_dev->ld_site;
1073                 struct lu_site_bkt_data *bkt;
1074
1075                 bkt = lu_site_bkt_from_fid(site, &header->loh_fid);
1076
1077                 init_waitqueue_entry_current(&waiter);
1078                 add_wait_queue(&bkt->lsb_marche_funebre, &waiter);
1079
1080                 while (1) {
1081                         set_current_state(TASK_UNINTERRUPTIBLE);
1082                         if (atomic_read(&header->loh_ref) == 1)
1083                                 break;
1084                         waitq_wait(&waiter, TASK_UNINTERRUPTIBLE);
1085                 }
1086
1087                 set_current_state(TASK_RUNNING);
1088                 remove_wait_queue(&bkt->lsb_marche_funebre, &waiter);
1089         }
1090
1091         cl_object_put(env, obj);
1092 }
1093
1094 void cl_inode_fini(struct inode *inode)
1095 {
1096         struct lu_env           *env;
1097         struct cl_inode_info    *lli  = cl_i2info(inode);
1098         struct cl_object        *clob = lli->lli_clob;
1099         int refcheck;
1100         int emergency;
1101
1102         if (clob != NULL) {
1103                 void                    *cookie;
1104
1105                 cookie = cl_env_reenter();
1106                 env = cl_env_get(&refcheck);
1107                 emergency = IS_ERR(env);
1108                 if (emergency) {
1109                         mutex_lock(&ccc_inode_fini_guard);
1110                         LASSERT(ccc_inode_fini_env != NULL);
1111                         cl_env_implant(ccc_inode_fini_env, &refcheck);
1112                         env = ccc_inode_fini_env;
1113                 }
1114                 /*
1115                  * cl_object cache is a slave to inode cache (which, in turn
1116                  * is a slave to dentry cache), don't keep cl_object in memory
1117                  * when its master is evicted.
1118                  */
1119                 cl_object_kill(env, clob);
1120                 lu_object_ref_del(&clob->co_lu, "inode", inode);
1121                 cl_object_put_last(env, clob);
1122                 lli->lli_clob = NULL;
1123                 if (emergency) {
1124                         cl_env_unplant(ccc_inode_fini_env, &refcheck);
1125                         mutex_unlock(&ccc_inode_fini_guard);
1126                 } else
1127                         cl_env_put(env, &refcheck);
1128                 cl_env_reexit(cookie);
1129         }
1130 }
1131
1132 /**
1133  * return IF_* type for given lu_dirent entry.
1134  * IF_* flag shld be converted to particular OS file type in
1135  * platform llite module.
1136  */
1137 __u16 ll_dirent_type_get(struct lu_dirent *ent)
1138 {
1139         __u16 type = 0;
1140         struct luda_type *lt;
1141         int len = 0;
1142
1143         if (le32_to_cpu(ent->lde_attrs) & LUDA_TYPE) {
1144                 const unsigned align = sizeof(struct luda_type) - 1;
1145
1146                 len = le16_to_cpu(ent->lde_namelen);
1147                 len = (len + align) & ~align;
1148                 lt = (void *)ent->lde_name + len;
1149                 type = IFTODT(le16_to_cpu(lt->lt_type));
1150         }
1151         return type;
1152 }
1153
1154 /**
1155  * build inode number from passed @fid */
1156 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32)
1157 {
1158         if (BITS_PER_LONG == 32 || api32)
1159                 RETURN(fid_flatten32(fid));
1160         else
1161                 RETURN(fid_flatten(fid));
1162 }
1163
1164 /**
1165  * build inode generation from passed @fid.  If our FID overflows the 32-bit
1166  * inode number then return a non-zero generation to distinguish them. */
1167 __u32 cl_fid_build_gen(const struct lu_fid *fid)
1168 {
1169         __u32 gen;
1170         ENTRY;
1171
1172         if (fid_is_igif(fid)) {
1173                 gen = lu_igif_gen(fid);
1174                 RETURN(gen);
1175         }
1176
1177         gen = (fid_flatten(fid) >> 32);
1178         RETURN(gen);
1179 }
1180
1181 /* lsm is unreliable after hsm implementation as layout can be changed at
1182  * any time. This is only to support old, non-clio-ized interfaces. It will
1183  * cause deadlock if clio operations are called with this extra layout refcount
1184  * because in case the layout changed during the IO, ll_layout_refresh() will
1185  * have to wait for the refcount to become zero to destroy the older layout.
1186  *
1187  * Notice that the lsm returned by this function may not be valid unless called
1188  * inside layout lock - MDS_INODELOCK_LAYOUT. */
1189 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode)
1190 {
1191         return lov_lsm_get(cl_i2info(inode)->lli_clob);
1192 }
1193
1194 void inline ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm)
1195 {
1196         lov_lsm_put(cl_i2info(inode)->lli_clob, lsm);
1197 }