Imported Upstream version 16.07-rc1
[deb_dpdk.git] / examples / qos_sched / main.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _MAIN_H_
35 #define _MAIN_H_
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 #include <rte_sched.h>
42
43 #define RTE_LOGTYPE_APP RTE_LOGTYPE_USER1
44
45 /*
46  * Configurable number of RX/TX ring descriptors
47  */
48 #define APP_INTERACTIVE_DEFAULT 0
49
50 #define APP_RX_DESC_DEFAULT 128
51 #define APP_TX_DESC_DEFAULT 256
52
53 #define APP_RING_SIZE (8*1024)
54 #define NB_MBUF   (2*1024*1024)
55
56 #define MAX_PKT_RX_BURST 64
57 #define PKT_ENQUEUE 64
58 #define PKT_DEQUEUE 32
59 #define MAX_PKT_TX_BURST 64
60
61 #define RX_PTHRESH 8 /**< Default values of RX prefetch threshold reg. */
62 #define RX_HTHRESH 8 /**< Default values of RX host threshold reg. */
63 #define RX_WTHRESH 4 /**< Default values of RX write-back threshold reg. */
64
65 #define TX_PTHRESH 36 /**< Default values of TX prefetch threshold reg. */
66 #define TX_HTHRESH 0  /**< Default values of TX host threshold reg. */
67 #define TX_WTHRESH 0  /**< Default values of TX write-back threshold reg. */
68
69 #define BURST_TX_DRAIN_US 100
70
71 #ifndef APP_MAX_LCORE
72 #define APP_MAX_LCORE 64
73 #endif
74 #define MAX_DATA_STREAMS (APP_MAX_LCORE/2)
75 #define MAX_SCHED_SUBPORTS              8
76 #define MAX_SCHED_PIPES         4096
77
78 #ifndef APP_COLLECT_STAT
79 #define APP_COLLECT_STAT                1
80 #endif
81
82 #if APP_COLLECT_STAT
83 #define APP_STATS_ADD(stat,val) (stat) += (val)
84 #else
85 #define APP_STATS_ADD(stat,val) do {(void) (val);} while (0)
86 #endif
87
88 #define APP_QAVG_NTIMES 10
89 #define APP_QAVG_PERIOD 100
90
91 struct thread_stat
92 {
93         uint64_t nb_rx;
94         uint64_t nb_drop;
95 };
96
97
98 struct thread_conf
99 {
100         uint32_t counter;
101         uint32_t n_mbufs;
102         struct rte_mbuf **m_table;
103
104         uint8_t rx_port;
105         uint8_t tx_port;
106         uint16_t rx_queue;
107         uint16_t tx_queue;
108         struct rte_ring *rx_ring;
109         struct rte_ring *tx_ring;
110         struct rte_sched_port *sched_port;
111
112 #if APP_COLLECT_STAT
113         struct thread_stat stat;
114 #endif
115 } __rte_cache_aligned;
116
117
118 struct flow_conf
119 {
120         uint32_t rx_core;
121         uint32_t wt_core;
122         uint32_t tx_core;
123         uint8_t rx_port;
124         uint8_t tx_port;
125         uint16_t rx_queue;
126         uint16_t tx_queue;
127         struct rte_ring *rx_ring;
128         struct rte_ring *tx_ring;
129         struct rte_sched_port *sched_port;
130         struct rte_mempool *mbuf_pool;
131
132         struct thread_conf rx_thread;
133         struct thread_conf wt_thread;
134         struct thread_conf tx_thread;
135 };
136
137
138 struct ring_conf
139 {
140         uint32_t rx_size;
141         uint32_t ring_size;
142         uint32_t tx_size;
143 };
144
145 struct burst_conf
146 {
147         uint16_t rx_burst;
148         uint16_t ring_burst;
149         uint16_t qos_dequeue;
150         uint16_t tx_burst;
151 };
152
153 struct ring_thresh
154 {
155         uint8_t pthresh; /**< Ring prefetch threshold. */
156         uint8_t hthresh; /**< Ring host threshold. */
157         uint8_t wthresh; /**< Ring writeback threshold. */
158 };
159
160 extern uint8_t interactive;
161 extern uint32_t qavg_period;
162 extern uint32_t qavg_ntimes;
163 extern uint32_t nb_pfc;
164 extern const char *cfg_profile;
165 extern int mp_size;
166 extern struct flow_conf qos_conf[];
167 extern int app_pipe_to_profile[MAX_SCHED_SUBPORTS][MAX_SCHED_PIPES];
168
169 extern struct ring_conf ring_conf;
170 extern struct burst_conf burst_conf;
171 extern struct ring_thresh rx_thresh;
172 extern struct ring_thresh tx_thresh;
173
174 extern struct rte_sched_port_params port_params;
175
176 int app_parse_args(int argc, char **argv);
177 int app_init(void);
178
179 void prompt(void);
180 void app_rx_thread(struct thread_conf **qconf);
181 void app_tx_thread(struct thread_conf **qconf);
182 void app_worker_thread(struct thread_conf **qconf);
183 void app_mixed_thread(struct thread_conf **qconf);
184
185 void app_stat(void);
186 int subport_stat(uint8_t port_id, uint32_t subport_id);
187 int pipe_stat(uint8_t port_id, uint32_t subport_id, uint32_t pipe_id);
188 int qavg_q(uint8_t port_id, uint32_t subport_id, uint32_t pipe_id, uint8_t tc, uint8_t q);
189 int qavg_tcpipe(uint8_t port_id, uint32_t subport_id, uint32_t pipe_id, uint8_t tc);
190 int qavg_pipe(uint8_t port_id, uint32_t subport_id, uint32_t pipe_id);
191 int qavg_tcsubport(uint8_t port_id, uint32_t subport_id, uint8_t tc);
192 int qavg_subport(uint8_t port_id, uint32_t subport_id);
193
194 #ifdef __cplusplus
195 }
196 #endif
197
198 #endif /* _MAIN_H_ */