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

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()
@@ -72,6 +72,9 @@ 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.
@@ -91,6 +94,8 @@ class CommandSim(CommandDesign):
             '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',
@@ -111,12 +116,22 @@ class CommandSim(CommandDesign):
             'waves': 'Include waveforms, if possible for tool',
             'waves-start': 'Starting time of waveform capture, if possible for tool',
             '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'''
@@ -182,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 = [],
@@ -197,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:
@@ -212,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:
@@ -220,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.
@@ -234,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,
@@ -244,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*
@@ -337,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,
@@ -358,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'])
 
@@ -389,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_base.py

@@ -178,6 +178,10 @@ class Tool:
         # a Command object's self.args instead of the class Tool.args. Safely create it
         # if it doesn't exist:
         self._VERSION = None
+
+        self.tool_warning_count = 0
+        self.tool_error_count = 0
+
         if getattr(self, 'args', None) is None:
             self.args = {}
         if getattr(self, 'args_help', None) is None:
@@ -225,12 +229,30 @@ class Tool:
         '''Sets and returns self._VERSION'''
         return self._VERSION
 
+    def report_tool_warn_error_counts(self) -> None:
+        '''Reports info line based on self.tool_error_count and self.tool_warning_count.'''
+        tool_name = get_class_tool_name(self)
+        if not tool_name:
+            return
+
+        info_color = Colors.green
+        start = ''
+        if self.tool_error_count or self.tool_warning_count:
+            start = safe_emoji('🔶 ')
+            info_color = Colors.yellow
+        util.info(
+            f"{start}Tool - {tool_name}, total counts:",
+            f"{Colors.bold}{self.tool_warning_count} tool warnings{Colors.normal}{info_color},",
+            f"{Colors.bold}{self.tool_error_count} tool errors",
+            color=info_color
+        )
+
     def set_tool_defines(self) -> None:
         '''Derived classes may override, sets any additional defines based on tool.'''
         return
 
 
-class Command: # pylint: disable=too-many-public-methods
+class Command: # pylint: disable=too-many-public-methods,too-many-instance-attributes
     '''Base class for all: eda COMMAND
 
     The Command class should be used when you don't require files, otherwise consider
@@ -244,6 +266,8 @@ class Command: # pylint: disable=too-many-public-methods
             self.args = {}
         if getattr(self, 'args_help', None) is None:
             self.args_help = {}
+        if getattr(self, 'args_kwargs', None) is None:
+            self.args_kwargs = {}
         self.args.update({
             "keep" : False,
             "force" : False,
@@ -332,6 +356,13 @@ class Command: # pylint: disable=too-many-public-methods
         self.tool_changed_respawn = {}
 
 
+    def get_info_job_name(self) -> str:
+        '''Returns an informational string of the job name, using: command - tool - top'''
+        return ' - '.join(
+            x for x in (self.command_name, self.args.get('tool', ''),
+                        self.args.get('top', '')) if x
+        )
+
     def error(self, *args, **kwargs) -> None:
         '''Returns None, child classes can call self.error(..) instead of util.error,
 
@@ -359,7 +390,6 @@ class Command: # pylint: disable=too-many-public-methods
                     f'ERROR: [eda] ({self.command_name}) {" ".join(list(args))}',
                     file=self.errors_log_f
                 )
-
         self.status = util.error(*args, **kwargs) # error_code passed and returned via kwargs
 
     def stop_process_tokens_before_do_it(self) -> bool:
@@ -374,24 +404,28 @@ class Command: # pylint: disable=too-many-public-methods
             return True
         return False
 
