distributor: add new burst-capable library
This patch includes the code for new burst-capable distributor library. It also includes the rte_distributor_next.h file which will be used as the public header once we add in the symbol versioning for v20 and v1705 APIs, at which stage we will rename it to rte_distributor.h. The new distributor code contains a very similar API to the legacy code, but now sends bursts of up to 8 mbufs to each worker. Flow ID's are reduced to 15 bits for an optimal flow matching algorithm. Signed-off-by: David Hunt <david.hunt@intel.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
This commit is contained in:
David Hunt
Thomas Monjalon
parent
66ec3e8bd2
commit
775003ad2f
@ -43,6 +43,7 @@ LIBABIVER := 1
|
||||
|
||||
# all source are stored in SRCS-y
|
||||
SRCS-$(CONFIG_RTE_LIBRTE_DISTRIBUTOR) := rte_distributor_v20.c
|
||||
SRCS-$(CONFIG_RTE_LIBRTE_DISTRIBUTOR) += rte_distributor.c
|
||||
|
||||
# install this header file
|
||||
SYMLINK-$(CONFIG_RTE_LIBRTE_DISTRIBUTOR)-include := rte_distributor.h
|
||||
|
||||
628
lib/librte_distributor/rte_distributor.c
Normal file
628
lib/librte_distributor/rte_distributor.c
Normal file
@ -0,0 +1,628 @@
|
||||
/*-
|
||||
* BSD LICENSE
|
||||
*
|
||||
* Copyright(c) 2017 Intel Corporation. All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* * Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* * Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
* * Neither the name of Intel Corporation nor the names of its
|
||||
* contributors may be used to endorse or promote products derived
|
||||
* from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include <sys/queue.h>
|
||||
#include <string.h>
|
||||
#include <rte_mbuf.h>
|
||||
#include <rte_memory.h>
|
||||
#include <rte_cycles.h>
|
||||
#include <rte_memzone.h>
|
||||
#include <rte_errno.h>
|
||||
#include <rte_string_fns.h>
|
||||
#include <rte_eal_memconfig.h>
|
||||
#include <rte_compat.h>
|
||||
#include "rte_distributor_private.h"
|
||||
#include "rte_distributor_next.h"
|
||||
#include "rte_distributor_v20.h"
|
||||
|
||||
TAILQ_HEAD(rte_dist_burst_list, rte_distributor_v1705);
|
||||
|
||||
static struct rte_tailq_elem rte_dist_burst_tailq = {
|
||||
.name = "RTE_DIST_BURST",
|
||||
};
|
||||
EAL_REGISTER_TAILQ(rte_dist_burst_tailq)
|
||||
|
||||
/**** APIs called by workers ****/
|
||||
|
||||
/**** Burst Packet APIs called by workers ****/
|
||||
|
||||
void
|
||||
rte_distributor_request_pkt_v1705(struct rte_distributor_v1705 *d,
|
||||
unsigned int worker_id, struct rte_mbuf **oldpkt,
|
||||
unsigned int count)
|
||||
{
|
||||
struct rte_distributor_buffer_v1705 *buf = &(d->bufs[worker_id]);
|
||||
unsigned int i;
|
||||
|
||||
volatile int64_t *retptr64;
|
||||
|
||||
if (unlikely(d->alg_type == RTE_DIST_ALG_SINGLE)) {
|
||||
rte_distributor_request_pkt(d->d_v20,
|
||||
worker_id, oldpkt[0]);
|
||||
return;
|
||||
}
|
||||
|
||||
retptr64 = &(buf->retptr64[0]);
|
||||
/* Spin while handshake bits are set (scheduler clears it) */
|
||||
while (unlikely(*retptr64 & RTE_DISTRIB_GET_BUF)) {
|
||||
rte_pause();
|
||||
uint64_t t = rte_rdtsc()+100;
|
||||
|
||||
while (rte_rdtsc() < t)
|
||||
rte_pause();
|
||||
}
|
||||
|
||||
/*
|
||||
* OK, if we've got here, then the scheduler has just cleared the
|
||||
* handshake bits. Populate the retptrs with returning packets.
|
||||
*/
|
||||
|
||||
for (i = count; i < RTE_DIST_BURST_SIZE; i++)
|
||||
buf->retptr64[i] = 0;
|
||||
|
||||
/* Set Return bit for each packet returned */
|
||||
for (i = count; i-- > 0; )
|
||||
buf->retptr64[i] =
|
||||
(((int64_t)(uintptr_t)(oldpkt[i])) <<
|
||||
RTE_DISTRIB_FLAG_BITS) | RTE_DISTRIB_RETURN_BUF;
|
||||
|
||||
/*
|
||||
* Finally, set the GET_BUF to signal to distributor that cache
|
||||
* line is ready for processing
|
||||
*/
|
||||
*retptr64 |= RTE_DISTRIB_GET_BUF;
|
||||
}
|
||||
|
||||
int
|
||||
rte_distributor_poll_pkt_v1705(struct rte_distributor_v1705 *d,
|
||||
unsigned int worker_id, struct rte_mbuf **pkts)
|
||||
{
|
||||
struct rte_distributor_buffer_v1705 *buf = &d->bufs[worker_id];
|
||||
uint64_t ret;
|
||||
int count = 0;
|
||||
unsigned int i;
|
||||
|
||||
if (unlikely(d->alg_type == RTE_DIST_ALG_SINGLE)) {
|
||||
pkts[0] = rte_distributor_poll_pkt(d->d_v20, worker_id);
|
||||
return (pkts[0]) ? 1 : 0;
|
||||
}
|
||||
|
||||
/* If bit is set, return */
|
||||
if (buf->bufptr64[0] & RTE_DISTRIB_GET_BUF)
|
||||
return -1;
|
||||
|
||||
/* since bufptr64 is signed, this should be an arithmetic shift */
|
||||
for (i = 0; i < RTE_DIST_BURST_SIZE; i++) {
|
||||
if (likely(buf->bufptr64[i] & RTE_DISTRIB_VALID_BUF)) {
|
||||
ret = buf->bufptr64[i] >> RTE_DISTRIB_FLAG_BITS;
|
||||
pkts[count++] = (struct rte_mbuf *)((uintptr_t)(ret));
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* so now we've got the contents of the cacheline into an array of
|
||||
* mbuf pointers, so toggle the bit so scheduler can start working
|
||||
* on the next cacheline while we're working.
|
||||
*/
|
||||
buf->bufptr64[0] |= RTE_DISTRIB_GET_BUF;
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
int
|
||||
rte_distributor_get_pkt_v1705(struct rte_distributor_v1705 *d,
|
||||
unsigned int worker_id, struct rte_mbuf **pkts,
|
||||
struct rte_mbuf **oldpkt, unsigned int return_count)
|
||||
{
|
||||
int count;
|
||||
|
||||
if (unlikely(d->alg_type == RTE_DIST_ALG_SINGLE)) {
|
||||
if (return_count <= 1) {
|
||||
pkts[0] = rte_distributor_get_pkt(d->d_v20,
|
||||
worker_id, oldpkt[0]);
|
||||
return (pkts[0]) ? 1 : 0;
|
||||
} else
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
rte_distributor_request_pkt_v1705(d, worker_id, oldpkt, return_count);
|
||||
|
||||
count = rte_distributor_poll_pkt_v1705(d, worker_id, pkts);
|
||||
while (count == -1) {
|
||||
uint64_t t = rte_rdtsc() + 100;
|
||||
|
||||
while (rte_rdtsc() < t)
|
||||
rte_pause();
|
||||
|
||||
count = rte_distributor_poll_pkt_v1705(d, worker_id, pkts);
|
||||
}
|
||||
return count;
|
||||
}
|
||||
|
||||
int
|
||||
rte_distributor_return_pkt_v1705(struct rte_distributor_v1705 *d,
|
||||
unsigned int worker_id, struct rte_mbuf **oldpkt, int num)
|
||||
{
|
||||
struct rte_distributor_buffer_v1705 *buf = &d->bufs[worker_id];
|
||||
unsigned int i;
|
||||
|
||||
if (unlikely(d->alg_type == RTE_DIST_ALG_SINGLE)) {
|
||||
if (num == 1)
|
||||
return rte_distributor_return_pkt(d->d_v20,
|
||||
worker_id, oldpkt[0]);
|
||||
else
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
for (i = 0; i < RTE_DIST_BURST_SIZE; i++)
|
||||
/* Switch off the return bit first */
|
||||
buf->retptr64[i] &= ~RTE_DISTRIB_RETURN_BUF;
|
||||
|
||||
for (i = num; i-- > 0; )
|
||||
buf->retptr64[i] = (((int64_t)(uintptr_t)oldpkt[i]) <<
|
||||
RTE_DISTRIB_FLAG_BITS) | RTE_DISTRIB_RETURN_BUF;
|
||||
|
||||
/* set the GET_BUF but even if we got no returns */
|
||||
buf->retptr64[0] |= RTE_DISTRIB_GET_BUF;
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**** APIs called on distributor core ***/
|
||||
|
||||
/* stores a packet returned from a worker inside the returns array */
|
||||
static inline void
|
||||
store_return(uintptr_t oldbuf, struct rte_distributor_v1705 *d,
|
||||
unsigned int *ret_start, unsigned int *ret_count)
|
||||
{
|
||||
if (!oldbuf)
|
||||
return;
|
||||
/* store returns in a circular buffer */
|
||||
d->returns.mbufs[(*ret_start + *ret_count) & RTE_DISTRIB_RETURNS_MASK]
|
||||
= (void *)oldbuf;
|
||||
*ret_start += (*ret_count == RTE_DISTRIB_RETURNS_MASK);
|
||||
*ret_count += (*ret_count != RTE_DISTRIB_RETURNS_MASK);
|
||||
}
|
||||
|
||||
/*
|
||||
* Match then flow_ids (tags) of the incoming packets to the flow_ids
|
||||
* of the inflight packets (both inflight on the workers and in each worker
|
||||
* backlog). This will then allow us to pin those packets to the relevant
|
||||
* workers to give us our atomic flow pinning.
|
||||
*/
|
||||
void
|
||||
find_match_scalar(struct rte_distributor_v1705 *d,
|
||||
uint16_t *data_ptr,
|
||||
uint16_t *output_ptr)
|
||||
{
|
||||
struct rte_distributor_backlog *bl;
|
||||
uint16_t i, j, w;
|
||||
|
||||
/*
|
||||
* Function overview:
|
||||
* 1. Loop through all worker ID's
|
||||
* 2. Compare the current inflights to the incoming tags
|
||||
* 3. Compare the current backlog to the incoming tags
|
||||
* 4. Add any matches to the output
|
||||
*/
|
||||
|
||||
for (j = 0 ; j < RTE_DIST_BURST_SIZE; j++)
|
||||
output_ptr[j] = 0;
|
||||
|
||||
for (i = 0; i < d->num_workers; i++) {
|
||||
bl = &d->backlog[i];
|
||||
|
||||
for (j = 0; j < RTE_DIST_BURST_SIZE ; j++)
|
||||
for (w = 0; w < RTE_DIST_BURST_SIZE; w++)
|
||||
if (d->in_flight_tags[i][j] == data_ptr[w]) {
|
||||
output_ptr[j] = i+1;
|
||||
break;
|
||||
}
|
||||
for (j = 0; j < RTE_DIST_BURST_SIZE; j++)
|
||||
for (w = 0; w < RTE_DIST_BURST_SIZE; w++)
|
||||
if (bl->tags[j] == data_ptr[w]) {
|
||||
output_ptr[j] = i+1;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* At this stage, the output contains 8 16-bit values, with
|
||||
* each non-zero value containing the worker ID on which the
|
||||
* corresponding flow is pinned to.
|
||||
*/
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* When the handshake bits indicate that there are packets coming
|
||||
* back from the worker, this function is called to copy and store
|
||||
* the valid returned pointers (store_return).
|
||||
*/
|
||||
static unsigned int
|
||||
handle_returns(struct rte_distributor_v1705 *d, unsigned int wkr)
|
||||
{
|
||||
struct rte_distributor_buffer_v1705 *buf = &(d->bufs[wkr]);
|
||||
uintptr_t oldbuf;
|
||||
unsigned int ret_start = d->returns.start,
|
||||
ret_count = d->returns.count;
|
||||
unsigned int count = 0;
|
||||
unsigned int i;
|
||||
|
||||
if (buf->retptr64[0] & RTE_DISTRIB_GET_BUF) {
|
||||
for (i = 0; i < RTE_DIST_BURST_SIZE; i++) {
|
||||
if (buf->retptr64[i] & RTE_DISTRIB_RETURN_BUF) {
|
||||
oldbuf = ((uintptr_t)(buf->retptr64[i] >>
|
||||
RTE_DISTRIB_FLAG_BITS));
|
||||
/* store returns in a circular buffer */
|
||||
store_return(oldbuf, d, &ret_start, &ret_count);
|
||||
count++;
|
||||
buf->retptr64[i] &= ~RTE_DISTRIB_RETURN_BUF;
|
||||
}
|
||||
}
|
||||
d->returns.start = ret_start;
|
||||
d->returns.count = ret_count;
|
||||
/* Clear for the worker to populate with more returns */
|
||||
buf->retptr64[0] = 0;
|
||||
}
|
||||
return count;
|
||||
}
|
||||
|
||||
/*
|
||||
* This function releases a burst (cache line) to a worker.
|
||||
* It is called from the process function when a cacheline is
|
||||
* full to make room for more packets for that worker, or when
|
||||
* all packets have been assigned to bursts and need to be flushed
|
||||
* to the workers.
|
||||
* It also needs to wait for any outstanding packets from the worker
|
||||
* before sending out new packets.
|
||||
*/
|
||||
static unsigned int
|
||||
release(struct rte_distributor_v1705 *d, unsigned int wkr)
|
||||
{
|
||||
struct rte_distributor_buffer_v1705 *buf = &(d->bufs[wkr]);
|
||||
unsigned int i;
|
||||
|
||||
while (!(d->bufs[wkr].bufptr64[0] & RTE_DISTRIB_GET_BUF))
|
||||
rte_pause();
|
||||
|
||||
handle_returns(d, wkr);
|
||||
|
||||
buf->count = 0;
|
||||
|
||||
for (i = 0; i < d->backlog[wkr].count; i++) {
|
||||
d->bufs[wkr].bufptr64[i] = d->backlog[wkr].pkts[i] |
|
||||
RTE_DISTRIB_GET_BUF | RTE_DISTRIB_VALID_BUF;
|
||||
d->in_flight_tags[wkr][i] = d->backlog[wkr].tags[i];
|
||||
}
|
||||
buf->count = i;
|
||||
for ( ; i < RTE_DIST_BURST_SIZE ; i++) {
|
||||
buf->bufptr64[i] = RTE_DISTRIB_GET_BUF;
|
||||
d->in_flight_tags[wkr][i] = 0;
|
||||
}
|
||||
|
||||
d->backlog[wkr].count = 0;
|
||||
|
||||
/* Clear the GET bit */
|
||||
buf->bufptr64[0] &= ~RTE_DISTRIB_GET_BUF;
|
||||
return buf->count;
|
||||
|
||||
}
|
||||
|
||||
|
||||
/* process a set of packets to distribute them to workers */
|
||||
int
|
||||
rte_distributor_process_v1705(struct rte_distributor_v1705 *d,
|
||||
struct rte_mbuf **mbufs, unsigned int num_mbufs)
|
||||
{
|
||||
unsigned int next_idx = 0;
|
||||
static unsigned int wkr;
|
||||
struct rte_mbuf *next_mb = NULL;
|
||||
int64_t next_value = 0;
|
||||
uint16_t new_tag = 0;
|
||||
uint16_t flows[RTE_DIST_BURST_SIZE] __rte_cache_aligned;
|
||||
unsigned int i, j, w, wid;
|
||||
|
||||
if (d->alg_type == RTE_DIST_ALG_SINGLE) {
|
||||
/* Call the old API */
|
||||
return rte_distributor_process(d->d_v20, mbufs, num_mbufs);
|
||||
}
|
||||
|
||||
if (unlikely(num_mbufs == 0)) {
|
||||
/* Flush out all non-full cache-lines to workers. */
|
||||
for (wid = 0 ; wid < d->num_workers; wid++) {
|
||||
if ((d->bufs[wid].bufptr64[0] & RTE_DISTRIB_GET_BUF)) {
|
||||
release(d, wid);
|
||||
handle_returns(d, wid);
|
||||
}
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
while (next_idx < num_mbufs) {
|
||||
uint16_t matches[RTE_DIST_BURST_SIZE];
|
||||
unsigned int pkts;
|
||||
|
||||
if (d->bufs[wkr].bufptr64[0] & RTE_DISTRIB_GET_BUF)
|
||||
d->bufs[wkr].count = 0;
|
||||
|
||||
if ((num_mbufs - next_idx) < RTE_DIST_BURST_SIZE)
|
||||
pkts = num_mbufs - next_idx;
|
||||
else
|
||||
pkts = RTE_DIST_BURST_SIZE;
|
||||
|
||||
for (i = 0; i < pkts; i++) {
|
||||
if (mbufs[next_idx + i]) {
|
||||
/* flows have to be non-zero */
|
||||
flows[i] = mbufs[next_idx + i]->hash.usr | 1;
|
||||
} else
|
||||
flows[i] = 0;
|
||||
}
|
||||
for (; i < RTE_DIST_BURST_SIZE; i++)
|
||||
flows[i] = 0;
|
||||
|
||||
find_match_scalar(d, &flows[0], &matches[0]);
|
||||
|
||||
/*
|
||||
* Matches array now contain the intended worker ID (+1) of
|
||||
* the incoming packets. Any zeroes need to be assigned
|
||||
* workers.
|
||||
*/
|
||||
|
||||
for (j = 0; j < pkts; j++) {
|
||||
|
||||
next_mb = mbufs[next_idx++];
|
||||
next_value = (((int64_t)(uintptr_t)next_mb) <<
|
||||
RTE_DISTRIB_FLAG_BITS);
|
||||
/*
|
||||
* User is advocated to set tag vaue for each
|
||||
* mbuf before calling rte_distributor_process.
|
||||
* User defined tags are used to identify flows,
|
||||
* or sessions.
|
||||
*/
|
||||
/* flows MUST be non-zero */
|
||||
new_tag = (uint16_t)(next_mb->hash.usr) | 1;
|
||||
|
||||
/*
|
||||
* Uncommenting the next line will cause the find_match
|
||||
* function to be optimised out, making this function
|
||||
* do parallel (non-atomic) distribution
|
||||
*/
|
||||
/* matches[j] = 0; */
|
||||
|
||||
if (matches[j]) {
|
||||
struct rte_distributor_backlog *bl =
|
||||
&d->backlog[matches[j]-1];
|
||||
if (unlikely(bl->count ==
|
||||
RTE_DIST_BURST_SIZE)) {
|
||||
release(d, matches[j]-1);
|
||||
}
|
||||
|
||||
/* Add to worker that already has flow */
|
||||
unsigned int idx = bl->count++;
|
||||
|
||||
bl->tags[idx] = new_tag;
|
||||
bl->pkts[idx] = next_value;
|
||||
|
||||
} else {
|
||||
struct rte_distributor_backlog *bl =
|
||||
&d->backlog[wkr];
|
||||
if (unlikely(bl->count ==
|
||||
RTE_DIST_BURST_SIZE)) {
|
||||
release(d, wkr);
|
||||
}
|
||||
|
||||
/* Add to current worker worker */
|
||||
unsigned int idx = bl->count++;
|
||||
|
||||
bl->tags[idx] = new_tag;
|
||||
bl->pkts[idx] = next_value;
|
||||
/*
|
||||
* Now that we've just added an unpinned flow
|
||||
* to a worker, we need to ensure that all
|
||||
* other packets with that same flow will go
|
||||
* to the same worker in this burst.
|
||||
*/
|
||||
for (w = j; w < pkts; w++)
|
||||
if (flows[w] == new_tag)
|
||||
matches[w] = wkr+1;
|
||||
}
|
||||
}
|
||||
wkr++;
|
||||
if (wkr >= d->num_workers)
|
||||
wkr = 0;
|
||||
}
|
||||
|
||||
/* Flush out all non-full cache-lines to workers. */
|
||||
for (wid = 0 ; wid < d->num_workers; wid++)
|
||||
if ((d->bufs[wid].bufptr64[0] & RTE_DISTRIB_GET_BUF))
|
||||
release(d, wid);
|
||||
|
||||
return num_mbufs;
|
||||
}
|
||||
|
||||
/* return to the caller, packets returned from workers */
|
||||
int
|
||||
rte_distributor_returned_pkts_v1705(struct rte_distributor_v1705 *d,
|
||||
struct rte_mbuf **mbufs, unsigned int max_mbufs)
|
||||
{
|
||||
struct rte_distributor_returned_pkts *returns = &d->returns;
|
||||
unsigned int retval = (max_mbufs < returns->count) ?
|
||||
max_mbufs : returns->count;
|
||||
unsigned int i;
|
||||
|
||||
if (d->alg_type == RTE_DIST_ALG_SINGLE) {
|
||||
/* Call the old API */
|
||||
return rte_distributor_returned_pkts(d->d_v20,
|
||||
mbufs, max_mbufs);
|
||||
}
|
||||
|
||||
for (i = 0; i < retval; i++) {
|
||||
unsigned int idx = (returns->start + i) &
|
||||
RTE_DISTRIB_RETURNS_MASK;
|
||||
|
||||
mbufs[i] = returns->mbufs[idx];
|
||||
}
|
||||
returns->start += i;
|
||||
returns->count -= i;
|
||||
|
||||
return retval;
|
||||
}
|
||||
|
||||
/*
|
||||
* Return the number of packets in-flight in a distributor, i.e. packets
|
||||
* being workered on or queued up in a backlog.
|
||||
*/
|
||||
static inline unsigned int
|
||||
total_outstanding(const struct rte_distributor_v1705 *d)
|
||||
{
|
||||
unsigned int wkr, total_outstanding = 0;
|
||||
|
||||
for (wkr = 0; wkr < d->num_workers; wkr++)
|
||||
total_outstanding += d->backlog[wkr].count;
|
||||
|
||||
return total_outstanding;
|
||||
}
|
||||
|
||||
/*
|
||||
* Flush the distributor, so that there are no outstanding packets in flight or
|
||||
* queued up.
|
||||
*/
|
||||
int
|
||||
rte_distributor_flush_v1705(struct rte_distributor_v1705 *d)
|
||||
{
|
||||
const unsigned int flushed = total_outstanding(d);
|
||||
unsigned int wkr;
|
||||
|
||||
if (d->alg_type == RTE_DIST_ALG_SINGLE) {
|
||||
/* Call the old API */
|
||||
return rte_distributor_flush(d->d_v20);
|
||||
}
|
||||
|
||||
while (total_outstanding(d) > 0)
|
||||
rte_distributor_process_v1705(d, NULL, 0);
|
||||
|
||||
/*
|
||||
* Send empty burst to all workers to allow them to exit
|
||||
* gracefully, should they need to.
|
||||
*/
|
||||
rte_distributor_process_v1705(d, NULL, 0);
|
||||
|
||||
for (wkr = 0; wkr < d->num_workers; wkr++)
|
||||
handle_returns(d, wkr);
|
||||
|
||||
return flushed;
|
||||
}
|
||||
|
||||
/* clears the internal returns array in the distributor */
|
||||
void
|
||||
rte_distributor_clear_returns_v1705(struct rte_distributor_v1705 *d)
|
||||
{
|
||||
unsigned int wkr;
|
||||
|
||||
if (d->alg_type == RTE_DIST_ALG_SINGLE) {
|
||||
/* Call the old API */
|
||||
rte_distributor_clear_returns(d->d_v20);
|
||||
}
|
||||
|
||||
/* throw away returns, so workers can exit */
|
||||
for (wkr = 0; wkr < d->num_workers; wkr++)
|
||||
d->bufs[wkr].retptr64[0] = 0;
|
||||
}
|
||||
|
||||
/* creates a distributor instance */
|
||||
struct rte_distributor_v1705 *
|
||||
rte_distributor_create_v1705(const char *name,
|
||||
unsigned int socket_id,
|
||||
unsigned int num_workers,
|
||||
unsigned int alg_type)
|
||||
{
|
||||
struct rte_distributor_v1705 *d;
|
||||
struct rte_dist_burst_list *dist_burst_list;
|
||||
char mz_name[RTE_MEMZONE_NAMESIZE];
|
||||
const struct rte_memzone *mz;
|
||||
unsigned int i;
|
||||
|
||||
/* TODO Reorganise function properly around RTE_DIST_ALG_SINGLE/BURST */
|
||||
|
||||
/* compilation-time checks */
|
||||
RTE_BUILD_BUG_ON((sizeof(*d) & RTE_CACHE_LINE_MASK) != 0);
|
||||
RTE_BUILD_BUG_ON((RTE_DISTRIB_MAX_WORKERS & 7) != 0);
|
||||
|
||||
if (alg_type == RTE_DIST_ALG_SINGLE) {
|
||||
d = malloc(sizeof(struct rte_distributor_v1705));
|
||||
d->d_v20 = rte_distributor_create(name,
|
||||
socket_id, num_workers);
|
||||
if (d->d_v20 == NULL) {
|
||||
/* rte_errno will have been set */
|
||||
return NULL;
|
||||
}
|
||||
d->alg_type = alg_type;
|
||||
return d;
|
||||
}
|
||||
|
||||
if (name == NULL || num_workers >= RTE_DISTRIB_MAX_WORKERS) {
|
||||
rte_errno = EINVAL;
|
||||
return NULL;
|
||||
}
|
||||
|
||||
snprintf(mz_name, sizeof(mz_name), RTE_DISTRIB_PREFIX"%s", name);
|
||||
mz = rte_memzone_reserve(mz_name, sizeof(*d), socket_id, NO_FLAGS);
|
||||
if (mz == NULL) {
|
||||
rte_errno = ENOMEM;
|
||||
return NULL;
|
||||
}
|
||||
|
||||
d = mz->addr;
|
||||
snprintf(d->name, sizeof(d->name), "%s", name);
|
||||
d->num_workers = num_workers;
|
||||
d->alg_type = alg_type;
|
||||
d->dist_match_fn = RTE_DIST_MATCH_SCALAR;
|
||||
|
||||
/*
|
||||
* Set up the backog tags so they're pointing at the second cache
|
||||
* line for performance during flow matching
|
||||
*/
|
||||
for (i = 0 ; i < num_workers ; i++)
|
||||
d->backlog[i].tags = &d->in_flight_tags[i][RTE_DIST_BURST_SIZE];
|
||||
|
||||
dist_burst_list = RTE_TAILQ_CAST(rte_dist_burst_tailq.head,
|
||||
rte_dist_burst_list);
|
||||
|
||||
|
||||
rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
|
||||
TAILQ_INSERT_TAIL(dist_burst_list, d, next);
|
||||
rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
|
||||
|
||||
return d;
|
||||
}
|
||||
269
lib/librte_distributor/rte_distributor_next.h
Normal file
269
lib/librte_distributor/rte_distributor_next.h
Normal file
@ -0,0 +1,269 @@
|
||||
/*-
|
||||
* BSD LICENSE
|
||||
*
|
||||
* Copyright(c) 2017 Intel Corporation. All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* * Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* * Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
* * Neither the name of Intel Corporation nor the names of its
|
||||
* contributors may be used to endorse or promote products derived
|
||||
* from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#ifndef _RTE_DISTRIBUTOR_H_
|
||||
#define _RTE_DISTRIBUTOR_H_
|
||||
|
||||
/**
|
||||
* @file
|
||||
* RTE distributor
|
||||
*
|
||||
* The distributor is a component which is designed to pass packets
|
||||
* one-at-a-time to workers, with dynamic load balancing.
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/* Type of distribution (burst/single) */
|
||||
enum rte_distributor_alg_type {
|
||||
RTE_DIST_ALG_BURST = 0,
|
||||
RTE_DIST_ALG_SINGLE,
|
||||
RTE_DIST_NUM_ALG_TYPES
|
||||
};
|
||||
|
||||
struct rte_distributor_v1705;
|
||||
struct rte_mbuf;
|
||||
|
||||
/**
|
||||
* Function to create a new distributor instance
|
||||
*
|
||||
* Reserves the memory needed for the distributor operation and
|
||||
* initializes the distributor to work with the configured number of workers.
|
||||
*
|
||||
* @param name
|
||||
* The name to be given to the distributor instance.
|
||||
* @param socket_id
|
||||
* The NUMA node on which the memory is to be allocated
|
||||
* @param num_workers
|
||||
* The maximum number of workers that will request packets from this
|
||||
* distributor
|
||||
* @param alg_type
|
||||
* Call the legacy API, or use the new burst API. legacy uses 32-bit
|
||||
* flow ID, and works on a single packet at a time. Latest uses 15-
|
||||
* bit flow ID and works on up to 8 packets at a time to worers.
|
||||
* @return
|
||||
* The newly created distributor instance
|
||||
*/
|
||||
struct rte_distributor_v1705 *
|
||||
rte_distributor_create_v1705(const char *name, unsigned int socket_id,
|
||||
unsigned int num_workers,
|
||||
unsigned int alg_type);
|
||||
|
||||
/* *** APIS to be called on the distributor lcore *** */
|
||||
/*
|
||||
* The following APIs are the public APIs which are designed for use on a
|
||||
* single lcore which acts as the distributor lcore for a given distributor
|
||||
* instance. These functions cannot be called on multiple cores simultaneously
|
||||
* without using locking to protect access to the internals of the distributor.
|
||||
*
|
||||
* NOTE: a given lcore cannot act as both a distributor lcore and a worker lcore
|
||||
* for the same distributor instance, otherwise deadlock will result.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Process a set of packets by distributing them among workers that request
|
||||
* packets. The distributor will ensure that no two packets that have the
|
||||
* same flow id, or tag, in the mbuf will be processed on different cores at
|
||||
* the same time.
|
||||
*
|
||||
* The user is advocated to set tag for each mbuf before calling this function.
|
||||
* If user doesn't set the tag, the tag value can be various values depending on
|
||||
* driver implementation and configuration.
|
||||
*
|
||||
* This is not multi-thread safe and should only be called on a single lcore.
|
||||
*
|
||||
* @param d
|
||||
* The distributor instance to be used
|
||||
* @param mbufs
|
||||
* The mbufs to be distributed
|
||||
* @param num_mbufs
|
||||
* The number of mbufs in the mbufs array
|
||||
* @return
|
||||
* The number of mbufs processed.
|
||||
*/
|
||||
int
|
||||
rte_distributor_process_v1705(struct rte_distributor_v1705 *d,
|
||||
struct rte_mbuf **mbufs, unsigned int num_mbufs);
|
||||
|
||||
/**
|
||||
* Get a set of mbufs that have been returned to the distributor by workers
|
||||
*
|
||||
* This should only be called on the same lcore as rte_distributor_process()
|
||||
*
|
||||
* @param d
|
||||
* The distributor instance to be used
|
||||
* @param mbufs
|
||||
* The mbufs pointer array to be filled in
|
||||
* @param max_mbufs
|
||||
* The size of the mbufs array
|
||||
* @return
|
||||
* The number of mbufs returned in the mbufs array.
|
||||
*/
|
||||
int
|
||||
rte_distributor_returned_pkts_v1705(struct rte_distributor_v1705 *d,
|
||||
struct rte_mbuf **mbufs, unsigned int max_mbufs);
|
||||
|
||||
/**
|
||||
* Flush the distributor component, so that there are no in-flight or
|
||||
* backlogged packets awaiting processing
|
||||
*
|
||||
* This should only be called on the same lcore as rte_distributor_process()
|
||||
*
|
||||
* @param d
|
||||
* The distributor instance to be used
|
||||
* @return
|
||||
* The number of queued/in-flight packets that were completed by this call.
|
||||
*/
|
||||
int
|
||||
rte_distributor_flush_v1705(struct rte_distributor_v1705 *d);
|
||||
|
||||
/**
|
||||
* Clears the array of returned packets used as the source for the
|
||||
* rte_distributor_returned_pkts() API call.
|
||||
*
|
||||
* This should only be called on the same lcore as rte_distributor_process()
|
||||
*
|
||||
* @param d
|
||||
* The distributor instance to be used
|
||||
*/
|
||||
void
|
||||
rte_distributor_clear_returns_v1705(struct rte_distributor_v1705 *d);
|
||||
|
||||
/* *** APIS to be called on the worker lcores *** */
|
||||
/*
|
||||
* The following APIs are the public APIs which are designed for use on
|
||||
* multiple lcores which act as workers for a distributor. Each lcore should use
|
||||
* a unique worker id when requesting packets.
|
||||
*
|
||||
* NOTE: a given lcore cannot act as both a distributor lcore and a worker lcore
|
||||
* for the same distributor instance, otherwise deadlock will result.
|
||||
*/
|
||||
|
||||
/**
|
||||
* API called by a worker to get new packets to process. Any previous packets
|
||||
* given to the worker is assumed to have completed processing, and may be
|
||||
* optionally returned to the distributor via the oldpkt parameter.
|
||||
*
|
||||
* @param d
|
||||
* The distributor instance to be used
|
||||
* @param worker_id
|
||||
* The worker instance number to use - must be less that num_workers passed
|
||||
* at distributor creation time.
|
||||
* @param pkts
|
||||
* The mbufs pointer array to be filled in (up to 8 packets)
|
||||
* @param oldpkt
|
||||
* The previous packet, if any, being processed by the worker
|
||||
* @param retcount
|
||||
* The number of packets being returned
|
||||
*
|
||||
* @return
|
||||
* The number of packets in the pkts array
|
||||
*/
|
||||
int
|
||||
rte_distributor_get_pkt_v1705(struct rte_distributor_v1705 *d,
|
||||
unsigned int worker_id, struct rte_mbuf **pkts,
|
||||
struct rte_mbuf **oldpkt, unsigned int retcount);
|
||||
|
||||
/**
|
||||
* API called by a worker to return a completed packet without requesting a
|
||||
* new packet, for example, because a worker thread is shutting down
|
||||
*
|
||||
* @param d
|
||||
* The distributor instance to be used
|
||||
* @param worker_id
|
||||
* The worker instance number to use - must be less that num_workers passed
|
||||
* at distributor creation time.
|
||||
* @param oldpkt
|
||||
* The previous packets being processed by the worker
|
||||
* @param num
|
||||
* The number of packets in the oldpkt array
|
||||
*/
|
||||
int
|
||||
rte_distributor_return_pkt_v1705(struct rte_distributor_v1705 *d,
|
||||
unsigned int worker_id, struct rte_mbuf **oldpkt, int num);
|
||||
|
||||
/**
|
||||
* API called by a worker to request a new packet to process.
|
||||
* Any previous packet given to the worker is assumed to have completed
|
||||
* processing, and may be optionally returned to the distributor via
|
||||
* the oldpkt parameter.
|
||||
* Unlike rte_distributor_get_pkt_burst(), this function does not wait for a
|
||||
* new packet to be provided by the distributor.
|
||||
*
|
||||
* NOTE: after calling this function, rte_distributor_poll_pkt_burst() should
|
||||
* be used to poll for the packet requested. The rte_distributor_get_pkt_burst()
|
||||
* API should *not* be used to try and retrieve the new packet.
|
||||
*
|
||||
* @param d
|
||||
* The distributor instance to be used
|
||||
* @param worker_id
|
||||
* The worker instance number to use - must be less that num_workers passed
|
||||
* at distributor creation time.
|
||||
* @param oldpkt
|
||||
* The returning packets, if any, processed by the worker
|
||||
* @param count
|
||||
* The number of returning packets
|
||||
*/
|
||||
void
|
||||
rte_distributor_request_pkt_v1705(struct rte_distributor_v1705 *d,
|
||||
unsigned int worker_id, struct rte_mbuf **oldpkt,
|
||||
unsigned int count);
|
||||
|
||||
/**
|
||||
* API called by a worker to check for a new packet that was previously
|
||||
* requested by a call to rte_distributor_request_pkt(). It does not wait
|
||||
* for the new packet to be available, but returns NULL if the request has
|
||||
* not yet been fulfilled by the distributor.
|
||||
*
|
||||
* @param d
|
||||
* The distributor instance to be used
|
||||
* @param worker_id
|
||||
* The worker instance number to use - must be less that num_workers passed
|
||||
* at distributor creation time.
|
||||
* @param mbufs
|
||||
* The array of mbufs being given to the worker
|
||||
*
|
||||
* @return
|
||||
* The number of packets being given to the worker thread, zero if no
|
||||
* packet is yet available.
|
||||
*/
|
||||
int
|
||||
rte_distributor_poll_pkt_v1705(struct rte_distributor_v1705 *d,
|
||||
unsigned int worker_id, struct rte_mbuf **mbufs);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
@ -129,6 +129,67 @@ struct rte_distributor {
|
||||
struct rte_distributor_returned_pkts returns;
|
||||
};
|
||||
|
||||
/* All different signature compare functions */
|
||||
enum rte_distributor_match_function {
|
||||
RTE_DIST_MATCH_SCALAR = 0,
|
||||
RTE_DIST_MATCH_VECTOR,
|
||||
RTE_DIST_NUM_MATCH_FNS
|
||||
};
|
||||
|
||||
/**
|
||||
* Buffer structure used to pass the pointer data between cores. This is cache
|
||||
* line aligned, but to improve performance and prevent adjacent cache-line
|
||||
* prefetches of buffers for other workers, e.g. when worker 1's buffer is on
|
||||
* the next cache line to worker 0, we pad this out to two cache lines.
|
||||
* We can pass up to 8 mbufs at a time in one cacheline.
|
||||
* There is a separate cacheline for returns in the burst API.
|
||||
*/
|
||||
struct rte_distributor_buffer_v1705 {
|
||||
volatile int64_t bufptr64[RTE_DIST_BURST_SIZE]
|
||||
__rte_cache_aligned; /* <= outgoing to worker */
|
||||
|
||||
int64_t pad1 __rte_cache_aligned; /* <= one cache line */
|
||||
|
||||
volatile int64_t retptr64[RTE_DIST_BURST_SIZE]
|
||||
__rte_cache_aligned; /* <= incoming from worker */
|
||||
|
||||
int64_t pad2 __rte_cache_aligned; /* <= one cache line */
|
||||
|
||||
int count __rte_cache_aligned; /* <= number of current mbufs */
|
||||
};
|
||||
|
||||
struct rte_distributor_v1705 {
|
||||
TAILQ_ENTRY(rte_distributor_v1705) next; /**< Next in list. */
|
||||
|
||||
char name[RTE_DISTRIBUTOR_NAMESIZE]; /**< Name of the ring. */
|
||||
unsigned int num_workers; /**< Number of workers polling */
|
||||
unsigned int alg_type; /**< Number of alg types */
|
||||
|
||||
/**>
|
||||
* First cache line in the this array are the tags inflight
|
||||
* on the worker core. Second cache line are the backlog
|
||||
* that are going to go to the worker core.
|
||||
*/
|
||||
uint16_t in_flight_tags[RTE_DISTRIB_MAX_WORKERS][RTE_DIST_BURST_SIZE*2]
|
||||
__rte_cache_aligned;
|
||||
|
||||
struct rte_distributor_backlog backlog[RTE_DISTRIB_MAX_WORKERS]
|
||||
__rte_cache_aligned;
|
||||
|
||||
struct rte_distributor_buffer_v1705 bufs[RTE_DISTRIB_MAX_WORKERS];
|
||||
|
||||
struct rte_distributor_returned_pkts returns;
|
||||
|
||||
enum rte_distributor_match_function dist_match_fn;
|
||||
|
||||
struct rte_distributor *d_v20;
|
||||
};
|
||||
|
||||
void
|
||||
find_match_scalar(struct rte_distributor_v1705 *d,
|
||||
uint16_t *data_ptr,
|
||||
uint16_t *output_ptr);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user