SBY Stages Setup script generation

sbysrc/sby_core.py

@@ -443,7 +443,7 @@ def parse_config(self, f):
 
             if mode == "setup":
                 _valid_options = (
-                    "cutpoint", "disable", "enable", "assume", "define"
+                    "cutpoint", "disable", "enable", "assume", "define", "invoke"
                 )
 
                 args = line.strip().split(maxsplit = 1)
@@ -546,6 +546,48 @@ def parse_config(self, f):
     def error(self, logmessage):
         raise SbyAbort(logmessage)
 
+    def gen_setup_script(self):
+        script = '# Autogenerated by SBY stage setup\n'
+        script += 'read_ilang design.il\n'
+        script += 'select *\n'
+
+        def cutpoint(v):
+            return f"cutpoint {v}\n"
+
+        def disable(v):
+            return f"select -del {v}\n"
+
+        def enable(v):
+            return f"select -add {v}\n"
+
+        def assume(v):
+            return f"chformal -assert2assume {v}\n"
+
+        def define(v):
+            defines = str()
+            for defn in v:
+                defines += f"select -set {v}\n"
+            return defines
+
+        def invoke(v):
+            return f"{v}\n"
+
+        for k, v in self.setup.items():
+            script += {
+                'cutpoint': cutpoint(v),
+                'disable': disable(v),
+                'enable': enable(v),
+                'assume': assume(v),
+                'define': define(v),
+                'invoke': invoke(v)
+            }.get(k, '')
+
+        script += 'select -set _setup %\n'
+        script += 'select @_setup %n\n'
+        script += 'chformal -assert -remove %\n'
+        script += 'write_ilang design_setup.il\n'
+        return script
+
 
 class SbyTaskloop:
     def __init__(self, jobclient=None):
@@ -600,7 +642,7 @@ def run(self):
             self.tasks = []
             for task in tasks:
                 task.check_timeout()
-                if task.procs_pending or task.procs_running:
+                if task.procs_pending or task.procs_running or task.stage_running:
                     self.tasks.append(task)
                 else:
                     task.exit_callback()
@@ -834,6 +876,9 @@ def __init__(self, sbyconfig, workdir, early_logs, reusedir, taskloop=None, logf
         self.taskloop = taskloop or SbyTaskloop()
         self.taskloop.tasks.append(self)
 
+        self.base_dependencies = []
+        self.stages_running = []
+
         self.procs_running = []
         self.procs_pending = []
 
@@ -978,9 +1023,14 @@ def make_model(self, model_name):
             os.makedirs(f"{self.workdir}/model")
 
         if model_name == "prep":
+            has_setup = len(self.setup) > 0
+
             with open(f"""{self.workdir}/model/design_prep.ys""", "w") as f:
                 print(f"# running in {self.workdir}/model/", file=f)
-                print(f"""read_ilang design.il""", file=f)
+                if has_setup:
+                    print(f"""read_ilang design_setup.il""", file=f)
+                else:
+                    print(f"""read_ilang design.il""", file=f)
                 print("scc -select; simplemap; select -clear", file=f)
                 print("memory_nordff", file=f)
                 if self.opt_multiclock:
@@ -1008,7 +1058,7 @@ def make_model(self, model_name):
             proc = SbyProc(
                 self,
                 model_name,
-                self.model("base"),
+                self.model("setup" if has_setup else "base"),
                 "cd {}/model; {} -ql design_{s}.log design_{s}.ys".format(self.workdir, self.exe_paths["yosys"], s=model_name)
             )
             proc.checkretcode = True
@@ -1028,7 +1078,7 @@ def make_model(self, model_name):
             proc = SbyProc(
                 self,
                 model_name,
-                [],
+                self.base_dependencies,
                 "cd {}/src; {} -ql ../model/design.log ../model/design.ys".format(self.workdir, self.exe_paths["yosys"])
             )
             proc.checkretcode = True
@@ -1158,6 +1208,19 @@ def instance_hierarchy_error_callback(retcode):
 
             return [proc]
 
+        if model_name == "setup":
+            with open(f"{self.workdir}/model/design_setup.ys", "w") as f:
+                f.write(self.gen_setup_script())
+
+            proc = SbyProc(
+                self,
+                "setup",
+                self.model("base"),
+                f"""cd {self.workdir}/model; {self.exe_paths["yosys"]} -ql design_setup.log design_setup.ys"""
+            )
+
+            return [proc]
+
         self.error(f"Invalid model name: {model_name}")
 
     def model(self, model_name):
@@ -1269,6 +1332,23 @@ def setup_procs(self, setupmode):
             self.retcode = 0
             return
 
+        # Check to see if we have stages to implement
+        if len(self.stage.keys()) > 0:
+            for stage_name, data in self.stage.items():
+                self.setup_stage(
+                    setupmode, config = list(
+                        map(
+                            lambda l: l.strip(),
+                            f'''\
+                            [options]
+                            mode {data['mode']}
+                            '''.splitlines()
+                        )
+                    ),
+                    name = stage_name, depends = self.model('base')
+                )
+
+
         if self.opt_make_model is not None:
             for name in self.opt_make_model.split(","):
                 self.model(name.strip())
@@ -1299,6 +1379,12 @@ def setup_procs(self, setupmode):
             if opt not in self.used_options:
                 self.error(f"Unused option: {opt}")
 
+    def setup_stage(self, setupmode, config, name, depends):
+        stage = SbyStage(config, self, name)
+        stage.base_dependencies.extend(depends)
+        self.stages_running.append(stage)
+        stage.setup_procs(setupmode)
+
     def summarize(self):
         total_clock_time = int(monotonic() - self.start_clock_time)
 
@@ -1432,3 +1518,23 @@ def print_junit_result(self, f, junit_ts_name, junit_tc_name, junit_format_stric
         print('</system-err>', file=f)
         print(f'</testsuite>', file=f)
         print(f'</testsuites>', file=f)
+
+class SbyStage(SbyTask):
+    def __init__(self, sbyconfig, main_task, name):
+        self.main_task = main_task
+        self.name = name
+        workdir = f'{main_task.workdir}/stage_{name}'
+        os.mkdir(workdir)
+
+        super().__init__(
+            sbyconfig, workdir,
+            early_logs = [], reusedir = False,
+            taskloop = main_task.taskloop, logfile = main_task.logfile
+        )
+
+        self.exit_callback = self.handle_stage_exit
+
+    def handle_stage_exit(self):
+        self.main_task.stages_running.remove(self)
+
+        # TODO pass the status back to the main task