// Protocol Buffers - Google's data interchange format // Copyright 2008 Google Inc. All rights reserved. // https://developers.google.com/protocol-buffers/ // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include // Must be included last #include using proto2_arena_unittest::ArenaMessage; using protobuf_unittest::TestAllExtensions; using protobuf_unittest::TestAllTypes; using protobuf_unittest::TestEmptyMessage; using protobuf_unittest::TestOneof2; namespace google { namespace protobuf { class Notifier { public: Notifier() : count_(0) {} void Notify() { count_++; } int GetCount() { return count_; } private: int count_; }; class SimpleDataType { public: SimpleDataType() : notifier_(NULL) {} void SetNotifier(Notifier* notifier) { notifier_ = notifier; } virtual ~SimpleDataType() { if (notifier_ != NULL) { notifier_->Notify(); } }; private: Notifier* notifier_; }; // A simple class that does not allow copying and so cannot be used as a // parameter type without "const &". class PleaseDontCopyMe { public: explicit PleaseDontCopyMe(int value) : value_(value) {} int value() const { return value_; } private: int value_; GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(PleaseDontCopyMe); }; // A class that takes four different types as constructor arguments. class MustBeConstructedWithOneThroughFour { public: MustBeConstructedWithOneThroughFour(int one, const char* two, const std::string& three, const PleaseDontCopyMe* four) : one_(one), two_(two), three_(three), four_(four) {} int one_; const char* const two_; std::string three_; const PleaseDontCopyMe* four_; private: GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(MustBeConstructedWithOneThroughFour); }; // A class that takes eight different types as constructor arguments. class MustBeConstructedWithOneThroughEight { public: MustBeConstructedWithOneThroughEight(int one, const char* two, const std::string& three, const PleaseDontCopyMe* four, int five, const char* six, const std::string& seven, const std::string& eight) : one_(one), two_(two), three_(three), four_(four), five_(five), six_(six), seven_(seven), eight_(eight) {} int one_; const char* const two_; std::string three_; const PleaseDontCopyMe* four_; int five_; const char* const six_; std::string seven_; std::string eight_; private: GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(MustBeConstructedWithOneThroughEight); }; TEST(ArenaTest, ArenaConstructable) { EXPECT_TRUE(Arena::is_arena_constructable::type::value); EXPECT_TRUE(Arena::is_arena_constructable::type::value); EXPECT_FALSE(Arena::is_arena_constructable::type::value); } TEST(ArenaTest, DestructorSkippable) { EXPECT_TRUE(Arena::is_destructor_skippable::type::value); EXPECT_TRUE(Arena::is_destructor_skippable::type::value); EXPECT_FALSE(Arena::is_destructor_skippable::type::value); } TEST(ArenaTest, BasicCreate) { Arena arena; EXPECT_TRUE(Arena::Create(&arena) != NULL); EXPECT_TRUE(Arena::Create(&arena) != NULL); EXPECT_TRUE(Arena::Create(&arena) != NULL); EXPECT_TRUE(Arena::Create(&arena) != NULL); EXPECT_TRUE(Arena::Create(&arena) != NULL); arena.Own(new int32_t); arena.Own(new int64_t); arena.Own(new float); arena.Own(new double); arena.Own(new std::string); arena.Own(NULL); Notifier notifier; SimpleDataType* data = Arena::Create(&arena); data->SetNotifier(¬ifier); data = new SimpleDataType; data->SetNotifier(¬ifier); arena.Own(data); arena.Reset(); EXPECT_EQ(2, notifier.GetCount()); } TEST(ArenaTest, CreateAndConstCopy) { Arena arena; const std::string s("foo"); const std::string* s_copy = Arena::Create(&arena, s); EXPECT_TRUE(s_copy != NULL); EXPECT_EQ("foo", s); EXPECT_EQ("foo", *s_copy); } TEST(ArenaTest, CreateAndNonConstCopy) { Arena arena; std::string s("foo"); const std::string* s_copy = Arena::Create(&arena, s); EXPECT_TRUE(s_copy != NULL); EXPECT_EQ("foo", s); EXPECT_EQ("foo", *s_copy); } TEST(ArenaTest, CreateAndMove) { Arena arena; std::string s("foo"); const std::string* s_move = Arena::Create(&arena, std::move(s)); EXPECT_TRUE(s_move != NULL); EXPECT_TRUE(s.empty()); // NOLINT EXPECT_EQ("foo", *s_move); } TEST(ArenaTest, CreateWithFourConstructorArguments) { Arena arena; const std::string three("3"); const PleaseDontCopyMe four(4); const MustBeConstructedWithOneThroughFour* new_object = Arena::Create(&arena, 1, "2", three, &four); EXPECT_TRUE(new_object != NULL); ASSERT_EQ(1, new_object->one_); ASSERT_STREQ("2", new_object->two_); ASSERT_EQ("3", new_object->three_); ASSERT_EQ(4, new_object->four_->value()); } TEST(ArenaTest, CreateWithEightConstructorArguments) { Arena arena; const std::string three("3"); const PleaseDontCopyMe four(4); const std::string seven("7"); const std::string eight("8"); const MustBeConstructedWithOneThroughEight* new_object = Arena::Create( &arena, 1, "2", three, &four, 5, "6", seven, eight); EXPECT_TRUE(new_object != NULL); ASSERT_EQ(1, new_object->one_); ASSERT_STREQ("2", new_object->two_); ASSERT_EQ("3", new_object->three_); ASSERT_EQ(4, new_object->four_->value()); ASSERT_EQ(5, new_object->five_); ASSERT_STREQ("6", new_object->six_); ASSERT_EQ("7", new_object->seven_); ASSERT_EQ("8", new_object->eight_); } class PleaseMoveMe { public: explicit PleaseMoveMe(const std::string& value) : value_(value) {} PleaseMoveMe(PleaseMoveMe&&) = default; PleaseMoveMe(const PleaseMoveMe&) = delete; const std::string& value() const { return value_; } private: std::string value_; }; TEST(ArenaTest, CreateWithMoveArguments) { Arena arena; PleaseMoveMe one("1"); const PleaseMoveMe* new_object = Arena::Create(&arena, std::move(one)); EXPECT_TRUE(new_object); ASSERT_EQ("1", new_object->value()); } TEST(ArenaTest, InitialBlockTooSmall) { // Construct a small blocks of memory to be used by the arena allocator; then, // allocate an object which will not fit in the initial block. for (int size = 0; size <= Arena::kBlockOverhead + 32; size++) { std::vector arena_block(size); ArenaOptions options; options.initial_block = arena_block.data(); options.initial_block_size = arena_block.size(); // Try sometimes with non-default block sizes so that we exercise paths // with and without ArenaImpl::Options. if ((size % 2) != 0) { options.start_block_size += 8; } Arena arena(options); char* p = Arena::CreateArray(&arena, 96); uintptr_t allocation = reinterpret_cast(p); // Ensure that the arena allocator did not return memory pointing into the // initial block of memory. uintptr_t arena_start = reinterpret_cast(arena_block.data()); uintptr_t arena_end = arena_start + arena_block.size(); EXPECT_FALSE(allocation >= arena_start && allocation < arena_end); // Write to the memory we allocated; this should (but is not guaranteed to) // trigger a check for heap corruption if the object was allocated from the // initially-provided block. memset(p, '\0', 96); } } TEST(ArenaTest, Parsing) { TestAllTypes original; TestUtil::SetAllFields(&original); // Test memory leak. Arena arena; TestAllTypes* arena_message = Arena::CreateMessage(&arena); arena_message->ParseFromString(original.SerializeAsString()); TestUtil::ExpectAllFieldsSet(*arena_message); // Test that string fields have nul terminator bytes (earlier bug). EXPECT_EQ(strlen(original.optional_string().c_str()), strlen(arena_message->optional_string().c_str())); } TEST(ArenaTest, UnknownFields) { TestAllTypes original; TestUtil::SetAllFields(&original); // Test basic parsing into (populating) and reading out of unknown fields on // an arena. Arena arena; TestEmptyMessage* arena_message = Arena::CreateMessage(&arena); arena_message->ParseFromString(original.SerializeAsString()); TestAllTypes copied; copied.ParseFromString(arena_message->SerializeAsString()); TestUtil::ExpectAllFieldsSet(copied); // Exercise UFS manual manipulation (setters). arena_message = Arena::CreateMessage(&arena); arena_message->mutable_unknown_fields()->AddVarint( TestAllTypes::kOptionalInt32FieldNumber, 42); copied.Clear(); copied.ParseFromString(arena_message->SerializeAsString()); EXPECT_TRUE(copied.has_optional_int32()); EXPECT_EQ(42, copied.optional_int32()); // Exercise UFS swap path. TestEmptyMessage* arena_message_2 = Arena::CreateMessage(&arena); arena_message_2->Swap(arena_message); copied.Clear(); copied.ParseFromString(arena_message_2->SerializeAsString()); EXPECT_TRUE(copied.has_optional_int32()); EXPECT_EQ(42, copied.optional_int32()); // Test field manipulation. TestEmptyMessage* arena_message_3 = Arena::CreateMessage(&arena); arena_message_3->mutable_unknown_fields()->AddVarint(1000, 42); arena_message_3->mutable_unknown_fields()->AddFixed32(1001, 42); arena_message_3->mutable_unknown_fields()->AddFixed64(1002, 42); arena_message_3->mutable_unknown_fields()->AddLengthDelimited(1003); arena_message_3->mutable_unknown_fields()->DeleteSubrange(0, 2); arena_message_3->mutable_unknown_fields()->DeleteByNumber(1002); arena_message_3->mutable_unknown_fields()->DeleteByNumber(1003); EXPECT_TRUE(arena_message_3->unknown_fields().empty()); } TEST(ArenaTest, Swap) { Arena arena1; Arena arena2; TestAllTypes* arena1_message; TestAllTypes* arena2_message; // Case 1: Swap(), no UFS on either message, both messages on different // arenas. Arena pointers should remain the same after swap. arena1_message = Arena::CreateMessage(&arena1); arena2_message = Arena::CreateMessage(&arena2); arena1_message->Swap(arena2_message); EXPECT_EQ(&arena1, arena1_message->GetArena()); EXPECT_EQ(&arena2, arena2_message->GetArena()); // Case 2: Swap(), UFS on one message, both messages on different arenas. arena1_message = Arena::CreateMessage(&arena1); arena2_message = Arena::CreateMessage(&arena2); arena1_message->mutable_unknown_fields()->AddVarint(1, 42); arena1_message->Swap(arena2_message); EXPECT_EQ(&arena1, arena1_message->GetArena()); EXPECT_EQ(&arena2, arena2_message->GetArena()); EXPECT_EQ(0, arena1_message->unknown_fields().field_count()); EXPECT_EQ(1, arena2_message->unknown_fields().field_count()); EXPECT_EQ(42, arena2_message->unknown_fields().field(0).varint()); // Case 3: Swap(), UFS on both messages, both messages on different arenas. arena1_message = Arena::CreateMessage(&arena1); arena2_message = Arena::CreateMessage(&arena2); arena1_message->mutable_unknown_fields()->AddVarint(1, 42); arena2_message->mutable_unknown_fields()->AddVarint(2, 84); arena1_message->Swap(arena2_message); EXPECT_EQ(&arena1, arena1_message->GetArena()); EXPECT_EQ(&arena2, arena2_message->GetArena()); EXPECT_EQ(1, arena1_message->unknown_fields().field_count()); EXPECT_EQ(1, arena2_message->unknown_fields().field_count()); EXPECT_EQ(84, arena1_message->unknown_fields().field(0).varint()); EXPECT_EQ(42, arena2_message->unknown_fields().field(0).varint()); } TEST(ArenaTest, ReflectionSwapFields) { Arena arena1; Arena arena2; TestAllTypes* arena1_message; TestAllTypes* arena2_message; // Case 1: messages on different arenas, only one message is set. arena1_message = Arena::CreateMessage(&arena1); arena2_message = Arena::CreateMessage(&arena2); TestUtil::SetAllFields(arena1_message); const Reflection* reflection = arena1_message->GetReflection(); std::vector fields; reflection->ListFields(*arena1_message, &fields); reflection->SwapFields(arena1_message, arena2_message, fields); EXPECT_EQ(&arena1, arena1_message->GetArena()); EXPECT_EQ(&arena2, arena2_message->GetArena()); std::string output; arena1_message->SerializeToString(&output); EXPECT_EQ(0, output.size()); TestUtil::ExpectAllFieldsSet(*arena2_message); reflection->SwapFields(arena1_message, arena2_message, fields); arena2_message->SerializeToString(&output); EXPECT_EQ(0, output.size()); TestUtil::ExpectAllFieldsSet(*arena1_message); // Case 2: messages on different arenas, both messages are set. arena1_message = Arena::CreateMessage(&arena1); arena2_message = Arena::CreateMessage(&arena2); TestUtil::SetAllFields(arena1_message); TestUtil::SetAllFields(arena2_message); reflection->SwapFields(arena1_message, arena2_message, fields); EXPECT_EQ(&arena1, arena1_message->GetArena()); EXPECT_EQ(&arena2, arena2_message->GetArena()); TestUtil::ExpectAllFieldsSet(*arena1_message); TestUtil::ExpectAllFieldsSet(*arena2_message); // Case 3: messages on different arenas with different lifetimes. arena1_message = Arena::CreateMessage(&arena1); { Arena arena3; TestAllTypes* arena3_message = Arena::CreateMessage(&arena3); TestUtil::SetAllFields(arena3_message); reflection->SwapFields(arena1_message, arena3_message, fields); } TestUtil::ExpectAllFieldsSet(*arena1_message); // Case 4: one message on arena, the other on heap. arena1_message = Arena::CreateMessage(&arena1); TestAllTypes message; TestUtil::SetAllFields(arena1_message); reflection->SwapFields(arena1_message, &message, fields); EXPECT_EQ(&arena1, arena1_message->GetArena()); EXPECT_EQ(nullptr, message.GetArena()); arena1_message->SerializeToString(&output); EXPECT_EQ(0, output.size()); TestUtil::ExpectAllFieldsSet(message); } TEST(ArenaTest, SetAllocatedMessage) { Arena arena; TestAllTypes* arena_message = Arena::CreateMessage(&arena); TestAllTypes::NestedMessage* nested = new TestAllTypes::NestedMessage; nested->set_bb(118); arena_message->set_allocated_optional_nested_message(nested); EXPECT_EQ(118, arena_message->optional_nested_message().bb()); } TEST(ArenaTest, ReleaseMessage) { Arena arena; TestAllTypes* arena_message = Arena::CreateMessage(&arena); arena_message->mutable_optional_nested_message()->set_bb(118); std::unique_ptr nested( arena_message->release_optional_nested_message()); EXPECT_EQ(118, nested->bb()); TestAllTypes::NestedMessage* released_null = arena_message->release_optional_nested_message(); EXPECT_EQ(NULL, released_null); } TEST(ArenaTest, SetAllocatedString) { Arena arena; TestAllTypes* arena_message = Arena::CreateMessage(&arena); std::string* allocated_str = new std::string("hello"); arena_message->set_allocated_optional_string(allocated_str); EXPECT_EQ("hello", arena_message->optional_string()); } TEST(ArenaTest, ReleaseString) { Arena arena; TestAllTypes* arena_message = Arena::CreateMessage(&arena); arena_message->set_optional_string("hello"); std::unique_ptr released_str( arena_message->release_optional_string()); EXPECT_EQ("hello", *released_str); // Test default value. } TEST(ArenaTest, SwapBetweenArenasWithAllFieldsSet) { Arena arena1; TestAllTypes* arena1_message = Arena::CreateMessage(&arena1); { Arena arena2; TestAllTypes* arena2_message = Arena::CreateMessage(&arena2); TestUtil::SetAllFields(arena2_message); arena2_message->Swap(arena1_message); std::string output; arena2_message->SerializeToString(&output); EXPECT_EQ(0, output.size()); } TestUtil::ExpectAllFieldsSet(*arena1_message); } TEST(ArenaTest, SwapBetweenArenaAndNonArenaWithAllFieldsSet) { TestAllTypes non_arena_message; TestUtil::SetAllFields(&non_arena_message); { Arena arena2; TestAllTypes* arena2_message = Arena::CreateMessage(&arena2); TestUtil::SetAllFields(arena2_message); arena2_message->Swap(&non_arena_message); TestUtil::ExpectAllFieldsSet(*arena2_message); TestUtil::ExpectAllFieldsSet(non_arena_message); } } TEST(ArenaTest, UnsafeArenaSwap) { Arena shared_arena; TestAllTypes* message1 = Arena::CreateMessage(&shared_arena); TestAllTypes* message2 = Arena::CreateMessage(&shared_arena); TestUtil::SetAllFields(message1); message1->UnsafeArenaSwap(message2); TestUtil::ExpectAllFieldsSet(*message2); } TEST(ArenaTest, SwapBetweenArenasUsingReflection) { Arena arena1; TestAllTypes* arena1_message = Arena::CreateMessage(&arena1); { Arena arena2; TestAllTypes* arena2_message = Arena::CreateMessage(&arena2); TestUtil::SetAllFields(arena2_message); const Reflection* r = arena2_message->GetReflection(); r->Swap(arena1_message, arena2_message); std::string output; arena2_message->SerializeToString(&output); EXPECT_EQ(0, output.size()); } TestUtil::ExpectAllFieldsSet(*arena1_message); } TEST(ArenaTest, SwapBetweenArenaAndNonArenaUsingReflection) { TestAllTypes non_arena_message; TestUtil::SetAllFields(&non_arena_message); { Arena arena2; TestAllTypes* arena2_message = Arena::CreateMessage(&arena2); TestUtil::SetAllFields(arena2_message); const Reflection* r = arena2_message->GetReflection(); r->Swap(&non_arena_message, arena2_message); TestUtil::ExpectAllFieldsSet(*arena2_message); TestUtil::ExpectAllFieldsSet(non_arena_message); } } TEST(ArenaTest, ReleaseFromArenaMessageMakesCopy) { TestAllTypes::NestedMessage* nested_msg = NULL; std::string* nested_string = NULL; { Arena arena; TestAllTypes* arena_message = Arena::CreateMessage(&arena); arena_message->mutable_optional_nested_message()->set_bb(42); *arena_message->mutable_optional_string() = "Hello"; nested_msg = arena_message->release_optional_nested_message(); nested_string = arena_message->release_optional_string(); } EXPECT_EQ(42, nested_msg->bb()); EXPECT_EQ("Hello", *nested_string); delete nested_msg; delete nested_string; } #if PROTOBUF_RTTI TEST(ArenaTest, ReleaseFromArenaMessageUsingReflectionMakesCopy) { TestAllTypes::NestedMessage* nested_msg = NULL; // Note: no string: reflection API only supports releasing submessages. { Arena arena; TestAllTypes* arena_message = Arena::CreateMessage(&arena); arena_message->mutable_optional_nested_message()->set_bb(42); const Reflection* r = arena_message->GetReflection(); const FieldDescriptor* f = arena_message->GetDescriptor()->FindFieldByName( "optional_nested_message"); nested_msg = static_cast( r->ReleaseMessage(arena_message, f)); } EXPECT_EQ(42, nested_msg->bb()); delete nested_msg; } #endif // PROTOBUF_RTTI TEST(ArenaTest, SetAllocatedAcrossArenas) { Arena arena1; TestAllTypes* arena1_message = Arena::CreateMessage(&arena1); TestAllTypes::NestedMessage* heap_submessage = new TestAllTypes::NestedMessage(); heap_submessage->set_bb(42); arena1_message->set_allocated_optional_nested_message(heap_submessage); // Should keep same object and add to arena's Own()-list. EXPECT_EQ(heap_submessage, arena1_message->mutable_optional_nested_message()); { Arena arena2; TestAllTypes::NestedMessage* arena2_submessage = Arena::CreateMessage(&arena2); arena2_submessage->set_bb(42); #ifdef PROTOBUF_HAS_DEATH_TEST EXPECT_DEBUG_DEATH(arena1_message->set_allocated_optional_nested_message( arena2_submessage), "submessage_arena"); #endif EXPECT_NE(arena2_submessage, arena1_message->mutable_optional_nested_message()); } TestAllTypes::NestedMessage* arena1_submessage = Arena::CreateMessage(&arena1); arena1_submessage->set_bb(42); TestAllTypes* heap_message = new TestAllTypes; #ifdef PROTOBUF_HAS_DEATH_TEST EXPECT_DEBUG_DEATH( heap_message->set_allocated_optional_nested_message(arena1_submessage), "submessage_arena"); #endif EXPECT_NE(arena1_submessage, heap_message->mutable_optional_nested_message()); delete heap_message; } TEST(ArenaTest, UnsafeArenaSetAllocatedAcrossArenas) { Arena arena1; TestAllTypes* arena1_message = Arena::CreateMessage(&arena1); { Arena arena2; TestAllTypes::NestedMessage* arena2_submessage = Arena::CreateMessage(&arena2); arena2_submessage->set_bb(42); arena1_message->unsafe_arena_set_allocated_optional_nested_message( arena2_submessage); EXPECT_EQ(arena2_submessage, arena1_message->mutable_optional_nested_message()); EXPECT_EQ(arena2_submessage, arena1_message->unsafe_arena_release_optional_nested_message()); } TestAllTypes::NestedMessage* arena1_submessage = Arena::CreateMessage(&arena1); arena1_submessage->set_bb(42); TestAllTypes* heap_message = new TestAllTypes; heap_message->unsafe_arena_set_allocated_optional_nested_message( arena1_submessage); EXPECT_EQ(arena1_submessage, heap_message->mutable_optional_nested_message()); EXPECT_EQ(arena1_submessage, heap_message->unsafe_arena_release_optional_nested_message()); delete heap_message; } TEST(ArenaTest, SetAllocatedAcrossArenasWithReflection) { // Same as above, with reflection. Arena arena1; TestAllTypes* arena1_message = Arena::CreateMessage(&arena1); const Reflection* r = arena1_message->GetReflection(); const Descriptor* d = arena1_message->GetDescriptor(); const FieldDescriptor* msg_field = d->FindFieldByName("optional_nested_message"); TestAllTypes::NestedMessage* heap_submessage = new TestAllTypes::NestedMessage(); heap_submessage->set_bb(42); r->SetAllocatedMessage(arena1_message, heap_submessage, msg_field); // Should keep same object and add to arena's Own()-list. EXPECT_EQ(heap_submessage, arena1_message->mutable_optional_nested_message()); { Arena arena2; TestAllTypes::NestedMessage* arena2_submessage = Arena::CreateMessage(&arena2); arena2_submessage->set_bb(42); #ifdef PROTOBUF_HAS_DEATH_TEST EXPECT_DEBUG_DEATH( r->SetAllocatedMessage(arena1_message, arena2_submessage, msg_field), "GetOwningArena"); #endif EXPECT_NE(arena2_submessage, arena1_message->mutable_optional_nested_message()); } TestAllTypes::NestedMessage* arena1_submessage = Arena::CreateMessage(&arena1); arena1_submessage->set_bb(42); TestAllTypes* heap_message = new TestAllTypes; #ifdef PROTOBUF_HAS_DEATH_TEST EXPECT_DEBUG_DEATH( r->SetAllocatedMessage(heap_message, arena1_submessage, msg_field), "GetOwningArena"); #endif EXPECT_NE(arena1_submessage, heap_message->mutable_optional_nested_message()); delete heap_message; } TEST(ArenaTest, UnsafeArenaSetAllocatedAcrossArenasWithReflection) { // Same as above, with reflection. Arena arena1; TestAllTypes* arena1_message = Arena::CreateMessage(&arena1); const Reflection* r = arena1_message->GetReflection(); const Descriptor* d = arena1_message->GetDescriptor(); const FieldDescriptor* msg_field = d->FindFieldByName("optional_nested_message"); { Arena arena2; TestAllTypes::NestedMessage* arena2_submessage = Arena::CreateMessage(&arena2); arena2_submessage->set_bb(42); r->UnsafeArenaSetAllocatedMessage(arena1_message, arena2_submessage, msg_field); EXPECT_EQ(arena2_submessage, arena1_message->mutable_optional_nested_message()); EXPECT_EQ(arena2_submessage, arena1_message->unsafe_arena_release_optional_nested_message()); } TestAllTypes::NestedMessage* arena1_submessage = Arena::CreateMessage(&arena1); arena1_submessage->set_bb(42); TestAllTypes* heap_message = new TestAllTypes; r->UnsafeArenaSetAllocatedMessage(heap_message, arena1_submessage, msg_field); EXPECT_EQ(arena1_submessage, heap_message->mutable_optional_nested_message()); EXPECT_EQ(arena1_submessage, heap_message->unsafe_arena_release_optional_nested_message()); delete heap_message; } TEST(ArenaTest, AddAllocatedWithReflection) { Arena arena1; ArenaMessage* arena1_message = Arena::CreateMessage(&arena1); const Reflection* r = arena1_message->GetReflection(); const Descriptor* d = arena1_message->GetDescriptor(); // Message with cc_enable_arenas = true; const FieldDescriptor* fd = d->FindFieldByName("repeated_nested_message"); r->AddMessage(arena1_message, fd); r->AddMessage(arena1_message, fd); r->AddMessage(arena1_message, fd); EXPECT_EQ(3, r->FieldSize(*arena1_message, fd)); } TEST(ArenaTest, RepeatedPtrFieldAddClearedTest) { #ifndef PROTOBUF_FUTURE_BREAKING_CHANGES { RepeatedPtrField repeated_field; EXPECT_TRUE(repeated_field.empty()); EXPECT_EQ(0, repeated_field.size()); // Ownership is passed to repeated_field. TestAllTypes* cleared = new TestAllTypes(); repeated_field.AddCleared(cleared); EXPECT_TRUE(repeated_field.empty()); EXPECT_EQ(0, repeated_field.size()); } #endif // !PROTOBUF_FUTURE_BREAKING_CHANGES { RepeatedPtrField repeated_field; EXPECT_TRUE(repeated_field.empty()); EXPECT_EQ(0, repeated_field.size()); // Ownership is passed to repeated_field. TestAllTypes* cleared = new TestAllTypes(); repeated_field.AddAllocated(cleared); EXPECT_FALSE(repeated_field.empty()); EXPECT_EQ(1, repeated_field.size()); } } TEST(ArenaTest, AddAllocatedToRepeatedField) { // Heap->arena case. Arena arena1; TestAllTypes* arena1_message = Arena::CreateMessage(&arena1); for (int i = 0; i < 10; i++) { TestAllTypes::NestedMessage* heap_submessage = new TestAllTypes::NestedMessage(); heap_submessage->set_bb(42); arena1_message->mutable_repeated_nested_message()->AddAllocated( heap_submessage); // Should not copy object -- will use arena_->Own(). EXPECT_EQ(heap_submessage, &arena1_message->repeated_nested_message(i)); EXPECT_EQ(42, arena1_message->repeated_nested_message(i).bb()); } // Arena1->Arena2 case. arena1_message->Clear(); for (int i = 0; i < 10; i++) { Arena arena2; TestAllTypes::NestedMessage* arena2_submessage = Arena::CreateMessage(&arena2); arena2_submessage->set_bb(42); #ifdef PROTOBUF_HAS_DEATH_TEST EXPECT_DEBUG_DEATH( arena1_message->mutable_repeated_nested_message()->AddAllocated( arena2_submessage), "value_arena"); #endif // Should not receive object. EXPECT_TRUE(arena1_message->repeated_nested_message().empty()); } // Arena->heap case. TestAllTypes* heap_message = new TestAllTypes; for (int i = 0; i < 10; i++) { Arena arena2; TestAllTypes::NestedMessage* arena2_submessage = Arena::CreateMessage(&arena2); arena2_submessage->set_bb(42); #ifdef PROTOBUF_HAS_DEATH_TEST EXPECT_DEBUG_DEATH( heap_message->mutable_repeated_nested_message()->AddAllocated( arena2_submessage), "value_arena"); #endif // Should not receive object. EXPECT_TRUE(heap_message->repeated_nested_message().empty()); } delete heap_message; // Heap->arena case for strings (which are not arena-allocated). arena1_message->Clear(); for (int i = 0; i < 10; i++) { std::string* s = new std::string("Test"); arena1_message->mutable_repeated_string()->AddAllocated(s); // Should not copy. EXPECT_EQ(s, &arena1_message->repeated_string(i)); EXPECT_EQ("Test", arena1_message->repeated_string(i)); } } TEST(ArenaTest, UnsafeArenaAddAllocatedToRepeatedField) { // Heap->arena case. Arena arena1; TestAllTypes* arena1_message = Arena::CreateMessage(&arena1); { auto* heap_submessage = new TestAllTypes::NestedMessage; arena1_message->mutable_repeated_nested_message()->UnsafeArenaAddAllocated( heap_submessage); // Should not copy object. EXPECT_EQ(heap_submessage, &arena1_message->repeated_nested_message(0)); EXPECT_EQ(heap_submessage, arena1_message->mutable_repeated_nested_message() ->UnsafeArenaReleaseLast()); delete heap_submessage; } // Arena1->Arena2 case. arena1_message->Clear(); { Arena arena2; TestAllTypes::NestedMessage* arena2_submessage = Arena::CreateMessage(&arena2); arena2_submessage->set_bb(42); arena1_message->mutable_repeated_nested_message()->UnsafeArenaAddAllocated( arena2_submessage); // Should own object. EXPECT_EQ(arena2_submessage, &arena1_message->repeated_nested_message(0)); EXPECT_EQ(arena2_submessage, arena1_message->mutable_repeated_nested_message() ->UnsafeArenaReleaseLast()); } // Arena->heap case. TestAllTypes* heap_message = new TestAllTypes; { Arena arena2; TestAllTypes::NestedMessage* arena2_submessage = Arena::CreateMessage(&arena2); arena2_submessage->set_bb(42); heap_message->mutable_repeated_nested_message()->UnsafeArenaAddAllocated( arena2_submessage); // Should own object. EXPECT_EQ(arena2_submessage, &heap_message->repeated_nested_message(0)); EXPECT_EQ(arena2_submessage, heap_message->mutable_repeated_nested_message() ->UnsafeArenaReleaseLast()); } delete heap_message; // Heap->arena case for strings (which are not arena-allocated). arena1_message->Clear(); { std::string* s = new std::string("Test"); arena1_message->mutable_repeated_string()->UnsafeArenaAddAllocated(s); // Should not copy. EXPECT_EQ(s, &arena1_message->repeated_string(0)); EXPECT_EQ("Test", arena1_message->repeated_string(0)); delete arena1_message->mutable_repeated_string()->UnsafeArenaReleaseLast(); } } TEST(ArenaTest, AddAllocatedToRepeatedFieldViaReflection) { // Heap->arena case. Arena arena1; TestAllTypes* arena1_message = Arena::CreateMessage(&arena1); const Reflection* r = arena1_message->GetReflection(); const Descriptor* d = arena1_message->GetDescriptor(); const FieldDescriptor* fd = d->FindFieldByName("repeated_nested_message"); for (int i = 0; i < 10; i++) { TestAllTypes::NestedMessage* heap_submessage = new TestAllTypes::NestedMessage; heap_submessage->set_bb(42); r->AddAllocatedMessage(arena1_message, fd, heap_submessage); // Should not copy object -- will use arena_->Own(). EXPECT_EQ(heap_submessage, &arena1_message->repeated_nested_message(i)); EXPECT_EQ(42, arena1_message->repeated_nested_message(i).bb()); } // Arena1->Arena2 case. arena1_message->Clear(); for (int i = 0; i < 10; i++) { Arena arena2; TestAllTypes::NestedMessage* arena2_submessage = Arena::CreateMessage(&arena2); arena2_submessage->set_bb(42); #ifdef PROTOBUF_HAS_DEATH_TEST EXPECT_DEBUG_DEATH( r->AddAllocatedMessage(arena1_message, fd, arena2_submessage), "value_arena"); #endif // Should not receive object. EXPECT_TRUE(arena1_message->repeated_nested_message().empty()); } // Arena->heap case. TestAllTypes* heap_message = new TestAllTypes; for (int i = 0; i < 10; i++) { Arena arena2; TestAllTypes::NestedMessage* arena2_submessage = Arena::CreateMessage(&arena2); arena2_submessage->set_bb(42); #ifdef PROTOBUF_HAS_DEATH_TEST EXPECT_DEBUG_DEATH( r->AddAllocatedMessage(heap_message, fd, arena2_submessage), "value_arena"); #endif // Should not receive object. EXPECT_TRUE(heap_message->repeated_nested_message().empty()); } delete heap_message; } TEST(ArenaTest, ReleaseLastRepeatedField) { // Release from arena-allocated repeated field and ensure that returned object // is heap-allocated. Arena arena; TestAllTypes* arena_message = Arena::CreateMessage(&arena); for (int i = 0; i < 10; i++) { TestAllTypes::NestedMessage* nested = Arena::CreateMessage(&arena); nested->set_bb(42); arena_message->mutable_repeated_nested_message()->AddAllocated(nested); } for (int i = 0; i < 10; i++) { const TestAllTypes::NestedMessage* orig_submessage = &arena_message->repeated_nested_message(10 - 1 - i); // last element TestAllTypes::NestedMessage* released = arena_message->mutable_repeated_nested_message()->ReleaseLast(); EXPECT_NE(released, orig_submessage); EXPECT_EQ(42, released->bb()); delete released; } // Test UnsafeArenaReleaseLast(). for (int i = 0; i < 10; i++) { TestAllTypes::NestedMessage* nested = Arena::CreateMessage(&arena); nested->set_bb(42); arena_message->mutable_repeated_nested_message()->AddAllocated(nested); } for (int i = 0; i < 10; i++) { const TestAllTypes::NestedMessage* orig_submessage = &arena_message->repeated_nested_message(10 - 1 - i); // last element TestAllTypes::NestedMessage* released = arena_message->mutable_repeated_nested_message() ->UnsafeArenaReleaseLast(); EXPECT_EQ(released, orig_submessage); EXPECT_EQ(42, released->bb()); // no delete -- |released| is on the arena. } // Test string case as well. ReleaseLast() in this case must copy the // string, even though it was originally heap-allocated and its pointer // was simply appended to the repeated field's internal vector, because the // string was placed on the arena's destructor list and cannot be removed // from that list (so the arena permanently owns the original instance). arena_message->Clear(); for (int i = 0; i < 10; i++) { std::string* s = new std::string("Test"); arena_message->mutable_repeated_string()->AddAllocated(s); } for (int i = 0; i < 10; i++) { const std::string* orig_element = &arena_message->repeated_string(10 - 1 - i); std::string* released = arena_message->mutable_repeated_string()->ReleaseLast(); EXPECT_NE(released, orig_element); EXPECT_EQ("Test", *released); delete released; } } TEST(ArenaTest, UnsafeArenaAddAllocated) { Arena arena; TestAllTypes* message = Arena::CreateMessage(&arena); for (int i = 0; i < 10; i++) { std::string* arena_string = Arena::Create(&arena); message->mutable_repeated_string()->UnsafeArenaAddAllocated(arena_string); EXPECT_EQ(arena_string, message->mutable_repeated_string(i)); } } TEST(ArenaTest, OneofMerge) { Arena arena; TestAllTypes* message0 = Arena::CreateMessage(&arena); TestAllTypes* message1 = Arena::CreateMessage(&arena); message0->set_oneof_string("x"); ASSERT_TRUE(message0->has_oneof_string()); message1->set_oneof_string("y"); ASSERT_TRUE(message1->has_oneof_string()); EXPECT_EQ("x", message0->oneof_string()); EXPECT_EQ("y", message1->oneof_string()); message0->MergeFrom(*message1); EXPECT_EQ("y", message0->oneof_string()); EXPECT_EQ("y", message1->oneof_string()); } TEST(ArenaTest, ArenaOneofReflection) { Arena arena; TestAllTypes* message = Arena::CreateMessage(&arena); const Descriptor* desc = message->GetDescriptor(); const Reflection* refl = message->GetReflection(); const FieldDescriptor* string_field = desc->FindFieldByName("oneof_string"); const FieldDescriptor* msg_field = desc->FindFieldByName("oneof_nested_message"); const OneofDescriptor* oneof = desc->FindOneofByName("oneof_field"); refl->SetString(message, string_field, "Test value"); EXPECT_TRUE(refl->HasOneof(*message, oneof)); refl->ClearOneof(message, oneof); EXPECT_FALSE(refl->HasOneof(*message, oneof)); Message* submsg = refl->MutableMessage(message, msg_field); EXPECT_TRUE(refl->HasOneof(*message, oneof)); refl->ClearOneof(message, oneof); EXPECT_FALSE(refl->HasOneof(*message, oneof)); refl->MutableMessage(message, msg_field); EXPECT_TRUE(refl->HasOneof(*message, oneof)); submsg = refl->ReleaseMessage(message, msg_field); EXPECT_FALSE(refl->HasOneof(*message, oneof)); EXPECT_TRUE(submsg->GetArena() == NULL); delete submsg; } void TestSwapRepeatedField(Arena* arena1, Arena* arena2) { // Test "safe" (copying) semantics for direct Swap() on RepeatedPtrField // between arenas. RepeatedPtrField field1(arena1); RepeatedPtrField field2(arena2); for (int i = 0; i < 10; i++) { TestAllTypes* t = Arena::CreateMessage(arena1); t->set_optional_string("field1"); t->set_optional_int32(i); if (arena1 != NULL) { field1.UnsafeArenaAddAllocated(t); } else { field1.AddAllocated(t); } } for (int i = 0; i < 5; i++) { TestAllTypes* t = Arena::CreateMessage(arena2); t->set_optional_string("field2"); t->set_optional_int32(i); if (arena2 != NULL) { field2.UnsafeArenaAddAllocated(t); } else { field2.AddAllocated(t); } } field1.Swap(&field2); EXPECT_EQ(5, field1.size()); EXPECT_EQ(10, field2.size()); EXPECT_TRUE(std::string("field1") == field2.Get(0).optional_string()); EXPECT_TRUE(std::string("field2") == field1.Get(0).optional_string()); // Ensure that fields retained their original order: for (int i = 0; i < field1.size(); i++) { EXPECT_EQ(i, field1.Get(i).optional_int32()); } for (int i = 0; i < field2.size(); i++) { EXPECT_EQ(i, field2.Get(i).optional_int32()); } } TEST(ArenaTest, SwapRepeatedField) { Arena arena; TestSwapRepeatedField(&arena, &arena); } TEST(ArenaTest, SwapRepeatedFieldWithDifferentArenas) { Arena arena1; Arena arena2; TestSwapRepeatedField(&arena1, &arena2); } TEST(ArenaTest, SwapRepeatedFieldWithNoArenaOnRightHandSide) { Arena arena; TestSwapRepeatedField(&arena, NULL); } TEST(ArenaTest, SwapRepeatedFieldWithNoArenaOnLeftHandSide) { Arena arena; TestSwapRepeatedField(NULL, &arena); } TEST(ArenaTest, ExtensionsOnArena) { Arena arena; // Ensure no leaks. TestAllExtensions* message_ext = Arena::CreateMessage(&arena); message_ext->SetExtension(protobuf_unittest::optional_int32_extension, 42); message_ext->SetExtension(protobuf_unittest::optional_string_extension, std::string("test")); message_ext ->MutableExtension(protobuf_unittest::optional_nested_message_extension) ->set_bb(42); } TEST(ArenaTest, RepeatedFieldOnArena) { // Preallocate an initial arena block to avoid mallocs during hooked region. std::vector arena_block(1024 * 1024); Arena arena(arena_block.data(), arena_block.size()); { internal::NoHeapChecker no_heap; // Fill some repeated fields on the arena to test for leaks. Also verify no // memory allocations. RepeatedField repeated_int32(&arena); RepeatedPtrField repeated_message(&arena); for (int i = 0; i < 100; i++) { repeated_int32.Add(42); repeated_message.Add()->set_optional_int32(42); EXPECT_EQ(&arena, repeated_message.Get(0).GetArena()); const TestAllTypes* msg_in_repeated_field = &repeated_message.Get(0); TestAllTypes* msg = repeated_message.UnsafeArenaReleaseLast(); EXPECT_EQ(msg_in_repeated_field, msg); } // UnsafeArenaExtractSubrange (i) should not leak and (ii) should return // on-arena pointers. for (int i = 0; i < 10; i++) { repeated_message.Add()->set_optional_int32(42); } TestAllTypes* extracted_messages[5]; repeated_message.UnsafeArenaExtractSubrange(0, 5, extracted_messages); EXPECT_EQ(&arena, repeated_message.Get(0).GetArena()); EXPECT_EQ(5, repeated_message.size()); } // Now, outside the scope of the NoHeapChecker, test ExtractSubrange's copying // semantics. { RepeatedPtrField repeated_message(&arena); for (int i = 0; i < 100; i++) { repeated_message.Add()->set_optional_int32(42); } TestAllTypes* extracted_messages[5]; // ExtractSubrange should copy to the heap. repeated_message.ExtractSubrange(0, 5, extracted_messages); EXPECT_EQ(NULL, extracted_messages[0]->GetArena()); // We need to free the heap-allocated messages to prevent a leak. for (int i = 0; i < 5; i++) { delete extracted_messages[i]; extracted_messages[i] = NULL; } } // Now check that we can create RepeatedFields/RepeatedPtrFields themselves on // the arena. They have the necessary type traits so that they can behave like // messages in this way. This is useful for higher-level generic templated // code that may allocate messages or repeated fields of messages on an arena. { RepeatedPtrField* repeated_ptr_on_arena = Arena::CreateMessage >(&arena); for (int i = 0; i < 10; i++) { // Add some elements and let the leak-checker ensure that everything is // freed. repeated_ptr_on_arena->Add(); } RepeatedField* repeated_int_on_arena = Arena::CreateMessage >(&arena); for (int i = 0; i < 100; i++) { repeated_int_on_arena->Add(i); } } arena.Reset(); } #if PROTOBUF_RTTI TEST(ArenaTest, MutableMessageReflection) { Arena arena; TestAllTypes* message = Arena::CreateMessage(&arena); const Reflection* r = message->GetReflection(); const Descriptor* d = message->GetDescriptor(); const FieldDescriptor* field = d->FindFieldByName("optional_nested_message"); TestAllTypes::NestedMessage* submessage = static_cast( r->MutableMessage(message, field)); TestAllTypes::NestedMessage* submessage_expected = message->mutable_optional_nested_message(); EXPECT_EQ(submessage_expected, submessage); EXPECT_EQ(&arena, submessage->GetArena()); const FieldDescriptor* oneof_field = d->FindFieldByName("oneof_nested_message"); submessage = static_cast( r->MutableMessage(message, oneof_field)); submessage_expected = message->mutable_oneof_nested_message(); EXPECT_EQ(submessage_expected, submessage); EXPECT_EQ(&arena, submessage->GetArena()); } #endif // PROTOBUF_RTTI void FillArenaAwareFields(TestAllTypes* message) { std::string test_string = "hello world"; message->set_optional_int32(42); message->set_optional_string(test_string); message->set_optional_bytes(test_string); message->mutable_optional_nested_message()->set_bb(42); message->set_oneof_uint32(42); message->mutable_oneof_nested_message()->set_bb(42); message->set_oneof_string(test_string); message->set_oneof_bytes(test_string); message->add_repeated_int32(42); // No repeated string: not yet arena-aware. message->add_repeated_nested_message()->set_bb(42); message->mutable_optional_lazy_message()->set_bb(42); } // Test: no allocations occur on heap while touching all supported field types. TEST(ArenaTest, NoHeapAllocationsTest) { // Allocate a large initial block to avoid mallocs during hooked test. std::vector arena_block(128 * 1024); ArenaOptions options; options.initial_block = &arena_block[0]; options.initial_block_size = arena_block.size(); Arena arena(options); { TestAllTypes* message = Arena::CreateMessage(&arena); FillArenaAwareFields(message); } arena.Reset(); } TEST(ArenaTest, ParseCorruptedString) { TestAllTypes message; TestUtil::SetAllFields(&message); TestParseCorruptedString(message); TestParseCorruptedString(message); } #if PROTOBUF_RTTI // Test construction on an arena via generic MessageLite interface. We should be // able to successfully deserialize on the arena without incurring heap // allocations, i.e., everything should still be arena-allocation-aware. TEST(ArenaTest, MessageLiteOnArena) { std::vector arena_block(128 * 1024); ArenaOptions options; options.initial_block = &arena_block[0]; options.initial_block_size = arena_block.size(); Arena arena(options); const MessageLite* prototype = &TestAllTypes::default_instance(); TestAllTypes initial_message; FillArenaAwareFields(&initial_message); std::string serialized; initial_message.SerializeToString(&serialized); { MessageLite* generic_message = prototype->New(&arena); EXPECT_TRUE(generic_message != NULL); EXPECT_EQ(&arena, generic_message->GetArena()); EXPECT_TRUE(generic_message->ParseFromString(serialized)); TestAllTypes* deserialized = static_cast(generic_message); EXPECT_EQ(42, deserialized->optional_int32()); } arena.Reset(); } #endif // PROTOBUF_RTTI // RepeatedField should support non-POD types, and invoke constructors and // destructors appropriately, because it's used this way by lots of other code // (even if this was not its original intent). TEST(ArenaTest, RepeatedFieldWithNonPODType) { { RepeatedField field_on_heap; for (int i = 0; i < 100; i++) { *field_on_heap.Add() = "test string long enough to exceed inline buffer"; } } { Arena arena; RepeatedField field_on_arena(&arena); for (int i = 0; i < 100; i++) { *field_on_arena.Add() = "test string long enough to exceed inline buffer"; } } } // Align n to next multiple of 8 uint64_t Align8(uint64_t n) { return (n + 7) & -8; } TEST(ArenaTest, SpaceAllocated_and_Used) { Arena arena_1; EXPECT_EQ(0, arena_1.SpaceAllocated()); EXPECT_EQ(0, arena_1.SpaceUsed()); EXPECT_EQ(0, arena_1.Reset()); Arena::CreateArray(&arena_1, 320); // Arena will allocate slightly more than 320 for the block headers. EXPECT_LE(320, arena_1.SpaceAllocated()); EXPECT_EQ(Align8(320), arena_1.SpaceUsed()); EXPECT_LE(320, arena_1.Reset()); // Test with initial block. std::vector arena_block(1024); ArenaOptions options; options.start_block_size = 256; options.max_block_size = 8192; options.initial_block = &arena_block[0]; options.initial_block_size = arena_block.size(); Arena arena_2(options); EXPECT_EQ(1024, arena_2.SpaceAllocated()); EXPECT_EQ(0, arena_2.SpaceUsed()); EXPECT_EQ(1024, arena_2.Reset()); Arena::CreateArray(&arena_2, 55); EXPECT_EQ(1024, arena_2.SpaceAllocated()); EXPECT_EQ(Align8(55), arena_2.SpaceUsed()); EXPECT_EQ(1024, arena_2.Reset()); } TEST(ArenaTest, BlockSizeDoubling) { Arena arena; EXPECT_EQ(0, arena.SpaceUsed()); EXPECT_EQ(0, arena.SpaceAllocated()); // Allocate something to get initial block size. Arena::CreateArray(&arena, 1); auto first_block_size = arena.SpaceAllocated(); // Keep allocating until space used increases. while (arena.SpaceAllocated() == first_block_size) { Arena::CreateArray(&arena, 1); } ASSERT_GT(arena.SpaceAllocated(), first_block_size); auto second_block_size = (arena.SpaceAllocated() - first_block_size); EXPECT_EQ(second_block_size, 2*first_block_size); } TEST(ArenaTest, Alignment) { Arena arena; for (int i = 0; i < 200; i++) { void* p = Arena::CreateArray(&arena, i); GOOGLE_CHECK_EQ(reinterpret_cast(p) % 8, 0) << i << ": " << p; } } TEST(ArenaTest, BlockSizeSmallerThanAllocation) { for (size_t i = 0; i <= 8; ++i) { ArenaOptions opt; opt.start_block_size = opt.max_block_size = i; Arena arena(opt); *Arena::Create(&arena) = 42; EXPECT_GE(arena.SpaceAllocated(), 8); EXPECT_EQ(8, arena.SpaceUsed()); *Arena::Create(&arena) = 42; EXPECT_GE(arena.SpaceAllocated(), 16); EXPECT_EQ(16, arena.SpaceUsed()); } } TEST(ArenaTest, GetArenaShouldReturnTheArenaForArenaAllocatedMessages) { Arena arena; ArenaMessage* message = Arena::CreateMessage(&arena); const ArenaMessage* const_pointer_to_message = message; EXPECT_EQ(&arena, Arena::GetArena(message)); EXPECT_EQ(&arena, Arena::GetArena(const_pointer_to_message)); // Test that the Message* / MessageLite* specialization SFINAE works. const Message* const_pointer_to_message_type = message; EXPECT_EQ(&arena, Arena::GetArena(const_pointer_to_message_type)); const MessageLite* const_pointer_to_message_lite_type = message; EXPECT_EQ(&arena, Arena::GetArena(const_pointer_to_message_lite_type)); } TEST(ArenaTest, GetArenaShouldReturnNullForNonArenaAllocatedMessages) { ArenaMessage message; const ArenaMessage* const_pointer_to_message = &message; EXPECT_EQ(NULL, Arena::GetArena(&message)); EXPECT_EQ(NULL, Arena::GetArena(const_pointer_to_message)); } TEST(ArenaTest, GetArenaShouldReturnNullForNonArenaCompatibleTypes) { // Test that GetArena returns nullptr for types that have a GetArena method // that doesn't return Arena*. struct { int GetArena() const { return 0; } } has_get_arena_method_wrong_return_type; EXPECT_EQ(nullptr, Arena::GetArena(&has_get_arena_method_wrong_return_type)); // Test that GetArena returns nullptr for types that have a GetArena alias. struct { using GetArena = Arena*; GetArena unused; } has_get_arena_alias; EXPECT_EQ(nullptr, Arena::GetArena(&has_get_arena_alias)); // Test that GetArena returns nullptr for types that have a GetArena data // member. struct { Arena GetArena; } has_get_arena_data_member; EXPECT_EQ(nullptr, Arena::GetArena(&has_get_arena_data_member)); } TEST(ArenaTest, AddCleanup) { Arena arena; for (int i = 0; i < 100; i++) { arena.Own(new int); } } namespace { uint32_t hooks_num_init = 0; uint32_t hooks_num_allocations = 0; uint32_t hooks_num_reset = 0; uint32_t hooks_num_destruct = 0; void ClearHookCounts() { hooks_num_init = 0; hooks_num_allocations = 0; hooks_num_reset = 0; hooks_num_destruct = 0; } } // namespace // A helper utility class that handles arena callbacks. class ArenaOptionsTestFriend final : public internal::ArenaMetricsCollector { public: static internal::ArenaMetricsCollector* NewWithAllocs() { return new ArenaOptionsTestFriend(true); } static internal::ArenaMetricsCollector* NewWithoutAllocs() { return new ArenaOptionsTestFriend(false); } static void Enable(ArenaOptions* options) { ClearHookCounts(); options->make_metrics_collector = &ArenaOptionsTestFriend::NewWithAllocs; } static void EnableWithoutAllocs(ArenaOptions* options) { ClearHookCounts(); options->make_metrics_collector = &ArenaOptionsTestFriend::NewWithoutAllocs; } explicit ArenaOptionsTestFriend(bool record_allocs) : ArenaMetricsCollector(record_allocs) { ++hooks_num_init; } void OnDestroy(uint64_t space_allocated) override { ++hooks_num_destruct; delete this; } void OnReset(uint64_t space_allocated) override { ++hooks_num_reset; } void OnAlloc(const std::type_info* allocated_type, uint64_t alloc_size) override { ++hooks_num_allocations; } }; // Test the hooks are correctly called. TEST(ArenaTest, ArenaHooksSanity) { ArenaOptions options; ArenaOptionsTestFriend::Enable(&options); // Scope for defining the arena { Arena arena(options); EXPECT_EQ(1, hooks_num_init); EXPECT_EQ(0, hooks_num_allocations); Arena::Create(&arena); if (std::is_trivially_destructible::value) { EXPECT_EQ(1, hooks_num_allocations); } else { EXPECT_EQ(2, hooks_num_allocations); } arena.Reset(); arena.Reset(); EXPECT_EQ(2, hooks_num_reset); } EXPECT_EQ(2, hooks_num_reset); EXPECT_EQ(1, hooks_num_destruct); } // Test that allocation hooks are not called when we don't need them. TEST(ArenaTest, ArenaHooksWhenAllocationsNotNeeded) { ArenaOptions options; ArenaOptionsTestFriend::EnableWithoutAllocs(&options); Arena arena(options); EXPECT_EQ(0, hooks_num_allocations); Arena::Create(&arena); EXPECT_EQ(0, hooks_num_allocations); } } // namespace protobuf } // namespace google #include