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