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