opencos-eda 0.2.38__tar.gz → 0.2.40__tar.gz

{opencos_eda-0.2.38/opencos_eda.egg-info → opencos_eda-0.2.40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.38
+Version: 0.2.40
 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.38 → opencos_eda-0.2.40}/opencos/commands/multi.py

@@ -392,7 +392,9 @@ class CommandMulti(CommandParallel):
             # Special case for 'multi' --export-jsonl, run reach child with --export-json
             command_list.append('--export-json')
         if tool and len(all_multi_tools) > 1:
-            command_list.append(f'--sub-work-dir={short_target}.{command}.{tool}')
+            command_list.append(f'--job-name={short_target}.{command}.{tool}')
+        else:
+            command_list.append(f'--job-name={short_target}.{command}')
 
     def append_jobs_from_targets(self, args:list):
         '''Helper method in CommandMulti to apply 'args' (list) to all self.targets,
@@ -430,13 +432,15 @@ class CommandMulti(CommandParallel):
                type(self.args['single-timeout']) in [int, str]:
                 command_list = ['timeout', str(self.args['single-timeout'])] + command_list
 
-            name = target
+            name = self.get_name_from_target(target)
             if tool and (len(all_multi_tools) > 1 or self.command_name == 'tools-multi'):
-                name = f'{short_target} ({tool})'
+                name += f' ({tool})'
 
             this_job_dict = {
                 'name' : name,
                 'index' : len(self.jobs),
+                'command': command,
+                'target': target,
                 'command_list' : command_list
             }
             if tool:

{opencos_eda-0.2.38 → opencos_eda-0.2.40}/opencos/commands/sweep.py

@@ -113,6 +113,9 @@ class CommandSweep(CommandDesign, CommandParallel):
         util.debug(f"Sweep: arg_tokens: '{arg_tokens}'")
         util.debug(f"Sweep: target:     '{self.sweep_target}'")
 
+        if not self.sweep_target:
+            self.error(f"Sweep can only take one target, found none, args: {unparsed}")
+
         # now create the list of jobs, support one axis
         self.jobs = []
 
@@ -197,15 +200,20 @@ class CommandSweep(CommandDesign, CommandParallel):
                    f"target={self.sweep_target}, arg_tokens={arg_tokens},",
                    f"sweep_axis_list={sweep_axis_list}")
         if not sweep_axis_list:
-            # we aren't sweeping anything, create one job
-            snapshot_name = self.sweep_target.replace('../','').replace('/','_') + sweep_string
+            # we aren't sweeping anything, create one job:
+            # name {target}.{command}[.sweep_value,.sweep_value,...]
+            snapshot_name = self.get_name_from_target(self.sweep_target)
+            snapshot_name = snapshot_name.replace(os.sep, '_') \
+                + f'.{self.single_command}{sweep_string}'
             eda_path = get_eda_exec('sweep')
             self.jobs.append({
                 'name' : snapshot_name,
                 'index' : len(self.jobs),
+                'command': self.single_command,
+                'target': self.sweep_target,
                 'command_list' : (
                     [eda_path, self.single_command, self.sweep_target,
-                     '--job_name', snapshot_name] + arg_tokens
+                     f'--job-name={snapshot_name}'] + arg_tokens
                 )
             })
             return
@@ -221,7 +229,7 @@ class CommandSweep(CommandDesign, CommandParallel):
             this_arg_tokens.append(f'{lhs}{operator}{v}')
 
             v_string = f"{v}".replace('.','p')
-            this_sweep_string = sweep_string + f"_{lhs_trimmed}_{v_string}"
+            this_sweep_string = sweep_string + f".{lhs_trimmed}_{v_string}"
 
             self.expand_sweep_axis(
                 arg_tokens=this_arg_tokens,

{opencos_eda-0.2.38 → opencos_eda-0.2.40}/opencos/eda_base.py

@@ -11,6 +11,7 @@ import signal
 import sys
 import threading
 import time
+from pathlib import Path
 
 import opencos
 from opencos import seed, deps_helpers, util, files
@@ -177,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,
@@ -184,24 +186,31 @@ class Command:
             'export-json': False,      # generates an export.json suitable for a testrunner, if possible for self.command.
             'enable-tags': [],
             'disable-tags': [],
+            'test-mode': False,
         })
         self.args_help.update({
-            'stop-before-compile': 'stop this run before any compile (if possible for tool) and' \
-            + ' save .sh scripts in eda-dir/',
+            'stop-before-compile': ('stop this run before any compile (if possible for tool) and'
+                                    ' save .sh scripts in eda-dir/'),
             'eda-dir':     'relative directory where eda logs are saved',
             'export':      'export results for these targets in eda-dir',
             'export-run':  'export, and run, results for these targets in eda-dir',
             'export-json': 'export, and save a JSON file per target',
-            'work-dir':    'Optional override for working directory, often defaults to ./eda.work/<top>.<command>',
-            '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' \
-            + ' match the criteria) for this command (mulitple appends to list).' \
-            + ' --disable-tags has higher precedence than --enable-tags.'
+            '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'
+                            ' match the criteria) for this command (mulitple appends to list).'
+                            ' --disable-tags has higher precedence than --enable-tags.'),
+            'test-mode': ('command and tool dependent, usually stops the command early without'
+                          ' executing.'),
         })
         self.modified_args = {}
         self.config = copy.deepcopy(config) # avoid external modifications.
         self.target = ""
+        self.target_path = ""
         self.status = 0
 
     def error(self, *args, **kwargs):
@@ -223,8 +232,18 @@ class Command:
 
     def create_work_dir(self):
         util.debug(f"create_work_dir: {self.args['eda-dir']=} {self.args['work-dir']=}")
-        if (not os.path.exists(self.args['eda-dir'])): # use os.path.isfile / isdir also
-            os.mkdir(self.args['eda-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']}")
         if self.args['design'] == "":
             if ('top' in self.args) and (self.args['top'] != ""):
@@ -250,14 +269,35 @@ class Command:
         if (os.path.exists(self.args['work-dir'])):
             if os.path.exists(keep_file) and not self.args['force']:
                 self.error(f"Cannot remove old work dir due to '{keep_file}'")
-            util.info(f"Removing previous '{self.args['work-dir']}'")
-            shutil.rmtree(self.args['work-dir'])
-        os.mkdir(self.args['work-dir'])
-        util.debug(f'create_work_dir: created {self.args["work-dir"]}')
+            elif os.path.abspath(self.args['work-dir']) in os.getcwd():
+                # This effectively checks if
+                # --work-dir=.
+                # --work-dir=$PWD
+                # --work-dir=/some/path/almost/here
+                # Allow it, but preserve the existing directory, we don't want to blow away
+                # files up-heir from us.
+                # Enables support for --work-dir=.
+                util.info(f"Not removing existing work-dir: '{self.args['work-dir']}' is within {os.getcwd()=}")
+            elif str(Path(self.args['work-dir'])).startswith(str(Path('/'))):
+                # Do not allow other absolute path work dirs if it already exists.
+                # This prevents you from --work-dir=~ and eda wipes out your home dir.
+                self.error(f'Cannot use work-dir={self.args["work-dir"]} starting with absolute path "/"')
+            elif str(Path('..')) in str(Path(self.args['work-dir'])):
+                # Do not allow other ../ work dirs if it already exists.
+                self.error(f'Cannot use work-dir={self.args["work-dir"]} with up-hierarchy ../ paths')
+            else:
+                # If we made it this far, on a directory that exists, that appears safe
+                # to delete and re-create:
+                util.info(f"Removing previous '{self.args['work-dir']}'")
+                shutil.rmtree(self.args['work-dir'])
+                util.safe_mkdir(self.args['work-dir'])
+                util.debug(f'create_work_dir: created {self.args["work-dir"]}')
+        else:
+            util.safe_mkdir(self.args['work-dir'])
+            util.debug(f'create_work_dir: created {self.args["work-dir"]}')
         if (self.args['keep']):
             open(keep_file, 'w').close()
-            util.debug(f'create_work_dir: created {keep_file}')
-        util.info(f'create_work_dir: created {self.args["work-dir"]}')
+            util.debug(f'create_work_dir: created {keep_file=}')
         return self.args['work-dir']
 
     def exec(self, work_dir, command_list, background=False, stop_on_error=True,
@@ -858,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.
@@ -1361,6 +1401,8 @@ class CommandParallel(Command):
         fancy_mode = util.args['fancy'] and (num_parallel > 1) and (num_parallel <= (lines-6))
         multi_cwd = util.getcwd() + os.sep
 
+        self.patch_jobs_for_duplicate_target_names()
+
         if run_parallel:
             # we are doing this multi-threaded
             util.info(f"Parallel: Running multi-threaded, starting {num_parallel} workers")
@@ -1519,6 +1561,10 @@ class CommandParallel(Command):
             self.status = 0 if len(self.jobs_status) == 0 else max(self.jobs_status)
         util.fancy_stop()
 
+    @staticmethod
+    def get_name_from_target(target: str) -> str:
+        return target.replace('../', '').lstrip('./')
+
 
     def update_args_list(self, args: list, tool: str) -> None:
         '''Modfies list args, using allow-listed known top-level args:
@@ -1572,3 +1618,58 @@ class CommandParallel(Command):
         # Remove unparsed args starting with '+', since those are commonly sent downstream to
         # single job (example, CommandSim plusargs).
         return [x for x in single_cmd_unparsed if not x.startswith('+')]
+
+
+    def patch_jobs_for_duplicate_target_names(self) -> None:
+        '''Examines list self.jobs, and if leaf target names are duplicate will
+        patch each command's job-name to:
+            --job-name=path.leaf.command[.tool]
+        '''
+
+        def get_job_name(job_dict: dict) -> str:
+            '''Fishes the job-name out of an entry in self.jobs'''
+            for i, item in enumerate(job_dict['command_list']):
+                if item.startswith('--job-name='):
+                    _, name = item.split('--job-name=')
+                    return name
+                elif item == '--job-name':
+                    return job_dict['command_list'][i + 1]
+            return ''
+
+        def replace_job_name(job_dict: dict, new_job_name: str) -> dict:
+            '''Replaces the job-name in an entry in self.jobs'''
+            for i, item in enumerate(job_dict['command_list']):
+                if item.startswith('--job-name='):
+                    job_dict['command_list'][i] = '--job-name=' + new_job_name
+                    return job_dict
+                elif item == '--job-name':
+                    job_dict['command_list'][i + 1] = new_job_name
+                    return job_dict
+            return job_dict
+
+
+        job_names_count_dict = {}
+        for job_dict in self.jobs:
+
+            key = get_job_name(job_dict)
+            if not key:
+                self.error(f'{job_dict=} needs to have a --job-name= arg attached')
+            if key not in job_names_count_dict:
+                job_names_count_dict[key] = 1
+            else:
+                job_names_count_dict[key] += 1
+
+        for i, job_dict in enumerate(self.jobs):
+            key = get_job_name(job_dict)
+            if job_names_count_dict[key] < 2:
+                continue
+
+            tpath, _ = os.path.split(job_dict['target'])
+
+            # prepend path information to job-name:
+            patched_sub_work_dir = False
+            patched_target_path = os.path.relpath(tpath).replace(os.sep, '_')
+            new_job_name = f'{patched_target_path}.{key}'
+            new_job_dict = replace_job_name(job_dict, new_job_name)
+            self.jobs[i] = new_job_dict
+            util.debug(f'Patched job {job_dict["name"]}: --job-name={new_job_name}')

