lustre/obdclass/cl_object.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  *
  31  * Client Lustre Object.
  32  *
  33  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  34  *   Author: Jinshan Xiong <jinshan.xiong@intel.com>
  35  */
  36
  37 /*
  38  * Locking.
  39  *
  40  *  i_mutex
  41  *      PG_locked
  42  *          ->coh_attr_guard
  43  *          ->ls_guard
  44  */
  45
  46 #define DEBUG_SUBSYSTEM S_CLASS
  47
  48 #include <linux/list.h>
  49 #include <libcfs/libcfs.h>
  50 #include <obd_class.h>
  51 #include <obd_support.h>
  52 #include <lustre_fid.h>
  53 #include <cl_object.h>
  54 #include <lu_object.h>
  55 #include "cl_internal.h"
  56
  57 static struct kmem_cache *cl_env_kmem;
  58 struct kmem_cache *cl_dio_aio_kmem;
  59 struct kmem_cache *cl_page_kmem_array[16];
  60 unsigned short cl_page_kmem_size_array[16];
  61
  62 /** Lock class of cl_object_header::coh_attr_guard */
  63 static struct lock_class_key cl_attr_guard_class;
  64
  65 /**
  66  * Initialize cl_object_header.
  67  */
  68 int cl_object_header_init(struct cl_object_header *h)
  69 {
  70         int result;
  71
  72         ENTRY;
  73         result = lu_object_header_init(&h->coh_lu);
  74         if (result == 0) {
  75                 spin_lock_init(&h->coh_attr_guard);
  76                 lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
  77                 h->coh_page_bufsize = 0;
  78         }
  79         RETURN(result);
  80 }
  81 EXPORT_SYMBOL(cl_object_header_init);
  82
  83 /**
  84  * Finalize cl_object_header.
  85  */
  86 void cl_object_header_fini(struct cl_object_header *h)
  87 {
  88         lu_object_header_fini(&h->coh_lu);
  89 }
  90
  91 /**
  92  * Returns a cl_object with a given \a fid.
  93  *
  94  * Returns either cached or newly created object. Additional reference on the
  95  * returned object is acquired.
  96  *
  97  * \see lu_object_find(), cl_page_find(), cl_lock_find()
  98  */
  99 struct cl_object *cl_object_find(const struct lu_env *env,
 100                                  struct cl_device *cd, const struct lu_fid *fid,
 101                                  const struct cl_object_conf *c)
 102 {
 103         might_sleep();
 104         return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
 105 }
 106 EXPORT_SYMBOL(cl_object_find);
 107
 108 /**
 109  * Releases a reference on \a o.
 110  *
 111  * When last reference is released object is returned to the cache, unless
 112  * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
 113  *
 114  * \see cl_page_put(), cl_lock_put().
 115  */
 116 void cl_object_put(const struct lu_env *env, struct cl_object *o)
 117 {
 118         lu_object_put(env, &o->co_lu);
 119 }
 120 EXPORT_SYMBOL(cl_object_put);
 121
 122 /**
 123  * Acquire an additional reference to the object \a o.
 124  *
 125  * This can only be used to acquire _additional_ reference, i.e., caller
 126  * already has to possess at least one reference to \a o before calling this.
 127  *
 128  * \see cl_page_get(), cl_lock_get().
 129  */
 130 void cl_object_get(struct cl_object *o)
 131 {
 132         lu_object_get(&o->co_lu);
 133 }
 134 EXPORT_SYMBOL(cl_object_get);
 135
 136 /**
 137  * Returns the top-object for a given \a o.
 138  *
 139  * \see cl_io_top()
 140  */
 141 struct cl_object *cl_object_top(struct cl_object *o)
 142 {
 143         struct cl_object_header *hdr = cl_object_header(o);
 144         struct cl_object *top;
 145
 146         while (hdr->coh_parent != NULL)
 147                 hdr = hdr->coh_parent;
 148
 149         top = lu2cl(lu_object_top(&hdr->coh_lu));
 150         CDEBUG(D_TRACE, "%p -> %p\n", o, top);
 151         return top;
 152 }
 153 EXPORT_SYMBOL(cl_object_top);
 154
 155 /**
 156  * Returns pointer to the lock protecting data-attributes for the given object
 157  * \a o.
 158  *
 159  * Data-attributes are protected by the cl_object_header::coh_attr_guard
 160  * spin-lock in the top-object.
 161  *
 162  * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
 163  */
 164 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
 165 {
 166         return &cl_object_header(cl_object_top(o))->coh_attr_guard;
 167 }
 168
 169 /**
 170  * Locks data-attributes.
 171  *
 172  * Prevents data-attributes from changing, until lock is released by
 173  * cl_object_attr_unlock(). This has to be called before calls to
 174  * cl_object_attr_get(), cl_object_attr_update().
 175  */
 176 void cl_object_attr_lock(struct cl_object *o)
 177 __acquires(cl_object_attr_guard(o))
 178 {
 179         spin_lock(cl_object_attr_guard(o));
 180 }
 181 EXPORT_SYMBOL(cl_object_attr_lock);
 182
 183 /**
 184  * Releases data-attributes lock, acquired by cl_object_attr_lock().
 185  */
 186 void cl_object_attr_unlock(struct cl_object *o)
 187 __releases(cl_object_attr_guard(o))
 188 {
 189         spin_unlock(cl_object_attr_guard(o));
 190 }
 191 EXPORT_SYMBOL(cl_object_attr_unlock);
 192
 193 /**
 194  * Returns data-attributes of an object \a obj.
 195  *
 196  * Every layer is asked (by calling cl_object_operations::coo_attr_get())
 197  * top-to-bottom to fill in parts of \a attr that this layer is responsible
 198  * for.
 199  */
 200 int cl_object_attr_get(const struct lu_env *env, struct cl_object *top,
 201                         struct cl_attr *attr)
 202 {
 203         struct cl_object *obj;
 204         int result = 0;
 205
 206         assert_spin_locked(cl_object_attr_guard(top));
 207         ENTRY;
 208
 209         cl_object_for_each(obj, top) {
 210                 if (obj->co_ops->coo_attr_get != NULL) {
 211                         result = obj->co_ops->coo_attr_get(env, obj, attr);
 212                         if (result != 0) {
 213                                 if (result > 0)
 214                                         result = 0;
 215                                 break;
 216                         }
 217                 }
 218         }
 219         RETURN(result);
 220 }
 221 EXPORT_SYMBOL(cl_object_attr_get);
 222
 223 /**
 224  * Updates data-attributes of an object \a obj.
 225  *
 226  * Only attributes, mentioned in a validness bit-mask \a v are
 227  * updated. Calls cl_object_operations::coo_upd_attr() on every layer, bottom
 228  * to top.
 229  */
 230 int cl_object_attr_update(const struct lu_env *env, struct cl_object *top,
 231                           const struct cl_attr *attr, unsigned v)
 232 {
 233         struct cl_object *obj;
 234         int result = 0;
 235
 236         assert_spin_locked(cl_object_attr_guard(top));
 237         ENTRY;
 238
 239         cl_object_for_each_reverse(obj, top) {
 240                 if (obj->co_ops->coo_attr_update != NULL) {
 241                         result = obj->co_ops->coo_attr_update(env, obj, attr,
 242                                                               v);
 243                         if (result != 0) {
 244                                 if (result > 0)
 245                                         result = 0;
 246                                 break;
 247                         }
 248                 }
 249         }
 250         RETURN(result);
 251 }
 252 EXPORT_SYMBOL(cl_object_attr_update);
 253
 254 /**
 255  * Notifies layers (bottom-to-top) that glimpse AST was received.
 256  *
 257  * Layers have to fill \a lvb fields with information that will be shipped
 258  * back to glimpse issuer.
 259  *
 260  * \see cl_lock_operations::clo_glimpse()
 261  */
 262 int cl_object_glimpse(const struct lu_env *env, struct cl_object *top,
 263                       struct ost_lvb *lvb)
 264 {
 265         struct cl_object *obj;
 266         int result = 0;
 267
 268         ENTRY;
 269         cl_object_for_each_reverse(obj, top) {
 270                 if (obj->co_ops->coo_glimpse != NULL) {
 271                         result = obj->co_ops->coo_glimpse(env, obj, lvb);
 272                         if (result != 0)
 273                                 break;
 274                 }
 275         }
 276         LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top->co_lu.lo_header),
 277                          "size: %llu mtime: %llu atime: %llu "
 278                          "ctime: %llu blocks: %llu\n",
 279                          lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
 280                          lvb->lvb_ctime, lvb->lvb_blocks);
 281         RETURN(result);
 282 }
 283 EXPORT_SYMBOL(cl_object_glimpse);
 284
 285 /**
 286  * Updates a configuration of an object \a obj.
 287  */
 288 int cl_conf_set(const struct lu_env *env, struct cl_object *top,
 289                 const struct cl_object_conf *conf)
 290 {
 291         struct cl_object *obj;
 292         int result = 0;
 293
 294         ENTRY;
 295         cl_object_for_each(obj, top) {
 296                 if (obj->co_ops->coo_conf_set != NULL) {
 297                         result = obj->co_ops->coo_conf_set(env, obj, conf);
 298                         if (result)
 299                                 break;
 300                 }
 301         }
 302         RETURN(result);
 303 }
 304 EXPORT_SYMBOL(cl_conf_set);
 305
 306 /**
 307  * Prunes caches of pages and locks for this object.
 308  */
 309 int cl_object_prune(const struct lu_env *env, struct cl_object *top)
 310 {
 311         struct cl_object *obj;
 312         int result = 0;
 313         ENTRY;
 314
 315         cl_object_for_each(obj, top) {
 316                 if (obj->co_ops->coo_prune != NULL) {
 317                         result = obj->co_ops->coo_prune(env, obj);
 318                         if (result)
 319                                 break;
 320                 }
 321         }
 322
 323         RETURN(result);
 324 }
 325 EXPORT_SYMBOL(cl_object_prune);
 326
 327 /**
 328  * Get stripe information of this object.
 329  */
 330 int cl_object_getstripe(const struct lu_env *env, struct cl_object *top,
 331                         struct lov_user_md __user *uarg, size_t size)
 332 {
 333         struct cl_object *obj;
 334         int result = 0;
 335         ENTRY;
 336
 337         cl_object_for_each(obj, top) {
 338                 if (obj->co_ops->coo_getstripe) {
 339                         result = obj->co_ops->coo_getstripe(env, obj, uarg,
 340                                                             size);
 341                         if (result)
 342                                 break;
 343                 }
 344         }
 345         RETURN(result);
 346 }
 347 EXPORT_SYMBOL(cl_object_getstripe);
 348
 349 /**
 350  * Get fiemap extents from file object.
 351  *
 352  * \param env [in]      lustre environment
 353  * \param obj [in]      file object
 354  * \param key [in]      fiemap request argument
 355  * \param fiemap [out]  fiemap extents mapping retrived
 356  * \param buflen [in]   max buffer length of @fiemap
 357  *
 358  * \retval 0    success
 359  * \retval < 0  error
 360  */
 361 int cl_object_fiemap(const struct lu_env *env, struct cl_object *top,
 362                      struct ll_fiemap_info_key *key,
 363                      struct fiemap *fiemap, size_t *buflen)
 364 {
 365         struct cl_object *obj;
 366         int result = 0;
 367         ENTRY;
 368
 369         cl_object_for_each(obj, top) {
 370                 if (obj->co_ops->coo_fiemap) {
 371                         result = obj->co_ops->coo_fiemap(env, obj, key, fiemap,
 372                                                          buflen);
 373                         if (result)
 374                                 break;
 375                 }
 376         }
 377         RETURN(result);
 378 }
 379 EXPORT_SYMBOL(cl_object_fiemap);
 380
 381 int cl_object_layout_get(const struct lu_env *env, struct cl_object *top,
 382                          struct cl_layout *cl)
 383 {
 384         struct cl_object *obj;
 385         ENTRY;
 386
 387         cl_object_for_each(obj, top) {
 388                 if (obj->co_ops->coo_layout_get)
 389                         return obj->co_ops->coo_layout_get(env, obj, cl);
 390         }
 391
 392         RETURN(-EOPNOTSUPP);
 393 }
 394 EXPORT_SYMBOL(cl_object_layout_get);
 395
 396 loff_t cl_object_maxbytes(struct cl_object *top)
 397 {
 398         struct cl_object *obj;
 399         loff_t maxbytes = LLONG_MAX;
 400         ENTRY;
 401
 402         cl_object_for_each(obj, top) {
 403                 if (obj->co_ops->coo_maxbytes)
 404                         maxbytes = min_t(loff_t, obj->co_ops->coo_maxbytes(obj),
 405                                          maxbytes);
 406         }
 407
 408         RETURN(maxbytes);
 409 }
 410 EXPORT_SYMBOL(cl_object_maxbytes);
 411
 412 int cl_object_flush(const struct lu_env *env, struct cl_object *top,
 413                          struct ldlm_lock *lock)
 414 {
 415         struct cl_object *obj;
 416         int rc = 0;
 417         ENTRY;
 418
 419         cl_object_for_each(obj, top) {
 420                 if (obj->co_ops->coo_object_flush) {
 421                         rc = obj->co_ops->coo_object_flush(env, obj, lock);
 422                         if (rc)
 423                                 break;
 424                 }
 425         }
 426         RETURN(rc);
 427 }
 428 EXPORT_SYMBOL(cl_object_flush);
 429
 430 /**
 431  * Helper function removing all object locks, and marking object for
 432  * deletion. All object pages must have been deleted at this point.
 433  *
 434  * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
 435  * and sub- objects respectively.
 436  */
 437 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
 438 {
 439         struct cl_object_header *hdr = cl_object_header(obj);
 440
 441         set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
 442 }
 443 EXPORT_SYMBOL(cl_object_kill);
 444
 445 void cache_stats_init(struct cache_stats *cs, const char *name)
 446 {
 447         int i;
 448
 449         cs->cs_name = name;
 450         for (i = 0; i < CS_NR; i++)
 451                 atomic_set(&cs->cs_stats[i], 0);
 452 }
 453
 454 static int cache_stats_print(const struct cache_stats *cs,
 455                              struct seq_file *m, int h)
 456 {
 457         int i;
 458
 459         /*
 460          *   lookup    hit    total  cached create
 461          * env: ...... ...... ...... ...... ......
 462          */
 463         if (h) {
 464                 const char *names[CS_NR] = CS_NAMES;
 465
 466                 seq_printf(m, "%6s", " ");
 467                 for (i = 0; i < CS_NR; i++)
 468                         seq_printf(m, "%8s", names[i]);
 469                 seq_printf(m, "\n");
 470         }
 471
 472         seq_printf(m, "%5.5s:", cs->cs_name);
 473         for (i = 0; i < CS_NR; i++)
 474                 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
 475         return 0;
 476 }
 477
 478 static void cl_env_percpu_refill(void);
 479
 480 /**
 481  * Initialize client site.
 482  *
 483  * Perform common initialization (lu_site_init()), and initialize statistical
 484  * counters. Also perform global initializations on the first call.
 485  */
 486 int cl_site_init(struct cl_site *s, struct cl_device *d)
 487 {
 488         size_t i;
 489         int result;
 490
 491         result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
 492         if (result == 0) {
 493                 cache_stats_init(&s->cs_pages, "pages");
 494                 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
 495                         atomic_set(&s->cs_pages_state[0], 0);
 496                 cl_env_percpu_refill();
 497         }
 498         return result;
 499 }
 500 EXPORT_SYMBOL(cl_site_init);
 501
 502 /**
 503  * Finalize client site. Dual to cl_site_init().
 504  */
 505 void cl_site_fini(struct cl_site *s)
 506 {
 507         lu_site_fini(&s->cs_lu);
 508 }
 509 EXPORT_SYMBOL(cl_site_fini);
 510
 511 static struct cache_stats cl_env_stats = {
 512         .cs_name    = "envs",
 513         .cs_stats = { ATOMIC_INIT(0), }
 514 };
 515
 516 /**
 517  * Outputs client site statistical counters into a buffer. Suitable for
 518  * ll_rd_*()-style functions.
 519  */
 520 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
 521 {
 522         static const char *const pstate[] = {
 523                 [CPS_CACHED]    = "c",
 524                 [CPS_OWNED]     = "o",
 525                 [CPS_PAGEOUT]   = "w",
 526                 [CPS_PAGEIN]    = "r",
 527                 [CPS_FREEING]   = "f"
 528         };
 529         size_t i;
 530
 531 /*
 532        lookup    hit  total   busy create
 533 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
 534 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
 535   env: ...... ...... ...... ...... ......
 536  */
 537         lu_site_stats_seq_print(&site->cs_lu, m);
 538         cache_stats_print(&site->cs_pages, m, 1);
 539         seq_printf(m, " [");
 540         for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
 541                 seq_printf(m, "%s: %u ", pstate[i],
 542                            atomic_read(&site->cs_pages_state[i]));
 543         seq_printf(m, "]\n");
 544         cache_stats_print(&cl_env_stats, m, 0);
 545         seq_printf(m, "\n");
 546         return 0;
 547 }
 548 EXPORT_SYMBOL(cl_site_stats_print);
 549
 550 /*****************************************************************************
 551  *
 552  * lu_env handling on client.
 553  *
 554  */
 555
 556 static unsigned cl_envs_cached_max = 32; /* XXX: prototype: arbitrary limit
 557                                           * for now. */
 558 static struct cl_env_cache {
 559         rwlock_t                cec_guard;
 560         unsigned                cec_count;
 561         struct list_head        cec_envs;
 562 } *cl_envs = NULL;
 563
 564 struct cl_env {
 565         void             *ce_magic;
 566         struct lu_env     ce_lu;
 567         struct lu_context ce_ses;
 568
 569         /*
 570          * Linkage into global list of all client environments. Used for
 571          * garbage collection.
 572          */
 573         struct list_head  ce_linkage;
 574         /*
 575          *
 576          */
 577         int               ce_ref;
 578         /*
 579          * Debugging field: address of the caller who made original
 580          * allocation.
 581          */
 582         void             *ce_debug;
 583 };
 584
 585 static void cl_env_inc(enum cache_stats_item item)
 586 {
 587 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
 588         atomic_inc(&cl_env_stats.cs_stats[item]);
 589 #endif
 590 }
 591
 592 static void cl_env_dec(enum cache_stats_item item)
 593 {
 594 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
 595         LASSERT(atomic_read(&cl_env_stats.cs_stats[item]) > 0);
 596         atomic_dec(&cl_env_stats.cs_stats[item]);
 597 #endif
 598 }
 599
 600 static void cl_env_init0(struct cl_env *cle, void *debug)
 601 {
 602         LASSERT(cle->ce_ref == 0);
 603         LASSERT(cle->ce_magic == &cl_env_init0);
 604         LASSERT(cle->ce_debug == NULL);
 605
 606         cle->ce_ref = 1;
 607         cle->ce_debug = debug;
 608         cl_env_inc(CS_busy);
 609 }
 610
 611 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
 612 {
 613         struct lu_env *env;
 614         struct cl_env *cle;
 615
 616         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
 617         if (cle != NULL) {
 618                 int rc;
 619
 620                 INIT_LIST_HEAD(&cle->ce_linkage);
 621                 cle->ce_magic = &cl_env_init0;
 622                 env = &cle->ce_lu;
 623                 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
 624                 if (rc == 0) {
 625                         rc = lu_context_init(&cle->ce_ses,
 626                                              LCT_SESSION | ses_tags);
 627                         if (rc == 0) {
 628                                 lu_context_enter(&cle->ce_ses);
 629                                 env->le_ses = &cle->ce_ses;
 630                                 cl_env_init0(cle, debug);
 631                         } else
 632                                 lu_env_fini(env);
 633                 }
 634                 if (rc != 0) {
 635                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 636                         env = ERR_PTR(rc);
 637                 } else {
 638                         cl_env_inc(CS_create);
 639                         cl_env_inc(CS_total);
 640                 }
 641         } else
 642                 env = ERR_PTR(-ENOMEM);
 643         return env;
 644 }
 645
 646 static void cl_env_fini(struct cl_env *cle)
 647 {
 648         cl_env_dec(CS_total);
 649         lu_context_fini(&cle->ce_lu.le_ctx);
 650         lu_context_fini(&cle->ce_ses);
 651         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 652 }
 653
 654 /* Get a cl_env, either from the per-CPU cache for the current CPU, or by
 655  * allocating a new one.
 656  */
 657 static struct lu_env *cl_env_obtain(void *debug)
 658 {
 659         struct cl_env *cle;
 660         struct lu_env *env;
 661         int cpu = get_cpu();
 662
 663         ENTRY;
 664
 665         read_lock(&cl_envs[cpu].cec_guard);
 666         LASSERT(equi(cl_envs[cpu].cec_count == 0,
 667                 list_empty(&cl_envs[cpu].cec_envs)));
 668         if (cl_envs[cpu].cec_count > 0) {
 669                 int rc;
 670
 671                 cle = container_of(cl_envs[cpu].cec_envs.next, struct cl_env,
 672                                    ce_linkage);
 673                 list_del_init(&cle->ce_linkage);
 674                 cl_envs[cpu].cec_count--;
 675                 read_unlock(&cl_envs[cpu].cec_guard);
 676                 put_cpu();
 677
 678                 env = &cle->ce_lu;
 679                 rc = lu_env_refill(env);
 680                 if (rc == 0) {
 681                         cl_env_init0(cle, debug);
 682                         lu_context_enter(&env->le_ctx);
 683                         lu_context_enter(&cle->ce_ses);
 684                 } else {
 685                         cl_env_fini(cle);
 686                         env = ERR_PTR(rc);
 687                 }
 688         } else {
 689                 read_unlock(&cl_envs[cpu].cec_guard);
 690                 put_cpu();
 691                 env = cl_env_new(lu_context_tags_default,
 692                                  lu_session_tags_default, debug);
 693         }
 694         RETURN(env);
 695 }
 696
 697 static inline struct cl_env *cl_env_container(struct lu_env *env)
 698 {
 699         return container_of(env, struct cl_env, ce_lu);
 700 }
 701
 702 /**
 703  * Returns an lu_env.
 704  *
 705  * No link to thread, this returns an env from the cache or
 706  * allocates a new one.
 707  *
 708  * If you need to get the specific environment you created for this thread,
 709  * you must either pass the pointer directly or store it in the file/inode
 710  * private data and retrieve it from there using ll_cl_add/ll_cl_find.
 711  *
 712  * \param refcheck pointer to a counter used to detect environment leaks. In
 713  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
 714  * scope and pointer to the same integer is passed as \a refcheck. This is
 715  * used to detect missed cl_env_put().
 716  *
 717  * \see cl_env_put()
 718  */
 719 struct lu_env *cl_env_get(__u16 *refcheck)
 720 {
 721         struct lu_env *env;
 722
 723         env = cl_env_obtain(__builtin_return_address(0));
 724         if (!IS_ERR(env)) {
 725                 struct cl_env *cle;
 726
 727                 cle = cl_env_container(env);
 728                 *refcheck = cle->ce_ref;
 729                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 730         }
 731         return env;
 732 }
 733 EXPORT_SYMBOL(cl_env_get);
 734
 735 /**
 736  * Forces an allocation of a fresh environment with given tags.
 737  *
 738  * \see cl_env_get()
 739  */
 740 struct lu_env *cl_env_alloc(__u16 *refcheck, __u32 tags)
 741 {
 742         struct lu_env *env;
 743
 744         env = cl_env_new(tags, tags, __builtin_return_address(0));
 745         if (!IS_ERR(env)) {
 746                 struct cl_env *cle;
 747
 748                 cle = cl_env_container(env);
 749                 *refcheck = cle->ce_ref;
 750                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 751         }
 752         return env;
 753 }
 754 EXPORT_SYMBOL(cl_env_alloc);
 755
 756 static void cl_env_exit(struct cl_env *cle)
 757 {
 758         lu_context_exit(&cle->ce_lu.le_ctx);
 759         lu_context_exit(&cle->ce_ses);
 760 }
 761
 762 /**
 763  * Finalizes and frees a given number of cached environments. This is done to
 764  * (1) free some memory (not currently hooked into VM), or (2) release
 765  * references to modules.
 766  */
 767 unsigned cl_env_cache_purge(unsigned nr)
 768 {
 769         struct cl_env *cle;
 770         unsigned i;
 771
 772         ENTRY;
 773         for_each_possible_cpu(i) {
 774                 write_lock(&cl_envs[i].cec_guard);
 775                 for (; !list_empty(&cl_envs[i].cec_envs) && nr > 0; --nr) {
 776                         cle = container_of(cl_envs[i].cec_envs.next,
 777                                            struct cl_env, ce_linkage);
 778                         list_del_init(&cle->ce_linkage);
 779                         LASSERT(cl_envs[i].cec_count > 0);
 780                         cl_envs[i].cec_count--;
 781                         write_unlock(&cl_envs[i].cec_guard);
 782
 783                         cl_env_fini(cle);
 784                         write_lock(&cl_envs[i].cec_guard);
 785                 }
 786                 LASSERT(equi(cl_envs[i].cec_count == 0,
 787                         list_empty(&cl_envs[i].cec_envs)));
 788                 write_unlock(&cl_envs[i].cec_guard);
 789         }
 790         RETURN(nr);
 791 }
 792 EXPORT_SYMBOL(cl_env_cache_purge);
 793
 794 /**
 795  * Release an environment.
 796  *
 797  * Decrement \a env reference counter. When counter drops to 0, nothing in
 798  * this thread is using environment and it is returned to the per-CPU cache or
 799  * freed immediately if the cache is full.
 800  */
 801 void cl_env_put(struct lu_env *env, __u16 *refcheck)
 802 {
 803         struct cl_env *cle;
 804
 805         cle = cl_env_container(env);
 806
 807         LASSERT(cle->ce_ref > 0);
 808         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
 809
 810         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 811         if (--cle->ce_ref == 0) {
 812                 int cpu = get_cpu();
 813
 814                 cl_env_dec(CS_busy);
 815                 cle->ce_debug = NULL;
 816                 cl_env_exit(cle);
 817                 /*
 818                  * Don't bother to take a lock here.
 819                  *
 820                  * Return environment to the cache only when it was allocated
 821                  * with the standard tags.
 822                  */
 823                 if (cl_envs[cpu].cec_count < cl_envs_cached_max &&
 824                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == lu_context_tags_default &&
 825                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == lu_session_tags_default) {
 826                         read_lock(&cl_envs[cpu].cec_guard);
 827                         list_add(&cle->ce_linkage, &cl_envs[cpu].cec_envs);
 828                         cl_envs[cpu].cec_count++;
 829                         read_unlock(&cl_envs[cpu].cec_guard);
 830                 } else
 831                         cl_env_fini(cle);
 832                 put_cpu();
 833         }
 834 }
 835 EXPORT_SYMBOL(cl_env_put);
 836
 837 /**
 838  * Converts struct cl_attr to struct ost_lvb.
 839  *
 840  * \see cl_lvb2attr
 841  */
 842 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
 843 {
 844         lvb->lvb_size   = attr->cat_size;
 845         lvb->lvb_mtime  = attr->cat_mtime;
 846         lvb->lvb_atime  = attr->cat_atime;
 847         lvb->lvb_ctime  = attr->cat_ctime;
 848         lvb->lvb_blocks = attr->cat_blocks;
 849 }
 850
 851 /**
 852  * Converts struct ost_lvb to struct cl_attr.
 853  *
 854  * \see cl_attr2lvb
 855  */
 856 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
 857 {
 858         attr->cat_size   = lvb->lvb_size;
 859         attr->cat_mtime  = lvb->lvb_mtime;
 860         attr->cat_atime  = lvb->lvb_atime;
 861         attr->cat_ctime  = lvb->lvb_ctime;
 862         attr->cat_blocks = lvb->lvb_blocks;
 863 }
 864 EXPORT_SYMBOL(cl_lvb2attr);
 865
 866 static struct cl_env cl_env_percpu[NR_CPUS];
 867 static DEFINE_MUTEX(cl_env_percpu_mutex);
 868
 869 static int cl_env_percpu_init(void)
 870 {
 871         struct cl_env *cle;
 872         int tags = LCT_REMEMBER | LCT_NOREF;
 873         int i, j;
 874         int rc = 0;
 875
 876         for_each_possible_cpu(i) {
 877                 struct lu_env *env;
 878
 879                 rwlock_init(&cl_envs[i].cec_guard);
 880                 INIT_LIST_HEAD(&cl_envs[i].cec_envs);
 881                 cl_envs[i].cec_count = 0;
 882
 883                 cle = &cl_env_percpu[i];
 884                 env = &cle->ce_lu;
 885
 886                 INIT_LIST_HEAD(&cle->ce_linkage);
 887                 cle->ce_magic = &cl_env_init0;
 888                 rc = lu_env_init(env, LCT_CL_THREAD | tags);
 889                 if (rc == 0) {
 890                         rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
 891                         if (rc == 0) {
 892                                 lu_context_enter(&cle->ce_ses);
 893                                 env->le_ses = &cle->ce_ses;
 894                         } else {
 895                                 lu_env_fini(env);
 896                         }
 897                 }
 898                 if (rc != 0)
 899                         break;
 900         }
 901         if (rc != 0) {
 902                 /* Indices 0 to i (excluding i) were correctly initialized,
 903                  * thus we must uninitialize up to i, the rest are undefined. */
 904                 for (j = 0; j < i; j++) {
 905                         cle = &cl_env_percpu[j];
 906                         lu_context_exit(&cle->ce_ses);
 907                         lu_context_fini(&cle->ce_ses);
 908                         lu_env_fini(&cle->ce_lu);
 909                 }
 910         }
 911
 912         return rc;
 913 }
 914
 915 static void cl_env_percpu_fini(void)
 916 {
 917         int i;
 918
 919         for_each_possible_cpu(i) {
 920                 struct cl_env *cle = &cl_env_percpu[i];
 921
 922                 lu_context_exit(&cle->ce_ses);
 923                 lu_context_fini(&cle->ce_ses);
 924                 lu_env_fini(&cle->ce_lu);
 925         }
 926 }
 927
 928 static void cl_env_percpu_refill(void)
 929 {
 930         int i;
 931
 932         mutex_lock(&cl_env_percpu_mutex);
 933         for_each_possible_cpu(i)
 934                 lu_env_refill(&cl_env_percpu[i].ce_lu);
 935         mutex_unlock(&cl_env_percpu_mutex);
 936 }
 937
 938 void cl_env_percpu_put(struct lu_env *env)
 939 {
 940         struct cl_env *cle;
 941         int cpu;
 942
 943         cpu = smp_processor_id();
 944         cle = cl_env_container(env);
 945         LASSERT(cle == &cl_env_percpu[cpu]);
 946
 947         cle->ce_ref--;
 948         LASSERT(cle->ce_ref == 0);
 949
 950         cl_env_dec(CS_busy);
 951         cle->ce_debug = NULL;
 952
 953         put_cpu();
 954 }
 955 EXPORT_SYMBOL(cl_env_percpu_put);
 956
 957 struct lu_env *cl_env_percpu_get(void)
 958 {
 959         struct cl_env *cle;
 960
 961         cle = &cl_env_percpu[get_cpu()];
 962         cl_env_init0(cle, __builtin_return_address(0));
 963
 964         return &cle->ce_lu;
 965 }
 966 EXPORT_SYMBOL(cl_env_percpu_get);
 967
 968 /*****************************************************************************
 969  *
 970  * Temporary prototype thing: mirror obd-devices into cl devices.
 971  *
 972  */
 973
 974 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
 975                                 struct lu_device_type *ldt,
 976                                 struct lu_device *next)
 977 {
 978         const char       *typename;
 979         struct lu_device *d;
 980
 981         LASSERT(ldt != NULL);
 982
 983         typename = ldt->ldt_name;
 984         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
 985         if (!IS_ERR(d)) {
 986                 int rc;
 987
 988                 if (site != NULL)
 989                         d->ld_site = site;
 990                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
 991                 if (rc == 0) {
 992                         lu_device_get(d);
 993                         lu_ref_add(&d->ld_reference,
 994                                    "lu-stack", &lu_site_init);
 995                 } else {
 996                         ldt->ldt_ops->ldto_device_free(env, d);
 997                         CERROR("can't init device '%s', %d\n", typename, rc);
 998                         d = ERR_PTR(rc);
 999                 }
1000         } else
1001                 CERROR("Cannot allocate device: '%s'\n", typename);
1002         return lu2cl_dev(d);
1003 }
1004 EXPORT_SYMBOL(cl_type_setup);
1005
1006 /**
1007  * Finalize device stack by calling lu_stack_fini().
1008  */
1009 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1010 {
1011         lu_stack_fini(env, cl2lu_dev(cl));
1012 }
1013 EXPORT_SYMBOL(cl_stack_fini);
1014
1015 static struct lu_context_key cl_key;
1016
1017 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1018 {
1019         return lu_context_key_get(&env->le_ctx, &cl_key);
1020 }
1021
1022 /* defines cl_key_{init,fini}() */
1023 LU_KEY_INIT_FINI(cl, struct cl_thread_info);
1024
1025 static struct lu_context_key cl_key = {
1026         .lct_tags = LCT_CL_THREAD,
1027         .lct_init = cl_key_init,
1028         .lct_fini = cl_key_fini,
1029 };
1030
1031 static struct lu_kmem_descr cl_object_caches[] = {
1032         {
1033                 .ckd_cache = &cl_env_kmem,
1034                 .ckd_name  = "cl_env_kmem",
1035                 .ckd_size  = sizeof(struct cl_env)
1036         },
1037         {
1038                 .ckd_cache = &cl_dio_aio_kmem,
1039                 .ckd_name  = "cl_dio_aio_kmem",
1040                 .ckd_size  = sizeof(struct cl_dio_aio)
1041         },
1042         {
1043                 .ckd_cache = NULL
1044         }
1045 };
1046
1047 /**
1048  * Global initialization of cl-data. Create kmem caches, register
1049  * lu_context_key's, etc.
1050  *
1051  * \see cl_global_fini()
1052  */
1053 int cl_global_init(void)
1054 {
1055         int result;
1056
1057         OBD_ALLOC_PTR_ARRAY(cl_envs, num_possible_cpus());
1058         if (cl_envs == NULL)
1059                 GOTO(out, result = -ENOMEM);
1060
1061         result = lu_kmem_init(cl_object_caches);
1062         if (result)
1063                 GOTO(out_envs, result);
1064
1065         LU_CONTEXT_KEY_INIT(&cl_key);
1066         result = lu_context_key_register(&cl_key);
1067         if (result)
1068                 GOTO(out_kmem, result);
1069
1070         result = cl_env_percpu_init();
1071         if (result) /* no cl_env_percpu_fini on error */
1072                 GOTO(out_keys, result);
1073
1074         return 0;
1075
1076 out_keys:
1077         lu_context_key_degister(&cl_key);
1078 out_kmem:
1079         lu_kmem_fini(cl_object_caches);
1080 out_envs:
1081         OBD_FREE_PTR_ARRAY(cl_envs, num_possible_cpus());
1082 out:
1083         return result;
1084 }
1085
1086 /**
1087  * Finalization of global cl-data. Dual to cl_global_init().
1088  */
1089 void cl_global_fini(void)
1090 {
1091         int i;
1092
1093         for (i = 0; i < ARRAY_SIZE(cl_page_kmem_array); i++) {
1094                 if (cl_page_kmem_array[i]) {
1095                         kmem_cache_destroy(cl_page_kmem_array[i]);
1096                         cl_page_kmem_array[i] = NULL;
1097                 }
1098         }
1099         cl_env_percpu_fini();
1100         lu_context_key_degister(&cl_key);
1101         lu_kmem_fini(cl_object_caches);
1102         OBD_FREE_PTR_ARRAY(cl_envs, num_possible_cpus());
1103 }