derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
84 lines
1.7 KiB
Plaintext
84 lines
1.7 KiB
Plaintext
.TH "PAPI_read" 3 "Wed Jun 25 2025 19:30:48" "Version 7.2.0.0" "PAPI" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
PAPI_read \- Read hardware counters from an event set\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.PP
|
|
\fBC Interface:\fP
|
|
.RS 4
|
|
#include <\fBpapi\&.h\fP>
|
|
.br
|
|
int \fBPAPI_read(int EventSet, long_long * values )\fP;
|
|
.RE
|
|
.PP
|
|
PAPI_read() copies the counters of the indicated event set into the provided array\&.
|
|
.PP
|
|
The counters continue counting after the read\&.
|
|
.PP
|
|
Note the differences between PAPI_read() and PAPI_accum(), specifically that PAPI_accum() resets the values array to zero\&.
|
|
.PP
|
|
PAPI_read() assumes an initialized PAPI library and a properly added event set\&.
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIEventSet\fP -- an integer handle for a PAPI Event Set as created by PAPI_create_eventset()
|
|
.br
|
|
\fI*values\fP -- an array to hold the counter values of the counting events
|
|
.RE
|
|
.PP
|
|
\fBReturn values\fP
|
|
.RS 4
|
|
\fIPAPI_EINVAL\fP One or more of the arguments is invalid\&.
|
|
.br
|
|
\fIPAPI_ESYS\fP A system or C library call failed inside PAPI, see the errno variable\&.
|
|
.br
|
|
\fIPAPI_ENOEVST\fP The event set specified does not exist\&.
|
|
.RE
|
|
.PP
|
|
\fBExamples\fP
|
|
.RS 4
|
|
|
|
.PP
|
|
.nf
|
|
do_100events();
|
|
if (PAPI_read(EventSet, values) != PAPI_OK)
|
|
handle_error(1);
|
|
// values[0] now equals 100
|
|
do_100events();
|
|
if (PAPI_accum(EventSet, values) != PAPI_OK)
|
|
handle_error(1);
|
|
// values[0] now equals 300
|
|
values[0] = \-100;
|
|
do_100events();
|
|
if (PAPI_accum(EventSet, values) != PAPI_OK)
|
|
handle_error(1);
|
|
// values[0] now equals 0
|
|
|
|
.fi
|
|
.PP
|
|
.RE
|
|
.PP
|
|
\fBSee also\fP
|
|
.RS 4
|
|
\fBPAPI_accum\fP
|
|
.PP
|
|
\fBPAPI_start\fP
|
|
.PP
|
|
\fBPAPI_stop\fP
|
|
.PP
|
|
\fBPAPI_reset\fP
|
|
.RE
|
|
.PP
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for PAPI from the source code\&.
|