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