4 * Copyright(c) 2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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
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.
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.
33 #ifndef _RTE_SERVICE_H_
34 #define _RTE_SERVICE_H_
41 * The service functionality provided by this header allows a DPDK component
42 * to indicate that it requires a function call in order for it to perform
45 * An example usage of this functionality would be a component that registers
46 * a service to perform a particular packet processing duty: for example the
47 * eventdev software PMD. At startup the application requests all services
48 * that have been registered, and the cores in the service-coremask run the
49 * required services. The EAL removes these number of cores from the available
50 * runtime cores, and dedicates them to performing service-core workloads. The
51 * application has access to the remaining lcores as normal.
60 #include <sys/queue.h>
62 #include <rte_lcore.h>
64 #define RTE_SERVICE_NAME_MAX 32
66 /* Capabilities of a service.
68 * Use the *rte_service_probe_capability* function to check if a service is
69 * capable of a specific capability.
71 /** When set, the service is capable of having multiple threads run it at the
74 #define RTE_SERVICE_CAP_MT_SAFE (1 << 0)
78 * @b EXPERIMENTAL: this API may change without prior notice
80 * Return the number of services registered.
82 * The number of services registered can be passed to *rte_service_get_by_id*,
83 * enabling the application to retrieve the specification of each service.
85 * @return The number of services registered.
87 uint32_t rte_service_get_count(void);
91 * @b EXPERIMENTAL: this API may change without prior notice
93 * Return the id of a service by name.
95 * This function provides the id of the service using the service name as
96 * lookup key. The service id is to be passed to other functions in the
101 * uint32_t service_id;
102 * int32_t ret = rte_service_get_by_name("service_X", &service_id);
108 * @param name The name of the service to retrieve
109 * @param[out] service_id A pointer to a uint32_t, to be filled in with the id.
110 * @retval 0 Success. The service id is provided in *service_id*.
111 * @retval -EINVAL Null *service_id* pointer provided
112 * @retval -ENODEV No such service registered
114 int32_t rte_service_get_by_name(const char *name, uint32_t *service_id);
118 * @b EXPERIMENTAL: this API may change without prior notice
120 * Return the name of the service.
122 * @return A pointer to the name of the service. The returned pointer remains
123 * in ownership of the service, and the application must not free it.
125 const char *rte_service_get_name(uint32_t id);
129 * @b EXPERIMENTAL: this API may change without prior notice
131 * Check if a service has a specific capability.
133 * This function returns if *service* has implements *capability*.
134 * See RTE_SERVICE_CAP_* defines for a list of valid capabilities.
135 * @retval 1 Capability supported by this service instance
136 * @retval 0 Capability not supported by this service instance
138 int32_t rte_service_probe_capability(uint32_t id, uint32_t capability);
142 * @b EXPERIMENTAL: this API may change without prior notice
144 * Map or unmap a lcore to a service.
146 * Each core can be added or removed from running a specific service. This
147 * function enables or disables *lcore* to run *service_id*.
149 * If multiple cores are enabled on a service, an atomic is used to ensure that
150 * only one cores runs the service at a time. The exception to this is when
151 * a service indicates that it is multi-thread safe by setting the capability
152 * called RTE_SERVICE_CAP_MT_SAFE. With the multi-thread safe capability set,
153 * the service function can be run on multiple threads at the same time.
155 * @param service_id the service to apply the lcore to
156 * @param lcore The lcore that will be mapped to service
157 * @param enable Zero to unmap or disable the core, non-zero to enable
159 * @retval 0 lcore map updated successfully
160 * @retval -EINVAL An invalid service or lcore was provided.
162 int32_t rte_service_map_lcore_set(uint32_t service_id, uint32_t lcore,
167 * @b EXPERIMENTAL: this API may change without prior notice
169 * Retrieve the mapping of an lcore to a service.
171 * @param service_id the service to apply the lcore to
172 * @param lcore The lcore that will be mapped to service
174 * @retval 1 lcore is mapped to service
175 * @retval 0 lcore is not mapped to service
176 * @retval -EINVAL An invalid service or lcore was provided.
178 int32_t rte_service_map_lcore_get(uint32_t service_id, uint32_t lcore);
182 * @b EXPERIMENTAL: this API may change without prior notice
184 * Set the runstate of the service.
186 * Each service is either running or stopped. Setting a non-zero runstate
187 * enables the service to run, while setting runstate zero disables it.
189 * @param id The id of the service
190 * @param runstate The run state to apply to the service
192 * @retval 0 The service was successfully started
193 * @retval -EINVAL Invalid service id
195 int32_t rte_service_runstate_set(uint32_t id, uint32_t runstate);
199 * @b EXPERIMENTAL: this API may change without prior notice
201 * Get the runstate for the service with *id*. See *rte_service_runstate_set*
202 * for details of runstates. A service can call this function to ensure that
203 * the application has indicated that it will receive CPU cycles. Either a
204 * service-core is mapped (default case), or the application has explicitly
205 * disabled the check that a service-cores is mapped to the service and takes
206 * responsibility to run the service manually using the available function
207 * *rte_service_run_iter_on_app_lcore* to do so.
209 * @retval 1 Service is running
210 * @retval 0 Service is stopped
211 * @retval -EINVAL Invalid service id
213 int32_t rte_service_runstate_get(uint32_t id);
217 * @b EXPERIMENTAL: this API may change without prior notice
219 * Enable or disable the check for a service-core being mapped to the service.
220 * An application can disable the check when takes the responsibility to run a
221 * service itself using *rte_service_run_iter_on_app_lcore*.
223 * @param id The id of the service to set the check on
224 * @param enable When zero, the check is disabled. Non-zero enables the check.
227 * @retval -EINVAL Invalid service ID
229 int32_t rte_service_set_runstate_mapped_check(uint32_t id, int32_t enable);
233 * @b EXPERIMENTAL: this API may change without prior notice
235 * This function runs a service callback from a non-service lcore.
237 * This function is designed to enable gradual porting to service cores, and
238 * to enable unit tests to verify a service behaves as expected.
240 * When called, this function ensures that the service identified by *id* is
241 * safe to run on this lcore. Multi-thread safe services are invoked even if
242 * other cores are simultaneously running them as they are multi-thread safe.
244 * Multi-thread unsafe services are handled depending on the variable
245 * *serialize_multithread_unsafe*:
246 * - When set, the function will check if a service is already being invoked
247 * on another lcore, refusing to run it and returning -EBUSY.
248 * - When zero, the application takes responsibility to ensure that the service
249 * indicated by *id* is not going to be invoked by another lcore. This setting
250 * avoids atomic operations, so is likely to be more performant.
252 * @param id The ID of the service to run
253 * @param serialize_multithread_unsafe This parameter indicates to the service
254 * cores library if it is required to use atomics to serialize access
255 * to mult-thread unsafe services. As there is an overhead in using
256 * atomics, applications can choose to enable or disable this feature
258 * Note that any thread calling this function MUST be a DPDK EAL thread, as
259 * the *rte_lcore_id* function is used to access internal data structures.
261 * @retval 0 Service was run on the calling thread successfully
262 * @retval -EBUSY Another lcore is executing the service, and it is not a
263 * multi-thread safe service, so the service was not run on this lcore
264 * @retval -ENOEXEC Service is not in a run-able state
265 * @retval -EINVAL Invalid service id
267 int32_t rte_service_run_iter_on_app_lcore(uint32_t id,
268 uint32_t serialize_multithread_unsafe);
272 * @b EXPERIMENTAL: this API may change without prior notice
274 * Start a service core.
276 * Starting a core makes the core begin polling. Any services assigned to it
277 * will be run as fast as possible.
280 * @retval -EINVAL Failed to start core. The *lcore_id* passed in is not
281 * currently assigned to be a service core.
283 int32_t rte_service_lcore_start(uint32_t lcore_id);
287 * @b EXPERIMENTAL: this API may change without prior notice
289 * Stop a service core.
291 * Stopping a core makes the core become idle, but remains assigned as a
295 * @retval -EINVAL Invalid *lcore_id* provided
296 * @retval -EALREADY Already stopped core
297 * @retval -EBUSY Failed to stop core, as it would cause a service to not
298 * be run, as this is the only core currently running the service.
299 * The application must stop the service first, and then stop the
302 int32_t rte_service_lcore_stop(uint32_t lcore_id);
306 * @b EXPERIMENTAL: this API may change without prior notice
308 * Adds lcore to the list of service cores.
310 * This functions can be used at runtime in order to modify the service core
314 * @retval -EBUSY lcore is busy, and not available for service core duty
315 * @retval -EALREADY lcore is already added to the service core list
316 * @retval -EINVAL Invalid lcore provided
318 int32_t rte_service_lcore_add(uint32_t lcore);
322 * @b EXPERIMENTAL: this API may change without prior notice
324 * Removes lcore from the list of service cores.
326 * This can fail if the core is not stopped, see *rte_service_core_stop*.
329 * @retval -EBUSY Lcore is not stopped, stop service core before removing.
330 * @retval -EINVAL failed to add lcore to service core mask.
332 int32_t rte_service_lcore_del(uint32_t lcore);
336 * @b EXPERIMENTAL: this API may change without prior notice
338 * Retrieve the number of service cores currently available.
340 * This function returns the integer count of service cores available. The
341 * service core count can be used in mapping logic when creating mappings
342 * from service cores to services.
344 * See *rte_service_lcore_list* for details on retrieving the lcore_id of each
347 * @return The number of service cores currently configured.
349 int32_t rte_service_lcore_count(void);
353 * @b EXPERIMENTAL: this API may change without prior notice
355 * Resets all service core mappings. This does not remove the service cores
356 * from duty, just unmaps all services / cores, and stops() the service cores.
357 * The runstate of services is not modified.
361 int32_t rte_service_lcore_reset_all(void);
365 * @b EXPERIMENTAL: this API may change without prior notice
367 * Enable or disable statistics collection for *service*.
369 * This function enables per core, per-service cycle count collection.
370 * @param id The service to enable statistics gathering on.
371 * @param enable Zero to disable statistics, non-zero to enable.
373 * @retval -EINVAL Invalid service pointer passed
375 int32_t rte_service_set_stats_enable(uint32_t id, int32_t enable);
379 * @b EXPERIMENTAL: this API may change without prior notice
381 * Retrieve the list of currently enabled service cores.
383 * This function fills in an application supplied array, with each element
384 * indicating the lcore_id of a service core.
386 * Adding and removing service cores can be performed using
387 * *rte_service_lcore_add* and *rte_service_lcore_del*.
388 * @param [out] array An array of at least *rte_service_lcore_count* items.
389 * If statically allocating the buffer, use RTE_MAX_LCORE.
390 * @param [out] n The size of *array*.
391 * @retval >=0 Number of service cores that have been populated in the array
392 * @retval -ENOMEM The provided array is not large enough to fill in the
393 * service core list. No items have been populated, call this function
394 * with a size of at least *rte_service_core_count* items.
396 int32_t rte_service_lcore_list(uint32_t array[], uint32_t n);
400 * @b EXPERIMENTAL: this API may change without prior notice
402 * Get the numer of services running on the supplied lcore.
404 * @param lcore Id of the service core.
405 * @retval >=0 Number of services registered to this core.
406 * @retval -EINVAL Invalid lcore provided
407 * @retval -ENOTSUP The provided lcore is not a service core.
409 int32_t rte_service_lcore_count_services(uint32_t lcore);
413 * @b EXPERIMENTAL: this API may change without prior notice
415 * Dumps any information available about the service. When id is UINT32_MAX,
416 * this function dumps info for all services.
418 * @retval 0 Statistics have been successfully dumped
419 * @retval -EINVAL Invalid service id provided
421 int32_t rte_service_dump(FILE *f, uint32_t id);
428 #endif /* _RTE_SERVICE_H_ */