vxlan:encap - use vnet rewrite
[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 u8 * format_vxlan_encap_trace (u8 * s, va_list * args)
53 {
54   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
55   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
56   vxlan_encap_trace_t * t 
57       = va_arg (*args, vxlan_encap_trace_t *);
58
59   s = format (s, "VXLAN encap to vxlan_tunnel%d vni %d", 
60               t->tunnel_index, t->vni);
61   return s;
62 }
63
64 always_inline uword
65 vxlan_encap_inline (vlib_main_t * vm,
66                     vlib_node_runtime_t * node,
67                     vlib_frame_t * from_frame,
68                     u8 is_ip4, u8 csum_offload)
69 {
70   u32 n_left_from, next_index, * from, * to_next;
71   vxlan_main_t * vxm = &vxlan_main;
72   vnet_main_t * vnm = vxm->vnet_main;
73   vnet_interface_main_t * im = &vnm->interface_main;
74   vlib_combined_counter_main_t * tx_counter = 
75       im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_TX;
76   u32 pkts_encapsulated = 0;
77   u32 thread_index = vlib_get_thread_index();
78   u32 sw_if_index0 = 0, sw_if_index1 = 0;
79   u32 next0 = 0, next1 = 0;
80   vxlan_tunnel_t * t0 = NULL, * t1 = NULL;
81   index_t dpoi_idx0 = INDEX_INVALID, dpoi_idx1 = INDEX_INVALID;
82
83   from = vlib_frame_vector_args (from_frame);
84   n_left_from = from_frame->n_vectors;
85
86   next_index = node->cached_next_index;
87
88   STATIC_ASSERT_SIZEOF(ip6_vxlan_header_t, 56);
89   STATIC_ASSERT_SIZEOF(ip4_vxlan_header_t, 36);
90
91   u8 const underlay_hdr_len = is_ip4 ?
92     sizeof(ip4_vxlan_header_t) : sizeof(ip6_vxlan_header_t);
93   u8 const rw_hdr_offset = sizeof t0->rewrite_data - underlay_hdr_len;
94   u16 const l3_len = is_ip4 ? sizeof(ip4_header_t) : sizeof(ip6_header_t);
95   u32 const csum_flags = is_ip4 ?
96     VNET_BUFFER_F_OFFLOAD_IP_CKSUM | VNET_BUFFER_F_IS_IP4 |
97     VNET_BUFFER_F_OFFLOAD_UDP_CKSUM :
98     VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
99
100   while (n_left_from > 0)
101     {
102       u32 n_left_to_next;
103
104       vlib_get_next_frame (vm, node, next_index,
105                            to_next, n_left_to_next);
106
107       while (n_left_from >= 4 && n_left_to_next >= 2)
108         {
109           /* Prefetch next iteration. */
110           {
111             vlib_buffer_t * p2, * p3;
112
113             p2 = vlib_get_buffer (vm, from[2]);
114             p3 = vlib_get_buffer (vm, from[3]);
115
116             vlib_prefetch_buffer_header (p2, LOAD);
117             vlib_prefetch_buffer_header (p3, LOAD);
118
119             CLIB_PREFETCH (p2->data, 2*CLIB_CACHE_LINE_BYTES, LOAD);
120             CLIB_PREFETCH (p3->data, 2*CLIB_CACHE_LINE_BYTES, LOAD);
121           }
122
123           u32 bi0 = to_next[0] = from[0];
124           u32 bi1 = to_next[1] = from[1];
125           from += 2;
126           to_next += 2;
127           n_left_to_next -= 2;
128           n_left_from -= 2;
129
130           vlib_buffer_t * b0 = vlib_get_buffer (vm, bi0);
131           vlib_buffer_t * b1 = vlib_get_buffer (vm, bi1);
132           u32 flow_hash0 = vnet_l2_compute_flow_hash (b0);
133           u32 flow_hash1 = vnet_l2_compute_flow_hash (b1);
134
135           /* Get next node index and adj index from tunnel next_dpo */
136           if (sw_if_index0 != vnet_buffer(b0)->sw_if_index[VLIB_TX])
137             {
138               sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_TX];
139               vnet_hw_interface_t *hi0 = 
140                   vnet_get_sup_hw_interface (vnm, sw_if_index0);
141               t0 = &vxm->tunnels[hi0->dev_instance];
142               /* Note: change to always set next0 if it may set to drop */
143               next0 = t0->next_dpo.dpoi_next_node;
144               dpoi_idx0 = t0->next_dpo.dpoi_index;
145             }
146
147           /* Get next node index and adj index from tunnel next_dpo */
148           if (sw_if_index1 != vnet_buffer(b1)->sw_if_index[VLIB_TX])
149             {
150               if (sw_if_index0 == vnet_buffer(b1)->sw_if_index[VLIB_TX])
151                 {
152                   sw_if_index1 = sw_if_index0;
153                   t1 = t0;
154                   next1 = next0;
155                   dpoi_idx1 = dpoi_idx0;
156                 }
157               else
158                 {
159                   sw_if_index1 = vnet_buffer(b1)->sw_if_index[VLIB_TX];
160                   vnet_hw_interface_t *hi1 = 
161                       vnet_get_sup_hw_interface (vnm, sw_if_index1);
162                   t1 = &vxm->tunnels[hi1->dev_instance];
163                   /* Note: change to always set next1 if it may set to drop */
164                   next1 = t1->next_dpo.dpoi_next_node;
165                   dpoi_idx1 = t1->next_dpo.dpoi_index;
166                 }
167             }
168
169           vnet_buffer(b0)->ip.adj_index[VLIB_TX] = dpoi_idx0;
170           vnet_buffer(b1)->ip.adj_index[VLIB_TX] = dpoi_idx1;
171
172           ASSERT(t0->rewrite_header.data_bytes == underlay_hdr_len);
173           ASSERT(t1->rewrite_header.data_bytes == underlay_hdr_len);
174
175           vlib_buffer_advance (b0, -underlay_hdr_len);
176           vlib_buffer_advance (b1, -underlay_hdr_len);
177
178           u32 len0 = vlib_buffer_length_in_chain (vm, b0);
179           u32 len1 = vlib_buffer_length_in_chain (vm, b1);
180           u16 payload_l0 = clib_host_to_net_u16 (len0 - l3_len);
181           u16 payload_l1 = clib_host_to_net_u16 (len1 - l3_len);
182
183           void * underlay0 = vlib_buffer_get_current(b0);
184           void * underlay1 = vlib_buffer_get_current(b1);
185
186           /* vnet_rewrite_two_header writes only in (uword) 8 bytes chunks
187            * and discards the first 4 bytes of the (36 bytes ip4 underlay)  rewrite
188            * use memcpy as a workaround */
189           clib_memcpy(underlay0, t0->rewrite_header.data + rw_hdr_offset, underlay_hdr_len);
190           clib_memcpy(underlay1, t1->rewrite_header.data + rw_hdr_offset, underlay_hdr_len);
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           vlib_increment_combined_counter (tx_counter, thread_index,
296               sw_if_index0, 1, len0);
297           vlib_increment_combined_counter (tx_counter, thread_index,
298               sw_if_index1, 1, len1);
299           pkts_encapsulated += 2;
300
301           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED)) 
302             {
303               vxlan_encap_trace_t *tr = 
304                 vlib_add_trace (vm, node, b0, sizeof (*tr));
305               tr->tunnel_index = t0 - vxm->tunnels;
306               tr->vni = t0->vni;
307            }
308
309           if (PREDICT_FALSE(b1->flags & VLIB_BUFFER_IS_TRACED)) 
310             {
311               vxlan_encap_trace_t *tr = 
312                 vlib_add_trace (vm, node, b1, sizeof (*tr));
313               tr->tunnel_index = t1 - vxm->tunnels;
314               tr->vni = t1->vni;
315             }
316
317           vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
318                                            to_next, n_left_to_next,
319                                            bi0, bi1, next0, next1);
320         }
321
322       while (n_left_from > 0 && n_left_to_next > 0)
323         {
324           u32 bi0 = to_next[0] = from[0];
325           from += 1;
326           to_next += 1;
327           n_left_from -= 1;
328           n_left_to_next -= 1;
329
330           vlib_buffer_t * b0 = vlib_get_buffer (vm, bi0);
331           u32 flow_hash0 = vnet_l2_compute_flow_hash(b0);
332
333           /* Get next node index and adj index from tunnel next_dpo */
334           if (sw_if_index0 != vnet_buffer(b0)->sw_if_index[VLIB_TX])
335             {
336               sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_TX];
337               vnet_hw_interface_t *hi0 = 
338                   vnet_get_sup_hw_interface (vnm, sw_if_index0);
339               t0 = &vxm->tunnels[hi0->dev_instance];
340               /* Note: change to always set next0 if it may be set to drop */
341               next0 = t0->next_dpo.dpoi_next_node;
342               dpoi_idx0 = t0->next_dpo.dpoi_index;
343             }
344           vnet_buffer(b0)->ip.adj_index[VLIB_TX] = dpoi_idx0;
345
346           ASSERT(t0->rewrite_header.data_bytes == underlay_hdr_len);
347
348           vlib_buffer_advance (b0, -underlay_hdr_len);
349           void * underlay0 = vlib_buffer_get_current(b0);
350
351           /* vnet_rewrite_one_header writes only in (uword) 8 bytes chunks
352            * and discards the first 4 bytes of the (36 bytes ip4 underlay)  rewrite
353            * use memcpy as a workaround */
354           clib_memcpy(underlay0, t0->rewrite_header.data + rw_hdr_offset, underlay_hdr_len);
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 static uword
456 vxlan4_encap (vlib_main_t * vm,
457               vlib_node_runtime_t * node,
458               vlib_frame_t * from_frame)
459 {
460   /* Disable chksum offload as setup overhead in tx node is not worthwhile
461      for ip4 header checksum only, unless udp checksum is also required */
462   return vxlan_encap_inline (vm, node, from_frame, /* is_ip4 */ 1, 
463                              /* csum_offload */ 0);
464 }
465
466 static uword
467 vxlan6_encap (vlib_main_t * vm,
468               vlib_node_runtime_t * node,
469               vlib_frame_t * from_frame)
470 {
471   /* Enable checksum offload for ip6 as udp checksum is mandatory, */
472   return vxlan_encap_inline (vm, node, from_frame, /* is_ip4 */ 0, 
473                              /* csum_offload */ 1);
474 }
475
476 VLIB_REGISTER_NODE (vxlan4_encap_node) = {
477   .function = vxlan4_encap,
478   .name = "vxlan4-encap",
479   .vector_size = sizeof (u32),
480   .format_trace = format_vxlan_encap_trace,
481   .type = VLIB_NODE_TYPE_INTERNAL,
482   .n_errors = ARRAY_LEN(vxlan_encap_error_strings),
483   .error_strings = vxlan_encap_error_strings,
484   .n_next_nodes = VXLAN_ENCAP_N_NEXT,
485   .next_nodes = {
486         [VXLAN_ENCAP_NEXT_DROP] = "error-drop",
487   },
488 };
489
490 VLIB_NODE_FUNCTION_MULTIARCH (vxlan4_encap_node, vxlan4_encap)
491
492 VLIB_REGISTER_NODE (vxlan6_encap_node) = {
493   .function = vxlan6_encap,
494   .name = "vxlan6-encap",
495   .vector_size = sizeof (u32),
496   .format_trace = format_vxlan_encap_trace,
497   .type = VLIB_NODE_TYPE_INTERNAL,
498   .n_errors = ARRAY_LEN(vxlan_encap_error_strings),
499   .error_strings = vxlan_encap_error_strings,
500   .n_next_nodes = VXLAN_ENCAP_N_NEXT,
501   .next_nodes = {
502         [VXLAN_ENCAP_NEXT_DROP] = "error-drop",
503   },
504 };
505
506 VLIB_NODE_FUNCTION_MULTIARCH (vxlan6_encap_node, vxlan6_encap)
507