FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
node.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 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 /**
16  * @file
17  * @brief L2-GRE over IPSec packet processing.
18  *
19  * Removes GRE header from the packet and sends it to the l2-input node.
20 */
21 
22 #include <vlib/vlib.h>
23 #include <vnet/pg/pg.h>
25 #include <vppinfra/sparse_vec.h>
26 
27 #define foreach_ipsec_gre_input_next \
28 _(PUNT, "error-punt") \
29 _(DROP, "error-drop") \
30 _(L2_INPUT, "l2-input")
31 
32 typedef enum {
33 #define _(s,n) IPSEC_GRE_INPUT_NEXT_##s,
35 #undef _
38 
39 typedef struct {
45 
46 static u8 * format_ipsec_gre_rx_trace (u8 * s, va_list * args)
47 {
48  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
49  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
50  ipsec_gre_rx_trace_t * t = va_arg (*args, ipsec_gre_rx_trace_t *);
51 
52  s = format (s, "GRE: tunnel %d len %d src %U dst %U",
53  t->tunnel_id, clib_net_to_host_u16(t->length),
56  return s;
57 }
58 
59 /**
60  * @brief L2-GRE over IPSec input node.
61  * @node ipsec-gre-input
62  *
63  * This node remove GRE header.
64  *
65  * @param vm vlib_main_t corresponding to the current thread.
66  * @param node vlib_node_runtime_t data for this node.
67  * @param from_frame vlib_frame_t whose contents should be dispatched.
68  *
69  * @par Graph mechanics: buffer metadata, next index usage
70  *
71  * <em>Uses:</em>
72  * - <code>ip->src_address</code> and <code>ip->dst_address</code>
73  * - Match tunnel by source and destination addresses in GRE IP header.
74  *
75  * <em>Sets:</em>
76  * - <code>vnet_buffer(b)->gre.src</code>
77  * - Save tunnel source IPv4 address.
78  * - <code>vnet_buffer(b)->gre.dst</code>
79  * - Save tunnel destination IPv4 address.
80  * - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
81  * - Set input sw_if_index to IPSec-GRE tunnel for learning.
82  *
83  * <em>Next Index:</em>
84  * - Dispatches the packet to the l2-input node.
85 */
87  vlib_node_runtime_t * node,
88  vlib_frame_t * from_frame)
89 {
91  u32 n_left_from, next_index, * from, * to_next;
92  u64 cached_tunnel_key = (u64) ~0;
93  u32 cached_tunnel_sw_if_index = 0, tunnel_sw_if_index;
94  u32 tun_src0, tun_dst0;
95  u32 tun_src1, tun_dst1;
96 
97  from = vlib_frame_vector_args (from_frame);
98  n_left_from = from_frame->n_vectors;
99 
100  next_index = node->cached_next_index;
101 
102  while (n_left_from > 0)
103  {
104  u32 n_left_to_next;
105 
106  vlib_get_next_frame (vm, node, next_index,
107  to_next, n_left_to_next);
108 
109  while (n_left_from >= 4 && n_left_to_next >= 2)
110  {
111  u32 bi0, bi1;
112  vlib_buffer_t * b0, * b1;
113  gre_header_t * h0, * h1;
114  u16 version0, version1, protocol0, protocol1;
115  int verr0, verr1;
116  u32 next0, next1;
117  ip4_header_t *ip0, *ip1;
118 
119  /* Prefetch next iteration. */
120  {
121  vlib_buffer_t * p2, * p3;
122 
123  p2 = vlib_get_buffer (vm, from[2]);
124  p3 = vlib_get_buffer (vm, from[3]);
125 
126  vlib_prefetch_buffer_header (p2, LOAD);
127  vlib_prefetch_buffer_header (p3, LOAD);
128 
129  CLIB_PREFETCH (p2->data, sizeof (h0[0]), LOAD);
130  CLIB_PREFETCH (p3->data, sizeof (h1[0]), LOAD);
131  }
132 
133  bi0 = from[0];
134  bi1 = from[1];
135  to_next[0] = bi0;
136  to_next[1] = bi1;
137  from += 2;
138  to_next += 2;
139  n_left_to_next -= 2;
140  n_left_from -= 2;
141 
142  b0 = vlib_get_buffer (vm, bi0);
143  b1 = vlib_get_buffer (vm, bi1);
144 
145  /* ip4_local hands us the ip header, not the gre header */
146  ip0 = vlib_buffer_get_current (b0);
147  ip1 = vlib_buffer_get_current (b1);
148 
149  /* Save src + dst ip4 address */
150  tun_src0 = ip0->src_address.as_u32;
151  tun_dst0 = ip0->dst_address.as_u32;
152  tun_src1 = ip1->src_address.as_u32;
153  tun_dst1 = ip1->dst_address.as_u32;
154 
155  vlib_buffer_advance (b0, sizeof (*ip0));
156  vlib_buffer_advance (b1, sizeof (*ip1));
157 
158  h0 = vlib_buffer_get_current (b0);
159  h1 = vlib_buffer_get_current (b1);
160 
161  protocol0 = clib_net_to_host_u16 (h0->protocol);
162  protocol1 = clib_net_to_host_u16 (h1->protocol);
163  if (PREDICT_TRUE(protocol0 == GRE_PROTOCOL_teb))
164  {
165  next0 = IPSEC_GRE_INPUT_NEXT_L2_INPUT;
166  b0->error = node->errors[IPSEC_GRE_ERROR_NONE];
167  }
168  else
169  {
170  b0->error = node->errors[IPSEC_GRE_ERROR_UNKNOWN_PROTOCOL];
171  next0 = IPSEC_GRE_INPUT_NEXT_DROP;
172  }
173  if (PREDICT_TRUE(protocol1 == GRE_PROTOCOL_teb))
174  {
175  next1 = IPSEC_GRE_INPUT_NEXT_L2_INPUT;
176  b1->error = node->errors[IPSEC_GRE_ERROR_NONE];
177  }
178  else
179  {
180  b1->error = node->errors[IPSEC_GRE_ERROR_UNKNOWN_PROTOCOL];
181  next1 = IPSEC_GRE_INPUT_NEXT_DROP;
182  }
183 
184  version0 = clib_net_to_host_u16 (h0->flags_and_version);
185  verr0 = version0 & GRE_VERSION_MASK;
186  version1 = clib_net_to_host_u16 (h1->flags_and_version);
187  verr1 = version1 & GRE_VERSION_MASK;
188 
189  b0->error = verr0 ? node->errors[IPSEC_GRE_ERROR_UNSUPPORTED_VERSION]
190  : b0->error;
191  next0 = verr0 ? IPSEC_GRE_INPUT_NEXT_DROP : next0;
192  b1->error = verr1 ? node->errors[IPSEC_GRE_ERROR_UNSUPPORTED_VERSION]
193  : b1->error;
194  next1 = verr1 ? IPSEC_GRE_INPUT_NEXT_DROP : next1;
195 
196  /* For L2 payload set input sw_if_index to GRE tunnel for learning */
197  if (PREDICT_TRUE(next0 == IPSEC_GRE_INPUT_NEXT_L2_INPUT))
198  {
199  u64 key = ((u64)(tun_dst0) << 32) | (u64)(tun_src0);
200 
201  if (cached_tunnel_key != key)
202  {
204  ipsec_gre_tunnel_t * t;
205  uword * p;
206 
207  p = hash_get (igm->tunnel_by_key, key);
208  if (!p)
209  {
210  next0 = IPSEC_GRE_INPUT_NEXT_DROP;
211  b0->error = node->errors[IPSEC_GRE_ERROR_NO_SUCH_TUNNEL];
212  goto drop0;
213  }
214  t = pool_elt_at_index (igm->tunnels, p[0]);
215  hi = vnet_get_hw_interface (igm->vnet_main,
216  t->hw_if_index);
217  tunnel_sw_if_index = hi->sw_if_index;
218  cached_tunnel_sw_if_index = tunnel_sw_if_index;
219  }
220  else
221  {
222  tunnel_sw_if_index = cached_tunnel_sw_if_index;
223  }
224  vnet_buffer(b0)->sw_if_index[VLIB_RX] = tunnel_sw_if_index;
225  }
226 
227 drop0:
228  /* For L2 payload set input sw_if_index to GRE tunnel for learning */
229  if (PREDICT_TRUE(next1 == IPSEC_GRE_INPUT_NEXT_L2_INPUT))
230  {
231  u64 key = ((u64)(tun_dst1) << 32) | (u64)(tun_src1);
232 
233  if (cached_tunnel_key != key)
234  {
236  ipsec_gre_tunnel_t * t;
237  uword * p;
238 
239  p = hash_get (igm->tunnel_by_key, key);
240  if (!p)
241  {
242  next1 = IPSEC_GRE_INPUT_NEXT_DROP;
243  b1->error = node->errors[IPSEC_GRE_ERROR_NO_SUCH_TUNNEL];
244  goto drop1;
245  }
246  t = pool_elt_at_index (igm->tunnels, p[0]);
247  hi = vnet_get_hw_interface (igm->vnet_main,
248  t->hw_if_index);
249  tunnel_sw_if_index = hi->sw_if_index;
250  cached_tunnel_sw_if_index = tunnel_sw_if_index;
251  }
252  else
253  {
254  tunnel_sw_if_index = cached_tunnel_sw_if_index;
255  }
256  vnet_buffer(b1)->sw_if_index[VLIB_RX] = tunnel_sw_if_index;
257  }
258 
259 drop1:
260  if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
261  {
262  ipsec_gre_rx_trace_t *tr = vlib_add_trace (vm, node,
263  b0, sizeof (*tr));
264  tr->tunnel_id = ~0;
265  tr->length = ip0->length;
266  tr->src.as_u32 = ip0->src_address.as_u32;
267  tr->dst.as_u32 = ip0->dst_address.as_u32;
268  }
269 
270  if (PREDICT_FALSE(b1->flags & VLIB_BUFFER_IS_TRACED))
271  {
272  ipsec_gre_rx_trace_t *tr = vlib_add_trace (vm, node,
273  b1, sizeof (*tr));
274  tr->tunnel_id = ~0;
275  tr->length = ip1->length;
276  tr->src.as_u32 = ip1->src_address.as_u32;
277  tr->dst.as_u32 = ip1->dst_address.as_u32;
278  }
279 
280  vlib_buffer_advance (b0, sizeof (*h0));
281  vlib_buffer_advance (b1, sizeof (*h1));
282 
283  vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
284  to_next, n_left_to_next,
285  bi0, bi1, next0, next1);
286  }
287 
288  while (n_left_from > 0 && n_left_to_next > 0)
289  {
290  u32 bi0;
291  vlib_buffer_t * b0;
292  gre_header_t * h0;
293  ip4_header_t * ip0;
294  u16 version0, protocol0;
295  int verr0;
296  u32 next0;
297  u32 tun_src0, tun_dst0;
298 
299  bi0 = from[0];
300  to_next[0] = bi0;
301  from += 1;
302  to_next += 1;
303  n_left_from -= 1;
304  n_left_to_next -= 1;
305 
306  b0 = vlib_get_buffer (vm, bi0);
307  ip0 = vlib_buffer_get_current (b0);
308 
309  tun_src0 = ip0->src_address.as_u32;
310  tun_dst0 = ip0->dst_address.as_u32;
311 
312  vlib_buffer_advance (b0, sizeof (*ip0));
313 
314  h0 = vlib_buffer_get_current (b0);
315 
316  protocol0 = clib_net_to_host_u16 (h0->protocol);
317  if (PREDICT_TRUE(protocol0 == GRE_PROTOCOL_teb))
318  {
319  next0 = IPSEC_GRE_INPUT_NEXT_L2_INPUT;
320  b0->error = node->errors[IPSEC_GRE_ERROR_NONE];
321  }
322  else
323  {
324  b0->error = node->errors[IPSEC_GRE_ERROR_UNKNOWN_PROTOCOL];
325  next0 = IPSEC_GRE_INPUT_NEXT_DROP;
326  }
327 
328  version0 = clib_net_to_host_u16 (h0->flags_and_version);
329  verr0 = version0 & GRE_VERSION_MASK;
330  b0->error = verr0 ? node->errors[IPSEC_GRE_ERROR_UNSUPPORTED_VERSION]
331  : b0->error;
332  next0 = verr0 ? IPSEC_GRE_INPUT_NEXT_DROP : next0;
333 
334  /* For L2 payload set input sw_if_index to GRE tunnel for learning */
335  if (PREDICT_TRUE(next0 == IPSEC_GRE_INPUT_NEXT_L2_INPUT))
336  {
337  u64 key = ((u64)(tun_dst0) << 32) | (u64)(tun_src0);
338 
339  if (cached_tunnel_key != key)
340  {
342  ipsec_gre_tunnel_t * t;
343  uword * p;
344 
345  p = hash_get (igm->tunnel_by_key, key);
346  if (!p)
347  {
348  next0 = IPSEC_GRE_INPUT_NEXT_DROP;
349  b0->error = node->errors[IPSEC_GRE_ERROR_NO_SUCH_TUNNEL];
350  goto drop;
351  }
352  t = pool_elt_at_index (igm->tunnels, p[0]);
353  hi = vnet_get_hw_interface (igm->vnet_main,
354  t->hw_if_index);
355  tunnel_sw_if_index = hi->sw_if_index;
356  cached_tunnel_sw_if_index = tunnel_sw_if_index;
357  }
358  else
359  {
360  tunnel_sw_if_index = cached_tunnel_sw_if_index;
361  }
362  vnet_buffer(b0)->sw_if_index[VLIB_RX] = tunnel_sw_if_index;
363  }
364 
365 drop:
366  if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
367  {
368  ipsec_gre_rx_trace_t *tr = vlib_add_trace (vm, node,
369  b0, sizeof (*tr));
370  tr->tunnel_id = ~0;
371  tr->length = ip0->length;
372  tr->src.as_u32 = ip0->src_address.as_u32;
373  tr->dst.as_u32 = ip0->dst_address.as_u32;
374  }
375 
376  vlib_buffer_advance (b0, sizeof (*h0));
377 
378  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
379  to_next, n_left_to_next,
380  bi0, next0);
381  }
382 
383  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
384  }
386  IPSEC_GRE_ERROR_PKTS_DECAP, from_frame->n_vectors);
387  return from_frame->n_vectors;
388 }
389 
390 static char * ipsec_gre_error_strings[] = {
391 #define ipsec_gre_error(n,s) s,
392 #include "error.def"
393 #undef ipsec_gre_error
394 };
395 
397  .name = "ipsec-gre-input",
398  /* Takes a vector of packets. */
399  .vector_size = sizeof (u32),
400 
401  .n_errors = IPSEC_GRE_N_ERROR,
402  .error_strings = ipsec_gre_error_strings,
403 
404  .n_next_nodes = IPSEC_GRE_INPUT_N_NEXT,
405  .next_nodes = {
406 #define _(s,n) [IPSEC_GRE_INPUT_NEXT_##s] = n,
408 #undef _
409  },
410 
411  .format_trace = format_ipsec_gre_rx_trace,
412 };
413 
415 {
416  {
417  clib_error_t * error;
419  if (error)
420  clib_error_report (error);
421  }
422 
423  return 0;
424 }
425 
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:124
vmrglw vmrglh hi
#define CLIB_UNUSED(x)
Definition: clib.h:82
vlib_node_registration_t ipsec_gre_input_node
(constructor) VLIB_REGISTER_NODE (ipsec_gre_input_node)
Definition: node.c:396
ip4_address_t src_address
Definition: ip4_packet.h:170
L2-GRE over IPSec packet processing.
#define PREDICT_TRUE(x)
Definition: clib.h:112
unsigned long u64
Definition: types.h:89
static vnet_hw_interface_t * vnet_get_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
u8 data[0]
Packet data.
Definition: buffer.h:181
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
#define VLIB_NODE_FN(node)
Definition: node.h:201
static clib_error_t * ipsec_gre_init(vlib_main_t *vm)
Definition: ipsec_gre.c:366
unsigned char u8
Definition: types.h:56
ipsec_gre_tunnel_t * tunnels
pool of tunnel instances
Definition: ipsec_gre.h:72
format_function_t format_ip4_address
Definition: format.h:75
#define foreach_ipsec_gre_input_next
Definition: node.c:27
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:163
ip4_address_t dst_address
Definition: ip4_packet.h:170
ipsec_gre_main_t ipsec_gre_main
Definition: ipsec_gre.c:28
#define vlib_prefetch_buffer_header(b, type)
Prefetch buffer metadata.
Definition: buffer.h:203
#define GRE_VERSION_MASK
Definition: packet.h:52
unsigned int u32
Definition: types.h:88
#define vlib_call_init_function(vm, x)
Definition: init.h:260
ip4_address_t src
Definition: node.c:42
vlib_error_t error
Error code for buffers to be enqueued to error handler.
Definition: buffer.h:136
uword * tunnel_by_key
hash mapping src/dst addr pair to tunnel
Definition: ipsec_gre.h:74
#define hash_get(h, key)
Definition: hash.h:249
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
static clib_error_t * ipsec_gre_input_init(vlib_main_t *vm)
Definition: node.c:414
unsigned short u16
Definition: types.h:57
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
ip4_address_t dst
Definition: node.c:43
static u8 * format_ipsec_gre_rx_trace(u8 *s, va_list *args)
Definition: node.c:46
#define PREDICT_FALSE(x)
Definition: clib.h:111
#define vlib_validate_buffer_enqueue_x2(vm, node, next_index, to_next, n_left_to_next, bi0, bi1, next0, next1)
Finish enqueueing two buffers forward in the graph.
Definition: buffer_node.h:70
#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:218
#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:338
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:1150
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
L2-GRE over IPSec errors.
#define CLIB_PREFETCH(addr, size, type)
Definition: cache.h:80
vlib_main_t * vm
Definition: buffer.c:312
u16 protocol
Definition: packet.h:55
IPSec-GRE state.
Definition: ipsec_gre.h:70
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:458
IPSec-GRE tunnel parameters.
Definition: ipsec_gre.h:52
static char * ipsec_gre_error_strings[]
Definition: node.c:390
#define clib_error_report(e)
Definition: error.h:113
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:248
vnet_main_t * vnet_main
convenience
Definition: ipsec_gre.h:82
ipsec_gre_input_next_t
Definition: node.c:32
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:57
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:244
typedef key
Definition: ipsec.api:244
#define vnet_buffer(b)
Definition: buffer.h:369
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
Definition: defs.h:46