eal: simplify meson build of common directory
[dpdk.git] / lib / librte_eal / common / include / rte_service_component.h
index 849c71d..16eab79 100644 (file)
@@ -2,28 +2,22 @@
  * Copyright(c) 2017 Intel Corporation
  */
 
-#ifndef _RTE_SERVICE_PRIVATE_H_
-#define _RTE_SERVICE_PRIVATE_H_
+#ifndef _SERVICE_PRIVATE_H_
+#define _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>
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Signature of callback function to run a service.
  */
 typedef int32_t (*rte_service_func)(void *args);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * The specification of a service.
  *
  * This struct contains metadata about the service itself, the callback
@@ -47,9 +41,6 @@ struct rte_service_spec {
 };
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Register a new service.
  *
  * A service represents a component that the requires CPU time periodically to
@@ -74,12 +65,9 @@ struct rte_service_spec {
  *         set)
  */
 int32_t rte_service_component_register(const struct rte_service_spec *spec,
-                                      uint32_t *service_id);
+               uint32_t *service_id);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Unregister a service component.
  *
  * The service being removed must be stopped before calling this function.
@@ -91,9 +79,6 @@ int32_t rte_service_component_register(const struct rte_service_spec *spec,
 int32_t rte_service_component_unregister(uint32_t id);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Private function to allow EAL to initialized default mappings.
  *
  * This function iterates all the services, and maps then to the available
@@ -109,9 +94,6 @@ int32_t rte_service_component_unregister(uint32_t id);
 int32_t rte_service_start_with_defaults(void);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Set the backend runstate of a component.
  *
  * This function allows services to be registered at startup, but not yet
@@ -126,9 +108,6 @@ int32_t rte_service_start_with_defaults(void);
 int32_t rte_service_component_runstate_set(uint32_t id, uint32_t runstate);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Initialize the service library.
  *
  * In order to use the service library, it must be initialized. EAL initializes
@@ -139,4 +118,12 @@ int32_t rte_service_component_runstate_set(uint32_t id, uint32_t runstate);
  */
 int32_t rte_service_init(void);
 
-#endif /* _RTE_SERVICE_PRIVATE_H_ */
+/**
+ * @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 /* _SERVICE_PRIVATE_H_ */