ViTE - Visual Trace Explorer User Manual - GForge
Contents
1. not want to launch ViTE again If you try to open a file which is not recognised by ViTE error messages will be displayed 4 1 3 Navigation under the trace You can change the position and the scale by moving the horizontal and vertical scroll bars You can also zoom in or out by clicking in the zoom button You can select an area with the mouse to zoom in You can also directly set a zoom level by selecting a zoom level in the bottom right It is also possible to select an area to zoom by clicking and keeping the clic while moving the zoom will be in the rectangle defined by the beginning and the end of the clic The use of the right clic undo the previous zoom You can go to the beginning or the end of the trace by clicking on the left and rigth arrow button and view the whole trace by clicking on the Show all button You can see the trace in fullscreen going on the View menu and picking fullscreen Moreover it is possible to hide the links and or the events using the No arrow and No Event buttons of the toolbar An other option is to get informations about an event a state a communication in the trace by clicking over this element on the screen If a lot of elements are grouped you may be forced to zoom to be able to get the right information about the element 5 Installation 5 1 Direct installation from packages ViTE can be downloaded from its website http vite gforge inria fr Go into the download section where you wi2. of the trace UESTION While compiling the sources I have a uic error too old Qt Designer version and or qformlayout h can not be found NSWER Check your Qt version by qmake version and be sure that it is at least the Qt4 4 one UESTION I just installed the rpm package and when I type vite on the console it returns me the following error GLIBCXX_3 4 9 is missing NSWER Try to update the package of the lib c Else install the software from the sources instructions are given in the README in order to help you UESTION I got Qt errors when I compile or launch ViTE like bin vite symbol lookup error usr lib libQtOpenGL s0 4 undefined symbol _ZN14QWidgetPrivate15checkWindowRoleEv or symbol lookup error vite undefined symbol _ZN9QHashData13detach_helperEPFvPNS 4NodeEPvEPFvSl1 Ei 23 NSWER It is a Qt problem Check if your qt version is the same for all Qt libraries like ibQtOpenGL and libQtCore UESTION I am on Windows and I double click on the executable and an error tell me that a dll is not found Le If you launch ViTE by the Qt prompt the path to find dll libraries is changed and these dll missing are found A solution is to find there are on your computer the dll missing and to copy them in the bin folder of ViTE ATTN Why does not ViTE run well E Check if ViTE is runnable on your computer cf configuration 24 Bibliography 1 ID IMAG Paje http www id imag fr Logiciels
3. technical manual Some plugins are integrated directly in ViTE because there were developed by developers or other dark reasons like the statistic one The windows is separated by tabs one for each plugin as you can see in figure 10 3 10 1 Statistic plugin Inside it you can have important informations from the trace file You can choose the containers you want check the box beside the node in order to have all the chil dren of it Then you can watch the percentage of each states for these containers by two ways like in figures 10 1 and 10 2 ir r _rr si ii _ EE Ena na n Yond otvembng sasugrm Staates Uses to display diagrams about the trace states You can display it as chart or horizontal bar Mr Boom Ma B mo tu Ba ra Mo ra Mac Mor mo me Mo u Bic ma E icon mi me mi a mo na as a nan 237 E Figure 10 1 Vertical diagram Moreover you can export them in a svg file 10 2 Distribution See figure 10 3 20 Start time 5 End time la Kind of viewing Horizontal Histogram 2 Statistics Uses to display diagrams about the trace states You can display it as chart or horizontal bar Selected node y Ensemble0 a y Node 75 0 100 0 y Node2 y Node3 Node Y Node4 le y Node5 Proc33 y Node6 Proc34 v Node7 v Nodeg Proc35 y Node9 Y Node10 Proc36 y Node11 Proc37 y Node12 y Node13 Proc38 f y Nodet4 y Node15 Proce a u
4. the CeCILL A license and that you accept its terms 2 Overview 2 1 What is ViTE ViTE is a powerful portable and open source profiling tool designed to visu alize traces produced by parallel applications It allows to open several and common trace formats OTF TAU Paj etc browse export filter retrieve information and draw graphical statistics from these trace files These traces can be generated using Eztrace or GTG cf chapter 6 p 13 2 2 ViTE As Easy As Open Close fa di tl wa File View Preferences Help File View Preferences Help Open Ctrl 0 SEA 5 Reload Ctrl R Reload Ctrl R Recent Files Recent Files k Export Ctrl E k Export Ctrl E Close Ctri W O Quit ctrl Q O Quit Horizontal Scrolling 3 Introduction With the ever increasing dissemination of multi core architectures parallel and or distributed applications are becoming the norm so as to use computer resources as efficiently as possible Trace collection and visualization is useful for developers willing to debug and monitor the performance of their parallel applications Yet most existing trace visualization tools are proprietary or cannot handle large trace files ViTE is a powerful portable and open source profiling tool which visualizes the traces produced by parallel applications Thanks to its scalable design ViTE efficiently helps programmers to analyze the performance of
5. you have a really customized odd OTF installation CMake produced the following output CMake Version 2 6 Press e to exit help Figure 5 2 CMake error 11 5 2 2 Using the configure script The second way is to use the configure script It works on Linux and MacOS Go to the source directory and type configure and then make on the console The configure script is useful because on some implementation in order to com pile Qt sources you have qmake or qmake qt4 Also options are available to cus tomise your compilation See configure h figure 5 1 for more informations For example if the directory of ViTE is in your home hit cd vite src amp amp configure amp amp make The binary will be in the bin directory under the name of vite Listing 5 1 configure h ViTE configuration shell script Usage configure options Options h help print this page release compiles in release mode by default debug compiles in debug mode enable _spinning_logo makes the rabbit to turn when no trace is loaded enable_otf enables the otf support An OTF release is provided in the externals otf directory otf_dir lt path gt path to the OTF library otf_incdir lt path gt include path to the OTF headers otf_libdir lt path gt library path to the OTF libraries enable_tau enables the tau support tau_dir lt path gt path to the TAU libra
6. ViTE Visual Trace Explorer September 7 2010 User Manual Release 1 2 Contents 1 Licence of ViTE 4 2 Overview 5 2 1 Whatis VIDE se osa oop Rae BE RKO A Greed Bo A ae BSS 5 2 2 Val Ws As Easy ASe do due ke AE es eh ea A a 5 3 Introduction 6 4 How to use 8 Al Hirst USE dan e Sok deere e e A e a a 8 4 1 1 Launching VITE e caa castro nr naka pakaa 8 4 1 2 Opena fle sioe d s was aaa a e a kei 9 4 1 3 Navigation under the trace ouo 9 5 Installation 10 5 1 Direct installation from packages ooo 10 5 2 Compilation ooa a 10 521 Using CMake s saoo cacane he ikh RSE kbri 10 5 2 2 Using the configure script 2 2 12 6 Generate traces 13 7 Supported formats 14 GA PUE see eb ae a APR ee Re a ea Pie GOR ee bee bs 14 1 2 Daje extent d ui io i gus Nee eee a Re a e 14 G3 OTE s 22 0 44 han Gee e e aa we Dew be hb ba 4 14 TA EAU get ae amp Rok BG ASS RRM ee eet 6 ae eae ke 15 8 Features 16 8 1 Recent files Reload traces 2 2 2 00 0 eee eee 16 8 2 Trace xport orcas RW A Ae eee a A 16 Sio WMiniMap lt ri fr Soe Sock eee ae hea bs 16 8 4 Preferences MENU o LL 17 SAL T hessettinosi saco rc Ste e a do e oem sae os 17 8 4 2 The plugins i dae i e 17 8 4 3 Other options e 17 9 Shortcuts 18 9 1 Launching by command line o o 18 9 2 In the graphical interface o o o e 19 10 Plugins 10 1 Statistic plugin sc e saot e
7. ated by users in order to interact with ViTE They do not need a recompilation of ViTE when you want to add one For now they are two main plugins one giving the distribution and the other one showing some statistics on the trace The existing ones are explained in the paragraph 10 8 4 3 Other options You can show or hide the information window by choosing Show infos window in the View menu You can hide the warning messages shown in the information window by chosing No warning in the View menu 17 9 Shortcuts 9 1 Launching by command line There are useful shortcuts for launching ViTE or functionalities of ViTE For example the export of a file in a svg format can be done without launching the graphical interface in one line all of it Shortcut Action Example f file path Open a file vite f example trace h Display the help vite h a file path Open the file and display vite a example trace file path t start end Open the trace file and display it in the interval in seconds vite file t 0 10 f path source e path dest export the trace file in the svg format vite f in trace e out svg f source e start end dest t export the trace file in the svg format in the interval given vite f in trace e out svg t 1 1 The f is facultative vite filename works too 2 There could be no time
8. caa a 10 2 Distribution 11 Authors 12 FAQ 20 20 22 23 1 Licence of ViTE ViTE is under the licence CeCILL A This software is governed by the CeCILL A license under French law and abiding by the rules of distribution of free software You can use modify and or redistribute the software under the terms of the CeCILL A license as circulated by CEA CNRS and INRIA at the following URL http www cecill info As a counterpart to the access to the source code and rights to copy modify and redistribute granted by the license users are provided only with a limited warranty and the software s author the holder of the economic rights and the successive licensors have only limited liability In this respect the user s attention is drawn to the risks associated with loading using modifying and or developing or reproducing the software by the user in light of its specific status of free software that may mean that it is complicated to manipulate and that also therefore means that it is reserved for developers and experienced professionals having in depth computer knowledge Users are therefore encouraged to load and test the software s suitability as regards their requirements in conditions enabling the security of their systems and or data to be ensured and more generally to use and operate it in the same conditions as regards security The fact that you are presently reading this means that you have had knowledge of
9. init or time_end vite file t 1 18 9 2 In the graphical interface Here is a list of all the shortcuts implemented in ViTE that you can find in the menu bar Shortcut Action CTRL O Open the open file dialog box CTRL W Close the file CTRL E Open the export file dialog box CTRL S Save the current configuration for the file opened CTRL Q or ALT F4 Quit ViTE CTRL SHIFT A Show all the trace Mouse wheel or or Horizontal zoom in or out CTRL Mouse wheel or or Quick horizontal zoom in or out ALT Mouse wheel Quick vertical zoom in or out HOME Show the start of the trace END Show the end of the trace PAGE UP resp PAGE DOWN Move the visualisation to the left resp right UP DOWN RIGHT LEFT Move the trace CTRL UP DOWN RIGHT LEFT Quickly move the trace SELECT AN AREA WITH LEFT Select a square area of the view and display it CLIC RIGHT CLIC Backup the previous square area selection view 3Not yet implemented 19 10 Plugins The plugins are libraries made by users that can be integrated in ViTE to get information which is not given immediately by the software It is distributed under the form of a dynamic library and should be placed in the right directory in order to be loaded To set these directory read the paragraph If you want to create plugins please refer to the
10. l Dy Reload Export Figure 10 2 Horizontal diagram janx Distribution Trace informations Statistics window Distribution Ensemble0 St Nodeo States Ensemble0 count 0 Ensemble0_Node0 count 19 Ensemble0_Node0_Proc0 count 2526 Ensemble0_Node0_Proc1 count 202 Ensemble0_Node0_Proc2 count 356 Ensemble0_Node0_Proc3 count 244 Ensemble0_Node0_Proc4 count 510 Ensemble0_Node0_Proc5 count 650 Ensemble0_Node0_Proc6 count 300 EnsembleO_Node0_Proc7 count 370 Ensemble0_Node2 count 19 FactoClean Ensemble0_Node2_Proc16 count 454 A Factolnit 5 at EnsembleO_Node2_Proc17 count 748 M Repos Ensemble0_Node2_Proc18 count 440 g Up Ensemble0_Node2_Proc19 count 706 e UpdoClean Ensemble0_Node2_Proc20 count 356 Updolnit Ensemble0_Node2_Proc21 count 930 n WaitDistant SaS Ensemble0_Node2_Proc22 count 846 g WaitLocal Ensemble0_Node2_Proc23 count 818 he Ensemble0_Node3 count 19 Ensemble0_Node3_Proc24 count 902 Ensemble0_Node3_Proc25 count 888 Figure 10 3 Distribution plugin 21 11 Authors ViTE authors and developers are Kevin COULOMB Mathieu FAVERGE Johnny JAZEIX Olivier LAGRASSE Jule MARCOUEILLE Pascal NOISETTE Arthur REDONDY Cl ment VUCHENER The documentations were also written by them We thank Francois Broquedis for the help for the MacOS compilation We
11. ll find the different packages for Linux Windows and its sources If you want to compile the source code please read the instructions on the paragraph 5 2 Quick install for Debian Ubuntu users Since ViTE is already available on Debian repository you can install it with the following apt get install vite or aptitude install vite The available version for these packages is the 1 1 These commands should also install the needed package Otherwise in order to install ViTE you need to have the following libraries on your computer e libqt4 dev e libqt4 opengl dev 5 2 Compilation The compilation of ViTE can be useful to customize it ViTE can be compiled using the cmake software or the configure script provided Currently there are optional features that can be enabled or disabled e OTF trace files support e Tau trace files support experimental e Spinning rabbit which is fun 5 minutes but no more 5 2 1 Using CMake The first way is to use cmake http www cmake org a portable way to compile On Windows system a GUI is provided in order to compile The rules to follow are the same as for Linux For Linux users the easiest way is to build a directory at the root of VITE sources mkdir obj amp amp cd obj ccmake Then type C to configure the CMake cache You will see the windows 5 1 After that you can check if the options set are good additional directories and libraries The
12. n type C then G to generate the Makefile If libraries or directories are not found you will get errors warning you to check the paths like in the figure 5 2 To finish type make and it will compile For Windows users the easiest way is to create a visual C project if you have it and compile with it You can also create create a mingw Makefile how ever the OTF library is only supported with visual c compiler so it could not compile work with mingw 10 009 Fichier dition Affichage Terminal Onglets Aide Page 1 of 1 a CMAKE BACKWARDS COMPATIBILITY CMAKE BUILD TYPE CMAKE INSTALL PREFIX EXECUTABLE OUTPUT PATH LIBRARY OUTPUT PATH QT QMAKE EXECUTABLE VITE ENABLE OTF ICMAKE BACKWARDS COMPATIBILITY For backwards compatibility what version of CMa Press enter to edit option CMake Version 2 6 patch 2 Press c to configure Press h for help Press q to quit without generating Press t to toggle advanced mode Currently Off y Figure 5 1 CMake window Y 009 Fichier Edition Affichage Terminal Onglets Aide Orr installation was not found Please provide OTF DIR through the GUI when working with ccmake as a command line argument when working with cmake e g cmake DOTF_DIR PATH usr local otf Note the following message is triggered by cmake on the first undefined necessary PATH variable e g OTF INCLUDE DIR Providing OTF DIR as above described is probably the simplest solution unless
13. ong time The recent files menu helps him to store the most recent opened traces in order to load them fastly 8 2 Trace export Go to File and choose export A dialog box will open You can select the type of the file among svg jpeg png or txt Then type the name of the file with or without the extension it will be added if it is not The svg png and jpeg selections export the trace in the current displayed interval zoom and or translation will be taken in account The txt option exports the counter chosen in the next windows figure 8 1 The format of the text file is readable with third part software such as gnuplot to easily have use some data concerning the counters E Selection of the counter x Choose the counter to export in the following list Node3 Memoire Cacarear ox Figure 8 1 Selection of the counter to export 8 3 Minimap The minimap is a thumbnail of the current trace view It is helpful to situate where you are looking in the trace when you have zoomed a lot 16 8 4 Preferences menu This menu contains the settings you can modify to customize ViTE 8 4 1 The settings It is where the user can customize its ViTE You can modify global informations as for the use of palette for looking the trace Also there are more specific options for configuring the palettes the directories where to look for plugins and informations about the minimap 8 4 2 The plugins Plugins are cre
14. paje index html 2 B de Oliveira Stein J Chassin de Kergommeaux Flexible performance visual ization of parallel and distributed applications pages 735 747 2003 3 B de Oliveira Stein J Chassin de Kergommeaux Paj an extensible envi ronment for visualizing multi threaded programs executions In Proceedings of the 6th International EuroPar Conference LNCS pages 133 140 Munich Ger many 2000 Springer 4 G Mouni J Chassin de Kergommeaux B de Oliveira Stein Paje input data format Technical report 2003 5 TU Dresden Open trace format http www paratools com otf php 6 Vampir performance optimization http www vampir eu 7 University of Oregon Tuning and analysis utilities http www cs uoregon edu research tau home php 25
15. potentially large appli cations running on many nodes cores and communicating processes ViTE allows one to visualize traces written in the Paj open format see http www id imag fr Logiciels paje and the OTF Its features include the ability to export views in the SVG format so as to integrate them easily into reports and the production of statistics The aim of ViTE is to have a free and open software able to display different traces format with a user friendly interface That is why it is under Cecill A licence you can see the content on chapter 1 More information are available on the official website of ViTE http vite gforge inria fr or on the forge itself http gforge inria fr projects vite This document is a start guide for understanding how to use ViTE The figures 3 1a and 3 1b are examples of a trace you can watch with ViTE Se Yow nd PRE RRA 2 S Genio contameriaizioa lt lt eee Capto T a0 a Example of a trace on linux ubuntu 8 04 Fle view Preferences Help ERE I MIOS A Ti raro no events max 2 og Scale containersistates Change postion b Example of a trace on windows XP Figure 3 1 Example of traces 4 How to use Software Libraries requirements ViTE uses the Qt library for its graphic window and OpenGL library for the trace graphic render You need to have the following version at least to run ViTE e Qt 4 4 or g
16. r trace viewer with its own format The Paj format 4 is a self explained format including the declaration of each event state communication present in the trace ViTE supports most of the Paj features forest of containers events communi cations states variables color of states These files are recognize by the trace extension Warning for now ViTE doesn t support e the push pop function allowing to stack several states to one container e several state lines per container e color on events and communications These functionnalities will be included as soon as possible 7 2 Paj extented This format is an extension of the Paj format to allow the user to have one file per container instead of only one sorted for the Paj format One main file contains the definitions item and the name relative to the directory of the main file not absolute of the extra files To follow the Paj format you just need to add the following field to the definition of the PajeCreateContainer event FileName string So each creation of container using a filename different form will include the specified file For example if there are n MPI processes running you can make each process open and fill a different file filename rank The same features as for the Paj format are supported You can include files in an include file to create the same tree as your architecture program node thread for example but FileName are only
17. reater e opengl 1 5 or greater A list of operating system not exhaustive where ViTE runs e Ubuntu 8 04 8 10 9 04 e MacOS X e Windows XP Vista It also run in a lot of Linux systems like Mandriva Fedora 4 1 First use 4 1 1 Launching ViTE After getting ViTE by compiling or executables you can go to the vite directory The executable is in bin vite if you have just compiled from the source directory with configure or src vite with cmake When you launch ViTE without any options these will be described in the section 9 you will have a window like the one in the figure 4 1 vite 008 File View Preferences Help PRE DR GA AW A A noas Noevents Scale containers states Change position 4 Zoom 100 v Figure 4 1 Launching of Vite 4 1 2 Open a file Go to the File menu and click on Open A dialog box will appear and you will have to choose the file you want to open After choosing it you must click on Open to open the file or Cancel if you do not want to open the selected file The other option to open a trace is to use drag and drop Select your trace in a file manager and drop it on the ViTE window Moreover a recent file list has been done in order to easily open the recent traces It keeps in memory the last ten traces opened You can also reload the current trace This is useful when you visualize a trace do some modifications on the file and do
18. ry tau_incdir lt path gt include path to the TAU headers tau_libdir lt path gt library path to the TAU libraries 12 6 Generate traces Important Remember that ViTE does NOT generate traces To generate traces there are various ways depending on the format In this section we are going to present two easy ways Dynamically It is possible to generate traces without modifying the source code using EzTrace EzTrace is an INRIA project that enables the creation of traces in the Paj format For more information on this project you can visit their website at http www gforge inria fr projects eztrace Intrusive method An other way is to insert functions in your code to gener ate traces To easily adapt to ViTE and easily change the generated format we recommend you to use the GTG Generic Trace Generator library This library offers a generic interface to generate traces in various format only Paj is currently available OTF is being written TAU is the next step There is a C and also a Fortran interface For more information on this project you can visit the project webpage http www gforge inria fr projects gtg 13 7 Supported formats ViTE can draw traces obtained from four main formats Paj Paj extented OTF and TAU 7 1 Paj The Paj format is the first format supported by ViTE The main reason is ViTE was designed to display Paj traces Paj 1 2 3 is originally an othe
19. supported for PajeCreateContainer event To read theis format with ViTE the main file has to have the ept extension The included ffiles can have any extension you want as soon as their name are correctly spelled in the first one 7 3 OTF OTF or Open Trace Format 5 was developed by TU Dresden It is a free format available created to replace VampirTrace and used by Vampir 6 ViTE does not bear some OTF features such as snapshots ViTE only stands states communi cations and eventlike actions Althought some functionnalities are missing ViTE generate random colors for the OTF format the first time you open a file because they are not stored in the file and you can use the color settings to change for a better choice of color 14 7 4 TAU TAU 7 is the latest format added ViTE possibilities on this format have not been fully tested and any bug report is welcome The basic features are supported states events communications Any bug report or suggestion about what format should be included in ViTE is welcome and can be posted on ViTE gforge website https gforge inria fr projects vite 15 8 Features ViTE comes with some features helping the use 8 1 Recent files Reload traces When the user does modifications on the current trace he would like to be able to reload the trace without launching ViTE The reload button or menu is here to solve this problem The user could also be working with the same traces for a l
20. thank Samuel Thibault for the time he spends to make the debian package available We thank C dric Augonnet for making the Distribution plugin We thank the rabbit for being The website was designed by Olivier LAGRASSE Pascal NOISETTE Cl ment VUCHENER 22 12 FAQ mas How can I help improving this beautiful software NSWER ViTE is not perfect yet Some features that could be implemented are written in the technical manual but it is just a start and a lot of other things can be done UESTION I have some problems when I want to see a trace because the window glitters e If you use Compiz you have to disable it while using ViTE UESTION Why do I only have a black screen when I try to open a trace A NSWER Are you sure the trace is right Some errors of meaning may have not been detected in the data structure RETE Why does a new window open when I open a trace A NSWER Make sure you close the current trace before opening the following Or it will open it in another window in order to let the user visualize both traces RETTE Why can t I open my svg export NSWER The export of a trace in svg format can be more than three times bigger than the trace file So if the trace you want to export is big the sug reader can be slow You can try using another software to open it inkscape mozilla or convert the sug in a png file this feature is not include in ViTE or export only a part
Download Pdf Manuals
Related Search