MatchLib Toolkit

MatchLib Toolkit is a collection of design examples that demonstrate various aspects the MatchLib Connections library for modelling synthesizable hardware.

Each example contains a short README, a Makefile to drive pre-HLS compilation/simulation and a Catapult TCL script for high-level synthesis.

Downloading

To download the MatchLib Toolkit examples:

shell> mkdir MCToolkit
shell> cd MCToolkit
shell> git clone http://github.com/hlslibs/matchlib_toolkit.git

The toolkit examples require numerous open-source packages including:

• SystemC
• MatchLib Connections
• MatchLib
• Boost Preprocessor and Static Assert (required by nVidia's Matchlib)
• RapidJSON
• AC Dataypes
• AC Math
• AC SimUtils
• BMP IO

All of these packages are already available in a Catapult install tree (or your standard RedHat install) and will be properly located by the toolkit Makefiles if your CATAPULT_HOME environment variable is set properly.

If you do not have a Catapult installation you can do one of the following:

1. Download the fully self-contained Matchlib examples kit at: https://forums.accellera.org/files/file/126-matchlib-examples-kit-for-accellera-systemc-evolution-day-2020-presentation/ (Note that this download contains a precompiled version SystemC)

2. Use the set_vars.csh (or set_vars.sh) script contained in this repository to download the additional needed packages from github:

   shell> cd MCToolkit/matchlib_toolkit
   shell> source examples/set_vars.csh
   OR
   shell> . examples/set_vars.sh
   

   The first time the set_vars.* script is sourced it will download into your current directory all of the required open-source packages. It will also compile the OSCI SystemC simulator. Subsequent sourcing of set_vars.* from the same working directory will just point to the downloaded packages. You will need to source this script in each new shell when you want to run an example.

Running an example to test the environment

Now try running the first example '01_and_gate' in order to verify the environment:

shell> cd examples/01_and_gate
shell> gmake all

You should see:

./sim_sc

SystemC 2.3.2-Accellera --- Feb 1 2022 11:27:36
Copyright (c) 1996-2017 by all Contributors,
ALL RIGHTS RESERVED
0 s top Stimulus started

Info: (I702) default timescale unit used for tracing: 1 ps (trace.vcd)
12 ns top stopping sim at end of stimulus

Info: /OSCI/SystemC: Simulation stopped by user.
Simulation PASSED

Documentation

It is recommended that you browse all of the documents in matchlib_toolkit/doc

Waveform Viewing

You can use Questa (vsim), VCS, or similar simulators to view the trace.vcd files produced from the SystemC simulations in the examples. Alternatively you can download the open source gtkwave waveform viewer (google gtkwave).