sys/sys/pmc.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2003-2008, Joseph Koshy
   5  * Copyright (c) 2007 The FreeBSD Foundation
   6  * All rights reserved.
   7  *
   8  * Portions of this software were developed by A. Joseph Koshy under
   9  * sponsorship from the FreeBSD Foundation and Google, Inc.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _SYS_PMC_H_
  36 #define _SYS_PMC_H_
  37
  38 #include <dev/hwpmc/pmc_events.h>
  39 #include <sys/proc.h>
  40 #include <sys/counter.h>
  41 #include <machine/pmc_mdep.h>
  42 #include <machine/profile.h>
  43 #ifdef _KERNEL
  44 #include <sys/epoch.h>
  45 #include <ck_queue.h>
  46 #endif
  47
  48 #define PMC_MODULE_NAME         "hwpmc"
  49 #define PMC_NAME_MAX            64 /* HW counter name size */
  50 #define PMC_CLASS_MAX           8  /* max #classes of PMCs per-system */
  51
  52 /*
  53  * Kernel<->userland API version number [MMmmpppp]
  54  *
  55  * Major numbers are to be incremented when an incompatible change to
  56  * the ABI occurs that older clients will not be able to handle.
  57  *
  58  * Minor numbers are incremented when a backwards compatible change
  59  * occurs that allows older correct programs to run unchanged.  For
  60  * example, when support for a new PMC type is added.
  61  *
  62  * The patch version is incremented for every bug fix.
  63  */
  64 #define PMC_VERSION_MAJOR       0x09
  65 #define PMC_VERSION_MINOR       0x03
  66 #define PMC_VERSION_PATCH       0x0000
  67
  68 #define PMC_VERSION             (PMC_VERSION_MAJOR << 24 |              \
  69         PMC_VERSION_MINOR << 16 | PMC_VERSION_PATCH)
  70
  71 #define PMC_CPUID_LEN 64
  72 /* cpu model name for pmu lookup */
  73 extern char pmc_cpuid[PMC_CPUID_LEN];
  74
  75 /*
  76  * Kinds of CPUs known.
  77  *
  78  * We keep track of CPU variants that need to be distinguished in
  79  * some way for PMC operations.  CPU names are grouped by manufacturer
  80  * and numbered sparsely in order to minimize changes to the ABI involved
  81  * when new CPUs are added.
  82  */
  83
  84 #define __PMC_CPUS()                                            \
  85         __PMC_CPU(AMD_K7,       0x00,   "AMD K7")               \
  86         __PMC_CPU(AMD_K8,       0x01,   "AMD K8")               \
  87         __PMC_CPU(INTEL_P5,     0x80,   "Intel Pentium")        \
  88         __PMC_CPU(INTEL_P6,     0x81,   "Intel Pentium Pro")    \
  89         __PMC_CPU(INTEL_CL,     0x82,   "Intel Celeron")        \
  90         __PMC_CPU(INTEL_PII,    0x83,   "Intel Pentium II")     \
  91         __PMC_CPU(INTEL_PIII,   0x84,   "Intel Pentium III")    \
  92         __PMC_CPU(INTEL_PM,     0x85,   "Intel Pentium M")      \
  93         __PMC_CPU(INTEL_PIV,    0x86,   "Intel Pentium IV")     \
  94         __PMC_CPU(INTEL_CORE,   0x87,   "Intel Core Solo/Duo")  \
  95         __PMC_CPU(INTEL_CORE2,  0x88,   "Intel Core2")          \
  96         __PMC_CPU(INTEL_CORE2EXTREME,   0x89,   "Intel Core2 Extreme")  \
  97         __PMC_CPU(INTEL_ATOM,   0x8A,   "Intel Atom")           \
  98         __PMC_CPU(INTEL_COREI7, 0x8B,   "Intel Core i7")        \
  99         __PMC_CPU(INTEL_WESTMERE, 0x8C,   "Intel Westmere")     \
 100         __PMC_CPU(INTEL_SANDYBRIDGE, 0x8D,   "Intel Sandy Bridge")      \
 101         __PMC_CPU(INTEL_IVYBRIDGE, 0x8E,   "Intel Ivy Bridge")  \
 102         __PMC_CPU(INTEL_SANDYBRIDGE_XEON, 0x8F,   "Intel Sandy Bridge Xeon")    \
 103         __PMC_CPU(INTEL_IVYBRIDGE_XEON, 0x90,   "Intel Ivy Bridge Xeon")        \
 104         __PMC_CPU(INTEL_HASWELL, 0x91,   "Intel Haswell")       \
 105         __PMC_CPU(INTEL_ATOM_SILVERMONT, 0x92,  "Intel Atom Silvermont")    \
 106         __PMC_CPU(INTEL_NEHALEM_EX, 0x93,   "Intel Nehalem Xeon 7500")  \
 107         __PMC_CPU(INTEL_WESTMERE_EX, 0x94,   "Intel Westmere Xeon E7")  \
 108         __PMC_CPU(INTEL_HASWELL_XEON, 0x95,   "Intel Haswell Xeon E5 v3") \
 109         __PMC_CPU(INTEL_BROADWELL, 0x96,   "Intel Broadwell") \
 110         __PMC_CPU(INTEL_BROADWELL_XEON, 0x97,   "Intel Broadwell Xeon") \
 111         __PMC_CPU(INTEL_SKYLAKE, 0x98,   "Intel Skylake")               \
 112         __PMC_CPU(INTEL_SKYLAKE_XEON, 0x99,   "Intel Skylake Xeon")     \
 113         __PMC_CPU(INTEL_ATOM_GOLDMONT, 0x9A,   "Intel Atom Goldmont")   \
 114         __PMC_CPU(INTEL_XSCALE, 0x100,  "Intel XScale")         \
 115         __PMC_CPU(MIPS_24K,     0x200,  "MIPS 24K")             \
 116         __PMC_CPU(MIPS_OCTEON,  0x201,  "Cavium Octeon")        \
 117         __PMC_CPU(MIPS_74K,     0x202,  "MIPS 74K")             \
 118         __PMC_CPU(PPC_7450,     0x300,  "PowerPC MPC7450")      \
 119         __PMC_CPU(PPC_E500,     0x340,  "PowerPC e500 Core")    \
 120         __PMC_CPU(PPC_970,      0x380,  "IBM PowerPC 970")      \
 121         __PMC_CPU(GENERIC,      0x400,  "Generic")              \
 122         __PMC_CPU(ARMV7_CORTEX_A5,      0x500,  "ARMv7 Cortex A5")      \
 123         __PMC_CPU(ARMV7_CORTEX_A7,      0x501,  "ARMv7 Cortex A7")      \
 124         __PMC_CPU(ARMV7_CORTEX_A8,      0x502,  "ARMv7 Cortex A8")      \
 125         __PMC_CPU(ARMV7_CORTEX_A9,      0x503,  "ARMv7 Cortex A9")      \
 126         __PMC_CPU(ARMV7_CORTEX_A15,     0x504,  "ARMv7 Cortex A15")     \
 127         __PMC_CPU(ARMV7_CORTEX_A17,     0x505,  "ARMv7 Cortex A17")     \
 128         __PMC_CPU(ARMV8_CORTEX_A53,     0x600,  "ARMv8 Cortex A53")     \
 129         __PMC_CPU(ARMV8_CORTEX_A57,     0x601,  "ARMv8 Cortex A57")
 130
 131 enum pmc_cputype {
 132 #undef  __PMC_CPU
 133 #define __PMC_CPU(S,V,D)        PMC_CPU_##S = V,
 134         __PMC_CPUS()
 135 };
 136
 137 #define PMC_CPU_FIRST   PMC_CPU_AMD_K7
 138 #define PMC_CPU_LAST    PMC_CPU_GENERIC
 139
 140 /*
 141  * Classes of PMCs
 142  */
 143
 144 #define __PMC_CLASSES()                                                 \
 145         __PMC_CLASS(TSC,        0x00,   "CPU Timestamp counter")        \
 146         __PMC_CLASS(K7,         0x01,   "AMD K7 performance counters")  \
 147         __PMC_CLASS(K8,         0x02,   "AMD K8 performance counters")  \
 148         __PMC_CLASS(P5,         0x03,   "Intel Pentium counters")       \
 149         __PMC_CLASS(P6,         0x04,   "Intel Pentium Pro counters")   \
 150         __PMC_CLASS(P4,         0x05,   "Intel Pentium-IV counters")    \
 151         __PMC_CLASS(IAF,        0x06,   "Intel Core2/Atom, fixed function") \
 152         __PMC_CLASS(IAP,        0x07,   "Intel Core...Atom, programmable") \
 153         __PMC_CLASS(UCF,        0x08,   "Intel Uncore fixed function")  \
 154         __PMC_CLASS(UCP,        0x09,   "Intel Uncore programmable")    \
 155         __PMC_CLASS(XSCALE,     0x0A,   "Intel XScale counters")        \
 156         __PMC_CLASS(MIPS24K,    0x0B,   "MIPS 24K")                     \
 157         __PMC_CLASS(OCTEON,     0x0C,   "Cavium Octeon")                \
 158         __PMC_CLASS(PPC7450,    0x0D,   "Motorola MPC7450 class")       \
 159         __PMC_CLASS(PPC970,     0x0E,   "IBM PowerPC 970 class")        \
 160         __PMC_CLASS(SOFT,       0x0F,   "Software events")              \
 161         __PMC_CLASS(ARMV7,      0x10,   "ARMv7")                        \
 162         __PMC_CLASS(ARMV8,      0x11,   "ARMv8")                        \
 163         __PMC_CLASS(MIPS74K,    0x12,   "MIPS 74K")                     \
 164         __PMC_CLASS(E500,       0x13,   "Freescale e500 class")
 165
 166 enum pmc_class {
 167 #undef  __PMC_CLASS
 168 #define __PMC_CLASS(S,V,D)      PMC_CLASS_##S = V,
 169         __PMC_CLASSES()
 170 };
 171
 172 #define PMC_CLASS_FIRST PMC_CLASS_TSC
 173 #define PMC_CLASS_LAST  PMC_CLASS_E500
 174
 175 /*
 176  * A PMC can be in the following states:
 177  *
 178  * Hardware states:
 179  *   DISABLED   -- administratively prohibited from being used.
 180  *   FREE       -- HW available for use
 181  * Software states:
 182  *   ALLOCATED  -- allocated
 183  *   STOPPED    -- allocated, but not counting events
 184  *   RUNNING    -- allocated, and in operation; 'pm_runcount'
 185  *                 holds the number of CPUs using this PMC at
 186  *                 a given instant
 187  *   DELETED    -- being destroyed
 188  */
 189
 190 #define __PMC_HWSTATES()                        \
 191         __PMC_STATE(DISABLED)                   \
 192         __PMC_STATE(FREE)
 193
 194 #define __PMC_SWSTATES()                        \
 195         __PMC_STATE(ALLOCATED)                  \
 196         __PMC_STATE(STOPPED)                    \
 197         __PMC_STATE(RUNNING)                    \
 198         __PMC_STATE(DELETED)
 199
 200 #define __PMC_STATES()                          \
 201         __PMC_HWSTATES()                        \
 202         __PMC_SWSTATES()
 203
 204 enum pmc_state {
 205 #undef  __PMC_STATE
 206 #define __PMC_STATE(S)  PMC_STATE_##S,
 207         __PMC_STATES()
 208         __PMC_STATE(MAX)
 209 };
 210
 211 #define PMC_STATE_FIRST PMC_STATE_DISABLED
 212 #define PMC_STATE_LAST  PMC_STATE_DELETED
 213
 214 /*
 215  * An allocated PMC may used as a 'global' counter or as a
 216  * 'thread-private' one.  Each such mode of use can be in either
 217  * statistical sampling mode or in counting mode.  Thus a PMC in use
 218  *
 219  * SS i.e., SYSTEM STATISTICAL  -- system-wide statistical profiling
 220  * SC i.e., SYSTEM COUNTER      -- system-wide counting mode
 221  * TS i.e., THREAD STATISTICAL  -- thread virtual, statistical profiling
 222  * TC i.e., THREAD COUNTER      -- thread virtual, counting mode
 223  *
 224  * Statistical profiling modes rely on the PMC periodically delivering
 225  * a interrupt to the CPU (when the configured number of events have
 226  * been measured), so the PMC must have the ability to generate
 227  * interrupts.
 228  *
 229  * In counting modes, the PMC counts its configured events, with the
 230  * value of the PMC being read whenever needed by its owner process.
 231  *
 232  * The thread specific modes "virtualize" the PMCs -- the PMCs appear
 233  * to be thread private and count events only when the profiled thread
 234  * actually executes on the CPU.
 235  *
 236  * The system-wide "global" modes keep the PMCs running all the time
 237  * and are used to measure the behaviour of the whole system.
 238  */
 239
 240 #define __PMC_MODES()                           \
 241         __PMC_MODE(SS,  0)                      \
 242         __PMC_MODE(SC,  1)                      \
 243         __PMC_MODE(TS,  2)                      \
 244         __PMC_MODE(TC,  3)
 245
 246 enum pmc_mode {
 247 #undef  __PMC_MODE
 248 #define __PMC_MODE(M,N) PMC_MODE_##M = N,
 249         __PMC_MODES()
 250 };
 251
 252 #define PMC_MODE_FIRST  PMC_MODE_SS
 253 #define PMC_MODE_LAST   PMC_MODE_TC
 254
 255 #define PMC_IS_COUNTING_MODE(mode)                              \
 256         ((mode) == PMC_MODE_SC || (mode) == PMC_MODE_TC)
 257 #define PMC_IS_SYSTEM_MODE(mode)                                \
 258         ((mode) == PMC_MODE_SS || (mode) == PMC_MODE_SC)
 259 #define PMC_IS_SAMPLING_MODE(mode)                              \
 260         ((mode) == PMC_MODE_SS || (mode) == PMC_MODE_TS)
 261 #define PMC_IS_VIRTUAL_MODE(mode)                               \
 262         ((mode) == PMC_MODE_TS || (mode) == PMC_MODE_TC)
 263
 264 /*
 265  * PMC row disposition
 266  */
 267
 268 #define __PMC_DISPOSITIONS(N)                                   \
 269         __PMC_DISP(STANDALONE)  /* global/disabled counters */  \
 270         __PMC_DISP(FREE)        /* free/available */            \
 271         __PMC_DISP(THREAD)      /* thread-virtual PMCs */       \
 272         __PMC_DISP(UNKNOWN)     /* sentinel */
 273
 274 enum pmc_disp {
 275 #undef  __PMC_DISP
 276 #define __PMC_DISP(D)   PMC_DISP_##D ,
 277         __PMC_DISPOSITIONS()
 278 };
 279
 280 #define PMC_DISP_FIRST  PMC_DISP_STANDALONE
 281 #define PMC_DISP_LAST   PMC_DISP_THREAD
 282
 283 /*
 284  * Counter capabilities
 285  *
 286  * __PMC_CAPS(NAME, VALUE, DESCRIPTION)
 287  */
 288
 289 #define __PMC_CAPS()                                                    \
 290         __PMC_CAP(INTERRUPT,    0, "generate interrupts")               \
 291         __PMC_CAP(USER,         1, "count user-mode events")            \
 292         __PMC_CAP(SYSTEM,       2, "count system-mode events")          \
 293         __PMC_CAP(EDGE,         3, "do edge detection of events")       \
 294         __PMC_CAP(THRESHOLD,    4, "ignore events below a threshold")   \
 295         __PMC_CAP(READ,         5, "read PMC counter")                  \
 296         __PMC_CAP(WRITE,        6, "reprogram PMC counter")             \
 297         __PMC_CAP(INVERT,       7, "invert comparison sense")           \
 298         __PMC_CAP(QUALIFIER,    8, "further qualify monitored events")  \
 299         __PMC_CAP(PRECISE,      9, "perform precise sampling")          \
 300         __PMC_CAP(TAGGING,      10, "tag upstream events")              \
 301         __PMC_CAP(CASCADE,      11, "cascade counters")
 302
 303 enum pmc_caps
 304 {
 305 #undef  __PMC_CAP
 306 #define __PMC_CAP(NAME, VALUE, DESCR)   PMC_CAP_##NAME = (1 << VALUE) ,
 307         __PMC_CAPS()
 308 };
 309
 310 #define PMC_CAP_FIRST           PMC_CAP_INTERRUPT
 311 #define PMC_CAP_LAST            PMC_CAP_CASCADE
 312
 313 /*
 314  * PMC Event Numbers
 315  *
 316  * These are generated from the definitions in "dev/hwpmc/pmc_events.h".
 317  */
 318
 319 enum pmc_event {
 320 #undef  __PMC_EV
 321 #undef  __PMC_EV_BLOCK
 322 #define __PMC_EV_BLOCK(C,V)     PMC_EV_ ## C ## __BLOCK_START = (V) - 1 ,
 323 #define __PMC_EV(C,N)           PMC_EV_ ## C ## _ ## N ,
 324         __PMC_EVENTS()
 325 };
 326
 327 /*
 328  * PMC SYSCALL INTERFACE
 329  */
 330
 331 /*
 332  * "PMC_OPS" -- these are the commands recognized by the kernel
 333  * module, and are used when performing a system call from userland.
 334  */
 335 #define __PMC_OPS()                                                     \
 336         __PMC_OP(CONFIGURELOG, "Set log file")                          \
 337         __PMC_OP(FLUSHLOG, "Flush log file")                            \
 338         __PMC_OP(GETCPUINFO, "Get system CPU information")              \
 339         __PMC_OP(GETDRIVERSTATS, "Get driver statistics")               \
 340         __PMC_OP(GETMODULEVERSION, "Get module version")                \
 341         __PMC_OP(GETPMCINFO, "Get per-cpu PMC information")             \
 342         __PMC_OP(PMCADMIN, "Set PMC state")                             \
 343         __PMC_OP(PMCALLOCATE, "Allocate and configure a PMC")           \
 344         __PMC_OP(PMCATTACH, "Attach a PMC to a process")                \
 345         __PMC_OP(PMCDETACH, "Detach a PMC from a process")              \
 346         __PMC_OP(PMCGETMSR, "Get a PMC's hardware address")             \
 347         __PMC_OP(PMCRELEASE, "Release a PMC")                           \
 348         __PMC_OP(PMCRW, "Read/Set a PMC")                               \
 349         __PMC_OP(PMCSETCOUNT, "Set initial count/sampling rate")        \
 350         __PMC_OP(PMCSTART, "Start a PMC")                               \
 351         __PMC_OP(PMCSTOP, "Stop a PMC")                                 \
 352         __PMC_OP(WRITELOG, "Write a cookie to the log file")            \
 353         __PMC_OP(CLOSELOG, "Close log file")                            \
 354         __PMC_OP(GETDYNEVENTINFO, "Get dynamic events list")
 355
 356
 357 enum pmc_ops {
 358 #undef  __PMC_OP
 359 #define __PMC_OP(N, D)  PMC_OP_##N,
 360         __PMC_OPS()
 361 };
 362
 363
 364 /*
 365  * Flags used in operations on PMCs.
 366  */
 367
 368 #define PMC_F_UNUSED1           0x00000001 /* unused */
 369 #define PMC_F_DESCENDANTS       0x00000002 /*OP ALLOCATE track descendants */
 370 #define PMC_F_LOG_PROCCSW       0x00000004 /*OP ALLOCATE track ctx switches */
 371 #define PMC_F_LOG_PROCEXIT      0x00000008 /*OP ALLOCATE log proc exits */
 372 #define PMC_F_NEWVALUE          0x00000010 /*OP RW write new value */
 373 #define PMC_F_OLDVALUE          0x00000020 /*OP RW get old value */
 374
 375 /* V2 API */
 376 #define PMC_F_CALLCHAIN         0x00000080 /*OP ALLOCATE capture callchains */
 377 #define PMC_F_USERCALLCHAIN     0x00000100 /*OP ALLOCATE use userspace stack */
 378
 379 /* internal flags */
 380 #define PMC_F_ATTACHED_TO_OWNER 0x00010000 /*attached to owner*/
 381 #define PMC_F_NEEDS_LOGFILE     0x00020000 /*needs log file */
 382 #define PMC_F_ATTACH_DONE       0x00040000 /*attached at least once */
 383
 384 #define PMC_CALLCHAIN_DEPTH_MAX 512
 385
 386 #define PMC_CC_F_USERSPACE      0x01       /*userspace callchain*/
 387
 388 /*
 389  * Cookies used to denote allocated PMCs, and the values of PMCs.
 390  */
 391
 392 typedef uint32_t        pmc_id_t;
 393 typedef uint64_t        pmc_value_t;
 394
 395 #define PMC_ID_INVALID          (~ (pmc_id_t) 0)
 396
 397 /*
 398  * PMC IDs have the following format:
 399  *
 400  * +-----------------------+-------+-----------+
 401  * |   CPU      | PMC MODE | CLASS | ROW INDEX |
 402  * +-----------------------+-------+-----------+
 403  *
 404  * where CPU is 12 bits, MODE 8, CLASS 4, and ROW INDEX 8  Field 'CPU'
 405  * is set to the requested CPU for system-wide PMCs or PMC_CPU_ANY for
 406  * process-mode PMCs.  Field 'PMC MODE' is the allocated PMC mode.
 407  * Field 'PMC CLASS' is the class of the PMC.  Field 'ROW INDEX' is the
 408  * row index for the PMC.
 409  *
 410  * The 'ROW INDEX' ranges over 0..NWPMCS where NHWPMCS is the total
 411  * number of hardware PMCs on this cpu.
 412  */
 413
 414
 415 #define PMC_ID_TO_ROWINDEX(ID)  ((ID) & 0xFF)
 416 #define PMC_ID_TO_CLASS(ID)     (((ID) & 0xF00) >> 8)
 417 #define PMC_ID_TO_MODE(ID)      (((ID) & 0xFF000) >> 12)
 418 #define PMC_ID_TO_CPU(ID)       (((ID) & 0xFFF00000) >> 20)
 419 #define PMC_ID_MAKE_ID(CPU,MODE,CLASS,ROWINDEX)                 \
 420         ((((CPU) & 0xFFF) << 20) | (((MODE) & 0xFF) << 12) |    \
 421         (((CLASS) & 0xF) << 8) | ((ROWINDEX) & 0xFF))
 422
 423 /*
 424  * Data structures for system calls supported by the pmc driver.
 425  */
 426
 427 /*
 428  * OP PMCALLOCATE
 429  *
 430  * Allocate a PMC on the named CPU.
 431  */
 432
 433 #define PMC_CPU_ANY     ~0
 434
 435 struct pmc_op_pmcallocate {
 436         uint32_t        pm_caps;        /* PMC_CAP_* */
 437         uint32_t        pm_cpu;         /* CPU number or PMC_CPU_ANY */
 438         enum pmc_class  pm_class;       /* class of PMC desired */
 439         enum pmc_event  pm_ev;          /* [enum pmc_event] desired */
 440         uint32_t        pm_flags;       /* additional modifiers PMC_F_* */
 441         enum pmc_mode   pm_mode;        /* desired mode */
 442         pmc_id_t        pm_pmcid;       /* [return] process pmc id */
 443         pmc_value_t     pm_count;       /* initial/sample count */
 444
 445         union pmc_md_op_pmcallocate pm_md; /* MD layer extensions */
 446 };
 447
 448 /*
 449  * OP PMCADMIN
 450  *
 451  * Set the administrative state (i.e., whether enabled or disabled) of
 452  * a PMC 'pm_pmc' on CPU 'pm_cpu'.  Note that 'pm_pmc' specifies an
 453  * absolute PMC number and need not have been first allocated by the
 454  * calling process.
 455  */
 456
 457 struct pmc_op_pmcadmin {
 458         int             pm_cpu;         /* CPU# */
 459         uint32_t        pm_flags;       /* flags */
 460         int             pm_pmc;         /* PMC# */
 461         enum pmc_state  pm_state;       /* desired state */
 462 };
 463
 464 /*
 465  * OP PMCATTACH / OP PMCDETACH
 466  *
 467  * Attach/detach a PMC and a process.
 468  */
 469
 470 struct pmc_op_pmcattach {
 471         pmc_id_t        pm_pmc;         /* PMC to attach to */
 472         pid_t           pm_pid;         /* target process */
 473 };
 474
 475 /*
 476  * OP PMCSETCOUNT
 477  *
 478  * Set the sampling rate (i.e., the reload count) for statistical counters.
 479  * 'pm_pmcid' need to have been previously allocated using PMCALLOCATE.
 480  */
 481
 482 struct pmc_op_pmcsetcount {
 483         pmc_value_t     pm_count;       /* initial/sample count */
 484         pmc_id_t        pm_pmcid;       /* PMC id to set */
 485 };
 486
 487
 488 /*
 489  * OP PMCRW
 490  *
 491  * Read the value of a PMC named by 'pm_pmcid'.  'pm_pmcid' needs
 492  * to have been previously allocated using PMCALLOCATE.
 493  */
 494
 495
 496 struct pmc_op_pmcrw {
 497         uint32_t        pm_flags;       /* PMC_F_{OLD,NEW}VALUE*/
 498         pmc_id_t        pm_pmcid;       /* pmc id */
 499         pmc_value_t     pm_value;       /* new&returned value */
 500 };
 501
 502
 503 /*
 504  * OP GETPMCINFO
 505  *
 506  * retrieve PMC state for a named CPU.  The caller is expected to
 507  * allocate 'npmc' * 'struct pmc_info' bytes of space for the return
 508  * values.
 509  */
 510
 511 struct pmc_info {
 512         char            pm_name[PMC_NAME_MAX]; /* pmc name */
 513         enum pmc_class  pm_class;       /* enum pmc_class */
 514         int             pm_enabled;     /* whether enabled */
 515         enum pmc_disp   pm_rowdisp;     /* FREE, THREAD or STANDLONE */
 516         pid_t           pm_ownerpid;    /* owner, or -1 */
 517         enum pmc_mode   pm_mode;        /* current mode [enum pmc_mode] */
 518         enum pmc_event  pm_event;       /* current event */
 519         uint32_t        pm_flags;       /* current flags */
 520         pmc_value_t     pm_reloadcount; /* sampling counters only */
 521 };
 522
 523 struct pmc_op_getpmcinfo {
 524         int32_t         pm_cpu;         /* 0 <= cpu < mp_maxid */
 525         struct pmc_info pm_pmcs[];      /* space for 'npmc' structures */
 526 };
 527
 528
 529 /*
 530  * OP GETCPUINFO
 531  *
 532  * Retrieve system CPU information.
 533  */
 534
 535
 536 struct pmc_classinfo {
 537         enum pmc_class  pm_class;       /* class id */
 538         uint32_t        pm_caps;        /* counter capabilities */
 539         uint32_t        pm_width;       /* width of the PMC */
 540         uint32_t        pm_num;         /* number of PMCs in class */
 541 };
 542
 543 struct pmc_op_getcpuinfo {
 544         enum pmc_cputype pm_cputype; /* what kind of CPU */
 545         uint32_t        pm_ncpu;    /* max CPU number */
 546         uint32_t        pm_npmc;    /* #PMCs per CPU */
 547         uint32_t        pm_nclass;  /* #classes of PMCs */
 548         struct pmc_classinfo  pm_classes[PMC_CLASS_MAX];
 549 };
 550
 551 /*
 552  * OP CONFIGURELOG
 553  *
 554  * Configure a log file for writing system-wide statistics to.
 555  */
 556
 557 struct pmc_op_configurelog {
 558         int             pm_flags;
 559         int             pm_logfd;   /* logfile fd (or -1) */
 560 };
 561
 562 /*
 563  * OP GETDRIVERSTATS
 564  *
 565  * Retrieve pmc(4) driver-wide statistics.
 566  */
 567 #ifdef _KERNEL
 568 struct pmc_driverstats {
 569         counter_u64_t   pm_intr_ignored;        /* #interrupts ignored */
 570         counter_u64_t   pm_intr_processed;      /* #interrupts processed */
 571         counter_u64_t   pm_intr_bufferfull;     /* #interrupts with ENOSPC */
 572         counter_u64_t   pm_syscalls;            /* #syscalls */
 573         counter_u64_t   pm_syscall_errors;      /* #syscalls with errors */
 574         counter_u64_t   pm_buffer_requests;     /* #buffer requests */
 575         counter_u64_t   pm_buffer_requests_failed; /* #failed buffer requests */
 576         counter_u64_t   pm_log_sweeps;          /* #sample buffer processing
 577                                                    passes */
 578         counter_u64_t   pm_merges;              /* merged k+u */
 579         counter_u64_t   pm_overwrites;          /* UR overwrites */
 580 };
 581 #endif
 582
 583 struct pmc_op_getdriverstats {
 584         unsigned int    pm_intr_ignored;        /* #interrupts ignored */
 585         unsigned int    pm_intr_processed;      /* #interrupts processed */
 586         unsigned int    pm_intr_bufferfull;     /* #interrupts with ENOSPC */
 587         unsigned int    pm_syscalls;            /* #syscalls */
 588         unsigned int    pm_syscall_errors;      /* #syscalls with errors */
 589         unsigned int    pm_buffer_requests;     /* #buffer requests */
 590         unsigned int    pm_buffer_requests_failed; /* #failed buffer requests */
 591         unsigned int    pm_log_sweeps;          /* #sample buffer processing
 592                                                    passes */
 593 };
 594
 595 /*
 596  * OP RELEASE / OP START / OP STOP
 597  *
 598  * Simple operations on a PMC id.
 599  */
 600
 601 struct pmc_op_simple {
 602         pmc_id_t        pm_pmcid;
 603 };
 604
 605 /*
 606  * OP WRITELOG
 607  *
 608  * Flush the current log buffer and write 4 bytes of user data to it.
 609  */
 610
 611 struct pmc_op_writelog {
 612         uint32_t        pm_userdata;
 613 };
 614
 615 /*
 616  * OP GETMSR
 617  *
 618  * Retrieve the machine specific address associated with the allocated
 619  * PMC.  This number can be used subsequently with a read-performance-counter
 620  * instruction.
 621  */
 622
 623 struct pmc_op_getmsr {
 624         uint32_t        pm_msr;         /* machine specific address */
 625         pmc_id_t        pm_pmcid;       /* allocated pmc id */
 626 };
 627
 628 /*
 629  * OP GETDYNEVENTINFO
 630  *
 631  * Retrieve a PMC dynamic class events list.
 632  */
 633
 634 struct pmc_dyn_event_descr {
 635         char            pm_ev_name[PMC_NAME_MAX];
 636         enum pmc_event  pm_ev_code;
 637 };
 638
 639 struct pmc_op_getdyneventinfo {
 640         enum pmc_class                  pm_class;
 641         unsigned int                    pm_nevent;
 642         struct pmc_dyn_event_descr      pm_events[PMC_EV_DYN_COUNT];
 643 };
 644
 645 #ifdef _KERNEL
 646
 647 #include <sys/malloc.h>
 648 #include <sys/sysctl.h>
 649 #include <sys/_cpuset.h>
 650
 651 #include <machine/frame.h>
 652
 653 #define PMC_HASH_SIZE                           1024
 654 #define PMC_MTXPOOL_SIZE                        2048
 655 #define PMC_LOG_BUFFER_SIZE                     256
 656 #define PMC_NLOGBUFFERS_PCPU                    32
 657 #define PMC_NSAMPLES                            256
 658 #define PMC_CALLCHAIN_DEPTH                     128
 659 #define PMC_THREADLIST_MAX                      128
 660
 661 #define PMC_SYSCTL_NAME_PREFIX "kern." PMC_MODULE_NAME "."
 662
 663 /*
 664  * Locking keys
 665  *
 666  * (b) - pmc_bufferlist_mtx (spin lock)
 667  * (k) - pmc_kthread_mtx (sleep lock)
 668  * (o) - po->po_mtx (spin lock)
 669  * (g) - global_epoch_preempt (epoch)
 670  * (p) - pmc_sx (sx)
 671  */
 672
 673 /*
 674  * PMC commands
 675  */
 676
 677 struct pmc_syscall_args {
 678         register_t      pmop_code;      /* one of PMC_OP_* */
 679         void            *pmop_data;     /* syscall parameter */
 680 };
 681
 682 /*
 683  * Interface to processor specific s1tuff
 684  */
 685
 686 /*
 687  * struct pmc_descr
 688  *
 689  * Machine independent (i.e., the common parts) of a human readable
 690  * PMC description.
 691  */
 692
 693 struct pmc_descr {
 694         char            pd_name[PMC_NAME_MAX]; /* name */
 695         uint32_t        pd_caps;        /* capabilities */
 696         enum pmc_class  pd_class;       /* class of the PMC */
 697         uint32_t        pd_width;       /* width in bits */
 698 };
 699
 700 /*
 701  * struct pmc_target
 702  *
 703  * This structure records all the target processes associated with a
 704  * PMC.
 705  */
 706
 707 struct pmc_target {
 708         LIST_ENTRY(pmc_target)  pt_next;
 709         struct pmc_process      *pt_process; /* target descriptor */
 710 };
 711
 712 /*
 713  * struct pmc
 714  *
 715  * Describes each allocated PMC.
 716  *
 717  * Each PMC has precisely one owner, namely the process that allocated
 718  * the PMC.
 719  *
 720  * A PMC may be attached to multiple target processes.  The
 721  * 'pm_targets' field links all the target processes being monitored
 722  * by this PMC.
 723  *
 724  * The 'pm_savedvalue' field is protected by a mutex.
 725  *
 726  * On a multi-cpu machine, multiple target threads associated with a
 727  * process-virtual PMC could be concurrently executing on different
 728  * CPUs.  The 'pm_runcount' field is atomically incremented every time
 729  * the PMC gets scheduled on a CPU and atomically decremented when it
 730  * get descheduled.  Deletion of a PMC is only permitted when this
 731  * field is '0'.
 732  *
 733  */
 734 struct pmc_pcpu_state {
 735         uint8_t pps_stalled;
 736         uint8_t pps_cpustate;
 737 } __aligned(CACHE_LINE_SIZE);
 738 struct pmc {
 739         LIST_HEAD(,pmc_target)  pm_targets;     /* list of target processes */
 740         LIST_ENTRY(pmc)         pm_next;        /* owner's list */
 741
 742         /*
 743          * System-wide PMCs are allocated on a CPU and are not moved
 744          * around.  For system-wide PMCs we record the CPU the PMC was
 745          * allocated on in the 'CPU' field of the pmc ID.
 746          *
 747          * Virtual PMCs run on whichever CPU is currently executing
 748          * their targets' threads.  For these PMCs we need to save
 749          * their current PMC counter values when they are taken off
 750          * CPU.
 751          */
 752
 753         union {
 754                 pmc_value_t     pm_savedvalue;  /* Virtual PMCS */
 755         } pm_gv;
 756
 757         /*
 758          * For sampling mode PMCs, we keep track of the PMC's "reload
 759          * count", which is the counter value to be loaded in when
 760          * arming the PMC for the next counting session.  For counting
 761          * modes on PMCs that are read-only (e.g., the x86 TSC), we
 762          * keep track of the initial value at the start of
 763          * counting-mode operation.
 764          */
 765
 766         union {
 767                 pmc_value_t     pm_reloadcount; /* sampling PMC modes */
 768                 pmc_value_t     pm_initial;     /* counting PMC modes */
 769         } pm_sc;
 770
 771         struct pmc_pcpu_state *pm_pcpu_state;
 772         volatile cpuset_t pm_cpustate;  /* CPUs where PMC should be active */
 773         uint32_t        pm_caps;        /* PMC capabilities */
 774         enum pmc_event  pm_event;       /* event being measured */
 775         uint32_t        pm_flags;       /* additional flags PMC_F_... */
 776         struct pmc_owner *pm_owner;     /* owner thread state */
 777         counter_u64_t           pm_runcount;    /* #cpus currently on */
 778         enum pmc_state  pm_state;       /* current PMC state */
 779         uint32_t        pm_overflowcnt; /* count overflow interrupts */
 780
 781         /*
 782          * The PMC ID field encodes the row-index for the PMC, its
 783          * mode, class and the CPU# associated with the PMC.
 784          */
 785
 786         pmc_id_t        pm_id;          /* allocated PMC id */
 787         enum pmc_class pm_class;
 788
 789         /* md extensions */
 790         union pmc_md_pmc        pm_md;
 791 };
 792
 793 /*
 794  * Accessor macros for 'struct pmc'
 795  */
 796
 797 #define PMC_TO_MODE(P)          PMC_ID_TO_MODE((P)->pm_id)
 798 #define PMC_TO_CLASS(P)         PMC_ID_TO_CLASS((P)->pm_id)
 799 #define PMC_TO_ROWINDEX(P)      PMC_ID_TO_ROWINDEX((P)->pm_id)
 800 #define PMC_TO_CPU(P)           PMC_ID_TO_CPU((P)->pm_id)
 801
 802 /*
 803  * struct pmc_threadpmcstate
 804  *
 805  * Record per-PMC, per-thread state.
 806  */
 807 struct pmc_threadpmcstate {
 808         pmc_value_t     pt_pmcval;      /* per-thread reload count */
 809 };
 810
 811 /*
 812  * struct pmc_thread
 813  *
 814  * Record a 'target' thread being profiled.
 815  */
 816 struct pmc_thread {
 817         LIST_ENTRY(pmc_thread) pt_next;         /* linked list */
 818         struct thread   *pt_td;                 /* target thread */
 819         struct pmc_threadpmcstate pt_pmcs[];    /* per-PMC state */
 820 };
 821
 822 /*
 823  * struct pmc_process
 824  *
 825  * Record a 'target' process being profiled.
 826  *
 827  * The target process being profiled could be different from the owner
 828  * process which allocated the PMCs.  Each target process descriptor
 829  * is associated with NHWPMC 'struct pmc *' pointers.  Each PMC at a
 830  * given hardware row-index 'n' will use slot 'n' of the 'pp_pmcs[]'
 831  * array.  The size of this structure is thus PMC architecture
 832  * dependent.
 833  *
 834  */
 835
 836 struct pmc_targetstate {
 837         struct pmc      *pp_pmc;   /* target PMC */
 838         pmc_value_t     pp_pmcval; /* per-process value */
 839 };
 840
 841 struct pmc_process {
 842         LIST_ENTRY(pmc_process) pp_next;        /* hash chain */
 843         LIST_HEAD(,pmc_thread) pp_tds;          /* list of threads */
 844         struct mtx      *pp_tdslock;            /* lock on pp_tds thread list */
 845         int             pp_refcnt;              /* reference count */
 846         uint32_t        pp_flags;               /* flags PMC_PP_* */
 847         struct proc     *pp_proc;               /* target process */
 848         struct pmc_targetstate pp_pmcs[];       /* NHWPMCs */
 849 };
 850
 851 #define PMC_PP_ENABLE_MSR_ACCESS        0x00000001
 852
 853 /*
 854  * struct pmc_owner
 855  *
 856  * We associate a PMC with an 'owner' process.
 857  *
 858  * A process can be associated with 0..NCPUS*NHWPMC PMCs during its
 859  * lifetime, where NCPUS is the numbers of CPUS in the system and
 860  * NHWPMC is the number of hardware PMCs per CPU.  These are
 861  * maintained in the list headed by the 'po_pmcs' to save on space.
 862  *
 863  */
 864
 865 struct pmc_owner  {
 866         LIST_ENTRY(pmc_owner)   po_next;        /* hash chain */
 867         CK_LIST_ENTRY(pmc_owner)        po_ssnext;      /* (g/p) list of SS PMC owners */
 868         LIST_HEAD(, pmc)        po_pmcs;        /* owned PMC list */
 869         TAILQ_HEAD(, pmclog_buffer) po_logbuffers; /* (o) logbuffer list */
 870         struct mtx              po_mtx;         /* spin lock for (o) */
 871         struct proc             *po_owner;      /* owner proc */
 872         uint32_t                po_flags;       /* (k) flags PMC_PO_* */
 873         struct proc             *po_kthread;    /* (k) helper kthread */
 874         struct file             *po_file;       /* file reference */
 875         int                     po_error;       /* recorded error */
 876         short                   po_sscount;     /* # SS PMCs owned */
 877         short                   po_logprocmaps; /* global mappings done */
 878         struct pmclog_buffer    *po_curbuf[MAXCPU];     /* current log buffer */
 879 };
 880
 881 #define PMC_PO_OWNS_LOGFILE             0x00000001 /* has a log file */
 882 #define PMC_PO_SHUTDOWN                 0x00000010 /* in the process of shutdown */
 883 #define PMC_PO_INITIAL_MAPPINGS_DONE    0x00000020
 884
 885 /*
 886  * struct pmc_hw -- describe the state of the PMC hardware
 887  *
 888  * When in use, a HW PMC is associated with one allocated 'struct pmc'
 889  * pointed to by field 'phw_pmc'.  When inactive, this field is NULL.
 890  *
 891  * On an SMP box, one or more HW PMC's in process virtual mode with
 892  * the same 'phw_pmc' could be executing on different CPUs.  In order
 893  * to handle this case correctly, we need to ensure that only
 894  * incremental counts get added to the saved value in the associated
 895  * 'struct pmc'.  The 'phw_save' field is used to keep the saved PMC
 896  * value at the time the hardware is started during this context
 897  * switch (i.e., the difference between the new (hardware) count and
 898  * the saved count is atomically added to the count field in 'struct
 899  * pmc' at context switch time).
 900  *
 901  */
 902
 903 struct pmc_hw {
 904         uint32_t        phw_state;      /* see PHW_* macros below */
 905         struct pmc      *phw_pmc;       /* current thread PMC */
 906 };
 907
 908 #define PMC_PHW_RI_MASK         0x000000FF
 909 #define PMC_PHW_CPU_SHIFT       8
 910 #define PMC_PHW_CPU_MASK        0x0000FF00
 911 #define PMC_PHW_FLAGS_SHIFT     16
 912 #define PMC_PHW_FLAGS_MASK      0xFFFF0000
 913
 914 #define PMC_PHW_INDEX_TO_STATE(ri)      ((ri) & PMC_PHW_RI_MASK)
 915 #define PMC_PHW_STATE_TO_INDEX(state)   ((state) & PMC_PHW_RI_MASK)
 916 #define PMC_PHW_CPU_TO_STATE(cpu)       (((cpu) << PMC_PHW_CPU_SHIFT) & \
 917         PMC_PHW_CPU_MASK)
 918 #define PMC_PHW_STATE_TO_CPU(state)     (((state) & PMC_PHW_CPU_MASK) >> \
 919         PMC_PHW_CPU_SHIFT)
 920 #define PMC_PHW_FLAGS_TO_STATE(flags)   (((flags) << PMC_PHW_FLAGS_SHIFT) & \
 921         PMC_PHW_FLAGS_MASK)
 922 #define PMC_PHW_STATE_TO_FLAGS(state)   (((state) & PMC_PHW_FLAGS_MASK) >> \
 923         PMC_PHW_FLAGS_SHIFT)
 924 #define PMC_PHW_FLAG_IS_ENABLED         (PMC_PHW_FLAGS_TO_STATE(0x01))
 925 #define PMC_PHW_FLAG_IS_SHAREABLE       (PMC_PHW_FLAGS_TO_STATE(0x02))
 926
 927 /*
 928  * struct pmc_sample
 929  *
 930  * Space for N (tunable) PC samples and associated control data.
 931  */
 932
 933 struct pmc_sample {
 934         uint16_t                ps_nsamples;    /* callchain depth */
 935         uint16_t                ps_nsamples_actual;
 936         uint16_t                ps_cpu;         /* cpu number */
 937         uint16_t                ps_flags;       /* other flags */
 938         lwpid_t                 ps_tid;         /* thread id */
 939         pid_t                   ps_pid;         /* process PID or -1 */
 940         int             ps_ticks; /* ticks at sample time */
 941         /* pad */
 942         struct thread           *ps_td;         /* which thread */
 943         struct pmc              *ps_pmc;        /* interrupting PMC */
 944         uintptr_t               *ps_pc;         /* (const) callchain start */
 945         uint64_t                ps_tsc;         /* tsc value */
 946 };
 947
 948 #define         PMC_SAMPLE_FREE         ((uint16_t) 0)
 949 #define         PMC_USER_CALLCHAIN_PENDING      ((uint16_t) 0xFFFF)
 950
 951 struct pmc_samplebuffer {
 952         volatile uint64_t               ps_prodidx; /* producer index */
 953         volatile uint64_t               ps_considx; /* consumer index */
 954         uintptr_t               *ps_callchains; /* all saved call chains */
 955         struct pmc_sample       ps_samples[];   /* array of sample entries */
 956 };
 957
 958 #define PMC_CONS_SAMPLE(psb)                                    \
 959         (&(psb)->ps_samples[(psb)->ps_considx & pmc_sample_mask])
 960
 961 #define PMC_CONS_SAMPLE_OFF(psb, off)                                                   \
 962         (&(psb)->ps_samples[(off) & pmc_sample_mask])
 963
 964 #define PMC_PROD_SAMPLE(psb)                                    \
 965         (&(psb)->ps_samples[(psb)->ps_prodidx & pmc_sample_mask])
 966
 967 /*
 968  * struct pmc_cpustate
 969  *
 970  * A CPU is modelled as a collection of HW PMCs with space for additional
 971  * flags.
 972  */
 973
 974 struct pmc_cpu {
 975         uint32_t        pc_state;       /* physical cpu number + flags */
 976         struct pmc_samplebuffer *pc_sb[3]; /* space for samples */
 977         struct pmc_hw   *pc_hwpmcs[];   /* 'npmc' pointers */
 978 };
 979
 980 #define PMC_PCPU_CPU_MASK               0x000000FF
 981 #define PMC_PCPU_FLAGS_MASK             0xFFFFFF00
 982 #define PMC_PCPU_FLAGS_SHIFT            8
 983 #define PMC_PCPU_STATE_TO_CPU(S)        ((S) & PMC_PCPU_CPU_MASK)
 984 #define PMC_PCPU_STATE_TO_FLAGS(S)      (((S) & PMC_PCPU_FLAGS_MASK) >> PMC_PCPU_FLAGS_SHIFT)
 985 #define PMC_PCPU_FLAGS_TO_STATE(F)      (((F) << PMC_PCPU_FLAGS_SHIFT) & PMC_PCPU_FLAGS_MASK)
 986 #define PMC_PCPU_CPU_TO_STATE(C)        ((C) & PMC_PCPU_CPU_MASK)
 987 #define PMC_PCPU_FLAG_HTT               (PMC_PCPU_FLAGS_TO_STATE(0x1))
 988
 989 /*
 990  * struct pmc_binding
 991  *
 992  * CPU binding information.
 993  */
 994
 995 struct pmc_binding {
 996         int     pb_bound;       /* is bound? */
 997         int     pb_cpu;         /* if so, to which CPU */
 998 };
 999
