File: PAPI_set_thr_specific.3

package info (click to toggle)
papi 7.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 31,272 kB
  • sloc: ansic: 485,669; cpp: 7,483; fortran: 3,138; makefile: 2,501; xml: 2,460; f90: 1,374; python: 1,062; sh: 780; perl: 242; pascal: 167; asm: 5
file content (75 lines) | stat: -rw-r--r-- 2,025 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
.TH "PAPI_set_thr_specific" 3 "Wed Jun 25 2025 19:30:49" "Version 7.2.0.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_set_thr_specific \- Store a pointer to a thread specific data structure\&.  

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

.PP
\fBPrototype:\fP
.RS 4
#include <\fBpapi\&.h\fP> 
.br
 int PAPI_set_thr_specific( int tag, void *ptr );
.RE
.PP
\fBParameters\fP
.RS 4
\fItag\fP 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\&. 
.br
\fIptr\fP A pointer to the memory containing the data structure\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIPAPI_OK\fP 
.br
\fIPAPI_EINVAL\fP The \fItag\fP argument is out of range\&.
.RE
.PP
In C, \fBPAPI_set_thr_specific\fP will save \fIptr\fP into an array indexed by \fItag\fP\&. There are 2 user available locations and \fItag\fP 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 \fBPAPI_thread_init\fP\&. There is no Fortran equivalent function\&.
.PP
\fBExample:\fP
.RS 4

.PP
.nf
int ret;
RateInfo *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 = (RateInfo *) malloc(sizeof(RateInfo));
    if (state == NULL) return (PAPI_ESYS);
    memset(state, 0, sizeof(RateInfo));
    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
 
.RE
.PP
\fBSee also\fP
.RS 4
\fBPAPI_register_thread\fP \fBPAPI_thread_init\fP \fBPAPI_thread_id\fP \fBPAPI_get_thr_specific\fP 
.RE
.PP


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