opencos-eda 0.2.35__py3-none-any.whl → 0.2.38__py3-none-any.whl

opencos/export_helper.py

@@ -1,4 +1,5 @@
 import os
+import shutil
 import json
 
 from opencos import util
@@ -75,7 +76,7 @@ def find_sv_included_files_within_file(filename:str,
                                        known_incdir_paths:list,
                                        warnings:bool=True,
                                        modify_files_and_save_to_path=None,
-                                       unmodified_files_link_to_path=None) -> list:
+                                       unmodified_files_copy_to_path=None) -> list:
     '''Given a filename (full path) and a list of known incdir paths, returns
     a list of included files (full path).
 
@@ -83,8 +84,8 @@ def find_sv_included_files_within_file(filename:str,
     to strip all path information on the `include "(path)" for example:
       `include "foo.svh" -- no modifications
       `include "../bar.svh" -- is modified to become `include "bar.svh"
-    (Optional) unmodified_files_link_to_path (str: directory/path) if you wish
-    to symlink unmodified files to this path.
+    (Optional) unmodified_files_copy_to_path (str: directory/path) if you wish
+    to copy unmodified files to this path.
     '''
 
     found_included_files = set()
@@ -97,7 +98,7 @@ def find_sv_included_files_within_file(filename:str,
 
     filename_no_path = os.path.split(filename)[1]
 
-    debug(f'export_helper: {filename=} {modify_files_and_save_to_path=} {unmodified_files_link_to_path=}')
+    debug(f'export_helper: {filename=} {modify_files_and_save_to_path=} {unmodified_files_copy_to_path=}')
 
     with open(filename) as f:
 
@@ -153,13 +154,13 @@ def find_sv_included_files_within_file(filename:str,
                     else:
                         outf.write(line)
 
-    # Optionally soft-link unmodified files to some path?
-    if len(modified_lines) == 0 and unmodified_files_link_to_path:
-        if os.path.isdir(unmodified_files_link_to_path):
-            dst = os.path.join(unmodified_files_link_to_path, filename_no_path)
+    # Copy unmodified files to some path.
+    if len(modified_lines) == 0 and unmodified_files_copy_to_path:
+        if os.path.isdir(unmodified_files_copy_to_path):
+            dst = os.path.join(unmodified_files_copy_to_path, filename_no_path)
             if not os.path.exists(dst):
-                debug(f'export_helper: Linked {filename=} to {dst=}')
-                os.symlink(src=filename, dst=dst)
+                debug(f'export_helper: Copied unmodified {filename=} to {dst=}')
+                shutil.copy(src=filename, dst=dst)
 
 
     # Back to the list found_included_files that we observed within our filename, we
@@ -193,7 +194,7 @@ def find_sv_included_files_within_file(filename:str,
 def get_list_sv_included_files(all_src_files:list, known_incdir_paths:list, target:str='',
                                warnings:bool=True,
                                modify_files_and_save_to_path=None,
-                               unmodified_files_link_to_path=None) -> list:
+                               unmodified_files_copy_to_path=None) -> list:
     ''' Given a list of all_src_files, and list of known_incdir_paths, returns a list
     of all included files (fullpath). This is recurisve if an included file includes another file.
 
@@ -205,7 +206,7 @@ def get_list_sv_included_files(all_src_files:list, known_incdir_paths:list, targ
         `include "foo.svh" -- no modifications
         `include "../bar.svh" -- is modified to become `include "bar.svh"
       Set to None (default) to disable.
-    unmodified_files_link_to_path -- (str: directory/path) if you wish to symlink unmodified
+    unmodified_files_copy_to_path -- (str: directory/path) if you wish to copy unmodified
       files to this path. Set to None (default) to disable.
     '''
 
@@ -220,7 +221,7 @@ def get_list_sv_included_files(all_src_files:list, known_incdir_paths:list, targ
             known_incdir_paths=known_incdir_paths,
             warnings=warnings,
             modify_files_and_save_to_path=modify_files_and_save_to_path,
-            unmodified_files_link_to_path=unmodified_files_link_to_path
+            unmodified_files_copy_to_path=unmodified_files_copy_to_path
         )
 
         for f in included_files_list:
@@ -239,7 +240,7 @@ def get_list_sv_included_files(all_src_files:list, known_incdir_paths:list, targ
                     known_incdir_paths=known_incdir_paths,
                     warnings=warnings,
                     modify_files_and_save_to_path=modify_files_and_save_to_path,
-                    unmodified_files_link_to_path=unmodified_files_link_to_path
+                    unmodified_files_copy_to_path=unmodified_files_copy_to_path
                 )
                 sv_included_files_dict[fname] = True # mark as traversed.
 
@@ -317,7 +318,7 @@ class ExportHelper:
             known_incdir_paths=self.cmd_design_obj.incdirs,
             target=self.target,
             modify_files_and_save_to_path=self.out_dir,
-            unmodified_files_link_to_path=self.out_dir
+            unmodified_files_copy_to_path=self.out_dir
         )
 
         info(f"export_helper: {self.target=} included files {self.included_files=}")
@@ -325,7 +326,7 @@ class ExportHelper:
         for filename in self.cmd_design_obj.files_non_source:
             dst = os.path.join(self.out_dir, os.path.split(filename)[1])
             if not os.path.exists(dst):
-                os.symlink(src=filename, dst=dst)
+                shutil.copy(src=filename, dst=dst)
 
     def create_deps_yml_in_out_dir(self, deps_file_args:list=list()):
         if not self.target:
@@ -449,11 +450,11 @@ class ExportHelper:
         info(f'export_helper: Wrote {dst=}')
 
         # If this was from an `export` command, and the self.out_dir != self.args['work-dir'], then
-        # link the export.json to the work-dir:
+        # copy the export.json to the work-dir:
         if self.out_dir != self.args['work-dir']:
             util.safe_mkdirs(base=self.args['work-dir'], new_dirs=['export'])
             src = os.path.abspath(os.path.join(self.out_dir, 'export.json'))
             dst = os.path.join(self.args['work-dir'], 'export', 'export.json')
             if not os.path.exists(dst):
-                os.symlink(src=src, dst=dst)
-            info(f'export_helper: Linked to {dst=}')
+                shutil.copy(src=filename, dst=dst)
+            info(f'export_helper: Copied {src=} to {dst=}')

opencos/files.py

@@ -29,7 +29,7 @@ ALL_FORCED_PREFIXES = set(list(FORCE_PREFIX_DICT.keys()))
 
 def get_source_file(target:str) -> (bool, str, str):
     '''Returns tuple: bool if file exists, filepath str, and optional forced file type str'''
-    if os.path.exists(target):
+    if os.path.isfile(target):
         # target exists as a file, return True w/ original target:
         return True, target, ''
 
@@ -37,7 +37,7 @@ def get_source_file(target:str) -> (bool, str, str):
         for p in ALL_FORCED_PREFIXES:
             if p in target:
                 fpath = ''.join(target.split(p)) # essentially just removing the "sv@" or whatever it is
-                if os.path.exists(fpath):
+                if os.path.isfile(fpath):
                     return True, fpath, FORCE_PREFIX_DICT.get(p)
 
     # target or fpath didn't exist, return False with the original target:

opencos/tests/helpers.py

@@ -142,13 +142,14 @@ class Helpers:
         # TODO(drew): There are some issues with log_it redirecting stdout from vivado
         # and modelsim_ase. So this may not work for all tools, you may have to directly
         # look at eda.work/{target}.sim/sim.log or xsim.log.
+        print(f'{os.getcwd()=}')
+        print(f'{command_str=}')
         with open(logfile, 'w', encoding='utf-8') as f:
-            with redirect_stdout(f):
-                with redirect_stderr(f):
-                    if use_eda_wrap:
-                        rc = eda_wrap(*(command_str.split()))
-                    else:
-                        rc = eda.main(*(command_str.split()))
+            with redirect_stdout(f), redirect_stderr(f):
+                if use_eda_wrap:
+                    rc = eda_wrap(*(command_str.split()))
+                else:
+                    rc = eda.main(*(command_str.split()))
             print(f'Wrote: {os.path.abspath(logfile)=}')
         return rc
 

opencos/tests/test_eda.py

@@ -53,6 +53,28 @@ def test_args_sim_default_tool():
     assert rc == 0
 
 
+class TestTargets(Helpers):
+    '''Tests for: eda targets'''
+
+    DEFAULT_DIR = os.path.join(THISPATH, '..', '..', 'lib', 'tests')
+
+    def test_lib_tests__no_pattern(self):
+        '''Test that this works: eda targets'''
+        self.chdir()
+        rc = self.log_it('targets --debug', use_eda_wrap=False)
+        assert rc == 0
+        assert self.is_in_log('oclib_fifo_test')
+        assert self.is_in_log('oclib_rrarb_test')
+
+    def test_lib_tests__with_pattern(self):
+        '''Test that this works: eda targets oclib_fifo*test'''
+        self.chdir()
+        rc = self.log_it('targets oclib_fifo*test', use_eda_wrap=False)
+        assert rc == 0
+        assert self.is_in_log('oclib_fifo_test')
+        assert not self.is_in_log('oclib_rrarb_test')
+
+
 @pytest.mark.skipif(
     'verilator' not in tools_loaded, reason="requires verilator"
 )

opencos/tools/invio.py

@@ -2,7 +2,6 @@
 
 # pylint: disable=R0801 # (duplicate code in derived classes, such as if-condition return.)
 
-import shutil
 import importlib.util
 
 from opencos import util
@@ -22,11 +21,11 @@ class ToolInvio(Tool):
         if self._VERSION:
             return self._VERSION
 
-        # We also have to make sure invio-py exists, or that we can import invio within python.
-        invio_py_path = shutil.which('invio-py')
+        # We also have to make sure we can import invio within python.
         spec = importlib.util.find_spec('invio')
-        if not spec or not invio_py_path:
-            self.error('"invio-py" not in path, or invio package not in python env')
+        if not spec:
+            self.error('"invio" package not in python env')
+
 
         return super().get_versions()
 

opencos/tools/invio_yosys.py

@@ -5,7 +5,6 @@
 # pylint: disable=too-many-locals     # TODO(drew): fix this later.
 
 import os
-import shutil
 import importlib.util
 
 from opencos import util
@@ -23,11 +22,10 @@ class ToolInvioYosys(ToolYosys):
         if self._VERSION:
             return self._VERSION
 
-        # We also have to make sure invio-py exists, or that we can import invio within python.
-        invio_py_path = shutil.which('invio-py')
+        # We also have to make sure we can import invio within python.
         spec = importlib.util.find_spec('invio')
-        if not spec or not invio_py_path:
-            self.error('"invio-py" not in path, or invio package not in python env')
+        if not spec:
+            self.error('"invio" package not in python env')
 
         # run ToolYosys.get_versions() to set up self.yosys_exe, and return the version
         # str:
@@ -49,6 +47,9 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
         self.args.update({
             'invio-blackbox': [],                # list of modules that invio/verific will blackbox.
         })
+        self.args_help.update({
+            'invio-blackbox': 'List of modules that invio will blackbox prior to yosys',
+        })
 
     def write_and_run_yosys_f_files(self, **kwargs) -> None:
 
@@ -74,13 +75,13 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
             os.mkdir(fullp)
 
         # create yosys.f so we can run a few commands within yosys.
-        yosys_f_path = os.path.join(work_dir, 'yosys.f')
-        yosys_v_path = os.path.join(work_dir, 'yosys', invio_dict['v_filename'])
-
-        synth_command = self.args.get('yosys-synth', 'synth')
+        yosys_f_path = os.path.join(self.full_work_dir, 'yosys.f')
+        self.yosys_v_path = os.path.join(self.yosys_out_dir, invio_dict['v_filename'])
 
         with open(yosys_f_path, 'w', encoding='utf-8') as f:
             lines = []
+            if self.args['liberty-file']:
+                lines.append('read_liberty -lib ' + self.args['liberty-file'])
             for path in invio_dict.get('blackbox_files_list', []):
                 # We have to read the verilog files from the invio blackbox_files_list:
                 lines.append(f'read_verilog {path}')
@@ -88,12 +89,9 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
                 # But we may blackbox different cells for yosys synthesis.
                 lines.append(f'blackbox {module}')
 
+
             lines.append(f'read_verilog {invio_dict["full_v_filename"]}')
-            lines += self.args.get('yosys-pre-synth', [])
-            lines += [
-                synth_command,
-                f'write_verilog {yosys_v_path}'
-            ]
+            lines += self.get_synth_command_lines()
             f.write('\n'.join(lines))
 
         synth_command_list = util.ShellCommandList(
@@ -105,6 +103,9 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
             ['python3', invio_dict['full_py_filename']], tee_fpath=invio_dict['full_py_filename']
         )
 
+        # Optinally create and run a sta.f:
+        sta_command_list = self.create_sta_f() # [] or util.ShellCommandList
+
         # We create a run_yosys.sh wrapping these scripts, but we do not run this one.
         util.write_shell_command_file(
             dirpath=self.args['work-dir'],
@@ -121,18 +122,25 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
                 # Gives us bash commands with tee and pipstatus:
                 invio_command_list,
                 synth_command_list,
+                sta_command_list,
             ],
         )
 
         # Do not run this if args['stop-before-compile'] is True
         if self.args.get('stop-before-compile', False) or \
            self.args.get('stop-after-compile', False):
