(no commit message)
[libreriscv.git] / openpower / sv_analysis.py
index 4706479431bc8debb1b683b22b4e0c16e5b00f56..487602312b0680fd6820017bb1a15d2f147345e1 100644 (file)
@@ -35,8 +35,8 @@ def get_csv(name):
 # Write an array of dictionaries to the CSV file name:
 def write_csv(name, items, headers):
     file_path = find_wiki_file(name)
-    with open(file_path, 'w') as csvfile:
-        writer = csv.DictWriter(csvfile, fieldnames)
+    with open(file_path, 'wb') as csvfile:
+        writer = csv.DictWriter(csvfile, headers, lineterminator="\n")
         writer.writeheader()
         writer.writerows(items)
 
@@ -55,7 +55,8 @@ def blank_key(row):
 # Floating point registers names like: FRT, FRA, FR1, ..., FRTp, ...
 # Return True if field is a register
 def isreg(field):
-    return field.startswith('R') or field.startswith('FR')
+    return (field.startswith('R') or field.startswith('FR') or
+            field == 'SPR')
 
 
 # These are the attributes of the instructions,
@@ -182,13 +183,18 @@ def process_csvs():
 
     # Ignore those containing: valid test sprs
     for fname in glob(pth):
+        if '-' in fname:
+            continue
         if 'valid' in fname:
             continue
         if 'test' in fname:
             continue
-        if 'sprs' in fname:
+        if fname.endswith('sprs.csv'):
+            continue
+        if fname.endswith('minor_19_valid.csv'):
+            continue
+        if 'RM' in fname:
             continue
-
         #print (fname)
         csvname = os.path.split(fname)[1]
         # csvname is something like: minor_59.csv, fname the whole path
@@ -197,7 +203,13 @@ def process_csvs():
         for row in csv:
             if blank_key(row):
                 continue
-            insns[row['comment']] = row # accumulate csv data by instruction
+            insn_name = row['comment']
+            # skip instructions that are not suitable
+            if insn_name in ['mcrxr', 'mcrxrx', 'darn']:
+                continue
+            if insn_name.startswith('bc') or 'rfid' in insn_name:
+                continue
+            insns[insn_name] = row # accumulate csv data by instruction
             dkey = create_key(row)
             key = tuple(dkey.values())
             # print("key=", key)
@@ -205,7 +217,7 @@ def process_csvs():
             primarykeys.add(key)
             if key not in bykey:
                 bykey[key] = []
