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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/*
* Testing operating system specific wrapper code
* (C) 2017 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
#include "tests.h"
#include <botan/internal/os_utils.h>
// For __ud2 intrinsic
#if defined(BOTAN_TARGET_COMPILER_IS_MSVC)
#include <intrin.h>
#endif
namespace Botan_Tests {
namespace {
/*
uint32_t get_process_id();
uint64_t get_cpu_cycle_counter();
uint64_t get_system_timestamp_ns();
size_t get_memory_locking_limit();
void* allocate_locked_pages(size_t length);
void free_locked_pages(void* ptr, size_t length);
int run_cpu_instruction_probe(std::function<int ()> probe_fn);
*/
class OS_Utils_Tests final : public Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<Test::Result> results;
results.push_back(test_get_process_id());
results.push_back(test_get_cpu_cycle_counter());
results.push_back(test_get_high_resolution_clock());
results.push_back(test_get_cpu_numbers());
results.push_back(test_get_system_timestamp());
results.push_back(test_memory_locking());
results.push_back(test_cpu_instruction_probe());
return results;
}
private:
Test::Result test_get_process_id()
{
Test::Result result("OS::get_process_id");
uint32_t pid1 = Botan::OS::get_process_id();
uint32_t pid2 = Botan::OS::get_process_id();
result.test_eq("PID same across calls", static_cast<size_t>(pid1), static_cast<size_t>(pid2));
#if defined(BOTAN_TARGET_OS_IS_INCLUDEOS) || defined(BOTAN_TARGET_OS_IS_LLVM)
result.test_eq("PID is expected to be zero on this platform", pid1, size_t(0));
#else
result.test_ne("PID is non-zero on systems with processes", pid1, 0);
#endif
return result;
}
Test::Result test_get_cpu_cycle_counter()
{
const size_t max_trials = 1024;
const size_t max_repeats = 32;
Test::Result result("OS::get_cpu_cycle_counter");
const uint64_t proc_ts1 = Botan::OS::get_cpu_cycle_counter();
if(proc_ts1 == 0)
{
const uint64_t proc_ts2 = Botan::OS::get_cpu_cycle_counter();
result.test_is_eq("Disabled processor timestamp stays at zero", proc_ts1, proc_ts2);
return result;
}
size_t counts = 0;
while(counts < max_trials && (Botan::OS::get_cpu_cycle_counter() == proc_ts1))
++counts;
result.test_lt("CPU cycle counter eventually changes value", counts, max_repeats);
return result;
}
Test::Result test_get_high_resolution_clock()
{
const size_t max_trials = 1024;
const size_t max_repeats = 128;
Test::Result result("OS::get_high_resolution_clock");
// TODO better tests
const uint64_t hr_ts1 = Botan::OS::get_high_resolution_clock();
result.test_ne("high resolution timestamp value is never zero", hr_ts1, 0);
size_t counts = 0;
while(counts < max_trials && (Botan::OS::get_high_resolution_clock() == hr_ts1))
++counts;
result.test_lt("high resolution clock eventually changes value", counts, max_repeats);
return result;
}
Test::Result test_get_cpu_numbers()
{
Test::Result result("OS::get_cpu_total/OS::get_cpu_available");
size_t tt = Botan::OS::get_cpu_total();
size_t ta = Botan::OS::get_cpu_available();
result.test_lte("get_cpu_available not greater than total", ta, tt);
return result;
}
Test::Result test_get_system_timestamp()
{
// TODO better tests
Test::Result result("OS::get_system_timestamp_ns");
uint64_t sys_ts1 = Botan::OS::get_system_timestamp_ns();
result.test_ne("System timestamp value is never zero", sys_ts1, 0);
// do something that consumes a little time
Botan::OS::get_process_id();
uint64_t sys_ts2 = Botan::OS::get_system_timestamp_ns();
result.confirm("System time moves forward", sys_ts1 <= sys_ts2);
return result;
}
Test::Result test_memory_locking()
{
Test::Result result("OS memory locked pages");
// TODO any tests...
return result;
}
Test::Result test_cpu_instruction_probe()
{
Test::Result result("OS::run_cpu_instruction_probe");
// OS::run_cpu_instruction_probe only implemented for Unix signals or Windows SEH
std::function<int ()> ok_fn = []() -> int { return 5; };
const int run_rc = Botan::OS::run_cpu_instruction_probe(ok_fn);
if(run_rc == -3)
{
result.test_note("run_cpu_instruction_probe not implemented on this platform");
return {result};
}
result.confirm("Correct result returned by working probe fn", run_rc == 5);
std::function<int ()> crash_probe;
#if defined(BOTAN_TARGET_COMPILER_IS_MSVC)
crash_probe = []() -> int { __ud2(); return 3; };
#elif defined(BOTAN_USE_GCC_INLINE_ASM)
#if defined(BOTAN_TARGET_CPU_IS_X86_FAMILY)
crash_probe = []() -> int { asm volatile("ud2"); return 3; };
#elif defined(BOTAN_TARGET_CPU_IS_ARM_FAMILY)
//ARM: asm volatile (".word 0xf7f0a000\n");
// illegal instruction in both ARM and Thumb modes
crash_probe = []() -> int { asm volatile(".word 0xe7f0def0\n"); return 3; };
#else
/*
PPC: "The instruction with primary opcode 0, when the instruction does not consist
entirely of binary zeros"
Others ?
*/
#endif
#endif
if(crash_probe)
{
const int crash_rc = Botan::OS::run_cpu_instruction_probe(crash_probe);
result.confirm("Result for function executing undefined opcode", crash_rc < 0);
}
return result;
}
};
BOTAN_REGISTER_TEST("os_utils", OS_Utils_Tests);
}
}
|
