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 __rte_experimental
 151 int rte_timer_data_alloc(uint32_t *id_ptr);
 152
 153 /**
 154  * @warning
 155  * @b EXPERIMENTAL: this API may change without prior notice
 156  *
 157  * Deallocate a timer data instance.
 158  *
 159  * @param id
 160  *   Identifier of the timer data instance to deallocate.
 161  *
 162  * @return
 163  *   - 0: Success
 164  *   - -EINVAL: invalid timer data instance identifier
 165  */
 166 __rte_experimental
 167 int rte_timer_data_dealloc(uint32_t id);
 168
 169 /**
 170  * Initialize the timer library.
 171  *
 172  * Initializes internal variables (list, locks and so on) for the RTE
 173  * timer library.
 174  *
 175  * @note
 176  *   This function must be called in every process before using the library.
 177  *
 178  * @return
 179  *   - 0: Success
 180  *   - -ENOMEM: Unable to allocate memory needed to initialize timer
 181  *      subsystem
 182  */
 183 int rte_timer_subsystem_init(void);
 184 int rte_timer_subsystem_init_v1905(void);
 185 void rte_timer_subsystem_init_v20(void);
 186
 187 /**
 188  * @warning
 189  * @b EXPERIMENTAL: this API may change without prior notice
 190  *
 191  * Free timer subsystem resources.
 192  */
 193 __rte_experimental
 194 void rte_timer_subsystem_finalize(void);
 195
 196 /**
 197  * Initialize a timer handle.
 198  *
 199  * The rte_timer_init() function initializes the timer handle *tim*
 200  * for use. No operations can be performed on a timer before it is
 201  * initialized.
 202  *
 203  * @param tim
 204  *   The timer to initialize.
 205  */
 206 void rte_timer_init(struct rte_timer *tim);
 207
 208 /**
 209  * Reset and start the timer associated with the timer handle.
 210  *
 211  * The rte_timer_reset() function resets and starts the timer
 212  * associated with the timer handle *tim*. When the timer expires after
 213  * *ticks* HPET cycles, the function specified by *fct* will be called
 214  * with the argument *arg* on core *tim_lcore*.
 215  *
 216  * If the timer associated with the timer handle is already running
 217  * (in the RUNNING state), the function will fail. The user has to check
 218  * the return value of the function to see if there is a chance that the
 219  * timer is in the RUNNING state.
 220  *
 221  * If the timer is being configured on another core (the CONFIG state),
 222  * it will also fail.
 223  *
 224  * If the timer is pending or stopped, it will be rescheduled with the
 225  * new parameters.
 226  *
 227  * @param tim
 228  *   The timer handle.
 229  * @param ticks
 230  *   The number of cycles (see rte_get_hpet_hz()) before the callback
 231  *   function is called.
 232  * @param type
 233  *   The type can be either:
 234  *   - PERIODICAL: The timer is automatically reloaded after execution
 235  *     (returns to the PENDING state)
 236  *   - SINGLE: The timer is one-shot, that is, the timer goes to a
 237  *     STOPPED state after execution.
 238  * @param tim_lcore
 239  *   The ID of the lcore where the timer callback function has to be
 240  *   executed. If tim_lcore is LCORE_ID_ANY, the timer library will
 241  *   launch it on a different core for each call (round-robin).
 242  * @param fct
 243  *   The callback function of the timer.
 244  * @param arg
 245  *   The user argument of the callback function.
 246  * @return
 247  *   - 0: Success; the timer is scheduled.
 248  *   - (-1): Timer is in the RUNNING or CONFIG state.
 249  */
 250 int rte_timer_reset(struct rte_timer *tim, uint64_t ticks,
 251                     enum rte_timer_type type, unsigned tim_lcore,
 252                     rte_timer_cb_t fct, void *arg);
 253 int rte_timer_reset_v1905(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_v20(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
 260
 261 /**
 262  * Loop until rte_timer_reset() succeeds.
 263  *
 264  * Reset and start the timer associated with the timer handle. Always
 265  * succeed. See rte_timer_reset() for details.
 266  *
 267  * @param tim
 268  *   The timer handle.
 269  * @param ticks
 270  *   The number of cycles (see rte_get_hpet_hz()) before the callback
 271  *   function is called.
 272  * @param type
 273  *   The type can be either:
 274  *   - PERIODICAL: The timer is automatically reloaded after execution
 275  *     (returns to the PENDING state)
 276  *   - SINGLE: The timer is one-shot, that is, the timer goes to a
 277  *     STOPPED state after execution.
 278  * @param tim_lcore
 279  *   The ID of the lcore where the timer callback function has to be
 280  *   executed. If tim_lcore is LCORE_ID_ANY, the timer library will
 281  *   launch it on a different core for each call (round-robin).
 282  * @param fct
 283  *   The callback function of the timer.
 284  * @param arg
 285  *   The user argument of the callback function.
 286  */
 287 void
 288 rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks,
 289                      enum rte_timer_type type, unsigned tim_lcore,
 290                      rte_timer_cb_t fct, void *arg);
 291
 292 /**
 293  * Stop a timer.
 294  *
 295  * The rte_timer_stop() function stops the timer associated with the
 296  * timer handle *tim*. It may fail if the timer is currently running or
 297  * being configured.
 298  *
 299  * If the timer is pending or stopped (for instance, already expired),
 300  * the function will succeed. The timer handle tim must have been
 301  * initialized using rte_timer_init(), otherwise, undefined behavior
 302  * will occur.
 303  *
 304  * This function can be called safely from a timer callback. If it
 305  * succeeds, the timer is not referenced anymore by the timer library
 306  * and the timer structure can be freed (even in the callback
 307  * function).
 308  *
 309  * @param tim
 310  *   The timer handle.
 311  * @return
 312  *   - 0: Success; the timer is stopped.
 313  *   - (-1): The timer is in the RUNNING or CONFIG state.
 314  */
 315 int rte_timer_stop(struct rte_timer *tim);
 316 int rte_timer_stop_v1905(struct rte_timer *tim);
 317 int rte_timer_stop_v20(struct rte_timer *tim);
 318
 319 /**
 320  * Loop until rte_timer_stop() succeeds.
 321  *
 322  * After a call to this function, the timer identified by *tim* is
 323  * stopped. See rte_timer_stop() for details.
 324  *
 325  * @param tim
 326  *   The timer handle.
 327  */
 328 void rte_timer_stop_sync(struct rte_timer *tim);
 329
 330 /**
 331  * Test if a timer is pending.
 332  *
 333  * The rte_timer_pending() function tests the PENDING status
 334  * of the timer handle *tim*. A PENDING timer is one that has been
 335  * scheduled and whose function has not yet been called.
 336  *
 337  * @param tim
 338  *   The timer handle.
 339  * @return
 340  *   - 0: The timer is not pending.
 341  *   - 1: The timer is pending.
 342  */
 343 int rte_timer_pending(struct rte_timer *tim);
 344
 345 /**
 346  * Manage the timer list and execute callback functions.
 347  *
 348  * This function must be called periodically from EAL lcores
 349  * main_loop(). It browses the list of pending timers and runs all
 350  * timers that are expired.
 351  *
 352  * The precision of the timer depends on the call frequency of this
 353  * function. However, the more often the function is called, the more
 354  * CPU resources it will use.
 355  *
 356  * @return
 357  *   - 0: Success
 358  *   - -EINVAL: timer subsystem not yet initialized
 359  */
 360 int rte_timer_manage(void);
 361 int rte_timer_manage_v1905(void);
 362 void rte_timer_manage_v20(void);
 363
 364 /**
 365  * Dump statistics about timers.
 366  *
 367  * @param f
 368  *   A pointer to a file for output
 369  * @return
 370  *   - 0: Success
 371  *   - -EINVAL: timer subsystem not yet initialized
 372  */
 373 int rte_timer_dump_stats(FILE *f);
 374 int rte_timer_dump_stats_v1905(FILE *f);
 375 void rte_timer_dump_stats_v20(FILE *f);
 376
 377 /**
 378  * @warning
 379  * @b EXPERIMENTAL: this API may change without prior notice
 380  *
 381  * This function is the same as rte_timer_reset(), except that it allows a
 382  * caller to specify the rte_timer_data instance containing the list to which
 383  * the timer should be added.
 384  *
 385  * @see rte_timer_reset()
 386  *
 387  * @param timer_data_id
 388  *   An identifier indicating which instance of timer data should be used for
 389  *   this operation.
 390  * @param tim
 391  *   The timer handle.
 392  * @param ticks
 393  *   The number of cycles (see rte_get_hpet_hz()) before the callback
 394  *   function is called.
 395  * @param type
 396  *   The type can be either:
 397  *   - PERIODICAL: The timer is automatically reloaded after execution
 398  *     (returns to the PENDING state)
 399  *   - SINGLE: The timer is one-shot, that is, the timer goes to a
 400  *     STOPPED state after execution.
 401  * @param tim_lcore
 402  *   The ID of the lcore where the timer callback function has to be
 403  *   executed. If tim_lcore is LCORE_ID_ANY, the timer library will
 404  *   launch it on a different core for each call (round-robin).
 405  * @param fct
 406  *   The callback function of the timer. This parameter can be NULL if (and
 407  *   only if) rte_timer_alt_manage() will be used to manage this timer.
 408  * @param arg
 409  *   The user argument of the callback function.
 410  * @return
 411  *   - 0: Success; the timer is scheduled.
 412  *   - (-1): Timer is in the RUNNING or CONFIG state.
 413  *   - -EINVAL: invalid timer_data_id
 414  */
 415 __rte_experimental
 416 int
 417 rte_timer_alt_reset(uint32_t timer_data_id, struct rte_timer *tim,
 418                     uint64_t ticks, enum rte_timer_type type,
 419                     unsigned int tim_lcore, rte_timer_cb_t fct, void *arg);
 420
 421 /**
 422  * @warning
 423  * @b EXPERIMENTAL: this API may change without prior notice
 424  *
 425  * This function is the same as rte_timer_stop(), except that it allows a
 426  * caller to specify the rte_timer_data instance containing the list from which
 427  * this timer should be removed.
 428  *
 429  * @see rte_timer_stop()
 430  *
 431  * @param timer_data_id
 432  *   An identifier indicating which instance of timer data should be used for
 433  *   this operation.
 434  * @param tim
 435  *   The timer handle.
 436  * @return
 437  *   - 0: Success; the timer is stopped.
 438  *   - (-1): The timer is in the RUNNING or CONFIG state.
 439  *   - -EINVAL: invalid timer_data_id
 440  */
 441 __rte_experimental
 442 int
 443 rte_timer_alt_stop(uint32_t timer_data_id, struct rte_timer *tim);
 444
 445 /**
 446  * Callback function type for rte_timer_alt_manage().
 447  */
 448 typedef void (*rte_timer_alt_manage_cb_t)(struct rte_timer *tim);
 449
 450 /**
 451  * @warning
 452  * @b EXPERIMENTAL: this API may change without prior notice
 453  *
 454  * Manage a set of timer lists and execute the specified callback function for
 455  * all expired timers. This function is similar to rte_timer_manage(), except
 456  * that it allows a caller to specify the timer_data instance that should
 457  * be operated on, as well as a set of lcore IDs identifying which timer lists
 458  * should be processed.  Callback functions of individual timers are ignored.
 459  *
 460  * @see rte_timer_manage()
 461  *
 462  * @param timer_data_id
 463  *   An identifier indicating which instance of timer data should be used for
 464  *   this operation.
 465  * @param poll_lcores
 466  *   An array of lcore ids identifying the timer lists that should be processed.
 467  *   NULL is allowed - if NULL, the timer list corresponding to the lcore
 468  *   calling this routine is processed (same as rte_timer_manage()).
 469  * @param n_poll_lcores
 470  *   The size of the poll_lcores array. If 'poll_lcores' is NULL, this parameter
 471  *   is ignored.
 472  * @param f
 473  *   The callback function which should be called for all expired timers.
 474  * @return
 475  *   - 0: success
 476  *   - -EINVAL: invalid timer_data_id
 477  */
 478 __rte_experimental
 479 int
 480 rte_timer_alt_manage(uint32_t timer_data_id, unsigned int *poll_lcores,
 481                      int n_poll_lcores, rte_timer_alt_manage_cb_t f);
 482
 483 /**
 484  * Callback function type for rte_timer_stop_all().
 485  */
 486 typedef void (*rte_timer_stop_all_cb_t)(struct rte_timer *tim, void *arg);
 487
 488 /**
 489  * @warning
 490  * @b EXPERIMENTAL: this API may change without prior notice
 491  *
 492  * Walk the pending timer lists for the specified lcore IDs, and for each timer
 493  * that is encountered, stop it and call the specified callback function to
 494  * process it further.
 495  *
 496  * @param timer_data_id
 497  *   An identifier indicating which instance of timer data should be used for
 498  *   this operation.
 499  * @param walk_lcores
 500  *   An array of lcore ids identifying the timer lists that should be processed.
 501  * @param nb_walk_lcores
 502  *   The size of the walk_lcores array.
 503  * @param f
 504  *   The callback function which should be called for each timers. Can be NULL.
 505  * @param f_arg
 506  *   An arbitrary argument that will be passed to f, if it is called.
 507  * @return
 508  *   - 0: success
 509  *   - EINVAL: invalid timer_data_id
 510  */
 511 __rte_experimental
 512 int
 513 rte_timer_stop_all(uint32_t timer_data_id, unsigned int *walk_lcores,
 514                    int nb_walk_lcores, rte_timer_stop_all_cb_t f, void *f_arg);
 515
 516 /**
 517  * @warning
 518  * @b EXPERIMENTAL: this API may change without prior notice
 519  *
 520  * This function is the same as rte_timer_dump_stats(), except that it allows
 521  * the caller to specify the rte_timer_data instance that should be used.
 522  *
 523  * @see rte_timer_dump_stats()
 524  *
 525  * @param timer_data_id
 526  *   An identifier indicating which instance of timer data should be used for
 527  *   this operation.
 528  * @param f
 529  *   A pointer to a file for output
 530  * @return
 531  *   - 0: success
 532  *   - -EINVAL: invalid timer_data_id
 533  */
 534 __rte_experimental
 535 int
 536 rte_timer_alt_dump_stats(uint32_t timer_data_id, FILE *f);
 537
 538 #ifdef __cplusplus
 539 }
 540 #endif
 541
 542 #endif /* _RTE_TIMER_H_ */