|
| 1 | +name: openkal cross-build (3 hosts × 3 targets) |
| 2 | + |
| 3 | +# ⭐⭐ WHAT THIS WORKFLOW ASSERTS, AND WHY IT IS A MATRIX RATHER THAN A ROW. |
| 4 | +# |
| 5 | +# `cross-build-test.yml` verifies the crosses served by a PAYLOAD: a toolchain |
| 6 | +# whose driver has exactly one target. There the host and the target are joined |
| 7 | +# — `x86_64-w64-mingw32-g++` is the Windows cross and nothing else — so one row |
| 8 | +# per supported combination is the honest shape. |
| 9 | +# |
| 10 | +# openkal changes the shape of the question. The target side — the C library, |
| 11 | +# the C++ runtime, the platform's own implementation — is a set of PACKAGES in |
| 12 | +# the dependency graph, and the compiler is an ordinary retargetable clang. The |
| 13 | +# claim that follows is that N hosts × N targets collapses to N implementations |
| 14 | +# plus one tool: **the machine doing the building stops being a variable.** |
| 15 | +# |
| 16 | +# ⚠️ THAT IS A CLAIM, AND CLAIMS OF THIS SHAPE HAVE BEEN WRONG IN THIS |
| 17 | +# REPOSITORY. Reaching PE from a Linux host needed four separate repairs, and |
| 18 | +# adding the other two hosts found seven more — every one of them a decision |
| 19 | +# that had been keyed on which machine was building rather than on which machine |
| 20 | +# the output was for: |
| 21 | +# |
| 22 | +# the link line's three host-shaped branches, only one of which carried |
| 23 | +# `--target=`; the `std` module command's Windows branch, which dropped the |
| 24 | +# package's own include paths; `cd X && …` not changing the drive in cmd.exe; |
| 25 | +# the artefact-format test matching LLVM's `apple` rather than mcpp's `macos`; |
| 26 | +# the C++ runtime contract naming a library to link when one was already in |
| 27 | +# the objects; `-nostdinc` missing so a host SDK header could be found; and |
| 28 | +# `-lgcc` naming GCC's runtime on a link whose compiler is clang. |
| 29 | +# |
| 30 | +# None of those was visible from one host. So the matrix is the test. |
| 31 | +# |
| 32 | +# ── The shape ────────────────────────────────────────────────────────────── |
| 33 | +# |
| 34 | +# THREE build jobs, one per host, each producing THREE artefacts — nine builds. |
| 35 | +# THREE run jobs, one per system, each executing the artefact FOR that system |
| 36 | +# produced by ALL THREE hosts. |
| 37 | +# |
| 38 | +# build on Linux build on macOS build on Windows |
| 39 | +# run Linux ✓ ✓ ✓ |
| 40 | +# run macOS ✓ ✓ ✓ |
| 41 | +# run Windows ✓ ✓ ✓ |
| 42 | +# |
| 43 | +# ⭐ The diagonal is an ordinary native build. The six off-diagonal cells are |
| 44 | +# the claim, and they are what a single-host workflow cannot reach. |
| 45 | +# |
| 46 | +# ⚠️ THE RUN JOBS INSTALL NOTHING — not mcpp, not a compiler, not a C runtime. |
| 47 | +# A program above openkal carries its C library, its C++ runtime and its |
| 48 | +# unwinder; what remains is the operating system it was built for. If a |
| 49 | +# toolchain step is ever added to one of them because "the program needs it", |
| 50 | +# that is the finding rather than the fix. |
| 51 | +# |
| 52 | +# ⚠️ AND THE ASSERTION IS ON THE OUTPUT, NOT THE EXIT STATUS. The program prints |
| 53 | +# four lines, and `unwound: true` is the one a link cannot fake: it says a |
| 54 | +# destructor ran while an exception was being carried out of a frame, which |
| 55 | +# means the unwinder found this image's own frame descriptions. |
| 56 | + |
| 57 | +on: |
| 58 | + pull_request: |
| 59 | + workflow_dispatch: |
| 60 | + |
| 61 | +concurrency: |
| 62 | + group: ci-${{ github.workflow }}-${{ github.ref }} |
| 63 | + cancel-in-progress: true |
| 64 | + |
| 65 | +env: |
| 66 | + # ⚠️ The version that BOOTSTRAPS the build of this repository's mcpp. What is |
| 67 | + # under test is the mcpp that comes out, which is why every step below uses |
| 68 | + # the built binary rather than this one. |
| 69 | + MCPP_VERSION: 2026.8.19.4 |
| 70 | + XLINGS_VERSION: v2026.8.17.2 |
| 71 | + XLINGS_NON_INTERACTIVE: '1' |
| 72 | + # The branch of the openkal packages this change is verified against. They |
| 73 | + # move together with it; when they are on `main` this becomes `main`. |
| 74 | + OPENKAL_BRANCH: feat/openkal-closure |
| 75 | + |
| 76 | +jobs: |
| 77 | + build: |
| 78 | + name: build 3 targets on ${{ matrix.host }} |
| 79 | + runs-on: ${{ matrix.runner }} |
| 80 | + timeout-minutes: 120 |
| 81 | + strategy: |
| 82 | + fail-fast: false |
| 83 | + matrix: |
| 84 | + include: |
| 85 | + - { host: linux, runner: ubuntu-24.04 } |
| 86 | + - { host: macos, runner: macos-14 } |
| 87 | + - { host: windows, runner: windows-2022 } |
| 88 | + defaults: |
| 89 | + run: |
| 90 | + shell: bash |
| 91 | + steps: |
| 92 | + - uses: actions/checkout@v4 |
| 93 | + |
| 94 | + - name: Install xlings (Unix) |
| 95 | + if: runner.os != 'Windows' |
| 96 | + run: | |
| 97 | + curl -fsSL https://raw.githubusercontent.com/openxlings/xlings/main/tools/other/quick_install.sh \ |
| 98 | + | bash -s "$XLINGS_VERSION" |
| 99 | + echo "$HOME/.xlings/subos/current/bin" >> "$GITHUB_PATH" |
| 100 | +
|
| 101 | + - name: Install xlings (Windows) |
| 102 | + if: runner.os == 'Windows' |
| 103 | + shell: pwsh |
| 104 | + run: | |
| 105 | + irm https://d2learn.org/xlings-install.ps1.txt | iex |
| 106 | + "$env:USERPROFILE\.xlings\subos\current\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append |
| 107 | +
|
| 108 | + - name: Install the bootstrap mcpp |
| 109 | + run: | |
| 110 | + # ⚠️ A LOOP, because one `xlings update` can return a stale index |
| 111 | + # without saying so: the index is published behind a pointer that |
| 112 | + # propagates asynchronously, and "synced 0 seconds ago" describes when |
| 113 | + # it was fetched rather than what it contains. |
| 114 | + for attempt in 1 2 3 4 5 6; do |
| 115 | + xlings update > /dev/null 2>&1 || true |
| 116 | + if xlings install "mcpp@$MCPP_VERSION" -y -g; then break; fi |
| 117 | + if [ "$attempt" = 6 ]; then |
| 118 | + echo "::error::mcpp@$MCPP_VERSION never appeared in the index"; exit 1 |
| 119 | + fi |
| 120 | + sleep 60 |
| 121 | + done |
| 122 | + mcpp self config --mirror GLOBAL |
| 123 | +
|
| 124 | + # ⭐ THE mcpp UNDER TEST. Everything after this uses the binary this step |
| 125 | + # produces; the bootstrap one above is only what compiles it. |
| 126 | + - name: Build the mcpp in this pull request |
| 127 | + run: | |
| 128 | + set -euo pipefail |
| 129 | + # ⚠️ `--dev` and not `--release`. What is under test is a set of |
| 130 | + # decisions about compile and link flags; an optimisation level |
| 131 | + # changes none of them and a release self-build is most of the budget |
| 132 | + # of a job on a two-core runner. |
| 133 | + mcpp build --dev |
| 134 | + BUILT=$(find target -type f \( -name 'mcpp' -o -name 'mcpp.exe' \) | head -1) |
| 135 | + [ -n "$BUILT" ] || { echo "::error::mcpp did not build"; exit 1; } |
| 136 | + echo "$(cd "$(dirname "$BUILT")" && pwd)" >> "$GITHUB_PATH" |
| 137 | + "$BUILT" --version |
| 138 | +
|
| 139 | + - name: Select the toolchain the openkal packages ask for |
| 140 | + run: | |
| 141 | + # ⚠️ Install, then select. `toolchain default` names one and does not |
| 142 | + # fetch it. |
| 143 | + mcpp toolchain install llvm 22.1.8 |
| 144 | + mcpp toolchain default 'llvm@22.1.8' |
| 145 | +
|
| 146 | + - name: The program — one source, three targets |
| 147 | + run: | |
| 148 | + set -euo pipefail |
| 149 | + git clone --quiet --depth 1 -b "$OPENKAL_BRANCH" \ |
| 150 | + https://github.com/mcpplibs/openkal-llvm-runtime "$RUNNER_TEMP/okl" |
| 151 | + cd "$RUNNER_TEMP/okl/examples/same-source" |
| 152 | + mkdir -p "$RUNNER_TEMP/out" |
| 153 | + # ⚠️ The three HOSTED targets. Bare metal is verified by |
| 154 | + # `openkal-llvm-runtime`'s own CI under qemu; it has no runner here to |
| 155 | + # execute on, and a build-only cell in a workflow whose point is |
| 156 | + # running would be the weaker claim. |
| 157 | + for t in x86_64-linux-gnu aarch64-macos x86_64-windows-gnu; do |
| 158 | + rm -rf target |
| 159 | + mcpp build --target "$t" |
| 160 | + a=$(find target -type f \( -name 'openkal-same-source' -o -name 'openkal-same-source.exe' \) | head -1) |
| 161 | + [ -n "$a" ] || { echo "::error::$t produced no artefact on ${{ matrix.host }}"; exit 1; } |
| 162 | + case "$t" in |
| 163 | + x86_64-windows-gnu) cp "$a" "$RUNNER_TEMP/out/windows.exe" ;; |
| 164 | + aarch64-macos) cp "$a" "$RUNNER_TEMP/out/macos" ;; |
| 165 | + *) cp "$a" "$RUNNER_TEMP/out/linux" ;; |
| 166 | + esac |
| 167 | + echo "${{ matrix.host }} → $t : $(ls -l "$a" | awk '{print $5}') bytes" |
| 168 | + done |
| 169 | +
|
| 170 | + - uses: actions/upload-artifact@v4 |
| 171 | + with: |
| 172 | + name: openkal-built-on-${{ matrix.host }} |
| 173 | + path: ${{ runner.temp }}/out/ |
| 174 | + if-no-files-found: error |
| 175 | + |
| 176 | + run: |
| 177 | + name: run 3 builds on ${{ matrix.system }} |
| 178 | + needs: build |
| 179 | + runs-on: ${{ matrix.runner }} |
| 180 | + timeout-minutes: 15 |
| 181 | + strategy: |
| 182 | + fail-fast: false |
| 183 | + matrix: |
| 184 | + include: |
| 185 | + - { system: linux, runner: ubuntu-24.04, file: linux } |
| 186 | + - { system: macos, runner: macos-14, file: macos } |
| 187 | + - { system: windows, runner: windows-2022, file: windows.exe } |
| 188 | + defaults: |
| 189 | + run: |
| 190 | + shell: bash |
| 191 | + steps: |
| 192 | + # ⚠️ NO checkout AND NO toolchain. This job is the claim: a program built |
| 193 | + # above openkal needs the operating system it was built for and nothing |
| 194 | + # else. Anything installed here would weaken what a pass means. |
| 195 | + - uses: actions/download-artifact@v4 |
| 196 | + with: { pattern: openkal-built-on-*, path: art } |
| 197 | + |
| 198 | + - name: The same program, from all three build hosts |
| 199 | + run: | |
| 200 | + set -euo pipefail |
| 201 | + fail=0 |
| 202 | + for host in linux macos windows; do |
| 203 | + bin="art/openkal-built-on-$host/${{ matrix.file }}" |
| 204 | + echo "──────── built on $host, running on ${{ matrix.system }} ────────" |
| 205 | + if [ ! -f "$bin" ]; then |
| 206 | + echo "::error::$bin is missing"; fail=1; continue |
| 207 | + fi |
| 208 | + # ⚠️ The executable bit does not survive an artefact upload. |
| 209 | + chmod +x "$bin" || true |
| 210 | + # ⚠️ arm64 macOS refuses an unsigned image, so the signature is |
| 211 | + # asserted before the run: a failure here is "the linker did not |
| 212 | + # ad-hoc sign it", which is a different repair from "it crashed". |
| 213 | + if [ "${{ matrix.system }}" = "macos" ]; then |
| 214 | + codesign -dv "$bin" 2>&1 | grep -q 'adhoc\|Signature' \ |
| 215 | + || { echo "::error::built on $host: no code signature"; fail=1; continue; } |
| 216 | + fi |
| 217 | + if ! "./$bin" > out.log 2>&1; then |
| 218 | + echo "::error::built on $host: it did not run"; cat out.log; fail=1; continue |
| 219 | + fi |
| 220 | + cat out.log |
| 221 | + ok=1 |
| 222 | + grep -q 'sorted: 2 4 7' out.log || ok=0 |
| 223 | + grep -q 'caught: 42' out.log || ok=0 |
| 224 | + # ⭐ The line a link cannot fake. |
| 225 | + grep -q 'unwound: true' out.log || ok=0 |
| 226 | + grep -q 'import std over openkal: ok' out.log || ok=0 |
| 227 | + [ "$ok" = 1 ] || { echo "::error::built on $host: wrong output"; fail=1; } |
| 228 | + done |
| 229 | + [ "$fail" = 0 ] || exit 1 |
| 230 | + echo "three builds, one system, same four lines" |
0 commit comments