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_bound_handler (session_bound_msg_t * mp)
455 echo_main_t *em = &echo_main;
456 echo_session_t *listen_session;
459 ECHO_FAIL (ECHO_FAIL_BIND, "bind failed: %U", format_api_error,
460 clib_net_to_host_u32 (mp->retval));
463 ECHO_LOG (0, "listening on %U:%u", format_ip46_address, mp->lcl_ip,
464 mp->lcl_is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
465 clib_net_to_host_u16 (mp->lcl_port));
467 /* Allocate local session and set it up */
468 listen_session = echo_session_new (em);
469 listen_session->session_type = ECHO_SESSION_TYPE_LISTEN;
470 listen_session->vpp_session_handle = mp->handle;
471 echo_session_handle_add_del (em, mp->handle, listen_session->session_index);
472 em->state = STATE_LISTEN;
473 em->listen_session_index = listen_session->session_index;
474 if (em->proto_cb_vft->bound_uri_cb)
475 em->proto_cb_vft->bound_uri_cb (mp, listen_session);
479 session_accepted_handler (session_accepted_msg_t * mp)
481 app_session_evt_t _app_evt, *app_evt = &_app_evt;
482 session_accepted_reply_msg_t *rmp;
483 svm_fifo_t *rx_fifo, *tx_fifo;
484 echo_main_t *em = &echo_main;
485 echo_session_t *session, *ls;
486 /* Allocate local session and set it up */
487 session = echo_session_new (em);
489 if (wait_for_segment_allocation (mp->segment_handle))
491 ECHO_FAIL (ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC,
492 "accepted wait_for_segment_allocation errored");
496 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
497 rx_fifo->client_session_index = session->session_index;
498 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
499 tx_fifo->client_session_index = session->session_index;
501 session->rx_fifo = rx_fifo;
502 session->tx_fifo = tx_fifo;
504 /* session->transport needed by app_send_dgram */
505 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
506 sizeof (ip46_address_t));
507 session->transport.is_ip4 = mp->rmt.is_ip4;
508 session->transport.rmt_port = mp->rmt.port;
509 clib_memcpy_fast (&session->transport.lcl_ip, &em->uri_elts.ip,
510 sizeof (ip46_address_t));
511 session->transport.lcl_port = em->uri_elts.port;
513 session->vpp_session_handle = mp->handle;
514 session->start = clib_time_now (&em->clib_time);
515 session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
517 if (!(ls = echo_get_session_from_handle (em, mp->listener_handle)))
519 session->listener_index = ls->session_index;
521 /* Add it to lookup table */
522 ECHO_LOG (1, "Accepted session 0x%lx -> 0x%lx", mp->handle,
523 mp->listener_handle);
524 echo_session_handle_add_del (em, mp->handle, session->session_index);
526 app_alloc_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt,
527 SESSION_CTRL_EVT_ACCEPTED_REPLY);
528 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
529 rmp->handle = mp->handle;
530 rmp->context = mp->context;
531 app_send_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt);
532 em->proto_cb_vft->accepted_cb (mp, session);
536 session_connected_handler (session_connected_msg_t * mp)
538 echo_main_t *em = &echo_main;
539 echo_session_t *session;
540 u32 listener_index = htonl (mp->context);
541 svm_fifo_t *rx_fifo, *tx_fifo;
545 ECHO_FAIL (ECHO_FAIL_SESSION_CONNECT,
546 "connection failed with code: %U", format_api_error,
547 clib_net_to_host_u32 (mp->retval));
551 session = echo_session_new (em);
552 if (wait_for_segment_allocation (mp->segment_handle))
554 ECHO_FAIL (ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC,
555 "connected wait_for_segment_allocation errored");
559 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
560 rx_fifo->client_session_index = session->session_index;
561 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
562 tx_fifo->client_session_index = session->session_index;
564 session->rx_fifo = rx_fifo;
565 session->tx_fifo = tx_fifo;
566 session->vpp_session_handle = mp->handle;
567 session->start = clib_time_now (&em->clib_time);
568 session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
570 session->listener_index = listener_index;
571 /* session->transport needed by app_send_dgram */
572 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
573 sizeof (ip46_address_t));
574 session->transport.is_ip4 = mp->lcl.is_ip4;
575 session->transport.lcl_port = mp->lcl.port;
576 clib_memcpy_fast (&session->transport.rmt_ip, &em->uri_elts.ip,
577 sizeof (ip46_address_t));
578 session->transport.rmt_port = em->uri_elts.port;
580 echo_session_handle_add_del (em, mp->handle, session->session_index);
581 em->proto_cb_vft->connected_cb ((session_connected_bundled_msg_t *) mp,
582 session->session_index, 0 /* is_failed */ );
587 * End of ECHO callback definitions
592 session_disconnected_handler (session_disconnected_msg_t * mp)
594 app_session_evt_t _app_evt, *app_evt = &_app_evt;
595 session_disconnected_reply_msg_t *rmp;
596 echo_main_t *em = &echo_main;
598 ECHO_LOG (1, "passive close session 0x%lx", mp->handle);
599 if (!(s = echo_get_session_from_handle (em, mp->handle)))
601 em->proto_cb_vft->disconnected_cb (mp, s);
603 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
604 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
605 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
607 rmp->handle = mp->handle;
608 rmp->context = mp->context;
609 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
613 session_reset_handler (session_reset_msg_t * mp)
615 app_session_evt_t _app_evt, *app_evt = &_app_evt;
616 echo_main_t *em = &echo_main;
617 session_reset_reply_msg_t *rmp;
618 echo_session_t *s = 0;
619 ECHO_LOG (1, "Reset session 0x%lx", mp->handle);
620 if (!(s = echo_get_session_from_handle (em, mp->handle)))
622 em->proto_cb_vft->reset_cb (mp, s);
624 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
625 SESSION_CTRL_EVT_RESET_REPLY);
626 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
628 rmp->handle = mp->handle;
629 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
633 handle_mq_event (session_event_t * e)
635 switch (e->event_type)
637 case SESSION_CTRL_EVT_BOUND:
638 session_bound_handler ((session_bound_msg_t *) e->data);
640 case SESSION_CTRL_EVT_ACCEPTED:
641 session_accepted_handler ((session_accepted_msg_t *) e->data);
643 case SESSION_CTRL_EVT_CONNECTED:
644 session_connected_handler ((session_connected_msg_t *) e->data);
646 case SESSION_CTRL_EVT_DISCONNECTED:
647 session_disconnected_handler ((session_disconnected_msg_t *) e->data);
649 case SESSION_CTRL_EVT_RESET:
650 session_reset_handler ((session_reset_msg_t *) e->data);
652 case SESSION_IO_EVT_RX:
655 ECHO_LOG (0, "unhandled event %u", e->event_type);
660 echo_process_rpcs (echo_main_t * em)
664 svm_msg_q_t *mq = em->rpc_msq_queue;
666 while (em->state < STATE_DATA_DONE && !em->time_to_stop)
669 if (svm_msg_q_is_empty (mq) && svm_msg_q_timedwait (mq, 1))
671 svm_msg_q_unlock (mq);
674 svm_msg_q_sub_w_lock (mq, &msg);
675 rpc = svm_msg_q_msg_data (mq, &msg);
676 svm_msg_q_unlock (mq);
677 ((echo_rpc_t) rpc->fp) (rpc->arg, rpc->opaque);
678 svm_msg_q_free_msg (mq, &msg);
683 echo_mq_dequeue_batch (svm_msg_q_t * mq, svm_msg_q_msg_t * msg_vec,
686 svm_msg_q_msg_t *msg;
690 n_msgs = clib_min (svm_msg_q_size (mq), n_max_msg);
691 for (i = 0; i < n_msgs; i++)
693 vec_add2 (msg_vec, msg, 1);
694 svm_msg_q_sub_w_lock (mq, msg);
700 echo_mq_thread_fn (void *arg)
702 clib_mem_set_thread_index (); /* First thing to do in client thread */
703 svm_msg_q_msg_t *msg_vec = 0;
704 echo_main_t *em = &echo_main;
706 svm_msg_q_msg_t *msg;
710 vec_validate (msg_vec, em->evt_q_size);
711 vec_reset_length (msg_vec);
712 wait_for_state_change (em, STATE_ATTACHED, 0);
713 mq = em->our_event_queue;
714 if (em->state < STATE_ATTACHED || !mq)
716 ECHO_FAIL (ECHO_FAIL_APP_ATTACH, "Application failed to attach");
720 while (em->state < STATE_DETACHED && !em->time_to_stop)
723 if (svm_msg_q_is_empty (mq) && svm_msg_q_timedwait (mq, 1))
725 svm_msg_q_unlock (mq);
728 echo_mq_dequeue_batch (mq, msg_vec, ~0);
729 svm_msg_q_unlock (mq);
731 for (i = 0; i < vec_len (msg_vec); i++)
733 msg = vec_elt_at_index (msg_vec, i);
734 e = svm_msg_q_msg_data (mq, msg);
736 svm_msg_q_free_msg (mq, msg); /* No lock, single thread dequeuing */
738 vec_reset_length (msg_vec);
745 clients_run (echo_main_t * em)
748 echo_notify_event (em, ECHO_EVT_FIRST_QCONNECT);
749 for (i = 0; i < em->n_connects; i++)
750 echo_send_connect (em->uri, SESSION_INVALID_INDEX);
751 wait_for_state_change (em, STATE_READY, 0);
752 ECHO_LOG (1, "App is ready");
753 echo_process_rpcs (em);
757 server_run (echo_main_t * em)
759 echo_send_listen (em);
760 wait_for_state_change (em, STATE_READY, 0);
761 ECHO_LOG (1, "App is ready");
762 echo_process_rpcs (em);
764 echo_send_unbind (em);
765 if (wait_for_state_change (em, STATE_DISCONNECTED, TIMEOUT))
767 ECHO_FAIL (ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT,
768 "Timeout waiting for state disconnected");
774 print_usage_and_exit (void)
776 echo_main_t *em = &echo_main;
779 "Usage: vpp_echo [socket-name SOCKET] [client|server] [uri URI] [OPTIONS]\n"
780 "Generates traffic and assert correct teardown of the QUIC hoststack\n"
782 " socket-name PATH Specify the binary socket path to connect to VPP\n"
783 " use-svm-api Use SVM API to connect to VPP\n"
784 " test-bytes[:assert] Check data correctness when receiving (assert fails on first error)\n"
785 " fifo-size N Use N Kb fifos\n"
786 " mq-size N Use N event slots for vpp_echo <-> vpp events\n"
787 " rx-buf N[Kb|Mb|GB] Use N[Kb|Mb|GB] RX buffer\n"
788 " tx-buf N[Kb|Mb|GB] Use N[Kb|Mb|GB] TX test buffer\n"
789 " appns NAMESPACE Use the namespace NAMESPACE\n"
790 " all-scope all-scope option\n"
791 " local-scope local-scope option\n"
792 " global-scope global-scope option\n"
793 " secret SECRET set namespace secret\n"
794 " chroot prefix PATH Use PATH as memory root path\n"
795 " sclose=[Y|N|W] When a stream is done, pass[N] send[Y] or wait[W] for close\n"
797 " time START:END Time between evts START & END, events being :\n"
798 " start - Start of the app\n"
799 " qconnect - first Connection connect sent\n"
800 " qconnected - last Connection connected\n"
801 " sconnect - first Stream connect sent\n"
802 " sconnected - last Stream got connected\n"
803 " lastbyte - Last expected byte received\n"
804 " exit - Exiting of the app\n"
805 " json Output global stats in json\n"
806 " log=N Set the log level to [0: no output, 1:errors, 2:log]\n"
808 " nclients N Open N clients sending data\n"
809 " nthreads N Use N busy loop threads for data [in addition to main & msg queue]\n"
810 " TX=1337[Kb|Mb|GB] Send 1337 [K|M|G]bytes, use TX=RX to reflect the data\n"
811 " RX=1337[Kb|Mb|GB] Expect 1337 [K|M|G]bytes\n" "\n");
812 for (i = 0; i < TRANSPORT_N_PROTO; i++)
814 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
815 if (vft && vft->print_usage_cb)
816 vft->print_usage_cb ();
818 fprintf (stderr, "\nDefault configuration is :\n"
819 " server nclients 1/1 RX=64Kb TX=RX\n"
820 " client nclients 1/1 RX=64Kb TX=64Kb\n");
825 echo_process_each_proto_opts (unformat_input_t * a)
827 echo_main_t *em = &echo_main;
829 for (i = 0; i < TRANSPORT_N_PROTO; i++)
831 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
832 if (vft && vft->process_opts_cb)
833 if ((rv = vft->process_opts_cb (a)))
840 echo_set_each_proto_defaults_before_opts (echo_main_t * em)
843 for (i = 0; i < TRANSPORT_N_PROTO; i++)
845 echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
846 if (vft && vft->set_defaults_before_opts_cb)
847 vft->set_defaults_before_opts_cb ();
852 echo_process_opts (int argc, char **argv)
854 echo_main_t *em = &echo_main;
855 unformat_input_t _argv, *a = &_argv;
861 unformat_init_command_line (a, argv);
862 while (unformat_check_input (a) != UNFORMAT_END_OF_INPUT)
864 if (echo_process_each_proto_opts (a))
866 else if (unformat (a, "chroot prefix %s", &chroot_prefix))
867 vl_set_memory_root_path ((char *) chroot_prefix);
868 else if (unformat (a, "uri %s", &uri))
869 em->uri = format (0, "%s%c", uri, 0);
870 else if (unformat (a, "server"))
872 else if (unformat (a, "client"))
874 else if (unformat (a, "test-bytes:assert"))
875 em->test_return_packets = RETURN_PACKETS_ASSERT;
876 else if (unformat (a, "test-bytes"))
877 em->test_return_packets = RETURN_PACKETS_LOG_WRONG;
878 else if (unformat (a, "socket-name %s", &em->socket_name))
880 else if (unformat (a, "use-svm-api"))
881 em->use_sock_api = 0;
882 else if (unformat (a, "fifo-size %d", &tmp))
883 em->fifo_size = tmp << 10;
884 else if (unformat (a, "prealloc-fifos %u", &em->prealloc_fifo_pairs))
886 else if (unformat (a, "rx-buf %U", unformat_data, &em->rx_buf_size))
888 else if (unformat (a, "tx-buf %U", unformat_data, &em->tx_buf_size))
890 else if (unformat (a, "mq-size %d", &em->evt_q_size))
892 else if (unformat (a, "nclients %d", &em->n_clients))
894 em->n_sessions = em->n_clients + 1;
895 em->n_connects = em->n_clients;
897 else if (unformat (a, "nthreads %d", &em->n_rx_threads))
899 else if (unformat (a, "appns %_%v%_", &em->appns_id))
901 else if (unformat (a, "all-scope"))
902 em->appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
903 | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
904 else if (unformat (a, "local-scope"))
905 em->appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
906 else if (unformat (a, "global-scope"))
907 em->appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
908 else if (unformat (a, "secret %lu", &em->appns_secret))
910 else if (unformat (a, "TX=RX"))
911 em->data_source = ECHO_RX_DATA_SOURCE;
912 else if (unformat (a, "TX=%U", unformat_data, &em->bytes_to_send))
914 else if (unformat (a, "RX=%U", unformat_data, &em->bytes_to_receive))
916 else if (unformat (a, "json"))
918 else if (unformat (a, "log=%d", &em->log_lvl))
920 else if (unformat (a, "sclose=%U",
921 echo_unformat_close, &em->send_stream_disconnects))
923 else if (unformat (a, "time %U:%U",
924 echo_unformat_timing_event, &em->timing.start_event,
925 echo_unformat_timing_event, &em->timing.end_event))
928 print_usage_and_exit ();
931 /* setting default for unset values
933 * bytes_to_send / bytes_to_receive & data_source */
934 if (em->bytes_to_receive == (u64) ~ 0)
935 em->bytes_to_receive = 64 << 10; /* default */
936 if (em->bytes_to_send == (u64) ~ 0)
937 em->bytes_to_send = 64 << 10; /* default */
938 else if (em->bytes_to_send == 0)
939 em->data_source = ECHO_NO_DATA_SOURCE;
941 em->data_source = ECHO_TEST_DATA_SOURCE;
943 if (em->data_source == ECHO_INVALID_DATA_SOURCE)
945 em->i_am_master ? ECHO_RX_DATA_SOURCE : ECHO_TEST_DATA_SOURCE;
946 if (em->data_source == ECHO_RX_DATA_SOURCE)
947 em->bytes_to_send = em->bytes_to_receive;
949 /* disconnect flags */
952 em->bytes_to_send == 0 ? ECHO_CLOSE_F_ACTIVE : ECHO_CLOSE_F_PASSIVE;
955 em->bytes_to_receive == 0 ? ECHO_CLOSE_F_PASSIVE : ECHO_CLOSE_F_ACTIVE;
956 if (em->send_stream_disconnects == ECHO_CLOSE_F_INVALID)
957 em->send_stream_disconnects = default_f_active;
961 echo_process_uri (echo_main_t * em)
963 unformat_input_t _input, *input = &_input;
965 unformat_init_string (input, (char *) em->uri, strlen ((char *) em->uri));
967 (input, "%U://%U/%d", unformat_transport_proto,
968 &em->uri_elts.transport_proto, unformat_ip4_address,
969 &em->uri_elts.ip.ip4, &port))
970 em->uri_elts.is_ip4 = 1;
973 (input, "%U://%U/%d", unformat_transport_proto,
974 &em->uri_elts.transport_proto, unformat_ip6_address,
975 &em->uri_elts.ip.ip6, &port))
976 em->uri_elts.is_ip4 = 0;
978 ECHO_FAIL (ECHO_FAIL_INVALID_URI, "Unable to process uri");
979 em->uri_elts.port = clib_host_to_net_u16 (port);
980 unformat_free (input);
983 static void __clib_constructor
986 /* init memory before proto register themselves */
987 echo_main_t *em = &echo_main;
988 clib_mem_init_thread_safe (0, 256 << 20);
989 clib_memset (em, 0, sizeof (*em));
993 main (int argc, char **argv)
995 echo_main_t *em = &echo_main;
996 fifo_segment_main_t *sm = &em->segment_main;
999 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1000 u32 rpc_queue_size = 64 << 10;
1002 em->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
1003 clib_spinlock_init (&em->sid_vpp_handles_lock);
1004 em->shared_segment_handles = hash_create (0, sizeof (uword));
1005 clib_spinlock_init (&em->segment_handles_lock);
1006 em->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
1007 em->use_sock_api = 1;
1008 em->fifo_size = 64 << 10;
1009 em->prealloc_fifo_pairs = 16;
1013 em->max_test_msg = 50;
1014 em->time_to_stop = 0;
1015 em->i_am_master = 1;
1016 em->n_rx_threads = 4;
1017 em->evt_q_size = 256;
1018 em->test_return_packets = RETURN_PACKETS_NOTEST;
1019 em->timing.start_event = ECHO_EVT_FIRST_QCONNECT;
1020 em->timing.end_event = ECHO_EVT_LAST_BYTE;
1021 em->bytes_to_receive = ~0; /* defaulted when we know if server/client */
1022 em->bytes_to_send = ~0; /* defaulted when we know if server/client */
1023 em->rx_buf_size = 1 << 20;
1024 em->tx_buf_size = 1 << 20;
1025 em->data_source = ECHO_INVALID_DATA_SOURCE;
1026 em->uri = format (0, "%s%c", "tcp://0.0.0.0/1234", 0);
1027 echo_set_each_proto_defaults_before_opts (em);
1028 echo_process_opts (argc, argv);
1029 echo_process_uri (em);
1030 em->proto_cb_vft = em->available_proto_cb_vft[em->uri_elts.transport_proto];
1031 if (!em->proto_cb_vft)
1033 ECHO_FAIL (ECHO_FAIL_PROTOCOL_NOT_SUPPORTED,
1034 "Protocol %U is not supported",
1035 format_transport_proto, em->uri_elts.transport_proto);
1038 if (em->proto_cb_vft->set_defaults_after_opts_cb)
1039 em->proto_cb_vft->set_defaults_after_opts_cb ();
1041 vec_validate (em->data_thread_handles, em->n_rx_threads);
1042 vec_validate (em->data_thread_args, em->n_clients);
1043 for (i = 0; i < em->n_clients; i++)
1044 em->data_thread_args[i] = SESSION_INVALID_INDEX;
1045 clib_time_init (&em->clib_time);
1046 init_error_string_table ();
1047 fifo_segment_main_init (sm, HIGH_SEGMENT_BASEVA, 20);
1048 vec_validate (em->connect_test_data, em->tx_buf_size);
1049 for (i = 0; i < em->tx_buf_size; i++)
1050 em->connect_test_data[i] = i & 0xff;
1053 svm_msg_q_ring_cfg_t rc[1] = {
1054 {rpc_queue_size, sizeof (echo_rpc_msg_t), 0},
1057 cfg->consumer_pid = getpid ();
1059 cfg->q_nitems = rpc_queue_size;
1060 cfg->ring_cfgs = rc;
1061 em->rpc_msq_queue = svm_msg_q_alloc (cfg);
1063 signal (SIGINT, stop_signal);
1064 signal (SIGQUIT, stop_signal);
1065 signal (SIGTERM, stop_signal);
1066 echo_api_hookup (em);
1068 app_name = em->i_am_master ? "echo_server" : "echo_client";
1069 if (connect_to_vpp (app_name))
1072 ECHO_FAIL (ECHO_FAIL_CONNECT_TO_VPP, "Couldn't connect to vpp");
1076 echo_session_prealloc (em);
1077 echo_notify_event (em, ECHO_EVT_START);
1079 echo_send_attach (em);
1080 if (wait_for_state_change (em, STATE_ATTACHED, TIMEOUT))
1082 ECHO_FAIL (ECHO_FAIL_ATTACH_TO_VPP,
1083 "Couldn't attach to vpp, did you run <session enable> ?");
1086 if (pthread_create (&em->mq_thread_handle,
1087 NULL /*attr */ , echo_mq_thread_fn, 0))
1089 ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE, "pthread create errored");
1092 for (i = 0; i < em->n_rx_threads; i++)
1093 if (pthread_create (&em->data_thread_handles[i],
1094 NULL /*attr */ , echo_data_thread_fn, (void *) i))
1096 ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE,
1097 "pthread create errored (index %d)", i);
1100 if (em->i_am_master)
1104 echo_notify_event (em, ECHO_EVT_EXIT);
1105 echo_free_sessions (em);
1106 echo_assert_test_suceeded (em);
1107 echo_send_detach (em);
1108 if (wait_for_state_change (em, STATE_DETACHED, TIMEOUT))
1110 ECHO_FAIL (ECHO_FAIL_DETACH, "Couldn't detach from vpp");
1114 pthread_join (em->mq_thread_handle, (void **) &rv);
1117 ECHO_FAIL (ECHO_FAIL_MQ_PTHREAD, "mq pthread errored %d", rv);
1120 if (em->use_sock_api)
1121 vl_socket_client_disconnect ();
1123 vl_client_disconnect_from_vlib ();
1125 ECHO_LOG (0, "Test complete !\n");
1126 if (em->output_json)
1127 print_global_json_stats (em);
1129 print_global_stats (em);
1130 vec_free (em->fail_descr);
1131 exit (em->has_failed);
1135 * fd.io coding-style-patch-verification: ON
1138 * eval: (c-set-style "gnu")