Code Coverage Support (#46)

* Code-coverage support

* Examples update

- code-coverage example
- tweak transpose and parallel-overhead

* Coverage output + testing

- config::get_setting value(...)
- REGULAR_EXPRESSION -> REGEX in cmake func args
- coverage.hpp header
- coverage JSON
- coverage tests

* cmake formatting

* Library instrumentation w/o main + more

- fixed library instrumentation w/o main
- use TIMEMORY_PROJECT_NAME in output messages
- removed '--driver' option from omnitrace exe
- support coverage in trace mode
- OMNITRACE_KOKKOS_KERNEL_LOGGER
- support multiple calls to omnitrace_set_env after init if already called
- support multiple calls to omnitrace_set_mpi after init if same args
- support multiple calls to omnitrace_init if same mode
- unique_ptr_t for thread_data which calls finalize when thread_data is destroyed
- tweaked openmp tests
- improved finalization

* Replace CI --output-on-failure with -V

* Fix to OMNITRACE_DL_INVOKE

* omnitrace-exe and testing updates

- omnitrace::omnitrace-timemory interface library
- support for configs in omnitrace exe
- print-{available,instrumented,...} opts no longer exit w/o --simulate
- all tests apply --print-instrumented functions
- tweaked coverage tests
- print-* options print instructions not address range

* Remove OMNITRACE_DEBUG_FINALIZE=ON from CI

* Python cmake tweaks

* Tweak test ordering

* Upload CI artifacts if fail or success

* CI Python tweaks

- Use OMNITRACE_PYTHON_PREFIX and OMNITRACE_PYTHON_ENVS

* CI ELFULTILS_DOWNLOAD_VERSION

* test tweaks

- labels and more coverage tests

* tweak to omnitrace --config handling

* Update module/function constraint handling + PP

- tweak pre-processor definition handling
- removed free-standing module_constraint
- remove free-standing routine_constraint
- remove module_name.find("omnitrace") module constraint
- fully handle the output path of omnitrace *-instr files
- get_use_code_coverage config option
- print-coverage option
- coverage_module_functions

* use github.job not github.name

* Re-enable HSA_ENABLE_INTERRUPT

- remove coverage address report

[ROCm/rocprofiler-systems commit: 791375bb24]

projects/rocprofiler-systems/source/python/CMakeLists.txt

@@ -21,10 +21,14 @@ function(OMNITRACE_CONFIGURE_PYTARGET _TARGET _VERSION)
         ${_TARGET}
         PROPERTIES PREFIX ""
                    OUTPUT_NAME libpyomnitrace
-                   LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/python/omnitrace
-                   ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/python/omnitrace
-                   RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/python/omnitrace
-                   PDB_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/python/omnitrace
+                   LIBRARY_OUTPUT_DIRECTORY
+                   ${PROJECT_BINARY_DIR}/lib/python/site-packages/omnitrace
+                   ARCHIVE_OUTPUT_DIRECTORY
+                   ${PROJECT_BINARY_DIR}/lib/python/site-packages/omnitrace
+                   RUNTIME_OUTPUT_DIRECTORY
+                   ${PROJECT_BINARY_DIR}/lib/python/site-packages/omnitrace
+                   PDB_OUTPUT_DIRECTORY
+                   ${PROJECT_BINARY_DIR}/lib/python/site-packages/omnitrace
                    INSTALL_RPATH_USE_LINK_PATH ON
                    ${EXTRA_PROPERTIES})
 