-            pass # skip it.
-        else:
-            self.exec( work_dir=work_dir, command_list=synth_command_list,
-                       tee_fpath=synth_command_list.tee_fpath )
-            util.info(f'yosys: wrote verilog to {yosys_v_path}')
-        return self.status
+            return
+
+        # Run the synth commands standalone:
+        self.exec( work_dir=work_dir, command_list=synth_command_list,
+                   tee_fpath=synth_command_list.tee_fpath )
+
+        if self.args['sta']:
+            self.exec(work_dir=self.full_work_dir, command_list=sta_command_list,
+                      tee_fpath=sta_command_list.tee_fpath)
+
+        if self.status == 0:
+            util.info(f'yosys: wrote verilog to {self.yosys_v_path}')
 
 
 class CommandElabInvioYosys(CommandSynthInvioYosys):

opencos/tools/slang_yosys.py

@@ -8,8 +8,7 @@ Contains classes for ToolSlangYosys, CommandSynthSlangYosys
 import os
 
 from opencos import util
-from opencos.commands import CommandSynth
-from opencos.tools.yosys import ToolYosys
+from opencos.tools.yosys import ToolYosys, CommonSynthYosys
 
 class ToolSlangYosys(ToolYosys):
     '''Uses slang.so in yosys plugins directory, called via yosys > plugin -i slang'''
