rtl-buddy 2.1.4__py3-none-any.whl

rtl_buddy/__init__.py

@@ -0,0 +1,5 @@
+# rtl-buddy
+# vim: set sw=2:ts=2:et:
+#
+# Copyright 2024 rtl_buddy contributors
+#

rtl_buddy/__main__.py

@@ -0,0 +1,18 @@
+# rtl-buddy
+# vim: set sw=2:ts=2:et:
+#
+# Copyright 2024 rtl_buddy contributors
+#
+import logging
+from .rtl_buddy import RtlBuddy
+
+DESCRIPTION = """
+RTL Buddy is a RTL development build system.
+"""
+
+def main() -> int:
+  rb = RtlBuddy(name='rtl_buddy_inst')
+  return rb.run()
+
+if __name__ == '__main__':
+  raise SystemExit(main())

rtl_buddy/config/__init__.py

@@ -0,0 +1,17 @@
+# rtl-buddy
+# vim: set sw=2:ts=2:et:
+#
+# Copyright 2024 rtl_buddy contributors
+#
+
+# Re-export config classes
+from .test import TestConfig, TestbenchConfig
+from .suite import SuiteConfig
+from .reg import RegConfig
+from .root import RootConfig
+from .platform import PlatformConfig
+from .rtl import RtlBuilderConfig
+from .model import ModelConfig, ModelConfigLoader
+from .verible import VeribleConfig
+from .coverage import CoverageConfig, CoverageConfigFile
+from .coverview import CoverviewConfig, CoverviewConfigFile

rtl_buddy/config/coverage.py

@@ -0,0 +1,41 @@
+import pprint
+
+from dataclasses import dataclass
+from serde import serde, field
+
+
+@dataclass
+class CoverageConfig:
+  """
+  Coverage post-processing configuration for a simulator family.
+
+  Attributes:
+    name (str): Simulator family name, e.g. "verilator" or "vcs".
+    use_lcov (bool): Whether LCOV output should be emitted for this simulator.
+  """
+  name: str
+  use_lcov: bool
+
+  def get_name(self) -> str:
+    return self.name
+
+  def get_use_lcov(self) -> bool:
+    return self.use_lcov
+
+  def __str__(self):
+    return pprint.pformat(self)
+
+
+@serde
+class CoverageConfigFile:
+  """
+  YAML-backed coverage configuration entry.
+  """
+  name: str
+  use_lcov: bool = field(rename='use-lcov', default=False)
+
+  def initialise(self) -> CoverageConfig:
+    return CoverageConfig(
+      name=self.name,
+      use_lcov=self.use_lcov,
+    )

rtl_buddy/config/coverview.py

@@ -0,0 +1,54 @@
+import pprint
+from collections.abc import Mapping
+
+from dataclasses import dataclass
+from serde import serde, field
+
+
+@dataclass
+class CoverviewConfig:
+  """
+  Coverview packaging configuration for a simulator family.
+
+  Attributes:
+    name (str): Simulator family name, e.g. "verilator" or "vcs".
+    config (dict): Inline Coverview JSON-compatible configuration values.
+    generate_tables (str | None): Optional coverage type to use for Coverview tables.
+  """
+  name: str
+  config: dict
+  generate_tables: str | None
+
+  def get_name(self) -> str:
+    return self.name
+
+  def get_config(self) -> dict:
+    return self.config
+
+  def get_generate_tables(self) -> str | None:
+    return self.generate_tables
+
+  def __str__(self):
+    return pprint.pformat(self)
+
+
+@serde
+class CoverviewConfigFile:
+  """
+  YAML-backed Coverview packaging configuration entry.
+  """
+  name: str
+  config: dict = field(default_factory=dict)
+  generate_tables: str | None = field(rename='generate-tables', default=None)
+
+  def initialise(self, root_cfg_path: str) -> CoverviewConfig:
+    del root_cfg_path
+    if not isinstance(self.config, Mapping):
+      raise ValueError(
+        f"cfg-coverview '{self.name}' config must be a mapping of inline Coverview JSON values"
+      )
+    return CoverviewConfig(
+      name=self.name,
+      config=dict(self.config),
+      generate_tables=self.generate_tables,
+    )

rtl_buddy/config/model.py

