.appveyor.sh

-# Configure the environment
-MSYSTEM=MINGW64
-THREADS=9
-SKIP_PERF_TESTS=YES
-BUILD_FLAVOUR=
-source /etc/profile || true # a terrible, terrible workaround for msys2 brokenness
-
-# Don't set -e until after /etc/profile is sourced
-set -ex
-cd $APPVEYOR_BUILD_FOLDER
-
-case "$1" in
-    "prepare")
-        # Prepare the tree
-        git config remote.origin.url git://github.com/ghc/ghc.git
-        git config --global url."git://github.com/ghc/packages-".insteadOf git://github.com/ghc/packages/
-        git submodule init
-        git submodule --quiet update --recursive
-        ;;
-    "build")
-        # Build the compiler
-        ./boot
-        cat <<EOF >> mk/build.mk
-        BuildFlavour=$BUILD_FLAVOUR
-        ifneq "\$(BuildFlavour)" ""
-        include mk/flavours/\$(BuildFlavour).mk
-        endif
-EOF
-        ./configure --enable-tarballs-autodownload
-        make -j$THREADS
-        ;;
-
-    "test")
-        make binary-dist
-        curl https://ghc-artifacts.s3.amazonaws.com/tools/ghc-artifact-collector-x86_64-windows --output ghc-artifact-collector
-        ./ghc-artifact-collector *.tar.xz
-        make test THREADS=$THREADS
-        ;;
-
-    *)
-        echo "$0: unknown mode $1"
-        exit 1
-        ;;
-esac

.editorconfig

+# http://editorconfig.org
+
+root = true
+
+[*.hs]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[Makefile]
+indent_style = tab
+
+[*.c]
+indent_style = space
+indent_size = 2

.ghcid

---command sh ./hadrian/ghci.sh
+--command sh -c "HADRIAN_ARGS=-j exec ./hadrian/ghci-multi -j"
 --reload compiler
 --reload ghc
 --reload includes
---restart hadrian/
+--restart hadrian/ghci-multi

.git-blame-ignore-revs

+5eecb20a0368b599d03930e2dbb0e91540de4cb2

.git-ignore-revs

+# Configure git to ignore commits listed in this file with:
+#
+#   git config blame.ignoreRevsFile .git-ignore-revs
+
+# Module Hierarchy Renamings
+af332442123878c1b61d236dce46418efcbe8750
+255418da5d264fb2758bc70925adb2094f34adc3
+1941ef4f050c0dfcb68229641fcbbde3a10f1072
+528df8ecb4e2f9c78b1ae4ab7ff8230644e9b643
+18a346a4b5a02b8c62e8eedb91b35c2d8e754b96
+817f93eac4d13f680e8e3e7a25eb403b1864f82e
+1b1067d14b656bbbfa7c47f156ec2700c9751549
+240f5bf6f53515535be5bf3ef7632aa69ae21e3e
+1500f0898e85316c7c97a2f759d83278a072ab0e
+3ca52151881451ce5b3a7740d003e811b586140d
+cf739945b8b28ff463dc44925348f20b3c1f22cb
+da7f74797e8c322006eba385c9cbdce346dd1d43
+6e2d9ee25bce06ae51d2f1cf8df4f7422106a383
+d491a6795d507eabe35d8aec63c534d29f2d305b
+99a9f51bf8207c79241fc0b685fadeb222a61292
+eb6082358cdb5f271a8e4c74044a12f97352c52f
+5119296440e6846c553c72b8a93afc5ecfa576f0
+447864a94a1679b5b079e08bb7208a0005381cef

.gitattributes

+# convert CRLF into LF on checkin
+# don't convert anything on checkout
+* text=auto eol=lf
 mk/win32-tarballs.md5sum text=auto eol=LF
+testsuite/tests/parser/should_run/T25375.hs text=auto eol=crlf

.gitignore

@@ -17,6 +17,8 @@ Thumbs.db
 
 *.hi
 *.hi-boot
+*.hie
+*.hie-boot
 *.o-boot
 *.p_o
 *.t_o
@@ -31,7 +33,9 @@ Thumbs.db
 *.dyn_o
 *.dyn_hi
 __pycache__
+.mypy_cache
 *.SYMDEF*
+a.out
 
 log
 tags
@@ -41,6 +45,8 @@ autom4te.cache
 config.log
 config.status
 configure
+# GHC's own aclocal.m4 is generated by aclocal
+/aclocal.m4
 
 # Temporarily generated configure files
 confdefs.h
@@ -49,8 +55,15 @@ confdefs.h
 stage0
 stage1
 stage2
-_build
+# Ignore _build, _validatebuild and any other custom build directories headed by _
+_*
+*/generated/
+*/ghc-stage1
+.shake.*
 .hadrian_ghci
+.hadrian_ghci_multi/
+.hie-bios
+hadrian/bootstrap/jq-bin
 
 # -----------------------------------------------------------------------------
 # Ignore any overlapped darcs repos and back up files
@@ -69,12 +82,12 @@ _darcs/
 /driver/ghc/dist/
 /driver/haddock/dist/
 /driver/ghci/dist/
-/includes/dist-*/
 /libffi/dist-install/
 /libraries/*/dist-boot/
 /libraries/*/dist-install/
+/libraries/*/dist-newstyle/
 /libraries/dist-haddock/
-/rts/dist/
+/linters/*/dist-install/
 /utils/*/dist*/
 /compiler/stage1/
 /compiler/stage2/
@@ -87,6 +100,7 @@ _darcs/
 # -----------------------------------------------------------------------------
 # specific generated files
 
+/.gitlab/jobs-metadata.json
 /bindist-list
 /bindist-list.uniq
 /bindistprep/
@@ -96,12 +110,19 @@ _darcs/
 /ch01.html
 /ch02.html
 /compiler/dist/
+/compiler/Bytecodes.h
+/compiler/ClosureTypes.h
+/compiler/FunTypes.h
+/compiler/MachRegs.h
+/compiler/MachRegs
+/compiler/GHC/CmmToLlvm/Version/Bounds.hs
 /compiler/ghc.cabal
 /compiler/ghc.cabal.old
 /distrib/configure.ac
 /distrib/ghc.iss
-/docs/man
 /docs/index.html
+/docs/man
+/docs/users_guide/.log
 /docs/users_guide/users_guide
 /docs/users_guide/ghc.1
 /docs/users_guide/flags.pyc
@@ -117,16 +138,19 @@ _darcs/
 /docs/users_guide/utils.pyc
 /driver/ghci/ghc-pkg-inplace
 /driver/ghci/ghci-inplace
+/driver/ghci/ghci-wrapper.cabal
 /driver/ghci/ghci.res
+/driver/ghci/cwrapper.c
+/driver/ghci/cwrapper.h
+/driver/ghci/getLocation.c
+/driver/ghci/getLocation.h
+/driver/ghci/isMinTTY.c
+/driver/ghci/isMinTTY.h
 /driver/package.conf
 /driver/package.conf.inplace.old
 /settings
 /ghc.spec
 /ghc/ghc-bin.cabal
-/includes/dist/
-/includes/ghcautoconf.h
-/includes/ghcplatform.h
-/includes/ghcversion.h
 /index.html
 /inplace/
 /libffi/build/
@@ -144,8 +168,12 @@ _darcs/
 /libraries/ghc-boot/ghc-boot.cabal
 /libraries/ghc-boot-th/GNUmakefile
 /libraries/ghc-boot-th/ghc-boot-th.cabal
+/libraries/ghc-boot-th-next/ghc-boot-th-next.cabal
 /libraries/ghc-boot-th/ghc.mk
 /libraries/ghc-heap/ghc-heap.cabal
+/libraries/ghc-internal/ghc-internal.cabal
+/libraries/ghc-experimental/ghc-experimental.cabal
+/libraries/base/base.cabal
 /libraries/ghci/GNUmakefile
 /libraries/ghci/ghci.cabal
 /libraries/ghci/ghc.mk
@@ -163,19 +191,13 @@ _darcs/
 /linter.log
 /mk/are-validating.mk
 /mk/build.mk
-/mk/config.h
-/mk/config.h.in
 /mk/config.mk
 /mk/config.mk.old
+/mk/system-cxx-std-lib-1.0.conf
 /mk/install.mk
 /mk/project.mk
 /mk/project.mk.old
 /mk/validate.mk
-/rts/rts.cabal
-/rts/package.conf.inplace
-/rts/package.conf.inplace.raw
-/rts/package.conf.install
-/rts/package.conf.install.raw
 /stage3.package.conf
 /testsuite_summary*.txt
 /testsuite*.xml
@@ -186,11 +208,10 @@ _darcs/
 /utils/mkUserGuidePart/mkUserGuidePart.cabal
 /utils/runghc/runghc.cabal
 /utils/gen-dll/gen-dll.cabal
-utils/lndir/fs.*
+/utils/ghc-pkg/ghc-pkg.cabal
 utils/unlit/fs.*
-rts/fs.*
-libraries/base/include/fs.h
-libraries/base/cbits/fs.c
+libraries/ghc-internal/include/fs.h
+libraries/ghc-internal/cbits/fs.c
 missing-win32-tarballs
 
 /extra-gcc-opts
@@ -212,13 +233,26 @@ GIT_COMMIT_ID
 *.run
 
 # -----------------------------------------------------------------------------
-# Output of ghc-in-ghci
+# ghc.nix
+ghc.nix/
 
-/.ghci-objects/
+# gdb
+.gdb_history
+.gdbinit
 
 # -----------------------------------------------------------------------------
-# ghc.nix
-ghc.nix/
+# Tooling
 
+# direnv
+.envrc
+.direnv
 
