drivers/event/sw/sw_evdev_worker.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
   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 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.
  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 #include <rte_atomic.h>
  34 #include <rte_cycles.h>
  35 #include <rte_event_ring.h>
  36
  37 #include "sw_evdev.h"
  38
  39 #define PORT_ENQUEUE_MAX_BURST_SIZE 64
  40
  41 static inline void
  42 sw_event_release(struct sw_port *p, uint8_t index)
  43 {
  44         /*
  45          * Drops the next outstanding event in our history. Used on dequeue
  46          * to clear any history before dequeuing more events.
  47          */
  48         RTE_SET_USED(index);
  49
  50         /* create drop message */
  51         struct rte_event ev;
  52         ev.op = sw_qe_flag_map[RTE_EVENT_OP_RELEASE];
  53
  54         uint16_t free_count;
  55         rte_event_ring_enqueue_burst(p->rx_worker_ring, &ev, 1, &free_count);
  56
  57         /* each release returns one credit */
  58         p->outstanding_releases--;
  59         p->inflight_credits++;
  60 }
  61
  62 /*
  63  * special-case of rte_event_ring enqueue, with overriding the ops member on
  64  * the events that get written to the ring.
  65  */
  66 static inline unsigned int
  67 enqueue_burst_with_ops(struct rte_event_ring *r, const struct rte_event *events,
  68                 unsigned int n, uint8_t *ops)
  69 {
  70         struct rte_event tmp_evs[PORT_ENQUEUE_MAX_BURST_SIZE];
  71         unsigned int i;
  72
  73         memcpy(tmp_evs, events, n * sizeof(events[0]));
  74         for (i = 0; i < n; i++)
  75                 tmp_evs[i].op = ops[i];
  76
  77         return rte_event_ring_enqueue_burst(r, tmp_evs, n, NULL);
  78 }
  79
  80 uint16_t
  81 sw_event_enqueue_burst(void *port, const struct rte_event ev[], uint16_t num)
  82 {
  83         int32_t i;
  84         uint8_t new_ops[PORT_ENQUEUE_MAX_BURST_SIZE];
  85         struct sw_port *p = port;
  86         struct sw_evdev *sw = (void *)p->sw;
  87         uint32_t sw_inflights = rte_atomic32_read(&sw->inflights);
  88
  89         if (unlikely(p->inflight_max < sw_inflights))
  90                 return 0;
  91
  92         if (num > PORT_ENQUEUE_MAX_BURST_SIZE)
  93                 num = PORT_ENQUEUE_MAX_BURST_SIZE;
  94
  95         if (p->inflight_credits < num) {
  96                 /* check if event enqueue brings port over max threshold */
  97                 uint32_t credit_update_quanta = sw->credit_update_quanta;
  98                 if (sw_inflights + credit_update_quanta > sw->nb_events_limit)
  99                         return 0;
 100
 101                 rte_atomic32_add(&sw->inflights, credit_update_quanta);
 102                 p->inflight_credits += (credit_update_quanta);
 103
 104                 if (p->inflight_credits < num)
 105                         return 0;
 106         }
 107
 108         uint32_t forwards = 0;
 109         for (i = 0; i < num; i++) {
 110                 int op = ev[i].op;
 111                 int outstanding = p->outstanding_releases > 0;
 112                 const uint8_t invalid_qid = (ev[i].queue_id >= sw->qid_count);
 113
 114                 p->inflight_credits -= (op == RTE_EVENT_OP_NEW);
 115                 p->inflight_credits += (op == RTE_EVENT_OP_RELEASE) *
 116                                         outstanding;
 117                 forwards += (op == RTE_EVENT_OP_FORWARD);
 118
 119                 new_ops[i] = sw_qe_flag_map[op];
 120                 new_ops[i] &= ~(invalid_qid << QE_FLAG_VALID_SHIFT);
 121
 122                 /* FWD and RELEASE packets will both resolve to taken (assuming
 123                  * correct usage of the API), providing very high correct
 124                  * prediction rate.
 125                  */
 126                 if ((new_ops[i] & QE_FLAG_COMPLETE) && outstanding)
 127                         p->outstanding_releases--;
 128
 129                 /* error case: branch to avoid touching p->stats */
 130                 if (unlikely(invalid_qid)) {
 131                         p->stats.rx_dropped++;
 132                         p->inflight_credits++;
 133                 }
 134         }
 135
 136         /* handle directed port forward credits */
 137         p->inflight_credits -= forwards * p->is_directed;
 138
 139         /* returns number of events actually enqueued */
 140         uint32_t enq = enqueue_burst_with_ops(p->rx_worker_ring, ev, i,
 141                                              new_ops);
 142         if (p->outstanding_releases == 0 && p->last_dequeue_burst_sz != 0) {
 143                 uint64_t burst_ticks = rte_get_timer_cycles() -
 144                                 p->last_dequeue_ticks;
 145                 uint64_t burst_pkt_ticks =
 146                         burst_ticks / p->last_dequeue_burst_sz;
 147                 p->avg_pkt_ticks -= p->avg_pkt_ticks / NUM_SAMPLES;
 148                 p->avg_pkt_ticks += burst_pkt_ticks / NUM_SAMPLES;
 149                 p->last_dequeue_ticks = 0;
 150         }
 151         return enq;
 152 }
 153
 154 uint16_t
 155 sw_event_enqueue(void *port, const struct rte_event *ev)
 156 {
 157         return sw_event_enqueue_burst(port, ev, 1);
 158 }
 159
 160 uint16_t
 161 sw_event_dequeue_burst(void *port, struct rte_event *ev, uint16_t num,
 162                 uint64_t wait)
 163 {
 164         RTE_SET_USED(wait);
 165         struct sw_port *p = (void *)port;
 166         struct sw_evdev *sw = (void *)p->sw;
 167         struct rte_event_ring *ring = p->cq_worker_ring;
 168         uint32_t credit_update_quanta = sw->credit_update_quanta;
 169
 170         /* check that all previous dequeues have been released */
 171         if (!p->is_directed) {
 172                 uint16_t out_rels = p->outstanding_releases;
 173                 uint16_t i;
 174                 for (i = 0; i < out_rels; i++)
 175                         sw_event_release(p, i);
 176         }
 177
 178         /* returns number of events actually dequeued */
 179         uint16_t ndeq = rte_event_ring_dequeue_burst(ring, ev, num, NULL);
 180         if (unlikely(ndeq == 0)) {
 181                 p->outstanding_releases = 0;
 182                 p->zero_polls++;
 183                 p->total_polls++;
 184                 goto end;
 185         }
 186
 187         /* only add credits for directed ports - LB ports send RELEASEs */
 188         p->inflight_credits += ndeq * p->is_directed;
 189         p->outstanding_releases = ndeq;
 190         p->last_dequeue_burst_sz = ndeq;
 191         p->last_dequeue_ticks = rte_get_timer_cycles();
 192         p->poll_buckets[(ndeq - 1) >> SW_DEQ_STAT_BUCKET_SHIFT]++;
 193         p->total_polls++;
 194
 195 end:
 196         if (p->inflight_credits >= credit_update_quanta * 2 &&
 197                         p->inflight_credits > credit_update_quanta + ndeq) {
 198                 rte_atomic32_sub(&sw->inflights, credit_update_quanta);
 199                 p->inflight_credits -= credit_update_quanta;
 200         }
 201         return ndeq;
 202 }
 203
 204 uint16_t
 205 sw_event_dequeue(void *port, struct rte_event *ev, uint64_t wait)
 206 {
 207         return sw_event_dequeue_burst(port, ev, 1, wait);
 208 }