FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
echo_client.c
Go to the documentation of this file.
1 /*
2  * echo_client.c - vpp built-in echo client code
3  *
4  * Copyright (c) 2017-2019 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 <hs_apps/echo_client.h>
22 
24 
25 #define ECHO_CLIENT_DBG (0)
26 #define DBG(_fmt, _args...) \
27  if (ECHO_CLIENT_DBG) \
28  clib_warning (_fmt, ##_args)
29 
30 static void
32 {
34  ASSERT (vlib_get_thread_index () == 0);
35  vlib_process_signal_event (ecm->vlib_main, ecm->cli_node_index, *code, 0);
36 }
37 
38 static void
40 {
41  if (vlib_get_thread_index () != 0)
43  sizeof (code));
44  else
45  signal_evt_to_cli_i (&code);
46 }
47 
48 static void
50 {
51  u8 *test_data = ecm->connect_test_data;
52  int test_buf_len, test_buf_offset, rv;
53  u32 bytes_this_chunk;
54 
55  test_buf_len = vec_len (test_data);
56  ASSERT (test_buf_len > 0);
57  test_buf_offset = s->bytes_sent % test_buf_len;
58  bytes_this_chunk = clib_min (test_buf_len - test_buf_offset,
59  s->bytes_to_send);
60 
61  if (!ecm->is_dgram)
62  {
63  if (ecm->no_copy)
64  {
65  svm_fifo_t *f = s->data.tx_fifo;
66  rv = clib_min (svm_fifo_max_enqueue_prod (f), bytes_this_chunk);
68  session_send_io_evt_to_thread_custom (&f->master_session_index,
69  s->thread_index,
71  }
72  else
73  rv = app_send_stream (&s->data, test_data + test_buf_offset,
74  bytes_this_chunk, 0);
75  }
76  else
77  {
78  if (ecm->no_copy)
79  {
81  svm_fifo_t *f = s->data.tx_fifo;
82  app_session_transport_t *at = &s->data.transport;
83  u32 max_enqueue = svm_fifo_max_enqueue_prod (f);
84 
85  if (max_enqueue <= sizeof (session_dgram_hdr_t))
86  return;
87 
88  max_enqueue -= sizeof (session_dgram_hdr_t);
89  rv = clib_min (max_enqueue, bytes_this_chunk);
90 
91  hdr.data_length = rv;
92  hdr.data_offset = 0;
93  clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip,
94  sizeof (ip46_address_t));
95  hdr.is_ip4 = at->is_ip4;
96  hdr.rmt_port = at->rmt_port;
97  clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip,
98  sizeof (ip46_address_t));
99  hdr.lcl_port = at->lcl_port;
100  svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
101  svm_fifo_enqueue_nocopy (f, rv);
102  session_send_io_evt_to_thread_custom (&f->master_session_index,
103  s->thread_index,
105  }
106  else
107  rv = app_send_dgram (&s->data, test_data + test_buf_offset,
108  bytes_this_chunk, 0);
109  }
110 
111  /* If we managed to enqueue data... */
112  if (rv > 0)
113  {
114  /* Account for it... */
115  s->bytes_to_send -= rv;
116  s->bytes_sent += rv;
117 
118  if (ECHO_CLIENT_DBG)
119  {
120  /* *INDENT-OFF* */
121  ELOG_TYPE_DECLARE (e) =
122  {
123  .format = "tx-enq: xfer %d bytes, sent %u remain %u",
124  .format_args = "i4i4i4",
125  };
126  /* *INDENT-ON* */
127  struct
128  {
129  u32 data[3];
130  } *ed;
132  ed->data[0] = rv;
133  ed->data[1] = s->bytes_sent;
134  ed->data[2] = s->bytes_to_send;
135  }
136  }
137 }
138 
139 static void
141 {
142  svm_fifo_t *rx_fifo = s->data.rx_fifo;
143  u32 thread_index = vlib_get_thread_index ();
144  int n_read, i;
145 
146  if (ecm->test_bytes)
147  {
148  if (!ecm->is_dgram)
149  n_read = app_recv_stream (&s->data, ecm->rx_buf[thread_index],
150  vec_len (ecm->rx_buf[thread_index]));
151  else
152  n_read = app_recv_dgram (&s->data, ecm->rx_buf[thread_index],
153  vec_len (ecm->rx_buf[thread_index]));
154  }
155  else
156  {
157  n_read = svm_fifo_max_dequeue_cons (rx_fifo);
158  svm_fifo_dequeue_drop (rx_fifo, n_read);
159  }
160 
161  if (n_read > 0)
162  {
163  if (ECHO_CLIENT_DBG)
164  {
165  /* *INDENT-OFF* */
166  ELOG_TYPE_DECLARE (e) =
167  {
168  .format = "rx-deq: %d bytes",
169  .format_args = "i4",
170  };
171  /* *INDENT-ON* */
172  struct
173  {
174  u32 data[1];
175  } *ed;
177  ed->data[0] = n_read;
178  }
179 
180  if (ecm->test_bytes)
181  {
182  for (i = 0; i < n_read; i++)
183  {
184  if (ecm->rx_buf[thread_index][i]
185  != ((s->bytes_received + i) & 0xff))
186  {
187  clib_warning ("read %d error at byte %lld, 0x%x not 0x%x",
188  n_read, s->bytes_received + i,
189  ecm->rx_buf[thread_index][i],
190  ((s->bytes_received + i) & 0xff));
191  ecm->test_failed = 1;
192  }
193  }
194  }
195  ASSERT (n_read <= s->bytes_to_receive);
196  s->bytes_to_receive -= n_read;
197  s->bytes_received += n_read;
198  }
199 }
200 
201 static uword
203  vlib_frame_t * frame)
204 {
206  int my_thread_index = vlib_get_thread_index ();
207  eclient_session_t *sp;
208  int i;
209  int delete_session;
210  u32 *connection_indices;
211  u32 *connections_this_batch;
212  u32 nconnections_this_batch;
213 
214  connection_indices = ecm->connection_index_by_thread[my_thread_index];
215  connections_this_batch =
216  ecm->connections_this_batch_by_thread[my_thread_index];
217 
218  if ((ecm->run_test != ECHO_CLIENTS_RUNNING) ||
219  ((vec_len (connection_indices) == 0)
220  && vec_len (connections_this_batch) == 0))
221  return 0;
222 
223  /* Grab another pile of connections */
224  if (PREDICT_FALSE (vec_len (connections_this_batch) == 0))
225  {
226  nconnections_this_batch =
227  clib_min (ecm->connections_per_batch, vec_len (connection_indices));
228 
229  ASSERT (nconnections_this_batch > 0);
230  vec_validate (connections_this_batch, nconnections_this_batch - 1);
231  clib_memcpy_fast (connections_this_batch,
232  connection_indices + vec_len (connection_indices)
233  - nconnections_this_batch,
234  nconnections_this_batch * sizeof (u32));
235  _vec_len (connection_indices) -= nconnections_this_batch;
236  }
237 
239  && ecm->prev_conns == vec_len (connections_this_batch)))
240  {
241  ecm->repeats++;
242  ecm->prev_conns = vec_len (connections_this_batch);
243  if (ecm->repeats == 500000)
244  {
245  clib_warning ("stuck clients");
246  }
247  }
248  else
249  {
250  ecm->prev_conns = vec_len (connections_this_batch);
251  ecm->repeats = 0;
252  }
253 
254  for (i = 0; i < vec_len (connections_this_batch); i++)
255  {
256  delete_session = 1;
257 
258  sp = pool_elt_at_index (ecm->sessions, connections_this_batch[i]);
259 
260  if (sp->bytes_to_send > 0)
261  {
262  send_data_chunk (ecm, sp);
263  delete_session = 0;
264  }
265  if (sp->bytes_to_receive > 0)
266  {
267  delete_session = 0;
268  }
269  if (PREDICT_FALSE (delete_session == 1))
270  {
271  session_t *s;
272 
276 
277  if (s)
278  {
279  vnet_disconnect_args_t _a, *a = &_a;
280  a->handle = session_handle (s);
281  a->app_index = ecm->app_index;
283 
284  vec_delete (connections_this_batch, 1, i);
285  i--;
287  }
288  else
289  {
290  clib_warning ("session AWOL?");
291  vec_delete (connections_this_batch, 1, i);
292  }
293 
294  /* Kick the debug CLI process */
295  if (ecm->ready_connections == 0)
296  {
297  signal_evt_to_cli (2);
298  }
299  }
300  }
301 
302  ecm->connection_index_by_thread[my_thread_index] = connection_indices;
303  ecm->connections_this_batch_by_thread[my_thread_index] =
304  connections_this_batch;
305  return 0;
306 }
307 
308 /* *INDENT-OFF* */
310 {
311  .function = echo_client_node_fn,
312  .name = "echo-clients",
313  .type = VLIB_NODE_TYPE_INPUT,
314  .state = VLIB_NODE_STATE_DISABLED,
315 };
316 /* *INDENT-ON* */
317 
318 static int
320 {
321  api_main_t *am = &api_main;
322  vl_shmem_hdr_t *shmem_hdr;
323 
324  shmem_hdr = am->shmem_hdr;
325  ecm->vl_input_queue = shmem_hdr->vl_input_queue;
326  ecm->my_client_index = vl_api_memclnt_create_internal ("echo_client",
327  ecm->vl_input_queue);
328  return 0;
329 }
330 
331 static int
333 {
336  u32 num_threads;
337  int i;
338 
339  if (create_api_loopback (ecm))
340  return -1;
341 
342  num_threads = 1 /* main thread */ + vtm->n_threads;
343 
344  /* Init test data. Big buffer */
345  vec_validate (ecm->connect_test_data, 4 * 1024 * 1024 - 1);
346  for (i = 0; i < vec_len (ecm->connect_test_data); i++)
347  ecm->connect_test_data[i] = i & 0xff;
348 
349  vec_validate (ecm->rx_buf, num_threads - 1);
350  for (i = 0; i < num_threads; i++)
351  vec_validate (ecm->rx_buf[i], vec_len (ecm->connect_test_data) - 1);
352 
353  ecm->is_init = 1;
354 
359 
360  return 0;
361 }
362 
363 static int
365  session_t * s, u8 is_fail)
366 {
368  vnet_connect_args_t *a = 0;
369  int rv;
370  u8 thread_index = vlib_get_thread_index ();
372  u32 stream_n;
373  session_handle_t handle;
374 
375  DBG ("QUIC Connection handle %d", session_handle (s));
376 
377  vec_validate (a, 1);
378  a->uri = (char *) ecm->connect_uri;
379  if (parse_uri (a->uri, &sep))
380  return -1;
381  sep.parent_handle = handle = session_handle (s);
382 
383  for (stream_n = 0; stream_n < ecm->quic_streams; stream_n++)
384  {
385  clib_memset (a, 0, sizeof (*a));
386  a->app_index = ecm->app_index;
387  a->api_context = -1 - api_context;
388  clib_memcpy (&a->sep_ext, &sep, sizeof (sep));
389 
390  DBG ("QUIC opening stream %d", stream_n);
391  if ((rv = vnet_connect (a)))
392  {
393  clib_error ("Stream session %d opening failed: %d", stream_n, rv);
394  return -1;
395  }
396  DBG ("QUIC stream %d connected", stream_n);
397  }
398  /*
399  * 's' is no longer valid, its underlying pool could have been moved in
400  * vnet_connect()
401  */
402  vec_add1 (ecm->quic_session_index_by_thread[thread_index], handle);
403  vec_free (a);
404  return 0;
405 }
406 
407 static int
409  session_t * s, u8 is_fail)
410 {
412  eclient_session_t *session;
413  u32 session_index;
414  u8 thread_index;
415 
417  return -1;
418 
419  if (is_fail)
420  {
421  clib_warning ("connection %d failed!", api_context);
423  signal_evt_to_cli (-1);
424  return 0;
425  }
426 
429  api_context, s,
430  is_fail);
431  DBG ("STREAM Connection callback %d", api_context);
432 
433  thread_index = s->thread_index;
434  ASSERT (thread_index == vlib_get_thread_index ()
436 
437  if (!ecm->vpp_event_queue[thread_index])
438  ecm->vpp_event_queue[thread_index] =
439  session_main_get_vpp_event_queue (thread_index);
440 
441  /*
442  * Setup session
443  */
445  pool_get (ecm->sessions, session);
447 
448  clib_memset (session, 0, sizeof (*session));
449  session_index = session - ecm->sessions;
450  session->bytes_to_send = ecm->bytes_to_send;
451  session->bytes_to_receive = ecm->no_return ? 0ULL : ecm->bytes_to_send;
452  session->data.rx_fifo = s->rx_fifo;
453  session->data.rx_fifo->client_session_index = session_index;
454  session->data.tx_fifo = s->tx_fifo;
455  session->data.tx_fifo->client_session_index = session_index;
456  session->data.vpp_evt_q = ecm->vpp_event_queue[thread_index];
457  session->vpp_session_handle = session_handle (s);
458 
459  if (ecm->is_dgram)
460  {
462  tc = session_get_transport (s);
463  clib_memcpy_fast (&session->data.transport, tc,
464  sizeof (session->data.transport));
465  session->data.is_dgram = 1;
466  }
467 
468  vec_add1 (ecm->connection_index_by_thread[thread_index], session_index);
470  if (ecm->ready_connections == ecm->expected_connections)
471  {
473  /* Signal the CLI process that the action is starting... */
474  signal_evt_to_cli (1);
475  }
476 
477  return 0;
478 }
479 
480 static int
482  session_t * s, u8 is_fail)
483 {
485  eclient_session_t *session;
486  u32 session_index;
487  u8 thread_index;
488 
490  return -1;
491 
492  if (is_fail)
493  {
494  clib_warning ("connection %d failed!", api_context);
496  signal_evt_to_cli (-1);
497  return 0;
498  }
499 
500  thread_index = s->thread_index;
501  ASSERT (thread_index == vlib_get_thread_index ()
503 
504  if (!ecm->vpp_event_queue[thread_index])
505  ecm->vpp_event_queue[thread_index] =
506  session_main_get_vpp_event_queue (thread_index);
507 
508  /*
509  * Setup session
510  */
512  pool_get (ecm->sessions, session);
514 
515  clib_memset (session, 0, sizeof (*session));
516  session_index = session - ecm->sessions;
517  session->bytes_to_send = ecm->bytes_to_send;
518  session->bytes_to_receive = ecm->no_return ? 0ULL : ecm->bytes_to_send;
519  session->data.rx_fifo = s->rx_fifo;
520  session->data.rx_fifo->client_session_index = session_index;
521  session->data.tx_fifo = s->tx_fifo;
522  session->data.tx_fifo->client_session_index = session_index;
523  session->data.vpp_evt_q = ecm->vpp_event_queue[thread_index];
524  session->vpp_session_handle = session_handle (s);
525 
526  if (ecm->is_dgram)
527  {
529  tc = session_get_transport (s);
530  clib_memcpy_fast (&session->data.transport, tc,
531  sizeof (session->data.transport));
532  session->data.is_dgram = 1;
533  }
534 
535  vec_add1 (ecm->connection_index_by_thread[thread_index], session_index);
537  if (ecm->ready_connections == ecm->expected_connections)
538  {
540  /* Signal the CLI process that the action is starting... */
541  signal_evt_to_cli (1);
542  }
543 
544  return 0;
545 }
546 
547 static void
549 {
551  vnet_disconnect_args_t _a = { 0 }, *a = &_a;
552 
553  if (s->session_state == SESSION_STATE_READY)
554  clib_warning ("Reset active connection %U", format_session, s, 2);
555 
556  a->handle = session_handle (s);
557  a->app_index = ecm->app_index;
559  return;
560 }
561 
562 static int
564 {
565  return 0;
566 }
567 
568 static void
570 {
572  vnet_disconnect_args_t _a = { 0 }, *a = &_a;
573  a->handle = session_handle (s);
574  a->app_index = ecm->app_index;
576  return;
577 }
578 
579 void
581 {
583  vnet_disconnect_args_t _a = { 0 }, *a = &_a;
584  a->handle = session_handle (s);
585  a->app_index = ecm->app_index;
587 }
588 
589 static int
591 {
593  eclient_session_t *sp;
594 
596  {
598  return -1;
599  }
600 
601  sp = pool_elt_at_index (ecm->sessions, s->rx_fifo->client_session_index);
602  receive_data_chunk (ecm, sp);
603 
605  {
606  if (svm_fifo_set_event (s->rx_fifo))
608  }
609  return 0;
610 }
611 
612 int
613 echo_client_add_segment_callback (u32 client_index, u64 segment_handle)
614 {
615  /* New heaps may be added */
616  return 0;
617 }
618 
619 /* *INDENT-OFF* */
621  .session_reset_callback = echo_clients_session_reset_callback,
622  .session_connected_callback = echo_clients_session_connected_callback,
623  .session_accept_callback = echo_clients_session_create_callback,
624  .session_disconnect_callback = echo_clients_session_disconnect_callback,
625  .builtin_app_rx_callback = echo_clients_rx_callback,
626  .add_segment_callback = echo_client_add_segment_callback
627 };
628 /* *INDENT-ON* */
629 
630 static clib_error_t *
631 echo_clients_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
632 {
633  u32 prealloc_fifos, segment_size = 256 << 20;
635  vnet_app_attach_args_t _a, *a = &_a;
636  u64 options[16];
637  int rv;
638 
639  clib_memset (a, 0, sizeof (*a));
640  clib_memset (options, 0, sizeof (options));
641 
642  a->api_client_index = ecm->my_client_index;
643  if (ecm->transport_proto == TRANSPORT_PROTO_QUIC)
644  echo_clients.session_connected_callback =
646  a->session_cb_vft = &echo_clients;
647 
648  prealloc_fifos = ecm->prealloc_fifos ? ecm->expected_connections : 1;
649 
650  if (ecm->private_segment_size)
651  segment_size = ecm->private_segment_size;
652 
653  options[APP_OPTIONS_ACCEPT_COOKIE] = 0x12345678;
654  options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
655  options[APP_OPTIONS_ADD_SEGMENT_SIZE] = segment_size;
656  options[APP_OPTIONS_RX_FIFO_SIZE] = ecm->fifo_size;
657  options[APP_OPTIONS_TX_FIFO_SIZE] = ecm->fifo_size;
659  options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = prealloc_fifos;
660  options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
661  options[APP_OPTIONS_TLS_ENGINE] = ecm->tls_engine;
662  if (appns_id)
663  {
664  options[APP_OPTIONS_FLAGS] |= appns_flags;
665  options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
666  }
667  a->options = options;
668  a->namespace_id = appns_id;
669 
670  if ((rv = vnet_application_attach (a)))
671  return clib_error_return (0, "attach returned %d", rv);
672 
673  ecm->app_index = a->app_index;
674  return 0;
675 }
676 
677 static int
679 {
681  vnet_app_detach_args_t _da, *da = &_da;
682  int rv;
683 
684  da->app_index = ecm->app_index;
685  da->api_client_index = ~0;
686  rv = vnet_application_detach (da);
687  ecm->test_client_attached = 0;
688  ecm->app_index = ~0;
689  return rv;
690 }
691 
692 static void *
694 {
695  return 0;
696 }
697 
698 /** Start a transmit thread */
699 int
701 {
702  if (ecm->client_thread_handle == 0)
703  {
704  int rv = pthread_create (&ecm->client_thread_handle,
705  NULL /*attr */ ,
707  if (rv)
708  {
709  ecm->client_thread_handle = 0;
710  return -1;
711  }
712  }
713  return 0;
714 }
715 
716 clib_error_t *
718 {
720  vnet_connect_args_t _a, *a = &_a;
721  int i, rv;
722 
723  clib_memset (a, 0, sizeof (*a));
724 
725  for (i = 0; i < n_clients; i++)
726  {
727  a->uri = (char *) ecm->connect_uri;
728  a->api_context = i;
729  a->app_index = ecm->app_index;
730 
732  if ((rv = vnet_connect_uri (a)))
733  {
735  return clib_error_return (0, "connect returned: %d", rv);
736  }
738 
739  /* Crude pacing for call setups */
740  if ((i % 16) == 0)
741  vlib_process_suspend (vm, 100e-6);
742  ASSERT (i + 1 >= ecm->ready_connections);
743  while (i + 1 - ecm->ready_connections > 128)
744  vlib_process_suspend (vm, 1e-3);
745  }
746  return 0;
747 }
748 
749 #define ec_cli_output(_fmt, _args...) \
750  if (!ecm->no_output) \
751  vlib_cli_output(vm, _fmt, ##_args)
752 
753 static clib_error_t *
755  unformat_input_t * input, vlib_cli_command_t * cmd)
756 {
758  vlib_thread_main_t *thread_main = vlib_get_thread_main ();
759  u64 tmp, total_bytes, appns_flags = 0, appns_secret = 0;
760  f64 test_timeout = 20.0, syn_timeout = 20.0, delta;
761  char *default_uri = "tcp://6.0.1.1/1234";
762  uword *event_data = 0, event_type;
763  f64 time_before_connects;
764  u32 n_clients = 1;
765  int preallocate_sessions = 0;
766  char *transfer_type;
767  clib_error_t *error = 0;
768  u8 *appns_id = 0;
769  int i;
771  int rv;
772 
773  ecm->quic_streams = 1;
774  ecm->bytes_to_send = 8192;
775  ecm->no_return = 0;
776  ecm->fifo_size = 64 << 10;
777  ecm->connections_per_batch = 1000;
778  ecm->private_segment_count = 0;
779  ecm->private_segment_size = 0;
780  ecm->no_output = 0;
781  ecm->test_bytes = 0;
782  ecm->test_failed = 0;
783  ecm->vlib_main = vm;
785  ecm->no_copy = 0;
787 
788  if (thread_main->n_vlib_mains > 1)
790  vec_free (ecm->connect_uri);
791 
793  {
794  if (unformat (input, "uri %s", &ecm->connect_uri))
795  ;
796  else if (unformat (input, "nclients %d", &n_clients))
797  ;
798  else if (unformat (input, "quic-streams %d", &ecm->quic_streams))
799  ;
800  else if (unformat (input, "mbytes %lld", &tmp))
801  ecm->bytes_to_send = tmp << 20;
802  else if (unformat (input, "gbytes %lld", &tmp))
803  ecm->bytes_to_send = tmp << 30;
804  else if (unformat (input, "bytes %lld", &ecm->bytes_to_send))
805  ;
806  else if (unformat (input, "test-timeout %f", &test_timeout))
807  ;
808  else if (unformat (input, "syn-timeout %f", &syn_timeout))
809  ;
810  else if (unformat (input, "no-return"))
811  ecm->no_return = 1;
812  else if (unformat (input, "fifo-size %d", &ecm->fifo_size))
813  ecm->fifo_size <<= 10;
814  else if (unformat (input, "private-segment-count %d",
815  &ecm->private_segment_count))
816  ;
817  else if (unformat (input, "private-segment-size %U",
818  unformat_memory_size, &tmp))
819  {
820  if (tmp >= 0x100000000ULL)
821  return clib_error_return
822  (0, "private segment size %lld (%llu) too large", tmp, tmp);
823  ecm->private_segment_size = tmp;
824  }
825  else if (unformat (input, "preallocate-fifos"))
826  ecm->prealloc_fifos = 1;
827  else if (unformat (input, "preallocate-sessions"))
828  preallocate_sessions = 1;
829  else
830  if (unformat (input, "client-batch %d", &ecm->connections_per_batch))
831  ;
832  else if (unformat (input, "appns %_%v%_", &appns_id))
833  ;
834  else if (unformat (input, "all-scope"))
835  appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
836  | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
837  else if (unformat (input, "local-scope"))
838  appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
839  else if (unformat (input, "global-scope"))
840  appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
841  else if (unformat (input, "secret %lu", &appns_secret))
842  ;
843  else if (unformat (input, "no-output"))
844  ecm->no_output = 1;
845  else if (unformat (input, "test-bytes"))
846  ecm->test_bytes = 1;
847  else if (unformat (input, "tls-engine %d", &ecm->tls_engine))
848  ;
849  else
850  return clib_error_return (0, "failed: unknown input `%U'",
851  format_unformat_error, input);
852  }
853 
854  /* Store cli process node index for signalling */
855  ecm->cli_node_index =
857 
858  if (ecm->is_init == 0)
859  {
860  if (echo_clients_init (vm))
861  return clib_error_return (0, "failed init");
862  }
863 
864 
865  ecm->ready_connections = 0;
866  ecm->expected_connections = n_clients * ecm->quic_streams;
867  ecm->rx_total = 0;
868  ecm->tx_total = 0;
869 
870  if (!ecm->connect_uri)
871  {
872  clib_warning ("No uri provided. Using default: %s", default_uri);
873  ecm->connect_uri = format (0, "%s%c", default_uri, 0);
874  }
875 
876  if ((rv = parse_uri ((char *) ecm->connect_uri, &sep)))
877  return clib_error_return (0, "Uri parse error: %d", rv);
878  ecm->transport_proto = sep.transport_proto;
879  ecm->is_dgram = (sep.transport_proto == TRANSPORT_PROTO_UDP
880  || sep.transport_proto == TRANSPORT_PROTO_UDPC);
881 
882 #if ECHO_CLIENT_PTHREAD
884 #endif
885 
887  vnet_session_enable_disable (vm, 1 /* turn on session and transports */ );
889 
890  if (ecm->test_client_attached == 0)
891  {
892  if ((error = echo_clients_attach (appns_id, appns_flags, appns_secret)))
893  {
894  vec_free (appns_id);
895  clib_error_report (error);
896  return error;
897  }
898  vec_free (appns_id);
899  }
900  ecm->test_client_attached = 1;
901 
902  /* Turn on the builtin client input nodes */
903  for (i = 0; i < thread_main->n_vlib_mains; i++)
905  VLIB_NODE_STATE_POLLING);
906 
907  if (preallocate_sessions)
908  pool_init_fixed (ecm->sessions, 1.1 * n_clients);
909 
910  /* Fire off connect requests */
911  time_before_connects = vlib_time_now (vm);
912  if ((error = echo_clients_connect (vm, n_clients)))
913  {
914  goto cleanup;
915  }
916 
917  /* Park until the sessions come up, or ten seconds elapse... */
918  vlib_process_wait_for_event_or_clock (vm, syn_timeout);
919  event_type = vlib_process_get_events (vm, &event_data);
920  switch (event_type)
921  {
922  case ~0:
923  ec_cli_output ("Timeout with only %d sessions active...",
924  ecm->ready_connections);
925  error = clib_error_return (0, "failed: syn timeout with %d sessions",
926  ecm->ready_connections);
927  goto cleanup;
928 
929  case 1:
930  delta = vlib_time_now (vm) - time_before_connects;
931  if (delta != 0.0)
932  ec_cli_output ("%d three-way handshakes in %.2f seconds %.2f/s",
933  n_clients, delta, ((f64) n_clients) / delta);
934 
936  ec_cli_output ("Test started at %.6f", ecm->test_start_time);
937  break;
938 
939  default:
940  ec_cli_output ("unexpected event(1): %d", event_type);
941  error = clib_error_return (0, "failed: unexpected event(1): %d",
942  event_type);
943  goto cleanup;
944  }
945 
946  /* Now wait for the sessions to finish... */
947  vlib_process_wait_for_event_or_clock (vm, test_timeout);
948  event_type = vlib_process_get_events (vm, &event_data);
949  switch (event_type)
950  {
951  case ~0:
952  ec_cli_output ("Timeout with %d sessions still active...",
953  ecm->ready_connections);
954  error = clib_error_return (0, "failed: timeout with %d sessions",
955  ecm->ready_connections);
956  goto cleanup;
957 
958  case 2:
959  ecm->test_end_time = vlib_time_now (vm);
960  ec_cli_output ("Test finished at %.6f", ecm->test_end_time);
961  break;
962 
963  default:
964  ec_cli_output ("unexpected event(2): %d", event_type);
965  error = clib_error_return (0, "failed: unexpected event(2): %d",
966  event_type);
967  goto cleanup;
968  }
969 
970  delta = ecm->test_end_time - ecm->test_start_time;
971  if (delta != 0.0)
972  {
973  total_bytes = (ecm->no_return ? ecm->tx_total : ecm->rx_total);
974  transfer_type = ecm->no_return ? "half-duplex" : "full-duplex";
975  ec_cli_output ("%lld bytes (%lld mbytes, %lld gbytes) in %.2f seconds",
976  total_bytes, total_bytes / (1ULL << 20),
977  total_bytes / (1ULL << 30), delta);
978  ec_cli_output ("%.2f bytes/second %s", ((f64) total_bytes) / (delta),
979  transfer_type);
980  ec_cli_output ("%.4f gbit/second %s",
981  (((f64) total_bytes * 8.0) / delta / 1e9),
982  transfer_type);
983  }
984  else
985  {
986  ec_cli_output ("zero delta-t?");
987  error = clib_error_return (0, "failed: zero delta-t");
988  goto cleanup;
989  }
990 
991  if (ecm->test_bytes && ecm->test_failed)
992  error = clib_error_return (0, "failed: test bytes");
993 
994 cleanup:
997  for (i = 0; i < vec_len (ecm->connection_index_by_thread); i++)
998  {
1002  }
1003 
1004  pool_free (ecm->sessions);
1005 
1006  /* Detach the application, so we can use different fifo sizes next time */
1007  if (ecm->test_client_attached)
1008  {
1009  if (echo_clients_detach ())
1010  {
1011  error = clib_error_return (0, "failed: app detach");
1012  ec_cli_output ("WARNING: app detach failed...");
1013  }
1014  }
1015  if (error)
1016  ec_cli_output ("test failed");
1017  vec_free (ecm->connect_uri);
1018  return error;
1019 }
1020 
1021 /* *INDENT-OFF* */
1022 VLIB_CLI_COMMAND (echo_clients_command, static) =
1023 {
1024  .path = "test echo clients",
1025  .short_help = "test echo clients [nclients %d][[m|g]bytes <bytes>]"
1026  "[test-timeout <time>][syn-timeout <time>][no-return][fifo-size <size>]"
1027  "[private-segment-count <count>][private-segment-size <bytes>[m|g]]"
1028  "[preallocate-fifos][preallocate-sessions][client-batch <batch-size>]"
1029  "[uri <tcp://ip/port>][test-bytes][no-output]",
1030  .function = echo_clients_command_fn,
1031  .is_mp_safe = 1,
1032 };
1033 /* *INDENT-ON* */
1034 
1035 clib_error_t *
1037 {
1039  ecm->is_init = 0;
1040  return 0;
1041 }
1042 
1044 
1045 /*
1046  * fd.io coding-style-patch-verification: ON
1047  *
1048  * Local Variables:
1049  * eval: (c-set-style "gnu")
1050  * End:
1051  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:439
int echo_client_add_segment_callback(u32 client_index, u64 segment_handle)
Definition: echo_client.c:613
vlib_main_t vlib_global_main
Definition: main.c:1940
vlib_main_t * vlib_main
Definition: echo_client.h:107
clib_error_t * echo_clients_connect(vlib_main_t *vm, u32 n_clients)
Definition: echo_client.c:717
#define clib_min(x, y)
Definition: clib.h:302
static int echo_clients_session_create_callback(session_t *s)
Definition: echo_client.c:563
u32 vl_api_memclnt_create_internal(char *name, svm_queue_t *q)
Definition: memory_api.c:120
static f64 vlib_process_wait_for_event_or_clock(vlib_main_t *vm, f64 dt)
Suspend a cooperative multi-tasking thread Waits for an event, or for the indicated number of seconds...
Definition: node_funcs.h:673
u8 is_ip4
set if uses ip4 networking
static u32 svm_fifo_max_enqueue_prod(svm_fifo_t *f)
Maximum number of bytes that can be enqueued into fifo.
Definition: svm_fifo.h:618
vlib_node_runtime_t node_runtime
Definition: node.h:554
u8 * format_session(u8 *s, va_list *args)
Format stream session as per the following format.
Definition: session_cli.c:55
a
Definition: bitmap.h:538
svm_fifo_t * tx_fifo
struct _vnet_connect_args vnet_connect_args_t
static session_cb_vft_t echo_clients
Definition: echo_client.c:620
#define clib_error(format, args...)
Definition: error.h:62
unsigned long u64
Definition: types.h:89
static svm_msg_q_t * session_main_get_vpp_event_queue(u32 thread_index)
Definition: session.h:607
u32 tls_engine
TLS engine mbedtls/openssl.
Definition: echo_client.h:65
static int echo_clients_detach()
Definition: echo_client.c:678
#define clib_memcpy_fast(a, b, c)
Definition: string.h:81
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
transport_connection_t * session_get_transport(session_t *s)
Definition: session.c:1468
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:279
static uword echo_client_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: echo_client.c:202
svm_fifo_t * rx_fifo
Pointers to rx/tx buffers.
u32 expected_connections
Number of clients/connections.
Definition: echo_client.h:61
static_always_inline void clib_spinlock_unlock_if_init(clib_spinlock_t *p)
Definition: lock.h:110
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:522
eclient_session_t * sessions
Session pool, shared.
Definition: echo_client.h:73
static int app_send_stream(app_session_t *s, u8 *data, u32 len, u8 noblock)
u64 bytes_to_send
Bytes to send.
Definition: echo_client.h:58
void svm_fifo_enqueue_nocopy(svm_fifo_t *f, u32 len)
Advance tail.
Definition: svm_fifo.c:964
int i
static void receive_data_chunk(echo_client_main_t *ecm, eclient_session_t *s)
Definition: echo_client.c:140
volatile int run_test
Signal start of test.
Definition: echo_client.h:86
u32 quic_streams
QUIC streams per connection.
Definition: echo_client.h:68
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
u8 data[128]
Definition: ipsec.api:251
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:236
vlib_main_t ** vlib_mains
Definition: buffer.c:332
void echo_clients_session_disconnect(session_t *s)
Definition: echo_client.c:580
unsigned char u8
Definition: types.h:56
app_session_t data
Definition: echo_client.h:33
u8 * connect_test_data
Pre-computed test data.
Definition: echo_client.h:76
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
double f64
Definition: types.h:142
#define vlib_worker_thread_barrier_sync(X)
Definition: threads.h:204
static session_handle_t session_handle(session_t *s)
struct _svm_fifo svm_fifo_t
#define clib_memcpy(d, s, n)
Definition: string.h:180
static uword vlib_process_suspend(vlib_main_t *vm, f64 dt)
Suspend a vlib cooperative multi-tasking thread for a period of time.
Definition: node_funcs.h:422
clib_error_t * echo_clients_main_init(vlib_main_t *vm)
Definition: echo_client.c:1036
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
static uword vlib_process_get_events(vlib_main_t *vm, uword **data_vector)
Return the first event type which has occurred and a vector of per-event data of that type...
Definition: node_funcs.h:516
struct _vnet_disconnect_args_t vnet_disconnect_args_t
int echo_clients_start_tx_pthread(echo_client_main_t *ecm)
Start a transmit thread.
Definition: echo_client.c:700
static u32 svm_fifo_max_dequeue_cons(svm_fifo_t *f)
Fifo max bytes to dequeue optimized for consumer.
Definition: svm_fifo.h:498
#define DBG(_fmt, _args...)
Definition: echo_client.c:26
#define clib_error_return(e, args...)
Definition: error.h:99
void vl_api_rpc_call_main_thread(void *fp, u8 *data, u32 data_length)
Definition: vlib_api.c:608
u32 app_index
app index after attach
Definition: echo_client.h:52
static int quic_echo_clients_qsession_connected_callback(u32 app_index, u32 api_context, session_t *s, u8 is_fail)
Definition: echo_client.c:364
svm_queue_t * vl_input_queue
vpe input queue
Definition: echo_client.h:47
struct vl_shmem_hdr_ * shmem_hdr
Binary API shared-memory segment header pointer.
Definition: api_common.h:266
ip46_address_t lcl_ip
svm_msg_q_t ** vpp_event_queue
Definition: echo_client.h:48
unsigned int u32
Definition: types.h:88
int session_send_io_evt_to_thread(svm_fifo_t *f, session_evt_type_t evt_type)
Definition: session.c:80
#define SESSION_INVALID_HANDLE
Definition: session_types.h:23
struct _vnet_app_attach_args_t vnet_app_attach_args_t
static void echo_clients_session_disconnect_callback(session_t *s)
Definition: echo_client.c:569
static void clib_spinlock_init(clib_spinlock_t *p)
Definition: lock.h:63
struct _session_endpoint_cfg session_endpoint_cfg_t
static int create_api_loopback(echo_client_main_t *ecm)
Definition: echo_client.c:319
static void signal_evt_to_cli(int code)
Definition: echo_client.c:39
static clib_error_t * echo_clients_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: echo_client.c:754
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
volatile u32 ready_connections
Definition: echo_client.h:82
static void vlib_process_signal_event(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Definition: node_funcs.h:934
struct _unformat_input_t unformat_input_t
static void cleanup(void)
Definition: client.c:131
int svm_fifo_enqueue(svm_fifo_t *f, u32 len, const u8 *src)
Enqueue data to fifo.
Definition: svm_fifo.c:888
#define ELOG_DATA(em, f)
Definition: elog.h:484
#define PREDICT_FALSE(x)
Definition: clib.h:112
ip46_address_t rmt_ip
remote ip
u32 ** connection_index_by_thread
Definition: echo_client.h:78
u32 private_segment_count
Number of private fifo segs.
Definition: echo_client.h:63
u32 ** connections_this_batch_by_thread
active connection batch
Definition: echo_client.h:79
u32 node_index
Node index.
Definition: node.h:496
clib_error_t * vnet_session_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: session.c:1613
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:203
int vnet_application_attach(vnet_app_attach_args_t *a)
Attach application to vpp.
Definition: application.c:809
static session_t * session_get_from_handle_if_valid(session_handle_t handle)
Definition: session.h:324
static void echo_clients_session_reset_callback(session_t *s)
Definition: echo_client.c:548
#define pool_free(p)
Free a pool.
Definition: pool.h:407
static u8 svm_fifo_set_event(svm_fifo_t *f)
Set fifo event flag.
Definition: svm_fifo.h:748
u32 no_copy
Don&#39;t memcpy data to tx fifo.
Definition: echo_client.h:67
u32 connections_per_batch
Connections to rx/tx at once.
Definition: echo_client.h:62
static int echo_clients_rx_callback(session_t *s)
Definition: echo_client.c:590
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
#define UNFORMAT_END_OF_INPUT
Definition: format.h:145
session_handle_t listener_handle
Parent listener session index if the result of an accept.
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:218
static clib_error_t * echo_clients_attach(u8 *appns_id, u64 appns_flags, u64 appns_secret)
Definition: echo_client.c:631
static vlib_process_t * vlib_get_current_process(vlib_main_t *vm)
Definition: node_funcs.h:391
vlib_main_t * vm
Definition: buffer.c:323
vlib_node_registration_t echo_clients_node
(constructor) VLIB_REGISTER_NODE (echo_clients_node)
Definition: echo_client.c:309
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
static int echo_clients_session_connected_callback(u32 app_index, u32 api_context, session_t *s, u8 is_fail)
Definition: echo_client.c:481
#define clib_warning(format, args...)
Definition: error.h:59
struct _stream_session_cb_vft session_cb_vft_t
echo_client_main_t echo_client_main
Definition: echo_client.c:23
elog_main_t elog_main
Definition: main.h:193
struct _transport_connection transport_connection_t
#define ELOG_TYPE_DECLARE(f)
Definition: elog.h:442
u32 private_segment_size
size of private fifo segs
Definition: echo_client.h:64
static int app_recv_stream(app_session_t *s, u8 *buf, u32 len)
svm_queue_t * vl_input_queue
Definition: memory_shared.h:84
static void send_data_chunk(echo_client_main_t *ecm, eclient_session_t *s)
Definition: echo_client.c:49
#define pool_init_fixed(pool, max_elts)
initialize a fixed-size, preallocated pool
Definition: pool.h:86
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:161
#define ASSERT(truth)
u32 cli_node_index
cli process node index
Definition: echo_client.h:50
#define vec_delete(V, N, M)
Delete N elements starting at element M.
Definition: vec.h:784
u32 my_client_index
loopback API client handle
Definition: echo_client.h:51
int vnet_application_detach(vnet_app_detach_args_t *a)
Detach application from vpp.
Definition: application.c:869
static int app_send_dgram(app_session_t *s, u8 *data, u32 len, u8 noblock)
#define clib_error_report(e)
Definition: error.h:113
static void vlib_node_set_state(vlib_main_t *vm, u32 node_index, vlib_node_state_t new_state)
Set node dispatch state.
Definition: node_funcs.h:148
#define ECHO_CLIENT_DBG
Definition: echo_client.c:25
ip46_address_t rmt_ip
u16 lcl_port
local port (network order)
struct _vnet_app_detach_args_t vnet_app_detach_args_t
u8 ** rx_buf
intermediate rx buffers
Definition: echo_client.h:75
int vnet_connect(vnet_connect_args_t *a)
Definition: application.c:1001
u8 thread_index
Index of the thread that allocated the session.
#define clib_atomic_fetch_add(a, b)
Definition: atomics.h:23
ip46_address_t lcl_ip
local ip
u8 prealloc_fifos
Request fifo preallocation.
Definition: echo_client.h:101
u32 ** quic_session_index_by_thread
Definition: echo_client.h:77
volatile u64 tx_total
Definition: echo_client.h:85
int parse_uri(char *uri, session_endpoint_cfg_t *sep)
volatile u64 rx_total
Definition: echo_client.h:84
u64 session_handle_t
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
volatile u8 session_state
State in session layer state machine.
u8 * connect_uri
URI for slave&#39;s connect.
Definition: echo_client.h:57
#define ec_cli_output(_fmt, _args...)
Definition: echo_client.c:749
u64 uword
Definition: types.h:112
clib_spinlock_t sessions_lock
Definition: echo_client.h:74
static void * echo_client_thread_fn(void *arg)
Definition: echo_client.c:693
connectionless service
int vnet_disconnect_session(vnet_disconnect_args_t *a)
Definition: application.c:1070
static int quic_echo_clients_session_connected_callback(u32 app_index, u32 api_context, session_t *s, u8 is_fail)
Definition: echo_client.c:408
#define SESSION_ENDPOINT_CFG_NULL
Definition: session_types.h:75
int session_send_io_evt_to_thread_custom(void *data, u32 thread_index, session_evt_type_t evt_type)
Definition: session.c:87
unformat_function_t unformat_memory_size
Definition: format.h:296
static void signal_evt_to_cli_i(int *code)
Definition: echo_client.c:31
static struct option options[]
Definition: main.c:52
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
void vlib_worker_thread_barrier_release(vlib_main_t *vm)
Definition: threads.c:1520
static vlib_thread_main_t * vlib_get_thread_main()
Definition: global_funcs.h:32
int vnet_connect_uri(vnet_connect_args_t *a)
pthread_t client_thread_handle
Definition: echo_client.h:80
int svm_fifo_dequeue_drop(svm_fifo_t *f, u32 len)
Dequeue and drop bytes from fifo.
Definition: svm_fifo.c:1029
static transport_service_type_t session_transport_service_type(session_t *s)
api_main_t api_main
Definition: api_shared.c:35
static_always_inline void clib_spinlock_lock_if_init(clib_spinlock_t *p)
Definition: lock.h:95
struct session_dgram_header_ session_dgram_hdr_t
static int echo_clients_init(vlib_main_t *vm)
Definition: echo_client.c:332
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
static int app_recv_dgram(app_session_t *s, u8 *buf, u32 len)
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:171
u16 rmt_port
remote port (network order)