opencos-eda 0.2.56__tar.gz → 0.2.57__tar.gz

{opencos_eda-0.2.56/opencos_eda.egg-info → opencos_eda-0.2.57}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.56
+Version: 0.2.57
 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.2.56 → opencos_eda-0.2.57}/opencos/commands/lec.py

@@ -27,6 +27,7 @@ class CommandLec(CommandDesign):
         self.args.update({
             'designs': [],
             'synth': True,
+            'flatten-all': True,
         })
         self.args_help.update({
             'designs': (
@@ -34,6 +35,9 @@ class CommandLec(CommandDesign):
                 ' use this arg twice'
             ),
             'synth': 'run synthesis on the two designs prior to running LEC',
+            'flatten-all': (
+                'arg passed to "synth" if run with --synth, to disable use --no-flatten-all'
+            ),
         })
 
         self.synth_design_verilog_fpaths = ['', '']

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/commands/multi.py

@@ -327,6 +327,10 @@ class CommandMulti(CommandParallel):
 
         if parsed.fail_if_no_targets and len(self.targets) == 0:
             self.error(f'Multi: --fail-if-no-targets set, and {self.targets=}')
+        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}')
+
         util.info("Multi: About to run: ", end="")
 
         def get_pretty_targets_tuple_as_list(l:list):

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/eda.py

