FD.io VPP  v17.01.1-3-gc6833f8
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 
23 
24 typedef struct {
25  union {
26  ip4_and_gre_header_t ip4_and_gre;
27  u64 as_u64[3];
28  };
30 
31 
32 /* Packet trace structure */
33 typedef struct {
34  /* Tunnel-id / index in tunnel vector */
36 
37  /* pkt length */
39 
40  /* tunnel ip4 addresses */
44 
45 u8 * format_gre_tx_trace (u8 * s, va_list * args)
46 {
47  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
48  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
49  gre_tx_trace_t * t = va_arg (*args, gre_tx_trace_t *);
50 
51  s = format (s, "GRE: tunnel %d len %d src %U dst %U",
52  t->tunnel_id, clib_net_to_host_u16 (t->length),
55  return s;
56 }
57 
58 u8 * format_gre_protocol (u8 * s, va_list * args)
59 {
60  gre_protocol_t p = va_arg (*args, u32);
61  gre_main_t * gm = &gre_main;
63 
64  if (pi)
65  s = format (s, "%s", pi->name);
66  else
67  s = format (s, "0x%04x", p);
68 
69  return s;
70 }
71 
72 u8 * format_gre_header_with_length (u8 * s, va_list * args)
73 {
74  gre_main_t * gm = &gre_main;
75  gre_header_t * h = va_arg (*args, gre_header_t *);
76  u32 max_header_bytes = va_arg (*args, u32);
77  gre_protocol_t p = clib_net_to_host_u16 (h->protocol);
78  uword indent, header_bytes;
79 
80  header_bytes = sizeof (h[0]);
81  if (max_header_bytes != 0 && header_bytes > max_header_bytes)
82  return format (s, "gre header truncated");
83 
84  indent = format_get_indent (s);
85 
86  s = format (s, "GRE %U", format_gre_protocol, p);
87 
88  if (max_header_bytes != 0 && header_bytes > max_header_bytes)
89  {
91  vlib_node_t * node = vlib_get_node (gm->vlib_main, pi->node_index);
92  if (node->format_buffer)
93  s = format (s, "\n%U%U",
94  format_white_space, indent,
95  node->format_buffer, (void *) (h + 1),
96  max_header_bytes - header_bytes);
97  }
98 
99  return s;
100 }
101 
102 u8 * format_gre_header (u8 * s, va_list * args)
103 {
104  gre_header_t * h = va_arg (*args, gre_header_t *);
105  return format (s, "%U", format_gre_header_with_length, h, 0);
106 }
107 
108 /* Returns gre protocol as an int in host byte order. */
109 uword
111  va_list * args)
112 {
113  u16 * result = va_arg (*args, u16 *);
114  gre_main_t * gm = &gre_main;
115  int i;
116 
117  /* Named type. */
119  gm->protocol_info_by_name, &i))
120  {
122  *result = pi->protocol;
123  return 1;
124  }
125 
126  return 0;
127 }
128 
129 uword
131  va_list * args)
132 {
133  u16 * result = va_arg (*args, u16 *);
135  return 0;
136  *result = clib_host_to_net_u16 ((u16) *result);
137  return 1;
138 }
139 
140 uword
141 unformat_gre_header (unformat_input_t * input, va_list * args)
142 {
143  u8 ** result = va_arg (*args, u8 **);
144  gre_header_t _h, * h = &_h;
145  u16 p;
146 
147  if (! unformat (input, "%U",
149  return 0;
150 
151  h->protocol = clib_host_to_net_u16 (p);
152 
153  /* Add header to result. */
154  {
155  void * p;
156  u32 n_bytes = sizeof (h[0]);
157 
158  vec_add2 (*result, p, n_bytes);
159  clib_memcpy (p, h, n_bytes);
160  }
161 
162  return 1;
163 }
164 
165 static int
167 {
168  switch (link)
169  {
170  case VNET_LINK_IP4:
171  return (GRE_PROTOCOL_ip4);
172  case VNET_LINK_IP6:
173  return (GRE_PROTOCOL_ip6);
174  case VNET_LINK_MPLS:
175  return (GRE_PROTOCOL_mpls_unicast);
176  case VNET_LINK_ETHERNET:
177  return (GRE_PROTOCOL_teb);
178  case VNET_LINK_ARP:
179  return (GRE_PROTOCOL_arp);
180  }
181  ASSERT(0);
182  return (GRE_PROTOCOL_ip4);
183 }
184 
185 static u8*
187  u32 sw_if_index,
188  vnet_link_t link_type,
189  const void *dst_address)
190 {
191  gre_main_t * gm = &gre_main;
192  ip4_and_gre_header_t * h;
193  u8* rewrite = NULL;
194  gre_tunnel_t *t;
195  u32 ti;
196 
197  ti = gm->tunnel_index_by_sw_if_index[sw_if_index];
198 
199  if (~0 == ti)
200  /* not one of ours */
201  return (0);
202 
203  t = pool_elt_at_index(gm->tunnels, ti);
204 
205  vec_validate(rewrite, sizeof(*h)-1);
206  h = (ip4_and_gre_header_t*)rewrite;
207  h->gre.protocol = clib_host_to_net_u16(gre_proto_from_vnet_link(link_type));
208 
209  h->ip4.ip_version_and_header_length = 0x45;
210  h->ip4.ttl = 254;
211  h->ip4.protocol = IP_PROTOCOL_GRE;
212  /* fixup ip4 header length and checksum after-the-fact */
213  h->ip4.src_address.as_u32 = t->tunnel_src.as_u32;
214  h->ip4.dst_address.as_u32 = t->tunnel_dst.as_u32;
215  h->ip4.checksum = ip4_header_checksum (&h->ip4);
216 
217  return (rewrite);
218 }
219 
220 void
222  ip_adjacency_t *adj,
223  vlib_buffer_t *b0)
224 {
225  ip4_header_t * ip0;
226 
227  ip0 = vlib_buffer_get_current (b0);
228 
229  /* Fixup the checksum and len fields in the GRE tunnel encap
230  * that was applied at the midchain node */
231  ip0->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
232  ip0->checksum = ip4_header_checksum (ip0);
233 }
234 
235 void
237  u32 sw_if_index,
238  adj_index_t ai)
239 {
242  gre_build_rewrite(vnm, sw_if_index,
243  adj_get_link_type(ai),
244  NULL));
245 
246  gre_tunnel_stack(ai);
247 }
248 
249 /**
250  * @brief TX function. Only called L2. L3 traffic uses the adj-midchains
251  */
252 static uword
254  vlib_node_runtime_t * node,
255  vlib_frame_t * frame)
256 {
257  gre_main_t * gm = &gre_main;
258  u32 next_index;
259  u32 * from, * to_next, n_left_from, n_left_to_next;
260  vnet_interface_output_runtime_t * rd = (void *) node->runtime_data;
261  const gre_tunnel_t *gt = pool_elt_at_index (gm->tunnels, rd->dev_instance);
262 
263  /* Vector of buffer / pkt indices we're supposed to process */
264  from = vlib_frame_vector_args (frame);
265 
266  /* Number of buffers / pkts */
267  n_left_from = frame->n_vectors;
268 
269  /* Speculatively send the first buffer to the last disposition we used */
270  next_index = node->cached_next_index;
271 
272  while (n_left_from > 0)
273  {
274  /* set up to enqueue to our disposition with index = next_index */
275  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
276 
277  /*
278  * FIXME DUAL LOOP
279  */
280 
281  while (n_left_from > 0 && n_left_to_next > 0)
282  {
283  vlib_buffer_t * b0;
284  u32 bi0;
285 
286  bi0 = from[0];
287  to_next[0] = bi0;
288  from += 1;
289  to_next += 1;
290  n_left_from -= 1;
291  n_left_to_next -= 1;
292 
293  b0 = vlib_get_buffer(vm, bi0);
294 
295  vnet_buffer(b0)->ip.adj_index[VLIB_TX] = gt->l2_adj_index;
296 
298  {
299  gre_tx_trace_t *tr = vlib_add_trace (vm, node,
300  b0, sizeof (*tr));
301  tr->tunnel_id = gt - gm->tunnels;
302  tr->length = vlib_buffer_length_in_chain (vm, b0);
303  tr->src.as_u32 = gt->tunnel_src.as_u32;
304  tr->dst.as_u32 = gt->tunnel_src.as_u32;
305  }
306 
307  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
308  to_next, n_left_to_next,
309  bi0, gt->l2_tx_arc);
310  }
311 
312  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
313  }
314 
316  GRE_ERROR_PKTS_ENCAP, frame->n_vectors);
317 
318  return frame->n_vectors;
319 }
320 
321 static uword
323  vlib_node_runtime_t * node,
324  vlib_frame_t * frame)
325 {
326  return (gre_interface_tx_inline (vm, node, frame));
327 }
328 
329 static uword
331  vlib_node_runtime_t * node,
332  vlib_frame_t * frame)
333 {
334  return (gre_interface_tx_inline (vm, node, frame));
335 }
336 
337 static u8 * format_gre_tunnel_name (u8 * s, va_list * args)
338 {
339  u32 dev_instance = va_arg (*args, u32);
340  return format (s, "gre%d", dev_instance);
341 }
342 
343 static u8 * format_gre_tunnel_teb_name (u8 * s, va_list * args)
344 {
345  u32 dev_instance = va_arg (*args, u32);
346  return format (s, "teb-gre%d", dev_instance);
347 }
348 
349 static u8 * format_gre_device (u8 * s, va_list * args)
350 {
351  u32 dev_instance = va_arg (*args, u32);
352  CLIB_UNUSED (int verbose) = va_arg (*args, int);
353 
354  s = format (s, "GRE tunnel: id %d\n", dev_instance);
355  return s;
356 }
357 
359  .name = "GRE tunnel device",
360  .format_device_name = format_gre_tunnel_name,
361  .format_device = format_gre_device,
362  .format_tx_trace = format_gre_tx_trace,
363  .tx_function = gre_interface_tx,
364  .admin_up_down_function = gre_interface_admin_up_down,
365 #ifdef SOON
366  .clear counter = 0;
367 #endif
368 };
369 
372 
374  .name = "GRE TEB tunnel device",
375  .format_device_name = format_gre_tunnel_teb_name,
376  .format_device = format_gre_device,
377  .format_tx_trace = format_gre_tx_trace,
378  .tx_function = gre_teb_interface_tx,
379  .admin_up_down_function = gre_interface_admin_up_down,
380 #ifdef SOON
381  .clear counter = 0;
382 #endif
383 };
384 
387 
389  .name = "GRE",
390  .format_header = format_gre_header_with_length,
391  .unformat_header = unformat_gre_header,
392  .build_rewrite = gre_build_rewrite,
393  .update_adjacency = gre_update_adj,
395 };
396 
397 static void add_protocol (gre_main_t * gm,
398  gre_protocol_t protocol,
399  char * protocol_name)
400 {
401  gre_protocol_info_t * pi;
402  u32 i;
403 
404  vec_add2 (gm->protocol_infos, pi, 1);
405  i = pi - gm->protocol_infos;
406 
407  pi->name = protocol_name;
408  pi->protocol = protocol;
409  pi->next_index = pi->node_index = ~0;
410 
411  hash_set (gm->protocol_info_by_protocol, protocol, i);
413 }
414 
416 {
417  gre_main_t * gm = &gre_main;
418  clib_error_t * error;
419  ip_main_t * im = &ip_main;
420  ip_protocol_info_t * pi;
421 
422  memset (gm, 0, sizeof (gm[0]));
423  gm->vlib_main = vm;
424  gm->vnet_main = vnet_get_main();
425 
426  if ((error = vlib_call_init_function (vm, ip_main_init)))
427  return error;
428 
429  if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
430  return error;
431 
432  /* Set up the ip packet generator */
433  pi = ip_get_protocol_info (im, IP_PROTOCOL_GRE);
436 
437  gm->protocol_info_by_name = hash_create_string (0, sizeof (uword));
438  gm->protocol_info_by_protocol = hash_create (0, sizeof (uword));
439  gm->tunnel_by_key = hash_create (0, sizeof (uword));
440 
441 #define _(n,s) add_protocol (gm, GRE_PROTOCOL_##s, #s);
443 #undef _
444 
446 }
447 
449 
451 {
453  return &gre_main;
454 }
455 
vnet_main_t * vnet_main
Definition: gre.h:164
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:396
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_vectors_left)
Release pointer to next frame vector data.
Definition: main.c:459
ip4_address_t src
Definition: gre.c:41
static uword gre_interface_tx(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: gre.c:322
#define hash_set(h, key, value)
Definition: hash.h:254
GRE related global data.
Definition: gre.h:130
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:343
#define CLIB_UNUSED(x)
Definition: clib.h:79
uword unformat(unformat_input_t *i, char *fmt,...)
Definition: unformat.c:966
ip4_address_t dst
Definition: gre.c:42
u8 runtime_data[0]
Definition: node.h:469
uword * protocol_info_by_protocol
Definition: gre.h:144
#define VNET_HW_INTERFACE_CLASS(x,...)
Definition: interface.h:356
u64 as_u64
Definition: bihash_doc.h:63
uword * tunnel_by_key
Hash mapping src/dst addr pair to tunnel.
Definition: gre.h:148
u32 tunnel_id
Definition: gre.c:35
static u8 * format_gre_tunnel_teb_name(u8 *s, va_list *args)
Definition: gre.c:343
vnet_link_t adj_get_link_type(adj_index_t ai)
Return the link type of the adjacency.
Definition: adj.c:262
#define NULL
Definition: clib.h:55
gre_protocol_t protocol
GRE protocol type in host byte order.
Definition: gre.h:47
char * name
Name (a c string).
Definition: gre.h:44
IP unicast adjacency.
Definition: lookup.h:188
A GRE payload protocol registration.
Definition: gre.h:42
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:521
#define hash_set_mem(h, key, value)
Definition: hash.h:274
Definition: ip.h:106
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:100
format_function_t format_ip4_address
Definition: format.h:79
u32 * tunnel_index_by_sw_if_index
Mapping from sw_if_index to tunnel index.
Definition: gre.h:160
VNET_DEVICE_CLASS(gre_device_class)
void adj_nbr_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, adj_midchain_flag_t flags, u8 *rewrite)
adj_nbr_midchain_update_rewrite
Definition: adj_midchain.c:375
ip4_address_t tunnel_dst
The tunnel&#39;s destination/remote address.
Definition: gre.h:94
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
unformat_function_t * unformat_pg_edit
Definition: ip.h:87
ip4_and_gre_header_t ip4_and_gre
Definition: gre.c:26
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
IPv4 and GRE header union.
Definition: gre.c:24
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:194
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:113
void gre_tunnel_stack(adj_index_t ai)
gre_tunnel_stack
Definition: interface.c:118
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
unsigned long u64
Definition: types.h:89
static uword gre_interface_tx_inline(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
TX function.
Definition: gre.c:253
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:977
#define vlib_call_init_function(vm, x)
Definition: init.h:161
uword unformat_gre_header(unformat_input_t *input, va_list *args)
Definition: gre.c:141
#define hash_create_string(elts, value_bytes)
Definition: hash.h:652
void gre_fixup(vlib_main_t *vm, ip_adjacency_t *adj, vlib_buffer_t *b0)
Definition: gre.c:221
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:369
A representation of a GRE tunnel.
Definition: gre.h:81
static uword format_get_indent(u8 *s)
Definition: format.h:72
static ip_protocol_info_t * ip_get_protocol_info(ip_main_t *im, u32 protocol)
Definition: ip.h:133
format_function_t * format_header
Definition: ip.h:78
u32 node_index
Node which handles this type.
Definition: gre.h:50
void gre_update_adj(vnet_main_t *vnm, u32 sw_if_index, adj_index_t ai)
Definition: gre.c:236
vnet_device_class_t gre_device_teb_class
#define PREDICT_FALSE(x)
Definition: clib.h:97
format_function_t * format_buffer
Definition: node.h:311
#define vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, bi0, next0)
Finish enqueueing one buffer forward in the graph.
Definition: buffer_node.h:216
#define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)
Get pointer to next frame vector data by (vlib_node_runtime_t, next_index).
Definition: node_funcs.h:350
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1113
uword * protocol_info_by_name
Hash tables mapping name/protocol to protocol info index.
Definition: gre.h:144
static u8 * format_gre_tunnel_name(u8 *s, va_list *args)
Definition: gre.c:337
static clib_error_t * gre_init(vlib_main_t *vm)
Definition: gre.c:415
gre_main_t * gre_get_main(vlib_main_t *vm)
Definition: gre.c:450
clib_error_t * ip_main_init(vlib_main_t *vm)
Definition: ip_init.c:45
u16 n_vectors
Definition: node.h:344
static u8 * format_gre_device(u8 *s, va_list *args)
Definition: gre.c:349
ip_main_t ip_main
Definition: ip_init.c:42
u16 protocol
Definition: packet.h:52
gre_protocol_t
Definition: packet.h:29
#define clib_memcpy(a, b, c)
Definition: string.h:69
ip4_address_t tunnel_src
The tunnel&#39;s source/local address.
Definition: gre.h:90
uword unformat_vlib_number_by_name(unformat_input_t *input, va_list *args)
Definition: format.c:157
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:72
static clib_error_t * gre_input_init(vlib_main_t *vm)
Definition: node.c:484
u8 * format_gre_tx_trace(u8 *s, va_list *args)
Definition: gre.c:45
#define hash_create(elts, value_bytes)
Definition: hash.h:658
u16 cached_next_index
Definition: node.h:463
#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:186
unsigned int u32
Definition: types.h:88
#define vnet_buffer(b)
Definition: buffer.h:361
u32 next_index
Next index for this type.
Definition: gre.h:53
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
static int gre_proto_from_vnet_link(vnet_link_t link)
Definition: gre.c:166
gre_tunnel_t * tunnels
pool of tunnel instances
Definition: gre.h:134
clib_error_t * ip4_lookup_init(vlib_main_t *vm)
Definition: ip4_forward.c:1102
vnet_hw_interface_class_t gre_hw_interface_class
#define VLIB_BUFFER_IS_TRACED
Definition: buffer.h:95
vlib_node_registration_t gre_input_node
(constructor) VLIB_REGISTER_NODE (gre_input_node)
Definition: node.c:419
u64 uword
Definition: types.h:112
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:55
Definition: defs.h:47
vnet_device_class_t gre_device_class
VLIB_DEVICE_TX_FUNCTION_MULTIARCH(gre_device_class, gre_interface_tx)
Definition: gre.c:370
clib_error_t * gre_interface_admin_up_down(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: interface.c:449
unsigned short u16
Definition: types.h:57
static void add_protocol(gre_main_t *gm, gre_protocol_t protocol, char *protocol_name)
Definition: gre.c:397
unsigned char u8
Definition: types.h:56
uword unformat_gre_protocol_host_byte_order(unformat_input_t *input, va_list *args)
Definition: gre.c:110
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:253
a point 2 point interface
Definition: interface.h:272
u8 * format_gre_header(u8 *s, va_list *args)
Definition: gre.c:102
unformat_function_t unformat_pg_gre_header
Definition: gre.h:214
u8 * format_gre_protocol(u8 *s, va_list *args)
Definition: gre.c:58
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:418
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:58
static uword gre_teb_interface_tx(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: gre.c:330
static gre_protocol_info_t * gre_get_protocol_info(gre_main_t *em, gre_protocol_t protocol)
Definition: gre.h:176
gre_protocol_info_t * protocol_infos
GRE payload protocol registrations.
Definition: gre.h:139
u32 length
Definition: gre.c:38
vlib_main_t * vlib_main
Definition: gre.h:163
struct _unformat_input_t unformat_input_t
uword unformat_gre_protocol_net_byte_order(unformat_input_t *input, va_list *args)
Definition: gre.c:130
u32 flags
buffer flags: VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:85
gre_main_t gre_main
Definition: gre.c:22
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57
static u16 ip4_header_checksum(ip4_header_t *i)
Definition: ip4_packet.h:238