Add sanitizers (#220)

* Add sanitizers

* rev ci version

* fix job names

* revert version

* fix ubsan.  Use sanitizers cmake module

.circleci/config.yml

@@ -35,7 +35,7 @@ jobs:
  - run:
  name: Kill server
  command: pkill etserver
- build_linux:
+ linux_asan:
  docker:
  - image: ubuntu:bionic
  steps:
@@ -51,11 +51,51 @@ jobs:
  command: git submodule update --init
  - run:
  name: Build the project with test
- command: mkdir build; cd build; cmake ../; make -j4
+ command: mkdir build; cd build; cmake -DASAN=ON ../; make -j4
+ - run:
+ name: Run tests
+ command: cd build; ./et-test
+ linux_tsan:
+ docker:
+ - image: ubuntu:bionic
+ steps:
+ - run:
+ name: Avoid hosts unknown for github
+ command: mkdir -p ~/.ssh/ && echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
+ - run:
+ name: Install system dependencies
+ command: apt-get update; apt-get install -y git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
+ - checkout
+ - run:
+ name: Init submodules
+ command: git submodule update --init
+ - run:
+ name: Build the project with test
+ command: mkdir build; cd build; cmake -DTSAN=ON ../; make -j4
  - run:
  name: Run tests
  command: cd build; ./et-test
- build_mac:
+ linux_ubsan:
+ docker:
+ - image: ubuntu:bionic
+ steps:
+ - run:
+ name: Avoid hosts unknown for github
+ command: mkdir -p ~/.ssh/ && echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
+ - run:
+ name: Install system dependencies
+ command: apt-get update; apt-get install -y git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
+ - checkout
+ - run:
+ name: Init submodules
+ command: git submodule update --init
+ - run:
+ name: Build the project with test
+ command: mkdir build; cd build; cmake -DUBSAN=ON ../; make -j4
+ - run:
+ name: Run tests
+ command: cd build; ./et-test
+ mac_tsan:
  macos:
  xcode: "10.2.1"
  steps:
@@ -71,14 +111,16 @@ jobs:
  command: git submodule update --init
  - run:
  name: Build the project with test
- command: mkdir build; cd build; cmake ../; make -j4
+ command: mkdir build; cd build; cmake -DTSAN=ON ../; make -j4
  - run:
  name: Run tests
  command: cd build; ./et-test
 workflows:
  version: 2
  build_and_test:
  jobs:
- - build_linux
- - build_mac
+ - linux_asan
+ - linux_tsan
+ - linux_ubsan
+ - mac_tsan
  - connect_to_initial_version

.gitignore

@@ -2,6 +2,7 @@
 deps
 out
 .vscode
+*PVS-Studio*
 
 # Code Coverage
 code-coverage.info

.gitmodules

@@ -10,3 +10,9 @@
 [submodule "external/ThreadPool"]
  path = external/ThreadPool
  url = https://github.com/progschj/ThreadPool.git
+[submodule "external/easyloggingpp"]
+ path = external/easyloggingpp
+ url = https://github.com/zuhd-org/easyloggingpp.git
+[submodule "external/sanitizers-cmake"]
+ path = external/sanitizers-cmake
+ url = git:https://github.com/arsenm/sanitizers-cmake.git

CMakeLists.txt

@@ -1,6 +1,9 @@
 cmake_minimum_required (VERSION 3.0.2)
 project (EternalTCP VERSION 6.0.0)
 
+SET(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/external/sanitizers-cmake/cmake" ${CMAKE_MODULE_PATH})
+FIND_PACKAGE(Sanitizers)
+
 option(CODE_COVERAGE "Enable code coverage" OFF)
 
 SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DET_VERSION='\"${PROJECT_VERSION}\"'")
@@ -87,7 +90,7 @@ ELSE()
 ENDIF()
 
 include_directories(
- external
+ external/easyloggingpp/src
  external/ThreadPool
  external/Catch2/single_include
  external/cxxopts/include
@@ -108,7 +111,7 @@ add_library(
  et-lib
  STATIC
 
- external/easylogging++.cc
+ external/easyloggingpp/src/easylogging++.cc
 
  src/base/BackedReader.cpp
  src/base/BackedWriter.cpp
@@ -132,6 +135,7 @@ add_dependencies(
  et-lib
  generated-code
  )
+add_sanitizers(et-lib)
 
 add_library(
  TerminalCommon
@@ -153,12 +157,12 @@ add_dependencies(
  TerminalCommon
  generated-code
  )
+add_sanitizers(TerminalCommon)
 
 add_executable (
  etserver
  src/terminal/TerminalServerMain.cpp
  )
-
 target_link_libraries (
  etserver
  LINK_PUBLIC
@@ -171,12 +175,12 @@ target_link_libraries (
  ${UTEMPTER_LIBRARIES}
  ${CORE_LIBRARIES}
 )
+add_sanitizers(etserver)
 
 add_executable (
  etterminal
  src/terminal/TerminalMain.cpp
  )
-
 target_link_libraries (
  etterminal
  LINK_PUBLIC
@@ -189,12 +193,12 @@ target_link_libraries (
  ${UTEMPTER_LIBRARIES}
  ${CORE_LIBRARIES}
 )
+add_sanitizers(etterminal)
 
 add_executable (
  et
  src/terminal/TerminalClientMain.cpp
  )
-
 target_link_libraries (
  et
  LINK_PUBLIC
@@ -206,6 +210,7 @@ target_link_libraries (
  ${UTEMPTER_LIBRARIES}
  ${CORE_LIBRARIES}
 )
+add_sanitizers(et)
 
 add_library (
  HtmCommon
@@ -223,13 +228,13 @@ add_dependencies(
  HtmCommon
  generated-code
  )
+add_sanitizers(HtmCommon)
 
 add_executable (
  htm
 
  src/htm/HtmClientMain.cpp
  )
-
 target_link_libraries (
  htm
  LINK_PUBLIC
@@ -243,13 +248,13 @@ target_link_libraries (
  ${UTEMPTER_LIBRARIES}
  ${CORE_LIBRARIES}
 )
+add_sanitizers(htm)
 
 add_executable (
  htmd
 
  src/htm/HtmServerMain.cpp
  )
-
 target_link_libraries (
  htmd
  LINK_PUBLIC
@@ -263,6 +268,7 @@ target_link_libraries (
  ${UTEMPTER_LIBRARIES}
  ${CORE_LIBRARIES}
 )
+add_sanitizers(htmd)
 
 enable_testing()
 
@@ -273,12 +279,10 @@ add_executable(
  ${TEST_SRCS}
  test/Main.cpp
  )
-
 add_dependencies(
  et-test
  TerminalCommon
  et-lib)
-
 target_link_libraries(
  et-test
  TerminalCommon
@@ -296,6 +300,7 @@ add_test(
  et-test
  et-test
  )
+add_sanitizers(et-test)
 
 install(TARGETS etserver etterminal et htm htmd
  PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ WORLD_EXECUTE WORLD_READ