Run Linux ASAN in CI

.github/workflows/main.yml

@@ -14,6 +14,66 @@ on:
       - '*'
 
 jobs:
+  sanitizer:
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        release: [stable, HEAD]
+    env: { CXX: clang++-14 }
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup Git User for Applying Patches
+      # See this thread for more details https://github.community/t/github-actions-bot-email-address/17204/5
+      run: |
+        git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+        git config --global user.name "github-actions[bot]"
+
+    - name: Configure the project
+      run: cmake --preset=ci-sanitize
+        -Dsleigh_RELEASE_TYPE=${{ matrix.release }}
+
+    - name: Build the project
+      run: cmake
+        --build build/sanitize
+        -j 2
+        -v
+
+    - name: Run the example
+      env:
+        ASAN_OPTIONS: "strict_string_checks=1:\
+          detect_stack_use_after_return=1:\
+          check_initialization_order=1:\
+          strict_init_order=1:\
+          detect_leaks=1"
+        UBSAN_OPTIONS: print_stacktrace=1
+      run: cmake
+        --build build/sanitize
+        -j 2
+        --target sleigh_example_runner
+
+    - name: Smoketest sleigh lift
+      env:
+        ASAN_OPTIONS: "strict_string_checks=1:\
+          detect_stack_use_after_return=1:\
+          check_initialization_order=1:\
+          strict_init_order=1:\
+          detect_leaks=1"
+        UBSAN_OPTIONS: print_stacktrace=1
+      run: ./build/sanitize/extra-tools/sleigh-lift/sleigh-lift disassemble x86-64.sla 4881ecc00f0000
+
+    - name: Run the tests
+      working-directory: build/sanitize
+      env:
+        ASAN_OPTIONS: "strict_string_checks=1:\
+          detect_stack_use_after_return=1:\
+          check_initialization_order=1:\
+          strict_init_order=1:\
+          detect_leaks=1"
+        UBSAN_OPTIONS: print_stacktrace=1
+      run: ctest -VV
+
   build:
     runs-on: ${{ matrix.os }}
 
@@ -98,6 +158,7 @@ jobs:
       shell: pwsh
       run: cmake "--preset=ci-$("${{ matrix.os }}".split("-")[0])"
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+        -Dsleigh_BUILD_DOCUMENTATION=ON
         -Dsleigh_RELEASE_TYPE=${{ matrix.release }}
 
     - name: Build the project

CMakePresets.json

@@ -26,8 +26,7 @@
       "hidden": true,
       "inherits": "cmake-pedantic",
       "cacheVariables": {
-        "sleigh_DEVELOPER_MODE": "ON",
-        "sleigh_BUILD_DOCUMENTATION": "ON"
+        "sleigh_DEVELOPER_MODE": "ON"
       }
     },
     {

src/patches/HEAD/0001-Fix-UBSAN-errors-in-decompiler.patch

@@ -1,7 +1,7 @@
-From 098585db4fa8c8eb9184851a40ef6706f1d176ed Mon Sep 17 00:00:00 2001
+From 1b5bc985f5abcbd47acd8864983863bd7800c123 Mon Sep 17 00:00:00 2001
 From: Alex Cameron <[email protected]>
 Date: Mon, 7 Feb 2022 02:02:03 +1100
-Subject: [PATCH 1/3] Fix UBSAN errors in decompiler
+Subject: [PATCH 1/5] Fix UBSAN errors in decompiler
 
 ---
  .../Decompiler/src/decompile/cpp/address.cc    |  4 ++--
@@ -42,7 +42,7 @@ index 2eb08b96a..07bf3ba55 100644
    mask <<= 1;
    val &= (~mask);
 diff --git a/Ghidra/Features/Decompiler/src/decompile/cpp/fspec.cc b/Ghidra/Features/Decompiler/src/decompile/cpp/fspec.cc
-index 1402bbd80..4b271e055 100644
+index b30e48298..e4395768f 100644
 --- a/Ghidra/Features/Decompiler/src/decompile/cpp/fspec.cc
 +++ b/Ghidra/Features/Decompiler/src/decompile/cpp/fspec.cc
 @@ -2661,8 +2661,12 @@ void ProtoModelMerged::decode(Decoder &decoder)
@@ -159,7 +159,7 @@ index ca9d71ab9..85d4dd281 100644
    return res;
  }
 diff --git a/Ghidra/Features/Decompiler/src/decompile/cpp/ruleaction.cc b/Ghidra/Features/Decompiler/src/decompile/cpp/ruleaction.cc
