1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef _RTE_DISTRIBUTOR_H_
6 #define _RTE_DISTRIBUTOR_H_
12 * The distributor is a component which is designed to pass packets
13 * one-at-a-time to workers, with dynamic load balancing.
20 /* Type of distribution (burst/single) */
21 enum rte_distributor_alg_type {
22 RTE_DIST_ALG_BURST = 0,
24 RTE_DIST_NUM_ALG_TYPES
27 struct rte_distributor;
31 * Function to create a new distributor instance
33 * Reserves the memory needed for the distributor operation and
34 * initializes the distributor to work with the configured number of workers.
37 * The name to be given to the distributor instance.
39 * The NUMA node on which the memory is to be allocated
41 * The maximum number of workers that will request packets from this
44 * Call the legacy API, or use the new burst API. legacy uses 32-bit
45 * flow ID, and works on a single packet at a time. Latest uses 15-
46 * bit flow ID and works on up to 8 packets at a time to workers.
48 * The newly created distributor instance
50 struct rte_distributor *
51 rte_distributor_create(const char *name, unsigned int socket_id,
52 unsigned int num_workers,
53 unsigned int alg_type);
55 /* *** APIS to be called on the distributor lcore *** */
57 * The following APIs are the public APIs which are designed for use on a
58 * single lcore which acts as the distributor lcore for a given distributor
59 * instance. These functions cannot be called on multiple cores simultaneously
60 * without using locking to protect access to the internals of the distributor.
62 * NOTE: a given lcore cannot act as both a distributor lcore and a worker lcore
63 * for the same distributor instance, otherwise deadlock will result.
67 * Process a set of packets by distributing them among workers that request
68 * packets. The distributor will ensure that no two packets that have the
69 * same flow id, or tag, in the mbuf will be processed on different cores at
72 * The user is advocated to set tag for each mbuf before calling this function.
73 * If user doesn't set the tag, the tag value can be various values depending on
74 * driver implementation and configuration.
76 * This is not multi-thread safe and should only be called on a single lcore.
79 * The distributor instance to be used
81 * The mbufs to be distributed
83 * The number of mbufs in the mbufs array
85 * The number of mbufs processed.
88 rte_distributor_process(struct rte_distributor *d,
89 struct rte_mbuf **mbufs, unsigned int num_mbufs);
92 * Get a set of mbufs that have been returned to the distributor by workers
94 * This should only be called on the same lcore as rte_distributor_process()
97 * The distributor instance to be used
99 * The mbufs pointer array to be filled in
101 * The size of the mbufs array
103 * The number of mbufs returned in the mbufs array.
106 rte_distributor_returned_pkts(struct rte_distributor *d,
107 struct rte_mbuf **mbufs, unsigned int max_mbufs);
110 * Flush the distributor component, so that there are no in-flight or
111 * backlogged packets awaiting processing
113 * This should only be called on the same lcore as rte_distributor_process()
116 * The distributor instance to be used
118 * The number of queued/in-flight packets that were completed by this call.
121 rte_distributor_flush(struct rte_distributor *d);
124 * Clears the array of returned packets used as the source for the
125 * rte_distributor_returned_pkts() API call.
127 * This should only be called on the same lcore as rte_distributor_process()
130 * The distributor instance to be used
133 rte_distributor_clear_returns(struct rte_distributor *d);
135 /* *** APIS to be called on the worker lcores *** */
137 * The following APIs are the public APIs which are designed for use on
138 * multiple lcores which act as workers for a distributor. Each lcore should use
139 * a unique worker id when requesting packets.
141 * NOTE: a given lcore cannot act as both a distributor lcore and a worker lcore
142 * for the same distributor instance, otherwise deadlock will result.
146 * API called by a worker to get new packets to process. Any previous packets
147 * given to the worker is assumed to have completed processing, and may be
148 * optionally returned to the distributor via the oldpkt parameter.
151 * The distributor instance to be used
153 * The worker instance number to use - must be less that num_workers passed
154 * at distributor creation time.
156 * The mbufs pointer array to be filled in (up to 8 packets)
158 * The previous packet, if any, being processed by the worker
160 * The number of packets being returned
163 * The number of packets in the pkts array
166 rte_distributor_get_pkt(struct rte_distributor *d,
167 unsigned int worker_id, struct rte_mbuf **pkts,
168 struct rte_mbuf **oldpkt, unsigned int retcount);
171 * API called by a worker to return a completed packet without requesting a
172 * new packet, for example, because a worker thread is shutting down
175 * The distributor instance to be used
177 * The worker instance number to use - must be less that num_workers passed
178 * at distributor creation time.
180 * The previous packets being processed by the worker
182 * The number of packets in the oldpkt array
185 rte_distributor_return_pkt(struct rte_distributor *d,
186 unsigned int worker_id, struct rte_mbuf **oldpkt, int num);
189 * API called by a worker to request a new packet to process.
190 * Any previous packet given to the worker is assumed to have completed
191 * processing, and may be optionally returned to the distributor via
192 * the oldpkt parameter.
193 * Unlike rte_distributor_get_pkt_burst(), this function does not wait for a
194 * new packet to be provided by the distributor.
196 * NOTE: after calling this function, rte_distributor_poll_pkt_burst() should
197 * be used to poll for the packet requested. The rte_distributor_get_pkt_burst()
198 * API should *not* be used to try and retrieve the new packet.
201 * The distributor instance to be used
203 * The worker instance number to use - must be less that num_workers passed
204 * at distributor creation time.
206 * The returning packets, if any, processed by the worker
208 * The number of returning packets
211 rte_distributor_request_pkt(struct rte_distributor *d,
212 unsigned int worker_id, struct rte_mbuf **oldpkt,
216 * API called by a worker to check for a new packet that was previously
217 * requested by a call to rte_distributor_request_pkt(). It does not wait
218 * for the new packet to be available, but returns NULL if the request has
219 * not yet been fulfilled by the distributor.
222 * The distributor instance to be used
224 * The worker instance number to use - must be less that num_workers passed
225 * at distributor creation time.
227 * The array of mbufs being given to the worker
230 * The number of packets being given to the worker thread, zero if no
231 * packet is yet available.
234 rte_distributor_poll_pkt(struct rte_distributor *d,
235 unsigned int worker_id, struct rte_mbuf **mbufs);