{opencos_eda-0.2.38 → opencos_eda-0.2.40}/opencos/tools/iverilog.py

@@ -156,8 +156,10 @@ class CommandSimIverilog(CommandSim, ToolIverilog):
                 # +define+{k}={v}, but also for SystemVerilog plusargs
                 command_list += [ '-D', f'{k}={sanitize_defines_for_sh(v)}' ]
 
-        assert len(self.files_sv) + len(self.files_v) > 0, \
-            f'{self.target=} {self.files_sv=} and {self.files_v=} are empty, cannot call iverilog'
+        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 call iverilog')
 
         command_list += list(self.files_sv) + list(self.files_v)
 

{opencos_eda-0.2.38 → opencos_eda-0.2.40}/opencos/tools/modelsim_ase.py

@@ -178,9 +178,10 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
             '-source',
             ] + list(self.files_sv) + list(self.files_v)
 
-        if len(self.files_sv) + len(self.files_v) == 0:
-            self.error(f'{self.target=} {self.files_sv=} and {self.files_v=} are empty,',
-                       'cannot create a valid vlog.f')
+        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)

{opencos_eda-0.2.38 → opencos_eda-0.2.40}/opencos/tools/verilator.py

@@ -82,11 +82,12 @@ class VerilatorSim(CommandSim, ToolVerilator):
         })
 
         self.args_help.update({
-            'waves':    'Include waveforms, if possible for Verilator by applying' \
-            + ' simulation runtime arg +trace. User will need SV code to interpret the plusarg' \
-            + ' and apply $dumpfile("dump.fst").',
-            'dump-vcd': 'If using --waves, apply simulation runtime arg +trace=vcd. User' \
-            + ' will need SV code to interpret the plusarg and apply $dumpfile("dump.vcd").',
+            'waves':    ('Include waveforms, if possible for Verilator by applying'
+                         ' simulation runtime arg +trace. User will need SV code to interpret the'
+                         'plusarg and apply $dumpfile("dump.fst").'),
+            'dump-vcd': ('If using --waves, apply simulation runtime arg +trace=vcd. User'
+                         ' will need SV code to interpret the plusarg and apply'
+                         ' $dumpfile("dump.vcd").'),
             'lint-only': 'Run verilator with --lint-only, instead of --binary',
             'gui':       'Not supported for Verilator',
             'cc-mode':   'Run verilator with --cc, requires a sim_main.cpp or similar sources',
@@ -227,9 +228,10 @@ class VerilatorSim(CommandSim, ToolVerilator):
                 # +define+{k}={v}, but also for SystemVerilog plusargs
                 verilate_command_list += [ f'+define+{k}={sanitize_defines_for_sh(v)}' ]
 
-        if (len(self.files_sv) + len(self.files_v)) == 0:
-            self.error(f'{self.target=} {self.files_sv=} and {self.files_v=} are empty,',
-                       'cannot call verilator')
+        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 call verilator')
 
         verilate_command_list += list(self.files_sv) + list(self.files_v)
 

{opencos_eda-0.2.38 → opencos_eda-0.2.40}/opencos/tools/vivado.py

@@ -720,7 +720,6 @@ class CommandUploadVivado(CommandUpload, ToolVivado):
             'host': "localhost",
             'port': 3121,
             'tcl-file': "upload.tcl",
-            'test-mode': False,
         })
         # TODO(drew): Add self.args_help.update({...})
 

{opencos_eda-0.2.38 → opencos_eda-0.2.40/opencos_eda.egg-info}/PKG-INFO

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

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