papi_decode(1) [centos man page]

papi_decode(1)							       PAPI							    papi_decode(1)

NAME

       papi_decode - papi_decode utility.

       file decode.c

NAME

       papi_decode - provides availability and detail information for PAPI preset events.

Synopsis
       papi_decode [-ah]

Description
       papi_decode is a PAPI utility program that converts the PAPI presets for the existing library into a comma separated value format that can
       then be viewed or modified in spreadsheet applications or text editors, and can be supplied to PAPI_encode_events (3) as a way of adding or
       modifying event definitions for specialized applications. The format for the csv output consists of a line of field names, followed by a
       blank line, followed by one line of comma separated values for each event contained in the preset table. A portion of this output (for
       Pentium 4) is shown below:

       *       name,derived,postfix,short_descr,long_descr,note,[native,...]
       *       PAPI_L1_ICM,NOT_DERIVED,,"L1I cache misses","Level 1 instruction cache misses",,BPU_fetch_request_TCMISS
       *       PAPI_L2_TCM,NOT_DERIVED,,"L2 cache misses","Level 2 cache misses",,BSQ_cache_reference_RD_2ndL_MISS_WR_2ndL_MISS
       *       PAPI_TLB_DM,NOT_DERIVED,,"Data TLB misses","Data translation lookaside buffer misses",,page_walk_type_DTMISS
       *

Options
       o -a Convert only the available PAPI preset events.
       o -h Display help information about this utility.
Bugs
       There are no known bugs in this utility. If you find a bug, it should be reported to the PAPI Mailing List at ptools-perfapi@ptools.org.

Version 5.2.0.0 						  Tue Jun 17 2014						    papi_decode(1)

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)