|
Packit |
577717 |
.TH "PAPI_start" 3 "Mon Dec 18 2017" "Version 5.6.0.0" "PAPI" \" -*- nroff -*-
|
|
Packit |
577717 |
.ad l
|
|
Packit |
577717 |
.nh
|
|
Packit |
577717 |
.SH NAME
|
|
Packit |
577717 |
PAPI_start \-
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
Start counting hardware events in an event set\&.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.SH SYNOPSIS
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.SH "Detailed Description"
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBC Interface:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
#include <\fBpapi\&.h\fP>
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
int \fBPAPI_start( int EventSet )\fP;
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBParameters:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
\fIEventSet\fP -- an integer handle for a PAPI event set as created by \fBPAPI_create_eventset\fP
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBReturn values:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
\fIPAPI_OK\fP
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fIPAPI_EINVAL\fP -- One or more of the arguments is invalid\&.
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fIPAPI_ESYS\fP -- A system or C library call failed inside PAPI, see the errno variable\&.
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fIPAPI_ENOEVST\fP -- The EventSet specified does not exist\&.
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fIPAPI_EISRUN\fP -- The EventSet is currently counting events\&.
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fIPAPI_ECNFLCT\fP -- The underlying counter hardware can not count this event and other events in the EventSet simultaneously\&.
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fIPAPI_ENOEVNT\fP -- The PAPI preset is not available on the underlying hardware\&.
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_start\fP starts counting all of the hardware events contained in the previously defined EventSet\&. All counters are implicitly set to zero before counting\&. Assumes an initialized PAPI library and a properly added event set\&.
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBExample:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.nf
|
|
Packit |
577717 |
* int EventSet = PAPI_NULL;
|
|
Packit |
577717 |
* long long values[2];
|
|
Packit |
577717 |
* int ret;
|
|
Packit |
577717 |
*
|
|
Packit |
577717 |
* ret = PAPI_create_eventset(&EventSet);
|
|
Packit |
577717 |
* if (ret != PAPI_OK) handle_error(ret);
|
|
Packit |
577717 |
*
|
|
Packit |
577717 |
* // Add Total Instructions Executed to our EventSet
|
|
Packit |
577717 |
* ret = PAPI_add_event(EventSet, PAPI_TOT_INS);
|
|
Packit |
577717 |
* if (ret != PAPI_OK) handle_error(ret);
|
|
Packit |
577717 |
*
|
|
Packit |
577717 |
* // Start counting
|
|
Packit |
577717 |
* ret = PAPI_start(EventSet);
|
|
Packit |
577717 |
* if (ret != PAPI_OK) handle_error(ret);
|
|
Packit |
577717 |
* poorly_tuned_function();
|
|
Packit |
577717 |
* ret = PAPI_stop(EventSet, values);
|
|
Packit |
577717 |
* if (ret != PAPI_OK) handle_error(ret);
|
|
Packit |
577717 |
* printf("%lld\\n",values[0]);
|
|
Packit |
577717 |
*
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.fi
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBSee Also:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
\fBPAPI_create_eventset\fP \fBPAPI_add_event\fP \fBPAPI_stop\fP
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.SH "Author"
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
Generated automatically by Doxygen for PAPI from the source code\&.
|