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
|
/*
* Copyright (C) 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <chrono>
#include <mutex>
#include <string>
#include <vector>
#include <gtest/gtest.h>
#include "LogBuffer.h"
#include "LogReaderList.h"
#include "LogStatistics.h"
#include "LogTags.h"
#include "PruneList.h"
#include "SerializedLogBuffer.h"
#include "SimpleLogBuffer.h"
using namespace std::chrono_literals;
struct LogMessage {
logger_entry entry;
std::string message;
bool regex_compare = false; // Only set for expected messages, when true 'message' should be
// interpretted as a regex.
};
// Compares the ordered list of expected and result, causing a test failure with appropriate
// information on failure.
void CompareLogMessages(const std::vector<LogMessage>& expected,
const std::vector<LogMessage>& result);
// Sets hdr_size and len parameters appropriately.
void FixupMessages(std::vector<LogMessage>* messages);
class TestWriter : public LogWriter {
public:
TestWriter(std::vector<LogMessage>* msgs, std::mutex* mutex, bool* released)
: LogWriter(0, true), mutex_(mutex ?: &logd_lock), msgs_(msgs), released_(released) {}
bool Write(const logger_entry& entry, const char* message) override {
auto lock = std::lock_guard{*mutex_};
msgs_->emplace_back(LogMessage{entry, std::string(message, entry.len), false});
return true;
}
void Release() {
if (released_) *released_ = true;
}
std::string name() const override { return "test_writer"; }
private:
std::mutex* mutex_;
std::vector<LogMessage>* msgs_;
bool* released_;
};
class LogBufferTest : public testing::TestWithParam<std::string> {
protected:
void SetUp() override {
if (GetParam() == "serialized") {
log_buffer_.reset(new SerializedLogBuffer(&reader_list_, &tags_, &stats_));
} else if (GetParam() == "simple") {
log_buffer_.reset(new SimpleLogBuffer(&reader_list_, &tags_, &stats_));
} else {
FAIL() << "Unknown buffer type selected for test";
}
log_id_for_each(i) { log_buffer_->SetSize(i, 1024 * 1024); }
}
void LogMessages(const std::vector<LogMessage>& messages) {
for (auto& [entry, message, _] : messages) {
EXPECT_GT(log_buffer_->Log(static_cast<log_id_t>(entry.lid),
log_time(entry.sec, entry.nsec), entry.uid, entry.pid,
entry.tid, message.c_str(), message.size()),
0);
}
}
struct FlushMessagesResult {
std::vector<LogMessage> messages;
uint64_t next_sequence;
};
FlushMessagesResult FlushMessages(std::mutex* mutex = nullptr) {
std::vector<LogMessage> read_log_messages;
std::unique_ptr<LogWriter> test_writer(new TestWriter(&read_log_messages, mutex, nullptr));
auto lock = std::lock_guard{logd_lock};
auto flush_to_state = log_buffer_->CreateFlushToState(1, kLogMaskAll);
EXPECT_TRUE(log_buffer_->FlushTo(test_writer.get(), *flush_to_state, nullptr));
return {read_log_messages, flush_to_state->start()};
}
struct ReaderThreadParams {
bool non_block = true;
unsigned long tail = 0;
LogMask log_mask = kLogMaskAll;
pid_t pid = 0;
log_time start_time = {};
uint64_t sequence = 1;
std::chrono::steady_clock::time_point deadline = {};
};
class TestReaderThread {
public:
TestReaderThread(const ReaderThreadParams& params, LogBufferTest& test) : test_(test) {
auto lock = std::lock_guard{mutex_};
std::unique_ptr<LogWriter> test_writer(
new TestWriter(&read_log_messages_, &mutex_, &released_));
std::unique_ptr<LogReaderThread> log_reader(new LogReaderThread(
test_.log_buffer_.get(), &test_.reader_list_, std::move(test_writer),
params.non_block, params.tail, params.log_mask, params.pid, params.start_time,
params.sequence, params.deadline));
test_.reader_list_.AddAndRunThread(std::move(log_reader));
}
void WaitUntilReleased() {
while (!released_) {
usleep(5000);
}
}
std::vector<LogMessage> WaitForMessages(size_t n) {
int retry_count = 1s / 5000us;
while (retry_count--) {
usleep(5000);
auto lock = std::lock_guard{mutex_};
if (read_log_messages_.size() == n) {
return read_log_messages_;
}
}
return {};
}
std::vector<LogMessage> read_log_messages() {
auto lock = std::lock_guard{mutex_};
return read_log_messages_;
}
private:
LogBufferTest& test_;
std::mutex mutex_;
std::vector<LogMessage> read_log_messages_;
bool released_ = false;
};
std::vector<LogMessage> ReadLogMessagesNonBlockingThread(const ReaderThreadParams& params) {
EXPECT_TRUE(params.non_block)
<< "params.non_block must be true for ReadLogMessagesNonBlockingThread()";
auto reader = TestReaderThread(params, *this);
reader.WaitUntilReleased();
auto lock = std::lock_guard{logd_lock};
EXPECT_EQ(0U, reader_list_.running_reader_threads().size());
return reader.read_log_messages();
}
void ReleaseAndJoinReaders() {
{
auto lock = std::lock_guard{logd_lock};
for (auto& reader : reader_list_.running_reader_threads()) {
reader->Release();
}
}
auto retries = 1s / 5000us;
while (retries--) {
usleep(5000);
auto lock = std::lock_guard{logd_lock};
if (reader_list_.running_reader_threads().size() == 0) {
return;
}
}
FAIL() << "ReleaseAndJoinReaders() timed out with reader threads still running";
}
LogReaderList reader_list_;
LogTags tags_;
PruneList prune_;
LogStatistics stats_{false, true};
std::unique_ptr<LogBuffer> log_buffer_;
};
|
