Skip to content

Enable ASAN/UBSAN integration and refactor linking logic #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Apr 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ jobs:
cores: 4
cc: 'gcc-12'
cxx: 'g++-12'
# - name: ubuntu-22.04-gcc-9
# image: ubuntu-22.04
# os: linux
# cores: 4
# cc: 'gcc-9'
# cxx: 'g++-9'
# - name: ubuntu-22.04-gcc-9
# image: ubuntu-22.04
# os: linux
# cores: 4
# cc: 'gcc-9'
# cxx: 'g++-9'
- name: ubuntu-22.04-gcc-11
image: ubuntu-22.04
os: linux
Expand All @@ -63,8 +63,9 @@ jobs:
cc: 'clang'
cxx: 'clang++'
buildType: [ Release, Debug, RelWithDebInfo ]
sanitizers: [ NO_SAN, ASAN, UBSAN ]

name: "${{ matrix.config.name }}-${{matrix.buildType}}"
name: "${{ matrix.config.name }}-${{matrix.buildType}}-${{matrix.sanitizers}}"
runs-on: ${{ matrix.config.image }}

steps:
Expand All @@ -88,6 +89,7 @@ jobs:
-DCMAKE_CXX_COMPILER=${{matrix.config.cxx}}
-DDXFCXX_BUILD_DOC=OFF
-DDXFCXX_FEATURE_STACKTRACE=ON
-DDXFCXX_ENABLE_${{matrix.sanitizers}}=ON

- name: Configure CMake
if: ${{ contains(matrix.config.os, 'linux') }}
Expand All @@ -98,6 +100,7 @@ jobs:
-DCMAKE_CXX_COMPILER=${{matrix.config.cxx}}
-DDXFCXX_BUILD_DOC=OFF
-DDXFCXX_FEATURE_STACKTRACE=ON
-DDXFCXX_ENABLE_${{matrix.sanitizers}}=ON

- name: Configure CMake
if: ${{ contains(matrix.config.os, 'win') }}
Expand All @@ -120,5 +123,7 @@ jobs:
/p:CL_MPCount=${{matrix.config.cores}}

