Project

General

Profile

Command Line Options » History » Version 36

Sergey Smolov, 11/09/2015 01:40 PM

1 1 Sergey Smolov
h1. Command Line Options
2
3 2 Sergey Smolov
{{toc}}
4
5 23 Sergey Smolov
The tool can be run by using either scripts (@retrascope.sh@ for Unix-like OS, @retrascope.bat@ for Window-like OS) or "HDL Retrascope IDE":http://forge.ispras.ru/projects/retrascope-ide plugin for "Eclipse":http://eclipse.org.
6 1 Sergey Smolov
7 23 Sergey Smolov
In this document the command line interface for "HDL Retrascope":http://forge.ispras.ru/projects/retrascope is described.
8
9
By default, the tool is run with "--help" option. Here is an output of the tool that is run with "--help" option:
10 1 Sergey Smolov
11
<pre>
12
usage: [options] files
13 29 Sergey Smolov
    --engine <arg>            Set a subset of engines
14
    --help                    Show this message
15
    --log <arg>               Set a log file
16
    --log-level <arg>         Set a log level
17
    --solver-debug            Set debug mode for SMT solver
18
    --target <arg>            Set a target entity
19
    --tool-debug-file <arg>   Set debug mode and save info to debug log file
20 1 Sergey Smolov
</pre>
21
22
This output shows four main categories of "HDL Retrascope":http://forge.ispras.ru/projects/retrascope command line options: source files, engines, logging mode and targets.
23
Options can be put into command line in an arbitrary order. 
24
25 16 Sergey Smolov
Options can have multi-values i.e. sequences of values, separated by system-dependent symbols. For example, for running the tool on multiple Verilog files (@file1.v@, @file2.v@, @file3.v@) on *nix OS, do the following:
26
27
<pre>
28
--target cfg file1.v:file2.v:file3.v
29
</pre>
30
31
while on Windows:
32
33
<pre>
34
--target cfg file1.v;file2.v;file3.v
35
</pre>
36
37
38 1 Sergey Smolov
h2. Source files
39
40
This option keeps paths to files that contain source code of hardware modules.
41
42
The "HDL Retrascope":http://forge.ispras.ru/projects/retrascope can elaborate hardware descriptions written in synthesizable subsets of VHDL and Verilog. For current version of the tool it is possible to elaborate the source code when it satisfies some limitations. 
43
44
For VHDL - no loop-cycles, no other modules'' instantiations, no wait-constructions, no function calls, no ''Z'' or ''X'' values, code size is less than 1 KLOC.
45
For Verilog - similar to VHDL.
46
47
If these limitations are satisfied there is a high probability that "HDL Retrascope":http://forge.ispras.ru/projects/retrascope will be able to elaborate your design:-) Otherwise an exception will occur.
48
It is possible to run the "HDL Retrascope":http://forge.ispras.ru/projects/retrascope both on several VHDL and Verilog designs. In such case a composite inner representation based on Control FLow Graph model will be constructed.
49
50
To transform Verilog design into Control Flow Graph model you need to run "HDL Retrascope":http://forge.ispras.ru/projects/retrascope with the following parameters:
51
52
<pre>
53
--target cfg /path/to/file/file.v
54
</pre>
55
56
where "cfg" encodes Controlf Flow Graph model as target.
57
58
To transform VHDL design into Control Flow Graph model you need to run "HDL Retrascope":http://forge.ispras.ru/projects/retrascope with the following parameters:
59
60
<pre>
61
--target cfg --toplevel toplevel_name /path/to/file/file.vhd
62
</pre>
63
64 3 Sergey Smolov
where "toplevel" is an option that is obligatory for all VHDL designs that are being elaborated. The toplevel option value is a string name of the top-level module of the specified VHDL file. For example, to elaborate the following VHDL design (that is saved in the hello.vhd file):
65
66
<pre>
67
entity hello_world is
68
end;
69
 
70
architecture hello_world_arc of hello_world is
71
begin
72
  stimulus : process
73
  begin
74 4 Sergey Smolov
    assert false report "Hello World"
75 3 Sergey Smolov
    severity note;
76
  end process stimulus;
