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
|
/*
* (C) Copyright 2025- ECMWF.
*
* This software is licensed under the terms of the Apache Licence Version 2.0
* which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
* In applying this licence, ECMWF does not waive the privileges and immunities
* granted to it by virtue of its status as an intergovernmental organisation nor
* does it submit to any jurisdiction.
*/
#include <pthread.h>
#include <unistd.h>
#include <algorithm>
#include <array>
#include <cstdint>
#include <cstring>
#include <ctime>
#include <type_traits>
#include <vector>
#include "eckit/memory/Padded.h"
#include "eckit/runtime/Main.h"
#include "eckit/runtime/TaskInfo.h"
#include "eckit/testing/Test.h"
namespace eckit::test {
CASE("TaskInfo correctly initializes all members on placement new") {
// Ensure we TaskInfo is a wrapper around Padded<Info, 4096> with no
// additional fields so that we can test Padded<Info, 4096> as proxy of TaskInfo
static_assert(sizeof(Padded<Info, 4096>) == sizeof(TaskInfo));
static_assert(std::is_trivially_copyable_v<Padded<Info, 4096>>);
const auto test_start_time = ::time(nullptr);
auto getTimeOfDayNow = []() {
::timeval t{};
::gettimeofday(&t, nullptr);
return t;
};
const auto test_start_time_of_day = getTimeOfDayNow();
auto timevalCmp = [](const struct timeval& a, const struct timeval& b) {
if (a.tv_sec < b.tv_sec)
return -1;
if (a.tv_sec > b.tv_sec)
return 1;
if (a.tv_usec < b.tv_usec)
return -1;
if (a.tv_usec > b.tv_usec)
return 1;
return 0;
};
alignas(TaskInfo) std::vector<uint8_t> buffer(sizeof(TaskInfo), 0xAF);
// We *could* just reinterpret_cast TaskInfo into Padded<Info, 4096> but this is
// undefined behaviour because Padded<Info, 4096> is not standart layout altough it
// is the same layout. Hence we memcpy
auto sut = new (buffer.data()) TaskInfo();
Padded<Info, 4096> info{};
::memcpy(&info, sut, sizeof(info));
EXPECT_EQUAL(info.busy_, true);
EXPECT_EQUAL(info.thread_, pthread_self());
EXPECT_EQUAL(info.pid_, getpid());
// start is initialized to now on construction, once we reach this line
// we no longer know when this was, so we just chcek for later than test start
// but earler than now.
EXPECT(info.start_ >= test_start_time);
EXPECT(info.start_ <= ::time(nullptr));
// last_ and check_ are initialized to now on construction, once we reach this line
// we no longer know when this was, so we just chcek for later than test start
// but earler than now.
EXPECT(info.last_ >= test_start_time);
EXPECT(info.last_ <= ::time(nullptr));
EXPECT(info.check_ >= test_start_time);
EXPECT(info.check_ <= ::time(nullptr));
EXPECT(info.show_);
EXPECT_EQUAL(info.late_, 0);
EXPECT(std::all_of(info.buffer_, info.buffer_ + Info::size_, [](auto v) { return v == 0x00; }));
EXPECT_EQUAL(info.pos_, 0);
std::array<char, 80> expected_name{};
::strncpy(expected_name.begin(), Main::instance().displayName().c_str(), expected_name.size() - 1);
EXPECT_EQUAL(::memcmp(info.name_, expected_name.begin(), expected_name.size()), 0);
std::array<char, 80> expected_kind{};
::strncpy(expected_kind.begin(), Main::instance().name().c_str(), expected_kind.size() - 1);
EXPECT_EQUAL(::memcmp(info.kind_, expected_kind.begin(), expected_kind.size()), 0);
std::array<char, 256> expected_status{};
::strncpy(expected_status.begin(), "Starting", expected_status.size() - 1);
EXPECT_EQUAL(::memcmp(info.status_, expected_status.begin(), expected_status.size()), 0);
std::array<char, 80> expected_application{};
::strncpy(expected_application.begin(), Main::instance().name().c_str(), expected_application.size() - 1);
EXPECT_EQUAL(::memcmp(info.application_, expected_application.begin(), expected_application.size()), 0);
EXPECT_EQUAL(info.progress_.min_, 0);
EXPECT_EQUAL(info.progress_.max_, 0);
EXPECT_EQUAL(info.progress_.val_, 0);
EXPECT(std::all_of(info.progress_.name_, info.progress_.name_ + sizeof(info.progress_.name_),
[](auto v) { return v == 0x00; }));
EXPECT_EQUAL(info.progress_.rate_, 0);
EXPECT_EQUAL(info.progress_.speed_, 0);
// progress_.start and progress_.last_ are initialized to time of day now
// on construction, once we reach this line we no longer know when this
// was, so we just chcek for later than test start but earler than now.
EXPECT(timevalCmp(info.progress_.start_, test_start_time_of_day) >= 0);
EXPECT(timevalCmp(info.progress_.start_, getTimeOfDayNow()) <= 0);
EXPECT(timevalCmp(info.progress_.last_, test_start_time_of_day) >= 0);
EXPECT(timevalCmp(info.progress_.last_, getTimeOfDayNow()) <= 0);
EXPECT_EQUAL(info.taskID_, 0);
EXPECT_EQUAL(info.stop_, false);
EXPECT_EQUAL(info.abort_, false);
EXPECT_EQUAL(info.stoppable_, true);
EXPECT_EQUAL(info.stopped_, false);
EXPECT_EQUAL(info.canceled_, false);
EXPECT_EQUAL(info.exception_, false);
EXPECT(std::all_of(info.cancelMsg_, info.cancelMsg_ + sizeof(info.cancelMsg_), [](auto v) { return v == 0x00; }));
EXPECT_EQUAL(info.config_, 0);
EXPECT_EQUAL(info.resource_, 0);
EXPECT_EQUAL(info.parent_, -1);
EXPECT_EQUAL(info.depth_, 0);
EXPECT_EQUAL(info.state_, ' ');
EXPECT_EQUAL(info.port_, 0);
EXPECT(std::all_of(info.host_, info.host_ + sizeof(info.host_), [](auto v) { return v == 0x00; }));
EXPECT(std::all_of(info.message_, info.message_ + sizeof(info.message_), [](auto v) { return v == 0x00; }));
}
CASE("Info struct binary compatibility") {
// The Info struct is persisted to disk via MappedArray and SharedMemArray.
// Processes read each other's monitor files by memory-mapping them and
// interpreting raw bytes as Info. If the struct layout changes (field sizes,
// offsets, or total size), existing files written by older binaries become
// unreadable or silently corrupt. These tests ensure that any layout-breaking
// change is caught immediately.
Info info{};
// Struct sizes
EXPECT_EQUAL(sizeof(Info), 11248u);
EXPECT_EQUAL(sizeof(Info::Progress), 152u);
EXPECT_EQUAL(sizeof(TaskInfo), 12288u);
EXPECT_EQUAL(sizeof(Padded<Info, 4096>), 12288u);
// Circular log buffer constant
EXPECT_EQUAL(Info::size_, 10240);
// Individual field sizes
EXPECT_EQUAL(sizeof(info.busy_), 1u);
EXPECT_EQUAL(sizeof(info.thread_), 8u);
EXPECT_EQUAL(sizeof(info.pid_), 4u);
EXPECT_EQUAL(sizeof(info.start_), 8u);
EXPECT_EQUAL(sizeof(info.last_), 8u);
EXPECT_EQUAL(sizeof(info.check_), 8u);
EXPECT_EQUAL(sizeof(info.show_), 1u);
EXPECT_EQUAL(sizeof(info.late_), 8u);
EXPECT_EQUAL(sizeof(info.buffer_), 10240u);
EXPECT_EQUAL(sizeof(info.pos_), 8u);
EXPECT_EQUAL(sizeof(info.name_), 80u);
EXPECT_EQUAL(sizeof(info.kind_), 80u);
EXPECT_EQUAL(sizeof(info.status_), 256u);
EXPECT_EQUAL(sizeof(info.application_), 80u);
EXPECT_EQUAL(sizeof(info.progress_), 152u);
EXPECT_EQUAL(sizeof(info.progress_.name_), 80u);
EXPECT_EQUAL(sizeof(info.taskID_), 8u);
EXPECT_EQUAL(sizeof(info.cancelMsg_), 80u);
EXPECT_EQUAL(sizeof(info.host_), 80u);
EXPECT_EQUAL(sizeof(info.message_), 80u);
EXPECT_EQUAL(sizeof(info.stop_), 1u);
EXPECT_EQUAL(sizeof(info.abort_), 1u);
EXPECT_EQUAL(sizeof(info.stoppable_), 1u);
EXPECT_EQUAL(sizeof(info.stopped_), 1u);
EXPECT_EQUAL(sizeof(info.canceled_), 1u);
EXPECT_EQUAL(sizeof(info.exception_), 1u);
EXPECT_EQUAL(sizeof(info.config_), 4u);
EXPECT_EQUAL(sizeof(info.resource_), 1u);
EXPECT_EQUAL(sizeof(info.parent_), 8u);
EXPECT_EQUAL(sizeof(info.depth_), 8u);
EXPECT_EQUAL(sizeof(info.state_), 1u);
EXPECT_EQUAL(sizeof(info.port_), 4u);
// Type traits
EXPECT(std::is_standard_layout_v<Info>);
EXPECT(std::is_trivially_copyable_v<Info>);
}
} // namespace eckit::test
int main(int argc, char** argv) {
return eckit::testing::run_tests(argc, argv);
}
|
