openpower/sv_analysis.py

   1 #!/usr/bin/env python2
   2 #
   3 # NOTE that this program is python2 compatible, please do not stop it
   4 # from working by adding syntax that prevents that.
   5 #
   6 # Initial version written by lkcl Oct 2020
   7 # This program analyses the Power 9 op codes and looks at in/out register uses
   8 # The results are displayed:
   9 #       https://libre-soc.org/openpower/opcode_regs_deduped/
  10 #
  11 # It finds .csv files in the directory isatables/
  12 # then goes through the categories and creates svp64 CSV augmentation
  13 # tables on a per-opcode basis
  14
  15 import csv
  16 import os
  17 from os.path import dirname, join
  18 from glob import glob
  19 from collections import OrderedDict
  20 from soc.decoder.power_svp64 import SVP64RM
  21
  22
  23 # Return absolute path (ie $PWD) + isatables + name
  24 def find_wiki_file(name):
  25     filedir = os.path.dirname(os.path.abspath(__file__))
  26     tabledir = join(filedir, 'isatables')
  27     file_path = join(tabledir, name)
  28     return file_path
  29
  30 # Return an array of dictionaries from the CSV file name:
  31 def get_csv(name):
  32     file_path = find_wiki_file(name)
  33     with open(file_path, 'r') as csvfile:
  34         reader = csv.DictReader(csvfile)
  35         return list(reader)
  36
  37 # Write an array of dictionaries to the CSV file name:
  38 def write_csv(name, items, headers):
  39     file_path = find_wiki_file(name)
  40     with open(file_path, 'w') as csvfile:
  41         writer = csv.DictWriter(csvfile, headers, lineterminator="\n")
  42         writer.writeheader()
  43         writer.writerows(items)
  44
  45 # This will return True if all values are true.
  46 # Not sure what this is about
  47 def blank_key(row):
  48     #for v in row.values():
  49     #    if 'SPR' in v: # skip all SPRs
  50     #        return True
  51     for v in row.values():
  52         if v:
  53             return False
  54     return True
  55
  56 # General purpose registers have names like: RA, RT, R1, ...
  57 # Floating point registers names like: FRT, FRA, FR1, ..., FRTp, ...
  58 # Return True if field is a register
  59 def isreg(field):
  60     return (field.startswith('R') or field.startswith('FR') or
  61             field == 'SPR')
  62
  63
  64 # These are the attributes of the instructions,
  65 # register names
  66 keycolumns = ['unit', 'in1', 'in2', 'in3', 'out', 'CR in', 'CR out',
  67                  ] # don't think we need these: 'ldst len', 'rc', 'lk']
  68
  69 tablecols = ['unit', 'in', 'outcnt', 'CR in', 'CR out', 'imm'
  70                  ] # don't think we need these: 'ldst len', 'rc', 'lk']
  71
  72 def create_key(row):
  73     res = OrderedDict()
  74     #print ("row", row)
  75     for key in keycolumns:
  76         # registers IN - special-case: count number of regs RA/RB/RC/RS
  77         if key in ['in1', 'in2', 'in3']:
  78             if 'in' not in res:
  79                 res['in'] = 0
  80             if isreg(row[key]):
  81                 res['in'] += 1
  82
  83         # registers OUT
  84         if key == 'out':
  85             # If upd is 1 then increment the count of outputs
  86             if 'outcnt' not in res:
  87                 res['outcnt'] = 0
  88             if isreg(row[key]):
  89                 res['outcnt'] += 1
  90             if row['upd'] == '1':
  91                 res['outcnt'] += 1
  92
  93         # CRs (Condition Register) (CR0 .. CR7)
  94         if key.startswith('CR'):
  95             if row[key].startswith('NONE'):
  96                 res[key] = '0'
  97             else:
  98                 res[key] = '1'
  99             if row['comment'].startswith('cr'):
 100                 res['crop'] = '1'
 101         # unit
 102         if key == 'unit':
 103             if row[key] == 'LDST': # we care about LDST units
 104                 res[key] = row[key]
 105             else:
 106                 res[key] = 'OTHER'
 107         # LDST len (LoadStore length)
 108         if key.startswith('ldst'):
 109             if row[key].startswith('NONE'):
 110                 res[key] = '0'
 111             else:
 112                 res[key] = '1'
 113         # rc, lk
 114         if key in ['rc', 'lk']:
 115             if row[key] == 'ONE':
 116                 res[key] = '1'
 117             elif row[key] == 'NONE':
 118                 res[key] = '0'
 119             else:
 120                 res[key] = 'R'
 121         if key == 'lk':
 122             res[key] = row[key]
 123
 124     # Convert the numerics 'in' & 'outcnt' to strings
 125     res['in'] = str(res['in'])
 126     res['outcnt'] = str(res['outcnt'])
 127
 128
 129     # constants
 130     if row['in2'].startswith('CONST_'):
 131         res['imm'] = "1" # row['in2'].split("_")[1]
 132     else:
 133         res['imm'] = ''
 134
 135     return res
 136
 137 #
 138 def dformat(d):
 139     res = []
 140     for k, v in d.items():
 141         res.append("%s: %s" % (k, v))
 142     return ' '.join(res)
 143
 144 def tformat(d):
 145     return ' | '.join(d) + " |"
 146
 147 def keyname(row):
 148     res = []
 149     if row['unit'] != 'OTHER':
 150         res.append(row['unit'])
 151     if row['in'] != '0':
 152         res.append('%sR' % row['in'])
 153     if row['outcnt'] != '0':
 154         res.append('%sW' % row['outcnt'])
 155     if row['CR in'] == '1' and row['CR out'] == '1':
 156         if 'crop' in row:
 157             res.append("CR=2R1W")
 158         else:
 159             res.append("CRio")
 160     elif row['CR in'] == '1':
 161         res.append("CRi")
 162     elif row['CR out'] == '1':
 163         res.append("CRo")
 164     elif 'imm' in row and row['imm']:
 165         res.append("imm")
 166     return '-'.join(res)
 167
 168
 169 def process_csvs():
 170     csvs = {}
 171     csvs_svp64 = {}
 172     bykey = {}
 173     primarykeys = set()
 174     dictkeys = OrderedDict()
 175     immediates = {}
 176     insns = {} # dictionary of CSV row, by instruction
 177     insn_to_csv = {}
 178
 179     print ("# OpenPOWER ISA register 'profile's")
 180     print ('')
 181     print ("this page is auto-generated, do not edit")
 182     print ("created by http://libre-soc.org/openpower/sv_analysis.py")
 183     print ('')
 184
 185     # Expand that (all .csv files)
 186     pth = find_wiki_file("*.csv")
 187
 188     # Ignore those containing: valid test sprs
 189     for fname in glob(pth):
 190         if '-' in fname:
 191             continue
 192         if 'valid' in fname:
 193             continue
 194         if 'test' in fname:
 195             continue
 196         if fname.endswith('sprs.csv'):
 197             continue
 198         if fname.endswith('minor_19_valid.csv'):
 199             continue
 200         if 'RM' in fname:
 201             continue
 202         #print (fname)
 203         csvname = os.path.split(fname)[1]
 204         csvname_ = csvname.split(".")[0]
 205         # csvname is something like: minor_59.csv, fname the whole path
 206         csv = get_csv(fname)
 207         csvs[fname] = csv
 208         csvs_svp64[csvname_] = []
 209         for row in csv:
 210             if blank_key(row):
 211                 continue
 212             insn_name = row['comment']
 213             # skip instructions that are not suitable
 214             if insn_name in ['mcrxr', 'mcrxrx', 'darn']:
 215                 continue
 216             if insn_name.startswith('bc') or 'rfid' in insn_name:
 217                 continue
 218             insns[insn_name] = row # accumulate csv data by instruction
 219             insn_to_csv[insn_name] = csvname_ # CSV file name by instruction
 220             dkey = create_key(row)
 221             key = tuple(dkey.values())
 222             # print("key=", key)
 223             dictkeys[key] = dkey
 224             primarykeys.add(key)
 225             if key not in bykey:
 226                 bykey[key] = []
 227             bykey[key].append((csvname, row['opcode'], insn_name,
 228                                row['form'].upper() + '-Form'))
 229
 230             # detect immediates, collate them (useful info)
 231             if row['in2'].startswith('CONST_'):
 232                 imm = row['in2'].split("_")[1]
 233                 if key not in immediates:
 234                     immediates[key] = set()
 235                 immediates[key].add(imm)
 236
 237     primarykeys = list(primarykeys)
 238     primarykeys.sort()
 239
 240     # mapping to old SVPrefix "Forms"
 241     mapsto = {'3R-1W-CRio': 'RM-1P-3S1D',
 242               '2R-1W-CRio': 'RM-1P-2S1D',
 243               '2R-1W-CRi': 'RM-1P-3S1D',
 244               '2R-1W-CRo': 'RM-1P-2S1D',
 245               '2R': 'non-SV',
 246               '2R-1W': 'RM-1P-2S1D',
 247               '1R-CRio': 'RM-2P-2S1D',
 248               '2R-CRio': 'RM-1P-2S1D',
 249               '2R-CRo': 'RM-1P-2S1D',
 250               '1R': 'non-SV',
 251               '1R-1W-CRio': 'RM-2P-1S1D',
 252               '1R-1W-CRo': 'RM-2P-1S1D',
 253               '1R-1W': 'RM-2P-1S1D',
 254               '1R-1W-imm': 'RM-2P-1S1D',
 255               '1R-CRo': 'RM-2P-1S1D',
 256               '1R-imm': 'non-SV',
 257               '1W': 'non-SV',
 258               '1W-CRi': 'RM-2P-1S1D',
 259               'CRio': 'RM-2P-1S1D',
 260               'CR=2R1W': 'RM-1P-2S1D',
 261               'CRi': 'non-SV',
 262               'imm': 'non-SV',
 263               '': 'non-SV',
 264               'LDST-2R-imm': 'LDSTRM-2P-2S',
 265               'LDST-2R-1W-imm': 'LDSTRM-2P-2S1D',
 266               'LDST-2R-1W': 'LDSTRM-2P-2S1D',
 267               'LDST-2R-2W': 'LDSTRM-2P-2S1D',
 268               'LDST-1R-1W-imm': 'LDSTRM-2P-1S1D',
 269               'LDST-1R-2W-imm': 'LDSTRM-2P-1S2D',
 270               'LDST-3R': 'LDSTRM-2P-3S',
 271               'LDST-3R-CRo': 'LDSTRM-2P-3S',  # st*x
 272               'LDST-3R-1W': 'LDSTRM-2P-2S1D',  # st*x
 273               }
 274     print ("# map to old SV Prefix")
 275     print ('')
 276     print ('[[!table  data="""')
 277     for key in primarykeys:
 278         name = keyname(dictkeys[key])
 279         value = mapsto.get(name, "-")
 280         print (tformat([name, value+ " "]))
 281     print ('"""]]')
 282     print ('')
 283
 284     print ("# keys")
 285     print ('')
 286     print ('[[!table  data="""')
 287     print (tformat(tablecols) + " imms | name |")
 288
 289     # print out the keys and the table from which they're derived
 290     for key in primarykeys:
 291         name = keyname(dictkeys[key])
 292         row = tformat(dictkeys[key].values())
 293         imms = list(immediates.get(key, ""))
 294         imms.sort()
 295         row += " %s | " % ("/".join(imms))
 296         row += " %s |" % name
 297         print (row)
 298     print ('"""]]')
 299     print ('')
 300
 301     # print out, by remap name, all the instructions under that category
 302     for key in primarykeys:
 303         name = keyname(dictkeys[key])
 304         value = mapsto.get(name, "-")
 305         print ("## %s (%s)" % (name, value))
 306         print ('')
 307         print ('[[!table  data="""')
 308         print (tformat(['CSV', 'opcode', 'asm', 'form']))
 309         rows = bykey[key]
 310         rows.sort()
 311         for row in rows:
 312             print (tformat(row))
 313         print ('"""]]')
 314         print ('')
 315
 316     #for fname, csv in csvs.items():
 317     #    print (fname)
 318
 319     #for insn, row in insns.items():
 320     #    print (insn, row)
 321
 322     print ("# svp64 remaps")
 323     svp64 = OrderedDict()
 324     # create a CSV file, per category, with SV "augmentation" info
 325     csvcols = ['insn', 'Ptype', 'Etype', '0', '1', '2', '3']
 326     csvcols += ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out'] # temporary
 327     for key in primarykeys:
 328         # get the decoded key containing row-analysis, and name/value
 329         dkey = dictkeys[key]
 330         name = keyname(dkey)
 331         value = mapsto.get(name, "-")
 332         if value == 'non-SV':
 333             continue
 334
 335         # print out svp64 tables by category
 336         print ("* **%s**: %s" % (name, value))
 337
 338         # store csv entries by svp64 RM category
 339         if value not in svp64:
 340             svp64[value] = []
 341
 342         rows = bykey[key]
 343         rows.sort()
 344
 345         for row in rows:
 346             #for idx in range(len(row)):
 347             #    if row[idx] == 'NONE':
 348             #        row[idx] = ''
 349             # get the instruction
 350             insn_name = row[2]
 351             insn = insns[insn_name]
 352             # start constructing svp64 CSV row
 353             res = OrderedDict()
 354             res['insn'] = insn_name
 355             res['Ptype'] = value.split('-')[1] # predication type (RM-xN-xxx)
 356             # get whether R_xxx_EXTRAn fields are 2-bit or 3-bit
 357             res['Etype'] = 'EXTRA2'
 358             # go through each register matching to Rxxxx_EXTRAx
 359             for k in ['0', '1', '2', '3']:
 360                 res[k] = ''
 361
 362             # temporary useful info
 363             regs = []
 364             for k in ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out']:
 365                 if insn[k].startswith('CONST'):
 366                     res[k] = ''
 367                     regs.append('')
 368                 else:
 369                     res[k] = insn[k]
 370                     if insn[k] == 'RA_OR_ZERO':
 371                         regs.append('RA')
 372                     elif insn[k] != 'NONE':
 373                         regs.append(insn[k])
 374                     else:
 375                         regs.append('')
 376
 377             # sigh now the fun begins.  this isn't the sanest way to do it
 378             # but the patterns are pretty regular.
 379             if value == 'LDSTRM-2P-1S1D':
 380                 res['Etype'] = 'EXTRA3' # RM EXTRA3 type
 381                 res['0'] = 'd:RT' # RT: Rdest_EXTRA3
 382                 res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
 383
 384             elif value == 'LDSTRM-2P-1S2D':
 385                 res['Etype'] = 'EXTRA2' # RM EXTRA2 type
 386                 res['0'] = 'd:RT' # RT: Rdest1_EXTRA2
 387                 res['1'] = 'd:RA' # RA: Rdest2_EXTRA2
 388                 res['2'] = 's:RA' # RA: Rsrc1_EXTRA2
 389
 390             elif value == 'LDSTRM-2P-2S':
 391                 res['Etype'] = 'EXTRA3' # RM EXTRA2 type
 392                 res['0'] = 'd:RS' # RT: Rdest1_EXTRA2
 393                 res['1'] = 's:RA' # RA: Rsrc1_EXTRA2
 394
 395             elif value == 'LDSTRM-2P-2S1D':
 396                 if 'st' in insn_name and 'x' not in insn_name: # stwu/stbu etc
 397                     res['Etype'] = 'EXTRA2' # RM EXTRA2 type
 398                     res['0'] = 'd:RA' # RA: Rdest1_EXTRA2
 399                     res['1'] = 's:RS' # RS: Rdsrc1_EXTRA2
 400                     res['2'] = 's:RA' # RA: Rsrc2_EXTRA2
 401                 elif 'st' in insn_name and 'x' in insn_name: # stwux
 402                     res['Etype'] = 'EXTRA2' # RM EXTRA2 type
 403                     res['0'] = 'd:RA' # RA: Rdest1_EXTRA2
 404                     res['1'] = 's:RS;s:RA' # RS: Rdest2_EXTRA2, RA: Rsrc1_EXTRA2
 405                     res['2'] = 's:RB' # RB: Rsrc2_EXTRA2
 406                 elif 'u' in insn_name: # ldux etc.
 407                     res['Etype'] = 'EXTRA2' # RM EXTRA2 type
 408                     res['0'] = 'd:RT' # RT: Rdest1_EXTRA2
 409                     res['1'] = 'd:RA' # RA: Rdest2_EXTRA2
 410                     res['2'] = 's:RB' # RB: Rsrc1_EXTRA2
 411                 else:
 412                     res['Etype'] = 'EXTRA2' # RM EXTRA2 type
 413                     res['0'] = 'd:RT' # RT: Rdest1_EXTRA2
 414                     res['1'] = 's:RA' # RA: Rsrc1_EXTRA2
 415                     res['2'] = 's:RB' # RB: Rsrc2_EXTRA2
 416
 417             elif value == 'LDSTRM-2P-3S':
 418                 res['Etype'] = 'EXTRA2' # RM EXTRA2 type
 419                 if 'cx' in insn_name:
 420                     res['0'] = 's:RS;d:CR0' # RS: Rsrc1_EXTRA2 CR0: dest
 421                 else:
 422                     res['0'] = 's:RS' # RS: Rsrc1_EXTRA2
 423                 res['1'] = 's:RA' # RA: Rsrc2_EXTRA2
 424                 res['2'] = 's:RB' # RA: Rsrc3_EXTRA2
 425
 426             elif value == 'RM-2P-1S1D':
 427                 res['Etype'] = 'EXTRA3' # RM EXTRA3 type
 428                 if insn_name == 'mtspr':
 429                     res['0'] = 'd:SPR' # SPR: Rdest1_EXTRA3
 430                     res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
 431                 elif insn_name == 'mfspr':
 432                     res['0'] = 'd:RS' # RS: Rdest1_EXTRA3
 433                     res['1'] = 's:SPR' # SPR: Rsrc1_EXTRA3
 434                 elif name == 'CRio' and insn_name == 'mcrf':
 435                     res['0'] = 'd:BF' # BFA: Rdest1_EXTRA3
 436                     res['1'] = 's:BFA' # BFA: Rsrc1_EXTRA3
 437                 elif 'mfcr' in insn_name or 'mfocrf' in insn_name:
 438                     res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
 439                     res['1'] = 's:CR' # CR: Rsrc1_EXTRA3
 440                 elif insn_name == 'setb':
 441                     res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
 442                     res['1'] = 's:BFA' # BFA: Rsrc1_EXTRA3
 443                 elif insn_name.startswith('cmp'): # cmpi
 444                     res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
 445                     res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
 446                 elif regs == ['RA','','','RT','','']:
 447                     res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
 448                     res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
 449                 elif regs == ['RA','','','RT','','CR0']:
 450                     res['0'] = 'd:RT;d:CR0' # RT,CR0: Rdest1_EXTRA3
 451                     res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
 452                 elif (regs == ['RS','','','RA','','CR0'] or
 453                       regs == ['','','RS','RA','','CR0']):
 454                     res['0'] = 'd:RA;d:CR0' # RA,CR0: Rdest1_EXTRA3
 455                     res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
 456                 elif regs == ['RS','','','RA','','']:
 457                     res['0'] = 'd:RA' # RA: Rdest1_EXTRA3
 458                     res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
 459                 elif regs == ['','FRB','','FRT','0','CR1']:
 460                     res['0'] = 'd:FRT;d:CR1' # FRT,CR1: Rdest1_EXTRA3
 461                     res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
 462                 elif regs == ['','FRB','','','','CR1']:
 463                     res['0'] = 'd:CR1' # CR1: Rdest1_EXTRA3
 464                     res['1'] = 's:FRB' # FRA: Rsrc1_EXTRA3
 465                 elif regs == ['','FRB','','','','BF']:
 466                     res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
 467                     res['1'] = 's:FRB' # FRA: Rsrc1_EXTRA3
 468                 elif regs == ['','FRB','','FRT','','CR1']:
 469                     res['0'] = 'd:FRT;d:CR1' # FRT,CR1: Rdest1_EXTRA3
 470                     res['1'] = 's:FRB' # FRB: Rsrc1_EXTRA3
 471                 else:
 472                     res['0'] = 'TODO'
 473
 474             elif value == 'RM-1P-2S1D':
 475                 res['Etype'] = 'EXTRA3' # RM EXTRA3 type
 476                 if insn_name.startswith('cr'):
 477                     res['0'] = 'd:BT' # BT: Rdest1_EXTRA3
 478                     res['1'] = 's:BA' # BA: Rsrc1_EXTRA3
 479                     res['2'] = 's:BB' # BB: Rsrc2_EXTRA3
 480                 elif regs == ['FRA','','FRC','FRT','','CR1']:
 481                     res['0'] = 'd:FRT;d:CR1' # FRT,CR1: Rdest1_EXTRA3
 482                     res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
 483                     res['2'] = 's:FRC' # FRC: Rsrc1_EXTRA3
 484                 # should be for fcmp
 485                 elif regs == ['FRA','FRB','','','','BF']:
 486                     res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
 487                     res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
 488                     res['2'] = 's:FRB' # FRB: Rsrc1_EXTRA3
 489                 elif regs == ['FRA','FRB','','FRT','','']:
 490                     res['0'] = 'd:FRT' # FRT: Rdest1_EXTRA3
 491                     res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
 492                     res['2'] = 's:FRB' # FRB: Rsrc1_EXTRA3
 493                 elif regs == ['FRA','FRB','','FRT','','CR1']:
 494                     res['0'] = 'd:FRT;d:CR1' # FRT,CR1: Rdest1_EXTRA3
 495                     res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
 496                     res['2'] = 's:FRB' # FRB: Rsrc1_EXTRA3
 497                 elif name == '2R-1W' or insn_name == 'cmpb': # cmpb
 498                     if insn_name in ['bpermd', 'cmpb']:
 499                         res['0'] = 'd:RA' # RA: Rdest1_EXTRA3
 500                         res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
 501                     else:
 502                         res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
 503                         res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
 504                     res['2'] = 's:RB' # RB: Rsrc1_EXTRA3
 505                 elif insn_name.startswith('cmp'): # cmp
 506                     res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
 507                     res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
 508                     res['2'] = 's:RB' # RB: Rsrc1_EXTRA3
 509                 elif (regs == ['','RB','RS','RA','','CR0'] or
 510                       regs == ['RS','RB','','RA','','CR0']):
 511                     res['0'] = 'd:RA;d:CR0' # RA,CR0: Rdest1_EXTRA3
 512                     res['1'] = 's:RB' # RB: Rsrc1_EXTRA3
 513                     res['2'] = 's:RS' # RS: Rsrc1_EXTRA3
 514                 elif regs == ['RA','RB','','RT','','CR0']:
 515                     res['0'] = 'd:RT;d:CR0' # RT,CR0: Rdest1_EXTRA3
 516                     res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
 517                     res['2'] = 's:RB' # RB: Rsrc1_EXTRA3
 518                 elif regs == ['RA','','RS','RA','','CR0']:
 519                     res['0'] = 'd:RA;d:CR0' # RA,CR0: Rdest1_EXTRA3
 520                     res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
 521                     res['2'] = 's:RS' # RS: Rsrc1_EXTRA3
 522                 else:
 523                     res['0'] = 'TODO'
 524
 525             elif value == 'RM-2P-2S1D':
 526                 res['Etype'] = 'EXTRA2' # RM EXTRA2 type
 527                 if insn_name.startswith('mt'): # mtcrf
 528                     res['0'] = 'd:CR' # CR: Rdest1_EXTRA2
 529                     res['1'] = 's:RS' # RS: Rsrc1_EXTRA2
 530                     res['2'] = 's:CR' # CR: Rsrc2_EXTRA2
 531                 else:
 532                     res['0'] = 'TODO'
 533
 534             elif value == 'RM-1P-3S1D':
 535                 res['Etype'] = 'EXTRA2' # RM EXTRA2 type
 536                 if insn_name == 'isel':
 537                     res['0'] = 'd:RT' # RT: Rdest1_EXTRA2
 538                     res['1'] = 's:RA' # RA: Rsrc1_EXTRA2
 539                     res['2'] = 's:RB' # RT: Rsrc2_EXTRA2
 540                     res['3'] = 's:BC' # BC: Rsrc3_EXTRA2
 541                 else:
 542                     res['0'] = 'd:FRT;d:CR1' # FRT, CR1: Rdest1_EXTRA2
 543                     res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA2
 544                     res['2'] = 's:FRB' # FRB: Rsrc2_EXTRA2
 545                     res['3'] = 's:FRC' # FRC: Rsrc3_EXTRA2
 546
 547             # add to svp64 csvs
 548             #for k in ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out']:
 549             #    del res[k]
 550             #if res['0'] != 'TODO':
 551             for k in res:
 552                 if res[k] == 'NONE' or res[k] == '':
 553                     res[k] = '0'
 554             svp64[value].append(res)
 555             # also add to by-CSV version
 556             csv_fname = insn_to_csv[insn_name]
 557             csvs_svp64[csv_fname].append(res)
 558
 559     print ('')
 560
 561     # now write out the csv files
 562     for value, csv in svp64.items():
 563         # print out svp64 tables by category
 564         print ("## %s" % value)
 565         print ('')
 566         print ('[[!table format=csv file="openpower/isatables/%s.csv"]]' % \
 567                     value)
 568         print ('')
 569
 570         #csvcols = ['insn', 'Ptype', 'Etype', '0', '1', '2', '3']
 571         write_csv("%s.csv" % value, csv, csvcols)
 572
 573     # get SVP64 augmented CSV files
 574     svt = SVP64RM()
 575     # Expand that (all .csv files)
 576     pth = find_wiki_file("*.csv")
 577
 578     # Ignore those containing: valid test sprs
 579     for fname in glob(pth):
 580         if '-' in fname:
 581             continue
 582         if 'valid' in fname:
 583             continue
 584         if 'test' in fname:
 585             continue
 586         if fname.endswith('sprs.csv'):
 587             continue
 588         if fname.endswith('minor_19_valid.csv'):
 589             continue
 590         if 'RM' in fname:
 591             continue
 592         svp64_csv = svt.get_svp64_csv(fname)
 593
 594     csvcols = ['insn', 'Ptype', 'Etype']
 595     csvcols += ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out']
 596
 597     # and a nice microwatt VHDL file
 598     file_path = find_wiki_file("sv_decode.vhdl")
 599     with open(file_path, 'w') as vhdl:
 600         # autogeneration warning
 601         vhdl.write("-- this file is auto-generated, do not edit\n")
 602         vhdl.write("-- http://libre-soc.org/openpower/sv_analysis.py")
 603         vhdl.write("-- part of Libre-SOC, sponsored by NLnet\n")
 604         vhdl.write("\n")
 605
 606         # first create array types
 607         lens = {'major' : 63,
 608                 'minor_4': 63,
 609                 'minor_19': 7,
 610                 'minor_30': 15,
 611                 'minor_31': 1023,
 612                 'minor_58': 63,
 613                 'minor_59': 31,
 614                 'minor_62': 63,
 615                 'minor_63l': 511,
 616                 'minor_63h': 16,
 617                 }
 618         for value, csv in csvs_svp64.items():
 619             # munge name
 620             value = value.lower()
 621             value = value.replace("-", "_")
 622             if value not in lens:
 623                 todo = "    -- TODO %s (or no SVP64 augmentation)\n"
 624                 vhdl.write(todo % value)
 625                 continue
 626             width = lens[value]
 627             typarray = "    type sv_%s_rom_array_t is " \
 628                        "array(0 to %d) of sv_decode_rom_t;\n"
 629             vhdl.write(typarray % (value, width))
 630
 631         # now output structs
 632         hdr = "\n" \
 633               "    constant sv_%s_decode_rom_array :\n" \
 634               "             sv_%s_rom_array_t := (\n"
 635         ftr = "          others  => sv_illegal_inst\n" \
 636               "    );\n\n"
 637         for value, csv in csvs_svp64.items():
 638             # munge name
 639             value = value.lower()
 640             value = value.replace("-", "_")
 641             if value not in lens:
 642                 continue
 643             vhdl.write(hdr % (value, value))
 644             for entry in csv:
 645                 insn = str(entry['insn'])
 646                 sventry = svt.svp64_instrs.get(insn, None)
 647                 op = insns[insn]['opcode']
 648                 # binary-to-vhdl-binary
 649                 if op.startswith("0b"):
 650                     op = "2#%s#" % op[2:]
 651                 row = []
 652                 for colname in csvcols[1:]:
 653                     re = entry[colname]
 654                     # zero replace with NONE
 655                     if re == '0':
 656                         re = 'NONE'
 657                     # 1/2 predication
 658                     re = re.replace("1P", "P1")
 659                     re = re.replace("2P", "P2")
 660                     row.append(re)
 661                 print (sventry)
 662                 for colname in ['sv_in1', 'sv_in2', 'sv_in3', 'sv_out',
 663                                 'sv_cr_in', 'sv_cr_out']:
 664                     if sventry is None:
 665                         re = 'NONE'
 666                     else:
 667                         re = sventry[colname]
 668                     row.append(re)
 669                 row = ', '.join(row)
 670                 vhdl.write("    %13s => (%s), -- %s\n" % (op, row, insn))
 671             vhdl.write(ftr)
 672
 673 if __name__ == '__main__':
 674     process_csvs()