2 // Copyright (c) 2010-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 #include <rte_lcore.h>
19 #include <rte_hash_crc.h>
20 #include "task_base.h"
24 #include "handle_master.h"
25 #include "prox_port_cfg.h"
27 static inline int find_ip(struct ether_hdr_arp *pkt, uint16_t len, uint32_t *ip_dst)
29 struct vlan_hdr *vlan_hdr;
30 struct ether_hdr *eth_hdr = (struct ether_hdr*)pkt;
32 uint16_t ether_type = eth_hdr->ether_type;
33 uint16_t l2_len = sizeof(struct ether_hdr);
36 while (((ether_type == ETYPE_8021ad) || (ether_type == ETYPE_VLAN)) && (l2_len + sizeof(struct vlan_hdr) < len)) {
37 vlan_hdr = (struct vlan_hdr *)((uint8_t *)pkt + l2_len);
39 ether_type = vlan_hdr->eth_proto;
45 // In case of MPLS, next hop MAC is based on MPLS, not destination IP
57 plog_warn("Unsupported packet type %x - CRC might be wrong\n", ether_type);
61 if (l2_len && (l2_len + sizeof(struct ipv4_hdr) <= len)) {
62 struct ipv4_hdr *ip = (struct ipv4_hdr *)((uint8_t *)pkt + l2_len);
63 // TODO: implement LPM => replace ip_dst by next hop IP DST
64 *ip_dst = ip->dst_addr;
70 /* This implementation could be improved: instead of checking each time we send a packet whether we need also
71 to send an ARP, we should only check whether the MAC is valid.
72 We should check arp_update_time in the master process. This would also require the generating task to clear its arp ring
73 to avoid sending many ARP while starting after a long stop.
74 We could also check for arp_timeout in the master so that dataplane has only to check whether MAC is available
75 but this would require either thread safety, or the the exchange of information between master and generating core.
78 int write_dst_mac(struct task_base *tbase, struct rte_mbuf *mbuf, uint32_t *ip_dst)
80 const uint64_t hz = rte_get_tsc_hz();
81 struct ether_hdr_arp *packet = rte_pktmbuf_mtod(mbuf, struct ether_hdr_arp *);
82 struct ether_addr *mac = &packet->ether_hdr.d_addr;
84 uint64_t tsc = rte_rdtsc();
85 struct l3_base *l3 = &(tbase->l3);
87 if (likely((l3->flags & FLAG_DST_MAC_KNOWN) && (tsc < l3->gw.arp_update_time) && (tsc < l3->gw.arp_timeout))) {
88 memcpy(mac, &l3->gw.mac, sizeof(struct ether_addr));
90 } else if (tsc > l3->gw.arp_update_time) {
91 // long time since we have sent an arp, send arp
92 l3->gw.arp_update_time = tsc + l3->arp_update_time * hz / 1000;
94 if ((l3->flags & FLAG_DST_MAC_KNOWN) && (tsc < l3->gw.arp_timeout)){
95 // MAC is valid in the table => send also the mbuf
96 memcpy(mac, &l3->gw.mac, sizeof(struct ether_addr));
97 return SEND_MBUF_AND_ARP;
99 // MAC still unknown, or timed out => only send ARP
103 // MAC is unknown and we already sent an ARP recently, drop mbuf and wait for ARP reply
108 uint16_t len = rte_pktmbuf_pkt_len(mbuf);
109 if (find_ip(packet, len, ip_dst) != 0) {
110 // Unable to find IP address => non IP packet => send it as it
113 if (likely(l3->n_pkts < 4)) {
114 for (unsigned int idx = 0; idx < l3->n_pkts; idx++) {
115 if (*ip_dst == l3->optimized_arp_table[idx].ip) {
116 // IP address already in table
117 if ((tsc < l3->optimized_arp_table[idx].arp_update_time) && (tsc < l3->optimized_arp_table[idx].arp_timeout)) {
118 // MAC address was recently updated in table, use it
119 memcpy(mac, &l3->optimized_arp_table[idx].mac, sizeof(struct ether_addr));
121 } else if (tsc > l3->optimized_arp_table[idx].arp_update_time) {
122 // ARP not sent since a long time, send ARP
123 l3->optimized_arp_table[idx].arp_update_time = tsc + l3->arp_update_time * hz / 1000;
124 if (tsc < l3->optimized_arp_table[idx].arp_timeout) {
125 // MAC still valid => also send mbuf
126 memcpy(mac, &l3->optimized_arp_table[idx].mac, sizeof(struct ether_addr));
127 return SEND_MBUF_AND_ARP;
129 // MAC unvalid => only send ARP
133 // ARP timeout elapsed, MAC not valid anymore but waiting for ARP reply
138 // IP address not found in table
139 l3->optimized_arp_table[l3->n_pkts].ip = *ip_dst;
140 l3->optimized_arp_table[l3->n_pkts].arp_update_time = tsc + l3->arp_update_time * hz / 1000;
143 if (l3->n_pkts < 4) {
147 // We have too many IP addresses to search linearly; lets use hash table instead => copy all entries in hash table
148 for (uint32_t idx = 0; idx < l3->n_pkts; idx++) {
149 uint32_t ip = l3->optimized_arp_table[idx].ip;
150 int ret = rte_hash_add_key(l3->ip_hash, (const void *)&ip);
152 // This should not happen as few entries so far.
153 // If it happens, we still send the ARP as easier:
154 // If the ARP corresponds to this error, the ARP reply will be ignored
155 // If ARP does not correspond to this error/ip, then ARP reply will be handled.
156 plogx_err("Unable add ip %d.%d.%d.%d in mac_hash (already %d entries)\n", IP4(ip), idx);
158 memcpy(&l3->arp_table[ret], &l3->optimized_arp_table[idx], sizeof(struct arp_table));
163 // Find IP in lookup table. Send ARP if not found
164 int ret = rte_hash_lookup(l3->ip_hash, (const void *)ip_dst);
165 if (unlikely(ret < 0)) {
166 // IP not found, try to send an ARP
167 int ret = rte_hash_add_key(l3->ip_hash, (const void *)ip_dst);
169 // No reason to send ARP, as reply would be anyhow ignored
170 plogx_err("Unable to add ip %d.%d.%d.%d in mac_hash\n", IP4(*ip_dst));
173 l3->arp_table[ret].ip = *ip_dst;
174 l3->arp_table[ret].arp_update_time = tsc + l3->arp_update_time * hz / 1000;
179 if (likely((tsc < l3->arp_table[ret].arp_update_time) && (tsc < l3->arp_table[ret].arp_timeout))) {
180 // MAC still valid and ARP sent recently
181 memcpy(mac, &l3->arp_table[ret].mac, sizeof(struct ether_addr));
183 } else if (tsc > l3->arp_table[ret].arp_update_time) {
184 // ARP not sent since a long time, send ARP
185 l3->arp_table[ret].arp_update_time = tsc + l3->arp_update_time * hz / 1000;
186 if (tsc < l3->arp_table[ret].arp_timeout) {
187 // MAC still valid => send also MBUF
188 memcpy(mac, &l3->arp_table[ret].mac, sizeof(struct ether_addr));
189 return SEND_MBUF_AND_ARP;
202 void task_init_l3(struct task_base *tbase, struct task_args *targ)
204 static char hash_name[30];
205 uint32_t n_entries = MAX_ARP_ENTRIES * 4;
206 const int socket_id = rte_lcore_to_socket_id(targ->lconf->id);
207 sprintf(hash_name, "A%03d_%03d_mac_table", targ->lconf->id, targ->id);
211 struct rte_hash_parameters hash_params = {
213 .entries = n_entries,
214 .key_len = sizeof(uint32_t),
215 .hash_func = rte_hash_crc,
216 .hash_func_init_val = 0,
218 tbase->l3.ip_hash = rte_hash_create(&hash_params);
219 PROX_PANIC(tbase->l3.ip_hash == NULL, "Failed to set up ip hash table\n");
221 tbase->l3.arp_table = (struct arp_table *)prox_zmalloc(n_entries * sizeof(struct arp_table), socket_id);
222 PROX_PANIC(tbase->l3.arp_table == NULL, "Failed to allocate memory for %u entries in arp table\n", n_entries);
223 plog_info("\tarp table, with %d entries of size %ld\n", n_entries, sizeof(struct l3_base));
225 targ->lconf->ctrl_func_p[targ->task] = handle_ctrl_plane_pkts;
226 targ->lconf->ctrl_timeout = freq_to_tsc(targ->ctrl_freq);
227 tbase->l3.gw.ip = rte_cpu_to_be_32(targ->gateway_ipv4);
228 tbase->flags |= TASK_L3;
229 tbase->l3.core_id = targ->lconf->id;
230 tbase->l3.task_id = targ->id;
231 tbase->l3.tmaster = targ->tmaster;
232 if (tbase->l3.arp_timeout != 0)
233 tbase->l3.arp_timeout = targ->arp_timeout;
235 tbase->l3.arp_timeout = DEFAULT_ARP_TIMEOUT;
236 if (tbase->l3.arp_update_time != 0)
237 tbase->l3.arp_update_time = targ->arp_update_time;
239 tbase->l3.arp_update_time = DEFAULT_ARP_UPDATE_TIME;
242 void task_start_l3(struct task_base *tbase, struct task_args *targ)
244 const int NB_ARP_MBUF = 1024;
245 const int ARP_MBUF_SIZE = 2048;
246 const int NB_CACHE_ARP_MBUF = 256;
248 struct prox_port_cfg *port = find_reachable_port(targ);
249 if (port && (tbase->l3.arp_pool == NULL)) {
250 static char name[] = "arp0_pool";
251 tbase->l3.reachable_port_id = port - prox_port_cfg;
252 if (targ->local_ipv4) {
253 tbase->local_ipv4 = rte_be_to_cpu_32(targ->local_ipv4);
254 register_ip_to_ctrl_plane(tbase->l3.tmaster, tbase->local_ipv4, tbase->l3.reachable_port_id, targ->lconf->id, targ->id);
257 struct rte_mempool *ret = rte_mempool_create(name, NB_ARP_MBUF, ARP_MBUF_SIZE, NB_CACHE_ARP_MBUF,
258 sizeof(struct rte_pktmbuf_pool_private), rte_pktmbuf_pool_init, NULL, rte_pktmbuf_init, 0,
260 PROX_PANIC(ret == NULL, "Failed to allocate ARP memory pool on socket %u with %u elements\n",
261 rte_socket_id(), NB_ARP_MBUF);
262 plog_info("\t\tMempool %p (%s) size = %u * %u cache %u, socket %d\n", ret, name, NB_ARP_MBUF,
263 ARP_MBUF_SIZE, NB_CACHE_ARP_MBUF, rte_socket_id());
264 tbase->l3.arp_pool = ret;
268 void task_set_gateway_ip(struct task_base *tbase, uint32_t ip)
270 tbase->l3.gw.ip = ip;
271 tbase->flags &= ~FLAG_DST_MAC_KNOWN;
274 void task_set_local_ip(struct task_base *tbase, uint32_t ip)
276 tbase->local_ipv4 = ip;
279 void handle_ctrl_plane_pkts(struct task_base *tbase, struct rte_mbuf **mbufs, uint16_t n_pkts)
282 const uint64_t hz = rte_get_tsc_hz();
283 uint32_t ip, ip_dst, idx;
286 struct ether_hdr_arp *hdr;
287 struct l3_base *l3 = &tbase->l3;
288 uint64_t tsc= rte_rdtsc();
290 for (j = 0; j < n_pkts; ++j) {
293 for (j = 0; j < n_pkts; ++j) {
294 PREFETCH0(rte_pktmbuf_mtod(mbufs[j], void *));
297 for (j = 0; j < n_pkts; ++j) {
298 out[0] = OUT_HANDLED;
299 command = mbufs[j]->udata64 & 0xFFFF;
300 plogx_dbg("\tReceived %s mbuf %p\n", actions_string[command], mbufs[j]);
302 case UPDATE_FROM_CTRL:
303 hdr = rte_pktmbuf_mtod(mbufs[j], struct ether_hdr_arp *);
304 ip = (mbufs[j]->udata64 >> 32) & 0xFFFFFFFF;
306 if (ip == l3->gw.ip) {
307 // MAC address of the gateway
308 memcpy(&l3->gw.mac, &hdr->arp.data.sha, 6);
309 l3->flags |= FLAG_DST_MAC_KNOWN;
310 l3->gw.arp_timeout = tsc + l3->arp_timeout * hz / 1000;
311 } else if (l3->n_pkts < 4) {
312 // Few packets tracked - should be faster to loop through them thean using a hash table
313 for (idx = 0; idx < l3->n_pkts; idx++) {
314 ip_dst = l3->optimized_arp_table[idx].ip;
318 if (idx < l3->n_pkts) {
319 // IP not found; this is a reply while we never asked for the request!
320 memcpy(&l3->optimized_arp_table[idx].mac, &(hdr->arp.data.sha), sizeof(struct ether_addr));
321 l3->optimized_arp_table[idx].arp_timeout = tsc + l3->arp_timeout * hz / 1000;
324 int ret = rte_hash_add_key(l3->ip_hash, (const void *)&ip);
326 plogx_info("Unable add ip %d.%d.%d.%d in mac_hash\n", IP4(ip));
328 memcpy(&l3->arp_table[ret].mac, &(hdr->arp.data.sha), sizeof(struct ether_addr));
329 l3->arp_table[ret].arp_timeout = tsc + l3->arp_timeout * hz / 1000;
334 case ARP_REPLY_FROM_CTRL:
335 case ARP_REQ_FROM_CTRL:
337 // tx_ctrlplane_pkt does not drop packets
338 tbase->aux->tx_ctrlplane_pkt(tbase, &mbufs[j], 1, out);
339 TASK_STATS_ADD_TX_NON_DP(&tbase->aux->stats, 1);