xref: /f-stack/lib/ff_dpdk_kni.h (revision 2317ada5)
1 /*
2  * Copyright (C) 2017-2021 THL A29 Limited, a Tencent company.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice, this
9  *   list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  *   this list of conditions and the following disclaimer in the documentation
12  *   and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  */
26 
27 #ifndef _FSTACK_DPDK_KNI_H
28 #define _FSTACK_DPDK_KNI_H
29 
30 #include <rte_config.h>
31 #include <rte_mbuf.h>
32 #include <rte_mempool.h>
33 
34 extern int enable_kni;
35 
36 enum FilterReturn {
37     FILTER_UNKNOWN = -1,
38     FILTER_ARP = 1,
39     FILTER_KNI = 2,
40 #ifdef INET6
41     FILTER_NDP = 3,  // Neighbor Solicitation/Advertisement, Router Solicitation/Advertisement/Redirect
42 #endif
43 };
44 
45 void ff_kni_init(uint16_t nb_ports, const char *tcp_ports,
46     const char *udp_ports);
47 
48 void ff_kni_alloc(uint16_t port_id, unsigned socket_id,
49     struct rte_mempool *mbuf_pool, unsigned ring_queue_size);
50 
51 void ff_kni_process(uint16_t port_id, uint16_t queue_id,
52     struct rte_mbuf **pkts_burst, unsigned count);
53 
54 enum FilterReturn ff_kni_proto_filter(const void *data, uint16_t len, uint16_t eth_frame_type);
55 
56 int ff_kni_enqueue(uint16_t port_id, struct rte_mbuf *pkt);
57 
58 
59 #endif /* ifndef _FSTACK_DPDK_KNI_H */
60