lib/librte_timer/rte_timer.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_TIMER_H_
   6 #define _RTE_TIMER_H_
   7
   8 /**
   9  * @file
  10  RTE Timer
  11  *
  12  * This library provides a timer service to RTE Data Plane execution
  13  * units that allows the execution of callback functions asynchronously.
  14  *
  15  * - Timers can be periodic or single (one-shot).
  16  * - The timers can be loaded from one core and executed on another. This has
  17  *   to be specified in the call to rte_timer_reset().
  18  * - High precision is possible. NOTE: this depends on the call frequency to
  19  *   rte_timer_manage() that check the timer expiration for the local core.
  20  * - If not used in an application, for improved performance, it can be
  21  *   disabled at compilation time by not calling the rte_timer_manage()
  22  *   to improve performance.
  23  *
  24  * The timer library uses the rte_get_hpet_cycles() function that
  25  * uses the HPET, when available, to provide a reliable time reference. [HPET
  26  * routines are provided by EAL, which falls back to using the chip TSC (time-
  27  * stamp counter) as fallback when HPET is not available]
  28  *
  29  * This library provides an interface to add, delete and restart a
  30  * timer. The API is based on the BSD callout(9) API with a few
  31  * differences.
  32  *
  33  * See the RTE architecture documentation for more information about the
  34  * design of this library.
  35  */
  36
  37 #include <stdio.h>
  38 #include <stdint.h>
  39 #include <stddef.h>
  40 #include <rte_common.h>
  41 #include <rte_config.h>
  42 #include <rte_spinlock.h>
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #define RTE_TIMER_STOP    0 /**< State: timer is stopped. */
  49 #define RTE_TIMER_PENDING 1 /**< State: timer is scheduled. */
  50 #define RTE_TIMER_RUNNING 2 /**< State: timer function is running. */
  51 #define RTE_TIMER_CONFIG  3 /**< State: timer is being configured. */
  52
  53 #define RTE_TIMER_NO_OWNER -2 /**< Timer has no owner. */
  54
  55 /**
  56  * Timer type: Periodic or single (one-shot).
  57  */
  58 enum rte_timer_type {
  59         SINGLE,
  60         PERIODICAL
  61 };
  62
  63 /**
  64  * Timer status: A union of the state (stopped, pending, running,
  65  * config) and an owner (the id of the lcore that owns the timer).
  66  */
  67 union rte_timer_status {
  68         RTE_STD_C11
  69         struct {
  70                 uint16_t state;  /**< Stop, pending, running, config. */
  71                 int16_t owner;   /**< The lcore that owns the timer. */
  72         };
  73         uint32_t u32;            /**< To atomic-set status + owner. */
  74 };
  75
  76 #ifdef RTE_LIBRTE_TIMER_DEBUG
  77 /**
  78  * A structure that stores the timer statistics (per-lcore).
  79  */
  80 struct rte_timer_debug_stats {
  81         uint64_t reset;   /**< Number of success calls to rte_timer_reset(). */
  82         uint64_t stop;    /**< Number of success calls to rte_timer_stop(). */
  83         uint64_t manage;  /**< Number of calls to rte_timer_manage(). */
  84         uint64_t pending; /**< Number of pending/running timers. */
  85 };
  86 #endif
  87
  88 struct rte_timer;
  89
  90 /**
  91  * Callback function type for timer expiry.
  92  */
  93 typedef void (*rte_timer_cb_t)(struct rte_timer *, void *);
  94
  95 #define MAX_SKIPLIST_DEPTH 10
  96
  97 /**
  98  * A structure describing a timer in RTE.
  99  */
 100 struct rte_timer
 101 {
 102         uint64_t expire;       /**< Time when timer expire. */
 103         struct rte_timer *sl_next[MAX_SKIPLIST_DEPTH];
 104         volatile union rte_timer_status status; /**< Status of timer. */
 105         uint64_t period;       /**< Period of timer (0 if not periodic). */
 106         rte_timer_cb_t f;      /**< Callback function. */
 107         void *arg;             /**< Argument to callback function. */
 108 };
 109
 110
 111 #ifdef __cplusplus
 112 /**
 113  * A C++ static initializer for a timer structure.
 114  */
 115 #define RTE_TIMER_INITIALIZER {             \
 116         0,                                      \
 117         {NULL},                                 \
 118         {{RTE_TIMER_STOP, RTE_TIMER_NO_OWNER}}, \
 119         0,                                      \
 120         NULL,                                   \
 121         NULL,                                   \
 122         }
 123 #else
 124 /**
 125  * A static initializer for a timer structure.
 126  */
 127 #define RTE_TIMER_INITIALIZER {                      \
 128                 .status = {{                         \
 129                         .state = RTE_TIMER_STOP,     \
 130                         .owner = RTE_TIMER_NO_OWNER, \
 131                 }},                                  \
 132         }
 133 #endif
 134
 135 /**
 136  * @warning
 137  * @b EXPERIMENTAL: this API may change without prior notice
 138  *
 139  * Allocate a timer data instance in shared memory to track a set of pending
 140  * timer lists.
 141  *
 142  * @param id_ptr
 143  *   Pointer to variable into which to write the identifier of the allocated
 144  *   timer data instance.
 145  *
 146  * @return
 147  *   - 0: Success
 148  *   - -ENOSPC: maximum number of timer data instances already allocated
 149  */
 150 int __rte_experimental rte_timer_data_alloc(uint32_t *id_ptr);
 151
 152 /**
 153  * @warning
 154  * @b EXPERIMENTAL: this API may change without prior notice
 155  *
 156  * Deallocate a timer data instance.
 157  *
 158  * @param id
 159  *   Identifier of the timer data instance to deallocate.
 160  *
 161  * @return
 162  *   - 0: Success
 163  *   - -EINVAL: invalid timer data instance identifier
 164  */
 165 int __rte_experimental rte_timer_data_dealloc(uint32_t id);
 166
 167 /**
 168  * Initialize the timer library.
 169  *
 170  * Initializes internal variables (list, locks and so on) for the RTE
 171  * timer library.
 172  */
 173 void rte_timer_subsystem_init_v20(void);
 174
 175 /**
 176  * Initialize the timer library.
 177  *
 178  * Initializes internal variables (list, locks and so on) for the RTE
 179  * timer library.
 180  *
 181  * @return
 182  *   - 0: Success
 183  *   - -EEXIST: Returned in secondary process when primary process has not
 184  *      yet initialized the timer subsystem
 185  *   - -ENOMEM: Unable to allocate memory needed to initialize timer
 186  *      subsystem
 187  */
 188 int rte_timer_subsystem_init_v1905(void);
 189 int rte_timer_subsystem_init(void);
 190
 191 /**
 192  * @warning
 193  * @b EXPERIMENTAL: this API may change without prior notice
 194  *
 195  * Free timer subsystem resources.
 196  */
 197 void __rte_experimental rte_timer_subsystem_finalize(void);
 198
 199 /**
 200  * Initialize a timer handle.
 201  *
 202  * The rte_timer_init() function initializes the timer handle *tim*
 203  * for use. No operations can be performed on a timer before it is
 204  * initialized.
 205  *
 206  * @param tim
 207  *   The timer to initialize.
 208  */
 209 void rte_timer_init(struct rte_timer *tim);
 210
 211 /**
 212  * Reset and start the timer associated with the timer handle.
 213  *
 214  * The rte_timer_reset() function resets and starts the timer
 215  * associated with the timer handle *tim*. When the timer expires after
 216  * *ticks* HPET cycles, the function specified by *fct* will be called
 217  * with the argument *arg* on core *tim_lcore*.
 218  *
 219  * If the timer associated with the timer handle is already running
 220  * (in the RUNNING state), the function will fail. The user has to check
 221  * the return value of the function to see if there is a chance that the
 222  * timer is in the RUNNING state.
 223  *
 224  * If the timer is being configured on another core (the CONFIG state),
 225  * it will also fail.
 226  *
 227  * If the timer is pending or stopped, it will be rescheduled with the
 228  * new parameters.
 229  *
 230  * @param tim
 231  *   The timer handle.
 232  * @param ticks
 233  *   The number of cycles (see rte_get_hpet_hz()) before the callback
 234  *   function is called.
 235  * @param type
 236  *   The type can be either:
 237  *   - PERIODICAL: The timer is automatically reloaded after execution
 238  *     (returns to the PENDING state)
 239  *   - SINGLE: The timer is one-shot, that is, the timer goes to a
 240  *     STOPPED state after execution.
 241  * @param tim_lcore
 242  *   The ID of the lcore where the timer callback function has to be
 243  *   executed. If tim_lcore is LCORE_ID_ANY, the timer library will
 244  *   launch it on a different core for each call (round-robin).
 245  * @param fct
 246  *   The callback function of the timer.
 247  * @param arg
 248  *   The user argument of the callback function.
 249  * @return
 250  *   - 0: Success; the timer is scheduled.
 251  *   - (-1): Timer is in the RUNNING or CONFIG state.
 252  */
 253 int rte_timer_reset_v20(struct rte_timer *tim, uint64_t ticks,
 254                         enum rte_timer_type type, unsigned int tim_lcore,
 255                         rte_timer_cb_t fct, void *arg);
 256 int rte_timer_reset_v1905(struct rte_timer *tim, uint64_t ticks,
 257                           enum rte_timer_type type, unsigned int tim_lcore,
 258                           rte_timer_cb_t fct, void *arg);
 259 int rte_timer_reset(struct rte_timer *tim, uint64_t ticks,
 260                     enum rte_timer_type type, unsigned tim_lcore,
 261                     rte_timer_cb_t fct, void *arg);
 262
 263
 264 /**
 265  * Loop until rte_timer_reset() succeeds.
 266  *
 267  * Reset and start the timer associated with the timer handle. Always
 268  * succeed. See rte_timer_reset() for details.
 269  *
 270  * @param tim
 271  *   The timer handle.
 272  * @param ticks
 273  *   The number of cycles (see rte_get_hpet_hz()) before the callback
 274  *   function is called.
 275  * @param type
 276  *   The type can be either:
 277  *   - PERIODICAL: The timer is automatically reloaded after execution
 278  *     (returns to the PENDING state)
 279  *   - SINGLE: The timer is one-shot, that is, the timer goes to a
 280  *     STOPPED state after execution.
 281  * @param tim_lcore
 282  *   The ID of the lcore where the timer callback function has to be
 283  *   executed. If tim_lcore is LCORE_ID_ANY, the timer library will
 284  *   launch it on a different core for each call (round-robin).
 285  * @param fct
 286  *   The callback function of the timer.
 287  * @param arg
 288  *   The user argument of the callback function.
 289  */
 290 void
 291 rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks,
 292                      enum rte_timer_type type, unsigned tim_lcore,
 293                      rte_timer_cb_t fct, void *arg);
 294
 295 /**
 296  * Stop a timer.
 297  *
 298  * The rte_timer_stop() function stops the timer associated with the
 299  * timer handle *tim*. It may fail if the timer is currently running or
 300  * being configured.
 301  *
 302  * If the timer is pending or stopped (for instance, already expired),
 303  * the function will succeed. The timer handle tim must have been
 304  * initialized using rte_timer_init(), otherwise, undefined behavior
 305  * will occur.
 306  *
 307  * This function can be called safely from a timer callback. If it
 308  * succeeds, the timer is not referenced anymore by the timer library
 309  * and the timer structure can be freed (even in the callback
 310  * function).
 311  *
 312  * @param tim
 313  *   The timer handle.
 314  * @return
 315  *   - 0: Success; the timer is stopped.
 316  *   - (-1): The timer is in the RUNNING or CONFIG state.
 317  */
 318 int rte_timer_stop_v20(struct rte_timer *tim);
 319 int rte_timer_stop_v1905(struct rte_timer *tim);
 320 int rte_timer_stop(struct rte_timer *tim);
 321
 322 /**
 323  * Loop until rte_timer_stop() succeeds.
 324  *
 325  * After a call to this function, the timer identified by *tim* is
 326  * stopped. See rte_timer_stop() for details.
 327  *
 328  * @param tim
 329  *   The timer handle.
 330  */
 331 void rte_timer_stop_sync(struct rte_timer *tim);
 332
 333 /**
 334  * Test if a timer is pending.
 335  *
 336  * The rte_timer_pending() function tests the PENDING status
 337  * of the timer handle *tim*. A PENDING timer is one that has been
 338  * scheduled and whose function has not yet been called.
 339  *
 340  * @param tim
 341  *   The timer handle.
 342  * @return
 343  *   - 0: The timer is not pending.
 344  *   - 1: The timer is pending.
 345  */
 346 int rte_timer_pending(struct rte_timer *tim);
 347
 348 /**
 349  * Manage the timer list and execute callback functions.
 350  *
 351  * This function must be called periodically from EAL lcores
 352  * main_loop(). It browses the list of pending timers and runs all
 353  * timers that are expired.
 354  *
 355  * The precision of the timer depends on the call frequency of this
 356  * function. However, the more often the function is called, the more
 357  * CPU resources it will use.
 358  */
 359 void rte_timer_manage_v20(void);
 360
 361 /**
 362  * Manage the timer list and execute callback functions.
 363  *
 364  * This function must be called periodically from EAL lcores
 365  * main_loop(). It browses the list of pending timers and runs all
 366  * timers that are expired.
 367  *
 368  * The precision of the timer depends on the call frequency of this
 369  * function. However, the more often the function is called, the more
 370  * CPU resources it will use.
 371  *
 372  * @return
 373  *   - 0: Success
 374  *   - -EINVAL: timer subsystem not yet initialized
 375  */
 376 int rte_timer_manage_v1905(void);
 377 int rte_timer_manage(void);
 378
 379 /**
 380  * Dump statistics about timers.
 381  *
 382  * @param f
 383  *   A pointer to a file for output
 384  */
 385 void rte_timer_dump_stats_v20(FILE *f);
 386
 387 /**
 388  * Dump statistics about timers.
 389  *
 390  * @param f
 391  *   A pointer to a file for output
 392  * @return
 393  *   - 0: Success
 394  *   - -EINVAL: timer subsystem not yet initialized
 395  */
 396 int rte_timer_dump_stats_v1905(FILE *f);
 397 int rte_timer_dump_stats(FILE *f);
 398
 399 /**
 400  * @warning
 401  * @b EXPERIMENTAL: this API may change without prior notice
 402  *
 403  * This function is the same as rte_timer_reset(), except that it allows a
 404  * caller to specify the rte_timer_data instance containing the list to which
 405  * the timer should be added.
 406  *
 407  * @see rte_timer_reset()
 408  *
 409  * @param timer_data_id
 410  *   An identifier indicating which instance of timer data should be used for
 411  *   this operation.
 412  * @param tim
 413  *   The timer handle.
 414  * @param ticks
 415  *   The number of cycles (see rte_get_hpet_hz()) before the callback
 416  *   function is called.
 417  * @param type
 418  *   The type can be either:
 419  *   - PERIODICAL: The timer is automatically reloaded after execution
 420  *     (returns to the PENDING state)
 421  *   - SINGLE: The timer is one-shot, that is, the timer goes to a
 422  *     STOPPED state after execution.
 423  * @param tim_lcore
 424  *   The ID of the lcore where the timer callback function has to be
 425  *   executed. If tim_lcore is LCORE_ID_ANY, the timer library will
 426  *   launch it on a different core for each call (round-robin).
 427  * @param fct
 428  *   The callback function of the timer. This parameter can be NULL if (and
 429  *   only if) rte_timer_alt_manage() will be used to manage this timer.
 430  * @param arg
 431  *   The user argument of the callback function.
 432  * @return
 433  *   - 0: Success; the timer is scheduled.
 434  *   - (-1): Timer is in the RUNNING or CONFIG state.
 435  *   - -EINVAL: invalid timer_data_id
 436  */
 437 int __rte_experimental
 438 rte_timer_alt_reset(uint32_t timer_data_id, struct rte_timer *tim,
 439                     uint64_t ticks, enum rte_timer_type type,
 440                     unsigned int tim_lcore, rte_timer_cb_t fct, void *arg);
 441
 442 /**
 443  * @warning
 444  * @b EXPERIMENTAL: this API may change without prior notice
 445  *
 446  * This function is the same as rte_timer_stop(), except that it allows a
 447  * caller to specify the rte_timer_data instance containing the list from which
 448  * this timer should be removed.
 449  *
 450  * @see rte_timer_stop()
 451  *
 452  * @param timer_data_id
 453  *   An identifier indicating which instance of timer data should be used for
 454  *   this operation.
 455  * @param tim
 456  *   The timer handle.
 457  * @return
 458  *   - 0: Success; the timer is stopped.
 459  *   - (-1): The timer is in the RUNNING or CONFIG state.
 460  *   - -EINVAL: invalid timer_data_id
 461  */
 462 int __rte_experimental
 463 rte_timer_alt_stop(uint32_t timer_data_id, struct rte_timer *tim);
 464
 465 /**
 466  * Callback function type for rte_timer_alt_manage().
 467  */
 468 typedef void (*rte_timer_alt_manage_cb_t)(struct rte_timer *tim);
 469
 470 /**
 471  * @warning
 472  * @b EXPERIMENTAL: this API may change without prior notice
 473  *
 474  * Manage a set of timer lists and execute the specified callback function for
 475  * all expired timers. This function is similar to rte_timer_manage(), except
 476  * that it allows a caller to specify the timer_data instance that should
 477  * be operated on, as well as a set of lcore IDs identifying which timer lists
 478  * should be processed.  Callback functions of individual timers are ignored.
 479  *
 480  * @see rte_timer_manage()
 481  *
 482  * @param timer_data_id
 483  *   An identifier indicating which instance of timer data should be used for
 484  *   this operation.
 485  * @param poll_lcores
 486  *   An array of lcore ids identifying the timer lists that should be processed.
 487  *   NULL is allowed - if NULL, the timer list corresponding to the lcore
 488  *   calling this routine is processed (same as rte_timer_manage()).
 489  * @param n_poll_lcores
 490  *   The size of the poll_lcores array. If 'poll_lcores' is NULL, this parameter
 491  *   is ignored.
 492  * @param f
 493  *   The callback function which should be called for all expired timers.
 494  * @return
 495  *   - 0: success
 496  *   - -EINVAL: invalid timer_data_id
 497  */
 498 int __rte_experimental
 499 rte_timer_alt_manage(uint32_t timer_data_id, unsigned int *poll_lcores,
 500                      int n_poll_lcores, rte_timer_alt_manage_cb_t f);
 501
 502 /**
 503  * @warning
 504  * @b EXPERIMENTAL: this API may change without prior notice
 505  *
 506  * This function is the same as rte_timer_dump_stats(), except that it allows
 507  * the caller to specify the rte_timer_data instance that should be used.
 508  *
 509  * @see rte_timer_dump_stats()
 510  *
 511  * @param timer_data_id
 512  *   An identifier indicating which instance of timer data should be used for
 513  *   this operation.
 514  * @param f
 515  *   A pointer to a file for output
 516  * @return
 517  *   - 0: success
 518  *   - -EINVAL: invalid timer_data_id
 519  */
 520 int __rte_experimental
 521 rte_timer_alt_dump_stats(uint32_t timer_data_id, FILE *f);
 522
 523 #ifdef __cplusplus
 524 }
 525 #endif
 526
 527 #endif /* _RTE_TIMER_H_ */