DPDK  16.04.0
rte_ivshmem.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_IVSHMEM_H_
35 #define RTE_IVSHMEM_H_
36 
37 #include <rte_memzone.h>
38 #include <rte_mempool.h>
39 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 #define IVSHMEM_MAGIC 0x0BADC0DE
53 #define IVSHMEM_NAME_LEN 32
54 
59  struct rte_memzone mz;
60  uint64_t offset;
61 };
62 
68  char name[IVSHMEM_NAME_LEN];
69  struct rte_ivshmem_metadata_entry entry[RTE_LIBRTE_IVSHMEM_MAX_ENTRIES];
71 };
72 
83 int rte_ivshmem_metadata_create(const char * name);
84 
98  const char * md_name);
99 
112 int rte_ivshmem_metadata_add_ring(const struct rte_ring * r,
113  const char * md_name);
114 
128  const char * md_name);
129 
130 
146 int rte_ivshmem_metadata_cmdline_generate(char *buffer, unsigned size,
147  const char *name);
148 
149 
158 void rte_ivshmem_metadata_dump(FILE *f, const char *name);
159 
160 
161 #ifdef __cplusplus
162 }
163 #endif
164 
165 #endif /* RTE_IVSHMEM_H_ */