4 * Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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
16 * * Neither the name of Intel Corporation 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.
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.
36 #include <rte_eventdev.h>
37 #include <rte_eventdev_pmd_vdev.h>
38 #include <rte_atomic.h>
40 #define SW_DEFAULT_CREDIT_QUANTA 32
41 #define SW_DEFAULT_SCHED_QUANTA 128
42 #define SW_QID_NUM_FIDS 16384
44 #define SW_Q_PRIORITY_MAX 255
45 #define SW_PORTS_MAX 64
46 #define MAX_SW_CONS_Q_DEPTH 128
47 #define SW_INFLIGHT_EVENTS_TOTAL 4096
48 /* allow for lots of over-provisioning */
49 #define MAX_SW_PROD_Q_DEPTH 4096
50 #define SW_FRAGMENTS_MAX 16
52 /* report dequeue burst sizes in buckets */
53 #define SW_DEQ_STAT_BUCKET_SHIFT 2
54 /* how many packets pulled from port by sched */
55 #define SCHED_DEQUEUE_BURST_SIZE 32
57 #define SW_PORT_HIST_LIST (MAX_SW_PROD_Q_DEPTH) /* size of our history list */
58 #define NUM_SAMPLES 64 /* how many data points use for average stats */
60 #define EVENTDEV_NAME_SW_PMD event_sw
61 #define SW_PMD_NAME RTE_STR(event_sw)
63 #define SW_SCHED_TYPE_DIRECT (RTE_SCHED_TYPE_PARALLEL + 1)
65 #define SW_NUM_POLL_BUCKETS (MAX_SW_CONS_Q_DEPTH >> SW_DEQ_STAT_BUCKET_SHIFT)
68 QE_FLAG_VALID_SHIFT = 0,
69 QE_FLAG_COMPLETE_SHIFT,
70 QE_FLAG_NOT_EOP_SHIFT,
74 #define QE_FLAG_VALID (1 << QE_FLAG_VALID_SHIFT) /* for NEW FWD, FRAG */
75 #define QE_FLAG_COMPLETE (1 << QE_FLAG_COMPLETE_SHIFT) /* set for FWD, DROP */
76 #define QE_FLAG_NOT_EOP (1 << QE_FLAG_NOT_EOP_SHIFT) /* set for FRAG only */
78 static const uint8_t sw_qe_flag_map[] = {
79 QE_FLAG_VALID /* NEW Event */,
80 QE_FLAG_VALID | QE_FLAG_COMPLETE /* FWD Event */,
81 QE_FLAG_COMPLETE /* RELEASE Event */,
83 /* Values which can be used for future support for partial
84 * events, i.e. where one event comes back to the scheduler
85 * as multiple which need to be tracked together
87 QE_FLAG_VALID | QE_FLAG_COMPLETE | QE_FLAG_NOT_EOP,
90 #ifdef RTE_LIBRTE_PMD_EVDEV_SW_DEBUG
91 #define SW_LOG_INFO(fmt, args...) \
92 RTE_LOG(INFO, EVENTDEV, "[%s] %s() line %u: " fmt "\n", \
94 __func__, __LINE__, ## args)
96 #define SW_LOG_DBG(fmt, args...) \
97 RTE_LOG(DEBUG, EVENTDEV, "[%s] %s() line %u: " fmt "\n", \
99 __func__, __LINE__, ## args)
101 #define SW_LOG_INFO(fmt, args...)
102 #define SW_LOG_DBG(fmt, args...)
105 #define SW_LOG_ERR(fmt, args...) \
106 RTE_LOG(ERR, EVENTDEV, "[%s] %s() line %u: " fmt "\n", \
108 __func__, __LINE__, ## args)
110 /* Records basic event stats at a given point. Used in port and qid structs */
111 struct sw_point_stats {
117 /* structure used to track what port a flow (FID) is pinned to */
119 /* which CQ this FID is currently pinned to */
121 /* number of packets gone to the CQ with this FID */
125 struct reorder_buffer_entry {
126 uint16_t num_fragments; /**< Number of packet fragments */
127 uint16_t fragment_index; /**< Points to the oldest valid frag */
128 uint8_t ready; /**< Entry is ready to be reordered */
129 struct rte_event fragments[SW_FRAGMENTS_MAX];
133 /* set when the QID has been initialized */
135 /* The type of this QID */
137 /* Integer ID representing the queue. This is used in history lists,
138 * to identify the stage of processing.
141 struct sw_point_stats stats;
143 /* Internal priority rings for packets */
144 struct iq_ring *iq[SW_IQS_MAX];
145 uint32_t iq_pkt_mask; /* A mask to indicate packets in an IQ */
146 uint64_t iq_pkt_count[SW_IQS_MAX];
148 /* Information on what CQs are polling this IQ */
149 uint32_t cq_num_mapped_cqs;
150 uint32_t cq_next_tx; /* cq to write next (non-atomic) packet */
151 uint32_t cq_map[SW_PORTS_MAX];
152 uint64_t to_port[SW_PORTS_MAX];
154 /* Track flow ids for atomic load balancing */
155 struct sw_fid_t fids[SW_QID_NUM_FIDS];
157 /* Track packet order for reordering when needed */
158 struct reorder_buffer_entry *reorder_buffer; /*< pkts await reorder */
159 struct rte_ring *reorder_buffer_freelist; /* available reorder slots */
160 uint32_t reorder_buffer_index; /* oldest valid reorder buffer entry */
161 uint32_t window_size; /* Used to wrap reorder_buffer_index */
166 struct sw_hist_list_entry {
169 struct reorder_buffer_entry *rob_entry;
175 /* new enqueue / dequeue API doesn't have an instance pointer, only the
176 * pointer to the port being enqueue/dequeued from
180 /* set when the port is initialized */
182 /* A numeric ID for the port */
185 int16_t is_directed; /** Takes from a single directed QID */
187 * For loadbalanced we can optimise pulling packets from
188 * producers if there is no reordering involved
190 int16_t num_ordered_qids;
192 /** Ring and buffer for pulling events from workers for scheduling */
193 struct qe_ring *rx_worker_ring __rte_cache_aligned;
194 /** Ring and buffer for pushing packets to workers after scheduling */
195 struct qe_ring *cq_worker_ring;
199 /* num releases yet to be completed on this port */
200 uint16_t outstanding_releases __rte_cache_aligned;
201 uint16_t inflight_max; /* app requested max inflights for this port */
202 uint16_t inflight_credits; /* num credits this port has right now */
204 uint16_t last_dequeue_burst_sz; /* how big the burst was */
205 uint64_t last_dequeue_ticks; /* used to track burst processing time */
206 uint64_t avg_pkt_ticks; /* tracks average over NUM_SAMPLES burst */
207 uint64_t total_polls; /* how many polls were counted in stats */
208 uint64_t zero_polls; /* tracks polls returning nothing */
209 uint32_t poll_buckets[SW_NUM_POLL_BUCKETS];
210 /* bucket values in 4s for shorter reporting */
212 /* History list structs, containing info on pkts egressed to worker */
213 uint16_t hist_head __rte_cache_aligned;
216 struct sw_hist_list_entry hist_list[SW_PORT_HIST_LIST];
218 /* track packets in and out of this port */
219 struct sw_point_stats stats;
222 uint32_t pp_buf_start;
223 uint32_t pp_buf_count;
224 uint16_t cq_buf_count;
225 struct rte_event pp_buf[SCHED_DEQUEUE_BURST_SIZE];
226 struct rte_event cq_buf[MAX_SW_CONS_Q_DEPTH];
228 uint8_t num_qids_mapped;
232 struct rte_eventdev_data *data;
236 uint32_t xstats_count;
237 struct sw_xstats_entry *xstats;
238 uint32_t xstats_count_mode_dev;
239 uint32_t xstats_count_mode_port;
240 uint32_t xstats_count_mode_queue;
242 /* Contains all ports - load balanced and directed */
243 struct sw_port ports[SW_PORTS_MAX] __rte_cache_aligned;
245 rte_atomic32_t inflights __rte_cache_aligned;
248 * max events in this instance. Cached here for performance.
249 * (also available in data->conf.nb_events_limit)
251 uint32_t nb_events_limit;
253 /* Internal queues - one per logical queue */
254 struct sw_qid qids[RTE_EVENT_MAX_QUEUES_PER_DEV] __rte_cache_aligned;
256 /* Cache how many packets are in each cq */
257 uint16_t cq_ring_space[SW_PORTS_MAX] __rte_cache_aligned;
259 /* Array of pointers to load-balanced QIDs sorted by priority level */
260 struct sw_qid *qids_prioritized[RTE_EVENT_MAX_QUEUES_PER_DEV];
263 struct sw_point_stats stats __rte_cache_aligned;
264 uint64_t sched_called;
265 int32_t sched_quanta;
266 uint64_t sched_no_iq_enqueues;
267 uint64_t sched_no_cq_enqueues;
268 uint64_t sched_cq_qid_called;
271 uint32_t credit_update_quanta;
273 /* store num stats and offset of the stats for each port */
274 uint16_t xstats_count_per_port[SW_PORTS_MAX];
275 uint16_t xstats_offset_for_port[SW_PORTS_MAX];
276 /* store num stats and offset of the stats for each queue */
277 uint16_t xstats_count_per_qid[RTE_EVENT_MAX_QUEUES_PER_DEV];
278 uint16_t xstats_offset_for_qid[RTE_EVENT_MAX_QUEUES_PER_DEV];
281 static inline struct sw_evdev *
282 sw_pmd_priv(const struct rte_eventdev *eventdev)
284 return eventdev->data->dev_private;
287 static inline const struct sw_evdev *
288 sw_pmd_priv_const(const struct rte_eventdev *eventdev)
290 return eventdev->data->dev_private;
293 uint16_t sw_event_enqueue(void *port, const struct rte_event *ev);
294 uint16_t sw_event_enqueue_burst(void *port, const struct rte_event ev[],
297 uint16_t sw_event_dequeue(void *port, struct rte_event *ev, uint64_t wait);
298 uint16_t sw_event_dequeue_burst(void *port, struct rte_event *ev, uint16_t num,
300 void sw_event_schedule(struct rte_eventdev *dev);
301 int sw_xstats_init(struct sw_evdev *dev);
302 int sw_xstats_uninit(struct sw_evdev *dev);
303 int sw_xstats_get_names(const struct rte_eventdev *dev,
304 enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id,
305 struct rte_event_dev_xstats_name *xstats_names,
306 unsigned int *ids, unsigned int size);
307 int sw_xstats_get(const struct rte_eventdev *dev,
308 enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id,
309 const unsigned int ids[], uint64_t values[], unsigned int n);
310 uint64_t sw_xstats_get_by_name(const struct rte_eventdev *dev,
311 const char *name, unsigned int *id);
312 int sw_xstats_reset(struct rte_eventdev *dev,
313 enum rte_event_dev_xstats_mode mode,
314 int16_t queue_port_id,
315 const uint32_t ids[],
319 #endif /* _SW_EVDEV_H_ */