VampirTrace 5.14.4 User Manual
TU Dresden
Center for Information Services and
High Performance Computing (ZIH)
01062 Dresden
Germany
http://www.tu-dresden.de/zih
http://www.tu-dresden.de/zih/vampirtrace
Contact<EMAIL_ADDRESS>This documentation describes how to apply VampirTrace to an application in order to generate trace files at execution time. This step is called instrumentation. It furthermore explains how to control the runtime measurement system during execution (tracing). This also includes performance counter sampling as well as selective filtering and grouping of functions.
VampirTrace consists of a tool set and a runtime library for instrumentation and tracing of software applications. It is particularly tailored to parallel and distributed High Performance Computing (HPC) applications.
The instrumentation part modifies a given application in order to inject additional measurement calls during runtime. The tracing part provides the actual measurement functionality used by the instrumentation calls. By this means, a variety of detailed performance properties can be collected and recorded during runtime. This includes function enter and leave events, MPI communication, OpenMP events, and performance counters.
After a successful tracing run, VampirTrace writes all collected data to a trace file in the Open Trace Format (OTF). As a result, the information is available for post-mortem analysis and visualization by various tools. Most notably, VampirTrace provides the input data for the Vampir analysis and visualization tool.
VampirTrace is included in OpenMPI 1.3 and later versions. If not disabled explicitly, VampirTrace is built automatically when installing OpenMPI.
Trace files can quickly become very large, especially with automatic instrumentation. Tracing applications for only a few seconds can result in trace files of several hundred megabytes. To protect users from creating trace files of several gigabytes, the default behavior of VampirTrace limits the internal buffer to 32 MB per process. Thus, even for larger scale runs the total trace file size will be moderate. Please read Section 3.3 on how to remove or change this limit.
VampirTrace supports various Unix and Linux platforms that are common in HPC nowadays. It is available as open source software under a BSD License.
The following list shows a summary of all instrumentation and tracing features that VampirTrace offers. Note that not all features are supported on all platforms.
Tracing of user functions ⇒ Chapter 2
MPI Tracing ⇒ Chapter 2
OpenMP Tracing ⇒ Chapter 2
Pthread Tracing
Java Tracing ⇒ Section 2.8
3rd-Party Library tracing ⇒ Section 2.9
MPI Correctness Checking ⇒ Section 4.10
User API
Performance Counters ⇒ Sections 4.1 and 4.2
CPU ID Tracing ⇒ Section 4.4
Child Process Execution Tracing ⇒ Section 4.9
I/O Tracing ⇒ Section 4.8
Memory Allocation Tracing ⇒ Section 4.3
Filtering & Grouping ⇒ Chapter 5
OTF Output ⇒ Chapter 3
To perform measurements with VampirTrace, the user's application program needs to be instrumented, i.e., at specific points of interest (called ``events'') VampirTrace measurement calls have to be activated. As an example, common events are, amongst others, entering and leaving of functions as well as sending and receiving of MPI messages.
VampirTrace handles this automatically by default. In order to enable the instrumentation of function calls, the user only needs to replace the compiler and linker commands with VampirTrace's wrappers, see Section 2.1 below. VampirTrace supports different ways of instrumentation as described in Section 2.2.
All the necessary instrumentation of user functions, MPI, and OpenMP events is handled by VampirTrace's compiler wrappers (vtcc, vtcxx, and vtfort). In the script used to build the application (e.g. a makefile), all compile and link commands should be replaced by the VampirTrace compiler wrapper. The wrappers perform the necessary instrumentation of the program and link the suitable VampirTrace library. Note that the VampirTrace version included in OpenMPI 1.3 has additional wrappers (mpicc-vt, mpicxx-vt, mpif77-vt, and mpif90-vt) which are like the ordinary MPI compiler wrappers (mpicc, mpicxx, mpif77, and mpif90) with the extension of automatic instrumentation.
The following list shows some examples specific to the parallelization type of the program:
| original: | gfortran hello.f90 -o hello |
| with instrumentation: | vtfort hello.f90 -o hello |
This will instrument user functions (if supported by the compiler) and link the VampirTrace library.
| original: | mpicc hello.c -o hello |
| with instrumentation: | vtcc -vt:cc mpicc hello.c -o hello |
MPI implementations without own compilers require the user to link the MPI library manually. In this case, simply replace the compiler by VampirTrace's compiler wrapper:
| original: | icc hello.c -o hello -lmpi |
| with instrumentation: | vtcc hello.c -o hello -lmpi |
If you want to instrument MPI events only (this creates smaller trace files and less overhead) use the option -vt:inst manual to disable automatic instrumentation of user functions (see also Section 2.4).
| original: | ifort <-openmp|-pthread> hello.f90 |
| -o hello | |
| with instrumentation: | vtfort <-openmp|-pthread> hello.f90 |
| -o hello |
For more information about OPARI read the documentation available in VampirTrace's installation directory at: share/vampirtrace/doc/opari/Readme.html
| original: | mpif90 <-openmp|-pthread> hello.F90 |
| -o hello | |
| with instrumentation: | vtfort -vt:fc mpif90 |
| <-openmp|-pthread> hello.F90 | |
| -o hello |
The VampirTrace compiler wrappers automatically try to detect which parallelization method is used by means of the compiler flags (e.g. -lmpi, -openmp or -pthread) and the compiler command (e.g. mpif90). If the compiler wrapper failed to detect this correctly, the instrumentation could be incomplete and an unsuitable VampirTrace library would be linked to the binary. In this case, you should tell the compiler wrapper which parallelization method your program uses by using the switches -vt:mpi, -vt:mt, and -vt:hyb for MPI, multithreaded, and hybrid programs, respectively. Note that these switches do not change the underlying compiler or compiler flags. Use the option -vt:verbose to see the command line that the compiler wrapper executes. The default settings of the compiler wrappers can be modified in the files share/vampirtrace/vtcc-wrapper-data.txt (and similar for the other languages) in the installation directory of VampirTrace. The settings include compilers, compiler flags, libraries, and instrumentation types. You could for instance modify the default C compiler from gcc to mpicc by changing the line compiler=gcc to compiler=mpicc. This may be convenient if you instrument MPI parallel programs only.
The wrapper option -vt:inst <insttype> specifies the instrumentation type to be used. The following values for <insttype> are possible:
To determine which instrumentation type will be used by default and which instrumentation types are available on your system have a look at the entry inst_avail in the wrapper's configuration file (e.g. share/vampirtrace/vtcc-wrapper-data.txt in the installation directory of VampirTrace for the C compiler wrapper).
Type vtcc -vt:help for otheroptions that can be passed to VampirTrace's compiler wrapper.
Automatic instrumentation is the most convenient method to instrument your program. If available, simply use the compiler wrappers without any parameters, e.g.:
% vtfort hello.f90 -o hello
Should any problems emerge to get symbol information automatically, then the environment variable VT_GNU_NMFILE can be set to a symbol list file, which is created with the command nm, like:
% nm hello > hello.nm
To get the source code line for the application functions use nm -l on Linux systems.
VampirTrace will include this information into the trace.
Note that the output format of nm must be written in BSD-style. See the manual page
of nm to obtain help for dealing with the output format setting.
__attribute__ ((__no_instrument_function__))
The PGI and IBM compilers prefer inlining over instrumentation when compiling with enabled inlining. Thus, one needs to disable inlining to enable the instrumentation of inline functions and vice versa.
The bottom line is that a function cannot be inlined and instrumented at the same time. For more information on how to inline functions read your compiler's manual.
The VT_USER_START, VT_USER_END calls can be used to instrument any user-defined sequence of statements.
Fortran: #include "vt_user.inc" VT_USER_START('name') ... VT_USER_END('name')
C: #include "vt_user.h" VT_USER_START("name"); ... VT_USER_END("name");If a block has several exit points (as it is often the case for functions), all exit points have to be instrumented with VT_USER_END, too.
For C++ it is simpler as is demonstrated in the following example. Only entry points into a scope need to be marked. The exit points are detected automatically when C++ deletes scope-local variables.
C++: #include "vt_user.h" { VT_TRACER("name"); ... }
The instrumented sources have to be compiled with -DVTRACE for all three languages, otherwise the VT_* calls are ignored. Note that Fortran source files instrumented this way have to be preprocessed, too.
 In such a way, all user functions can be instrumented by a compiler while special source code regions (e.g. loops) can be instrumented by VT's API.
