Add Compute source build support (#214)

Author: Kyle-Ye

.github/workflows/compute.yml

@@ -7,28 +7,34 @@ on:
     branches: [main]
 
 jobs:
-  # TODO: Enable once Compute binary is available for Linux or source integration is supported
-  # compute_ubuntu_build:
-  #   name: Build with Compute on Ubuntu
-  #   strategy:
-  #     fail-fast: false
-  #     matrix:
-  #       swift_version: ["6.1.3"]
-  #   runs-on: ubuntu-22.04
-  #   env:
-  #     OPENATTRIBUTEGRAPH_WERROR: 1
-  #     OPENATTRIBUTEGRAPH_OPENATTRIBUTESHIMS_COMPUTE: 1
-  #     OPENATTRIBUTEGRAPH_COMPATIBILITY_TEST: 0
-  #   container: swift:${{ matrix.swift_version }}-jammy
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #     - name: Checkout Swift headers
-  #       uses: ./.github/actions/checkout-swift-headers
-  #     - name: Build in debug mode
-  #       run: swift build -c debug
+  compute_ubuntu_build:
+    name: Build with Compute (source) on Ubuntu
+    strategy:
+      fail-fast: false
+      matrix:
+        swift_version: ["6.2"]
+    runs-on: ubuntu-22.04
+    env:
+      # -Wno-elaborated-enum-base is not working for Compute dependency. Disable warnings-as-errors for now to unblock CI. We should fix the underlying issue and re-enable warnings-as-errors in the future.
+      # OPENATTRIBUTEGRAPH_WERROR: 1
+      OPENATTRIBUTEGRAPH_WERROR: 0
+      OPENATTRIBUTEGRAPH_OPENATTRIBUTESHIMS_COMPUTE: 1
+      OPENATTRIBUTEGRAPH_OPENATTRIBUTESHIMS_COMPUTE_USE_BINARY: 0
+      OPENATTRIBUTEGRAPH_USE_LOCAL_DEPS: 1
+      OPENATTRIBUTEGRAPH_COMPATIBILITY_TEST: 0
+    container: swift:${{ matrix.swift_version }}-jammy
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Linux build environment
+        run: Scripts/CI/linux_compute_build.sh
+        shell: bash
+      - name: Checkout Swift headers
+        uses: ./.github/actions/checkout-swift-headers
+      - name: Build in debug mode
+        run: swift build -c debug -Xcc -Wno-elaborated-enum-base
 
   compute_macos_build:
-    name: Build with Compute on macOS
+    name: Build with Compute (binary) on macOS
     strategy:
       fail-fast: false
       matrix:
@@ -38,6 +44,7 @@ jobs:
     env:
       OPENATTRIBUTEGRAPH_WERROR: 1
       OPENATTRIBUTEGRAPH_OPENATTRIBUTESHIMS_COMPUTE: 1
+      OPENATTRIBUTEGRAPH_OPENATTRIBUTESHIMS_COMPUTE_USE_BINARY: 1
       OPENATTRIBUTEGRAPH_COMPATIBILITY_TEST: 0
     steps:
       - uses: actions/checkout@v4
@@ -51,7 +58,7 @@ jobs:
         run: swift build -c debug
 
   compute_ios_build:
-    name: Build with Compute on iOS
+    name: Build with Compute (binary) on iOS
     strategy:
       fail-fast: false
       matrix:
@@ -65,6 +72,7 @@ jobs:
     env:
       OPENATTRIBUTEGRAPH_WERROR: 1
       OPENATTRIBUTEGRAPH_OPENATTRIBUTESHIMS_COMPUTE: 1
+      OPENATTRIBUTEGRAPH_OPENATTRIBUTESHIMS_COMPUTE_USE_BINARY: 1
       OPENATTRIBUTEGRAPH_COMPATIBILITY_TEST: 0
     steps:
       - uses: actions/checkout@v4

Package.resolved

@@ -230,13 +230,17 @@ extension Target {
         self.swiftSettings = swiftSettings
     }
 
-    func addComputeBinarySettings() {
+    func addComputeSettings() {
         dependencies.append(
             "Compute",
         )
         var swiftSettings = swiftSettings ?? []
         swiftSettings.append(.define("OPENATTRIBUTEGRAPH_COMPUTE"))
         self.swiftSettings = swiftSettings
+
+        var linkerSettings = linkerSettings ?? []
+        linkerSettings.append(.linkedLibrary("swiftDemangle", .when(platforms: .darwinPlatforms)))
+        self.linkerSettings = linkerSettings
     }
 }
 
@@ -272,16 +276,20 @@ let swiftClonePlugin = Target.plugin(
 // MARK: - Targets
 
 let platformTarget = Target.target(
-    name: "Platform",
+    // Avoid target collision with Compute package
+    name: "OpenAttributeGraphPlatform",
+    path: "Sources/Platform",
     cSettings: sharedCSettings + [
         .define("_GNU_SOURCE", .when(platforms: [.linux])),
     ]
 )
 let utilitiesTarget = Target.target(
-    name: "Utilities",
+    // Avoid target collision with Compute package
+    name: "OpenAttributeGraphUtilities",
     dependencies: [
         .target(name: platformTarget.name),
     ],
+    path: "Sources/Utilities",
     cxxSettings: sharedCxxSettings
 )
 // FIXME: Merge into one target
@@ -365,7 +373,7 @@ let package = Package(
     name: "OpenAttributeGraph",
     products: [
         .library(name: "OpenAttributeGraph", type: .dynamic, targets: [openAttributeGraphTarget.name, openAttributeGraphCxxTarget.name]),
-        .library(name: "OpenAttributeGraphShims", type: .dynamic, targets: [openAttributeGraphTarget.name, openAttributeGraphCxxTarget.name, openAttributeGraphShimsTarget.name]),
+        .library(name: "OpenAttributeGraphShims", type: .dynamic, targets: [openAttributeGraphShimsTarget.name]),
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-numerics", from: "1.0.2"),
@@ -421,22 +429,30 @@ if buildForDarwinPlatform {
 }
 
 if computeCondition {
-    let computeBinary = envBoolValue("OPENATTRIBUTESHIMS_COMPUTE_BINARY", default: true)
+    let computeBinary = envBoolValue("OPENATTRIBUTESHIMS_COMPUTE_USE_BINARY", default: false)
     if computeBinary {
-        let computeVersion = envStringValue("OPENATTRIBUTESHIMS_COMPUTE_BINARY_VERSION", default: "0.0.1")
-        let computeURL = envStringValue("OPENATTRIBUTESHIMS_COMPUTE_BINARY_URL", default: "https://github.com/Kyle-Ye/Compute/releases/download/\(computeVersion)/Compute.xcframework.zip")
-        let computeChecksum = envStringValue("OPENATTRIBUTESHIMS_COMPUTE_BINARY_CHECKSUM", default: "95a256da2055d7c73184aeb9be088ba7019f7ea79b8a31e2dd930526c5ccbe8f")
+        let computeVersion = envStringValue("OPENATTRIBUTESHIMS_COMPUTE_USE_BINARY_VERSION", default: "0.0.1")
+        // TODO: Use upstream link when avaiable. Tracked on https://github.com/jcmosc/Compute/issues/20
+        let computeURL = envStringValue("OPENATTRIBUTESHIMS_COMPUTE_USE_BINARY_URL", default: "https://github.com/Kyle-Ye/Compute/releases/download/\(computeVersion)/Compute.xcframework.zip")
+        let computeChecksum = envStringValue("OPENATTRIBUTESHIMS_COMPUTE_USE_BINARY_CHECKSUM", default: "95a256da2055d7c73184aeb9be088ba7019f7ea79b8a31e2dd930526c5ccbe8f")
         package.targets.append(
             .binaryTarget(
                 name: "Compute",
                 url: computeURL,
                 checksum: computeChecksum
-            ),
+            )
         )
-        openAttributeGraphShimsTarget.addComputeBinarySettings()
     } else {
-        // TODO
+        let computeRepo: Package.Dependency
+        if useLocalDeps {
+            computeRepo = Package.Dependency.package(path: "../Compute")
+        } else {
+            // TODO: No release tag or branch yet.
+            computeRepo = Package.Dependency.package(url: "https://github.com/jcmosc/Compute", revision: "34c5af92008a2db18e8b598fb426e3e2872e752c")
+        }
+        package.dependencies.append(computeRepo)
     }
+    openAttributeGraphShimsTarget.addComputeSettings()
     package.platforms = [.iOS(.v18), .macOS(.v15), .macCatalyst(.v18), .tvOS(.v18), .watchOS(.v10), .visionOS(.v2)]
 } else if attributeGraphCondition {
     setupDPFDependency()

Package.swift

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+# A `realpath` alternative using the default C implementation.
+filepath() {
+  [[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
+}
+
+REPO_ROOT="$(dirname $(dirname $(dirname $(filepath $0))))"
+cd $REPO_ROOT
+
+clone_checkout_compute() {
+  cd $REPO_ROOT
+  revision=$(Scripts/CI/get_revision.sh compute)
+  cd ..
+  if [ ! -d Compute ]; then
+    git clone https://github.com/jcmosc/Compute.git
+    cd Compute
+  else
+    echo "Compute already exists, skipping clone."
+    cd Compute
+    git fetch --all --quiet
+    git stash --quiet || true
+    git reset --hard --quiet origin/main
+  fi
+  git checkout --quiet $revision
+  git submodule update --init --recursive
+}
+
+clone_checkout_compute

Scripts/CI/compute_setup.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# A `realpath` alternative using the default C implementation.
+filepath() {
+  [[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
+}
+
+REPO_ROOT="$(dirname $(dirname $(dirname $(filepath $0))))"
+cd $REPO_ROOT
+
+# Fix SSH submodule checkout failure for git@github.com:jcmosc/swift-runtime-headers.git
+git config --global url."https://github.com/".insteadOf "git@github.com:"
+
+# Install Linux dependencies
+apt-get update
+apt-get install -y libssl-dev
+
+Scripts/CI/compute_setup.sh