From c525cba09c2af4ce873156ad71c7528dab9d1dc0 Mon Sep 17 00:00:00 2001
From: Wade Fife <wade.fife@ettus.com>
Date: Fri, 20 Jan 2023 13:52:05 -0600
Subject: [PATCH] fpga: tools: Add repeat_fpga_build.py

This script allows you to repeatedly run an FPGA build until it
successfully meets timing.


Original-commit: f72e8daeecf7dff92dce47be0b956699b5e40a16
---
 tools/utils/repeat_fpga_build.py | 163 +++++++++++++++++++++++++++++++
 1 file changed, 163 insertions(+)
 create mode 100755 tools/utils/repeat_fpga_build.py

diff --git a/tools/utils/repeat_fpga_build.py b/tools/utils/repeat_fpga_build.py
new file mode 100755
index 0000000..dec734a
--- /dev/null
+++ b/tools/utils/repeat_fpga_build.py
@@ -0,0 +1,163 @@
+#!/usr/bin/env python3
+#
+# Copyright 2023 Ettus Research, a National Instrument Brand
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+"""
+Repeatedly runs the requested build until it builds successfully and meets
+timing, up to a maximum number of tries. Builds will be retried when they
+fail with timing errors or other errors that might not reoccur. Builds will
+stop if a an unrecognized error occurs.
+"""
+
+import sys
+import argparse
+import subprocess
+import logging
+import re
+import random
+
+
+def parse_args():
+    """Parse the command line arguments.
+
+    Returns:
+        Populated namespace containing the arguments and their values.
+    """
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.ArgumentDefaultsHelpFormatter
+    )
+    parser.add_argument(
+        "--target",
+        "-t",
+        type=str,
+        required=True,
+        help="FPGA make target to build (e.g., X310_XG).",
+    )
+    parser.add_argument(
+        "--num",
+        "-n",
+        type=int,
+        default=4,
+        required=False,
+        help="Number of times to attempt the build.",
+    )
+    parser.add_argument(
+        "--persistent",
+        "-p",
+        action="store_true",
+        default=False,
+        help=(
+            "Continue retrying builds regardless of which error occurs, "
+            "up to the specified number of attempts."
+        ),
+    )
+    parser.add_argument(
+        "--seed",
+        "-s",
+        type=int,
+        default=0,
+        required=False,
+        help="Initial seed value to use.",
+    )
+    return parser.parse_args()
+
+
+def run_fpga_build(build_seed, target):
+    """Performs one iteration of an FPGA build.
+
+    Args:
+        build_seed: 32-bit signed integer to seed the FPGA build.
+        target: Make target name (e.g., X310_XG).
+
+    Returns:
+        0: The build succeeded.
+        1: There was a timing or other error that might not reoccur.
+        2: There was some other error that should cause us to stop trying.
+    """
+    output = ""
+    cmd = f'/bin/bash -c "make {target} BUILD_SEED={build_seed}"'
+    with subprocess.Popen(
+        cmd,
+        shell=True,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+        bufsize=1,
+        universal_newlines=True,
+    ) as proc:
+        for line in proc.stdout:
+            print(line, end="")
+            output += line
+    if proc.returncode != 0:
+        # Regular expressions for error strings to search for that would tell
+        # us we should try again.
+        transient_errors = [
+            # Standard timing error:
+            "The design did not satisfy timing constraints",
+            # Known issue fixed in Vivado 2021.2:
+            (
+                "Router encountered a fatal exception of type .*"
+                "Trying to tool lock on already tool locked arc"
+            ),
+        ]
+        for error_string in transient_errors:
+            if re.search(error_string, output):
+                return 1
+        return 2
+    return 0
+
+
+def next_build_seed(previous_seed):
+    """Determines the next seed to use based on the previous seed. This creates
+    a reproducible sequence of values with a specific initial value.
+
+    Args:
+        previous_seed: The previous integer seed from which to determine the
+            new seed.
+
+    Returns:
+        The next build seed value in the range of a 32-bit signed integer.
+    """
+    random.seed(previous_seed)
+    return random.randint(-0x80000000, 0x7FFFFFFF)
+
+
+def main():
+    """Run the requested builds.
+
+    Returns:
+        The status of the last build (0 if successful, non-zero if the build
+        failed).
+    """
+    logging.basicConfig(format="[REPEAT BUILD][%(levelname)s] %(message)s")
+    logging.root.setLevel(logging.INFO)
+    args = parse_args()
+    build_seed = args.seed
+    status = 128
+    try:
+        for build_num in range(1, args.num + 1):
+            logging.info(f"Starting FPGA build {build_num} with seed {build_seed}")
+            status = run_fpga_build(build_seed, args.target)
+            logging.info(f"Finished FPGA build {build_num}")
+            if status == 0:
+                logging.info(f"FPBA build succeeded on attempt number {build_num}")
+                break
+            elif build_num == args.num:
+                logging.error("Reached maximum number of FPGA build attempts")
+            elif status == 1:
+                logging.info("FPGA build will be restarted due to unsuccessful attempt")
+            elif status == 2 and not args.persistent:
+                logging.error("Stopping due to unexpected FPGA build error")
+                break
+            build_seed = next_build_seed(build_seed)
+    except (KeyboardInterrupt):
+        logging.info("Received SIGINT. Aborting . . .")
+        # Return normal Bash value for SIGINT (128+2)
+        return 130
+    return status
+
+
+if __name__ == "__main__":
+    sys.exit(main())