opencos-eda 0.2.39__tar.gz → 0.2.41__tar.gz

{opencos_eda-0.2.39/opencos_eda.egg-info → opencos_eda-0.2.41}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.39
+Version: 0.2.41
 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.39 → opencos_eda-0.2.41}/opencos/eda.py

@@ -166,7 +166,7 @@ def auto_tool_setup(warnings:bool=True, config=None, quiet=False, tool=None) ->
             continue
 
         has_all_py = True
-        requires_py_list = value.get('requires_py', list())
+        requires_py_list = value.get('requires_py', [])
         for pkg in requires_py_list:
             spec = importlib.util.find_spec(pkg)
             if not spec:
@@ -174,22 +174,27 @@ def auto_tool_setup(warnings:bool=True, config=None, quiet=False, tool=None) ->
                 util.debug(f"... No, missing pkg {spec}")
 
         has_all_env = True
-        requires_env_list = value.get('requires_env', list())
+        requires_env_list = value.get('requires_env', [])
         for env in requires_env_list:
             if not os.environ.get(env, ''):
                 has_all_env = False
                 util.debug(f"... No, missing env {env}")
 
         has_all_exe = True
+        has_all_in_exe_path = True
         for exe in exe_list:
             assert exe != '', f'{tool=} {value=} value missing "exe" {exe=}'
             p = shutil.which(exe)
             if not p:
                 has_all_exe = False
                 util.debug(f"... No, missing exe {exe}")
+            for req in value.get('requires_in_exe_path', []):
+                if p and req and str(req).lower() not in str(p).lower():
+                    has_all_in_exe_path = False
+                    util.debug(f"... No, missing path requirement {req}")
 
         if has_all_exe:
-            requires_cmd_list = value.get('requires_cmd', list())
+            requires_cmd_list = value.get('requires_cmd', [])
             for cmd in requires_cmd_list:
                 cmd_list = shlex.split(cmd)
                 try:
@@ -203,7 +208,7 @@ def auto_tool_setup(warnings:bool=True, config=None, quiet=False, tool=None) ->
                     util.debug(f"... No, exception running {cmd_list}")
 
 
-        if all([has_all_py, has_all_env, has_all_exe]):
+        if all([has_all_py, has_all_env, has_all_exe, has_all_in_exe_path]):
             exe = exe_list[0]
             p = shutil.which(exe)
             config['auto_tools_found'][name] = exe # populate key-value pairs w/ first exe in list

{opencos_eda-0.2.39 → opencos_eda-0.2.41}/opencos/eda_base.py

@@ -178,6 +178,7 @@ class Command:
             "job-name" : "", # this is used to create a certain dir under "eda_dir"
             "work-dir" : "", # this can be used to run the job in a certain dir, else it will be <eda-dir>/<job-name> else <eda-dir>/<target>_<command>
             "sub-work-dir" : "", # this can be used to name the dir built under <eda-dir>, which seems to be same function as job-name??
+            "work-dir-use-target-dir": False,
             "suffix" : "",
             "design" : "", # not sure how this relates to top
             'export':     False,
@@ -196,6 +197,8 @@ class Command:
             'export-json': 'export, and save a JSON file per target',
             'work-dir':    ('Optional override for working directory, often defaults to'
                             ' ./eda.work/<top>.<command>'),
