2 * Copyright (c) 2017-2021 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #ifndef __vcl_test_h__
17 #define __vcl_test_h__
24 #include <vcl/vppcom.h>
26 #define vtfail(_fn, _rv) \
29 perror ("ERROR when calling " _fn); \
30 fprintf (stderr, "\nERROR: " _fn " failed (errno = %d)!\n", -_rv); \
34 #define vterr(_fn, _rv) \
37 fprintf (stderr, "\nERROR: " _fn " failed (errno = %d)!\n", -_rv); \
40 #define vtwrn(_fmt, _args...) \
41 fprintf (stderr, "\nERROR: " _fmt "\n", ##_args) \
43 #define vtinf(_fmt, _args...) \
44 fprintf (stdout, "vt<w%u>: " _fmt "\n", __wrk_index, ##_args)
46 #define vt_atomic_add(_ptr, _val) \
47 __atomic_fetch_add (_ptr, _val, __ATOMIC_RELEASE)
49 #define VCL_TEST_TOKEN_HELP "#H"
50 #define VCL_TEST_TOKEN_EXIT "#X"
51 #define VCL_TEST_TOKEN_VERBOSE "#V"
52 #define VCL_TEST_TOKEN_TXBUF_SIZE "#T:"
53 #define VCL_TEST_TOKEN_NUM_TEST_SESS "#I:"
54 #define VCL_TEST_TOKEN_NUM_WRITES "#N:"
55 #define VCL_TEST_TOKEN_RXBUF_SIZE "#R:"
56 #define VCL_TEST_TOKEN_SHOW_CFG "#C"
57 #define VCL_TEST_TOKEN_RUN_UNI "#U"
58 #define VCL_TEST_TOKEN_RUN_BI "#B"
60 #define VCL_TEST_SERVER_PORT 22000
61 #define VCL_TEST_LOCALHOST_IPADDR "127.0.0.1"
63 #define VCL_TEST_CFG_CTRL_MAGIC 0xfeedface
64 #define VCL_TEST_CFG_NUM_WRITES_DEF 1000000
65 #define VCL_TEST_CFG_TXBUF_SIZE_DEF 8192
66 #define VCL_TEST_CFG_RXBUF_SIZE_DEF (64*VCL_TEST_CFG_TXBUF_SIZE_DEF)
67 #define VCL_TEST_CFG_BUF_SIZE_MIN 128
68 #define VCL_TEST_CFG_MAX_TEST_SESS 512
69 #define VCL_TEST_CFG_MAX_EPOLL_EVENTS 16
71 #define VCL_TEST_CTRL_LISTENER (~0 - 1)
72 #define VCL_TEST_DATA_LISTENER (~0)
73 #define VCL_TEST_DELAY_DISCONNECT 1
74 #define VCL_TEST_SEPARATOR_STRING \
75 " -----------------------------\n"
92 typedef struct __attribute__ ((packed))
99 uint32_t num_test_sessions;
100 uint32_t num_test_sessions_perq;
101 uint32_t num_test_qsessions;
103 uint32_t address_ip6;
104 uint32_t transport_udp;
108 uint64_t total_bytes;
121 struct timespec start;
122 struct timespec stop;
125 typedef struct vcl_test_session
131 int (*read) (struct vcl_test_session *ts, void *buf, uint32_t buflen);
132 int (*write) (struct vcl_test_session *ts, void *buf, uint32_t buflen);
138 vcl_test_stats_t stats;
139 vcl_test_stats_t old_stats;
141 vppcom_endpt_t endpt;
143 vppcom_data_segment_t ds[2];
145 } vcl_test_session_t;
147 static __thread int __wrk_index = 0;
150 vcl_test_worker_index (void)
157 int (*init) (vcl_test_cfg_t *cfg);
158 int (*open) (vcl_test_session_t *ts, vppcom_endpt_t *endpt);
159 int (*listen) (vcl_test_session_t *ts, vppcom_endpt_t *endpt);
160 int (*accept) (int listen_fd, vcl_test_session_t *ts);
161 int (*close) (vcl_test_session_t *ts);
162 } vcl_test_proto_vft_t;
166 vcl_test_session_t *qsessions;
167 uint32_t n_qsessions;
173 const vcl_test_proto_vft_t *protos[VPPCOM_PROTO_SRTP + 1];
174 uint32_t ckpair_index;
179 extern vcl_test_main_t vcl_test_main;
181 #define VCL_TEST_REGISTER_PROTO(proto, vft) \
182 static void __attribute__ ((constructor)) vcl_test_init_##proto (void) \
184 vcl_test_main.protos[proto] = &vft; \
188 vcl_test_stats_accumulate (vcl_test_stats_t * accum, vcl_test_stats_t * incr)
190 accum->rx_xacts += incr->rx_xacts;
191 accum->rx_bytes += incr->rx_bytes;
192 accum->rx_eagain += incr->rx_eagain;
193 accum->rx_incomp += incr->rx_incomp;
194 accum->tx_xacts += incr->tx_xacts;
195 accum->tx_bytes += incr->tx_bytes;
196 accum->tx_eagain += incr->tx_eagain;
197 accum->tx_incomp += incr->tx_incomp;
201 vcl_test_cfg_init (vcl_test_cfg_t * cfg)
203 cfg->magic = VCL_TEST_CFG_CTRL_MAGIC;
204 cfg->test = VCL_TEST_TYPE_NONE;
205 cfg->ctrl_handle = ~0;
206 cfg->num_test_sessions = 1;
207 cfg->num_test_sessions_perq = 1;
209 cfg->rxbuf_size = VCL_TEST_CFG_RXBUF_SIZE_DEF;
210 cfg->num_writes = VCL_TEST_CFG_NUM_WRITES_DEF;
211 cfg->txbuf_size = VCL_TEST_CFG_TXBUF_SIZE_DEF;
212 cfg->total_bytes = cfg->num_writes * cfg->txbuf_size;
216 vcl_test_cfg_verify (vcl_test_cfg_t * cfg, vcl_test_cfg_t * valid_cfg)
218 /* Note: txbuf & rxbuf on server are the same buffer,
219 * so txbuf_size is not included in this check.
221 return ((cfg->magic == valid_cfg->magic)
222 && (cfg->test == valid_cfg->test)
223 && (cfg->verbose == valid_cfg->verbose)
224 && (cfg->rxbuf_size == valid_cfg->rxbuf_size)
225 && (cfg->num_writes == valid_cfg->num_writes)
226 && (cfg->total_bytes == valid_cfg->total_bytes));
230 vcl_test_buf_alloc (vcl_test_cfg_t * cfg, uint8_t is_rxbuf, uint8_t ** buf,
233 uint32_t alloc_size = is_rxbuf ? cfg->rxbuf_size : cfg->txbuf_size;
234 uint8_t *lb = realloc (*buf, (size_t) alloc_size);
239 cfg->rxbuf_size = *bufsize = alloc_size;
241 cfg->txbuf_size = *bufsize = alloc_size;
247 vtwrn ("realloc failed. using buffer size %d instead of %u",
248 *bufsize, alloc_size);
253 vcl_test_session_buf_alloc (vcl_test_session_t *ts)
255 ts->rxbuf_size = ts->cfg.rxbuf_size;
256 ts->txbuf_size = ts->cfg.txbuf_size;
257 vcl_test_buf_alloc (&ts->cfg, 0 /* is_rxbuf */, (uint8_t **) &ts->txbuf,
259 vcl_test_buf_alloc (&ts->cfg, 1 /* is_rxbuf */, (uint8_t **) &ts->rxbuf,
264 vcl_test_session_buf_free (vcl_test_session_t *ts)
273 vcl_test_type_str (vcl_test_t t)
277 case VCL_TEST_TYPE_NONE:
280 case VCL_TEST_TYPE_ECHO:
283 case VCL_TEST_TYPE_UNI:
286 case VCL_TEST_TYPE_BI:
289 case VCL_TEST_TYPE_EXIT:
298 vcl_test_cfg_dump (vcl_test_cfg_t * cfg, uint8_t is_client)
302 printf (" test config (%p):\n"
303 VCL_TEST_SEPARATOR_STRING
306 "%-5s test: %s (%d)\n"
307 " ctrl handle: %d (0x%x)\n"
308 "%-5s num test sockets: %u (0x%08x)\n"
309 "%-5s verbose: %s (%d)\n"
310 "%-5s rxbuf size: %lu (0x%08lx)\n"
311 "%-5s txbuf size: %lu (0x%08lx)\n"
312 "%-5s num writes: %lu (0x%08lx)\n"
313 " client tx bytes: %lu (0x%08lx)\n"
314 VCL_TEST_SEPARATOR_STRING,
315 (void *) cfg, cfg->magic, cfg->seq_num,
316 is_client && (cfg->test == VCL_TEST_TYPE_UNI) ?
317 "'" VCL_TEST_TOKEN_RUN_UNI "'" :
318 is_client && (cfg->test == VCL_TEST_TYPE_BI) ?
319 "'" VCL_TEST_TOKEN_RUN_BI "'" : spc,
320 vcl_test_type_str (cfg->test), cfg->test,
321 cfg->ctrl_handle, cfg->ctrl_handle,
322 is_client ? "'" VCL_TEST_TOKEN_NUM_TEST_SESS "'" : spc,
323 cfg->num_test_sessions, cfg->num_test_sessions,
324 is_client ? "'" VCL_TEST_TOKEN_VERBOSE "'" : spc,
325 cfg->verbose ? "on" : "off", cfg->verbose,
326 is_client ? "'" VCL_TEST_TOKEN_RXBUF_SIZE "'" : spc,
327 cfg->rxbuf_size, cfg->rxbuf_size,
328 is_client ? "'" VCL_TEST_TOKEN_TXBUF_SIZE "'" : spc,
329 cfg->txbuf_size, cfg->txbuf_size,
330 is_client ? "'" VCL_TEST_TOKEN_NUM_WRITES "'" : spc,
331 cfg->num_writes, cfg->num_writes,
332 cfg->total_bytes, cfg->total_bytes);
336 vcl_test_stats_dump (char *header, vcl_test_stats_t * stats,
337 uint8_t show_rx, uint8_t show_tx, uint8_t verbose)
339 struct timespec diff;
340 double duration, rate;
341 uint64_t total_bytes;
343 if ((stats->stop.tv_nsec - stats->start.tv_nsec) < 0)
345 diff.tv_sec = stats->stop.tv_sec - stats->start.tv_sec - 1;
346 diff.tv_nsec = stats->stop.tv_nsec - stats->start.tv_nsec + 1e9;
350 diff.tv_sec = stats->stop.tv_sec - stats->start.tv_sec;
351 diff.tv_nsec = stats->stop.tv_nsec - stats->start.tv_nsec;
353 duration = (double) diff.tv_sec + (1e-9 * diff.tv_nsec);
355 total_bytes = stats->tx_bytes + stats->rx_bytes;
356 rate = (double) total_bytes *8 / duration / 1e9;
357 printf ("\n%s: Streamed %lu bytes\n"
358 " in %lf seconds (%lf Gbps %s-duplex)!\n",
359 header, total_bytes, duration, rate,
360 (show_rx && show_tx) ? "full" : "half");
364 printf (VCL_TEST_SEPARATOR_STRING
365 " tx stats (0x%p):\n"
366 VCL_TEST_SEPARATOR_STRING
367 " writes: %lu (0x%08lx)\n"
368 " tx bytes: %lu (0x%08lx)\n"
369 " tx eagain: %u (0x%08x)\n"
370 " tx incomplete: %u (0x%08x)\n",
371 (void *) stats, stats->tx_xacts, stats->tx_xacts,
372 stats->tx_bytes, stats->tx_bytes,
373 stats->tx_eagain, stats->tx_eagain,
374 stats->tx_incomp, stats->tx_incomp);
378 printf (VCL_TEST_SEPARATOR_STRING
379 " rx stats (0x%p):\n"
380 VCL_TEST_SEPARATOR_STRING
381 " reads: %lu (0x%08lx)\n"
382 " rx bytes: %lu (0x%08lx)\n"
383 " rx eagain: %u (0x%08x)\n"
384 " rx incomplete: %u (0x%08x)\n",
385 (void *) stats, stats->rx_xacts, stats->rx_xacts,
386 stats->rx_bytes, stats->rx_bytes,
387 stats->rx_eagain, stats->rx_eagain,
388 stats->rx_incomp, stats->rx_incomp);
391 printf (" start.tv_sec: %ld\n"
392 " start.tv_nsec: %ld\n"
393 " stop.tv_sec: %ld\n"
394 " stop.tv_nsec: %ld\n",
395 stats->start.tv_sec, stats->start.tv_nsec,
396 stats->stop.tv_sec, stats->stop.tv_nsec);
398 printf (VCL_TEST_SEPARATOR_STRING);
402 vcl_test_time_diff (struct timespec *old, struct timespec *new)
405 if ((new->tv_nsec - old->tv_nsec) < 0)
407 sec = new->tv_sec - old->tv_sec - 1;
408 nsec = new->tv_nsec - old->tv_nsec + 1e9;
412 sec = new->tv_sec - old->tv_sec;
413 nsec = new->tv_nsec - old->tv_nsec;
415 return (double) sec + (1e-9 * nsec);
419 vcl_test_stats_dump_inc (vcl_test_session_t *ts, int is_rx)
421 vcl_test_stats_t *old, *new;
422 double duration, rate;
423 uint64_t total_bytes;
426 old = &ts->old_stats;
428 duration = vcl_test_time_diff (&old->stop, &new->stop);
432 total_bytes = new->rx_bytes - old->rx_bytes;
433 dir_str = "Received";
437 total_bytes = new->tx_bytes - old->tx_bytes;
441 rate = (double) total_bytes * 8 / duration / 1e9;
442 printf ("%d: %s %lu Mbytes in %.2lf seconds %.2lf Gbps\n", ts->fd, dir_str,
443 (uint64_t) (total_bytes / 1e6), duration, rate);
447 vcl_comp_tspec (struct timespec *a, struct timespec *b)
449 if (a->tv_sec < b->tv_sec)
451 else if (a->tv_sec > b->tv_sec)
453 else if (a->tv_nsec < b->tv_nsec)
455 else if (a->tv_nsec > b->tv_nsec)
462 vcl_test_read (vcl_test_session_t *ts, void *buf, uint32_t nbytes)
464 vcl_test_stats_t *stats = &ts->stats;
465 int rv, rx_bytes = 0;
470 rv = vppcom_session_read (ts->fd, buf, nbytes);
474 if (errno == EAGAIN || errno == EWOULDBLOCK)
480 vterr ("vppcom_session_read()", -errno);
490 stats->rx_bytes += rx_bytes;
496 vcl_test_read_ds (vcl_test_session_t *ts)
498 vcl_test_stats_t *stats = &ts->stats;
504 rx_bytes = vppcom_session_read_segments (ts->fd, ts->ds, 2, ~0);
511 if ((rx_bytes == 0) ||
513 && ((errno == EAGAIN) || (errno == EWOULDBLOCK))))
516 while ((rx_bytes == 0) ||
517 ((rx_bytes < 0) && ((errno == EAGAIN) || (errno == EWOULDBLOCK))));
521 vterr ("vppcom_session_read()", -errno);
524 stats->rx_bytes += rx_bytes;
530 vcl_test_write (vcl_test_session_t *ts, void *buf, uint32_t nbytes)
532 int tx_bytes = 0, nbytes_left = nbytes, rv;
533 vcl_test_stats_t *stats = &ts->stats;
538 rv = vppcom_session_write (ts->fd, buf, nbytes_left);
542 if ((errno == EAGAIN || errno == EWOULDBLOCK))
548 nbytes_left = nbytes_left - rv;
550 if (rv < nbytes_left)
553 while (tx_bytes != nbytes);
557 vterr ("vpcom_session_write", -errno);
560 stats->tx_bytes += tx_bytes;
570 printf ("CLIENT: Test configuration commands:"
571 INDENT VCL_TEST_TOKEN_HELP
572 "\t\t\tDisplay help."
573 INDENT VCL_TEST_TOKEN_EXIT
574 "\t\t\tExit test client & server."
575 INDENT VCL_TEST_TOKEN_SHOW_CFG
576 "\t\t\tShow the current test cfg."
577 INDENT VCL_TEST_TOKEN_RUN_UNI
578 "\t\t\tRun the Uni-directional test."
579 INDENT VCL_TEST_TOKEN_RUN_BI
580 "\t\t\tRun the Bi-directional test."
581 INDENT VCL_TEST_TOKEN_VERBOSE
582 "\t\t\tToggle verbose setting."
583 INDENT VCL_TEST_TOKEN_RXBUF_SIZE
584 "<rxbuf size>\tRx buffer size (bytes)."
585 INDENT VCL_TEST_TOKEN_TXBUF_SIZE
586 "<txbuf size>\tTx buffer size (bytes)."
587 INDENT VCL_TEST_TOKEN_NUM_WRITES
588 "<# of writes>\tNumber of txbuf writes to server." "\n");
591 #endif /* __vcl_test_h__ */
594 * fd.io coding-style-patch-verification: ON
597 * eval: (c-set-style "gnu")