Whamcloud - gitweb
LU-12254 lnet: correct discovery LNetEQFree()
[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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * Client Lustre Object.
33  *
34  *   Author: Nikita Danilov <nikita.danilov@sun.com>
35  *   Author: Jinshan Xiong <jinshan.xiong@intel.com>
36  */
37
38 /*
39  * Locking.
40  *
41  *  i_mutex
42  *      PG_locked
43  *          ->coh_attr_guard
44  *          ->ls_guard
45  */
46
47 #define DEBUG_SUBSYSTEM S_CLASS
48
49 #include <linux/list.h>
50 #include <libcfs/libcfs.h>
51 /* class_put_type() */
52 #include <obd_class.h>
53 #include <obd_support.h>
54 #include <lustre_fid.h>
55 #include <libcfs/libcfs_hash.h> /* for cfs_hash stuff */
56 #include <cl_object.h>
57 #include <lu_object.h>
58 #include "cl_internal.h"
59
60 static struct kmem_cache *cl_env_kmem;
61
62 /** Lock class of cl_object_header::coh_attr_guard */
63 static struct lock_class_key cl_attr_guard_class;
64
65 /**
66  * Initialize cl_object_header.
67  */
68 int cl_object_header_init(struct cl_object_header *h)
69 {
70         int result;
71
72         ENTRY;
73         result = lu_object_header_init(&h->coh_lu);
74         if (result == 0) {
75                 spin_lock_init(&h->coh_attr_guard);
76                 lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
77                 h->coh_page_bufsize = 0;
78         }
79         RETURN(result);
80 }
81 EXPORT_SYMBOL(cl_object_header_init);
82
83 /**
84  * Finalize cl_object_header.
85  */
86 void cl_object_header_fini(struct cl_object_header *h)
87 {
88         lu_object_header_fini(&h->coh_lu);
89 }
90
91 /**
92  * Returns a cl_object with a given \a fid.
93  *
94  * Returns either cached or newly created object. Additional reference on the
95  * returned object is acquired.
96  *
97  * \see lu_object_find(), cl_page_find(), cl_lock_find()
98  */
99 struct cl_object *cl_object_find(const struct lu_env *env,
100                                  struct cl_device *cd, const struct lu_fid *fid,
101                                  const struct cl_object_conf *c)
102 {
103         might_sleep();
104         return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
105 }
106 EXPORT_SYMBOL(cl_object_find);
107
108 /**
109  * Releases a reference on \a o.
110  *
111  * When last reference is released object is returned to the cache, unless
112  * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
113  *
114  * \see cl_page_put(), cl_lock_put().
115  */
116 void cl_object_put(const struct lu_env *env, struct cl_object *o)
117 {
118         lu_object_put(env, &o->co_lu);
119 }
120 EXPORT_SYMBOL(cl_object_put);
121
122 /**
123  * Acquire an additional reference to the object \a o.
124  *
125  * This can only be used to acquire _additional_ reference, i.e., caller
126  * already has to possess at least one reference to \a o before calling this.
127  *
128  * \see cl_page_get(), cl_lock_get().
129  */
130 void cl_object_get(struct cl_object *o)
131 {
132         lu_object_get(&o->co_lu);
133 }
134 EXPORT_SYMBOL(cl_object_get);
135
136 /**
137  * Returns the top-object for a given \a o.
138  *
139  * \see cl_io_top()
140  */
141 struct cl_object *cl_object_top(struct cl_object *o)
142 {
143         struct cl_object_header *hdr = cl_object_header(o);
144         struct cl_object *top;
145
146         while (hdr->coh_parent != NULL)
147                 hdr = hdr->coh_parent;
148
149         top = lu2cl(lu_object_top(&hdr->coh_lu));
150         CDEBUG(D_TRACE, "%p -> %p\n", o, top);
151         return top;
152 }
153 EXPORT_SYMBOL(cl_object_top);
154
155 /**
156  * Returns pointer to the lock protecting data-attributes for the given object
157  * \a o.
158  *
159  * Data-attributes are protected by the cl_object_header::coh_attr_guard
160  * spin-lock in the top-object.
161  *
162  * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
163  */
164 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
165 {
166         return &cl_object_header(cl_object_top(o))->coh_attr_guard;
167 }
168
169 /**
170  * Locks data-attributes.
171  *
172  * Prevents data-attributes from changing, until lock is released by
173  * cl_object_attr_unlock(). This has to be called before calls to
174  * cl_object_attr_get(), cl_object_attr_update().
175  */
176 void cl_object_attr_lock(struct cl_object *o)
177 __acquires(cl_object_attr_guard(o))
178 {
179         spin_lock(cl_object_attr_guard(o));
180 }
181 EXPORT_SYMBOL(cl_object_attr_lock);
182
183 /**
184  * Releases data-attributes lock, acquired by cl_object_attr_lock().
185  */
186 void cl_object_attr_unlock(struct cl_object *o)
187 __releases(cl_object_attr_guard(o))
188 {
189         spin_unlock(cl_object_attr_guard(o));
190 }
191 EXPORT_SYMBOL(cl_object_attr_unlock);
192
193 /**
194  * Returns data-attributes of an object \a obj.
195  *
196  * Every layer is asked (by calling cl_object_operations::coo_attr_get())
197  * top-to-bottom to fill in parts of \a attr that this layer is responsible
198  * for.
199  */
200 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
201                         struct cl_attr *attr)
202 {
203         struct lu_object_header *top;
204         int result;
205
206         assert_spin_locked(cl_object_attr_guard(obj));
207         ENTRY;
208
209         top = obj->co_lu.lo_header;
210         result = 0;
211         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
212                 if (obj->co_ops->coo_attr_get != NULL) {
213                         result = obj->co_ops->coo_attr_get(env, obj, attr);
214                         if (result != 0) {
215                                 if (result > 0)
216                                         result = 0;
217                                 break;
218                         }
219                 }
220         }
221         RETURN(result);
222 }
223 EXPORT_SYMBOL(cl_object_attr_get);
224
225 /**
226  * Updates data-attributes of an object \a obj.
227  *
228  * Only attributes, mentioned in a validness bit-mask \a v are
229  * updated. Calls cl_object_operations::coo_upd_attr() on every layer, bottom
230  * to top.
231  */
232 int cl_object_attr_update(const struct lu_env *env, struct cl_object *obj,
233                           const struct cl_attr *attr, unsigned v)
234 {
235         struct lu_object_header *top;
236         int result;
237
238         assert_spin_locked(cl_object_attr_guard(obj));
239         ENTRY;
240
241         top = obj->co_lu.lo_header;
242         result = 0;
243         list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
244                 if (obj->co_ops->coo_attr_update != NULL) {
245                         result = obj->co_ops->coo_attr_update(env, obj, attr,
246                                                               v);
247                         if (result != 0) {
248                                 if (result > 0)
249                                         result = 0;
250                                 break;
251                         }
252                 }
253         }
254         RETURN(result);
255 }
256 EXPORT_SYMBOL(cl_object_attr_update);
257
258 /**
259  * Notifies layers (bottom-to-top) that glimpse AST was received.
260  *
261  * Layers have to fill \a lvb fields with information that will be shipped
262  * back to glimpse issuer.
263  *
264  * \see cl_lock_operations::clo_glimpse()
265  */
266 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
267                       struct ost_lvb *lvb)
268 {
269         struct lu_object_header *top;
270         int result;
271
272         ENTRY;
273         top = obj->co_lu.lo_header;
274         result = 0;
275         list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
276                 if (obj->co_ops->coo_glimpse != NULL) {
277                         result = obj->co_ops->coo_glimpse(env, obj, lvb);
278                         if (result != 0)
279                                 break;
280                 }
281         }
282         LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
283                          "size: %llu mtime: %llu atime: %llu "
284                          "ctime: %llu blocks: %llu\n",
285                          lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
286                          lvb->lvb_ctime, lvb->lvb_blocks);
287         RETURN(result);
288 }
289 EXPORT_SYMBOL(cl_object_glimpse);
290
291 /**
292  * Updates a configuration of an object \a obj.
293  */
294 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
295                 const struct cl_object_conf *conf)
296 {
297         struct lu_object_header *top;
298         int result;
299
300         ENTRY;
301         top = obj->co_lu.lo_header;
302         result = 0;
303         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
304                 if (obj->co_ops->coo_conf_set != NULL) {
305                         result = obj->co_ops->coo_conf_set(env, obj, conf);
306                         if (result != 0)
307                                 break;
308                 }
309         }
310         RETURN(result);
311 }
312 EXPORT_SYMBOL(cl_conf_set);
313
314 /**
315  * Prunes caches of pages and locks for this object.
316  */
317 int cl_object_prune(const struct lu_env *env, struct cl_object *obj)
318 {
319         struct lu_object_header *top;
320         struct cl_object *o;
321         int result;
322         ENTRY;
323
324         top = obj->co_lu.lo_header;
325         result = 0;
326         list_for_each_entry(o, &top->loh_layers, co_lu.lo_linkage) {
327                 if (o->co_ops->coo_prune != NULL) {
328                         result = o->co_ops->coo_prune(env, o);
329                         if (result != 0)
330                                 break;
331                 }
332         }
333
334         RETURN(result);
335 }
336 EXPORT_SYMBOL(cl_object_prune);
337
338 /**
339  * Get stripe information of this object.
340  */
341 int cl_object_getstripe(const struct lu_env *env, struct cl_object *obj,
342                         struct lov_user_md __user *uarg, size_t size)
343 {
344         struct lu_object_header *top;
345         int                     result = 0;
346         ENTRY;
347
348         top = obj->co_lu.lo_header;
349         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
350                 if (obj->co_ops->coo_getstripe != NULL) {
351                         result = obj->co_ops->coo_getstripe(env, obj, uarg,
352                                                             size);
353                         if (result != 0)
354                                 break;
355                 }
356         }
357         RETURN(result);
358 }
359 EXPORT_SYMBOL(cl_object_getstripe);
360
361 /**
362  * Get fiemap extents from file object.
363  *
364  * \param env [in]      lustre environment
365  * \param obj [in]      file object
366  * \param key [in]      fiemap request argument
367  * \param fiemap [out]  fiemap extents mapping retrived
368  * \param buflen [in]   max buffer length of @fiemap
369  *
370  * \retval 0    success
371  * \retval < 0  error
372  */
373 int cl_object_fiemap(const struct lu_env *env, struct cl_object *obj,
374                      struct ll_fiemap_info_key *key,
375                      struct fiemap *fiemap, size_t *buflen)
376 {
377         struct lu_object_header *top;
378         int                     result = 0;
379         ENTRY;
380
381         top = obj->co_lu.lo_header;
382         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
383                 if (obj->co_ops->coo_fiemap != NULL) {
384                         result = obj->co_ops->coo_fiemap(env, obj, key, fiemap,
385                                                          buflen);
386                         if (result != 0)
387                                 break;
388                 }
389         }
390         RETURN(result);
391 }
392 EXPORT_SYMBOL(cl_object_fiemap);
393
394 int cl_object_layout_get(const struct lu_env *env, struct cl_object *obj,
395                          struct cl_layout *cl)
396 {
397         struct lu_object_header *top = obj->co_lu.lo_header;
398         ENTRY;
399
400         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
401                 if (obj->co_ops->coo_layout_get != NULL)
402                         return obj->co_ops->coo_layout_get(env, obj, cl);
403         }
404
405         RETURN(-EOPNOTSUPP);
406 }
407 EXPORT_SYMBOL(cl_object_layout_get);
408
409 loff_t cl_object_maxbytes(struct cl_object *obj)
410 {
411         struct lu_object_header *top = obj->co_lu.lo_header;
412         loff_t maxbytes = LLONG_MAX;
413         ENTRY;
414
415         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
416                 if (obj->co_ops->coo_maxbytes != NULL)
417                         maxbytes = min_t(loff_t, obj->co_ops->coo_maxbytes(obj),
418                                          maxbytes);
419         }
420
421         RETURN(maxbytes);
422 }
423 EXPORT_SYMBOL(cl_object_maxbytes);
424
425 /**
426  * Helper function removing all object locks, and marking object for
427  * deletion. All object pages must have been deleted at this point.
428  *
429  * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
430  * and sub- objects respectively.
431  */
432 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
433 {
434         struct cl_object_header *hdr = cl_object_header(obj);
435
436         set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
437 }
438 EXPORT_SYMBOL(cl_object_kill);
439
440 void cache_stats_init(struct cache_stats *cs, const char *name)
441 {
442         int i;
443
444         cs->cs_name = name;
445         for (i = 0; i < CS_NR; i++)
446                 atomic_set(&cs->cs_stats[i], 0);
447 }
448
449 static int cache_stats_print(const struct cache_stats *cs,
450                              struct seq_file *m, int h)
451 {
452         int i;
453
454         /*
455          *   lookup    hit    total  cached create
456          * env: ...... ...... ...... ...... ......
457          */
458         if (h) {
459                 const char *names[CS_NR] = CS_NAMES;
460
461                 seq_printf(m, "%6s", " ");
462                 for (i = 0; i < CS_NR; i++)
463                         seq_printf(m, "%8s", names[i]);
464                 seq_printf(m, "\n");
465         }
466
467         seq_printf(m, "%5.5s:", cs->cs_name);
468         for (i = 0; i < CS_NR; i++)
469                 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
470         return 0;
471 }
472
473 static void cl_env_percpu_refill(void);
474
475 /**
476  * Initialize client site.
477  *
478  * Perform common initialization (lu_site_init()), and initialize statistical
479  * counters. Also perform global initializations on the first call.
480  */
481 int cl_site_init(struct cl_site *s, struct cl_device *d)
482 {
483         size_t i;
484         int result;
485
486         result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
487         if (result == 0) {
488                 cache_stats_init(&s->cs_pages, "pages");
489                 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
490                         atomic_set(&s->cs_pages_state[0], 0);
491                 cl_env_percpu_refill();
492         }
493         return result;
494 }
495 EXPORT_SYMBOL(cl_site_init);
496
497 /**
498  * Finalize client site. Dual to cl_site_init().
499  */
500 void cl_site_fini(struct cl_site *s)
501 {
502         lu_site_fini(&s->cs_lu);
503 }
504 EXPORT_SYMBOL(cl_site_fini);
505
506 static struct cache_stats cl_env_stats = {
507         .cs_name    = "envs",
508         .cs_stats = { ATOMIC_INIT(0), }
509 };
510
511 /**
512  * Outputs client site statistical counters into a buffer. Suitable for
513  * ll_rd_*()-style functions.
514  */
515 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
516 {
517         static const char *pstate[] = {
518                 [CPS_CACHED]    = "c",
519                 [CPS_OWNED]     = "o",
520                 [CPS_PAGEOUT]   = "w",
521                 [CPS_PAGEIN]    = "r",
522                 [CPS_FREEING]   = "f"
523         };
524         size_t i;
525
526 /*
527        lookup    hit  total   busy create
528 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
529 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
530   env: ...... ...... ...... ...... ......
531  */
532         lu_site_stats_seq_print(&site->cs_lu, m);
533         cache_stats_print(&site->cs_pages, m, 1);
534         seq_printf(m, " [");
535         for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
536                 seq_printf(m, "%s: %u ", pstate[i],
537                            atomic_read(&site->cs_pages_state[i]));
538         seq_printf(m, "]\n");
539         cache_stats_print(&cl_env_stats, m, 0);
540         seq_printf(m, "\n");
541         return 0;
542 }
543 EXPORT_SYMBOL(cl_site_stats_print);
544
545 /*****************************************************************************
546  *
547  * lu_env handling on client.
548  *
549  */
550
551 /**
552  * The most efficient way is to store cl_env pointer in task specific
553  * structures. On Linux, it isn't easy to use task_struct->journal_info
554  * because Lustre code may call into other fs during memory reclaim, which
555  * has certain assumptions about journal_info. There are not currently any
556  * fields in task_struct that can be used for this purpose.
557  * \note As long as we use task_struct to store cl_env, we assume that once
558  * called into Lustre, we'll never call into the other part of the kernel
559  * which will use those fields in task_struct without explicitly exiting
560  * Lustre.
561  *
562  * Since there's no space in task_struct is available, hash will be used.
563  * bz20044, bz22683.
564  */
565
566 static unsigned cl_envs_cached_max = 32; /* XXX: prototype: arbitrary limit
567                                           * for now. */
568 static struct cl_env_cache {
569         rwlock_t                cec_guard;
570         unsigned                cec_count;
571         struct list_head        cec_envs;
572 } *cl_envs = NULL;
573
574 struct cl_env {
575         void             *ce_magic;
576         struct lu_env     ce_lu;
577         struct lu_context ce_ses;
578
579         /*
580          * Linkage into global list of all client environments. Used for
581          * garbage collection.
582          */
583         struct list_head  ce_linkage;
584         /*
585          *
586          */
587         int               ce_ref;
588         /*
589          * Debugging field: address of the caller who made original
590          * allocation.
591          */
592         void             *ce_debug;
593 };
594
595 static void cl_env_inc(enum cache_stats_item item)
596 {
597 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
598         atomic_inc(&cl_env_stats.cs_stats[item]);
599 #endif
600 }
601
602 static void cl_env_dec(enum cache_stats_item item)
603 {
604 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
605         LASSERT(atomic_read(&cl_env_stats.cs_stats[item]) > 0);
606         atomic_dec(&cl_env_stats.cs_stats[item]);
607 #endif
608 }
609
610 static void cl_env_init0(struct cl_env *cle, void *debug)
611 {
612         LASSERT(cle->ce_ref == 0);
613         LASSERT(cle->ce_magic == &cl_env_init0);
614         LASSERT(cle->ce_debug == NULL);
615
616         cle->ce_ref = 1;
617         cle->ce_debug = debug;
618         cl_env_inc(CS_busy);
619 }
620
621 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
622 {
623         struct lu_env *env;
624         struct cl_env *cle;
625
626         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
627         if (cle != NULL) {
628                 int rc;
629
630                 INIT_LIST_HEAD(&cle->ce_linkage);
631                 cle->ce_magic = &cl_env_init0;
632                 env = &cle->ce_lu;
633                 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
634                 if (rc == 0) {
635                         rc = lu_context_init(&cle->ce_ses,
636                                              LCT_SESSION | ses_tags);
637                         if (rc == 0) {
638                                 lu_context_enter(&cle->ce_ses);
639                                 env->le_ses = &cle->ce_ses;
640                                 cl_env_init0(cle, debug);
641                         } else
642                                 lu_env_fini(env);
643                 }
644                 if (rc != 0) {
645                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
646                         env = ERR_PTR(rc);
647                 } else {
648                         cl_env_inc(CS_create);
649                         cl_env_inc(CS_total);
650                 }
651         } else
652                 env = ERR_PTR(-ENOMEM);
653         return env;
654 }
655
656 static void cl_env_fini(struct cl_env *cle)
657 {
658         cl_env_dec(CS_total);
659         lu_context_fini(&cle->ce_lu.le_ctx);
660         lu_context_fini(&cle->ce_ses);
661         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
662 }
663
664 static struct lu_env *cl_env_obtain(void *debug)
665 {
666         struct cl_env *cle;
667         struct lu_env *env;
668         int cpu = get_cpu();
669
670         ENTRY;
671
672         read_lock(&cl_envs[cpu].cec_guard);
673         LASSERT(equi(cl_envs[cpu].cec_count == 0,
674                 list_empty(&cl_envs[cpu].cec_envs)));
675         if (cl_envs[cpu].cec_count > 0) {
676                 int rc;
677
678                 cle = container_of(cl_envs[cpu].cec_envs.next, struct cl_env,
679                                    ce_linkage);
680                 list_del_init(&cle->ce_linkage);
681                 cl_envs[cpu].cec_count--;
682                 read_unlock(&cl_envs[cpu].cec_guard);
683                 put_cpu();
684
685                 env = &cle->ce_lu;
686                 rc = lu_env_refill(env);
687                 if (rc == 0) {
688                         cl_env_init0(cle, debug);
689                         lu_context_enter(&env->le_ctx);
690                         lu_context_enter(&cle->ce_ses);
691                 } else {
692                         cl_env_fini(cle);
693                         env = ERR_PTR(rc);
694                 }
695         } else {
696                 read_unlock(&cl_envs[cpu].cec_guard);
697                 put_cpu();
698                 env = cl_env_new(lu_context_tags_default,
699                                  lu_session_tags_default, debug);
700         }
701         RETURN(env);
702 }
703
704 static inline struct cl_env *cl_env_container(struct lu_env *env)
705 {
706         return container_of(env, struct cl_env, ce_lu);
707 }
708
709 /**
710  * Returns lu_env: if there already is an environment associated with the
711  * current thread, it is returned, otherwise, new environment is allocated.
712  *
713  * Allocations are amortized through the global cache of environments.
714  *
715  * \param refcheck pointer to a counter used to detect environment leaks. In
716  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
717  * scope and pointer to the same integer is passed as \a refcheck. This is
718  * used to detect missed cl_env_put().
719  *
720  * \see cl_env_put()
721  */
722 struct lu_env *cl_env_get(__u16 *refcheck)
723 {
724         struct lu_env *env;
725
726         env = cl_env_obtain(__builtin_return_address(0));
727         if (!IS_ERR(env)) {
728                 struct cl_env *cle;
729
730                 cle = cl_env_container(env);
731                 *refcheck = cle->ce_ref;
732                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
733         }
734         return env;
735 }
736 EXPORT_SYMBOL(cl_env_get);
737
738 /**
739  * Forces an allocation of a fresh environment with given tags.
740  *
741  * \see cl_env_get()
742  */
743 struct lu_env *cl_env_alloc(__u16 *refcheck, __u32 tags)
744 {
745         struct lu_env *env;
746
747         env = cl_env_new(tags, tags, __builtin_return_address(0));
748         if (!IS_ERR(env)) {
749                 struct cl_env *cle;
750
751                 cle = cl_env_container(env);
752                 *refcheck = cle->ce_ref;
753                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
754         }
755         return env;
756 }
757 EXPORT_SYMBOL(cl_env_alloc);
758
759 static void cl_env_exit(struct cl_env *cle)
760 {
761         lu_context_exit(&cle->ce_lu.le_ctx);
762         lu_context_exit(&cle->ce_ses);
763 }
764
765 /**
766  * Finalizes and frees a given number of cached environments. This is done to
767  * (1) free some memory (not currently hooked into VM), or (2) release
768  * references to modules.
769  */
770 unsigned cl_env_cache_purge(unsigned nr)
771 {
772         struct cl_env *cle;
773         unsigned i;
774
775         ENTRY;
776         for_each_possible_cpu(i) {
777                 write_lock(&cl_envs[i].cec_guard);
778                 for (; !list_empty(&cl_envs[i].cec_envs) && nr > 0; --nr) {
779                         cle = container_of(cl_envs[i].cec_envs.next,
780                                            struct cl_env, ce_linkage);
781                         list_del_init(&cle->ce_linkage);
782                         LASSERT(cl_envs[i].cec_count > 0);
783                         cl_envs[i].cec_count--;
784                         write_unlock(&cl_envs[i].cec_guard);
785
786                         cl_env_fini(cle);
787                         write_lock(&cl_envs[i].cec_guard);
788                 }
789                 LASSERT(equi(cl_envs[i].cec_count == 0,
790                         list_empty(&cl_envs[i].cec_envs)));
791                 write_unlock(&cl_envs[i].cec_guard);
792         }
793         RETURN(nr);
794 }
795 EXPORT_SYMBOL(cl_env_cache_purge);
796
797 /**
798  * Release an environment.
799  *
800  * Decrement \a env reference counter. When counter drops to 0, nothing in
801  * this thread is using environment and it is returned to the allocation
802  * cache, or freed straight away, if cache is large enough.
803  */
804 void cl_env_put(struct lu_env *env, __u16 *refcheck)
805 {
806         struct cl_env *cle;
807
808         cle = cl_env_container(env);
809
810         LASSERT(cle->ce_ref > 0);
811         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
812
813         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
814         if (--cle->ce_ref == 0) {
815                 int cpu = get_cpu();
816
817                 cl_env_dec(CS_busy);
818                 cle->ce_debug = NULL;
819                 cl_env_exit(cle);
820                 /*
821                  * Don't bother to take a lock here.
822                  *
823                  * Return environment to the cache only when it was allocated
824                  * with the standard tags.
825                  */
826                 if (cl_envs[cpu].cec_count < cl_envs_cached_max &&
827                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
828                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
829                         read_lock(&cl_envs[cpu].cec_guard);
830                         list_add(&cle->ce_linkage, &cl_envs[cpu].cec_envs);
831                         cl_envs[cpu].cec_count++;
832                         read_unlock(&cl_envs[cpu].cec_guard);
833                 } else
834                         cl_env_fini(cle);
835                 put_cpu();
836         }
837 }
838 EXPORT_SYMBOL(cl_env_put);
839
840 /**
841  * Converts struct cl_attr to struct ost_lvb.
842  *
843  * \see cl_lvb2attr
844  */
845 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
846 {
847         lvb->lvb_size   = attr->cat_size;
848         lvb->lvb_mtime  = attr->cat_mtime;
849         lvb->lvb_atime  = attr->cat_atime;
850         lvb->lvb_ctime  = attr->cat_ctime;
851         lvb->lvb_blocks = attr->cat_blocks;
852 }
853
854 /**
855  * Converts struct ost_lvb to struct cl_attr.
856  *
857  * \see cl_attr2lvb
858  */
859 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
860 {
861         attr->cat_size   = lvb->lvb_size;
862         attr->cat_mtime  = lvb->lvb_mtime;
863         attr->cat_atime  = lvb->lvb_atime;
864         attr->cat_ctime  = lvb->lvb_ctime;
865         attr->cat_blocks = lvb->lvb_blocks;
866 }
867 EXPORT_SYMBOL(cl_lvb2attr);
868
869 static struct cl_env cl_env_percpu[NR_CPUS];
870
871 static int cl_env_percpu_init(void)
872 {
873         struct cl_env *cle;
874         int tags = LCT_REMEMBER | LCT_NOREF;
875         int i, j;
876         int rc = 0;
877
878         for_each_possible_cpu(i) {
879                 struct lu_env *env;
880
881                 rwlock_init(&cl_envs[i].cec_guard);
882                 INIT_LIST_HEAD(&cl_envs[i].cec_envs);
883                 cl_envs[i].cec_count = 0;
884
885                 cle = &cl_env_percpu[i];
886                 env = &cle->ce_lu;
887
888                 INIT_LIST_HEAD(&cle->ce_linkage);
889                 cle->ce_magic = &cl_env_init0;
890                 rc = lu_env_init(env, LCT_CL_THREAD | tags);
891                 if (rc == 0) {
892                         rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
893                         if (rc == 0) {
894                                 lu_context_enter(&cle->ce_ses);
895                                 env->le_ses = &cle->ce_ses;
896                         } else {
897                                 lu_env_fini(env);
898                         }
899                 }
900                 if (rc != 0)
901                         break;
902         }
903         if (rc != 0) {
904                 /* Indices 0 to i (excluding i) were correctly initialized,
905                  * thus we must uninitialize up to i, the rest are undefined. */
906                 for (j = 0; j < i; j++) {
907                         cle = &cl_env_percpu[j];
908                         lu_context_exit(&cle->ce_ses);
909                         lu_context_fini(&cle->ce_ses);
910                         lu_env_fini(&cle->ce_lu);
911                 }
912         }
913
914         return rc;
915 }
916
917 static void cl_env_percpu_fini(void)
918 {
919         int i;
920
921         for_each_possible_cpu(i) {
922                 struct cl_env *cle = &cl_env_percpu[i];
923
924                 lu_context_exit(&cle->ce_ses);
925                 lu_context_fini(&cle->ce_ses);
926                 lu_env_fini(&cle->ce_lu);
927         }
928 }
929
930 static void cl_env_percpu_refill(void)
931 {
932         int i;
933
934         for_each_possible_cpu(i)
935                 lu_env_refill(&cl_env_percpu[i].ce_lu);
936 }
937
938 void cl_env_percpu_put(struct lu_env *env)
939 {
940         struct cl_env *cle;
941         int cpu;
942
943         cpu = smp_processor_id();
944         cle = cl_env_container(env);
945         LASSERT(cle == &cl_env_percpu[cpu]);
946
947         cle->ce_ref--;
948         LASSERT(cle->ce_ref == 0);
949
950         cl_env_dec(CS_busy);
951         cle->ce_debug = NULL;
952
953         put_cpu();
954 }
955 EXPORT_SYMBOL(cl_env_percpu_put);
956
957 struct lu_env *cl_env_percpu_get()
958 {
959         struct cl_env *cle;
960
961         cle = &cl_env_percpu[get_cpu()];
962         cl_env_init0(cle, __builtin_return_address(0));
963
964         return &cle->ce_lu;
965 }
966 EXPORT_SYMBOL(cl_env_percpu_get);
967
968 /*****************************************************************************
969  *
970  * Temporary prototype thing: mirror obd-devices into cl devices.
971  *
972  */
973
974 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
975                                 struct lu_device_type *ldt,
976                                 struct lu_device *next)
977 {
978         const char       *typename;
979         struct lu_device *d;
980
981         LASSERT(ldt != NULL);
982
983         typename = ldt->ldt_name;
984         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
985         if (!IS_ERR(d)) {
986                 int rc;
987
988                 if (site != NULL)
989                         d->ld_site = site;
990                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
991                 if (rc == 0) {
992                         lu_device_get(d);
993                         lu_ref_add(&d->ld_reference,
994                                    "lu-stack", &lu_site_init);
995                 } else {
996                         ldt->ldt_ops->ldto_device_free(env, d);
997                         CERROR("can't init device '%s', %d\n", typename, rc);
998                         d = ERR_PTR(rc);
999                 }
1000         } else
1001                 CERROR("Cannot allocate device: '%s'\n", typename);
1002         return lu2cl_dev(d);
1003 }
1004 EXPORT_SYMBOL(cl_type_setup);
1005
1006 /**
1007  * Finalize device stack by calling lu_stack_fini().
1008  */
1009 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1010 {
1011         lu_stack_fini(env, cl2lu_dev(cl));
1012 }
1013 EXPORT_SYMBOL(cl_stack_fini);
1014
1015 static struct lu_context_key cl_key;
1016
1017 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1018 {
1019         return lu_context_key_get(&env->le_ctx, &cl_key);
1020 }
1021
1022 /* defines cl_key_{init,fini}() */
1023 LU_KEY_INIT_FINI(cl, struct cl_thread_info);
1024
1025 static struct lu_context_key cl_key = {
1026         .lct_tags = LCT_CL_THREAD,
1027         .lct_init = cl_key_init,
1028         .lct_fini = cl_key_fini,
1029 };
1030
1031 static struct lu_kmem_descr cl_object_caches[] = {
1032         {
1033                 .ckd_cache = &cl_env_kmem,
1034                 .ckd_name  = "cl_env_kmem",
1035                 .ckd_size  = sizeof (struct cl_env)
1036         },
1037         {
1038                 .ckd_cache = NULL
1039         }
1040 };
1041
1042 /**
1043  * Global initialization of cl-data. Create kmem caches, register
1044  * lu_context_key's, etc.
1045  *
1046  * \see cl_global_fini()
1047  */
1048 int cl_global_init(void)
1049 {
1050         int result;
1051
1052         OBD_ALLOC(cl_envs, sizeof(*cl_envs) * num_possible_cpus());
1053         if (cl_envs == NULL)
1054                 GOTO(out, result = -ENOMEM);
1055
1056         result = lu_kmem_init(cl_object_caches);
1057         if (result)
1058                 GOTO(out_envs, result);
1059
1060         LU_CONTEXT_KEY_INIT(&cl_key);
1061         result = lu_context_key_register(&cl_key);
1062         if (result)
1063                 GOTO(out_kmem, result);
1064
1065         result = cl_env_percpu_init();
1066         if (result) /* no cl_env_percpu_fini on error */
1067                 GOTO(out_keys, result);
1068
1069         return 0;
1070
1071 out_keys:
1072         lu_context_key_degister(&cl_key);
1073 out_kmem:
1074         lu_kmem_fini(cl_object_caches);
1075 out_envs:
1076         OBD_FREE(cl_envs, sizeof(*cl_envs) * num_possible_cpus());
1077 out:
1078         return result;
1079 }
1080
1081 /**
1082  * Finalization of global cl-data. Dual to cl_global_init().
1083  */
1084 void cl_global_fini(void)
1085 {
1086         cl_env_percpu_fini();
1087         lu_context_key_degister(&cl_key);
1088         lu_kmem_fini(cl_object_caches);
1089         OBD_FREE(cl_envs, sizeof(*cl_envs) * num_possible_cpus());
1090 }