1b7579f77SDag-Erling Smørgrav /* 2b7579f77SDag-Erling Smørgrav * util/alloc.h - memory allocation service. 3b7579f77SDag-Erling Smørgrav * 4b7579f77SDag-Erling Smørgrav * Copyright (c) 2007, NLnet Labs. All rights reserved. 5b7579f77SDag-Erling Smørgrav * 6b7579f77SDag-Erling Smørgrav * This software is open source. 7b7579f77SDag-Erling Smørgrav * 8b7579f77SDag-Erling Smørgrav * Redistribution and use in source and binary forms, with or without 9b7579f77SDag-Erling Smørgrav * modification, are permitted provided that the following conditions 10b7579f77SDag-Erling Smørgrav * are met: 11b7579f77SDag-Erling Smørgrav * 12b7579f77SDag-Erling Smørgrav * Redistributions of source code must retain the above copyright notice, 13b7579f77SDag-Erling Smørgrav * this list of conditions and the following disclaimer. 14b7579f77SDag-Erling Smørgrav * 15b7579f77SDag-Erling Smørgrav * Redistributions in binary form must reproduce the above copyright notice, 16b7579f77SDag-Erling Smørgrav * this list of conditions and the following disclaimer in the documentation 17b7579f77SDag-Erling Smørgrav * and/or other materials provided with the distribution. 18b7579f77SDag-Erling Smørgrav * 19b7579f77SDag-Erling Smørgrav * Neither the name of the NLNET LABS nor the names of its contributors may 20b7579f77SDag-Erling Smørgrav * be used to endorse or promote products derived from this software without 21b7579f77SDag-Erling Smørgrav * specific prior written permission. 22b7579f77SDag-Erling Smørgrav * 23b7579f77SDag-Erling Smørgrav * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2417d15b25SDag-Erling Smørgrav * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2517d15b25SDag-Erling Smørgrav * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2617d15b25SDag-Erling Smørgrav * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2717d15b25SDag-Erling Smørgrav * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2817d15b25SDag-Erling Smørgrav * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 2917d15b25SDag-Erling Smørgrav * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 3017d15b25SDag-Erling Smørgrav * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 3117d15b25SDag-Erling Smørgrav * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 3217d15b25SDag-Erling Smørgrav * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3317d15b25SDag-Erling Smørgrav * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34b7579f77SDag-Erling Smørgrav */ 35b7579f77SDag-Erling Smørgrav 36b7579f77SDag-Erling Smørgrav /** 37b7579f77SDag-Erling Smørgrav * \file 38b7579f77SDag-Erling Smørgrav * 39b7579f77SDag-Erling Smørgrav * This file contains memory allocation functions. 40b7579f77SDag-Erling Smørgrav * 41b7579f77SDag-Erling Smørgrav * The reasons for this service are: 42b7579f77SDag-Erling Smørgrav * o Avoid locking costs of getting global lock to call malloc(). 43b7579f77SDag-Erling Smørgrav * o The packed rrset type needs to be kept on special freelists, 44b7579f77SDag-Erling Smørgrav * so that they are reused for other packet rrset allocations. 45b7579f77SDag-Erling Smørgrav * 46b7579f77SDag-Erling Smørgrav */ 47b7579f77SDag-Erling Smørgrav 48b7579f77SDag-Erling Smørgrav #ifndef UTIL_ALLOC_H 49b7579f77SDag-Erling Smørgrav #define UTIL_ALLOC_H 50b7579f77SDag-Erling Smørgrav 51b7579f77SDag-Erling Smørgrav #include "util/locks.h" 52b7579f77SDag-Erling Smørgrav struct ub_packed_rrset_key; 53b7579f77SDag-Erling Smørgrav struct regional; 54b7579f77SDag-Erling Smørgrav 55b7579f77SDag-Erling Smørgrav /** The special type, packed rrset. Not allowed to be used for other memory */ 563005e0a3SDag-Erling Smørgrav typedef struct ub_packed_rrset_key alloc_special_type; 57b7579f77SDag-Erling Smørgrav /** clean the special type. Pass pointer. */ 58b7579f77SDag-Erling Smørgrav #define alloc_special_clean(x) (x)->id = 0; 59b7579f77SDag-Erling Smørgrav /** access next pointer. (in available spot). Pass pointer. */ 603005e0a3SDag-Erling Smørgrav #define alloc_special_next(x) ((alloc_special_type*)((x)->entry.overflow_next)) 61b7579f77SDag-Erling Smørgrav /** set next pointer. (in available spot). Pass pointers. */ 62b7579f77SDag-Erling Smørgrav #define alloc_set_special_next(x, y) \ 63b7579f77SDag-Erling Smørgrav ((x)->entry.overflow_next) = (struct lruhash_entry*)(y); 64b7579f77SDag-Erling Smørgrav 65b7579f77SDag-Erling Smørgrav /** how many blocks to cache locally. */ 66b7579f77SDag-Erling Smørgrav #define ALLOC_SPECIAL_MAX 10 67b7579f77SDag-Erling Smørgrav 68b7579f77SDag-Erling Smørgrav /** 69b7579f77SDag-Erling Smørgrav * Structure that provides allocation. Use one per thread. 70b7579f77SDag-Erling Smørgrav * The one on top has a NULL super pointer. 71b7579f77SDag-Erling Smørgrav */ 72b7579f77SDag-Erling Smørgrav struct alloc_cache { 73b7579f77SDag-Erling Smørgrav /** lock, only used for the super. */ 743005e0a3SDag-Erling Smørgrav lock_quick_type lock; 75b7579f77SDag-Erling Smørgrav /** global allocator above this one. NULL for none (malloc/free) */ 76b7579f77SDag-Erling Smørgrav struct alloc_cache* super; 77b7579f77SDag-Erling Smørgrav /** singly linked lists of special type. These are free for use. */ 783005e0a3SDag-Erling Smørgrav alloc_special_type* quar; 79b7579f77SDag-Erling Smørgrav /** number of items in quarantine. */ 80b7579f77SDag-Erling Smørgrav size_t num_quar; 81b7579f77SDag-Erling Smørgrav /** thread number for id creation */ 82b7579f77SDag-Erling Smørgrav int thread_num; 83b7579f77SDag-Erling Smørgrav /** next id number to pass out */ 84b7579f77SDag-Erling Smørgrav uint64_t next_id; 85b7579f77SDag-Erling Smørgrav /** last id number possible */ 86b7579f77SDag-Erling Smørgrav uint64_t last_id; 87b7579f77SDag-Erling Smørgrav /** what function to call to cleanup when last id is reached */ 88b7579f77SDag-Erling Smørgrav void (*cleanup)(void*); 89b7579f77SDag-Erling Smørgrav /** user arg for cleanup */ 90b7579f77SDag-Erling Smørgrav void* cleanup_arg; 91b7579f77SDag-Erling Smørgrav 92b7579f77SDag-Erling Smørgrav /** how many regional blocks to keep back max */ 93b7579f77SDag-Erling Smørgrav size_t max_reg_blocks; 94b7579f77SDag-Erling Smørgrav /** how many regional blocks are kept now */ 95b7579f77SDag-Erling Smørgrav size_t num_reg_blocks; 96b7579f77SDag-Erling Smørgrav /** linked list of regional blocks, using regional->next */ 97b7579f77SDag-Erling Smørgrav struct regional* reg_list; 98b7579f77SDag-Erling Smørgrav }; 99b7579f77SDag-Erling Smørgrav 100b7579f77SDag-Erling Smørgrav /** 101b7579f77SDag-Erling Smørgrav * Init alloc (zeroes the struct). 102b7579f77SDag-Erling Smørgrav * @param alloc: this parameter is allocated by the caller. 103b7579f77SDag-Erling Smørgrav * @param super: super to use (init that before with super_init). 104b7579f77SDag-Erling Smørgrav * Pass this argument NULL to init the toplevel alloc structure. 105b7579f77SDag-Erling Smørgrav * @param thread_num: thread number for id creation of special type. 106b7579f77SDag-Erling Smørgrav */ 107b7579f77SDag-Erling Smørgrav void alloc_init(struct alloc_cache* alloc, struct alloc_cache* super, 108b7579f77SDag-Erling Smørgrav int thread_num); 109b7579f77SDag-Erling Smørgrav 110b7579f77SDag-Erling Smørgrav /** 111b7579f77SDag-Erling Smørgrav * Free the alloc. Pushes all the cached items into the super structure. 112b7579f77SDag-Erling Smørgrav * Or deletes them if alloc->super is NULL. 113b7579f77SDag-Erling Smørgrav * Does not free the alloc struct itself (it was also allocated by caller). 114b7579f77SDag-Erling Smørgrav * @param alloc: is almost zeroed on exit (except some stats). 115b7579f77SDag-Erling Smørgrav */ 116b7579f77SDag-Erling Smørgrav void alloc_clear(struct alloc_cache* alloc); 117b7579f77SDag-Erling Smørgrav 118b7579f77SDag-Erling Smørgrav /** 119*3bd4df0aSDag-Erling Smørgrav * Free the special alloced items. The rrset and message caches must be 120*3bd4df0aSDag-Erling Smørgrav * empty, there must be no more references to rrset pointers into the 121*3bd4df0aSDag-Erling Smørgrav * rrset cache. 122*3bd4df0aSDag-Erling Smørgrav * @param alloc: the special allocs are freed. 123*3bd4df0aSDag-Erling Smørgrav */ 124*3bd4df0aSDag-Erling Smørgrav void alloc_clear_special(struct alloc_cache* alloc); 125*3bd4df0aSDag-Erling Smørgrav 126*3bd4df0aSDag-Erling Smørgrav /** 1273005e0a3SDag-Erling Smørgrav * Get a new special_type element. 128b7579f77SDag-Erling Smørgrav * @param alloc: where to alloc it. 129b7579f77SDag-Erling Smørgrav * @return: memory block. Will not return NULL (instead fatal_exit). 130b7579f77SDag-Erling Smørgrav * The block is zeroed. 131b7579f77SDag-Erling Smørgrav */ 1323005e0a3SDag-Erling Smørgrav alloc_special_type* alloc_special_obtain(struct alloc_cache* alloc); 133b7579f77SDag-Erling Smørgrav 134b7579f77SDag-Erling Smørgrav /** 1353005e0a3SDag-Erling Smørgrav * Return special_type back to pool. 136b7579f77SDag-Erling Smørgrav * The block is cleaned up (zeroed) which also invalidates the ID inside. 137b7579f77SDag-Erling Smørgrav * @param alloc: where to alloc it. 138b7579f77SDag-Erling Smørgrav * @param mem: block to free. 139b7579f77SDag-Erling Smørgrav */ 1403005e0a3SDag-Erling Smørgrav void alloc_special_release(struct alloc_cache* alloc, alloc_special_type* mem); 141b7579f77SDag-Erling Smørgrav 142b7579f77SDag-Erling Smørgrav /** 143b7579f77SDag-Erling Smørgrav * Set ID number of special type to a fresh new ID number. 144b7579f77SDag-Erling Smørgrav * In case of ID number overflow, the rrset cache has to be cleared. 145b7579f77SDag-Erling Smørgrav * @param alloc: the alloc cache 146b7579f77SDag-Erling Smørgrav * @return: fresh id is returned. 147b7579f77SDag-Erling Smørgrav */ 148b7579f77SDag-Erling Smørgrav uint64_t alloc_get_id(struct alloc_cache* alloc); 149b7579f77SDag-Erling Smørgrav 150b7579f77SDag-Erling Smørgrav /** 151b7579f77SDag-Erling Smørgrav * Get memory size of alloc cache, alloc structure including special types. 152b7579f77SDag-Erling Smørgrav * @param alloc: on what alloc. 153b7579f77SDag-Erling Smørgrav * @return size in bytes. 154b7579f77SDag-Erling Smørgrav */ 155b7579f77SDag-Erling Smørgrav size_t alloc_get_mem(struct alloc_cache* alloc); 156b7579f77SDag-Erling Smørgrav 157b7579f77SDag-Erling Smørgrav /** 158b7579f77SDag-Erling Smørgrav * Print debug information (statistics). 159b7579f77SDag-Erling Smørgrav * @param alloc: on what alloc. 160b7579f77SDag-Erling Smørgrav */ 161b7579f77SDag-Erling Smørgrav void alloc_stats(struct alloc_cache* alloc); 162b7579f77SDag-Erling Smørgrav 163b7579f77SDag-Erling Smørgrav /** 164b7579f77SDag-Erling Smørgrav * Get a new regional for query states 165b7579f77SDag-Erling Smørgrav * @param alloc: where to alloc it. 166b7579f77SDag-Erling Smørgrav * @return regional for use or NULL on alloc failure. 167b7579f77SDag-Erling Smørgrav */ 168b7579f77SDag-Erling Smørgrav struct regional* alloc_reg_obtain(struct alloc_cache* alloc); 169b7579f77SDag-Erling Smørgrav 170b7579f77SDag-Erling Smørgrav /** 171b7579f77SDag-Erling Smørgrav * Put regional for query states back into alloc cache. 172b7579f77SDag-Erling Smørgrav * @param alloc: where to alloc it. 173b7579f77SDag-Erling Smørgrav * @param r: regional to put back. 174b7579f77SDag-Erling Smørgrav */ 175b7579f77SDag-Erling Smørgrav void alloc_reg_release(struct alloc_cache* alloc, struct regional* r); 176b7579f77SDag-Erling Smørgrav 177b7579f77SDag-Erling Smørgrav /** 178b7579f77SDag-Erling Smørgrav * Set cleanup on ID overflow callback function. This should remove all 179b7579f77SDag-Erling Smørgrav * RRset ID references from the program. Clear the caches. 180b7579f77SDag-Erling Smørgrav * @param alloc: the alloc 181b7579f77SDag-Erling Smørgrav * @param cleanup: the callback function, called as cleanup(arg). 182b7579f77SDag-Erling Smørgrav * @param arg: user argument to callback function. 183b7579f77SDag-Erling Smørgrav */ 184b7579f77SDag-Erling Smørgrav void alloc_set_id_cleanup(struct alloc_cache* alloc, void (*cleanup)(void*), 185b7579f77SDag-Erling Smørgrav void* arg); 186b7579f77SDag-Erling Smørgrav 187b7579f77SDag-Erling Smørgrav #ifdef UNBOUND_ALLOC_LITE 18809a3aaf3SDag-Erling Smørgrav # include <sldns/ldns.h> 18909a3aaf3SDag-Erling Smørgrav # include <sldns/packet.h> 1908ed2b524SDag-Erling Smørgrav # ifdef HAVE_OPENSSL_SSL_H 191b7579f77SDag-Erling Smørgrav # include <openssl/ssl.h> 1928ed2b524SDag-Erling Smørgrav # endif 193b7579f77SDag-Erling Smørgrav # define malloc(s) unbound_stat_malloc_lite(s, __FILE__, __LINE__, __func__) 194b7579f77SDag-Erling Smørgrav # define calloc(n,s) unbound_stat_calloc_lite(n, s, __FILE__, __LINE__, __func__) 195b7579f77SDag-Erling Smørgrav # define free(p) unbound_stat_free_lite(p, __FILE__, __LINE__, __func__) 196b7579f77SDag-Erling Smørgrav # define realloc(p,s) unbound_stat_realloc_lite(p, s, __FILE__, __LINE__, __func__) 197b7579f77SDag-Erling Smørgrav void *unbound_stat_malloc_lite(size_t size, const char* file, int line, 198b7579f77SDag-Erling Smørgrav const char* func); 199b7579f77SDag-Erling Smørgrav void *unbound_stat_calloc_lite(size_t nmemb, size_t size, const char* file, 200b7579f77SDag-Erling Smørgrav int line, const char* func); 201b7579f77SDag-Erling Smørgrav void unbound_stat_free_lite(void *ptr, const char* file, int line, 202b7579f77SDag-Erling Smørgrav const char* func); 203b7579f77SDag-Erling Smørgrav void *unbound_stat_realloc_lite(void *ptr, size_t size, const char* file, 204b7579f77SDag-Erling Smørgrav int line, const char* func); 205b7579f77SDag-Erling Smørgrav # ifdef strdup 206b7579f77SDag-Erling Smørgrav # undef strdup 207b7579f77SDag-Erling Smørgrav # endif 208b7579f77SDag-Erling Smørgrav # define strdup(s) unbound_strdup_lite(s, __FILE__, __LINE__, __func__) 209b7579f77SDag-Erling Smørgrav char* unbound_strdup_lite(const char* s, const char* file, int line, 210b7579f77SDag-Erling Smørgrav const char* func); 211b7579f77SDag-Erling Smørgrav char* unbound_lite_wrapstr(char* s); 21217d15b25SDag-Erling Smørgrav # define sldns_rr2str(rr) unbound_lite_wrapstr(sldns_rr2str(rr)) 21317d15b25SDag-Erling Smørgrav # define sldns_rdf2str(rdf) unbound_lite_wrapstr(sldns_rdf2str(rdf)) 21417d15b25SDag-Erling Smørgrav # define sldns_rr_type2str(t) unbound_lite_wrapstr(sldns_rr_type2str(t)) 21517d15b25SDag-Erling Smørgrav # define sldns_rr_class2str(c) unbound_lite_wrapstr(sldns_rr_class2str(c)) 21617d15b25SDag-Erling Smørgrav # define sldns_rr_list2str(r) unbound_lite_wrapstr(sldns_rr_list2str(r)) 21717d15b25SDag-Erling Smørgrav # define sldns_pkt2str(p) unbound_lite_wrapstr(sldns_pkt2str(p)) 21817d15b25SDag-Erling Smørgrav # define sldns_pkt_rcode2str(r) unbound_lite_wrapstr(sldns_pkt_rcode2str(r)) 21917d15b25SDag-Erling Smørgrav # define sldns_pkt2wire(a, r, s) unbound_lite_pkt2wire(a, r, s) 22017d15b25SDag-Erling Smørgrav sldns_status unbound_lite_pkt2wire(uint8_t **dest, const sldns_pkt *p, size_t *size); 221b7579f77SDag-Erling Smørgrav # define i2d_DSA_SIG(d, s) unbound_lite_i2d_DSA_SIG(d, s) 222b7579f77SDag-Erling Smørgrav int unbound_lite_i2d_DSA_SIG(DSA_SIG* dsasig, unsigned char** sig); 223b7579f77SDag-Erling Smørgrav #endif /* UNBOUND_ALLOC_LITE */ 224b7579f77SDag-Erling Smørgrav 225b7579f77SDag-Erling Smørgrav #endif /* UTIL_ALLOC_H */ 226