src/vnet/session/application_namespace.c

   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
  16 #include <vnet/session/application_namespace.h>
  17 #include <vnet/session/application.h>
  18 #include <vnet/session/session_table.h>
  19 #include <vnet/session/session.h>
  20 #include <vnet/fib/fib_table.h>
  21 #include <vppinfra/file.h>
  22 #include <vppinfra/format_table.h>
  23 #include <vlib/unix/unix.h>
  24
  25 /**
  26  * Hash table of application namespaces by app ns ids
  27  */
  28 uword *app_namespace_lookup_table;
  29
  30 /**
  31  * Pool of application namespaces
  32  */
  33 static app_namespace_t *app_namespace_pool;
  34
  35 static u8 app_sapi_enabled;
  36
  37 app_namespace_t *
  38 app_namespace_get (u32 index)
  39 {
  40   return pool_elt_at_index (app_namespace_pool, index);
  41 }
  42
  43 app_namespace_t *
  44 app_namespace_get_from_id (const u8 *ns_id)
  45 {
  46   u32 index = app_namespace_index_from_id (ns_id);
  47   if (index == APP_NAMESPACE_INVALID_INDEX)
  48     return 0;
  49   return app_namespace_get (index);
  50 }
  51
  52 u32
  53 app_namespace_index (app_namespace_t * app_ns)
  54 {
  55   return (app_ns - app_namespace_pool);
  56 }
  57
  58 void
  59 app_namespace_free (app_namespace_t *app_ns)
  60 {
  61   hash_unset_mem (app_namespace_lookup_table, app_ns->ns_id);
  62   vec_free (app_ns->ns_id);
  63
  64   pool_put (app_namespace_pool, app_ns);
  65 }
  66
  67 app_namespace_t *
  68 app_namespace_alloc (const u8 *ns_id)
  69 {
  70   app_namespace_t *app_ns;
  71
  72   pool_get (app_namespace_pool, app_ns);
  73   clib_memset (app_ns, 0, sizeof (*app_ns));
  74
  75   app_ns->ns_id = vec_dup ((u8 *) ns_id);
  76   vec_terminate_c_string (app_ns->ns_id);
  77
  78   hash_set_mem (app_namespace_lookup_table, app_ns->ns_id,
  79                 app_ns - app_namespace_pool);
  80
  81   return app_ns;
  82 }
  83
  84 session_error_t
  85 vnet_app_namespace_add_del (vnet_app_namespace_add_del_args_t *a)
  86 {
  87   app_namespace_t *app_ns;
  88   session_table_t *st;
  89   u32 ns_index;
  90   session_error_t rv;
  91
  92   if (a->is_add)
  93     {
  94       if (a->sw_if_index != APP_NAMESPACE_INVALID_INDEX
  95           && !vnet_get_sw_interface_or_null (vnet_get_main (),
  96                                              a->sw_if_index))
  97         return SESSION_E_INVALID;
  98
  99       if (a->sw_if_index != APP_NAMESPACE_INVALID_INDEX)
 100         {
 101           a->ip4_fib_id =
 102             fib_table_get_table_id_for_sw_if_index (FIB_PROTOCOL_IP4,
 103                                                     a->sw_if_index);
 104           a->ip6_fib_id =
 105             fib_table_get_table_id_for_sw_if_index (FIB_PROTOCOL_IP6,
 106                                                     a->sw_if_index);
 107         }
 108       if (a->sw_if_index == APP_NAMESPACE_INVALID_INDEX
 109           && a->ip4_fib_id == APP_NAMESPACE_INVALID_INDEX)
 110         return SESSION_E_INVALID;
 111
 112       app_ns = app_namespace_get_from_id (a->ns_id);
 113       if (!app_ns)
 114         {
 115           app_ns = app_namespace_alloc (a->ns_id);
 116           st = session_table_alloc ();
 117           session_table_init (st, FIB_PROTOCOL_MAX);
 118           st->is_local = 1;
 119           st->appns_index = app_namespace_index (app_ns);
 120           app_ns->local_table_index = session_table_index (st);
 121           if (a->sock_name)
 122             {
 123               app_ns->sock_name = vec_dup (a->sock_name);
 124               vec_terminate_c_string (app_ns->sock_name);
 125             }
 126
 127           /* Add socket for namespace,
 128            * only at creation time */
 129           if (app_sapi_enabled)
 130             {
 131               rv = appns_sapi_add_ns_socket (app_ns);
 132               if (rv)
 133                 return rv;
 134             }
 135         }
 136
 137       app_ns->ns_secret = a->secret;
 138       app_ns->sw_if_index = a->sw_if_index;
 139       app_ns->ip4_fib_index =
 140         fib_table_find (FIB_PROTOCOL_IP4, a->ip4_fib_id);
 141       app_ns->ip6_fib_index =
 142         fib_table_find (FIB_PROTOCOL_IP6, a->ip6_fib_id);
 143       session_lookup_set_tables_appns (app_ns);
 144
 145     }
 146   else
 147     {
 148       ns_index = app_namespace_index_from_id (a->ns_id);
 149       if (ns_index == APP_NAMESPACE_INVALID_INDEX)
 150         return SESSION_E_INVALID;
 151
 152       app_ns = app_namespace_get (ns_index);
 153       if (!app_ns)
 154         return SESSION_E_INVALID;
 155
 156       application_namespace_cleanup (app_ns);
 157
 158       if (app_sapi_enabled)
 159         appns_sapi_del_ns_socket (app_ns);
 160
 161       st = session_table_get (app_ns->local_table_index);
 162
 163       session_table_free (st, FIB_PROTOCOL_MAX);
 164       if (app_ns->sock_name)
 165         vec_free (app_ns->sock_name);
 166
 167       app_namespace_free (app_ns);
 168     }
 169
 170   return 0;
 171 }
 172
 173 const u8 *
 174 app_namespace_id (app_namespace_t * app_ns)
 175 {
 176   return app_ns->ns_id;
 177 }
 178
 179 u32
 180 app_namespace_index_from_id (const u8 * ns_id)
 181 {
 182   uword *indexp;
 183   u8 *key;
 184
 185   key = vec_dup ((u8 *) ns_id);
 186   vec_terminate_c_string (key);
 187
 188   indexp = hash_get_mem (app_namespace_lookup_table, key);
 189   vec_free (key);
 190   if (!indexp)
 191     return APP_NAMESPACE_INVALID_INDEX;
 192   return *indexp;
 193 }
 194
 195 const u8 *
 196 app_namespace_id_from_index (u32 index)
 197 {
 198   app_namespace_t *app_ns;
 199
 200   app_ns = app_namespace_get (index);
 201   return app_namespace_id (app_ns);
 202 }
 203
 204 u32
 205 app_namespace_get_fib_index (app_namespace_t * app_ns, u8 fib_proto)
 206 {
 207   return fib_proto == FIB_PROTOCOL_IP4 ?
 208     app_ns->ip4_fib_index : app_ns->ip6_fib_index;
 209 }
 210
 211 session_table_t *
 212 app_namespace_get_local_table (app_namespace_t * app_ns)
 213 {
 214   return session_table_get (app_ns->local_table_index);
 215 }
 216
 217 int
 218 appns_sapi_enable_disable (int is_enable)
 219 {
 220   /* This cannot be called with active sockets */
 221   if (pool_elts (app_namespace_pool))
 222     return -1;
 223
 224   app_sapi_enabled = is_enable;
 225   return 0;
 226 }
 227
 228 u8
 229 appns_sapi_enabled (void)
 230 {
 231   return app_sapi_enabled;
 232 }
 233
 234 void
 235 app_namespaces_init (void)
 236 {
 237   u8 *ns_id = format (0, "default");
 238
 239   if (!app_namespace_lookup_table)
 240     app_namespace_lookup_table =
 241       hash_create_vec (0, sizeof (u8), sizeof (uword));
 242
 243   /*
 244    * Allocate default namespace
 245    */
 246
 247   /* clang-format off */
 248   vnet_app_namespace_add_del_args_t a = {
 249     .ns_id = ns_id,
 250     .sock_name = 0,
 251     .secret = 0,
 252     .sw_if_index = APP_NAMESPACE_INVALID_INDEX,
 253     .is_add = 1
 254   };
 255   /* clang-format on */
 256
 257   vnet_app_namespace_add_del (&a);
 258   vec_free (ns_id);
 259 }
 260
 261 static clib_error_t *
 262 app_ns_fn (vlib_main_t * vm, unformat_input_t * input,
 263            vlib_cli_command_t * cmd)
 264 {
 265   u8 is_add = 0, *ns_id = 0, secret_set = 0, sw_if_index_set = 0;
 266   u8 *sock_name = 0;
 267   unformat_input_t _line_input, *line_input = &_line_input;
 268   u32 sw_if_index, fib_id = APP_NAMESPACE_INVALID_INDEX;
 269   vnet_main_t *vnm = vnet_get_main ();
 270   u64 secret;
 271   clib_error_t *error = 0;
 272   int rv;
 273
 274   session_cli_return_if_not_enabled ();
 275
 276   if (!unformat_user (input, unformat_line_input, line_input))
 277     return 0;
 278
 279   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 280     {
 281       if (unformat (line_input, "add"))
 282         is_add = 1;
 283       else if (unformat (line_input, "del"))
 284         is_add = 0;
 285       else if (unformat (line_input, "id %_%v%_", &ns_id))
 286         ;
 287       else if (unformat (line_input, "secret %lu", &secret))
 288         secret_set = 1;
 289       else if (unformat (line_input, "sw_if_index %u", &sw_if_index))
 290         sw_if_index_set = 1;
 291       else if (unformat (line_input, "if %U", unformat_vnet_sw_interface, vnm,
 292                          &sw_if_index))
 293         sw_if_index_set = 1;
 294       else if (unformat (line_input, "fib_id", &fib_id))
 295         ;
 296       else if (unformat (line_input, "sock-name %_%v%_", &sock_name))
 297         ;
 298       else
 299         {
 300           error = clib_error_return (0, "unknown input `%U'",
 301                                      format_unformat_error, line_input);
 302           goto done;
 303         }
 304     }
 305
 306   if (!ns_id)
 307     {
 308       vlib_cli_output (vm, "namespace-id must be provided");
 309       goto done;
 310     }
 311
 312   if (is_add && (!secret_set || !sw_if_index_set))
 313     {
 314       vlib_cli_output (vm, "secret and interface must be provided");
 315       goto done;
 316     }
 317
 318   /* clang-format off */
 319   vnet_app_namespace_add_del_args_t args = {
 320     .ns_id = ns_id,
 321     .secret = secret,
 322     .sw_if_index = sw_if_index,
 323     .sock_name = sock_name,
 324     .ip4_fib_id = fib_id,
 325     .is_add = is_add,
 326   };
 327   /* clang-format on */
 328
 329   if ((rv = vnet_app_namespace_add_del (&args)))
 330     error = clib_error_return (0, "app namespace add del returned %d", rv);
 331
 332 done:
 333
 334   vec_free (ns_id);
 335   vec_free (sock_name);
 336   unformat_free (line_input);
 337
 338   return error;
 339 }
 340
 341 VLIB_CLI_COMMAND (app_ns_command, static) = {
 342   .path = "app ns",
 343   .short_help = "app ns [add|del] id <namespace-id> secret <secret> "
 344                 "sw_if_index <sw_if_index> if <interface>",
 345   .function = app_ns_fn,
 346 };
 347
 348 u8 *
 349 format_app_namespace (u8 * s, va_list * args)
 350 {
 351   app_namespace_t *app_ns = va_arg (*args, app_namespace_t *);
 352   vnet_main_t *vnm = vnet_get_main ();
 353
 354   s = format (s, "Application namespace [%u]\nid:        %s\nsecret:    %lu",
 355               app_namespace_index (app_ns), app_ns->ns_id, app_ns->ns_secret);
 356   if (app_ns->sw_if_index != (u32) ~0)
 357     s = format (s, "\nInterface: %U", format_vnet_sw_if_index_name, vnm,
 358                 app_ns->sw_if_index);
 359   if (app_ns->sock_name)
 360     s = format (s, "\nSocket:    %s", app_ns->sock_name);
 361
 362   return s;
 363 }
 364
 365 static void
 366 app_namespace_show_api (vlib_main_t * vm, app_namespace_t * app_ns)
 367 {
 368   app_ns_api_handle_t *handle;
 369   app_worker_t *app_wrk;
 370   clib_socket_t *cs;
 371   clib_file_t *cf;
 372
 373   if (!app_sapi_enabled)
 374     {
 375       vlib_cli_output (vm, "app socket api not enabled!");
 376       return;
 377     }
 378
 379   vlib_cli_output (vm, "socket: %v\n", app_ns->sock_name);
 380
 381   if (!pool_elts (app_ns->app_sockets))
 382     return;
 383
 384   vlib_cli_output (vm, "%12s%12s%5s", "app index", "wrk index", "fd");
 385
 386
 387   pool_foreach (cs, app_ns->app_sockets)  {
 388     handle = (app_ns_api_handle_t *) &cs->private_data;
 389     cf = clib_file_get (&file_main, handle->aah_file_index);
 390     if (handle->aah_app_wrk_index == APP_INVALID_INDEX)
 391       {
 392         vlib_cli_output (vm, "%12d%12d%5u", -1, -1, cf->file_descriptor);
 393         continue;
 394       }
 395     app_wrk = app_worker_get (handle->aah_app_wrk_index);
 396     vlib_cli_output (vm, "%12d%12d%5u", app_wrk->app_index,
 397                      app_wrk->wrk_map_index, cf->file_descriptor);
 398   }
 399 }
 400
 401 static clib_error_t *
 402 show_app_ns_fn (vlib_main_t * vm, unformat_input_t * main_input,
 403                 vlib_cli_command_t * cmd)
 404 {
 405   unformat_input_t _line_input, *line_input = &_line_input;
 406   u8 *ns_id = 0, do_table = 0, had_input = 1, do_api = 0;
 407   app_namespace_t *app_ns;
 408   vnet_main_t *vnm = vnet_get_main ();
 409   session_table_t *st;
 410   table_t table = {}, *t = &table;
 411
 412   session_cli_return_if_not_enabled ();
 413
 414   if (!unformat_user (main_input, unformat_line_input, line_input))
 415     {
 416       had_input = 0;
 417       goto do_ns_list;
 418     }
 419
 420   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 421     {
 422       if (unformat (line_input, "id %_%v%_", &ns_id))
 423         do_table = 1;
 424       else if (unformat (line_input, "api-clients"))
 425         do_api = 1;
 426       else
 427         {
 428           vlib_cli_output (vm, "unknown input [%U]", format_unformat_error,
 429                            line_input);
 430           goto done;
 431         }
 432     }
 433
 434   if (do_api)
 435     {
 436       if (!do_table)
 437         {
 438           vlib_cli_output (vm, "must specify a table for api");
 439           goto done;
 440         }
 441       app_ns = app_namespace_get_from_id (ns_id);
 442       app_namespace_show_api (vm, app_ns);
 443       goto done;
 444     }
 445   if (do_table)
 446     {
 447       app_ns = app_namespace_get_from_id (ns_id);
 448       if (!app_ns)
 449         {
 450           vlib_cli_output (vm, "ns %v not found", ns_id);
 451           goto done;
 452         }
 453       st = session_table_get (app_ns->local_table_index);
 454       if (!st)
 455         {
 456           vlib_cli_output (vm, "table for ns %v could not be found", ns_id);
 457           goto done;
 458         }
 459       vlib_cli_output (vm, "%U", format_app_namespace, app_ns);
 460       session_lookup_show_table_entries (vm, st, 0, 1);
 461       vec_free (ns_id);
 462       goto done;
 463     }
 464
 465 do_ns_list:
 466   table_add_header_col (t, 5, "Index", "Secret", "Interface", "Id", "Socket");
 467   int i = 0;
 468   pool_foreach (app_ns, app_namespace_pool)
 469     {
 470       int j = 0;
 471       table_format_cell (t, i, j++, "%u", app_namespace_index (app_ns));
 472       table_format_cell (t, i, j++, "%lu", app_ns->ns_secret);
 473       table_format_cell (t, i, j++, "%U", format_vnet_sw_if_index_name, vnm,
 474                          app_ns->sw_if_index);
 475       table_format_cell (t, i, j++, "%s", app_ns->ns_id);
 476       table_format_cell (t, i++, j++, "%s", app_ns->sock_name);
 477     }
 478
 479   t->default_body.align = TTAA_LEFT;
 480   t->default_header_col.align = TTAA_LEFT;
 481   t->default_header_col.fg_color = TTAC_YELLOW;
 482   t->default_header_col.flags = TTAF_FG_COLOR_SET;
 483   vlib_cli_output (vm, "%U", format_table, t);
 484   table_free (t);
 485
 486 done:
 487   if (had_input)
 488     unformat_free (line_input);
 489   return 0;
 490 }
 491
 492 VLIB_CLI_COMMAND (show_app_ns_command, static) = {
 493   .path = "show app ns",
 494   .short_help = "show app ns [id <id> [api-clients]]",
 495   .function = show_app_ns_fn,
 496 };
 497
 498 /*
 499  * fd.io coding-style-patch-verification: ON
 500  *
 501  * Local Variables:
 502  * eval: (c-set-style "gnu")
 503  * End:
 504  */