1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef _RTE_SERVICE_H_
6 #define _RTE_SERVICE_H_
13 * The service functionality provided by this header allows a DPDK component
14 * to indicate that it requires a function call in order for it to perform
17 * An example usage of this functionality would be a component that registers
18 * a service to perform a particular packet processing duty: for example the
19 * eventdev software PMD. At startup the application requests all services
20 * that have been registered, and the cores in the service-coremask run the
21 * required services. The EAL removes these number of cores from the available
22 * runtime cores, and dedicates them to performing service-core workloads. The
23 * application has access to the remaining lcores as normal.
32 #include <sys/queue.h>
34 #include <rte_config.h>
35 #include <rte_lcore.h>
37 #define RTE_SERVICE_NAME_MAX 32
39 /* Capabilities of a service.
41 * Use the *rte_service_probe_capability* function to check if a service is
42 * capable of a specific capability.
44 /** When set, the service is capable of having multiple threads run it at the
47 #define RTE_SERVICE_CAP_MT_SAFE (1 << 0)
51 * @b EXPERIMENTAL: this API may change without prior notice
53 * Return the number of services registered.
55 * The number of services registered can be passed to *rte_service_get_by_id*,
56 * enabling the application to retrieve the specification of each service.
58 * @return The number of services registered.
60 uint32_t rte_service_get_count(void);
64 * @b EXPERIMENTAL: this API may change without prior notice
66 * Return the id of a service by name.
68 * This function provides the id of the service using the service name as
69 * lookup key. The service id is to be passed to other functions in the
74 * uint32_t service_id;
75 * int32_t ret = rte_service_get_by_name("service_X", &service_id);
81 * @param name The name of the service to retrieve
82 * @param[out] service_id A pointer to a uint32_t, to be filled in with the id.
83 * @retval 0 Success. The service id is provided in *service_id*.
84 * @retval -EINVAL Null *service_id* pointer provided
85 * @retval -ENODEV No such service registered
87 int32_t rte_service_get_by_name(const char *name, uint32_t *service_id);
91 * @b EXPERIMENTAL: this API may change without prior notice
93 * Return the name of the service.
95 * @return A pointer to the name of the service. The returned pointer remains
96 * in ownership of the service, and the application must not free it.
98 const char *rte_service_get_name(uint32_t id);
102 * @b EXPERIMENTAL: this API may change without prior notice
104 * Check if a service has a specific capability.
106 * This function returns if *service* has implements *capability*.
107 * See RTE_SERVICE_CAP_* defines for a list of valid capabilities.
108 * @retval 1 Capability supported by this service instance
109 * @retval 0 Capability not supported by this service instance
111 int32_t rte_service_probe_capability(uint32_t id, uint32_t capability);
115 * @b EXPERIMENTAL: this API may change without prior notice
117 * Map or unmap a lcore to a service.
119 * Each core can be added or removed from running a specific service. This
120 * function enables or disables *lcore* to run *service_id*.
122 * If multiple cores are enabled on a service, an atomic is used to ensure that
123 * only one cores runs the service at a time. The exception to this is when
124 * a service indicates that it is multi-thread safe by setting the capability
125 * called RTE_SERVICE_CAP_MT_SAFE. With the multi-thread safe capability set,
126 * the service function can be run on multiple threads at the same time.
128 * @param service_id the service to apply the lcore to
129 * @param lcore The lcore that will be mapped to service
130 * @param enable Zero to unmap or disable the core, non-zero to enable
132 * @retval 0 lcore map updated successfully
133 * @retval -EINVAL An invalid service or lcore was provided.
135 int32_t rte_service_map_lcore_set(uint32_t service_id, uint32_t lcore,
140 * @b EXPERIMENTAL: this API may change without prior notice
142 * Retrieve the mapping of an lcore to a service.
144 * @param service_id the service to apply the lcore to
145 * @param lcore The lcore that will be mapped to service
147 * @retval 1 lcore is mapped to service
148 * @retval 0 lcore is not mapped to service
149 * @retval -EINVAL An invalid service or lcore was provided.
151 int32_t rte_service_map_lcore_get(uint32_t service_id, uint32_t lcore);
155 * @b EXPERIMENTAL: this API may change without prior notice
157 * Set the runstate of the service.
159 * Each service is either running or stopped. Setting a non-zero runstate
160 * enables the service to run, while setting runstate zero disables it.
162 * @param id The id of the service
163 * @param runstate The run state to apply to the service
165 * @retval 0 The service was successfully started
166 * @retval -EINVAL Invalid service id
168 int32_t rte_service_runstate_set(uint32_t id, uint32_t runstate);
172 * @b EXPERIMENTAL: this API may change without prior notice
174 * Get the runstate for the service with *id*. See *rte_service_runstate_set*
175 * for details of runstates. A service can call this function to ensure that
176 * the application has indicated that it will receive CPU cycles. Either a
177 * service-core is mapped (default case), or the application has explicitly
178 * disabled the check that a service-cores is mapped to the service and takes
179 * responsibility to run the service manually using the available function
180 * *rte_service_run_iter_on_app_lcore* to do so.
182 * @retval 1 Service is running
183 * @retval 0 Service is stopped
184 * @retval -EINVAL Invalid service id
186 int32_t rte_service_runstate_get(uint32_t id);
190 * @b EXPERIMENTAL: this API may change without prior notice
192 * Enable or disable the check for a service-core being mapped to the service.
193 * An application can disable the check when takes the responsibility to run a
194 * service itself using *rte_service_run_iter_on_app_lcore*.
196 * @param id The id of the service to set the check on
197 * @param enable When zero, the check is disabled. Non-zero enables the check.
200 * @retval -EINVAL Invalid service ID
202 int32_t rte_service_set_runstate_mapped_check(uint32_t id, int32_t enable);
206 * @b EXPERIMENTAL: this API may change without prior notice
208 * This function runs a service callback from a non-service lcore.
210 * This function is designed to enable gradual porting to service cores, and
211 * to enable unit tests to verify a service behaves as expected.
213 * When called, this function ensures that the service identified by *id* is
214 * safe to run on this lcore. Multi-thread safe services are invoked even if
215 * other cores are simultaneously running them as they are multi-thread safe.
217 * Multi-thread unsafe services are handled depending on the variable
218 * *serialize_multithread_unsafe*:
219 * - When set, the function will check if a service is already being invoked
220 * on another lcore, refusing to run it and returning -EBUSY.
221 * - When zero, the application takes responsibility to ensure that the service
222 * indicated by *id* is not going to be invoked by another lcore. This setting
223 * avoids atomic operations, so is likely to be more performant.
225 * @param id The ID of the service to run
226 * @param serialize_multithread_unsafe This parameter indicates to the service
227 * cores library if it is required to use atomics to serialize access
228 * to mult-thread unsafe services. As there is an overhead in using
229 * atomics, applications can choose to enable or disable this feature
231 * Note that any thread calling this function MUST be a DPDK EAL thread, as
232 * the *rte_lcore_id* function is used to access internal data structures.
234 * @retval 0 Service was run on the calling thread successfully
235 * @retval -EBUSY Another lcore is executing the service, and it is not a
236 * multi-thread safe service, so the service was not run on this lcore
237 * @retval -ENOEXEC Service is not in a run-able state
238 * @retval -EINVAL Invalid service id
240 int32_t rte_service_run_iter_on_app_lcore(uint32_t id,
241 uint32_t serialize_multithread_unsafe);
245 * @b EXPERIMENTAL: this API may change without prior notice
247 * Start a service core.
249 * Starting a core makes the core begin polling. Any services assigned to it
250 * will be run as fast as possible. The application must ensure that the lcore
251 * is in a launchable state: e.g. call *rte_eal_lcore_wait* on the lcore_id
252 * before calling this function.
255 * @retval -EINVAL Failed to start core. The *lcore_id* passed in is not
256 * currently assigned to be a service core.
258 int32_t rte_service_lcore_start(uint32_t lcore_id);
262 * @b EXPERIMENTAL: this API may change without prior notice
264 * Stop a service core.
266 * Stopping a core makes the core become idle, but remains assigned as a
270 * @retval -EINVAL Invalid *lcore_id* provided
271 * @retval -EALREADY Already stopped core
272 * @retval -EBUSY Failed to stop core, as it would cause a service to not
273 * be run, as this is the only core currently running the service.
274 * The application must stop the service first, and then stop the
277 int32_t rte_service_lcore_stop(uint32_t lcore_id);
281 * @b EXPERIMENTAL: this API may change without prior notice
283 * Adds lcore to the list of service cores.
285 * This functions can be used at runtime in order to modify the service core
289 * @retval -EBUSY lcore is busy, and not available for service core duty
290 * @retval -EALREADY lcore is already added to the service core list
291 * @retval -EINVAL Invalid lcore provided
293 int32_t rte_service_lcore_add(uint32_t lcore);
297 * @b EXPERIMENTAL: this API may change without prior notice
299 * Removes lcore from the list of service cores.
301 * This can fail if the core is not stopped, see *rte_service_core_stop*.
304 * @retval -EBUSY Lcore is not stopped, stop service core before removing.
305 * @retval -EINVAL failed to add lcore to service core mask.
307 int32_t rte_service_lcore_del(uint32_t lcore);
311 * @b EXPERIMENTAL: this API may change without prior notice
313 * Retrieve the number of service cores currently available.
315 * This function returns the integer count of service cores available. The
316 * service core count can be used in mapping logic when creating mappings
317 * from service cores to services.
319 * See *rte_service_lcore_list* for details on retrieving the lcore_id of each
322 * @return The number of service cores currently configured.
324 int32_t rte_service_lcore_count(void);
328 * @b EXPERIMENTAL: this API may change without prior notice
330 * Resets all service core mappings. This does not remove the service cores
331 * from duty, just unmaps all services / cores, and stops() the service cores.
332 * The runstate of services is not modified.
336 int32_t rte_service_lcore_reset_all(void);
340 * @b EXPERIMENTAL: this API may change without prior notice
342 * Enable or disable statistics collection for *service*.
344 * This function enables per core, per-service cycle count collection.
345 * @param id The service to enable statistics gathering on.
346 * @param enable Zero to disable statistics, non-zero to enable.
348 * @retval -EINVAL Invalid service pointer passed
350 int32_t rte_service_set_stats_enable(uint32_t id, int32_t enable);
354 * @b EXPERIMENTAL: this API may change without prior notice
356 * Retrieve the list of currently enabled service cores.
358 * This function fills in an application supplied array, with each element
359 * indicating the lcore_id of a service core.
361 * Adding and removing service cores can be performed using
362 * *rte_service_lcore_add* and *rte_service_lcore_del*.
363 * @param [out] array An array of at least *rte_service_lcore_count* items.
364 * If statically allocating the buffer, use RTE_MAX_LCORE.
365 * @param [out] n The size of *array*.
366 * @retval >=0 Number of service cores that have been populated in the array
367 * @retval -ENOMEM The provided array is not large enough to fill in the
368 * service core list. No items have been populated, call this function
369 * with a size of at least *rte_service_core_count* items.
371 int32_t rte_service_lcore_list(uint32_t array[], uint32_t n);
375 * @b EXPERIMENTAL: this API may change without prior notice
377 * Get the numer of services running on the supplied lcore.
379 * @param lcore Id of the service core.
380 * @retval >=0 Number of services registered to this core.
381 * @retval -EINVAL Invalid lcore provided
382 * @retval -ENOTSUP The provided lcore is not a service core.
384 int32_t rte_service_lcore_count_services(uint32_t lcore);
388 * @b EXPERIMENTAL: this API may change without prior notice
390 * Dumps any information available about the service. When id is UINT32_MAX,
391 * this function dumps info for all services.
393 * @retval 0 Statistics have been successfully dumped
394 * @retval -EINVAL Invalid service id provided
396 int32_t rte_service_dump(FILE *f, uint32_t id);
399 * Returns the number of cycles that this service has consumed
401 #define RTE_SERVICE_ATTR_CYCLES 0
404 * Returns the count of invocations of this service function
406 #define RTE_SERVICE_ATTR_CALL_COUNT 1
410 * @b EXPERIMENTAL: this API may change without prior notice
412 * Get an attribute from a service.
414 * @retval 0 Success, the attribute value has been written to *attr_value*.
415 * -EINVAL Invalid id, attr_id or attr_value was NULL.
417 int32_t rte_service_attr_get(uint32_t id, uint32_t attr_id,
418 uint32_t *attr_value);
422 * @b EXPERIMENTAL: this API may change without prior notice
424 * Reset all attribute values of a service.
426 * @param id The service to reset all statistics of
427 * @retval 0 Successfully reset attributes
428 * -EINVAL Invalid service id provided
430 int32_t rte_service_attr_reset_all(uint32_t id);
434 * @b EXPERIMENTAL: this API may change without prior notice
436 * Free up the memory that has been initialized. This routine
437 * is to be invoked prior to process termination.
441 void rte_service_finalize(void);
448 #endif /* _RTE_SERVICE_H_ */