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