app/testeventdev: add helper functions to check options
[dpdk.git] / app / test-eventdev / evt_options.h
1 /*
2  *   BSD LICENSE
3  *
4  *   Copyright (C) Cavium 2017.
5  *
6  *   Redistribution and use in source and binary forms, with or without
7  *   modification, are permitted provided that the following conditions
8  *   are met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  *       notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above copyright
13  *       notice, this list of conditions and the following disclaimer in
14  *       the documentation and/or other materials provided with the
15  *       distribution.
16  *     * Neither the name of Cavium networks nor the names of its
17  *       contributors may be used to endorse or promote products derived
18  *       from this software without specific prior written permission.
19  *
20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #ifndef _EVT_OPTIONS_
34 #define _EVT_OPTIONS_
35
36 #include <stdio.h>
37 #include <stdbool.h>
38
39 #include <rte_common.h>
40 #include <rte_eventdev.h>
41 #include <rte_lcore.h>
42
43 #include "evt_common.h"
44
45 struct evt_options {
46 #define EVT_TEST_NAME_MAX_LEN     32
47         char test_name[EVT_TEST_NAME_MAX_LEN];
48         bool plcores[RTE_MAX_LCORE];
49         bool wlcores[RTE_MAX_LCORE];
50         uint8_t sched_type_list[EVT_MAX_STAGES];
51         int slcore;
52         uint32_t nb_flows;
53         int socket_id;
54         int pool_sz;
55         int nb_stages;
56         int verbose_level;
57         uint64_t nb_pkts;
58         uint16_t wkr_deq_dep;
59         uint8_t dev_id;
60         uint32_t fwd_latency:1;
61         uint32_t q_priority:1;
62 };
63
64 void evt_options_default(struct evt_options *opt);
65
66 /* options check helpers */
67 static inline bool
68 evt_lcores_has_overlap(bool lcores[], int lcore)
69 {
70         if (lcores[lcore] == true) {
71                 evt_err("lcore overlaps at %d", lcore);
72                 return true;
73         }
74
75         return false;
76 }
77
78 static inline bool
79 evt_lcores_has_overlap_multi(bool lcoresx[], bool lcoresy[])
80 {
81         int i;
82
83         for (i = 0; i < RTE_MAX_LCORE; i++) {
84                 if (lcoresx[i] && lcoresy[i]) {
85                         evt_err("lcores overlaps at %d", i);
86                         return true;
87                 }
88         }
89         return false;
90 }
91
92 static inline bool
93 evt_has_active_lcore(bool lcores[])
94 {
95         int i;
96
97         for (i = 0; i < RTE_MAX_LCORE; i++)
98                 if (lcores[i])
99                         return true;
100         return false;
101 }
102
103 static inline int
104 evt_nr_active_lcores(bool lcores[])
105 {
106         int i;
107         int c = 0;
108
109         for (i = 0; i < RTE_MAX_LCORE; i++)
110                 if (lcores[i])
111                         c++;
112         return c;
113 }
114
115 static inline int
116 evt_get_first_active_lcore(bool lcores[])
117 {
118         int i;
119
120         for (i = 0; i < RTE_MAX_LCORE; i++)
121                 if (lcores[i])
122                         return i;
123         return -1;
124 }
125
126 static inline bool
127 evt_has_disabled_lcore(bool lcores[])
128 {
129         int i;
130
131         for (i = 0; i < RTE_MAX_LCORE; i++)
132                 if ((lcores[i] == true) && !(rte_lcore_is_enabled(i)))
133                         return true;
134         return false;
135 }
136
137 static inline bool
138 evt_has_invalid_stage(struct evt_options *opt)
139 {
140         if (!opt->nb_stages) {
141                 evt_err("need minimum one stage, check --stlist");
142                 return true;
143         }
144         if (opt->nb_stages > EVT_MAX_STAGES) {
145                 evt_err("requested changes are beyond EVT_MAX_STAGES=%d",
146                         EVT_MAX_STAGES);
147                 return true;
148         }
149         return false;
150 }
151
152 static inline bool
153 evt_has_invalid_sched_type(struct evt_options *opt)
154 {
155         int i;
156
157         for (i = 0; i < opt->nb_stages; i++) {
158                 if (opt->sched_type_list[i] > RTE_SCHED_TYPE_PARALLEL) {
159                         evt_err("invalid sched_type %d at %d",
160                                 opt->sched_type_list[i], i);
161                         return true;
162                 }
163         }
164         return false;
165 }
166
167
168 #endif /* _EVT_OPTIONS_ */