RetroArch/.github/workflows/Linux-pace-shadow.yml at master · CarletonComputerScienceSociety/RetroArch · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
name: CI Linux pace shadow [debug harness]

# The pace decision - which sources hold the loop each iteration - is
# one pure function, runloop_pace_decide() in runloop.h, that every
# path of runloop_iterate() defers to. It began life shadowing the
# paths' own scattered decisions with a debug assertion that the two
# agreed; this job was created to run that assertion in CI, and it
# never fired, which is what let the paths defer.
#
# What the job still does: builds with DEBUG=1 under ASan and UBSan,
# so every retro_assert in the wrapper, the ring and the runloop is
# live, and runs the threaded-video harness through it - threaded and
# unthreaded, menu open and closed, display pacing on, the runtime
# toggles - then the pacing sample, whose menu table pins the decision
# row by row. The release harness job cannot see an assertion; this
# one can.

on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}

jobs:
  linux-pace-shadow:
    name: Debug build, harness with assertions live
    runs-on: ubuntu-latest
    timeout-minutes: 45

    steps:
      - name: Install dependencies
        timeout-minutes: 5
        run: |
          pkgs="build-essential libxkbcommon-dev libx11-xcb-dev xvfb x11-utils zlib1g-dev libfreetype6-dev libegl1-mesa-dev libgles2-mesa-dev libgbm-dev libavcodec-dev libsdl2-dev libsdl-image1.2-dev libxml2-dev yasm"
          if dpkg -s $pkgs >/dev/null 2>&1; then
            echo "All packages already present on runner image; skipping apt."
            exit 0
          fi
          for i in 1 2 3; do
            sudo timeout 90 apt-get update -y \
              -o Acquire::Retries=3 -o Acquire::http::Timeout=30 && break
            echo "apt-get update failed (attempt $i); retrying in 10s"
            sleep 10
          done
          sudo apt-get install -y \
            -o Acquire::Retries=3 -o Acquire::http::Timeout=30 \
            $pkgs

      - name: Checkout
        uses: actions/checkout@v5

      - name: Configure
        # Non-Qt, as the harness requires (with Qt, main() lives in
        # ui_qt.o). Menu enabled: the menu lanes are half the point.
        run: |
          ./configure \
            --disable-qt \
            --disable-discord \
            --disable-cheevos \
            --disable-networking \
            --disable-ffmpeg

      - name: Build with DEBUG=1 and -fsanitize=address,undefined
        run: |
          make -j$(getconf _NPROCESSORS_ONLN) SANITIZER=address,undefined DEBUG=1

      - name: Run the threaded-video harness with assertions live
        shell: bash
        run: |
          set -eu
          # SAN=address is the harness's default and links exactly the
          # build above; CYCLES=2 runs each toggling lane twice.
          SAN=address CYCLES=2 make -C samples/gfx/threaded_video check
          make -C samples/gfx/threaded_video clean

      - name: Run the pacing sample (the menu table)
        shell: bash
        run: |
          set -eu
          make -C samples/runloop/pacing check
          make -C samples/runloop/pacing clean