src/vnet/session/application.h

   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 #ifndef SRC_VNET_SESSION_APPLICATION_H_
  17 #define SRC_VNET_SESSION_APPLICATION_H_
  18
  19 #include <vnet/session/application_interface.h>
  20 #include <vnet/session/application_namespace.h>
  21 #include <vnet/session/session_types.h>
  22 #include <vnet/session/segment_manager.h>
  23
  24 #define APP_DEBUG 0
  25
  26 #if APP_DEBUG > 0
  27 #define APP_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
  28 #else
  29 #define APP_DBG(_fmt, _args...)
  30 #endif
  31
  32 typedef struct app_worker_
  33 {
  34   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  35
  36   /** Worker index in global worker pool*/
  37   u32 wrk_index;
  38
  39   /** Worker index in app's map pool */
  40   u32 wrk_map_index;
  41
  42   /** Index of owning app */
  43   u32 app_index;
  44
  45   /** Application listens for events on this svm queue */
  46   svm_msg_q_t *event_queue;
  47
  48   /** Segment manager used for outgoing connects issued by the app */
  49   u32 connects_seg_manager;
  50
  51   /** Lookup tables for listeners. Value is segment manager index */
  52   uword *listeners_table;
  53
  54   /**
  55    * First segment manager has in the the first segment the application's
  56    * event fifo. Depending on what the app does, it may be either used for
  57    * a listener or for connects.
  58    */
  59   u32 first_segment_manager;
  60   u8 first_segment_manager_in_use;
  61
  62   /** API index for the worker. Needed for multi-process apps */
  63   u32 api_client_index;
  64
  65   u8 app_is_builtin;
  66 } app_worker_t;
  67
  68 typedef struct app_worker_map_
  69 {
  70   u32 wrk_index;
  71 } app_worker_map_t;
  72
  73 typedef struct app_listener_
  74 {
  75   clib_bitmap_t *workers;       /**< workers accepting connections */
  76   u32 accept_rotor;             /**< last worker to accept a connection */
  77   u32 al_index;
  78   u32 app_index;
  79   u32 local_index;
  80   u32 session_index;
  81 } app_listener_t;
  82
  83 typedef struct application_
  84 {
  85   /** App index in app pool */
  86   u32 app_index;
  87
  88   /** Flags */
  89   u32 flags;
  90
  91   /** Callbacks: shoulder-taps for the server/client */
  92   session_cb_vft_t cb_fns;
  93
  94   /** Segment manager properties. Shared by all segment managers */
  95   segment_manager_props_t sm_properties;
  96
  97   /** Pool of mappings that keep track of workers associated to this app */
  98   app_worker_map_t *worker_maps;
  99
 100   /** Name registered by builtin apps */
 101   u8 *name;
 102
 103   /** Namespace the application belongs to */
 104   u32 ns_index;
 105
 106   u16 proxied_transports;
 107
 108   /** Pool of listeners for the app */
 109   app_listener_t *listeners;
 110
 111   /*
 112    * TLS & QUIC Specific
 113    */
 114
 115   /** Certificate to be used for listen sessions */
 116   u8 *tls_cert;
 117
 118   /** PEM encoded key */
 119   u8 *tls_key;
 120
 121   /** Preferred tls engine */
 122   u8 tls_engine;
 123
 124   u64 *quicly_ctx;
 125
 126 } application_t;
 127
 128 typedef struct app_main_
 129 {
 130   /**
 131    * Pool from which we allocate all applications
 132    */
 133   application_t *app_pool;
 134
 135   /**
 136    * Hash table of apps by api client index
 137    */
 138   uword *app_by_api_client_index;
 139
 140   /**
 141    * Hash table of builtin apps by name
 142    */
 143   uword *app_by_name;
 144 } app_main_t;
 145
 146 typedef struct app_init_args_
 147 {
 148 #define _(_type, _name) _type _name;
 149   foreach_app_init_args
 150 #undef _
 151 } app_init_args_t;
 152
 153 typedef struct _vnet_app_worker_add_del_args
 154 {
 155   u32 app_index;                /**< App for which a new worker is requested */
 156   u32 wrk_map_index;            /**< Index to delete or return value if add */
 157   u32 api_client_index;         /**< Binary API client index */
 158   ssvm_private_t *segment;      /**< First segment in segment manager */
 159   u64 segment_handle;           /**< Handle for the segment */
 160   svm_msg_q_t *evt_q;           /**< Worker message queue */
 161   u8 is_add;                    /**< Flag set if addition */
 162 } vnet_app_worker_add_del_args_t;
 163
 164 #define APP_INVALID_INDEX ((u32)~0)
 165 #define APP_NS_INVALID_INDEX ((u32)~0)
 166 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
 167
 168 app_listener_t *app_listener_get (application_t * app, u32 al_index);
 169 int app_listener_alloc_and_init (application_t * app,
 170                                  session_endpoint_cfg_t * sep,
 171                                  app_listener_t ** listener);
 172 void app_listener_cleanup (app_listener_t * app_listener);
 173 session_handle_t app_listener_handle (app_listener_t * app_listener);
 174 app_listener_t *app_listener_lookup (application_t * app,
 175                                      session_endpoint_cfg_t * sep);
 176 app_listener_t *app_listener_get_w_handle (session_handle_t handle);
 177 app_listener_t *app_listener_get_w_session (session_t * ls);
 178 session_t *app_listener_get_session (app_listener_t * al);
 179 session_t *app_listener_get_local_session (app_listener_t * al);
 180
 181 application_t *application_get (u32 index);
 182 application_t *application_get_if_valid (u32 index);
 183 application_t *application_lookup (u32 api_client_index);
 184 application_t *application_lookup_name (const u8 * name);
 185 app_worker_t *application_get_worker (application_t * app, u32 wrk_index);
 186 app_worker_t *application_get_default_worker (application_t * app);
 187 app_worker_t *application_listener_select_worker (session_t * ls);
 188 int application_change_listener_owner (session_t * s, app_worker_t * app_wrk);
 189 int application_is_proxy (application_t * app);
 190 int application_is_builtin (application_t * app);
 191 int application_is_builtin_proxy (application_t * app);
 192 u32 application_session_table (application_t * app, u8 fib_proto);
 193 u32 application_local_session_table (application_t * app);
 194 const u8 *application_name_from_index (u32 app_or_wrk);
 195 u8 application_has_local_scope (application_t * app);
 196 u8 application_has_global_scope (application_t * app);
 197 void application_setup_proxy (application_t * app);
 198 void application_remove_proxy (application_t * app);
 199
 200 segment_manager_props_t *application_get_segment_manager_properties (u32
 201                                                                      app_index);
 202
 203 segment_manager_props_t
 204   * application_segment_manager_properties (application_t * app);
 205
 206 /*
 207  * App worker
 208  */
 209
 210 app_worker_t *app_worker_alloc (application_t * app);
 211 int application_alloc_worker_and_init (application_t * app,
 212                                        app_worker_t ** wrk);
 213 app_worker_t *app_worker_get (u32 wrk_index);
 214 app_worker_t *app_worker_get_if_valid (u32 wrk_index);
 215 application_t *app_worker_get_app (u32 wrk_index);
 216 int app_worker_own_session (app_worker_t * app_wrk, session_t * s);
 217 void app_worker_free (app_worker_t * app_wrk);
 218 int app_worker_connect_session (app_worker_t * app, session_endpoint_t * tep,
 219                                 u32 api_context);
 220 int app_worker_start_listen (app_worker_t * app_wrk, app_listener_t * lstnr);
 221 int app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al);
 222 int app_worker_init_accepted (session_t * s);
 223 int app_worker_accept_notify (app_worker_t * app_wrk, session_t * s);
 224 int app_worker_init_connected (app_worker_t * app_wrk, session_t * s);
 225 int app_worker_connect_notify (app_worker_t * app_wrk, session_t * s,
 226                                u32 opaque);
 227 int app_worker_close_notify (app_worker_t * app_wrk, session_t * s);
 228 int app_worker_reset_notify (app_worker_t * app_wrk, session_t * s);
 229 int app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s);
 230 int app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s);
 231 segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *,
 232                                                           session_t *);
 233 segment_manager_t *app_worker_get_connect_segment_manager (app_worker_t *);
 234 segment_manager_t
 235   * app_worker_get_or_alloc_connect_segment_manager (app_worker_t *);
 236 int app_worker_alloc_connects_segment_manager (app_worker_t * app);
 237 int app_worker_add_segment_notify (app_worker_t * app_wrk,
 238                                    u64 segment_handle);
 239 int app_worker_del_segment_notify (app_worker_t * app_wrk,
 240                                    u64 segment_handle);
 241 u32 app_worker_n_listeners (app_worker_t * app);
 242 session_t *app_worker_first_listener (app_worker_t * app,
 243                                       u8 fib_proto, u8 transport_proto);
 244 int app_worker_send_event (app_worker_t * app, session_t * s, u8 evt);
 245 int app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
 246                                     u8 evt_type);
 247 session_t *app_worker_proxy_listener (app_worker_t * app, u8 fib_proto,
 248                                       u8 transport_proto);
 249 u8 *format_app_worker (u8 * s, va_list * args);
 250 u8 *format_app_worker_listener (u8 * s, va_list * args);
 251 void app_worker_format_connects (app_worker_t * app_wrk, int verbose);
 252 int vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a);
 253
 254 uword unformat_application_proto (unformat_input_t * input, va_list * args);
 255
 256 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
 257
 258 /*
 259  * fd.io coding-style-patch-verification: ON
 260  *
 261  * Local Variables:
 262  * eval: (c-set-style "gnu")
 263  * End:
 264  */