/****************************/

/* THIS IS OPEN SOURCE CODE */

/****************************/

/** 

* @file    papi.h

*

* @author  Philip Mucci

*          mucci@cs.utk.edu

* @author  dan terpstra

*          terpstra@cs.utk.edu

* @author  Haihang You

*	       you@cs.utk.edu

* @author  Kevin London

*	       london@cs.utk.edu

* @author  Maynard Johnson

*          maynardj@us.ibm.com

*

* @brief Return codes and api definitions.

*/

#ifndef _PAPI

#define _PAPI

#pragma GCC visibility push(default)

/**

 * @mainpage PAPI

 *  

 * @section papi_intro Introduction

 * The PAPI Performance Application Programming Interface provides machine and 

 * operating system independent access to hardware performance counters found 

 * on most modern processors. 

 * Any of over 100 preset events can be counted through either a simple high 

 * level programming interface or a more complete low level interface from 

 * either C or Fortran. 

 * A list of the function calls in these interfaces is given below, 

 * with references to other pages for more complete details. 

 *

 * @section papi_high_api High Level Functions

 * A simple interface for instrumenting end-user applications. 

 * Fully supported on both C and Fortran. 

 * See individual functions for details on usage.

 * 

 *	@ref high_api

 * 

 * Note that the high-level interface is self-initializing. 

 * You can mix high and low level calls, but you @b must call either 

 * @ref PAPI_library_init() or a high level routine before calling a low level routine.

 *

 * @section papi_low_api Low Level Functions

 * Advanced interface for all applications and performance tools.

 * Some functions may be implemented only for C or Fortran.

 * See individual functions for details on usage and support.

 * 

 * @ref low_api

 *

 * @section papi_Fortran Fortran API

 * The Fortran interface has some unique features and entry points.

 * See individual functions for details.

 * 

 * @ref PAPIF

 *

 * @section Components 

 *

 *	Components provide access to hardware information on specific subsystems.

 *

 *	Components can be found under the conponents directory or @ref papi_components "here". 

 *	and included in a build as an argument to configure, 

 *	'--with-components=< comma_seperated_list_of_components_to_build >'

 * 

 * @section papi_util PAPI Utility Commands

 * 
 

 *		
 @ref papi_avail - provides availability and detail information for PAPI preset events

 *		
 @ref papi_clockres - provides availability and detail information for PAPI preset events

 *		
 @ref papi_cost - provides availability and detail information for PAPI preset events

 *		
 @ref papi_command_line - executes PAPI preset or native events from the command line

 *		
 @ref papi_decode -	decodes PAPI preset events into a csv format suitable for 

 *							PAPI_encode_events

 *		
 @ref papi_event_chooser -	given a list of named events, lists other events 

 *										that can be counted with them

 *		
 @ref papi_mem_info -	provides information on the memory architecture 

									of the current processor

 *		
 @ref papi_native_avail - provides detailed information for PAPI native events 

 * 

 * @see The PAPI Website http://icl.cs.utk.edu/papi

 */

