concrete/.github/workflows/benchmark.yml

# Run benchmarks on an AWS instance and return parsed results to Slab CI bot.
name: Performance benchmarks

on:
  push:
    branches:
      - 'main'
  workflow_dispatch:
    inputs:
      ec2-instance-type:
        description: 'EC2 instance type'
        required: true
        default: 'm6i.metal'
        type: choice
        options:
          - m6i.metal
          - c6a.metal
  # Have a weekly benchmark run on main branch to be available on Monday morning (Paris time)
# TODO: uncomment this section once MLBenchmarks are implemented
#  schedule:
#    # * is a special character in YAML so you have to quote this string
#    # At 1:00 every Thursday
#    # Timezone is UTC, so Paris time is +2 during the summer and +1 during winter
#    - cron: '0 1 * * THU'

env:
  CARGO_TERM_COLOR: always
  RESULTS_FILENAME: parsed_benchmark_results_${{ github.sha }}.json
  EC2_INSTANCE_TYPE: ${{ inputs.ec2-instance-type || 'm6i.metal' }}

jobs:
  start-runner:
    name: Start EC2 runner
    runs-on: ubuntu-20.04
    outputs:
      label: ${{ steps.start-ec2-runner.outputs.label }}
      ec2-instance-id: ${{ steps.start-ec2-runner.outputs.ec2-instance-id }}
    steps:
      - name: Sets env vars for m6i.metal
        if: ${{ env.EC2_INSTANCE_TYPE == 'm6i.metal' }}
        run: |
          echo "AWS_REGION=eu-west-3" >> $GITHUB_ENV
          echo "EC2_IMAGE_ID=ami-0a24aaee029d1295c" >> $GITHUB_ENV
          echo "SUBNET_ID=subnet-a886b4c1" >> $GITHUB_ENV
          echo "SECURITY_GROUP_ID=sg-0bf1c1d79c97bc88f" >> $GITHUB_ENV

      - name: Sets env vars for c6a.metal
        if: ${{ env.EC2_INSTANCE_TYPE == 'c6a.metal' }}
        run: |
          echo "AWS_REGION=us-east-1" >> $GITHUB_ENV
          echo "EC2_IMAGE_ID=ami-0afb83d80b3b060d8" >> $GITHUB_ENV
          echo "SUBNET_ID=subnet-da319dd4" >> $GITHUB_ENV
          echo "SECURITY_GROUP_ID=sg-0f8b52622a2669491" >> $GITHUB_ENV

      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ${{ env.AWS_REGION }}
      - name: Start EC2 runner
        id: start-ec2-runner
        uses: machulav/ec2-github-runner@v2
        with:
          mode: start
          github-token: ${{ secrets.CONCRETE_ACTIONS_TOKEN }}
          ec2-image-id: ${{ env.EC2_IMAGE_ID }}
          ec2-instance-type: ${{ env.EC2_INSTANCE_TYPE }}
          subnet-id: ${{ env.SUBNET_ID }}
          security-group-id: ${{ env.SECURITY_GROUP_ID }}
          aws-resource-tags: >
            [
              {"Key": "Name", "Value": "compiler-benchmarks-github"}
            ]

  run-benchmarks:
    name: Execute end-to-end benchmarks in EC2
    runs-on: ${{ needs.start-runner.outputs.label }}
    if: ${{ !cancelled() }}
    needs: start-runner
    steps:
      # SSH private key is required as some dependencies are from private repos
      - uses: webfactory/ssh-agent@v0.5.2
        with:
          ssh-private-key: ${{ secrets.CONCRETE_COMPILER_CI_SSH_PRIVATE }}

      - name: Fetch submodules
        uses: actions/checkout@v3
        with:
          submodules: recursive
          token: ${{ secrets.GH_TOKEN }}

      - name: Set up home
        # "Install rust" step require root user to have a HOME directory which is not set.
        run: |
          echo "HOME=/home/ubuntu" >> "${GITHUB_ENV}"

      - name: Install rust
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
          override: true

      - name: Concrete-Optimizer
        run: |
          cd compiler
          make concrete-optimizer-lib

      - name: Download KeySetCache
        if: ${{ !contains(github.head_ref, 'newkeysetcache') }}
        continue-on-error: true
        run: |
          cd compiler
          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} make keysetcache_ci_populated

      - name: Mark KeySetCache
        run: |
          touch keysetcache.timestamp

      - name: Build compiler and run end-to-end benchmarks
        run: |
          set -e
          cd compiler
          make BINDINGS_PYTHON_ENABLED=OFF run-benchmarks

      - name: Upload raw results artifact
        uses: actions/upload-artifact@v3
        with:
          name: ${{ github.sha }}_raw
          path: compiler/benchmarks_results.json

      - name: Parse results
        shell: bash
        run: |
          OPTIMIZER_HASH="$(cd compiler/concrete-optimizer; git rev-parse HEAD)"
          python3 ./ci/benchmark_parser.py compiler/benchmarks_results.json ${{ env.RESULTS_FILENAME }} \
          --series-name compiler_end_to_end_benchmarks \
          --series-help "Concrete compiler end-to-end benchmarks timings" \
          --series-tags "{\"compiler_hash\": \"${{ github.sha }}\", \"branch\": \"${{ github.ref_name }}\", \"optimizer_hash\": \"${OPTIMIZER_HASH}\", \"hardware\": \"aws ${{ env.EC2_INSTANCE_TYPE }}\"}"

      - name: Upload parsed results artifact
        uses: actions/upload-artifact@v3
        with:
          name: ${{ github.sha }}
          path: ${{ env.RESULTS_FILENAME }}

      - name: Checkout Slab repo
        uses: actions/checkout@v3
        with:
          repository: zama-ai/slab
          path: slab
          token: ${{ secrets.GH_TOKEN }}

      - name: Send data to Slab
        shell: bash
        run: |
          echo "Computing HMac on downloaded artifact"
          SIGNATURE="$(slab/scripts/hmac_calculator.sh ${{ env.RESULTS_FILENAME }} '${{ secrets.JOB_SECRET }}')"
          echo "Sending results to Slab..."
          curl -v -k \
          -H "Content-Type: application/json" \
          -H "X-Slab-Repository: ${{ github.repository }}" \
          -H "X-Slab-Command: plot_data" \
          -H "X-Hub-Signature-256: sha256=${SIGNATURE}" \
          -d @${{ env.RESULTS_FILENAME }} \
          ${{ secrets.SLAB_URL }}


  stop-runner:
    name: Stop EC2 runner
    needs:
      - start-runner
      - run-benchmarks
    runs-on: ubuntu-20.04
    if: ${{ always() && (needs.start-runner.result != 'skipped') }}
    steps:
      - name: Sets AWS region for m6i.metal
        if: ${{ env.EC2_INSTANCE_TYPE == 'm6i.metal' }}
        run: |
          echo "AWS_REGION=eu-west-3" >> $GITHUB_ENV

      - name: Sets AWS region for c6a.metal
        if: ${{ env.EC2_INSTANCE_TYPE == 'c6a.metal' }}
        run: |
          echo "AWS_REGION=us-east-1" >> $GITHUB_ENV

      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ${{ env.AWS_REGION }}
      - name: Stop EC2 runner
        uses: machulav/ec2-github-runner@v2
        with:
          github-token: ${{ secrets.CONCRETE_ACTIONS_TOKEN }}
          label: ${{ needs.start-runner.outputs.label }}
          ec2-instance-id: ${{ needs.start-runner.outputs.ec2-instance-id }}
          mode: stop