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