help.txt

it is very important

        or change their order to avoid replacing other strings in a line or already replaced IPs. 
  For example first line must be removed because it's not neccessary:
  1:0
  0.1.0.2
  0.3.0.1        

* Trace graph SKIPS LINES (formats 9.2, 9.3, 9.4, 9.5) WHICH DON'T CONTAIN ALL THE NECESSARY INFORMATION 
  (see columns description in 9.6) or CONVERTS THEM INTO Trace graph trace format if it's possible. 

9.1. Wired
----------
+ 0.1 8 1 tcp 40 ------- 2 8.0 7.0 0 0
- 0.1 8 1 tcp 40 ------- 2 8.0 7.0 0 0
r 0.11016 8 1 tcp 40 ------- 2 8.0 7.0 0 0

9.2. Wireless
-------------
M 0.00000 0 (212.25, 215.07, 0.00), (392.36, 331.50), 13.75
s 82.613915213 _2_ RTR  --- 3 DSR 24 [0 0 0 0] ------- [2:255 3:255 32 0] 1 [1 2] [0 2 0 0->0] [0 0 0 0->0]
r 82.620724496 _5_ RTR  --- 4 DSR 44 [a2 5 3 800] ------- [3:255 2:255 255 5] 3 [0 2] [1 2 3 2->3] [0 0 0 0->0]
f 82.621436060 _0_ RTR  --- 3 DSR 44 [0 ffffffff 5 800] ------- [2:255 3:255 32 0] 3 [1 2] [0 2 0 0->0] [0 0 0 0->0]
s 117.939882761 _2_ RTR  --- 242 cbr 540 [0 0 0 0] ------- [2:1 4:0 32 4] [89] 0 1
r 117.942740948 _4_ RTR  --- 242 cbr 540 [a2 4 2 800] ------- [2:1 4:0 32 4] [89] 1 1

9.3. New trace file format (wireless)
-------------------------------------
s -t 0.267662078 -Hs 0 -Hd -1 -Ni 0 -Nx 5.00 -Ny 2.00 -Nz 0.00 -Ne -1.000000 -Nl RTR -Nw --- -Ma 0 -Md 0 -Ms 0 -Mt 0 -Is 0.255 -Id -1.255 -It message -Il 32 -If 0 -Ii 0 -Iv 32 
s -t 1.511681090 -Hs 1 -Hd -1 -Ni 1 -Nx 390.00 -Ny 385.00 -Nz 0.00 -Ne -1.000000 -Nl RTR -Nw --- -Ma 0 -Md 0 -Ms 0 -Mt 0 -Is 1.255 -Id -1.255 -It message -Il 32 -If 0 -Ii 1 -Iv 32 
M 10.00000 0 (5.00, 2.00, 0.00), (20.00, 18.00), 1.00
s -t 10.000000000 -Hs 0 -Hd -2 -Ni 0 -Nx 5.00 -Ny 2.00 -Nz 0.00 -Ne -1.000000 -Nl AGT -Nw --- -Ma 0 -Md 0 -Ms 0 -Mt 0 -Is 0.0 -Id 1.0 -It tcp -Il 40 -If 2 -Ii 2 -Iv 32 -Pn tcp -Ps 0 -Pa 0 -Pf 0 -Po 0 
r -t 10.000000000 -Hs 0 -Hd -2 -Ni 0 -Nx 5.00 -Ny 2.00 -Nz 0.00 -Ne -1.000000 -Nl RTR -Nw --- -Ma 0 -Md 0 -Ms 0 -Mt 0 -Is 0.0 -Id 1.0 -It tcp -Il 40 -If 2 -Ii 2 -Iv 32 -Pn tcp -Ps 0 -Pa 0 -Pf 0 -Po 0 

NOTE! AGT and RTR and MAC or AGT and RTR trace levels should be ON in wireless simulations because 
      calculations results can be wrong when some of the trace levels are OFF.
