opencos-eda 0.2.52__py3-none-any.whl → 0.2.54__py3-none-any.whl

opencos/tools/modelsim_ase.py

@@ -19,6 +19,7 @@ class ToolModelsimAse(ToolQuesta):
 
     _TOOL = 'modelsim_ase' # otherwise it's 'questa' from base class.
     _EXE = 'vsim'
+    use_vopt = False
 
 class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
     '''CommandSimModelsimAse is a command handler for: eda sim --tool=modelsim_ase'''
@@ -44,6 +45,15 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
             )
         )
 
+    def run_in_batch_mode(self) -> bool:
+        '''Returns bool if we should run in batch mode (-c) from command line'''
+        # TODO(drew): make CommandSimQuesta a parent and inherit this method instead.
+        if self.args['test-mode']:
+            return True
+        if self.args['gui']:
+            return False
+        return True
+
     # We do override do_it() to avoid using CommandSimQuesta.do_it()
     def do_it(self):
         CommandSim.do_it(self)
@@ -72,15 +82,12 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
             command_lists=vsim_command_lists
         )
 
+        # Write simulate.sh and all.sh to work-dir:
         vsim_command_lists = self.get_simulate_command_lists()
-        util.write_shell_command_file(
-            dirpath=self.args['work-dir'],
-            filename='all.sh',
-            command_lists = [['./pre_compile_dep_shell_commands.sh']] + vsim_command_lists
+        self.write_sh_scripts_to_work_dir(
+            compile_lists=[], elaborate_lists=[], simulate_lists=vsim_command_lists
         )
 
-        self.write_eda_config_and_args()
-
     def compile(self):
         if self.args['stop-before-compile']:
             # don't run anything, save everyting we've already run in _prep_compile()
@@ -111,7 +118,7 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
         # This will also set up a compile.
         vsim_command_list = [
             self.sim_exe,
-            '' if self.args['gui'] else '-c',
+            '-c' if self.run_in_batch_mode() else '',
             '-do', 'vsim_vlogonly.do', '-logfile', 'sim.log',
         ]
         return [vsim_command_list]
@@ -120,7 +127,7 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
         # This will also set up a compile, for vlog + vsim (0 time)
         vsim_command_list = [
             self.sim_exe,
-            '' if self.args['gui'] else '-c',
+            '-c' if self.run_in_batch_mode() else '',
             '-do', 'vsim_lintonly.do', '-logfile', 'sim.log',
         ]
         return [vsim_command_list]
@@ -129,7 +136,7 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
     # This will also set up a compile, for vlog + vsim (with run -a)
         vsim_command_list = [
             self.sim_exe,
-            '' if self.args['gui'] else '-c',
+            '-c' if self.run_in_batch_mode() else '',
             '-do', 'vsim.do', '-logfile', 'sim.log',
         ]
         return [vsim_command_list]
@@ -193,7 +200,9 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
         with open(vlog_dot_f_fpath, 'w', encoding='utf-8') as f:
             f.writelines(line + "\n" for line in vlog_dot_f_lines)
 
-    def write_vsim_dot_do(self, dot_do_to_write: list) -> None:
+    def write_vsim_dot_do( # pylint: disable=too-many-locals
+            self, dot_do_to_write: list
+    ) -> None:
         '''Writes files(s) based on dot_do_to_write(list of str)
 
         list arg values can be empty (all) or have items 'all', 'sim', 'lint', 'vlog'.'''
@@ -216,27 +225,28 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
         # TODO(drew): support self.args['sim_libary', 'elab-args', sim-args'] (3 lists)
         # to add to vsim_one_liner.
 
-        vsim_one_liner = "vsim -onfinish stop" \
-            + f" -sv_seed {self.args['seed']} {sim_plusargs_str} {vsim_suppress_list_str}" \
-            + f" {voptargs_str} work.{self.args['top']}"
+        vopt_one_liner = ""
+        if self.use_vopt:
+            vopt_one_liner = (
+                f"vopt {voptargs_str} work.{self.args['top']} -o opt__{self.args['top']}"
+            )
+            vopt_one_liner = vopt_one_liner.replace('\n', ' ') # needs to be a one-liner
+            # vopt doesn't need -voptargs=(value) like vsim does, simply use (value).
+            vopt_one_liner = vopt_one_liner.replace('-voptargs=', '')
 
-        vsim_one_liner = vsim_one_liner.replace('\n', ' ') # needs to be a one-liner
+            vsim_one_liner = "vsim -onfinish stop" \
+                + f" -sv_seed {self.args['seed']} {sim_plusargs_str} {vsim_suppress_list_str}" \
+                + f" opt__{self.args['top']}"
+        else:
+            # vopt doesn't exist, use single vsim call after vlog call:
+            vsim_one_liner = "vsim -onfinish stop" \
+                + f" -sv_seed {self.args['seed']} {sim_plusargs_str} {vsim_suppress_list_str}" \
+                + f" {voptargs_str} work.{self.args['top']}"
 
-        vsim_vlogonly_dot_do_lines = [
-            "if {[file exists work]} { vdel -all work; }",
-            "vlib work;",
-            "if {[catch {vlog -f vlog.f} result]} {",
-            "    echo \"Caught $result \";",
-            "    if {[batch_mode]} {",
-            "        quit -f -code 20;",
-            "    }",
-            "}",
-            "if {[batch_mode]} {",
-            "    quit -f -code 0;",
-            "}",
-        ]
 
-        vsim_lintonly_dot_do_lines = [
+        vsim_one_liner = vsim_one_liner.replace('\n', ' ')
+
+        vlog_do_lines = [
             "if {[file exists work]} { vdel -all work; }",
             "vlib work;",
             "quietly set qc 30;",
@@ -246,44 +256,35 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
             "        quit -f -code 20;",
             "    }",
             "}",
+        ]
+
+        vopt_do_lines = []
+        if self.use_vopt:
+            vopt_do_lines = [
+                "if {[catch { " + vopt_one_liner + " } result] } {",
+                "    echo \"Caught $result\";",
+                "    if {[batch_mode]} {",
+                "        quit -f -code 19;",
+                "    }",
+                "}",
+            ]
+
+        vsim_do_lines = [
             "if {[catch { " + vsim_one_liner + " } result] } {",
             "    echo \"Caught $result\";",
             "    if {[batch_mode]} {",
-            "        quit -f -code 19;",
+            "        quit -f -code 18;",
             "    }",
             "}",
-            "set TestStatus [coverage attribute -name SEED -name TESTSTATUS];",
-            "if {[regexp \"TESTSTATUS += 0\" $TestStatus]} {",
-            "    quietly set qc 0;",
-            "} elseif {[regexp \"TESTSTATUS += 1\" $TestStatus]} {",
-            "    quietly set qc 0;",
-            "} else {",
-            "    quietly set qc 2;",
-            "}",
+        ]
+
+        vsim_vlogonly_dot_do_lines = vlog_do_lines + [
             "if {[batch_mode]} {",
-            "    quit -f -code $qc;",
+            "    quit -f -code 0;",
             "}",
         ]
 
-        vsim_dot_do_lines = [
-            "if {[file exists work]} { vdel -all work; }",
-            "vlib work;",
-            "quietly set qc 30;",
-            "if {[catch {vlog -f vlog.f} result]} {",
-            "    echo \"Caught $result \";",
-            "    if {[batch_mode]} {",
-            "        quit -f -code 20;",
-            "    }",
-            "}",
-            "if {[catch { " + vsim_one_liner + " } result] } {",
-            "    echo \"Caught $result\";",
-            "    if {[batch_mode]} {",
-            "        quit -f -code 19;",
-            "    }",
-            "}",
-            "onbreak { resume; };",
-            "catch {log -r *};",
-            "run -a;",
+        final_check_teststatus_do_lines = [
             "set TestStatus [coverage attribute -name SEED -name TESTSTATUS];",
             "if {[regexp \"TESTSTATUS += 0\" $TestStatus]} {",
             "    quietly set qc 0;",
@@ -297,6 +298,18 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
             "}",
         ]
 
+        # final vlog/vopt/vsim lint-only .do command (want to make sure it can completely
+        # build for 'elab' style eda job), runs for 0ns, logs nothing for a waveform, quits
+        vsim_lintonly_dot_do_lines = vlog_do_lines + vopt_do_lines + vsim_do_lines \
+            + final_check_teststatus_do_lines
+
+        # final vlog/opt/vsim full simulation .do command.
+        vsim_dot_do_lines = vlog_do_lines + vopt_do_lines + vsim_do_lines + [
+            "onbreak { resume; };",
+            "catch {log -r *};",
+            "run -a;",
+        ] + final_check_teststatus_do_lines
+
         write_all = len(dot_do_to_write) == 0 or 'all' in dot_do_to_write
         if write_all or 'sim' in dot_do_to_write:
             with open(vsim_dot_do_fpath, 'w', encoding='utf-8') as f: