lib/libpmc/pmc.soft.3

   1 .\" Copyright (c) 2012 Fabien Thomas.  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 March 28, 2012
  27 .Os
  28 .Dt PMC.SOFT 3
  29 .Sh NAME
  30 .Nm pmc.soft
  31 .Nd measurements using software based events
  32 .Sh LIBRARY
  33 .Lb libpmc
  34 .Sh SYNOPSIS
  35 .In pmc.h
  36 .Sh DESCRIPTION
  37 Software events are used to collect various source of software events.
  38 .Ss PMC Features
  39 16 sampling counters using software events based on various sources.
  40 These PMCs support the following capabilities:
  41 .Bl -column "PMC_CAP_INTERRUPT" "Support"
  42 .It Em Capability Ta Em Support
  43 .It PMC_CAP_CASCADE Ta \&No
  44 .It PMC_CAP_EDGE Ta \&No
  45 .It PMC_CAP_INTERRUPT Ta Yes
  46 .It PMC_CAP_INVERT Ta \&No
  47 .It PMC_CAP_READ Ta Yes
  48 .It PMC_CAP_PRECISE Ta \&No
  49 .It PMC_CAP_SYSTEM Ta Yes
  50 .It PMC_CAP_TAGGING Ta \&No
  51 .It PMC_CAP_THRESHOLD Ta \&No
  52 .It PMC_CAP_USER Ta Yes
  53 .It PMC_CAP_WRITE Ta Yes
  54 .El
  55 .Ss Event Qualifiers
  56 There is no supported event qualifier.
  57 .Pp
  58 The event specifiers supported by software are:
  59 .Bl -tag -width indent
  60 .It Li CLOCK.HARD
  61 Hard clock ticks.
  62 .It Li CLOCK.STAT
  63 Stat clock ticks.
  64 .It Li LOCK.FAILED
  65 Lock acquisition failed.
  66 .It Li PAGE_FAULT.ALL
  67 All page fault type.
  68 .It Li PAGE_FAULT.READ
  69 Read page fault.
  70 .It Li PAGE_FAULT.WRITE
  71 Write page fault.
  72 .El
  73 .Sh SEE ALSO
  74 .Xr pmc 3 ,
  75 .Xr pmc.atom 3 ,
  76 .Xr pmc.core 3 ,
  77 .Xr pmc.iaf 3 ,
  78 .Xr pmc.ucf 3 ,
  79 .Xr pmc.k7 3 ,
  80 .Xr pmc.k8 3 ,
  81 .Xr pmc.p4 3 ,
  82 .Xr pmc.p5 3 ,
  83 .Xr pmc.p6 3 ,
  84 .Xr pmc.corei7 3 ,
  85 .Xr pmc.corei7uc 3 ,
  86 .Xr pmc.westmereuc 3 ,
  87 .Xr pmc.tsc 3 ,
  88 .Xr pmc_cpuinfo 3 ,
  89 .Xr pmclog 3 ,
  90 .Xr hwpmc 4
  91 .Sh HISTORY
  92 The
  93 .Nm pmc
  94 library first appeared in
  95 .Fx 6.0 .
  96 .Sh AUTHORS
  97 The
  98 .Lb libpmc
  99 library was written by
 100 .An "Joseph Koshy"
 101 .Aq jkoshy@FreeBSD.org .
 102 Software PMC was written by
 103 .An "Fabien Thomas"
 104 .Aq fabient@FreeBSD.org .