Merge pull request #539 from PatKamin/ci-libbacktrace

pbalcer · web-flow · commit 20d4c6bd7a38 · 2023-05-26T11:00:42.000+02:00
[ci] Test tracing using libbacktrace
diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml
@@ -1,20 +1,31 @@
-name: CMake
+name: Build and test
 
 on: [push, pull_request]
 
-env:
-  BUILD_TYPE: Release
-
 jobs:
   ubuntu-build:
     name: Build - Ubuntu
     strategy:
       matrix:
-        config:
-          - {os: 'ubuntu-20.04', compiler: {c: gcc, cxx: g++}}
-          - {os: 'ubuntu-22.04', compiler: {c: gcc, cxx: g++}}
-          - {os: 'ubuntu-22.04', compiler: {c: clang, cxx: clang++}}
-    runs-on: ${{matrix.config.os}}
+        os: ['ubuntu-20.04', 'ubuntu-22.04']
+        build_type: [Debug, Release]
+        compiler: [{c: gcc, cxx: g++}]
+        libbacktrace: ['-DVAL_USE_LIBBACKTRACE_BACKTRACE=OFF']
+        include:
+          - os: 'ubuntu-22.04'
+            build_type: Release
+            compiler: {c: clang, cxx: clang++}
+            libbacktrace: '-DVAL_USE_LIBBACKTRACE_BACKTRACE=OFF'
+          - os: 'ubuntu-22.04'
+            build_type: Release
+            compiler: {c: gcc, cxx: g++}
+            libbacktrace: '-DVAL_USE_LIBBACKTRACE_BACKTRACE=ON'
+          - os: 'ubuntu-22.04'
+            build_type: Release
+            compiler: {c: clang, cxx: clang++}
+            libbacktrace: '-DVAL_USE_LIBBACKTRACE_BACKTRACE=ON'
+
+    runs-on: ${{matrix.os}}
 
     steps:
     - uses: actions/checkout@v3
@@ -27,37 +38,47 @@ jobs:
     - name: Install pip packages
       run: pip install -r third_party/requirements.txt
 
+    - name: Install libbacktrace
+      if: matrix.libbacktrace == '-DVAL_USE_LIBBACKTRACE_BACKTRACE=ON'
+      run: |
+        git clone https://github.com/ianlancetaylor/libbacktrace.git
+        cd libbacktrace
+        ./configure
+        make
+        sudo make install        
+        cd ..
+
     - name: Configure CMake
       run: >
         cmake
         -B${{github.workspace}}/build
-        -DCMAKE_C_COMPILER=${{matrix.config.compiler.c}}
-        -DCMAKE_CXX_COMPILER=${{matrix.config.compiler.cxx}}
+        -DCMAKE_C_COMPILER=${{matrix.compiler.c}}
+        -DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
         -DUR_ENABLE_TRACING=ON
         -DUR_DEVELOPER_MODE=ON
-        -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+        -DCMAKE_BUILD_TYPE=${{matrix.build_type}}
         -DUR_BUILD_TESTS=ON
         -DUR_FORMAT_CPP_STYLE=ON
+        ${{matrix.libbacktrace}}
 
     - name: Generate source from spec, check for uncommitted diff
-      if: matrix.config.os == 'ubuntu-22.04'
+      if: matrix.os == 'ubuntu-22.04'
       run: cmake --build ${{github.workspace}}/build --target check-generated
 
     - name: Build
-      run: cmake --build ${{github.workspace}}/build
+      run: cmake --build ${{github.workspace}}/build -j $(nproc)
 
     - name: Test
       working-directory: ${{github.workspace}}/build
-      run: ctest -C ${{env.BUILD_TYPE}} --output-on-failure -L "python|uma|loader|validation|tracing|unit|urtrace"
+      run: ctest -C ${{matrix.build_type}} --output-on-failure -L "python|uma|loader|validation|tracing|unit|urtrace"
 
   windows-build:
     name: Build - Windows
     strategy:
       matrix:
