lib/librte_distributor/rte_distributor_v1705.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 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 #ifndef _RTE_DISTRIB_V1705_H_
  34 #define _RTE_DISTRIB_V1705_H_
  35
  36 /**
  37  * @file
  38  * RTE distributor
  39  *
  40  * The distributor is a component which is designed to pass packets
  41  * one-at-a-time to workers, with dynamic load balancing.
  42  */
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 struct rte_distributor *
  49 rte_distributor_create_v1705(const char *name, unsigned int socket_id,
  50                 unsigned int num_workers,
  51                 unsigned int alg_type);
  52
  53 int
  54 rte_distributor_process_v1705(struct rte_distributor *d,
  55                 struct rte_mbuf **mbufs, unsigned int num_mbufs);
  56
  57 int
  58 rte_distributor_returned_pkts_v1705(struct rte_distributor *d,
  59                 struct rte_mbuf **mbufs, unsigned int max_mbufs);
  60
  61 int
  62 rte_distributor_flush_v1705(struct rte_distributor *d);
  63
  64 void
  65 rte_distributor_clear_returns_v1705(struct rte_distributor *d);
  66
  67 int
  68 rte_distributor_get_pkt_v1705(struct rte_distributor *d,
  69         unsigned int worker_id, struct rte_mbuf **pkts,
  70         struct rte_mbuf **oldpkt, unsigned int retcount);
  71
  72 int
  73 rte_distributor_return_pkt_v1705(struct rte_distributor *d,
  74         unsigned int worker_id, struct rte_mbuf **oldpkt, int num);
  75
  76 void
  77 rte_distributor_request_pkt_v1705(struct rte_distributor *d,
  78                 unsigned int worker_id, struct rte_mbuf **oldpkt,
  79                 unsigned int count);
  80
  81 int
  82 rte_distributor_poll_pkt_v1705(struct rte_distributor *d,
  83                 unsigned int worker_id, struct rte_mbuf **mbufs);
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif
  88
  89 #endif