@@ -0,0 +1,106 @@
+import logging
+logger = logging.getLogger(__name__)
+import pprint
+
+from serde import serde, field
+from serde.yaml import from_yaml
+from typing import Literal
+
+from ..errors import FatalRtlBuddyError
+from ..logging_utils import log_event
+
+@serde
+class ModelConfig:
+  """
+  Representation of a single model entry in a 'model_config' file
+
+  Attributes
+    name (str): Unique model identifier.
+    filelist (list[str]): List of paths to files associated with the model.
+    path (str|None): Path to the model config file. Will usually be set by the loader.
+  """
+  name: str
+  filelist: list[str]
+  path: str|None
+  
+  def get_model_name(self):
+    """
+    Retrieve the value of model_name.
+
+    Returns:
+    model_name (str): The value of model_name in the model.
+    """
+    return self.model_name
+
+  def get_model_path(self):
+    """
+    Retrieve the value of path.
+
+    Returns:
+    path (str): The value of path in the model. The path to the model config file.
+    """
+    return self.path
+
+  def get_filelist(self):
+    """
+    Retrieve the value of filelist.
+
+    Returns:
+    filelist (list[str]): The value of filelist in the model.
+    """
+    return self.filelist
+
+  def __str__(self):
+    return pprint.pformat(self)
+
+@serde
+class ModelConfigFile:
+  """
+  Representation of a 'model_config' file.
+
+  Attributes
+    rtl_buddy_filetype (Literal['model_config']): Config file type. Must be 'model_config'.
+    models (list[RawModelConfig]): List of model configurations.
+  """
+  rtl_buddy_filetype: Literal['model_config'] = field(rename='rtl-buddy-filetype')
+  models: list[ModelConfig] = field(default_factory=list)
+
+# TODO: Raise errors instead of killing things here
+class ModelConfigLoader:
+  """
+  Helper class to load model configurations from a file. Reads the file once.
+
+  Attributes:
+    models(list[RawModelConfig]): List of raw model configs.
+  """
+  def __init__(self, path:str) -> None:
+    self.path = path
+    self.models = []
+    
+    try:
+      with open(self.path, 'r') as file:
+        data = from_yaml(ModelConfigFile, file.read())
+        self.models = data.models
+    except Exception as e:
+      log_event(logger, logging.ERROR, "model_config.load_failed", path=path, error=e)
+      raise FatalRtlBuddyError(f'failed to load "{path}"') from e
+ 
+  def get_model(self, model_name:str) -> ModelConfig:
+    """
+    Get a ModelConfig according to model_name.
+
+    Args:
+      name (str): Unique system identifier for the model.
+      model_name (str): Unique identifier for the model in file.
+    Returns:
+      model (ModelConfig): The model configuration.
+    Raises:
+      Panics if no model corresponding to model_name can be found.
+    """
+    for model in self.models:
+      if model.name == model_name:
+        model.path = self.path
+        return model
+
+    log_event(logger, logging.ERROR, "model_config.model_not_found", model=model_name, path=self.path)
+    raise FatalRtlBuddyError(f"model '{model_name}' not found")

rtl_buddy/config/platform.py

