blob: 0cfc9bf3c8ad6660c94927596588d505d1c0612e [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
2 * Time calculation functions.
3 *
Willy Tarreau45a12512011-09-10 16:56:42 +02004 * Copyright 2000-2011 Willy Tarreau <w@1wt.eu>
Willy Tarreaubaaee002006-06-26 02:48:02 +02005 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
Willy Tarreaued72d822018-10-17 19:01:24 +020013#include <unistd.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020014#include <sys/time.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020015
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020016#include <haproxy/api.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020017#include <haproxy/time.h>
Willy Tarreau6064b342021-03-23 08:45:42 +010018#include <haproxy/ticks.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020019#include <haproxy/tools.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020020
Christopher Faulet9a655712017-05-11 11:00:15 +020021THREAD_LOCAL unsigned int ms_left_scaled; /* milliseconds left for current second (0..2^32-1) */
22THREAD_LOCAL unsigned int now_ms; /* internal date in milliseconds (may wrap) */
23THREAD_LOCAL unsigned int samp_time; /* total elapsed time over current sample */
24THREAD_LOCAL unsigned int idle_time; /* total idle time over current sample */
Christopher Faulet9a655712017-05-11 11:00:15 +020025THREAD_LOCAL struct timeval now; /* internal date is a monotonic function of real clock */
26THREAD_LOCAL struct timeval date; /* the real current date */
Willy Tarreaubaaee002006-06-26 02:48:02 +020027struct timeval start_date; /* the process's start date */
Christopher Faulet9a655712017-05-11 11:00:15 +020028THREAD_LOCAL struct timeval before_poll; /* system date before calling poll() */
29THREAD_LOCAL struct timeval after_poll; /* system date after leaving poll() */
Willy Tarreaubaaee002006-06-26 02:48:02 +020030
Willy Tarreau9fefc512017-11-23 14:52:28 +010031static THREAD_LOCAL struct timeval tv_offset; /* per-thread time ofsset relative to global time */
Willy Tarreau650f3742021-03-17 18:52:18 +010032volatile unsigned long long global_now; /* common date between all threads (32:32) */
Willy Tarreau6064b342021-03-23 08:45:42 +010033volatile unsigned int global_now_ms; /* common date in milliseconds (may wrap) */
Willy Tarreau9fefc512017-11-23 14:52:28 +010034
Willy Tarreau93acfa22019-09-26 08:00:23 +020035static THREAD_LOCAL unsigned int iso_time_sec; /* last iso time value for this thread */
Emeric Brunb39a3752020-07-02 17:22:17 +020036static THREAD_LOCAL char iso_time_str[34]; /* ISO time representation of gettimeofday() */
Willy Tarreau93acfa22019-09-26 08:00:23 +020037
Willy Tarreaubaaee002006-06-26 02:48:02 +020038/*
39 * adds <ms> ms to <from>, set the result to <tv> and returns a pointer <tv>
40 */
Willy Tarreau03e78532020-02-25 07:38:05 +010041struct timeval *_tv_ms_add(struct timeval *tv, const struct timeval *from, int ms)
Willy Tarreaubaaee002006-06-26 02:48:02 +020042{
Willy Tarreau42aae5c2007-04-29 17:43:56 +020043 tv->tv_usec = from->tv_usec + (ms % 1000) * 1000;
44 tv->tv_sec = from->tv_sec + (ms / 1000);
Willy Tarreaubaaee002006-06-26 02:48:02 +020045 while (tv->tv_usec >= 1000000) {
46 tv->tv_usec -= 1000000;
47 tv->tv_sec++;
48 }
49 return tv;
50}
51
52/*
53 * compares <tv1> and <tv2> modulo 1ms: returns 0 if equal, -1 if tv1 < tv2, 1 if tv1 > tv2
Willy Tarreau42aae5c2007-04-29 17:43:56 +020054 * Must not be used when either argument is eternity. Use tv_ms_cmp2() for that.
Willy Tarreaubaaee002006-06-26 02:48:02 +020055 */
Willy Tarreau03e78532020-02-25 07:38:05 +010056int _tv_ms_cmp(const struct timeval *tv1, const struct timeval *tv2)
Willy Tarreaubaaee002006-06-26 02:48:02 +020057{
Willy Tarreau42aae5c2007-04-29 17:43:56 +020058 return __tv_ms_cmp(tv1, tv2);
Willy Tarreaubaaee002006-06-26 02:48:02 +020059}
60
61/*
Willy Tarreaubaaee002006-06-26 02:48:02 +020062 * compares <tv1> and <tv2> modulo 1 ms: returns 0 if equal, -1 if tv1 < tv2, 1 if tv1 > tv2,
Willy Tarreaua6a6a932007-04-28 22:40:08 +020063 * assuming that TV_ETERNITY is greater than everything.
Willy Tarreaubaaee002006-06-26 02:48:02 +020064 */
Willy Tarreau03e78532020-02-25 07:38:05 +010065int _tv_ms_cmp2(const struct timeval *tv1, const struct timeval *tv2)
Willy Tarreaubaaee002006-06-26 02:48:02 +020066{
Willy Tarreau42aae5c2007-04-29 17:43:56 +020067 return __tv_ms_cmp2(tv1, tv2);
Willy Tarreau8d7d1492007-04-29 10:50:43 +020068}
69
70/*
71 * compares <tv1> and <tv2> modulo 1 ms: returns 1 if tv1 <= tv2, 0 if tv1 > tv2,
72 * assuming that TV_ETERNITY is greater than everything. Returns 0 if tv1 is
73 * TV_ETERNITY, and always assumes that tv2 != TV_ETERNITY. Designed to replace
Willy Tarreau42aae5c2007-04-29 17:43:56 +020074 * occurrences of (tv_ms_cmp2(tv,now) <= 0).
Willy Tarreau8d7d1492007-04-29 10:50:43 +020075 */
Willy Tarreau03e78532020-02-25 07:38:05 +010076int _tv_ms_le2(const struct timeval *tv1, const struct timeval *tv2)
Willy Tarreau8d7d1492007-04-29 10:50:43 +020077{
Willy Tarreau42aae5c2007-04-29 17:43:56 +020078 return __tv_ms_le2(tv1, tv2);
79}
Willy Tarreau8d7d1492007-04-29 10:50:43 +020080
Willy Tarreau42aae5c2007-04-29 17:43:56 +020081/*
82 * returns the remaining time between tv1=now and event=tv2
83 * if tv2 is passed, 0 is returned.
84 * Must not be used when either argument is eternity.
85 */
Willy Tarreau03e78532020-02-25 07:38:05 +010086unsigned long _tv_ms_remain(const struct timeval *tv1, const struct timeval *tv2)
Willy Tarreau42aae5c2007-04-29 17:43:56 +020087{
88 return __tv_ms_remain(tv1, tv2);
Willy Tarreaubaaee002006-06-26 02:48:02 +020089}
90
91/*
92 * returns the remaining time between tv1=now and event=tv2
93 * if tv2 is passed, 0 is returned.
94 * Returns TIME_ETERNITY if tv2 is eternity.
95 */
Willy Tarreau03e78532020-02-25 07:38:05 +010096unsigned long _tv_ms_remain2(const struct timeval *tv1, const struct timeval *tv2)
Willy Tarreaubaaee002006-06-26 02:48:02 +020097{
Willy Tarreaubaaee002006-06-26 02:48:02 +020098 if (tv_iseternity(tv2))
99 return TIME_ETERNITY;
100
Willy Tarreau42aae5c2007-04-29 17:43:56 +0200101 return __tv_ms_remain(tv1, tv2);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200102}
103
Willy Tarreaubaaee002006-06-26 02:48:02 +0200104/*
Willy Tarreau42aae5c2007-04-29 17:43:56 +0200105 * Returns the time in ms elapsed between tv1 and tv2, assuming that tv1<=tv2.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200106 * Must not be used when either argument is eternity.
107 */
Willy Tarreau03e78532020-02-25 07:38:05 +0100108unsigned long _tv_ms_elapsed(const struct timeval *tv1, const struct timeval *tv2)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200109{
Willy Tarreau42aae5c2007-04-29 17:43:56 +0200110 return __tv_ms_elapsed(tv1, tv2);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200111}
112
113/*
Willy Tarreaud825eef2007-05-12 22:35:00 +0200114 * adds <inc> to <from>, set the result to <tv> and returns a pointer <tv>
115 */
Willy Tarreau03e78532020-02-25 07:38:05 +0100116struct timeval *_tv_add(struct timeval *tv, const struct timeval *from, const struct timeval *inc)
Willy Tarreaud825eef2007-05-12 22:35:00 +0200117{
118 return __tv_add(tv, from, inc);
119}
120
121/*
Willy Tarreau0481c202007-05-13 16:03:27 +0200122 * If <inc> is set, then add it to <from> and set the result to <tv>, then
123 * return 1, otherwise return 0. It is meant to be used in if conditions.
124 */
Willy Tarreau03e78532020-02-25 07:38:05 +0100125int _tv_add_ifset(struct timeval *tv, const struct timeval *from, const struct timeval *inc)
Willy Tarreau0481c202007-05-13 16:03:27 +0200126{
127 return __tv_add_ifset(tv, from, inc);
128}
129
130/*
Willy Tarreaud825eef2007-05-12 22:35:00 +0200131 * Computes the remaining time between tv1=now and event=tv2. if tv2 is passed,
132 * 0 is returned. The result is stored into tv.
133 */
Willy Tarreau03e78532020-02-25 07:38:05 +0100134struct timeval *_tv_remain(const struct timeval *tv1, const struct timeval *tv2, struct timeval *tv)
Willy Tarreaud825eef2007-05-12 22:35:00 +0200135{
136 return __tv_remain(tv1, tv2, tv);
137}
138
139/*
140 * Computes the remaining time between tv1=now and event=tv2. if tv2 is passed,
141 * 0 is returned. The result is stored into tv. Returns ETERNITY if tv2 is
142 * eternity.
143 */
Willy Tarreau03e78532020-02-25 07:38:05 +0100144struct timeval *_tv_remain2(const struct timeval *tv1, const struct timeval *tv2, struct timeval *tv)
Willy Tarreaud825eef2007-05-12 22:35:00 +0200145{
146 return __tv_remain2(tv1, tv2, tv);
147}
148
Willy Tarreau0481c202007-05-13 16:03:27 +0200149/* tv_isle: compares <tv1> and <tv2> : returns 1 if tv1 <= tv2, otherwise 0 */
Willy Tarreau03e78532020-02-25 07:38:05 +0100150int _tv_isle(const struct timeval *tv1, const struct timeval *tv2)
Willy Tarreau0481c202007-05-13 16:03:27 +0200151{
152 return __tv_isle(tv1, tv2);
153}
154
155/* tv_isgt: compares <tv1> and <tv2> : returns 1 if tv1 > tv2, otherwise 0 */
Willy Tarreau03e78532020-02-25 07:38:05 +0100156int _tv_isgt(const struct timeval *tv1, const struct timeval *tv2)
Willy Tarreau0481c202007-05-13 16:03:27 +0200157{
158 return __tv_isgt(tv1, tv2);
159}
160
Willy Tarreau7649aac2017-11-23 11:52:55 +0100161/* tv_update_date: sets <date> to system time, and sets <now> to something as
Willy Tarreaub0b37bc2008-06-23 14:00:57 +0200162 * close as possible to real time, following a monotonic function. The main
163 * principle consists in detecting backwards and forwards time jumps and adjust
164 * an offset to correct them. This function should be called once after each
165 * poll, and never farther apart than MAX_DELAY_MS*2. The poll's timeout should
166 * be passed in <max_wait>, and the return value in <interrupted> (a non-zero
167 * value means that we have not expired the timeout). Calling it with (-1,*)
168 * sets both <date> and <now> to current date, and calling it with (0,1) simply
169 * updates the values.
Christopher Faulet99aad922017-10-31 09:03:51 +0100170 *
Willy Tarreau7649aac2017-11-23 11:52:55 +0100171 * An offset is used to adjust the current time (date), to have a monotonic time
Christopher Faulet99aad922017-10-31 09:03:51 +0100172 * (now). It must be global and thread-safe. But a timeval cannot be atomically
Willy Tarreau7649aac2017-11-23 11:52:55 +0100173 * updated. So instead, we store it in a 64-bits integer (offset) whose 32 MSB
Ilya Shipitsin46a030c2020-07-05 16:36:08 +0500174 * contain the signed seconds adjustment and the 32 LSB contain the unsigned
Willy Tarreau7649aac2017-11-23 11:52:55 +0100175 * microsecond adjustment. We cannot use a timeval for this since it's never
176 * clearly specified whether a timeval may hold negative values or not.
Willy Tarreaub7f694f2008-06-22 17:18:02 +0200177 */
Willy Tarreau03e78532020-02-25 07:38:05 +0100178void tv_update_date(int max_wait, int interrupted)
Willy Tarreaub7f694f2008-06-22 17:18:02 +0200179{
Willy Tarreaua3315442018-02-05 20:11:38 +0100180 struct timeval adjusted, deadline, tmp_now, tmp_adj;
Willy Tarreau351b3a12017-03-29 15:24:33 +0200181 unsigned int curr_sec_ms; /* millisecond of current second (0..999) */
Willy Tarreau6064b342021-03-23 08:45:42 +0100182 unsigned int old_now_ms, new_now_ms;
Willy Tarreau9fefc512017-11-23 14:52:28 +0100183 unsigned long long old_now;
184 unsigned long long new_now;
Willy Tarreaub7f694f2008-06-22 17:18:02 +0200185
Willy Tarreaub0b37bc2008-06-23 14:00:57 +0200186 gettimeofday(&date, NULL);
187 if (unlikely(max_wait < 0)) {
Willy Tarreau9fefc512017-11-23 14:52:28 +0100188 tv_zero(&tv_offset);
Willy Tarreau75590582009-03-05 14:54:50 +0100189 adjusted = date;
Willy Tarreau45a12512011-09-10 16:56:42 +0200190 after_poll = date;
191 samp_time = idle_time = 0;
Willy Tarreau81036f22019-05-20 19:24:50 +0200192 ti->idle_pct = 100;
Willy Tarreau43091ed2019-06-06 16:50:39 +0200193 old_now = global_now;
194 if (!old_now) { // never set
195 new_now = (((unsigned long long)adjusted.tv_sec) << 32) + (unsigned int)adjusted.tv_usec;
196 _HA_ATOMIC_CAS(&global_now, &old_now, new_now);
197 }
Willy Tarreaue6313a32008-06-29 13:47:25 +0200198 goto to_ms;
Willy Tarreaub0b37bc2008-06-23 14:00:57 +0200199 }
Willy Tarreau7649aac2017-11-23 11:52:55 +0100200
Willy Tarreau9fefc512017-11-23 14:52:28 +0100201 __tv_add(&adjusted, &date, &tv_offset);
Willy Tarreau7649aac2017-11-23 11:52:55 +0100202
Willy Tarreau9fefc512017-11-23 14:52:28 +0100203 /* compute the minimum and maximum local date we may have reached based
204 * on our past date and the associated timeout.
205 */
206 _tv_ms_add(&deadline, &now, max_wait + MAX_DELAY_MS);
Willy Tarreau7649aac2017-11-23 11:52:55 +0100207
Willy Tarreau9fefc512017-11-23 14:52:28 +0100208 if (unlikely(__tv_islt(&adjusted, &now) || __tv_islt(&deadline, &adjusted))) {
209 /* Large jump. If the poll was interrupted, we consider that the
210 * date has not changed (immediate wake-up), otherwise we add
211 * the poll time-out to the previous date. The new offset is
212 * recomputed.
213 */
214 _tv_ms_add(&adjusted, &now, interrupted ? 0 : max_wait);
Willy Tarreaub0b37bc2008-06-23 14:00:57 +0200215 }
216
Willy Tarreau9fefc512017-11-23 14:52:28 +0100217 /* now that we have bounded the local time, let's check if it's
218 * realistic regarding the global date, which only moves forward,
219 * otherwise catch up.
Willy Tarreaub0b37bc2008-06-23 14:00:57 +0200220 */
Willy Tarreau9fefc512017-11-23 14:52:28 +0100221 old_now = global_now;
Willy Tarreau75590582009-03-05 14:54:50 +0100222
Willy Tarreau9fefc512017-11-23 14:52:28 +0100223 do {
224 tmp_now.tv_sec = (unsigned int)(old_now >> 32);
225 tmp_now.tv_usec = old_now & 0xFFFFFFFFU;
Willy Tarreaua3315442018-02-05 20:11:38 +0100226 tmp_adj = adjusted;
Willy Tarreau7649aac2017-11-23 11:52:55 +0100227
Willy Tarreaua3315442018-02-05 20:11:38 +0100228 if (__tv_islt(&tmp_adj, &tmp_now))
229 tmp_adj = tmp_now;
Willy Tarreau9fefc512017-11-23 14:52:28 +0100230
231 /* now <adjusted> is expected to be the most accurate date,
232 * equal to <global_now> or newer.
233 */
Willy Tarreaua3315442018-02-05 20:11:38 +0100234 new_now = (((unsigned long long)tmp_adj.tv_sec) << 32) + (unsigned int)tmp_adj.tv_usec;
Willy Tarreau9fefc512017-11-23 14:52:28 +0100235
236 /* let's try to update the global <now> or loop again */
Olivier Houchardcab0f0b2019-03-08 18:55:31 +0100237 } while (!_HA_ATOMIC_CAS(&global_now, &old_now, new_now));
Willy Tarreau9fefc512017-11-23 14:52:28 +0100238
Willy Tarreaua3315442018-02-05 20:11:38 +0100239 adjusted = tmp_adj;
240
Willy Tarreau9fefc512017-11-23 14:52:28 +0100241 /* the new global date when we looked was old_now, and the new one is
242 * new_now == adjusted. We can recompute our local offset.
243 */
244 tv_offset.tv_sec = adjusted.tv_sec - date.tv_sec;
245 tv_offset.tv_usec = adjusted.tv_usec - date.tv_usec;
246 if (tv_offset.tv_usec < 0) {
247 tv_offset.tv_usec += 1000000;
248 tv_offset.tv_sec--;
249 }
Willy Tarreau7649aac2017-11-23 11:52:55 +0100250
Willy Tarreaue6313a32008-06-29 13:47:25 +0200251 to_ms:
Willy Tarreau75590582009-03-05 14:54:50 +0100252 now = adjusted;
253 curr_sec_ms = now.tv_usec / 1000; /* ms of current second */
Willy Tarreaueab777c2012-12-29 21:50:07 +0100254
255 /* For frequency counters, we'll need to know the ratio of the previous
256 * value to add to current value depending on the current millisecond.
257 * The principle is that during the first millisecond, we use 999/1000
258 * of the past value and that during the last millisecond we use 0/1000
259 * of the past value. In summary, we only use the past value during the
260 * first 999 ms of a second, and the last ms is used to complete the
261 * current measure. The value is scaled to (2^32-1) so that a simple
262 * multiply followed by a shift gives us the final value.
263 */
264 ms_left_scaled = (999U - curr_sec_ms) * 4294967U;
Willy Tarreau75590582009-03-05 14:54:50 +0100265 now_ms = now.tv_sec * 1000 + curr_sec_ms;
Willy Tarreau6064b342021-03-23 08:45:42 +0100266
267 /* update the global current millisecond */
268 old_now_ms = global_now_ms;
269 do {
270 new_now_ms = old_now_ms;
271 if (tick_is_lt(new_now_ms, now_ms))
272 new_now_ms = now_ms;
273 } while (!_HA_ATOMIC_CAS(&global_now_ms, &old_now_ms, new_now_ms));
274
Willy Tarreaub0b37bc2008-06-23 14:00:57 +0200275 return;
Willy Tarreaub7f694f2008-06-22 17:18:02 +0200276}
277
Willy Tarreau93acfa22019-09-26 08:00:23 +0200278/* returns the current date as returned by gettimeofday() in ISO+microsecond
279 * format. It uses a thread-local static variable that the reader can consume
280 * for as long as it wants until next call. Thus, do not call it from a signal
281 * handler. If <pad> is non-0, a trailing space will be added. It will always
Emeric Brunb39a3752020-07-02 17:22:17 +0200282 * return exactly 32 or 33 characters (depending on padding) and will always be
283 * zero-terminated, thus it will always fit into a 34 bytes buffer.
284 * This also always include the local timezone (in +/-HH:mm format) .
Willy Tarreau93acfa22019-09-26 08:00:23 +0200285 */
286char *timeofday_as_iso_us(int pad)
287{
288 struct timeval new_date;
289 struct tm tm;
Emeric Brunb39a3752020-07-02 17:22:17 +0200290 const char *offset;
291 char c;
Willy Tarreau93acfa22019-09-26 08:00:23 +0200292 gettimeofday(&new_date, NULL);
293 if (new_date.tv_sec != iso_time_sec || !new_date.tv_sec) {
294 get_localtime(new_date.tv_sec, &tm);
Emeric Brunb39a3752020-07-02 17:22:17 +0200295 offset = get_gmt_offset(new_date.tv_sec, &tm);
296 if (unlikely(strftime(iso_time_str, sizeof(iso_time_str), "%Y-%m-%dT%H:%M:%S.000000+00:00", &tm) != 32))
297 strcpy(iso_time_str, "YYYY-mm-ddTHH:MM:SS.000000-00:00"); // make the failure visible but respect format.
298 iso_time_str[26] = offset[0];
299 iso_time_str[27] = offset[1];
300 iso_time_str[28] = offset[2];
301 iso_time_str[30] = offset[3];
302 iso_time_str[31] = offset[4];
Willy Tarreau93acfa22019-09-26 08:00:23 +0200303 iso_time_sec = new_date.tv_sec;
304 }
Emeric Brunb39a3752020-07-02 17:22:17 +0200305 /* utoa_pad adds a trailing 0 so we save the char for restore */
306 c = iso_time_str[26];
Willy Tarreau93acfa22019-09-26 08:00:23 +0200307 utoa_pad(new_date.tv_usec, iso_time_str + 20, 7);
Emeric Brunb39a3752020-07-02 17:22:17 +0200308 iso_time_str[26] = c;
Willy Tarreau93acfa22019-09-26 08:00:23 +0200309 if (pad) {
Emeric Brunb39a3752020-07-02 17:22:17 +0200310 iso_time_str[32] = ' ';
311 iso_time_str[33] = 0;
Willy Tarreau93acfa22019-09-26 08:00:23 +0200312 }
313 return iso_time_str;
314}
315
Willy Tarreaud825eef2007-05-12 22:35:00 +0200316/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200317 * Local variables:
318 * c-indent-level: 8
319 * c-basic-offset: 8
320 * End:
321 */