Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 1 | /* |
Florin Coras | 288eaab | 2019-02-03 15:26:14 -0800 | [diff] [blame] | 2 | * Copyright (c) 2016-2019 Cisco and/or its affiliates. |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 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: |
| 6 | * |
| 7 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | * |
| 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. |
| 14 | */ |
| 15 | #ifndef __included_uri_h__ |
| 16 | #define __included_uri_h__ |
| 17 | |
Florin Coras | c1a4265 | 2019-02-08 18:27:29 -0800 | [diff] [blame] | 18 | #include <vlibmemory/api.h> |
| 19 | #include <svm/message_queue.h> |
Florin Coras | c9940fc | 2019-02-05 20:55:11 -0800 | [diff] [blame] | 20 | #include <vnet/session/session_types.h> |
Florin Coras | 54a51fd | 2019-02-07 15:34:52 -0800 | [diff] [blame] | 21 | #include <vnet/tls/tls_test.h> |
Florin Coras | 88001c6 | 2019-04-24 14:44:46 -0700 | [diff] [blame] | 22 | #include <svm/fifo_segment.h> |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 23 | |
Florin Coras | c1a4265 | 2019-02-08 18:27:29 -0800 | [diff] [blame] | 24 | typedef struct _stream_session_cb_vft |
| 25 | { |
| 26 | /** Notify server of new segment */ |
| 27 | int (*add_segment_callback) (u32 api_client_index, u64 segment_handle); |
| 28 | |
| 29 | /** Notify server of new segment */ |
| 30 | int (*del_segment_callback) (u32 api_client_index, u64 segment_handle); |
| 31 | |
| 32 | /** Notify server of newly accepted session */ |
| 33 | int (*session_accept_callback) (session_t * new_session); |
| 34 | |
| 35 | /** Connection request callback */ |
| 36 | int (*session_connected_callback) (u32 app_wrk_index, u32 opaque, |
| 37 | session_t * s, u8 code); |
| 38 | |
| 39 | /** Notify app that session is closing */ |
| 40 | void (*session_disconnect_callback) (session_t * s); |
| 41 | |
Florin Coras | 692b949 | 2019-07-12 15:01:53 -0700 | [diff] [blame] | 42 | /** Notify app that transport is closed */ |
| 43 | void (*session_transport_closed_callback) (session_t * s); |
| 44 | |
Florin Coras | 70f26d5 | 2019-07-08 11:47:18 -0700 | [diff] [blame] | 45 | /** Notify app that session or transport are about to be removed */ |
| 46 | void (*session_cleanup_callback) (session_t * s, session_cleanup_ntf_t ntf); |
| 47 | |
Florin Coras | c1a4265 | 2019-02-08 18:27:29 -0800 | [diff] [blame] | 48 | /** Notify app that session was reset */ |
| 49 | void (*session_reset_callback) (session_t * s); |
| 50 | |
| 51 | /** Direct RX callback for built-in application */ |
| 52 | int (*builtin_app_rx_callback) (session_t * session); |
| 53 | |
| 54 | /** Direct TX callback for built-in application */ |
| 55 | int (*builtin_app_tx_callback) (session_t * session); |
| 56 | |
| 57 | } session_cb_vft_t; |
| 58 | |
| 59 | #define foreach_app_init_args \ |
| 60 | _(u32, api_client_index) \ |
| 61 | _(u8 *, name) \ |
| 62 | _(u64 *, options) \ |
| 63 | _(u8 *, namespace_id) \ |
| 64 | _(session_cb_vft_t *, session_cb_vft) \ |
| 65 | _(u32, app_index) \ |
| 66 | |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 67 | typedef struct _vnet_app_attach_args_t |
| 68 | { |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 69 | #define _(_type, _name) _type _name; |
| 70 | foreach_app_init_args |
| 71 | #undef _ |
| 72 | ssvm_private_t * segment; |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 73 | svm_msg_q_t *app_evt_q; |
Florin Coras | d85de68 | 2018-11-29 17:02:29 -0800 | [diff] [blame] | 74 | u64 segment_handle; |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 75 | } vnet_app_attach_args_t; |
| 76 | |
| 77 | typedef struct _vnet_app_detach_args_t |
| 78 | { |
| 79 | u32 app_index; |
Florin Coras | 053a0e4 | 2018-11-13 15:52:38 -0800 | [diff] [blame] | 80 | u32 api_client_index; |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 81 | } vnet_app_detach_args_t; |
| 82 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 83 | typedef struct _vnet_bind_args_t |
| 84 | { |
| 85 | union |
| 86 | { |
Florin Coras | 5665ced | 2018-10-25 18:03:45 -0700 | [diff] [blame] | 87 | session_endpoint_cfg_t sep_ext; |
Florin Coras | 3cbc04b | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 88 | session_endpoint_t sep; |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 89 | char *uri; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 90 | }; |
| 91 | |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 92 | u32 app_index; |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 93 | u32 wrk_map_index; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 94 | |
| 95 | /* |
| 96 | * Results |
| 97 | */ |
| 98 | char *segment_name; |
| 99 | u32 segment_name_length; |
| 100 | u64 server_event_queue_address; |
| 101 | u64 handle; |
Florin Coras | c9940fc | 2019-02-05 20:55:11 -0800 | [diff] [blame] | 102 | } vnet_listen_args_t; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 103 | |
Florin Coras | dfae9f9 | 2019-02-20 19:48:31 -0800 | [diff] [blame] | 104 | typedef struct _vnet_unlisten_args_t |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 105 | { |
| 106 | union |
| 107 | { |
| 108 | char *uri; |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 109 | u64 handle; /**< Session handle */ |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 110 | }; |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 111 | u32 app_index; /**< Owning application index */ |
Florin Coras | ab2f6db | 2018-08-31 14:31:41 -0700 | [diff] [blame] | 112 | u32 wrk_map_index; /**< App's local pool worker index */ |
Florin Coras | c1a4265 | 2019-02-08 18:27:29 -0800 | [diff] [blame] | 113 | } vnet_unlisten_args_t; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 114 | |
| 115 | typedef struct _vnet_connect_args |
| 116 | { |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 117 | union |
| 118 | { |
Florin Coras | 5665ced | 2018-10-25 18:03:45 -0700 | [diff] [blame] | 119 | session_endpoint_cfg_t sep_ext; |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 120 | session_endpoint_t sep; |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 121 | char *uri; |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 122 | }; |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 123 | u32 app_index; |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 124 | u32 wrk_map_index; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 125 | u32 api_context; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 126 | |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 127 | session_handle_t session_handle; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 128 | } vnet_connect_args_t; |
| 129 | |
| 130 | typedef struct _vnet_disconnect_args_t |
| 131 | { |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 132 | session_handle_t handle; |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 133 | u32 app_index; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 134 | } vnet_disconnect_args_t; |
| 135 | |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 136 | typedef struct _vnet_application_add_tls_cert_args_t |
| 137 | { |
| 138 | u32 app_index; |
| 139 | u8 *cert; |
| 140 | } vnet_app_add_tls_cert_args_t; |
| 141 | |
| 142 | typedef struct _vnet_application_add_tls_key_args_t |
| 143 | { |
| 144 | u32 app_index; |
| 145 | u8 *key; |
| 146 | } vnet_app_add_tls_key_args_t; |
| 147 | |
Florin Coras | 54a51fd | 2019-02-07 15:34:52 -0800 | [diff] [blame] | 148 | typedef enum tls_engine_type_ |
| 149 | { |
| 150 | TLS_ENGINE_NONE, |
| 151 | TLS_ENGINE_MBEDTLS, |
| 152 | TLS_ENGINE_OPENSSL, |
| 153 | TLS_N_ENGINES |
| 154 | } tls_engine_type_t; |
| 155 | |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 156 | /* Application attach options */ |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 157 | typedef enum |
| 158 | { |
Florin Coras | a546481 | 2017-04-19 13:00:05 -0700 | [diff] [blame] | 159 | APP_OPTIONS_FLAGS, |
Florin Coras | ff6e769 | 2017-12-11 04:59:01 -0800 | [diff] [blame] | 160 | APP_OPTIONS_EVT_QUEUE_SIZE, |
| 161 | APP_OPTIONS_SEGMENT_SIZE, |
| 162 | APP_OPTIONS_ADD_SEGMENT_SIZE, |
Dave Barach | 2c25a62 | 2017-06-26 11:35:07 -0400 | [diff] [blame] | 163 | APP_OPTIONS_PRIVATE_SEGMENT_COUNT, |
Florin Coras | ff6e769 | 2017-12-11 04:59:01 -0800 | [diff] [blame] | 164 | APP_OPTIONS_RX_FIFO_SIZE, |
| 165 | APP_OPTIONS_TX_FIFO_SIZE, |
| 166 | APP_OPTIONS_PREALLOC_FIFO_PAIRS, |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 167 | APP_OPTIONS_NAMESPACE, |
| 168 | APP_OPTIONS_NAMESPACE_SECRET, |
Florin Coras | 7999e83 | 2017-10-31 01:51:04 -0700 | [diff] [blame] | 169 | APP_OPTIONS_PROXY_TRANSPORT, |
Florin Coras | ff6e769 | 2017-12-11 04:59:01 -0800 | [diff] [blame] | 170 | APP_OPTIONS_ACCEPT_COOKIE, |
Florin Coras | 58d36f0 | 2018-03-09 13:05:53 -0800 | [diff] [blame] | 171 | APP_OPTIONS_TLS_ENGINE, |
Florin Coras | ff6e769 | 2017-12-11 04:59:01 -0800 | [diff] [blame] | 172 | APP_OPTIONS_N_OPTIONS |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 173 | } app_attach_options_index_t; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 174 | |
Florin Coras | a546481 | 2017-04-19 13:00:05 -0700 | [diff] [blame] | 175 | #define foreach_app_options_flags \ |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 176 | _(ACCEPT_REDIRECT, "Use FIFO with redirects") \ |
Florin Coras | a546481 | 2017-04-19 13:00:05 -0700 | [diff] [blame] | 177 | _(ADD_SEGMENT, "Add segment and signal app if needed") \ |
Florin Coras | 7999e83 | 2017-10-31 01:51:04 -0700 | [diff] [blame] | 178 | _(IS_BUILTIN, "Application is builtin") \ |
Florin Coras | da3eec1 | 2018-09-07 13:29:17 -0700 | [diff] [blame] | 179 | _(IS_TRANSPORT_APP, "Application is a transport proto") \ |
Florin Coras | 7e12d94 | 2018-06-27 14:32:43 -0700 | [diff] [blame] | 180 | _(IS_PROXY, "Application is proxying") \ |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 181 | _(USE_GLOBAL_SCOPE, "App can use global session scope") \ |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 182 | _(USE_LOCAL_SCOPE, "App can use local session scope") \ |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 183 | _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \ |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 184 | |
Florin Coras | a546481 | 2017-04-19 13:00:05 -0700 | [diff] [blame] | 185 | typedef enum _app_options |
| 186 | { |
| 187 | #define _(sym, str) APP_OPTIONS_##sym, |
| 188 | foreach_app_options_flags |
| 189 | #undef _ |
| 190 | } app_options_t; |
| 191 | |
| 192 | typedef enum _app_options_flags |
| 193 | { |
| 194 | #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym, |
| 195 | foreach_app_options_flags |
| 196 | #undef _ |
| 197 | } app_options_flags_t; |
| 198 | |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 199 | #define foreach_fd_type \ |
| 200 | _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \ |
| 201 | _(MEMFD_SEGMENT, "Fd for memfd segment") \ |
| 202 | _(MQ_EVENTFD, "Event fd used by message queue") \ |
| 203 | _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \ |
| 204 | |
| 205 | typedef enum session_fd_type_ |
| 206 | { |
| 207 | #define _(sym, str) SESSION_FD_##sym, |
| 208 | foreach_fd_type |
| 209 | #undef _ |
| 210 | SESSION_N_FD_TYPE |
| 211 | } session_fd_type_t; |
| 212 | |
| 213 | typedef enum session_fd_flag_ |
| 214 | { |
| 215 | #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym, |
| 216 | foreach_fd_type |
| 217 | #undef _ |
| 218 | } session_fd_flag_t; |
| 219 | |
Aloys Augustin | 502785b | 2019-04-09 11:40:57 +0200 | [diff] [blame] | 220 | int parse_uri (char *uri, session_endpoint_cfg_t * sep); |
Florin Coras | c9940fc | 2019-02-05 20:55:11 -0800 | [diff] [blame] | 221 | int vnet_bind_uri (vnet_listen_args_t *); |
Florin Coras | c1a4265 | 2019-02-08 18:27:29 -0800 | [diff] [blame] | 222 | int vnet_unbind_uri (vnet_unlisten_args_t * a); |
| 223 | int vnet_connect_uri (vnet_connect_args_t * a); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 224 | |
Florin Coras | c1a4265 | 2019-02-08 18:27:29 -0800 | [diff] [blame] | 225 | int vnet_application_attach (vnet_app_attach_args_t * a); |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 226 | int vnet_application_detach (vnet_app_detach_args_t * a); |
Florin Coras | c1a4265 | 2019-02-08 18:27:29 -0800 | [diff] [blame] | 227 | int vnet_listen (vnet_listen_args_t * a); |
| 228 | int vnet_connect (vnet_connect_args_t * a); |
| 229 | int vnet_unlisten (vnet_unlisten_args_t * a); |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 230 | int vnet_disconnect_session (vnet_disconnect_args_t * a); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 231 | |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 232 | clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a); |
| 233 | clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 234 | |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 235 | typedef struct app_session_transport_ |
| 236 | { |
| 237 | ip46_address_t rmt_ip; /**< remote ip */ |
| 238 | ip46_address_t lcl_ip; /**< local ip */ |
Florin Coras | 7e12d94 | 2018-06-27 14:32:43 -0700 | [diff] [blame] | 239 | u16 rmt_port; /**< remote port (network order) */ |
| 240 | u16 lcl_port; /**< local port (network order) */ |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 241 | u8 is_ip4; /**< set if uses ip4 networking */ |
| 242 | } app_session_transport_t; |
| 243 | |
Florin Coras | 7e12d94 | 2018-06-27 14:32:43 -0700 | [diff] [blame] | 244 | #define foreach_app_session_field \ |
| 245 | _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \ |
| 246 | _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \ |
| 247 | _(session_type_t, session_type) /**< session type */ \ |
| 248 | _(volatile u8, session_state) /**< session state */ \ |
| 249 | _(u32, session_index) /**< index in owning pool */ \ |
| 250 | _(app_session_transport_t, transport) /**< transport info */ \ |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 251 | _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \ |
Florin Coras | 7e12d94 | 2018-06-27 14:32:43 -0700 | [diff] [blame] | 252 | _(u8, is_dgram) /**< flag for dgram mode */ \ |
| 253 | |
| 254 | typedef struct |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 255 | { |
Florin Coras | 7e12d94 | 2018-06-27 14:32:43 -0700 | [diff] [blame] | 256 | #define _(type, name) type name; |
| 257 | foreach_app_session_field |
| 258 | #undef _ |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 259 | } app_session_t; |
| 260 | |
Florin Coras | 6011699 | 2018-08-27 09:52:18 -0700 | [diff] [blame] | 261 | typedef struct session_bound_msg_ |
| 262 | { |
| 263 | u32 context; |
| 264 | u64 handle; |
| 265 | i32 retval; |
| 266 | u8 lcl_is_ip4; |
| 267 | u8 lcl_ip[16]; |
| 268 | u16 lcl_port; |
Florin Coras | 30e79c2 | 2019-01-02 19:31:22 -0800 | [diff] [blame] | 269 | uword rx_fifo; |
| 270 | uword tx_fifo; |
| 271 | uword vpp_evt_q; |
Florin Coras | 6011699 | 2018-08-27 09:52:18 -0700 | [diff] [blame] | 272 | u32 segment_size; |
| 273 | u8 segment_name_length; |
| 274 | u8 segment_name[128]; |
| 275 | } __clib_packed session_bound_msg_t; |
| 276 | |
Florin Coras | dfae9f9 | 2019-02-20 19:48:31 -0800 | [diff] [blame] | 277 | typedef struct session_unlisten_reply_msg_ |
| 278 | { |
| 279 | u32 context; |
| 280 | u64 handle; |
| 281 | i32 retval; |
| 282 | } __clib_packed session_unlisten_reply_msg_t; |
| 283 | |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 284 | typedef struct session_accepted_msg_ |
| 285 | { |
| 286 | u32 context; |
| 287 | u64 listener_handle; |
| 288 | u64 handle; |
Florin Coras | 30e79c2 | 2019-01-02 19:31:22 -0800 | [diff] [blame] | 289 | uword server_rx_fifo; |
| 290 | uword server_tx_fifo; |
Florin Coras | fa76a76 | 2018-11-29 12:40:10 -0800 | [diff] [blame] | 291 | u64 segment_handle; |
Florin Coras | 30e79c2 | 2019-01-02 19:31:22 -0800 | [diff] [blame] | 292 | uword vpp_event_queue_address; |
Florin Coras | 09d18c2 | 2019-04-24 11:10:02 -0700 | [diff] [blame] | 293 | transport_endpoint_t rmt; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 294 | } __clib_packed session_accepted_msg_t; |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 295 | |
| 296 | typedef struct session_accepted_reply_msg_ |
| 297 | { |
| 298 | u32 context; |
| 299 | i32 retval; |
| 300 | u64 handle; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 301 | } __clib_packed session_accepted_reply_msg_t; |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 302 | |
| 303 | /* Make sure this is not too large, otherwise it won't fit when dequeued in |
| 304 | * the session queue node */ |
| 305 | STATIC_ASSERT (sizeof (session_accepted_reply_msg_t) <= 16, "accept reply"); |
| 306 | |
| 307 | typedef struct session_connected_msg_ |
| 308 | { |
| 309 | u32 context; |
| 310 | i32 retval; |
| 311 | u64 handle; |
Florin Coras | 30e79c2 | 2019-01-02 19:31:22 -0800 | [diff] [blame] | 312 | uword server_rx_fifo; |
| 313 | uword server_tx_fifo; |
Florin Coras | fa76a76 | 2018-11-29 12:40:10 -0800 | [diff] [blame] | 314 | u64 segment_handle; |
Florin Coras | 653e43f | 2019-03-04 10:56:23 -0800 | [diff] [blame] | 315 | uword ct_rx_fifo; |
| 316 | uword ct_tx_fifo; |
| 317 | u64 ct_segment_handle; |
Florin Coras | 30e79c2 | 2019-01-02 19:31:22 -0800 | [diff] [blame] | 318 | uword vpp_event_queue_address; |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 319 | u32 segment_size; |
| 320 | u8 segment_name_length; |
| 321 | u8 segment_name[64]; |
Florin Coras | 09d18c2 | 2019-04-24 11:10:02 -0700 | [diff] [blame] | 322 | transport_endpoint_t lcl; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 323 | } __clib_packed session_connected_msg_t; |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 324 | |
| 325 | typedef struct session_disconnected_msg_ |
| 326 | { |
| 327 | u32 client_index; |
| 328 | u32 context; |
| 329 | u64 handle; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 330 | } __clib_packed session_disconnected_msg_t; |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 331 | |
| 332 | typedef struct session_disconnected_reply_msg_ |
| 333 | { |
| 334 | u32 context; |
| 335 | i32 retval; |
| 336 | u64 handle; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 337 | } __clib_packed session_disconnected_reply_msg_t; |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 338 | |
| 339 | typedef struct session_reset_msg_ |
| 340 | { |
| 341 | u32 client_index; |
| 342 | u32 context; |
| 343 | u64 handle; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 344 | } __clib_packed session_reset_msg_t; |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 345 | |
| 346 | typedef struct session_reset_reply_msg_ |
| 347 | { |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 348 | u32 context; |
| 349 | i32 retval; |
| 350 | u64 handle; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 351 | } __clib_packed session_reset_reply_msg_t; |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 352 | |
Florin Coras | 30e79c2 | 2019-01-02 19:31:22 -0800 | [diff] [blame] | 353 | typedef struct session_req_worker_update_msg_ |
| 354 | { |
| 355 | u64 session_handle; |
| 356 | } __clib_packed session_req_worker_update_msg_t; |
| 357 | |
| 358 | /* NOTE: using u16 for wrk indices because message needs to fit in 18B */ |
| 359 | typedef struct session_worker_update_msg_ |
| 360 | { |
| 361 | u32 client_index; |
| 362 | u16 wrk_index; |
| 363 | u16 req_wrk_index; |
| 364 | u64 handle; |
| 365 | } __clib_packed session_worker_update_msg_t; |
| 366 | |
| 367 | typedef struct session_worker_update_reply_msg_ |
| 368 | { |
| 369 | u64 handle; |
| 370 | uword rx_fifo; |
| 371 | uword tx_fifo; |
| 372 | u64 segment_handle; |
| 373 | } __clib_packed session_worker_update_reply_msg_t; |
| 374 | |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 375 | typedef struct app_session_event_ |
| 376 | { |
| 377 | svm_msg_q_msg_t msg; |
| 378 | session_event_t *evt; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 379 | } __clib_packed app_session_evt_t; |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 380 | |
| 381 | static inline void |
| 382 | app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt, |
| 383 | u8 evt_type) |
| 384 | { |
| 385 | svm_msg_q_lock_and_alloc_msg_w_ring (mq, |
| 386 | SESSION_MQ_CTRL_EVT_RING, |
| 387 | SVM_Q_WAIT, &app_evt->msg); |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 388 | app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg); |
Dave Barach | b7b9299 | 2018-10-17 10:38:51 -0400 | [diff] [blame] | 389 | clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt)); |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 390 | app_evt->evt->event_type = evt_type; |
| 391 | } |
| 392 | |
| 393 | static inline void |
| 394 | app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt) |
| 395 | { |
Florin Coras | 0dfbce6 | 2019-07-15 07:48:27 -0700 | [diff] [blame] | 396 | svm_msg_q_add_and_unlock (mq, &app_evt->msg); |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 397 | } |
| 398 | |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 399 | /** |
| 400 | * Send fifo io event to vpp worker thread |
| 401 | * |
| 402 | * Because there may be multiple writers to one of vpp's queues, this |
| 403 | * protects message allocation and enqueueing. |
| 404 | * |
| 405 | * @param mq vpp message queue |
| 406 | * @param f fifo for which the event is sent |
| 407 | * @param evt_type type of event |
| 408 | * @param noblock flag to indicate is request is blocking or not |
| 409 | * @return 0 if success, negative integer otherwise |
| 410 | */ |
| 411 | static inline int |
Florin Coras | c0737e9 | 2019-03-04 14:19:39 -0800 | [diff] [blame] | 412 | app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type, |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 413 | u8 noblock) |
| 414 | { |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 415 | session_event_t *evt; |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 416 | svm_msg_q_msg_t msg; |
| 417 | |
| 418 | if (noblock) |
| 419 | { |
| 420 | if (svm_msg_q_try_lock (mq)) |
| 421 | return -1; |
| 422 | if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING))) |
| 423 | { |
| 424 | svm_msg_q_unlock (mq); |
| 425 | return -2; |
| 426 | } |
| 427 | msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING); |
| 428 | if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg))) |
| 429 | { |
| 430 | svm_msg_q_unlock (mq); |
| 431 | return -2; |
| 432 | } |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 433 | evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg); |
Florin Coras | c0737e9 | 2019-03-04 14:19:39 -0800 | [diff] [blame] | 434 | evt->session_index = session_index; |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 435 | evt->event_type = evt_type; |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 436 | svm_msg_q_add_and_unlock (mq, &msg); |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 437 | return 0; |
| 438 | } |
| 439 | else |
| 440 | { |
| 441 | svm_msg_q_lock (mq); |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 442 | while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)) |
| 443 | svm_msg_q_wait (mq); |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 444 | msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING); |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 445 | evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg); |
Florin Coras | c0737e9 | 2019-03-04 14:19:39 -0800 | [diff] [blame] | 446 | evt->session_index = session_index; |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 447 | evt->event_type = evt_type; |
| 448 | if (svm_msg_q_is_full (mq)) |
| 449 | svm_msg_q_wait (mq); |
Florin Coras | 52207f1 | 2018-07-12 14:48:06 -0700 | [diff] [blame] | 450 | svm_msg_q_add_and_unlock (mq, &msg); |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 451 | return 0; |
| 452 | } |
| 453 | } |
| 454 | |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 455 | always_inline int |
| 456 | app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at, |
Florin Coras | 460dce6 | 2018-07-27 05:45:06 -0700 | [diff] [blame] | 457 | svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type, |
Florin Coras | 653e43f | 2019-03-04 10:56:23 -0800 | [diff] [blame] | 458 | u8 do_evt, u8 noblock) |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 459 | { |
| 460 | u32 max_enqueue, actual_write; |
| 461 | session_dgram_hdr_t hdr; |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 462 | int rv; |
| 463 | |
Sirshak Das | 28aa539 | 2019-02-05 01:33:33 -0600 | [diff] [blame] | 464 | max_enqueue = svm_fifo_max_enqueue_prod (f); |
Florin Coras | 8e43d04 | 2018-05-04 15:46:57 -0700 | [diff] [blame] | 465 | if (max_enqueue <= sizeof (session_dgram_hdr_t)) |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 466 | return 0; |
| 467 | |
| 468 | max_enqueue -= sizeof (session_dgram_hdr_t); |
| 469 | actual_write = clib_min (len, max_enqueue); |
| 470 | hdr.data_length = actual_write; |
| 471 | hdr.data_offset = 0; |
Dave Barach | 178cf49 | 2018-11-13 16:34:13 -0500 | [diff] [blame] | 472 | clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t)); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 473 | hdr.is_ip4 = at->is_ip4; |
| 474 | hdr.rmt_port = at->rmt_port; |
Dave Barach | 178cf49 | 2018-11-13 16:34:13 -0500 | [diff] [blame] | 475 | clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t)); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 476 | hdr.lcl_port = at->lcl_port; |
Florin Coras | 87b15ce | 2019-04-28 21:16:30 -0700 | [diff] [blame] | 477 | rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 478 | ASSERT (rv == sizeof (hdr)); |
| 479 | |
Florin Coras | 87b15ce | 2019-04-28 21:16:30 -0700 | [diff] [blame] | 480 | rv = svm_fifo_enqueue (f, actual_write, data); |
Florin Coras | 4b76112 | 2019-03-21 13:54:53 -0700 | [diff] [blame] | 481 | if (do_evt) |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 482 | { |
Florin Coras | 4b76112 | 2019-03-21 13:54:53 -0700 | [diff] [blame] | 483 | if (rv > 0 && svm_fifo_set_event (f)) |
Florin Coras | c0737e9 | 2019-03-04 14:19:39 -0800 | [diff] [blame] | 484 | app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type, |
| 485 | noblock); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 486 | } |
Florin Coras | 8e43d04 | 2018-05-04 15:46:57 -0700 | [diff] [blame] | 487 | ASSERT (rv); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 488 | return rv; |
| 489 | } |
| 490 | |
| 491 | always_inline int |
| 492 | app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock) |
| 493 | { |
| 494 | return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data, |
Florin Coras | 653e43f | 2019-03-04 10:56:23 -0800 | [diff] [blame] | 495 | len, SESSION_IO_EVT_TX, 1 /* do_evt */ , |
| 496 | noblock); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 497 | } |
| 498 | |
| 499 | always_inline int |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 500 | app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data, |
Florin Coras | 653e43f | 2019-03-04 10:56:23 -0800 | [diff] [blame] | 501 | u32 len, u8 evt_type, u8 do_evt, u8 noblock) |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 502 | { |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 503 | int rv; |
| 504 | |
Florin Coras | 87b15ce | 2019-04-28 21:16:30 -0700 | [diff] [blame] | 505 | rv = svm_fifo_enqueue (f, len, data); |
Florin Coras | 4b76112 | 2019-03-21 13:54:53 -0700 | [diff] [blame] | 506 | if (do_evt) |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 507 | { |
Florin Coras | 4b76112 | 2019-03-21 13:54:53 -0700 | [diff] [blame] | 508 | if (rv > 0 && svm_fifo_set_event (f)) |
Florin Coras | c0737e9 | 2019-03-04 14:19:39 -0800 | [diff] [blame] | 509 | app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type, |
| 510 | noblock); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 511 | } |
| 512 | return rv; |
| 513 | } |
| 514 | |
| 515 | always_inline int |
| 516 | app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock) |
| 517 | { |
Florin Coras | 460dce6 | 2018-07-27 05:45:06 -0700 | [diff] [blame] | 518 | return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len, |
Florin Coras | 653e43f | 2019-03-04 10:56:23 -0800 | [diff] [blame] | 519 | SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 520 | } |
| 521 | |
| 522 | always_inline int |
| 523 | app_send (app_session_t * s, u8 * data, u32 len, u8 noblock) |
| 524 | { |
| 525 | if (s->is_dgram) |
| 526 | return app_send_dgram (s, data, len, noblock); |
| 527 | return app_send_stream (s, data, len, noblock); |
| 528 | } |
| 529 | |
| 530 | always_inline int |
| 531 | app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len, |
Florin Coras | 460dce6 | 2018-07-27 05:45:06 -0700 | [diff] [blame] | 532 | app_session_transport_t * at, u8 clear_evt, u8 peek) |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 533 | { |
| 534 | session_dgram_pre_hdr_t ph; |
| 535 | u32 max_deq; |
| 536 | int rv; |
| 537 | |
Sirshak Das | 28aa539 | 2019-02-05 01:33:33 -0600 | [diff] [blame] | 538 | max_deq = svm_fifo_max_dequeue_cons (f); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 539 | if (max_deq < sizeof (session_dgram_hdr_t)) |
Florin Coras | 460dce6 | 2018-07-27 05:45:06 -0700 | [diff] [blame] | 540 | { |
| 541 | if (clear_evt) |
| 542 | svm_fifo_unset_event (f); |
| 543 | return 0; |
| 544 | } |
| 545 | |
| 546 | if (clear_evt) |
| 547 | svm_fifo_unset_event (f); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 548 | |
| 549 | svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph); |
| 550 | ASSERT (ph.data_length >= ph.data_offset); |
| 551 | if (!ph.data_offset) |
| 552 | svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at); |
| 553 | len = clib_min (len, ph.data_length - ph.data_offset); |
| 554 | rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf); |
Florin Coras | 460dce6 | 2018-07-27 05:45:06 -0700 | [diff] [blame] | 555 | if (peek) |
| 556 | return rv; |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 557 | ph.data_offset += rv; |
| 558 | if (ph.data_offset == ph.data_length) |
| 559 | svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN); |
| 560 | else |
| 561 | svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph)); |
| 562 | return rv; |
| 563 | } |
| 564 | |
| 565 | always_inline int |
| 566 | app_recv_dgram (app_session_t * s, u8 * buf, u32 len) |
| 567 | { |
Florin Coras | 460dce6 | 2018-07-27 05:45:06 -0700 | [diff] [blame] | 568 | return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 569 | } |
| 570 | |
| 571 | always_inline int |
Florin Coras | 460dce6 | 2018-07-27 05:45:06 -0700 | [diff] [blame] | 572 | app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek) |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 573 | { |
| 574 | if (clear_evt) |
| 575 | svm_fifo_unset_event (f); |
Florin Coras | 460dce6 | 2018-07-27 05:45:06 -0700 | [diff] [blame] | 576 | |
| 577 | if (peek) |
| 578 | return svm_fifo_peek (f, 0, len, buf); |
| 579 | |
Florin Coras | 87b15ce | 2019-04-28 21:16:30 -0700 | [diff] [blame] | 580 | return svm_fifo_dequeue (f, len, buf); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 581 | } |
| 582 | |
| 583 | always_inline int |
| 584 | app_recv_stream (app_session_t * s, u8 * buf, u32 len) |
| 585 | { |
Florin Coras | 460dce6 | 2018-07-27 05:45:06 -0700 | [diff] [blame] | 586 | return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 587 | } |
| 588 | |
| 589 | always_inline int |
| 590 | app_recv (app_session_t * s, u8 * data, u32 len) |
| 591 | { |
| 592 | if (s->is_dgram) |
| 593 | return app_recv_dgram (s, data, len); |
| 594 | return app_recv_stream (s, data, len); |
| 595 | } |
| 596 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 597 | #endif /* __included_uri_h__ */ |
| 598 | |
| 599 | /* |
| 600 | * fd.io coding-style-patch-verification: ON |
| 601 | * |
| 602 | * Local Variables: |
| 603 | * eval: (c-set-style "gnu") |
| 604 | * End: |
| 605 | */ |