rte_distributor.h

Go to the documentation of this file.

/*-
 *   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_

#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;
struct rte_mbuf;

struct rte_distributor *
rte_distributor_create(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.
 */

int
rte_distributor_process(struct rte_distributor *d,
                struct rte_mbuf **mbufs, unsigned int num_mbufs);

int
rte_distributor_returned_pkts(struct rte_distributor *d,
                struct rte_mbuf **mbufs, unsigned int max_mbufs);

int
rte_distributor_flush(struct rte_distributor *d);

void
rte_distributor_clear_returns(struct rte_distributor *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.
 */

int
rte_distributor_get_pkt(struct rte_distributor *d,
        unsigned int worker_id, struct rte_mbuf **pkts,
        struct rte_mbuf **oldpkt, unsigned int retcount);

int
rte_distributor_return_pkt(struct rte_distributor *d,
        unsigned int worker_id, struct rte_mbuf **oldpkt, int num);

void
rte_distributor_request_pkt(struct rte_distributor *d,
                unsigned int worker_id, struct rte_mbuf **oldpkt,
                unsigned int count);

int
rte_distributor_poll_pkt(struct rte_distributor *d,
                unsigned int worker_id, struct rte_mbuf **mbufs);

#ifdef __cplusplus
}
#endif

#endif