From 9f1a728b3d57055eff3078151219ba580d8b3030 Mon Sep 17 00:00:00 2001 From: Etan Kissling Date: Sun, 4 Oct 2026 16:51:50 +0200 Subject: [PATCH 1/3] Add ASAN/UBSAN to CI Adopt AddressSanitizer / UndefinedBehaviorSanitizer to catch bugs early. --- .github/workflows/tests.yml | 5 ++- .gitignore | 2 +- intops.nimble | 70 +++++++++++++++++++++++++++++-------- 3 files changed, 60 insertions(+), 17 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index e20d7f4..e86ac67 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -12,4 +12,7 @@ jobs: tests: uses: status-im/nimbus-common-workflow/.github/workflows/common.yml@main with: - nim-versions: '["version-1-6", "version-2-0", "version-2-2", "devel"]' + nim-versions: '["version-1-6", "version-2-0", "version-2-2", "version-2-4", "devel"]' + test-command: | + nimble test_asan + nimble test diff --git a/.gitignore b/.gitignore index 36ce0fe..529979c 100644 --- a/.gitignore +++ b/.gitignore @@ -15,7 +15,7 @@ nbook nimcache/ -tests/tintops +build/ results.csv results.json diff --git a/intops.nimble b/intops.nimble index 9b07cf2..e167562 100644 --- a/intops.nimble +++ b/intops.nimble @@ -1,3 +1,5 @@ +mode = ScriptMode.Verbose + # Package version = "1.0.8" @@ -12,22 +14,60 @@ requires "nim >= 1.6.16", "unittest2 >= 0.2.5" import std/[os, sequtils, strformat, parseopt, json] -task test, "Run tests": - let - archFlags = - commandLineParams().filterIt(it.startsWith("--cpu") or it.startsWith("--gcc")) - archFlagStr = archFlags.join(" ") - - for intopsFlagStr in [ - "-d:intopsNoIntrinsics", "-d:intopsNoInlineAsm", "-d:intopsNoInlineC", - "-d:unittest2Static", - "-d:unittest2Static -d:intopsNoIntrinsics -d:intopsNoInlineAsm -d:intopsNoInlineC", - ]: - let flags = [intopsFlagStr, archFlagStr].join(" ") +let nimc = getEnv("NIMC", "nim") # Which nim compiler to use +let lang = getEnv("NIMLANG", "c") # Which backend (c/cpp/js) +let flags = getEnv("NIMFLAGS", "") # Extra flags for the compiler +let verbose = getEnv("V", "") notin ["", "0"] +let platform = getEnv("PLATFORM", "") +let testArguments = [ + "-d:intopsNoIntrinsics", + "-d:intopsNoInlineAsm", + "-d:intopsNoInlineC", + "-d:unittest2Static", + "-d:unittest2Static -d:intopsNoIntrinsics -d:intopsNoInlineAsm -d:intopsNoInlineC", +] + +let cfg = + " --styleCheck:usages --styleCheck:error" & + (if verbose: "" else: " --verbosity:0") & + " --skipParentCfg --skipUserCfg --outdir:build -f " & + quoteShell("--nimcache:build/nimcache/$projectName") + +proc build(args, path: string) = + let archFlags = + commandLineParams().filterIt(it.startsWith("--cpu") or it.startsWith("--gcc")) + exec nimc & " " & lang & " " & cfg & " " & flags & " " & archFlags.join(" ") & + " " & args & " " & path + +proc run(args, path: string) = + build args & " -r", path - echo fmt"# Flags: {flags}" - - selfExec fmt"r {flags} tests/tintops.nim" +task test, "Run tests": + for args in testArguments: + run args & " --mm:refc", "tests/tintops" + if (NimMajor, NimMinor) > (1, 6): + run args & " --mm:orc", "tests/tintops" + +task test_asan, "Run tests with ASAN": + if platform != "x86" and (NimMajor, NimMinor) >= (2, 2): + try: + exec "echo '#if __clang_major__ < 20\n#error\n#endif' | clang -E - >/dev/null" + except OSError: + return + + # https://clang.llvm.org/docs/AddressSanitizer.html + putEnv("ASAN_OPTIONS", "detect_leaks=0:detect_stack_use_after_return=1") + # https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html + putEnv("UBSAN_OPTIONS", "print_stacktrace=1") + let asanArgs = + " --mm:orc -d:useMalloc --cc:clang --debugger:native" & + " --passC:-fsanitize=address,undefined" & + " --passL:-fsanitize=address,undefined" & + " --passC:-fno-sanitize-recover=undefined" & + " --passC:-fno-sanitize-merge" & + " --passC:-fno-omit-frame-pointer" + for args in testArguments: + run args & asanArgs, "tests/tintops" task bench, "Run benchmarks": var From 4fd61591230fd9c2adaf146017046dda00ced7b8 Mon Sep 17 00:00:00 2001 From: Etan Kissling Date: Sun, 4 Oct 2026 16:54:43 +0200 Subject: [PATCH 2/3] Fix style check --- src/intops/impl/intrinsics/x86.nim | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/intops/impl/intrinsics/x86.nim b/src/intops/impl/intrinsics/x86.nim index 5c7c3c9..30b793a 100644 --- a/src/intops/impl/intrinsics/x86.nim +++ b/src/intops/impl/intrinsics/x86.nim @@ -57,7 +57,7 @@ when cpuX86 and canUseIntrinsics: bool(borrow) -when cpu64bit and cpuX86 and canUseIntrinsics: +when cpu64Bit and cpuX86 and canUseIntrinsics: func builtinCarryingAdd*( carry: uint8, a, b: culonglong, res: ptr culonglong ): uint8 {.importc: "_addcarry_u64", x86_header.} @@ -101,7 +101,7 @@ when cpu64bit and cpuX86 and canUseIntrinsics: bool(borrow) -when cpu64bit and cpuX86 and compilerMsvc and canUseIntrinsics: +when cpu64Bit and cpuX86 and compilerMsvc and canUseIntrinsics: func builtinWideningMul*( a, b: culonglong, hi: ptr culonglong ): uint64 {.importc: "_umul128", x86_header.} From 956291849f40987ecd6e0c209d7c7bd104533ed6 Mon Sep 17 00:00:00 2001 From: Etan Kissling Date: Tue, 6 Oct 2026 08:21:56 +0200 Subject: [PATCH 3/3] Drop Clang 20 check CI runners are updating to an image that always has Clang 20 available. --- .github/workflows/bench.yml | 1 - .github/workflows/tests.yml | 1 - intops.nimble | 12 +++--------- 3 files changed, 3 insertions(+), 11 deletions(-) diff --git a/.github/workflows/bench.yml b/.github/workflows/bench.yml index f7b1be7..fae104b 100644 --- a/.github/workflows/bench.yml +++ b/.github/workflows/bench.yml @@ -14,7 +14,6 @@ jobs: secrets: EXTERNAL_SERVICE_TOKEN: ${{ secrets.BENCHER_API_TOKEN }} with: - nim-versions: '["version-1-6", "version-2-0", "version-2-2", "devel"]' test-command: | if [[ "$MATRIX_OS" == "windows" ]]; then powershell -c "irm https://bencher.dev/download/install-cli.ps1 | iex" diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index e86ac67..b89be0e 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -12,7 +12,6 @@ jobs: tests: uses: status-im/nimbus-common-workflow/.github/workflows/common.yml@main with: - nim-versions: '["version-1-6", "version-2-0", "version-2-2", "version-2-4", "devel"]' test-command: | nimble test_asan nimble test diff --git a/intops.nimble b/intops.nimble index e167562..790d068 100644 --- a/intops.nimble +++ b/intops.nimble @@ -10,7 +10,7 @@ srcDir = "src" # Dependencies -requires "nim >= 1.6.16", "unittest2 >= 0.2.5" +requires "nim >= 1.6.16", "unittest2 >= 0.3.0" import std/[os, sequtils, strformat, parseopt, json] @@ -45,16 +45,10 @@ proc run(args, path: string) = task test, "Run tests": for args in testArguments: run args & " --mm:refc", "tests/tintops" - if (NimMajor, NimMinor) > (1, 6): - run args & " --mm:orc", "tests/tintops" + run args & " --mm:orc", "tests/tintops" task test_asan, "Run tests with ASAN": - if platform != "x86" and (NimMajor, NimMinor) >= (2, 2): - try: - exec "echo '#if __clang_major__ < 20\n#error\n#endif' | clang -E - >/dev/null" - except OSError: - return - + if platform != "x86": # https://clang.llvm.org/docs/AddressSanitizer.html putEnv("ASAN_OPTIONS", "detect_leaks=0:detect_stack_use_after_return=1") # https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html