Merge pull request #2572 from clash-lang/workaround-mmap-bug-everywhere

Enable ghc mmap crash workaround for every ghc compiled binary

Author: leonschoorl

.ci/build.sh

@@ -23,6 +23,11 @@ if [[ "$GHC_HEAD" != "yes" ]]; then
 fi
 set -u
 
+cabal v2-build clash-prelude --write-ghc-environment-files=always
+# Undo mmap crash workaround for clash-cosim, see PR #2572.
+# It uses a custom setup, which can't be linked with -rtsopts
+GHCRTS="" cabal v2-build clash-cosim --write-ghc-environment-files=always
+
 # Build with default constraints
 cabal v2-build all --write-ghc-environment-files=always
 

.ci/cabal.project.local

@@ -10,7 +10,7 @@ package *
 
 package clash-prelude
   ghc-options: -Werror
-  flags: +doctests +multiple-hidden -workaround-ghc-mmap-crash
+  flags: +doctests +multiple-hidden
   tests: True
   benchmarks: True
 
@@ -24,7 +24,6 @@ package clash-lib
 
 package clash-ghc
   ghc-options: -Werror
-  flags: -workaround-ghc-mmap-crash
 
 package clash-cosim
   ghc-options: -Werror
@@ -48,7 +47,7 @@ package clash-lib-hedgehog
 package clash-testsuite
   ghc-options: -Werror
   -- enable cosim
-  flags: +cosim +multiple-hidden -workaround-ghc-mmap-crash
+  flags: +cosim +multiple-hidden
 
 package clash-benchmark
   ghc-options: -Werror

.ci/clash-ffi-example-build.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+set -xeu
+
+# See PR #2572. Undo mmap crash workaround for clash-ffi-example.
+cd clash-ffi/example
+cabal build clash-ffi
+GHCRTS="" cabal build clash-ffi-example

.ci/gitlab/common.yml

@@ -22,6 +22,7 @@
     - export THREADS=$(./.ci/effective_cpus.sh)
     - export CABAL_JOBS=$(./.ci/effective_cpus.sh)
     - export CABAL_DIR=$HOME/.cabal
+    - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then export GHCRTS="-xm20000000"; fi
     - export
     - tar -xf cache.tar.zst -C / || true
     - .ci/setup.sh

.ci/gitlab/test.yml

@@ -28,6 +28,7 @@ stages:
     - export CABAL_DIR=$HOME/.cabal
     - export clash_lib_datadir=$(pwd)/clash-lib/
     - export clash_cosim_datadir=$(pwd)/clash-cosim/
+    - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then export GHCRTS="-xm20000000"; fi
     - export
     - tar -xf dist.tar.zst -C /
 
@@ -50,6 +51,7 @@ stages:
     - export CABAL_DIR=$HOME/.cabal
     - export clash_lib_datadir=$(pwd)/clash-lib/
     - export clash_cosim_datadir=$(pwd)/clash-cosim/
+    - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then export GHCRTS="-xm20000000"; fi
     - export
     - tar -xf cache.tar.zst -C / || true
     - tar -xf dist.tar.zst -C /
@@ -167,6 +169,7 @@ ffi:example:
     - export clash_cosim_datadir=$(pwd)/clash-cosim/
     - export MASKBINS="$(mktemp -d)"
     - PATH="$MASKBINS:$PATH"
+    - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then export GHCRTS="-xm20000000"; fi
     - export
     - tar -xf cache.tar.zst -C / || true
       # The iverilog on CI cannot run the example, we only test it builds
@@ -177,6 +180,7 @@ ffi:example:
       # Make sure we get custom cabals setting in the clash-example project too
     - cp cabal.project.local clash-ffi/example
   script:
+     - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then ./.ci/clash-ffi-example-build.sh; fi
      - cd clash-ffi/example && ./run-iverilog.sh
   after_script:
     - tar -cf - /root/.cabal | zstd -T${THREADS} -3 > cache.tar.zst

.ci/setup.sh

@@ -78,10 +78,6 @@ if [ ! -f cabal.project.local ]; then
   fi
 
   set +u
-  if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then
-    sed -i 's/-workaround-ghc-mmap-crash/+workaround-ghc-mmap-crash/g' cabal.project.local
-  fi
-
   if [[ "$GHC_HEAD" == "yes" ]]; then
     cat .ci/cabal.project.local.append-HEAD >> cabal.project.local
   fi

.github/workflows/ci.yml

@@ -138,7 +138,7 @@ jobs:
         CABAL_JOBS: 2
         MULTIPLE_HIDDEN: ${{ matrix.multiple_hidden }}
         CI_COMMIT_BRANCH: ${{ github.base_ref }}
-        WORKAROUND_GHC_MMAP_CRASH: ${{ matrix.workaround_ghc_mmap_crash }}
+        GHCRTS: ${{ fromJSON('["","-xm20000000"]')[matrix.workaround_ghc_mmap_crash == 'yes'] }}
 
     steps:
       - name: Checkout

.gitlab-ci.yml

@@ -67,6 +67,7 @@ nix-build:
   needs: []
   stage: test
   before_script:
+   - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then export GHCRTS="-xm20000000"; fi
    - nix-env -i gawk
   script:
     - nix-build -j$(./.ci/effective_cpus.sh)

benchmark/profiling/prepare/clash-profiling-prepare.cabal

@@ -26,7 +26,7 @@ library
 executable clash-profile-normalization-prepare
   main-is:             profile-normalization-prepare.hs
   default-language:    Haskell2010
-  ghc-options:         -Wall -Wcompat
+  ghc-options:         -Wall -Wcompat -rtsopts
   build-depends:       base,
                        binary,
                        bytestring,
@@ -38,7 +38,7 @@ executable clash-profile-normalization-prepare
 executable clash-profile-netlist-prepare
   main-is:             profile-netlist-prepare.hs
   default-language:    Haskell2010
-  ghc-options:         -Wall -Wcompat
+  ghc-options:         -Wall -Wcompat -rtsopts
   build-depends:       base,
                        binary,
                        bytestring,

benchmark/profiling/run/clash-profiling.cabal

@@ -12,7 +12,7 @@ cabal-version:       >=1.10
 executable clash-profile-normalization-run
   main-is:             profile-normalization-run.hs
   default-language:    Haskell2010
-  ghc-options:         -O2 -Wall -Wcompat
+  ghc-options:         -O2 -Wall -Wcompat -rtsopts
   build-depends:       base,
                        binary,
                        bytestring,
@@ -30,7 +30,7 @@ executable clash-profile-normalization-run
 executable clash-profile-netlist-run
   main-is:             profile-netlist-run.hs
   default-language:    Haskell2010
-  ghc-options:         -O2 -Wall -Wcompat
+  ghc-options:         -O2 -Wall -Wcompat -rtsopts
   build-depends:       base,
                        binary,
                        bytestring,