vxlan: vxlan/vxlan.api API cleanup
[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 ? VNET_BUFFER_F_OFFLOAD_IP_CKSUM |
97       VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_OFFLOAD_UDP_CKSUM :
98       VNET_BUFFER_F_IS_IP6 | 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 - CLIB_CACHE_LINE_BYTES, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
120             CLIB_PREFETCH (p3->data - CLIB_CACHE_LINE_BYTES, 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           vnet_rewrite_two_headers(*t0, *t1, vlib_buffer_get_current(b0), vlib_buffer_get_current(b1), underlay_hdr_len);
175
176           vlib_buffer_advance (b0, -underlay_hdr_len);
177           vlib_buffer_advance (b1, -underlay_hdr_len);
178
179           u32 len0 = vlib_buffer_length_in_chain (vm, b0);
180           u32 len1 = vlib_buffer_length_in_chain (vm, b1);
181           u16 payload_l0 = clib_host_to_net_u16 (len0 - l3_len);
182           u16 payload_l1 = clib_host_to_net_u16 (len1 - l3_len);
183
184           void * underlay0 = vlib_buffer_get_current(b0);
185           void * underlay1 = vlib_buffer_get_current(b1);
186
187           ip4_header_t * ip4_0, * ip4_1;
188           qos_bits_t ip4_0_tos = 0, ip4_1_tos = 0;
189           ip6_header_t * ip6_0, * ip6_1;
190           udp_header_t * udp0, * udp1;
191           u8 * l3_0, * l3_1;
192           if (is_ip4)
193             {
194               ip4_vxlan_header_t * hdr0 = underlay0;
195               ip4_vxlan_header_t * hdr1 = underlay1;
196
197               /* Fix the IP4 checksum and length */
198               ip4_0 = &hdr0->ip4;
199               ip4_1 = &hdr1->ip4;
200               ip4_0->length = clib_host_to_net_u16 (len0);
201               ip4_1->length = clib_host_to_net_u16 (len1);
202
203               if (PREDICT_FALSE (b0->flags & VNET_BUFFER_F_QOS_DATA_VALID))
204                 {
205                   ip4_0_tos = vnet_buffer2 (b0)->qos.bits;
206                   ip4_0->tos = ip4_0_tos;
207                 }
208               if (PREDICT_FALSE (b1->flags & VNET_BUFFER_F_QOS_DATA_VALID))
209                 {
210                   ip4_1_tos = vnet_buffer2 (b1)->qos.bits;
211                   ip4_1->tos = ip4_1_tos;
212                 }
213
214               l3_0 = (u8 *)ip4_0;
215               l3_1 = (u8 *)ip4_1;
216               udp0 = &hdr0->udp;
217               udp1 = &hdr1->udp;
218             }
219           else /* ipv6 */
220             {
221               ip6_vxlan_header_t * hdr0 = underlay0;
222               ip6_vxlan_header_t * hdr1 = underlay1;
223
224               /* Fix IP6 payload length */
225               ip6_0 = &hdr0->ip6;
226               ip6_1 = &hdr1->ip6;
227               ip6_0->payload_length = payload_l0;
228               ip6_1->payload_length = payload_l1;
229
230               l3_0 = (u8 *)ip6_0;
231               l3_1 = (u8 *)ip6_1;
232               udp0 = &hdr0->udp;
233               udp1 = &hdr1->udp;
234             }
235
236           /* Fix UDP length  and set source port */
237           udp0->length = payload_l0;
238           udp0->src_port = flow_hash0;
239           udp1->length = payload_l1;
240           udp1->src_port = flow_hash1;
241
242           if (csum_offload)
243             {
244               b0->flags |= csum_flags;
245               vnet_buffer (b0)->l3_hdr_offset = l3_0 - b0->data;
246               vnet_buffer (b0)->l4_hdr_offset = (u8 *) udp0 - b0->data;
247               b1->flags |= csum_flags;
248               vnet_buffer (b1)->l3_hdr_offset = l3_1 - b1->data;
249               vnet_buffer (b1)->l4_hdr_offset = (u8 *) udp1 - b1->data;
250             }
251           /* IPv4 UDP checksum only if checksum offload is used */
252           else if (is_ip4)
253             {
254               ip_csum_t sum0 = ip4_0->checksum;
255               sum0 = ip_csum_update (sum0, 0, ip4_0->length, ip4_header_t,
256                   length /* changed member */);
257               if (PREDICT_FALSE (ip4_0_tos))
258                 {
259                   sum0 = ip_csum_update (sum0, 0, ip4_0_tos, ip4_header_t,
260                       tos /* changed member */);
261                 }
262               ip4_0->checksum = ip_csum_fold (sum0);
263               ip_csum_t sum1 = ip4_1->checksum;
264               sum1 = ip_csum_update (sum1, 0, ip4_1->length, ip4_header_t,
265                   length /* changed member */);
266               if (PREDICT_FALSE (ip4_1_tos))
267                 {
268                   sum1 = ip_csum_update (sum1, 0, ip4_1_tos, ip4_header_t,
269                       tos /* changed member */);
270                 }
271               ip4_1->checksum = ip_csum_fold (sum1);
272             }
273           /* IPv6 UDP checksum is mandatory */
274           else
275             {
276               int bogus = 0;
277
278               udp0->checksum = ip6_tcp_udp_icmp_compute_checksum
279                 (vm, b0, ip6_0, &bogus);
280               ASSERT(bogus == 0);
281               if (udp0->checksum == 0)
282                 udp0->checksum = 0xffff;
283               udp1->checksum = ip6_tcp_udp_icmp_compute_checksum
284                 (vm, b1, ip6_1, &bogus);
285               ASSERT(bogus == 0);
286               if (udp1->checksum == 0)
287                 udp1->checksum = 0xffff;
288             }
289
290         /* save inner packet flow_hash for load-balance node */
291         vnet_buffer (b0)->ip.flow_hash = flow_hash0;
292         vnet_buffer (b1)->ip.flow_hash = flow_hash1;
293
294         if (sw_if_index0 == sw_if_index1)
295         {
296           vlib_increment_combined_counter (tx_counter, thread_index,
297               sw_if_index0, 2, len0 + len1);
298         }
299         else
300         {
301           vlib_increment_combined_counter (tx_counter, thread_index,
302               sw_if_index0, 1, len0);
303           vlib_increment_combined_counter (tx_counter, thread_index,
304               sw_if_index1, 1, len1);
305         }
306           pkts_encapsulated += 2;
307
308           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED)) 
309             {
310               vxlan_encap_trace_t *tr = 
311                 vlib_add_trace (vm, node, b0, sizeof (*tr));
312               tr->tunnel_index = t0 - vxm->tunnels;
313               tr->vni = t0->vni;
314            }
315
316           if (PREDICT_FALSE(b1->flags & VLIB_BUFFER_IS_TRACED)) 
317             {
318               vxlan_encap_trace_t *tr = 
319                 vlib_add_trace (vm, node, b1, sizeof (*tr));
320               tr->tunnel_index = t1 - vxm->tunnels;
321               tr->vni = t1->vni;
322             }
323
324           vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
325                                            to_next, n_left_to_next,
326                                            bi0, bi1, next0, next1);
327         }
328
329       while (n_left_from > 0 && n_left_to_next > 0)
330         {
331           u32 bi0 = to_next[0] = from[0];
332           from += 1;
333           to_next += 1;
334           n_left_from -= 1;
335           n_left_to_next -= 1;
336
337           vlib_buffer_t * b0 = vlib_get_buffer (vm, bi0);
338           u32 flow_hash0 = vnet_l2_compute_flow_hash(b0);
339
340           /* Get next node index and adj index from tunnel next_dpo */
341           if (sw_if_index0 != vnet_buffer(b0)->sw_if_index[VLIB_TX])
342             {
343               sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_TX];
344               vnet_hw_interface_t *hi0 = 
345                   vnet_get_sup_hw_interface (vnm, sw_if_index0);
346               t0 = &vxm->tunnels[hi0->dev_instance];
347               /* Note: change to always set next0 if it may be set to drop */
348               next0 = t0->next_dpo.dpoi_next_node;
349               dpoi_idx0 = t0->next_dpo.dpoi_index;
350             }
351           vnet_buffer(b0)->ip.adj_index[VLIB_TX] = dpoi_idx0;
352
353           ASSERT(t0->rewrite_header.data_bytes == underlay_hdr_len);
354           vnet_rewrite_one_header(*t0, vlib_buffer_get_current(b0), underlay_hdr_len);
355
356           vlib_buffer_advance (b0, -underlay_hdr_len);
357           void * underlay0 = vlib_buffer_get_current(b0);
358
359           u32 len0 = vlib_buffer_length_in_chain (vm, b0);
360           u16 payload_l0 = clib_host_to_net_u16 (len0 - l3_len);
361
362           udp_header_t * udp0;
363           ip4_header_t * ip4_0;
364           qos_bits_t ip4_0_tos = 0;
365           ip6_header_t * ip6_0;
366           u8 * l3_0;
367           if (is_ip4)
368             {
369               ip4_vxlan_header_t * hdr = underlay0;
370
371               /* Fix the IP4 checksum and length */
372               ip4_0 = &hdr->ip4;
373               ip4_0->length = clib_host_to_net_u16 (len0);
374
375               if (PREDICT_FALSE (b0->flags & VNET_BUFFER_F_QOS_DATA_VALID))
376                 {
377                   ip4_0_tos = vnet_buffer2 (b0)->qos.bits;
378                   ip4_0->tos = ip4_0_tos;
379                 }
380
381               l3_0 = (u8*)ip4_0;
382               udp0 = &hdr->udp;
383             }
384           else /* ip6 path */
385             {
386               ip6_vxlan_header_t * hdr = underlay0;
387
388               /* Fix IP6 payload length */
389               ip6_0 = &hdr->ip6;
390               ip6_0->payload_length = payload_l0;
391
392               l3_0 = (u8 *)ip6_0;
393               udp0 = &hdr->udp;
394             }
395
396           /* Fix UDP length  and set source port */
397           udp0->length = payload_l0;
398           udp0->src_port = flow_hash0;
399
400           if (csum_offload)
401             {
402               b0->flags |= csum_flags;
403               vnet_buffer (b0)->l3_hdr_offset = l3_0 - b0->data;
404               vnet_buffer (b0)->l4_hdr_offset = (u8 *) udp0 - b0->data;
405             }
406           /* IPv4 UDP checksum only if checksum offload is used */
407           else if (is_ip4)
408             {
409               ip_csum_t sum0 = ip4_0->checksum;
410               sum0 = ip_csum_update (sum0, 0, ip4_0->length, ip4_header_t,
411                   length /* changed member */);
412               if (PREDICT_FALSE (ip4_0_tos))
413                 {
414                   sum0 = ip_csum_update (sum0, 0, ip4_0_tos, ip4_header_t,
415                       tos /* changed member */);
416                 }
417               ip4_0->checksum = ip_csum_fold (sum0);
418             }
419           /* IPv6 UDP checksum is mandatory */
420           else
421             {
422               int bogus = 0;
423
424               udp0->checksum = ip6_tcp_udp_icmp_compute_checksum
425                 (vm, b0, ip6_0, &bogus);
426               ASSERT(bogus == 0);
427               if (udp0->checksum == 0)
428                 udp0->checksum = 0xffff;
429             }
430
431           /* reuse inner packet flow_hash for load-balance node */
432           vnet_buffer (b0)->ip.flow_hash = flow_hash0;
433
434           vlib_increment_combined_counter (tx_counter, thread_index,
435               sw_if_index0, 1, len0);
436           pkts_encapsulated ++;
437
438           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED)) 
439             {
440               vxlan_encap_trace_t *tr = 
441                 vlib_add_trace (vm, node, b0, sizeof (*tr));
442               tr->tunnel_index = t0 - vxm->tunnels;
443               tr->vni = t0->vni;
444             }
445           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
446                                            to_next, n_left_to_next,
447                                            bi0, next0);
448         }
449
450       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
451     }
452
453   /* Do we still need this now that tunnel tx stats is kept? */
454   vlib_node_increment_counter (vm, node->node_index, 
455                                VXLAN_ENCAP_ERROR_ENCAPSULATED, 
456                                pkts_encapsulated);
457
458   return from_frame->n_vectors;
459 }
460
461 VLIB_NODE_FN (vxlan4_encap_node) (vlib_main_t * vm,
462               vlib_node_runtime_t * node,
463               vlib_frame_t * from_frame)
464 {
465   /* Disable chksum offload as setup overhead in tx node is not worthwhile
466      for ip4 header checksum only, unless udp checksum is also required */
467   return vxlan_encap_inline (vm, node, from_frame, /* is_ip4 */ 1, 
468                              /* csum_offload */ 0);
469 }
470
471 VLIB_NODE_FN (vxlan6_encap_node) (vlib_main_t * vm,
472               vlib_node_runtime_t * node,
473               vlib_frame_t * from_frame)
474 {
475   /* Enable checksum offload for ip6 as udp checksum is mandatory, */
476   return vxlan_encap_inline (vm, node, from_frame, /* is_ip4 */ 0, 
477                              /* csum_offload */ 1);
478 }
479
480 VLIB_REGISTER_NODE (vxlan4_encap_node) = {
481   .name = "vxlan4-encap",
482   .vector_size = sizeof (u32),
483   .format_trace = format_vxlan_encap_trace,
484   .type = VLIB_NODE_TYPE_INTERNAL,
485   .n_errors = ARRAY_LEN(vxlan_encap_error_strings),
486   .error_strings = vxlan_encap_error_strings,
487   .n_next_nodes = VXLAN_ENCAP_N_NEXT,
488   .next_nodes = {
489         [VXLAN_ENCAP_NEXT_DROP] = "error-drop",
490   },
491 };
492
493 VLIB_REGISTER_NODE (vxlan6_encap_node) = {
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