Retrascope

h1. Getting Started

{{toc}}

h2. Prerequisite

Retrascope should be "installed":https://forge.ispras.ru/projects/retrascope/wiki/Installation_Guide.

h2. Command Line Interface

As it is described in "Overview":https://forge.ispras.ru/projects/retrascope/wiki/Overview, Retrascope contains a number of data representations that are called *entities* and a number of active components that are called *engines*. When working with the tool through command line interface, _valuable_ engines and\or entities are to be specified. To describe the approach, let's look at the map of all engines and entities at Retrascope:

*Figure 1* : Engines & entities dependency graph

!engines-entities.png(*Figure 1* : Engines & entities dependency graph)!

On the Fig. 1 engines are depicted as labeled edges, entities are depicted as labeled nodes. Entities that are represented by text files, are shown as grey rectangles. Entities, that are stored in memory, are shown as yellow circles. Edge and node labels store engine and entity _identifiers_ respectively. Edge directions mean input (source) and output (destination) entities for engines.

At simple case, it is enough for the tool running to pass the desired entity or engine identifier as command line parameter. However, as it can be seen from Fig. 1, some engines require two or more inputs. For such engines (like @smv-test-parser@, for example) _merge points_ that are depicted by white circle nodes are introduced. Having such merge points in Retrascope engines\entities dependency graph, means that it is not enough to specify only the destination engine or entity. Tool parameters should be selected with the aim to describe the concrete path at the dependency graph.

For example, we would like to run the tool on VHDL module that is called @example.vhd@ with the aim to check properties that are extracted from it's internal EFSM model (@efsm-transition-property-extractor@) by a VHDL testbench. Here is the module code:

<pre>

entity example is

 port (input : in bit_vector(2 downto 1);

       output: out bit_vector(1 downto 0);

       clock: in bit);

end example;

architecture BEHAV of example is

 begin

   process(clock)

 begin

   if clock'event and clock='1' then

     if (input(2) = '1') then

       output <= "11";

     end if;

     if (input(1) = '0') then

       output <= "01";

     end if;

   end if;

 end process;

end BEHAV;

</pre>

On Windows, Retrascope should have at least the following arguments:

<pre>

> retrascope.bat example.vhd --module-name example --target vhdl-testbench --engine vhdl-parser;efsm-transition-property-extractor

</pre>

On Linux-based OS:

<pre>

$ retrascope example.vhd --module-name example --target vhdl-testbench --engine vhdl-parser:efsm-transition-property-extractor

</pre>

Next chapters of this guide describe main use cases of the Retrascope tool.

h2. Model visualization

Retrascope tool extracts the following categories of models from target HDL descriptions:

* Control Flow Graph (CFG)

* Guarded Actions Decision Diagram (GADD)

* High-Level Decision Diagram (HLDD)

* Extended Finite State Machine (EFSM)

All the models tend to be equivalent to the target HDL module(s) and are stored in memory as Java objects. To get their graphical representation we use "GraphML":https://en.wikipedia.org/wiki/GraphML format - an XML-based format for graphs. To open GraphML files we'd recommend to use "yEd":https://www.yworks.com/products/yed editor. To run the tool for CFG model visualization, use the following parameters:

<pre>

$ ./retrascope example.vhd --module-name example --engine cfg-graphml-printer --graphml example-cfg.graphml

</pre>

To convert the generated _example-cfg.graphml_ file into the PNG format, do the following:

# Run yEd editor

# From main menu select "File" -> "Open...", then select the _example-cfg.graphml_ file in your file system and press "Open"

# Select "Layout" -> "Hierarchical" then press "OK"

# Select "File" -> "Export..." and select PNG format

The result is on Figure 2.

*Figure 2* : CFG model

!example-cfg.png(*Figure 2* : CFG model)!

Parameters are similar for GADD model:

<pre>

$ ./retrascope example.vhd --module-name example --engine gadd-graphml-printer --graphml example-gadd.graphml

</pre>

and for EFSM model:

<pre>

$ ./retrascope example.vhd --module-name example --engine efsm-graphml-printer --graphml example-efsm.graphml

</pre>

To be continued...