/** \htmlonly

  * @page CDI PAPI Component Development Interface

  * @par \em Introduction

  *		PAPI-C consists of a Framework and between 1 and 16 Components. 

  *		The Framework is platform independent and exposes the PAPI API to end users. 

  *		The Components provide access to hardware information on specific subsystems. 

  *		By convention, Component 0 is always a CPU Component. 

  *		This allows default behavior for legacy code, and provides a universal 

  *		place to define system-wide operations and parameters, 

  *		like clock rates and interrupt structures. 

  *		Currently only a single CPU Component can exist at a time. 

  *

  * @par No CPU

  *		In certain cases it can be desirable to use a generic CPU component for 

  *		testing instrumentation or for operation on systems that don't provide 

  *		the proper patches for accessing cpu counters. 

  *		For such a case, the configure option: 

  *	@code

  *		configure --with-no-cpu-counters = yes

  *	@endcode 

  *	is provided to build PAPI with an "empty" cpu component.

  *

  *	@par Exposed Interface

  *		A Component for PAPI-C typically consists of a single header file and a 

  *		single (or small number of) source file(s). 

  *		All of the information for a Component needed by PAPI-C is exposed through 

  *		a single data structure that is declared and initialized at the bottom 

  *		of the main source file. 

  *		This structure, @ref papi_vector_t , is defined in @ref papi_vector.h .

  *	

  *	@par Compiling With an Existing Component 

  *		Components provided with the PAPI source distribution all appear in the 

  *		src/components directory. 

  *		Each component exists in its own directory, named the same as the component itself. 

  *		To include a component in a PAPI build, use the configure command line as shown:

  *	

  *	@code

  *		configure --with-components="component list"

  *	@endcode

  *	

  * Replace the "component list" argument with either the name of a specific 

  *	component directory or multiple component names separated by spaces and 

  *	enclosed in quotes as shown below:

  *

  *	\c configure --with-components="acpi lustre infiniband"

  *

  *	In some cases components themselves require additional configuration. 

  *	In these cases an error message will be produced when you run @code make @endcode . 

  *	To fix this, run the configure script found in the component directory.

  * 

  *	@par Adding a New Component 

  *	The mechanics of adding a new component to the PAPI 4.1 build are relatively straight-forward.

  *	Add a directory to the papi/src/components directory that is named with 

  *	the base name of the component. 

  *	This directory will contain the source files and build files for the new component. 

  *	If configuration of the component is necessary, 

  *	additional configure and make files will be needed. 

  *	The /example directory can be cloned and renamed as a starting point. 

  *	Other components can be used as examples. 

  *	This is described in more detail in /components/README.

  *

  *	@par Developing a New Component 

  *		A PAPI-C component generally consists of a header file and one or a 

  *		small number of source files. 

  *		The source file must contain a @ref papi_vector_t structure that 

  *		exposes the internal data and entry points of the component to the PAPI-C Framework. 

  *		This structure must have a unique name that is exposed externally and 

  *		contains the name of the directory containing the component source code.

  *

  *	Three types of information are exposed in the @ref papi_vector_t structure:

  *		Configuration parameters are contained in the @ref PAPI_component_info_t structure;

  *		Sizes of opaque data structures necessary for memory management are in the @ref cmp_struct_sizes_t structure;

  *		An array of function entry points which, if implemented, provide access to the functionality of the component.

  *

  *	If a function is not implemented in a given component its value in the structure can be left unset. 

  *	In this case it will be initialized to NULL, and result (generally) in benign, although unproductive, behavior.

  *

  *	During the development of a component, functions can be implemented and tested in blocks. 

  *	Further information about an appropriate order for developing these functions 

  *	can be found in the Component Development Cookbook .

  *

  * @par PAPI-C Open Research Issues:

  *	

  *	
 Support for non-standard data types: 

  *		Currently PAPI supports returned data values expressed as unsigned 64-bit integers. 

  *		This is appropriate for counting events, but may not be as appropriate 

  *		for expressing other values. 

  *		Examples of some other possible data types are shown below. 

  *		Data type might be expressed as a flag in the event definition.

  *	
 Signed Integer

  *		

  *		
Float: 64-bit IEEE double precision

  *		
Fixed Point: 32-bit integer and 32-bit fraction

  *		
Ratios: 32 bit numerator and 32 bit denominator

  *		

  *	
 Synchronization:

  *		Components might report values with widely different time scales and 

  *		remote measurements may be significantly skewed in time from local measurements. 

  *		It would be desirable to have a mechanism to synchronize these values in time.

  *	
 Dynamic Component Discovery:

  *		Components currently must be included statically in the PAPI library build. 

  *		This minimizes startup disruption and time lag, particularly for large parallel systems. 

  *		In some instances it would also be desirable to support a run-time 

  *		discovery process for components, possibly by searching a specific 

  *		location for dynamic libraries.

  *	
 Component Repository:

  *		A small collection of components are currently maintained and 

  *		supported inside the PAPI source distribution. 

  *		It would be desirable to create a public component repository where 3rd 

  *		parties could submit components for the use and benefit of the larger community.

  *	
 Multiple CPU Components:

  *		With the rise in popularity of heterogeneous computing systems, it may 

  *		become desirable to have more than one CPU component. 

  *		Issues must then be resolved relating to which cpu time-base is used, 

  *		how are interrupts handled, etc. 

  *	

  * \endhtmlonly

  */

/* Definition of PAPI_VERSION format.  Note that each of the four 

 * components _must_ be less than 256.  Also, the PAPI_VER_CURRENT

 * masks out the revision and increment.  Any revision change is supposed 

 * to be binary compatible between the user application code and the 

 * run-time library. Any modification that breaks this compatibility 

 * _should_ modify the minor version number as to force user applications 

 * to re-compile.

 */

#define PAPI_VERSION_NUMBER(maj,min,rev,inc) (((maj)<<24) | ((min)<<16) | ((rev)<<8) | (inc))

#define PAPI_VERSION_MAJOR(x)   	(((x)>>24)    & 0xff)

#define PAPI_VERSION_MINOR(x)		(((x)>>16)    & 0xff)

#define PAPI_VERSION_REVISION(x)	(((x)>>8)     & 0xff)

#define PAPI_VERSION_INCREMENT(x)((x)          & 0xff)

/* This is the official PAPI version */

/* The final digit represents the patch count */

#define PAPI_VERSION  			PAPI_VERSION_NUMBER(5,6,0,0)

#define PAPI_VER_CURRENT 		(PAPI_VERSION & 0xffff0000)

  /* Tests for checking event code type */

#define IS_NATIVE( EventCode ) ( ( EventCode & PAPI_NATIVE_MASK ) && !(EventCode & PAPI_PRESET_MASK) )

#define IS_PRESET( EventCode ) ( ( EventCode & PAPI_PRESET_MASK ) && !(EventCode & PAPI_NATIVE_MASK) )

#define IS_USER_DEFINED( EventCode ) ( ( EventCode & PAPI_PRESET_MASK ) && (EventCode & PAPI_NATIVE_MASK) )

#ifdef __cplusplus

extern "C"

