lib/libpmc/pmc.3

   1 .\" Copyright (c) 2003-2008 Joseph Koshy.  All rights reserved.
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\"
  12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  22 .\" SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd November 24, 2008
  27 .Dt PMC 3
  28 .Os
  29 .Sh NAME
  30 .Nm pmc
  31 .Nd library for accessing hardware performance monitoring counters
  32 .Sh LIBRARY
  33 .Lb libpmc
  34 .Sh SYNOPSIS
  35 .In pmc.h
  36 .Sh DESCRIPTION
  37 The
  38 .Lb libpmc
  39 provides a programming interface that allows applications to use
  40 hardware performance counters to gather performance data about
  41 specific processes or for the system as a whole.
  42 The library is implemented using the lower-level facilities offered by
  43 the
  44 .Xr hwpmc 4
  45 driver.
  46 .Ss Key Concepts
  47 Performance monitoring counters (PMCs) are represented by the library
  48 using a software abstraction.
  49 These
  50 .Dq abstract
  51 PMCs can have two scopes:
  52 .Bl -bullet
  53 .It
  54 System scope.
  55 These PMCs measure events in a whole-system manner, i.e., independent
  56 of the currently executing thread.
  57 System scope PMCs are allocated on specific CPUs and do not
  58 migrate between CPUs.
  59 Non-privileged process are allowed to allocate system scope PMCs if the
  60 .Xr hwpmc 4
  61 sysctl tunable:
  62 .Va security.bsd.unprivileged_syspmcs
  63 is non-zero.
  64 .It
  65 Process scope.
  66 These PMCs only measure hardware events when the processes they are
  67 attached to are executing on a CPU.
  68 In an SMP system, process scope PMCs migrate between CPUs along with
  69 their target processes.
  70 .El
  71 .Pp
  72 Orthogonal to PMC scope, PMCs may be allocated in one of two
  73 operational modes:
  74 .Bl -bullet
  75 .It
  76 Counting PMCs measure events according to their scope
  77 (system or process).
  78 The application needs to explicitly read these counters
  79 to retrieve their value.
  80 .It
  81 Sampling PMCs cause the CPU to be periodically interrupted
  82 and information about its state of execution to be collected.
  83 Sampling PMCs are used to profile specific processes and kernel
  84 threads or to profile the system as a whole.
  85 .El
  86 .Pp
  87 The scope and operational mode for a software PMC are specified at
  88 PMC allocation time.
  89 An application is allowed to allocate multiple PMCs subject
  90 to availability of hardware resources.
  91 .Pp
  92 The library uses human-readable strings to name the event being
  93 measured by hardware.
  94 The syntax used for specifying a hardware event along with additional
  95 event specific qualifiers (if any) is described in detail in section
  96 .Sx "EVENT SPECIFIERS"
  97 below.
  98 .Pp
  99 PMCs are associated with the process that allocated them and
 100 will be automatically reclaimed by the system when the process exits.
 101 Additionally, process-scope PMCs have to be attached to one or more
 102 target processes before they can perform measurements.
 103 A process-scope PMC may be attached to those target processes
 104 that its owner process would otherwise be permitted to debug.
 105 An owner process may attach PMCs to itself allowing
 106 it to measure its own behavior.
 107 Additionally, on some machine architectures, such self-attached PMCs
 108 may be read cheaply using specialized instructions supported by the
 109 processor.
 110 .Pp
 111 Certain kinds of PMCs require that a log file be configured before
 112 they may be started.
 113 These include:
 114 .Bl -bullet -compact
 115 .It
 116 System scope sampling PMCs.
 117 .It
 118 Process scope sampling PMCs.
 119 .It
 120 Process scope counting PMCs that have been configured to report PMC
 121 readings on process context switches or process exits.
 122 .El
 123 Up to one log file may be configured per owner process.
 124 Events logged to a log file may be subsequently analyzed using the
 125 .Xr pmclog 3
 126 family of functions.
 127 .Ss Supported CPUs
 128 The CPUs known to the PMC library are named by the
 129 .Vt "enum pmc_cputype"
 130 enumeration.
 131 Supported CPUs include:
 132 .Bl -tag -width "Li PMC_CPU_INTEL_CORE2" -compact
 133 .It Li PMC_CPU_AMD_K7
 134 .Tn "AMD Athlon"
 135 CPUs.
 136 .It Li PMC_CPU_AMD_K8
 137 .Tn "AMD Athlon64"
 138 CPUs.
 139 .It Li PMC_CPU_INTEL_ATOM
 140 .Tn Intel
 141 .Tn Atom
 142 CPUs and other CPUs conforming to version 3 of the
 143 .Tn Intel
 144 performance measurement architecture.
 145 .It Li PMC_CPU_INTEL_CORE
 146 .Tn Intel
 147 .Tn Core Solo
 148 and
 149 .Tn Core Duo
 150 CPUs, and other CPUs conforming to version 1 of the
 151 .Tn Intel
 152 performance measurement architecture.
 153 .It Li PMC_CPU_INTEL_CORE2
 154 .Tn Intel
 155 .Tn "Core2 Solo" ,
 156 .Tn "Core2 Duo"
 157 and
 158 .Tn "Core2 Extreme"
 159 CPUs, and other CPUs conforming to version 2 of the
 160 .Tn Intel
 161 performance measurement architecture.
 162 .It Li PMC_CPU_INTEL_P5
 163 .Tn Intel
 164 .Tn "Pentium"
 165 CPUs.
 166 .It Li PMC_CPU_INTEL_P6
 167 .Tn Intel
 168 .Tn "Pentium Pro"
 169 CPUs.
 170 .It Li PMC_CPU_INTEL_PII
 171 .Tn "Intel Pentium II"
 172 CPUs.
 173 .It Li PMC_CPU_INTEL_PIII
 174 .Tn "Intel Pentium III"
 175 CPUs.
 176 .It Li PMC_CPU_INTEL_PIV
 177 .Tn "Intel Pentium 4"
 178 CPUs.
 179 .It Li PMC_CPU_INTEL_PM
 180 .Tn "Intel Pentium M"
 181 CPUs.
 182 .El
 183 .Ss Supported PMCs
 184 PMC supported by this library are named by the
 185 .Vt enum pmc_class
 186 enumeration.
 187 Supported PMC kinds include:
 188 .Bl -tag -width "Li PMC_CLASS_IAF" -compact
 189 .It Li PMC_CLASS_IAF
 190 Fixed function hardware counters presents in CPUs conforming to the
 191 .Tn Intel
 192 performance measurement architecture version 2 and later.
 193 .It Li PMC_CLASS_IAP
 194 Programmable hardware counters present in CPUs conforming to the
 195 .Tn Intel
 196 performance measurement architecture version 1 and later.
 197 .It Li PMC_CLASS_K7
 198 Programmable hardware counters present in
 199 .Tn "AMD Athlon"
 200 CPUs.
 201 .It Li PMC_CLASS_K8
 202 Programmable hardware counters present in
 203 .Tn "AMD Athlon64"
 204 CPUs.
 205 .It Li PMC_CLASS_P4
 206 Programmable hardware counters present in
 207 .Tn "Intel Pentium 4"
 208 CPUs.
 209 .It Li PMC_CLASS_P5
 210 Programmable hardware counters present in
 211 .Tn Intel
 212 .Tn Pentium
 213 CPUs.
 214 .It Li PMC_CLASS_P6
 215 Programmable hardware counters present in
 216 .Tn Intel
 217 .Tn "Pentium Pro" ,
 218 .Tn "Pentium II" ,
 219 .Tn "Pentium III" ,
 220 .Tn "Celeron" ,
 221 and
 222 .Tn "Pentium M"
 223 CPUs.
 224 .It Li PMC_CLASS_TSC
 225 The timestamp counter on i386 and amd64 architecture CPUs.
 226 .It Li PMC_CLASS_SOFT
 227 Software events.
 228 .El
 229 .Ss PMC Capabilities
 230 Capabilities of performance monitoring hardware are denoted using
 231 the
 232 .Vt "enum pmc_caps"
 233 enumeration.
 234 Supported capabilities include:
 235 .Bl -tag -width "Li PMC_CAP_INTERRUPT" -compact
 236 .It Li PMC_CAP_CASCADE
 237 The ability to cascade counters.
 238 .It Li PMC_CAP_EDGE
 239 The ability to count negated to asserted transitions of the hardware
 240 conditions being probed for.
 241 .It Li PMC_CAP_INTERRUPT
 242 The ability to interrupt the CPU.
 243 .It Li PMC_CAP_INVERT
 244 The ability to invert the sense of the hardware conditions being
 245 measured.
 246 .It Li PMC_CAP_PRECISE
 247 The ability to perform precise sampling.
 248 .It Li PMC_CAP_QUALIFIER
 249 The hardware allows monitored to be further qualified in some
 250 system dependent way.
 251 .It Li PMC_CAP_READ
 252 The ability to read from performance counters.
 253 .It Li PMC_CAP_SYSTEM
 254 The ability to restrict counting of hardware events to when the CPU is
 255 running privileged code.
 256 .It Li PMC_CAP_THRESHOLD
 257 The ability to ignore simultaneous hardware events below a
 258 programmable threshold.
 259 .It Li PMC_CAP_USER
 260 The ability to restrict counting of hardware events to those when the
 261 CPU is running unprivileged code.
 262 .It Li PMC_CAP_WRITE
 263 The ability to write to performance counters.
 264 .El
 265 .Ss CPU Naming Conventions
 266 CPUs are named using small integers from zero up to, but
 267 excluding, the value returned by function
 268 .Fn pmc_ncpu .
 269 On platforms supporting sparsely numbered CPUs not all the numbers in
 270 this range will denote valid CPUs.
 271 Operations on non-existent CPUs will return an error.
 272 .Ss Functional Grouping of the API
 273 This section contains a brief overview of the available functionality
 274 in the PMC library.
 275 Each function listed here is described further in its own manual page.
 276 .Bl -tag -width indent
 277 .It Administration
 278 .Bl -tag -compact
 279 .It Fn pmc_disable , Fn pmc_enable
 280 Administratively disable (enable) specific performance monitoring
 281 counter hardware.
 282 Counters that are disabled will not be available to applications to
 283 use.
 284 .El
 285 .It "Convenience Functions"
 286 .Bl -tag -compact
 287 .It Fn pmc_event_names_of_class
 288 Returns a list of event names supported by a given PMC type.
 289 .It Fn pmc_name_of_capability
 290 Convert a
 291 .Dv PMC_CAP_*
 292 flag to a human-readable string.
 293 .It Fn pmc_name_of_class
 294 Convert a
 295 .Dv PMC_CLASS_*
 296 constant to a human-readable string.
 297 .It Fn pmc_name_of_cputype
 298 Return a human-readable name for a CPU type.
 299 .It Fn pmc_name_of_disposition
 300 Return a human-readable string describing a PMC's disposition.
 301 .It Fn pmc_name_of_event
 302 Convert a numeric event code to a human-readable string.
 303 .It Fn pmc_name_of_mode
 304 Convert a
 305 .Dv PMC_MODE_*
 306 constant to a human-readable name.
 307 .It Fn pmc_name_of_state
 308 Return a human-readable string describing a PMC's current state.
 309 .El
 310 .It "Library Initialization"
 311 .Bl -tag -compact
 312 .It Fn pmc_init
 313 Initialize the library.
 314 This function must be called before any other library function.
 315 .El
 316 .It "Log File Handling"
 317 .Bl -tag -compact
 318 .It Fn pmc_configure_logfile
 319 Configure a log file for
 320 .Xr hwpmc 4
 321 to write logged events to.
 322 .It Fn pmc_flush_logfile
 323 Flush all pending log data in
 324 .Xr hwpmc 4 Ns Ap s
 325 buffers.
 326 .It Fn pmc_close_logfile
 327 Flush all pending log data and close
 328 .Xr hwpmc 4 Ns Ap s
 329 side of the stream.
 330 .It Fn pmc_writelog
 331 Append arbitrary user data to the current log file.
 332 .El
 333 .It "PMC Management"
 334 .Bl -tag -compact
 335 .It Fn pmc_allocate , Fn pmc_release
 336 Allocate (free) a PMC.
 337 .It Fn pmc_attach , Fn pmc_detach
 338 Attach (detach) a process scope PMC to a target.
 339 .It Fn pmc_read , Fn pmc_write , Fn pmc_rw
 340 Read (write) a value from (to) a PMC.
 341 .It Fn pmc_start , Fn pmc_stop
 342 Start (stop) a software PMC.
 343 .It Fn pmc_set
 344 Set the reload value for a sampling PMC.
 345 .El
 346 .It "Queries"
 347 .Bl -tag -compact
 348 .It Fn pmc_capabilities
 349 Retrieve the capabilities for a given PMC.
 350 .It Fn pmc_cpuinfo
 351 Retrieve information about the CPUs and PMC hardware present in the
 352 system.
 353 .It Fn pmc_get_driver_stats
 354 Retrieve statistics maintained by
 355 .Xr hwpmc 4 .
 356 .It Fn pmc_ncpu
 357 Determine the greatest possible CPU number on the system.
 358 .It Fn pmc_npmc
 359 Return the number of hardware PMCs present in a given CPU.
 360 .It Fn pmc_pmcinfo
 361 Return information about the state of a given CPU's PMCs.
 362 .It Fn pmc_width
 363 Determine the width of a hardware counter in bits.
 364 .El
 365 .It "x86 Architecture Specific API"
 366 .Bl -tag -compact
 367 .It Fn pmc_get_msr
 368 Returns the processor model specific register number
 369 associated with
 370 .Fa pmc .
 371 Applications may then use the x86
 372 .Ic RDPMC
 373 instruction to directly read the contents of the PMC.
 374 .El
 375 .El
 376 .Ss Signal Handling Requirements
 377 Applications using PMCs are required to handle the following signals:
 378 .Bl -tag -width ".Dv SIGBUS"
 379 .It Dv SIGBUS
 380 When the
 381 .Xr hwpmc 4
 382 module is unloaded using
 383 .Xr kldunload 8 ,
 384 processes that have PMCs allocated to them will be sent a
 385 .Dv SIGBUS
 386 signal.
 387 .It Dv SIGIO
 388 The
 389 .Xr hwpmc 4
 390 driver will send a PMC owning process a
 391 .Dv SIGIO
 392 signal if:
 393 .Bl -bullet
 394 .It
 395 If any process-mode PMC allocated by it loses all its
 396 target processes.
 397 .It
 398 If the driver encounters an error when writing log data to a
 399 configured log file.
 400 This error may be retrieved by a subsequent call to
 401 .Fn pmc_flush_logfile .
 402 .El
 403 .El
 404 .Ss Typical Program Flow
 405 .Bl -enum
 406 .It
 407 An application would first invoke function
 408 .Fn pmc_init
 409 to allow the library to initialize itself.
 410 .It
 411 Signal handling would then be set up.
 412 .It
 413 Next the application would allocate the PMCs it desires using function
 414 .Fn pmc_allocate .
 415 .It
 416 Initial values for PMCs may be set using function
 417 .Fn pmc_set .
 418 .It
 419 If a log file is necessary for the PMCs to work, it would
 420 be configured using function
 421 .Fn pmc_configure_logfile .
 422 .It
 423 Process scope PMCs would then be attached to their target processes
 424 using function
 425 .Fn pmc_attach .
 426 .It
 427 The PMCs would then be started using function
 428 .Fn pmc_start .
 429 .It
 430 Once started, the values of counting PMCs may be read using function
 431 .Fn pmc_read .
 432 For PMCs that write events to the log file, this logged data would be
 433 read and parsed using the
 434 .Xr pmclog 3
 435 family of functions.
 436 .It
 437 PMCs are stopped using function
 438 .Fn pmc_stop ,
 439 and process scope PMCs are detached from their targets using
 440 function
 441 .Fn pmc_detach .
 442 .It
 443 Before the process exits, its may release its PMCs using function
 444 .Fn pmc_release .
 445 Any configured log file may be closed using function
 446 .Fn pmc_configure_logfile .
 447 .El
 448 .Sh EVENT SPECIFIERS
 449 Event specifiers are strings comprising of an event name, followed by
 450 optional parameters modifying the semantics of the hardware event
 451 being probed.
 452 Event names are PMC architecture dependent, but the PMC library defines
 453 machine independent aliases for commonly used events.
 454 .Pp
 455 Event specifiers spellings are case-insensitive and space characters,
 456 periods, underscores and hyphens are considered equivalent to each other.
 457 Thus the event specifiers
 458 .Qq "Example Event" ,
 459 .Qq "example-event" ,
 460 and
 461 .Qq "EXAMPLE_EVENT"
 462 are equivalent.
 463 .Ss PMC Architecture Dependent Events
 464 PMC architecture dependent event specifiers are described in the
 465 following manual pages:
 466 .Bl -column " PMC_CLASS_TSC " "MANUAL PAGE "
 467 .It Em "PMC Class"      Ta Em "Manual Page"
 468 .It Li PMC_CLASS_IAF    Ta Xr pmc.iaf 3
 469 .It Li PMC_CLASS_IAP    Ta Xr pmc.atom 3 , Xr pmc.core 3 , Xr pmc.core2 3
 470 .It Li PMC_CLASS_K7     Ta Xr pmc.k7 3
 471 .It Li PMC_CLASS_K8     Ta Xr pmc.k8 3
 472 .It Li PMC_CLASS_P4     Ta Xr pmc.p4 3
 473 .It Li PMC_CLASS_P5     Ta Xr pmc.p5 3
 474 .It Li PMC_CLASS_P6     Ta Xr pmc.p6 3
 475 .It Li PMC_CLASS_TSC    Ta Xr pmc.tsc 3
 476 .El
 477 .Ss Event Name Aliases
 478 Event name aliases are PMC-independent names for commonly used events.
 479 The following aliases are known to this version of the
 480 .Nm pmc
 481 library:
 482 .Bl -tag -width indent
 483 .It Li branches
 484 Measure the number of branches retired.
 485 .It Li branch-mispredicts
 486 Measure the number of retired branches that were mispredicted.
 487 .It Li cycles
 488 Measure processor cycles.
 489 This event is implemented using the processor's Time Stamp Counter
 490 register.
 491 .It Li dc-misses
 492 Measure the number of data cache misses.
 493 .It Li ic-misses
 494 Measure the number of instruction cache misses.
 495 .It Li instructions
 496 Measure the number of instructions retired.
 497 .It Li interrupts
 498 Measure the number of interrupts seen.
 499 .It Li unhalted-cycles
 500 Measure the number of cycles the processor is not in a halted
 501 or sleep state.
 502 .El
 503 .Sh COMPATIBILITY
 504 The interface between the
 505 .Nm pmc
 506 library and the
 507 .Xr hwpmc 4
 508 driver is intended to be private to the implementation and may
 509 change.
 510 In order to ease forward compatibility with future versions of the
 511 .Xr hwpmc 4
 512 driver, applications are urged to dynamically link with the
 513 .Nm pmc
 514 library.
 515 .Pp
 516 The
 517 .Nm pmc
 518 API is
 519 .Ud
 520 .Sh SEE ALSO
 521 .Xr pmc.atom 3 ,
 522 .Xr pmc.core 3 ,
 523 .Xr pmc.core2 3 ,
 524 .Xr pmc.iaf 3 ,
 525 .Xr pmc.k7 3 ,
 526 .Xr pmc.k8 3 ,
 527 .Xr pmc.p4 3 ,
 528 .Xr pmc.p5 3 ,
 529 .Xr pmc.p6 3 ,
 530 .Xr pmc.soft 3 ,
 531 .Xr pmc.tsc 3 ,
 532 .Xr pmclog 3 ,
 533 .Xr hwpmc 4 ,
 534 .Xr pmccontrol 8 ,
 535 .Xr pmcstat 8
 536 .Sh HISTORY
 537 The
 538 .Nm pmc
 539 library first appeared in
 540 .Fx 6.0 .
 541 .Sh AUTHORS
 542 The
 543 .Lb libpmc
 544 library was written by
 545 .An "Joseph Koshy"
 546 .Aq jkoshy@FreeBSD.org .