Added SPIRV-Tools to perform optimizations.

This provides much more advanced optimizations than the remap step.
Optimization now has two levels: dead-code elimination only or full
optimizations.

Added update-submodules.sh script to handle submodules. This ensures that
the SPIRV-Headers submodule for SPIRV-Tools is properly set up.

Installs for static libraries should now include the proper
find_dependency() calls for both boost and SPIRV-Tools.

Updated CI build steps to build all relevant configurations, including
debug, release, static, shared, and 32-bit and 64-bit for Windows.

Author: akb825

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "SPIRV-Cross"]
 	path = Compile/SPIRV-Cross
 	url = https://github.com/KhronosGroup/SPIRV-Cross
+[submodule "Compile/SPIRV-Tools"]
+	path = Compile/SPIRV-Tools
+	url = https://github.com/akb825/SPIRV-Tools.git

CMakeLists.txt

@@ -18,7 +18,7 @@ set(MSL_EXPORTS_DIR ${CMAKE_BINARY_DIR}/cmake CACHE PATH
 	"Folder for placing the cmake exports while building. Useful when embedding in other projects.")
 set(MSL_ROOT_FOLDER MSL CACHE STRING
 	"Root folder for the MSL projects. Usefull when embedding in other projects.")
-set(MSL_INSTALL TRUE CACHE BOOL "Allow installation for MSL components.")
+set(MSL_INSTALL ON CACHE BOOL "Allow installation for MSL components.")
 
 if (MSL_BUILD_TESTS)
 	find_package(GTest QUIET)

Compile/CMakeLists.txt