@@ -0,0 +1,108 @@
+import logging
+logger = logging.getLogger(__name__)
+import pprint
+
+from dataclasses import dataclass
+from serde import serde, field
+from .rtl import RtlBuilderConfig
+from .verible import VeribleConfig
+from ..errors import FatalRtlBuddyError
+from ..logging_utils import log_event
+
+@dataclass
+class PlatformConfig:
+  """
+  Configuration entry defining a single test platoform.
+
+  Attributes:
+    os (str): Target OS of platform.
+    unames (list[str]): List of supported unames for the platform.
+    builder (str | None): Name of builder configuration associated with the platform.
+    verible (str): Name of verible configuration associated with the platform.
+  """
+  os: str
+  unames: list[str]
+  builder: RtlBuilderConfig
+  verible: VeribleConfig
+
+  def get_os(self) -> str:
+    """
+    Retrieve the value of os.
+
+    Returns:
+      os (str): The value of os
+    """
+    return self.os
+
+  def get_builder(self) -> RtlBuilderConfig:
+    """
+    Get the value of builder
+
+    Returns:
+      builder (RtlBuilderConfig): The value of builder.
+    """
+    return self.builder
+
+  def get_verible(self) -> VeribleConfig:
+    """
+    Get the value of verible.
+
+    Returns:
+      verible_name (str): The value of verible.
+    """
+    return self.verible
+
+  def __str__(self) -> str:
+    return pprint.pformat(self)
+
+@serde
+class PlatformConfigFile:
+  os: str
+  unames: list[str]
+  builder: str | None
+  verible: str
+
+  def initialise(self, builders:dict[str, RtlBuilderConfig], veribles:dict[str, VeribleConfig], builder_override:str|None) -> PlatformConfig:
+    builder = None
+    if self.builder is not None:
+      if self.builder not in builders:
+          log_event(logger, logging.ERROR, "platform.builder_missing", builder=self.builder, os=self.os)
+          raise FatalRtlBuddyError(f'"{self.builder}" not in root config')
+
+      builder = builders[self.builder]
+
+    if builder_override is not None:
+      log_event(logger, logging.INFO, "platform.builder_override", builder=builder_override, configured_builder=self.builder, os=self.os)
+      if builder_override not in builders:
+        log_event(logger, logging.ERROR, "platform.builder_override_missing", builder=builder_override, os=self.os)
+        raise FatalRtlBuddyError(f'Builder override "{builder_override}" is not in root config.')
+
+      builder = builders[builder_override]
+
+    if builder is None:
+      log_event(logger, logging.ERROR, "platform.builder_unset", os=self.os)
+      raise FatalRtlBuddyError("Both builder and builder_override are not set. Builder is None")
+
+    if self.verible not in veribles:
+      log_event(logger, logging.ERROR, "platform.verible_missing", verible=self.verible, os=self.os)
+      raise FatalRtlBuddyError(f'"{self.verible}" not in verible config')
+
+    return PlatformConfig(self.os, self.unames, builder, veribles[self.verible])
+
+  def get_os(self) -> str:
+    """
+    Retrieve the value of os.
+
+    Returns:
+      os (str): The value of os
+    """
+    return self.os
+
+  def get_unames(self) -> list[str]:
+    """
+    Retrieve the value of unames, the list of unames supported by the platform.
+
+    Returns:
+      unames (list[str]): The value of unames.
+    """
+    return self.unames

rtl_buddy/config/reg.py

@@ -0,0 +1,84 @@
+import logging
+logger = logging.getLogger(__name__)
+import pprint
+import os
+
+from serde import serde, field, SerdeError
+from serde.yaml import from_yaml
+from typing import Literal
+from .suite import SuiteConfig
+from ..errors import FatalRtlBuddyError
+from ..logging_utils import log_event
+
+@serde
+class RegConfigFile:
+  """
+  Representation of a "reg_config' file.
+
+  Attributes
+    rtl_buddy_filetype (Literal['reg_config']): Config file type. Must be 'reg_config'.
+    test_configs (list[str]): List of paths to test configurations.
+  """
+  rtl_buddy_filetype: Literal['reg_config'] = field(rename='rtl-buddy-filetype')
+  test_configs: list[str] = field(rename='test-configs', default_factory=list)
+
+class RegConfig:
+  """
+  Configuration for a set of regression tests.
+
+  Attributes:
+    name (str): Unique regression test identifier.
+    path (str): Path to the regression test file.
+    test_configs (list[str]): List of paths to test suite files defining tests in the regression test.
+  """
+
+  def __init__(self, name:str, path:str) -> None:
+    """
+    Initialise a RegConfig given a path to a YAML configuration file.
+
+    Args:
+      name (str): Unique regression test identifier.
+      path (str): Path to the regression test configuration file.
+    Raises:
+      SystemExitError: If there was an error parsing the file.
+    """
+    self.name = name
+    self.path = path
+    self.suite_configs = []
+    try:
+      with open(path, 'r') as file:
+        data = from_yaml(RegConfigFile, file.read())
+        self.suite_configs = list(map(lambda suite_path: SuiteConfig(os.path.join(os.path.dirname(self.path), suite_path)), data.test_configs))
+    except Exception as e:
+      log_event(logger, logging.ERROR, "regression_config.load_failed", name=self.name, path=path, error=e)
+      raise FatalRtlBuddyError(f'{self.name}: failed to load "{path}"') from e
+
+  def get_name(self):
+    """
+    Retrieve the value of name
+
+    Returns:
+    name (str): The name of the regression test
+    """
+    return self.name
+
+  def get_path(self):
+    """
+    Retrieve the value of path
+
+    Returns
+    path (str): The value of path in the regression test
+    """
+    return self.path
+
+  def get_suite_configs(self):
+    """
+    Retrieve the value of suite_configs
+
+    Returns
+    test_configs (list[SuiteConfig]): The value of suite_configs in the regression test
+    """
+    return self.suite_configs
+
+  def __str__(self):
+    return pprint.pformat(self)