Whamcloud - gitweb
LU-362 Fix error path in lu_kmem_init().
[fs/lustre-release.git] / lustre / obdclass / cl_object.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 (c) 2008, 2010, Oracle and/or its affiliates. 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  * Client Lustre Object.
37  *
38  *   Author: Nikita Danilov <nikita.danilov@sun.com>
39  */
40
41 /*
42  * Locking.
43  *
44  *  i_mutex
45  *      PG_locked
46  *          ->coh_page_guard
47  *          ->coh_lock_guard
48  *          ->coh_attr_guard
49  *          ->ls_guard
50  */
51
52 #define DEBUG_SUBSYSTEM S_CLASS
53 #ifndef EXPORT_SYMTAB
54 # define EXPORT_SYMTAB
55 #endif
56
57 #include <libcfs/libcfs.h>
58 /* class_put_type() */
59 #include <obd_class.h>
60 #include <obd_support.h>
61 #include <lustre_fid.h>
62 #include <libcfs/list.h>
63 #include <libcfs/libcfs_hash.h> /* for cfs_hash stuff */
64 /* lu_time_global_{init,fini}() */
65 #include <lu_time.h>
66
67 #include <cl_object.h>
68 #include "cl_internal.h"
69
70 static cfs_mem_cache_t *cl_env_kmem;
71
72 /** Lock class of cl_object_header::coh_page_guard */
73 static cfs_lock_class_key_t cl_page_guard_class;
74 /** Lock class of cl_object_header::coh_lock_guard */
75 static cfs_lock_class_key_t cl_lock_guard_class;
76 /** Lock class of cl_object_header::coh_attr_guard */
77 static cfs_lock_class_key_t cl_attr_guard_class;
78
79 /**
80  * Initialize cl_object_header.
81  */
82 int cl_object_header_init(struct cl_object_header *h)
83 {
84         int result;
85
86         ENTRY;
87         result = lu_object_header_init(&h->coh_lu);
88         if (result == 0) {
89                 cfs_spin_lock_init(&h->coh_page_guard);
90                 cfs_spin_lock_init(&h->coh_lock_guard);
91                 cfs_spin_lock_init(&h->coh_attr_guard);
92                 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_page_guard_class);
93                 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_lock_guard_class);
94                 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
95                 h->coh_pages = 0;
96                 /* XXX hard coded GFP_* mask. */
97                 INIT_RADIX_TREE(&h->coh_tree, GFP_ATOMIC);
98                 CFS_INIT_LIST_HEAD(&h->coh_locks);
99         }
100         RETURN(result);
101 }
102 EXPORT_SYMBOL(cl_object_header_init);
103
104 /**
105  * Finalize cl_object_header.
106  */
107 void cl_object_header_fini(struct cl_object_header *h)
108 {
109         LASSERT(cfs_list_empty(&h->coh_locks));
110         lu_object_header_fini(&h->coh_lu);
111 }
112 EXPORT_SYMBOL(cl_object_header_fini);
113
114 /**
115  * Returns a cl_object with a given \a fid.
116  *
117  * Returns either cached or newly created object. Additional reference on the
118  * returned object is acquired.
119  *
120  * \see lu_object_find(), cl_page_find(), cl_lock_find()
121  */
122 struct cl_object *cl_object_find(const struct lu_env *env,
123                                  struct cl_device *cd, const struct lu_fid *fid,
124                                  const struct cl_object_conf *c)
125 {
126         cfs_might_sleep();
127         return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
128 }
129 EXPORT_SYMBOL(cl_object_find);
130
131 /**
132  * Releases a reference on \a o.
133  *
134  * When last reference is released object is returned to the cache, unless
135  * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
136  *
137  * \see cl_page_put(), cl_lock_put().
138  */
139 void cl_object_put(const struct lu_env *env, struct cl_object *o)
140 {
141         lu_object_put(env, &o->co_lu);
142 }
143 EXPORT_SYMBOL(cl_object_put);
144
145 /**
146  * Acquire an additional reference to the object \a o.
147  *
148  * This can only be used to acquire _additional_ reference, i.e., caller
149  * already has to possess at least one reference to \a o before calling this.
150  *
151  * \see cl_page_get(), cl_lock_get().
152  */
153 void cl_object_get(struct cl_object *o)
154 {
155         lu_object_get(&o->co_lu);
156 }
157 EXPORT_SYMBOL(cl_object_get);
158
159 /**
160  * Returns the top-object for a given \a o.
161  *
162  * \see cl_page_top(), cl_io_top()
163  */
164 struct cl_object *cl_object_top(struct cl_object *o)
165 {
166         struct cl_object_header *hdr = cl_object_header(o);
167         struct cl_object *top;
168
169         while (hdr->coh_parent != NULL)
170                 hdr = hdr->coh_parent;
171
172         top = lu2cl(lu_object_top(&hdr->coh_lu));
173         CDEBUG(D_TRACE, "%p -> %p\n", o, top);
174         return top;
175 }
176 EXPORT_SYMBOL(cl_object_top);
177
178 /**
179  * Returns pointer to the lock protecting data-attributes for the given object
180  * \a o.
181  *
182  * Data-attributes are protected by the cl_object_header::coh_attr_guard
183  * spin-lock in the top-object.
184  *
185  * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
186  */
187 static cfs_spinlock_t *cl_object_attr_guard(struct cl_object *o)
188 {
189         return &cl_object_header(cl_object_top(o))->coh_attr_guard;
190 }
191
192 /**
193  * Locks data-attributes.
194  *
195  * Prevents data-attributes from changing, until lock is released by
196  * cl_object_attr_unlock(). This has to be called before calls to
197  * cl_object_attr_get(), cl_object_attr_set().
198  */
199 void cl_object_attr_lock(struct cl_object *o)
200 {
201         cfs_spin_lock(cl_object_attr_guard(o));
202 }
203 EXPORT_SYMBOL(cl_object_attr_lock);
204
205 /**
206  * Releases data-attributes lock, acquired by cl_object_attr_lock().
207  */
208 void cl_object_attr_unlock(struct cl_object *o)
209 {
210         cfs_spin_unlock(cl_object_attr_guard(o));
211 }
212 EXPORT_SYMBOL(cl_object_attr_unlock);
213
214 /**
215  * Returns data-attributes of an object \a obj.
216  *
217  * Every layer is asked (by calling cl_object_operations::coo_attr_get())
218  * top-to-bottom to fill in parts of \a attr that this layer is responsible
219  * for.
220  */
221 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
222                        struct cl_attr *attr)
223 {
224         struct lu_object_header *top;
225         int result;
226
227         LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
228         ENTRY;
229
230         top = obj->co_lu.lo_header;
231         result = 0;
232         cfs_list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
233                 if (obj->co_ops->coo_attr_get != NULL) {
234                         result = obj->co_ops->coo_attr_get(env, obj, attr);
235                         if (result != 0) {
236                                 if (result > 0)
237                                         result = 0;
238                                 break;
239                         }
240                 }
241         }
242         RETURN(result);
243 }
244 EXPORT_SYMBOL(cl_object_attr_get);
245
246 /**
247  * Updates data-attributes of an object \a obj.
248  *
249  * Only attributes, mentioned in a validness bit-mask \a v are
250  * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
251  * to top.
252  */
253 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
254                        const struct cl_attr *attr, unsigned v)
255 {
256         struct lu_object_header *top;
257         int result;
258
259         LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
260         ENTRY;
261
262         top = obj->co_lu.lo_header;
263         result = 0;
264         cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
265                                         co_lu.lo_linkage) {
266                 if (obj->co_ops->coo_attr_set != NULL) {
267                         result = obj->co_ops->coo_attr_set(env, obj, attr, v);
268                         if (result != 0) {
269                                 if (result > 0)
270                                         result = 0;
271                                 break;
272                         }
273                 }
274         }
275         RETURN(result);
276 }
277 EXPORT_SYMBOL(cl_object_attr_set);
278
279 /**
280  * Notifies layers (bottom-to-top) that glimpse AST was received.
281  *
282  * Layers have to fill \a lvb fields with information that will be shipped
283  * back to glimpse issuer.
284  *
285  * \see cl_lock_operations::clo_glimpse()
286  */
287 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
288                       struct ost_lvb *lvb)
289 {
290         struct lu_object_header *top;
291         int result;
292
293         ENTRY;
294         top = obj->co_lu.lo_header;
295         result = 0;
296         cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
297                                         co_lu.lo_linkage) {
298                 if (obj->co_ops->coo_glimpse != NULL) {
299                         result = obj->co_ops->coo_glimpse(env, obj, lvb);
300                         if (result != 0)
301                                 break;
302                 }
303         }
304         LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
305                          "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
306                          "ctime: "LPU64" blocks: "LPU64"\n",
307                          lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
308                          lvb->lvb_ctime, lvb->lvb_blocks);
309         RETURN(result);
310 }
311 EXPORT_SYMBOL(cl_object_glimpse);
312
313 /**
314  * Updates a configuration of an object \a obj.
315  */
316 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
317                 const struct cl_object_conf *conf)
318 {
319         struct lu_object_header *top;
320         int result;
321
322         ENTRY;
323         top = obj->co_lu.lo_header;
324         result = 0;
325         cfs_list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
326                 if (obj->co_ops->coo_conf_set != NULL) {
327                         result = obj->co_ops->coo_conf_set(env, obj, conf);
328                         if (result != 0)
329                                 break;
330                 }
331         }
332         RETURN(result);
333 }
334 EXPORT_SYMBOL(cl_conf_set);
335
336 /**
337  * Helper function removing all object locks, and marking object for
338  * deletion. All object pages must have been deleted at this point.
339  *
340  * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
341  * and sub- objects respectively.
342  */
343 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
344 {
345         struct cl_object_header *hdr;
346
347         hdr = cl_object_header(obj);
348         LASSERT(hdr->coh_tree.rnode == NULL);
349         LASSERT(hdr->coh_pages == 0);
350
351         cfs_set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
352         /*
353          * Destroy all locks. Object destruction (including cl_inode_fini())
354          * cannot cancel the locks, because in the case of a local client,
355          * where client and server share the same thread running
356          * prune_icache(), this can dead-lock with ldlm_cancel_handler()
357          * waiting on __wait_on_freeing_inode().
358          */
359         cl_locks_prune(env, obj, 0);
360 }
361 EXPORT_SYMBOL(cl_object_kill);
362
363 /**
364  * Prunes caches of pages and locks for this object.
365  */
366 void cl_object_prune(const struct lu_env *env, struct cl_object *obj)
367 {
368         ENTRY;
369         cl_pages_prune(env, obj);
370         cl_locks_prune(env, obj, 1);
371         EXIT;
372 }
373 EXPORT_SYMBOL(cl_object_prune);
374
375 /**
376  * Check if the object has locks.
377  */
378 int cl_object_has_locks(struct cl_object *obj)
379 {
380         struct cl_object_header *head = cl_object_header(obj);
381         int has;
382
383         cfs_spin_lock(&head->coh_lock_guard);
384         has = cfs_list_empty(&head->coh_locks);
385         cfs_spin_unlock(&head->coh_lock_guard);
386
387         return (has == 0);
388 }
389 EXPORT_SYMBOL(cl_object_has_locks);
390
391 void cache_stats_init(struct cache_stats *cs, const char *name)
392 {
393         cs->cs_name = name;
394         cfs_atomic_set(&cs->cs_lookup, 0);
395         cfs_atomic_set(&cs->cs_hit,    0);
396         cfs_atomic_set(&cs->cs_total,  0);
397         cfs_atomic_set(&cs->cs_busy,   0);
398 }
399
400 int cache_stats_print(const struct cache_stats *cs,
401                       char *page, int count, int h)
402 {
403         int nob = 0;
404 /*
405        lookup    hit  total cached create
406   env: ...... ...... ...... ...... ......
407 */
408         if (h)
409                 nob += snprintf(page, count,
410                                 "       lookup    hit  total   busy create\n");
411
412         nob += snprintf(page + nob, count - nob,
413                         "%5.5s: %6u %6u %6u %6u %6u",
414                         cs->cs_name,
415                         cfs_atomic_read(&cs->cs_lookup),
416                         cfs_atomic_read(&cs->cs_hit),
417                         cfs_atomic_read(&cs->cs_total),
418                         cfs_atomic_read(&cs->cs_busy),
419                         cfs_atomic_read(&cs->cs_created));
420         return nob;
421 }
422
423 /**
424  * Initialize client site.
425  *
426  * Perform common initialization (lu_site_init()), and initialize statistical
427  * counters. Also perform global initializations on the first call.
428  */
429 int cl_site_init(struct cl_site *s, struct cl_device *d)
430 {
431         int i;
432         int result;
433
434         result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
435         if (result == 0) {
436                 cache_stats_init(&s->cs_pages, "pages");
437                 cache_stats_init(&s->cs_locks, "locks");
438                 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
439                         cfs_atomic_set(&s->cs_pages_state[0], 0);
440                 for (i = 0; i < ARRAY_SIZE(s->cs_locks_state); ++i)
441                         cfs_atomic_set(&s->cs_locks_state[i], 0);
442         }
443         return result;
444 }
445 EXPORT_SYMBOL(cl_site_init);
446
447 /**
448  * Finalize client site. Dual to cl_site_init().
449  */
450 void cl_site_fini(struct cl_site *s)
451 {
452         lu_site_fini(&s->cs_lu);
453 }
454 EXPORT_SYMBOL(cl_site_fini);
455
456 static struct cache_stats cl_env_stats = {
457         .cs_name    = "envs",
458         .cs_created = CFS_ATOMIC_INIT(0),
459         .cs_lookup  = CFS_ATOMIC_INIT(0),
460         .cs_hit     = CFS_ATOMIC_INIT(0),
461         .cs_total   = CFS_ATOMIC_INIT(0),
462         .cs_busy    = CFS_ATOMIC_INIT(0)
463 };
464
465 /**
466  * Outputs client site statistical counters into a buffer. Suitable for
467  * ll_rd_*()-style functions.
468  */
469 int cl_site_stats_print(const struct cl_site *site, char *page, int count)
470 {
471         int nob;
472         int i;
473         static const char *pstate[] = {
474                 [CPS_CACHED]  = "c",
475                 [CPS_OWNED]   = "o",
476                 [CPS_PAGEOUT] = "w",
477                 [CPS_PAGEIN]  = "r",
478                 [CPS_FREEING] = "f"
479         };
480         static const char *lstate[] = {
481                 [CLS_NEW]       = "n",
482                 [CLS_QUEUING]   = "q",
483                 [CLS_ENQUEUED]  = "e",
484                 [CLS_HELD]      = "h",
485                 [CLS_INTRANSIT] = "t",
486                 [CLS_CACHED]    = "c",
487                 [CLS_FREEING]   = "f"
488         };
489 /*
490        lookup    hit  total   busy create
491 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
492 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
493   env: ...... ...... ...... ...... ......
494  */
495         nob = lu_site_stats_print(&site->cs_lu, page, count);
496         nob += cache_stats_print(&site->cs_pages, page + nob, count - nob, 1);
497         nob += snprintf(page + nob, count - nob, " [");
498         for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
499                 nob += snprintf(page + nob, count - nob, "%s: %u ",
500                                 pstate[i],
501                                 cfs_atomic_read(&site->cs_pages_state[i]));
502         nob += snprintf(page + nob, count - nob, "]\n");
503         nob += cache_stats_print(&site->cs_locks, page + nob, count - nob, 0);
504         nob += snprintf(page + nob, count - nob, " [");
505         for (i = 0; i < ARRAY_SIZE(site->cs_locks_state); ++i)
506                 nob += snprintf(page + nob, count - nob, "%s: %u ",
507                                 lstate[i],
508                                 cfs_atomic_read(&site->cs_locks_state[i]));
509         nob += snprintf(page + nob, count - nob, "]\n");
510         nob += cache_stats_print(&cl_env_stats, page + nob, count - nob, 0);
511         nob += snprintf(page + nob, count - nob, "\n");
512         return nob;
513 }
514 EXPORT_SYMBOL(cl_site_stats_print);
515
516 /*****************************************************************************
517  *
518  * lu_env handling on client.
519  *
520  */
521
522 /**
523  * The most efficient way is to store cl_env pointer in task specific
524  * structures. On Linux, it wont' be easy to use task_struct->journal_info
525  * because Lustre code may call into other fs which has certain assumptions
526  * about journal_info. Currently following fields in task_struct are identified
527  * can be used for this purpose:
528  *  - cl_env: for liblustre.
529  *  - tux_info: ony on RedHat kernel.
530  *  - ...
531  * \note As long as we use task_struct to store cl_env, we assume that once
532  * called into Lustre, we'll never call into the other part of the kernel
533  * which will use those fields in task_struct without explicitly exiting
534  * Lustre.
535  *
536  * If there's no space in task_struct is available, hash will be used.
537  * bz20044, bz22683.
538  */
539
540 static CFS_LIST_HEAD(cl_envs);
541 static unsigned cl_envs_cached_nr  = 0;
542 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
543                                            * for now. */
544 static cfs_spinlock_t cl_envs_guard = CFS_SPIN_LOCK_UNLOCKED;
545
546 struct cl_env {
547         void             *ce_magic;
548         struct lu_env     ce_lu;
549         struct lu_context ce_ses;
550
551 #ifdef LL_TASK_CL_ENV
552         void             *ce_prev;
553 #else
554         /**
555          * This allows cl_env to be entered into cl_env_hash which implements
556          * the current thread -> client environment lookup.
557          */
558         cfs_hlist_node_t  ce_node;
559 #endif
560         /**
561          * Owner for the current cl_env.
562          *
563          * If LL_TASK_CL_ENV is defined, this point to the owning cfs_current(),
564          * only for debugging purpose ;
565          * Otherwise hash is used, and this is the key for cfs_hash.
566          * Now current thread pid is stored. Note using thread pointer would
567          * lead to unbalanced hash because of its specific allocation locality
568          * and could be varied for different platforms and OSes, even different
569          * OS versions.
570          */
571         void             *ce_owner;
572
573         /*
574          * Linkage into global list of all client environments. Used for
575          * garbage collection.
576          */
577         cfs_list_t        ce_linkage;
578         /*
579          *
580          */
581         int               ce_ref;
582         /*
583          * Debugging field: address of the caller who made original
584          * allocation.
585          */
586         void             *ce_debug;
587 };
588
589 #define CL_ENV_INC(counter) cfs_atomic_inc(&cl_env_stats.counter)
590
591 #define CL_ENV_DEC(counter)                                             \
592         do {                                                            \
593                 LASSERT(cfs_atomic_read(&cl_env_stats.counter) > 0);    \
594                 cfs_atomic_dec(&cl_env_stats.counter);                  \
595         } while (0)
596
597 static void cl_env_init0(struct cl_env *cle, void *debug)
598 {
599         LASSERT(cle->ce_ref == 0);
600         LASSERT(cle->ce_magic == &cl_env_init0);
601         LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
602
603         cle->ce_ref = 1;
604         cle->ce_debug = debug;
605         CL_ENV_INC(cs_busy);
606 }
607
608
609 #ifndef LL_TASK_CL_ENV
610 /*
611  * The implementation of using hash table to connect cl_env and thread
612  */
613
614 static cfs_hash_t *cl_env_hash;
615
616 static unsigned cl_env_hops_hash(cfs_hash_t *lh,
617                                  const void *key, unsigned mask)
618 {
619 #if BITS_PER_LONG == 64
620         return cfs_hash_u64_hash((__u64)key, mask);
621 #else
622         return cfs_hash_u32_hash((__u32)key, mask);
623 #endif
624 }
625
626 static void *cl_env_hops_obj(cfs_hlist_node_t *hn)
627 {
628         struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
629         LASSERT(cle->ce_magic == &cl_env_init0);
630         return (void *)cle;
631 }
632
633 static int cl_env_hops_keycmp(const void *key, cfs_hlist_node_t *hn)
634 {
635         struct cl_env *cle = cl_env_hops_obj(hn);
636
637         LASSERT(cle->ce_owner != NULL);
638         return (key == cle->ce_owner);
639 }
640
641 static void cl_env_hops_noop(cfs_hash_t *hs, cfs_hlist_node_t *hn)
642 {
643         struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
644         LASSERT(cle->ce_magic == &cl_env_init0);
645 }
646
647 static cfs_hash_ops_t cl_env_hops = {
648         .hs_hash        = cl_env_hops_hash,
649         .hs_key         = cl_env_hops_obj,
650         .hs_keycmp      = cl_env_hops_keycmp,
651         .hs_object      = cl_env_hops_obj,
652         .hs_get         = cl_env_hops_noop,
653         .hs_put_locked  = cl_env_hops_noop,
654 };
655
656 static inline struct cl_env *cl_env_fetch(void)
657 {
658         struct cl_env *cle;
659
660         cle = cfs_hash_lookup(cl_env_hash, (void *) (long) cfs_current()->pid);
661         LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
662         return cle;
663 }
664
665 static inline void cl_env_attach(struct cl_env *cle)
666 {
667         if (cle) {
668                 int rc;
669
670                 LASSERT(cle->ce_owner == NULL);
671                 cle->ce_owner = (void *) (long) cfs_current()->pid;
672                 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
673                                          &cle->ce_node);
674                 LASSERT(rc == 0);
675         }
676 }
677
678 static inline void cl_env_do_detach(struct cl_env *cle)
679 {
680         void *cookie;
681
682         LASSERT(cle->ce_owner == (void *) (long) cfs_current()->pid);
683         cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
684                               &cle->ce_node);
685         LASSERT(cookie == cle);
686         cle->ce_owner = NULL;
687 }
688
689 static int cl_env_store_init(void) {
690         cl_env_hash = cfs_hash_create("cl_env",
691                                       HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
692                                       HASH_CL_ENV_BKT_BITS, 0,
693                                       CFS_HASH_MIN_THETA,
694                                       CFS_HASH_MAX_THETA,
695                                       &cl_env_hops,
696                                       CFS_HASH_RW_BKTLOCK);
697         return cl_env_hash != NULL ? 0 :-ENOMEM;
698 }
699
700 static void cl_env_store_fini(void) {
701         cfs_hash_putref(cl_env_hash);
702 }
703
704 #else /* LL_TASK_CL_ENV */
705 /*
706  * The implementation of store cl_env directly in thread structure.
707  */
708
709 static inline struct cl_env *cl_env_fetch(void)
710 {
711         struct cl_env *cle;
712
713         cle = cfs_current()->LL_TASK_CL_ENV;
714         if (cle && cle->ce_magic != &cl_env_init0)
715                 cle = NULL;
716         return cle;
717 }
718
719 static inline void cl_env_attach(struct cl_env *cle)
720 {
721         if (cle) {
722                 LASSERT(cle->ce_owner == NULL);
723                 cle->ce_owner = cfs_current();
724                 cle->ce_prev = cfs_current()->LL_TASK_CL_ENV;
725                 cfs_current()->LL_TASK_CL_ENV = cle;
726         }
727 }
728
729 static inline void cl_env_do_detach(struct cl_env *cle)
730 {
731         LASSERT(cle->ce_owner == cfs_current());
732         LASSERT(cfs_current()->LL_TASK_CL_ENV == cle);
733         cfs_current()->LL_TASK_CL_ENV = cle->ce_prev;
734         cle->ce_owner = NULL;
735 }
736
737 static int cl_env_store_init(void) { return 0; }
738 static void cl_env_store_fini(void) { }
739
740 #endif /* LL_TASK_CL_ENV */
741
742 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
743 {
744         if (cle == NULL)
745                 cle = cl_env_fetch();
746
747         if (cle && cle->ce_owner)
748                 cl_env_do_detach(cle);
749
750         return cle;
751 }
752
753 static struct lu_env *cl_env_new(__u32 tags, void *debug)
754 {
755         struct lu_env *env;
756         struct cl_env *cle;
757
758         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, CFS_ALLOC_IO);
759         if (cle != NULL) {
760                 int rc;
761
762                 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
763                 cle->ce_magic = &cl_env_init0;
764                 env = &cle->ce_lu;
765                 rc = lu_env_init(env, LCT_CL_THREAD|tags);
766                 if (rc == 0) {
767                         rc = lu_context_init(&cle->ce_ses, LCT_SESSION|tags);
768                         if (rc == 0) {
769                                 lu_context_enter(&cle->ce_ses);
770                                 env->le_ses = &cle->ce_ses;
771                                 cl_env_init0(cle, debug);
772                         } else
773                                 lu_env_fini(env);
774                 }
775                 if (rc != 0) {
776                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
777                         env = ERR_PTR(rc);
778                 } else {
779                         CL_ENV_INC(cs_created);
780                         CL_ENV_INC(cs_total);
781                 }
782         } else
783                 env = ERR_PTR(-ENOMEM);
784         return env;
785 }
786
787 static void cl_env_fini(struct cl_env *cle)
788 {
789         CL_ENV_DEC(cs_total);
790         lu_context_fini(&cle->ce_lu.le_ctx);
791         lu_context_fini(&cle->ce_ses);
792         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
793 }
794
795 static struct lu_env *cl_env_obtain(void *debug)
796 {
797         struct cl_env *cle;
798         struct lu_env *env;
799
800         ENTRY;
801         cfs_spin_lock(&cl_envs_guard);
802         LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
803         if (cl_envs_cached_nr > 0) {
804                 int rc;
805
806                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
807                 cfs_list_del_init(&cle->ce_linkage);
808                 cl_envs_cached_nr--;
809                 cfs_spin_unlock(&cl_envs_guard);
810
811                 env = &cle->ce_lu;
812                 rc = lu_env_refill(env);
813                 if (rc == 0) {
814                         cl_env_init0(cle, debug);
815                         lu_context_enter(&env->le_ctx);
816                         lu_context_enter(&cle->ce_ses);
817                 } else {
818                         cl_env_fini(cle);
819                         env = ERR_PTR(rc);
820                 }
821         } else {
822                 cfs_spin_unlock(&cl_envs_guard);
823                 env = cl_env_new(0, debug);
824         }
825         RETURN(env);
826 }
827
828 static inline struct cl_env *cl_env_container(struct lu_env *env)
829 {
830         return container_of(env, struct cl_env, ce_lu);
831 }
832
833 struct lu_env *cl_env_peek(int *refcheck)
834 {
835         struct lu_env *env;
836         struct cl_env *cle;
837
838         CL_ENV_INC(cs_lookup);
839
840         /* check that we don't go far from untrusted pointer */
841         CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
842
843         env = NULL;
844         cle = cl_env_fetch();
845         if (cle != NULL) {
846                 CL_ENV_INC(cs_hit);
847                 env = &cle->ce_lu;
848                 *refcheck = ++cle->ce_ref;
849         }
850         CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
851         return env;
852 }
853 EXPORT_SYMBOL(cl_env_peek);
854
855 /**
856  * Returns lu_env: if there already is an environment associated with the
857  * current thread, it is returned, otherwise, new environment is allocated.
858  *
859  * Allocations are amortized through the global cache of environments.
860  *
861  * \param refcheck pointer to a counter used to detect environment leaks. In
862  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
863  * scope and pointer to the same integer is passed as \a refcheck. This is
864  * used to detect missed cl_env_put().
865  *
866  * \see cl_env_put()
867  */
868 struct lu_env *cl_env_get(int *refcheck)
869 {
870         struct lu_env *env;
871
872         env = cl_env_peek(refcheck);
873         if (env == NULL) {
874                 env = cl_env_obtain(__builtin_return_address(0));
875                 if (!IS_ERR(env)) {
876                         struct cl_env *cle;
877
878                         cle = cl_env_container(env);
879                         cl_env_attach(cle);
880                         *refcheck = cle->ce_ref;
881                         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
882                 }
883         }
884         return env;
885 }
886 EXPORT_SYMBOL(cl_env_get);
887
888 /**
889  * Forces an allocation of a fresh environment with given tags.
890  *
891  * \see cl_env_get()
892  */
893 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
894 {
895         struct lu_env *env;
896
897         LASSERT(cl_env_peek(refcheck) == NULL);
898         env = cl_env_new(tags, __builtin_return_address(0));
899         if (!IS_ERR(env)) {
900                 struct cl_env *cle;
901
902                 cle = cl_env_container(env);
903                 *refcheck = cle->ce_ref;
904                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
905         }
906         return env;
907 }
908 EXPORT_SYMBOL(cl_env_alloc);
909
910 static void cl_env_exit(struct cl_env *cle)
911 {
912         LASSERT(cle->ce_owner == NULL);
913         lu_context_exit(&cle->ce_lu.le_ctx);
914         lu_context_exit(&cle->ce_ses);
915 }
916
917 /**
918  * Finalizes and frees a given number of cached environments. This is done to
919  * (1) free some memory (not currently hooked into VM), or (2) release
920  * references to modules.
921  */
922 unsigned cl_env_cache_purge(unsigned nr)
923 {
924         struct cl_env *cle;
925
926         ENTRY;
927         cfs_spin_lock(&cl_envs_guard);
928         for (; !cfs_list_empty(&cl_envs) && nr > 0; --nr) {
929                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
930                 cfs_list_del_init(&cle->ce_linkage);
931                 LASSERT(cl_envs_cached_nr > 0);
932                 cl_envs_cached_nr--;
933                 cfs_spin_unlock(&cl_envs_guard);
934
935                 cl_env_fini(cle);
936                 cfs_spin_lock(&cl_envs_guard);
937         }
938         LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
939         cfs_spin_unlock(&cl_envs_guard);
940         RETURN(nr);
941 }
942 EXPORT_SYMBOL(cl_env_cache_purge);
943
944 /**
945  * Release an environment.
946  *
947  * Decrement \a env reference counter. When counter drops to 0, nothing in
948  * this thread is using environment and it is returned to the allocation
949  * cache, or freed straight away, if cache is large enough.
950  */
951 void cl_env_put(struct lu_env *env, int *refcheck)
952 {
953         struct cl_env *cle;
954
955         cle = cl_env_container(env);
956
957         LASSERT(cle->ce_ref > 0);
958         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
959
960         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
961         if (--cle->ce_ref == 0) {
962                 CL_ENV_DEC(cs_busy);
963                 cl_env_detach(cle);
964                 cle->ce_debug = NULL;
965                 cl_env_exit(cle);
966                 /*
967                  * Don't bother to take a lock here.
968                  *
969                  * Return environment to the cache only when it was allocated
970                  * with the standard tags.
971                  */
972                 if (cl_envs_cached_nr < cl_envs_cached_max &&
973                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
974                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
975                         cfs_spin_lock(&cl_envs_guard);
976                         cfs_list_add(&cle->ce_linkage, &cl_envs);
977                         cl_envs_cached_nr++;
978                         cfs_spin_unlock(&cl_envs_guard);
979                 } else
980                         cl_env_fini(cle);
981         }
982 }
983 EXPORT_SYMBOL(cl_env_put);
984
985 /**
986  * Declares a point of re-entrancy.
987  *
988  * \see cl_env_reexit()
989  */
990 void *cl_env_reenter(void)
991 {
992         return cl_env_detach(NULL);
993 }
994 EXPORT_SYMBOL(cl_env_reenter);
995
996 /**
997  * Exits re-entrancy.
998  */
999 void cl_env_reexit(void *cookie)
1000 {
1001         cl_env_detach(NULL);
1002         cl_env_attach(cookie);
1003 }
1004 EXPORT_SYMBOL(cl_env_reexit);
1005
1006 /**
1007  * Setup user-supplied \a env as a current environment. This is to be used to
1008  * guaranteed that environment exists even when cl_env_get() fails. It is up
1009  * to user to ensure proper concurrency control.
1010  *
1011  * \see cl_env_unplant()
1012  */
1013 void cl_env_implant(struct lu_env *env, int *refcheck)
1014 {
1015         struct cl_env *cle = cl_env_container(env);
1016
1017         LASSERT(cle->ce_ref > 0);
1018
1019         cl_env_attach(cle);
1020         cl_env_get(refcheck);
1021         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1022 }
1023 EXPORT_SYMBOL(cl_env_implant);
1024
1025 /**
1026  * Detach environment installed earlier by cl_env_implant().
1027  */
1028 void cl_env_unplant(struct lu_env *env, int *refcheck)
1029 {
1030         struct cl_env *cle = cl_env_container(env);
1031
1032         LASSERT(cle->ce_ref > 1);
1033
1034         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1035
1036         cl_env_detach(cle);
1037         cl_env_put(env, refcheck);
1038 }
1039 EXPORT_SYMBOL(cl_env_unplant);
1040
1041 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1042 {
1043         struct lu_env *env;
1044
1045         nest->cen_cookie = NULL;
1046         env = cl_env_peek(&nest->cen_refcheck);
1047         if (env != NULL) {
1048                 if (!cl_io_is_going(env))
1049                         return env;
1050                 else {
1051                         cl_env_put(env, &nest->cen_refcheck);
1052                         nest->cen_cookie = cl_env_reenter();
1053                 }
1054         }
1055         env = cl_env_get(&nest->cen_refcheck);
1056         if (IS_ERR(env)) {
1057                 cl_env_reexit(nest->cen_cookie);
1058                 return env;
1059         }
1060
1061         LASSERT(!cl_io_is_going(env));
1062         return env;
1063 }
1064 EXPORT_SYMBOL(cl_env_nested_get);
1065
1066 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1067 {
1068         cl_env_put(env, &nest->cen_refcheck);
1069         cl_env_reexit(nest->cen_cookie);
1070 }
1071 EXPORT_SYMBOL(cl_env_nested_put);
1072
1073 /**
1074  * Converts struct cl_attr to struct ost_lvb.
1075  *
1076  * \see cl_lvb2attr
1077  */
1078 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1079 {
1080         ENTRY;
1081         lvb->lvb_size   = attr->cat_size;
1082         lvb->lvb_mtime  = attr->cat_mtime;
1083         lvb->lvb_atime  = attr->cat_atime;
1084         lvb->lvb_ctime  = attr->cat_ctime;
1085         lvb->lvb_blocks = attr->cat_blocks;
1086         EXIT;
1087 }
1088 EXPORT_SYMBOL(cl_attr2lvb);
1089
1090 /**
1091  * Converts struct ost_lvb to struct cl_attr.
1092  *
1093  * \see cl_attr2lvb
1094  */
1095 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1096 {
1097         ENTRY;
1098         attr->cat_size   = lvb->lvb_size;
1099         attr->cat_mtime  = lvb->lvb_mtime;
1100         attr->cat_atime  = lvb->lvb_atime;
1101         attr->cat_ctime  = lvb->lvb_ctime;
1102         attr->cat_blocks = lvb->lvb_blocks;
1103         EXIT;
1104 }
1105 EXPORT_SYMBOL(cl_lvb2attr);
1106
1107 /*****************************************************************************
1108  *
1109  * Temporary prototype thing: mirror obd-devices into cl devices.
1110  *
1111  */
1112
1113 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1114                                 struct lu_device_type *ldt,
1115                                 struct lu_device *next)
1116 {
1117         const char       *typename;
1118         struct lu_device *d;
1119
1120         LASSERT(ldt != NULL);
1121
1122         typename = ldt->ldt_name;
1123         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1124         if (!IS_ERR(d)) {
1125                 int rc;
1126
1127                 if (site != NULL)
1128                         d->ld_site = site;
1129                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1130                 if (rc == 0) {
1131                         lu_device_get(d);
1132                         lu_ref_add(&d->ld_reference,
1133                                    "lu-stack", &lu_site_init);
1134                 } else {
1135                         ldt->ldt_ops->ldto_device_free(env, d);
1136                         CERROR("can't init device '%s', %d\n", typename, rc);
1137                         d = ERR_PTR(rc);
1138                 }
1139         } else
1140                 CERROR("Cannot allocate device: '%s'\n", typename);
1141         return lu2cl_dev(d);
1142 }
1143 EXPORT_SYMBOL(cl_type_setup);
1144
1145 /**
1146  * Finalize device stack by calling lu_stack_fini().
1147  */
1148 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1149 {
1150         lu_stack_fini(env, cl2lu_dev(cl));
1151 }
1152 EXPORT_SYMBOL(cl_stack_fini);
1153
1154 int  cl_lock_init(void);
1155 void cl_lock_fini(void);
1156
1157 int  cl_page_init(void);
1158 void cl_page_fini(void);
1159
1160 static struct lu_context_key cl_key;
1161
1162 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1163 {
1164         return lu_context_key_get(&env->le_ctx, &cl_key);
1165 }
1166
1167 /* defines cl0_key_{init,fini}() */
1168 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1169
1170 static void *cl_key_init(const struct lu_context *ctx,
1171                          struct lu_context_key *key)
1172 {
1173         struct cl_thread_info *info;
1174
1175         info = cl0_key_init(ctx, key);
1176         if (!IS_ERR(info)) {
1177                 int i;
1178
1179                 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1180                         lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1181         }
1182         return info;
1183 }
1184
1185 static void cl_key_fini(const struct lu_context *ctx,
1186                         struct lu_context_key *key, void *data)
1187 {
1188         struct cl_thread_info *info;
1189         int i;
1190
1191         info = data;
1192         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1193                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1194         cl0_key_fini(ctx, key, data);
1195 }
1196
1197 static void cl_key_exit(const struct lu_context *ctx,
1198                         struct lu_context_key *key, void *data)
1199 {
1200         struct cl_thread_info *info = data;
1201         int i;
1202
1203         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1204                 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1205                 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1206                 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1207                 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1208                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1209                 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1210         }
1211 }
1212
1213 static struct lu_context_key cl_key = {
1214         .lct_tags = LCT_CL_THREAD,
1215         .lct_init = cl_key_init,
1216         .lct_fini = cl_key_fini,
1217         .lct_exit = cl_key_exit
1218 };
1219
1220 static struct lu_kmem_descr cl_object_caches[] = {
1221         {
1222                 .ckd_cache = &cl_env_kmem,
1223                 .ckd_name  = "cl_env_kmem",
1224                 .ckd_size  = sizeof (struct cl_env)
1225         },
1226         {
1227                 .ckd_cache = NULL
1228         }
1229 };
1230
1231 /**
1232  * Global initialization of cl-data. Create kmem caches, register
1233  * lu_context_key's, etc.
1234  *
1235  * \see cl_global_fini()
1236  */
1237 int cl_global_init(void)
1238 {
1239         int result;
1240
1241         result = cl_env_store_init();
1242         if (result)
1243                 return result;
1244
1245         result = lu_kmem_init(cl_object_caches);
1246         if (result)
1247                 goto out_store;
1248
1249         LU_CONTEXT_KEY_INIT(&cl_key);
1250         result = lu_context_key_register(&cl_key);
1251         if (result)
1252                 goto out_kmem;
1253
1254         result = cl_lock_init();
1255         if (result)
1256                 goto out_context;
1257
1258         result = cl_page_init();
1259         if (result)
1260                 goto out_lock;
1261
1262         return 0;
1263 out_lock:
1264         cl_lock_fini();
1265 out_context:
1266         lu_context_key_degister(&cl_key);
1267 out_kmem:
1268         lu_kmem_fini(cl_object_caches);
1269 out_store:
1270         cl_env_store_fini();
1271         return result;
1272 }
1273
1274 /**
1275  * Finalization of global cl-data. Dual to cl_global_init().
1276  */
1277 void cl_global_fini(void)
1278 {
1279         cl_lock_fini();
1280         cl_page_fini();
1281         lu_context_key_degister(&cl_key);
1282         lu_kmem_fini(cl_object_caches);
1283         cl_env_store_fini();
1284 }