xref: /dpdk/app/test-crypto-perf/cperf_options.h (revision 68a03efeed657e6e05f281479b33b51102797e15)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2018 Intel Corporation
3  */
4 
5 #ifndef _CPERF_OPTIONS_
6 #define _CPERF_OPTIONS_
7 
8 #include <rte_crypto.h>
9 #include <rte_cryptodev.h>
10 #ifdef RTE_LIB_SECURITY
11 #include <rte_security.h>
12 #endif
13 
14 #define CPERF_PTEST_TYPE	("ptest")
15 #define CPERF_SILENT		("silent")
16 
17 #define CPERF_POOL_SIZE		("pool-sz")
18 #define CPERF_TOTAL_OPS		("total-ops")
19 #define CPERF_BURST_SIZE	("burst-sz")
20 #define CPERF_BUFFER_SIZE	("buffer-sz")
21 #define CPERF_SEGMENT_SIZE	("segment-sz")
22 #define CPERF_DESC_NB		("desc-nb")
23 #define CPERF_IMIX		("imix")
24 
25 #define CPERF_DEVTYPE		("devtype")
26 #define CPERF_OPTYPE		("optype")
27 #define CPERF_SESSIONLESS	("sessionless")
28 #define CPERF_OUT_OF_PLACE	("out-of-place")
29 #define CPERF_TEST_FILE		("test-file")
30 #define CPERF_TEST_NAME		("test-name")
31 
32 #define CPERF_CIPHER_ALGO	("cipher-algo")
33 #define CPERF_CIPHER_OP		("cipher-op")
34 #define CPERF_CIPHER_KEY_SZ	("cipher-key-sz")
35 #define CPERF_CIPHER_IV_SZ	("cipher-iv-sz")
36 
37 #define CPERF_AUTH_ALGO		("auth-algo")
38 #define CPERF_AUTH_OP		("auth-op")
39 #define CPERF_AUTH_KEY_SZ	("auth-key-sz")
40 #define CPERF_AUTH_IV_SZ	("auth-iv-sz")
41 
42 #define CPERF_AEAD_ALGO		("aead-algo")
43 #define CPERF_AEAD_OP		("aead-op")
44 #define CPERF_AEAD_KEY_SZ	("aead-key-sz")
45 #define CPERF_AEAD_IV_SZ	("aead-iv-sz")
46 #define CPERF_AEAD_AAD_SZ	("aead-aad-sz")
47 
48 #define CPERF_DIGEST_SZ		("digest-sz")
49 
50 #ifdef RTE_LIB_SECURITY
51 #define CPERF_PDCP_SN_SZ	("pdcp-sn-sz")
52 #define CPERF_PDCP_DOMAIN	("pdcp-domain")
53 #define CPERF_PDCP_SES_HFN_EN	("pdcp-ses-hfn-en")
54 #define PDCP_DEFAULT_HFN	0x1
55 #define CPERF_DOCSIS_HDR_SZ	("docsis-hdr-sz")
56 #endif
57 
58 #define CPERF_CSV		("csv-friendly")
59 
60 /* benchmark-specific options */
61 #define CPERF_PMDCC_DELAY_MS	("pmd-cyclecount-delay-ms")
62 
63 #define MAX_LIST 32
64 
65 enum cperf_perf_test_type {
66 	CPERF_TEST_TYPE_THROUGHPUT,
67 	CPERF_TEST_TYPE_LATENCY,
68 	CPERF_TEST_TYPE_VERIFY,
69 	CPERF_TEST_TYPE_PMDCC
70 };
71 
72 
73 extern const char *cperf_test_type_strs[];
74 
75 enum cperf_op_type {
76 	CPERF_CIPHER_ONLY = 1,
77 	CPERF_AUTH_ONLY,
78 	CPERF_CIPHER_THEN_AUTH,
79 	CPERF_AUTH_THEN_CIPHER,
80 	CPERF_AEAD,
81 	CPERF_PDCP,
82 	CPERF_DOCSIS
83 };
84 
85 extern const char *cperf_op_type_strs[];
86 
87 struct cperf_options {
88 	enum cperf_perf_test_type test;
89 
90 	uint32_t pool_sz;
91 	uint32_t total_ops;
92 	uint32_t headroom_sz;
93 	uint32_t tailroom_sz;
94 	uint32_t segment_sz;
95 	uint32_t test_buffer_size;
96 	uint32_t *imix_buffer_sizes;
97 	uint32_t nb_descriptors;
98 	uint16_t nb_qps;
99 
100 	uint32_t sessionless:1;
101 	uint32_t out_of_place:1;
102 	uint32_t silent:1;
103 	uint32_t csv:1;
104 
105 	enum rte_crypto_cipher_algorithm cipher_algo;
106 	enum rte_crypto_cipher_operation cipher_op;
107 
108 	uint16_t cipher_key_sz;
109 	uint16_t cipher_iv_sz;
110 
111 	enum rte_crypto_auth_algorithm auth_algo;
112 	enum rte_crypto_auth_operation auth_op;
113 
114 	uint16_t auth_key_sz;
115 	uint16_t auth_iv_sz;
116 
117 	enum rte_crypto_aead_algorithm aead_algo;
118 	enum rte_crypto_aead_operation aead_op;
119 
120 	uint16_t aead_key_sz;
121 	uint16_t aead_iv_sz;
122 	uint16_t aead_aad_sz;
123 
124 	uint16_t digest_sz;
125 
126 #ifdef RTE_LIB_SECURITY
127 	uint16_t pdcp_sn_sz;
128 	uint16_t pdcp_ses_hfn_en;
129 	enum rte_security_pdcp_domain pdcp_domain;
130 	uint16_t docsis_hdr_sz;
131 #endif
132 	char device_type[RTE_CRYPTODEV_NAME_MAX_LEN];
133 	enum cperf_op_type op_type;
134 
135 	char *test_file;
136 	char *test_name;
137 
138 	uint32_t buffer_size_list[MAX_LIST];
139 	uint8_t buffer_size_count;
140 	uint32_t max_buffer_size;
141 	uint32_t min_buffer_size;
142 	uint32_t inc_buffer_size;
143 
144 	uint32_t burst_size_list[MAX_LIST];
145 	uint8_t burst_size_count;
146 	uint32_t max_burst_size;
147 	uint32_t min_burst_size;
148 	uint32_t inc_burst_size;
149 
150 	/* pmd-cyclecount specific options */
151 	uint32_t pmdcc_delay;
152 	uint32_t imix_distribution_list[MAX_LIST];
153 	uint8_t imix_distribution_count;
154 };
155 
156 void
157 cperf_options_default(struct cperf_options *options);
158 
159 int
160 cperf_options_parse(struct cperf_options *options,
161 		int argc, char **argv);
162 
163 int
164 cperf_options_check(struct cperf_options *options);
165 
166 void
167 cperf_options_dump(struct cperf_options *options);
168 
169 #endif
170