-    def status_any_error(self, report=True) -> bool:
+    def status_any_error(self, report: bool = True) -> bool:
         '''Used by derived classes process_tokens() to know an error was reached
-        and to not perform the command. Necessary for pytests that use eda.main()'''
-        if report and self.status > 0:
+        and to not perform the command. Necessary for pytests that use eda.main()
+
+        Note we also check any parent Tool class for tool_error_count > 0
+        '''
+        any_err = False
+        if self.status > 0:
+            any_err = True
+        elif isinstance(self, Tool) and getattr(self, 'tool_error_count', 0):
+            util.warning(f'eda_base.py internal: Command status={self.status}, but',
+                         f'Tool tool_error_count={getattr(self, "tool_error_count", 0)}')
+            any_err = True
+        if report and any_err:
             util.error(f"command '{self.command_name}' has previous errors")
-        return self.status > 0
+        return any_err
 
     def report_pass_fail(self) -> None:
         '''Reports an INFO line with pass/fail information'''
-        job_name = ' - '.join(
-            x for x in (self.command_name, self.args.get('tool', ''),
-                        self.args.get('top', '')) if x
-        )
-        if self.status_any_error():
-            util.info(f'{safe_emoji("❌ ")}{job_name}: Errors observed.', color=Colors.red)
-        else:
-            util.info(f'{safe_emoji("✅ ")}{job_name}: No errors observed.')
-
+        job_name = self.get_info_job_name()
+        if not self.status_any_error():
+            util.info(f'{safe_emoji("✅ ")}{job_name}: {Colors.bold}No errors observed.')
 
     def which_tool(self, command:str) -> str:
         '''Returns a str for the tool name used for the requested command'''
@@ -557,16 +591,17 @@ class Command: # pylint: disable=too-many-public-methods
         if return_code > 0:
             if return_code == 1:
                 self.status = status_constants.EDA_EXEC_NONZERO_RETURN_CODE1
-            if return_code == 255:
+            elif return_code == 255:
                 self.status = status_constants.EDA_EXEC_NONZERO_RETURN_CODE255
             else:
                 self.status = status_constants.EDA_EXEC_NONZERO_RETURN_CODE2
+
             if stop_on_error:
                 self.error(f"exec: returned with error (return code: {return_code})",
                            error_code=self.status)
             else:
-                util.debug(f"{safe_emoji('❌ ')}exec: returned with error (return code:",
-                           f"{return_code})")
+                util.info(f"{safe_emoji('❌ ')}exec: returned with error (return code:",
+                          f"{return_code})")
         else:
             util.debug(f"exec: returned without error (return code: {return_code})")
         return stderr, stdout, return_code
@@ -680,6 +715,10 @@ class Command: # pylint: disable=too-many-public-methods
                 help_kwargs = {'help': f'{type(value).__name__} default={value}'}
             help_kwargs['help'] = help_kwargs['help'].replace('%', '%%')
 
+            # Update with any self.args_kwargs for this key
+            if self.args_kwargs.get(key, {}):
+                help_kwargs.update(self.args_kwargs.get(key, {}))
+
 
             # It's important to set the default=None on these, except for list types where default
             # is []. If the parsed Namespace has values set to None or [], we do not update. This
@@ -1040,6 +1079,26 @@ class Command: # pylint: disable=too-many-public-methods
             util.warning(*msg)
 
 
+    def update_tool_warn_err_counts_from_log_lines(
+            self, log_lines: list, bad_strings: list, warning_strings: list
+    ) -> None:
+        '''Given lines (list of str) from a log, update self.tool_[error|warning]_count values
+
+        Since Tool class is not always a parent in Command/CommandDesign/CommandSim, we
+        have to modfiy these member names safely for pylint.
+
+        Derived classes may override this, especially if the Tool is known and reports
+        the complete error/warning summary counts in a certain way.
+        '''
+        if not isinstance(self, Tool):
+            return
+        for line in log_lines:
+            if any(bad_str in line for bad_str in bad_strings):
+                setattr(self, 'tool_error_count', getattr(self, 'tool_error_count', 0) + 1)
+            if any(warn_str in line for warn_str in warning_strings):
+                setattr(self, 'tool_warning_count', getattr(self, 'tool_warning_count', 0) + 1)
+
+
 class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
     '''CommandDesign is the eda base class for command handlers that need to track files.
 

opencos/eda_config.py

@@ -57,6 +57,7 @@ class Defaults:
         'defines',
         'log-bad-strings',
         'log-must-strings',
+        'log-warning-strings',
         'sim-libraries',
         'compile-args',
         'compile-waves-args',

opencos/eda_config_defaults.yml

@@ -154,6 +154,8 @@ tools:
 
   verilator:
     defines: { }
+    log-warning-strings:
+      - "%Warning"
     log-bad-strings:
       - "%Error"
       - "%Fatal"
@@ -239,8 +241,11 @@ tools:
     defines:
       OC_TOOL_RIVIERA: 1
       RIVIERA: 1
+    log-warning-strings:
+      - "Warning: "
     log-bad-strings:
-      - "Error:"
+      - "Error: "
+      - "Fatal: "
     log-must-strings:
       - "VSIM: Simulation has finished"
     compile-args: |
@@ -261,8 +266,11 @@ tools:
     defines:
       OC_ASSERT_PROPERTY_NOT_SUPPORTED: 1
       OC_TOOL_MODELSIM_ASE: 1
+    log-warning-strings:
+      - "Warning: "
     log-bad-strings:
-      - "Error:"
+      - "Error: "
+      - "Fatal: "
     log-must-strings:
       - " vsim "
       - "Errors: 0"
@@ -286,8 +294,11 @@ tools:
   questa_fse:
     defines:
       OC_TOOL_QUESTA_FSE: 1
+    log-warning-strings:
+      - "Warning: "
     log-bad-strings:
-      - "Error:"
+      - "Error: "
+      - "Fatal: "
     log-must-strings:
       - " vsim "
       - "Errors: 0"
@@ -309,6 +320,9 @@ tools:
 
 
   iverilog:
+    log-warning-strings:
+      - "Warning:"
+      - "WARNING:"
     log-bad-strings:
       - "Error:"
       - "ERROR:"
@@ -328,6 +342,9 @@ tools:
   cocotb:
     defines:
       OC_TOOL_COCOTB: null
+    log-warning-strings:
+      - "Warning:"
+      - "WARNING:"
     log-bad-strings:
       - "ERROR"
       - "FAILED"
@@ -344,6 +361,14 @@ tools:
       OC_TOOL_QUARTUS: null
 
   vivado:
