blob: ec29d18b59b8d0e183a011a0f9a43aca6095a05e [file] [log] [blame]
Dave Barach68b0fb02017-02-28 15:15:56 -05001/*
Florin Coras288eaab2019-02-03 15:26:14 -08002 * Copyright (c) 2016-2019 Cisco and/or its affiliates.
Dave Barach68b0fb02017-02-28 15:15:56 -05003 * 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 Corasc1a42652019-02-08 18:27:29 -080018#include <vlibmemory/api.h>
19#include <svm/message_queue.h>
Florin Corasc9940fc2019-02-05 20:55:11 -080020#include <vnet/session/session_types.h>
Florin Coras54a51fd2019-02-07 15:34:52 -080021#include <vnet/tls/tls_test.h>
Florin Coras88001c62019-04-24 14:44:46 -070022#include <svm/fifo_segment.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050023
Nathan Skrzypczak79f89532019-09-13 11:08:13 +020024typedef struct certificate_
25{
26 u32 *app_interests; /* vec of application index asking for deletion cb */
27 u32 cert_key_index; /* index in cert & key pool */
28 u8 *key;
29 u8 *cert;
30} app_cert_key_pair_t;
31
Florin Corasc1a42652019-02-08 18:27:29 -080032typedef struct _stream_session_cb_vft
33{
34 /** Notify server of new segment */
35 int (*add_segment_callback) (u32 api_client_index, u64 segment_handle);
36
37 /** Notify server of new segment */
38 int (*del_segment_callback) (u32 api_client_index, u64 segment_handle);
39
40 /** Notify server of newly accepted session */
41 int (*session_accept_callback) (session_t * new_session);
42
43 /** Connection request callback */
44 int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
45 session_t * s, u8 code);
46
47 /** Notify app that session is closing */
48 void (*session_disconnect_callback) (session_t * s);
49
Florin Coras692b9492019-07-12 15:01:53 -070050 /** Notify app that transport is closed */
51 void (*session_transport_closed_callback) (session_t * s);
52
Florin Coras70f26d52019-07-08 11:47:18 -070053 /** Notify app that session or transport are about to be removed */
54 void (*session_cleanup_callback) (session_t * s, session_cleanup_ntf_t ntf);
55
Florin Corasc1a42652019-02-08 18:27:29 -080056 /** Notify app that session was reset */
57 void (*session_reset_callback) (session_t * s);
58
Florin Coras49568af2019-07-31 16:46:24 -070059 /** Notify app that session pool migration happened */
60 void (*session_migrate_callback) (session_t * s, session_handle_t new_sh);
61
Florin Corasc1a42652019-02-08 18:27:29 -080062 /** Direct RX callback for built-in application */
63 int (*builtin_app_rx_callback) (session_t * session);
64
65 /** Direct TX callback for built-in application */
66 int (*builtin_app_tx_callback) (session_t * session);
67
Nathan Skrzypczak79f89532019-09-13 11:08:13 +020068 /** Cert and key pair delete notification */
69 int (*app_cert_key_pair_delete_callback) (app_cert_key_pair_t * ckpair);
70
Florin Corasc1a42652019-02-08 18:27:29 -080071} session_cb_vft_t;
72
73#define foreach_app_init_args \
74 _(u32, api_client_index) \
75 _(u8 *, name) \
76 _(u64 *, options) \
77 _(u8 *, namespace_id) \
78 _(session_cb_vft_t *, session_cb_vft) \
79 _(u32, app_index) \
80
Florin Coras6cf30ad2017-04-04 23:08:23 -070081typedef struct _vnet_app_attach_args_t
82{
Florin Coras15531972018-08-12 23:50:53 -070083#define _(_type, _name) _type _name;
84 foreach_app_init_args
85#undef _
86 ssvm_private_t * segment;
Florin Coras99368312018-08-02 10:45:44 -070087 svm_msg_q_t *app_evt_q;
Florin Corasd85de682018-11-29 17:02:29 -080088 u64 segment_handle;
Florin Coras6cf30ad2017-04-04 23:08:23 -070089} vnet_app_attach_args_t;
90
91typedef struct _vnet_app_detach_args_t
92{
93 u32 app_index;
Florin Coras053a0e42018-11-13 15:52:38 -080094 u32 api_client_index;
Florin Coras6cf30ad2017-04-04 23:08:23 -070095} vnet_app_detach_args_t;
96
Dave Barach68b0fb02017-02-28 15:15:56 -050097typedef struct _vnet_bind_args_t
98{
99 union
100 {
Florin Coras5665ced2018-10-25 18:03:45 -0700101 session_endpoint_cfg_t sep_ext;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700102 session_endpoint_t sep;
Florin Coras15531972018-08-12 23:50:53 -0700103 char *uri;
Dave Barach68b0fb02017-02-28 15:15:56 -0500104 };
105
Florin Coras6cf30ad2017-04-04 23:08:23 -0700106 u32 app_index;
Florin Coras15531972018-08-12 23:50:53 -0700107 u32 wrk_map_index;
Dave Barach68b0fb02017-02-28 15:15:56 -0500108
109 /*
110 * Results
111 */
112 char *segment_name;
113 u32 segment_name_length;
114 u64 server_event_queue_address;
115 u64 handle;
Florin Corasc9940fc2019-02-05 20:55:11 -0800116} vnet_listen_args_t;
Dave Barach68b0fb02017-02-28 15:15:56 -0500117
Florin Corasdfae9f92019-02-20 19:48:31 -0800118typedef struct _vnet_unlisten_args_t
Dave Barach68b0fb02017-02-28 15:15:56 -0500119{
120 union
121 {
122 char *uri;
Florin Coras15531972018-08-12 23:50:53 -0700123 u64 handle; /**< Session handle */
Dave Barach68b0fb02017-02-28 15:15:56 -0500124 };
Florin Coras15531972018-08-12 23:50:53 -0700125 u32 app_index; /**< Owning application index */
Florin Corasab2f6db2018-08-31 14:31:41 -0700126 u32 wrk_map_index; /**< App's local pool worker index */
Florin Corasc1a42652019-02-08 18:27:29 -0800127} vnet_unlisten_args_t;
Dave Barach68b0fb02017-02-28 15:15:56 -0500128
129typedef struct _vnet_connect_args
130{
Florin Coras371ca502018-02-21 12:07:41 -0800131 union
132 {
Florin Coras5665ced2018-10-25 18:03:45 -0700133 session_endpoint_cfg_t sep_ext;
Florin Coras15531972018-08-12 23:50:53 -0700134 session_endpoint_t sep;
Florin Coras371ca502018-02-21 12:07:41 -0800135 char *uri;
Florin Coras371ca502018-02-21 12:07:41 -0800136 };
Florin Coras6cf30ad2017-04-04 23:08:23 -0700137 u32 app_index;
Florin Coras15531972018-08-12 23:50:53 -0700138 u32 wrk_map_index;
Dave Barach68b0fb02017-02-28 15:15:56 -0500139 u32 api_context;
Dave Barach68b0fb02017-02-28 15:15:56 -0500140
Florin Corasf8f516a2018-02-08 15:10:09 -0800141 session_handle_t session_handle;
Dave Barach68b0fb02017-02-28 15:15:56 -0500142} vnet_connect_args_t;
143
144typedef struct _vnet_disconnect_args_t
145{
Florin Corasf8f516a2018-02-08 15:10:09 -0800146 session_handle_t handle;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700147 u32 app_index;
Dave Barach68b0fb02017-02-28 15:15:56 -0500148} vnet_disconnect_args_t;
149
Florin Coras371ca502018-02-21 12:07:41 -0800150typedef struct _vnet_application_add_tls_cert_args_t
151{
152 u32 app_index;
153 u8 *cert;
154} vnet_app_add_tls_cert_args_t;
155
156typedef struct _vnet_application_add_tls_key_args_t
157{
158 u32 app_index;
159 u8 *key;
160} vnet_app_add_tls_key_args_t;
161
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200162typedef enum crypto_engine_type_
Florin Coras54a51fd2019-02-07 15:34:52 -0800163{
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200164 CRYPTO_ENGINE_NONE,
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200165 CRYPTO_ENGINE_OPENSSL,
Yu Ping98bd3582019-10-21 23:23:44 +0800166 CRYPTO_ENGINE_MBEDTLS,
Nathan Skrzypczak8095b602019-09-12 16:02:13 +0200167 CRYPTO_ENGINE_VPP,
168 CRYPTO_ENGINE_PICOTLS,
Florin Coras79ba25d2019-10-20 19:32:47 -0700169 CRYPTO_ENGINE_LAST = CRYPTO_ENGINE_PICOTLS,
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200170} crypto_engine_type_t;
Florin Coras54a51fd2019-02-07 15:34:52 -0800171
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200172typedef struct _vnet_app_add_cert_key_pair_args_
173{
174 u8 *cert;
175 u8 *key;
176 u32 index;
177} vnet_app_add_cert_key_pair_args_t;
178
Nathan Skrzypczakde6caf42019-10-09 14:41:48 +0200179typedef struct crypto_ctx_
180{
181 u32 ctx_index; /**< index in crypto context pool */
182 u32 n_subscribers; /**< refcount of sessions using said context */
183 u32 ckpair_index; /**< certificate & key */
184 u8 crypto_engine;
Nathan Skrzypczakde6caf42019-10-09 14:41:48 +0200185} crypto_context_t;
186
Florin Coras6cf30ad2017-04-04 23:08:23 -0700187/* Application attach options */
Dave Barach68b0fb02017-02-28 15:15:56 -0500188typedef enum
189{
Florin Corasa5464812017-04-19 13:00:05 -0700190 APP_OPTIONS_FLAGS,
Florin Corasff6e7692017-12-11 04:59:01 -0800191 APP_OPTIONS_EVT_QUEUE_SIZE,
192 APP_OPTIONS_SEGMENT_SIZE,
193 APP_OPTIONS_ADD_SEGMENT_SIZE,
Dave Barach2c25a622017-06-26 11:35:07 -0400194 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
Florin Corasff6e7692017-12-11 04:59:01 -0800195 APP_OPTIONS_RX_FIFO_SIZE,
196 APP_OPTIONS_TX_FIFO_SIZE,
197 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
Florin Corascea194d2017-10-02 00:18:51 -0700198 APP_OPTIONS_NAMESPACE,
199 APP_OPTIONS_NAMESPACE_SECRET,
Florin Coras7999e832017-10-31 01:51:04 -0700200 APP_OPTIONS_PROXY_TRANSPORT,
Florin Corasff6e7692017-12-11 04:59:01 -0800201 APP_OPTIONS_ACCEPT_COOKIE,
Florin Coras58d36f02018-03-09 13:05:53 -0800202 APP_OPTIONS_TLS_ENGINE,
Florin Corasff6e7692017-12-11 04:59:01 -0800203 APP_OPTIONS_N_OPTIONS
Florin Coras6cf30ad2017-04-04 23:08:23 -0700204} app_attach_options_index_t;
Dave Barach68b0fb02017-02-28 15:15:56 -0500205
Florin Corasa5464812017-04-19 13:00:05 -0700206#define foreach_app_options_flags \
Florin Corascea194d2017-10-02 00:18:51 -0700207 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
Florin Corasa5464812017-04-19 13:00:05 -0700208 _(ADD_SEGMENT, "Add segment and signal app if needed") \
Florin Coras7999e832017-10-31 01:51:04 -0700209 _(IS_BUILTIN, "Application is builtin") \
Florin Corasda3eec12018-09-07 13:29:17 -0700210 _(IS_TRANSPORT_APP, "Application is a transport proto") \
Florin Coras7e12d942018-06-27 14:32:43 -0700211 _(IS_PROXY, "Application is proxying") \
Florin Corascea194d2017-10-02 00:18:51 -0700212 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
Florin Coras3c2fed52018-07-04 04:15:05 -0700213 _(USE_LOCAL_SCOPE, "App can use local session scope") \
Florin Coras99368312018-08-02 10:45:44 -0700214 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
Dave Barach68b0fb02017-02-28 15:15:56 -0500215
Florin Corasa5464812017-04-19 13:00:05 -0700216typedef enum _app_options
217{
218#define _(sym, str) APP_OPTIONS_##sym,
219 foreach_app_options_flags
220#undef _
221} app_options_t;
222
223typedef enum _app_options_flags
224{
225#define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
226 foreach_app_options_flags
227#undef _
228} app_options_flags_t;
229
Florin Coras99368312018-08-02 10:45:44 -0700230#define foreach_fd_type \
231 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
232 _(MEMFD_SEGMENT, "Fd for memfd segment") \
233 _(MQ_EVENTFD, "Event fd used by message queue") \
234 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
235
236typedef enum session_fd_type_
237{
238#define _(sym, str) SESSION_FD_##sym,
239 foreach_fd_type
240#undef _
241 SESSION_N_FD_TYPE
242} session_fd_type_t;
243
244typedef enum session_fd_flag_
245{
246#define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
247 foreach_fd_type
248#undef _
249} session_fd_flag_t;
250
Aloys Augustin502785b2019-04-09 11:40:57 +0200251int parse_uri (char *uri, session_endpoint_cfg_t * sep);
Florin Corasc9940fc2019-02-05 20:55:11 -0800252int vnet_bind_uri (vnet_listen_args_t *);
Florin Corasc1a42652019-02-08 18:27:29 -0800253int vnet_unbind_uri (vnet_unlisten_args_t * a);
254int vnet_connect_uri (vnet_connect_args_t * a);
Dave Barach68b0fb02017-02-28 15:15:56 -0500255
Florin Corasc1a42652019-02-08 18:27:29 -0800256int vnet_application_attach (vnet_app_attach_args_t * a);
Florin Coras371ca502018-02-21 12:07:41 -0800257int vnet_application_detach (vnet_app_detach_args_t * a);
Florin Corasc1a42652019-02-08 18:27:29 -0800258int vnet_listen (vnet_listen_args_t * a);
259int vnet_connect (vnet_connect_args_t * a);
260int vnet_unlisten (vnet_unlisten_args_t * a);
Florin Coras371ca502018-02-21 12:07:41 -0800261int vnet_disconnect_session (vnet_disconnect_args_t * a);
Dave Barach68b0fb02017-02-28 15:15:56 -0500262
Florin Coras371ca502018-02-21 12:07:41 -0800263clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
264clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200265int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
266int vnet_app_del_cert_key_pair (u32 index);
Nathan Skrzypczak7fbdb6a2019-10-09 16:23:26 +0200267/** Ask for app cb on pair deletion */
268int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500269
Florin Coras7fb0fe12018-04-09 09:24:52 -0700270typedef struct app_session_transport_
271{
272 ip46_address_t rmt_ip; /**< remote ip */
273 ip46_address_t lcl_ip; /**< local ip */
Florin Coras7e12d942018-06-27 14:32:43 -0700274 u16 rmt_port; /**< remote port (network order) */
275 u16 lcl_port; /**< local port (network order) */
Florin Coras7fb0fe12018-04-09 09:24:52 -0700276 u8 is_ip4; /**< set if uses ip4 networking */
277} app_session_transport_t;
278
Florin Coras7e12d942018-06-27 14:32:43 -0700279#define foreach_app_session_field \
280 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
281 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
282 _(session_type_t, session_type) /**< session type */ \
283 _(volatile u8, session_state) /**< session state */ \
284 _(u32, session_index) /**< index in owning pool */ \
285 _(app_session_transport_t, transport) /**< transport info */ \
Florin Coras3c2fed52018-07-04 04:15:05 -0700286 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
Florin Coras7e12d942018-06-27 14:32:43 -0700287 _(u8, is_dgram) /**< flag for dgram mode */ \
288
289typedef struct
Florin Coras7fb0fe12018-04-09 09:24:52 -0700290{
Florin Coras7e12d942018-06-27 14:32:43 -0700291#define _(type, name) type name;
292 foreach_app_session_field
293#undef _
Florin Coras7fb0fe12018-04-09 09:24:52 -0700294} app_session_t;
295
Florin Coras458089b2019-08-21 16:20:44 -0700296typedef struct session_listen_msg_
297{
298 u32 client_index;
299 u32 context; /* Not needed but keeping it for compatibility with bapi */
300 u32 wrk_index;
301 u32 vrf;
302 u16 port;
303 u8 proto;
304 u8 is_ip4;
305 ip46_address_t ip;
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200306 u32 ckpair_index;
Nathan Skrzypczak45ec9f42019-11-06 14:47:40 +0100307 u8 crypto_engine;
Florin Coras458089b2019-08-21 16:20:44 -0700308} __clib_packed session_listen_msg_t;
309
Florin Corase24a4bc2019-10-16 11:21:41 -0700310STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
311 "msg too large");
312
Florin Coras458089b2019-08-21 16:20:44 -0700313typedef struct session_listen_uri_msg_
314{
315 u32 client_index;
316 u32 context;
317 u8 uri[56];
318} __clib_packed session_listen_uri_msg_t;
319
Florin Corase24a4bc2019-10-16 11:21:41 -0700320STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
321 "msg too large");
322
Florin Coras60116992018-08-27 09:52:18 -0700323typedef struct session_bound_msg_
324{
325 u32 context;
326 u64 handle;
327 i32 retval;
328 u8 lcl_is_ip4;
329 u8 lcl_ip[16];
330 u16 lcl_port;
Florin Coras30e79c22019-01-02 19:31:22 -0800331 uword rx_fifo;
332 uword tx_fifo;
333 uword vpp_evt_q;
Florin Coras60116992018-08-27 09:52:18 -0700334 u32 segment_size;
335 u8 segment_name_length;
336 u8 segment_name[128];
337} __clib_packed session_bound_msg_t;
338
Florin Coras458089b2019-08-21 16:20:44 -0700339typedef struct session_unlisten_msg_
340{
341 u32 client_index;
342 u32 context;
343 u32 wrk_index;
344 session_handle_t handle;
345} __clib_packed session_unlisten_msg_t;
346
Florin Corasdfae9f92019-02-20 19:48:31 -0800347typedef struct session_unlisten_reply_msg_
348{
349 u32 context;
350 u64 handle;
351 i32 retval;
352} __clib_packed session_unlisten_reply_msg_t;
353
Florin Coras52207f12018-07-12 14:48:06 -0700354typedef struct session_accepted_msg_
355{
356 u32 context;
357 u64 listener_handle;
358 u64 handle;
Florin Coras30e79c22019-01-02 19:31:22 -0800359 uword server_rx_fifo;
360 uword server_tx_fifo;
Florin Corasfa76a762018-11-29 12:40:10 -0800361 u64 segment_handle;
Florin Coras30e79c22019-01-02 19:31:22 -0800362 uword vpp_event_queue_address;
Florin Coras09d18c22019-04-24 11:10:02 -0700363 transport_endpoint_t rmt;
Nathan Skrzypczakc00f4802019-12-03 16:25:11 +0100364 u8 flags;
Florin Coras54693d22018-07-17 10:46:29 -0700365} __clib_packed session_accepted_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700366
367typedef struct session_accepted_reply_msg_
368{
369 u32 context;
370 i32 retval;
371 u64 handle;
Florin Coras54693d22018-07-17 10:46:29 -0700372} __clib_packed session_accepted_reply_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700373
Florin Coras458089b2019-08-21 16:20:44 -0700374typedef struct session_connect_msg_
375{
376 u32 client_index;
377 u32 context;
378 u32 wrk_index;
379 u32 vrf;
380 u16 port;
381 u8 proto;
382 u8 is_ip4;
383 ip46_address_t ip;
Florin Corasef7cbf62019-10-17 09:56:27 -0700384 ip46_address_t lcl_ip;
Florin Coras458089b2019-08-21 16:20:44 -0700385 u8 hostname_len;
386 u8 hostname[16];
387 u64 parent_handle;
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200388 u32 ckpair_index;
Nathan Skrzypczak45ec9f42019-11-06 14:47:40 +0100389 u8 crypto_engine;
Nathan Skrzypczakc00f4802019-12-03 16:25:11 +0100390 u8 flags;
Florin Coras458089b2019-08-21 16:20:44 -0700391} __clib_packed session_connect_msg_t;
392
Florin Corase24a4bc2019-10-16 11:21:41 -0700393STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
394 "msg too large");
395
Florin Coras458089b2019-08-21 16:20:44 -0700396typedef struct session_connect_uri_msg_
397{
398 u32 client_index;
399 u32 context;
400 u8 uri[56];
401} __clib_packed session_connect_uri_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700402
Florin Corase24a4bc2019-10-16 11:21:41 -0700403STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
404 SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
405
Florin Coras52207f12018-07-12 14:48:06 -0700406typedef struct session_connected_msg_
407{
408 u32 context;
409 i32 retval;
410 u64 handle;
Florin Coras30e79c22019-01-02 19:31:22 -0800411 uword server_rx_fifo;
412 uword server_tx_fifo;
Florin Corasfa76a762018-11-29 12:40:10 -0800413 u64 segment_handle;
Florin Coras653e43f2019-03-04 10:56:23 -0800414 uword ct_rx_fifo;
415 uword ct_tx_fifo;
416 u64 ct_segment_handle;
Florin Coras30e79c22019-01-02 19:31:22 -0800417 uword vpp_event_queue_address;
Florin Coras52207f12018-07-12 14:48:06 -0700418 u32 segment_size;
419 u8 segment_name_length;
420 u8 segment_name[64];
Florin Coras09d18c22019-04-24 11:10:02 -0700421 transport_endpoint_t lcl;
Florin Coras54693d22018-07-17 10:46:29 -0700422} __clib_packed session_connected_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700423
Florin Coras458089b2019-08-21 16:20:44 -0700424typedef struct session_disconnect_msg_
425{
426 u32 client_index;
427 u32 context;
428 session_handle_t handle;
429} __clib_packed session_disconnect_msg_t;
430
Florin Coras52207f12018-07-12 14:48:06 -0700431typedef struct session_disconnected_msg_
432{
433 u32 client_index;
434 u32 context;
435 u64 handle;
Florin Coras54693d22018-07-17 10:46:29 -0700436} __clib_packed session_disconnected_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700437
438typedef struct session_disconnected_reply_msg_
439{
440 u32 context;
441 i32 retval;
442 u64 handle;
Florin Coras54693d22018-07-17 10:46:29 -0700443} __clib_packed session_disconnected_reply_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700444
445typedef struct session_reset_msg_
446{
447 u32 client_index;
448 u32 context;
449 u64 handle;
Florin Coras54693d22018-07-17 10:46:29 -0700450} __clib_packed session_reset_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700451
452typedef struct session_reset_reply_msg_
453{
Florin Coras52207f12018-07-12 14:48:06 -0700454 u32 context;
455 i32 retval;
456 u64 handle;
Florin Coras54693d22018-07-17 10:46:29 -0700457} __clib_packed session_reset_reply_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700458
Florin Coras30e79c22019-01-02 19:31:22 -0800459typedef struct session_req_worker_update_msg_
460{
461 u64 session_handle;
462} __clib_packed session_req_worker_update_msg_t;
463
464/* NOTE: using u16 for wrk indices because message needs to fit in 18B */
465typedef struct session_worker_update_msg_
466{
467 u32 client_index;
468 u16 wrk_index;
469 u16 req_wrk_index;
470 u64 handle;
471} __clib_packed session_worker_update_msg_t;
472
473typedef struct session_worker_update_reply_msg_
474{
475 u64 handle;
476 uword rx_fifo;
477 uword tx_fifo;
478 u64 segment_handle;
479} __clib_packed session_worker_update_reply_msg_t;
480
Florin Coras458089b2019-08-21 16:20:44 -0700481typedef struct session_app_detach_msg_
482{
483 u32 client_index;
484 u32 context;
485} session_app_detach_msg_t;
486
Florin Coras52207f12018-07-12 14:48:06 -0700487typedef struct app_session_event_
488{
489 svm_msg_q_msg_t msg;
490 session_event_t *evt;
Florin Coras54693d22018-07-17 10:46:29 -0700491} __clib_packed app_session_evt_t;
Florin Coras52207f12018-07-12 14:48:06 -0700492
493static inline void
494app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
495 u8 evt_type)
496{
497 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
498 SESSION_MQ_CTRL_EVT_RING,
499 SVM_Q_WAIT, &app_evt->msg);
Florin Coras52207f12018-07-12 14:48:06 -0700500 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
Dave Barachb7b92992018-10-17 10:38:51 -0400501 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
Florin Coras52207f12018-07-12 14:48:06 -0700502 app_evt->evt->event_type = evt_type;
503}
504
505static inline void
506app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
507{
Florin Coras0dfbce62019-07-15 07:48:27 -0700508 svm_msg_q_add_and_unlock (mq, &app_evt->msg);
Florin Coras52207f12018-07-12 14:48:06 -0700509}
510
Florin Coras3c2fed52018-07-04 04:15:05 -0700511/**
512 * Send fifo io event to vpp worker thread
513 *
514 * Because there may be multiple writers to one of vpp's queues, this
515 * protects message allocation and enqueueing.
516 *
517 * @param mq vpp message queue
518 * @param f fifo for which the event is sent
519 * @param evt_type type of event
520 * @param noblock flag to indicate is request is blocking or not
521 * @return 0 if success, negative integer otherwise
522 */
523static inline int
Florin Corasc0737e92019-03-04 14:19:39 -0800524app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
Florin Coras3c2fed52018-07-04 04:15:05 -0700525 u8 noblock)
526{
Florin Coras52207f12018-07-12 14:48:06 -0700527 session_event_t *evt;
Florin Coras3c2fed52018-07-04 04:15:05 -0700528 svm_msg_q_msg_t msg;
529
530 if (noblock)
531 {
532 if (svm_msg_q_try_lock (mq))
533 return -1;
534 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
535 {
536 svm_msg_q_unlock (mq);
537 return -2;
538 }
539 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
Florin Coras52207f12018-07-12 14:48:06 -0700540 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
Florin Corasc0737e92019-03-04 14:19:39 -0800541 evt->session_index = session_index;
Florin Coras3c2fed52018-07-04 04:15:05 -0700542 evt->event_type = evt_type;
Florin Coras52207f12018-07-12 14:48:06 -0700543 svm_msg_q_add_and_unlock (mq, &msg);
Florin Coras3c2fed52018-07-04 04:15:05 -0700544 return 0;
545 }
546 else
547 {
548 svm_msg_q_lock (mq);
Nathan Skrzypczak35174b42019-09-27 17:04:47 +0200549 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
550 || svm_msg_q_is_full (mq))
Florin Coras54693d22018-07-17 10:46:29 -0700551 svm_msg_q_wait (mq);
Florin Coras3c2fed52018-07-04 04:15:05 -0700552 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
Florin Coras52207f12018-07-12 14:48:06 -0700553 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
Florin Corasc0737e92019-03-04 14:19:39 -0800554 evt->session_index = session_index;
Florin Coras3c2fed52018-07-04 04:15:05 -0700555 evt->event_type = evt_type;
Florin Coras52207f12018-07-12 14:48:06 -0700556 svm_msg_q_add_and_unlock (mq, &msg);
Florin Coras3c2fed52018-07-04 04:15:05 -0700557 return 0;
558 }
559}
560
Florin Coras7fb0fe12018-04-09 09:24:52 -0700561always_inline int
562app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
Florin Coras460dce62018-07-27 05:45:06 -0700563 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
Florin Coras653e43f2019-03-04 10:56:23 -0800564 u8 do_evt, u8 noblock)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700565{
566 u32 max_enqueue, actual_write;
567 session_dgram_hdr_t hdr;
Florin Coras7fb0fe12018-04-09 09:24:52 -0700568 int rv;
569
Sirshak Das28aa5392019-02-05 01:33:33 -0600570 max_enqueue = svm_fifo_max_enqueue_prod (f);
Florin Coras8e43d042018-05-04 15:46:57 -0700571 if (max_enqueue <= sizeof (session_dgram_hdr_t))
Florin Coras7fb0fe12018-04-09 09:24:52 -0700572 return 0;
573
574 max_enqueue -= sizeof (session_dgram_hdr_t);
575 actual_write = clib_min (len, max_enqueue);
576 hdr.data_length = actual_write;
577 hdr.data_offset = 0;
Dave Barach178cf492018-11-13 16:34:13 -0500578 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
Florin Coras7fb0fe12018-04-09 09:24:52 -0700579 hdr.is_ip4 = at->is_ip4;
580 hdr.rmt_port = at->rmt_port;
Dave Barach178cf492018-11-13 16:34:13 -0500581 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
Florin Coras7fb0fe12018-04-09 09:24:52 -0700582 hdr.lcl_port = at->lcl_port;
Florin Coras87b15ce2019-04-28 21:16:30 -0700583 rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700584 ASSERT (rv == sizeof (hdr));
585
Florin Coras87b15ce2019-04-28 21:16:30 -0700586 rv = svm_fifo_enqueue (f, actual_write, data);
Florin Coras4b761122019-03-21 13:54:53 -0700587 if (do_evt)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700588 {
Florin Coras4b761122019-03-21 13:54:53 -0700589 if (rv > 0 && svm_fifo_set_event (f))
Florin Corasc0737e92019-03-04 14:19:39 -0800590 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
591 noblock);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700592 }
Florin Coras8e43d042018-05-04 15:46:57 -0700593 ASSERT (rv);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700594 return rv;
595}
596
597always_inline int
598app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
599{
600 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
Florin Coras653e43f2019-03-04 10:56:23 -0800601 len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
602 noblock);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700603}
604
605always_inline int
Florin Coras3c2fed52018-07-04 04:15:05 -0700606app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
Florin Coras653e43f2019-03-04 10:56:23 -0800607 u32 len, u8 evt_type, u8 do_evt, u8 noblock)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700608{
Florin Coras7fb0fe12018-04-09 09:24:52 -0700609 int rv;
610
Florin Coras87b15ce2019-04-28 21:16:30 -0700611 rv = svm_fifo_enqueue (f, len, data);
Florin Coras4b761122019-03-21 13:54:53 -0700612 if (do_evt)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700613 {
Florin Coras4b761122019-03-21 13:54:53 -0700614 if (rv > 0 && svm_fifo_set_event (f))
Florin Corasc0737e92019-03-04 14:19:39 -0800615 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
616 noblock);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700617 }
618 return rv;
619}
620
621always_inline int
622app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
623{
Florin Coras460dce62018-07-27 05:45:06 -0700624 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
Florin Coras653e43f2019-03-04 10:56:23 -0800625 SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700626}
627
628always_inline int
629app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
630{
631 if (s->is_dgram)
632 return app_send_dgram (s, data, len, noblock);
633 return app_send_stream (s, data, len, noblock);
634}
635
636always_inline int
637app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
Florin Coras460dce62018-07-27 05:45:06 -0700638 app_session_transport_t * at, u8 clear_evt, u8 peek)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700639{
640 session_dgram_pre_hdr_t ph;
641 u32 max_deq;
642 int rv;
643
Sirshak Das28aa5392019-02-05 01:33:33 -0600644 max_deq = svm_fifo_max_dequeue_cons (f);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700645 if (max_deq < sizeof (session_dgram_hdr_t))
Florin Coras460dce62018-07-27 05:45:06 -0700646 {
647 if (clear_evt)
648 svm_fifo_unset_event (f);
649 return 0;
650 }
651
652 if (clear_evt)
653 svm_fifo_unset_event (f);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700654
655 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
656 ASSERT (ph.data_length >= ph.data_offset);
657 if (!ph.data_offset)
658 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
659 len = clib_min (len, ph.data_length - ph.data_offset);
660 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
Florin Coras460dce62018-07-27 05:45:06 -0700661 if (peek)
662 return rv;
Florin Coras7fb0fe12018-04-09 09:24:52 -0700663 ph.data_offset += rv;
664 if (ph.data_offset == ph.data_length)
665 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
666 else
667 svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
668 return rv;
669}
670
671always_inline int
672app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
673{
Florin Coras460dce62018-07-27 05:45:06 -0700674 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700675}
676
677always_inline int
Florin Coras460dce62018-07-27 05:45:06 -0700678app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700679{
680 if (clear_evt)
681 svm_fifo_unset_event (f);
Florin Coras460dce62018-07-27 05:45:06 -0700682
683 if (peek)
684 return svm_fifo_peek (f, 0, len, buf);
685
Florin Coras87b15ce2019-04-28 21:16:30 -0700686 return svm_fifo_dequeue (f, len, buf);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700687}
688
689always_inline int
690app_recv_stream (app_session_t * s, u8 * buf, u32 len)
691{
Florin Coras460dce62018-07-27 05:45:06 -0700692 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700693}
694
695always_inline int
696app_recv (app_session_t * s, u8 * data, u32 len)
697{
698 if (s->is_dgram)
699 return app_recv_dgram (s, data, len);
700 return app_recv_stream (s, data, len);
701}
702
Dave Barach68b0fb02017-02-28 15:15:56 -0500703#endif /* __included_uri_h__ */
704
705/*
706 * fd.io coding-style-patch-verification: ON
707 *
708 * Local Variables:
709 * eval: (c-set-style "gnu")
710 * End:
711 */