-        config:
-          - {os: 'windows-2019'}
-          - {os: 'windows-2022'}
-    runs-on: ${{matrix.config.os}}
+        os: ['windows-2019', 'windows-2022']
+        build_type: [Debug, Release]
+    runs-on: ${{matrix.os}}
 
     steps:
     - uses: actions/checkout@v3
@@ -80,12 +101,12 @@ jobs:
         -DUR_FORMAT_CPP_STYLE=ON
 
     - name: Generate source from spec, check for uncommitted diff
-      if: matrix.config.os == 'windows-2022'
-      run: cmake --build ${{github.workspace}}/build --target check-generated --config ${{env.BUILD_TYPE}}
+      if: matrix.os == 'windows-2022'
+      run: cmake --build ${{github.workspace}}/build --target check-generated --config ${{matrix.build_type}}
 
     - name: Build all
-      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+      run: cmake --build ${{github.workspace}}/build --config ${{matrix.build_type}} -j 2
 
     - name: Test
       working-directory: ${{github.workspace}}/build
-      run: ctest -C ${{env.BUILD_TYPE}} --output-on-failure -L "python|uma|loader|validation|tracing|unit|urtrace"
+      run: ctest -C ${{matrix.build_type}} --output-on-failure -L "python|uma|loader|validation|tracing|unit|urtrace"
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,7 +1,7 @@
 # Copyright (C) 2022-2023 Intel Corporation
 # SPDX-License-Identifier: MIT
 
-cmake_minimum_required(VERSION 3.14.0 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.15.0 FATAL_ERROR)
 project(unified-runtime VERSION 0.6.0)
 
 include(GNUInstallDirs)
@@ -70,7 +70,7 @@ if(NOT MSVC)
         link_libraries(stdc++fs)
     endif()
 elseif(MSVC)
-    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
+    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /MP")
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /MP")
     add_compile_options(/MP /W3)
@@ -103,8 +103,12 @@ if(UR_ENABLE_TRACING)
     if (MSVC)
         set_property(TARGET xpti PROPERTY MSVC_RUNTIME_LIBRARY "${CMAKE_MSVC_RUNTIME_LIBRARY}")
         set_property(TARGET xptifw PROPERTY MSVC_RUNTIME_LIBRARY "${CMAKE_MSVC_RUNTIME_LIBRARY}")
+        set(TARGET_XPTI $<IF:$<CONFIG:Release>,xpti,xptid>)
+
         # disable warning C4267: The compiler detected a conversion from size_t to a smaller type.
         target_compile_options(xptifw PRIVATE /wd4267)
+    else()
+        set(TARGET_XPTI xpti)
     endif()
 endif()
 
diff --git a/examples/collector/CMakeLists.txt b/examples/collector/CMakeLists.txt
@@ -11,7 +11,7 @@ target_include_directories(${TARGET_NAME} PRIVATE
     ${CMAKE_SOURCE_DIR}/include
 )
 
-target_link_libraries(${TARGET_NAME} PRIVATE xpti ${CMAKE_DL_LIBS})
+target_link_libraries(${TARGET_NAME} PRIVATE ${TARGET_XPTI})
 target_include_directories(${TARGET_NAME} PRIVATE ${xpti_SOURCE_DIR}/include)
 
 if(MSVC)
diff --git a/source/loader/CMakeLists.txt b/source/loader/CMakeLists.txt
@@ -36,7 +36,7 @@ target_link_libraries(ur_loader PRIVATE
 )
 
 if(UR_ENABLE_TRACING)
-    target_link_libraries(ur_loader PRIVATE xpti)
+    target_link_libraries(ur_loader PRIVATE ${TARGET_XPTI})
     target_include_directories(ur_loader PRIVATE ${xpti_SOURCE_DIR}/include)
     target_compile_definitions(ur_loader PRIVATE XPTI_STATIC_LIBRARY)
 endif()
