1 | /*
|
---|
2 | * Copyright (C) 2011 by Matthias Ringwald
|
---|
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 | *
|
---|
17 | * THIS SOFTWARE IS PROVIDED BY MATTHIAS RINGWALD AND CONTRIBUTORS
|
---|
18 | * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
---|
19 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
---|
20 | * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
|
---|
21 | * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
---|
22 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
---|
23 | * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
---|
24 | * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
---|
25 | * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
---|
26 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
---|
27 | * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
---|
28 | * SUCH DAMAGE.
|
---|
29 | *
|
---|
30 | */
|
---|
31 |
|
---|
32 | /*
|
---|
33 | * memory_pool.h
|
---|
34 | *
|
---|
35 | * @Brief Fixed-size block allocation
|
---|
36 | *
|
---|
37 | * @Assumption block_size >= sizeof(void *)
|
---|
38 | * @Assumption size of storage >= count * block_size
|
---|
39 | *
|
---|
40 | * @Note minimal implementation, no error checking/handling
|
---|
41 | */
|
---|
42 |
|
---|
43 | #ifndef __MEMORY_POOL_H
|
---|
44 | #define __MEMORY_POOL_H
|
---|
45 |
|
---|
46 | #if defined __cplusplus
|
---|
47 | extern "C" {
|
---|
48 | #endif
|
---|
49 |
|
---|
50 | typedef void * memory_pool_t;
|
---|
51 |
|
---|
52 | // initialize memory pool with with given storage, block size and count
|
---|
53 | void memory_pool_create(memory_pool_t *pool, void * storage, int count, int block_size);
|
---|
54 |
|
---|
55 | // get free block from pool, @returns NULL or pointer to block
|
---|
56 | void * memory_pool_get(memory_pool_t *pool);
|
---|
57 |
|
---|
58 | // return previously reserved block to memory pool
|
---|
59 | void memory_pool_free(memory_pool_t *pool, void * block);
|
---|
60 |
|
---|
61 | #if defined __cplusplus
|
---|
62 | }
|
---|
63 | #endif
|
---|
64 |
|
---|
65 | #endif // __MEMORY_POOL_H
|
---|