Merge pull request #34 from ntoskrnl7/codex/add-github-release-assets

[codex] add GitHub release assets

Author: ntoskrnl7

.github/workflows/nuget.yml .github/workflows/package.yml.github/workflows/nuget.yml renamed to .github/workflows/package.yml

@@ -1,10 +1,10 @@
-name: NuGet
+name: Package
 
 on:
   pull_request:
     branches: [ main ]
     paths:
-      - '.github/workflows/nuget.yml'
+      - '.github/workflows/package.yml'
       - 'nuget/**'
       - 'scripts/nuget/**'
       - 'CMakeLists.txt'
@@ -22,7 +22,7 @@ on:
     tags:
       - 'v*'
     paths:
-      - '.github/workflows/nuget.yml'
+      - '.github/workflows/package.yml'
       - 'nuget/**'
       - 'scripts/nuget/**'
       - 'CMakeLists.txt'
@@ -46,6 +46,11 @@ on:
         required: true
         type: boolean
         default: false
+      github_release:
+        description: Upload release assets to GitHub Releases
+        required: true
+        type: boolean
+        default: false
 
 permissions:
   contents: read
@@ -154,12 +159,22 @@ jobs:
         shell: pwsh
         run: ./scripts/nuget/Pack-CrtSysNuGet.ps1 -Version '${{ steps.version.outputs.package_version }}'
 
