Add std430 memory layout

Arthapz · Mar 10, 2024 · 45e5c43 · 45e5c43
1 parent 0042633
commit 45e5c43
Show file tree

Hide file tree

Showing 9 changed files with 93 additions and 16 deletions.
diff --git a/include/NZSL/Ast/Enums.hpp b/include/NZSL/Ast/Enums.hpp
@@ -174,7 +174,8 @@ namespace nzsl::Ast
 
 	enum class MemoryLayout
 	{
-		Std140 = 0
+		Std140 = 0,
+		Std430 = 1
 	};
 
 	enum class ModuleFeature

diff --git a/include/NZSL/Enums.hpp b/include/NZSL/Enums.hpp
@@ -138,8 +138,9 @@ namespace nzsl
 	{
 		Packed,
 		Std140,
+		Std430,
 
-		Max = Std140
+		Max = Std430
 	};
 }
 

diff --git a/include/NZSL/Math/FieldOffsets.inl b/include/NZSL/Math/FieldOffsets.inl
@@ -137,6 +137,7 @@ namespace nzsl
 				return 1;
 
 			case StructLayout::Std140:
+			case StructLayout::Std430:
 			{
 				switch (fieldType)
 				{

diff --git a/src/NZSL/Ast/SanitizeVisitor.cpp b/src/NZSL/Ast/SanitizeVisitor.cpp
@@ -1860,18 +1860,33 @@ namespace nzsl::Ast
 			}
 
 			const ExpressionType& memberType = member.type.GetResultingValue();
-			if (clone->description.layout.IsResultingValue() && clone->description.layout.GetResultingValue() == Ast::MemoryLayout::Std140)
+			if (clone->description.layout.IsResultingValue())
 			{
+				Ast::MemoryLayout structLayout = clone->description.layout.GetResultingValue();
+				auto LayoutName = [&](Ast::MemoryLayout layout)
+				{
+					auto it = LangData::s_memoryLayouts.find(layout);
+					if (it == LangData::s_memoryLayouts.end())
+						throw AstInternalError{ node.sourceLocation, "missing layout data" };
+
+					return it->second.identifier;
+				};
+
 				const ExpressionType& targetType = ResolveAlias(member.type.GetResultingValue());
 
-				if (IsPrimitiveType(targetType) && std::get<PrimitiveType>(targetType) == PrimitiveType::Boolean)
-					throw CompilerStructLayoutTypeNotAllowedError{ member.sourceLocation, "bool", "std140" };
+				if (IsPrimitiveType(targetType))
+				{
+					if (std::get<PrimitiveType>(targetType) == PrimitiveType::Boolean)
+						throw CompilerStructLayoutTypeNotAllowedError{ member.sourceLocation, "bool", LayoutName(structLayout) };
+				}
 				else if (IsStructType(targetType))
 				{
 					std::size_t structIndex = std::get<StructType>(targetType).structIndex;
 					const StructDescription* desc = m_context->structs.Retrieve(structIndex, member.sourceLocation);
-					if (!desc->layout.HasValue() || desc->layout.GetResultingValue() != clone->description.layout.GetResultingValue())
-						throw CompilerStructLayoutInnerMismatchError{ member.sourceLocation, "std140", "<TODO>" };
+					if (!desc->layout.HasValue())
+						throw CompilerStructLayoutInnerMismatchError{ member.sourceLocation, LayoutName(structLayout), "<no layout>" };
+					else if (Ast::MemoryLayout memberLayout = desc->layout.GetResultingValue(); memberLayout != structLayout)
+						throw CompilerStructLayoutInnerMismatchError{ member.sourceLocation, LayoutName(structLayout), LayoutName(memberLayout) };
 				}
 			}
 

diff --git a/src/NZSL/GlslWriter.cpp b/src/NZSL/GlslWriter.cpp
@@ -792,9 +792,8 @@ namespace nzsl
 	{
 		switch (layout)
 		{
-			case Ast::MemoryLayout::Std140:
-				Append("std140");
-				break;
+			case Ast::MemoryLayout::Std140: Append("std140"); break;
+			case Ast::MemoryLayout::Std430: Append("std430"); break;
 		}
 	}
 
@@ -2222,7 +2221,7 @@ namespace nzsl
 
 			bool isUniformOrStorageBuffer = IsStorageType(exprType) || IsUniformType(exprType);
 
-			bool isStd140 = false;
+			const char* memoryLayout = nullptr;
 			if (isUniformOrStorageBuffer)
 			{
 				std::size_t structIndex;
@@ -2237,7 +2236,13 @@ namespace nzsl
 
 				const auto& structInfo = Nz::Retrieve(m_currentState->structs, structIndex);
 				if (structInfo.desc->layout.HasValue())
-					isStd140 = structInfo.desc->layout.GetResultingValue() == Ast::MemoryLayout::Std140;
+				{
+					switch (structInfo.desc->layout.GetResultingValue())
+					{
+						case Ast::MemoryLayout::Std140: memoryLayout = "std140"; break;
+						case Ast::MemoryLayout::Std430: memoryLayout = "std430"; break;
+					}
+				}
 
 				if (!structInfo.desc->tag.empty() && m_currentState->states->debugLevel >= DebugLevel::Minimal)
 					AppendComment("struct tag: " + structInfo.desc->tag);
@@ -2309,10 +2314,10 @@ namespace nzsl
 				}
 			}
 
