NVIDIA Monitoring (NvMon)

add_event_set(estr) -> groupid

Add a performance group or a custom event set to the nvmon module. Returns a groupid (starting at 1) which is required to later specify the event set.

get_event_results([groupid_or_groupname, eventid_or_eventname, gpuid::Integer])

Retrieve the results of monitored events. Same as get_metric_results but for raw events.

Return the groupid of the currently activate group.

Return the derived metric result of the last measurement cycle identified by group groupid and the indices for metric metricidx and gpu gpuid (all starting at 1).

Return the raw counter register result of the last measurement cycle identified by group groupid and the indices for event eventidx and gpu gpuid (all starting at 1).

Return the (long) description of a performance group with id groupid (starts at 1).

Return the derived metric result of all measurements identified by group groupid and the indices for metric metricidx and gpu gpuid (all starting at 1).

get_metric_results([groupid_or_groupname, metricid_or_metricname, gpuid::Integer])

Retrieve the results of monitored metrics.

Optionally, a group, metric, and gpuid can be provided to select a subset of metrics or a single metric. If given as integers, note that groupid, metricid, and gpuid all start at 1 and the latter enumerates the monitored gpus.

If no arguments are provided, a nested data structure is returned in which different levels correspond to performance groups, gpus, and metrics (in this order). ```

get_metric_results()

Get the metric results for all performance groups and all monitored (NvMon.init) gpus.

Returns a an OrderedDict whose keys correspond to the performance groups and the values hold the results for all monitored gpus. ```

Return the name of the counter register identified by groupid and eventidx (both start at 1).

Return the name of the event identified by groupid and eventidx (both start at 1).

Return the name of the group identified by groupid (starts at 1). If it is a custom event set, the name is set to Custom.

Return the name of a derived metric identified by groupid and metricidx (both start at 1).

Return the number of events in the group with id groupid (starts at 1).

Return the number of GPUs initialized in the nvmon module.

Return the number of groups currently registered in the nvmon module.

Return the number of metrics in the group with id groupid (starts at 1). Always zero for custom event sets.

Return the raw counter register result of all measurements identified by group groupid and the indices for event eventidx and gpu gpuid (all starting at 1).

Return the short information about a performance group with id groupid (starts at 1).

Return the measurement time for group identified by groupid (starts at 1).

init(gpuid_or_gpuids)

Initialize LIKWID's NvMon module for the gpu(s) with the given gpu id(s) (starting at 0!).

Checks if the given performance group is available on the given GPU (defaults to the first).

nvmon(f, group_or_groups[; gpuids])

Monitor performance groups while executing the given function f on one or multiple GPUs. Note that

• NvMon.init and NvMon.finalize are called automatically
• the measurement of multiple performance groups is sequential and requires multiple executions of f!

Keyword arguments:

• gpuids (default: first GPU): specify the GPUs to be monitored

Note: This is an experimental feature and might change or be dropped any time!

Example

julia> using LIKWID

julia> x = CUDA.rand(1000); y = CUDA.rand(1000);

julia> metrics, events = nvmon("FLOPS_DP") do
           CUDA.@sync x .+ y;
       end;

Read the counter registers. To be executed after start_counters and before stop_counters. Returns true on success.

Program the counter registers to measure all events in group groupid (starts at 1). Returns true on success.

Start the counter registers. Returns true on success.

Stop the counter registers. Returns true on success.

Return a dictionary of all available nvmon groups for the GPU identified by gpu (starts at 0).

Examples

julia> NvMon.supported_groups()
Dict{String, LIKWID.GroupInfoCompact} with 4 entries:
  "DATA"     => DATA => Load to store ratio
  "FLOPS_SP" => FLOPS_SP => Single-precision floating point
  "FLOPS_HP" => FLOPS_HP => Half-precision floating point
  "FLOPS_DP" => FLOPS_DP => Double-precision floating point

Switch currently active group to groupid (starts at 1). Returns true on success.

@nvmon group_or_groups codeblock

See also: nvmon

Note: This is an experimental feature and might change or be dropped any time!

Example

julia> using LIKWID

julia> x = CUDA.rand(1000); y = CUDA.rand(1000);

julia> metrics, events = @nvmon "FLOPS_DP" x .+ y;