Use VT's compiler wrapper (described above) for compiling and linking the instrumented source code, such as:
Note that you can also use the option -vt:inst manual with non-instrumented sources. Binaries created in this manner only contain MPI and OpenMP instrumentation, which might be desirable in some cases.
int main() { ... VT_OFF(); initialize(); VT_ON(); compute(); ... }Furthermore the "on/off" functionality can be used to control the tracing behavior of VampirTrace and allows to trace only parts of interests. Therefore the amount of trace data can be reduced essentially. To check whether if tracing is enabled or not use the call VT_IS_ON.
Use the instrumentation call VT_SET_REWIND_MARK at the beginning of a (possibly not interesting) code section. Later, you can decide to rewind the trace buffer to the mark with the call VT_REWIND. All recorded trace data between the mark and the rewind call will be dropped. Note, that only one mark can be set at a time. The last call to VT_SET_REWIND_MARK will be considered when rewinding the trace buffer. This simplified Fortran code example sketches how the rewind approach can be used:
do step=1,number_of_time_steps VT_SET_REWIND_MARK() call compute_time_step(step) if(finished_as_expected) VT_REWIND() end do
% vtcc -vt:inst tauinst hello.c -o hello
% vtcc -vt:inst tauinst hello.c -o hello \ -vt:tau '-f <filename>'
The option -vt:inst dyninst is used with the compiler wrapper to instrument the application during runtime (binary instrumentation), by using Dyninst. Recompiling is not necessary for this kind of instrumentation, but relinking:
% vtfort -vt:inst dyninst hello.o -o hello
The compiler wrapper dynamically links the library libvt-dynatt.so
to the application. This library attaches the mutator-program
vtdyn during runtime which invokes the instrumentation by using Dyninst.
To prevent certain functions from being instrumented you can use the runtime function filtering as explained in Section 5.1. All additional overhead, due to instrumentation of these functions, will be removed.
VampirTrace also allows binary instrumentation of functions located in shared libraries. For this to work a colon-separated list of shared library names has to be given in the environment variable VT_DYN_SHLIBS:
VT_DYN_SHLIBS=libsupport.so:libmath.so
% vtdyn -o dyninst_a.out ./a.out
% mpirun -np 4 ./a.out
By putting the call to vtrun directly before the actual application call, instrumention support will be enabled at runtime:
% mpirun -np 4 vtrun ./a.out
For more information about the tool vtrun see Section B.6.
% java -agentlib:vt-java ...
Or more easier, by replacing the usal Java application launcher java by the command vtjava:
% vtjava ...
When tracing Java applications, you probably want to filter out dispensable function calls. Please have a look at Sections 5.1 and 5.2 to learn about different ways for excluding parts of the application from tracing.
% vtlibwrapgen -g SDL -o SDLwrap.c /usr/include/SDL/*.h
This generates the source file SDLwrap.c that contains wrapper-functions for all library functions found in the header-files located in /usr/include/SDL/ and instructs VampirTrace to assign these functions to the new group SDL.
The generated wrapper source file can be edited in order to add manual instrumentation or alter attributes of the library wrapper. A detailed description can be found in the generated source file or in the header file vt_libwrap.h which can be found in the include directory of VampirTrace.
To adapt the library instrumentation it is possible to pass a filter file to
the generation process. The rules are like these for normal VampirTrace instrumentation
(see Section 5.1), where only 0 (exclude functions) and -1 (generally include
functions) are allowed.
The second step is to compile the generated source file:
% vtlibwrapgen --build --shared -o libSDLwrap SDLwrap.c
This builds the shared library libSDLwrap.so which can be linked to the application or preloaded by using the environment variable LD_PRELOAD:
% LD_PRELOAD=$PWD/libSDLwrap.so <executable>
Running a VampirTrace instrumented application should normally result in an OTF trace file in the current working directory where the application was executed. If a problem occurs, set the environment variable VT_VERBOSE to 2 before executing the instrumented application in order to see control messages of the VampirTrace runtime system which might help tracking down the problem.
The internal buffer of VampirTrace is limited to 32 MB per process. Use the environment variables VT_BUFFER_SIZE and VT_MAX_FLUSHES to increase this limit. Section 3.3 contains further information on how to influence trace file size.
The default name of the trace file depends on the operating system where the application is run. On Linux, MacOS and Sun Solaris the trace file will be named like the application, e.g. hello.otf for the executable hello. For other systems, the default name is a.otf. Optionally, the trace file name can be defined manually by setting the environment variable VT_FILE_PREFIX to the desired name. The suffix .otf will be added automatically.
To prevent overwriting of trace files by repetitive program runs, one can enable unique trace file naming by setting VT_FILE_UNIQUE to yes. In this case, VampirTrace adds a unique number to the file names as soon as a second trace file with the same name is created. A *.lock file is used to count up the number of trace files in a directory. Be aware that VampirTrace potentially overwrites an existing trace file if you delete this lock file. The default value of VT_FILE_UNIQUE is no. You can also set this variable to a number greater than zero, which will be added to the trace file name. This way you can manually control the unique file naming.
The default location of the final trace file is the working directory at application start time. If the trace file shall be stored in another place, use VT_PFORM_GDIR as described in Section 3.2 to change the location of the trace file.
| Variable | Purpose | Default |
|---|---|---|
|
Global Settings |
||
| VT_APPPATH | Path to the application executable.
⇒ Section 2.3.2 |
- |
| VT_BUFFER_SIZE | Size of internal event trace buffer per process. This is the place where
event records are stored, before being written to OTF.
⇒ Section 3.3 |
32M |
| VT_CLEAN | Remove temporary trace files? | yes |
| VT_COMPRESSION | Write compressed trace files? | yes |
| VT_COMPRESSION_BSIZE | Size of the compression buffer in OTF. | OTF default |
| VT_FILE_PREFIX | Prefix used for trace filenames. | ⇒Sect.3.1 |
| VT_FILE_UNIQUE | Enable unique trace file naming?
Set to yes, no, or a numerical ID.
⇒ Section 3.1 |
no |
| VT_MAX_FLUSHES | Maximum number of buffer flushes.
⇒ Section 3.3 |
1 |
| VT_MAX_SNAPSHOTS | Maximum number of snapshots to generate. | 1024 |
| VT_MAX_THREADS | Maximum number of threads per process that VampirTrace reserves resources for. | 65536 |
| VT_OTF_BUFFER_SIZE | Size of internal OTF buffer. This buffer contains OTF-encoded trace data that is written to file at once. | OTF default |
| VT_PFORM_GDIR | Name of global directory to store final trace file in. | ./ |
| VT_PFORM_LDIR | Name of node-local directory which can be used to store temporary trace files. | /tmp/ |
| VT_SNAPSHOTS | Enable snapshot generation? Allows Vampir to load subsets of the resulting trace. | yes |
| VT_THREAD_BUFFER_SIZE | Size of internal event trace buffer per thread. If not defined, the
size is set to 10% of VT_BUFFER_SIZE.
⇒ Section 3.3 |
0 |
| VT_UNIFY | Unify local trace files afterwards? | yes |
| VT_VERBOSE | Level of VampirTrace related information messages: Quiet (0), Critical (1), Information (2) | 1 |
|
I/O Forwarding (IOFSL) |
||
| VT_IOFSL_ASYNC_IO | Enable buffered IOFSL writes?
⇒ Section D.4.2 |
no |
| VT_IOFSL_SERVERS | Comma-separated list of IOFSL server addresses.
⇒ Section D.4.2 |
- |
| VT_IOFSL_MODE | Mode of the IOFSL communication:
(MULTIFILE_SPLIT or MULTIFILE) ⇒ Section D.4.2 |
MULTIFILE_SPLIT |
|
Optional Features |
||
| VT_CPUIDTRACE | Enable tracing of core ID of a CPU?
⇒ Section 4.4 |
no |
| VT_ETIMESYNC | Enable enhanced timer synchronization?
⇒ Section 3.7 |
no |
| VT_ETIMESYNC_INTV | Interval between two successive synchronization phases in s. | 120 |
| VT_GPUTRACE | Comma-separated list of GPU tracing options. ⇒ Section 4.5 |
no |
| VT_IOLIB_PATHNAME | Provides an alternative library to use for LIBC I/O calls. ⇒ Section 4.8 | - |
| VT_IOTRACE | Enable tracing of application I/O calls?
⇒ Section 4.8 |
no |
| VT_IOTRACE_EXTENDED | Enable tracing of additional function argument for application I/O calls?
⇒ Section 4.8 |
no |
| VT_EXECTRACE | Enable tracing of function calls for creating and controling child processes?
⇒ Section 4.9 |
yes |
| VT_MEMTRACE | Enable memory allocation counter?
⇒ Section 4.3 |
no |
| VT_MODE | Colon-separated list of VampirTrace modes: Tracing (TRACE), Profiling (STAT).
⇒ Section 3.4 |
TRACE |
| VT_MPICHECK | Enable MPI correctness checking via UniMCI? | no |
| VT_MPICHECK_ERREXIT | Force trace write and application exit if an MPI usage error is detected? | no |
| VT_MPITRACE | Enable tracing of MPI events? | yes |
| VT_MPI_IGNORE_FILTER | Enable tracing of MPI communication events although its corresponding functions are filtered? | no |
| VT_OMPTRACE | Enable tracing of OpenMP events instrumented by OPARI? | yes |
| VT_PTHREAD_REUSE | Reuse IDs of terminated Pthreads? | yes |
| VT_STAT_INTV | Length of interval in ms for writing the next profiling record | 0 |
| VT_STAT_PROPS | Colon-separated list of event types that shall be recorded in profiling mode:
Functions (FUNC), Messages (MSG), Collective Ops. (COLLOP) or all of them
(ALL)
⇒ Section 3.4 |
ALL |
| VT_SYNC_FLUSH | Enable synchronized buffer flush?
⇒ Section 3.6 |
no |
| VT_SYNC_FLUSH_LEVEL | Minimum buffer fill level for synchronized buffer flush in percent. | 80 |
|
Counters |
||
| VT_CUPTI_METRICS | Specify CUDA hardware counter metrics (CUPTI events) to be recorded with trace events
as a colon/VT_METRICS_SEP-separated list of names.
⇒ Section 4.5 |
- |
| VT_CUPTI_EVENTS_SAMPLING | Sample CUDA hardware counters during the execution of a kernel.
⇒ Section 4.5 |
no |
| VT_METRICS | Specify counter metrics to be recorded with trace events as a
colon/VT_METRICS_SEP-separated list of names.
⇒ Section 4.1 |
- |
| VT_METRICS_SEP | Separator string between counter specifications in VT_METRICS. | : |
| VT_PLUGIN_CNTR_METRICS | Colon-separated list of plugin counter metrics which shall be recorded.
⇒ Section 4.7 |
- |
| VT_RUSAGE | Colon-separated list of resource usage counters which shall be recorded.
⇒ Section 4.2 |
- |
| VT_RUSAGE_INTV | Sample interval for recording resource usage counters in ms. | 100 |
|
Binary Instrumentation (Dyninst) |
||
| VT_DYN_DETACH | Detach Dyninst mutator-program vtdyn from application process? | yes |
| VT_DYN_IGNORE_NODBG | Disable instrumentation of functions which have no debug information? | no |
| VT_DYN_INNER_LOOPS | Instrument inner loops within outer loops?
(implies VT_DYN_OUTER_LOOPS=yes) |
no |
| VT_DYN_LOOP_ITERS | Instrument loop iterations?
(implies VT_DYN_OUTER_LOOPS=yes) |
no |
| VT_DYN_OUTER_LOOPS | Instrument outer loops within functions? | no |
| VT_DYN_SHLIBS | Colon-separated list of shared libraries for Dyninst instrumentation.
⇒ Section 2.6 |
- |
|
Filtering, Grouping |
||
| VT_FILTER_SPEC | Name of function/region filter file.
⇒ Section 5.1 |
- |
| VT_GROUPS_SPEC | Name of function grouping file.
⇒ Section 5.3 |
- |
| VT_JAVA_FILTER_SPEC | Name of Java specific filter file.
⇒ Section 5.2 |
- |
| VT_JAVA_GROUP_CLASSES | Create a group for each Java class automatically? | yes |
| VT_MAX_STACK_DEPTH | Maximum number of stack level to be traced.
(0 = unlimited) |
0 |
| VT_ONOFF_CHECK_STACK_BALANCE | Check stack level balance when switching tracing on/off.
⇒ Section 2.4.2 |
yes |
|
Symbol List |
||
| VT_GNU_NM | Command to list symbols from object files.
⇒ Section 2.3 |
nm |
| VT_GNU_NMFILE | Name of file with symbol list information.
⇒ Section 2.3 |
- |
The variables VT_PFORM_GDIR, VT_PFORM_LDIR, VT_FILE_PREFIX may contain (sub)strings of the form $XYZ or ${XYZ} where XYZ is the name of another environment variable. Evaluation of the environment variable is done at measurement runtime.
When you use these environment variables, make sure that they have the same value for all processes of your application on all nodes of your cluster. Some cluster environments do not automatically transfer your environment when executing parts of your job on remote nodes of the cluster, and you may need to explicitly set and export them in batch job submission scripts.
The default values of the environment variables VT_BUFFER_SIZE and VT_MAX_FLUSHES limit the internal buffer of VampirTrace to 32 MB per process and the number of times that the buffer is flushed to 1, respectively. Events that are to be recorded after the limit has been reached are no longer written into the trace file. The environment variables apply to every process of a parallel application, meaning that applications with n processes will typically create trace files n times the size of a serial application.
To remove the limit and get a complete trace of an application, set VT_MAX_FLUSHES to 0. This causes VampirTrace to always write the buffer to disk when it is full. To change the size of the buffer, use the environment variable VT_BUFFER_SIZE. The optimal value for this variable depends on the application which is to be traced. Setting a small value will increase the memory available to the application, but will trigger frequent buffer flushes by VampirTrace. These buffer flushes can significantly change the behavior of the application. On the other hand, setting a large value, like 2G, will minimize buffer flushes by VampirTrace, but decrease the memory available to the application. If not enough memory is available to hold the VampirTrace buffer and the application data, parts of the application may be swapped to disk, leading to a significant change in the behavior of the application.
In multi-threaded applications a single buffer cannot be shared across a process and the associated threads for performance reasons. Thus independent buffers are created for every process and thread, at which the process buffer size is 70% and the thread buffer size is 10% of the value set in VT_BUFFER_SIZE. The buffer size of processes and threads can be explicitly specified setting the environment variable VT_THREAD_BUFFER_SIZE, which defines the buffer size of a thread, whereas the buffer size of a process is then defined by the value of VT_BUFFER_SIZE. The total memory consumption of the application is calculated as follows (assuming that every process has the same number of threads):
Note that you can decrease the size of trace files significantly by using the runtime function filtering as explained in Section 5.1.
To profile an application set the variable VT_MODE to STAT. Setting VT_MODE to STAT:TRACE tells VampirTrace to perform tracing and profiling at the same time. By setting the variable VT_STAT_PROPS the user can influence whether functions, messages, and/or collective operations shall be profiled. See Section 3.2 for information about these environment variables.
After a run of an instrumented application the traces of the single processes need to be unified in terms of timestamps and event IDs. In most cases, this happens automatically. If the environment variable VT_UNIFY is set to no or under certain circumstances it is necessary to perform unification of local traces manually. To do this, use the following command:
% vtunify <prefix>
If VampirTrace was built with support for OpenMP and/or MPI, it is possible to speedup the unification of local traces significantly. To distribute the unification on multible processes the MPI parallel version vtunify-mpi can be used as follow:
% mpirun -np <nranks> vtunify-mpi <prefix>
Furthermore, both tools vtunify and vtunify-mpi are capable to open additional OpenMP threads for unification. The number of threads can be specified by the OMP_NUM_THREADS environment variable.
Especially on cluster environments, where each process has its own local timer,
tracing relies on precisely synchronized timers. Therefore, VampirTrace provides
several mechanisms for timer synchronization. The default synchronization scheme is a
linear synchronization at the very begin and the very end of a trace run with a
master-slave communication pattern.
However, this way of synchronization can become to imprecise for long trace runs.
Therefore, we recommend the usage of the enhanced timer synchronization scheme of
VampirTrace. This scheme inserts additional synchronization phases at appropriate
points in the program flow. Currently, VampirTrace makes use of all MPI collective
functions associated with MPI_COMM_WORLD.
To enable this synchronization scheme, a LAPACK library with C wrapper support has to be
provided for VampirTrace and the environment variable
VT_ETIMESYNC (⇒ Section 3.2)
has to be set before the tracing.
The length of the interval between two successive synchronization phases can be
adjusted with VT_ETIMESYNC_INTV.
The following LAPACK libraries provide a C-LAPACK API that can be used by VampirTrace
for the enhanced timer synchronization:
In order to ease the process of configuring the runtime environment, the graphical tool vtsetup has been added to the VampirTrace toolset. With the help of a graphical user interface, required environment variables can be configured. The following option categories can be managed:
Furthermore, the user is granted more fine-grained control by activating the Advanced View button. The configuration can be saved to an XML file. After successfull configuration, the application can be launched directly or a script can be generated for manual execution.
If VampirTrace has been built with hardware counter support , it is capable of recording hardware counter information as part of the event records. To request the measurement of certain counters, the user is required to set the environment variable VT_METRICS. The variable should contain a colon-separated list of counter names or a predefined platform-specific group.
The user can leave the environment variable unset to indicate that no counters are requested. If any of the requested counters are not recognized or the full list of counters cannot be recorded due to hardware resource limits, program execution will be aborted with an error message.
If the PAPI library is used to access hardware performance counters, metric names can be any PAPI preset names or PAPI native counter names. For example, set
VT_METRICS=PAPI_FP_OPS:PAPI_L2_TCM:!CPU_TEMP1
to record the number of floating point instructions and level 2 cache misses (PAPI preset counters),
cpu temperature from the lm_sensors component.
The leading exclamation mark let CPU_TEMP1 be interpreted as absolute value counter.
See Section C.1 for a full list of PAPI preset counters.
On Sun Solaris operating systems VampirTrace can make use of the CPC performance counter library to query the processor's hardware performance counters. The counters which are actually available on your platform can be queried with the tool vtcpcavail. The listed names can then be used within VT_METRICS to tell VampirTrace which counters to record.
On NEC SX machines VampirTrace uses special register calls to query the processor's hardware counters. Use VT_METRICS to specify the counters that have to be recorded. See Section C.3 for a full list of NEC SX hardware performance counters.
The Unix system call getrusage provides information about consumed resources and operating system events of processes such as user/system time, received signals, and context switches.
If VampirTrace has been built with resource usage support, it is able to record this information as performance counters to the trace. You can enable tracing of specific resource counters by setting the environment variable VT_RUSAGE to a colon-separated list of counter names, as specified in Section C.4. For example, set
VT_RUSAGE=ru_stime:ru_majflt
to record the system time consumed by each process and the number of page faults.
Alternatively, one can set this variable to the value all to
enable recording of all 16 resource usage counters.
Note that not all counters are supported by all Unix operating systems.
Linux 2.6 kernels, for example, support only resource information for six of them.
See Section C.4 and the manual page of getrusage for details.
The resource usage counters are not recorded at every event. They are only read if 100ms have passed since the last sampling. The interval can be changed by setting VT_RUSAGE_INTV to the number of desired milliseconds. Setting VT_RUSAGE_INTV to zero leads to sampling resource usage counters at every event, which may introduce a large runtime overhead. Note that in most cases the operating system does not update the resource usage information at the same high frequency as the hardware performance counters. Setting VT_RUSAGE_INTV to a value less than 10ms does usually not improve the granularity.
Be aware that, when using the resource usage counters for multi-threaded programs, the information displayed is valid for the whole process and not for each single thread.
Calls to functions which reside in external libraries can be intercepted by implementing identical functions and linking them before the external library. Such ``wrapper functions'' can record the parameters and return values of the library functions.
If VampirTrace has been built with memory allocation tracing support , it uses this technique for recording calls to memory (de)allocation functions of the standard C library, which are executed by the application. The following functions are intercepted by VampirTrace:
| malloc | memalign |
| calloc | posix_memalign |
| realloc | valloc |
| free |
The gathered information will be saved as counter which indicates the current memory allocated in bytes. To request the measurement of the application's allocated memory, the user must set the environment variable VT_MEMTRACE to yes.
The GNU LIBC implementation provides a function to determine the core id of a CPU on which the calling thread is running. VampirTrace uses this functionality to record the current core identifier as counter. This feature can be activated by setting the environment variable VT_CPUIDTRACE to yes.
To enable a particular composition of CUDA measurement features the variable should contain a comma-separated list of available CUDA measurement options.
| cuda | enable CUDA (needed to use CUDA runtime API wrapper) |
| (OpenCL is available in VampirTrace GPU beta releases) | |
| cupti | use the CUPTI interface instead of the library wrapper |
| runtime | CUDA runtime API |
| driver | CUDA driver API |
| kernel | CUDA kernels |
| concurrent | force recording of concurrent kernels with CUPTI |
| idle | GPU compute idle time |
| pure_idle | GPU idle time - considering data transfers as not idle |
| (acts as idle for CUDA runtime API wrapper) | |
| memcpy | CUDA memory copies |
| sync | enable recording of synchronization for tracing via CUPTI |
| stream_reuse | force reusing of CUDA streams after cudaStreamDestroy() |
| memusage | CUDA memory allocation |
| debug | CUDA tracing debug mode |
| error | CUDA errors will exit the program |
| yes|default | same as ``cuda,runtime,kernel,memcpy'' |
| no | disable CUDA measurement |
Since CUDA Toolkit 4.1 the CUDA Profiling and Tool Interface (CUPTI) allows capturing of CUDA device activities. VampirTrace trace has currently two methods to trace the CUDA runtime API and corresponding GPU activities: traditional library wrapping with CUDA events for GPU activity measurement and tracing via the CUPTI interface. Several features are just implemented in the library wrapping approach, whereas the CUPTI measurement brings new possibilities and occasionally more accuracy.
The new environment variable VT_GPUTRACE replaces several previously available environment variables. However, there are still additional feature switches implemented as environment variables to further refine CUDA tracing (the default is bold):
Every CUDA stream, which is executed on a cuda-capable device and used during program execution, creates an own thread. ``CUDA-Threads'' can contain CUDA communication, kernel and counter records and have the following notation:
Due to an issue with CUPTI, the device is not always properly shown (device is displayed as ?). The CUDA stream number is increasing, beginning with the default stream 1. The stream number provided by CUPTI might not be evenly increasing. CUDA streams without records will not be written.
If CUDA libraries are used, which create CUDA streams themselves, many CUDA threads (CUDA streams per device) can appear in a program trace. In that case, it may be useful to force reusing of CUDA streams (add option stream_reuse to VT_GPUTRACE). This enables VampirTrace to reuse an existing thread buffer of a destroyed CUDA stream and therewith reduces the number of separate CUDA threads (or streams) in the trace. The CUDA stream number will then be missing in the CUDA thread notation.
As kernels and asynchronous memory copies are executed asynchronously on the CUDA device, information about these activities will be buffered until a synchronizing CUDA API function call or the program exits. Every used CUDA device and its corresponding host thread has an own buffer (8192 bytes by default), when CUDA tracing is done via the CUDA runtime API wrapper. If the buffer is full, it will be flushed immediately. When using CUDA tracing via CUPTI every CUDA context creation initiates the allocation of an own buffer (65536 bytes by default). If the buffer is full, further records will be dropped and a warning will be shown in stderr output. The buffer size can be specified in bytes with the environment variable VT_CUDATRACE_BUFFER_SIZE.
Several new region groups have been introduced:
| CUDART_API | CUDA runtime API calls |
|---|---|
| CUDRV_API | CUDA driver API calls |
| CUDA_SYNC | CUDA synchronization |
| CUDA_KERNEL | CUDA kernels (device functions) can only appear on ``CUDA-Threads'' |
| GPU_IDLE | GPU compute idle time - the CUDA device does not run any kernel currently (shown in first used stream of the device) |
| VT_CUDA | Measurement overhead (write CUDA events, check current device, etc.) |
Synchronous CUDA peer-to-peer memory copies will only be recorded, if the sync option is set and the synchronization level is 3 (default).
Until CUDA Toolkit 4.2 the usage of CUDA events between asynchronous tasks serializes their on-device execution. As VampirTrace uses CUDA events for time measurement and asynchronous tasks may overlap (depends on the CUDA device capability), there might be a sensible impact on the program flow. CUDA 5 removes this restriction.
With kernel tracing enabled there are three counters, which provide information about the kernel's grid, block and thread composition: blocks_per_grid, threads_per_block, threads_per_kernel. With CUPTI tracing additional kernel counters are available: static and dynamic shared memory, total local memory and registers per thread (VT_GPUTRACE_KERNEL=2).
GCC4.3 and OpenMP:
Use the flags -vt:opari -nodecl -Xcompiler=-fopenmp with vtnvcc
to compile the OpenMP CUDA application.
CUDA 3.1:
The CUDA runtime library 3.1 creates a conflict with zlib.
A workaround is to replace all
gcc/g++ calls with the VampirTrace compiler wrappers
(vtcc/vtc++) and pass the following additional flags to
nvcc for compilation of the kernels:
-I$VT_INSTALL_PATH/include/vampirtrace -L$VT_INSTALL_PATH/lib -Xcompiler=-g,-finstrument-functions,-pthread -lvt -lopen-trace-format -lcudart -lz -ldl -lm$VT_INSTALL_PATH is the path to the VampirTrace installation directory. It is not necessary to specify the VampirTrace include and library path, if it is installed in the default directory.
This uses automatic compiler instrumentation (-finstrument-functions) and the standard VampirTrace library. Replace the -lvt with -lvt-mt for multithreaded, -lvt-mpi for MPI and -lvt-hyb for multithreaded MPI applications. In this case the CUDA runtime library is linked before the zlib.
If the application is linked with gcc/g++, the linking command has to ensure, that the respective VampirTrace library is linked before the CUDA runtime library libcudart.so (check e.g. with ``ldd executable''). Using the VampirTrace compiler wrappers (vtcc/vtc++) for linking is the easiest way to ensure correct linking of the VampirTrace library.
With the library tracing mechanism described in section 2.9, it is possible to trace CUDA applications without recompiling or relinking. There are only events written for Runtime API calls, kernels and communication between host and device.
# Compilers NVCC := vtnvcc CXX := vtc++ CC := vtcc LINK := vtc++ #-vt:mt
CUDA 5.0:
Set the following environment variables for automatic instrumentation before
running make:
export GCC=vtc++ #-vt:mt export NVCC=vtnvcc #-vt:mt
Use the compiler switches for MPI, multi-threaded and hybrid programs, if necessary (e.g. the CUDA SDK example simpleMultiGPU is a multi-threaded program, which needs to be linked with a multi-threaded VampirTrace library).
Notes:
For 32-bit systems VampirTrace has to be configured with the 32-bit
version of the CUDA runtime library. If the link test fails, use the
following configure option :
--with-cuda-lib-dir=$CUDA_INSTALL_PATH/lib
To build CUPTI support on 32-bit systems (or for CUPTI 1.0), VampirTrace has to be configured with the 32-bit version of the CUPTI library. If the link test fails, use the following configure option :
--with-cupti-lib-dir=$CUPTI_INSTALL_PATH/lib
VampirTrace CUDA support has been successfully tested with CUDA toolkit version 3.x, 4.x and 5.0.
C/C++: #include "vt_user.h"
% vtcc
-DVTRACE_PTHREAD hello.c -o hello
export VT_PLUGIN_CNTR_METRICS=<library_name>_<event_name>If you have for example a library named libKswEvents.so with the event page_faults, the you can set it with
export VT_PLUGIN_CNTR_METRICS=KswEvents_page_faultsVisit http://www.tu-dresden.de/zih/vampirtrace/plugin_counter for documentation and examples.
If VampirTrace has been built with I/O tracing support , it uses the same technique as used to intercept memory (de)allocation functions (⇒ Section 4.3) for recording calls to I/O functions of the standard C library, which are executed by the application. The following functions are intercepted by VampirTrace:
| close | creat | creat64 | dup |
| dup2 | fclose | fcntl | fdopen |
| fgetc | fgets | flockfile | fopen |
| fopen64 | fprintf | fputc | fputs |
| fread | fscanf | fseek | fseeko |
| fseeko64 | fsetpos | fsetpos64 | ftrylockfile |
| funlockfile | fwrite | getc | gets |
| lockf | lseek | lseek64 | open |
| open64 | pread | pread64 | putc |
| puts | pwrite | pwrite64 | read |
| readv | rewind | unlink | write |
| writev |
The gathered information will be saved as I/O event records in the trace file. This feature has to be activated for each tracing run by setting the environment variable VT_IOTRACE to yes.
If you'd like to experiment with some other I/O library, set the environment variable VT_IOLIB_PATHNAME to the alternative one. Beware that this library must provide all I/O functions mentioned above otherwise VampirTrace will abort. Setting the environment variable VT_IOTRACE_EXTENDED to yes enables the collection of additional function arguments for some of the I/O function mentioned above. For example, this option stores offsets for pwrite and pread additionally to the I/O event record. Enabling VT_IOTRACE_EXTENDED automatically enables VT_IOTRACE.
In addition to the memory allocation tracing (⇒ Section 4.3) and I/O tracing (⇒ Section 4.8), VampirTrace uses the library wrapping technique also to intercept functions of the standard C library for creating and controling child processes. These functions are:
| execl | execvp | fork | waitid |
| execlp | execve | system | wait3 |
| execle | execvpe | wait | wait4 |
| execv | fexecve | waitpid |
When VampirTrace detects a call of an exec function, the current trace file is closed before executing the new program. If the executed program is also instrumented with VampirTrace, it will create a different trace file. Note that VampirTrace aborts if the exec function returns unsuccessfully. Calling fork in an instrumented program creates an additional process in the same trace file. Using this feature requires building VampirTrace with support for tracing LIBC functions for creating and , and setting the environment variable VT_EXECTRACE to yes.
VampirTrace supports the recording of MPI correctness events, e.g., usage of invalid MPI requests. This is implemented by using the Universal MPI Correctness Interface (UniMCI), which provides an interface between tools like VampirTrace and existing runtime MPI correctness checking tools. Correctness events are stored as markers in the trace file and are visualized by Vampir.
If VampirTrace is built with UniMCI support, the user only has to enable MPI correctness checking. This is done by merely setting the environment variable VT_MPICHECK to yes. Further, if your application crashes due to an MPI error you should set VT_MPICHECK_ERREXIT to yes. This environmental variable forces VampirTrace to write its trace to disk and exit afterwards. As a result, the trace with the detected error is stored before the application might crash.
To install VampirTrace with correctness checking support it is necessary to have UniMCI installed on your system. UniMCI in turn requires you to have a supported MPI correctness checking tool installed, currently only the tool Marmot is known to have UniMCI support. So all in all you should use the following order to install with correctness checking support:
Information on how to install Marmot and UniMCI is given in their respective manuals. VampirTrace will automatically detect an UniMCI installation if the unimci-config tool is in path.
In addition to the manual instrumentation (⇒ Section 2.4), the VampirTrace API provides instrumentation calls which allow recording of program variable values (e.g. iteration counts, calculation results, ...) or any other numerical quantity. A user-defined counter is identified by its name, the counter group it belongs to, the type of its value (integer or floating-point) and the unit that the value is quoted (e.g. ``GFlop/sec'').
The VT_COUNT_GROUP_DEF and VT_COUNT_DEF instrumentation calls can be used to define counter groups and counters:
Fortran: #include "vt_user.inc" integer :: id, gid VT_COUNT_GROUP_DEF('name', gid) VT_COUNT_DEF('name', 'unit', type, gid, id)
C/C++: #include "vt_user.h" unsigned int id, gid; gid = VT_COUNT_GROUP_DEF("name"); id = VT_COUNT_DEF("name", "unit", type, gid);
The definition of a counter group is optional. If no special counter group is desired, the default group ``User'' can be used. In this case, set the parameter gid of VT_COUNT_DEF() to VT_COUNT_DEFGROUP.
The third parameter type of VT_COUNT_DEF specifies the data type of the counter value. To record a value for any of the defined counters the corresponding instrumentation call VT_COUNT_*_VAL must be invoked.
| Fortran: | ||
|---|---|---|
| Type | Count call | Data type |
| VT_COUNT_TYPE_INTEGER | VT_COUNT_INTEGER_VAL | integer (4 byte) |
| VT_COUNT_TYPE_INTEGER8 | VT_COUNT_INTEGER8_VAL | integer (8 byte) |
| VT_COUNT_TYPE_REAL | VT_COUNT_REAL_VAL | real |
| VT_COUNT_TYPE_DOUBLE | VT_COUNT_DOUBLE_VAL | double precision |
| C/C++: | ||
|---|---|---|
| Type | Count call | Data type |
| VT_COUNT_TYPE_SIGNED | VT_COUNT_SIGNED_VAL | signed int (max. 64-bit) |
| VT_COUNT_TYPE_UNSIGNED | VT_COUNT_UNSIGNED_VAL | unsigned int (max. 64-bit) |
| VT_COUNT_TYPE_FLOAT | VT_COUNT_FLOAT_VAL | float |
| VT_COUNT_TYPE_DOUBLE | VT_COUNT_DOUBLE_VAL | double |
The following example records the loop index i:
Fortran: #include "vt_user.inc" program main integer :: i, cid, cgid VT_COUNT_GROUP_DEF('loopindex', cgid) VT_COUNT_DEF('i', '#', VT_COUNT_TYPE_INTEGER, cgid, cid) do i=1,100 VT_COUNT_INTEGER_VAL(cid, i) end do end program main
C/C++: #include "vt_user.h" int main() { unsigned int i, cid, cgid; cgid = VT_COUNT_GROUP_DEF('loopindex'); cid = VT_COUNT_DEF("i", "#", VT_COUNT_TYPE_UNSIGNED, cgid); for( i = 1; i <= 100; i++ ) { VT_COUNT_UNSIGNED_VAL(cid, i); } return 0; }
For all three languages the instrumented sources have to be compiled with -DVTRACE. Otherwise the VT_* calls are ignored.
Optionally, if the sources contain further VampirTrace API calls and only the calls for user-defined counters shall be disabled, then the sources have to be compiled with -DVTRACE_NO_COUNT in addition to -DVTRACE.
In addition to the manual instrumentation (⇒ Section 2.4), the VampirTrace API provides instrumentation calls which allow recording of special user information, which can be used to better identify parts of interest. A user-defined marker is identified by its name and type.
Fortran: #include "vt_user.inc" integer :: mid VT_MARKER_DEF('name', type, mid) VT_MARKER(mid, 'text') C/C++: #include "vt_user.h" unsigned int mid; mid = VT_MARKER_DEF("name",type); VT_MARKER(mid, "text"); Types for Fortran/C/C++: VT_MARKER_TYPE_ERROR VT_MARKER_TYPE_WARNING VT_MARKER_TYPE_HINT
For all three languages the instrumented sources have to be compiled with -DVTRACE. Otherwise the VT_* calls are ignored.
Optionally, if the sources contain further VampirTrace API calls and only the calls for user-defined markers shall be disabled, then the sources have to be compiled with -DVTRACE_NO_MARKER in addition to -DVTRACE.
Fortran: #include "vt_user.inc" integer :: cid VT_COMM_DEF('name', cid) C/C++: #include "vt_user.h" unsigned cid; cid = VT_COMM_DEF("name", cid);
Using VT_SEND and VT_RECV the user can insert send and receive events into the trace:
C/C++: int rank, size; MPI_Comm_rank(MPI_COMM_WORLD, &rank); MPI_Comm_size(MPI_COMM_WORLD, &size); if( rank == 0 ) { for ( int i = 1; i < size; i++ ) { VT_SEND(VT_COMM_WORLD,i,100); } }else { VT_RECV(VT_COMM_WORLD,rank,100); }
The calls are similar for Fortran.
As can be seen, the arguments to VT_SEND and VT_RECV are a communicator, a tag and the size of the message. The tag is required in order to identify both ends of a user-defined communication. Therefore it has to be globally unique for a given communicator and cannot be reused within a single communicator. Messages with duplicated tags will not be visible in the final trace.
For all three languages the instrumented sources have to be compiled with -DVTRACE. Otherwise the VT_* calls are ignored. Optionally, if the sources contain further VampirTrace API calls and only the calls for user-defined markers shall be disabled, then the sources have to be compiled with -DVTRACE_NO_MSG in addition to -DVTRACE.
By default, all calls of instrumented functions will be traced, so that the
resulting trace files can easily become very large. In order to decrease the
size of a trace, VampirTrace allows the specification of filter directives
before running an instrumented application.
The user can decide on how often an instrumented function(group) shall be
recorded to a trace file.
To use a filter, the environment variable VT_FILTER_SPEC needs to be
defined. It should contain the path and name of a file with filter directives
specified as follows:
<function> - <limit> [S:<[min-]max-stack-level>] [R]
or
<groups> - <limit> [S:<[min-]max-stack-level>] [R] G
or
<function-call-path> - <limit> C
| functions, groups | Semicolon-separated list of |
| functions/groups. | |
| (can contain wildcards) | |
| function-call-path | Semicolon-separated list of |
| functions in a call path. | |
| (MUST NOT contain wildcards) | |
| limit | call limit |
| Stop recording of functions/groups when | |
| the specified call limit is reached. | |
| (0 = don't record functions/groups, | |
| -1 record unlimited) | |
| S:<[min-]max-stack-level> | |
| minimum/maximum call stack level | |
| Don't record functions/groups called | |
| beyond the specified stack level | |
| boundaries. | |
| (values must be > 0, only valid if call | |
| limit is != 0) | |
| R | Attribute for recursive filtering. |
| Don't record callees of filtered | |
| function/group. | |
| G | Attribute for filtering function groups. |
| C | Attribute for filtering function a call path. |
| (implies recursive filtering R) | |
Example:
add;sub;mul;div -- 1000 MATH -- 500 G * -- 3000000 S:5-10
These filter directives cause that the functions add, sub,
mul, and div will be recorded at most 1000 times. All the functions
of the group MATH at most 500 times. The remaining functions * will
only be recorded when they are called between call stack level 5 and 10 but at most
3000000 times.
Besides creating filter files manually, you can also use the vtfilter tool to generate them automatically. This tool reads a provided trace and decides whether a function should be filtered or not, based on the evaluation of
The 'C' attribute indicates that the listed functions specify a call path
- a specific sequence of function calls. Recording of the last function in the
list will be stopped if the specified call limit is reached.
The call path must begin with the root function, typically main, and MUST NOT
contain wildcards.
Example:
main;foo;bar -- 0 C
This filter directive causes that the function bar called from foo which prior was called from main will never be recorded. Since call path filtering impies recursiveness (see attribute R) all callee functions of this call path will be excluded from recording as well.
An experimental extension allows rank specific filtering. Use @ clauses to restrict all following filters to the given ranks. The rank selection must be given as a list of <from> - <to> pairs or single values. Note that all rank specific rules are only effective after MPI_Init because the ranks are unknown before. The optional argument - OFF disables the given ranks completely, regardless of following filter rules.
@ 35 - 42 -- OFF @ 4 - 10, 20 - 29, 34 foo;bar -- 2000 * -- 0
The example defines two limits for the ranks 4 - 10, 20 - 29, and 34. The first line disables the ranks 35 - 42 completely.
For Java tracing there are additional possibilities of filtering. Firstly, there is a default filter applied. The rules can be found in the filter file <vt-install>/etc/ vt-java-default-filter.spec. Secondly, user-defined filters can be applied additionally by setting VT_JAVA_FILTER_SPEC to a file containing the rules.
The syntax of the filter rules is as follows:
<method|thread> <include|exclude> <filter string[;fs]...>
Filtering can be done on thread names and method names, defined by the first parameter. The second parameter determines whether the matching item shall be included for tracing or excluded from it. Multiple filter strings on a line have to be separated by ; and may contain occurences of * for wildcard matching.
The user-supplied filter rules will be applied before the default filter and the first match counts so it is possible to include items that would be excluded by the default filter otherwise.
VampirTrace allows assigning functions/regions to a group. Groups can, for instance, be highlighted by different colors in Vampir displays. The following standard groups are created by VampirTrace:
| Group name | Contained functions/regions |
|---|---|
| MPI | MPI functions |
| OMP | OpenMP API function calls |
| OMP_SYNC | OpenMP barriers |
| OMP_PREG | OpenMP parallel regions |
| Pthreads | Pthread API function calls |
| LIBC-EXEC | LIBC function calls for creating and controling child processes (⇒ Section 4.9) |
| LIBC-I/O | LIBC functions (⇒ Section 4.8) |
| LIBC-MALLOC | LIBC memory (de)allocation functions (⇒ Section 4.3) |
| Application | remaining instrumented functions and source code regions |
Additionally, you can create your own groups, e.g., to better distinguish different phases of an application. To use function/region grouping set the environment variable VT_GROUPS_SPEC to the path of a file which contains the group assignments specified as follows:
<group>=<functions>
| group | group name |
| functions | semicolon-seperated list of functions |
| (can contain wildcards) |
Example:
MATH=add;sub;mul;div USER=app_*
These group assignments associate the functions add, sub, mul, and div with group ``MATH'', and all functions with the prefix app_ are associated with group ``USER''.
Building VampirTrace is typically a combination of running configure and make. Execute the following commands to install VampirTrace from the directory at the top of the tree:
% ./configure --prefix=/where/to/install [...lots of output...] % make all install
If you need special access for installing, you can execute make all as a user with write permissions in the build tree and a separate make install as a user with write permissions to the install tree.
However, for more details, also read the following instructions. Sometimes it might be necessary to provide ./configure with options, e.g., specifications of paths or compilers.
VampirTrace comes with example programs written in C, C++, and Fortran. They can be used to test different instrumentation types of the VampirTrace installation. You can find them in the directory examples of the VampirTrace package.
Note that you should compile VampirTrace with the same compiler you use for the application to trace.
Some systems require unusual options for compiling or linking which the configure script does not know. Run ./configure -help for details on some of the pertinent environment variables.
You can pass initial values for configuration parameters to configure by setting variables in the command line or in the environment. Here is an example:
% ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
By default, make install will install the package's files in /usr/local/bin, /usr/local/include, etc. You can specify an installation prefix other than /usr/local by giving configure the option -prefix=PATH.
This a summary of the most important optional features. For a full list of all available features run ./configure -help.
This a summary of the most important optional features. For a full list of all available features run ./configure -help.
If you would like to use an external version of OTF library, set:
If the supplied OTF library was built without zlib support then OTFLIB will be set to -lopen-trace-format.
If you have not specified the environment variable MPICC (MPI compiler command) use the following options to set the location of your MPI installation:
If your system does not have an MPI Fortran library set -enable-fmpi-lib (see above), otherwise set:
Use the following options to specify your MPI-implementation
To enable enhanced timer synchronization a LAPACK library with C wrapper support is needed:
To enable Java support the JVM Tool Interface (JVMTI) version 1.0 or higher is required:
To enable support for generating wrapper for 3th-Party libraries the C code parser CTool is needed:
To enable support for CUDA API wrapping, the CUDA-Toolkit install path is needed:
To enable support for CUPTI features, the CUPTI install path is needed:
Building VampirTrace on cross compilation platforms needs some special attention. The compiler wrappers, OPARI, and the Library Wrapper Generator are built for the front-end (build system) whereas the the VampirTrace libraries, vtdyn, vtunify, and vtfilter are built for the back-end (host system). Some configure options which are of interest for cross compilation are shown below:
BlueGene/P and BlueGene/Q:
% ./configure --host=powerpc64-ibm-linux-gnu
Cray XK6:
% ./configure --host=x86_64-cray-linux-gnu CC_FOR_BUILD=craycc CXX_FOR_BUILD=crayc++
NEC SX6:
% ./configure --host=sx6-nec-superux14.1
Add the bin subdirectory of the installation directory to your
$PATH environment variable. To use VampirTrace with Dyninst,
you will also need to add the lib subdirectory to your
LD_LIBRARY_PATH environment variable:
for csh and tcsh:
> setenv PATH <vt-install>/bin:$PATH > setenv LD_LIBRARY_PATH <vt-install>/lib:$LD_LIBRARY_PATHfor bash and sh:
% export PATH=<vt-install>/bin:$PATH % export LD_LIBRARY_PATH=<vt-install>/lib:$LD_LIBRARY_PATH
If you have checked out a developer's copy of VampirTrace (i.e. checked out from CVS), you should first run:
% ./bootstrap [--otf-package <package>] [--version <version>]Note that GNU Autoconf ≥2.60 and GNU Automake ≥1.9.6 are required. You can download them from http://www.gnu.org/software/autoconfand http://www.gnu.org/software/automake.
vtcc,vtcxx,vtfort - compiler wrappers for C, C++, Fortran Syntax: vt<cc|cxx|fc> [options] ... options: -vt:help Show this help message. -vt:version Show VampirTrace version. -vt:<cc|cxx|fc> <cmd> Set the underlying compiler command. -vt:inst <insttype> Set the instrumentation type. possible values: compinst fully-automatic by compiler manual manual by using VampirTrace's API dyninst binary by using Dyninst (www.dyninst.org) tauinst automatic source code instrumentation by using PDT/TAU -vt:inst-exclude-file-list <file>[,file,...] Set list of source files to be excluded from the automatic instrumentation by the compiler or PDT/TAU. (file names can contain wildcards) -vt:inst-exclude-file <file> Set pathname of file containing a list of source files to be excluded from the automatic instrumentation by the compiler or PDT/TAU. (file names can contain wildcards, one file name per line) Note when using an exclusion list for automatic compiler instrumentation: If a source file from the exclusion list is involved in a compile step, the instrumentation is disabled for this step. -vt:opari <!args> Set options for OPARI command. (see share/vampirtrace/doc/opari/Readme.html) -vt:opari-rcfile <file> Set pathname of the OPARI resource file. (default: opari.rc) -vt:opari-table <file> Set pathname of the OPARI runtime table file. (default: opari.tab.c) -vt:opari-exclude-file-list <file>[,file,...] Set list of source files to be excluded from the instrumentation of OpenMP constructs by OPARI. (file names can contain wildcards) -vt:opari-exclude-file <file> Set pathname of file containing a list of source files to be excluded from the instrumentation of OpenMP constructs by OPARI. (file names can contain wildcards, one file name per line) -vt:noopari Disable instrumentation of OpenMP contructs by OPARI. -vt:<seq|mpi|mt|hyb> Enforce application's parallelization type. It's only necessary if it could not be determined automatically based on underlying compiler and flags. seq = sequential mpi = parallel (uses MPI) mt = parallel (uses OpenMP/POSIX threads) hyb = hybrid parallel (MPI + Threads) (default: automatically) -vt:tau <!args> Set options for the TAU instrumentor command. -vt:pdt <!args> Set options for the PDT parse command. -vt:preprocess Preprocess the source files before parsing by OPARI and/or PDT. -vt:cpp <cmd> Set C preprocessor command. -vt:cppflags <[!]flags> Set/add flags for the C preprocessor. -vt:verbose Enable verbose mode. -vt:keepfiles Keep intermediate files. -vt:reusefiles Reuse intermediate files, if exist. -vt:show[me] Do not invoke the underlying compiler. Instead, show the command line that would be executed to compile and link the program. -vt:showme-compile Do not invoke the underlying compiler. Instead, show the compiler flags that would be supplied to the compiler. -vt:showme-link Do not invoke the underlying compiler. Instead, show the linker flags that would be supplied to the compiler. See the man page for your underlying compiler for other options that can be passed through 'vt<cc|cxx|fc>'. Environment variables: VT_INST Equivalent to '-vt:inst' VT_CC Equivalent to '-vt:cc ' VT_CXX Equivalent to '-vt:cxx ' VT_FC Equivalent to '-vt:fc' VT_CFLAGS C compiler flags VT_CXXFLAGS C++ compiler flags VT_FCFLAGS Fortran compiler flags VT_LDFLAGS Linker flags VT_LIBS Libraries to pass to the linker The corresponding command line options overwrite the environment variables setting. Examples: automatically instrumentation by compiler: vtcc -vt:cc gcc -vt:inst compinst -c foo.c -o foo.o vtcc -vt:cc gcc -vt:inst compinst -c bar.c -o bar.o vtcc -vt:cc gcc -vt:inst compinst foo.o bar.o -o foo manually instrumentation by using VT's API: vtfort -vt:inst manual foobar.F90 -o foobar -DVTRACE IMPORTANT: Fortran source files instrumented by VT's API have to be preprocessed by CPP.
vtunify[-mpi] - local trace unifier for VampirTrace. Syntax: vtunify[-mpi] [options] <input trace prefix> options: -h, --help Show this help message. -V, --version Show VampirTrace version. -o PREFIX Prefix of output trace filename. -f FILE Function profile output filename. (default=PREFIX.prof.txt) -k, --keeplocal Don't remove input trace files. -p, --progress Show progress. -v, --verbose Increase output verbosity. (can be used more than once) -q, --quiet Enable quiet mode. (only emergency output) --iofsl-servers LIST Enable IOFSL mode where LIST contains a comma-separated list of IOFSL server addresses. --iofsl-mode MODE IOFSL mode (MULTIFILE or MULTIFILE_SPLIT). (default: MULTIFILE_SPLIT) --iofsl-asyncio Use asynchronous I/O in IOFSL mode. --stats Unify only summarized information (*.stats), no events --nocompress Don't compress output trace files. --nosnapshots Don't create snapshots. --maxsnapshots N Maximum number of snapshots. (default: 1024) --nomsgmatch Don't match messages. --droprecvs Drop message receive events, if msg. matching is enabled.
vtdyn - binary instrumentor (Dyninst mutator) for VampirTrace. Syntax: vtdyn [options] <executable> [arguments ...] options: -h, --help Show this help message. -V, --version Show VampirTrace version. -v, --verbose Increase output verbosity. (can be used more than once) -q, --quiet Enable quiet mode. (only emergency output) -o, --output FILE Rewrite instrumented executable to specified pathname. -f, --filter FILE Pathname of input filter file. -s, --shlibs SHLIBS[,...] Comma-separated list of shared libraries which shall also be instrumented. --outer-loops Do instrument outer loops within functions. --inner-loops Do instrument inner loops within outer loops. (implies --outer-loops) --loop-iters Do instrument loop iterations. (implies --outer-loops) --ignore-nodbg Don't instrument functions which have no debug information.
vtfilter[-mpi] - filter tool for VampirTrace.  See 'gen-options' below for valid options. --filt Filter a trace using an already existing filter file. (default) See 'filt-options' below for valid options. -h, --help Show this help message. -V, --version Show VampirTrace version. -p, --progress Show progress. -v, --verbose Increase output verbosity. (can be used more than once) gen-options: -o, --output=FILE Pathname of output filter file. -r, --reduce=N Reduce the trace size to N percent of the original size. The program relies on the fact that the major part of the trace are function calls. The approximation of size will get worse with a rising percentage of communication and other non function calling or performance counter records. -l, --limit=N Limit the number of calls for filtered function to N. (default: 0) -s, --stats Prints out the desired and the expected percentage of file size. -e, --exclude=FUNC[;FUNC;...] Exclude certain functions from filtering. A function name may contain wildcards. --exclude-file=FILE Pathname of file containing a list of functions to be excluded from filtering. -i, --include=FUNC[;FUNC;...] Force to include certain functions into the filter. A function name may contain wildcards. --include-file=FILE Pathname of file containing a list of functions to be included into the filter. --include-callees Automatically include callees of included functions as well into the filter. filt-options: -o, --output=FILE Pathname of output trace file. -f, --filter=FILE Pathname of input filter file. -s, --max-streams=N Maximum number of output streams. (default: 0) vtfilter: Set this to 0 to get the same number of output streams as input streams. vtfilter-mpi: Set this to 0 to get the same number of output streams as MPI processes used, but at least the number of input streams. --max-file-handles=N Maximum number of files that are allowed to be open simultaneously. (default: 256) --nocompress Don't compress output trace files.
vtlibwrapgen - library wrapper generator for VampirTrace. Syntax: Generate a library wrapper source file: vtlibwrapgen [gen-options] <input header file> [input header file...] Build a wrapper library from a generated source file: vtlibwrapgen --build [build-options] <input lib. wrapper source file> options: --gen Generate a library wrapper source file. This is the default behavior. See 'gen-options' below for valid options. --build Build a wrapper library from a generated source file. See 'build-options' below for valid options. -h, --help Show this help message. -V, --version Show VampirTrace version. -q, --quiet Enable quiet mode. (only emergency output) -v, --verbose Increase output verbosity. (can be used more than once) gen-options: -o, --output=FILE Pathname of output wrapper source file. (default: wrap.c) -l, --shlib=SHLIB Pathname of shared library that contains the actual library functions. (can be used more then once) -f, --filter=FILE Pathname of input filter file. -g, --group=NAME Separate function group name for wrapped functions. -s, --sysheader=FILE Header file to be included additionally. --nocpp Don't use preprocessor. --keepcppfile Don't remove preprocessed header files. --cpp=CPP C preprocessor command (default: gcc -E) --cppflags=CPPFLAGS C preprocessor flags, e.g. -I<include dir> --cppdir=DIR Change to this preprocessing directory. environment variables: VT_CPP C preprocessor command (equivalent to '--cpp') VT_CPPFLAGS C preprocessor flags (equivalent to '--cppflags') build-options: -o, --output=PREFIX Prefix of output wrapper library. (default: libwrap) --shared Do only build shared wrapper library. --static Do only build static wrapper library. --libtool=LT Libtool command --cc=CC C compiler command (default: gcc) --cflags=CFLAGS C compiler flags --ld=LD linker command (default: CC) --ldflags=LDFLAGS linker flags, e.g. -L<lib dir> (default: CFLAGS) --libs=LIBS libraries to pass to the linker, e.g. -l<library> environment variables: VT_CC C compiler command (equivalent to '--cc') VT_CFLAGS C compiler flags (equivalent to '--cflags') VT_LD linker command (equivalent to '--ld') VT_LDFLAGS linker flags (equivalent to '--ldflags') VT_LIBS libraries to pass to the linker (equivalent to '--libs') examples: Generating wrapper library 'libm_wrap' for the Math library 'libm.so': vtlibwrapgen -l libm.so -g MATH -o mwrap.c \ /usr/include/math.h vtlibwrapgen --build -o libm_wrap mwrap.c export LD_PRELOAD=$PWD/libm_wrap.so:libvt.so
vtrun - application execution wrapper for VampirTrace. Syntax: vtrun [options] <executable> [arguments] options: -h, --help Show this help message. -V, --version Show VampirTrace version. -v, --verbose Increase output verbosity. (can be used more than once) -q, --quiet Enable quiet mode. (only emergency output) -<seq|mpi|mt|hyb> Set application's parallelization type. It's only necessary if it could not be determined automatically. seq = sequential mpi = parallel (uses MPI) mt = parallel (uses OpenMP/POSIX threads) hyb = hybrid parallel (MPI + Threads) (default: automatically) --fortran Set application's language to Fortran. It's only necessary for MPI-applications and if it could not be determined automatically. --dyninst Instrument user functions by Dyninst. --extra-libs=LIBS Extra libraries to preload. example: original: mpirun -np 4 ./a.out with VampirTrace: mpirun -np 4 vtrun ./a.out
vtiofsl-start - set environment variables and start IOFSL servers. Syntax: vtiofsl-start [options] options: -h, --help Show this help message. -V, --version Show VampirTrace version. -v, --verbose Increase output verbosity. (can be used more than once) -q, --quiet Enable quiet mode. (only emergency output) -n, --num NUM Number of IOFSL servers to start. -m, --mode MODE IOFSL mode (MULTIFILE or MULTIFILE_SPLIT). (default: MULTIFILE_SPLIT) --asyncio Use asynchronous I/O. environment variables: VT_IOFSL_NUM_SERVERS equivalent to '-n' or '--num' VT_IOFSL_MODE equivalent to '-m' or '--mode' VT_IOFSL_ASYNC_IO=<yes|true|1> equivalent to '--asyncio' note: This script needs to be sourced from a shell, since it sets environment variables. Either -n or VT_IOFSL_NUM_SERVERS must be specified.
vtiofsl-stop - stop running IOFSL servers. Syntax: vtiofsl-stop [options] options: -h, --help Show this help message. -V, --version Show VampirTrace version. -v, --verbose Increase output verbosity. (can be used more than once) -q, --quiet Enable quiet mode. (only emergency output) note: This script needs to be sourced from a shell, since it sets environment variables.
Available counter names can be queried with the PAPI commands papi_avail and papi_native_avail. Depending on the hardware there are limitations in the combination of different counters. To check whether your choice works properly, use the command papi_event_chooser.
PAPI_L[1|2|3]_[D|I|T]C[M|H|A|R|W] Level 1/2/3 data/instruction/total cache misses/hits/accesses/reads/writes PAPI_L[1|2|3]_[LD|ST]M Level 1/2/3 load/store misses PAPI_CA_SNP Requests for a snoop PAPI_CA_SHR Requests for exclusive access to shared cache line PAPI_CA_CLN Requests for exclusive access to clean cache line PAPI_CA_INV Requests for cache line invalidation PAPI_CA_ITV Requests for cache line intervention PAPI_BRU_IDL Cycles branch units are idle PAPI_FXU_IDL Cycles integer units are idle PAPI_FPU_IDL Cycles floating point units are idle PAPI_LSU_IDL Cycles load/store units are idle PAPI_TLB_DM Data translation lookaside buffer misses PAPI_TLB_IM Instruction translation lookaside buffer misses PAPI_TLB_TL Total translation lookaside buffer misses PAPI_BTAC_M Branch target address cache misses PAPI_PRF_DM Data prefetch cache misses PAPI_TLB_SD Translation lookaside buffer shootdowns PAPI_CSR_FAL Failed store conditional instructions PAPI_CSR_SUC Successful store conditional instructions PAPI_CSR_TOT Total store conditional instructions PAPI_MEM_SCY Cycles Stalled Waiting for memory accesses PAPI_MEM_RCY Cycles Stalled Waiting for memory Reads PAPI_MEM_WCY Cycles Stalled Waiting for memory writes PAPI_STL_ICY Cycles with no instruction issue PAPI_FUL_ICY Cycles with maximum instruction issue PAPI_STL_CCY Cycles with no instructions completed PAPI_FUL_CCY Cycles with maximum instructions completed PAPI_BR_UCN Unconditional branch instructions PAPI_BR_CN Conditional branch instructions PAPI_BR_TKN Conditional branch instructions taken PAPI_BR_NTK Conditional branch instructions not taken PAPI_BR_MSP Conditional branch instructions mispredicted PAPI_BR_PRC Conditional branch instructions correctly predicted PAPI_FMA_INS FMA instructions completed PAPI_TOT_IIS Instructions issued PAPI_TOT_INS Instructions completed PAPI_INT_INS Integer instructions PAPI_FP_INS Floating point instructions PAPI_LD_INS Load instructions PAPI_SR_INS Store instructions PAPI_BR_INS Branch instructions PAPI_VEC_INS Vector/SIMD instructions PAPI_LST_INS Load/store instructions completed PAPI_SYC_INS Synchronization instructions completed PAPI_FML_INS Floating point multiply instructions PAPI_FAD_INS Floating point add instructions PAPI_FDV_INS Floating point divide instructions PAPI_FSQ_INS Floating point square root instructions PAPI_FNV_INS Floating point inverse instructions PAPI_RES_STL Cycles stalled on any resource PAPI_FP_STAL Cycles the FP unit(s) are stalled PAPI_FP_OPS Floating point operations PAPI_TOT_CYC Total cycles PAPI_HW_INT Hardware interrupts
Available counter names can be queried with the VampirTrace tool vtcpcavail. In addition to the counter names, it shows how many performance counters can be queried at a time. See below for a sample output.
% ./vtcpcavail CPU performance counter interface: UltraSPARC T2 Number of concurrently readable performance counters on the CPU: 2 Available events: AES_busy_cycle AES_op Atomics Br_completed Br_taken CPU_ifetch_to_PCX CPU_ld_to_PCX CPU_st_to_PCX CRC_MPA_cksum CRC_TCPIP_cksum DC_miss DES_3DES_busy_cycle DES_3DES_op DTLB_HWTW_miss_L2 DTLB_HWTW_ref_L2 DTLB_miss IC_miss ITLB_HWTW_miss_L2 ITLB_HWTW_ref_L2 ITLB_miss Idle_strands Instr_FGU_arithmetic Instr_cnt Instr_ld Instr_other Instr_st Instr_sw L2_dmiss_ld L2_imiss MA_busy_cycle MA_op MD5_SHA-1_SHA-256_busy_cycle MD5_SHA-1_SHA-256_op MMU_ld_to_PCX RC4_busy_cycle RC4_op Stream_ld_to_PCX Stream_st_to_PCX TLB_miss See the "UltraSPARC T2 User's Manual" for descriptions of these events. Documentation for Sun processors can be found at: http://www.sun.com/processors/manuals
SX_CTR_STM System timer reg SX_CTR_USRCC User clock counter SX_CTR_EX Execution counter SX_CTR_VX Vector execution counter SX_CTR_VE Vector element counter SX_CTR_VECC Vector execution clock counter SX_CTR_VAREC Vector arithmetic execution clock counter SX_CTR_VLDEC Vector load execution clock counter SX_CTR_FPEC Floating point data execution counter SX_CTR_BCCC Bank conflict clock counter SX_CTR_ICMCC Instruction cache miss clock counter SX_CTR_OCMCC Operand cache miss clock counter SX_CTR_IPHCC Instruction pipeline hold clock counter SX_CTR_MNCCC Memory network conflict clock counter SX_CTR_SRACC Shared resource access clock counter SX_CTR_BREC Branch execution counter SX_CTR_BPFC Branch prediction failure counter
The list of resource usage counters can also be found in the manual page of getrusage. Note that, depending on the operating system, not all fields may be maintained. The fields supported by the Linux 2.6 kernel are shown in the table.
| Name | Unit | Linux | Description |
|---|---|---|---|
| ru_utime | ms | x | Total amount of user time used. |
| ru_stime | ms | x | Total amount of system time used. |
| ru_maxrss | kB | Maximum resident set size. | |
| ru_ixrss | kB × s | Integral shared memory size (text segment) over the runtime. | |
| ru_idrss | kB × s | Integral data segment memory used over the runtime. | |
| ru_isrss | kB × s | Integral stack memory used over the runtime. | |
| ru_minflt | # | x | Number of soft page faults (i.e. those serviced by reclaiming a page from the list of pages awaiting reallocation). |
| ru_majflt | # | x | Number of hard page faults (i.e. those that required I/O). |
| ru_nswap | # | Number of times a process was swapped out of physical memory. | |
| ru_inblock | # | Number of input operations via the file system. Note: This and ru_oublock do not include operations with the cache. | |
| ru_oublock | # | Number of output operations via the file system. | |
| ru_msgsnd | # | Number of IPC messages sent. | |
| ru_msgrcv | # | Number of IPC messages received. | |
| ru_nsignals | # | Number of signals delivered. | |
| ru_nvcsw | # | x | Number of voluntary context switches, i.e. because the process gave up the processor before it had to (usually to wait for some resource to be available). |
| ru_nivcsw | # | x | Number of involuntary context switches, i.e. a higher priority process became runnable or the current process used up its time slice. |
VampirTrace and OTF can make use of the I/O Forwarding Scalability Layer (IOFSL) which allows users to write the data of many streams of a parallel trace into one or few physical files (so called multifiles) during program run. Compared with the default of writing at least two files per stream, process or even thread, this can provide a substantial performance benefit and is especially important for stability when recording highly parallel traces.
This section gives an overview over the architecture and principles from a technical point of view.
The Open Trace Format (OTF) is utilized by VampirTrace to store its trace information obtained during a run of the instrumented application. The OTF library provides an interface for reading and writing trace files. A trace consists of one or more so called streams, each containing the data of one process or thread. The data is stored in records encoded using a plain ASCII format and can optionally be transparently compressed. Although it basically offers a way to store several streams in one physical file, it does not offer mechanisms to assure data consistency for concurrent writes into one file.
To allow for arbitrary thread creation during a trace run and to avoid expensive locking, VampirTrace writes the obtained data of each process or thread into separate OTF files causing the creation of at least two files per process/thread (definitions and events). With the ever increasing number of parallel processes and the limitations of today's parallel filesystem's meta-data processing, this can become a severe problem for system performance and stability. Consequently, the goal was to significantly reduce the number of physical files used by VampirTrace and OTF during a trace run from at least two files per process/thread to a number that is acceptable for today's filesystems.
The goal of the I/O Forwarding Scalability Layer IOFSL is to provide a forwarding layer on the basis of a client-server architecture. It allows clients to send I/O requests to a server which is able to execute the original I/O calls and even aggregate these requests to improve performance. Besides the aggregation of normal write requests, the server also offers non-blocking write requests and a so-called atomic append mode which allows many clients to write potentially large blocks of data concurrently into one single physical file (multifile) without the need for client-side locking. In this case, the data is appended to the end of the file and the corresponding offset can be obtained later. Additionally, this atomic append feature can be used with more than one server allowing the write requests of many clients into one file being distributed across a smaller number of servers.
IOFSL is being developed at Argonne National Laboratory and is available at www.iofsl.org. By relying on open software, it is portable to a wide range of machines and has been tested on a generic Linux cluster as well as on the leadership-class computing system Jaguar.
Since IOFSL servers can handle multiple clients, an N:M mapping of clients to servers is possible. The exact ratio depends on the amount of data the clients send and the bandwidth available for the server nodes. In our test cases, a ratio of up to 300 clients per server was used.
When using the IOFSL integration, all write requests in OTF are issued using the zoidfs API. Those writes are handled by the IOFSL forwarding servers and aggregated into a single file using the atomic append feature. The offset in the multifile is returned to OTF and stored in a second file, the so called index file, in order to maintain the mapping between written blocks and streams. For any block of a stream written into the multifile, the index file contains the ID of the stream, the start of the block, and its length. This allows for an efficient reading of blocks since only the index file has to be scanned for entries for a given stream ID. Additionally, a large number of logical files (streams) can be stored using only two physical files.
In order to use this setup, IOFSL and VampirTrace have to be compiled in order. In the following sections, the directory <install_dir> should be replaced with a - possibly user-local - directory used for installation, e.g. $HOME/local. The installation procedure for IOFSL is described at https://trac.mcs.anl.gov/projects/iofsl/wiki/Building. Currently the iofsl_vampir git branch is required.
Note that building boost, OpenPA or BMI/PVFS is not required in case it is already present on the machine. Building GNU autoconf is not covered by this document. For the use with VampirTrace, ROMIO and therefore rebuilding MPICH is not required.
$> ./bootstrap.sh \ --with-libraries=system,date_time,\ program_options,regex,thread,test \ --prefix=<install_dir> $> ./bjam --prefix=<install_dir> \ --libdir=<install_dir>/lib \ --includedir=<install_dir>/include \ install
$> ./configure --prefix=<install_dir> $> make all install
$> ./configure --enable-bmi-only --prefix=<install_dir> \ --with-openib=<openib_install_dir> $> make all installNote that the option -with-openib can be omitted if support for direct access to InfiniBand is not required.
$> mkdir iofsl $> cd iofsl $> git init $> git remote add -t iofsl_vampir \ -f origin git://git.mcs.anl.gov/iofsl.git $> git checkout iofsl_vampir $> ./prepare
The following commands can be used to build the IOFSL client and server:
$> ./configure --with-bmi=<install_dir> \ --with-boost=<install_dir> --with-openpa=<install_dir> \ --prefix=<install_dir> --with-cunit=no $> make all install
$> ./configure \ --prefix=<install_dir> \ --enable-iofsl \ --with-zoidfs-dir=<install_dir> \ --with-bmi-dir=<install_dir> \ # On Cray XK6 with PBS as batch system add --enable-iofsl-scripts=crayxk6 $> make all install
The use of I/O forwarding servers implicates a system specific deployment. VampirTrace mitigates this effort by providing convenient scripts for specific system setups. Currently Cray XK6 systems are supported, which are described here. Furthermore the IOFSL specific adjustable parameters of VampirTrace are described.
We assume that VampirTrace with IOFSL support has been installed as previously described. This might be deployed to the user using a module.
# Check module av vampirtrace to # see what is available at your system $> module load vampirtrace/5.13
Build your application as usual with VampirTrace. For details please refer to the general part of this documentation.
$> vtcc -vt:hyb application.c -o application
The scripts vtiofsl-start and vtiofsl-stop are provided to control the IOFSL server instances. They will be launched on dedicated compute nodes that are part of the batch Job allocation.
Example using 64 server instances:
#!/bin/sh #PBS... [...] ## Allocate enough cores: (64 * 16) + 16384 => 17408 #PBS -l size=17408 ## Preserve environment #PBS -V
It is highly recommended to set the following environment variable.
[...] # The directory to which the trace is written mkdir trace export VT_PFORM_GDIR=$PWD/trace
[...] # rca module need to be loaded! . /opt/modules/default/etc/modules.sh module load rca # Start server source vtiofsl-start -n 64 # Run application as usual aprun -n 16384 application --parameter inputfile # Shutdown server source vtiofsl-stop
Interactive jobs work the same way. You can either run a script similar to the job submission script, or run the commands from your shell. However the scripts are developed and tested on bash. Other shells are not supported.
The vtiofsl-scripts assume to be run within a PBS job. If you run them multiple times within one job, the detailed log files may be overwritten.
The vtiofsl-scripts create a number of log files and configuration files in the $VT_PFORM_GDIR/.iofsl directory.
bmi { serverlist = ( "tcp://<IP_ADDRESS>:12345", "tcp://<IP_ADDRESS>:12345", "tcp://<IP_ADDRESS>:12346" ); }At start-up, the server looks for the environment variable ZOIDFS_SEVER_RANK to determine its address, e.g. ZOIDFS_SEVER_RANK=0 would cause the address tcp://<IP_ADDRESS>:12345 to be used. The configuration file can be shared between all server instances and lets the servers determine the coordination server, which is usually rank 0.
The I/O forwarding server (iofwd) can be deployed in multiple ways. This is highly system specific, possible ways to do so are:
The list of available I/O forwarding servers is provided to VampirTrace by setting VT_IOFSL_SERVERS to a comma-separated list of addresses, e.g.
export VT_IOFSL_SERVERS= \ "tcp://<IP_ADDRESS>:12345,tcp://<IP_ADDRESS>:12345"VampirTrace / OTF will choose a server upon opening the file based on the stream identifier encoded in the original filename.
In the default setting, each server will create two files for each type of file, the actual file containing the appended data and an index file. This mode is called MULTIFILE_SPLIT. It provides a good workload for parallel file systems. In the so called MULTIFILE mode, all servers share data and index files. It requires additional synchronization between the servers. Also the Lustre file system does not allow to stripe individual files over more than a maximum number of storage targets, introducing a performance-bottleneck. The MULTIFILE mode should be considered experimental. Therefore, using the default mode is recommended. The mode can be set using VT_IOFSL_MODE to either MULTIFILE_SPLIT or MULTIFILE.
IOFSL offers a capability, where write requests are buffered on the forwarding server. This can reduce the trace flush times, without consuming node local resources. To enable this, VT_IOFSL_ASYNC_IO is set to yes.
The unification step can also use the IOFSL mode for writing the output trace. This is controlled with the same environment variables. Therefore if VampirTrace uses IOFSL, the implicit unification at the end of the trace run will also use IOFSL for output. If VT_UNIFY=no, then one should make sure that the correct IOFSL environment is also available to the later vtunify(-mpi), unless intended otherwise.
All tools that work on the generated trace need to be built with the appropriate OTF Version to ensure compatibility with traces generated with IOFSL. This especially applies to the Vampir visualization server and GUI. If backwards compatibility is required, the trace can be transformed using otfmerge, e.g.
$> mpirun -np 1024 \ otfmerge-mpi -n 0 -o merged-trace input-trace.otf
There are several limitations which make this generally a bad idea:
If subroutines have been instrumented with automatic instrumentation by GNU, Intel, PathScale, or Open64 compilers, VampirTrace needs to look-up the function names and their source code line before program start. In certain cases, this may take very long. To accelerate this process prepare a file with symbol information using the command nm as explained in Section 2.3 and set VT_GNU_NMFILE to the pathname of this file. This method prevents VampirTrace from getting the function names from the binary.
The IBM C compiler ≥11 and Fortran compiler ≥13 provide -qfunctrace option to enable tracing for all functions. To disable tracing for all functions you can use -qnofunctrace. Regardless of -qnofunctrace both -qfunctrace+ and -qfunctrace- can be used to enable resp. disable tracing for a colon-separated list of function names, classes, or namespaces. For example,
-qfunctrace -qfunctrace-myFunc1:myFunc2
enables tracing for all functions except for myFunc1 and myFunc2.
Also GNU compiler ≥4.3 provides options to limit compiler instrumentation. -finstrument-functions-exclude-file-list sets a list of files. All functions defined in a file of this list will be excluded from instrumentation. The option -finstrument-functions-exclude-function-list sets a list of function names that are excluded from instrumentation. Arguments of both compiler options must be separated by comma. Matching of arguments with function or file names is done on substrings. For example,
-finstrument-functions-exclude-file-list=include
will exclude any function defined in files whose pathnames contain "include".

The pattern needs to be specified more precisely, for instance:
-finstrument-functions-exclude-file-list=/usr/include
This rule can be used to exclude Standard Template Library (STL) calls in C++ from tracing.
VampirTrace does not implement any tracing at the Fortran language level. Therefore it is unaware of any I/O function calls done by Fortran applications.
However, if you enable I/O tracing using VT_IOTRACE, VampirTrace records all calls to LIBC's I/O functions. As Fortran uses the LIBC interface for executing its I/O operations, these function calls will be part of the trace. Depending on your Fortran compiler, a single Fortran file read/write operation may be split into several LIBC read calls which you will then see in your trace.
Beware that this may lead you to the (wrong) conclusion that your application spends time between the LIBC I/O calls inside the user function that contains the Fortran I/O call, especially when doing formatted I/O . It is rather the Fortran I/O subsystem which does all the formatting of the data that is eating your cpu cycles. But as this layer is unknown to VampirTrace, it cannot be shown and the time is accounted to the next higher function in the call stack - the user function.
The absence of an *.otf file usually means that the trace was not unified. This is the case on certain platforms, e.g. when using DYNINST or when the local traces are not available when the application ends and VampirTrace performs trace unification.
In those cases, a *.uctl file can be found in the directory of the trace file and the user needs to perform trace unification manually.
Starting and stopping tracing by using the VT_ON/VT_OFF calls as well as the buffer rewind method are considered advanced usage of VampirTrace and should be performed with care. When restarting the recording of events, the call stack of the application has to have the same depth as when the recording was stopped. The same applies for the rewind call, which has to be at the same stack level as the rewind mark. If this is not the case, an error message will be printed during runtime and VampirTrace will abort execution. A safe method is to call VT_OFF and VT_ON in the same function.
It is allowed to use "on/off" in a section between a rewind mark and a buffer rewind call. But it is not allowed to call VT_SET_REWIND_MARK or VT_REWIND during a section deactivated by the "on/off" functionality.
Buffer flushes interfere with the rewind method: If the trace buffer is flushed after the call to VT_SET_REWIND_MARK, the mark is removed and a subsequent call to VT_REWIND will not work and issue a warning message.
In addition, stopping or rewinding tracing while waiting for MPI messages can cause those MPI messages not to be recorded in the trace. This can cause problems when analyzing the OTF trace afterwards, e.g., with Vampir.
For unique naming of multiple trace files in the same directory, a file *.lock is created and locked for exclusive access if VT_FILE_UNIQUE is set to yes (⇒ Section 3.1). Some file systems do not implement file locking. In this case, VampirTrace still tries to name the trace files uniquely, but this may fail in certain cases. Alternatively, you can manually control the unique file naming by setting VT_FILE_UNIQUE to a different numerical ID for each program run.
VampirTrace hard-codes some directory paths in its executables and libraries based on installation paths specified by the configure script. However, it's possible to move an existing VampirTrace installation to another location and use it without rebuild from source. Therefore it's necessary to set the environment variable VT_PREFIX to the new installation prefix before using VampirTrace's Compiler Wrappers (⇒ Section 2.1) or launching an instrumented application. For example:
./configure --prefix=/opt/vampirtrace make install mv /opt/vampirtrace $HOME/vampirtrace export VT_PREFIX=$HOME/vampirtrace
The byte counts in collective communication records changed with version 5.10.
From 5.10 on, the byte counts of collective communication records show the bytes per rank given to the MPI call or returned by the MPI call. This is the MPI API perspective. It is next to impossible to find out how many bytes are actually sent or received during a collective operation by any other MPI implementation.
In the past (until VampirTrace version 5.9), the byte count in collective operation records was defined differently. It used a simple and naive hypothetical implementation of collectives based on point-to-point messages and derived the byte counts from that. This might have been more confusing than helpful and was therefore changed.
Thanks to Eugene Loh for pointing this out!
It is a known issue with the tau_instrumentor that it doesn't support inline assembler code. At the moment there is no other solution than using another kind of instrumentation like compiler instrumenation (⇒ Section 2.3) or manual instrumenation (⇒ Section 2.4).
You may contact us at mailto:vampirsupport<EMAIL_ADDRESS>for support on installing and using VampirTrace.
Suggestions are always welcome (contact<EMAIL_ADDRESS>but there is a chance that we can not implement all your wishes as our resources are limited.
Anyways, the source code of VampirTrace is open to everybody so you may
implement support for new stuff yourself.
If you provide us with your additions afterwards we will consider merging them
into the official VampirTrace package.


Free Wi-Fi or open computer use available. Make sure you are courteous of other users waiting and spend your time wisely.
What's Your Sign?
Here participants can review the meanings of each of the Mobo Code symbols, find the ones that match the resources available, and learn how to put them to use in their establishments. This is also a guide for people that can use these resources.
Food that would otherwise be thrown out at the end of the day is available. The time that it's available is shown in 24-hour format.
Public restrooms available. Please be mindful of others and respectful of this valuable resource.
Open beds or places to rest available. It’s better than a park bench.
Day-Jobs available. These jobs can be any sort of short-term, unskilled labor for a small compensation to help you make it through another day.
Drinkable water available. None of us can live without it!
Temporary shelter from weather available. These situations can include rain, hail, and snow, but it's the participant’s call to determine what constitutes extreme
weather.
Clothing available. This can include second-hand clothing as well as defective or unsellable items.
Instructions for Using the Code
Download PDF (ver. 1.0)1. Download the PDF to your computer by clicking the button above.
2. Print the PDF onto letter-size (8.5” x 11”) paper. Card stock or self-adhesive paper works best. A black & white or color printer can be used.
3. Trim the symbols out using the crop marks so that the gray border is visible within a white edge.
4. Post the symbols in a window or door so that they are visible to passers-by.
Do you have a suggestion for a new symbol?
Tell us about it and if we use your idea in the next version, you may be eligible for compensation. Privacy Policy


Back
Product
* Brand Name:-
Brand Name is not valid.
* Product Name:-
Product Name is not valid.
HSN Code:-
HSN Code is not valid.
* Rate(Price):-
Rate is not valid.
Quantity :-
Quantity is not valid.
UOM:-
UOM is not valid.
Send
×
Your Data Saved successfully.…


2 writes to PipelinePosition
System.Management.Automation (2)
engine\InvocationInfo.cs (1)
97
PipelinePosition
= (int)SerializationUtilities.GetPropertyValue(psObject, "InvocationInfo_PipelinePosition");
engine\pipeline.cs (1)
1031
myInfo.
PipelinePosition
= i + 1;
9 references to PipelinePosition
System.Management.Automation (9)
engine\CmdletParameterBinderController.cs (1)
2926
invoInfo.
PipelinePosition
);
engine\CommandProcessor.cs (2)
385
this.Command.MyInvocation.PipelineIterationInfo[this.Command.MyInvocation.
PipelinePosition
]++;
522
if (this.Command.MyInvocation.
PipelinePosition
== 1)
engine\CommandProcessorBase.cs (1)
717
if (this.Command.MyInvocation.
PipelinePosition
== 1)
engine\InvocationInfo.cs (1)
429
RemotingEncoder.AddNoteProperty<int>(psObject, "InvocationInfo_PipelinePosition", () => this.
PipelinePosition
);
engine\NativeCommandProcessor.cs (2)
655
if (this.Command.MyInvocation.
PipelinePosition
< this.Command.MyInvocation.PipelineLength)
1458
if (this.Command.MyInvocation.
PipelinePosition
== this.Command.MyInvocation.PipelineLength)
engine\remoting\commands\InvokeCommandCommand.cs (1)
999
if ((MyInvocation != null) && (MyInvocation.
PipelinePosition
== 1) && !MyInvocation.ExpectingInput)
engine\ScriptCommandProcessor.cs (1)
449
this.Command.MyInvocation.PipelineIterationInfo[this.Command.MyInvocation.
PipelinePosition
]++;


Say Thanks to birthday wishes on Facebook
Get access code
- Go to developers.facebook.com.
- Under Tools in the menu, go to Graph explorer.
- Click on Get Access Token. Paste the token here
If you have any queries, comment here: lifepluslinux.blogspot.in
NOTE: We
do not save any of your credentials. Don't believe me? See the
source :P


Hello, my name is Nicholas Malacarne, and I am a developer. My work is primarily web based, and I love learning and using both front-end and back-end technologies. I am currently employed at CraterDust, LLC, and I am loving every minute of it.
I graduated from Gwinnett Tech with an Associate of Applied Science Degree - Computer Programming. The curriculum comprised mainly of Jave/JavaEE, but I was also subjected to other languages such as PHP, Python, JavaScript, and C++. I fell in love with web development at first sight, and I was especially intrigued by technologies that dealt with the communication between client and server such as AJAX.
Since the day I graduated, I have worked in a few professional development environments. My first job was maintaining a legacy PHP web application. I worked mainly with back-end technologies during this time. I learned a lot about PHP, MySQL, and how to work on and maintain a large code base. Towards the end of my stay, the team started dabbling in AngularJS, and was in the process of moving from SVN to Git.
I was later offered a position at CraterDust, LLC which was extremely exciting. I work with a group of talented designers which means that I get to focus not only on back-end technologies, but also a lot of client-side as well. Since I have been here, we have designed and developed Facebook applications, splash pages, and ECommerce migrations and setups. I look forward to growing digitally.
In my spare time, I like to learn new languages, libraries, and technologies. I also enjoy writing scripts for the computer games that I play.
I built this site so that I could document the many programming adventures which I undertake, and I would also like to write about what I learn along the way.