+    log-warning-strings:
+      - "WARNING: "
+      - "Warning: "
+    log-bad-strings:
+      - "FATAL: "
+      - "Fatal: "
+      - "ERROR: "
+      - "Error: "
     sim-libraries:
       - xil_defaultlib
       - unisims_ver

opencos/tests/test_tools.py

@@ -7,13 +7,12 @@ import shutil
 import sys
 import pytest
 
-from opencos import eda, eda_base
-
+from opencos import eda_base
 from opencos.tools.verilator import ToolVerilator
 from opencos.tools.vivado import ToolVivado
 from opencos.tools.cocotb import ToolCocotb
 from opencos.tests import helpers
-from opencos.tests.helpers import eda_wrap, eda_wrap_is_sim_fail, config, tools_loaded
+from opencos.tests.helpers import Helpers, eda_wrap, eda_wrap_is_sim_fail, config, tools_loaded
 from opencos.utils.markup_helpers import yaml_safe_load
 from opencos.utils import status_constants
 
@@ -24,6 +23,10 @@ def chdir_remove_work_dir(relpath):
     '''Changes dir to relpath, removes the work directories (eda.work, eda.export*)'''
     return helpers.chdir_remove_work_dir(THISPATH, relpath)
 
+def filter_tools(tools: list) -> list:
+    '''Given a list of tool l, filters to return a list of tools that are loaded'''
+    return [x for x in tools if x in tools_loaded]
+
 
 def test_tools_loaded():
     '''Does not directly call 'eda.main' instead create a few Tool
@@ -107,40 +110,60 @@ list_of_added_sim_args = [
     '--gui --test-mode',
 ]
 
+list_of_loaded_tools = filter_tools(list_of_tools)
+
 cannot_use_cocotb = 'cocotb' not in tools_loaded or \
     ('iverilog' not in tools_loaded and \
      'verilator' not in tools_loaded)
 CANNOT_USE_COCOTB_REASON = 'requires cocotb in tools_loaded, and one of (iverilog, verilator) too'
 
-@pytest.mark.parametrize("command", list_of_commands)
-@pytest.mark.parametrize("tool", list_of_tools)
-@pytest.mark.parametrize("target,sim_expect_pass", list_of_deps_targets)
-@pytest.mark.parametrize("added_sim_args_str", list_of_added_sim_args)
-def test_sim_elab_tools_pass_or_fail(command, tool, target, sim_expect_pass, added_sim_args_str):
-    '''tests that: eda <sim|elab> --tool <parameter-tool> <parameter-args> <parameter-target>
 
-    will correctly pass or fail depending on if it is supported or not.
+class TestSimElabTools(Helpers):
+    '''Tests for eda sim|elab for various tools with various args'''
 