- name: Test
if: ${{ ! cancelled() }}
continue-on-error: true
working-directory: ${{github.workspace}}/build
run: ctest -C ${{matrix.buildType}} --extra-verbose
run: ctest -C ${{matrix.buildType}} --extra-verbose --output-on-failure --parallel ${{matrix.config.cores}}
13 changes: 7 additions & 6 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ set(DXFEED_GRAAL_NATIVE_SDK_JFROG_BASE_URL "https://dxfeed.jfrog.io/artifactory/
option(DXFCXX_USE_DXFG_STUB "Use dxFeed Graal SDK stub" OFF)
set(DXFG_STUB_REPO "https://github.com/ttldtor/DxFeedGraalNativeSdkStub" CACHE STRING "")

option(DXFCXX_ENABLE_ASAN_UBSAN "Enable address, UB sanitizers etc" OFF)
option(DXFCXX_ENABLE_VS_ASAN "Enable VS address sanitizer" OFF)
option(DXFCXX_ENABLE_ASAN "Enable address, address sanitizer" OFF)
option(DXFCXX_ENABLE_UBSAN "Enable address, UB sanitizer" OFF)
option(DXFCXX_USE_PRECOMPILED_HEADERS "Use precompiled headers" ON)

option(DXFCXX_FEATURE_STACKTRACE "Allow capturing stacktraces using boost::stacktrace" OFF)
Expand All @@ -86,6 +86,7 @@ set(DXFCXX_GRAAL_TARGET_CPU "unknown" CACHE STRING "")

include(cmake/ParseAndDetectPlatforms.cmake)
include(cmake/LinkStacktrace.cmake)
include(cmake/LinkAsanUbsan.cmake)

if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/third_party/graal-native-sdk-${DXFEED_GRAAL_NATIVE_SDK_VERSION}-${DXFCXX_GRAAL_TARGET_PLATFORM}/CMakeLists.txt")
add_subdirectory(third_party/graal-native-sdk-${DXFEED_GRAAL_NATIVE_SDK_VERSION}-${DXFCXX_GRAAL_TARGET_PLATFORM})
Expand Down Expand Up @@ -537,10 +538,10 @@ if (DXFCXX_FEATURE_STACKTRACE)
target_compile_definitions(${PROJECT_NAME}_static PUBLIC DXFCXX_FEATURE_STACKTRACE)
endif ()

if (DXFCXX_ENABLE_ASAN_UBSAN)
target_compile_options(${PROJECT_NAME} PRIVATE "-fsanitize=address" "-fsanitize=undefined")
target_link_options(${PROJECT_NAME} PRIVATE "-fsanitize=address" "-fsanitize=undefined")
target_link_libraries(${PROJECT_NAME} PUBLIC asan ubsan)
if (DXFCXX_ENABLE_ASAN)
LinkAsan(${PROJECT_NAME})
elseif (DXFCXX_ENABLE_UBSAN)
LinkUbsan(${PROJECT_NAME})
endif ()

add_custom_command(TARGET ${PROJECT_NAME}_static POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy_if_different
Expand Down
37 changes: 37 additions & 0 deletions cmake/LinkAsanUbsan.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Copyright (c) 2025 Devexperts LLC.
# SPDX-License-Identifier: MPL-2.0

function(LinkAsan targetName)
if (WIN32)
if (MINGW)
target_compile_options(${targetName} PRIVATE "-fsanitize=address")
target_link_options(${targetName} PRIVATE "-fsanitize=address")
else ()
target_compile_options(${targetName} PRIVATE "/fsanitize=address")
target_link_options(${targetName} PRIVATE "/fsanitize=address")

target_compile_definitions(${targetName}
PUBLIC
$<$<COMPILE_LANG_AND_ID:CXX,MSVC>:
_DISABLE_VECTOR_ANNOTATION
_DISABLE_STRING_ANNOTATION
>
)
endif ()
else ()
target_compile_options(${targetName} PRIVATE "-fsanitize=address")
target_link_options(${targetName} PRIVATE "-fsanitize=address")
endif ()
endfunction()

function(LinkUbsan targetName)
if (WIN32)
if (MINGW)
target_compile_options(${targetName} PRIVATE "-fsanitize=address")
target_link_options(${targetName} PRIVATE "-fsanitize=address")
endif ()
else ()
target_compile_options(${targetName} PRIVATE "-fsanitize=undefined")
target_link_options(${targetName} PRIVATE "-fsanitize=undefined")
endif ()
endfunction()
8 changes: 7 additions & 1 deletion tests/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,20 @@ foreach (DXFC_TEST_SOURCE ${DXFC_TEST_SOURCES})
set(DXFC_TEST_BASENAME dxFeedGraalCxxApi_${DXFC_TEST_BASENAME})
# message("${DXFC_TEST_BASENAME}: ${DXFC_TEST_SOURCE}")

add_executable(${DXFC_TEST_BASENAME} ${DXFC_TEST_SOURCE})
add_executable(${DXFC_TEST_BASENAME} ${DXFC_TEST_SOURCE} main.cpp)
target_include_directories(${DXFC_TEST_BASENAME} PRIVATE ${DXFC_TEST_INCLUDE_DIRS})
target_link_libraries(${DXFC_TEST_BASENAME} PRIVATE dxfcxx::static fmt::fmt-header-only)

if (DXFCXX_FEATURE_STACKTRACE)
LinkStacktrace(${DXFC_TEST_BASENAME})
endif ()

if (DXFCXX_ENABLE_ASAN)
LinkAsan(${DXFC_TEST_BASENAME})
elseif (DXFCXX_ENABLE_UBSAN)
LinkUbsan(${DXFC_TEST_BASENAME})
endif ()

set_target_properties(${DXFC_TEST_BASENAME} PROPERTIES
CXX_STANDARD 20
CMAKE_C_STANDARD 11
Expand Down
2 changes: 0 additions & 2 deletions tests/api/CandleSymbolTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
2 changes: 0 additions & 2 deletions tests/api/DXEndpointTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
2 changes: 0 additions & 2 deletions tests/api/DXFeedTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <vector>
Expand Down
2 changes: 0 additions & 2 deletions tests/api/DXPublisherTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
2 changes: 0 additions & 2 deletions tests/api/DataIntegrityTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
2 changes: 0 additions & 2 deletions tests/api/EventsTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
2 changes: 0 additions & 2 deletions tests/api/MarketEventSymbolsTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
2 changes: 0 additions & 2 deletions tests/api/OrderSourceTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
2 changes: 0 additions & 2 deletions tests/event/EventsTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
2 changes: 0 additions & 2 deletions tests/exceptions/ExceptionsTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
118 changes: 118 additions & 0 deletions tests/main.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT

#include <dxfeed_graal_c_api/api.h>
#include <dxfeed_graal_cpp_api/api.hpp>

#include <doctest.h>
#include <string>

#ifdef WIN32
void setSignalHandler() {
}
#else
# include <execinfo.h>
# include <signal.h>

# ifdef DXFCXX_FEATURE_STACKTRACE
# include <boost/stacktrace.hpp>
# include <fmt/format.h>

inline std::string boostStackTraceToString(const boost::stacktrace::stacktrace &stacktrace) {
std::string result;

for (auto &&frame : stacktrace) {
result += "\tat ";
auto frameString = boost::stacktrace::to_string(frame);

if (frameString.empty()) {
result += "\n";

continue;
}

std::string what;
std::size_t whereStart = 0;

auto foundIn = frameString.find(" in ");

if (foundIn != std::string::npos) {
what = frameString.substr(0, foundIn);
whereStart = foundIn + 4;
} else {
auto foundAt = frameString.find(" at ");

if (foundAt != std::string::npos) {
what = frameString.substr(0, foundAt);
whereStart = foundIn + 4;
} else {
whereStart = frameString.size();
}
}

if (whereStart == frameString.size()) {
what = frameString;

result += what + "\n";

continue;
}

auto foundLastSep = frameString.find_last_of("\\/");
std::string where;

if (foundLastSep != std::string::npos && foundLastSep < frameString.size() - 1) {
where = frameString.substr(foundLastSep + 1);
} else {
where = frameString.substr(whereStart);
}

result += fmt::format("{}({})\n", what, where);
}

return result;
}

std::string getStackTrace() {
return boostStackTraceToString(boost::stacktrace::stacktrace());
}
# else
std::string getStackTrace() {
return "";
}
# endif

void sigSegvHandler(int) {
std::cerr << "SIGSEGV:\n" << getStackTrace() << std::endl;

exit(1);
}

void sigBusHandler(int) {
std::cerr << "SIGBUS:\n" << getStackTrace() << std::endl;

exit(1);
}

void setSignalHandler() {
signal(SIGSEGV, sigSegvHandler);
signal(SIGBUS, sigBusHandler);
}
#endif

int main(int /*argc*/, char ** /*argv*/) {
setSignalHandler();

doctest::Context context;

const int res = context.run(); // run queries, or run tests unless --no-run is specified

if (context.shouldExit()) // important - query flags (and --exit) rely on the user doing this
return res; // propagate the result of the tests

context.clearFilters(); // removes all filters added up to this point

return res;
}
2 changes: 0 additions & 2 deletions tests/model/IndexedTxModelTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
2 changes: 0 additions & 2 deletions tests/model/MarketDepthModelTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include "dxfeed_graal_cpp_api/model/MarketDepthModel.hpp"

#include <random>
Expand Down
2 changes: 0 additions & 2 deletions tests/model/TimeSeriesTxModelTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>

Expand Down
2 changes: 0 additions & 2 deletions tests/schedule/ScheduleTest.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include <string>
#include <thread>
#include <unordered_map>
Expand Down
Loading
Loading