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