Merge pull request #1965 from tyrielv/tyrielv/static-native-linking

Statically link libgit2 into NativeAOT executables via vcpkg

Author: tyrielv

.github/workflows/build.yaml

@@ -290,6 +290,13 @@ jobs:
       if: steps.skip.outputs.result != 'true'
       uses: microsoft/setup-msbuild@v3.0.0
 
+    - name: Install vcpkg native dependencies
+      if: steps.skip.outputs.result != 'true'
+      shell: cmd
+      run: |
+        "%VCPKG_INSTALLATION_ROOT%\vcpkg.exe" install --triplet x64-windows-static-aot --x-install-root=out\vcpkg_installed\static --x-manifest-root=src || exit /b 1
+        "%VCPKG_INSTALLATION_ROOT%\vcpkg.exe" install --triplet x64-windows-dynamic --x-install-root=out\vcpkg_installed\dynamic --x-manifest-root=src || exit /b 1
+
     - name: Build VFS for Git
       if: steps.skip.outputs.result != 'true'
       shell: cmd

.gitignore

@@ -228,4 +228,5 @@ ModelManifest.xml
 .vscode/
 
 # ProjFS Kext Unit Test coverage results
-ProjFS.Mac/CoverageResult.txt
+ProjFS.Mac/CoverageResult.txt
+

Directory.Build.props

@@ -33,6 +33,74 @@
     <BaseIntermediateOutputPath>$(ProjectOutPath)obj\</BaseIntermediateOutputPath>
   </PropertyGroup>
 
+  <!--
+    Static native linking: embed libgit2 directly into AOT-compiled executables.
+
+    vcpkg builds a static git2.lib (via the x64-windows-static-aot triplet) which
+    the NativeAOT linker links into the final executable. This eliminates the
+    "DLL missing" crash vector for libgit2.
+
+    How it works:
+      1. vcpkg install produces git2.lib + transitive deps (pcre, zlib, etc.)
+      2. <NativeLibrary> items tell the NativeAOT linker where to find the .lib files
+      3. <DirectPInvoke> tells the linker to resolve P/Invoke calls at link time
+      4. libgit2_filename is overridden from "git2-XXXXXXX" (NuGet) to "git2" (vcpkg)
+
+    A side benefit of this approach: we can apply patches to libgit2 that haven't
+    been included in an official release yet, via the overlay port in overlays/.
+
+    To rebuild vcpkg libs after overlay changes:
+      vcpkg install [triplet x64-windows-static-aot] [overlay-triplets=triplets] [overlay-ports=overlays]
+
+    See THIRD-PARTY-NOTICES.md for license details on these native libraries.
+  -->
+  <PropertyGroup Condition="'$(PublishAot)' == 'true'">
+    <VcpkgInstalledDir>$(RepoOutPath)vcpkg_installed\static\x64-windows-static-aot\</VcpkgInstalledDir>
+  </PropertyGroup>
+
+  <!-- Set libgit2 library name unconditionally — all builds use vcpkg-sourced libgit2 -->
+  <PropertyGroup Condition="'$(MSBuildProjectExtension)' == '.csproj'">
+    <libgit2_filename>git2</libgit2_filename>
+  </PropertyGroup>
+
+  <ItemGroup Condition="'$(PublishAot)' == 'true'">
+    <DirectPInvoke Include="git2" />
+
+    <!-- libgit2 static library and its transitive dependencies -->
+    <NativeLibrary Include="$(VcpkgInstalledDir)lib\git2.lib" />
+    <NativeLibrary Include="$(VcpkgInstalledDir)lib\pcre.lib" />
+    <NativeLibrary Include="$(VcpkgInstalledDir)lib\http_parser.lib" />
+    <NativeLibrary Include="$(VcpkgInstalledDir)lib\zs.lib" />
+
+    <!-- Windows system libraries required by libgit2 (WinHTTP TLS backend) -->
+    <NativeLibrary Include="winhttp.lib" />
+    <NativeLibrary Include="crypt32.lib" />
+    <NativeLibrary Include="rpcrt4.lib" />
+    <NativeLibrary Include="secur32.lib" />
+  </ItemGroup>
+
+  <!--
+    Non-AOT projects (tests) need git2.dll for runtime P/Invoke.
+    Copy from the vcpkg dynamic build output.
+  -->
+  <ItemGroup Condition="'$(PublishAot)' != 'true' and '$(MSBuildProjectExtension)' == '.csproj' and '$(IncludeBuildOutput)' != 'false'">
+    <Content Include="$(RepoOutPath)vcpkg_installed\dynamic\x64-windows-dynamic\bin\git2.dll">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
+      <Link>git2.dll</Link>
+    </Content>
+    <Content Include="$(RepoOutPath)vcpkg_installed\dynamic\x64-windows-dynamic\bin\pcre.dll">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
+      <Link>pcre.dll</Link>
+    </Content>
+    <Content Include="$(RepoOutPath)vcpkg_installed\dynamic\x64-windows-dynamic\bin\z.dll">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
+      <Link>z.dll</Link>
+    </Content>
+  </ItemGroup>
+
   <!-- Native project properties -->
   <PropertyGroup Condition="'$(MSBuildProjectExtension)' == '.vcxproj'">
     <Platform>x64</Platform>

