Skip to content

Noncontiguous View Support #245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jasongraffius wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Noncontiguous View Support #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1aa0bf5
Introduce noncontiguous container utility
jasongraffius Feb 27, 2026
2d4bd2a
Add UnalignedAccessor to read/write through iterator
jasongraffius Feb 27, 2026
cfa0610
Introduce IteratorStorage for any iterable
jasongraffius Mar 4, 2026
3033ea8
Add support for IteratorStorage to Make<Struct>View
jasongraffius Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions compiler/back_end/cpp/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,23 @@ emboss_cc_test(
],
deps = [
"//testdata:alignments_emboss",
"//runtime/cpp/test/util:noncontiguous_container",
"@com_google_googletest//:gtest_main",
],
)

emboss_cc_test(
name = "iterator_view_integration_test",
srcs = [
"testcode/iterator_view_integration_test.cc",
],
deps = [
"//testdata:alignments_emboss",
"//testdata:condition_emboss",
"//testdata:dynamic_size_emboss",
"//testdata:uint_sizes_emboss",
"//testdata:virtual_field_emboss",
"//runtime/cpp/test/util:noncontiguous_container",
"@com_google_googletest//:gtest_main",
],
)
Expand Down
34 changes: 34 additions & 0 deletions compiler/back_end/cpp/generated_code_templates
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,40 @@ MakeAligned${name}View(
emboss_reserved_local_size);
}

template <typename Iterator,
typename = typename ::std::enable_if<
!::std::is_pointer<Iterator>::value>::type>
inline Generic${name}View<
/**/ ::emboss::support::IteratorStorage<Iterator>>
Make${name}View(${constructor_parameters} Iterator emboss_reserved_local_begin,
Iterator emboss_reserved_local_end) {
return Generic${name}View<
/**/ ::emboss::support::IteratorStorage<Iterator>>(
${forwarded_parameters} ::emboss::support::IteratorStorage<Iterator>(
::std::move(emboss_reserved_local_begin),
::std::move(emboss_reserved_local_end)));
}

template <typename Container,
typename = typename ::std::enable_if<
!EmbossReservedInternalIsGeneric${name}View<
typename ::std::remove_cv<typename ::std::remove_reference<
Container>::type>::type>::value &&
!::std::is_pointer<typename ::std::remove_reference<
Container>::type>::value>::type>
inline Generic${name}View<
/**/ ::emboss::support::IteratorStorage<
decltype(::std::begin(::std::declval<Container &>()))>>
Make${name}View(${constructor_parameters} Container &&emboss_reserved_local_container) {
return Generic${name}View<
/**/ ::emboss::support::IteratorStorage<
decltype(::std::begin(::std::declval<Container &>()))>>(
${forwarded_parameters} ::emboss::support::IteratorStorage<
decltype(::std::begin(::std::declval<Container &>()))>(
::std::begin(emboss_reserved_local_container),
::std::end(emboss_reserved_local_container)));
}

