/*
- * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Copyright (c) 2017-2019 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
#ifndef SRC_VNET_SESSION_APPLICATION_H_
#define SRC_VNET_SESSION_APPLICATION_H_
-#include <vnet/session/session.h>
-#include <vnet/session/segment_manager.h>
+#include <vnet/session/application_interface.h>
#include <vnet/session/application_namespace.h>
+#include <vnet/session/session_types.h>
+#include <vnet/session/segment_manager.h>
+
+#define APP_DEBUG 0
-typedef struct _stream_session_cb_vft
+#if APP_DEBUG > 0
+#define APP_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
+#else
+#define APP_DBG(_fmt, _args...)
+#endif
+
+typedef struct app_worker_
{
- /** Notify server of new segment */
- int (*add_segment_callback) (u32 api_client_index,
- const ssvm_private_t * ssvm_seg);
- /** Notify server of new segment */
- int (*del_segment_callback) (u32 api_client_index,
- const ssvm_private_t * ssvm_seg);
+ CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
+
+ /** Worker index in global worker pool*/
+ u32 wrk_index;
+
+ /** Worker index in app's map pool */
+ u32 wrk_map_index;
+
+ /** Index of owning app */
+ u32 app_index;
+
+ /** Application listens for events on this svm queue */
+ svm_msg_q_t *event_queue;
+
+ /**
+ * Segment manager used for outgoing connects issued by the app. By
+ * convention this is the first segment manager allocated by the worker
+ * so it's also the one that holds the first segment with the app's
+ * message queue in it.
+ */
+ u32 connects_seg_manager;
+
+ /** Lookup tables for listeners. Value is segment manager index */
+ uword *listeners_table;
- /** Notify server of newly accepted session */
- int (*session_accept_callback) (stream_session_t * new_session);
+ /** API index for the worker. Needed for multi-process apps */
+ u32 api_client_index;
- /** Connection request callback */
- int (*session_connected_callback) (u32 app_index, u32 opaque,
- stream_session_t * s, u8 code);
+ u8 app_is_builtin;
- /** Notify app that session is closing */
- void (*session_disconnect_callback) (stream_session_t * s);
+ /** Pool of half-open session handles. Tracked in case worker detaches */
+ session_handle_t *half_open_table;
- /** Notify app that session was reset */
- void (*session_reset_callback) (stream_session_t * s);
+ /** Protects detached seg managers */
+ clib_spinlock_t detached_seg_managers_lock;
- /** Direct RX callback for built-in application */
- int (*builtin_app_rx_callback) (stream_session_t * session);
+ /** Vector of detached listener segment managers */
+ u32 *detached_seg_managers;
+} app_worker_t;
- /** Direct TX callback for built-in application */
- int (*builtin_app_tx_callback) (stream_session_t * session);
+typedef struct app_worker_map_
+{
+ u32 wrk_index;
+} app_worker_map_t;
-} session_cb_vft_t;
+typedef struct app_listener_
+{
+ clib_bitmap_t *workers; /**< workers accepting connections */
+ u32 accept_rotor; /**< last worker to accept a connection */
+ u32 al_index; /**< app listener index in app pool */
+ u32 app_index; /**< owning app index */
+ u32 local_index; /**< local listening session index */
+ u32 session_index; /**< global listening session index */
+ session_handle_t ls_handle; /**< session handle of the local or global
+ listening session that also identifies
+ the app listener */
+} app_listener_t;
+
+typedef enum app_rx_mq_flags_
+{
+ APP_RX_MQ_F_PENDING = 1 << 0,
+ APP_RX_MQ_F_POSTPONED = 1 << 1,
+} app_rx_mq_flags_t;
-typedef struct _application
+typedef struct app_rx_mq_elt_
{
- /** Index in server pool */
- u32 index;
+ struct app_rx_mq_elt_ *next;
+ struct app_rx_mq_elt_ *prev;
+ svm_msg_q_t *mq;
+ uword file_index;
+ u32 app_index;
+ u8 flags;
+} app_rx_mq_elt_t;
+
+typedef struct application_
+{
+ /** App index in app pool */
+ u32 app_index;
/** Flags */
u32 flags;
- /** Name registered by builtin apps */
- u8 *name;
+ /** Callbacks: shoulder-taps for the server/client */
+ session_cb_vft_t cb_fns;
- /*
- * Binary API interface to external app
- */
+ /** Segment manager properties. Shared by all segment managers */
+ segment_manager_props_t sm_properties;
- /** Binary API connection index, ~0 if internal */
- u32 api_client_index;
+ /** Pool of mappings that keep track of workers associated to this app */
+ app_worker_map_t *worker_maps;
+
+ /** Name registered by builtin apps */
+ u8 *name;
/** Namespace the application belongs to */
u32 ns_index;
- /** Application listens for events on this svm queue */
- svm_msg_q_t *event_queue;
+ u16 proxied_transports;
- /*
- * Callbacks: shoulder-taps for the server/client
- */
+ /** Pool of listeners for the app */
+ app_listener_t *listeners;
- session_cb_vft_t cb_fns;
+ /** Preferred tls engine */
+ u8 tls_engine;
- /*
- * ssvm (fifo) segment management
- */
- /** Segment manager used for outgoing connects issued by the app */
- u32 connects_seg_manager;
+ /** quic initialization vector */
+ char quic_iv[17];
+ u8 quic_iv_set;
- /** Lookup tables for listeners. Value is segment manager index */
- uword *listeners_table;
+ /** Segment where rx mqs were allocated */
+ fifo_segment_t rx_mqs_segment;
/**
- * First segment manager has in the the first segment the application's
- * event fifo. Depending on what the app does, it may be either used for
- * a listener or for connects.
+ * Fixed vector of rx mqs that can be a part of pending_rx_mqs
+ * linked list maintained by the app sublayer for each worker
*/
- u32 first_segment_manager;
- u8 first_segment_manager_in_use;
-
- /** Segment manager properties. Shared by all segment managers */
- segment_manager_properties_t sm_properties;
+ app_rx_mq_elt_t *rx_mqs;
+} application_t;
- u16 proxied_transports;
+typedef struct app_rx_mq_handle_
+{
+ union
+ {
+ struct
+ {
+ u32 app_index;
+ u32 thread_index;
+ };
+ u64 as_u64;
+ };
+} __attribute__ ((aligned (sizeof (u64)))) app_rx_mq_handle_t;
+
+/**
+ * App sublayer per vpp worker state
+ */
+typedef struct asl_wrk_
+{
+ /** Linked list of mqs with pending messages */
+ app_rx_mq_elt_t *pending_rx_mqs;
+} appsl_wrk_t;
- /*
- * Local "cut through" connections specific
+typedef struct app_main_
+{
+ /**
+ * Pool from which we allocate all applications
*/
+ application_t *app_pool;
- /** Segment manager used for incoming "cut through" connects */
- u32 local_segment_manager;
-
- /** Pool of local listen sessions */
- local_session_t *local_listen_sessions;
+ /**
+ * Hash table of apps by api client index
+ */
+ uword *app_by_api_client_index;
- /** Pool of local sessions the app owns (as a server) */
- local_session_t *local_sessions;
+ /**
+ * Hash table of builtin apps by name
+ */
+ uword *app_by_name;
- /** Hash table of the app's local connects */
- uword *local_connects;
+ /**
+ * Pool from which we allocate certificates (key, cert)
+ */
+ app_cert_key_pair_t *cert_key_pair_store;
/*
- * TLS Specific
+ * Last registered crypto engine type
*/
+ crypto_engine_type_t last_crypto_engine;
- /** Certificate to be used for listen sessions */
- u8 *tls_cert;
+ /**
+ * App sublayer per-worker state
+ */
+ appsl_wrk_t *wrk;
+} app_main_t;
- /** PEM encoded key */
- u8 *tls_key;
+typedef struct app_init_args_
+{
+#define _(_type, _name) _type _name;
+ foreach_app_init_args
+#undef _
+} app_init_args_t;
- /** Preferred tls engine */
- u8 tls_engine;
-} application_t;
+typedef struct _vnet_app_worker_add_del_args
+{
+ u32 app_index; /**< App for which a new worker is requested */
+ u32 wrk_map_index; /**< Index to delete or return value if add */
+ u32 api_client_index; /**< Binary API client index */
+ ssvm_private_t *segment; /**< First segment in segment manager */
+ u64 segment_handle; /**< Handle for the segment */
+ svm_msg_q_t *evt_q; /**< Worker message queue */
+ u8 is_add; /**< Flag set if addition */
+} vnet_app_worker_add_del_args_t;
#define APP_INVALID_INDEX ((u32)~0)
#define APP_NS_INVALID_INDEX ((u32)~0)
#define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
-application_t *application_new ();
-int application_init (application_t * app, u32 api_client_index,
- u8 * name, u64 * options, session_cb_vft_t * cb_fns);
-void application_del (application_t * app);
+app_listener_t *app_listener_get (application_t * app, u32 al_index);
+int app_listener_alloc_and_init (application_t * app,
+ session_endpoint_cfg_t * sep,
+ app_listener_t ** listener);
+void app_listener_cleanup (app_listener_t * app_listener);
+session_handle_t app_listener_handle (app_listener_t * app_listener);
+app_listener_t *app_listener_lookup (application_t * app,
+ session_endpoint_cfg_t * sep);
+
+/**
+ * Get app listener handle for listening session
+ *
+ * For a given listening session, this can return either the session
+ * handle of the app listener associated to the listening session or,
+ * if no such app listener exists, the session's handle
+ *
+ * @param ls listening session
+ * @return app listener or listening session handle
+ */
+session_handle_t app_listen_session_handle (session_t * ls);
+/**
+ * Get app listener for listener session handle
+ *
+ * Should only be called on handles that have an app listener, i.e.,
+ * were obtained at the end of a @ref vnet_listen call.
+ *
+ * @param handle handle of the app listener. This is the handle of
+ * either the global or local listener
+ * @return pointer to app listener or 0
+ */
+app_listener_t *app_listener_get_w_handle (session_handle_t handle);
+app_listener_t *app_listener_get_w_session (session_t * ls);
+session_t *app_listener_get_session (app_listener_t * al);
+session_t *app_listener_get_local_session (app_listener_t * al);
+
application_t *application_get (u32 index);
application_t *application_get_if_valid (u32 index);
application_t *application_lookup (u32 api_client_index);
application_t *application_lookup_name (const u8 * name);
-u32 application_get_index (application_t * app);
-
-int application_start_listen (application_t * app,
- session_endpoint_t * tep,
- session_handle_t * handle);
-int application_start_local_listen (application_t * server,
- session_endpoint_t * sep,
- session_handle_t * handle);
-int application_stop_listen (application_t * srv, session_handle_t handle);
-int application_stop_local_listen (application_t * server,
- session_handle_t listener_handle);
-int application_open_session (application_t * app, session_endpoint_t * tep,
- u32 api_context);
-int application_api_queue_is_full (application_t * app);
-
-segment_manager_t *application_get_listen_segment_manager (application_t *
- app,
- stream_session_t *
- ls);
-segment_manager_t *application_get_connect_segment_manager (application_t *
- app);
-int application_alloc_connects_segment_manager (application_t * app);
-
+app_worker_t *application_get_worker (application_t * app, u32 wrk_index);
+app_worker_t *application_get_default_worker (application_t * app);
+app_worker_t *application_listener_select_worker (session_t * ls);
+int application_change_listener_owner (session_t * s, app_worker_t * app_wrk);
int application_is_proxy (application_t * app);
int application_is_builtin (application_t * app);
int application_is_builtin_proxy (application_t * app);
-int application_add_segment_notify (u32 app_index, ssvm_private_t * fs);
u32 application_session_table (application_t * app, u8 fib_proto);
u32 application_local_session_table (application_t * app);
-u8 *application_name_from_index (u32 app_index);
-
+const u8 *application_name_from_index (u32 app_or_wrk);
u8 application_has_local_scope (application_t * app);
u8 application_has_global_scope (application_t * app);
-u32 application_n_listeners (application_t * app);
-stream_session_t *application_first_listener (application_t * app,
- u8 fib_proto,
- u8 transport_proto);
void application_setup_proxy (application_t * app);
void application_remove_proxy (application_t * app);
-segment_manager_properties_t *application_get_segment_manager_properties (u32
- app_index);
-segment_manager_properties_t
- * application_segment_manager_properties (application_t * app);
-
-local_session_t *application_alloc_local_session (application_t * app);
-void application_free_local_session (application_t * app,
- local_session_t * ls);
-local_session_t *application_get_local_session (application_t * app,
- u32 session_index);
-local_session_t *application_get_local_session_from_handle (session_handle_t
- handle);
-int application_local_session_connect (u32 table_index,
- application_t * client,
- application_t * server,
- local_session_t * ll, u32 opaque);
-int application_local_session_connect_notify (local_session_t * ls);
-int application_local_session_disconnect (u32 app_index,
- local_session_t * ls);
-int application_local_session_disconnect_w_index (u32 app_index,
- u32 ls_index);
-void application_local_sessions_del (application_t * app);
-
-int application_send_event (application_t * app, stream_session_t * s,
- u8 evt);
-int application_lock_and_send_event (application_t * app,
- stream_session_t * s, u8 evt_type);
-
-always_inline u32
-local_session_id (local_session_t * ll)
-{
- ASSERT (ll->app_index < (2 << 16) && ll->session_index < (2 << 16));
- return ((u32) ll->app_index << 16 | (u32) ll->session_index);
-}
+segment_manager_props_t *application_get_segment_manager_properties (u32
+ app_index);
-always_inline void
-local_session_parse_id (u32 ls_id, u32 * app_index, u32 * session_index)
-{
- *app_index = ls_id >> 16;
- *session_index = ls_id & 0xFFF;
-}
-
-always_inline void
-local_session_parse_handle (session_handle_t handle, u32 * server_index,
- u32 * session_index)
-{
- u32 bottom;
- ASSERT ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX);
- bottom = (handle & 0xFFFFFFFF);
- local_session_parse_id (bottom, server_index, session_index);
-}
-
-always_inline session_handle_t
-application_local_session_handle (local_session_t * ls)
-{
- return ((u64) SESSION_LOCAL_HANDLE_PREFIX << 32)
- | (u64) local_session_id (ls);
-}
+segment_manager_props_t
+ * application_segment_manager_properties (application_t * app);
-always_inline local_session_t *
-application_get_local_listen_session (application_t * app, u32 session_index)
-{
- return pool_elt_at_index (app->local_listen_sessions, session_index);
-}
+svm_msg_q_t *application_rx_mq_get (application_t *app, u32 mq_index);
+u8 application_use_private_rx_mqs (void);
+fifo_segment_t *application_get_rx_mqs_segment (application_t *app);
+void application_enable_rx_mqs_nodes (u8 is_en);
-always_inline local_session_t *
-application_get_local_listener_w_handle (session_handle_t handle)
-{
- u32 server_index, session_index;
- application_t *app;
- local_session_parse_handle (handle, &server_index, &session_index);
- app = application_get (server_index);
- return application_get_local_listen_session (app, session_index);
-}
-
-always_inline u8
-application_local_session_listener_has_transport (local_session_t * ls)
-{
- transport_proto_t tp;
- tp = session_type_transport_proto (ls->listener_session_type);
- return (tp != TRANSPORT_PROTO_NONE);
-}
-
-void mq_send_local_session_disconnected_cb (u32 app_index,
- local_session_t * ls);
+/*
+ * App worker
+ */
-int application_connect (u32 client_index, u32 api_context,
- session_endpoint_t * sep);
+app_worker_t *app_worker_alloc (application_t * app);
+int application_alloc_worker_and_init (application_t * app,
+ app_worker_t ** wrk);
+app_worker_t *app_worker_get (u32 wrk_index);
+app_worker_t *app_worker_get_if_valid (u32 wrk_index);
+application_t *app_worker_get_app (u32 wrk_index);
+int app_worker_own_session (app_worker_t * app_wrk, session_t * s);
+void app_worker_free (app_worker_t * app_wrk);
+int app_worker_connect_session (app_worker_t *app, session_endpoint_cfg_t *sep,
+ session_handle_t *rsh);
+int app_worker_start_listen (app_worker_t * app_wrk, app_listener_t * lstnr);
+int app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al);
+int app_worker_init_accepted (session_t * s);
+int app_worker_accept_notify (app_worker_t * app_wrk, session_t * s);
+int app_worker_init_connected (app_worker_t * app_wrk, session_t * s);
+int app_worker_connect_notify (app_worker_t * app_wrk, session_t * s,
+ session_error_t err, u32 opaque);
+int app_worker_add_half_open (app_worker_t *app_wrk, session_handle_t sh);
+int app_worker_del_half_open (app_worker_t *app_wrk, session_t *s);
+int app_worker_close_notify (app_worker_t * app_wrk, session_t * s);
+int app_worker_transport_closed_notify (app_worker_t * app_wrk,
+ session_t * s);
+int app_worker_reset_notify (app_worker_t * app_wrk, session_t * s);
+int app_worker_cleanup_notify (app_worker_t * app_wrk, session_t * s,
+ session_cleanup_ntf_t ntf);
+int app_worker_migrate_notify (app_worker_t * app_wrk, session_t * s,
+ session_handle_t new_sh);
+int app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s);
+int app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s);
+int app_worker_session_fifo_tuning (app_worker_t * app_wrk, session_t * s,
+ svm_fifo_t * f,
+ session_ft_action_t act, u32 len);
+segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *,
+ session_t *);
+segment_manager_t *app_worker_get_connect_segment_manager (app_worker_t *);
+int app_worker_add_segment_notify (app_worker_t * app_wrk,
+ u64 segment_handle);
+int app_worker_del_segment_notify (app_worker_t * app_wrk,
+ u64 segment_handle);
+u32 app_worker_n_listeners (app_worker_t * app);
+session_t *app_worker_first_listener (app_worker_t * app,
+ u8 fib_proto, u8 transport_proto);
+int app_worker_send_event (app_worker_t * app, session_t * s, u8 evt);
+int app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
+ u8 evt_type);
+session_t *app_worker_proxy_listener (app_worker_t * app, u8 fib_proto,
+ u8 transport_proto);
+void app_worker_del_detached_sm (app_worker_t * app_wrk, u32 sm_index);
+u8 *format_app_worker (u8 * s, va_list * args);
+u8 *format_app_worker_listener (u8 * s, va_list * args);
+u8 *format_crypto_engine (u8 * s, va_list * args);
+u8 *format_crypto_context (u8 * s, va_list * args);
+void app_worker_format_connects (app_worker_t * app_wrk, int verbose);
+int vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a);
uword unformat_application_proto (unformat_input_t * input, va_list * args);
+app_cert_key_pair_t *app_cert_key_pair_get (u32 index);
+app_cert_key_pair_t *app_cert_key_pair_get_if_valid (u32 index);
+app_cert_key_pair_t *app_cert_key_pair_get_default ();
+
+/* Needed while we support both bapi and mq ctrl messages */
+int mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
+ session_handle_t handle, int rv);
+int mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
+ session_t * s, session_error_t err);
+void mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
+ u32 context, int rv);
+void sapi_socket_close_w_handle (u32 api_handle);
+
+crypto_engine_type_t app_crypto_engine_type_add (void);
+u8 app_crypto_engine_n_types (void);
+
#endif /* SRC_VNET_SESSION_APPLICATION_H_ */
/*