Parse build options from .visaasm shader override

Parse and use build options when using shader override with .visaasm files.

Author: franciszek-majkusiak

IGC/Compiler/CISACodeGen/CISABuilder.cpp

@@ -6403,6 +6403,7 @@ namespace IGC
         bool vISAAsmParseError = false;
         // Parse the generated VISA text
         if (visaAsmOverride) {
+            vAsmTextBuilder->SetOption(vISA_ParseBuildOptions, true);
             for (const std::string &tmpVisaFile : visaOverrideFiles) {
                 llvm::SmallVector<char, 1024> visaAsmNameVector;
                 std::string visaAsmName = GetDumpFileName("");
@@ -6424,6 +6425,7 @@ namespace IGC
                     break;
                 }
             }
+            vAsmTextBuilder->SetOption(vISA_ParseBuildOptions, false);
         } else {
             int result = 0;
             if (m_hasInlineAsm) {

visa/BuildCISAIR.h

@@ -529,6 +529,8 @@ class CISA_IR_Builder : public VISABuilder {
 
   void CISA_post_file_parse();
 
+  void CISA_parse_build_options(const char* argStr);
+
   VISA_opnd *CISA_create_gen_src_operand(const char *var_name, short v_stride,
                                          short width, short h_stride,
                                          unsigned char row_offset,

visa/BuildCISAIRImpl.cpp

@@ -1559,6 +1559,7 @@ extern int CISAparse(CISA_IR_Builder *builder);
 extern YY_BUFFER_STATE CISA_scan_string(const char *yy_str);
 extern void CISA_delete_buffer(YY_BUFFER_STATE buf);
 static std::mutex mtx;
+extern void resetGlobalVariables();
 
 int CISA_IR_Builder::ParseVISAText(const std::string &visaText,
                                    const std::string &visaTextFile) {
@@ -1581,6 +1582,7 @@ int CISA_IR_Builder::ParseVISAText(const std::string &visaText,
     }
   }
 
+  resetGlobalVariables();
   YY_BUFFER_STATE visaBuf = CISA_scan_string(visaText.c_str());
   if (CISAparse(this) != 0) {
 #ifndef DLL_MODE
@@ -1622,6 +1624,7 @@ int CISA_IR_Builder::ParseVISAText(const std::string &visaFile) {
     return VISA_FAILURE;
   }
 
+  resetGlobalVariables();
   if (CISAparse(this) != 0) {
     vISA_ASSERT(false, "Parsing visa text failed");
     return VISA_FAILURE;
@@ -4012,6 +4015,30 @@ CISA_IR_Builder::get_input_class(Common_ISA_Var_Class var_class) {
 }
 void CISA_IR_Builder::CISA_post_file_parse() { return; }
 
+void CISA_IR_Builder::CISA_parse_build_options(const char* argStr) {
+  std::string args(argStr);
+  size_t first_quote = args.find_first_of('"');
+  size_t last_quote = args.find_last_of('"');
+
+  if (first_quote != std::string::npos &&
+      last_quote != std::string::npos &&
+      first_quote < last_quote) {
+    args = args.substr(first_quote + 1, last_quote - first_quote - 1);
+    std::vector<std::string> argvStrings;
+    std::vector<const char*> argv;
+    std::string token;
+    std::istringstream ss(args);
+    while (ss >> token) {
+      argvStrings.push_back(token);
+    }
+    argv.reserve(argvStrings.size());
+    for (const std::string& s : argvStrings) {
+        argv.push_back(s.c_str());
+    }
+    getOptions()->parseOptions(argv.size(), argv.data());
+  }
+}
+
 // place it here so that internal Gen_IR files don't have to include
 // VISAKernel.h
 std::stringstream &IR_Builder::criticalMsgStream() {

visa/CISA.l

@@ -53,6 +53,11 @@ static unsigned char           FENCEOptions(const char* str);
 static COMMON_ISA_VME_OP_MODE  VMEType(const char *str);
 static CHANNEL_OUTPUT_FORMAT   Get_Channel_Output(const char* str);
 static void                    appendStringLiteralChar(char c, char *buf, size_t *len);
+
+static bool buildOptionPresent = false;
+void resetGlobalVariables() {
+    buildOptionPresent = false;
+}
 %}
 
 %option yylineno
@@ -66,6 +71,17 @@ static void                    appendStringLiteralChar(char c, char *buf, size_t
       return NEWLINE;
    }
 
+"//Build option:"[ \t]*\"([^\"\n]*)\"[ \t]* {
+    if(pBuilder->getOptions()->getOption(vISA_ParseBuildOptions)) {
+        if(buildOptionPresent)
+            YY_FATAL_ERROR("more then one instance of build options");
+        buildOptionPresent = true;
+        TRACE("** BUILD_OPTION\n");
+        CISAlval.string = strdup(yytext);
+        return BUILD_OPTION_LINE;
+    }
+}
+
 [ \t] { /*drop non-newline spaces*/}
 "//"[^\n]* {
         // drop comments

visa/CISA.y

@@ -397,6 +397,8 @@ std::vector<attr_gen_struct*> AttrOptVar;
 
 %token NEWLINE
 
+%token <string> BUILD_OPTION_LINE
+
 
 %token                     UNIFORM
 %token <string>            RTWRITE_OPTION
@@ -689,6 +691,7 @@ Statement:
     | Instruction
     | Label
     | Scope
+    | BuildOptions
 
 
 // ------------- Scope -------------
@@ -3165,6 +3168,12 @@ DataTypeIntOrVector:
           ITYPE
         | VTYPE
 
+// --------- BuildOptions --------------------------------
+BuildOptions: BUILD_OPTION_LINE
+    {
+        pBuilder->CISA_parse_build_options($1);
+    }
+
 
 %%
 ///////////////////////////////////////////////////////////////////////////////

visa/Common_ISA_framework.cpp

@@ -190,8 +190,8 @@ int CISA_IR_Builder::isaDump(const char *combinedIsaasmName) const {
 #else
   const bool isaasmToConsole = m_options.getOption(vISA_ISAASMToConsole);
   const bool genIsaasm = m_options.getOption(vISA_GenerateISAASM);
-  const bool allowIsaasmDump = CisaFramework::allowDump(m_options,
-    combinedIsaasmName ? combinedIsaasmName : std::string());
+  const bool allowIsaasmDump = combinedIsaasmName && combinedIsaasmName[0] != '\0' &&
+      CisaFramework::allowDump(m_options, combinedIsaasmName);
   const bool genCombinedIsaasm =
     m_options.getOption(vISA_GenerateCombinedISAASM) &&
     (isaasmToConsole || allowIsaasmDump);

visa/include/VISAOptionsDefs.h

@@ -626,6 +626,8 @@ DEF_VISA_OPTION(
     "1 enables basic output, 2 enables with def/use dataflow information "
     "(may increase compile time significantly for large shaders)",
     0)
+DEF_VISA_OPTION(vISA_ParseBuildOptions, ET_BOOL, "-parseBuildOptions", UNUSED,
+                false)
 
 //=== misc options ===
 DEF_VISA_OPTION(vISA_PlatformSet, ET_INT32, NULLSTR, UNUSED, -1 /*GENX_NONE*/)