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:
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, u64 segment_handle);
36 /** Notify server of new segment */
37 int (*del_segment_callback) (u32 api_client_index, u64 segment_handle);
39 /** Notify server of newly accepted session */
40 int (*session_accept_callback) (session_t * new_session);
42 /** Connection request callback */
43 int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
44 session_t * s, u8 code);
46 /** Notify app that session is closing */
47 void (*session_disconnect_callback) (session_t * s);
49 /** Notify app that session was reset */
50 void (*session_reset_callback) (session_t * s);
52 /** Direct RX callback for built-in application */
53 int (*builtin_app_rx_callback) (session_t * session);
55 /** Direct TX callback for built-in application */
56 int (*builtin_app_tx_callback) (session_t * session);
60 typedef struct app_worker_
62 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
64 /** Worker index in global worker pool*/
67 /** Worker index in app's map pool */
70 /** Index of owning app */
73 /** Application listens for events on this svm queue */
74 svm_msg_q_t *event_queue;
76 /** Segment manager used for outgoing connects issued by the app */
77 u32 connects_seg_manager;
79 /** Lookup tables for listeners. Value is segment manager index */
80 uword *listeners_table;
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.
87 u32 first_segment_manager;
88 u8 first_segment_manager_in_use;
91 * Local "cut through" connections specific
94 /** Segment manager used for incoming "cut through" connects */
95 u32 local_segment_manager;
97 /** Pool of local sessions the app owns (as a server) */
98 local_session_t *local_sessions;
100 /** Hash table of the app's local connects */
101 uword *local_connects;
103 /** API index for the worker. Needed for multi-process apps */
104 u32 api_client_index;
109 typedef struct app_worker_map_
114 typedef struct app_listener_
116 clib_bitmap_t *workers; /**< workers accepting connections */
117 u32 accept_rotor; /**< last worker to accept a connection */
121 typedef struct application_
123 /** App index in app pool */
129 /** Callbacks: shoulder-taps for the server/client */
130 session_cb_vft_t cb_fns;
132 /** Segment manager properties. Shared by all segment managers */
133 segment_manager_properties_t sm_properties;
135 /** Pool of mappings that keep track of workers associated to this app */
136 app_worker_map_t *worker_maps;
138 /** Name registered by builtin apps */
141 /** Namespace the application belongs to */
144 u16 proxied_transports;
146 /** Pool of listeners for the app */
147 app_listener_t *listeners;
149 /** Pool of local listeners for app */
150 app_listener_t *local_listeners;
152 /** Pool of local listen sessions */
153 local_session_t *local_listen_sessions;
159 /** Certificate to be used for listen sessions */
162 /** PEM encoded key */
165 /** Preferred tls engine */
170 typedef struct app_main_
173 * Pool from which we allocate all applications
175 application_t *app_pool;
178 * Pool of workers associated to apps
180 app_worker_t *workers;
183 * Hash table of apps by api client index
185 uword *app_by_api_client_index;
188 * Hash table of builtin apps by name
193 #define foreach_app_init_args \
194 _(u32, api_client_index) \
197 _(u8 *, namespace_id) \
198 _(session_cb_vft_t *, session_cb_vft) \
201 typedef struct app_init_args_
203 #define _(_type, _name) _type _name;
204 foreach_app_init_args
208 typedef struct _vnet_app_worker_add_del_args
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;
219 #define APP_INVALID_INDEX ((u32)~0)
220 #define APP_NS_INVALID_INDEX ((u32)~0)
221 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
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, 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,
232 segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *,
234 segment_manager_t *app_worker_get_connect_segment_manager (app_worker_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 session_t *app_worker_first_listener (app_worker_t * app,
241 u8 fib_proto, u8 transport_proto);
242 u8 app_worker_application_is_builtin (app_worker_t * app_wrk);
243 int app_worker_send_event (app_worker_t * app, session_t * s, u8 evt);
244 int app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
246 clib_error_t *vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a);
248 int application_start_listen (application_t * app,
249 session_endpoint_cfg_t * tep,
250 session_handle_t * handle);
251 int application_stop_listen (u32 app_index, u32 app_or_wrk,
252 session_handle_t handle);
254 application_t *application_alloc (void);
255 int application_alloc_and_init (app_init_args_t * args);
256 void application_free (application_t * app);
257 void application_detach_process (application_t * app, u32 api_client_index);
258 application_t *application_get (u32 index);
259 application_t *application_get_if_valid (u32 index);
260 application_t *application_lookup (u32 api_client_index);
261 application_t *application_lookup_name (const u8 * name);
262 app_worker_t *application_get_worker (application_t * app, u32 wrk_index);
263 app_worker_t *application_get_default_worker (application_t * app);
264 app_worker_t *application_listener_select_worker (session_t * ls,
267 int application_is_proxy (application_t * app);
268 int application_is_builtin (application_t * app);
269 int application_is_builtin_proxy (application_t * app);
270 u32 application_session_table (application_t * app, u8 fib_proto);
271 u32 application_local_session_table (application_t * app);
272 const u8 *application_name_from_index (u32 app_or_wrk);
273 u8 application_has_local_scope (application_t * app);
274 u8 application_has_global_scope (application_t * app);
275 u8 application_use_mq_for_ctrl (application_t * app);
276 void application_setup_proxy (application_t * app);
277 void application_remove_proxy (application_t * app);
279 segment_manager_properties_t *application_get_segment_manager_properties (u32
282 segment_manager_properties_t
283 * application_segment_manager_properties (application_t * app);
289 local_session_t *application_local_session_alloc (app_worker_t * app);
290 void application_local_session_free (app_worker_t * app,
291 local_session_t * ls);
292 local_session_t *application_get_local_session (app_worker_t * app,
294 local_session_t *application_get_local_session_from_handle (session_handle_t
297 * application_get_local_listen_session_from_handle (session_handle_t lh);
298 int application_start_local_listen (application_t * server,
299 session_endpoint_cfg_t * sep,
300 session_handle_t * handle);
301 int application_stop_local_listen (u32 app_index, u32 app_or_wrk,
302 session_handle_t lh);
303 int application_local_session_connect (app_worker_t * client,
304 app_worker_t * server,
305 local_session_t * ls, u32 opaque);
306 int application_local_session_connect_notify (local_session_t * ls);
307 int application_local_session_disconnect (u32 app_or_wrk,
308 local_session_t * ls);
309 int application_local_session_disconnect_w_index (u32 app_or_wrk,
311 void app_worker_local_sessions_free (app_worker_t * app);
314 local_session_id (local_session_t * ls)
316 ASSERT (ls->session_index < (2 << 16));
317 u32 app_or_wrk_index;
319 if (ls->session_state == SESSION_STATE_LISTENING)
321 ASSERT (ls->app_index < (2 << 16));
322 app_or_wrk_index = ls->app_index;
326 ASSERT (ls->app_wrk_index < (2 << 16));
327 app_or_wrk_index = ls->app_wrk_index;
330 return ((u32) app_or_wrk_index << 16 | (u32) ls->session_index);
334 local_session_parse_id (u32 ls_id, u32 * app_or_wrk, u32 * session_index)
336 *app_or_wrk = ls_id >> 16;
337 *session_index = ls_id & 0xFF;
341 local_session_parse_handle (session_handle_t handle, u32 * app_or_wrk_index,
345 ASSERT ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX);
346 bottom = (handle & 0xFFFFFFFF);
347 local_session_parse_id (bottom, app_or_wrk_index, session_index);
350 always_inline session_handle_t
351 application_local_session_handle (local_session_t * ls)
353 return ((u64) SESSION_LOCAL_HANDLE_PREFIX << 32)
354 | (u64) local_session_id (ls);
357 always_inline local_session_t *
358 application_get_local_listen_session (application_t * app, u32 session_index)
360 return pool_elt_at_index (app->local_listen_sessions, session_index);
363 always_inline local_session_t *
364 application_get_local_listener_w_handle (session_handle_t handle)
366 u32 server_index, session_index;
368 local_session_parse_handle (handle, &server_index, &session_index);
369 app = application_get (server_index);
370 return application_get_local_listen_session (app, session_index);
374 application_local_session_listener_has_transport (local_session_t * ls)
376 transport_proto_t tp;
377 tp = session_type_transport_proto (ls->listener_session_type);
378 return (tp != TRANSPORT_PROTO_NONE);
381 void mq_send_local_session_disconnected_cb (u32 app_or_wrk,
382 local_session_t * ls);
384 uword unformat_application_proto (unformat_input_t * input, va_list * args);
386 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
389 * fd.io coding-style-patch-verification: ON
392 * eval: (c-set-style "gnu")