-            bykey[key].append((csvname, row['opcode'], row['comment'],
+            bykey[key].append((csvname, row['opcode'], insn_name,
                                row['form'].upper() + '-Form'))
 
             # detect immediates, collate them (useful info)
@@ -242,15 +254,15 @@ def process_csvs():
               'CRi': 'non-SV',
               'imm': 'non-SV',
               '': 'non-SV',
-              'LDST-2R-imm': 'RM-2P-2S',
-              'LDST-2R-1W-imm': 'RM-2P-2S1D',
-              'LDST-2R-1W': 'RM-2P-2S1D',
-              'LDST-2R-2W': 'RM-2P-2S1D',
-              'LDST-1R-1W-imm': 'RM-2P-1S1D',
-              'LDST-1R-2W-imm': 'RM-2P-1S2D',
-              'LDST-3R': 'RM-2P-3S',
-              'LDST-3R-CRo': 'RM-2P-3S',  # st*x
-              'LDST-3R-1W': 'RM-2P-2S1D',  # st*x
+              'LDST-2R-imm': 'LDSTRM-2P-2S',
+              'LDST-2R-1W-imm': 'LDSTRM-2P-2S1D',
+              'LDST-2R-1W': 'LDSTRM-2P-2S1D',
+              'LDST-2R-2W': 'LDSTRM-2P-2S1D',
+              'LDST-1R-1W-imm': 'LDSTRM-2P-1S1D',
+              'LDST-1R-2W-imm': 'LDSTRM-2P-1S2D',
+              'LDST-3R': 'LDSTRM-2P-3S',
+              'LDST-3R-CRo': 'LDSTRM-2P-3S',  # st*x
+              'LDST-3R-1W': 'LDSTRM-2P-2S1D',  # st*x
               }
     print ("# map to old SV Prefix")
     print ('')
@@ -301,20 +313,32 @@ def process_csvs():
     #    print (insn, row)
 
     print ("# svp64 remaps")
+    svp64 = OrderedDict()
     # create a CSV file, per category, with SV "augmentation" info
-    csvcols = ['insn', 'Ptype', 'in1', 'in2', 'in3', 'out', 'CR in', 'CR out']
+    csvcols = ['insn', 'Ptype', 'Etype', '0', '1', '2', '3']
+    csvcols += ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out'] # temporary
     for key in primarykeys:
-        name = keyname(dictkeys[key])
+        # get the decoded key containing row-analysis, and name/value
+        dkey = dictkeys[key]
+        name = keyname(dkey)
         value = mapsto.get(name, "-")
         if value == 'non-SV':
             continue
-        print ("## %s (%s)" % (name, value))
-        print ('')
-        print ('[[!table  data="""')
-        print (tformat(csvcols))
+
+        # print out svp64 tables by category
+        print ("* **%s**: %s" % (name, value))
+
+        # store csv entries by svp64 RM category
+        if value not in svp64:
+            svp64[value] = []
+
         rows = bykey[key]
         rows.sort()
+
         for row in rows:
+            #for idx in range(len(row)):
+            #    if row[idx] == 'NONE':
+            #        row[idx] = ''
             # get the instruction
             insn_name = row[2]
             insn = insns[insn_name]
@@ -322,15 +346,219 @@ def process_csvs():
             res = OrderedDict()
             res['insn'] = insn_name
             res['Ptype'] = value.split('-')[1] # predication type (RM-xN-xxx)
+            # get whether R_xxx_EXTRAn fields are 2-bit or 3-bit
+            res['Etype'] = 'EXTRA2'
             # go through each register matching to Rxxxx_EXTRAx
+            for k in ['0', '1', '2', '3']:
+                res[k] = ''
+
+            # temporary useful info
+            regs = []
             for k in ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out']:
                 if insn[k].startswith('CONST'):
                     res[k] = ''
+                    regs.append('')
                 else:
                     res[k] = insn[k]
-            print (tformat(res.values()))
-        print ('"""]]')
+                    if insn[k] == 'RA_OR_ZERO':
+                        regs.append('RA')
+                    elif insn[k] != 'NONE':
+                        regs.append(insn[k])
+                    else:
+                        regs.append('')
+
+            # sigh now the fun begins.  this isn't the sanest way to do it
+            # but the patterns are pretty regular.
+            if value == 'LDSTRM-2P-1S1D':
+                res['Etype'] = 'EXTRA3' # RM EXTRA3 type
+                res['0'] = 'd:RT' # RT: Rdest_EXTRA3
+                res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
+
+            elif value == 'LDSTRM-2P-1S2D':
+                res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                res['0'] = 'd:RT' # RT: Rdest1_EXTRA2
+                res['1'] = 'd:RA' # RA: Rdest2_EXTRA2
+                res['2'] = 's:RA' # RA: Rsrc1_EXTRA2
+
+            elif value == 'LDSTRM-2P-2S':
+                res['Etype'] = 'EXTRA3' # RM EXTRA2 type
+                res['0'] = 'd:RS' # RT: Rdest1_EXTRA2
+                res['1'] = 's:RA' # RA: Rsrc1_EXTRA2
+
+            elif value == 'LDSTRM-2P-2S1D':
+                if 'st' in insn_name and 'x' not in insn_name: # stwu/stbu etc
+                    res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                    res['0'] = 'd:RA' # RA: Rdest1_EXTRA2
+                    res['1'] = 's:RS' # RS: Rdsrc1_EXTRA2
+                    res['2'] = 's:RA' # RA: Rsrc2_EXTRA2
+                elif 'st' in insn_name and 'x' in insn_name: # stwux
+                    res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                    res['0'] = 'd:RA' # RA: Rdest1_EXTRA2
+                    res['1'] = 's:RS,s:RA' # RS: Rdest2_EXTRA2, RA: Rsrc1_EXTRA2
+                    res['2'] = 's:RB' # RB: Rsrc2_EXTRA2
+                elif 'u' in insn_name: # ldux etc.
+                    res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                    res['0'] = 'd:RT' # RT: Rdest1_EXTRA2
+                    res['1'] = 'd:RA' # RA: Rdest2_EXTRA2
+                    res['2'] = 's:RB' # RB: Rsrc1_EXTRA2
+                else:
+                    res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                    res['0'] = 'd:RT' # RT: Rdest1_EXTRA2
+                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA2
+                    res['2'] = 's:RB' # RB: Rsrc2_EXTRA2
+
+            elif value == 'LDSTRM-2P-3S':
+                res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                if 'cx' in insn_name:
+                    res['0'] = 's:RS,d:CR0' # RS: Rsrc1_EXTRA2 CR0: dest
+                else:
+                    res['0'] = 's:RS' # RS: Rsrc1_EXTRA2
+                res['1'] = 's:RA' # RA: Rsrc2_EXTRA2
+                res['2'] = 's:RB' # RA: Rsrc3_EXTRA2
+
+            elif value == 'RM-2P-1S1D':
+                res['Etype'] = 'EXTRA3' # RM EXTRA3 type
+                if insn_name == 'mtspr':
+                    res['0'] = 'd:SPR' # SPR: Rdest1_EXTRA3
+                    res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
+                elif insn_name == 'mfspr':
+                    res['0'] = 'd:RS' # RS: Rdest1_EXTRA3
+                    res['1'] = 's:SPR' # SPR: Rsrc1_EXTRA3
+                elif name == 'CRio' and insn_name == 'mcrf':
+                    res['0'] = 'd:BF' # BFA: Rdest1_EXTRA3
+                    res['1'] = 's:BFA' # BFA: Rsrc1_EXTRA3
+                elif 'mfcr' in insn_name or 'mfocrf' in insn_name:
+                    res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
+                    res['1'] = 's:CR' # CR: Rsrc1_EXTRA3
+                elif insn_name == 'setb':
+                    res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
+                    res['1'] = 's:BFA' # BFA: Rsrc1_EXTRA3
+                elif insn_name.startswith('cmp'): # cmpi
+                    res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
+                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
+                elif regs == ['RA','','','RT','','']:
+                    res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
+                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
+                elif regs == ['RA','','','RT','','CR0']:
+                    res['0'] = 'd:RT,d:CR0' # RT,CR0: Rdest1_EXTRA3
+                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
+                elif (regs == ['RS','','','RA','','CR0'] or
+                      regs == ['','','RS','RA','','CR0']):
+                    res['0'] = 'd:RA,d:CR0' # RA,CR0: Rdest1_EXTRA3
+                    res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
+                elif regs == ['RS','','','RA','','']:
+                    res['0'] = 'd:RA' # RA: Rdest1_EXTRA3
+                    res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
+                elif regs == ['','FRB','','FRT','0','CR1']:
+                    res['0'] = 'd:FRT,d:CR1' # FRT,CR1: Rdest1_EXTRA3
+                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
+                elif regs == ['','FRB','','','','CR1']:
+                    res['0'] = 'd:CR1' # CR1: Rdest1_EXTRA3
+                    res['1'] = 's:FRB' # FRA: Rsrc1_EXTRA3
+                elif regs == ['','FRB','','','','BF']:
+                    res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
+                    res['1'] = 's:FRB' # FRA: Rsrc1_EXTRA3
+                elif regs == ['','FRB','','FRT','','CR1']:
+                    res['0'] = 'd:FRT,d:CR1' # FRT,CR1: Rdest1_EXTRA3
+                    res['1'] = 's:FRB' # FRB: Rsrc1_EXTRA3
+                else:
+                    res['0'] = 'TODO'
+
+            elif value == 'RM-1P-2S1D':
+                res['Etype'] = 'EXTRA3' # RM EXTRA3 type
+                if insn_name.startswith('cr'):
+                    res['0'] = 'd:BT' # BT: Rdest1_EXTRA3
+                    res['1'] = 's:BA' # BA: Rsrc1_EXTRA3
+                    res['2'] = 's:BB' # BB: Rsrc2_EXTRA3
+                elif regs == ['FRA','','FRC','FRT','','CR1']:
+                    res['0'] = 'd:FRT,d:CR1' # FRT,CR1: Rdest1_EXTRA3
+                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
+                    res['2'] = 's:FRC' # FRC: Rsrc1_EXTRA3
+                # should be for fcmp
+                elif regs == ['FRA','FRB','','','','BF']:
+                    res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
+                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
+                    res['2'] = 's:FRB' # FRB: Rsrc1_EXTRA3
+                elif regs == ['FRA','FRB','','FRT','','']:
+                    res['0'] = 'd:FRT' # FRT: Rdest1_EXTRA3
+                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
+                    res['2'] = 's:FRB' # FRB: Rsrc1_EXTRA3
+                elif regs == ['FRA','FRB','','FRT','','CR1']:
+                    res['0'] = 'd:FRT,d:CR1' # FRT,CR1: Rdest1_EXTRA3
+                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
+                    res['2'] = 's:FRB' # FRB: Rsrc1_EXTRA3
+                elif name == '2R-1W' or insn_name == 'cmpb': # cmpb
+                    if insn_name in ['bpermd', 'cmpb']:
+                        res['0'] = 'd:RA' # RA: Rdest1_EXTRA3
+                        res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
+                    else:
+                        res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
+                        res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
+                    res['2'] = 's:RB' # RB: Rsrc1_EXTRA3
+                elif insn_name.startswith('cmp'): # cmp
+                    res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
+                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
+                    res['2'] = 's:RB' # RB: Rsrc1_EXTRA3
+                elif (regs == ['','RB','RS','RA','','CR0'] or
+                      regs == ['RS','RB','','RA','','CR0']):
+                    res['0'] = 'd:RA,d:CR0' # RA,CR0: Rdest1_EXTRA3
+                    res['1'] = 's:RB' # RB: Rsrc1_EXTRA3
+                    res['2'] = 's:RS' # RS: Rsrc1_EXTRA3
+                elif regs == ['RA','RB','','RT','','CR0']:
+                    res['0'] = 'd:RT,d:CR0' # RT,CR0: Rdest1_EXTRA3
+                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
+                    res['2'] = 's:RB' # RB: Rsrc1_EXTRA3
+                elif regs == ['RA','','RS','RA','','CR0']:
+                    res['0'] = 'd:RA,d:CR0' # RA,CR0: Rdest1_EXTRA3
+                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
+                    res['2'] = 's:RS' # RS: Rsrc1_EXTRA3
+                else:
+                    res['0'] = 'TODO'
+
+            elif value == 'RM-2P-2S1D':
+                res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                if insn_name.startswith('mt'): # mtcrf
+                    res['0'] = 'd:CR' # CR: Rdest1_EXTRA2
+                    res['1'] = 's:RS' # RS: Rsrc1_EXTRA2
+                    res['2'] = 's:CR' # CR: Rsrc2_EXTRA2
+                else:
+                    res['0'] = 'TODO'
+
+            elif value == 'RM-1P-3S1D':
+                res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                if insn_name == 'isel':
+                    res['0'] = 'd:RT' # RT: Rdest1_EXTRA2
+                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA2
+                    res['2'] = 's:RB' # RT: Rsrc2_EXTRA2
+                    res['3'] = 's:BC' # BC: Rsrc3_EXTRA2
+                else:
+                    res['0'] = 'd:FRT,d:CR1' # FRT, CR1: Rdest1_EXTRA2
+                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA2
+                    res['2'] = 's:FRB' # FRB: Rsrc2_EXTRA2
+                    res['3'] = 's:FRC' # FRC: Rsrc3_EXTRA2
+
+            # add to svp64 csvs
+            #for k in ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out']:
+            #    del res[k]
+            #if res['0'] != 'TODO':
+            for k in res:
+                if res[k] == 'NONE' or res[k] == '':
+                    res[k] = '0'
+            svp64[value].append(res)
+
+    print ('')
+
+    # now write out the csv files
+    for value, csv in svp64.items():
+        # print out svp64 tables by category
+        print ("## %s" % value)
+        print ('')
+        print ('[[!table format=csv file="openpower/isatables/%s.csv"]]' % \
+                    value)
         print ('')
 
+        #csvcols = ['insn', 'Ptype', 'Etype', '0', '1', '2', '3']
+        write_csv("%s.csv" % value, csv, csvcols)
+
 if __name__ == '__main__':
     process_csvs()