{

#endif

/* Include files */

#include <sys/types.h>

#include <limits.h>

#include "papiStdEventDefs.h"

/** \internal 

@defgroup ret_codes Return Codes

Return Codes

All of the functions contained in the PerfAPI return standardized error codes.

Values greater than or equal to zero indicate success, less than zero indicates

failure. 

@{

*/

#define PAPI_OK          0     /**< No error */

#define PAPI_EINVAL     -1     /**< Invalid argument */

#define PAPI_ENOMEM     -2     /**< Insufficient memory */

#define PAPI_ESYS       -3     /**< A System/C library call failed */

#define PAPI_ECMP       -4     /**< Not supported by component */

#define PAPI_ESBSTR     -4     /**< Backwards compatibility */

#define PAPI_ECLOST     -5     /**< Access to the counters was lost or interrupted */

#define PAPI_EBUG       -6     /**< Internal error, please send mail to the developers */

#define PAPI_ENOEVNT    -7     /**< Event does not exist */

#define PAPI_ECNFLCT    -8     /**< Event exists, but cannot be counted due to counter resource limitations */

#define PAPI_ENOTRUN    -9     /**< EventSet is currently not running */

#define PAPI_EISRUN     -10    /**< EventSet is currently counting */

#define PAPI_ENOEVST    -11    /**< No such EventSet Available */

#define PAPI_ENOTPRESET -12    /**< Event in argument is not a valid preset */

#define PAPI_ENOCNTR    -13    /**< Hardware does not support performance counters */

#define PAPI_EMISC      -14    /**< Unknown error code */

#define PAPI_EPERM      -15    /**< Permission level does not permit operation */

#define PAPI_ENOINIT    -16    /**< PAPI hasn't been initialized yet */

#define PAPI_ENOCMP     -17    /**< Component Index isn't set */

#define PAPI_ENOSUPP    -18    /**< Not supported */

#define PAPI_ENOIMPL    -19    /**< Not implemented */

#define PAPI_EBUF       -20    /**< Buffer size exceeded */

#define PAPI_EINVAL_DOM -21    /**< EventSet domain is not supported for the operation */

#define PAPI_EATTR		-22    /**< Invalid or missing event attributes */

#define PAPI_ECOUNT		-23    /**< Too many events or attributes */

#define PAPI_ECOMBO		-24    /**< Bad combination of features */

#define PAPI_NUM_ERRORS	 25    /**< Number of error messages specified in this API */

#define PAPI_NOT_INITED		0

#define PAPI_LOW_LEVEL_INITED 	1       /* Low level has called library init */

#define PAPI_HIGH_LEVEL_INITED 	2       /* High level has called library init */

#define PAPI_THREAD_LEVEL_INITED 4      /* Threads have been inited */

/** @} */

/** @internal 

@defgroup consts Constants

All of the functions in the PerfAPI should use the following set of constants.

@{

*/

#define PAPI_NULL       -1      /**

/** @internal  

	@defgroup domain_defns Domain definitions 

 	@{ */

#define PAPI_DOM_USER    0x1    /**< User context counted */

#define PAPI_DOM_MIN     PAPI_DOM_USER

#define PAPI_DOM_KERNEL	 0x2    /**< Kernel/OS context counted */

#define PAPI_DOM_OTHER	 0x4    /**< Exception/transient mode (like user TLB misses ) */

#define PAPI_DOM_SUPERVISOR 0x8 /**< Supervisor/hypervisor context counted */

#define PAPI_DOM_ALL	 (PAPI_DOM_USER|PAPI_DOM_KERNEL|PAPI_DOM_OTHER|PAPI_DOM_SUPERVISOR) /**< All contexts counted */

/* #define PAPI_DOM_DEFAULT PAPI_DOM_USER NOW DEFINED BY COMPONENT */

#define PAPI_DOM_MAX     PAPI_DOM_ALL

#define PAPI_DOM_HWSPEC  0x80000000     /**< Flag that indicates we are not reading CPU like stuff.

                                           The lower 31 bits can be decoded by the component into something

                                           meaningful. i.e. SGI HUB counters */

/** @} */

/** @internal 

 *	@defgroup thread_defns Thread Definitions 

 *		We define other levels in papi_internal.h

 *		for internal PAPI use, so if you change anything

 *		make sure to look at both places -KSL

 *	@{ */

#define PAPI_USR1_TLS		0x0

#define PAPI_USR2_TLS		0x1

#define PAPI_HIGH_LEVEL_TLS     0x2

#define PAPI_NUM_TLS		0x3

#define PAPI_TLS_USR1		PAPI_USR1_TLS

#define PAPI_TLS_USR2		PAPI_USR2_TLS

#define PAPI_TLS_HIGH_LEVEL     PAPI_HIGH_LEVEL_TLS

#define PAPI_TLS_NUM		PAPI_NUM_TLS

#define PAPI_TLS_ALL_THREADS	0x10

/** @} */

/** @internal 

 *	@defgroup locking_defns Locking Mechanisms defines 

 *	@{ */

#define PAPI_USR1_LOCK          	0x0    /**< User controlled locks */

#define PAPI_USR2_LOCK          	0x1    /**< User controlled locks */

#define PAPI_NUM_LOCK           	0x2    /**< Used with setting up array */

#define PAPI_LOCK_USR1          	PAPI_USR1_LOCK

#define PAPI_LOCK_USR2          	PAPI_USR2_LOCK

#define PAPI_LOCK_NUM			PAPI_NUM_LOCK

/** @} */

/* Remove this!  If it breaks userspace we might have to add it back :( */

/* #define PAPI_MPX_DEF_DEG 32			                        */

/**	@internal 

	@defgroup papi_vendors  Vendor definitions 

	@{ */

#define PAPI_VENDOR_UNKNOWN 0

#define PAPI_VENDOR_INTEL   1

#define PAPI_VENDOR_AMD     2

#define PAPI_VENDOR_IBM     3

#define PAPI_VENDOR_CRAY    4

#define PAPI_VENDOR_SUN     5

#define PAPI_VENDOR_FREESCALE 6

#define PAPI_VENDOR_ARM     7

#define PAPI_VENDOR_MIPS    8

/** @} */

/** @internal 

 *	@defgroup granularity_defns Granularity definitions 

 *	@{ */

#define PAPI_GRN_THR     0x1    /**< PAPI counters for each individual thread */

#define PAPI_GRN_MIN     PAPI_GRN_THR

#define PAPI_GRN_PROC    0x2    /**< PAPI counters for each individual process */

#define PAPI_GRN_PROCG   0x4    /**< PAPI counters for each individual process group */

#define PAPI_GRN_SYS     0x8    /**< PAPI counters for the current CPU, are you bound? */

#define PAPI_GRN_SYS_CPU 0x10   /**< PAPI counters for all CPUs individually */

#define PAPI_GRN_MAX     PAPI_GRN_SYS_CPU

/** @} */

/** @internal 

	@defgroup evt_states States of an EventSet 

	@{ */

#define PAPI_STOPPED      0x01  /**< EventSet stopped */

#define PAPI_RUNNING      0x02  /**< EventSet running */

#define PAPI_PAUSED       0x04  /**< EventSet temp. disabled by the library */

#define PAPI_NOT_INIT     0x08  /**< EventSet defined, but not initialized */

#define PAPI_OVERFLOWING  0x10  /**< EventSet has overflowing enabled */

#define PAPI_PROFILING    0x20  /**< EventSet has profiling enabled */

#define PAPI_MULTIPLEXING 0x40  /**< EventSet has multiplexing enabled */

#define PAPI_ATTACHED	  0x80  /**< EventSet is attached to another thread/process */

#define PAPI_CPU_ATTACHED 0x100 /**< EventSet is attached to a specific cpu (not counting thread of execution) */

/** @} */

/** @internal 

	@defgroup error_predef Error predefines 

	@{ */

#define PAPI_QUIET       0      /**< Option to turn off automatic reporting of return codes < 0 to stderr. */

#define PAPI_VERB_ECONT  1      /**< Option to automatically report any return codes < 0 to stderr and continue. */

#define PAPI_VERB_ESTOP  2      /**< Option to automatically report any return codes < 0 to stderr and exit. */

/** @} */

/** @internal 

	@defgroup profile_defns Profile definitions 

	@{ */

#define PAPI_PROFIL_POSIX     0x0        /**< Default type of profiling, similar to 'man profil'. */

#define PAPI_PROFIL_RANDOM    0x1        /**< Drop a random 25% of the samples. */

#define PAPI_PROFIL_WEIGHTED  0x2        /**< Weight the samples by their value. */

#define PAPI_PROFIL_COMPRESS  0x4        /**< Ignore samples if hash buckets get big. */

#define PAPI_PROFIL_BUCKET_16 0x8        /**< Use 16 bit buckets to accumulate profile info (default) */

#define PAPI_PROFIL_BUCKET_32 0x10       /**< Use 32 bit buckets to accumulate profile info */

#define PAPI_PROFIL_BUCKET_64 0x20       /**< Use 64 bit buckets to accumulate profile info */

#define PAPI_PROFIL_FORCE_SW  0x40       /**< Force Software overflow in profiling */

#define PAPI_PROFIL_DATA_EAR  0x80       /**< Use data address register profiling */

#define PAPI_PROFIL_INST_EAR  0x100      /**< Use instruction address register profiling */

#define PAPI_PROFIL_BUCKETS   (PAPI_PROFIL_BUCKET_16 | PAPI_PROFIL_BUCKET_32 | PAPI_PROFIL_BUCKET_64)

/** @} */

/* @defgroup overflow_defns Overflow definitions 

   @{ */

#define PAPI_OVERFLOW_FORCE_SW 0x40	/**< Force using Software */

#define PAPI_OVERFLOW_HARDWARE 0x80	/**< Using Hardware */

/** @} */

/** @internal 

  *	@defgroup mpx_defns Multiplex flags definitions 

  * @{ */

#define PAPI_MULTIPLEX_DEFAULT	0x0	/**< Use whatever method is available, prefer kernel of course. */

#define PAPI_MULTIPLEX_FORCE_SW 0x1	/**< Force PAPI multiplexing instead of kernel */

/** @} */

/** @internal 

	@defgroup option_defns Option definitions 

	@{ */

#define PAPI_INHERIT_ALL  1     /**< The flag to this to inherit all children's counters */

#define PAPI_INHERIT_NONE 0     /**< The flag to this to inherit none of the children's counters */

#define PAPI_DETACH			1		/**< Detach */

#define PAPI_DEBUG          2       /**< Option to turn on  debugging features of the PAPI library */

#define PAPI_MULTIPLEX 		3       /**< Turn on/off or multiplexing for an eventset */

#define PAPI_DEFDOM  		4       /**< Domain for all new eventsets. Takes non-NULL option pointer. */

#define PAPI_DOMAIN  		5       /**< Domain for an eventset */

#define PAPI_DEFGRN  		6       /**< Granularity for all new eventsets */

#define PAPI_GRANUL  		7       /**< Granularity for an eventset */

#define PAPI_DEF_MPX_NS     8       /**< Multiplexing/overflowing interval in ns, same as PAPI_DEF_ITIMER_NS */

  //#define PAPI_EDGE_DETECT    9       /**< Count cycles of events if supported [not implemented] */

  //#define PAPI_INVERT         10		/**< Invert count detect if supported [not implemented] */

#define PAPI_MAX_MPX_CTRS	11      /**< Maximum number of counters we can multiplex */

#define PAPI_PROFIL  		12      /**< Option to turn on the overflow/profil reporting software [not implemented] */

#define PAPI_PRELOAD 		13      /**< Option to find out the environment variable that can preload libraries */

#define PAPI_CLOCKRATE  	14      /**< Clock rate in MHz */

#define PAPI_MAX_HWCTRS 	15      /**< Number of physical hardware counters */

#define PAPI_HWINFO  		16      /**< Hardware information */

#define PAPI_EXEINFO  		17      /**< Executable information */

#define PAPI_MAX_CPUS 		18      /**< Number of ncpus we can talk to from here */

#define PAPI_ATTACH			19      /**< Attach to a another tid/pid instead of ourself */

#define PAPI_SHLIBINFO      20      /**< Shared Library information */

#define PAPI_LIB_VERSION    21      /**< Option to find out the complete version number of the PAPI library */

#define PAPI_COMPONENTINFO  22      /**< Find out what the component supports */

/* Currently the following options are only available on Itanium; they may be supported elsewhere in the future */

#define PAPI_DATA_ADDRESS   23      /**< Option to set data address range restriction */

#define PAPI_INSTR_ADDRESS  24      /**< Option to set instruction address range restriction */

#define PAPI_DEF_ITIMER		25		/**< Option to set the type of itimer used in both software multiplexing, overflowing and profiling */

#define PAPI_DEF_ITIMER_NS	26		/**< Multiplexing/overflowing interval in ns, same as PAPI_DEF_MPX_NS */

/* Currently the following options are only available on systems using the perf_events component within papi */

#define PAPI_CPU_ATTACH		27      /**< Specify a cpu number the event set should be tied to */

#define PAPI_INHERIT		28      /**< Option to set counter inheritance flag */

#define PAPI_USER_EVENTS_FILE 29	/**< Option to set file from where to parse user defined events */

#define PAPI_INIT_SLOTS    64     /*Number of initialized slots in

                                   DynamicArray of EventSets */

#define PAPI_MIN_STR_LEN        64      /* For small strings, like names & stuff */

#define PAPI_MAX_STR_LEN       128      /* For average run-of-the-mill strings */

#define PAPI_2MAX_STR_LEN      256      /* For somewhat longer run-of-the-mill strings */

#define PAPI_HUGE_STR_LEN     1024      /* This should be defined in terms of a system parameter */

#define PAPI_PMU_MAX           40      /* maximum number of pmu's supported by one component */

#define PAPI_DERIVED           0x1      /* Flag to indicate that the event is derived */

/** @} */

/** Possible values for the 'modifier' parameter of the PAPI_enum_event call.

   A value of 0 (PAPI_ENUM_EVENTS) is always assumed to enumerate ALL 

   events on every platform.

   PAPI PRESET events are broken into related event categories.

   Each supported component can have optional values to determine how 

   native events on that component are enumerated.

*/

enum {

   PAPI_ENUM_EVENTS = 0,		/**< Always enumerate all events */

   PAPI_ENUM_FIRST,				/**< Enumerate first event (preset or native) */

   PAPI_PRESET_ENUM_AVAIL, 		/**< Enumerate events that exist here */

   /* PAPI PRESET section */

   PAPI_PRESET_ENUM_MSC,		/**< Miscellaneous preset events */

   PAPI_PRESET_ENUM_INS,		/**< Instruction related preset events */

   PAPI_PRESET_ENUM_IDL,		/**< Stalled or Idle preset events */

   PAPI_PRESET_ENUM_BR,			/**< Branch related preset events */

   PAPI_PRESET_ENUM_CND,		/**< Conditional preset events */

   PAPI_PRESET_ENUM_MEM,		/**< Memory related preset events */

   PAPI_PRESET_ENUM_CACH,		/**< Cache related preset events */

   PAPI_PRESET_ENUM_L1,			/**< L1 cache related preset events */

   PAPI_PRESET_ENUM_L2,			/**< L2 cache related preset events */

   PAPI_PRESET_ENUM_L3,			/**< L3 cache related preset events */

   PAPI_PRESET_ENUM_TLB,		/**< Translation Lookaside Buffer events */

   PAPI_PRESET_ENUM_FP,			/**< Floating Point related preset events */

   /* PAPI native event related section */

   PAPI_NTV_ENUM_UMASKS,		/**< all individual bits for given group */

   PAPI_NTV_ENUM_UMASK_COMBOS,	/**< all combinations of mask bits for given group */

   PAPI_NTV_ENUM_IARR,			/**< Enumerate events that support IAR (instruction address ranging) */

   PAPI_NTV_ENUM_DARR,			/**< Enumerate events that support DAR (data address ranging) */

   PAPI_NTV_ENUM_OPCM,			/**< Enumerate events that support OPC (opcode matching) */

   PAPI_NTV_ENUM_IEAR,			/**< Enumerate IEAR (instruction event address register) events */

   PAPI_NTV_ENUM_DEAR,			/**< Enumerate DEAR (data event address register) events */

   PAPI_NTV_ENUM_GROUPS			/**< Enumerate groups an event belongs to (e.g. POWER5) */

};

#define PAPI_ENUM_ALL PAPI_ENUM_EVENTS

#define PAPI_PRESET_BIT_MSC		(1 << PAPI_PRESET_ENUM_MSC)	/* Miscellaneous preset event bit */

#define PAPI_PRESET_BIT_INS		(1 << PAPI_PRESET_ENUM_INS)	/* Instruction related preset event bit */

#define PAPI_PRESET_BIT_IDL		(1 << PAPI_PRESET_ENUM_IDL)	/* Stalled or Idle preset event bit */

#define PAPI_PRESET_BIT_BR		(1 << PAPI_PRESET_ENUM_BR)	/* branch related preset events */

#define PAPI_PRESET_BIT_CND		(1 << PAPI_PRESET_ENUM_CND)	/* conditional preset events */

#define PAPI_PRESET_BIT_MEM		(1 << PAPI_PRESET_ENUM_MEM)	/* memory related preset events */

#define PAPI_PRESET_BIT_CACH	(1 << PAPI_PRESET_ENUM_CACH)	/* cache related preset events */

#define PAPI_PRESET_BIT_L1		(1 << PAPI_PRESET_ENUM_L1)	/* L1 cache related preset events */

#define PAPI_PRESET_BIT_L2		(1 << PAPI_PRESET_ENUM_L2)	/* L2 cache related preset events */

#define PAPI_PRESET_BIT_L3		(1 << PAPI_PRESET_ENUM_L3)	/* L3 cache related preset events */

#define PAPI_PRESET_BIT_TLB		(1 << PAPI_PRESET_ENUM_TLB)	/* Translation Lookaside Buffer events */

#define PAPI_PRESET_BIT_FP		(1 << PAPI_PRESET_ENUM_FP)	/* Floating Point related preset events */

#define PAPI_NTV_GROUP_AND_MASK		0x00FF0000	/* bits occupied by group number */

#define PAPI_NTV_GROUP_SHIFT		16			/* bit shift to encode group number */

/** @} */

/* 

The Low Level API

The following functions represent the low level portion of the

PerfAPI. These functions provide greatly increased efficiency and

functionality over the high level API presented in the next

section. All of the following functions are callable from both C and

Fortran except where noted. As mentioned in the introduction, the low

level API is only as powerful as the component upon which it is

built. Thus some features may not be available on every platform. The

converse may also be true, that more advanced features may be

available and defined in the header file.  The user is encouraged to

read the documentation carefully.  */

#include <signal.h>

/*  Earlier versions of PAPI define a special long_long type to mask

	an incompatibility between the Windows compiler and gcc-style compilers.

	That problem no longer exists, so long_long has been purged from the source.

	The defines below preserve backward compatibility. Their use is deprecated,

	but will continue to be supported in the near term.

*/

#define long_long long long

#define u_long_long unsigned long long

/** @defgroup papi_data_structures PAPI Data Structures */

	typedef unsigned long PAPI_thread_id_t;

	/** @ingroup papi_data_structures */

	typedef struct _papi_all_thr_spec {

     int num;

     PAPI_thread_id_t *id;

     void **data;

   } PAPI_all_thr_spec_t;

  typedef void (*PAPI_overflow_handler_t) (int EventSet, void *address,

                                long long overflow_vector, void *context);

        /* Handle C99 and more recent compilation */

	/* caddr_t was never approved by POSIX and is obsolete */

	/* We should probably switch all caddr_t to void * or long */

#ifdef __STDC_VERSION__

  #if (__STDC_VERSION__ >= 199901L)

	typedef char *caddr_t;

  #else

  #endif

#endif

	/** @ingroup papi_data_structures */

   typedef struct _papi_sprofil {

      void *pr_base;          /**< buffer base */

      unsigned pr_size;       /**< buffer size */

      caddr_t pr_off;         /**< pc start address (offset) */

      unsigned pr_scale;      /**< pc scaling factor: 

                                 fixed point fraction

                                 0xffff ~= 1, 0x8000 == .5, 0x4000 == .25, etc.

                                 also, two extensions 0x1000 == 1, 0x2000 == 2 */

   } PAPI_sprofil_t;

/** @ingroup papi_data_structures */

   typedef struct _papi_itimer_option {

     int itimer_num;

     int itimer_sig;

     int ns;

     int flags;

   } PAPI_itimer_option_t;

/** @ingroup papi_data_structures */

   typedef struct _papi_inherit_option {

      int eventset;

      int inherit;

   } PAPI_inherit_option_t;

/** @ingroup papi_data_structures */

   typedef struct _papi_domain_option {

      int def_cidx; /**< this structure requires a component index to set default domains */

      int eventset;

      int domain;

   } PAPI_domain_option_t;

/**  @ingroup papi_data_structures*/

   typedef struct _papi_granularity_option {

      int def_cidx; /**< this structure requires a component index to set default granularity */

      int eventset;

      int granularity;

   } PAPI_granularity_option_t;

/** @ingroup papi_data_structures */

   typedef struct _papi_preload_option {

      char lib_preload_env[PAPI_MAX_STR_LEN];   

      char lib_preload_sep;

      char lib_dir_env[PAPI_MAX_STR_LEN];

      char lib_dir_sep;

   } PAPI_preload_info_t;

/** @ingroup papi_data_structures */

   typedef struct _papi_component_option {

     char name[PAPI_MAX_STR_LEN];            /**< Name of the component we're using */

     char short_name[PAPI_MIN_STR_LEN];      /**< Short name of component,

						to be prepended to event names */

     char description[PAPI_MAX_STR_LEN];     /**< Description of the component */

     char version[PAPI_MIN_STR_LEN];         /**< Version of this component */

     char support_version[PAPI_MIN_STR_LEN]; /**< Version of the support library */

     char kernel_version[PAPI_MIN_STR_LEN];  /**< Version of the kernel PMC support driver */

     char disabled_reason[PAPI_MAX_STR_LEN]; /**< Reason for failure of initialization */

     int disabled;   /**< 0 if enabled, otherwise error code from initialization */

     int CmpIdx;				/**< Index into the vector array for this component; set at init time */

     int num_cntrs;               /**< Number of hardware counters the component supports */

     int num_mpx_cntrs;           /**< Number of hardware counters the component or PAPI can multiplex supports */

     int num_preset_events;       /**< Number of preset events the component supports */

     int num_native_events;       /**< Number of native events the component supports */

     int default_domain;          /**< The default domain when this component is used */

     int available_domains;       /**< Available domains */ 

     int default_granularity;     /**< The default granularity when this component is used */

     int available_granularities; /**< Available granularities */

     int hardware_intr_sig;       /**< Signal used by hardware to deliver PMC events */

//   int opcode_match_width;      /**< Width of opcode matcher if exists, 0 if not */

     int component_type;          /**< Type of component */

     char *pmu_names[PAPI_PMU_MAX];         /**< list of pmu names supported by this component */

     int reserved[8];             /* */

     unsigned int hardware_intr:1;         /**< hw overflow intr, does not need to be emulated in software*/

     unsigned int precise_intr:1;          /**< Performance interrupts happen precisely */

     unsigned int posix1b_timers:1;        /**< Using POSIX 1b interval timers (timer_create) instead of setitimer */

     unsigned int kernel_profile:1;        /**< Has kernel profiling support (buffered interrupts or sprofil-like) */

     unsigned int kernel_multiplex:1;      /**< In kernel multiplexing */

//   unsigned int data_address_range:1;    /**< Supports data address range limiting */

//   unsigned int instr_address_range:1;   /**< Supports instruction address range limiting */

     unsigned int fast_counter_read:1;     /**< Supports a user level PMC read instruction */

     unsigned int fast_real_timer:1;       /**< Supports a fast real timer */

     unsigned int fast_virtual_timer:1;    /**< Supports a fast virtual timer */

     unsigned int attach:1;                /**< Supports attach */

     unsigned int attach_must_ptrace:1;	   /**< Attach must first ptrace and stop the thread/process*/

//   unsigned int edge_detect:1;           /**< Supports edge detection on events */

//   unsigned int invert:1;                /**< Supports invert detection on events */

//   unsigned int profile_ear:1;      	   /**< Supports data/instr/tlb miss address sampling */

//     unsigned int cntr_groups:1;           /**< Underlying hardware uses counter groups (e.g. POWER5)*/

     unsigned int cntr_umasks:1;           /**< counters have unit masks */

//   unsigned int cntr_IEAR_events:1;      /**< counters support instr event addr register */

//   unsigned int cntr_DEAR_events:1;      /**< counters support data event addr register */

//   unsigned int cntr_OPCM_events:1;      /**< counter events support opcode matching */

     /* This should be a granularity option */

     unsigned int cpu:1;                   /**< Supports specifying cpu number to use with event set */

     unsigned int inherit:1;               /**< Supports child processes inheriting parents counters */

     unsigned int reserved_bits:12;

   } PAPI_component_info_t;

/**  @ingroup papi_data_structures*/

   typedef struct _papi_mpx_info {

     int timer_sig;				/**< Signal number used by the multiplex timer, 0 if not: PAPI_SIGNAL */

     int timer_num;				/**< Number of the itimer or POSIX 1 timer used by the multiplex timer: PAPI_ITIMER */

     int timer_us;				/**< uS between switching of sets: PAPI_MPX_DEF_US */

   } PAPI_mpx_info_t;

   typedef int (*PAPI_debug_handler_t) (int code);

   /** @ingroup papi_data_structures */

   typedef struct _papi_debug_option {

      int level;

      PAPI_debug_handler_t handler;

   } PAPI_debug_option_t;

/** @ingroup papi_data_structures

	@brief get the executable's address space info */

   typedef struct _papi_address_map {

      char name[PAPI_HUGE_STR_LEN];

      caddr_t text_start;       /**< Start address of program text segment */

      caddr_t text_end;         /**< End address of program text segment */

      caddr_t data_start;       /**< Start address of program data segment */

      caddr_t data_end;         /**< End address of program data segment */

      caddr_t bss_start;        /**< Start address of program bss segment */

      caddr_t bss_end;          /**< End address of program bss segment */

   } PAPI_address_map_t;

/** @ingroup papi_data_structures

	@brief get the executable's info */

   typedef struct _papi_program_info {

      char fullname[PAPI_HUGE_STR_LEN];  /**< path + name */

      PAPI_address_map_t address_info;	 /**< executable's address space info */

   } PAPI_exe_info_t;

   /** @ingroup papi_data_structures */

   typedef struct _papi_shared_lib_info {

      PAPI_address_map_t *map;

      int count;

   } PAPI_shlib_info_t;

/** Specify the file containing user defined events. */

typedef char* PAPI_user_defined_events_file_t;

   /* The following defines and next for structures define the memory heirarchy */

   /* All sizes are in BYTES */

   /* Associativity:

		0: Undefined;

		1: Direct Mapped

		SHRT_MAX: Full

		Other values == associativity

   */

#define PAPI_MH_TYPE_EMPTY    0x0

#define PAPI_MH_TYPE_INST     0x1

#define PAPI_MH_TYPE_DATA     0x2

#define PAPI_MH_TYPE_VECTOR   0x4

#define PAPI_MH_TYPE_TRACE    0x8

#define PAPI_MH_TYPE_UNIFIED  (PAPI_MH_TYPE_INST|PAPI_MH_TYPE_DATA)

#define PAPI_MH_CACHE_TYPE(a) (a & 0xf)

#define PAPI_MH_TYPE_WT       0x00	   /* write-through cache */

#define PAPI_MH_TYPE_WB       0x10	   /* write-back cache */

#define PAPI_MH_CACHE_WRITE_POLICY(a) (a & 0xf0)

#define PAPI_MH_TYPE_UNKNOWN  0x000

#define PAPI_MH_TYPE_LRU      0x100

#define PAPI_MH_TYPE_PSEUDO_LRU 0x200

#define PAPI_MH_CACHE_REPLACEMENT_POLICY(a) (a & 0xf00)

#define PAPI_MH_TYPE_TLB       0x1000  /* tlb, not memory cache */

#define PAPI_MH_TYPE_PREF      0x2000  /* prefetch buffer */

#define PAPI_MH_MAX_LEVELS    6		   /* # descriptors for each TLB or cache level */

#define PAPI_MAX_MEM_HIERARCHY_LEVELS 	  4

/** @ingroup papi_data_structures */

   typedef struct _papi_mh_tlb_info {

      int type; /**< Empty, instr, data, vector, unified */

      int num_entries;

      int page_size;

      int associativity;

   } PAPI_mh_tlb_info_t;

/** @ingroup papi_data_structures */

   typedef struct _papi_mh_cache_info {

      int type; /**< Empty, instr, data, vector, trace, unified */

      int size;

      int line_size;

      int num_lines;

      int associativity;

   } PAPI_mh_cache_info_t;

/** @ingroup papi_data_structures */

   typedef struct _papi_mh_level_info {

      PAPI_mh_tlb_info_t   tlb[PAPI_MH_MAX_LEVELS];

      PAPI_mh_cache_info_t cache[PAPI_MH_MAX_LEVELS];

   } PAPI_mh_level_t;

/**  @ingroup papi_data_structures

  *	 @brief mh for mem hierarchy maybe? */

   typedef struct _papi_mh_info { 

      int levels;

      PAPI_mh_level_t level[PAPI_MAX_MEM_HIERARCHY_LEVELS];

   } PAPI_mh_info_t;

/**  @ingroup papi_data_structures

  *  @brief Hardware info structure */

   typedef struct _papi_hw_info {

      int ncpu;                     /**< Number of CPUs per NUMA Node */

      int threads;                  /**< Number of hdw threads per core */

      int cores;                    /**< Number of cores per socket */

      int sockets;                  /**< Number of sockets */

      int nnodes;                   /**< Total Number of NUMA Nodes */

      int totalcpus;                /**< Total number of CPUs in the entire system */

      int vendor;                   /**< Vendor number of CPU */

      char vendor_string[PAPI_MAX_STR_LEN];     /**< Vendor string of CPU */

      int model;                    /**< Model number of CPU */

      char model_string[PAPI_MAX_STR_LEN];      /**< Model string of CPU */

      float revision;               /**< Revision of CPU */

      int cpuid_family;             /**< cpuid family */

      int cpuid_model;              /**< cpuid model */

      int cpuid_stepping;           /**< cpuid stepping */

      int cpu_max_mhz;              /**< Maximum supported CPU speed */

      int cpu_min_mhz;              /**< Minimum supported CPU speed */

      PAPI_mh_info_t mem_hierarchy; /**< PAPI memory heirarchy description */

      int virtualized;              /**< Running in virtual machine */

      char virtual_vendor_string[PAPI_MAX_STR_LEN]; 

                                    /**< Vendor for virtual machine */

      char virtual_vendor_version[PAPI_MAX_STR_LEN];

                                    /**< Version of virtual machine */

      /* Legacy Values, do not use */

      float mhz;                    /**< Deprecated */

      int clock_mhz;                /**< Deprecated */

      /* For future expansion */

      int reserved[8];

   } PAPI_hw_info_t;

/** @ingroup papi_data_structures */

   typedef struct _papi_attach_option {

      int eventset;

      unsigned long tid;

   } PAPI_attach_option_t;

/**  @ingroup papi_data_structures*/

      typedef struct _papi_cpu_option {

         int eventset;

         unsigned int cpu_num;

      } PAPI_cpu_option_t;

/** @ingroup papi_data_structures */

   typedef struct _papi_multiplex_option {

      int eventset;

      int ns;

      int flags;

   } PAPI_multiplex_option_t;

   /** @ingroup papi_data_structures 

	 *  @brief address range specification for range restricted counting if both are zero, range is disabled  */

   typedef struct _papi_addr_range_option { 

      int eventset;           /**< eventset to restrict */

      caddr_t start;          /**< user requested start address of an address range */

      caddr_t end;            /**< user requested end address of an address range */

      int start_off;          /**< hardware specified offset from start address */

      int end_off;            /**< hardware specified offset from end address */

   } PAPI_addr_range_option_t;

/** @ingroup papi_data_structures 

  *	@union PAPI_option_t

  *	@brief A pointer to the following is passed to PAPI_set/get_opt() */

	typedef union

	{

		PAPI_preload_info_t preload;

		PAPI_debug_option_t debug;

		PAPI_inherit_option_t inherit;

		PAPI_granularity_option_t granularity;

		PAPI_granularity_option_t defgranularity;

		PAPI_domain_option_t domain;

		PAPI_domain_option_t defdomain;

		PAPI_attach_option_t attach;

		PAPI_cpu_option_t cpu;

		PAPI_multiplex_option_t multiplex;

		PAPI_itimer_option_t itimer;

		PAPI_hw_info_t *hw_info;

		PAPI_shlib_info_t *shlib_info;

		PAPI_exe_info_t *exe_info;

		PAPI_component_info_t *cmp_info;

		PAPI_addr_range_option_t addr;

		PAPI_user_defined_events_file_t events_file;

	} PAPI_option_t;

/** @ingroup papi_data_structures

  *	@brief A pointer to the following is passed to PAPI_get_dmem_info() */

	typedef struct _dmem_t {

	  long long peak;

	  long long size;

	  long long resident;

	  long long high_water_mark;

	  long long shared;

	  long long text;

	  long long library;

	  long long heap;

	  long long locked;