Add macOS build configuration (#5)

* Stabilize for macOS build
* Extend some bazel configs to macOS from linux-only
* Added CI/CD support for macOS

---------
Co-authored-by: [email protected] <[email protected]>
Co-authored-by: Mihajlo Linić <[email protected]>

Author: 3 people

.bazelrc

@@ -44,13 +44,20 @@ build:linux_x86_64 --host_copt=-march=haswell
 build:linux_aarch64 --copt=-march=armv8-a
 build:linux_aarch64 --host_copt=-march=armv8-a
 
+# Configure for Linux on ARM64 (Apple Silicon)
+# Macosx version in plat name should be aligned with --macos_minimum_os
+# flag in .bazelrc. And requires a change in both places to be made.
+build:macos --macos_minimum_os=12.0
+build:macos_arm64 --copt=-mcpu=apple-m1
+build:macos_arm64 --host_copt=-mcpu=apple-m1
+
 # Only use level three optimizations for target, not necessarily for host
 # since host artifacts don't need to be fast.
 build --copt=-O3
 
 # Suppress C++ compiler warnings.
-build:linux --copt=-w
-build:linux --host_copt=-w
+build --copt=-w
+build --host_copt=-w
 
 #
 # Remote execution capabilities
@@ -118,12 +125,12 @@ build:linux --define=INCLUDEDIR=$(PREFIX)/include
 build:linux --define=PROTOBUF_INCLUDE_PATH=$(PREFIX)/include
 
 # By default, build TF in C++ 17 mode.
-build:linux --cxxopt=-std=c++17
-build:linux --host_cxxopt=-std=c++17
+build --cxxopt=-std=c++17
+build --host_cxxopt=-std=c++17
 
 # Do not risk cache corruption. See:
 # https://github.com/bazelbuild/bazel/issues/3360
-build:linux --experimental_guard_against_concurrent_changes
+build --experimental_guard_against_concurrent_changes
 
 # Configure short or long logs
 build:short_logs --output_filter=DONT_MATCH_ANYTHING

.github/workflows/publish.yaml

@@ -102,8 +102,13 @@ jobs:
         include:
           - os: ubuntu-22.04
             arch: x86_64
+            sys: linux
           - os: ubuntu-22.04-arm
             arch: aarch64
+            sys: linux
+          - os: macos-14
+            arch: arm64
+            sys: macos
     runs-on: ${{ matrix.os }}
     timeout-minutes: 360
     environment: release
@@ -150,14 +155,14 @@ jobs:
             --build_tag_filters="-nokokoro,-nopresubmit,-requires-gpu-nvidia" \
             --google_credentials="${{ steps.auth.outputs.credentials_file_path }}" \
             --remote_cache="https://storage.googleapis.com/${{ vars.BAZEL_CACHE_BUCKET }}/${{ github.job }}" \
-            --config="linux_${{ matrix.arch }}" \
+            --config="${{ matrix.sys }}_${{ matrix.arch }}" \
             -- \
             --output_dir="${{ github.workspace }}/dist/"
 
     - name: Upload Python package
       uses: actions/[email protected]
       with:
-        name: python-package-distributions-${{ matrix.arch }}
+        name: python-package-distributions-${{ matrix.sys }}-${{ matrix.arch }}
         path: dist/*.whl
 
   test-package:
@@ -168,8 +173,13 @@ jobs:
         include:
           - os: ubuntu-22.04
             arch: x86_64
+            sys: linux
           - os: ubuntu-22.04-arm
             arch: aarch64
+            sys: linux
+          - os: macos-14
+            arch: arm64
+            sys: macos
     runs-on: ${{ matrix.os }}
     timeout-minutes: 5
     steps:
@@ -182,7 +192,7 @@ jobs:
     - name: Download Python package
       uses: actions/[email protected]
       with:
-        name: python-package-distributions-${{ matrix.arch }}
+        name: python-package-distributions-${{ matrix.sys }}-${{ matrix.arch }}
         path: dist/
 
     - name: Set up Python
@@ -210,7 +220,7 @@ jobs:
 
   publish-package:
     name: Publish Package
-    needs: [build-package, test-package]
+    needs: [build-package,test-package]
     runs-on: ubuntu-22.04
     timeout-minutes: 5
     permissions:
@@ -231,4 +241,4 @@ jobs:
         password: ${{ secrets.PYTHON_REPOSITORY_TOKEN }}
         repository-url: ${{ vars.PYTHON_REPOSITORY_URL }}
         verbose: 'true'
-        user: ${{ secrets.PYTHON_REPOSITORY_USER }}
+        user: ${{ secrets.PYTHON_REPOSITORY_USER }}

tensorflow_federated/cc/simulation/BUILD

@@ -53,6 +53,10 @@ cc_library(
 
 cc_binary(
     name = "worker_binary",
-    linkopts = ["-lrt"],
+    linkopts = select({
+        "@platforms//os:osx": [],
+        "@platforms//os:linux": ["-lrt"],
+        "//conditions:default": [],
+    }),
     deps = [":worker_main"],
 )

tools/python_package/build_python_package.sh

@@ -14,6 +14,8 @@
 # limitations under the License.
 #
 # Tool to build the TensorFlow Federated Python package.
+
+
 set -e
 
 usage() {
@@ -24,8 +26,10 @@ usage() {
 }
 
 main() {
+
   # Parse the arguments.
   local output_dir="${BUILD_WORKING_DIRECTORY}/dist"
+  
 
   while [[ "$#" -gt 0 ]]; do
     option="$1"
@@ -48,7 +52,8 @@ main() {
     exit 1
   fi
 
-  # Check the GLIBC version.
+if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+      # Check the GLIBC version.
   glibc_version=$(ldd --version 2>&1 | grep "GLIBC" | awk '{print $NF}')
 
   # Error handling if GLIBC version couldn't be determined.
@@ -67,12 +72,25 @@ main() {
   arch=$(uname -m)
   case "$arch" in
     aarch64|x86_64) ;; # Supported architectures
-    *) echo "error: Unsupported architecture: $arch" >&2; exit 1 ;;
+    *) echo "error: Unsupported architecture: linux/$arch"  >&2; exit 1 ;;
   esac
 
   plat_name="manylinux_${manylinux_version}_${arch}"
+elif [[ "$OSTYPE" == "darwin"* ]]; then
 
+ arch=$(uname -m)
+  case "$arch" in
+    arm64) ;; # Supported architectures
+    *) echo "error: Unsupported architecture: darwin/$arch" >&2; exit 1 ;;
+  esac
 
+# TODO: update code above to process macos plat_name as well
+# In .bazelrc it is build with --macos_minimum_os=12.0
+# Macosx version in plat name should be aligned with --macos_minimum_os
+# flag in .bazelrc. And requires a change in both places to be made.
+# wonder if there is a better way
+  plat_name="macosx_12_0_arm64"
+fi
   # Create a temp directory.
   local temp_dir="$(mktemp --directory)"
   trap "rm -rf ${temp_dir}" EXIT
@@ -87,6 +105,10 @@ main() {
   # Build the Python package.
   pip install --upgrade "build" "toml-cli"
 
+  # Trap to avoid editing a linked file
+  previous_plat_name=$(toml get --toml-path "pyproject.toml" "tool.distutils.bdist_wheel.plat-name")
+  trap "toml set --toml-path "pyproject.toml" "tool.distutils.bdist_wheel.plat-name" "$previous_plat_name"" EXIT
+
   # Update wheel platform
   toml set --toml-path "pyproject.toml" "tool.distutils.bdist_wheel.plat-name" "$plat_name"
   pip freeze