opencos-eda 0.3.6__py3-none-any.whl → 0.3.8__py3-none-any.whl

opencos/commands/flist.py

@@ -48,7 +48,7 @@ class CommandFList(CommandDesign):
             'bracket-quote-path' : False,
             'single-quote-path'  : False,
             'double-quote-path'  : False,
-            'no-quote-path'      : False,
+            'quote-path'         : True,
             'build-script'       : "", # we don't want this to error either
 
             'print-to-stdout': False,
@@ -122,7 +122,7 @@ class CommandFList(CommandDesign):
 
         pq1 = ""
         pq2 = "" # pq = path quote
-        if self.args['no-quote-path']:
+        if not self.args['quote-path']:
             pass # if we decide to make one of the below default, this will override
         elif self.args['bracket-quote-path']:
             pq1 = "{"

opencos/commands/multi.py

@@ -28,7 +28,7 @@ class CommandMulti(CommandParallel):
             'fake': False,
             'parallel': 1,
             'single-timeout': None,
-            'fail-if-no-targets': False,
+            'fail-if-no-targets': True,
             'export-jsonl': False,
             'print-targets': False,
         }
@@ -325,8 +325,9 @@ class CommandMulti(CommandParallel):
             current_targets = len(self.targets)
         util.info(f"Multi: Expanded {target_globs} to {len(self.targets)} {command} targets")
 
-        if parsed.fail_if_no_targets and len(self.targets) == 0:
-            self.error(f'Multi: --fail-if-no-targets set, and {self.targets=}')
+        if self.args['fail-if-no-targets'] and not self.targets:
+            self.error(f'Multi: --fail-if-no-targets set, and {self.targets=}. Disable with',
+                       '--no-fail-if-no-targets, or see: eda multi --help')
         if not all_multi_tools:
             possible_tools = self.all_handler_commands.get(command, [])
             self.error(f'Multi: no tools to run for {command=}, available tools: {possible_tools}')

opencos/commands/sim.py

@@ -44,7 +44,7 @@ def parameters_dict_get_command_list(params: dict, arg_prefix: str = '-G') -> li
     return ret_list
 
 
-class CommandSim(CommandDesign):
+class CommandSim(CommandDesign): # pylint: disable=too-many-public-methods
     '''Base class command handler for: eda sim ...'''
 
     CHECK_REQUIRES = [Tool] # Used by check_command_handler_cls()
@@ -59,11 +59,11 @@ class CommandSim(CommandDesign):
         self.args.update({
             "pre-sim-tcl": [],
             'compile-args': [],
+            'compile-waivers': [],
             'elab-args': [],
             'sim-args': [],
             'sim-plusargs': [], # lists are handled by 'set_arg(k,v)' so they append.
             'sim-library': [],
-            'compile-waivers': [],
             'sim-waivers': [],
             'coverage': False,
             'waves': False,
@@ -72,24 +72,39 @@ class CommandSim(CommandDesign):
             'optimize': False,
             'log-bad-strings': ['ERROR: ', 'FATAL: ', 'Error: ', 'Fatal: '],
             'log-must-strings': [],
+            'log-warning-strings': ['WARNING: ', 'Warning: '],
+            'uvm': False,
+            'uvm-version': '1.2',
             # verilate-args: list of args you can only pass to Verilator,
             # not used by other simulators, so these can go in DEPS files for custom things
             # like -CFLAGS -O0, etc.
             'verilate-args': [],
         })
         self.args_help.update({
+            'pre-sim-tcl': (
+                'Tool dependent, TCL file to run prior to simulation (if tool supports TCL)'
+            ),
             'compile-args': 'args added to sim/elab "compile" step',
+            'compile-waivers': (
+                'simulation tool depenent waivers by name, applied at compilation step'
+            ),
             'coverage': 'attempt to run coverage steps on the compile/elab/simulation',
             'elab-args':    'args added to sim/elab "elaboration" step, if required by tool',
             'log-bad-strings': 'strings that if present in the log will fail the simulation',
             'log-must-strings': ('strings that are required by the log to not-fail the simulation.'
                                  ' Some tools use these at only certain phases'
                                  ' (compile/elab/sim).'),
+            'log-warning-strings': ('strings that if present will be counted in the total tool'
+                                    ' warnings at end of simulation'),
             'pass-pattern': ('Additional string required to pass a simulation, appends to'
                              ' log-must-strings'),
             'sim-args':      'args added to final "simulation" step',
             'sim-plusargs':  ('"simulation" step run-time args passed to tool, these can also'
                               ' be set using --sim-plusargs=name[=value], or simply +name[=value]'),
+            'sim-library': 'named libraries added to simulation, tool dependent',
+            'sim-waivers': (
+                'simulation tool depenent waivers by name, applied at "simulation" step'
+            ),
             'stop-before-compile': ('Create work-dir sh scripts for compile/elab/simulate, but do'
                                     ' not run them.'),
             'stop-after-compile': 'Create work-dir sh scripts, but only run the compile step.',
@@ -97,17 +112,26 @@ class CommandSim(CommandDesign):
                                      ' simulation step.'),
             'top': 'Name of topmost Verilog/SystemVerilog module, or VHDL entity',
             'verilate-args': ('args added to "compile" step in Verilator simulation'
-                              ' (for --tool=verilator)'),
+                              ' (for --tool=verilator) these are identical to --compile-args'),
             'waves': 'Include waveforms, if possible for tool',
             'waves-start': 'Starting time of waveform capture, if possible for tool',
