wavekit 0.1.0__tar.gz

wavekit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

wavekit-0.1.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: wavekit
+Version: 0.1.0
+Summary: 
+Author: cxzzzz
+Author-email: cxz19961010@outlook.com
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: numpy (>=2.0.0,<3.0.0)
+Requires-Dist: pytest (>=8.2.2,<9.0.0)
+Requires-Dist: vcdvcd (>=2.3.5,<3.0.0)
+Description-Content-Type: text/markdown
+
+# wavekit
+
+This is a Python library for manipulating and analyzing digital circuit waveforms. The library provides tools to read, process, and perform various operations on waveform data, suitable for various digital circuit simulation and testing scenarios.
+
+## Features
+* Read various waveform file formats (e.g., VCD, FSDB, etc.)
+* Batch extraction of waveforms using absolute paths, brace expansions and regular expressions
+* Perform arithmetic operations, bitwise operations, functional operations and other operators on waveform data
+
+## Installation
+
+### Using pip
+You can install the library using pip:
+
+``` bash
+pip install wavekit
+```
+
+### From Source
+To install the library from the source, follow these steps:
+
+Clone the repository:
+
+```bash
+git clone https://github.com/cxzzzz/wavekit.git
+```
+
+Navigate to the project directory:
+``` bash
+cd wavekit
+```
+Install the library using pip:
+
+``` bash
+pip install .
+```
+
+## Quick Start
+Here is a simple example demonstrating how to use the library to read a VCD file and perform some operations on the waveform data:
+
+``` python
+```
+
+## License
+This project is licensed under the MIT License. See the [LICENSE] file for details.

wavekit-0.1.0/README.md

@@ -0,0 +1,45 @@
+# wavekit
+
+This is a Python library for manipulating and analyzing digital circuit waveforms. The library provides tools to read, process, and perform various operations on waveform data, suitable for various digital circuit simulation and testing scenarios.
+
+## Features
+* Read various waveform file formats (e.g., VCD, FSDB, etc.)
+* Batch extraction of waveforms using absolute paths, brace expansions and regular expressions
+* Perform arithmetic operations, bitwise operations, functional operations and other operators on waveform data
+
+## Installation
+
+### Using pip
+You can install the library using pip:
+
+``` bash
+pip install wavekit
+```
+
+### From Source
+To install the library from the source, follow these steps:
+
+Clone the repository:
+
+```bash
+git clone https://github.com/cxzzzz/wavekit.git
+```
+
+Navigate to the project directory:
+``` bash
+cd wavekit
+```
+Install the library using pip:
+
+``` bash
+pip install .
+```
+
+## Quick Start
+Here is a simple example demonstrating how to use the library to read a VCD file and perform some operations on the waveform data:
+
+``` python
+```
+
+## License
+This project is licensed under the MIT License. See the [LICENSE] file for details.

wavekit-0.1.0/build.py

@@ -0,0 +1,54 @@
+# setup.py
+
+from setuptools import setup, Extension, find_packages
+from Cython.Build import cythonize
+import numpy as np
+import os
+
+extensions = [
+        Extension(
+            "src.wavekit.value_change",
+            sources=["src/wavekit/value_change.pyx", ],
+            include_dirs=[np.get_include()],
+            extra_compile_args=["-fpic","-O3", "-march=native"],
+            extra_link_args=["-O3", "-march=native"],
+            language="c++",
+            #define_macros=[('CYTHON_TRACE', '1')] # open profiling
+        )
+]
+
+if VERDI_HOME := os.environ.get('VERDI_HOME'):
+
+    npi_include_dir = os.path.join(VERDI_HOME,'share/NPI/inc')
+    npi_library_dir = os.path.join(VERDI_HOME,'share/NPI/lib/LINUX64')
+
+    extensions = [
+        Extension(
+            "src.wavekit.npi_fsdb_reader",
+            sources=["src/wavekit/npi_fsdb_reader.pyx", ],
+            include_dirs=[np.get_include(), npi_include_dir],
+            library_dirs=[npi_library_dir],
+            libraries=["NPI"],
+            extra_compile_args=["-fpic","-O3", "-march=native"],
+            extra_link_args=["-O3", "-march=native",f"-Wl,-rpath,{npi_library_dir}"],
+            language="c++",
+            #define_macros=[('CYTHON_TRACE', '1')] # open profiling
+        )
+    ]
+
+
+setup(
+    ext_modules=cythonize(extensions,
+        compiler_directives={
+            "language_level": 3,
+            "embedsignature": True,
+            "boundscheck": False,
+            "wraparound": False,
+            "cdivision": True,
+            "nonecheck": False,
+            #'profile': True, # open profiling
+            #'linetrace': True
+        }
+    ),
+    script_args=['build_ext','--inplace'],
+)

