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.
19 #include <hs_apps/sapi/vpp_echo_common.h>
21 char *echo_fail_code_str[] = {
22 #define _(sym, str) str,
23 foreach_echo_fail_code
34 format_ip4_address (u8 * s, va_list * args)
36 u8 *a = va_arg (*args, u8 *);
37 return format (s, "%d.%d.%d.%d", a[0], a[1], a[2], a[3]);
41 format_ip6_address (u8 * s, va_list * args)
43 ip6_address_t *a = va_arg (*args, ip6_address_t *);
44 u32 i, i_max_n_zero, max_n_zeros, i_first_zero, n_zeros, last_double_colon;
46 i_max_n_zero = ARRAY_LEN (a->as_u16);
48 i_first_zero = i_max_n_zero;
50 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
52 u32 is_zero = a->as_u16[i] == 0;
53 if (is_zero && i_first_zero >= ARRAY_LEN (a->as_u16))
59 if ((!is_zero && n_zeros > max_n_zeros)
60 || (i + 1 >= ARRAY_LEN (a->as_u16) && n_zeros > max_n_zeros))
62 i_max_n_zero = i_first_zero;
63 max_n_zeros = n_zeros;
64 i_first_zero = ARRAY_LEN (a->as_u16);
69 last_double_colon = 0;
70 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
72 if (i == i_max_n_zero && max_n_zeros > 1)
76 last_double_colon = 1;
80 s = format (s, "%s%x",
81 (last_double_colon || i == 0) ? "" : ":",
82 clib_net_to_host_u16 (a->as_u16[i]));
83 last_double_colon = 0;
90 /* Format an IP46 address. */
92 format_ip46_address (u8 * s, va_list * args)
94 ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
95 ip46_type_t type = va_arg (*args, ip46_type_t);
101 is_ip4 = ip46_address_is_ip4 (ip46);
112 format (s, "%U", format_ip4_address, &ip46->ip4) :
113 format (s, "%U", format_ip6_address, &ip46->ip6);
117 format_api_error (u8 * s, va_list * args)
119 echo_main_t *em = &echo_main;
120 i32 error = va_arg (*args, u32);
123 p = hash_get (em->error_string_by_error_number, -error);
126 s = format (s, "%s", p[0]);
128 s = format (s, "%d", error);
133 init_error_string_table ()
135 echo_main_t *em = &echo_main;
136 em->error_string_by_error_number = hash_create (0, sizeof (uword));
138 #define _(n,v,s) hash_set (em->error_string_by_error_number, -v, s);
139 foreach_vnet_api_error;
142 hash_set (em->error_string_by_error_number, 99, "Misc");
146 echo_format_session (u8 * s, va_list * args)
148 echo_session_t *session = va_arg (*args, echo_session_t *);
150 return format (s, "%U 0x%lx S[%u]", echo_format_session_type,
151 session->session_type, session->vpp_session_handle,
152 session->session_index);
156 echo_format_session_type (u8 * s, va_list * args)
158 u32 session_type = va_arg (*args, u32);
159 switch (session_type)
161 case ECHO_SESSION_TYPE_QUIC:
162 return format (s, "Qsession");
163 case ECHO_SESSION_TYPE_STREAM:
164 return format (s, "Stream");
165 case ECHO_SESSION_TYPE_LISTEN:
166 return format (s, "Lsession");
170 return format (s, "BadSession");
174 echo_format_session_state (u8 * s, va_list * args)
176 u32 session_state = va_arg (*args, u32);
177 switch (session_state)
179 case ECHO_SESSION_STATE_INITIAL:
180 return format (s, "ECHO_SESSION_STATE_INITIAL (%u)", session_state);
181 case ECHO_SESSION_STATE_READY:
182 return format (s, "ECHO_SESSION_STATE_READY (%u)", session_state);
183 case ECHO_SESSION_STATE_AWAIT_CLOSING:
184 return format (s, "ECHO_SESSION_STATE_AWAIT_CLOSING (%u)",
186 case ECHO_SESSION_STATE_AWAIT_DATA:
187 return format (s, "ECHO_SESSION_STATE_AWAIT_DATA (%u)", session_state);
188 case ECHO_SESSION_STATE_CLOSING:
189 return format (s, "ECHO_SESSION_STATE_CLOSING (%u)", session_state);
190 case ECHO_SESSION_STATE_CLOSED:
191 return format (s, "ECHO_SESSION_STATE_CLOSED (%u)", session_state);
195 return format (s, "unknown session state (%u)", session_state);
199 echo_format_app_state (u8 * s, va_list * args)
201 u32 state = va_arg (*args, u32);
202 if (state == STATE_START)
203 return format (s, "STATE_START (%u)", state);
204 if (state == STATE_ATTACHED)
205 return format (s, "STATE_ATTACHED (%u)", state);
206 if (state == STATE_ATTACHED_NO_CERT)
207 return format (s, "STATE_ATTACHED_NO_CERT (%u)", state);
208 if (state == STATE_LISTEN)
209 return format (s, "STATE_LISTEN (%u)", state);
210 if (state == STATE_READY)
211 return format (s, "STATE_READY (%u)", state);
212 if (state == STATE_DATA_DONE)
213 return format (s, "STATE_DATA_DONE (%u)", state);
214 if (state == STATE_DISCONNECTED)
215 return format (s, "STATE_DISCONNECTED (%u)", state);
216 if (state == STATE_DETACHED)
217 return format (s, "STATE_DETACHED (%u)", state);
219 return format (s, "unknown state (%u)", state);
223 echo_unformat_close (unformat_input_t * input, va_list * args)
225 u8 *a = va_arg (*args, u8 *);
226 if (unformat (input, "Y"))
227 *a = ECHO_CLOSE_F_ACTIVE;
228 else if (unformat (input, "N"))
229 *a = ECHO_CLOSE_F_NONE;
230 else if (unformat (input, "W"))
231 *a = ECHO_CLOSE_F_PASSIVE;
238 echo_unformat_timing_event (unformat_input_t * input, va_list * args)
240 u8 *a = va_arg (*args, u8 *);
241 if (unformat (input, "start"))
243 else if (unformat (input, "qconnected"))
244 *a = ECHO_EVT_LAST_QCONNECTED;
245 else if (unformat (input, "qconnect"))
246 *a = ECHO_EVT_FIRST_QCONNECT;
247 else if (unformat (input, "sconnected"))
248 *a = ECHO_EVT_LAST_SCONNECTED;
249 else if (unformat (input, "sconnect"))
250 *a = ECHO_EVT_FIRST_SCONNECT;
251 else if (unformat (input, "lastbyte"))
252 *a = ECHO_EVT_LAST_BYTE;
253 else if (unformat (input, "exit"))
261 echo_format_bytes_per_sec (u8 * s, va_list * args)
263 f64 bps = va_arg (*args, f64) * 8;
265 return format (s, "%.3f Gb/s", bps / 1e9);
267 return format (s, "%.3f Mb/s", bps / 1e6);
269 return format (s, "%.3f Kb/s", bps / 1e3);
271 return format (s, "%.3f b/s", bps);
275 echo_format_timing_event (u8 * s, va_list * args)
277 u32 timing_event = va_arg (*args, u32);
278 if (timing_event == ECHO_EVT_START)
279 return format (s, "start");
280 if (timing_event == ECHO_EVT_FIRST_QCONNECT)
281 return format (s, "qconnect");
282 if (timing_event == ECHO_EVT_LAST_QCONNECTED)
283 return format (s, "qconnected");
284 if (timing_event == ECHO_EVT_FIRST_SCONNECT)
285 return format (s, "sconnect");
286 if (timing_event == ECHO_EVT_LAST_SCONNECTED)
287 return format (s, "sconnected");
288 if (timing_event == ECHO_EVT_LAST_BYTE)
289 return format (s, "lastbyte");
290 if (timing_event == ECHO_EVT_EXIT)
291 return format (s, "exit");
293 return format (s, "unknown timing event");
297 unformat_transport_proto (unformat_input_t * input, va_list * args)
299 u32 *proto = va_arg (*args, u32 *);
300 if (unformat (input, "tcp"))
301 *proto = TRANSPORT_PROTO_TCP;
302 else if (unformat (input, "TCP"))
303 *proto = TRANSPORT_PROTO_TCP;
304 else if (unformat (input, "udp"))
305 *proto = TRANSPORT_PROTO_UDP;
306 else if (unformat (input, "UDP"))
307 *proto = TRANSPORT_PROTO_UDP;
308 else if (unformat (input, "tls"))
309 *proto = TRANSPORT_PROTO_TLS;
310 else if (unformat (input, "TLS"))
311 *proto = TRANSPORT_PROTO_TLS;
312 else if (unformat (input, "quic"))
313 *proto = TRANSPORT_PROTO_QUIC;
314 else if (unformat (input, "QUIC"))
315 *proto = TRANSPORT_PROTO_QUIC;
322 format_transport_proto (u8 * s, va_list * args)
324 u32 transport_proto = va_arg (*args, u32);
325 switch (transport_proto)
327 case TRANSPORT_PROTO_TCP:
328 s = format (s, "TCP");
330 case TRANSPORT_PROTO_UDP:
331 s = format (s, "UDP");
333 case TRANSPORT_PROTO_NONE:
334 s = format (s, "NONE");
336 case TRANSPORT_PROTO_TLS:
337 s = format (s, "TLS");
339 case TRANSPORT_PROTO_QUIC:
340 s = format (s, "QUIC");
343 s = format (s, "UNKNOWN");
350 unformat_ip4_address (unformat_input_t * input, va_list * args)
352 u8 *result = va_arg (*args, u8 *);
355 if (!unformat (input, "%d.%d.%d.%d", &a[0], &a[1], &a[2], &a[3]))
358 if (a[0] >= 256 || a[1] >= 256 || a[2] >= 256 || a[3] >= 256)
370 unformat_ip6_address (unformat_input_t * input, va_list * args)
372 ip6_address_t *result = va_arg (*args, ip6_address_t *);
374 uword hex_quad, n_hex_quads, hex_digit, n_hex_digits;
375 uword c, n_colon, double_colon_index;
377 n_hex_quads = hex_quad = n_hex_digits = n_colon = 0;
378 double_colon_index = ARRAY_LEN (hex_quads);
379 while ((c = unformat_get_input (input)) != UNFORMAT_END_OF_INPUT)
382 if (c >= '0' && c <= '9')
384 else if (c >= 'a' && c <= 'f')
385 hex_digit = c + 10 - 'a';
386 else if (c >= 'A' && c <= 'F')
387 hex_digit = c + 10 - 'A';
388 else if (c == ':' && n_colon < 2)
392 unformat_put_input (input);
396 /* Too many hex quads. */
397 if (n_hex_quads >= ARRAY_LEN (hex_quads))
402 hex_quad = (hex_quad << 4) | hex_digit;
404 /* Hex quad must fit in 16 bits. */
405 if (n_hex_digits >= 4)
412 /* Save position of :: */
415 /* More than one :: ? */
416 if (double_colon_index < ARRAY_LEN (hex_quads))
418 double_colon_index = n_hex_quads;
421 if (n_colon > 0 && n_hex_digits > 0)
423 hex_quads[n_hex_quads++] = hex_quad;
429 if (n_hex_digits > 0)
430 hex_quads[n_hex_quads++] = hex_quad;
435 /* Expand :: to appropriate number of zero hex quads. */
436 if (double_colon_index < ARRAY_LEN (hex_quads))
438 word n_zero = ARRAY_LEN (hex_quads) - n_hex_quads;
440 for (i = n_hex_quads - 1; i >= (signed) double_colon_index; i--)
441 hex_quads[n_zero + i] = hex_quads[i];
443 for (i = 0; i < n_zero; i++)
444 hex_quads[double_colon_index + i] = 0;
446 n_hex_quads = ARRAY_LEN (hex_quads);
449 /* Too few hex quads given. */
450 if (n_hex_quads < ARRAY_LEN (hex_quads))
453 for (i = 0; i < ARRAY_LEN (hex_quads); i++)
454 result->as_u16[i] = clib_host_to_net_u16 (hex_quads[i]);
461 unformat_ip46_address (unformat_input_t * input, va_list * args)
463 ip46_address_t *ip = va_arg (*args, ip46_address_t *);
465 if (unformat (input, "%U", unformat_ip4_address, &ip->ip4))
467 else if (unformat (input, "%U", unformat_ip6_address, &ip->ip6))
475 echo_format_crypto_engine (u8 * s, va_list * args)
477 u32 state = va_arg (*args, u32);
478 if (state == CRYPTO_ENGINE_MBEDTLS)
479 return format (s, "mbedtls");
480 if (state == CRYPTO_ENGINE_OPENSSL)
481 return format (s, "openssl");
482 if (state == CRYPTO_ENGINE_PICOTLS)
483 return format (s, "picotls");
484 if (state == CRYPTO_ENGINE_VPP)
485 return format (s, "vpp");
487 return format (s, "unknown crypto engine");
491 echo_unformat_crypto_engine (unformat_input_t * input, va_list * args)
493 u8 *a = va_arg (*args, u8 *);
494 if (unformat (input, "mbedtls"))
495 *a = CRYPTO_ENGINE_MBEDTLS;
496 else if (unformat (input, "openssl"))
497 *a = CRYPTO_ENGINE_OPENSSL;
498 else if (unformat (input, "picotls"))
499 *a = CRYPTO_ENGINE_PICOTLS;
500 else if (unformat (input, "vpp"))
501 *a = CRYPTO_ENGINE_VPP;
510 * End of format functions
515 echo_session_handle_add_del (echo_main_t * em, u64 handle, u32 sid)
517 clib_spinlock_lock (&em->sid_vpp_handles_lock);
518 if (sid == SESSION_INVALID_INDEX)
520 ECHO_LOG (3, "hash_unset(0x%lx)", handle);
521 hash_unset (em->session_index_by_vpp_handles, handle);
525 ECHO_LOG (3, "hash_set(0x%lx) S[%d]", handle, sid);
526 hash_set (em->session_index_by_vpp_handles, handle, sid);
528 clib_spinlock_unlock (&em->sid_vpp_handles_lock);
532 echo_session_new (echo_main_t * em)
534 /* thread safe new prealloced session
535 * see echo_session_prealloc */
536 return pool_elt_at_index (em->sessions,
537 clib_atomic_fetch_add (&em->nxt_available_sidx,
542 echo_send_rpc (echo_main_t * em, void *fp, echo_rpc_args_t * args)
546 if (PREDICT_FALSE (svm_msg_q_lock (em->rpc_msq_queue)))
548 ECHO_FAIL (ECHO_FAIL_RPC_SIZE, "RPC lock failed");
551 if (PREDICT_FALSE (svm_msg_q_ring_is_full (em->rpc_msq_queue, 0)))
553 svm_msg_q_unlock (em->rpc_msq_queue);
554 ECHO_FAIL (ECHO_FAIL_RPC_SIZE, "RPC ring is full");
557 msg = svm_msg_q_alloc_msg_w_ring (em->rpc_msq_queue, 0);
558 evt = (echo_rpc_msg_t *) svm_msg_q_msg_data (em->rpc_msq_queue, &msg);
560 clib_memcpy (&evt->args, args, sizeof (evt->args));
562 svm_msg_q_add_and_unlock (em->rpc_msq_queue, &msg);
567 echo_get_session_from_handle (echo_main_t * em, u64 handle)
570 clib_spinlock_lock (&em->sid_vpp_handles_lock);
571 p = hash_get (em->session_index_by_vpp_handles, handle);
572 clib_spinlock_unlock (&em->sid_vpp_handles_lock);
575 ECHO_LOG (2, "unknown handle 0x%lx", handle);
578 return pool_elt_at_index (em->sessions, p[0]);
582 wait_for_state_change (echo_main_t * em, connection_state_t state,
585 f64 end_time = clib_time_now (&em->clib_time) + timeout;
586 while (!timeout || clib_time_now (&em->clib_time) < end_time)
588 if (em->state == state)
590 if (em->time_to_stop)
593 ECHO_LOG (2, "timeout waiting for %U", echo_format_app_state, state);
598 echo_notify_event (echo_main_t * em, echo_test_evt_t e)
600 if (em->timing.events_sent & e)
602 if (em->timing.start_event == e)
603 em->timing.start_time = clib_time_now (&em->clib_time);
604 else if (em->timing.end_event == e)
605 em->timing.end_time = clib_time_now (&em->clib_time);
606 em->timing.events_sent |= e;
610 echo_session_print_stats (echo_main_t * em, echo_session_t * session)
612 f64 deltat = clib_time_now (&em->clib_time) - session->start;
613 ECHO_LOG (1, "Session 0x%x done in %.6fs RX[%.4f] TX[%.4f] Gbit/s\n",
614 session->vpp_session_handle, deltat,
615 (session->bytes_received * 8.0) / deltat / 1e9,
616 (session->bytes_sent * 8.0) / deltat / 1e9);
620 * fd.io coding-style-patch-verification: ON
623 * eval: (c-set-style "gnu")