opencos-eda 0.3.2__tar.gz → 0.3.3__tar.gz

{opencos_eda-0.3.2/opencos_eda.egg-info → opencos_eda-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.2
+Version: 0.3.3
 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
@@ -17,4 +17,5 @@ Requires-Dist: toml>=0.10.2
 Requires-Dist: yamllint>=1.35.1
 Requires-Dist: PySerial>=3.5
 Requires-Dist: cocotb>=2.0
+Requires-Dist: supports_color>=0.2.0
 Dynamic: license-file

{opencos_eda-0.3.2 → opencos_eda-0.3.3}/opencos/eda_config_defaults.yml

@@ -145,6 +145,7 @@ tools:
       --timescale=1ns/1ns
       --allow-dup-initial-drivers
       -Wno-missing-top
+    compile-waivers: []
 
   verilator:
     defines: { }
@@ -153,11 +154,11 @@ tools:
       - "%Fatal"
     log-must-strings:
       - "R e p o r t: Verilator" # These come at end of compile or simulation, since we don't suppress it.
+    # Note: -j $(nproc) is handled in verilator.py, but you can override it in compile-args
     compile-args: |
       --timing
       --assert
       --autoflush
-      -j 2
       -sv
     compile-coverage-args: |
       --coverage

{opencos_eda-0.3.2 → opencos_eda-0.3.3}/opencos/tests/helpers.py

@@ -242,7 +242,9 @@ class Helpers:
 
         return rc
 
-    def is_in_log(self, *want_str, logfile=None, windows_path_support=False):
+    def is_in_log(
+            self, *want_str, logfile=None, windows_path_support: bool = False
+    ) -> bool:
         '''Check if want_str (joined) is in the logfile, or self.DEFAULT_LOG'''
         logfile = self._resolve_logfile(logfile)
         want_str0 = ' '.join(list(want_str))
@@ -254,7 +256,9 @@ class Helpers:
                     return True
         return False
 
-    def get_log_lines_with(self, *want_str, logfile=None, windows_path_support=False):
+    def get_log_lines_with(
+            self, *want_str, logfile=None, windows_path_support: bool = False
+    ) -> list:
         '''gets all log lines with any of want_str args are in the logfile, or self.DEFAULT_LOG'''
         logfile = self._resolve_logfile(logfile)
         ret_list = []
@@ -267,6 +271,21 @@ class Helpers:
                     ret_list.append(line)
         return ret_list
 
+    def get_log_lines_with_all(
+            self, *want_str, logfile=None, windows_path_support: bool = False
+    ) -> list:
+        '''gets all log lines with ALL of want_str args are in the logfile, or self.DEFAULT_LOG'''
+        logfile = self._resolve_logfile(logfile)
+        ret_list = []
+        with open(logfile, encoding='utf-8') as f:
+            for line in f.readlines():
+                if all(x in line for x in list(want_str)):
+                    ret_list.append(line)
+                elif windows_path_support and \
+                     all(x.replace('/', '\\') in line for x in list(want_str)):
+                    ret_list.append(line)
+        return ret_list
+
     def get_log_words_with(self, *want_str, logfile=None, windows_path_support=False):
         '''gets all log words with any of *want_str within a single word
         in the logfile or self.DEFAULT_LOG

{opencos_eda-0.3.2 → opencos_eda-0.3.3}/opencos/tools/slang.py

@@ -128,6 +128,7 @@ class CommandElabSlang(CommandElab, ToolSlang):
         command_list += self.tool_config.get('compile-args', '--single-unit').split()
         command_list += self.args['slang-args'] # add user args.
         command_list += self._get_slang_json_args(command_exe=command_list[0])
+        command_list += self._get_slang_tool_config_waivers()
 
         # incdirs
         for value in self.incdirs:
@@ -214,6 +215,11 @@ class CommandElabSlang(CommandElab, ToolSlang):
 
         return command_list
 
+    def _get_slang_tool_config_waivers(self) -> list:
+        # Add compile waivers from config and command-line args
+        return [f'-Wno-{waiver}' for waiver in
+                self.tool_config.get('compile-waivers', []) + self.args['compile-waivers']]
+
 
 class CommandLintSlang(CommandElabSlang):
     '''CommandLintSlang is a command handler for: eda lint --tool=slang.'''

{opencos_eda-0.3.2 → opencos_eda-0.3.3}/opencos/tools/verilator.py

@@ -5,10 +5,12 @@ Contains classes for ToolVerilator and VerilatorSim, VerilatorElab.
 
 # pylint: disable=R0801 # (calling functions with same arguments)
 
+import multiprocessing
 import os
 import shutil
 import subprocess
 
+
 from opencos import util
 from opencos.eda_base import Tool
 from opencos.commands import CommandSim
@@ -210,15 +212,9 @@ class VerilatorSim(CommandSim, ToolVerilator):
 
         verilate_command_list = self._get_start_verilator_command_list(lint_only=lint_only)
 
-        # Add compile args from our self.config (tools.verilator.compile-args str)
-        config_compile_args = self.tool_config.get(
-            'compile-args',
-            '--timing --assert --autoflush -sv').split()
-        verilate_command_list += config_compile_args
-
         verilate_command_list += self._get_verilator_tool_config_waivers()
 
-        verilate_command_list += self._verilator_args_deal_with_cflags()
+        verilate_command_list += self._verilator_args_defaults_cflags_nproc()
 
         verilate_command_list += self._get_verilator_waves_args(lint_only=lint_only)
 
@@ -425,45 +421,51 @@ class VerilatorSim(CommandSim, ToolVerilator):
         return ret
 
 
-    def _verilator_args_deal_with_cflags(self) -> list:
+    def _verilator_args_defaults_cflags_nproc(self) -> list:
         '''Returns list of args to be added to verilator (compile) step
 
-        Uses self.args['verilate-args'] and self.args['compile-args']
+        Uses self.args['verilate-args'], self.args['compile-args'], and self.tool_config
+
+        Sets -j <value> and -CFLAGS -O<value> if not present in --config-yml, --compile-args,
+        or --verilate-args. If present, chooses the first instance (does not present duplicates
+        to verilator call).
         '''
 
-        # We can only support one -CFLAGS followed by one -O[0-9] arg in self.args['verilate-args']:
-        verilate_cflags_args_dict = {}
-        verilate_args = [] # will be combined verilate_args + compile-args
-        prev_arg_is_cflags = False
+        # We can only support one -CFLAGS followed by one -O[0-9] arg in
+        # --verilate-args or --compile-args.
+
+        # Add compile args from our self.config (tools.verilator.compile-args str)
+        verilate_args = self.args['verilate-args'] + \
+            self.args['compile-args'] + \
+            self.tool_config.get(
+                'compile-args',
+                '--timing --assert --autoflush -sv').split()
+
         util.debug(f"{self.args['verilate-args']=}")
         util.debug(f"{self.args['compile-args']=}")
-        for arg in self.args['verilate-args'] + self.args['compile-args']:
-            # pick the first ones we see of these:
-            if arg == '-CFLAGS':
-                prev_arg_is_cflags = True
-                if arg not in verilate_cflags_args_dict:
-                    # We can only have 1
-                    verilate_cflags_args_dict[arg] = True
-                    verilate_args.append(arg)
-                else:
-                    util.debug(f'Previous saw -CFLAGS args {verilate_cflags_args_dict=},',
-                               f'skipping new {arg=}')
-
-            elif arg.startswith('-O') and len(arg) == 3:
-                if '-O' not in verilate_cflags_args_dict and prev_arg_is_cflags:
-                    # We can only have 1
-                    verilate_cflags_args_dict['-O'] = arg[-1]
-                    verilate_args.append(arg)
-                else:
-                    util.debug(f'Previous saw -CFLAGS args {verilate_cflags_args_dict=},',
-                               f'skipping new {arg=}')
-                prev_arg_is_cflags = False
-
-            else:
-                prev_arg_is_cflags = False
-                verilate_args.append(arg)
 
-        if '-CFLAGS' in verilate_args:
+        dash_j_arg_indices = []
+        cflags_dasho_args_indices = []
+        for i, arg in enumerate(list(verilate_args)):
+            # There can only be one of these: -j <value>, similarly can only be one of
+            # -CFLAGS -O<value>
+            if (i + 1) < len(verilate_args):
+                if arg == '-j':
+                    dash_j_arg_indices.extend([i, i + 1])
+                if arg == '-CFLAGS':
+                    next_arg = verilate_args[i + 1]
+                    if next_arg.startswith('-O') and len(next_arg) == 3:
+                        cflags_dasho_args_indices.extend([i, i + 1])
+
+        # For -j <value> we'll pick the first one, remove the rest.
+        # Same goes for -CFLAGS -O<value>
+        for index in dash_j_arg_indices[2:] + cflags_dasho_args_indices[2:]:
+            verilate_args[index] = ''
+
+        verilate_args = [x for x in verilate_args if x != ''] # strip empty str.
+
+        # Support for --optimize which will use -CFLAGS -O3, if -CFLAGS is not present at all.
+        if cflags_dasho_args_indices:
             # add whatever args were passed via 'compile-args' or 'verilate_args'. Note these will
             # take precedence over the --optimize arg.
             pass
@@ -472,8 +474,15 @@ class VerilatorSim(CommandSim, ToolVerilator):
             # (slower compile, better runtime)
             verilate_args += '-CFLAGS', '-O3'
         else:
+            # Default to -O1:
             verilate_args += '-CFLAGS', '-O1'
 
+        # If there was no -j setting, then use max(2, $(nproc) - 1)
+        if not dash_j_arg_indices:
+            nproc = max(2, multiprocessing.cpu_count() - 1)
+            verilate_args += '-j', f'{nproc}'
+
+
         return verilate_args
 
 

{opencos_eda-0.3.2 → opencos_eda-0.3.3}/opencos/util.py

@@ -18,6 +18,7 @@ from enum import Enum
 from pathlib import Path
 from importlib import import_module
 from dotenv import load_dotenv
+from supports_color import supportsColor
 
 from opencos.utils import status_constants
 
@@ -29,7 +30,7 @@ dot_f_files_expanded = set() # pylint: disable=invalid-name
 env_files_loaded = set()     # pylint: disable=invalid-name
 
 args = {                    # pylint: disable=invalid-name
-    'color' : False,
+    'color' : bool(supportsColor.stdout),
     'quiet' : False,
     'verbose' : False,
     'debug' : False,
@@ -351,13 +352,14 @@ def get_argparser() -> argparse.ArgumentParser:
     bool_action_kwargs = get_argparse_bool_action_kwargs()
 
     parser.add_argument('--version', default=False, action='store_true')
-    parser.add_argument('--color', **bool_action_kwargs, default=True,
+    parser.add_argument('--color', **bool_action_kwargs, default=bool(supportsColor.stdout),
                         help='Use shell colors for info/warning/error messaging')
-    parser.add_argument('--quiet', **bool_action_kwargs, help='Do not display info messaging')
-    parser.add_argument('--verbose', **bool_action_kwargs,
+    parser.add_argument('--quiet', **bool_action_kwargs, default=args['quiet'],
+                        help='Do not display info messaging')
+    parser.add_argument('--verbose', **bool_action_kwargs, default=args['verbose'],
                         help='Display additional messaging level 2 or higher')
-    parser.add_argument('--fancy', **bool_action_kwargs)
-    parser.add_argument('--debug', **bool_action_kwargs,
+    parser.add_argument('--fancy', **bool_action_kwargs, default=args['fancy'])
+    parser.add_argument('--debug', **bool_action_kwargs, default=args['debug'],
                         help='Display additional debug messaging level 1 or higher')
     parser.add_argument('--debug-level', type=int, default=0,
                         help='Set debug level messaging (default: 0)')

{opencos_eda-0.3.2 → opencos_eda-0.3.3/opencos_eda.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.2
+Version: 0.3.3
 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
@@ -17,4 +17,5 @@ Requires-Dist: toml>=0.10.2
 Requires-Dist: yamllint>=1.35.1
 Requires-Dist: PySerial>=3.5
 Requires-Dist: cocotb>=2.0
+Requires-Dist: supports_color>=0.2.0
 Dynamic: license-file

{opencos_eda-0.3.2 → opencos_eda-0.3.3}/opencos_eda.egg-info/requires.txt

@@ -8,3 +8,4 @@ toml>=0.10.2
 yamllint>=1.35.1
 PySerial>=3.5
 cocotb>=2.0
+supports_color>=0.2.0

{opencos_eda-0.3.2 → opencos_eda-0.3.3}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [project]
 name = "opencos-eda"
-version = "0.3.2"
+version = "0.3.3"
 dependencies = [
   # opencos/eda.py dependencies
   "mergedeep >= 1.3.4",
@@ -16,6 +16,7 @@ dependencies = [
   # opencos/oc_cli.py dependencies
   "PySerial >= 3.5",
   "cocotb >= 2.0",
+  "supports_color >= 0.2.0",
 ]
 requires-python = ">= 3.8"
 authors = [