DPDK  17.02.1
rte_kni.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_KNI_H_
35 #define _RTE_KNI_H_
36 
49 #include <rte_pci.h>
50 #include <rte_memory.h>
51 #include <rte_mempool.h>
52 
53 #include <exec-env/rte_kni_common.h>
54 
55 #ifdef __cplusplus
56 extern "C" {
57 #endif
58 
59 struct rte_kni;
60 struct rte_mbuf;
61 
65 struct rte_kni_ops {
66  uint8_t port_id; /* Port ID */
67 
68  /* Pointer to function of changing MTU */
69  int (*change_mtu)(uint8_t port_id, unsigned new_mtu);
70 
71  /* Pointer to function of configuring network interface */
72  int (*config_network_if)(uint8_t port_id, uint8_t if_up);
73 };
74 
78 struct rte_kni_conf {
79  /*
80  * KNI name which will be used in relevant network device.
81  * Let the name as short as possible, as it will be part of
82  * memzone name.
83  */
84  char name[RTE_KNI_NAMESIZE];
85  uint32_t core_id; /* Core ID to bind kernel thread on */
86  uint16_t group_id; /* Group ID */
87  unsigned mbuf_size; /* mbuf size */
88  struct rte_pci_addr addr;
89  struct rte_pci_id id;
90 
91  __extension__
92  uint8_t force_bind : 1; /* Flag to bind kernel thread */
93 };
94 
105 void rte_kni_init(unsigned int max_kni_ifaces);
106 
107 
131 struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
132  const struct rte_kni_conf *conf, struct rte_kni_ops *ops);
133 
148 int rte_kni_release(struct rte_kni *kni);
149 
162 int rte_kni_handle_request(struct rte_kni *kni);
163 
180 unsigned rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs,
181  unsigned num);
182 
199 unsigned rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs,
200  unsigned num);
201 
212 struct rte_kni *rte_kni_get(const char *name);
213 
222 const char *rte_kni_get_name(const struct rte_kni *kni);
223 
237 int rte_kni_register_handlers(struct rte_kni *kni, struct rte_kni_ops *ops);
238 
249 int rte_kni_unregister_handlers(struct rte_kni *kni);
250 
254 void rte_kni_close(void);
255 
256 #ifdef __cplusplus
257 }
258 #endif
259 
260 #endif /* _RTE_KNI_H_ */