Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

cpc_count_usr_events(3cpc) [opensolaris man page]

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

NAME
cpc_count_usr_events, cpc_count_sys_events - enable and disable performance counters SYNOPSIS
cc [ flag... ] file... -lcpc [ library... ] #include <libcpc.h> int cpc_count_usr_events(int enable); int cpc_count_sys_events(int enable); DESCRIPTION
In certain applications, it can be useful to explicitly enable and disable performance counters at different times so that the performance of a critical algorithm can be examined. The cpc_count_usr_events() function can be used to control whether events are counted on behalf of the application running in user mode, while cpc_count_sys_events() can be used to control whether events are counted on behalf of the application while it is running in the kernel, without otherwise disturbing the binding of events to the invoking LWP. If the enable argu- ment is non-zero, counting of events is enabled, otherwise they are disabled. RETURN VALUES
Upon successful completion, cpc_count_usr_events() and cpc_count_sys_events() return 0. Otherwise, the functions return -1 and set errno to indicate the error. ERRORS
The cpc_count_usr_events() and cpc_count_sys_events() functions will fail if: EAGAIN The associated performance counter context has been invalidated by another process. EINVAL No performance counter context has been created, or an attempt was made to enable system events while delivering counter over- flow signals. EXAMPLES
Example 1 Use cpc_count_usr_events() to minimize code needed by application. In this example, the routine cpc_count_usr_events() is used to minimize the amount of code that needs to be added to the application. The cputrack(1) command can be used in conjunction with these interfaces to provide event programming, sampling, and reporting facilities. If the application is instrumented in this way and then started by cputrack with the nouser flag set in the event specification, counting of user events will only be enabled around the critical code section of interest. If the program is run normally, no harm will ensue. int have_counters = 0; int main(int argc, char *argv[]) { if (cpc_version(CPC_VER_CURRENT) == CPC_VER_CURRENT && cpc_getcpuver() != -1 && cpc_access() == 0) have_counters = 1; /* ... other application code */ if (have_counters) (void) cpc_count_usr_events(1); /* ==> Code to be measured goes here <== */ if (have_counters) (void) cpc_count_usr_events(0); /* ... other application code */ } ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ |Interface Stability |Obsolete | +-----------------------------+-----------------------------+ SEE ALSO
cputrack(1), cpc(3CPC), cpc_access(3CPC), cpc_bind_event(3CPC), cpc_enable(3CPC), cpc_getcpuver(3CPC), cpc_pctx_bind_event(3CPC), cpc_ver- sion(3CPC), libcpc(3LIB), attributes(5) NOTES
The cpc_count_usr_events() and cpc_count_sys_events() functions exist for binary compatibility only. Source containing these functions will not compile. These functions are obsolete and might be removed in a future release. Applications should use cpc_enable(3CPC) instead. SunOS 5.11 28 Mar 2005 cpc_count_usr_events(3CPC)

Check Out this Related Man Page

libcpc(3LIB)							Interface Libraries						      libcpc(3LIB)

NAME
libcpc - CPU performance counter library SYNOPSIS
cc [ flag... ] file... -lcpc [ library... ] DESCRIPTION
Functions in this library provide access to CPU performance counters on platforms that contain the appropriate hardware. INTERFACES
The shared object libcpc.so.1 provides the public interfaces defined below. See intro(3) for additional information on shared object inter- faces. cpc_access cpc_bind_cpu cpc_bind_curlwp cpc_bind_event cpc_bind_pctx cpc_buf_add cpc_buf_copy cpc_buf_create cpc_buf_destroy cpc_buf_get cpc_buf_hrtime cpc_buf_set cpc_buf_sub cpc_buf_tick cpc_buf_zero cpc_caps cpc_cciname cpc_close cpc_cpuref cpc_count_sys_events cpc_count_usr_events cpc_disable cpc_enable cpc_event_accum cpc_event_diff cpc_eventtostr cpc_getcciname cpc_getcpuref cpc_getcpuver cpc_getnpic cpc_getusage cpc_npic cpc_open cpc_pctx_bind_event cpc_pctx_invalidate cpc_pctx_rele cpc_pctx_take_sample cpc_rele cpc_request_preset cpc_set_add_request cpc_set_create cpc_set_destroy cpc_set_restart cpc_set_sample cpc_seterrfn cpc_seterrhndlr cpc_shared_bind_event cpc_shared_close cpc_shared_open cpc_shared_rele cpc_shared_take_sample cpc_strtoevent cpc_take_sample cpc_unbind cpc_version cpc_walk_attrs cpc_walk_events_all cpc_walk_events_pic cpc_walk_names cpc_walk_requests FILES
/usr/lib/libcpc.so.1 shared object /usr/lib/64/libcpc.so.1 64-bit shared object ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWcpcu | +-----------------------------+-----------------------------+ |MT-Level |Safe | +-----------------------------+-----------------------------+ SEE ALSO
cputrack(1), cpustat(1M), intro(3), cpc(3CPC), attributes(5) SunOS 5.10 22 Jun 2004 libcpc(3LIB)
Man Page