DPDK  16.11.9
rte_memzone.h
Go to the documentation of this file.
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 _RTE_MEMZONE_H_
35 #define _RTE_MEMZONE_H_
36 
54 #include <stdio.h>
55 #include <rte_memory.h>
56 #include <rte_common.h>
57 
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61 
62 #define RTE_MEMZONE_2MB 0x00000001
63 #define RTE_MEMZONE_1GB 0x00000002
64 #define RTE_MEMZONE_16MB 0x00000100
65 #define RTE_MEMZONE_16GB 0x00000200
66 #define RTE_MEMZONE_256KB 0x00010000
67 #define RTE_MEMZONE_256MB 0x00020000
68 #define RTE_MEMZONE_512MB 0x00040000
69 #define RTE_MEMZONE_4GB 0x00080000
70 #define RTE_MEMZONE_SIZE_HINT_ONLY 0x00000004
76 struct rte_memzone {
77 
78 #define RTE_MEMZONE_NAMESIZE 32
79  char name[RTE_MEMZONE_NAMESIZE];
81  phys_addr_t phys_addr;
82  RTE_STD_C11
83  union {
84  void *addr;
85  uint64_t addr_64;
86  };
87  size_t len;
89  uint64_t hugepage_sz;
91  int32_t socket_id;
93  uint32_t flags;
94  uint32_t memseg_id;
95 } __attribute__((__packed__));
96 
141 const struct rte_memzone *rte_memzone_reserve(const char *name,
142  size_t len, int socket_id,
143  unsigned flags);
144 
193 const struct rte_memzone *rte_memzone_reserve_aligned(const char *name,
194  size_t len, int socket_id,
195  unsigned flags, unsigned align);
196 
251 const struct rte_memzone *rte_memzone_reserve_bounded(const char *name,
252  size_t len, int socket_id,
253  unsigned flags, unsigned align, unsigned bound);
254 
264 int rte_memzone_free(const struct rte_memzone *mz);
265 
277 const struct rte_memzone *rte_memzone_lookup(const char *name);
278 
285 void rte_memzone_dump(FILE *f);
286 
295 void rte_memzone_walk(void (*func)(const struct rte_memzone *, void *arg),
296  void *arg);
297 
298 #ifdef __cplusplus
299 }
300 #endif
301 
302 #endif /* _RTE_MEMZONE_H_ */