Add programmatic capture for PIX tool (#200)

* Add PIX functionality to WinMLRunner

* Made comments more descriptive

* Added #if and #endif Directives

Author: ryanlai2

Tools/WinMLRunner/src/Common.h

@@ -41,6 +41,12 @@ enum WINML_MODEL_TEST_PERF
 
 using namespace winrt;
 
+#define THROW_IF_FAILED(hr)                                                                                            \
+    {                                                                                                                  \
+        if (FAILED(hr))                                                                                                \
+            throw hresult_error(hr);                                                                                   \
+    }
+
 inline std::wstring MakeErrorMsg(HRESULT hr)
 {
     std::wostringstream ss;

Tools/WinMLRunner/src/OutputHelper.h

@@ -12,6 +12,11 @@
 #include <direct.h>
 #include <queue>
 
+#if defined(_AMD64_)
+// PIX markers only work on amd64
+#include <DXProgrammableCapture.h>
+#endif
+
 using namespace winrt::Windows::AI::MachineLearning;
 using namespace winrt::Windows::Storage::Streams;
 using namespace ::Windows::Graphics::DirectX::Direct3D11;
@@ -962,7 +967,10 @@ class OutputHelper
     std::vector<double> m_clockEvalTimes;
 
     std::wstring getCsvFileNamePerIterationResult() { return m_csvFileNamePerIterationResult; }
-
+#if defined(_AMD64_)
+    // PIX markers only work on amd64
+    com_ptr<IDXGraphicsAnalysis>& GetGraphicsAnalysis() { return m_graphicsAnalysis; }
+#endif
 private:
     std::wstring m_csvFileName;
     std::wstring m_csvFileNamePerIterationSummary;
@@ -981,4 +989,9 @@ class OutputHelper
     std::vector<double> m_GPUDedicatedDiff;
     std::vector<std::string> m_outputResult;
     std::vector<int> m_outputTensorHash;
+
+#if defined(_AMD64_)
+    // PIX markers only work on amd64
+    com_ptr<IDXGraphicsAnalysis> m_graphicsAnalysis = nullptr;
+#endif
 };

Tools/WinMLRunner/src/Run.cpp

@@ -8,19 +8,13 @@
 #include "Run.h"
 #include "Scenarios.h"
 
-#define THROW_IF_FAILED(hr)                                                                                            \
-    {                                                                                                                  \
-        if (FAILED(hr))                                                                                                \
-            throw hresult_error(hr);                                                                                   \
-    }
 using namespace winrt::Windows::Graphics::DirectX::Direct3D11;
 
 LearningModel LoadModel(const std::wstring& path, bool capturePerf, OutputHelper& output, const CommandLineArgs& args,
                         uint32_t iterationNum, Profiler<WINML_MODEL_TEST_PERF>& profiler)
 {
     LearningModel model = nullptr;
     output.PrintLoadingInfo(path);
-
     try
     {
         if (capturePerf)
@@ -197,7 +191,15 @@ HRESULT EvaluateModel(const LearningModel& model, const CommandLineArgs& args, O
 
     LearningModelSession session = nullptr;
     IDirect3DDevice winrtDevice = nullptr;
-
+#if defined(_AMD64_)
+    // PIX markers only work on AMD64
+    if (output.GetGraphicsAnalysis().get())
+    {
+        // If PIX tool is attached to WinMLRunner then begin capture. First capture will include
+        // session creation, first iteration bind and first iteration evaluate.
+        output.GetGraphicsAnalysis()->BeginCapture();
+    }
+#endif
     try
     {
         if (deviceCreationLocation == DeviceCreationLocation::ClientCode && deviceType != DeviceType::CPU)
@@ -308,6 +310,15 @@ HRESULT EvaluateModel(const LearningModel& model, const CommandLineArgs& args, O
             return hr.code();
         }
 
+#if defined(_AMD64_)
+        // PIX markers only work on AMD64
+        // If PIX tool was attached then capture already began for the first iteration before session creation.
+        // This is to begin PIX capture for each iteration after the first iteration.
+        if (i > 0 && output.GetGraphicsAnalysis())
+        {
+            output.GetGraphicsAnalysis()->BeginCapture();
+        }
+#endif
         HRESULT bindInputResult =
             BindInputFeatures(model, context, inputFeatures, args, output, captureIterationPerf, i, profiler);
 
@@ -344,6 +355,14 @@ HRESULT EvaluateModel(const LearningModel& model, const CommandLineArgs& args, O
                 completionString = "[SUCCESS]\n";
             }
         }
+#if defined(_AMD64_)
+        // PIX markers only work on AMD64
+        if (output.GetGraphicsAnalysis())
+        {
+            // If PIX tool is attached, then end the capture
+            output.GetGraphicsAnalysis()->EndCapture();
+        }
+#endif
     }
     printf("%s", completionString.c_str());
 
@@ -360,12 +379,12 @@ HRESULT EvaluateModel(const LearningModel& model, const CommandLineArgs& args, O
 }
 
 HRESULT EvaluateModelWithDeviceType(const LearningModel& model, const DeviceType deviceType,
-                                     const std::vector<InputBindingType>& inputBindingTypes,
-                                     const std::vector<InputDataType>& inputDataTypes,
-                                     const std::vector<DeviceCreationLocation> deviceCreationLocations,
-                                     const CommandLineArgs& args, const std::wstring& modelPath, OutputHelper& output,
-                                     Profiler<WINML_MODEL_TEST_PERF>& profiler,
-                                     TensorFeatureDescriptor& tensorDescriptor)
+                                    const std::vector<InputBindingType>& inputBindingTypes,
+                                    const std::vector<InputDataType>& inputDataTypes,
+                                    const std::vector<DeviceCreationLocation> deviceCreationLocations,
+                                    const CommandLineArgs& args, const std::wstring& modelPath, OutputHelper& output,
+                                    Profiler<WINML_MODEL_TEST_PERF>& profiler,
+                                    TensorFeatureDescriptor& tensorDescriptor)
 {
     for (const auto& inputBindingType : inputBindingTypes)
     {
@@ -452,7 +471,7 @@ HRESULT EvaluateModels(const std::vector<std::wstring>& modelPaths, const std::v
         {
             HRESULT evaluateModelWithDeviceTypeResult =
                 EvaluateModelWithDeviceType(model, deviceType, inputBindingTypes, inputDataTypes,
-                                             deviceCreationLocations, args, path, output, profiler, tensorDescriptor);
+                                            deviceCreationLocations, args, path, output, profiler, tensorDescriptor);
             if (FAILED(evaluateModelWithDeviceTypeResult))
             {
                 lastEvaluateModelResult = evaluateModelWithDeviceTypeResult;
@@ -553,6 +572,16 @@ int run(CommandLineArgs& args, Profiler<WINML_MODEL_TEST_PERF>& profiler)
     winrt::init_apartment();
     OutputHelper output(args.NumIterations());
 
+#if defined(_AMD64_)
+    // PIX markers only work on AMD64
+    // Check if PIX tool is attached to WinMLRunner
+    // Try to acquire IDXGraphicsAnalysis - this only succeeds if PIX is attached
+    if (SUCCEEDED(DXGIGetDebugInterface1(0, IID_PPV_ARGS(output.GetGraphicsAnalysis().put()))))
+    {
+        std::cout << "Detected PIX tool is attached to WinMLRunner" << std::endl;
+    }
+#endif
+
     // Profiler is a wrapper class that captures and stores timing and memory usage data on the
     // CPU and GPU.
     profiler.Enable();
@@ -590,6 +619,5 @@ int run(CommandLineArgs& args, Profiler<WINML_MODEL_TEST_PERF>& profiler)
         return EvaluateModels(modelPaths, deviceTypes, inputBindingTypes, inputDataTypes, deviceCreationLocations, args,
                               output, profiler);
     }
-
     return 0;
 }