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