usr/src/man/man3lib/libcpc.3lib

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH LIBCPC 3LIB "Oct 8, 2008"
   7 .SH NAME
   8 libcpc \- CPU performance counter library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lcpc\fR [ \fIlibrary\fR... ]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 Functions in this library provide access to CPU performance counters on
  19 platforms that contain the appropriate hardware.
  20 .SH INTERFACES
  21 .sp
  22 .LP
  23 The shared object \fBlibcpc.so.1\fR provides the public interfaces defined
  24 below. See \fBIntro\fR(3) for additional information on shared object
  25 interfaces.
  26 .sp
  27
  28 .sp
  29 .TS
  30 l l
  31 l l .
  32 \fBcpc_access\fR        \fBcpc_bind_cpu\fR
  33 \fBcpc_bind_curlwp\fR   \fBcpc_bind_event\fR
  34 \fBcpc_bind_pctx\fR     \fBcpc_buf_add\fR
  35 \fBcpc_buf_copy\fR      \fBcpc_buf_create\fR
  36 \fBcpc_buf_destroy\fR   \fBcpc_buf_get\fR
  37 \fBcpc_buf_hrtime\fR    \fBcpc_buf_set\fR
  38 \fBcpc_buf_sub\fR       \fBcpc_buf_tick\fR
  39 \fBcpc_buf_zero\fR      \fBcpc_caps\fR
  40 \fBcpc_cciname\fR       \fBcpc_close\fR
  41 \fBcpc_cpuref\fR        \fBcpc_count_sys_events\fR
  42 \fBcpc_count_usr_events\fR      \fBcpc_disable\fR
  43 \fBcpc_enable\fR        \fBcpc_event_accum\fR
  44 \fBcpc_event_diff\fR    \fBcpc_eventtostr\fR
  45 \fBcpc_getcciname\fR    \fBcpc_getcpuref\fR
  46 \fBcpc_getcpuver\fR     \fBcpc_getnpic\fR
  47 \fBcpc_getusage\fR      \fBcpc_npic\fR
  48 \fBcpc_open\fR  \fBcpc_pctx_bind_event\fR
  49 \fBcpc_pctx_invalidate\fR       \fBcpc_pctx_rele\fR
  50 \fBcpc_pctx_take_sample\fR      \fBcpc_rele\fR
  51 \fBcpc_request_preset\fR        \fBcpc_set_add_request\fR
  52 \fBcpc_set_create\fR    \fBcpc_set_destroy\fR
  53 \fBcpc_set_restart\fR   \fBcpc_set_sample\fR
  54 \fBcpc_seterrfn\fR      \fBcpc_seterrhndlr\fR
  55 \fBcpc_shared_bind_event\fR     \fBcpc_shared_close\fR
  56 \fBcpc_shared_open\fR   \fBcpc_shared_rele\fR
  57 \fBcpc_shared_take_sample\fR    \fBcpc_strtoevent\fR
  58 \fBcpc_take_sample\fR   \fBcpc_unbind\fR
  59 \fBcpc_version\fR       \fBcpc_walk_attrs\fR
  60 \fBcpc_walk_events_all\fR       \fBcpc_walk_events_pic\fR
  61 \fBcpc_walk_generic_events_all\fR       \fBcpc_walk_generic_events_pic\fR
  62 \fBcpc_walk_names\fR    \fBcpc_walk_requests\fR
  63 .TE
  64
  65 .SH FILES
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB/usr/lib/libcpc.so.1\fR\fR
  70 .ad
  71 .RS 27n
  72 shared object
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fB/usr/lib/64/libcpc.so.1\fR\fR
  79 .ad
  80 .RS 27n
  81 64-bit shared object
  82 .RE
  83
  84 .SH ATTRIBUTES
  85 .sp
  86 .LP
  87 See \fBattributes\fR(5) for descriptions of the following attributes:
  88 .sp
  89
  90 .sp
  91 .TS
  92 box;
  93 c | c
  94 l | l .
  95 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  96 MT-Level        Safe
  97 .TE
  98
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBcputrack\fR(1), \fBcpustat\fR(1M), \fBIntro\fR(3), \fBcpc\fR(3CPC),
 103 \fBattributes\fR(5), \fBxVM\fR(5)
 104 .SH NOTES
 105 .sp
 106 .LP
 107 There is no support for access to performance counters in the \fBxVM\fR(5)
 108 environment. The \fB-h\fR operations for \fBcputrack\fR(1) are not enabled.