Generic cache of pre-initialized objects. It uses per-cpu caches
[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.1 2005/06/07 19:07:11 hsu Exp $
33  */
34
35 #ifndef _OBJCACHE_H_
36 #define _OBJCACHE_H_
37
38 #define OC_MFLAGS       0x0000ffff      /* same as malloc flags */
39
40 typedef boolean_t (objcache_ctor_fn)(void *obj, void *private, int ocflags);
41 typedef void (objcache_dtor_fn)(void *obj, void *private);
42
43 extern objcache_dtor_fn null_dtor;
44
45 /*
46  * Underlying allocator.
47  */
48 typedef void *(objcache_alloc_fn)(void *allocator_args, int ocflags);
49 typedef void (objcache_free_fn)(void *obj, void *allocator_args);
50
51 struct objcache;
52
53 struct objcache
54         *objcache_create(char *name, int cluster_limit, int mag_capacity,
55                          objcache_ctor_fn *ctor, objcache_dtor_fn *dtor,
56                          void *private,
57                          objcache_alloc_fn *alloc, objcache_free_fn *free,
58                          void *allocator_args);
59 void    *objcache_get(struct objcache *oc, int ocflags);
60 void     objcache_put(struct objcache *oc, void *obj);
61 void     objcache_populate_linear(struct objcache *oc, void *elts, int nelts,
62                                   int size);
63 boolean_t objcache_reclaimlist(struct objcache *oc[], int nlist, int ocflags);
64 void     objcache_destroy(struct objcache *oc);
65
66 /*
67  * Common underlying allocators.
68  */
69 struct objcache_malloc_args {
70         size_t          objsize;
71         malloc_type_t   mtype;
72 };
73 void    *objcache_malloc_alloc(void *allocator_args, int ocflags);
74 void     objcache_malloc_free(void *obj, void *allocator_args);
75
76 void    *objcache_nop_alloc(void *allocator_args, int ocflags);
77 void     objcache_nop_free(void *obj, void *allocator_args);
78
79 #endif