[#390] Add UBSAN

CMakeLists.txt

@@ -74,13 +74,41 @@ if (IRODS_ENABLE_ADDRESS_SANITIZER)
   # detect_container_overflow is disabled to guard against false positives which occur when
   # parts of the binary are compiled with ASAN and other parts are not.
   add_compile_definitions(IRODS_ADDRESS_SANITIZER_DEFAULT_OPTIONS="log_path=/tmp/irods_client_http_api_asan_output:detect_container_overflow=0")
+  add_compile_options(-fsanitize=address)
+  add_link_options(-fsanitize=address)
+endif()
+
+option(IRODS_ENABLE_UNDEFINED_BEHAVIOR_SANITIZER "Enables detection of undefined behavior provided by Undefined Behavior Sanitizer." OFF)
+if (IRODS_ENABLE_UNDEFINED_BEHAVIOR_SANITIZER)
+  # Make sure the correct llvm-symbolizer binary is available to Undefined Behavior Sanitizer. This binary
+  # allows debug symbols to be reported appropriately. Additionally, set options for logging.
+  #
+  #     export PATH=/opt/irods-externals/clang13.0.1-0/bin:$PATH
+  add_compile_definitions(IRODS_UNDEFINED_BEHAVIOR_SANITIZER_DEFAULT_OPTIONS="log_path=/tmp/irods_client_http_api_ubsan_output")
+
+  add_compile_options(
+    -fsanitize=undefined
+    -fsanitize=float-divide-by-zero
+    -fsanitize=unsigned-integer-overflow
+    -fsanitize=implicit-conversion
+    -fsanitize=local-bounds
+    -fsanitize=nullability
+    -fsanitize-ignorelist=${CMAKE_CURRENT_SOURCE_DIR}/ub-sanitizer-ignorelist.txt)
+  add_link_options(
+    -fsanitize=undefined
+    -fsanitize=float-divide-by-zero
+    -fsanitize=unsigned-integer-overflow
+    -fsanitize=implicit-conversion
+    -fsanitize=local-bounds
+    -fsanitize=nullability)
+endif()
+
+if (IRODS_ENABLE_ADDRESS_SANITIZER OR IRODS_ENABLE_UNDEFINED_BEHAVIOR_SANITIZER)
   add_compile_options(
-    -fsanitize=address
     -fno-omit-frame-pointer
     -fno-optimize-sibling-calls
     -O1)
   add_link_options(
-    -fsanitize=address
     -fno-omit-frame-pointer
     -fno-optimize-sibling-calls
     -O1)

core/src/main.cpp

@@ -71,6 +71,14 @@ extern "C" const char* __asan_default_options()
 } // __asan_default_options
 #endif
 
+#if __has_feature(undefined_behavior_sanitizer)
+extern "C" const char* __ubsan_default_options()
+{
+	// See root CMakeLists.txt file for definition.
+	return IRODS_UNDEFINED_BEHAVIOR_SANITIZER_DEFAULT_OPTIONS;
+} // __ubsan_default_options
+#endif
+
 // clang-format off
 namespace beast   = boost::beast; // from <boost/beast.hpp>
 namespace net     = boost::asio;  // from <boost/asio.hpp>

ub-sanitizer-ignorelist.txt

@@ -0,0 +1,7 @@
+[unsigned-integer-overflow]
+src:/opt/irods-externals/boost*/include/boost/beast/http/impl/field.ipp
+src:/opt/irods-externals/boost*/include/boost/beast/core/impl/string.ipp
+src:/opt/irods-externals/boost*/include/boost/beast/core/detail/string.hpp
+
+[implicit-conversion]
+src:/opt/irods-externals/boost*/include/boost/asio/detail/impl/signal_set_service.ipp