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