tau system configure¶
Build TAU configurations in system-level storage.
Usage¶
usage: tau system configure [arguments]
Build TAU configurations in system-level storage.
Options:
--backend <backend> Database backend in which to store this project's data.
- <backend>: tinydb, sqlite, auto
--tau-config (minimal|full|<path>)
TAU configurations to build, or a TAU installation to use instead.
-h, --help Show this help message and exit.
Application Arguments:
--caf [T/F] Application uses Coarray Fortran.
--linkage <linkage> Application linkage.
- <linkage>: static, dynamic
--mpc [T/F] Application uses MPC.
--pthreads [T/F] Application uses pthreads.
--python [T/F] Application uses Python.
--tbb [T/F] Application uses Thread Building Blocks (TBB).
CAF Arguments:
--caf-fc <command> Coarray Fortran compiler command.
CUDA Arguments:
--cuda-compilers <family> Select all CUDA compilers automatically from the given family, ignored
if at least one CUDA compiler is specified.
- <family>: IBM, NVHPC, NVIDIA, None
--cuda-cxx <command> CUDA compiler command.
--cuda-fc <command> CUDA Fortran compiler command.
--cuda-toolkit <path> Path to NVIDIA CUDA Toolkit (enables OpenCL support).
Data Arguments:
--callpath [depth] Maximum depth for callpath recording.
--metrics <metric> [<metric> ...]
A space or comma separated list of performance metrics to gather, e.g.
TIME PAPI_FP_INS.
--system-load [T/F] Measure system load.
--unwind-depth [depth] Record callstack to specified depth.
Host Arguments:
--arch <arch> Host architecture.
- <arch>: x86_64, ppc64le, aarch64
--cc <command> Host C compiler command.
--compilers <family> Select all host compilers automatically from the given family, ignored
if at least one host compiler is specified.
- <family>: Apple, Arm, Cray, GNU, IBM, Intel, NVHPC, PGI, System
--cxx <command> Host C++ compiler command.
--fc <command> Host Fortran compiler command.
--os <os> Host operating system.
- <os>: Darwin, Linux, CNL
Instrumentation Arguments:
--baseline [T/F] Completely disable all instrumentation and measure wall clock time via
the OS.
--compiler-inst [mode] Use compiler-generated callbacks to gather performance data.
- mode: always, fallback, never
--keep-inst-files [T/F] Don't remove instrumented files after compilation.
--reuse-inst-files [T/F] Reuse and preserve instrumented files after compilation.
--sample [T/F] Use event-based sampling to gather performance data.
--source-inst [mode] Use hooks inserted into the application source code to gather
performance data.
- mode: automatic, manual, never
Measurement Arguments:
--callsite [T/F] Record event callsites.
--comm-matrix [T/F] Record the point-to-point communication matrix.
--cuda [T/F] Measure cuda events via the CUPTI interface.
--io [T/F] Measure time spent in POSIX I/O calls.
--level_zero [T/F] Level zero .
--metadata-merge [T/F] Merge metadata of TAU profiles.
--mpi [T/F] Use MPI library wrapper to measure time spent in MPI methods.
--mpit [T/F] MPI-T profiling interface.
--openacc [T/F] Use OpeACC library wrapper to measure time spent in OpenACC methods.
--opencl [T/F] Measure OpenCL events.
--openmp [library] Use specified library to measure time spent in OpenMP directives.
- library: ignore, opari, ompt
--ptts [T/F] Enable support for PTTS.
--ptts-post [T/F] Skip application sampling and post-process existing PTTS sample files.
--ptts-report-flags PTTS_REPORT_FLAGS
Flags to pass to PTTS report_ts command.
--ptts-restart [T/F] Enable restart support within PTTS, allowing application to
continuerunning and be reinstrumented after stop.
--ptts-sample-flags sample_flags
Flags to pass to PTTS sample_ts command.
--ptts-start PTTS_START Address at which to start a PTTS sampling region.
--ptts-stop PTTS_STOP Address at which to stop a PTTS sampling region.
--sample-resolution [file/function/line]
Sample resolution.
- file/function/line: file, function, line
--sampling-period [us] Default sampling period in microseconds.
--select-file path Specify selective instrumentation file.
--shmem [T/F] Use SHMEM library wrapper to measure time spent in SHMEM methods.
--throttle [T/F] Throttle lightweight events to reduce overhead.
--throttle-num-calls [count]
Lightweight event call count threshold.
--throttle-per-call [us] Lightweight event duration threshold in microseconds.
--update-nightly [T/F] Download newest TAU nightly.
Memory Arguments:
--heap-usage [T/F] Measure heap memory usage.
--memory-alloc [T/F] Record memory allocation/deallocation events and detect leaks.
--track-memory-footprint [T/F]
Track memory footprint.
Message Passing Interface (MPI) Arguments:
--mpi-cc <command> MPI C compiler command.
--mpi-cxx <command> MPI C++ compiler command.
--mpi-fc <command> MPI Fortran compiler command.
--mpi-libraries <flag> [<flag> ...]
Libraries to link to when building MPI applications.
--mpi-wrappers <family> Select all MPI compilers automatically from the given family, ignored
if at least one MPI compiler is specified.
- <family>: Cray, IBM, Intel, NVHPC, None, System
Output Format Arguments:
--profile [<format>] Generate application profiles.
- <format>: tau, merged, cubex, sqlite, none
--trace [<format>] Generate application traces.
- <format>: slog2, otf2, none
Python Arguments:
--python-interpreter <command>
Python Interpreter command.
Software Package Arguments:
--binutils (<path>|<url>|download|None)
Path or URL to a GNU binutils installation or archive file.
--gotcha (<path>|<url>|download|None)
GOTCHA installation for Score-P use.
--level_zero_source (<path>|None)
Path to Intel Level Zero.
--libdwarf (<path>|<url>|download|None)
Path or URL to a libdwarf installation or archive file.
--libelf (<path>|<url>|download|None)
Libelf installation for libdwarf use.
--libunwind (<path>|<url>|download|None)
Path or URL to a libunwind installation or archive file.
--ompt (<path>|<url>|download|None)
Path or URL to OMPT installation or archive file.
--otf (<path>|<url>|download|None)
Path or URL to libotf2 installation or archive file.
--papi (<path>|<url>|download|None)
Path or URL to a PAPI installation or archive file.
--pdt (<path>|<url>|download|None)
Path or URL to a PDT installation or archive file.
--scorep (<path>|<url>|download|None)
Path or URL to a Score-P installation or archive file.
--sqlite3 (<path>|<url>|download|None)
Path or URL to SQLite3 installation or archive file.
--tau (<path>|<url>|download|nightly)
Path or URL to a TAU installation or archive file.
--unwinder (libunwind|backtrace|None)
Name of unwinder to be used.
Symmetric Hierarchical Memory (SHMEM) Arguments:
--shmem-cc <command> SHMEM C compiler command.
--shmem-compilers <family> Select all SHMEM compilers automatically from the given family,
ignored if at least one SHMEM compiler is specified.
- <family>: Cray, OpenSHMEM, SOS
--shmem-cxx <command> SHMEM C++ compiler command.
--shmem-fc <command> SHMEM Fortran compiler command.
--shmem-libraries <flag> [<flag> ...]
Libraries to link to when building SHMEM applications.
Universal Parallel C Arguments:
--upc <command> Universal Parallel C compiler command.