papi_assign_eventset_component(3) [centos man page]

PAPI_assign_eventset_component(3)				       PAPI					 PAPI_assign_eventset_component(3)

NAME

       PAPI_assign_eventset_component -

       Assign a component index to an existing but empty EventSet.

SYNOPSIS

Detailed Description
       @par C Interface:
       PAPI_assign_eventset_component( int  EventSet, int  cidx );

       @param EventSet
	   An integer identifier for an existing EventSet.
       @param cidx
	   An integer identifier for a component.
	   By convention, component 0 is always the cpu component.

       @retval PAPI_ENOCMP
	   The argument cidx is not a valid component.
       @retval PAPI_ENOEVST
	   The EventSet doesn't exist.
       @retval PAPI_ENOMEM
	   Insufficient memory to complete the operation.

       PAPI_assign_eventset_component assigns a specific component index,
       as specified by cidx, to a new EventSet identified by EventSet, as obtained
       from PAPI_create_eventset. EventSets are ordinarily automatically bound
       to components when the first event is added. This routine is useful to
       explicitly bind an EventSet to a component before setting component related
       options.

       @par Examples:

       *   int EventSet = PAPI_NULL;
       *   if ( PAPI_create_eventset( &EventSet ) != PAPI_OK )
       *   handle_error( 1 );
       *   // Bind our EventSet to the cpu component
       *   if ( PAPI_assign_eventset_component( EventSet, 0 ) != PAPI_OK )
       *   handle_error( 1 );
       *   // Convert our EventSet to multiplexing
       *   if ( PAPI_set_multiplex( EventSet ) != PAPI_OK )
       *   handle_error( 1 );
       *

       See Also:
	   PAPI_set_opt
	    PAPI_create_eventset
	    PAPI_add_events
	    PAPI_set_multiplex

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

Version 5.2.0.0 						  Tue Jun 17 2014				 PAPI_assign_eventset_component(3)

PAPI_remove_event(3)						       PAPI						      PAPI_remove_event(3)

NAME

       PAPI_remove_event -

       removes a hardware event from a PAPI event set.

SYNOPSIS

Detailed Description
       A hardware event can be either a PAPI Preset or a native hardware
       event code.  For a list of PAPI preset events, see PAPI_presets or
       run the papi_avail utility in the PAPI distribution.  PAPI Presets
       can be passed to PAPI_query_event to see if they exist on the
       underlying architecture.  For a list of native events available on
       the current platform, run papi_native_avail in the PAPI distribution.

       @par C Interface:
       int PAPI_remove_event( int  EventSet, int  EventCode );

       @param[in] EventSet
	  -- an integer handle for a PAPI event set as created
		by PAPI_create_eventset
       @param[in] EventCode
	  -- a defined event such as PAPI_TOT_INS or a native event.

       @retval PAPI_OK
	   Everything worked.
       @retval PAPI_EINVAL
	   One or more of the arguments is invalid.
       @retval PAPI_ENOEVST
	   The EventSet specified does not exist.
       @retval PAPI_EISRUN
	   The EventSet is currently counting events.
       @retval PAPI_ECNFLCT
	   The underlying counter hardware can not count this
		  event and other events in the EventSet simultaneously.
       @retval PAPI_ENOEVNT
	   The PAPI preset is not available on the underlying hardware.

       @par Example:

       *   int EventSet = PAPI_NULL;
       *   int ret;
       *
       *   // Create an empty EventSet
       *   ret = PAPI_create_eventset(&EventSet);
       *   if (ret != PAPI_OK) handle_error(ret);
       *
       *   // Add Total Instructions Executed to our EventSet
       *   ret = PAPI_add_event(EventSet, PAPI_TOT_INS);
       *   if (ret != PAPI_OK) handle_error(ret);
       *
       *   // Start counting
       *   ret = PAPI_start(EventSet);
       *   if (ret != PAPI_OK) handle_error(ret);
       *
       *   // Stop counting, ignore values
       *   ret = PAPI_stop(EventSet, NULL);
       *   if (ret != PAPI_OK) handle_error(ret);
       *
       *   // Remove event
       *   ret = PAPI_remove_event(EventSet, PAPI_TOT_INS);
       *   if (ret != PAPI_OK) handle_error(ret);
       *

       See Also:
	   PAPI_cleanup_eventset

	   PAPI_destroy_eventset

	   PAPI_event_name_to_code

	   PAPI_presets

	   PAPI_add_event

	   PAPI_add_events

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

Version 5.2.0.0 						  Tue Jun 17 2014					      PAPI_remove_event(3)