OTF2 Tools

Usage of OTF2 tools

OTF2 config tool

A call to otf2-config has the following syntax:

Usage: otf2-config [OPTION]... COMMAND

Commands:
  --cflags     prints additional compiler flags. They already contain
               the include flags
  --cppflags   prints the include flags for the OTF2 headers
  --libs       prints the required libraries for linking
  --ldflags    prints the required linker flags
  --cc         prints the C compiler name
  --help       prints this usage information

  --version    prints the version number of the OTF2 package and
  --otf2-revision
               prints the revision number of the OTF2 package
  --common-revision
               prints the revision number of the common package
  --interface-version
               prints the interface version number

Options:
  --backend
               on systems, which required cross-compiling, this flag
               specifies that the information for the backend is displayed.
               By default the information for the frontend is displayed.
               On non-cross compiling systems, this flag is ignored
  --cuda       specifies that the required flags are for the CUDA compiler

OTF2 print tool

A call to oft2-print has the following syntax:

Usage: otf2-print [OPTION]... [--] ANCHORFILE
Print selected content of the OTF2 archive specified by ANCHORFILE.

Options:
  -A, --show-all          print all output including definitions and anchor
                          file
  -G, --show-global-defs  print all global definitions
  -I, --show-info         print information from the anchor file
  -T, --show-thumbnails   print the headers from all thumbnails
  -M, --show-mappings     print mappings to global definitions
  -C, --show-clock-offsets
                          print clock offsets to global timer
  -L, --location <LID>    limit output to location <LID>
  -s, --step <N>          step through output by steps of <N> events
      --time <MIN> <MAX>  limit output to events within time interval
      --system-tree       output system tree to dot-file
      --silent            only validate trace and do not print any events
  -d, --debug             turn on debug mode
  -V, --version           print version information
  -h, --help              print this help information

OTF2 snapshots tool

A call to oft2-snapshots has the following syntax:

Usage: otf2-snapshots [OPTION]... ANCHORFILE
Append snapshots to existing otf2 traces at given 'break' timestamps.

Options:
  -n, --number <BREAKS> Number of breaks (distributed regularly)
                        if -p and -t are not set, the default for -n is 10
                        breaks.
  -p <TICK_RATE>        Create break every <TICK_RATE> ticks
                        if both, -n and -p are specified the one producing
                        more breaks wins.
      --progress        Brief mode, print progress information.
      --verbose         Verbose mode, print break timestamps, i.e. snapshot
                        informations to stdout.
  -V, --version         Print version information.
  -h, --help            Print this help information.

OTF2 marker tool

A call to oft2-marker has the following syntax:

Usage: otf2-marker [OPTION] [ARGUMENTS]... ANCHORFILE
Read or edit a marker file.

Options:
                      Print all markers sorted by group.
      --def <GROUP> [<CATEGORY>]
                      Print all marker definitions of group <GROUP> or of
                      category <CATEGORY> from group <GROUP>.
      --defs-only     Print only marker definitions.
      --add-def <GROUP> <CATEGORY> <SEVERITY>
                      Add a new marker definition.
      --add <GROUP> <CATEGORY> <TIME> <SCOPE> <TEXT>
                      Add a marker to an existing definition.
      --remove-def <GROUP> [<CATEGORY>]
                      Remove all marker classes of group <GROUP> or only the
                      category <CATEGORY> of group <GROUP>; and all according
                      markers.
      --clear-def <GROUP> [<CATEGORY>]
                      Remove all markers of group <GROUP> or only of category
                      <CATEGORY> of group <GROUP>.
      --reset         Reset all marker.
  -V, --version       Print version information.
  -h, --help          Print this help information.

Argument descriptions:
  <GROUP>, <CATEGORY>, <TEXT>
                      Arbitrary strings.
  <SEVERITY>          One of:
                       * NONE
                       * LOW
                       * MEDIUM
                       * HIGH
  <TIME>              One of the following formats:
                       * <TIMESTAMP>
                         A valid timestamp inside the trace range
                         'global offset' and 'global offset' + 'trace
                         length'.
                       * <TIMESTAMP>+<DURATION>
                         <TIMESTAMP> and <TIMESTAMP> + <DURATION> must be valid
                         timestamps inside the trace range 'global
                         offset' and 'global offset' + 'trace length'.
                       * <TIMESTAMP-START>-<TIMESTAMP-END>
                         Two valid timestamps inside the trace range 'global
                         offset' and 'global offset' + 'trace length', with
                         <TIMESTAMP-START> <= <TIMESTAMP-END>.
                      See the CLOCK_PROPERTIES definition with the help
                      of the 'otf2-print -G' tool.
  <SCOPE>[:<SCOPE-REF>]
                       The <SCOPE> must be one of:
                       * GLOBAL
                       * LOCATION:<LOCATION-REF>
                       * LOCATION_GROUP:<LOCATION-GROUP-REF>
                       * SYSTEM_TREE_NODE:<SYSTEM-TREE-NODE-REF>
                       * GROUP:<GROUP-REF>
                       * COMM:<COMMUNICATOR-REF>
                      <SCOPE-REF> must be a valid definition reference of
                      the specified scope. Use 'otf2-print -G' for a list of
                      defined references.
                      There is no <SCOPE-REF> for <SCOPE> 'GLOBAL'.
                      For a scope 'GROUP' the type of the referenced
                      group must be 'OTF2_GROUP_TYPE_LOCATIONS' or
                      'OTF2_GROUP_TYPE_COMM_LOCATIONS'.