[PATCH v2 14/15] service: clarify documentation for register
From: Harry van Haaren <hidden>
Date: 2017-08-21 12:58:41
Subsystem:
library code, the rest · Maintainers:
Andrew Morton, Linus Torvalds
This commit adds a section to the service register function to make it clear that registering a service, must not configure service-cores (eg: adding lcores or changing mappings). Signed-off-by: Harry van Haaren <redacted> --- lib/librte_eal/common/include/rte_service_component.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/lib/librte_eal/common/include/rte_service_component.h b/lib/librte_eal/common/include/rte_service_component.h
index 5e4573b..ac965cb 100644
--- a/lib/librte_eal/common/include/rte_service_component.h
+++ b/lib/librte_eal/common/include/rte_service_component.h@@ -85,8 +85,13 @@ struct rte_service_spec { * * 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 it using - * *rte_service_set_coremask*. + * 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
--
2.7.4