FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
gre.c
Go to the documentation of this file.
1 /*
2  * gre.c: gre
3  *
4  * Copyright (c) 2012 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #include <vnet/vnet.h>
19 #include <vnet/gre/gre.h>
20 #include <vnet/adj/adj_midchain.h>
21 #include <vnet/tunnel/tunnel_dp.h>
22 
23 extern gre_main_t gre_main;
24 
25 #ifndef CLIB_MARCH_VARIANT
27 
28 typedef struct
29 {
30  union
31  {
32  ip4_and_gre_header_t ip4_and_gre;
33  u64 as_u64[3];
34  };
36 
37 typedef struct
38 {
39  union
40  {
41  ip6_and_gre_header_t ip6_and_gre;
42  u64 as_u64[3];
43  };
45 #endif /* CLIB_MARCH_VARIANT */
46 
47 
48 /* Packet trace structure */
49 typedef struct
50 {
51  /* Tunnel-id / index in tunnel vector */
53 
54  /* pkt length */
56 
57  /* tunnel ip addresses */
58  ip46_address_t src;
59  ip46_address_t dst;
61 
62 extern u8 *format_gre_tx_trace (u8 * s, va_list * args);
63 
64 #ifndef CLIB_MARCH_VARIANT
65 u8 *
66 format_gre_tx_trace (u8 * s, va_list * args)
67 {
68  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
69  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
70  gre_tx_trace_t *t = va_arg (*args, gre_tx_trace_t *);
71 
72  s = format (s, "GRE: tunnel %d len %d src %U dst %U",
73  t->tunnel_id, t->length,
76  return s;
77 }
78 
79 u8 *
80 format_gre_protocol (u8 * s, va_list * args)
81 {
82  gre_protocol_t p = va_arg (*args, u32);
85 
86  if (pi)
87  s = format (s, "%s", pi->name);
88  else
89  s = format (s, "0x%04x", p);
90 
91  return s;
92 }
93 
94 u8 *
95 format_gre_header_with_length (u8 * s, va_list * args)
96 {
98  gre_header_t *h = va_arg (*args, gre_header_t *);
99  u32 max_header_bytes = va_arg (*args, u32);
100  gre_protocol_t p = clib_net_to_host_u16 (h->protocol);
101  u32 indent, header_bytes;
102 
103  header_bytes = sizeof (h[0]);
104  if (max_header_bytes != 0 && header_bytes > max_header_bytes)
105  return format (s, "gre header truncated");
106 
107  indent = format_get_indent (s);
108 
109  s = format (s, "GRE %U", format_gre_protocol, p);
110 
111  if (max_header_bytes != 0 && header_bytes < max_header_bytes)
112  {
115  if (node->format_buffer)
116  s = format (s, "\n%U%U",
117  format_white_space, indent,
118  node->format_buffer, (void *) (h + 1),
119  max_header_bytes - header_bytes);
120  }
121 
122  return s;
123 }
124 
125 u8 *
126 format_gre_header (u8 * s, va_list * args)
127 {
128  gre_header_t *h = va_arg (*args, gre_header_t *);
129  return format (s, "%U", format_gre_header_with_length, h, 0);
130 }
131 
132 /* Returns gre protocol as an int in host byte order. */
133 uword
135  va_list * args)
136 {
137  u16 *result = va_arg (*args, u16 *);
138  gre_main_t *gm = &gre_main;
139  int i;
140 
141  /* Named type. */
143  gm->protocol_info_by_name, &i))
144  {
146  *result = pi->protocol;
147  return 1;
148  }
149 
150  return 0;
151 }
152 
153 uword
155  va_list * args)
156 {
157  u16 *result = va_arg (*args, u16 *);
159  return 0;
160  *result = clib_host_to_net_u16 ((u16) * result);
161  return 1;
162 }
163 
164 uword
165 unformat_gre_header (unformat_input_t * input, va_list * args)
166 {
167  u8 **result = va_arg (*args, u8 **);
168  gre_header_t _h, *h = &_h;
169  u16 p;
170 
171  if (!unformat (input, "%U", unformat_gre_protocol_host_byte_order, &p))
172  return 0;
173 
174  h->protocol = clib_host_to_net_u16 (p);
175 
176  /* Add header to result. */
177  {
178  void *p;
179  u32 n_bytes = sizeof (h[0]);
180 
181  vec_add2 (*result, p, n_bytes);
182  clib_memcpy (p, h, n_bytes);
183  }
184 
185  return 1;
186 }
187 
188 static int
190 {
191  switch (link)
192  {
193  case VNET_LINK_IP4:
194  return (GRE_PROTOCOL_ip4);
195  case VNET_LINK_IP6:
196  return (GRE_PROTOCOL_ip6);
197  case VNET_LINK_MPLS:
198  return (GRE_PROTOCOL_mpls_unicast);
199  case VNET_LINK_ETHERNET:
200  return (GRE_PROTOCOL_teb);
201  case VNET_LINK_ARP:
202  return (GRE_PROTOCOL_arp);
203  case VNET_LINK_NSH:
204  ASSERT (0);
205  break;
206  }
207  ASSERT (0);
208  return (GRE_PROTOCOL_ip4);
209 }
210 
211 static u8 *
214  vnet_link_t link_type, const void *dst_address)
215 {
216  gre_main_t *gm = &gre_main;
217  const ip46_address_t *dst;
218  ip4_and_gre_header_t *h4;
219  ip6_and_gre_header_t *h6;
220  gre_header_t *gre;
221  u8 *rewrite = NULL;
222  gre_tunnel_t *t;
223  u32 ti;
224  u8 is_ipv6;
225 
226  dst = dst_address;
228 
229  if (~0 == ti)
230  /* not one of ours */
231  return (0);
232 
233  t = pool_elt_at_index (gm->tunnels, ti);
234 
235  is_ipv6 = t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6 ? 1 : 0;
236 
237  if (!is_ipv6)
238  {
239  vec_validate (rewrite, sizeof (*h4) - 1);
240  h4 = (ip4_and_gre_header_t *) rewrite;
241  gre = &h4->gre;
242  h4->ip4.ip_version_and_header_length = 0x45;
243  h4->ip4.ttl = 254;
244  h4->ip4.protocol = IP_PROTOCOL_GRE;
245  /* fixup ip4 header length and checksum after-the-fact */
246  h4->ip4.src_address.as_u32 = t->tunnel_src.ip4.as_u32;
247  h4->ip4.dst_address.as_u32 = dst->ip4.as_u32;
248  h4->ip4.checksum = ip4_header_checksum (&h4->ip4);
249  }
250  else
251  {
252  vec_validate (rewrite, sizeof (*h6) - 1);
253  h6 = (ip6_and_gre_header_t *) rewrite;
254  gre = &h6->gre;
255  h6->ip6.ip_version_traffic_class_and_flow_label =
256  clib_host_to_net_u32 (6 << 28);
257  h6->ip6.hop_limit = 255;
258  h6->ip6.protocol = IP_PROTOCOL_GRE;
259  /* fixup ip6 header length and checksum after-the-fact */
260  h6->ip6.src_address.as_u64[0] = t->tunnel_src.ip6.as_u64[0];
261  h6->ip6.src_address.as_u64[1] = t->tunnel_src.ip6.as_u64[1];
262  h6->ip6.dst_address.as_u64[0] = dst->ip6.as_u64[0];
263  h6->ip6.dst_address.as_u64[1] = dst->ip6.as_u64[1];
264  }
265 
266  if (PREDICT_FALSE (t->type == GRE_TUNNEL_TYPE_ERSPAN))
267  {
268  gre->protocol = clib_host_to_net_u16 (GRE_PROTOCOL_erspan);
269  gre->flags_and_version = clib_host_to_net_u16 (GRE_FLAGS_SEQUENCE);
270  }
271  else
272  gre->protocol =
273  clib_host_to_net_u16 (gre_proto_from_vnet_link (link_type));
274 
275  return (rewrite);
276 }
277 
278 static void
280  const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
281 {
283  ip4_and_gre_header_t *ip0;
284 
285  ip0 = vlib_buffer_get_current (b0);
286  flags = pointer_to_uword (data);
287 
288  /* Fixup the checksum and len fields in the GRE tunnel encap
289  * that was applied at the midchain node */
290  ip0->ip4.length =
291  clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
292  tunnel_encap_fixup_4o4 (flags, (ip4_header_t *) (ip0 + 1), &ip0->ip4);
293  ip0->ip4.checksum = ip4_header_checksum (&ip0->ip4);
294 }
295 
296 static void
298  const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
299 {
301  ip4_and_gre_header_t *ip0;
302 
303  ip0 = vlib_buffer_get_current (b0);
304  flags = pointer_to_uword (data);
305 
306  /* Fixup the checksum and len fields in the GRE tunnel encap
307  * that was applied at the midchain node */
308  ip0->ip4.length =
309  clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
310  tunnel_encap_fixup_6o4 (flags, (ip6_header_t *) (ip0 + 1), &ip0->ip4);
311  ip0->ip4.checksum = ip4_header_checksum (&ip0->ip4);
312 }
313 
314 static void
316  const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
317 {
318  ip4_header_t *ip0;
319 
320  ip0 = vlib_buffer_get_current (b0);
321 
322  /* Fixup the checksum and len fields in the GRE tunnel encap
323  * that was applied at the midchain node */
324  ip0->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
325  ip0->checksum = ip4_header_checksum (ip0);
326 }
327 
328 static void
330  const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
331 {
333  ip6_and_gre_header_t *ip0;
334 
335  ip0 = vlib_buffer_get_current (b0);
336  flags = pointer_to_uword (data);
337 
338  /* Fixup the payload length field in the GRE tunnel encap that was applied
339  * at the midchain node */
340  ip0->ip6.payload_length =
341  clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
342  sizeof (ip0->ip6));
343  tunnel_encap_fixup_4o6 (flags, (ip4_header_t *) (ip0 + 1), &ip0->ip6);
344 }
345 
346 static void
348  const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
349 {
351  ip6_and_gre_header_t *ip0;
352 
353  ip0 = vlib_buffer_get_current (b0);
354  flags = pointer_to_uword (data);
355 
356  /* Fixup the payload length field in the GRE tunnel encap that was applied
357  * at the midchain node */
358  ip0->ip6.payload_length =
359  clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
360  sizeof (ip0->ip6));
361  tunnel_encap_fixup_6o6 (flags, (ip6_header_t *) (ip0 + 1), &ip0->ip6);
362 }
363 
364 static void
366  const ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
367 {
368  ip6_and_gre_header_t *ip0;
369 
370  ip0 = vlib_buffer_get_current (b0);
371 
372  /* Fixup the payload length field in the GRE tunnel encap that was applied
373  * at the midchain node */
374  ip0->ip6.payload_length =
375  clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
376  sizeof (ip0->ip6));
377 }
378 
379 /**
380  * return the appropriate fixup function given the overlay (link-type) and
381  * underlay (fproto) combination
382  */
385 {
386  if (fproto == FIB_PROTOCOL_IP6 && lt == VNET_LINK_IP6)
387  return (gre66_fixup);
388  if (fproto == FIB_PROTOCOL_IP6 && lt == VNET_LINK_IP4)
389  return (gre46_fixup);
390  if (fproto == FIB_PROTOCOL_IP4 && lt == VNET_LINK_IP6)
391  return (gre64_fixup);
392  if (fproto == FIB_PROTOCOL_IP4 && lt == VNET_LINK_IP4)
393  return (gre44_fixup);
394  if (fproto == FIB_PROTOCOL_IP6 && lt == VNET_LINK_ETHERNET)
395  return (grex6_fixup);
396  if (fproto == FIB_PROTOCOL_IP4 && lt == VNET_LINK_ETHERNET)
397  return (grex4_fixup);
398 
399  ASSERT (0);
400  return (gre44_fixup);
401 }
402 
403 void
405 {
406  gre_main_t *gm = &gre_main;
407  gre_tunnel_t *t;
408  adj_flags_t af;
409  u32 ti;
410 
412  t = pool_elt_at_index (gm->tunnels, ti);
414 
417 
420  adj_get_link_type (ai)),
421  uword_to_pointer (t->flags, void *), af,
422  gre_build_rewrite (vnm, sw_if_index, adj_get_link_type (ai),
423  &t->tunnel_dst.fp_addr));
424 
425  gre_tunnel_stack (ai);
426 }
427 
430 {
432 
434  (ai, gre_get_fixup (ctx->t->tunnel_dst.fp_proto,
435  adj_get_link_type (ai)),
436  uword_to_pointer (ctx->t->flags, void *),
439  ctx->t->sw_if_index,
440  adj_get_link_type (ai),
441  &teib_entry_get_nh (ctx->ne)->fp_addr));
442 
443  teib_entry_adj_stack (ctx->ne, ai);
444 
445  return (ADJ_WALK_RC_CONTINUE);
446 }
447 
450 {
451  gre_tunnel_t *t = data;
452 
454  adj_get_link_type (ai)),
455  NULL, ADJ_FLAG_NONE, NULL);
456 
458 
459  return (ADJ_WALK_RC_CONTINUE);
460 }
461 
462 void
464 {
465  gre_main_t *gm = &gre_main;
466  ip_adjacency_t *adj;
467  teib_entry_t *ne;
468  gre_tunnel_t *t;
469  u32 ti;
470 
471  adj = adj_get (ai);
473  t = pool_elt_at_index (gm->tunnels, ti);
474 
475  ne = teib_entry_find (sw_if_index, &adj->sub_type.nbr.next_hop);
476 
477  if (NULL == ne)
478  // no NHRP entry to provide the next-hop
479  return;
480 
481  mgre_walk_ctx_t ctx = {
482  .t = t,
483  .ne = ne
484  };
485  adj_nbr_walk_nh (sw_if_index,
486  adj->ia_nh_proto,
487  &adj->sub_type.nbr.next_hop, mgre_mk_complete_walk, &ctx);
488 }
489 #endif /* CLIB_MARCH_VARIANT */
490 
491 typedef enum
492 {
496 
497 /**
498  * @brief TX function. Only called for L2 payload including TEB or ERSPAN.
499  * L3 traffic uses the adj-midchains.
500  */
505 {
506  gre_main_t *gm = &gre_main;
507  u32 *from, n_left_from;
508  vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
509  u32 sw_if_index[2] = { ~0, ~0 };
510  const gre_tunnel_t *gt[2] = { 0 };
511  adj_index_t adj_index[2] = { ADJ_INDEX_INVALID, ADJ_INDEX_INVALID };
512 
513  from = vlib_frame_vector_args (frame);
514  n_left_from = frame->n_vectors;
515  vlib_get_buffers (vm, from, bufs, n_left_from);
516 
517  while (n_left_from >= 2)
518  {
519 
520  if (PREDICT_FALSE
521  (sw_if_index[0] != vnet_buffer (b[0])->sw_if_index[VLIB_TX]))
522  {
523  const vnet_hw_interface_t *hi;
524  sw_if_index[0] = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
525  hi = vnet_get_sup_hw_interface (gm->vnet_main, sw_if_index[0]);
526  gt[0] = &gm->tunnels[hi->dev_instance];
527  adj_index[0] = gt[0]->l2_adj_index;
528  }
529  if (PREDICT_FALSE
530  (sw_if_index[1] != vnet_buffer (b[1])->sw_if_index[VLIB_TX]))
531  {
532  const vnet_hw_interface_t *hi;
533  sw_if_index[1] = vnet_buffer (b[1])->sw_if_index[VLIB_TX];
534  hi = vnet_get_sup_hw_interface (gm->vnet_main, sw_if_index[1]);
535  gt[1] = &gm->tunnels[hi->dev_instance];
536  adj_index[1] = gt[1]->l2_adj_index;
537  }
538 
539  vnet_buffer (b[0])->ip.adj_index[VLIB_TX] = adj_index[0];
540  vnet_buffer (b[1])->ip.adj_index[VLIB_TX] = adj_index[1];
541 
542  if (type == GRE_TUNNEL_TYPE_ERSPAN)
543  {
544  /* Encap GRE seq# and ERSPAN type II header */
545  erspan_t2_t *h0;
546  u32 seq_num;
547  u64 hdr;
548  vlib_buffer_advance (b[0], -sizeof (erspan_t2_t));
549  h0 = vlib_buffer_get_current (b[0]);
550  seq_num = clib_atomic_fetch_add (&gt[0]->gre_sn->seq_num, 1);
551  hdr = clib_host_to_net_u64 (ERSPAN_HDR2);
552  h0->seq_num = clib_host_to_net_u32 (seq_num);
553  h0->t2_u64 = hdr;
554  h0->t2.cos_en_t_session |= clib_host_to_net_u16 (gt[0]->session_id);
555  }
556  if (type == GRE_TUNNEL_TYPE_ERSPAN)
557  {
558  /* Encap GRE seq# and ERSPAN type II header */
559  erspan_t2_t *h0;
560  u32 seq_num;
561  u64 hdr;
562  vlib_buffer_advance (b[1], -sizeof (erspan_t2_t));
563  h0 = vlib_buffer_get_current (b[1]);
564  seq_num = clib_atomic_fetch_add (&gt[1]->gre_sn->seq_num, 1);
565  hdr = clib_host_to_net_u64 (ERSPAN_HDR2);
566  h0->seq_num = clib_host_to_net_u32 (seq_num);
567  h0->t2_u64 = hdr;
568  h0->t2.cos_en_t_session |= clib_host_to_net_u16 (gt[1]->session_id);
569  }
570 
571  if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
572  {
573  gre_tx_trace_t *tr = vlib_add_trace (vm, node,
574  b[0], sizeof (*tr));
575  tr->tunnel_id = gt[0] - gm->tunnels;
576  tr->src = gt[0]->tunnel_src;
577  tr->dst = gt[0]->tunnel_dst.fp_addr;
578  tr->length = vlib_buffer_length_in_chain (vm, b[0]);
579  }
580  if (PREDICT_FALSE (b[1]->flags & VLIB_BUFFER_IS_TRACED))
581  {
582  gre_tx_trace_t *tr = vlib_add_trace (vm, node,
583  b[1], sizeof (*tr));
584  tr->tunnel_id = gt[1] - gm->tunnels;
585  tr->src = gt[1]->tunnel_src;
586  tr->dst = gt[1]->tunnel_dst.fp_addr;
587  tr->length = vlib_buffer_length_in_chain (vm, b[1]);
588  }
589 
590  b += 2;
591  n_left_from -= 2;
592  }
593 
594  while (n_left_from >= 1)
595  {
596 
597  if (PREDICT_FALSE
598  (sw_if_index[0] != vnet_buffer (b[0])->sw_if_index[VLIB_TX]))
599  {
600  const vnet_hw_interface_t *hi;
601  sw_if_index[0] = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
602  hi = vnet_get_sup_hw_interface (gm->vnet_main, sw_if_index[0]);
603  gt[0] = &gm->tunnels[hi->dev_instance];
604  adj_index[0] = gt[0]->l2_adj_index;
605  }
606 
607  vnet_buffer (b[0])->ip.adj_index[VLIB_TX] = adj_index[0];
608 
609  if (type == GRE_TUNNEL_TYPE_ERSPAN)
610  {
611  /* Encap GRE seq# and ERSPAN type II header */
612  erspan_t2_t *h0;
613  u32 seq_num;
614  u64 hdr;
615  ASSERT (gt[0]->type == GRE_TUNNEL_TYPE_ERSPAN);
616  vlib_buffer_advance (b[0], -sizeof (erspan_t2_t));
617  h0 = vlib_buffer_get_current (b[0]);
618  seq_num = clib_atomic_fetch_add (&gt[0]->gre_sn->seq_num, 1);
619  hdr = clib_host_to_net_u64 (ERSPAN_HDR2);
620  h0->seq_num = clib_host_to_net_u32 (seq_num);
621  h0->t2_u64 = hdr;
622  h0->t2.cos_en_t_session |= clib_host_to_net_u16 (gt[0]->session_id);
623  }
624 
625  if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
626  {
627  gre_tx_trace_t *tr = vlib_add_trace (vm, node,
628  b[0], sizeof (*tr));
629  tr->tunnel_id = gt[0] - gm->tunnels;
630  tr->src = gt[0]->tunnel_src;
631  tr->dst = gt[0]->tunnel_dst.fp_addr;
632  tr->length = vlib_buffer_length_in_chain (vm, b[0]);
633  }
634 
635  b += 1;
636  n_left_from -= 1;
637  }
638 
639  vlib_buffer_enqueue_to_single_next (vm, node, from,
641  frame->n_vectors);
642 
644  GRE_ERROR_PKTS_ENCAP, frame->n_vectors);
645 
646  return frame->n_vectors;
647 }
648 
649 static char *gre_error_strings[] = {
650 #define gre_error(n,s) s,
651 #include "error.def"
652 #undef gre_error
653 };
654 
658 {
659  return (gre_encap_inline (vm, node, frame, GRE_TUNNEL_TYPE_TEB));
660 }
661 
665 {
666  return (gre_encap_inline (vm, node, frame, GRE_TUNNEL_TYPE_ERSPAN));
667 }
668 
669 /* *INDENT-OFF* */
671 {
672  .name = "gre-teb-encap",
673  .vector_size = sizeof (u32),
674  .format_trace = format_gre_tx_trace,
676  .n_errors = GRE_N_ERROR,
677  .error_strings = gre_error_strings,
678  .n_next_nodes = GRE_ENCAP_N_NEXT,
679  .next_nodes = {
680  [GRE_ENCAP_NEXT_L2_MIDCHAIN] = "adj-l2-midchain",
681  },
682 };
684 {
685  .name = "gre-erspan-encap",
686  .vector_size = sizeof (u32),
687  .format_trace = format_gre_tx_trace,
689  .n_errors = GRE_N_ERROR,
690  .error_strings = gre_error_strings,
691  .n_next_nodes = GRE_ENCAP_N_NEXT,
692  .next_nodes = {
693  [GRE_ENCAP_NEXT_L2_MIDCHAIN] = "adj-l2-midchain",
694  },
695 };
696 /* *INDENT-ON* */
697 
698 #ifndef CLIB_MARCH_VARIANT
699 static u8 *
700 format_gre_tunnel_name (u8 * s, va_list * args)
701 {
702  u32 dev_instance = va_arg (*args, u32);
703  gre_main_t *gm = &gre_main;
704  gre_tunnel_t *t;
705 
706  if (dev_instance >= vec_len (gm->tunnels))
707  return format (s, "<improperly-referenced>");
708 
709  t = pool_elt_at_index (gm->tunnels, dev_instance);
710  return format (s, "gre%d", t->user_instance);
711 }
712 
713 static u8 *
714 format_gre_device (u8 * s, va_list * args)
715 {
716  u32 dev_instance = va_arg (*args, u32);
717  CLIB_UNUSED (int verbose) = va_arg (*args, int);
718 
719  s = format (s, "GRE tunnel: id %d\n", dev_instance);
720  return s;
721 }
722 
723 static int
725  ip46_address_t * src, ip46_address_t * dst, u8 * is_l2)
726 {
727  gre_main_t *gm = &gre_main;
728  gre_tunnel_t *t;
729  u32 ti;
730 
732 
733  if (~0 == ti)
734  /* not one of ours */
735  return -1;
736 
737  t = pool_elt_at_index (gm->tunnels, ti);
738 
739  *src = t->tunnel_src;
740  *dst = t->tunnel_dst.fp_addr;
741  *is_l2 = t->type == GRE_TUNNEL_TYPE_TEB;
742 
743  return (0);
744 }
745 
746 /* *INDENT-OFF* */
748  .name = "GRE tunnel device",
749  .format_device_name = format_gre_tunnel_name,
750  .format_device = format_gre_device,
751  .format_tx_trace = format_gre_tx_trace,
752  .admin_up_down_function = gre_interface_admin_up_down,
753  .ip_tun_desc = gre_tunnel_desc,
754 #ifdef SOON
755  .clear counter = 0;
756 #endif
757 };
758 
760  .name = "GRE",
761  .format_header = format_gre_header_with_length,
762  .unformat_header = unformat_gre_header,
763  .build_rewrite = gre_build_rewrite,
764  .update_adjacency = gre_update_adj,
766 };
767 
769  .name = "mGRE",
770  .format_header = format_gre_header_with_length,
771  .unformat_header = unformat_gre_header,
772  .build_rewrite = gre_build_rewrite,
773  .update_adjacency = mgre_update_adj,
775 };
776 /* *INDENT-ON* */
777 #endif /* CLIB_MARCH_VARIANT */
778 
779 static void
781 {
783  u32 i;
784 
785  vec_add2 (gm->protocol_infos, pi, 1);
786  i = pi - gm->protocol_infos;
787 
788  pi->name = protocol_name;
789  pi->protocol = protocol;
790  pi->next_index = pi->node_index = ~0;
791 
792  hash_set (gm->protocol_info_by_protocol, protocol, i);
794 }
795 
796 static clib_error_t *
798 {
799  gre_main_t *gm = &gre_main;
800  clib_error_t *error;
801  ip_main_t *im = &ip_main;
802  ip_protocol_info_t *pi;
803 
804  clib_memset (gm, 0, sizeof (gm[0]));
805  gm->vlib_main = vm;
806  gm->vnet_main = vnet_get_main ();
807 
808  if ((error = vlib_call_init_function (vm, ip_main_init)))
809  return error;
810 
811  if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
812  return error;
813 
814  if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
815  return error;
816 
817  /* Set up the ip packet generator */
818  pi = ip_get_protocol_info (im, IP_PROTOCOL_GRE);
821 
822  gm->protocol_info_by_name = hash_create_string (0, sizeof (uword));
823  gm->protocol_info_by_protocol = hash_create (0, sizeof (uword));
824  gm->tunnel_by_key4 =
825  hash_create_mem (0, sizeof (gre_tunnel_key4_t), sizeof (uword));
826  gm->tunnel_by_key6 =
827  hash_create_mem (0, sizeof (gre_tunnel_key6_t), sizeof (uword));
828  gm->seq_num_by_key =
829  hash_create_mem (0, sizeof (gre_sn_key_t), sizeof (uword));
830 
831 #define _(n,s) add_protocol (gm, GRE_PROTOCOL_##s, #s);
833 #undef _
835 }
836 
838 
839 /*
840  * fd.io coding-style-patch-verification: ON
841  *
842  * Local Variables:
843  * eval: (c-set-style "gnu")
844  * End:
845  */
vnet_main_t * vnet_main
Definition: gre.h:286
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:509
fib_protocol_t fp_proto
protocol type
Definition: fib_types.h:212
uword * seq_num_by_key
Hash mapping tunnel src/dst addr and fib-idx to sequence number.
Definition: gre.h:273
VNET_HW_INTERFACE_CLASS(gre_hw_interface_class)
ip46_address_t src
Definition: gre.c:58
void adj_nbr_walk_nh(u32 sw_if_index, fib_protocol_t adj_nh_proto, const ip46_address_t *nh, adj_walk_cb_t cb, void *ctx)
Walk adjacencies on a link with a given next-hop.
Definition: adj_nbr.c:663
#define hash_set(h, key, value)
Definition: hash.h:255
uword * tunnel_by_key6
Hash mapping to tunnels with ipv6 src/dst addr.
Definition: gre.h:268
GRE related global data.
Definition: gre.h:243
#define CLIB_UNUSED(x)
Definition: clib.h:87
Key for a IPv6 GRE Tunnel We use a different type so that the V4 key hash is as small as possible...
Definition: gre.h:136
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:103
uword * protocol_info_by_protocol
Definition: gre.h:258
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
static vnet_hw_interface_t * vnet_get_sup_hw_interface(vnet_main_t *vnm, u32 sw_if_index)
static clib_error_t * ip4_lookup_init(vlib_main_t *vm)
Definition: ip4_forward.c:1148
u64 as_u64
Definition: bihash_doc.h:63
u32 tunnel_id
Definition: gre.c:52
unsigned long u64
Definition: types.h:89
static void gre66_fixup(vlib_main_t *vm, const ip_adjacency_t *adj, vlib_buffer_t *b0, const void *data)
Definition: gre.c:347
vnet_link_t adj_get_link_type(adj_index_t ai)
Return the link type of the adjacency.
Definition: adj.c:507
gre_protocol_t protocol
GRE protocol type in host byte order.
Definition: gre.h:76
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
char * name
Name (a c string).
Definition: gre.h:73
IP unicast adjacency.
Definition: adj.h:227
a non-broadcast multiple access interface
Definition: interface.h:390
A GRE payload protocol registration.
Definition: gre.h:70
vl_api_address_t src
Definition: gre.api:54
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:630
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:989
static adj_midchain_fixup_t gre_get_fixup(fib_protocol_t fproto, vnet_link_t lt)
return the appropriate fixup function given the overlay (link-type) and underlay (fproto) combination...
Definition: gre.c:384
static u32 format_get_indent(u8 *s)
Definition: format.h:72
#define hash_set_mem(h, key, value)
Definition: hash.h:275
const gre_tunnel_t * t
Definition: gre.h:330
vlib_main_t * vm
Definition: in2out_ed.c:1582
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
void(* adj_midchain_fixup_t)(vlib_main_t *vm, const struct ip_adjacency_t_ *adj, vlib_buffer_t *b0, const void *data)
A function type for post-rewrite fixups on midchain adjacency.
Definition: adj.h:152
static void gre44_fixup(vlib_main_t *vm, const ip_adjacency_t *adj, vlib_buffer_t *b0, const void *data)
Definition: gre.c:279
Definition: ip.h:107
#define VLIB_NODE_FN(node)
Definition: node.h:202
static uword vlib_buffer_length_in_chain(vlib_main_t *vm, vlib_buffer_t *b)
Get length in bytes of the buffer chain.
Definition: buffer_funcs.h:402
static void gre64_fixup(vlib_main_t *vm, const ip_adjacency_t *adj, vlib_buffer_t *b0, const void *data)
Definition: gre.c:297
unsigned char u8
Definition: types.h:56
static_always_inline u32 gre_encap_inline(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame, gre_tunnel_type_t type)
TX function.
Definition: gre.c:502
u8 data[128]
Definition: ipsec_types.api:89
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
u32 * tunnel_index_by_sw_if_index
Mapping from sw_if_index to tunnel index.
Definition: gre.h:278
VNET_DEVICE_CLASS(gre_device_class)
#define clib_memcpy(d, s, n)
Definition: string.h:180
vnet_hw_interface_class_t mgre_hw_interface_class
Hash key for GRE header seq number generation for ERSPAN encap.
Definition: gre.h:176
static clib_error_t * gre_input_init(vlib_main_t *vm)
Definition: node.c:540
vl_api_ip_proto_t protocol
Definition: lb_types.api:71
static ip_adjacency_t * adj_get(adj_index_t adj_index)
Get a pointer to an adjacency object from its index.
Definition: adj.h:459
u32 sw_if_index
Definition: gre.h:206
unformat_function_t * unformat_pg_edit
Definition: ip.h:88
#define static_always_inline
Definition: clib.h:108
ip4_and_gre_header_t ip4_and_gre
Definition: gre.c:32
adj_walk_rc_t mgre_mk_complete_walk(adj_index_t ai, void *data)
Definition: gre.c:429
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
static_always_inline void tunnel_encap_fixup_6o6(tunnel_encap_decap_flags_t flags, const ip6_header_t *inner, ip6_header_t *outer)
Definition: tunnel_dp.h:47
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:129
void gre_tunnel_stack(adj_index_t ai)
gre_tunnel_stack
Definition: interface.c:132
enum adj_walk_rc_t_ adj_walk_rc_t
return codes from a adjacency walker callback function
gre_encap_next_t
Definition: gre.c:491
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
static_always_inline void vlib_buffer_enqueue_to_single_next(vlib_main_t *vm, vlib_node_runtime_t *node, u32 *buffers, u16 next_index, u32 count)
Definition: buffer_node.h:459
ip6_and_gre_header_t ip6_and_gre
Definition: gre.c:41
unsigned int u32
Definition: types.h:88
adj_index_t l2_adj_index
an L2 tunnel always rquires an L2 midchain.
Definition: gre.h:214
#define vlib_call_init_function(vm, x)
Definition: init.h:270
ip46_address_t tunnel_src
The tunnel&#39;s source/local address.
Definition: gre.h:196
uword unformat_gre_header(unformat_input_t *input, va_list *args)
Definition: gre.c:165
#define VLIB_FRAME_SIZE
Definition: node.h:377
union ip_adjacency_t_::@149 sub_type
#define hash_create_string(elts, value_bytes)
Definition: hash.h:690
vl_api_fib_path_type_t type
Definition: fib_types.api:123
static_always_inline void tunnel_encap_fixup_4o6(tunnel_encap_decap_flags_t flags, const ip4_header_t *inner, ip6_header_t *outer)
Definition: tunnel_dp.h:57
#define hash_create_mem(elts, key_bytes, value_bytes)
Definition: hash.h:661
uword * tunnel_by_key4
Hash mapping to tunnels with ipv4 src/dst addr.
Definition: gre.h:263
#define ADJ_INDEX_INVALID
Invalid ADJ index - used when no adj is known likewise blazoned capitals INVALID speak volumes where ...
Definition: adj_types.h:36
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:534
A representation of a GRE tunnel.
Definition: gre.h:186
static ip_protocol_info_t * ip_get_protocol_info(ip_main_t *im, u32 protocol)
Definition: ip.h:134
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:226
#define gm
Definition: dlmalloc.c:1219
format_function_t * format_header
Definition: ip.h:79
static void grex4_fixup(vlib_main_t *vm, const ip_adjacency_t *adj, vlib_buffer_t *b0, const void *data)
Definition: gre.c:315
long ctx[MAX_CONNS]
Definition: main.c:144
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
u32 session_id
Definition: flow_types.api:131
vec_header_t h
Definition: buffer.c:322
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
u32 node_index
Node which handles this type.
Definition: gre.h:82
void gre_update_adj(vnet_main_t *vnm, u32 sw_if_index, adj_index_t ai)
Definition: gre.c:404
static void gre46_fixup(vlib_main_t *vm, const ip_adjacency_t *adj, vlib_buffer_t *b0, const void *data)
Definition: gre.c:329
#define PREDICT_FALSE(x)
Definition: clib.h:120
u8 * format_gre_tx_trace(u8 *s, va_list *args)
Definition: gre.c:66
format_function_t * format_buffer
Definition: node.h:357
u32 node_index
Node index.
Definition: node.h:487
vl_api_address_t dst
Definition: gre.api:55
enum tunnel_encap_decap_flags_t_ tunnel_encap_decap_flags_t
u16 flags_and_version
Definition: packet.h:40
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1231
uword * protocol_info_by_name
Hash tables mapping name/protocol to protocol info index.
Definition: gre.h:258
static u8 * format_gre_tunnel_name(u8 *s, va_list *args)
Definition: gre.c:700
format_function_t format_ip46_address
Definition: ip46_address.h:50
void teib_entry_adj_stack(const teib_entry_t *te, adj_index_t ai)
Definition: teib.c:74
static clib_error_t * gre_init(vlib_main_t *vm)
Definition: gre.c:797
Key for a IPv4 GRE Tunnel.
Definition: gre.h:111
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
clib_error_t * ip_main_init(vlib_main_t *vm)
Definition: ip_init.c:45
gre_tunnel_type_t type
Definition: gre.h:207
Definition: teib.c:29
u16 n_vectors
Definition: node.h:396
static u8 * format_gre_device(u8 *s, va_list *args)
Definition: gre.c:714
ip_main_t ip_main
Definition: ip_init.c:42
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
static int gre_tunnel_desc(u32 sw_if_index, ip46_address_t *src, ip46_address_t *dst, u8 *is_l2)
Definition: gre.c:724
u16 protocol
Definition: packet.h:55
void adj_nbr_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, const void *fixup_data, adj_flags_t flags, u8 *rewrite)
adj_nbr_midchain_update_rewrite
Definition: adj_midchain.c:434
gre_protocol_t
Definition: packet.h:30
static_always_inline void tunnel_encap_fixup_4o4(tunnel_encap_decap_flags_t flags, const ip4_header_t *inner, ip4_header_t *outer)
Definition: tunnel_dp.h:24
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
u8 * format_gre_header_with_length(u8 *s, va_list *args)
Definition: gre.c:95
adj_walk_rc_t mgre_mk_incomplete_walk(adj_index_t ai, void *data)
Definition: gre.c:449
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1582
void adj_midchain_delegate_unstack(adj_index_t ai)
unstack a midchain delegate (this stacks it on a drop)
#define hash_create(elts, value_bytes)
Definition: hash.h:696
#define uword_to_pointer(u, type)
Definition: types.h:136
#define ASSERT(truth)
static u8 * gre_build_rewrite(vnet_main_t *vnm, u32 sw_if_index, vnet_link_t link_type, const void *dst_address)
Definition: gre.c:212
const teib_entry_t * ne
Definition: gre.h:331
u32 next_index
Next index for this type.
Definition: gre.h:85
#define ERSPAN_HDR2
Definition: packet.h:164
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
static void grex6_fixup(vlib_main_t *vm, const ip_adjacency_t *adj, vlib_buffer_t *b0, const void *data)
Definition: gre.c:365
struct ip_adjacency_t_::@149::@150 nbr
IP_LOOKUP_NEXT_ARP/IP_LOOKUP_NEXT_REWRITE.
static int gre_proto_from_vnet_link(vnet_link_t link)
Definition: gre.c:189
gre_tunnel_t * tunnels
pool of tunnel instances
Definition: gre.h:248
uword unformat_vlib_number_by_name(unformat_input_t *input, va_list *args)
Definition: format.c:157
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:248
static uword pointer_to_uword(const void *p)
Definition: types.h:131
vnet_hw_interface_class_t gre_hw_interface_class
u32 user_instance
Definition: gre.h:231
vl_api_ip4_address_t hi
Definition: arp.api:37
#define clib_atomic_fetch_add(a, b)
Definition: atomics.h:23
enum adj_flags_t_ adj_flags_t
Flags on an IP adjacency.
void mgre_update_adj(vnet_main_t *vnm, u32 sw_if_index, adj_index_t ai)
Definition: gre.c:463
fib_protocol_t ia_nh_proto
The protocol of the neighbor/peer.
Definition: adj.h:342
Definition: defs.h:47
vnet_device_class_t gre_device_class
clib_error_t * gre_interface_admin_up_down(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: interface.c:552
ip46_address_t dst
Definition: gre.c:59
vlib_node_registration_t gre_teb_encap_node
(constructor) VLIB_REGISTER_NODE (gre_teb_encap_node)
Definition: gre.c:670
teib_entry_t * teib_entry_find(u32 sw_if_index, const ip46_address_t *peer)
Definition: teib.c:86
static_always_inline void tunnel_encap_fixup_6o4(tunnel_encap_decap_flags_t flags, const ip6_header_t *inner, ip4_header_t *outer)
Definition: tunnel_dp.h:37
static void add_protocol(gre_main_t *gm, gre_protocol_t protocol, char *protocol_name)
Definition: gre.c:780
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
uword unformat_gre_protocol_host_byte_order(unformat_input_t *input, va_list *args)
Definition: gre.c:134
#define GRE_FLAGS_SEQUENCE
Definition: packet.h:47
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: in2out_ed.c:1583
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:297
a point 2 point interface
Definition: interface.h:386
u8 * format_gre_header(u8 *s, va_list *args)
Definition: gre.c:126
unformat_function_t unformat_pg_gre_header
Definition: gre.h:354
u8 * format_gre_protocol(u8 *s, va_list *args)
Definition: gre.c:80
#define vnet_buffer(b)
Definition: buffer.h:417
vlib_node_registration_t gre_erspan_encap_node
(constructor) VLIB_REGISTER_NODE (gre_erspan_encap_node)
Definition: gre.c:683
enum gre_tunnel_type_t_ gre_tunnel_type_t
The GRE tunnel type.
fib_prefix_t tunnel_dst
The tunnel&#39;s destination/remote address.
Definition: gre.h:200
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:85
static gre_protocol_info_t * gre_get_protocol_info(gre_main_t *em, gre_protocol_t protocol)
Definition: gre.h:313
gre_protocol_info_t * protocol_infos
GRE payload protocol registrations.
Definition: gre.h:253
u32 length
Definition: gre.c:55
vlib_main_t * vlib_main
Definition: gre.h:285
void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace.c:577
bool is_ipv6
Definition: dhcp.api:202
static_always_inline void vlib_get_buffers(vlib_main_t *vm, u32 *bi, vlib_buffer_t **b, int count)
Translate array of buffer indices into buffer pointers.
Definition: buffer_funcs.h:280
static clib_error_t * ip6_lookup_init(vlib_main_t *vm)
Definition: ip6_forward.c:2785
uword unformat_gre_protocol_net_byte_order(unformat_input_t *input, va_list *args)
Definition: gre.c:154
static char * gre_error_strings[]
Definition: gre.c:649
gre_main_t gre_main
Definition: gre.c:26
tunnel_encap_decap_flags_t flags
Definition: gre.h:209
static u16 ip4_header_checksum(ip4_header_t *i)
Definition: ip4_packet.h:314
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:33
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
const fib_prefix_t * teib_entry_get_nh(const teib_entry_t *te)
Definition: teib.c:68