Blame man/man3/PAPI_read_ts.3
|
Packit |
577717 |
.TH "PAPI_read_ts" 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_read_ts \-
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
Read hardware counters with a timestamp\&.
|
|
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_read_ts(int EventSet, long long *values, long long *cycles )\fP;
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_read_ts()\fP copies the counters of the indicated event set into the provided array\&. It also places a real-time cycle timestamp into the cycles array\&.
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
The counters continue counting after the read\&.
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_read_ts()\fP assumes an initialized PAPI library and a properly added event set\&.
|
|
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 |
.br
|
|
Packit |
577717 |
\fI*values\fP -- an array to hold the counter values of the counting events
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fI*cycles\fP -- an array to hold the timestamp values
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBReturn values:\fP
|
|
Packit |
577717 |
.RS 4
|
|
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 event set specified does not exist\&.
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBExamples\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.nf
|
|
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_read\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_accum\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_start\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_stop\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_reset\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\&.
|