opencos-eda 0.3.12__py3-none-any.whl → 0.3.14__py3-none-any.whl

opencos/eda.py

@@ -75,7 +75,7 @@ def init_config(
             config['command_handler'][_cmd] = cls
 
     config['auto_tools_found'] = {}
-    config['tools_loaded'] = set()
+    config['tools_loaded'] = []
 
     # If this is a sub_command sitation, then use that for setting up tools, otherwise
     # use the command. If there's no command, blank str is fine will load all the tools, or
@@ -192,7 +192,7 @@ def auto_tool_setup( # pylint: disable=too-many-locals,too-many-branches,too-man
     '''Returns an updated config, uses config['auto_tools_order'] dict and
     config['tools'] dict, calls tool_setup(..)
 
-    -- adds items to config['tools_loaded'] set
+    -- adds items to config['tools_loaded'] list
     -- updates config['command_handler'][command] with a Tool class
 
     Input arg tool can be in the form (for example):
@@ -210,7 +210,7 @@ def auto_tool_setup( # pylint: disable=too-many-locals,too-many-branches,too-man
     if 'auto_tools_found' not in config:
         config['auto_tools_found'] = {}
     if 'tools_loaded' not in config:
-        config['tools_loaded'] = set()
+        config['tools_loaded'] = []
 
     util.debug(f'Calling auto_tool_setup for {tool=} {command=}')
 
@@ -223,12 +223,14 @@ def auto_tool_setup( # pylint: disable=too-many-locals,too-many-branches,too-man
 
     # Step 1 - Load tools (do not set config['command_handler'][command])
 
-    for name, tool_cfg in config['tools'].items():
+    if tool:
+        # if called with tool=(some_name), then only load that tool (which is not
+        # this one). Also delete this entry from config['tools'] because we don't need it.
+        for name in list(config['tools'].keys()):
+            if tool != name:
+                del config['tools'][name]
 
-        if tool and tool != name:
-            # if called with tool=(some_name), then only load that tool (which is not
-            # this one)
-            continue
+    for name, tool_cfg in config['tools'].items():
 
         if name in config['auto_tools_found']:
             # we already loaded this tool.
@@ -326,7 +328,8 @@ def auto_tool_setup( # pylint: disable=too-many-locals,too-many-branches,too-man
             else:
                 p = safe_shutil_which(exe_list[0])
             config['auto_tools_found'][name] = p # populate key-value pairs w/ first exe in list
-            config['tools_loaded'].add(name)
+            if name not in config['tools_loaded']:
+                config['tools_loaded'].append(name)
             if not quiet:
                 util.info(f"Detected {name} ({p})")
         else:

opencos/eda_base.py

@@ -26,7 +26,8 @@ from opencos import eda_config
 
 from opencos.util import Colors, safe_emoji
 from opencos.utils.str_helpers import sprint_time, strip_outer_quotes, string_or_space, \
-    indent_wrap_long_text, pretty_list_columns_manual, get_terminal_columns
+    indent_wrap_long_text, pretty_list_columns_manual, get_terminal_columns, \
+    PARAMETER_NAME_RSTR
 from opencos.utils.subprocess_helpers import subprocess_run_background
 from opencos.utils import status_constants
 
@@ -192,6 +193,8 @@ class Tool:
             self.args_help = {}
         if getattr(self, 'defines', None) is None:
             self.defines = {}
+        if getattr(self, 'config', None) is None:
+            self.config = config
         self.args.update({
             'tool':   self._TOOL, # Set for all derived classes.
         })
@@ -261,8 +264,20 @@ class Tool:
         )
 
     def set_tool_defines(self) -> None:
-        '''Derived classes may override, sets any additional defines based on tool.'''
-        return
+        '''Derived classes may override, sets any additional defines based on tool.
+
+        If overriding, you likely want to call:
+            super().set_tool_defines()
+        to pick up anything from self.config['tools'] (from the eda_config YAML)
+        '''
+        if not self._TOOL:
+            return
+
+        _tool_config = self.config.get('tools', {}).get(self._TOOL, {})
+        self.defines.update(
+            _tool_config.get('defines', {})
+        )
+
 
 
 class Command: # pylint: disable=too-many-public-methods,too-many-instance-attributes
@@ -1501,7 +1516,14 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
     def process_parameter_arg(
             self, text: str, pwd: str = os.getcwd()
     ) -> None:
-        '''Retuns None, parses -G<Name>=<Value> adds to internal self.parameters.'''
+        '''Retuns None, parses -G<Name>=<Value> adds to internal self.parameters.
+
+        Note that not all tools will allow hierarchy path information when setting
+        parameters. The Queta/Modelsim family can handle -G/Path/To/Name=Value,
+        but other tools may crash.
+
+        Also note - we do not currently accept [0] in the /Path/To/generate[1]/Name=Value
+        '''
 
         # Deal with raw CLI/bash/powershell argparser, strip all outer quotes.
         text = strip_outer_quotes(text)
@@ -1514,14 +1536,14 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
             return
 
         text = text[2:] # strip leading -G
-        m = re.match(r'^(\w+)$', text)
+        m = re.match(rf'^({PARAMETER_NAME_RSTR})$', text)
         if m:
             k = m.group(1)
             util.warning(f"Parameter {k} has no value and will not be applied")
             return
-        m = re.match(r'^(\w+)\=(\S+)$', text)
+        m = re.match(rf'^({PARAMETER_NAME_RSTR})\=(\S+)$', text)
         if not m:
-            m = re.match(r'^(\w+)\=(\"[^\"]*\")$', text)
+            m = re.match(rf'^({PARAMETER_NAME_RSTR})\=(\"[^\"]*\")$', text)
         if m:
             k = m.group(1)
             v = m.group(2)
@@ -1536,7 +1558,11 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
                 v = int(v)
             except ValueError:
                 pass
+            util.debug('set parameter Name={k} Value={v}')
             self.set_parameter(k, v)
+        else:
+            util.warning(f'Unable to set parameter from token (-G removed): {text}')
+
 
 
     def process_plusarg( # pylint: disable=too-many-branches
@@ -1924,19 +1950,24 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
             m = re.match(r"^\'?\+\w+", token)
             if m:
                 # Copy and strip all outer ' or " on the plusarg:
+                util.debug(f'plusarg found at {token=}')
                 plusarg = strip_outer_quotes(token)
                 self.process_plusarg(plusarg, pwd=pwd)
                 remove_list.append(token)
                 continue
 
             # Parameters in -G<word>=<something>
-            m = re.match(r"^\'?\-G\w+\=.+", token)
+            # Parameters in -Gpath.to.<word>=<something>
+            # Parameters in -G/path/to/<word>=<something>
+            m = re.match(rf"^\'?\-G{PARAMETER_NAME_RSTR}\=.+", token)
             if m:
                 # Copy and strip all outer ' or " on the text:
+                util.debug(f'found parameter at {token=}')
                 param = strip_outer_quotes(token)
                 self.process_parameter_arg(param, pwd=pwd)
                 remove_list.append(token)
 
+
         for x in remove_list:
             unparsed.remove(x)
 

opencos/eda_config.py

@@ -33,6 +33,7 @@ class Defaults:
     opencos_config_yml = 'eda_config_defaults.yml'
     config_yml = ''
     config_yml_set_from = ''
+    non_default_config_yml_arg_used = ''
 
     supported_config_keys = set([
         'DEFAULT_HANDLERS', 'DEFAULT_HANDLERS_HELP',
@@ -314,11 +315,35 @@ def get_eda_config(args:list, quiet=False) -> (dict, list):
         config = None
 
     if parsed.config_yml != Defaults.config_yml:
+        Defaults.non_default_config_yml_arg_used = parsed.config_yml
         config = get_config_merged_with_defaults(config)
 
     return config, unparsed
 
 
+def get_config_yml_args_for_flist() -> list:
+    '''Returns list of args, or empty list. Used by CommandFList when we want to get the args
+
+    to reproduce a target to be run again in `eda`'''
+    ret = []
+
+    if Defaults.non_default_config_yml_arg_used:
+        ret.append(f'--config-yml={Defaults.non_default_config_yml_arg_used}')
+
+        if Defaults.config_yml_set_from:
+            # a default config-yml was used, but it wasn't from eda, was from
+            # ENV or HOME dir. This is not included in the flist, so warn about it.
+            # Since we don't support > 1 config-yml args, need to warn about this.
+            util.warning('Note: for command "flist", picked up',
+                         f'--config-yml={Defaults.config_yml},',
+                         f'from: {Defaults.config_yml_set_from}')
+
+    elif Defaults.config_yml_set_from:
+        ret.append(f'--config-yml={Defaults.config_yml}')
+
+    return ret
+
+
 def write_eda_config_and_args(
         dirpath : str, filename: str = EDA_OUTPUT_CONFIG_FNAME,
         command_obj_ref: object = None
@@ -334,16 +359,22 @@ def write_eda_config_and_args(
         # Use deep copy b/c otherwise these are references to opencos.eda.
         data[x] = copy.deepcopy(getattr(command_obj_ref, x, ''))
 
-    # copy util.args
-    data['util'] = {
-        'args': util.args
-    }
+    # copy util.args, and other util globals:
+    data['util'] = {}
+    for x in ['INITIAL_CWD', 'args', 'dot_f_files_expanded', 'env_files_loaded', 'max_error_code']:
+        data['util'][x] = getattr(util, x, '')
+
+    # copy some information about which eda_config YAML was used:
+    for member in ['config_yml', 'config_yml_set_from', 'non_default_config_yml_arg_used']:
+        data[member] = getattr(Defaults, member, '')
 
     # fix some burried class references in command_obj_ref.config,
     # otherwise we won't be able to safe load this yaml, so cast as str repr.
-    for k, v in getattr(command_obj_ref, 'config', {}).items():
+    config = getattr(command_obj_ref, 'config', {})
+    for k, v in config.items():
         if k == 'command_handler':
-            data['config'][k] = str(v)
+            data['config']['command_handler'] = str(v)
+
 
     yaml_safe_writer(data=data, filepath=fullpath)
 

opencos/eda_config_defaults.yml

@@ -116,6 +116,7 @@ command_determines_tool:
 
 command_tool_is_optional:
   # eda commands that may not need to use a tool at all, will skip auto_tools_order if --tool=None (default)
+  - shell
   - flist
   - export
   - targets
@@ -254,6 +255,7 @@ tools:
 
     defines:
       OC_TOOL_SLANG: null
+      SLANG: 1
     log-bad-strings:
       - 'Build failed: '
     log-must-strings:
@@ -273,7 +275,8 @@ tools:
       elab: opencos.tools.verilator.VerilatorElab
       sim: opencos.tools.verilator.VerilatorSim
 
-    defines: { }
+    defines:
+      SIMULATION: 1
     log-warning-strings:
       - "%Warning"
     log-bad-strings:
@@ -382,11 +385,14 @@ tools:
       lint: opencos.tools.riviera.CommandLintRiviera
       elab: opencos.tools.riviera.CommandElabRiviera
       sim:  opencos.tools.riviera.CommandSimRiviera
+      flist: opencos.tools.riviera.CommandFListRiviera
       waves:  opencos.commands.waves.CommandWaves
 
     defines:
       OC_TOOL_RIVIERA: 1
       RIVIERA: 1
+      # see oclib_defines.vh, this is to prevent type comparisons
+      OC_TOOL_BROKEN_TYPE_COMPARISON: 1
     log-warning-strings:
       - "Warning: "
     log-bad-strings:
@@ -396,7 +402,7 @@ tools:
     log-must-strings:
       - "VSIM: Simulation has finished"
     compile-args: |
-      -echo -sv -input_ports net -lcu -dbg +accb +accr +accs +dacc
+      -echo -sv -input_ports net -dbg +accb +accr +accs +dacc
     compile-coverage-args: |
       -coverage sbecam -coverage_options count
     # -uvm -ovm
@@ -406,7 +412,8 @@ tools:
       -acdb -acdb_cov sbfectapm
     simulate-coverage-tcl:
       - acdb save
-      - acdb report -db work.acdb -txt -o cov.txt
+      - acdb report -i work.acdb -txt -o cov.txt
+      - acdb report -i work.acdb -txt -o covg.txt -show covergroups
 
 
   modelsim_ase:
@@ -416,11 +423,14 @@ tools:
       lint: opencos.tools.modelsim_ase.CommandLintModelsimAse
       elab: opencos.tools.modelsim_ase.CommandElabModelsimAse
       sim:  opencos.tools.modelsim_ase.CommandSimModelsimAse
+      flist: opencos.tools.modelsim_ase.CommandFListModelsimAse
       waves:  opencos.commands.waves.CommandWaves
 
     defines:
       OC_ASSERT_PROPERTY_NOT_SUPPORTED: 1
       OC_TOOL_MODELSIM_ASE: 1
+      # see oclib_defines.vh, this is to prevent type comparisons
+      OC_TOOL_BROKEN_TYPE_COMPARISON: 1
     log-warning-strings:
       - "Warning: "
     log-bad-strings:
@@ -457,7 +467,7 @@ tools:
       waves:  opencos.commands.waves.CommandWaves
 
     defines:
-      OC_TOOL_QUESTA_FSE: 1
+      OC_TOOL_QUESTA_FE: 1
     log-warning-strings:
       - "Warning: "
     log-bad-strings:
@@ -531,7 +541,7 @@ tools:
       waves:  opencos.commands.waves.CommandWaves
 
     defines:
-      OC_TOOL_QUESTA_FSE: 1
+      OC_TOOL_QUESTA: 1
     log-warning-strings:
       - "Warning: "
     log-bad-strings:
@@ -563,6 +573,10 @@ tools:
       lint: opencos.tools.iverilog.CommandLintIverilog
       elab: opencos.tools.iverilog.CommandElabIverilog
       sim:  opencos.tools.iverilog.CommandSimIverilog
+    defines:
+      SIMULATION: 1
+      IVERILOG: 1
+      OC_ASSERT_PROPERTY_NOT_SUPPORTED: 1
 
     log-warning-strings:
       - "Warning:"
@@ -595,6 +609,8 @@ tools:
 
     defines:
       OC_TOOL_COCOTB: null
+      COCOTB: 1
+      SIMULATION: 1
     log-warning-strings:
       - "Warning:"
       - "WARNING:"
@@ -669,6 +685,10 @@ tools:
       elab:  opencos.tools.slang_yosys.CommandElabSlangYosys
       synth: opencos.tools.slang_yosys.CommandSynthSlangYosys
       lec:   opencos.tools.slang_yosys.CommandLecSlangYosys
+    defines:
+      OC_TOOL_YOSYS: null
+      OC_TOOL_SLANG: null
+      SLANG: 1
 
   tabbycad_yosys:
     exe: yosys
@@ -676,6 +696,9 @@ tools:
       - YOSYSHQ_LICENSE
     handlers:
       synth: opencos.tools.tabbycad_yosys.CommandSynthTabbyCadYosys
+    defines:
+      OC_TOOL_YOSYS: null
+      OC_TOOL_TABBYCAD: null
 
   invio_yosys:
     exe: yosys
@@ -686,6 +709,8 @@ tools:
     handlers:
       elab:  opencos.tools.invio_yosys.CommandElabInvioYosys
       synth: opencos.tools.invio_yosys.CommandSynthInvioYosys
+      OC_TOOL_YOSYS: null
+      OC_TOOL_INVIO: null
 
   yosys:
     exe: yosys

opencos/eda_tool_helper.py

@@ -21,7 +21,7 @@ from opencos.utils import str_helpers
 def get_config_and_tools_loaded( # pylint: disable=dangerous-default-value
         quiet: bool = False, args: list = []
 ) -> (dict, set):
-    '''Returns config dict and set tools_loaded, given the found config.
+    '''Returns config dict and list tools_loaded, given the found config.
 
     Can BYO args such as --config-yml=MY_OWN_EDA_CONFIG.yml
     '''
@@ -34,7 +34,7 @@ def get_config_and_tools_loaded( # pylint: disable=dangerous-default-value
     # within eda, etc, if you already have a valid config or tools_loaded.
     eda = import_module("opencos.eda")
     config = eda.init_config(config=config, quiet=quiet)
-    tools_loaded = config.get('tools_loaded', set()).copy()
+    tools_loaded = config.get('tools_loaded', []).copy()
 
     return config, tools_loaded
 
@@ -55,7 +55,7 @@ def get_all_handler_commands(config=None, tools_loaded=None) -> dict:
         config, tools_loaded = get_config_and_tools_loaded()
 
     assert isinstance(config, dict)
-    assert isinstance(tools_loaded, set)
+    assert isinstance(tools_loaded, list)
 
     # Let's re-walk auto_tools_order to get this ordered per eda command:
     for command, tools_list in config.get('auto_tools_order', {}).items():
@@ -130,7 +130,7 @@ def get_handler_info_with_versions( # pylint: disable=too-many-branches
     if not config:
         config, tools_loaded = get_config_and_tools_loaded()
     else:
-        tools_loaded = list(config.get('tools_loaded', set()))
+        tools_loaded = list(config.get('tools_loaded', []))
 
     eda_commands = list(config.get('DEFAULT_HANDLERS', {}).keys())
     show_versions = config.get('show_tool_versions', False)

opencos/tools/cocotb.py

@@ -51,14 +51,6 @@ class ToolCocotb(Tool):
 
         return ''
 
-    def set_tool_defines(self):
-        super().set_tool_defines()
-        self.defines.update({
-            'SIMULATION': 1,
-            'COCOTB': 1,
-            'OC_TOOL_COCOTB': None,
-        })
-
 
 class CommandSimCocotb(CommandSim, ToolCocotb):
     '''CommandSimCocotb is a command handler for: eda sim --tool=cocotb'''
@@ -103,9 +95,6 @@ class CommandSimCocotb(CommandSim, ToolCocotb):
         self.cocotb_test_files = []
 
 
-    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:

opencos/tools/invio.py

@@ -26,14 +26,8 @@ class ToolInvio(Tool):
         if not spec:
             self.error('"invio" package not in python env')
 
-
         return super().get_versions()
 
-    def set_tool_defines(self):
-        super().set_tool_defines()
-        self.defines.update({
-            'OC_TOOL_INVIO': None,
-        })
 
 class CommandElabInvio(CommandElab, ToolInvio):
     '''Command handler for: eda elab --tool=invio'''

opencos/tools/iverilog.py

@@ -44,14 +44,6 @@ class ToolIverilog(Tool):
         self._VERSION = version
         return self._VERSION
 
-    def set_tool_defines(self):
-        # TODO(drew): come back to this, Tool doesn't have self.defines. Command does.
-        self.defines.update({
-            'SIMULATION': 1,
-            'IVERILOG': 1,
-            'OC_ASSERT_PROPERTY_NOT_SUPPORTED': 1,
-        })
-
 
 class CommandSimIverilog(CommandSim, ToolIverilog):
     '''CommandSimIverilog is a command handler for: eda sim --tool=iverilog'''
@@ -78,6 +70,7 @@ class CommandSimIverilog(CommandSim, ToolIverilog):
     # We do not override CommandSim.do_it()
     def prepare_compile(self):
         self.set_tool_defines()
+        self.update_library_map()
 
         self.iverilog_command_lists = self.get_compile_command_lists()
         self.iverilog_exec_command_lists  = self.get_simulate_command_lists()
@@ -128,17 +121,25 @@ class CommandSimIverilog(CommandSim, ToolIverilog):
         for value in self.incdirs:
             command_list += [ '-I', value ]
 
-        for k,v in self.defines.items():
-            if v is None:
-                command_list += [ '-D', k ]
-            else:
-                # Generally we should only support int and str python types passed as
-                # +define+{k}={v}, but also for SystemVerilog plusargs
-                command_list += [ '-D', f'{k}={sanitize_defines_for_sh(v)}' ]
+        if self.args['ext-defines-sv-fname']:
+            self.create_ext_defines_sv()
+        else:
+            for k,v in self.defines.items():
+                if v is None:
+                    command_list += [ '-D', k ]
+                else:
+                    # Generally we should only support int and str python types passed as
+                    # +define+{k}={v}, but also for SystemVerilog plusargs
+                    command_list += [ '-D', f'{k}={sanitize_defines_for_sh(v)}' ]
 
         # parameters
+        # If you do -PName=Value, all parameters in the hierachy with Name will be set,
+        # so to only do top level parameters, if hierarchy isn't mentioned in the Name,
+        # would need to do -P{self.args['top'].Name=Value
         command_list.extend(
-            self.process_parameters_get_list(arg_prefix=f'-P{self.args["top"]}.')
+            self.process_parameters_get_list(
+                arg_prefix='-P', hier_delimiter='.', top_hier_str=f'{self.args["top"]}.'
+            )
         )
 
         if not self.files_sv and not self.files_v:

opencos/tools/modelsim_ase.py

@@ -40,18 +40,6 @@ class CommandSimModelsimAse(CommonSimQuesta):
             )
         })
 
-    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_ASSERT_PROPERTY_NOT_SUPPORTED': 1,
-                 'OC_TOOL_MODELSIM_ASE': 1}
-            )
-        )
-
-
 
 class CommandElabModelsimAse(CommandSimModelsimAse):
     '''CommandElabModelsimAse is a command handler for: eda elab --tool=modelsim_ase'''

