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