/src/openssl/include/internal/time.h

Source (jump to first uncovered line)
/*
 * Copyright 2022-2023 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#ifndef OSSL_INTERNAL_TIME_H
# define OSSL_INTERNAL_TIME_H
# pragma once

# include <openssl/e_os2.h>     /* uint64_t */
# include "internal/e_os.h"
# include "internal/e_winsock.h" /* for struct timeval */
# include "internal/safe_math.h"

/*
 * Internal type defining a time.
 * This should be treated as an opaque structure.
 *
 * The time datum is Unix's 1970 and at nanosecond precision, this gives
 * a range of 584 years roughly.
 */
typedef struct {
    uint64_t t;     /* Ticks since the epoch */
} OSSL_TIME;

/* The precision of times allows this many values per second */
# define OSSL_TIME_SECOND ((uint64_t)1000000000)

/* One millisecond. */
# define OSSL_TIME_MS     (OSSL_TIME_SECOND / 1000)

/* One microsecond. */
# define OSSL_TIME_US     (OSSL_TIME_MS     / 1000)

/* One nanosecond. */
# define OSSL_TIME_NS     (OSSL_TIME_US     / 1000)

#define ossl_seconds2time(s) ossl_ticks2time((s) * OSSL_TIME_SECOND)
#define ossl_time2seconds(t) (ossl_time2ticks(t) / OSSL_TIME_SECOND)
#define ossl_ms2time(ms) ossl_ticks2time((ms) * OSSL_TIME_MS)
#define ossl_time2ms(t) (ossl_time2ticks(t) / OSSL_TIME_MS)
#define ossl_us2time(us) ossl_ticks2time((us) * OSSL_TIME_US)
#define ossl_time2us(t) (ossl_time2ticks(t) / OSSL_TIME_US)

/*
 * Arithmetic operations on times.
 * These operations are saturating, in that an overflow or underflow returns
 * the largest or smallest value respectively.
 */
OSSL_SAFE_MATH_UNSIGNED(time, uint64_t)

/* Convert a tick count into a time */
static ossl_unused ossl_inline
OSSL_TIME ossl_ticks2time(uint64_t ticks)
{
    OSSL_TIME r;

    r.t = ticks;
    return r;
}

/* Convert a time to a tick count */
static ossl_unused ossl_inline
uint64_t ossl_time2ticks(OSSL_TIME t)
{
    return t.t;
}

/* Get current time */
OSSL_TIME ossl_time_now(void);

/* The beginning and end of the time range */
static ossl_unused ossl_inline
OSSL_TIME ossl_time_zero(void)
{
    return ossl_ticks2time(0);
}

static ossl_unused ossl_inline
OSSL_TIME ossl_time_infinite(void)
{
    return ossl_ticks2time(~(uint64_t)0);
}


/* Convert time to timeval */
static ossl_unused ossl_inline
struct timeval ossl_time_to_timeval(OSSL_TIME t)
{
    struct timeval tv;
    int err = 0;

    /*
     * Round up any nano secs which struct timeval doesn't support. Ensures that
     * we never return a zero time if the input time is non zero
     */
    t.t = safe_add_time(t.t, OSSL_TIME_US - 1, &err);
    if (err)
        t = ossl_time_infinite();

#ifdef _WIN32
    tv.tv_sec = (long int)(t.t / OSSL_TIME_SECOND);
#else
    tv.tv_sec = (time_t)(t.t / OSSL_TIME_SECOND);
#endif
    tv.tv_usec = (t.t % OSSL_TIME_SECOND) / OSSL_TIME_US;
    return tv;
}

/* Convert timeval to time */
static ossl_unused ossl_inline
OSSL_TIME ossl_time_from_timeval(struct timeval tv)
{
    OSSL_TIME t;

#ifndef __DJGPP__ /* tv_sec is unsigned on djgpp. */
    if (tv.tv_sec < 0)
        return ossl_time_zero();
#endif
    t.t = tv.tv_sec * OSSL_TIME_SECOND + tv.tv_usec * OSSL_TIME_US;
    return t;
}

/* Convert OSSL_TIME to time_t */
static ossl_unused ossl_inline
time_t ossl_time_to_time_t(OSSL_TIME t)
{
    return (time_t)(t.t / OSSL_TIME_SECOND);
}

/* Convert time_t to OSSL_TIME */
static ossl_unused ossl_inline
OSSL_TIME ossl_time_from_time_t(time_t t)
{
    OSSL_TIME ot;

    ot.t = t;
    ot.t *= OSSL_TIME_SECOND;
    return ot;
}

/* Compare two time values, return -1 if less, 1 if greater and 0 if equal */
static ossl_unused ossl_inline
int ossl_time_compare(OSSL_TIME a, OSSL_TIME b)
{
    if (a.t > b.t)
        return 1;
    if (a.t < b.t)
        return -1;
    return 0;
}

/* Returns true if an OSSL_TIME is ossl_time_zero(). */
static ossl_unused ossl_inline
int ossl_time_is_zero(OSSL_TIME t)
{
    return ossl_time_compare(t, ossl_time_zero()) == 0;
}

/* Returns true if an OSSL_TIME is ossl_time_infinite(). */
static ossl_unused ossl_inline
int ossl_time_is_infinite(OSSL_TIME t)
{
    return ossl_time_compare(t, ossl_time_infinite()) == 0;
}

static ossl_unused ossl_inline
OSSL_TIME ossl_time_add(OSSL_TIME a, OSSL_TIME b)
{
    OSSL_TIME r;
    int err = 0;

    r.t = safe_add_time(a.t, b.t, &err);
    return err ? ossl_time_infinite() : r;
}

static ossl_unused ossl_inline
OSSL_TIME ossl_time_subtract(OSSL_TIME a, OSSL_TIME b)
{
    OSSL_TIME r;
    int err = 0;

    r.t = safe_sub_time(a.t, b.t, &err);
    return err ? ossl_time_zero() : r;
}

/* Returns |a - b|. */
static ossl_unused ossl_inline
OSSL_TIME ossl_time_abs_difference(OSSL_TIME a, OSSL_TIME b)
{
    return a.t > b.t ? ossl_time_subtract(a, b)
                     : ossl_time_subtract(b, a);
}

static ossl_unused ossl_inline
OSSL_TIME ossl_time_multiply(OSSL_TIME a, uint64_t b)
{
    OSSL_TIME r;
    int err = 0;

    r.t = safe_mul_time(a.t, b, &err);
    return err ? ossl_time_infinite() : r;
}

static ossl_unused ossl_inline
OSSL_TIME ossl_time_divide(OSSL_TIME a, uint64_t b)
{
    OSSL_TIME r;
    int err = 0;

    r.t = safe_div_time(a.t, b, &err);
    return err ? ossl_time_zero() : r;
}

static ossl_unused ossl_inline
OSSL_TIME ossl_time_muldiv(OSSL_TIME a, uint64_t b, uint64_t c)
{
    OSSL_TIME r;
    int err = 0;

    r.t = safe_muldiv_time(a.t, b, c, &err);
    return err ? ossl_time_zero() : r;
}

/* Return higher of the two given time values. */
static ossl_unused ossl_inline
OSSL_TIME ossl_time_max(OSSL_TIME a, OSSL_TIME b)
{
    return a.t > b.t ? a : b;
}

/* Return the lower of the two given time values. */
static ossl_unused ossl_inline
OSSL_TIME ossl_time_min(OSSL_TIME a, OSSL_TIME b)
{
    return a.t < b.t ? a : b;
}

#endif

Coverage Report

Created: 2024-11-21 07:03

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