File: PAPIf_hl_region_end.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 (77 lines) | stat: -rw-r--r-- 1,730 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
65
66
67
68
69
70
71
72
73
74
75
76
77
.TH "PAPIf_hl_region_end" 3 "Thu Feb 27 2020" "Version 6.0.0.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPIf_hl_region_end \- 
.PP
Reads and stores hardware events at the end of an instrumented code region\&.  

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

.PP
\fBFortran Prototype:\fP
.RS 4
#include 'fpapi\&.h' 
.br
 \fBPAPIf_hl_region_end( C_STRING region, C_INT check )\fP
.RE
.PP
\fBParameters:\fP
.RS 4
\fIregion\fP -- a unique region name corresponding to \fBPAPIf_hl_region_begin\fP
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIPAPI_OK\fP 
.br
\fIPAPI_ENOTRUN\fP -- EventSet is currently not running or could not determined\&. 
.br
\fIPAPI_ESYS\fP -- A system or C library call failed inside PAPI, see the errno variable\&. 
.br
\fIPAPI_EMISC\fP -- PAPI has been deactivated due to previous erros\&. 
.br
\fIPAPI_ENOMEM\fP -- Insufficient memory\&.
.RE
.PP
\fBPAPIf_hl_region_end\fP reads hardware events and stores the difference to the values from \fBPAPIf_hl_region_begin\fP at the end of an instrumented code region\&. Assumes that \fBPAPIf_hl_region_begin\fP was called before\&. Note that an output is automatically generated when your application terminates\&.
.PP
\fBExample:\fP
.RS 4

.RE
.PP
.PP
.nf
* integer retval
*
* call PAPIf_hl_region_begin("computation", retval)
* if ( retval \&.NE\&. PAPI_OK ) then
*     write (*,*) "PAPIf_hl_region_begin failed!"
* end if
*
* !do some computation here
*
* call PAPIf_hl_region_end("computation", retval)
* if ( retval \&.NE\&. PAPI_OK ) then
*     write (*,*) "PAPIf_hl_region_end failed!"
* end if
*
* 
.fi
.PP
.PP
\fBSee Also:\fP
.RS 4
\fBPAPI_hl_region_end\fP 
.RE
.PP


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