Enable debug assertions in libstdc++ (#3924)

Adds a jenkins job that will run the unit tests with debug mode with libstdc++. To fix the debug issues I wrapped the instruction_ref in a class(actually reused the class thats used on windows).

Author: pfultz2

Jenkinsfile

@@ -208,16 +208,22 @@ rocmtest clang_debug: rocmnode('mi200+') { cmake_build ->
 //            cmake_build(flags: "-DCMAKE_BUILD_TYPE=release -DMIGRAPHX_USE_HIPRTC=On -DGPU_TARGETS='${gpu_targets}'")
 //        }
 //    }
+}, clang_release_navi: rocmnode('navi32') { cmake_build ->
+    stage('HIP Clang Release Navi32') {
+        def gpu_targets = getnavi3xtargets()
+        cmake_build(flags: "-DCMAKE_BUILD_TYPE=release -DGPU_TARGETS='${gpu_targets}' -DMIGRAPHX_DISABLE_ONNX_TESTS=On")
+    }
 }, clang_asan: rocmnode('nogpu') { cmake_build ->
     stage('Clang ASAN') {
         def sanitizers = "undefined,address"
         def debug_flags = "-g -O2 -fno-omit-frame-pointer -fsanitize=${sanitizers} -fno-sanitize-recover=${sanitizers}"
         cmake_build(flags: "-DCMAKE_BUILD_TYPE=debug -DMIGRAPHX_ENABLE_C_API_TEST=Off -DMIGRAPHX_ENABLE_PYTHON=Off -DMIGRAPHX_ENABLE_GPU=Off -DMIGRAPHX_ENABLE_CPU=On -DCMAKE_CXX_FLAGS_DEBUG='${debug_flags}'", compiler:'/usr/bin/clang++-14')
     }
-}, clang_release_navi: rocmnode('navi32') { cmake_build ->
-    stage('HIP Clang Release Navi32') {
-        def gpu_targets = getnavi3xtargets()
-        cmake_build(flags: "-DCMAKE_BUILD_TYPE=release -DGPU_TARGETS='${gpu_targets}' -DMIGRAPHX_DISABLE_ONNX_TESTS=On")
+}, debub_libstdcxx: rocmnode('nogpu') { cmake_build ->
+    stage('Debug libstdc++') {
+        def sanitizers = "undefined"
+        def debug_flags = "-g -O2 -fno-omit-frame-pointer -fsanitize=${sanitizers} -fno-sanitize-recover=${sanitizers} -D_GLIBCXX_DEBUG"
+        cmake_build(flags: "-DCMAKE_BUILD_TYPE=debug -DMIGRAPHX_ENABLE_C_API_TEST=Off -DMIGRAPHX_ENABLE_PYTHON=Off -DMIGRAPHX_ENABLE_GPU=Off -DMIGRAPHX_ENABLE_CPU=Off -DCMAKE_CXX_FLAGS_DEBUG='${debug_flags}'", compiler:'/usr/bin/clang++-14')
     }
 }
 

src/fuse_concat.cpp

@@ -66,7 +66,7 @@ struct fused_concat
         module_ref post_mod          = mods.back();
         // post_mod has one input argument that is result of concat and will get generated from
         // pre-mods internally. Therefore deduct 1 from post_mod params while asserting.
-        assert(input_iter + post_mod->get_parameter_names().size() - 1 == inputs.end());
+        assert(input_iter + (post_mod->get_parameter_names().size() - 1) == inputs.end());
         auto type                    = std::prev(post_mod->end())->get_shape().type();
         const auto& first_shape_lens = concat_inputs.front().lens();
         auto mismatch_it =

src/include/migraphx/instruction_ref.hpp

@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2015-2023 Advanced Micro Devices, Inc. All rights reserved.
+ * Copyright (c) 2015-2025 Advanced Micro Devices, Inc. All rights reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -33,7 +33,15 @@ namespace migraphx {
 inline namespace MIGRAPHX_INLINE_NS {
 
 struct instruction;
-#if defined(_WIN32) && !defined(NDEBUG) && !defined(CPPCHECK)
+
+MIGRAPHX_EXPORT migraphx::instruction*
+as_address(const std::list<instruction>::iterator& ins) noexcept;
+MIGRAPHX_EXPORT const migraphx::instruction*
+as_address(const std::list<instruction>::const_iterator& ins) noexcept;
+
+#if defined(CPPCHECK)
+using instruction_ref = std::list<instruction>::iterator;
+#else
 struct instruction_ref : std::list<instruction>::iterator
 {
     using instruction_iter       = std::list<instruction>::iterator;
@@ -48,7 +56,7 @@ struct instruction_ref : std::list<instruction>::iterator
                                 std::is_same<U, instruction_ref>{})>
     friend bool operator==(const T& x, const U& y)
     {
-        return x._Unwrapped()._Ptr == y._Unwrapped()._Ptr;
+        return as_address(x) == as_address(y);
     }
 
     template <class T,
@@ -60,18 +68,14 @@ struct instruction_ref : std::list<instruction>::iterator
         return not(x == y);
     }
 };
-#else
-using instruction_ref = std::list<instruction>::iterator;
 #endif
 
-MIGRAPHX_EXPORT migraphx::instruction* as_address(const instruction_ref& ins) noexcept;
-
 } // namespace MIGRAPHX_INLINE_NS
 } // namespace migraphx
 
 namespace std {
 template <>
-struct hash<migraphx::instruction_ref> // NOLINT
+struct hash<migraphx::instruction_ref>
 {
     using argument_type = migraphx::instruction_ref;
     using result_type   = std::size_t;
@@ -81,18 +85,6 @@ struct hash<migraphx::instruction_ref> // NOLINT
     }
 };
 
