2023-11-01 03:32:09 +00:00
# Nimbus
2024-02-19 09:33:43 +00:00
# Copyright (c) 2018-2024 Status Research & Development GmbH
2023-11-01 03:32:09 +00:00
# Licensed under either of
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
# http://www.apache.org/licenses/LICENSE-2.0)
# * MIT license ([LICENSE-MIT](LICENSE-MIT) or
# http://opensource.org/licenses/MIT)
# at your option. This file may not be copied, modified, or distributed except
# according to those terms.
2022-03-27 11:21:15 +00:00
import strutils
2023-03-14 16:45:58 +00:00
const currentDir = currentSourcePath()[0 .. ^(len("config.nims") + 1)]
if getEnv("NIMBUS_BUILD_SYSTEM") == "yes" and
# BEWARE
# In Nim 1.6, config files are evaluated with a working directory
# matching where the Nim command was invocated. This means that we
# must do all file existance checks with full absolute paths:
system.fileExists(currentDir & "nimbus-build-system.paths"):
2022-08-25 19:19:50 +00:00
include "nimbus-build-system.paths"
2024-07-04 16:10:40 +00:00
const nimCachePathOverride {.strdefine.} = ""
when nimCachePathOverride == "":
when defined(release):
let nimCachePath = "nimcache/release/" & projectName()
else:
let nimCachePath = "nimcache/debug/" & projectName()
2020-02-09 16:31:37 +00:00
else:
2024-07-04 16:10:40 +00:00
let nimCachePath = nimCachePathOverride
switch("nimcache", nimCachePath)
# `-flto` gives a significant improvement in processing speed, specially hash tree and state transition (basically any CPU-bound code implemented in nim)
# With LTO enabled, optimization flags should be passed to both compiler and linker!
if defined(release) and not defined(disableLTO):
# "-w" is not passed to the compiler during linking, so we need to disable
# some warnings by hand.
switch("passL", "-Wno-stringop-overflow -Wno-stringop-overread")
if defined(macosx): # Clang
switch("passC", "-flto=thin")
switch("passL", "-flto=thin -Wl,-object_path_lto," & nimCachePath & "/lto")
elif defined(linux):
switch("passC", "-flto=auto")
switch("passL", "-flto=auto")
switch("passC", "-finline-limit=100000")
switch("passL", "-finline-limit=100000")
else:
# On windows, LTO needs more love and attention so "gcc-ar" and "gcc-ranlib" are
# used for static libraries.
discard
# Hidden visibility allows for better position-independent codegen - it also
# resolves a build issue in BLST where otherwise private symbols would require
# an unsupported relocation on PIE-enabled distros such as ubuntu - BLST itself
# solves this via a linker script which is messy
switch("passC", "-fvisibility=hidden")
2020-02-09 16:31:37 +00:00
if defined(windows):
# disable timestamps in Windows PE headers - https://wiki.debian.org/ReproducibleBuilds/TimestampsInPEBinaries
switch("passL", "-Wl,--no-insert-timestamp")
Limit stack size on Windows like other targets
We can't use `ulimit -s` to limit stack size on Windows. Even though Bash
accepts `ulimit -s` and the numbers change it has no effect and is not passed
to child processes.
(See https://public-inbox.org/git/alpine.DEB.2.21.1.1709131448390.4132@virtualbox/)
Instead, set it when building the test executable, following, a suggestion from
@stefantalpalaru.
https://github.com/status-im/nimbus-eth1/pull/598#discussion_r621107128
To ensure no conflict with `config.nims`, `-d:windowsNoSetStack` is used. This
proved unnecessary in practice because the command-line option is passed to the
linker after the config file option. But given we don't have an automated test
to verify linker behaviour, it's best not to rely on the option order, neither
how the linker treats it, or whether Nim will always send them in that order.
Testing:
This has been verified by using a smaller limit. At 200k, all `ENABLE_EVMC=0`
OS targets passed as expected, and all `ENABLE_EVMC=1` OS targets failed with
expected kinds of errors due to stack overflow, including Windows.
(400k wasn't small enough; 32-bit x86 Windows passed on that).
Signed-off-by: Jamie Lokier <jamie@shareable.org>
2021-04-29 18:40:47 +00:00
# increase stack size, unless something else is setting the stack size
if not defined(windowsNoSetStack):
switch("passL", "-Wl,--stack,8388608")
2020-02-09 16:31:37 +00:00
# https://github.com/nim-lang/Nim/issues/4057
--tlsEmulation:off
if defined(i386):
# set the IMAGE_FILE_LARGE_ADDRESS_AWARE flag so we can use PAE, if enabled, and access more than 2 GiB of RAM
switch("passL", "-Wl,--large-address-aware")
2023-04-20 10:58:56 +00:00
# Colors are disabled for Windows, see issue:
# https://github.com/status-im/nim-chronicles/issues/130
switch("define", "chronicles_colors=off")
2022-03-27 11:21:15 +00:00
# Avoid some rare stack corruption while using exceptions with a SEH-enabled
# toolchain: https://github.com/status-im/nimbus-eth2/issues/3121
switch("define", "nimRawSetjmp")
2021-04-09 07:26:06 +00:00
# This helps especially for 32-bit x86, which sans SSE2 and newer instructions
# requires quite roundabout code generation for cryptography, and other 64-bit
# and larger arithmetic use cases, along with register starvation issues. When
# engineering a more portable binary release, this should be tweaked but still
# use at least -msse2 or -msse3.
2022-01-25 13:43:22 +00:00
#
# https://github.com/status-im/nimbus-eth2/blob/stable/docs/cpu_features.md#ssse3-supplemental-sse3
# suggests that SHA256 hashing with SSSE3 is 20% faster than without SSSE3, so
# given its near-ubiquity in the x86 installed base, it renders a distribution
# build more viable on an overall broader range of hardware.
#
2020-02-13 19:18:27 +00:00
if defined(disableMarchNative):
2021-04-09 07:26:06 +00:00
if defined(i386) or defined(amd64):
2022-03-27 11:21:15 +00:00
if defined(macosx):
2024-09-17 10:22:06 +00:00
# https://support.apple.com/en-us/102861
# "macOS Ventura is compatible with these computers" lists current oldest
# supported x86 models, all of which have Kaby Lake or newer CPUs.
switch("passC", "-march=skylake -mtune=generic")
switch("passL", "-march=skylake -mtune=generic")
2022-03-27 11:21:15 +00:00
else:
switch("passC", "-mssse3")
switch("passL", "-mssse3")
2022-01-25 13:43:22 +00:00
elif defined(macosx) and defined(arm64):
# Apple's Clang can't handle "-march=native" on M1: https://github.com/status-im/nimbus-eth2/issues/2758
switch("passC", "-mcpu=apple-a14")
switch("passL", "-mcpu=apple-a14")
2024-12-11 09:32:15 +00:00
elif defined(riscv64):
# riscv64 needs specification of ISA with extensions. 'gc' is widely supported
# and seems to be the minimum extensions needed to build.
switch("passC", "-march=rv64gc")
switch("passL", "-march=rv64gc")
2020-02-13 19:18:27 +00:00
else:
switch("passC", "-march=native")
2021-04-09 07:26:06 +00:00
switch("passL", "-march=native")
2020-02-13 19:18:27 +00:00
if defined(windows):
# https://gcc.gnu.org/bugzilla/show_bug.cgi?id=65782
# ("-fno-asynchronous-unwind-tables" breaks Nim's exception raising, sometimes)
2021-04-09 07:26:06 +00:00
switch("passC", "-mno-avx512f")
switch("passL", "-mno-avx512f")
2021-05-18 22:40:52 +00:00
# Omitting frame pointers in nim breaks the GC:
2021-04-09 07:26:06 +00:00
# https://github.com/nim-lang/Nim/issues/10625
2021-05-18 22:40:52 +00:00
if not defined(windows):
# ...except on Windows where the Nim bug doesn't manifest and the option
# crashes GCC in some Mingw-w64 versions:
# https://sourceforge.net/p/mingw-w64/bugs/880/
# https://gcc.gnu.org/bugzilla/show_bug.cgi?id=86593
switch("passC", "-fno-omit-frame-pointer")
switch("passL", "-fno-omit-frame-pointer")
2020-02-13 19:18:27 +00:00
2020-02-09 16:31:37 +00:00
--threads:on
--opt:speed
--excessiveStackTrace:on
# enable metric collection
--define:metrics
2021-04-09 07:26:06 +00:00
# for heap-usage-by-instance-type metrics and object base-type strings
--define:nimTypeNames
2024-02-20 03:07:38 +00:00
--styleCheck:usages
2024-05-30 09:01:07 +00:00
--styleCheck:error
2024-05-29 18:47:06 +00:00
--mm:refc
2021-04-09 07:26:06 +00:00
switch("define", "withoutPCRE")
2020-02-09 16:31:37 +00:00
2022-03-27 11:21:15 +00:00
when not defined(disable_libbacktrace):
--define:nimStackTraceOverride
switch("import", "libbacktrace")
else:
--stacktrace:on
--linetrace:on
var canEnableDebuggingSymbols = true
if defined(macosx):
# The default open files limit is too low on macOS (512), breaking the
# "--debugger:native" build. It can be increased with `ulimit -n 1024`.
let openFilesLimitTarget = 1024
var openFilesLimit = 0
try:
openFilesLimit = staticExec("ulimit -n").strip(chars = Whitespace + Newlines).parseInt()
if openFilesLimit < openFilesLimitTarget:
echo "Open files limit too low to enable debugging symbols and lightweight stack traces."
echo "Increase it with \"ulimit -n " & $openFilesLimitTarget & "\""
canEnableDebuggingSymbols = false
except:
echo "ulimit error"
# We ignore this resource limit on Windows, where a default `ulimit -n` of 256
# in Git Bash is apparently ignored by the OS, and on Linux where the default of
# 1024 is good enough for us.
if canEnableDebuggingSymbols:
2020-02-09 16:31:37 +00:00
# add debugging symbols and original files and line numbers
--debugger:native
--define:nimOldCaseObjects # https://github.com/status-im/nim-confutils/issues/9
2022-03-27 11:21:15 +00:00
# `switch("warning[CaseTransition]", "off")` fails with "Error: invalid command line option: '--warning[CaseTransition]'"
switch("warning", "CaseTransition:off")
2020-02-09 16:31:37 +00:00
2023-06-04 06:00:50 +00:00
# nim-kzg shipping their own blst, nimbus-eth1 too.
# disable nim-kzg's blst
switch("define", "kzgExternalBlst")
2024-03-28 01:55:12 +00:00
2024-06-04 16:15:33 +00:00
# We lock down rocksdb to a particular version
# TODO self-build rocksdb dll on windows
when not defined(use_system_rocksdb) and not defined(windows):
2024-03-28 01:55:12 +00:00
switch("define", "rocksdb_static_linking")
# use the C++ linker profile because it's a C++ library
when defined(macosx):
switch("clang.linkerexe", "clang++")
else:
switch("gcc.linkerexe", "g++")
switch("dynlibOverride", "rocksdb")
switch("dynlibOverride", "lz4")
switch("dynlibOverride", "zstd")
2024-06-04 16:15:33 +00:00
2024-07-03 10:14:03 +00:00
# This applies per-file compiler flags to C files
# which do not support {.localPassC: "...".}
# Unfortunately this is filename based instead of path-based
# Assumes GCC
# -fomit-frame-pointer for https://github.com/status-im/nimbus-eth1/issues/2127
2024-07-04 16:10:40 +00:00
put("secp256k1.always", "-fno-lto -fomit-frame-pointer")
# ############################################################
#
# No LTO for crypto
#
# ############################################################
# This applies per-file compiler flags to C files
# which do not support {.localPassC: "-fno-lto".}
# Unfortunately this is filename based instead of path-based
# Assumes GCC
# BLST
put("server.always", "-fno-lto")
put("assembly.always", "-fno-lto")
# BearSSL - only RNGs
put("aesctr_drbg.always", "-fno-lto")
put("hmac_drbg.always", "-fno-lto")
put("sysrng.always", "-fno-lto")
# ############################################################
#
# Spurious warnings
#
# ############################################################
# sqlite3.c: In function ‘ sqlite3SelectNew’ :
# vendor/nim-sqlite3-abi/sqlite3.c:124500: warning: function may return address of local variable [-Wreturn-local-addr]
put("sqlite3.always", "-fno-lto") # -Wno-return-local-addr