@@ -49,6 +49,9 @@ def init_config(
 
     # For key DEFAULT_HANDLERS, we'll update config['command_handler'] with
     # the actual class using importlib (via opencos.util)
+
+    eda_config.tool_try_add_to_path(tool)
+
     config['command_handler'] = {}
     for _cmd, str_class in config['DEFAULT_HANDLERS'].items():
         cls = util.import_class_from_string(str_class)
@@ -329,7 +332,7 @@ def tool_setup(tool: str, config: dict, quiet: bool = False, auto_setup: bool =
     config['tools_loaded'].add(tool)
 
 
-def process_tokens( # pylint: disable=too-many-branches,too-many-statements,too-many-locals
+def process_tokens( # pylint: disable=too-many-branches,too-many-statements,too-many-locals,too-many-return-statements
         tokens: list, original_args: list, config: dict, is_interactive=False
 ) -> int:
     '''Returns bash/sh style return code int (0 pass, non-zero fail).
@@ -416,6 +419,15 @@ def process_tokens( # pylint: disable=too-many-branches,too-many-statements,too-
         return 2
 
     sco = config['command_handler'][command](config=config) # sub command object
+    if not parsed.tool:
+        # then what was the auto selected tool?
+        sco_tool = getattr(sco, '_TOOL', '')
+        if sco_tool in config['auto_tools_order'][0] and \
+           config['auto_tools_order'][0][sco_tool].get('disable-auto', False):
+            util.error(f'Cannot use tool={sco_tool} without arg --tool, it cannot be selected',
+                       'automatically')
+            return status_constants.EDA_COMMAND_OR_ARGS_ERROR
+
     util.debug(f'{command=}')
     util.debug(f'{sco.config=}')
     util.debug(f'{type(sco)=}')

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/eda_config.py

@@ -47,7 +47,7 @@ class Defaults:
         'exe', 'handlers',
         'requires_env', 'requires_py', 'requires_cmd', 'requires_in_exe_path',
         'requires_vsim_helper', 'requires_vscode_extension',
-        'disable-tools-multi',
+        'disable-tools-multi', 'disable-auto',
     ])
     supported_config_tool_keys = set([
         'defines',
@@ -158,6 +158,9 @@ def update_config_auto_tool_order_for_tool(tool: str, config: dict) -> str:
 
     user_exe = shutil.which(user_exe)
 
+    # try adding to $PATH if in form --tool=/path/to/exe
+    tool_try_add_to_path(tool)
+
     if tool not in config['auto_tools_order'][0]:
         return tool
     if not user_exe:
@@ -322,3 +325,34 @@ def write_eda_config_and_args(
             data['config'][k] = str(v)
 
     yaml_safe_writer(data=data, filepath=fullpath)
+
+
+def tool_try_add_to_path(tool: str) -> None:
+    '''Since we support --tool=<name>=/path/to/bin/exe, attempt to prepend $PATH
+
+    with this information for this tool (which will nicely affect all subprocesses,
+    but not wreck our original shell).'''
+
+    if not tool or '=' not in tool:
+        return
+
+    name, exe = tool.split('=')
+    if os.path.isdir(name):
+        # Someone passes us --tool=<name>=/path/to/bin/ (did not have exe)
+        path = name
+    else:
+        # Someone passes us --tool=<name>=/path/to/bin/exe, remove the exe.
+        path, _ = os.path.split(exe)
+    if not path:
+        return
+
+    path = os.path.abspath(path)
+    if os.path.isdir(path):
+        paths = os.environ['PATH'].split(':')
+        if path not in paths:
+            os.environ['PATH'] = path + ':' + os.environ['PATH']
+            util.info(f'--tool={tool} has path information, prepending PATH with: {path}')
+        else:
+            util.info(f'--tool={tool} has path information, but {path} already in $PATH')
+    if exe and os.path.isfile(exe):
+        util.info(f'--tool={tool} has path information, using exe {shutil.which(exe)}')

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/eda_config_defaults.yml

@@ -516,6 +516,7 @@ auto_tools_order:
         sim:  opencos.tools.iverilog.CommandSimIverilog
 
     cocotb:
+      disable-auto: True # do not allow this to run `eda sim` with --tool not set
       exe: python
       requires_cmd:
         - python -c "import cocotb; print(cocotb.__version__)"

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/export_helper.py

@@ -286,7 +286,11 @@ def get_list_sv_included_files(
         # If we have more than N levels of `include hunting, then rethink this.
         # For example, some codebases would do their file dependencies as `include
         # as part of their header guards, which could be ~100 levels of nesting.
-        for fname,traversed in sv_included_files_dict.items():
+
+        # make a copy of keys so we don't alter during traversal of the dict:
+        fnames = list(sv_included_files_dict.keys())
+        for fname in fnames:
+            traversed = sv_included_files_dict[fname]
             if not traversed:
                 included_files_list = find_sv_included_files_within_file(
                     filename=fname,

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/tests/helpers.py

@@ -39,6 +39,15 @@ def can_run_eda_command(*commands, config: dict) -> bool:
         if handler and getattr(handler, 'CHECK_REQUIRES', []):
             if not all(issubclass(handler, x) for x in getattr(handler, 'CHECK_REQUIRES', [])):
                 return False
+
+        # We cannot run tools that have disable-auto set:
+        tool = getattr(handler, '_TOOL', '')
+        if handler and tool:
+            entry = config['auto_tools_order'][0].get(tool, {})
+            if entry and entry.get('disable-auto', False):
+                # This tool cannot automatically run our command.
+                return False
+
         runnable.append(True)
     return runnable and all(runnable)
 

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/tools/cocotb.py

@@ -100,9 +100,34 @@ class CommandSimCocotb(CommandSim, ToolCocotb):
     def set_tool_defines(self):
         ToolCocotb.set_tool_defines(self)
 
+    def help( # pylint: disable=dangerous-default-value
+            self, tokens: list = [], no_targets: bool = False
+    ) -> None:
+        '''Override for Command.help(...)'''
+
+        super().help(tokens=tokens, no_targets=no_targets)
+        self._warn_if_simulator_not_present()
+
+    def _warn_if_simulator_not_present(self) -> None:
+        '''Warn if --cocotb-simulator is not set, or if the exe is not in PATH'''
+
+        simulator = self.args['cocotb-simulator']
+        if not simulator:
+            util.warning('--cocotb-simulator is not set, a simulation cannot be run with'
+                         'this arg value')
+            return
+        exe = shutil.which(simulator)
+        if not exe:
+            util.warning(f'--cocotb-simulator={simulator}, {simulator} is not present in PATH',
+                         'a simulation cannot be run with this arg value')
+
+
     def prepare_compile(self):
         self.set_tool_defines()
 
+        # Check existence of cocotb-simulator:
+        self._warn_if_simulator_not_present()
+
         # Fix iverilog -> icarus
         if self.args['cocotb-simulator'] == 'iverilog':
             self.args['cocotb-simulator'] = 'icarus'

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/tools/modelsim_ase.py

@@ -10,7 +10,7 @@ Note that this is for 32-bit Modelsim Student Edition. Consider using --tool=que
 import os
 
 from opencos import util
-from opencos.commands import CommandSim
+from opencos.commands import sim, CommandSim
 from opencos.tools.questa import ToolQuesta
 from opencos.utils.str_helpers import sanitize_defines_for_sh
 
@@ -201,6 +201,44 @@ 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 vopt_handle_parameters(self) -> (str, list):
+        '''Returns str for vopt or voptargs, and list of vopt tcl
+
+        Note this is used for self.use_vopt = True or False.
+        '''
+
+        voptargs_str = ''
+        vopt_do_lines = []
+
+        # Note that if self.use_vopt=True, we have to do some workarounds for how
+        # some questa-like tools behave for: tcl/.do + vopt arg processing
+        # This affects string based parameters that have spaces (vopt treats spaces unique args,
+        # vsim does not). Since we'd like to keep the vopt/vsim split into separate steps, we can
+        # work around this by setting tcl varaibles for each parameter.
+        if self.parameters:
+            if not self.use_vopt:
+                voptargs_str += ' ' + ' '.join(self.process_parameters_get_list(arg_prefix='-G'))
+            else:
+                for k,v in self.parameters.items():
+                    s = sim.parameters_dict_get_command_list(params={k: v}, arg_prefix='')[0]
+                    # At this point, s should be a str in form {k}={v}
+                    if not s or '=' not in s:
+                        continue
+                    if ' ' in s:
+                        # Instead of:
+                        #   vopt -GMyParam="hi bye"
+                        # we'll do:
+                        #   set PARAMETERS(MyParam) "hi bye"
+                        #  vopt -GMyParam=$PARAMETERS(MyParam)
+                        s = s.replace(f'{k}=', f'set PARAMETERS({k}) ')
+                        vopt_do_lines.append(s)
+                        voptargs_str += f' -G{k}=$PARAMETERS({k}) '
+                    else:
+                        voptargs_str += f' -G{s} '
+
+        return voptargs_str, vopt_do_lines
+
+
     def write_vsim_dot_do( # pylint: disable=too-many-locals
             self, dot_do_to_write: list
     ) -> None:
@@ -223,9 +261,13 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
                 typ='waveform', description='Modelsim/Questa Waveform WLF (Wave Log Format) file'
             )
 
-        # parameters
-        if self.parameters:
-            voptargs_str += ' ' + ' '.join(self.process_parameters_get_list(arg_prefix='-G'))
+        vlog_do_lines = []
+        vsim_do_lines = []
+
+        # parameters, use helper method to get voptargs_str and vopt_do_lines
+        more_voptargs_str, vopt_do_lines = self.vopt_handle_parameters()
+        voptargs_str += more_voptargs_str
+
 
         # TODO(drew): support self.args['sim_libary', 'elab-args', sim-args'] (3 lists)
         # to add to vsim_one_liner.
@@ -251,7 +293,7 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
 
         vsim_one_liner = vsim_one_liner.replace('\n', ' ')
 
-        vlog_do_lines = [
+        vlog_do_lines += [
             "if {[file exists work]} { vdel -all work; }",
             "vlib work;",
             "quietly set qc 30;",
@@ -263,9 +305,8 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
             "}",
         ]
 
-        vopt_do_lines = []
         if self.use_vopt:
-            vopt_do_lines = [
+            vopt_do_lines += [
                 "if {[catch { " + vopt_one_liner + " } result] } {",
                 "    echo \"Caught $result\";",
                 "    if {[batch_mode]} {",
@@ -274,7 +315,7 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
                 "}",
             ]
 
-        vsim_do_lines = [
+        vsim_do_lines += [
             "if {[catch { " + vsim_one_liner + " } result] } {",
             "    echo \"Caught $result\";",
             "    if {[batch_mode]} {",

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/tools/slang_yosys.py

@@ -118,7 +118,10 @@ class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
             params=self.parameters, arg_prefix='-G '
         )
 
-        read_slang_cmd.append(f'--top {self.args["top"]}')
+        # In case --top was not set:
+        if not any(x.startswith('--top') for x in read_slang_cmd):
+            read_slang_cmd.append(f'--top {self.args["top"]}')
+
         return ' '.join(read_slang_cmd)
 
 

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/tools/yosys.py

@@ -536,7 +536,6 @@ class CommandLecYosys(CommandLec, ToolYosys):
 
         self.synth_designs_tops = [None, None]
         self.synth_designs_fpaths = [None, None]
-        self.synth_design_top_module_names = [None, None]
 
     def get_synth_result_fpath(self, target: str) -> str:
         '''Overridden from CommandLec'''
@@ -547,7 +546,7 @@ class CommandLecYosys(CommandLec, ToolYosys):
     def get_synth_command_list(self, design_num: int) -> list:
         '''Returns one of the synthesis command lists, for design_num=0 or 1'''
 
-        if not design_num in [0, 1]:
+        if not design_num in (0, 1):
             self.error(f'{design_num=} we only support LEC on designs 0 and 1')
 
         synth_cmd_list = [
@@ -561,31 +560,43 @@ class CommandLecYosys(CommandLec, ToolYosys):
         synth_cmd_list += [
             '--work-dir=' + self.synth_work_dirs[design_num],
             self.args['designs'][design_num],
-            f'--rename-module=Design{design_num + 1}'
+            f'--rename-module=Design{design_num + 1}',
         ]
 
-        self.synth_design_top_module_names[design_num] = f'Design{design_num + 1}'
+        if self.args['flatten-all']:
+            # We have to do this or may get conflicts on black-boxed modules, but can
+            # be avoided with --no-flatten-all.
+            synth_cmd_list.append(
+                '--flatten-all'
+            )
+
+        self.synth_designs_tops[design_num] = f'Design{design_num + 1}'
 
         return synth_cmd_list
 
 
-    def get_synth_top_from_output_config(self, design_num: int) -> str:
-        '''Returns the top name given the design number that we synthesized'''
+    def get_synth_top_from_output_config(self, design_num: int) -> (str, str):
+        '''Returns the (orignal top name, module name) tuple given the design number
+
+        that we synthesized'''
 
         work_dir = self.synth_work_dirs[design_num]
         output_cfg_fpath = os.path.join(work_dir, eda_config.EDA_OUTPUT_CONFIG_FNAME)
         data = yaml_safe_load(output_cfg_fpath)
         top = data.get('args', {}).get('top', '')
-        if not top:
+        rename_module = data.get('args', {}).get('rename-module', '')
+        if not top and not rename_module:
             self.error(f'"top" not found in synth run from {work_dir=} in',
                        f'config {output_cfg_fpath}')
-        return top
+        if not rename_module:
+            return top, top
+        return top, rename_module
 
 
     def get_synth_results_fpath(self, design_num: int, top: str) -> str:
-        '''Returns the synthesized .v file fpath'''
+        '''Returns the synthesized .v file fpath, using orignal top (not renamed)'''
         if not top:
-            top = self.get_synth_top_from_output_config(design_num=design_num)
+            top, _ = self.get_synth_top_from_output_config(design_num=design_num)
 
         work_dir = self.synth_work_dirs[design_num]
         fpath = os.path.join(work_dir, 'yosys', f'{top}.v')
@@ -594,7 +605,7 @@ class CommandLecYosys(CommandLec, ToolYosys):
         return fpath
 
 
-    def do_it(self) -> None:
+    def do_it(self) -> None: # pylint: disable=too-many-locals,too-many-statements,too-many-branches
         self.set_tool_defines()
         self.write_eda_config_and_args()
 
@@ -622,6 +633,9 @@ class CommandLecYosys(CommandLec, ToolYosys):
                     self.exec(work_dir=self.args['work-dir'], command_list=x,
                               tee_fpath=x.tee_fpath)
 
+            util.info(f'LEC ran via --yosys-scriptfile: {self.args["yosys-scriptfile"]}')
+            return
+
 
         if self.args['synth']:
             synth1_cmd_list = self.get_synth_command_list(design_num=0)
@@ -636,23 +650,23 @@ class CommandLecYosys(CommandLec, ToolYosys):
             self.exec(pwd, synth2_cmd_list, background=True)
             util.info(f'Finished with 2nd LEC synthesis {self.args["designs"][1]}')
 
-            self.synth_designs_tops = [
-                self.get_synth_top_from_output_config(design_num=0),
-                self.get_synth_top_from_output_config(design_num=1)
-            ]
+
+            top0, module0 = self.get_synth_top_from_output_config(design_num=0)
+            top1, module1 = self.get_synth_top_from_output_config(design_num=1)
+            self.synth_designs_tops = [module0, module1]
             util.info(f'Design tops: {self.synth_designs_tops}')
 
             # read the output config
             self.synth_designs_fpaths = [
                 os.path.abspath(
-                    self.get_synth_results_fpath(design_num=0, top=self.synth_designs_tops[0])),
+                    self.get_synth_results_fpath(design_num=0, top=top0)),
                 os.path.abspath(
-                    self.get_synth_results_fpath(design_num=1, top=self.synth_designs_tops[1]))
+                    self.get_synth_results_fpath(design_num=1, top=top1))
             ]
             util.info(f'Design tops: {self.synth_designs_fpaths}')
 
         else:
-            # don't run synthesis, need the two top level .v files in
+            # don't run synthesis, need the two top level .v|.sv files in
             # self.synth_designs_fpaths, and need the two top module names in
             # self.synth_designs_tops
             self.synth_designs_fpaths = [
@@ -660,11 +674,19 @@ class CommandLecYosys(CommandLec, ToolYosys):
                 os.path.abspath(self.args['designs'][1])
             ]
 
+            for i in (0, 1):
+                if not os.path.isfile(self.args['designs'][i]):
+                    self.error(
+                        'Using synth=False (--no-synth) --designs=<value> must be a single',
+                        f'filename, however {self.args["designs"][i]} does not exist'
+                    )
+
             path, fname = os.path.split(self.synth_designs_fpaths[0])
             module_guess, _ = os.path.splitext(fname)
             top1 = util.get_inferred_top_module_name(
                 module_guess=module_guess, module_fpath=self.synth_designs_fpaths[0]
             )
+            util.debug(f'design1 {module_guess=} {fname=} {path=}')
             util.info(f'design1 top module name = {top1} (from {path} / {fname})')
 
             path, fname = os.path.split(self.synth_designs_fpaths[1])
@@ -672,6 +694,7 @@ class CommandLecYosys(CommandLec, ToolYosys):
             top2 = util.get_inferred_top_module_name(
                 module_guess=module_guess, module_fpath=self.synth_designs_fpaths[1]
             )
+            util.debug(f'design2 {module_guess=} {fname=} {path=}')
             util.info(f'design2 top module name = {top2} (from {path} / {fname})')
 
             self.synth_designs_tops = [top1, top2]
@@ -691,13 +714,20 @@ class CommandLecYosys(CommandLec, ToolYosys):
                     ]
                 else:
                     self.error(f' --pre-read-verilog file {x} does not exist')
+
+        nooverwrite = ''
+        if self.args['synth'] and not self.args['flatten-all']:
+            # If we don't flatten-all from synthesis, and we had to run synthesis,
+            # then read the 2nd file with -overwrite
+            nooverwrite = '-nooverwrite'
+
         lec_cmd_f_list += [
             '# Design1 (module):',
             f'read_verilog -sv -icells {self.synth_designs_fpaths[0]}',
             '# Design2 (module):',
-            f'read_verilog -sv -icells {self.synth_designs_fpaths[1]}',
+            f'read_verilog -sv -icells {self.synth_designs_fpaths[1]} {nooverwrite}',
             'clk2fflogic;',
-            f'miter -equiv -flatten {" ".join(self.synth_design_top_module_names)} miter',
+            f'miter -equiv -flatten {" ".join(self.synth_designs_tops)} miter',
             ('sat -seq 50 -verify -prove trigger 0 -show-all -show-inputs -show-outputs'
              ' -set-init-zero miter'),
         ]

{opencos_eda-0.2.56 → opencos_eda-0.2.57}/opencos/utils/vsim_helper.py

@@ -10,8 +10,6 @@ import subprocess
 
 from opencos.util import debug
 
-vsim_path = shutil.which('vsim')
-
 INIT_HAS_RUN = False
 TOOL_IS = {
     'riviera': False,
@@ -29,6 +27,7 @@ def init() -> None:
         return
 
     INIT_HAS_RUN = True
+    vsim_path = shutil.which('vsim')
 
     if not vsim_path:
         return

{opencos_eda-0.2.56 → opencos_eda-0.2.57/opencos_eda.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.56
+Version: 0.2.57
 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.2.56 → opencos_eda-0.2.57}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [project]
 name = "opencos-eda"
-version = "0.2.56"
+version = "0.2.57"
 dependencies = [
   # opencos/eda.py dependencies
   "mergedeep >= 1.3.4",