2 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
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__
23 #include <vcl/vppcom.h>
25 #define vtfail(_fn, _rv) \
28 perror ("ERROR when calling " _fn); \
29 fprintf (stderr, "\nERROR: " _fn " failed (errno = %d)!\n", -_rv); \
33 #define vterr(_fn, _rv) \
36 fprintf (stderr, "\nERROR: " _fn " failed (errno = %d)!\n", -_rv); \
39 #define vtwrn(_fmt, _args...) \
40 fprintf (stderr, "\nERROR: " _fmt "\n", ##_args) \
42 #define vtinf(_fmt, _args...) \
43 fprintf (stdout, "vt<w%u>: " _fmt "\n", __wrk_index, ##_args)
45 #define vt_atomic_add(_ptr, _val) \
46 __atomic_fetch_add (_ptr, _val, __ATOMIC_RELEASE)
48 #define VCL_TEST_TOKEN_HELP "#H"
49 #define VCL_TEST_TOKEN_EXIT "#X"
50 #define VCL_TEST_TOKEN_VERBOSE "#V"
51 #define VCL_TEST_TOKEN_TXBUF_SIZE "#T:"
52 #define VCL_TEST_TOKEN_NUM_TEST_SESS "#I:"
53 #define VCL_TEST_TOKEN_NUM_WRITES "#N:"
54 #define VCL_TEST_TOKEN_RXBUF_SIZE "#R:"
55 #define VCL_TEST_TOKEN_SHOW_CFG "#C"
56 #define VCL_TEST_TOKEN_RUN_UNI "#U"
57 #define VCL_TEST_TOKEN_RUN_BI "#B"
59 #define VCL_TEST_SERVER_PORT 22000
60 #define VCL_TEST_LOCALHOST_IPADDR "127.0.0.1"
62 #define VCL_TEST_CFG_CTRL_MAGIC 0xfeedface
63 #define VCL_TEST_CFG_NUM_WRITES_DEF 1000000
64 #define VCL_TEST_CFG_TXBUF_SIZE_DEF 8192
65 #define VCL_TEST_CFG_RXBUF_SIZE_DEF (64*VCL_TEST_CFG_TXBUF_SIZE_DEF)
66 #define VCL_TEST_CFG_BUF_SIZE_MIN 128
67 #define VCL_TEST_CFG_MAX_TEST_SESS 32
68 #define VCL_TEST_CFG_MAX_EPOLL_EVENTS 16
70 #define VCL_TEST_DELAY_DISCONNECT 1
71 #define VCL_TEST_SEPARATOR_STRING \
72 " -----------------------------\n"
82 typedef struct __attribute__ ((packed))
88 uint32_t num_test_sessions;
89 uint32_t num_test_sessions_perq;
90 uint32_t num_test_qsessions;
93 uint32_t transport_udp;
110 struct timespec start;
111 struct timespec stop;
122 vcl_test_stats_t stats;
124 } vcl_test_session_t;
128 * TLS server cert and keys to be used for testing only
130 char vcl_test_crt_rsa[] =
131 "-----BEGIN CERTIFICATE-----\r\n"
132 "MIID5zCCAs+gAwIBAgIJALeMYCEHrTtJMA0GCSqGSIb3DQEBCwUAMIGJMQswCQYD\r\n"
133 "VQQGEwJVUzELMAkGA1UECAwCQ0ExETAPBgNVBAcMCFNhbiBKb3NlMQ4wDAYDVQQK\r\n"
134 "DAVDaXNjbzEOMAwGA1UECwwFZmQuaW8xFjAUBgNVBAMMDXRlc3R0bHMuZmQuaW8x\r\n"
135 "IjAgBgkqhkiG9w0BCQEWE3ZwcC1kZXZAbGlzdHMuZmQuaW8wHhcNMTgwMzA1MjEx\r\n"
136 "NTEyWhcNMjgwMzAyMjExNTEyWjCBiTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNB\r\n"
137 "MREwDwYDVQQHDAhTYW4gSm9zZTEOMAwGA1UECgwFQ2lzY28xDjAMBgNVBAsMBWZk\r\n"
138 "LmlvMRYwFAYDVQQDDA10ZXN0dGxzLmZkLmlvMSIwIAYJKoZIhvcNAQkBFhN2cHAt\r\n"
139 "ZGV2QGxpc3RzLmZkLmlvMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\r\n"
140 "4C1k8a1DuStgggqT4o09fP9sJ2dC54bxhS/Xk2VEfaIZ222WSo4X/syRVfVy9Yah\r\n"
141 "cpI1zJ/RDxaZSFhgA+nPZBrFMsrULkrdAOpOVj8eDEp9JuWdO2ODSoFnCvLxcYWB\r\n"
142 "Yc5kHryJpEaGJl1sFQSesnzMFty/59ta0stk0Fp8r5NhIjWvSovGzPo6Bhz+VS2c\r\n"
143 "ebIZh4x1t2hHaFcgm0qJoJ6DceReWCW8w+yOVovTolGGq+bpb2Hn7MnRSZ2K2NdL\r\n"
144 "+aLXpkZbS/AODP1FF2vTO1mYL290LO7/51vJmPXNKSDYMy5EvILr5/VqtjsFCwRL\r\n"
145 "Q4jcM/+GeHSAFWx4qIv0BwIDAQABo1AwTjAdBgNVHQ4EFgQUWa1SOB37xmT53tZQ\r\n"
146 "aXuLLhRI7U8wHwYDVR0jBBgwFoAUWa1SOB37xmT53tZQaXuLLhRI7U8wDAYDVR0T\r\n"
147 "BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAoUht13W4ya27NVzQuCMvqPWL3VM4\r\n"
148 "3xbPFk02FaGz/WupPu276zGlzJAZrbuDcQowwwU1Ni1Yygxl96s1c2M5rHDTrOKG\r\n"
149 "rK0hbkSFBo+i6I8u4HiiQ4rYmG0Hv6+sXn3of0HsbtDPGgWZoipPWDljPYEURu3e\r\n"
150 "3HRe/Dtsj9CakBoSDzs8ndWaBR+f4sM9Tk1cjD46Gq2T/qpSPXqKxEUXlzhdCAn4\r\n"
151 "twub17Bq2kykHpppCwPg5M+v30tHG/R2Go15MeFWbEJthFk3TZMjKL7UFs7fH+x2\r\n"
152 "wSonXb++jY+KmCb93C+soABBizE57g/KmiR2IxQ/LMjDik01RSUIaM0lLA==\r\n"
153 "-----END CERTIFICATE-----\r\n";
154 uint32_t vcl_test_crt_rsa_len = sizeof (vcl_test_crt_rsa);
156 char vcl_test_key_rsa[] =
157 "-----BEGIN PRIVATE KEY-----\r\n"
158 "MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDgLWTxrUO5K2CC\r\n"
159 "CpPijT18/2wnZ0LnhvGFL9eTZUR9ohnbbZZKjhf+zJFV9XL1hqFykjXMn9EPFplI\r\n"
160 "WGAD6c9kGsUyytQuSt0A6k5WPx4MSn0m5Z07Y4NKgWcK8vFxhYFhzmQevImkRoYm\r\n"
161 "XWwVBJ6yfMwW3L/n21rSy2TQWnyvk2EiNa9Ki8bM+joGHP5VLZx5shmHjHW3aEdo\r\n"
162 "VyCbSomgnoNx5F5YJbzD7I5Wi9OiUYar5ulvYefsydFJnYrY10v5otemRltL8A4M\r\n"
163 "/UUXa9M7WZgvb3Qs7v/nW8mY9c0pINgzLkS8guvn9Wq2OwULBEtDiNwz/4Z4dIAV\r\n"
164 "bHioi/QHAgMBAAECggEBAMzGipP8+oT166U+NlJXRFifFVN1DvdhG9PWnOxGL+c3\r\n"
165 "ILmBBC08WQzmHshPemBvR6DZkA1H23cV5JTiLWrFtC00CvhXsLRMrE5+uWotI6yE\r\n"
166 "iofybMroHvD6/X5R510UX9hQ6MHu5ShLR5VZ9zXHz5MpTmB/60jG5dLx+jgcwBK8\r\n"
167 "LuGv2YB/WCUwT9QJ3YU2eaingnXtz/MrFbkbltrqlnBdlD+kTtw6Yac9y1XuuQXc\r\n"
168 "BPeulLNDuPolJVWbUvDBZrpt2dXTgz8ws1sv+wCNE0xwQJsqW4Nx3QkpibUL9RUr\r\n"
169 "CVbKlNfa9lopT6nGKlgX69R/uH35yh9AOsfasro6w0ECgYEA82UJ8u/+ORah+0sF\r\n"
170 "Q0FfW5MTdi7OAUHOz16pUsGlaEv0ERrjZxmAkHA/VRwpvDBpx4alCv0Hc39PFLIk\r\n"
171 "nhSsM2BEuBkTAs6/GaoNAiBtQVE/hN7awNRWVmlieS0go3Y3dzaE9IUMyj8sPOFT\r\n"
172 "5JdJ6BM69PHKCkY3dKdnnfpFEuECgYEA68mRpteunF1mdZgXs+WrN+uLlRrQR20F\r\n"
173 "ZyMYiUCH2Dtn26EzA2moy7FipIIrQcX/j+KhYNGM3e7MU4LymIO29E18mn8JODnH\r\n"
174 "sQOXzBTsf8A4yIVMkcuQD3bfb0JiUGYUPOidTp2N7IJA7+6Yc3vQOyb74lnKnJoO\r\n"
175 "gougPT2wS+cCgYAn7muzb6xFsXDhyW0Tm6YJYBfRS9yAWEuVufINobeBZPSl2cN1\r\n"
176 "Jrnw+HlrfTNbrJWuJmjtZJXUXQ6cVp2rUbjutNyRV4vG6iRwEXYQ40EJdkr1gZpi\r\n"
177 "CHQhuShuuPih2MNAy7EEbM+sXrDjTBR3bFqzuHPzu7dp+BshCFX3lRfAAQKBgGQt\r\n"
178 "K5i7IhCFDjb/+3IPLgOAK7mZvsvZ4eXD33TQ2eZgtut1PXtBtNl17/b85uv293Fm\r\n"
179 "VDISVcsk3eLNS8zIiT6afUoWlxAwXEs0v5WRfjl4radkGvgGiJpJYvyeM67877RB\r\n"
180 "EDSKc/X8ESLfOB44iGvZUEMG6zJFscx9DgN25iQZAoGAbyd+JEWwdVH9/K3IH1t2\r\n"
181 "PBkZX17kNWv+iVM1WyFjbe++vfKZCrOJiyiqhDeEqgrP3AuNMlaaduC3VRC3G5oV\r\n"
182 "Mj1tlhDWQ/qhvKdCKNdIVQYDE75nw+FRWV8yYkHAnXYW3tNoweDIwixE0hkPR1bc\r\n"
183 "oEjPLVNtx8SOj/M4rhaPT3I=\r\n" "-----END PRIVATE KEY-----\r\n";
184 uint32_t vcl_test_key_rsa_len = sizeof (vcl_test_key_rsa);
187 vcl_test_stats_accumulate (vcl_test_stats_t * accum, vcl_test_stats_t * incr)
189 accum->rx_xacts += incr->rx_xacts;
190 accum->rx_bytes += incr->rx_bytes;
191 accum->rx_eagain += incr->rx_eagain;
192 accum->rx_incomp += incr->rx_incomp;
193 accum->tx_xacts += incr->tx_xacts;
194 accum->tx_bytes += incr->tx_bytes;
195 accum->tx_eagain += incr->tx_eagain;
196 accum->tx_incomp += incr->tx_incomp;
200 vcl_test_cfg_init (vcl_test_cfg_t * cfg)
202 cfg->magic = VCL_TEST_CFG_CTRL_MAGIC;
203 cfg->test = VCL_TEST_TYPE_NONE;
204 cfg->ctrl_handle = ~0;
205 cfg->num_test_sessions = 1;
206 cfg->num_test_sessions_perq = 1;
208 cfg->rxbuf_size = VCL_TEST_CFG_RXBUF_SIZE_DEF;
209 cfg->num_writes = VCL_TEST_CFG_NUM_WRITES_DEF;
210 cfg->txbuf_size = VCL_TEST_CFG_TXBUF_SIZE_DEF;
211 cfg->total_bytes = cfg->num_writes * cfg->txbuf_size;
215 vcl_test_cfg_verify (vcl_test_cfg_t * cfg, vcl_test_cfg_t * valid_cfg)
217 /* Note: txbuf & rxbuf on server are the same buffer,
218 * so txbuf_size is not included in this check.
220 return ((cfg->magic == valid_cfg->magic)
221 && (cfg->test == valid_cfg->test)
222 && (cfg->verbose == valid_cfg->verbose)
223 && (cfg->rxbuf_size == valid_cfg->rxbuf_size)
224 && (cfg->num_writes == valid_cfg->num_writes)
225 && (cfg->total_bytes == valid_cfg->total_bytes));
229 vcl_test_buf_alloc (vcl_test_cfg_t * cfg, uint8_t is_rxbuf, uint8_t ** buf,
232 uint32_t alloc_size = is_rxbuf ? cfg->rxbuf_size : cfg->txbuf_size;
233 uint8_t *lb = realloc (*buf, (size_t) alloc_size);
238 cfg->rxbuf_size = *bufsize = alloc_size;
240 cfg->txbuf_size = *bufsize = alloc_size;
246 vtwrn ("realloc failed. using buffer size %d instead of %u",
247 *bufsize, alloc_size);
252 vcl_test_session_buf_alloc (vcl_test_session_t * socket)
254 socket->rxbuf_size = socket->cfg.rxbuf_size;
255 socket->txbuf_size = socket->cfg.txbuf_size;
256 vcl_test_buf_alloc (&socket->cfg, 0 /* is_rxbuf */ ,
257 (uint8_t **) & socket->txbuf, &socket->txbuf_size);
258 vcl_test_buf_alloc (&socket->cfg, 1 /* is_rxbuf */ ,
259 (uint8_t **) & socket->rxbuf, &socket->rxbuf_size);
263 vcl_test_type_str (vcl_test_t t)
267 case VCL_TEST_TYPE_NONE:
270 case VCL_TEST_TYPE_ECHO:
273 case VCL_TEST_TYPE_UNI:
276 case VCL_TEST_TYPE_BI:
279 case VCL_TEST_TYPE_EXIT:
288 vcl_test_cfg_dump (vcl_test_cfg_t * cfg, uint8_t is_client)
292 printf (" test config (%p):\n"
293 VCL_TEST_SEPARATOR_STRING
296 "%-5s test: %s (%d)\n"
297 " ctrl handle: %d (0x%x)\n"
298 "%-5s num test sockets: %u (0x%08x)\n"
299 "%-5s verbose: %s (%d)\n"
300 "%-5s rxbuf size: %lu (0x%08lx)\n"
301 "%-5s txbuf size: %lu (0x%08lx)\n"
302 "%-5s num writes: %lu (0x%08lx)\n"
303 " client tx bytes: %lu (0x%08lx)\n"
304 VCL_TEST_SEPARATOR_STRING,
305 (void *) cfg, cfg->magic, cfg->seq_num,
306 is_client && (cfg->test == VCL_TEST_TYPE_UNI) ?
307 "'" VCL_TEST_TOKEN_RUN_UNI "'" :
308 is_client && (cfg->test == VCL_TEST_TYPE_BI) ?
309 "'" VCL_TEST_TOKEN_RUN_BI "'" : spc,
310 vcl_test_type_str (cfg->test), cfg->test,
311 cfg->ctrl_handle, cfg->ctrl_handle,
312 is_client ? "'" VCL_TEST_TOKEN_NUM_TEST_SESS "'" : spc,
313 cfg->num_test_sessions, cfg->num_test_sessions,
314 is_client ? "'" VCL_TEST_TOKEN_VERBOSE "'" : spc,
315 cfg->verbose ? "on" : "off", cfg->verbose,
316 is_client ? "'" VCL_TEST_TOKEN_RXBUF_SIZE "'" : spc,
317 cfg->rxbuf_size, cfg->rxbuf_size,
318 is_client ? "'" VCL_TEST_TOKEN_TXBUF_SIZE "'" : spc,
319 cfg->txbuf_size, cfg->txbuf_size,
320 is_client ? "'" VCL_TEST_TOKEN_NUM_WRITES "'" : spc,
321 cfg->num_writes, cfg->num_writes,
322 cfg->total_bytes, cfg->total_bytes);
326 vcl_test_stats_dump (char *header, vcl_test_stats_t * stats,
327 uint8_t show_rx, uint8_t show_tx, uint8_t verbose)
329 struct timespec diff;
330 double duration, rate;
331 uint64_t total_bytes;
333 if ((stats->stop.tv_nsec - stats->start.tv_nsec) < 0)
335 diff.tv_sec = stats->stop.tv_sec - stats->start.tv_sec - 1;
336 diff.tv_nsec = stats->stop.tv_nsec - stats->start.tv_nsec + 1e9;
340 diff.tv_sec = stats->stop.tv_sec - stats->start.tv_sec;
341 diff.tv_nsec = stats->stop.tv_nsec - stats->start.tv_nsec;
343 duration = (double) diff.tv_sec + (1e-9 * diff.tv_nsec);
345 total_bytes = stats->tx_bytes + stats->rx_bytes;
346 rate = (double) total_bytes *8 / duration / 1e9;
347 printf ("\n%s: Streamed %lu bytes\n"
348 " in %lf seconds (%lf Gbps %s-duplex)!\n",
349 header, total_bytes, duration, rate,
350 (show_rx && show_tx) ? "full" : "half");
354 printf (VCL_TEST_SEPARATOR_STRING
355 " tx stats (0x%p):\n"
356 VCL_TEST_SEPARATOR_STRING
357 " writes: %lu (0x%08lx)\n"
358 " tx bytes: %lu (0x%08lx)\n"
359 " tx eagain: %u (0x%08x)\n"
360 " tx incomplete: %u (0x%08x)\n",
361 (void *) stats, stats->tx_xacts, stats->tx_xacts,
362 stats->tx_bytes, stats->tx_bytes,
363 stats->tx_eagain, stats->tx_eagain,
364 stats->tx_incomp, stats->tx_incomp);
368 printf (VCL_TEST_SEPARATOR_STRING
369 " rx stats (0x%p):\n"
370 VCL_TEST_SEPARATOR_STRING
371 " reads: %lu (0x%08lx)\n"
372 " rx bytes: %lu (0x%08lx)\n"
373 " rx eagain: %u (0x%08x)\n"
374 " rx incomplete: %u (0x%08x)\n",
375 (void *) stats, stats->rx_xacts, stats->rx_xacts,
376 stats->rx_bytes, stats->rx_bytes,
377 stats->rx_eagain, stats->rx_eagain,
378 stats->rx_incomp, stats->rx_incomp);
381 printf (" start.tv_sec: %ld\n"
382 " start.tv_nsec: %ld\n"
383 " stop.tv_sec: %ld\n"
384 " stop.tv_nsec: %ld\n",
385 stats->start.tv_sec, stats->start.tv_nsec,
386 stats->stop.tv_sec, stats->stop.tv_nsec);
388 printf (VCL_TEST_SEPARATOR_STRING);
392 vcl_comp_tspec (struct timespec *a, struct timespec *b)
394 if (a->tv_sec < b->tv_sec)
396 else if (a->tv_sec > b->tv_sec)
398 else if (a->tv_nsec < b->tv_nsec)
400 else if (a->tv_nsec > b->tv_nsec)
407 vcl_test_read (int fd, uint8_t * buf, uint32_t nbytes,
408 vcl_test_stats_t * stats)
416 rx_bytes = vppcom_session_read (fd, buf, nbytes);
425 if ((rx_bytes == 0) ||
427 && ((errno == EAGAIN) || (errno == EWOULDBLOCK))))
429 else if (rx_bytes < nbytes)
433 while ((rx_bytes == 0) ||
434 ((rx_bytes < 0) && ((errno == EAGAIN) || (errno == EWOULDBLOCK))));
438 vterr ("vppcom_session_read()", -errno);
441 stats->rx_bytes += rx_bytes;
447 vcl_test_read_ds (int fd, vppcom_data_segment_t * ds,
448 vcl_test_stats_t * stats)
456 rx_bytes = vppcom_session_read_segments (fd, ds, 2, ~0);
465 if ((rx_bytes == 0) ||
467 && ((errno == EAGAIN) || (errno == EWOULDBLOCK))))
471 while ((rx_bytes == 0) ||
472 ((rx_bytes < 0) && ((errno == EAGAIN) || (errno == EWOULDBLOCK))));
476 vterr ("vppcom_session_read()", -errno);
479 stats->rx_bytes += rx_bytes;
485 vcl_test_write (int fd, uint8_t * buf, uint32_t nbytes,
486 vcl_test_stats_t * stats, uint32_t verbose)
488 int tx_bytes = 0, nbytes_left = nbytes, rv;
494 rv = vppcom_session_write (fd, buf, nbytes_left);
498 if ((errno == EAGAIN || errno == EWOULDBLOCK) && stats)
504 nbytes_left = nbytes_left - rv;
510 while (tx_bytes != nbytes);
514 vterr ("vpcom_session_write", -errno);
517 stats->tx_bytes += tx_bytes;
527 printf ("CLIENT: Test configuration commands:"
528 INDENT VCL_TEST_TOKEN_HELP
529 "\t\t\tDisplay help."
530 INDENT VCL_TEST_TOKEN_EXIT
531 "\t\t\tExit test client & server."
532 INDENT VCL_TEST_TOKEN_SHOW_CFG
533 "\t\t\tShow the current test cfg."
534 INDENT VCL_TEST_TOKEN_RUN_UNI
535 "\t\t\tRun the Uni-directional test."
536 INDENT VCL_TEST_TOKEN_RUN_BI
537 "\t\t\tRun the Bi-directional test."
538 INDENT VCL_TEST_TOKEN_VERBOSE
539 "\t\t\tToggle verbose setting."
540 INDENT VCL_TEST_TOKEN_RXBUF_SIZE
541 "<rxbuf size>\tRx buffer size (bytes)."
542 INDENT VCL_TEST_TOKEN_TXBUF_SIZE
543 "<txbuf size>\tTx buffer size (bytes)."
544 INDENT VCL_TEST_TOKEN_NUM_WRITES
545 "<# of writes>\tNumber of txbuf writes to server." "\n");
548 #endif /* __vcl_test_h__ */
551 * fd.io coding-style-patch-verification: ON
554 * eval: (c-set-style "gnu")