From fca3a90f282196f1ac900c220159471f877accdf Mon Sep 17 00:00:00 2001 From: ChadliaJerad Date: Tue, 22 Aug 2023 14:18:43 -0700 Subject: [PATCH] Update the README file to reflect the change in fedsd usage --- util/tracing/visualization/README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/util/tracing/visualization/README.md b/util/tracing/visualization/README.md index ffd422c41..c199787d3 100644 --- a/util/tracing/visualization/README.md +++ b/util/tracing/visualization/README.md @@ -1,7 +1,9 @@ # Trace sequence diagram visualizer `fedsd` is a utility that reports the interactions (exchanged messages) -between federates and the RTI in a sequence-diagram-like format. +between federates and the RTI in a sequence-diagram-like format. +It also reports the interactions between different encalves in an enclaved execution, where no RTI trace file is provided. + To use `fedsd`, you need to first obtain an execution trace. To do this, enable the tracing mechanism in your Lingua Franca program by setting the `tracing` target property to `true` and then compile and run the program. @@ -10,7 +12,7 @@ internally running `trace_to_csv`. It then aggregates the data from all `.csv` files to do the matching and draw the sequence diagram. # Installing -`fedsd` is installed together with the rest of the tracing tools. For instructions refer to `~/util/tracing/README.md`. +`fedsd` is installed together with the rest of the tracing tools. For instructions refer to `util/tracing/README.md`. # Running @@ -20,20 +22,20 @@ file will be generated for each of the federates, in addition to `rti.lft`. The contains the RTI trace. If, however, the federation is launched manually, then running the `RTI` command should be passed the `-t` flag in order to make sure that it, too, has tracing enabled: -``` -$ RTI -n -t +```bash +RTI -n -t ``` It is most convenient to launch the RTI and all federates from the same working directory so that they will all write their trace file to that directory. -Once the federation stopped executing, run `fedsd` on all generated `.lft` files: -``` -$ fedsd *.lft -``` -In case `trace_to_csv` executable is in a different location, other than `/usr/local/bin/`, then use the `INSTALL_PREFIX` flag, as follows: +Once the federation stopped executing, running `fedsd` will operate on all the `.lft` files in the current directory: +```bash +fedsd ``` -fedsd INSTALL_PREFIX=~/.local/bin/ *.lft +It is also possible to operate on specific files. In such a case, run `fedsd` with `-r` flag to provide the RTI trace file, and `-f` flag to privide the list of federates +trace files. Bith argumenets are optional. +```bash +fedsd -r -f ``` -The output is an html file named `trace_svg.html` (in the current directory) that contains the sequence of interactions -between the federates and the RTI. +The output is an html file named `trace_svg.html` (in the current directory) that contains the sequence of interactions between the federates and the RTI.