X-Git-Url: https://gerrit.fd.io/r/gitweb?p=vpp.git;a=blobdiff_plain;f=src%2Fvnet%2Fsession%2Fapplication_interface.h;h=bf9467690287276a6cd1c68bf2a6c80e7c2f8b59;hp=dc4c46906c4edc86fb54f0c323b1781908973d21;hb=2de9c0f92;hpb=178cf493d009995b28fdf220f04c98860ff79a9b diff --git a/src/vnet/session/application_interface.h b/src/vnet/session/application_interface.h index dc4c46906c4..bf946769028 100644 --- a/src/vnet/session/application_interface.h +++ b/src/vnet/session/application_interface.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016 Cisco and/or its affiliates. + * Copyright (c) 2016-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: @@ -15,11 +15,72 @@ #ifndef __included_uri_h__ #define __included_uri_h__ -#include -#include -#include -#include -#include +#include +#include +#include +#include +#include + +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 app_wrk_index, u64 segment_handle); + + /** Notify server of new segment */ + 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); + + /** 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 \ + _(u32, api_client_index) \ + _(u8 *, name) \ + _(u64 *, options) \ + _(u8 *, namespace_id) \ + _(session_cb_vft_t *, session_cb_vft) \ + _(u32, app_index) \ typedef struct _vnet_app_attach_args_t { @@ -28,11 +89,13 @@ typedef struct _vnet_app_attach_args_t #undef _ ssvm_private_t * segment; svm_msg_q_t *app_evt_q; + u64 segment_handle; } vnet_app_attach_args_t; typedef struct _vnet_app_detach_args_t { u32 app_index; + u32 api_client_index; } vnet_app_detach_args_t; typedef struct _vnet_bind_args_t @@ -54,9 +117,9 @@ typedef struct _vnet_bind_args_t u32 segment_name_length; u64 server_event_queue_address; u64 handle; -} vnet_bind_args_t; +} vnet_listen_args_t; -typedef struct _vnet_unbind_args_t +typedef struct _vnet_unlisten_args_t { union { @@ -65,7 +128,7 @@ typedef struct _vnet_unbind_args_t }; u32 app_index; /**< Owning application index */ u32 wrk_map_index; /**< App's local pool worker index */ -} vnet_unbind_args_t; +} vnet_unlisten_args_t; typedef struct _vnet_connect_args { @@ -100,6 +163,32 @@ typedef struct _vnet_application_add_tls_key_args_t u8 *key; } vnet_app_add_tls_key_args_t; +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_ +{ + 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 { @@ -116,6 +205,10 @@ typedef enum 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; @@ -127,7 +220,6 @@ typedef enum _(IS_PROXY, "Application is proxying") \ _(USE_GLOBAL_SCOPE, "App can use global session scope") \ _(USE_LOCAL_SCOPE, "App can use local session scope") \ - _(USE_MQ_FOR_CTRL_MSGS, "Use message queue for ctr msgs") \ _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \ typedef enum _app_options @@ -165,24 +257,24 @@ typedef enum session_fd_flag_ #undef _ } session_fd_flag_t; -int vnet_bind_uri (vnet_bind_args_t *); -int vnet_unbind_uri (vnet_unbind_args_t * a); -clib_error_t *vnet_connect_uri (vnet_connect_args_t * a); +int parse_uri (char *uri, session_endpoint_cfg_t * sep); +int vnet_bind_uri (vnet_listen_args_t *); +int vnet_unbind_uri (vnet_unlisten_args_t * a); +int vnet_connect_uri (vnet_connect_args_t * a); -clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a); -clib_error_t *vnet_bind (vnet_bind_args_t * a); -clib_error_t *vnet_connect (vnet_connect_args_t * a); -clib_error_t *vnet_unbind (vnet_unbind_args_t * a); +int vnet_application_attach (vnet_app_attach_args_t * a); int vnet_application_detach (vnet_app_detach_args_t * a); +int vnet_listen (vnet_listen_args_t * a); +int vnet_connect (vnet_connect_args_t * a); +int vnet_unlisten (vnet_unlisten_args_t * a); 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); - -extern const char test_srv_crt_rsa[]; -extern const u32 test_srv_crt_rsa_len; -extern const char test_srv_key_rsa[]; -extern const u32 test_srv_key_rsa_len; +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_ { @@ -210,6 +302,33 @@ 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; +} __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; @@ -218,27 +337,40 @@ typedef struct session_bound_msg_ u8 lcl_is_ip4; u8 lcl_ip[16]; u16 lcl_port; - u64 rx_fifo; - u64 tx_fifo; - u64 vpp_evt_q; + uword rx_fifo; + uword tx_fifo; + uword vpp_evt_q; u32 segment_size; u8 segment_name_length; u8 segment_name[128]; } __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; + u64 handle; + i32 retval; +} __clib_packed session_unlisten_reply_msg_t; + typedef struct session_accepted_msg_ { u32 context; u64 listener_handle; u64 handle; - u64 server_rx_fifo; - u64 server_tx_fifo; - u64 vpp_event_queue_address; - u64 server_event_queue_address; - u64 client_event_queue_address; - u16 port; - u8 is_ip4; - u8 ip[16]; + uword server_rx_fifo; + uword server_tx_fifo; + u64 segment_handle; + uword vpp_event_queue_address; + transport_endpoint_t rmt; + u8 flags; } __clib_packed session_accepted_msg_t; typedef struct session_accepted_reply_msg_ @@ -248,28 +380,63 @@ 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; + 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_ { u32 context; i32 retval; u64 handle; - u64 server_rx_fifo; - u64 server_tx_fifo; - u64 vpp_event_queue_address; - u64 client_event_queue_address; - u64 server_event_queue_address; + uword server_rx_fifo; + uword server_tx_fifo; + u64 segment_handle; + uword ct_rx_fifo; + uword ct_tx_fifo; + u64 ct_segment_handle; + uword vpp_event_queue_address; u32 segment_size; u8 segment_name_length; u8 segment_name[64]; - u8 lcl_ip[16]; - u8 is_ip4; - u16 lcl_port; + 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; @@ -293,12 +460,69 @@ typedef struct session_reset_msg_ typedef struct session_reset_reply_msg_ { - u32 client_index; u32 context; i32 retval; u64 handle; } __clib_packed session_reset_reply_msg_t; +typedef struct session_req_worker_update_msg_ +{ + u64 session_handle; +} __clib_packed session_req_worker_update_msg_t; + +/* NOTE: using u16 for wrk indices because message needs to fit in 18B */ +typedef struct session_worker_update_msg_ +{ + u32 client_index; + u16 wrk_index; + u16 req_wrk_index; + u64 handle; +} __clib_packed session_worker_update_msg_t; + +typedef struct session_worker_update_reply_msg_ +{ + u64 handle; + uword rx_fifo; + uword tx_fifo; + 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; + u32 vpp_thread_index; +} __clib_packed session_migrated_msg_t; + +typedef struct session_cleanup_msg_ +{ + session_handle_t handle; +} __clib_packed session_cleanup_msg_t; + typedef struct app_session_event_ { svm_msg_q_msg_t msg; @@ -312,7 +536,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; @@ -321,7 +544,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); } /** @@ -337,7 +560,7 @@ app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt) * @return 0 if success, negative integer otherwise */ static inline int -app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, u8 evt_type, +app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type, u8 noblock) { session_event_t *evt; @@ -353,13 +576,8 @@ app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, u8 evt_type, 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->fifo = f; + evt->session_index = session_index; evt->event_type = evt_type; svm_msg_q_add_and_unlock (mq, &msg); return 0; @@ -367,14 +585,13 @@ app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, 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->fifo = f; + 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; } @@ -383,13 +600,13 @@ app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, u8 evt_type, always_inline int 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 noblock) + u8 do_evt, u8 noblock) { u32 max_enqueue, actual_write; session_dgram_hdr_t hdr; int rv; - max_enqueue = svm_fifo_max_enqueue (f); + max_enqueue = svm_fifo_max_enqueue_prod (f); if (max_enqueue <= sizeof (session_dgram_hdr_t)) return 0; @@ -402,13 +619,15 @@ app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at, 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); + rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr); ASSERT (rv == sizeof (hdr)); - if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0) + rv = svm_fifo_enqueue (f, actual_write, data); + if (do_evt) { - if (svm_fifo_set_event (f)) - app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock); + if (rv > 0 && svm_fifo_set_event (f)) + app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type, + noblock); } ASSERT (rv); return rv; @@ -418,19 +637,22 @@ always_inline int app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock) { return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data, - len, FIFO_EVENT_APP_TX, noblock); + len, SESSION_IO_EVT_TX, 1 /* do_evt */ , + noblock); } always_inline int app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data, - u32 len, u8 evt_type, u8 noblock) + u32 len, u8 evt_type, u8 do_evt, u8 noblock) { int rv; - if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0) + rv = svm_fifo_enqueue (f, len, data); + if (do_evt) { - if (svm_fifo_set_event (f)) - app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock); + if (rv > 0 && svm_fifo_set_event (f)) + app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type, + noblock); } return rv; } @@ -439,7 +661,7 @@ always_inline int app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock) { return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len, - FIFO_EVENT_APP_TX, noblock); + SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock); } always_inline int @@ -458,7 +680,7 @@ app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len, u32 max_deq; int rv; - max_deq = svm_fifo_max_dequeue (f); + max_deq = svm_fifo_max_dequeue_cons (f); if (max_deq < sizeof (session_dgram_hdr_t)) { if (clear_evt) @@ -500,7 +722,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