From: schnorr Date: Thu, 8 Apr 2010 12:32:16 +0000 (+0000) Subject: documentation about triva - installation, execution and time-slice description X-Git-Tag: SVN~265 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/fb9b4711ee0213301381ef0b7c0a7a446ae9a9e7 documentation about triva - installation, execution and time-slice description git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@7475 48e7efb5-ca39-0410-a469-dd3cf9ba447f --- diff --git a/buildtools/Cmake/src/CMakeDocs.txt b/buildtools/Cmake/src/CMakeDocs.txt index 1dbde2dc01..8d725a041e 100644 --- a/buildtools/Cmake/src/CMakeDocs.txt +++ b/buildtools/Cmake/src/CMakeDocs.txt @@ -94,6 +94,7 @@ if(MAKE_DOC) endforeach(file ${PNGS}) exec_program("cp ${PROJECT_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${PROJECT_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${PROJECT_DIRECTORY}/doc/html/" "${PROJECT_DIRECTORY}/doc/") + exec_program("cp ${PROJECT_DIRECTORY}/doc/triva-time_interval.png ${PROJECT_DIRECTORY}/doc/html/" "${PROJECT_DIRECTORY}/doc/") exec_program("cp ${PROJECT_DIRECTORY}/doc/simgrid.css ${PROJECT_DIRECTORY}/doc/html/" "${PROJECT_DIRECTORY}/doc/") set(top_srcdir "..") diff --git a/doc/FAQ.doc b/doc/FAQ.doc index 66f2f863e2..1e10e5f282 100644 --- a/doc/FAQ.doc +++ b/doc/FAQ.doc @@ -1808,6 +1808,91 @@ int main (int argc, char **argv) } \endverbatim +\subsubsection faq_tracing_analyzing Analyzing the SimGrid Traces + +The SimGrid library, during an instrumented simulation, creates a trace file in +the Paje file format that contains the platform utilization for the simulation +that was executed. The visualization analysis of this file is performed with the +visualization tool Triva, with +special configurations tunned to SimGrid needs. This part of the documentation +explains how to configure and use Triva to analyse a SimGrid trace file. + +- Installing Triva: the tool is available in the INRIAGforge, +at http://triva.gforge.inria.fr. +Use the following command to get the sources, and then check the file +INSTALL.simplified. This file contains instructions to install +the tool's dependencies in a Ubuntu/Debian Linux. +\verbatim +$ svn checkout svn://scm.gforge.inria.fr/svn/triva +$ cd triva +$ cat INSTALL.simplified +\endverbatim + +- Executing Triva: a binary called Triva is available after the + installation (you can execute it passing --help to check its +options). If the triva binary is not available after following the +installation instructions, you may want to execute the following command to +initialize the GNUstep environment variables (note that the location of the +GNUstep.sh file may vary depending on your GNUstep installation - the +command is known to work in Ubuntu and Debian Linux): +\verbatim +$ source /usr/share/GNUstep/Makefiles/GNUstep.sh +\endverbatim +You should be able to see this output after the installation of triva: +\verbatim +$ ./Triva.app/Triva --help +Usage: Triva [OPTION...] TRACEFILE +Trace Analysis through Visualization + + You need to use one of the following options: + -g, --graph Graph Analysis + -t, --treemap Treemap Analysis + + Other auxiliary options to check the trace file: + -c, --check Check the integrity of trace file + -h, --hierarchy Export the trace type hierarchy + + -?, --help Give this help list + --usage Give a short usage message +\endverbatim +Triva expects that the user choose one of the available options +(currently --graph or --treemap for a visualization analysis) +and the trace file from the simulation. + +- Understanding Triva - time-slice: the analysis of a trace file using + the tool always takes into account the concept of the time-slice. +This concept means that what is being visualized in the screen is always +calculated considering a specific time frame, with its beggining and end +timestamp. The time-slice is configured by the user and can be changed +dynamically through the window called Time Interval that is opened +whenever a trace file is being analyzed. The next figure depicts the time-slice +configuration window. +In the top of the window, in the space named Trace Time, +the two fields show the beggining of the trace (which usually starts in 0) and +the end (that depends on the time simulated by SimGrid). The middle of the +window, in the square named Time Slice Configuration, contains the +aspects related to the time-slice, including its start and its +size. The gray rectangle in the bottom of this part indicates the +current time-slice that is considered for the drawings. If the checkbox +Update Drawings on Sliders Change is not selected, the button +Apply must be clicked in order to inform triva that the +new time-slice must be considered. The bottom part of the window, in the space +indicated by the square Time Slice Animation can be used to advance +the time-frame automatically. The user configures the amount of time that the +time-frame will forward and how frequent this update will happen. Once this is +configured, the user clicks the Play button in order to see the dynamic +changes on the drawings. +
+\htmlonly + +\endhtmlonly +
+Remarks: when the trace has too many hosts or links, the computation to +take into account a new time-slice can be expensive. When this happens, the +Frequency parameter, but also updates caused by change on configurations +when the checkbox Update Drawings on Sliders +Change is selected will not be followed. + \section faq_troubleshooting Troubleshooting \subsection faq_trouble_lib_compil SimGrid compilation and installation problems diff --git a/doc/triva-time_interval.png b/doc/triva-time_interval.png new file mode 100644 index 0000000000..b321914d78 Binary files /dev/null and b/doc/triva-time_interval.png differ diff --git a/doc/triva-time_interval.svg b/doc/triva-time_interval.svg new file mode 100644 index 0000000000..ba1475e72c --- /dev/null +++ b/doc/triva-time_interval.svg @@ -0,0 +1,552 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + Trace Start Time + + + Trace End Time + + Time-Slice Start + + Time-Slice Size + + + CurrentTime-Slice + + Time-Slicegoes forward ofthis amount + + Screen is updateevery thisamount of time + +