xref: /dpdk/app/test-eventdev/evt_options.h (revision ba57777d)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2017 Cavium, Inc
3  */
4 
5 #ifndef _EVT_OPTIONS_
6 #define _EVT_OPTIONS_
7 
8 #include <stdio.h>
9 #include <stdbool.h>
10 
11 #include <rte_common.h>
12 #include <rte_ethdev.h>
13 #include <rte_eventdev.h>
14 #include <rte_lcore.h>
15 
16 #include "evt_common.h"
17 
18 #define EVT_BOOL_FMT(x)          ((x) ? "true" : "false")
19 
20 #define EVT_VERBOSE              ("verbose")
21 #define EVT_DEVICE               ("dev")
22 #define EVT_TEST                 ("test")
23 #define EVT_PROD_LCORES          ("plcores")
24 #define EVT_WORK_LCORES          ("wlcores")
25 #define EVT_NB_FLOWS             ("nb_flows")
26 #define EVT_SOCKET_ID            ("socket_id")
27 #define EVT_POOL_SZ              ("pool_sz")
28 #define EVT_WKR_DEQ_DEP          ("worker_deq_depth")
29 #define EVT_NB_PKTS              ("nb_pkts")
30 #define EVT_NB_STAGES            ("nb_stages")
31 #define EVT_SCHED_TYPE_LIST      ("stlist")
32 #define EVT_FWD_LATENCY          ("fwd_latency")
33 #define EVT_QUEUE_PRIORITY       ("queue_priority")
34 #define EVT_DEQ_TMO_NSEC         ("deq_tmo_nsec")
35 #define EVT_PROD_ETHDEV          ("prod_type_ethdev")
36 #define EVT_PROD_TIMERDEV        ("prod_type_timerdev")
37 #define EVT_PROD_TIMERDEV_BURST  ("prod_type_timerdev_burst")
38 #define EVT_NB_TIMERS            ("nb_timers")
39 #define EVT_NB_TIMER_ADPTRS      ("nb_timer_adptrs")
40 #define EVT_TIMER_TICK_NSEC      ("timer_tick_nsec")
41 #define EVT_MAX_TMO_NSEC         ("max_tmo_nsec")
42 #define EVT_EXPIRY_NSEC          ("expiry_nsec")
43 #define EVT_MBUF_SZ              ("mbuf_sz")
44 #define EVT_MAX_PKT_SZ           ("max_pkt_sz")
45 #define EVT_NB_ETH_QUEUES        ("nb_eth_queues")
46 #define EVT_ENA_VECTOR           ("enable_vector")
47 #define EVT_VECTOR_SZ            ("vector_size")
48 #define EVT_VECTOR_TMO           ("vector_tmo_ns")
49 #define EVT_PER_PORT_POOL	 ("per_port_pool")
50 #define EVT_HELP                 ("help")
51 
52 void evt_options_default(struct evt_options *opt);
53 int evt_options_parse(struct evt_options *opt, int argc, char **argv);
54 void evt_options_dump(struct evt_options *opt);
55 
56 /* options check helpers */
57 static inline bool
58 evt_lcores_has_overlap(bool lcores[], int lcore)
59 {
60 	if (lcores[lcore] == true) {
61 		evt_err("lcore overlaps at %d", lcore);
62 		return true;
63 	}
64 
65 	return false;
66 }
67 
68 static inline bool
69 evt_lcores_has_overlap_multi(bool lcoresx[], bool lcoresy[])
70 {
71 	int i;
72 
73 	for (i = 0; i < RTE_MAX_LCORE; i++) {
74 		if (lcoresx[i] && lcoresy[i]) {
75 			evt_err("lcores overlaps at %d", i);
76 			return true;
77 		}
78 	}
79 	return false;
80 }
81 
82 static inline bool
83 evt_has_active_lcore(bool lcores[])
84 {
85 	int i;
86 
87 	for (i = 0; i < RTE_MAX_LCORE; i++)
88 		if (lcores[i])
89 			return true;
90 	return false;
91 }
92 
93 static inline int
94 evt_nr_active_lcores(bool lcores[])
95 {
96 	int i;
97 	int c = 0;
98 
99 	for (i = 0; i < RTE_MAX_LCORE; i++)
100 		if (lcores[i])
101 			c++;
102 	return c;
103 }
104 
105 static inline int
106 evt_get_first_active_lcore(bool lcores[])
107 {
108 	int i;
109 
110 	for (i = 0; i < RTE_MAX_LCORE; i++)
111 		if (lcores[i])
112 			return i;
113 	return -1;
114 }
115 
116 static inline bool
117 evt_has_disabled_lcore(bool lcores[])
118 {
119 	int i;
120 
121 	for (i = 0; i < RTE_MAX_LCORE; i++)
122 		if ((lcores[i] == true) && !(rte_lcore_is_enabled(i)))
123 			return true;
124 	return false;
125 }
126 
127 static inline bool
128 evt_has_invalid_stage(struct evt_options *opt)
129 {
130 	if (!opt->nb_stages) {
131 		evt_err("need minimum one stage, check --stlist");
132 		return true;
133 	}
134 	if (opt->nb_stages > EVT_MAX_STAGES) {
135 		evt_err("requested changes are beyond EVT_MAX_STAGES=%d",
136 			EVT_MAX_STAGES);
137 		return true;
138 	}
139 	return false;
140 }
141 
142 static inline bool
143 evt_has_invalid_sched_type(struct evt_options *opt)
144 {
145 	int i;
146 
147 	for (i = 0; i < opt->nb_stages; i++) {
148 		if (opt->sched_type_list[i] > RTE_SCHED_TYPE_PARALLEL) {
149 			evt_err("invalid sched_type %d at %d",
150 				opt->sched_type_list[i], i);
151 			return true;
152 		}
153 	}
154 	return false;
155 }
156 
157 /* option dump helpers */
158 static inline void
159 evt_dump_worker_lcores(struct evt_options *opt)
160 {
161 	int c;
162 
163 	evt_dump_begin("worker lcores");
164 	for  (c = 0; c < RTE_MAX_LCORE; c++) {
165 		if (opt->wlcores[c])
166 			printf("%d ", c);
167 	}
168 	evt_dump_end;
169 }
170 
171 static inline void
172 evt_dump_producer_lcores(struct evt_options *opt)
173 {
174 	int c;
175 
176 	evt_dump_begin("producer lcores");
177 	for  (c = 0; c < RTE_MAX_LCORE; c++) {
178 		if (opt->plcores[c])
179 			printf("%d ", c);
180 	}
181 	evt_dump_end;
182 }
183 
184 static inline void
185 evt_dump_nb_flows(struct evt_options *opt)
186 {
187 	evt_dump("nb_flows", "%d", opt->nb_flows);
188 }
189 
190 static inline void
191 evt_dump_worker_dequeue_depth(struct evt_options *opt)
192 {
193 	evt_dump("worker deq depth", "%d", opt->wkr_deq_dep);
194 }
195 
196 static inline void
197 evt_dump_nb_stages(struct evt_options *opt)
198 {
199 	evt_dump("nb_stages", "%d", opt->nb_stages);
200 }
201 
202 static inline void
203 evt_dump_fwd_latency(struct evt_options *opt)
204 {
205 	evt_dump("fwd_latency", "%s", EVT_BOOL_FMT(opt->fwd_latency));
206 }
207 
208 static inline void
209 evt_dump_queue_priority(struct evt_options *opt)
210 {
211 	evt_dump("queue_priority", "%s", EVT_BOOL_FMT(opt->q_priority));
212 }
213 
214 static inline const char*
215 evt_sched_type_2_str(uint8_t sched_type)
216 {
217 
218 	if (sched_type == RTE_SCHED_TYPE_ORDERED)
219 		return "O";
220 	else if (sched_type == RTE_SCHED_TYPE_ATOMIC)
221 		return "A";
222 	else if (sched_type == RTE_SCHED_TYPE_PARALLEL)
223 		return "P";
224 	else
225 		return "I";
226 }
227 
228 static inline void
229 evt_dump_sched_type_list(struct evt_options *opt)
230 {
231 	int i;
232 
233 	evt_dump_begin("sched_type_list");
234 	for (i = 0; i < opt->nb_stages; i++)
235 		printf("%s ", evt_sched_type_2_str(opt->sched_type_list[i]));
236 
237 	evt_dump_end;
238 }
239 
240 static inline const char *
241 evt_prod_id_to_name(enum evt_prod_type prod_type)
242 {
243 	switch (prod_type) {
244 	default:
245 	case EVT_PROD_TYPE_SYNT:
246 		return "Synthetic producer lcores";
247 	case EVT_PROD_TYPE_ETH_RX_ADPTR:
248 		return "Ethdev Rx Adapter";
249 	case EVT_PROD_TYPE_EVENT_TIMER_ADPTR:
250 		return "Event timer adapter";
251 	}
252 
253 	return "";
254 }
255 
256 #define EVT_PROD_MAX_NAME_LEN 50
257 static inline void
258 evt_dump_producer_type(struct evt_options *opt)
259 {
260 	char name[EVT_PROD_MAX_NAME_LEN];
261 
262 	switch (opt->prod_type) {
263 	default:
264 	case EVT_PROD_TYPE_SYNT:
265 		snprintf(name, EVT_PROD_MAX_NAME_LEN,
266 				"Synthetic producer lcores");
267 		break;
268 	case EVT_PROD_TYPE_ETH_RX_ADPTR:
269 		snprintf(name, EVT_PROD_MAX_NAME_LEN,
270 				"Ethdev Rx Adapter producers");
271 		evt_dump("nb_ethdev", "%d", rte_eth_dev_count_avail());
272 		break;
273 	case EVT_PROD_TYPE_EVENT_TIMER_ADPTR:
274 		if (opt->timdev_use_burst)
275 			snprintf(name, EVT_PROD_MAX_NAME_LEN,
276 				"Event timer adapter burst mode producer");
277 		else
278 			snprintf(name, EVT_PROD_MAX_NAME_LEN,
279 				"Event timer adapter producer");
280 		evt_dump("nb_timer_adapters", "%d", opt->nb_timer_adptrs);
281 		evt_dump("max_tmo_nsec", "%"PRIu64"", opt->max_tmo_nsec);
282 		evt_dump("expiry_nsec", "%"PRIu64"", opt->expiry_nsec);
283 		if (opt->optm_timer_tick_nsec)
284 			evt_dump("optm_timer_tick_nsec", "%"PRIu64"",
285 					opt->optm_timer_tick_nsec);
286 		else
287 			evt_dump("timer_tick_nsec", "%"PRIu64"",
288 					opt->timer_tick_nsec);
289 		break;
290 	}
291 	evt_dump("prod_type", "%s", name);
292 }
293 
294 #endif /* _EVT_OPTIONS_ */
295