NOTE! It's better to use old wireless format (9.2) than new trace format (faster file loading).

9.4. Wired-wireless
-------------------
A trace file in this format must have 'mixed12' header, for example:
mixed12 ip
+ 1 1 0 cbr 1000 ------- 2 0.1.0.2 1.0.1.2 0 0
- 1 1 0 cbr 1000 ------- 2 0.1.0.2 1.0.1.2 0 0
s 1.000000000 _7_ AGT  --- 1 cbr 1000 [0 0 0 0] ------- [4194307:1 6144:1 32 0] [0] 0 0
s 1.001000000 _7_ RTR  --- 1 cbr 1000 [0 0 0 0] ------- [4194307:1 6144:1 32 0] [0] 0 0 
s 1.010000000 _7_ MAC  --- 1 cbr 1000 [0 0 0 0] ------- [4194307:1 6144:1 32 0] [0] 0 0 

NOTE! AGT, RTR and MAC trace levels have to be ON. See 9 for notes about 'ip' in the file header.

9.5. Wired-new trace file format
--------------------------------
A trace file in this format must have 'mixed13' header, for example:
mixed13 ip
+ 1 1 0 cbr 1000 ------- 2 0.1.0.2 1.0.1.2 0 0
- 1 1 0 cbr 1000 ------- 2 0.1.0.2 1.0.1.2 0 0
s -t 1.000000000 -Hs 7 -Hd -2 -Ni 7 -Nx 258.00 -Ny 244.00 -Nz 0.00 -Ne -1.000000 -Nl AGT -Nw --- -Ma 0 -Md 0 -Ms 0 -Mt 0 -Is 4194307.1 -Id 6144.1 -It cbr -Il 1000 -If 5 -Ii 1 -Iv 32 -Pn cbr -Pi 0 -Pf 0 -Po 0 
s -t 1.001000000 -Hs 7 -Hd -2 -Ni 7 -Nx 258.00 -Ny 244.00 -Nz 0.00 -Ne -1.000000 -Nl RTR -Nw --- -Ma 0 -Md 0 -Ms 0 -Mt 0 -Is 4194307.1 -Id 6144.1 -It cbr -Il 1000 -If 5 -Ii 1 -Iv 32 -Pn cbr -Pi 0 -Pf 0 -Po 0 
s -t 1.010000000 -Hs 7 -Hd -2 -Ni 7 -Nx 258.00 -Ny 244.00 -Nz 0.00 -Ne -1.000000 -Nl MAC -Nw --- -Ma 0 -Md 0 -Ms 0 -Mt 0 -Is 4194307.1 -Id 6144.1 -It cbr -Il 1000 -If 5 -Ii 1 -Iv 32 -Pn cbr -Pi 0 -Pf 0 -Po 0 

NOTE! AGT, RTR and MAC trace levels have to be ON. See 9 for notes about 'ip' in the file header.

9.6. Converting your own trace files formats into Trace graph trace file format
---------------------------------------------------------------------------------
Trace graph trace file format has 12 columns (fields tags in brackets are from the file format described in 9.3):
 1. event (s, r, f, d)
 2. event time (-t)
 3. current node number (-Ni)
 4. trace level (-Nl) (AGT, RTR, MAC, IFQ)
 5. packet unique ID (-Ii)
 6. packet type (-It) plus 15-length(packet type) spaces before packet size
 7. packet size (-Il)
 8. other node number (-Ms)
 9. hop from (-Is)
10. hop to (-Id)
11. next node number (-Hd)
12. sequence number (-Pi or -Ps, equals -1 if not present)

A file in this format must have the following header: tracegraph.
For example we have 2 first lines of a Trace graph trace file:

tracegraph
s 0.267662078 0 RTR 0 message        32 0 0 -1 -1 -1

Below we have 3 example lines of formats described in 9.2, 9.3 and 9.6.
The lines are from the same simulation, so trace formats differences can be seen.

