papi_add_named_event(3) [centos man page]

PAPI_add_named_event(3) 					       PAPI						   PAPI_add_named_event(3)

NAME

       PAPI_add_named_event -

       add PAPI preset or native hardware event by name to an EventSet

SYNOPSIS

Detailed Description
       @par C Interface:
       int PAPI_add_named_event( int EventSet, char *EventName );

       PAPI_add_named_event adds one event to a PAPI EventSet. @n
       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 avail test case
       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 current platform, run the papi_native_avail
       utility in the PAPI distribution.

       @param EventSet
	   An integer handle for a PAPI Event Set as created by PAPI_create_eventset.
       @param EventCode
	   A defined event such as PAPI_TOT_INS.

       @retval Positive-Integer
	   The number of consecutive elements that succeeded before the error.
       @retval PAPI_EINVAL
	   One or more of the arguments is invalid.
       @retval PAPI_ENOINIT
	   The PAPI library has not been initialized.
       @retval PAPI_ENOMEM
	   Insufficient memory to complete the operation.
       @retval PAPI_ENOEVST
	   The event set specified does not exist.
       @retval PAPI_EISRUN
	   The event set is currently counting events.
       @retval PAPI_ECNFLCT
	   The underlying counter hardware can not count this event and other events
	   in the event set simultaneously.
       @retval PAPI_ENOEVNT
	   The PAPI preset is not available on the underlying hardware.
       @retval PAPI_EBUG
	   Internal error, please send mail to the developers.

       @par Examples:

       *  char EventName = "PAPI_TOT_INS";
       *   int EventSet = PAPI_NULL;
       *   unsigned int native = 0x0;
       *   if ( PAPI_create_eventset( &EventSet ) != PAPI_OK )
       *   handle_error( 1 );
       *   // Add Total Instructions Executed to our EventSet
       *   if ( PAPI_add_named_event( EventSet, EventName ) != PAPI_OK )
       *   handle_error( 1 );
       *   // Add native event PM_CYC to EventSet
       *   if ( PAPI_add_named_event( EventSet, "PM_CYC" ) != PAPI_OK )
       *   handle_error( 1 );
       *

       @see PAPI_add_event @n
       PAPI_query_named_event @n
       PAPI_remove_named_event.fi

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

Version 5.2.0.0 						  Tue Jun 17 2014					   PAPI_add_named_event(3)

Check Out this Related Man Page

PAPI_get_multiplex(3)						       PAPI						     PAPI_get_multiplex(3)

NAME

       PAPI_get_multiplex -

       Get the multiplexing status of specified event set.

SYNOPSIS

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

       Fortran Interface:
	   #include fpapi.h
	    PAPIF_get_multiplex( C_INT	EventSet,  C_INT  check )

       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_ENOEVST The EventSet specified does not exist.
	   PAPI_EISRUN The EventSet is currently counting events.
	   PAPI_ENOMEM Insufficient memory to complete the operation.

       PAPI_get_multiplex tests the state of the PAPI_MULTIPLEXING flag in the specified event set, returning TRUE if a PAPI event set is
       multiplexed, or FALSE if not.

       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_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_get_multiplex(3)

Linux and UNIX Man Pages

papi_add_named_event(3) [centos man page]

Check Out this Related Man Page