// Copyright 2020 The Pigweed Authors // // Licensed under the Apache License, Version 2.0 (the "License"); you may not // use this file except in compliance with the License. You may obtain a copy of // the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the // License for the specific language governing permissions and limitations under // the License. #include "pw_tokenizer/tokenize.h" #include #include #include #include #include #include "gtest/gtest.h" #include "pw_tokenizer/hash.h" #include "pw_tokenizer_private/tokenize_test.h" #include "pw_varint/varint.h" namespace pw::tokenizer { namespace { // Constructs an array with the hashed string followed by the provided bytes. template constexpr auto ExpectedData( const char (&format)[kSize], uint32_t token_mask = std::numeric_limits::max()) { const uint32_t value = Hash(format) & token_mask; return std::array{ static_cast(value & 0xff), static_cast(value >> 8 & 0xff), static_cast(value >> 16 & 0xff), static_cast(value >> 24 & 0xff), kData...}; } TEST(TokenizeString, EmptyString_IsZero) { constexpr pw_tokenizer_Token token = PW_TOKENIZE_STRING(""); EXPECT_EQ(0u, token); } TEST(TokenizeString, String_MatchesHash) { constexpr uint32_t token = PW_TOKENIZE_STRING("[:-)"); EXPECT_EQ(Hash("[:-)"), token); } constexpr uint32_t kGlobalToken = PW_TOKENIZE_STRING(">:-[]"); TEST(TokenizeString, GlobalVariable_MatchesHash) { EXPECT_EQ(Hash(">:-[]"), kGlobalToken); } struct TokenizedWithinClass { static constexpr uint32_t kThisToken = PW_TOKENIZE_STRING("???"); }; static_assert(Hash("???") == TokenizedWithinClass::kThisToken); TEST(TokenizeString, ClassMember_MatchesHash) { EXPECT_EQ(Hash("???"), TokenizedWithinClass().kThisToken); } TEST(TokenizeString, Mask) { [[maybe_unused]] constexpr uint32_t token = PW_TOKENIZE_STRING("(O_o)"); [[maybe_unused]] constexpr uint32_t masked_1 = PW_TOKENIZE_STRING_MASK("domain", 0xAAAAAAAA, "(O_o)"); [[maybe_unused]] constexpr uint32_t masked_2 = PW_TOKENIZE_STRING_MASK("domain", 0x55555555, "(O_o)"); [[maybe_unused]] constexpr uint32_t masked_3 = PW_TOKENIZE_STRING_MASK("domain", 0xFFFF0000, "(O_o)"); static_assert(token != masked_1 && token != masked_2 && token != masked_3); static_assert(masked_1 != masked_2 && masked_2 != masked_3); static_assert((token & 0xAAAAAAAA) == masked_1); static_assert((token & 0x55555555) == masked_2); static_assert((token & 0xFFFF0000) == masked_3); } // Use a function with a shorter name to test tokenizing __func__ and // __PRETTY_FUNCTION__. // // WARNING: This function might cause errors for compilers other than GCC and // clang. It relies on two GCC/clang extensions: // // 1 - The __PRETTY_FUNCTION__ C++ function name variable. // 2 - __func__ as a static constexpr array instead of static const. See // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=66639 for background. // void TestName() { constexpr uint32_t function_hash = PW_TOKENIZE_STRING(__func__); EXPECT_EQ(pw::tokenizer::Hash(__func__), function_hash); // Check the non-standard __PRETTY_FUNCTION__ name. constexpr uint32_t pretty_function = PW_TOKENIZE_STRING(__PRETTY_FUNCTION__); EXPECT_EQ(pw::tokenizer::Hash(__PRETTY_FUNCTION__), pretty_function); } TEST(TokenizeString, FunctionName) { TestName(); } TEST(TokenizeString, Array) { constexpr char array[] = "won-won-won-wonderful"; const uint32_t array_hash = PW_TOKENIZE_STRING(array); EXPECT_EQ(Hash(array), array_hash); } TEST(TokenizeString, NullInString) { // Use PW_TOKENIZER_STRING_TOKEN to avoid emitting strings with NUL into the // ELF file. The CSV database format does not support NUL. constexpr char nulls[32] = {}; static_assert(Hash(nulls) == PW_TOKENIZER_STRING_TOKEN(nulls)); static_assert(PW_TOKENIZER_STRING_TOKEN(nulls) != 0u); static_assert(PW_TOKENIZER_STRING_TOKEN("\0") == Hash("\0")); static_assert(PW_TOKENIZER_STRING_TOKEN("\0") != Hash("")); static_assert(PW_TOKENIZER_STRING_TOKEN("abc\0def") == Hash("abc\0def")); static_assert(Hash("abc\0def") != Hash("abc\0def\0")); } // Verify that we can tokenize multiple strings from one source line. #define THREE_FOR_ONE(first, second, third) \ [[maybe_unused]] constexpr uint32_t token_1 = \ PW_TOKENIZE_STRING_DOMAIN("TEST_DOMAIN", first); \ [[maybe_unused]] constexpr uint32_t token_2 = \ PW_TOKENIZE_STRING_DOMAIN("TEST_DOMAIN", second); \ [[maybe_unused]] constexpr uint32_t token_3 = \ PW_TOKENIZE_STRING_DOMAIN("TEST_DOMAIN", third); TEST(TokenizeString, MultipleTokenizationsInOneMacroExpansion) { // This verifies that we can safely tokenize multiple times in a single macro // expansion. This can be useful when for example a name and description are // both tokenized after being passed into a macro. // // This test only verifies that this compiles correctly; it does not test // that the tokenizations make it to the final token database. THREE_FOR_ONE("hello", "yes", "something"); } class TokenizeToBuffer : public ::testing::Test { public: TokenizeToBuffer() : buffer_{} {} protected: uint8_t buffer_[64]; }; TEST_F(TokenizeToBuffer, Integer64) { size_t message_size = 14; PW_TOKENIZE_TO_BUFFER( buffer_, &message_size, "%" PRIu64, static_cast(0x55555555'55555555ull)); // 0xAAAAAAAA'AAAAAAAA // Pattern becomes 10101010'11010101'10101010 ... constexpr std::array expected = ExpectedData<0xAA, 0xD5, 0xAA, 0xD5, 0xAA, 0xD5, 0xAA, 0xD5, 0xAA, 0x01>( "%" PRIu64); ASSERT_EQ(expected.size(), message_size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, Integer64Overflow) { size_t message_size; for (size_t size = 4; size < 20; ++size) { message_size = size; PW_TOKENIZE_TO_BUFFER( buffer_, &message_size, "%" PRIx64, static_cast(std::numeric_limits::min())); if (size < 14) { constexpr std::array empty = ExpectedData("%" PRIx64); ASSERT_EQ(sizeof(uint32_t), message_size); EXPECT_EQ(std::memcmp(empty.data(), &buffer_, empty.size()), 0); // Make sure nothing was written past the end of the buffer. EXPECT_TRUE(std::all_of(&buffer_[size], std::end(buffer_), [](uint8_t v) { return v == '\0'; })); } else { constexpr std::array expected = ExpectedData<0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x01>("%" PRIx64); ASSERT_EQ(expected.size(), message_size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } } } TEST_F(TokenizeToBuffer, IntegerNegative) { size_t message_size = 9; PW_TOKENIZE_TO_BUFFER( buffer_, &message_size, "%" PRId32, std::numeric_limits::min()); // 0x8000'0000 -zig-zag-> 0xff'ff'ff'ff'0f constexpr std::array expected = ExpectedData<0xff, 0xff, 0xff, 0xff, 0x0f>("%" PRId32); ASSERT_EQ(expected.size(), message_size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, IntegerMin) { size_t message_size = 9; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "%d", -1); constexpr std::array expected = ExpectedData<0x01>("%d"); ASSERT_EQ(expected.size(), message_size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, IntegerDoesntFit) { size_t message_size = 8; PW_TOKENIZE_TO_BUFFER( buffer_, &message_size, "%" PRId32, std::numeric_limits::min()); constexpr std::array expected = ExpectedData<>("%" PRId32); ASSERT_EQ(expected.size(), message_size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, String) { size_t message_size = sizeof(buffer_); PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "The answer is: %s", "5432!"); constexpr std::array expected = ExpectedData<5, '5', '4', '3', '2', '!'>("The answer is: %s"); ASSERT_EQ(expected.size(), message_size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, String_BufferTooSmall_TruncatesAndSetsTopStatusBit) { size_t message_size = 8; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "The answer is: %s", "5432!"); constexpr std::array truncated_1 = ExpectedData<0x83, '5', '4', '3'>("The answer is: %s"); ASSERT_EQ(truncated_1.size(), message_size); EXPECT_EQ(std::memcmp(truncated_1.data(), buffer_, truncated_1.size()), 0); } TEST_F(TokenizeToBuffer, String_TwoBytesLeft_TruncatesToOneCharacter) { size_t message_size = 6; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "The answer is: %s", "5432!"); constexpr std::array truncated_2 = ExpectedData<0x81, '5'>("The answer is: %s"); ASSERT_EQ(truncated_2.size(), message_size); EXPECT_EQ(std::memcmp(truncated_2.data(), buffer_, truncated_2.size()), 0); } TEST_F(TokenizeToBuffer, String_OneByteLeft_OnlyWritesTruncatedStatusByte) { size_t message_size = 5; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "The answer is: %s", "5432!"); std::array result = ExpectedData<0x80>("The answer is: %s"); ASSERT_EQ(result.size(), message_size); EXPECT_EQ(std::memcmp(result.data(), buffer_, result.size()), 0); } TEST_F(TokenizeToBuffer, EmptyString_OneByteLeft_EncodesCorrectly) { size_t message_size = 5; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "The answer is: %s", ""); std::array result = ExpectedData<0>("The answer is: %s"); ASSERT_EQ(result.size(), message_size); EXPECT_EQ(std::memcmp(result.data(), buffer_, result.size()), 0); } TEST_F(TokenizeToBuffer, String_ZeroBytesLeft_WritesNothing) { size_t message_size = 4; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "The answer is: %s", "5432!"); constexpr std::array empty = ExpectedData<>("The answer is: %s"); ASSERT_EQ(empty.size(), message_size); EXPECT_EQ(std::memcmp(empty.data(), buffer_, empty.size()), 0); } TEST_F(TokenizeToBuffer, Array) { static constexpr char array[] = "1234"; size_t message_size = 4; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, array); constexpr std::array result = ExpectedData<>("1234"); ASSERT_EQ(result.size(), message_size); EXPECT_EQ(std::memcmp(result.data(), buffer_, result.size()), 0); } TEST_F(TokenizeToBuffer, NullptrString_EncodesNull) { char* string = nullptr; size_t message_size = 9; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "The answer is: %s", string); std::array result = ExpectedData<4, 'N', 'U', 'L', 'L'>("The answer is: %s"); ASSERT_EQ(result.size(), message_size); EXPECT_EQ(std::memcmp(result.data(), buffer_, result.size()), 0); } TEST_F(TokenizeToBuffer, NullptrString_BufferTooSmall_EncodesTruncatedNull) { char* string = nullptr; size_t message_size = 6; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "The answer is: %s", string); std::array result = ExpectedData<0x81, 'N'>("The answer is: %s"); ASSERT_EQ(result.size(), message_size); EXPECT_EQ(std::memcmp(result.data(), buffer_, result.size()), 0); } TEST_F(TokenizeToBuffer, Domain_String) { size_t message_size = sizeof(buffer_); PW_TOKENIZE_TO_BUFFER_DOMAIN( "TEST_DOMAIN", buffer_, &message_size, "The answer was: %s", "5432!"); constexpr std::array expected = ExpectedData<5, '5', '4', '3', '2', '!'>("The answer was: %s"); ASSERT_EQ(expected.size(), message_size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, Mask) { size_t message_size = sizeof(buffer_); PW_TOKENIZE_TO_BUFFER_MASK("TEST_DOMAIN", 0x0000FFFF, buffer_, &message_size, "The answer was: %s", "5432!"); constexpr std::array expected = ExpectedData<5, '5', '4', '3', '2', '!'>("The answer was: %s", 0x0000FFFF); ASSERT_EQ(expected.size(), message_size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, TruncateArgs) { // Args that can't fit are dropped completely size_t message_size = 6; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "%u %d", static_cast(0b0010'1010u), 0xffffff); constexpr std::array expected = ExpectedData<0b0101'0100u>("%u %d"); ASSERT_EQ(expected.size(), message_size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, NoRoomForToken) { // Nothing is written if there isn't room for the token. std::memset(buffer_, '$', sizeof(buffer_)); auto is_untouched = [](uint8_t v) { return v == '$'; }; size_t message_size = 3; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "The answer: \"%s\"", "5432!"); EXPECT_EQ(0u, message_size); EXPECT_TRUE(std::all_of(buffer_, std::end(buffer_), is_untouched)); message_size = 2; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "Jello, world!"); EXPECT_EQ(0u, message_size); EXPECT_TRUE(std::all_of(buffer_, std::end(buffer_), is_untouched)); message_size = 1; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "Jello!"); EXPECT_EQ(0u, message_size); EXPECT_TRUE(std::all_of(buffer_, std::end(buffer_), is_untouched)); message_size = 0; PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "Jello?"); EXPECT_EQ(0u, message_size); EXPECT_TRUE(std::all_of(buffer_, std::end(buffer_), is_untouched)); } TEST_F(TokenizeToBuffer, CharArray) { size_t message_size = sizeof(buffer_); PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, __func__); constexpr auto expected = ExpectedData(__func__); ASSERT_EQ(expected.size(), message_size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, C_StringShortFloat) { size_t size = sizeof(buffer_); pw_tokenizer_ToBufferTest_StringShortFloat(buffer_, &size); constexpr std::array expected = // clang-format off ExpectedData<1, '1', // string '1' 3, // -2 (zig-zag encoded) 0x00, 0x00, 0x40, 0x40 // 3.0 in floating point >(TEST_FORMAT_STRING_SHORT_FLOAT); ASSERT_EQ(expected.size(), size); // clang-format on EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, C_SequentialZigZag) { size_t size = sizeof(buffer_); pw_tokenizer_ToBufferTest_SequentialZigZag(buffer_, &size); constexpr std::array expected = ExpectedData<0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13>( TEST_FORMAT_SEQUENTIAL_ZIG_ZAG); ASSERT_EQ(expected.size(), size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); } TEST_F(TokenizeToBuffer, C_Overflow) { std::memset(buffer_, '$', sizeof(buffer_)); { size_t size = 7; pw_tokenizer_ToBufferTest_Requires8(buffer_, &size); constexpr std::array expected = ExpectedData<2, 'h', 'i'>(TEST_FORMAT_REQUIRES_8); ASSERT_EQ(expected.size(), size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); EXPECT_EQ(buffer_[7], '$'); } { size_t size = 8; pw_tokenizer_ToBufferTest_Requires8(buffer_, &size); constexpr std::array expected = ExpectedData<2, 'h', 'i', 13>(TEST_FORMAT_REQUIRES_8); ASSERT_EQ(expected.size(), size); EXPECT_EQ(std::memcmp(expected.data(), buffer_, expected.size()), 0); EXPECT_EQ(buffer_[8], '$'); } } // Test fixture for callback and global handler. Both of these need a global // message buffer. To keep the message buffers separate, template this on the // derived class type. template class GlobalMessage : public ::testing::Test { public: static void SetMessage(const uint8_t* message, size_t size) { ASSERT_LE(size, sizeof(message_)); std::memcpy(message_, message, size); message_size_bytes_ = size; } protected: GlobalMessage() { std::memset(message_, 0, sizeof(message_)); message_size_bytes_ = 0; } static uint8_t message_[256]; static size_t message_size_bytes_; }; template uint8_t GlobalMessage::message_[256] = {}; template size_t GlobalMessage::message_size_bytes_ = 0; class TokenizeToCallback : public GlobalMessage {}; TEST_F(TokenizeToCallback, Variety) { PW_TOKENIZE_TO_CALLBACK( SetMessage, "%s there are %x (%.2f) of them%c", "Now", 2u, 2.0f, '.'); const auto expected = // clang-format off ExpectedData<3, 'N', 'o', 'w', // string "Now" 0x04, // unsigned 2 (zig-zag encoded) 0x00, 0x00, 0x00, 0x40, // float 2.0 0x5C // char '.' (0x2E, zig-zag encoded) >("%s there are %x (%.2f) of them%c"); // clang-format on ASSERT_EQ(expected.size(), message_size_bytes_); EXPECT_EQ(std::memcmp(expected.data(), message_, expected.size()), 0); } TEST_F(TokenizeToCallback, Strings) { PW_TOKENIZE_TO_CALLBACK(SetMessage, "The answer is: %s", "5432!"); constexpr std::array expected = ExpectedData<5, '5', '4', '3', '2', '!'>("The answer is: %s"); ASSERT_EQ(expected.size(), message_size_bytes_); EXPECT_EQ(std::memcmp(expected.data(), message_, expected.size()), 0); } TEST_F(TokenizeToCallback, Domain_Strings) { PW_TOKENIZE_TO_CALLBACK_DOMAIN( "TEST_DOMAIN", SetMessage, "The answer is: %s", "5432!"); constexpr std::array expected = ExpectedData<5, '5', '4', '3', '2', '!'>("The answer is: %s"); ASSERT_EQ(expected.size(), message_size_bytes_); EXPECT_EQ(std::memcmp(expected.data(), message_, expected.size()), 0); } TEST_F(TokenizeToCallback, Mask) { PW_TOKENIZE_TO_CALLBACK_MASK( "TEST_DOMAIN", 0x00000FFF, SetMessage, "The answer is: %s", "5432!"); constexpr std::array expected = ExpectedData<5, '5', '4', '3', '2', '!'>("The answer is: %s", 0x00000FFF); ASSERT_EQ(expected.size(), message_size_bytes_); EXPECT_EQ(std::memcmp(expected.data(), message_, expected.size()), 0); } TEST_F(TokenizeToCallback, CharArray) { PW_TOKENIZE_TO_CALLBACK(SetMessage, __func__); constexpr auto expected = ExpectedData(__func__); ASSERT_EQ(expected.size(), message_size_bytes_); EXPECT_EQ(std::memcmp(expected.data(), message_, expected.size()), 0); } TEST_F(TokenizeToCallback, C_SequentialZigZag) { pw_tokenizer_ToCallbackTest_SequentialZigZag(SetMessage); constexpr std::array expected = ExpectedData<0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13>( TEST_FORMAT_SEQUENTIAL_ZIG_ZAG); ASSERT_EQ(expected.size(), message_size_bytes_); EXPECT_EQ(std::memcmp(expected.data(), message_, expected.size()), 0); } // Hijack an internal macro to capture the tokenizer domain. #undef _PW_TOKENIZER_RECORD_ORIGINAL_STRING #define _PW_TOKENIZER_RECORD_ORIGINAL_STRING(token, domain, string) \ tokenizer_domain = domain; \ string_literal = string TEST_F(TokenizeToBuffer, Domain_Default) { const char* tokenizer_domain = nullptr; const char* string_literal = nullptr; size_t message_size = sizeof(buffer_); PW_TOKENIZE_TO_BUFFER(buffer_, &message_size, "The answer is: %s", "5432!"); EXPECT_STREQ(tokenizer_domain, PW_TOKENIZER_DEFAULT_DOMAIN); EXPECT_STREQ(string_literal, "The answer is: %s"); } TEST_F(TokenizeToBuffer, Domain_Specified) { const char* tokenizer_domain = nullptr; const char* string_literal = nullptr; size_t message_size = sizeof(buffer_); PW_TOKENIZE_TO_BUFFER_DOMAIN( "._.", buffer_, &message_size, "The answer is: %s", "5432!"); EXPECT_STREQ(tokenizer_domain, "._."); EXPECT_STREQ(string_literal, "The answer is: %s"); } TEST_F(TokenizeToCallback, Domain_Default) { const char* tokenizer_domain = nullptr; const char* string_literal = nullptr; PW_TOKENIZE_TO_CALLBACK(SetMessage, "The answer is: %s", "5432!"); EXPECT_STREQ(tokenizer_domain, PW_TOKENIZER_DEFAULT_DOMAIN); EXPECT_STREQ(string_literal, "The answer is: %s"); } TEST_F(TokenizeToCallback, Domain_Specified) { const char* tokenizer_domain = nullptr; const char* string_literal = nullptr; PW_TOKENIZE_TO_CALLBACK_DOMAIN( "ThisIsTheDomain", SetMessage, "The answer is: %s", "5432!"); EXPECT_STREQ(tokenizer_domain, "ThisIsTheDomain"); EXPECT_STREQ(string_literal, "The answer is: %s"); } } // namespace } // namespace pw::tokenizer