first public release
[dpdk.git] / lib / librte_malloc / malloc_heap.h
1 /*-
2  *   BSD LICENSE
3  * 
4  *   Copyright(c) 2010-2012 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  *  version: DPDK.L.1.2.3-3
34  */
35
36 #ifndef MALLOC_HEAP_H_
37 #define MALLOC_HEAP_H_
38
39 enum heap_state {
40         NOT_INITIALISED = 0,
41         INITIALISED
42 };
43
44 struct malloc_heap {
45         enum heap_state initialised;
46         unsigned numa_socket;
47         volatile unsigned mz_count;
48         rte_spinlock_t lock;
49         struct malloc_elem * volatile free_head;
50 } __rte_cache_aligned;
51
52 #define RTE_MALLOC_SOCKET_DEFAULT       0
53
54 static inline unsigned
55 malloc_get_numa_socket(void)
56 {
57         unsigned malloc_socket = RTE_MALLOC_SOCKET_DEFAULT;
58         #ifdef RTE_MALLOC_PER_NUMA_NODE
59                 malloc_socket = rte_socket_id();
60         #endif
61         return malloc_socket;
62 }
63
64 void *
65 malloc_heap_alloc(struct malloc_heap *heap, const char *type,
66                 size_t size, unsigned align);
67
68 #endif /* MALLOC_HEAP_H_ */