-.gdb_history
+# Visual Studio Code
+.vscode
+
+# Tooling - ghcide
+*.hiedb
+
+# clangd
+.clangd
+dist-newstyle/

.gitlab/README.md

+# Where the GitLab happens
+
+
+## Updating PERF_NOTES_PUSH_CREDENTIALS
+
+This CI variable is used by test-metrics.sh to push performance data as a git
+note to https://gitlab.haskell.org/ghc/ghc-performance-notes.
+
+The current token will expire on 2025-07-02.
+
+### STEPS
+
+Set and fetch the updated token:
+
+```
+GITLAB_WRITE=<Your Gitlab API token>
+
+one_year_later="$(date --date='1 year' --iso-8601)"
+curl -X POST --header "PRIVATE-TOKEN: $GITLAB_WRITE" -H "Content-Type: application/json" \
+    --data '{"name":"test-metrics.sh", "scopes":["write_repository"], "expires_at":"$one_year_later"}' \
+    https://gitlab.haskell.org/api/v4/projects/117/access_tokens \
+    | jq .token
+```
+
+Update the variable:
+
+```
+GITLAB_WRITE=<Your Gitlab API token>
+
+NEW_VALUE=<Output from the above>
+
+curl --fail-with-body --request PUT --header "PRIVATE-TOKEN: $GITLAB_WRITE" \
+    "https://gitlab.haskell.org/api/v4/projects/1/variables/PERF_NOTES_PUSH_CREDENTIALS" \
+    --form "value=$NEW_VALUE"
+
+```

.gitlab/ci.sh