@@ -84,65 +88,33 @@ target_link_libraries(
 
 target_compile_definitions(libpyomnitrace-interface INTERFACE OMNITRACE_PYBIND11_SOURCE)
 
-# ----------------------------------------------------------------------------
-# Console scripts
-#
-function(OMNITRACE_PYTHON_CONSOLE_SCRIPT SCRIPT_NAME SCRIPT_SUBMODULE)
-    set(options)
-    set(args VERSION ROOT_DIR)
-    set(kwargs)
-    cmake_parse_arguments(ARG "${options}" "${args}" "${kwargs}" ${ARGN})
-
-    if(ARG_VERSION AND ARG_ROOT_DIR)
-        set(Python3_ROOT_DIR "${ARG_ROOT_DIR}")
-        find_package(Python3 ${ARG_VERSION} EXACT QUIET MODULE COMPONENTS Interpreter)
-        set(PYTHON_EXECUTABLE "${Python3_EXECUTABLE}")
-        configure_file(${PROJECT_SOURCE_DIR}/cmake/Templates/console-script.in
-                       ${PROJECT_BINARY_DIR}/bin/${SCRIPT_NAME}-${ARG_VERSION} @ONLY)
-
-        if(CMAKE_INSTALL_PYTHONDIR)
-            install(
-                PROGRAMS ${PROJECT_BINARY_DIR}/bin/${SCRIPT_NAME}-${ARG_VERSION}
-                DESTINATION ${CMAKE_INSTALL_BINDIR}
-                OPTIONAL)
-        endif()
-
-        if(OMNITRACE_BUILD_TESTING OR OMNITRACE_BUILD_PYTHON)
-            add_test(
-                NAME ${SCRIPT_NAME}-console-script-test-${ARG_VERSION}
-                COMMAND ${PROJECT_BINARY_DIR}/bin/${SCRIPT_NAME}-${ARG_VERSION} --help
-                WORKING_DIRECTORY ${PROJECT_BINARY_DIR})
-            set_tests_properties(
-                ${SCRIPT_NAME}-console-script-test-${ARG_VERSION}
-                PROPERTIES LABELS "python;python-${ARG_VERSION};console-script")
-            add_test(
-                NAME ${SCRIPT_NAME}-generic-console-script-test-${ARG_VERSION}
-                COMMAND ${PROJECT_BINARY_DIR}/bin/${SCRIPT_NAME} --help
-                WORKING_DIRECTORY ${PROJECT_BINARY_DIR})
-            set_tests_properties(
-                ${SCRIPT_NAME}-generic-console-script-test-${ARG_VERSION}
-                PROPERTIES ENVIRONMENT "PYTHON_EXECUTABLE=${PYTHON_EXECUTABLE}" LABELS
-                           "python;python-${ARG_VERSION};console-script")
-        endif()
-    else()
-        set(PYTHON_EXECUTABLE "python3")
-
-        configure_file(${PROJECT_SOURCE_DIR}/cmake/Templates/console-script.in
-                       ${PROJECT_BINARY_DIR}/bin/${SCRIPT_NAME} @ONLY)
-
-        if(CMAKE_INSTALL_PYTHONDIR)
-            install(
-                PROGRAMS ${PROJECT_BINARY_DIR}/bin/${SCRIPT_NAME}
-                DESTINATION ${CMAKE_INSTALL_BINDIR}
-                OPTIONAL)
-        endif()
-    endif()
-endfunction()
-
 include(PyBind11Tools)
 
-# OMNITRACE_PYTHON_ROOT_DIRS=/opt/conda/envs/py36;/opt/conda/envs/py37;/opt/conda/envs/py38;/opt/conda/envs/py39
-# OMNITRACE_PYTHON_VERSIONS=3.6;3.7;3.8;3.9
+omnitrace_watch_for_change(OMNITRACE_PYTHON_ROOT_DIRS _PYTHON_DIRS_CHANGED)
+if(_PYTHON_DIRS_CHANGED)
+    unset(OMNITRACE_PYTHON_VERSION CACHE)
+    unset(OMNITRACE_PYTHON_VERSIONS CACHE)
+else()
+    foreach(_VAR PREFIX ENVS)
+        omnitrace_watch_for_change(OMNITRACE_PYTHON_${_VAR} _CHANGED)
+        if(_CHANGED)
+            unset(OMNITRACE_PYTHON_ROOT_DIRS CACHE)
+            unset(OMNITRACE_PYTHON_VERSIONS CACHE)
+            break()
+        endif()
+    endforeach()
+endif()
+
+if(OMNITRACE_PYTHON_PREFIX AND OMNITRACE_PYTHON_ENVS)
+    omnitrace_directory(
+        FAIL
+        PREFIX ${OMNITRACE_PYTHON_PREFIX}
+        PATHS ${OMNITRACE_PYTHON_ENVS}
+        OUTPUT_VARIABLE _PYTHON_ROOT_DIRS)
+    set(OMNITRACE_PYTHON_ROOT_DIRS
+        "${_PYTHON_ROOT_DIRS}"
+        CACHE INTERNAL "Root directories for python")
+endif()
 
 if(NOT OMNITRACE_PYTHON_VERSIONS AND OMNITRACE_PYTHON_VERSION)
     set(OMNITRACE_PYTHON_VERSIONS "${OMNITRACE_PYTHON_VERSION}")
@@ -152,6 +124,7 @@ if(NOT OMNITRACE_PYTHON_VERSIONS AND OMNITRACE_PYTHON_VERSION)
             "${_PY_ROOT_DIR}"
             CACHE INTERNAL "" FORCE)
     endif()
