sys/sys/pmc.h

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