# *******************************************************************************
# Copyright 2024-2025 Arm Limited and affiliates.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# *******************************************************************************

name: "Nightly AArch64"

on:
  #* allow manual trigger of workflow when needed. Useful for a nightly.
  workflow_dispatch:
  schedule:
    #* minute (0-59) hour (0-23) day (1-31) month (1-12)  day of the week (0 - 6)
    #* cron jobs run on the default (main) branch.
    #* set to run at 5am UCT
  - cron: "0 5 * * *"

#* Stop stale workflows, though we should never hit this unless it hangs for a whole day.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

# Declare default permissions as read only.
permissions: write-all

jobs:
  build-acl-cache:
    uses: ./.github/workflows/aarch64-acl.yml

  test-performance:
    uses: ./.github/workflows/performance-aarch64.yml

  build-and-test:
    needs: build-acl-cache
    strategy:
      matrix:
        config: [
          { name: c6g, label: ah-ubuntu_22_04-c6g_8x-100, threading: OMP, toolset: gcc, build: RelWithAssert, testset: NIGHTLY },
          { name: c7g, label: ah-ubuntu_22_04-c7g_8x-100, threading: OMP, toolset: gcc, build: RelWithAssert, testset: NIGHTLY }
        ]

    name: ${{ matrix.config.name }}, ${{ matrix.config.toolset }}, ${{ matrix.config.threading }}, ${{ matrix.config.build }}
    runs-on: ${{ matrix.config.label }}
    steps:

      - name: Checkout oneDNN
        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
        with:
          path: oneDNN
          fetch-tags: true
          fetch-depth: 0

      # Note: This will create a github actions cache
      - name: Get latest CMake and Ninja
        uses: lukka/get-cmake@56d043d188c3612951d8755da8f4b709ec951ad6 # v3.31.6
        with:
          cmakeVersion: 3.31.0
          ninjaVersion: 1.12.0

      - if: ${{ matrix.config.threading == 'OMP' }}
        name: Install openmp
        run: |
          sudo apt install -y libomp-dev

      - name: Read version file
        id: get-versions
        run: |
          content=`cat ${{ github.workspace }}/oneDNN/.github/automation/aarch64/ci.json`
          content="${content//[$'\t\r\n$ ']}"
          echo "output=$content" >> $GITHUB_OUTPUT

      - name: Install gcc
        run: |
          sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
          sudo apt update -y
          sudo apt install -y g++-${{ fromJson(steps.get-versions.outputs.output).dependencies.gcc }}

      - name: setup python
        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
        with:
          python-version: '3.10'

      - name: Clone ACL
        run: ${{ github.workspace }}/oneDNN/.github/automation/aarch64/build_acl.sh
        env:
          ACL_ACTION: clone
          ACL_ROOT_DIR: ${{ github.workspace }}/ComputeLibrary
          ACL_VERSION: ${{ fromJson(steps.get-versions.outputs.output).dependencies.acl }}

      - name: Get ACL commit hash for cache key
        id: get_acl_commit_hash
        run: (cd ${{ github.workspace }}/ComputeLibrary && echo "ACLCommitHash=$(git rev-parse --short HEAD)") >> $GITHUB_OUTPUT

      - name: Get system name
        id: get_system_name
        run: (echo "SystemName=$(uname)") >> $GITHUB_OUTPUT

      - name: Restore cached ACL
        id: cache-acl-restore
        uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
        with:
          key: ${{ steps.get_system_name.outputs.SystemName }}-acl-${{ matrix.config.toolset }}-${{ matrix.config.build }}-${{ steps.get_acl_commit_hash.outputs.ACLCommitHash }}
          path: ${{ github.workspace }}/ComputeLibrary/build

      - name: Configure oneDNN
        run: ${{ github.workspace }}/oneDNN/.github/automation/aarch64/build.sh
        working-directory: ${{ github.workspace }}/oneDNN
        env:
          ACL_ROOT_DIR: ${{ github.workspace }}/ComputeLibrary
          BUILD_TOOLSET: ${{ matrix.config.toolset }}
          CMAKE_BUILD_TYPE: ${{ matrix.config.build }}
          CMAKE_GENERATOR: Ninja
          GCC_VERSION: ${{ fromJson(steps.get-versions.outputs.output).dependencies.gcc }}
          ONEDNN_ACTION: configure
          ONEDNN_TEST_SET: ${{ matrix.config.testset }}
          ONEDNN_THREADING: ${{ matrix.config.threading }}

      - name: Build oneDNN
        run: ${{ github.workspace }}/oneDNN/.github/automation/aarch64/build.sh
        working-directory: ${{ github.workspace }}/oneDNN
        env:
          ONEDNN_ACTION: build

      - name: Run oneDNN tests
        run: |
          set -o pipefail
          ${{ github.workspace }}/oneDNN/.github/automation/aarch64/test.sh ${{ github.workspace }}/test_results.xml ${{ github.workspace }}/test_results.log
        working-directory: ${{ github.workspace }}/oneDNN/build
        env:
          BUILD_TOOLSET: ${{ matrix.config.toolset }}
          CMAKE_BUILD_TYPE: ${{ matrix.config.build }}
          CTEST_PARALLEL_LEVEL: 8
          DYLD_LIBRARY_PATH: ${{ github.workspace }}/ComputeLibrary/build
          ONEDNN_THREADING: ${{ matrix.config.threading }}

      - name: Find last successful run
        if: failure()
        id: get-stable-cache
        uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
        with:
          key: latest-nightly-success-sha
          path: ${{ github.workspace }}/oneDNN/.github/automation/aarch64/stable.sha

      - name: Use backup stable hash
        if: failure() && steps.get-stable-cache.outputs.cache-hit != 'true'
        run: echo ${{ fromJson(steps.get-versions.outputs.output).dependencies.onednn-base }} > ${{ github.workspace }}/oneDNN/.github/automation/aarch64/stable.sha

      - name: Get stable hash
        if: failure()
        id: get-stable
        run: echo "stable-hash=$(cat ${{ github.workspace }}/oneDNN/.github/automation/aarch64/stable.sha)" >> $GITHUB_OUTPUT

      - name: Run git bisect
        if: failure()
        shell: bash
        working-directory: ${{ github.workspace }}/oneDNN
        run: python .github/automation/aarch64/bisect_ctest.py --unique ${{ steps.get-stable.outputs.stable-hash }} ${{ github.workspace }}/test_results.log
        env:
          ACL_ROOT_DIR: ${{ github.workspace }}/ComputeLibrary
      
      - name: Reset to HEAD
        if: failure()
        working-directory: ${{ github.workspace }}/oneDNN
        run: git bisect reset

      - name: Update wiki
        if: ${{ (success() || failure()) && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/ryo-not-rio/wiki') }}
        uses: ./oneDNN/.github/actions/update-wiki
        with:
          command: add-unit
          title: ${{ matrix.config.name }}
          in-file: ${{ github.workspace }}/test_results.xml
  
  save-success-hash:
    runs-on: ubuntu-latest
    needs: build-and-test
    steps:
      - name: Checkout oneDNN
        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
        with:
          path: oneDNN
      
      - name: Create hash file
        working-directory: ${{ github.workspace }}/oneDNN
        run: echo "$(git rev-parse --short HEAD)" > .github/automation/aarch64/stable.sha

      - name: Save hash
        uses: actions/cache/save@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
        with:
          key: latest-nightly-success-sha
          path: ${{ github.workspace }}/oneDNN/.github/automation/aarch64/stable.sha

  #* This job adds a check named "Nightly AArch64" that represents overall
  #* workflow status and can be used in branch rulesets
  status:
    needs: build-and-test
    runs-on: ubuntu-latest
    name: "Nightly AArch64"
    steps:
      - name: Print success
        run: echo Success