+    unset(OMNITRACE_PYTHON_VERSION CACHE)
 elseif(
     NOT OMNITRACE_PYTHON_VERSIONS
     AND NOT OMNITRACE_PYTHON_VERSION
@@ -182,27 +155,16 @@ elseif(
         CACHE INTERNAL "" FORCE)
 endif()
 
-list(LENGTH OMNITRACE_PYTHON_VERSIONS _NUM_PYTHON_VERSIONS)
-list(LENGTH OMNITRACE_PYTHON_ROOT_DIRS _NUM_PYTHON_ROOT_DIRS)
+omnitrace_watch_for_change(OMNITRACE_PYTHON_ROOT_DIRS)
+omnitrace_watch_for_change(OMNITRACE_PYTHON_VERSIONS)
 
-if(NOT _NUM_PYTHON_VERSIONS EQUAL _NUM_PYTHON_ROOT_DIRS)
-    omnitrace_message(
-        WARNING
-        "Error! Number of python versions  : ${_NUM_PYTHON_VERSIONS}. VERSIONS :: ${OMNITRACE_PYTHON_VERSIONS}"
-        )
-    omnitrace_message(
-        WARNING
-        "Error! Number of python root directories : ${_NUM_PYTHON_ROOT_DIRS}. ROOT DIRS :: ${OMNITRACE_PYTHON_ROOT_DIRS}"
-        )
-    omnitrace_message(
-        FATAL_ERROR
-        "Error! Number of python versions != number of python root directories")
-endif()
+omnitrace_check_python_dirs_and_versions(FAIL)
 
 file(GLOB_RECURSE PYTHON_FILES ${CMAKE_CURRENT_SOURCE_DIR}/omnitrace/*.py)
 foreach(_IN ${PYTHON_FILES})
     string(REPLACE "${CMAKE_CURRENT_SOURCE_DIR}/omnitrace"
-                   "${PROJECT_BINARY_DIR}/python/omnitrace" _OUT "${_IN}")
+                   "${PROJECT_BINARY_DIR}/lib/python/site-packages/omnitrace" _OUT
+                   "${_IN}")
     configure_file(${_IN} ${_OUT} @ONLY)
     install(
         FILES ${_OUT}
@@ -212,12 +174,6 @@ endforeach()
 
 omnitrace_python_console_script("omnitrace-python" "omnitrace")
 
-execute_process(
-    COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_INSTALL_LIBDIR}/python
-    COMMAND ${CMAKE_COMMAND} -E create_symlink ../../python
-            ${CMAKE_INSTALL_LIBDIR}/python/site-packages
-    WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
-
 set(_INDEX 0)
 foreach(_VERSION ${OMNITRACE_PYTHON_VERSIONS})
     # add_library(libpyomnitrace MODULE ${pysources} ${pyheaders})
@@ -237,29 +193,9 @@ foreach(_VERSION ${OMNITRACE_PYTHON_VERSIONS})
     math(EXPR _INDEX "${_INDEX} + 1")
 endforeach()
 
-if(PYTHON_EXECUTABLE AND OFF)
-    configure_file(${CMAKE_CURRENT_LIST_DIR}/setup.py.in
-                   ${PROJECT_BINARY_DIR}/python/setup.py @ONLY)
-    configure_file(${CMAKE_CURRENT_LIST_DIR}/setup.cfg.in
-                   ${PROJECT_BINARY_DIR}/python/setup.cfg @ONLY)
-    configure_file(${CMAKE_CURRENT_LIST_DIR}/pyproject.toml
-                   ${PROJECT_BINARY_DIR}/python/pyproject.toml COPYONLY)
-    execute_process(
-        COMMAND ${PYTHON_EXECUTABLE} setup.py dist_info
-        OUTPUT_VARIABLE _OUT
-        RESULT_VARIABLE _RET
-        ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE
-        WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/python)
-    set(_DIST_DIR
-        ${PROJECT_BINARY_DIR}/python/${PROJECT_NAME}-${PROJECT_VERSION}.dist-info)
-    if(NOT EXISTS ${_DIST_DIR})
-        set(_DIST_DIR ${PROJECT_BINARY_DIR}/${PROJECT_NAME}.dist-info)
-    endif()
-    if(EXISTS ${_DIST_DIR} AND IS_DIRECTORY ${_DIST_DIR})
-        configure_file(${PROJECT_SOURCE_DIR}/LICENSE ${_DIST_DIR}/LICENSE.txt COPYONLY)
-        install(
-            DIRECTORY ${_DIST_DIR}
-            DESTINATION ${CMAKE_INSTALL_PYTHONDIR}
-            OPTIONAL)
-    endif()
-endif()
+configure_file(${CMAKE_CURRENT_LIST_DIR}/setup.py.in
+               ${PROJECT_BINARY_DIR}/lib/python/site-packages/setup.py @ONLY)
+configure_file(${CMAKE_CURRENT_LIST_DIR}/setup.cfg.in
+               ${PROJECT_BINARY_DIR}/lib/python/site-packages/setup.cfg @ONLY)
+configure_file(${CMAKE_CURRENT_LIST_DIR}/pyproject.toml
+               ${PROJECT_BINARY_DIR}/lib/python/site-packages/pyproject.toml COPYONLY)

projects/rocprofiler-systems/source/python/setup.cfg.in

@@ -26,7 +26,6 @@ classifiers =
     Operating System :: Unix
     Programming Language :: C++
     Programming Language :: Python :: 3
-    Programming Language :: Python :: @OMNITRACE_PYTHON_VERSION@
     Topic :: Software Development :: Libraries :: Python Modules
     Topic :: Utilities
 

projects/rocprofiler-systems/source/python/setup.py.in

@@ -1,3 +1,5 @@
+#!/usr/bin/env python3
+
 from setuptools import setup
 
 setup(
@@ -7,5 +9,4 @@ setup(
     author="AMD Research",
     url="@PROJECT_HOMEPAGE_URL@",
     packages=["@PROJECT_NAME@"],
-    python_requires="=@OMNITRACE_PYTHON_VERSION@",
 )