compat_time.h 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. /* Copyright (c) 2003-2004, Roger Dingledine
  2. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  3. * Copyright (c) 2007-2016, The Tor Project, Inc. */
  4. /* See LICENSE for licensing information */
  5. /**
  6. * \file compat_time.h
  7. *
  8. * \brief Functions and types for monotonic times.
  9. *
  10. * monotime_* functions try to provide a high-resolution monotonic timer with
  11. * something the best resolution the system provides. monotime_coarse_*
  12. * functions run faster (if the operating system gives us a way to do that)
  13. * but produce a less accurate timer: accuracy will probably be on the order
  14. * of tens of milliseconds.
  15. */
  16. #ifndef TOR_COMPAT_TIME_H
  17. #define TOR_COMPAT_TIME_H
  18. #include "orconfig.h"
  19. #ifdef _WIN32
  20. #undef HAVE_CLOCK_GETTIME
  21. #endif
  22. #if defined(HAVE_CLOCK_GETTIME)
  23. /* to ensure definition of CLOCK_MONOTONIC_COARSE if it's there */
  24. #include <time.h>
  25. #endif
  26. #if !defined(HAVE_GETTIMEOFDAY) && !defined(HAVE_STRUCT_TIMEVAL_TV_SEC)
  27. /** Implementation of timeval for platforms that don't have it. */
  28. struct timeval {
  29. time_t tv_sec;
  30. unsigned int tv_usec;
  31. };
  32. #endif
  33. /** Represents a monotonic timer in a platform-dependent way. */
  34. typedef struct monotime_t {
  35. #ifdef __APPLE__
  36. /* On apple, there is a 64-bit counter whose precision we must look up. */
  37. uint64_t abstime_;
  38. #elif defined(HAVE_CLOCK_GETTIME)
  39. /* It sure would be nice to use clock_gettime(). Posix is a nice thing. */
  40. struct timespec ts_;
  41. #elif defined (_WIN32)
  42. /* On Windows, there is a 64-bit counter whose precision we must look up. */
  43. int64_t pcount_;
  44. #else
  45. #define MONOTIME_USING_GETTIMEOFDAY
  46. /* Otherwise, we will be stuck using gettimeofday. */
  47. struct timeval tv_;
  48. #endif
  49. } monotime_t;
  50. #if defined(HAVE_CLOCK_GETTIME) && defined(CLOCK_MONOTONIC_COARSE)
  51. #define MONOTIME_COARSE_FN_IS_DIFFERENT
  52. #define monotime_coarse_t monotime_t
  53. #elif defined(_WIN32)
  54. #define MONOTIME_COARSE_FN_IS_DIFFERENT
  55. #define MONOTIME_COARSE_TYPE_IS_DIFFERENT
  56. /** Represents a coarse monotonic time in a platform-independent way. */
  57. typedef struct monotime_coarse_t {
  58. uint64_t tick_count_;
  59. } monotime_coarse_t;
  60. #else
  61. #define monotime_coarse_t monotime_t
  62. #endif
  63. /**
  64. * Initialize the timing subsystem. This function is idempotent.
  65. */
  66. void monotime_init(void);
  67. /**
  68. * Set <b>out</b> to the current time.
  69. */
  70. void monotime_get(monotime_t *out);
  71. /**
  72. * Return the number of nanoseconds between <b>start</b> and <b>end</b>.
  73. */
  74. int64_t monotime_diff_nsec(const monotime_t *start, const monotime_t *end);
  75. /**
  76. * Return the number of microseconds between <b>start</b> and <b>end</b>.
  77. */
  78. int64_t monotime_diff_usec(const monotime_t *start, const monotime_t *end);
  79. /**
  80. * Return the number of milliseconds between <b>start</b> and <b>end</b>.
  81. */
  82. int64_t monotime_diff_msec(const monotime_t *start, const monotime_t *end);
  83. /**
  84. * Return the number of nanoseconds since the timer system was initialized.
  85. */
  86. uint64_t monotime_absolute_nsec(void);
  87. /**
  88. * Return the number of microseconds since the timer system was initialized.
  89. */
  90. uint64_t monotime_absolute_usec(void);
  91. /**
  92. * Return the number of milliseconds since the timer system was initialized.
  93. */
  94. uint64_t monotime_absolute_msec(void);
  95. #if defined(MONOTIME_COARSE_FN_IS_DIFFERENT)
  96. /**
  97. * Set <b>out</b> to the current coarse time.
  98. */
  99. void monotime_coarse_get(monotime_coarse_t *out);
  100. uint64_t monotime_coarse_absolute_nsec(void);
  101. uint64_t monotime_coarse_absolute_usec(void);
  102. uint64_t monotime_coarse_absolute_msec(void);
  103. #else
  104. #define monotime_coarse_get monotime_get
  105. #define monotime_coarse_absolute_nsec monotime_absolute_nsec
  106. #define monotime_coarse_absolute_usec monotime_absolute_usec
  107. #define monotime_coarse_absolute_msec monotime_absolute_msec
  108. #endif
  109. #if defined(MONOTIME_COARSE_TYPE_IS_DIFFERENT)
  110. int64_t monotime_coarse_diff_nsec(const monotime_coarse_t *start,
  111. const monotime_coarse_t *end);
  112. int64_t monotime_coarse_diff_usec(const monotime_coarse_t *start,
  113. const monotime_coarse_t *end);
  114. int64_t monotime_coarse_diff_msec(const monotime_coarse_t *start,
  115. const monotime_coarse_t *end);
  116. #else
  117. #define monotime_coarse_diff_nsec monotime_diff_nsec
  118. #define monotime_coarse_diff_usec monotime_diff_usec
  119. #define monotime_coarse_diff_msec monotime_diff_msec
  120. #endif
  121. void tor_gettimeofday(struct timeval *timeval);
  122. #ifdef TOR_UNIT_TESTS
  123. void tor_sleep_msec(int msec);
  124. void monotime_enable_test_mocking(void);
  125. void monotime_disable_test_mocking(void);
  126. void monotime_set_mock_time_nsec(int64_t);
  127. #if defined(MONOTIME_COARSE_FN_IS_DIFFERENT)
  128. void monotime_coarse_set_mock_time_nsec(int64_t);
  129. #else
  130. #define monotime_coarse_set_mock_time_nsec monotime_set_mock_time_nsec
  131. #endif
  132. #endif
  133. #ifdef COMPAT_TIME_PRIVATE
  134. #if defined(_WIN32) || defined(TOR_UNIT_TESTS)
  135. STATIC int64_t ratchet_performance_counter(int64_t count_raw);
  136. STATIC int64_t ratchet_coarse_performance_counter(int64_t count_raw);
  137. #endif
  138. #if defined(MONOTIME_USING_GETTIMEOFDAY) || defined(TOR_UNIT_TESTS)
  139. STATIC void ratchet_timeval(const struct timeval *timeval_raw,
  140. struct timeval *out);
  141. #endif
  142. #ifdef TOR_UNIT_TESTS
  143. void monotime_reset_ratchets_for_testing(void);
  144. #endif
  145. #endif
  146. #endif