cpc_version(3cpc) [sunos man page]

cpc_version(3CPC)														 cpc_version(3CPC)

NAME

       cpc_version - coordinate CPC library and application versions

SYNOPSIS

       cc [ flag... ] file... -lcpc [ library... ]
       #include <libcpc.h>

       uint_t cpc_version(uint_t version);

       The  cpc_version()  function takes an interface version as an argument and returns an interface version as a result.  Usually, the argument
       will be the value of CPC_VER_CURRENT bound to the application when it was compiled.

       If the version requested is still supported by the implementation, cpc_version() returns the requested version number and  the  application
       can  use  the  facilities  of  the  library  on that platform.  If the implementation cannot support the version needed by the application,
       cpc_version() returns CPC_VER_NONE, indicating that the application will at least need to be recompiled to operate  correctly  on  the  new
       platform, and may require further changes.

       If version is CPC_VER_NONE, cpc_version() returns the most current version of the library.

       Example 1:  Protect an application from using an incompatible library.

       The following lines of code protect an application from using an incompatible library:

       if (cpc_version(CPC_VER_CURRENT) == CPC_VER_NONE) {
	       /* version mismatch - library cannot translate */
	       exit(1);
       }

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

       cpc(3CPC), cpc_open(3CPC), libcpc(3LIB), attributes(5)

       The  cpc_version()  function exists for binary compatibility only. Source containing this function will not compile. This function is obso-
       lete and might be removed in a future release. Applications should use cpc_open(3CPC) instead.

       The version number is used only to express incompatible semantic changes in the performance counter interfaces on the given platform within
       a  single  instruction  set  architecture, for example, when a new set of performance counter registers are added to  an existing processor
       family that cannot be specified in the existing cpc_event_t data structure.

								    28 Mar 2005 						 cpc_version(3CPC)

cpc_event(3CPC) 				    CPU Performance Counters Library Functions					   cpc_event(3CPC)

NAME

       cpc_event - data structure to describe CPU performance counters

SYNOPSIS

       #include <libcpc.h>

DESCRIPTION

       The libcpc interfaces manipulate CPU performance counters using the cpc_event_t data structure. This structure contains several fields that
       are common to all processors, and some that are processor-dependent. These structures can be declared by a consumer of the  API,  thus  the
       size  and  offsets  of  the  fields  and  the  entire data structure are fixed per processor for any particular version of the library. See
       cpc_version(3CPC) for details of library versioning.

   SPARC
       For UltraSPARC, the structure contains the following members:

	 typedef struct {
		 int ce_cpuver;
		 hrtime_t ce_hrt;
		 uint64_t ce_tick;
		 uint64_t ce_pic[2];
		 uint64_t ce_pcr;
	 } cpc_event_t;

   x86
       For Pentium, the structure contains the following members:

	 typedef struct {
		 int ce_cpuver;
		 hrtime_t ce_hrt;
		 uint64_t ce_tsc;
		 uint64_t ce_pic[2];
		 uint32_t ce_pes[2];
	 #define ce_cesr ce_pes[0]
	 } cpc_event_t;

       The APIs are used to manipulate the highly processor-dependent control registers (the ce_pcr, ce_cesr, and ce_pes fields);  the	programmer
       is  strongly  advised not to reference those fields directly in portable code. The ce_pic array elements contain 64-bit accumulated counter
       values.	The hardware registers are virtualized to 64-bit quantities even though the underlying hardware only supports 32-bits (UltraSPARC)
       or 40-bits (Pentium) before overflow.

       The  ce_hrt field is a high resolution timestamp taken at the time the counters were sampled by the kernel.  This uses the same timebase as
       gethrtime(3C).

       On SPARC V9 machines, the number of cycles spent running on the processor is computed from samples of the processor-dependent  %tick regis-
       ter,  and placed in the	ce_tick field. On Pentium processors, the processor-dependent time-stamp counter register is similarly sampled and
       placed in the ce_tsc field.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       gethrtime(3C), cpc(3CPC), cpc_version(3CPC), libcpc(3LIB), attributes(5)

SunOS 5.11							    12 May 2003 						   cpc_event(3CPC)