blob: 58e7c3049d9d76ea18fe7a5bd30c3732317ef650 [file] [log] [blame]
Austin Schuha36c8902019-12-30 18:07:15 -08001#include "aos/events/logging/logfile_utils.h"
2
3#include <fcntl.h>
Austin Schuha36c8902019-12-30 18:07:15 -08004#include <sys/stat.h>
5#include <sys/types.h>
6#include <sys/uio.h>
7
Brian Silvermanf51499a2020-09-21 12:49:08 -07008#include <algorithm>
9#include <climits>
Austin Schuha36c8902019-12-30 18:07:15 -080010
Austin Schuhe4fca832020-03-07 16:58:53 -080011#include "absl/strings/escaping.h"
Austin Schuh05b70472020-01-01 17:11:17 -080012#include "aos/configuration.h"
Austin Schuhfa895892020-01-07 20:07:41 -080013#include "aos/flatbuffer_merge.h"
Austin Schuh6f3babe2020-01-26 20:34:50 -080014#include "aos/util/file.h"
Austin Schuha36c8902019-12-30 18:07:15 -080015#include "flatbuffers/flatbuffers.h"
Austin Schuh05b70472020-01-01 17:11:17 -080016#include "gflags/gflags.h"
17#include "glog/logging.h"
Austin Schuha36c8902019-12-30 18:07:15 -080018
Brian Silvermanf59fe3f2020-09-22 21:04:09 -070019#if defined(__x86_64__)
20#define ENABLE_LZMA 1
21#elif defined(__aarch64__)
22#define ENABLE_LZMA 1
23#else
24#define ENABLE_LZMA 0
25#endif
26
27#if ENABLE_LZMA
28#include "aos/events/logging/lzma_encoder.h"
29#endif
30
Austin Schuh7fbf5a72020-09-21 16:28:13 -070031DEFINE_int32(flush_size, 128000,
Austin Schuha36c8902019-12-30 18:07:15 -080032 "Number of outstanding bytes to allow before flushing to disk.");
33
Brian Silvermanf51499a2020-09-21 12:49:08 -070034namespace aos::logger {
Austin Schuha36c8902019-12-30 18:07:15 -080035
Austin Schuh05b70472020-01-01 17:11:17 -080036namespace chrono = std::chrono;
37
Brian Silvermanf51499a2020-09-21 12:49:08 -070038DetachedBufferWriter::DetachedBufferWriter(
39 std::string_view filename, std::unique_ptr<DetachedBufferEncoder> encoder)
40 : filename_(filename), encoder_(std::move(encoder)) {
Brian Silvermana9f2ec92020-10-06 18:00:53 -070041 if (!util::MkdirPIfSpace(filename, 0777)) {
42 ran_out_of_space_ = true;
43 } else {
44 fd_ = open(std::string(filename).c_str(),
45 O_RDWR | O_CLOEXEC | O_CREAT | O_EXCL, 0774);
46 if (fd_ == -1 && errno == ENOSPC) {
47 ran_out_of_space_ = true;
48 } else {
49 PCHECK(fd_ != -1) << ": Failed to open " << filename << " for writing";
50 VLOG(1) << "Opened " << filename << " for writing";
51 }
52 }
Austin Schuha36c8902019-12-30 18:07:15 -080053}
54
55DetachedBufferWriter::~DetachedBufferWriter() {
Brian Silverman0465fcf2020-09-24 00:29:18 -070056 Close();
57 if (ran_out_of_space_) {
58 CHECK(acknowledge_ran_out_of_space_)
59 << ": Unacknowledged out of disk space, log file was not completed";
Brian Silvermanf51499a2020-09-21 12:49:08 -070060 }
Austin Schuh2f8fd752020-09-01 22:38:28 -070061}
62
Brian Silvermand90905f2020-09-23 14:42:56 -070063DetachedBufferWriter::DetachedBufferWriter(DetachedBufferWriter &&other) {
Austin Schuh2f8fd752020-09-01 22:38:28 -070064 *this = std::move(other);
65}
66
Brian Silverman87ac0402020-09-17 14:47:01 -070067// When other is destroyed "soon" (which it should be because we're getting an
68// rvalue reference to it), it will flush etc all the data we have queued up
69// (because that data will then be its data).
Austin Schuh2f8fd752020-09-01 22:38:28 -070070DetachedBufferWriter &DetachedBufferWriter::operator=(
71 DetachedBufferWriter &&other) {
Austin Schuh2f8fd752020-09-01 22:38:28 -070072 std::swap(filename_, other.filename_);
Brian Silvermanf51499a2020-09-21 12:49:08 -070073 std::swap(encoder_, other.encoder_);
Austin Schuh2f8fd752020-09-01 22:38:28 -070074 std::swap(fd_, other.fd_);
Brian Silverman0465fcf2020-09-24 00:29:18 -070075 std::swap(ran_out_of_space_, other.ran_out_of_space_);
76 std::swap(acknowledge_ran_out_of_space_, other.acknowledge_ran_out_of_space_);
Austin Schuh2f8fd752020-09-01 22:38:28 -070077 std::swap(iovec_, other.iovec_);
Brian Silvermanf51499a2020-09-21 12:49:08 -070078 std::swap(max_write_time_, other.max_write_time_);
79 std::swap(max_write_time_bytes_, other.max_write_time_bytes_);
80 std::swap(max_write_time_messages_, other.max_write_time_messages_);
81 std::swap(total_write_time_, other.total_write_time_);
82 std::swap(total_write_count_, other.total_write_count_);
83 std::swap(total_write_messages_, other.total_write_messages_);
84 std::swap(total_write_bytes_, other.total_write_bytes_);
Austin Schuh2f8fd752020-09-01 22:38:28 -070085 return *this;
Austin Schuha36c8902019-12-30 18:07:15 -080086}
87
Brian Silvermanf51499a2020-09-21 12:49:08 -070088void DetachedBufferWriter::QueueSpan(absl::Span<const uint8_t> span) {
Brian Silvermana9f2ec92020-10-06 18:00:53 -070089 if (ran_out_of_space_) {
90 // We don't want any later data to be written after space becomes
91 // available, so refuse to write anything more once we've dropped data
92 // because we ran out of space.
93 VLOG(1) << "Ignoring span: " << span.size();
94 return;
95 }
96
Brian Silvermanf51499a2020-09-21 12:49:08 -070097 if (encoder_->may_bypass() && span.size() > 4096u) {
98 // Over this threshold, we'll assume it's cheaper to add an extra
99 // syscall to write the data immediately instead of copying it to
100 // enqueue.
Austin Schuha36c8902019-12-30 18:07:15 -0800101
Brian Silvermanf51499a2020-09-21 12:49:08 -0700102 // First, flush everything.
103 while (encoder_->queue_size() > 0u) {
104 Flush();
105 }
Austin Schuhde031b72020-01-10 19:34:41 -0800106
Brian Silvermanf51499a2020-09-21 12:49:08 -0700107 // Then, write it directly.
108 const auto start = aos::monotonic_clock::now();
109 const ssize_t written = write(fd_, span.data(), span.size());
110 const auto end = aos::monotonic_clock::now();
Brian Silverman0465fcf2020-09-24 00:29:18 -0700111 HandleWriteReturn(written, span.size());
Brian Silvermanf51499a2020-09-21 12:49:08 -0700112 UpdateStatsForWrite(end - start, written, 1);
113 } else {
114 encoder_->Encode(CopySpanAsDetachedBuffer(span));
Austin Schuha36c8902019-12-30 18:07:15 -0800115 }
Brian Silvermanf51499a2020-09-21 12:49:08 -0700116
117 FlushAtThreshold();
Austin Schuha36c8902019-12-30 18:07:15 -0800118}
119
Brian Silverman0465fcf2020-09-24 00:29:18 -0700120void DetachedBufferWriter::Close() {
121 if (fd_ == -1) {
122 return;
123 }
124 encoder_->Finish();
125 while (encoder_->queue_size() > 0) {
126 Flush();
127 }
128 if (close(fd_) == -1) {
129 if (errno == ENOSPC) {
130 ran_out_of_space_ = true;
131 } else {
132 PLOG(ERROR) << "Closing log file failed";
133 }
134 }
135 fd_ = -1;
136 VLOG(1) << "Closed " << filename_;
137}
138
Austin Schuha36c8902019-12-30 18:07:15 -0800139void DetachedBufferWriter::Flush() {
Brian Silvermanf51499a2020-09-21 12:49:08 -0700140 const auto queue = encoder_->queue();
141 if (queue.empty()) {
Austin Schuha36c8902019-12-30 18:07:15 -0800142 return;
143 }
Brian Silverman0465fcf2020-09-24 00:29:18 -0700144 if (ran_out_of_space_) {
145 // We don't want any later data to be written after space becomes available,
146 // so refuse to write anything more once we've dropped data because we ran
147 // out of space.
148 VLOG(1) << "Ignoring queue: " << queue.size();
149 encoder_->Clear(queue.size());
150 return;
151 }
Brian Silvermanf51499a2020-09-21 12:49:08 -0700152
Austin Schuha36c8902019-12-30 18:07:15 -0800153 iovec_.clear();
Brian Silvermanf51499a2020-09-21 12:49:08 -0700154 const size_t iovec_size = std::min<size_t>(queue.size(), IOV_MAX);
155 iovec_.resize(iovec_size);
Austin Schuha36c8902019-12-30 18:07:15 -0800156 size_t counted_size = 0;
Brian Silvermanf51499a2020-09-21 12:49:08 -0700157 for (size_t i = 0; i < iovec_size; ++i) {
158 iovec_[i].iov_base = const_cast<uint8_t *>(queue[i].data());
159 iovec_[i].iov_len = queue[i].size();
160 counted_size += iovec_[i].iov_len;
Austin Schuha36c8902019-12-30 18:07:15 -0800161 }
Brian Silvermanf51499a2020-09-21 12:49:08 -0700162
163 const auto start = aos::monotonic_clock::now();
Austin Schuha36c8902019-12-30 18:07:15 -0800164 const ssize_t written = writev(fd_, iovec_.data(), iovec_.size());
Brian Silvermanf51499a2020-09-21 12:49:08 -0700165 const auto end = aos::monotonic_clock::now();
Brian Silverman0465fcf2020-09-24 00:29:18 -0700166 HandleWriteReturn(written, counted_size);
Brian Silvermanf51499a2020-09-21 12:49:08 -0700167
168 encoder_->Clear(iovec_size);
169
170 UpdateStatsForWrite(end - start, written, iovec_size);
171}
172
Brian Silverman0465fcf2020-09-24 00:29:18 -0700173void DetachedBufferWriter::HandleWriteReturn(ssize_t write_return,
174 size_t write_size) {
175 if (write_return == -1 && errno == ENOSPC) {
176 ran_out_of_space_ = true;
177 return;
178 }
179 PCHECK(write_return >= 0) << ": write failed";
180 if (write_return < static_cast<ssize_t>(write_size)) {
181 // Sometimes this happens instead of ENOSPC. On a real filesystem, this
182 // never seems to happen in any other case. If we ever want to log to a
183 // socket, this will happen more often. However, until we get there, we'll
184 // just assume it means we ran out of space.
185 ran_out_of_space_ = true;
186 return;
187 }
188}
189
Brian Silvermanf51499a2020-09-21 12:49:08 -0700190void DetachedBufferWriter::UpdateStatsForWrite(
191 aos::monotonic_clock::duration duration, ssize_t written, int iovec_size) {
192 if (duration > max_write_time_) {
193 max_write_time_ = duration;
194 max_write_time_bytes_ = written;
195 max_write_time_messages_ = iovec_size;
196 }
197 total_write_time_ += duration;
198 ++total_write_count_;
199 total_write_messages_ += iovec_size;
200 total_write_bytes_ += written;
201}
202
203void DetachedBufferWriter::FlushAtThreshold() {
204 // Flush if we are at the max number of iovs per writev, because there's no
205 // point queueing up any more data in memory. Also flush once we have enough
206 // data queued up.
207 while (encoder_->queued_bytes() > static_cast<size_t>(FLAGS_flush_size) ||
208 encoder_->queue_size() >= IOV_MAX) {
209 Flush();
210 }
Austin Schuha36c8902019-12-30 18:07:15 -0800211}
212
213flatbuffers::Offset<MessageHeader> PackMessage(
214 flatbuffers::FlatBufferBuilder *fbb, const Context &context,
215 int channel_index, LogType log_type) {
216 flatbuffers::Offset<flatbuffers::Vector<uint8_t>> data_offset;
217
218 switch (log_type) {
219 case LogType::kLogMessage:
220 case LogType::kLogMessageAndDeliveryTime:
Austin Schuh6f3babe2020-01-26 20:34:50 -0800221 case LogType::kLogRemoteMessage:
Brian Silvermaneaa41d62020-07-08 19:47:35 -0700222 data_offset = fbb->CreateVector(
223 static_cast<const uint8_t *>(context.data), context.size);
Austin Schuha36c8902019-12-30 18:07:15 -0800224 break;
225
226 case LogType::kLogDeliveryTimeOnly:
227 break;
228 }
229
230 MessageHeader::Builder message_header_builder(*fbb);
231 message_header_builder.add_channel_index(channel_index);
Austin Schuh6f3babe2020-01-26 20:34:50 -0800232
233 switch (log_type) {
234 case LogType::kLogRemoteMessage:
235 message_header_builder.add_queue_index(context.remote_queue_index);
236 message_header_builder.add_monotonic_sent_time(
237 context.monotonic_remote_time.time_since_epoch().count());
238 message_header_builder.add_realtime_sent_time(
239 context.realtime_remote_time.time_since_epoch().count());
240 break;
241
242 case LogType::kLogMessage:
243 case LogType::kLogMessageAndDeliveryTime:
244 case LogType::kLogDeliveryTimeOnly:
245 message_header_builder.add_queue_index(context.queue_index);
246 message_header_builder.add_monotonic_sent_time(
247 context.monotonic_event_time.time_since_epoch().count());
248 message_header_builder.add_realtime_sent_time(
249 context.realtime_event_time.time_since_epoch().count());
250 break;
251 }
Austin Schuha36c8902019-12-30 18:07:15 -0800252
253 switch (log_type) {
254 case LogType::kLogMessage:
Austin Schuh6f3babe2020-01-26 20:34:50 -0800255 case LogType::kLogRemoteMessage:
Austin Schuha36c8902019-12-30 18:07:15 -0800256 message_header_builder.add_data(data_offset);
257 break;
258
259 case LogType::kLogMessageAndDeliveryTime:
260 message_header_builder.add_data(data_offset);
261 [[fallthrough]];
262
263 case LogType::kLogDeliveryTimeOnly:
264 message_header_builder.add_monotonic_remote_time(
265 context.monotonic_remote_time.time_since_epoch().count());
266 message_header_builder.add_realtime_remote_time(
267 context.realtime_remote_time.time_since_epoch().count());
268 message_header_builder.add_remote_queue_index(context.remote_queue_index);
269 break;
270 }
271
272 return message_header_builder.Finish();
273}
274
Brian Silvermanf51499a2020-09-21 12:49:08 -0700275SpanReader::SpanReader(std::string_view filename) : filename_(filename) {
Brian Silvermanf59fe3f2020-09-22 21:04:09 -0700276 static const std::string_view kXz = ".xz";
277 if (filename.substr(filename.size() - kXz.size()) == kXz) {
278#if ENABLE_LZMA
279 decoder_ = std::make_unique<LzmaDecoder>(filename);
280#else
281 LOG(FATAL) << "Reading xz-compressed files not supported on this platform";
282#endif
283 } else {
284 decoder_ = std::make_unique<DummyDecoder>(filename);
285 }
Austin Schuh05b70472020-01-01 17:11:17 -0800286}
287
288absl::Span<const uint8_t> SpanReader::ReadMessage() {
289 // Make sure we have enough for the size.
290 if (data_.size() - consumed_data_ < sizeof(flatbuffers::uoffset_t)) {
291 if (!ReadBlock()) {
292 return absl::Span<const uint8_t>();
293 }
294 }
295
296 // Now make sure we have enough for the message.
297 const size_t data_size =
298 flatbuffers::GetPrefixedSize(data_.data() + consumed_data_) +
299 sizeof(flatbuffers::uoffset_t);
Austin Schuhe4fca832020-03-07 16:58:53 -0800300 if (data_size == sizeof(flatbuffers::uoffset_t)) {
301 LOG(ERROR) << "Size of data is zero. Log file end is corrupted, skipping.";
302 LOG(ERROR) << " Rest of log file is "
303 << absl::BytesToHexString(std::string_view(
304 reinterpret_cast<const char *>(data_.data() +
305 consumed_data_),
306 data_.size() - consumed_data_));
307 return absl::Span<const uint8_t>();
308 }
Austin Schuh05b70472020-01-01 17:11:17 -0800309 while (data_.size() < consumed_data_ + data_size) {
310 if (!ReadBlock()) {
311 return absl::Span<const uint8_t>();
312 }
313 }
314
315 // And return it, consuming the data.
316 const uint8_t *data_ptr = data_.data() + consumed_data_;
317
318 consumed_data_ += data_size;
319
320 return absl::Span<const uint8_t>(data_ptr, data_size);
321}
322
Austin Schuh05b70472020-01-01 17:11:17 -0800323bool SpanReader::ReadBlock() {
Brian Silvermanf51499a2020-09-21 12:49:08 -0700324 // This is the amount of data we grab at a time. Doing larger chunks minimizes
325 // syscalls and helps decompressors batch things more efficiently.
Austin Schuh05b70472020-01-01 17:11:17 -0800326 constexpr size_t kReadSize = 256 * 1024;
327
328 // Strip off any unused data at the front.
329 if (consumed_data_ != 0) {
Brian Silvermanf51499a2020-09-21 12:49:08 -0700330 data_.erase_front(consumed_data_);
Austin Schuh05b70472020-01-01 17:11:17 -0800331 consumed_data_ = 0;
332 }
333
334 const size_t starting_size = data_.size();
335
336 // This should automatically grow the backing store. It won't shrink if we
337 // get a small chunk later. This reduces allocations when we want to append
338 // more data.
Brian Silvermanf51499a2020-09-21 12:49:08 -0700339 data_.resize(starting_size + kReadSize);
Austin Schuh05b70472020-01-01 17:11:17 -0800340
Brian Silvermanf51499a2020-09-21 12:49:08 -0700341 const size_t count =
342 decoder_->Read(data_.begin() + starting_size, data_.end());
343 data_.resize(starting_size + count);
Austin Schuh05b70472020-01-01 17:11:17 -0800344 if (count == 0) {
Austin Schuh05b70472020-01-01 17:11:17 -0800345 return false;
346 }
Austin Schuh05b70472020-01-01 17:11:17 -0800347
348 return true;
349}
350
Austin Schuh6f3babe2020-01-26 20:34:50 -0800351FlatbufferVector<LogFileHeader> ReadHeader(std::string_view filename) {
352 SpanReader span_reader(filename);
Austin Schuh6f3babe2020-01-26 20:34:50 -0800353 absl::Span<const uint8_t> config_data = span_reader.ReadMessage();
354
355 // Make sure something was read.
Austin Schuh97789fc2020-08-01 14:42:45 -0700356 CHECK(config_data != absl::Span<const uint8_t>())
357 << ": Failed to read header from: " << filename;
Austin Schuh6f3babe2020-01-26 20:34:50 -0800358
Austin Schuh5212cad2020-09-09 23:12:09 -0700359 // And copy the config so we have it forever, removing the size prefix.
Brian Silverman354697a2020-09-22 21:06:32 -0700360 ResizeableBuffer data;
361 data.resize(config_data.size() - sizeof(flatbuffers::uoffset_t));
362 memcpy(data.data(), config_data.begin() + sizeof(flatbuffers::uoffset_t),
363 data.size());
Austin Schuh6f3babe2020-01-26 20:34:50 -0800364 return FlatbufferVector<LogFileHeader>(std::move(data));
365}
366
Austin Schuh5212cad2020-09-09 23:12:09 -0700367FlatbufferVector<MessageHeader> ReadNthMessage(std::string_view filename,
368 size_t n) {
369 SpanReader span_reader(filename);
370 absl::Span<const uint8_t> data_span = span_reader.ReadMessage();
371 for (size_t i = 0; i < n + 1; ++i) {
372 data_span = span_reader.ReadMessage();
373
374 // Make sure something was read.
375 CHECK(data_span != absl::Span<const uint8_t>())
376 << ": Failed to read data from: " << filename;
377 }
378
Brian Silverman354697a2020-09-22 21:06:32 -0700379 // And copy the config so we have it forever, removing the size prefix.
380 ResizeableBuffer data;
381 data.resize(data_span.size() - sizeof(flatbuffers::uoffset_t));
382 memcpy(data.data(), data_span.begin() + sizeof(flatbuffers::uoffset_t),
383 data.size());
Austin Schuh5212cad2020-09-09 23:12:09 -0700384 return FlatbufferVector<MessageHeader>(std::move(data));
385}
386
Austin Schuh05b70472020-01-01 17:11:17 -0800387MessageReader::MessageReader(std::string_view filename)
Austin Schuh97789fc2020-08-01 14:42:45 -0700388 : span_reader_(filename),
389 raw_log_file_header_(FlatbufferVector<LogFileHeader>::Empty()) {
Austin Schuh05b70472020-01-01 17:11:17 -0800390 // Make sure we have enough to read the size.
Austin Schuh97789fc2020-08-01 14:42:45 -0700391 absl::Span<const uint8_t> header_data = span_reader_.ReadMessage();
Austin Schuh05b70472020-01-01 17:11:17 -0800392
393 // Make sure something was read.
Austin Schuh97789fc2020-08-01 14:42:45 -0700394 CHECK(header_data != absl::Span<const uint8_t>())
395 << ": Failed to read header from: " << filename;
Austin Schuh05b70472020-01-01 17:11:17 -0800396
Austin Schuh97789fc2020-08-01 14:42:45 -0700397 // And copy the header data so we have it forever.
Brian Silverman354697a2020-09-22 21:06:32 -0700398 ResizeableBuffer header_data_copy;
399 header_data_copy.resize(header_data.size() - sizeof(flatbuffers::uoffset_t));
400 memcpy(header_data_copy.data(),
401 header_data.begin() + sizeof(flatbuffers::uoffset_t),
402 header_data_copy.size());
Austin Schuh97789fc2020-08-01 14:42:45 -0700403 raw_log_file_header_ =
404 FlatbufferVector<LogFileHeader>(std::move(header_data_copy));
Austin Schuh05b70472020-01-01 17:11:17 -0800405
Austin Schuhcde938c2020-02-02 17:30:07 -0800406 max_out_of_order_duration_ =
Austin Schuh2f8fd752020-09-01 22:38:28 -0700407 chrono::nanoseconds(log_file_header()->max_out_of_order_duration());
Austin Schuhcde938c2020-02-02 17:30:07 -0800408
409 VLOG(1) << "Opened " << filename << " as node "
410 << FlatbufferToJson(log_file_header()->node());
Austin Schuh05b70472020-01-01 17:11:17 -0800411}
412
413std::optional<FlatbufferVector<MessageHeader>> MessageReader::ReadMessage() {
414 absl::Span<const uint8_t> msg_data = span_reader_.ReadMessage();
415 if (msg_data == absl::Span<const uint8_t>()) {
416 return std::nullopt;
417 }
418
Brian Silverman354697a2020-09-22 21:06:32 -0700419 ResizeableBuffer result_buffer;
420 result_buffer.resize(msg_data.size() - sizeof(flatbuffers::uoffset_t));
421 memcpy(result_buffer.data(),
422 msg_data.begin() + sizeof(flatbuffers::uoffset_t),
423 result_buffer.size());
424 FlatbufferVector<MessageHeader> result(std::move(result_buffer));
Austin Schuh05b70472020-01-01 17:11:17 -0800425
426 const monotonic_clock::time_point timestamp = monotonic_clock::time_point(
427 chrono::nanoseconds(result.message().monotonic_sent_time()));
428
429 newest_timestamp_ = std::max(newest_timestamp_, timestamp);
Austin Schuh8bd96322020-02-13 21:18:22 -0800430 VLOG(2) << "Read from " << filename() << " data " << FlatbufferToJson(result);
Austin Schuh6f3babe2020-01-26 20:34:50 -0800431 return std::move(result);
Austin Schuh05b70472020-01-01 17:11:17 -0800432}
433
Austin Schuh6f3babe2020-01-26 20:34:50 -0800434SplitMessageReader::SplitMessageReader(
Austin Schuhfa895892020-01-07 20:07:41 -0800435 const std::vector<std::string> &filenames)
436 : filenames_(filenames),
Austin Schuh97789fc2020-08-01 14:42:45 -0700437 log_file_header_(FlatbufferVector<LogFileHeader>::Empty()) {
Austin Schuhfa895892020-01-07 20:07:41 -0800438 CHECK(NextLogFile()) << ": filenames is empty. Need files to read.";
439
Austin Schuh6f3babe2020-01-26 20:34:50 -0800440 // Grab any log file header. They should all match (and we will check as we
441 // open more of them).
Austin Schuh97789fc2020-08-01 14:42:45 -0700442 log_file_header_ = message_reader_->raw_log_file_header();
Austin Schuhfa895892020-01-07 20:07:41 -0800443
Austin Schuh2f8fd752020-09-01 22:38:28 -0700444 for (size_t i = 1; i < filenames_.size(); ++i) {
445 MessageReader message_reader(filenames_[i]);
446
447 const monotonic_clock::time_point new_monotonic_start_time(
448 chrono::nanoseconds(
449 message_reader.log_file_header()->monotonic_start_time()));
450 const realtime_clock::time_point new_realtime_start_time(
451 chrono::nanoseconds(
452 message_reader.log_file_header()->realtime_start_time()));
453
454 // There are 2 types of part files. Part files from before time estimation
455 // has started, and part files after. We don't declare a log file "started"
456 // until time estimation is up. And once a log file starts, it should never
457 // stop again, and should remain constant.
458 // To compare both types of headers, we mutate our saved copy of the header
459 // to match the next chunk by updating time if we detect a stopped ->
460 // started transition.
461 if (monotonic_start_time() == monotonic_clock::min_time) {
462 CHECK_EQ(realtime_start_time(), realtime_clock::min_time);
463 // We should only be missing the monotonic start time when logging data
Brian Silverman87ac0402020-09-17 14:47:01 -0700464 // for remote nodes. We don't have a good way to determine the remote
Austin Schuh2f8fd752020-09-01 22:38:28 -0700465 // realtime offset, so it shouldn't be filled out.
466 // TODO(austin): If we have a good way, feel free to fill it out. It
467 // probably won't be better than we could do in post though with the same
468 // data.
469 CHECK(!log_file_header_.mutable_message()->has_realtime_start_time());
470 if (new_monotonic_start_time != monotonic_clock::min_time) {
471 // If we finally found our start time, update the header. Do this once
472 // because it should never change again.
473 log_file_header_.mutable_message()->mutate_monotonic_start_time(
474 new_monotonic_start_time.time_since_epoch().count());
475 log_file_header_.mutable_message()->mutate_realtime_start_time(
476 new_realtime_start_time.time_since_epoch().count());
477 }
478 }
479
Austin Schuh64fab802020-09-09 22:47:47 -0700480 // We don't have a good way to set the realtime start time on remote nodes.
481 // Confirm it remains consistent.
482 CHECK_EQ(log_file_header_.mutable_message()->has_realtime_start_time(),
483 message_reader.log_file_header()->has_realtime_start_time());
484
485 // Parts index will *not* match unless we set them to match. We only want
486 // to accept the start time and parts mismatching, so set them.
487 log_file_header_.mutable_message()->mutate_parts_index(
488 message_reader.log_file_header()->parts_index());
489
Austin Schuh2f8fd752020-09-01 22:38:28 -0700490 // Now compare that the headers match.
Austin Schuh64fab802020-09-09 22:47:47 -0700491 if (!CompareFlatBuffer(message_reader.raw_log_file_header(),
492 log_file_header_)) {
Brian Silvermanae7c0332020-09-30 16:58:23 -0700493 if (message_reader.log_file_header()->has_log_event_uuid() &&
494 log_file_header_.message().has_log_event_uuid() &&
495 message_reader.log_file_header()->log_event_uuid()->string_view() !=
496 log_file_header_.message().log_event_uuid()->string_view()) {
Austin Schuh64fab802020-09-09 22:47:47 -0700497 LOG(FATAL) << "Logger UUIDs don't match between log file chunks "
498 << filenames_[0] << " and " << filenames_[i]
499 << ", this is not supported.";
500 }
501 if (message_reader.log_file_header()->has_parts_uuid() &&
502 log_file_header_.message().has_parts_uuid() &&
503 message_reader.log_file_header()->parts_uuid()->string_view() !=
504 log_file_header_.message().parts_uuid()->string_view()) {
505 LOG(FATAL) << "Parts UUIDs don't match between log file chunks "
506 << filenames_[0] << " and " << filenames_[i]
507 << ", this is not supported.";
508 }
509
510 LOG(FATAL) << "Header is different between log file chunks "
511 << filenames_[0] << " and " << filenames_[i]
512 << ", this is not supported.";
513 }
Austin Schuh2f8fd752020-09-01 22:38:28 -0700514 }
Austin Schuh64fab802020-09-09 22:47:47 -0700515 // Put the parts index back to the first log file chunk.
516 log_file_header_.mutable_message()->mutate_parts_index(
517 message_reader_->log_file_header()->parts_index());
Austin Schuh2f8fd752020-09-01 22:38:28 -0700518
Austin Schuh6f3babe2020-01-26 20:34:50 -0800519 // Setup per channel state.
Austin Schuh05b70472020-01-01 17:11:17 -0800520 channels_.resize(configuration()->channels()->size());
Austin Schuh6f3babe2020-01-26 20:34:50 -0800521 for (ChannelData &channel_data : channels_) {
522 channel_data.data.split_reader = this;
523 // Build up the timestamp list.
524 if (configuration::MultiNode(configuration())) {
525 channel_data.timestamps.resize(configuration()->nodes()->size());
526 for (MessageHeaderQueue &queue : channel_data.timestamps) {
527 queue.timestamps = true;
528 queue.split_reader = this;
529 }
530 }
531 }
Austin Schuh05b70472020-01-01 17:11:17 -0800532
Austin Schuh6f3babe2020-01-26 20:34:50 -0800533 // Build up channels_to_write_ as an optimization to make it fast to figure
534 // out which datastructure to place any new data from a channel on.
535 for (const Channel *channel : *configuration()->channels()) {
536 // This is the main case. We will only see data on this node.
537 if (configuration::ChannelIsSendableOnNode(channel, node())) {
538 channels_to_write_.emplace_back(
539 &channels_[channels_to_write_.size()].data);
540 } else
541 // If we can't send, but can receive, we should be able to see
542 // timestamps here.
543 if (configuration::ChannelIsReadableOnNode(channel, node())) {
544 channels_to_write_.emplace_back(
545 &(channels_[channels_to_write_.size()]
546 .timestamps[configuration::GetNodeIndex(configuration(),
547 node())]));
548 } else {
549 channels_to_write_.emplace_back(nullptr);
550 }
551 }
Austin Schuh05b70472020-01-01 17:11:17 -0800552}
553
Austin Schuh6f3babe2020-01-26 20:34:50 -0800554bool SplitMessageReader::NextLogFile() {
Austin Schuhfa895892020-01-07 20:07:41 -0800555 if (next_filename_index_ == filenames_.size()) {
556 return false;
557 }
558 message_reader_ =
559 std::make_unique<MessageReader>(filenames_[next_filename_index_]);
560
561 // We can't support the config diverging between two log file headers. See if
562 // they are the same.
563 if (next_filename_index_ != 0) {
Austin Schuh64fab802020-09-09 22:47:47 -0700564 // In order for the headers to identically compare, they need to have the
565 // same parts_index. Rewrite the saved header with the new parts_index,
566 // compare, and then restore.
567 const int32_t original_parts_index =
568 log_file_header_.message().parts_index();
569 log_file_header_.mutable_message()->mutate_parts_index(
570 message_reader_->log_file_header()->parts_index());
571
Austin Schuh97789fc2020-08-01 14:42:45 -0700572 CHECK(CompareFlatBuffer(message_reader_->raw_log_file_header(),
573 log_file_header_))
Austin Schuhfa895892020-01-07 20:07:41 -0800574 << ": Header is different between log file chunks "
575 << filenames_[next_filename_index_] << " and "
576 << filenames_[next_filename_index_ - 1] << ", this is not supported.";
Austin Schuh64fab802020-09-09 22:47:47 -0700577
578 log_file_header_.mutable_message()->mutate_parts_index(
579 original_parts_index);
Austin Schuhfa895892020-01-07 20:07:41 -0800580 }
581
582 ++next_filename_index_;
583 return true;
584}
585
Austin Schuh6f3babe2020-01-26 20:34:50 -0800586bool SplitMessageReader::QueueMessages(
Austin Schuhcde938c2020-02-02 17:30:07 -0800587 monotonic_clock::time_point last_dequeued_time) {
Austin Schuh6f3babe2020-01-26 20:34:50 -0800588 // TODO(austin): Once we are happy that everything works, read a 256kb chunk
589 // to reduce the need to re-heap down below.
Austin Schuhcde938c2020-02-02 17:30:07 -0800590
591 // Special case no more data. Otherwise we blow up on the CHECK statement
592 // confirming that we have enough data queued.
593 if (at_end_) {
594 return false;
595 }
596
597 // If this isn't the first time around, confirm that we had enough data queued
598 // to follow the contract.
599 if (time_to_queue_ != monotonic_clock::min_time) {
600 CHECK_LE(last_dequeued_time,
601 newest_timestamp() - max_out_of_order_duration())
602 << " node " << FlatbufferToJson(node()) << " on " << this;
603
604 // Bail if there is enough data already queued.
605 if (last_dequeued_time < time_to_queue_) {
Austin Schuhee711052020-08-24 16:06:09 -0700606 VLOG(1) << MaybeNodeName(target_node_) << "All up to date on " << this
607 << ", dequeued " << last_dequeued_time << " queue time "
608 << time_to_queue_;
Austin Schuhcde938c2020-02-02 17:30:07 -0800609 return true;
610 }
611 } else {
612 // Startup takes a special dance. We want to queue up until the start time,
613 // but we then want to find the next message to read. The conservative
614 // answer is to immediately trigger a second requeue to get things moving.
615 time_to_queue_ = monotonic_start_time();
616 QueueMessages(time_to_queue_);
617 }
618
619 // If we are asked to queue, queue for at least max_out_of_order_duration past
620 // the last known time in the log file (ie the newest timestep read). As long
621 // as we requeue exactly when time_to_queue_ is dequeued and go no further, we
622 // are safe. And since we pop in order, that works.
623 //
624 // Special case the start of the log file. There should be at most 1 message
625 // from each channel at the start of the log file. So always force the start
626 // of the log file to just be read.
627 time_to_queue_ = std::max(time_to_queue_, newest_timestamp());
Austin Schuhee711052020-08-24 16:06:09 -0700628 VLOG(1) << MaybeNodeName(target_node_) << "Queueing, going until "
629 << time_to_queue_ << " " << filename();
Austin Schuhcde938c2020-02-02 17:30:07 -0800630
631 bool was_emplaced = false;
Austin Schuh6f3babe2020-01-26 20:34:50 -0800632 while (true) {
Austin Schuhcde938c2020-02-02 17:30:07 -0800633 // Stop if we have enough.
Brian Silverman98360e22020-04-28 16:51:20 -0700634 if (newest_timestamp() > time_to_queue_ + max_out_of_order_duration() &&
Austin Schuhcde938c2020-02-02 17:30:07 -0800635 was_emplaced) {
Austin Schuhee711052020-08-24 16:06:09 -0700636 VLOG(1) << MaybeNodeName(target_node_) << "Done queueing on " << this
637 << ", queued to " << newest_timestamp() << " with requeue time "
638 << time_to_queue_;
Austin Schuh6f3babe2020-01-26 20:34:50 -0800639 return true;
640 }
Austin Schuh05b70472020-01-01 17:11:17 -0800641
Austin Schuh6f3babe2020-01-26 20:34:50 -0800642 if (std::optional<FlatbufferVector<MessageHeader>> msg =
643 message_reader_->ReadMessage()) {
644 const MessageHeader &header = msg.value().message();
645
Austin Schuhcde938c2020-02-02 17:30:07 -0800646 const monotonic_clock::time_point timestamp = monotonic_clock::time_point(
647 chrono::nanoseconds(header.monotonic_sent_time()));
Austin Schuh6f3babe2020-01-26 20:34:50 -0800648
Austin Schuh0b5fd032020-03-28 17:36:49 -0700649 if (VLOG_IS_ON(2)) {
Brian Silvermand90905f2020-09-23 14:42:56 -0700650 LOG(INFO) << MaybeNodeName(target_node_) << "Queued " << this << " "
651 << filename() << " ttq: " << time_to_queue_ << " now "
Austin Schuhee711052020-08-24 16:06:09 -0700652 << newest_timestamp() << " start time "
653 << monotonic_start_time() << " " << FlatbufferToJson(&header);
Austin Schuh0b5fd032020-03-28 17:36:49 -0700654 } else if (VLOG_IS_ON(1)) {
655 FlatbufferVector<MessageHeader> copy = msg.value();
656 copy.mutable_message()->clear_data();
Austin Schuhee711052020-08-24 16:06:09 -0700657 LOG(INFO) << MaybeNodeName(target_node_) << "Queued " << this << " "
658 << filename() << " ttq: " << time_to_queue_ << " now "
659 << newest_timestamp() << " start time "
660 << monotonic_start_time() << " " << FlatbufferToJson(copy);
Austin Schuh0b5fd032020-03-28 17:36:49 -0700661 }
Austin Schuhcde938c2020-02-02 17:30:07 -0800662
663 const int channel_index = header.channel_index();
664 was_emplaced = channels_to_write_[channel_index]->emplace_back(
665 std::move(msg.value()));
666 if (was_emplaced) {
667 newest_timestamp_ = std::max(newest_timestamp_, timestamp);
668 }
Austin Schuh6f3babe2020-01-26 20:34:50 -0800669 } else {
670 if (!NextLogFile()) {
Austin Schuhee711052020-08-24 16:06:09 -0700671 VLOG(1) << MaybeNodeName(target_node_) << "No more files, last was "
672 << filenames_.back();
Austin Schuhcde938c2020-02-02 17:30:07 -0800673 at_end_ = true;
Austin Schuh8bd96322020-02-13 21:18:22 -0800674 for (MessageHeaderQueue *queue : channels_to_write_) {
675 if (queue == nullptr || queue->timestamp_merger == nullptr) {
676 continue;
677 }
678 queue->timestamp_merger->NoticeAtEnd();
679 }
Austin Schuh6f3babe2020-01-26 20:34:50 -0800680 return false;
681 }
682 }
Austin Schuh05b70472020-01-01 17:11:17 -0800683 }
Austin Schuh6f3babe2020-01-26 20:34:50 -0800684}
685
686void SplitMessageReader::SetTimestampMerger(TimestampMerger *timestamp_merger,
687 int channel_index,
688 const Node *target_node) {
689 const Node *reinterpreted_target_node =
690 configuration::GetNodeOrDie(configuration(), target_node);
Austin Schuhee711052020-08-24 16:06:09 -0700691 target_node_ = reinterpreted_target_node;
692
Austin Schuh6f3babe2020-01-26 20:34:50 -0800693 const Channel *const channel =
694 configuration()->channels()->Get(channel_index);
695
Austin Schuhcde938c2020-02-02 17:30:07 -0800696 VLOG(1) << " Configuring merger " << this << " for channel " << channel_index
697 << " "
698 << configuration::CleanedChannelToString(
699 configuration()->channels()->Get(channel_index));
700
Austin Schuh6f3babe2020-01-26 20:34:50 -0800701 MessageHeaderQueue *message_header_queue = nullptr;
702
703 // Figure out if this log file is from our point of view, or the other node's
704 // point of view.
705 if (node() == reinterpreted_target_node) {
Austin Schuhcde938c2020-02-02 17:30:07 -0800706 VLOG(1) << " Replaying as logged node " << filename();
707
708 if (configuration::ChannelIsSendableOnNode(channel, node())) {
709 VLOG(1) << " Data on node";
710 message_header_queue = &(channels_[channel_index].data);
711 } else if (configuration::ChannelIsReadableOnNode(channel, node())) {
712 VLOG(1) << " Timestamps on node";
713 message_header_queue =
714 &(channels_[channel_index].timestamps[configuration::GetNodeIndex(
715 configuration(), node())]);
Austin Schuh6f3babe2020-01-26 20:34:50 -0800716 } else {
Austin Schuhcde938c2020-02-02 17:30:07 -0800717 VLOG(1) << " Dropping";
Austin Schuh6f3babe2020-01-26 20:34:50 -0800718 }
719 } else {
Austin Schuhcde938c2020-02-02 17:30:07 -0800720 VLOG(1) << " Replaying as other node " << filename();
Austin Schuh6f3babe2020-01-26 20:34:50 -0800721 // We are replaying from another node's point of view. The only interesting
Austin Schuhcde938c2020-02-02 17:30:07 -0800722 // data is data that is sent from our node and received on theirs.
723 if (configuration::ChannelIsReadableOnNode(channel,
724 reinterpreted_target_node) &&
725 configuration::ChannelIsSendableOnNode(channel, node())) {
726 VLOG(1) << " Readable on target node";
Austin Schuh6f3babe2020-01-26 20:34:50 -0800727 // Data from another node.
728 message_header_queue = &(channels_[channel_index].data);
729 } else {
Austin Schuhcde938c2020-02-02 17:30:07 -0800730 VLOG(1) << " Dropping";
Austin Schuh6f3babe2020-01-26 20:34:50 -0800731 // This is either not sendable on the other node, or is a timestamp and
732 // therefore not interesting.
733 }
734 }
735
736 // If we found one, write it down. This will be nullptr when there is nothing
737 // relevant on this channel on this node for the target node. In that case,
738 // we want to drop the message instead of queueing it.
739 if (message_header_queue != nullptr) {
740 message_header_queue->timestamp_merger = timestamp_merger;
741 }
742}
743
744std::tuple<monotonic_clock::time_point, uint32_t,
745 FlatbufferVector<MessageHeader>>
746SplitMessageReader::PopOldest(int channel_index) {
747 CHECK_GT(channels_[channel_index].data.size(), 0u);
Austin Schuhcde938c2020-02-02 17:30:07 -0800748 const std::tuple<monotonic_clock::time_point, uint32_t, const MessageHeader *>
749 timestamp = channels_[channel_index].data.front_timestamp();
Austin Schuh6f3babe2020-01-26 20:34:50 -0800750 FlatbufferVector<MessageHeader> front =
751 std::move(channels_[channel_index].data.front());
Austin Schuh2f8fd752020-09-01 22:38:28 -0700752 channels_[channel_index].data.PopFront();
Austin Schuhcde938c2020-02-02 17:30:07 -0800753
Austin Schuh2f8fd752020-09-01 22:38:28 -0700754 VLOG(1) << MaybeNodeName(target_node_) << "Popped Data " << this << " "
755 << std::get<0>(timestamp) << " for "
756 << configuration::StrippedChannelToString(
757 configuration()->channels()->Get(channel_index))
758 << " (" << channel_index << ")";
Austin Schuhcde938c2020-02-02 17:30:07 -0800759
760 QueueMessages(std::get<0>(timestamp));
Austin Schuh6f3babe2020-01-26 20:34:50 -0800761
762 return std::make_tuple(std::get<0>(timestamp), std::get<1>(timestamp),
763 std::move(front));
764}
765
766std::tuple<monotonic_clock::time_point, uint32_t,
767 FlatbufferVector<MessageHeader>>
Austin Schuh2f8fd752020-09-01 22:38:28 -0700768SplitMessageReader::PopOldestTimestamp(int channel, int node_index) {
Austin Schuh6f3babe2020-01-26 20:34:50 -0800769 CHECK_GT(channels_[channel].timestamps[node_index].size(), 0u);
Austin Schuhcde938c2020-02-02 17:30:07 -0800770 const std::tuple<monotonic_clock::time_point, uint32_t, const MessageHeader *>
771 timestamp = channels_[channel].timestamps[node_index].front_timestamp();
Austin Schuh6f3babe2020-01-26 20:34:50 -0800772 FlatbufferVector<MessageHeader> front =
773 std::move(channels_[channel].timestamps[node_index].front());
Austin Schuh2f8fd752020-09-01 22:38:28 -0700774 channels_[channel].timestamps[node_index].PopFront();
Austin Schuhcde938c2020-02-02 17:30:07 -0800775
Austin Schuh2f8fd752020-09-01 22:38:28 -0700776 VLOG(1) << MaybeNodeName(target_node_) << "Popped timestamp " << this << " "
Austin Schuhee711052020-08-24 16:06:09 -0700777 << std::get<0>(timestamp) << " for "
778 << configuration::StrippedChannelToString(
779 configuration()->channels()->Get(channel))
Austin Schuh2f8fd752020-09-01 22:38:28 -0700780 << " on "
781 << configuration()->nodes()->Get(node_index)->name()->string_view()
782 << " (" << node_index << ")";
Austin Schuhcde938c2020-02-02 17:30:07 -0800783
784 QueueMessages(std::get<0>(timestamp));
Austin Schuh6f3babe2020-01-26 20:34:50 -0800785
786 return std::make_tuple(std::get<0>(timestamp), std::get<1>(timestamp),
787 std::move(front));
788}
789
Austin Schuhcde938c2020-02-02 17:30:07 -0800790bool SplitMessageReader::MessageHeaderQueue::emplace_back(
Austin Schuh6f3babe2020-01-26 20:34:50 -0800791 FlatbufferVector<MessageHeader> &&msg) {
792 CHECK(split_reader != nullptr);
793
794 // If there is no timestamp merger for this queue, nobody is listening. Drop
795 // the message. This happens when a log file from another node is replayed,
796 // and the timestamp mergers down stream just don't care.
797 if (timestamp_merger == nullptr) {
Austin Schuhcde938c2020-02-02 17:30:07 -0800798 return false;
Austin Schuh6f3babe2020-01-26 20:34:50 -0800799 }
800
801 CHECK(timestamps != msg.message().has_data())
802 << ": Got timestamps and data mixed up on a node. "
803 << FlatbufferToJson(msg);
804
805 data_.emplace_back(std::move(msg));
806
807 if (data_.size() == 1u) {
808 // Yup, new data. Notify.
809 if (timestamps) {
810 timestamp_merger->UpdateTimestamp(split_reader, front_timestamp());
811 } else {
812 timestamp_merger->Update(split_reader, front_timestamp());
813 }
814 }
Austin Schuhcde938c2020-02-02 17:30:07 -0800815
816 return true;
Austin Schuh6f3babe2020-01-26 20:34:50 -0800817}
818
Austin Schuh2f8fd752020-09-01 22:38:28 -0700819void SplitMessageReader::MessageHeaderQueue::PopFront() {
Austin Schuh6f3babe2020-01-26 20:34:50 -0800820 data_.pop_front();
821 if (data_.size() != 0u) {
822 // Yup, new data.
823 if (timestamps) {
824 timestamp_merger->UpdateTimestamp(split_reader, front_timestamp());
825 } else {
826 timestamp_merger->Update(split_reader, front_timestamp());
827 }
Austin Schuh2f8fd752020-09-01 22:38:28 -0700828 } else {
829 // Poke anyways to update the heap.
830 if (timestamps) {
831 timestamp_merger->UpdateTimestamp(
832 nullptr, std::make_tuple(monotonic_clock::min_time, 0, nullptr));
833 } else {
834 timestamp_merger->Update(
835 nullptr, std::make_tuple(monotonic_clock::min_time, 0, nullptr));
836 }
Austin Schuh6f3babe2020-01-26 20:34:50 -0800837 }
Austin Schuh05b70472020-01-01 17:11:17 -0800838}
839
840namespace {
841
Austin Schuh6f3babe2020-01-26 20:34:50 -0800842bool SplitMessageReaderHeapCompare(
843 const std::tuple<monotonic_clock::time_point, uint32_t,
844 SplitMessageReader *>
845 first,
846 const std::tuple<monotonic_clock::time_point, uint32_t,
847 SplitMessageReader *>
848 second) {
849 if (std::get<0>(first) > std::get<0>(second)) {
850 return true;
851 } else if (std::get<0>(first) == std::get<0>(second)) {
852 if (std::get<1>(first) > std::get<1>(second)) {
853 return true;
854 } else if (std::get<1>(first) == std::get<1>(second)) {
855 return std::get<2>(first) > std::get<2>(second);
856 } else {
857 return false;
858 }
859 } else {
860 return false;
861 }
862}
863
Austin Schuh05b70472020-01-01 17:11:17 -0800864bool ChannelHeapCompare(
865 const std::pair<monotonic_clock::time_point, int> first,
866 const std::pair<monotonic_clock::time_point, int> second) {
867 if (first.first > second.first) {
868 return true;
869 } else if (first.first == second.first) {
870 return first.second > second.second;
871 } else {
872 return false;
873 }
874}
875
876} // namespace
877
Austin Schuh6f3babe2020-01-26 20:34:50 -0800878TimestampMerger::TimestampMerger(
879 const Configuration *configuration,
880 std::vector<SplitMessageReader *> split_message_readers, int channel_index,
881 const Node *target_node, ChannelMerger *channel_merger)
882 : configuration_(configuration),
883 split_message_readers_(std::move(split_message_readers)),
884 channel_index_(channel_index),
885 node_index_(configuration::MultiNode(configuration)
886 ? configuration::GetNodeIndex(configuration, target_node)
887 : -1),
888 channel_merger_(channel_merger) {
889 // Tell the readers we care so they know who to notify.
Austin Schuhcde938c2020-02-02 17:30:07 -0800890 VLOG(1) << "Configuring channel " << channel_index << " target node "
891 << FlatbufferToJson(target_node);
Austin Schuh6f3babe2020-01-26 20:34:50 -0800892 for (SplitMessageReader *reader : split_message_readers_) {
893 reader->SetTimestampMerger(this, channel_index, target_node);
894 }
895
896 // And then determine if we need to track timestamps.
897 const Channel *channel = configuration->channels()->Get(channel_index);
898 if (!configuration::ChannelIsSendableOnNode(channel, target_node) &&
899 configuration::ChannelIsReadableOnNode(channel, target_node)) {
900 has_timestamps_ = true;
901 }
902}
903
904void TimestampMerger::PushMessageHeap(
Austin Schuhcde938c2020-02-02 17:30:07 -0800905 std::tuple<monotonic_clock::time_point, uint32_t, const MessageHeader *>
906 timestamp,
Austin Schuh6f3babe2020-01-26 20:34:50 -0800907 SplitMessageReader *split_message_reader) {
Austin Schuh2f8fd752020-09-01 22:38:28 -0700908 if (split_message_reader != nullptr) {
909 DCHECK(std::find_if(message_heap_.begin(), message_heap_.end(),
910 [split_message_reader](
911 const std::tuple<monotonic_clock::time_point,
912 uint32_t, SplitMessageReader *>
913 x) {
914 return std::get<2>(x) == split_message_reader;
915 }) == message_heap_.end())
916 << ": Pushing message when it is already in the heap.";
Austin Schuh6f3babe2020-01-26 20:34:50 -0800917
Austin Schuh2f8fd752020-09-01 22:38:28 -0700918 message_heap_.push_back(std::make_tuple(
919 std::get<0>(timestamp), std::get<1>(timestamp), split_message_reader));
Austin Schuh6f3babe2020-01-26 20:34:50 -0800920
Austin Schuh2f8fd752020-09-01 22:38:28 -0700921 std::push_heap(message_heap_.begin(), message_heap_.end(),
922 &SplitMessageReaderHeapCompare);
923 }
Austin Schuh6f3babe2020-01-26 20:34:50 -0800924
925 // If we are just a data merger, don't wait for timestamps.
926 if (!has_timestamps_) {
Austin Schuh2f8fd752020-09-01 22:38:28 -0700927 if (!message_heap_.empty()) {
928 channel_merger_->Update(std::get<0>(message_heap_[0]), channel_index_);
929 pushed_ = true;
930 } else {
931 // Remove ourselves if we are empty.
932 channel_merger_->Update(monotonic_clock::min_time, channel_index_);
933 }
Austin Schuh6f3babe2020-01-26 20:34:50 -0800934 }
935}
936
Austin Schuhcde938c2020-02-02 17:30:07 -0800937std::tuple<monotonic_clock::time_point, uint32_t, const MessageHeader *>
938TimestampMerger::oldest_message() const {
939 CHECK_GT(message_heap_.size(), 0u);
940 std::tuple<monotonic_clock::time_point, uint32_t, SplitMessageReader *>
941 oldest_message_reader = message_heap_.front();
942 return std::get<2>(oldest_message_reader)->oldest_message(channel_index_);
943}
944
945std::tuple<monotonic_clock::time_point, uint32_t, const MessageHeader *>
946TimestampMerger::oldest_timestamp() const {
947 CHECK_GT(timestamp_heap_.size(), 0u);
948 std::tuple<monotonic_clock::time_point, uint32_t, SplitMessageReader *>
949 oldest_message_reader = timestamp_heap_.front();
950 return std::get<2>(oldest_message_reader)
951 ->oldest_message(channel_index_, node_index_);
952}
953
Austin Schuh6f3babe2020-01-26 20:34:50 -0800954void TimestampMerger::PushTimestampHeap(
Austin Schuhcde938c2020-02-02 17:30:07 -0800955 std::tuple<monotonic_clock::time_point, uint32_t, const MessageHeader *>
956 timestamp,
Austin Schuh6f3babe2020-01-26 20:34:50 -0800957 SplitMessageReader *split_message_reader) {
Austin Schuh2f8fd752020-09-01 22:38:28 -0700958 if (split_message_reader != nullptr) {
959 DCHECK(std::find_if(timestamp_heap_.begin(), timestamp_heap_.end(),
960 [split_message_reader](
961 const std::tuple<monotonic_clock::time_point,
962 uint32_t, SplitMessageReader *>
963 x) {
964 return std::get<2>(x) == split_message_reader;
965 }) == timestamp_heap_.end())
966 << ": Pushing timestamp when it is already in the heap.";
Austin Schuh6f3babe2020-01-26 20:34:50 -0800967
Austin Schuh2f8fd752020-09-01 22:38:28 -0700968 timestamp_heap_.push_back(std::make_tuple(
969 std::get<0>(timestamp), std::get<1>(timestamp), split_message_reader));
Austin Schuh6f3babe2020-01-26 20:34:50 -0800970
Austin Schuh2f8fd752020-09-01 22:38:28 -0700971 std::push_heap(timestamp_heap_.begin(), timestamp_heap_.end(),
972 SplitMessageReaderHeapCompare);
973 }
Austin Schuh6f3babe2020-01-26 20:34:50 -0800974
975 // If we are a timestamp merger, don't wait for data. Missing data will be
976 // caught at read time.
977 if (has_timestamps_) {
Austin Schuh2f8fd752020-09-01 22:38:28 -0700978 if (!timestamp_heap_.empty()) {
979 channel_merger_->Update(std::get<0>(timestamp_heap_[0]), channel_index_);
980 pushed_ = true;
981 } else {
982 // Remove ourselves if we are empty.
983 channel_merger_->Update(monotonic_clock::min_time, channel_index_);
984 }
Austin Schuh6f3babe2020-01-26 20:34:50 -0800985 }
986}
987
988std::tuple<monotonic_clock::time_point, uint32_t,
989 FlatbufferVector<MessageHeader>>
990TimestampMerger::PopMessageHeap() {
991 // Pop the oldest message reader pointer off the heap.
992 CHECK_GT(message_heap_.size(), 0u);
993 std::tuple<monotonic_clock::time_point, uint32_t, SplitMessageReader *>
994 oldest_message_reader = message_heap_.front();
995
996 std::pop_heap(message_heap_.begin(), message_heap_.end(),
997 &SplitMessageReaderHeapCompare);
998 message_heap_.pop_back();
999
1000 // Pop the oldest message. This re-pushes any messages from the reader to the
1001 // message heap.
1002 std::tuple<monotonic_clock::time_point, uint32_t,
1003 FlatbufferVector<MessageHeader>>
1004 oldest_message =
1005 std::get<2>(oldest_message_reader)->PopOldest(channel_index_);
1006
1007 // Confirm that the time and queue_index we have recorded matches.
1008 CHECK_EQ(std::get<0>(oldest_message), std::get<0>(oldest_message_reader));
1009 CHECK_EQ(std::get<1>(oldest_message), std::get<1>(oldest_message_reader));
1010
1011 // Now, keep reading until we have found all duplicates.
Brian Silverman8a32ce62020-08-12 12:02:38 -07001012 while (!message_heap_.empty()) {
Austin Schuh6f3babe2020-01-26 20:34:50 -08001013 // See if it is a duplicate.
1014 std::tuple<monotonic_clock::time_point, uint32_t, SplitMessageReader *>
1015 next_oldest_message_reader = message_heap_.front();
1016
Austin Schuhcde938c2020-02-02 17:30:07 -08001017 std::tuple<monotonic_clock::time_point, uint32_t, const MessageHeader *>
1018 next_oldest_message_time = std::get<2>(next_oldest_message_reader)
1019 ->oldest_message(channel_index_);
Austin Schuh6f3babe2020-01-26 20:34:50 -08001020
1021 if (std::get<0>(next_oldest_message_time) == std::get<0>(oldest_message) &&
1022 std::get<1>(next_oldest_message_time) == std::get<1>(oldest_message)) {
1023 // Pop the message reader pointer.
1024 std::pop_heap(message_heap_.begin(), message_heap_.end(),
1025 &SplitMessageReaderHeapCompare);
1026 message_heap_.pop_back();
1027
1028 // Pop the next oldest message. This re-pushes any messages from the
1029 // reader.
1030 std::tuple<monotonic_clock::time_point, uint32_t,
1031 FlatbufferVector<MessageHeader>>
1032 next_oldest_message = std::get<2>(next_oldest_message_reader)
1033 ->PopOldest(channel_index_);
1034
1035 // And make sure the message matches in it's entirety.
1036 CHECK(std::get<2>(oldest_message).span() ==
1037 std::get<2>(next_oldest_message).span())
1038 << ": Data at the same timestamp doesn't match.";
1039 } else {
1040 break;
1041 }
1042 }
1043
1044 return oldest_message;
1045}
1046
1047std::tuple<monotonic_clock::time_point, uint32_t,
1048 FlatbufferVector<MessageHeader>>
1049TimestampMerger::PopTimestampHeap() {
1050 // Pop the oldest message reader pointer off the heap.
1051 CHECK_GT(timestamp_heap_.size(), 0u);
1052
1053 std::tuple<monotonic_clock::time_point, uint32_t, SplitMessageReader *>
1054 oldest_timestamp_reader = timestamp_heap_.front();
1055
1056 std::pop_heap(timestamp_heap_.begin(), timestamp_heap_.end(),
1057 &SplitMessageReaderHeapCompare);
1058 timestamp_heap_.pop_back();
1059
1060 CHECK(node_index_ != -1) << ": Timestamps in a single node environment";
1061
1062 // Pop the oldest message. This re-pushes any timestamps from the reader to
1063 // the timestamp heap.
1064 std::tuple<monotonic_clock::time_point, uint32_t,
1065 FlatbufferVector<MessageHeader>>
1066 oldest_timestamp = std::get<2>(oldest_timestamp_reader)
Austin Schuh2f8fd752020-09-01 22:38:28 -07001067 ->PopOldestTimestamp(channel_index_, node_index_);
Austin Schuh6f3babe2020-01-26 20:34:50 -08001068
1069 // Confirm that the time we have recorded matches.
1070 CHECK_EQ(std::get<0>(oldest_timestamp), std::get<0>(oldest_timestamp_reader));
1071 CHECK_EQ(std::get<1>(oldest_timestamp), std::get<1>(oldest_timestamp_reader));
1072
Austin Schuh2f8fd752020-09-01 22:38:28 -07001073 // Now, keep reading until we have found all duplicates.
1074 while (!timestamp_heap_.empty()) {
1075 // See if it is a duplicate.
1076 std::tuple<monotonic_clock::time_point, uint32_t, SplitMessageReader *>
1077 next_oldest_timestamp_reader = timestamp_heap_.front();
Austin Schuh6f3babe2020-01-26 20:34:50 -08001078
Austin Schuh2f8fd752020-09-01 22:38:28 -07001079 std::tuple<monotonic_clock::time_point, uint32_t, const MessageHeader *>
1080 next_oldest_timestamp_time =
1081 std::get<2>(next_oldest_timestamp_reader)
1082 ->oldest_message(channel_index_, node_index_);
Austin Schuh6f3babe2020-01-26 20:34:50 -08001083
Austin Schuh2f8fd752020-09-01 22:38:28 -07001084 if (std::get<0>(next_oldest_timestamp_time) ==
1085 std::get<0>(oldest_timestamp) &&
1086 std::get<1>(next_oldest_timestamp_time) ==
1087 std::get<1>(oldest_timestamp)) {
1088 // Pop the timestamp reader pointer.
1089 std::pop_heap(timestamp_heap_.begin(), timestamp_heap_.end(),
1090 &SplitMessageReaderHeapCompare);
1091 timestamp_heap_.pop_back();
1092
1093 // Pop the next oldest timestamp. This re-pushes any messages from the
1094 // reader.
1095 std::tuple<monotonic_clock::time_point, uint32_t,
1096 FlatbufferVector<MessageHeader>>
1097 next_oldest_timestamp =
1098 std::get<2>(next_oldest_timestamp_reader)
1099 ->PopOldestTimestamp(channel_index_, node_index_);
1100
1101 // And make sure the contents matches in it's entirety.
1102 CHECK(std::get<2>(oldest_timestamp).span() ==
1103 std::get<2>(next_oldest_timestamp).span())
1104 << ": Data at the same timestamp doesn't match, "
1105 << aos::FlatbufferToJson(std::get<2>(oldest_timestamp)) << " vs "
1106 << aos::FlatbufferToJson(std::get<2>(next_oldest_timestamp)) << " "
1107 << absl::BytesToHexString(std::string_view(
1108 reinterpret_cast<const char *>(
1109 std::get<2>(oldest_timestamp).span().data()),
1110 std::get<2>(oldest_timestamp).span().size()))
1111 << " vs "
1112 << absl::BytesToHexString(std::string_view(
1113 reinterpret_cast<const char *>(
1114 std::get<2>(next_oldest_timestamp).span().data()),
1115 std::get<2>(next_oldest_timestamp).span().size()));
1116
1117 } else {
1118 break;
1119 }
Austin Schuh8bd96322020-02-13 21:18:22 -08001120 }
1121
Austin Schuh2f8fd752020-09-01 22:38:28 -07001122 return oldest_timestamp;
Austin Schuh8bd96322020-02-13 21:18:22 -08001123}
1124
Austin Schuh6f3babe2020-01-26 20:34:50 -08001125std::tuple<TimestampMerger::DeliveryTimestamp, FlatbufferVector<MessageHeader>>
1126TimestampMerger::PopOldest() {
1127 if (has_timestamps_) {
Austin Schuh2f8fd752020-09-01 22:38:28 -07001128 VLOG(1) << "Looking for matching timestamp for "
1129 << configuration::StrippedChannelToString(
1130 configuration_->channels()->Get(channel_index_))
1131 << " (" << channel_index_ << ") "
1132 << " at " << std::get<0>(oldest_timestamp());
1133
Austin Schuh8bd96322020-02-13 21:18:22 -08001134 // Read the timestamps.
Austin Schuh6f3babe2020-01-26 20:34:50 -08001135 std::tuple<monotonic_clock::time_point, uint32_t,
1136 FlatbufferVector<MessageHeader>>
1137 oldest_timestamp = PopTimestampHeap();
1138
1139 TimestampMerger::DeliveryTimestamp timestamp;
1140 timestamp.monotonic_event_time =
1141 monotonic_clock::time_point(chrono::nanoseconds(
1142 std::get<2>(oldest_timestamp).message().monotonic_sent_time()));
1143 timestamp.realtime_event_time =
1144 realtime_clock::time_point(chrono::nanoseconds(
1145 std::get<2>(oldest_timestamp).message().realtime_sent_time()));
Austin Schuh8d7e0bb2020-10-02 17:57:00 -07001146 timestamp.queue_index =
1147 std::get<2>(oldest_timestamp).message().queue_index();
Austin Schuh6f3babe2020-01-26 20:34:50 -08001148
1149 // Consistency check.
1150 CHECK_EQ(timestamp.monotonic_event_time, std::get<0>(oldest_timestamp));
1151 CHECK_EQ(std::get<2>(oldest_timestamp).message().queue_index(),
1152 std::get<1>(oldest_timestamp));
1153
1154 monotonic_clock::time_point remote_timestamp_monotonic_time(
1155 chrono::nanoseconds(
1156 std::get<2>(oldest_timestamp).message().monotonic_remote_time()));
1157
Austin Schuh8bd96322020-02-13 21:18:22 -08001158 // See if we have any data. If not, pass the problem up the chain.
Brian Silverman8a32ce62020-08-12 12:02:38 -07001159 if (message_heap_.empty()) {
Austin Schuhee711052020-08-24 16:06:09 -07001160 LOG(WARNING) << MaybeNodeName(configuration_->nodes()->Get(node_index_))
1161 << "No data to match timestamp on "
1162 << configuration::CleanedChannelToString(
1163 configuration_->channels()->Get(channel_index_))
1164 << " (" << channel_index_ << ")";
Austin Schuh8bd96322020-02-13 21:18:22 -08001165 return std::make_tuple(timestamp,
1166 std::move(std::get<2>(oldest_timestamp)));
1167 }
1168
Austin Schuh6f3babe2020-01-26 20:34:50 -08001169 while (true) {
Austin Schuhcde938c2020-02-02 17:30:07 -08001170 {
1171 // Ok, now try grabbing data until we find one which matches.
1172 std::tuple<monotonic_clock::time_point, uint32_t, const MessageHeader *>
1173 oldest_message_ref = oldest_message();
1174
1175 // Time at which the message was sent (this message is written from the
1176 // sending node's perspective.
1177 monotonic_clock::time_point remote_monotonic_time(chrono::nanoseconds(
1178 std::get<2>(oldest_message_ref)->monotonic_sent_time()));
1179
1180 if (remote_monotonic_time < remote_timestamp_monotonic_time) {
Austin Schuhee711052020-08-24 16:06:09 -07001181 LOG(WARNING) << configuration_->nodes()
1182 ->Get(node_index_)
1183 ->name()
1184 ->string_view()
1185 << " Undelivered message, skipping. Remote time is "
1186 << remote_monotonic_time << " timestamp is "
1187 << remote_timestamp_monotonic_time << " on channel "
1188 << configuration::StrippedChannelToString(
1189 configuration_->channels()->Get(channel_index_))
1190 << " (" << channel_index_ << ")";
Austin Schuhcde938c2020-02-02 17:30:07 -08001191 PopMessageHeap();
1192 continue;
1193 } else if (remote_monotonic_time > remote_timestamp_monotonic_time) {
Austin Schuhee711052020-08-24 16:06:09 -07001194 LOG(WARNING) << configuration_->nodes()
1195 ->Get(node_index_)
1196 ->name()
1197 ->string_view()
1198 << " Data not found. Remote time should be "
1199 << remote_timestamp_monotonic_time
1200 << ", message time is " << remote_monotonic_time
1201 << " on channel "
1202 << configuration::StrippedChannelToString(
1203 configuration_->channels()->Get(channel_index_))
Austin Schuh2f8fd752020-09-01 22:38:28 -07001204 << " (" << channel_index_ << ")"
1205 << (VLOG_IS_ON(1) ? DebugString() : "");
Austin Schuhcde938c2020-02-02 17:30:07 -08001206 return std::make_tuple(timestamp,
1207 std::move(std::get<2>(oldest_timestamp)));
1208 }
1209
1210 timestamp.monotonic_remote_time = remote_monotonic_time;
1211 }
1212
Austin Schuh2f8fd752020-09-01 22:38:28 -07001213 VLOG(1) << "Found matching data "
1214 << configuration::StrippedChannelToString(
1215 configuration_->channels()->Get(channel_index_))
1216 << " (" << channel_index_ << ")";
Austin Schuh6f3babe2020-01-26 20:34:50 -08001217 std::tuple<monotonic_clock::time_point, uint32_t,
1218 FlatbufferVector<MessageHeader>>
1219 oldest_message = PopMessageHeap();
1220
Austin Schuh6f3babe2020-01-26 20:34:50 -08001221 timestamp.realtime_remote_time =
1222 realtime_clock::time_point(chrono::nanoseconds(
1223 std::get<2>(oldest_message).message().realtime_sent_time()));
1224 timestamp.remote_queue_index =
1225 std::get<2>(oldest_message).message().queue_index();
1226
Austin Schuhcde938c2020-02-02 17:30:07 -08001227 CHECK_EQ(timestamp.monotonic_remote_time,
1228 remote_timestamp_monotonic_time);
1229
1230 CHECK_EQ(timestamp.remote_queue_index,
1231 std::get<2>(oldest_timestamp).message().remote_queue_index())
1232 << ": " << FlatbufferToJson(&std::get<2>(oldest_timestamp).message())
1233 << " data "
1234 << FlatbufferToJson(&std::get<2>(oldest_message).message());
Austin Schuh6f3babe2020-01-26 20:34:50 -08001235
Austin Schuh30dd5c52020-08-01 14:43:44 -07001236 return std::make_tuple(timestamp, std::move(std::get<2>(oldest_message)));
Austin Schuh6f3babe2020-01-26 20:34:50 -08001237 }
1238 } else {
1239 std::tuple<monotonic_clock::time_point, uint32_t,
1240 FlatbufferVector<MessageHeader>>
1241 oldest_message = PopMessageHeap();
1242
1243 TimestampMerger::DeliveryTimestamp timestamp;
1244 timestamp.monotonic_event_time =
1245 monotonic_clock::time_point(chrono::nanoseconds(
1246 std::get<2>(oldest_message).message().monotonic_sent_time()));
1247 timestamp.realtime_event_time =
1248 realtime_clock::time_point(chrono::nanoseconds(
1249 std::get<2>(oldest_message).message().realtime_sent_time()));
Austin Schuh8d7e0bb2020-10-02 17:57:00 -07001250 timestamp.queue_index = std::get<2>(oldest_message).message().queue_index();
Austin Schuh6f3babe2020-01-26 20:34:50 -08001251 timestamp.remote_queue_index = 0xffffffff;
1252
1253 CHECK_EQ(std::get<0>(oldest_message), timestamp.monotonic_event_time);
1254 CHECK_EQ(std::get<1>(oldest_message),
1255 std::get<2>(oldest_message).message().queue_index());
1256
Austin Schuh30dd5c52020-08-01 14:43:44 -07001257 return std::make_tuple(timestamp, std::move(std::get<2>(oldest_message)));
Austin Schuh6f3babe2020-01-26 20:34:50 -08001258 }
1259}
1260
Austin Schuh8bd96322020-02-13 21:18:22 -08001261void TimestampMerger::NoticeAtEnd() { channel_merger_->NoticeAtEnd(); }
1262
Austin Schuh6f3babe2020-01-26 20:34:50 -08001263namespace {
1264std::vector<std::unique_ptr<SplitMessageReader>> MakeSplitMessageReaders(
1265 const std::vector<std::vector<std::string>> &filenames) {
1266 CHECK_GT(filenames.size(), 0u);
1267 // Build up all the SplitMessageReaders.
1268 std::vector<std::unique_ptr<SplitMessageReader>> result;
1269 for (const std::vector<std::string> &filenames : filenames) {
1270 result.emplace_back(std::make_unique<SplitMessageReader>(filenames));
1271 }
1272 return result;
1273}
1274} // namespace
1275
1276ChannelMerger::ChannelMerger(
1277 const std::vector<std::vector<std::string>> &filenames)
1278 : split_message_readers_(MakeSplitMessageReaders(filenames)),
Austin Schuh97789fc2020-08-01 14:42:45 -07001279 log_file_header_(split_message_readers_[0]->raw_log_file_header()) {
Austin Schuh6f3babe2020-01-26 20:34:50 -08001280 // Now, confirm that the configuration matches for each and pick a start time.
1281 // Also return the list of possible nodes.
1282 for (const std::unique_ptr<SplitMessageReader> &reader :
1283 split_message_readers_) {
1284 CHECK(CompareFlatBuffer(log_file_header_.message().configuration(),
1285 reader->log_file_header()->configuration()))
1286 << ": Replaying log files with different configurations isn't "
1287 "supported";
1288 }
1289
1290 nodes_ = configuration::GetNodes(configuration());
1291}
1292
1293bool ChannelMerger::SetNode(const Node *target_node) {
1294 std::vector<SplitMessageReader *> split_message_readers;
1295 for (const std::unique_ptr<SplitMessageReader> &reader :
1296 split_message_readers_) {
1297 split_message_readers.emplace_back(reader.get());
1298 }
1299
1300 // Go find a log_file_header for this node.
1301 {
1302 bool found_node = false;
1303
1304 for (const std::unique_ptr<SplitMessageReader> &reader :
1305 split_message_readers_) {
James Kuszmaulfc273dc2020-05-09 17:56:19 -07001306 // In order to identify which logfile(s) map to the target node, do a
1307 // logical comparison of the nodes, by confirming that we are either in a
1308 // single-node setup (where the nodes will both be nullptr) or that the
1309 // node names match (but the other node fields--e.g., hostname lists--may
1310 // not).
1311 const bool both_null =
1312 reader->node() == nullptr && target_node == nullptr;
1313 const bool both_have_name =
1314 (reader->node() != nullptr) && (target_node != nullptr) &&
1315 (reader->node()->has_name() && target_node->has_name());
1316 const bool node_names_identical =
Brian Silvermand90905f2020-09-23 14:42:56 -07001317 both_have_name && (reader->node()->name()->string_view() ==
1318 target_node->name()->string_view());
James Kuszmaulfc273dc2020-05-09 17:56:19 -07001319 if (both_null || node_names_identical) {
Austin Schuh6f3babe2020-01-26 20:34:50 -08001320 if (!found_node) {
1321 found_node = true;
1322 log_file_header_ = CopyFlatBuffer(reader->log_file_header());
Austin Schuhcde938c2020-02-02 17:30:07 -08001323 VLOG(1) << "Found log file " << reader->filename() << " with node "
1324 << FlatbufferToJson(reader->node()) << " start_time "
1325 << monotonic_start_time();
Austin Schuh6f3babe2020-01-26 20:34:50 -08001326 } else {
Austin Schuh2f8fd752020-09-01 22:38:28 -07001327 // Find the earliest start time. That way, if we get a full log file
1328 // directly from the node, and a partial later, we start with the
1329 // full. Update our header to match that.
1330 const monotonic_clock::time_point new_monotonic_start_time(
1331 chrono::nanoseconds(
1332 reader->log_file_header()->monotonic_start_time()));
1333 const realtime_clock::time_point new_realtime_start_time(
1334 chrono::nanoseconds(
1335 reader->log_file_header()->realtime_start_time()));
1336
1337 if (monotonic_start_time() == monotonic_clock::min_time ||
1338 (new_monotonic_start_time != monotonic_clock::min_time &&
1339 new_monotonic_start_time < monotonic_start_time())) {
1340 log_file_header_.mutable_message()->mutate_monotonic_start_time(
1341 new_monotonic_start_time.time_since_epoch().count());
1342 log_file_header_.mutable_message()->mutate_realtime_start_time(
1343 new_realtime_start_time.time_since_epoch().count());
1344 VLOG(1) << "Updated log file " << reader->filename()
1345 << " with node " << FlatbufferToJson(reader->node())
1346 << " start_time " << new_monotonic_start_time;
1347 }
Austin Schuh6f3babe2020-01-26 20:34:50 -08001348 }
1349 }
1350 }
1351
1352 if (!found_node) {
1353 LOG(WARNING) << "Failed to find log file for node "
1354 << FlatbufferToJson(target_node);
1355 return false;
1356 }
1357 }
1358
1359 // Build up all the timestamp mergers. This connects up all the
1360 // SplitMessageReaders.
1361 timestamp_mergers_.reserve(configuration()->channels()->size());
1362 for (size_t channel_index = 0;
1363 channel_index < configuration()->channels()->size(); ++channel_index) {
1364 timestamp_mergers_.emplace_back(
1365 configuration(), split_message_readers, channel_index,
1366 configuration::GetNode(configuration(), target_node), this);
1367 }
1368
1369 // And prime everything.
Austin Schuh6f3babe2020-01-26 20:34:50 -08001370 for (std::unique_ptr<SplitMessageReader> &split_message_reader :
1371 split_message_readers_) {
Austin Schuhcde938c2020-02-02 17:30:07 -08001372 split_message_reader->QueueMessages(
1373 split_message_reader->monotonic_start_time());
Austin Schuh6f3babe2020-01-26 20:34:50 -08001374 }
1375
1376 node_ = configuration::GetNodeOrDie(configuration(), target_node);
1377 return true;
1378}
1379
Austin Schuh858c9f32020-08-31 16:56:12 -07001380monotonic_clock::time_point ChannelMerger::OldestMessageTime() const {
Brian Silverman8a32ce62020-08-12 12:02:38 -07001381 if (channel_heap_.empty()) {
Austin Schuh6f3babe2020-01-26 20:34:50 -08001382 return monotonic_clock::max_time;
1383 }
1384 return channel_heap_.front().first;
1385}
1386
1387void ChannelMerger::PushChannelHeap(monotonic_clock::time_point timestamp,
1388 int channel_index) {
1389 // Pop and recreate the heap if it has already been pushed. And since we are
1390 // pushing again, we don't need to clear pushed.
1391 if (timestamp_mergers_[channel_index].pushed()) {
Brian Silverman8a32ce62020-08-12 12:02:38 -07001392 const auto channel_iterator = std::find_if(
Austin Schuh6f3babe2020-01-26 20:34:50 -08001393 channel_heap_.begin(), channel_heap_.end(),
1394 [channel_index](const std::pair<monotonic_clock::time_point, int> x) {
1395 return x.second == channel_index;
Brian Silverman8a32ce62020-08-12 12:02:38 -07001396 });
1397 DCHECK(channel_iterator != channel_heap_.end());
1398 if (std::get<0>(*channel_iterator) == timestamp) {
1399 // It's already in the heap, in the correct spot, so nothing
1400 // more for us to do here.
1401 return;
1402 }
1403 channel_heap_.erase(channel_iterator);
Austin Schuh6f3babe2020-01-26 20:34:50 -08001404 std::make_heap(channel_heap_.begin(), channel_heap_.end(),
1405 ChannelHeapCompare);
1406 }
1407
Austin Schuh2f8fd752020-09-01 22:38:28 -07001408 if (timestamp == monotonic_clock::min_time) {
1409 timestamp_mergers_[channel_index].set_pushed(false);
1410 return;
1411 }
1412
Austin Schuh05b70472020-01-01 17:11:17 -08001413 channel_heap_.push_back(std::make_pair(timestamp, channel_index));
1414
1415 // The default sort puts the newest message first. Use a custom comparator to
1416 // put the oldest message first.
1417 std::push_heap(channel_heap_.begin(), channel_heap_.end(),
1418 ChannelHeapCompare);
1419}
1420
Austin Schuh2f8fd752020-09-01 22:38:28 -07001421void ChannelMerger::VerifyHeaps() {
Austin Schuh661a8d82020-09-13 17:25:56 -07001422 std::vector<std::pair<monotonic_clock::time_point, int>> channel_heap =
1423 channel_heap_;
1424 std::make_heap(channel_heap.begin(), channel_heap.end(), &ChannelHeapCompare);
Austin Schuh2f8fd752020-09-01 22:38:28 -07001425
Austin Schuh661a8d82020-09-13 17:25:56 -07001426 for (size_t i = 0; i < channel_heap_.size(); ++i) {
1427 CHECK(channel_heap_[i] == channel_heap[i]) << ": Heaps diverged...";
1428 CHECK_EQ(
1429 std::get<0>(channel_heap[i]),
1430 timestamp_mergers_[std::get<1>(channel_heap[i])].channel_merger_time());
Austin Schuh2f8fd752020-09-01 22:38:28 -07001431 }
1432}
1433
Austin Schuh6f3babe2020-01-26 20:34:50 -08001434std::tuple<TimestampMerger::DeliveryTimestamp, int,
1435 FlatbufferVector<MessageHeader>>
1436ChannelMerger::PopOldest() {
Austin Schuh8bd96322020-02-13 21:18:22 -08001437 CHECK_GT(channel_heap_.size(), 0u);
Austin Schuh05b70472020-01-01 17:11:17 -08001438 std::pair<monotonic_clock::time_point, int> oldest_channel_data =
1439 channel_heap_.front();
Austin Schuh6f3babe2020-01-26 20:34:50 -08001440 int channel_index = oldest_channel_data.second;
Austin Schuh05b70472020-01-01 17:11:17 -08001441 std::pop_heap(channel_heap_.begin(), channel_heap_.end(),
1442 &ChannelHeapCompare);
1443 channel_heap_.pop_back();
Austin Schuh8bd96322020-02-13 21:18:22 -08001444
Austin Schuh6f3babe2020-01-26 20:34:50 -08001445 timestamp_mergers_[channel_index].set_pushed(false);
Austin Schuh05b70472020-01-01 17:11:17 -08001446
Austin Schuh6f3babe2020-01-26 20:34:50 -08001447 TimestampMerger *merger = &timestamp_mergers_[channel_index];
Austin Schuh05b70472020-01-01 17:11:17 -08001448
Austin Schuhcde938c2020-02-02 17:30:07 -08001449 // Merger handles any queueing needed from here.
Austin Schuh6f3babe2020-01-26 20:34:50 -08001450 std::tuple<TimestampMerger::DeliveryTimestamp,
1451 FlatbufferVector<MessageHeader>>
1452 message = merger->PopOldest();
Brian Silverman8a32ce62020-08-12 12:02:38 -07001453 DCHECK_EQ(std::get<0>(message).monotonic_event_time,
1454 oldest_channel_data.first)
1455 << ": channel_heap_ was corrupted for " << channel_index << ": "
1456 << DebugString();
Austin Schuh05b70472020-01-01 17:11:17 -08001457
Austin Schuh2f8fd752020-09-01 22:38:28 -07001458 CHECK_GE(std::get<0>(message).monotonic_event_time, last_popped_time_)
1459 << ": " << MaybeNodeName(log_file_header()->node())
1460 << "Messages came off the queue out of order. " << DebugString();
1461 last_popped_time_ = std::get<0>(message).monotonic_event_time;
1462
1463 VLOG(1) << "Popped " << last_popped_time_ << " "
1464 << configuration::StrippedChannelToString(
1465 configuration()->channels()->Get(channel_index))
1466 << " (" << channel_index << ")";
1467
Austin Schuh6f3babe2020-01-26 20:34:50 -08001468 return std::make_tuple(std::get<0>(message), channel_index,
1469 std::move(std::get<1>(message)));
1470}
1471
Austin Schuhcde938c2020-02-02 17:30:07 -08001472std::string SplitMessageReader::MessageHeaderQueue::DebugString() const {
1473 std::stringstream ss;
1474 for (size_t i = 0; i < data_.size(); ++i) {
Austin Schuh2f8fd752020-09-01 22:38:28 -07001475 if (i < 5 || i + 5 > data_.size()) {
1476 if (timestamps) {
1477 ss << " msg: ";
1478 } else {
1479 ss << " timestamp: ";
1480 }
1481 ss << monotonic_clock::time_point(
1482 chrono::nanoseconds(data_[i].message().monotonic_sent_time()))
Austin Schuhcde938c2020-02-02 17:30:07 -08001483 << " ("
Austin Schuh2f8fd752020-09-01 22:38:28 -07001484 << realtime_clock::time_point(
1485 chrono::nanoseconds(data_[i].message().realtime_sent_time()))
1486 << ") " << data_[i].message().queue_index();
1487 if (timestamps) {
1488 ss << " <- remote "
1489 << monotonic_clock::time_point(chrono::nanoseconds(
1490 data_[i].message().monotonic_remote_time()))
1491 << " ("
1492 << realtime_clock::time_point(chrono::nanoseconds(
1493 data_[i].message().realtime_remote_time()))
1494 << ")";
1495 }
1496 ss << "\n";
1497 } else if (i == 5) {
1498 ss << " ...\n";
Austin Schuh6f3babe2020-01-26 20:34:50 -08001499 }
Austin Schuhcde938c2020-02-02 17:30:07 -08001500 }
Austin Schuh6f3babe2020-01-26 20:34:50 -08001501
Austin Schuhcde938c2020-02-02 17:30:07 -08001502 return ss.str();
1503}
Austin Schuh6f3babe2020-01-26 20:34:50 -08001504
Austin Schuhcde938c2020-02-02 17:30:07 -08001505std::string SplitMessageReader::DebugString(int channel) const {
1506 std::stringstream ss;
1507 ss << "[\n";
1508 ss << channels_[channel].data.DebugString();
1509 ss << " ]";
1510 return ss.str();
1511}
Austin Schuh6f3babe2020-01-26 20:34:50 -08001512
Austin Schuhcde938c2020-02-02 17:30:07 -08001513std::string SplitMessageReader::DebugString(int channel, int node_index) const {
1514 std::stringstream ss;
1515 ss << "[\n";
1516 ss << channels_[channel].timestamps[node_index].DebugString();
1517 ss << " ]";
1518 return ss.str();
1519}
1520
1521std::string TimestampMerger::DebugString() const {
1522 std::stringstream ss;
1523
1524 if (timestamp_heap_.size() > 0) {
1525 ss << " timestamp_heap {\n";
1526 std::vector<
1527 std::tuple<monotonic_clock::time_point, uint32_t, SplitMessageReader *>>
1528 timestamp_heap = timestamp_heap_;
1529 while (timestamp_heap.size() > 0u) {
1530 std::tuple<monotonic_clock::time_point, uint32_t, SplitMessageReader *>
1531 oldest_timestamp_reader = timestamp_heap.front();
1532
1533 ss << " " << std::get<2>(oldest_timestamp_reader) << " "
1534 << std::get<0>(oldest_timestamp_reader) << " queue_index ("
1535 << std::get<1>(oldest_timestamp_reader) << ") ttq "
1536 << std::get<2>(oldest_timestamp_reader)->time_to_queue() << " "
1537 << std::get<2>(oldest_timestamp_reader)->filename() << " -> "
1538 << std::get<2>(oldest_timestamp_reader)
1539 ->DebugString(channel_index_, node_index_)
1540 << "\n";
1541
1542 std::pop_heap(timestamp_heap.begin(), timestamp_heap.end(),
1543 &SplitMessageReaderHeapCompare);
1544 timestamp_heap.pop_back();
1545 }
1546 ss << " }\n";
1547 }
1548
1549 ss << " message_heap {\n";
1550 {
1551 std::vector<
1552 std::tuple<monotonic_clock::time_point, uint32_t, SplitMessageReader *>>
1553 message_heap = message_heap_;
Brian Silverman8a32ce62020-08-12 12:02:38 -07001554 while (!message_heap.empty()) {
Austin Schuhcde938c2020-02-02 17:30:07 -08001555 std::tuple<monotonic_clock::time_point, uint32_t, SplitMessageReader *>
1556 oldest_message_reader = message_heap.front();
1557
1558 ss << " " << std::get<2>(oldest_message_reader) << " "
1559 << std::get<0>(oldest_message_reader) << " queue_index ("
1560 << std::get<1>(oldest_message_reader) << ") ttq "
1561 << std::get<2>(oldest_message_reader)->time_to_queue() << " "
1562 << std::get<2>(oldest_message_reader)->filename() << " -> "
1563 << std::get<2>(oldest_message_reader)->DebugString(channel_index_)
1564 << "\n";
1565
1566 std::pop_heap(message_heap.begin(), message_heap.end(),
1567 &SplitMessageReaderHeapCompare);
1568 message_heap.pop_back();
Austin Schuh6f3babe2020-01-26 20:34:50 -08001569 }
Austin Schuh05b70472020-01-01 17:11:17 -08001570 }
Austin Schuhcde938c2020-02-02 17:30:07 -08001571 ss << " }";
1572
1573 return ss.str();
1574}
1575
1576std::string ChannelMerger::DebugString() const {
1577 std::stringstream ss;
1578 ss << "start_time " << realtime_start_time() << " " << monotonic_start_time()
1579 << "\n";
1580 ss << "channel_heap {\n";
1581 std::vector<std::pair<monotonic_clock::time_point, int>> channel_heap =
1582 channel_heap_;
Brian Silverman8a32ce62020-08-12 12:02:38 -07001583 while (!channel_heap.empty()) {
Austin Schuhcde938c2020-02-02 17:30:07 -08001584 std::tuple<monotonic_clock::time_point, int> channel = channel_heap.front();
1585 ss << " " << std::get<0>(channel) << " (" << std::get<1>(channel) << ") "
1586 << configuration::CleanedChannelToString(
1587 configuration()->channels()->Get(std::get<1>(channel)))
1588 << "\n";
1589
1590 ss << timestamp_mergers_[std::get<1>(channel)].DebugString() << "\n";
1591
1592 std::pop_heap(channel_heap.begin(), channel_heap.end(),
1593 &ChannelHeapCompare);
1594 channel_heap.pop_back();
1595 }
1596 ss << "}";
1597
1598 return ss.str();
Austin Schuh05b70472020-01-01 17:11:17 -08001599}
1600
Austin Schuhee711052020-08-24 16:06:09 -07001601std::string MaybeNodeName(const Node *node) {
1602 if (node != nullptr) {
1603 return node->name()->str() + " ";
1604 }
1605 return "";
1606}
1607
Brian Silvermanf51499a2020-09-21 12:49:08 -07001608} // namespace aos::logger