blob: cddc031ec0db134bc5d47f26c6712a8ace6fd16d [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 Corasc4c4cf52019-08-24 18:17:34 -070032typedef struct session_cb_vft_
Florin Corasc1a42652019-02-08 18:27:29 -080033{
34 /** Notify server of new segment */
Florin Corasc4c4cf52019-08-24 18:17:34 -070035 int (*add_segment_callback) (u32 app_wrk_index, u64 segment_handle);
Florin Corasc1a42652019-02-08 18:27:29 -080036
37 /** Notify server of new segment */
Florin Corasc4c4cf52019-08-24 18:17:34 -070038 int (*del_segment_callback) (u32 app_wrk_index, u64 segment_handle);
Florin Corasc1a42652019-02-08 18:27:29 -080039
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,
Florin Coras00e01d32019-10-21 16:07:46 -070045 session_t * s, session_error_t code);
Florin Corasc1a42652019-02-08 18:27:29 -080046
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
Ryujiro Shibuyad8f48e22020-01-22 12:11:42 +000071 /** Delegate fifo-tuning-logic to application */
72 int (*fifo_tuning_callback) (session_t * s, svm_fifo_t * f,
73 session_ft_action_t act, u32 bytes);
74
Florin Corasc1a42652019-02-08 18:27:29 -080075} session_cb_vft_t;
76
77#define foreach_app_init_args \
78 _(u32, api_client_index) \
79 _(u8 *, name) \
80 _(u64 *, options) \
81 _(u8 *, namespace_id) \
82 _(session_cb_vft_t *, session_cb_vft) \
83 _(u32, app_index) \
84
Florin Coras6cf30ad2017-04-04 23:08:23 -070085typedef struct _vnet_app_attach_args_t
86{
Florin Coras15531972018-08-12 23:50:53 -070087#define _(_type, _name) _type _name;
88 foreach_app_init_args
89#undef _
90 ssvm_private_t * segment;
Florin Coras99368312018-08-02 10:45:44 -070091 svm_msg_q_t *app_evt_q;
Florin Corasd85de682018-11-29 17:02:29 -080092 u64 segment_handle;
Florin Coras6cf30ad2017-04-04 23:08:23 -070093} vnet_app_attach_args_t;
94
95typedef struct _vnet_app_detach_args_t
96{
97 u32 app_index;
Florin Coras053a0e42018-11-13 15:52:38 -080098 u32 api_client_index;
Florin Coras6cf30ad2017-04-04 23:08:23 -070099} vnet_app_detach_args_t;
100
Dave Barach68b0fb02017-02-28 15:15:56 -0500101typedef struct _vnet_bind_args_t
102{
103 union
104 {
Florin Coras5665ced2018-10-25 18:03:45 -0700105 session_endpoint_cfg_t sep_ext;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700106 session_endpoint_t sep;
Florin Coras15531972018-08-12 23:50:53 -0700107 char *uri;
Dave Barach68b0fb02017-02-28 15:15:56 -0500108 };
109
Florin Coras6cf30ad2017-04-04 23:08:23 -0700110 u32 app_index;
Florin Coras15531972018-08-12 23:50:53 -0700111 u32 wrk_map_index;
Dave Barach68b0fb02017-02-28 15:15:56 -0500112
113 /*
114 * Results
115 */
116 char *segment_name;
117 u32 segment_name_length;
118 u64 server_event_queue_address;
119 u64 handle;
Florin Corasc9940fc2019-02-05 20:55:11 -0800120} vnet_listen_args_t;
Dave Barach68b0fb02017-02-28 15:15:56 -0500121
Florin Corasdfae9f92019-02-20 19:48:31 -0800122typedef struct _vnet_unlisten_args_t
Dave Barach68b0fb02017-02-28 15:15:56 -0500123{
124 union
125 {
126 char *uri;
Florin Coras15531972018-08-12 23:50:53 -0700127 u64 handle; /**< Session handle */
Dave Barach68b0fb02017-02-28 15:15:56 -0500128 };
Florin Coras15531972018-08-12 23:50:53 -0700129 u32 app_index; /**< Owning application index */
Florin Corasab2f6db2018-08-31 14:31:41 -0700130 u32 wrk_map_index; /**< App's local pool worker index */
Florin Corasc1a42652019-02-08 18:27:29 -0800131} vnet_unlisten_args_t;
Dave Barach68b0fb02017-02-28 15:15:56 -0500132
133typedef struct _vnet_connect_args
134{
Florin Coras371ca502018-02-21 12:07:41 -0800135 union
136 {
Florin Coras5665ced2018-10-25 18:03:45 -0700137 session_endpoint_cfg_t sep_ext;
Florin Coras15531972018-08-12 23:50:53 -0700138 session_endpoint_t sep;
Florin Coras371ca502018-02-21 12:07:41 -0800139 char *uri;
Florin Coras371ca502018-02-21 12:07:41 -0800140 };
Florin Coras6cf30ad2017-04-04 23:08:23 -0700141 u32 app_index;
Florin Coras15531972018-08-12 23:50:53 -0700142 u32 wrk_map_index;
Dave Barach68b0fb02017-02-28 15:15:56 -0500143 u32 api_context;
Dave Barach68b0fb02017-02-28 15:15:56 -0500144
Florin Corasf8f516a2018-02-08 15:10:09 -0800145 session_handle_t session_handle;
Dave Barach68b0fb02017-02-28 15:15:56 -0500146} vnet_connect_args_t;
147
148typedef struct _vnet_disconnect_args_t
149{
Florin Corasf8f516a2018-02-08 15:10:09 -0800150 session_handle_t handle;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700151 u32 app_index;
Dave Barach68b0fb02017-02-28 15:15:56 -0500152} vnet_disconnect_args_t;
153
Florin Coras371ca502018-02-21 12:07:41 -0800154typedef struct _vnet_application_add_tls_cert_args_t
155{
156 u32 app_index;
157 u8 *cert;
158} vnet_app_add_tls_cert_args_t;
159
160typedef struct _vnet_application_add_tls_key_args_t
161{
162 u32 app_index;
163 u8 *key;
164} vnet_app_add_tls_key_args_t;
165
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200166typedef enum crypto_engine_type_
Florin Coras54a51fd2019-02-07 15:34:52 -0800167{
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200168 CRYPTO_ENGINE_NONE,
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200169 CRYPTO_ENGINE_OPENSSL,
Yu Ping98bd3582019-10-21 23:23:44 +0800170 CRYPTO_ENGINE_MBEDTLS,
Nathan Skrzypczak8095b602019-09-12 16:02:13 +0200171 CRYPTO_ENGINE_VPP,
172 CRYPTO_ENGINE_PICOTLS,
Florin Coras79ba25d2019-10-20 19:32:47 -0700173 CRYPTO_ENGINE_LAST = CRYPTO_ENGINE_PICOTLS,
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200174} crypto_engine_type_t;
Florin Coras54a51fd2019-02-07 15:34:52 -0800175
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200176typedef struct _vnet_app_add_cert_key_pair_args_
177{
178 u8 *cert;
179 u8 *key;
180 u32 index;
181} vnet_app_add_cert_key_pair_args_t;
182
Nathan Skrzypczakde6caf42019-10-09 14:41:48 +0200183typedef struct crypto_ctx_
184{
185 u32 ctx_index; /**< index in crypto context pool */
186 u32 n_subscribers; /**< refcount of sessions using said context */
187 u32 ckpair_index; /**< certificate & key */
188 u8 crypto_engine;
Nathan Skrzypczakd1b9e702019-11-07 13:52:09 +0100189 void *data; /**< protocol specific data */
Nathan Skrzypczakde6caf42019-10-09 14:41:48 +0200190} crypto_context_t;
191
Florin Coras6cf30ad2017-04-04 23:08:23 -0700192/* Application attach options */
Dave Barach68b0fb02017-02-28 15:15:56 -0500193typedef enum
194{
Florin Corasa5464812017-04-19 13:00:05 -0700195 APP_OPTIONS_FLAGS,
Florin Corasff6e7692017-12-11 04:59:01 -0800196 APP_OPTIONS_EVT_QUEUE_SIZE,
197 APP_OPTIONS_SEGMENT_SIZE,
198 APP_OPTIONS_ADD_SEGMENT_SIZE,
Dave Barach2c25a622017-06-26 11:35:07 -0400199 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
Florin Corasff6e7692017-12-11 04:59:01 -0800200 APP_OPTIONS_RX_FIFO_SIZE,
201 APP_OPTIONS_TX_FIFO_SIZE,
202 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
Florin Coras9845c202020-04-28 01:54:22 +0000203 APP_OPTIONS_PREALLOC_FIFO_HDRS,
Florin Corascea194d2017-10-02 00:18:51 -0700204 APP_OPTIONS_NAMESPACE,
205 APP_OPTIONS_NAMESPACE_SECRET,
Florin Coras7999e832017-10-31 01:51:04 -0700206 APP_OPTIONS_PROXY_TRANSPORT,
Florin Corasff6e7692017-12-11 04:59:01 -0800207 APP_OPTIONS_ACCEPT_COOKIE,
Florin Coras58d36f02018-03-09 13:05:53 -0800208 APP_OPTIONS_TLS_ENGINE,
Ryujiro Shibuyad8f48e22020-01-22 12:11:42 +0000209 APP_OPTIONS_MAX_FIFO_SIZE,
Ryujiro Shibuya234fe892019-12-25 07:40:54 +0000210 APP_OPTIONS_HIGH_WATERMARK,
211 APP_OPTIONS_LOW_WATERMARK,
Florin Coras2de9c0f2020-02-02 19:30:39 +0000212 APP_OPTIONS_PCT_FIRST_ALLOC,
Florin Corasff6e7692017-12-11 04:59:01 -0800213 APP_OPTIONS_N_OPTIONS
Florin Coras6cf30ad2017-04-04 23:08:23 -0700214} app_attach_options_index_t;
Dave Barach68b0fb02017-02-28 15:15:56 -0500215
Florin Corasa5464812017-04-19 13:00:05 -0700216#define foreach_app_options_flags \
Florin Corascea194d2017-10-02 00:18:51 -0700217 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
Florin Corasa5464812017-04-19 13:00:05 -0700218 _(ADD_SEGMENT, "Add segment and signal app if needed") \
Florin Coras7999e832017-10-31 01:51:04 -0700219 _(IS_BUILTIN, "Application is builtin") \
Florin Corasda3eec12018-09-07 13:29:17 -0700220 _(IS_TRANSPORT_APP, "Application is a transport proto") \
Florin Coras7e12d942018-06-27 14:32:43 -0700221 _(IS_PROXY, "Application is proxying") \
Florin Corascea194d2017-10-02 00:18:51 -0700222 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
Florin Coras3c2fed52018-07-04 04:15:05 -0700223 _(USE_LOCAL_SCOPE, "App can use local session scope") \
Florin Coras99368312018-08-02 10:45:44 -0700224 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
Dave Barach68b0fb02017-02-28 15:15:56 -0500225
Florin Corasa5464812017-04-19 13:00:05 -0700226typedef enum _app_options
227{
228#define _(sym, str) APP_OPTIONS_##sym,
229 foreach_app_options_flags
230#undef _
231} app_options_t;
232
233typedef enum _app_options_flags
234{
235#define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
236 foreach_app_options_flags
237#undef _
238} app_options_flags_t;
239
Florin Coras99368312018-08-02 10:45:44 -0700240#define foreach_fd_type \
241 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
242 _(MEMFD_SEGMENT, "Fd for memfd segment") \
243 _(MQ_EVENTFD, "Event fd used by message queue") \
244 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
245
246typedef enum session_fd_type_
247{
248#define _(sym, str) SESSION_FD_##sym,
249 foreach_fd_type
250#undef _
251 SESSION_N_FD_TYPE
252} session_fd_type_t;
253
254typedef enum session_fd_flag_
255{
256#define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
257 foreach_fd_type
258#undef _
259} session_fd_flag_t;
260
Aloys Augustin502785b2019-04-09 11:40:57 +0200261int parse_uri (char *uri, session_endpoint_cfg_t * sep);
Florin Corasc9940fc2019-02-05 20:55:11 -0800262int vnet_bind_uri (vnet_listen_args_t *);
Florin Corasc1a42652019-02-08 18:27:29 -0800263int vnet_unbind_uri (vnet_unlisten_args_t * a);
264int vnet_connect_uri (vnet_connect_args_t * a);
Dave Barach68b0fb02017-02-28 15:15:56 -0500265
Florin Corasc1a42652019-02-08 18:27:29 -0800266int vnet_application_attach (vnet_app_attach_args_t * a);
Florin Coras371ca502018-02-21 12:07:41 -0800267int vnet_application_detach (vnet_app_detach_args_t * a);
Florin Corasc1a42652019-02-08 18:27:29 -0800268int vnet_listen (vnet_listen_args_t * a);
269int vnet_connect (vnet_connect_args_t * a);
270int vnet_unlisten (vnet_unlisten_args_t * a);
Florin Coras371ca502018-02-21 12:07:41 -0800271int vnet_disconnect_session (vnet_disconnect_args_t * a);
Dave Barach68b0fb02017-02-28 15:15:56 -0500272
Florin Coras371ca502018-02-21 12:07:41 -0800273clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
274clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200275int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
276int vnet_app_del_cert_key_pair (u32 index);
Nathan Skrzypczak7fbdb6a2019-10-09 16:23:26 +0200277/** Ask for app cb on pair deletion */
278int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500279
Florin Coras7fb0fe12018-04-09 09:24:52 -0700280typedef struct app_session_transport_
281{
282 ip46_address_t rmt_ip; /**< remote ip */
283 ip46_address_t lcl_ip; /**< local ip */
Florin Coras7e12d942018-06-27 14:32:43 -0700284 u16 rmt_port; /**< remote port (network order) */
285 u16 lcl_port; /**< local port (network order) */
Florin Coras7fb0fe12018-04-09 09:24:52 -0700286 u8 is_ip4; /**< set if uses ip4 networking */
287} app_session_transport_t;
288
Florin Coras7e12d942018-06-27 14:32:43 -0700289#define foreach_app_session_field \
290 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
291 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
292 _(session_type_t, session_type) /**< session type */ \
293 _(volatile u8, session_state) /**< session state */ \
294 _(u32, session_index) /**< index in owning pool */ \
295 _(app_session_transport_t, transport) /**< transport info */ \
Florin Coras3c2fed52018-07-04 04:15:05 -0700296 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
Florin Coras7e12d942018-06-27 14:32:43 -0700297 _(u8, is_dgram) /**< flag for dgram mode */ \
298
299typedef struct
Florin Coras7fb0fe12018-04-09 09:24:52 -0700300{
Florin Coras7e12d942018-06-27 14:32:43 -0700301#define _(type, name) type name;
302 foreach_app_session_field
303#undef _
Florin Coras7fb0fe12018-04-09 09:24:52 -0700304} app_session_t;
305
Florin Coras458089b2019-08-21 16:20:44 -0700306typedef struct session_listen_msg_
307{
308 u32 client_index;
309 u32 context; /* Not needed but keeping it for compatibility with bapi */
310 u32 wrk_index;
311 u32 vrf;
312 u16 port;
313 u8 proto;
314 u8 is_ip4;
315 ip46_address_t ip;
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200316 u32 ckpair_index;
Nathan Skrzypczak45ec9f42019-11-06 14:47:40 +0100317 u8 crypto_engine;
Florin Coras1e966172020-05-16 18:18:14 +0000318 u8 flags;
Florin Coras458089b2019-08-21 16:20:44 -0700319} __clib_packed session_listen_msg_t;
320
Florin Corase24a4bc2019-10-16 11:21:41 -0700321STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
322 "msg too large");
323
Florin Coras458089b2019-08-21 16:20:44 -0700324typedef struct session_listen_uri_msg_
325{
326 u32 client_index;
327 u32 context;
328 u8 uri[56];
329} __clib_packed session_listen_uri_msg_t;
330
Florin Corase24a4bc2019-10-16 11:21:41 -0700331STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
332 "msg too large");
333
Florin Coras60116992018-08-27 09:52:18 -0700334typedef struct session_bound_msg_
335{
336 u32 context;
337 u64 handle;
338 i32 retval;
339 u8 lcl_is_ip4;
340 u8 lcl_ip[16];
341 u16 lcl_port;
Florin Coras30e79c22019-01-02 19:31:22 -0800342 uword rx_fifo;
343 uword tx_fifo;
344 uword vpp_evt_q;
Florin Coras60116992018-08-27 09:52:18 -0700345 u32 segment_size;
346 u8 segment_name_length;
347 u8 segment_name[128];
348} __clib_packed session_bound_msg_t;
349
Florin Coras458089b2019-08-21 16:20:44 -0700350typedef struct session_unlisten_msg_
351{
352 u32 client_index;
353 u32 context;
354 u32 wrk_index;
355 session_handle_t handle;
356} __clib_packed session_unlisten_msg_t;
357
Florin Corasdfae9f92019-02-20 19:48:31 -0800358typedef struct session_unlisten_reply_msg_
359{
360 u32 context;
361 u64 handle;
362 i32 retval;
363} __clib_packed session_unlisten_reply_msg_t;
364
Florin Coras52207f12018-07-12 14:48:06 -0700365typedef struct session_accepted_msg_
366{
367 u32 context;
368 u64 listener_handle;
369 u64 handle;
Florin Coras30e79c22019-01-02 19:31:22 -0800370 uword server_rx_fifo;
371 uword server_tx_fifo;
Florin Corasfa76a762018-11-29 12:40:10 -0800372 u64 segment_handle;
Florin Coras30e79c22019-01-02 19:31:22 -0800373 uword vpp_event_queue_address;
Florin Coras09d18c22019-04-24 11:10:02 -0700374 transport_endpoint_t rmt;
Nathan Skrzypczakc00f4802019-12-03 16:25:11 +0100375 u8 flags;
Florin Coras54693d22018-07-17 10:46:29 -0700376} __clib_packed session_accepted_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700377
378typedef struct session_accepted_reply_msg_
379{
380 u32 context;
381 i32 retval;
382 u64 handle;
Florin Coras54693d22018-07-17 10:46:29 -0700383} __clib_packed session_accepted_reply_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700384
Florin Coras458089b2019-08-21 16:20:44 -0700385typedef struct session_connect_msg_
386{
387 u32 client_index;
388 u32 context;
389 u32 wrk_index;
390 u32 vrf;
391 u16 port;
Florin Coras0a1e1832020-03-29 18:54:04 +0000392 u16 lcl_port;
Florin Coras458089b2019-08-21 16:20:44 -0700393 u8 proto;
394 u8 is_ip4;
395 ip46_address_t ip;
Florin Corasef7cbf62019-10-17 09:56:27 -0700396 ip46_address_t lcl_ip;
Florin Coras458089b2019-08-21 16:20:44 -0700397 u8 hostname_len;
398 u8 hostname[16];
399 u64 parent_handle;
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200400 u32 ckpair_index;
Nathan Skrzypczak45ec9f42019-11-06 14:47:40 +0100401 u8 crypto_engine;
Nathan Skrzypczakc00f4802019-12-03 16:25:11 +0100402 u8 flags;
Florin Coras458089b2019-08-21 16:20:44 -0700403} __clib_packed session_connect_msg_t;
404
Florin Corase24a4bc2019-10-16 11:21:41 -0700405STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
406 "msg too large");
407
Florin Coras458089b2019-08-21 16:20:44 -0700408typedef struct session_connect_uri_msg_
409{
410 u32 client_index;
411 u32 context;
412 u8 uri[56];
413} __clib_packed session_connect_uri_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700414
Florin Corase24a4bc2019-10-16 11:21:41 -0700415STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
416 SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
417
Florin Coras52207f12018-07-12 14:48:06 -0700418typedef struct session_connected_msg_
419{
420 u32 context;
421 i32 retval;
422 u64 handle;
Florin Coras30e79c22019-01-02 19:31:22 -0800423 uword server_rx_fifo;
424 uword server_tx_fifo;
Florin Corasfa76a762018-11-29 12:40:10 -0800425 u64 segment_handle;
Florin Coras653e43f2019-03-04 10:56:23 -0800426 uword ct_rx_fifo;
427 uword ct_tx_fifo;
428 u64 ct_segment_handle;
Florin Coras30e79c22019-01-02 19:31:22 -0800429 uword vpp_event_queue_address;
Florin Coras52207f12018-07-12 14:48:06 -0700430 u32 segment_size;
431 u8 segment_name_length;
432 u8 segment_name[64];
Florin Coras09d18c22019-04-24 11:10:02 -0700433 transport_endpoint_t lcl;
Florin Coras54693d22018-07-17 10:46:29 -0700434} __clib_packed session_connected_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700435
Florin Coras458089b2019-08-21 16:20:44 -0700436typedef struct session_disconnect_msg_
437{
438 u32 client_index;
439 u32 context;
440 session_handle_t handle;
441} __clib_packed session_disconnect_msg_t;
442
Florin Coras52207f12018-07-12 14:48:06 -0700443typedef struct session_disconnected_msg_
444{
445 u32 client_index;
446 u32 context;
447 u64 handle;
Florin Coras54693d22018-07-17 10:46:29 -0700448} __clib_packed session_disconnected_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700449
450typedef struct session_disconnected_reply_msg_
451{
452 u32 context;
453 i32 retval;
454 u64 handle;
Florin Coras54693d22018-07-17 10:46:29 -0700455} __clib_packed session_disconnected_reply_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700456
457typedef struct session_reset_msg_
458{
459 u32 client_index;
460 u32 context;
461 u64 handle;
Florin Coras54693d22018-07-17 10:46:29 -0700462} __clib_packed session_reset_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700463
464typedef struct session_reset_reply_msg_
465{
Florin Coras52207f12018-07-12 14:48:06 -0700466 u32 context;
467 i32 retval;
468 u64 handle;
Florin Coras54693d22018-07-17 10:46:29 -0700469} __clib_packed session_reset_reply_msg_t;
Florin Coras52207f12018-07-12 14:48:06 -0700470
Florin Coras30e79c22019-01-02 19:31:22 -0800471typedef struct session_req_worker_update_msg_
472{
473 u64 session_handle;
474} __clib_packed session_req_worker_update_msg_t;
475
476/* NOTE: using u16 for wrk indices because message needs to fit in 18B */
477typedef struct session_worker_update_msg_
478{
479 u32 client_index;
480 u16 wrk_index;
481 u16 req_wrk_index;
482 u64 handle;
483} __clib_packed session_worker_update_msg_t;
484
485typedef struct session_worker_update_reply_msg_
486{
487 u64 handle;
488 uword rx_fifo;
489 uword tx_fifo;
490 u64 segment_handle;
491} __clib_packed session_worker_update_reply_msg_t;
492
Florin Coras458089b2019-08-21 16:20:44 -0700493typedef struct session_app_detach_msg_
494{
495 u32 client_index;
496 u32 context;
497} session_app_detach_msg_t;
498
Florin Corasc4c4cf52019-08-24 18:17:34 -0700499typedef struct app_map_another_segment_msg_
500{
501 u32 client_index;
502 u32 context;
503 u8 fd_flags;
504 u32 segment_size;
505 u8 segment_name[128];
506 u64 segment_handle;
507} session_app_add_segment_msg_t;
508
509typedef struct app_unmap_segment_msg_
510{
511 u32 client_index;
512 u32 context;
513 u64 segment_handle;
514} session_app_del_segment_msg_t;
515
Florin Coras68b7e582020-01-21 18:33:23 -0800516typedef struct session_migrate_msg_
517{
518 uword vpp_evt_q;
519 session_handle_t handle;
520 session_handle_t new_handle;
521 u32 vpp_thread_index;
522} __clib_packed session_migrated_msg_t;
523
Florin Coras9ace36d2019-10-28 13:14:17 -0700524typedef struct session_cleanup_msg_
525{
526 session_handle_t handle;
Florin Coras36d49392020-04-24 23:00:11 +0000527 u8 type;
Florin Coras9ace36d2019-10-28 13:14:17 -0700528} __clib_packed session_cleanup_msg_t;
529
Florin Coras40c07ce2020-07-16 20:46:17 -0700530typedef struct session_app_wrk_rpc_msg_
531{
532 u32 client_index; /**< app client index */
533 u32 wrk_index; /**< dst worker index */
hanlina3a48962020-07-13 11:09:15 +0800534 u8 data[64]; /**< rpc data */
Florin Coras40c07ce2020-07-16 20:46:17 -0700535} __clib_packed session_app_wrk_rpc_msg_t;
536
Florin Coras52207f12018-07-12 14:48:06 -0700537typedef struct app_session_event_
538{
539 svm_msg_q_msg_t msg;
540 session_event_t *evt;
Florin Coras54693d22018-07-17 10:46:29 -0700541} __clib_packed app_session_evt_t;
Florin Coras52207f12018-07-12 14:48:06 -0700542
543static inline void
544app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
545 u8 evt_type)
546{
547 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
548 SESSION_MQ_CTRL_EVT_RING,
549 SVM_Q_WAIT, &app_evt->msg);
Florin Coras52207f12018-07-12 14:48:06 -0700550 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
Dave Barachb7b92992018-10-17 10:38:51 -0400551 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
Florin Coras52207f12018-07-12 14:48:06 -0700552 app_evt->evt->event_type = evt_type;
553}
554
555static inline void
556app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
557{
Florin Coras0dfbce62019-07-15 07:48:27 -0700558 svm_msg_q_add_and_unlock (mq, &app_evt->msg);
Florin Coras52207f12018-07-12 14:48:06 -0700559}
560
Florin Coras3c2fed52018-07-04 04:15:05 -0700561/**
562 * Send fifo io event to vpp worker thread
563 *
564 * Because there may be multiple writers to one of vpp's queues, this
565 * protects message allocation and enqueueing.
566 *
567 * @param mq vpp message queue
568 * @param f fifo for which the event is sent
569 * @param evt_type type of event
570 * @param noblock flag to indicate is request is blocking or not
571 * @return 0 if success, negative integer otherwise
572 */
573static inline int
Florin Corasc0737e92019-03-04 14:19:39 -0800574app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
Florin Coras3c2fed52018-07-04 04:15:05 -0700575 u8 noblock)
576{
Florin Coras52207f12018-07-12 14:48:06 -0700577 session_event_t *evt;
Florin Coras3c2fed52018-07-04 04:15:05 -0700578 svm_msg_q_msg_t msg;
579
580 if (noblock)
581 {
582 if (svm_msg_q_try_lock (mq))
583 return -1;
584 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
585 {
586 svm_msg_q_unlock (mq);
587 return -2;
588 }
589 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
Florin Coras52207f12018-07-12 14:48:06 -0700590 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
Florin Corasc0737e92019-03-04 14:19:39 -0800591 evt->session_index = session_index;
Florin Coras3c2fed52018-07-04 04:15:05 -0700592 evt->event_type = evt_type;
Florin Coras52207f12018-07-12 14:48:06 -0700593 svm_msg_q_add_and_unlock (mq, &msg);
Florin Coras3c2fed52018-07-04 04:15:05 -0700594 return 0;
595 }
596 else
597 {
598 svm_msg_q_lock (mq);
Nathan Skrzypczak35174b42019-09-27 17:04:47 +0200599 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
600 || svm_msg_q_is_full (mq))
Florin Coras54693d22018-07-17 10:46:29 -0700601 svm_msg_q_wait (mq);
Florin Coras3c2fed52018-07-04 04:15:05 -0700602 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
Florin Coras52207f12018-07-12 14:48:06 -0700603 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
Florin Corasc0737e92019-03-04 14:19:39 -0800604 evt->session_index = session_index;
Florin Coras3c2fed52018-07-04 04:15:05 -0700605 evt->event_type = evt_type;
Florin Coras52207f12018-07-12 14:48:06 -0700606 svm_msg_q_add_and_unlock (mq, &msg);
Florin Coras3c2fed52018-07-04 04:15:05 -0700607 return 0;
608 }
609}
610
Florin Coras7fb0fe12018-04-09 09:24:52 -0700611always_inline int
612app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
Florin Coras460dce62018-07-27 05:45:06 -0700613 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
Florin Coras653e43f2019-03-04 10:56:23 -0800614 u8 do_evt, u8 noblock)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700615{
616 u32 max_enqueue, actual_write;
617 session_dgram_hdr_t hdr;
Florin Coras7fb0fe12018-04-09 09:24:52 -0700618 int rv;
619
Sirshak Das28aa5392019-02-05 01:33:33 -0600620 max_enqueue = svm_fifo_max_enqueue_prod (f);
Florin Coras7a2abce2020-04-05 19:25:44 +0000621 if (max_enqueue < (sizeof (session_dgram_hdr_t) + len))
Florin Coras7fb0fe12018-04-09 09:24:52 -0700622 return 0;
623
624 max_enqueue -= sizeof (session_dgram_hdr_t);
625 actual_write = clib_min (len, max_enqueue);
626 hdr.data_length = actual_write;
627 hdr.data_offset = 0;
Dave Barach178cf492018-11-13 16:34:13 -0500628 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
Florin Coras7fb0fe12018-04-09 09:24:52 -0700629 hdr.is_ip4 = at->is_ip4;
630 hdr.rmt_port = at->rmt_port;
Dave Barach178cf492018-11-13 16:34:13 -0500631 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
Florin Coras7fb0fe12018-04-09 09:24:52 -0700632 hdr.lcl_port = at->lcl_port;
Florin Coras87b15ce2019-04-28 21:16:30 -0700633 rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700634 ASSERT (rv == sizeof (hdr));
635
Florin Coras87b15ce2019-04-28 21:16:30 -0700636 rv = svm_fifo_enqueue (f, actual_write, data);
Florin Coras4b761122019-03-21 13:54:53 -0700637 if (do_evt)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700638 {
Florin Coras4b761122019-03-21 13:54:53 -0700639 if (rv > 0 && svm_fifo_set_event (f))
Florin Corasc0737e92019-03-04 14:19:39 -0800640 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
641 noblock);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700642 }
Florin Coras8e43d042018-05-04 15:46:57 -0700643 ASSERT (rv);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700644 return rv;
645}
646
647always_inline int
648app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
649{
650 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
Florin Coras653e43f2019-03-04 10:56:23 -0800651 len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
652 noblock);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700653}
654
655always_inline int
Florin Coras3c2fed52018-07-04 04:15:05 -0700656app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
Florin Coras653e43f2019-03-04 10:56:23 -0800657 u32 len, u8 evt_type, u8 do_evt, u8 noblock)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700658{
Florin Coras7fb0fe12018-04-09 09:24:52 -0700659 int rv;
660
Florin Coras87b15ce2019-04-28 21:16:30 -0700661 rv = svm_fifo_enqueue (f, len, data);
Florin Coras4b761122019-03-21 13:54:53 -0700662 if (do_evt)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700663 {
Florin Coras4b761122019-03-21 13:54:53 -0700664 if (rv > 0 && svm_fifo_set_event (f))
Florin Corasc0737e92019-03-04 14:19:39 -0800665 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
666 noblock);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700667 }
668 return rv;
669}
670
671always_inline int
672app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
673{
Florin Coras460dce62018-07-27 05:45:06 -0700674 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
Florin Coras653e43f2019-03-04 10:56:23 -0800675 SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700676}
677
678always_inline int
679app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
680{
681 if (s->is_dgram)
682 return app_send_dgram (s, data, len, noblock);
683 return app_send_stream (s, data, len, noblock);
684}
685
686always_inline int
687app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
Florin Coras460dce62018-07-27 05:45:06 -0700688 app_session_transport_t * at, u8 clear_evt, u8 peek)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700689{
690 session_dgram_pre_hdr_t ph;
691 u32 max_deq;
692 int rv;
693
Sirshak Das28aa5392019-02-05 01:33:33 -0600694 max_deq = svm_fifo_max_dequeue_cons (f);
Florin Coras0a1e1832020-03-29 18:54:04 +0000695 if (max_deq <= sizeof (session_dgram_hdr_t))
Florin Coras460dce62018-07-27 05:45:06 -0700696 {
697 if (clear_evt)
698 svm_fifo_unset_event (f);
699 return 0;
700 }
701
702 if (clear_evt)
703 svm_fifo_unset_event (f);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700704
705 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
706 ASSERT (ph.data_length >= ph.data_offset);
Florin Coras7a2abce2020-04-05 19:25:44 +0000707
Florin Corasba78e232020-04-06 21:28:59 +0000708 /* Check if we have the full dgram */
709 if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
710 && len >= ph.data_length)
711 return 0;
712
713 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700714 len = clib_min (len, ph.data_length - ph.data_offset);
715 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
Florin Coras460dce62018-07-27 05:45:06 -0700716 if (peek)
717 return rv;
Florin Coras7a2abce2020-04-05 19:25:44 +0000718
719 /* Discards data that did not fit in buffer */
720 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
721
Florin Coras7fb0fe12018-04-09 09:24:52 -0700722 return rv;
723}
724
725always_inline int
726app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
727{
Florin Coras460dce62018-07-27 05:45:06 -0700728 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700729}
730
731always_inline int
Florin Coras460dce62018-07-27 05:45:06 -0700732app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700733{
734 if (clear_evt)
735 svm_fifo_unset_event (f);
Florin Coras460dce62018-07-27 05:45:06 -0700736
737 if (peek)
738 return svm_fifo_peek (f, 0, len, buf);
739
Florin Coras87b15ce2019-04-28 21:16:30 -0700740 return svm_fifo_dequeue (f, len, buf);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700741}
742
743always_inline int
744app_recv_stream (app_session_t * s, u8 * buf, u32 len)
745{
Florin Coras460dce62018-07-27 05:45:06 -0700746 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700747}
748
749always_inline int
750app_recv (app_session_t * s, u8 * data, u32 len)
751{
752 if (s->is_dgram)
753 return app_recv_dgram (s, data, len);
754 return app_recv_stream (s, data, len);
755}
756
Florin Coras00e01d32019-10-21 16:07:46 -0700757/* *INDENT-OFF* */
758static char *session_error_str[] = {
759#define _(sym, str) str,
760 foreach_session_error
761#undef _
762};
763/* *INDENT-ON* */
764
765static inline u8 *
766format_session_error (u8 * s, va_list * args)
767{
768 session_error_t error = va_arg (*args, session_error_t);
769 if (-error >= 0 && -error < SESSION_N_ERRORS)
770 s = format (s, "%s", session_error_str[-error]);
771 else
772 s = format (s, "invalid session err %u", -error);
773 return s;
774}
Dave Barach68b0fb02017-02-28 15:15:56 -0500775#endif /* __included_uri_h__ */
776
777/*
778 * fd.io coding-style-patch-verification: ON
779 *
780 * Local Variables:
781 * eval: (c-set-style "gnu")
782 * End:
783 */