2 * Copyright (c) 2005 Jeffrey M. Hsu. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
33 #ifndef _SYS_OBJCACHE_H_
34 #define _SYS_OBJCACHE_H_
36 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
39 #include <sys/types.h>
41 #ifndef _SYS_MALLOC_H_
42 #include <sys/malloc.h>
45 #define OC_MFLAGS 0x0000ffff /* same as malloc flags */
47 typedef __boolean_t (objcache_ctor_fn)(void *obj, void *privdata, int ocflags);
48 typedef void (objcache_dtor_fn)(void *obj, void *privdata);
51 * Underlying allocator.
53 typedef void *(objcache_alloc_fn)(void *allocator_args, int ocflags);
54 typedef void (objcache_free_fn)(void *obj, void *allocator_args);
61 *objcache_create(const char *name, int cluster_limit, int nom_cache,
62 objcache_ctor_fn *ctor, objcache_dtor_fn *dtor,
64 objcache_alloc_fn *alloc, objcache_free_fn *free,
65 void *allocator_args);
67 *objcache_create_simple(malloc_type_t mtype, size_t objsize);
69 *objcache_create_mbacked(malloc_type_t mtype, size_t objsize,
70 int cluster_limit, int nom_cache,
71 objcache_ctor_fn *ctor, objcache_dtor_fn *dtor,
73 void *objcache_get(struct objcache *oc, int ocflags);
74 void objcache_put(struct objcache *oc, void *obj);
75 void objcache_dtor(struct objcache *oc, void *obj);
76 void objcache_populate_linear(struct objcache *oc, void *elts, int nelts,
78 __boolean_t objcache_reclaimlist(struct objcache *oc[], int nlist, int ocflags);
79 void objcache_destroy(struct objcache *oc);
84 * Common underlying allocators.
86 struct objcache_malloc_args {
93 void *objcache_malloc_alloc(void *allocator_args, int ocflags);
94 void objcache_malloc_free(void *obj, void *allocator_args);
96 void *objcache_nop_alloc(void *allocator_args, int ocflags);
97 void objcache_nop_free(void *obj, void *allocator_args);
101 #endif /* _KERNEL || _KERNEL_STRUCTURES */
102 #endif /* !_SYS_OBJCACHE_H_ */