77
end hello_world_arc;
78
</pre>
79
80
we need to run "HDL Retrascope":http://forge.ispras.ru/projects/retrascope with the following parameters:
81
82
<pre>
83
--target cfg --toplevel hello_world /path/to/file/hello.vhd
84
</pre>
85 2 Sergey Smolov
86 30 Sergey Smolov
You may omit the "toplevel" option in the case you are going to elaborate a single VHDL module which name is the same as it''s toplevel module name.
87
88 2 Sergey Smolov
h2. Targets
89
90 5 Sergey Smolov
From the tool point of view, the "HDL Retrascope":http://forge.ispras.ru/projects/retrascope operates with entities. One kind of these entities called "source files" was described in the previous section and for it''s elaboration the default tool components (called HDL parsers) are used.
91
92
Other entities may be treated as equivalent transformations of source code, or as data that can be extracted from source code (for example, like knowledge about module interfaces) or constructed (like module-level tests). Every entity which representation is included into "HDL Retrascope":http://forge.ispras.ru/projects/retrascope is stronlge connected with the tool component called "engine".
93
94 7 Sergey Smolov
To select the entity the user wants to get as result, the "target" option is needed to be initialized. For example, to get the EFSM (Extended Finite State Machine) that is stored into "GraphML":http://graphml.graphdrawing.org graphical format, the "HDL Retrascope":http://forge.ispras.ru/projects/retrascope should be run with the following options (for Verilog design called example.v):
95 5 Sergey Smolov
96
<pre>
97
--target efsm-graphml example.v
98
</pre>
99
100 8 Sergey Smolov
Here is the list of all target options of "HDL Retrascope":http://forge.ispras.ru/projects/retrascope:
101 6 Sergey Smolov
|*Name*|*Description*|
102 34 Sergey Smolov
|assertion|Assertion model|
103 6 Sergey Smolov
|cfg|Control flow graph model|
104 8 Sergey Smolov
|cfg-graphml|Control flow graph model that is saved in the "GraphML":http://graphml.graphdrawing.org file|
105 6 Sergey Smolov
|cfginterface|Interface (input and output signals) of control flow graph model|
106
|cgaa|Clocked guarded atomic actions model|
107 8 Sergey Smolov
|cgaa-graphml|Clocked guarded atomic actions model that is saved in the "GraphML":http://graphml.graphdrawing.org file|
108 35 Mikhail Lebedev
|conflicts|Conflict model|
109
|conflicts-xml|Conflict model that is saved in the XML file|
110 6 Sergey Smolov
|efsm|Extended finite state machine model|
111 8 Sergey Smolov
|efsm-graphml|Extended finite state machine model that is saved in the "GraphML":http://graphml.graphdrawing.org file|
112 25 Igor Melnichenko
|vhdl-testbench|VHDL testbench|
113 1 Sergey Smolov
114
h2. Engines
115
116 8 Sergey Smolov
As it is described above, the "HDL Retrascope":http://forge.ispras.ru/projects/retrascope consists of components called "engines" for source files & models elaboration. The "HDL Retrascope":http://forge.ispras.ru/projects/retrascope tool takes the target and constructs a sequence of engines called "toolchain" that reaches the specified target as a result. If the specified target is unreachable, the tool returns an error message.
117
When the specified target can be reached by several toolchains, the user can select the desired one by selecting engines with special option called "engine".
118
Here is the list of all engines of "HDL Retrascope":http://forge.ispras.ru/projects/retrascope:
119
|*Name*|*Description*|
120
|verilog-parser|Parser of hardware modules descriptions written in Verilog|
121
|vhdl-parser|Parser of hardware modules descriptions written in VHDL|
122
|cfg-graphml-printer|Printer of control flow graph model into "GraphML":http://graphml.graphdrawing.org format|
123
|cfg-cgaa-transformer|Transformer of control flow graph model into clocked guarded actions model|
124
|cfg-cfginterface-extractor|Extractor of interface signals of control flow graph model|
125
|cgaa-graphml-printer|Printer of clocked guarded atomic actions model into "GraphML":http://graphml.graphdrawing.org format|
126
|cgaa-efsm-transformer|Transformer of control flow graph model into extended finite state machine model|
127
|efsm-graphml-printer|Printer of extended finite state machine model into "GraphML":http://graphml.graphdrawing.org format|
128
|efsm-fate-test-generator|The "FATE":http://link.springer.com/article/10.1007%2Fs10836-011-5209-8 test generator from extended finite state machine model|
129 1 Sergey Smolov
|efsm-test-generator| Generator of tests from extended finite state machine model|
130 36 Sergey Smolov
|efsm-transition-assertion-extractor| Extractor of EFSM transition assertions|
131 35 Mikhail Lebedev
|efsm-conflict-extractor|Extractor of conflict model from extended finite state machine|
132
|conflict-xml-printer|Printer of conflict model into XML format|
133 1 Sergey Smolov
|test-xml-printer|Printer of tests into XML format|
134
|xml-test-parser|Parser of XML format files keeping the tests|
135 26 Sergey Smolov
|test-vhdl-testbench-printer|Creates VHDL testbenches on the basis of an HDL source code and generated tests|
136 8 Sergey Smolov
137 14 Sergey Smolov
Some options are common for all the tool engines. Here they are:
138
|*Option name*|*Description*|*Acceptable value*|
139
|printer-style|Set a printer style|VERILOG/VHDL|
140 11 Sergey Smolov
141 14 Sergey Smolov
Some engines have individual command line options. Here is the list of all engine-specific options:
142
143 15 Sergey Smolov
|*Engine name*|*Option*|*Description*|*Acceptable value*|*Default value*|
144
|verilog-parser|include-path|Path to find included files|Any existing file system path|empty|
145 31 Sergey Smolov
|vhdl-parser|toplevel|Toplevel VHDL modules names|Name of toplevel module for the processed VHDL module(s)|empty for more than one input files; file name for only input file|
146 15 Sergey Smolov
|cfg-graphml-printer|cfg-graphml|Output GraphML file name|Any string name for file that is acceptable by OS|cfg-model.graphml|
147 20 Sergey Smolov
|cgaa-graphml-printer|cfg-graphml|Output GraphML file name|Any string name for file that is acceptable by OS|cgaa-model.graphml|
148 28 Sergey Smolov
|cgaa-efsm-transformer|state-vars|Names of state-like variables|Any string name or names separated by system separators|empty|
149 15 Sergey Smolov
|efsm-graphml-printer|efsm-graphml|Output GraphML file name|Any string name for file that is acceptable by OS|efsm-model.graphml|
150 18 Igor Melnichenko
|efsm-fate-test-generator|sequence-length|Amount of vectors in one randomly generated sequence|Any integer (including zero)|a total amount of states|
151
|efsm-fate-test-generator|sequences-number|Amount of sequences in a randomly generated fragment of a test|Any integer (including zero)|A ratio of a total amount of transitions to a total amount of states (rounded to an integer)|
152 21 Igor Melnichenko
|efsm-fate-test-generator|loop-limit|Loop iteration limit|Any integer which is greater than zero|1|
153 1 Sergey Smolov
|efsm-test-generator|loop-limit|Loop iteration limit|Any integer which is greater than zero|1|
154 35 Mikhail Lebedev
|efsm-conflict-extractor|search-type|Type of search performed on an extended finite state machine|BFS (Breadth-First Search) or DFS (Depth-First Search)|BFS|
155
|efsm-conflict-extractor|search-depth|Depth of search performed on an extended finite state machine|Any integer which is greater than zero|10|
156
|conflict-xml-printer|output-file|Output XML file name|Any string name for file that is acceptable by OS|conflicts.xml|
157 1 Sergey Smolov
|test-xml-printer|file-name|Output XML file name|Any string name for file that is acceptable by OS|test.xml|
158 27 Igor Melnichenko
|test-vhdl-testbench-printer|testbench-dir|A directory where testbenches are saved|Either a relative or an absolute path to a directory. The %%MODULE_NAME%% placeholder is replaced by a processed design''s name|testbenches/%MODULE_NAME%|
159 32 Igor Melnichenko
|test-vhdl-testbench-printer|overwrite-existing|Overwrite target files if they already exist|||
160 15 Sergey Smolov
161 2 Sergey Smolov
h2. Logging
162
163 19 Igor Melnichenko
By default, "HDL Retrascope":http://forge.ispras.ru/projects/retrascope prints it''s output to the standard error stream. It is also possible to redirect the tool output to the specified file by using <code>--log</code> option.
164
The default logging level is <code>INFO</code>. It is possible to change it by means of the <code>--log-level</code> option. The acceptable values are <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>, <code>DEBUG</code>.
165 24 Sergey Smolov
166
h2. SMT solver debug mode
167
168
By default, "Fortress":http://http://forge.ispras.ru/projects/solver-api do not store the *.smt2 files through which it communicates with SMT solver. It can be enabled by setting <code>--solver-debug</code> option.