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