File: PAPI_ipc.3

package info (click to toggle)
papi 6.0.0~dfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 11,056 kB
  • sloc: ansic: 103,847; fortran: 3,015; xml: 2,460; cpp: 1,845; f90: 1,360; makefile: 977; sh: 591; python: 274
file content (64 lines) | stat: -rw-r--r-- 1,764 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
.TH "PAPI_ipc" 3 "Thu Feb 27 2020" "Version 6.0.0.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_ipc \- 
.PP
Simplified call to get instructions per cycle, real and processor time\&.  

.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP 

.PP
\fBC Interface: \fP
.RS 4
#include <\fBpapi\&.h\fP> 
.br
int \fBPAPI_ipc( float *rtime, float *ptime, long long *ins, float *ipc )\fP;
.RE
.PP
\fBParameters:\fP
.RS 4
\fI*rtime\fP realtime since the latest call 
.br
\fI*ptime\fP process time since the latest call 
.br
\fI*ins\fP instructions since the latest call 
.br
\fI*ipc\fP incremental instructions per cycle since the latest call
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIPAPI_EINVAL\fP The counters were already started by something other than \fBPAPI_ipc()\fP\&. 
.br
\fIPAPI_ENOEVNT\fP The events PAPI_TOT_INS and PAPI_TOT_CYC are not supported\&. 
.br
\fIPAPI_ENOMEM\fP Insufficient memory to complete the operation\&.
.RE
.PP
The first call to \fBPAPI_ipc()\fP will initialize the PAPI interface, set up the counters to monitor PAPI_TOT_INS and PAPI_TOT_CYC events and start the counters\&.
.PP
Subsequent calls will read the counters and return real time, process time, instructions and the IPC rate since the latest call to \fBPAPI_ipc()\fP\&.
.PP
\fBPAPI_ipc()\fP should return a ratio greater than 1\&.0, indicating instruction level parallelism within the chip\&. The larger this ratio the more effeciently the program is running\&. Note that \fBPAPI_ipc()\fP is thread-safe and can therefore be called by multiple threads\&.
.PP
\fBSee Also:\fP
.RS 4
\fBPAPI_flips_rate()\fP 
.PP
\fBPAPI_flops_rate()\fP 
.PP
\fBPAPI_epc()\fP 
.PP
\fBPAPI_rate_stop()\fP 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for PAPI from the source code\&.