hsa: refactor vpp_echo failure handling
[vpp.git] / src / plugins / hs_apps / sapi / vpp_echo.c
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
16 #include <stdio.h>
17 #include <signal.h>
18
19 #include <vlibmemory/api.h>
20 #include <svm/fifo_segment.h>
21
22 #include <hs_apps/sapi/vpp_echo_common.h>
23
24 echo_main_t echo_main;
25
26 static void
27 echo_session_prealloc (echo_main_t * em)
28 {
29   /* We need to prealloc to avoid vec resize in threads */
30   echo_session_t *session;
31   int i;
32   for (i = 0; i < em->n_sessions; i++)
33     {
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;
39     }
40 }
41
42 static void
43 echo_assert_test_suceeded (echo_main_t * em)
44 {
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);
56 }
57
58 always_inline void
59 echo_session_dequeue_notify (echo_session_t * s)
60 {
61   int rv;
62   if (!svm_fifo_set_event (s->rx_fifo))
63     return;
64   if ((rv =
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",
68                rv);
69   svm_fifo_clear_deq_ntf (s->rx_fifo);
70 }
71
72 static void
73 stop_signal (int signum)
74 {
75   echo_main_t *em = &echo_main;
76   em->time_to_stop = 1;
77 }
78
79 int
80 connect_to_vpp (char *name)
81 {
82   echo_main_t *em = &echo_main;
83   api_main_t *am = &api_main;
84
85   if (em->use_sock_api)
86     {
87       if (vl_socket_client_connect ((char *) em->socket_name, name,
88                                     0 /* default rx, tx buffer */ ))
89         {
90           ECHO_FAIL (ECHO_FAIL_SOCKET_CONNECT, "socket connect failed");
91           return -1;
92         }
93
94       if (vl_socket_client_init_shm (0, 1 /* want_pthread */ ))
95         {
96           ECHO_FAIL (ECHO_FAIL_INIT_SHM_API, "init shm api failed");
97           return -1;
98         }
99     }
100   else
101     {
102       if (vl_client_connect_to_vlib ("/vpe-api", name, 32) < 0)
103         {
104           ECHO_FAIL (ECHO_FAIL_SHMEM_CONNECT, "shmem connect failed");
105           return -1;
106         }
107     }
108   em->vl_input_queue = am->shmem_hdr->vl_input_queue;
109   em->my_client_index = am->my_client_index;
110   return 0;
111 }
112
113 static void
114 print_global_json_stats (echo_main_t * em)
115 {
116   u8 *start_evt =
117     format (0, "%U", echo_format_timing_event, em->timing.start_event);
118   u8 *end_evt =
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;
124
125   if (start_evt_missing)
126     ECHO_FAIL (ECHO_FAIL_MISSING_START_EVENT,
127                "Expected event %s to happen, but it did not!", start_evt);
128
129   if (end_evt_missing)
130     ECHO_FAIL (ECHO_FAIL_MISSING_END_EVENT,
131                "Expected event %s to happen, but it did not!", end_evt);
132
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\": \"%s\",\n", start_evt);
138   fformat (stdout, "  \"start_evt_missing\": \"%s\",\n",
139            start_evt_missing ? "True" : "False");
140   fformat (stdout, "  \"end_evt\": \"%s\",\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");
160   fflush (stdout);
161   vec_free (start_evt);
162   vec_free (end_evt);
163 }
164
165 static void
166 print_global_stats (echo_main_t * em)
167 {
168   u8 *start_evt =
169     format (0, "%U", echo_format_timing_event, em->timing.start_event);
170   u8 *end_evt =
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;
176
177   if (start_evt_missing)
178     ECHO_FAIL (ECHO_FAIL_MISSING_START_EVENT,
179                "Expected event %s to happen, but it did not!", start_evt);
180
181   if (end_evt_missing)
182     ECHO_FAIL (ECHO_FAIL_MISSING_END_EVENT,
183                "Expected event %s to happen, but it did not!", end_evt);
184
185   fformat (stdout, "Timing %s:%s\n", start_evt, end_evt);
186   if (start_evt_missing)
187     fformat (stdout, "Missing Start Timing Event (%s)!\n", start_evt);
188   if (end_evt_missing)
189     fformat (stdout, "Missing End Timing Event (%s)!\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);
194   if (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);
201   if (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);
213   if (em->has_failed)
214     fformat (stdout, "\nFailure Return Status: %d\n%v", em->has_failed,
215              em->fail_descr);
216   vec_free (start_evt);
217   vec_free (end_evt);
218 }
219
220 void
221 echo_update_count_on_session_close (echo_main_t * em, echo_session_t * s)
222 {
223
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);
230
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);
234 }
235
236 static void
237 echo_free_sessions (echo_main_t * em)
238 {
239   /* Free marked sessions */
240   echo_session_t *s;
241   u32 *session_indexes = 0, *session_index;
242
243   /* *INDENT-OFF* */
244   pool_foreach (s, em->sessions,
245   ({
246     if (s->session_state == ECHO_SESSION_STATE_CLOSED)
247       vec_add1 (session_indexes, s->session_index);}
248   ));
249   /* *INDENT-ON* */
250   vec_foreach (session_index, session_indexes)
251   {
252     /* Free session */
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);
258   }
259 }
260
261 static void
262 test_recv_bytes (echo_main_t * em, echo_session_t * s, u8 * rx_buf,
263                  u32 n_read)
264 {
265   u32 i;
266   u8 expected;
267   for (i = 0; i < n_read; i++)
268     {
269       expected = (s->bytes_received + i) & 0xff;
270       if (rx_buf[i] == expected || em->max_test_msg > 0)
271         continue;
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],
274                 expected);
275       em->max_test_msg--;
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");
280     }
281 }
282
283 static int
284 recv_data_chunk (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
285 {
286   int n_read;
287   n_read = app_recv ((app_session_t *) s, rx_buf, vec_len (rx_buf));
288   if (n_read <= 0)
289     return 0;
290   if (svm_fifo_needs_deq_ntf (s->rx_fifo, n_read))
291     echo_session_dequeue_notify (s);
292
293   if (em->test_return_packets)
294     test_recv_bytes (em, s, rx_buf, n_read);
295
296   s->bytes_received += n_read;
297   s->bytes_to_receive -= n_read;
298   return n_read;
299 }
300
301 static int
302 send_data_chunk (echo_session_t * s, u8 * tx_buf, int offset, int len)
303 {
304   int n_sent;
305   int bytes_this_chunk = clib_min (s->bytes_to_send, len - offset);
306   if (!bytes_this_chunk)
307     return 0;
308   n_sent = app_send ((app_session_t *) s, tx_buf + offset,
309                      bytes_this_chunk, SVM_Q_WAIT);
310   if (n_sent < 0)
311     return 0;
312   s->bytes_to_send -= n_sent;
313   s->bytes_sent += n_sent;
314   return n_sent;
315 }
316
317 static int
318 mirror_data_chunk (echo_main_t * em, echo_session_t * s, u8 * tx_buf, u64 len)
319 {
320   u64 n_sent = 0;
321   while (n_sent < len && !em->time_to_stop)
322     n_sent += send_data_chunk (s, tx_buf, n_sent, len);
323   return n_sent;
324 }
325
326 static inline void
327 echo_check_closed_listener (echo_main_t * em, echo_session_t * s)
328 {
329   echo_session_t *ls;
330   /* if parent has died, terminate gracefully */
331   if (s->listener_index == SESSION_INVALID_INDEX)
332     return;
333   ls = pool_elt_at_index (em->sessions, s->listener_index);
334   if (ls->session_state < ECHO_SESSION_STATE_CLOSING)
335     return;
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 */ );
340 }
341
342 /*
343  * Rx/Tx polling thread per connection
344  */
345 static void
346 echo_handle_data (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
347 {
348   int n_read, n_sent = 0;
349
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,
354                               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)
358     {
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;
362       else
363         {
364           s->session_state = ECHO_SESSION_STATE_AWAIT_CLOSING;
365           if (em->send_stream_disconnects == ECHO_CLOSE_F_ACTIVE)
366             {
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);
370             }
371           else if (em->send_stream_disconnects == ECHO_CLOSE_F_NONE)
372             {
373               s->session_state = ECHO_SESSION_STATE_CLOSING;
374               clib_atomic_fetch_add (&em->stats.clean_count.s, 1);
375             }
376         }
377       return;
378     }
379
380   /* Check for idle clients */
381   if (em->log_lvl > 1)
382     {
383       if (n_sent || n_read)
384         s->idle_cycles = 0;
385       else if (s->idle_cycles++ == 1e7)
386         {
387           s->idle_cycles = 0;
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,
394                     s->session_state);
395         }
396     }
397 }
398
399 static void *
400 echo_data_thread_fn (void *arg)
401 {
402   clib_mem_set_thread_index ();
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;
406   u32 idx = (u64) arg;
407   if (n * idx >= N)
408     {
409       ECHO_LOG (1, "Thread %u exiting, no sessions to care for", idx);
410       pthread_exit (0);
411     }
412   u32 thread_n_sessions = clib_min (n, N - n * idx);
413
414   u32 i = 0;
415   u32 n_closed_sessions = 0;
416   u32 session_index;
417   u8 *rx_buf = 0;
418   echo_session_t *s;
419   vec_validate (rx_buf, em->rx_buf_size);
420
421   for (i = 0; !em->time_to_stop; i = (i + 1) % thread_n_sessions)
422     {
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)
426         continue;
427       s = pool_elt_at_index (em->sessions, session_index);
428       switch (s->session_state)
429         {
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);
434           break;
435         case ECHO_SESSION_STATE_AWAIT_CLOSING:
436           echo_check_closed_listener (em, s);
437           break;
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 */ );
441           break;
442         case ECHO_SESSION_STATE_CLOSED:
443           n_closed_sessions++;
444           break;
445         }
446       if (n_closed_sessions == thread_n_sessions)
447         break;
448     }
449   pthread_exit (0);
450 }
451
452 static void
453 session_bound_handler (session_bound_msg_t * mp)
454 {
455   echo_main_t *em = &echo_main;
456   echo_session_t *listen_session;
457   if (mp->retval)
458     {
459       ECHO_FAIL (ECHO_FAIL_BIND, "bind failed: %U", format_api_error,
460                  clib_net_to_host_u32 (mp->retval));
461       return;
462     }
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));
466
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);
476 }
477
478 static void
479 session_accepted_handler (session_accepted_msg_t * mp)
480 {
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);
488
489   if (wait_for_segment_allocation (mp->segment_handle))
490     {
491       ECHO_FAIL (ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC,
492                  "accepted wait_for_segment_allocation errored");
493       return;
494     }
495
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;
500
501   session->rx_fifo = rx_fifo;
502   session->tx_fifo = tx_fifo;
503
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;
512
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,
516                                          svm_msg_q_t *);
517   if (!(ls = echo_get_session_from_handle (em, mp->listener_handle)))
518     return;
519   session->listener_index = ls->session_index;
520
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);
525
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);
533 }
534
535 static void
536 session_connected_handler (session_connected_msg_t * mp)
537 {
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;
542
543   if (mp->retval)
544     {
545       ECHO_FAIL (ECHO_FAIL_SESSION_CONNECT,
546                  "connection failed with code: %U", format_api_error,
547                  clib_net_to_host_u32 (mp->retval));
548       return;
549     }
550
551   session = echo_session_new (em);
552   if (wait_for_segment_allocation (mp->segment_handle))
553     {
554       ECHO_FAIL (ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC,
555                  "connected wait_for_segment_allocation errored");
556       return;
557     }
558
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;
563
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,
569                                          svm_msg_q_t *);
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;
579
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 */ );
583 }
584
585 /*
586  *
587  *  End of ECHO callback definitions
588  *
589  */
590
591 static void
592 session_disconnected_handler (session_disconnected_msg_t * mp)
593 {
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;
597   echo_session_t *s;
598   ECHO_LOG (1, "passive close session 0x%lx", mp->handle);
599   if (!(s = echo_get_session_from_handle (em, mp->handle)))
600     return;
601   em->proto_cb_vft->disconnected_cb (mp, s);
602
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;
606   rmp->retval = 0;
607   rmp->handle = mp->handle;
608   rmp->context = mp->context;
609   app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
610 }
611
612 static void
613 session_reset_handler (session_reset_msg_t * mp)
614 {
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)))
621     return;
622   em->proto_cb_vft->reset_cb (mp, s);
623
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;
627   rmp->retval = 0;
628   rmp->handle = mp->handle;
629   app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
630 }
631
632 static void
633 handle_mq_event (session_event_t * e)
634 {
635   switch (e->event_type)
636     {
637     case SESSION_CTRL_EVT_BOUND:
638       session_bound_handler ((session_bound_msg_t *) e->data);
639       break;
640     case SESSION_CTRL_EVT_ACCEPTED:
641       session_accepted_handler ((session_accepted_msg_t *) e->data);
642       break;
643     case SESSION_CTRL_EVT_CONNECTED:
644       session_connected_handler ((session_connected_msg_t *) e->data);
645       break;
646     case SESSION_CTRL_EVT_DISCONNECTED:
647       session_disconnected_handler ((session_disconnected_msg_t *) e->data);
648       break;
649     case SESSION_CTRL_EVT_RESET:
650       session_reset_handler ((session_reset_msg_t *) e->data);
651       break;
652     case SESSION_IO_EVT_RX:
653       break;
654     default:
655       ECHO_LOG (0, "unhandled event %u", e->event_type);
656     }
657 }
658
659 static void
660 echo_process_rpcs (echo_main_t * em)
661 {
662   echo_rpc_msg_t *rpc;
663   svm_msg_q_msg_t msg;
664   while (em->state < STATE_DATA_DONE && !em->time_to_stop)
665     {
666       if (svm_msg_q_sub (em->rpc_msq_queue, &msg, SVM_Q_TIMEDWAIT, 1))
667         continue;
668       rpc = svm_msg_q_msg_data (em->rpc_msq_queue, &msg);
669       ((echo_rpc_t) rpc->fp) (rpc->arg, rpc->opaque);
670       svm_msg_q_free_msg (em->rpc_msq_queue, &msg);
671     }
672 }
673
674 static void *
675 echo_mq_thread_fn (void *arg)
676 {
677   clib_mem_set_thread_index ();
678   echo_main_t *em = &echo_main;
679   session_event_t *e;
680   svm_msg_q_msg_t msg;
681   int rv;
682   wait_for_state_change (em, STATE_ATTACHED, 0);
683   if (em->state < STATE_ATTACHED || !em->our_event_queue)
684     {
685       ECHO_FAIL (ECHO_FAIL_APP_ATTACH, "Application failed to attach");
686       pthread_exit (0);
687     }
688
689   while (1)
690     {
691       if (!(rv = svm_msg_q_sub (em->our_event_queue,
692                                 &msg, SVM_Q_TIMEDWAIT, 1)))
693         {
694           e = svm_msg_q_msg_data (em->our_event_queue, &msg);
695           handle_mq_event (e);
696           svm_msg_q_free_msg (em->our_event_queue, &msg);
697         }
698       if (rv == ETIMEDOUT
699           && (em->time_to_stop || em->state == STATE_DETACHED))
700         break;
701     }
702   pthread_exit (0);
703 }
704
705 static void
706 clients_run (echo_main_t * em)
707 {
708   u64 i;
709   echo_notify_event (em, ECHO_EVT_FIRST_QCONNECT);
710   for (i = 0; i < em->n_connects; i++)
711     echo_send_connect (em->uri, SESSION_INVALID_INDEX);
712   wait_for_state_change (em, STATE_READY, 0);
713   ECHO_LOG (1, "App is ready");
714   echo_process_rpcs (em);
715 }
716
717 static void
718 server_run (echo_main_t * em)
719 {
720   echo_send_listen (em);
721   wait_for_state_change (em, STATE_READY, 0);
722   ECHO_LOG (1, "App is ready");
723   echo_process_rpcs (em);
724   /* Cleanup */
725   echo_send_unbind (em);
726   if (wait_for_state_change (em, STATE_DISCONNECTED, TIMEOUT))
727     {
728       ECHO_FAIL (ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT,
729                  "Timeout waiting for state disconnected");
730       return;
731     }
732 }
733
734 static void
735 print_usage_and_exit (void)
736 {
737   echo_main_t *em = &echo_main;
738   int i;
739   fprintf (stderr,
740            "Usage: vpp_echo [socket-name SOCKET] [client|server] [uri URI] [OPTIONS]\n"
741            "Generates traffic and assert correct teardown of the QUIC hoststack\n"
742            "\n"
743            "  socket-name PATH    Specify the binary socket path to connect to VPP\n"
744            "  use-svm-api         Use SVM API to connect to VPP\n"
745            "  test-bytes[:assert] Check data correctness when receiving (assert fails on first error)\n"
746            "  fifo-size N         Use N Kb fifos\n"
747            "  rx-buf N            Use N Kb RX buffer\n"
748            "  tx-buf N            Use N Kb TX test buffer\n"
749            "  appns NAMESPACE     Use the namespace NAMESPACE\n"
750            "  all-scope           all-scope option\n"
751            "  local-scope         local-scope option\n"
752            "  global-scope        global-scope option\n"
753            "  secret SECRET       set namespace secret\n"
754            "  chroot prefix PATH  Use PATH as memory root path\n"
755            "  sclose=[Y|N|W]      When a stream is done,    pass[N] send[Y] or wait[W] for close\n"
756            "\n"
757            "  time START:END      Time between evts START & END, events being :\n"
758            "                       start - Start of the app\n"
759            "                       qconnect    - first Connection connect sent\n"
760            "                       qconnected  - last Connection connected\n"
761            "                       sconnect    - first Stream connect sent\n"
762            "                       sconnected  - last Stream got connected\n"
763            "                       lastbyte    - Last expected byte received\n"
764            "                       exit        - Exiting of the app\n"
765            "  json                Output global stats in json\n"
766            "  log=N               Set the log level to [0: no output, 1:errors, 2:log]\n"
767            "\n"
768            "  nclients N          Open N clients sending data\n"
769            "  nthreads N          Use N busy loop threads for data [in addition to main & msg queue]\n"
770            "  TX=1337[Kb|Mb|GB]   Send 1337 [K|M|G]bytes, use TX=RX to reflect the data\n"
771            "  RX=1337[Kb|Mb|GB]   Expect 1337 [K|M|G]bytes\n" "\n");
772   for (i = 0; i < TRANSPORT_N_PROTO; i++)
773     {
774       echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
775       if (vft && vft->print_usage_cb)
776         vft->print_usage_cb ();
777     }
778   fprintf (stderr, "\nDefault configuration is :\n"
779            " server nclients 1/1 RX=64Kb TX=RX\n"
780            " client nclients 1/1 RX=64Kb TX=64Kb\n");
781   exit (1);
782 }
783
784 static int
785 echo_process_each_proto_opts (unformat_input_t * a)
786 {
787   echo_main_t *em = &echo_main;
788   int i, rv;
789   for (i = 0; i < TRANSPORT_N_PROTO; i++)
790     {
791       echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
792       if (vft && vft->process_opts_cb)
793         if ((rv = vft->process_opts_cb (a)))
794           return rv;
795     }
796   return 0;
797 }
798
799 static void
800 echo_set_each_proto_defaults_before_opts (echo_main_t * em)
801 {
802   int i;
803   for (i = 0; i < TRANSPORT_N_PROTO; i++)
804     {
805       echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
806       if (vft && vft->set_defaults_before_opts_cb)
807         vft->set_defaults_before_opts_cb ();
808     }
809 }
810
811 void
812 echo_process_opts (int argc, char **argv)
813 {
814   echo_main_t *em = &echo_main;
815   unformat_input_t _argv, *a = &_argv;
816   u32 tmp;
817   u8 *chroot_prefix;
818   u8 *uri = 0;
819   u8 default_f_active;
820
821   unformat_init_command_line (a, argv);
822   while (unformat_check_input (a) != UNFORMAT_END_OF_INPUT)
823     {
824       if (echo_process_each_proto_opts (a))
825         ;
826       else if (unformat (a, "chroot prefix %s", &chroot_prefix))
827         vl_set_memory_root_path ((char *) chroot_prefix);
828       else if (unformat (a, "uri %s", &uri))
829         em->uri = format (0, "%s%c", uri, 0);
830       else if (unformat (a, "server"))
831         em->i_am_master = 1;
832       else if (unformat (a, "client"))
833         em->i_am_master = 0;
834       else if (unformat (a, "test-bytes:assert"))
835         em->test_return_packets = RETURN_PACKETS_ASSERT;
836       else if (unformat (a, "test-bytes"))
837         em->test_return_packets = RETURN_PACKETS_LOG_WRONG;
838       else if (unformat (a, "socket-name %s", &em->socket_name))
839         ;
840       else if (unformat (a, "use-svm-api"))
841         em->use_sock_api = 0;
842       else if (unformat (a, "fifo-size %d", &tmp))
843         em->fifo_size = tmp << 10;
844       else if (unformat (a, "rx-buf %d", &tmp))
845         em->rx_buf_size = tmp << 10;
846       else if (unformat (a, "tx-buf %d", &tmp))
847         em->rx_buf_size = tmp << 10;
848       else if (unformat (a, "nclients %d", &em->n_clients))
849         {
850           em->n_sessions = em->n_clients + 1;
851           em->n_connects = em->n_clients;
852         }
853       else if (unformat (a, "nthreads %d", &em->n_rx_threads))
854         ;
855       else if (unformat (a, "appns %_%v%_", &em->appns_id))
856         ;
857       else if (unformat (a, "all-scope"))
858         em->appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
859                             | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
860       else if (unformat (a, "local-scope"))
861         em->appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
862       else if (unformat (a, "global-scope"))
863         em->appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
864       else if (unformat (a, "secret %lu", &em->appns_secret))
865         ;
866       else if (unformat (a, "TX=RX"))
867         em->data_source = ECHO_RX_DATA_SOURCE;
868       else if (unformat (a, "TX=%U", unformat_data, &em->bytes_to_send))
869         ;
870       else if (unformat (a, "RX=%U", unformat_data, &em->bytes_to_receive))
871         ;
872       else if (unformat (a, "json"))
873         em->output_json = 1;
874       else if (unformat (a, "log=%d", &em->log_lvl))
875         ;
876       else if (unformat (a, "sclose=%U",
877                          echo_unformat_close, &em->send_stream_disconnects))
878         ;
879       else if (unformat (a, "time %U:%U",
880                          echo_unformat_timing_event, &em->timing.start_event,
881                          echo_unformat_timing_event, &em->timing.end_event))
882         ;
883       else
884         print_usage_and_exit ();
885     }
886
887   /* setting default for unset values
888    *
889    * bytes_to_send / bytes_to_receive & data_source  */
890   if (em->bytes_to_receive == (u64) ~ 0)
891     em->bytes_to_receive = 64 << 10;    /* default */
892   if (em->bytes_to_send == (u64) ~ 0)
893     em->bytes_to_send = 64 << 10;       /* default */
894   else if (em->bytes_to_send == 0)
895     em->data_source = ECHO_NO_DATA_SOURCE;
896   else
897     em->data_source = ECHO_TEST_DATA_SOURCE;
898
899   if (em->data_source == ECHO_INVALID_DATA_SOURCE)
900     em->data_source =
901       em->i_am_master ? ECHO_RX_DATA_SOURCE : ECHO_TEST_DATA_SOURCE;
902   if (em->data_source == ECHO_RX_DATA_SOURCE)
903     em->bytes_to_send = em->bytes_to_receive;
904
905   /* disconnect flags  */
906   if (em->i_am_master)
907     default_f_active =
908       em->bytes_to_send == 0 ? ECHO_CLOSE_F_ACTIVE : ECHO_CLOSE_F_PASSIVE;
909   else
910     default_f_active =
911       em->bytes_to_receive == 0 ? ECHO_CLOSE_F_PASSIVE : ECHO_CLOSE_F_ACTIVE;
912   if (em->send_stream_disconnects == ECHO_CLOSE_F_INVALID)
913     em->send_stream_disconnects = default_f_active;
914 }
915
916 void
917 echo_process_uri (echo_main_t * em)
918 {
919   unformat_input_t _input, *input = &_input;
920   u32 port;
921   unformat_init_string (input, (char *) em->uri, strlen ((char *) em->uri));
922   if (unformat
923       (input, "%U://%U/%d", unformat_transport_proto,
924        &em->uri_elts.transport_proto, unformat_ip4_address,
925        &em->uri_elts.ip.ip4, &port))
926     em->uri_elts.is_ip4 = 1;
927   else
928     if (unformat
929         (input, "%U://%U/%d", unformat_transport_proto,
930          &em->uri_elts.transport_proto, unformat_ip6_address,
931          &em->uri_elts.ip.ip6, &port))
932     em->uri_elts.is_ip4 = 0;
933   else
934     ECHO_FAIL (ECHO_FAIL_INVALID_URI, "Unable to process uri");
935   em->uri_elts.port = clib_host_to_net_u16 (port);
936   unformat_free (input);
937 }
938
939 static void __clib_constructor
940 vpp_echo_init ()
941 {
942   /* init memory before proto register themselves */
943   echo_main_t *em = &echo_main;
944   clib_mem_init_thread_safe (0, 256 << 20);
945   clib_memset (em, 0, sizeof (*em));
946 }
947
948 int
949 main (int argc, char **argv)
950 {
951   echo_main_t *em = &echo_main;
952   fifo_segment_main_t *sm = &em->segment_main;
953   char *app_name;
954   u64 i;
955   svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
956   u32 rpc_queue_size = 64 << 10;
957
958   em->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
959   clib_spinlock_init (&em->sid_vpp_handles_lock);
960   em->shared_segment_handles = hash_create (0, sizeof (uword));
961   clib_spinlock_init (&em->segment_handles_lock);
962   em->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
963   em->use_sock_api = 1;
964   em->fifo_size = 64 << 10;
965   em->n_clients = 1;
966   em->n_connects = 1;
967   em->n_sessions = 2;
968   em->max_test_msg = 50;
969   em->time_to_stop = 0;
970   em->i_am_master = 1;
971   em->n_rx_threads = 4;
972   em->test_return_packets = RETURN_PACKETS_NOTEST;
973   em->timing.start_event = ECHO_EVT_FIRST_QCONNECT;
974   em->timing.end_event = ECHO_EVT_LAST_BYTE;
975   em->bytes_to_receive = ~0;    /* defaulted when we know if server/client */
976   em->bytes_to_send = ~0;       /* defaulted when we know if server/client */
977   em->rx_buf_size = 1 << 20;
978   em->tx_buf_size = 1 << 20;
979   em->data_source = ECHO_INVALID_DATA_SOURCE;
980   em->uri = format (0, "%s%c", "tcp://0.0.0.0/1234", 0);
981   echo_set_each_proto_defaults_before_opts (em);
982   echo_process_opts (argc, argv);
983   echo_process_uri (em);
984   em->proto_cb_vft = em->available_proto_cb_vft[em->uri_elts.transport_proto];
985   if (!em->proto_cb_vft)
986     {
987       ECHO_FAIL (ECHO_FAIL_PROTOCOL_NOT_SUPPORTED,
988                  "Protocol %U is not supported",
989                  format_transport_proto, em->uri_elts.transport_proto);
990       goto exit_on_error;
991     }
992   if (em->proto_cb_vft->set_defaults_after_opts_cb)
993     em->proto_cb_vft->set_defaults_after_opts_cb ();
994
995   vec_validate (em->data_thread_handles, em->n_rx_threads);
996   vec_validate (em->data_thread_args, em->n_clients);
997   for (i = 0; i < em->n_clients; i++)
998     em->data_thread_args[i] = SESSION_INVALID_INDEX;
999   clib_time_init (&em->clib_time);
1000   init_error_string_table ();
1001   fifo_segment_main_init (sm, HIGH_SEGMENT_BASEVA, 20);
1002   vec_validate (em->connect_test_data, em->tx_buf_size);
1003   for (i = 0; i < em->tx_buf_size; i++)
1004     em->connect_test_data[i] = i & 0xff;
1005
1006   /* *INDENT-OFF* */
1007   svm_msg_q_ring_cfg_t rc[1] = {
1008     {rpc_queue_size, sizeof (echo_rpc_msg_t), 0},
1009   };
1010   /* *INDENT-ON* */
1011   cfg->consumer_pid = getpid ();
1012   cfg->n_rings = 1;
1013   cfg->q_nitems = rpc_queue_size;
1014   cfg->ring_cfgs = rc;
1015   em->rpc_msq_queue = svm_msg_q_alloc (cfg);
1016
1017   signal (SIGINT, stop_signal);
1018   signal (SIGQUIT, stop_signal);
1019   signal (SIGTERM, stop_signal);
1020   echo_api_hookup (em);
1021
1022   app_name = em->i_am_master ? "echo_server" : "echo_client";
1023   if (connect_to_vpp (app_name))
1024     {
1025       svm_region_exit ();
1026       ECHO_FAIL (ECHO_FAIL_CONNECT_TO_VPP, "Couldn't connect to vpp");
1027       goto exit_on_error;
1028     }
1029
1030   echo_session_prealloc (em);
1031   echo_notify_event (em, ECHO_EVT_START);
1032
1033   echo_send_attach (em);
1034   if (wait_for_state_change (em, STATE_ATTACHED, TIMEOUT))
1035     {
1036       ECHO_FAIL (ECHO_FAIL_ATTACH_TO_VPP,
1037                  "Couldn't attach to vpp, did you run <session enable> ?");
1038       goto exit_on_error;
1039     }
1040   if (pthread_create (&em->mq_thread_handle,
1041                       NULL /*attr */ , echo_mq_thread_fn, 0))
1042     {
1043       ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE, "pthread create errored");
1044       goto exit_on_error;
1045     }
1046   for (i = 0; i < em->n_rx_threads; i++)
1047     if (pthread_create (&em->data_thread_handles[i],
1048                         NULL /*attr */ , echo_data_thread_fn, (void *) i))
1049       {
1050         ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE,
1051                    "pthread create errored (index %d)", i);
1052         goto exit_on_error;
1053       }
1054   if (em->i_am_master)
1055     server_run (em);
1056   else
1057     clients_run (em);
1058   echo_notify_event (em, ECHO_EVT_EXIT);
1059   echo_free_sessions (em);
1060   echo_assert_test_suceeded (em);
1061   echo_send_detach (em);
1062   if (wait_for_state_change (em, STATE_DETACHED, TIMEOUT))
1063     {
1064       ECHO_FAIL (ECHO_FAIL_DETACH, "Couldn't detach from vpp");
1065       goto exit_on_error;
1066     }
1067   int *rv;
1068   pthread_join (em->mq_thread_handle, (void **) &rv);
1069   if (rv)
1070     {
1071       ECHO_FAIL (ECHO_FAIL_MQ_PTHREAD, "mq pthread errored %d", rv);
1072       goto exit_on_error;
1073     }
1074   if (em->use_sock_api)
1075     vl_socket_client_disconnect ();
1076   else
1077     vl_client_disconnect_from_vlib ();
1078 exit_on_error:
1079   ECHO_LOG (0, "Test complete !\n");
1080   if (em->output_json)
1081     print_global_json_stats (em);
1082   else
1083     print_global_stats (em);
1084   vec_free (em->fail_descr);
1085   exit (em->has_failed);
1086 }
1087
1088 /*
1089  * fd.io coding-style-patch-verification: ON
1090  *
1091  * Local Variables:
1092  * eval: (c-set-style "gnu")
1093  * End:
1094  */