File: PAPI_get_thr_specific.3

package info (click to toggle)
papi 5.3.2-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 27,244 kB
  • ctags: 37,740
  • sloc: ansic: 384,780; makefile: 3,319; fortran: 3,306; xml: 2,460; sh: 791; python: 515; perl: 269; asm: 24
file content (79 lines) | stat: -rw-r--r-- 1,997 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
78
79
.TH "PAPI_get_thr_specific" 3 "Mon Jun 30 2014" "Version 5.3.2.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_get_thr_specific \- 
.PP
Retrieve a pointer to a thread specific data structure\&.  

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

.PP
.nf
@par Prototype:
    \#include <papi.h> @n
    int PAPI_get_thr_specific( int tag, void **ptr );

@param tag
    An identifier, the value of which is either PAPI_USR1_TLS or 
    PAPI_USR2_TLS. This identifier indicates which of several data 
    structures associated with this thread is to be accessed.
@param ptr
    A pointer to the memory containing the data structure. 

@retval PAPI_OK
@retval PAPI_EINVAL 
    The @em tag argument is out of range. 

In C, PAPI_get_thr_specific PAPI_get_thr_specific will retrieve the pointer from the array with index @em tag. 
There are 2 user available locations and @em tag can be either 
PAPI_USR1_TLS or PAPI_USR2_TLS. 
The array mentioned above is managed by PAPI and allocated to each 
thread which has called PAPI_thread_init. 
There is no Fortran equivalent function. 

@par Example:

.fi
.PP
 
.PP
.nf
 int ret;
 HighLevelInfo *state = NULL;
 ret = PAPI_thread_init(pthread_self);
 if (ret != PAPI_OK) handle_error(ret);
 
 // Do we have the thread specific data setup yet?

ret = PAPI_get_thr_specific(PAPI_USR1_TLS, (void *) &state);
if (ret != PAPI_OK || state == NULL) {
    state = (HighLevelInfo *) malloc(sizeof(HighLevelInfo));
    if (state == NULL) return (PAPI_ESYS);
    memset(state, 0, sizeof(HighLevelInfo));
    state->EventSet = PAPI_NULL;
    ret = PAPI_create_eventset(&state->EventSet);
    if (ret != PAPI_OK) return (PAPI_ESYS);
    ret = PAPI_set_thr_specific(PAPI_USR1_TLS, state);
    if (ret != PAPI_OK) return (ret);
}
*   

.fi
.PP
 
.PP
\fBSee Also:\fP
.RS 4
\fBPAPI_register_thread\fP \fBPAPI_thread_init\fP \fBPAPI_thread_id\fP \fBPAPI_set_thr_specific\fP 
.RE
.PP


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