siliconcompiler 0.35.3__py3-none-any.whl → 0.35.4__py3-none-any.whl

siliconcompiler/constraints/asic_timing.py

@@ -1,4 +1,4 @@
-from typing import Union, Set, List, Tuple
+from typing import Union, Set, List, Tuple, Optional
 
 from siliconcompiler.schema import BaseSchema, NamedSchema, EditableSchema, Parameter, \
     PerNode, Scope
@@ -14,7 +14,7 @@ class ASICTimingScenarioSchema(NamedSchema):
     operating mode, SDC filesets, and timing checks to be performed.
     """
 
-    def __init__(self, name: str = None):
+    def __init__(self, name: Optional[str] = None):
         super().__init__()
         self.set_name(name)
 
@@ -126,7 +126,7 @@ class ASICTimingScenarioSchema(NamedSchema):
     def set_pin_voltage(self,
                         pin: str,
                         voltage: float,
-                        step: str = None, index: Union[str, int] = None):
+                        step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the voltage for a specified pin.
 
@@ -140,7 +140,8 @@ class ASICTimingScenarioSchema(NamedSchema):
 
     def get_pin_voltage(self,
                         pin: str,
-                        step: str = None, index: Union[str, int] = None) -> float:
+                        step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> float:
         """
         Gets the voltage of a specified pin.
 
@@ -162,7 +163,7 @@ class ASICTimingScenarioSchema(NamedSchema):
     def add_libcorner(self,
                       libcorner: Union[List[str], str],
                       clobber: bool = False,
-                      step: str = None, index: Union[str, int] = None):
+                      step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Adds a library corner to the design.
 
@@ -179,8 +180,8 @@ class ASICTimingScenarioSchema(NamedSchema):
         else:
             return self.add("libcorner", libcorner, step=step, index=index)
 
-    def get_libcorner(self,
-                      step: str = None, index: Union[str, int] = None) -> Set[str]:
+    def get_libcorner(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> Set[str]:
         """
         Gets the set of library corners.
 
@@ -195,7 +196,7 @@ class ASICTimingScenarioSchema(NamedSchema):
 
     def set_pexcorner(self,
                       pexcorner: str,
-                      step: str = None, index: Union[str, int] = None):
+                      step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the parasitic extraction (PEX) corner for the design.
 
@@ -207,7 +208,7 @@ class ASICTimingScenarioSchema(NamedSchema):
         return self.set("pexcorner", pexcorner, step=step, index=index)
 
     def get_pexcorner(self,
-                      step: str = None, index: Union[str, int] = None) -> str:
+                      step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> str:
         """
         Gets the parasitic extraction (PEX) corner currently set for the design.
 
@@ -222,7 +223,7 @@ class ASICTimingScenarioSchema(NamedSchema):
 
     def set_mode(self,
                  mode: str,
-                 step: str = None, index: Union[str, int] = None):
+                 step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the operational mode for the design.
 
@@ -234,7 +235,7 @@ class ASICTimingScenarioSchema(NamedSchema):
         return self.set("mode", mode, step=step, index=index)
 
     def get_mode(self,
-                 step: str = None, index: Union[str, int] = None) -> str:
+                 step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> str:
         """
         Gets the operational mode currently set for the design.
 
@@ -249,7 +250,7 @@ class ASICTimingScenarioSchema(NamedSchema):
 
     def set_opcond(self,
                    opcond: str,
-                   step: str = None, index: Union[str, int] = None):
+                   step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the operating condition for the design.
 
@@ -261,7 +262,7 @@ class ASICTimingScenarioSchema(NamedSchema):
         return self.set("opcond", opcond, step=step, index=index)
 
     def get_opcond(self,
-                   step: str = None, index: Union[str, int] = None) -> str:
+                   step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> str:
         """
         Gets the operating condition currently set for the design.
 
@@ -276,7 +277,7 @@ class ASICTimingScenarioSchema(NamedSchema):
 
     def set_temperature(self,
                         temperature: float,
-                        step: str = None, index: Union[str, int] = None):
+                        step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the temperature for the design.
 
@@ -287,8 +288,8 @@ class ASICTimingScenarioSchema(NamedSchema):
         """
         return self.set("temperature", temperature, step=step, index=index)
 
-    def get_temperature(self,
-                        step: str = None, index: Union[str, int] = None) -> float:
+    def get_temperature(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> float:
         """
         Gets the temperature currently set for the design.
 
@@ -305,7 +306,7 @@ class ASICTimingScenarioSchema(NamedSchema):
                        design: Union[Design, str],
                        fileset: str,
                        clobber: bool = False,
-                       step: str = None, index: Union[str, int] = None):
+                       step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Adds an SDC fileset for a given design.
 
