2 // Copyright (c) 2017 Intel Corporation
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
8 // http://www.apache.org/licenses/LICENSE-2.0
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
17 #ifndef __INCLUDE_LIB_ARP_H__
18 #define __INCLUDE_LIB_ARP_H__
20 #include <rte_pipeline.h>
21 #include "rte_ether.h"
25 #define ND_IPV6_ADDR_SIZE 16 /**< 16 Byte of IPv6 Address. */
26 #define ND_IPV6_TIMER_EXPIRY 300 /**< in Seconds, Timer for ND IPv6 Expiry */
27 #define ARP_TIMER_EXPIRY 20 /**< in Seconds, TIMER for ARP Expiry */
28 #define TIMER_MILLISECOND 1
29 #define RTE_LOGTYPE_LIBARP RTE_LOGTYPE_USER1
30 #define MAX_ND_RT_ENTRY 32
31 #define MAX_ARP_RT_ENTRY 32
32 #define NUM_DESC (get_arp_buf())
33 #define ARP_BUF_DEFAULT 30000
35 #define ARP_RETRY_COUNT 100
36 #undef L3_STACK_SUPPORT
38 #define MAX_LOCAL_MAC_ADDRESS 32
41 uint32_t nhip[MAX_LOCAL_MAC_ADDRESS];
42 struct ether_addr link_hw_laddr[MAX_LOCAL_MAC_ADDRESS];
47 uint8_t nhip[MAX_LOCAL_MAC_ADDRESS][16];
48 struct ether_addr link_hw_laddr[MAX_LOCAL_MAC_ADDRESS];
52 uint8_t arp_cache_dest_mac_present(uint32_t out_port);
53 uint8_t nd_cache_dest_mac_present(uint32_t out_port);
54 extern struct ether_addr *get_local_cache_hw_addr(uint8_t out_port, uint32_t nhip);
55 extern struct ether_addr *get_nd_local_link_hw_addr(uint8_t out_port, uint8_t nhip[]);
56 extern struct arp_cache arp_local_cache[MAX_PORTS];
57 extern void prefetch(void);
58 extern void update_nhip_access(uint8_t);
59 uint32_t get_arp_buf(void);
60 uint32_t get_nd_buf(void);
61 extern int my_inet_pton_ipv6(int af, const char *src, void *dst);
62 extern struct rte_hash *arp_hash_handle;
63 extern struct rte_hash *nd_hash_handle;
64 extern uint32_t lib_arp_get_mac_req;
65 extern uint32_t lib_arp_nh_found;
66 extern uint32_t lib_arp_no_nh_found;
67 extern uint32_t lib_arp_arp_entry_found;
68 extern uint32_t lib_arp_no_arp_entry_found;
69 extern uint32_t lib_arp_populate_called;
70 extern uint32_t lib_arp_delete_called;
71 extern uint32_t lib_arp_duplicate_found;
72 extern uint32_t arp_route_tbl_index;
73 extern uint32_t lib_nd_get_mac_req;
74 extern uint32_t lib_nd_nh_found;
75 extern uint32_t lib_nd_no_nh_found;
76 extern uint32_t lib_nd_nd_entry_found;
77 extern uint32_t lib_nd_no_arp_entry_found;
78 extern uint32_t lib_nd_populate_called;
79 extern uint32_t lib_nd_delete_called;
80 extern uint32_t lib_nd_duplicate_found;
94 uint32_t ip; /**< IP address */
95 uint8_t port_id; /**< Port id */
96 uint8_t filler1; /**< filler 1, for better hash key */
97 uint8_t filler2; /**< filler 2, for better hash key */
98 uint8_t filler3; /**< filler 3, for better hash key */
105 uint8_t ipv6[ND_IPV6_ADDR_SIZE]; /**< 128 Bit of IPv6 Address*/
106 uint8_t port_id; /**< Port id */
116 enum arp_key_type type;
118 struct arp_key_ipv4 ipv4;
119 } key; /**< Key of type arp key Ipv4 */
123 * call back function parameter pair remove nd entry
127 struct nd_timer_key {
128 uint8_t ipv6[ND_IPV6_ADDR_SIZE]; /**< IPv6 address */
129 uint8_t port_id; /**< Port id */
130 } __rte_cache_aligned;
133 * call back function parameter remove arp entry
136 struct arp_timer_key {
137 uint32_t ip; /**< Ip address */
138 uint8_t port_id; /**< Port id */
139 } __rte_cache_aligned;
141 extern uint32_t ARPICMP_DEBUG;
151 extern uint32_t NDIPV6_DEBUG; /**< ND IPv6 */
153 #define ICMPv6_COMPLETE 1 /**< ICMPv6 entry populated and echo reply recieved. */
154 #define ICMPv6_INCOMPLETE 0 /**< ICMPv6 entry populated and either awaiting echo reply or stale entry. */
155 #define STATIC_ARP 1 /**< Static ARP Entry. */
156 #define DYNAMIC_ARP 0 /**< Dynamic ARP Entry. */
157 #define STATIC_ND 1 /**< Static ND Entry. */
158 #define DYNAMIC_ND 0 /**< Dynamic ND Entry. */
161 * A structure is used to defined the ARP entry data
162 * This structure is used as a input parameters for entry of ARP data
165 struct arp_entry_data {
166 struct ether_addr eth_addr; /**< ethernet address */
167 uint32_t ip; /**< IP address */
168 uint8_t port; /**< Port */
169 uint8_t status; /**< Status of entry */
170 uint8_t mode; /**< Mode */
171 uint8_t retry_count; /**< retry count for ARP*/
172 struct rte_timer *timer; /**< Timer Associated with ARP*/
173 struct arp_timer_key *timer_key;
174 rte_rwlock_t queue_lock; /** queue lock */
175 struct rte_mbuf **buf_pkts;
177 uint64_t n_confirmed;
178 } __attribute__ ((packed));
181 * A structure is used to defined the table for arp entry data
182 * This structure is used to maintain the arp entry data
185 struct table_arp_entry_data {
186 uint8_t eth_addr[6]; /**< Ethernet address */
187 uint8_t port; /**< port */
188 uint8_t status; /**< status of entry */
189 uint32_t ip; /**< Ip address */
190 } __attribute__ ((packed));
193 * A structure is used to define the ND entry data for IPV6
194 * This structure is used as a input parameters for ND entry data
197 struct nd_entry_data {
198 struct ether_addr eth_addr; /**< Ethernet address */
199 uint8_t port; /**< port */
200 uint8_t status; /**< statusof the entry */
201 uint8_t mode; /**< Mode */
202 uint8_t ipv6[ND_IPV6_ADDR_SIZE]; /**< Ipv6 address */
203 uint8_t retry_count; /**< retry count for ARP*/
204 struct rte_timer *timer; /**< Timer */
205 struct nd_timer_key *timer_key;
206 rte_rwlock_t queue_lock; /** queue lock */
207 struct rte_mbuf **buf_pkts;
209 uint64_t n_confirmed;
210 } __attribute__ ((packed));
213 * A structure is used to define the table for ND entry data
214 * This structure is used to maintain ND entry data
218 struct table_nd_entry_data {
219 uint8_t eth_addr[6]; /**< Ethernet address */
220 uint8_t port; /**< Port */
221 uint8_t status; /**< status of Entry */
222 uint8_t ipv6[ND_IPV6_ADDR_SIZE]; /**< IPv6 address */
223 struct rte_timer *timer; /**< Timer */
224 } __attribute__ ((packed));
227 struct arp_cache arp_local_cache[MAX_PORTS];
228 struct nd_cache nd_local_cache[MAX_PORTS];
229 struct ether_addr link_hw_addr[MAX_LOCAL_MAC_ADDRESS];
230 uint32_t link_hw_addr_array_idx;
231 uint8_t arp_cache_hw_laddr_valid[MAX_LOCAL_MAC_ADDRESS];
232 uint8_t nd_cache_hw_laddr_valid[MAX_LOCAL_MAC_ADDRESS];
233 uint64_t update_tsc[MAX_LOCAL_MAC_ADDRESS];
234 } __rte_cache_aligned;
237 * To get the destination MAC address andnext hop for the ip address and outgoing port
239 * IP address for which MAC address is needed.
243 * pointer to the ether_addr, This gets update with valid MAC addresss
245 * Gets the next hop IP by Ip address and physical port
247 * 0 if failure, and 1 if success
249 struct arp_entry_data *get_dest_mac_addr_port(const uint32_t ipaddr,
250 uint32_t phy_port, struct ether_addr *hw_addr);
253 * To get the destination mac address for IPV6 address
255 * IPv6 address which need the destination mac adress
259 * pointer to the ether_address, This gets update with valid mac address
261 * Gets the next hop ipv6 address by ipv6 address and physical port
263 * 0 if failure, 1 ifsuccess
265 int arp_queue_unresolved_packet(struct arp_entry_data * arp_data,
266 struct rte_mbuf * m);
267 extern void arp_send_buffered_pkts(struct arp_entry_data *ret_arp_data,struct ether_addr *hw_addr, uint8_t port_id);
269 int nd_queue_unresolved_packet(struct nd_entry_data *nd_data,
270 struct rte_mbuf * m);
271 extern void nd_send_buffered_pkts(struct nd_entry_data *ret_nd_data,struct ether_addr *hw_addr, uint8_t port_id);
274 * To get hardware link address
279 struct ether_addr *get_link_hw_addr(uint8_t out_port);
282 * This prints the Arp Table
286 void print_arp_table(void);
289 * This prints the ND table
293 void print_nd_table(void);
296 * This removes arp entry from Table
302 void remove_arp_entry(struct arp_entry_data *ret_arp_data, void *arg);
305 * Removes ND entry from Nd Table
312 void remove_nd_entry_ipv6(struct nd_entry_data *ret_nd_data, void *arg);
315 * Populate arp entry in arp Table
325 void populate_arp_entry(const struct ether_addr *hw_addr, uint32_t ipaddr,
326 uint8_t portid, uint8_t mode);
329 * Populate ND entry in ND Table
340 void populate_nd_entry(const struct ether_addr *hw_addr, uint8_t ip[],
341 uint8_t portid, uint8_t mode);
344 * To send ARp request
351 void request_arp(uint8_t port_id, uint32_t ip);
354 * TO send echo request
360 struct rte_mbuf *request_echo(uint32_t port_id, uint32_t ip);
363 * To send icmpv6 echo request
369 struct rte_mbuf *request_icmpv6_echo(uint8_t ipv6[], l2_phy_interface_t *port);
378 struct rte_mbuf *request_nd(uint8_t ipv6[], l2_phy_interface_t *port);
381 * To process te ARP and ICMP packets
383 * Packets to be processed
389 void process_arpicmp_pkt(struct rte_mbuf *pkt, l2_phy_interface_t *port);
393 * Validate if key-value pair already exists in the hash table for given key - IPv4
395 * Arp key to validate entry
397 struct arp_entry_data *retrieve_arp_entry(const struct arp_key_ipv4 arp_key, uint8_t mode);
401 * Validate if key-value pair already exists in the hash table for given key - ND IPv6
403 * Nd key to validate Nd entry
406 struct nd_entry_data *retrieve_nd_entry(struct nd_key_ipv6 nd_key, uint8_t mode);
409 * Setsup Arp Initilization
411 //void lib_arp_init(void);
412 void lib_arp_init(struct pipeline_params *params, struct app_params *app);
414 void set_port_to_loadb_map(uint8_t pipeline_num);
417 * Acts on port_to_loadb_map
419 uint8_t get_port_to_loadb_map(uint8_t phy_port_id);
421 void set_phy_inport_map(uint8_t pipeline_num, uint8_t *map);
422 void set_phy_outport_map(uint8_t pipeline_num, uint8_t *map);
425 * Acts on lb_outport_id
428 uint8_t get_loadb_outport_id(uint8_t actual_phy_port);
429 uint8_t get_vnf_set_num(uint8_t pipeline_num);
431 void pipelines_port_info(void);
432 void pipelines_map_info(void);
435 * A callback for arp Timer
441 void arp_timer_callback(struct rte_timer *, void *arg);
444 * A callback for ND timer
450 void nd_timer_callback(struct rte_timer *timer, void *arg);
453 * To create Arp Table
456 void create_arp_table(void);
461 void create_nd_table(void);
464 * To parse and process the Arp and icmp packets
474 void process_arpicmp_pkt_parse(struct rte_mbuf **pkt, uint16_t pkt_num,
475 uint64_t pkt_mask, l2_phy_interface_t *port);
482 void send_gratuitous_arp(l2_phy_interface_t *port);
488 void set_arpdebug(int flag);
490 * To set timer for arp entry
492 * timer val for arp entry
494 void set_arptimeout(uint32_t timeout_val);
496 * To get nexthop for ipv4
502 uint32_t get_nh(uint32_t, uint32_t *, struct ether_addr *addr);
504 * To get nexthop for ipv6
512 void get_nh_ipv6(uint8_t ipv6[], uint32_t *port, uint8_t nhipv6[], struct ether_addr *hw_addr);
514 struct arp_entry_data *get_dest_mac_addr_ipv4(const uint32_t nhip,
515 uint32_t phy_port, struct ether_addr *hw_addr);
516 struct nd_entry_data *get_dest_mac_addr_ipv6(uint8_t nhipv6[],
517 uint32_t phy_port, struct ether_addr *hw_addr);