d35779b348f46842a822771975c6280eb3ee7cb5
[charm.git] / doc / projections / manual.tex
1 %\documentclass[10pt,dvips]{article}
2 \documentclass[10pt]{article}
3 \usepackage{../pplmanual}
4 \usepackage[pdftex]{graphicx}
5 \usepackage{subfigure}
6 %\usepackage[dvips]{graphicx}
7 %\usepackage[usenames,dvipsnames]{color}
8 %\usepackage[pdftex]{hyperref}
9 \usepackage{epsfig}
10 \input{../pplmanual}
11
12 \ifpdf
13 \DeclareGraphicsExtensions{.jpg,.pdf,.mps,.png}
14 \else
15 \DeclareGraphicsExtensions{.eps}
16 \fi
17
18
19 \title{\projections{} Manual}
20 \version{7.0}
21 \credits{
22 By Mike DeNardo, Sid Cammeresi, Theckla Louchios, Orion Lawlor, Gengbin Zheng,
23 Chee Wai Lee, Isaac Dooley, and Sindhura Bandhakavi
24 }
25
26 \begin{document}
27 \maketitle
28
29 \section{Introduction}
30
31 \projections{} is a performance analysis/visualization framework that
32 helps you understand and investigate performance-related problems in
33 your parallel (\charmpp{}) application. It is a framework with an
34 event tracing component with features that allow you to control the
35 amount of information generated and to a lesser degree the amount of
36 perturbation the tracing activities introduce into the application. It
37 also has a Java-based visualization and analysis component with
38 various views that will help present the performance information in a
39 visually useful manner.
40
41 Performance analysis with \projections{} typically involves 2 simple
42 steps:
43
44 \begin{enumerate}
45 \item 
46 Prepare your application code by linking with the appropriate trace
47 generation modules and executing it to generate trace data. (see
48 section \ref{sec::preparation})
49 \item
50 Using the Java-based tool to visually study various aspects of the
51 performance information to locate application execution performance
52 problems. (see section \ref{sec::visualization})
53 \end{enumerate}
54
55 \section{Preparing the \charmpp{} Application}
56 \label{sec::preparation}
57
58 The \charmpp{} runtime automatically records pertinent performance
59 data at performance-related events encountered by the runtime. These
60 events include the start and end of entry method execution, message
61 sends from entry methods and scheduler idle time. This means {\em
62 most} users will not need to manually insert code into their
63 applications in order to generate trace data. In scenarios where
64 special performance information not captured by the runtime is
65 required, an API (see section \ref{sec::api}) is available for
66 user-specific events with some support for visualization by the
67 Java-based tool. If greater control over tracing activities
68 (e.g. dynamically turning instrumentation on and off) is desired, the
69 API also allows users to insert code into their applications for such
70 purposes.
71
72 The automatic recording of events by the \projections{} framework
73 introduces the overhead of an if-statement for each runtime event,
74 even if no performance analysis traces are desired. Developers of
75 \charmpp{} applications who consider such an overhead to be
76 unacceptable (e.g. for a production application which requires the
77 absolute best performance) may recompile the \charmpp{} runtime with
78 the {\tt -{}-with-production} flag which removes the instrumentation
79 stubs.
80
81 To enable performance tracing of your application, users simply need
82 to link the appropriate trace data generation module(s) (also referred
83 to as {\em tracemode(s)}). (see section \ref{sec::trace modules})
84
85 \subsection{\projections{} Tracing Modules at Application Link Time}
86 \label{sec::trace modules}
87
88 \projections{} tracing modules dictate the type of performance data,
89 data detail and data format each processor will record. They are also
90 refered to as ``tracemodes''. There are currently 2 tracemodes
91 available. Zero or more tracemodes may be specified at link-time. When
92 no tracemodes are specified, no trace data is generated.
93
94 \subsubsection{Tracemode {\tt projections}}
95
96 Link time option: {\tt -tracemode projections}
97
98 This tracemode generates detailed event log files that contain
99 information about all \charmpp{} events like entry method calls and
100 message packing during the execution of the program.  The data will be
101 used by \projections{} in visualization and analysis.
102
103 This tracemode will generate a single symbol table file and $p$ ASCII
104 log files for $p$ processors. The names of the log files will be
105 NAME.\#.log where NAME is the name of your executable and \# is the
106 processor \#. The name of the symbol table file is NAME.sts where NAME
107 is the name of your executable.
108
109 This is the main source of data expected by the performance
110 visualizer. Certain tools like timeline will not work without the
111 detailed data from this tracemode.
112
113 The following is a list of runtime options available under this tracemode:
114
115 \begin{itemize}
116 \item
117 {\tt +logsize NUM}: keep only NUM log entries in the memory of each
118 processor. The logs are emptied and flushed to disk when filled.
119 \item
120 {\tt +binary-trace}:  generate projections log in binary form.
121 \item
122 {\tt +gz-trace}:      generate gzip (if available) compressed log files.
123 \item
124 {\tt +checknested}: a debug option. Checks if events are improperly nested
125 while recorded and issue a warning immediately.
126
127 \item {\tt +trace-subdirs NUM}: divide the generated log files among
128   {\tt NUM} subdirectories of the trace root, each named {\tt
129     PROGNAME.projdir.K}
130 \end{itemize}
131
132 \subsubsection{Tracemode {\tt summary}}
133
134 Compile option: {\tt -tracemode summary}
135
136 In this tracemode, execution time across all entry points for each
137 processor is partitioned into a fixed number of equally sized
138 time-interval bins. These bins are globally resized whenever they are
139 all filled in order to accomodate longer execution times while keeping
140 the amount of space used constant.
141
142 Additional data like the total number of calls made to each entry
143 point is summarised within each processor.
144
145 This tracemode will generate a single symbol table file and $p$ ASCII
146 summary files for $p$ processors. The names of the summary files will
147 be NAME.\#.sum where NAME is the name of your executable and \# is the
148 processor \#. The name of the symbol table file is NAME.sum.sts where NAME
149 is the name of your executable.
150
151 This tracemode can be used to control the amount of output generated
152 in a run. It is typically used in scenarios where a quick look at the
153 overall utilization graph of the application is desired to identify
154 smaller regions of time for more detailed study. Attempting to
155 generate the same graph using the detailed logs of the prior tracemode
156 may be unnecessarily time consuming or impossible.
157
158 The following is a list of runtime options available under this tracemode:
159
160 \begin{itemize}
161 \item
162 {\tt +bincount NUM}:   use NUM time-interval bins. The bins are resized and compacted when filled.
163 \item
164 {\tt +binsize TIME}:   sets the initial time quantum each bin represents.
165 \item
166 {\tt +version}:        set summary version to generate.
167 %\item
168 %{\tt +epThreshold}: DOESNT DO ANYTHING YET. LEFT COMMENTED FOR DOC PURPOSES
169 %\item
170 %{\tt +epInterval}: DOESNT DO ANYTHING YET. LEFT COMMENTED FOR DOC PURPOSES
171 \item
172 {\tt +sumDetail}: Generates a additional set of files, one per processor,
173 that stores the time spent by each entry method associated with each 
174 time-bin. The names of ``summary detail'' files will be NAME.\#.sumd where
175 NAME is the name of your executable and \# is the processor \#.
176 \item
177 {\tt +sumOnly}: Generates an additional file that stores a single
178 utilization value per time-bin, averaged across all processors. This
179 file bears the name NAME.sum where NAME is the name of your
180 executable. This runtime option currently overrides the {\tt
181 +sumDetail} option.
182 \end{itemize}
183
184 \subsection{General Runtime Options}
185 \label{sec::general options}
186
187 The following is a list of runtime options available with the same
188 semantics for all tracemodes:
189
190 \begin{itemize}
191 \item
192 {\tt +traceroot DIR}: place all generated files in DIR.
193 \item
194 {\tt +traceoff}: trace generation is turned off when the application
195 is started. The user is expected to insert code to turn tracing on at
196 some point in the run.
197 \item
198 {\tt +traceWarn}: By default, warning messages from the framework are
199 not displayed. This option enables warning messages to be printed to
200 screen. However, on large numbers of processors, they can overwhelm
201 the terminal I/O system of the machine and result in unacceptable
202 perturbation of the application.
203 \end{itemize}
204
205
206 \subsection{\projections{} API for \charmpp{} Applications}
207 \label{sec::api}
208
209 \subsubsection{Selective Tracing}
210 \label{sec::selective tracing}
211
212 \charmpp{} allows user to start/stop tracing the execution at certain
213 points in time on the local processor. Users are advised to make these
214 calls on all processors and at well-defined points in the application.
215
216 Users may choose to have instrumentation turned off at first (by
217 command line option {\tt +traceoff} - see section \ref{sec::general options}) if some period of time in middle of the
218 application\'s execution is of interest to the user.
219
220 Alternatively, users may start the application with instrumentation
221 turned on (default) and turn off tracing for specific sections of the
222 application.
223
224 Again, users are advised to be consistent as the {\tt +traceoff}
225 runtime option applies to all processors in the application.
226
227 \begin{itemize}
228 \item
229 {\tt void traceBegin()}
230
231 Enables the runtime to trace events (including all user events) on the local processor where {\tt traceBegin} is called.
232
233 \item
234 {\tt void traceEnd()}
235
236 Prevents the runtime from tracing events (including all user events) on the local processor where {\tt traceEnd} is called.
237
238 \end{itemize}
239
240 \subsubsection{User Events}
241 \label{sec::user events}
242
243 \projections{} has the ability to visualize traceable user
244 specified events. User events are usually displayed in the Timeline view as vertical bars above the entry methods. Alternatively the user event can be displayed as a vertical bar that vertically spans the timelines for all processors. Follow these following basic steps for creating user events in a charm++ program:
245
246 \begin{enumerate}
247 \item
248 Register an event with an identifying string and either specify or acquire
249 a globally unique event identifier. All user events that are not registered will be displayed in white.
250
251 \item
252 Use the event identifier to specify trace points in your code of interest to you.
253 \end{enumerate}
254
255 The functions available are as follows:
256
257 \begin{itemize}
258 \item
259 {\tt int traceRegisterUserEvent(char* EventDesc, int EventNum=-1) }
260
261 This function registers a user event by associating {\tt EventNum} to
262 {\tt EventDesc}. If {\tt EventNum} is not specified, a globally unique
263 event identifier is obtained from the runtime and returned. The string {\tt EventDesc} must either be a constant string, or it can be a dynamically allocated string that is {\bf NOT} freed by the program. If the {\tt EventDesc} contains a substring ``***'' then the Projections Timeline tool will draw the event vertically spanning all PE timelines.
264
265 {\tt EventNum} has to be the same on all processors. Therefore use one of the following methods to ensure the same value for any PEs generating the user events:
266
267 \begin{enumerate}
268 \item
269 Call {\tt traceRegisterUserEvent} on PE 0 in main::main without specifying
270 an event number, and store returned event number into a readonly variable.
271 \item
272 Call {\tt traceRegisterUserEvent} and specify the event number on
273 processor 0. Doing this on other processors would have no
274 effect. Afterwards, the event number can be used in the following user
275 event calls.
276 \end{enumerate}
277
278 Eg. {\tt traceRegisterUserEvent("Time Step Begin", 10);}
279
280 Eg. {\tt eventID = traceRegisterUserEvent(``Time Step Begin'');}
281
282 \end{itemize}
283
284
285
286 There are two main types of user events, bracketed and non bracketed. Non-bracketed user events mark a specific point in time. Bracketed user events span an arbitrary contiguous time range. Additionally, the user can supply a short user supplied text string that is recorded with the event in the log file. These strings should not contain newline characters, but they may contain simple html formatting tags such as \texttt{<br>}, \texttt{<b>}, \texttt{<i>}, \texttt{<font color=\#ff00ff>}, etc.
287
288 The calls for recording user events are the following:
289
290 \begin{itemize}
291
292
293 \item
294 {\tt void traceUserEvent(int EventNum) }
295
296 This function creates a user event that marks a specific point in time.
297
298 Eg. {\tt traceUserEvent(10);}
299
300 \item
301 {\tt void traceUserBracketEvent(int EventNum, double StartTime, double EndTime) }
302
303 This function records a user event spanning a time interval from {\tt StartTime} to {\tt EndTime}. Both {\tt StartTime} and {\tt EndTime} should be obtained from a call to {\tt CmiWallTimer()} at the appropriate point in the program.
304
305 Eg.
306 \begin{verbatim}
307    traceRegisterUserEvent("Critical Code", 20); // on PE 0
308    double critStart = CmiWallTimer();;  // start time
309    // do the critical code
310    traceUserBracketEvent(20, critStart,CmiWallTimer());
311 \end{verbatim}
312
313
314
315
316
317 \item
318 {\tt void traceUserSuppliedNote(char * note) }
319
320 This function records a user specified text string at the current time.
321
322
323
324
325 \item
326 {\tt void traceUserSuppliedBracketedNote(char *note, int EventNum, double StartTime, double EndTime)}
327
328 This function records a user event spanning a time interval from {\tt StartTime} to {\tt EndTime}. Both {\tt StartTime} and {\tt EndTime} should be obtained from a call to {\tt CmiWallTimer()} at the appropriate point in the program.
329
330 Additionally, a user supplied text string is recorded, and the  {\tt EventNum} is recorded. These events are therefore displayed with colors determined by the {\tt EventNum}, just as those generated with {\tt traceUserBracketEvent} are.
331
332 \end{itemize}
333
334
335 \subsubsection{Function-level Tracing for Adaptive MPI Applications}
336 \label{sec::AMPI functions}
337
338 Adaptive MPI (AMPI) is an implementation of the MPI interface on top
339 of \charmpp{}. As with standard MPI programs, the appropriate semantic
340 context for performance analysis is captured through the observation
341 of MPI calls within C/C++/Fortran functions. Unfortunately, AMPI's
342 implementation does not grant the runtime access to information about
343 user function calls. As a result, the tracing framework must provide
344 an explicit API for capturing this piece of performance information in
345 addition to MPI calls (which are known to the runtime).
346
347 The functions, similar to those used to capture user events, are as
348 follows:
349
350 \begin{itemize}
351 \item 
352 \begin{verbatim}
353 int _TRACE_REGISTER_FUNCTION_NAME(const char *name);
354 \end{verbatim}
355 This function registers an AMPI function {\tt name}. The tracing
356 framework assigns to function {\tt name} a unique id and returns
357 it. It is the user's responsibility to ensure that {\tt name} is
358 unique and consistent.
359
360 This registration function should be called near the start of the
361 application, just after {\tt MPI\_Init}.
362
363 \item
364 \begin{verbatim}
365 int _TRACE_REGISTER_FUNCTION_ID(const char *name, int idx);
366 \end{verbatim}
367 This function registers an AMPI function {\tt name} to be associated
368 explicitly to the id {\tt idx}. It is the user's responsibility to 
369 ensure that {\tt name} as well as {\tt idx} are unique and consistent.
370 The tracing framework returns {\tt idx}.
371
372 This is an alternative registration function and should be called near
373 the start of the application just after {\tt MPI\_Init}.
374
375 \item
376 \begin{verbatim}
377 void _TRACE_BEGIN_FUNCTION_NAME(const char *name);
378 \end{verbatim}
379 This function tells the tracing framework to record a begin event
380 associated with the registered function {\tt name}. If this were called
381 in a C/C++ environment with pre-processor support, the line number of
382 the function call will also be recorded.
383
384 \item
385 \begin{verbatim}
386 void _TRACE_BEGIN_FUNCTION_ID(int idx);
387 \end{verbatim}
388 This function tells the tracing framework to record a begin event
389 associated with the registered function indexed by {\tt idx}. If this were
390 called in a C/C++ environment with pre-processor support, the line number
391 of the function call will also be recorded.
392
393 \item
394 \begin{verbatim}
395 void _TRACE_END_FUNCTION_NAME(const char *name);
396 \end{verbatim}
397 This function tells the tracing framework to record a end event
398 associated with the registered function {\tt name}.
399
400 \item
401 \begin{verbatim}
402 void _TRACE_END_FUNCTION_ID(int idx);
403 \end{verbatim}
404 This function tells the tracing framework to record a end event
405 associated with the registered function indexed by {\tt idx}.
406
407 \end{itemize}
408
409 AMPI function events captured by the use of this API are recognized by
410 the visualization system and used for special AMPI-specific views in
411 addition to standard \charmpp{} entry methods.
412
413 %\subsubsection{Tracing POSE Parallel Discrete Event Simulation Abstractions}
414 %\label{sec::POSE}
415 %
416 %Parallel Object-oriented Simulation Environment (POSE) is a parallel
417 %discrete event simulator (PDES) implemented on top of
418 %\charmpp{}. Understanding the performance of simulations conducted
419 %using POSE requires not just the performance of POSE as the \charmpp{}
420 %runtime system sees it (through entry methods), but also requires the
421 %understanding of PDES progress and degree-of-parallelism in real time
422 %as well as virtual time.
423 %
424 %As a result, POSE provides its own performance data format that the
425 %\projections{} visualization tool understands when a POSE simulation
426 %is executed with the {\tt +dop\_pose} runtime option. No additional
427 %user intervention is required.
428
429 \section{Advanced Tracing Features}
430 \label{sec::advanced tracing features}
431
432 \subsection{End-of-run Analysis for Data Reduction}
433 \label{sec::data reduction}
434
435 As applications are scaled to thousands or hundreds of thousands of
436 processors, the amount of data generated becomes extremely large and
437 potentially unmanagable by the visualization tool. At the time of this
438 documentation, \projections{} is capable of handling data from 8000+
439 processors but with somewhat severe tool responsiveness issues. We
440 have developed an approach to mitigate this data size problem with
441 options to trim-off ``uninteresting'' processors' data by not writing
442 such data at the end of an application's execution.
443
444 This is currently done through heuristics to pick out interesting
445 extremal (i.e. poorly behaved) processors and at the same time using a
446 k-means clustering to pick out exemplar processors from equivalence
447 classes to form a representative subset of processor data. The analyst
448 is advised to also link in the summary module via {\tt +tracemode
449 summary} and enable the {\tt +sumDetail} option in order to retain
450 some profile data for processors whose data were dropped.
451
452 \begin{itemize}
453 \item
454 {\tt +extrema}: enables extremal processor identification analysis at
455 the end of the application's execution.
456 \item
457 {\tt +numClusters}: determines the number of clusters (equivalence
458 classes) to be used by the k-means clustering algorithm for
459 determining exemplar processors. Analysts should take advantage of
460 their knowledge of natural application decomposition to guess at a
461 good value for this.
462 \end{itemize}
463
464 This feature is still being developed and refined as part of our
465 research. It would be appreciated if users of this feature could
466 contact the developers if you have input or suggestions.
467
468 \newpage
469
470 \section{The \projections{} Performance Visualization Tool}
471 \label{sec::visualization}
472
473 The \projections{} Java-based visualization tool (henceforth refered
474 to as simply \projections{}) comes pre-built with the \charmpp{}
475 source release. It can be located at \\ {\tt
476 CHARM\_LOCATION/tools/projections} which will henceforth be refered to
477 as {\tt PROJECTIONS\_LOCATION}.
478
479 \subsection{Building \projections{}}
480
481 To rebuild \projections{} (optional) from the source:
482
483 \begin{enumerate}
484 \item[1)]
485    Make sure the JDK commands ``java'', ``javac'', ``ant'',  and ``jar''
486    are in your path  
487 \item[2)]
488    Make sure that your versions of java and javac are at least 1.5. Do this by running ``java -version'' and ``javac -version''. Also, make sure the environment variable JAVA\_HOME is not pointing at an old version of java.
489 \item[3)]
490    From {\tt PROJECTIONS\_LOCATION/}, type ``ant clean'' then ``ant''
491 \item[4)]
492    The following files are placed in `bin':
493
494       {\tt projections}           : Starts projections, for UNIX machines
495
496       {\tt projections.bat}       : Starts projections, for Windows machines
497
498       {\tt projections.jar}       : archive of all the java and image files
499 \end{enumerate}
500
501 \subsection{Visualization and Analysis using \projections{}}
502
503 \subsubsection{Starting Up}
504 \label{sec:startingUp}
505 From any location, type: \\
506 {\tt > PROJECTIONS\_LOCATION/bin/projections [NAME.sts]} \\
507 where {\tt PROJECTIONS\_LOCATION} is the path to the main projections
508 directory.
509
510 Available options to the visualization component of \projections{} include:
511
512 \begin{itemize}
513 \item
514 {\tt -h or --help}: displays help information about available options.
515 \item
516 {\tt -V or --version}: displays current \projections{} version number.
517 \item
518 {\tt -u or --use-version $<ver>$}: overrides the data interpretation
519 behavior of \projections{} to explicitly use $ver$ instead of the
520 current version. This is useful in scenarios where the latest version
521 of \projections{} is not backward-compatible with older log formats.
522 \item
523 {\tt -no-idle}: tells \projections{} to ignore idle time information
524 contained in the logs.
525 \item
526 {\tt -bgsize $<x> <y> <z>$}: tells \projections{} to compute
527 additional derived information by assuming a logical 3-D Torus
528 topology with the specified dimensionality and a processor-to-torus
529 placement policy that matches \charmpp's placement policy on the BG/L
530 class of machines. The presence of this option enables additional
531 communication visualization options (see later). Note that this option
532 is really meant to be used for logs generated from virtual-node mode
533 BG/L executions. The additional information derived from any other
534 logs would probably be misleading.
535 \item
536 {\tt -print\_usage}: tells \projections{} to also write to standard
537 output the detailed graph numbers when viewing Usage Profiles (see
538 later). This is useful for generating visuals that are better
539 expressed by tools such as gnuPlot than through screen captures of
540 \projections{} plots.
541 \end{itemize}
542
543 Supplying the optional {\tt NAME.sts} file in the command line will
544 cause \projections{} to load data from the file at startup. This shortcut
545 saves time selecting the desired dataset via the GUI's file dialog.
546
547 \begin{figure}[hbt]
548 \center
549 %\epsfig{figure=fig/front-with-summary.eps,height=4in}
550 \includegraphics[width=4.0in]{fig/front-with-summary}
551 \caption{\projections{} main window}
552 \label{mainwindow}
553 \end{figure}
554
555 When \projections{} is started, it will display a main window as shown
556 in figure \ref{mainwindow}. If summary (.sum) files are available in
557 the set of data, a low-resolution utilization graph (Summary Display)
558 will be displayed as shown. If summary files are not available, or if
559 \projections{} was started without supplying the optional {\tt
560 NAME.sts} file, the main window will show a blank screen.
561
562 %{\bf Menu Options}
563
564 \begin{itemize}
565 \item
566   {\bf File} contains 3 options. {\it Open File(s)} allows you to
567   explicitly load a data set. This happens if you had not specified a
568   {\tt NAME.sts} file in the command line when starting \projections{}
569   or if you wish to explicitly load a new dataset. It brings up a
570   dialog box that allows you to select the location of the dataset you
571   wish to study. Navigate to the directory containing your data and
572   select the .sts file.  Click on `Open'. If you have selected a valid
573   file, \projections{} will load in some preliminary data from the
574   files and then activate the rest of the options under the menu item
575   {\bf Tools}. {\it Close current data} currently works the same way
576   as {\it Close all data}. They unload all current \projections{} data
577   so one can load in a new set of data. They will also deactivate the
578   individual items provided in the {\bf Tools} menu option.
579 \item
580   {\bf Preferences} generally allows you to set foreground or background
581   colors and entry method color schemes. This is useful for configuring
582   the color schemes of \projections{} windows to be print-friendly.
583 \item
584   {\bf Tools} lists the set of available tools for analysis of generated
585   trace data. It will be described in great detail under section
586   \ref{sec::available tools}.
587 \end{itemize}
588
589 %{\bf Summary Display}
590
591 The Summary Display loaded on the Main Window displays basic processor
592 utilization data (averaged across all processors) over time
593 intervals. This is provided by the data generated by the summary
594 tracemode. This view offers no special features over and above the
595 {\bf Standard Graph Display} described in section \ref{sec::misc}. 
596 Please refer the appropriate section on information for using
597 its available features.
598
599 %{\bf Summary Display Performance Issues}
600
601 There should not be any serious performance issues involved in the
602 loading of summary data on the main window.
603
604 \subsubsection{Available Tools}
605 \label{sec::available tools}
606
607 The following tools and views become available to you after a dataset
608 has been loaded (with the exception of Multirun Analysis) and may be
609 accessed via the menu item Tools:
610
611 \begin{itemize}
612 \item 
613 The {\bf Graphs} view is where you can analyze your data by breaking it
614 into any number of intervals and look at what goes on in each of those
615 intervals.
616 \item
617 The {\bf Timelines} view lets you look at what a specific processor is
618 doing at each moment of the program. It is the most detailed view of a
619 parallel application \projections{} offers (and correspondingly, the
620 most resource-hungry).
621 \item
622 The {\bf Usage Profile} view lets you see percentage-wise what entry
623 methods each processor spends its time on during a specified time range.
624 It is particularly useful for identifying load imbalance and the probable
625 offending entry method.
626 \item
627 The {\bf Communication} view is a general tool that presents
628 communication properties contributed by each entry point across the
629 processors.
630 \item
631 The {\bf Log File Viewer} provides a human-readable, verbose
632 interpretation of a log file's entries.
633 \item
634 The {\bf Histograms} view presents entry point or communication
635 histogram information (ie. the frequency of occurrence of events given
636 an activity property like time bin size or message size on the
637 x-axis).
638 \item
639 The {\bf Overview} view gives user an overview of the utilization of
640 all processors during the execution. It is an extremely useful initial
641 tool to begin your performance analysis efforts with as it provides an
642 overall picture of application performance while being very
643 light-weight at the same time.
644 \item
645 The {\bf Animation} view animates the processor usage over a specified
646 range of time and a specified interval size.
647 \item
648 The {\bf Time Profile Graph} view is a more detailed presentation of
649 the {\bf Graphs} utilization view in that it presents the time
650 contribution by each entry point across the desired time
651 interval. While the {\bf Graphs} view can show the same data, it is
652 unable to stack the entry points, which proves useful in some cases.
653 \end{itemize}
654
655 \subsection{Performance Views}
656
657 \subsubsection{Graphs}
658 \label{sec::graph view}
659
660 %{\bf Introduction}
661
662 The Graphs window (see figure \ref{graph}) is where you can analyze your data by breaking it
663 into any number of intervals and look at what goes on in each of those
664 intervals.
665
666 %{\bf Dialog Box}
667
668 When the Graph Window first appears, a dialog box will also appear. It
669 will ask for the following information (Please refer to
670 \ref{sec::misc} for information on special features you can
671 use involving the various fields)::
672
673 \begin{itemize}
674 \item
675 Processor(s): Choose which processor(s) you wish to visualize graph 
676 information for.
677 \item
678 Start Time : Choose the starting time of interest. A time-based field.
679 \item
680 End Time : Choose the ending time of interest. A time-based field.
681 \item
682 Interval Size : Determine the size of an interval. The number of intervals
683 will also be determined by this value (End Time - Start Time divided by
684 Interval Size). A time-based field.
685 \end{itemize}
686
687 Standard \projections{} dialog options and buttons are also available
688 (see \ref{sec::misc} for details).
689
690 The following menu items are available:
691
692 \begin{itemize}
693 \item
694 {\bf File} contains 2 options: {\it Print Graph} uses Java's built-in 
695 print manager feature to render the tool's displays (usually to a printer 
696 or a file depending on the platform on which Java is supported). Note that
697 the current implementation of the renderer does not behave in exactly the
698 same fashion as the screen renderer, so you should expect the output to look
699 somewhat different. {\it Close} simply closes the Graph window.
700 \item
701 {\bf Tools} contains 2 options: {\it Set Interval Size} reloads the dialog
702 box so you could select a new time range over which to view Graph data.
703 {\it Timeline} is currently not implemented. Its intended as a convenient
704 way to load Timeline data (see section \ref{sec::timeline view}) over the 
705 same parameters as the current Graph view.
706 \end{itemize}
707
708 %{\bf Tool Performance }
709
710 The amount of time to analyze your data depends on several factors,
711 including the number of processors, number of entries, and number of
712 intervals you have selected.  A progress meter will show the amount of
713 data loaded so far. The meter will not, however, report rendering
714 progress which is determined mainly by the number of intervals selected.
715 As a rule of thumb, limit the number of intervals to 1,000 or less.
716
717 \begin{figure}[hbt]
718 \center
719 %\epsfig{figure=fig/graph.eps,height=4.3in}
720 \includegraphics[width=4.3in]{fig/graph}
721 \caption{Graph tool}
722 \label{graph}
723 \end{figure}
724
725 %{\bf Tool Features }
726
727 The Graph Window has 3 components in its display:
728 \begin{enumerate}
729 \item[1)]
730 {\bf Display Panel} (located : top-left area)
731    \begin{itemize}
732    \item[-]
733    Displays title, graph, and axes. To the left is a y-axis bar for
734    detailed information involving the number of messages sent or time
735    executed depending on the {\bf Control Panel} toggle selected (see 
736    below). To the right is a y-axis bar for average processor-utilization 
737    information. The x-axis may be based on time-interval or per-processor
738    information depending on the appropriate {\bf Control Panel} toggle.
739    \item[-]
740    Allows you to toggle display between a line graph and a bar graph.
741    \item[-]
742    Allows you to scale the graph along the X-axis.  You can either
743    enter a scale value $>=$ 1.0 in the text box, or you can use the
744    $<<$ and $>>$ buttons to increment/decrement the scale by .25.
745    Clicking on Reset sets the scale back to 1.0.  When the scale is
746    greater than 1.0, a scrollbar will appear along the bottom of the
747    graph to let you scroll back and forth.
748    \end{itemize}
749 \item[2)]
750 {\bf Legend Panel} (located : top-right area)
751    \begin{itemize}
752    \item[-]
753    Shows what information is currently being displayed on the graph and 
754    what color represents that information.
755    \item[-]
756    Click on the `Select Display Items' button to bring up a window to
757    add/remove items from the graph and to change the colors of the items:
758       \begin{itemize}
759       \item[*]
760       The {\bf Select Display Items} window shows a list of items that you
761       can display on the graph.  There are 3 main sections: System
762       Usage, System Msgs, and User Entries. The System Usage and System
763       Msgs are the same for all programs. The User Entries section
764       has program-specific items in it.
765       \item[*]
766       Click on the checkbox next to an item to have it displayed on the
767       graph.
768       \item[*]
769       Click on the colorbox next to an item to modify its color.
770       \item[*]
771       Click on `Select All' to choose all of the items
772       \item[*]
773       Click on `Clear All' to remove all of the items
774       \item[*]
775       Click on `Apply' to apply you choices/changes to the graph
776       \item[*]
777       Click on `Close' to exit
778       \end{itemize}
779    \end{itemize}
780 \item[3)]
781 {\bf Control Panel} (located : bottom area)
782    \begin{itemize}
783    \item[-]
784    Allows you to toggle what is displayed on the X-axis.  You can either
785    have the x-axis display the data by interval or by processor.
786    \item[-]
787    Allows you to toggle what is displayed on the Y-axis.  You can
788    either have the y-axis display the data by the number of msgs sent
789    or by the amount of time taken.
790    \item[-]
791    Allows you to change what data is being displayed by iterating
792    through the selections.  If you have selected an x-axis type of
793    `interval', that means you are looking at what goes on in each
794    interval for a specific processor.  Clicking on the $<<, <, >, >>$
795    buttons will change the processor you are looking at by either -5,
796    -1, +1, or +5.  Conversely, if you have an x-axis of `processor',
797    then the iterate buttons will change the value of the interval that
798    you are looking at for each processor.
799    \item[-]
800    Allows you to indicate which intervals/processors you want to
801    examine.  Instead of just looking at one processor or one interval,
802    the box and buttons on the right side of this panel let you choose
803    any number or processors/intervals to look at. This field behaves
804    like a processor field. Please refer to section \ref{sec::misc} 
805    for more information about the special features on using processor
806    fields.
807
808    Clicking on `Apply' updates the graph with your choices. Clicking
809    on `Select All' chooses the entire processor range.  When you
810    select more than one processor's worth of data to display, the
811    graph will show the desired information summed across all selected
812    processors. The exception to this is processor utilization data
813    which is always displayed as data averaged across all selected
814    processors.
815    \end{itemize}
816 \end{enumerate}
817
818 \subsubsection{Timelines}
819 \label{sec::timeline view}
820
821 %{\bf Introduction}
822
823 The Timeline window (see figure \ref{timeline}) lets you look at what
824 a specific processor is doing at each moment of the program.
825
826 \begin{figure}[htb]
827 \center
828 %\epsfig{figure=fig/timeline.eps,height=3.8in}
829 \includegraphics[width=3.8in]{fig/timeline}
830 \caption{Timeline Tool}
831 \label{timeline}
832 \end{figure}
833
834 %{\bf Dialog Box}
835
836 When opening a Timeline view, a dialog box appears. 
837 The box asks for the following information (Please refer to
838 \ref{sec::misc} for information on special features you can
839 use involving the various fields):
840
841 \begin{itemize}
842 \item
843 Processor(s): Choose which processor(s) you want to see in the timeline.
844 \item
845 Start Time  : Choose what time you want your timeline to start at.
846 A time-based field.
847 \item
848 End Time    : Choose what time you want your timeline to end at. A time-based
849 field.
850 \end{itemize}
851
852 Standard \projections{} dialog options and buttons are also available
853 (see \ref{sec::misc} for details).
854
855
856 The following menu options are available:
857
858 \begin{itemize}
859 \item {\bf File} contains 1 enabled option: 
860 {\it Close} simply closes the Timeline Window.
861 \item {\bf Tools} contains 1 option: {\it Modify Ranges} opens the initial 
862 dialog box thereby allowing you to select new set of processors or time duration
863 parameters.
864 \item {\bf Colors} contains options for loading, using, and modifying color schemes. {\it Change Colors} functions in
865 a manner similar to the button of the same name described under control 
866 panel information below. {\it Save Colors} allows you to save the current
867 color set to a file named ``color.map'' into the same directory where your
868 data logs are stored. Note that the directory must have write permissions
869 for you before this can work. We are currently working on a more flexible
870 scheme for storing saved color sets. {\it Restore Colors} allows you to
871 load any previously saved color sets described above. {\it Default Colors}
872 resets the current color set to the default set that \projections{} assigns
873 without user intervention.
874
875 Other color schemes are provided that can be used for some applications. The colors set as described above are the default coloring scheme. Other options for coloring the events are by event id (chare array index), user supplied parameter, or memory usage. In order to color by a user supplied parameter such as timestep, the C function  \texttt{traceUserSuppliedData(int value);} should be called within some entry methods. If such a method is called in an entry method, the entry method invocation can be colored by the parameter. The user supplied data can also be viewed in the tooltip that appears when the cursor hovers over an entry method invocation in the window. To color by memory usage, the C function \texttt{traceMemoryUsage();} should be called in all entry methods. The call records the current memory usage. Red indicates high memory usage, and green indicates low memory usage. The actual memory usage can also be viewed in the tooltips that appear when the cursor is over an event. The memory usage is only available in when using a Charm++ version that uses gnu memory.
876
877
878 \item {\bf Screenshot} contains 1 option: 
879 {\it Save as JPG or PNG} save the visible portion of the visualization
880 to an image file. You must choose a filename ending with a \texttt{.png}
881 or \texttt{.jpg} extension when choosing the location to save the image. The
882 appropriate filetype is chosen based on the chosen filename
883 extension. If the view is zoomed in, only the portion currently shown
884 on screen is saved.
885
886 \end{itemize}
887
888 The Timeline Window consists of two parts:
889 \begin{enumerate}
890 \item[1)]
891 {\bf Display Panel} (located: top area)
892
893 This is where the timelines are displayed and is the largest portion
894 of the window.  The time axis is displayed at the top 
895 of the panel.  The left side of the
896 panel shows the processor labels, each containing a processor number and
897 two strange numbers. These two numbers represent the percentage of the
898 loaded timeline during which work occurs. The first of the two numbers
899 is the ``non-idle'' time, i.e. the portion of the time in the timeline
900 not spent in idle regions. This contains both time for entry methods
901 as well as other uninstrumented time spent likely in the Charm++
902 runtime. The second number is the percentage of the time used by the
903 entry methods for the selected range.
904
905
906 The timeline itself consists of colored bars for each event.
907 Placing the cursor over any of these bars will display information 
908 about the event including:  the name, the begin time, the end
909 time, the total time, the time spent packing, the number of messages it
910 created, and which processor created the event. 
911
912 Left clicking on an event bar will cause a window to popup. This
913 window contains detailed information about the messages sent by the
914 clicked upon event.
915
916 Right clicking on an event bar will cause a line to be drawn to the
917 beginning of the event bar from the point where the message causing
918 the event originated. This option may not be applicable for threaded
919 events. If the message originated on a processor not currently
920 included in the visualization, the other processor will be loaded, and
921 then the message line will be drawn. A warning message will appear if
922 the message origination point is outside the time duration, and hence
923 no line will be drawn.
924
925 User events are displayed as bars above the ordinary
926 event bars in the display area. If the name of the user event contains a substring ``***'' then the bar will vertically span the whole screen.
927
928 Message pack times and send points can be displayed below the event
929 bars. The message sends are small white tick marks, while the message
930 pack times are small pink bars usually occurring immediatly after the
931 message send point. If zoomed in to a point where each microsecond
932 takes more than one pixel, the message send point and the following
933 packing time may appear disconnected. This is an inherent problem with
934 the granularity used for the logfiles.
935
936
937 \item[2)]
938 {\bf Control Panel} (located: bottom area)
939
940 The controls in this panel are obvious, but we mention one here anyway.
941
942    View User Event - Checking this box will bring up a new
943    window showing the string description, begin time, end time and
944    duration of all user events on each processor. You can access
945    information on user events on different processors by accessing the
946    numbered tabs near the top of the display.
947
948    \begin{figure}[htb]
949    \center
950 %\epsfig{figure=fig/userevent.eps,height=1.5in}
951    \includegraphics[height=1.5in]{fig/userevent}
952    \caption{User Event Window}
953    \label{userevent}
954    \end{figure}
955
956 \end{enumerate}
957
958 Various features appear when the user moves the mouse cursor over the
959 top axis. A vertical line will appear to highlight a specific
960 time. The exact time will be displayed at the bottom of the
961 window. Additionally a user can select a range by clicking while a
962 time is highlighted and dragging to the left or right of that
963 point. As a selection is being made, a vertical white line will mark
964 the beginning and end of the range. Between these lines, the
965 background color for the display will change to gray to better
966 distinguish the selection from the surrounding areas. After a
967 selection is made, its duration is displayed at the bottom. A user can
968 zoom into the selection by clicking the ``Zoom Selected'' button. To
969 release a selection, single-click anywhere along the axis. Clicking
970 ``Load Selected'' when a selection is active will cause the timeline
971 range to be reloaded. To zoom out, the ``<<'' or ``Reset'' button can be used.
972
973
974 To then zoom into the selected area via this interface, click on
975 either the ``Zoom Selected'' or the ``Load Selected'' buttons.  The
976 difference between these two buttons is that the "Load Selected" zooms
977 into the selected area and discards any events that are outside the
978 time range.  This is more efficient than ``Zoom Selected'' as the
979 latter draws all the events on a virtual canvas and then zooms into
980 the canvas. The disadvantage of using ``Load Selected'' is that it
981 becomes impossible to zoom back out without having to re-specify the
982 time range via the ``Select Ranges'' button.
983
984 Performance-wise, this is the most memory-intensive part of the
985 visualization tool. The load and zoom times are proportional to the
986 number of events displayed. The user should be aware of how event-intensive the application is
987 over the desired time-period before proceeding to use this view. If
988 \projections{} takes too long to load a timeline, cancel the load and
989 choose a smaller time range or fewer processors. We expect to add features to alleviate
990 this problem in future releases.
991
992 \subsubsection{Usage Profile}
993 \label{sec::usage profile}
994 The Usage Profile window (see figure \ref{usage profile}) lets you see
995 percentage-wise what each processor spends its time on during a
996 specified period.
997
998 When the window first comes up, a dialog box appears asking for the
999 processor(s) you want to look at as well as the time range you want to
1000 look at.  This dialog functions in exactly the same way as for the Timeline
1001 tool (see section \ref{sec::timeline view}).
1002
1003 \begin{figure}[htb]
1004 \center
1005 %\epsfig{figure=fig/usageprofile.eps,height=4in}
1006 \includegraphics[width=4.0in]{fig/usageprofile}
1007 \caption{Usage Profile}
1008 \label{usage profile}
1009 \end{figure}
1010
1011 The following menu options are available in this view:
1012
1013 \begin{itemize}
1014 \item {\bf File} has 2 options: {\it Select Processors} reloads the dialog
1015 box for the view and allows you to select a new processor and time range
1016 for this view. {\it Print Profile} currently does nothing. This will be
1017 addressed in a later release of \projections{}.
1018 \end{itemize}
1019
1020 The following components are supported in this view:
1021
1022 \begin{itemize}
1023 \item[1)] 
1024 {\bf Main Display} (located: top area) 
1025 The left axis of the display shows a scale from 0\% to 100\%.  The
1026 main part of the display shows the statistics.  Each processor is
1027 represented by a vertical bar with the leftmost bar representing the
1028 statistics averaged across all processors. The bottom of the bar
1029 always shows the time spent in each entry method (distinguished by the
1030 entry method's assigned color) . Above that is always reported the
1031 message pack time (in black), message unpack time (in orange) and idle
1032 time (in white). Above this, if the information exists, are colored
1033 bars representing communication CPU overheads contributed by each
1034 entry method (again, distinguished by the same set of colors
1035 representing entry methods). Finally the black area on top represents
1036 time overheads that the \charmpp{} runtime cannot account for.
1037
1038 If you mouse-over a portion of the bar (with the exception of the
1039 black area on top), a pop-up window will appear telling you the name
1040 of the item, what percent of the usage it has, and the processor it is
1041 on.
1042
1043 \item[2)]
1044 {\bf Control Panel} (located: bottom area)
1045 The panellets you adjust the scales in both the X and Y directions.
1046 The X direction is useful if you are looking at a large number of
1047 processors. The Y direction is useful if there are small-percentage
1048 items for a processor. The ``Reset'' button allows you to reset the 
1049 X and Y scales.
1050
1051 The ``Pie Chart'' button generates a pie chart representation (see
1052 figure \ref{piechart}) of the same information using averaged
1053 statistics but without idle time and communication CPU overheads.
1054
1055 \begin{figure}[htb]
1056 \center
1057 %\epsfig{figure=fig/piechart.eps,height=1in}
1058 \includegraphics[width=1.8in]{fig/piechart}
1059 \caption{Pie Chart representation of average usage}
1060 \label{piechart}
1061 \end{figure}
1062
1063 The ``Change Colors'' button lists all entry methods displayed on the
1064 main display and their assigned colors. It allows you to change those
1065 assigned colors to aid in highlighting entry methods.
1066
1067 The resource consumption of this view is moderate. Load times and
1068 visualization times should be relatively fast, but dismissing the tool
1069 may result in a very slight delay while \projections{} reclaims memory
1070 through Java's garbage collection system.
1071
1072 \end{itemize}
1073
1074 \subsubsection{Communication}
1075 \label{sec::communication}
1076
1077 The communication tool (see figure \ref{communication}) visualizes
1078 communication properties on each processor over a user-specified time
1079 range.
1080
1081 The dialog box of the tool allows you to specify the time period
1082 within which to load communication characteristics information. This
1083 dialog box is exactly the same as that of the Timeline tool (see
1084 section \ref{sec::timeline view}).
1085
1086 The main component employs the standard capabilities provided by
1087 \projections{}' standard graph (see \ref{sec::misc}).
1088
1089 The control panel allows you to switch between the following
1090 communication characteristics:
1091
1092 \begin{itemize}
1093 \item[-] Number of Messages Sent by entry methods (initial default view);
1094 \item[-] Number of Bytes Sent by entry methods;
1095 \item[-] Number of Messages Received by entry methods;
1096 \item[-] Number of Bytes Received by entry methods;
1097 \item[-] Number of Messages Sent externally (physically) by entry methods;
1098 \item[-] Number of Bytes Sent externally (physically) by entry methods;
1099 \item[-] and Number of hops messages travelled before being received
1100 by an entry methods. This is available when the runtime option {\tt -bgsize}
1101 (See section \ref{sec:startingUp}) is supplied.
1102 \end{itemize}
1103
1104 \begin{figure}[htb]
1105 \center
1106 %\epsfig{figure=fig/commhistogram.eps,height=4in}
1107 \includegraphics[width=4.0in]{fig/apoa1_512_CommProcessorProfile}
1108 \caption{Communication View}
1109 \label{communication}
1110 \end{figure}
1111
1112 This view uses memory proportional to the number of processors selected.
1113
1114 \subsubsection{Communication vs Time}
1115
1116 The communication over time tool (see figure \ref{communication-time})
1117 visualizes communication properties over all processors and displayed
1118 over a user-specified time range on the x-axis.
1119
1120 The dialog box of the tool allows you to specify the time period
1121 within which to load communication characteristics information. This
1122 dialog box is exactly the same as that of the Communication tool (see
1123 section \ref{sec::communication}).
1124
1125 The main component employs the standard capabilities provided by
1126 \projections{}' standard graph (see \ref{sec::misc}).
1127
1128 The control panel allows you to switch between the following
1129 communication characteristics:
1130
1131 \begin{itemize}
1132 \item[-] Number of Messages Sent by entry methods (initial default view);
1133 \item[-] Number of Bytes Sent by entry methods;
1134 \item[-] Number of Messages Received by entry methods;
1135 \item[-] Number of Bytes Received by entry methods;
1136 \item[-] Number of Messages Sent externally (physically) by entry methods;
1137 \item[-] Number of Bytes Sent externally (physically) by entry methods;
1138 \item[-] and Number of hops messages travelled before being received
1139 by an entry methods (available only on trace logs generated on the
1140 Bluegene machine).
1141 \end{itemize}
1142
1143 \begin{figure}[htb]
1144 \center
1145 %\epsfig{figure=fig/commhistogram.eps,height=4in}
1146 \includegraphics[width=4.0in]{fig/apoa1_512_CommTimeProfile}
1147 \caption{Communication View over Time}
1148 \label{communication-time}
1149 \end{figure}
1150
1151 This view has no known problems loading any range or volume of data.
1152
1153 \subsubsection{View Log Files}
1154
1155 This window (see figure \ref{viewlog}) lets you see a translation of a
1156 log file from a bunch of numbers to a verbose version.  A dialog box
1157 asks which processor you want to look at.  After choosing and pressing
1158 OK, the translated version appears. Note that this is {\it not} a
1159 standard processor field. This tool will only load {\it exactly} one
1160 processor's data.
1161
1162 \begin{figure}[htb]
1163 \center
1164 %\epsfig{figure=fig/viewlog.eps,height=4in}
1165 \includegraphics[width=2.5in]{fig/viewlog}
1166 \caption{Log File View}
1167 \label{viewlog}
1168 \end{figure}
1169
1170 Each line has:
1171 \begin{itemize}
1172 \item[-] a line number (starting at 0)
1173 \item[-] the time the event occurred at
1174 \item[-] a description of what happened.
1175 \end{itemize}
1176
1177 This tool has the following menu options:
1178
1179 \begin{itemize}
1180 \item {\bf File} has 2 options: {\it Open File} reloads the dialog box
1181 and allows the user to select a new processor's data to be loaded.
1182 {\it Close} closes the current window.
1183 \item {\bf Help} has 2 options: {\it Index} currently does not do anything.
1184 This will be addressed in a later release of \projections{}. {\it About}
1185 currently does not do anything. This will also be addressed in a later
1186 release of \projections{}.
1187 \end{itemize}
1188
1189 The tool has 2 buttons. ``Open File'' reloads the dialog box (described 
1190 above) and allows the user to select a new processor's data to be loaded.
1191 ``Close Window'' closes the current window.
1192
1193 \subsubsection{Histograms}
1194
1195 This module (see figure \ref{histogram}) allows you to examine the
1196 performance property distribution of all your entry points (EP). It
1197 gives a histogram of different number of EP's that have the following
1198 properties falling in different property bins:
1199
1200 The dialog box for this view asks the following information from the
1201 user. (Please refer to \ref{sec::misc} for information on special
1202 features you can use involving the various fields):
1203
1204 \begin{itemize}
1205 \item
1206 Processor(s): Choose which processor(s) you wish to visualize histogram
1207 information for.
1208 \item
1209 Start Time: Choose the starting time of interest. A time-based field.
1210 \item
1211 End Time: Choose the ending time of interest. A time-based field.
1212 \item
1213 Number of Bins: Select the number of property bins to fit frequency data
1214 under. A simple numeric field.
1215 \item
1216 Size of Bin: Determine (in units - microseconds or bytes) how large each
1217 bin should be. A simple numeric field.
1218 \item
1219 Starting Bin Size: Determine (in units - microseconds or bytes) how
1220 far to offset the data. This is useful for ignoring data that is too
1221 small to be considered significant, but could overwhelm other data
1222 because of the sheer numbers of occurrences. A simple numeric field.
1223 \end{itemize}
1224
1225 The dialog box reports the selection of bins as specified by the user
1226 by displaying the minimum bin size (in units - microseconds or bytes)
1227 to the maximum bin size. ``units'' refer to microseconds for time-based
1228 histograms or bytes for histograms representing message sizes.
1229
1230 Standard graph features can be employed for the main display of this
1231 view (see section \ref{sec::misc}). 
1232
1233 The following menu items are available in this tool:
1234
1235 \begin{itemize}
1236 \item {\bf File} offers 3 options: {\it Select Entry Points} currently
1237 does nothing. It is intended to behave similarly to the button ``Select
1238 Entries'' described below. This will be fixed in a later release of
1239 \projections{}. {\it Set Range} reloads the dialog box and allows the
1240 user to load data based on new parameters. {\it Close} closes the current
1241 tool window.
1242 \item {\bf View} provides 1 option: {\it Show Longest EPs} currently
1243 does nothing. It is intended to behave similarly to the button 
1244 ``Out-of-Range EPs'' and will be fixed in a later release of \projections{}.
1245 \end{itemize}
1246
1247 The following options are available in the control panel in the form
1248 of toggle buttons:
1249
1250 \begin{itemize}
1251 \item[-] Entry method execution time (How long did that entry method ran 
1252 for?)
1253 \item[-] Entry method creation message size (How large was the message
1254 that caused the entry method's execution?)
1255 \end{itemize}
1256
1257 \begin{figure}[htb]
1258 \center
1259 %\epsfig{figure=fig/histogram.eps,height=4in}
1260 \includegraphics[width=4.0in]{fig/histogram}
1261 \caption{Histogram view}
1262 \label{histogram}
1263 \end{figure}
1264
1265 The use of the tool is somewhat counterintuitive. The dialog box is
1266 created immediately and when the tool window is created, it is
1267 defaulted to a time-based histogram. You may change this histogram to
1268 a message-size-based histogram by selecting the ``Message Size'' radio
1269 button which would then update the graph using the same parameters
1270 provided in the dialog box. This issue will be fixed in upcoming
1271 editions of \projections{}.
1272
1273 The following features are, as of this writing, not implemented. They
1274 will be ready in a later release of \projections{}.
1275
1276 The ``Select Entries'' button is intended to bring up a color
1277 selection and filtering window that allows you to filter away entry
1278 methods from the count. This offers more control over the analysis
1279 (e.g. when you already know EP 5 takes 20-30ms and you want to know if
1280 there are other entry points also takes 20-30ms).
1281
1282 The ``Out-of-Range EPs'' button is intended to bring up a table
1283 detailing all the entry methods that fall into the overflow (last)
1284 bin. This list will, by default, be listed in descending order of time
1285 taken by the entry methods.
1286
1287 The performance of this view is affected by the number of bins the
1288 user wishes to analyze. We recommend the user limits the analysis to
1289 1,000 bins or less.
1290
1291 \subsubsection{Overview}
1292
1293 Overview (see figure \ref{overview}) gives users an overview of the
1294 utilization of all processors during the execution over a
1295 user-specified time range.
1296
1297 The dialog box of the tool allows you to specify the time period
1298 within which to load overview information. This dialog box is exactly
1299 the same as that of the Timeline tool (see section \ref{sec::timeline
1300 view}).
1301
1302 \begin{figure}[!ht]
1303   \centering
1304   \subfigure[Overview]{
1305     \includegraphics[width=3in]{fig/apoa1_512_overview}
1306     \label{overview}
1307   } 
1308   \subfigure[Overview with dominant Entry Method colors]{
1309     \includegraphics[width=3in]{fig/apoa1_512_overviewEPColored}
1310     \label{overview-ep}
1311   }
1312   \caption{Different Overview presentation forms.}
1313   \label{overview forms}
1314 \end{figure}
1315
1316 %\begin{figure}[htb]
1317 %\center
1318 %\epsfig{figure=fig/overview.eps,height=4in}
1319 %\includegraphics[width=4.0in]{fig/apoa1_512_overview}
1320 %\caption{Overview}
1321 %\label{overview}
1322 %\end{figure}
1323 %
1324 %\begin{figure}[htb]
1325 %\center
1326 %\epsfig{figure=fig/overview.eps,height=4in}
1327 %\includegraphics[width=4.0in]{fig/apoa1_512_overviewEPColored}
1328 %\caption{Overview with dominant Entry Method colors}
1329 %\label{overview-ep}
1330 %\end{figure}
1331
1332 This tool provides support for the following menu options:
1333
1334 \begin{itemize}
1335 \item {\bf File} provides 1 option: {\it Close} closes the current tool.
1336 \item {\bf Modify} provides 1 option: {\it Set Range} reloads the
1337 dialog box and allows the user to specify new parameters for rendering
1338 new overview information.
1339 \end{itemize}
1340
1341 The view currently hard codes the number of intervals to 7,000
1342 independent of the time-range desired.
1343
1344 Each processor has a row of colored bars in the display, different
1345 colors indicating different utilization at that time (White
1346 representing 100% utilization, shades of red representing other
1347 utilization (100% < utilization < 0%) and the background color
1348 representing 0% utilization. Moving a mouse over the graph will invoke
1349 a display of the processor usage of the specific processor at the
1350 specific time in the status bar below the graph. Vertical and
1351 horizontal zoom is enabled by two zooming bars to the right and lower
1352 of the graph. Panning is possible by clicking on any part of the
1353 display and dragging the mouse.
1354
1355 The ``by EP colors'' radio button provides more detail by replacing
1356 the utilization colors with the colors of the most significant entry
1357 method execution time in that time-interval on that processor
1358 represented by the cells (as illustrated in figure
1359 \ref{overview-ep}). 
1360 %Be warned that this particular view is very likely
1361 %a major visualization resource hog.
1362
1363 The Overview tool uses memory proportional to the number of processors
1364 selected. If an out-of-memory error is encountered, try again by
1365 skipping processors (e.g. {\tt 0-8191:2} instead of {\tt
1366 0-8191}). This should show the general application structure almost as
1367 well as using the full processor range.
1368
1369 \subsubsection{Animations}
1370
1371 This window (see figure \ref{animation}) animates the processor usage
1372 over a specified range of time and a specified interval size.
1373
1374 The dialog box to load animation information is exactly the same as
1375 that of the Graph tool (see section \ref{sec::graph view}).
1376
1377 \begin{figure}[htb]
1378 \center
1379 %\epsfig{figure=fig/animation.eps,height=3in}
1380 \includegraphics[width=2.5in]{fig/animation}
1381 \caption{Animation View}
1382 \label{animation}
1383 \end{figure}
1384
1385 A color temperature bar serves as a legend for displaying different
1386 processor utilizations as the animation progresses. Each time interval
1387 will have its data rendered as a frame. A frame displays in text on
1388 the top of the display the currently represented execution time of the
1389 application and what the size of an interval is.
1390
1391 Each selected processor is laid out in a 2-D plot as close to a square
1392 as possible. The view employs a color temperature ranging from blue
1393 (cool - low utilization) to bright red (hot - high utilization) to
1394 represent utilization.
1395
1396 You may manually update the frames by using the ``$<<$'' or ``$>>$''
1397 buttons to visualize the preceding or next frames respectively. The
1398 ``Auto'' button toggles automatic animation given the desired refresh
1399 rate.
1400
1401 The ``Frame Refresh Delay'' field allows you to select the real time
1402 delay between frames. It is a time-based field (see section
1403 \ref{sec::misc} for special features in using time-based
1404 fields).
1405
1406 The ``Set Ranges'' button allows you to set new parameters for this
1407 view via the dialog box.
1408
1409 This view has no known performance issues.
1410
1411 \subsubsection{Time Profile Graph}
1412
1413 The Time Profile view (see figure \ref{time profile}) is a
1414 visualization of the amount of time contributed by each entry method
1415 summed across all processors and displayed by user-adjustable time
1416 intervals.
1417
1418 Time Profile's dialog box is exactly the same as that of the Graph
1419 tool (see section \ref{sec::graph view}).
1420
1421 \begin{figure}[htb]
1422 \center
1423 %\epsfig{figure=fig/timeprofile.eps,height=4in}
1424 \includegraphics[width=4.0in]{fig/timeprofile}
1425 \caption{Time Profile Graph View}
1426 \label{time profile}
1427 \end{figure}
1428
1429 Standard graph features can be employed for the main display of this
1430 view (see section \ref{sec::misc}).
1431
1432 Under the tool options, one may:
1433
1434 \begin{itemize}
1435 \item[-] Filter the set of entry methods to be displayed on the graph via
1436 the ``Select Entry Points'' button. One may also modify the color set used
1437 for the entry methods via this option.
1438 \item[-] use the ``Select New Range'' button to reload the dialog box
1439 for the tool and set new parameters for visualization (eg. different
1440 time range, different set of processors or different interval sizes).
1441 \item[-] store the current set of entry method colors to disk (to the
1442 same directory where the trace logs are stored). This is done via the
1443 ``Save Entry Colors'' button.
1444 \item[-] load the stored set of entry method colors (if it exists)
1445 from disk (from the same directory where the trace logs are
1446 stored). This is done via the ``Load Entry Colors'' button.
1447 \end{itemize}
1448
1449 Time Profile also reacts to the presence of data about AMPI
1450 functions (See section \ref{sec::AMPI functions}). When such data is
1451 detected, an extra tabbed window displays a graph similar to entry
1452 method profiles, but for AMPI functions only.
1453
1454 This tool's performance is tied to the number of intervals desired by
1455 the user. We recommend that the user stick to visualizing 1,000
1456 intervals or less.
1457
1458 \subsubsection{User Events Profile}
1459
1460 The User Events view is essentially a usage profile (See section
1461 \ref{sec::usage profile}) of bracketed user events (if any) that were
1462 recorded over a specified time range. The x-axis holds bars of data
1463 associated with each processor while the y-axis represents the time
1464 spent by each user event. Each user event is assigned a color.
1465
1466 \begin{figure}[htb]
1467 \center
1468 \includegraphics[width=4.0in]{fig/apoa1_128_userEventsView}
1469 \caption{User Events Profile View}
1470 \label{user event profile}
1471 \end{figure}
1472
1473 It is important to note that user-events can be arbitrarily
1474 nested. The view currently displays information based on raw data
1475 without regard to the way the events are nested. Memory usage is
1476 proportional to the number of processors to be displayed.
1477
1478 \input{View_Outlier}
1479
1480 \subsubsection{Multirun Analysis}
1481
1482 \subsubsection{Function Tool}
1483 \label{sec::function tool}
1484 The Function Tool view presents a graph that is a usage profile (See
1485 section \ref{sec::usage profile}) of AMPI function information. This
1486 view allows the analyst to choose to display the time spent by each
1487 function or the number of calls made over the selected time range.
1488
1489 In the case of AMPI functions, the events are properly nested. The
1490 information displayed is currently that of {\em inclusive time}
1491 (i.e. if function B's calls are nested within function A's, the time
1492 spent in function B contribute to both function B's and function A's
1493 displayed performance information). There are plans to implement the
1494 presentation of AMPI function information based on {\em exclusive
1495 time} (i.e. time within functions are computed by subtracting the
1496 measured time spent minus the time spent by any calls to nested
1497 functions).
1498
1499 %\subsubsection{POSE Analysis}
1500
1501 \subsubsection{AMPI Usage Profile}
1502
1503 The AMPI Usage Profile view presents a graph similar to Function
1504 Tool's (See section \ref{sec::function tool}) with several
1505 modifications:
1506
1507 \begin{enumerate}
1508 \item In it's per-processor mode, displayed via the tabbed window
1509 ``Per Processor'', the information displayed includes the time spent
1510 by other events outside of AMPI. This is displayed as a white bar
1511 marked ``Others'' when moused-over. This allows the analyst to compare
1512 the time spent by events within AMPI functions along with other
1513 recorded events. In contrast, Function Tool shows only AMPI function
1514 events.
1515 \item In it's per-function mode, displayed via the tabbed window ``Per
1516 Function'', the information is displayed with each bar on the x-axis
1517 showing the percentage utilization for a different AMPI function.
1518 \end{enumerate}
1519
1520 \input{View_NoiseMiner}
1521
1522 \subsection{Miscellaneous features}
1523 \label{sec::misc}
1524
1525 \subsubsection{Standard Graph Display Interface} 
1526
1527 A standard graph display (an example of which can be found with the
1528 Main Summary Graph - figure \ref{mainwindow}) has the following
1529 features:
1530
1531 \begin{itemize}
1532 \item[-] {\bf Graph types} can be selected between ``Line Graph'' which
1533 connects each data point with a colored line representing the
1534 appropriate data entry. This information may be ``stacked'' or
1535 ``unstacked'' (controlled by the checkbox to the right). A ``stacked''
1536 graph places one data point set (Y values) on top of another. An
1537 ``unstacked'' graph simply uses the data point's Y value to directly
1538 determine the point's position; ``Bar Graph'' (the default) which
1539 draws a colored bar for each data entry and the value of the data
1540 point determines its height or starting position (depending on whether
1541 the bar graph is ``stacked'' or ``unstacked''). A ``Bar Graph''
1542 displayed in ``unstacked'' mode draws its bars in a tallest to
1543 shortest order so that the large Y values do not cover over the small
1544 Y values; ``Area Graph'' is similar to a ``Line Graph'' except that the
1545 area under the lines for a particular Y data point set is also colored
1546 by the data's appropriate color. ``Area Graph''s are always stacked.
1547 \item[-] {\bf x-scale} allows the user to scale the X-Axis. This can be
1548 done by directly entering a scaling factor in the text field (simple
1549 numeric field - see below) or by using the ``$<<$'' or ``$>>$'' buttons
1550 to increase or decrease the scale by 0.25 each time. The ``Reset'' button
1551 changes the scale factor back to 1.0. A scrollbar automatically appears
1552 if the scale factor causes the canvas to be larger than the window.
1553 \item {\bf y-scale} allows the user to scale the Y-Axis. This functions 
1554 similarly to the {\bf x-scale} feature where the buttons and fields are
1555 concerned.
1556 \end{itemize}
1557
1558 \subsubsection{Standard Dialog Features}
1559
1560 \begin{figure}[htb]
1561 \center
1562 %\epsfig{figure=fig/standard_dialog.eps,height=4in}
1563 \includegraphics[width=2.5in]{fig/standard_dialog}
1564 \caption{An example Dialog with standard fields}
1565 \label{standard dialog}
1566 \end{figure}
1567
1568 Figure \ref{standard dialog} shows a sample dialog box with standard
1569 features. The following are standard features that can be employed in
1570 such a dialog box:
1571
1572 \begin{itemize}
1573 \item[-] {\bf Moving from field to field} via the tab key causes the
1574 dialog box update the last field input by the user. It also performs a
1575 consistency check. Whenever it finds an inconsistency, it will move
1576 mouse focus onto the offending field, disabling the ``OK'' button so
1577 as to force the user to fix the inconsistency. Examples of
1578 inconsistency includes: input that violates a field's format; input
1579 whose value violates constraints (eg. start time larger than end
1580 time); or out-of-range stand-alone values.
1581 \item[-] {\bf Available buttons} include ``OK'' which confirms the
1582 user's choice of parameters. This button is only activated if the
1583 dialog box considers the parameters' input to be
1584 consistent. ``Update'' causes the dialog box to update the last field
1585 input by the user and perform a consistency check. This is similar in
1586 behavior to the user tabbing between fields. ``Cancel'' closes the
1587 dialog box without modifying any parameters if the tool has already
1588 been loaded or aborts the tool's load attempt otherwise.
1589 \item[-] {\bf Parameter History} allows the user to quickly access
1590 information for all tools for a set of frequently needed time
1591 periods. An example of such a use is the desire by the analyst to view
1592 a particular phase or timestep of a computation without having to
1593 memorize or write on a piece of paper when exactly the phase or
1594 timestep occurred.
1595
1596 It consists of a pull-down text box and 2 buttons. ``Add to History
1597 List'' adds the current time range to the pull-down list to the left
1598 of the button. The dialog box maintains up to 5 entries, replacing
1599 older entries with newer ones. ``Remove Selected History'' removes the
1600 currently selected entry in the history list. ``Save History to Disk''
1601 stores current history information to the file ``ranges.hst'' in the
1602 same directory where your logs are stored. Note that you will need
1603 write access to that directory to successfully store history
1604 information. A more flexible scheme is currently being developed and
1605 will be released in a later version of \projections{}. Clicking on the
1606 pull-down list allows the user to select one out of up to 5 possible
1607 time ranges. You can do so by moving the mouse up or down the
1608 list. Clicking on any one item changes the start and end times on the
1609 dialog box.
1610 \end{itemize}
1611
1612 \subsubsection{Data Fields}
1613
1614 Throughout \projections{} tools and dialog boxes (see sample figure
1615 \ref{standard dialog}), data entry fields are provided. Unless
1616 otherwise specified, these can be of the following standard field with
1617 some format requirements:
1618
1619 \begin{itemize}
1620 \item[-] {\bf Simple numeric fields}: An example can be found in
1621 figure \ref{standard dialog} for ``Number of Bins:''. This field expects
1622 a single number.
1623 \item[-] {\bf Time-Based Field}: An example can be found in figure
1624 \ref{standard dialog} for ``Start Time:''. This field expects a single
1625 simple or floating point number followed by a time-scale modifier. The
1626 following modifiers are supported: {\it none} - this is the default
1627 and means the input number represents time in microseconds. A whole
1628 number is expected; {\it The characters ``us''} - the input number
1629 represents time in microseconds. A whole number is expected; {\it The
1630 characters ``ms''} - the input number represents time in
1631 milliseconds. This can be a whole number or floating point number; or
1632 {\it The character ``s''} - the input number represents time in
1633 seconds. This can be a whole number or floating point number.
1634 \item[-] {\bf Processor-Based Field}: An example can be found in
1635 figure \ref{standard dialog} for ``Processors:''. This field expects a
1636 single whole number; a list of whole numbers; a range; or a mixed list
1637 of whole numbers and ranges. Here are some examples which makes the
1638 format clearer:
1639
1640    eg: Want to see processors 1,3,5,7:  Enter {\tt 1,3,5,7}
1641
1642    eg: Want to see processors 1,2,3,4:  Enter {\tt 1-4}
1643
1644    eg: Want to see processors 1,2,3,7:  Enter {\tt 1-3,7}
1645
1646    eg: Want to see processors 1,3,4,5,7,8: Enter {\tt 1,3-5,7-8}
1647
1648 Ranges also allow skip-factors. Here are some examples:
1649
1650    eg: Want to see processors 3,6,9,12,15: Enter {\tt 3-15:3}
1651
1652    eg: Want to see processors 1,3,6,9,11,14: Enter {\tt 1,3-9:3,11,14}
1653
1654 This feature is extremely flexible. It will normalize your input to a
1655 canonical form, tolerating duplication of entries as well as
1656 out-of-order entries (ie. {\tt 4,6,3} is the same as {\tt 3-4,6}).
1657 \end{itemize}
1658
1659 \section{Known Issues}
1660 \label{sec::known issues}
1661
1662 This section lists known issues and bugs with the \projections{}
1663 framework that we have not resolved at this time.
1664
1665 \begin{itemize}
1666 \item
1667 \charmpp{} scheduler idle time is known to be incorrectly recorded on
1668 the BG/L machine at IBM TJ Watson.
1669 \item
1670 End-of-Run analysis techniques (while tracing applications) are
1671 currently known to hang for applications that make multiple calls to
1672 traceBegin() and traceEnd() on the same processor through multiple
1673 \charmpp{} objects.
1674 \end{itemize}
1675
1676 \end{document}