@@ -337,8 +338,8 @@ class ASICTimingScenarioSchema(NamedSchema):
         else:
             return self.add("sdcfileset", (design, fileset), step=step, index=index)
 
-    def get_sdcfileset(self,
-                       step: str = None, index: Union[str, int] = None) -> List[Tuple[str, str]]:
+    def get_sdcfileset(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> List[Tuple[str, str]]:
         """
         Gets the list of SDC filesets.
 
@@ -354,7 +355,7 @@ class ASICTimingScenarioSchema(NamedSchema):
     def add_check(self,
                   check: Union[List[str], str],
                   clobber: bool = False,
-                  step: str = None, index: Union[str, int] = None):
+                  step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Adds a check to the design process.
 
@@ -371,7 +372,8 @@ class ASICTimingScenarioSchema(NamedSchema):
         else:
             return self.add("check", check, step=step, index=index)
 
-    def get_check(self, step: str = None, index: Union[str, int] = None) -> Set[str]:
+    def get_check(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> Set[str]:
         """
         Gets the set of checks configured for the design process.
 
@@ -426,7 +428,7 @@ class ASICTimingConstraintSchema(BaseSchema):
 
         EditableSchema(self).insert(scenario.name, scenario, clobber=True)
 
-    def get_scenario(self, scenario: str = None):
+    def get_scenario(self, scenario: Optional[str] = None):
         """
         Retrieves one or all timing scenarios from the configuration.
 
@@ -490,6 +492,35 @@ class ASICTimingConstraintSchema(BaseSchema):
         self.add_scenario(scenarioobj)
         return scenarioobj
 
+    def copy_scenario(self, scenario: str, name: str, insert: bool = True) \
+            -> ASICTimingScenarioSchema:
+        """
+        Copies an existing timing scenario, renames it, and optionally adds it to the design.
+
+        This method retrieves the scenario identified by ``scenario``, creates a
+        deep copy of it, and renames the copy to ``name``. If ``insert`` is True,
+        the new scenario is immediately added to the configuration.
+
+        Args:
+            scenario (str): The name of the existing scenario to be copied.
+            name (str): The name to assign to the new copied scenario.
+            insert (bool, optional): Whether to add the newly created scenario
+                to the configuration. Defaults to True.
+
+        Returns:
+            ASICTimingScenarioSchema: The newly created copy of the scenario.
+
+        Raises:
+            LookupError: If the source scenario specified by ``scenario`` does not exist.
+        """
+        constraint = EditableSchema(self.get_scenario(scenario)).copy()
+        EditableSchema(constraint).rename(name)
+        if insert:
+            if self.valid(name):
+                raise ValueError(f"{name} already exists")
+            self.add_scenario(constraint)
+        return constraint
+
     def remove_scenario(self, scenario: str) -> bool:
         """
         Removes a timing scenario from the design configuration.

siliconcompiler/constraints/fpga_timing.py

@@ -1,4 +1,4 @@
-from typing import Union
+from typing import Union, Optional
 
 from siliconcompiler.schema import BaseSchema, NamedSchema, EditableSchema, Parameter, \
     PerNode, Scope
@@ -12,7 +12,7 @@ class FPGATimingScenarioSchema(NamedSchema):
     scenario and operating mode.
     """
 
-    def __init__(self, name: str = None):
+    def __init__(self, name: Optional[str] = None):
         super().__init__()
         self.set_name(name)
 
@@ -31,7 +31,7 @@ class FPGATimingScenarioSchema(NamedSchema):
 
     def set_mode(self,
                  mode: str,
-                 step: str = None, index: Union[str, int] = None):
+                 step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the operational mode for the design.
 
@@ -42,8 +42,7 @@ class FPGATimingScenarioSchema(NamedSchema):
         """
         return self.set("mode", mode, step=step, index=index)
 
-    def get_mode(self,
-                 step: str = None, index: Union[str, int] = None) -> str:
+    def get_mode(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> str:
         """
         Gets the operational mode currently set for the design.
 
@@ -98,7 +97,7 @@ class FPGATimingConstraintSchema(BaseSchema):
 
         EditableSchema(self).insert(scenario.name, scenario, clobber=True)
 
-    def get_scenario(self, scenario: str = None):
+    def get_scenario(self, scenario: Optional[str] = None):
         """
         Retrieves one or all timing scenarios from the configuration.
 

siliconcompiler/data/templates/replay/replay.sh.j2

@@ -4,10 +4,27 @@ if [ "${BASH_SOURCE[0]}" != "$0" ]; then
     return
 fi
 
+__print_help() {
+    # Print help information for this file
+    echo "Usage: $0"
+    echo "  Options:"
+    echo "    --which           print which executable would be used"
+    echo "    --version         print the version of the executable, if supported"
+    echo "    --directory       print the execution directory"
+    echo "    --command         print the execution command"
+    echo "    --skipcd          do not change directory into replay directory"
+    echo "    --skipexports     do not export environmental variables"
+    echo "    --cmdprefix <cmd> prefix to add to the replay command, such as gdb"
+    echo "    --cmdarg <args>   prefix to add to the replay command, such as -gui"
+    echo "    --node            execute entire node"
+    echo "    -h,--help         print this help"
+}
+
 # Parse replay arguments
 CD_WORK="{{ work_dir }}"
 PRINT=""
 CMDPREFIX=""
+CMDARGS=""
 SKIPEXPORT=0
 DONODE={{ node_only }}
 while [[ $# -gt 0 ]]; do
@@ -41,27 +58,22 @@ while [[ $# -gt 0 ]]; do
             shift
             shift
             ;;
+        --cmdarg)
+            CMDARGS="$2"
+            shift
+            shift
+            ;;
         --node)
             DONODE=1
             shift
-            shift
             ;;
         -h|--help)
-            echo "Usage: $0"
-            echo "  Options:"
-            echo "    --which           print which executable would be used"
-            echo "    --version         print the version of the executable, if supported"
-            echo "    --directory       print the execution directory"
-            echo "    --command         print the execution command"
-            echo "    --skipcd          do not change directory into replay directory"
-            echo "    --skipexports     do not export environmental variables"
-            echo "    --cmdprefix <cmd> prefix to add to the replay command, such as dgb"
-            echo "    --node            execute entire node"
-            echo "    -h,--help         print this help"
+            __print_help
             exit 0
             ;;
         *)
             echo "Unknown option $1"
+            __print_help
             exit 1
             ;;
     esac
@@ -105,5 +117,6 @@ python3 -m siliconcompiler.scheduler.run_node \
 {% if cmds|length > 0 %}else
 # Command execution
 $CMDPREFIX \{% for cmd in cmds %}
-{% if not loop.first %}  {% endif %}{{ cmd }}{% if not loop.last %} \{% endif %}{% endfor %}
-{% endif %}fi
+{% if not loop.first %}  {% endif %}{{ cmd }} \{% endfor %}
+{% endif %}  ${CMDARGS}
+fi

siliconcompiler/package/__init__.py

@@ -16,6 +16,7 @@ import logging
 import os
 import random
 import re
+import shutil
 import time
 import threading
 import uuid
@@ -29,7 +30,8 @@ from importlib.metadata import distributions, distribution
 from pathlib import Path
 from urllib import parse as url_parse
 
-from siliconcompiler.utils import get_plugins
+from siliconcompiler.utils import get_plugins, default_cache_dir
+from siliconcompiler.utils.paths import cwdirsafe
 
 if TYPE_CHECKING:
     from siliconcompiler.project import Project
@@ -370,7 +372,7 @@ class RemoteResolver(Resolver):
         Returns:
             Path: The path to the cache directory.
         """
-        default_path = os.path.join(Path.home(), '.sc', 'cache')
+        default_path = default_cache_dir()
         if not root:
             return Path(default_path)
 
@@ -380,8 +382,7 @@ class RemoteResolver(Resolver):
             if path:
                 path = root.find_files('option', 'cachedir', missing_ok=True)
                 if not path:
-                    path = os.path.join(getattr(root, "_Project__cwd", os.getcwd()),
-                                        root.get('option', 'cachedir'))
+                    path = os.path.join(cwdirsafe(root), root.get('option', 'cachedir'))
         if not path:
             path = default_path
 
@@ -543,7 +544,17 @@ class RemoteResolver(Resolver):
             if self.check_cache():
                 return self.cache_path
 
-            self.resolve_remote()
+            try:
+                self.resolve_remote()
+            except BaseException as e:
+                # Exception occurred, so need to cleanup
+                try:
+                    shutil.rmtree(self.cache_path)
+                except BaseException as cleane:
+                    self.logger.error(f"Exception occurred during cleanup: {cleane} "
+                                      f"({cleane.__class__.__name__})")
+                raise e from None
+
             self.set_changed()
             return self.cache_path
 
@@ -560,7 +571,7 @@ class FileResolver(Resolver):
         if source.startswith("file://"):
             source = source[7:]
         if source[0] != "$" and not os.path.isabs(source):
-            source = os.path.join(getattr(root, "_Project__cwd", os.getcwd()), source)
+            source = os.path.join(cwdirsafe(root), source)
 
         super().__init__(name, root, f"file://{source}", None)
 

siliconcompiler/project.py

@@ -394,13 +394,21 @@ class Project(PathSchemaBase, CommandLineSchema, BaseSchema):
             return
 
         edit_schema = EditableSchema(self)
-        edit_schema.insert("flowgraph", flow.name, flow)
 
         # Instantiate tasks
         for task_cls in flow.get_all_tasks():
             task = task_cls()
             if not self.valid("tool", task.tool(), "task", task.task()):
                 edit_schema.insert("tool", task.tool(), "task", task.task(), task)
+            else:
+                existing_task: Task = self.get("tool", task.tool(), "task", task.task(),
+                                               field="schema")
+                if type(existing_task) is not type(task):
+                    raise TypeError(f"Task {task.tool()}/{task.task()} already exists with "
+                                    f"different type {type(existing_task).__name__}, "
+                                    f"imported type is {type(task).__name__}")
+
+        edit_schema.insert("flowgraph", flow.name, flow)
 
     def check_manifest(self) -> bool:
         """

siliconcompiler/scheduler/docker.py

@@ -3,6 +3,8 @@ import os
 import shlex
 import sys
 
+import docker.errors
+
 from pathlib import Path
 
 import siliconcompiler
@@ -11,10 +13,9 @@ from siliconcompiler.package import RemoteResolver
 from siliconcompiler.utils import default_email_credentials_file
 from siliconcompiler.scheduler import SchedulerNode
 from siliconcompiler.utils.logging import SCBlankLoggerFormatter
-from siliconcompiler.utils.curation import collect
 
 
-def get_image(project, step, index):
+def get_image(project, step, index) -> str:
     """Determines the Docker image to use for a given node.
 
     The image is selected based on the following priority:
@@ -32,7 +33,7 @@ def get_image(project, step, index):
     """
     from siliconcompiler import __version__
 
-    queue = project.get('option', 'scheduler', 'queue', step=step, index=index)
+    queue = project.option.scheduler.get_queue(step=step, index=index)
     if queue:
         return queue
 
@@ -161,24 +162,24 @@ class DockerSchedulerNode(SchedulerNode):
         """
         A static pre-processing hook for the Docker scheduler.
 
-        On Windows, this method forces all file/directory parameters to be
-        copied rather than linked, which avoids issues with differing
-        filesystem types between the host and the Linux-based container.
-        It then triggers :meth:`.collect()` to ensure all files are staged.
-
         Args:
             project (Project): The project object to perform pre-processing on.
         """
-        if sys.platform == 'win32':
-            # this avoids the issue of different file system types
-            project.logger.error('Setting copy field to true for docker run on Windows')
-            for key in project.allkeys():
-                if key[0] == 'history':
-                    continue
-                sc_type = project.get(*key, field='type')
-                if 'dir' in sc_type or 'file' in sc_type:
-                    project.set(*key, True, field='copy')
-            collect(project)
+        try:
+            client = docker.from_env()
+            client.version()
+        except (docker.errors.DockerException, docker.errors.APIError):
+            raise RuntimeError('docker is not available or installed on this machine')
+
+    def mark_copy(self) -> bool:
+        if sys.platform != 'win32':
+            return False
+
+        do_collect = False
+        for key in self.get_required_path_keys():
+            self.project.set(*key, True, field='copy')
+            do_collect = True
+        return do_collect
 
     def run(self):
         """
@@ -196,12 +197,7 @@ class DockerSchedulerNode(SchedulerNode):
         """
         self._init_run_logger()
 
-        try:
-            client = docker.from_env()
-            client.version()
-        except (docker.errors.DockerException, docker.errors.APIError) as e:
-            self.logger.error(f'Unable to connect to docker: {e}')
-            self.halt()
+        client = docker.from_env()
 
         is_windows = sys.platform == 'win32'
 
@@ -233,7 +229,7 @@ class DockerSchedulerNode(SchedulerNode):
         email_file = default_email_credentials_file()
         if is_windows:
             # Hack to get around manifest merging
-            self.project.set('option', 'cachedir', None)
+            self.project.option.set_cachedir(None)
             cache_dir = '/sc_cache'
             cwd = '/sc_docker'
             builddir = f'{cwd}/build'
@@ -347,3 +343,6 @@ class DockerSchedulerNode(SchedulerNode):
 
         # Restore working directory
         os.chdir(start_cwd)
+
+    def check_required_paths(self) -> bool:
+        return True