Move utility files to utils folder (#784)

Summary: Pull Request resolved: #784 Move the utility files into a utils folder to clean up src and include directories. Move the following files: - CudaDeviceProperties - CudaUtil - Demangle - ScopeExit - ThreadUtil - WeakSymbols - cupti_call - cupti_strings Skipping time_since_epoch due to dependency in PyTorch. Test Plan: CI Differential Revision: D47566850 Pulled By: aaronenyeshi fbshipit-source-id: f720302ab044dca7ef024db08f70c3247f324627
pytorch · Jul 19, 2023 · b23e5b0 · b23e5b0
1 parent b76bdf9
commit b23e5b0
Show file tree

Hide file tree

Showing 43 changed files with 51 additions and 44 deletions.
diff --git a/libkineto/CMakeLists.txt b/libkineto/CMakeLists.txt
@@ -30,8 +30,10 @@ set(KINETO_LIBRARY_TYPE "default" CACHE STRING
 set_property(CACHE KINETO_LIBRARY_TYPE PROPERTY STRINGS default shared)
 option(KINETO_BUILD_TESTS "Build kineto unit tests" ON)
 
+set(KINETO_BASE_DIR "${CMAKE_SOURCE_DIR}/../..")
 set(LIBKINETO_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src")
 set(LIBKINETO_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include")
+set(LIBKINETO_UTILS_DIR "${CMAKE_CURRENT_SOURCE_DIR}/utils")
 set(LIBKINETO_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
 set(LIBKINETO_THIRDPARTY_DIR "${CMAKE_CURRENT_SOURCE_DIR}/third_party")
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
@@ -157,8 +159,10 @@ add_subdirectory("${IPCFABRIC_INCLUDE_DIR}")
 target_link_libraries(kineto_base PRIVATE dynolog_ipcfabric_lib)
 
 target_include_directories(kineto_base PUBLIC
+      $<BUILD_INTERFACE:${KINETO_BASE_DIR}>
       $<BUILD_INTERFACE:${LIBKINETO_INCLUDE_DIR}>
       $<BUILD_INTERFACE:${LIBKINETO_SOURCE_DIR}>
+      $<BUILD_INTERFACE:${LIBKINETO_UTILS_DIR}>
       $<BUILD_INTERFACE:${DYNOLOG_INCLUDE_DIR}>
       $<BUILD_INTERFACE:${FMT_INCLUDE_DIR}>
       $<BUILD_INTERFACE:${IPCFABRIC_INCLUDE_DIR}>
@@ -168,6 +172,7 @@ target_include_directories(kineto_base PUBLIC
       $<BUILD_INTERFACE:${ROCM_INCLUDE_DIRS}>)
 
 target_include_directories(kineto_api PUBLIC
+      $<BUILD_INTERFACE:${KINETO_BASE_DIR}>
       $<BUILD_INTERFACE:${FMT_INCLUDE_DIR}>
       $<BUILD_INTERFACE:${LIBKINETO_INCLUDE_DIR}>)
 

diff --git a/libkineto/include/GenericTraceActivity.h b/libkineto/include/GenericTraceActivity.h
@@ -13,7 +13,7 @@
 #include <thread>
 #include <vector>
 
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 #include "ITraceActivity.h"
 #include "TraceSpan.h"
 

diff --git a/libkineto/include/libkineto.h b/libkineto/include/libkineto.h
@@ -31,7 +31,7 @@
 #include "ILoggerObserver.h"
 #include "LoggingAPI.h"
 
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 
 extern "C" {
   void suppressLibkinetoLogMessages();

diff --git a/libkineto/ipcfabric/Utils.h b/libkineto/ipcfabric/Utils.h
@@ -8,6 +8,9 @@
 
 #pragma once
 
+#include <sys/types.h>
+#include <cstdint>
+
 namespace dynolog {
 namespace ipcfabric {
 

diff --git a/libkineto/libkineto_defs.bzl b/libkineto/libkineto_defs.bzl
@@ -5,14 +5,12 @@
 
 def get_libkineto_api_srcs():
     return [
-        "src/ThreadUtil.cpp",
         "src/libkineto_api.cpp",
+        "utils/ThreadUtil.cpp",
     ]
 
 def get_libkineto_cupti_srcs(with_api = True):
     return [
-        "src/CudaDeviceProperties.cpp",
-        "src/CudaUtil.cpp",
         "src/CuptiActivityApi.cpp",
         "src/CuptiActivityPlatform.cpp",
         "src/CuptiCallbackApi.cpp",
@@ -22,11 +20,12 @@ def get_libkineto_cupti_srcs(with_api = True):
         "src/CuptiRangeProfilerApi.cpp",
         "src/CuptiRangeProfilerConfig.cpp",
         "src/CuptiNvPerfMetric.cpp",
-        "src/Demangle.cpp",
         "src/EventProfiler.cpp",
         "src/EventProfilerController.cpp",
-        "src/WeakSymbols.cpp",
-        "src/cupti_strings.cpp",
+        "utils/CudaDeviceProperties.cpp",
+        "utils/CudaUtil.cpp",
+        "utils/WeakSymbols.cpp",
+        "utils/cupti_strings.cpp",
     ] + (get_libkineto_cpu_only_srcs(with_api))
 
 def get_libkineto_roctracer_srcs(with_api = True):
@@ -46,7 +45,6 @@ def get_libkineto_cpu_only_srcs(with_api = True):
         "src/ConfigLoader.cpp",
         "src/CuptiActivityApi.cpp",
         "src/DaemonConfigLoader.cpp",
-        "src/Demangle.cpp",
         "src/GenericTraceActivity.cpp",
         "src/ILoggerObserver.cpp",
         "src/IpcFabricConfigClient.cpp",
@@ -55,6 +53,7 @@ def get_libkineto_cpu_only_srcs(with_api = True):
         "src/init.cpp",
         "src/output_csv.cpp",
         "src/output_json.cpp",
+        "utils/Demangle.cpp",
     ] + (get_libkineto_api_srcs() if with_api else [])
 
 def get_libkineto_public_headers():
@@ -70,9 +69,10 @@ def get_libkineto_public_headers():
         "include/ILoggerObserver.h",
         "include/ITraceActivity.h",
         "include/TraceSpan.h",
-        "include/ThreadUtil.h",
         "include/libkineto.h",
         "include/time_since_epoch.h",
+        "utils/Demangle.h",
+        "utils/ThreadUtil.h",
     ]
 
 # kineto code should be updated to not have to

diff --git a/libkineto/src/ActivityProfilerController.cpp b/libkineto/src/ActivityProfilerController.cpp
@@ -18,7 +18,7 @@
 #ifdef HAS_ROCTRACER
 #include "RoctracerActivityApi.h"
 #endif
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 #include "output_json.h"
 #include "output_membuf.h"
 

diff --git a/libkineto/src/Config.cpp b/libkineto/src/Config.cpp
@@ -23,7 +23,7 @@
 #include <time.h>
 
 #include "Logger.h"
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 
 using namespace std::chrono;
 

diff --git a/libkineto/src/CuptiActivity.cpp b/libkineto/src/CuptiActivity.cpp
@@ -10,8 +10,8 @@
 
 #include <fmt/format.h>
 
-#include "CudaDeviceProperties.h"
-#include "Demangle.h"
+#include "kineto/libkineto/utils/CudaDeviceProperties.h"
+#include "kineto/libkineto/utils/Demangle.h"
 #include "output_base.h"
 
 namespace KINETO_NAMESPACE {

diff --git a/libkineto/src/CuptiActivity.h b/libkineto/src/CuptiActivity.h
@@ -16,8 +16,8 @@
 #include "GenericTraceActivity.h"
 #include "CuptiActivityPlatform.h"
 #include "GenericTraceActivity.h"
-#include "ThreadUtil.h"
-#include "cupti_strings.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
+#include "kineto/libkineto/utils/cupti_strings.h"
 
 namespace libkineto {
   class ActivityLogger;

diff --git a/libkineto/src/CuptiActivityApi.cpp b/libkineto/src/CuptiActivityApi.cpp
@@ -13,10 +13,10 @@
 #include <mutex>
 #include <thread>
 
-#include "cupti_call.h"
+#include "kineto/libkineto/utils/cupti_call.h"
 #include "Logger.h"
 #include "Config.h"
-#include "CudaUtil.h"
+#include "kineto/libkineto/utils/CudaUtil.h"
 
 using namespace std::chrono;
 

diff --git a/libkineto/src/CuptiActivityProfiler.cpp b/libkineto/src/CuptiActivityProfiler.cpp
@@ -24,9 +24,9 @@
 #include <cupti.h>
 // TODO(T90238193)
 // @lint-ignore-every CLANGTIDY facebook-hte-RelativeInclude
-#include "cuda_call.h"
-#include "cupti_call.h"
-#include "CudaUtil.h"
+#include "kineto/libkineto/utils/cuda_call.h"
+#include "kineto/libkineto/utils/cupti_call.h"
+#include "kineto/libkineto/utils/CudaUtil.h"
 #endif
 
 #include "Config.h"
@@ -42,7 +42,7 @@
 #include "output_base.h"
 
 #include "Logger.h"
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 
 using namespace std::chrono;
 using std::string;

diff --git a/libkineto/src/CuptiActivityProfiler.h b/libkineto/src/CuptiActivityProfiler.h
@@ -30,7 +30,7 @@
 #include "CuptiActivity.h"
 #endif // HAS_CUPTI
 
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 #include "TraceSpan.h"
 #include "libkineto.h"
 #include "output_base.h"

diff --git a/libkineto/src/CuptiCallbackApi.cpp b/libkineto/src/CuptiCallbackApi.cpp
@@ -18,7 +18,7 @@
 #include <shared_mutex>
 
 #ifdef HAS_CUPTI
-#include "cupti_call.h"
+#include "kineto/libkineto/utils/cupti_call.h"
 #endif
 #include "Logger.h"
 

diff --git a/libkineto/src/CuptiEventApi.cpp b/libkineto/src/CuptiEventApi.cpp
@@ -11,7 +11,7 @@
 #include <chrono>
 
 #include "Logger.h"
-#include "cupti_call.h"
+#include "kineto/libkineto/utils/cupti_call.h"
 
 using std::vector;
 

diff --git a/libkineto/src/CuptiMetricApi.cpp b/libkineto/src/CuptiMetricApi.cpp
@@ -11,7 +11,7 @@
 #include <chrono>
 
 #include "Logger.h"
-#include "cupti_call.h"
+#include "kineto/libkineto/utils/cupti_call.h"
 
 using std::vector;
 

diff --git a/libkineto/src/CuptiNvPerfMetric.cpp b/libkineto/src/CuptiNvPerfMetric.cpp
@@ -17,7 +17,7 @@
 
 // TODO(T90238193)
 // @lint-ignore-every CLANGTIDY facebook-hte-RelativeInclude
-#include "ScopeExit.h"
+#include "kineto/libkineto/utils/ScopeExit.h"
 #include "CuptiNvPerfMetric.h"
 #include "Logger.h"
 

diff --git a/libkineto/src/CuptiRangeProfiler.cpp b/libkineto/src/CuptiRangeProfiler.cpp
@@ -19,7 +19,7 @@
 #include "output_base.h"
 #include "CuptiRangeProfiler.h"
 #include "CuptiRangeProfilerConfig.h"
-#include "Demangle.h"
+#include "kineto/libkineto/utils/Demangle.h"
 
 namespace KINETO_NAMESPACE {
 

diff --git a/libkineto/src/CuptiRangeProfilerApi.cpp b/libkineto/src/CuptiRangeProfilerApi.cpp
@@ -16,12 +16,12 @@
 #include <unordered_map>
 
 #ifdef HAS_CUPTI
-#include "cupti_call.h"
+#include "kineto/libkineto/utils/cupti_call.h"
 #endif
 
 #include "time_since_epoch.h"
 #include "Logger.h"
-#include "Demangle.h"
+#include "kineto/libkineto/utils/Demangle.h"
 
 // TODO(T90238193)
 // @lint-ignore-every CLANGTIDY facebook-hte-RelativeInclude
@@ -30,7 +30,7 @@
 #if HAS_CUPTI_RANGE_PROFILER
 #include <cupti.h>
 #include <nvperf_host.h>
-#include "cupti_call.h"
+#include "kineto/libkineto/utils/cupti_call.h"
 #endif // HAS_CUPTI_RANGE_PROFILER
 
 namespace KINETO_NAMESPACE {

diff --git a/libkineto/src/EventProfilerController.cpp b/libkineto/src/EventProfilerController.cpp
@@ -20,7 +20,7 @@
 #include "output_csv.h"
 
 #include "Logger.h"
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 
 using namespace std::chrono;
 using std::unique_ptr;

diff --git a/libkineto/src/IpcFabricConfigClient.cpp b/libkineto/src/IpcFabricConfigClient.cpp
@@ -17,7 +17,7 @@
 
 // TODO(T90238193)
 // @lint-ignore-every CLANGTIDY facebook-hte-RelativeInclude
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 
 namespace KINETO_NAMESPACE {
 

diff --git a/libkineto/src/Logger.cpp b/libkineto/src/Logger.cpp
@@ -22,7 +22,7 @@
 #include <fmt/chrono.h>
 #include <fmt/format.h>
 
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 
 namespace KINETO_NAMESPACE {
 

diff --git a/libkineto/src/RoctracerActivityApi.cpp b/libkineto/src/RoctracerActivityApi.cpp
@@ -13,9 +13,9 @@
 
 #include "RoctracerActivityApi.h"
 #include "RoctracerLogger.h"
-#include "Demangle.h"
+#include "kineto/libkineto/utils/Demangle.h"
 #include "output_base.h"
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 
 typedef uint64_t timestamp_t;
 

diff --git a/libkineto/src/RoctracerLogger.cpp b/libkineto/src/RoctracerLogger.cpp
@@ -12,7 +12,7 @@
 #include <chrono>
 #include <time.h>
 
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 
 typedef uint64_t timestamp_t;
 
@@ -360,4 +360,3 @@ bool ApiIdList::contains(uint32_t apiId)
 {
   return (filter_.find(apiId) != filter_.end()) ? !invert_ : invert_;  // XOR
 }
-
diff --git a/libkineto/src/init.cpp b/libkineto/src/init.cpp
@@ -20,7 +20,7 @@
 #include "CuptiRangeProfiler.h"
 #include "EventProfilerController.h"
 #endif
-#include "cupti_call.h"
+#include "kineto/libkineto/utils/cupti_call.h"
 #include "libkineto.h"
 
 #include "Logger.h"

diff --git a/libkineto/src/libkineto_api.cpp b/libkineto/src/libkineto_api.cpp
@@ -9,7 +9,7 @@
 #include "libkineto.h"
 
 #include "ConfigLoader.h"
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 
 namespace libkineto {
 

diff --git a/libkineto/src/output_base.h b/libkineto/src/output_base.h
@@ -16,7 +16,7 @@
 
 #include "ActivityBuffers.h"
 #include "GenericTraceActivity.h"
-#include "ThreadUtil.h"
+#include "kineto/libkineto/utils/ThreadUtil.h"
 #include "TraceSpan.h"
 
 namespace KINETO_NAMESPACE {

diff --git a/libkineto/src/output_json.cpp b/libkineto/src/output_json.cpp
@@ -15,7 +15,7 @@
 
 #include "Config.h"
 #ifdef HAS_CUPTI
-#include "CudaDeviceProperties.h"
+#include "kineto/libkineto/utils/CudaDeviceProperties.h"
 #endif // HAS_CUPTI
 #include "TraceSpan.h"
 

diff --git a/libkineto/test/CuptiStringsTest.cpp b/libkineto/test/CuptiStringsTest.cpp
@@ -8,7 +8,7 @@
 
 #include <gtest/gtest.h>
 
-#include "src/cupti_strings.h"
+#include "utils/cupti_strings.h"
 
 using namespace KINETO_NAMESPACE;
 

diff --git a/libkineto/test/PidInfoTest.cpp b/libkineto/test/PidInfoTest.cpp
@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-#include "include/ThreadUtil.h"
+#include "utils/ThreadUtil.h"
 
 #include <atomic>
 #include <thread>

diff --git a/libkineto/src/CudaDeviceProperties.cpp → libkineto/utils/CudaDeviceProperties.cpp b/libkineto/src/CudaDeviceProperties.cpp → libkineto/utils/CudaDeviceProperties.cpp
diff --git a/libkineto/src/CudaDeviceProperties.h → libkineto/utils/CudaDeviceProperties.h b/libkineto/src/CudaDeviceProperties.h → libkineto/utils/CudaDeviceProperties.h
diff --git a/libkineto/src/CudaUtil.cpp → libkineto/utils/CudaUtil.cpp b/libkineto/src/CudaUtil.cpp → libkineto/utils/CudaUtil.cpp
diff --git a/libkineto/src/CudaUtil.h → libkineto/utils/CudaUtil.h b/libkineto/src/CudaUtil.h → libkineto/utils/CudaUtil.h
diff --git a/libkineto/src/Demangle.cpp → libkineto/utils/Demangle.cpp b/libkineto/src/Demangle.cpp → libkineto/utils/Demangle.cpp
diff --git a/libkineto/src/Demangle.h → libkineto/utils/Demangle.h b/libkineto/src/Demangle.h → libkineto/utils/Demangle.h
diff --git a/libkineto/src/ScopeExit.h → libkineto/utils/ScopeExit.h b/libkineto/src/ScopeExit.h → libkineto/utils/ScopeExit.h
diff --git a/libkineto/src/ThreadUtil.cpp → libkineto/utils/ThreadUtil.cpp b/libkineto/src/ThreadUtil.cpp → libkineto/utils/ThreadUtil.cpp
diff --git a/libkineto/include/ThreadUtil.h → libkineto/utils/ThreadUtil.h b/libkineto/include/ThreadUtil.h → libkineto/utils/ThreadUtil.h
diff --git a/libkineto/src/WeakSymbols.cpp → libkineto/utils/WeakSymbols.cpp b/libkineto/src/WeakSymbols.cpp → libkineto/utils/WeakSymbols.cpp
diff --git a/libkineto/src/cuda_call.h → libkineto/utils/cuda_call.h b/libkineto/src/cuda_call.h → libkineto/utils/cuda_call.h
diff --git a/libkineto/src/cupti_call.h → libkineto/utils/cupti_call.h b/libkineto/src/cupti_call.h → libkineto/utils/cupti_call.h
diff --git a/libkineto/src/cupti_strings.cpp → libkineto/utils/cupti_strings.cpp b/libkineto/src/cupti_strings.cpp → libkineto/utils/cupti_strings.cpp
diff --git a/libkineto/src/cupti_strings.h → libkineto/utils/cupti_strings.h b/libkineto/src/cupti_strings.h → libkineto/utils/cupti_strings.h