Directory.Build.targets

@@ -12,6 +12,75 @@
   <!-- Include custom MSBuild targets/tasks -->
   <Import Project="$(MSBuildThisFileDirectory)GVFS\GVFS.MSBuild\GVFS.targets" />
 
+  <!--
+    Auto-restore vcpkg native dependencies when missing.
+    Modeled after vcpkg's official VcpkgInstallManifestDependencies target
+    (scripts/buildsystems/msbuild/vcpkg.targets), adapted for .csproj projects
+    and dual-triplet installs (static-aot + dynamic).
+
+    Key differences from official vcpkg.targets:
+      - Hooks PrepareForBuild instead of ClCompile (which doesn't exist in csproj)
+      - Installs two triplets (static for AOT linking, dynamic for runtime P/Invoke)
+      - Outputs to out/vcpkg_installed/ instead of src/vcpkg_installed/
+      - Discovers vcpkg via VCPKG_INSTALLATION_ROOT, VS-bundled path, or PATH
+
+    Stamp file pattern: the target uses Inputs/Outputs so MSBuild skips it entirely
+    when the manifests haven't changed and the stamp file is up-to-date.
+    Build.bat also runs vcpkg install upfront, making this a no-op for CLI builds.
+  -->
+  <PropertyGroup Condition="'$(MSBuildProjectExtension)' == '.csproj'">
+    <_VcpkgManifestFile>$(RepoSrcPath)vcpkg.json</_VcpkgManifestFile>
+    <_VcpkgConfigFile>$(RepoSrcPath)vcpkg-configuration.json</_VcpkgConfigFile>
+    <_VcpkgStampFile>$(RepoOutPath)vcpkg_installed\.msbuildstamp</_VcpkgStampFile>
+  </PropertyGroup>
+
+  <ItemGroup Condition="'$(MSBuildProjectExtension)' == '.csproj'">
+    <_VcpkgManifestInputs Include="$(_VcpkgManifestFile)" />
+    <_VcpkgManifestInputs Include="$(_VcpkgConfigFile)" Condition="Exists('$(_VcpkgConfigFile)')" />
+  </ItemGroup>
+
+  <Target Name="_RestoreVcpkgDependencies"
+          BeforeTargets="PrepareForBuild;ComputeFilesToPublish"
+          Condition="'$(MSBuildProjectName)' == 'GVFS.Common'"
+          Inputs="@(_VcpkgManifestInputs)"
+          Outputs="$(_VcpkgStampFile)">
+
+    <!-- Locate vcpkg: VCPKG_INSTALLATION_ROOT > VS-bundled > PATH -->
+    <PropertyGroup>
+      <_VcpkgExe Condition="Exists('$(VCPKG_INSTALLATION_ROOT)\vcpkg.exe')">$(VCPKG_INSTALLATION_ROOT)\vcpkg.exe</_VcpkgExe>
+      <_VcpkgExe Condition="'$(_VcpkgExe)' == '' and Exists('$(VsInstallRoot)\VC\vcpkg\vcpkg.exe')">$(VsInstallRoot)\VC\vcpkg\vcpkg.exe</_VcpkgExe>
+      <_VcpkgManifestArg>--x-manifest-root="$(RepoSrcPath.TrimEnd('\'))"</_VcpkgManifestArg>
+    </PropertyGroup>
+
+    <!-- For dotnet build (no VsInstallRoot): find VS-bundled vcpkg via vswhere -->
+    <Exec Command="&quot;$(MSBuildProgramFiles32)\Microsoft Visual Studio\Installer\vswhere.exe&quot; -latest -products * -property installationPath"
+          ConsoleToMSBuild="true" IgnoreExitCode="true" StandardOutputImportance="low"
+          Condition="'$(_VcpkgExe)' == ''">
+      <Output TaskParameter="ConsoleOutput" PropertyName="_VsInstallPath" />
+    </Exec>
+    <PropertyGroup Condition="'$(_VcpkgExe)' == '' and '$(_VsInstallPath)' != '' and Exists('$(_VsInstallPath)\VC\vcpkg\vcpkg.exe')">
+      <_VcpkgExe>$(_VsInstallPath)\VC\vcpkg\vcpkg.exe</_VcpkgExe>
+    </PropertyGroup>
+
+    <!-- Final fallback: bare vcpkg on PATH -->
+    <PropertyGroup Condition="'$(_VcpkgExe)' == ''">
+      <_VcpkgExe>vcpkg</_VcpkgExe>
+    </PropertyGroup>
+
+    <Message Importance="high" Text="[vcpkg] Installing native dependencies to $(RepoOutPath)vcpkg_installed\" />
+
+    <MakeDir Directories="$(RepoOutPath)vcpkg_installed\" />
+    <Exec Command="&quot;$(_VcpkgExe)&quot; install --x-wait-for-lock --triplet x64-windows-static-aot --x-install-root=&quot;$(RepoOutPath)vcpkg_installed\static&quot; $(_VcpkgManifestArg)"
+          StandardOutputImportance="High" StandardErrorImportance="High" />
+    <Exec Command="&quot;$(_VcpkgExe)&quot; install --x-wait-for-lock --triplet x64-windows-dynamic --x-install-root=&quot;$(RepoOutPath)vcpkg_installed\dynamic&quot; $(_VcpkgManifestArg)"
+          StandardOutputImportance="High" StandardErrorImportance="High" />
+
+    <Error Condition="!Exists('$(RepoOutPath)vcpkg_installed\dynamic\x64-windows-dynamic\bin\git2.dll')"
+           Text="vcpkg install completed but expected output files are missing. Check vcpkg output above for errors." />
+
+    <Touch Files="$(_VcpkgStampFile)" AlwaysCreate="true" />
+  </Target>
+
   <!--
     Copy native C++ hook executables and managed peer executables to GVFS.exe
     output directory. In a production install all binaries are co-located in one

Directory.Packages.props

@@ -13,7 +13,7 @@
     <PackageVersion Include="SharpZipLib" Version="1.3.3" />
 
     <!-- Git -->
-    <PackageVersion Include="LibGit2Sharp.NativeBinaries" Version="2.0.322" />
+    <!-- libgit2 native library is now provided by vcpkg (see overlays/libgit2) -->
 
     <!-- ProjFS -->
     <PackageVersion Include="Microsoft.Windows.ProjFS" Version="2.1.0" />

GVFS/GVFS.Common/GVFS.Common.csproj

@@ -5,7 +5,6 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="LibGit2Sharp.NativeBinaries" />
     <PackageReference Include="Microsoft.Data.Sqlite" />
     <PackageReference Include="SharpZipLib" />
   </ItemGroup>

GVFS/GVFS.Common/Git/LibGit2Repo.cs

@@ -483,7 +483,7 @@ public static string GetLastError()
                 return Marshal.PtrToStructure<GitError>(ptr).Message;
             }
 