+#!/usr/bin/env bash
+# shellcheck disable=SC2230
+# shellcheck disable=SC1090
+
+# This is the primary driver of the GitLab CI infrastructure.
+# Run `ci.sh usage` for usage information.
+set -Eeuo pipefail
+
+# Configuration:
+# N.B. You may want to also update the index-state in hadrian/cabal.project.
+HACKAGE_INDEX_STATE="2025-01-27T17:45:32Z"
+MIN_HAPPY_VERSION="1.20"
+MIN_ALEX_VERSION="3.2.6"
+
+TOP="$(pwd)"
+if [ ! -d "$TOP/.gitlab" ]; then
+  echo "This script expects to be run from the root of a ghc checkout"
+fi
+
+CABAL_CACHE="$TOP/${CABAL_CACHE:-cabal-cache}"
+
+source "$TOP/.gitlab/common.sh"
+
+function time_it() {
+  local name="$1"
+  shift
+  local start=$(date +%s)
+  local res=0
+  set +e
+  ( set -e ; $@ )
+  res=$?
+  set -e
+  local end=$(date +%s)
+  local delta=$(expr $end - $start)
+
+  echo "$name took $delta seconds"
+  printf "%15s | $delta" > ci-timings
+  return $res
+}
+
+function usage() {
+  cat <<EOF
+$0 - GHC continuous integration driver
+
+Common Modes:
+
+  usage             Show this usage message.
+  setup             Prepare environment for a build.
+  configure         Run ./configure.
+  clean             Clean the tree
+  shell             Run an interactive shell with a configured build environment.
+  save_test_output  Generate unexpected-test-output.tar.gz
+  save_cache        Preserve the cabal cache
+
+Hadrian build system
+  build_hadrian Build GHC via the Hadrian build system
+  test_hadrian  Test GHC via the Hadrian build system
+
+Environment variables affecting both build systems:
+
+  CROSS_TARGET      Triple of cross-compilation target.
+  VERBOSE           Set to non-empty for verbose build output
+  RUNTEST_ARGS      Arguments passed to runtest.py
+  MSYSTEM           (Windows-only) Which platform to build from (CLANG64).
+  IGNORE_PERF_FAILURES
+                    Whether to ignore perf failures (one of "increases",
+                    "decreases", or "all")
+  HERMETIC          Take measures to avoid looking at anything in \$HOME
+  CONFIGURE_ARGS    Arguments passed to configure script.
+  CONFIGURE_WRAPPER Wrapper for the configure script (e.g. Emscripten's emconfigure).
+  ENABLE_NUMA       Whether to enable numa support for the build (disabled by default)
+  INSTALL_CONFIGURE_ARGS
+                    Arguments passed to the binary distribution configure script
+                    during installation of test toolchain.
+  NIX_SYSTEM        On Darwin, the target platform of the desired toolchain
+                    (either "x86-64-darwin" or "aarch-darwin")
+  NO_BOOT           Whether to run ./boot or not, used when testing the source dist
+
+Environment variables determining build configuration of Hadrian system:
+
+  BUILD_FLAVOUR     Which flavour to build.
+  REINSTALL_GHC     Build and test a reinstalled "stage3" ghc built using cabal-install
+                    This tests the "reinstall" configuration
+  CROSS_EMULATOR    The emulator to use for testing of cross-compilers.
+
+Environment variables determining bootstrap toolchain (Linux):
+
+  GHC           Path of GHC executable to use for bootstrapping.
+  CABAL         Path of cabal-install executable to use for bootstrapping.
+  ALEX          Path of alex executable to use for bootstrapping.
+  HAPPY         Path of alex executable to use for bootstrapping.
+
+Environment variables determining bootstrap toolchain (non-Linux):
+
+  GHC_VERSION   Which GHC version to fetch for bootstrapping.
+  CABAL_INSTALL_VERSION
+                Cabal-install version to fetch for bootstrapping.
+EOF
+}
+
+function setup_locale() {
+  # Musl doesn't provide locale support at all...
+  if ! which locale > /dev/null; then
+    info "No locale executable. Skipping locale setup..."
+    return
+  fi
+
+  # BSD grep terminates early with -q, consequently locale -a will get a
+  # SIGPIPE and the pipeline will fail with pipefail.
+  shopt -o -u pipefail
+  if locale -a | grep -q C.UTF-8; then
+    # Debian
+    export LANG=C.UTF-8
+  elif locale -a | grep -q C.utf8; then
+    # Fedora calls it this
+    export LANG=C.utf8
+  elif locale -a | grep -q en_US.UTF-8; then
+    # Centos doesn't have C.UTF-8
+    export LANG=en_US.UTF-8
+  elif locale -a | grep -q en_US.utf8; then
+    # Centos doesn't have C.UTF-8
+    export LANG=en_US.utf8
+  else
+    error "Failed to find usable locale"
+    info "Available locales:"
+    locale -a
+    fail "No usable locale, aborting..."
+  fi
+  info "Using locale $LANG..."
+  export LC_ALL=$LANG
+  shopt -o -s pipefail
+}
+
+function mingw_init() {
+  case "$MSYSTEM" in
+    CLANG64)
+      target_triple="x86_64-unknown-mingw32"
+      boot_triple="x86_64-unknown-mingw32" # triple of bootstrap GHC
+      ;;
+    *)
+      fail "win32-init: Unknown MSYSTEM $MSYSTEM"
+      ;;
+  esac
+
+  # Bring mingw toolchain into PATH.
+  # This is extracted from /etc/profile since this script inexplicably fails to
+  # run under gitlab-runner.
+  # shellcheck disable=SC1091
+  source /etc/msystem
+  MINGW_MOUNT_POINT="${MINGW_PREFIX}"
+  PATH="$MINGW_MOUNT_POINT/bin:$PATH"
+
+  # We always use mingw64 Python to avoid path length issues like #17483.
+  export PYTHON="/mingw64/bin/python3"
+  # And need to use sphinx-build from the environment
+  export SPHINXBUILD="/mingw64/bin/sphinx-build.exe"
+}
+
+# This will contain GHC's local native toolchain
+toolchain="$TOP/toolchain"
+mkdir -p "$toolchain/bin"
+PATH="$toolchain/bin:$PATH"
+
+export METRICS_FILE="$TOP/performance-metrics.tsv"
+
+cores="$(mk/detect-cpu-count.sh)"
+
+# Use a local temporary directory to ensure that concurrent builds don't
+# interfere with one another
+mkdir -p "$TOP/tmp"
+export TMP="$TOP/tmp"
+export TEMP="$TOP/tmp"
+
+function show_tool() {
+  local tool="$1"
+  info "$tool = ${!tool}"
+  ${!tool} --version
+}
+
+function set_toolchain_paths() {
+  case "$(uname -m)-$(uname)" in
+    # Linux toolchains are included in the Docker image
+    *-Linux) toolchain_source="env" ;;
+    # Darwin toolchains are provided via .gitlab/darwin/toolchain.nix
+    *-Darwin) toolchain_source="nix" ;;
+    *) toolchain_source="extracted" ;;
+  esac
+
+  case "$toolchain_source" in
+    extracted)
+      # These are populated by setup_toolchain
+      GHC="$toolchain/bin/ghc$exe"
+      CABAL="$toolchain/bin/cabal$exe"
+      HAPPY="$toolchain/bin/happy$exe"
+      ALEX="$toolchain/bin/alex$exe"
+      if [ "$(uname)" = "FreeBSD" ]; then
+        GHC=/usr/local/bin/ghc
+      fi
+      ;;
+    nix)
+      if [[ ! -f toolchain.sh ]]; then
+        case "$NIX_SYSTEM" in
+          x86_64-darwin|aarch64-darwin) ;;
+          *) fail "unknown NIX_SYSTEM" ;;
+        esac
+        info "Building toolchain for $NIX_SYSTEM"
+        nix-build --quiet .gitlab/darwin/toolchain.nix --argstr system "$NIX_SYSTEM" -o toolchain.sh
+      fi
+      source toolchain.sh
+      ;;
+    env)
+      # These are generally set by the Docker image but
+      # we provide these handy fallbacks in case the
+      # script isn't run from within a GHC CI docker image.
+      : ${GHC:=$(which ghc)}
+      : ${CABAL:=$(which cabal)}
+      : ${HAPPY:=$(which happy)}
+      : ${ALEX:=$(which alex)}
+      ;;
+    *) fail "bad toolchain_source"
+  esac
+
+  export GHC
+  export CABAL
+  export HAPPY
+  export ALEX
+
+  if [[ "${CROSS_TARGET:-}" == *"wasm"* ]]; then
+    source "/home/ghc/.ghc-wasm/env"
+  fi
+}
+
+function cabal_update() {
+  # In principle -w shouldn't be necessary here but with
+  # cabal-install 3.8.1.0 it is, due to cabal#8447.
+  run "$CABAL" update -w "$GHC" "hackage.haskell.org,${HACKAGE_INDEX_STATE}"
+}
+
+
+# Extract GHC toolchain
+function setup() {
+  echo "=== TIMINGS ===" > ci-timings
+
+  if [ -d "$CABAL_CACHE" ]; then
+      info "Extracting cabal cache from $CABAL_CACHE to $CABAL_DIR..."
+      mkdir -p "$CABAL_DIR"
+      cp -Rf "$CABAL_CACHE"/* "$CABAL_DIR"
+  fi
+
+  case $toolchain_source in
+    extracted) time_it "setup" setup_toolchain ;;
+    *) ;;
+  esac
+
+  cabal_update || fail "cabal update failed"
+
+  # Make sure that git works
+  git config user.email "ghc-ci@gitlab-haskell.org"
+  git config user.name "GHC GitLab CI"
+
+  info "====================================================="
+  info "Toolchain versions"
+  info "====================================================="
+  show_tool GHC
+  show_tool CABAL
+  show_tool HAPPY
+  show_tool ALEX
+
+  info "====================================================="
+  info "ghc --info"
+  info "====================================================="
+  $GHC --info
+}
+
+function fetch_ghc() {
+  if [ ! -e "$GHC" ]; then
+      local v="$GHC_VERSION"
+      if [[ -z "$v" ]]; then
+          fail "neither GHC nor GHC_VERSION are not set"
+      fi
+
+      start_section "fetch GHC"
+      url="https://downloads.haskell.org/~ghc/${GHC_VERSION}/ghc-${GHC_VERSION}-${boot_triple}.tar.xz"
+      info "Fetching GHC binary distribution from $url..."
+      curl "$url" > ghc.tar.xz || fail "failed to fetch GHC binary distribution"
+      $TAR -xJf ghc.tar.xz || fail "failed to extract GHC binary distribution"
+      case "$(uname)" in
+        MSYS_*|MINGW*)
+          cp -r ghc-${GHC_VERSION}*/* "$toolchain"
+          ;;
+        *)
+          pushd ghc-${GHC_VERSION}*
+          ./configure --prefix="$toolchain"
+          "$MAKE" install
+          popd
+          ;;
+      esac
+      rm -Rf "ghc-${GHC_VERSION}" ghc.tar.xz
+      end_section "fetch GHC"
+  fi
+
+}
+
+function fetch_cabal() {
+  if [ ! -e "$CABAL" ]; then
+      local v="$CABAL_INSTALL_VERSION"
+      if [[ -z "$v" ]]; then
+          fail "neither CABAL nor CABAL_INSTALL_VERSION are not set"
+      fi
+
+      start_section "fetch cabal"
+      case "$(uname)" in
+        # N.B. Windows uses zip whereas all others use .tar.xz
+        MSYS_*|MINGW*)
+          case "$MSYSTEM" in
+            CLANG64) cabal_arch="x86_64" ;;
+            *) fail "unknown MSYSTEM $MSYSTEM" ;;
+          esac
+          url="https://downloads.haskell.org/~cabal/cabal-install-$v/cabal-install-$v-$cabal_arch-windows.zip"
+          info "Fetching cabal binary distribution from $url..."
+          curl "$url" > "$TMP/cabal.zip"
+          unzip "$TMP/cabal.zip"
+          mv cabal.exe "$CABAL"
+          ;;
+        *)
+          local base_url="https://downloads.haskell.org/~cabal/cabal-install-$v/"
+          case "$(uname)" in
+            Darwin) cabal_url="$base_url/cabal-install-$v-x86_64-apple-darwin17.7.0.tar.xz" ;;
+            FreeBSD) cabal_url="$base_url/cabal-install-$v-x86_64-freebsd14.tar.xz" ;;
+            *) fail "don't know where to fetch cabal-install for $(uname)"
+          esac
+          echo "Fetching cabal-install from $cabal_url"
+          curl "$cabal_url" > cabal.tar.xz
+          tmp="$(tar -tJf cabal.tar.xz | head -n1)"
+          $TAR -xJf cabal.tar.xz
+          # Check if the bindist has directory structure
+          if [[ "$tmp" = "cabal" ]]; then
+              mv cabal "$toolchain/bin"
+          else
+              mv "$tmp/cabal" "$toolchain/bin"
+          fi
+          ;;
+      esac
+      end_section "fetch cabal"
+  fi
+}
+
+# For non-Docker platforms we prepare the bootstrap toolchain
+# here. For Docker platforms this is done in the Docker image
+# build.
+function setup_toolchain() {
+  fetch_ghc
+  fetch_cabal
+  cabal_update
+
+  local cabal_install="$CABAL v2-install \
+    --with-compiler=$GHC \
+    --index-state=$HACKAGE_INDEX_STATE \
+    --installdir=$toolchain/bin \
+    --ignore-project \
+    --overwrite-policy=always"
+
+  # Avoid symlinks on Windows
+  case "$(uname)" in
+    MSYS_*|MINGW*) cabal_install="$cabal_install --install-method=copy" ;;
+    *) ;;
+  esac
+
+  info "Building happy..."
+  $cabal_install happy --constraint="happy>=$MIN_HAPPY_VERSION"
+
+  info "Building alex..."
+  $cabal_install alex --constraint="alex>=$MIN_ALEX_VERSION"
+}
+
+function cleanup_submodules() {
+  start_section "clean submodules"
+  if [ -d .git ]; then
+    info "Cleaning submodules..."
+    # On Windows submodules can inexplicably get into funky states where git
+    # believes that the submodule is initialized yet its associated repository
+    # is not valid. Avoid failing in this case with the following insanity.
+    git submodule sync || git submodule deinit --force --all
+    git submodule update --init
+    git submodule foreach git clean -xdf
+  else
+    info "Not cleaning submodules, not in a git repo"
+  fi;
+  end_section "clean submodules"
+}
+
+function configure() {
+  case "${CONFIGURE_WRAPPER:-}" in
+    emconfigure) source "$EMSDK/emsdk_env.sh" ;;
+    *) ;;
+  esac
+
+  if [[ -z "${NO_BOOT:-}" ]]; then
+    start_section "booting"
+    run python3 boot
+    end_section "booting"
+  fi
+
+  read -r -a args <<< "${CONFIGURE_ARGS:-}"
+  if [[ -n "${target_triple:-}" ]]; then
+    args+=("--target=$target_triple")
+  fi
+  if [[ -n "${ENABLE_NUMA:-}" ]]; then
+    args+=("--enable-numa")
+    else
+    args+=("--disable-numa")
+  fi
+  if [[ -n ${HAPPY:-} ]]; then
+    args+=("HAPPY=$HAPPY")
+  fi
+  if [[ -n ${ALEX:-} ]]; then
+    args+=("ALEX=$ALEX")
+  fi
+
+  start_section "configuring"
+  # See https://stackoverflow.com/questions/7577052 for a rationale for the
+  # args[@] symbol-soup below.
+  run ${CONFIGURE_WRAPPER:-} ./configure \
+    --enable-tarballs-autodownload \
+    "${args[@]+"${args[@]}"}" \
+    GHC="$GHC" \
+    || ( cat config.log; fail "configure failed" )
+  end_section "configuring"
+}
+
+function fetch_perf_notes() {
+  info "Fetching perf notes..."
+  "$TOP/.gitlab/test-metrics.sh" pull
+}
+
+function push_perf_notes() {
+  if [[ -z "${TEST_ENV:-}" ]]; then
+    return
+  fi
+
+  # TODO: Remove this check, see #25299
+  # It is easy to forget to update this when testing a new cross platform
+  if [[ -n "${CROSS_TARGET:-}" ]] && [[ "${CROSS_TARGET:-}" != *"javascript"* ]] && [[ "${CROSS_TARGET:-}" != *"wasm"* ]]; then
+    info "Can't test cross-compiled build."
+    return
+  fi
+
+  info "Pushing perf notes..."
+  "$TOP/.gitlab/test-metrics.sh" push
+}
+
+# Figure out which commit should be used by the testsuite driver as a
+# performance baseline. See Note [The CI Story].
+function determine_metric_baseline() {
+  if [ -n "${CI_MERGE_REQUEST_DIFF_BASE_SHA:-}" ]; then
+    PERF_BASELINE_COMMIT="$CI_MERGE_REQUEST_DIFF_BASE_SHA"
+    export PERF_BASELINE_COMMIT
+    info "Using $PERF_BASELINE_COMMIT for performance metric baseline..."
+  fi
+}
+
+function check_msys2_deps() {
+  # Ensure that GHC on Windows doesn't have any dynamic dependencies on msys2
+  case "$(uname)" in
+    MSYS_*|MINGW*)
+      sysroot="$(cygpath "$SYSTEMROOT")"
+      PATH="$sysroot/System32:$sysroot;$sysroot/Wbem" $@ \
+          || fail "'$@' failed; there may be unwanted dynamic dependencies."
+      ;;
+  esac
+}
+
+# If RELEASE_JOB = yes then we skip builds with a validate flavour.
+# This has the effect of
+#  (1) Skipping validate jobs when trying to do release builds
+#  (2) Ensured we don't accidentally build release builds with validate flavour.
+#
+# We should never try to build a validate build in a release pipeline so this is
+# very defensive in case we have made a mistake somewhere.
+function check_release_build() {
+  if [ "${RELEASE_JOB:-}" == "yes" ] && [[ "${BUILD_FLAVOUR:-}" == *"validate"* ]]
+  then
+    info "Exiting build because this is a validate build in a release job"
+    exit 0;
+  fi
+}
+
+function build_hadrian() {
+  if [ -z "${BIN_DIST_NAME:-}" ]; then
+    fail "BIN_DIST_NAME not set"
+  fi
+  if [ -n "${BIN_DIST_PREP_TAR_COMP:-}" ]; then
+    fail "BIN_DIST_PREP_TAR_COMP must not be set for hadrian (you mean BIN_DIST_NAME)"
+  fi
+
+  check_release_build
+
+  # Just to be sure, use the same hackage index state when building Hadrian.
+  echo "index-state: $HACKAGE_INDEX_STATE" > hadrian/cabal.project.local
+
+  # We can safely enable parallel compression for x64. By the time
+  # hadrian calls tar/xz to produce bindist, there's no other build
+  # work taking place.
+  if [[ "${CI_JOB_NAME:-}" != *"i386"* ]]; then
+    export XZ_OPT="${XZ_OPT:-} -T$cores"
+  fi
+
+  if [[ -n "${REINSTALL_GHC:-}" ]]; then
+    run_hadrian build-cabal -V
+  else
+    case "$(uname)" in
+        MSYS_*|MINGW*)
+          run_hadrian test:all_deps reloc-binary-dist -V
+          mv _build/reloc-bindist/ghc*.tar.xz "$BIN_DIST_NAME.tar.xz"
+          ;;
+        *)
+          run_hadrian test:all_deps binary-dist -V
+          mv _build/bindist/ghc*.tar.xz "$BIN_DIST_NAME.tar.xz"
+          ;;
+    esac
+  fi
+
+}
+
+# run's `make DESTDIR=$1 install` and then
+# merges the file tree to the actual destination $2,
+# ensuring that `DESTDIR` is properly honoured by the
+# build system
+function make_install_destdir() {
+  local destdir=$1
+  local instdir=$2
+
+  mkdir -p "$destdir"
+  mkdir -p "$instdir"
+  run "$MAKE" DESTDIR="$destdir" install || fail "make install failed"
+  # check for empty dir portably
+  # https://superuser.com/a/667100
+  if find "$instdir" -mindepth 1 -maxdepth 1 | read; then
+    fail "$instdir is not empty!"
+  fi
+  info "merging file tree from $destdir to $instdir"
+  cp -a "$destdir/$instdir"/* "$instdir"/
+  "$instdir"/bin/${cross_prefix}ghc-pkg recache
+}
+
+# install the binary distribution in directory $1 to $2.
+function install_bindist() {
+  case "${CONFIGURE_WRAPPER:-}" in
+    emconfigure) source "$EMSDK/emsdk_env.sh" ;;
+    *) ;;
+  esac
+
+  local bindist="$1"
+  local instdir="$2"
+  pushd "$bindist"
+  case "$(uname)" in
+    MSYS_*|MINGW*)
+      mkdir -p "$instdir"
+      cp -a * "$instdir"
+      ;;
+    *)
+      read -r -a args <<< "${INSTALL_CONFIGURE_ARGS:-}"
+
+      # FIXME: The bindist configure script shouldn't need to be reminded of
+      # the target platform. See #21970.
+      if [ -n "${CROSS_TARGET:-}" ]; then
+          args+=( "--target=$CROSS_TARGET" "--host=$CROSS_TARGET" )
+      fi
+
+      run ${CONFIGURE_WRAPPER:-} ./configure \
+          --prefix="$instdir" \
+          "${args[@]+"${args[@]}"}" || fail "bindist configure failed"
+      make_install_destdir "$TOP"/destdir "$instdir"
+      # And check the `--info` of the installed compiler, sometimes useful in CI log.
+      "$instdir"/bin/ghc --info
+      ;;
+  esac
+  popd
+}
+
+function test_hadrian() {
+  check_msys2_deps _build/stage1/bin/ghc --version
+  check_release_build
+
+  # Ensure that statically-linked builds are actually static
+  if [[ "${BUILD_FLAVOUR}" = *static* ]]; then
+    bad_execs=""
+    for binary in _build/stage1/bin/*; do
+      if ldd "${binary}" &> /dev/null; then
+        warn "${binary} is not static!"
+        ldd "${binary}"
+        echo
+        bad_execs="$bad_execs $binary"
+      fi
+    done
+    if [ -n "$bad_execs" ]; then
+      fail "the following executables contain dynamic-object references: $bad_execs"
+    fi
+  fi
+
+
+  if [[ "${CROSS_EMULATOR:-}" == "NOT_SET" ]]; then
+    info "Cannot test cross-compiled build without CROSS_EMULATOR being set."
+    return
+    # special case for JS backend
+  elif [ -n "${CROSS_TARGET:-}" ] && [ "${CROSS_EMULATOR:-}" == "js-emulator" ]; then
+    # The JS backend doesn't support CROSS_EMULATOR logic yet
+    unset CROSS_EMULATOR
+    # run "hadrian test" directly, not using the bindist, even though it did get installed.
+    # This is a temporary solution, See !9515 for the status of hadrian support.
+    run_hadrian \
+      test \
+      --summary-junit=./junit.xml \
+      --test-have-intree-files    \
+      --docs=none                 \
+      "runtest.opts+=${RUNTEST_ARGS:-}" \
+      "runtest.opts+=--unexpected-output-dir=$TOP/unexpected-test-output" \
+      || fail "cross-compiled hadrian main testsuite"
+  elif [[ -n "${CROSS_TARGET:-}" ]] && [[ "${CROSS_TARGET:-}" == *"wasm"* ]]; then
+    run_hadrian \
+      test \
+      --summary-junit=./junit.xml \
+      "runtest.opts+=${RUNTEST_ARGS:-}" \
+      "runtest.opts+=--unexpected-output-dir=$TOP/unexpected-test-output" \
+      || fail "hadrian main testsuite targetting $CROSS_TARGET"
+  elif [ -n "${CROSS_TARGET:-}" ]; then
+    local instdir="$TOP/_build/install"
+    local test_compiler="$instdir/bin/${cross_prefix}ghc$exe"
+    install_bindist _build/bindist/ghc-*/ "$instdir"
+    echo 'main = putStrLn "hello world"' > expected
+    run "$test_compiler" -package ghc "$TOP/.gitlab/hello.hs" -o hello
+    ${CROSS_EMULATOR:-} ./hello > actual
+    run diff expected actual
+  elif [[ -n "${REINSTALL_GHC:-}" ]]; then
+    run_hadrian \
+      test \
+      --test-root-dirs=testsuite/tests/stage1 \
+      --test-compiler=stage-cabal \
+      --test-root-dirs=testsuite/tests/perf \
+      --test-root-dirs=testsuite/tests/typecheck \
+      "runtest.opts+=${RUNTEST_ARGS:-}" \
+      "runtest.opts+=--unexpected-output-dir=$TOP/unexpected-test-output" \
+      || fail "hadrian cabal-install test"
+  else
+    local instdir="$TOP/_build/install"
+    local test_compiler="$instdir/bin/${cross_prefix}ghc$exe"
+    install_bindist _build/bindist/ghc-*/ "$instdir"
+
+    if [[ "${WINDOWS_HOST}" == "no" ]] && [ -z "${CROSS_TARGET:-}" ]
+    then
+      run_hadrian \
+        test \
+        --test-root-dirs=testsuite/tests/stage1 \
+        --test-compiler=stage1 \
+        "runtest.opts+=${RUNTEST_ARGS:-}" || fail "hadrian stage1 test"
+      info "STAGE1_TEST=$?"
+    fi
+
+    # Ensure the resulting compiler has the correct bignum-flavour,
+    # except for cross-compilers as they may not support the interpreter
+    if [ -z "${CROSS_TARGET:-}" ]
+    then
+      test_compiler_backend=$(${test_compiler} -e "GHC.Num.Backend.backendName")
+      if [ $test_compiler_backend != "\"$BIGNUM_BACKEND\"" ]; then
+        fail "Test compiler has a different BIGNUM_BACKEND ($test_compiler_backend) than requested ($BIGNUM_BACKEND)"
+      fi
+    fi
+
+    # If we are doing a release job, check the compiler can build a profiled executable
+    if [ "${RELEASE_JOB:-}" == "yes" ]; then
+      echo "main = print ()" > proftest.hs
+      run ${test_compiler} -prof proftest.hs || fail "hadrian profiled libs test"
+      rm proftest.hs
+    fi
+
+    run_hadrian \
+      test \
+      --summary-junit=./junit.xml \
+      --test-have-intree-files \
+      --test-compiler="${test_compiler}" \
+      "runtest.opts+=${RUNTEST_ARGS:-}" \
+      "runtest.opts+=--unexpected-output-dir=$TOP/unexpected-test-output" \
+      || fail "hadrian main testsuite"
+
+    info "STAGE2_TEST=$?"
+
+  fi
+}
+
+function summarise_hi_files() {
+  hi_files=$(find . -type f -name "*.hi" | sort)
+  for iface in $hi_files; do echo "$iface  $($HC --show-iface "$iface" | grep "  ABI hash:")"; done | tee $OUT/abis
+  for iface in $hi_files; do echo "$iface  $($HC --show-iface "$iface" | grep "  interface hash:")"; done | tee $OUT/interfaces
+  for iface in $hi_files; do
+      fname="$OUT/$(dirname "$iface")"
+      mkdir -p "$fname"
+      $HC --show-iface "$iface" > "$OUT/$iface"
+  done
+}
+
+function summarise_o_files() {
+  OBJDUMP=$(if test "$(uname)" == "Darwin"; then echo "objdump -m"; else echo "objdump"; fi)
+  o_files=$(find . -type f -name "*.o" | sort)
+  for o in $o_files; do
+      fname="$OUT/objs/$(dirname "$o")"
+      mkdir -p "$fname"
+      # To later compare object dumps except for the first line which prints the file path
+      $OBJDUMP --all-headers "$o" | tail -n+2 > "$OUT/objs/$o.all-headers"
+      $OBJDUMP --disassemble-all "$o" | tail -n+2 > "$OUT/objs/$o.disassemble-all"
+  done
+}
+
+function cabal_abi_test() {
+  if [ -z "$OUT" ]; then
+    fail "OUT not set"
+  fi
+
+  cp -r libraries/Cabal $DIR
+  pushd $DIR
+  echo $PWD
+
+  start_section "Cabal test: $OUT"
+  mkdir -p "$OUT"
+  "$HC" \
+    -hidir tmp -odir tmp -fforce-recomp -haddock \
+    -iCabal/Cabal/src -XNoPolyKinds Distribution.Simple -j"$cores" \
+    -fobject-determinism \
+    "$@" 2>&1 | sed '1d' | tee $OUT/log
+  summarise_hi_files
+  summarise_o_files
+  popd
+  end_section "Cabal test: $OUT"
+}
+
+function cabal_test() {
+  if [ -z "$OUT" ]; then
+    fail "OUT not set"
+  fi
+
+  start_section "Cabal test: $OUT"
+  mkdir -p "$OUT"
+  run "$HC" \
+    -hidir tmp -odir tmp -fforce-recomp \
+    -dumpdir "$OUT/dumps" -ddump-timings \
+    +RTS --machine-readable "-t$OUT/rts.log" -RTS \
+    -ilibraries/Cabal/Cabal/src -XNoPolyKinds Distribution.Simple \
+    "$@" 2>&1 | tee $OUT/log
+  rm -Rf tmp
+  end_section "Cabal test: $OUT"
+}
+
+function run_perf_test() {
+  if [ -z "$HC" ]; then
+    fail "HC not set"
+  fi
+
+  mkdir -p out
+  git -C libraries/Cabal/ rev-parse HEAD > out/cabal_commit
+  $HC --print-project-git-commit-id > out/ghc_commit
+  OUT=out/Cabal-O0 cabal_test -O0
+  OUT=out/Cabal-O1 cabal_test -O1
+  OUT=out/Cabal-O2 cabal_test -O2
+}
+
+function check_interfaces(){
+  difference=$(diff "$1/$3" "$2/$3") || warn "diff failed"
+  if [ -z "$difference" ]
+   then
+      info "$1 and $2 $3 match"
+   else
+     echo $difference
+     for line in $(echo "$difference" | tr ' ' '\n' | grep ".hi" | sort | uniq); do
+       diff "$1/$line" "$2/$line"
+     done
+     fail "$4"
+  fi
+}
+
+function check_objects(){
+
+  # Big fast check
+  if diff -r "$1" "$2"
+  then
+    echo "Objects are the same"
+  else
+    echo "--------------------------------------------------------------------------------"
+    echo "Comparing all objects (1. headers, 2. disassembly). Stopping at first failure..."
+    echo "--------------------------------------------------------------------------------"
+
+    pushd "$1" >/dev/null
+    OBJ_DUMPS=$(find . -type f -name "*.all-headers" -or -name "*.disassemble-all")
+    popd >/dev/null
+
+    for dump in $OBJ_DUMPS
+    do
+      if diff "$1/$dump" "$2/$dump"
+      then
+        fail "Mismatched object: $dump"
+      fi
+    done
+
+    fail "Some objects are mismatched, but theres no diff with --all-headers or --disassemble-all. Perhaps try objdump -s"
+  fi
+
+}
+
+function abi_test() {
+  for i in {1..10}; do info "iteration $i"; run_abi_test; done
+}
+
+function run_abi_test() {
+  if [ -z "$HC" ]; then
+    fail "HC not set"
+  fi
+  mkdir -p out
+  OUT="$PWD/out/run1" DIR=$(mktemp -d XXXX-looooooooong) cabal_abi_test -O1 -haddock
+  # Count uniques in reverse one of the runs to get more non-determinism exposed
+  OUT="$PWD/out/run2" DIR=$(mktemp -d XXXX-short) cabal_abi_test -O1 -haddock -dunique-increment=-1 -dinitial-unique=16777215
+  check_interfaces out/run1 out/run2 abis "Mismatched ABI hash"
+  check_interfaces out/run1 out/run2 interfaces "Mismatched interface hashes"
+  check_objects out/run1 out/run2
+}
+
+function save_test_output() {
+    tar -czf unexpected-test-output.tar.gz unexpected-test-output
+}
+
+function save_cache () {
+  info "Storing cabal cache from $CABAL_DIR to $CABAL_CACHE..."
+  rm -Rf "$CABAL_CACHE"
+  cp -Rf "$CABAL_DIR" "$CABAL_CACHE"
+}
+
+function clean() {
+  rm -R tmp
+  run rm -Rf _build
+}
+
+function run_hadrian() {
+  if [ -z "${BUILD_FLAVOUR:-}" ]; then
+    fail "BUILD_FLAVOUR not set"
+  fi
+  read -r -a args <<< "${HADRIAN_ARGS:-}"
+  if [ -n "${VERBOSE:-}" ]; then args+=("-V"); fi
+  # Before running the compiler, unset variables gitlab env vars as these
+  # can destabilise the performance test (see #20341)
+  (unset $(compgen -v | grep CI_*);
+    run "${HADRIAN_PATH:-hadrian/build-cabal}" \
+      --flavour="$BUILD_FLAVOUR" \
+      -j"$cores" \
+      --broken-test="${BROKEN_TESTS:-}" \
+      --bignum=$BIGNUM_BACKEND \
+      "${args[@]+"${args[@]}"}" \
+      "$@")
+}
+
+# A convenience function to allow debugging in the CI environment.
+function shell() {
+  local cmd="${@: 1}"
+  if [ -z "$cmd" ]; then
+    cmd="bash -i"
+  fi
+  run $cmd
+}
+
+function lint_author(){
+  base=$1
+  head=$2
+  for email in $(git log --format='%ae' $base..$head); do
+    if [ $email == "ghc-ci@gitlab-haskell.org" ];
+    then
+      fail "Commit has GHC CI author, please amend the author information."
+    fi
+  done
+}
+
+function abi_of(){
+  DIR=$(realpath $1)
+  mkdir -p "$OUT"
+  pushd $DIR
+  summarise_hi_files
+  popd
+}
+
+# Checks that the interfaces in folder $1 match the interfaces in folder $2
+function compare_interfaces_of(){
+  OUT=$PWD/out/run1 abi_of $1
+  OUT=$PWD/out/run2 abi_of $2
+  check_interfaces out/run1 out/run2 abis "Mismatched ABI hash"
+  check_interfaces out/run1 out/run2 interfaces "Mismatched interface hashes"
+}
+
+
+setup_locale
+
+# Platform-specific environment initialization
+if [ -n "${HERMETIC:-}" ]; then
+  export CABAL_DIR="$TOP/cabal"
+  # We previously set HOME=/nonexistent but apparently nix wants $HOME to exist
+  # so sadly we must settle for someplace writable.
+  export HOME="$TOP/tmp-home"
+else
+  BIN_DIST_NAME="${BIN_DIST_NAME:-}"
+  case "$(uname)" in
+    MSYS_*|MINGW*) CABAL_DIR="$APPDATA/cabal" ;;
+    *) CABAL_DIR="$HOME/.cabal" ;;
+  esac
+fi
+
+case "$(uname)" in
+  MSYS_*|MINGW*)
+    exe=".exe"
+    # N.B. cabal-install expects CABAL_DIR to be a Windows path
+    CABAL_DIR="$(cygpath -w "$CABAL_DIR")"
+    WINDOWS_HOST="yes"
+    ;;
+  *)
+    exe=""
+    WINDOWS_HOST="no"
+    ;;
+esac
+
+MAKE="make"
+TAR="tar"
+case "$(uname)" in
+  MSYS_*|MINGW*) mingw_init ;;
+  Darwin) boot_triple="x86_64-apple-darwin" ;;
+  FreeBSD)
+    boot_triple="x86_64-portbld-freebsd"
+    MAKE="gmake"
+    TAR="gtar"
+    ;;
+  Linux) ;;
+  *) fail "uname $(uname) is not supported" ;;
+esac
+
+if [ -n "${CROSS_TARGET:-}" ]; then
+  info "Cross-compiling for $CROSS_TARGET..."
+  target_triple="$CROSS_TARGET"
+  cross_prefix="$target_triple-"
+else
+  cross_prefix=""
+fi
+
+echo "Branch name ${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME:-}"
+# Ignore performance improvements in @marge-bot batches.
+# See #19562.
+if [ "${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME:-}" == "wip/marge_bot_batch_merge_job" ]; then
+  if [ -z "${IGNORE_PERF_FAILURES:-}" ]; then
+    IGNORE_PERF_FAILURES="decreases"
+    echo "Ignoring perf failures"
+  fi
+fi
+echo "CI_COMMIT_BRANCH: ${CI_COMMIT_BRANCH:-}"
+echo "CI_PROJECT_PATH: ${CI_PROJECT_PATH:-}"
+if [ "${CI_COMMIT_BRANCH:-}" == "master" ] &&  [ "${CI_PROJECT_PATH:-}" == "ghc/ghc" ]; then
+  if [ -z "${IGNORE_PERF_FAILURES:-}" ]; then
+    IGNORE_PERF_FAILURES="decreases"
+    echo "Ignoring perf failures"
+  fi
+fi
+if [ -n "${IGNORE_PERF_FAILURES:-}" ]; then
+  RUNTEST_ARGS=( "${RUNTEST_ARGS[@]:-}" "--ignore-perf-failures=$IGNORE_PERF_FAILURES" )
+fi
+
+if [[ -z ${BIGNUM_BACKEND:-} ]]; then BIGNUM_BACKEND=gmp; fi
+
+determine_metric_baseline
+
+set_toolchain_paths
+
+case ${1:-help} in
+  help|usage) usage ;;
+  setup) setup && cleanup_submodules ;;
+  configure) time_it "configure" configure ;;
+  build_hadrian) time_it "build" build_hadrian ;;
+  # N.B. Always push notes, even if the build fails. This is okay to do as the
+  # testsuite driver doesn't record notes for tests that fail due to
+  # correctness.
+  test_hadrian)
+    fetch_perf_notes
+    res=0
+    time_it "test" test_hadrian || res=$?
+    push_perf_notes
+    exit $res ;;
+  run_hadrian) shift; run_hadrian "$@" ;;
+  perf_test) run_perf_test ;;
+  abi_test) abi_test ;;
+  cabal_test) cabal_test ;;
+  lint_author) shift; lint_author "$@" ;;
+  compare_interfaces_of) shift; compare_interfaces_of "$@" ;;
+  clean) clean ;;
+  save_test_output) save_test_output ;;
+  save_cache) save_cache ;;
+  shell) shift; shell "$@" ;;
+  *) fail "unknown mode $1" ;;
+esac

