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 <vlibmemory/api.h>
20 #include <svm/fifo_segment.h>
22 #include <hs_apps/sapi/vpp_echo_common.h>
24 echo_main_t echo_main;
27 echo_session_prealloc (echo_main_t * em)
29 /* We need to prealloc to avoid vec resize in threads */
30 echo_session_t *session;
32 for (i = 0; i < em->n_sessions; i++)
34 pool_get (em->sessions, session);
35 clib_memset (session, 0, sizeof (*session));
36 session->session_index = session - em->sessions;
37 session->listener_index = SESSION_INVALID_INDEX;
38 session->session_state = ECHO_SESSION_STATE_INITIAL;
43 echo_assert_test_suceeded (echo_main_t * em)
45 CHECK (ECHO_FAIL_TEST_ASSERT_RX_TOTAL,
46 em->n_clients * em->bytes_to_receive, em->stats.rx_total,
47 "Invalid amount of data received");
48 CHECK (ECHO_FAIL_TEST_ASSERT_TX_TOTAL,
49 em->n_clients * em->bytes_to_send, em->stats.tx_total,
50 "Invalid amount of data sent");
51 clib_spinlock_lock (&em->sid_vpp_handles_lock);
52 CHECK (ECHO_FAIL_TEST_ASSERT_ALL_SESSIONS_CLOSED,
53 0, hash_elts (em->session_index_by_vpp_handles),
54 "Some sessions are still open");
55 clib_spinlock_unlock (&em->sid_vpp_handles_lock);
59 echo_session_dequeue_notify (echo_session_t * s)
62 if (!svm_fifo_set_event (s->rx_fifo))
65 app_send_io_evt_to_vpp (s->vpp_evt_q, s->rx_fifo->master_session_index,
66 SESSION_IO_EVT_RX, SVM_Q_WAIT)))
67 ECHO_FAIL (ECHO_FAIL_SEND_IO_EVT, "app_send_io_evt_to_vpp errored %d",
69 svm_fifo_clear_deq_ntf (s->rx_fifo);
73 stop_signal (int signum)
75 echo_main_t *em = &echo_main;
80 connect_to_vpp (char *name)
82 echo_main_t *em = &echo_main;
83 api_main_t *am = &api_main;
87 if (vl_socket_client_connect ((char *) em->socket_name, name,
88 0 /* default rx, tx buffer */ ))
90 ECHO_FAIL (ECHO_FAIL_SOCKET_CONNECT, "socket connect failed");
94 if (vl_socket_client_init_shm (0, 1 /* want_pthread */ ))
96 ECHO_FAIL (ECHO_FAIL_INIT_SHM_API, "init shm api failed");
102 if (vl_client_connect_to_vlib ("/vpe-api", name, 32) < 0)
104 ECHO_FAIL (ECHO_FAIL_SHMEM_CONNECT, "shmem connect failed");
108 em->vl_input_queue = am->shmem_hdr->vl_input_queue;
109 em->my_client_index = am->my_client_index;
114 print_global_json_stats (echo_main_t * em)
117 format (0, "%U", echo_format_timing_event, em->timing.start_event);
119 format (0, "%U", echo_format_timing_event, em->timing.end_event);
120 u8 start_evt_missing = !(em->timing.events_sent & em->timing.start_event);
121 u8 end_evt_missing = !(em->timing.events_sent & em->timing.end_event);
122 f64 deltat = start_evt_missing || end_evt_missing ? 0 :
123 em->timing.end_time - em->timing.start_time;
125 if (start_evt_missing)
126 ECHO_FAIL (ECHO_FAIL_MISSING_START_EVENT,
127 "Expected event %v to happen, but it did not!", start_evt);
130 ECHO_FAIL (ECHO_FAIL_MISSING_END_EVENT,
131 "Expected event %v to happen, but it did not!", end_evt);
133 fformat (stdout, "vpp_echo JSON stats:\n{\n");
134 fformat (stdout, " \"role\": \"%s\",\n",
135 em->i_am_master ? "server" : "client");
136 fformat (stdout, " \"time\": \"%.9f\",\n", deltat);
137 fformat (stdout, " \"start_evt\": \"%v\",\n", start_evt);
138 fformat (stdout, " \"start_evt_missing\": \"%s\",\n",
139 start_evt_missing ? "True" : "False");
140 fformat (stdout, " \"end_evt\": \"%v\",\n", end_evt);
141 fformat (stdout, " \"end_evt_missing\": \"%s\",\n",
142 end_evt_missing ? "True" : "False");
143 fformat (stdout, " \"rx_data\": %lld,\n", em->stats.rx_total);
144 fformat (stdout, " \"tx_rx\": %lld,\n", em->stats.tx_total);
145 fformat (stdout, " \"closing\": {\n");
146 fformat (stdout, " \"reset\": { \"q\": %d, \"s\": %d },\n",
147 em->stats.reset_count.q, em->stats.reset_count.s);
148 fformat (stdout, " \"close\": { \"q\": %d, \"s\": %d },\n",
149 em->stats.close_count.q, em->stats.close_count.s);
150 fformat (stdout, " \"active\": { \"q\": %d, \"s\": %d },\n",
151 em->stats.active_count.q, em->stats.active_count.s);
152 fformat (stdout, " \"clean\": { \"q\": %d, \"s\": %d }\n",
153 em->stats.clean_count.q, em->stats.clean_count.s);
154 fformat (stdout, " }\n");
155 fformat (stdout, " \"results\": {\n");
156 fformat (stdout, " \"has_failed\": \"%d\"\n", em->has_failed);
157 fformat (stdout, " \"fail_descr\": \"%v\"\n", em->fail_descr);
158 fformat (stdout, " }\n");
159 fformat (stdout, "}\n");
161 vec_free (start_evt);
166 print_global_stats (echo_main_t * em)
169 format (0, "%U", echo_format_timing_event, em->timing.start_event);
171 format (0, "%U", echo_format_timing_event, em->timing.end_event);
172 u8 start_evt_missing = !(em->timing.events_sent & em->timing.start_event);
173 u8 end_evt_missing = !(em->timing.events_sent & em->timing.end_event);
174 f64 deltat = start_evt_missing || end_evt_missing ? 0 :
175 em->timing.end_time - em->timing.start_time;
177 if (start_evt_missing)
178 ECHO_FAIL (ECHO_FAIL_MISSING_START_EVENT,
179 "Expected event %v to happen, but it did not!", start_evt);
182 ECHO_FAIL (ECHO_FAIL_MISSING_END_EVENT,
183 "Expected event %v to happen, but it did not!", end_evt);
185 fformat (stdout, "Timing %v:%v\n", start_evt, end_evt);
186 if (start_evt_missing)
187 fformat (stdout, "Missing Start Timing Event (%v)!\n", start_evt);
189 fformat (stdout, "Missing End Timing Event (%v)!\n", end_evt);
190 fformat (stdout, "-------- TX --------\n");
191 fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
192 em->stats.tx_total, em->stats.tx_total / (1ULL << 20),
193 em->stats.tx_total / (1ULL << 30), deltat);
195 fformat (stdout, "%.4f Gbit/second\n",
196 (em->stats.tx_total * 8.0) / deltat / 1e9);
197 fformat (stdout, "-------- RX --------\n");
198 fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
199 em->stats.rx_total, em->stats.rx_total / (1ULL << 20),
200 em->stats.rx_total / (1ULL << 30), deltat);
202 fformat (stdout, "%.4f Gbit/second\n",
203 (em->stats.rx_total * 8.0) / deltat / 1e9);
204 fformat (stdout, "--------------------\n");
205 fformat (stdout, "Received close on %d streams (and %d Quic conn)\n",
206 em->stats.close_count.s, em->stats.close_count.q);
207 fformat (stdout, "Received reset on %d streams (and %d Quic conn)\n",
208 em->stats.reset_count.s, em->stats.reset_count.q);
209 fformat (stdout, "Sent close on %d streams (and %d Quic conn)\n",
210 em->stats.active_count.s, em->stats.active_count.q);
211 fformat (stdout, "Discarded %d streams (and %d Quic conn)\n",
212 em->stats.clean_count.s, em->stats.clean_count.q);
214 fformat (stdout, "\nFailure Return Status: %d\n%v", em->has_failed,
216 vec_free (start_evt);
221 echo_update_count_on_session_close (echo_main_t * em, echo_session_t * s)
224 ECHO_LOG (1, "[%lu/%lu] -> S(%x) -> [%lu/%lu]",
225 s->bytes_received, s->bytes_received + s->bytes_to_receive,
226 s->session_index, s->bytes_sent,
227 s->bytes_sent + s->bytes_to_send);
228 clib_atomic_fetch_add (&em->stats.tx_total, s->bytes_sent);
229 clib_atomic_fetch_add (&em->stats.rx_total, s->bytes_received);
231 if (PREDICT_FALSE (em->stats.rx_total ==
232 em->n_clients * em->bytes_to_receive))
233 echo_notify_event (em, ECHO_EVT_LAST_BYTE);
237 echo_free_sessions (echo_main_t * em)
239 /* Free marked sessions */
241 u32 *session_indexes = 0, *session_index;
244 pool_foreach (s, em->sessions,
246 if (s->session_state == ECHO_SESSION_STATE_CLOSED)
247 vec_add1 (session_indexes, s->session_index);}
250 vec_foreach (session_index, session_indexes)
253 s = pool_elt_at_index (em->sessions, *session_index);
254 echo_session_handle_add_del (em, s->vpp_session_handle,
255 SESSION_INVALID_INDEX);
256 clib_memset (s, 0xfe, sizeof (*s));
257 pool_put (em->sessions, s);
262 test_recv_bytes (echo_main_t * em, echo_session_t * s, u8 * rx_buf,
267 for (i = 0; i < n_read; i++)
269 expected = (s->bytes_received + i) & 0xff;
270 if (rx_buf[i] == expected || em->max_test_msg > 0)
272 ECHO_LOG (0, "Session 0x%lx byte %lld was 0x%x expected 0x%x",
273 s->vpp_session_handle, s->bytes_received + i, rx_buf[i],
276 if (em->max_test_msg == 0)
277 ECHO_LOG (0, "Too many errors, hiding next ones");
278 if (em->test_return_packets == RETURN_PACKETS_ASSERT)
279 ECHO_FAIL (ECHO_FAIL_TEST_BYTES_ERR, "test-bytes errored");
284 recv_data_chunk (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
287 n_read = app_recv ((app_session_t *) s, rx_buf, vec_len (rx_buf));
290 if (svm_fifo_needs_deq_ntf (s->rx_fifo, n_read))
291 echo_session_dequeue_notify (s);
293 if (em->test_return_packets)
294 test_recv_bytes (em, s, rx_buf, n_read);
296 s->bytes_received += n_read;
297 s->bytes_to_receive -= n_read;
302 send_data_chunk (echo_session_t * s, u8 * tx_buf, int offset, int len)
305 int bytes_this_chunk = clib_min (s->bytes_to_send, len - offset);
306 if (!bytes_this_chunk)
308 n_sent = app_send ((app_session_t *) s, tx_buf + offset,
309 bytes_this_chunk, SVM_Q_WAIT);
312 s->bytes_to_send -= n_sent;
313 s->bytes_sent += n_sent;
318 mirror_data_chunk (echo_main_t * em, echo_session_t * s, u8 * tx_buf, u64 len)
321 while (n_sent < len && !em->time_to_stop)
322 n_sent += send_data_chunk (s, tx_buf, n_sent, len);
327 echo_check_closed_listener (echo_main_t * em, echo_session_t * s)
330 /* if parent has died, terminate gracefully */
331 if (s->listener_index == SESSION_INVALID_INDEX)
333 ls = pool_elt_at_index (em->sessions, s->listener_index);
334 if (ls->session_state < ECHO_SESSION_STATE_CLOSING)
336 ECHO_LOG (2, "Session 0%lx died, close child 0x%lx", ls->vpp_session_handle,
337 s->vpp_session_handle);
338 echo_update_count_on_session_close (em, s);
339 em->proto_cb_vft->cleanup_cb (s, 1 /* parent_died */ );
343 * Rx/Tx polling thread per connection
346 echo_handle_data (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
348 int n_read, n_sent = 0;
350 n_read = recv_data_chunk (em, s, rx_buf);
351 if (em->data_source == ECHO_TEST_DATA_SOURCE)
352 n_sent = send_data_chunk (s, em->connect_test_data,
353 s->bytes_sent % em->tx_buf_size,
355 else if (em->data_source == ECHO_RX_DATA_SOURCE)
356 n_sent = mirror_data_chunk (em, s, rx_buf, n_read);
357 if (!s->bytes_to_send && !s->bytes_to_receive)
359 /* Session is done, need to close */
360 if (s->session_state == ECHO_SESSION_STATE_AWAIT_DATA)
361 s->session_state = ECHO_SESSION_STATE_CLOSING;
364 s->session_state = ECHO_SESSION_STATE_AWAIT_CLOSING;
365 if (em->send_stream_disconnects == ECHO_CLOSE_F_ACTIVE)
367 echo_send_rpc (em, echo_send_disconnect_session,
368 (void *) s->vpp_session_handle, 0);
369 clib_atomic_fetch_add (&em->stats.active_count.s, 1);
371 else if (em->send_stream_disconnects == ECHO_CLOSE_F_NONE)
373 s->session_state = ECHO_SESSION_STATE_CLOSING;
374 clib_atomic_fetch_add (&em->stats.clean_count.s, 1);
380 /* Check for idle clients */
383 if (n_sent || n_read)
385 else if (s->idle_cycles++ == 1e7)
388 ECHO_LOG (1, "Idle client TX:%dB RX:%dB", s->bytes_to_send,
389 s->bytes_to_receive);
390 ECHO_LOG (1, "Idle FIFOs TX:%dB RX:%dB",
391 svm_fifo_max_dequeue (s->tx_fifo),
392 svm_fifo_max_dequeue (s->rx_fifo));
393 ECHO_LOG (1, "Session 0x%lx state %u", s->vpp_session_handle,
400 echo_data_thread_fn (void *arg)
402 clib_mem_set_thread_index (); /* First thing to do in client thread */
403 echo_main_t *em = &echo_main;
404 u32 N = em->n_clients;
405 u32 n = (N + em->n_rx_threads - 1) / em->n_rx_threads;
409 ECHO_LOG (1, "Thread %u exiting, no sessions to care for", idx);
412 u32 thread_n_sessions = clib_min (n, N - n * idx);
415 u32 n_closed_sessions = 0;
419 vec_validate (rx_buf, em->rx_buf_size);
421 for (i = 0; !em->time_to_stop; i = (i + 1) % thread_n_sessions)
423 n_closed_sessions = i == 0 ? 0 : n_closed_sessions;
424 session_index = em->data_thread_args[n * idx + i];
425 if (session_index == SESSION_INVALID_INDEX)
427 s = pool_elt_at_index (em->sessions, session_index);
428 switch (s->session_state)
430 case ECHO_SESSION_STATE_READY:
431 case ECHO_SESSION_STATE_AWAIT_DATA:
432 echo_handle_data (em, s, rx_buf);
433 echo_check_closed_listener (em, s);
435 case ECHO_SESSION_STATE_AWAIT_CLOSING:
436 echo_check_closed_listener (em, s);
438 case ECHO_SESSION_STATE_CLOSING:
439 echo_update_count_on_session_close (em, s);
440 em->proto_cb_vft->cleanup_cb (s, 0 /* parent_died */ );
442 case ECHO_SESSION_STATE_CLOSED:
446 if (n_closed_sessions == thread_n_sessions)
453 session_unlisten_handler (session_unlisten_msg_t * mp)
455 echo_session_t *listen_session;
456 echo_main_t *em = &echo_main;
457 listen_session = pool_elt_at_index (em->sessions, em->listen_session_index);
458 em->proto_cb_vft->cleanup_cb (listen_session, 0 /* parent_died */ );
459 em->state = STATE_DISCONNECTED;
463 session_bound_handler (session_bound_msg_t * mp)
465 echo_main_t *em = &echo_main;
466 echo_session_t *listen_session;
469 ECHO_FAIL (ECHO_FAIL_BIND, "bind failed: %U", format_api_error,
470 clib_net_to_host_u32 (mp->retval));
473 ECHO_LOG (0, "listening on %U:%u", format_ip46_address, mp->lcl_ip,
474 mp->lcl_is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
475 clib_net_to_host_u16 (mp->lcl_port));
477 /* Allocate local session and set it up */
478 listen_session = echo_session_new (em);
479 listen_session->session_type = ECHO_SESSION_TYPE_LISTEN;
480 listen_session->vpp_session_handle = mp->handle;
481 echo_session_handle_add_del (em, mp->handle, listen_session->session_index);
482 em->state = STATE_LISTEN;
483 em->listen_session_index = listen_session->session_index;
484 if (em->proto_cb_vft->bound_uri_cb)
485 em->proto_cb_vft->bound_uri_cb (mp, listen_session);
489 session_accepted_handler (session_accepted_msg_t * mp)
491 app_session_evt_t _app_evt, *app_evt = &_app_evt;
492 session_accepted_reply_msg_t *rmp;
493 svm_fifo_t *rx_fifo, *tx_fifo;
494 echo_main_t *em = &echo_main;
495 echo_session_t *session, *ls;
496 /* Allocate local session and set it up */
497 session = echo_session_new (em);
499 if (wait_for_segment_allocation (mp->segment_handle))
501 ECHO_FAIL (ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC,
502 "accepted wait_for_segment_allocation errored");
506 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
507 rx_fifo->client_session_index = session->session_index;
508 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
509 tx_fifo->client_session_index = session->session_index;
511 session->rx_fifo = rx_fifo;
512 session->tx_fifo = tx_fifo;
514 /* session->transport needed by app_send_dgram */
515 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
516 sizeof (ip46_address_t));
517 session->transport.is_ip4 = mp->rmt.is_ip4;
518 session->transport.rmt_port = mp->rmt.port;
519 clib_memcpy_fast (&session->transport.lcl_ip, &em->uri_elts.ip,
520 sizeof (ip46_address_t));
521 session->transport.lcl_port = em->uri_elts.port;
523 session->vpp_session_handle = mp->handle;
524 session->start = clib_time_now (&em->clib_time);
525 session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
527 if (!(ls = echo_get_session_from_handle (em, mp->listener_handle)))
529 session->listener_index = ls->session_index;
531 /* Add it to lookup table */
532 ECHO_LOG (1, "Accepted session 0x%lx -> 0x%lx", mp->handle,
533 mp->listener_handle);
534 echo_session_handle_add_del (em, mp->handle, session->session_index);
536 app_alloc_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt,
537 SESSION_CTRL_EVT_ACCEPTED_REPLY);
538 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
539 rmp->handle = mp->handle;
540 rmp->context = mp->context;
541 app_send_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt);
542 em->proto_cb_vft->accepted_cb (mp, session);
546 session_connected_handler (session_connected_msg_t * mp)
548 echo_main_t *em = &echo_main;
549 echo_session_t *session;
550 u32 listener_index = htonl (mp->context);
551 svm_fifo_t *rx_fifo, *tx_fifo;
555 if (em->proto_cb_vft->connected_cb)
557 proto_cb_vft->connected_cb ((session_connected_bundled_msg_t *) mp,
558 listener_index, 1 /* is_failed */ );
562 session = echo_session_new (em);
563 if (wait_for_segment_allocation (mp->segment_handle))
565 ECHO_FAIL (ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC,
566 "connected wait_for_segment_allocation errored");
570 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
571 rx_fifo->client_session_index = session->session_index;
572 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
573 tx_fifo->client_session_index = session->session_index;
575 session->rx_fifo = rx_fifo;
576 session->tx_fifo = tx_fifo;
577 session->vpp_session_handle = mp->handle;
578 session->start = clib_time_now (&em->clib_time);
579 session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
581 session->listener_index = listener_index;
582 /* session->transport needed by app_send_dgram */
583 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
584 sizeof (ip46_address_t));
585 session->transport.is_ip4 = mp->lcl.is_ip4;
586 session->transport.lcl_port = mp->lcl.port;
587 clib_memcpy_fast (&session->transport.rmt_ip, &em->uri_elts.ip,
588 sizeof (ip46_address_t));
589 session->transport.rmt_port = em->uri_elts.port;
591 echo_session_handle_add_del (em, mp->handle, session->session_index);
592 em->proto_cb_vft->connected_cb ((session_connected_bundled_msg_t *) mp,
593 session->session_index, 0 /* is_failed */ );
598 * End of ECHO callback definitions
603 session_disconnected_handler (session_disconnected_msg_t * mp)
605 app_session_evt_t _app_evt, *app_evt = &_app_evt;
606 session_disconnected_reply_msg_t *rmp;
607 echo_main_t *em = &echo_main;
609 ECHO_LOG (1, "passive close session 0x%lx", mp->handle);
610 if (!(s = echo_get_session_from_handle (em, mp->handle)))
612 ECHO_FAIL (ECHO_FAIL_SESSION_DISCONNECT, "Session 0x%lx not found",
616 em->proto_cb_vft->disconnected_cb (mp, s);
618 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
619 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
620 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
622 rmp->handle = mp->handle;
623 rmp->context = mp->context;
624 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
628 session_reset_handler (session_reset_msg_t * mp)
630 app_session_evt_t _app_evt, *app_evt = &_app_evt;
631 echo_main_t *em = &echo_main;
632 session_reset_reply_msg_t *rmp;
633 echo_session_t *s = 0;
634 ECHO_LOG (1, "Reset session 0x%lx", mp->handle);
635 if (!(s = echo_get_session_from_handle (em, mp->handle)))
637 ECHO_FAIL (ECHO_FAIL_SESSION_RESET, "Session 0x%lx not found",
641 em->proto_cb_vft->reset_cb (mp, s);
643 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
644 SESSION_CTRL_EVT_RESET_REPLY);
645 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
647 rmp->handle = mp->handle;
648 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
652 handle_mq_event (session_event_t * e)
654 switch (e->event_type)
656 case SESSION_CTRL_EVT_BOUND:
657 return session_bound_handler ((session_bound_msg_t *) e->data);
658 case SESSION_CTRL_EVT_ACCEPTED:
659 return session_accepted_handler ((session_accepted_msg_t *) e->data);
660 case SESSION_CTRL_EVT_CONNECTED:
661 return session_connected_handler ((session_connected_msg_t *) e->data);
662 case SESSION_CTRL_EVT_DISCONNECTED:
663 return session_disconnected_handler ((session_disconnected_msg_t *)
665 case SESSION_CTRL_EVT_RESET:
666 return session_reset_handler ((session_reset_msg_t *) e->data);
667 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
668 return session_unlisten_handler ((session_unlisten_msg_t *) e->data);
669 case SESSION_IO_EVT_RX:
672 ECHO_LOG (0, "unhandled event %u", e->event_type);
677 echo_process_rpcs (echo_main_t * em)
681 svm_msg_q_t *mq = em->rpc_msq_queue;
683 while (em->state < STATE_DATA_DONE && !em->time_to_stop)
686 if (svm_msg_q_is_empty (mq) && svm_msg_q_timedwait (mq, 1))
688 svm_msg_q_unlock (mq);
691 svm_msg_q_sub_w_lock (mq, &msg);
692 rpc = svm_msg_q_msg_data (mq, &msg);
693 svm_msg_q_unlock (mq);
694 ((echo_rpc_t) rpc->fp) (rpc->arg, rpc->opaque);
695 svm_msg_q_free_msg (mq, &msg);
700 echo_mq_dequeue_batch (svm_msg_q_t * mq, svm_msg_q_msg_t * msg_vec,
703 svm_msg_q_msg_t *msg;
707 n_msgs = clib_min (svm_msg_q_size (mq), n_max_msg);
708 for (i = 0; i < n_msgs; i++)
710 vec_add2 (msg_vec, msg, 1);
711 svm_msg_q_sub_w_lock (mq, msg);
717 echo_mq_thread_fn (void *arg)
719 clib_mem_set_thread_index (); /* First thing to do in client thread */
720 svm_msg_q_msg_t *msg_vec = 0;
721 echo_main_t *em = &echo_main;
723 svm_msg_q_msg_t *msg;
727 vec_validate (msg_vec, em->evt_q_size);
728 vec_reset_length (msg_vec);
729 wait_for_state_change (em, STATE_ATTACHED, 0);
731 if (em->state < STATE_ATTACHED || !mq)
733 ECHO_FAIL (ECHO_FAIL_APP_ATTACH, "Application failed to attach");
737 while (em->state < STATE_DETACHED && !em->time_to_stop)
740 if (svm_msg_q_is_empty (mq) && svm_msg_q_timedwait (mq, 1))
742 svm_msg_q_unlock (mq);
745 echo_mq_dequeue_batch (mq, msg_vec, ~0);
746 svm_msg_q_unlock (mq);
748 for (i = 0; i < vec_len (msg_vec); i++)
750 msg = vec_elt_at_index (msg_vec, i);
751 e = svm_msg_q_msg_data (mq, msg);
753 svm_msg_q_free_msg (mq, msg); /* No lock, single thread dequeuing */
755 vec_reset_length (msg_vec);
762 clients_run (echo_main_t * em)
765 echo_notify_event (em, ECHO_EVT_FIRST_QCONNECT);
766 for (i = 0; i < em->n_connects; i++)
767 echo_send_connect (SESSION_INVALID_HANDLE, SESSION_INVALID_INDEX);
768 wait_for_state_change (em, STATE_READY, 0);
769 ECHO_LOG (1, "App is ready");
770 echo_process_rpcs (em);
774 server_run (echo_main_t * em)
777 echo_send_listen (em);
778 wait_for_state_change (em, STATE_READY, 0);
779 ECHO_LOG (1, "App is ready");
780 echo_process_rpcs (em);
782 ls = pool_elt_at_index (em->sessions, em->listen_session_index);
783 echo_send_unbind (em, ls);
784 if (wait_for_state_change (em, STATE_DISCONNECTED, TIMEOUT))
786 ECHO_FAIL (ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT,
787 "Timeout waiting for state disconnected");
793 print_usage_and_exit (void)
795 echo_main_t *em = &echo_main;
798 "Usage: vpp_echo [socket-name SOCKET] [client|server] [uri URI] [OPTIONS]\n"
799 "Generates traffic and assert correct teardown of the QUIC hoststack\n"
801 " socket-name PATH Specify the binary socket path to connect to VPP\n"
802 " use-svm-api Use SVM API to connect to VPP\n"
803 " test-bytes[:assert] Check data correctness when receiving (assert fails on first error)\n"
804 " fifo-size N Use N Kb fifos\n"
805 " mq-size N Use N event slots for vpp_echo <-> vpp events\n"
806 " rx-buf N[Kb|Mb|GB] Use N[Kb|Mb|GB] RX buffer\n"
807 " tx-buf N[Kb|Mb|GB] Use N[Kb|Mb|GB] TX test buffer\n"
808 " appns NAMESPACE Use the namespace NAMESPACE\n"
809 " all-scope all-scope option\n"
810 " local-scope local-scope option\n"
811 " global-scope global-scope option\n"
812 " secret SECRET set namespace secret\n"
813 " chroot prefix PATH Use PATH as memory root path\n"
814 " sclose=[Y|N|W] When a stream is done, pass[N] send[Y] or wait[W] for close\n"
816 " time START:END Time between evts START & END, events being :\n"
817 " start - Start of the app\n"
818 " qconnect - first Connection connect sent\n"
819 " qconnected - last Connection connected\n"
820 " sconnect - first Stream connect sent\n"
821 " sconnected - last Stream got connected\n"
822 " lastbyte - Last expected byte received\n"
823 " exit - Exiting of the app\n"
824 " json Output global stats in json\n"
825 " log=N Set the log level to [0: no output, 1:errors, 2:log]\n"
827 " nclients N Open N clients sending data\n"
828 " nthreads N Use N busy loop threads for data [in addition to main & msg queue]\n"
829 " TX=1337[Kb|Mb|GB] Send 1337 [K|M|G]bytes, use TX=RX to reflect the data\n"
830 " RX=1337[Kb|Mb|GB] Expect 1337 [K|M|G]bytes\n" "\n");
831 for (i = 0; i < TRANSPORT_N_PROTO; i++)
833 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
834 if (vft && vft->print_usage_cb)
835 vft->print_usage_cb ();
837 fprintf (stderr, "\nDefault configuration is :\n"
838 " server nclients 1/1 RX=64Kb TX=RX\n"
839 " client nclients 1/1 RX=64Kb TX=64Kb\n");
844 echo_process_each_proto_opts (unformat_input_t * a)
846 echo_main_t *em = &echo_main;
848 for (i = 0; i < TRANSPORT_N_PROTO; i++)
850 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
851 if (vft && vft->process_opts_cb)
852 if ((rv = vft->process_opts_cb (a)))
859 echo_set_each_proto_defaults_before_opts (echo_main_t * em)
862 for (i = 0; i < TRANSPORT_N_PROTO; i++)
864 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
865 if (vft && vft->set_defaults_before_opts_cb)
866 vft->set_defaults_before_opts_cb ();
871 echo_process_opts (int argc, char **argv)
873 echo_main_t *em = &echo_main;
874 unformat_input_t _argv, *a = &_argv;
880 unformat_init_command_line (a, argv);
881 while (unformat_check_input (a) != UNFORMAT_END_OF_INPUT)
883 if (echo_process_each_proto_opts (a))
885 else if (unformat (a, "chroot prefix %s", &chroot_prefix))
886 vl_set_memory_root_path ((char *) chroot_prefix);
887 else if (unformat (a, "uri %s", &uri))
888 em->uri = format (0, "%s%c", uri, 0);
889 else if (unformat (a, "server"))
891 else if (unformat (a, "client"))
893 else if (unformat (a, "test-bytes:assert"))
894 em->test_return_packets = RETURN_PACKETS_ASSERT;
895 else if (unformat (a, "test-bytes"))
896 em->test_return_packets = RETURN_PACKETS_LOG_WRONG;
897 else if (unformat (a, "socket-name %s", &em->socket_name))
899 else if (unformat (a, "use-svm-api"))
900 em->use_sock_api = 0;
901 else if (unformat (a, "fifo-size %d", &tmp))
902 em->fifo_size = tmp << 10;
903 else if (unformat (a, "prealloc-fifos %u", &em->prealloc_fifo_pairs))
905 else if (unformat (a, "rx-buf %U", unformat_data, &em->rx_buf_size))
907 else if (unformat (a, "tx-buf %U", unformat_data, &em->tx_buf_size))
909 else if (unformat (a, "mq-size %d", &em->evt_q_size))
911 else if (unformat (a, "nclients %d", &em->n_clients))
913 em->n_sessions = em->n_clients + 1;
914 em->n_connects = em->n_clients;
916 else if (unformat (a, "nthreads %d", &em->n_rx_threads))
920 (a, "crypto %U", echo_unformat_crypto_engine,
921 &em->crypto_ctx_engine))
923 else if (unformat (a, "appns %_%v%_", &em->appns_id))
925 else if (unformat (a, "all-scope"))
926 em->appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
927 | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
928 else if (unformat (a, "local-scope"))
929 em->appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
930 else if (unformat (a, "global-scope"))
931 em->appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
932 else if (unformat (a, "secret %lu", &em->appns_secret))
934 else if (unformat (a, "TX=RX"))
935 em->data_source = ECHO_RX_DATA_SOURCE;
936 else if (unformat (a, "TX=%U", unformat_data, &em->bytes_to_send))
938 else if (unformat (a, "RX=%U", unformat_data, &em->bytes_to_receive))
940 else if (unformat (a, "json"))
942 else if (unformat (a, "log=%d", &em->log_lvl))
944 else if (unformat (a, "sclose=%U",
945 echo_unformat_close, &em->send_stream_disconnects))
947 else if (unformat (a, "time %U:%U",
948 echo_unformat_timing_event, &em->timing.start_event,
949 echo_unformat_timing_event, &em->timing.end_event))
952 print_usage_and_exit ();
955 /* setting default for unset values
957 * bytes_to_send / bytes_to_receive & data_source */
958 if (em->bytes_to_receive == (u64) ~ 0)
959 em->bytes_to_receive = 64 << 10; /* default */
960 if (em->bytes_to_send == (u64) ~ 0)
961 em->bytes_to_send = 64 << 10; /* default */
962 else if (em->bytes_to_send == 0)
963 em->data_source = ECHO_NO_DATA_SOURCE;
965 em->data_source = ECHO_TEST_DATA_SOURCE;
967 if (em->data_source == ECHO_INVALID_DATA_SOURCE)
969 em->i_am_master ? ECHO_RX_DATA_SOURCE : ECHO_TEST_DATA_SOURCE;
970 if (em->data_source == ECHO_RX_DATA_SOURCE)
971 em->bytes_to_send = em->bytes_to_receive;
973 /* disconnect flags */
976 em->bytes_to_send == 0 ? ECHO_CLOSE_F_ACTIVE : ECHO_CLOSE_F_PASSIVE;
979 em->bytes_to_receive == 0 ? ECHO_CLOSE_F_PASSIVE : ECHO_CLOSE_F_ACTIVE;
980 if (em->send_stream_disconnects == ECHO_CLOSE_F_INVALID)
981 em->send_stream_disconnects = default_f_active;
985 echo_process_uri (echo_main_t * em)
987 unformat_input_t _input, *input = &_input;
989 unformat_init_string (input, (char *) em->uri, strlen ((char *) em->uri));
991 (input, "%U://%U/%d", unformat_transport_proto,
992 &em->uri_elts.transport_proto, unformat_ip4_address,
993 &em->uri_elts.ip.ip4, &port))
994 em->uri_elts.is_ip4 = 1;
997 (input, "%U://%U/%d", unformat_transport_proto,
998 &em->uri_elts.transport_proto, unformat_ip6_address,
999 &em->uri_elts.ip.ip6, &port))
1000 em->uri_elts.is_ip4 = 0;
1002 ECHO_FAIL (ECHO_FAIL_INVALID_URI, "Unable to process uri");
1003 em->uri_elts.port = clib_host_to_net_u16 (port);
1004 unformat_free (input);
1007 static void __clib_constructor
1010 /* init memory before proto register themselves */
1011 echo_main_t *em = &echo_main;
1012 clib_mem_init_thread_safe (0, 256 << 20);
1013 clib_memset (em, 0, sizeof (*em));
1017 main (int argc, char **argv)
1019 echo_main_t *em = &echo_main;
1020 fifo_segment_main_t *sm = &em->segment_main;
1023 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1024 u32 rpc_queue_size = 64 << 10;
1026 em->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
1027 clib_spinlock_init (&em->sid_vpp_handles_lock);
1028 em->shared_segment_handles = hash_create (0, sizeof (uword));
1029 clib_spinlock_init (&em->segment_handles_lock);
1030 em->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
1031 em->use_sock_api = 1;
1032 em->fifo_size = 64 << 10;
1033 em->prealloc_fifo_pairs = 16;
1037 em->max_test_msg = 50;
1038 em->time_to_stop = 0;
1039 em->i_am_master = 1;
1040 em->n_rx_threads = 4;
1041 em->evt_q_size = 256;
1042 em->test_return_packets = RETURN_PACKETS_NOTEST;
1043 em->timing.start_event = ECHO_EVT_FIRST_QCONNECT;
1044 em->timing.end_event = ECHO_EVT_LAST_BYTE;
1045 em->bytes_to_receive = ~0; /* defaulted when we know if server/client */
1046 em->bytes_to_send = ~0; /* defaulted when we know if server/client */
1047 em->rx_buf_size = 1 << 20;
1048 em->tx_buf_size = 1 << 20;
1049 em->data_source = ECHO_INVALID_DATA_SOURCE;
1050 em->uri = format (0, "%s%c", "tcp://0.0.0.0/1234", 0);
1051 em->crypto_ctx_engine = TLS_ENGINE_NONE;
1052 echo_set_each_proto_defaults_before_opts (em);
1053 echo_process_opts (argc, argv);
1054 echo_process_uri (em);
1055 em->proto_cb_vft = em->available_proto_cb_vft[em->uri_elts.transport_proto];
1056 if (!em->proto_cb_vft)
1058 ECHO_FAIL (ECHO_FAIL_PROTOCOL_NOT_SUPPORTED,
1059 "Protocol %U is not supported",
1060 format_transport_proto, em->uri_elts.transport_proto);
1063 if (em->proto_cb_vft->set_defaults_after_opts_cb)
1064 em->proto_cb_vft->set_defaults_after_opts_cb ();
1066 vec_validate (em->data_thread_handles, em->n_rx_threads);
1067 vec_validate (em->data_thread_args, em->n_clients);
1068 for (i = 0; i < em->n_clients; i++)
1069 em->data_thread_args[i] = SESSION_INVALID_INDEX;
1070 clib_time_init (&em->clib_time);
1071 init_error_string_table ();
1072 fifo_segment_main_init (sm, HIGH_SEGMENT_BASEVA, 20);
1073 vec_validate (em->connect_test_data, em->tx_buf_size);
1074 for (i = 0; i < em->tx_buf_size; i++)
1075 em->connect_test_data[i] = i & 0xff;
1078 svm_msg_q_ring_cfg_t rc[1] = {
1079 {rpc_queue_size, sizeof (echo_rpc_msg_t), 0},
1082 cfg->consumer_pid = getpid ();
1084 cfg->q_nitems = rpc_queue_size;
1085 cfg->ring_cfgs = rc;
1086 em->rpc_msq_queue = svm_msg_q_alloc (cfg);
1088 signal (SIGINT, stop_signal);
1089 signal (SIGQUIT, stop_signal);
1090 signal (SIGTERM, stop_signal);
1091 echo_api_hookup (em);
1093 app_name = em->i_am_master ? "echo_server" : "echo_client";
1094 if (connect_to_vpp (app_name))
1097 ECHO_FAIL (ECHO_FAIL_CONNECT_TO_VPP, "Couldn't connect to vpp");
1101 echo_session_prealloc (em);
1102 echo_notify_event (em, ECHO_EVT_START);
1104 echo_send_attach (em);
1105 if (wait_for_state_change (em, STATE_ATTACHED_NO_CERT, TIMEOUT))
1107 ECHO_FAIL (ECHO_FAIL_ATTACH_TO_VPP,
1108 "Couldn't attach to vpp, did you run <session enable> ?");
1112 if (em->crypto_ctx_engine == TLS_ENGINE_NONE)
1113 /* when no crypto engine specified, dont expect crypto ctx */
1114 em->state = STATE_ATTACHED;
1117 ECHO_LOG (1, "Adding crypto context %U", echo_format_crypto_engine,
1118 em->crypto_ctx_engine);
1119 echo_send_add_crypto_ctx (em);
1120 if (wait_for_state_change (em, STATE_ATTACHED, TIMEOUT))
1122 ECHO_FAIL (ECHO_FAIL_APP_ATTACH,
1123 "Couldn't add crypto context to vpp\n");
1128 if (pthread_create (&em->mq_thread_handle,
1129 NULL /*attr */ , echo_mq_thread_fn, 0))
1131 ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE, "pthread create errored");
1135 for (i = 0; i < em->n_rx_threads; i++)
1136 if (pthread_create (&em->data_thread_handles[i],
1137 NULL /*attr */ , echo_data_thread_fn, (void *) i))
1139 ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE,
1140 "pthread create errored (index %d)", i);
1143 if (em->i_am_master)
1147 echo_notify_event (em, ECHO_EVT_EXIT);
1148 echo_free_sessions (em);
1149 echo_assert_test_suceeded (em);
1150 echo_send_detach (em);
1151 if (wait_for_state_change (em, STATE_DETACHED, TIMEOUT))
1153 ECHO_FAIL (ECHO_FAIL_DETACH, "Couldn't detach from vpp");
1157 pthread_join (em->mq_thread_handle, (void **) &rv);
1160 ECHO_FAIL (ECHO_FAIL_MQ_PTHREAD, "mq pthread errored %d", rv);
1163 if (em->use_sock_api)
1164 vl_socket_client_disconnect ();
1166 vl_client_disconnect_from_vlib ();
1168 ECHO_LOG (0, "Test complete !\n");
1169 if (em->output_json)
1170 print_global_json_stats (em);
1172 print_global_stats (em);
1173 vec_free (em->fail_descr);
1174 exit (em->has_failed);
1178 * fd.io coding-style-patch-verification: ON
1181 * eval: (c-set-style "gnu")