doc: whitespace changes in licenses
[dpdk.git] / examples / qos_sched / main.h
1 /*-
2  *   BSD LICENSE
3  * 
4  *   Copyright(c) 2010-2013 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 #ifdef RTE_EXEC_ENV_BAREMETAL
44 #error "Baremetal is not supported"
45 #else
46 #define MAIN main
47 #endif
48
49 #define RTE_LOGTYPE_APP RTE_LOGTYPE_USER1
50
51 /*
52  * Configurable number of RX/TX ring descriptors
53  */
54 #define APP_RX_DESC_DEFAULT 128
55 #define APP_TX_DESC_DEFAULT 256
56
57 #define MBUF_SIZE (1528 + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
58 #define APP_RING_SIZE (8*1024)
59 #define NB_MBUF   (2*1024*1024)
60
61 #define MAX_PKT_RX_BURST 64
62 #define PKT_ENQUEUE 64
63 #define PKT_DEQUEUE 32
64 #define MAX_PKT_TX_BURST 64
65
66 #define RX_PTHRESH 8 /**< Default values of RX prefetch threshold reg. */
67 #define RX_HTHRESH 8 /**< Default values of RX host threshold reg. */
68 #define RX_WTHRESH 4 /**< Default values of RX write-back threshold reg. */
69
70 #define TX_PTHRESH 36 /**< Default values of TX prefetch threshold reg. */
71 #define TX_HTHRESH 0  /**< Default values of TX host threshold reg. */
72 #define TX_WTHRESH 0  /**< Default values of TX write-back threshold reg. */
73
74 #define BURST_TX_DRAIN_US 100
75
76 #define MAX_DATA_STREAMS (RTE_MAX_LCORE/2)
77 #define MAX_SCHED_SUBPORTS              8
78 #define MAX_SCHED_PIPES                 4096
79
80 #ifndef APP_COLLECT_STAT
81 #define APP_COLLECT_STAT                1
82 #endif
83
84 #if APP_COLLECT_STAT
85 #define APP_STATS_ADD(stat,val) (stat) += (val)
86 #else
87 #define APP_STATS_ADD(stat,val) do {(void) (val);} while (0)
88 #endif
89
90 struct thread_stat
91 {
92         uint64_t nb_rx;
93         uint64_t nb_drop;
94 };
95
96
97 struct thread_conf
98 {
99         uint32_t counter;
100         uint32_t n_mbufs;
101         struct rte_mbuf **m_table;
102
103         uint8_t rx_port;
104         uint8_t tx_port;
105         uint16_t rx_queue;
106         uint16_t tx_queue;
107         struct rte_ring *rx_ring;
108         struct rte_ring *tx_ring;
109         struct rte_sched_port *sched_port;
110
111 #if APP_COLLECT_STAT
112         struct thread_stat stat;
113 #endif
114 } __rte_cache_aligned;
115
116
117 struct flow_conf
118 {
119         uint32_t rx_core;
120         uint32_t wt_core;
121         uint32_t tx_core;
122         uint8_t rx_port;
123         uint8_t tx_port;
124         uint16_t rx_queue;
125         uint16_t tx_queue;
126         struct rte_ring *rx_ring;
127         struct rte_ring *tx_ring;
128         struct rte_sched_port *sched_port;
129         struct rte_mempool *mbuf_pool;
130
131         struct thread_conf rx_thread;
132         struct thread_conf wt_thread;
133         struct thread_conf tx_thread;
134 };
135
136
137 struct ring_conf
138 {
139         uint32_t rx_size;
140         uint32_t ring_size;
141         uint32_t tx_size;
142 };
143
144 struct burst_conf
145 {
146         uint16_t rx_burst;
147         uint16_t ring_burst;
148         uint16_t qos_dequeue;
149         uint16_t tx_burst;
150 };
151
152 struct ring_thresh
153 {
154         uint8_t pthresh; /**< Ring prefetch threshold. */
155         uint8_t hthresh; /**< Ring host threshold. */
156         uint8_t wthresh; /**< Ring writeback threshold. */
157 };
158
159 extern uint32_t nb_pfc;
160 extern const char *cfg_profile;
161 extern int mp_size;
162 extern struct flow_conf qos_conf[];
163 extern int app_pipe_to_profile[MAX_SCHED_SUBPORTS][MAX_SCHED_PIPES];
164
165 extern struct ring_conf ring_conf;
166 extern struct burst_conf burst_conf;
167 extern struct ring_thresh rx_thresh;
168 extern struct ring_thresh tx_thresh;
169
170 extern struct rte_sched_port_params port_params;
171
172 int MAIN(int argc, char **argv);
173 int app_parse_args(int argc, char **argv);
174 int app_init(void);
175
176 void app_rx_thread(struct thread_conf **qconf);
177 void app_tx_thread(struct thread_conf **qconf);
178 void app_worker_thread(struct thread_conf **qconf);
179 void app_mixed_thread(struct thread_conf **qconf);
180
181
182 #ifdef __cplusplus
183 }
184 #endif
185
186 #endif /* _MAIN_H_ */