1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef _RTE_SERVICE_PRIVATE_H_
6 #define _RTE_SERVICE_PRIVATE_H_
8 /* This file specifies the internal service specification.
9 * Include this file if you are writing a component that requires CPU cycles to
10 * operate, and you wish to run the component using service cores
13 #include <rte_service.h>
17 * @b EXPERIMENTAL: this API may change without prior notice
19 * Signature of callback function to run a service.
21 typedef int32_t (*rte_service_func)(void *args);
25 * @b EXPERIMENTAL: this API may change without prior notice
27 * The specification of a service.
29 * This struct contains metadata about the service itself, the callback
30 * function to run one iteration of the service, a userdata pointer, flags etc.
32 struct rte_service_spec {
33 /** The name of the service. This should be used by the application to
34 * understand what purpose this service provides.
36 char name[RTE_SERVICE_NAME_MAX];
37 /** The callback to invoke to run one iteration of the service. */
38 rte_service_func callback;
39 /** The userdata pointer provided to the service callback. */
40 void *callback_userdata;
41 /** Flags to indicate the capabilities of this service. See defines in
42 * the public header file for values of RTE_SERVICE_CAP_*
44 uint32_t capabilities;
45 /** NUMA socket ID that this service is affinitized to */
51 * @b EXPERIMENTAL: this API may change without prior notice
53 * Register a new service.
55 * A service represents a component that the requires CPU time periodically to
56 * achieve its purpose.
58 * For example the eventdev SW PMD requires CPU cycles to perform its
59 * scheduling. This can be achieved by registering it as a service, and the
60 * application can then assign CPU resources to that service.
62 * Note that when a service component registers itself, it is not permitted to
63 * add or remove service-core threads, or modify lcore-to-service mappings. The
64 * only API that may be called by the service-component is
65 * *rte_service_component_runstate_set*, which indicates that the service
66 * component is ready to be executed.
68 * @param spec The specification of the service to register
69 * @param[out] service_id A pointer to a uint32_t, which will be filled in
70 * during registration of the service. It is set to the integers
71 * service number given to the service. This parameter may be NULL.
72 * @retval 0 Successfully registered the service.
73 * -EINVAL Attempted to register an invalid service (eg, no callback
76 int32_t rte_service_component_register(const struct rte_service_spec *spec,
77 uint32_t *service_id);
81 * @b EXPERIMENTAL: this API may change without prior notice
83 * Unregister a service component.
85 * The service being removed must be stopped before calling this function.
87 * @retval 0 The service was successfully unregistered.
88 * @retval -EBUSY The service is currently running, stop the service before
89 * calling unregister. No action has been taken.
91 int32_t rte_service_component_unregister(uint32_t id);
95 * @b EXPERIMENTAL: this API may change without prior notice
97 * Private function to allow EAL to initialized default mappings.
99 * This function iterates all the services, and maps then to the available
100 * cores. Based on the capabilities of the services, they are set to run on the
101 * available cores in a round-robin manner.
104 * @retval -ENOTSUP No service lcores in use
105 * @retval -EINVAL Error while iterating over services
106 * @retval -ENODEV Error in enabling service lcore on a service
107 * @retval -ENOEXEC Error when starting services
109 int32_t rte_service_start_with_defaults(void);
113 * @b EXPERIMENTAL: this API may change without prior notice
115 * Set the backend runstate of a component.
117 * This function allows services to be registered at startup, but not yet
118 * enabled to run by default. When the service has been configured (via the
119 * usual method; eg rte_eventdev_configure, the service can mark itself as
120 * ready to run. The differentiation between backend runstate and
121 * service_runstate is that the backend runstate is set by the service
122 * component while the service runstate is reserved for application usage.
126 int32_t rte_service_component_runstate_set(uint32_t id, uint32_t runstate);
130 * @b EXPERIMENTAL: this API may change without prior notice
132 * Initialize the service library.
134 * In order to use the service library, it must be initialized. EAL initializes
135 * the library at startup.
138 * @retval -EALREADY Service library is already initialized
140 int32_t rte_service_init(void);
144 * @b EXPERIMENTAL: this API may change without prior notice
146 * @internal Free up the memory that has been initialized.
147 * This routine is to be invoked prior to process termination.
151 void rte_service_finalize(void);
153 #endif /* _RTE_SERVICE_PRIVATE_H_ */