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 33 #ifndef _SYS_OBJCACHE_H_ 34 #define _SYS_OBJCACHE_H_ 35 36 #ifndef _SYS_TYPES_H_ 37 #include <sys/types.h> 38 #endif 39 40 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 41 42 #ifndef _SYS__MALLOC_H_ 43 #include <sys/_malloc.h> 44 #endif 45 46 #define OC_MFLAGS 0x0000ffff /* same as malloc flags */ 47 48 typedef __boolean_t (objcache_ctor_fn)(void *obj, void *privdata, int ocflags); 49 typedef void (objcache_dtor_fn)(void *obj, void *privdata); 50 51 /* 52 * Underlying allocator. 53 */ 54 typedef void *(objcache_alloc_fn)(void *allocator_args, int ocflags); 55 typedef void (objcache_free_fn)(void *obj, void *allocator_args); 56 57 #ifdef _KERNEL 58 59 struct objcache; 60 61 struct objcache 62 *objcache_create(const char *name, int cluster_limit, int nom_cache, 63 objcache_ctor_fn *ctor, objcache_dtor_fn *dtor, 64 void *privdata, 65 objcache_alloc_fn *alloc, objcache_free_fn *free, 66 void *allocator_args); 67 struct objcache 68 *objcache_create_simple(malloc_type_t mtype, size_t objsize); 69 struct objcache 70 *objcache_create_mbacked(malloc_type_t mtype, size_t objsize, 71 int cluster_limit, int nom_cache, 72 objcache_ctor_fn *ctor, objcache_dtor_fn *dtor, 73 void *privdata); 74 void objcache_set_cluster_limit(struct objcache *oc, int cluster_limit); 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); 81 void objcache_destroy(struct objcache *oc); 82 83 #endif /* _KERNEL */ 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) __malloclike; 96 void *objcache_malloc_alloc_zero(void *allocator_args, int ocflags) 97 __malloclike; 98 void objcache_malloc_free(void *obj, void *allocator_args); 99 100 void *objcache_nop_alloc(void *allocator_args, int ocflags); 101 void objcache_nop_free(void *obj, void *allocator_args); 102 103 #endif /* _KERNEL */ 104 105 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 106 107 #define OBJCACHE_UNLIMITED 0x40000000 108 #define OBJCACHE_NAMELEN 32 109 110 struct objcache_stats { 111 char oc_name[OBJCACHE_NAMELEN]; /* \0 term. */ 112 113 /* 114 * >= OBJCACHE_UNLIMITED, if unlimited. 115 */ 116 u_long oc_limit; 117 118 u_long oc_requested; 119 u_long oc_used; 120 u_long oc_cached; 121 u_long oc_exhausted; 122 u_long oc_failed; 123 u_long oc_allocated; 124 u_long oc_reserved[5]; /* reserved 0. */ 125 }; 126 127 #endif /* !_SYS_OBJCACHE_H_ */ 128