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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef __included_vpp_echo_common_h__
17 #define __included_vpp_echo_common_h__
19 #include <vnet/session/application_interface.h>
20 #include <vpp/api/vpe_msg_enum.h>
22 #define vl_typedefs /* define message structures */
23 #include <vpp/api/vpe_all_api_h.h>
26 /* declare message handlers for each api */
28 #define vl_endianfun /* define message structures */
29 #include <vpp/api/vpe_all_api_h.h>
32 /* instantiate all the print functions we know about */
33 #define vl_print(handle, ...)
35 #include <vpp/api/vpe_all_api_h.h>
40 #define foreach_echo_fail_code \
41 _(ECHO_FAIL_NONE, "ECHO_FAIL_NONE") \
42 _(ECHO_FAIL_SEND_IO_EVT, "ECHO_FAIL_SEND_IO_EVT") \
43 _(ECHO_FAIL_SOCKET_CONNECT, "ECHO_FAIL_SOCKET_CONNECT") \
44 _(ECHO_FAIL_INIT_SHM_API, "ECHO_FAIL_INIT_SHM_API") \
45 _(ECHO_FAIL_SHMEM_CONNECT, "ECHO_FAIL_SHMEM_CONNECT") \
46 _(ECHO_FAIL_TEST_BYTES_ERR, "ECHO_FAIL_TEST_BYTES_ERR") \
47 _(ECHO_FAIL_BIND, "ECHO_FAIL_BIND") \
48 _(ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC, \
49 "ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC") \
50 _(ECHO_FAIL_SESSION_CONNECT, "ECHO_FAIL_SESSION_CONNECT") \
51 _(ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC, \
52 "ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC") \
53 _(ECHO_FAIL_APP_ATTACH, "ECHO_FAIL_APP_ATTACH") \
54 _(ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT, \
55 "ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT") \
56 _(ECHO_FAIL_INVALID_URI, "ECHO_FAIL_INVALID_URI") \
57 _(ECHO_FAIL_PROTOCOL_NOT_SUPPORTED, \
58 "ECHO_FAIL_PROTOCOL_NOT_SUPPORTED") \
59 _(ECHO_FAIL_CONNECT_TO_VPP, "ECHO_FAIL_CONNECT_TO_VPP") \
60 _(ECHO_FAIL_ATTACH_TO_VPP, "ECHO_FAIL_ATTACH_TO_VPP") \
61 _(ECHO_FAIL_1ST_PTHREAD_CREATE, "ECHO_FAIL_1ST_PTHREAD_CREATE") \
62 _(ECHO_FAIL_PTHREAD_CREATE, "ECHO_FAIL_PTHREAD_CREATE") \
63 _(ECHO_FAIL_DETACH, "ECHO_FAIL_DETACH") \
64 _(ECHO_FAIL_MQ_PTHREAD, "ECHO_FAIL_MQ_PTHREAD") \
65 _(ECHO_FAIL_VL_API_APP_ATTACH, "ECHO_FAIL_VL_API_APP_ATTACH") \
66 _(ECHO_FAIL_VL_API_MISSING_SEGMENT_NAME, \
67 "ECHO_FAIL_VL_API_MISSING_SEGMENT_NAME") \
68 _(ECHO_FAIL_VL_API_RECV_FD_MSG, "ECHO_FAIL_VL_API_RECV_FD_MSG") \
69 _(ECHO_FAIL_VL_API_SVM_FIFO_SEG_ATTACH, \
70 "ECHO_FAIL_VL_API_SVM_FIFO_SEG_ATTACH") \
71 _(ECHO_FAIL_VL_API_FIFO_SEG_ATTACH, \
72 "ECHO_FAIL_VL_API_FIFO_SEG_ATTACH") \
73 _(ECHO_FAIL_VL_API_DETACH_REPLY, "ECHO_FAIL_VL_API_DETACH_REPLY") \
74 _(ECHO_FAIL_VL_API_BIND_URI_REPLY, "ECHO_FAIL_VL_API_BIND_URI_REPLY") \
75 _(ECHO_FAIL_VL_API_UNBIND_REPLY, "ECHO_FAIL_VL_API_UNBIND_REPLY") \
76 _(ECHO_FAIL_SESSION_DISCONNECT, "ECHO_FAIL_SESSION_DISCONNECT") \
77 _(ECHO_FAIL_SESSION_RESET, "ECHO_FAIL_SESSION_RESET") \
78 _(ECHO_FAIL_VL_API_TLS_CERT_ADD_REPLY, \
79 "ECHO_FAIL_VL_API_TLS_CERT_ADD_REPLY") \
80 _(ECHO_FAIL_VL_API_TLS_KEY_ADD_REPLY, \
81 "ECHO_FAIL_VL_API_TLS_KEY_ADD_REPLY") \
82 _(ECHO_FAIL_GET_SESSION_FROM_HANDLE, \
83 "ECHO_FAIL_GET_SESSION_FROM_HANDLE") \
84 _(ECHO_FAIL_QUIC_WRONG_CONNECT, "ECHO_FAIL_QUIC_WRONG_CONNECT") \
85 _(ECHO_FAIL_QUIC_WRONG_ACCEPT, "ECHO_FAIL_QUIC_WRONG_ACCEPT") \
86 _(ECHO_FAIL_TCP_BAPI_CONNECT, "ECHO_FAIL_TCP_BAPI_CONNECT") \
87 _(ECHO_FAIL_UDP_BAPI_CONNECT, "ECHO_FAIL_UDP_BAPI_CONNECT") \
88 _(ECHO_FAIL_MISSING_START_EVENT, "ECHO_FAIL_MISSING_START_EVENT") \
89 _(ECHO_FAIL_MISSING_END_EVENT, "ECHO_FAIL_MISSING_END_EVENT") \
90 _(ECHO_FAIL_TEST_ASSERT_RX_TOTAL, "ECHO_FAIL_TEST_ASSERT_RX_TOTAL") \
91 _(ECHO_FAIL_TEST_ASSERT_TX_TOTAL, "ECHO_FAIL_TEST_ASSERT_TX_TOTAL") \
92 _(ECHO_FAIL_TEST_ASSERT_ALL_SESSIONS_CLOSED, \
93 "ECHO_FAIL_TEST_ASSERT_ALL_SESSIONS_CLOSED")
97 #define _(sym, str) sym,
98 foreach_echo_fail_code
102 extern char *echo_fail_code_str[];
104 #define CHECK(fail, expected, result, _fmt, _args...) \
105 if (expected != result) \
106 ECHO_FAIL (fail, "expected %d, got %d : " _fmt, expected, \
109 #define ECHO_FAIL(fail, _fmt, _args...) \
111 echo_main_t *em = &echo_main; \
112 em->has_failed = fail; \
113 if (vec_len(em->fail_descr)) \
114 em->fail_descr = format(em->fail_descr, " | %s (%d): "_fmt, \
115 echo_fail_code_str[fail], fail, ##_args); \
117 em->fail_descr = format(0, "%s (%d): "_fmt, \
118 echo_fail_code_str[fail], fail, ##_args); \
119 em->time_to_stop = 1; \
120 if (em->log_lvl > 0) \
121 clib_warning ("%v", em->fail_descr); \
124 #define ECHO_LOG(lvl, _fmt,_args...) \
126 echo_main_t *em = &echo_main; \
127 if (em->log_lvl > lvl) \
128 clib_warning (_fmt, ##_args); \
131 #define ECHO_REGISTER_PROTO(proto, vft) \
132 static void __clib_constructor \
133 vpp_echo_init_##proto () \
135 echo_main_t *em = &echo_main; \
136 em->available_proto_cb_vft[proto] = &vft; \
141 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
142 #define _(type, name) type name;
143 foreach_app_session_field
145 u64 vpp_session_handle;
148 volatile u64 bytes_received;
149 volatile u64 bytes_to_receive;
151 u32 listener_index; /* listener index in echo session pool */
152 u32 idle_cycles; /* consecutive enq/deq with no data */
153 volatile u64 accepted_session_count; /* sessions we accepted (as a listener) */
159 ECHO_TEST_DATA_SOURCE,
161 ECHO_INVALID_DATA_SOURCE
166 ECHO_CLOSE_F_INVALID = 0,
167 ECHO_CLOSE_F_PASSIVE, /* wait for close msg */
168 ECHO_CLOSE_F_ACTIVE, /* send close msg */
169 ECHO_CLOSE_F_NONE, /* don't bother sending close msg */
172 enum quic_session_type_t
174 ECHO_SESSION_TYPE_QUIC,
175 ECHO_SESSION_TYPE_STREAM,
176 ECHO_SESSION_TYPE_LISTEN,
179 enum quic_session_state_t
181 ECHO_SESSION_STATE_INITIAL,
182 ECHO_SESSION_STATE_READY,
183 ECHO_SESSION_STATE_AWAIT_CLOSING, /* Data transfer is done, wait for close evt */
184 ECHO_SESSION_STATE_AWAIT_DATA, /* Peer closed, wait for outstanding data */
185 ECHO_SESSION_STATE_CLOSING, /* told vpp to close */
186 ECHO_SESSION_STATE_CLOSED, /* closed in vpp */
192 STATE_ATTACHED_NO_CERT,
193 STATE_ATTACHED_ONE_CERT,
200 } connection_state_t;
202 typedef enum echo_test_evt_
204 ECHO_EVT_START = 1, /* app starts */
205 ECHO_EVT_FIRST_QCONNECT = (1 << 1), /* First connect Quic session sent */
206 ECHO_EVT_LAST_QCONNECTED = (1 << 2), /* All Quic session are connected */
207 ECHO_EVT_FIRST_SCONNECT = (1 << 3), /* First connect Stream session sent */
208 ECHO_EVT_LAST_SCONNECTED = (1 << 4), /* All Stream session are connected */
209 ECHO_EVT_LAST_BYTE = (1 << 5), /* Last byte received */
210 ECHO_EVT_EXIT = (1 << 6), /* app exits */
213 typedef union session_connected_bundled_msg_
215 session_connected_msg_t *mp;
216 vl_api_connect_uri_reply_t *bmp;
217 } session_connected_bundled_msg_t;
219 typedef struct echo_proto_cb_vft_
221 void (*connected_cb) (session_connected_bundled_msg_t * mp, u32 session_index, u8 is_failed); /* Session is connected */
222 void (*accepted_cb) (session_accepted_msg_t * mp, echo_session_t * session); /* Session got accepted */
223 void (*bound_uri_cb) (session_bound_msg_t * mp, echo_session_t * session); /* Session got bound */
224 void (*reset_cb) (session_reset_msg_t * mp, echo_session_t * s); /* Received RESET on session */
225 void (*disconnected_cb) (session_disconnected_msg_t * mp, echo_session_t * s); /* Received DISCONNECT on session */
226 void (*sent_disconnect_cb) (echo_session_t * s); /* ACK disconnect we sent to vpp */
227 void (*cleanup_cb) (echo_session_t * s, u8 parent_died); /* Session should be cleaned up (parent listener may be dead) */
228 /* Add CLI options */
229 int (*process_opts_cb) (unformat_input_t * a);
230 void (*set_defaults_before_opts_cb) (void);
231 void (*set_defaults_after_opts_cb) (void);
232 void (*print_usage_cb) (void);
233 } echo_proto_cb_vft_t;
237 RETURN_PACKETS_NOTEST,
238 RETURN_PACKETS_LOG_WRONG,
239 RETURN_PACKETS_ASSERT,
240 } test_return_packets_t;
242 typedef struct teardown_stat_
244 u32 q; /* quic sessions */
245 u32 s; /* stream sessions */
250 svm_queue_t *vl_input_queue; /* vpe input queue */
251 u32 my_client_index; /* API client handle */
252 u8 *uri; /* The URI we're playing with */
253 echo_session_t *sessions; /* Session pool */
254 svm_msg_q_t *app_mq; /* Our receiveing event queue */
255 svm_msg_q_t *ctrl_mq; /* Our control queue (towards vpp) */
256 clib_time_t clib_time; /* For deadman timers */
259 u32 listen_session_index; /* Index of vpp listener session */
261 uword *session_index_by_vpp_handles; /* Hash table : quic_echo s_id -> vpp s_handle */
262 clib_spinlock_t sid_vpp_handles_lock; /* Hash table lock */
264 uword *shared_segment_handles; /* Hash table : segment_names -> 1 */
265 clib_spinlock_t segment_handles_lock; /* Hash table lock */
266 echo_proto_cb_vft_t *proto_cb_vft;
267 svm_msg_q_t *rpc_msq_queue; /* MQ between quic_echo threads */
268 fifo_segment_main_t segment_main;
270 /* State of the connection, shared between msg RX thread and main thread */
271 volatile connection_state_t state;
272 volatile u8 time_to_stop; /* Signal variables */
273 u8 has_failed; /* stores the exit code */
274 u8 *fail_descr; /* vector containing fail description */
276 /** Flag that decides if socket, instead of svm, api is used to connect to
277 * vpp. If sock api is used, shm binary api is subsequently bootstrapped
278 * and all other messages are exchanged using shm IPC. */
281 u8 *connect_test_data;
282 u8 test_return_packets;
283 u64 bytes_to_send; /* target per stream */
284 u64 bytes_to_receive; /* target per stream */
286 u32 prealloc_fifo_pairs;
289 data_source_t data_source; /* Use no/dummy/mirrored data */
290 u8 send_stream_disconnects; /* actively send disconnect */
291 u8 output_json; /* Output stats as JSON */
292 u8 log_lvl; /* Verbosity of the logging */
293 int max_test_msg; /* Limit the number of incorrect data messages */
294 u32 evt_q_size; /* Size of the vpp MQ (app<->vpp events) */
295 u32 crypto_ctx_engine; /* crypto engine used */
301 pthread_t *data_thread_handles; /* vec of data thread handles */
302 pthread_t mq_thread_handle; /* Message queue thread handle */
303 u32 *volatile data_thread_args;
305 u32 n_connects; /* Target number of connects to send */
306 u32 n_sessions; /* Number of sessions to prealloc */
307 u32 n_clients; /* Target number of clients doing RX/TX */
308 u32 n_rx_threads; /* Number of data threads */
310 volatile u32 n_clients_connected; /* Number of STREAM sessions connected */
311 volatile u32 nxt_available_sidx; /* next unused prealloced session_index */
313 /* VNET_API_ERROR_FOO -> "Foo" hash table */
314 uword *error_string_by_error_number;
315 echo_proto_cb_vft_t *available_proto_cb_vft[TRANSPORT_N_PROTO];
321 teardown_stat_t reset_count; /* received reset from vpp */
322 teardown_stat_t close_count; /* received close from vpp */
323 teardown_stat_t active_count; /* sent close to vpp */
324 teardown_stat_t clean_count; /* cleaned up stale session */
327 struct /* Event based timing : start & end depend on CLI specified events */
345 extern echo_main_t echo_main;
347 typedef void (*echo_rpc_t) (void *arg, u32 opaque);
356 u8 *format_ip4_address (u8 * s, va_list * args);
357 u8 *format_ip6_address (u8 * s, va_list * args);
358 u8 *format_ip46_address (u8 * s, va_list * args);
359 uword unformat_data (unformat_input_t * input, va_list * args);
360 u8 *format_api_error (u8 * s, va_list * args);
361 void init_error_string_table ();
362 u8 *echo_format_app_state (u8 * s, va_list * args);
363 uword echo_unformat_close (unformat_input_t * input, va_list * args);
364 uword echo_unformat_timing_event (unformat_input_t * input, va_list * args);
365 u8 *echo_format_timing_event (u8 * s, va_list * args);
366 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
367 u8 *format_transport_proto (u8 * s, va_list * args);
368 uword unformat_ip4_address (unformat_input_t * input, va_list * args);
369 uword unformat_ip6_address (unformat_input_t * input, va_list * args);
371 void echo_session_handle_add_del (echo_main_t * em, u64 handle, u32 sid);
372 echo_session_t *echo_session_new (echo_main_t * em);
373 int echo_send_rpc (echo_main_t * em, void *fp, void *arg, u32 opaque);
374 echo_session_t *echo_get_session_from_handle (echo_main_t * em, u64 handle);
375 int wait_for_segment_allocation (u64 segment_handle);
376 int wait_for_state_change (echo_main_t * em, connection_state_t state,
378 void echo_notify_event (echo_main_t * em, echo_test_evt_t e);
379 void echo_session_print_stats (echo_main_t * em, echo_session_t * session);
380 u8 *echo_format_crypto_engine (u8 * s, va_list * args);
381 uword echo_unformat_crypto_engine (unformat_input_t * input, va_list * args);
385 void echo_send_attach (echo_main_t * em);
386 void echo_send_detach (echo_main_t * em);
387 void echo_send_listen (echo_main_t * em);
388 void echo_send_unbind (echo_main_t * em, echo_session_t * s);
389 void echo_send_connect (u64 vpp_session_handle, u32 opaque);
390 void echo_send_disconnect_session (u64 handle, u32 opaque);
391 void echo_api_hookup (echo_main_t * em);
392 void echo_send_add_crypto_ctx (echo_main_t * em);
394 #endif /* __included_vpp_echo_common_h__ */
397 * fd.io coding-style-patch-verification: ON
400 * eval: (c-set-style "gnu")