FD.io VPP  v19.04.2-12-g66b1689
Vector Packet Processing
interface.c
Go to the documentation of this file.
1 /*
2  * gre_interface.c: gre interfaces
3  *
4  * Copyright (c) 2016 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  * @file
19  * @brief L2-GRE over IPSec tunnel interface.
20  *
21  * Creates ipsec-gre tunnel interface.
22  * Provides a command line interface so humans can interact with VPP.
23  */
24 
25 #include <vnet/vnet.h>
26 #include <vnet/pg/pg.h>
28 #include <vnet/ip/format.h>
29 #include <vnet/ipsec/ipsec.h>
30 #include <vnet/l2/l2_input.h>
31 
32 #include <vnet/ipsec/esp.h>
33 
34 u8 *
35 format_ipsec_gre_tunnel (u8 * s, va_list * args)
36 {
37  ipsec_gre_tunnel_t *t = va_arg (*args, ipsec_gre_tunnel_t *);
39 
40  s = format (s,
41  "[%d] %U (src) %U (dst) local-sa %d remote-sa %d",
42  t - gm->tunnels,
45  t->local_sa_id, t->remote_sa_id);
46  return s;
47 }
48 
49 static clib_error_t *
51  unformat_input_t * input,
52  vlib_cli_command_t * cmd)
53 {
56 
57  if (pool_elts (igm->tunnels) == 0)
58  vlib_cli_output (vm, "No IPSec GRE tunnels configured...");
59 
60  /* *INDENT-OFF* */
61  pool_foreach (t, igm->tunnels,
62  ({
63  vlib_cli_output (vm, "%U", format_ipsec_gre_tunnel, t);
64  }));
65  /* *INDENT-ON* */
66 
67  return 0;
68 }
69 
70 /* *INDENT-OFF* */
71 VLIB_CLI_COMMAND (show_ipsec_gre_tunnel_command, static) = {
72  .path = "show ipsec gre tunnel",
74 };
75 /* *INDENT-ON* */
76 
77 /* force inclusion from application's main.c */
80 {
81  return 0;
82 }
83 
85 
86 /**
87  * @brief Add or delete ipsec-gre tunnel interface.
88  *
89  * @param *a vnet_ipsec_gre_tunnel_add_del_args_t - tunnel interface parameters
90  * @param *sw_if_indexp u32 - software interface index
91  * @return int - 0 if success otherwise <code>VNET_API_ERROR_</code>
92  */
93 int
95  u32 * sw_if_indexp)
96 {
98  vnet_main_t *vnm = igm->vnet_main;
99  ipsec_main_t *im = &ipsec_main;
102  u32 hw_if_index, sw_if_index;
103  u32 slot;
104  uword *p;
105  u64 key;
106 
107  key = (u64) a->src.as_u32 << 32 | (u64) a->dst.as_u32;
108  p = hash_get (igm->tunnel_by_key, key);
109 
110  if (a->is_add)
111  {
112  /* check if same src/dst pair exists */
113  if (p)
114  return VNET_API_ERROR_INVALID_VALUE;
115 
117  clib_memset (t, 0, sizeof (*t));
118 
120  {
122 
123  hw_if_index = igm->free_ipsec_gre_tunnel_hw_if_indices
125  _vec_len (igm->free_ipsec_gre_tunnel_hw_if_indices) -= 1;
126 
127  hi = vnet_get_hw_interface (vnm, hw_if_index);
128  hi->dev_instance = t - igm->tunnels;
129  hi->hw_instance = hi->dev_instance;
130 
131  /* clear old stats of freed tunnel before reuse */
132  sw_if_index = hi->sw_if_index;
136  sw_if_index);
139  sw_if_index);
141  (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
143  }
144  else
145  {
146  hw_if_index = vnet_register_interface
147  (vnm, ipsec_gre_device_class.index, t - igm->tunnels,
148  ipsec_gre_hw_interface_class.index, t - igm->tunnels);
149  hi = vnet_get_hw_interface (vnm, hw_if_index);
150  sw_if_index = hi->sw_if_index;
151  }
152 
153  t->hw_if_index = hw_if_index;
155  t->local_sa_id = a->local_sa_id;
156  t->remote_sa_id = a->remote_sa_id;
159 
160  ip4_sw_interface_enable_disable (sw_if_index, 1);
161 
163  sw_if_index, ~0);
165 
166  hi->min_packet_bytes = 64 + sizeof (gre_header_t) +
167  sizeof (ip4_header_t) + sizeof (esp_header_t) + sizeof (esp_footer_t);
168 
169  /* Standard default gre MTU. */
170  /* TODO: Should take tunnel overhead into consideration */
171  vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
172 
173  clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
174  clib_memcpy (&t->tunnel_dst, &a->dst, sizeof (t->tunnel_dst));
175 
176  hash_set (igm->tunnel_by_key, key, t - igm->tunnels);
177 
181 
183  }
184  else
185  { /* !is_add => delete */
186  /* tunnel needs to exist */
187  if (!p)
188  return VNET_API_ERROR_NO_SUCH_ENTRY;
189 
190  t = pool_elt_at_index (igm->tunnels, p[0]);
191 
192  sw_if_index = t->sw_if_index;
193  ip4_sw_interface_enable_disable (sw_if_index, 0);
194  vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
195  /* make sure tunnel is removed from l2 bd or xconnect */
196  set_int_l2_mode (igm->vlib_main, vnm, MODE_L3, sw_if_index, 0,
197  L2_BD_PORT_TYPE_NORMAL, 0, 0);
200 
201  hash_unset (igm->tunnel_by_key, key);
202  pool_put (igm->tunnels, t);
203  }
204 
205  if (sw_if_indexp)
206  *sw_if_indexp = sw_if_index;
207 
208  return ipsec_add_del_ipsec_gre_tunnel (vnm, a);
209 }
210 
211 static clib_error_t *
213  unformat_input_t * input,
214  vlib_cli_command_t * cmd)
215 {
216  unformat_input_t _line_input, *line_input = &_line_input;
217  u32 num_m_args = 0;
219  int rv;
221  clib_error_t *error = NULL;
222 
223  clib_memset (a, 0, sizeof (*a));
224  a->is_add = 1;
225 
226  /* Get a line of input. */
227  if (!unformat_user (input, unformat_line_input, line_input))
228  return 0;
229 
230  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
231  {
232  if (unformat (line_input, "del"))
233  a->is_add = 0;
234  else if (unformat (line_input, "src %U", unformat_ip4_address, &a->src))
235  num_m_args++;
236  else if (unformat (line_input, "dst %U", unformat_ip4_address, &a->dst))
237  num_m_args++;
238  else if (unformat (line_input, "local-sa %d", &a->local_sa_id))
239  num_m_args++;
240  else if (unformat (line_input, "remote-sa %d", &a->remote_sa_id))
241  num_m_args++;
242  else
243  {
244  error = clib_error_return (0, "unknown input `%U'",
245  format_unformat_error, line_input);
246  goto done;
247  }
248  }
249 
250  if (num_m_args < 4)
251  {
252  error = clib_error_return (0, "mandatory argument(s) missing");
253  goto done;
254  }
255 
256  if (memcmp (&a->src, &a->dst, sizeof (a->src)) == 0)
257  {
258  error = clib_error_return (0, "src and dst are identical");
259  goto done;
260  }
261 
262  rv = vnet_ipsec_gre_tunnel_add_del (a, &sw_if_index);
263 
264  switch (rv)
265  {
266  case 0:
268  vnet_get_main (), sw_if_index);
269  break;
270  case VNET_API_ERROR_INVALID_VALUE:
271  error = clib_error_return (0, "GRE tunnel already exists...");
272  goto done;
273  default:
274  error = clib_error_return (0,
275  "vnet_ipsec_gre_tunnel_add_del returned %d",
276  rv);
277  goto done;
278  }
279 
280 done:
281  unformat_free (line_input);
282 
283  return error;
284 }
285 
286 /* *INDENT-OFF* */
287 VLIB_CLI_COMMAND (create_ipsec_gre_tunnel_command, static) = {
288  .path = "create ipsec gre tunnel",
289  .short_help = "create ipsec gre tunnel src <addr> dst <addr> "
290  "local-sa <id> remote-sa <id> [del]",
292 };
293 /* *INDENT-ON* */
294 
295 /*
296 * fd.io coding-style-patch-verification: ON
297 *
298 * Local Variables:
299 * eval: (c-set-style "gnu")
300 * End:
301 */
u32 sw_if_index
Definition: ipsec_gre.api:37
vmrglw vmrglh hi
#define hash_set(h, key, value)
Definition: hash.h:255
ip4_address_t tunnel_dst
tunnel IPv4 dst address
Definition: ipsec_gre.h:57
#define hash_unset(h, key)
Definition: hash.h:261
a
Definition: bitmap.h:538
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
u32 remote_sa
remote IPSec SA index
Definition: ipsec_gre.h:59
L2-GRE over IPSec packet processing.
vnet_interface_main_t interface_main
Definition: vnet.h:56
unsigned long u64
Definition: types.h:89
#define NULL
Definition: clib.h:58
static vnet_hw_interface_t * vnet_get_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:522
static clib_error_t * show_ipsec_gre_tunnel_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: interface.c:50
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
clib_memset(h->entries, 0, sizeof(h->entries[0])*entries)
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
u8 * format_ipsec_gre_tunnel(u8 *s, va_list *args)
Definition: interface.c:35
int vnet_ipsec_gre_tunnel_add_del(const ipsec_gre_tunnel_add_del_args_t *a, u32 *sw_if_indexp)
Add or delete ipsec-gre tunnel interface.
Definition: interface.c:94
format_function_t format_vnet_sw_if_index_name
unsigned char u8
Definition: types.h:56
#define clib_memcpy(d, s, n)
Definition: string.h:180
#define IPSEC_GRE_OUTPUT_NEXT_ESP_ENCRYPT
Definition: ipsec_gre.h:91
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 pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:493
unformat_function_t unformat_ip4_address
Definition: format.h:70
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:163
ipsec_main_t ipsec_main
Definition: ipsec.c:28
vlib_combined_counter_main_t * combined_sw_if_counters
Definition: interface.h:824
ipsec_gre_main_t ipsec_gre_main
Definition: ipsec_gre.c:28
uword vlib_node_add_next_with_slot(vlib_main_t *vm, uword node_index, uword next_node_index, uword slot)
Definition: node.c:205
#define clib_error_return(e, args...)
Definition: error.h:99
vnet_hw_interface_class_t ipsec_gre_hw_interface_class
unsigned int u32
Definition: types.h:88
u32 vnet_register_interface(vnet_main_t *vnm, u32 dev_class_index, u32 dev_instance, u32 hw_class_index, u32 hw_instance)
Definition: interface.c:740
int ipsec_add_del_ipsec_gre_tunnel(vnet_main_t *vnm, const ipsec_gre_tunnel_add_del_args_t *args)
Definition: ipsec_if.c:437
u32 sw_if_index
hardware interface index
Definition: ipsec_gre.h:62
u32 remote_sa_id
remote IPSec SA id
Definition: ipsec_gre.h:61
unformat_function_t unformat_line_input
Definition: format.h:282
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 void vlib_zero_combined_counter(vlib_combined_counter_main_t *cm, u32 index)
Clear a combined counter Clears the set of per-thread counters.
Definition: counter.h:285
clib_error_t * ipsec_gre_interface_init(vlib_main_t *vm)
Definition: interface.c:79
void ip4_sw_interface_enable_disable(u32 sw_if_index, u32 is_enable)
Definition: ip4_forward.c:525
vlib_main_t * vlib_main
Definition: vnet.h:80
#define gm
Definition: dlmalloc.c:1217
u32 esp4_encrypt_node_index
Definition: ipsec.h:119
struct _unformat_input_t unformat_input_t
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:286
u32 local_sa
local IPSec SA index
Definition: ipsec_gre.h:58
vlib_simple_counter_main_t * sw_if_counters
Definition: interface.h:823
#define pool_get_aligned(P, E, A)
Allocate an object E from a pool P with alignment A.
Definition: pool.h:230
u32 ipsec_get_sa_index_by_sa_id(u32 sa_id)
Definition: ipsec_sa.c:362
u32 * tunnel_index_by_sw_if_index
mapping from sw_if_index to tunnel index
Definition: ipsec_gre.h:78
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
vlib_main_t * vm
Definition: buffer.c:312
static void vnet_interface_counter_unlock(vnet_interface_main_t *im)
Definition: interface.h:855
IPSec-GRE state.
Definition: ipsec_gre.h:70
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:155
static void vnet_interface_counter_lock(vnet_interface_main_t *im)
Definition: interface.h:847
#define ASSERT(truth)
vnet_device_class_t ipsec_gre_device_class
IPSec-GRE tunnel parameters.
Definition: ipsec_gre.h:52
u32 set_int_l2_mode(vlib_main_t *vm, vnet_main_t *vnet_main, u32 mode, u32 sw_if_index, u32 bd_index, l2_bd_port_type_t port_type, u32 shg, u32 xc_sw_if_index)
Set the subinterface to run in l2 or l3 mode.
Definition: l2_input.c:589
static void vlib_zero_simple_counter(vlib_simple_counter_main_t *cm, u32 index)
Clear a simple counter Clears the set of per-thread u16 counters, and the u64 counter.
Definition: counter.h:139
vnet_main_t * vnet_main
convenience
Definition: ipsec_gre.h:82
u32 local_sa_id
local IPSec SA id
Definition: ipsec_gre.h:60
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u64 uword
Definition: types.h:112
static void unformat_free(unformat_input_t *i)
Definition: format.h:162
typedef key
Definition: ipsec.api:244
void vnet_sw_interface_set_mtu(vnet_main_t *vnm, u32 sw_if_index, u32 mtu)
Definition: interface.c:642
u32 * free_ipsec_gre_tunnel_hw_if_indices
free vlib hw_if_indices
Definition: ipsec_gre.h:76
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
clib_error_t * vnet_sw_interface_set_flags(vnet_main_t *vnm, u32 sw_if_index, vnet_sw_interface_flags_t flags)
Definition: interface.c:513
static clib_error_t * create_ipsec_gre_tunnel_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: interface.c:212
#define vec_validate_init_empty(V, I, INIT)
Make sure vector is long enough for given index and initialize empty space (no header, unspecified alignment)
Definition: vec.h:486
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:762
vlib_main_t * vlib_main
convenience
Definition: ipsec_gre.h:81
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
ip4_address_t tunnel_src
tunnel IPv4 src address
Definition: ipsec_gre.h:56
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:170
#define MODE_L3
Definition: l2_input.h:210
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128