s 0.267662078 _0_ RTR  --- 0 message 32 [0 0 0 0] ------- [0:255 -1:255 32 0]
s -t 0.267662078 -Hs 0 -Hd -1 -Ni 0 -Nx 5.00 -Ny 2.00 -Nz 0.00 -Ne -1.000000 -Nl RTR -Nw --- -Ma 0 -Md 0 -Ms 0 -Mt 0 -Is 0.255 -Id -1.255 -It message -Il 32 -If 0 -Ii 0 -Iv 32 
s 0.267662078 0 RTR 0 message        32 0 0 -1 -1 -1

Another example 3 lines:

D 78.470313904 _0_ IFQ  ARP 2 tcp 80 [0 0 0 800] ------- [0:0 1:0 32 1] [0 0] 0 0
d -t 78.470313904 -Hs 0 -Hd 1 -Ni 0 -Nx 20.00 -Ny 18.00 -Nz 0.00 -Ne -1.000000 -Nl IFQ -Nw ARP -Ma 0 -Md 0 -Ms 0 -Mt 800 -Is 0.0 -Id 1.0 -It tcp -Il 80 -If 2 -Ii 2 -Iv 32 -Pn tcp -Ps 0 -Pa 0 -Pf 0 -Po 0 
d 78.470313904 0 IFQ 2 tcp            80 0 0 1 1 0

As for wired format to Trace graph format conversion '+' must be replaced by 's' (4th column in Trace graph format=AGT, 8th column=0, 
11th column=0) or 'r' (if '+' after 'r' for the same packet at the same node, 4th column=RTR, 8th column=-1, 11th column=4th column 
in wired format), '-' must be replaced by 's' (4th column=MAC, 8th column=0, 11th column=0) or 'f' (4th column=RTR, 8th column=0, 
11th column=4th column in wired format). For 'r' event 3rd column=4th column in wired format, 4th column=MAC, 8th column=3rd column 
in wired format, 11th column=0. For 'd' event (4th column=RTR, 8th column=0, 11th column=4th column in wired format).
For example before conversion:

+ 1.00 1 0 cbr 1000 ------- 2 1.2 2.2 0 0
- 1.00 1 0 cbr 1000 ------- 2 1.2 2.2 0 0

after conversion:

s 1.00 1 AGT 0 cbr            1000 0 1.2 2.2 0 0
s 1.00 1 MAC 0 cbr            1000 0 1.2 2.2 0 0


10. TRACE GRAPH SCRIPT FILE FORMAT
==================================

To process a trace or a mat file automatically a Trace graph script file has to be written.
This option is useful when there is a lot of trace files to analyse or when trace files are big (see 11).
All the analysis results (graphs and network information) are saved to text files (see 3.8, 3.9).
Script files can be processed from the command line, for example:

trgraph c:\trgraph\out.tr -script c:\samplescript.txt
trgraph c:\mat\out.mat -script samplescript.txt
trgraph out.tr -script samplescript.txt

An example script file:

SAVE MAT FILE: ON
SAVE GRAPHS TO JPEG: ON
SAVE GRAPHS STATISTICS: ON
GRAPHS LEGEND: ON
RESET OPTIONS: ON
CLOSE PROGRAM WHEN FINISHED: ON
GRAPHS:
IDs of all the generated packets,PT: cbr,ST: 1.1,ET: 3.3,MARKPOINTS,MINORGRID
%Cumulative sum of numbers of generated packets at current node,PT: tcp,CN: 2,ON: 3,DC
CN2ON delays frequency distribution,HISTEDGES: 0.01 0.02 0.03 0.04,PT: cbr,STL: RTR,DTL: MAC 
NETWORK INFORMATION:
Simulation information,PT: cbr
Current node information,FID: 1

The first 6 lines have to be like the ones above but they don't have to be in the same order.
All the 6 options can be ON or OFF. Options:

SAVE MAT FILE               - saves a trace file when loaded to mat file (see 1.2)
SAVE GRAPHS TO JPEG         - saves all the plotted graphs to jpeg files not only to text files (see 1.3)
SAVE GRAPHS STATISTICS      - saves all the plotted graphs statistics to text files (see 3.17)
GRAPHS LEGEND               - enables/disables legend on the graphs
RESET OPTIONS               - turns all the options (like Packet type, Flow ID, Other node, Time interval, etc.) off
                              after each processed line from the script file
CLOSE PROGRAM WHEN FINISHED - closes (or not) Trace graph when analysis is done

The 7th line has to contain 'GRAPHS'. All the lines with graphs and network information names and options have to be ended 
with a comma (,). All the options (see 8. Shortcuts) also have to be separated with a comma. Options parameters 
(e.g. 1.1 is a parameter for ST:) have to be separated with spaces. Options with parameters have to be ended with 
a colon (:) (e.g. PT:). Options without parameters cannot be ended with a colon (:) (e.g. DC, MINORGRID). 
Lines beginning with '%' are skipped. Graphs and network information names have to be the same as these in the menus. 
There is a sample script file (samplescript.txt) in the 'doc' subdirectory.


11. Trace graph configuration file
==================================

Trace graph configuration file must have name trgraph.cfg. If the file doesn't exist or values are wrong default configuration is set.
Variables list:
PRECISION                  - number of precision fields for the calculations results (range 1 - 16),
                             default value is 10
SPLIT                      - small vector length for splitting big vectors to speed up delays, jitter, RTT and file loading calculations 
                             (range 100 - 100000), on my computer the best value is around 2500 (default value)
REMOVE TEMP FILE           - temporary file in Trace graph format is removed after loading, option can be ON or OFF,
                             default value is ON
AUTOMATIC FORMAT DETECTION - enables (ON)/disables (OFF) automatic file format (see 9 for supported formats) detection, 
                             when option is ON file headers like 'tracegraph', 'hex', 'mixed12', 'mixed13', 'ip', etc. (see 9) are not needed,
                             if option is OFF headers must be added to trace files,
                             default value is ON
MAXIMAL NUMBER OF LINES    - maximal number of lines (greater than 99) to read for automatic file format detection, 
                             if a format cannot be detected the number has to be increased or automatic detection has to be disabled,
                             default value is 1000, there is 'Maximal number of lines (...) has been processed' message after processing
                             number of lines set in the configuration file


12. SYSTEM REQUIREMENTS
=======================

I've checked Trace graph runs on a Pentium class machine with 32MB of RAM but it's very slow. 
On my Celeron 366@525, 192MB, the speed is acceptable. Trace graph runs best in 1024x768 or 
higher resolution. SYSTEM FONT SIZE HAS TO BE SET TO SMALL before running the program. 
Matlab doesn't cope with larger fonts and some names are cut. It should be about 3 times free space 
as a trace file size to load the trace file (doesn't concern mat files and trace files in Trace graph 
format without a specified time interval). I don't know maximum trace file size that can be loaded 
(I think it's less than 200MB). I only know that a 150MB trace file can be loaded.

NOTE! Loading trace files, delays, jitter, RTT and processing times calculations can take a long time.


13. AUTHOR CONTACT
==================

Copyright (c) 2001-2003 by Wroclaw University of Technology, Poland. All rights reserved. Please see copyright.txt.
Trace graph author: Jaroslaw Malek, email: [e-mail].
(if you email me and don't receive any answer it means my or your email hasn't been delivered so try ICQ)
ICQ UIN: 53167277
Network Simulator ns-2 web site: http://www.isi.edu/nsnam/ns/.
Matlab web site: http://www.mathworks.com.
Wroclaw University of Technology web site: http://www.pwr.wroc.pl.
Trace graph web site: http://www.geocities.com/tracegraph/.
Trace graph mirror web site: http://diament.ists.pwr.wroc.pl/~tracegr/tracegraph.php.