+            "work-dir-use-target-dir": ('Set the work-dir to be the same as the in-place location'
+                                       ' where the target (DEPS) exists'),
             'enable-tags': ('DEPS markup tag names to be force enabled for this'
                             ' command (mulitple appends to list).'),
             'diable-tags': ('DEPS markup tag names to be disabled (even if they'
@@ -207,6 +210,7 @@ class Command:
         self.modified_args = {}
         self.config = copy.deepcopy(config) # avoid external modifications.
         self.target = ""
+        self.target_path = ""
         self.status = 0
 
     def error(self, *args, **kwargs):
@@ -228,6 +232,16 @@ class Command:
 
     def create_work_dir(self):
         util.debug(f"create_work_dir: {self.args['eda-dir']=} {self.args['work-dir']=}")
+        if self.args['work-dir-use-target-dir']:
+            if not self.target_path:
+                self.target_path = '.'
+            util.info(f"create_work_dir: --work-dir-use-target-dir: using:",
+                       f"{os.path.abspath(self.target_path)}",
+                       f'target={self.target}')
+            self.args['work-dir'] = self.target_path
+            self.args['sub-work-dir'] = ''
+            return self.args['work-dir']
+
         if not os.path.exists(self.args['eda-dir']):
             util.safe_mkdir(self.args['eda-dir'])
             util.info(f"create_work_dir: created {self.args['eda-dir']}")
@@ -884,7 +898,7 @@ class CommandDesign(Command):
         # self.target is a name we grab for the job (i.e. for naming work dir etc).  we don't want the path prefix.
         # TODO: too messy -- there's also a self.target, args['job-name'], args['work-dir'], args['design'], args['top'], args['sub-work-dir'] ...
 
-        self.target = os.path.basename(target)
+        self.target_path, self.target = os.path.split(target)
 
         if target in self.targets_dict:
             # If we're encountered this target before, stop. We're not traversing again.

{opencos_eda-0.2.39 → opencos_eda-0.2.41}/opencos/eda_config.py

@@ -35,7 +35,8 @@ class Defaults:
         'auto_tools_order',
     ])
     supported_config_auto_tools_order_keys = set([
-        'exe', 'handlers', 'requires_env', 'requires_py', 'requires_cmd',
+        'exe', 'handlers',
+        'requires_env', 'requires_py', 'requires_cmd', 'requires_in_exe_path',
         'disable-tools-multi',
     ])
     supported_config_tool_keys = set([

{opencos_eda-0.2.39 → opencos_eda-0.2.41}/opencos/eda_config_defaults.yml

@@ -86,6 +86,7 @@ tools:
   #   log-must-strings:    <Array of strings>
   #   sim-libraries:       <Array of strings>
   #   compile-args:        <string space separated>
+  #   compile-coverage-args: <string space separated>
   #   compile-waves-args:  <string space separated>
   #   compile-waivers:     <Array of strings, no spaces>
   #   elab-args:           <string space separated>
@@ -192,6 +193,24 @@ tools:
       VERIFIC: null
 
 
+  riviera:
+    defines:
+      OC_TOOL_RIVIERA: 1
+    log-bad-strings:
+      - "Error:"
+    log-must-strings:
+      - "VSIM: Simulation has finished"
+    compile-args: |
+      -echo -sv -input_ports net -lcu -dbg +accb +accr +accs +dacc
+    compile-coverage-args: |
+      -coverage sbecam -coverage_options count
+    # -uvm -ovm
+    simulate-waves-args: |
+      +accb +accr +access +r+w
+    coverage-args: |
+      -acdb -acdb_cov sbfectapm
+
+
   modelsim_ase:
     defines:
       OC_ASSERT_PROPERTY_NOT_SUPPORTED: 1
@@ -348,10 +367,23 @@ auto_tools_order:
         elab: opencos.tools.queta.CommandElabQuesta
         sim: opencos.tools.queta.CommandSimQuesta
 
+    riviera:
+      exe: vsim
+      requires_cmd:
+        - vsim -version
+        - which riviera  # Do not run it, make sure it's in PATH
+      requires_in_exe_path:
+        - riviera
+      handlers:
+        elab: opencos.tools.riviera.CommandElabRiviera
+        sim:  opencos.tools.riviera.CommandSimRiviera
+
     modelsim_ase:
       exe: vsim
       requires_cmd:
         - vsim -version
+      requires_in_exe_path:
+        - modelsim
       handlers:
         elab: opencos.tools.modelsim_ase.CommandElabModelsimAse
         sim:  opencos.tools.modelsim_ase.CommandSimModelsimAse

{opencos_eda-0.2.39 → opencos_eda-0.2.41}/opencos/tests/test_tools.py

@@ -71,7 +71,7 @@ list_of_tools = [
     'iverilog',
     'verilator',
     'vivado',
-    'modelsim_ase'
+    'modelsim_ase',
 ]
 
 list_of_deps_targets = [

{opencos_eda-0.2.39 → opencos_eda-0.2.41}/opencos/tools/modelsim_ase.py

@@ -3,6 +3,8 @@
 Contains classes for ToolModelsimAse, CommandSimModelsimAse, CommandElabModelsimAse.
 '''
 
+# pylint: disable=R0801 # (duplicate code in derived classes, such as if-condition return.)
+
 import os
 
 from opencos import util
@@ -133,7 +135,7 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
     def get_post_simulate_command_lists(self, **kwargs) -> list:
         return []
 
-    def write_vlog_dot_f(self, filename='vlog.f'):
+    def write_vlog_dot_f(self, filename='vlog.f') -> None:
         '''Returns none, creates filename (str) for a vlog.f'''
         vlog_dot_f_lines = []
 
@@ -186,7 +188,7 @@ 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 write_vsim_dot_do(self, dot_do_to_write: list):
+    def write_vsim_dot_do(self, dot_do_to_write: list) -> None:
         '''Writes files(s) based on dot_do_to_write(list of str)
 
         list arg values can be empty (all) or have items 'all', 'sim', 'lint', 'vlog'.'''

opencos_eda-0.2.41/opencos/tools/riviera.py

@@ -0,0 +1,293 @@
+''' opencos.tools.riviera - Used by opencos.eda for sim/elab commands w/ --tool=riviera.
+
+Contains classes for ToolRiviera, CommandSimRiviera, CommandElabRiviera.
+'''
+
+# pylint: disable=too-many-ancestors
+# pylint: disable=R0801 # (duplicate code in derived classes, such as if-condition return.)
+
+import os
+import shutil
+import subprocess
+
+from opencos import util
+from opencos.util import sanitize_defines_for_sh
+from opencos.tools.modelsim_ase import ToolModelsimAse, CommandSimModelsimAse
+
+class ToolRiviera(ToolModelsimAse):
+    '''ToolRiviera used by opencos.eda for --tool=riviera'''
+
+    _TOOL = 'riviera'
+    _EXE = 'vsim'
+
+    def get_versions(self) -> str:
+        if self._VERSION:
+            return self._VERSION
+        path = shutil.which(self._EXE)
+        if not path:
+            self.error(f"{self._EXE} not in path, need to setup or add to PATH")
+            util.debug(f"{path=}")
+        else:
+            self.sim_exe = path
+            self.sim_exe_base_path, _ = os.path.split(path)
+
+        version_ret = subprocess.run(
+            [self.sim_exe, '-version'],
+            capture_output=True,
+            check=False
+        )
+        stdout = version_ret.stdout.decode('utf-8').rstrip()
+
+        # 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:
+            self.error(f'{stdout}: does not show Riviera')
+        self._VERSION = right.split()[0]
+        return self._VERSION
+
+
+class CommandSimRiviera(CommandSimModelsimAse, ToolRiviera):
+    '''CommandSimRiviera is a command handler for: eda sim --tool=riviera'''
+
+    def __init__(self, config: dict):
+        CommandSimModelsimAse.__init__(self, config=config)
+        ToolRiviera.__init__(self, config=self.config)
+        self.shell_command = os.path.join(self.sim_exe_base_path, 'vsim')
+        self.starter_edition = True
+        self.args.update({
+            'tool': self._TOOL, # override
+            'gui': False,
+        })
+
+    def set_tool_defines(self):
+        # Update any defines from config.tools.modelsim_ase:
+        self.defines.update(
+            self.tool_config.get(
+                'defines',
+                # defaults, if not set:
+                {'OC_TOOL_RIVIERA': 1}
+            )
+        )
+
+    # Note: many of these we follow the same flow as CommandSimModelsimAse:
+    # do_it, prepare_compile, compile, elaborate, simulate
+
+    def get_compile_command_lists(self, **kwargs) -> list:
+        # This will also set up a compile.
+        vsim_command_list = [
+            self.sim_exe,
+            '' if self.args['gui'] else '-c',
+            '-l', 'sim.log', '-do', 'vsim_vlogonly.do'
+        ]
+        return [vsim_command_list]
+
+    def get_elaborate_command_lists(self, **kwargs) -> list:
+        # This will also set up a compile, for vlog + vsim (0 time)
+        vsim_command_list = [
+            self.sim_exe,
+            '' if self.args['gui'] else '-c',
+            '-l', 'sim.log', '-do', 'vsim_lintonly.do',
+        ]
+        return [vsim_command_list]
+
+    def get_simulate_command_lists(self, **kwargs) -> list:
+    # This will also set up a compile, for vlog + vsim (with run -all)
+        vsim_command_list = [
+            self.sim_exe,
+            '' if self.args['gui'] else '-c',
+            '-l', 'sim.log', '-do', 'vsim.do',
+        ]
+        return [vsim_command_list]
+
+    def get_post_simulate_command_lists(self, **kwargs) -> list:
+        return []
+
+
+    def write_vlog_dot_f(self, filename='vlog.f') -> None:
+        '''Returns none, creates filename (str) for a vlog.f'''
+        vlog_dot_f_lines = []
+
+        # Add compile args from config.tool.riviera
+        vlog_dot_f_lines += self.tool_config.get(
+            'compile-args',
+            '-sv -input_ports net').split()
+
+        # Add waivers from config.tool.riviera, convert to warning:
+        for waiver in self.tool_config.get('compile-waivers', []):
+            vlog_dot_f_lines += [f'-err {waiver} W1']
+
+        vlog_dot_f_fname = filename
+        vlog_dot_f_fpath = os.path.join(self.args['work-dir'], vlog_dot_f_fname)
+
+        for value in self.incdirs:
+            vlog_dot_f_lines += [ f"+incdir+{value}" ]
+
+        for k,v in self.defines.items():
+            if v is None:
+                vlog_dot_f_lines += [ f'+define+{k}' ]
+            else:
+
+                # if the value v is a double-quoted string, such as v='"hi"', the
+                # entire +define+NAME="hi" needs to wrapped in double quotes with the
+                # value v double-quotes escaped: "+define+NAME=\"hi\""
+                if isinstance(v, str) and v.startswith('"') and v.endswith('"'):
+                    str_v = v.replace('"', '\\"')
+                    vlog_dot_f_lines += [ f'"+define+{k}={str_v}"' ]
+                else:
+                    # Generally we should only support int and str python types passed as
+                    # +define+{k}={v}, but also for SystemVerilog plusargs
+                    vlog_dot_f_lines += [ f'+define+{k}={sanitize_defines_for_sh(v)}' ]
+
+
+        vlog_dot_f_lines += self.args['compile-args']
+        if self.args['coverage']:
+            vlog_dot_f_lines += self.tool_config.get('compile-coverage-args', '').split()
+
+        vlog_dot_f_lines += [
+            ] + list(self.files_sv) + list(self.files_v)
+
+        if not self.files_sv and not self.files_v:
+            if not self.args['stop-before-compile']:
+                self.error(f'{self.target=} {self.files_sv=} and {self.files_v=} are empty,',
+                           'cannot create a valid vlog.f')
+
+        with open(vlog_dot_f_fpath, 'w', encoding='utf-8') as f:
+            f.writelines(line + "\n" for line in vlog_dot_f_lines)
+
+
+    def write_vsim_dot_do(self, dot_do_to_write: list) -> None:
+        '''Writes files(s) based on dot_do_to_write(list of str)
+
+        list arg values can be empty (all) or have items 'all', 'sim', 'lint', 'vlog'.'''
+
+        vsim_dot_do_fpath = os.path.join(self.args['work-dir'], 'vsim.do')
+        vsim_lintonly_dot_do_fpath = os.path.join(self.args['work-dir'], 'vsim_lintonly.do')
+        vsim_vlogonly_dot_do_fpath = os.path.join(self.args['work-dir'], 'vsim_vlogonly.do')
+
+        sim_plusargs_str = self._get_sim_plusargs_str()
+
+        voptargs_str = ""
+        if self.args['gui'] or self.args['waves'] or self.args['coverage']:
+            voptargs_str = self.tool_config.get('simulate-waves-args',
+                                                '+accb +accr +access +r+w')
+        if self.args['coverage']:
+            voptargs_str += self.tool_config.get('coverage-args', '')
+
+        # TODO(drew): support self.args['sim_libary', 'elab-args', sim-args'] (3 lists)
+        # to add to vsim_one_liner.
+
+        vsim_one_liner = (
+            "vsim"
+            f" -sv_seed {self.args['seed']} {sim_plusargs_str}"
+            f" {voptargs_str} work.{self.args['top']}"
+        )
+
+        vsim_one_liner = vsim_one_liner.replace('\n', ' ') # needs to be a one-liner
+
+        vsim_vlogonly_dot_do_lines = [
+            "if {[file exists work]} { vdel -all work; }",
+            "vlib work;",
+            "if {[catch {vlog -f vlog.f} result]} {",
+            "    echo \"Caught $result \";",
+            "    if {[batch_mode]} {",
+            "        quit -code 20 -force;",
+            "    }",
+            "}",
+            "if {[batch_mode]} {",
+            "    quit -code 0 -force;",
+            "}",
+        ]
+
+        vsim_lintonly_dot_do_lines = [
+            "if {[file exists work]} { vdel -all work; }",
+            "vlib work;",
+            "set qc 30;",
+            "if {[catch {vlog -f vlog.f} result]} {",
+            "    echo \"Caught $result \";",
+            "    if {[batch_mode]} {",
+            "        quit -code 20 -force;",
+            "    }",
+            "}",
+            "if {[catch { " + vsim_one_liner + " } result] } {",
+            "    echo \"Caught $result\";",
+            "    if {[batch_mode]} {",
+            "        quit -code 19 -force;",
+            "    }",
+            "}",
+            "if {[batch_mode]} {",
+            "    quit -code 0 -force;",
+            "}",
+        ]
+
+        vsim_dot_do_lines = [
+            "if {[file exists work]} { vdel -all work; }",
+            "vlib work;",
+            "set qc 30;",
+            "if {[catch {vlog -f vlog.f} result]} {",
+            "    echo \"Caught $result \";",
+            "    if {[batch_mode]} {",
+            "        quit -code 20 -force;",
+            "    }",
+            "}",
+            "if {[catch { " + vsim_one_liner + " } result] } {",
+            "    echo \"Caught $result\";",
+            "    if {[batch_mode]} {",
+            "        quit -code 19 -force;",
+            "    }",
+            "}",
+        ]
+
+        if self.args['coverage']:
+            vsim_dot_do_lines += [
+                "run -all;",
+                "acdb save",
+                "acdb report -db work.acdb -txt -o cov.txt",
+                # Note - could try:
+                ##"cover report -o cov.report.txt -fullverbose -all_columns",
+            ]
+        else:
+            vsim_dot_do_lines += [
+                "run -all;",
+            ]
+
+
+        vsim_dot_do_lines += [
+            "if {[batch_mode]} {",
+            "    quit -code 0 -force;",
+            "}",
+        ]
+
+        write_all = len(dot_do_to_write) == 0 or 'all' in dot_do_to_write
+        if write_all or 'sim' in dot_do_to_write:
+            with open(vsim_dot_do_fpath, 'w', encoding='utf-8') as f:
+                f.writelines(line + "\n" for line in vsim_dot_do_lines)
+
+        if write_all or 'lint' in dot_do_to_write:
+            with open(vsim_lintonly_dot_do_fpath, 'w', encoding='utf-8') as f:
+                f.writelines(line + "\n" for line in vsim_lintonly_dot_do_lines)
+
+        if write_all or 'vlog' in dot_do_to_write:
+            with open(vsim_vlogonly_dot_do_fpath, 'w', encoding='utf-8') as f:
+                f.writelines(line + "\n" for line in vsim_vlogonly_dot_do_lines)
+
+
+
+    def _get_vsim_suppress_list_str(self) -> str:
+        vsim_suppress_list = []
+        # Add waivers from config.tool.modelsim_ase:
+        for waiver in self.tool_config.get(
+                'simulate-waivers', [
+                    #defaults: none
+                ]):
+            vsim_suppress_list += ['-filter', str(waiver)]
+
+        return ' '.join(vsim_suppress_list)
+
+
+class CommandElabRiviera(CommandSimRiviera):
+    '''CommandElabRiviera is a command handler for: eda elab --tool=riviera'''
+
+    def __init__(self, config:dict):
+        super().__init__(config)
+        self.args['stop-after-elaborate'] = True

{opencos_eda-0.2.39 → opencos_eda-0.2.41/opencos_eda.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.39
+Version: 0.2.41
 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.39 → opencos_eda-0.2.41}/opencos_eda.egg-info/SOURCES.txt

@@ -64,6 +64,7 @@ opencos/tools/invio_yosys.py
 opencos/tools/iverilog.py
 opencos/tools/modelsim_ase.py
 opencos/tools/questa.py
+opencos/tools/riviera.py
 opencos/tools/slang.py
 opencos/tools/slang_yosys.py
 opencos/tools/surelog.py

{opencos_eda-0.2.39 → opencos_eda-0.2.41}/pyproject.toml

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