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