ci-x86.yml

# **********************************************************
# Copyright (c) 2020-2025 Google, Inc.  All rights reserved.
# **********************************************************

# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
#   this list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
#
# * Neither the name of Google, Inc. nor the names of its contributors may be
#   used to endorse or promote products derived from this software without
#   specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL VMWARE, INC. OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
# DAMAGE.

# Github Actions workflow for x86 Continuous Integration testing.
#
# Each test suite is a separate job. When adding a new test suite job,
# remember to add it to the send-failure-notification job to ensure failure
# notifications are set up properly.

name: ci-x86
on:
  # Run on pushes to master and on pull request changes, including from a
  # forked repo with no "push" trigger, while avoiding duplicate triggers.
  push:
    branches:
      - master
  pull_request:
    types: [opened, reopened, synchronize]
  merge_group:

  # Manual trigger using the Actions page. May remove when integration complete.
  workflow_dispatch:

defaults:
  run:
    shell: bash
  # We'd like to add common initial steps for all jobs, but that's not supported.
  # Composite Run Steps can help, but we don't have that many common steps -- just
  # checkout and fetch for now.
  # https://docs.github.com/en/free-pro-team@latest/actions/creating-actions/about-actions#composite-run-steps-actions
  # https://github.community/t/reusing-sharing-inheriting-steps-between-jobs-declarations

