Fixes some tests/bugs, and adds a build with sanitizers, add ASAN CI run

.github/workflows/c-cpp.yml

@@ -135,6 +135,80 @@ jobs:
     - name: Run test suite on SPR
       run: sde -spr -- ./builddir/testexe
 
+  ADL-ASAN-clang18:
+
+    runs-on: intel-ubuntu-24.04
+
+    steps:
+    - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+    - name: Install dependencies
+      run: |
+        sudo apt update
+        sudo apt -y install clang-18 libomp-18-dev libgtest-dev meson curl git
+
+    - name: Install Intel SDE
+      run: |
+        curl -o /tmp/sde.tar.xz https://downloadmirror.intel.com/784319/sde-external-9.24.0-2023-07-13-lin.tar.xz
+        mkdir /tmp/sde && tar -xvf /tmp/sde.tar.xz -C /tmp/sde/
+        sudo mv /tmp/sde/* /opt/sde && sudo ln -s /opt/sde/sde64 /usr/bin/sde
+
+    - name: Build examples
+      env:
+        CXX: clang++-18
+      run: |
+        cd examples
+        make all
+
+    - name: Build
+      env:
+        CXX: clang++-18
+      run: |
+        make clean
+        meson setup -Dbuild_tests=true -Duse_openmp=true -Db_sanitize=address,undefined -Dfatal_sanitizers=true  -Dasan_ci_dont_validate=true -Db_lundef=false --warnlevel 0 --buildtype release builddir
+        cd builddir
+        ninja
+
+    - name: Run test suite on SPR
+      run: sde -adl -- ./builddir/testexe
+
+  SPR-ASAN-clang18:
+
+    runs-on: intel-ubuntu-24.04
+
+    steps:
+    - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+    - name: Install dependencies
+      run: |
+        sudo apt update
+        sudo apt -y install clang-18 libomp-18-dev libgtest-dev meson curl git
+
+    - name: Install Intel SDE
+      run: |
+        curl -o /tmp/sde.tar.xz https://downloadmirror.intel.com/784319/sde-external-9.24.0-2023-07-13-lin.tar.xz
+        mkdir /tmp/sde && tar -xvf /tmp/sde.tar.xz -C /tmp/sde/
+        sudo mv /tmp/sde/* /opt/sde && sudo ln -s /opt/sde/sde64 /usr/bin/sde
+
+    - name: Build examples
+      env:
+        CXX: clang++-18
+      run: |
+        cd examples
+        make all
+
+    - name: Build
+      env:
+        CXX: clang++-18
+      run: |
+        make clean
+        meson setup -Dbuild_tests=true -Duse_openmp=true -Db_sanitize=address,undefined -Dfatal_sanitizers=true  -Dasan_ci_dont_validate=true -Db_lundef=false --warnlevel 0 --buildtype release builddir
+        cd builddir
+        ninja
+
+    - name: Run test suite on SPR
+      run: sde -spr -- ./builddir/testexe
+
   SKX-SKL-openmp:
 
     runs-on: intel-ubuntu-24.04

Makefile

@@ -6,6 +6,10 @@ test_openmp:
 	meson setup -Dbuild_tests=true -Duse_openmp=true --warnlevel 2 --werror --buildtype release builddir
 	cd builddir && ninja
 
+test_asan:
+	meson setup -Dbuild_tests=true -Duse_openmp=true -Db_sanitize=address,undefined -Dfatal_sanitizers=true -Db_lundef=false -Dasan_ci_dont_validate=true --warnlevel 0 --buildtype debugoptimized builddir
+	cd builddir && ninja
+
 bench:
 	meson setup -Dbuild_benchmarks=true --warnlevel 2 --werror --buildtype release builddir
 	cd builddir && ninja

meson.build

@@ -18,6 +18,11 @@ if get_option('build_ippbench')
   ipplink = ['-lipps', '-lippcore']
 endif
 
+# Essentially '-Werror' for the sanitizers; all problems become fatal with this set
+if get_option('fatal_sanitizers')
+  add_project_arguments([ '-fno-sanitize-recover=all' ], language: 'cpp')
+endif
+
 # Add google vqsort to benchmarks:
 benchvq = false
 if get_option('build_vqsortbench')

meson_options.txt

@@ -10,4 +10,7 @@ option('use_openmp', type : 'boolean', value : false,
   description : 'Use OpenMP to accelerate key-value sort (default: "false").')
 option('lib_type', type : 'string', value : 'shared',
   description : 'Library type: shared or static (default: "shared").')
-
+option('fatal_sanitizers', type : 'boolean', value : 'false',
+  description : 'If sanitizers are enabled, should all issues be considered fatal? (default: "false").')
+option('asan_ci_dont_validate', type : 'boolean', value : 'false',
+  description : 'Only for speeding up ASAN CI, do not turn on otherwise')

src/xss-common-qsort.h

@@ -649,6 +649,9 @@ xss_qselect(T *arr, arrsize_t k, arrsize_t arrsize, bool hasnan)
                                       Comparator<vtype, true>,
                                       Comparator<vtype, false>>::type;
 
+    // Exit early if no work would be done
+    if (arrsize <= 1) return;
+
     arrsize_t index_first_elem = 0;
     arrsize_t index_last_elem = arrsize - 1;
 

tests/meson.build

@@ -1,19 +1,33 @@
 libtests = []
 
+# Add compile flags when needed for the ASAN CI run
+testargs = []
+if get_option('asan_ci_dont_validate')
+  if get_option('fatal_sanitizers')
+    testargs = ['-DXSS_ASAN_CI_NOCHECK=true']
+  else
+    error('asan_ci_dont_validate is only for the ASAN CI, should be false otherwise!')
+  endif
+endif
+
+
 libtests += static_library('tests_qsort',
   files('test-qsort.cpp', ),
   dependencies: gtest_dep,
   include_directories : [src, lib, utils],
+  cpp_args : [testargs],
   )
 
 libtests += static_library('tests_kvsort',
   files('test-keyvalue.cpp', ),
   dependencies: gtest_dep,
   include_directories : [src, lib, utils],
+  cpp_args : [testargs],
   )
 
 libtests += static_library('tests_objsort',
   files('test-objqsort.cpp', ),
   dependencies: gtest_dep,
   include_directories : [src, lib, utils],
+  cpp_args : [testargs],
   )

tests/test-keyvalue.cpp

@@ -14,7 +14,7 @@ class simdkvsort : public ::testing::Test {
 public:
     simdkvsort()
     {
-        std::iota(arrsize.begin(), arrsize.end(), 1);
+        std::iota(arrsize.begin(), arrsize.end(), 0);
         arrsize.push_back(10'000);
         arrsize.push_back(100'000);
         arrsize.push_back(1'000'000);
@@ -58,6 +58,9 @@ bool is_kv_sorted(
 {
     auto cmp_eq = compare<T1, std::equal_to<T1>>();
 
+    // Always true for arrays of zero length
+    if (size == 0) return true;
+
     // First check keys are exactly identical
     for (size_t i = 0; i < size; i++) {
         if (!cmp_eq(keys_comp[i], keys_ref[i])) { return false; }
@@ -173,8 +176,10 @@ TYPED_TEST_P(simdkvsort, test_kvsort_ascending)
             std::vector<T2> val = get_array<T2>(type, size);
             std::vector<T1> key_bckp = key;
             std::vector<T2> val_bckp = val;
+
             x86simdsort::keyvalue_qsort(
                     key.data(), val.data(), size, hasnan, false);
+#ifndef XSS_ASAN_CI_NOCHECK
             xss::scalar::keyvalue_qsort(
                     key_bckp.data(), val_bckp.data(), size, hasnan, false);
 
@@ -184,7 +189,7 @@ TYPED_TEST_P(simdkvsort, test_kvsort_ascending)
                                                       val_bckp.data(),
                                                       size);
             ASSERT_EQ(is_kv_sorted_, true);
-
+#endif
             key.clear();
             val.clear();
             key_bckp.clear();
@@ -204,8 +209,10 @@ TYPED_TEST_P(simdkvsort, test_kvsort_descending)
             std::vector<T2> val = get_array<T2>(type, size);
             std::vector<T1> key_bckp = key;
             std::vector<T2> val_bckp = val;
+
             x86simdsort::keyvalue_qsort(
                     key.data(), val.data(), size, hasnan, true);
+#ifndef XSS_ASAN_CI_NOCHECK
             xss::scalar::keyvalue_qsort(
                     key_bckp.data(), val_bckp.data(), size, hasnan, true);
 
@@ -215,7 +222,7 @@ TYPED_TEST_P(simdkvsort, test_kvsort_descending)
                                                       val_bckp.data(),
                                                       size);
             ASSERT_EQ(is_kv_sorted_, true);
-
+#endif
             key.clear();
             val.clear();
             key_bckp.clear();
@@ -232,19 +239,21 @@ TYPED_TEST_P(simdkvsort, test_kvselect_ascending)
     for (auto type : this->arrtype) {
         bool hasnan = is_nan_test(type);
         for (auto size : this->arrsize) {
-            size_t k = rand() % size;
+            size_t k = size != 0 ? rand() % size : 0;
 
             std::vector<T1> key = get_array<T1>(type, size);
             std::vector<T2> val = get_array<T2>(type, size);
             std::vector<T1> key_bckp = key;
             std::vector<T2> val_bckp = val;
 
+            x86simdsort::keyvalue_select(
+                    key.data(), val.data(), k, size, hasnan, false);
+#ifndef XSS_ASAN_CI_NOCHECK
             xss::scalar::keyvalue_qsort(
                     key_bckp.data(), val_bckp.data(), size, hasnan, false);
 
             // Test select by using it as part of partial_sort
-            x86simdsort::keyvalue_select(
-                    key.data(), val.data(), k, size, hasnan, false);
+            if (size == 0) continue;
             IS_ARR_PARTITIONED<T1>(key, k, key_bckp[k], type);
             xss::scalar::keyvalue_qsort(
                     key.data(), val.data(), k, hasnan, false);
@@ -259,7 +268,7 @@ TYPED_TEST_P(simdkvsort, test_kvselect_ascending)
                                                   size,
                                                   k);
             ASSERT_EQ(is_kv_partialsorted_, true);
-
+#endif
             key.clear();
             val.clear();
             key_bckp.clear();
@@ -276,19 +285,21 @@ TYPED_TEST_P(simdkvsort, test_kvselect_descending)
     for (auto type : this->arrtype) {
         bool hasnan = is_nan_test(type);
         for (auto size : this->arrsize) {
-            size_t k = rand() % size;
+            size_t k = size != 0 ? rand() % size : 0;
 
             std::vector<T1> key = get_array<T1>(type, size);
             std::vector<T2> val = get_array<T2>(type, size);
             std::vector<T1> key_bckp = key;
             std::vector<T2> val_bckp = val;
 
+            x86simdsort::keyvalue_select(
+                    key.data(), val.data(), k, size, hasnan, true);
+#ifndef XSS_ASAN_CI_NOCHECK
             xss::scalar::keyvalue_qsort(
                     key_bckp.data(), val_bckp.data(), size, hasnan, true);
 
             // Test select by using it as part of partial_sort
-            x86simdsort::keyvalue_select(
-                    key.data(), val.data(), k, size, hasnan, true);
+            if (size == 0) continue;
             IS_ARR_PARTITIONED<T1>(key, k, key_bckp[k], type, true);
             xss::scalar::keyvalue_qsort(
                     key.data(), val.data(), k, hasnan, true);
@@ -303,7 +314,7 @@ TYPED_TEST_P(simdkvsort, test_kvselect_descending)
                                                   size,
                                                   k);
             ASSERT_EQ(is_kv_partialsorted_, true);
-
+#endif
             key.clear();
             val.clear();
             key_bckp.clear();
@@ -319,14 +330,17 @@ TYPED_TEST_P(simdkvsort, test_kvpartial_sort_ascending)
     for (auto type : this->arrtype) {
         bool hasnan = is_nan_test(type);
         for (auto size : this->arrsize) {
-            size_t k = rand() % size;
+            size_t k = size != 0 ? rand() % size : 0;
 
             std::vector<T1> key = get_array<T1>(type, size);
             std::vector<T2> val = get_array<T2>(type, size);
             std::vector<T1> key_bckp = key;
             std::vector<T2> val_bckp = val;
+
             x86simdsort::keyvalue_partial_sort(
                     key.data(), val.data(), k, size, hasnan, false);
+#ifndef XSS_ASAN_CI_NOCHECK
+            if (size == 0) continue;
             xss::scalar::keyvalue_qsort(
                     key_bckp.data(), val_bckp.data(), size, hasnan, false);
 
@@ -340,7 +354,7 @@ TYPED_TEST_P(simdkvsort, test_kvpartial_sort_ascending)
                                                   size,
                                                   k);
             ASSERT_EQ(is_kv_partialsorted_, true);
-
+#endif
             key.clear();
             val.clear();
             key_bckp.clear();
@@ -356,14 +370,17 @@ TYPED_TEST_P(simdkvsort, test_kvpartial_sort_descending)
     for (auto type : this->arrtype) {
         bool hasnan = is_nan_test(type);
         for (auto size : this->arrsize) {
-            size_t k = rand() % size;
+            size_t k = size != 0 ? rand() % size : 0;
 
             std::vector<T1> key = get_array<T1>(type, size);
             std::vector<T2> val = get_array<T2>(type, size);
             std::vector<T1> key_bckp = key;
             std::vector<T2> val_bckp = val;
+
             x86simdsort::keyvalue_partial_sort(
                     key.data(), val.data(), k, size, hasnan, true);
+#ifndef XSS_ASAN_CI_NOCHECK
+            if (size == 0) continue;
             xss::scalar::keyvalue_qsort(
                     key_bckp.data(), val_bckp.data(), size, hasnan, true);
 
@@ -377,7 +394,7 @@ TYPED_TEST_P(simdkvsort, test_kvpartial_sort_descending)
                                                   size,
                                                   k);
             ASSERT_EQ(is_kv_partialsorted_, true);
-
+#endif
             key.clear();
             val.clear();
             key_bckp.clear();

tests/test-objqsort.cpp

@@ -25,7 +25,7 @@ class simdobjsort : public ::testing::Test {
 public:
     simdobjsort()
     {
-        std::iota(arrsize.begin(), arrsize.end(), 1);
+        std::iota(arrsize.begin(), arrsize.end(), 0);
         arrtype = {"random",
                    "constant",
                    "sorted",

tests/test-qsort-common.h

@@ -29,6 +29,7 @@ inline bool is_nan_test(std::string type)
 template <typename T>
 void IS_SORTED(std::vector<T> sorted, std::vector<T> arr, std::string type)
 {
+    if (arr.size() == 0) return;
     if (memcmp(arr.data(), sorted.data(), arr.size() * sizeof(T)) != 0) {
         REPORT_FAIL("Array not sorted", arr.size(), type, -1);
     }