5.0-beta (revision 14401)
|
Score-P allows to configure several measurement parameters via environment variables. After the measurement run you can find a 'scorep.cfg' file in your experiment directory which contains the configuration of the measurement run. If you did not set any configuration values explicitly, this file will contain the default values. This file is safe to be used as input for a POSIX shell. For example, if you want to reuse the same configuration from a previous measurement run, do something like this:
$ set -a $ . scorep.cfg $ set +a
Measurement configuration variables have a specific type which accepts certain values.
An arbitrary character sequence, no white space trimming is done.
Like String but a path is expected. Though no validation is performed.
A Boolean value, no white space trimming is done. Accepted Boolean values for true are case insensitive and the following:
Everything else is interpreted as the Boolean value false.
A decimal number, white space trimming is done.
Like Number, but also accepts unit case insensitive suffixes after optional white space:
The 'b' suffix can be omitted.
A symbolic set. Accepted members are listed in the documentation of the variable. Multiple values are allowed, are case insensitive, and are subject to white space trimming. They can be separated with one of the following characters:
Acceptable values can also have aliases, which are listed in the documentation and separated by '/'. Values can be negated by preceeding it with '~'. Order of evaluation is from left to right.
Like Set, but only one value allowed to be selected.
This is the list of all known configure variables to control a Score-P measurement.
scorep-info config-vars
command to list only those supported by the used installation.SCOREP_ENABLE_PROFILING
Enable profiling
SCOREP_ENABLE_TRACING
Enable tracing
SCOREP_ENABLE_UNWINDING
Enables recording calling context information for every event
The calling context is the call chain of functions to the current position in the running program. This call chain will also be annotated with source code information if possible.
This is a prerequisite for sampling but also works with instrumented applications.
Note that when tracing is also enabled, Score-P does not write the usual Enter/Leave records into the OTF2 trace, but new records.
See also SCOREP_TRACING_CONVERT_CALLING_CONTEXT_EVENTS.
Note also that this supresses events from the compiler instrumentation.
SCOREP_VERBOSE
Be verbose
SCOREP_TOTAL_MEMORY
Total memory in bytes per process to be consumed by the measurement system
SCOREP_TOTAL_MEMORY will be split into pages of size SCOREP_PAGE_SIZE (potentially reduced to a multiple of SCOREP_PAGE_SIZE). Maximum size is 4 GBminus one SCOREP_PAGE_SIZE.
SCOREP_PAGE_SIZE
Memory page size in bytes
If not a power of two, SCOREP_PAGE_SIZE will be increased to the next larger power of two. SCOREP_TOTAL_MEMORY will be split up into pages of (the adjusted) SCOREP_PAGE_SIZE. Minimum size is 512 bytes.
SCOREP_EXPERIMENT_DIRECTORY
Name of the experiment directory as child of the current working directory
The experiment directory is created directly under the current working directory. No parent directories will be created. The experiment directory is only created if it is requested by at least one substrate. When no experiment name is given (the default) Score-P names the experiment directory `scorep-measurement-tmp' and renames this after a successful measurement to a generated name based on the current time.
SCOREP_OVERWRITE_EXPERIMENT_DIRECTORY
Overwrite an existing experiment directory
If you specified a specific experiment directory name, but this name is already given, you can force overwriting it with this flag. The previous experiment directory will be renamed.
SCOREP_MACHINE_NAME
The machine name used in profile and trace output
We suggest using a unique name, e.g., the fully qualified domain name. The default machine name was set at configure time (see the INSTALL file for customization options).
SCOREP_EXECUTABLE
Executable of the application
File name, preferably with full path, of the application's executable. This is a fallback if Score-P cannot determine the exetuable's name automatically. The name is required by some compiler adapters. They will complain if this environment variable is needed.
SCOREP_ENABLE_SYSTEM_TREE_SEQUENCE_DEFINITIONS
Use system tree sequence definitions
Enables an internal system tree representation that specifies a sequence of system tree nodes with one record instead of creating one record per system tree node, location group or location. It is more scalable and has less memory requirements than single-node records. However, it costs inidividual names of nodes, but simply enumerates them based on types. Currently, system tree sequence definitions support only MPI (and trivially single-process) applications.
SCOREP_FORCE_CFG_FILES
Force the creation of experiment directory and configuration files
If this is set to 'true' (which is the default), the experiment directory will be created along with some configuration files, even if no substrate writes data (i.e., profiling and tracing are disabled and no substrate plugin registered for writing).
If this is set to 'false', the directory will only be created if any substrate actually writes data.
SCOREP_TIMER
Timer used during measurement
The following timers are available for this installation:
Low overhead time stamp counter (X86_64) timer.
gettimeofday timer.
clock_gettime timer with CLOCK_MONOTONIC_RAW as clock.
SCOREP_NM_SYMBOLS
Application's symbol table obtained via 'nm -l' for compiler instrumentation
File name, preferably with full path, of <file> that contains the <application>'s symbol table that was obtained by the command:
$ nm -l <application> 2> /dev/null > <file>
Only needed if generating the file at measurement initialization time fails, e.g., if using the 'system()' command from the compute nodes isn't possible.
SCOREP_DEBUG_UNIFY
Writes the pre-unified definitions also in the local definition trace files
SCOREP_PROFILING_TASK_EXCHANGE_NUM
Number of foreign task objects that are collected before they are put into the common task object exchange buffer
The profiling creates a record for every task instance that is running. To avoid locking, the required memory is taken from a preallocated memory block. Each thread has its own memory block. On task completion, the created object can be reused by other tasks. However, if tasks migrate, the data structure migrates with them. Thus, if there is an imbalance in the migration from a source thread that starts the execution of tasks towards a sink thread that completes the tasks, the source thread may continually creating new task objects while in the sink, released task objects are collected. Thus, if the sink collected a certain number of tasks it should trigger a backflow of its collected task objects. However, this requires locking which should be avoided as much as possible. Thus, we do not want the locking to happen on every migrated task, but only if a certain imbalance occurs. This environment variable determines the number of migrated task instances that must be collected before the backflow is triggered.
SCOREP_PROFILING_MAX_CALLPATH_DEPTH
Maximum depth of the calltree
SCOREP_PROFILING_BASE_NAME
Base for construction of the profile filename
String which is used as based to create the filenames for the profile files.
SCOREP_PROFILING_FORMAT
Profile output format
Sets the output format for the profile.
The following formats are supported:
No profile output. This does not disable profile recording.
Tau snapshot format.
Stores the sum for every metric per callpath per location in Cube4 format.
Stores an extended set of statistics in Cube4 format.
Sums all locations within a location group and stores the data in Cube4 format.
Sums all locations within a location group and store in addition some statistical data about the distribution among the location of a location group.
Stores the initial location, the slowest location and the fastest location per process. Sums all other locations within a location group. The result is stored in Cube4 format.
Clusters locations within a location group if they have the same calltree structure. Sums locations within a cluster. Stores the result in Cube4 format.
Default format. If Cube4 is supported, Cube4 is the default else the Tau snapshot format is default.
SCOREP_PROFILING_ENABLE_CLUSTERING
Enable clustering
SCOREP_PROFILING_CLUSTER_COUNT
Maximum cluster count for iteration clustering
SCOREP_PROFILING_CLUSTERING_MODE
Specifies the level of strictness when comparing call trees for equivalence
Possible levels:
No structural similarity required.
The sub-trees structure must match.
The sub-trees structure and the number of visits must match.
The structure of the call-path to MPI calls must match.
Nodes that are not on an MPI call-path may differ.
Like above, but the number of visits of the MPI calls must match, too.
Like above, but the number of visits must match also match on all nodes on the call-path to an MPI function.
SCOREP_PROFILING_CLUSTERED_REGION
Name of the clustered region
The clustering can only cluster one dynamic region. If more than one dynamic region are defined by the user, the region is clustered which is exited first. If another region should be clustered instead you can specify the region name in this variable. If the variable is unset or empty, the first exited dynamic region is clustered.
SCOREP_PROFILING_ENABLE_CORE_FILES
Write .core files if an error occurred
If an error occurs inside the profiling system, the profiling is disabled. For debugging reasons, it might be feasible to get the state of the local stack at these points. It is not recommended to enable this feature for large scale measurements.
SCOREP_TRACING_USE_SION
Whether or not to use libsion as OTF2 substrate
SCOREP_TRACING_MAX_PROCS_PER_SION_FILE
Maximum number of processes that share one sion file (must be > 0)
All processes are than evenly distributed over the number of needed files to fulfill this constraint. E.g., having 4 processes and setting the maximum to 3 would result in 2 files each holding 2 processes.
SCOREP_TRACING_CONVERT_CALLING_CONTEXT_EVENTS
Write calling context information as a sequence of Enter/Leave events to trace
When recording the calling context of events (instrumented or sampled) than these could be stored in the trace either as the new CallingContext records from OTF2 or they could be converted to the legacy Enter/Leave records. This can be controlled with this variable, where the former is the false value.
This is only in effect if SCOREP_ENABLING_UNWINDING is on.
Note that enabling this will result in an increase of records per event and also of the loss of the source code locations.
This option exists only for backwards compatibility for tools, which cannot handle the new OTF2 records. This option my thus be removed in future releases.
SCOREP_ONLINEACCESS_ENABLE
Enable online access interface
SCOREP_ONLINEACCESS_REG_PORT
Online access registry service port
SCOREP_ONLINEACCESS_REG_HOST
Online access registry service hostname
SCOREP_ONLINEACCESS_BASE_PORT
Base port for online access server
SCOREP_ONLINEACCESS_APPL_NAME
Application name to be registered
SCOREP_FILTERING_FILE
A file name which contain the filter rules
SCOREP_SUBSTRATE_PLUGINS
Specify list of used plugins
List of requested substrate plugin names that will be used during program run.
SCOREP_SUBSTRATE_PLUGINS_SEP
Separator of substrate plugin names
Character that separates plugin names in SCOREP_SUBSTRATE_PLUGINS.
SCOREP_METRIC_PAPI
PAPI metric names to measure
List of requested PAPI metric names that will be collected during program run.
SCOREP_METRIC_PAPI_PER_PROCESS
PAPI metric names to measure per-process
List of requested PAPI metric names that will be recorded only by first thread of a process.
SCOREP_METRIC_PAPI_SEP
Separator of PAPI metric names
Character that separates metric names in SCOREP_METRIC_PAPI and SCOREP_METRIC_PAPI_PER_PROCESS.
SCOREP_METRIC_RUSAGE
Resource usage metric names to measure
List of requested resource usage metric names that will be collected during program run.
SCOREP_METRIC_RUSAGE_PER_PROCESS
Resource usage metric names to measure per-process
List of requested resource usage metric names that will be recorded only by first thread of a process.
SCOREP_METRIC_RUSAGE_SEP
Separator of resource usage metric names
Character that separates metric names in SCOREP_METRIC_RUSAGE and SCOREP_METRIC_RUSAGE_PER_PROCESS.
SCOREP_METRIC_PLUGINS
Specify list of used plugins
List of requested metric plugin names that will be used during program run.
SCOREP_METRIC_PLUGINS_SEP
Separator of plugin names
Character that separates plugin names in SCOREP_METRIC_PLUGINS.
SCOREP_METRIC_PERF
PERF metric names to measure
List of requested PERF metric names that will be collected during program run.
SCOREP_METRIC_PERF_PER_PROCESS
PERF metric names to measure per-process
List of requested PERF metric names that will be recorded only by first thread of a process.
SCOREP_METRIC_PERF_SEP
Separator of PERF metric names
Character that separates metric names in SCOREP_METRIC_PERF and SCOREP_METRIC_PERF_PER_PROCESS.
SCOREP_SAMPLING_EVENTS
Set the sampling event and period: <event>[<period>]
This selects the interrupt source for sampling.
This is only in effect if SCOREP_ENABLE_UNWINDING is on.
Possible values:
- perf event (perf_<event>, see "perf list")
period in number of events, default: 10000000
e.g., perf_cycles@2000000
- PAPI event (PAPI_<event>, see "papi_avail")
period in number of events, default: 10000000
e.g., PAPI_TOT_CYC@2000000
- timer (POSIX timer, invalid for multi-threaded)
period in us, default: 10000
e.g., timer@2000
SCOREP_SAMPLING_SEP
Separator of sampling event names
Character that separates sampling event names in SCOREP_SAMPLING_EVENTS
SCOREP_TOPOLOGY_PLATFORM
Record hardware topology information for this platform, if available.
SCOREP_TOPOLOGY_PROCESS
Record the Process x Thread topology.
SCOREP_TOPOLOGY_USER
Record topologies provided by user instrumentation
SCOREP_TOPOLOGY_MPI
Record MPI cartesian topologies.
SCOREP_SELECTIVE_CONFIG_FILE
A file name which configures selective recording
SCOREP_MPI_MAX_COMMUNICATORS
Determines the number of concurrently used communicators per process
SCOREP_MPI_MAX_WINDOWS
Determines the number of concurrently used windows for MPI one-sided communication per process
SCOREP_MPI_MAX_ACCESS_EPOCHS
Maximum amount of concurrently active access or exposure epochs per process
SCOREP_MPI_MAX_GROUPS
Maximum number of concurrently used MPI groups per process
SCOREP_MPI_ENABLE_GROUPS
The names of the function groups which are measured
Other functions are not measured.
Possible groups are:
All MPI functions
Communicator and group management
Collective functions
Default configuration.
Includes:
- cg
- coll
- env
- io
- p2p
- rma
- topo
- xnonblock
Environmental management
MPI Error handling
External interface functions
MPI file I/O
Peer-to-peer communication
Miscellaneous
PControl
One sided communication
Process management
Topology
MPI datatype functions
Extended non-blocking events
Test events for uncompleted requests
SCOREP_MPI_MEMORY_RECORDING
Enable tracking of memory allocations done by calls to MPI_ALLOC_MEM and MPI_FREE_MEM
Requires that the MISC group is also recorded.
SCOREP_MPI_ONLINE_ANALYSIS
Enable online mpi wait states analysis
SCOREP_SHMEM_MEMORY_RECORDING
Enable tracking of memory allocations done by calls to the SHMEM allocation API
SCOREP_CUDA_ENABLE
CUDA measurement features
Sets the CUDA measurement mode to capture:
CUDA runtime API
CUDA driver API
CUDA kernels
Serialized kernel recording
Fixed CUDA kernel metrics
CUDA memory copies
Record implicit and explicit CUDA synchronization
GPU compute idle time
GPU idle time (memory copies are not idle)
Record CUDA memory (de)allocations as a counter
Record references between CUDA activities
Flush CUDA activity buffer at program exit
CUDA runtime API and GPU activities.
Includes:
- runtime
- kernel
- memcpy
SCOREP_CUDA_BUFFER
Total memory in bytes for the CUDA record buffer
SCOREP_CUDA_BUFFER_CHUNK
Chunk size in bytes for the CUDA record buffer (ignored for CUDA 5.5 and earlier)
SCOREP_OPENCL_ENABLE
OpenCL measurement features
Sets the OpenCL measurement mode to capture:
OpenCL runtime API
OpenCL kernels
OpenCL buffer reads/writes
OpenCL API and GPU activities.
Includes:
- api
- kernel
- memcpy
SCOREP_OPENCL_BUFFER_QUEUE
Memory in bytes for the OpenCL command queue buffer
SCOREP_OPENACC_ENABLE
OpenACC measurement features
Sets the OpenACC measurement mode to capture:
OpenACC regions
OpenACC wait operations
OpenACC enqueue operations (kernel, upload, download)
OpenACC device memory allocations
Record kernel properties such as the kernel name as well as the gang, worker and vector size for kernel launch operations
Record variable names for OpenACC data allocation and enqueue upload/download
OpenACC regions, enqueue and wait operations.
Includes:
- regions
- wait
- enqueue
SCOREP_MEMORY_RECORDING
Memory recording
Memory (de)allocations are recorded via the libc/C++ API.