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
102 lines
2.2 KiB
Plaintext
102 lines
2.2 KiB
Plaintext
.TH "PAPI_state" 3 "Wed Jun 25 2025 19:30:49" "Version 7.2.0.0" "PAPI" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
PAPI_state \- Return the counting state of an EventSet\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.PP
|
|
\fBC Interface:\fP
|
|
.RS 4
|
|
#include <\fBpapi\&.h\fP>
|
|
.br
|
|
int PAPI_state( int EventSet, int * status );
|
|
.RE
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIEventSet\fP -- an integer handle for a PAPI event set as created by \fBPAPI_create_eventset\fP
|
|
.br
|
|
\fIstatus\fP -- an integer containing a boolean combination of one or more of the following nonzero constants as defined in the PAPI header file \fBpapi\&.h\fP:
|
|
.PD 0
|
|
.IP "\(bu" 1
|
|
PAPI_STOPPED -- EventSet is stopped
|
|
.IP "\(bu" 1
|
|
PAPI_RUNNING -- EventSet is running
|
|
.IP "\(bu" 1
|
|
PAPI_PAUSED -- EventSet temporarily disabled by the library
|
|
.IP "\(bu" 1
|
|
PAPI_NOT_INIT -- EventSet defined, but not initialized
|
|
.IP "\(bu" 1
|
|
PAPI_OVERFLOWING -- EventSet has overflowing enabled
|
|
.IP "\(bu" 1
|
|
PAPI_PROFILING -- EventSet has profiling enabled
|
|
.IP "\(bu" 1
|
|
PAPI_MULTIPLEXING -- EventSet has multiplexing enabled
|
|
.IP "\(bu" 1
|
|
PAPI_ACCUMULATING -- reserved for future use
|
|
.IP "\(bu" 1
|
|
PAPI_HWPROFILING -- reserved for future use
|
|
|
|
.PP
|
|
.RE
|
|
.PP
|
|
\fBReturn values\fP
|
|
.RS 4
|
|
\fIPAPI_OK\fP
|
|
.br
|
|
\fIPAPI_EINVAL\fP One or more of the arguments is invalid\&.
|
|
.br
|
|
\fIPAPI_ENOEVST\fP The EventSet specified does not exist\&.
|
|
|
|
.RE
|
|
.PP
|
|
PAPI_state() returns the counting state of the specified event set\&.
|
|
|
|
.PP
|
|
\fBExample:\fP
|
|
.RS 4
|
|
|
|
.PP
|
|
.nf
|
|
int EventSet = PAPI_NULL;
|
|
int status = 0;
|
|
int ret;
|
|
|
|
ret = PAPI_create_eventset(&EventSet);
|
|
if (ret != PAPI_OK) handle_error(ret);
|
|
|
|
// Add Total Instructions Executed to our EventSet
|
|
ret = PAPI_add_event(EventSet, PAPI_TOT_INS);
|
|
if (ret != PAPI_OK) handle_error(ret);
|
|
|
|
// Start counting
|
|
ret = PAPI_state(EventSet, &status);
|
|
if (ret != PAPI_OK) handle_error(ret);
|
|
printf("State is now %d\\n",status);
|
|
ret = PAPI_start(EventSet);
|
|
if (ret != PAPI_OK) handle_error(ret);
|
|
ret = PAPI_state(EventSet, &status);
|
|
if (ret != PAPI_OK) handle_error(ret);
|
|
printf("State is now %d\\n",status);
|
|
|
|
.fi
|
|
.PP
|
|
.RE
|
|
.PP
|
|
\fBSee also\fP
|
|
.RS 4
|
|
\fBPAPI_stop\fP \fBPAPI_start\fP
|
|
.RE
|
|
.PP
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for PAPI from the source code\&.
|