opencos-eda 0.2.57__py3-none-any.whl → 0.3.0__py3-none-any.whl

opencos/_version.py

@@ -9,11 +9,14 @@ if sys.version_info >= (3, 8):
 
     from importlib import metadata
     try:
-        VERSION = metadata.version(NAME)
+        ver = metadata.version(NAME)
     except metadata.PackageNotFoundError:
         # Handle case where the package is not installed (e.g., running from source checkout)
-        VERSION = "0.0.0"
+        ver = "0.0.0"
 
 else:
     # This package only supports >= 3.8, so not doing the importlib_metadata method.
-    VERSION = "unknown" # Or raise an error, or handle differently
+    ver = "unknown" # Or raise an error, or handle differently
+
+
+VERSION = ver # pylint: disable=invalid-name

opencos/_waves_pkg.sv

@@ -15,7 +15,7 @@ package _waves_pkg;
   bit        trace_en_init = 0;
   bit        trace_en      = init_trace();
 
-  function automatic bit init_trace();
+  function bit init_trace();
 
     if (trace_en_init) // only do this once.
       return trace_en;
@@ -41,7 +41,39 @@ package _waves_pkg;
 
   endfunction : init_trace
 
-`endif // #verilator
+`elsif RIVIERA
+
+  bit        trace_en_init = 0;
+  bit        trace_en      = init_trace();
+
+  // Note: must be non-automatic function for --tool=riviera
+  function bit init_trace();
+
+    if (trace_en_init) // only do this once.
+      return trace_en;
+
+    trace_en_init = 1;
+
+    if ($test$plusargs("trace") != 0) begin
+      automatic string trace_str_value = "";
+      void'($value$plusargs("trace=%s", trace_str_value));
+      if (trace_str_value.tolower() == "vcd") begin
+        $display("%t %m: Starting tracing to ./dump.vcd, plusarg +trace=%s",
+                 $realtime, trace_str_value);
+        $dumpfile("dump.vcd");
+        $dumpvars();
+        return 1;
+      end
+    end
+
+    $display("%t %m: Starting tracing to ./dump.fst", $realtime);
+    $dumpfile("dump.fst");
+    $dumpvars();
+    return 1;
+
+  endfunction : init_trace
+
+`endif
 `endif
 `endif
 

opencos/commands/build.py

@@ -40,6 +40,7 @@ class CommandBuild(CommandDesign):
             self.create_work_dir()
             self.run_dep_commands()
             self.do_it()
+            self.run_post_tool_dep_commands()
         else:
             util.warning(f'CommandBuild: {self.command_name=} not run due to lack of',
                          f'{self.args["top"]=} value')

opencos/commands/export.py

@@ -50,6 +50,7 @@ class CommandExport(CommandDesign):
             self.create_work_dir()
             self.run_dep_commands()
             self.do_it()
+            self.run_post_tool_dep_commands()
         else:
             util.warning(f'CommandExport: {self.command_name=} not run due to lack of',
                          f'{self.args["top"]=} value')

opencos/commands/flist.py

@@ -227,3 +227,4 @@ class CommandFList(CommandDesign):
             util.info(f"Created file: {self.args['out']}")
 
         self.write_eda_config_and_args()
+        self.run_post_tool_dep_commands()

opencos/commands/lec.py

@@ -100,6 +100,7 @@ class CommandLec(CommandDesign):
         self.create_work_dir()
         self.run_dep_commands()
         self.do_it()
+        self.run_post_tool_dep_commands()
         return unparsed
 
 

opencos/commands/proj.py

@@ -37,5 +37,6 @@ class CommandProj(CommandDesign):
             self.create_work_dir()
             self.run_dep_commands()
             self.do_it()
+            self.run_post_tool_dep_commands()
 
         return unparsed

opencos/commands/shell.py

@@ -58,6 +58,10 @@ class CommandShell(CommandDesign):
             self.create_work_dir()
             self.run_dep_commands()
             self.do_it()
+            self.run_post_tool_dep_commands()
+        else:
+            util.warning(f'CommandShell: {self.command_name=} not run due to lack of',
+                         f'{self.args["top"]=} value')
         return unparsed
 
 

opencos/commands/sim.py

@@ -63,6 +63,8 @@ class CommandSim(CommandDesign):
             'sim-args': [],
             'sim-plusargs': [], # lists are handled by 'set_arg(k,v)' so they append.
             'sim-library': [],
+            'compile-waivers': [],
+            'sim-waivers': [],
             'coverage': False,
             'waves': False,
             'waves-start': 0,
@@ -142,6 +144,7 @@ class CommandSim(CommandDesign):
             self.create_work_dir()
             self.run_dep_commands()
             self.do_it()
+            self.run_post_tool_dep_commands()
         return unparsed
 
 
@@ -400,7 +403,7 @@ class CommandSim(CommandDesign):
         '''
 
         all_lists = [] # list - of - (command-list)
-        if self.has_dep_shell_commands:
+        if self.has_pre_compile_dep_shell_commands:
             all_lists = [
                 ['./pre_compile_dep_shell_commands.sh']
             ]
@@ -423,6 +426,11 @@ class CommandSim(CommandDesign):
                                           line_breaks=simulate_line_breaks)
             all_lists.append(['./' + simulate_sh_fname])
 
+        if self.has_post_tool_dep_shell_commands:
+            all_lists = [
+                ['./post_tool_dep_shell_commands.sh']
+            ]
+
         util.write_shell_command_file(dirpath=self.args['work-dir'], filename='all.sh',
                                       command_lists=all_lists)
 
@@ -459,3 +467,41 @@ class CommandSim(CommandDesign):
     def get_post_simulate_command_lists(self, **kwargs) -> list:
         ''' Returns a list of lists (list of command lists).'''
         raise NotImplementedError
+
+    def add_waves_pkg_file(self) -> None:
+        '''If --waves is present, and one of --waves-fst or --waves-vcd or --dump-vcd, and
+
+        the user is missing any $dumpfile(), then adds a pre-written
+        SystemVerilog package to their source code. Note that individual tools have
+        to call this prior to their compile step, CommandSim does not run this method for
+        you.
+        '''
+        if not self.args['waves']:
+            return
+        if not any(self.args.get(x, False) for x in ('waves-fst', 'waves-vcd', 'dump-vcd')):
+            return
+        found_dumpfile = False
+        for fname in self.files_v + self.files_sv:
+            if found_dumpfile:
+                break
+            with open(fname, encoding='utf-8') as f:
+                for line in f.readlines():
+                    if '$dumpfile' in line:
+                        found_dumpfile = True
+                        break
+
+        if not found_dumpfile:
+            thispath = os.path.dirname(__file__)
+            file_to_add = os.path.join(thispath, '..', '_waves_pkg.sv')
+            util.info(f'--waves arg present, no $dumpfile found, adding SV file: {file_to_add}')
+            self.add_file(file_to_add)
+
+        # register .vcd or .fst artifacts:
+        util.artifacts.add_extension(
+            search_paths=self.args['work-dir'], file_extension='fst',
+            typ='waveform', description='Simulation Waveform FST (Fast Signal Trace) file'
+        )
+        util.artifacts.add_extension(
+            search_paths=self.args['work-dir'], file_extension='vcd',
+            typ='waveform', description='Simulation Waveform VCD (Value Change Dump) file'
+        )

opencos/commands/synth.py

@@ -73,6 +73,10 @@ class CommandSynth(CommandDesign):
             self.create_work_dir()
             self.run_dep_commands()
             self.do_it()
+            self.run_post_tool_dep_commands()
+        else:
+            util.warning(f'CommandSynth: {self.command_name=} not run due to lack of',
+                         f'{self.args["top"]=} value')
         return unparsed
 
     def do_export(self):

opencos/deps/defaults.py

@@ -59,14 +59,22 @@ SUPPORTED_TAG_KEYS = set([
     'additive-config-tools',
 ])
 
+COMMAND_ATTRIBUTES = {
+    # with default values
+    'run-from-work-dir': True,
+    'filepath-subst-target-dir': True,
+
+    'run-after-tool': False,   # default is to run before any tool compile step.
+    'dirpath-subst-target-dir': False,
+    'var-subst-args': False,
+    'var-subst-os-env': False,
+    'tee': None,
+}
+
 SUPPORTED_COMMAND_KEYS = set([
     'shell',
-    'work-dir-add-srcs', 'work-dir-add-sources',
     'peakrdl',
-    'run-from-work-dir',     # default True
-    'filepath-subst-target-dir', # default True
-    'dirpath-subst-target-dir',  # default False
-    'var-subst-args',
-    'var-subst-os-env',
-    'tee',
+    'work-dir-add-srcs', 'work-dir-add-sources'
 ])
+for key in COMMAND_ATTRIBUTES:
+    SUPPORTED_COMMAND_KEYS.add(key)

opencos/deps/deps_commands.py

@@ -16,14 +16,14 @@ import re
 import shutil
 
 from opencos.util import debug, error, warning, ShellCommandList
-from opencos.deps.defaults import SUPPORTED_COMMAND_KEYS
+from opencos.deps.defaults import SUPPORTED_COMMAND_KEYS, COMMAND_ATTRIBUTES
 
 THISPATH = os.path.dirname(__file__)
 PEAKRDL_CLEANUP_PY = os.path.join(THISPATH, '..', 'peakrdl_cleanup.py')
 
 def path_substitutions_relative_to_work_dir(
         exec_list: list, info_str: str, target_path: str,
-        enable_filepath_subst: bool, enable_dirpath_subst: bool
+        attributes: dict
 ) -> list:
     '''For shell commands, since eda.py Command objects operate out of a "work-dir", it can
     make shell commands confusing with additional ../.. to get to the calling directory, and
@@ -38,7 +38,8 @@ def path_substitutions_relative_to_work_dir(
     dirpath-subst-target-dir: True)
     '''
 
-    if not enable_filepath_subst and not enable_dirpath_subst:
+    if not attributes.get('filepath-subst-target-dir', True) and \
+       not attributes.get('dirpath-subst-target-dir', False):
         return exec_list
 
     # Look for path substitutions, b/c we later "work" in self.args['work-dir'], but
@@ -53,13 +54,15 @@ def path_substitutions_relative_to_work_dir(
             # self.args['work-dir'] don't need this, and we can't assume dir levels in the work-dir.
             try:
                 try_path = os.path.abspath(os.path.join(os.path.abspath(target_path), m.group(1)))
-                if enable_filepath_subst and  os.path.isfile(try_path):
+                if attributes.get('filepath-subst-target-dir', True) and \
+                   os.path.isfile(try_path):
                     # make the substitution
                     exec_list[i] = word.replace(m.group(1), try_path)
                     debug(f'file path substitution {info_str=} {target_path=}: replaced - {word=}'
                           f'is now ={exec_list[i]}. This can be disabled in DEPS with:',
                           '"filepath-subst-targetdir: false"')
-                elif enable_dirpath_subst and os.path.isdir(try_path):
+                elif attributes.get('dirpath-subst-target-dir', False) and \
+                     os.path.isdir(try_path):
                     # make the substitution
                     exec_list[i] = word.replace(m.group(1), try_path)
                     debug(f'dir path substitution {info_str=} {target_path=}: replaced - {word=}'
@@ -84,12 +87,7 @@ def line_with_var_subst( # pylint: disable=dangerous-default-value
     if '{' not in line:
         return line
 
-    if replace_vars_os_env:
-        replace_dict = {}
-        replace_dict.update(os.environ)
-        replace_dict.update(replace_vars_dict)
-    else:
-        replace_dict = replace_vars_dict
+    replace_dict = replace_vars_dict
 
     words = line.split()
     for i,word in enumerate(words):
@@ -100,6 +98,13 @@ def line_with_var_subst( # pylint: disable=dangerous-default-value
             pass
 
     new_line = ' '.join(words)
+
+    if replace_vars_os_env:
+        try:
+            new_line = os.path.expandvars(new_line)
+        except Exception as e:
+            warning(f'{e}: trying to apply env vars to line: {new_line}')
+
     if new_line != line:
         debug(f'{target_node=} {target_path=} performed string format replacement,',
               f'{line=} {new_line=}')
@@ -112,8 +117,7 @@ def line_with_var_subst( # pylint: disable=dangerous-default-value
 
 def parse_deps_shell_str(
         line: str, target_path: str, target_node: str,
-        enable_filepath_subst_target_dir: bool = True,
-        enable_dirpath_subst_target_dir: bool = False,
+        attributes: dict,
         enable: bool = True
 ) -> dict:
     '''Returns None or a dict of a possible shell command from line (str)
@@ -146,20 +150,21 @@ def parse_deps_shell_str(
     # Note this can be disable in DEPS via path-subst-target-dir=False
     exec_list = path_substitutions_relative_to_work_dir(
         exec_list=exec_list, info_str='shell@', target_path=target_path,
-        enable_filepath_subst=enable_filepath_subst_target_dir,
-        enable_dirpath_subst=enable_dirpath_subst_target_dir
+        attributes=attributes
     )
 
     return {
         'target_path': os.path.abspath(target_path),
         'target_node': target_node,
-        'run_from_work_dir': True, # may be overriden later.
         'exec_list': exec_list,
+        'attributes': attributes
     }
 
 
 def parse_deps_work_dir_add_srcs(
-        line : str, target_path : str, target_node : str, enable : bool = True
+        line : str, target_path : str, target_node : str,
+        attributes: dict,
+        enable : bool = True
 ) -> dict:
     '''Returns None or a dict describing source files to add from the work-dir path
 
@@ -182,17 +187,19 @@ def parse_deps_work_dir_add_srcs(
     files_str = m.group(1)
     file_list = files_str.split()
 
-    d = {'target_path': os.path.abspath(target_path),
-         'target_node': target_node,
-         'file_list': file_list,
-         }
+    d = {
+        'target_path': os.path.abspath(target_path),
+        'target_node': target_node,
+        'file_list': file_list,
+        'attributes': attributes
+    }
     return d
 
 
 def parse_deps_peakrdl( # pylint: disable=too-many-locals
-        line: str, target_path: str, target_node: str, enable: bool = True,
-        enable_filepath_subst_target_dir: bool = True,
-        enable_dirpath_subst_target_dir: bool = False
+        line: str, target_path: str, target_node: str,
+        attributes: dict,
+        enable: bool = True
 ) -> dict:
     '''Returns None or a dict describing a PeakRDL CSR register generator dependency
 
@@ -268,16 +275,16 @@ def parse_deps_peakrdl( # pylint: disable=too-many-locals
                 line=(' shell@ ' + ' '.join(one_cmd_as_list)),
                 target_path=target_path,
                 target_node=target_node,
-                enable_filepath_subst_target_dir=enable_filepath_subst_target_dir,
-                enable_dirpath_subst_target_dir=enable_dirpath_subst_target_dir
+                attributes=attributes
             )
         )
 
     # Make the work_dir_add_srcs dict:
     ret_dict['work_dir_add_srcs'] = parse_deps_work_dir_add_srcs(
-        line = ' work_dir_add_srcs@ ' + ' '.join(sv_files),
-        target_path = target_path,
-        target_node = target_node
+        line=' work_dir_add_srcs@ ' + ' '.join(sv_files),
+        target_path=target_path,
+        target_node=target_node,
+        attributes=attributes
     )
 
     return ret_dict
@@ -329,65 +336,69 @@ def deps_commands_handler( #pylint: disable=too-many-locals,too-many-branches
                 error(f'deps_commands.process_commands - command {key=} not in',
                       f'{SUPPORTED_COMMAND_KEYS=}')
 
+        # collect attributes for this command:
+        attributes = {}
+        for key, default_value in COMMAND_ATTRIBUTES.items():
+            attributes[key] = command.get(key, default_value)
+
         var_subst_dict = {} # this is per-command.
-        if config['dep_command_enables'].get('var_subst_os_env', False) and \
-           command.get('var-subst-os-env', False):
-            var_subst_dict.update(dict(os.environ))
         if config['dep_command_enables'].get('var_subst_args', False) and \
-           command.get('var-subst-args', False):
+           attributes['var-subst-args']:
             var_subst_dict = eda_args
 
-        tee_fpath = command.get('tee', None)
-
-        # These are both optional bools, default True, would have to explicitly be set to False
-        # to take effect:
-        run_from_work_dir = command.get('run-from-work-dir', True)
-        filepath_subst_target_dir = command.get('filepath-subst-target-dir', True)
-        dirpath_subst_target_dir = command.get('dirpath-subst-target-dir', False)
-
         for key,item in command.items():
 
             # skip the tee and var-subst-* keys, since these types are bools and not commands.
-            if key in ['tee',
-                       'var-subst-os-env',
-                       'var-subst-args',
-                       'run-from-work-dir',
-                       'filepath-subst-target-dir',
-                       'dirpath-subst-target-dir']:
+            if key in COMMAND_ATTRIBUTES:
                 continue
 
             # Optional variable substituion in commands
             if isinstance(item, str):
-                item = line_with_var_subst(item, replace_vars_dict=var_subst_dict,
-                                           target_node=target_node, target_path=deps_file)
+                item = line_with_var_subst(
+                    line=item,
+                    replace_vars_dict=var_subst_dict,
+                    replace_vars_os_env=attributes['var-subst-os-env'],
+                    target_node=target_node,
+                    target_path=deps_file
+                )
 
             if key == 'shell':
                 # For now, piggyback on parse_deps_shell_str:
-                ret_dict = parse_deps_shell_str(
-                    line=('shell@ ' + item),
-                    target_path=target_path,
-                    target_node=target_node,
-                    enable_filepath_subst_target_dir=filepath_subst_target_dir,
-                    enable_dirpath_subst_target_dir=dirpath_subst_target_dir,
-                    enable=config['dep_command_enables']['shell'],
-                )
-                # To support 'tee: <some-file>' need to append it to last
-                # list item in ret_dict['exec_list'], and make it a util.ShellCommandList.
-                if tee_fpath:
-                    ret_dict['exec_list'] = ShellCommandList(
-                        ret_dict['exec_list'], tee_fpath=tee_fpath
+
+                # If our shell commands have \n in them, split the commands.
+                item = item.replace('\\\n', ' ') # but not \ + newline
+
+                for shell_line in item.split('\n'):
+
+                    shell_line = shell_line.strip()
+                    if not shell_line:
+                        continue
+
+                    ret_dict = parse_deps_shell_str(
+                        line=('shell@ ' + shell_line),
+                        target_path=target_path,
+                        target_node=target_node,
+                        attributes=attributes,
+                        enable=config['dep_command_enables']['shell'],
                     )
-                ret_dict['run_from_work_dir'] = run_from_work_dir
-                assert ret_dict, f'shell command failed in {dep=} {target_node=} in {deps_file=}'
-                shell_commands_list.append(ret_dict) # process this later, append to ret tuple
+                    # To support 'tee: <some-file>' need to append it to last
+                    # list item in ret_dict['exec_list'], and make it a util.ShellCommandList.
+                    if attributes['tee']:
+                        ret_dict['exec_list'] = ShellCommandList(
+                            ret_dict['exec_list'], tee_fpath=attributes['tee']
+                        )
+                    assert ret_dict, \
+                        f'shell command failed in {dep=} {target_node=} in {deps_file=}'
+                    shell_commands_list.append(ret_dict) # process this later, append to ret tuple
 
             elif key in ['work-dir-add-srcs', 'work-dir-add-sources']:
                 # For now, piggyback on parse_deps_work_dir_add_srcs:
                 ret_dict = parse_deps_work_dir_add_srcs(
-                    line = 'work_dir_add_srcs@ ' + item,
-                    target_path = target_path,
-                    target_node = target_node,
+                    line='work_dir_add_srcs@ ' + item,
+                    target_path=target_path,
+                    target_node=target_node,
                     enable=config['dep_command_enables']['work_dir_add_srcs'],
+                    attributes=attributes,
                 )
                 assert ret_dict, \
                     f'work-dir-add-srcs command failed in {dep=} {target_node=} in {deps_file=}'
@@ -397,12 +408,11 @@ def deps_commands_handler( #pylint: disable=too-many-locals,too-many-branches
             elif key == 'peakrdl':
                 # for now, piggyback on parse_deps_peakrdl:
                 ret_dict = parse_deps_peakrdl(
-                    line = 'peakrdl@ ' + item,
-                    target_path = target_path,
-                    target_node = target_node,
-                    enable_filepath_subst_target_dir=filepath_subst_target_dir,
-                    enable_dirpath_subst_target_dir=dirpath_subst_target_dir,
-                    enable=config['dep_command_enables']['peakrdl']
+                    line='peakrdl@ ' + item,
+                    target_path=target_path,
+                    target_node=target_node,
+                    enable=config['dep_command_enables']['peakrdl'],
+                    attributes=attributes
                 )
                 assert ret_dict, f'peakrdl command failed in {dep=} {target_node=} in {deps_file=}'
 

opencos/deps_schema.py

@@ -85,6 +85,8 @@ my_target_name:
                                            directory path substitution relative to target dir
                                            (if substituted directory exists).
         tee:                         <---- string, filename to write logs to
+        run-after-tool:              <---- bool, default false. Set to true to run after any
+                                           EDA tools, or any command handlers have completed.
       - work-dir-add-sources:        <---- work-dir-add-sources, optional list (or string)
         - some_file_gen_from_sh.sv   <---- string filename that we created with sh command
       - peakrdl:                     <---- string peakrdl command for CSR generation
@@ -171,6 +173,7 @@ DEPS_COMMANDS_LIST = [
         Optional('var-subst-args'): bool,
         Optional('var-subst-os-env'): bool,
         Optional('run-from-work-dir'): bool,
+        Optional('run-after-tool'): bool,
         Optional('filepath-subst-target-dir'): bool,
         Optional('dirpath-subst-target-dir'): bool,
         Optional('tee'): Or(str, type(None)),

opencos/eda.py

@@ -520,7 +520,8 @@ def main(*args):
 
     original_args = args.copy() # save before any parsing.
 
-    # Set global --debug, --quiet, --color  early before parsing other args:
+    # Set global --debug, --quiet, --color, -f/--iput-file, --envfile
+    # early before parsing other args:
     util_parsed, unparsed = util.process_tokens(args)
 
     util.debug(f"main: file: {os.path.realpath(__file__)}")