-            'work-dir': 'Optional override for working directory, defaults to ./eda.work/<top>.sim',
             'test-mode': ('stops the command early without executing, if --gui is present will'
-                          ' instead test without spawning gui')
+                          ' instead test without spawning gui'),
+            'uvm': (
+                'Attempts to support UVM (aka 1.2 if --uvm-version=1.2) for the'
+                ' the simulation tool. May add libraries for uvm, tool dependent.'
+            ),
+            'uvm-version': (
+                'Used if --uvm is set, for example --uvm-version=1.2'
+            ),
+
+        })
 
+        self.args_kwargs.update({
+            'uvm-version': { 'choices': ['1.2'] },
         })
 
 
-        self.args['verilate-args'] = []
 
     def process_parameters_get_list(self, arg_prefix: str = '-G') -> list:
         '''Returns list (suitable command list for shell or for tool) from self.parameters'''
@@ -173,14 +197,14 @@ class CommandSim(CommandDesign):
 
         # Collect (overwrite CommandSim) the bad and must strings, if present,
         # from our config.tools.verilator:
-        for tool_config_key in ['log-bad-strings', 'log-must-strings']:
+        for tool_config_key in ('log-bad-strings', 'log-must-strings', 'log-warning-strings'):
             if len(self.tool_config.get(tool_config_key, [])) > 0:
                 self.args[tool_config_key] = self.tool_config.get(tool_config_key, [])
 
 
     # Methods that derived classes may override:
 
