/
tm.h
142 lines (112 loc) · 5.78 KB
/
tm.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
*******************************************************************************
\file tm.h
\brief Time and timers
\project bee2 [cryptographic library]
\author (C) Sergey Agievich [agievich@{bsu.by|gmail.com}]
\created 2014.10.13
\version 2015.11.25
\license This program is released under the GNU General Public License
version 3. See Copyright Notices in bee2/info.h.
*******************************************************************************
*/
/*!
*******************************************************************************
\file tm.h
\brief Время и таймеры
*******************************************************************************
*/
#ifndef __BEE2_TM_H
#define __BEE2_TM_H
#include <time.h>
#include "bee2/defs.h"
#ifdef __cplusplus
extern "C" {
#endif
/*!
*******************************************************************************
\file tm.h
\section tm-timer Таймер
Функции tmFreq(), tmTicks() отвечают за работу с наиболее точным таймером
среди доступных. Показания выдаются в виде значения типа tm_ticks_t.
Наиболее точным таймером на платформах x86, x64 является регистр RDTSC,
который обновляется с частотой процессора.
Таймер определяется в следующей очередности (до первого найденного):
-- на платформах x86, x64 использовать регистр RDTSC;
-- в среде Windows использовать функции QueryPerformance[Counter|Frequency]();
-- в среде Unix использовать функции clock_get[time|res]();
-- использовать функцию clock() и константу CLOCK_PER_SEC (см. time.h).
\typedef tm_ticks_t
\brief Число тактов таймера
*******************************************************************************
*/
#ifndef U64_SUPPORT
typedef u32 tm_ticks_t;
#else
typedef u64 tm_ticks_t;
#endif
/*! \brief Показания таймера
Возвращается число тактов, выполненных наиболее точным из доступных
таймеров. Таймер начинает работу до первого вызова функции. Показания
таймера монотонно увеличиваются вплоть до переполнения счетчика тактов.
\return Число тактов или 0 в случае ошибки.
*/
tm_ticks_t tmTicks();
/*! \brief Частота таймера
Возвращается число тактов, которое выполняет в секунду наиболее точный из
доступных таймеров.
\warning Замер частоты может занять время (в пределах 0.1 секунды).
\return Число тактов в секунду или 0 в случае ошибки.
*/
tm_ticks_t tmFreq();
/*! \brief Скорость
По числу reps экспериментов за ticks тактов определяется число
экспериментов, которое можно выполнить за 1 секунду.
\warning Расчеты ведутся в dword. Может быть потеря точности, связанная
с переполнением.
\return Число экспериментов в секунду или SIZE_MAX в случае ошибки.
*/
size_t tmSpeed(
size_t reps, /*!< [in] число экспериментов */
tm_ticks_t ticks /*!< [in] число тактов */
);
/*!
*******************************************************************************
\file tm.h
\section tm-time Время
Системное время задается числом секунд, прошедших с полуночи
01 января 1970 года (1970-01-01T00:00:00Z в формате ISO 8601).
Использованную шкалу времени прнято называть UNIX-время.
Начало отсчета -- старт "эры UNIX" (Unix Epoch).
Отметка времени представляется типом tm_time_t. Этот тип повторяет системный
тип time_t и наследует его неопределенность по разрядности и знаковости.
\warning 10 января 2004 счетчик секунд принял значение 2^30.
32-битовый счетчик исчерпает себя 19 января 2038 года.
*******************************************************************************
*/
/*! \brief Время */
typedef time_t tm_time_t;
#define TIME_0 ((tm_time_t)0)
#define TIME_1 ((tm_time_t)1)
#define TIME_ERR ((tm_time_t)(TIME_0 - TIME_1))
/*! \brief UNIX-время
Возвращается число секунд, прошедших с момента 1970-01-01T00:00:00Z.
\return Число секунд или TIME_ERR в случае ошибки.
*/
tm_time_t tmTime();
/*! \brief Округленное UNIX-время
Возвращается округленное UNIX-время (tmTime() - t0) / ts,
где t0 --- базовая отметка времени (начало отсчета), ts -- шаг времени.
\return Округленное UNIX-время или TIME_ERR в случае ошибки.
\remark Ошибками считаются следующие ситуации:
ts == 0, tmTime() < t0.
\remark Процедура округления соответствует RFC 6238.
*/
tm_time_t tmTimeRound(
tm_time_t t0, /*!< [in] начало отсчета */
tm_time_t ts /*!< [in] шаг времени */
);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* __BEE2_TM_H */