Experimental support for ARM64 (#1086)

intuibase · web-flow · commit dea266bb4eac · 2024-08-27T12:21:00.000+02:00
diff --git a/.ci/Makefile b/.ci/Makefile
@@ -1,11 +1,21 @@
 ifeq ($(DOCKERFILE),)
 	ifeq ($(BUILD_ARCHITECTURE), linuxmusl-x86-64)
 		DOCKERFILE := Dockerfile.alpine
+	else ifeq ($(BUILD_ARCHITECTURE), linuxmusl-arm64)
+		DOCKERFILE := Dockerfile.alpine
 	else
 		DOCKERFILE := Dockerfile
 	endif
 endif
 
+DOCKER_PLATFORM := linux/x86_64
+ifeq ($(BUILD_ARCHITECTURE), linux-arm64)
+	DOCKER_PLATFORM := linux/arm64
+else ifeq ($(BUILD_ARCHITECTURE), linuxmusl-arm64)
+	DOCKER_PLATFORM := linux/arm64
+endif
+
+
 SHELL=/bin/bash -o pipefail
 MAKEFLAGS += --no-print-directory
 IMAGE := test-php
@@ -45,6 +55,7 @@ prepare:  ## Build docker image for building and testing the project
 	docker build \
 		--build-arg PHP_VERSION=${PHP_VERSION} --build-arg SEL_DISTRO=${SEL_DISTRO}\
 		--tag $(IMAGE):${PHP_VERSION}$(SUFFIX) \
+		--platform $(DOCKER_PLATFORM) \
 		-f ${DOCKERFILE} .
 	@echo "::endgroup::"
 
@@ -59,8 +70,8 @@ build:
 		-w /source/agent/native \
 		-e CONAN_USER_HOME=$(CONAN_USER_HOME) \
 		elasticobservability/apm-agent-php-dev:native-build-gcc-12.2.0-$(BUILD_ARCHITECTURE)-0.0.2 \
-		sh -c "cmake --preset $(BUILD_ARCHITECTURE)-release \
-				&& cmake --build --preset $(BUILD_ARCHITECTURE)-release -j$(nproc)\
+		sh -c "cmake --preset $(BUILD_ARCHITECTURE)-release  \
+				&& cmake --build --preset $(BUILD_ARCHITECTURE)-release \
 				&& ctest --preset $(BUILD_ARCHITECTURE)-release --verbose"
 	@echo "::endgroup::"
 
diff --git a/.github/workflows/build-arch-matrix-generator.yml b/.github/workflows/build-arch-matrix-generator.yml
@@ -0,0 +1,44 @@
+---
+
+# Runs the build based on the provided files in test.yml
+name: build
+
+on:
+  workflow_call:
+    inputs:
+      build_arch:
+        required: true
+        type: string
+        default: 'x86_64'
+    outputs:
+      matrix-combinations:
+        description: "Matrix of architectures to build for"
+        value: ${{ jobs.setup-build-matrix.outputs.matrix-combinations }}
+
+jobs:
+  setup-build-matrix:
+    name: setup-build-matrix
+    runs-on: ubuntu-latest
+    env:
+      SELECTED_ARCH: ${{ inputs.build_arch }}
+    outputs:
+      matrix-combinations: ${{ steps.setup-matrix-combinations.outputs.matrix-combinations }}
+    steps:
+      - name: Create build matrix
+        id: setup-matrix-combinations
+        run: |
+          MATRIX=''
+          if [ "${SELECTED_ARCH}" == "x86_64" ] ||  [ "${SELECTED_ARCH}" == "all" ]; then
+            echo "${SELECTED_ARCH} selected. Adding x86_64"
+            MATRIX+='{"arch": "linux-x86-64"}, {"arch": "linuxmusl-x86-64"}'
+          fi
+          if [ "${SELECTED_ARCH}" == "arm64" ] ||  [ "${SELECTED_ARCH}" == "all" ]; then
+            echo "${SELECTED_ARCH} selected. Adding arm64"
+            if [ ! -z "${MATRIX}" ]; then
+              MATRIX+=','
+            fi
+            MATRIX+='{"arch": "linux-arm64", "run_qemu": 1},{"arch": "linuxmusl-arm64", "run_qemu": 1}'
+          fi
+          echo "matrix-combinations={\"include\":[$MATRIX]}"
+
+          echo "matrix-combinations={\"include\":[$MATRIX]}" >> $GITHUB_OUTPUT
diff --git a/.github/workflows/build-packages.yml b/.github/workflows/build-packages.yml
@@ -13,24 +13,28 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       packages: read
+    strategy:
+      fail-fast: false
+      matrix:
+        BUILD_ARCH: ["x86-64", "arm64"]
+    env:
+      BUILD_ARCH: ${{ matrix.BUILD_ARCH }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/download-artifact@v3
         with:
-          name: package-parts-linux-x86-64
-          path: agent/native/_build/linux-x86-64-release/
+          name: package-parts-linux-${{ matrix.BUILD_ARCH }}
+          path: agent/native/_build/linux-${{ matrix.BUILD_ARCH }}-release/
       - uses: actions/download-artifact@v3
         with:
-          name: package-parts-linuxmusl-x86-64
-          path: agent/native/_build/linuxmusl-x86-64-release/
-
+          name: package-parts-linuxmusl-${{ matrix.BUILD_ARCH }}
+          path: agent/native/_build/linuxmusl-${{ matrix.BUILD_ARCH }}-release/
       - name: Log in to the Container registry
         uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-
       - name: package
         run: make -C packaging package
       - name: package info
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -4,28 +4,54 @@
 name: build
 
 on:
-  workflow_call: ~
+  workflow_call:
+    inputs:
+      build_arch:
+        required: false
+        type: string
+        default: 'x86_64'
+  workflow_dispatch:
+    inputs:
+      build_arch:
+        type: choice
+        description: Build architecture
+        default: 'x86_64'
+        options:
+          - all
+          - x86_64
+          - arm64
 
 permissions:
   contents: read
 
 jobs:
+  setup-build-matrix:
+    uses: ./.github/workflows/build-arch-matrix-generator.yml
+    with:
+      build_arch: ${{ inputs.build_arch }}
+
   build:
     name: build-agent-library
     runs-on: ubuntu-latest
-    timeout-minutes: 30
+    needs: setup-build-matrix
+    timeout-minutes: 300
     strategy:
       fail-fast: false
-      matrix:
-        arch:
-          - "linux-x86-64"
-          - "linuxmusl-x86-64"
+      matrix: ${{ fromJson(needs.setup-build-matrix.outputs.matrix-combinations) }}
     env:
       BUILD_ARCHITECTURE: ${{ matrix.arch }}
     steps:
       - uses: actions/checkout@v4
+      - if: ${{ matrix.run_qemu }}
+        uses: docker/setup-qemu-action@v3
+        with:
+          platforms: arm64
       - name: Build
-        run: make -f .ci/Makefile build
+        run: |
+          uname -a
+          echo "Detected CPUs: $(nproc)"
+          make -f .ci/Makefile build
+
       - uses: actions/upload-artifact@v3
         with:
           name: package-parts-${{ matrix.arch }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -5,6 +5,7 @@ permissions:
   contents: read
 
 on:
+  workflow_dispatch: ~
   push:
     tags: [ "v[0-9]+*" ]
     branches:
@@ -28,6 +29,8 @@ jobs:
 
   build:
     uses: ./.github/workflows/build.yml
+    with:
+      build_arch: all
 
   build-packages:
     permissions:
diff --git a/.github/workflows/test-packages.yml b/.github/workflows/test-packages.yml
@@ -73,6 +73,11 @@ jobs:
           name: package-parts-linuxmusl-x86-64
           path: agent/native/_build/linuxmusl-x86-64-release
 
+      - name: Remove ARM64 artifacts
+        run: |
+          rm ${BUILD_PACKAGES}/apm-agent-php*arm64*
+          rm ${BUILD_PACKAGES}/apm-agent-php*aarch64*
+
       - if: ${{ env.TESTING_TYPE == 'lifecycle' }}
         name: lifecycle test
         run: |
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,6 +1,12 @@
 name: test
 
 on:
+  workflow_call:
+    inputs:
+      build_arch:
+        required: true
+        type: string
+        default: 'all'
   pull_request:
     paths-ignore:
       - "**/*.asciidoc"
@@ -26,13 +32,21 @@ concurrency:
 jobs:
   build:
     uses: ./.github/workflows/build.yml
+    with:
+      build_arch: all
+
+  setup-build-matrix:
+    uses: ./.github/workflows/build-arch-matrix-generator.yml
+    with:
+      build_arch: all
 
   phpt-tests:
     name: phpt-tests
     runs-on: ubuntu-latest
     needs:
       - build
-    timeout-minutes: 10
+      - setup-build-matrix
+    timeout-minutes: 120
     strategy:
       fail-fast: false
       matrix:
@@ -44,25 +58,27 @@ jobs:
           - "8.1"
           - "8.2"
           - "8.3"
-        arch:
-          - "linux-x86-64"
-          - "linuxmusl-x86-64"
+        data: ${{ fromJson(needs.setup-build-matrix.outputs.matrix-combinations).include }}
     env:
       PHP_VERSION: ${{ matrix.php-version }}
-      BUILD_ARCHITECTURE: ${{ matrix.arch }}
+      BUILD_ARCHITECTURE: ${{ matrix.data.arch }}
     steps:
       - uses: actions/checkout@v4
-      - name: Prepare
-        run: make -f .ci/Makefile prepare
       - uses: actions/download-artifact@v3
         with:
-          name: package-parts-${{ matrix.arch }}
-          path: agent/native/_build/${{ matrix.arch }}-release/
-      - name: Display structure of downloaded files
-        run: ls -R
+          name: package-parts-${{ matrix.data.arch }}
+          path: agent/native/_build/${{ matrix.data.arch }}-release/
+      - if: ${{ matrix.data.run_qemu }}
+        uses: docker/setup-qemu-action@v3
+        with:
+          platforms: arm64
+      - name: Prepare
+        run: make -f .ci/Makefile prepare
       - name: phpt-unit-tests
-        run: make -f .ci/Makefile run-phpt-tests
-
+        run: |
+          tree agent/native/_build/
+          uname -a
+          make -f .ci/Makefile run-phpt-tests
   static-checks-unit-tests:
     name: static-checks-unit-tests
     runs-on: ubuntu-latest
diff --git a/agent/native/ext/constants.h b/agent/native/ext/constants.h
@@ -19,6 +19,7 @@
 
 #pragma once
 
+
 #include "basic_macros.h"
 #include "elastic_apm_assert.h"
 
diff --git a/docs/setup.asciidoc b/docs/setup.asciidoc
@@ -11,12 +11,14 @@ endif::[]
 === Prerequisites
 
 [discrete]
-==== Operating system
-The agent is currently only available for the Linux operating system.
+==== Operating system and architecture
+We officially support Linux systems (glibc, deb and rpm packages) and Alpine Linux (musl libc - apk packages) for x86_64 (AMD64) processors.
+
+NOTE: Experimentally, we also provide packages for the ARM64 architecture - please note that these packages have not been fully tested.
 
 [discrete]
 ==== PHP
-The agent supports PHP versions 7.2-8.2.
+The agent supports PHP versions 7.2-8.3.
 
 [discrete]
 ==== curl
diff --git a/docs/supported-technologies.asciidoc b/docs/supported-technologies.asciidoc
@@ -14,7 +14,8 @@ We will use the results to add support for the most requested technologies.
 [[supported-os]]
 === Operating systems
 
-The agent supports Linux operating system.
+We officially support Linux systems (glibc, deb and rpm packages) and Alpine Linux (musl libc - apk packages) for x86_64 (AMD64) processors.
+Experimentally, we also provide packages for the ARM64 architecture - please note that these packages have not been fully tested.
 
 [float]
 [[supported-php-versions]]
diff --git a/packaging/Makefile b/packaging/Makefile
diff --git a/packaging/create-package.sh b/packaging/create-package.sh