1000
1001 struct pmc_mdep;
1002
1003 /*
1004  * struct pmc_classdep
1005  *
1006  * PMC class-dependent operations.
1007  */
1008 struct pmc_classdep {
1009         uint32_t        pcd_caps;       /* class capabilities */
1010         enum pmc_class  pcd_class;      /* class id */
1011         int             pcd_num;        /* number of PMCs */
1012         int             pcd_ri;         /* row index of the first PMC in class */
1013         int             pcd_width;      /* width of the PMC */
1014
1015         /* configuring/reading/writing the hardware PMCs */
1016         int (*pcd_config_pmc)(int _cpu, int _ri, struct pmc *_pm);
1017         int (*pcd_get_config)(int _cpu, int _ri, struct pmc **_ppm);
1018         int (*pcd_read_pmc)(int _cpu, int _ri, pmc_value_t *_value);
1019         int (*pcd_write_pmc)(int _cpu, int _ri, pmc_value_t _value);
1020
1021         /* pmc allocation/release */
1022         int (*pcd_allocate_pmc)(int _cpu, int _ri, struct pmc *_t,
1023                 const struct pmc_op_pmcallocate *_a);
1024         int (*pcd_release_pmc)(int _cpu, int _ri, struct pmc *_pm);
1025
1026         /* starting and stopping PMCs */
1027         int (*pcd_start_pmc)(int _cpu, int _ri);
1028         int (*pcd_stop_pmc)(int _cpu, int _ri);
1029
1030         /* description */
1031         int (*pcd_describe)(int _cpu, int _ri, struct pmc_info *_pi,
1032                 struct pmc **_ppmc);
1033
1034         /* class-dependent initialization & finalization */
1035         int (*pcd_pcpu_init)(struct pmc_mdep *_md, int _cpu);
1036         int (*pcd_pcpu_fini)(struct pmc_mdep *_md, int _cpu);
1037
1038         /* machine-specific interface */
1039         int (*pcd_get_msr)(int _ri, uint32_t *_msr);
1040 };
1041
1042 /*
1043  * struct pmc_mdep
1044  *
1045  * Machine dependent bits needed per CPU type.
1046  */
1047
1048 struct pmc_mdep  {
1049         uint32_t        pmd_cputype;    /* from enum pmc_cputype */
1050         uint32_t        pmd_npmc;       /* number of PMCs per CPU */
1051         uint32_t        pmd_nclass;     /* number of PMC classes present */
1052
1053         /*
1054          * Machine dependent methods.
1055          */
1056
1057         /* per-cpu initialization and finalization */
1058         int (*pmd_pcpu_init)(struct pmc_mdep *_md, int _cpu);
1059         int (*pmd_pcpu_fini)(struct pmc_mdep *_md, int _cpu);
1060
1061         /* thread context switch in/out */
1062         int (*pmd_switch_in)(struct pmc_cpu *_p, struct pmc_process *_pp);
1063         int (*pmd_switch_out)(struct pmc_cpu *_p, struct pmc_process *_pp);
1064
1065         /* handle a PMC interrupt */
1066         int (*pmd_intr)(struct trapframe *_tf);
1067
1068         /*
1069          * PMC class dependent information.
1070          */
1071         struct pmc_classdep pmd_classdep[];
1072 };
1073
1074 /*
1075  * Per-CPU state.  This is an array of 'mp_ncpu' pointers
1076  * to struct pmc_cpu descriptors.
1077  */
1078
1079 extern struct pmc_cpu **pmc_pcpu;
1080
1081 /* driver statistics */
1082 extern struct pmc_driverstats pmc_stats;
1083
1084 #if     defined(HWPMC_DEBUG)
1085 #include <sys/ktr.h>
1086
1087 /* debug flags, major flag groups */
1088 struct pmc_debugflags {
1089         int     pdb_CPU;
1090         int     pdb_CSW;
1091         int     pdb_LOG;
1092         int     pdb_MDP;
1093         int     pdb_MOD;
1094         int     pdb_OWN;
1095         int     pdb_PMC;
1096         int     pdb_PRC;
1097         int     pdb_SAM;
1098 };
1099
1100 extern struct pmc_debugflags pmc_debugflags;
1101
1102 #define KTR_PMC                 KTR_SUBSYS
1103
1104 #define PMC_DEBUG_STRSIZE               128
1105 #define PMC_DEBUG_DEFAULT_FLAGS         { 0, 0, 0, 0, 0, 0, 0, 0, 0 }
1106
1107 #define PMCDBG0(M, N, L, F) do {                                        \
1108         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1109                 CTR0(KTR_PMC, #M ":" #N ":" #L  ": " F);                \
1110 } while (0)
1111 #define PMCDBG1(M, N, L, F, p1) do {                                    \
1112         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1113                 CTR1(KTR_PMC, #M ":" #N ":" #L  ": " F, p1);            \
1114 } while (0)
1115 #define PMCDBG2(M, N, L, F, p1, p2) do {                                \
1116         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1117                 CTR2(KTR_PMC, #M ":" #N ":" #L  ": " F, p1, p2);        \
1118 } while (0)
1119 #define PMCDBG3(M, N, L, F, p1, p2, p3) do {                            \
1120         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1121                 CTR3(KTR_PMC, #M ":" #N ":" #L  ": " F, p1, p2, p3);    \
1122 } while (0)
1123 #define PMCDBG4(M, N, L, F, p1, p2, p3, p4) do {                        \
1124         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1125                 CTR4(KTR_PMC, #M ":" #N ":" #L  ": " F, p1, p2, p3, p4);\
1126 } while (0)
1127 #define PMCDBG5(M, N, L, F, p1, p2, p3, p4, p5) do {                    \
1128         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1129                 CTR5(KTR_PMC, #M ":" #N ":" #L  ": " F, p1, p2, p3, p4, \
1130                     p5);                                                \
1131 } while (0)
1132 #define PMCDBG6(M, N, L, F, p1, p2, p3, p4, p5, p6) do {                \
1133         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1134                 CTR6(KTR_PMC, #M ":" #N ":" #L  ": " F, p1, p2, p3, p4, \
1135                     p5, p6);                                            \
1136 } while (0)
1137
1138 /* Major numbers */
1139 #define PMC_DEBUG_MAJ_CPU               0 /* cpu switches */
1140 #define PMC_DEBUG_MAJ_CSW               1 /* context switches */
1141 #define PMC_DEBUG_MAJ_LOG               2 /* logging */
1142 #define PMC_DEBUG_MAJ_MDP               3 /* machine dependent */
1143 #define PMC_DEBUG_MAJ_MOD               4 /* misc module infrastructure */
1144 #define PMC_DEBUG_MAJ_OWN               5 /* owner */
1145 #define PMC_DEBUG_MAJ_PMC               6 /* pmc management */
1146 #define PMC_DEBUG_MAJ_PRC               7 /* processes */
1147 #define PMC_DEBUG_MAJ_SAM               8 /* sampling */
1148
1149 /* Minor numbers */
1150
1151 /* Common (8 bits) */
1152 #define PMC_DEBUG_MIN_ALL               0 /* allocation */
1153 #define PMC_DEBUG_MIN_REL               1 /* release */
1154 #define PMC_DEBUG_MIN_OPS               2 /* ops: start, stop, ... */
1155 #define PMC_DEBUG_MIN_INI               3 /* init */
1156 #define PMC_DEBUG_MIN_FND               4 /* find */
1157
1158 /* MODULE */
1159 #define PMC_DEBUG_MIN_PMH              14 /* pmc_hook */
1160 #define PMC_DEBUG_MIN_PMS              15 /* pmc_syscall */
1161
1162 /* OWN */
1163 #define PMC_DEBUG_MIN_ORM               8 /* owner remove */
1164 #define PMC_DEBUG_MIN_OMR               9 /* owner maybe remove */
1165
1166 /* PROCESSES */
1167 #define PMC_DEBUG_MIN_TLK               8 /* link target */
1168 #define PMC_DEBUG_MIN_TUL               9 /* unlink target */
1169 #define PMC_DEBUG_MIN_EXT              10 /* process exit */
1170 #define PMC_DEBUG_MIN_EXC              11 /* process exec */
1171 #define PMC_DEBUG_MIN_FRK              12 /* process fork */
1172 #define PMC_DEBUG_MIN_ATT              13 /* attach/detach */
1173 #define PMC_DEBUG_MIN_SIG              14 /* signalling */
1174
1175 /* CONTEXT SWITCHES */
1176 #define PMC_DEBUG_MIN_SWI               8 /* switch in */
1177 #define PMC_DEBUG_MIN_SWO               9 /* switch out */
1178
1179 /* PMC */
1180 #define PMC_DEBUG_MIN_REG               8 /* pmc register */
1181 #define PMC_DEBUG_MIN_ALR               9 /* allocate row */
1182
1183 /* MACHINE DEPENDENT LAYER */
1184 #define PMC_DEBUG_MIN_REA               8 /* read */
1185 #define PMC_DEBUG_MIN_WRI               9 /* write */
1186 #define PMC_DEBUG_MIN_CFG              10 /* config */
1187 #define PMC_DEBUG_MIN_STA              11 /* start */
1188 #define PMC_DEBUG_MIN_STO              12 /* stop */
1189 #define PMC_DEBUG_MIN_INT              13 /* interrupts */
1190
1191 /* CPU */
1192 #define PMC_DEBUG_MIN_BND               8 /* bind */
1193 #define PMC_DEBUG_MIN_SEL               9 /* select */
1194
1195 /* LOG */
1196 #define PMC_DEBUG_MIN_GTB               8 /* get buf */
1197 #define PMC_DEBUG_MIN_SIO               9 /* schedule i/o */
1198 #define PMC_DEBUG_MIN_FLS              10 /* flush */
1199 #define PMC_DEBUG_MIN_SAM              11 /* sample */
1200 #define PMC_DEBUG_MIN_CLO              12 /* close */
1201
1202 #else
1203 #define PMCDBG0(M, N, L, F)             /* nothing */
1204 #define PMCDBG1(M, N, L, F, p1)
1205 #define PMCDBG2(M, N, L, F, p1, p2)
1206 #define PMCDBG3(M, N, L, F, p1, p2, p3)
1207 #define PMCDBG4(M, N, L, F, p1, p2, p3, p4)
1208 #define PMCDBG5(M, N, L, F, p1, p2, p3, p4, p5)
1209 #define PMCDBG6(M, N, L, F, p1, p2, p3, p4, p5, p6)
1210 #endif
1211
1212 /* declare a dedicated memory pool */
1213 MALLOC_DECLARE(M_PMC);
1214
1215 /*
1216  * Functions
1217  */
1218
1219 struct pmc_mdep *pmc_md_initialize(void);       /* MD init function */
1220 void    pmc_md_finalize(struct pmc_mdep *_md);  /* MD fini function */
1221 int     pmc_getrowdisp(int _ri);
1222 int     pmc_process_interrupt(int _ring, struct pmc *_pm, struct trapframe *_tf);
1223 int     pmc_save_kernel_callchain(uintptr_t *_cc, int _maxsamples,
1224     struct trapframe *_tf);
1225 int     pmc_save_user_callchain(uintptr_t *_cc, int _maxsamples,
1226     struct trapframe *_tf);
1227 struct pmc_mdep *pmc_mdep_alloc(int nclasses);
1228 void pmc_mdep_free(struct pmc_mdep *md);
1229 uint64_t pmc_rdtsc(void);
1230 #endif /* _KERNEL */
1231 #endif /* _SYS_PMC_H_ */