Updated SPIRV-Tools and glslang.

Replaced usage of the removed SPIRV remapper from glslang with equivalents
in SPIRV-Tool's optimizer. Also replaced spirv.hpp to that brought in
from SPIRV-Headers.

Use UTF-8 codepage for Windows, allowing for using Unicode paths similar to
what is currently done on Mac and Linux.

Avoid printing full output on invalid arguments. This makes it easier to
see what the error is for a simple mistake. Running tools by themselves
will still show the full help output, but now without other errors, though
will still have a non-zero exit code to indicate that it wasn't a
successful run.

Author: akb825

CMakeLists.txt

@@ -90,7 +90,7 @@ endif()
 
 set(MSL_MAJOR_VERSION 1)
 set(MSL_MINOR_VERSION 8)
-set(MSL_PATCH_VERSION 1)
+set(MSL_PATCH_VERSION 2)
 set(MSL_VERSION ${MSL_MAJOR_VERSION}.${MSL_MINOR_VERSION}.${MSL_PATCH_VERSION})
 
 set(MSL_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})

Compile/SPIRV-Tools

@@ -34,7 +34,6 @@
 #endif
 
 #include "SPIRV/GlslangToSpv.h"
-#include "SPIRV/SPVRemapper.h"
 #include "glslang/Public/ResourceLimits.h"
 
 #if MSL_GCC || MSL_CLANG
@@ -344,30 +343,26 @@ void Compiler::process(SpirV& spirv, int processOptions)
 	if (processOptions == 0)
 		return;
 
-	std::uint32_t options = 0;
+	// NOTE: We have some known invalid code, such as missing bindings. Therefore we need to skip
+	// validation.
+	spv_optimizer_options options = spvOptimizerOptionsCreate();
+	spvOptimizerOptionsSetRunValidator(options, false);
+	spvtools::Optimizer optimizer(SPV_ENV_VULKAN_1_0);
 	if (processOptions & RemapVariables)
-		options |= spv::spirvbin_t::MAP_ALL;
+		optimizer.RegisterPass(spvtools::CreateCanonicalizeIdsPass());
 	if (processOptions & DeadCodeElimination)
-		options |= spv::spirvbin_t::DCE_ALL;
+	{
+		optimizer.RegisterPass(spvtools::CreateEliminateDeadFunctionsPass());
+		optimizer.RegisterPass(spvtools::CreateEliminateDeadConstantPass());
+	}
 	if (processOptions & StripDebug)
-		options |= spv::spirvbin_t::STRIP;
-
-	spv::spirvbin_t remapper;
-	remapper.remap(spirv, options);
-
+		optimizer.RegisterPass(spvtools::CreateStripDebugInfoPass());
 	if (processOptions & Optimize)
-	{
-		// NOTE: We have some known invalid code, such as missing bindings. Therefore we need to
-		// skip validation.
-		spv_optimizer_options options = spvOptimizerOptionsCreate();
-		spvOptimizerOptionsSetRunValidator(options, false);
-		spvtools::Optimizer optimizer(SPV_ENV_VULKAN_1_0);
 		optimizer.RegisterPerformancePasses();
-		SpirV optimizedSpirV;
-		if (optimizer.Run(spirv.data(), spirv.size(), &optimizedSpirV, options))
-			spirv = std::move(optimizedSpirV);
-		spvOptimizerOptionsDestroy(options);
-	}
+	SpirV optimizedSpirV;
+	if (optimizer.Run(spirv.data(), spirv.size(), &optimizedSpirV, options))
+		spirv = std::move(optimizedSpirV);
+	spvOptimizerOptionsDestroy(options);
 }
 
 } // namespace msl

Compile/glslang

@@ -17,7 +17,7 @@
 #include "SpirVProcessor.h"
 #include <MSL/Compile/CompiledResult.h>
 #include <MSL/Compile/Output.h>
-#include <SPIRV/spirv.hpp>
+#include <spirv/unified1/spirv.hpp>
 #include <algorithm>
 #include <cassert>
 #include <cstring>

Compile/src/Compiler.cpp

@@ -29,7 +29,7 @@
 #include <boost/algorithm/string/classification.hpp>
 #include <boost/algorithm/string/split.hpp>
 #include <boost/algorithm/string/trim.hpp>