opencos/tools/quartus.py

@@ -550,9 +550,29 @@ class CommandFListQuartus(CommandFList, ToolQuartus):
         CommandFList.__init__(self, config=config)
         ToolQuartus.__init__(self, config=self.config)
         self.args.update({
-            'emit-parameter': False
+            # synth/project style Flist, can't emit these:
+            'emit-parameter': False,
+            'emit-plusargs': False,
         })
 
+    def get_flist_plusargs_list(self) -> list:
+        '''Overriden from CommandFList.'''
+        if self.args['unprocessed-plusargs']:
+            util.warning('Command "flist" for --tool=quartus is not intended for simulation',
+                         'and plusargs were present. They will NOT be included in the flist:',
+                         f'{self.args["unprocessed-plusargs"]}')
+
+        return []
+
+    def get_flist_parameter_list(self) -> list:
+        '''Overriden from CommandFList.'''
+        if self.parameters:
+            util.warning('Command "flist" for --tool=quartus is not intended for simulation',
+                         'and parameters were present. They will NOT be included in the flist:',
+                         f'{self.parameters}')
+
+        return []
+
 
 class CommandProjQuartus(CommandProj, ToolQuartus):
     '''CommandProjQuartus is a command handler for: eda proj --tool=quartus'''

opencos/tools/questa.py

@@ -39,20 +39,6 @@ class CommandSimQuesta(CommonSimQuesta):
         })
 
 
-    def set_tool_defines(self):
-        '''Override from questa.ToolQuesta'''
-        # Update any defines from config.tools.questa_fse:
-        self.defines.update(
-            self.tool_config.get(
-                'defines',
-                # defaults, if not set:
-                {
-                 'OC_TOOL_QUESTA': 1
-                }
-            )
-        )
-
-
 class CommandElabQuesta(CommandSimQuesta):
     '''CommandElabQuesta is a command handler for: eda elab --tool=questa'''