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/application_interface.h>
20 #include <vnet/session/application_namespace.h>
21 #include <vnet/session/session_types.h>
22 #include <vnet/session/segment_manager.h>
27 #define APP_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
29 #define APP_DBG(_fmt, _args...)
32 typedef struct app_worker_
34 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
36 /** Worker index in global worker pool*/
39 /** Worker index in app's map pool */
42 /** Index of owning app */
45 /** Application listens for events on this svm queue */
46 svm_msg_q_t *event_queue;
48 /** Segment manager used for outgoing connects issued by the app */
49 u32 connects_seg_manager;
51 /** Lookup tables for listeners. Value is segment manager index */
52 uword *listeners_table;
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.
59 u32 first_segment_manager;
60 u8 first_segment_manager_in_use;
62 /** API index for the worker. Needed for multi-process apps */
67 /** Per transport proto hash tables of half-open connection handles */
68 uword **half_open_table;
70 /** Protects detached seg managers */
71 clib_spinlock_t detached_seg_managers_lock;
73 /** Vector of detached listener segment managers */
74 u32 *detached_seg_managers;
77 typedef struct app_worker_map_
82 typedef struct app_listener_
84 clib_bitmap_t *workers; /**< workers accepting connections */
85 u32 accept_rotor; /**< last worker to accept a connection */
86 u32 al_index; /**< app listener index in app pool */
87 u32 app_index; /**< owning app index */
88 u32 local_index; /**< local listening session index */
89 u32 session_index; /**< global listening session index */
90 session_handle_t ls_handle; /**< session handle of the local or global
91 listening session that also identifies
95 typedef enum app_rx_mq_flags_
97 APP_RX_MQ_F_PENDING = 1 << 0,
98 APP_RX_MQ_F_POSTPONED = 1 << 1,
101 typedef struct app_rx_mq_elt_
103 struct app_rx_mq_elt_ *next;
104 struct app_rx_mq_elt_ *prev;
111 typedef struct application_
113 /** App index in app pool */
119 /** Callbacks: shoulder-taps for the server/client */
120 session_cb_vft_t cb_fns;
122 /** Segment manager properties. Shared by all segment managers */
123 segment_manager_props_t sm_properties;
125 /** Pool of mappings that keep track of workers associated to this app */
126 app_worker_map_t *worker_maps;
128 /** Name registered by builtin apps */
131 /** Namespace the application belongs to */
134 u16 proxied_transports;
136 /** Pool of listeners for the app */
137 app_listener_t *listeners;
139 /** Preferred tls engine */
142 /** quic initialization vector */
146 /** Segment where rx mqs were allocated */
147 fifo_segment_t rx_mqs_segment;
150 * Fixed vector of rx mqs that can be a part of pending_rx_mqs
151 * linked list maintained by the app sublayer for each worker
153 app_rx_mq_elt_t *rx_mqs;
156 typedef struct app_rx_mq_handle_
167 } __attribute__ ((aligned (sizeof (u64)))) app_rx_mq_handle_t;
170 * App sublayer per vpp worker state
172 typedef struct asl_wrk_
174 /** Linked list of mqs with pending messages */
175 app_rx_mq_elt_t *pending_rx_mqs;
178 typedef struct app_main_
181 * Pool from which we allocate all applications
183 application_t *app_pool;
186 * Hash table of apps by api client index
188 uword *app_by_api_client_index;
191 * Hash table of builtin apps by name
196 * Pool from which we allocate certificates (key, cert)
198 app_cert_key_pair_t *cert_key_pair_store;
201 * Last registered crypto engine type
203 crypto_engine_type_t last_crypto_engine;
206 * App sublayer per-worker state
211 typedef struct app_init_args_
213 #define _(_type, _name) _type _name;
214 foreach_app_init_args
218 typedef struct _vnet_app_worker_add_del_args
220 u32 app_index; /**< App for which a new worker is requested */
221 u32 wrk_map_index; /**< Index to delete or return value if add */
222 u32 api_client_index; /**< Binary API client index */
223 ssvm_private_t *segment; /**< First segment in segment manager */
224 u64 segment_handle; /**< Handle for the segment */
225 svm_msg_q_t *evt_q; /**< Worker message queue */
226 u8 is_add; /**< Flag set if addition */
227 } vnet_app_worker_add_del_args_t;
229 #define APP_INVALID_INDEX ((u32)~0)
230 #define APP_NS_INVALID_INDEX ((u32)~0)
231 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
233 app_listener_t *app_listener_get (application_t * app, u32 al_index);
234 int app_listener_alloc_and_init (application_t * app,
235 session_endpoint_cfg_t * sep,
236 app_listener_t ** listener);
237 void app_listener_cleanup (app_listener_t * app_listener);
238 session_handle_t app_listener_handle (app_listener_t * app_listener);
239 app_listener_t *app_listener_lookup (application_t * app,
240 session_endpoint_cfg_t * sep);
243 * Get app listener handle for listening session
245 * For a given listening session, this can return either the session
246 * handle of the app listener associated to the listening session or,
247 * if no such app listener exists, the session's handle
249 * @param ls listening session
250 * @return app listener or listening session handle
252 session_handle_t app_listen_session_handle (session_t * ls);
254 * Get app listener for listener session handle
256 * Should only be called on handles that have an app listener, i.e.,
257 * were obtained at the end of a @ref vnet_listen call.
259 * @param handle handle of the app listener. This is the handle of
260 * either the global or local listener
261 * @return pointer to app listener or 0
263 app_listener_t *app_listener_get_w_handle (session_handle_t handle);
264 app_listener_t *app_listener_get_w_session (session_t * ls);
265 session_t *app_listener_get_session (app_listener_t * al);
266 session_t *app_listener_get_local_session (app_listener_t * al);
268 application_t *application_get (u32 index);
269 application_t *application_get_if_valid (u32 index);
270 application_t *application_lookup (u32 api_client_index);
271 application_t *application_lookup_name (const u8 * name);
272 app_worker_t *application_get_worker (application_t * app, u32 wrk_index);
273 app_worker_t *application_get_default_worker (application_t * app);
274 app_worker_t *application_listener_select_worker (session_t * ls);
275 int application_change_listener_owner (session_t * s, app_worker_t * app_wrk);
276 int application_is_proxy (application_t * app);
277 int application_is_builtin (application_t * app);
278 int application_is_builtin_proxy (application_t * app);
279 u32 application_session_table (application_t * app, u8 fib_proto);
280 u32 application_local_session_table (application_t * app);
281 const u8 *application_name_from_index (u32 app_or_wrk);
282 u8 application_has_local_scope (application_t * app);
283 u8 application_has_global_scope (application_t * app);
284 void application_setup_proxy (application_t * app);
285 void application_remove_proxy (application_t * app);
287 segment_manager_props_t *application_get_segment_manager_properties (u32
290 segment_manager_props_t
291 * application_segment_manager_properties (application_t * app);
293 svm_msg_q_t *application_rx_mq_get (application_t *app, u32 mq_index);
294 u8 application_use_private_rx_mqs (void);
295 fifo_segment_t *application_get_rx_mqs_segment (application_t *app);
296 void application_enable_rx_mqs_nodes (u8 is_en);
302 app_worker_t *app_worker_alloc (application_t * app);
303 int application_alloc_worker_and_init (application_t * app,
304 app_worker_t ** wrk);
305 app_worker_t *app_worker_get (u32 wrk_index);
306 app_worker_t *app_worker_get_if_valid (u32 wrk_index);
307 application_t *app_worker_get_app (u32 wrk_index);
308 int app_worker_own_session (app_worker_t * app_wrk, session_t * s);
309 void app_worker_free (app_worker_t * app_wrk);
310 int app_worker_connect_session (app_worker_t * app, session_endpoint_t * tep,
312 int app_worker_start_listen (app_worker_t * app_wrk, app_listener_t * lstnr);
313 int app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al);
314 int app_worker_init_accepted (session_t * s);
315 int app_worker_accept_notify (app_worker_t * app_wrk, session_t * s);
316 int app_worker_init_connected (app_worker_t * app_wrk, session_t * s);
317 int app_worker_connect_notify (app_worker_t * app_wrk, session_t * s,
318 session_error_t err, u32 opaque);
319 int app_worker_add_half_open (app_worker_t * app_wrk, transport_proto_t tp,
320 session_handle_t ho_handle,
321 session_handle_t wrk_handle);
322 int app_worker_del_half_open (app_worker_t * app_wrk, transport_proto_t tp,
323 session_handle_t ho_handle);
324 u64 app_worker_lookup_half_open (app_worker_t * app_wrk, transport_proto_t tp,
325 session_handle_t ho_handle);
326 int app_worker_close_notify (app_worker_t * app_wrk, session_t * s);
327 int app_worker_transport_closed_notify (app_worker_t * app_wrk,
329 int app_worker_reset_notify (app_worker_t * app_wrk, session_t * s);
330 int app_worker_cleanup_notify (app_worker_t * app_wrk, session_t * s,
331 session_cleanup_ntf_t ntf);
332 int app_worker_migrate_notify (app_worker_t * app_wrk, session_t * s,
333 session_handle_t new_sh);
334 int app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s);
335 int app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s);
336 int app_worker_session_fifo_tuning (app_worker_t * app_wrk, session_t * s,
338 session_ft_action_t act, u32 len);
339 segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *,
341 segment_manager_t *app_worker_get_connect_segment_manager (app_worker_t *);
343 * app_worker_get_or_alloc_connect_segment_manager (app_worker_t *);
344 int app_worker_alloc_connects_segment_manager (app_worker_t * app);
345 int app_worker_add_segment_notify (app_worker_t * app_wrk,
347 int app_worker_del_segment_notify (app_worker_t * app_wrk,
349 u32 app_worker_n_listeners (app_worker_t * app);
350 session_t *app_worker_first_listener (app_worker_t * app,
351 u8 fib_proto, u8 transport_proto);
352 int app_worker_send_event (app_worker_t * app, session_t * s, u8 evt);
353 int app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
355 session_t *app_worker_proxy_listener (app_worker_t * app, u8 fib_proto,
357 void app_worker_del_detached_sm (app_worker_t * app_wrk, u32 sm_index);
358 u8 *format_app_worker (u8 * s, va_list * args);
359 u8 *format_app_worker_listener (u8 * s, va_list * args);
360 u8 *format_crypto_engine (u8 * s, va_list * args);
361 u8 *format_crypto_context (u8 * s, va_list * args);
362 void app_worker_format_connects (app_worker_t * app_wrk, int verbose);
363 int vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a);
365 uword unformat_application_proto (unformat_input_t * input, va_list * args);
367 app_cert_key_pair_t *app_cert_key_pair_get (u32 index);
368 app_cert_key_pair_t *app_cert_key_pair_get_if_valid (u32 index);
369 app_cert_key_pair_t *app_cert_key_pair_get_default ();
371 /* Needed while we support both bapi and mq ctrl messages */
372 int mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
373 session_handle_t handle, int rv);
374 int mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
375 session_t * s, session_error_t err);
376 void mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
377 u32 context, int rv);
379 crypto_engine_type_t app_crypto_engine_type_add (void);
380 u8 app_crypto_engine_n_types (void);
382 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
385 * fd.io coding-style-patch-verification: ON
388 * eval: (c-set-style "gnu")