fsva 0.0.6

fsva (FuseSoc Verification Automation)

fsva - FuseSoc Verification Automation

Introduction

FuseSoc Verification Automation (fsva) is a tool that aims to automate the verification process of libraries and HDL design projects managed with FuseSoc build tool/system.

fsva in no way duplicates or replaces functionalities provided by the FuseSoc. Colloquially speaking, fsva is a wrapper for FuseSoc, automating the verification process. It simply detects and runs verification targets, and parses verification results.

Why?

The major goal is to easily integrate project/libraries described in FuseSoc into Continuous Integration workflow. FuseSoc is more than good for building and running single targets, however if you want to run multiple verificaiton targets it keeps rebuilding verification frameworks. This particular operation is redundant and time consuming. fsva assumes that verification frameworks (such as UVVM or OSVVM) are already pre-compiled (pre-analyzed) for simulation engines. What is more, fsva extends FuseSoc by parsing verification results.

How it works

fsva scans recursively for .core files and fetches all targets starting with tb_ or ending with _tb. Then it runs these targets calling FuseSoc run command and captures stdout and stderr. By default verification targets are run in parallel. The default number of concurrent processes equals multiprocessing.cpu_count(). All verification results, as well as verification summary, are saved as separate files in a directory, which name reflects the UTC time of a verification process startup. Under the UTC time directory, the cores directories are located. Each core directory contains directories with results for particular verification targets. Example _fsva output directory structure:

_fsva/
└── 2020-07-15_16-31-47
    ├── div_by_3
    │   └── div_by_3_tb
    │       └── output.txt
    ├── gbt_link_checker
    │   ├── checker_tb
    │   │   └── output.txt
    │   ├── generator_1_tb
    │   │   └── output.txt
    │   └── generator_2_tb
    │       └── output.txt
    ├── psl
    │   └── tb_0
    │       ├── ghdl.ghw
    │       ├── ghdl_psl_report.json
    │       └── output.txt
    └── summary

If any extra parsing of the verification results is needed (for example in case of metric driven verification) in the future, it will be based on prefix or suffix indicating verification framework/infrastructure. For instance, for UVVM it will be tb_uvvm_ / _uvvm_tb, respectively for OSVVM it will be tb_osvvm_ / _osvvm_tb.

If FuseSoc supports formal verification targets in the future, they will be fetched based on fv_ prefix or _fv suffix.

Installation

Latest stable version of fsva can be installed from PyPI: pip install --user fsva.

Alternatively, you can clone this repository and run python setup.py install --user.

Usage

Verify project

Execute fsva in project root directory to run all verification targets.

Verify single core or target

You can also run all verification targets for single core: fsva core_name or run specific verification target for specific core fsva core_name target_name. When verifying single core or target, the output is printed on the console. Extra files, such as waveform, PSL reports etc. are placed under _fsva/tmp/{core}/{target}/ path.

Note!

If you use it with UVVM you may need to fix status that is returned when UVVM test bench fails: Integrating UVVM with Continuous Integration - problem with simulators exit status.

MIT License

Copyright (c) 2019 Michał Kruszewski

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.