Skip to main content

Zuspec Software Backend

The Zuspec Software (SW) Backend transforms Zuspec hardware component models into executable C/C++ code for simulation, testing, and modeling.

Features

  • Component Translation: Zuspec Components → C structs and functions

  • Async/Sync: Transforms async methods with optional sync conversion

  • Protocol Interfaces: Generates C API structs for Protocol types

  • Type Mapping: Maps Zuspec types to C types

  • Validation: Pre-generation compatibility checks

  • Compilation: Built-in GCC compiler interface

  • Test Execution: Automated test runner

  • Type Specialization: Optional monomorphization (experimental)

  • PSS → C (scenario path): compile PSS actions/activities/constraints to a self-contained C program via the shared Scenario Runtime IR — runtime constraint solving (dv-solve), sequential/repeat activities, and parallel/timed concurrency on the zsp_timebase scheduler. See docs/pss-to-c.md and examples/pss/. Independent of the datamodel-driven CGenerator below:

    from zuspec.be.sw.scenario import generate_c_files, build_executable
    srcs = generate_c_files(["examples/pss/02_constrained_regs.pss"], "out/", root="pss_top")
    build_executable(srcs, "out/case", "out/")   # → ./out/case <seed> <iters>
    

Installation

pip install zuspec-be-sw

Quick Start

import zuspec.dataclasses as zdc
from zuspec.be.sw import CGenerator, CValidator, CCompiler, TestRunner
from pathlib import Path

@zdc.dataclass
class Counter(zdc.Component):
    count: int = zdc.field(default=0)
    
    def increment(self):
        self.count += 1
    
    def get_count(self) -> int:
        return self.count

# Build → Validate → Generate → Compile → Run
factory = zdc.DataModelFactory()
ctxt = factory.build(Counter)

validator = CValidator()
assert validator.validate(ctxt)

gen = CGenerator(Path("output"))
sources = gen.generate(ctxt)

compiler = CCompiler(Path("output"))
exe = compiler.compile(sources, Path("output/test"))

runner = TestRunner()
result = runner.run(exe)

Generated C Code

typedef struct Counter {
    int count;
} Counter;

void Counter_init(Counter *self);
void Counter_increment(Counter *self);
int Counter_get_count(Counter *self);

Documentation

Requirements

  • Python >= 3.7
  • zuspec-dataclasses
  • C compiler (GCC)

License

Apache-2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zuspec_be_sw-0.1.0-py3-none-any.whl (255.6 kB view details)

Uploaded Python 3

File details

Details for the file zuspec_be_sw-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: zuspec_be_sw-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 255.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.15

File hashes

Hashes for zuspec_be_sw-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3bce7029cb282274c37be24ac2eb530d9859843197dee57ead2f9152a632c0b8
MD5 2ddff1f5c251f9bf5de7c18007cef089
BLAKE2b-256 2241322037f1f3621d8f3dde2023c266eae6be1306e872b9f69273ddd2a59455

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.0 This release

1 file

0.0.9

15 files

0.0.8

15 files

0.0.7

15 files

0.0.5

5 files

0.0.4

5 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page