FD.io VPP  v20.01-48-g3e0dafb74
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
74  a->sw_if_index))
75  return VNET_API_ERROR_INVALID_SW_IF_INDEX;
76 
77 
78  if (a->sw_if_index != APP_NAMESPACE_INVALID_INDEX)
79  {
80  a->ip4_fib_id =
82  a->sw_if_index);
83  a->ip6_fib_id =
85  a->sw_if_index);
86  }
87  if (a->sw_if_index == APP_NAMESPACE_INVALID_INDEX
88  && a->ip4_fib_id == APP_NAMESPACE_INVALID_INDEX)
89  return VNET_API_ERROR_INVALID_VALUE;
90 
91  app_ns = app_namespace_get_from_id (a->ns_id);
92  if (!app_ns)
93  {
94  app_ns = app_namespace_alloc (a->ns_id);
95  st = session_table_alloc ();
97  st->is_local = 1;
98  st->appns_index = app_namespace_index (app_ns);
99  app_ns->local_table_index = session_table_index (st);
100  }
101  app_ns->ns_secret = a->secret;
102  app_ns->sw_if_index = a->sw_if_index;
103  app_ns->ip4_fib_index =
104  fib_table_find (FIB_PROTOCOL_IP4, a->ip4_fib_id);
105  app_ns->ip6_fib_index =
106  fib_table_find (FIB_PROTOCOL_IP6, a->ip6_fib_id);
108  }
109  else
110  {
111  return VNET_API_ERROR_UNIMPLEMENTED;
112  }
113  return 0;
114 }
115 
116 const u8 *
118 {
119  return app_ns->ns_id;
120 }
121 
122 u32
124 {
125  uword *indexp;
126  indexp = hash_get_mem (app_namespace_lookup_table, ns_id);
127  if (!indexp)
129  return *indexp;
130 }
131 
132 const u8 *
134 {
135  app_namespace_t *app_ns;
136 
137  app_ns = app_namespace_get (index);
138  return app_namespace_id (app_ns);
139 }
140 
141 u32
143 {
144  return fib_proto == FIB_PROTOCOL_IP4 ?
145  app_ns->ip4_fib_index : app_ns->ip6_fib_index;
146 }
147 
150 {
151  return session_table_get (app_ns->local_table_index);
152 }
153 
154 void
156 {
157  u8 *ns_id = format (0, "default");
158 
161  hash_create_vec (0, sizeof (u8), sizeof (uword));
162 
163  /*
164  * Allocate default namespace
165  */
167  .ns_id = ns_id,
168  .secret = 0,
169  .sw_if_index = APP_NAMESPACE_INVALID_INDEX,
170  .is_add = 1
171  };
173  vec_free (ns_id);
174 }
175 
176 static clib_error_t *
178  vlib_cli_command_t * cmd)
179 {
180  unformat_input_t _line_input, *line_input = &_line_input;
181  u8 is_add = 0, *ns_id = 0, secret_set = 0, sw_if_index_set = 0;
183  u64 secret;
184  clib_error_t *error = 0;
185  int rv;
186 
188 
189  if (!unformat_user (input, unformat_line_input, line_input))
190  return 0;
191 
192  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
193  {
194  if (unformat (line_input, "add"))
195  is_add = 1;
196  else if (unformat (line_input, "id %_%v%_", &ns_id))
197  ;
198  else if (unformat (line_input, "secret %lu", &secret))
199  secret_set = 1;
200  else if (unformat (line_input, "sw_if_index %u", &sw_if_index))
201  sw_if_index_set = 1;
202  else if (unformat (line_input, "fib_id", &fib_id))
203  ;
204  else
205  {
206  error = clib_error_return (0, "unknown input `%U'",
207  format_unformat_error, line_input);
208  unformat_free (line_input);
209  return error;
210  }
211  }
212  unformat_free (line_input);
213 
214  if (!ns_id || !secret_set || !sw_if_index_set)
215  {
216  vlib_cli_output (vm, "namespace-id, secret and sw_if_index must be "
217  "provided");
218  return 0;
219  }
220 
221  if (is_add)
222  {
224  .ns_id = ns_id,
225  .secret = secret,
226  .sw_if_index = sw_if_index,
227  .ip4_fib_id = fib_id,
228  .is_add = 1
229  };
230  if ((rv = vnet_app_namespace_add_del (&args)))
231  return clib_error_return (0, "app namespace add del returned %d", rv);
232  }
233 
234  return error;
235 }
236 
237 /* *INDENT-OFF* */
238 VLIB_CLI_COMMAND (app_ns_command, static) =
239 {
240  .path = "app ns",
241  .short_help = "app ns [add] id <namespace-id> secret <secret> "
242  "sw_if_index <sw_if_index>",
243  .function = app_ns_fn,
244 };
245 /* *INDENT-ON* */
246 
247 u8 *
248 format_app_namespace (u8 * s, va_list * args)
249 {
250  app_namespace_t *app_ns = va_arg (*args, app_namespace_t *);
251  s = format (s, "%-10u%-20lu%-20u%-50v", app_namespace_index (app_ns),
252  app_ns->ns_secret, app_ns->sw_if_index, app_ns->ns_id);
253  return s;
254 }
255 
256 static clib_error_t *
258  vlib_cli_command_t * cmd)
259 {
260  unformat_input_t _line_input, *line_input = &_line_input;
261  app_namespace_t *app_ns;
262  session_table_t *st;
263  u8 *ns_id, do_table = 0, had_input = 1;
264 
266 
267  if (!unformat_user (main_input, unformat_line_input, line_input))
268  {
269  had_input = 0;
270  goto do_ns_list;
271  }
272 
273  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
274  {
275  if (unformat (line_input, "table %_%v%_", &ns_id))
276  do_table = 1;
277  else
278  {
279  vlib_cli_output (vm, "unknown input [%U]", format_unformat_error,
280  line_input);
281  goto done;
282  }
283  }
284 
285  if (do_table)
286  {
287  app_ns = app_namespace_get_from_id (ns_id);
288  if (!app_ns)
289  {
290  vlib_cli_output (vm, "ns %v not found", ns_id);
291  goto done;
292  }
293  st = session_table_get (app_ns->local_table_index);
294  if (!st)
295  {
296  vlib_cli_output (vm, "table for ns %v could not be found", ns_id);
297  goto done;
298  }
299  session_lookup_show_table_entries (vm, st, 0, 1);
300  vec_free (ns_id);
301  goto done;
302  }
303 
304 do_ns_list:
305  vlib_cli_output (vm, "%-10s%-20s%-20s%-50s", "Index", "Secret",
306  "sw_if_index", "Name");
307 
308  /* *INDENT-OFF* */
309  pool_foreach (app_ns, app_namespace_pool, ({
310  vlib_cli_output (vm, "%U", format_app_namespace, app_ns);
311  }));
312  /* *INDENT-ON* */
313 
314 done:
315  if (had_input)
316  unformat_free (line_input);
317  return 0;
318 }
319 
320 /* *INDENT-OFF* */
321 VLIB_CLI_COMMAND (show_app_ns_command, static) =
322 {
323  .path = "show app ns",
324  .short_help = "show app ns",
325  .function = show_app_ns_fn,
326 };
327 /* *INDENT-ON* */
328 
329 /*
330  * fd.io coding-style-patch-verification: ON
331  *
332  * Local Variables:
333  * eval: (c-set-style "gnu")
334  * End:
335  */
#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:46
#define session_cli_return_if_not_enabled()
Definition: session.h:618
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)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
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:989
#define hash_set_mem(h, key, value)
Definition: hash.h:275
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:237
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:498
vl_api_interface_index_t sw_if_index
Definition: gre.api:59
#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:1097
unformat_function_t unformat_line_input
Definition: format.h:283
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:519
struct _unformat_input_t unformat_input_t
#define vec_dup(V)
Return copy of vector (no header, no alignment)
Definition: vec.h:376
app_namespace_t * app_namespace_get(u32 index)
vlib_main_t * vm
Definition: in2out_ed.c:1810
uword * app_namespace_lookup_table
Hash table of application namespaces by app ns ids.
#define UNFORMAT_END_OF_INPUT
Definition: format.h:145
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:342
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:152
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:1073
#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:163
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:689
static vnet_sw_interface_t * vnet_get_sw_interface_or_null(vnet_main_t *vnm, u32 sw_if_index)
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:171