papi_get_virt_usec(3) [centos man page]

PAPI_get_virt_usec(3)						       PAPI						     PAPI_get_virt_usec(3)

NAME

       PAPI_get_virt_usec -

       get virtual time counter values in microseconds

SYNOPSIS

Detailed Description
       @retval PAPI_ECNFLCT
	   If there is no master event set.
	   This will happen if the library has not been initialized, or for threaded
	   applications, if there has been no thread id function defined by the
	   PAPI_thread_init function.
       @retval PAPI_ENOMEM
	   For threaded applications, if there has not yet been any thread
	   specific master event created for the current thread, and if the
	   allocation of such an event set fails, the call will return PAPI_ENOMEM or PAPI_ESYS .

       This function returns the total number of virtual units from some
       arbitrary starting point.
       Virtual units accrue every time the process is running in user-mode on
       behalf of the process.
       Like the real time counters, this count is guaranteed to exist on every
       platform PAPI supports. However on some platforms, the resolution can be
       as bad as 1/Hz as defined by the operating system.
       @par Examples:

	       s = PAPI_get_virt_cyc();
	       your_slow_code();
	       e = PAPI_get_virt_cyc();
	       printf("Process has run for cycles: %lld
",e-s);
       *

       See Also:
	   PAPIF

	   PAPI

	   PAPI

	   PAPI_get_real_cyc

	   PAPI_get_virt_cyc

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

Version 5.2.0.0 						  Tue Jun 17 2014					     PAPI_get_virt_usec(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)