xref: /illumos-gate/usr/src/man/man3lib/libcpc.3lib (revision bbf21555)
te
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
Copyright 2019 Joyent, Inc.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
LIBCPC 3LIB "March 25, 2019"
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. A more detailed explanation of the library and a list of processor-specific events is available in cpc(3CPC).

INTERFACES

The shared object libcpc.so.1 provides the public interfaces defined below. See Intro(3) for additional information on shared object interfaces.

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_generic_events_all cpc_walk_generic_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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Safe
SEE ALSO

cputrack (1), Intro (3), cpc (3CPC), attributes (7), xVM (7), cpustat (8)

NOTES

There is no support for access to performance counters in the xVM(7) environment. The -h operations for cputrack(1) are not enabled.