-template <>
-struct equal_to<migraphx::instruction_ref> // NOLINT
-{
-    using argument_type = migraphx::instruction_ref;
-    using result_type   = bool;
-    result_type operator()(const migraphx::instruction_ref& x,
-                           const migraphx::instruction_ref& y) const noexcept
-    {
-        return migraphx::as_address(x) == migraphx::as_address(y);
-    }
-};
-
 } // namespace std
 
 #ifdef _MSC_VER

src/include/migraphx/iterator.hpp

@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2015-2022 Advanced Micro Devices, Inc. All rights reserved.
+ * Copyright (c) 2015-2025 Advanced Micro Devices, Inc. All rights reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -26,6 +26,7 @@
 
 #include <migraphx/config.hpp>
 #include <migraphx/rank.hpp>
+#include <memory>
 
 namespace migraphx {
 inline namespace MIGRAPHX_INLINE_NS {
@@ -48,6 +49,34 @@ bool is_end(Iterator it, EndIterator last)
     return is_end(rank<2>{}, it, last);
 }
 
+template <class Iterator>
+auto* iterator_address(rank<0>, Iterator it)
+{
+    return std::addressof(*it);
+}
+
+template <class Iterator>
+auto iterator_address(rank<1>, Iterator it) -> decltype(it._M_dereferenceable()
+                                                            ? std::addressof(*it)
+                                                            : nullptr)
+{
+    return it._M_dereferenceable() ? std::addressof(*it) : nullptr;
+}
+
+template <class Iterator>
+auto iterator_address(rank<1>,
+                      Iterator it) -> decltype(std::addressof(it._Unwrapped()._Ptr->_Myval),
+                                               std::addressof(*it))
+{
+    return it._Unwrapped()._Ptr ? std::addressof(it._Unwrapped()._Ptr->_Myval) : nullptr;
+}
+
+template <class Iterator>
+auto* iterator_address(Iterator it)
+{
+    return iterator_address(rank<1>{}, it);
+}
+
 } // namespace MIGRAPHX_INLINE_NS
 } // namespace migraphx
 #endif // MIGRAPHX_GUARD_MIGRAPHX_ITERATOR_HPP

src/include/migraphx/op/name.hpp

@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2015-2022 Advanced Micro Devices, Inc. All rights reserved.
+ * Copyright (c) 2015-2025 Advanced Micro Devices, Inc. All rights reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -26,6 +26,7 @@
 
 #include <migraphx/config.hpp>
 #include <migraphx/type_name.hpp>
+#include <cassert>
 
 namespace migraphx {
 inline namespace MIGRAPHX_INLINE_NS {
@@ -38,6 +39,7 @@ struct op_name
     std::string name() const
     {
         static const std::string& name = get_type_name<Derived>();
+        assert((name.rfind("::") + 2) < name.size());
         return name.substr(name.rfind("::") + 2);
     }
 };

src/instruction.cpp

@@ -27,6 +27,7 @@
 #include <migraphx/module.hpp>
 #include <migraphx/ranges.hpp>
 #include <migraphx/output_iterator.hpp>
+#include <migraphx/iterator.hpp>
 #include <queue>
 
 namespace migraphx {
@@ -543,9 +544,14 @@ std::vector<shape> try_compute_shape(const operation& op, const std::vector<shap
     return {new_shape};
 }
 
-migraphx::instruction* as_address(const instruction_ref& ins) noexcept
+migraphx::instruction* as_address(const std::list<instruction>::iterator& ins) noexcept
 {
-    return std::addressof(*ins);
+    return iterator_address(ins);
+}
+
+const migraphx::instruction* as_address(const std::list<instruction>::const_iterator& ins) noexcept
+{
+    return iterator_address(ins);
 }
 
 // DFS through inputs of `end` to find `start`.

test/tf/tests/assert_less_equal_test.cpp

@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2015-2024 Advanced Micro Devices, Inc. All rights reserved.
+ * Copyright (c) 2015-2025 Advanced Micro Devices, Inc. All rights reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -25,6 +25,8 @@
 
 #include <tf_test.hpp>
 
+// Skip this test for libstdc++ debug for now since it exposes a bug in protobuf
+#ifndef _GLIBCXX_DEBUG
 TEST_CASE(assert_less_equal_test)
 {
     migraphx::program p;
@@ -42,3 +44,4 @@ TEST_CASE(assert_less_equal_test)
 
     EXPECT(p == prog);
 }
+#endif