lib/librte_eal/common/include/rte_service.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_SERVICE_H_
   6 #define _RTE_SERVICE_H_
   7
   8 /**
   9  * @file
  10  *
  11  * Service functions
  12  *
  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
  15  * its processing.
  16  *
  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.
  24  */
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 #include<stdio.h>
  31 #include <stdint.h>
  32 #include <sys/queue.h>
  33
  34 #include <rte_config.h>
  35 #include <rte_lcore.h>
  36
  37 #define RTE_SERVICE_NAME_MAX 32
  38
  39 /* Capabilities of a service.
  40  *
  41  * Use the *rte_service_probe_capability* function to check if a service is
  42  * capable of a specific capability.
  43  */
  44 /** When set, the service is capable of having multiple threads run it at the
  45  *  same time.
  46  */
  47 #define RTE_SERVICE_CAP_MT_SAFE (1 << 0)
  48
  49 /**
  50  *  Return the number of services registered.
  51  *
  52  * The number of services registered can be passed to *rte_service_get_by_id*,
  53  * enabling the application to retrieve the specification of each service.
  54  *
  55  * @return The number of services registered.
  56  */
  57 uint32_t rte_service_get_count(void);
  58
  59 /**
  60  * Return the id of a service by name.
  61  *
  62  * This function provides the id of the service using the service name as
  63  * lookup key. The service id is to be passed to other functions in the
  64  * rte_service_* API.
  65  *
  66  * Example usage:
  67  * @code
  68  *      uint32_t service_id;
  69  *      int32_t ret = rte_service_get_by_name("service_X", &service_id);
  70  *      if (ret) {
  71  *              // handle error
  72  *      }
  73  * @endcode
  74  *
  75  * @param name The name of the service to retrieve
  76  * @param[out] service_id A pointer to a uint32_t, to be filled in with the id.
  77  * @retval 0 Success. The service id is provided in *service_id*.
  78  * @retval -EINVAL Null *service_id* pointer provided
  79  * @retval -ENODEV No such service registered
  80  */
  81 int32_t rte_service_get_by_name(const char *name, uint32_t *service_id);
  82
  83 /**
  84  * Return the name of the service.
  85  *
  86  * @return A pointer to the name of the service. The returned pointer remains
  87  *         in ownership of the service, and the application must not free it.
  88  */
  89 const char *rte_service_get_name(uint32_t id);
  90
  91 /**
  92  * Check if a service has a specific capability.
  93  *
  94  * This function returns if *service* has implements *capability*.
  95  * See RTE_SERVICE_CAP_* defines for a list of valid capabilities.
  96  * @retval 1 Capability supported by this service instance
  97  * @retval 0 Capability not supported by this service instance
  98  */
  99 int32_t rte_service_probe_capability(uint32_t id, uint32_t capability);
 100
 101 /**
 102  * Map or unmap a lcore to a service.
 103  *
 104  * Each core can be added or removed from running a specific service. This
 105  * function enables or disables *lcore* to run *service_id*.
 106  *
 107  * If multiple cores are enabled on a service, an atomic is used to ensure that
 108  * only one cores runs the service at a time. The exception to this is when
 109  * a service indicates that it is multi-thread safe by setting the capability
 110  * called RTE_SERVICE_CAP_MT_SAFE. With the multi-thread safe capability set,
 111  * the service function can be run on multiple threads at the same time.
 112  *
 113  * @param service_id the service to apply the lcore to
 114  * @param lcore The lcore that will be mapped to service
 115  * @param enable Zero to unmap or disable the core, non-zero to enable
 116  *
 117  * @retval 0 lcore map updated successfully
 118  * @retval -EINVAL An invalid service or lcore was provided.
 119  */
 120 int32_t rte_service_map_lcore_set(uint32_t service_id, uint32_t lcore,
 121                 uint32_t enable);
 122
 123 /**
 124  * Retrieve the mapping of an lcore to a service.
 125  *
 126  * @param service_id the service to apply the lcore to
 127  * @param lcore The lcore that will be mapped to service
 128  *
 129  * @retval 1 lcore is mapped to service
 130  * @retval 0 lcore is not mapped to service
 131  * @retval -EINVAL An invalid service or lcore was provided.
 132  */
 133 int32_t rte_service_map_lcore_get(uint32_t service_id, uint32_t lcore);
 134
 135 /**
 136  * Set the runstate of the service.
 137  *
 138  * Each service is either running or stopped. Setting a non-zero runstate
 139  * enables the service to run, while setting runstate zero disables it.
 140  *
 141  * @param id The id of the service
 142  * @param runstate The run state to apply to the service
 143  *
 144  * @retval 0 The service was successfully started
 145  * @retval -EINVAL Invalid service id
 146  */
 147 int32_t rte_service_runstate_set(uint32_t id, uint32_t runstate);
 148
 149 /**
 150  * Get the runstate for the service with *id*. See *rte_service_runstate_set*
 151  * for details of runstates. A service can call this function to ensure that
 152  * the application has indicated that it will receive CPU cycles. Either a
 153  * service-core is mapped (default case), or the application has explicitly
 154  * disabled the check that a service-cores is mapped to the service and takes
 155  * responsibility to run the service manually using the available function
 156  * *rte_service_run_iter_on_app_lcore* to do so.
 157  *
 158  * @retval 1 Service is running
 159  * @retval 0 Service is stopped
 160  * @retval -EINVAL Invalid service id
 161  */
 162 int32_t rte_service_runstate_get(uint32_t id);
 163
 164 /**
 165  * Enable or disable the check for a service-core being mapped to the service.
 166  * An application can disable the check when takes the responsibility to run a
 167  * service itself using *rte_service_run_iter_on_app_lcore*.
 168  *
 169  * @param id The id of the service to set the check on
 170  * @param enable When zero, the check is disabled. Non-zero enables the check.
 171  *
 172  * @retval 0 Success
 173  * @retval -EINVAL Invalid service ID
 174  */
 175 int32_t rte_service_set_runstate_mapped_check(uint32_t id, int32_t enable);
 176
 177 /**
 178  * This function runs a service callback from a non-service lcore.
 179  *
 180  * This function is designed to enable gradual porting to service cores, and
 181  * to enable unit tests to verify a service behaves as expected.
 182  *
 183  * When called, this function ensures that the service identified by *id* is
 184  * safe to run on this lcore. Multi-thread safe services are invoked even if
 185  * other cores are simultaneously running them as they are multi-thread safe.
 186  *
 187  * Multi-thread unsafe services are handled depending on the variable
 188  * *serialize_multithread_unsafe*:
 189  * - When set, the function will check if a service is already being invoked
 190  *   on another lcore, refusing to run it and returning -EBUSY.
 191  * - When zero, the application takes responsibility to ensure that the service
 192  *   indicated by *id* is not going to be invoked by another lcore. This setting
 193  *   avoids atomic operations, so is likely to be more performant.
 194  *
 195  * @param id The ID of the service to run
 196  * @param serialize_multithread_unsafe This parameter indicates to the service
 197  *           cores library if it is required to use atomics to serialize access
 198  *           to mult-thread unsafe services. As there is an overhead in using
 199  *           atomics, applications can choose to enable or disable this feature
 200  *
 201  * Note that any thread calling this function MUST be a DPDK EAL thread, as
 202  * the *rte_lcore_id* function is used to access internal data structures.
 203  *
 204  * @retval 0 Service was run on the calling thread successfully
 205  * @retval -EBUSY Another lcore is executing the service, and it is not a
 206  *         multi-thread safe service, so the service was not run on this lcore
 207  * @retval -ENOEXEC Service is not in a run-able state
 208  * @retval -EINVAL Invalid service id
 209  */
 210 int32_t rte_service_run_iter_on_app_lcore(uint32_t id,
 211                 uint32_t serialize_multithread_unsafe);
 212
 213 /**
 214  * Start a service core.
 215  *
 216  * Starting a core makes the core begin polling. Any services assigned to it
 217  * will be run as fast as possible. The application must ensure that the lcore
 218  * is in a launchable state: e.g. call *rte_eal_lcore_wait* on the lcore_id
 219  * before calling this function.
 220  *
 221  * @retval 0 Success
 222  * @retval -EINVAL Failed to start core. The *lcore_id* passed in is not
 223  *          currently assigned to be a service core.
 224  */
 225 int32_t rte_service_lcore_start(uint32_t lcore_id);
 226
 227 /**
 228  * Stop a service core.
 229  *
 230  * Stopping a core makes the core become idle, but remains  assigned as a
 231  * service core.
 232  *
 233  * @retval 0 Success
 234  * @retval -EINVAL Invalid *lcore_id* provided
 235  * @retval -EALREADY Already stopped core
 236  * @retval -EBUSY Failed to stop core, as it would cause a service to not
 237  *          be run, as this is the only core currently running the service.
 238  *          The application must stop the service first, and then stop the
 239  *          lcore.
 240  */
 241 int32_t rte_service_lcore_stop(uint32_t lcore_id);
 242
 243 /**
 244  * Adds lcore to the list of service cores.
 245  *
 246  * This functions can be used at runtime in order to modify the service core
 247  * mask.
 248  *
 249  * @retval 0 Success
 250  * @retval -EBUSY lcore is busy, and not available for service core duty
 251  * @retval -EALREADY lcore is already added to the service core list
 252  * @retval -EINVAL Invalid lcore provided
 253  */
 254 int32_t rte_service_lcore_add(uint32_t lcore);
 255
 256 /**
 257  * Removes lcore from the list of service cores.
 258  *
 259  * This can fail if the core is not stopped, see *rte_service_core_stop*.
 260  *
 261  * @retval 0 Success
 262  * @retval -EBUSY Lcore is not stopped, stop service core before removing.
 263  * @retval -EINVAL failed to add lcore to service core mask.
 264  */
 265 int32_t rte_service_lcore_del(uint32_t lcore);
 266
 267 /**
 268  * Retrieve the number of service cores currently available.
 269  *
 270  * This function returns the integer count of service cores available. The
 271  * service core count can be used in mapping logic when creating mappings
 272  * from service cores to services.
 273  *
 274  * See *rte_service_lcore_list* for details on retrieving the lcore_id of each
 275  * service core.
 276  *
 277  * @return The number of service cores currently configured.
 278  */
 279 int32_t rte_service_lcore_count(void);
 280
 281 /**
 282  * Resets all service core mappings. This does not remove the service cores
 283  * from duty, just unmaps all services / cores, and stops() the service cores.
 284  * The runstate of services is not modified.
 285  *
 286  * @retval 0 Success
 287  */
 288 int32_t rte_service_lcore_reset_all(void);
 289
 290 /**
 291  * Enable or disable statistics collection for *service*.
 292  *
 293  * This function enables per core, per-service cycle count collection.
 294  * @param id The service to enable statistics gathering on.
 295  * @param enable Zero to disable statistics, non-zero to enable.
 296  * @retval 0 Success
 297  * @retval -EINVAL Invalid service pointer passed
 298  */
 299 int32_t rte_service_set_stats_enable(uint32_t id, int32_t enable);
 300
 301 /**
 302  * Retrieve the list of currently enabled service cores.
 303  *
 304  * This function fills in an application supplied array, with each element
 305  * indicating the lcore_id of a service core.
 306  *
 307  * Adding and removing service cores can be performed using
 308  * *rte_service_lcore_add* and *rte_service_lcore_del*.
 309  * @param [out] array An array of at least *rte_service_lcore_count* items.
 310  *              If statically allocating the buffer, use RTE_MAX_LCORE.
 311  * @param [out] n The size of *array*.
 312  * @retval >=0 Number of service cores that have been populated in the array
 313  * @retval -ENOMEM The provided array is not large enough to fill in the
 314  *          service core list. No items have been populated, call this function
 315  *          with a size of at least *rte_service_core_count* items.
 316  */
 317 int32_t rte_service_lcore_list(uint32_t array[], uint32_t n);
 318
 319 /**
 320  * Get the numer of services running on the supplied lcore.
 321  *
 322  * @param lcore Id of the service core.
 323  * @retval >=0 Number of services registered to this core.
 324  * @retval -EINVAL Invalid lcore provided
 325  * @retval -ENOTSUP The provided lcore is not a service core.
 326  */
 327 int32_t rte_service_lcore_count_services(uint32_t lcore);
 328
 329 /**
 330  * Dumps any information available about the service. When id is UINT32_MAX,
 331  * this function dumps info for all services.
 332  *
 333  * @retval 0 Statistics have been successfully dumped
 334  * @retval -EINVAL Invalid service id provided
 335  */
 336 int32_t rte_service_dump(FILE *f, uint32_t id);
 337
 338 /**
 339  * Returns the number of cycles that this service has consumed
 340  */
 341 #define RTE_SERVICE_ATTR_CYCLES 0
 342
 343 /**
 344  * Returns the count of invocations of this service function
 345  */
 346 #define RTE_SERVICE_ATTR_CALL_COUNT 1
 347
 348 /**
 349  * Get an attribute from a service.
 350  *
 351  * @retval 0 Success, the attribute value has been written to *attr_value*.
 352  *         -EINVAL Invalid id, attr_id or attr_value was NULL.
 353  */
 354 int32_t rte_service_attr_get(uint32_t id, uint32_t attr_id,
 355                 uint32_t *attr_value);
 356
 357 /**
 358  * Reset all attribute values of a service.
 359  *
 360  * @param id The service to reset all statistics of
 361  * @retval 0 Successfully reset attributes
 362  *         -EINVAL Invalid service id provided
 363  */
 364 int32_t rte_service_attr_reset_all(uint32_t id);
 365
 366 #ifdef __cplusplus
 367 }
 368 #endif
 369
 370
 371 #endif /* _RTE_SERVICE_H_ */