@@ -28,49 +27,17 @@ class ToolSlangYosys(ToolYosys):
         })
 
 
-class CommandSynthSlangYosys(CommandSynth, ToolSlangYosys):
+class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
     '''CommandSynthSlangYosys is a command handler for: eda synth --tool=slang_yosys'''
 
     def __init__(self, config: dict):
-        CommandSynth.__init__(self, config)
+        CommonSynthYosys.__init__(self, config)
         ToolSlangYosys.__init__(self, config=self.config)
-        self.args.update({
-            'sta': False,
-            'liberty-file': '',
-            'sdc-file': '',
-            'yosys-synth': 'synth',       # synth_xilinx, synth_altera, etc (see: yosys help)
-            'yosys-pre-synth': ['prep', 'proc'], # command run in yosys prior to yosys-synth.
-            'yosys-blackbox': [],                # list of modules that yosys will blackbox.
-        })
-        self.args_help.update({
-            'sta': 'After running Yosys, run "sta" with --liberty-file.' \
-            + ' sta can be installed via: https://github.com/The-OpenROAD-Project/OpenSTA',
-            'sdc-file': '.sdc file to use with --sta, if not present will use auto constraints',
-            'liberty-file': 'Single liberty file for synthesis and sta,' \
-            + ' for example: github/OpenSTA/examples/nangate45_slow.lib.gz',
-            'yosys-synth': 'The synth command provided to Yosys, see: yosys help.',
-            'yosys-pre-synth': 'Yosys commands performed prior to running "synth"' \
-            + ' (or eda arg value for --yosys-synth)',
-            'yosys-blackbox': 'List of modules that yosys will blackbox, likely will need these' \
-            + ' in Verilog-2001 for yosys to read outside of slang and synth',
-        })
 
         self.slang_out_dir = ''
