Carry recorded QOS bits in the outer VXLAN IP header
[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
24 /* Statistics (not all errors) */
25 #define foreach_vxlan_encap_error    \
26 _(ENCAPSULATED, "good packets encapsulated")
27
28 static char * vxlan_encap_error_strings[] = {
29 #define _(sym,string) string,
30   foreach_vxlan_encap_error
31 #undef _
32 };
33
34 typedef enum {
35 #define _(sym,str) VXLAN_ENCAP_ERROR_##sym,
36     foreach_vxlan_encap_error
37 #undef _
38     VXLAN_ENCAP_N_ERROR,
39 } vxlan_encap_error_t;
40
41 typedef enum {
42     VXLAN_ENCAP_NEXT_DROP,
43     VXLAN_ENCAP_N_NEXT,
44 } vxlan_encap_next_t;
45
46 typedef struct {
47   u32 tunnel_index;
48   u32 vni;
49 } vxlan_encap_trace_t;
50
51 u8 * format_vxlan_encap_trace (u8 * s, va_list * args)
52 {
53   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
54   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
55   vxlan_encap_trace_t * t 
56       = va_arg (*args, vxlan_encap_trace_t *);
57
58   s = format (s, "VXLAN encap to vxlan_tunnel%d vni %d", 
59               t->tunnel_index, t->vni);
60   return s;
61 }
62
63 always_inline uword
64 vxlan_encap_inline (vlib_main_t * vm,
65                     vlib_node_runtime_t * node,
66                     vlib_frame_t * from_frame,
67                     u8 is_ip4, u8 csum_offload)
68 {
69   u32 n_left_from, next_index, * from, * to_next;
70   vxlan_main_t * vxm = &vxlan_main;
71   vnet_main_t * vnm = vxm->vnet_main;
72   vnet_interface_main_t * im = &vnm->interface_main;
73   vlib_combined_counter_main_t * tx_counter = 
74       im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_TX;
75   u32 pkts_encapsulated = 0;
76   u32 thread_index = vlib_get_thread_index();
77   u32 sw_if_index0 = 0, sw_if_index1 = 0;
78   u32 next0 = 0, next1 = 0;
79   vxlan_tunnel_t * t0 = NULL, * t1 = NULL;
80   index_t dpoi_idx0 = INDEX_INVALID, dpoi_idx1 = INDEX_INVALID;
81
82   from = vlib_frame_vector_args (from_frame);
83   n_left_from = from_frame->n_vectors;
84
85   next_index = node->cached_next_index;
86
87   STATIC_ASSERT_SIZEOF(ip6_vxlan_header_t, 56);
88   STATIC_ASSERT_SIZEOF(ip4_vxlan_header_t, 36);
89
90   word const underlay_hdr_len = is_ip4 ?
91     sizeof(ip4_vxlan_header_t) : sizeof(ip6_vxlan_header_t);
92   u16 const l3_len = is_ip4 ? sizeof(ip4_header_t) : sizeof(ip6_header_t);
93   u32 const csum_flags = is_ip4 ?
94     VNET_BUFFER_F_OFFLOAD_IP_CKSUM | VNET_BUFFER_F_IS_IP4 |
95     VNET_BUFFER_F_OFFLOAD_UDP_CKSUM :
96     VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
97
98   while (n_left_from > 0)
99     {
100       u32 n_left_to_next;
101
102       vlib_get_next_frame (vm, node, next_index,
103                            to_next, n_left_to_next);
104
105       while (n_left_from >= 4 && n_left_to_next >= 2)
106         {
107           /* Prefetch next iteration. */
108           {
109             vlib_buffer_t * p2, * p3;
110
111             p2 = vlib_get_buffer (vm, from[2]);
112             p3 = vlib_get_buffer (vm, from[3]);
113
114             vlib_prefetch_buffer_header (p2, LOAD);
115             vlib_prefetch_buffer_header (p3, LOAD);
116
117             CLIB_PREFETCH (p2->data, 2*CLIB_CACHE_LINE_BYTES, LOAD);
118             CLIB_PREFETCH (p3->data, 2*CLIB_CACHE_LINE_BYTES, LOAD);
119           }
120
121           u32 bi0 = from[0];
122           u32 bi1 = from[1];
123
124           vlib_buffer_t * b0 = vlib_get_buffer (vm, bi0);
125           vlib_buffer_t * b1 = vlib_get_buffer (vm, bi1);
126           u32 flow_hash0 = vnet_l2_compute_flow_hash (b0);
127           u32 flow_hash1 = vnet_l2_compute_flow_hash (b1);
128
129           to_next[0] = bi0;
130           to_next[1] = bi1;
131           from += 2;
132           to_next += 2;
133           n_left_to_next -= 2;
134           n_left_from -= 2;
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(vec_len(t0->rewrite) == underlay_hdr_len);
174           ASSERT(vec_len(t1->rewrite) == 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           ip4_header_t * ip4_0, * ip4_1;
185           qos_bits_t ip4_0_tos = 0, ip4_1_tos = 0;
186           ip6_header_t * ip6_0, * ip6_1;
187           udp_header_t * udp0, * udp1;
188           u8 * l3_0, * l3_1;
189           if (is_ip4)
190             {
191               ip4_vxlan_header_t * hdr0 = vlib_buffer_get_current(b0);
192               ip4_vxlan_header_t * rewrite0 = (void *)t0->rewrite;
193               ip4_vxlan_header_t * hdr1 = vlib_buffer_get_current(b1);
194               ip4_vxlan_header_t * rewrite1 = (void *)t1->rewrite;
195               *hdr0 = *rewrite0;
196               *hdr1 = *rewrite1;
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 = vlib_buffer_get_current(b0);
223               ip6_vxlan_header_t * rewrite0 = (void *) t0->rewrite;
224               ip6_vxlan_header_t * hdr1 = vlib_buffer_get_current(b0);
225               ip6_vxlan_header_t * rewrite1 = (void *) t1->rewrite;
226               *hdr0 = *rewrite0;
227               *hdr1 = *rewrite1;
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 = from[0];
325           vlib_buffer_t * b0 = vlib_get_buffer (vm, bi0);
326           u32 flow_hash0 = vnet_l2_compute_flow_hash(b0);
327
328           to_next[0] = bi0;
329           from += 1;
330           to_next += 1;
331           n_left_from -= 1;
332           n_left_to_next -= 1;
333
334           /* Get next node index and adj index from tunnel next_dpo */
335           if (sw_if_index0 != vnet_buffer(b0)->sw_if_index[VLIB_TX])
336             {
337               sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_TX];
338               vnet_hw_interface_t *hi0 = 
339                   vnet_get_sup_hw_interface (vnm, sw_if_index0);
340               t0 = &vxm->tunnels[hi0->dev_instance];
341               /* Note: change to always set next0 if it may be set to drop */
342               next0 = t0->next_dpo.dpoi_next_node;
343               dpoi_idx0 = t0->next_dpo.dpoi_index;
344             }
345           vnet_buffer(b0)->ip.adj_index[VLIB_TX] = dpoi_idx0;
346
347           ASSERT(vec_len(t0->rewrite) == underlay_hdr_len);
348           vlib_buffer_advance (b0, -underlay_hdr_len);
349
350           u32 len0 = vlib_buffer_length_in_chain (vm, b0);
351           u16 payload_l0 = clib_host_to_net_u16 (len0 - l3_len);
352
353           udp_header_t * udp0;
354           ip4_header_t * ip4_0;
355           qos_bits_t ip4_0_tos = 0;
356           ip6_header_t * ip6_0;
357           u8 * l3_0;
358           if (is_ip4)
359             {
360               ip4_vxlan_header_t * rewrite = (void *)t0->rewrite;
361               ip4_vxlan_header_t * hdr = vlib_buffer_get_current(b0);
362               *hdr = *rewrite;
363
364               /* Fix the IP4 checksum and length */
365               ip4_0 = &hdr->ip4;
366               ip4_0->length = clib_host_to_net_u16 (len0);
367
368               if (PREDICT_FALSE (b0->flags & VNET_BUFFER_F_QOS_DATA_VALID))
369                 {
370                   ip4_0_tos = vnet_buffer2 (b0)->qos.bits;
371                   ip4_0->tos = ip4_0_tos;
372                 }
373
374               l3_0 = (u8*)ip4_0;
375               udp0 = &hdr->udp;
376             }
377           else /* ip6 path */
378             {
379               ip6_vxlan_header_t * hdr = vlib_buffer_get_current(b0);
380               ip6_vxlan_header_t * rewrite = (void *) t0->rewrite;
381               *hdr = *rewrite;
382
383               /* Fix IP6 payload length */
384               ip6_0 = &hdr->ip6;
385               ip6_0->payload_length = payload_l0;
386
387               l3_0 = (u8 *)ip6_0;
388               udp0 = &hdr->udp;
389             }
390
391           /* Fix UDP length  and set source port */
392           udp0->length = payload_l0;
393           udp0->src_port = flow_hash0;
394
395           if (csum_offload)
396             {
397               b0->flags |= csum_flags;
398               vnet_buffer (b0)->l3_hdr_offset = l3_0 - b0->data;
399               vnet_buffer (b0)->l4_hdr_offset = (u8 *) udp0 - b0->data;
400             }
401           /* IPv4 UDP checksum only if checksum offload is used */
402           else if (is_ip4)
403             {
404               ip_csum_t sum0 = ip4_0->checksum;
405               sum0 = ip_csum_update (sum0, 0, ip4_0->length, ip4_header_t,
406                   length /* changed member */);
407               if (PREDICT_FALSE (ip4_0_tos))
408                 {
409                   sum0 = ip_csum_update (sum0, 0, ip4_0_tos, ip4_header_t,
410                       tos /* changed member */);
411                 }
412               ip4_0->checksum = ip_csum_fold (sum0);
413             }
414           /* IPv6 UDP checksum is mandatory */
415           else
416             {
417               int bogus = 0;
418
419               udp0->checksum = ip6_tcp_udp_icmp_compute_checksum
420                 (vm, b0, ip6_0, &bogus);
421               ASSERT(bogus == 0);
422               if (udp0->checksum == 0)
423                 udp0->checksum = 0xffff;
424             }
425
426           vlib_increment_combined_counter (tx_counter, thread_index,
427               sw_if_index0, 1, len0);
428           pkts_encapsulated ++;
429
430           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED)) 
431             {
432               vxlan_encap_trace_t *tr = 
433                 vlib_add_trace (vm, node, b0, sizeof (*tr));
434               tr->tunnel_index = t0 - vxm->tunnels;
435               tr->vni = t0->vni;
436             }
437           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
438                                            to_next, n_left_to_next,
439                                            bi0, next0);
440         }
441
442       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
443     }
444
445   /* Do we still need this now that tunnel tx stats is kept? */
446   vlib_node_increment_counter (vm, node->node_index, 
447                                VXLAN_ENCAP_ERROR_ENCAPSULATED, 
448                                pkts_encapsulated);
449
450   return from_frame->n_vectors;
451 }
452
453 static uword
454 vxlan4_encap (vlib_main_t * vm,
455               vlib_node_runtime_t * node,
456               vlib_frame_t * from_frame)
457 {
458   /* Disable chksum offload as setup overhead in tx node is not worthwhile
459      for ip4 header checksum only, unless udp checksum is also required */
460   return vxlan_encap_inline (vm, node, from_frame, /* is_ip4 */ 1, 
461                              /* csum_offload */ 0);
462 }
463
464 static uword
465 vxlan6_encap (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   .function = vxlan4_encap,
476   .name = "vxlan4-encap",
477   .vector_size = sizeof (u32),
478   .format_trace = format_vxlan_encap_trace,
479   .type = VLIB_NODE_TYPE_INTERNAL,
480   .n_errors = ARRAY_LEN(vxlan_encap_error_strings),
481   .error_strings = vxlan_encap_error_strings,
482   .n_next_nodes = VXLAN_ENCAP_N_NEXT,
483   .next_nodes = {
484         [VXLAN_ENCAP_NEXT_DROP] = "error-drop",
485   },
486 };
487
488 VLIB_NODE_FUNCTION_MULTIARCH (vxlan4_encap_node, vxlan4_encap)
489
490 VLIB_REGISTER_NODE (vxlan6_encap_node) = {
491   .function = vxlan6_encap,
492   .name = "vxlan6-encap",
493   .vector_size = sizeof (u32),
494   .format_trace = format_vxlan_encap_trace,
495   .type = VLIB_NODE_TYPE_INTERNAL,
496   .n_errors = ARRAY_LEN(vxlan_encap_error_strings),
497   .error_strings = vxlan_encap_error_strings,
498   .n_next_nodes = VXLAN_ENCAP_N_NEXT,
499   .next_nodes = {
500         [VXLAN_ENCAP_NEXT_DROP] = "error-drop",
501   },
502 };
503
504 VLIB_NODE_FUNCTION_MULTIARCH (vxlan6_encap_node, vxlan6_encap)
505