 |
9.4 (revision f07997df4)
|
A call to scorep has the following syntax:
This is the Score-P instrumentation tool. The usage is:
scorep <options> <original command>
Common options are:
--help, -h Show help output. Does not execute any other command.
-v, --verbose[=<value>] Specifies the verbosity level. The following
levels are available:
0 = No output
1 = Executed commands are displayed (default if no
value is specified)
2 = Detailed information is displayed
--dry-run Only displays the executed commands. It does not
execute any command.
--keep-files Do not delete temporarily created files after successful
instrumentation. By default, temporary files are deleted
if no error occurs during instrumentation.
--instrument-filter=<file>
Specifies the filter file for filtering functions during
compile-time. Not supported by all instrumentation methods.
It applies the same syntax, as the one used by Score-P during
run-time.
--version Prints the Score-P version and exits.
--disable-preprocessing
Tells scorep to skip all preprocessing related steps,
the input files are already preprocessed.
--no-as-needed Adds a GNU ld linker flag to fix undefined references
when using shared Score-P libraries. This happens on
systems using --as-needed as linker default. It will
be handled transparently in future releases of Score-P.
--thread=<paradigm>[:<variant>]
Possible paradigms and variants are:
none
No thread support.
omp:opari2
OpenMP support using thread tracking via ancestry functions
in OpenMP 3.0 and later.
It requires and, thus, automatically enables OPARI2
instrumentation.
omp:ompt
OpenMP support using thread tracking via OMPT.
pthread
Pthread support.
It conflicts and, thus, automatically disables OPARI2
instrumentation.
--mpp=<paradigm>[:<variant>]
Possible paradigms and variants are:
none
No multi-process support.
mpi
MPI support using library wrapping
shmem
SHMEM support using library wrapping
--io=<paradigm>[:<variant>](,<paradigm>[:<variant>])*
Deprecated. Instrumentation is always performed but must be
explicity enabled at the time of measurement.
The default is the first supported mode in the above order.
Possible paradigms and variants are:
none
No I/O wrapping support.
posix
POSIX I/O support using library wrapping. This includes the
file descriptor based POSIX API (i.e., `open`/`close`). The
POSIX asynchronous I/O API (i.e., `aio_read`/`aio_write`), if
available. And the ISO C `FILE` handle based API (i.e.,
`fopen`/`fclose`).
--compiler Enables compiler instrumentation.
--nocompiler Disables compiler instrumentation.
--compiler-plugin-arg=<option>
Add additional arguments for compiler plugin.
Available options:
exception-handling=<true|false>
Enables / disables exception handling for instrumentation.
May introduce additional overhead. It is enabled by default.
--cuda Enables CUDA instrumentation. Enabled by default, if the
nvcc compiler is in use. In this case it also conflicts and
thus automatically disables preprocessing.
--nocuda Disables CUDA instrumentation.
--pomp Deprecated, consider using manual region instrumentation (--user)
instead. Enables OPARI2 pomp user instrumentation. By default, it
also enables preprocessing.
--nopomp Deprecated, consider using manual region instrumentation (--user)
instead. Disables OPARI2 pomp user instrumentation (Default).
--openmp Deprecated, please use --thread=omp:opari2 instead.
Enables OPARI2 instrumentation of OpenMP directives. By default,
it also enables preprocessing (Default for compile units
with enabled OpenMP support during the compilation).
Conflicts with --thread=omp:ompt.
--noopenmp Deprecated, please use --thread=none instead.
Disables OPARI2 instrumentation of OpenMP directives.
Note: To ensure thread-safe execution of the measurement,
parallel regions still need to be tracked and will appear
in the results (Default for compile units without OpenMP
enabled compilation).
--opari=<parameter-list>
Pass options to the source-to-source instrumenter OPARI2
to have finer control over the instrumentation process.
Please refer to the OPARI2 user documentation for more
details.
--preprocess Enables preprocess instrumentation.
It cannot be enabled, if not at least one of the following is
enabled: OPARI2 instrumentation.
--nopreprocess Disables preprocess instrumentation.
--user Enables user instrumentation.
--nouser Disables user instrumentation.
--opencl[:<wrap-mode>]
Enables OpenCL instrumentation.
--noopencl Disables OpenCL instrumentation.
--openacc Enables OpenACC instrumentation.
--noopenacc Disables OpenACC instrumentation.
--memory Deprecated. Instrumentation is always performed but must be
explicity enabled at the time of measurement.
Enables memory usage instrumentation. It is enabled by default.
--nomemory Disables memory usage instrumentation.
--kokkos Enables Kokkos instrumentation.
--nokokkos Disables Kokkos instrumentation.
--hip Enables HIP instrumentation. Enabled by default, if the
hipcc compiler is in use. In this case it also disables by
default the compiler instrumentation and conflicts with the
preprocessing.
--nohip Disables HIP instrumentation.
Report bugs to <support@score-p.org>
A call to scorep-config has the following syntax:
Usage:
scorep-config <command> [<options>]
Commands:
--prefix Prints the canonical installation prefix of this Score-P
installation.
--cflags Prints additional compiler flags for a C compiler.
They already contain the include flags.
--cxxflags Prints additional compiler flags for a C++ compiler.
They already contain the include flags.
--fflags Prints additional compiler flags for a Fortran compiler.
They already contain the include flags.
--cppflags[=language]
Prints the include flags. They are already contained in the
output of the --cflags, --cxxflags, and --fflags commands.
language may be one of c (default), c++, or fortran.
--ldflags Prints the library path flags for the linker.
--libs Prints the required libraries to link against
(combines --event-libs and --mgmt-libs).
--event-libs
Prints only the required libraries to link against which
includes event entry points into the measurement.
--mgmt-libs
Prints only the required libraries to link against which
includes management code from the Score-P measurement and
their dependencies.
--preload-libs
Prints only the required libraries which should be listed in
LD_PRELOAD.
--cc Prints the C compiler name.
--cxx Prints the C++ compiler name.
--fc Prints the Fortran compiler name.
--mpicc Prints the MPI C compiler name.
--mpicxx Prints the MPI C++ compiler name.
--mpifc Prints the MPI Fortran compiler name.
--shmemcc Prints the SHMEM C compiler name.
--shmemcxx Prints the SHMEM C++ compiler name.
--shmemfc Prints the SHMEM Fortran compiler name.
--libtool Prints the path to the libtool script used to build Score-P
libraries.
--mpilibtool
Prints the path to the libtool script used to build Score-P
MPI libraries.
--shmemlibtool
Prints the path to the libtool script used to build Score-P
SHMEM libraries.
--help Prints this usage information.
--version Prints the version number of the Score-P package.
--scorep-revision
Prints the revision number of the Score-P package.
--common-revision
Prints the revision number of the common package.
--remap-specfile
Prints the path to the remapper specification file.
--adapter-init
Prints the code for adapter initialization.
--libwrap-support
Prints true if library wrapping is supported.
Options:
--target Get flags for specified target, e.g., mic.
--nvcc Convert flags to be suitable for the nvcc compiler.
--compiler|--nocompiler
Specifies whether compiler instrumentation is used.
On default compiler instrumentation is enabled.
--user|--nouser
Specifies whether user instrumentation is used.
On default user instrumentation is disabled.
--pomp|--nopomp
Deprecated, consider using manual region
instrumentation (--user) instead.
Specifies whether pomp instrumentation is used.
On default pomp instrumentation is disabled.
--cuda|--nocuda
Specifies whether cuda instrumentation is used.
On default cuda instrumentation is enabled.
--openacc|--noopenacc
Specifies whether openacc instrumentation is used.
On default openacc instrumentation is enabled.
--hip|--nohip
Specifies whether hip instrumentation is used.
On default hip instrumentation is enabled.
--opencl|--noopencl
Specifies whether opencl instrumentation is used.
On default opencl instrumentation is enabled.
--kokkos|--nokokkos
Specifies whether kokkos instrumentation is used.
On default kokkos instrumentation is enabled.
--preprocess|--nopreprocess
Specifies whether preprocess instrumentation is used.
On default preprocess instrumentation is disabled.
--memory|--nomemory
Deprecated. Instrumentation is always performed but must be
explicity enabled at the time of measurement. Specifies whether
memory usage instrumentation is used.
On default memory usage instrumentation is enabled.
The following memory interfaces may be recorded, if present:
ISO C:
malloc,realloc,calloc,free,memalign,posix_memalign,valloc,
aligned_alloc
ISO C++:
new,new[],delete,delete[]
Intel KNL MCDRAM API:
hbw_malloc,hbw_realloc,hbw_calloc,hbw_free,hbw_posix_memalign,
hbw_posix_memalign_psize;
--io=<paradigm,...>|--noio
Deprecated. Instrumentation is always performed but must be
explicity enabled at the time of measurement. Specifies whether
I/O instrumentation is used.
On default I/O instrumentation is enabled.
The following I/O paradigms may be recorded, if present:
none
posix (default)
--thread=<threading system>
Available threading systems are:
none (default)
omp
pthread
--mpp=<multi-process paradigm>
Available multi-process paradigms are:
none (default)
mpi
shmem
Report bugs to <support@score-p.org>
A call to scorep-info has the following syntax:
Usage: scorep-info <info command> <command options>
scorep-info --help [<info command>]
This is the Score-P info tool.
Available info commands:
config-summary:
Shows the configure summary of the Score-P package.
config-vars:
Shows the list of all measurement config variables with a short description.
Info command options:
--help Displays a description of the Score-P measurement
configuration system.
--full Displays a detailed description for each config variable.
--values Displays the current values for each config variable.
Warning: These values may be wrong, please consult the
manual of the batch system how to pass the values
to the measurement job.
ldaudit:
Shows the LD_AUDIT value needed to extend address lookup to dynamically
loaded shared objects.
libwrap-summary:
Shows known library wrappers available to this Score-P installation.
Info command options:
--build Shows detailed information about how the library wrapper
was built.
license:
Shows the license of the Score-P package.
open-issues:
Shows open and known issues of the Score-P package.
Report bugs to <support@score-p.org>
A call to scorep-score has the following syntax:
Usage: scorep-score [options] <profile>
Options:
-r Show all regions.
-h, --help Show this help and exit.
-f <filter> Shows the result with the filter applied.
-c <num> Specifies the number of hardware counters that shall be measured.
By default, this value is 0, which means that only a timestamp
is measured on each event. If you plan to record hardware counters
specify the number of hardware counters. Otherwise, scorep-score
may underestimate the required space.
-m Prints mangled region names instead of demangled names.
-s <choice> Sorting of entries. Possible choices are totaltime, timepervisit,
maxbuffer, visits and name (default=maxbuffer).
-g [<list>] Generation of an initial filter file with the name
'initial_scorep.filter'. A valid parameter list has the form
KEY=VALUE[,KEY=VALUE]*. By default, uses the following control
parameters:
`bufferpercent=1,timepervisit=1`
A region is included in the filter file (i.e., excluded from
measurement) if it matches all of the given conditions, with the
following keys:
- `bufferpercent` : estimated memory requirements exceed the
given threshold in percent of the total
estimated trace buffer requirements
- `bufferabsolute` : estimated memory requirements exceed
the given absolute threshold in MB
- `visits` : number of visits exceeds the given
threshold
- `timepervisit` : time per visit value is below the given
threshold in microseconds
- `type` : region type matches the given value
(allowed: 'usr', 'com', 'both')
The generation parameter `all` will create a filter file with
the name 'max_scorep.filter', that contains all filterable
regions. This maximal filter file serves as starting point for a
manual approach without using any heuristics.
A call to scorep-backend-info has the following syntax:
Usage: scorep-backend-info <info command> <command options>
scorep-backend-info --help
This is the Score-P backend info tool.
Available info commands:
system-tree:
Shows the available system tree levels, starting with the root.
config-vars:
Shows the current values of all measurement config variables.