-    def run_commands_check_logs( # pylint: disable=dangerous-default-value
+    def run_commands_check_logs( # pylint: disable=dangerous-default-value,too-many-locals
             self, commands: list , check_logs: bool = True, log_filename=None,
             bad_strings: list = [],
             must_strings: list = [],
@@ -188,7 +212,10 @@ class CommandSim(CommandDesign):
     ) -> None:
         '''Returns None, runs all commands (each element is a list) and checks logs
 
-        for bad-strings and must-strings (args or class member vars)
+        for bad-strings and must-strings (args or class member vars).
+
+        Will add any bad_strings or tool log-warning-strings to self, so tool
+        related warning/error counts can be reported later.
         '''
 
         for obj in commands:
@@ -203,7 +230,7 @@ class CommandSim(CommandDesign):
             if not work_dir:
                 work_dir = self.args['work-dir']
 
-            util.debug(f'run_commands_check_logs: {clist=}, {tee_fpath=}')
+            util.debug(f'run_commands_check_logs: {clist=}, {tee_fpath=}, {log_filename=}')
 
             log_fname = None
             if tee_fpath:
@@ -211,11 +238,18 @@ class CommandSim(CommandDesign):
             if log_filename:
                 log_fname = log_filename
 
-
-            _, stdout, _ = self.exec(
-                work_dir=work_dir, command_list=clist, tee_fpath=tee_fpath
+            # track the retcode because we run stop_on_error=False (to count warnings/errors)
+            _, stdout, retcode = self.exec(
+                work_dir=work_dir, command_list=clist, tee_fpath=tee_fpath,
+                stop_on_error=False,
             )
 
+            if check_logs and not log_fname and bad_strings:
+                util.warning(
+                    f'{self.get_info_job_name()}: check_logs=True but no log file set',
+                    f'(run --debug for more info), for command: {" ".join(clist)}'
+                )
+
             if check_logs and log_fname:
                 # Note this call will check on stdout if not GUI, not opening the log_fname,
                 # but if this is GUI we normally lose stdout and have to open the log.
@@ -225,6 +259,7 @@ class CommandSim(CommandDesign):
                     file_contents_str = stdout
 
                 self.check_logs_for_errors(
+                    sim_retcode=retcode,
                     filename=os.path.join(work_dir, log_fname),
                     file_contents_str=file_contents_str,
                     bad_strings=bad_strings, must_strings=must_strings,
@@ -235,6 +270,10 @@ class CommandSim(CommandDesign):
                     name=os.path.join(work_dir, log_fname),
                     typ='text', description='Simulator stdout/stderr log file'
                 )
+            if retcode:
+                self.error(
+                    f"{self.get_info_job_name()}: exec returned with error code: {retcode}"
+                )
 
     def do_export(self) -> None:
         '''CommandSim helper for handling args --export*
@@ -328,9 +367,13 @@ class CommandSim(CommandDesign):
         '''
         return
 
+
     def check_logs_for_errors( # pylint: disable=dangerous-default-value,too-many-locals,too-many-branches
-            self, filename: str = '', file_contents_str: str = '',
+            self,
+            sim_retcode: int = 0,
+            filename: str = '', file_contents_str: str = '',
             bad_strings: list = [], must_strings: list = [],
+            warning_strings: list = [],
             use_bad_strings: bool = True, use_must_strings: bool = True
     ) -> None:
         '''Returns None, checks logs using args bad_strings, must_strings,
@@ -349,6 +392,8 @@ class CommandSim(CommandDesign):
         if use_must_strings:
             _must_strings = must_strings + self.args.get('log-must-strings', [])
 
+        _warning_strings = warning_strings + self.args.get('log-warning-strings', [])
+
         if self.args['pass-pattern'] != "":
             _must_strings.append(self.args['pass-pattern'])
 
@@ -380,6 +425,20 @@ class CommandSim(CommandDesign):
             self.error(f'sim.check_logs_for_errors: {log_fpath=} does not exist, and no',
                        'file_contents_str exists to check')
 
+        self.update_tool_warn_err_counts_from_log_lines(
+            log_lines=lines, bad_strings=_bad_strings, warning_strings=_warning_strings
+        )
+
+        if isinstance(self, Tool):
+            self.report_tool_warn_error_counts()
+
+        if sim_retcode > 0:
+            # We have to update artifacts first, have the caller set the error.
+            # Skip the checking for bad strings or must strings, because we've already
+            # failed, but we did the important counting of Error and Warning lines above,
+            # and reported it.
+            return
+
         if lines:
             for lineno, line in enumerate(lines):
                 if any(must_str in line for must_str in _must_strings):

opencos/eda.py

@@ -20,8 +20,8 @@ from pathlib import Path
 
 import opencos
 from opencos import util, eda_config, eda_base
-from opencos.util import safe_emoji
-from opencos.eda_base import Tool, which_tool, get_eda_exec
+from opencos.util import safe_emoji, Colors
+from opencos.eda_base import Tool, which_tool, get_eda_exec, print_eda_usage_line
 from opencos.utils import vsim_helper, vscode_helper
 from opencos.utils.subprocess_helpers import subprocess_run_background
 from opencos.utils import status_constants, str_helpers, subprocess_helpers
@@ -76,7 +76,7 @@ def get_all_commands_help_str(config: dict) -> str:
         all_commands_help.append(f'    {key:<{max_command_str_len}} - {value.strip()}')
     if all_commands_help:
         all_commands_help = [
-            'Where <command> is one of:',
+            f'Where {Colors.byellow}COMMAND{Colors.normal} is one of:',
             '',
         ] + all_commands_help
     return '\n'.join(all_commands_help)
@@ -95,22 +95,24 @@ def usage(tokens: list, config: dict, command: str = "", tool: str = "") -> int:
     '''
 
     if command == "":
-        print(
-f"""
-{safe_emoji("🔦 ")}Usage:
-    eda [<options>] <command> [options] <files|targets, ...>
-"""
-        )
+        util.info('Help:', color=Colors.cyan)
+        print()
+        print_eda_usage_line()
         print(get_all_commands_help_str(config=config))
-        print(
-f"""
-{safe_emoji("❕ ")}where <files|targets, ...> is one or more source file or DEPS markup file target,
-    such as .v, .sv, .vhd[l], .cpp files, or a target key in a DEPS.[yml|yaml|toml|json].
-    Note that you can prefix source files with `sv@`, `v@`, `vhdl@` or `cpp@` to
-    force use that file as systemverilog, verilog, vhdl, or C++, respectively.
-
-"""
-        )
+        print()
+        print(str_helpers.indent_wrap_long_text(
+            (
+                f'{safe_emoji("❕ ")}where {Colors.byellow}FILES|TARGETS{Colors.normal}'
+                ' is one or more source file or DEPS markup file target,'
+                ' such as .v, .sv, .vhd[l], .cpp files, or a target key in a'
+                f' {Colors.byellow}DEPS.[yml|yaml|toml|json]{Colors.normal}. Note that you can'
+                f' prefix source files with {Colors.bcyan}sv@{Colors.normal},'
+                f' {Colors.bcyan}v@{Colors.normal}, {Colors.bcyan}vhdl@{Colors.normal},'
+                f' or {Colors.bcyan}cpp@{Colors.normal}'
+                ' to force use that file as systemverilog, verilog, vhdl, or C++, respectively.'
+            ), width=str_helpers.get_terminal_columns(), indent=4
+        ))
+        print()
         eda_base.print_base_help()
         return 0
 
@@ -527,7 +529,7 @@ def main(*args):
         sys.exit(0)
 
     if not util.args['quiet']:
-        util.info(f'eda: version {opencos.__version__}')
+        util.info(f'eda: version {opencos.__version__}', color=Colors.bcyan)
         # And show the command that was run (all args):
         util.info(f"main: eda {' '.join(args)}; (run from {os.getcwd()})")
 
@@ -537,7 +539,7 @@ def main(*args):
     # Note - we used to call: config = init_config(config=config)
     # However, we now defer calling init_config(..) until eda.process_tokens(..)
 
-    util.info("*** OpenCOS EDA ***")
+    util.info("*** OpenCOS EDA ***", color=Colors.bcyan)
 
     if len(args) == 0 or (len(args) == 1 and '--debug' in args):
         # special snowflake case if someone called with a singular arg --debug