Added support for building Linux binaries on CI. Added Linux binary to ClangSharp.Pathogen.Runtime.

Fixes MochiLibraries#1

Author: PathogenDavid

.github/workflows/ClangSharp.Pathogen.yml

@@ -20,8 +20,24 @@ env:
   DOTNET_GENERATE_ASPNET_CERTIFICATE: false
 jobs:
   build-llvm:
-    name: Build LLVM
-    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: windows-latest
+            name: Windows
+            lib-path: build/bin/libclang.dll
+            build-command: ./build-native.cmd
+            artifact-name: LlvmBuildOutputs-Windows
+          # We use Ubuntu 18.04 so that the binary is usable on systems using glibc 2.27 and later
+          # If we want to support even older versions we should explore building libclang with https://github.com/wheybags/glibc_version_header
+          - os: ubuntu-18.04
+            name: Linux
+            lib-path: build-linux/lib/libclang.so
+            build-command: ./build-native.sh
+            artifact-name: LlvmBuildOutputs-Linux
+    name: Build LLVM - ${{matrix.name}}
+    runs-on: ${{matrix.os}}
     steps:
       # ----------------------------------------------------------------------- Checkout
       - name: Checkout
@@ -47,9 +63,8 @@ jobs:
         with:
           key: llvm-output-${{runner.os}}-${{steps.llvm.outputs.revision}}
           # These are the paths of the external files required in ClangSharp.Pathogen.Runtime.csproj
-          # (Version.props is required by tooling/Versioning.props)
           # (Make sure this is syncronized with "Archive LLVM Outputs" below)
-          path: build/bin/libclang.dll
+          path: ${{matrix.lib-path}}
 
       - name: Checkout LLVM
         if: steps.cached-llvm.outputs.cache-hit != 'true'
@@ -73,21 +88,35 @@ jobs:
         if: steps.cached-llvm.outputs.cache-hit != 'true'
         run: sccache --start-server
 
+      # The GitHub hosted runners do not have Ninja installed by default
+      # We only need to do this on Linux since Visual Studio comes with a copy of Ninja and we end up picking that one up for Windows
+      - name: Install Ninja
+        if: steps.cached-llvm.outputs.cache-hit != 'true' && runner.os == 'Linux'
+        run: sudo apt install --yes ninja-build
+
       - name: Build LLVM
         if: steps.cached-llvm.outputs.cache-hit != 'true'
-        run: ./build-native.cmd
+        run: ${{matrix.build-command}}
 
       - name: Show sccache statistics
         if: steps.cached-llvm.outputs.cache-hit != 'true'
         run: sccache --show-stats
 
+      # The GitHub Actions cache gets confused by the symlink so we need to remove it
+      - name: Unsymlink libclang
+        if: steps.cached-llvm.outputs.cache-hit != 'true' && runner.os == 'Linux'
+        run: |
+          cp ${{matrix.lib-path}} ${{matrix.lib-path}}-nosymlink
+          rm ${{matrix.lib-path}}
+          mv ${{matrix.lib-path}}-nosymlink ${{matrix.lib-path}}
+
       - name: Upload LLVM build artifacts
         uses: actions/upload-artifact@v2
         with:
-          name: LlvmBuildOutputs
+          name: ${{matrix.artifact-name}}
           if-no-files-found: error
-          # This paths listed here must match "Load cached LLVM build outputs" above
-          path: build/bin/libclang.dll
+          # The paths listed here must match "Load cached LLVM build outputs" above
+          path: ${{matrix.lib-path}}
 
   build-dotnet:
     name: Build ClangSharp.Pathogen
@@ -117,11 +146,16 @@ jobs:
           dotnet-version: 5.0.x
 
       # ----------------------------------------------------------------------- Download LLVM Build
-      - name: Download LLVM build artifacts
+      - name: Download LLVM Windows build artifacts
         uses: actions/download-artifact@v2
         with:
-          name: LlvmBuildOutputs
+          name: LlvmBuildOutputs-Windows
           path: build/bin/
+      - name: Download LLVM Linux build artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: LlvmBuildOutputs-Linux
+          path: build-linux/lib/
 
       # ----------------------------------------------------------------------- Configure versioning
       - name: Configure build
