lib/libpmc/pmc.xscale.3

   1 .\" Copyright (c) 2009, 2010 Rui Paulo.  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 December 23, 2009
  27 .Dt PMC.XSCALE 3
  28 .Os
  29 .Sh NAME
  30 .Nm pmc.xscale
  31 .Nd measurement events for
  32 .Tn Intel
  33 .Tn XScale
  34 family CPUs
  35 .Sh LIBRARY
  36 .Lb libpmc
  37 .Sh SYNOPSIS
  38 .In pmc.h
  39 .Sh DESCRIPTION
  40 .Tn Intel XScale
  41 CPUs are ARM CPUs based on the ARMv5e core.
  42 .Pp
  43 Second generation cores have 2 counters, while third generation cores
  44 have 4 counters.
  45 Third generation cores also have an increased number of PMC events.
  46 .Pp
  47 .Tn Intel XScale
  48 PMCs are documented in
  49 .Rs
  50 .%B "3rd Generation Intel XScale Microarchitecture Developer's Manual"
  51 .%D May 2007
  52 .Re
  53 .Ss Event Specifiers (Programmable PMCs)
  54 .Tn Intel XScale
  55 programmable PMCs support the following events:
  56 .Bl -tag -width indent
  57 .It Li IC_FETCH
  58 External memory fetch due to L1 instruction cache miss.
  59 .It Li IC_MISS
  60 Instruction cache or TLB miss.
  61 .It Li DATA_DEPENDENCY_STALLED
  62 A data dependency stalled
  63 .It Li ITLB_MISS
  64 Instruction TLB miss.
  65 .It Li DTLB_MISS
  66 Data TLB miss.
  67 .It Li BRANCH_RETIRED
  68 Branch instruction retired (executed).
  69 .It Li BRANCH_MISPRED
  70 Branch mispredicted.
  71 .It Li INSTR_RETIRED
  72 Instructions retired (executed).
  73 .It Li DC_FULL_CYCLE
  74 L1 data cache buffer full stall.
  75 Event occurs on every cycle the
  76 condition is present.
  77 .It Li DC_FULL_CONTIG
  78 L1 data cache buffer full stall.
  79 Event occurs once for each contiguous sequence of this type of stall.
  80 .It Li DC_ACCESS
  81 L1 data cache access, not including cache operations.
  82 .It Li DC_MISS
  83 L1 data cache miss, not including cache operations.
  84 .It Li DC_WRITEBACK
  85 L1 data cache write-back.
  86 Occurs for each cache line that's written back from the cache.
  87 .It Li PC_CHANGE
  88 Software changed the program counter.
  89 .It Li BRANCH_RETIRED_ALL
  90 Branch instruction retired (executed).
  91 This event counts all branch instructions, indirect or direct.
  92 .It Li INSTR_CYCLE
  93 Count the number of microarchitecture cycles each instruction requires
  94 to issue.
  95 .It Li CP_STALL
  96 Coprocessor stalled the instruction pipeline.
  97 .It Li PC_CHANGE_ALL
  98 Software changed the program counter (includes exceptions).
  99 .It Li PIPELINE_FLUSH
 100 Pipeline flushes due to mispredictions or exceptions.
 101 .It Li BACKEND_STALL
 102 Backend stalled the instruction pipeline.
 103 .It Li MULTIPLIER_USE
 104 Multiplier used.
 105 .It Li MULTIPLIER_STALLED
 106 Multiplier stalled the instruction pipeline.
 107 .It Li DATA_CACHE_STALLED
 108 Data cache stalled the instruction pipeline.
 109 .It Li L2_CACHE_REQ
 110 L2 cache request, not including cache operations.
 111 .It Li L2_CACHE_MISS
 112 L2 cache miss, not including cache operations.
 113 .It Li ADDRESS_BUS_TRANS
 114 Address bus transaction.
 115 .It Li SELF_ADDRESS_BUS_TRANS
 116 Self initiated address bus transaction.
 117 .It Li DATA_BUS_TRANS
 118 Data bus transaction.
 119 .El
 120 .Ss Event Name Aliases
 121 The following table shows the mapping between the PMC-independent
 122 aliases supported by
 123 .Lb libpmc
 124 and the underlying hardware events used.
 125 .Bl -column "branch-mispredicts" "BRANCH_MISPRED"
 126 .It Em Alias Ta Em Event Ta
 127 .It Li branches Ta Li BRANCH_RETIRED Ta
 128 .It Li branch-mispredicts Ta Li BRANCH_MISPRED Ta
 129 .It Li dc-misses Ta Li DC_MISS Ta
 130 .It Li ic-misses Ta Li IC_MISS Ta
 131 .It Li instructions Ta Li INSTR_RETIRED Ta
 132 .El
 133 .Sh SEE ALSO
 134 .Xr pmc 3 ,
 135 .Xr pmc_cpuinfo 3 ,
 136 .Xr pmclog 3 ,
 137 .Xr pmc.soft 3 ,
 138 .Xr hwpmc 4
 139 .Sh HISTORY
 140 The
 141 .Nm pmc
 142 library first appeared in
 143 .Fx 6.0 .
 144 Intel XScale support first appeared in
 145 .Fx 9.0 .
 146 .Sh AUTHORS
 147 The
 148 .Lb libpmc
 149 library was written by
 150 .An "Joseph Koshy"
 151 .Aq jkoshy@FreeBSD.org .
 152 .Pp
 153 Intel XScale support was added by
 154 .An "Rui Paulo"
 155 .Aq rpaulo@FreeBSD.org .
 156 .Sh CAVEATS
 157 The Intel XScale code does not yet support sampling.