X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fsession%2Fapplication_interface.h;h=96142573b98325dcee16637a1180a9c950c6668c;hb=b46241889;hp=3e6abdbec86adbf4db518d171b59a9b271288b03;hpb=09d18c2fee0eb96c486f9d112e39dcd34e430b0e;p=vpp.git diff --git a/src/vnet/session/application_interface.h b/src/vnet/session/application_interface.h index 3e6abdbec86..96142573b98 100644 --- a/src/vnet/session/application_interface.h +++ b/src/vnet/session/application_interface.h @@ -17,37 +17,61 @@ #include #include -#include #include #include +#include -typedef struct _stream_session_cb_vft +typedef struct certificate_ +{ + u32 *app_interests; /* vec of application index asking for deletion cb */ + u32 cert_key_index; /* index in cert & key pool */ + u8 *key; + u8 *cert; +} app_cert_key_pair_t; + +typedef struct session_cb_vft_ { /** Notify server of new segment */ - int (*add_segment_callback) (u32 api_client_index, u64 segment_handle); + int (*add_segment_callback) (u32 app_wrk_index, u64 segment_handle); /** Notify server of new segment */ - int (*del_segment_callback) (u32 api_client_index, u64 segment_handle); + int (*del_segment_callback) (u32 app_wrk_index, u64 segment_handle); /** Notify server of newly accepted session */ int (*session_accept_callback) (session_t * new_session); /** Connection request callback */ int (*session_connected_callback) (u32 app_wrk_index, u32 opaque, - session_t * s, u8 code); + session_t * s, session_error_t code); /** Notify app that session is closing */ void (*session_disconnect_callback) (session_t * s); + /** Notify app that transport is closed */ + void (*session_transport_closed_callback) (session_t * s); + + /** Notify app that session or transport are about to be removed */ + void (*session_cleanup_callback) (session_t * s, session_cleanup_ntf_t ntf); + /** Notify app that session was reset */ void (*session_reset_callback) (session_t * s); + /** Notify app that session pool migration happened */ + void (*session_migrate_callback) (session_t * s, session_handle_t new_sh); + /** Direct RX callback for built-in application */ int (*builtin_app_rx_callback) (session_t * session); /** Direct TX callback for built-in application */ int (*builtin_app_tx_callback) (session_t * session); + /** Cert and key pair delete notification */ + int (*app_cert_key_pair_delete_callback) (app_cert_key_pair_t * ckpair); + + /** Delegate fifo-tuning-logic to application */ + int (*fifo_tuning_callback) (session_t * s, svm_fifo_t * f, + session_ft_action_t act, u32 bytes); + } session_cb_vft_t; #define foreach_app_init_args \ @@ -57,6 +81,7 @@ typedef struct _stream_session_cb_vft _(u8 *, namespace_id) \ _(session_cb_vft_t *, session_cb_vft) \ _(u32, app_index) \ + _(u8, use_sock_api) \ typedef struct _vnet_app_attach_args_t { @@ -139,13 +164,31 @@ typedef struct _vnet_application_add_tls_key_args_t u8 *key; } vnet_app_add_tls_key_args_t; -typedef enum tls_engine_type_ +typedef enum crypto_engine_type_ +{ + CRYPTO_ENGINE_NONE, + CRYPTO_ENGINE_OPENSSL, + CRYPTO_ENGINE_MBEDTLS, + CRYPTO_ENGINE_VPP, + CRYPTO_ENGINE_PICOTLS, + CRYPTO_ENGINE_LAST = CRYPTO_ENGINE_PICOTLS, +} crypto_engine_type_t; + +typedef struct _vnet_app_add_cert_key_pair_args_ +{ + u8 *cert; + u8 *key; + u32 index; +} vnet_app_add_cert_key_pair_args_t; + +typedef struct crypto_ctx_ { - TLS_ENGINE_NONE, - TLS_ENGINE_MBEDTLS, - TLS_ENGINE_OPENSSL, - TLS_N_ENGINES -} tls_engine_type_t; + u32 ctx_index; /**< index in crypto context pool */ + u32 n_subscribers; /**< refcount of sessions using said context */ + u32 ckpair_index; /**< certificate & key */ + u8 crypto_engine; + void *data; /**< protocol specific data */ +} crypto_context_t; /* Application attach options */ typedef enum @@ -158,11 +201,16 @@ typedef enum APP_OPTIONS_RX_FIFO_SIZE, APP_OPTIONS_TX_FIFO_SIZE, APP_OPTIONS_PREALLOC_FIFO_PAIRS, + APP_OPTIONS_PREALLOC_FIFO_HDRS, APP_OPTIONS_NAMESPACE, APP_OPTIONS_NAMESPACE_SECRET, APP_OPTIONS_PROXY_TRANSPORT, APP_OPTIONS_ACCEPT_COOKIE, APP_OPTIONS_TLS_ENGINE, + APP_OPTIONS_MAX_FIFO_SIZE, + APP_OPTIONS_HIGH_WATERMARK, + APP_OPTIONS_LOW_WATERMARK, + APP_OPTIONS_PCT_FIRST_ALLOC, APP_OPTIONS_N_OPTIONS } app_attach_options_index_t; @@ -225,6 +273,10 @@ int vnet_disconnect_session (vnet_disconnect_args_t * a); clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a); clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a); +int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a); +int vnet_app_del_cert_key_pair (u32 index); +/** Ask for app cb on pair deletion */ +int vnet_app_add_cert_key_interest (u32 index, u32 app_index); typedef struct app_session_transport_ { @@ -252,6 +304,34 @@ typedef struct #undef _ } app_session_t; +typedef struct session_listen_msg_ +{ + u32 client_index; + u32 context; /* Not needed but keeping it for compatibility with bapi */ + u32 wrk_index; + u32 vrf; + u16 port; + u8 proto; + u8 is_ip4; + ip46_address_t ip; + u32 ckpair_index; + u8 crypto_engine; + u8 flags; +} __clib_packed session_listen_msg_t; + +STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE, + "msg too large"); + +typedef struct session_listen_uri_msg_ +{ + u32 client_index; + u32 context; + u8 uri[56]; +} __clib_packed session_listen_uri_msg_t; + +STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE, + "msg too large"); + typedef struct session_bound_msg_ { u32 context; @@ -263,11 +343,17 @@ typedef struct session_bound_msg_ uword rx_fifo; uword tx_fifo; uword vpp_evt_q; - u32 segment_size; - u8 segment_name_length; - u8 segment_name[128]; + u64 segment_handle; } __clib_packed session_bound_msg_t; +typedef struct session_unlisten_msg_ +{ + u32 client_index; + u32 context; + u32 wrk_index; + session_handle_t handle; +} __clib_packed session_unlisten_msg_t; + typedef struct session_unlisten_reply_msg_ { u32 context; @@ -284,7 +370,9 @@ typedef struct session_accepted_msg_ uword server_tx_fifo; u64 segment_handle; uword vpp_event_queue_address; + u32 mq_index; transport_endpoint_t rmt; + u8 flags; } __clib_packed session_accepted_msg_t; typedef struct session_accepted_reply_msg_ @@ -294,9 +382,38 @@ typedef struct session_accepted_reply_msg_ u64 handle; } __clib_packed session_accepted_reply_msg_t; -/* Make sure this is not too large, otherwise it won't fit when dequeued in - * the session queue node */ -STATIC_ASSERT (sizeof (session_accepted_reply_msg_t) <= 16, "accept reply"); +typedef struct session_connect_msg_ +{ + u32 client_index; + u32 context; + u32 wrk_index; + u32 vrf; + u16 port; + u16 lcl_port; + u8 proto; + u8 is_ip4; + ip46_address_t ip; + ip46_address_t lcl_ip; + u8 hostname_len; + u8 hostname[16]; + u64 parent_handle; + u32 ckpair_index; + u8 crypto_engine; + u8 flags; +} __clib_packed session_connect_msg_t; + +STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE, + "msg too large"); + +typedef struct session_connect_uri_msg_ +{ + u32 client_index; + u32 context; + u8 uri[56]; +} __clib_packed session_connect_uri_msg_t; + +STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <= + SESSION_CTRL_MSG_MAX_SIZE, "msg too large"); typedef struct session_connected_msg_ { @@ -316,6 +433,13 @@ typedef struct session_connected_msg_ transport_endpoint_t lcl; } __clib_packed session_connected_msg_t; +typedef struct session_disconnect_msg_ +{ + u32 client_index; + u32 context; + session_handle_t handle; +} __clib_packed session_disconnect_msg_t; + typedef struct session_disconnected_msg_ { u32 client_index; @@ -366,6 +490,51 @@ typedef struct session_worker_update_reply_msg_ u64 segment_handle; } __clib_packed session_worker_update_reply_msg_t; +typedef struct session_app_detach_msg_ +{ + u32 client_index; + u32 context; +} session_app_detach_msg_t; + +typedef struct app_map_another_segment_msg_ +{ + u32 client_index; + u32 context; + u8 fd_flags; + u32 segment_size; + u8 segment_name[128]; + u64 segment_handle; +} session_app_add_segment_msg_t; + +typedef struct app_unmap_segment_msg_ +{ + u32 client_index; + u32 context; + u64 segment_handle; +} session_app_del_segment_msg_t; + +typedef struct session_migrate_msg_ +{ + uword vpp_evt_q; + session_handle_t handle; + session_handle_t new_handle; + u64 segment_handle; + u32 vpp_thread_index; +} __clib_packed session_migrated_msg_t; + +typedef struct session_cleanup_msg_ +{ + session_handle_t handle; + u8 type; +} __clib_packed session_cleanup_msg_t; + +typedef struct session_app_wrk_rpc_msg_ +{ + u32 client_index; /**< app client index */ + u32 wrk_index; /**< dst worker index */ + u8 data[64]; /**< rpc data */ +} __clib_packed session_app_wrk_rpc_msg_t; + typedef struct app_session_event_ { svm_msg_q_msg_t msg; @@ -379,7 +548,6 @@ app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt, svm_msg_q_lock_and_alloc_msg_w_ring (mq, SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT, &app_evt->msg); - svm_msg_q_unlock (mq); app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg); clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt)); app_evt->evt->event_type = evt_type; @@ -388,7 +556,7 @@ app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt, static inline void app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt) { - svm_msg_q_add (mq, &app_evt->msg, SVM_Q_WAIT); + svm_msg_q_add_and_unlock (mq, &app_evt->msg); } /** @@ -414,17 +582,13 @@ app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type, { if (svm_msg_q_try_lock (mq)) return -1; - if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING))) + if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING) + || svm_msg_q_is_full (mq))) { svm_msg_q_unlock (mq); return -2; } msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING); - if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg))) - { - svm_msg_q_unlock (mq); - return -2; - } evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg); evt->session_index = session_index; evt->event_type = evt_type; @@ -434,14 +598,13 @@ app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type, else { svm_msg_q_lock (mq); - while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)) + while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING) + || svm_msg_q_is_full (mq)) svm_msg_q_wait (mq); msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING); evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg); evt->session_index = session_index; evt->event_type = evt_type; - if (svm_msg_q_is_full (mq)) - svm_msg_q_wait (mq); svm_msg_q_add_and_unlock (mq, &msg); return 0; } @@ -452,35 +615,35 @@ app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at, svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type, u8 do_evt, u8 noblock) { - u32 max_enqueue, actual_write; session_dgram_hdr_t hdr; int rv; - max_enqueue = svm_fifo_max_enqueue_prod (f); - if (max_enqueue <= sizeof (session_dgram_hdr_t)) + if (svm_fifo_max_enqueue_prod (f) < (sizeof (session_dgram_hdr_t) + len)) return 0; - max_enqueue -= sizeof (session_dgram_hdr_t); - actual_write = clib_min (len, max_enqueue); - hdr.data_length = actual_write; + hdr.data_length = len; hdr.data_offset = 0; clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t)); hdr.is_ip4 = at->is_ip4; hdr.rmt_port = at->rmt_port; clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t)); hdr.lcl_port = at->lcl_port; - rv = svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr); - ASSERT (rv == sizeof (hdr)); - rv = svm_fifo_enqueue_nowait (f, actual_write, data); + /* *INDENT-OFF* */ + svm_fifo_seg_t segs[2] = {{ (u8 *) &hdr, sizeof (hdr) }, { data, len }}; + /* *INDENT-ON* */ + + rv = svm_fifo_enqueue_segments (f, segs, 2, 0 /* allow partial */ ); + if (PREDICT_FALSE (rv < 0)) + return 0; + if (do_evt) { - if (rv > 0 && svm_fifo_set_event (f)) - app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type, - noblock); + if (svm_fifo_set_event (f)) + app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index, + evt_type, noblock); } - ASSERT (rv); - return rv; + return len; } always_inline int @@ -497,12 +660,12 @@ app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data, { int rv; - rv = svm_fifo_enqueue_nowait (f, len, data); + rv = svm_fifo_enqueue (f, len, data); if (do_evt) { if (rv > 0 && svm_fifo_set_event (f)) - app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type, - noblock); + app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index, + evt_type, noblock); } return rv; } @@ -531,7 +694,7 @@ app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len, int rv; max_deq = svm_fifo_max_dequeue_cons (f); - if (max_deq < sizeof (session_dgram_hdr_t)) + if (max_deq <= sizeof (session_dgram_hdr_t)) { if (clear_evt) svm_fifo_unset_event (f); @@ -543,17 +706,21 @@ app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len, svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph); ASSERT (ph.data_length >= ph.data_offset); - if (!ph.data_offset) - svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at); + + /* Check if we have the full dgram */ + if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN) + && len >= ph.data_length) + return 0; + + svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at); len = clib_min (len, ph.data_length - ph.data_offset); rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf); if (peek) return rv; - ph.data_offset += rv; - if (ph.data_offset == ph.data_length) - svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN); - else - svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph)); + + /* Discards data that did not fit in buffer */ + svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN); + return rv; } @@ -572,7 +739,7 @@ app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek) if (peek) return svm_fifo_peek (f, 0, len, buf); - return svm_fifo_dequeue_nowait (f, len, buf); + return svm_fifo_dequeue (f, len, buf); } always_inline int @@ -589,6 +756,93 @@ app_recv (app_session_t * s, u8 * data, u32 len) return app_recv_stream (s, data, len); } +/* *INDENT-OFF* */ +static char *session_error_str[] = { +#define _(sym, str) str, + foreach_session_error +#undef _ +}; +/* *INDENT-ON* */ + +static inline u8 * +format_session_error (u8 * s, va_list * args) +{ + session_error_t error = va_arg (*args, session_error_t); + if (-error >= 0 && -error < SESSION_N_ERRORS) + s = format (s, "%s", session_error_str[-error]); + else + s = format (s, "invalid session err %u", -error); + return s; +} + +/* + * Socket API messages + */ + +typedef enum app_sapi_msg_type +{ + APP_SAPI_MSG_TYPE_NONE, + APP_SAPI_MSG_TYPE_ATTACH, + APP_SAPI_MSG_TYPE_ATTACH_REPLY, + APP_SAPI_MSG_TYPE_ADD_DEL_WORKER, + APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY, + APP_SAPI_MSG_TYPE_SEND_FDS, +} __clib_packed app_sapi_msg_type_e; + +typedef struct app_sapi_attach_msg_ +{ + u8 name[64]; + u64 options[18]; +} __clib_packed app_sapi_attach_msg_t; + +STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <= + sizeof (((app_sapi_attach_msg_t *) 0)->options), + "Out of options, fix message definition"); + +typedef struct app_sapi_attach_reply_msg_ +{ + i32 retval; + u32 app_index; + u64 app_mq; + u64 vpp_ctrl_mq; + u64 segment_handle; + u32 api_client_handle; + u8 vpp_ctrl_mq_thread; + u8 n_fds; + u8 fd_flags; +} __clib_packed app_sapi_attach_reply_msg_t; + +typedef struct app_sapi_worker_add_del_msg_ +{ + u32 app_index; + u32 wrk_index; + u8 is_add; +} __clib_packed app_sapi_worker_add_del_msg_t; + +typedef struct app_sapi_worker_add_del_reply_msg_ +{ + i32 retval; + u32 wrk_index; + u64 app_event_queue_address; + u64 segment_handle; + u32 api_client_handle; + u8 n_fds; + u8 fd_flags; + u8 is_add; +} __clib_packed app_sapi_worker_add_del_reply_msg_t; + +typedef struct app_sapi_msg_ +{ + app_sapi_msg_type_e type; + union + { + app_sapi_attach_msg_t attach; + app_sapi_attach_reply_msg_t attach_reply; + app_sapi_worker_add_del_msg_t worker_add_del; + app_sapi_worker_add_del_reply_msg_t worker_add_del_reply; + }; +} __clib_packed app_sapi_msg_t; + #endif /* __included_uri_h__ */ /*