@@ -167,6 +201,7 @@ jobs:
         with:
           name: Packages
           path: packages/**
+
   publish-packages:
     name: Publish ClangSharp.Pathogen
     runs-on: ubuntu-latest

ClangSharp.Pathogen.Runtime/ClangSharp.Pathogen.Runtime.csproj

@@ -6,7 +6,8 @@
     <RuntimeIdentifier>win-x64</RuntimeIdentifier>
 
     <!-- Paths to LLVM things -->
-    <LibClangPathogenPath>$(MSBuildThisFileDirectory)../build/bin/libclang.dll</LibClangPathogenPath>
+    <LibClangPathogenPathWindows>$(MSBuildThisFileDirectory)../build/bin/libclang.dll</LibClangPathogenPathWindows>
+    <LibClangPathogenPathLinux>$(MSBuildThisFileDirectory)../build-linux/lib/libclang.so</LibClangPathogenPathLinux>
     <PathogenExtensionsCppPath>$(MSBuildThisFileDirectory)../external/llvm-project/clang/tools/libclang/PathogenExtensions.cpp</PathogenExtensionsCppPath>
     <LicenseFilePath>$(MSBuildThisFileDirectory)../external/llvm-project/clang/LICENSE.TXT</LicenseFilePath>
 
@@ -33,17 +34,36 @@
     <None Condition="Exists('$(PathogenExtensionsCppPath)')" Include="$(PathogenExtensionsCppPath)" Link="PathogenExtensions.cpp" />
     <None Condition="Exists('$(LicenseFilePath)')" Include="$(LicenseFilePath)" Link="LICENSE.txt" Pack="true" PackagePath="LICENSE.txt" />
   </ItemGroup>
-  <ItemGroup Condition="Exists('$(LibClangPathogenPath)')">
-    <None Include="$(LibClangPathogenPath)" Link="libclang-pathogen.dll">
+  <ItemGroup>
+    <None Include="$(LibClangPathogenPathWindows)" Link="libclang-pathogen.dll" Condition="Exists('$(LibClangPathogenPathWindows)')">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       <Pack>true</Pack>
       <PackagePath>runtimes/win-x64/native/libclang-pathogen.dll</PackagePath>
     </None>
+    <None Include="$(LibClangPathogenPathLinux)" Link="libclang-pathogen.so" Condition="Exists('$(LibClangPathogenPathLinux)')">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Pack>true</Pack>
+      <PackagePath>runtimes/linux-x64/native/libclang-pathogen.so</PackagePath>
+    </None>
   </ItemGroup>
   <!-- Error if native runtime needs to be built or llvm-project is missing -->
   <Target Name="_NativeRuntimeChecks" BeforeTargets="Build;Pack">
     <Error Text="PathogenExtensions.cpp is missing, ensure Git submodules are up-to-date." Condition="!Exists('$(PathogenExtensionsCppPath)')" />
     <Error Text="Clang LICENSE.TXT is missing, ensure Git submodules are up-to-date." Condition="!Exists('$(LicenseFilePath)')" />
-    <Error Text="Custom libclang.dll is missing, run `build-native.cmd` in the solution root to build it." Condition="!Exists('$(LibClangPathogenPath)')" />
+
+    <PropertyGroup>
+      <_AllRuntimesPresent>true</_AllRuntimesPresent>
+      <_AnyRuntimePresent>false</_AnyRuntimePresent>
+      <!-- Check Windows runtime -->
+      <_AllRuntimesPresent Condition="!Exists('$(LibClangPathogenPathWindows)')">false</_AllRuntimesPresent>
+      <_AnyRuntimePresent Condition="Exists('$(LibClangPathogenPathWindows)')">true</_AnyRuntimePresent>
+      <!-- Check Linux runtime -->
+      <_AllRuntimesPresent Condition="!Exists('$(LibClangPathogenPathLinux)')">false</_AllRuntimesPresent>
+      <_AnyRuntimePresent Condition="Exists('$(LibClangPathogenPathLinux)')">true</_AnyRuntimePresent>
+    </PropertyGroup>
+    <!-- CI builds must have all runtimes present -->
+    <Error Text="One or more native runtimes are missing, all runtimes are required for CI builds." Condition="'$(ContinuousIntegrationBuild)' == 'true' and '$(_AllRuntimesPresent)' != 'true'" />
+    <!-- For non-CI builds, at least one runtime must be present -->
+    <Error Text="No native runtimes found, at least one native runtime must be built using `build-native.cmd` or `build-native.sh`." Condition="'$(ContinuousIntegrationBuild)' != 'true' and '$(_AnyRuntimePresent)' != 'true'" />
   </Target>
 </Project>

README.md

@@ -6,7 +6,7 @@
 
 This repo contains C# bindings for the [libclang Pathogen Extensions](https://github.com/InfectedLibraries/llvm-project) as well as other utilities used by Biohazrd for interacting with ClangSharp.
 
-Currently this project targets libclang 10.0.0 and ClangSharp 10.0.0-beta. Currently the NuGet package only supports Windows x64, but the native components can be manually built for Linux x64.
+Currently this project targets libclang 10.0.0 and ClangSharp 10.0.0-beta. The NuGet package is currently built for Windows x64 and Linux x64 (glibc >= 2.27).
 
 ## License
 
@@ -39,7 +39,7 @@ If [sccache](https://github.com/mozilla/sccache) (0.2.15 recommended) is present
 
 ## Building - Linux
 
-Ubuntu 20.04 Focal x64 is recommended.
+Ubuntu 20.04 Focal x64 is recommended for development, Ubuntu 18.04 Bionic x64 is used for CI builds.
 
 ### Prerequisites
 
@@ -57,8 +57,8 @@ If [sccache](https://github.com/mozilla/sccache) (0.2.15 recommended, download t
 
 1. Ensure Git submodules are up-to-date with `git submodule update --init --recursive`
 2. Run `build-native.sh` (This will take quite a while the first time.)
-
-You can build and pack the managed components using the .NET SDK (IE: `dotnet build`), however the `ClangSharp.Pathogen.Runtime` project will fail due to the fact that it currently expects the Windows native runtime to be present. (Linux NuGet packages are sitll a work in progress.)
+3. Build the managed components using `dotnet build`
+4. If desired, pack the NuGet packages using `dotnet pack`
 
 ## Development