papi_get_cmp_opt(3) [centos man page]

PAPI_get_cmp_opt(3)						       PAPI						       PAPI_get_cmp_opt(3)

NAME

       PAPI_get_cmp_opt -

       Get component specific PAPI options.

SYNOPSIS

Detailed Description
       Parameters:
	   option is an input parameter describing the course of action. Possible values are defined in papi.h and briefly described in the table
	   below. The Fortran calls are implementations of specific options.
	   ptr is a pointer to a structure that acts as both an input and output parameter.
	   cidx An integer identifier for a component. By convention, component 0 is always the cpu component.

       Return values:
	   PAPI_EINVAL One or more of the arguments is invalid.

       PAPI_get_opt() and PAPI_set_opt() query or change 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 .

       The C interface for these functions passes a pointer to the PAPI_option_t structure. Not all options require or return information in this
       structure, and not all options are implemented for both get and set. Some options require a component index to be provided. These options
       are handled explicitly by the PAPI_get_cmp_opt() call for 'get' and implicitly through the option structure for 'set'. The Fortran
       interface is a series of calls implementing various subsets of the C interface. Not all options in C are available in Fortran.

       Note:
	   Some options, such as PAPI_DOMAIN and PAPI_MULTIPLEX, are also available as separate entry points in both C and Fortran.

       The reader is urged to see the example code in the PAPI distribution for usage of PAPI_get_opt. The file papi.h contains definitions for
       the structures unioned in the PAPI_option_t structure.

       See Also:
	   PAPI_set_debug PAPI_set_multiplex PAPI_set_domain PAPI_option_t

Author
       Generated automatically by Doxygen for PAPI from the source code.

Version 5.2.0.0 						  Tue Jun 17 2014					       PAPI_get_cmp_opt(3)

PAPI_set_multiplex(3)						       PAPI						     PAPI_set_multiplex(3)

NAME

       PAPI_set_multiplex -

       Convert a standard event set to a multiplexed event set.

SYNOPSIS

Detailed Description
       C Interface:
	   #include <papi.h>
	    int PAPI_set_multiplex( int  EventSet );

       Parameters:
	   EventSet an integer handle for a PAPI event set as created by PAPI_create_eventset

       Return values:
	   PAPI_OK
	   PAPI_EINVAL -- One or more of the arguments is invalid, or the EventSet is already multiplexed.
	   PAPI_ENOCMP -- The EventSet specified is not yet bound to a component.
	   PAPI_ENOEVST -- The EventSet specified does not exist.
	   PAPI_EISRUN -- The EventSet is currently counting events.
	   PAPI_ENOMEM -- Insufficient memory to complete the operation.

       PAPI_set_multiplex converts a standard PAPI event set created by a call to PAPI_create_eventset into an event set capable of handling
       multiplexed events. This must be done after calling PAPI_multiplex_init, and either PAPI_add_event or PAPI_assign_eventset_component, but
       prior to calling PAPI_start().

       Events can be added to an event set either before or after converting it into a multiplexed set, but the conversion must be done prior to
       using it as a multiplexed set.

       Note:
	   Multiplexing can't be enabled until PAPI knows which component is targeted. Due to the late binding nature of PAPI event sets, this
	   only happens after adding an event to an event set or explicitly binding the component with a call to PAPI_assign_eventset_component.

       Example:

	   *   int EventSet = PAPI_NULL;
	   *   int ret;
	   *
	   *   // Create an empty EventSet
	   *   ret = PAPI_create_eventset(&EventSet);
	   *   if (ret != PAPI_OK) handle_error(ret);
	   *
	   *   // Bind it to the CPU component
	   *   ret = PAPI_assign_eventset_component(EventSet, 0);
	   *   if (ret != PAPI_OK) handle_error(ret);
	   *
	   *   // Check  current multiplex status
	   *   ret = PAPI_get_multiplex(EventSet);
	   *   if (ret == TRUE) printf("This event set is ready for multiplexing.")
	   *   if (ret == FALSE) printf("This event set is not enabled for multiplexing.")
	   *   if (ret < 0) handle_error(ret);
	   *
	   *   // Turn on multiplexing
	   *   ret = PAPI_set_multiplex(EventSet);
	   *   if ((ret == PAPI_EINVAL) && (PAPI_get_multiplex(EventSet) == TRUE))
	   *	 printf("This event set already has multiplexing enabled0);
	   *   else if (ret != PAPI_OK) handle_error(ret);
	   *

       See Also:
	   PAPI_multiplex_init

	   PAPI_get_multiplex

	   PAPI_set_opt

	   PAPI_create_eventset

Author
       Generated automatically by Doxygen for PAPI from the source code.

Version 5.2.0.0 						  Tue Jun 17 2014					     PAPI_set_multiplex(3)