Add building/testing with msbuild and the clang compiler

The LLVM/clang compiler warning and error message are easier too read than their MSVC cl counterparts. Also compiling/running tests on Windows with a different compiler has the benefit of a better coverage. This includes a few minor changes to allow clang-cl to compile the project. Change-Id: I43d84034f3e920a45731c4aab4f851a60921290d Signed-off-by: Arne Schwabe <[email protected]>
schwabe · Sep 17, 2024 · 2fa0eb1 · 2fa0eb1
1 parent b236261
commit 2fa0eb1
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 14 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -272,7 +272,7 @@ jobs:
       strategy:
         fail-fast: false
         matrix:
-          arch: [amd64, x86, arm64]
+          arch: [amd64, x86, arm64, amd64-clang, x86-clang]
 
       name: "msbuild - ${{ matrix.arch }} - openssl"
       env:

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -622,7 +622,8 @@ if (BUILD_TESTING)
         check_linker_flag(C -Wl,--wrap=parse_line LD_SUPPORTS_WRAP)
     endif()
 
-    if (${LD_SUPPORTS_WRAP})
+    # Clang-cl (which is also MSVC) is wrongly detected to support wrap
+    if (NOT MSVC AND "${LD_SUPPORTS_WRAP}")
         list(APPEND unit_tests
             "test_argv"
             "test_tls_crypt"

diff --git a/CMakePresets.json b/CMakePresets.json
@@ -121,6 +121,10 @@
                 "CMAKE_BUILD_TYPE": "Release"
             }
         },
+        {
+            "name": "clangtoolset",
+            "toolset": "ClangCL"
+        },
         {
             "name": "mingw-x64",
             "inherits": [ "base", "base-mingw", "x64-mingw" ]
@@ -133,6 +137,10 @@
             "name": "win-amd64-release",
             "inherits": [ "base", "base-windows", "x64", "release" ]
         },
+        {
+            "name": "win-amd64-clang-release",
+            "inherits": [ "base", "base-windows", "clangtoolset", "x64", "release" ]
+        },
         {
             "name": "win-arm64-release",
             "inherits": [ "base", "base-windows", "arm64", "release" ]
@@ -141,10 +149,18 @@
             "name": "win-x86-release",
             "inherits": [ "base", "base-windows", "x86", "release" ]
         },
+        {
+            "name": "win-x86-clang-release",
+            "inherits": [ "base", "base-windows", "clangtoolset", "x86", "release" ]
+        },
         {
             "name": "win-amd64-debug",
             "inherits": [ "base", "base-windows", "x64", "debug" ]
         },
+        {
+            "name": "win-amd64-clang-debug",
+            "inherits": [ "base", "base-windows", "clangtoolset", "x64", "debug" ]
+        },
         {
             "name": "win-arm64-debug",
             "inherits": [ "base", "base-windows", "arm64", "debug" ]
@@ -153,6 +169,10 @@
             "name": "win-x86-debug",
             "inherits": [ "base", "base-windows", "x86", "debug" ]
         },
+        {
+            "name": "win-x86-clang-debug",
+            "inherits": [ "base", "base-windows", "clangtoolset", "x86", "debug" ]
+        },
         {
             "name": "unix-native",
             "generator": "Ninja Multi-Config",
@@ -173,6 +193,11 @@
             "configurePreset": "win-amd64-release",
             "configuration": "Release"
         },
+        {
+            "name": "win-amd64-clang-release",
+            "configurePreset": "win-amd64-clang-release",
+            "configuration": "Release"
+        },
         {
             "name": "win-arm64-release",
             "configurePreset": "win-arm64-release",
@@ -183,11 +208,21 @@
             "configurePreset": "win-x86-release",
             "configuration": "Release"
         },
+        {
+            "name": "win-x86-clang-release",
+            "configurePreset": "win-x86-clang-release",
+            "configuration": "Release"
+        },
         {
             "name": "win-amd64-debug",
             "configurePreset": "win-amd64-debug",
             "configuration": "Debug"
         },
+        {
+            "name": "win-amd64-clang-debug",
+            "configurePreset": "win-amd64-clang-debug",
+            "configuration": "Debug"
+        },
         {
             "name": "win-arm64-debug",
             "configurePreset": "win-arm64-debug",
@@ -198,6 +233,11 @@
             "configurePreset": "win-x86-debug",
             "configuration": "Debug"
         },
+        {
+            "name": "win-x86-clang-debug",
+            "configurePreset": "win-x86-clang-debug",
+            "configuration": "Debug"
+        },
         {
             "name": "unix-native",
             "configurePreset": "unix-native"
@@ -208,18 +248,34 @@
             "name": "win-amd64-release",
             "configurePreset": "win-amd64-release"
         },
+        {
+            "name": "win-amd64-clang-release",
+            "configurePreset": "win-amd64-clang-release"
+        },
         {
             "name": "win-x86-release",
             "configurePreset": "win-x86-release"
         },
+        {
+            "name": "win-x86-clang-release",
+            "configurePreset": "win-x86-clang-release"
+        },
         {
             "name": "win-amd64-debug",
             "configurePreset": "win-amd64-debug"
         },
