xref: /btstack/src/btstack_memory_pool.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2014 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 /*
39  *  btstack_memory_pool.h
40  *
41  *  @Brief Fixed-size block allocation
42  *
43  *  @Assumption block_size >= sizeof(void *)
44  *  @Assumption size of storage >= count * block_size
45  *
46  *  @Note minimal implementation, no error checking/handling
47  */
48 
49 #ifndef btstack_memory_pool_H
50 #define btstack_memory_pool_H
51 
52 #if defined __cplusplus
53 extern "C" {
54 #endif
55 
56 typedef void * btstack_memory_pool_t;
57 
58 // initialize memory pool with with given storage, block size and count
59 void   btstack_memory_pool_create(btstack_memory_pool_t *pool, void * storage, int count, int block_size);
60 
61 // get free block from pool, @return NULL or pointer to block
62 void * btstack_memory_pool_get(btstack_memory_pool_t *pool);
63 
64 // return previously reserved block to memory pool
65 void   btstack_memory_pool_free(btstack_memory_pool_t *pool, void * block);
66 
67 #if defined __cplusplus
68 }
69 #endif
70 
71 #endif // btstack_memory_pool_H
72