Sat, 28 Oct 2017 15:43:51 +0200
modules documentation
olaf@13 | 1 | /* |
universe@103 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
olaf@13 | 3 | * |
universe@259 | 4 | * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved. |
universe@103 | 5 | * |
universe@103 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@103 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@103 | 8 | * |
universe@103 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@103 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@103 | 11 | * |
universe@103 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@103 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@103 | 14 | * documentation and/or other materials provided with the distribution. |
universe@103 | 15 | * |
universe@103 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@103 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@103 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@103 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@103 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@103 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@103 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@103 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@103 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@103 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@103 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
olaf@13 | 27 | */ |
olaf@13 | 28 | |
universe@251 | 29 | #include "ucx/mempool.h" |
universe@251 | 30 | |
olaf@13 | 31 | #include <stdlib.h> |
olaf@13 | 32 | #include <string.h> |
olaf@13 | 33 | #include <stdio.h> |
universe@95 | 34 | #ifdef __cplusplus |
universe@95 | 35 | #define __STDC_FORMAT_MACROS |
universe@95 | 36 | #endif |
universe@75 | 37 | #include <inttypes.h> |
olaf@13 | 38 | |
universe@138 | 39 | /** Capsule for destructible memory chunks. */ |
olaf@13 | 40 | typedef struct { |
universe@138 | 41 | /** The destructor for the memory chunk. */ |
olaf@13 | 42 | ucx_destructor destructor; |
universe@138 | 43 | /** |
universe@138 | 44 | * First byte of the memory chunk. |
universe@138 | 45 | * Note, that the address <code>&c</code> is also the address |
universe@138 | 46 | * of the whole memory chunk. |
universe@138 | 47 | */ |
olaf@13 | 48 | char c; |
olaf@13 | 49 | } ucx_memchunk; |
olaf@13 | 50 | |
universe@138 | 51 | /** Capsule for data and its destructor. */ |
olaf@13 | 52 | typedef struct { |
universe@138 | 53 | /** The destructor for the data. */ |
olaf@13 | 54 | ucx_destructor destructor; |
universe@138 | 55 | /** A pointer to the data. */ |
olaf@13 | 56 | void *ptr; |
olaf@13 | 57 | } ucx_regdestr; |
olaf@13 | 58 | |
universe@253 | 59 | #ifdef __cplusplus |
universe@253 | 60 | extern "C" |
universe@253 | 61 | #endif |
universe@253 | 62 | void ucx_mempool_shared_destr(void* ptr) { |
olaf@13 | 63 | ucx_regdestr *rd = (ucx_regdestr*)ptr; |
olaf@13 | 64 | rd->destructor(rd->ptr); |
olaf@13 | 65 | } |
olaf@13 | 66 | |
olaf@13 | 67 | UcxMempool *ucx_mempool_new(size_t n) { |
olaf@14 | 68 | UcxMempool *pool = (UcxMempool*)malloc(sizeof(UcxMempool)); |
universe@135 | 69 | if (!pool) { |
universe@135 | 70 | return NULL; |
universe@135 | 71 | } |
universe@15 | 72 | |
universe@69 | 73 | pool->data = (void**) malloc(n * sizeof(void*)); |
universe@15 | 74 | if (pool->data == NULL) { |
universe@15 | 75 | free(pool); |
universe@15 | 76 | return NULL; |
universe@15 | 77 | } |
universe@15 | 78 | |
olaf@13 | 79 | pool->ndata = 0; |
olaf@13 | 80 | pool->size = n; |
olaf@158 | 81 | |
olaf@158 | 82 | UcxAllocator *allocator = (UcxAllocator*)malloc(sizeof(UcxAllocator)); |
olaf@158 | 83 | if(!allocator) { |
olaf@158 | 84 | free(pool->data); |
olaf@158 | 85 | free(pool); |
olaf@158 | 86 | return NULL; |
olaf@158 | 87 | } |
olaf@158 | 88 | allocator->malloc = (ucx_allocator_malloc)ucx_mempool_malloc; |
olaf@158 | 89 | allocator->calloc = (ucx_allocator_calloc)ucx_mempool_calloc; |
olaf@158 | 90 | allocator->realloc = (ucx_allocator_realloc)ucx_mempool_realloc; |
olaf@158 | 91 | allocator->free = (ucx_allocator_free)ucx_mempool_free; |
olaf@158 | 92 | allocator->pool = pool; |
olaf@158 | 93 | pool->allocator = allocator; |
olaf@158 | 94 | |
olaf@13 | 95 | return pool; |
olaf@13 | 96 | } |
olaf@13 | 97 | |
universe@15 | 98 | int ucx_mempool_chcap(UcxMempool *pool, size_t newcap) { |
universe@241 | 99 | if (newcap < pool->ndata) { |
universe@241 | 100 | return 1; |
universe@241 | 101 | } |
universe@241 | 102 | |
universe@69 | 103 | void **data = (void**) realloc(pool->data, newcap*sizeof(void*)); |
universe@135 | 104 | if (data) { |
universe@15 | 105 | pool->data = data; |
universe@15 | 106 | pool->size = newcap; |
universe@241 | 107 | return 0; |
universe@135 | 108 | } else { |
universe@241 | 109 | return 1; |
universe@15 | 110 | } |
olaf@13 | 111 | } |
olaf@13 | 112 | |
olaf@13 | 113 | void *ucx_mempool_malloc(UcxMempool *pool, size_t n) { |
universe@141 | 114 | if (pool->ndata >= pool->size) { |
universe@242 | 115 | size_t newcap = pool->size*2; |
universe@242 | 116 | if (newcap < pool->size || ucx_mempool_chcap(pool, newcap)) { |
universe@141 | 117 | return NULL; |
universe@141 | 118 | } |
universe@141 | 119 | } |
universe@141 | 120 | |
universe@248 | 121 | void *p = malloc(sizeof(ucx_destructor) + n); |
universe@248 | 122 | ucx_memchunk *mem = (ucx_memchunk*)p; |
universe@135 | 123 | if (!mem) { |
universe@135 | 124 | return NULL; |
universe@135 | 125 | } |
olaf@13 | 126 | |
olaf@13 | 127 | mem->destructor = NULL; |
olaf@13 | 128 | pool->data[pool->ndata] = mem; |
olaf@13 | 129 | pool->ndata++; |
olaf@13 | 130 | |
universe@135 | 131 | return &(mem->c); |
olaf@13 | 132 | } |
olaf@13 | 133 | |
olaf@13 | 134 | void *ucx_mempool_calloc(UcxMempool *pool, size_t nelem, size_t elsize) { |
olaf@13 | 135 | void *ptr = ucx_mempool_malloc(pool, nelem*elsize); |
universe@135 | 136 | if (!ptr) { |
olaf@13 | 137 | return NULL; |
olaf@13 | 138 | } |
olaf@13 | 139 | memset(ptr, 0, nelem * elsize); |
olaf@13 | 140 | return ptr; |
olaf@13 | 141 | } |
olaf@13 | 142 | |
olaf@13 | 143 | void *ucx_mempool_realloc(UcxMempool *pool, void *ptr, size_t n) { |
universe@28 | 144 | char *mem = ((char*)ptr) - sizeof(ucx_destructor); |
universe@15 | 145 | char *newm = (char*) realloc(mem, n + sizeof(ucx_destructor)); |
universe@135 | 146 | if (!newm) { |
universe@135 | 147 | return NULL; |
universe@135 | 148 | } |
universe@15 | 149 | if (mem != newm) { |
universe@95 | 150 | for(size_t i=0 ; i < pool->ndata ; i++) { |
olaf@14 | 151 | if(pool->data[i] == mem) { |
olaf@14 | 152 | pool->data[i] = newm; |
universe@28 | 153 | return newm + sizeof(ucx_destructor); |
olaf@14 | 154 | } |
olaf@13 | 155 | } |
universe@116 | 156 | fprintf(stderr, "FATAL: 0x%08" PRIxPTR" not in mpool 0x%08" PRIxPTR"\n", |
universe@75 | 157 | (intptr_t)ptr, (intptr_t)pool); |
universe@241 | 158 | abort(); |
universe@16 | 159 | } else { |
universe@28 | 160 | return newm + sizeof(ucx_destructor); |
olaf@13 | 161 | } |
olaf@13 | 162 | } |
olaf@13 | 163 | |
olaf@113 | 164 | void ucx_mempool_free(UcxMempool *pool, void *ptr) { |
olaf@113 | 165 | ucx_memchunk *chunk = (ucx_memchunk*)((char*)ptr-sizeof(ucx_destructor)); |
olaf@113 | 166 | for(size_t i=0 ; i<pool->ndata ; i++) { |
olaf@113 | 167 | if(chunk == pool->data[i]) { |
olaf@113 | 168 | if(chunk->destructor != NULL) { |
universe@141 | 169 | chunk->destructor(&(chunk->c)); |
olaf@113 | 170 | } |
olaf@113 | 171 | free(chunk); |
olaf@113 | 172 | size_t last_index = pool->ndata - 1; |
olaf@113 | 173 | if(i != last_index) { |
olaf@113 | 174 | pool->data[i] = pool->data[last_index]; |
universe@141 | 175 | pool->data[last_index] = NULL; |
olaf@113 | 176 | } |
olaf@113 | 177 | pool->ndata--; |
olaf@113 | 178 | return; |
olaf@113 | 179 | } |
olaf@113 | 180 | } |
universe@116 | 181 | fprintf(stderr, "FATAL: 0x%08" PRIxPTR" not in mpool 0x%08" PRIxPTR"\n", |
olaf@113 | 182 | (intptr_t)ptr, (intptr_t)pool); |
universe@240 | 183 | abort(); |
olaf@113 | 184 | } |
olaf@113 | 185 | |
olaf@113 | 186 | void ucx_mempool_destroy(UcxMempool *pool) { |
olaf@13 | 187 | ucx_memchunk *chunk; |
universe@95 | 188 | for(size_t i=0 ; i<pool->ndata ; i++) { |
olaf@13 | 189 | chunk = (ucx_memchunk*) pool->data[i]; |
olaf@113 | 190 | if(chunk) { |
universe@135 | 191 | if(chunk->destructor) { |
universe@135 | 192 | chunk->destructor(&(chunk->c)); |
olaf@113 | 193 | } |
olaf@113 | 194 | free(chunk); |
olaf@13 | 195 | } |
olaf@13 | 196 | } |
olaf@13 | 197 | free(pool->data); |
olaf@158 | 198 | free(pool->allocator); |
olaf@13 | 199 | free(pool); |
olaf@13 | 200 | } |
olaf@13 | 201 | |
olaf@13 | 202 | void ucx_mempool_set_destr(void *ptr, ucx_destructor func) { |
olaf@13 | 203 | *(ucx_destructor*)((char*)ptr-sizeof(ucx_destructor)) = func; |
olaf@13 | 204 | } |
olaf@13 | 205 | |
olaf@13 | 206 | void ucx_mempool_reg_destr(UcxMempool *pool, void *ptr, ucx_destructor destr) { |
olaf@13 | 207 | ucx_regdestr *rd = (ucx_regdestr*)ucx_mempool_malloc( |
olaf@13 | 208 | pool, |
olaf@13 | 209 | sizeof(ucx_regdestr)); |
olaf@13 | 210 | rd->destructor = destr; |
olaf@14 | 211 | rd->ptr = ptr; |
olaf@13 | 212 | ucx_mempool_set_destr(rd, ucx_mempool_shared_destr); |
olaf@13 | 213 | } |
olaf@113 | 214 |