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 if (em->rx_results_diff)
46 CHECK_DIFF (ECHO_FAIL_TEST_ASSERT_RX_TOTAL, em->stats.rx_expected,
47 em->stats.rx_total, "Invalid amount of data received");
49 CHECK_SAME (ECHO_FAIL_TEST_ASSERT_RX_TOTAL, em->stats.rx_expected,
50 em->stats.rx_total, "Invalid amount of data received");
52 if (em->tx_results_diff)
53 CHECK_DIFF (ECHO_FAIL_TEST_ASSERT_TX_TOTAL, em->stats.tx_expected,
54 em->stats.tx_total, "Invalid amount of data sent");
56 CHECK_SAME (ECHO_FAIL_TEST_ASSERT_TX_TOTAL, em->stats.tx_expected,
57 em->stats.tx_total, "Invalid amount of data sent");
59 clib_spinlock_lock (&em->sid_vpp_handles_lock);
60 CHECK_SAME (ECHO_FAIL_TEST_ASSERT_ALL_SESSIONS_CLOSED,
61 0, hash_elts (em->session_index_by_vpp_handles),
62 "Some sessions are still open");
63 clib_spinlock_unlock (&em->sid_vpp_handles_lock);
67 echo_session_dequeue_notify (echo_session_t * s)
70 if (!svm_fifo_set_event (s->rx_fifo))
73 app_send_io_evt_to_vpp (s->vpp_evt_q, s->rx_fifo->master_session_index,
74 SESSION_IO_EVT_RX, SVM_Q_WAIT)))
75 ECHO_FAIL (ECHO_FAIL_SEND_IO_EVT, "app_send_io_evt_to_vpp errored %d",
77 svm_fifo_clear_deq_ntf (s->rx_fifo);
81 stop_signal (int signum)
83 echo_main_t *em = &echo_main;
88 connect_to_vpp (char *name)
90 echo_main_t *em = &echo_main;
91 api_main_t *am = vlibapi_get_main ();
95 if (vl_socket_client_connect ((char *) em->socket_name, name,
96 0 /* default rx, tx buffer */ ))
98 ECHO_FAIL (ECHO_FAIL_SOCKET_CONNECT, "socket connect failed");
102 if (vl_socket_client_init_shm (0, 1 /* want_pthread */ ))
104 ECHO_FAIL (ECHO_FAIL_INIT_SHM_API, "init shm api failed");
110 if (vl_client_connect_to_vlib ("/vpe-api", name, 32) < 0)
112 ECHO_FAIL (ECHO_FAIL_SHMEM_CONNECT, "shmem connect failed");
116 em->vl_input_queue = am->shmem_hdr->vl_input_queue;
117 em->my_client_index = am->my_client_index;
122 print_global_json_stats (echo_main_t * em)
125 format (0, "%U", echo_format_timing_event, em->timing.start_event);
127 format (0, "%U", echo_format_timing_event, em->timing.end_event);
128 u8 start_evt_missing = !(em->timing.events_sent & em->timing.start_event);
129 u8 end_evt_missing = (em->rx_results_diff || em->tx_results_diff) ? 0 :
130 !(em->timing.events_sent & em->timing.end_event);
131 f64 deltat = start_evt_missing || end_evt_missing ? 0 :
132 em->timing.end_time - em->timing.start_time;
134 if (start_evt_missing)
135 ECHO_FAIL (ECHO_FAIL_MISSING_START_EVENT,
136 "Expected event %v to happen, but it did not!", start_evt);
139 ECHO_FAIL (ECHO_FAIL_MISSING_END_EVENT,
140 "Expected event %v to happen, but it did not!", end_evt);
142 fformat (stdout, "vpp_echo JSON stats:\n{\n");
143 fformat (stdout, " \"role\": \"%s\",\n",
144 em->i_am_master ? "server" : "client");
145 fformat (stdout, " \"time\": \"%.9f\",\n", deltat);
146 fformat (stdout, " \"start_evt\": \"%v\",\n", start_evt);
147 fformat (stdout, " \"start_evt_missing\": \"%s\",\n",
148 start_evt_missing ? "True" : "False");
149 fformat (stdout, " \"end_evt\": \"%v\",\n", end_evt);
150 fformat (stdout, " \"end_evt_missing\": \"%s\",\n",
151 end_evt_missing ? "True" : "False");
152 fformat (stdout, " \"rx_data\": %lld,\n", em->stats.rx_total);
153 fformat (stdout, " \"tx_rx\": %lld,\n", em->stats.tx_total);
154 fformat (stdout, " \"closing\": {\n");
155 fformat (stdout, " \"reset\": { \"q\": %d, \"s\": %d },\n",
156 em->stats.reset_count.q, em->stats.reset_count.s);
157 fformat (stdout, " \"recv evt\": { \"q\": %d, \"s\": %d },\n",
158 em->stats.close_count.q, em->stats.close_count.s);
159 fformat (stdout, " \"send evt\": { \"q\": %d, \"s\": %d },\n",
160 em->stats.active_count.q, em->stats.active_count.s);
161 fformat (stdout, " \"clean\": { \"q\": %d, \"s\": %d }\n",
162 em->stats.clean_count.q, em->stats.clean_count.s);
163 fformat (stdout, " \"accepted\": { \"q\": %d, \"s\": %d }\n",
164 em->stats.accepted_count.q, em->stats.accepted_count.s);
165 fformat (stdout, " \"connected\": { \"q\": %d, \"s\": %d }\n",
166 em->stats.connected_count.q, em->stats.connected_count.s);
167 fformat (stdout, " }\n");
168 fformat (stdout, " \"results\": {\n");
169 fformat (stdout, " \"has_failed\": \"%d\"\n", em->has_failed);
170 fformat (stdout, " \"fail_descr\": \"%v\"\n", em->fail_descr);
171 fformat (stdout, " }\n");
172 fformat (stdout, "}\n");
174 vec_free (start_evt);
179 print_global_stats (echo_main_t * em)
182 format (0, "%U", echo_format_timing_event, em->timing.start_event);
184 format (0, "%U", echo_format_timing_event, em->timing.end_event);
185 u8 start_evt_missing = !(em->timing.events_sent & em->timing.start_event);
186 u8 end_evt_missing = (em->rx_results_diff || em->tx_results_diff) ? 0 :
187 !(em->timing.events_sent & em->timing.end_event);
188 f64 deltat = start_evt_missing || end_evt_missing ? 0 :
189 em->timing.end_time - em->timing.start_time;
191 if (start_evt_missing)
192 ECHO_FAIL (ECHO_FAIL_MISSING_START_EVENT,
193 "Expected event %v to happen, but it did not!", start_evt);
196 ECHO_FAIL (ECHO_FAIL_MISSING_END_EVENT,
197 "Expected event %v to happen, but it did not!", end_evt);
199 fformat (stdout, "Timing %v:%v\n", start_evt, end_evt);
200 if (start_evt_missing)
201 fformat (stdout, "Missing Start Timing Event (%v)!\n", start_evt);
203 fformat (stdout, "Missing End Timing Event (%v)!\n", end_evt);
204 fformat (stdout, "-------- TX --------\n");
205 fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
206 em->stats.tx_total, em->stats.tx_total / (1ULL << 20),
207 em->stats.tx_total / (1ULL << 30), deltat);
209 fformat (stdout, "%.4f Gbit/second\n",
210 (em->stats.tx_total * 8.0) / deltat / 1e9);
211 fformat (stdout, "-------- RX --------\n");
212 fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
213 em->stats.rx_total, em->stats.rx_total / (1ULL << 20),
214 em->stats.rx_total / (1ULL << 30), deltat);
216 fformat (stdout, "%.4f Gbit/second\n",
217 (em->stats.rx_total * 8.0) / deltat / 1e9);
218 fformat (stdout, "--------------------\n");
219 fformat (stdout, "Received close on %d streams (and %d Quic conn)\n",
220 em->stats.close_count.s, em->stats.close_count.q);
221 fformat (stdout, "Received reset on %d streams (and %d Quic conn)\n",
222 em->stats.reset_count.s, em->stats.reset_count.q);
223 fformat (stdout, "Sent close on %d streams (and %d Quic conn)\n",
224 em->stats.active_count.s, em->stats.active_count.q);
225 fformat (stdout, "Discarded %d streams (and %d Quic conn)\n",
226 em->stats.clean_count.s, em->stats.clean_count.q);
227 fformat (stdout, "--------------------\n");
228 fformat (stdout, "Got accept on %d streams (and %d Quic conn)\n",
229 em->stats.accepted_count.s, em->stats.accepted_count.q);
230 fformat (stdout, "Got connected on %d streams (and %d Quic conn)\n",
231 em->stats.connected_count.s, em->stats.connected_count.q);
233 fformat (stdout, "\nFailure Return Status: %d\n%v", em->has_failed,
235 vec_free (start_evt);
240 echo_update_count_on_session_close (echo_main_t * em, echo_session_t * s)
243 ECHO_LOG (2, "[%lu/%lu] -> %U -> [%lu/%lu]",
244 s->bytes_received, s->bytes_received + s->bytes_to_receive,
245 echo_format_session, s, s->bytes_sent,
246 s->bytes_sent + s->bytes_to_send);
247 clib_atomic_fetch_add (&em->stats.tx_total, s->bytes_sent);
248 clib_atomic_fetch_add (&em->stats.rx_total, s->bytes_received);
250 if (PREDICT_FALSE (em->stats.rx_total == em->stats.rx_expected))
251 echo_notify_event (em, ECHO_EVT_LAST_BYTE);
255 echo_free_sessions (echo_main_t * em)
257 /* Free marked sessions */
259 u32 *session_indexes = 0, *session_index;
262 pool_foreach (s, em->sessions,
264 if (s->session_state == ECHO_SESSION_STATE_CLOSED)
265 vec_add1 (session_indexes, s->session_index);}
268 vec_foreach (session_index, session_indexes)
271 s = pool_elt_at_index (em->sessions, *session_index);
272 echo_session_handle_add_del (em, s->vpp_session_handle,
273 SESSION_INVALID_INDEX);
274 clib_memset (s, 0xfe, sizeof (*s));
275 pool_put (em->sessions, s);
280 test_recv_bytes (echo_main_t * em, echo_session_t * s, u8 * rx_buf,
285 for (i = 0; i < n_read; i++)
287 expected = (s->bytes_received + i) & 0xff;
288 if (rx_buf[i] == expected || em->max_test_msg > 0)
290 ECHO_LOG (1, "Session 0x%lx byte %lld was 0x%x expected 0x%x",
291 s->vpp_session_handle, s->bytes_received + i, rx_buf[i],
294 if (em->max_test_msg == 0)
295 ECHO_LOG (1, "Too many errors, hiding next ones");
296 if (em->test_return_packets == RETURN_PACKETS_ASSERT)
297 ECHO_FAIL (ECHO_FAIL_TEST_BYTES_ERR, "test-bytes errored");
302 recv_data_chunk (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
305 n_read = app_recv ((app_session_t *) s, rx_buf, vec_len (rx_buf));
308 if (svm_fifo_needs_deq_ntf (s->rx_fifo, n_read))
309 echo_session_dequeue_notify (s);
311 if (em->test_return_packets)
312 test_recv_bytes (em, s, rx_buf, n_read);
314 s->bytes_received += n_read;
315 s->bytes_to_receive -= n_read;
320 send_data_chunk (echo_session_t * s, u8 * tx_buf, int offset, int len)
323 int bytes_this_chunk = clib_min (s->bytes_to_send, len - offset);
324 if (!bytes_this_chunk)
326 n_sent = app_send ((app_session_t *) s, tx_buf + offset,
327 bytes_this_chunk, SVM_Q_WAIT);
330 s->bytes_to_send -= n_sent;
331 s->bytes_sent += n_sent;
336 mirror_data_chunk (echo_main_t * em, echo_session_t * s, u8 * tx_buf, u64 len)
339 while (n_sent < len && !em->time_to_stop)
340 n_sent += send_data_chunk (s, tx_buf, n_sent, len);
345 echo_check_closed_listener (echo_main_t * em, echo_session_t * s)
348 /* if parent has died, terminate gracefully */
349 if (s->listener_index == SESSION_INVALID_INDEX)
351 ECHO_LOG (3, "%U: listener_index == SESSION_INVALID_INDEX",
352 echo_format_session, s);
355 ls = pool_elt_at_index (em->sessions, s->listener_index);
356 if (ls->session_state < ECHO_SESSION_STATE_CLOSING)
358 ECHO_LOG (3, "%U: ls->session_state (%d) < "
359 "ECHO_SESSION_STATE_CLOSING (%d)",
360 echo_format_session, ls, ls->session_state,
361 ECHO_SESSION_STATE_CLOSING);
365 ECHO_LOG (3, "%U died, close child %U", echo_format_session, ls,
366 echo_format_session, s);
367 echo_update_count_on_session_close (em, s);
368 em->proto_cb_vft->cleanup_cb (s, 1 /* parent_died */ );
372 * Rx/Tx polling thread per connection
375 echo_handle_data (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
377 int n_read, n_sent = 0;
379 n_read = recv_data_chunk (em, s, rx_buf);
380 if ((em->data_source == ECHO_TEST_DATA_SOURCE) && s->bytes_to_send)
381 n_sent = send_data_chunk (s, em->connect_test_data,
382 s->bytes_sent % em->tx_buf_size,
384 else if (em->data_source == ECHO_RX_DATA_SOURCE)
385 n_sent = mirror_data_chunk (em, s, rx_buf, n_read);
386 if (!s->bytes_to_send && !s->bytes_to_receive)
388 /* Session is done, need to close */
389 if (s->session_state == ECHO_SESSION_STATE_AWAIT_DATA)
390 s->session_state = ECHO_SESSION_STATE_CLOSING;
393 s->session_state = ECHO_SESSION_STATE_AWAIT_CLOSING;
394 if (em->send_stream_disconnects == ECHO_CLOSE_F_ACTIVE)
396 echo_send_rpc (em, echo_send_disconnect_session,
397 (void *) s->vpp_session_handle, 0);
398 clib_atomic_fetch_add (&em->stats.active_count.s, 1);
400 else if (em->send_stream_disconnects == ECHO_CLOSE_F_NONE)
402 s->session_state = ECHO_SESSION_STATE_CLOSING;
403 clib_atomic_fetch_add (&em->stats.clean_count.s, 1);
406 ECHO_LOG (3, "%U: %U", echo_format_session, s,
407 echo_format_session_state, s->session_state);
411 /* Check for idle clients */
414 if (n_sent || n_read)
416 else if (s->idle_cycles++ == 1e7)
419 ECHO_LOG (2, "Idle client TX:%dB RX:%dB", s->bytes_to_send,
420 s->bytes_to_receive);
421 ECHO_LOG (2, "Idle FIFOs TX:%dB RX:%dB",
422 svm_fifo_max_dequeue (s->tx_fifo),
423 svm_fifo_max_dequeue (s->rx_fifo));
424 ECHO_LOG (2, "Session 0x%lx state %U", s->vpp_session_handle,
425 echo_format_session_state, s->session_state);
431 echo_data_thread_fn (void *arg)
433 clib_mem_set_thread_index (); /* First thing to do in client thread */
434 echo_main_t *em = &echo_main;
435 u32 N = em->n_clients;
436 u32 n = (N + em->n_rx_threads - 1) / em->n_rx_threads;
440 ECHO_LOG (2, "Thread %u exiting, no sessions to care for", idx);
443 u32 thread_n_sessions = clib_min (n, N - n * idx);
446 u32 n_closed_sessions = 0;
450 vec_validate (rx_buf, em->rx_buf_size);
452 for (i = 0; !em->time_to_stop; i = (i + 1) % thread_n_sessions)
454 n_closed_sessions = i == 0 ? 0 : n_closed_sessions;
455 session_index = em->data_thread_args[n * idx + i];
456 if (session_index == SESSION_INVALID_INDEX)
458 s = pool_elt_at_index (em->sessions, session_index);
459 switch (s->session_state)
461 case ECHO_SESSION_STATE_READY:
462 case ECHO_SESSION_STATE_AWAIT_DATA:
463 echo_handle_data (em, s, rx_buf);
464 echo_check_closed_listener (em, s);
466 case ECHO_SESSION_STATE_AWAIT_CLOSING:
467 ECHO_LOG (3, "%U: %U", echo_format_session, s,
468 echo_format_session_state, s->session_state);
469 echo_check_closed_listener (em, s);
471 case ECHO_SESSION_STATE_CLOSING:
472 ECHO_LOG (3, "%U: %U", echo_format_session, s,
473 echo_format_session_state, s->session_state);
474 echo_update_count_on_session_close (em, s);
475 em->proto_cb_vft->cleanup_cb (s, 0 /* parent_died */ );
477 case ECHO_SESSION_STATE_CLOSED:
478 ECHO_LOG (3, "%U: %U", echo_format_session, s,
479 echo_format_session_state, s->session_state);
483 if (n_closed_sessions == thread_n_sessions)
486 ECHO_LOG (2, "Mission accomplished!");
491 session_unlisten_handler (session_unlisten_msg_t * mp)
493 echo_session_t *listen_session;
494 echo_main_t *em = &echo_main;
495 listen_session = pool_elt_at_index (em->sessions, em->listen_session_index);
496 em->proto_cb_vft->cleanup_cb (listen_session, 0 /* parent_died */ );
497 listen_session->session_state = ECHO_SESSION_STATE_CLOSED;
498 em->state = STATE_DISCONNECTED;
502 session_bound_handler (session_bound_msg_t * mp)
504 echo_main_t *em = &echo_main;
505 echo_session_t *listen_session;
508 ECHO_FAIL (ECHO_FAIL_BIND, "bind failed: %U", format_api_error,
509 clib_net_to_host_u32 (mp->retval));
512 ECHO_LOG (1, "listening on %U:%u", format_ip46_address, mp->lcl_ip,
513 mp->lcl_is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
514 clib_net_to_host_u16 (mp->lcl_port));
516 /* Allocate local session and set it up */
517 listen_session = echo_session_new (em);
518 listen_session->session_type = ECHO_SESSION_TYPE_LISTEN;
519 listen_session->vpp_session_handle = mp->handle;
520 echo_session_handle_add_del (em, mp->handle, listen_session->session_index);
521 em->state = STATE_LISTEN;
522 em->listen_session_index = listen_session->session_index;
523 if (em->proto_cb_vft->bound_uri_cb)
524 em->proto_cb_vft->bound_uri_cb (mp, listen_session);
528 session_accepted_handler (session_accepted_msg_t * mp)
530 app_session_evt_t _app_evt, *app_evt = &_app_evt;
531 session_accepted_reply_msg_t *rmp;
532 svm_fifo_t *rx_fifo, *tx_fifo;
533 echo_main_t *em = &echo_main;
534 echo_session_t *session, *ls;
536 if (!(ls = echo_get_session_from_handle (em, mp->listener_handle)))
538 ECHO_FAIL (ECHO_FAIL_SESSION_ACCEPTED_BAD_LISTENER,
539 "Unknown listener handle 0x%lx", mp->listener_handle);
542 if (wait_for_segment_allocation (mp->segment_handle))
544 ECHO_FAIL (ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC,
545 "accepted wait_for_segment_allocation errored");
549 /* Allocate local session and set it up */
550 session = echo_session_new (em);
551 session->vpp_session_handle = mp->handle;
553 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
554 rx_fifo->client_session_index = session->session_index;
555 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
556 tx_fifo->client_session_index = session->session_index;
558 session->rx_fifo = rx_fifo;
559 session->tx_fifo = tx_fifo;
561 /* session->transport needed by app_send_dgram */
562 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
563 sizeof (ip46_address_t));
564 session->transport.is_ip4 = mp->rmt.is_ip4;
565 session->transport.rmt_port = mp->rmt.port;
566 clib_memcpy_fast (&session->transport.lcl_ip, &em->uri_elts.ip,
567 sizeof (ip46_address_t));
568 session->transport.lcl_port = em->uri_elts.port;
570 session->vpp_session_handle = mp->handle;
571 session->start = clib_time_now (&em->clib_time);
572 session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
574 session->listener_index = ls->session_index;
576 /* Add it to lookup table */
577 ECHO_LOG (2, "Accepted session 0x%lx S[%u] -> 0x%lx S[%u]",
578 mp->handle, session->session_index,
579 mp->listener_handle, session->listener_index);
580 echo_session_handle_add_del (em, mp->handle, session->session_index);
582 app_alloc_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt,
583 SESSION_CTRL_EVT_ACCEPTED_REPLY);
584 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
585 rmp->handle = mp->handle;
586 rmp->context = mp->context;
587 app_send_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt);
588 em->proto_cb_vft->accepted_cb (mp, session);
592 session_connected_handler (session_connected_msg_t * mp)
594 echo_main_t *em = &echo_main;
595 echo_session_t *session;
596 u32 listener_index = htonl (mp->context);
597 svm_fifo_t *rx_fifo, *tx_fifo;
599 clib_atomic_add_fetch (&em->max_sim_connects, 1);
603 if (em->proto_cb_vft->connected_cb)
605 proto_cb_vft->connected_cb ((session_connected_bundled_msg_t *) mp,
606 listener_index, 1 /* is_failed */ );
610 session = echo_session_new (em);
611 if (wait_for_segment_allocation (mp->segment_handle))
613 ECHO_FAIL (ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC,
614 "connected wait_for_segment_allocation errored");
618 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
619 rx_fifo->client_session_index = session->session_index;
620 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
621 tx_fifo->client_session_index = session->session_index;
623 session->rx_fifo = rx_fifo;
624 session->tx_fifo = tx_fifo;
625 session->vpp_session_handle = mp->handle;
626 session->start = clib_time_now (&em->clib_time);
627 session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
629 session->listener_index = listener_index;
630 /* session->transport needed by app_send_dgram */
631 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
632 sizeof (ip46_address_t));
633 session->transport.is_ip4 = mp->lcl.is_ip4;
634 session->transport.lcl_port = mp->lcl.port;
635 clib_memcpy_fast (&session->transport.rmt_ip, &em->uri_elts.ip,
636 sizeof (ip46_address_t));
637 session->transport.rmt_port = em->uri_elts.port;
639 echo_session_handle_add_del (em, mp->handle, session->session_index);
640 em->proto_cb_vft->connected_cb ((session_connected_bundled_msg_t *) mp,
641 session->session_index, 0 /* is_failed */ );
646 * End of ECHO callback definitions
651 session_disconnected_handler (session_disconnected_msg_t * mp)
653 app_session_evt_t _app_evt, *app_evt = &_app_evt;
654 session_disconnected_reply_msg_t *rmp;
655 echo_main_t *em = &echo_main;
657 if (!(s = echo_get_session_from_handle (em, mp->handle)))
659 ECHO_LOG (1, "Invalid vpp_session_handle: 0x%lx", mp->handle);
662 if (s->session_state == ECHO_SESSION_STATE_CLOSED)
664 ECHO_LOG (2, "%U: already in ECHO_SESSION_STATE_CLOSED",
665 echo_format_session, s);
669 ECHO_LOG (2, "%U: passive close", echo_format_session, s);
670 em->proto_cb_vft->disconnected_cb (mp, s);
672 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
673 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
674 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
676 rmp->handle = mp->handle;
677 rmp->context = mp->context;
678 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
682 session_reset_handler (session_reset_msg_t * mp)
684 app_session_evt_t _app_evt, *app_evt = &_app_evt;
685 echo_main_t *em = &echo_main;
686 session_reset_reply_msg_t *rmp;
687 echo_session_t *s = 0;
688 if (!(s = echo_get_session_from_handle (em, mp->handle)))
690 ECHO_LOG (1, "Invalid vpp_session_handle: 0x%lx", mp->handle);
693 ECHO_LOG (2, "%U: session reset", echo_format_session, s);
694 em->proto_cb_vft->reset_cb (mp, s);
696 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
697 SESSION_CTRL_EVT_RESET_REPLY);
698 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
700 rmp->handle = mp->handle;
701 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
705 handle_mq_event (session_event_t * e)
707 switch (e->event_type)
709 case SESSION_CTRL_EVT_BOUND:
710 return session_bound_handler ((session_bound_msg_t *) e->data);
711 case SESSION_CTRL_EVT_ACCEPTED:
712 return session_accepted_handler ((session_accepted_msg_t *) e->data);
713 case SESSION_CTRL_EVT_CONNECTED:
714 return session_connected_handler ((session_connected_msg_t *) e->data);
715 case SESSION_CTRL_EVT_DISCONNECTED:
716 return session_disconnected_handler ((session_disconnected_msg_t *)
718 case SESSION_CTRL_EVT_RESET:
719 return session_reset_handler ((session_reset_msg_t *) e->data);
720 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
721 return session_unlisten_handler ((session_unlisten_msg_t *) e->data);
722 case SESSION_IO_EVT_RX:
725 ECHO_LOG (1, "unhandled event %u", e->event_type);
730 echo_process_rpcs (echo_main_t * em)
734 svm_msg_q_t *mq = em->rpc_msq_queue;
736 while (em->state < STATE_DATA_DONE && !em->time_to_stop)
739 if (svm_msg_q_is_empty (mq) && svm_msg_q_timedwait (mq, 1))
741 svm_msg_q_unlock (mq);
744 svm_msg_q_sub_w_lock (mq, &msg);
745 rpc = svm_msg_q_msg_data (mq, &msg);
746 svm_msg_q_unlock (mq);
747 ((echo_rpc_t) rpc->fp) (rpc->arg, rpc->opaque);
748 svm_msg_q_free_msg (mq, &msg);
753 echo_mq_thread_fn (void *arg)
755 clib_mem_set_thread_index (); /* First thing to do in client thread */
756 svm_msg_q_msg_t *msg_vec = 0;
757 echo_main_t *em = &echo_main;
759 svm_msg_q_msg_t *msg;
763 vec_validate (msg_vec, em->evt_q_size);
764 vec_reset_length (msg_vec);
765 wait_for_state_change (em, STATE_ATTACHED, 0);
767 if (em->state < STATE_ATTACHED || !mq)
769 ECHO_FAIL (ECHO_FAIL_APP_ATTACH, "Application failed to attach");
773 while (em->state < STATE_DETACHED && !em->time_to_stop)
776 if (svm_msg_q_is_empty (mq) && svm_msg_q_timedwait (mq, 1))
778 svm_msg_q_unlock (mq);
781 for (i = 0; i < svm_msg_q_size (mq); i++)
783 vec_add2 (msg_vec, msg, 1);
784 svm_msg_q_sub_w_lock (mq, msg);
786 svm_msg_q_unlock (mq);
788 for (i = 0; i < vec_len (msg_vec); i++)
790 msg = vec_elt_at_index (msg_vec, i);
791 e = svm_msg_q_msg_data (mq, msg);
793 svm_msg_q_free_msg (mq, msg); /* No lock, single thread dequeuing */
795 vec_reset_length (msg_vec);
802 clients_run (echo_main_t * em)
805 echo_notify_event (em, ECHO_EVT_FIRST_QCONNECT);
806 for (i = 0; i < em->n_connects; i++)
807 echo_send_connect (SESSION_INVALID_HANDLE, SESSION_INVALID_INDEX);
808 wait_for_state_change (em, STATE_READY, 0);
809 ECHO_LOG (2, "App is ready");
810 echo_process_rpcs (em);
814 server_run (echo_main_t * em)
817 echo_send_listen (em);
818 wait_for_state_change (em, STATE_READY, 0);
819 ECHO_LOG (2, "App is ready");
820 echo_process_rpcs (em);
822 ECHO_LOG (2, "Unbind listen port");
823 ls = pool_elt_at_index (em->sessions, em->listen_session_index);
824 echo_send_unbind (em, ls);
825 if (wait_for_state_change (em, STATE_DISCONNECTED, TIMEOUT))
827 ECHO_FAIL (ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT,
828 "Timeout waiting for state disconnected");
834 print_usage_and_exit (void)
836 echo_main_t *em = &echo_main;
839 "Usage: vpp_echo [socket-name SOCKET] [client|server] [uri URI] [OPTIONS]\n"
840 "Generates traffic and assert correct teardown of the hoststack\n"
842 " socket-name PATH Specify the binary socket path to connect to VPP\n"
843 " use-svm-api Use SVM API to connect to VPP\n"
844 " test-bytes[:assert] Check data correctness when receiving (assert fails on first error)\n"
845 " fifo-size N[K|M|G] Use N[K|M|G] fifos\n"
846 " mq-size N Use mq with N slots for [vpp_echo->vpp] communication\n"
847 " max-sim-connects N Do not allow more than N mq events inflight\n"
848 " rx-buf N[K|M|G] Use N[Kb|Mb|GB] RX buffer\n"
849 " tx-buf N[K|M|G] Use N[Kb|Mb|GB] TX test buffer\n"
850 " appns NAMESPACE Use the namespace NAMESPACE\n"
851 " all-scope all-scope option\n"
852 " local-scope local-scope option\n"
853 " global-scope global-scope option\n"
854 " secret SECRET set namespace secret\n"
855 " chroot prefix PATH Use PATH as memory root path\n"
856 " sclose=[Y|N|W] When stream is done, send[Y]|nop[N]|wait[W] for close\n"
858 " time START:END Time between evts START & END, events being :\n"
859 " start - Start of the app\n"
860 " qconnect - first Connection connect sent\n"
861 " qconnected - last Connection connected\n"
862 " sconnect - first Stream connect sent\n"
863 " sconnected - last Stream got connected\n"
864 " lastbyte - Last expected byte received\n"
865 " exit - Exiting of the app\n"
866 " rx-results-diff Rx results different to pass test\n"
867 " tx-results-diff Tx results different to pass test\n"
868 " json Output global stats in json\n"
869 " log=N Set the log level to [0: no output, 1:errors, 2:log]\n"
870 " crypto [engine] Set the crypto engine [openssl, vpp, picotls, mbedtls]\n"
872 " nclients N Open N clients sending data\n"
873 " nthreads N Use N busy loop threads for data [in addition to main & msg queue]\n"
874 " TX=1337[K|M|G]|RX Send 1337 [K|M|G]bytes, use TX=RX to reflect the data\n"
875 " RX=1337[K|M|G] Expect 1337 [K|M|G]bytes\n" "\n");
876 for (i = 0; i < TRANSPORT_N_PROTO; i++)
878 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
879 if (vft && vft->print_usage_cb)
880 vft->print_usage_cb ();
882 fprintf (stderr, "\nDefault configuration is :\n"
883 " server nclients 1 [quic-streams 1] RX=64Kb TX=RX\n"
884 " client nclients 1 [quic-streams 1] RX=64Kb TX=64Kb\n");
885 exit (ECHO_FAIL_USAGE);
889 echo_process_each_proto_opts (unformat_input_t * a)
891 echo_main_t *em = &echo_main;
893 for (i = 0; i < TRANSPORT_N_PROTO; i++)
895 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
896 if (vft && vft->process_opts_cb)
897 if ((rv = vft->process_opts_cb (a)))
904 echo_set_each_proto_defaults_before_opts (echo_main_t * em)
907 for (i = 0; i < TRANSPORT_N_PROTO; i++)
909 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
910 if (vft && vft->set_defaults_before_opts_cb)
911 vft->set_defaults_before_opts_cb ();
916 echo_process_opts (int argc, char **argv)
918 echo_main_t *em = &echo_main;
919 unformat_input_t _argv, *a = &_argv;
925 unformat_init_command_line (a, argv);
926 while (unformat_check_input (a) != UNFORMAT_END_OF_INPUT)
928 if (echo_process_each_proto_opts (a))
930 else if (unformat (a, "chroot prefix %s", &chroot_prefix))
931 vl_set_memory_root_path ((char *) chroot_prefix);
932 else if (unformat (a, "uri %s", &uri))
933 em->uri = format (0, "%s%c", uri, 0);
934 else if (unformat (a, "server"))
936 else if (unformat (a, "client"))
938 else if (unformat (a, "test-bytes:assert"))
939 em->test_return_packets = RETURN_PACKETS_ASSERT;
940 else if (unformat (a, "test-bytes"))
941 em->test_return_packets = RETURN_PACKETS_LOG_WRONG;
942 else if (unformat (a, "socket-name %s", &em->socket_name))
944 else if (unformat (a, "use-svm-api"))
945 em->use_sock_api = 0;
946 else if (unformat (a, "fifo-size %U", unformat_memory_size, &tmp))
948 if (tmp >= 0x100000000ULL)
951 "ERROR: fifo-size %ld (0x%lx) too large\n", tmp, tmp);
952 print_usage_and_exit ();
956 else if (unformat (a, "prealloc-fifos %u", &em->prealloc_fifo_pairs))
959 if (unformat (a, "rx-buf %U", unformat_data_size, &em->rx_buf_size))
962 if (unformat (a, "tx-buf %U", unformat_data_size, &em->tx_buf_size))
964 else if (unformat (a, "mq-size %d", &em->evt_q_size))
966 else if (unformat (a, "nclients %d", &em->n_clients))
968 em->n_sessions = em->n_clients + 1;
969 em->n_connects = em->n_clients;
971 else if (unformat (a, "nthreads %d", &em->n_rx_threads))
973 else if (unformat (a, "crypto %U", echo_unformat_crypto_engine, &tmp))
974 em->crypto_engine = tmp;
975 else if (unformat (a, "appns %_%v%_", &em->appns_id))
977 else if (unformat (a, "all-scope"))
978 em->appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
979 | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
980 else if (unformat (a, "local-scope"))
981 em->appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
982 else if (unformat (a, "global-scope"))
983 em->appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
984 else if (unformat (a, "secret %lu", &em->appns_secret))
986 else if (unformat (a, "TX=RX"))
987 em->data_source = ECHO_RX_DATA_SOURCE;
988 else if (unformat (a, "TX=%U", unformat_data_size, &em->bytes_to_send))
990 else if (unformat (a, "RX=%U", unformat_data_size,
991 &em->bytes_to_receive))
993 else if (unformat (a, "rx-results-diff"))
994 em->rx_results_diff = 1;
995 else if (unformat (a, "tx-results-diff"))
996 em->tx_results_diff = 1;
997 else if (unformat (a, "json"))
999 else if (unformat (a, "wait-for-gdb"))
1000 em->wait_for_gdb = 1;
1001 else if (unformat (a, "log=%d", &em->log_lvl))
1003 else if (unformat (a, "sclose=%U",
1004 echo_unformat_close, &em->send_stream_disconnects))
1006 else if (unformat (a, "time %U:%U",
1007 echo_unformat_timing_event, &em->timing.start_event,
1008 echo_unformat_timing_event, &em->timing.end_event))
1010 else if (unformat (a, "max-sim-connects %d", &em->max_sim_connects))
1013 print_usage_and_exit ();
1016 /* setting default for unset values
1018 * bytes_to_send / bytes_to_receive & data_source */
1019 if (em->bytes_to_receive == (u64) ~ 0)
1020 em->bytes_to_receive = 64 << 10; /* default */
1021 if (em->bytes_to_send == (u64) ~ 0)
1022 em->bytes_to_send = 64 << 10; /* default */
1023 else if (em->bytes_to_send == 0)
1024 em->data_source = ECHO_NO_DATA_SOURCE;
1026 em->data_source = ECHO_TEST_DATA_SOURCE;
1028 if (em->data_source == ECHO_INVALID_DATA_SOURCE)
1030 em->i_am_master ? ECHO_RX_DATA_SOURCE : ECHO_TEST_DATA_SOURCE;
1031 if (em->data_source == ECHO_RX_DATA_SOURCE)
1032 em->bytes_to_send = em->bytes_to_receive;
1034 /* disconnect flags */
1035 if (em->i_am_master)
1037 em->bytes_to_send == 0 ? ECHO_CLOSE_F_ACTIVE : ECHO_CLOSE_F_PASSIVE;
1040 em->bytes_to_receive == 0 ? ECHO_CLOSE_F_PASSIVE : ECHO_CLOSE_F_ACTIVE;
1041 if (em->send_stream_disconnects == ECHO_CLOSE_F_INVALID)
1042 em->send_stream_disconnects = default_f_active;
1044 if (em->max_sim_connects == 0)
1045 em->max_sim_connects = em->evt_q_size >> 1;
1047 if (em->wait_for_gdb)
1049 volatile u64 nop = 0;
1051 clib_warning ("Waiting for gdb...");
1052 while (em->wait_for_gdb)
1054 clib_warning ("Resuming execution (%llu)!", nop);
1059 echo_process_uri (echo_main_t * em)
1061 unformat_input_t _input, *input = &_input;
1063 unformat_init_string (input, (char *) em->uri, strlen ((char *) em->uri));
1065 (input, "%U://%U/%d", unformat_transport_proto,
1066 &em->uri_elts.transport_proto, unformat_ip4_address,
1067 &em->uri_elts.ip.ip4, &port))
1068 em->uri_elts.is_ip4 = 1;
1071 (input, "%U://%U/%d", unformat_transport_proto,
1072 &em->uri_elts.transport_proto, unformat_ip6_address,
1073 &em->uri_elts.ip.ip6, &port))
1074 em->uri_elts.is_ip4 = 0;
1076 ECHO_FAIL (ECHO_FAIL_INVALID_URI, "Unable to process uri");
1077 em->uri_elts.port = clib_host_to_net_u16 (port);
1078 unformat_free (input);
1081 static void __clib_constructor
1084 /* init memory before proto register themselves */
1085 echo_main_t *em = &echo_main;
1086 clib_mem_init_thread_safe (0, 256 << 20);
1087 clib_memset (em, 0, sizeof (*em));
1091 main (int argc, char **argv)
1093 echo_main_t *em = &echo_main;
1094 fifo_segment_main_t *sm = &em->segment_main;
1097 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1098 u32 rpc_queue_size = 256 << 10;
1100 em->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
1101 clib_spinlock_init (&em->sid_vpp_handles_lock);
1102 em->shared_segment_handles = hash_create (0, sizeof (uword));
1103 clib_spinlock_init (&em->segment_handles_lock);
1104 em->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
1105 em->use_sock_api = 1;
1106 em->fifo_size = 64 << 10;
1107 em->prealloc_fifo_pairs = 16;
1111 em->max_test_msg = 50;
1112 em->time_to_stop = 0;
1113 em->i_am_master = 1;
1114 em->n_rx_threads = 4;
1115 em->evt_q_size = 256;
1116 em->test_return_packets = RETURN_PACKETS_NOTEST;
1117 em->timing.start_event = ECHO_EVT_FIRST_QCONNECT;
1118 em->timing.end_event = ECHO_EVT_LAST_BYTE;
1119 em->bytes_to_receive = ~0; /* defaulted when we know if server/client */
1120 em->bytes_to_send = ~0; /* defaulted when we know if server/client */
1121 em->rx_buf_size = 1 << 20;
1122 em->tx_buf_size = 1 << 20;
1123 em->data_source = ECHO_INVALID_DATA_SOURCE;
1124 em->uri = format (0, "%s%c", "tcp://0.0.0.0/1234", 0);
1125 em->max_sim_connects = 0;
1126 em->crypto_engine = CRYPTO_ENGINE_NONE;
1127 echo_set_each_proto_defaults_before_opts (em);
1128 echo_process_opts (argc, argv);
1129 echo_process_uri (em);
1130 em->proto_cb_vft = em->available_proto_cb_vft[em->uri_elts.transport_proto];
1131 if (!em->proto_cb_vft)
1133 ECHO_FAIL (ECHO_FAIL_PROTOCOL_NOT_SUPPORTED,
1134 "Protocol %U is not supported",
1135 format_transport_proto, em->uri_elts.transport_proto);
1138 if (em->proto_cb_vft->set_defaults_after_opts_cb)
1139 em->proto_cb_vft->set_defaults_after_opts_cb ();
1141 em->stats.rx_expected = em->bytes_to_receive * em->n_clients;
1142 em->stats.tx_expected = em->bytes_to_send * em->n_clients;
1144 vec_validate (em->data_thread_handles, em->n_rx_threads);
1145 vec_validate (em->data_thread_args, em->n_clients);
1146 for (i = 0; i < em->n_clients; i++)
1147 em->data_thread_args[i] = SESSION_INVALID_INDEX;
1148 clib_time_init (&em->clib_time);
1149 init_error_string_table ();
1150 fifo_segment_main_init (sm, HIGH_SEGMENT_BASEVA, 20);
1151 vec_validate (em->connect_test_data, em->tx_buf_size);
1152 for (i = 0; i < em->tx_buf_size; i++)
1153 em->connect_test_data[i] = i & 0xff;
1156 svm_msg_q_ring_cfg_t rc[1] = {
1157 {rpc_queue_size, sizeof (echo_rpc_msg_t), 0},
1160 cfg->consumer_pid = getpid ();
1162 cfg->q_nitems = rpc_queue_size;
1163 cfg->ring_cfgs = rc;
1164 em->rpc_msq_queue = svm_msg_q_alloc (cfg);
1166 signal (SIGINT, stop_signal);
1167 signal (SIGQUIT, stop_signal);
1168 signal (SIGTERM, stop_signal);
1169 echo_api_hookup (em);
1171 app_name = em->i_am_master ? "echo_server" : "echo_client";
1172 if (connect_to_vpp (app_name))
1175 ECHO_FAIL (ECHO_FAIL_CONNECT_TO_VPP, "Couldn't connect to vpp");
1179 echo_session_prealloc (em);
1180 echo_notify_event (em, ECHO_EVT_START);
1182 echo_send_attach (em);
1183 if (wait_for_state_change (em, STATE_ATTACHED_NO_CERT, TIMEOUT))
1185 ECHO_FAIL (ECHO_FAIL_ATTACH_TO_VPP,
1186 "Couldn't attach to vpp, did you run <session enable> ?");
1190 if (em->uri_elts.transport_proto != TRANSPORT_PROTO_QUIC
1191 && em->uri_elts.transport_proto != TRANSPORT_PROTO_TLS)
1192 em->state = STATE_ATTACHED;
1195 ECHO_LOG (2, "Adding crypto context %U", echo_format_crypto_engine,
1197 echo_send_add_cert_key (em);
1198 if (wait_for_state_change (em, STATE_ATTACHED, TIMEOUT))
1200 ECHO_FAIL (ECHO_FAIL_APP_ATTACH,
1201 "Couldn't add crypto context to vpp\n");
1206 if (pthread_create (&em->mq_thread_handle,
1207 NULL /*attr */ , echo_mq_thread_fn, 0))
1209 ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE, "pthread create errored");
1213 for (i = 0; i < em->n_rx_threads; i++)
1214 if (pthread_create (&em->data_thread_handles[i],
1215 NULL /*attr */ , echo_data_thread_fn, (void *) i))
1217 ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE,
1218 "pthread create errored (index %d)", i);
1221 if (em->i_am_master)
1225 echo_notify_event (em, ECHO_EVT_EXIT);
1226 echo_free_sessions (em);
1227 echo_send_del_cert_key (em);
1228 if (wait_for_state_change (em, STATE_CLEANED_CERT_KEY, TIMEOUT))
1230 ECHO_FAIL (ECHO_FAIL_DEL_CERT_KEY, "Couldn't cleanup cert and key");
1234 echo_send_detach (em);
1235 if (wait_for_state_change (em, STATE_DETACHED, TIMEOUT))
1237 ECHO_FAIL (ECHO_FAIL_DETACH, "Couldn't detach from vpp");
1241 pthread_join (em->mq_thread_handle, (void **) &rv);
1244 ECHO_FAIL (ECHO_FAIL_MQ_PTHREAD, "mq pthread errored %d", rv);
1247 if (em->use_sock_api)
1248 vl_socket_client_disconnect ();
1250 vl_client_disconnect_from_vlib ();
1251 echo_assert_test_suceeded (em);
1253 ECHO_LOG (1, "Test complete !\n");
1254 if (em->output_json)
1255 print_global_json_stats (em);
1257 print_global_stats (em);
1258 vec_free (em->fail_descr);
1259 exit (em->has_failed);
1263 * fd.io coding-style-patch-verification: ON
1266 * eval: (c-set-style "gnu")