Add initial static library support (Windows Only) (#1446)

* Add initial static library support

* Revert change to msquic.lttng target

Also adds a missing newline at init.c's EOF

* Add whole static lib archiving support

* Add static build configuration to windows platforms in build.ps1 and
exclude system libs

* Invert build.ps1 switch and add documentation

* Resolve static link issues with repeated definition of QuicTraceRundown

* Add win32 static configurations to the azure pipeline build job lists

* Correctly ignore MSVC runtime libraries and fix documentation

* Passively create the static lib directly if it doesn't exist

In the event that a different output directory is specified, cmake's
generator will generally create the directory if it doesn't exist.
For the static monolith however, we emit the file with link.exe
directly, and this will fail if the parent directory doesn't exist.

* Try fix CI

* Add STATIC target annotation on perflib and testlib

* Reject libs without a valid ARCHIVE_OUTPUT_DIRECTORY path and inject CI
cached binaries

* Try to fix tests

* Force static build of gtest and support statically linked tools

* Remove kernel static build mods and handle MsQuicUnload in atexit
handlers

* Enforce a different means to enforce static builds for gtest artifacts

* Fix interop static

* One more?

* Change static linkage load/unload invocations to lazy lockfree approach

* Re-add exclusion list which was needed for the release build

* Introduce empty.c file and make msquic_static library a physical target

* Add missing InterlockedAnd to advertise the unloading sequence is
complete

* Inline MsQuicOpen to prevent duplicate symbol issues on Windows

* Temp workaround - Just use macro

* One more fix

Co-authored-by: Nick Banks <[email protected]>

Author: jeremyong

.azure/azure-pipelines.ci.yml

@@ -99,6 +99,24 @@ stages:
       tls: openssl
       config: Release
       extraBuildArgs: -EnableTelemetryAsserts
+  - template: ./templates/build-config-user.yml
+    parameters:
+      image: windows-latest
+      platform: windows
+      arch: x64
+      tls: schannel
+      config: Release
+      extraName: 'static'
+      extraBuildArgs: -EnableTelemetryAsserts -Static -ExtraArtifactDir Static
+  - template: ./templates/build-config-user.yml
+    parameters:
+      image: windows-latest
+      platform: windows
+      arch: x64
+      tls: openssl
+      config: Release
+      extraName: 'static'
+      extraBuildArgs: -EnableTelemetryAsserts -Static -ExtraArtifactDir Static
 
 - stage: build_windows_debug
   displayName: Build Windows - Debug
@@ -129,6 +147,24 @@ stages:
       tls: openssl
       config: Debug
       extraBuildArgs: -EnableTelemetryAsserts
+  - template: ./templates/build-config-user.yml
+    parameters:
+      image: windows-latest
+      platform: windows
+      arch: x64
+      tls: schannel
+      config: Debug
+      extraName: 'static'
+      extraBuildArgs: -EnableTelemetryAsserts -Static -ExtraArtifactDir Static
+  - template: ./templates/build-config-user.yml
+    parameters:
+      image: windows-latest
+      platform: windows
+      arch: x64
+      tls: openssl
+      config: Debug
+      extraName: 'static'
+      extraBuildArgs: -EnableTelemetryAsserts -Static -ExtraArtifactDir Static
 
 - stage: build_windows_nontest
   displayName: Build Windows - Non Tested

CMakeLists.txt

@@ -113,6 +113,7 @@ endif()
 option(QUIC_BUILD_TOOLS "Builds the tools code" ON)
 option(QUIC_BUILD_TEST "Builds the test code" ON)
 option(QUIC_BUILD_PERF "Builds the perf code" ON)
+option(QUIC_BUILD_SHARED "Builds msquic as a dynamic library" ON)
 option(QUIC_ENABLE_LOGGING "Enables logging" OFF)
 option(QUIC_ENABLE_SANITIZERS "Enables sanitizers" OFF)
 option(QUIC_STATIC_LINK_CRT "Statically links the C runtime" ON)
@@ -127,6 +128,9 @@ option(QUIC_TLS_SECRETS_SUPPORT "Enable export of TLS secrets" OFF)
 option(QUIC_TELEMETRY_ASSERTS "Enable telemetry asserts in release builds" OFF)
 option(QUIC_USE_SYSTEM_LIBCRYPTO "Use system libcrypto if openssl TLS" OFF)
 option(QUIC_DISABLE_POSIX_GSO "Disable GSO for systems that say they support it but don't" OFF)
+option(QUIC_FOLDER_PREFIX "Optional prefix for source group folders when using an IDE generator" "")
+
+set(BUILD_SHARED_LIBS ${QUIC_BUILD_SHARED})
 
 # FindLTTngUST does not exist before CMake 3.6, so disable logging for older cmake versions
 if (${CMAKE_VERSION} VERSION_LESS "3.6.0")
@@ -252,14 +256,14 @@ if(WIN32)
     add_custom_target(MsQuicEtw_HeaderBuild
         DEPENDS ${QUIC_BUILD_DIR}/inc/MsQuicEtw.h)
 
-    set_property(TARGET MsQuicEtw_HeaderBuild PROPERTY FOLDER "helpers")
+    set_property(TARGET MsQuicEtw_HeaderBuild PROPERTY FOLDER "${QUIC_FOLDER_PREFIX}helpers")
 
     add_library(MsQuicEtw_Header INTERFACE)
     target_include_directories(MsQuicEtw_Header INTERFACE ${QUIC_BUILD_DIR}/inc)
     add_dependencies(MsQuicEtw_Header MsQuicEtw_HeaderBuild)
 
     add_library(MsQuicEtw_Resource OBJECT ${QUIC_BUILD_DIR}/inc/MsQuicEtw.rc)
-    set_property(TARGET MsQuicEtw_Resource PROPERTY FOLDER "helpers")
+    set_property(TARGET MsQuicEtw_Resource PROPERTY FOLDER "${QUIC_FOLDER_PREFIX}helpers")
 
     message(STATUS "Disabling (client) shared port support")
     list(APPEND QUIC_COMMON_DEFINES QUIC_DISABLE_SHARED_PORT_TESTS)
@@ -403,7 +407,7 @@ if(QUIC_TLS STREQUAL "openssl")
         set(LIBCRYPTO_PATH ${OPENSSL_DIR}/release/lib/libcrypto${CMAKE_STATIC_LIBRARY_SUFFIX})
 
         add_library(OpenSSL_Crypto STATIC IMPORTED)
-        set_property(TARGET OpenSSL_Crypto PROPERTY FOLDER "libraries")
+        set_property(TARGET OpenSSL_Crypto PROPERTY FOLDER "${QUIC_FOLDER_PREFIX}libraries")
         set_target_properties(OpenSSL_Crypto PROPERTIES
             IMPORTED_LOCATION_DEBUG ${LIBCRYPTO_DEBUG_PATH}
             IMPORTED_LOCATION_RELEASE ${LIBCRYPTO_PATH}
@@ -412,7 +416,7 @@ if(QUIC_TLS STREQUAL "openssl")
             MAP_IMPORTED_CONFIG_RELWITHDEBINFO RELEASE)
 
         add_library(OpenSSL_SSL STATIC IMPORTED)
-        set_property(TARGET OpenSSL_SSL PROPERTY FOLDER "libraries")
+        set_property(TARGET OpenSSL_SSL PROPERTY FOLDER "${QUIC_FOLDER_PREFIX}libraries")
         set_target_properties(OpenSSL_SSL PROPERTIES
             IMPORTED_LOCATION_DEBUG ${LIBSSL_DEBUG_PATH}
             IMPORTED_LOCATION_RELEASE ${LIBSSL_PATH}
@@ -548,7 +552,7 @@ if (QUIC_ENABLE_LOGGING)
     function(add_clog_library)
         CLOG_GENERATE_TARGET(${ARGV})
         target_link_libraries(${ARGV0} PRIVATE inc)
-        set_property(TARGET ${ARGV0} PROPERTY FOLDER "helpers")
+        set_property(TARGET ${ARGV0} PROPERTY FOLDER "${QUIC_FOLDER_PREFIX}helpers")
     endfunction()
 else()
     function(add_clog_library)
@@ -621,21 +625,28 @@ endif()
 
 # Test code
 if(QUIC_BUILD_TEST)
-    # Build the googletest framework.
-    set(BUILD_GMOCK OFF CACHE BOOL "Builds the googlemock subproject")
-    set(INSTALL_GTEST OFF CACHE BOOL "Enable installation of googletest. (Projects embedding googletest may want to turn this OFF.)")
-    if(WIN32)
-        option(gtest_force_shared_crt "Use shared (DLL) run-time lib even when Google Test is built as static lib." ON)
-    endif()
+    include(FetchContent)
 
     enable_testing()
-    add_subdirectory(submodules/googletest)
+    
+    # Build the googletest framework.
+
+    # Enforce static builds for test artifacts
+    set(PREV_BUILD_SHARED_LIBS ${BUILD_SHARED_LIBS} CACHE INTERNAL "")
+    set(BUILD_SHARED_LIBS OFF CACHE INTERNAL "")
+    FetchContent_Declare(
+        googletest
+        SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/submodules/googletest
+        CMAKE_ARGS "-DBUILD_GMOCK=OFF -DINSTALL_GTEST=OFF -Dgtest_force_shared_crt=ON"
+    )
+    FetchContent_MakeAvailable(googletest)
+    set(BUILD_SHARED_LIBS ${PREV_BUILD_SHARED_LIBS} CACHE INTERNAL "")
 
     set_property(TARGET gtest PROPERTY CXX_STANDARD 17)
     set_property(TARGET gtest_main PROPERTY CXX_STANDARD 17)
 
-    set_property(TARGET gtest PROPERTY FOLDER "tests")
-    set_property(TARGET gtest_main PROPERTY FOLDER "tests")
+    set_property(TARGET gtest PROPERTY FOLDER "${QUIC_FOLDER_PREFIX}tests")
+    set_property(TARGET gtest_main PROPERTY FOLDER "${QUIC_FOLDER_PREFIX}tests")
 
     add_subdirectory(src/core/unittest)
     add_subdirectory(src/platform/unittest)

docs/BUILD.md

@@ -129,6 +129,9 @@ The script has a lot of additional configuration options, but the default should
 
 `-Arch <x86/x64/arm/arm64>` Allow for building for different architectures. **x64** is the defualt architecture.
 
+`-Static` Compiles msquic as a monolithic statically linkable library.
+Supported only by Windows currently.
+
 `-Tls <schannel/openssl>` Allows for building with different TLS providers. The default is platform dependent (Windows = schannel, Linux = openssl).
 
 `-Clean` Forces a clean build of everything.

scripts/build.ps1

@@ -10,13 +10,16 @@ This script provides helpers for building msquic.
     The CPU architecture to build for.
 
 .PARAMETER Platform
-    Specify which platform to build for
+    Specify which platform to build for.
+
+.PARAMETER Static
+    Specify a static library is preferred (shared is the default).
 
 .PARAMETER Tls
     The TLS library to use.
 
 .PARAMETER ToolchainFile
-    Toolchain file to use (if cross)
+    Toolchain file to use (if cross).
 
 .PARAMETER DisableLogs
     Disables log collection.
@@ -105,6 +108,9 @@ param (
     [ValidateSet("uwp", "windows", "linux", "macos")] # For future expansion
     [string]$Platform = "",
 
+    [Parameter(Mandatory = $false)]
+    [switch]$Static = $false,
+
     [Parameter(Mandatory = $false)]
     [ValidateSet("schannel", "openssl")]
     [string]$Tls = "",
@@ -199,6 +205,11 @@ if (!$IsWindows -And $Platform -eq "uwp") {
     exit
 }
 
+if (!$IsWindows -And $Static) {
+    Write-Error "[$(Get-Date)] Static linkage on non windows platforms not yet supported"
+    exit
+}
+
 # Root directory of the project.
 $RootDir = Split-Path $PSScriptRoot -Parent
 
@@ -270,6 +281,9 @@ function CMake-Generate {
     } else {
         $Arguments += " $Generator"
     }
+    if($Static) {
+        $Arguments += " -DQUIC_BUILD_SHARED=off"
+    }
     $Arguments += " -DQUIC_TLS=" + $Tls
     $Arguments += " -DQUIC_OUTPUT_DIR=" + $ArtifactsDir
     if (!$DisableLogs) {