-#include <SPIRV/spirv.hpp>
+#include <spirv/unified1/spirv.hpp>
 
 #include <algorithm>
 #include <cassert>

Compile/src/SpirVProcessor.cpp

@@ -3,6 +3,11 @@ find_package(Boost CONFIG COMPONENTS program_options filesystem)
 file(GLOB_RECURSE sources *.cpp *.h)
 add_executable(mslb-extract ${sources})
 
+if (WIN32)
+	configure_file(mslb-extract.manifest.in ${CMAKE_CURRENT_BINARY_DIR}/mslb-extract.manifest @ONLY)
+	target_sources(mslb-extract PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/mslb-extract.manifest)
+endif()
+
 target_link_libraries(mslb-extract PRIVATE MSL::Client Boost::program_options Boost::filesystem)
 target_compile_definitions(mslb-extract PRIVATE BOOST_ALL_NO_LIB
 	MSL_MAJOR_VERSION=${MSL_MAJOR_VERSION} MSL_MINOR_VERSION=${MSL_MINOR_VERSION}

Compile/src/Target.cpp

@@ -359,6 +359,24 @@ static const char* stageNames[] =
 static_assert(sizeof(stageNames)/sizeof(*stageNames) == msl::stageCount,
 	"stageNames out of sync with enum");
 
+static const char* programName(const char* programPath)
+{
+	std::size_t length = std::strlen(programPath);
+	for (std::size_t i = length; i-- > 0;)
+	{
+#if MSL_WINDOWS
+		if (programPath[i] == '/' || programPath[i] == '\\')
+#else
+		if (programPath[i] == '/')
+#endif
+		{
+			return programPath + i + 1;
+		}
+	}
+
+	return programPath;
+}
+
 static bool shadersAreText(const msl::Module& module)
 {
 	uint32_t targetId = module.targetId();
@@ -1188,12 +1206,13 @@ int main(int argc, char** argv)
 	{
 		if (!options.count("help") && !options.count("version"))
 		{
-			std::cerr << "error: " << e.what() << std::endl << std::endl;
+			if (argc > 1)
+				std::cerr << "error: " << e.what() << std::endl;
 			exitCode = 1;
 		}
 	}
 
-	if (options.count("help") || exitCode != 0)
+	if (options.count("help") || argc <= 1)
 	{
 		std::cout << "Usage: mslb-extract -i input -o output" << std::endl <<
 			std::endl;
@@ -1227,6 +1246,11 @@ int main(int argc, char** argv)
 			"." << MSL_PATCH_VERSION << std::endl;
 		return exitCode;
 	}
+	else if (exitCode != 0)
+	{
+		std::cerr << "Run " << programName(argv[0]) << " -h for usage." << std::endl;
+		return exitCode;
+	}
 
 	msl::Module module;
 	std::string moduleFile = options["input"].as<std::string>();

tools/mslb-extract/CMakeLists.txt

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<assembly manifestVersion="1.0" xmlns="urn:schemas-microsoft-com:asm.v1">
+  <assemblyIdentity type="win32" name="mslb-extract" version="@[email protected]"/>
+  <application>
+    <windowsSettings>
+      <activeCodePage xmlns="http://schemas.microsoft.com/SMI/2019/WindowsSettings">UTF-8</activeCodePage>
+    </windowsSettings>
+  </application>
+</assembly>

tools/mslb-extract/mslb-extract.cpp

@@ -3,6 +3,11 @@ find_package(Boost CONFIG COMPONENTS program_options)
 file(GLOB_RECURSE sources *.cpp *.h)
 add_executable(mslc ${sources})
 
+if (WIN32)
+	configure_file(mslc.manifest.in ${CMAKE_CURRENT_BINARY_DIR}/mslc.manifest @ONLY)
+	target_sources(mslc PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/mslc.manifest)
+endif()
+
 target_link_libraries(mslc PRIVATE MSL::Compile Boost::program_options)
 target_compile_definitions(mslc PRIVATE BOOST_ALL_NO_LIB
 	MSL_MAJOR_VERSION=${MSL_MAJOR_VERSION} MSL_MINOR_VERSION=${MSL_MINOR_VERSION}