objcache: objcache_create on longer changes cluster_limit
[dragonfly.git] / sys / sys / objcache.h
1 /*
2  * Copyright (c) 2005 Jeffrey M. Hsu.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Jeffrey M. Hsu.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of The DragonFly Project nor the names of its
16  *    contributors may be used to endorse or promote products derived
17  *    from this software without specific, prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * $DragonFly: src/sys/sys/objcache.h,v 1.11 2008/10/26 04:29:20 sephe Exp $
33  */
34
35 #ifndef _OBJCACHE_H_
36 #define _OBJCACHE_H_
37
38 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
39
40 #ifndef _SYS_TYPES_H_
41 #include <sys/types.h>
42 #endif
43 #ifndef _SYS_MALLOC_H_
44 #include <sys/malloc.h>
45 #endif
46
47 #define OC_MFLAGS       0x0000ffff      /* same as malloc flags */
48
49 typedef __boolean_t (objcache_ctor_fn)(void *obj, void *privdata, int ocflags);
50 typedef void (objcache_dtor_fn)(void *obj, void *privdata);
51
52 /*
53  * Underlying allocator.
54  */
55 typedef void *(objcache_alloc_fn)(void *allocator_args, int ocflags);
56 typedef void (objcache_free_fn)(void *obj, void *allocator_args);
57
58 #ifdef  _KERNEL
59
60 struct objcache;
61
62 struct objcache
63         *objcache_create(const char *name, int cluster_limit, int nom_cache,
64                          objcache_ctor_fn *ctor, objcache_dtor_fn *dtor,
65                          void *privdata,
66                          objcache_alloc_fn *alloc, objcache_free_fn *free,
67                          void *allocator_args);
68 struct objcache
69         *objcache_create_simple(malloc_type_t mtype, size_t objsize);
70 struct objcache
71         *objcache_create_mbacked(malloc_type_t mtype, size_t objsize,
72                           int cluster_limit, int nom_cache,
73                           objcache_ctor_fn *ctor, objcache_dtor_fn *dtor,
74                           void *privdata);
75 void    *objcache_get(struct objcache *oc, int ocflags);
76 void     objcache_put(struct objcache *oc, void *obj);
77 void     objcache_dtor(struct objcache *oc, void *obj);
78 void     objcache_populate_linear(struct objcache *oc, void *elts, int nelts,
79                                   int size);
80 __boolean_t objcache_reclaimlist(struct objcache *oc[], int nlist, int ocflags);
81 void     objcache_destroy(struct objcache *oc);
82
83 #endif
84
85 /*
86  * Common underlying allocators.
87  */
88 struct objcache_malloc_args {
89         size_t          objsize;
90         malloc_type_t   mtype;
91 };
92
93 #ifdef  _KERNEL
94
95 void    *objcache_malloc_alloc(void *allocator_args, int ocflags);
96 void     objcache_malloc_free(void *obj, void *allocator_args);
97
98 void    *objcache_nop_alloc(void *allocator_args, int ocflags);
99 void     objcache_nop_free(void *obj, void *allocator_args);
100
101 #endif  /* !_KERNEL */
102
103 #endif  /* _KERNEL || _KERNEL_STRUCTURES */
104 #endif  /* _SYS_OBJCACHE_H_ */