wavekit-0.1.0/pyproject.toml

@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "wavekit"
+version = "0.1.0"
+description = ""
+authors = ["cxzzzz <cxz19961010@outlook.com>"]
+readme = "README.md"
+build = "build.py"
+include = ["src/wavekit/*.so"]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+numpy = "^2.0.0"
+vcdvcd = "^2.3.5"
+pytest = "^8.2.2"
+
+[build-system]
+requires = ["poetry-core", "Cython", "setuptools", "wheel", "numpy>=2.0.0"]
+build-backend = "poetry.core.masonry.api"

wavekit-0.1.0/src/wavekit/__init__.py

@@ -0,0 +1,15 @@
+#   -------------------------------------------------------------
+#   Copyright (c) Microsoft Corporation. All rights reserved.
+#   Licensed under the MIT License. See LICENSE in project root for information.
+#   -------------------------------------------------------------
+"""Python Package Template"""
+from __future__ import annotations
+
+__version__ = "0.0.1"
+
+from .waveform import Waveform
+from .vcd_reader import VcdReader
+try:
+    from .fsdb_reader import FsdbReader
+except ImportError:
+    pass

wavekit-0.1.0/src/wavekit/fsdb_reader.py

@@ -0,0 +1,125 @@
+from __future__ import annotations
+import importlib
+from collections import defaultdict
+from typing import Optional
+from functools import cached_property
+from .waveform import Waveform
+from .reader import Reader, Scope
+from .npi_fsdb_reader import NpiFsdbReader, NpiFsdbScope
+
+class FsdbScope(Scope):
+
+    def __init__(self, handle: NpiFsdbScope, parent_scope: FsdbScope):
+        super().__init__(name=handle.name())
+        self.handle = handle
+        self.parent_scope = parent_scope
+
+    @cached_property
+    def signal_list(self) -> list[str]:
+        return [s for s in self.handle.signal_list()]
+
+    @cached_property
+    def child_scope_list(self) -> list[FsdbScope]:
+        return [FsdbScope(c, self) for c in self.handle.child_scope_list()]
+
+    @property
+    def type(self) -> str:
+        if not hasattr(self, '_type'):
+            self._type = self.handle.type()
+        return self._type
+
+    @property
+    def def_name(self) -> Optional[str]:
+        if not hasattr(self, '_def_name'):
+            self._def_name = self.handle.def_name()
+        return self._def_name
+
+    def find_scope_by_module(self, module_name: str, depth: int = 0) -> list[Scope]:
+        if not hasattr(self, '_preloaded_module_scope'):
+            self.preload_module_scope()
+        return self._preloaded_module_scope[module_name]
+
+    def preload_module_scope(self):
+        preloaded_module_scope = defaultdict(list)
+        for c in self.child_scope_list:
+            for module_name, module_scope_list in c.preload_module_scope().items():
+                preloaded_module_scope[module_name].extend(module_scope_list)
+
+        if self.type == 'npiFsdbScopeSvModule':
+            #assert self.def_name not in preloaded_module_scope , (self.def_name, preloaded_module_scope)
+            preloaded_module_scope[self.def_name].append(self)
+        self._preloaded_module_scope = preloaded_module_scope
+        return preloaded_module_scope
+
+class FsdbReader(Reader):
+
+    pynpi = {}
+
+    def __init__(self, file: str):
+        super().__init__()
+
+        if len(FsdbReader.pynpi) == 0:
+            import sys
+            import os
+            rel_lib_path = os.environ["VERDI_HOME"] + "/share/NPI/python"
+            sys.path.append(os.path.abspath(rel_lib_path))
+            FsdbReader.pynpi['npisys'] = importlib.import_module(
+                "pynpi.npisys")
+            FsdbReader.pynpi['waveform'] = importlib.import_module(
+                "pynpi.waveform")
+            FsdbReader.pynpi['npisys'].init([''])
+
+        self.file = file
+        self.file_handle = NpiFsdbReader(file)
+
+    def load_wave(
+        self,
+        signal: str,
+        clock: str,
+        xz_value: int = 0,
+        signed: bool = False,
+        sample_on_posedge: bool = False,
+        begin_time: Optional[str] = None,
+        end_time: Optional[str] = None,
+    ) -> Waveform:
+
+        format = FsdbReader.pynpi['waveform'].VctFormat_e.BinStrVal
+        begin_time = begin_time or 0
+        end_time = end_time or 2**64-1
+
+        signal_value_change = self.file_handle.load_value_change(signal,
+            begin_time = begin_time,
+            end_time = end_time,
+            xz_value = xz_value
+        )
+
+        clock_value_change = self.file_handle.load_value_change(clock,
+            begin_time = begin_time,
+            end_time = end_time,
+            xz_value = 0
+        )
+
+        return self.value_change_to_waveform(
+            signal_value_change,
+            clock_value_change,
+            width=self.file_handle.get_signal_width(signal),
+            signed=signed,
+            sample_on_posedge=sample_on_posedge,
+            signal=signal
+        )
+
+    def top_scope_list(self) -> list[Scope]:
+        if not hasattr(self, "_top_scope_list"):
+            self._top_scope_list = [FsdbScope(s, None) for s in self.file_handle.top_scope_list()]
+        return self._top_scope_list
+
+    @property
+    def begin_time(self) -> str:
+        return self.file_handle.min_time()
+
+    @property
+    def end_time(self) -> str:
+        return self.file_handle.max_time()
+
+    def close(self):
+        self.file_handle.close()