-    Also tests for: non-gui, or --gui --test-mode (runs non-gui, but most python args will
-    be for --gui mode, signal logging, etc).
-    '''
-    if tool not in tools_loaded:
-        pytest.skip(f"{tool=} skipped, {tools_loaded=}")
-        return # skip/pass
-
-    added_args = []
-    if command == 'sim':
-        added_args = added_sim_args_str.split()
-
-    relative_dir = "deps_files/test_err_fatal"
-    os.chdir(os.path.join(THISPATH, relative_dir))
-    rc = eda.main(command, '--tool', tool, *(added_args), target)
-    print(f'{rc=}')
-    if command != 'sim' or sim_expect_pass:
-        # command='elab' should pass.
-        assert rc == 0
-    else:
-        assert eda_wrap_is_sim_fail(rc)
+    DEFAULT_DIR = os.path.join(THISPATH, 'deps_files', 'test_err_fatal')
+
+    @pytest.mark.parametrize("command", list_of_commands)
+    @pytest.mark.parametrize("tool", list_of_loaded_tools)
+    @pytest.mark.parametrize("target,sim_expect_pass", list_of_deps_targets)
+    @pytest.mark.parametrize("added_sim_args_str", list_of_added_sim_args)
+    def test_pass_or_fail(
+            self, command, tool, target, sim_expect_pass, added_sim_args_str
+    ):
+        '''tests that: eda <sim|elab> --tool <parameter-tool> <parameter-args> <parameter-target>
+
+        will correctly pass or fail depending on if it is supported or not.
+
+        Also tests for: non-gui, or --gui --test-mode (runs non-gui, but most python args will
+        be for --gui mode, signal logging, etc).
+        '''
+        added_args_str = ''
+        if command == 'sim':
+            added_args_str = added_sim_args_str
+
+        rc = self.log_it(f'{command} --tool {tool} {added_args_str} {target}')
+        print(f'{rc=}')
+        tool_error_count_lines = self.get_log_lines_with('tool errors')
+        if command != 'sim' or sim_expect_pass:
+            # command='elab' should pass.
+            assert rc == 0
+            assert tool_error_count_lines
+            assert all('tool warnings' in line for line in tool_error_count_lines)
+            assert all(' 0 tool errors' in line for line in tool_error_count_lines)
+
+        else:
+            assert eda_wrap_is_sim_fail(rc)
+            assert tool_error_count_lines
+            assert all('tool warnings' in line for line in tool_error_count_lines)
+            # May or may not have reported tool errors.
+            assert all('tool errors' in line for line in tool_error_count_lines)
+            # The final line of tool warnings/errors should have > 0 tool errors,
+            # since we were checking SV $error and $fatal
+            assert ' 0 tool errors' not in tool_error_count_lines[-1]
+            # The line should end with ' X tool errors'
+            parts = tool_error_count_lines[-1].split()
+            assert parts[-3].isdigit()
+            assert int(parts[-3]) in (1, 2, 3) # we should have at least 1, but some tools dup.
 
 
 @pytest.mark.skipif('vivado' not in tools_loaded, reason="requires vivado")

opencos/tools/iverilog.py

@@ -93,7 +93,7 @@ class CommandSimIverilog(CommandSim, ToolIverilog):
     def compile(self):
         if self.args['stop-before-compile']:
             return
-        self.run_commands_check_logs(self.iverilog_command_lists, check_logs=False)
+        self.run_commands_check_logs(self.iverilog_command_lists)
 
     def elaborate(self):
         pass
@@ -148,7 +148,7 @@ class CommandSimIverilog(CommandSim, ToolIverilog):
 
         command_list += list(self.files_sv) + list(self.files_v)
 
-        return [ util.ShellCommandList(command_list) ]
+        return [ util.ShellCommandList(command_list, tee_fpath='compile.log') ]
 
     def get_elaborate_command_lists(self, **kwargs) -> list:
         return []

opencos/tools/riviera.py

@@ -21,6 +21,7 @@ class ToolRiviera(ToolModelsimAse):
     _TOOL = 'riviera'
     _EXE = 'vsim'
     use_vopt = False
+    uvm_versions = set()
 
     def get_versions(self) -> str:
         if self._VERSION:
@@ -40,7 +41,17 @@ class ToolRiviera(ToolModelsimAse):
         )
         stdout = version_ret.stdout.decode('utf-8', errors='replace').rstrip()
 
-        # Expect:
+        # Get the UVM versions in the install directory. Note this may run
+        # more than once, so only do this if self.uvm_versions not yet set:
+        riviera_path, _ = os.path.split(self.sim_exe_base_path)
+        vlib_path = os.path.join(riviera_path, 'vlib')
+        if not self.uvm_versions and os.path.isdir(vlib_path):
+            for item in os.listdir(vlib_path):
+                # uvm-1.1, uvm-1.1d - so don't pick anything > 9 chars (uvm-M.mRr)
+                if item.startswith('uvm-') and '1800' not in item and len(item) <= 9:
+                    self.uvm_versions.add(item[4:])
+
+        # For Version, expect:
         #  Aldec, Inc. Riviera-PRO version 2025.04.139.9738 built for Linux64 on May 30, 2025
         left, right = stdout.split('version')
         if 'Riviera' not in left:
@@ -76,6 +87,18 @@ class CommandSimRiviera(CommandSimModelsimAse, ToolRiviera):
                 'bring your own .tcl file to run in Riviera (vsim) for coverage. The default'
                 ' tcl steps are (from tool config in --config-yml):   '
             ) + '; '.join(self.tool_config.get('simulate-coverage-tcl', [])),
+            'uvm': (
+                'Attempts to support UVM. Adds to vlog: -l uvm +incdir+PATH for the PATH to'
+                ' uvm_macros.svh for the installed version of Riviera used.'
+            ),
+        })
+
+        if self.uvm_versions:
+            # set default to latest version:
+            self.args['uvm-version'] = sorted(self.uvm_versions)[-1]
+
+        self.args_kwargs.update({
+            'uvm-version': { 'choices': list(self.uvm_versions) }
         })
 
     def set_tool_defines(self):
@@ -136,7 +159,9 @@ class CommandSimRiviera(CommandSimModelsimAse, ToolRiviera):
         return []
 
 
-    def write_vlog_dot_f(self, filename='vlog.f') -> None:
+    def write_vlog_dot_f( # pylint: disable=too-many-branches
+            self, filename: str = 'vlog.f'
+    ) -> None:
         '''Returns none, creates filename (str) for a vlog.f'''
         vlog_dot_f_lines = []
 
@@ -153,6 +178,12 @@ class CommandSimRiviera(CommandSimModelsimAse, ToolRiviera):
         vlog_dot_f_fname = filename
         vlog_dot_f_fpath = os.path.join(self.args['work-dir'], vlog_dot_f_fname)
 
+        if self.args['uvm']:
+            vlog_dot_f_lines.extend([
+                f'-uvmver {self.args["uvm-version"]}',
+                '-dbg'
+            ])
+
         for value in self.incdirs:
             vlog_dot_f_lines += [ f"+incdir+{value}" ]
 

opencos/tools/slang.py

@@ -176,6 +176,30 @@ class CommandElabSlang(CommandElab, ToolSlang):
     def get_post_simulate_command_lists(self, **kwargs) -> list:
         return []
 
+    def update_tool_warn_err_counts_from_log_lines(
+            self, log_lines: list, bad_strings: list, warning_strings: list
+    ) -> None:
+        '''
+        Overriden from Command, we ignore bad_strings/warning_strings and use a custom
+        checker.
+        '''
+        for line in log_lines:
+            if not line.startswith('Build failed: '):
+                continue
+            if not all(x in line for x in ('errors', 'warnings')):
+                continue
+
+            parts = line.strip().split()
+            if len(parts) < 6:
+                continue
+
+            errs = parts[2]
+            warns = parts[4]
+            if errs.isdigit():
+                self.tool_error_count += int(errs)
+            if warns.isdigit():
+                self.tool_warning_count += int(warns)
+
     def _get_slang_command_list_start(self) -> list:
         command_list = [self.slang_exe]
 

opencos/tools/surelog.py

@@ -147,6 +147,28 @@ class CommandElabSurelog(CommandElab, ToolSurelog):
             command_lists=self.surelog_command_lists, line_breaks=True
         )
 
+    def update_tool_warn_err_counts_from_log_lines(
+            self, log_lines: list, bad_strings: list, warning_strings: list
+    ) -> None:
+        '''
+        Overriden from Command, we ignore bad_strings/warning_strings and use a custom
+        checker.
+        '''
+        for line in log_lines:
+            line = line.strip()
+            if line.endswith(' 0'):
+                continue
+            if line.startswith('[  FATAL] : ') or \
+               line.startswith('[ SYNTAX] : ') or \
+               line.startswith('[  ERROR] : '):
+                parts = line.split()
+                if parts[-1].isdigit():
+                    self.tool_error_count += int(parts[-1])
+            if line.startswith('[WARNING] : '):
+                parts = line.split()
+                if parts[-1].isdigit():
+                    self.tool_warning_count += int(parts[-1])
+
 
 class CommandLintSurelog(CommandElabSurelog):
     '''CommandLintSurelog is a command handler for: eda lint --tool=surelog.'''

opencos/tools/verilator.py

@@ -82,7 +82,6 @@ class VerilatorSim(CommandSim, ToolVerilator):
             'lint-only': False,
             'cc-mode': False,
             'verilator-coverage-args': [],
-            'uvm': False,
             'x-assign': '',
             'x-initial': '',
         })
@@ -117,9 +116,9 @@ class VerilatorSim(CommandSim, ToolVerilator):
                          ' Also conditinally adds to verilated exe call:'
                          ' +verilator+rand+reset+[0,2] for arg values 0, unique|fast'),
             'uvm': (
-                'Warns on Verilator < 5.042, or missing $UVM_HOME environment var set (or in'
-                ' .env, $UVM_HOME/uvm_pkg.sv should exist), and will run verilator with args:'
-                ' -Wno-fatal +define+UVM_NO_DPI'
+                'Enables UVM. Warns on Verilator < 5.042, or missing $UVM_HOME environment'
+                ' var set (or in .env, $UVM_HOME/uvm_pkg.sv should exist), and will run verilator'
+                ' with args: -Wno-fatal +define+UVM_NO_DPI'
             ),
             'verilator-coverage-args': (
                 'Requires --coverage, args to be applied to verilator_coverage, which runs'
@@ -127,6 +126,12 @@ class VerilatorSim(CommandSim, ToolVerilator):
             ),
         })
 
+
+        self.args_kwargs.update({
+            'x-assign':    { 'choices': ['0', '1', 'unique', 'fast'] },
+            'x-initial':   { 'choices': ['0', 'unique', 'fast'] },
+        })
+
         self.verilate_command_lists = []
         self.lint_only_command_lists = []
         self.verilated_exec_command_lists = []
@@ -562,7 +567,8 @@ class VerilatorSim(CommandSim, ToolVerilator):
                              'version > v5.042')
 
             if not os.environ.get('UVM_HOME', ''):
-                util.warning('--uvm set, however env (or .env or --env-file) $UVM_HOME is not set')
+                util.warning('--uvm set, however env (or .env or --env-file)',
+                             '$UVM_HOME is not set')
 
         uvm_pkg_found = self._verilator_support_uvm_pkg_fpath(add_if_found=add_uvm_pkg_if_found)
         if warnings and not uvm_pkg_found:

opencos/tools/vivado.py

@@ -225,6 +225,8 @@ class CommandSimVivado(CommandSim, ToolVivado):
 
         if self.tool_config.get('elab-waves-args', ''):
             command_list += self.tool_config.get('elab-waves-args', '').split()
+        if self.args['uvm']:
+            command_list.extend(['-L', 'uvm'])
         elif self.args['gui'] and self.args['waves']:
             command_list += ['-debug', 'all']
         elif self.args['gui']:
@@ -305,6 +307,8 @@ class CommandSimVivado(CommandSim, ToolVivado):
                 command_list[0] += ".bat"
             if typ == 'sv':
                 command_list.append('-sv')
+                if self.args['uvm']:
+                    command_list.extend(['-L', 'uvm'])
             command_list += self.tool_config.get('compile-args', '').split()
             if util.args['verbose']:
                 command_list += ['-v', '2']

opencos/util.py

@@ -901,7 +901,8 @@ def exit( # pylint: disable=redefined-builtin
             elif args['warnings']:
                 info_color = Colors.yellow
             info(
-                f"{start}Exiting with {args['warnings']} warnings, {args['errors']} errors",
+                f"{start}Exiting with {Colors.bold}{args['warnings']} warnings{info_color},",
+                f"{Colors.bold}{args['errors']} errors",
                 color=info_color
             )
         sys.exit(error_code)

opencos/utils/str_helpers.py

@@ -132,11 +132,11 @@ def get_terminal_columns():
 
     Returns:
         int: The number of columns in the terminal, or a default value (e.g., 80)
-             if the terminal size cannot be determined.
+             if the terminal size cannot be determined. Min value of 40 is returned.
     """
     try:
         size = os.get_terminal_size()
-        return size.columns
+        return max(40, size.columns)
     except OSError:
         # Handle cases where the terminal size cannot be determined (e.g., not in a TTY)
         return 80  # Default to 80 columns
@@ -166,13 +166,13 @@ def pretty_list_columns_manual(data: list, num_columns: int = 4, auto_columns: b
         max_line_len = 0
         for x in max_lengths:
             max_line_len += x + _spacing
-        if max_line_len > window_cols:
+        if max_line_len >= window_cols:
             # subtract a column (already >= 2):
             ret_lines.extend(
                 pretty_list_columns_manual(data=data, num_columns=num_columns-1, auto_columns=True)
             )
             return ret_lines
-        if max_line_len + max_item_len + _spacing <= window_cols:
+        if max_line_len + max_item_len + _spacing < window_cols:
             # add 1 more column if we're guaranteed to have room.
             ret_lines.extend(
                 pretty_list_columns_manual(data=data, num_columns=num_columns+1, auto_columns=True)

{opencos_eda-0.3.7.dist-info → opencos_eda-0.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.7
+Version: 0.3.8
 Summary: A simple Python package for wrapping RTL simuliatons and synthesis
 Author-email: Simon Sabato <simon@cognichip.ai>, Drew Ranck <drew@cognichip.ai>
 Project-URL: Homepage, https://github.com/cognichip/opencos

{opencos_eda-0.3.7.dist-info → opencos_eda-0.3.8.dist-info}/RECORD

@@ -3,9 +3,9 @@ opencos/_version.py,sha256=KaWIjS0c08g-C0fgYY1kXwSPqhOFxaq5pYEeoZhOR_I,617
 opencos/_waves_pkg.sv,sha256=TL5YT9lT-fn2FD54MbVVZROmZ7vtW3ScA_rM2eRzKmU,2068
 opencos/deps_schema.py,sha256=fx1_IJhsDYkUciwwCPTXHP6ftFjTsPVjO4xg12twIjw,17384
 opencos/eda.py,sha256=tmDF1TZAa_i3CSWdc92GL1iYM86Fz1p_wdsfy88aPco,23933
-opencos/eda_base.py,sha256=wdjfm79q7jlXgbn1PTRe-4Ewe9h2itJRuZ7zsk_SdGQ,115259
-opencos/eda_config.py,sha256=cKAUKguoFEvFgvi2c36Osf6W767Y4KYjoagflqVhUSw,14168
-opencos/eda_config_defaults.yml,sha256=tbu7hyfPM0AetW0CTMu4J3umGMpHLn5bs5bkWDyFM3w,16260
+opencos/eda_base.py,sha256=J_al8-oQS5HCTJyiNSFVaNosESPctLWNpKG7FVGJXks,117815
+opencos/eda_config.py,sha256=d7gMx9ZJTcnUwVhqUkQtY4PI3UGD0ZvH8D_GXvc5Erc,14199
+opencos/eda_config_defaults.yml,sha256=BbBJqahrec5UmnnpsM9AaQVh3NM0wyGd5V5QKCMmNsA,16780
 opencos/eda_config_max_verilator_waivers.yml,sha256=lTAU4IOEbUWVlPzuer1YYhIyxpPINeA4EJqcRIT-Ymk,840
 opencos/eda_config_reduced.yml,sha256=cQ9jY4J7EvAbeHTiP6bvpDSVJAYiitjLZPSxxLKIEbk,1440
 opencos/eda_deps_bash_completion.bash,sha256=jMkQKY82HBgOnQeMdA1hMrXguRFtB52SMBxUemKovL4,1958
@@ -18,7 +18,7 @@ opencos/files.py,sha256=4fomXM5vyA5FUAImSeAjrPchQPysPSD07c_TLYg5cd8,1617
 opencos/names.py,sha256=Y2aJ5wgpbNIJ-_P5xUXnHMv_h-zMOX2Rt6iLuduqC1Q,1213
 opencos/peakrdl_cleanup.py,sha256=vHNGtalTrIVP335PhRjPt9RhoccgpK1HJAi-E4M8Kc8,736
 opencos/seed.py,sha256=IL9Yg-r9SLSRseMVWaEHmuw2_DNi_eyut11EafoNTsU,942
-opencos/util.py,sha256=7KR8cxjdLYoQIAMbEpbBHjYqMThbMWo1HKt33zfocn0,44395
+opencos/util.py,sha256=rJnXWOy_5vlb_qC1O5LmeOwJaJZrV46ZM9tYAcQKqAw,44453
 opencos/commands/__init__.py,sha256=oOOQmn5_jHAMSOfA3swJJ7mdoyHsJA0lJwKPTudlTns,1125
 opencos/commands/build.py,sha256=mvJYxk5J15k0Cr8R7oIdIIdsEtWV3gE-LnPweVwtSDo,1487
 opencos/commands/deps_help.py,sha256=WDrU7H9sypzDAxe_CHqhW5B_scbQMzBEdf-v-Jcfd5Q,10682
@@ -31,7 +31,7 @@ opencos/commands/multi.py,sha256=kC21JYJU5E-rP0v690YsgR2rV9WikoeUTwGC4gzYK3M,275
 opencos/commands/open.py,sha256=XckvKUNwvc5KHbYGV-eQ2i0WG4X-yckroDaMC610MB4,804
 opencos/commands/proj.py,sha256=cExW9ZZkw6nkpVyNfeQzJADzmPtbYgBgWml82tqO6jY,1158
 opencos/commands/shell.py,sha256=upHpFs8Gdtzi-boVXwsC-QzEsnvtoZNMAu4oN10kdxw,7801
-opencos/commands/sim.py,sha256=JkrlVHqzFAzAMCEjJ_fzRxDqbFt-DzWunzCUapUaJBw,21870
+opencos/commands/sim.py,sha256=a8fsf_Yw5igGiLhJGszlsKxTuQndfrFdStexmA4gwgE,24142
 opencos/commands/sweep.py,sha256=ni4XFgnFF8HLXtwPhETyLWfvc2kgtm4bcxFcKzUhkf0,9343
 opencos/commands/synth.py,sha256=m4ZwqHgOF5We0XP94F7TQli11WCPlkzhamI4fDfFR1o,4573
 opencos/commands/targets.py,sha256=_jRNhm2Fqj0fmMvTw6Ba39DCsRHf_r_uZCy_R064kpA,1472
@@ -55,7 +55,7 @@ opencos/tests/test_eda.py,sha256=n76XUSfaPNnTZeS8u5z6f9MHKPJIls4o-S4ftlGxuNg,377
 opencos/tests/test_eda_elab.py,sha256=AjU4WMYtFoHpNe1Z4yWWpxDKy4V_hAjL5rl3jqphZrk,3179
 opencos/tests/test_eda_synth.py,sha256=BtBrNVJ9C-LJt3K0wNNS5ukEVrET16AbRXl2IzxudJ8,5744
 opencos/tests/test_oc_cli.py,sha256=w-F-LjSSWVql3D2WG8tcV4_C52i-hL_2WT3oDpKQn9s,734
-opencos/tests/test_tools.py,sha256=6uGZQaR7znpfjOuhRiLTLY0XdDiGFSTruOEDphsZfDg,13749
+opencos/tests/test_tools.py,sha256=xzxlHSgqZNN9urxzNfQU4vjexmxRF6bsKvXijU35z78,15046
 opencos/tests/deps_files/command_order/DEPS.yml,sha256=jFce1gErT8XJpovYJj7t7X6Lu-Up_4yNRj9L8wOCAbI,1046
 opencos/tests/deps_files/error_msgs/DEPS.yml,sha256=fYvHouIscOlr8V28bqx9SoxRBpDBLX4AG-AkVXh8qbo,717
 opencos/tests/deps_files/iverilog_test/DEPS.yml,sha256=vDylEuLt642lhRSvOr3F5ziB5lhPSwkaUGN4_mWJw-c,40
@@ -68,30 +68,30 @@ opencos/tools/cocotb.py,sha256=bR97Mb87D0HPdoV82rLT7oszPLmdIPzYU1IEBaGnuXg,20544
 opencos/tools/invio.py,sha256=S2ChWr8xMZHSOOhX2hGKQhMmtQY2potVQjc-lsMg73o,3299
 opencos/tools/invio_helpers.py,sha256=86WOGmSf4m_lEqBtK3DLjWqI0jnqAWzBEBRYfBUGiSY,8804
 opencos/tools/invio_yosys.py,sha256=CszGeTdE1ilnMmWPLW77BrtobbsGb1CKXqot0hGimFU,5996
-opencos/tools/iverilog.py,sha256=3IQIZVDioChKEJIVVJki-q7NlvBg0k3n61oM7ltG9c8,6551
+opencos/tools/iverilog.py,sha256=PH_mvFU3LbMAPNskxMi1tD4DsMWRcsy27V_M0La9TNY,6558
 opencos/tools/modelsim_ase.py,sha256=Jt-6N3BZZyu25fT1ehFQLRUTVvrcCo4e2Gl7UtsQcuk,17834
 opencos/tools/quartus.py,sha256=_TfmPSYpbhmDLw7Dur-rRP0iGwv9hhQ6E5G-XLiYPEM,30486
 opencos/tools/questa.py,sha256=nHImM0Wydcf4YHGibHmQAwmqKHmMxKZUqY-E-vz1o8M,9827
 opencos/tools/questa_fse.py,sha256=hytkeuGg4qImj7rStV1i2kxkz9B0KFheGtcadxmpYAo,2550
-opencos/tools/riviera.py,sha256=_-vsN7TD6WdW4PVsSJaEhJls3RgXGRowhY_QV1hdFqE,13678
-opencos/tools/slang.py,sha256=S_vODMT5Zl5vi9FMGHfahp5B0oMNyDIRJXtRAldVCwY,8625
+opencos/tools/riviera.py,sha256=Llvd7jwOvy8rApqFOTnGpHSAhV3vFUsdjgMUuW4rsOE,15003
+opencos/tools/slang.py,sha256=nDB9eK_DNAgewsXP4Sc1wh_bQiOr5q3-3ccpTbdWr1Y,9423
 opencos/tools/slang_yosys.py,sha256=MKh13eAmLJDkynZiezyT8E2gI4CKnXipzgFCZppaMXo,10230
-opencos/tools/surelog.py,sha256=S2RAZJyjdISm_tRvAhXbla7_z_tJfotZih5f9Y3m7DQ,5648
+opencos/tools/surelog.py,sha256=uqUOpDq9Vs8Inj4m3nlMbag47LrJB4QHUIRes7dFbQY,6520
 opencos/tools/tabbycad_yosys.py,sha256=2LePPgYXBVdsy7YcffPIWN-I0B7queLQ_f_pme2SCGw,7803
-opencos/tools/verilator.py,sha256=mUNGZZB0P8NiF_zJW4wJHRQvwyiV_YwYNo3H_GYDFFc,24736
-opencos/tools/vivado.py,sha256=I9yVFK5wnFl1268l8WCk5Xh8wZBlSCODVTg4qStVF8c,41475
+opencos/tools/verilator.py,sha256=oIZpqiawohf21JZ_ib0NSAbVpVMYCwPswQ315Y6nU7g,24941
+opencos/tools/vivado.py,sha256=k_7sc9cv69BIkIxnbQKNFjLubS_O-p7HvTH_SkiZDMQ,41643
 opencos/tools/yosys.py,sha256=2h88u0NA_vqLgZG9I78gIy6nQuWxyT6mirDlyjTHn9w,28290
 opencos/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 opencos/utils/markup_helpers.py,sha256=A8Ev5UJ4EVKjdcF2g85SQbjdPZR4jGpNqCLaBy_4v7Q,4569
 opencos/utils/status_constants.py,sha256=na6YsqlsCwIYzTXWE14dPadUYRNTrOS6YTXHCer2NbA,635
-opencos/utils/str_helpers.py,sha256=-hR7MAQLOoY2lIfqtxNtnzb3apeJPkh8shEGFzkwQfs,6637
+opencos/utils/str_helpers.py,sha256=mCByhIyZLwDJuyeT70YShepgkkikY0pf7k6_xS93dGg,6675
 opencos/utils/subprocess_helpers.py,sha256=nmRUe5sPyXomzKEvEQU5231U_vilj8TuXNXLipwqLTM,6579
 opencos/utils/vscode_helper.py,sha256=9nHyMUIL-gzfW-qLH06sgaCnVK-YTOtu6pusitNNhL8,1363
 opencos/utils/vsim_helper.py,sha256=1johPOGbjbMgnCDSTpgsQcSuAquiqq1Y2MBxS6WY6b4,1552
-opencos_eda-0.3.7.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-opencos_eda-0.3.7.dist-info/licenses/LICENSE.spdx,sha256=8gn1610RMP6eFgT3Hm6q9VKXt0RvdTItL_oxMo72jII,189
-opencos_eda-0.3.7.dist-info/METADATA,sha256=BzLaVDTvMpHFvXBhH7S6ZQJhtfYDoUh_cvR8jGux0fI,1164
-opencos_eda-0.3.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-opencos_eda-0.3.7.dist-info/entry_points.txt,sha256=6n1T5NwVYDhN5l1h5zmyT197G4pE0SySDreB0QJzJR0,218
-opencos_eda-0.3.7.dist-info/top_level.txt,sha256=J4JDP-LpRyJqPNeh9bSjx6yrLz2Mk0h6un6YLmtqql4,8
-opencos_eda-0.3.7.dist-info/RECORD,,
+opencos_eda-0.3.8.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+opencos_eda-0.3.8.dist-info/licenses/LICENSE.spdx,sha256=8gn1610RMP6eFgT3Hm6q9VKXt0RvdTItL_oxMo72jII,189
+opencos_eda-0.3.8.dist-info/METADATA,sha256=d4yZ9dj5zoyO3Rf1nA7G5AOSHmJ6RXrd4vedVuEWQJI,1164
+opencos_eda-0.3.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+opencos_eda-0.3.8.dist-info/entry_points.txt,sha256=6n1T5NwVYDhN5l1h5zmyT197G4pE0SySDreB0QJzJR0,218
+opencos_eda-0.3.8.dist-info/top_level.txt,sha256=J4JDP-LpRyJqPNeh9bSjx6yrLz2Mk0h6un6YLmtqql4,8
+opencos_eda-0.3.8.dist-info/RECORD,,