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 unformat_data (unformat_input_t * input, va_list * args)
120 u64 *a = va_arg (*args, u64 *);
121 if (unformat (input, "%lluGb", &_a))
123 else if (unformat (input, "%lluG", &_a))
125 else if (unformat (input, "%lluMb", &_a))
127 else if (unformat (input, "%lluM", &_a))
129 else if (unformat (input, "%lluKb", &_a))
131 else if (unformat (input, "%lluK", &_a))
133 else if (unformat (input, "%llu", a))
141 format_api_error (u8 * s, va_list * args)
143 echo_main_t *em = &echo_main;
144 i32 error = va_arg (*args, u32);
147 p = hash_get (em->error_string_by_error_number, -error);
150 s = format (s, "%s", p[0]);
152 s = format (s, "%d", error);
157 init_error_string_table ()
159 echo_main_t *em = &echo_main;
160 em->error_string_by_error_number = hash_create (0, sizeof (uword));
162 #define _(n,v,s) hash_set (em->error_string_by_error_number, -v, s);
163 foreach_vnet_api_error;
166 hash_set (em->error_string_by_error_number, 99, "Misc");
170 echo_format_app_state (u8 * s, va_list * args)
172 u32 state = va_arg (*args, u32);
173 if (state == STATE_START)
174 return format (s, "STATE_START");
175 if (state == STATE_ATTACHED)
176 return format (s, "STATE_ATTACHED");
177 if (state == STATE_ATTACHED_NO_CERT)
178 return format (s, "STATE_ATTACHED_NO_CERT");
179 if (state == STATE_ATTACHED_ONE_CERT)
180 return format (s, "STATE_ATTACHED_ONE_CERT");
181 if (state == STATE_LISTEN)
182 return format (s, "STATE_LISTEN");
183 if (state == STATE_READY)
184 return format (s, "STATE_READY");
185 if (state == STATE_DATA_DONE)
186 return format (s, "STATE_DATA_DONE");
187 if (state == STATE_DISCONNECTED)
188 return format (s, "STATE_DISCONNECTED");
189 if (state == STATE_DETACHED)
190 return format (s, "STATE_DETACHED");
192 return format (s, "unknown state");
196 echo_unformat_close (unformat_input_t * input, va_list * args)
198 u8 *a = va_arg (*args, u8 *);
199 if (unformat (input, "Y"))
200 *a = ECHO_CLOSE_F_ACTIVE;
201 else if (unformat (input, "N"))
202 *a = ECHO_CLOSE_F_NONE;
203 else if (unformat (input, "W"))
204 *a = ECHO_CLOSE_F_PASSIVE;
211 echo_unformat_timing_event (unformat_input_t * input, va_list * args)
213 u8 *a = va_arg (*args, u8 *);
214 if (unformat (input, "start"))
216 else if (unformat (input, "qconnected"))
217 *a = ECHO_EVT_LAST_QCONNECTED;
218 else if (unformat (input, "qconnect"))
219 *a = ECHO_EVT_FIRST_QCONNECT;
220 else if (unformat (input, "sconnected"))
221 *a = ECHO_EVT_LAST_SCONNECTED;
222 else if (unformat (input, "sconnect"))
223 *a = ECHO_EVT_FIRST_SCONNECT;
224 else if (unformat (input, "lastbyte"))
225 *a = ECHO_EVT_LAST_BYTE;
226 else if (unformat (input, "exit"))
234 echo_format_timing_event (u8 * s, va_list * args)
236 u32 timing_event = va_arg (*args, u32);
237 if (timing_event == ECHO_EVT_START)
238 return format (s, "start");
239 if (timing_event == ECHO_EVT_FIRST_QCONNECT)
240 return format (s, "qconnect");
241 if (timing_event == ECHO_EVT_LAST_QCONNECTED)
242 return format (s, "qconnected");
243 if (timing_event == ECHO_EVT_FIRST_SCONNECT)
244 return format (s, "sconnect");
245 if (timing_event == ECHO_EVT_LAST_SCONNECTED)
246 return format (s, "sconnected");
247 if (timing_event == ECHO_EVT_LAST_BYTE)
248 return format (s, "lastbyte");
249 if (timing_event == ECHO_EVT_EXIT)
250 return format (s, "exit");
252 return format (s, "unknown timing event");
256 unformat_transport_proto (unformat_input_t * input, va_list * args)
258 u32 *proto = va_arg (*args, u32 *);
259 if (unformat (input, "tcp"))
260 *proto = TRANSPORT_PROTO_TCP;
261 else if (unformat (input, "TCP"))
262 *proto = TRANSPORT_PROTO_TCP;
263 else if (unformat (input, "udpc"))
264 *proto = TRANSPORT_PROTO_UDPC;
265 else if (unformat (input, "UDPC"))
266 *proto = TRANSPORT_PROTO_UDPC;
267 else if (unformat (input, "udp"))
268 *proto = TRANSPORT_PROTO_UDP;
269 else if (unformat (input, "UDP"))
270 *proto = TRANSPORT_PROTO_UDP;
271 else if (unformat (input, "sctp"))
272 *proto = TRANSPORT_PROTO_SCTP;
273 else if (unformat (input, "SCTP"))
274 *proto = TRANSPORT_PROTO_SCTP;
275 else if (unformat (input, "tls"))
276 *proto = TRANSPORT_PROTO_TLS;
277 else if (unformat (input, "TLS"))
278 *proto = TRANSPORT_PROTO_TLS;
279 else if (unformat (input, "quic"))
280 *proto = TRANSPORT_PROTO_QUIC;
281 else if (unformat (input, "QUIC"))
282 *proto = TRANSPORT_PROTO_QUIC;
289 format_transport_proto (u8 * s, va_list * args)
291 u32 transport_proto = va_arg (*args, u32);
292 switch (transport_proto)
294 case TRANSPORT_PROTO_TCP:
295 s = format (s, "TCP");
297 case TRANSPORT_PROTO_UDP:
298 s = format (s, "UDP");
300 case TRANSPORT_PROTO_SCTP:
301 s = format (s, "SCTP");
303 case TRANSPORT_PROTO_NONE:
304 s = format (s, "NONE");
306 case TRANSPORT_PROTO_TLS:
307 s = format (s, "TLS");
309 case TRANSPORT_PROTO_UDPC:
310 s = format (s, "UDPC");
312 case TRANSPORT_PROTO_QUIC:
313 s = format (s, "QUIC");
316 s = format (s, "UNKNOWN");
323 unformat_ip4_address (unformat_input_t * input, va_list * args)
325 u8 *result = va_arg (*args, u8 *);
328 if (!unformat (input, "%d.%d.%d.%d", &a[0], &a[1], &a[2], &a[3]))
331 if (a[0] >= 256 || a[1] >= 256 || a[2] >= 256 || a[3] >= 256)
343 unformat_ip6_address (unformat_input_t * input, va_list * args)
345 ip6_address_t *result = va_arg (*args, ip6_address_t *);
347 uword hex_quad, n_hex_quads, hex_digit, n_hex_digits;
348 uword c, n_colon, double_colon_index;
350 n_hex_quads = hex_quad = n_hex_digits = n_colon = 0;
351 double_colon_index = ARRAY_LEN (hex_quads);
352 while ((c = unformat_get_input (input)) != UNFORMAT_END_OF_INPUT)
355 if (c >= '0' && c <= '9')
357 else if (c >= 'a' && c <= 'f')
358 hex_digit = c + 10 - 'a';
359 else if (c >= 'A' && c <= 'F')
360 hex_digit = c + 10 - 'A';
361 else if (c == ':' && n_colon < 2)
365 unformat_put_input (input);
369 /* Too many hex quads. */
370 if (n_hex_quads >= ARRAY_LEN (hex_quads))
375 hex_quad = (hex_quad << 4) | hex_digit;
377 /* Hex quad must fit in 16 bits. */
378 if (n_hex_digits >= 4)
385 /* Save position of :: */
388 /* More than one :: ? */
389 if (double_colon_index < ARRAY_LEN (hex_quads))
391 double_colon_index = n_hex_quads;
394 if (n_colon > 0 && n_hex_digits > 0)
396 hex_quads[n_hex_quads++] = hex_quad;
402 if (n_hex_digits > 0)
403 hex_quads[n_hex_quads++] = hex_quad;
408 /* Expand :: to appropriate number of zero hex quads. */
409 if (double_colon_index < ARRAY_LEN (hex_quads))
411 word n_zero = ARRAY_LEN (hex_quads) - n_hex_quads;
413 for (i = n_hex_quads - 1; i >= (signed) double_colon_index; i--)
414 hex_quads[n_zero + i] = hex_quads[i];
416 for (i = 0; i < n_zero; i++)
417 hex_quads[double_colon_index + i] = 0;
419 n_hex_quads = ARRAY_LEN (hex_quads);
422 /* Too few hex quads given. */
423 if (n_hex_quads < ARRAY_LEN (hex_quads))
426 for (i = 0; i < ARRAY_LEN (hex_quads); i++)
427 result->as_u16[i] = clib_host_to_net_u16 (hex_quads[i]);
434 echo_format_crypto_engine (u8 * s, va_list * args)
436 u32 state = va_arg (*args, u32);
437 if (state == TLS_ENGINE_MBEDTLS)
438 return format (s, "mbedtls");
439 if (state == TLS_ENGINE_OPENSSL)
440 return format (s, "openssl");
441 if (state == CRYPTO_ENGINE_PICOTLS)
442 return format (s, "picotls");
443 if (state == CRYPTO_ENGINE_VPP)
444 return format (s, "vpp");
446 return format (s, "unknown crypto engine");
450 echo_unformat_crypto_engine (unformat_input_t * input, va_list * args)
452 u8 *a = va_arg (*args, u8 *);
453 if (unformat (input, "mbedtls"))
454 *a = TLS_ENGINE_MBEDTLS;
455 else if (unformat (input, "openssl"))
456 *a = TLS_ENGINE_OPENSSL;
457 else if (unformat (input, "picotls"))
458 *a = CRYPTO_ENGINE_PICOTLS;
459 else if (unformat (input, "vpp"))
460 *a = CRYPTO_ENGINE_VPP;
469 * End of format functions
474 echo_session_handle_add_del (echo_main_t * em, u64 handle, u32 sid)
476 clib_spinlock_lock (&em->sid_vpp_handles_lock);
477 if (sid == SESSION_INVALID_INDEX)
478 hash_unset (em->session_index_by_vpp_handles, handle);
480 hash_set (em->session_index_by_vpp_handles, handle, sid);
481 clib_spinlock_unlock (&em->sid_vpp_handles_lock);
485 echo_session_new (echo_main_t * em)
487 /* thread safe new prealloced session */
488 return pool_elt_at_index (em->sessions,
489 clib_atomic_fetch_add (&em->nxt_available_sidx,
494 echo_send_rpc (echo_main_t * em, void *fp, void *arg, u32 opaque)
498 if (PREDICT_FALSE (svm_msg_q_lock (em->rpc_msq_queue)))
500 ECHO_LOG (1, "RPC lock failed");
503 if (PREDICT_FALSE (svm_msg_q_ring_is_full (em->rpc_msq_queue, 0)))
505 svm_msg_q_unlock (em->rpc_msq_queue);
506 ECHO_LOG (1, "RPC ring is full");
509 msg = svm_msg_q_alloc_msg_w_ring (em->rpc_msq_queue, 0);
510 evt = (echo_rpc_msg_t *) svm_msg_q_msg_data (em->rpc_msq_queue, &msg);
512 evt->opaque = opaque;
515 svm_msg_q_add_and_unlock (em->rpc_msq_queue, &msg);
520 echo_get_session_from_handle (echo_main_t * em, u64 handle)
523 clib_spinlock_lock (&em->sid_vpp_handles_lock);
524 p = hash_get (em->session_index_by_vpp_handles, handle);
525 clib_spinlock_unlock (&em->sid_vpp_handles_lock);
528 ECHO_FAIL (ECHO_FAIL_GET_SESSION_FROM_HANDLE,
529 "unknown handle 0x%lx", handle);
532 return pool_elt_at_index (em->sessions, p[0]);
536 wait_for_segment_allocation (u64 segment_handle)
538 echo_main_t *em = &echo_main;
540 timeout = clib_time_now (&em->clib_time) + TIMEOUT;
541 uword *segment_present;
542 ECHO_LOG (1, "Waiting for segment 0x%lx...", segment_handle);
543 while (clib_time_now (&em->clib_time) < timeout)
545 clib_spinlock_lock (&em->segment_handles_lock);
546 segment_present = hash_get (em->shared_segment_handles, segment_handle);
547 clib_spinlock_unlock (&em->segment_handles_lock);
548 if (segment_present != 0)
550 if (em->time_to_stop == 1)
553 ECHO_LOG (1, "timeout wait_for_segment_allocation (0x%lx)", segment_handle);
558 wait_for_state_change (echo_main_t * em, connection_state_t state,
561 f64 end_time = clib_time_now (&em->clib_time) + timeout;
562 while (!timeout || clib_time_now (&em->clib_time) < end_time)
564 if (em->state == state)
566 if (em->time_to_stop)
569 ECHO_LOG (1, "timeout waiting for %U", echo_format_app_state, state);
574 echo_notify_event (echo_main_t * em, echo_test_evt_t e)
576 if (em->timing.events_sent & e)
578 if (em->timing.start_event == e)
579 em->timing.start_time = clib_time_now (&em->clib_time);
580 else if (em->timing.end_event == e)
581 em->timing.end_time = clib_time_now (&em->clib_time);
582 em->timing.events_sent |= e;
586 echo_session_print_stats (echo_main_t * em, echo_session_t * session)
588 f64 deltat = clib_time_now (&em->clib_time) - session->start;
589 ECHO_LOG (0, "Session 0x%x done in %.6fs RX[%.4f] TX[%.4f] Gbit/s\n",
590 session->vpp_session_handle, deltat,
591 (session->bytes_received * 8.0) / deltat / 1e9,
592 (session->bytes_sent * 8.0) / deltat / 1e9);
596 * fd.io coding-style-patch-verification: ON
599 * eval: (c-set-style "gnu")