doc: move FAQ
[dpdk.git] / lib / librte_acl / tb_mem.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
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  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _TB_MEM_H_
35 #define _TB_MEM_H_
36
37 /**
38  * @file
39  *
40  * RTE ACL temporary (build phase) memory management.
41  * Contains structures and functions to manage temporary (used by build only)
42  * memory. Memory allocated in large blocks to speed 'free' when trie is
43  * destructed (finish of build phase).
44  */
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 #include <rte_acl_osdep.h>
51 #include <setjmp.h>
52
53 struct tb_mem_block {
54         struct tb_mem_block *next;
55         struct tb_mem_pool  *pool;
56         size_t               size;
57         uint8_t             *mem;
58 };
59
60 struct tb_mem_pool {
61         struct tb_mem_block *block;
62         size_t               alignment;
63         size_t               min_alloc;
64         size_t               alloc;
65         /* jump target in case of memory allocation failure. */
66         sigjmp_buf           fail;
67 };
68
69 void *tb_alloc(struct tb_mem_pool *pool, size_t size);
70 void tb_free_pool(struct tb_mem_pool *pool);
71
72 #ifdef __cplusplus
73 }
74 #endif
75
76 #endif /* _TB_MEM_H_ */