wavekit-0.1.0/src/wavekit/npi_fsdb.pxd

@@ -0,0 +1,115 @@
+
+cdef extern from "npi.h":
+    cdef int npi_init(int argc, char** argv)
+    cdef int npi_end()
+    cdef int npi_load_design(int argc, char** argv)
+
+cdef extern from "npi_fsdb.h":
+
+    ctypedef unsigned long long  NPI_UINT64
+    ctypedef long long           NPI_INT64
+    ctypedef int                 NPI_INT32
+    ctypedef unsigned int        NPI_UINT32
+    ctypedef short               NPI_INT16
+    ctypedef unsigned short      NPI_UINT16
+    ctypedef char                NPI_BYTE8
+    ctypedef unsigned char       NPI_UBYTE8
+
+    ctypedef void* npiFsdbFileHandle
+    ctypedef void* npiFsdbScopeHandle
+    ctypedef void* npiFsdbSigHandle
+    ctypedef void* npiFsdbSigdbHandle
+    ctypedef void* npiFsdbVctHandle
+    ctypedef void* npiFsdbFtHandle
+
+    ctypedef void* npiFsdbScopeIter
+    ctypedef void* npiFsdbSigIter
+    ctypedef void* npiFsdbEnumIter
+    ctypedef NPI_UINT64 npiFsdbTime
+
+    ctypedef enum npiFsdbValType:
+        npiFsdbBinStrVal
+        npiFsdbOctStrVal
+        npiFsdbDecStrVal
+        npiFsdbHexStrVal
+        npiFsdbSintVal
+        npiFsdbUintVal
+        npiFsdbRealVal
+        npiFsdbStringVal
+        npiFsdbEnumStrVal
+        npiFsdbSint64Val
+        npiFsdbUint64Val
+        npiFsdbObjTypeVal
+
+    ctypedef struct npiFsdbValueValue:
+        char* str
+        int sint
+        unsigned int uint
+        long long sint64
+        unsigned long long uint64
+        double real
+
+    ctypedef struct npiFsdbValue:
+        npiFsdbValType format
+        npiFsdbValueValue value
+        # union field
+
+    ctypedef enum npiFsdbSigPropertyType:
+        npiFsdbSigName
+        npiFsdbSigFullName
+        npiFsdbSigIsReal
+        npiFsdbSigHasMember
+        npiFsdbSigLeftRange
+        npiFsdbSigRightRange
+        npiFsdbSigRangeSize
+        npiFsdbSigIsString
+        npiFsdbSigDirection
+        npiFsdbSigAssertionType
+        npiFsdbSigCompositeType
+        npiFsdbSigIsPacked
+        npiFsdbSigHasReasonCode
+        npiFsdbSigReasonCode
+        npiFsdbSigReasonCodeDesc
+        npiFsdbSigIsParam
+        npiFsdbSigHasEnum
+        npiFsdbSigPowerType
+        npiFsdbSigHasForceTag
+        npiFsdbSigSpType
+        npiFsdbSigEnumId
+
+    ctypedef enum npiFsdbScopePropertyType:
+        npiFsdbScopeName
+        npiFsdbScopeFullName
+        npiFsdbScopeDefName
+        npiFsdbScopeType
+
+
+
+
+    npiFsdbFileHandle npi_fsdb_open( const NPI_BYTE8* name )
+    NPI_INT32 npi_fsdb_close( npiFsdbFileHandle file )
+    NPI_INT32 npi_fsdb_min_time( npiFsdbFileHandle file, npiFsdbTime *time )
+    NPI_INT32 npi_fsdb_max_time( npiFsdbFileHandle file, npiFsdbTime *time )
+    npiFsdbSigHandle npi_fsdb_sig_by_name( npiFsdbFileHandle file, const NPI_BYTE8* name, npiFsdbScopeHandle scope )
+    npiFsdbVctHandle npi_fsdb_create_vct( npiFsdbSigHandle sig )
+    NPI_INT32 npi_fsdb_goto_time( npiFsdbVctHandle vct, npiFsdbTime time )
+    NPI_INT32 npi_fsdb_goto_first( npiFsdbVctHandle vct )
+    NPI_INT32 npi_fsdb_goto_next( npiFsdbVctHandle vct )
+    NPI_INT32 npi_fsdb_goto_prev( npiFsdbVctHandle vct )
+
+    NPI_INT32 npi_fsdb_vct_time( npiFsdbVctHandle vct, npiFsdbTime *time )
+    NPI_INT32 npi_fsdb_vct_value( npiFsdbVctHandle vct, npiFsdbValue *value)
+    NPI_INT32 npi_fsdb_release_vct( npiFsdbVctHandle vct )
+    NPI_INT32 npi_fsdb_unload_vc( npiFsdbFileHandle file )
+
+    NPI_INT32 npi_fsdb_sig_property( npiFsdbSigPropertyType type, npiFsdbSigHandle sig, NPI_INT32* prop )
+    const NPI_BYTE8* npi_fsdb_sig_property_str( npiFsdbSigPropertyType type, npiFsdbSigHandle sig)
+    NPI_INT32 npi_fsdb_scope_property( npiFsdbScopePropertyType type, npiFsdbScopeHandle scope, NPI_INT32* prop )
+    const NPI_BYTE8* npi_fsdb_scope_property_str( npiFsdbScopePropertyType type, npiFsdbScopeHandle scope )
+
+    npiFsdbScopeIter npi_fsdb_iter_top_scope( npiFsdbFileHandle file )
+    npiFsdbScopeIter npi_fsdb_iter_child_scope( npiFsdbScopeHandle scope )
+    npiFsdbScopeHandle npi_fsdb_iter_scope_next( npiFsdbScopeIter iter )
+    npiFsdbSigHandle npi_fsdb_iter_sig_next( npiFsdbSigIter iter )
+    npiFsdbSigIter npi_fsdb_iter_sig( npiFsdbScopeHandle scope )
+    npiFsdbSigIter npi_fsdb_iter_member( npiFsdbSigHandle sig )