lustre/lclient/lcommon_cl.c

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