.gitlab/circle-ci-job.sh

-# Circle CI "backend" for Gitlab CI
-# =================================
-#
-# Usage example:
-#   .gitlab/circle-ci-job.sh validate-x86_64-linux
-#
-# There are two things to configure to get artifacts to be
-# uploaded to gitlab properly:
-#
-# - At https://<gitlab host>/admin/application_settings, expand the
-#   Continuous Integration and Deployment section and set the
-#   "Maximum artifacts size (MB)" field to something large enough
-#   to contain the bindists (the test reports are tiny in comparison).
-#   500MB seems to work fine, but 200MB might be sufficient.
-#
-# - If gitlab is exposed behind some form of proxy (e.g nginx), make sure
-#   the maximum client request body size is large enough to contain all the
-#   artifacts of a build. For nginx, this would be the following configuration
-#   option: https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size
-#   (which can be set with services.nginx.clientMaxBodySize on nixos).
-
-#!/usr/bin/env sh
-
-set -e
-
-GHCCI_URL="localhost:8888"
-
-[ $# -gt 0 ] || (echo You need to pass the Circle CI job type as argument to this script; exit 1)
-[ ${CI_RUNNER_ID:-} ] || (echo "CI_RUNNER_ID is not set"; exit 1)
-[ ${CI_JOB_ID:-} ] || (echo "CI_JOB_ID is not set"; exit 1)
-[ ${CI_COMMIT_SHA:-} ] || (echo "CI_COMMIT_SHA is not set"; exit 1)
-[ ${CI_REPOSITORY_URL:-} ] || (echo "CI_REPOSITORY_URL is not set"; exit 1)
-[ ${CI_PIPELINE_ID:-} ] || (echo "CI_PIPELINE_ID is not set"; exit 1)
-# the first argument to this script is the Circle CI job type:
-# validate-x86_64-linux, validate-i386-linux, ...
-CIRCLE_JOB="circleci-$1"
-
-gitlab_user=$(echo $CI_REPOSITORY_URL | cut -d/ -f4)
-gitlab_repo=$(echo $CI_REPOSITORY_URL | cut -d/ -f5 | cut -d. -f1)
-
-BODY="{ \"jobType\": \"$CIRCLE_JOB\", \"source\": { \"user\": \"$gitlab_user\", \"project\":\"$gitlab_repo\", \"commit\":\"$CI_COMMIT_SHA\" }, \"pipelineID\": $CI_PIPELINE_ID, \"runnerID\": $CI_RUNNER_ID, \"jobID\": $CI_JOB_ID }"
-
-
-RESP=$(curl -s -XPOST -H "Content-Type: application/json" -d "$BODY" \
-	    http://${GHCCI_URL}/job)
-
-if [ $? -eq 0 ]; then
-    build_num=$(echo $RESP | jq '.build_num')
-    circle_url=$(echo $RESP | jq '.url')
-else
-    echo "Couldn't submit job"
-    echo $RESP
-    exit 1
-fi
-
-echo Circle CI build number: $build_num
-echo Circle CI build page: $circle_url
-
-outcome="null"
-STATUS_URL="http://${GHCCI_URL}/job/${build_num}"
-STATUS_RESP=""
-
-while [ "$outcome" == "null" ]; do
-    sleep 30s
-    STATUS_RESP=$(curl -s $STATUS_URL)
-    if [ $? -eq 0 ]; then
-	new_outcome=$(echo $STATUS_RESP | jq '.outcome')
-	jq_exitcode=$?
-	if [ "$new_outcome" == "null" ] && [ $jq_exitcode -ne 0 ]; then
-	    echo "Couldn't read 'outcome' field in JSON:"
-	    echo $STATUS_RESP
-	    echo "Skipping"
-	else
-	    outcome="$new_outcome"
-	fi
-    else
-	echo "curl failed:"
-	echo $STATUS_RESP
-	echo "Skipping"
-    fi
-done
-
-if [ "$outcome" == "\"success\"" ]; then
-    echo The build passed
-    artifactsBody=$(curl -s http://${GHCCI_URL}/job/${build_num}/artifacts)
-    (echo $artifactsBody | jq '.[] | .url' | xargs wget -q) || echo "No artifacts"
-    exit 0
-else
-    echo The build failed
-
-    artifactsBody=$(curl -s http://${GHCCI_URL}/job/${build_num}/artifacts)
-    (echo $artifactsBody | jq '.[] | .url' | xargs wget -q) || echo "No artifacts"
-
-    failing_step=$(echo $STATUS_RESP | jq '.steps | .[] | .actions | .[] | select(.status != "success")')
-    failing_step_name=$(echo $failing_step | jq '.name' | sed -e 's/^"//' -e 's/"$//' -e 's/\\r\\n/\n/')
-    echo "Failing step: $failing_step_name"
-
-    failing_cmds=$(echo $failing_step | jq '.bash_command' | sed -e 's/^"//' -e 's/"$//' -e 's/\\r\\n/\n/')
-    echo "Failing command(s):"
-    echo $failing_cmds
-
-    log_url=$(echo $failing_step | jq '.output_url' | sed -e 's/^"//' -e 's/"$//' -e 's/\\r\\n/\n/')
-    echo "Log url: $log_url"
-
-    last_log_lines=$(curl -s $log_url | gunzip | jq '.[] | select(.type == "out") | .message' | sed -e 's/^"//' -e 's/"$//' -e 's/\\r\\n/\n/' | tail -50)
-    echo End of the build log:
-    echo $last_log_lines
-
-    exit 1
-fi

.gitlab/common.sh

+# Common bash utilities
+# ----------------------
+
+# Colors
+BLACK="0;30"
+GRAY="1;30"
+RED="0;31"
+LT_RED="1;31"
+BROWN="0;33"
+LT_BROWN="1;33"
+GREEN="0;32"
+LT_GREEN="1;32"
+BLUE="0;34"
+LT_BLUE="1;34"
+PURPLE="0;35"
+LT_PURPLE="1;35"
+CYAN="0;36"
+LT_CYAN="1;36"
+WHITE="1;37"
+LT_GRAY="0;37"
+
+# GitLab Pipelines log section delimiters
+# https://gitlab.com/gitlab-org/gitlab-foss/issues/14664
+start_section() {
+  name="$1"
+  echo -e "section_start:$(date +%s):$name\015\033[0K"
+}
+
+end_section() {
+  name="$1"
+  echo -e "section_end:$(date +%s):$name\015\033[0K"
+}
+
+echo_color() {
+  local color="$1"
+  local msg="$2"
+  echo -e "\033[${color}m${msg}\033[0m"
+}
+
+error() { echo_color "${RED}" "$1"; }
+warn() { echo_color "${LT_BROWN}" "$1"; }
+info() { echo_color "${LT_BLUE}" "$1"; }
+
+fail() { error "error: $1"; exit 1; }
+
+function run() {
+  info "Running $*..."
+  "$@" || ( error "$* failed"; return 1; )
+}
+

.gitlab/darwin-init.sh

-#!/bin/bash
-
-set -e
-
-toolchain=`pwd`/toolchain
-PATH="$toolchain/bin:$PATH"
-
-if [ -d "`pwd`/cabal-cache" ]; then
-    cp -Rf cabal-cache $HOME/.cabal
-fi
-
-if [ ! -e $toolchain/bin/ghc ]; then
-    mkdir -p tmp
-    cd tmp
-    ghc_tarball="https://downloads.haskell.org/~ghc/$GHC_VERSION/ghc-$GHC_VERSION-x86_64-apple-darwin.tar.xz"
-    echo "Fetching GHC from $ghc_tarball"
-    curl $ghc_tarball | tar -xJ
-    cd ghc-$GHC_VERSION
-    ./configure --prefix=$toolchain
-    make install
-    cd ../..
-    rm -Rf tmp
-fi
-
-if [ ! -e $toolchain/bin/cabal ]; then
-    cabal_tarball="https://downloads.haskell.org/~cabal/cabal-install-latest/cabal-install-2.4.1.0-x86_64-apple-darwin-sierra.tar.xz"
-    echo "Fetching cabal-install from $cabal_tarball"
-    curl $cabal_tarball | tar -xz
-    mv cabal $toolchain/bin
-fi
-
-if [ ! -e $toolchain/bin/happy ]; then
-    cabal update
-    cabal new-install happy --symlink-bindir=$toolchain/bin
-fi
-
-if [ ! -e $toolchain/bin/alex ]; then
-    cabal update
-    cabal new-install alex --symlink-bindir=$toolchain/bin
-fi
-

.gitlab/darwin/nix/sources.json

+{
+    "niv": {
+        "branch": "master",
+        "description": "Easy dependency management for Nix projects",
+        "homepage": "https://github.com/nmattia/niv",
+        "owner": "nmattia",
+        "repo": "niv",
+        "rev": "e0ca65c81a2d7a4d82a189f1e23a48d59ad42070",
+        "sha256": "1pq9nh1d8nn3xvbdny8fafzw87mj7gsmp6pxkdl65w2g18rmcmzx",
+        "type": "tarball",
+        "url": "https://github.com/nmattia/niv/archive/e0ca65c81a2d7a4d82a189f1e23a48d59ad42070.tar.gz",
+        "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
+    },
+    "nixpkgs": {
+        "branch": "nixos-unstable",
+        "description": "Nix Packages collection",
+        "homepage": "",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "2893f56de08021cffd9b6b6dfc70fd9ccd51eb60",
+        "sha256": "1anwxmjpm21msnnlrjdz19w31bxnbpn4kgf93sn3npihi7wf4a8h",
+        "type": "tarball",
+        "url": "https://github.com/nixos/nixpkgs/archive/2893f56de08021cffd9b6b6dfc70fd9ccd51eb60.tar.gz",
+        "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
+    }
+}

.gitlab/darwin/nix/sources.nix

+# This file has been generated by Niv.
+
+let
+
+  #
+  # The fetchers. fetch_<type> fetches specs of type <type>.
+  #
+
+  fetch_file = pkgs: name: spec:
+    let
+      name' = sanitizeName name + "-src";
+    in
+      if spec.builtin or true then
+        builtins_fetchurl { inherit (spec) url sha256; name = name'; }
+      else
+        pkgs.fetchurl { inherit (spec) url sha256; name = name'; };
+
+  fetch_tarball = pkgs: name: spec:
+    let
+      name' = sanitizeName name + "-src";
+    in
+      if spec.builtin or true then
+        builtins_fetchTarball { name = name'; inherit (spec) url sha256; }
+      else
+        pkgs.fetchzip { name = name'; inherit (spec) url sha256; };
+
+  fetch_git = name: spec:
+    let
+      ref =
+        if spec ? ref then spec.ref else
+          if spec ? branch then "refs/heads/${spec.branch}" else
+            if spec ? tag then "refs/tags/${spec.tag}" else
+              abort "In git source '${name}': Please specify `ref`, `tag` or `branch`!";
+    in
+      builtins.fetchGit { url = spec.repo; inherit (spec) rev; inherit ref; };
+
+  fetch_local = spec: spec.path;
+
+  fetch_builtin-tarball = name: throw
+    ''[${name}] The niv type "builtin-tarball" is deprecated. You should instead use `builtin = true`.
+        $ niv modify ${name} -a type=tarball -a builtin=true'';
+
+  fetch_builtin-url = name: throw
+    ''[${name}] The niv type "builtin-url" will soon be deprecated. You should instead use `builtin = true`.
+        $ niv modify ${name} -a type=file -a builtin=true'';
+
+  #
+  # Various helpers
+  #
+
+  # https://github.com/NixOS/nixpkgs/pull/83241/files#diff-c6f540a4f3bfa4b0e8b6bafd4cd54e8bR695
+  sanitizeName = name:
+    (
+      concatMapStrings (s: if builtins.isList s then "-" else s)
+        (
+          builtins.split "[^[:alnum:]+._?=-]+"
+            ((x: builtins.elemAt (builtins.match "\\.*(.*)" x) 0) name)
+        )
+    );
+
+  # The set of packages used when specs are fetched using non-builtins.
+  mkPkgs = sources: system:
+    let
+      sourcesNixpkgs =
+        import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) { inherit system; };
+      hasNixpkgsPath = builtins.any (x: x.prefix == "nixpkgs") builtins.nixPath;
+      hasThisAsNixpkgsPath = <nixpkgs> == ./.;
+    in
+      if builtins.hasAttr "nixpkgs" sources
+      then sourcesNixpkgs
+      else if hasNixpkgsPath && ! hasThisAsNixpkgsPath then
+        import <nixpkgs> {}
+      else
+        abort
+          ''
+            Please specify either <nixpkgs> (through -I or NIX_PATH=nixpkgs=...) or
+            add a package called "nixpkgs" to your sources.json.
+          '';
+
+  # The actual fetching function.
+  fetch = pkgs: name: spec:
+
+    if ! builtins.hasAttr "type" spec then
+      abort "ERROR: niv spec ${name} does not have a 'type' attribute"
+    else if spec.type == "file" then fetch_file pkgs name spec
+    else if spec.type == "tarball" then fetch_tarball pkgs name spec
+    else if spec.type == "git" then fetch_git name spec
+    else if spec.type == "local" then fetch_local spec
+    else if spec.type == "builtin-tarball" then fetch_builtin-tarball name
+    else if spec.type == "builtin-url" then fetch_builtin-url name
+    else
+      abort "ERROR: niv spec ${name} has unknown type ${builtins.toJSON spec.type}";
+
+  # If the environment variable NIV_OVERRIDE_${name} is set, then use
+  # the path directly as opposed to the fetched source.
+  replace = name: drv:
+    let
+      saneName = stringAsChars (c: if isNull (builtins.match "[a-zA-Z0-9]" c) then "_" else c) name;
+      ersatz = builtins.getEnv "NIV_OVERRIDE_${saneName}";
+    in
+      if ersatz == "" then drv else
+        # this turns the string into an actual Nix path (for both absolute and
+        # relative paths)
+        if builtins.substring 0 1 ersatz == "/" then /. + ersatz else /. + builtins.getEnv "PWD" + "/${ersatz}";
+
+  # Ports of functions for older nix versions
+
+  # a Nix version of mapAttrs if the built-in doesn't exist
+  mapAttrs = builtins.mapAttrs or (
+    f: set: with builtins;
+    listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set))
+  );
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/lists.nix#L295
+  range = first: last: if first > last then [] else builtins.genList (n: first + n) (last - first + 1);
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L257
+  stringToCharacters = s: map (p: builtins.substring p 1 s) (range 0 (builtins.stringLength s - 1));
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L269
+  stringAsChars = f: s: concatStrings (map f (stringToCharacters s));
+  concatMapStrings = f: list: concatStrings (map f list);
+  concatStrings = builtins.concatStringsSep "";
+
+  # https://github.com/NixOS/nixpkgs/blob/8a9f58a375c401b96da862d969f66429def1d118/lib/attrsets.nix#L331
+  optionalAttrs = cond: as: if cond then as else {};
+
+  # fetchTarball version that is compatible between all the versions of Nix
+  builtins_fetchTarball = { url, name ? null, sha256 }@attrs:
+    let
+      inherit (builtins) lessThan nixVersion fetchTarball;
+    in
+      if lessThan nixVersion "1.12" then
+        fetchTarball ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; }))
+      else
+        fetchTarball attrs;
+
+  # fetchurl version that is compatible between all the versions of Nix
+  builtins_fetchurl = { url, name ? null, sha256 }@attrs:
+    let
+      inherit (builtins) lessThan nixVersion fetchurl;
+    in
+      if lessThan nixVersion "1.12" then
+        fetchurl ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; }))
+      else
+        fetchurl attrs;
+
+  # Create the final "sources" from the config
+  mkSources = config:
+    mapAttrs (
+      name: spec:
+        if builtins.hasAttr "outPath" spec
+        then abort
+          "The values in sources.json should not have an 'outPath' attribute"
+        else
+          spec // { outPath = replace name (fetch config.pkgs name spec); }
+    ) config.sources;
+
+  # The "config" used by the fetchers
+  mkConfig =
+    { sourcesFile ? if builtins.pathExists ./sources.json then ./sources.json else null
+    , sources ? if isNull sourcesFile then {} else builtins.fromJSON (builtins.readFile sourcesFile)
+    , system ? builtins.currentSystem
+    , pkgs ? mkPkgs sources system
+    }: rec {
+      # The sources, i.e. the attribute set of spec name to spec
+      inherit sources;
+
+      # The "pkgs" (evaluated nixpkgs) to use for e.g. non-builtin fetchers
+      inherit pkgs;
+    };
+
+in
+mkSources (mkConfig {}) // { __functor = _: settings: mkSources (mkConfig settings); }

