papi_list_events(3) [centos man page]

PAPI_list_events(3)						       PAPI						       PAPI_list_events(3)

NAME

       PAPI_list_events -

       list the events in an event set

SYNOPSIS

Detailed Description
       List the events in an event set.

       PAPI_list_events() returns an array of events and a count of the

	total number of events in an event set. This call assumes an initialized PAPI library and a successfully created event set.

       C Interface
	   #include <papi.h>
	    int PAPI_list_events(int *EventSet, int *Events, int *number );

       Parameters:
	   EventSet An integer handle for a PAPI event set as created by PAPI_create_eventset
	   *Events A pointer to a preallocated array of codes for events, such as PAPI_INT_INS. No more than *number codes will be stored into the
	   array.
	   *number On input, the size of the Events array, or maximum number of event codes to be returned. A value of 0 can be used to probe an
	   event set. On output, the number of events actually in the event set. This value may be greater than the actually stored number of
	   event codes.

       Return values:
	   PAPI_EINVAL
	   PAPI_ENOEVST

       Examples:

		   if (PAPI_event_name_to_code("PAPI_TOT_INS",&EventCode) != PAPI_OK)
		   exit(1);
		   if (PAPI_add_event(EventSet, EventCode) != PAPI_OK)
		   exit(1);
		   Convert a second event name to an event code
		   if (PAPI_event_name_to_code("PAPI_L1_LDM",&EventCode) != PAPI_OK)
		   exit(1);
		   if (PAPI_add_event(EventSet, EventCode) != PAPI_OK)
		   exit(1);
		   number = 0;
		   if(PAPI_list_events(EventSet, NULL, &number))
		   exit(1);
		   if(number != 2)
		   exit(1);
		   if(PAPI_list_events(EventSet, Events, &number))
		   exit(1);
	   *

       See Also:
	   PAPI_event_code_to_name

	   PAPI_event_name_to_code

	   PAPI_add_event

	   PAPI_create_eventset

       Fortran Interface:
	   #include 'fpapi.h'
	    PAPI_list_events( C_INT EventSet, C_INT(*) Events, C_INT number, C_INT check )

       See Also:
	   PAPI_list_events

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

Version 5.2.0.0 						  Tue Jun 17 2014					       PAPI_list_events(3)

PAPI_add_event(3)						       PAPI							 PAPI_add_event(3)

NAME

       PAPI_add_event -

       add PAPI preset or native hardware event to an event set

SYNOPSIS

Detailed Description
       @par C Interface:
       int PAPI_add_event( int	EventSet, int  EventCode );

       PAPI_add_event adds one event to a PAPI Event Set. @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. For the encoding of native events,
       see PAPI_event_name_to_code to learn how to generate native code for the
       supported native event on the underlying architecture.

       @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_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:

       *   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_event( EventSet, PAPI_TOT_INS ) != PAPI_OK )
       *   handle_error( 1 );
       *   // Add native event PM_CYC to EventSet
       *   if ( PAPI_event_name_to_code( "PM_CYC", &native ) != PAPI_OK )
       *   handle_error( 1 );
       *   if ( PAPI_add_event( EventSet, native ) != PAPI_OK )
       *   handle_error( 1 );
       *

       @see PAPI_cleanup_eventset @n
       PAPI_destroy_eventset @n
       PAPI_event_code_to_name @n
       PAPI_remove_events @n
       PAPI_query_event @n
       PAPI_presets @n
       PAPI_native @n
       PAPI_remove_event.fi

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

Version 5.2.0.0 						  Tue Jun 17 2014						 PAPI_add_event(3)