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_wrk_postponed_msg_
39 u8 data[SESSION_CTRL_MSG_TX_MAX_SIZE];
40 } app_wrk_postponed_msg_t;
42 typedef struct app_worker_
44 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
46 /** Worker index in global worker pool*/
49 /** Worker index in app's map pool */
52 /** Index of owning app */
55 /** Application listens for events on this svm queue */
56 svm_msg_q_t *event_queue;
59 * Segment manager used for outgoing connects issued by the app. By
60 * convention this is the first segment manager allocated by the worker
61 * so it's also the one that holds the first segment with the app's
62 * message queue in it.
64 u32 connects_seg_manager;
66 /** Lookup tables for listeners. Value is segment manager index */
67 uword *listeners_table;
69 /** API index for the worker. Needed for multi-process apps */
72 /** Set if mq is congested */
77 /** Pool of half-open session handles. Tracked in case worker detaches */
78 session_handle_t *half_open_table;
80 /** Protects detached seg managers */
81 clib_spinlock_t detached_seg_managers_lock;
83 /** Vector of detached listener segment managers */
84 u32 *detached_seg_managers;
86 /** Fifo of messages postponed because of mq congestion */
87 app_wrk_postponed_msg_t *postponed_mq_msgs;
89 /** Lock to add/sub message from ref @postponed_mq_msgs */
90 clib_spinlock_t postponed_mq_msgs_lock;
93 typedef struct app_worker_map_
98 typedef struct app_listener_
100 clib_bitmap_t *workers; /**< workers accepting connections */
101 u32 accept_rotor; /**< last worker to accept a connection */
102 u32 al_index; /**< app listener index in app pool */
103 u32 app_index; /**< owning app index */
104 u32 local_index; /**< local listening session index */
105 u32 session_index; /**< global listening session index */
106 session_handle_t ls_handle; /**< session handle of the local or global
107 listening session that also identifies
111 typedef enum app_rx_mq_flags_
113 APP_RX_MQ_F_PENDING = 1 << 0,
114 APP_RX_MQ_F_POSTPONED = 1 << 1,
117 typedef struct app_rx_mq_elt_
119 struct app_rx_mq_elt_ *next;
120 struct app_rx_mq_elt_ *prev;
127 typedef struct application_
129 /** App index in app pool */
135 /** Callbacks: shoulder-taps for the server/client */
136 session_cb_vft_t cb_fns;
138 /** Segment manager properties. Shared by all segment managers */
139 segment_manager_props_t sm_properties;
141 /** Pool of mappings that keep track of workers associated to this app */
142 app_worker_map_t *worker_maps;
144 /** Name registered by builtin apps */
147 /** Namespace the application belongs to */
150 u16 proxied_transports;
152 /** Pool of listeners for the app */
153 app_listener_t *listeners;
155 /** Preferred tls engine */
158 /** quic initialization vector */
162 /** Segment where rx mqs were allocated */
163 fifo_segment_t rx_mqs_segment;
166 * Fixed vector of rx mqs that can be a part of pending_rx_mqs
167 * linked list maintained by the app sublayer for each worker
169 app_rx_mq_elt_t *rx_mqs;
172 typedef struct app_rx_mq_handle_
183 } __attribute__ ((aligned (sizeof (u64)))) app_rx_mq_handle_t;
186 * App sublayer per vpp worker state
188 typedef struct asl_wrk_
190 /** Linked list of mqs with pending messages */
191 app_rx_mq_elt_t *pending_rx_mqs;
194 typedef struct app_main_
197 * Pool from which we allocate all applications
199 application_t *app_pool;
202 * Hash table of apps by api client index
204 uword *app_by_api_client_index;
207 * Hash table of builtin apps by name
212 * Pool from which we allocate certificates (key, cert)
214 app_cert_key_pair_t *cert_key_pair_store;
217 * Last registered crypto engine type
219 crypto_engine_type_t last_crypto_engine;
222 * App sublayer per-worker state
227 typedef struct app_init_args_
229 #define _(_type, _name) _type _name;
230 foreach_app_init_args
234 typedef struct _vnet_app_worker_add_del_args
236 u32 app_index; /**< App for which a new worker is requested */
237 u32 wrk_map_index; /**< Index to delete or return value if add */
238 u32 api_client_index; /**< Binary API client index */
239 ssvm_private_t *segment; /**< First segment in segment manager */
240 u64 segment_handle; /**< Handle for the segment */
241 svm_msg_q_t *evt_q; /**< Worker message queue */
242 u8 is_add; /**< Flag set if addition */
243 } vnet_app_worker_add_del_args_t;
245 #define APP_INVALID_INDEX ((u32)~0)
246 #define APP_NS_INVALID_INDEX ((u32)~0)
247 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
249 app_listener_t *app_listener_get (application_t * app, u32 al_index);
250 int app_listener_alloc_and_init (application_t * app,
251 session_endpoint_cfg_t * sep,
252 app_listener_t ** listener);
253 void app_listener_cleanup (app_listener_t * app_listener);
254 session_handle_t app_listener_handle (app_listener_t * app_listener);
255 app_listener_t *app_listener_lookup (application_t * app,
256 session_endpoint_cfg_t * sep);
259 * Get app listener handle for listening session
261 * For a given listening session, this can return either the session
262 * handle of the app listener associated to the listening session or,
263 * if no such app listener exists, the session's handle
265 * @param ls listening session
266 * @return app listener or listening session handle
268 session_handle_t app_listen_session_handle (session_t * ls);
270 * Get app listener for listener session handle
272 * Should only be called on handles that have an app listener, i.e.,
273 * were obtained at the end of a @ref vnet_listen call.
275 * @param handle handle of the app listener. This is the handle of
276 * either the global or local listener
277 * @return pointer to app listener or 0
279 app_listener_t *app_listener_get_w_handle (session_handle_t handle);
280 app_listener_t *app_listener_get_w_session (session_t * ls);
281 session_t *app_listener_get_session (app_listener_t * al);
282 session_t *app_listener_get_local_session (app_listener_t * al);
284 application_t *application_get (u32 index);
285 application_t *application_get_if_valid (u32 index);
286 application_t *application_lookup (u32 api_client_index);
287 application_t *application_lookup_name (const u8 * name);
288 app_worker_t *application_get_worker (application_t * app, u32 wrk_index);
289 app_worker_t *application_get_default_worker (application_t * app);
290 app_worker_t *application_listener_select_worker (session_t * ls);
291 int application_change_listener_owner (session_t * s, app_worker_t * app_wrk);
292 int application_is_proxy (application_t * app);
293 int application_is_builtin (application_t * app);
294 int application_is_builtin_proxy (application_t * app);
295 u32 application_session_table (application_t * app, u8 fib_proto);
296 u32 application_local_session_table (application_t * app);
297 const u8 *application_name_from_index (u32 app_or_wrk);
298 u8 application_has_local_scope (application_t * app);
299 u8 application_has_global_scope (application_t * app);
300 void application_setup_proxy (application_t * app);
301 void application_remove_proxy (application_t * app);
302 void application_namespace_cleanup (app_namespace_t *app_ns);
303 int application_original_dst_is_enabled (application_t *app);
305 segment_manager_props_t *application_get_segment_manager_properties (u32
308 segment_manager_props_t
309 * application_segment_manager_properties (application_t * app);
311 svm_msg_q_t *application_rx_mq_get (application_t *app, u32 mq_index);
312 u8 application_use_private_rx_mqs (void);
313 fifo_segment_t *application_get_rx_mqs_segment (application_t *app);
314 void application_enable_rx_mqs_nodes (u8 is_en);
320 app_worker_t *app_worker_alloc (application_t * app);
321 int application_alloc_worker_and_init (application_t * app,
322 app_worker_t ** wrk);
323 app_worker_t *app_worker_get (u32 wrk_index);
324 app_worker_t *app_worker_get_if_valid (u32 wrk_index);
325 application_t *app_worker_get_app (u32 wrk_index);
326 int app_worker_own_session (app_worker_t * app_wrk, session_t * s);
327 void app_worker_free (app_worker_t * app_wrk);
328 int app_worker_connect_session (app_worker_t *app, session_endpoint_cfg_t *sep,
329 session_handle_t *rsh);
330 int app_worker_start_listen (app_worker_t * app_wrk, app_listener_t * lstnr);
331 int app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al);
332 int app_worker_init_accepted (session_t * s);
333 int app_worker_accept_notify (app_worker_t * app_wrk, session_t * s);
334 int app_worker_init_connected (app_worker_t * app_wrk, session_t * s);
335 int app_worker_connect_notify (app_worker_t * app_wrk, session_t * s,
336 session_error_t err, u32 opaque);
337 int app_worker_add_half_open (app_worker_t *app_wrk, session_handle_t sh);
338 int app_worker_del_half_open (app_worker_t *app_wrk, session_t *s);
339 int app_worker_close_notify (app_worker_t * app_wrk, session_t * s);
340 int app_worker_transport_closed_notify (app_worker_t * app_wrk,
342 int app_worker_reset_notify (app_worker_t * app_wrk, session_t * s);
343 int app_worker_cleanup_notify (app_worker_t * app_wrk, session_t * s,
344 session_cleanup_ntf_t ntf);
345 int app_worker_migrate_notify (app_worker_t * app_wrk, session_t * s,
346 session_handle_t new_sh);
347 int app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s);
348 int app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s);
349 int app_worker_session_fifo_tuning (app_worker_t * app_wrk, session_t * s,
351 session_ft_action_t act, u32 len);
352 segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *,
354 segment_manager_t *app_worker_get_connect_segment_manager (app_worker_t *);
355 int app_worker_add_segment_notify (app_worker_t * app_wrk,
357 int app_worker_del_segment_notify (app_worker_t * app_wrk,
359 u32 app_worker_n_listeners (app_worker_t * app);
360 session_t *app_worker_first_listener (app_worker_t * app,
361 u8 fib_proto, u8 transport_proto);
362 void app_wrk_send_ctrl_evt_fd (app_worker_t *app_wrk, u8 evt_type, void *msg,
363 u32 msg_len, int fd);
364 void app_wrk_send_ctrl_evt (app_worker_t *app_wrk, u8 evt_type, void *msg,
366 int app_worker_send_event (app_worker_t * app, session_t * s, u8 evt);
367 int app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
369 session_t *app_worker_proxy_listener (app_worker_t * app, u8 fib_proto,
371 void app_worker_del_detached_sm (app_worker_t * app_wrk, u32 sm_index);
372 u8 *format_app_worker (u8 * s, va_list * args);
373 u8 *format_app_worker_listener (u8 * s, va_list * args);
374 u8 *format_crypto_engine (u8 * s, va_list * args);
375 u8 *format_crypto_context (u8 * s, va_list * args);
376 void app_worker_format_connects (app_worker_t * app_wrk, int verbose);
377 int vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a);
379 uword unformat_application_proto (unformat_input_t * input, va_list * args);
381 app_cert_key_pair_t *app_cert_key_pair_get (u32 index);
382 app_cert_key_pair_t *app_cert_key_pair_get_if_valid (u32 index);
383 app_cert_key_pair_t *app_cert_key_pair_get_default ();
385 /* Needed while we support both bapi and mq ctrl messages */
386 int mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
387 session_handle_t handle, int rv);
388 int mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
389 session_t * s, session_error_t err);
390 void mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
391 u32 context, int rv);
392 void sapi_socket_close_w_handle (u32 api_handle);
394 crypto_engine_type_t app_crypto_engine_type_add (void);
395 u8 app_crypto_engine_n_types (void);
397 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
400 * fd.io coding-style-patch-verification: ON
403 * eval: (c-set-style "gnu")