FD.io VPP  v19.04.1-1-ge4a0f9f
Vector Packet Processing
application_namespace.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2019 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 
18 #include <vnet/session/session.h>
19 #include <vnet/fib/fib_table.h>
20 
21 /**
22  * Hash table of application namespaces by app ns ids
23  */
25 
26 /**
27  * Pool of application namespaces
28  */
30 
33 {
34  return pool_elt_at_index (app_namespace_pool, index);
35 }
36 
39 {
40  u32 index = app_namespace_index_from_id (ns_id);
41  if (index == APP_NAMESPACE_INVALID_INDEX)
42  return 0;
43  return app_namespace_get (index);
44 }
45 
46 u32
48 {
49  return (app_ns - app_namespace_pool);
50 }
51 
54 {
55  app_namespace_t *app_ns;
56  pool_get (app_namespace_pool, app_ns);
57  clib_memset (app_ns, 0, sizeof (*app_ns));
58  app_ns->ns_id = vec_dup (ns_id);
60  app_ns - app_namespace_pool);
61  return app_ns;
62 }
63 
64 int
66 {
67  app_namespace_t *app_ns;
68  session_table_t *st;
69 
70  if (a->is_add)
71  {
72  if (a->sw_if_index != APP_NAMESPACE_INVALID_INDEX
73  && !vnet_get_sw_interface_safe (vnet_get_main (), a->sw_if_index))
74  return VNET_API_ERROR_INVALID_SW_IF_INDEX;
75 
76 
77  if (a->sw_if_index != APP_NAMESPACE_INVALID_INDEX)
78  {
79  a->ip4_fib_id =
81  a->sw_if_index);
82  a->ip6_fib_id =
84  a->sw_if_index);
85  }
86  if (a->sw_if_index == APP_NAMESPACE_INVALID_INDEX
87  && a->ip4_fib_id == APP_NAMESPACE_INVALID_INDEX)
88  return VNET_API_ERROR_INVALID_VALUE;
89 
90  app_ns = app_namespace_get_from_id (a->ns_id);
91  if (!app_ns)
92  {
93  app_ns = app_namespace_alloc (a->ns_id);
94  st = session_table_alloc ();
96  st->is_local = 1;
97  st->appns_index = app_namespace_index (app_ns);
98  app_ns->local_table_index = session_table_index (st);
99  }
100  app_ns->ns_secret = a->secret;
101  app_ns->sw_if_index = a->sw_if_index;
102  app_ns->ip4_fib_index =
103  fib_table_find (FIB_PROTOCOL_IP4, a->ip4_fib_id);
104  app_ns->ip6_fib_index =
105  fib_table_find (FIB_PROTOCOL_IP6, a->ip6_fib_id);
107  }
108  else
109  {
110  return VNET_API_ERROR_UNIMPLEMENTED;
111  }
112  return 0;
113 }
114 
115 const u8 *
117 {
118  return app_ns->ns_id;
119 }
120 
121 u32
123 {
124  uword *indexp;
125  indexp = hash_get_mem (app_namespace_lookup_table, ns_id);
126  if (!indexp)
128  return *indexp;
129 }
130 
131 const u8 *
133 {
134  app_namespace_t *app_ns;
135 
136  app_ns = app_namespace_get (index);
137  return app_namespace_id (app_ns);
138 }
139 
140 u32
142 {
143  return fib_proto == FIB_PROTOCOL_IP4 ?
144  app_ns->ip4_fib_index : app_ns->ip6_fib_index;
145 }
146 
149 {
150  return session_table_get (app_ns->local_table_index);
151 }
152 
153 void
155 {
156  u8 *ns_id = format (0, "default");
157 
160  hash_create_vec (0, sizeof (u8), sizeof (uword));
161 
162  /*
163  * Allocate default namespace
164  */
166  .ns_id = ns_id,
167  .secret = 0,
168  .sw_if_index = APP_NAMESPACE_INVALID_INDEX,
169  .is_add = 1
170  };
172  vec_free (ns_id);
173 }
174 
175 static clib_error_t *
177  vlib_cli_command_t * cmd)
178 {
179  unformat_input_t _line_input, *line_input = &_line_input;
180  u8 is_add = 0, *ns_id = 0, secret_set = 0, sw_if_index_set = 0;
182  u64 secret;
183  clib_error_t *error = 0;
184  int rv;
185 
187 
188  if (!unformat_user (input, unformat_line_input, line_input))
189  return 0;
190 
191  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
192  {
193  if (unformat (line_input, "add"))
194  is_add = 1;
195  else if (unformat (line_input, "id %_%v%_", &ns_id))
196  ;
197  else if (unformat (line_input, "secret %lu", &secret))
198  secret_set = 1;
199  else if (unformat (line_input, "sw_if_index %u", &sw_if_index))
200  sw_if_index_set = 1;
201  else if (unformat (line_input, "fib_id", &fib_id))
202  ;
203  else
204  {
205  error = clib_error_return (0, "unknown input `%U'",
206  format_unformat_error, line_input);
207  unformat_free (line_input);
208  return error;
209  }
210  }
211  unformat_free (line_input);
212 
213  if (!ns_id || !secret_set || !sw_if_index_set)
214  {
215  vlib_cli_output (vm, "namespace-id, secret and sw_if_index must be "
216  "provided");
217  return 0;
218  }
219 
220  if (is_add)
221  {
223  .ns_id = ns_id,
224  .secret = secret,
225  .sw_if_index = sw_if_index,
226  .ip4_fib_id = fib_id,
227  .is_add = 1
228  };
229  if ((rv = vnet_app_namespace_add_del (&args)))
230  return clib_error_return (0, "app namespace add del returned %d", rv);
231  }
232 
233  return error;
234 }
235 
236 /* *INDENT-OFF* */
237 VLIB_CLI_COMMAND (app_ns_command, static) =
238 {
239  .path = "app ns",
240  .short_help = "app ns [add] id <namespace-id> secret <secret> "
241  "sw_if_index <sw_if_index>",
242  .function = app_ns_fn,
243 };
244 /* *INDENT-ON* */
245 
246 u8 *
247 format_app_namespace (u8 * s, va_list * args)
248 {
249  app_namespace_t *app_ns = va_arg (*args, app_namespace_t *);
250  s = format (s, "%-10u%-20lu%-20u%-50v", app_namespace_index (app_ns),
251  app_ns->ns_secret, app_ns->sw_if_index, app_ns->ns_id);
252  return s;
253 }
254 
255 static clib_error_t *
257  vlib_cli_command_t * cmd)
258 {
259  unformat_input_t _line_input, *line_input = &_line_input;
260  app_namespace_t *app_ns;
261  session_table_t *st;
262  u8 *ns_id, do_table = 0, had_input = 1;
263 
265 
266  if (!unformat_user (main_input, unformat_line_input, line_input))
267  {
268  had_input = 0;
269  goto do_ns_list;
270  }
271 
272  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
273  {
274  if (unformat (line_input, "table %_%v%_", &ns_id))
275  do_table = 1;
276  else
277  {
278  vlib_cli_output (vm, "unknown input [%U]", format_unformat_error,
279  line_input);
280  goto done;
281  }
282  }
283 
284  if (do_table)
285  {
286  app_ns = app_namespace_get_from_id (ns_id);
287  if (!app_ns)
288  {
289  vlib_cli_output (vm, "ns %v not found", ns_id);
290  goto done;
291  }
292  st = session_table_get (app_ns->local_table_index);
293  if (!st)
294  {
295  vlib_cli_output (vm, "table for ns %v could not be found", ns_id);
296  goto done;
297  }
298  session_lookup_show_table_entries (vm, st, 0, 1);
299  vec_free (ns_id);
300  goto done;
301  }
302 
303 do_ns_list:
304  vlib_cli_output (vm, "%-10s%-20s%-20s%-50s", "Index", "Secret",
305  "sw_if_index", "Name");
306 
307  /* *INDENT-OFF* */
308  pool_foreach (app_ns, app_namespace_pool, ({
309  vlib_cli_output (vm, "%U", format_app_namespace, app_ns);
310  }));
311  /* *INDENT-ON* */
312 
313 done:
314  if (had_input)
315  unformat_free (line_input);
316  return 0;
317 }
318 
319 /* *INDENT-OFF* */
320 VLIB_CLI_COMMAND (show_app_ns_command, static) =
321 {
322  .path = "show app ns",
323  .short_help = "show app ns",
324  .function = show_app_ns_fn,
325 };
326 /* *INDENT-ON* */
327 
328 /*
329  * fd.io coding-style-patch-verification: ON
330  *
331  * Local Variables:
332  * eval: (c-set-style "gnu")
333  * End:
334  */
u32 sw_if_index
Definition: ipsec_gre.api:37
#define APP_NAMESPACE_INVALID_INDEX
session_table_t * session_table_alloc(void)
Definition: session_table.c:31
void session_lookup_show_table_entries(vlib_main_t *vm, session_table_t *table, u8 type, u8 is_local)
a
Definition: bitmap.h:538
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
#define session_cli_return_if_not_enabled()
Definition: session.h:516
int vnet_app_namespace_add_del(vnet_app_namespace_add_del_args_t *a)
u32 app_namespace_index(app_namespace_t *app_ns)
unsigned long u64
Definition: types.h:89
static clib_error_t * app_ns_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
void session_lookup_set_tables_appns(app_namespace_t *app_ns)
Mark (global) tables as pertaining to app ns.
struct _vnet_app_namespace_add_del_args vnet_app_namespace_add_del_args_t
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
#define hash_set_mem(h, key, value)
Definition: hash.h:275
clib_memset(h->entries, 0, sizeof(h->entries[0])*entries)
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:236
unsigned char u8
Definition: types.h:56
app_namespace_t * app_namespace_alloc(u8 *ns_id)
u8 * format_app_namespace(u8 *s, va_list *args)
void app_namespaces_init(void)
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:493
#define clib_error_return(e, args...)
Definition: error.h:99
unsigned int u32
Definition: types.h:88
u32 app_namespace_index_from_id(const u8 *ns_id)
u32 fib_table_find(fib_protocol_t proto, u32 table_id)
Get the index of the FIB for a Table-ID.
Definition: fib_table.c:1064
unformat_function_t unformat_line_input
Definition: format.h:282
void session_table_init(session_table_t *slt, u8 fib_proto)
Initialize session table hash tables.
Definition: session_table.c:70
u32 app_namespace_get_fib_index(app_namespace_t *app_ns, u8 fib_proto)
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
struct _unformat_input_t unformat_input_t
#define vec_dup(V)
Return copy of vector (no header, no alignment)
Definition: vec.h:375
app_namespace_t * app_namespace_get(u32 index)
uword * app_namespace_lookup_table
Hash table of application namespaces by app ns ids.
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
vlib_main_t * vm
Definition: buffer.c:312
session_table_t * app_namespace_get_local_table(app_namespace_t *app_ns)
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
static vnet_sw_interface_t * vnet_get_sw_interface_safe(vnet_main_t *vnm, u32 sw_if_index)
const u8 * app_namespace_id_from_index(u32 index)
const u8 * app_namespace_id(app_namespace_t *app_ns)
struct _app_namespace app_namespace_t
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:155
session_table_t * session_table_get(u32 table_index)
Definition: session_table.c:46
u32 fib_table_get_table_id_for_sw_if_index(fib_protocol_t proto, u32 sw_if_index)
Get the Table-ID of the FIB bound to the interface.
Definition: fib_table.c:1040
u8 is_add
Definition: ipsec_gre.api:36
#define hash_create_vec(elts, key_bytes, value_bytes)
Definition: hash.h:668
u64 uword
Definition: types.h:112
static void unformat_free(unformat_input_t *i)
Definition: format.h:162
struct _session_lookup_table session_table_t
#define FIB_PROTOCOL_MAX
Definition outside of enum so it does not need to be included in non-defaulted switch statements...
Definition: fib_types.h:52
#define hash_get_mem(h, key)
Definition: hash.h:269
u32 session_table_index(session_table_t *slt)
Definition: session_table.c:40
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
static app_namespace_t * app_namespace_pool
Pool of application namespaces.
static clib_error_t * show_app_ns_fn(vlib_main_t *vm, unformat_input_t *main_input, vlib_cli_command_t *cmd)
app_namespace_t * app_namespace_get_from_id(const u8 *ns_id)
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:725
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:170