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