BigfootDev/flatbuffers
1
0
Fork 1
mirror of https://github.com/google/flatbuffers.git synced 2026-06-15 08:48:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Efficient Conversion of a FlatBufferBuilder to a MessageBuilder (#4980)

Browse Source 
* Efficient conversion of FlatBufferBuilder to grpc::MessageBuilder

* Added a variety of tests to validate correctness of the MessageBuilder move operations.
Disable MessageBuilder half-n-half tests on MacOS.

* Fix failing Android build

* Generalized the MessageBuilder move constructor to accept a deallocator
This commit is contained in:
Sumant Tambe
2018-10-18 10:32:59 -07:00
committed by Wouter van Oortmerssen
parent ad8b1e5dbd
commit 802639e40d
6 changed files with 441 additions and 220 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
tests/test_builder.cpp
View File

@@ -129,7 +129,9 @@ bool release_n_verify(flatbuffers::FlatBufferBuilder &fbb, const std::string &ex
}
void FlatBufferBuilderTest() {
BuilderTests<flatbuffers::FlatBufferBuilder>::all_tests();
using flatbuffers::FlatBufferBuilder;
BuilderTests<FlatBufferBuilder>::all_tests();
BuilderTests<TestHeapBuilder>::all_tests();
BuilderTests<GrpcLikeMessageBuilder>::all_tests();
@@ -140,7 +142,7 @@ void FlatBufferBuilderTest() {
REUSABLE_AFTER_RELEASE_RAW_AND_MOVE_ASSIGN
};
BuilderReuseTests<flatbuffers::FlatBufferBuilder>::run_tests(TestSelector(tests, tests+4));
BuilderReuseTests<TestHeapBuilder>::run_tests(TestSelector(tests, tests+4));
BuilderReuseTests<GrpcLikeMessageBuilder>::run_tests(TestSelector(tests, tests+4));
BuilderReuseTests<FlatBufferBuilder, FlatBufferBuilder>::run_tests(TestSelector(tests, tests+4));
BuilderReuseTests<TestHeapBuilder, TestHeapBuilder>::run_tests(TestSelector(tests, tests+4));
BuilderReuseTests<GrpcLikeMessageBuilder, GrpcLikeMessageBuilder>::run_tests(TestSelector(tests, tests+4));
}

283
tests/test_builder.h
View File

