/src/openssl/include/internal/time.h
Line | Count | Source |
1 | | /* |
2 | | * Copyright 2022-2023 The OpenSSL Project Authors. All Rights Reserved. |
3 | | * |
4 | | * Licensed under the Apache License 2.0 (the "License"). You may not use |
5 | | * this file except in compliance with the License. You can obtain a copy |
6 | | * in the file LICENSE in the source distribution or at |
7 | | * https://www.openssl.org/source/license.html |
8 | | */ |
9 | | |
10 | | #ifndef OSSL_INTERNAL_TIME_H |
11 | | #define OSSL_INTERNAL_TIME_H |
12 | | #pragma once |
13 | | |
14 | | #include <openssl/e_os2.h> /* uint64_t */ |
15 | | #include "internal/e_os.h" |
16 | | #include "internal/e_winsock.h" /* for struct timeval */ |
17 | | #include "internal/safe_math.h" |
18 | | |
19 | | /* |
20 | | * Internal type defining a time. |
21 | | * This should be treated as an opaque structure. |
22 | | * |
23 | | * The time datum is Unix's 1970 and at nanosecond precision, this gives |
24 | | * a range of 584 years roughly. |
25 | | */ |
26 | | typedef struct { |
27 | | uint64_t t; /* Ticks since the epoch */ |
28 | | } OSSL_TIME; |
29 | | |
30 | | /* The precision of times allows this many values per second */ |
31 | 0 | #define OSSL_TIME_SECOND ((uint64_t)1000000000) |
32 | | |
33 | | /* One millisecond. */ |
34 | 0 | #define OSSL_TIME_MS (OSSL_TIME_SECOND / 1000) |
35 | | |
36 | | /* One microsecond. */ |
37 | 0 | #define OSSL_TIME_US (OSSL_TIME_MS / 1000) |
38 | | |
39 | | /* One nanosecond. */ |
40 | 0 | #define OSSL_TIME_NS (OSSL_TIME_US / 1000) |
41 | | |
42 | | #define ossl_seconds2time(s) ossl_ticks2time((s) * OSSL_TIME_SECOND) |
43 | 0 | #define ossl_time2seconds(t) (ossl_time2ticks(t) / OSSL_TIME_SECOND) |
44 | 0 | #define ossl_ms2time(ms) ossl_ticks2time((ms) * OSSL_TIME_MS) |
45 | 0 | #define ossl_time2ms(t) (ossl_time2ticks(t) / OSSL_TIME_MS) |
46 | | #define ossl_us2time(us) ossl_ticks2time((us) * OSSL_TIME_US) |
47 | | #define ossl_time2us(t) (ossl_time2ticks(t) / OSSL_TIME_US) |
48 | | |
49 | | /* |
50 | | * Arithmetic operations on times. |
51 | | * These operations are saturating, in that an overflow or underflow returns |
52 | | * the largest or smallest value respectively. |
53 | | */ |
54 | | OSSL_SAFE_MATH_UNSIGNED(time, uint64_t) |
55 | | |
56 | | /* Convert a tick count into a time */ |
57 | | static ossl_unused ossl_inline |
58 | | OSSL_TIME |
59 | | ossl_ticks2time(uint64_t ticks) |
60 | 0 | { |
61 | 0 | OSSL_TIME r; |
62 | |
|
63 | 0 | r.t = ticks; |
64 | 0 | return r; |
65 | 0 | } Unexecuted instantiation: api.c:ossl_ticks2time Unexecuted instantiation: internal.c:ossl_ticks2time Unexecuted instantiation: argon2.c:ossl_ticks2time Unexecuted instantiation: sleep.c:ossl_ticks2time Unexecuted instantiation: time.c:ossl_ticks2time Unexecuted instantiation: thread_posix.c:ossl_ticks2time Unexecuted instantiation: arch.c:ossl_ticks2time Unexecuted instantiation: bss_dgram.c:ossl_ticks2time |
66 | | |
67 | | /* Convert a time to a tick count */ |
68 | | static ossl_unused ossl_inline |
69 | | uint64_t |
70 | | ossl_time2ticks(OSSL_TIME t) |
71 | 0 | { |
72 | 0 | return t.t; |
73 | 0 | } Unexecuted instantiation: api.c:ossl_time2ticks Unexecuted instantiation: internal.c:ossl_time2ticks Unexecuted instantiation: argon2.c:ossl_time2ticks Unexecuted instantiation: sleep.c:ossl_time2ticks Unexecuted instantiation: time.c:ossl_time2ticks Unexecuted instantiation: thread_posix.c:ossl_time2ticks Unexecuted instantiation: arch.c:ossl_time2ticks Unexecuted instantiation: bss_dgram.c:ossl_time2ticks |
74 | | |
75 | | /* Get current time */ |
76 | | OSSL_TIME ossl_time_now(void); |
77 | | |
78 | | /* The beginning and end of the time range */ |
79 | | static ossl_unused ossl_inline |
80 | | OSSL_TIME |
81 | | ossl_time_zero(void) |
82 | 0 | { |
83 | 0 | return ossl_ticks2time(0); |
84 | 0 | } Unexecuted instantiation: api.c:ossl_time_zero Unexecuted instantiation: internal.c:ossl_time_zero Unexecuted instantiation: argon2.c:ossl_time_zero Unexecuted instantiation: sleep.c:ossl_time_zero Unexecuted instantiation: time.c:ossl_time_zero Unexecuted instantiation: thread_posix.c:ossl_time_zero Unexecuted instantiation: arch.c:ossl_time_zero Unexecuted instantiation: bss_dgram.c:ossl_time_zero |
85 | | |
86 | | static ossl_unused ossl_inline |
87 | | OSSL_TIME |
88 | | ossl_time_infinite(void) |
89 | 0 | { |
90 | 0 | return ossl_ticks2time(~(uint64_t)0); |
91 | 0 | } Unexecuted instantiation: api.c:ossl_time_infinite Unexecuted instantiation: internal.c:ossl_time_infinite Unexecuted instantiation: argon2.c:ossl_time_infinite Unexecuted instantiation: sleep.c:ossl_time_infinite Unexecuted instantiation: time.c:ossl_time_infinite Unexecuted instantiation: thread_posix.c:ossl_time_infinite Unexecuted instantiation: arch.c:ossl_time_infinite Unexecuted instantiation: bss_dgram.c:ossl_time_infinite |
92 | | |
93 | | /* Convert time to timeval */ |
94 | | static ossl_unused ossl_inline struct timeval ossl_time_to_timeval(OSSL_TIME t) |
95 | 0 | { |
96 | 0 | struct timeval tv; |
97 | 0 | int err = 0; |
98 | | |
99 | | /* |
100 | | * Round up any nano secs which struct timeval doesn't support. Ensures that |
101 | | * we never return a zero time if the input time is non zero |
102 | | */ |
103 | 0 | t.t = safe_add_time(t.t, OSSL_TIME_US - 1, &err); |
104 | 0 | if (err) |
105 | 0 | t = ossl_time_infinite(); |
106 | |
|
107 | | #ifdef _WIN32 |
108 | | tv.tv_sec = (long int)(t.t / OSSL_TIME_SECOND); |
109 | | #else |
110 | 0 | tv.tv_sec = (time_t)(t.t / OSSL_TIME_SECOND); |
111 | 0 | #endif |
112 | 0 | tv.tv_usec = (t.t % OSSL_TIME_SECOND) / OSSL_TIME_US; |
113 | 0 | return tv; |
114 | 0 | } Unexecuted instantiation: api.c:ossl_time_to_timeval Unexecuted instantiation: internal.c:ossl_time_to_timeval Unexecuted instantiation: argon2.c:ossl_time_to_timeval Unexecuted instantiation: sleep.c:ossl_time_to_timeval Unexecuted instantiation: time.c:ossl_time_to_timeval Unexecuted instantiation: thread_posix.c:ossl_time_to_timeval Unexecuted instantiation: arch.c:ossl_time_to_timeval Unexecuted instantiation: bss_dgram.c:ossl_time_to_timeval |
115 | | |
116 | | /* Convert timeval to time */ |
117 | | static ossl_unused ossl_inline |
118 | | OSSL_TIME |
119 | | ossl_time_from_timeval(struct timeval tv) |
120 | 0 | { |
121 | 0 | OSSL_TIME t; |
122 | |
|
123 | 0 | #ifndef __DJGPP__ /* tv_sec is unsigned on djgpp. */ |
124 | 0 | if (tv.tv_sec < 0) |
125 | 0 | return ossl_time_zero(); |
126 | 0 | #endif |
127 | 0 | t.t = tv.tv_sec * OSSL_TIME_SECOND + tv.tv_usec * OSSL_TIME_US; |
128 | 0 | return t; |
129 | 0 | } Unexecuted instantiation: api.c:ossl_time_from_timeval Unexecuted instantiation: internal.c:ossl_time_from_timeval Unexecuted instantiation: argon2.c:ossl_time_from_timeval Unexecuted instantiation: sleep.c:ossl_time_from_timeval Unexecuted instantiation: time.c:ossl_time_from_timeval Unexecuted instantiation: thread_posix.c:ossl_time_from_timeval Unexecuted instantiation: arch.c:ossl_time_from_timeval Unexecuted instantiation: bss_dgram.c:ossl_time_from_timeval |
130 | | |
131 | | /* Convert OSSL_TIME to time_t */ |
132 | | static ossl_unused ossl_inline |
133 | | time_t |
134 | | ossl_time_to_time_t(OSSL_TIME t) |
135 | 0 | { |
136 | 0 | return (time_t)(t.t / OSSL_TIME_SECOND); |
137 | 0 | } Unexecuted instantiation: api.c:ossl_time_to_time_t Unexecuted instantiation: internal.c:ossl_time_to_time_t Unexecuted instantiation: argon2.c:ossl_time_to_time_t Unexecuted instantiation: sleep.c:ossl_time_to_time_t Unexecuted instantiation: time.c:ossl_time_to_time_t Unexecuted instantiation: thread_posix.c:ossl_time_to_time_t Unexecuted instantiation: arch.c:ossl_time_to_time_t Unexecuted instantiation: bss_dgram.c:ossl_time_to_time_t |
138 | | |
139 | | /* Convert time_t to OSSL_TIME */ |
140 | | static ossl_unused ossl_inline |
141 | | OSSL_TIME |
142 | | ossl_time_from_time_t(time_t t) |
143 | 0 | { |
144 | 0 | OSSL_TIME ot; |
145 | 0 |
|
146 | 0 | ot.t = t; |
147 | 0 | ot.t *= OSSL_TIME_SECOND; |
148 | 0 | return ot; |
149 | 0 | } Unexecuted instantiation: api.c:ossl_time_from_time_t Unexecuted instantiation: internal.c:ossl_time_from_time_t Unexecuted instantiation: argon2.c:ossl_time_from_time_t Unexecuted instantiation: sleep.c:ossl_time_from_time_t Unexecuted instantiation: time.c:ossl_time_from_time_t Unexecuted instantiation: thread_posix.c:ossl_time_from_time_t Unexecuted instantiation: arch.c:ossl_time_from_time_t Unexecuted instantiation: bss_dgram.c:ossl_time_from_time_t |
150 | | |
151 | | /* Compare two time values, return -1 if less, 1 if greater and 0 if equal */ |
152 | | static ossl_unused ossl_inline int ossl_time_compare(OSSL_TIME a, OSSL_TIME b) |
153 | 0 | { |
154 | 0 | if (a.t > b.t) |
155 | 0 | return 1; |
156 | 0 | if (a.t < b.t) |
157 | 0 | return -1; |
158 | 0 | return 0; |
159 | 0 | } Unexecuted instantiation: api.c:ossl_time_compare Unexecuted instantiation: internal.c:ossl_time_compare Unexecuted instantiation: argon2.c:ossl_time_compare Unexecuted instantiation: sleep.c:ossl_time_compare Unexecuted instantiation: time.c:ossl_time_compare Unexecuted instantiation: thread_posix.c:ossl_time_compare Unexecuted instantiation: arch.c:ossl_time_compare Unexecuted instantiation: bss_dgram.c:ossl_time_compare |
160 | | |
161 | | /* Returns true if an OSSL_TIME is ossl_time_zero(). */ |
162 | | static ossl_unused ossl_inline int ossl_time_is_zero(OSSL_TIME t) |
163 | 0 | { |
164 | 0 | return ossl_time_compare(t, ossl_time_zero()) == 0; |
165 | 0 | } Unexecuted instantiation: api.c:ossl_time_is_zero Unexecuted instantiation: internal.c:ossl_time_is_zero Unexecuted instantiation: argon2.c:ossl_time_is_zero Unexecuted instantiation: sleep.c:ossl_time_is_zero Unexecuted instantiation: time.c:ossl_time_is_zero Unexecuted instantiation: thread_posix.c:ossl_time_is_zero Unexecuted instantiation: arch.c:ossl_time_is_zero Unexecuted instantiation: bss_dgram.c:ossl_time_is_zero |
166 | | |
167 | | /* Returns true if an OSSL_TIME is ossl_time_infinite(). */ |
168 | | static ossl_unused ossl_inline int ossl_time_is_infinite(OSSL_TIME t) |
169 | 0 | { |
170 | 0 | return ossl_time_compare(t, ossl_time_infinite()) == 0; |
171 | 0 | } Unexecuted instantiation: api.c:ossl_time_is_infinite Unexecuted instantiation: internal.c:ossl_time_is_infinite Unexecuted instantiation: argon2.c:ossl_time_is_infinite Unexecuted instantiation: sleep.c:ossl_time_is_infinite Unexecuted instantiation: time.c:ossl_time_is_infinite Unexecuted instantiation: thread_posix.c:ossl_time_is_infinite Unexecuted instantiation: arch.c:ossl_time_is_infinite Unexecuted instantiation: bss_dgram.c:ossl_time_is_infinite |
172 | | |
173 | | static ossl_unused ossl_inline |
174 | | OSSL_TIME |
175 | | ossl_time_add(OSSL_TIME a, OSSL_TIME b) |
176 | 0 | { |
177 | 0 | OSSL_TIME r; |
178 | 0 | int err = 0; |
179 | |
|
180 | 0 | r.t = safe_add_time(a.t, b.t, &err); |
181 | 0 | return err ? ossl_time_infinite() : r; |
182 | 0 | } Unexecuted instantiation: api.c:ossl_time_add Unexecuted instantiation: internal.c:ossl_time_add Unexecuted instantiation: argon2.c:ossl_time_add Unexecuted instantiation: sleep.c:ossl_time_add Unexecuted instantiation: time.c:ossl_time_add Unexecuted instantiation: thread_posix.c:ossl_time_add Unexecuted instantiation: arch.c:ossl_time_add Unexecuted instantiation: bss_dgram.c:ossl_time_add |
183 | | |
184 | | static ossl_unused ossl_inline |
185 | | OSSL_TIME |
186 | | ossl_time_subtract(OSSL_TIME a, OSSL_TIME b) |
187 | 0 | { |
188 | 0 | OSSL_TIME r; |
189 | 0 | int err = 0; |
190 | |
|
191 | 0 | r.t = safe_sub_time(a.t, b.t, &err); |
192 | 0 | return err ? ossl_time_zero() : r; |
193 | 0 | } Unexecuted instantiation: api.c:ossl_time_subtract Unexecuted instantiation: internal.c:ossl_time_subtract Unexecuted instantiation: argon2.c:ossl_time_subtract Unexecuted instantiation: sleep.c:ossl_time_subtract Unexecuted instantiation: time.c:ossl_time_subtract Unexecuted instantiation: thread_posix.c:ossl_time_subtract Unexecuted instantiation: arch.c:ossl_time_subtract Unexecuted instantiation: bss_dgram.c:ossl_time_subtract |
194 | | |
195 | | /* Returns |a - b|. */ |
196 | | static ossl_unused ossl_inline |
197 | | OSSL_TIME |
198 | | ossl_time_abs_difference(OSSL_TIME a, OSSL_TIME b) |
199 | 0 | { |
200 | 0 | return a.t > b.t ? ossl_time_subtract(a, b) |
201 | 0 | : ossl_time_subtract(b, a); |
202 | 0 | } Unexecuted instantiation: api.c:ossl_time_abs_difference Unexecuted instantiation: internal.c:ossl_time_abs_difference Unexecuted instantiation: argon2.c:ossl_time_abs_difference Unexecuted instantiation: sleep.c:ossl_time_abs_difference Unexecuted instantiation: time.c:ossl_time_abs_difference Unexecuted instantiation: thread_posix.c:ossl_time_abs_difference Unexecuted instantiation: arch.c:ossl_time_abs_difference Unexecuted instantiation: bss_dgram.c:ossl_time_abs_difference |
203 | | |
204 | | static ossl_unused ossl_inline |
205 | | OSSL_TIME |
206 | | ossl_time_multiply(OSSL_TIME a, uint64_t b) |
207 | 0 | { |
208 | 0 | OSSL_TIME r; |
209 | 0 | int err = 0; |
210 | 0 |
|
211 | 0 | r.t = safe_mul_time(a.t, b, &err); |
212 | 0 | return err ? ossl_time_infinite() : r; |
213 | 0 | } Unexecuted instantiation: api.c:ossl_time_multiply Unexecuted instantiation: internal.c:ossl_time_multiply Unexecuted instantiation: argon2.c:ossl_time_multiply Unexecuted instantiation: sleep.c:ossl_time_multiply Unexecuted instantiation: time.c:ossl_time_multiply Unexecuted instantiation: thread_posix.c:ossl_time_multiply Unexecuted instantiation: arch.c:ossl_time_multiply Unexecuted instantiation: bss_dgram.c:ossl_time_multiply |
214 | | |
215 | | static ossl_unused ossl_inline |
216 | | OSSL_TIME |
217 | | ossl_time_divide(OSSL_TIME a, uint64_t b) |
218 | 0 | { |
219 | 0 | OSSL_TIME r; |
220 | 0 | int err = 0; |
221 | 0 |
|
222 | 0 | r.t = safe_div_time(a.t, b, &err); |
223 | 0 | return err ? ossl_time_zero() : r; |
224 | 0 | } Unexecuted instantiation: api.c:ossl_time_divide Unexecuted instantiation: internal.c:ossl_time_divide Unexecuted instantiation: argon2.c:ossl_time_divide Unexecuted instantiation: sleep.c:ossl_time_divide Unexecuted instantiation: time.c:ossl_time_divide Unexecuted instantiation: thread_posix.c:ossl_time_divide Unexecuted instantiation: arch.c:ossl_time_divide Unexecuted instantiation: bss_dgram.c:ossl_time_divide |
225 | | |
226 | | static ossl_unused ossl_inline |
227 | | OSSL_TIME |
228 | | ossl_time_muldiv(OSSL_TIME a, uint64_t b, uint64_t c) |
229 | 0 | { |
230 | 0 | OSSL_TIME r; |
231 | 0 | int err = 0; |
232 | 0 |
|
233 | 0 | r.t = safe_muldiv_time(a.t, b, c, &err); |
234 | 0 | return err ? ossl_time_zero() : r; |
235 | 0 | } Unexecuted instantiation: api.c:ossl_time_muldiv Unexecuted instantiation: internal.c:ossl_time_muldiv Unexecuted instantiation: argon2.c:ossl_time_muldiv Unexecuted instantiation: sleep.c:ossl_time_muldiv Unexecuted instantiation: time.c:ossl_time_muldiv Unexecuted instantiation: thread_posix.c:ossl_time_muldiv Unexecuted instantiation: arch.c:ossl_time_muldiv Unexecuted instantiation: bss_dgram.c:ossl_time_muldiv |
236 | | |
237 | | /* Return higher of the two given time values. */ |
238 | | static ossl_unused ossl_inline |
239 | | OSSL_TIME |
240 | | ossl_time_max(OSSL_TIME a, OSSL_TIME b) |
241 | 0 | { |
242 | 0 | return a.t > b.t ? a : b; |
243 | 0 | } Unexecuted instantiation: api.c:ossl_time_max Unexecuted instantiation: internal.c:ossl_time_max Unexecuted instantiation: argon2.c:ossl_time_max Unexecuted instantiation: sleep.c:ossl_time_max Unexecuted instantiation: time.c:ossl_time_max Unexecuted instantiation: thread_posix.c:ossl_time_max Unexecuted instantiation: arch.c:ossl_time_max Unexecuted instantiation: bss_dgram.c:ossl_time_max |
244 | | |
245 | | /* Return the lower of the two given time values. */ |
246 | | static ossl_unused ossl_inline |
247 | | OSSL_TIME |
248 | | ossl_time_min(OSSL_TIME a, OSSL_TIME b) |
249 | 0 | { |
250 | 0 | return a.t < b.t ? a : b; |
251 | 0 | } Unexecuted instantiation: api.c:ossl_time_min Unexecuted instantiation: internal.c:ossl_time_min Unexecuted instantiation: argon2.c:ossl_time_min Unexecuted instantiation: sleep.c:ossl_time_min Unexecuted instantiation: time.c:ossl_time_min Unexecuted instantiation: thread_posix.c:ossl_time_min Unexecuted instantiation: arch.c:ossl_time_min Unexecuted instantiation: bss_dgram.c:ossl_time_min |
252 | | |
253 | | #endif |