// ** struct_text_stream ** ////////////////////////////////////////////////////
template <class Stream>
bool UpdateFromTextStream(Stream *emboss_reserved_local_stream) const {
Expand Down
225 changes: 225 additions & 0 deletions compiler/back_end/cpp/testcode/iterator_view_integration_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
#include <gtest/gtest.h>

#include <cstddef>
#include <vector>

#include "runtime/cpp/test/util/noncontiguous_container.h"
#include "testdata/alignments.emb.h"
#include "testdata/condition.emb.h"
#include "testdata/dynamic_size.emb.h"
#include "testdata/uint_sizes.emb.h"
#include "testdata/virtual_field.emb.h"

namespace emboss {
namespace test {
namespace {

template <typename CharT>
void TestMakeAlignmentsViewIntegration() {
using ByteT = typename std::remove_const<CharT>::type;

std::vector<std::vector<ByteT>> chunks = {
{ByteT(0x11), ByteT(0x22)},
{ByteT(0x33), ByteT(0x44), ByteT(0x55)},
{ByteT(0x66), ByteT(0x77), ByteT(0x88)},
{ByteT(0x00), ByteT(0x00), ByteT(0x00), ByteT(0x00)},
{ByteT(0x00), ByteT(0x00), ByteT(0x00), ByteT(0x00)},
{ByteT(0x00), ByteT(0x00), ByteT(0x00), ByteT(0x00)},
{ByteT(0x00), ByteT(0x00), ByteT(0x00), ByteT(0x00)},
{ByteT(0x00), ByteT(0x00), ByteT(0x00), ByteT(0x00)}};

::emboss::support::test::NoncontiguousContainer<ByteT> container(chunks);

auto view = MakeAlignmentsView(container);
EXPECT_TRUE(view.Ok());
EXPECT_EQ(view.SizeInBytes(), 28U);

EXPECT_EQ(view.zero_offset().dummy().Read(), 0x11223344U);
EXPECT_EQ(view.three_offset().dummy().Read(), 0x44556677U);
EXPECT_EQ(view.four_offset().dummy().Read(), 0x55667788U);
}

TEST(IteratorViewIntegrationTest, MakeAlignmentsView) {
TestMakeAlignmentsViewIntegration<const char>();
TestMakeAlignmentsViewIntegration<char>();
TestMakeAlignmentsViewIntegration<const unsigned char>();
TestMakeAlignmentsViewIntegration<unsigned char>();
#if __cplusplus >= 201703L
TestMakeAlignmentsViewIntegration<const std::byte>();
TestMakeAlignmentsViewIntegration<std::byte>();
#endif
}

// ---------------------------------------------------------
// BasicConditional from condition.emb (LittleEndian)
// 0 [+1] UInt x; if x == 0: 1 [+1] UInt xc
// ---------------------------------------------------------

template <typename CharT>
void TestBasicConditionalViewIntegration() {
using ByteT = typename std::remove_const<CharT>::type;

std::vector<std::vector<ByteT>> chunks = {
{ByteT(0x00)}, // x == 0
{ByteT(0xAA)} // xc == 0xAA
};
::emboss::support::test::NoncontiguousContainer<ByteT> container(chunks);

auto view = MakeBasicConditionalView(container);
EXPECT_TRUE(view.Ok());
EXPECT_EQ(view.SizeInBytes(), 2U);
EXPECT_EQ(view.x().Read(), 0U);
EXPECT_EQ(view.xc().Read(), 0xAAU);

std::vector<std::vector<ByteT>> chunks2 = {
{ByteT(0x01)}, // x == 1
};
::emboss::support::test::NoncontiguousContainer<ByteT> container2(chunks2);
auto view2 = MakeBasicConditionalView(container2);
EXPECT_TRUE(view2.Ok());
EXPECT_EQ(view2.SizeInBytes(), 1U);

std::vector<std::vector<ByteT>> chunks_fail = {
{ByteT(0x00)}, // x == 0
};
::emboss::support::test::NoncontiguousContainer<ByteT> container_fail(
chunks_fail);
auto view_fail = MakeBasicConditionalView(container_fail);
EXPECT_FALSE(view_fail.IsComplete());
}

TEST(IteratorViewIntegrationTest, BasicConditional) {
TestBasicConditionalViewIntegration<char>();
TestBasicConditionalViewIntegration<const char>();
TestBasicConditionalViewIntegration<unsigned char>();
TestBasicConditionalViewIntegration<const unsigned char>();
#if __cplusplus >= 201703L
TestBasicConditionalViewIntegration<std::byte>();
TestBasicConditionalViewIntegration<const std::byte>();
#endif
}

// ---------------------------------------------------------
// AlternatingEndianSizes from uint_sizes.emb
// Mixture of LittleEndian and BigEndian
// ---------------------------------------------------------
template <typename CharT>
void TestAlternatingEndianSizesViewIntegration() {
using ByteT = typename std::remove_const<CharT>::type;

std::vector<std::vector<ByteT>> chunks = {
{ByteT(0x11)}, // one_byte (BigEndian)
{ByteT(0x22), ByteT(0x33)}, // two_byte (LittleEndian) = 0x3322
{ByteT(0x44)}, // split...
{ByteT(0x55), ByteT(0x66)}, // three_byte (BigEndian) = 0x445566
{ByteT(0x77), ByteT(0x88), ByteT(0x99),
ByteT(0xAA)} // four_byte (LittleEndian) = 0xAA998877
};

// Adding the rest to reach 36 bytes (8 fields)
chunks.push_back(std::vector<ByteT>(26));

::emboss::support::test::NoncontiguousContainer<ByteT> container(chunks);

auto view = MakeAlternatingEndianSizesView(container);
EXPECT_TRUE(view.Ok());
EXPECT_EQ(view.one_byte().Read(), 0x11U);
EXPECT_EQ(view.two_byte().Read(), 0x3322U);
EXPECT_EQ(view.three_byte().Read(), 0x445566U);
EXPECT_EQ(view.four_byte().Read(), 0xAA998877U);
}

TEST(IteratorViewIntegrationTest, AlternatingEndianSizes) {
TestAlternatingEndianSizesViewIntegration<char>();
TestAlternatingEndianSizesViewIntegration<const char>();
TestAlternatingEndianSizesViewIntegration<unsigned char>();
TestAlternatingEndianSizesViewIntegration<const unsigned char>();
#if __cplusplus >= 201703L
TestAlternatingEndianSizesViewIntegration<std::byte>();
TestAlternatingEndianSizesViewIntegration<const std::byte>();
#endif
}

// ---------------------------------------------------------
// Message from dynamic_size.emb
// struct Message:
// 0 [+1] UInt header_length (h)
// 1 [+1] UInt message_length (m)
// 2 [+h-2] UInt:8[h-2] padding
// h [+m] UInt:8[m] message
// h+m [+4] UInt crc32
// ---------------------------------------------------------
template <typename CharT>
void TestMessageDynamicSizeIntegration() {
using ByteT = typename std::remove_const<CharT>::type;

// h = 4, m = 3
std::vector<std::vector<ByteT>> chunks = {
{ByteT(4)}, // header_length
{ByteT(3)}, // message_length
{ByteT(0x00), ByteT(0x00)}, // padding
{ByteT(0xAA), ByteT(0xBB)}, // message byte 0, 1
{ByteT(0xCC)}, // message byte 2
{ByteT(0x11), ByteT(0x22), ByteT(0x33), ByteT(0x44)} // crc32
};

::emboss::support::test::NoncontiguousContainer<ByteT> container(chunks);

auto view = MakeMessageView(container);
EXPECT_TRUE(view.Ok());
EXPECT_EQ(view.SizeInBytes(), 11U);
EXPECT_EQ(view.header_length().Read(), 4U);
EXPECT_EQ(view.message_length().Read(), 3U);

EXPECT_EQ(view.message()[0].Read(), 0xAAU);
EXPECT_EQ(view.message()[1].Read(), 0xBBU);
EXPECT_EQ(view.message()[2].Read(), 0xCCU);

EXPECT_EQ(view.crc32().Read(), 0x44332211U); // Little endian
}

TEST(IteratorViewIntegrationTest, MessageDynamicSize) {
TestMessageDynamicSizeIntegration<char>();
TestMessageDynamicSizeIntegration<const char>();
TestMessageDynamicSizeIntegration<unsigned char>();
TestMessageDynamicSizeIntegration<const unsigned char>();
#if __cplusplus >= 201703L
TestMessageDynamicSizeIntegration<std::byte>();
TestMessageDynamicSizeIntegration<const std::byte>();
#endif
}

// ---------------------------------------------------------
// UsesExternalSize
// ---------------------------------------------------------
template <typename CharT>
void TestUsesExternalSizeIntegration() {
using ByteT = typename std::remove_const<CharT>::type;

std::vector<std::vector<ByteT>> chunks = {
{ByteT(0x11), ByteT(0x22), ByteT(0x33), ByteT(0x44)},
{ByteT(0x55), ByteT(0x66), ByteT(0x77), ByteT(0x88)},
};

::emboss::support::test::NoncontiguousContainer<ByteT> container(chunks);

auto view = MakeUsesExternalSizeView(container);
EXPECT_TRUE(view.Ok());
EXPECT_EQ(view.x().value().Read(), 0x44332211U);
EXPECT_EQ(view.y().value().Read(), 0x88776655U);
}

TEST(IteratorViewIntegrationTest, UsesExternalSize) {
TestUsesExternalSizeIntegration<char>();
TestUsesExternalSizeIntegration<const char>();
TestUsesExternalSizeIntegration<unsigned char>();
TestUsesExternalSizeIntegration<const unsigned char>();
#if __cplusplus >= 201703L
TestUsesExternalSizeIntegration<std::byte>();
TestUsesExternalSizeIntegration<const std::byte>();
#endif
}

} // namespace
} // namespace test
} // namespace emboss
Loading
Loading