test/runner: allow disabling VCD using SIM_NO_VCD=1 env var

[openpower-isa.git] / src / openpower / util.py

diff --git a/src/openpower/util.py b/src/openpower/util.py
index 697b4cab35693feb77d04438af579dd6de71c62a..f63a49f08c777a61af729f845aa3a78db7e5e410 100644 (file)
--- a/src/openpower/util.py
+++ b/src/openpower/util.py
@@ -1,20 +1,52 @@
+from enum import Enum
+from fnmatch import fnmatchcase
 import os
 import random
-from openpower.consts import FastRegsEnum
+from openpower.consts import FastRegsEnum, StateRegsEnum
 from openpower.decoder.power_enums import SPRfull as SPR, spr_dict
+from functools import lru_cache
+
 
 # note that we can get away with using SPRfull here because the values
 # (numerical values) are what is used for lookup.
-spr_to_fast = { SPR.CTR: FastRegsEnum.CTR,
-                SPR.LR: FastRegsEnum.LR,
-                SPR.TAR: FastRegsEnum.TAR,
-                SPR.SRR0: FastRegsEnum.SRR0,
-                SPR.SRR1: FastRegsEnum.SRR1,
-                SPR.XER: FastRegsEnum.XER,
-                SPR.DEC: FastRegsEnum.DEC,
-                SPR.TB: FastRegsEnum.TB,
-                SPR.SVSRR0: FastRegsEnum.SVSRR0,
-               }
+spr_to_fast = {
+    SPR.LR: FastRegsEnum.LR,
+    SPR.CTR: FastRegsEnum.CTR,
+    SPR.SRR0: FastRegsEnum.SRR0,
+    SPR.SRR1: FastRegsEnum.SRR1,
+    SPR.HSRR0: FastRegsEnum.HSRR0,
+    SPR.HSRR1: FastRegsEnum.HSRR1,
+    SPR.SPRG0_priv: FastRegsEnum.SPRG0,
+    SPR.SPRG1_priv: FastRegsEnum.SPRG1,
+    SPR.SPRG2_priv: FastRegsEnum.SPRG2,
+    SPR.SPRG3: FastRegsEnum.SPRG3,
+    SPR.HSPRG0: FastRegsEnum.HSPRG0,
+    SPR.HSPRG1: FastRegsEnum.HSPRG1,
+    SPR.XER: FastRegsEnum.XER,
+    SPR.TAR: FastRegsEnum.TAR,
+    SPR.SVSRR0: FastRegsEnum.SVSRR0,
+}
+
+spr_to_state = {SPR.DEC: StateRegsEnum.DEC,
+                SPR.TB: StateRegsEnum.TB,
+                }
+
+sprstr_to_state = {}
+state_to_spr = {}
+for (k, v) in spr_to_state.items():
+    sprstr_to_state[k.name] = v
+    state_to_spr[v] = k
+
+
+def state_reg_to_spr(spr_num):
+    return state_to_spr[spr_num].value
+
+
+def spr_to_state_reg(spr_num):
+    if not isinstance(spr_num, str):
+        spr_num = spr_dict[spr_num].SPR
+    return sprstr_to_state.get(spr_num, None)
+
 
 sprstr_to_fast = {}
 fast_to_spr = {}
@@ -22,6 +54,7 @@ for (k, v) in spr_to_fast.items():
     sprstr_to_fast[k.name] = v
     fast_to_spr[v] = k
 
+
 def fast_reg_to_spr(spr_num):
     return fast_to_spr[spr_num].value
 
@@ -47,9 +80,9 @@ def spr_to_slow_reg(spr_num):
 # TODO: make this a util routine (somewhere)
 def mask_extend(x, nbits, repeat):
     res = 0
-    extended = (1<<repeat)-1
+    extended = (1 << repeat)-1
     for i in range(nbits):
-        if x & (1<<i):
+        if x & (1 << i):
             res |= extended << (i*repeat)
     return res
 
@@ -60,10 +93,59 @@ def log_rand(n, min_val=1):
     return random.randint(min_val, (1 << logrange)-1)
 
 
-def log(*args, **kwargs):
-    """verbose printing, disabled if an ENV VAR "SILENCELOG" exists.
+class LogType(Enum):
+    Default = "default"
+    InstrInOuts = "instr_in_outs"
+    SkipCase = "skip_case"
+    OutputMatching = "output_matching"
+
+
+@lru_cache(typed=True)
+def __parse_log_env_var(silencelog_raw):
+    if silencelog_raw is None:
+        return {k: False for k in LogType}
+    silencelog = os.environ.decodevalue(silencelog_raw)
+    silencelog = silencelog.lower().split(",")
+    for i, v in enumerate(silencelog):
+        silencelog[i] = v.strip()
+    retval = {k: True for k in LogType}
+    if len(silencelog) > 1 and silencelog[-1] == "":
+        # allow trailing comma
+        silencelog.pop()
+    if len(silencelog) == 1:
+        if silencelog[0] in ("0", "false"):
+            for k in LogType:
+                retval[k] = False
+            silencelog.pop()
+        if silencelog[0] in ("1", "true", ""):
+            silencelog.pop()
+    for v in silencelog:
+        silenced = True
+        if v.startswith("!"):
+            v = v[1:]
+            silenced = False
+        matches = False
+        for k in LogType:
+            if fnmatchcase(k.value, v):
+                matches = True
+                retval[k] = silenced
+        assert matches, (f"SILENCELOG: {v!r} did not match any known LogType: "
+                         f"LogTypes: {' '.join(i.value for i in LogType)}")
+    # for k, v in retval.items():
+    #    print(repr(k), "silenced" if v else "active")
+    return retval
+
+
+__ENCODED_SILENCELOG = os.environ.encodekey("SILENCELOG")
+
+
+def log(*args, kind=LogType.Default, **kwargs):
+    """verbose printing, can be disabled by setting env var "SILENCELOG".
     """
-    if 'SILENCELOG' in os.environ:
+    # look up in os.environ._data since it is a dict and hence won't raise
+    # internal exceptions to avoid triggering breakpoints on raised exceptions.
+    env_var = os.environ._data.get(__ENCODED_SILENCELOG, None)
+    silenced = __parse_log_env_var(env_var)
+    if silenced[kind]:
         return
     print(*args, **kwargs)
-