Project

General

Profile

Command Line Options » History » Revision 13

Revision 12 (Sergey Smolov, 01/20/2020 10:59 AM) → Revision 13/17 (Sergey Smolov, 01/20/2020 02:56 PM)

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 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 Skips matching for the rest of the longest trace (default: disabled) 
   -d, --debug             Enable Enables printing for debug messages (default: disabled) 
   -se, --skip-equal       Skip Skips subsequent records if they differ in time field only (default: disabled) 
 </pre> 

 The detailed descriptions description of some specific command line options are given below. is shown 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: table=. 
 <pre> {font-style:italic; font-weight:bold; background:#ddd}. |<. Full name | Short name |<. Description | Default value| 
 1 clk 0 IT (1) 00000004 3c080001 A svc : lui t0,0x1 |<. @--help@ | @-h@ |<. Shows help message |-| 
 1 clk R r8 00000000 
 </pre> 

 The @log2.txt@ file contains |<. @FILE@ | @FILE@ |<. Path to the following records: trace file|-| 
 <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. |<. @--window-size@ | @-w@ |<. The idea is not to compare trace files record by record, but "record block" by "records block" with size of matching window, i.e 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 interval (in ticks) for records inside matching | 1 | 
 |<. @--first-dif-stop@ | @-fds@ |<. Stop 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 tool's matching process when the first non-matched record proven difference has been detected. 

 h2. Skip matching detected | disabled | 
 |<. @--skip-rest@ | @-sr@ |<. Skips the matching\printing process for the rest 

 There are not so many reasons to continue of the matching process when there is longest trace | disabled | 
 |<. @--debug@ | @-d@ |<. Enables printing for debug messages | disabled | 
 |<. @--skip-equal@ | @-se@ |<. Skips subsequent records if they differ in time field only one not completely parsed trace. When enabled, the appropriate option disables matching in such case. | disabled |