Move GTPin common code into utils directory (intel#50)

* Move common gtpin code to utils

* Fix copyright

* Version update

Author: idubinov

VERSION

@@ -1 +1 @@
-0.49.21
+0.49.22

chapters/binary_instrumentation/GTPin.md

@@ -1,4 +1,7 @@
 # Binary Instrumentation with Graphics Technology Pin (GT Pin)
+
+This chapter is outdated and describes deprecated interface GTPin v2. [Actual GTPin documentation](http://pin.iil.intel.com/pin/gtpin/Doxygen/html/)
+
 ## Overview
 This chapter describes **Graphics Technology Pin (GT Pin)** -  the solution for binary code instrumentation on Intel(R) Processor Graphics. It is a [Pin](http://pintool.intel.com/) like system that instruments Gen execution unit (EU) binaries and is used to build architectural and software tools to analyze shaders or compute kernels running on Gen EUs.
 

samples/gpu_inst_count/CMakeLists.txt

@@ -21,9 +21,9 @@ if(CMAKE_INCLUDE_PATH)
     PUBLIC "${CMAKE_INCLUDE_PATH}")
 endif()
 
-add_subdirectory(gtpin_dev_kit)
-FindGTPinDevKitHeaders(gput_inst_count)
-target_link_libraries(gput_inst_count gtpin_dev_kit)
+add_subdirectory("${PROJECT_SOURCE_DIR}/../../utils/gtpin_utils" gtpin_tool_utils)
+FindGTPinToolUtilsHeaders(gput_inst_count)
+target_link_libraries(gput_inst_count gtpin_tool_utils)
 
 FindGTPinLibrary(gput_inst_count)
 FindGTPinHeaders(gput_inst_count)

samples/gpu_inst_count/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-This sample is a simple LD_PRELOAD based tool that allows to collect dynamic execution count for every OpenCL(TM) kernel instruction.
+This sample is a simple LD_PRELOAD based tool that allows to collect dynamic execution count for every GPU kernel instruction. The sample uses common code from utils/gtpin_utils.
 
 As a result, assembly listing annotated with dynamic instruction count for each kernel will be printed.
 
@@ -83,10 +83,9 @@ As a result, assembly listing annotated with dynamic instruction count for each
 
 ## Prerequisites
 
-- [CMake](https://cmake.org/) (version 3.12 and above)
+- [CMake](https://cmake.org/) (version 3.16 and above)
 - [Git](https://git-scm.com/) (version 1.8 and above)
-- [Python](https://www.python.org/) (version 2.7 and above)
-- [Graphics Technology Pin (GT Pin)](https://software.intel.com/content/www/us/en/develop/articles/gtpin.html)
+- [Graphics Technology Pin (GT Pin)](https://software.intel.com/content/www/us/en/develop/articles/gtpin.html) (version 3.7 and above)
 
 ## Build and Run
 

samples/gpu_inst_count/gpu_inst_count.cc

@@ -1,8 +1,13 @@
+//==============================================================
+// Copyright (C) Intel Corporation
+//
+// SPDX-License-Identifier: MIT
+// =============================================================
 
 #include "gpu_inst_count.hpp"
 
-using namespace gtpin_prof;
-using namespace gtpin;
+namespace gtpin {
+namespace gtpin_prof {
 
 /********************
  * Requered functions - should be implemented
@@ -61,7 +66,7 @@ PROF_STATUS GpuInstCountKernel::Instrument(IGtKernelInstrument& instrumentor) {
     GtGenProcedure proc;
     PointOfInterest poi(instrumentor, m_profileArray, bblIdx);
     poi.InstructionCounterAnalysis(offsetof(GpuInstCountRecord, count));
-    poi.ClosePOI(proc);
+    poi.FinishPOI(proc);
     instrumentor.InstrumentInstruction(it->second, GtIpoint::Before(), proc);
   }
 
@@ -130,3 +135,6 @@ std::shared_ptr<InvocationData> GpuInstCountFactory::MakeInvocationData(
 std::shared_ptr<ResultData> GpuInstCountFactory::MakeResultData() {
   return std::make_shared<GpuInstCountResultData>();
 };
+
+}
+}

samples/gpu_inst_count/gpu_inst_count.hpp

@@ -1,3 +1,9 @@
+//==============================================================
+// Copyright (C) Intel Corporation
+//
+// SPDX-License-Identifier: MIT
+// =============================================================
+
 #ifndef PLGG_GPU_INST_COUNT_H
 #define PLGG_GPU_INST_COUNT_H
 
@@ -12,10 +18,9 @@
  * @file Header file for GTPin-based tool draft
  */
 
+namespace gtpin {
 namespace gtpin_prof {
 
-using namespace gtpin;
-
 /**
  * RESULTS classes
  * Extend tool-specific delivered classes with fields specific for the profiler.
@@ -146,5 +151,6 @@ class GpuInstCountProfiler : public GTPinProfilerBase {
 };
 
 }  // namespace gtpin_prof
+}
 
 #endif  // PLGG_GPU_INST_COUNT_H

samples/gpu_inst_count/gtpin_dev_kit/CMakeLists.txt

@@ -11,8 +11,8 @@
 #include "gpu_inst_count.hpp"
 #include "utils.h"
 
-using namespace gtpin_prof;
 using namespace gtpin;
+using namespace gtpin_prof;
 
 class GpuInstCountTxtWriter : public StreamGTPinDataWriter {
  public:

samples/gpu_inst_count/tool.cc

@@ -0,0 +1,34 @@
+set(PTI_GTPIN_TOOL_BASE_DIR ${CMAKE_CURRENT_LIST_DIR} CACHE INTERNAL "")
+
+include("../../build_utils/CMakeLists.txt")
+SetRequiredCMakeVersion()
+cmake_minimum_required(VERSION ${REQUIRED_CMAKE_VERSION})
+
+macro(FindGTPinToolUtilsHeaders TARGET)
+  target_include_directories(${TARGET}
+    PUBLIC "${PTI_GTPIN_TOOL_BASE_DIR}/include")
+endmacro()
+
+project(PTI_GTPin_tool_utils CXX)
+SetCompilerFlags()
+SetBuildType()
+
+add_library(gtpin_tool_utils STATIC
+  "${PTI_GTPIN_TOOL_BASE_DIR}/src/filter.cc"
+  "${PTI_GTPIN_TOOL_BASE_DIR}/src/gtpin_capsules.cc"
+  "${PTI_GTPIN_TOOL_BASE_DIR}/src/gtpin_tool.cc"
+  "${PTI_GTPIN_TOOL_BASE_DIR}/src/prof_lib_gpu_gtpin.cc"
+  "${PTI_GTPIN_TOOL_BASE_DIR}/src/writer.cc"
+  )
+FindGTPinToolUtilsHeaders(gtpin_tool_utils)
+set_property(TARGET gtpin_tool_utils PROPERTY POSITION_INDEPENDENT_CODE ON)
+target_include_directories(gtpin_tool_utils
+  PRIVATE "${PTI_GTPIN_TOOL_BASE_DIR}/../../sdk/src/utils")
+if(CMAKE_INCLUDE_PATH)
+  target_include_directories(gtpin_tool_utils
+    PUBLIC "${CMAKE_INCLUDE_PATH}")
+endif()
+
+FindGTPinLibrary(gtpin_tool_utils)
+FindGTPinHeaders(gtpin_tool_utils)
+FindGTPinUtils(gtpin_tool_utils)

utils/gtpin_utils/CMakeLists.txt

@@ -1,5 +1,11 @@
-#ifndef DEF_GPU_GTPIN_H
-#define DEF_GPU_GTPIN_H
+//==============================================================
+// Copyright (C) Intel Corporation
+//
+// SPDX-License-Identifier: MIT
+// =============================================================
+
+#ifndef PTI_GTPIN_UTILS_H
+#define PTI_GTPIN_UTILS_H
 
 #include <api/gtpin_api.h>
 #include <stdint.h>
@@ -25,14 +31,13 @@
 #define MAX_SIMD_WIDTH 8 * MAX_SIMD_WIDTH_BYTES
 #define MAX_SIMD_WIDTH_STR STR(MAX_SIMD_WIDTH)
 
-using namespace gtpin;
-
+namespace gtpin {
 namespace gtpin_prof {
 
 enum PROF_STATUS { PROF_STATUS_SUCCESS = 0, PROF_STATUS_ERROR, PROF_STATUS_NOTHING_TO_INSTRUMENT };
 
 typedef uint32_t KernelRun;
-typedef uint32_t KernelId;
+typedef uint32_t KernelId;  // TODO: rename into GTPin kernel ID
 typedef uint32_t InstructionOffset;
 
 /**
@@ -88,18 +93,14 @@ struct GTPinKernelExecDesriptor : public KernelExecDesriptor {
 
   GTPinKernelExecDesriptor(const IGtKernelDispatch& dispatcher, KernelRun runGlobalIdx,
                            KernelRun runIdx = -1)
-      :  /// TODO: check that bug fixed, use next gtpinDispatchId instead of
-         /// enqueue-based one gtpinDispatchId(dispatcher.DispatchId()),
-        KernelExecDesriptor(dispatcher.Kernel().Name().Get(), dispatcher.Kernel().Id(),
-                            runGlobalIdx, runIdx) {
-    GtKernelExecDesc execDesc;
-    dispatcher.GetExecDescriptor(execDesc);
-    gtpinDispatchId = execDesc.l0ExecDesc.enqueue_index;
-  };
+      : KernelExecDesriptor(dispatcher.Kernel().Name().Get(), dispatcher.Kernel().Id(),
+                            runGlobalIdx, runIdx),
+        gtpinDispatchId(dispatcher.DispatchId()){};
 
   uint64_t gtpinDispatchId = -1;
 };
 
 }  // namespace gtpin_prof
+}  // namespace gtpin
 
-#endif  // DEF_GPU_GTPIN_H
+#endif  // PTI_GTPIN_UTILS_H