Merge "logd: add tests for log deduplication" am: 0a6c83e7d0 (a4f37b2e) · Commits · e / os / android_system_core

logd/Android.bp

+1 −4

Original line number	Diff line number	Diff line
		@@ -125,10 +125,7 @@ cc_defaults {
		"-Wextra",
		"-Werror",
		"-fno-builtin",

		"-DAUDITD_LOG_TAG=1003",
		"-DCHATTY_LOG_TAG=1004",
		],
		] + event_flag,

		srcs: [
		"logd_test.cpp",

logd/ChattyLogBuffer.cpp

+2 −1

Original line number	Diff line number	Diff line
		@@ -28,6 +28,7 @@
		#include <time.h>
		#include <unistd.h>

		#include <limits>
		#include <unordered_map>
		#include <utility>

		@@ -286,7 +287,7 @@ int ChattyLogBuffer::Log(log_id_t log_id, log_time realtime, uid_t uid, pid_t pi
		lastLoggedElements[LOG_ID_EVENTS] = elem;
		total += htole32(swab);
		// check for overflow
		if (total >= UINT32_MAX) {
		if (total >= std::numeric_limits<int32_t>::max()) {
		log(currentLast);
		unlock();
		return len;

logd/LogBufferTest.cpp

+334 −101

Original line number	Diff line number	Diff line
		@@ -18,7 +18,9 @@

		#include <unistd.h>

		#include <limits>
		#include <memory>
		#include <regex>
		#include <vector>

		#include <android-base/stringprintf.h>
		@@ -34,6 +36,7 @@
		#include "LogWriter.h"

		using android::base::Join;
		using android::base::Split;
		using android::base::StringPrintf;

		#ifndef __ANDROID__
		@@ -58,52 +61,19 @@ char* android::uidToName(uid_t) {
		return nullptr;
		}

		class TestWriter : public LogWriter {
		public:
		TestWriter(std::vector<std::pair<logger_entry, std::string>>* msgs, bool* released)
		: LogWriter(0, true, true), msgs_(msgs), released_(released) {}
		bool Write(const logger_entry& entry, const char* message) override {
		msgs_->emplace_back(entry, std::string(message, entry.len));
		return true;
		}

		void Release() {
		if (released_) *released_ = true;
		}

		std::string name() const override { return "test_writer"; }

		private:
		std::vector<std::pair<logger_entry, std::string>>* msgs_;
		bool* released_;
		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.
		};

		class LogBufferTest : public testing::Test {
		protected:
		void SetUp() override {
		log_buffer_.reset(new ChattyLogBuffer(&reader_list_, &tags_, &prune_, &stats_));
		}

		void FixupMessages(std::vector<std::pair<logger_entry, std::string>>* messages) {
		for (auto& [entry, message] : *messages) {
		entry.hdr_size = sizeof(logger_entry);
		entry.len = message.size();
		}
		}

		void LogMessages(const std::vector<std::pair<logger_entry, std::string>>& messages) {
		for (auto& [entry, message] : messages) {
		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());
		}
		}

		std::vector<std::string> CompareLoggerEntries(const logger_entry& expected,
		const logger_entry& result) {
		const logger_entry& result, bool ignore_len) {
		std::vector<std::string> errors;
		if (expected.len != result.len) {
		if (!ignore_len && expected.len != result.len) {
		errors.emplace_back(
		StringPrintf("len: %" PRIu16 " vs %" PRIu16, expected.len, result.len));
		StringPrintf("len: expected %" PRIu16 " vs %" PRIu16, expected.len, result.len));
		}
		if (expected.hdr_size != result.hdr_size) {
		errors.emplace_back(StringPrintf("hdr_size: %" PRIu16 " vs %" PRIu16, expected.hdr_size,
		@@ -111,42 +81,50 @@ class LogBufferTest : public testing::Test {
		}
		if (expected.pid != result.pid) {
		errors.emplace_back(
		StringPrintf("pid: %" PRIi32 " vs %" PRIi32, expected.pid, result.pid));
		StringPrintf("pid: expected %" PRIi32 " vs %" PRIi32, expected.pid, result.pid));
		}
		if (expected.tid != result.tid) {
		errors.emplace_back(
		StringPrintf("tid: %" PRIu32 " vs %" PRIu32, expected.tid, result.tid));
		StringPrintf("tid: expected %" PRIu32 " vs %" PRIu32, expected.tid, result.tid));
		}
		if (expected.sec != result.sec) {
		errors.emplace_back(
		StringPrintf("sec: %" PRIu32 " vs %" PRIu32, expected.sec, result.sec));
		StringPrintf("sec: expected %" PRIu32 " vs %" PRIu32, expected.sec, result.sec));
		}
		if (expected.nsec != result.nsec) {
		errors.emplace_back(
		StringPrintf("nsec: %" PRIu32 " vs %" PRIu32, expected.nsec, result.nsec));
		StringPrintf("nsec: expected %" PRIu32 " vs %" PRIu32, expected.nsec, result.nsec));
		}
		if (expected.lid != result.lid) {
		errors.emplace_back(
		StringPrintf("lid: %" PRIu32 " vs %" PRIu32, expected.lid, result.lid));
		StringPrintf("lid: expected %" PRIu32 " vs %" PRIu32, expected.lid, result.lid));
		}
		if (expected.uid != result.uid) {
		errors.emplace_back(
		StringPrintf("uid: %" PRIu32 " vs %" PRIu32, expected.uid, result.uid));
		StringPrintf("uid: expected %" PRIu32 " vs %" PRIu32, expected.uid, result.uid));
		}
		return errors;
		}

		std::string MakePrintable(std::string in) {
		if (in.size() > 80) {
		in = in.substr(0, 80) + "...";
		}
		std::string result;
		for (const char c : in) {
		if (isprint(c)) {
		result.push_back(c);
		} else {
		result.append(StringPrintf("\\%02x", static_cast<int>(c) & 0xFF));
		}
		}
		return result;
		}

		std::string CompareMessages(const std::string& expected, const std::string& result) {
		if (expected == result) {
		return {};
		}
		auto shorten_string = [](const std::string& in) {
		if (in.size() > 10) {
		return in.substr(0, 10) + "...";
		}
		return in;
		};

		size_t diff_index = 0;
		for (; diff_index < std::min(expected.size(), result.size()); ++diff_index) {
		if (expected[diff_index] != result[diff_index]) {
		@@ -155,36 +133,110 @@ class LogBufferTest : public testing::Test {
		}

		if (diff_index < 10) {
		auto expected_short = shorten_string(expected);
		auto result_short = shorten_string(result);
		return StringPrintf("msg: %s vs %s", expected_short.c_str(), result_short.c_str());
		auto expected_short = MakePrintable(expected);
		auto result_short = MakePrintable(result);
		return StringPrintf("msg: expected '%s' vs '%s'", expected_short.c_str(),
		result_short.c_str());
		}

		auto expected_short = shorten_string(expected.substr(diff_index));
		auto result_short = shorten_string(result.substr(diff_index));
		return StringPrintf("msg: index %zu: %s vs %s", diff_index, expected_short.c_str(),
		auto expected_short = MakePrintable(expected.substr(diff_index));
		auto result_short = MakePrintable(result.substr(diff_index));
		return StringPrintf("msg: index %zu: expected '%s' vs '%s'", diff_index, expected_short.c_str(),
		result_short.c_str());
		}

		void CompareLogMessages(const std::vector<std::pair<logger_entry, std::string>>& expected,
		const std::vector<std::pair<logger_entry, std::string>>& result) {
		std::string CompareRegexMessages(const std::string& expected, const std::string& result) {
		auto expected_pieces = Split(expected, std::string("\0", 1));
		auto result_pieces = Split(result, std::string("\0", 1));

		if (expected_pieces.size() != 3 \|\| result_pieces.size() != 3) {
		return StringPrintf(
		"msg: should have 3 null delimited strings found %d in expected, %d in result: "
		"'%s' vs '%s'",
		static_cast<int>(expected_pieces.size()), static_cast<int>(result_pieces.size()),
		MakePrintable(expected).c_str(), MakePrintable(result).c_str());
		}
		if (expected_pieces[0] != result_pieces[0]) {
		return StringPrintf("msg: tag/priority mismatch expected '%s' vs '%s'",
		MakePrintable(expected_pieces[0]).c_str(),
		MakePrintable(result_pieces[0]).c_str());
		}
		std::regex expected_tag_regex(expected_pieces[1]);
		if (!std::regex_search(result_pieces[1], expected_tag_regex)) {
		return StringPrintf("msg: message regex mismatch expected '%s' vs '%s'",
		MakePrintable(expected_pieces[1]).c_str(),
		MakePrintable(result_pieces[1]).c_str());
		}
		if (expected_pieces[2] != result_pieces[2]) {
		return StringPrintf("msg: nothing expected after final null character '%s' vs '%s'",
		MakePrintable(expected_pieces[2]).c_str(),
		MakePrintable(result_pieces[2]).c_str());
		}
		return {};
		}

		void CompareLogMessages(const std::vector<LogMessage>& expected,
		const std::vector<LogMessage>& result) {
		EXPECT_EQ(expected.size(), result.size());
		size_t end = std::min(expected.size(), result.size());
		size_t num_errors = 0;
		for (size_t i = 0; i < end; ++i) {
		auto errors = CompareLoggerEntries(expected[i].first, result[i].first);
		auto msg_error = CompareMessages(expected[i].second, result[i].second);
		auto errors =
		CompareLoggerEntries(expected[i].entry, result[i].entry, expected[i].regex_compare);
		auto msg_error = expected[i].regex_compare
		? CompareRegexMessages(expected[i].message, result[i].message)
		: CompareMessages(expected[i].message, result[i].message);
		if (!msg_error.empty()) {
		errors.emplace_back(msg_error);
		}
		if (!errors.empty()) {
		GTEST_LOG_(ERROR) << "Mismatch log message " << i << " " << Join(errors, " ");
		GTEST_LOG_(ERROR) << "Mismatch log message " << i << "\n" << Join(errors, "\n");
		++num_errors;
		}
		}
		EXPECT_EQ(0U, num_errors);
		}

		class TestWriter : public LogWriter {
		public:
		TestWriter(std::vector<LogMessage>* msgs, bool* released)
		: LogWriter(0, true, true), msgs_(msgs), released_(released) {}
		bool Write(const logger_entry& entry, const char* message) override {
		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::vector<LogMessage>* msgs_;
		bool* released_;
		};

		class LogBufferTest : public testing::Test {
		protected:
		void SetUp() override {
		log_buffer_.reset(new ChattyLogBuffer(&reader_list_, &tags_, &prune_, &stats_));
		}

		void FixupMessages(std::vector<LogMessage>* messages) {
		for (auto& [entry, message, _] : *messages) {
		entry.hdr_size = sizeof(logger_entry);
		entry.len = message.size();
		}
		}

		void LogMessages(const std::vector<LogMessage>& messages) {
		for (auto& [entry, message, _] : messages) {
		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());
		}
		}

		LogReaderList reader_list_;
		LogTags tags_;
		PruneList prune_;
		@@ -193,7 +245,7 @@ class LogBufferTest : public testing::Test {
		};

		TEST_F(LogBufferTest, smoke) {
		std::vector<std::pair<logger_entry, std::string>> log_messages = {
		std::vector<LogMessage> log_messages = {
		{{
		.pid = 1,
		.tid = 1,
		@@ -207,7 +259,7 @@ TEST_F(LogBufferTest, smoke) {
		FixupMessages(&log_messages);
		LogMessages(log_messages);

		std::vector<std::pair<logger_entry, std::string>> read_log_messages;
		std::vector<LogMessage> read_log_messages;
		std::unique_ptr<LogWriter> test_writer(new TestWriter(&read_log_messages, nullptr));
		uint64_t flush_result = log_buffer_->FlushTo(test_writer.get(), 1, nullptr, nullptr);
		EXPECT_EQ(1ULL, flush_result);
		@@ -215,7 +267,7 @@ TEST_F(LogBufferTest, smoke) {
		}

		TEST_F(LogBufferTest, smoke_with_reader_thread) {
		std::vector<std::pair<logger_entry, std::string>> log_messages = {
		std::vector<LogMessage> log_messages = {
		{{.pid = 1, .tid = 2, .sec = 10000, .nsec = 20001, .lid = LOG_ID_MAIN, .uid = 0},
		"first"},
		{{.pid = 10, .tid = 2, .sec = 10000, .nsec = 20002, .lid = LOG_ID_MAIN, .uid = 0},
		@@ -240,7 +292,7 @@ TEST_F(LogBufferTest, smoke_with_reader_thread) {
		FixupMessages(&log_messages);
		LogMessages(log_messages);

		std::vector<std::pair<logger_entry, std::string>> read_log_messages;
		std::vector<LogMessage> read_log_messages;
		bool released = false;

		{
		@@ -264,7 +316,7 @@ TEST_F(LogBufferTest, smoke_with_reader_thread) {

		// Generate random messages, set the 'sec' parameter explicit though, to be able to track the
		// expected order of messages.
		std::pair<logger_entry, std::string> GenerateRandomLogMessage(uint32_t sec) {
		LogMessage GenerateRandomLogMessage(uint32_t sec) {
		auto rand_uint32 = [](int max) -> uint32_t { return rand() % max; };
		logger_entry entry = {
		.hdr_size = sizeof(logger_entry),
		@@ -308,13 +360,13 @@ std::pair<logger_entry, std::string> GenerateRandomLogMessage(uint32_t sec) {

		TEST_F(LogBufferTest, random_messages) {
		srand(1);
		std::vector<std::pair<logger_entry, std::string>> log_messages;
		std::vector<LogMessage> log_messages;
		for (size_t i = 0; i < 1000; ++i) {
		log_messages.emplace_back(GenerateRandomLogMessage(i));
		}
		LogMessages(log_messages);

		std::vector<std::pair<logger_entry, std::string>> read_log_messages;
		std::vector<LogMessage> read_log_messages;
		bool released = false;

		{
		@@ -335,3 +387,184 @@ TEST_F(LogBufferTest, random_messages) {
		}
		CompareLogMessages(log_messages, read_log_messages);
		}

		TEST_F(LogBufferTest, deduplication_simple) {
		auto make_message = [&](uint32_t sec, const char* tag, const char* msg,
		bool regex = false) -> LogMessage {
		logger_entry entry = {
		.pid = 1, .tid = 1, .sec = sec, .nsec = 1, .lid = LOG_ID_MAIN, .uid = 0};
		std::string message;
		message.push_back(ANDROID_LOG_INFO);
		message.append(tag);
		message.push_back('\0');
		message.append(msg);
		message.push_back('\0');
		return {entry, message, regex};
		};

		// clang-format off
		std::vector<LogMessage> log_messages = {
		make_message(0, "test_tag", "duplicate"),
		make_message(1, "test_tag", "duplicate"),
		make_message(2, "test_tag", "not_same"),
		make_message(3, "test_tag", "duplicate"),
		make_message(4, "test_tag", "duplicate"),
		make_message(5, "test_tag", "not_same"),
		make_message(6, "test_tag", "duplicate"),
		make_message(7, "test_tag", "duplicate"),
		make_message(8, "test_tag", "duplicate"),
		make_message(9, "test_tag", "not_same"),
		make_message(10, "test_tag", "duplicate"),
		make_message(11, "test_tag", "duplicate"),
		make_message(12, "test_tag", "duplicate"),
		make_message(13, "test_tag", "duplicate"),
		make_message(14, "test_tag", "duplicate"),
		make_message(15, "test_tag", "duplicate"),
		make_message(16, "test_tag", "not_same"),
		make_message(100, "test_tag", "duplicate"),
		make_message(200, "test_tag", "duplicate"),
		make_message(300, "test_tag", "duplicate"),
		};
		// clang-format on
		FixupMessages(&log_messages);
		LogMessages(log_messages);

		std::vector<LogMessage> read_log_messages;
		std::unique_ptr<LogWriter> test_writer(new TestWriter(&read_log_messages, nullptr));
		log_buffer_->FlushTo(test_writer.get(), 1, nullptr, nullptr);

		std::vector<LogMessage> expected_log_messages = {
		make_message(0, "test_tag", "duplicate"),
		make_message(1, "test_tag", "duplicate"),
		make_message(2, "test_tag", "not_same"),
		make_message(3, "test_tag", "duplicate"),
		make_message(4, "test_tag", "duplicate"),
		make_message(5, "test_tag", "not_same"),
		// 3 duplicate logs together print the first, a 1 count chatty message, then the last.
		make_message(6, "test_tag", "duplicate"),
		make_message(7, "chatty", "uid=0\\([^\\)]+\\) [^ ]+ expire 1 line", true),
		make_message(8, "test_tag", "duplicate"),
		make_message(9, "test_tag", "not_same"),
		// 6 duplicate logs together print the first, a 4 count chatty message, then the last.
		make_message(10, "test_tag", "duplicate"),
		make_message(14, "chatty", "uid=0\\([^\\)]+\\) [^ ]+ expire 4 lines", true),
		make_message(15, "test_tag", "duplicate"),
		make_message(16, "test_tag", "not_same"),
		// duplicate logs > 1 minute apart are not deduplicated.
		make_message(100, "test_tag", "duplicate"),
		make_message(200, "test_tag", "duplicate"),
		make_message(300, "test_tag", "duplicate"),
		};
		FixupMessages(&expected_log_messages);
		CompareLogMessages(expected_log_messages, read_log_messages);
		};

		TEST_F(LogBufferTest, deduplication_overflow) {
		auto make_message = [&](uint32_t sec, const char* tag, const char* msg,
		bool regex = false) -> LogMessage {
		logger_entry entry = {
		.pid = 1, .tid = 1, .sec = sec, .nsec = 1, .lid = LOG_ID_MAIN, .uid = 0};
		std::string message;
		message.push_back(ANDROID_LOG_INFO);
		message.append(tag);
		message.push_back('\0');
		message.append(msg);
		message.push_back('\0');
		return {entry, message, regex};
		};

		uint32_t sec = 0;
		std::vector<LogMessage> log_messages = {
		make_message(sec++, "test_tag", "normal"),
		};
		size_t expired_per_chatty_message = std::numeric_limits<uint16_t>::max();
		for (size_t i = 0; i < expired_per_chatty_message + 3; ++i) {
		log_messages.emplace_back(make_message(sec++, "test_tag", "duplicate"));
		}
		log_messages.emplace_back(make_message(sec++, "test_tag", "normal"));
		FixupMessages(&log_messages);
		LogMessages(log_messages);

		std::vector<LogMessage> read_log_messages;
		std::unique_ptr<LogWriter> test_writer(new TestWriter(&read_log_messages, nullptr));
		log_buffer_->FlushTo(test_writer.get(), 1, nullptr, nullptr);

		std::vector<LogMessage> expected_log_messages = {
		make_message(0, "test_tag", "normal"),
		make_message(1, "test_tag", "duplicate"),
		make_message(expired_per_chatty_message + 1, "chatty",
		"uid=0\\([^\\)]+\\) [^ ]+ expire 65535 lines", true),
		make_message(expired_per_chatty_message + 2, "chatty",
		"uid=0\\([^\\)]+\\) [^ ]+ expire 1 line", true),
		make_message(expired_per_chatty_message + 3, "test_tag", "duplicate"),
		make_message(expired_per_chatty_message + 4, "test_tag", "normal"),
		};
		FixupMessages(&expected_log_messages);
		CompareLogMessages(expected_log_messages, read_log_messages);
		}

		TEST_F(LogBufferTest, deduplication_liblog) {
		auto make_message = [&](uint32_t sec, int32_t tag, int32_t count) -> LogMessage {
		logger_entry entry = {
		.pid = 1, .tid = 1, .sec = sec, .nsec = 1, .lid = LOG_ID_EVENTS, .uid = 0};
		android_log_event_int_t liblog_event = {
		.header.tag = tag, .payload.type = EVENT_TYPE_INT, .payload.data = count};
		return {entry, std::string(reinterpret_cast<char*>(&liblog_event), sizeof(liblog_event)),
		false};
		};

		// LIBLOG_LOG_TAG
		std::vector<LogMessage> log_messages = {
		make_message(0, 1234, 1),
		make_message(1, LIBLOG_LOG_TAG, 3),
		make_message(2, 1234, 2),
		make_message(3, LIBLOG_LOG_TAG, 3),
		make_message(4, LIBLOG_LOG_TAG, 4),
		make_message(5, 1234, 223),
		make_message(6, LIBLOG_LOG_TAG, 2),
		make_message(7, LIBLOG_LOG_TAG, 3),
		make_message(8, LIBLOG_LOG_TAG, 4),
		make_message(9, 1234, 227),
		make_message(10, LIBLOG_LOG_TAG, 1),
		make_message(11, LIBLOG_LOG_TAG, 3),
		make_message(12, LIBLOG_LOG_TAG, 2),
		make_message(13, LIBLOG_LOG_TAG, 3),
		make_message(14, LIBLOG_LOG_TAG, 5),
		make_message(15, 1234, 227),
		make_message(16, LIBLOG_LOG_TAG, 2),
		make_message(17, LIBLOG_LOG_TAG, std::numeric_limits<int32_t>::max()),
		make_message(18, LIBLOG_LOG_TAG, 3),
		make_message(19, LIBLOG_LOG_TAG, 5),
		make_message(20, 1234, 227),
		};
		FixupMessages(&log_messages);
		LogMessages(log_messages);

		std::vector<LogMessage> read_log_messages;
		std::unique_ptr<LogWriter> test_writer(new TestWriter(&read_log_messages, nullptr));
		log_buffer_->FlushTo(test_writer.get(), 1, nullptr, nullptr);

		std::vector<LogMessage> expected_log_messages = {
		make_message(0, 1234, 1),
		make_message(1, LIBLOG_LOG_TAG, 3),
		make_message(2, 1234, 2),
		make_message(3, LIBLOG_LOG_TAG, 3),
		make_message(4, LIBLOG_LOG_TAG, 4),
		make_message(5, 1234, 223),
		// More than 2 liblog events (3 here), sum their value into the third message.
		make_message(6, LIBLOG_LOG_TAG, 2),
		make_message(8, LIBLOG_LOG_TAG, 7),
		make_message(9, 1234, 227),
		// More than 2 liblog events (5 here), sum their value into the third message.
		make_message(10, LIBLOG_LOG_TAG, 1),
		make_message(14, LIBLOG_LOG_TAG, 13),
		make_message(15, 1234, 227),
		// int32_t max is the max for a chatty message, beyond that we must use new messages.
		make_message(16, LIBLOG_LOG_TAG, 2),
		make_message(17, LIBLOG_LOG_TAG, std::numeric_limits<int32_t>::max()),
		make_message(19, LIBLOG_LOG_TAG, 8),
		make_message(20, 1234, 227),
		};
		FixupMessages(&expected_log_messages);
		CompareLogMessages(expected_log_messages, read_log_messages);
		};
		No newline at end of file