+        {
+            "name": "win-amd64-clang-debug",
+            "configurePreset": "win-amd64-clang-debug"
+        },
         {
             "name": "win-x86-debug",
             "configurePreset": "win-x86-debug"
         },
+        {
+            "name": "win-x86-clang-debug",
+            "configurePreset": "win-x86-clang-debug"
+        },
         {
             "name": "unix-native",
             "configurePreset": "unix-native"

diff --git a/config.h.cmake.in b/config.h.cmake.in
@@ -442,8 +442,10 @@ don't. */
 # define _GNU_SOURCE 1
 #endif
 
-
-#if defined(_WIN32)
+/* if inttypes.h is included this breaks rc.exe when using the ClangCL
+ * Toolchain as it pulls in a inttypes.h variant for clang that rc.exe does
+ * not understand (#include_next preprocessor directive) */
+#if defined(_WIN32) && !defined(RC_INVOKED)
 #include <inttypes.h>
 typedef uint32_t in_addr_t;
 typedef uint16_t in_port_t;
@@ -455,7 +457,7 @@ typedef uint16_t in_port_t;
 #define SIGTERM   15
 #endif
 
-#if defined(_MSC_VER)
+#if defined(_MSC_VER) && !defined(RC_INVOKED)
 #include <BaseTsd.h>
 typedef SSIZE_T ssize_t;
 #define strncasecmp strnicmp

diff --git a/src/openvpnmsica/openvpnmsica.c b/src/openvpnmsica/openvpnmsica.c
@@ -300,7 +300,7 @@ find_adapters(
 UINT __stdcall
 FindSystemInfo(_In_ MSIHANDLE hInstall)
 {
-#ifdef _MSC_VER
+#if defined(_MSC_VER) && !defined(__clang__)
 #pragma comment(linker, DLLEXP_EXPORT)
 #endif
 
@@ -337,7 +337,7 @@ FindSystemInfo(_In_ MSIHANDLE hInstall)
 UINT __stdcall
 CloseOpenVPNGUI(_In_ MSIHANDLE hInstall)
 {
-#ifdef _MSC_VER
+#if defined(_MSC_VER) && !defined(__clang__)
 #pragma comment(linker, DLLEXP_EXPORT)
 #endif
     UNREFERENCED_PARAMETER(hInstall); /* This CA is does not interact with MSI session (report errors, access properties, tables, etc.). */
@@ -360,7 +360,7 @@ CloseOpenVPNGUI(_In_ MSIHANDLE hInstall)
 UINT __stdcall
 StartOpenVPNGUI(_In_ MSIHANDLE hInstall)
 {
-#ifdef _MSC_VER
+#if defined(_MSC_VER) && !defined(__clang__)
 #pragma comment(linker, DLLEXP_EXPORT)
 #endif
 
@@ -633,7 +633,7 @@ schedule_adapter_delete(
 UINT __stdcall
 EvaluateTUNTAPAdapters(_In_ MSIHANDLE hInstall)
 {
-#ifdef _MSC_VER
+#if defined(_MSC_VER) && !defined(__clang__)
 #pragma comment(linker, DLLEXP_EXPORT)
 #endif
 
@@ -786,7 +786,7 @@ EvaluateTUNTAPAdapters(_In_ MSIHANDLE hInstall)
                 {
                     goto cleanup_szDisplayName;
                 }
-#ifdef __GNUC__
+#if defined(__GNUC__) || defined(__clang__)
 /*
  * warning: enumeration value ‘MSICONDITION_TRUE’ not handled in switch
  * warning: enumeration value ‘MSICONDITION_NONE’ not handled in switch
@@ -806,7 +806,7 @@ EvaluateTUNTAPAdapters(_In_ MSIHANDLE hInstall)
                         free(szValue);
                         goto cleanup_szDisplayName;
                 }
-#ifdef __GNUC__
+#if defined(__GNUC__) || defined(__clang__)
 #pragma GCC diagnostic pop
 #endif
                 free(szValue);
@@ -962,7 +962,7 @@ CreateRebootFile(_In_z_ LPCWSTR szTmpDir)
 UINT __stdcall
 ProcessDeferredAction(_In_ MSIHANDLE hInstall)
 {
-#ifdef _MSC_VER
+#if defined(_MSC_VER) && !defined(__clang__)
 #pragma comment(linker, DLLEXP_EXPORT)
 #endif
 
@@ -1162,7 +1162,7 @@ ProcessDeferredAction(_In_ MSIHANDLE hInstall)
 UINT __stdcall
 CheckAndScheduleReboot(_In_ MSIHANDLE hInstall)
 {
-#ifdef _MSC_VER
+#if defined(_MSC_VER) && !defined(__clang__)
 #pragma comment(linker, DLLEXP_EXPORT)
 #endif
 

diff --git a/src/openvpnmsica/openvpnmsica.h b/src/openvpnmsica/openvpnmsica.h
@@ -66,7 +66,9 @@ extern DWORD openvpnmsica_thread_data_idx;
 extern "C" {
 #endif
 
-#ifdef __GNUC__
+/* Ensure that clang-cl, which does not understand the #pragma comment(linker, ...)
+ * is handled the same way as mingw */
+#if defined(__GNUC__) || defined(__clang__)
 #define DLLEXP_DECL __declspec(dllexport)
 #else
 #define DLLEXP_DECL