vxlan:restructure encap loop
[vpp.git] / src / vnet / vxlan / encap.c
1
2 /*
3  * Copyright (c) 2015 Cisco and/or its affiliates.
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16 #include <vppinfra/error.h>
17 #include <vppinfra/hash.h>
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/ethernet/ethernet.h>
21 #include <vnet/vxlan/vxlan.h>
22
23 /* Statistics (not all errors) */
24 #define foreach_vxlan_encap_error    \
25 _(ENCAPSULATED, "good packets encapsulated")
26
27 static char * vxlan_encap_error_strings[] = {
28 #define _(sym,string) string,
29   foreach_vxlan_encap_error
30 #undef _
31 };
32
33 typedef enum {
34 #define _(sym,str) VXLAN_ENCAP_ERROR_##sym,
35     foreach_vxlan_encap_error
36 #undef _
37     VXLAN_ENCAP_N_ERROR,
38 } vxlan_encap_error_t;
39
40 typedef enum {
41     VXLAN_ENCAP_NEXT_DROP,
42     VXLAN_ENCAP_N_NEXT,
43 } vxlan_encap_next_t;
44
45 typedef struct {
46   u32 tunnel_index;
47   u32 vni;
48 } vxlan_encap_trace_t;
49
50 u8 * format_vxlan_encap_trace (u8 * s, va_list * args)
51 {
52   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
53   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
54   vxlan_encap_trace_t * t 
55       = va_arg (*args, vxlan_encap_trace_t *);
56
57   s = format (s, "VXLAN encap to vxlan_tunnel%d vni %d", 
58               t->tunnel_index, t->vni);
59   return s;
60 }
61
62 always_inline uword
63 vxlan_encap_inline (vlib_main_t * vm,
64                     vlib_node_runtime_t * node,
65                     vlib_frame_t * from_frame,
66                     u8 is_ip4, u8 csum_offload)
67 {
68   u32 n_left_from, next_index, * from, * to_next;
69   vxlan_main_t * vxm = &vxlan_main;
70   vnet_main_t * vnm = vxm->vnet_main;
71   vnet_interface_main_t * im = &vnm->interface_main;
72   vlib_combined_counter_main_t * tx_counter = im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_TX;
73   u32 pkts_encapsulated = 0;
74   u32 thread_index = vlib_get_thread_index();
75   u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
76   u32 sw_if_index0 = 0, sw_if_index1 = 0;
77   u32 next0 = 0, next1 = 0;
78   vnet_hw_interface_t * hi0, * hi1;
79   vxlan_tunnel_t * t0 = NULL, * t1 = NULL;
80
81   from = vlib_frame_vector_args (from_frame);
82   n_left_from = from_frame->n_vectors;
83
84   next_index = node->cached_next_index;
85   stats_sw_if_index = node->runtime_data[0];
86   stats_n_packets = stats_n_bytes = 0;
87
88   STATIC_ASSERT_SIZEOF(ip6_vxlan_header_t, 56);
89   STATIC_ASSERT_SIZEOF(ip4_vxlan_header_t, 36);
90
91   word const underlay_hdr_len = is_ip4 ?
92     sizeof(ip4_vxlan_header_t) : sizeof(ip6_vxlan_header_t);
93   u16 const l3_len = is_ip4 ? sizeof(ip4_header_t) : sizeof(ip6_header_t);
94   u32 const csum_flags = is_ip4 ?
95     VNET_BUFFER_F_OFFLOAD_IP_CKSUM | VNET_BUFFER_F_IS_IP4 |
96     VNET_BUFFER_F_OFFLOAD_UDP_CKSUM :
97     VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
98
99   while (n_left_from > 0)
100     {
101       u32 n_left_to_next;
102
103       vlib_get_next_frame (vm, node, next_index,
104                            to_next, n_left_to_next);
105
106       while (n_left_from >= 4 && n_left_to_next >= 2)
107         {
108           /* Prefetch next iteration. */
109           {
110             vlib_buffer_t * p2, * p3;
111
112             p2 = vlib_get_buffer (vm, from[2]);
113             p3 = vlib_get_buffer (vm, from[3]);
114
115             vlib_prefetch_buffer_header (p2, LOAD);
116             vlib_prefetch_buffer_header (p3, LOAD);
117
118             CLIB_PREFETCH (p2->data, 2*CLIB_CACHE_LINE_BYTES, LOAD);
119             CLIB_PREFETCH (p3->data, 2*CLIB_CACHE_LINE_BYTES, LOAD);
120           }
121
122           u32 bi0 = from[0];
123           u32 bi1 = from[1];
124
125           vlib_buffer_t * b0 = vlib_get_buffer (vm, bi0);
126           vlib_buffer_t * b1 = vlib_get_buffer (vm, bi1);
127           u32 flow_hash0 = vnet_l2_compute_flow_hash (b0);
128           u32 flow_hash1 = vnet_l2_compute_flow_hash (b1);
129
130           to_next[0] = bi0;
131           to_next[1] = bi1;
132           from += 2;
133           to_next += 2;
134           n_left_to_next -= 2;
135           n_left_from -= 2;
136
137           /* Get next node index and adj index from tunnel next_dpo */
138           if (sw_if_index0 != vnet_buffer(b0)->sw_if_index[VLIB_TX])
139             {
140               sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_TX];
141               hi0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
142               t0 = &vxm->tunnels[hi0->dev_instance];
143               /* Note: change to always set next0 if it may be set to drop */
144               next0 = t0->next_dpo.dpoi_next_node;
145             }
146           vnet_buffer(b0)->ip.adj_index[VLIB_TX] = t0->next_dpo.dpoi_index;
147
148           /* Get next node index and adj index from tunnel next_dpo */
149           if (sw_if_index1 != vnet_buffer(b1)->sw_if_index[VLIB_TX])
150             {
151               sw_if_index1 = vnet_buffer(b1)->sw_if_index[VLIB_TX];
152               hi1 = vnet_get_sup_hw_interface (vnm, sw_if_index1); 
153               t1 = &vxm->tunnels[hi1->dev_instance];
154               /* Note: change to always set next1 if it may be set to drop */
155               next1 = t1->next_dpo.dpoi_next_node;
156             }
157           vnet_buffer(b1)->ip.adj_index[VLIB_TX] = t1->next_dpo.dpoi_index;
158
159           ASSERT(vec_len(t0->rewrite) == underlay_hdr_len);
160           ASSERT(vec_len(t1->rewrite) == underlay_hdr_len);
161
162           vlib_buffer_advance (b0, -underlay_hdr_len);
163           vlib_buffer_advance (b1, -underlay_hdr_len);
164
165           u32 len0 = vlib_buffer_length_in_chain (vm, b0);
166           u32 len1 = vlib_buffer_length_in_chain (vm, b1);
167           u16 payload_l0 = clib_host_to_net_u16 (len0 - l3_len);
168           u16 payload_l1 = clib_host_to_net_u16 (len1 - l3_len);
169
170           ip4_header_t * ip4_0, * ip4_1;
171           ip6_header_t * ip6_0, * ip6_1;
172           udp_header_t * udp0, * udp1;
173           u8 * l3_0, * l3_1;
174           if (is_ip4)
175             {
176               ip4_vxlan_header_t * hdr0 = vlib_buffer_get_current(b0);
177               ip4_vxlan_header_t * rewrite0 = (void *)t0->rewrite;
178               ip4_vxlan_header_t * hdr1 = vlib_buffer_get_current(b1);
179               ip4_vxlan_header_t * rewrite1 = (void *)t1->rewrite;
180               *hdr0 = *rewrite0;
181               *hdr1 = *rewrite1;
182
183               /* Fix the IP4 checksum and length */
184               ip4_0 = &hdr0->ip4;
185               ip4_1 = &hdr1->ip4;
186               ip4_0->length = clib_host_to_net_u16 (len0);
187               ip4_1->length = clib_host_to_net_u16 (len1);
188
189               l3_0 = (u8 *)ip4_0;
190               l3_1 = (u8 *)ip4_1;
191               udp0 = &hdr0->udp;
192               udp1 = &hdr1->udp;
193             }
194           else /* ipv6 */
195             {
196               ip6_vxlan_header_t * hdr0 = vlib_buffer_get_current(b0);
197               ip6_vxlan_header_t * rewrite0 = (void *) t0->rewrite;
198               ip6_vxlan_header_t * hdr1 = vlib_buffer_get_current(b0);
199               ip6_vxlan_header_t * rewrite1 = (void *) t1->rewrite;
200               *hdr0 = *rewrite0;
201               *hdr1 = *rewrite1;
202
203               /* Fix IP6 payload length */
204               ip6_0 = &hdr0->ip6;
205               ip6_1 = &hdr1->ip6;
206               ip6_0->payload_length = payload_l0;
207               ip6_1->payload_length = payload_l1;
208
209               l3_0 = (u8 *)ip6_0;
210               l3_1 = (u8 *)ip6_1;
211               udp0 = &hdr0->udp;
212               udp1 = &hdr1->udp;
213             }
214
215           /* Fix UDP length  and set source port */
216           udp0->length = payload_l0;
217           udp0->src_port = flow_hash0;
218           udp1->length = payload_l1;
219           udp1->src_port = flow_hash1;
220
221           if (csum_offload)
222             {
223               b0->flags |= csum_flags;
224               vnet_buffer (b0)->l3_hdr_offset = l3_0 - b0->data;
225               vnet_buffer (b0)->l4_hdr_offset = (u8 *) udp0 - b0->data;
226               b1->flags |= csum_flags;
227               vnet_buffer (b1)->l3_hdr_offset = l3_1 - b1->data;
228               vnet_buffer (b1)->l4_hdr_offset = (u8 *) udp1 - b1->data;
229             }
230           /* IPv4 UDP checksum only if checksum offload is used */
231           else if (is_ip4)
232             {
233               ip_csum_t sum0 = ip4_0->checksum;
234               sum0 = ip_csum_update (sum0, 0, ip4_0->length, ip4_header_t,
235                   length /* changed member */);
236               ip4_0->checksum = ip_csum_fold (sum0);
237               ip_csum_t sum1 = ip4_1->checksum;
238               sum1 = ip_csum_update (sum1, 0, ip4_1->length, ip4_header_t,
239                   length /* changed member */);
240               ip4_1->checksum = ip_csum_fold (sum1);
241             }
242           /* IPv6 UDP checksum is mandatory */
243           else
244             {
245               int bogus = 0;
246
247               udp0->checksum = ip6_tcp_udp_icmp_compute_checksum
248                 (vm, b0, ip6_0, &bogus);
249               ASSERT(bogus == 0);
250               if (udp0->checksum == 0)
251                 udp0->checksum = 0xffff;
252               udp1->checksum = ip6_tcp_udp_icmp_compute_checksum
253                 (vm, b1, ip6_1, &bogus);
254               ASSERT(bogus == 0);
255               if (udp1->checksum == 0)
256                 udp1->checksum = 0xffff;
257             }
258
259           /* Batch stats increment on the same vxlan tunnel so counter is not
260              incremented per packet. Note stats are still incremented for deleted
261              and admin-down tunnel where packets are dropped. It is not worthwhile
262              to check for this rare case and affect normal path performance. */
263           if (sw_if_index0 == sw_if_index1)
264             {
265               if (PREDICT_FALSE(sw_if_index0 != stats_sw_if_index))
266                 {
267                   if (stats_n_packets) 
268                     {
269                       vlib_increment_combined_counter (tx_counter, thread_index,
270                           stats_sw_if_index, stats_n_packets, stats_n_bytes);
271                       stats_n_packets = stats_n_bytes = 0;
272                     }
273                   stats_sw_if_index = sw_if_index0;
274                 }
275               stats_n_packets += 2;
276               stats_n_bytes += len0 + len1;
277             }
278           else
279             {
280               vlib_increment_combined_counter (tx_counter, thread_index,
281                   sw_if_index0, 1, len0);
282               vlib_increment_combined_counter (tx_counter, thread_index,
283                   sw_if_index1, 1, len1);
284             }
285           pkts_encapsulated += 2;
286
287           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED)) 
288             {
289               vxlan_encap_trace_t *tr = 
290                 vlib_add_trace (vm, node, b0, sizeof (*tr));
291               tr->tunnel_index = t0 - vxm->tunnels;
292               tr->vni = t0->vni;
293            }
294
295           if (PREDICT_FALSE(b1->flags & VLIB_BUFFER_IS_TRACED)) 
296             {
297               vxlan_encap_trace_t *tr = 
298                 vlib_add_trace (vm, node, b1, sizeof (*tr));
299               tr->tunnel_index = t1 - vxm->tunnels;
300               tr->vni = t1->vni;
301             }
302
303           vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
304                                            to_next, n_left_to_next,
305                                            bi0, bi1, next0, next1);
306         }
307
308       while (n_left_from > 0 && n_left_to_next > 0)
309         {
310           u32 bi0 = from[0];
311           vlib_buffer_t * b0 = vlib_get_buffer (vm, bi0);
312           u32 flow_hash0 = vnet_l2_compute_flow_hash(b0);
313
314           to_next[0] = bi0;
315           from += 1;
316           to_next += 1;
317           n_left_from -= 1;
318           n_left_to_next -= 1;
319
320           /* Get next node index and adj index from tunnel next_dpo */
321           if (sw_if_index0 != vnet_buffer(b0)->sw_if_index[VLIB_TX])
322             {
323               sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_TX];
324               hi0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
325               t0 = &vxm->tunnels[hi0->dev_instance];
326               /* Note: change to always set next0 if it may be set to drop */
327               next0 = t0->next_dpo.dpoi_next_node;
328             }
329           vnet_buffer(b0)->ip.adj_index[VLIB_TX] = t0->next_dpo.dpoi_index;
330
331           ASSERT(vec_len(t0->rewrite) == underlay_hdr_len);
332           vlib_buffer_advance (b0, -underlay_hdr_len);
333
334           u32 len0 = vlib_buffer_length_in_chain (vm, b0);
335           u16 payload_l0 = clib_host_to_net_u16 (len0 - l3_len);
336
337           udp_header_t * udp0;
338           ip4_header_t * ip4_0;
339           ip6_header_t * ip6_0;
340           u8 * l3_0;
341           if (is_ip4)
342             {
343               ip4_vxlan_header_t * rewrite = (void *)t0->rewrite;
344               ip4_vxlan_header_t * hdr = vlib_buffer_get_current(b0);
345               *hdr = *rewrite;
346
347               /* Fix the IP4 checksum and length */
348               ip4_0 = &hdr->ip4;
349               ip4_0->length = clib_host_to_net_u16 (len0);
350
351               l3_0 = (u8*)ip4_0;
352               udp0 = &hdr->udp;
353             }
354           else /* ip6 path */
355             {
356               ip6_vxlan_header_t * hdr = vlib_buffer_get_current(b0);
357               ip6_vxlan_header_t * rewrite = (void *) t0->rewrite;
358               *hdr = *rewrite;
359
360               /* Fix IP6 payload length */
361               ip6_0 = &hdr->ip6;
362               ip6_0->payload_length = payload_l0;
363
364               l3_0 = (u8 *)ip6_0;
365               udp0 = &hdr->udp;
366             }
367
368           /* Fix UDP length  and set source port */
369           udp0->length = payload_l0;
370           udp0->src_port = flow_hash0;
371
372           if (csum_offload)
373             {
374               b0->flags |= csum_flags;
375               vnet_buffer (b0)->l3_hdr_offset = l3_0 - b0->data;
376               vnet_buffer (b0)->l4_hdr_offset = (u8 *) udp0 - b0->data;
377             }
378           /* IPv4 UDP checksum only if checksum offload is used */
379           else if (is_ip4)
380             {
381               ip_csum_t sum0 = ip4_0->checksum;
382               sum0 = ip_csum_update (sum0, 0, ip4_0->length, ip4_header_t,
383                   length /* changed member */);
384               ip4_0->checksum = ip_csum_fold (sum0);
385             }
386           /* IPv6 UDP checksum is mandatory */
387           else
388             {
389               int bogus = 0;
390
391               udp0->checksum = ip6_tcp_udp_icmp_compute_checksum
392                 (vm, b0, ip6_0, &bogus);
393               ASSERT(bogus == 0);
394               if (udp0->checksum == 0)
395                 udp0->checksum = 0xffff;
396             }
397
398           /* Batch stats increment on the same vxlan tunnel so counter is not
399              incremented per packet. Note stats are still incremented for deleted
400              and admin-down tunnel where packets are dropped. It is not worthwhile
401              to check for this rare case and affect normal path performance. */
402           if (PREDICT_FALSE (sw_if_index0 != stats_sw_if_index)) 
403             {
404               if (stats_n_packets)
405                 {
406                   vlib_increment_combined_counter (tx_counter, thread_index,
407                       stats_sw_if_index, stats_n_packets, stats_n_bytes);
408                   stats_n_bytes = stats_n_packets = 0;
409                 }
410               stats_sw_if_index = sw_if_index0;
411             }
412           stats_n_packets += 1;
413           stats_n_bytes += len0;
414           pkts_encapsulated ++;
415
416           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED)) 
417             {
418               vxlan_encap_trace_t *tr = 
419                 vlib_add_trace (vm, node, b0, sizeof (*tr));
420               tr->tunnel_index = t0 - vxm->tunnels;
421               tr->vni = t0->vni;
422             }
423           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
424                                            to_next, n_left_to_next,
425                                            bi0, next0);
426         }
427
428       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
429     }
430
431   /* Do we still need this now that tunnel tx stats is kept? */
432   vlib_node_increment_counter (vm, node->node_index, 
433                                VXLAN_ENCAP_ERROR_ENCAPSULATED, 
434                                pkts_encapsulated);
435
436   /* Increment any remaining batch stats */
437   if (stats_n_packets)
438     {
439       vlib_increment_combined_counter (tx_counter, thread_index,
440           stats_sw_if_index, stats_n_packets, stats_n_bytes);
441       node->runtime_data[0] = stats_sw_if_index;
442     }
443
444   return from_frame->n_vectors;
445 }
446
447 static uword
448 vxlan4_encap (vlib_main_t * vm,
449               vlib_node_runtime_t * node,
450               vlib_frame_t * from_frame)
451 {
452   /* Disable chksum offload as setup overhead in tx node is not worthwhile
453      for ip4 header checksum only, unless udp checksum is also required */
454   return vxlan_encap_inline (vm, node, from_frame, /* is_ip4 */ 1, 
455                              /* csum_offload */ 0);
456 }
457
458 static uword
459 vxlan6_encap (vlib_main_t * vm,
460               vlib_node_runtime_t * node,
461               vlib_frame_t * from_frame)
462 {
463   /* Enable checksum offload for ip6 as udp checksum is mandatory, */
464   return vxlan_encap_inline (vm, node, from_frame, /* is_ip4 */ 0, 
465                              /* csum_offload */ 1);
466 }
467
468 VLIB_REGISTER_NODE (vxlan4_encap_node) = {
469   .function = vxlan4_encap,
470   .name = "vxlan4-encap",
471   .vector_size = sizeof (u32),
472   .format_trace = format_vxlan_encap_trace,
473   .type = VLIB_NODE_TYPE_INTERNAL,
474   .n_errors = ARRAY_LEN(vxlan_encap_error_strings),
475   .error_strings = vxlan_encap_error_strings,
476   .n_next_nodes = VXLAN_ENCAP_N_NEXT,
477   .next_nodes = {
478         [VXLAN_ENCAP_NEXT_DROP] = "error-drop",
479   },
480 };
481
482 VLIB_NODE_FUNCTION_MULTIARCH (vxlan4_encap_node, vxlan4_encap)
483
484 VLIB_REGISTER_NODE (vxlan6_encap_node) = {
485   .function = vxlan6_encap,
486   .name = "vxlan6-encap",
487   .vector_size = sizeof (u32),
488   .format_trace = format_vxlan_encap_trace,
489   .type = VLIB_NODE_TYPE_INTERNAL,
490   .n_errors = ARRAY_LEN(vxlan_encap_error_strings),
491   .error_strings = vxlan_encap_error_strings,
492   .n_next_nodes = VXLAN_ENCAP_N_NEXT,
493   .next_nodes = {
494         [VXLAN_ENCAP_NEXT_DROP] = "error-drop",
495   },
496 };
497
498 VLIB_NODE_FUNCTION_MULTIARCH (vxlan6_encap_node, vxlan6_encap)
499