Limit Vec Element in ShaderDump

Author: mnaczk

IGC/common/MDFrameWork.cpp

@@ -33,6 +33,7 @@ IN THE SOFTWARE.
 #include "common/LLVMWarningsPop.hpp"
 
 #include "StringMacros.hpp"
+#include "common/igc_regkeys.hpp"
 
 #include <iostream>
 
@@ -187,6 +188,16 @@ MDNode* CreateNode(const std::vector<val> &vec, Module* module, StringRef name)
     for (auto it = vec.begin(); it != vec.end(); ++it)
     {
         nodes.push_back(CreateNode(*(it), module, name.str() + "Vec[" + std::to_string(i++) + "]"));
+        if (IGC_IS_FLAG_DISABLED(ShowFullVectorsInShaderDumps) && i > MAX_VECTOR_SIZE_TO_PRINT_IN_SHADER_DUMPS)
+        {
+            std::string warningMessage = "ShaderDumpEnable Warning! " + name.str() + "Vec[] has " + std::to_string(vec.size())
+                + " elements. Including first " + std::to_string(MAX_VECTOR_SIZE_TO_PRINT_IN_SHADER_DUMPS)
+                + " items in ShaderDumps. To print all elements set ShowFullVectorsInShaderDumps register flag to True. "
+                + "ShaderOverride flag may not work properly without ShowFullVectorsInShaderDumps enabled.";
+            printf("%s\n\n", warningMessage.c_str());
+            nodes.push_back(CreateNode(false, module, warningMessage + " ShowFullVectorsInShaderDumps currently equals"));
+            break;
+        }
     }
     MDNode* node = MDNode::get(module->getContext(), nodes);
     return node;

IGC/common/MDFrameWork.h

@@ -46,6 +46,7 @@ const unsigned int INPUT_RESOURCE_SLOT_COUNT = 128;
 const unsigned int NUM_SHADER_RESOURCE_VIEW_SIZE = (INPUT_RESOURCE_SLOT_COUNT + 1) / 64;
 
 const unsigned int g_c_maxNumberOfBufferPushed = 4;
+static const int MAX_VECTOR_SIZE_TO_PRINT_IN_SHADER_DUMPS = 1000;
 
 namespace IGC
 {

IGC/common/igc_flags.def

@@ -244,6 +244,7 @@ DECLARE_IGC_REGKEY(bool, QualityMetricsEnable,          false, "Enable Quality M
 DECLARE_IGC_REGKEY(bool, ShaderDumpEnable,              false, "dump LLVM IR, visaasm, and GenISA", true)
 DECLARE_IGC_REGKEY(bool, ElfDumpEnable,                 false, "dump ELF file", true)
 DECLARE_IGC_REGKEY(bool, ShaderDumpEnableAll,           false, "dump all LLVM IR passes, visaasm, and GenISA", true)
+DECLARE_IGC_REGKEY(bool, ShowFullVectorsInShaderDumps,  false, "print all elements of vectors in ShaderDumps, can dramatically increase ShaderDumps size", true)
 DECLARE_IGC_REGKEY(debugString, PrintAfter,             0,     "Take either all or comma/semicolon-separated list of pass names. If set, enable print LLVM IR after the given pass is done (mimic llvm print-after)", true)
 DECLARE_IGC_REGKEY(debugString, PrintBefore,            0,     "Take either all or comma/semicolon-separated list of pass names. If set, enable print LLVM IR before the given pass is done (mimic llvm print-before)", true)
 DECLARE_IGC_REGKEY(bool, InterleaveSourceShader,        true, "Interleave the source shader in asm dump", true)