| rte_service.h(3) | Library Functions Manual | rte_service.h(3) |
rte_service.h
#include <stdio.h>
#include <stdint.h>
#include <rte_config.h>
#include <rte_lcore.h>
#define RTE_SERVICE_CAP_MT_SAFE (1 << 0)
#define RTE_SERVICE_ATTR_CYCLES 0
#define RTE_SERVICE_ATTR_CALL_COUNT 1
#define RTE_SERVICE_ATTR_IDLE_CALL_COUNT 2
#define RTE_SERVICE_ATTR_ERROR_CALL_COUNT 3
#define RTE_SERVICE_LCORE_ATTR_LOOPS 0
#define RTE_SERVICE_LCORE_ATTR_CYCLES 1
uint32_t rte_service_get_count (void)
int32_t rte_service_get_by_name (const char *name, uint32_t
*service_id)
const char * rte_service_get_name (uint32_t id)
int32_t rte_service_probe_capability (uint32_t id, uint32_t capability)
int32_t rte_service_map_lcore_set (uint32_t service_id, uint32_t lcore,
uint32_t enable)
int32_t rte_service_map_lcore_get (uint32_t service_id, uint32_t lcore)
int32_t rte_service_runstate_set (uint32_t id, uint32_t runstate)
int32_t rte_service_runstate_get (uint32_t id)
int32_t rte_service_may_be_active (uint32_t id)
int32_t rte_service_set_runstate_mapped_check (uint32_t id, int32_t
enable)
int32_t rte_service_run_iter_on_app_lcore (uint32_t id, uint32_t
serialize_multithread_unsafe)
int32_t rte_service_lcore_start (uint32_t lcore_id)
int32_t rte_service_lcore_stop (uint32_t lcore_id)
int32_t rte_service_lcore_may_be_active (uint32_t lcore_id)
int32_t rte_service_lcore_add (uint32_t lcore)
int32_t rte_service_lcore_del (uint32_t lcore)
int32_t rte_service_lcore_count (void)
int32_t rte_service_lcore_reset_all (void)
int32_t rte_service_set_stats_enable (uint32_t id, int32_t enable)
int32_t rte_service_lcore_list (uint32_t array[], uint32_t n)
int32_t rte_service_lcore_count_services (uint32_t lcore)
int32_t rte_service_dump (FILE *f, uint32_t id)
int32_t rte_service_attr_get (uint32_t id, uint32_t attr_id, uint64_t
*attr_value)
int32_t rte_service_attr_reset_all (uint32_t id)
int32_t rte_service_lcore_attr_get (uint32_t lcore, uint32_t attr_id,
uint64_t *attr_value)
int32_t rte_service_lcore_attr_reset_all (uint32_t lcore)
Service functions
The service functionality provided by this header allows a DPDK component to indicate that it requires a function call in order for it to perform its processing.
An example usage of this functionality would be a component that registers a service to perform a particular packet processing duty: for example the eventdev software PMD. At startup the application requests all services that have been registered, and the cores in the service-coremask run the required services. The EAL removes these number of cores from the available runtime cores, and dedicates them to performing service-core workloads. The application has access to the remaining lcores as normal.
Definition in file rte_service.h.
When set, the service is capable of having multiple threads run it at the same time.
Definition at line 46 of file rte_service.h.
Returns the number of cycles that this service has consumed. Only cycles spent in non-idle calls (i.e., calls not returning -EAGAIN) count.
Definition at line 381 of file rte_service.h.
Returns the total number of invocations of this service function (regardless of return value).
Definition at line 387 of file rte_service.h.
Returns the number of invocations of this service function where the service reported having not performed any useful work (i.e., returned -EAGAIN).
Definition at line 394 of file rte_service.h.
Returns the number of invocations of this service function where the service reported an error (i.e., the return value was neither 0 nor -EAGAIN).
Definition at line 401 of file rte_service.h.
Returns the number of times the service runner has looped.
Definition at line 424 of file rte_service.h.
Returns the total number of cycles that the lcore has spent on running services. Only non-idle calls (i.e., calls not returning -EAGAIN) count toward this total.
Definition at line 431 of file rte_service.h.
Return the number of services registered.
Returns
Return the id of a service by name.
This function provides the id of the service using the service name as lookup key. The service id is to be passed to other functions in the rte_service_* API.
Example usage:
uint32_t service_id;
int32_t ret = rte_service_get_by_name("service_X", &service_id);
if (ret) {
// handle error
}
Parameters
Return values
Return the name of the service.
Returns
Check if a service has a specific capability.
This function returns if service has implements capability. See RTE_SERVICE_CAP_* defines for a list of valid capabilities.
Return values
Map or unmap a lcore to a service.
Each core can be added or removed from running a specific service. This function enables or disables lcore to run service_id.
If multiple cores are enabled on a service, a lock is used to ensure that only one core runs the service at a time. The exception to this is when a service indicates that it is multi-thread safe by setting the capability called RTE_SERVICE_CAP_MT_SAFE. With the multi-thread safe capability set, the service function can be run on multiple threads at the same time.
If the service is known to be mapped to a single lcore, setting the capability of the service to RTE_SERVICE_CAP_MT_SAFE can achieve better performance by avoiding the use of lock.
Parameters
Return values
Retrieve the mapping of an lcore to a service.
Parameters
Return values
Set the runstate of the service.
Each service is either running or stopped. Setting a non-zero runstate enables the service to run, while setting runstate zero disables it.
Parameters
Return values
Get the runstate for the service with id. See rte_service_runstate_set() for details of runstates. A service can call this function to ensure that the application has indicated that it will receive CPU cycles. Either a service-core is mapped (default case), or the application has explicitly disabled the check that a service-cores is mapped to the service and takes responsibility to run the service manually using the available function rte_service_run_iter_on_app_lcore() to do so.
Return values
This function returns whether the service may be currently executing on at least one lcore, or definitely is not. This function can be used to determine if, after setting the service runstate to stopped, the service is still executing a service lcore.
Care must be taken if calling this function when the service runstate is running, since the result of this function may be incorrect by the time the function returns due to service cores running in parallel.
Return values
Enable or disable the check for a service-core being mapped to the service. An application can disable the check when takes the responsibility to run a service itself using rte_service_run_iter_on_app_lcore().
Parameters
Return values
This function runs a service callback from a non-service lcore.
This function is designed to enable gradual porting to service cores, and to enable unit tests to verify a service behaves as expected.
When called, this function ensures that the service identified by id is safe to run on this lcore. Multi-thread safe services are invoked even if other cores are simultaneously running them as they are multi-thread safe.
Multi-thread unsafe services are handled depending on the variable serialize_multithread_unsafe:
Parameters
Note that any thread calling this function MUST be a DPDK EAL thread, as the rte_lcore_id() function is used to access internal data structures.
Return values
Start a service core.
Starting a core makes the core begin polling. Any services assigned to it will be run as fast as possible. The application must ensure that the lcore is in a launchable state: e.g. call rte_eal_lcore_wait() on the lcore_id before calling this function.
Return values
Stop a service core.
Stopping a core makes the core become idle, but remains assigned as a service core. Note that the service lcore thread may not have returned from the service it is running when this API returns.
The rte_service_lcore_may_be_active() API can be used to check if the service lcore is * still active.
Return values
Reports if a service lcore is currently running.
This function returns if the core has finished service cores code, and has returned to EAL control. If rte_service_lcore_stop() has been called but the lcore has not returned to EAL yet, it might be required to wait and call this function again. The amount of time to wait before the core returns depends on the duration of the services being run.
Return values
Adds lcore to the list of service cores.
This functions can be used at runtime in order to modify the service core mask.
Return values
Removes lcore from the list of service cores.
This can fail if the core is not stopped, see rte_service_core_stop().
Return values
Retrieve the number of service cores currently available.
This function returns the integer count of service cores available. The service core count can be used in mapping logic when creating mappings from service cores to services.
See rte_service_lcore_list() for details on retrieving the lcore_id of each service core.
Returns
Resets all service core mappings. This does not remove the service cores from duty, just unmaps all services / cores, and stops() the service cores. The runstate of services is not modified.
The cores that are stopped with this call, are in WAIT state.
Return values
Enable or disable statistics collection for service.
This function enables per core, per-service cycle count collection.
Parameters
Return values
Retrieve the list of currently enabled service cores.
This function fills in an application supplied array, with each element indicating the lcore_id of a service core.
Adding and removing service cores can be performed using rte_service_lcore_add() and rte_service_lcore_del().
Parameters
Return values
Get the number of services running on the supplied lcore.
Parameters
Return values
Dumps any information available about the service. When id is UINT32_MAX, this function dumps info for all services.
Return values
Get an attribute from a service.
Return values
Reset all attribute values of a service.
Parameters
Return values
Get an attribute from a service core.
Parameters
Return values
Reset all attribute values of a service core.
Parameters
Return values
Generated automatically by Doxygen for DPDK from the source code.
| Version 24.11.3 | DPDK |