src/vnet/session/application_interface.c

   1 /*
   2  * Copyright (c) 2016 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 #include <vnet/session/application_interface.h>
  16
  17 #include <vnet/session/session.h>
  18 #include <vlibmemory/api.h>
  19 #include <vnet/dpo/load_balance.h>
  20
  21 /** @file
  22     VPP's application/session API bind/unbind/connect/disconnect calls
  23 */
  24
  25 static u8
  26 session_endpoint_is_local (session_endpoint_t * sep)
  27 {
  28   return (ip_is_zero (&sep->ip, sep->is_ip4)
  29           || ip_is_local_host (&sep->ip, sep->is_ip4));
  30 }
  31
  32 static u8
  33 session_endpoint_is_zero (session_endpoint_t * sep)
  34 {
  35   return ip_is_zero (&sep->ip, sep->is_ip4);
  36 }
  37
  38 u8
  39 session_endpoint_in_ns (session_endpoint_t * sep)
  40 {
  41   u8 is_zero = ip_is_zero (&sep->ip, sep->is_ip4);
  42   if (!is_zero && sep->sw_if_index != ENDPOINT_INVALID_INDEX
  43       && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
  44     {
  45       clib_warning ("sw_if_index %u not configured with ip %U",
  46                     sep->sw_if_index, format_ip46_address, &sep->ip,
  47                     sep->is_ip4);
  48       return 0;
  49     }
  50   return (is_zero || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
  51 }
  52
  53 int
  54 api_parse_session_handle (u64 handle, u32 * session_index, u32 * thread_index)
  55 {
  56   session_manager_main_t *smm = vnet_get_session_manager_main ();
  57   stream_session_t *pool;
  58
  59   *thread_index = handle & 0xFFFFFFFF;
  60   *session_index = handle >> 32;
  61
  62   if (*thread_index >= vec_len (smm->sessions))
  63     return VNET_API_ERROR_INVALID_VALUE;
  64
  65   pool = smm->sessions[*thread_index];
  66
  67   if (pool_is_free_index (pool, *session_index))
  68     return VNET_API_ERROR_INVALID_VALUE_2;
  69
  70   return 0;
  71 }
  72
  73 static void
  74 session_endpoint_update_for_app (session_endpoint_t * sep,
  75                                  application_t * app)
  76 {
  77   app_namespace_t *app_ns;
  78   app_ns = app_namespace_get (app->ns_index);
  79   if (app_ns)
  80     {
  81       /* Ask transport and network to bind to/connect using local interface
  82        * that "supports" app's namespace. This will fix our local connection
  83        * endpoint.
  84        */
  85       sep->sw_if_index = app_ns->sw_if_index;
  86       sep->fib_index =
  87         sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
  88     }
  89 }
  90
  91 static int
  92 vnet_bind_i (u32 app_index, session_endpoint_t * sep, u64 * handle)
  93 {
  94   application_t *app;
  95   u32 table_index;
  96   u64 listener;
  97   int rv, have_local = 0;
  98
  99   app = application_get_if_valid (app_index);
 100   if (!app)
 101     {
 102       SESSION_DBG ("app not attached");
 103       return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
 104     }
 105
 106   session_endpoint_update_for_app (sep, app);
 107   if (!session_endpoint_in_ns (sep))
 108     return VNET_API_ERROR_INVALID_VALUE_2;
 109
 110   table_index = application_session_table (app,
 111                                            session_endpoint_fib_proto (sep));
 112   listener = session_lookup_endpoint_listener (table_index, sep, 1);
 113   if (listener != SESSION_INVALID_HANDLE)
 114     return VNET_API_ERROR_ADDRESS_IN_USE;
 115
 116   /*
 117    * Add session endpoint to local session table. Only binds to "inaddr_any"
 118    * (i.e., zero address) are added to local scope table.
 119    */
 120   if (application_has_local_scope (app) && session_endpoint_is_zero (sep))
 121     {
 122       table_index = application_local_session_table (app);
 123       listener = session_lookup_endpoint_listener (table_index, sep, 1);
 124       if (listener != SESSION_INVALID_HANDLE)
 125         return VNET_API_ERROR_ADDRESS_IN_USE;
 126       session_lookup_add_session_endpoint (table_index, sep, app->index);
 127       *handle = session_lookup_local_listener_make_handle (sep);
 128       have_local = 1;
 129     }
 130
 131   if (!application_has_global_scope (app))
 132     return (have_local - 1);
 133
 134   /*
 135    * Add session endpoint to global session table
 136    */
 137
 138   /* Setup listen path down to transport */
 139   rv = application_start_listen (app, sep, handle);
 140   if (rv && have_local)
 141     session_lookup_del_session_endpoint (table_index, sep);
 142   return rv;
 143 }
 144
 145 int
 146 vnet_unbind_i (u32 app_index, u64 handle)
 147 {
 148   application_t *app = application_get_if_valid (app_index);
 149   stream_session_t *listener = 0;
 150   u32 table_index;
 151
 152   if (!app)
 153     {
 154       SESSION_DBG ("app (%d) not attached", app_index);
 155       return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
 156     }
 157
 158   /*
 159    * Clean up local session table. If we have a listener session use it to
 160    * find the port and proto. If not, the handle must be a local table handle
 161    * so parse it.
 162    */
 163
 164   if (application_has_local_scope (app))
 165     {
 166       session_endpoint_t sep = SESSION_ENDPOINT_NULL;
 167       if (!session_lookup_local_is_handle (handle))
 168         listener = listen_session_get_from_handle (handle);
 169       if (listener)
 170         {
 171           if (listen_session_get_local_session_endpoint (listener, &sep))
 172             {
 173               clib_warning ("broken listener");
 174               return -1;
 175             }
 176         }
 177       else
 178         {
 179           if (session_lookup_local_listener_parse_handle (handle, &sep))
 180             {
 181               clib_warning ("can't parse handle");
 182               return -1;
 183             }
 184         }
 185       table_index = application_local_session_table (app);
 186       session_lookup_del_session_endpoint (table_index, &sep);
 187     }
 188
 189   /*
 190    * Clear the global scope table of the listener
 191    */
 192   if (application_has_global_scope (app))
 193     return application_stop_listen (app, handle);
 194   return 0;
 195 }
 196
 197 static int
 198 app_connect_redirect (application_t * server, void *mp)
 199 {
 200   return server->cb_fns.redirect_connect_callback (server->api_client_index,
 201                                                    mp);
 202 }
 203
 204 int
 205 vnet_connect_i (u32 app_index, u32 api_context, session_endpoint_t * sep,
 206                 void *mp)
 207 {
 208   application_t *server, *app;
 209   u32 table_index, server_index;
 210   stream_session_t *listener;
 211
 212   if (session_endpoint_is_zero (sep))
 213     return VNET_API_ERROR_INVALID_VALUE;
 214
 215   app = application_get (app_index);
 216   session_endpoint_update_for_app (sep, app);
 217
 218   /*
 219    * First check the the local scope for locally attached destinations.
 220    * If we have local scope, we pass *all* connects through it since we may
 221    * have special policy rules even for non-local destinations, think proxy.
 222    */
 223   if (application_has_local_scope (app))
 224     {
 225       table_index = application_local_session_table (app);
 226       server_index = session_lookup_local_endpoint (table_index, sep);
 227       if (server_index == APP_DROP_INDEX)
 228         return VNET_API_ERROR_APP_CONNECT_FILTERED;
 229
 230       /*
 231        * Break loop if rule in local table points to connecting app. This
 232        * can happen if client is a generic proxy. Route connect through
 233        * global table instead.
 234        */
 235       if (server_index != app_index)
 236         {
 237           server = application_get (server_index);
 238           /*
 239            * Server is willing to have a direct fifo connection created
 240            * instead of going through the state machine, etc.
 241            */
 242           if (server && (server->flags & APP_OPTIONS_FLAGS_ACCEPT_REDIRECT))
 243             return app_connect_redirect (server, mp);
 244         }
 245     }
 246
 247   /*
 248    * If nothing found, check the global scope for locally attached
 249    * destinations. Make sure first that we're allowed to.
 250    */
 251   if (session_endpoint_is_local (sep))
 252     return VNET_API_ERROR_SESSION_CONNECT;
 253
 254   if (!application_has_global_scope (app))
 255     return VNET_API_ERROR_APP_CONNECT_SCOPE;
 256
 257   table_index = application_session_table (app,
 258                                            session_endpoint_fib_proto (sep));
 259   listener = session_lookup_listener (table_index, sep);
 260   if (listener)
 261     {
 262       server = application_get (listener->app_index);
 263       if (server && (server->flags & APP_OPTIONS_FLAGS_ACCEPT_REDIRECT))
 264         return app_connect_redirect (server, mp);
 265     }
 266
 267   /*
 268    * Not connecting to a local server, propagate to transport
 269    */
 270   if (application_open_session (app, sep, api_context))
 271     return VNET_API_ERROR_SESSION_CONNECT;
 272   return 0;
 273 }
 274
 275 /**
 276  * unformat a vnet URI
 277  *
 278  * transport-proto://ip46-addr:port
 279  * eg. tcp://ip46-addr:port
 280  *
 281  * u8 ip46_address[16];
 282  * u16  port_in_host_byte_order;
 283  * stream_session_type_t sst;
 284  * u8 *fifo_name;
 285  *
 286  * if (unformat (input, "%U", unformat_vnet_uri, &ip46_address,
 287  *              &sst, &port, &fifo_name))
 288  *  etc...
 289  *
 290  */
 291 uword
 292 unformat_vnet_uri (unformat_input_t * input, va_list * args)
 293 {
 294   session_endpoint_t *sep = va_arg (*args, session_endpoint_t *);
 295   u32 transport_proto = 0;
 296   if (unformat (input, "%U://%U/%d", unformat_transport_proto,
 297                 &transport_proto, unformat_ip4_address, &sep->ip.ip4,
 298                 &sep->port))
 299     {
 300       sep->transport_proto = transport_proto;
 301       sep->port = clib_host_to_net_u16 (sep->port);
 302       sep->is_ip4 = 1;
 303       return 1;
 304     }
 305   if (unformat (input, "%U://%U/%d", unformat_transport_proto,
 306                 &transport_proto, unformat_ip6_address, &sep->ip.ip6,
 307                 &sep->port))
 308     {
 309       sep->transport_proto = transport_proto;
 310       sep->port = clib_host_to_net_u16 (sep->port);
 311       sep->is_ip4 = 0;
 312       return 1;
 313     }
 314   return 0;
 315 }
 316
 317 static u8 *cache_uri;
 318 static session_endpoint_t *cache_sep;
 319
 320 int
 321 parse_uri (char *uri, session_endpoint_t * sep)
 322 {
 323   unformat_input_t _input, *input = &_input;
 324
 325   if (cache_uri && !strncmp (uri, (char *) cache_uri, vec_len (cache_uri)))
 326     {
 327       *sep = *cache_sep;
 328       return 0;
 329     }
 330
 331   /* Make sure */
 332   uri = (char *) format (0, "%s%c", uri, 0);
 333
 334   /* Parse uri */
 335   unformat_init_string (input, uri, strlen (uri));
 336   if (!unformat (input, "%U", unformat_vnet_uri, sep))
 337     {
 338       unformat_free (input);
 339       return VNET_API_ERROR_INVALID_VALUE;
 340     }
 341   unformat_free (input);
 342
 343   vec_free (cache_uri);
 344   cache_uri = (u8 *) uri;
 345   if (cache_sep)
 346     clib_mem_free (cache_sep);
 347   cache_sep = clib_mem_alloc (sizeof (*sep));
 348   *cache_sep = *sep;
 349
 350   return 0;
 351 }
 352
 353 static int
 354 session_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
 355 {
 356   app_namespace_t *app_ns;
 357   if (vec_len (namespace_id) == 0)
 358     {
 359       /* Use default namespace */
 360       *app_ns_index = 0;
 361       return 0;
 362     }
 363
 364   *app_ns_index = app_namespace_index_from_id (namespace_id);
 365   if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
 366     return VNET_API_ERROR_APP_INVALID_NS;
 367   app_ns = app_namespace_get (*app_ns_index);
 368   if (!app_ns)
 369     return VNET_API_ERROR_APP_INVALID_NS;
 370   if (app_ns->ns_secret != secret)
 371     return VNET_API_ERROR_APP_WRONG_NS_SECRET;
 372   return 0;
 373 }
 374
 375 /**
 376  * Attach application to vpp
 377  *
 378  * Allocates a vpp app, i.e., a structure that keeps back pointers
 379  * to external app and a segment manager for shared memory fifo based
 380  * communication with the external app.
 381  */
 382 clib_error_t *
 383 vnet_application_attach (vnet_app_attach_args_t * a)
 384 {
 385   svm_fifo_segment_private_t *fs;
 386   application_t *app = 0;
 387   segment_manager_t *sm;
 388   u32 app_ns_index = 0;
 389   u64 secret;
 390   int rv;
 391
 392   app = application_lookup (a->api_client_index);
 393   if (app)
 394     return clib_error_return_code (0, VNET_API_ERROR_APP_ALREADY_ATTACHED,
 395                                    0, "app already attached");
 396
 397   secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
 398   if ((rv = session_validate_namespace (a->namespace_id, secret,
 399                                         &app_ns_index)))
 400     return clib_error_return_code (0, rv, 0, "namespace validation: %d", rv);
 401   a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
 402   app = application_new ();
 403   if ((rv = application_init (app, a->api_client_index, a->options,
 404                               a->session_cb_vft)))
 405     return clib_error_return_code (0, rv, 0, "app init: %d", rv);
 406
 407   a->app_event_queue_address = pointer_to_uword (app->event_queue);
 408   sm = segment_manager_get (app->first_segment_manager);
 409   fs = segment_manager_get_segment_w_lock (sm, 0);
 410
 411   if (application_is_proxy (app))
 412     application_setup_proxy (app);
 413
 414   ASSERT (vec_len (fs->ssvm.name) <= 128);
 415   a->segment = &fs->ssvm;
 416   a->app_index = app->index;
 417
 418   segment_manager_segment_reader_unlock (sm);
 419
 420   return 0;
 421 }
 422
 423 /**
 424  * Detach application from vpp
 425  */
 426 int
 427 vnet_application_detach (vnet_app_detach_args_t * a)
 428 {
 429   application_t *app;
 430   app = application_get_if_valid (a->app_index);
 431
 432   if (!app)
 433     {
 434       clib_warning ("app not attached");
 435       return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
 436     }
 437
 438   application_del (app);
 439   return 0;
 440 }
 441
 442 int
 443 vnet_bind_uri (vnet_bind_args_t * a)
 444 {
 445   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
 446   int rv;
 447
 448   rv = parse_uri (a->uri, &sep);
 449   if (rv)
 450     return rv;
 451
 452   return vnet_bind_i (a->app_index, &sep, &a->handle);
 453 }
 454
 455 int
 456 vnet_unbind_uri (vnet_unbind_args_t * a)
 457 {
 458   stream_session_t *listener;
 459   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
 460   int rv;
 461
 462   rv = parse_uri (a->uri, &sep);
 463   if (rv)
 464     return rv;
 465
 466   /* NOTE: only default table supported for uri */
 467   listener = session_lookup_listener (0, &sep);
 468   if (!listener)
 469     return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
 470
 471   return vnet_unbind_i (a->app_index, listen_session_get_handle (listener));
 472 }
 473
 474 clib_error_t *
 475 vnet_connect_uri (vnet_connect_args_t * a)
 476 {
 477   session_endpoint_t sep_null = SESSION_ENDPOINT_NULL;
 478   int rv;
 479
 480   /* Parse uri */
 481   a->sep = sep_null;
 482   rv = parse_uri (a->uri, &a->sep);
 483   if (rv)
 484     return clib_error_return_code (0, rv, 0, "app init: %d", rv);
 485   if ((rv = vnet_connect_i (a->app_index, a->api_context, &a->sep, a->mp)))
 486     return clib_error_return_code (0, rv, 0, "connect failed");
 487   return 0;
 488 }
 489
 490 int
 491 vnet_disconnect_session (vnet_disconnect_args_t * a)
 492 {
 493   u32 index, thread_index;
 494   stream_session_t *s;
 495
 496   session_parse_handle (a->handle, &index, &thread_index);
 497   s = session_get_if_valid (index, thread_index);
 498
 499   if (!s || s->app_index != a->app_index)
 500     return VNET_API_ERROR_INVALID_VALUE;
 501
 502   /* We're peeking into another's thread pool. Make sure */
 503   ASSERT (s->session_index == index);
 504
 505   stream_session_disconnect (s);
 506   return 0;
 507 }
 508
 509 clib_error_t *
 510 vnet_bind (vnet_bind_args_t * a)
 511 {
 512   int rv;
 513   if ((rv = vnet_bind_i (a->app_index, &a->sep, &a->handle)))
 514     return clib_error_return_code (0, rv, 0, "bind failed");
 515   return 0;
 516 }
 517
 518 clib_error_t *
 519 vnet_unbind (vnet_unbind_args_t * a)
 520 {
 521   int rv;
 522   if ((rv = vnet_unbind_i (a->app_index, a->handle)))
 523     return clib_error_return_code (0, rv, 0, "unbind failed");
 524   return 0;
 525 }
 526
 527 clib_error_t *
 528 vnet_connect (vnet_connect_args_t * a)
 529 {
 530   int rv;
 531   if ((rv = vnet_connect_i (a->app_index, a->api_context, &a->sep, a->mp)))
 532     return clib_error_return_code (0, rv, 0, "connect failed");
 533   return 0;
 534 }
 535
 536 /*
 537  * fd.io coding-style-patch-verification: ON
 538  *
 539  * Local Variables:
 540  * eval: (c-set-style "gnu")
 541  * End:
 542  */