quic: Add support for unidirectional streams
[vpp.git] / src / plugins / hs_apps / sapi / vpp_echo_common.h
1 /*
2  * Copyright (c) 2019 Cisco and/or its affiliates.
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
16 #ifndef __included_vpp_echo_common_h__
17 #define __included_vpp_echo_common_h__
18
19 #include <vnet/session/application_interface.h>
20 #include <vpp/api/vpe_msg_enum.h>
21
22 #define vl_typedefs             /* define message structures */
23 #include <vpp/api/vpe_all_api_h.h>
24 #undef vl_typedefs
25
26 /* declare message handlers for each api */
27
28 #define vl_endianfun            /* define message structures */
29 #include <vpp/api/vpe_all_api_h.h>
30 #undef vl_endianfun
31
32 /* instantiate all the print functions we know about */
33 #define vl_print(handle, ...)
34 #define vl_printfun
35 #include <vpp/api/vpe_all_api_h.h>
36 #undef vl_printfun
37
38 #define TIMEOUT 10.0
39 #define LOGGING_BATCH (100)
40
41 #define foreach_echo_fail_code                                          \
42   _(ECHO_FAIL_NONE, "ECHO_FAIL_NONE")                                   \
43   _(ECHO_FAIL_USAGE, "ECHO_FAIL_USAGE")                                 \
44   _(ECHO_FAIL_SEND_IO_EVT, "ECHO_FAIL_SEND_IO_EVT")                     \
45   _(ECHO_FAIL_SOCKET_CONNECT, "ECHO_FAIL_SOCKET_CONNECT")               \
46   _(ECHO_FAIL_INIT_SHM_API, "ECHO_FAIL_INIT_SHM_API")                   \
47   _(ECHO_FAIL_SHMEM_CONNECT, "ECHO_FAIL_SHMEM_CONNECT")                 \
48   _(ECHO_FAIL_TEST_BYTES_ERR, "ECHO_FAIL_TEST_BYTES_ERR")               \
49   _(ECHO_FAIL_BIND, "ECHO_FAIL_BIND")                                   \
50   _(ECHO_FAIL_SESSION_ACCEPTED_BAD_LISTENER,                            \
51     "ECHO_FAIL_SESSION_ACCEPTED_BAD_LISTENER")                          \
52   _(ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC,                              \
53     "ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC")                            \
54   _(ECHO_FAIL_SESSION_CONNECT, "ECHO_FAIL_SESSION_CONNECT")             \
55   _(ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC,                             \
56     "ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC")                           \
57   _(ECHO_FAIL_APP_ATTACH, "ECHO_FAIL_APP_ATTACH")                       \
58   _(ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT,                                \
59     "ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT")                              \
60   _(ECHO_FAIL_INVALID_URI, "ECHO_FAIL_INVALID_URI")                     \
61   _(ECHO_FAIL_PROTOCOL_NOT_SUPPORTED,                                   \
62     "ECHO_FAIL_PROTOCOL_NOT_SUPPORTED")                                 \
63   _(ECHO_FAIL_CONNECT_TO_VPP, "ECHO_FAIL_CONNECT_TO_VPP")               \
64   _(ECHO_FAIL_ATTACH_TO_VPP, "ECHO_FAIL_ATTACH_TO_VPP")                 \
65   _(ECHO_FAIL_1ST_PTHREAD_CREATE, "ECHO_FAIL_1ST_PTHREAD_CREATE")       \
66   _(ECHO_FAIL_PTHREAD_CREATE, "ECHO_FAIL_PTHREAD_CREATE")               \
67   _(ECHO_FAIL_DETACH, "ECHO_FAIL_DETACH")                               \
68   _(ECHO_FAIL_DEL_CERT_KEY, "ECHO_FAIL_DEL_CERT_KEY")                               \
69   _(ECHO_FAIL_MQ_PTHREAD, "ECHO_FAIL_MQ_PTHREAD")                       \
70   _(ECHO_FAIL_VL_API_APP_ATTACH, "ECHO_FAIL_VL_API_APP_ATTACH")         \
71   _(ECHO_FAIL_VL_API_MISSING_SEGMENT_NAME,                              \
72     "ECHO_FAIL_VL_API_MISSING_SEGMENT_NAME")                            \
73   _(ECHO_FAIL_VL_API_NULL_APP_MQ, "ECHO_FAIL_VL_API_NULL_APP_MQ")       \
74   _(ECHO_FAIL_VL_API_RECV_FD_MSG, "ECHO_FAIL_VL_API_RECV_FD_MSG")       \
75   _(ECHO_FAIL_VL_API_SVM_FIFO_SEG_ATTACH,                               \
76     "ECHO_FAIL_VL_API_SVM_FIFO_SEG_ATTACH")                             \
77   _(ECHO_FAIL_VL_API_FIFO_SEG_ATTACH,                                   \
78     "ECHO_FAIL_VL_API_FIFO_SEG_ATTACH")                                 \
79   _(ECHO_FAIL_VL_API_DETACH_REPLY, "ECHO_FAIL_VL_API_DETACH_REPLY")     \
80   _(ECHO_FAIL_VL_API_BIND_URI_REPLY, "ECHO_FAIL_VL_API_BIND_URI_REPLY") \
81   _(ECHO_FAIL_VL_API_UNBIND_REPLY, "ECHO_FAIL_VL_API_UNBIND_REPLY")     \
82   _(ECHO_FAIL_SESSION_DISCONNECT, "ECHO_FAIL_SESSION_DISCONNECT")       \
83   _(ECHO_FAIL_SESSION_RESET, "ECHO_FAIL_SESSION_RESET")                 \
84   _(ECHO_FAIL_VL_API_CERT_KEY_ADD_REPLY,                                \
85     "ECHO_FAIL_VL_API_CERT_KEY_ADD_REPLY")                              \
86   _(ECHO_FAIL_VL_API_CERT_KEY_DEL_REPLY,                                \
87     "ECHO_FAIL_VL_API_CERT_KEY_DEL_REPLY")                              \
88   _(ECHO_FAIL_GET_SESSION_FROM_HANDLE,                                  \
89     "ECHO_FAIL_GET_SESSION_FROM_HANDLE")                                \
90   _(ECHO_FAIL_QUIC_WRONG_CONNECT, "ECHO_FAIL_QUIC_WRONG_CONNECT")       \
91   _(ECHO_FAIL_QUIC_WRONG_ACCEPT, "ECHO_FAIL_QUIC_WRONG_ACCEPT")         \
92   _(ECHO_FAIL_TCP_BAPI_CONNECT, "ECHO_FAIL_TCP_BAPI_CONNECT")           \
93   _(ECHO_FAIL_UDP_BAPI_CONNECT, "ECHO_FAIL_UDP_BAPI_CONNECT")           \
94   _(ECHO_FAIL_MISSING_START_EVENT, "ECHO_FAIL_MISSING_START_EVENT")     \
95   _(ECHO_FAIL_MISSING_END_EVENT, "ECHO_FAIL_MISSING_END_EVENT")         \
96   _(ECHO_FAIL_TEST_ASSERT_RX_TOTAL, "ECHO_FAIL_TEST_ASSERT_RX_TOTAL")   \
97   _(ECHO_FAIL_UNIDIRECTIONAL, "ECHO_FAIL_UNIDIRECTIONAL")               \
98   _(ECHO_FAIL_TEST_ASSERT_TX_TOTAL, "ECHO_FAIL_TEST_ASSERT_TX_TOTAL")   \
99   _(ECHO_FAIL_TEST_ASSERT_ALL_SESSIONS_CLOSED,                          \
100     "ECHO_FAIL_TEST_ASSERT_ALL_SESSIONS_CLOSED")                        \
101   _(ECHO_FAIL_RPC_SIZE, "ECHO_FAIL_RPC_SIZE")
102
103 typedef enum
104 {
105 #define _(sym, str) sym,
106   foreach_echo_fail_code
107 #undef _
108 } echo_fail_t;
109
110 extern char *echo_fail_code_str[];
111
112 #define CHECK_SAME(fail, expected, result, _fmt, _args...)      \
113 do {                                                            \
114   if ((expected) != (result))                                   \
115     ECHO_FAIL ((fail), "expected same (%lld, got %lld) : "_fmt, \
116                (u64)(expected), (u64)(result), ##_args);        \
117 } while (0)
118
119 #define CHECK_DIFF(fail, expected, result, _fmt, _args...)      \
120 do {                                                            \
121   if ((expected) == (result))                                   \
122     ECHO_FAIL ((fail), "expected different (both %lld) : "_fmt, \
123                (u64)(expected), ##_args);                       \
124 } while (0)
125
126 #define ECHO_FAIL(fail, _fmt, _args...)                                 \
127 do {                                                                    \
128     echo_main_t *em = &echo_main;                                       \
129     em->has_failed = (fail);                                            \
130     if (vec_len(em->fail_descr))                                        \
131       em->fail_descr = format(em->fail_descr, " | %s (%u): "_fmt,       \
132                               echo_fail_code_str[fail], fail, ##_args); \
133     else                                                                \
134       em->fail_descr = format(0, "%s (%u): "_fmt,                       \
135                               echo_fail_code_str[fail], fail, ##_args); \
136     em->time_to_stop = 1;                                               \
137     if (em->log_lvl > 0)                                                \
138       clib_warning ("%v", em->fail_descr);                              \
139 } while (0)
140
141 #define ECHO_LOG(lvl, _fmt,_args...)    \
142   {                                     \
143     echo_main_t *em = &echo_main;       \
144     if (em->log_lvl > lvl)              \
145          clib_warning (_fmt, ##_args);  \
146   }
147
148 #define ECHO_REGISTER_PROTO(proto, vft)         \
149   static void __clib_constructor                \
150   vpp_echo_init_##proto ()                      \
151   {                                             \
152     echo_main_t *em = &echo_main;               \
153     em->available_proto_cb_vft[proto] = &vft;   \
154   }
155
156 typedef struct
157 {
158   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
159 #define _(type, name) type name;
160   foreach_app_session_field
161 #undef _
162   u64 vpp_session_handle;
163   u64 bytes_sent;
164   u64 bytes_to_send;
165   volatile u64 bytes_received;
166   volatile u64 bytes_to_receive;
167   f64 start;
168   u32 listener_index;           /* listener index in echo session pool */
169   u32 idle_cycles;              /* consecutive enq/deq with no data */
170   volatile u64 accepted_session_count;  /* sessions we accepted (as a listener) */
171 } echo_session_t;
172
173 typedef enum
174 {
175   ECHO_NO_DATA_SOURCE,
176   ECHO_TEST_DATA_SOURCE,
177   ECHO_RX_DATA_SOURCE,
178   ECHO_INVALID_DATA_SOURCE
179 } data_source_t;
180
181 enum echo_close_f_t
182 {
183   ECHO_CLOSE_F_INVALID = 0,
184   ECHO_CLOSE_F_PASSIVE,         /* wait for close msg */
185   ECHO_CLOSE_F_ACTIVE,          /* send close msg */
186   ECHO_CLOSE_F_NONE,            /* don't bother sending close msg */
187 };
188
189 enum quic_session_type_t
190 {
191   ECHO_SESSION_TYPE_QUIC,
192   ECHO_SESSION_TYPE_STREAM,
193   ECHO_SESSION_TYPE_LISTEN,
194 };
195
196 enum quic_session_state_t
197 {
198   ECHO_SESSION_STATE_INITIAL,
199   ECHO_SESSION_STATE_READY,
200   ECHO_SESSION_STATE_AWAIT_CLOSING,     /* Data transfer is done, wait for close evt */
201   ECHO_SESSION_STATE_AWAIT_DATA,        /* Peer closed, wait for outstanding data */
202   ECHO_SESSION_STATE_CLOSING,   /* told vpp to close */
203   ECHO_SESSION_STATE_CLOSED,    /* closed in vpp */
204 };
205
206 typedef enum
207 {
208   STATE_START,
209   STATE_ATTACHED_NO_CERT,
210   STATE_ATTACHED,
211   STATE_LISTEN,
212   STATE_READY,
213   STATE_DATA_DONE,
214   STATE_DISCONNECTED,
215   STATE_CLEANED_CERT_KEY,
216   STATE_DETACHED
217 } connection_state_t;
218
219 typedef enum echo_test_evt_
220 {
221   ECHO_EVT_START = 1,           /* app starts */
222   ECHO_EVT_FIRST_QCONNECT = (1 << 1),   /* First connect Quic session sent */
223   ECHO_EVT_LAST_QCONNECTED = (1 << 2),  /* All Quic session are connected */
224   ECHO_EVT_FIRST_SCONNECT = (1 << 3),   /* First connect Stream session sent */
225   ECHO_EVT_LAST_SCONNECTED = (1 << 4),  /* All Stream session are connected */
226   ECHO_EVT_LAST_BYTE = (1 << 5),        /* Last byte received */
227   ECHO_EVT_EXIT = (1 << 6),     /* app exits */
228 } echo_test_evt_t;
229
230 typedef union session_connected_bundled_msg_
231 {
232   session_connected_msg_t *mp;
233   vl_api_connect_uri_reply_t *bmp;
234 } session_connected_bundled_msg_t;
235
236 typedef struct echo_proto_cb_vft_
237 {
238   void (*connected_cb) (session_connected_bundled_msg_t * mp, u32 session_index, u8 is_failed); /* Session is connected */
239   void (*accepted_cb) (session_accepted_msg_t * mp, echo_session_t * session);  /* Session got accepted */
240   void (*bound_uri_cb) (session_bound_msg_t * mp, echo_session_t * session);    /* Session got bound */
241   void (*reset_cb) (session_reset_msg_t * mp, echo_session_t * s);      /* Received RESET on session */
242   void (*disconnected_cb) (session_disconnected_msg_t * mp, echo_session_t * s);        /* Received DISCONNECT on session */
243   void (*sent_disconnect_cb) (echo_session_t * s);      /* ACK disconnect we sent to vpp */
244   void (*cleanup_cb) (echo_session_t * s, u8 parent_died);      /* Session should be cleaned up (parent listener may be dead) */
245   /* Add CLI options */
246   int (*process_opts_cb) (unformat_input_t * a);
247   void (*set_defaults_before_opts_cb) (void);
248   void (*set_defaults_after_opts_cb) (void);
249   void (*print_usage_cb) (void);
250 } echo_proto_cb_vft_t;
251
252 typedef enum
253 {
254   RETURN_PACKETS_NOTEST,
255   RETURN_PACKETS_LOG_WRONG,
256   RETURN_PACKETS_ASSERT,
257 } test_return_packets_t;
258
259 typedef struct teardown_stat_
260 {
261   u32 q;                        /* quic sessions */
262   u32 s;                        /* stream sessions */
263 } teardown_stat_t;
264
265 typedef struct
266 {
267   svm_queue_t *vl_input_queue;  /* vpe input queue */
268   u32 my_client_index;          /* API client handle */
269   u8 *uri;                      /* The URI we're playing with */
270   u32 n_uris;                   /* Cycle through adjacent ips */
271   ip46_address_t lcl_ip;        /* Local ip for client */
272   u8 lcl_ip_set;
273   echo_session_t *sessions;     /* Session pool */
274   svm_msg_q_t *app_mq;          /* Our receiveing event queue */
275   svm_msg_q_t *ctrl_mq;         /* Our control queue (towards vpp) */
276   clib_time_t clib_time;        /* For deadman timers */
277   u8 *socket_name;
278   int i_am_master;
279   u32 *listen_session_indexes;  /* vec of vpp listener sessions */
280   volatile u32 listen_session_cnt;
281
282   uword *session_index_by_vpp_handles;  /* Hash table : quic_echo s_id -> vpp s_handle */
283   clib_spinlock_t sid_vpp_handles_lock; /* Hash table lock */
284
285   uword *shared_segment_handles;        /* Hash table : segment_names -> 1 */
286   clib_spinlock_t segment_handles_lock; /* Hash table lock */
287   echo_proto_cb_vft_t *proto_cb_vft;
288   svm_msg_q_t *rpc_msq_queue;   /* MQ between quic_echo threads */
289   fifo_segment_main_t segment_main;
290
291   /* State of the connection, shared between msg RX thread and main thread */
292   volatile connection_state_t state;
293   volatile u8 time_to_stop;     /* Signal variables */
294   u8 rx_results_diff;           /* Rx results will be different than cfg */
295   u8 tx_results_diff;           /* Tx results will be different than cfg */
296   u8 has_failed;                /* stores the exit code */
297   u8 *fail_descr;               /* vector containing fail description */
298
299   /** Flag that decides if socket, instead of svm, api is used to connect to
300    * vpp. If sock api is used, shm binary api is subsequently bootstrapped
301    * and all other messages are exchanged using shm IPC. */
302   u8 use_sock_api;
303
304   u8 *connect_test_data;
305   u8 test_return_packets;
306   u64 bytes_to_send;            /* target per stream */
307   u64 bytes_to_receive;         /* target per stream */
308   u32 fifo_size;
309   u32 prealloc_fifo_pairs;
310   u64 rx_buf_size;
311   u64 tx_buf_size;
312   data_source_t data_source;    /* Use no/dummy/mirrored data */
313   u8 send_stream_disconnects;   /* actively send disconnect */
314   u8 output_json;               /* Output stats as JSON */
315   volatile u8 wait_for_gdb;     /* Wait for gdb to attach */
316   u8 log_lvl;                   /* Verbosity of the logging */
317   int max_test_msg;             /* Limit the number of incorrect data messages */
318   u32 evt_q_size;               /* Size of the vpp MQ (app<->vpp events) */
319   u32 ckpair_index;             /* Cert key pair used */
320   u8 crypto_engine;             /* crypto engine used */
321   u8 connect_flag;              /* flags to pass to mq connect */
322
323   u8 *appns_id;
324   u64 appns_flags;
325   u64 appns_secret;
326
327   pthread_t *data_thread_handles;       /* vec of data thread handles */
328   pthread_t mq_thread_handle;   /* Message queue thread handle */
329   u32 *volatile data_thread_args;
330
331   u32 n_connects;               /* Target number of connects to send */
332   u32 n_sessions;               /* Number of sessions to prealloc */
333   u32 n_clients;                /* Target number of clients doing RX/TX */
334   u32 n_rx_threads;             /* Number of data threads */
335
336   volatile u32 n_clients_connected;     /* Number of STREAM sessions connected */
337   volatile u32 nxt_available_sidx;      /* next unused prealloced session_index */
338
339   volatile int max_sim_connects;
340
341   /* VNET_API_ERROR_FOO -> "Foo" hash table */
342   uword *error_string_by_error_number;
343   echo_proto_cb_vft_t *available_proto_cb_vft[TRANSPORT_N_PROTO];
344
345   struct
346   {
347     u64 tx_total;
348     u64 rx_total;
349     u64 tx_expected;
350     u64 rx_expected;
351     teardown_stat_t reset_count;        /* received reset from vpp */
352     teardown_stat_t close_count;        /* received close from vpp */
353     teardown_stat_t active_count;       /* sent close to vpp */
354     teardown_stat_t clean_count;        /* cleaned up stale session */
355     teardown_stat_t connected_count;    /* connected sessions count */
356     teardown_stat_t accepted_count;     /* connected sessions count */
357   } stats;
358
359   struct                        /* Event based timing : start & end depend on CLI specified events */
360   {
361     f64 start_time;
362     f64 end_time;
363     u8 events_sent;
364     u8 start_event;
365     u8 end_event;
366   } timing;
367
368   struct
369   {
370     u32 transport_proto;
371     ip46_address_t ip;
372     u32 port;
373     u8 is_ip4;
374   } uri_elts;
375 } echo_main_t;
376
377 extern echo_main_t echo_main;
378
379
380 typedef struct echo_connect_args_
381 {
382   u32 context;
383   u64 parent_session_handle;
384   ip46_address_t ip;
385   ip46_address_t lcl_ip;
386 } echo_connect_args_t;
387
388 typedef struct echo_disconnect_args_
389 {
390   u64 session_handle;
391 } echo_disconnect_args_t;
392
393 typedef union
394 {
395   echo_connect_args_t connect;
396   echo_disconnect_args_t disconnect;
397 } echo_rpc_args_t;
398
399 typedef void (*echo_rpc_t) (echo_main_t * em, echo_rpc_args_t * arg);
400
401 typedef struct
402 {
403   void *fp;
404   echo_rpc_args_t args;
405 } echo_rpc_msg_t;
406
407
408 u8 *format_ip4_address (u8 * s, va_list * args);
409 u8 *format_ip6_address (u8 * s, va_list * args);
410 u8 *format_ip46_address (u8 * s, va_list * args);
411 u8 *format_api_error (u8 * s, va_list * args);
412 void init_error_string_table ();
413 u8 *echo_format_session (u8 * s, va_list * args);
414 u8 *echo_format_session_type (u8 * s, va_list * args);
415 u8 *echo_format_session_state (u8 * s, va_list * args);
416 u8 *echo_format_app_state (u8 * s, va_list * args);
417 uword echo_unformat_close (unformat_input_t * input, va_list * args);
418 uword echo_unformat_timing_event (unformat_input_t * input, va_list * args);
419 u8 *echo_format_timing_event (u8 * s, va_list * args);
420 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
421 u8 *format_transport_proto (u8 * s, va_list * args);
422 uword unformat_ip4_address (unformat_input_t * input, va_list * args);
423 uword unformat_ip6_address (unformat_input_t * input, va_list * args);
424
425 void echo_session_handle_add_del (echo_main_t * em, u64 handle, u32 sid);
426 echo_session_t *echo_session_new (echo_main_t * em);
427 int echo_send_rpc (echo_main_t * em, void *fp, echo_rpc_args_t * args);
428 echo_session_t *echo_get_session_from_handle (echo_main_t * em, u64 handle);
429 int wait_for_segment_allocation (u64 segment_handle);
430 int wait_for_state_change (echo_main_t * em, connection_state_t state,
431                            f64 timeout);
432 void echo_notify_event (echo_main_t * em, echo_test_evt_t e);
433 void echo_session_print_stats (echo_main_t * em, echo_session_t * session);
434 u8 *echo_format_crypto_engine (u8 * s, va_list * args);
435 uword echo_unformat_crypto_engine (unformat_input_t * input, va_list * args);
436
437 /* Binary API */
438
439 void echo_send_attach (echo_main_t * em);
440 void echo_send_detach (echo_main_t * em);
441 void echo_send_listen (echo_main_t * em, ip46_address_t * ip);
442 void echo_send_unbind (echo_main_t * em, echo_session_t * s);
443 void echo_send_connect (echo_main_t * em, void *args);
444 void echo_send_disconnect_session (echo_main_t * em, void *args);
445 void echo_api_hookup (echo_main_t * em);
446 void echo_send_add_cert_key (echo_main_t * em);
447 void echo_send_del_cert_key (echo_main_t * em);
448
449 #endif /* __included_vpp_echo_common_h__ */
450
451 /*
452  * fd.io coding-style-patch-verification: ON
453  *
454  * Local Variables:
455  * eval: (c-set-style "gnu")
456  * End:
457  */