pydftracer 1.0.1__tar.gz

pydftracer-1.0.1/CMakeLists.txt

@@ -0,0 +1,517 @@
+cmake_minimum_required(VERSION 3.4...3.18)
+#------------------------------------------------------------------------------
+# Version information
+#------------------------------------------------------------------------------
+
+set(DFTRACER_VERSION_MAJOR "3")
+set(DFTRACER_VERSION_MINOR "0")
+set(DFTRACER_VERSION_PATCH "0")
+set(DFTRACER_PACKAGE ${PROJECT_NAME})
+set(DFTRACER_PACKAGE_NAME ${PROJECT_NAME})
+set(DFTRACER_PACKAGE_VERSION "${DFTRACER_VERSION_MAJOR}.${DFTRACER_VERSION_MINOR}.${DFTRACER_VERSION_PATCH}")
+set(DFTRACER_PACKAGE_VERSION_MAJOR "${DFTRACER_VERSION_MAJOR}.${DFTRACER_VERSION_MINOR}")
+set(DFTRACER_PACKAGE_VERSION_MINOR "${DFTRACER_VERSION_PATCH}")
+set(DFTRACER_PACKAGE_STRING "${DFTRACER_PACKAGE_NAME} ${DFTRACER_PACKAGE_VERSION}")
+set(DFTRACER_PACKAGE_TARNAME "${DFTRACER_PACKAGE}")
+
+project(dftracer LANGUAGES C CXX)
+
+
+# Convenience defines
+string(TOUPPER "${PROJECT_NAME}" UPPER_PROJECT_NAME)
+string(TOLOWER "${PROJECT_NAME}" LOWER_PROJECT_NAME)
+
+#------------------------------------------------------------------------------
+# Internal Includes for header and libraries
+#------------------------------------------------------------------------------
+# Get installation directories -- these get used in various places;
+# best to just make them available
+option (DFTRACER_LIBDIR_AS_LIB OFF)
+if (NOT DFTRACER_LIBDIR_AS_LIB)
+    include(GNUInstallDirs)
+endif ()
+#
+if (CMAKE_INSTALL_LIBDIR)
+   message(STATUS "CMAKE_INSTALL_LIBDIR ${CMAKE_INSTALL_LIBDIR}")
+   set(DFTRACER_LIBDIR ${CMAKE_INSTALL_LIBDIR})
+   set(DFTRACER_INSTALL_INCLUDE_DIR
+       ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR})
+   set(DFTRACER_INSTALL_DOCDIR
+       ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DOCDIR})
+   set(DFTRACER_INSTALL_SYSCONFDIR
+       ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_SYSCONFDIR}/modulefiles)
+else ()
+   set(DFTRACER_LIBDIR "lib")
+   set(DFTRACER_INSTALL_INCLUDE_DIR "${CMAKE_INSTALL_PREFIX}/include")
+   set(DFTRACER_INSTALL_DOCDIR "${CMAKE_INSTALL_PREFIX}/doc")
+   set(DFTRACER_INSTALL_SYSCONFDIR "${CMAKE_INSTALL_PREFIX}/etc/modulefiles")
+   message(STATUS "DFTRACER_LIBDIR set to ${DFTRACER_LIBDIR}")
+endif ()
+
+#------------------------------------------------------------------------------
+# Internal Paths for cmake libraries and Setup install and output Directories
+#------------------------------------------------------------------------------
+# This sets where to look for dependent libraries
+set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} ${CMAKE_BINARY_DIR} ${CMAKE_INSTALL_PREFIX})
+# This sets where to look for dependent library's cmake files
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules)
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_BINARY_DIR}/${DFTRACER_LIBDIR}/cmake)
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_BINARY_DIR}/share/cmake)
+
+#------------------------------------------------------------------------------
+if (NOT DFTRACER_EXTERNALLY_CONFIGURED)
+    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin CACHE PATH "Single Directory for all Executables.")
+    set(CMAKE_INCLUDE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/include CACHE PATH "Store the headers.")
+    set(EXECUTABLE_OUTPUT_PATH ${CMAKE_RUNTIME_OUTPUT_DIRECTORY})
+    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${DFTRACER_LIBDIR} CACHE PATH "Single Directory for all Libraries")
+    set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${DFTRACER_LIBDIR} CACHE PATH "Single Directory for all static libraries.")
+endif ()
+
+include_directories(${CMAKE_BINARY_DIR}/include)
+link_directories(${CMAKE_BINARY_DIR}/${DFTRACER_LIBDIR})
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src)
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)
+
+#-----------------------------------------------------------------------------
+# Targets built within this project are exported at Install time for use
+# by other projects.
+#-----------------------------------------------------------------------------
+if (NOT DFTRACER_EXPORTED_TARGETS)
+    set(DFTRACER_EXPORTED_TARGETS "dftracer-targets")
+endif ()
+
+
+include(dftracer-utils)
+#------------------------------------------------------------------------------
+# Build options
+#------------------------------------------------------------------------------
+# option(ENABLE_DFTRACER_DEBUG "Include debugging prints and logging" OFF) # This is not needed as we have CMAKE_BUILD_TYPE
+# This is verbose, maybe an alternate might help simplify
+#option(BUILD_URPC "Build DFTRACER's URPC code" OFF)
+#option(ENABLE_PERFFLOW "Build with PerfFlow Aspect support" OFF)
+#option(ENABLE_UCX_DTL "Build DFTRACER's UCX data transport layer" OFF)
+
+# This option is off by default because non-developers should not use
+# this option under normal circumstances.
+option(DFTRACER_WARNINGS_AS_ERRORS "Build with warnings promoted to errors." OFF)
+mark_as_advanced(DFTRACER_WARNINGS_AS_ERRORS)
+
+option (DFTRACER_USE_CLANG_LIBCXX OFF)
+if (DFTRACER_USE_CLANG_LIBCXX)
+    set (GCC_TOOLCHAIN "")
+endif (DFTRACER_USE_CLANG_LIBCXX)
+
+# Options
+option (DFTRACER_DISABLE_HWLOC "Disable HWLOC" On)
+if (NOT DFTRACER_DISABLE_HWLOC) 
+    set(DFTRACER_HWLOC_ENABLE 1)
+endif()
+option (DFTRACER_BUILD_PYTHON_BINDINGS "Build python bindings." ON)
+set(DFTRACER_PYTHON_EXE "python3" CACHE STRING "Python executable to use for building.")
+set(DFTRACER_PYTHON_SITE $ENV{DFTRACER_PYTHON_SITE} CACHE STRING "Python site packages to use for building.")
+
+
+if (DFTRACER_BUILD_PYTHON_BINDINGS)
+    if (DFTRACER_PYTHON_SITE)
+        set(PYTHON_SITE_PACKAGES "${DFTRACER_PYTHON_SITE}")
+        set(MAIN_PYTHON_SITE_PACKAGES ${PYTHON_SITE_PACKAGES})
+    else()
+        set(PYTHON_SITE_PACKAGES ${CMAKE_INSTALL_PREFIX})
+        execute_process (COMMAND ${DFTRACER_PYTHON_EXE} -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())" OUTPUT_VARIABLE MAIN_PYTHON_SITE_PACKAGES OUTPUT_STRIP_TRAILING_WHITESPACE)
+    endif()
+    include_directories(${PYTHON_SITE_PACKAGES}/dftracer/include)
+    link_directories(${PYTHON_SITE_PACKAGES}/dftracer/lib)
+endif()
+
+# install dependency
+option (DFTRACER_INSTALL_DEPENDENCIES "Install DFTracer dependencies" OFF)
+
+# testing
+option (DFTRACER_ENABLE_TESTS "Enable tests for DFTRACER." OFF)
+option (DFTRACER_ENABLE_DLIO_BENCHMARK_TESTS "Enable dlio_benchmark tests" OFF)
+option (DFTRACER_ENABLE_PAPER_TESTS "Enable paper tests" OFF)
+
+#------------------------------------------------------------------------------
+# Compiler setup
+#------------------------------------------------------------------------------
+include(ExternalProject)
+# It requires include(GNUInstallDirs) before if that is needed
+include(SetupCompiler)
+
+#------------------------------------------------------------------------------
+# Build Type based configurations
+#------------------------------------------------------------------------------
+
+if(CMAKE_BUILD_TYPE STREQUAL "")
+    set(CMAKE_BUILD_TYPE "Release") # Setting default as Release
+endif()
+
+if (NOT DEFINED BUILD_SHARED_LIBS)
+    set(BUILD_SHARED_LIBS ON)
+endif ()
+#------------------------------------------------------------------------------
+# Disallow in-source build
+#------------------------------------------------------------------------------
+if ("${CMAKE_CURRENT_SOURCE_DIR}" STREQUAL "${CMAKE_BINARY_DIR}")
+    message(FATAL_ERROR
+            "${PROJECT_NAME} requires an out of source Build. "
+            "Please create a separate binary directory and run CMake there.")
+endif ()
+#------------------------------------------------------------------------------
+# Set a default build type if none was specified
+#------------------------------------------------------------------------------
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+    message(STATUS "Setting build type to 'RelWithDebInfo' as none was specified.")
+    set(CMAKE_BUILD_TYPE RelWithDebInfo CACHE STRING "Choose the type of build." FORCE)
+    # Set the possible values of build type for cmake-gui
+    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release"
+            "MinSizeRel" "RelWithDebInfo")
+endif ()
+#------------------------------------------------------------------------------
+# Dependencies
+#------------------------------------------------------------------------------
+
+if (DFTRACER_INSTALL_DEPENDENCIES) 
+    message(STATUS "[${PROJECT_NAME}] downloading dependencies. Please run make for downloading depedencies and then do reconfigure without dependency flag.")
+    message(STATUS "[${PROJECT_NAME}] Installing depedencies at ${CMAKE_INSTALL_PREFIX}")
+    add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/dependency)
+else()
+# Required Dependencies
+# =============================================================================
+set(DEPENDENCY_LIB "")
+find_package(cpp-logger 1.0.0 REQUIRED)
+if (${cpp-logger_FOUND})
+    include_directories(${CPP_LOGGER_INCLUDE_DIRS})
+    set(DEPENDENCY_LIB ${DEPENDENCY_LIB} ${CPP_LOGGER_LIBRARIES})
+    message(STATUS "[CPP_LOGGER] found cpp-logger at ${CPP_LOGGER_INCLUDE_DIRS}")
+else ()
+    message(FATAL_ERROR "-- [CPP_LOGGER] is needed for ${PROJECT_NAME} build")
+endif ()
+find_package(brahma REQUIRED)
+if (${brahma_FOUND})
+    message(STATUS "[BRAHMA] found brahma at ${BRAHMA_INCLUDE_DIRS}")
+    include_directories(${BRAHMA_INCLUDE_DIRS})
+    set(DEPENDENCY_LIB ${DEPENDENCY_LIB} ${BRAHMA_LIBRARIES})
+else ()
+    message(FATAL_ERROR "-- [BRAHMA] is needed for ${PROJECT_NAME} build")
+endif ()
+find_package(yaml-cpp REQUIRED)
+if (${yaml-cpp_FOUND})
+    message(STATUS "[DFTRACER] found yaml-cpp at ${YAML_CPP_INCLUDE_DIR}")
+    include_directories(${YAML_CPP_INCLUDE_DIR})
+    set(YAML_CPP_LIBRARY_DIR "${YAML_CPP_CMAKE_DIR}/../../")
+    set(DEPENDENCY_LIB ${DEPENDENCY_LIB} -L${YAML_CPP_LIBRARY_DIR} ${YAML_CPP_LIBRARIES})
+else ()
+    message(FATAL_ERROR "-- [DFTRACER] yaml-cpp is needed for ${PROJECT_NAME} build")
+endif ()
+
+# Optional Dependencies
+# =============================================================================
+if (DFTRACER_BUILD_PYTHON_BINDINGS)
+    find_package(pybind11 REQUIRED)
+    #add_subdirectory(dependency/py11bind)
+endif()
+if (NOT DFTRACER_DISABLE_HWLOC)
+    find_package(HWLOC REQUIRED)
+    if (${HWLOC_FOUND})
+        include_directories(${HWLOC_INCLUDE_DIRS})
+        set(DEPENDENCY_LIB ${DEPENDENCY_LIB} ${HWLOC_LIBRARIES})
+        message(STATUS "[DFTRACER] found hwloc at ${HWLOC_INCLUDE_DIRS}")
+    else ()
+        message(FATAL_ERROR "-- [DFTRACER] hwloc is needed for ${PROJECT_NAME} build with -DDFTRACER_DISABLE_HWLOC-ON option.")
+    endif ()
+endif()
+
+
+
+
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src)
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)
+set(DFTRACER_PRELOAD_SRC ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/dftracer_preload.cpp)
+set(DFTRACER_PRELOAD_PRIVATE_INCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/dftracer_preload.h)
+
+set(DFTRACER_CORE_SRC ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/brahma/posix.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/brahma/stdio.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/writer/chrome_writer.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/utils/posix_internal.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/dftracer.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/core/dftracer_main.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/utils/configuration_manager.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/df_logger.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/utils/utils.cpp)
+set(DFTRACER_CORE_PUBLIC_INCLUDE
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/dftracer/dftracer.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/dftracer/core/constants.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/dftracer/core/typedef.h)
+set(DFTRACER_CORE_PRIVATE_INCLUDE
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/utils/posix_internal.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/utils/utils.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/brahma/posix.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/brahma/stdio.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/core/dftracer_main.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/core/macro.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/core/singleton.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/utils/configuration_manager.h)
+add_library(${PROJECT_NAME} SHARED)
+target_link_libraries(${PROJECT_NAME} ${DEPENDENCY_LIB})
+add_library(${PROJECT_NAME}_preload SHARED)
+target_link_libraries(${PROJECT_NAME}_preload ${DEPENDENCY_LIB} ${PROJECT_NAME})
+if (DFTRACER_BUILD_PYTHON_BINDINGS)
+    pybind11_add_module(py${PROJECT_NAME} ${DFTRACER_CORE_SRC} ${CMAKE_CURRENT_SOURCE_DIR}/src/dftracer/pydftracer.cpp)
+    target_compile_definitions(py${PROJECT_NAME} PRIVATE VERSION_INFO=${EXAMPLE_VERSION_INFO})
+    target_link_libraries(py${PROJECT_NAME} PRIVATE ${DEPENDENCY_LIB})
+endif()
+target_sources(${PROJECT_NAME}
+        PRIVATE
+        ${DFTRACER_CORE_SRC}
+        )
+target_sources(${PROJECT_NAME}_preload
+        PRIVATE
+        ${DFTRACER_PRELOAD_SRC}
+        )
+target_include_directories(${PROJECT_NAME}
+        PRIVATE
+        # where the library itself will look for its internal headers
+        ${CMAKE_CURRENT_SOURCE_DIR}/src
+        PUBLIC
+        # where top-level project will look for the library's public headers
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+        # where external projects will look for the library's public headers
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+        )
+set_target_properties(${PROJECT_NAME}
+        PROPERTIES
+        DEBUG_OUTPUT_NAME ${PROJECT_NAME}
+        RELEASE_OUTPUT_NAME ${PROJECT_NAME}
+        MINSIZEREL_OUTPUT_NAME ${PROJECT_NAME}
+        RELWITHDEBINFO_OUTPUT_NAME ${PROJECT_NAME}
+        VERSION ${DFTRACER_PACKAGE_VERSION}
+        SOVERSION ${DFTRACER_PACKAGE_VERSION}
+        )
+
+dftracer_install_headers("${DFTRACER_CORE_PUBLIC_INCLUDE}")
+install(
+        TARGETS ${PROJECT_NAME}
+        EXPORT ${DFTRACER_EXPORTED_TARGETS}
+        LIBRARY DESTINATION ${DFTRACER_INSTALL_LIB_DIR}
+        ARCHIVE DESTINATION ${DFTRACER_INSTALL_LIB_DIR}
+        RUNTIME DESTINATION ${DFTRACER_INSTALL_BIN_DIR}
+)
+install(TARGETS ${PROJECT_NAME}
+        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+install(TARGETS ${PROJECT_NAME}_preload
+        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+
+install(
+    TARGETS
+    ${PROJECT_NAME}_preload
+    EXPORT
+    ${DFTRACER_EXPORTED_TARGETS}
+    LIBRARY DESTINATION ${DFTRACER_INSTALL_LIB_DIR}
+    ARCHIVE DESTINATION ${DFTRACER_INSTALL_LIB_DIR}
+    RUNTIME DESTINATION ${DFTRACER_INSTALL_BIN_DIR}
+)
+if (DFTRACER_BUILD_PYTHON_BINDINGS)
+    install(TARGETS py${PROJECT_NAME}
+            LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+            PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+    file(GENERATE OUTPUT ${CMAKE_BINARY_DIR}/symlink.sh CONTENT "echo -- Installing: symlink ${MAIN_PYTHON_SITE_PACKAGES}/$<TARGET_FILE_NAME:py${PROJECT_NAME}> from ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/$<TARGET_FILE_NAME:py${PROJECT_NAME}>;ln -sf ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/$<TARGET_FILE_NAME:py${PROJECT_NAME}> ${MAIN_PYTHON_SITE_PACKAGES}/$<TARGET_FILE_NAME:py${PROJECT_NAME}>")
+    install(CODE "execute_process(
+                COMMAND bash -c \"set -e
+                chmod +x ${CMAKE_BINARY_DIR}/symlink.sh
+                . ${CMAKE_BINARY_DIR}/symlink.sh
+                \")")
+endif()
+#cmake_policy(SET CMP0079 NEW) # In case that we need more control over the target building order
+
+if(DFTRACER_ENABLE_TESTS)
+    message("-- " "[DFTracer] Enabling Testing")
+    if(CMAKE_BUILD_TYPE STREQUAL "PROFILE")
+        message("-- " "[DFTracer] building with CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE}")
+        set(CMAKE_C_FLAGS_PROFILE --coverage)
+        set(CMAKE_CXX_FLAGS_PROFILE --coverage)
+    endif()
+    enable_testing()
+    add_subdirectory(test)
+    if(CMAKE_BUILD_TYPE STREQUAL "PROFILE")
+        get_property(COVERAGE_FILE_LIST GLOBAL PROPERTY COVERAGE_FILES)
+        add_custom_command(OUTPUT default.profdata COMMAND llvm-profdata merge -sparse ${COVERAGE_FILE_LIST} -o default.profdata VERBATIM)
+        add_custom_target(merged_coverage DEPENDS default.profdata)
+    endif()
+endif()
+
+#-----------------------------------------------------------------------------
+# Configure the config.cmake file for the build directory
+#-----------------------------------------------------------------------------
+configure_file(
+        ${CMAKE_CURRENT_SOURCE_DIR}/cmake/configure_files/${PROJECT_NAME}-config.cmake.build.in
+        ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/cmake/${PROJECT_NAME}/${PROJECT_NAME}-config.cmake @ONLY
+)
+
+configure_file(
+        ${CMAKE_CURRENT_SOURCE_DIR}/cmake/configure_files/${PROJECT_NAME}-config.cmake.install.in
+        ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/cmake/${PROJECT_NAME}/install/${PROJECT_NAME}-config.cmake @ONLY
+)
+install(
+        FILES
+        ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/cmake/${PROJECT_NAME}/install/${PROJECT_NAME}-config.cmake
+        DESTINATION
+        ${DFTRACER_LIBDIR}/cmake/${PROJECT_NAME}
+)
+#-----------------------------------------------------------------------------
+# Configure the ${PROJECT_NAME}-config-version .cmake file for the install directory
+#-----------------------------------------------------------------------------
+configure_file(
+        ${CMAKE_CURRENT_SOURCE_DIR}/cmake/configure_files/${PROJECT_NAME}-config-version.cmake.in
+        ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/cmake/${PROJECT_NAME}/${PROJECT_NAME}-config-version.cmake @ONLY
+)
+
+install(
+        FILES
+        ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/cmake/${PROJECT_NAME}/${PROJECT_NAME}-config-version.cmake
+        DESTINATION
+        ${DFTRACER_LIBDIR}/cmake/${PROJECT_NAME}
+)
+
+export(EXPORT ${DFTRACER_EXPORTED_TARGETS}
+        FILE "${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/cmake/${PROJECT_NAME}/${PROJECT_NAME}Targets.cmake")
+
+# Write the configure file
+configure_file("${CMAKE_SOURCE_DIR}/cmake/configure_files/dftracer_config.hpp.in"
+               "${CMAKE_INCLUDE_OUTPUT_DIRECTORY}/dftracer/dftracer_config.hpp" @ONLY)
+
+
+################################################################
+# Install DFTRACER
+################################################################
+
+include(CMakePackageConfigHelpers)
+
+# Write the version file. This is independent of build/install tree.
+write_basic_package_version_file(
+  DFTRACERConfigVersion.cmake
+  VERSION "${DFTRACER_PACKAGE_VERSION}"
+  COMPATIBILITY SameMajorVersion)
+
+install(FILES
+        "${CMAKE_INCLUDE_OUTPUT_DIRECTORY}/dftracer/dftracer_config.hpp"
+        DESTINATION
+        ${DFTRACER_INSTALL_INCLUDE_DIR}/dftracer)
+
+install(EXPORT
+        ${DFTRACER_EXPORTED_TARGETS}
+        DESTINATION
+        ${DFTRACER_LIBDIR}/cmake/${PROJECT_NAME}
+        FILE
+        ${DFTRACER_EXPORTED_TARGETS}.cmake
+        )
+
+# Install license and readme
+install(FILES
+        "${PROJECT_SOURCE_DIR}/LICENSE"
+        "${PROJECT_SOURCE_DIR}/README.md"
+        DESTINATION
+        ${DFTRACER_INSTALL_DOCDIR})
+
+
+###############################################################################
+#                      Print out configuration summary
+###############################################################################
+
+if (CMAKE_HOST_SYSTEM_NAME MATCHES "Linux")
+  set(DFTRACER_GNU_LINUX TRUE)
+endif ()
+
+# NOTE: message() outputs to stderr by default. We now use a string to
+# maintain this information and then have cmake echo it to stdout. The
+# only side effects are that if you use the CMake GUI, you won't see
+# this output anymore (they only report stderr) and that if you add
+# something to the list, you must remember your newline!
+set(_str "\n== DFTRACER Configuration Summary ==\n\n")
+string(APPEND _str "  PROJECT_SOURCE_DIR:   ${PROJECT_SOURCE_DIR}\n"
+  "  PROJECT_BINARY_DIR:   ${PROJECT_BINARY_DIR}\n\n"
+  "  CMAKE_INSTALL_PREFIX: ${CMAKE_INSTALL_PREFIX}\n"
+  "  CMAKE_BUILD_TYPE:     ${CMAKE_BUILD_TYPE}\n\n")
+if (CMAKE_BUILD_TYPE MATCHES None)
+  string(APPEND _str
+    "  CXX FLAGS:            ${CMAKE_CXX_FLAGS}\n")
+elseif (CMAKE_BUILD_TYPE MATCHES Release)
+  string(APPEND _str
+    "  CXX FLAGS:            ${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_RELEASE}\n")
+  string(APPEND _str
+    "  C FLAGS:              ${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_RELEASE}\n")
+elseif (CMAKE_BUILD_TYPE MATCHES RelWithDebInfo)
+  string(APPEND _str
+    "  CXX FLAGS:            ${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_RELWITHDEBINFO}\n")
+  string(APPEND _str
+    "  C FLAGS:              ${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_RELWITHDEBINFO}\n")
+elseif (CMAKE_BUILD_TYPE MATCHES Debug)
+  string(APPEND _str
+    "  CXX FLAGS:            ${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_DEBUG}\n")
+  string(APPEND _str
+    "  C FLAGS:              ${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_DEBUG}\n")
+endif ()
+string(APPEND _str "\n")
+
+string(APPEND _str
+  "  DFTRACER_PACKAGE_VERSION:        ${DFTRACER_PACKAGE_VERSION}\n")
+string(APPEND _str
+  "  DFTRACER_GIT_VERSION:            ${DFTRACER_GIT_VERSION}\n")
+string(APPEND _str
+  "  GLIBC_VERSION:               ${GLIBC_VERSION}\n")
+  string(APPEND _str
+  "  DFTRACER_PYTHON_EXE:               ${DFTRACER_PYTHON_EXE}\n")
+  string(APPEND _str
+  "  DFTRACER_PYTHON_SITE:               ${DFTRACER_PYTHON_SITE}\n")
+  string(APPEND _str
+  "  MAIN_PYTHON_SITE_PACKAGES:               ${MAIN_PYTHON_SITE_PACKAGES}\n")
+  string(APPEND _str
+  "  DEPENDENCY_LIB:               ${DEPENDENCY_LIB}\n")
+#Print the true/false variables
+append_str_tf(_str
+  DFTRACER_GNU_LINUX
+  DFTRACER_LIBDIR_AS_LIB
+  DFTRACER_USE_CLANG_LIBCXX
+  DFTRACER_WARNINGS_AS_ERRORS
+  DFTRACER_BUILD_PYTHON_BINDINGS
+  DFTRACER_ENABLE_TESTS
+  DFTRACER_ENABLE_DLIO_BENCHMARK_TESTS
+  DFTRACER_ENABLE_PAPER_TESTS
+)
+string(APPEND _str
+  "\n== End DFTRACER Configuration Summary ==\n")
+
+# Output to stdout
+execute_process(COMMAND ${CMAKE_COMMAND} -E echo "${_str}")
+set(_str)
+
+
+###############################################################################
+# Write a basic modulefile
+###############################################################################
+
+set(DFTRACER_MODULEFILE_NAME "dftracer-${DFTRACER_PACKAGE_VERSION}.lua")
+#  CACHE STRING
+#  "The name of the DFTRACER modulefile to install. Must end in .lua.")
+
+if (NOT (DFTRACER_MODULEFILE_NAME MATCHES ".+\.lua"))
+  message(WARNING
+    "DFTRACER_MODULEFILE_NAME must have extension \".lua\". Appending.")
+  set(DFTRACER_MODULEFILE_NAME "${DFTRACER_MODULEFILE_NAME}.lua"
+    CACHE STRING "" FORCE)
+endif ()
+
+configure_file(
+  "${CMAKE_SOURCE_DIR}/cmake/configure_files/dftracer_module.lua.in"
+  "${CMAKE_BINARY_DIR}/dftracer_module.lua.install"
+  @ONLY)
+
+install(FILES "${CMAKE_BINARY_DIR}/dftracer_module.lua.install"
+  RENAME "${DFTRACER_MODULEFILE_NAME}"
+  DESTINATION
+  "${DFTRACER_INSTALL_SYSCONFDIR}")
+
+endif()

pydftracer-1.0.1/MANIFEST.in

@@ -0,0 +1,6 @@
+graft src
+graft cmake
+graft dependency
+graft include
+
+include CMakeLists.txt

pydftracer-1.0.1/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.1
+Name: pydftracer
+Version: 1.0.1
+Summary: I/O profiler for deep learning python apps. Specifically for dlio_benchmark.
+Home-page: https://github.com/hariharan-devarajan/dftracer
+Author: Hariharan Devarajan (Hari)
+License: UNKNOWN
+Project-URL: Bug Reports, https://github.com/hariharan-devarajan/dftracer/issues
+Project-URL: Source, https://github.com/hariharan-devarajan/dftracer
+Description: [![DFTracer Build and Test](https://github.com/hariharan-devarajan/dftracer/actions/workflows/ci.yml/badge.svg)](https://github.com/hariharan-devarajan/dftracer/actions/workflows/ci.yml)
+        [![Coverage Status](https://coveralls.io/repos/github/hariharan-devarajan/dftracer/badge.svg?branch=feature/apis)](https://coveralls.io/github/hariharan-devarajan/dftracer?branch=dev)
+        [![Documentation Status](https://readthedocs.org/projects/dftracer/badge/?version=latest)](https://dftracer.readthedocs.io/en/latest/?badge=latest)
+        
+        # DFTracer v1.0.1
+        A multi-level profiler for capturing application functions and low-level system I/O calls from deep learning workloads.
+        
+        Requirements for profiler
+        1. Python > 3.7
+        2. pybind11
+        
+        
+        Requirements for analyzer
+        1. bokeh>=2.4.2
+        2. pybind11
+        3. [zindex_py](https://github.com/hariharan-devarajan/zindex.git)
+        4. pandas>=2.0.3
+        5. dask>=2023.5.0
+        6. distributed
+        7. numpy>=1.24.3
+        8. pyarrow>=12.0.1
+        9. rich>=13.6.0
+        10. python-intervals>=1.10.0.post1
+        11. matplotlib>=3.7.3
+        
+        ## Build DFTracer with pip
+        
+        Users can easily install DFTracer using pip. This is the way most python packages are installed.
+        This method would work for both native python environments and conda environments.
+        
+        ### From source
+        
+        ```bash
+            git clone git@github.com:hariharan-devarajan/dftracer.git
+            cd dftracer
+            # You can skip this for installing the dev branch.
+            # for latest stable version use master branch.
+            git checkout tags/<Release> -b <Release>
+            pip install .
+        ```
+        
+        ### From Github
+        
+        ```bash
+        DFT_VERSION=dev
+        pip install git+https://github.com/hariharan-devarajan/dftracer.git@${DFT_VERSION}
+        ```
+        
+        For more build instructions check [here](https://dftracer.readthedocs.io/en/latest/build.html)
+        
+        Usage
+        
+        ```
+            from dftracer.logger import dftracer, dft_fn
+            log_inst = dftracer.initialize_log(logfile=None, data_dir=None, process_id=-1)
+            dft_fn = dft_fn("COMPUTE")
+        
+            # Example of using function decorators
+            @dft_fn.log
+            def log_events(index):
+                sleep(1)
+        
+            # Example of function spawning and implicit I/O calls
+            def posix_calls(val):
+                index, is_spawn = val
+                path = f"{cwd}/data/demofile{index}.txt"
+                f = open(path, "w+")
+                f.write("Now the file has more content!")
+                f.close()
+                if is_spawn:
+                    print(f"Calling spawn on {index} with pid {os.getpid()}")
+                    log_inst.finalize() # This need to be called to correctly finalize DFTracer.
+                else:
+                    print(f"Not calling spawn on {index} with pid {os.getpid()}")
+        
+            # NPZ calls internally calls POSIX calls.
+            def npz_calls(index):
+                # print(f"{cwd}/data/demofile2.npz")
+                path = f"{cwd}/data/demofile{index}.npz"
+                if os.path.exists(path):
+                    os.remove(path)
+                records = np.random.randint(255, size=(8, 8, 1024), dtype=np.uint8)
+                record_labels = [0] * 1024
+                np.savez(path, x=records, y=record_labels)
+        
+            def main():
+                log_events(0)
+                npz_calls(1)
+                with get_context('spawn').Pool(1, initializer=init) as pool:
+                    pool.map(posix_calls, ((2, True),))
+                log_inst.finalize()
+        
+        
+            if __name__ == "__main__":
+                main()
+        
+        ```
+        
+        For this example, as the DFTRACER_CPP_INIT do not pass log file or data dir, we need to set ``DFTRACER_LOG_FILE`` and ``DFTRACER_DATA_DIR``.
+        By default the DFTracer mode is set to FUNCTION.
+        Example of running this configurations are:
+        
+        ```
+        
+            # the process id, app_name and .pfw will be appended by the profiler for each app and process.
+            # name of final log file is ~/log_file-<APP_NAME>-<PID>.pfw
+            DFTRACER_LOG_FILE=~/log_file
+            # Colon separated paths for including for profiler
+            DFTRACER_DATA_DIR=/dev/shm/:/p/gpfs1/$USER/dataset:$PWD/data
+            # Enable profiler
+            DFTRACER_ENABLE=1
+        ```
+        
+        For more example check [Examples](https://dftracer.readthedocs.io/en/latest/examples.html).
+        
+        
+Keywords: profiler,deep learning,I/O,benchmark,NPZ,pytorch benchmark,tensorflow benchmark
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires: pybind11
+Requires: setuptools
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Provides-Extra: test
+Provides-Extra: dfanalyzer