-			if (isStd140)
+			if (memoryLayout)
 			{
 				BeginLayout();
-				Append("std140");
+				Append(memoryLayout);
 			}
 
 			EndLayout();

diff --git a/src/NZSL/Lang/LangData.hpp b/src/NZSL/Lang/LangData.hpp
@@ -226,7 +226,8 @@ namespace nzsl::LangData
 	};
 
 	constexpr auto s_memoryLayouts = frozen::make_unordered_map<Ast::MemoryLayout, MemoryLayoutData>({
-		{ Ast::MemoryLayout::Std140, { "std140", StructLayout::Std140 } }
+		{ Ast::MemoryLayout::Std140, { "std140", StructLayout::Std140 } },
+		{ Ast::MemoryLayout::Std430, { "std430", StructLayout::Std140 } }
 	});
 
 	constexpr auto s_moduleFeatures = frozen::make_unordered_map<Ast::ModuleFeature, ModuleFeatureData>({

diff --git a/tests/src/Tests/ErrorsTests.cpp b/tests/src/Tests/ErrorsTests.cpp
@@ -742,6 +742,40 @@ fn main()
 
 		/************************************************************************/
 
+		SECTION("Layouts")
+		{
+			CHECK_THROWS_WITH(Compile(R"(
+[nzsl_version("1.0")]
+module;
+
+[layout(std140)]
+struct Foo
+{
+	a: bool
+}
+)"), "(8, 2): CStructLayoutTypeNotAllowed error: bool type is not allowed in std140 layout");
+
+			CHECK_THROWS_WITH(Compile(R"(
+[nzsl_version("1.0")]
+module;
+
+[layout(std140)]
+struct Foo
+{
+	a: i32
+}
+
+[layout(std430)]
+struct Bar
+{
+	a: Foo
+}
+)"), "(14, 2): CStructLayoutInnerMismatch error: inner struct layout mismatch, struct is declared with std430 but field has layout std140");
+
+		}
+
+		/************************************************************************/
+
 		SECTION("Loops")
 		{
 			CHECK_THROWS_WITH(Compile(R"(

diff --git a/tests/src/Tests/ExternalTests.cpp b/tests/src/Tests/ExternalTests.cpp
@@ -417,6 +417,7 @@ fn main()
 [nzsl_version("1.0")]
 module;
 
+[layout(std430)]
 struct Data
 {
 	data: u32,
@@ -444,7 +445,7 @@ fn main()
 			glslEnv.glMinorVersion = 1;
 
 			ExpectGLSL(*shaderModule, R"(
-buffer _nzslBindingdata
+layout(std430) buffer _nzslBindingdata
 {
 	uint data;
 	float values[];
@@ -458,6 +459,7 @@ void main()
 )", {}, glslEnv);
 
 			ExpectNZSL(*shaderModule, R"(
+[layout(std430)]
 struct Data
 {
 	data: u32,

diff --git a/tests/src/Tests/FieldOffsetsTests.cpp b/tests/src/Tests/FieldOffsetsTests.cpp
@@ -20,6 +20,23 @@ TEST_CASE("Field offsets", "[FieldOffsets]")
 		REQUIRE(fieldOffsets.AddField(nzsl::StructFieldType::Float3) == 416);
 		REQUIRE(fieldOffsets.GetAlignedSize() == 432);
 	}
+
+	// From https://github.com/shader-slang/slang/blob/master/tests/reflection/std430-layout.glsl
+	SECTION("std430")
+	{
+		nzsl::FieldOffsets innerStruct(nzsl::StructLayout::Std430);
+		innerStruct.AddField(nzsl::StructFieldType::Float2);
+
+		nzsl::FieldOffsets fieldOffsets(nzsl::StructLayout::Std430);
+		REQUIRE(fieldOffsets.AddField(nzsl::StructFieldType::Float1) == 0);
+		REQUIRE(fieldOffsets.AddField(nzsl::StructFieldType::Float3) == 16);
+		REQUIRE(fieldOffsets.AddFieldArray(nzsl::StructFieldType::Float1, 4) == 28);
+		REQUIRE(fieldOffsets.AddField(nzsl::StructFieldType::Float2) == 48);
+		REQUIRE(fieldOffsets.AddStruct(innerStruct) == 56);
+		REQUIRE(fieldOffsets.AddField(nzsl::StructFieldType::Float3) == 64);
+		REQUIRE(fieldOffsets.AddField(nzsl::StructFieldType::Float1) == 76);
+		REQUIRE(fieldOffsets.GetAlignedSize() == 80);
+	}
 }
 
 TEST_CASE("RegisterStructField", "[FieldOffsets]")