Replace NDEBUG with custom flags to avoid ABI issues (#1796)

dartsim · Mar 24, 2024 · 8931e2c · 8931e2c
1 parent a51e08c
commit 8931e2c
Show file tree

Hide file tree

Showing 49 changed files with 2,518 additions and 2,100 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -141,19 +141,17 @@ if(NOT CMAKE_BUILD_TYPE)
 endif()
 string(TOUPPER ${CMAKE_BUILD_TYPE} CMAKE_BUILD_TYPE_UPPERCASE)
 
-set(BUILD_TYPE_DEBUG FALSE)
-set(BUILD_TYPE_RELEASE FALSE)
-set(BUILD_TYPE_RELWITHDEBINFO FALSE)
-set(BUILD_TYPE_MINSIZEREL FALSE)
+set(DART_BUILD_MODE_DEBUG FALSE)
+set(DART_BUILD_MODE_RELEASE FALSE)
 
 if("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "DEBUG")
-  set(BUILD_TYPE_DEBUG TRUE)
+  set(DART_BUILD_MODE_DEBUG TRUE)
 elseif("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "RELEASE")
-  set(BUILD_TYPE_RELEASE TRUE)
+  set(DART_BUILD_MODE_RELEASE TRUE)
 elseif("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "RELWITHDEBINFO")
-  set(BUILD_TYPE_RELWITHDEBINFO TRUE)
+  set(DART_BUILD_MODE_RELEASE TRUE)
 elseif("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "MINSIZEREL")
-  set(BUILD_TYPE_MINSIZEREL TRUE)
+  set(DART_BUILD_MODE_RELEASE TRUE)
 else()
   message(WARNING "CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} unknown. Valid options are: Debug | Release | RelWithDebInfo | MinSizeRel")
 endif()
@@ -167,14 +165,14 @@ endif()
 # - ERROR: To enable log with DART_ERROR() and below
 # - FATAL: To enable log with DART_FATAL()
 # - OFF: To turn off all the logs
-if(BUILD_TYPE_DEBUG)
+if(DART_BUILD_MODE_DEBUG)
   set(DART_ACTIVE_LOG_LEVEL "DEBUG" CACHE STRING "Compile time active log level to enable")
 else()
   set(DART_ACTIVE_LOG_LEVEL "INFO" CACHE STRING "Compile time active log level to enable")
 endif()
 set_property(CACHE DART_ACTIVE_LOG_LEVEL PROPERTY STRINGS TRACE DEBUG INFO WARN ERROR FATAL OFF)
 
-if(BUILD_TYPE_DEBUG)
+if(DART_BUILD_MODE_DEBUG)
   option(DART_TREAT_WARNINGS_AS_ERRORS "Treat warnings as errors" OFF)
 else()
   option(DART_TREAT_WARNINGS_AS_ERRORS "Treat warnings as errors" ON)

diff --git a/dart/collision/Option.hpp b/dart/collision/Option.hpp
@@ -35,7 +35,7 @@
 
 #pragma message(                                                               \
     "This header has been deprecated in DART 6.1. "                            \
-    "Please include CollisionOption.hpp intead.")
+    "Please include CollisionOption.hpp instead.")
 
 #include "dart/collision/CollisionOption.hpp"
 

diff --git a/dart/collision/Result.hpp b/dart/collision/Result.hpp
@@ -35,7 +35,7 @@
 
 #pragma message(                                                               \
     "This header has been deprecated in DART 6.1. "                            \
-    "Please include CollisionResult.hpp intead.")
+    "Please include CollisionResult.hpp instead.")
 
 #include "dart/collision/CollisionResult.hpp"
 

diff --git a/dart/common/FreeListAllocator.cpp b/dart/common/FreeListAllocator.cpp
@@ -395,7 +395,7 @@ void FreeListAllocator::MemoryBlockHeader::merge(MemoryBlockHeader* other)
 }
 
 //==============================================================================
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
 bool FreeListAllocator::MemoryBlockHeader::isValid() const
 {
   if (mPrev != nullptr && mPrev->mNext != this)

diff --git a/dart/common/FreeListAllocator.hpp b/dart/common/FreeListAllocator.hpp
@@ -126,7 +126,7 @@ class FreeListAllocator : public MemoryAllocator
     /// Merges this memory block with the given memory block
     void merge(MemoryBlockHeader* other);
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
     /// [Debug only] Returns whether this memory block is valid
     bool isValid() const;
 #endif

diff --git a/dart/common/Macros.hpp b/dart/common/Macros.hpp
@@ -36,6 +36,7 @@
 #include <cassert>
 
 #include "dart/common/Logging.hpp"
+#include "dart/config.hpp"
 
 // DART_NUM_ARGS(<arg1> [, <arg2> [, ...]])
 #define DETAIL_DART_NUM_ARGS(z, a, b, c, d, e, f, cnt, ...) cnt
@@ -68,7 +69,7 @@
 #define DETAIL_DART_ASSERT_2(condition, message) assert((condition) && #message)
 #define DART_ASSERT(...)                                                       \
   DART_CONCAT(DETAIL_DART_ASSERT_, DART_NUM_ARGS(__VA_ARGS__))                 \
-  (__VA_ARGS__)
+      (__VA_ARGS__)
 
 // Macro to mark the function is not implemented
 #define DART_NOT_IMPLEMENTED                                                   \

diff --git a/dart/common/MemoryAllocator.hpp b/dart/common/MemoryAllocator.hpp
@@ -38,6 +38,7 @@
 #include <string>
 
 #include "dart/common/Castable.hpp"
+#include "dart/config.hpp"
 
 namespace dart::common {
 

diff --git a/dart/common/MemoryManager.cpp b/dart/common/MemoryManager.cpp
@@ -32,7 +32,7 @@
 
 #include "dart/common/MemoryManager.hpp"
 
-#ifndef NDEBUG // debug
+#if DART_BUILD_MODE_DEBUG
   #include "dart/common/Logging.hpp"
 #endif
 
@@ -49,7 +49,7 @@ MemoryManager& MemoryManager::GetDefault()
 MemoryManager::MemoryManager(MemoryAllocator& baseAllocator)
   : mBaseAllocator(baseAllocator),
     mFreeListAllocator(mBaseAllocator),
-#ifdef NDEBUG
+#if DART_BUILD_MODE_RELEASE
     mPoolAllocator(mFreeListAllocator)
 #else
     mPoolAllocator(mFreeListAllocator.getInternalAllocator())
@@ -73,7 +73,7 @@ MemoryAllocator& MemoryManager::getBaseAllocator()
 //==============================================================================
 FreeListAllocator& MemoryManager::getFreeListAllocator()
 {
-#ifdef NDEBUG
+#if DART_BUILD_MODE_RELEASE
   return mFreeListAllocator;
 #else
   return mFreeListAllocator.getInternalAllocator();
@@ -83,7 +83,7 @@ FreeListAllocator& MemoryManager::getFreeListAllocator()
 //==============================================================================
 PoolAllocator& MemoryManager::getPoolAllocator()
 {
-#ifdef NDEBUG
+#if DART_BUILD_MODE_RELEASE
   return mPoolAllocator;
 #else
   return mPoolAllocator.getInternalAllocator();
@@ -146,7 +146,7 @@ void MemoryManager::deallocateUsingPool(void* pointer, size_t bytes)
   deallocate(Type::Pool, pointer, bytes);
 }
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
 //==============================================================================
 bool MemoryManager::hasAllocated(void* pointer, size_t size) const noexcept
 {

diff --git a/dart/common/MemoryManager.hpp b/dart/common/MemoryManager.hpp
@@ -33,7 +33,7 @@
 #ifndef DART_COMMON_MEMORYMANAGER_HPP_
 #define DART_COMMON_MEMORYMANAGER_HPP_
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
   #include <mutex>
 #endif
 #include <iostream>
@@ -151,7 +151,7 @@ class MemoryManager final
   template <typename T>
   void destroyUsingPool(T* pointer) noexcept;
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
   /// Returns true if a pointer is allocated by the internal allocator.
   [[nodiscard]] bool hasAllocated(void* pointer, size_t size) const noexcept;
 #endif
@@ -164,10 +164,10 @@ class MemoryManager final
       std::ostream& os, const MemoryManager& memoryManager);
 
 private:
-  /// The base allocator to allocate memory chunck.
+  /// The base allocator to allocate memory chunk.
   MemoryAllocator& mBaseAllocator;
 
-#ifdef NDEBUG
+#if DART_BUILD_MODE_RELEASE
   /// The free list allocator.
   FreeListAllocator mFreeListAllocator;
 

diff --git a/dart/config.hpp.in b/dart/config.hpp.in
@@ -44,10 +44,9 @@
   #define DART_COMPILER_MSVC
 #endif
 
-#cmakedefine01 BUILD_TYPE_DEBUG
-#cmakedefine01 BUILD_TYPE_RELEASE
-#cmakedefine01 BUILD_TYPE_RELWITHDEBINFO
-#cmakedefine01 BUILD_TYPE_MINSIZEREL
+// Indicates the build mode used for compiling
+#cmakedefine01 DART_BUILD_MODE_DEBUG
+#cmakedefine01 DART_BUILD_MODE_RELEASE
 
 #cmakedefine01 HAVE_NLOPT
 #cmakedefine01 HAVE_IPOPT

diff --git a/dart/constraint/BoxedLcpConstraintSolver.cpp b/dart/constraint/BoxedLcpConstraintSolver.cpp
@@ -33,7 +33,7 @@
 #include "dart/constraint/BoxedLcpConstraintSolver.hpp"
 
 #include <cassert>
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
   #include <iomanip>
   #include <iostream>
 #endif
@@ -155,7 +155,7 @@ void BoxedLcpConstraintSolver::solveConstrainedGroup(ConstrainedGroup& group)
     return;
 
   const int nSkip = dPAD(n);
-#ifdef NDEBUG // release
+#if DART_BUILD_MODE_RELEASE
   mA.resize(n, nSkip);
 #else // debug
   mA.setZero(n, nSkip);
@@ -310,7 +310,7 @@ void BoxedLcpConstraintSolver::solveConstrainedGroup(ConstrainedGroup& group)
 }
 
 //==============================================================================
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
 bool BoxedLcpConstraintSolver::isSymmetric(std::size_t n, double* A)
 {
   std::size_t nSkip = dPAD(n);

diff --git a/dart/constraint/BoxedLcpConstraintSolver.hpp b/dart/constraint/BoxedLcpConstraintSolver.hpp
@@ -154,12 +154,12 @@ class BoxedLcpConstraintSolver : public ConstraintSolver
   /// Cache data for boxed LCP formulation
   Eigen::VectorXi mOffset;
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
 private:
   /// Return true if the matrix is symmetric
   bool isSymmetric(std::size_t n, double* A);
 
-  /// Return true if the diagonla block of matrix is symmetric
+  /// Return true if the diagonal block of matrix is symmetric
   bool isSymmetric(
       std::size_t n, double* A, std::size_t begin, std::size_t end);
 

diff --git a/dart/constraint/BoxedLcpSolver.hpp b/dart/constraint/BoxedLcpSolver.hpp
@@ -88,7 +88,7 @@ class BoxedLcpSolver : public common::Castable<BoxedLcpSolver>
       bool earlyTermination = false)
       = 0;
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
   virtual bool canSolve(int n, const double* A) = 0;
 #endif
 };

diff --git a/dart/constraint/ConstrainedGroup.cpp b/dart/constraint/ConstrainedGroup.cpp
@@ -101,7 +101,7 @@ void ConstrainedGroup::removeAllConstraints()
 }
 
 //==============================================================================
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
 bool ConstrainedGroup::containConstraint(
     const ConstConstraintBasePtr& _constraint) const
 {

diff --git a/dart/constraint/ConstrainedGroup.hpp b/dart/constraint/ConstrainedGroup.hpp
@@ -38,6 +38,7 @@
 
 #include <Eigen/Dense>
 
+#include "dart/config.hpp"
 #include "dart/constraint/SmartPointer.hpp"
 
 namespace dart {
@@ -100,7 +101,7 @@ class ConstrainedGroup
   friend class ConstraintSolver;
 
 private:
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
   /// Return true if _constraint is contained
   bool containConstraint(const ConstConstraintBasePtr& _constraint) const;
 #endif

diff --git a/dart/constraint/DantzigBoxedLcpSolver.cpp b/dart/constraint/DantzigBoxedLcpSolver.cpp
@@ -66,7 +66,7 @@ bool DantzigBoxedLcpSolver::solve(
       n, A, x, b, nullptr, 0, lo, hi, findex, earlyTermination);
 }
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
 //==============================================================================
 bool DantzigBoxedLcpSolver::canSolve(int /*n*/, const double* /*A*/)
 {

diff --git a/dart/constraint/DantzigBoxedLcpSolver.hpp b/dart/constraint/DantzigBoxedLcpSolver.hpp
@@ -59,7 +59,7 @@ class DantzigBoxedLcpSolver : public BoxedLcpSolver
       int* findex,
       bool earlyTermination) override;
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
   // Documentation inherited.
   bool canSolve(int n, const double* A) override;
 #endif

diff --git a/dart/constraint/DantzigLCPSolver.cpp b/dart/constraint/DantzigLCPSolver.cpp
@@ -32,7 +32,7 @@
 
 #include "dart/constraint/DantzigLCPSolver.hpp"
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
   #include <iomanip>
   #include <iostream>
 #endif
@@ -79,7 +79,7 @@ void DantzigLCPSolver::solve(ConstrainedGroup* _group)
   int* findex = new int[n];
 
   // Set w to 0 and findex to -1
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
   std::memset(A, 0.0, n * nSkip * sizeof(double));
 #endif
   std::memset(w, 0.0, n * sizeof(double));
@@ -189,7 +189,7 @@ void DantzigLCPSolver::solve(ConstrainedGroup* _group)
 }
 
 //==============================================================================
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
 bool DantzigLCPSolver::isSymmetric(std::size_t _n, double* _A)
 {
   std::size_t nSkip = dPAD(_n);

diff --git a/dart/constraint/DantzigLCPSolver.hpp b/dart/constraint/DantzigLCPSolver.hpp
@@ -42,7 +42,7 @@ namespace dart {
 namespace constraint {
 
 /// \deprecated This header has been deprecated in DART 6.7. Please include
-/// DantzigBoxedLcpSolver.hpp intead.
+/// DantzigBoxedLcpSolver.hpp instead.
 ///
 /// DantzigLCPSolver is a LCP solver that uses ODE's implementation of Dantzig
 /// algorithm
@@ -58,12 +58,12 @@ class DantzigLCPSolver : public LCPSolver
   // Documentation inherited
   void solve(ConstrainedGroup* _group) override;
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
 private:
   /// Return true if the matrix is symmetric
   bool isSymmetric(std::size_t _n, double* _A);
 
-  /// Return true if the diagonla block of matrix is symmetric
+  /// Return true if the diagonal block of matrix is symmetric
   bool isSymmetric(
       std::size_t _n, double* _A, std::size_t _begin, std::size_t _end);
 

diff --git a/dart/constraint/JointConstraint.cpp b/dart/constraint/JointConstraint.cpp
@@ -403,7 +403,7 @@ void JointConstraint::getInformation(ConstraintInfo* lcp)
     if (!mActive[i])
       continue;
 
-#ifndef NDEBUG // debug
+#if DART_BUILD_MODE_DEBUG
     if (std::abs(lcp->w[index]) > 1e-6)
     {
       dterr << "Invalid " << index
@@ -418,7 +418,7 @@ void JointConstraint::getInformation(ConstraintInfo* lcp)
     lcp->lo[index] = mImpulseLowerBound[i];
     lcp->hi[index] = mImpulseUpperBound[i];
 
-#ifndef NDEBUG // debug
+#if DART_BUILD_MODE_DEBUG
     if (lcp->findex[index] != -1)
     {
       dterr << "Invalid " << index

diff --git a/dart/constraint/JointLimitConstraint.cpp b/dart/constraint/JointLimitConstraint.cpp
@@ -312,7 +312,7 @@ void JointLimitConstraint::getInformation(ConstraintInfo* lcp)
       lcp->lo[index] = mLowerBound[i];
       lcp->hi[index] = mUpperBound[i];
 
-#ifndef NDEBUG // Debug mode
+#if DART_BUILD_MODE_DEBUG
       if (lcp->lo[index] > lcp->hi[index])
       {
         std::cout << "dim: " << mDim << std::endl;

diff --git a/dart/constraint/PGSLCPSolver.cpp b/dart/constraint/PGSLCPSolver.cpp
@@ -32,7 +32,7 @@
 
 #include "dart/constraint/PGSLCPSolver.hpp"
 
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
   #include <iomanip>
   #include <iostream>
 #endif
@@ -72,7 +72,7 @@ void PGSLCPSolver::solve(ConstrainedGroup* _group)
   int* findex = new int[n];
 
   // Set w to 0 and findex to -1
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
   std::memset(A, 0.0, n * nSkip * sizeof(double));
 #endif
   std::memset(w, 0.0, n * sizeof(double));
@@ -185,7 +185,7 @@ void PGSLCPSolver::solve(ConstrainedGroup* _group)
 }
 
 //==============================================================================
-#ifndef NDEBUG
+#if DART_BUILD_MODE_DEBUG
 bool PGSLCPSolver::isSymmetric(std::size_t _n, double* _A)
 {
   std::size_t nSkip = dPAD(_n);