MicroTESK » Trace Matcher

h1. Command Line Options

{{toc}}

h1. Overview

The _Trace Matcher_ command line looks as follows:

<pre>

usage: traceutils [-h] [-w [W_SIZE]] [-fds] [-sr] [-d] [-se] FILE [FILE ...]

positional arguments:

  FILE                  Path to trace file

optional arguments:

  -h, --help            Show this help message and exit

  -w [W_SIZE], --window-size [W_SIZE]

                        Matching window size in ticks (default: 1)

  -fds, --first-dif-stop

                        Stop the tool when the first difference is detected (default: disabled)

  -sr, --skip-rest      Skip matching for the rest of the longest trace (default: disabled)

  -d, --debug           Enable printing for debug messages (default: disabled)

  -se, --skip-equal     Skip subsequent records if they differ in time field only (default: disabled)

</pre>

The detailed descriptions of some specific options are given below.

h2. Window size

For example, there are two input trace files that are called @log1.txt@ and @log2.txt@. The @log1.txt@ file contains the following records:

<pre>

1 clk 0 IT (1) 00000004 3c080001 A svc : lui t0,0x1

1 clk R r8 00000000

</pre>

The @log2.txt@ file contains the following records:

<pre>

1 clk R r8 00000000

1 clk 0 IT (1) 00000004 3c080001 A svc : lui t0,0x1

</pre>

Trace files to compare may contain same _records_ (lines), but at different positions relative to each other. To take this effect into account and do not treat actually simultaneous but formally logged in different order events, a *window* concept is introduced. The idea is not to compare trace files record by record, but "record block" by "records block" with the aim to find equal but reordered records. Such block is called as "window". Window is characterized by it's size that is a number of records inside the window. By default, window size is set to 1. It means that record by record comparison will be made.

h2. Stopping when first difference

When an appropriate option is enabled, the tool ceases matching process when the first non-matched record has been detected.

h2. Skip matching for the rest

There are not so many reasons to continue the matching process when there is only one not completely parsed trace. When enabled, the appropriate option disables matching in such case.