@@ -37,6 +37,14 @@ file(GLOB spirvCrossSources ${SPIRV_CROSS_DIR}/spirv_*.cpp ${SPIRV_CROSS_DIR}/sp
 set(externalSources
 	${glslangSources} ${glslangOsSources} ${glslResourceSources} ${spirvCrossSources})
 
+# SPIRV-Tools has too complex of a build configuration to just embed the source in this library,
+# but the CMakeLists.txt is set up to properly manage library exports. Only need to install the
+# libraries if a static build, though.
+set(SPIRV_SKIP_EXECUTABLES ON CACHE BOOL "")
+set(SPIRV_SKIP_TESTS ON CACHE BOOL "")
+set(SKIP_SPIRV_TOOLS_INSTALL ${MSL_SHARED} CACHE BOOL "")
+add_subdirectory(SPIRV-Tools)
+
 # Don't care about warnings for external files.
 if (MSVC)
 	set_source_files_properties(${externalSources} PROPERTIES COMPILE_FLAGS /w)
@@ -55,15 +63,22 @@ target_include_directories(msl_compile
 			${SHARED_DIR}
 			src)
 target_link_libraries(msl_compile
-	PRIVATE ${Boost_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+	PRIVATE SPIRV-Tools-opt ${Boost_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
 
 msl_set_folder(msl_compile libs)
 msl_setup_filters(SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src
 	INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/include/MSL/Compile
 	FILES ${sources})
 msl_setup_filters(SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR} FILES ${externalSources})
 
-msl_install_library(TARGET msl_compile MODULE Compile)
+if (NOT MSL_SHARED)
+    # Only need to include the external dependencies for static library build so it can be linked.
+	set(externalDepends EXTERNAL_DEPENDS SPIRV-Tools-opt BOOST_DEPENDS system thread filesystem
+		wave)
+else()
+	set(externalDepends)
+endif()
+msl_install_library(TARGET msl_compile MODULE Compile ${externalDepends})
 set(MSL_DOC_PROJECTS ${MSL_DOC_PROJECTS} Compile PARENT_SCOPE)
 
 add_subdirectory(test)

Compile/SPIRV-Tools

@@ -117,6 +117,16 @@ class MSL_COMPILE_EXPORT Target
 	static const unsigned int featureCount =
 		static_cast<unsigned int>(Feature::EarlyFragmentTests) + 1;
 
+	/**
+	 * @brief Enum for the optimization passes to run.
+	 */
+	enum class Optimize
+	{
+		None,    ///< Don't perform any optimizations.
+		Minimal, ///< Minimal optimizations such as dead-code removal.
+		Full     ///< Full optimization passes.
+	};
+
 	/**
 	 * @brief Information about a feature.
 	 *
@@ -308,24 +318,16 @@ class MSL_COMPILE_EXPORT Target
 	void setRemapVariables(bool remap);
 
 	/**
-	 * @brief Retruns whether or not to optimize the output.
-	 *
-	 * This will do some simple optimizations on the SPIR-V code. This can also be used for targets
-	 * when passing through other tools.
-	 *
-	 * @return True to optimize.
+	 * @brief Retruns the optimization mode.
+	 * @return The optimization mode.
 	 */
-	bool getOptimize() const;
+	Optimize getOptimize() const;
 
 	/**
-	 * @brief Sets whether or not to optimize the output.
-	 *
-	 * This will do some simple optimizations on the SPIR-V code. This can also be used for targets
-	 * when passing through other tools.
-	 *
-	 * @param optimize True to optimize.
+	 * @brief Sets the optimization mode.
+	 * @param optimize The optimization mode.
 	 */
-	void setOptimize(bool optimize);
+	void setOptimize(Optimize optimize);
 
 	/**
 	 * @brief Returns whether or not to strip the debug symbols from SPIR-V.
@@ -491,10 +493,10 @@ class MSL_COMPILE_EXPORT Target
 	std::string m_spirVToolCommand;
 
 	bool m_remapVariables;
-	bool m_optimize;
 	bool m_stripDebug;
 	bool m_dummyBindings;
 	bool m_adjustableBindings;
+	Optimize m_optimize;
 	std::string m_resourcesFile;
 };
 

Compile/include/MSL/Compile/Target.h

@@ -22,6 +22,8 @@
 #include <atomic>
 #include <cstring>
 
+#include <spirv-tools/optimizer.hpp>
+
 #if MSL_GCC || MSL_CLANG
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wconversion"
@@ -338,13 +340,20 @@ void Compiler::process(SpirV& spirv, int processOptions)
 		options |= spv::spirvbin_t::MAP_ALL;
 	if (processOptions & DeadCodeElimination)
 		options |= spv::spirvbin_t::DCE_ALL;
-	if (processOptions & Optimize)
-		options |= spv::spirvbin_t::OPT_ALL;
 	if (processOptions & StripDebug)
 		options |= spv::spirvbin_t::STRIP;
 
 	spv::spirvbin_t remapper;
 	remapper.remap(spirv, options);
+
+	if (processOptions & Optimize)
+	{
+		spvtools::Optimizer optimizer(SPV_ENV_VULKAN_1_0);
+		optimizer.RegisterPerformancePasses();
+		SpirV optimizedSpirV;
+		if (optimizer.Run(spirv.data(), spirv.size()*sizeof(std::uint32_t), &optimizedSpirV))
+			spirv = std::move(optimizedSpirV);
+	}
 }
 
 } // namespace msl

Compile/src/Compiler.cpp

@@ -440,10 +440,10 @@ const Target::FeatureInfo& Target::getFeatureInfo(Target::Feature feature)
 
 Target::Target()
 	: m_remapVariables(false)
-	, m_optimize(false)
 	, m_stripDebug(false)
 	, m_dummyBindings(false)
 	, m_adjustableBindings(false)
+	, m_optimize(Optimize::None)
 {
 	Compiler::initialize();
 	m_featureStates.fill(State::Default);
@@ -550,12 +550,12 @@ void Target::setRemapVariables(bool remap)
 	m_remapVariables = remap;
 }
 
-bool Target::getOptimize() const
+Target::Optimize Target::getOptimize() const
 {
 	return m_optimize;
 }
 
-void Target::setOptimize(bool optimize)
+void Target::setOptimize(Optimize optimize)
 {
 	m_optimize = optimize;
 }
@@ -724,12 +724,16 @@ bool Target::compileImpl(CompiledResult& result, Output& output, Parser& parser,
 	int processOptions = 0;
 	if (m_remapVariables)
 		processOptions |= Compiler::RemapVariables;
-	if (m_optimize)
+	switch (m_optimize)
 	{
-		// NOTE: Optimization may end up renaming interface variables.
-		if (!needsReflectionNames())
-			processOptions |= Compiler::Optimize;
-		processOptions |= Compiler::DeadCodeElimination;
+		case Optimize::None:
+			break;
+		case Optimize::Minimal:
+			processOptions |= Compiler::DeadCodeElimination;
+			break;
+		case Optimize::Full:
+			processOptions |= Compiler::DeadCodeElimination | Compiler::Optimize;
+			break;
 	}
 
 	SpirVProcessor::Strip strip;

Compile/src/Target.cpp

@@ -43,6 +43,7 @@ The following software is required to build MSL:
 * [boost](http://www.boost.org/) (required unless only building client library without tests)
 * [glslang](https://github.com/KhronosGroup/glslang) (required for compiler, provided as submodule)
 * [SPIRV-Cross](https://github.com/KhronosGroup/SPIRV-Cross) (required for compiler, provided as submodule)
+* [SPIRV-Tools](https://github.com/KhronosGroup/SPIRV-Tools) (required for compiler, provided as submodule)
 * [FlatBuffers](https://google.github.io/flatbuffers/) (required if changing the schema)
 * [doxygen](http://www.stack.nl/~dimitri/doxygen/) (optional)
 * [gtest](https://github.com/google/googletest) (optional)
@@ -51,10 +52,7 @@ The following software is required to build MSL:
 
 > **Note:** When Boost is manually installed, the appropriate variables should be set. In the case of Windows, the `BOOST_LIBRARYDIR` and `BOOST_ROOT` variables should be set. (examples: `BOOST_LIBRARYDIR=C:\local\boost_1_64_0\lib64-msvc-14.1` and `BOOST_ROOT=C:\local\boost_1_64_0`) In Windows, the value of `BOOST_LIBRARYDIR` should also be on `PATH` to ensure the DLLs can be loaded.
 
-The glslang and SPIRV-Cross submodules can be grabbed by running the commands
-
-	ModularShaderLanguage$ git submodule init
-	ModularShaderLanguage$ git submodule update
+The glslang, SPIRV-Cross, and SPIRV-Tools submodules can be grabbed by running script `update-submodules.sh`.
 
 Additionally, additional tools such as Microsoft's HLSL compiler and Apple's Metal compiler will be required when compiling shaders for certain platforms.