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 = &api_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, " }\n");
164 fformat (stdout, " \"results\": {\n");
165 fformat (stdout, " \"has_failed\": \"%d\"\n", em->has_failed);
166 fformat (stdout, " \"fail_descr\": \"%v\"\n", em->fail_descr);
167 fformat (stdout, " }\n");
168 fformat (stdout, "}\n");
170 vec_free (start_evt);
175 print_global_stats (echo_main_t * em)
178 format (0, "%U", echo_format_timing_event, em->timing.start_event);
180 format (0, "%U", echo_format_timing_event, em->timing.end_event);
181 u8 start_evt_missing = !(em->timing.events_sent & em->timing.start_event);
182 u8 end_evt_missing = (em->rx_results_diff || em->tx_results_diff) ? 0 :
183 !(em->timing.events_sent & em->timing.end_event);
184 f64 deltat = start_evt_missing || end_evt_missing ? 0 :
185 em->timing.end_time - em->timing.start_time;
187 if (start_evt_missing)
188 ECHO_FAIL (ECHO_FAIL_MISSING_START_EVENT,
189 "Expected event %v to happen, but it did not!", start_evt);
192 ECHO_FAIL (ECHO_FAIL_MISSING_END_EVENT,
193 "Expected event %v to happen, but it did not!", end_evt);
195 fformat (stdout, "Timing %v:%v\n", start_evt, end_evt);
196 if (start_evt_missing)
197 fformat (stdout, "Missing Start Timing Event (%v)!\n", start_evt);
199 fformat (stdout, "Missing End Timing Event (%v)!\n", end_evt);
200 fformat (stdout, "-------- TX --------\n");
201 fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
202 em->stats.tx_total, em->stats.tx_total / (1ULL << 20),
203 em->stats.tx_total / (1ULL << 30), deltat);
205 fformat (stdout, "%.4f Gbit/second\n",
206 (em->stats.tx_total * 8.0) / deltat / 1e9);
207 fformat (stdout, "-------- RX --------\n");
208 fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
209 em->stats.rx_total, em->stats.rx_total / (1ULL << 20),
210 em->stats.rx_total / (1ULL << 30), deltat);
212 fformat (stdout, "%.4f Gbit/second\n",
213 (em->stats.rx_total * 8.0) / deltat / 1e9);
214 fformat (stdout, "--------------------\n");
215 fformat (stdout, "Received close on %d streams (and %d Quic conn)\n",
216 em->stats.close_count.s, em->stats.close_count.q);
217 fformat (stdout, "Received reset on %d streams (and %d Quic conn)\n",
218 em->stats.reset_count.s, em->stats.reset_count.q);
219 fformat (stdout, "Sent close on %d streams (and %d Quic conn)\n",
220 em->stats.active_count.s, em->stats.active_count.q);
221 fformat (stdout, "Discarded %d streams (and %d Quic conn)\n",
222 em->stats.clean_count.s, em->stats.clean_count.q);
224 fformat (stdout, "\nFailure Return Status: %d\n%v", em->has_failed,
226 vec_free (start_evt);
231 echo_update_count_on_session_close (echo_main_t * em, echo_session_t * s)
234 ECHO_LOG (1, "[%lu/%lu] -> %U -> [%lu/%lu]",
235 s->bytes_received, s->bytes_received + s->bytes_to_receive,
236 echo_format_session, s, s->bytes_sent,
237 s->bytes_sent + s->bytes_to_send);
238 clib_atomic_fetch_add (&em->stats.tx_total, s->bytes_sent);
239 clib_atomic_fetch_add (&em->stats.rx_total, s->bytes_received);
241 if (PREDICT_FALSE (em->stats.rx_total == em->stats.rx_expected))
242 echo_notify_event (em, ECHO_EVT_LAST_BYTE);
246 echo_free_sessions (echo_main_t * em)
248 /* Free marked sessions */
250 u32 *session_indexes = 0, *session_index;
253 pool_foreach (s, em->sessions,
255 if (s->session_state == ECHO_SESSION_STATE_CLOSED)
256 vec_add1 (session_indexes, s->session_index);}
259 vec_foreach (session_index, session_indexes)
262 s = pool_elt_at_index (em->sessions, *session_index);
263 echo_session_handle_add_del (em, s->vpp_session_handle,
264 SESSION_INVALID_INDEX);
265 clib_memset (s, 0xfe, sizeof (*s));
266 pool_put (em->sessions, s);
271 test_recv_bytes (echo_main_t * em, echo_session_t * s, u8 * rx_buf,
276 for (i = 0; i < n_read; i++)
278 expected = (s->bytes_received + i) & 0xff;
279 if (rx_buf[i] == expected || em->max_test_msg > 0)
281 ECHO_LOG (0, "Session 0x%lx byte %lld was 0x%x expected 0x%x",
282 s->vpp_session_handle, s->bytes_received + i, rx_buf[i],
285 if (em->max_test_msg == 0)
286 ECHO_LOG (0, "Too many errors, hiding next ones");
287 if (em->test_return_packets == RETURN_PACKETS_ASSERT)
288 ECHO_FAIL (ECHO_FAIL_TEST_BYTES_ERR, "test-bytes errored");
293 recv_data_chunk (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
296 n_read = app_recv ((app_session_t *) s, rx_buf, vec_len (rx_buf));
299 if (svm_fifo_needs_deq_ntf (s->rx_fifo, n_read))
300 echo_session_dequeue_notify (s);
302 if (em->test_return_packets)
303 test_recv_bytes (em, s, rx_buf, n_read);
305 s->bytes_received += n_read;
306 s->bytes_to_receive -= n_read;
311 send_data_chunk (echo_session_t * s, u8 * tx_buf, int offset, int len)
314 int bytes_this_chunk = clib_min (s->bytes_to_send, len - offset);
315 if (!bytes_this_chunk)
317 n_sent = app_send ((app_session_t *) s, tx_buf + offset,
318 bytes_this_chunk, SVM_Q_WAIT);
321 s->bytes_to_send -= n_sent;
322 s->bytes_sent += n_sent;
327 mirror_data_chunk (echo_main_t * em, echo_session_t * s, u8 * tx_buf, u64 len)
330 while (n_sent < len && !em->time_to_stop)
331 n_sent += send_data_chunk (s, tx_buf, n_sent, len);
336 echo_check_closed_listener (echo_main_t * em, echo_session_t * s)
339 /* if parent has died, terminate gracefully */
340 if (s->listener_index == SESSION_INVALID_INDEX)
342 ECHO_LOG (2, "%U: listener_index == SESSION_INVALID_INDEX",
343 echo_format_session, s);
346 ls = pool_elt_at_index (em->sessions, s->listener_index);
347 if (ls->session_state < ECHO_SESSION_STATE_CLOSING)
349 ECHO_LOG (3, "%U: ls->session_state (%d) < "
350 "ECHO_SESSION_STATE_CLOSING (%d)",
351 echo_format_session, ls, ls->session_state,
352 ECHO_SESSION_STATE_CLOSING);
356 ECHO_LOG (2, "%U died, close child %U", echo_format_session, ls,
357 echo_format_session, s);
358 echo_update_count_on_session_close (em, s);
359 em->proto_cb_vft->cleanup_cb (s, 1 /* parent_died */ );
363 * Rx/Tx polling thread per connection
366 echo_handle_data (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
368 int n_read, n_sent = 0;
370 n_read = recv_data_chunk (em, s, rx_buf);
371 if ((em->data_source == ECHO_TEST_DATA_SOURCE) && s->bytes_to_send)
372 n_sent = send_data_chunk (s, em->connect_test_data,
373 s->bytes_sent % em->tx_buf_size,
375 else if (em->data_source == ECHO_RX_DATA_SOURCE)
376 n_sent = mirror_data_chunk (em, s, rx_buf, n_read);
377 if (!s->bytes_to_send && !s->bytes_to_receive)
379 /* Session is done, need to close */
380 if (s->session_state == ECHO_SESSION_STATE_AWAIT_DATA)
381 s->session_state = ECHO_SESSION_STATE_CLOSING;
384 s->session_state = ECHO_SESSION_STATE_AWAIT_CLOSING;
385 if (em->send_stream_disconnects == ECHO_CLOSE_F_ACTIVE)
387 echo_send_rpc (em, echo_send_disconnect_session,
388 (void *) s->vpp_session_handle, 0);
389 clib_atomic_fetch_add (&em->stats.active_count.s, 1);
391 else if (em->send_stream_disconnects == ECHO_CLOSE_F_NONE)
393 s->session_state = ECHO_SESSION_STATE_CLOSING;
394 clib_atomic_fetch_add (&em->stats.clean_count.s, 1);
397 ECHO_LOG (2, "%U: %U", echo_format_session, s,
398 echo_format_session_state, s->session_state);
402 /* Check for idle clients */
405 if (n_sent || n_read)
407 else if (s->idle_cycles++ == 1e7)
410 ECHO_LOG (1, "Idle client TX:%dB RX:%dB", s->bytes_to_send,
411 s->bytes_to_receive);
412 ECHO_LOG (1, "Idle FIFOs TX:%dB RX:%dB",
413 svm_fifo_max_dequeue (s->tx_fifo),
414 svm_fifo_max_dequeue (s->rx_fifo));
415 ECHO_LOG (1, "Session 0x%lx state %U", s->vpp_session_handle,
416 echo_format_session_state, s->session_state);
422 echo_data_thread_fn (void *arg)
424 clib_mem_set_thread_index (); /* First thing to do in client thread */
425 echo_main_t *em = &echo_main;
426 u32 N = em->n_clients;
427 u32 n = (N + em->n_rx_threads - 1) / em->n_rx_threads;
431 ECHO_LOG (1, "Thread %u exiting, no sessions to care for", idx);
434 u32 thread_n_sessions = clib_min (n, N - n * idx);
437 u32 n_closed_sessions = 0;
441 vec_validate (rx_buf, em->rx_buf_size);
443 for (i = 0; !em->time_to_stop; i = (i + 1) % thread_n_sessions)
445 n_closed_sessions = i == 0 ? 0 : n_closed_sessions;
446 session_index = em->data_thread_args[n * idx + i];
447 if (session_index == SESSION_INVALID_INDEX)
449 s = pool_elt_at_index (em->sessions, session_index);
450 switch (s->session_state)
452 case ECHO_SESSION_STATE_READY:
453 case ECHO_SESSION_STATE_AWAIT_DATA:
454 echo_handle_data (em, s, rx_buf);
455 echo_check_closed_listener (em, s);
457 case ECHO_SESSION_STATE_AWAIT_CLOSING:
458 ECHO_LOG (3, "%U: %U", echo_format_session, s,
459 echo_format_session_state, s->session_state);
460 echo_check_closed_listener (em, s);
462 case ECHO_SESSION_STATE_CLOSING:
463 ECHO_LOG (2, "%U: %U", echo_format_session, s,
464 echo_format_session_state, s->session_state);
465 echo_update_count_on_session_close (em, s);
466 em->proto_cb_vft->cleanup_cb (s, 0 /* parent_died */ );
468 case ECHO_SESSION_STATE_CLOSED:
469 ECHO_LOG (2, "%U: %U", echo_format_session, s,
470 echo_format_session_state, s->session_state);
474 if (n_closed_sessions == thread_n_sessions)
477 ECHO_LOG (1, "Mission accomplished!");
482 session_unlisten_handler (session_unlisten_msg_t * mp)
484 echo_session_t *listen_session;
485 echo_main_t *em = &echo_main;
486 listen_session = pool_elt_at_index (em->sessions, em->listen_session_index);
487 em->proto_cb_vft->cleanup_cb (listen_session, 0 /* parent_died */ );
488 listen_session->session_state = ECHO_SESSION_STATE_CLOSED;
489 em->state = STATE_DISCONNECTED;
493 session_bound_handler (session_bound_msg_t * mp)
495 echo_main_t *em = &echo_main;
496 echo_session_t *listen_session;
499 ECHO_FAIL (ECHO_FAIL_BIND, "bind failed: %U", format_api_error,
500 clib_net_to_host_u32 (mp->retval));
503 ECHO_LOG (0, "listening on %U:%u", format_ip46_address, mp->lcl_ip,
504 mp->lcl_is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
505 clib_net_to_host_u16 (mp->lcl_port));
507 /* Allocate local session and set it up */
508 listen_session = echo_session_new (em);
509 listen_session->session_type = ECHO_SESSION_TYPE_LISTEN;
510 listen_session->vpp_session_handle = mp->handle;
511 echo_session_handle_add_del (em, mp->handle, listen_session->session_index);
512 em->state = STATE_LISTEN;
513 em->listen_session_index = listen_session->session_index;
514 if (em->proto_cb_vft->bound_uri_cb)
515 em->proto_cb_vft->bound_uri_cb (mp, listen_session);
519 session_accepted_handler (session_accepted_msg_t * mp)
521 app_session_evt_t _app_evt, *app_evt = &_app_evt;
522 session_accepted_reply_msg_t *rmp;
523 svm_fifo_t *rx_fifo, *tx_fifo;
524 echo_main_t *em = &echo_main;
525 echo_session_t *session, *ls;
527 if (!(ls = echo_get_session_from_handle (em, mp->listener_handle)))
529 ECHO_FAIL (ECHO_FAIL_SESSION_ACCEPTED_BAD_LISTENER,
530 "Unknown listener handle 0x%lx", mp->listener_handle);
533 if (wait_for_segment_allocation (mp->segment_handle))
535 ECHO_FAIL (ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC,
536 "accepted wait_for_segment_allocation errored");
540 /* Allocate local session and set it up */
541 session = echo_session_new (em);
542 session->vpp_session_handle = mp->handle;
544 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
545 rx_fifo->client_session_index = session->session_index;
546 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
547 tx_fifo->client_session_index = session->session_index;
549 session->rx_fifo = rx_fifo;
550 session->tx_fifo = tx_fifo;
552 /* session->transport needed by app_send_dgram */
553 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
554 sizeof (ip46_address_t));
555 session->transport.is_ip4 = mp->rmt.is_ip4;
556 session->transport.rmt_port = mp->rmt.port;
557 clib_memcpy_fast (&session->transport.lcl_ip, &em->uri_elts.ip,
558 sizeof (ip46_address_t));
559 session->transport.lcl_port = em->uri_elts.port;
561 session->vpp_session_handle = mp->handle;
562 session->start = clib_time_now (&em->clib_time);
563 session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
565 session->listener_index = ls->session_index;
567 /* Add it to lookup table */
568 ECHO_LOG (1, "Accepted session 0x%lx S[%u] -> 0x%lx S[%u]",
569 mp->handle, session->session_index,
570 mp->listener_handle, session->listener_index);
571 echo_session_handle_add_del (em, mp->handle, session->session_index);
573 app_alloc_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt,
574 SESSION_CTRL_EVT_ACCEPTED_REPLY);
575 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
576 rmp->handle = mp->handle;
577 rmp->context = mp->context;
578 app_send_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt);
579 em->proto_cb_vft->accepted_cb (mp, session);
583 session_connected_handler (session_connected_msg_t * mp)
585 echo_main_t *em = &echo_main;
586 echo_session_t *session;
587 u32 listener_index = htonl (mp->context);
588 svm_fifo_t *rx_fifo, *tx_fifo;
590 clib_atomic_add_fetch (&em->max_sim_connects, 1);
594 if (em->proto_cb_vft->connected_cb)
596 proto_cb_vft->connected_cb ((session_connected_bundled_msg_t *) mp,
597 listener_index, 1 /* is_failed */ );
601 session = echo_session_new (em);
602 if (wait_for_segment_allocation (mp->segment_handle))
604 ECHO_FAIL (ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC,
605 "connected wait_for_segment_allocation errored");
609 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
610 rx_fifo->client_session_index = session->session_index;
611 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
612 tx_fifo->client_session_index = session->session_index;
614 session->rx_fifo = rx_fifo;
615 session->tx_fifo = tx_fifo;
616 session->vpp_session_handle = mp->handle;
617 session->start = clib_time_now (&em->clib_time);
618 session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
620 session->listener_index = listener_index;
621 /* session->transport needed by app_send_dgram */
622 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
623 sizeof (ip46_address_t));
624 session->transport.is_ip4 = mp->lcl.is_ip4;
625 session->transport.lcl_port = mp->lcl.port;
626 clib_memcpy_fast (&session->transport.rmt_ip, &em->uri_elts.ip,
627 sizeof (ip46_address_t));
628 session->transport.rmt_port = em->uri_elts.port;
630 echo_session_handle_add_del (em, mp->handle, session->session_index);
631 em->proto_cb_vft->connected_cb ((session_connected_bundled_msg_t *) mp,
632 session->session_index, 0 /* is_failed */ );
637 * End of ECHO callback definitions
642 session_disconnected_handler (session_disconnected_msg_t * mp)
644 app_session_evt_t _app_evt, *app_evt = &_app_evt;
645 session_disconnected_reply_msg_t *rmp;
646 echo_main_t *em = &echo_main;
648 if (!(s = echo_get_session_from_handle (em, mp->handle)))
650 ECHO_LOG (0, "Invalid vpp_session_handle: 0x%lx", mp->handle);
653 if (s->session_state == ECHO_SESSION_STATE_CLOSED)
655 ECHO_LOG (1, "%U: already in ECHO_SESSION_STATE_CLOSED",
656 echo_format_session, s);
660 ECHO_LOG (1, "%U: passive close", echo_format_session, s);
661 em->proto_cb_vft->disconnected_cb (mp, s);
663 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
664 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
665 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
667 rmp->handle = mp->handle;
668 rmp->context = mp->context;
669 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
673 session_reset_handler (session_reset_msg_t * mp)
675 app_session_evt_t _app_evt, *app_evt = &_app_evt;
676 echo_main_t *em = &echo_main;
677 session_reset_reply_msg_t *rmp;
678 echo_session_t *s = 0;
679 if (!(s = echo_get_session_from_handle (em, mp->handle)))
681 ECHO_LOG (0, "Invalid vpp_session_handle: 0x%lx", mp->handle);
684 ECHO_LOG (1, "%U: session reset", echo_format_session, s);
685 em->proto_cb_vft->reset_cb (mp, s);
687 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
688 SESSION_CTRL_EVT_RESET_REPLY);
689 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
691 rmp->handle = mp->handle;
692 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
696 handle_mq_event (session_event_t * e)
698 switch (e->event_type)
700 case SESSION_CTRL_EVT_BOUND:
701 return session_bound_handler ((session_bound_msg_t *) e->data);
702 case SESSION_CTRL_EVT_ACCEPTED:
703 return session_accepted_handler ((session_accepted_msg_t *) e->data);
704 case SESSION_CTRL_EVT_CONNECTED:
705 return session_connected_handler ((session_connected_msg_t *) e->data);
706 case SESSION_CTRL_EVT_DISCONNECTED:
707 return session_disconnected_handler ((session_disconnected_msg_t *)
709 case SESSION_CTRL_EVT_RESET:
710 return session_reset_handler ((session_reset_msg_t *) e->data);
711 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
712 return session_unlisten_handler ((session_unlisten_msg_t *) e->data);
713 case SESSION_IO_EVT_RX:
716 ECHO_LOG (0, "unhandled event %u", e->event_type);
721 echo_process_rpcs (echo_main_t * em)
725 svm_msg_q_t *mq = em->rpc_msq_queue;
727 while (em->state < STATE_DATA_DONE && !em->time_to_stop)
730 if (svm_msg_q_is_empty (mq) && svm_msg_q_timedwait (mq, 1))
732 svm_msg_q_unlock (mq);
735 svm_msg_q_sub_w_lock (mq, &msg);
736 rpc = svm_msg_q_msg_data (mq, &msg);
737 svm_msg_q_unlock (mq);
738 ((echo_rpc_t) rpc->fp) (rpc->arg, rpc->opaque);
739 svm_msg_q_free_msg (mq, &msg);
744 echo_mq_thread_fn (void *arg)
746 clib_mem_set_thread_index (); /* First thing to do in client thread */
747 svm_msg_q_msg_t *msg_vec = 0;
748 echo_main_t *em = &echo_main;
750 svm_msg_q_msg_t *msg;
754 vec_validate (msg_vec, em->evt_q_size);
755 vec_reset_length (msg_vec);
756 wait_for_state_change (em, STATE_ATTACHED, 0);
758 if (em->state < STATE_ATTACHED || !mq)
760 ECHO_FAIL (ECHO_FAIL_APP_ATTACH, "Application failed to attach");
764 while (em->state < STATE_DETACHED && !em->time_to_stop)
767 if (svm_msg_q_is_empty (mq) && svm_msg_q_timedwait (mq, 1))
769 svm_msg_q_unlock (mq);
772 for (i = 0; i < svm_msg_q_size (mq); i++)
774 vec_add2 (msg_vec, msg, 1);
775 svm_msg_q_sub_w_lock (mq, msg);
777 svm_msg_q_unlock (mq);
779 for (i = 0; i < vec_len (msg_vec); i++)
781 msg = vec_elt_at_index (msg_vec, i);
782 e = svm_msg_q_msg_data (mq, msg);
784 svm_msg_q_free_msg (mq, msg); /* No lock, single thread dequeuing */
786 vec_reset_length (msg_vec);
793 clients_run (echo_main_t * em)
796 echo_notify_event (em, ECHO_EVT_FIRST_QCONNECT);
797 for (i = 0; i < em->n_connects; i++)
798 echo_send_connect (SESSION_INVALID_HANDLE, SESSION_INVALID_INDEX);
799 wait_for_state_change (em, STATE_READY, 0);
800 ECHO_LOG (1, "App is ready");
801 echo_process_rpcs (em);
805 server_run (echo_main_t * em)
808 echo_send_listen (em);
809 wait_for_state_change (em, STATE_READY, 0);
810 ECHO_LOG (1, "App is ready");
811 echo_process_rpcs (em);
813 ECHO_LOG (1, "Unbind listen port");
814 ls = pool_elt_at_index (em->sessions, em->listen_session_index);
815 echo_send_unbind (em, ls);
816 if (wait_for_state_change (em, STATE_DISCONNECTED, TIMEOUT))
818 ECHO_FAIL (ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT,
819 "Timeout waiting for state disconnected");
825 print_usage_and_exit (void)
827 echo_main_t *em = &echo_main;
830 "Usage: vpp_echo [socket-name SOCKET] [client|server] [uri URI] [OPTIONS]\n"
831 "Generates traffic and assert correct teardown of the hoststack\n"
833 " socket-name PATH Specify the binary socket path to connect to VPP\n"
834 " use-svm-api Use SVM API to connect to VPP\n"
835 " test-bytes[:assert] Check data correctness when receiving (assert fails on first error)\n"
836 " fifo-size N[K|M|G] Use N[K|M|G] fifos\n"
837 " mq-size N Use mq with N slots for [vpp_echo->vpp] communication\n"
838 " max-sim-connects N Do not allow more than N mq events inflight\n"
839 " rx-buf N[K|M|G] Use N[Kb|Mb|GB] RX buffer\n"
840 " tx-buf N[K|M|G] Use N[Kb|Mb|GB] TX test buffer\n"
841 " appns NAMESPACE Use the namespace NAMESPACE\n"
842 " all-scope all-scope option\n"
843 " local-scope local-scope option\n"
844 " global-scope global-scope option\n"
845 " secret SECRET set namespace secret\n"
846 " chroot prefix PATH Use PATH as memory root path\n"
847 " sclose=[Y|N|W] When stream is done, send[Y]|nop[N]|wait[W] for close\n"
849 " time START:END Time between evts START & END, events being :\n"
850 " start - Start of the app\n"
851 " qconnect - first Connection connect sent\n"
852 " qconnected - last Connection connected\n"
853 " sconnect - first Stream connect sent\n"
854 " sconnected - last Stream got connected\n"
855 " lastbyte - Last expected byte received\n"
856 " exit - Exiting of the app\n"
857 " rx-results-diff Rx results different to pass test\n"
858 " tx-results-diff Tx results different to pass test\n"
859 " json Output global stats in json\n"
860 " log=N Set the log level to [0: no output, 1:errors, 2:log]\n"
861 " crypto [engine] Set the crypto engine [openssl, vpp, picotls, mbedtls]\n"
863 " nclients N Open N clients sending data\n"
864 " nthreads N Use N busy loop threads for data [in addition to main & msg queue]\n"
865 " TX=1337[K|M|G]|RX Send 1337 [K|M|G]bytes, use TX=RX to reflect the data\n"
866 " RX=1337[K|M|G] Expect 1337 [K|M|G]bytes\n" "\n");
867 for (i = 0; i < TRANSPORT_N_PROTO; i++)
869 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
870 if (vft && vft->print_usage_cb)
871 vft->print_usage_cb ();
873 fprintf (stderr, "\nDefault configuration is :\n"
874 " server nclients 1 [quic-streams 1] RX=64Kb TX=RX\n"
875 " client nclients 1 [quic-streams 1] RX=64Kb TX=64Kb\n");
876 exit (ECHO_FAIL_USAGE);
880 echo_process_each_proto_opts (unformat_input_t * a)
882 echo_main_t *em = &echo_main;
884 for (i = 0; i < TRANSPORT_N_PROTO; i++)
886 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
887 if (vft && vft->process_opts_cb)
888 if ((rv = vft->process_opts_cb (a)))
895 echo_set_each_proto_defaults_before_opts (echo_main_t * em)
898 for (i = 0; i < TRANSPORT_N_PROTO; i++)
900 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
901 if (vft && vft->set_defaults_before_opts_cb)
902 vft->set_defaults_before_opts_cb ();
907 echo_process_opts (int argc, char **argv)
909 echo_main_t *em = &echo_main;
910 unformat_input_t _argv, *a = &_argv;
916 unformat_init_command_line (a, argv);
917 while (unformat_check_input (a) != UNFORMAT_END_OF_INPUT)
919 if (echo_process_each_proto_opts (a))
921 else if (unformat (a, "chroot prefix %s", &chroot_prefix))
922 vl_set_memory_root_path ((char *) chroot_prefix);
923 else if (unformat (a, "uri %s", &uri))
924 em->uri = format (0, "%s%c", uri, 0);
925 else if (unformat (a, "server"))
927 else if (unformat (a, "client"))
929 else if (unformat (a, "test-bytes:assert"))
930 em->test_return_packets = RETURN_PACKETS_ASSERT;
931 else if (unformat (a, "test-bytes"))
932 em->test_return_packets = RETURN_PACKETS_LOG_WRONG;
933 else if (unformat (a, "socket-name %s", &em->socket_name))
935 else if (unformat (a, "use-svm-api"))
936 em->use_sock_api = 0;
937 else if (unformat (a, "fifo-size %U", unformat_memory_size, &tmp))
939 if (tmp >= 0x100000000ULL)
942 "ERROR: fifo-size %ld (0x%lx) too large\n", tmp, tmp);
943 print_usage_and_exit ();
947 else if (unformat (a, "prealloc-fifos %u", &em->prealloc_fifo_pairs))
950 if (unformat (a, "rx-buf %U", unformat_data_size, &em->rx_buf_size))
953 if (unformat (a, "tx-buf %U", unformat_data_size, &em->tx_buf_size))
955 else if (unformat (a, "mq-size %d", &em->evt_q_size))
957 else if (unformat (a, "nclients %d", &em->n_clients))
959 em->n_sessions = em->n_clients + 1;
960 em->n_connects = em->n_clients;
962 else if (unformat (a, "nthreads %d", &em->n_rx_threads))
964 else if (unformat (a, "crypto %U", echo_unformat_crypto_engine, &tmp))
965 em->crypto_engine = tmp;
966 else if (unformat (a, "appns %_%v%_", &em->appns_id))
968 else if (unformat (a, "all-scope"))
969 em->appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
970 | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
971 else if (unformat (a, "local-scope"))
972 em->appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
973 else if (unformat (a, "global-scope"))
974 em->appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
975 else if (unformat (a, "secret %lu", &em->appns_secret))
977 else if (unformat (a, "TX=RX"))
978 em->data_source = ECHO_RX_DATA_SOURCE;
979 else if (unformat (a, "TX=%U", unformat_data_size, &em->bytes_to_send))
981 else if (unformat (a, "RX=%U", unformat_data_size,
982 &em->bytes_to_receive))
984 else if (unformat (a, "rx-results-diff"))
985 em->rx_results_diff = 1;
986 else if (unformat (a, "tx-results-diff"))
987 em->tx_results_diff = 1;
988 else if (unformat (a, "json"))
990 else if (unformat (a, "wait-for-gdb"))
991 em->wait_for_gdb = 1;
992 else if (unformat (a, "log=%d", &em->log_lvl))
994 else if (unformat (a, "sclose=%U",
995 echo_unformat_close, &em->send_stream_disconnects))
997 else if (unformat (a, "time %U:%U",
998 echo_unformat_timing_event, &em->timing.start_event,
999 echo_unformat_timing_event, &em->timing.end_event))
1001 else if (unformat (a, "max-sim-connects %d", &em->max_sim_connects))
1004 print_usage_and_exit ();
1007 /* setting default for unset values
1009 * bytes_to_send / bytes_to_receive & data_source */
1010 if (em->bytes_to_receive == (u64) ~ 0)
1011 em->bytes_to_receive = 64 << 10; /* default */
1012 if (em->bytes_to_send == (u64) ~ 0)
1013 em->bytes_to_send = 64 << 10; /* default */
1014 else if (em->bytes_to_send == 0)
1015 em->data_source = ECHO_NO_DATA_SOURCE;
1017 em->data_source = ECHO_TEST_DATA_SOURCE;
1019 if (em->data_source == ECHO_INVALID_DATA_SOURCE)
1021 em->i_am_master ? ECHO_RX_DATA_SOURCE : ECHO_TEST_DATA_SOURCE;
1022 if (em->data_source == ECHO_RX_DATA_SOURCE)
1023 em->bytes_to_send = em->bytes_to_receive;
1025 /* disconnect flags */
1026 if (em->i_am_master)
1028 em->bytes_to_send == 0 ? ECHO_CLOSE_F_ACTIVE : ECHO_CLOSE_F_PASSIVE;
1031 em->bytes_to_receive == 0 ? ECHO_CLOSE_F_PASSIVE : ECHO_CLOSE_F_ACTIVE;
1032 if (em->send_stream_disconnects == ECHO_CLOSE_F_INVALID)
1033 em->send_stream_disconnects = default_f_active;
1035 if (em->max_sim_connects == 0)
1036 em->max_sim_connects = em->evt_q_size >> 1;
1038 if (em->wait_for_gdb)
1040 volatile u64 nop = 0;
1042 clib_warning ("Waiting for gdb...");
1043 while (em->wait_for_gdb)
1045 clib_warning ("Resuming execution (%llu)!", nop);
1050 echo_process_uri (echo_main_t * em)
1052 unformat_input_t _input, *input = &_input;
1054 unformat_init_string (input, (char *) em->uri, strlen ((char *) em->uri));
1056 (input, "%U://%U/%d", unformat_transport_proto,
1057 &em->uri_elts.transport_proto, unformat_ip4_address,
1058 &em->uri_elts.ip.ip4, &port))
1059 em->uri_elts.is_ip4 = 1;
1062 (input, "%U://%U/%d", unformat_transport_proto,
1063 &em->uri_elts.transport_proto, unformat_ip6_address,
1064 &em->uri_elts.ip.ip6, &port))
1065 em->uri_elts.is_ip4 = 0;
1067 ECHO_FAIL (ECHO_FAIL_INVALID_URI, "Unable to process uri");
1068 em->uri_elts.port = clib_host_to_net_u16 (port);
1069 unformat_free (input);
1072 static void __clib_constructor
1075 /* init memory before proto register themselves */
1076 echo_main_t *em = &echo_main;
1077 clib_mem_init_thread_safe (0, 256 << 20);
1078 clib_memset (em, 0, sizeof (*em));
1082 main (int argc, char **argv)
1084 echo_main_t *em = &echo_main;
1085 fifo_segment_main_t *sm = &em->segment_main;
1088 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1089 u32 rpc_queue_size = 256 << 10;
1091 em->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
1092 clib_spinlock_init (&em->sid_vpp_handles_lock);
1093 em->shared_segment_handles = hash_create (0, sizeof (uword));
1094 clib_spinlock_init (&em->segment_handles_lock);
1095 em->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
1096 em->use_sock_api = 1;
1097 em->fifo_size = 64 << 10;
1098 em->prealloc_fifo_pairs = 16;
1102 em->max_test_msg = 50;
1103 em->time_to_stop = 0;
1104 em->i_am_master = 1;
1105 em->n_rx_threads = 4;
1106 em->evt_q_size = 256;
1107 em->test_return_packets = RETURN_PACKETS_NOTEST;
1108 em->timing.start_event = ECHO_EVT_FIRST_QCONNECT;
1109 em->timing.end_event = ECHO_EVT_LAST_BYTE;
1110 em->bytes_to_receive = ~0; /* defaulted when we know if server/client */
1111 em->bytes_to_send = ~0; /* defaulted when we know if server/client */
1112 em->rx_buf_size = 1 << 20;
1113 em->tx_buf_size = 1 << 20;
1114 em->data_source = ECHO_INVALID_DATA_SOURCE;
1115 em->uri = format (0, "%s%c", "tcp://0.0.0.0/1234", 0);
1116 em->max_sim_connects = 0;
1117 em->crypto_engine = CRYPTO_ENGINE_NONE;
1118 echo_set_each_proto_defaults_before_opts (em);
1119 echo_process_opts (argc, argv);
1120 echo_process_uri (em);
1121 em->proto_cb_vft = em->available_proto_cb_vft[em->uri_elts.transport_proto];
1122 if (!em->proto_cb_vft)
1124 ECHO_FAIL (ECHO_FAIL_PROTOCOL_NOT_SUPPORTED,
1125 "Protocol %U is not supported",
1126 format_transport_proto, em->uri_elts.transport_proto);
1129 if (em->proto_cb_vft->set_defaults_after_opts_cb)
1130 em->proto_cb_vft->set_defaults_after_opts_cb ();
1132 em->stats.rx_expected = em->bytes_to_receive * em->n_clients;
1133 em->stats.tx_expected = em->bytes_to_send * em->n_clients;
1135 vec_validate (em->data_thread_handles, em->n_rx_threads);
1136 vec_validate (em->data_thread_args, em->n_clients);
1137 for (i = 0; i < em->n_clients; i++)
1138 em->data_thread_args[i] = SESSION_INVALID_INDEX;
1139 clib_time_init (&em->clib_time);
1140 init_error_string_table ();
1141 fifo_segment_main_init (sm, HIGH_SEGMENT_BASEVA, 20);
1142 vec_validate (em->connect_test_data, em->tx_buf_size);
1143 for (i = 0; i < em->tx_buf_size; i++)
1144 em->connect_test_data[i] = i & 0xff;
1147 svm_msg_q_ring_cfg_t rc[1] = {
1148 {rpc_queue_size, sizeof (echo_rpc_msg_t), 0},
1151 cfg->consumer_pid = getpid ();
1153 cfg->q_nitems = rpc_queue_size;
1154 cfg->ring_cfgs = rc;
1155 em->rpc_msq_queue = svm_msg_q_alloc (cfg);
1157 signal (SIGINT, stop_signal);
1158 signal (SIGQUIT, stop_signal);
1159 signal (SIGTERM, stop_signal);
1160 echo_api_hookup (em);
1162 app_name = em->i_am_master ? "echo_server" : "echo_client";
1163 if (connect_to_vpp (app_name))
1166 ECHO_FAIL (ECHO_FAIL_CONNECT_TO_VPP, "Couldn't connect to vpp");
1170 echo_session_prealloc (em);
1171 echo_notify_event (em, ECHO_EVT_START);
1173 echo_send_attach (em);
1174 if (wait_for_state_change (em, STATE_ATTACHED_NO_CERT, TIMEOUT))
1176 ECHO_FAIL (ECHO_FAIL_ATTACH_TO_VPP,
1177 "Couldn't attach to vpp, did you run <session enable> ?");
1181 if (em->uri_elts.transport_proto != TRANSPORT_PROTO_QUIC
1182 && em->uri_elts.transport_proto != TRANSPORT_PROTO_TLS)
1183 em->state = STATE_ATTACHED;
1186 ECHO_LOG (1, "Adding crypto context %U", echo_format_crypto_engine,
1188 echo_send_add_cert_key (em);
1189 if (wait_for_state_change (em, STATE_ATTACHED, TIMEOUT))
1191 ECHO_FAIL (ECHO_FAIL_APP_ATTACH,
1192 "Couldn't add crypto context to vpp\n");
1197 if (pthread_create (&em->mq_thread_handle,
1198 NULL /*attr */ , echo_mq_thread_fn, 0))
1200 ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE, "pthread create errored");
1204 for (i = 0; i < em->n_rx_threads; i++)
1205 if (pthread_create (&em->data_thread_handles[i],
1206 NULL /*attr */ , echo_data_thread_fn, (void *) i))
1208 ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE,
1209 "pthread create errored (index %d)", i);
1212 if (em->i_am_master)
1216 echo_notify_event (em, ECHO_EVT_EXIT);
1217 echo_free_sessions (em);
1218 echo_send_del_cert_key (em);
1219 if (wait_for_state_change (em, STATE_CLEANED_CERT_KEY, TIMEOUT))
1221 ECHO_FAIL (ECHO_FAIL_DEL_CERT_KEY, "Couldn't cleanup cert and key");
1225 echo_send_detach (em);
1226 if (wait_for_state_change (em, STATE_DETACHED, TIMEOUT))
1228 ECHO_FAIL (ECHO_FAIL_DETACH, "Couldn't detach from vpp");
1232 pthread_join (em->mq_thread_handle, (void **) &rv);
1235 ECHO_FAIL (ECHO_FAIL_MQ_PTHREAD, "mq pthread errored %d", rv);
1238 if (em->use_sock_api)
1239 vl_socket_client_disconnect ();
1241 vl_client_disconnect_from_vlib ();
1242 echo_assert_test_suceeded (em);
1244 ECHO_LOG (0, "Test complete !\n");
1245 if (em->output_json)
1246 print_global_json_stats (em);
1248 print_global_stats (em);
1249 vec_free (em->fail_descr);
1250 exit (em->has_failed);
1254 * fd.io coding-style-patch-verification: ON
1257 * eval: (c-set-style "gnu")