-        self.yosys_out_dir = ''
         self.slang_v_path = ''
-        self.yosys_v_path = ''
-        self.full_work_dir = ''
-        self.blackbox_list = []
 
-    def do_it(self) -> None:
-        CommandSynth.do_it(self)
-
-        if self.is_export_enabled():
-            return
-
-        self._write_and_run_yosys_f_files()
-
-    def _write_and_run_yosys_f_files(self):
+    def write_and_run_yosys_f_files(self, **kwargs) -> None:
         '''
         1. Creates and runs: yosys.slang.f
            -- should create post_slang_ls.txt
@@ -88,28 +55,20 @@ class CommandSynthSlangYosys(CommandSynth, ToolSlangYosys):
         util.debug(f'slang_yosys: {self.blackbox_list=}')
 
         # create {work_dir} / yosys
-        self.full_work_dir = self.args.get('work-dir', '')
-        if not self.full_work_dir:
-            self.error(f'work_dir={self.full_work_dir} is not set')
-        self.full_work_dir = os.path.abspath(self.full_work_dir)
         self.slang_out_dir = os.path.join(self.full_work_dir, 'slang')
-        self.yosys_out_dir = os.path.join(self.full_work_dir, 'yosys')
-        for p in [self.slang_out_dir, self.yosys_out_dir]:
-            util.safe_mkdir(p)
+        util.safe_mkdir(self.slang_out_dir)
 
         self.slang_v_path = os.path.join(self.slang_out_dir, f'{self.args["top"]}.v')
-        self.yosys_v_path = os.path.join(self.yosys_out_dir, f'{self.args["top"]}.v')
-
 
         # Run our created yosys.slang.f script
         # Note - this will always run, even if --stop-before-compile is set.
         slang_command_list = self._create_yosys_slang_f() # util.ShellCommandList
 
         # Create and run yosys.synth.f
-        synth_command_list = self._create_yosys_synth_f() # util.ShellCommandList
+        synth_command_list = self.create_yosys_synth_f() # util.ShellCommandList
 
         # Optinally create and run a sta.f:
-        sta_command_list = self._create_sta_f() # [] or util.ShellCommandList
+        sta_command_list = self.create_sta_f() # [] or util.ShellCommandList
 
         # We create a run_yosys.sh wrapping these scripts, but we do not run this one.
         util.write_shell_command_file(
@@ -246,7 +205,7 @@ class CommandSynthSlangYosys(CommandSynth, ToolSlangYosys):
                             yosys_blackbox_list.append(line)
         return yosys_blackbox_list
 
-    def _create_yosys_synth_f(self) -> util.ShellCommandList:
+    def create_yosys_synth_f(self) -> util.ShellCommandList:
         # Create yosys.synth.f
         yosys_synth_f_path = os.path.join(self.full_work_dir, 'yosys.synth.f')
 
@@ -254,10 +213,6 @@ class CommandSynthSlangYosys(CommandSynth, ToolSlangYosys):
         # yosys.synth.f script.
         yosys_blackbox_list = self._get_yosys_blackbox_list()
 
-        synth_command = self.args.get('yosys-synth', 'synth')
-        if self.args['flatten-all']:
-            synth_command += ' -flatten'
-
         if self.args['liberty-file'] and not os.path.exists(self.args['liberty-file']):
             self.error(f'--liberty-file={self.args["liberty-file"]} file does not exist')
 
@@ -273,20 +228,7 @@ class CommandSynthSlangYosys(CommandSynth, ToolSlangYosys):
             for inst in yosys_blackbox_list:
                 lines.append('blackbox ' + inst)
 
-            lines += self.args.get('yosys-pre-synth', [])
-            lines.append(synth_command)
-
-            # TODO(drew): I need a blackbox flow here? Or a memory_libmap?
-            #   --> https://yosyshq.readthedocs.io/projects/yosys/en/latest/cmd/memory_libmap.html
-            # TODO(drew): can I run multiple liberty files?
-            if self.args['liberty-file']:
-                lines += [
-                    'dfflibmap -liberty ' + self.args['liberty-file'],
-                    #'memory_libmap -lib ' + self.args['liberty-file'], # Has to be unzipped?
-                    'abc -liberty  ' + self.args['liberty-file'],
-                ]
-
-            lines.append(f'write_verilog {self.yosys_v_path}')
+            lines += self.get_synth_command_lines()
             f.write('\n'.join(lines))
 
         synth_command_list = util.ShellCommandList(
@@ -296,74 +238,7 @@ class CommandSynthSlangYosys(CommandSynth, ToolSlangYosys):
         return synth_command_list
 
 
-    def _create_sta_f(self) -> list:
-
-        if not self.args['sta']:
-            return []
-
-        if not self.args['liberty-file']:
-            self.error('--sta is set, but need to also set --liberty-file=<file>')
-
-        if self.args['sdc-file']:
-            if not os.path.exists(self.args['sdc-file']):
-                self.error(f'--sdc-file={self.args["sdc-file"]} file does not exist')
-
-        if not self.sta_exe:
-            self.error(f'--sta is set, but "sta" was not found in PATH, see: {self._URL}')
-
-        sta_command_list = util.ShellCommandList(
-            [ self.sta_exe, '-no_init', '-exit', 'sta.f' ],
-            tee_fpath = 'sta.log'
-        )
-
-        # Need to create sta.f:
-        if self.args['sdc-file']:
-            sdc_path = self.args['sdc-file']
-        else:
-            # Need to create sdc.f:
-            sdc_path = 'sdc.f'
-            self._create_sdc_f()
-
-        with open(os.path.join(self.args['work-dir'], 'sta.f'), 'w',
-                  encoding='utf-8') as f:
-            lines = [
-                'read_liberty ' + self.args['liberty-file'],
-                'read_verilog ' + self.yosys_v_path,
-                'link_design ' + self.args['top'],
-                'read_sdc ' + sdc_path,
-                'report_checks',
-            ]
-            f.write('\n'.join(lines))
-
-        return util.ShellCommandList(
-            sta_command_list,
-            tee_fpath = 'sta.log'
-        )
-
-
-    def _create_sdc_f(self) -> None:
-        if self.args['sdc-file']:
-            # already exists from args, return b/c nothing to create.
-            return
-
-        with open(os.path.join(self.args['work-dir'], 'sdc.f'), 'w',
-                  encoding='utf-8') as f:
-            clock_name = self.args['clock-name']
-            period = self.args['clock-ns']
-            name_not_equal_clocks_str = f'NAME !~ "{clock_name}"'
-            lines = [
-                f'create_clock -add -name {clock_name} -period {period} [get_ports ' \
-                + '{' + clock_name + '}];',
-                f'set_input_delay -max {self.args["idelay-ns"]} -clock {clock_name}' \
-                + ' [get_ports * -filter {DIRECTION == IN && ' \
-                + name_not_equal_clocks_str + '}];',
-                f'set_output_delay -max {self.args["odelay-ns"]} -clock {clock_name}' \
-                + ' [get_ports * -filter {DIRECTION == OUT}];',
-            ]
-            f.write('\n'.join(lines))
-
-
-class CommandElabSlangYosys(CommandSynthSlangYosys):
+class CommandElabSlangYosys(CommandSynthSlangYosys): # pylint: disable=too-many-ancestors
     '''CommandSynthSlangYosys is a command handler for: eda synth --tool=slang_yosys
 
     Runs slang-yosys as elab only (does not run the synthesis portion), but is