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_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)