1. fixes defect where 32word and 64word in align directives failed parse

2. protects vISA generated variables from conflicting with vISA keywords.
   - vISA reserved words are suffixed with _ (iteratively).
   - we include tests against all ops and subops

Change-Id: I8378a92e2db0e04a563f6db8746c1d85abf179e8

Author: trbauer

visa/CISA.l

@@ -732,7 +732,7 @@ v_type[ ]*=[ ]*T {
         return T_CLASS;
     }
 
-type[ ]*=[ ]*(ud|d|uw|w|ub|b|df|f|bool|uq|q|UD|D|UW|W|UB|B|DF|F|Bool|BOOL|UQ|Q|hf|HF)  {
+type[ ]*=[ ]*(ud|d|uw|w|ub|b|df|f|bool|uq|q|UD|D|UW|W|UB|B|DF|F|Bool|BOOL|UQ|Q|hf|HF) {
         TRACE("\n** TYPE ");
         CISAlval.type = str2type(yytext, yyleng);
         return DECL_DATA_TYPE;
@@ -743,7 +743,20 @@ type[ ]*=[ ]*(ud|d|uw|w|ub|b|df|f|bool|uq|q|UD|D|UW|W|UB|B|DF|F|Bool|BOOL|UQ|Q|h
         TRACE("\n** AlignType - 2GRF ");
         CISAlval.align = ALIGN_2_GRF;
         // fprintf(stderr, "%s", "2GRF symbol is deprecated; please use GRFx2");
-        return ALIGNTYPE_2GRF;
+        return ALIGNTYPE_NONVAR_KEYWORD;
+}
+
+32word {
+        /* other cases are handled as VAR */
+        TRACE("\n** AlignType - 32word ");
+        CISAlval.align = ALIGN_32WORD;
+        return ALIGNTYPE_NONVAR_KEYWORD;
+}
+64word {
+        /* other cases are handled as VAR */
+        TRACE("\n** AlignType - 64word ");
+        CISAlval.align = ALIGN_64WORD;
+        return ALIGNTYPE_NONVAR_KEYWORD;
 }
 
 "(-)"    {TRACE("\n** SRCMOD_NEG "); return SRCMOD_NEG;}

visa/CISA.y

@@ -356,7 +356,7 @@ VISA_RawOpnd* rawOperandArray[16];
 %token <string> RTWRITE_OPTION
 
 %token <string>            STRING_LITERAL
-%token <CISA_align>        ALIGNTYPE_2GRF
+%token <CISA_align>        ALIGNTYPE_NONVAR_KEYWORD
 %token <media_mode>        MEDIA_MODE
 %token <oword_mod>         OWORD_MODIFIER
 %token <s_channel>         SAMPLER_CHANNEL
@@ -730,8 +730,8 @@ AlignType : /* empty */
                {
                    $$ = ALIGN_BYTE;
                }
-              | ALIGN ALIGNTYPE_2GRF {
-                   $$ = ALIGN_BYTE;
+              | ALIGN ALIGNTYPE_NONVAR_KEYWORD {
+                   $$ = $2;
               }
               | ALIGN VAR /* e.g. byte, word, dword, qword, GRF, GRFx2 */
                {
@@ -2063,7 +2063,7 @@ static bool ParseAlign(CISA_IR_Builder* pCisaBuilder, const char *sym, VISA_Alig
         value = ALIGN_OWORD;
     } else if (strcmp(sym, "GRF") == 0) {
         value = ALIGN_GRF;
-    } else if (strcmp(sym, "GRFx2") == 0) {
+    } else if (strcmp(sym, "GRFx2") == 0 || strcmp(sym, "2GRF") == 0) {
         value = ALIGN_2_GRF;
     } else if (strcmp(sym, "hword") == 0) {
         value = ALIGN_HWORD;

visa/IsaDescription.cpp

@@ -1998,8 +1998,7 @@ static const ISA_SubInst_Desc SVMSubOpcodeDesc[] =
 };
 
 
-static const ISA_SubInst_Desc *getSubInstTable(
-    uint8_t opcode, int &size)
+const ISA_SubInst_Desc *getSubInstTable(uint8_t opcode, int &size)
 {
     const ISA_SubInst_Desc *table = nullptr;
     switch (opcode)
@@ -2017,7 +2016,9 @@ static const ISA_SubInst_Desc *getSubInstTable(
         size = sizeof(SVMSubOpcodeDesc)/sizeof(SVMSubOpcodeDesc[0]);
         break;
     default:
-        MUST_BE_TRUE(false, "instruction does not have sub opcode");
+        table = nullptr;
+        size = 0;
+        break;
     }
     return table;
 }

visa/IsaDescription.h

@@ -236,6 +236,11 @@ struct VISA_INST_Desc
     const ISA_SubInst_Desc& getSubInstDescByName(const char *symbol) const;
 };
 
+// looks up a parent opcode and resolves the sub ops of that parent
+// returns nullptr and sets 'size' to 0 if an op doesn't have a subop.
+// e.g. ... = getSubInstTable(ISA_SVM, svmSubOps);
+const ISA_SubInst_Desc *getSubInstTable(uint8_t opcode, int &size);
+
 enum SVMSubOpcode
 {
     SVM_BLOCK_LD = 0x1,

visa/VISAKernel.h

@@ -135,6 +135,7 @@ class VISAKernelImpl : public VISAFunction
         m_GenNamedVarMap.emplace_back();
 
         createKernelAttributes();
+        createReservedKeywordSet();
     }
 
     void* alloc(size_t sz) { return m_mem.alloc(sz); }
@@ -852,6 +853,8 @@ class VISAKernelImpl : public VISAFunction
     void computeAndEmitDebugInfo(VISAKernelImplListTy& functions);
 
 private:
+    void createReservedKeywordSet();
+    bool isReservedName(const std::string &nm) const;
     void ensureVariableNameUnique(const char *&varName);
     void generateVariableName(Common_ISA_Var_Class Ty, const char *&varName);
 
@@ -1009,6 +1012,7 @@ class VISAKernelImpl : public VISAFunction
     // TODO: this should be merged and re-worked to fit into the symbol table
     // scheme
     std::unordered_set<std::string> varNames;
+    std::unordered_set<std::string> reservedNames;
 
     int m_vISAInstCount;
     print_decl_index_t m_printDeclIndex;

visa/VISAKernelImpl.cpp

@@ -763,12 +763,47 @@ void VISAKernelImpl::createBindlessSampler()
     }
 }
 
+void VISAKernelImpl::createReservedKeywordSet() {
+    for (int i = 0; i < ISA_NUM_OPCODE; i++) {
+        const VISA_INST_Desc &desc = CISA_INST_table[i];
+        if (desc.name != nullptr)
+            reservedNames.insert(desc.name);
+        int subOpsLen = 0;
+        const ISA_SubInst_Desc *subOps = getSubInstTable(desc.opcode, subOpsLen);
+        if (subOps != nullptr) {
+            // e.g. ops like ISA_SVM have a subtable of operations
+            for (int si = 0; si < subOpsLen; si++) {
+                // same tables have some padding and empty ops
+                if (subOps[si].name != nullptr)
+                    reservedNames.insert(subOps[si].name);
+            }
+        }
+    }
+
+}
+
+bool VISAKernelImpl::isReservedName(const std::string &nm) const {
+    auto opItr = reservedNames.find(nm);
+    return (opItr != reservedNames.end());
+}
+
 void VISAKernelImpl::ensureVariableNameUnique(const char *&varName)
 {
-    // escape the name to ensure it's a legal vISA identifier
+    // legalize the LLVM name to vISA standards; some examples follow:
+    // given  ==> we fix it to this
+    // 1.  "0"  ==> "_0"              (LLVM name)
+    // 2.  "add.i.i" ==> "add_i_i"    (LLVM compound name)
+    // 3.  "mul" ==> "mul_"           (vISA keyword)
+    // 4.  suppose both variable "x" and "x0" exist
+    //       "x" ==> "x_1"            (since "x0" already used)
+    //       "x0" ==> "x0_1"          (it's a dumb suffixing strategy)
     std::stringstream escdName;
+
+    // step 1
     if (isdigit(varName[0]))
         escdName << '_';
+
+    // step 2
     for (size_t i = 0, slen = strlen(varName); i < slen; i++) {
         char c = varName[i];
         if (!isalnum(c)) {
@@ -777,6 +812,11 @@ void VISAKernelImpl::ensureVariableNameUnique(const char *&varName)
         escdName << c;
     }
 
+    // case 3: "mul" ==> "mul_"
+    while (isReservedName(escdName.str()))
+        escdName << '_';
+
+    // case 4: if "x" already exists, then use "x_#" where # is 0,1,..
     std::string varNameS = escdName.str();
     if (varNames.find(varNameS) != varNames.end()) {
         // not unqiue, add a counter until it is unique
@@ -787,14 +827,12 @@ void VISAKernelImpl::ensureVariableNameUnique(const char *&varName)
             varNameS = ss.str();
         } while (varNames.find(varNameS) != varNames.end());
     }
-
     varNames.insert(varNameS);
 
     char *buf = (char*)m_mem.alloc(varNameS.size() + 1);
     memcpy_s(buf, varNameS.size(), varNameS.c_str(), varNameS.size());
     buf[varNameS.size()] = 0;
     varName = buf;
-    varNames.insert(varNameS);
 }
 
 void VISAKernelImpl::generateVariableName(Common_ISA_Var_Class Ty, const char *&varName)