@@ -2,6 +2,7 @@
#define TEST_BUILDER_H
#include <set>
#include <type_traits>
#include "monster_test_generated.h"
#include "flatbuffers/flatbuffers.h"
#include "test_assert.h"
@@ -13,6 +14,16 @@ class MessageBuilder;
}
}
template <class T, class U>
struct is_same {
static const bool value = false;
};
template <class T>
struct is_same<T, T> {
static const bool value = true;
};
extern const std::string m1_name;
extern const Color m1_color;
extern const std::string m2_name;
@@ -32,145 +43,157 @@ bool verify(const uint8_t *buf, size_t offset, const std::string &expected_name,
bool release_n_verify(flatbuffers::FlatBufferBuilder &fbb, const std::string &expected_name, Color color);
bool release_n_verify(flatbuffers::grpc::MessageBuilder &mbb, const std::string &expected_name, Color color);
// clang-format off
#if !defined(FLATBUFFERS_CPP98_STL)
// clang-format on
template <class Builder>
void builder_move_assign_after_releaseraw_test(Builder b1) {
auto root_offset1 = populate1(b1);
b1.Finish(root_offset1);
size_t size, offset;
b1.ReleaseRaw(size, offset);
Builder src;
auto root_offset2 = populate2(src);
src.Finish(root_offset2);
auto src_size = src.GetSize();
// Move into a released builder.
b1 = std::move(src);
TEST_EQ_FUNC(b1.GetSize(), src_size);
TEST_ASSERT_FUNC(release_n_verify(b1, m2_name, m2_color));
TEST_EQ_FUNC(src.GetSize(), 0);
}
// clang-format off
#endif // !defined(FLATBUFFERS_CPP98_STL)
// clang-format on
void builder_move_assign_after_releaseraw_test(flatbuffers::grpc::MessageBuilder b1);
template <class DestBuilder, class SrcBuilder = DestBuilder>
struct BuilderTests {
// clang-format off
#if !defined(FLATBUFFERS_CPP98_STL)
// clang-format on
static void empty_builder_movector_test() {
Builder b1;
size_t b1_size = b1.GetSize();
Builder b2(std::move(b1));
size_t b2_size = b2.GetSize();
TEST_EQ_FUNC(b1_size, 0);
TEST_EQ_FUNC(b1_size, b2_size);
SrcBuilder src;
size_t src_size = src.GetSize();
DestBuilder dst(std::move(src));
size_t dst_size = dst.GetSize();
TEST_EQ_FUNC(src_size, 0);
TEST_EQ_FUNC(src_size, dst_size);
}
static void nonempty_builder_movector_test() {
Builder b1;
populate1(b1);
size_t b1_size = b1.GetSize();
Builder b2(std::move(b1));
TEST_EQ_FUNC(b1_size, b2.GetSize());
TEST_EQ_FUNC(b1.GetSize(), 0);
SrcBuilder src;
populate1(src);
size_t src_size = src.GetSize();
DestBuilder dst(std::move(src));
TEST_EQ_FUNC(src_size, dst.GetSize());
TEST_EQ_FUNC(src.GetSize(), 0);
}
static void builder_movector_before_finish_test() {
Builder b1;
auto root_offset1 = populate1(b1);
Builder b2(std::move(b1));
b2.Finish(root_offset1);
TEST_ASSERT_FUNC(release_n_verify(b2, m1_name, m1_color));
TEST_EQ_FUNC(b1.GetSize(), 0);
SrcBuilder src;
auto root_offset1 = populate1(src);
DestBuilder dst(std::move(src));
dst.Finish(root_offset1);
TEST_ASSERT_FUNC(release_n_verify(dst, m1_name, m1_color));
TEST_EQ_FUNC(src.GetSize(), 0);
}
static void builder_movector_after_finish_test() {
Builder b1;
auto root_offset1 = populate1(b1);
b1.Finish(root_offset1);
auto b1_size = b1.GetSize();
Builder b2(std::move(b1));
TEST_EQ_FUNC(b2.GetSize(), b1_size);
TEST_ASSERT_FUNC(release_n_verify(b2, m1_name, m1_color));
TEST_EQ_FUNC(b1.GetSize(), 0);
SrcBuilder src;
auto root_offset1 = populate1(src);
src.Finish(root_offset1);
auto src_size = src.GetSize();
DestBuilder dst(std::move(src));
TEST_EQ_FUNC(dst.GetSize(), src_size);
TEST_ASSERT_FUNC(release_n_verify(dst, m1_name, m1_color));
TEST_EQ_FUNC(src.GetSize(), 0);
}
static void builder_move_assign_before_finish_test() {
Builder b1;
auto root_offset1 = populate1(b1);
Builder b2;
populate2(b2);
b2 = std::move(b1);
b2.Finish(root_offset1);
TEST_ASSERT_FUNC(release_n_verify(b2, m1_name, m1_color));
TEST_EQ_FUNC(b1.GetSize(), 0);
SrcBuilder src;
auto root_offset1 = populate1(src);
DestBuilder dst;
populate2(dst);
dst = std::move(src);
dst.Finish(root_offset1);
TEST_ASSERT_FUNC(release_n_verify(dst, m1_name, m1_color));
TEST_EQ_FUNC(src.GetSize(), 0);
}
static void builder_move_assign_after_finish_test() {
Builder b1;
auto root_offset1 = populate1(b1);
b1.Finish(root_offset1);
auto b1_size = b1.GetSize();
Builder b2;
auto root_offset2 = populate2(b2);
b2.Finish(root_offset2);
b2 = std::move(b1);
TEST_EQ_FUNC(b2.GetSize(), b1_size);
TEST_ASSERT_FUNC(release_n_verify(b2, m1_name, m1_color));
TEST_EQ_FUNC(b1.GetSize(), 0);
SrcBuilder src;
auto root_offset1 = populate1(src);
src.Finish(root_offset1);
auto src_size = src.GetSize();
DestBuilder dst;
auto root_offset2 = populate2(dst);
dst.Finish(root_offset2);
dst = std::move(src);
TEST_EQ_FUNC(dst.GetSize(), src_size);
TEST_ASSERT_FUNC(release_n_verify(dst, m1_name, m1_color));
TEST_EQ_FUNC(src.GetSize(), 0);
}
static void builder_move_assign_after_release_test() {
Builder b1;
auto root_offset1 = populate1(b1);
b1.Finish(root_offset1);
DestBuilder dst;
auto root_offset1 = populate1(dst);
dst.Finish(root_offset1);
{
flatbuffers::DetachedBuffer b1_detached = b1.Release();
flatbuffers::DetachedBuffer dst_detached = dst.Release();
// detached buffer is deleted
}
Builder b2;
auto root_offset2 = populate2(b2);
b2.Finish(root_offset2);
auto b2_size = b2.GetSize();
SrcBuilder src;
auto root_offset2 = populate2(src);
src.Finish(root_offset2);
auto src_size = src.GetSize();
// Move into a released builder.
b1 = std::move(b2);
TEST_EQ_FUNC(b1.GetSize(), b2_size);
TEST_ASSERT_FUNC(release_n_verify(b1, m2_name, m2_color));
TEST_EQ_FUNC(b2.GetSize(), 0);
}
static void builder_move_assign_after_releaseraw_test() {
Builder b1;
auto root_offset1 = populate1(b1);
b1.Finish(root_offset1);
size_t size, offset;
uint8_t *buf = release_raw_base(b1, size, offset);
TEST_ASSERT_FUNC(verify(buf, offset, m1_name, m1_color));
free_raw(b1, buf);
Builder b2;
auto root_offset2 = populate2(b2);
b2.Finish(root_offset2);
auto b2_size = b2.GetSize();
// Move into a released builder.
b1 = std::move(b2);
TEST_EQ_FUNC(b1.GetSize(), b2_size);
TEST_ASSERT_FUNC(release_n_verify(b1, m2_name, m2_color));
TEST_EQ_FUNC(b2.GetSize(), 0);
dst = std::move(src);
TEST_EQ_FUNC(dst.GetSize(), src_size);
TEST_ASSERT_FUNC(release_n_verify(dst, m2_name, m2_color));
TEST_EQ_FUNC(src.GetSize(), 0);
}
// clang-format off
#endif // !defined(FLATBUFFERS_CPP98_STL)
// clang-format on
static void builder_swap_before_finish_test() {
Builder b1;
auto root_offset1 = populate1(b1);
auto size1 = b1.GetSize();
Builder b2;
auto root_offset2 = populate2(b2);
auto size2 = b2.GetSize();
b1.Swap(b2);
b1.Finish(root_offset2);
b2.Finish(root_offset1);
TEST_EQ_FUNC(b1.GetSize() > size2, true);
TEST_EQ_FUNC(b2.GetSize() > size1, true);
TEST_ASSERT_FUNC(release_n_verify(b1, m2_name, m2_color));
TEST_ASSERT_FUNC(release_n_verify(b2, m1_name, m1_color));
static void builder_swap_before_finish_test(bool run = is_same<DestBuilder, SrcBuilder>::value) {
/// Swap is allowed only when lhs and rhs are the same concrete type.
if(run) {
SrcBuilder src;
auto root_offset1 = populate1(src);
auto size1 = src.GetSize();
DestBuilder dst;
auto root_offset2 = populate2(dst);
auto size2 = dst.GetSize();
src.Swap(dst);
src.Finish(root_offset2);
dst.Finish(root_offset1);
TEST_EQ_FUNC(src.GetSize() > size2, true);
TEST_EQ_FUNC(dst.GetSize() > size1, true);
TEST_ASSERT_FUNC(release_n_verify(src, m2_name, m2_color));
TEST_ASSERT_FUNC(release_n_verify(dst, m1_name, m1_color));
}
}
static void builder_swap_after_finish_test() {
Builder b1;
auto root_offset1 = populate1(b1);
b1.Finish(root_offset1);
auto size1 = b1.GetSize();
Builder b2;
auto root_offset2 = populate2(b2);
b2.Finish(root_offset2);
auto size2 = b2.GetSize();
b1.Swap(b2);
TEST_EQ_FUNC(b1.GetSize(), size2);
TEST_EQ_FUNC(b2.GetSize(), size1);
TEST_ASSERT_FUNC(release_n_verify(b1, m2_name, m2_color));
TEST_ASSERT_FUNC(release_n_verify(b2, m1_name, m1_color));
static void builder_swap_after_finish_test(bool run = is_same<DestBuilder, SrcBuilder>::value) {
/// Swap is allowed only when lhs and rhs are the same concrete type.
if(run) {
SrcBuilder src;
auto root_offset1 = populate1(src);
src.Finish(root_offset1);
auto size1 = src.GetSize();
DestBuilder dst;
auto root_offset2 = populate2(dst);
dst.Finish(root_offset2);
auto size2 = dst.GetSize();
src.Swap(dst);
TEST_EQ_FUNC(src.GetSize(), size2);
TEST_EQ_FUNC(dst.GetSize(), size1);
TEST_ASSERT_FUNC(release_n_verify(src, m2_name, m2_color));
TEST_ASSERT_FUNC(release_n_verify(dst, m1_name, m1_color));
}
}
static void all_tests() {
@@ -184,7 +207,7 @@ struct BuilderTests {
builder_move_assign_before_finish_test();
builder_move_assign_after_finish_test();
builder_move_assign_after_release_test();
builder_move_assign_after_releaseraw_test();
builder_move_assign_after_releaseraw_test(DestBuilder());
// clang-format off
#endif // !defined(FLATBUFFERS_CPP98_STL)
// clang-format on
@@ -204,19 +227,19 @@ enum BuilderReuseTestSelector {
typedef std::set<BuilderReuseTestSelector> TestSelector;
template <class Builder>
template <class DestBuilder, class SrcBuilder>
struct BuilderReuseTests {
static void builder_reusable_after_release_test(TestSelector selector) {
if (!selector.count(REUSABLE_AFTER_RELEASE)) {
return;
}
Builder b1;
DestBuilder fbb;
std::vector<flatbuffers::DetachedBuffer> buffers;
for (int i = 0; i < 5; ++i) {
auto root_offset1 = populate1(b1);
b1.Finish(root_offset1);
buffers.push_back(b1.Release());
auto root_offset1 = populate1(fbb);
fbb.Finish(root_offset1);
buffers.push_back(fbb.Release());
TEST_ASSERT_FUNC(verify(buffers[i], m1_name, m1_color));
}
}
@@ -226,14 +249,14 @@ struct BuilderReuseTests {
return;
}
Builder b1;
DestBuilder fbb;
for (int i = 0; i < 5; ++i) {
auto root_offset1 = populate1(b1);
b1.Finish(root_offset1);
auto root_offset1 = populate1(fbb);
fbb.Finish(root_offset1);
size_t size, offset;
uint8_t *buf = release_raw_base(b1, size, offset);
uint8_t *buf = release_raw_base(fbb, size, offset);
TEST_ASSERT_FUNC(verify(buf, offset, m1_name, m1_color));
free_raw(b1, buf);
free_raw(fbb, buf);
}
}
@@ -245,16 +268,16 @@ struct BuilderReuseTests {
return;
}
Builder b1;
DestBuilder dst;
std::vector<flatbuffers::DetachedBuffer> buffers;
for (int i = 0; i < 5; ++i) {
auto root_offset1 = populate1(b1);
b1.Finish(root_offset1);
buffers.push_back(b1.Release());
auto root_offset1 = populate1(dst);
dst.Finish(root_offset1);
buffers.push_back(dst.Release());
TEST_ASSERT_FUNC(verify(buffers[i], m1_name, m1_color));
Builder b2;
b1 = std::move(b2);
TEST_EQ_FUNC(b2.GetSize(), 0);
SrcBuilder src;
dst = std::move(src);
TEST_EQ_FUNC(src.GetSize(), 0);
}
}
@@ -263,17 +286,17 @@ struct BuilderReuseTests {
return;
}
Builder b1;
DestBuilder dst;
for (int i = 0; i < 5; ++i) {
auto root_offset1 = populate1(b1);
b1.Finish(root_offset1);
auto root_offset1 = populate1(dst);
dst.Finish(root_offset1);
size_t size, offset;
uint8_t *buf = release_raw_base(b1, size, offset);
uint8_t *buf = release_raw_base(dst, size, offset);
TEST_ASSERT_FUNC(verify(buf, offset, m1_name, m1_color));
free_raw(b1, buf);
Builder b2;
b1 = std::move(b2);
TEST_EQ_FUNC(b2.GetSize(), 0);
free_raw(dst, buf);
SrcBuilder src;
dst = std::move(src);
TEST_EQ_FUNC(src.GetSize(), 0);
}
}
// clang-format off