blob: de609d2d7a05f542850e35c8624beb0a5aa81f6c [file] [log] [blame]
Dave Barach68b0fb02017-02-28 15:15:56 -05001/*
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
Dave Barach68b0fb02017-02-28 15:15:56 -050019#include <vnet/session/session.h>
Florin Coras6cf30ad2017-04-04 23:08:23 -070020#include <vnet/session/segment_manager.h>
Florin Corascea194d2017-10-02 00:18:51 -070021#include <vnet/session/application_namespace.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050022
Florin Coras15531972018-08-12 23:50:53 -070023#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
Dave Barach68b0fb02017-02-28 15:15:56 -050031typedef struct _stream_session_cb_vft
32{
33 /** Notify server of new segment */
Florin Corasb384b542018-01-15 01:08:33 -080034 int (*add_segment_callback) (u32 api_client_index,
35 const ssvm_private_t * ssvm_seg);
Florin Corasf8f516a2018-02-08 15:10:09 -080036 /** Notify server of new segment */
37 int (*del_segment_callback) (u32 api_client_index,
38 const ssvm_private_t * ssvm_seg);
Dave Barach68b0fb02017-02-28 15:15:56 -050039
40 /** Notify server of newly accepted session */
41 int (*session_accept_callback) (stream_session_t * new_session);
42
Florin Corascea194d2017-10-02 00:18:51 -070043 /** Connection request callback */
Florin Coras15531972018-08-12 23:50:53 -070044 int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
Dave Barach68b0fb02017-02-28 15:15:56 -050045 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
Florin Coras371ca502018-02-21 12:07:41 -080053 /** 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);
Dave Barach68b0fb02017-02-28 15:15:56 -050058
Dave Barach68b0fb02017-02-28 15:15:56 -050059} session_cb_vft_t;
60
Florin Coras15531972018-08-12 23:50:53 -070061typedef struct app_worker_
Dave Barach68b0fb02017-02-28 15:15:56 -050062{
Florin Coras15531972018-08-12 23:50:53 -070063 /** Worker index in global worker pool*/
64 u32 wrk_index;
Dave Barach68b0fb02017-02-28 15:15:56 -050065
Florin Coras15531972018-08-12 23:50:53 -070066 /** Worker index in app's map pool */
67 u32 wrk_map_index;
Dave Barach68b0fb02017-02-28 15:15:56 -050068
Florin Coras15531972018-08-12 23:50:53 -070069 /** Index of owning app */
70 u32 app_index;
Florin Corascea194d2017-10-02 00:18:51 -070071
Dave Barach68b0fb02017-02-28 15:15:56 -050072 /** Application listens for events on this svm queue */
Florin Coras3c2fed52018-07-04 04:15:05 -070073 svm_msg_q_t *event_queue;
Dave Barach68b0fb02017-02-28 15:15:56 -050074
Florin Corasf8f516a2018-02-08 15:10:09 -080075 /** Segment manager used for outgoing connects issued by the app */
Florin Coras6cf30ad2017-04-04 23:08:23 -070076 u32 connects_seg_manager;
77
Florin Corasc87c91d2017-08-16 19:55:49 -070078 /** Lookup tables for listeners. Value is segment manager index */
Florin Coras6cf30ad2017-04-04 23:08:23 -070079 uword *listeners_table;
80
Florin Coras7999e832017-10-31 01:51:04 -070081 /**
82 * First segment manager has in the the first segment the application's
Florin Corasc87c91d2017-08-16 19:55:49 -070083 * event fifo. Depending on what the app does, it may be either used for
Florin Coras7999e832017-10-31 01:51:04 -070084 * a listener or for connects.
85 */
Florin Coras6cf30ad2017-04-04 23:08:23 -070086 u32 first_segment_manager;
Florin Coras0e9c33b2017-08-14 22:33:41 -070087 u8 first_segment_manager_in_use;
Florin Coras6cf30ad2017-04-04 23:08:23 -070088
Florin Corasf8f516a2018-02-08 15:10:09 -080089 /*
90 * Local "cut through" connections specific
91 */
92
93 /** Segment manager used for incoming "cut through" connects */
94 u32 local_segment_manager;
95
96 /** Pool of local listen sessions */
97 local_session_t *local_listen_sessions;
98
99 /** Pool of local sessions the app owns (as a server) */
100 local_session_t *local_sessions;
101
102 /** Hash table of the app's local connects */
103 uword *local_connects;
Florin Coras371ca502018-02-21 12:07:41 -0800104
Florin Coras15531972018-08-12 23:50:53 -0700105 u8 app_is_builtin;
106} app_worker_t;
107
108typedef struct app_worker_map_
109{
110 u32 wrk_index;
111} app_worker_map_t;
112
113typedef struct application_
114{
115 /** App index in app pool */
116 u32 app_index;
117
118 /** Binary API connection index, ~0 if internal */
119 u32 api_client_index;
120
121 /** Flags */
122 u32 flags;
123
124 /** Callbacks: shoulder-taps for the server/client */
125 session_cb_vft_t cb_fns;
126
127 /** Segment manager properties. Shared by all segment managers */
128 segment_manager_properties_t sm_properties;
129
130 /** Pool of mappings that keep track of workers associated to this app */
131 app_worker_map_t *worker_maps;
132
133 /** Name registered by builtin apps */
134 u8 *name;
135
136 /** Namespace the application belongs to */
137 u32 ns_index;
138
139 u16 proxied_transports;
140
Florin Coras371ca502018-02-21 12:07:41 -0800141 /*
142 * TLS Specific
143 */
144
145 /** Certificate to be used for listen sessions */
146 u8 *tls_cert;
147
148 /** PEM encoded key */
149 u8 *tls_key;
Florin Coras58d36f02018-03-09 13:05:53 -0800150
151 /** Preferred tls engine */
152 u8 tls_engine;
Dave Barach68b0fb02017-02-28 15:15:56 -0500153} application_t;
154
Florin Coras15531972018-08-12 23:50:53 -0700155typedef struct app_main_
156{
157 /**
158 * Pool from which we allocate all applications
159 */
160 application_t *app_pool;
161
162 /**
163 * Pool of workers associated to apps
164 */
165 app_worker_t *workers;
166
167 /**
168 * Hash table of apps by api client index
169 */
170 uword *app_by_api_client_index;
171
172 /**
173 * Hash table of builtin apps by name
174 */
175 uword *app_by_name;
176} app_main_t;
177
178#define foreach_app_init_args \
179 _(u32, api_client_index) \
180 _(u8 *, name) \
181 _(u64 *, options) \
182 _(u8 *, namespace_id) \
183 _(session_cb_vft_t *, session_cb_vft) \
184 _(u32, app_index) \
185
186typedef struct app_init_args_
187{
188#define _(_type, _name) _type _name;
189 foreach_app_init_args
190#undef _
191} app_init_args_t;
192
193typedef struct _vnet_app_worker_add_del_args
194{
195 u32 app_index; /**< App for which a new worker is requested */
196 u32 wrk_index; /**< Index to delete or return value if add */
197 ssvm_private_t *segment; /**< First segment in segment manager */
198 svm_msg_q_t *evt_q; /**< Worker message queue */
199 u8 is_add; /**< Flag set if addition */
200} vnet_app_worker_add_del_args_t;
201
Florin Corascea194d2017-10-02 00:18:51 -0700202#define APP_INVALID_INDEX ((u32)~0)
203#define APP_NS_INVALID_INDEX ((u32)~0)
Florin Corasc87c91d2017-08-16 19:55:49 -0700204#define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
205
Florin Coras15531972018-08-12 23:50:53 -0700206app_worker_t *app_worker_alloc (application_t * app);
207int app_worker_alloc_and_init (application_t * app, app_worker_t ** wrk);
208app_worker_t *app_worker_get (u32 wrk_index);
209app_worker_t *app_worker_get_if_valid (u32 wrk_index);
210void app_worker_free (app_worker_t * app_wrk);
211int app_worker_start_listen (app_worker_t * app,
212 session_endpoint_t * tep,
213 session_handle_t * handle);
214int app_worker_stop_listen (session_handle_t handle, u32 app_wrk_index);
215int app_worker_open_session (app_worker_t * app, session_endpoint_t * tep,
216 u32 api_context);
217segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *,
218 stream_session_t *);
219segment_manager_t *app_worker_get_connect_segment_manager (app_worker_t *);
220int app_worker_alloc_connects_segment_manager (app_worker_t * app);
221int app_worker_add_segment_notify (u32 app_wrk_index, ssvm_private_t * fs);
222u32 app_worker_n_listeners (app_worker_t * app);
223stream_session_t *app_worker_first_listener (app_worker_t * app,
224 u8 fib_proto,
225 u8 transport_proto);
226u8 app_worker_application_is_builtin (app_worker_t * app_wrk);
227clib_error_t *vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a);
228
229application_t *application_alloc (void);
230int application_alloc_and_init (app_init_args_t * args);
231void application_free (application_t * app);
Dave Barach68b0fb02017-02-28 15:15:56 -0500232application_t *application_get (u32 index);
Florin Corase04c2992017-03-01 08:17:34 -0800233application_t *application_get_if_valid (u32 index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500234application_t *application_lookup (u32 api_client_index);
Florin Coras0bee9ce2018-03-22 21:24:31 -0700235application_t *application_lookup_name (const u8 * name);
Florin Coras15531972018-08-12 23:50:53 -0700236u32 application_index (application_t * app);
237app_worker_t *application_get_worker (application_t * app, u32 wrk_index);
238app_worker_t *application_get_default_worker (application_t * app);
Dave Barach68b0fb02017-02-28 15:15:56 -0500239int application_api_queue_is_full (application_t * app);
240
Florin Coras371ca502018-02-21 12:07:41 -0800241
Dave Barach52851e62017-08-07 09:35:25 -0400242int application_is_proxy (application_t * app);
Florin Coras7999e832017-10-31 01:51:04 -0700243int application_is_builtin (application_t * app);
244int application_is_builtin_proxy (application_t * app);
Florin Corascea194d2017-10-02 00:18:51 -0700245u32 application_session_table (application_t * app, u8 fib_proto);
246u32 application_local_session_table (application_t * app);
Florin Coras15531972018-08-12 23:50:53 -0700247u8 *application_name_from_index (u32 app_wrk_index);
Florin Corascea194d2017-10-02 00:18:51 -0700248u8 application_has_local_scope (application_t * app);
249u8 application_has_global_scope (application_t * app);
Florin Coras60116992018-08-27 09:52:18 -0700250u8 application_use_mq_for_ctrl (application_t * app);
Florin Coras7999e832017-10-31 01:51:04 -0700251void application_setup_proxy (application_t * app);
252void application_remove_proxy (application_t * app);
253
Florin Corasa332c462018-01-31 06:52:17 -0800254segment_manager_properties_t *application_get_segment_manager_properties (u32
Florin Coras15531972018-08-12 23:50:53 -0700255 app_wrk_index);
Florin Corasa332c462018-01-31 06:52:17 -0800256segment_manager_properties_t
257 * application_segment_manager_properties (application_t * app);
258
Florin Coras15531972018-08-12 23:50:53 -0700259local_session_t *application_alloc_local_session (app_worker_t * app);
260void application_free_local_session (app_worker_t * app,
Florin Corasf8f516a2018-02-08 15:10:09 -0800261 local_session_t * ls);
Florin Coras15531972018-08-12 23:50:53 -0700262local_session_t *application_get_local_session (app_worker_t * app,
Florin Corasf8f516a2018-02-08 15:10:09 -0800263 u32 session_index);
264local_session_t *application_get_local_session_from_handle (session_handle_t
265 handle);
Florin Coras60116992018-08-27 09:52:18 -0700266local_session_t
267 * application_get_local_listen_session_from_handle (session_handle_t lh);
Florin Coras15531972018-08-12 23:50:53 -0700268int application_start_local_listen (app_worker_t * server,
269 session_endpoint_t * sep,
270 session_handle_t * handle);
271int application_stop_local_listen (session_handle_t lh, u32 app_wrk_index);
272int application_local_session_connect (app_worker_t * client,
273 app_worker_t * server,
Florin Corasf8f516a2018-02-08 15:10:09 -0800274 local_session_t * ll, u32 opaque);
275int application_local_session_connect_notify (local_session_t * ls);
Florin Coras15531972018-08-12 23:50:53 -0700276int application_local_session_disconnect (u32 app_wrk_index,
Florin Corasf8f516a2018-02-08 15:10:09 -0800277 local_session_t * ls);
Florin Coras15531972018-08-12 23:50:53 -0700278int application_local_session_disconnect_w_index (u32 app_wrk_index,
Florin Corasf6647e02018-03-23 22:56:43 -0700279 u32 ls_index);
Florin Coras15531972018-08-12 23:50:53 -0700280void application_local_sessions_free (app_worker_t * app);
Florin Corasf8f516a2018-02-08 15:10:09 -0800281
Florin Coras15531972018-08-12 23:50:53 -0700282int application_send_event (app_worker_t * app, stream_session_t * s, u8 evt);
283int application_lock_and_send_event (app_worker_t * app,
Florin Coras3c2fed52018-07-04 04:15:05 -0700284 stream_session_t * s, u8 evt_type);
285
Florin Corasf8f516a2018-02-08 15:10:09 -0800286always_inline u32
287local_session_id (local_session_t * ll)
288{
Florin Coras15531972018-08-12 23:50:53 -0700289 ASSERT (ll->app_wrk_index < (2 << 16) && ll->session_index < (2 << 16));
290 return ((u32) ll->app_wrk_index << 16 | (u32) ll->session_index);
Florin Corasf8f516a2018-02-08 15:10:09 -0800291}
292
293always_inline void
Florin Coras15531972018-08-12 23:50:53 -0700294local_session_parse_id (u32 ls_id, u32 * app_wrk_index, u32 * session_index)
Florin Corasf8f516a2018-02-08 15:10:09 -0800295{
Florin Coras15531972018-08-12 23:50:53 -0700296 *app_wrk_index = ls_id >> 16;
Florin Corasf8f516a2018-02-08 15:10:09 -0800297 *session_index = ls_id & 0xFFF;
298}
299
300always_inline void
301local_session_parse_handle (session_handle_t handle, u32 * server_index,
302 u32 * session_index)
303{
304 u32 bottom;
Florin Coras5fda7a32018-02-14 08:04:31 -0800305 ASSERT ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX);
Florin Corasf8f516a2018-02-08 15:10:09 -0800306 bottom = (handle & 0xFFFFFFFF);
307 local_session_parse_id (bottom, server_index, session_index);
308}
309
310always_inline session_handle_t
311application_local_session_handle (local_session_t * ls)
312{
Florin Coras5fda7a32018-02-14 08:04:31 -0800313 return ((u64) SESSION_LOCAL_HANDLE_PREFIX << 32)
314 | (u64) local_session_id (ls);
Florin Corasf8f516a2018-02-08 15:10:09 -0800315}
316
317always_inline local_session_t *
Florin Coras15531972018-08-12 23:50:53 -0700318application_get_local_listen_session (app_worker_t * app, u32 session_index)
Florin Corasf8f516a2018-02-08 15:10:09 -0800319{
320 return pool_elt_at_index (app->local_listen_sessions, session_index);
321}
322
Florin Coras5fda7a32018-02-14 08:04:31 -0800323always_inline local_session_t *
324application_get_local_listener_w_handle (session_handle_t handle)
325{
Florin Coras15531972018-08-12 23:50:53 -0700326 u32 server_wrk_index, session_index;
327 app_worker_t *app;
328 local_session_parse_handle (handle, &server_wrk_index, &session_index);
329 app = app_worker_get (server_wrk_index);
Florin Coras5fda7a32018-02-14 08:04:31 -0800330 return application_get_local_listen_session (app, session_index);
331}
332
Florin Corasf8f516a2018-02-08 15:10:09 -0800333always_inline u8
334application_local_session_listener_has_transport (local_session_t * ls)
335{
336 transport_proto_t tp;
337 tp = session_type_transport_proto (ls->listener_session_type);
338 return (tp != TRANSPORT_PROTO_NONE);
339}
340
Florin Coras15531972018-08-12 23:50:53 -0700341void mq_send_local_session_disconnected_cb (u32 app_wrk_index,
Florin Coras99368312018-08-02 10:45:44 -0700342 local_session_t * ls);
Florin Coras371ca502018-02-21 12:07:41 -0800343
Florin Coras371ca502018-02-21 12:07:41 -0800344uword unformat_application_proto (unformat_input_t * input, va_list * args);
Florin Corasf8f516a2018-02-08 15:10:09 -0800345
Dave Barach68b0fb02017-02-28 15:15:56 -0500346#endif /* SRC_VNET_SESSION_APPLICATION_H_ */
347
348/*
349 * fd.io coding-style-patch-verification: ON
350 *
351 * Local Variables:
352 * eval: (c-set-style "gnu")
353 * End:
354 */