src/openpower/decoder/power_fields.py

   1 from collections import namedtuple
   2
   3 import operator as _operator
   4 import functools as _functools
   5
   6 from openpower.decoder.power_enums import find_wiki_file as _find_wiki_file
   7 from openpower.decoder.selectable_int import (
   8     SelectableInt as _SelectableInt,
   9     BitRange as _BitRange,
  10     selectconcat as _selectconcat,
  11     selectltu as _selectltu,
  12 )
  13
  14
  15 class RemapError(ValueError):
  16     pass
  17
  18
  19 class Descriptor:
  20     def __init__(self, cls):
  21         self.__cls = cls
  22         return super().__init__()
  23
  24     def __get__(self, instance, owner):
  25         if instance is None:
  26             return self.__cls
  27         return self.__cls(storage=instance.storage)
  28
  29     def __set__(self, instance, value):
  30         if instance is None:
  31             raise AttributeError("read-only attribute")
  32         self.__cls(storage=instance.storage).assign(value)
  33
  34
  35 @_functools.total_ordering
  36 class Reference:
  37     def __init__(self, storage, *args, **kwargs):
  38         if not isinstance(storage, _SelectableInt):
  39             raise ValueError(storage)
  40
  41         self.storage = storage
  42
  43         super().__init__()
  44         self.__post_init__()
  45
  46     def __post_init__(self, *args, **kwargs):
  47         _ = (args, kwargs)
  48
  49     def __binary_operator(self, op, other):
  50         span = dict.fromkeys(self.__class__.span).keys()
  51         lhs = _selectconcat(*(self.storage[bit] for bit in span))
  52
  53         if isinstance(other, Reference):
  54             span = dict.fromkeys(other.__class__.span).keys()
  55             rhs = _selectconcat(*(other.storage[bit] for bit in span))
  56         elif isinstance(other, int):
  57             bits = len(self.__class__)
  58             if other.bit_length() > bits:
  59                 raise OverflowError(other)
  60             rhs = _SelectableInt(value=other, bits=bits)
  61         elif isinstance(other, _SelectableInt):
  62             rhs = other
  63         else:
  64             raise ValueError(other)
  65
  66         return op(lhs, rhs)
  67
  68     def __lt__(self, other):
  69         return self.__binary_operator(_selectltu, other)
  70
  71     def __eq__(self, other):
  72         return self.__binary_operator(_operator.eq, other)
  73
  74     def __bool__(self):
  75         return bool(int(self))
  76
  77     def __int__(self):
  78         span = dict.fromkeys(self.__class__.span).keys()
  79         return int(_selectconcat(*(self.storage[bit] for bit in span)))
  80
  81     def __index__(self):
  82         return int(self).__index__()
  83
  84     @property
  85     def storage(self):
  86         return self.__storage
  87
  88     @storage.setter
  89     def storage(self, storage):
  90         if not isinstance(storage, _SelectableInt):
  91             raise ValueError(storage)
  92
  93         self.__storage = storage
  94
  95     def assign(self, value, bits=None):
  96         if bits is None:
  97             bits = range(len(self.__class__))
  98         elif isinstance(bits, int):
  99             bits = (bits,)
 100         elif isinstance(bits, slice):
 101             assert bits.step is None or bits.step == 1
 102             bits = range(bits.start, bits.stop)
 103         bits = tuple(bits)
 104
 105         if isinstance(value, int):
 106             if value.bit_length() > len(bits):
 107                 raise OverflowError(value)
 108             value = _SelectableInt(value=value, bits=len(bits))
 109         if not isinstance(value, _SelectableInt):
 110             raise ValueError(value)
 111         if value.bits != len(bits):
 112             raise OverflowError(value)
 113
 114         span = tuple(self.__class__.span)
 115         mapping = dict(enumerate(span))
 116         for (src, bit) in enumerate(bits):
 117             if src >= value.bits:
 118                 raise OverflowError(src)
 119             dst = mapping.get(bit)
 120             if dst is None:
 121                 raise OverflowError(bit)
 122             self.storage[dst] = value[src]
 123
 124
 125 class FieldMeta(type):
 126     def __new__(metacls, clsname, bases, ns, items=()):
 127         assert "__members__" not in ns
 128
 129         members = []
 130         for item in items:
 131             if not isinstance(item, int):
 132                 raise ValueError(item)
 133             if item < 0:
 134                 raise ValueError(item)
 135             members.append(item)
 136
 137         ns["__members__"] = tuple(members)
 138
 139         return super().__new__(metacls, clsname, bases, ns)
 140
 141     def __repr__(cls):
 142         if not cls.__members__:
 143             return cls.__name__
 144         return f"{cls.__name__}{cls.__members__!r}"
 145
 146     def __iter__(cls):
 147         yield from cls.__members__
 148
 149     def __len__(cls):
 150         return len(cls.__members__)
 151
 152     def __getitem__(cls, selector):
 153         if isinstance(selector, int):
 154             selector = (selector,)
 155
 156         items = []
 157         for idx in selector:
 158             if not isinstance(idx, int):
 159                 raise ValueError(selector)
 160             item = cls.__members__[idx]
 161             items.append(item)
 162
 163         return cls.__class__(cls.__name__, (Field,), {}, items=items)
 164
 165     def remap(cls, scheme):
 166         if isinstance(scheme, type) and issubclass(scheme, Mapping):
 167             scheme = range(len(scheme))
 168         scheme = cls.__class__(cls.__name__, (cls,), {}, items=scheme)
 169
 170         if len(cls) == 0:
 171             return scheme
 172         elif len(cls) > len(scheme):
 173             llen = f"len(scheme)"
 174             rlen = f"len({cls.__name__})"
 175             raise RemapError(f"{llen} != {rlen}")
 176
 177         ns = {}
 178         ns["__doc__"] = cls.__doc__
 179         items = map(lambda item: scheme.__members__[item], cls)
 180
 181         return cls.__class__(cls.__name__, (cls,), ns, items=items)
 182
 183     @property
 184     def span(cls):
 185         return cls.__members__
 186
 187
 188 class Field(Reference, metaclass=FieldMeta):
 189     def __repr__(self):
 190         return f"[{len(self.__class__)}]0x{int(self):x}"
 191
 192     def __iter__(self):
 193         for bit in self.__class__:
 194             yield self.storage[bit]
 195
 196     def __getitem__(self, key):
 197         if isinstance(key, int):
 198             bit = self.storage[self.__class__.__members__[key]]
 199             return _SelectableInt(value=bit, bits=1)
 200         if isinstance(key, slice):
 201             assert key.step is None or key.step == 1
 202             key = range(key.start, key.stop)
 203
 204         return _selectconcat(*(self[bit] for bit in key))
 205
 206     def __setitem__(self, key, value):
 207         return self.assign(value=value, bits=key)
 208
 209     @classmethod
 210     def traverse(cls, path):
 211         yield (path, cls.__members__)
 212
 213
 214 class MappingMeta(type):
 215     def __new__(metacls, clsname, bases, ns):
 216         members = {}
 217
 218         for cls in bases:
 219             if isinstance(cls, metacls):
 220                 members.update(cls.__members__)
 221
 222         for (name, cls) in ns.get("__annotations__", {}).items():
 223             if not (isinstance(cls, type) and
 224                     issubclass(cls, (Mapping, Field))):
 225                 raise ValueError(f"{clsname}.{name}: {cls!r}")
 226
 227             if name in ns:
 228                 try:
 229                     members[name] = cls.remap(ns[name])
 230                 except RemapError as error:
 231                     raise RemapError(f"{name}: {error}")
 232             else:
 233                 if cls is Field:
 234                     raise ValueError(f"{clsname}.{name}: missing initializer")
 235                 members[name] = cls
 236
 237         ns["__members__"] = members
 238         for (name, cls) in members.items():
 239             ns[name] = Descriptor(cls)
 240
 241         return super().__new__(metacls, clsname, bases, ns)
 242
 243     def __repr__(cls):
 244         return f"{cls.__name__}({cls.__members__!r})"
 245
 246     def __iter__(cls):
 247         yield from cls.__members__.items()
 248
 249     def __len__(cls):
 250         length = 0
 251         for field in cls.__members__.values():
 252             length = max(length, len(field))
 253         return length
 254
 255     def __getitem__(cls, selector):
 256         return cls.__members__["_"][selector]
 257
 258     def remap(cls, scheme):
 259         ns = {}
 260         annotations = {}
 261
 262         for (name, field) in cls:
 263             annotations[name] = field.remap(scheme)
 264         ns["__annotations__"] = annotations
 265         ns["__doc__"] = cls.__doc__
 266
 267         return cls.__class__(cls.__name__, (cls,), ns)
 268
 269     @property
 270     def span(cls):
 271         for field in cls.__members__.values():
 272             yield from field.span
 273
 274
 275 class Mapping(Reference, metaclass=MappingMeta):
 276     def __init__(self, storage, **kwargs):
 277         members = {}
 278         for (name, cls) in self.__class__:
 279             members[name] = cls(storage)
 280
 281         self.__members = members
 282
 283         return super().__init__(storage, **kwargs)
 284
 285     def __repr__(self):
 286         items = tuple(f"{name}={field!r}" for (name, field) in self)
 287         return f"{{{', '.join(items)}}}"
 288
 289     def __iter__(self):
 290         yield from self.__members.items()
 291
 292     def __getitem__(self, key):
 293         if isinstance(key, (int, slice, list, tuple, range)):
 294             return self["_"].__getitem__(key)
 295
 296         return self.__members.__getitem__(key)
 297
 298     def __setitem__(self, key, value):
 299         if isinstance(key, (int, slice, list, tuple, range)):
 300             return self["_"].assign(value=value, bits=key)
 301
 302         return self.assign(value=value, bits=key)
 303
 304     @classmethod
 305     def traverse(cls, path):
 306         for (name, member) in cls.__members__.items():
 307             if name == "_":
 308                 yield from member.traverse(path=path)
 309             elif path == "":
 310                 yield from member.traverse(path=name)
 311             else:
 312                 yield from member.traverse(path=f"{path}.{name}")
 313
 314
 315 def decode_instructions(form):
 316     res = {}
 317     accum = []
 318     for l in form:
 319         if l.strip().startswith("Formats"):
 320             l = l.strip().split(":")[-1]
 321             l = l.replace(" ", "")
 322             l = l.split(",")
 323             for fmt in l:
 324                 if fmt not in res:
 325                     res[fmt] = [accum[0]]
 326                 else:
 327                     res[fmt].append(accum[0])
 328             accum = []
 329         else:
 330             accum.append(l.strip())
 331     return res
 332
 333
 334 def decode_form_header(hdr):
 335     res = {}
 336     count = 0
 337     hdr = hdr.strip()
 338     for f in hdr.split("|"):
 339         if not f:
 340             continue
 341         if f[0].isdigit():
 342             idx = int(f.strip().split(' ')[0])
 343             res[count] = idx
 344         count += len(f) + 1
 345     return res
 346
 347
 348 def find_unique(d, key):
 349     if key not in d:
 350         return key
 351     idx = 1
 352     while "%s_%d" % (key, idx) in d:
 353         idx += 1
 354     return "%s_%d" % (key, idx)
 355
 356
 357 def decode_line(header, line):
 358     line = line.strip()
 359     res = {}
 360     count = 0
 361     prev_fieldname = None
 362     for f in line.split("|"):
 363         if not f:
 364             continue
 365         end = count + len(f) + 1
 366         fieldname = f.strip()
 367         if not fieldname or fieldname.startswith('/'):
 368             if prev_fieldname is not None:
 369                 res[prev_fieldname] = (res[prev_fieldname], header[count])
 370                 prev_fieldname = None
 371             count = end
 372             continue
 373         bitstart = header[count]
 374         if prev_fieldname is not None:
 375             res[prev_fieldname] = (res[prev_fieldname], bitstart)
 376         res[fieldname] = bitstart
 377         count = end
 378         prev_fieldname = fieldname
 379     res[prev_fieldname] = (bitstart, 32)
 380     return res
 381
 382
 383 def decode_form(form):
 384     header = decode_form_header(form[0])
 385     res = []
 386     for line in form[1:]:
 387         dec = decode_line(header, line)
 388         if dec:
 389             res.append(dec)
 390     fields = {}
 391     falternate = {}
 392     for l in res:
 393         for k, (start, end) in l.items():
 394             if k in fields:
 395                 if (start, end) == fields[k]:
 396                     continue  # already in and matching for this Form
 397                 if k in falternate:
 398                     alternate = "%s_%d" % (k, falternate[k])
 399                     if (start, end) == fields[alternate]:
 400                         continue
 401                 falternate[k] = fidx = falternate.get(k, 0) + 1
 402                 fields["%s_%d" % (k, fidx)] = (start, end)
 403             else:
 404                 fields[k] = (start, end)
 405     return fields
 406
 407
 408 class DecodeFields:
 409
 410     def __init__(self, bitkls=_BitRange, bitargs=(), fname=None,
 411                  name_on_wiki=None):
 412         self.bitkls = bitkls
 413         self.bitargs = bitargs
 414         if fname is None:
 415             assert name_on_wiki is None
 416             fname = "fields.txt"
 417             name_on_wiki = "fields.text"
 418         self.fname = _find_wiki_file(name_on_wiki)
 419
 420     @property
 421     def form_names(self):
 422         return self.instrs.keys()
 423
 424     def create_specs(self):
 425         self.forms, self.instrs = self.decode_fields()
 426         forms = self.form_names
 427         #print ("specs", self.forms, forms)
 428         for form in forms:
 429             fields = self.instrs[form]
 430             fk = fields.keys()
 431             Fields = namedtuple("Fields", fk)
 432             instr = Fields(**fields)
 433             setattr(self, "Form%s" % form, instr)
 434         # now add in some commonly-used fields (should be done automatically)
 435         # note that these should only be ones which are the same on all Forms
 436         # note: these are from microwatt insn_helpers.vhdl
 437         self.common_fields = {
 438             "PO": self.Formall.PO,
 439             "FRS": self.FormX.FRS,
 440             "FRT": self.FormX.FRT,
 441             "FRA": self.FormX.FRA,
 442             "FRB": self.FormX.FRB,
 443             "FRC": self.FormA.FRC,
 444             "RS": self.FormX.RS,
 445             "RT": self.FormX.RT,
 446             "RA": self.FormX.RA,
 447             "RB": self.FormX.RB,
 448             "RC": self.FormVA.RC,
 449             "SI": self.FormD.SI,
 450             "UI": self.FormD.UI,
 451             "L": self.FormD.L,
 452             "SH32": self.FormM.SH,
 453             "sh": self.FormMD.sh,
 454             "MB32": self.FormM.MB,
 455             "ME32": self.FormM.ME,
 456             "LI": self.FormI.LI,
 457             "LK": self.FormI.LK,
 458             "AA": self.FormB.AA,
 459             "Rc": self.FormX.Rc,
 460             "OE": self.FormXO.OE,
 461             "BD": self.FormB.BD,
 462             "BF": self.FormX.BF,
 463             "CR": self.FormXL.XO,
 464             "BB": self.FormXL.BB,
 465             "BA": self.FormXL.BA,
 466             "BT": self.FormXL.BT,
 467             "FXM": self.FormXFX.FXM,
 468             "BO": self.FormXL.BO,
 469             "BI": self.FormXL.BI,
 470             "BH": self.FormXL.BH,
 471             "D": self.FormD.D,
 472             "DS": self.FormDS.DS,
 473             "TO": self.FormX.TO,
 474             "BC": self.FormA.BC,
 475             "SH": self.FormX.SH,
 476             "ME": self.FormM.ME,
 477             "MB": self.FormM.MB,
 478             "SPR": self.FormXFX.SPR}
 479         for k, v in self.common_fields.items():
 480             setattr(self, k, v)
 481
 482     def decode_fields(self):
 483         with open(self.fname) as f:
 484             txt = f.readlines()
 485         #print ("decode", txt)
 486         forms = {}
 487         reading_data = False
 488         for l in txt:
 489             l = l.strip()
 490             if len(l) == 0:
 491                 continue
 492             if reading_data:
 493                 if l[0] == '#':
 494                     reading_data = False
 495                 else:
 496                     forms[heading].append(l)
 497             if not reading_data:
 498                 assert l[0] == '#'
 499                 heading = l[1:].strip()
 500                 # if heading.startswith('1.6.28'): # skip instr fields for now
 501                 #     break
 502                 heading = heading.split(' ')[-1]
 503                 reading_data = True
 504                 forms[heading] = []
 505
 506         res = {}
 507         inst = {}
 508
 509         for hdr, form in forms.items():
 510             if heading == 'Fields':
 511                 i = decode_instructions(form)
 512                 for form, field in i.items():
 513                     inst[form] = self.decode_instruction_fields(field)
 514             # else:
 515             #     res[hdr] = decode_form(form)
 516         return res, inst
 517
 518     def decode_instruction_fields(self, fields):
 519         res = {}
 520         for field in fields:
 521             f, spec = field.strip().split(" ")
 522             ss = spec[1:-1].split(",")
 523             fs = f.split(",")
 524             if len(fs) > 1:
 525                 individualfields = []
 526                 for f0, s0 in zip(fs, ss):
 527                     txt = "%s (%s)" % (f0, s0)
 528                     individualfields.append(txt)
 529                 if len(fs) > 1:
 530                     res.update(self.decode_instruction_fields(
 531                         individualfields))
 532             d = self.bitkls(*self.bitargs)
 533             idx = 0
 534             for s in ss:
 535                 s = s.split(':')
 536                 if len(s) == 1:
 537                     d[idx] = int(s[0])
 538                     idx += 1
 539                 else:
 540                     start = int(s[0])
 541                     end = int(s[1])
 542                     while start <= end:
 543                         d[idx] = start
 544                         idx += 1
 545                         start += 1
 546             f = f.replace(",", "_")
 547             unique = find_unique(res, f)
 548             res[unique] = d
 549
 550         return res
 551
 552
 553 if __name__ == '__main__':
 554     dec = DecodeFields()
 555     dec.create_specs()
 556     forms, instrs = dec.forms, dec.instrs
 557     for form, fields in instrs.items():
 558         print("Form", form)
 559         for field, bits in fields.items():
 560             print("\tfield", field, bits)