Documentation + Miscellaneous Fixes (#36)

* Added documentation markdown source

* Replaced AARInternal with AMDResearch in URLs

* Renamed cpack artifact names

* Fix to testing and lulesh submodule checkout

* Docker updates

* CMake and CPack

- force CMAKE_INSTALL_LIBDIR to lib
- CPACK_DEBIAN_PACKAGE_RELEASE uses OMNITRACE_CPACK_SYSTEM_NAME
- CPACK_RPM_PACKAGE_RELEASE uses OMNITRACE_CPACK_SYSTEM_NAME
- Tweak LIBOMP_LIBRARY find in examples/openmp
- Tweak setup-env.sh.in

* Partial update of README

- status badges
- docs link
- removed install info (covered by docs)

* OMNITRACE_SAMPLING_CPUS setting

- enables control over which CPUs are sampled for frequency

* omnitrace exe updates

- exclude transaction clone, virtual thunk, non-virtual thunk
- module_function::start_address
- module_function::instructions
- verbosity > 0 encodes instructions into JSON

* Miscellaneous fixes

- relocate setup-env.sh.in
- add modulefile.in
- Updated README.md and source/docs/about.md
- cmake fix for libomp
- fix license in miscellaneous places
- dl.hpp and dl.cpp

* Update timemory and dyninst submodules

- timemory signals updates
- dyninst Movement-adhoc updates

* cmake format

[ROCm/rocprofiler-systems commit: 945f541965]

projects/rocprofiler-systems/cmake/ConfigCPack.cmake

@@ -1,7 +1,8 @@
 if(DYNINST_BUILD_ELFUTILS AND DYNINST_ELFUTILS_DOWNLOAD_VERSION)
+    omnitrace_add_feature(DYNINST_ELFUTILS_DOWNLOAD_VERSION "ElfUtils download version")
     foreach(_LIB dw elf)
         install(
-            FILES
+            PROGRAMS
                 ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/dyninst-tpls/lib/lib${_LIB}${CMAKE_SHARED_LIBRARY_SUFFIX}
                 ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/dyninst-tpls/lib/lib${_LIB}${CMAKE_SHARED_LIBRARY_SUFFIX}.1
                 ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/dyninst-tpls/lib/lib${_LIB}-${DYNINST_ELFUTILS_DOWNLOAD_VERSION}${CMAKE_SHARED_LIBRARY_SUFFIX}
@@ -32,6 +33,7 @@ set(CPACK_PACKAGE_VERSION_MINOR "${PROJECT_VERSION_MINOR}")
 set(CPACK_PACKAGE_VERSION_PATCH "${PROJECT_VERSION_PATCH}")
 set(CPACK_PACKAGE_CONTACT "jonathan.madsen@amd.com")
 set(CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE")
+set(CPACK_INCLUDE_TOPLEVEL_DIRECTORY OFF)
 set(OMNITRACE_CPACK_SYSTEM_NAME
     "${_SYSTEM_NAME}"
     CACHE STRING "System name, e.g. Linux or Ubuntu-18.04")
@@ -101,8 +103,9 @@ omnitrace_add_feature(OMNITRACE_PACKAGE_FILE_NAME "CPack filename")
 #
 # -------------------------------------------------------------------------------------- #
 
-set(CPACK_DEBIAN_PACKAGE_HOMEPAGE "https://github.com/AARInternal/omnitrace")
-set(CPACK_DEBIAN_PACKAGE_RELEASE "${CMAKE_SYSTEM_NAME}${OMNITRACE_CPACK_PACKAGE_SUFFIX}")
+set(CPACK_DEBIAN_PACKAGE_HOMEPAGE "https://github.com/AMDResearch/omnitrace")
+set(CPACK_DEBIAN_PACKAGE_RELEASE
+    "${OMNITRACE_CPACK_SYSTEM_NAME}${OMNITRACE_CPACK_PACKAGE_SUFFIX}")
 string(REGEX REPLACE "([a-zA-Z])-([0-9])" "\\1\\2" CPACK_DEBIAN_PACKAGE_RELEASE
                      "${CPACK_DEBIAN_PACKAGE_RELEASE}")
 string(REPLACE "-" "~" CPACK_DEBIAN_PACKAGE_RELEASE "${CPACK_DEBIAN_PACKAGE_RELEASE}")
@@ -166,7 +169,8 @@ if(DEFINED CPACK_PACKAGING_INSTALL_PREFIX)
     set(CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "${CPACK_PACKAGING_INSTALL_PREFIX}")
 endif()
 
-set(CPACK_RPM_PACKAGE_RELEASE "${CMAKE_SYSTEM_NAME}${OMNITRACE_CPACK_PACKAGE_SUFFIX}")
+set(CPACK_RPM_PACKAGE_RELEASE
+    "${OMNITRACE_CPACK_SYSTEM_NAME}${OMNITRACE_CPACK_PACKAGE_SUFFIX}")
 string(REGEX REPLACE "([a-zA-Z])-([0-9])" "\\1\\2" CPACK_RPM_PACKAGE_RELEASE
                      "${CPACK_RPM_PACKAGE_RELEASE}")
 string(REPLACE "-" "~" CPACK_RPM_PACKAGE_RELEASE "${CPACK_RPM_PACKAGE_RELEASE}")

projects/rocprofiler-systems/cmake/Modules/FindROCmVersion.cmake

@@ -190,10 +190,7 @@ function(ROCM_VERSION_PARSE_VERSION_FILES)
         endforeach()
     endfunction()
 
-    # search for HIP to set ROCM_PATH
-    if(NOT hip_FOUND)
-        find_package(hip)
-    endif()
+    # search for HIP to set ROCM_PATH if(NOT hip_FOUND) find_package(hip) endif()
 
     function(COMPUTE_ROCM_VERSION_DIR)
         if(EXISTS "${ROCmVersion_VERSION_FILE}" AND IS_ABSOLUTE
@@ -231,7 +228,7 @@ function(ROCM_VERSION_PARSE_VERSION_FILES)
         set(_PATHS ${ROCmVersion_DIR})
     else()
         set(_PATHS ${ROCmVersion_DIR} ${ROCmVersion_ROOT} ${ROCmVersion_ROOT_DIR}
-                   ${ROCM_PATH} $ENV{CMAKE_PREFIX_PATH} ${CMAKE_PREFIX_PATH} /opt/rocm)
+                   $ENV{CMAKE_PREFIX_PATH} ${CMAKE_PREFIX_PATH} ${ROCM_PATH} /opt/rocm)
         rocm_version_message(STATUS "ROCmVersion search paths: ${_PATHS}")
     endif()
 

projects/rocprofiler-systems/cmake/Packages.cmake

@@ -191,7 +191,7 @@ if(OMNITRACE_BUILD_DYNINST)
         omnitrace_target_compile_definitions(
             omnitrace-dyninst
             INTERFACE
-                DYNINST_API_RT="${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}:$<TARGET_FILE_DIR:Dyninst::dyninstAPI_RT>:${CMAKE_INSTALL_PREFIX}/lib/$<TARGET_FILE_NAME:Dyninst::dyninstAPI_RT>:$<TARGET_FILE:Dyninst::dyninstAPI_RT>"
+                DYNINST_API_RT="${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}:$<TARGET_FILE_DIR:Dyninst::dyninstAPI_RT>:${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/$<TARGET_FILE_NAME:Dyninst::dyninstAPI_RT>:$<TARGET_FILE:Dyninst::dyninstAPI_RT>"
             )
     endif()
 
@@ -466,6 +466,9 @@ if(NOT TARGET PTL::ptl-shared)
     set(PTL_USE_GPU OFF)
     set(PTL_DEVELOPER_INSTALL OFF)
 
+    if(NOT DEFINED BUILD_OBJECT_LIBS)
+        set(BUILD_OBJECT_LIBS OFF)
+    endif()
     omnitrace_save_variables(
         BUILD_CONFIG
         VARIABLES BUILD_SHARED_LIBS BUILD_STATIC_LIBS BUILD_OBJECT_LIBS

projects/rocprofiler-systems/cmake/Templates/modulefile.in

@@ -0,0 +1,15 @@
+#%Module1.0
+
+module-whatis "omnitrace (version @OMNITRACE_VERSION@)"
+
+proc ModulesHelp { } {
+puts stderr "Loads omnitrace v@OMNITRACE_VERSION@"
+}
+
+set ROOT [file normalize [file dirname [file normalize ${ModulesCurrentModulefile}]]/../../..]
+
+prepend-path CMAKE_PREFIX_PATH "${ROOT}"
+prepend-path PATH "${ROOT}/bin"
+prepend-path LD_LIBRARY_PATH "${ROOT}/@CMAKE_INSTALL_LIBDIR@"
+prepend-path PYTHONPATH "${ROOT}/@CMAKE_INSTALL_PYTHONDIR@"
+setenv @PROJECT_NAME@_DIR "${ROOT}/share/cmake/omnitrace"

projects/rocprofiler-systems/cmake/Templates/setup-env.sh.in

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+BASEDIR=$(dirname ${BASH_SOURCE[0]})
+BASEDIR=$(cd ${BASEDIR}/../.. && pwd)
+
+if [ ! -d "${BASEDIR}" ]; then
+    echo "${BASEDIR} does not exist"
+    return 1
+fi
+
+PATH=${BASEDIR}/bin:${PATH}
+LD_LIBRARY_PATH=${BASEDIR}/@CMAKE_INSTALL_LIBDIR@:${LD_LIBRARY_PATH}
+
+export PATH
+export LD_LIBRARY_PATH