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 May 28, 2022
  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
 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 .Pp
 124 Up to one log file may be configured per owner process.
 125 Events logged to a log file may be subsequently analyzed using the
 126 .Xr pmclog 3
 127 family of functions.
 128 .Ss Supported CPUs
 129 The CPUs known to the PMC library are named by the
 130 .Vt "enum pmc_cputype"
 131 enumeration.
 132 Supported CPUs include:
 133 .Pp
 134 .Bl -tag -width "Li PMC_CPU_INTEL_CORE2" -compact
 135 .It Li PMC_CPU_AMD_K7
 136 .Tn "AMD Athlon"
 137 CPUs.
 138 .It Li PMC_CPU_AMD_K8
 139 .Tn "AMD Athlon64"
 140 CPUs.
 141 .It Li PMC_CPU_INTEL_ATOM
 142 .Tn Intel
 143 .Tn Atom
 144 CPUs and other CPUs conforming to version 3 of the
 145 .Tn Intel
 146 performance measurement architecture.
 147 .It Li PMC_CPU_INTEL_CORE
 148 .Tn Intel
 149 .Tn Core Solo
 150 and
 151 .Tn Core Duo
 152 CPUs, and other CPUs conforming to version 1 of the
 153 .Tn Intel
 154 performance measurement architecture.
 155 .It Li PMC_CPU_INTEL_CORE2
 156 .Tn Intel
 157 .Tn "Core2 Solo" ,
 158 .Tn "Core2 Duo"
 159 and
 160 .Tn "Core2 Extreme"
 161 CPUs, and other CPUs conforming to version 2 of the
 162 .Tn Intel
 163 performance measurement architecture.
 164 .El
 165 .Ss Supported PMCs
 166 PMC supported by this library are named by the
 167 .Vt enum pmc_class
 168 enumeration.
 169 Supported PMC kinds include:
 170 .Pp
 171 .Bl -tag -width "Li PMC_CLASS_IAF" -compact
 172 .It Li PMC_CLASS_IAF
 173 Fixed function hardware counters presents in CPUs conforming to the
 174 .Tn Intel
 175 performance measurement architecture version 2 and later.
 176 .It Li PMC_CLASS_IAP
 177 Programmable hardware counters present in CPUs conforming to the
 178 .Tn Intel
 179 performance measurement architecture version 1 and later.
 180 .It Li PMC_CLASS_K7
 181 Programmable hardware counters present in
 182 .Tn "AMD Athlon"
 183 CPUs.
 184 .It Li PMC_CLASS_K8
 185 Programmable hardware counters present in
 186 .Tn "AMD Athlon64"
 187 CPUs.
 188 .It Li PMC_CLASS_TSC
 189 The timestamp counter on i386 and amd64 architecture CPUs.
 190 .It Li PMC_CLASS_SOFT
 191 Software events.
 192 .El
 193 .Ss PMC Capabilities
 194 Capabilities of performance monitoring hardware are denoted using
 195 the
 196 .Vt "enum pmc_caps"
 197 enumeration.
 198 Supported capabilities include:
 199 .Pp
 200 .Bl -tag -width "Li PMC_CAP_INTERRUPT" -compact
 201 .It Li PMC_CAP_CASCADE
 202 The ability to cascade counters.
 203 .It Li PMC_CAP_DOMWIDE
 204 Separate counters tied to each NUMA domain.
 205 .It Li PMC_CAP_EDGE
 206 The ability to count negated to asserted transitions of the hardware
 207 conditions being probed for.
 208 .It Li PMC_CAP_INTERRUPT
 209 The ability to interrupt the CPU.
 210 .It Li PMC_CAP_INVERT
 211 The ability to invert the sense of the hardware conditions being
 212 measured.
 213 .It Li PMC_CAP_PRECISE
 214 The ability to perform precise sampling.
 215 .It Li PMC_CAP_QUALIFIER
 216 The hardware allows monitored to be further qualified in some
 217 system dependent way.
 218 .It Li PMC_CAP_READ
 219 The ability to read from performance counters.
 220 .It Li PMC_CAP_SYSTEM
 221 The ability to restrict counting of hardware events to when the CPU is
 222 running privileged code.
 223 .It Li PMC_CAP_SYSWIDE
 224 A single counter aggregating events for the whole system.
 225 .It Li PMC_CAP_THRESHOLD
 226 The ability to ignore simultaneous hardware events below a
 227 programmable threshold.
 228 .It Li PMC_CAP_USER
 229 The ability to restrict counting of hardware events to those when the
 230 CPU is running unprivileged code.
 231 .It Li PMC_CAP_WRITE
 232 The ability to write to performance counters.
 233 .El
 234 .Ss CPU Naming Conventions
 235 CPUs are named using small integers from zero up to, but
 236 excluding, the value returned by function
 237 .Fn pmc_ncpu .
 238 On platforms supporting sparsely numbered CPUs not all the numbers in
 239 this range will denote valid CPUs.
 240 Operations on non-existent CPUs will return an error.
 241 .Ss Functional Grouping of the API
 242 This section contains a brief overview of the available functionality
 243 in the PMC library.
 244 Each function listed here is described further in its own manual page.
 245 .Bl -tag -width 2n
 246 .It Administration
 247 .Bl -tag -width 6n -compact
 248 .It Fn pmc_disable , Fn pmc_enable
 249 Administratively disable (enable) specific performance monitoring
 250 counter hardware.
 251 Counters that are disabled will not be available to applications to
 252 use.
 253 .El
 254 .It "Convenience Functions"
 255 .Bl -tag -width 6n -compact
 256 .It Fn pmc_event_names_of_class
 257 Returns a list of event names supported by a given PMC type.
 258 .It Fn pmc_name_of_capability
 259 Convert a
 260 .Dv PMC_CAP_*
 261 flag to a human-readable string.
 262 .It Fn pmc_name_of_class
 263 Convert a
 264 .Dv PMC_CLASS_*
 265 constant to a human-readable string.
 266 .It Fn pmc_name_of_cputype
 267 Return a human-readable name for a CPU type.
 268 .It Fn pmc_name_of_disposition
 269 Return a human-readable string describing a PMC's disposition.
 270 .It Fn pmc_name_of_event
 271 Convert a numeric event code to a human-readable string.
 272 .It Fn pmc_name_of_mode
 273 Convert a
 274 .Dv PMC_MODE_*
 275 constant to a human-readable name.
 276 .It Fn pmc_name_of_state
 277 Return a human-readable string describing a PMC's current state.
 278 .El
 279 .It "Library Initialization"
 280 .Bl -tag -width 6n -compact
 281 .It Fn pmc_init
 282 Initialize the library.
 283 This function must be called before any other library function.
 284 .El
 285 .It "Log File Handling"
 286 .Bl -tag -width 6n -compact
 287 .It Fn pmc_configure_logfile
 288 Configure a log file for
 289 .Xr hwpmc 4
 290 to write logged events to.
 291 .It Fn pmc_flush_logfile
 292 Flush all pending log data in
 293 .Xr hwpmc 4 Ns Ap s
 294 buffers.
 295 .It Fn pmc_close_logfile
 296 Flush all pending log data and close
 297 .Xr hwpmc 4 Ns Ap s
 298 side of the stream.
 299 .It Fn pmc_writelog
 300 Append arbitrary user data to the current log file.
 301 .El
 302 .It "PMC Management"
 303 .Bl -tag -width 6n -compact
 304 .It Fn pmc_allocate , Fn pmc_release
 305 Allocate (free) a PMC.
 306 .It Fn pmc_attach , Fn pmc_detach
 307 Attach (detach) a process scope PMC to a target.
 308 .It Fn pmc_read , Fn pmc_write , Fn pmc_rw
 309 Read (write) a value from (to) a PMC.
 310 .It Fn pmc_start , Fn pmc_stop
 311 Start (stop) a software PMC.
 312 .It Fn pmc_set
 313 Set the reload value for a sampling PMC.
 314 .El
 315 .It "Queries"
 316 .Bl -tag -width 6n -compact
 317 .It Fn pmc_capabilities
 318 Retrieve the capabilities for a given PMC.
 319 .It Fn pmc_cpuinfo
 320 Retrieve information about the CPUs and PMC hardware present in the
 321 system.
 322 .It Fn pmc_get_driver_stats
 323 Retrieve statistics maintained by
 324 .Xr hwpmc 4 .
 325 .It Fn pmc_ncpu
 326 Determine the greatest possible CPU number on the system.
 327 .It Fn pmc_npmc
 328 Return the number of hardware PMCs present in a given CPU.
 329 .It Fn pmc_pmcinfo
 330 Return information about the state of a given CPU's PMCs.
 331 .It Fn pmc_width
 332 Determine the width of a hardware counter in bits.
 333 .El
 334 .It "x86 Architecture Specific API"
 335 .Bl -tag -width 6n -compact
 336 .It Fn pmc_get_msr
 337 Returns the processor model specific register number
 338 associated with
 339 .Fa pmc .
 340 Applications may then use the x86
 341 .Ic RDPMC
 342 instruction to directly read the contents of the PMC.
 343 .El
 344 .El
 345 .Ss Signal Handling Requirements
 346 Applications using PMCs are required to handle the following signals:
 347 .Bl -tag -width ".Dv SIGBUS"
 348 .It Dv SIGBUS
 349 When the
 350 .Xr hwpmc 4
 351 module is unloaded using
 352 .Xr kldunload 8 ,
 353 processes that have PMCs allocated to them will be sent a
 354 .Dv SIGBUS
 355 signal.
 356 .It Dv SIGIO
 357 The
 358 .Xr hwpmc 4
 359 driver will send a PMC owning process a
 360 .Dv SIGIO
 361 signal if:
 362 .Bl -bullet
 363 .It
 364 If any process-mode PMC allocated by it loses all its
 365 target processes.
 366 .It
 367 If the driver encounters an error when writing log data to a
 368 configured log file.
 369 This error may be retrieved by a subsequent call to
 370 .Fn pmc_flush_logfile .
 371 .El
 372 .El
 373 .Ss Typical Program Flow
 374 .Bl -enum
 375 .It
 376 An application would first invoke function
 377 .Fn pmc_init
 378 to allow the library to initialize itself.
 379 .It
 380 Signal handling would then be set up.
 381 .It
 382 Next the application would allocate the PMCs it desires using function
 383 .Fn pmc_allocate .
 384 .It
 385 Initial values for PMCs may be set using function
 386 .Fn pmc_set .
 387 .It
 388 If a log file is necessary for the PMCs to work, it would
 389 be configured using function
 390 .Fn pmc_configure_logfile .
 391 .It
 392 Process scope PMCs would then be attached to their target processes
 393 using function
 394 .Fn pmc_attach .
 395 .It
 396 The PMCs would then be started using function
 397 .Fn pmc_start .
 398 .It
 399 Once started, the values of counting PMCs may be read using function
 400 .Fn pmc_read .
 401 For PMCs that write events to the log file, this logged data would be
 402 read and parsed using the
 403 .Xr pmclog 3
 404 family of functions.
 405 .It
 406 PMCs are stopped using function
 407 .Fn pmc_stop ,
 408 and process scope PMCs are detached from their targets using
 409 function
 410 .Fn pmc_detach .
 411 .It
 412 Before the process exits, its may release its PMCs using function
 413 .Fn pmc_release .
 414 Any configured log file may be closed using function
 415 .Fn pmc_configure_logfile .
 416 .El
 417 .Sh EVENT SPECIFIERS
 418 Event specifiers are strings comprising of an event name, followed by
 419 optional parameters modifying the semantics of the hardware event
 420 being probed.
 421 Event names are PMC architecture dependent, but the PMC library defines
 422 machine independent aliases for commonly used events.
 423 .Pp
 424 Event specifiers spellings are case-insensitive and space characters,
 425 periods, underscores and hyphens are considered equivalent to each other.
 426 Thus the event specifiers
 427 .Qq "Example Event" ,
 428 .Qq "example-event" ,
 429 and
 430 .Qq "EXAMPLE_EVENT"
 431 are equivalent.
 432 .Ss PMC Architecture Dependent Events
 433 PMC architecture dependent event specifiers are described in the
 434 following manual pages:
 435 .Bl -column " PMC_CLASS_TSC " "MANUAL PAGE "
 436 .It Em "PMC Class"      Ta Em "Manual Page"
 437 .It Li PMC_CLASS_IAF    Ta Xr pmc.iaf 3
 438 .It Li PMC_CLASS_IAP    Ta Xr pmc.atom 3 , Xr pmc.core 3 , Xr pmc.core2 3
 439 .It Li PMC_CLASS_K7     Ta Xr pmc.k7 3
 440 .It Li PMC_CLASS_K8     Ta Xr pmc.k8 3
 441 .It Li PMC_CLASS_TSC    Ta Xr pmc.tsc 3
 442 .El
 443 .Ss Event Name Aliases
 444 Event name aliases are PMC-independent names for commonly used events.
 445 The following aliases are known to this version of the
 446 .Nm pmc
 447 library:
 448 .Bl -tag -width indent
 449 .It Li branches
 450 Measure the number of branches retired.
 451 .It Li branch-mispredicts
 452 Measure the number of retired branches that were mispredicted.
 453 .It Li cycles
 454 Measure processor cycles.
 455 This event is implemented using the processor's Time Stamp Counter
 456 register.
 457 .It Li dc-misses
 458 Measure the number of data cache misses.
 459 .It Li ic-misses
 460 Measure the number of instruction cache misses.
 461 .It Li instructions
 462 Measure the number of instructions retired.
 463 .It Li interrupts
 464 Measure the number of interrupts seen.
 465 .It Li unhalted-cycles
 466 Measure the number of cycles the processor is not in a halted
 467 or sleep state.
 468 .El
 469 .Sh COMPATIBILITY
 470 The interface between the
 471 .Nm pmc
 472 library and the
 473 .Xr hwpmc 4
 474 driver is intended to be private to the implementation and may
 475 change.
 476 In order to ease forward compatibility with future versions of the
 477 .Xr hwpmc 4
 478 driver, applications are urged to dynamically link with the
 479 .Nm pmc
 480 library.
 481 .Pp
 482 The
 483 .Nm pmc
 484 API is
 485 .Ud
 486 .Sh SEE ALSO
 487 .Xr pmc.atom 3 ,
 488 .Xr pmc.core 3 ,
 489 .Xr pmc.core2 3 ,
 490 .Xr pmc.haswell 3 ,
 491 .Xr pmc.haswelluc 3 ,
 492 .Xr pmc.haswellxeon 3 ,
 493 .Xr pmc.iaf 3 ,
 494 .Xr pmc.ivybridge 3 ,
 495 .Xr pmc.ivybridgexeon 3 ,
 496 .Xr pmc.k7 3 ,
 497 .Xr pmc.k8 3 ,
 498 .Xr pmc.sandybridge 3 ,
 499 .Xr pmc.sandybridgeuc 3 ,
 500 .Xr pmc.sandybridgexeon 3 ,
 501 .Xr pmc.soft 3 ,
 502 .Xr pmc.tsc 3 ,
 503 .Xr pmc.westmere 3 ,
 504 .Xr pmc.westmereuc 3 ,
 505 .Xr pmc_allocate 3 ,
 506 .Xr pmc_attach 3 ,
 507 .Xr pmc_capabilities 3 ,
 508 .Xr pmc_configure_logfile 3 ,
 509 .Xr pmc_disable 3 ,
 510 .Xr pmc_event_names_of_class 3 ,
 511 .Xr pmc_get_driver_stats 3 ,
 512 .Xr pmc_get_msr 3 ,
 513 .Xr pmc_init 3 ,
 514 .Xr pmc_name_of_capability 3 ,
 515 .Xr pmc_read 3 ,
 516 .Xr pmc_set 3 ,
 517 .Xr pmc_start 3 ,
 518 .Xr pmclog 3 ,
 519 .Xr hwpmc 4 ,
 520 .Xr pmccontrol 8 ,
 521 .Xr pmcstat 8
 522 .Sh HISTORY
 523 The
 524 .Nm pmc
 525 library first appeared in
 526 .Fx 6.0 .
 527 .Sh AUTHORS
 528 The
 529 .Lb libpmc
 530 library was written by
 531 .An Joseph Koshy Aq Mt jkoshy@FreeBSD.org .