loop_timing_witness

Repository paths are shown relative to the source tree.

Python Library Documentation: package loop_timing_witness

NAME
    loop_timing_witness - Hash-bound timing, tracking and power analysis for Loop Timing Witness.

DESCRIPTION
    Manifest utilities load independently of analysis and schema validation.
    The public analysis exports are resolved when they are first requested.

PACKAGE CONTENTS
    amp_build_dependencies
    amp_capture_observations
    amp_collisions
    amp_completion
    amp_contract
    amp_device
    amp_elf
    amp_elf_symbols
    amp_exit_channel
    amp_image_contract
    amp_image_dependencies
    amp_image_options
    amp_image_receipt
    amp_memory
    amp_platform
    amp_plugin_receipt
    amp_plugin_snapshot
    amp_report_completion
    amp_run_input
    amp_runtime_snapshot
    amp_rust_dependencies
    amp_rust_receipt
    amp_rust_vectors
    amp_simulation_manifest
    analyze_run
    device_tree_blob
    device_tree_interrupts
    device_tree_properties
    device_tree_resources
    device_tree_structure
    event_stream
    host_load_receipt
    latency_jitter
    manifest_io
    native_completion
    native_tracking
    report_outputs
    report_publication
    run_analysis
    run_manifest
    run_series
    tracking_observations
    validate_measurement_domain

CLASSES
    builtins.object
        loop_timing_witness.run_manifest.RunInputs

    class RunInputs(builtins.object)
     |  RunInputs(
     |      manifest: 'dict[str, Any]',
     |      domain: 'dict[str, Any]',
     |      files: 'dict[str, bytes]',
     |      directory: 'Path | None' = None
     |  ) -> None
     |
     |  Validated run configuration and hash-bound input bytes.
     |
     |  Attributes
     |  ----------
     |  manifest
     |      Run metadata validated against the versioned run schema.
     |  domain
     |      Measurement-domain contract validated against its schema and cross-field rules.
     |  files
     |      Complete input bytes keyed by ``events``, ``tracking`` and ``power``;
     |      optional inputs are absent when the manifest declares ``null``.
     |  directory
     |      Original resolved manifest directory for validating captured source receipts.
     |
     |  Methods defined here:
     |
     |  __delattr__(self, name)
     |      Implement delattr(self, name).
     |
     |  __eq__(self, other)
     |      Return self==value.
     |
     |  __getstate__ = _dataclass_getstate(self) from dataclasses
     |
     |  __hash__(self)
     |      Return hash(self).
     |
     |  __init__(
     |      self,
     |      manifest: 'dict[str, Any]',
     |      domain: 'dict[str, Any]',
     |      files: 'dict[str, bytes]',
     |      directory: 'Path | None' = None
     |  ) -> None
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  __replace__ = _replace(self, /, **changes) from dataclasses
     |
     |  __repr__(self)
     |      Return repr(self).
     |
     |  __setattr__(self, name, value)
     |      Implement setattr(self, name, value).
     |
     |  __setstate__ = _dataclass_setstate(self, state) from dataclasses
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  directory
     |
     |  domain
     |
     |  files
     |
     |  manifest
     |
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |
     |  __annotations__ = {'directory': 'Path | None', 'domain': 'dict[str, An...
     |
     |  __dataclass_fields__ = {'directory': Field(name='directory',type='Path...
     |
     |  __dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,or...
     |
     |  __match_args__ = ('manifest', 'domain', 'files', 'directory')

FUNCTIONS
    __dir__() -> 'list[str]'
        Include unresolved public exports in module introspection.

        Returns
        -------
        list[str]
            Sorted module attributes, including the complete public interface.

    __getattr__(name: 'str') -> 'object'
        Resolve and retain one public analysis export.

        Parameters
        ----------
        name
            Public export requested through normal module attribute access.

        Returns
        -------
        object
            Original run-input class or analysis function from its owning module.

        Raises
        ------
        AttributeError
            The name is not part of the public analysis interface.

    build_report(inputs: 'RunInputs') -> 'tuple[dict[str, Any], list[dict[str, int | str]]]'
        Calculate every report field from validated run inputs.

        Parameters
        ----------
        inputs
            Schema-valid manifest and bytes verified against their SHA-256 values.

        Returns
        -------
        tuple[dict[str, Any], list[dict[str, int | str]]]
            Report object and per-cycle interval table.

        Raises
        ------
        ValueError
            If binary events or auxiliary series contradict the run contract.

    load_run(manifest_path: 'Path') -> 'RunInputs'
        Load a schema-valid run and verify every referenced input file.

        Parameters
        ----------
        manifest_path
            Path to one versioned run manifest.

        Returns
        -------
        RunInputs
            Domain, run metadata and hash-bound input bytes.

        Raises
        ------
        OSError
            If the manifest, domain or input bytes cannot be read.
        ValueError
            If JSON, schema, semantic or digest validation fails.

DATA
    __all__ = ['RunInputs', 'build_report', 'load_run']

FILE
    src/loop_timing_witness/__init__.py