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