habibalamin
commented
1 month ago I've been messing around with GHCup on OpenBSD (7.5), and these are the roadblocks to getting GHCup to compile and run:
-
lzma-staticdependency's vendoredliblzmadoesn't compile on OpenBSD (though upstreamliblzmadoes).-
Solution 1: switch to
lzma, which doesn't vendorliblzma(funnily enough, incabal.project.release, we pass+staticas a build flag constraint tolzmain some environments, but it doesn't seem to do anything with it, not even do a static build, which is what I expected; if you can explain why we pass it that build flag, I'd appreciate it).libarchivehas a transitive dependency onlzma-static, so the above solution alone doesn't entirely solve the problem; you'd also have to enable thetarbuild flag to usezipandtardependencies instead oflibarchive. -
Solution 2: generate the platform-specific
config.hfile for OpenBSD.lzma-staticvendorsliblzmafrom thexzsource tree. Due toliblzmadisallowing compilation on architectures other than 32- or 64-bit, and the inability to use thesizeof()macro during the preprocessing phase to test for this condition before runtime, it requires the use of aconfigurescript to defineSIZEOF_SIZE_T.liblzmaupstream includes thisconfigurescript, butlzma-staticopts instead to vendor platform-specificconfig.hheader files, which it has agen-header.shscript to generate (the script fetches anxzsource tarball to use theconfigurescript from it to and copies the generatedconfig.hfile).diff -ru a/gen-header.sh b/gen-header.sh --- a/gen-header.sh +++ b/gen-header.sh @@ -13,7 +13,7 @@ XZ_URL="https://tukaani.org/xz/${XZ_BALL}" [ -f "${XZ_BALL}" ] || curl -LO "${XZ_URL}" -[ -d "xz-${XZ_VER}" ] || tar xf "${XZ_BALL}" +[ -d "xz-${XZ_VER}" ] || bzcat "${XZ_BALL}" | tar xf - cd "xz-${XZ_VER}" ./configure @@ -69,6 +69,28 @@ case "$(uname -s)" in cp config.h ../autoconf-freebsd-aarch64/config.h ;; esac ;; + "OpenBSD"|"openbsd") + case "$(uname -m)" in + x86_64|amd64) + if [ "$(getconf LONG_BIT)" = "32" ] ; then + cp config.h ../autoconf-openbsd-i386/config.h + else + cp config.h ../autoconf-openbsd-x86_64/config.h + fi + ;; + i*86) + cp config.h ../autoconf-openbsd-i386/config.h ;; + armv7*) + cp config.h ../autoconf-openbsd-arm/config.h ;; + aarch64|arm64|armv8l) + if [ "$(getconf LONG_BIT)" = "32" ] ; then + cp config.h ../autoconf-openbsd-arm/config.h + else + cp config.h ../autoconf-openbsd-aarch64/config.h + fi + ;; + esac + ;; *) die "Unknown platform" ;; esac diff -ru a/lzma-static.cabal b/lzma-static.cabal --- a/lzma-static.cabal +++ b/lzma-static.cabal @@ -91,6 +91,15 @@ library include-dirs: autoconf-freebsd elif arch(aarch64) include-dirs: autoconf-freebsd-aarch64 + elif os(openbsd) + if arch(x86_64) + include-dirs: autoconf-openbsd-x86_64 + elif arch(i386) + include-dirs: autoconf-openbsd-i386 + elif arch(arm) + include-dirs: autoconf-openbsd-arm + elif arch(aarch64) + include-dirs: autoconf-openbsd-aarch64 else build-depends: unbuildable<0 buildable: False(I've only built on OpenBSD amd64.)
-
Solution 3: we can go further and use a generic fallback
config.hfile to make the vendoredliblzma(which hasn't been updated since the initial commit) easily buildable on OpenBSD, and other arbitrary platforms which don't have their ownconfig.hfile. (We can still also use an OpenBSD-specificconfig.hfile if we want.)diff -ru a/lzma-static.cabal b/lzma-static.cabal --- a/lzma-static.cabal +++ b/lzma-static.cabal @@ -92,8 +92,7 @@ library elif arch(aarch64) include-dirs: autoconf-freebsd-aarch64 else - build-depends: unbuildable<0 - buildable: False + include-dirs: autoconf-generic c-sources: cbits/lzma_wrapper.cMost of the platform-specific definitions seem to be unnecessary (
liblzmahas fallback behaviour, and the generatedconfig.heven comments out some definitions instead of defining them as0), butSIZEOF_SIZE_Tis required and can't simply be set to a reasonable default.// Incorrect(?) SIZE_MAX: // - Interix headers typedef size_t to unsigned long, // but a few lines later define SIZE_MAX to INT32_MAX. // - SCO OpenServer (x86) headers typedef size_t to unsigned int // but define SIZE_MAX to INT32_MAX. #if defined(__INTERIX) || defined(_SCO_DS) # undef SIZE_MAX #endif // The code currently assumes that size_t is either 32-bit or 64-bit. #ifndef SIZE_MAX # if SIZEOF_SIZE_T == 4 # define SIZE_MAX UINT32_MAX # elif SIZEOF_SIZE_T == 8 # define SIZE_MAX UINT64_MAX # else # error size_t is not 32-bit or 64-bit # endif #endif #if SIZE_MAX != UINT32_MAX && SIZE_MAX != UINT64_MAX # error size_t is not 32-bit or 64-bit #endifThere is a way to solve this to prevent compilation on non-32- or 64-bit platforms without requiring a
configurescript, but it involves a preprocessor macro to emit uncompilable code if a certain condition is met, which produces an error message unrelated to the actual failing condition (though, in practice, the macro name and its arguments are shown, so having something likeFAIL_BUILD_IF(sizeof(size_t) < 4)makes it pretty obvious why the build failed). It basically involves inserting something like the following code somewhere, maybe incbits/lzma_wrapper.cbefore the C code which provides the Haskell wrapper:#define FAIL_BUILD_IF(condition) ((void)sizeof(char[1 - 2*!!(condition)])) // This function should never be called, it's simply a container so that // `FAIL_BUILD_IF` can emit uncompilable code into it. void _fail_build_if() { // The code currently assumes that size_t is either 32-bit or 64-bit. FAIL_BUILD_IF(sizeof(size_t) < 4); # define SIZEOF_SIZE_T 4 FAIL_BUILD_IF(sizeof(size_t) > 4 && sizeof(size_t) < 8); # undef SIZEOF_SIZE_T # define SIZEOF_SIZE_T 8 FAIL_BUILD_IF(sizeof(size_t) > 8); // Incorrect(?) SIZE_MAX: // - Interix headers typedef size_t to unsigned long, // but a few lines later define SIZE_MAX to INT32_MAX. // - SCO OpenServer (x86) headers typedef size_t to unsigned int // but define SIZE_MAX to INT32_MAX. #if defined(__INTERIX) || defined(_SCO_DS) # undef SIZE_MAX #endif # ifndef SIZE_MAX # if SIZEOF_SIZE_T == 8 # define SIZE_MAX UINT64_MAX # elif SIZEOF_SIZE_T == 4 # define SIZE_MAX UINT32_MAX # else # error size_t is not 32-bit or 64-bit # endif # endif # if SIZE_MAX != UINT32_MAX && SIZE_MAX != UINT64_MAX # error size_t is not 32-bit or 64-bit # endif }Apart from the
SIZEOF_SIZE_Tissue, a genericconfig.hwhich lacksHAVE__BOOL&HAVE_STDBOOL_Hcauses the following compilation error:cbits/common/sysdefs.h:144:23: error: error: cannot combine with previous 'char' declaration specifier | 144 | typedef unsigned char _Bool; | ^ typedef unsigned char _Bool; ^ cbits/common/sysdefs.h:144:1: error: warning: typedef requires a name [-Wmissing-declarations] | 144 | typedef unsigned char _Bool; | ^(The terminal colours on the first error highlight the underscore, so the caret isn't just pointing to the whole word
_Bool, that's how I figured out the fix). This has a simple fix:diff -ru a/cbits/common/sysdefs.h b/cbits/common/sysdefs.h --- a/cbits/common/sysdefs.h +++ b/cbits/common/sysdefs.h @@ -140,10 +140,10 @@ #ifdef HAVE_STDBOOL_H # include <stdbool.h> #else +# define bool _Bool # if ! HAVE__BOOL -typedef unsigned char _Bool; +typedef unsigned char bool; # endif -# define bool _Bool # define false 0 # define true 1 # define __bool_true_false_are_defined 1
-
- GHCup itself refuses to run on any platform it doesn't explicitly recognise.
- Solution 1: add OpenBSD as a supported platform in
lib/GHCup/Types.hs, andlib/GHCup/Platform.hs. - Solution 2: like with
lzma-static'sliblzma, I feel it would be best to simply allow it to build and run on any platform (which GHC & GHCup themselves can run on). Is there a reason GHCup doesn't do that?
- Solution 1: add OpenBSD as a supported platform in
-
As mentioned, bindists. Building GHC on OpenBSD has some special considerations.
- OpenBSD tar doesn't support the
-Tflag, used bybinary-distMake target. - GNU Make is required.
- OpenBSD's
autoconf&automakeare shell scripts which delegate to the versions specified byAUTOCONF_VERSION&AUTOMAKE_VERSION. It fails to run without specifying those environment variables. -
lndoesn't recognise the-vflag, so I use this shim:#!/usr/bin/env sh error() { >&2 echo "$@" } without_v() { printf '%s' "$1" | sed 's:v::' } without_verbose_flags() { for arg in "$@"; do case "$arg" in -*) # `local` is not strictly POSIX shell, but it's available # on OpenBSD ksh, and it's essential if we want code that # isn't too buggy, IMO. local flags="$(without_v "$arg")" if [ "$flags" != '-' ]; then printf '%s ' "$flags" fi;; *) printf '%s ' "$arg";; esac done | sed 's: $::' } verbose_flag_given() { for arg in "$@"; do case "$arg" in -*) if [ "$(without_v "$arg")" != "$arg" ]; then return 0 fi esac done return 1 } if verbose_flag_given "$@"; then error "WARNING: ln given \`-v\`, but doesn't understand; using dumb shim to ignore!" fi /bin/ln $(without_verbose_flags "$@")I'm sure one could improve it by actually acting on the
-vflag, but you obviously don't need that for the build to work. (I tweaked the shim slightly from what I originally wrote in my build scripts, to better name certain functions, so apologies if I broke it; I do have my original scripts if needed.) -
Some older GHC & OpenBSD versions also require patching. Some OpenBSD versions have different package or symlink requirements. I have some build scripts for some older versions:
- GHC 8.2.2 on OpenBSD 6.6:
diff -ru a/libraries/Cabal/Cabal/Distribution/PackageDescription/Configuration.hs b/libraries/Cabal/Cabal/Distribution/PackageDescription/Configuration.hs --- a/libraries/Cabal/Cabal/Distribution/PackageDescription/Configuration.hs +++ b/libraries/Cabal/Cabal/Distribution/PackageDescription/Configuration.hs @@ -56,7 +56,8 @@ import Distribution.Types.Condition import Distribution.Types.DependencyMap -import qualified Data.Map as Map +import qualified Data.Map.Lazy as Map +import qualified Data.Map.Strict as Map.Strict import Data.Tree ( Tree(Node) ) ------------------------------------------------------------------------------ @@ -219,7 +220,7 @@ mp m@(Right _) _ = m mp _ m@(Right _) = m mp (Left xs) (Left ys) = - let union = Map.foldrWithKey (Map.insertWith' combine) + let union = Map.foldrWithKey (Map.Strict.insertWith combine) (unDepMapUnion xs) (unDepMapUnion ys) combine x y = simplifyVersionRange $ unionVersionRanges x y in union `seq` Left (DepMapUnion union)- GHC 8.6.5 on OpenBSD 6.6:
diff -ru a/rts/RtsSymbols.c b/rts/RtsSymbols.c --- a/rts/RtsSymbols.c +++ b/rts/RtsSymbols.c @@ -278,9 +278,7 @@ #endif #if defined(openbsd_HOST_OS) -#define RTS_OPENBSD_ONLY_SYMBOLS \ - SymE_NeedsProto(__guard_local) \ - SymE_NeedsProto(_DYNAMIC) +#define RTS_OPENBSD_ONLY_SYMBOLS SymE_NeedsProto(__guard_local) #else #define RTS_OPENBSD_ONLY_SYMBOLS #endif- GHC 8.8.4 on OpenBSD 6.8:
-
diff -ru a/utils/iserv/ghc.mk b/utils/iserv/ghc.mk --- a/utils/iserv/ghc.mk +++ b/utils/iserv/ghc.mk @@ -32,7 +32,7 @@ # need it there's no alternative. # Don't do this on FreeBSD to work around #17962. ifeq "$(TargetElf)" "YES" -ifeq "$(findstring $(TargetOS_CPP), solaris2 freebsd)" "" +ifeq "$(findstring $(TargetOS_CPP), solaris2 freebsd openbsd)" "" # The Solaris linker does not support --export-dynamic option. It also # does not need it since it exports all dynamic symbols by default utils/iserv_stage2_MORE_HC_OPTS += -optl-Wl,--export-dynamic - GCC must be installed (not Clang).
python3is not symlinked topython3.$MINORby default.
- OpenBSD tar doesn't support the
hasufell
dfordivam
Bodigrim
https://github.com/haskell/unix/pull/262
But we have no bindists so far.