@@ -92,8 +92,10 @@ endif()
 
 
 # link validation backtrace dependencies
-find_package(Libbacktrace)
-if (VAL_USE_LIBBACKTRACE_BACKTRACE AND LIBBACKTRACE_FOUND AND UNIX)
+if(UNIX)
+    find_package(Libbacktrace)
+endif()
+if (VAL_USE_LIBBACKTRACE_BACKTRACE AND LIBBACKTRACE_FOUND)
     message(STATUS "Using libbacktrace backtrace for validation")
 
     target_sources(ur_loader PRIVATE
diff --git a/source/loader/layers/validation/backtrace_libbacktrace.cpp b/source/loader/layers/validation/backtrace_libbacktrace.cpp
@@ -42,14 +42,16 @@ int backtrace_cb(void *data, uintptr_t pc, const char *filename, int lineno,
     } else if (function != NULL) {
         backtraceLine << "(" << function << ") ";
     } else {
-        backtraceLine << "(????????) ";
+        // Note: Escaping the last '?' character to avoid creation of a trigraph character
+        backtraceLine << "(???????\?) ";
     }
 
     char filepath[PATH_MAX];
     if (realpath(filename, filepath) != NULL) {
         backtraceLine << "(" << filepath << ":" << std::dec << lineno << ")";
     } else {
-        backtraceLine << "(????????)";
+        // Note: Escaping the last '?' character to avoid creation of a trigraph character
+        backtraceLine << "(???????\?)";
     }
 
     std::vector<std::string> *backtrace =
diff --git a/tools/urtrace/CMakeLists.txt b/tools/urtrace/CMakeLists.txt
@@ -11,7 +11,7 @@ target_include_directories(${TARGET_NAME} PRIVATE
     ${CMAKE_SOURCE_DIR}/include
 )
 
-target_link_libraries(${TARGET_NAME} PRIVATE xpti ${PROJECT_NAME}::common ${CMAKE_DL_LIBS})
+target_link_libraries(${TARGET_NAME} PRIVATE ${TARGET_XPTI} ${PROJECT_NAME}::common ${CMAKE_DL_LIBS})
 target_include_directories(${TARGET_NAME} PRIVATE ${xpti_SOURCE_DIR}/include)
 
 if(MSVC)
diff --git a/tools/urtrace/urtrace b/tools/urtrace/urtrace
@@ -62,7 +62,6 @@ if args.debug:
     print(config)
 env = dict()
 
-env['UR_LOG_COLLECTOR']="level:info;output:stderr;flush:info"
 collector_args = ""
 if args.print_begin:
     collector_args += "print_begin;"
@@ -81,15 +80,16 @@ env['UR_COLLECTOR_ARGS'] = collector_args
 log_collector = ""
 if args.debug:
     log_collector += "level:debug;"
+    log_collector += "flush:debug;"
 else:
     log_collector += "level:info;"
+    log_collector += "flush:info;"
 if args.file:
     log_collector += "output:file," + args.file + ";"
 elif args.stdout:
-    log_collector += "output:stdout;"
+    log_collector += "output:stdout"
 else:
-    log_collector += "output:stderr;"
-log_collector += "flush:error"
+    log_collector += "output:stderr"
 env['UR_LOG_COLLECTOR'] = log_collector
 
 env['XPTI_TRACE_ENABLE'] = "1"

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ target_include_directories(${TARGET_NAME} PRIVATE`
`11`	`11`	`${CMAKE_SOURCE_DIR}/include`
`12`	`12`	`)`
`13`	`13`
`14`		`-target_link_libraries(${TARGET_NAME} PRIVATE xpti ${CMAKE_DL_LIBS})`
	`14`	`+target_link_libraries(${TARGET_NAME} PRIVATE ${TARGET_XPTI})`
`15`	`15`	`target_include_directories(${TARGET_NAME} PRIVATE ${xpti_SOURCE_DIR}/include)`
`16`	`16`
`17`	`17`	`if(MSVC)`