-index f11ab8dea..66a0b32fc 100644
+index 4851365d4..d069d1c94 100644
 --- a/Ghidra/Features/Decompiler/src/decompile/cpp/ruleaction.cc
 +++ b/Ghidra/Features/Decompiler/src/decompile/cpp/ruleaction.cc
 @@ -976,7 +976,12 @@ int4 RulePullsubIndirect::applyOp(PcodeOp *op,Funcdata &data)
@@ -176,7 +176,7 @@ index f11ab8dea..66a0b32fc 100644
    consume = ~consume;
    if ((consume & indir->getIn(0)->getConsume())!=0) return 0;
 
-@@ -6778,8 +6783,9 @@ int4 RulePtrsubCharConstant::applyOp(PcodeOp *op,Funcdata &data)
+@@ -6782,8 +6787,9 @@ int4 RulePtrsubCharConstant::applyOp(PcodeOp *op,Funcdata &data)
    Varnode *sb = op->getIn(0);
    Datatype *sbType = sb->getTypeReadFacing(op);
    if (sbType->getMetatype() != TYPE_PTR) return 0;
@@ -188,7 +188,7 @@ index f11ab8dea..66a0b32fc 100644
    Varnode *vn1 = op->getIn(1);
    if (!vn1->isConstant()) return 0;
    Varnode *outvn = op->getOut();
-@@ -8509,7 +8515,11 @@ int4 RuleSubvarSubpiece::applyOp(PcodeOp *op,Funcdata &data)
+@@ -8593,7 +8599,11 @@ int4 RuleSubvarSubpiece::applyOp(PcodeOp *op,Funcdata &data)
    Varnode *outvn = op->getOut();
    int4 flowsize = outvn->getSize();
    uintb mask = calc_mask( flowsize );
@@ -262,10 +262,10 @@ index b308e1b71..af2982aee 100644
  }
 
 diff --git a/Ghidra/Features/Decompiler/src/decompile/cpp/type.cc b/Ghidra/Features/Decompiler/src/decompile/cpp/type.cc
-index f1c0b6452..68de180fc 100644
+index fa02605a6..74f207063 100644
 --- a/Ghidra/Features/Decompiler/src/decompile/cpp/type.cc
 +++ b/Ghidra/Features/Decompiler/src/decompile/cpp/type.cc
