session: segment handle in accept/connect notifications
[vpp.git] / src / vnet / session-apps / echo_client.c
1 /*
2  * echo_client.c - vpp built-in echo client code
3  *
4  * Copyright (c) 2017 by Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #include <vnet/vnet.h>
19 #include <vlibapi/api.h>
20 #include <vlibmemory/api.h>
21 #include <vnet/session-apps/echo_client.h>
22
23 echo_client_main_t echo_client_main;
24
25 #define ECHO_CLIENT_DBG (0)
26
27 static void
28 signal_evt_to_cli_i (int *code)
29 {
30   echo_client_main_t *ecm = &echo_client_main;
31   ASSERT (vlib_get_thread_index () == 0);
32   vlib_process_signal_event (ecm->vlib_main, ecm->cli_node_index, *code, 0);
33 }
34
35 static void
36 signal_evt_to_cli (int code)
37 {
38   if (vlib_get_thread_index () != 0)
39     vl_api_rpc_call_main_thread (signal_evt_to_cli_i, (u8 *) & code,
40                                  sizeof (code));
41   else
42     signal_evt_to_cli_i (&code);
43 }
44
45 static void
46 send_data_chunk (echo_client_main_t * ecm, eclient_session_t * s)
47 {
48   u8 *test_data = ecm->connect_test_data;
49   int test_buf_len, test_buf_offset, rv;
50   u32 bytes_this_chunk;
51
52   test_buf_len = vec_len (test_data);
53   ASSERT (test_buf_len > 0);
54   test_buf_offset = s->bytes_sent % test_buf_len;
55   bytes_this_chunk = clib_min (test_buf_len - test_buf_offset,
56                                s->bytes_to_send);
57
58   if (!ecm->is_dgram)
59     {
60       if (ecm->no_copy)
61         {
62           svm_fifo_t *f = s->data.tx_fifo;
63           rv = clib_min (svm_fifo_max_enqueue (f), bytes_this_chunk);
64           svm_fifo_enqueue_nocopy (f, rv);
65           session_send_io_evt_to_thread_custom (f, s->thread_index,
66                                                 FIFO_EVENT_APP_TX);
67         }
68       else
69         rv = app_send_stream (&s->data, test_data + test_buf_offset,
70                               bytes_this_chunk, 0);
71     }
72   else
73     {
74       if (ecm->no_copy)
75         {
76           session_dgram_hdr_t hdr;
77           svm_fifo_t *f = s->data.tx_fifo;
78           app_session_transport_t *at = &s->data.transport;
79           u32 max_enqueue = svm_fifo_max_enqueue (f);
80
81           if (max_enqueue <= sizeof (session_dgram_hdr_t))
82             return;
83
84           max_enqueue -= sizeof (session_dgram_hdr_t);
85           rv = clib_min (max_enqueue, bytes_this_chunk);
86
87           hdr.data_length = rv;
88           hdr.data_offset = 0;
89           clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip,
90                             sizeof (ip46_address_t));
91           hdr.is_ip4 = at->is_ip4;
92           hdr.rmt_port = at->rmt_port;
93           clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip,
94                             sizeof (ip46_address_t));
95           hdr.lcl_port = at->lcl_port;
96           svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
97           svm_fifo_enqueue_nocopy (f, rv);
98           session_send_io_evt_to_thread_custom (f, s->thread_index,
99                                                 FIFO_EVENT_APP_TX);
100         }
101       else
102         rv = app_send_dgram (&s->data, test_data + test_buf_offset,
103                              bytes_this_chunk, 0);
104     }
105
106   /* If we managed to enqueue data... */
107   if (rv > 0)
108     {
109       /* Account for it... */
110       s->bytes_to_send -= rv;
111       s->bytes_sent += rv;
112
113       if (ECHO_CLIENT_DBG)
114         {
115           /* *INDENT-OFF* */
116           ELOG_TYPE_DECLARE (e) =
117             {
118               .format = "tx-enq: xfer %d bytes, sent %u remain %u",
119               .format_args = "i4i4i4",
120             };
121           /* *INDENT-ON* */
122           struct
123           {
124             u32 data[3];
125           } *ed;
126           ed = ELOG_DATA (&vlib_global_main.elog_main, e);
127           ed->data[0] = rv;
128           ed->data[1] = s->bytes_sent;
129           ed->data[2] = s->bytes_to_send;
130         }
131     }
132 }
133
134 static void
135 receive_data_chunk (echo_client_main_t * ecm, eclient_session_t * s)
136 {
137   svm_fifo_t *rx_fifo = s->data.rx_fifo;
138   u32 thread_index = vlib_get_thread_index ();
139   int n_read, i;
140
141   if (ecm->test_bytes)
142     {
143       if (!ecm->is_dgram)
144         n_read = app_recv_stream (&s->data, ecm->rx_buf[thread_index],
145                                   vec_len (ecm->rx_buf[thread_index]));
146       else
147         n_read = app_recv_dgram (&s->data, ecm->rx_buf[thread_index],
148                                  vec_len (ecm->rx_buf[thread_index]));
149     }
150   else
151     {
152       n_read = svm_fifo_max_dequeue (rx_fifo);
153       svm_fifo_dequeue_drop (rx_fifo, n_read);
154     }
155
156   if (n_read > 0)
157     {
158       if (ECHO_CLIENT_DBG)
159         {
160           /* *INDENT-OFF* */
161           ELOG_TYPE_DECLARE (e) =
162             {
163               .format = "rx-deq: %d bytes",
164               .format_args = "i4",
165             };
166           /* *INDENT-ON* */
167           struct
168           {
169             u32 data[1];
170           } *ed;
171           ed = ELOG_DATA (&vlib_global_main.elog_main, e);
172           ed->data[0] = n_read;
173         }
174
175       if (ecm->test_bytes)
176         {
177           for (i = 0; i < n_read; i++)
178             {
179               if (ecm->rx_buf[thread_index][i]
180                   != ((s->bytes_received + i) & 0xff))
181                 {
182                   clib_warning ("read %d error at byte %lld, 0x%x not 0x%x",
183                                 n_read, s->bytes_received + i,
184                                 ecm->rx_buf[thread_index][i],
185                                 ((s->bytes_received + i) & 0xff));
186                   ecm->test_failed = 1;
187                 }
188             }
189         }
190       ASSERT (n_read <= s->bytes_to_receive);
191       s->bytes_to_receive -= n_read;
192       s->bytes_received += n_read;
193     }
194 }
195
196 static uword
197 echo_client_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
198                      vlib_frame_t * frame)
199 {
200   echo_client_main_t *ecm = &echo_client_main;
201   int my_thread_index = vlib_get_thread_index ();
202   eclient_session_t *sp;
203   int i;
204   int delete_session;
205   u32 *connection_indices;
206   u32 *connections_this_batch;
207   u32 nconnections_this_batch;
208
209   connection_indices = ecm->connection_index_by_thread[my_thread_index];
210   connections_this_batch =
211     ecm->connections_this_batch_by_thread[my_thread_index];
212
213   if ((ecm->run_test != ECHO_CLIENTS_RUNNING) ||
214       ((vec_len (connection_indices) == 0)
215        && vec_len (connections_this_batch) == 0))
216     return 0;
217
218   /* Grab another pile of connections */
219   if (PREDICT_FALSE (vec_len (connections_this_batch) == 0))
220     {
221       nconnections_this_batch =
222         clib_min (ecm->connections_per_batch, vec_len (connection_indices));
223
224       ASSERT (nconnections_this_batch > 0);
225       vec_validate (connections_this_batch, nconnections_this_batch - 1);
226       clib_memcpy_fast (connections_this_batch,
227                         connection_indices + vec_len (connection_indices)
228                         - nconnections_this_batch,
229                         nconnections_this_batch * sizeof (u32));
230       _vec_len (connection_indices) -= nconnections_this_batch;
231     }
232
233   if (PREDICT_FALSE (ecm->prev_conns != ecm->connections_per_batch
234                      && ecm->prev_conns == vec_len (connections_this_batch)))
235     {
236       ecm->repeats++;
237       ecm->prev_conns = vec_len (connections_this_batch);
238       if (ecm->repeats == 500000)
239         {
240           clib_warning ("stuck clients");
241         }
242     }
243   else
244     {
245       ecm->prev_conns = vec_len (connections_this_batch);
246       ecm->repeats = 0;
247     }
248
249   for (i = 0; i < vec_len (connections_this_batch); i++)
250     {
251       delete_session = 1;
252
253       sp = pool_elt_at_index (ecm->sessions, connections_this_batch[i]);
254
255       if (sp->bytes_to_send > 0)
256         {
257           send_data_chunk (ecm, sp);
258           delete_session = 0;
259         }
260       if (sp->bytes_to_receive > 0)
261         {
262           delete_session = 0;
263         }
264       if (PREDICT_FALSE (delete_session == 1))
265         {
266           stream_session_t *s;
267
268           clib_atomic_fetch_add (&ecm->tx_total, sp->bytes_sent);
269           clib_atomic_fetch_add (&ecm->rx_total, sp->bytes_received);
270           s = session_get_from_handle_if_valid (sp->vpp_session_handle);
271
272           if (s)
273             {
274               vnet_disconnect_args_t _a, *a = &_a;
275               a->handle = session_handle (s);
276               a->app_index = ecm->app_index;
277               vnet_disconnect_session (a);
278
279               vec_delete (connections_this_batch, 1, i);
280               i--;
281               clib_atomic_fetch_add (&ecm->ready_connections, -1);
282             }
283           else
284             {
285               clib_warning ("session AWOL?");
286               vec_delete (connections_this_batch, 1, i);
287             }
288
289           /* Kick the debug CLI process */
290           if (ecm->ready_connections == 0)
291             {
292               signal_evt_to_cli (2);
293             }
294         }
295     }
296
297   ecm->connection_index_by_thread[my_thread_index] = connection_indices;
298   ecm->connections_this_batch_by_thread[my_thread_index] =
299     connections_this_batch;
300   return 0;
301 }
302
303 /* *INDENT-OFF* */
304 VLIB_REGISTER_NODE (echo_clients_node) =
305 {
306   .function = echo_client_node_fn,
307   .name = "echo-clients",
308   .type = VLIB_NODE_TYPE_INPUT,
309   .state = VLIB_NODE_STATE_DISABLED,
310 };
311 /* *INDENT-ON* */
312
313 static int
314 create_api_loopback (echo_client_main_t * ecm)
315 {
316   api_main_t *am = &api_main;
317   vl_shmem_hdr_t *shmem_hdr;
318
319   shmem_hdr = am->shmem_hdr;
320   ecm->vl_input_queue = shmem_hdr->vl_input_queue;
321   ecm->my_client_index = vl_api_memclnt_create_internal ("echo_client",
322                                                          ecm->vl_input_queue);
323   return 0;
324 }
325
326 static int
327 echo_clients_init (vlib_main_t * vm)
328 {
329   echo_client_main_t *ecm = &echo_client_main;
330   vlib_thread_main_t *vtm = vlib_get_thread_main ();
331   u32 num_threads;
332   int i;
333
334   if (create_api_loopback (ecm))
335     return -1;
336
337   num_threads = 1 /* main thread */  + vtm->n_threads;
338
339   /* Init test data. Big buffer */
340   vec_validate (ecm->connect_test_data, 4 * 1024 * 1024 - 1);
341   for (i = 0; i < vec_len (ecm->connect_test_data); i++)
342     ecm->connect_test_data[i] = i & 0xff;
343
344   vec_validate (ecm->rx_buf, num_threads - 1);
345   for (i = 0; i < num_threads; i++)
346     vec_validate (ecm->rx_buf[i], vec_len (ecm->connect_test_data) - 1);
347
348   ecm->is_init = 1;
349
350   vec_validate (ecm->connection_index_by_thread, vtm->n_vlib_mains);
351   vec_validate (ecm->connections_this_batch_by_thread, vtm->n_vlib_mains);
352   vec_validate (ecm->vpp_event_queue, vtm->n_vlib_mains);
353
354   return 0;
355 }
356
357 static int
358 echo_clients_session_connected_callback (u32 app_index, u32 api_context,
359                                          stream_session_t * s, u8 is_fail)
360 {
361   echo_client_main_t *ecm = &echo_client_main;
362   eclient_session_t *session;
363   u32 session_index;
364   u8 thread_index;
365
366   if (PREDICT_FALSE (ecm->run_test != ECHO_CLIENTS_STARTING))
367     return -1;
368
369   if (is_fail)
370     {
371       clib_warning ("connection %d failed!", api_context);
372       ecm->run_test = ECHO_CLIENTS_EXITING;
373       signal_evt_to_cli (-1);
374       return 0;
375     }
376
377   thread_index = s->thread_index;
378   ASSERT (thread_index == vlib_get_thread_index ()
379           || session_transport_service_type (s) == TRANSPORT_SERVICE_CL);
380
381   if (!ecm->vpp_event_queue[thread_index])
382     ecm->vpp_event_queue[thread_index] =
383       session_manager_get_vpp_event_queue (thread_index);
384
385   /*
386    * Setup session
387    */
388   clib_spinlock_lock_if_init (&ecm->sessions_lock);
389   pool_get (ecm->sessions, session);
390   clib_spinlock_unlock_if_init (&ecm->sessions_lock);
391
392   clib_memset (session, 0, sizeof (*session));
393   session_index = session - ecm->sessions;
394   session->bytes_to_send = ecm->bytes_to_send;
395   session->bytes_to_receive = ecm->no_return ? 0ULL : ecm->bytes_to_send;
396   session->data.rx_fifo = s->server_rx_fifo;
397   session->data.rx_fifo->client_session_index = session_index;
398   session->data.tx_fifo = s->server_tx_fifo;
399   session->data.tx_fifo->client_session_index = session_index;
400   session->data.vpp_evt_q = ecm->vpp_event_queue[thread_index];
401   session->vpp_session_handle = session_handle (s);
402
403   if (ecm->is_dgram)
404     {
405       transport_connection_t *tc;
406       tc = session_get_transport (s);
407       clib_memcpy_fast (&session->data.transport, tc,
408                         sizeof (session->data.transport));
409       session->data.is_dgram = 1;
410     }
411
412   vec_add1 (ecm->connection_index_by_thread[thread_index], session_index);
413   clib_atomic_fetch_add (&ecm->ready_connections, 1);
414   if (ecm->ready_connections == ecm->expected_connections)
415     {
416       ecm->run_test = ECHO_CLIENTS_RUNNING;
417       /* Signal the CLI process that the action is starting... */
418       signal_evt_to_cli (1);
419     }
420
421   return 0;
422 }
423
424 static void
425 echo_clients_session_reset_callback (stream_session_t * s)
426 {
427   if (s->session_state == SESSION_STATE_READY)
428     clib_warning ("Reset active connection %U", format_stream_session, s, 2);
429   stream_session_cleanup (s);
430   return;
431 }
432
433 static int
434 echo_clients_session_create_callback (stream_session_t * s)
435 {
436   return 0;
437 }
438
439 static void
440 echo_clients_session_disconnect_callback (stream_session_t * s)
441 {
442   echo_client_main_t *ecm = &echo_client_main;
443   vnet_disconnect_args_t _a, *a = &_a;
444   a->handle = session_handle (s);
445   a->app_index = ecm->app_index;
446   vnet_disconnect_session (a);
447   return;
448 }
449
450 void
451 echo_clients_session_disconnect (stream_session_t * s)
452 {
453   echo_client_main_t *ecm = &echo_client_main;
454   vnet_disconnect_args_t _a, *a = &_a;
455   a->handle = session_handle (s);
456   a->app_index = ecm->app_index;
457   vnet_disconnect_session (a);
458 }
459
460 static int
461 echo_clients_rx_callback (stream_session_t * s)
462 {
463   echo_client_main_t *ecm = &echo_client_main;
464   eclient_session_t *sp;
465
466   if (PREDICT_FALSE (ecm->run_test != ECHO_CLIENTS_RUNNING))
467     {
468       echo_clients_session_disconnect (s);
469       return -1;
470     }
471
472   sp = pool_elt_at_index (ecm->sessions,
473                           s->server_rx_fifo->client_session_index);
474   receive_data_chunk (ecm, sp);
475
476   if (svm_fifo_max_dequeue (s->server_rx_fifo))
477     {
478       if (svm_fifo_set_event (s->server_rx_fifo))
479         session_send_io_evt_to_thread (s->server_rx_fifo,
480                                        FIFO_EVENT_BUILTIN_RX);
481     }
482   return 0;
483 }
484
485 int
486 echo_client_add_segment_callback (u32 client_index, u64 segment_handle)
487 {
488   /* New heaps may be added */
489   return 0;
490 }
491
492 /* *INDENT-OFF* */
493 static session_cb_vft_t echo_clients = {
494   .session_reset_callback = echo_clients_session_reset_callback,
495   .session_connected_callback = echo_clients_session_connected_callback,
496   .session_accept_callback = echo_clients_session_create_callback,
497   .session_disconnect_callback = echo_clients_session_disconnect_callback,
498   .builtin_app_rx_callback = echo_clients_rx_callback,
499   .add_segment_callback = echo_client_add_segment_callback
500 };
501 /* *INDENT-ON* */
502
503 static clib_error_t *
504 echo_clients_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
505 {
506   u32 prealloc_fifos, segment_size = 256 << 20;
507   echo_client_main_t *ecm = &echo_client_main;
508   vnet_app_attach_args_t _a, *a = &_a;
509   u64 options[16];
510   clib_error_t *error = 0;
511
512   clib_memset (a, 0, sizeof (*a));
513   clib_memset (options, 0, sizeof (options));
514
515   a->api_client_index = ecm->my_client_index;
516   a->session_cb_vft = &echo_clients;
517
518   prealloc_fifos = ecm->prealloc_fifos ? ecm->expected_connections : 1;
519
520   if (ecm->private_segment_size)
521     segment_size = ecm->private_segment_size;
522
523   options[APP_OPTIONS_ACCEPT_COOKIE] = 0x12345678;
524   options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
525   options[APP_OPTIONS_ADD_SEGMENT_SIZE] = segment_size;
526   options[APP_OPTIONS_RX_FIFO_SIZE] = ecm->fifo_size;
527   options[APP_OPTIONS_TX_FIFO_SIZE] = ecm->fifo_size;
528   options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = ecm->private_segment_count;
529   options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = prealloc_fifos;
530   options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
531   options[APP_OPTIONS_TLS_ENGINE] = ecm->tls_engine;
532   if (appns_id)
533     {
534       options[APP_OPTIONS_FLAGS] |= appns_flags;
535       options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
536     }
537   a->options = options;
538   a->namespace_id = appns_id;
539
540   if ((error = vnet_application_attach (a)))
541     return error;
542
543   ecm->app_index = a->app_index;
544   return 0;
545 }
546
547 static int
548 echo_clients_detach ()
549 {
550   echo_client_main_t *ecm = &echo_client_main;
551   vnet_app_detach_args_t _da, *da = &_da;
552   int rv;
553
554   da->app_index = ecm->app_index;
555   rv = vnet_application_detach (da);
556   ecm->test_client_attached = 0;
557   ecm->app_index = ~0;
558   return rv;
559 }
560
561 static void *
562 echo_client_thread_fn (void *arg)
563 {
564   return 0;
565 }
566
567 /** Start a transmit thread */
568 int
569 echo_clients_start_tx_pthread (echo_client_main_t * ecm)
570 {
571   if (ecm->client_thread_handle == 0)
572     {
573       int rv = pthread_create (&ecm->client_thread_handle,
574                                NULL /*attr */ ,
575                                echo_client_thread_fn, 0);
576       if (rv)
577         {
578           ecm->client_thread_handle = 0;
579           return -1;
580         }
581     }
582   return 0;
583 }
584
585 clib_error_t *
586 echo_clients_connect (vlib_main_t * vm, u32 n_clients)
587 {
588   echo_client_main_t *ecm = &echo_client_main;
589   vnet_connect_args_t _a, *a = &_a;
590   clib_error_t *error = 0;
591   int i;
592
593   clib_memset (a, 0, sizeof (*a));
594   for (i = 0; i < n_clients; i++)
595     {
596       a->uri = (char *) ecm->connect_uri;
597       a->api_context = i;
598       a->app_index = ecm->app_index;
599
600       if ((error = vnet_connect_uri (a)))
601         return error;
602
603       /* Crude pacing for call setups  */
604       if ((i % 4) == 0)
605         vlib_process_suspend (vm, 10e-6);
606       ASSERT (i + 1 >= ecm->ready_connections);
607       while (i + 1 - ecm->ready_connections > 1000)
608         {
609           vlib_process_suspend (vm, 100e-6);
610         }
611     }
612   return 0;
613 }
614
615 #define ec_cli_output(_fmt, _args...)                   \
616   if (!ecm->no_output)                                  \
617     vlib_cli_output(vm, _fmt, ##_args)
618
619 static clib_error_t *
620 echo_clients_command_fn (vlib_main_t * vm,
621                          unformat_input_t * input, vlib_cli_command_t * cmd)
622 {
623   echo_client_main_t *ecm = &echo_client_main;
624   vlib_thread_main_t *thread_main = vlib_get_thread_main ();
625   u64 tmp, total_bytes, appns_flags = 0, appns_secret = 0;
626   f64 test_timeout = 20.0, syn_timeout = 20.0, delta;
627   char *default_uri = "tcp://6.0.1.1/1234";
628   uword *event_data = 0, event_type;
629   f64 time_before_connects;
630   u32 n_clients = 1;
631   int preallocate_sessions = 0;
632   char *transfer_type;
633   clib_error_t *error = 0;
634   u8 *appns_id = 0;
635   int i;
636
637   ecm->bytes_to_send = 8192;
638   ecm->no_return = 0;
639   ecm->fifo_size = 64 << 10;
640   ecm->connections_per_batch = 1000;
641   ecm->private_segment_count = 0;
642   ecm->private_segment_size = 0;
643   ecm->no_output = 0;
644   ecm->test_bytes = 0;
645   ecm->test_failed = 0;
646   ecm->vlib_main = vm;
647   ecm->tls_engine = TLS_ENGINE_OPENSSL;
648   ecm->no_copy = 0;
649   ecm->run_test = ECHO_CLIENTS_STARTING;
650
651   if (thread_main->n_vlib_mains > 1)
652     clib_spinlock_init (&ecm->sessions_lock);
653   vec_free (ecm->connect_uri);
654
655   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
656     {
657       if (unformat (input, "uri %s", &ecm->connect_uri))
658         ;
659       else if (unformat (input, "nclients %d", &n_clients))
660         ;
661       else if (unformat (input, "mbytes %lld", &tmp))
662         ecm->bytes_to_send = tmp << 20;
663       else if (unformat (input, "gbytes %lld", &tmp))
664         ecm->bytes_to_send = tmp << 30;
665       else if (unformat (input, "bytes %lld", &ecm->bytes_to_send))
666         ;
667       else if (unformat (input, "test-timeout %f", &test_timeout))
668         ;
669       else if (unformat (input, "syn-timeout %f", &syn_timeout))
670         ;
671       else if (unformat (input, "no-return"))
672         ecm->no_return = 1;
673       else if (unformat (input, "fifo-size %d", &ecm->fifo_size))
674         ecm->fifo_size <<= 10;
675       else if (unformat (input, "private-segment-count %d",
676                          &ecm->private_segment_count))
677         ;
678       else if (unformat (input, "private-segment-size %U",
679                          unformat_memory_size, &tmp))
680         {
681           if (tmp >= 0x100000000ULL)
682             return clib_error_return
683               (0, "private segment size %lld (%llu) too large", tmp, tmp);
684           ecm->private_segment_size = tmp;
685         }
686       else if (unformat (input, "preallocate-fifos"))
687         ecm->prealloc_fifos = 1;
688       else if (unformat (input, "preallocate-sessions"))
689         preallocate_sessions = 1;
690       else
691         if (unformat (input, "client-batch %d", &ecm->connections_per_batch))
692         ;
693       else if (unformat (input, "appns %_%v%_", &appns_id))
694         ;
695       else if (unformat (input, "all-scope"))
696         appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
697                         | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
698       else if (unformat (input, "local-scope"))
699         appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
700       else if (unformat (input, "global-scope"))
701         appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
702       else if (unformat (input, "secret %lu", &appns_secret))
703         ;
704       else if (unformat (input, "no-output"))
705         ecm->no_output = 1;
706       else if (unformat (input, "test-bytes"))
707         ecm->test_bytes = 1;
708       else if (unformat (input, "tls-engine %d", &ecm->tls_engine))
709         ;
710       else
711         return clib_error_return (0, "failed: unknown input `%U'",
712                                   format_unformat_error, input);
713     }
714
715   /* Store cli process node index for signalling */
716   ecm->cli_node_index =
717     vlib_get_current_process (vm)->node_runtime.node_index;
718
719   if (ecm->is_init == 0)
720     {
721       if (echo_clients_init (vm))
722         return clib_error_return (0, "failed init");
723     }
724
725
726   ecm->ready_connections = 0;
727   ecm->expected_connections = n_clients;
728   ecm->rx_total = 0;
729   ecm->tx_total = 0;
730
731   if (!ecm->connect_uri)
732     {
733       clib_warning ("No uri provided. Using default: %s", default_uri);
734       ecm->connect_uri = format (0, "%s%c", default_uri, 0);
735     }
736
737   if (ecm->connect_uri[0] == 'u' && ecm->connect_uri[3] != 'c')
738     ecm->is_dgram = 1;
739
740 #if ECHO_CLIENT_PTHREAD
741   echo_clients_start_tx_pthread ();
742 #endif
743
744   vlib_worker_thread_barrier_sync (vm);
745   vnet_session_enable_disable (vm, 1 /* turn on session and transports */ );
746   vlib_worker_thread_barrier_release (vm);
747
748   if (ecm->test_client_attached == 0)
749     {
750       if ((error = echo_clients_attach (appns_id, appns_flags, appns_secret)))
751         {
752           vec_free (appns_id);
753           clib_error_report (error);
754           return error;
755         }
756       vec_free (appns_id);
757     }
758   ecm->test_client_attached = 1;
759
760   /* Turn on the builtin client input nodes */
761   for (i = 0; i < thread_main->n_vlib_mains; i++)
762     vlib_node_set_state (vlib_mains[i], echo_clients_node.index,
763                          VLIB_NODE_STATE_POLLING);
764
765   if (preallocate_sessions)
766     pool_init_fixed (ecm->sessions, 1.1 * n_clients);
767
768   /* Fire off connect requests */
769   time_before_connects = vlib_time_now (vm);
770   if ((error = echo_clients_connect (vm, n_clients)))
771     goto cleanup;
772
773   /* Park until the sessions come up, or ten seconds elapse... */
774   vlib_process_wait_for_event_or_clock (vm, syn_timeout);
775   event_type = vlib_process_get_events (vm, &event_data);
776   switch (event_type)
777     {
778     case ~0:
779       ec_cli_output ("Timeout with only %d sessions active...",
780                      ecm->ready_connections);
781       error = clib_error_return (0, "failed: syn timeout with %d sessions",
782                                  ecm->ready_connections);
783       goto cleanup;
784
785     case 1:
786       delta = vlib_time_now (vm) - time_before_connects;
787       if (delta != 0.0)
788         ec_cli_output ("%d three-way handshakes in %.2f seconds %.2f/s",
789                        n_clients, delta, ((f64) n_clients) / delta);
790
791       ecm->test_start_time = vlib_time_now (ecm->vlib_main);
792       ec_cli_output ("Test started at %.6f", ecm->test_start_time);
793       break;
794
795     default:
796       ec_cli_output ("unexpected event(1): %d", event_type);
797       error = clib_error_return (0, "failed: unexpected event(1): %d",
798                                  event_type);
799       goto cleanup;
800     }
801
802   /* Now wait for the sessions to finish... */
803   vlib_process_wait_for_event_or_clock (vm, test_timeout);
804   event_type = vlib_process_get_events (vm, &event_data);
805   switch (event_type)
806     {
807     case ~0:
808       ec_cli_output ("Timeout with %d sessions still active...",
809                      ecm->ready_connections);
810       error = clib_error_return (0, "failed: timeout with %d sessions",
811                                  ecm->ready_connections);
812       goto cleanup;
813
814     case 2:
815       ecm->test_end_time = vlib_time_now (vm);
816       ec_cli_output ("Test finished at %.6f", ecm->test_end_time);
817       break;
818
819     default:
820       ec_cli_output ("unexpected event(2): %d", event_type);
821       error = clib_error_return (0, "failed: unexpected event(2): %d",
822                                  event_type);
823       goto cleanup;
824     }
825
826   delta = ecm->test_end_time - ecm->test_start_time;
827   if (delta != 0.0)
828     {
829       total_bytes = (ecm->no_return ? ecm->tx_total : ecm->rx_total);
830       transfer_type = ecm->no_return ? "half-duplex" : "full-duplex";
831       ec_cli_output ("%lld bytes (%lld mbytes, %lld gbytes) in %.2f seconds",
832                      total_bytes, total_bytes / (1ULL << 20),
833                      total_bytes / (1ULL << 30), delta);
834       ec_cli_output ("%.2f bytes/second %s", ((f64) total_bytes) / (delta),
835                      transfer_type);
836       ec_cli_output ("%.4f gbit/second %s",
837                      (((f64) total_bytes * 8.0) / delta / 1e9),
838                      transfer_type);
839     }
840   else
841     {
842       ec_cli_output ("zero delta-t?");
843       error = clib_error_return (0, "failed: zero delta-t");
844       goto cleanup;
845     }
846
847   if (ecm->test_bytes && ecm->test_failed)
848     error = clib_error_return (0, "failed: test bytes");
849
850 cleanup:
851   ecm->run_test = ECHO_CLIENTS_EXITING;
852   vlib_process_wait_for_event_or_clock (vm, 10e-3);
853   for (i = 0; i < vec_len (ecm->connection_index_by_thread); i++)
854     {
855       vec_reset_length (ecm->connection_index_by_thread[i]);
856       vec_reset_length (ecm->connections_this_batch_by_thread[i]);
857     }
858
859   pool_free (ecm->sessions);
860
861   /* Detach the application, so we can use different fifo sizes next time */
862   if (ecm->test_client_attached)
863     {
864       if (echo_clients_detach ())
865         {
866           error = clib_error_return (0, "failed: app detach");
867           ec_cli_output ("WARNING: app detach failed...");
868         }
869     }
870   if (error)
871     ec_cli_output ("test failed");
872   vec_free (ecm->connect_uri);
873   return error;
874 }
875
876 /* *INDENT-OFF* */
877 VLIB_CLI_COMMAND (echo_clients_command, static) =
878 {
879   .path = "test echo clients",
880   .short_help = "test echo clients [nclients %d][[m|g]bytes <bytes>]"
881       "[test-timeout <time>][syn-timeout <time>][no-return][fifo-size <size>]"
882       "[private-segment-count <count>][private-segment-size <bytes>[m|g]]"
883       "[preallocate-fifos][preallocate-sessions][client-batch <batch-size>]"
884       "[uri <tcp://ip/port>][test-bytes][no-output]",
885   .function = echo_clients_command_fn,
886   .is_mp_safe = 1,
887 };
888 /* *INDENT-ON* */
889
890 clib_error_t *
891 echo_clients_main_init (vlib_main_t * vm)
892 {
893   echo_client_main_t *ecm = &echo_client_main;
894   ecm->is_init = 0;
895   return 0;
896 }
897
898 VLIB_INIT_FUNCTION (echo_clients_main_init);
899
900 /*
901  * fd.io coding-style-patch-verification: ON
902  *
903  * Local Variables:
904  * eval: (c-set-style "gnu")
905  * End:
906  */