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