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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef SRC_VNET_SESSION_APPLICATION_H_
17 #define SRC_VNET_SESSION_APPLICATION_H_
19 #include <vnet/session/session.h>
20 #include <vnet/session/segment_manager.h>
21 #include <vnet/session/application_namespace.h>
26 #define APP_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
28 #define APP_DBG(_fmt, _args...)
31 typedef struct _stream_session_cb_vft
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);
40 /** Notify server of newly accepted session */
41 int (*session_accept_callback) (stream_session_t * new_session);
43 /** Connection request callback */
44 int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
45 stream_session_t * s, u8 code);
47 /** Notify app that session is closing */
48 void (*session_disconnect_callback) (stream_session_t * s);
50 /** Notify app that session was reset */
51 void (*session_reset_callback) (stream_session_t * s);
53 /** Direct RX callback for built-in application */
54 int (*builtin_app_rx_callback) (stream_session_t * session);
56 /** Direct TX callback for built-in application */
57 int (*builtin_app_tx_callback) (stream_session_t * session);
61 typedef struct app_worker_
63 /** Worker index in global worker pool*/
66 /** Worker index in app's map pool */
69 /** Index of owning app */
72 /** Application listens for events on this svm queue */
73 svm_msg_q_t *event_queue;
75 /** Segment manager used for outgoing connects issued by the app */
76 u32 connects_seg_manager;
78 /** Lookup tables for listeners. Value is segment manager index */
79 uword *listeners_table;
82 * First segment manager has in the the first segment the application's
83 * event fifo. Depending on what the app does, it may be either used for
84 * a listener or for connects.
86 u32 first_segment_manager;
87 u8 first_segment_manager_in_use;
90 * Local "cut through" connections specific
93 /** Segment manager used for incoming "cut through" connects */
94 u32 local_segment_manager;
96 /** Pool of local listen sessions */
97 local_session_t *local_listen_sessions;
99 /** Pool of local sessions the app owns (as a server) */
100 local_session_t *local_sessions;
102 /** Hash table of the app's local connects */
103 uword *local_connects;
108 typedef struct app_worker_map_
113 typedef struct application_
115 /** App index in app pool */
118 /** Binary API connection index, ~0 if internal */
119 u32 api_client_index;
124 /** Callbacks: shoulder-taps for the server/client */
125 session_cb_vft_t cb_fns;
127 /** Segment manager properties. Shared by all segment managers */
128 segment_manager_properties_t sm_properties;
130 /** Pool of mappings that keep track of workers associated to this app */
131 app_worker_map_t *worker_maps;
133 /** Name registered by builtin apps */
136 /** Namespace the application belongs to */
139 u16 proxied_transports;
145 /** Certificate to be used for listen sessions */
148 /** PEM encoded key */
151 /** Preferred tls engine */
155 typedef struct app_main_
158 * Pool from which we allocate all applications
160 application_t *app_pool;
163 * Pool of workers associated to apps
165 app_worker_t *workers;
168 * Hash table of apps by api client index
170 uword *app_by_api_client_index;
173 * Hash table of builtin apps by name
178 #define foreach_app_init_args \
179 _(u32, api_client_index) \
182 _(u8 *, namespace_id) \
183 _(session_cb_vft_t *, session_cb_vft) \
186 typedef struct app_init_args_
188 #define _(_type, _name) _type _name;
189 foreach_app_init_args
193 typedef struct _vnet_app_worker_add_del_args
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;
202 #define APP_INVALID_INDEX ((u32)~0)
203 #define APP_NS_INVALID_INDEX ((u32)~0)
204 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
206 app_worker_t *app_worker_alloc (application_t * app);
207 int app_worker_alloc_and_init (application_t * app, app_worker_t ** wrk);
208 app_worker_t *app_worker_get (u32 wrk_index);
209 app_worker_t *app_worker_get_if_valid (u32 wrk_index);
210 void app_worker_free (app_worker_t * app_wrk);
211 int app_worker_start_listen (app_worker_t * app,
212 session_endpoint_t * tep,
213 session_handle_t * handle);
214 int app_worker_stop_listen (session_handle_t handle, u32 app_wrk_index);
215 int app_worker_open_session (app_worker_t * app, session_endpoint_t * tep,
217 segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *,
219 segment_manager_t *app_worker_get_connect_segment_manager (app_worker_t *);
220 int app_worker_alloc_connects_segment_manager (app_worker_t * app);
221 int app_worker_add_segment_notify (u32 app_wrk_index, ssvm_private_t * fs);
222 u32 app_worker_n_listeners (app_worker_t * app);
223 stream_session_t *app_worker_first_listener (app_worker_t * app,
226 u8 app_worker_application_is_builtin (app_worker_t * app_wrk);
227 clib_error_t *vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a);
229 application_t *application_alloc (void);
230 int application_alloc_and_init (app_init_args_t * args);
231 void application_free (application_t * app);
232 application_t *application_get (u32 index);
233 application_t *application_get_if_valid (u32 index);
234 application_t *application_lookup (u32 api_client_index);
235 application_t *application_lookup_name (const u8 * name);
236 u32 application_index (application_t * app);
237 app_worker_t *application_get_worker (application_t * app, u32 wrk_index);
238 app_worker_t *application_get_default_worker (application_t * app);
239 int application_api_queue_is_full (application_t * app);
242 int application_is_proxy (application_t * app);
243 int application_is_builtin (application_t * app);
244 int application_is_builtin_proxy (application_t * app);
245 u32 application_session_table (application_t * app, u8 fib_proto);
246 u32 application_local_session_table (application_t * app);
247 u8 *application_name_from_index (u32 app_wrk_index);
248 u8 application_has_local_scope (application_t * app);
249 u8 application_has_global_scope (application_t * app);
250 u8 application_use_mq_for_ctrl (application_t * app);
251 void application_setup_proxy (application_t * app);
252 void application_remove_proxy (application_t * app);
254 segment_manager_properties_t *application_get_segment_manager_properties (u32
256 segment_manager_properties_t
257 * application_segment_manager_properties (application_t * app);
259 local_session_t *application_alloc_local_session (app_worker_t * app);
260 void application_free_local_session (app_worker_t * app,
261 local_session_t * ls);
262 local_session_t *application_get_local_session (app_worker_t * app,
264 local_session_t *application_get_local_session_from_handle (session_handle_t
267 * application_get_local_listen_session_from_handle (session_handle_t lh);
268 int application_start_local_listen (app_worker_t * server,
269 session_endpoint_t * sep,
270 session_handle_t * handle);
271 int application_stop_local_listen (session_handle_t lh, u32 app_wrk_index);
272 int application_local_session_connect (app_worker_t * client,
273 app_worker_t * server,
274 local_session_t * ll, u32 opaque);
275 int application_local_session_connect_notify (local_session_t * ls);
276 int application_local_session_disconnect (u32 app_wrk_index,
277 local_session_t * ls);
278 int application_local_session_disconnect_w_index (u32 app_wrk_index,
280 void application_local_sessions_free (app_worker_t * app);
282 int application_send_event (app_worker_t * app, stream_session_t * s, u8 evt);
283 int application_lock_and_send_event (app_worker_t * app,
284 stream_session_t * s, u8 evt_type);
287 local_session_id (local_session_t * ll)
289 ASSERT (ll->app_wrk_index < (2 << 16) && ll->session_index < (2 << 16));
290 return ((u32) ll->app_wrk_index << 16 | (u32) ll->session_index);
294 local_session_parse_id (u32 ls_id, u32 * app_wrk_index, u32 * session_index)
296 *app_wrk_index = ls_id >> 16;
297 *session_index = ls_id & 0xFFF;
301 local_session_parse_handle (session_handle_t handle, u32 * server_index,
305 ASSERT ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX);
306 bottom = (handle & 0xFFFFFFFF);
307 local_session_parse_id (bottom, server_index, session_index);
310 always_inline session_handle_t
311 application_local_session_handle (local_session_t * ls)
313 return ((u64) SESSION_LOCAL_HANDLE_PREFIX << 32)
314 | (u64) local_session_id (ls);
317 always_inline local_session_t *
318 application_get_local_listen_session (app_worker_t * app, u32 session_index)
320 return pool_elt_at_index (app->local_listen_sessions, session_index);
323 always_inline local_session_t *
324 application_get_local_listener_w_handle (session_handle_t handle)
326 u32 server_wrk_index, session_index;
328 local_session_parse_handle (handle, &server_wrk_index, &session_index);
329 app = app_worker_get (server_wrk_index);
330 return application_get_local_listen_session (app, session_index);
334 application_local_session_listener_has_transport (local_session_t * ls)
336 transport_proto_t tp;
337 tp = session_type_transport_proto (ls->listener_session_type);
338 return (tp != TRANSPORT_PROTO_NONE);
341 void mq_send_local_session_disconnected_cb (u32 app_wrk_index,
342 local_session_t * ls);
344 uword unformat_application_proto (unformat_input_t * input, va_list * args);
346 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
349 * fd.io coding-style-patch-verification: ON
352 * eval: (c-set-style "gnu")