Tests: Modified dis.py and added primitive tests (#37)

JuliaPoo · web-flow · commit fd338dfc1d32 · 2023-04-13T16:38:13.000+08:00
* Tests: Modified dis.py and added primitive tests

* Docs: Typos and more documentation

* Test: Fixed minor issue
diff --git a/CS4215.md b/CS4215.md
@@ -16,5 +16,23 @@ language, our interpreter cannot be used as a bootstrap Python.
 
 # Where are files located?
 
-The majority of the changes and functionality are in `Python/tier2.c`. Doxygen documentation
-is written alongside the code.
+The majority of the changes and functionality are in `Python/tier2.c` where Doxygen documentation
+is written alongside the code, and in `Tools/cases_generator/` which contains the DSL implementation.
+
+# Running tests
+
+We've written simple tests of the main functionalities.
+Unfortunately we did not have time to write comprehensive tests, and it doesn't seem worth it eitherways given the experimental nature of this project.
+
+After building, run `python tier2_test.py` in the repository's root folder.
+
+# Debugging output
+
+In `tier2.c`, two flags can be set to print debug messages:
+```c
+// Prints codegen debug messages
+#define BB_DEBUG 0
+
+// Prints typeprop debug messages
+#define TYPEPROP_DEBUG 0
+```
diff --git a/Lib/dis.py b/Lib/dis.py
@@ -474,6 +474,7 @@ def _get_instructions_bytes(code, varname_from_oparg=None,
         for i in range(start, end):
             labels.add(target)
     starts_line = None
+    ret = []
     for offset, op, arg in _unpack_opargs(code):
         if linestarts is not None:
             starts_line = linestarts.get(offset, None)
@@ -534,9 +535,9 @@ def _get_instructions_bytes(code, varname_from_oparg=None,
                                     if arg & (1<<i))
             elif deop == BINARY_OP:
                 _, argrepr = _nb_ops[arg]
-        yield Instruction(_all_opname[op], op,
+        ret.append(Instruction(_all_opname[op], op,
                           arg, argval, argrepr,
-                          offset, starts_line, is_jump_target, positions)
+                          offset, starts_line, is_jump_target, positions))
         caches = _inline_cache_entries[deop]
         if not caches:
             continue
@@ -555,10 +556,11 @@ def _get_instructions_bytes(code, varname_from_oparg=None,
                     argrepr = f"{name}: {int.from_bytes(data, sys.byteorder)}"
                 else:
                     argrepr = ""
-                yield Instruction(
+                ret.append(Instruction(
                     "CACHE", CACHE, 0, None, argrepr, offset, None, False,
                     Positions(*next(co_positions, ()))
-                )
+                ))
+    return ret
 
 def disassemble(co, lasti=-1, *, file=None, show_caches=False, adaptive=False, tier2=False):
     """Disassemble a code object."""
diff --git a/Python/tier2.c b/Python/tier2.c
@@ -9,8 +9,8 @@
 
 #include "opcode.h"
 
-#define BB_DEBUG 1
-#define TYPEPROP_DEBUG 1
+#define BB_DEBUG 0
+#define TYPEPROP_DEBUG 0
 // Max typed version basic blocks per basic block
 #define MAX_BB_VERSIONS 10
 
diff --git a/tier2_test.py b/tier2_test.py
@@ -0,0 +1,322 @@
+import dis
+
+#########
+# Utils #
+#########
+
+def trigger_tier2(f, args):
+    for _ in range(64):
+        f(*args)
+
+def writeinst(opc:str, arg:int=0):
+
+    "Makes life easier in writing python bytecode"
+
+    nb = max(1,-(-arg.bit_length()//8))
+    ab = arg.to_bytes(nb, 'big')
+    ext_arg = dis._all_opmap['EXTENDED_ARG']
+    inst = bytearray()
+    for i in range(nb-1):
+        inst.append(ext_arg)
+        inst.append(ab[i])
+    inst.append(dis._all_opmap[opc])
+    inst.append(ab[-1])
+
+    return bytes(inst)
+
+
+###################
+# Type prop tests #
+###################
+
+def test_typeprop1(a):
+    # Dummy code won't be ran
+    return a+(a+(a+a))
+
+bytecode = b"".join([
+    # Tests TYPE_SET and TYPE_OVERWRITE
+    writeinst("RESUME", 0),
+    writeinst("LOAD_FAST", 0),
+    writeinst("COPY", 1),
+    writeinst("COPY", 1),
+    writeinst("BINARY_OP", 0),
+    writeinst("CACHE", 0), # For tier1
+    writeinst("BINARY_OP", 0),
+    writeinst("CACHE", 0), # For tier1
+    writeinst("RETURN_VALUE", 0)
+])
+
+# Switch to bytecode
+test_typeprop1.__code__ = test_typeprop1.__code__.replace(co_code=bytecode)
+
+trigger_tier2(test_typeprop1, (0,))
+expected = [
+    "RESUME_QUICK",
+    "LOAD_FAST", # Load locals
+    "COPY",
+    "COPY", # Copy variable on stack
+            # All stack variables part of the tree
+    "BINARY_CHECK_FLOAT",
+    "NOP",  # Space for an EXTENDED_ARG if needed
+    "BB_BRANCH_IF_FLAG_SET",
+
+    # This should let the typeprop know all the locals and stack be int
+    # TYPE_SET
+    # Locals: [int]
+    # Stack : [int->locals[0], int->stack[0], int->stack[1]]
+    "BINARY_CHECK_INT",
+    "NOP",
+    "BB_BRANCH_IF_FLAG_UNSET", # Fallthrough!
+
+    # Should propagate the result as int
+    # TYPE_OVERWRITE
+    # Locals: [int]
+    # Stack : [int->locals[0], int]
+    "BINARY_OP_ADD_INT_REST",
+
+    # There should be no more guards here
+    # if the type propagator is working
+    "BINARY_OP_ADD_INT_REST",
+    "RETURN_VALUE"
+]
+insts = dis.get_instructions(test_typeprop1, tier2=True)
+for x,y in zip(insts, expected):
+    assert x.opname == y
+
+bytecode = b"".join([
+    # Tests TYPE_SWAP
+    writeinst("RESUME", 0),
+    writeinst("LOAD_FAST", 0), # float
+    writeinst("LOAD_FAST", 1), # int
+    writeinst("SWAP", 2), # Stack: [int, float]
+
+    writeinst("COPY", 1),
+    # Should generate the FLOAT specialisation
+    writeinst("BINARY_OP", 0),
+    writeinst("CACHE", 0), # For tier1
+
+    writeinst("SWAP", 2), # [float, int]
+    writeinst("COPY", 1),
+    # Should generate the INT specialisation
+    writeinst("BINARY_OP", 0),
+    writeinst("CACHE", 0), # For tier1
+
+    # float + int
+    writeinst("BINARY_OP", 0),
+    writeinst("CACHE", 0), # For tier1
+    writeinst("RETURN_VALUE", 0)
+])
+
+def test_typeprop2(a,b):
+    # Dummy code won't be ran
+    return a+(a+(a+a))
+
+# Switch to bytecode
+test_typeprop2.__code__ = test_typeprop2.__code__.replace(co_code=bytecode)
+test_typeprop2(0.1,1)
+
+trigger_tier2(test_typeprop2, (0.1,1))
+expected = [
+    "RESUME_QUICK",
+    "LOAD_FAST",
+    "LOAD_FAST",
+    "SWAP",
+    "COPY",
+
+    # Should gen specialised float
+    "BINARY_CHECK_FLOAT",
+    "NOP",
+    "BB_BRANCH_IF_FLAG_UNSET",
+    "BINARY_OP_ADD_FLOAT_UNBOXED",
+    "SWAP",
+    "COPY",
+
+    # Ladder of types guards
+    "BINARY_CHECK_FLOAT",
+    "NOP",
+    "BB_BRANCH_IF_FLAG_SET",
+
+    # Should gen specialised int
+    "BINARY_CHECK_INT",
+    "NOP",
+    "BB_BRANCH_IF_FLAG_UNSET",
+    "BINARY_OP_ADD_INT_REST",
+    # Don't care about the rest of the insts
+]
+insts = dis.get_instructions(test_typeprop2, tier2=True)
+# Assert the value is correct
+assert abs(test_typeprop2(0.1,1) - 2.2) < 0.001
+for x,y in zip(insts, expected):
+    assert x.opname == y
+
+
+#######################################
+# Type guard                          #
+# + Float unboxing                    #
+# + Jump rewriting test               #
+#######################################
+
+def test_guard_elimination(a,b):
+    x = b
+    y = b
+    # First a+x should inform the type prop that
+    # `a`, `x`, `b` and `y` are int
+    # So guard should be eliminated in (a+x) + y
+    return a + x + y
+
+trigger_tier2(test_guard_elimination, (0,0))
+expected = [
+    # From tier1 bytecode
+    "RESUME_QUICK",
+    "LOAD_FAST",
+    "STORE_FAST",
+    "LOAD_FAST",
+    "STORE_FAST",
+    "LOAD_FAST",
+    "LOAD_FAST",
+
+    "BINARY_CHECK_FLOAT", # First ladder check
+    "NOP",
+    "BB_BRANCH_IF_FLAG_SET",
+    "BINARY_CHECK_INT", # Second ladder check
+    "NOP",
+    "BB_BRANCH_IF_FLAG_UNSET", # Fall through!
+
+    "BINARY_OP_ADD_INT_REST", # a+x
+    "LOAD_FAST",
+    "BINARY_OP_ADD_INT_REST", # (a+x) + y (guard eliminated)
+    "RETURN_VALUE"
+]
+insts = dis.get_instructions(test_guard_elimination, tier2=True)
+for x,y in zip(insts, expected):
+    assert x.opname == y
+
+# We only wanna test the stability of the first type guards
+# later on
+first_guard_test_until = insts[-1].offset
+
+# Trigger generation of other branch
+test_guard_elimination(0.1, 0.1)
+insts = dis.get_instructions(test_guard_elimination, tier2=True)
+expected = [
+    # From tier1 bytecode
+    "RESUME_QUICK",
+    "LOAD_FAST",
+    "STORE_FAST",
+    "LOAD_FAST",
+    "STORE_FAST",
+    "LOAD_FAST",
+    "LOAD_FAST",
+
+    "BINARY_CHECK_FLOAT", # First ladder check
+    "NOP",
+    "BB_JUMP_IF_FLAG_SET", # Rewrite to jump to float case
+    "POP_TOP", # Pop result
+
+    # The same as above
+    "BINARY_CHECK_INT",
+    "NOP",
+    "BB_BRANCH_IF_FLAG_UNSET",
+    "BINARY_OP_ADD_INT_REST",
+    "LOAD_FAST",
+    "BINARY_OP_ADD_INT_REST",
+    "RETURN_VALUE",
+
+    # Float case
+    "BINARY_OP_ADD_FLOAT_UNBOXED", # Unbox
+    "LOAD_FAST",
+    "UNBOX_FLOAT", # Unbox local
+    "STORE_FAST_UNBOXED_BOXED", # Store unboxed float into local
+    "LOAD_FAST_NO_INCREF", # Load (unboxed) local again
+    "BINARY_OP_ADD_FLOAT_UNBOXED", # No type guard here
+    "BOX_FLOAT", # Box to return
+    "RETURN_VALUE"
+]
+
+test_guard_elimination(1,1)
+for x,y in zip(insts, expected):
+    assert x.opname == y
+
+# Perform other polymorphism stuff
+# We've not implemented type guard elimination
+# For these mixed types (e.g., float+int) 
+# So these will generate more type guards with the same 
+# mechanisms as above.
+# So codegen wise tier2 takes a while to stabilise
+assert (test_guard_elimination(1,0.1) - 1.2) < 0.001
+assert (test_guard_elimination(0.1,1) - 2.1) < 0.001
+assert (test_guard_elimination(.4,.5) - 1.4) < 0.001
+assert test_guard_elimination(2,3) == 8
+
+# At this point all cases should be generated
+# so check if the generated cases are the same
+expected = dis.get_instructions(test_guard_elimination, tier2=True)
+test_guard_elimination(-192,203)
+test_guard_elimination(2.3, 12)
+test_guard_elimination(324, 0.12)
+test_guard_elimination(0.12,32.1)
+insts = dis.get_instructions(test_guard_elimination, tier2=True)
+
+# Make sure the first type guard is stable
+for x,y in zip(insts, expected):
+    if x.offset >= first_guard_test_until:
+        break
+    assert x.opname == y.opname
+
+
+######################
+# Backward jump test #
+# + loop peeling     #
+######################
+
+def test_backwards_jump(a):
+    for i in range(64):
+        a = i + a
+    return a
+
+# Trigger only one JUMP_BACKWARD_QUICK
+# i.e., perfect specialisation the first time
+trigger_tier2(test_backwards_jump, (0,))
+
+# Make sure it looped 64 times
+assert test_backwards_jump(7) == 2023 # <-- Hi! ~ Jules
+
+# Make sure it jumped to the correct spot
+insts = dis.get_instructions(test_backwards_jump, tier2=True) 
+backwards_jump = next(x for x in insts if x.opname == "JUMP_BACKWARD_QUICK")
+instidx, jmp_target = next((i,x) for i,x in enumerate(insts) if x.offset == backwards_jump.argval)
+assert jmp_target.opname == "NOP" # Space for an EXTENDED_ARG
+assert insts[instidx + 1].opname == "BB_TEST_ITER_RANGE" # The loop predicate
+
+
+def test_loop_peeling(a):
+    for i in range(64):
+        a = float(i) + a
+    return a
+
+# This triggers loop peeling, because 
+# the first iteration `a` type is int
+# and the 2nd iteration `a` type is float
+# This should triger a JUMP_FORWARD in place of
+# a JUMP_BACKWARD_QUICK
+trigger_tier2(test_loop_peeling, (0,))
+
+# Make sure it looped 64 times
+assert abs(test_loop_peeling(7) - 2023) < 0.001
+
+# Make sure the JUMP_FORWARD jumped correctly
+insts = dis.get_instructions(test_loop_peeling, tier2=True) 
+forwards_jump = next(x for x in insts if x.opname == "JUMP_FORWARD")
+instidx, jmp_target = next((i,x) for i,x in enumerate(insts) if x.offset == forwards_jump.argval)
+assert jmp_target.opname == "NOP" # Space for an EXTENDED_ARG
+assert insts[instidx + 1].opname == "BB_TEST_ITER_RANGE" # The loop predicate
+
+# We also need to make sure JUMP_FORWARD
+# jumped into the float-specialised loop body
+endidx, _ = next(
+    (i,x) for i,x in enumerate(insts) 
+    if (x.opname == "JUMP_BACKWARD_QUICK" and x.offset > jmp_target.offset))
+# Check for existence of float-specialised instruction in loop body
+assert any(1 for _ in
+    filter(lambda i: i.opname == 'BINARY_OP_ADD_FLOAT_UNBOXED', insts[instidx:endidx]))
+