-            [DllImport(Git2NativeLibName, EntryPoint = "giterr_last")]
+            [DllImport(Git2NativeLibName, EntryPoint = "git_error_last")]
             private static extern IntPtr GetLastGitError();
 
             [StructLayout(LayoutKind.Sequential)]

GVFS/GVFS.Hooks/GVFS.Hooks.csproj

@@ -5,10 +5,6 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
   </PropertyGroup>
 
-  <ItemGroup>
-    <PackageReference Include="LibGit2Sharp.NativeBinaries" />
-  </ItemGroup>
-
   <ItemGroup>
     <!--
     Files from GVFS.Common included as links here to prevent adding

Readme.md

@@ -89,3 +89,7 @@ See [License.md](License.md).
 
 VFS for Git relies on the PrjFlt filter driver, formerly known as the GvFlt
 filter driver, available as a prerelease NuGet package.
+
+VFS for Git also includes or links to third-party native libraries at build
+time. See [THIRD-PARTY-NOTICES.md](THIRD-PARTY-NOTICES.md) for details on
+these dependencies and their licenses.

THIRD-PARTY-NOTICES.md

@@ -0,0 +1,69 @@
+# Third-Party Notices
+
+VFS for Git incorporates third-party native libraries that are statically
+linked into the final executable when building with NativeAOT. This file
+documents those dependencies and their licenses.
+
+## libgit2
+
+**Source:** https://github.com/libgit2/libgit2
+**Version:** 1.9.3 (via vcpkg overlay port in overlays/libgit2/)
+**License:** GPLv2 with Linking Exception
+
+libgit2 is used for local Git object lookups (commit parsing, tree walking,
+blob size queries, config reading). VFS for Git calls libgit2 via P/Invoke
+and, when building with NativeAOT, statically links the compiled library into
+the executable.
+
+The libgit2 COPYING file (https://github.com/libgit2/libgit2/blob/main/COPYING)
+includes the following linking exception:
+
+> In addition to the permissions in the GNU General Public License,
+> the authors give you unlimited permission to link the compiled
+> version of this library into combinations with other programs,
+> and to distribute those combinations without any restriction
+> coming from the use of this file. (The General Public License
+> restrictions do apply in other respects; for example, they cover
+> modification of the file, and distribution when not linked into
+> a combined executable.)
+
+This exception explicitly permits both dynamic and static linking of the
+compiled libgit2 library into VFS for Git without imposing GPL obligations
+on VFS for Git's own MIT-licensed source code. Modifications to libgit2
+itself remain subject to the GPLv2.
+
+The full GPLv2 license text is available at:
+https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+
+## SQLite
+
+**Source:** https://www.sqlite.org/
+**Version:** Bundled via SQLitePCLRaw.lib.e_sqlite3 NuGet package
+**License:** Public Domain
+
+SQLite is used for persistent storage of placeholder lists and blob size
+caches. The SQLite C library is in the public domain and imposes no
+restrictions on linking or distribution.
+
+> The author disclaims copyright to this source code. In place of a
+> legal notice, here is a blessing:
+>
+> May you do good and not evil.
+> May you find forgiveness for yourself and forgive others.
+> May you share freely, never taking more than you give.
+
+https://www.sqlite.org/copyright.html
+
+## SQLitePCLRaw / Microsoft.Data.Sqlite
+
+**Source:** https://github.com/ericsink/SQLitePCL.raw (SQLitePCLRaw),
+https://github.com/dotnet/efcore (Microsoft.Data.Sqlite)
+**License:** Apache License 2.0
+
+These managed libraries provide the .NET API surface for SQLite access.
+SQLitePCLRaw handles the P/Invoke layer to the native SQLite library, and
+Microsoft.Data.Sqlite provides the ADO.NET provider. Both are licensed under
+the Apache License 2.0, which permits static linking without restriction.
+
+The full Apache License 2.0 text is available at:
+https://www.apache.org/licenses/LICENSE-2.0