+      - name: Pack GitHub release assets
+        shell: pwsh
+        run: ./scripts/nuget/Pack-CrtSysReleaseAssets.ps1 -Version '${{ steps.version.outputs.package_version }}'
+
       - uses: actions/upload-artifact@v7
         with:
           name: crtsys-nuget-${{ steps.version.outputs.package_version }}
           path: artifacts/nuget/*.nupkg
           if-no-files-found: error
 
+      - uses: actions/upload-artifact@v7
+        with:
+          name: crtsys-release-assets-${{ steps.version.outputs.package_version }}
+          path: artifacts/release/*
+          if-no-files-found: error
+
   test-package-driver:
     name: Test NuGet driver package ${{ matrix.arch }} ${{ matrix.config }}
     needs: pack
@@ -222,6 +237,34 @@ jobs:
           -Configuration '${{ matrix.config }}'
           -WindowsSdkVersion '10.0.22621.0'
 
+  test-release-native-cmake:
+    name: Test release native CMake asset ${{ matrix.arch }} ${{ matrix.config }}
+    needs: pack
+    runs-on: windows-2022
+    strategy:
+      fail-fast: false
+      matrix:
+        arch: [x64, ARM64]
+        config: [Debug, Release]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/download-artifact@v7
+        with:
+          name: crtsys-release-assets-${{ needs.pack.outputs.package_version }}
+          path: artifacts/release
+
+      - name: Build native release CMake consumer test
+        shell: pwsh
+        run: >
+          ./scripts/nuget/Test-CrtSysReleaseAssets.ps1
+          -ReleaseDirectory artifacts/release
+          -Version '${{ needs.pack.outputs.package_version }}'
+          -Architecture '${{ matrix.arch }}'
+          -Configuration '${{ matrix.config }}'
+          -WindowsSdkVersion '10.0.22621.0'
+
   publish:
     name: Publish NuGet
     needs: [pack, test-package-driver, test-package-app]
@@ -261,3 +304,53 @@ jobs:
         env:
           NUGET_API_KEY: ${{ steps.nuget-login.outputs.NUGET_API_KEY }}
         run: ./scripts/nuget/Push-CrtSysNuGet.ps1 -SkipDuplicate
+
+  github-release:
+    name: Upload GitHub Release Assets
+    needs: [pack, test-package-driver, test-package-app, test-release-native-cmake]
+    if: startsWith(github.ref, 'refs/tags/v') || (github.event_name == 'workflow_dispatch' && inputs.github_release)
+    runs-on: windows-2022
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/download-artifact@v7
+        with:
+          name: crtsys-release-assets-${{ needs.pack.outputs.package_version }}
+          path: artifacts/release
+
+      - name: Create or update GitHub release
+        shell: pwsh
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          $version = '${{ needs.pack.outputs.package_version }}'
+          $tagName = "v$version"
+          if ('${{ github.ref_type }}' -eq 'tag') {
+            $tagName = '${{ github.ref_name }}'
+          }
+
+          $assets = @(Get-ChildItem -Path artifacts\release -File | Sort-Object FullName | ForEach-Object { $_.FullName })
+          if ($assets.Count -eq 0) {
+            throw 'No GitHub Release assets were found.'
+          }
+
+          & gh release view $tagName *> $null
+          if ($LASTEXITCODE -eq 0) {
+            Write-Host "Uploading assets to existing GitHub Release $tagName"
+            & gh release upload $tagName @assets --clobber
+          } else {
+            Write-Host "Creating GitHub Release $tagName"
+            $notes = @(
+              "crtsys $version release assets."
+              ""
+              "- crtsys.$version.nupkg: offline NuGet package"
+              "- crtsys-$version-native.zip: headers, docs, CMake helpers, native MSBuild imports, and prebuilt x64/ARM64 Debug/Release libraries"
+              "- crtsys-$version-SHA256SUMS.txt: SHA-256 checksums"
+            ) -join [Environment]::NewLine
+            & gh release create $tagName @assets --target '${{ github.sha }}' --title "crtsys $version" --notes $notes
+          }
+
+          if ($LASTEXITCODE -ne 0) {
+            throw "GitHub Release upload failed with exit code $LASTEXITCODE."
+          }

README.md

@@ -1,6 +1,6 @@
 # crtsys
 
-**C**/C++ Run**t**ime support for Windows kernel **sys** drivers.
+**C**/C++ **R**un**t**ime support for Windows kernel drivers (`.sys`).
 
 [![CMake](https://github.com/ntoskrnl7/crtsys/actions/workflows/cmake.yml/badge.svg)](https://github.com/ntoskrnl7/crtsys/actions/workflows/cmake.yml)
 ![GitHub](https://img.shields.io/github/license/ntoskrnl7/crtsys)
@@ -185,6 +185,13 @@ Driver mode is enabled automatically when MSBuild sees a driver project
 console application, static library, or CMake project into a WDK driver project,
 and it does not install or replace the WDK toolset.
 
+Driver builds may emit `LNK4088` because `crtsys` intentionally uses
+`/FORCE:MULTIPLE` for known duplicate CRT/runtime symbols between `libcntpr`,
+`Ldk`, `ntoskrnl`, and the runtime glue. Treat that as an expected build
+warning only when the remaining link output contains no unresolved symbols and
+the duplicate symbols are in the known runtime boundary. Final drivers still
+need load, verifier, signing, and target-OS validation.
+
 The current binary package targets:
 
 - Visual Studio 2022
@@ -236,10 +243,29 @@ $env:NUGET_API_KEY = '<nuget-api-key>'
 GitHub Actions builds the prebuilt libraries and package on pull requests and
 pushes. A tag such as `v0.1.12` publishes to nuget.org through NuGet Trusted
 Publishing when the tag version matches `include/.internal/version`.
+The same tag build also creates GitHub Release assets. Manual workflow runs can
+set `github_release=true` to create or update the matching GitHub Release
+without pushing a tag.
+
+Release assets include:
+
+- `crtsys.<version>.nupkg` for offline NuGet installation.
+- `crtsys-<version>-native.zip` with headers, docs, CMake helpers, native
+  MSBuild imports, and prebuilt x64/ARM64 Debug/Release driver libraries.
+- `crtsys-<version>-SHA256SUMS.txt` for asset checksums.
+
+The native zip includes `cmake/CrtSys.cmake`, and the same `crtsys_add_driver`
+API can consume the prebuilt driver libraries when it is included from the
+unpacked bundle. A WDK CMake project can unpack the zip and use:
+
+```cmake
+include(path/to/crtsys-<version>/cmake/CrtSys.cmake)
+crtsys_add_driver(my_driver src/main.cpp)
+```
 
 For GitHub Actions publishing, create a nuget.org Trusted Publishing policy
 with the package owner shown by nuget.org, repository owner `ntoskrnl7`,
-repository `crtsys`, workflow file `nuget.yml`, and no environment
+repository `crtsys`, workflow file `package.yml`, and no environment
 restriction. Set the GitHub Actions repository variable
 `NUGET_TRUSTED_PUBLISHING_USER` to the nuget.org user that created the policy.
 

cmake/CrtSys.cmake

@@ -4,6 +4,28 @@ cmake_policy(SET CMP0021 OLD)
 set(CMAKE_CXX_STANDARD_LIBRARIES " ")
 set(CMAKE_C_STANDARD_LIBRARIES ${CMAKE_CXX_STANDARD_LIBRARIES})
 
+if(NOT DEFINED CRTSYS_NTL_MAIN)
+    set(CRTSYS_NTL_MAIN ON)
+endif()
+
+if(NOT DEFINED CRTSYS_USE_LIBCNTPR)
+    set(CRTSYS_USE_LIBCNTPR ON)
+endif()
+
+if(DEFINED crtsys_SOURCE_DIR)
+    set(_CRTSYS_ROOT "${crtsys_SOURCE_DIR}")
+else()
+    get_filename_component(_CRTSYS_ROOT "${CMAKE_CURRENT_LIST_DIR}/.." ABSOLUTE)
+endif()
+
+if(NOT DEFINED CRTSYS_USE_PREBUILT)
+    if(NOT TARGET crtsys AND EXISTS "${_CRTSYS_ROOT}/lib/native")
+        set(CRTSYS_USE_PREBUILT ON)
+    else()
+        set(CRTSYS_USE_PREBUILT OFF)
+    endif()
+endif()
+
 function(crtsys_scope_compile_options_to_c_cxx TARGET_NAME)
     get_target_property(TARGET_COMPILE_OPTIONS ${TARGET_NAME} COMPILE_OPTIONS)
     if(NOT TARGET_COMPILE_OPTIONS)
@@ -57,23 +79,100 @@ CPMAddPackage("gh:ntoskrnl7/FindWDK#master")
 list(APPEND CMAKE_MODULE_PATH "${FindWDK_SOURCE_DIR}/cmake")
 find_package(WDK REQUIRED)
 
-function(crtsys_add_driver _target)
-    cmake_parse_arguments(WDK "" "WINVER" "" ${ARGN})
-    wdk_add_driver(${_target} ${WDK_UNPARSED_ARGUMENTS} CUSTOM_ENTRY_POINT CrtSysDriverEntry EXTENDED_CPP_FEATURES)
-    crtsys_scope_compile_options_to_c_cxx(${_target})
+function(crtsys_get_prebuilt_arch _out_arch)
+    if("${CMAKE_VS_PLATFORM_NAME}" STREQUAL "x64")
+        set(_arch x64)
+    elseif("${CMAKE_VS_PLATFORM_NAME}" STREQUAL "ARM64")
+        set(_arch ARM64)
+    elseif("${CMAKE_VS_PLATFORM_NAME}" STREQUAL "Win32")
+        message(FATAL_ERROR "The crtsys prebuilt driver bundle does not include x86 driver libraries.")
+    else()
+        message(FATAL_ERROR "Unsupported crtsys prebuilt platform: ${CMAKE_VS_PLATFORM_NAME}")
+    endif()
+
+    set(${_out_arch} "${_arch}" PARENT_SCOPE)
+endfunction()
+
+function(crtsys_get_prebuilt_library _out_path _library _configuration)
+    crtsys_get_prebuilt_arch(_arch)
+
+    if("${_configuration}" STREQUAL "Debug")
+        set(_config_dir Debug)
+    else()
+        set(_config_dir Release)
+    endif()
 
-    target_link_libraries(${_target} crtsys)
+    set(_path "${_CRTSYS_ROOT}/lib/native/${_arch}/${_config_dir}/${_library}")
+    file(TO_CMAKE_PATH "${_path}" _path)
+    if(NOT EXISTS "${_path}")
+        message(FATAL_ERROR "Required crtsys prebuilt library was not found: ${_path}")
+    endif()
 
+    set(${_out_path} "${_path}" PARENT_SCOPE)
+endfunction()
+
+function(crtsys_apply_driver_settings _target _root)
     get_target_property(INC_DIR_TMP ${_target} INCLUDE_DIRECTORIES)
-    set_property(TARGET ${_target} PROPERTY INCLUDE_DIRECTORIES "${crtsys_SOURCE_DIR}/include;${crtsys_SOURCE_DIR}/include/.internal/msvc/$(VCToolsVersion);${crtsys_SOURCE_DIR}/include/.internal/msvc/${MSVC_TOOLSET_VERSION};${crtsys_SOURCE_DIR}/include/.internal/msvc/$(VCToolsVersion)/stl;${crtsys_SOURCE_DIR}/include/.internal/msvc/${MSVC_TOOLSET_VERSION}/stl;$(VC_IncludePath);$(WindowsSDK_IncludePath);${INC_DIR_TMP}")
+    if(NOT INC_DIR_TMP)
+        set(INC_DIR_TMP "")
+    endif()
 
-    if(EXISTS "${crtsys_SOURCE_DIR}/include/.internal/winsdk/${CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION}/wdk/${WDK_VERSION}/forced.h")
-      target_compile_options(${_target} PRIVATE "$<$<COMPILE_LANGUAGE:C,CXX>:/FI${crtsys_SOURCE_DIR}/include/.internal/winsdk/${CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION}/wdk/${WDK_VERSION}/forced.h>")
+    set_property(TARGET ${_target} PROPERTY INCLUDE_DIRECTORIES "${_root}/include;${_root}/include/.internal/msvc/$(VCToolsVersion);${_root}/include/.internal/msvc/${MSVC_TOOLSET_VERSION};${_root}/include/.internal/msvc/$(VCToolsVersion)/stl;${_root}/include/.internal/msvc/${MSVC_TOOLSET_VERSION}/stl;$(VC_IncludePath);$(WindowsSDK_IncludePath);${INC_DIR_TMP}")
+
+    if(EXISTS "${_root}/include/.internal/winsdk/${CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION}/wdk/${WDK_VERSION}/forced.h")
+      target_compile_options(${_target} PRIVATE "$<$<COMPILE_LANGUAGE:C,CXX>:/FI${_root}/include/.internal/winsdk/${CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION}/wdk/${WDK_VERSION}/forced.h>")
     endif()
 
-    target_compile_options(${_target} PRIVATE "$<$<COMPILE_LANGUAGE:C,CXX>:/FI${crtsys_SOURCE_DIR}/include/.internal/adjust_link_order>")
+    target_compile_options(${_target} PRIVATE "$<$<COMPILE_LANGUAGE:C,CXX>:/FI${_root}/include/.internal/adjust_link_order>")
 
     if(CRTSYS_NTL_MAIN)
       target_compile_definitions(${_target} PUBLIC CRTSYS_USE_NTL_MAIN)
     endif()
 endfunction()
+
+function(crtsys_link_prebuilt_driver_libraries _target)
+    crtsys_get_prebuilt_library(_crtsys_debug crtsys.lib Debug)
+    crtsys_get_prebuilt_library(_ldk_debug Ldk.lib Debug)
+    crtsys_get_prebuilt_library(_crtsys_release crtsys.lib Release)
+    crtsys_get_prebuilt_library(_ldk_release Ldk.lib Release)
+
+    target_link_libraries(
+        ${_target}
+        debug "${_crtsys_debug}"
+        debug "${_ldk_debug}"
+        optimized "${_crtsys_release}"
+        optimized "${_ldk_release}"
+    )
+
+    target_compile_definitions(${_target} PUBLIC "_KERNEL32_" "_ITERATOR_DEBUG_LEVEL=0" "_HAS_EXCEPTIONS")
+    target_compile_options(${_target} PUBLIC "$<$<COMPILE_LANGUAGE:CXX>:/Zc:threadSafeInit->")
+    target_compile_options(${_target} PUBLIC "$<$<COMPILE_LANGUAGE:C,CXX>:/MT>")
+
+    if(CRTSYS_USE_LIBCNTPR)
+        if(NOT TARGET WDK::LIBCNTPR)
+            message(FATAL_ERROR "WDK::LIBCNTPR is required for crtsys prebuilt driver support.")
+        endif()
+
+        target_link_libraries(${_target} WDK::LIBCNTPR)
+        target_compile_definitions(${_target} PUBLIC CRTSYS_USE_LIBCNTPR)
+        target_link_options(${_target} PUBLIC "/FORCE:MULTIPLE")
+    endif()
+endfunction()
+
+function(crtsys_add_driver _target)
+    cmake_parse_arguments(WDK "" "WINVER" "" ${ARGN})
+    wdk_add_driver(${_target} ${WDK_UNPARSED_ARGUMENTS} CUSTOM_ENTRY_POINT CrtSysDriverEntry EXTENDED_CPP_FEATURES)
+    crtsys_scope_compile_options_to_c_cxx(${_target})
+
+    crtsys_apply_driver_settings(${_target} "${_CRTSYS_ROOT}")
+
+    if(CRTSYS_USE_PREBUILT)
+        crtsys_link_prebuilt_driver_libraries(${_target})
+    else()
+        if(NOT TARGET crtsys)
+            message(FATAL_ERROR "crtsys target was not found. Add crtsys with CPMAddPackage or use an unpacked crtsys native release bundle.")
+        endif()
+
+        target_link_libraries(${_target} crtsys)
+    endif()
+endfunction()

docs/ko-kr.md

@@ -1,6 +1,6 @@
 # crtsys
 
-Windows 커널 드라이버(`.sys`)를 위한 **C**/C++ Run**t**ime 지원
+Windows 커널 드라이버(`.sys`)를 위한 **C**/C++ **R**un**t**ime 지원
 라이브러리입니다.
 
 [![CMake](https://github.com/ntoskrnl7/crtsys/actions/workflows/cmake.yml/badge.svg)](https://github.com/ntoskrnl7/crtsys/actions/workflows/cmake.yml)
@@ -185,6 +185,13 @@ Driver mode는 MSBuild가 driver 프로젝트를 감지할 때 자동으로 켜
 프로젝트, console application, static library, CMake 프로젝트를 WDK driver
 프로젝트로 변환하지 않으며 WDK toolset을 설치하거나 대체하지 않습니다.
 
+driver build에서는 `LNK4088`이 보일 수 있습니다. `crtsys`는 `libcntpr`,
+`Ldk`, `ntoskrnl`, runtime glue 사이의 알려진 CRT/runtime symbol 중복을
+처리하기 위해 의도적으로 `/FORCE:MULTIPLE`을 사용합니다. 이 경고는 남은
+link output에 unresolved symbol이 없고, 중복 symbol이 알려진 runtime 경계
+안에 있을 때만 예상 가능한 build warning으로 보아야 합니다. 최종 드라이버는
+여전히 load, verifier, signing, 대상 OS 검증이 필요합니다.
+
 현재 binary 패키지 대상은 다음과 같습니다.
 
 - Visual Studio 2022
@@ -237,10 +244,30 @@ GitHub Actions도 pull request와 push에서 prebuilt library와 패키지를
 생성합니다. `v0.1.12` 같은 태그를 push하면, 태그 버전이
 `include/.internal/version`과 일치할 때 NuGet Trusted Publishing을 통해
 nuget.org로 publish합니다.
+같은 태그 빌드는 GitHub Release asset도 생성합니다. 수동 workflow 실행에서
+`github_release=true`를 지정하면 태그를 새로 push하지 않고도 해당 버전의
+GitHub Release를 만들거나 갱신할 수 있습니다.
+
+Release asset에는 다음 파일이 포함됩니다.
+
+- 오프라인 NuGet 설치용 `crtsys.<version>.nupkg`.
+- 헤더, 문서, CMake helper, native MSBuild import, x64/ARM64 Debug/Release
+  driver library가 포함된 `crtsys-<version>-native.zip`.
+- asset 검증용 `crtsys-<version>-SHA256SUMS.txt`.
+
+native zip에는 `cmake/CrtSys.cmake`가 포함되며, 이 파일을 unpack된 bundle에서
+include하면 같은 `crtsys_add_driver` API가 prebuilt driver library를
+사용합니다. WDK CMake 프로젝트에서는 zip을 푼 뒤 다음처럼 사용할 수
+있습니다.
+
+```cmake
+include(path/to/crtsys-<version>/cmake/CrtSys.cmake)
+crtsys_add_driver(my_driver src/main.cpp)
+```
 
 GitHub Actions publish를 사용하려면 nuget.org Trusted Publishing policy를
 nuget.org에 표시되는 package owner, repository owner `ntoskrnl7`,
-repository `crtsys`, workflow file `nuget.yml`, environment 제한 없음으로
+repository `crtsys`, workflow file `package.yml`, environment 제한 없음으로
 생성합니다. GitHub Actions repository variable
 `NUGET_TRUSTED_PUBLISHING_USER`에는 policy를 생성한 nuget.org 사용자를
 설정합니다.