.gitlab/darwin/toolchain.nix

+{ system }:
+
+let
+  sources = import ./nix/sources.nix;
+  nixpkgsSrc = sources.nixpkgs;
+  pkgs = import nixpkgsSrc { inherit system; };
+  hostPkgs = import nixpkgsSrc { };
+in
+
+let
+  hsPkgs = pkgs.haskellPackages;
+  alex = hsPkgs.alex;
+  happy = hsPkgs.happy;
+  targetTriple = pkgs.stdenv.targetPlatform.config;
+
+  ghcBindists = let version = ghc.version; in {
+    aarch64-darwin = hostPkgs.fetchurl {
+      url = "https://downloads.haskell.org/ghc/${version}/ghc-${version}-aarch64-apple-darwin.tar.xz";
+      sha256 = "sha256-c1GTMJf3/yiW/t4QL532EswD5JVlgA4getkfsxj4TaA=";
+    };
+    x86_64-darwin = hostPkgs.fetchurl {
+      url = "https://downloads.haskell.org/ghc/${version}/ghc-${version}-x86_64-apple-darwin.tar.xz";
+      sha256 = "sha256-LrYniMG0phsvyW6dhQC+3ompvzcxnwAe6GezEqqzoTQ=";
+    };
+
+  };
+
+  ghc = pkgs.stdenv.mkDerivation rec {
+    # Using 9.6.2 because of #24050
+    version = "9.6.2";
+    name = "ghc";
+    src = ghcBindists.${pkgs.stdenv.hostPlatform.system};
+    configureFlags = [
+      "CC=/usr/bin/clang"
+      "CLANG=/usr/bin/clang"
+      "AR=/usr/bin/ar"
+      "LLC=${llvm}/bin/llc"
+      "OPT=${llvm}/bin/opt"
+      "LLVMAS=${llvm_clang}/bin/clang"
+      "CONF_CC_OPTS_STAGE2=--target=${targetTriple}"
+      "CONF_CXX_OPTS_STAGE2=--target=${targetTriple}"
+      "CONF_GCC_LINKER_OPTS_STAGE2=--target=${targetTriple}"
+    ];
+    buildPhase = "true";
+
+    # This is a horrible hack because the configure script invokes /usr/bin/clang
+    # without a `--target` flag. Then depending on whether the `nix` binary itself is
+    # a native x86 or arm64 binary means that /usr/bin/clang thinks it needs to run in
+    # x86 or arm64 mode.
+
+    # The correct answer for the check in question is the first one we try, so by replacing
+    # the condition to true; we select the right C++ standard library still.
+    preConfigure = ''
+      sed "s/\"\$CC\" -o actest actest.o \''${1} 2>\/dev\/null/true/i" configure > configure.new
+      mv configure.new configure
+      chmod +x configure
+      cat configure
+
+    '';
+
+    # N.B. Work around #20253.
+    nativeBuildInputs = [ pkgs.gnused ];
+    postInstallPhase = ''
+      settings="$out/lib/ghc-${version}/settings"
+      sed -i -e "s%\"llc\"%\"${llvm}/bin/llc\"%" $settings
+      sed -i -e "s%\"opt\"%\"${llvm}/bin/opt\"%" $settings
+      sed -i -e "s%\"clang\"%\"/usr/bin/clang\"%" $settings
+      sed -i -e 's%("C compiler command", "")%("C compiler command", "/usr/bin/clang")%' $settings
+      sed -i -e 's%("C compiler flags", "")%("C compiler flags", "--target=${targetTriple}")%' $settings
+      sed -i -e 's%("C++ compiler flags", "")%("C++ compiler flags", "--target=${targetTriple}")%' $settings
+      sed -i -e 's%("C compiler link flags", "")%("C compiler link flags", "--target=${targetTriple}")%' $settings
+    '';
+
+    # Sanity check: verify that we can compile hello world.
+    doInstallCheck = true;
+    installCheckPhase = ''
+      unset DYLD_LIBRARY_PATH
+      $out/bin/ghc --info
+      cd $TMP
+      mkdir test-ghc; cd test-ghc
+      cat > main.hs << EOF
+        {-# LANGUAGE TemplateHaskell #-}
+        module Main where
+        main = putStrLn \$([|"yes"|])
+      EOF
+      $out/bin/ghc --make -v3 main.hs || exit 1
+      echo compilation ok
+      [ $(./main) == "yes" ]
+    '';
+  };
+
+  ourtexlive = with pkgs;
+    texlive.combine {
+      inherit (texlive)
+        scheme-medium collection-xetex fncychap titlesec tabulary varwidth
+        framed capt-of wrapfig needspace dejavu-otf helvetic upquote;
+    };
+  fonts = with pkgs; makeFontsConf { fontDirectories = [ dejavu_fonts ]; };
+
+  llvm = pkgs.llvm_15;
+  llvm_clang = pkgs.llvmPackages_15.clang-unwrapped;
+in
+pkgs.writeTextFile {
+  name = "toolchain";
+  text = ''
+    export PATH
+    PATH="${pkgs.autoconf}/bin:$PATH"
+    PATH="${pkgs.automake}/bin:$PATH"
+    export FONTCONFIG_FILE=${fonts}
+    export XELATEX="${ourtexlive}/bin/xelatex"
+    export MAKEINDEX="${ourtexlive}/bin/makeindex"
+    export HAPPY="${happy}/bin/happy"
+    export ALEX="${alex}/bin/alex"
+    export GHC="${ghc}/bin/ghc"
+    export LLC="${llvm}/bin/llc"
+    export OPT="${llvm}/bin/opt"
+    export LLVMAS="${llvm_clang}/bin/clang"
+    export SPHINXBUILD="${pkgs.python3Packages.sphinx}/bin/sphinx-build"
+    export CABAL_INSTALL="${pkgs.cabal-install}/bin/cabal"
+    export CABAL="$CABAL_INSTALL"
+
+    sdk_path="$(xcrun --sdk macosx --show-sdk-path)"
+    : ''${CONFIGURE_ARGS:=}
+    CONFIGURE_ARGS+="''${CONFIGURE_ARGS:+ }--with-ffi-libraries=$sdk_path/usr/lib --with-ffi-includes=$sdk_path/usr/include/ffi --build=${targetTriple}"
+    export CONFIGURE_ARGS
+  '';
+}

.gitlab/fix-submodules.py

-#!/usr/bin/env python3
-
-"""
-Fix submodule upstream URLs. This ensures that CI builds of GHC forks
-clone their submodules from its usual location. Otherwise users would need to
-fork all submodules before their CI builds would succeed.
-"""
-
-from pathlib import Path
-import re
-
-x = open('.gitmodules').read()
-x = re.sub(r"url *= *\.\.", "url = https://gitlab.haskell.org/ghc", x)
-open('.gitmodules', 'w').write(x)
-
-import subprocess
-
-def get_configs(config_file):
-    args = ['git', 'config', '-f', config_file.as_posix(), '--list']
-    out = subprocess.check_output(args)
-    configs = {}
-    for line in out.decode('UTF-8').split('\n'):
-        if '=' in line:
-            k,v = line.split('=')
-            configs[k] = v
-
-    return configs
-
-def set_config(config_file, key, value):
-    args = ['git', 'config', '-f', config_file.as_posix(), '--replace', key, value]
-    subprocess.check_call(args)
-
-upstreams = {
-    'utils/haddock': 'https://github.com/haskell/haddock'
-}
-
-modules_config = Path('.gitmodules')
-
-def main():
-    for k,v in get_configs(modules_config).items():
-        match = re.match('submodule\.(.+)\.url', k)
-        if match is not None:
-            submod = match.group(1)
-            if submod in upstreams:
-                url = upstreams[submod]
-            else:
-                url = re.sub('\.\.', 'https://gitlab.haskell.org/ghc', v)
-
-            print('Using {submod} from {url}'.format(submod=submod, url=url))
-            set_config(modules_config, k, url)
-
-if __name__ == '__main__':
-    main()

.gitlab/generate-ci/LICENSE

+Copyright (c) 2023, The GHC Developers
+
+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 The GHC Developers nor the names of other
+      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 THE COPYRIGHT
+OWNER 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.

.gitlab/generate-ci/README.mkd

+# generate-ci
+
+This is the generator for GHC's GitLab CI infrastructure. In particular, this
+generates two outputs:
+
+ * `.gitlab/jobs.yaml`, which is a YAML (or, strictly speaking, JSON)
+   file which defines the bulk of the validation, nightly, and release jobs of
+   GHC's CI. This is committed to the GHC repository and must be updated
+   whenever `gen_ci.hs` is modified.
+
+ * `.gitlab/jobs-metadata.json`, which is a mapping between platforms and
+   produced binary distribution names used when producing `ghcup` metadata
+   for nightly pipeline artifacts (see the `.ghcup-metadata` job in
+   `/.gitlab-ci.yaml`).
+
+
+## Modifying the CI configuration (nix)
+
+The jobs are defined in `gen_ci.hs`. After modifying this you can run
+```sh
+nix run .gitlab/generate-ci#generate-jobs
+```
+from the top of the GHC repository to update the generated configuration.
+
+
+## Modifying the CI configuration (without nix)
+
+One can run `update-ci` without Nix as follows (assuming one has `jq`,
+`cabal-install`, and GHC installed):
+```sh
+$ cabal build generate-ci
+$ PATH="$(dirname $(cabal list-bin generate-ci)):$PATH"
+$ ./generate-jobs
+```

.gitlab/generate-ci/flake.lock

+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1710146030,
+        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1724334015,
+        "narHash": "sha256-5sfvc0MswIRNdRWioUhG58rGKGn2o90Ck6l6ClpwQqA=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "6d204f819efff3d552a88d0a44b5aaaee172b784",
+        "type": "github"
+      },
+      "original": {
+        "id": "nixpkgs",
+        "type": "indirect"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}