table of contents
- bookworm 7.0.0-2
- testing 7.1.0-5+b1
- unstable 7.1.0-5+b1
- experimental 7.2.0~b1-1
PAPI_get_opt(3) | PAPI | PAPI_get_opt(3) |
NAME¶
PAPI_get_opt -
Get PAPI library or event set options.
SYNOPSIS¶
Detailed Description¶
C Interface:
int PAPI_get_opt( int option, PAPI_option_t * ptr );
Parameters:
ptr Pointer to a structure determined by the selected option. See PAPI_option_t for a description of possible structures.
Return values:
PAPI_EINVAL The specified option or parameter is invalid.
PAPI_ENOEVST The EventSet specified does not exist.
PAPI_ECMP The option is not implemented for the current component.
PAPI_ENOINIT specified option requires PAPI to be initialized first.
PAPI_get_opt() queries the options of the PAPI library or a specific event set created by PAPI_create_eventset. Some options may require that the eventset be bound to a component before they can execute successfully. This can be done either by adding an event or by explicitly calling PAPI_assign_eventset_component.
Ptr is a pointer to the PAPI_option_t structure, which is actually a union of different structures for different options. Not all options require or return information in these structures. Each returns different values in the structure. Some options require a component index to be provided. These options are handled explicitly by the PAPI_get_cmp_opt() call.
Note:
The reader is encouraged to peruse the ctests code in the PAPI distribution for examples of usage of PAPI_set_opt.
Possible values for the PAPI_get_opt option parameter
OPTION DEFINITION PAPI_DEFDOM Get default counting domain for
newly created event sets. Requires a component index. PAPI_DEFGRN Get
default counting granularity. Requires a component index. PAPI_DEBUG Get the
PAPI debug state and the debug handler. The debug state is specified in
ptr->debug.level. The debug handler is specified in
ptr->debug.handler.
For further information regarding debug states and the behavior of the
handler, see PAPI_set_debug. PAPI_MULTIPLEX Get current multiplexing state
for specified EventSet. PAPI_DEF_ITIMER Get the type of itimer used in
software multiplexing, overflowing and profiling. PAPI_DEF_MPX_NS Get the
sampling time slice in nanoseconds for multiplexing and overflow.
PAPI_DEF_ITIMER_NS See PAPI_DEF_MPX_NS. PAPI_ATTACH Get thread or process id
to which event set is attached. Returns TRUE if currently attached.
PAPI_CPU_ATTACH Get ptr->cpu.cpu_num and Attach state for EventSet
specified in ptr->cpu.eventset. PAPI_DETACH Get thread or process id to
which event set is attached. Returns TRUE if currently attached. PAPI_DOMAIN
Get domain for EventSet specified in ptr->domain.eventset. Will error if
eventset is not bound to a component. PAPI_GRANUL Get granularity for
EventSet specified in ptr->granularity.eventset. Will error if eventset
is not bound to a component. PAPI_INHERIT Get current inheritance state for
specified EventSet. PAPI_PRELOAD Get LD_PRELOAD environment equivalent.
PAPI_CLOCKRATE Get clockrate in MHz. PAPI_MAX_CPUS Get number of CPUs.
PAPI_EXEINFO Get Executable addresses for text/data/bss. PAPI_HWINFO Get
information about the hardware. PAPI_LIB_VERSION Get the full PAPI version
of the library. This does not require PAPI to be initialized first.
PAPI_MAX_HWCTRS Get number of counters. Requires a component index.
PAPI_MAX_MPX_CTRS Get maximum number of multiplexing counters. Requires a
component index. PAPI_SHLIBINFO Get shared library information used by the
program. PAPI_COMPONENTINFO Get the PAPI features the specified component
supports. Requires a component index.
See Also:
PAPI_get_cmp_opt
PAPI_set_opt
PAPI_option_t
Author¶
Generated automatically by Doxygen for PAPI from the source code.
Mon Nov 14 2022 | Version 7.0.0.0 |