src/vnet/session/application.h

   1 /*
   2  * Copyright (c) 2017 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 #ifndef SRC_VNET_SESSION_APPLICATION_H_
  17 #define SRC_VNET_SESSION_APPLICATION_H_
  18
  19 #include <vnet/session/session.h>
  20 #include <vnet/session/segment_manager.h>
  21 #include <vnet/session/application_namespace.h>
  22
  23 #define APP_DEBUG 0
  24
  25 #if APP_DEBUG > 0
  26 #define APP_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
  27 #else
  28 #define APP_DBG(_fmt, _args...)
  29 #endif
  30
  31 typedef struct _stream_session_cb_vft
  32 {
  33   /** Notify server of new segment */
  34   int (*add_segment_callback) (u32 api_client_index, u64 segment_handle);
  35
  36   /** Notify server of new segment */
  37   int (*del_segment_callback) (u32 api_client_index, u64 segment_handle);
  38
  39   /** Notify server of newly accepted session */
  40   int (*session_accept_callback) (stream_session_t * new_session);
  41
  42   /** Connection request callback */
  43   int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
  44                                      stream_session_t * s, u8 code);
  45
  46   /** Notify app that session is closing */
  47   void (*session_disconnect_callback) (stream_session_t * s);
  48
  49   /** Notify app that session was reset */
  50   void (*session_reset_callback) (stream_session_t * s);
  51
  52   /** Direct RX callback for built-in application */
  53   int (*builtin_app_rx_callback) (stream_session_t * session);
  54
  55   /** Direct TX callback for built-in application */
  56   int (*builtin_app_tx_callback) (stream_session_t * session);
  57
  58 } session_cb_vft_t;
  59
  60 typedef struct app_worker_
  61 {
  62   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  63
  64   /** Worker index in global worker pool*/
  65   u32 wrk_index;
  66
  67   /** Worker index in app's map pool */
  68   u32 wrk_map_index;
  69
  70   /** Index of owning app */
  71   u32 app_index;
  72
  73   /** Application listens for events on this svm queue */
  74   svm_msg_q_t *event_queue;
  75
  76   /** Segment manager used for outgoing connects issued by the app */
  77   u32 connects_seg_manager;
  78
  79   /** Lookup tables for listeners. Value is segment manager index */
  80   uword *listeners_table;
  81
  82   /**
  83    * First segment manager has in the the first segment the application's
  84    * event fifo. Depending on what the app does, it may be either used for
  85    * a listener or for connects.
  86    */
  87   u32 first_segment_manager;
  88   u8 first_segment_manager_in_use;
  89
  90   /*
  91    * Local "cut through" connections specific
  92    */
  93
  94   /** Segment manager used for incoming "cut through" connects */
  95   u32 local_segment_manager;
  96
  97   /** Pool of local sessions the app owns (as a server) */
  98   local_session_t *local_sessions;
  99
 100   /** Hash table of the app's local connects */
 101   uword *local_connects;
 102
 103   /** API index for the worker. Needed for multi-process apps */
 104   u32 api_client_index;
 105
 106   u8 app_is_builtin;
 107 } app_worker_t;
 108
 109 typedef struct app_worker_map_
 110 {
 111   u32 wrk_index;
 112 } app_worker_map_t;
 113
 114 typedef struct app_listener_
 115 {
 116   clib_bitmap_t *workers;       /**< workers accepting connections */
 117   u32 accept_rotor;             /**< last worker to accept a connection */
 118   u32 al_index;
 119 } app_listener_t;
 120
 121 typedef struct application_
 122 {
 123   /** App index in app pool */
 124   u32 app_index;
 125
 126   /** Flags */
 127   u32 flags;
 128
 129   /** Callbacks: shoulder-taps for the server/client */
 130   session_cb_vft_t cb_fns;
 131
 132   /** Segment manager properties. Shared by all segment managers */
 133   segment_manager_properties_t sm_properties;
 134
 135   /** Pool of mappings that keep track of workers associated to this app */
 136   app_worker_map_t *worker_maps;
 137
 138   /** Name registered by builtin apps */
 139   u8 *name;
 140
 141   /** Namespace the application belongs to */
 142   u32 ns_index;
 143
 144   u16 proxied_transports;
 145
 146   /** Pool of listeners for the app */
 147   app_listener_t *listeners;
 148
 149   /** Pool of local listeners for app */
 150   app_listener_t *local_listeners;
 151
 152   /** Pool of local listen sessions */
 153   local_session_t *local_listen_sessions;
 154
 155   /*
 156    * TLS Specific
 157    */
 158
 159   /** Certificate to be used for listen sessions */
 160   u8 *tls_cert;
 161
 162   /** PEM encoded key */
 163   u8 *tls_key;
 164
 165   /** Preferred tls engine */
 166   u8 tls_engine;
 167
 168 } application_t;
 169
 170 typedef struct app_main_
 171 {
 172   /**
 173    * Pool from which we allocate all applications
 174    */
 175   application_t *app_pool;
 176
 177   /**
 178    * Pool of workers associated to apps
 179    */
 180   app_worker_t *workers;
 181
 182   /**
 183    * Hash table of apps by api client index
 184    */
 185   uword *app_by_api_client_index;
 186
 187   /**
 188    * Hash table of builtin apps by name
 189    */
 190   uword *app_by_name;
 191 } app_main_t;
 192
 193 #define foreach_app_init_args                   \
 194   _(u32, api_client_index)                      \
 195   _(u8 *, name)                                 \
 196   _(u64 *, options)                             \
 197   _(u8 *, namespace_id)                         \
 198   _(session_cb_vft_t *, session_cb_vft)         \
 199   _(u32, app_index)                             \
 200
 201 typedef struct app_init_args_
 202 {
 203 #define _(_type, _name) _type _name;
 204   foreach_app_init_args
 205 #undef _
 206 } app_init_args_t;
 207
 208 typedef struct _vnet_app_worker_add_del_args
 209 {
 210   u32 app_index;                /**< App for which a new worker is requested */
 211   u32 wrk_map_index;            /**< Index to delete or return value if add */
 212   u32 api_client_index;         /**< Binary API client index */
 213   ssvm_private_t *segment;      /**< First segment in segment manager */
 214   u64 segment_handle;           /**< Handle for the segment */
 215   svm_msg_q_t *evt_q;           /**< Worker message queue */
 216   u8 is_add;                    /**< Flag set if addition */
 217 } vnet_app_worker_add_del_args_t;
 218
 219 #define APP_INVALID_INDEX ((u32)~0)
 220 #define APP_NS_INVALID_INDEX ((u32)~0)
 221 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
 222
 223 app_worker_t *app_worker_alloc (application_t * app);
 224 int app_worker_alloc_and_init (application_t * app, app_worker_t ** wrk);
 225 app_worker_t *app_worker_get (u32 wrk_index);
 226 app_worker_t *app_worker_get_if_valid (u32 wrk_index);
 227 application_t *app_worker_get_app (u32 wrk_index);
 228 int app_worker_own_session (app_worker_t * app_wrk, stream_session_t * s);
 229 void app_worker_free (app_worker_t * app_wrk);
 230 int app_worker_open_session (app_worker_t * app, session_endpoint_t * tep,
 231                              u32 api_context);
 232 segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *,
 233                                                           stream_session_t *);
 234 segment_manager_t *app_worker_get_connect_segment_manager (app_worker_t *);
 235 segment_manager_t
 236   * app_worker_get_or_alloc_connect_segment_manager (app_worker_t *);
 237 int app_worker_alloc_connects_segment_manager (app_worker_t * app);
 238 int app_worker_add_segment_notify (u32 app_or_wrk, u64 segment_handle);
 239 u32 app_worker_n_listeners (app_worker_t * app);
 240 stream_session_t *app_worker_first_listener (app_worker_t * app,
 241                                              u8 fib_proto,
 242                                              u8 transport_proto);
 243 u8 app_worker_application_is_builtin (app_worker_t * app_wrk);
 244 int app_worker_send_event (app_worker_t * app, stream_session_t * s, u8 evt);
 245 int app_worker_lock_and_send_event (app_worker_t * app, stream_session_t * s,
 246                                     u8 evt_type);
 247 clib_error_t *vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a);
 248
 249 int application_start_listen (application_t * app,
 250                               session_endpoint_cfg_t * tep,
 251                               session_handle_t * handle);
 252 int application_stop_listen (u32 app_index, u32 app_or_wrk,
 253                              session_handle_t handle);
 254
 255 application_t *application_alloc (void);
 256 int application_alloc_and_init (app_init_args_t * args);
 257 void application_free (application_t * app);
 258 void application_detach_process (application_t * app, u32 api_client_index);
 259 application_t *application_get (u32 index);
 260 application_t *application_get_if_valid (u32 index);
 261 application_t *application_lookup (u32 api_client_index);
 262 application_t *application_lookup_name (const u8 * name);
 263 app_worker_t *application_get_worker (application_t * app, u32 wrk_index);
 264 app_worker_t *application_get_default_worker (application_t * app);
 265 app_worker_t *application_listener_select_worker (stream_session_t * ls,
 266                                                   u8 is_local);
 267
 268 int application_is_proxy (application_t * app);
 269 int application_is_builtin (application_t * app);
 270 int application_is_builtin_proxy (application_t * app);
 271 u32 application_session_table (application_t * app, u8 fib_proto);
 272 u32 application_local_session_table (application_t * app);
 273 const u8 *application_name_from_index (u32 app_or_wrk);
 274 u8 application_has_local_scope (application_t * app);
 275 u8 application_has_global_scope (application_t * app);
 276 u8 application_use_mq_for_ctrl (application_t * app);
 277 void application_setup_proxy (application_t * app);
 278 void application_remove_proxy (application_t * app);
 279
 280 segment_manager_properties_t *application_get_segment_manager_properties (u32
 281                                                                           app_index);
 282
 283 segment_manager_properties_t
 284   * application_segment_manager_properties (application_t * app);
 285
 286 /*
 287  * Local session
 288  */
 289
 290 local_session_t *application_local_session_alloc (app_worker_t * app);
 291 void application_local_session_free (app_worker_t * app,
 292                                      local_session_t * ls);
 293 local_session_t *application_get_local_session (app_worker_t * app,
 294                                                 u32 session_index);
 295 local_session_t *application_get_local_session_from_handle (session_handle_t
 296                                                             handle);
 297 local_session_t
 298   * application_get_local_listen_session_from_handle (session_handle_t lh);
 299 int application_start_local_listen (application_t * server,
 300                                     session_endpoint_cfg_t * sep,
 301                                     session_handle_t * handle);
 302 int application_stop_local_listen (u32 app_index, u32 app_or_wrk,
 303                                    session_handle_t lh);
 304 int application_local_session_connect (app_worker_t * client,
 305                                        app_worker_t * server,
 306                                        local_session_t * ls, u32 opaque);
 307 int application_local_session_connect_notify (local_session_t * ls);
 308 int application_local_session_disconnect (u32 app_or_wrk,
 309                                           local_session_t * ls);
 310 int application_local_session_disconnect_w_index (u32 app_or_wrk,
 311                                                   u32 ls_index);
 312 void app_worker_local_sessions_free (app_worker_t * app);
 313
 314 always_inline u32
 315 local_session_id (local_session_t * ls)
 316 {
 317   ASSERT (ls->session_index < (2 << 16));
 318   u32 app_or_wrk_index;
 319
 320   if (ls->session_state == SESSION_STATE_LISTENING)
 321     {
 322       ASSERT (ls->app_index < (2 << 16));
 323       app_or_wrk_index = ls->app_index;
 324     }
 325   else
 326     {
 327       ASSERT (ls->app_wrk_index < (2 << 16));
 328       app_or_wrk_index = ls->app_wrk_index;
 329     }
 330
 331   return ((u32) app_or_wrk_index << 16 | (u32) ls->session_index);
 332 }
 333
 334 always_inline void
 335 local_session_parse_id (u32 ls_id, u32 * app_or_wrk, u32 * session_index)
 336 {
 337   *app_or_wrk = ls_id >> 16;
 338   *session_index = ls_id & 0xFF;
 339 }
 340
 341 always_inline void
 342 local_session_parse_handle (session_handle_t handle, u32 * app_or_wrk_index,
 343                             u32 * session_index)
 344 {
 345   u32 bottom;
 346   ASSERT ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX);
 347   bottom = (handle & 0xFFFFFFFF);
 348   local_session_parse_id (bottom, app_or_wrk_index, session_index);
 349 }
 350
 351 always_inline session_handle_t
 352 application_local_session_handle (local_session_t * ls)
 353 {
 354   return ((u64) SESSION_LOCAL_HANDLE_PREFIX << 32)
 355     | (u64) local_session_id (ls);
 356 }
 357
 358 always_inline local_session_t *
 359 application_get_local_listen_session (application_t * app, u32 session_index)
 360 {
 361   return pool_elt_at_index (app->local_listen_sessions, session_index);
 362 }
 363
 364 always_inline local_session_t *
 365 application_get_local_listener_w_handle (session_handle_t handle)
 366 {
 367   u32 server_index, session_index;
 368   application_t *app;
 369   local_session_parse_handle (handle, &server_index, &session_index);
 370   app = application_get (server_index);
 371   return application_get_local_listen_session (app, session_index);
 372 }
 373
 374 always_inline u8
 375 application_local_session_listener_has_transport (local_session_t * ls)
 376 {
 377   transport_proto_t tp;
 378   tp = session_type_transport_proto (ls->listener_session_type);
 379   return (tp != TRANSPORT_PROTO_NONE);
 380 }
 381
 382 void mq_send_local_session_disconnected_cb (u32 app_or_wrk,
 383                                             local_session_t * ls);
 384
 385 uword unformat_application_proto (unformat_input_t * input, va_list * args);
 386
 387 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
 388
 389 /*
 390  * fd.io coding-style-patch-verification: ON
 391  *
 392  * Local Variables:
 393  * eval: (c-set-style "gnu")
 394  * End:
 395  */