jobs:
  # 32-bit Linux build with gcc and run tests:
  x86-32:
    runs-on: ubuntu-20.04

    # When checking out the repository that triggered a workflow, actions/checkout
    # defaults to the reference or SHA for that event. See documentation for ref at
    # https://github.com/actions/checkout
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: true

    # Cancel any prior runs for a PR (but do not cancel master branch runs).
    - uses: n1hility/cancel-previous-runs@v2
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
      if: ${{ github.event_name == 'pull_request' }}

    # We also need origin/master for pre-commit source file checks in runsuite.cmake.
    # But fetching multiple branches isn't supported yet: actions/checkout#214
    # Pending PR that adds this support actions/checkout#155
    # TODO i#4549: When necessary support is available, remove/replace the
    # workaround here and from every job in other Github Actions CI workflows.
    - run: git fetch --no-tags --depth=1 origin master

    # Install multilib for non-cross-compiling Linux build.
    # GA CI uses packages.microsoft.com which is missing i386 packages, and
    # attempts at using apt with us.archive-ubuntu.com hit dep issues:
    # so we manually install the i386 packages we need.
    - name: Create Build Environment
      run: |
        sudo apt update
        sudo apt-get -y install doxygen vera++ zlib1g-dev libsnappy-dev \
          liblz4-dev g++-multilib libunwind-dev
        sudo add-apt-repository 'deb [arch=i386] http://us.archive.ubuntu.com/ubuntu focal main'
        apt download libunwind8:i386 libunwind-dev:i386 liblzma5:i386 \
          zlib1g:i386 zlib1g-dev:i386
        mkdir ../extract
        for i in *.deb; do dpkg-deb -x $i ../extract; done
        sudo rsync -av ../extract/usr/lib/i386-linux-gnu/ /usr/lib/i386-linux-gnu/
        sudo rsync -av ../extract/lib/i386-linux-gnu/ /usr/lib/i386-linux-gnu/
        sudo rsync -av ../extract/usr/include/i386-linux-gnu/ /usr/include/
        echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope

    # Use a newer cmake to avoid 32-bit toolchain problems (i#4830).
    - name: Setup newer cmake
      uses: jwlawson/actions-setup-cmake@v2
      with:
        cmake-version: '3.19.7'

    - name: Run Suite
      working-directory: ${{ github.workspace }}
      run: ./suite/runsuite_wrapper.pl automated_ci 32_only
      env:
        DYNAMORIO_CROSS_AARCHXX_LINUX_ONLY: no
        CI_TRIGGER: ${{ github.event_name }}
        CI_BRANCH: ${{ github.ref }}

  # 64-bit Linux build with gcc and run tests.
  x86-64:
    runs-on: ubuntu-20.04
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: true

    # Cancel any prior runs for a PR (but do not cancel master branch runs).
    - uses: n1hility/cancel-previous-runs@v2
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
      if: ${{ github.event_name == 'pull_request' }}

    - run: git fetch --no-tags --depth=1 origin master

    # Install multilib for non-cross-compiling Linux build.
    - name: Create Build Environment
      run: |
        sudo apt update
        sudo apt-get -y install doxygen vera++ zlib1g-dev libsnappy-dev \
          liblz4-dev g++-multilib libunwind-dev
        echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope

    # Use a newer cmake to avoid 32-bit toolchain problems (i#4830).
    - name: Setup newer cmake
      uses: jwlawson/actions-setup-cmake@v2
      with:
        cmake-version: '3.19.7'

    - name: Run Suite
      working-directory: ${{ github.workspace }}
      run: ./suite/runsuite_wrapper.pl automated_ci 64_only
      env:
        DYNAMORIO_CROSS_AARCHXX_LINUX_ONLY: no
        CI_TRIGGER: ${{ github.event_name }}
        CI_BRANCH: ${{ github.ref }}

  # Ubuntu22 64-bit Linux build with gcc and run tests.
  # XXX: A matrix could combine this with the 20.04 but our auto-cancel
  # step cancels the 2nd job so we need to solve that first.
  x86-64-ubuntu22:
    runs-on: ubuntu-22.04
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: true

    # Cancel any prior runs for a PR (but do not cancel master branch runs).
    - uses: n1hility/cancel-previous-runs@v2
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
      if: ${{ github.event_name == 'pull_request' }}

    - run: git fetch --no-tags --depth=1 origin master

    # Install multilib for non-cross-compiling Linux build.
    - name: Create Build Environment
      run: |
        sudo apt update
        sudo apt-get -y install doxygen vera++ zlib1g-dev libsnappy-dev \
          liblz4-dev g++-multilib libunwind-dev
        echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope

    # Use a newer cmake to avoid 32-bit toolchain problems (i#4830).
    - name: Setup newer cmake
      uses: jwlawson/actions-setup-cmake@v2
      with:
        cmake-version: '3.19.7'

    - name: Run Suite
      working-directory: ${{ github.workspace }}
      run: ./suite/runsuite_wrapper.pl automated_ci 64_only
      env:
        DYNAMORIO_CROSS_AARCHXX_LINUX_ONLY: no
        CI_TRIGGER: ${{ github.event_name }}
        CI_BRANCH: ${{ github.ref }}

  # Ubuntu22 64-bit Linux build with gcc and run tests.
  # XXX: A matrix could combine this with the 20.04 but our auto-cancel
  # step cancels the 2nd job so we need to solve that first.
  x86-32-ubuntu22:
    runs-on: ubuntu-22.04
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: true

    # Cancel any prior runs for a PR (but do not cancel master branch runs).
    - uses: n1hility/cancel-previous-runs@v2
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
      if: ${{ github.event_name == 'pull_request' }}

    - run: git fetch --no-tags --depth=1 origin master

    # Install multilib for non-cross-compiling Linux build.
    - name: Create Build Environment
      run: |
        sudo apt update
        sudo apt-get -y install doxygen vera++ zlib1g-dev libsnappy-dev \
          liblz4-dev g++-multilib libunwind-dev
        sudo add-apt-repository 'deb [arch=i386] http://us.archive.ubuntu.com/ubuntu focal main'
        apt download libunwind8:i386 libunwind-dev:i386 liblzma5:i386 \
          zlib1g:i386 zlib1g-dev:i386
        mkdir ../extract
        for i in *.deb; do dpkg-deb -x $i ../extract; done
        sudo rsync -av ../extract/usr/lib/i386-linux-gnu/ /usr/lib/i386-linux-gnu/
        sudo rsync -av ../extract/lib/i386-linux-gnu/ /usr/lib/i386-linux-gnu/
        sudo rsync -av ../extract/usr/include/i386-linux-gnu/ /usr/include/
        echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope

    # Use a newer cmake to avoid 32-bit toolchain problems (i#4830).
    - name: Setup newer cmake
      uses: jwlawson/actions-setup-cmake@v2
      with:
        cmake-version: '3.19.7'

    - name: Run Suite
      working-directory: ${{ github.workspace }}
      run: ./suite/runsuite_wrapper.pl automated_ci 32_only
      env:
        DYNAMORIO_CROSS_AARCHXX_LINUX_ONLY: no
        CI_TRIGGER: ${{ github.event_name }}
        CI_BRANCH: ${{ github.ref }}

  # 64-bit Linux build with gcc and musl.
  # TODO i#1973: Fix failing cases and enable tests in CI.
  x86-64-alpine-3_21:
    runs-on: ubuntu-22.04
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: true
        path: ${{ github.workspace }}/DynamoRIO

    # Cancel any prior runs for a PR (but do not cancel master branch runs).
    - uses: n1hility/cancel-previous-runs@v2
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
      if: ${{ github.event_name == 'pull_request' }}

    - run: git fetch --no-tags --depth=1 origin master
      working-directory: ${{ github.workspace }}/DynamoRIO

    # Create an Alpine Linux 3.21.2 chroot environment for building
    - name: Create Build Environment
      run: |
        sudo mkdir alpine-root
        curl -L https://dl-cdn.alpinelinux.org/v3.21/releases/x86_64/alpine-minirootfs-3.21.3-x86_64.tar.gz |
        sudo tar xzv -C alpine-root

        cd alpine-root
        sudo mount -o bind /dev/ dev
        sudo mount -t proc proc proc
        sudo mount -t sysfs sys sys
        sudo mount -o bind ${{ github.workspace }}/DynamoRIO root

        sudo chroot . sbin/apk upgrade

        # Meta-package build-base simplifies dependencies, but it pulls in
        # fortify-headers. Alpine ships an out-of-date version whose headers
        # contain unnecessary includes, causing naming conflicts.
        # TODO i#1973: simplify dependency with build-base after fixing
        # the compatibility problem.
        # Supply --allow-untrusted since we're creating a rootfs from scratch
        # thus don't have any public key available.
        sudo chroot . sbin/apk add \
          alpine-base binutils bash cmake doxygen file g++ git libunwind-dev \
          lz4-dev lz4-static linux-headers make musl-dev musl-libintl perl \
          patch xz-dev zlib-dev zlib-static

    - name: Run Suite
      working-directory: ${{ github.workspace }}
      run: |
        sudo --preserve-env=CI_TRIGGER,CI_BRANCH,DYNAMORIO_MUSL \
          chroot alpine-root sh -c 'cd &&
                                    ./suite/runsuite_wrapper.pl automated_ci 64_only'
      env:
        DYNAMORIO_MUSL: yes
        CI_TRIGGER: ${{ github.event_name }}
        CI_BRANCH: ${{ github.ref }}

  send-failure-notification:
      uses: ./.github/workflows/failure-notification.yml
      needs: [x86-32, x86-64, x86-64-ubuntu22, x86-32-ubuntu22, x86-64-alpine-3_21]
      # By default, a failure in a job skips the jobs that need it. The
      # following expression ensures that failure-notification.yml is
      # always invoked.
      if: ${{ always() }}
      with:
        test_suite_status: ${{ format('{0} {1} | {2} {3} | {4} {5} | {6} {7} | {8} {9}',
                                      'x86-32', needs.x86-32.result,
                                      'x86-64', needs.x86-64.result,
                                      'x86-64-ubuntu22', needs.x86-64-ubuntu22.result,
                                      'x86-32-ubuntu22', needs.x86-32-ubuntu22.result,
                                      'x86-64-alpine-3_21', needs.x86-64-alpine-3_21.result) }}
        test_suite_results_only: ${{ join(needs.*.result, ',') }}
      secrets: inherit