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 80 81 82
|
.TH "PAPI_detach" 3 "Thu Feb 27 2020" "Version 6.0.0.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_detach \-
.PP
Detach PAPI event set from previously specified thread id and restore to executing thread\&.
.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP
.PP
.nf
@par C Interface:
\#include <papi.h> @n
int PAPI_detach( int EventSet, unsigned long tid );
PAPI_detach is a wrapper function that calls PAPI_set_opt to allow PAPI to
monitor performance counts on a thread other than the one currently executing.
This is sometimes referred to as third party monitoring.
PAPI_attach connects the specified EventSet to the specified thread;
PAPI_detach breaks that connection and restores the EventSet to the
original executing thread.
@param EventSet
An integer handle for a PAPI EventSet as created by PAPI_create_eventset.
@param tid
A thread id as obtained from, for example, PAPI_list_threads or PAPI_thread_id.
@retval PAPI_ECMP
This feature is unsupported on this component.
@retval PAPI_EINVAL
One or more of the arguments is invalid.
@retval PAPI_ENOEVST
The event set specified does not exist.
@retval PAPI_EISRUN
The event set is currently counting events.
@par Examples:
.fi
.PP
.PP
.nf
* int EventSet = PAPI_NULL;
* unsigned long pid;
* pid = fork( );
* if ( pid <= 0 )
* exit( 1 );
* if ( PAPI_create_eventset( &EventSet ) != PAPI_OK )
* exit( 1 );
* // Add Total Instructions Executed to our EventSet
* if ( PAPI_add_event( EventSet, PAPI_TOT_INS ) != PAPI_OK )
* exit( 1 );
* // Attach this EventSet to the forked process
* if ( PAPI_attach( EventSet, pid ) != PAPI_OK )
* exit( 1 );
*
.fi
.PP
.PP
\fBSee Also:\fP
.RS 4
\fBPAPI_set_opt\fP
.br
\fBPAPI_list_threads\fP
.br
\fBPAPI_thread_id\fP
.br
\fBPAPI_thread_init\fP
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for PAPI from the source code\&.
|