Coverage Report

Created: 2026-01-07 06:10

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/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 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: 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
64
65
/* Convert a time to a tick count */
66
static ossl_unused ossl_inline uint64_t ossl_time2ticks(OSSL_TIME t)
67
0
{
68
0
    return t.t;
69
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
70
71
/* Get current time */
72
OSSL_TIME ossl_time_now(void);
73
74
/* The beginning and end of the time range */
75
static ossl_unused ossl_inline OSSL_TIME ossl_time_zero(void)
76
0
{
77
0
    return ossl_ticks2time(0);
78
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
79
80
static ossl_unused ossl_inline OSSL_TIME ossl_time_infinite(void)
81
0
{
82
0
    return ossl_ticks2time(~(uint64_t)0);
83
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
84
85
/* Convert time to timeval */
86
static ossl_unused ossl_inline struct timeval ossl_time_to_timeval(OSSL_TIME t)
87
0
{
88
0
    struct timeval tv;
89
0
    int err = 0;
90
91
    /*
92
     * Round up any nano secs which struct timeval doesn't support. Ensures that
93
     * we never return a zero time if the input time is non zero
94
     */
95
0
    t.t = safe_add_time(t.t, OSSL_TIME_US - 1, &err);
96
0
    if (err)
97
0
        t = ossl_time_infinite();
98
99
#ifdef _WIN32
100
    tv.tv_sec = (long int)(t.t / OSSL_TIME_SECOND);
101
#else
102
0
    tv.tv_sec = (time_t)(t.t / OSSL_TIME_SECOND);
103
0
#endif
104
0
    tv.tv_usec = (t.t % OSSL_TIME_SECOND) / OSSL_TIME_US;
105
0
    return tv;
106
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
107
108
/* Convert timeval to time */
109
static ossl_unused ossl_inline OSSL_TIME ossl_time_from_timeval(struct timeval tv)
110
0
{
111
0
    OSSL_TIME t;
112
113
0
#ifndef __DJGPP__ /* tv_sec is unsigned on djgpp. */
114
0
    if (tv.tv_sec < 0)
115
0
        return ossl_time_zero();
116
0
#endif
117
0
    t.t = tv.tv_sec * OSSL_TIME_SECOND + tv.tv_usec * OSSL_TIME_US;
118
0
    return t;
119
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
120
121
/* Convert OSSL_TIME to time_t */
122
static ossl_unused ossl_inline time_t ossl_time_to_time_t(OSSL_TIME t)
123
0
{
124
0
    return (time_t)(t.t / OSSL_TIME_SECOND);
125
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
126
127
/* Convert time_t to OSSL_TIME */
128
static ossl_unused ossl_inline OSSL_TIME ossl_time_from_time_t(time_t t)
129
0
{
130
0
    OSSL_TIME ot;
131
0
132
0
    ot.t = t;
133
0
    ot.t *= OSSL_TIME_SECOND;
134
0
    return ot;
135
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
136
137
/* Compare two time values, return -1 if less, 1 if greater and 0 if equal */
138
static ossl_unused ossl_inline int ossl_time_compare(OSSL_TIME a, OSSL_TIME b)
139
0
{
140
0
    if (a.t > b.t)
141
0
        return 1;
142
0
    if (a.t < b.t)
143
0
        return -1;
144
0
    return 0;
145
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
146
147
/* Returns true if an OSSL_TIME is ossl_time_zero(). */
148
static ossl_unused ossl_inline int ossl_time_is_zero(OSSL_TIME t)
149
0
{
150
0
    return ossl_time_compare(t, ossl_time_zero()) == 0;
151
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
152
153
/* Returns true if an OSSL_TIME is ossl_time_infinite(). */
154
static ossl_unused ossl_inline int ossl_time_is_infinite(OSSL_TIME t)
155
0
{
156
0
    return ossl_time_compare(t, ossl_time_infinite()) == 0;
157
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
158
159
static ossl_unused ossl_inline OSSL_TIME ossl_time_add(OSSL_TIME a, OSSL_TIME b)
160
0
{
161
0
    OSSL_TIME r;
162
0
    int err = 0;
163
164
0
    r.t = safe_add_time(a.t, b.t, &err);
165
0
    return err ? ossl_time_infinite() : r;
166
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
167
168
static ossl_unused ossl_inline OSSL_TIME ossl_time_subtract(OSSL_TIME a, OSSL_TIME b)
169
0
{
170
0
    OSSL_TIME r;
171
0
    int err = 0;
172
173
0
    r.t = safe_sub_time(a.t, b.t, &err);
174
0
    return err ? ossl_time_zero() : r;
175
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
176
177
/* Returns |a - b|. */
178
static ossl_unused ossl_inline OSSL_TIME ossl_time_abs_difference(OSSL_TIME a, OSSL_TIME b)
179
0
{
180
0
    return a.t > b.t ? ossl_time_subtract(a, b)
181
0
                     : ossl_time_subtract(b, a);
182
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
183
184
static ossl_unused ossl_inline OSSL_TIME ossl_time_multiply(OSSL_TIME a, uint64_t b)
185
0
{
186
0
    OSSL_TIME r;
187
0
    int err = 0;
188
0
189
0
    r.t = safe_mul_time(a.t, b, &err);
190
0
    return err ? ossl_time_infinite() : r;
191
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
192
193
static ossl_unused ossl_inline OSSL_TIME ossl_time_divide(OSSL_TIME a, uint64_t b)
194
0
{
195
0
    OSSL_TIME r;
196
0
    int err = 0;
197
0
198
0
    r.t = safe_div_time(a.t, b, &err);
199
0
    return err ? ossl_time_zero() : r;
200
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
201
202
static ossl_unused ossl_inline OSSL_TIME ossl_time_muldiv(OSSL_TIME a, uint64_t b, uint64_t c)
203
0
{
204
0
    OSSL_TIME r;
205
0
    int err = 0;
206
0
207
0
    r.t = safe_muldiv_time(a.t, b, c, &err);
208
0
    return err ? ossl_time_zero() : r;
209
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
210
211
/* Return higher of the two given time values. */
212
static ossl_unused ossl_inline OSSL_TIME ossl_time_max(OSSL_TIME a, OSSL_TIME b)
213
0
{
214
0
    return a.t > b.t ? a : b;
215
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
216
217
/* Return the lower of the two given time values. */
218
static ossl_unused ossl_inline OSSL_TIME ossl_time_min(OSSL_TIME a, OSSL_TIME b)
219
0
{
220
0
    return a.t < b.t ? a : b;
221
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
222
223
#endif