add support for dumping command buffers to a file

Author: bashbaug

docs/controls.md

@@ -525,6 +525,16 @@ This is the list of options that is implicitly passed to CLANG to build a non-Op
 
 This is the list of options that is implicitly passed to CLANG to build an OpenCL 2.0 SPIR-V module.  Any application-provided build options will be appended to these build options.
 
+### Controls for Dumping Command Buffers
+
+##### `OmitCommandBufferNumber` (bool)
+
+If set to a nonzero value, the Intercept Layer for OpenCL Applications will omit the command buffer number from dumped file names and hash tracking.  This can produce deterministic results even if command buffers are creatd and finalized in a non-deterministic order (say, by multiple threads).
+
+##### `DumpCommandBuffers` (bool)
+
+If set to a nonzero value, the Intercept Layer for OpenCL Applications will dump the commands and dependencies in a command buffer to a file when the command buffer is successfully finalized.  The file name will have the form "CLI\_\<Command BufferNumber\>\_\<Uniqueue Command BufferHash Code\>\_cmdbuf.dot".   The command buffer is described using the DOT graph description language.
+
 ### Controls for Dumping and Injecting Buffers and Images
 
 ##### `DumpBufferHashes` (bool)

intercept/src/controls.h

@@ -121,7 +121,8 @@ CLI_CONTROL( std::string,   DefaultOptions,                         "-cc1 -x cl
 CLI_CONTROL( std::string,   OpenCL2Options,                         "-cc1 -x cl -cl-std=CL2.0 -D__OPENCL_C_VERSION__=200 -D__OPENCL_VERSION__=200 -emit-spirv -triple=spir", "This is the list of options that is implicitly passed to CLANG to build an OpenCL 2.0 SPIR-V module.  Any application-provided build options will be appended to these build options." )
 
 CLI_CONTROL_SEPARATOR( Controls for Dumping Command Buffers: )
-CLI_CONTROL( bool,          DumpCommandBuffers,                     false, "TODO" )
+CLI_CONTROL( bool,          OmitCommandBufferNumber,                false, "If set to a nonzero value, the Intercept Layer for OpenCL Applications will omit the command buffer number from dumped file names and hash tracking.  This can produce deterministic results even if command buffers are creatd and finalized in a non-deterministic order (say, by multiple threads)." )
+CLI_CONTROL( bool,          DumpCommandBuffers,                     false, "If set to a nonzero value, the Intercept Layer for OpenCL Applications will dump the commands and dependencies in a command buffer to a file when the command buffer is successfully finalized.  The file name will have the form \"CLI_<Command BufferNumber>_<Uniqueue Command BufferHash Code>_cmdbuf.dot\".   The command buffer is described using the DOT graph description language." )
 
 CLI_CONTROL_SEPARATOR( Controls for Dumping and Injecting Buffers and Images: )
 CLI_CONTROL( bool,          DumpBufferHashes,                       false, "If set to a nonzero value, the Intercept Layer for OpenCL Applications will dump hashes of a buffer, SVM, or USM allocation rather than the full contents of the buffer.  This can be useful to identify which kernel enqueues generate different results without requiring a large amount of disk space." )

intercept/src/intercept.cpp

@@ -155,6 +155,8 @@ CLIntercept::CLIntercept( void* pGlobalData )
     m_AubCaptureKernelEnqueueSkipCounter = 0;
     m_AubCaptureKernelEnqueueCaptureCounter = 0;
 
+    m_CommandBufferNumber = 0;
+
 #define CLI_CONTROL( _type, _name, _init, _desc )   m_Config . _name = _init;
 #include "controls.h"
 #undef CLI_CONTROL
@@ -6740,7 +6742,56 @@ void CLIntercept::traceCommandBufferFinalize(
 
     SCommandBufferTraceInfo& traceInfo = m_CommandBufferTraceInfoMap[ cmdbuf ];
     traceInfo.finalize();
-    std::cout << "Command Buffer Trace:\n" << traceInfo.trace.str() << std::endl;
+
+    // Now dump the command buffer trace.
+
+    const auto& str = traceInfo.trace.str();
+    const char* ptr = str.c_str();
+    size_t size = str.size();
+
+    auto hash = computeHash( ptr, size );
+
+    std::string fileName;
+
+    // Get the dump directory name.
+    OS().GetDumpDirectoryName( sc_DumpDirectoryName, fileName );
+
+    // Make the file name.  It will have the form:
+    //   CLI_<program number>_<hash>_cmdbuf.dot
+    {
+        char    numberString[256] = "";
+
+        if( config().OmitProgramNumber )    // TODO: add a different control?
+        {
+            CLI_SPRINTF( numberString, 256, "%08X",
+                (unsigned int)hash );
+        }
+        else
+        {
+            CLI_SPRINTF( numberString, 256, "%04u_%08X",
+                m_CommandBufferNumber,
+                (unsigned int)hash );
+        }
+
+        fileName += "/CLI_";
+        fileName += numberString;
+        fileName += "_cmdbuf.dot";
+    }
+
+    // Now make directories as appropriate.
+    OS().MakeDumpDirectories( fileName );
+
+    log( "Dumping command buffer to file: " + fileName + "\n" );
+    dumpMemoryToFile(
+        fileName,
+        false,
+        ptr,
+        size );
+
+    m_CommandBufferNumber++;
+
+    // Now that we are done tracing, we can remove the trace info.
+    m_CommandBufferTraceInfoMap.erase( cmdbuf );
 }
 
 ///////////////////////////////////////////////////////////////////////////////

intercept/src/intercept.h

@@ -1364,6 +1364,8 @@ class CLIntercept
     typedef std::map< cl_semaphore_khr, cl_platform_id >    CSemaphoreInfoMap;
     CSemaphoreInfoMap   m_SemaphoreInfoMap;
 
+    unsigned int    m_CommandBufferNumber;
+
     typedef std::map< cl_command_buffer_khr, cl_platform_id >   CCommandBufferInfoMap;
     CCommandBufferInfoMap   m_CommandBufferInfoMap;