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