4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef MALLOC_ELEM_H_
35 #define MALLOC_ELEM_H_
37 #include <rte_memory.h>
39 /* dummy definition of struct so we can use pointers to it in malloc_elem struct */
45 ELEM_PAD /* element is a padding-only header */
49 struct malloc_heap *heap;
50 struct malloc_elem *volatile prev; /* points to prev elem in memzone */
51 LIST_ENTRY(malloc_elem) free_list; /* list of free elements in heap */
52 const struct rte_memzone *mz;
53 volatile enum elem_state state;
56 #ifdef RTE_LIBRTE_MALLOC_DEBUG
57 uint64_t header_cookie; /* Cookie marking start of data */
58 /* trailer cookie at start + size */
60 } __rte_cache_aligned;
62 #ifndef RTE_LIBRTE_MALLOC_DEBUG
63 static const unsigned MALLOC_ELEM_TRAILER_LEN = 0;
65 /* dummy function - just check if pointer is non-null */
67 malloc_elem_cookies_ok(const struct malloc_elem *elem){ return elem != NULL; }
69 /* dummy function - no header if malloc_debug is not enabled */
71 set_header(struct malloc_elem *elem __rte_unused){ }
73 /* dummy function - no trailer if malloc_debug is not enabled */
75 set_trailer(struct malloc_elem *elem __rte_unused){ }
79 static const unsigned MALLOC_ELEM_TRAILER_LEN = RTE_CACHE_LINE_SIZE;
81 #define MALLOC_HEADER_COOKIE 0xbadbadbadadd2e55ULL /**< Header cookie. */
82 #define MALLOC_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
84 /* define macros to make referencing the header and trailer cookies easier */
85 #define MALLOC_ELEM_TRAILER(elem) (*((uint64_t*)RTE_PTR_ADD(elem, \
86 elem->size - MALLOC_ELEM_TRAILER_LEN)))
87 #define MALLOC_ELEM_HEADER(elem) (elem->header_cookie)
90 set_header(struct malloc_elem *elem)
93 MALLOC_ELEM_HEADER(elem) = MALLOC_HEADER_COOKIE;
97 set_trailer(struct malloc_elem *elem)
100 MALLOC_ELEM_TRAILER(elem) = MALLOC_TRAILER_COOKIE;
103 /* check that the header and trailer cookies are set correctly */
105 malloc_elem_cookies_ok(const struct malloc_elem *elem)
107 return (elem != NULL &&
108 MALLOC_ELEM_HEADER(elem) == MALLOC_HEADER_COOKIE &&
109 MALLOC_ELEM_TRAILER(elem) == MALLOC_TRAILER_COOKIE);
114 static const unsigned MALLOC_ELEM_HEADER_LEN = sizeof(struct malloc_elem);
115 #define MALLOC_ELEM_OVERHEAD (MALLOC_ELEM_HEADER_LEN + MALLOC_ELEM_TRAILER_LEN)
118 * Given a pointer to the start of a memory block returned by malloc, get
119 * the actual malloc_elem header for that block.
121 static inline struct malloc_elem *
122 malloc_elem_from_data(const void *data)
127 struct malloc_elem *elem = RTE_PTR_SUB(data, MALLOC_ELEM_HEADER_LEN);
128 if (!malloc_elem_cookies_ok(elem))
130 return elem->state != ELEM_PAD ? elem: RTE_PTR_SUB(elem, elem->pad);
134 * initialise a malloc_elem header
137 malloc_elem_init(struct malloc_elem *elem,
138 struct malloc_heap *heap,
139 const struct rte_memzone *mz,
143 * initialise a dummy malloc_elem header for the end-of-memzone marker
146 malloc_elem_mkend(struct malloc_elem *elem,
147 struct malloc_elem *prev_free);
150 * return true if the current malloc_elem can hold a block of data
151 * of the requested size and with the requested alignment
154 malloc_elem_can_hold(struct malloc_elem *elem, size_t size, unsigned align);
157 * reserve a block of data in an existing malloc_elem. If the malloc_elem
158 * is much larger than the data block requested, we split the element in two.
161 malloc_elem_alloc(struct malloc_elem *elem, size_t size, unsigned align);
164 * free a malloc_elem block by adding it to the free list. If the
165 * blocks either immediately before or immediately after newly freed block
166 * are also free, the blocks are merged together.
169 malloc_elem_free(struct malloc_elem *elem);
172 * attempt to resize a malloc_elem by expanding into any free space
173 * immediately after it in memory.
176 malloc_elem_resize(struct malloc_elem *elem, size_t size);
179 * Given an element size, compute its freelist index.
182 malloc_elem_free_list_index(size_t size);
185 * Add element to its heap's free list.
188 malloc_elem_free_list_insert(struct malloc_elem *elem);
190 #endif /* MALLOC_ELEM_H_ */