For future reference: static linking across different platforms

[Nielsbishere]

The following PR is meant more as a showcase of hacky solutions to get static linking to work across different platforms.
I'm not expecting this to get merged of course, it's just to demonstrate my findings and hopefully something can be improved internally to fix these issues in a better way down the road.
It demonstrates the following issues, that when solved can make static linking possible:

• DLL hooks should be made into DxcInitialize and DxcShutdown which the user needs to manually call if static linking is applied.
• DXC_API_IMPORT becomes a NO-OP in static linking.
• LLVMHLSL, LLVMipo and LLVMScalarOpts have some weird circular dependency that makes linking impossible on non MSVC it seems like. In this branch, I merged them all in one, which is a terrible solution, but it works. Ideally, the circular dependency should be resolved instead. clangAnalysis and clangAST have the same problem, so I also merged those.
• DXC CLI tools expect dynamic linking, so I turned them off (I only needed dxcompiler.lib/.a, etc.).

As an additional note, I hope the wchars can be phased out slowly too, as on linux/OSX these unexpectedly (for me at least) these are UTF32 rather than UTF16. UTF8 would be nice.

[github-actions]

⚠️ C/C++ code formatter, clang-format found issues in your code. ⚠️

You can test this locally with the following command:

git-clang-format --diff 6c2b9f340e19e44743ba821a750f85e4ce44bb1b b37088d419abeddfa682b696ddf84c6653287a1a -- include/dxc/Support/D3DReflection.h include/dxc/Support/Unicode.h include/dxc/Test/D3DReflectionDumper.h include/dxc/Test/D3DReflectionStrings.h include/dxc/WinAdapter.h include/dxc/dxcapi.h lib/DxcSupport/Unicode.cpp lib/DxcSupport/dxcapi.use.cpp lib/DxilContainer/D3DReflectionDumper.cpp lib/DxilContainer/D3DReflectionStrings.cpp lib/HLSL/DxilContainerReflection.cpp projects/dxilconv/tools/dxbc2dxil/dxbc2dxil.cpp tools/clang/include/clang/AST/Attr.h tools/clang/tools/dxa/dxa.cpp tools/clang/tools/dxcompiler/DXCompiler.cpp tools/clang/tools/dxcompiler/dxcapi.cpp tools/clang/tools/dxcvalidator/dxcvalidator.cpp tools/clang/tools/dxr/dxr.cpp tools/clang/unittests/HLSLExec/ExecutionTest.cpp tools/clang/unittests/HLSLTestLib/FileCheckerTest.cpp tools/dxexp/dxexp.cpp

View the diff from clang-format here.

diff --git a/include/dxc/dxcapi.h b/include/dxc/dxcapi.h
index 97e883b23..edc89e6c9 100644
--- a/include/dxc/dxcapi.h
+++ b/include/dxc/dxcapi.h
@@ -47,14 +47,16 @@ struct IDxcIncludeHandler;
 
 /// \brief Typedef for DxcCreateInstance function pointer.
 ///
-/// This can be used with GetProcAddress to get the DxcCreateInstance function (if it's not statically linked).
+/// This can be used with GetProcAddress to get the DxcCreateInstance function
+/// (if it's not statically linked).
 typedef HRESULT(__stdcall *DxcCreateInstanceProc)(_In_ REFCLSID rclsid,
                                                   _In_ REFIID riid,
                                                   _Out_ LPVOID *ppv);
 
 /// \brief Typedef for DxcCreateInstance2 function pointer.
 ///
-/// This can be used with GetProcAddress to get the DxcCreateInstance2 function (if it's not statically linked).
+/// This can be used with GetProcAddress to get the DxcCreateInstance2 function
+/// (if it's not statically linked).
 typedef HRESULT(__stdcall *DxcCreateInstance2Proc)(_In_ IMalloc *pMalloc,
                                                    _In_ REFCLSID rclsid,
                                                    _In_ REFIID riid,
@@ -90,12 +92,14 @@ extern "C" DXC_API_IMPORT
 
 #ifdef ENABLE_DXC_STATIC_LINKING
 
-/// \brief This function has to be called before any DXC calls to initialize it if it's statically linked.
+/// \brief This function has to be called before any DXC calls to initialize it
+/// if it's statically linked.
 ///
 /// If dynamically linked, this will automatically be called.
 extern "C" HRESULT __stdcall DxcInitialize();
 
-/// \brief This function has to be called after all DXC calls (shutdown) to free everything it if it's statically linked.
+/// \brief This function has to be called after all DXC calls (shutdown) to free
+/// everything it if it's statically linked.
 ///
 /// If dynamically linked, this will automatically be called.
 extern "C" void __stdcall DxcShutdown(BOOL isProcessTermination);
diff --git a/lib/HLSL/DxilContainerReflection.cpp b/lib/HLSL/DxilContainerReflection.cpp
index 2ec42b4b3..d0ae5a063 100644
--- a/lib/HLSL/DxilContainerReflection.cpp
+++ b/lib/HLSL/DxilContainerReflection.cpp
@@ -2876,7 +2876,7 @@ public:
   // Use D3D_RETURN_PARAMETER_INDEX to get description of the return value.
   STDMETHOD_(ID3D12FunctionParameterReflection *, GetFunctionParameter)
   (INT ParameterIndex) { return &g_InvalidFunctionParameter; }
-  
+
   STDMETHOD_(UINT64, GetRequiresFlags)() { return m_FeatureFlags; }
 };
 
diff --git a/tools/clang/tools/dxcompiler/DXCompiler.cpp b/tools/clang/tools/dxcompiler/DXCompiler.cpp
index 21ecf584a..e12ab0e69 100644
--- a/tools/clang/tools/dxcompiler/DXCompiler.cpp
+++ b/tools/clang/tools/dxcompiler/DXCompiler.cpp
@@ -102,7 +102,7 @@ HRESULT __stdcall DxcInitialize() {
 void __stdcall DxcShutdown(BOOL isProcessTermination) {
 
 #if defined(LLVM_ON_UNIX)
-  (void) isProcessTermination;
+  (void)isProcessTermination;
   DxcSetThreadMallocToDefault();
   ::hlsl::options::cleanupHlslOptTable();
   ::llvm::sys::fs::CleanupPerThreadFileSystem();
@@ -115,7 +115,8 @@ void __stdcall DxcShutdown(BOOL isProcessTermination) {
   ::hlsl::options::cleanupHlslOptTable();
   ::llvm::sys::fs::CleanupPerThreadFileSystem();
   ::llvm::llvm_shutdown();
-  if (!isProcessTermination) { // FreeLibrary has been called or the DLL load failed
+  if (!isProcessTermination) { // FreeLibrary has been called or the DLL load
+                               // failed
     DxilLibCleanup(DxilLibCleanUpType::UnloadLibrary);
   } else { // Process termination. We should not call FreeLibrary()
     DxilLibCleanup(DxilLibCleanUpType::ProcessTermination);
@@ -130,7 +131,7 @@ void __stdcall DxcShutdown(BOOL isProcessTermination) {
 #ifndef ENABLE_DXC_STATIC_LINKING
 #if defined(LLVM_ON_UNIX)
 HRESULT __attribute__((constructor)) DllMain() { return DxcInitialize(); }
-void __attribute__((destructor)) DllShutdown(){ DxcShutdown();}
+void __attribute__((destructor)) DllShutdown() { DxcShutdown(); }
 #else  // LLVM_ON_UNIX
 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD Reason, LPVOID reserved) {
   BOOL result = TRUE;

• Check this box to apply formatting changes to this branch.

[Nielsbishere]

Closing as main on my fork is now merging all sorts of things.