Merge pull request #752 from boriel-basic/fix/O2_Optimizer_with_next

Fix/o2 optimizer with next

Author: boriel

src/arch/z80/optimizer/memcell.py

@@ -323,7 +323,7 @@ def affects(self, reglist: list[str] | str) -> bool:
             reglist = [reglist]
 
         reglist = helpers.single_registers(reglist)
-        return bool([x for x in self.destroys if x in reglist])
+        return any(x for x in self.destroys if x in reglist)
 
     def needs(self, reglist: list[str] | str) -> bool:
         """Returns if this instruction need any of the registers
@@ -333,7 +333,7 @@ def needs(self, reglist: list[str] | str) -> bool:
             reglist = [reglist]
 
         reglist = helpers.single_registers(reglist)
-        return bool([x for x in self.requires if x in reglist])
+        return any(x for x in self.requires if x in reglist)
 
     @property
     def used_labels(self) -> list[str]:

src/arch/z80/peephole/evaluator.py

@@ -44,6 +44,8 @@ class FN(str, Enum):
     CTEST = "CTEST"
     NEEDS = "NEEDS"
     FLAGVAL = "FLAGVAL"
+    OP1 = "OP1"
+    OP2 = "OP2"
 
 
 # Reg expr patterns
@@ -74,6 +76,8 @@ class FN(str, Enum):
     FN.CTEST: lambda x: memcell.MemCell(x, 1).condition_flag,  # condition test, if any. E.g. retz returns 'z'
     FN.NEEDS: lambda x: memcell.MemCell(x[0], 1).needs(x[1]),
     FN.FLAGVAL: lambda x: helpers.new_tmp_val(),
+    FN.OP1: lambda x: (x.strip().replace(",", " ", 1).split() + [""])[1],
+    FN.OP2: lambda x: (x.strip().replace(",", " ", 1).split() + ["", ""])[2],
 }
 
 # Binary operators

src/arch/z80/peephole/opts/028_o2_pop_up.opt

@@ -18,7 +18,8 @@ REPLACE {{
 }}
 
 IF {{
-  !(INSTR($2) IN (jp, jr, ret, call, djnz, rst)) && !NEEDS($2, (sp, $1)) && !IS_LABEL($2)
+  !(INSTR($2) IN (jp, jr, ret, call, djnz, rst)) && !NEEDS($2, (sp, $1)) && !IS_LABEL($2) &&
+  OP1($2) <> "sp" && OP2($2) <> "sp"
 }}
 
 WITH {{

src/arch/z80/peephole/opts/028_o3_pop_up.opt

@@ -18,6 +18,7 @@ REPLACE {{
 
 IF {{
   !(INSTR($2) IN (jp, jr, ret, call, djnz, rst)) && !NEEDS($2, (sp, $1)) && !IS_LABEL($2)
+  && OP1($2) <> "sp"
 }}
 
 WITH {{

tests/arch/zx48k/optimizer/test_optimizer.py

@@ -41,3 +41,26 @@ def test_unrequired_or_a(self):
         with mock_options_level(4):
             optimized_code = optimizer.Optimizer().optimize(code)
             assert optimized_code.split("\n")[:2] == ["call .core.__LTI8", "ld bc, 0"]
+
+    def test_ld_sp_requires_sp(self):
+        code_src = """
+        ld sp, hl
+        pop iy
+        """
+        code = [x.strip() for x in code_src.split("\n") if x.strip()]
+
+        with mock_options_level(4):
+            optimized_code = optimizer.Optimizer().optimize(code)
+            assert optimized_code.split("\n")[:2] == ["ld sp, hl", "pop iy"]
+
+    def test_hd_sp_requires_sp(self):
+        code_src = """
+        add hl, sp
+        pop iy
+        jp (hl)
+        """
+        code = [x.strip() for x in code_src.split("\n") if x.strip()]
+
+        with mock_options_level(3):
+            optimized_code = optimizer.Optimizer().optimize(code)
+            assert optimized_code.split("\n") == ["add hl, sp", "pop iy", "jp (hl)"]

tests/functional/test.py

@@ -12,6 +12,7 @@
 import sys
 import tempfile
 from collections.abc import Callable, Iterable
+from typing import Final
 
 reOPT = re.compile(r"^opt([0-9]+)_")  # To detect -On tests
 reBIN = re.compile(r"^(?:.*/)?(tzx|tap)_.*")  # To detect tzx / tap test
@@ -39,6 +40,8 @@
 import src.api.utils  # noqa
 from src import zxbasm, zxbc, zxbpp  # noqa
 
+DEFAULT_TIMEOUT: Final[int] = 3  # Default test timeout in seconds
+
 # global FLAGS
 CLOSE_STDERR = False  # Whether to show compiler error or not (usually not when doing tests)
 PRINT_DIFF = False  # Will show diff on test failure
@@ -51,7 +54,7 @@
 STDERR: str = ""
 INLINE: bool = True  # Set to false to use system Shell
 RAISE_EXCEPTIONS = False  # True if we want the testing to abort on compiler crashes
-TIMEOUT = 3  # Max number of seconds a test should last
+TIMEOUT = DEFAULT_TIMEOUT  # Max number of seconds a test should last
 
 _timeout = lambda: TIMEOUT
 
@@ -604,6 +607,7 @@ def main(argv=None):
     global TIMEOUT
 
     COUNTER = FAILED = EXIT_CODE = 0
+    TIMEOUT = DEFAULT_TIMEOUT
 
     parser = argparse.ArgumentParser(description="Test compiler output against source code samples")
     parser.add_argument("-d", "--show-diff", action="store_true", help="Shows output difference on failure")
@@ -626,6 +630,12 @@ def main(argv=None):
         action="store_true",
         help="If an exception is raised (i.e." "the compiler crashes) the testing will " "stop with such exception",
     )
+    parser.add_argument(
+        "--timeout",
+        type=int,
+        default=TIMEOUT,
+        help=f"Sets test timeout in seconds. Default is {TIMEOUT}. Set 0 to disable.",
+    )
     args = parser.parse_args(argv)
 
     STDERR = args.stderr
@@ -643,6 +653,7 @@ def main(argv=None):
         PRINT_DIFF = args.show_diff
         VIM_DIFF = args.show_visual_diff
         UPDATE = args.force_update
+        TIMEOUT = args.timeout
 
         if VIM_DIFF:
             TIMEOUT = 0  # disable timeout for Vim-dif

tests/functional/zxnext/opt2_epilogue.asm

@@ -0,0 +1,31 @@
+	org 32768
+.core.__START_PROGRAM:
+	di
+	push iy
+	ld iy, 0x5C3A  ; ZX Spectrum ROM variables address
+	ld hl, 0
+	add hl, sp
+	ld (.core.__CALL_BACK__), hl
+	ei
+	jp .core.__MAIN_PROGRAM__
+.core.__CALL_BACK__:
+	DEFW 0
+.core.ZXBASIC_USER_DATA:
+	; Defines USER DATA Length in bytes
+.core.ZXBASIC_USER_DATA_LEN EQU .core.ZXBASIC_USER_DATA_END - .core.ZXBASIC_USER_DATA
+	.core.__LABEL__.ZXBASIC_USER_DATA_LEN EQU .core.ZXBASIC_USER_DATA_LEN
+	.core.__LABEL__.ZXBASIC_USER_DATA EQU .core.ZXBASIC_USER_DATA
+.core.ZXBASIC_USER_DATA_END:
+.core.__MAIN_PROGRAM__:
+	ld hl, 0
+	ld b, h
+	ld c, l
+.core.__END_PROGRAM:
+	di
+	ld hl, (.core.__CALL_BACK__)
+	ld sp, hl
+	pop iy
+	ei
+	ret
+	;; --- end of user code ---
+	END

tests/functional/zxnext/opt2_epilogue.bas

@@ -0,0 +1,2 @@
+REM Test empty program for prologue and epilogue
+REM for ZX Next using O2 optimizer

tests/functional/zxnext/opt4_mul8.asm

@@ -33,10 +33,10 @@ _y:
 	push hl
 	call _printTest
 .core.__END_PROGRAM:
-	pop iy
 	di
 	ld hl, (.core.__CALL_BACK__)
 	ld sp, hl
+	pop iy
 	ei
 	ret
 _printTest: