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 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 37 38 #ifndef _SYS_TYPES_H_ 39 #include <sys/types.h> 40 #endif 41 #ifndef _SYS_MALLOC_H_ 42 #include <sys/malloc.h> 43 #endif 44 45 #define OC_MFLAGS 0x0000ffff /* same as malloc flags */ 46 47 typedef __boolean_t (objcache_ctor_fn)(void *obj, void *privdata, int ocflags); 48 typedef void (objcache_dtor_fn)(void *obj, void *privdata); 49 50 /* 51 * Underlying allocator. 52 */ 53 typedef void *(objcache_alloc_fn)(void *allocator_args, int ocflags); 54 typedef void (objcache_free_fn)(void *obj, void *allocator_args); 55 56 #ifdef _KERNEL 57 58 struct objcache; 59 60 struct objcache 61 *objcache_create(const char *name, int cluster_limit, int nom_cache, 62 objcache_ctor_fn *ctor, objcache_dtor_fn *dtor, 63 void *privdata, 64 objcache_alloc_fn *alloc, objcache_free_fn *free, 65 void *allocator_args); 66 struct objcache 67 *objcache_create_simple(malloc_type_t mtype, size_t objsize); 68 struct objcache 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, 72 void *privdata); 73 void objcache_set_cluster_limit(struct objcache *oc, int cluster_limit); 74 void *objcache_get(struct objcache *oc, int ocflags); 75 void objcache_put(struct objcache *oc, void *obj); 76 void objcache_dtor(struct objcache *oc, void *obj); 77 void objcache_populate_linear(struct objcache *oc, void *elts, int nelts, 78 int size); 79 __boolean_t objcache_reclaimlist(struct objcache *oc[], int nlist, int ocflags); 80 void objcache_destroy(struct objcache *oc); 81 82 #endif /* !_KERNEL */ 83 84 /* 85 * Common underlying allocators. 86 */ 87 struct objcache_malloc_args { 88 size_t objsize; 89 malloc_type_t mtype; 90 }; 91 92 #ifdef _KERNEL 93 94 void *objcache_malloc_alloc(void *allocator_args, int ocflags); 95 void *objcache_malloc_alloc_zero(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 105 #define OBJCACHE_UNLIMITED 0x40000000 106 #define OBJCACHE_NAMELEN 32 107 108 struct objcache_stats { 109 char oc_name[OBJCACHE_NAMELEN]; /* \0 term. */ 110 111 /* 112 * >= OBJCACHE_UNLIMITED, if unlimited. 113 */ 114 u_long oc_limit; 115 116 u_long oc_requested; 117 u_long oc_used; 118 u_long oc_cached; 119 u_long oc_exhausted; 120 u_long oc_failed; 121 u_long oc_allocated; 122 u_long oc_reserved[5]; /* reserved 0. */ 123 }; 124 125 #endif /* !_SYS_OBJCACHE_H_ */ 126