-@@ -3296,8 +3296,8 @@ void TypeFactory::recalcPointerSubmeta(Datatype *base,sub_metatype sub)
+@@ -3352,8 +3352,8 @@ void TypeFactory::recalcPointerSubmeta(Datatype *base,sub_metatype sub)
    top.submeta = sub;			// Search on the incorrect submeta
    iter = tree.lower_bound(&top);
    while(iter != tree.end()) {
@@ -289,5 +289,5 @@ index c35bde877..061e53677 100644
          uintb true_result = ((uintb)(int32_t)f) & 0xffffffff;
          uintb encoding = format.getEncoding(f);
 -- 
-2.40.0
+2.40.1
 

src/patches/HEAD/0002-Use-stroull-instead-of-stroul-to-parse-address-offse.patch

@@ -1,7 +1,7 @@
-From a2d412ce5edb750ee1f768a4a7ebfeaece6f7976 Mon Sep 17 00:00:00 2001
+From aa6352010bf7e61f6bd2ebbe59bd3f280e6c3c12 Mon Sep 17 00:00:00 2001
 From: Alex Cameron <[email protected]>
 Date: Wed, 3 Aug 2022 20:01:18 +1000
-Subject: [PATCH 2/3] Use `stroull` instead of `stroul` to parse address
+Subject: [PATCH 2/5] Use `stroull` instead of `stroul` to parse address
  offsets
 
 ---
@@ -34,5 +34,5 @@ index bf4e1dc96..594b4583a 100644
      enddata = (const char *) tmpdata;
      if (enddata - s.c_str() == s.size()) { // If no size or offset override
 -- 
-2.40.0
+2.40.1
 

src/patches/HEAD/0003-Fix-ASAN-initialize-order-fiasco.patch

@@ -0,0 +1,67 @@
+From 24e39c23c92a337cf51310698bfa4ca9e78d9523 Mon Sep 17 00:00:00 2001
+From: Eric Kilmer <[email protected]>
+Date: Wed, 24 May 2023 19:03:25 -0400
+Subject: [PATCH 3/5] Fix ASAN initialize-order-fiasco
+
+Use the "Constructo On First Use" idiom from
+https://en.wikibooks.org/wiki/More_C%2B%2B_Idioms/Construct_On_First_Use
+---
+ Ghidra/Features/Decompiler/src/decompile/cpp/test.cc |  4 +---
+ Ghidra/Features/Decompiler/src/decompile/cpp/test.hh | 10 ++++++++--
+ 2 files changed, 9 insertions(+), 5 deletions(-)
+
+diff --git a/Ghidra/Features/Decompiler/src/decompile/cpp/test.cc b/Ghidra/Features/Decompiler/src/decompile/cpp/test.cc
+index 660f06940..603aaa5bb 100644
+--- a/Ghidra/Features/Decompiler/src/decompile/cpp/test.cc
++++ b/Ghidra/Features/Decompiler/src/decompile/cpp/test.cc
+@@ -18,8 +18,6 @@
+
+ namespace ghidra {
+
+-vector<UnitTest *> UnitTest::tests;
+-
+ /// Run all the tests unless a non-empty set of names is passed in.
+ /// In which case, only the named tests in the set are run.
+ /// \param testNames is the set of names
+@@ -30,7 +28,7 @@ int UnitTest::run(set<string> &testNames)
+   int total = 0;
+   int passed = 0;
+
+-  for(auto &t : UnitTest::tests) {
++  for(auto &t : UnitTest::tests()) {
+     if (testNames.size() > 0 && testNames.find(t->name) == testNames.end()) {
+       continue;
+     }
+diff --git a/Ghidra/Features/Decompiler/src/decompile/cpp/test.hh b/Ghidra/Features/Decompiler/src/decompile/cpp/test.hh
+index 27c27bc21..78d7886a3 100644
+--- a/Ghidra/Features/Decompiler/src/decompile/cpp/test.hh
++++ b/Ghidra/Features/Decompiler/src/decompile/cpp/test.hh
+@@ -53,7 +53,6 @@ typedef void (*testfunc_t)();	///< A unit-test function
+ /// The static run() method calls all the function pointers of all instantiated
+ /// objects.
+ struct UnitTest {
+-  static vector<UnitTest *> tests;		///< The collection of test objects
+   string name;					///< Name of the test
+   testfunc_t func;				///< Call-back function executing the test
+
+@@ -64,9 +63,16 @@ struct UnitTest {
+   UnitTest(const string &name,testfunc_t func) :
+       name(name), func(func)
+   {
+-    tests.push_back(this);
++    tests().push_back(this);
+   }
+
++  /// \brief The collection of test objects
++  static vector<UnitTest *> & tests() {
++    static vector<UnitTest *> tests;
++    return tests;
++  }
++
++
+   static int run(set<string> &testNames);	///< Run all the instantiated tests
+ };
+
+-- 
+2.40.1
+