first public release

[dpdk.git] / lib / librte_malloc / malloc_heap.h

diff --git a/lib/librte_malloc/malloc_heap.h b/lib/librte_malloc/malloc_heap.h
new file mode 100644 (file)
index 0000000..cf599d9
--- /dev/null
+++ b/lib/librte_malloc/malloc_heap.h
@@ -0,0 +1,68 @@
+/*-
+ *   BSD LICENSE
+ * 
+ *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
+ *   All rights reserved.
+ * 
+ *   Redistribution and use in source and binary forms, with or without 
+ *   modification, are permitted provided that the following conditions 
+ *   are met:
+ * 
+ *     * Redistributions of source code must retain the above copyright 
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright 
+ *       notice, this list of conditions and the following disclaimer in 
+ *       the documentation and/or other materials provided with the 
+ *       distribution.
+ *     * Neither the name of Intel Corporation nor the names of its 
+ *       contributors may be used to endorse or promote products derived 
+ *       from this software without specific prior written permission.
+ * 
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ *  version: DPDK.L.1.2.3-3
+ */
+
+#ifndef MALLOC_HEAP_H_
+#define MALLOC_HEAP_H_
+
+enum heap_state {
+       NOT_INITIALISED = 0,
+       INITIALISED
+};
+
+struct malloc_heap {
+       enum heap_state initialised;
+       unsigned numa_socket;
+       volatile unsigned mz_count;
+       rte_spinlock_t lock;
+       struct malloc_elem * volatile free_head;
+} __rte_cache_aligned;
+
+#define RTE_MALLOC_SOCKET_DEFAULT      0
+
+static inline unsigned
+malloc_get_numa_socket(void)
+{
+       unsigned malloc_socket = RTE_MALLOC_SOCKET_DEFAULT;
+       #ifdef RTE_MALLOC_PER_NUMA_NODE
+               malloc_socket = rte_socket_id();
+       #endif
+       return malloc_socket;
+}
+
+void *
+malloc_heap_alloc(struct malloc_heap *heap, const char *type,
+               size_t size, unsigned align);
+
+#endif /* MALLOC_HEAP_H_ */