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