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       0x05
  65 #define PMC_VERSION_MINOR       0x01
  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 /*
  72  * Kinds of CPUs known.
  73  *
  74  * We keep track of CPU variants that need to be distinguished in
  75  * some way for PMC operations.  CPU names are grouped by manufacturer
  76  * and numbered sparsely in order to minimize changes to the ABI involved
  77  * when new CPUs are added.
  78  */
  79
  80 #define __PMC_CPUS()                                            \
  81         __PMC_CPU(AMD_K7,       0x00,   "AMD K7")               \
  82         __PMC_CPU(AMD_K8,       0x01,   "AMD K8")               \
  83         __PMC_CPU(INTEL_P5,     0x80,   "Intel Pentium")        \
  84         __PMC_CPU(INTEL_P6,     0x81,   "Intel Pentium Pro")    \
  85         __PMC_CPU(INTEL_CL,     0x82,   "Intel Celeron")        \
  86         __PMC_CPU(INTEL_PII,    0x83,   "Intel Pentium II")     \
  87         __PMC_CPU(INTEL_PIII,   0x84,   "Intel Pentium III")    \
  88         __PMC_CPU(INTEL_PM,     0x85,   "Intel Pentium M")      \
  89         __PMC_CPU(INTEL_PIV,    0x86,   "Intel Pentium IV")     \
  90         __PMC_CPU(INTEL_CORE,   0x87,   "Intel Core Solo/Duo")  \
  91         __PMC_CPU(INTEL_CORE2,  0x88,   "Intel Core2")          \
  92         __PMC_CPU(INTEL_CORE2EXTREME,   0x89,   "Intel Core2 Extreme")  \
  93         __PMC_CPU(INTEL_ATOM,   0x8A,   "Intel Atom")           \
  94         __PMC_CPU(INTEL_COREI7, 0x8B,   "Intel Core i7")        \
  95         __PMC_CPU(INTEL_WESTMERE, 0x8C,   "Intel Westmere")     \
  96         __PMC_CPU(INTEL_SANDYBRIDGE, 0x8D,   "Intel Sandy Bridge")      \
  97         __PMC_CPU(INTEL_IVYBRIDGE, 0x8E,   "Intel Ivy Bridge")  \
  98         __PMC_CPU(INTEL_SANDYBRIDGE_XEON, 0x8F,   "Intel Sandy Bridge Xeon")    \
  99         __PMC_CPU(INTEL_IVYBRIDGE_XEON, 0x90,   "Intel Ivy Bridge Xeon")        \
 100         __PMC_CPU(INTEL_HASWELL, 0x91,   "Intel Haswell")       \
 101         __PMC_CPU(INTEL_ATOM_SILVERMONT, 0x92,  "Intel Atom Silvermont")    \
 102         __PMC_CPU(INTEL_NEHALEM_EX, 0x93,   "Intel Nehalem Xeon 7500")  \
 103         __PMC_CPU(INTEL_WESTMERE_EX, 0x94,   "Intel Westmere Xeon E7")  \
 104         __PMC_CPU(INTEL_HASWELL_XEON, 0x95,   "Intel Haswell Xeon E5 v3") \
 105         __PMC_CPU(INTEL_BROADWELL, 0x96,   "Intel Broadwell") \
 106         __PMC_CPU(INTEL_BROADWELL_XEON, 0x97,   "Intel Broadwell Xeon") \
 107         __PMC_CPU(INTEL_SKYLAKE, 0x98,   "Intel Skylake")               \
 108         __PMC_CPU(INTEL_SKYLAKE_XEON, 0x99,   "Intel Skylake Xeon")     \
 109         __PMC_CPU(INTEL_XSCALE, 0x100,  "Intel XScale")         \
 110         __PMC_CPU(MIPS_24K,     0x200,  "MIPS 24K")             \
 111         __PMC_CPU(MIPS_OCTEON,  0x201,  "Cavium Octeon")        \
 112         __PMC_CPU(MIPS_74K,     0x202,  "MIPS 74K")             \
 113         __PMC_CPU(PPC_7450,     0x300,  "PowerPC MPC7450")      \
 114         __PMC_CPU(PPC_E500,     0x340,  "PowerPC e500 Core")    \
 115         __PMC_CPU(PPC_970,      0x380,  "IBM PowerPC 970")      \
 116         __PMC_CPU(GENERIC,      0x400,  "Generic")              \
 117         __PMC_CPU(ARMV7_CORTEX_A5,      0x500,  "ARMv7 Cortex A5")      \
 118         __PMC_CPU(ARMV7_CORTEX_A7,      0x501,  "ARMv7 Cortex A7")      \
 119         __PMC_CPU(ARMV7_CORTEX_A8,      0x502,  "ARMv7 Cortex A8")      \
 120         __PMC_CPU(ARMV7_CORTEX_A9,      0x503,  "ARMv7 Cortex A9")      \
 121         __PMC_CPU(ARMV7_CORTEX_A15,     0x504,  "ARMv7 Cortex A15")     \
 122         __PMC_CPU(ARMV7_CORTEX_A17,     0x505,  "ARMv7 Cortex A17")     \
 123         __PMC_CPU(ARMV8_CORTEX_A53,     0x600,  "ARMv8 Cortex A53")     \
 124         __PMC_CPU(ARMV8_CORTEX_A57,     0x601,  "ARMv8 Cortex A57")
 125
 126 enum pmc_cputype {
 127 #undef  __PMC_CPU
 128 #define __PMC_CPU(S,V,D)        PMC_CPU_##S = V,
 129         __PMC_CPUS()
 130 };
 131
 132 #define PMC_CPU_FIRST   PMC_CPU_AMD_K7
 133 #define PMC_CPU_LAST    PMC_CPU_GENERIC
 134
 135 /*
 136  * Classes of PMCs
 137  */
 138
 139 #define __PMC_CLASSES()                                                 \
 140         __PMC_CLASS(TSC,        0x00,   "CPU Timestamp counter")        \
 141         __PMC_CLASS(K7,         0x01,   "AMD K7 performance counters")  \
 142         __PMC_CLASS(K8,         0x02,   "AMD K8 performance counters")  \
 143         __PMC_CLASS(P5,         0x03,   "Intel Pentium counters")       \
 144         __PMC_CLASS(P6,         0x04,   "Intel Pentium Pro counters")   \
 145         __PMC_CLASS(P4,         0x05,   "Intel Pentium-IV counters")    \
 146         __PMC_CLASS(IAF,        0x06,   "Intel Core2/Atom, fixed function") \
 147         __PMC_CLASS(IAP,        0x07,   "Intel Core...Atom, programmable") \
 148         __PMC_CLASS(UCF,        0x08,   "Intel Uncore fixed function")  \
 149         __PMC_CLASS(UCP,        0x09,   "Intel Uncore programmable")    \
 150         __PMC_CLASS(XSCALE,     0x0A,   "Intel XScale counters")        \
 151         __PMC_CLASS(MIPS24K,    0x0B,   "MIPS 24K")                     \
 152         __PMC_CLASS(OCTEON,     0x0C,   "Cavium Octeon")                \
 153         __PMC_CLASS(PPC7450,    0x0D,   "Motorola MPC7450 class")       \
 154         __PMC_CLASS(PPC970,     0x0E,   "IBM PowerPC 970 class")        \
 155         __PMC_CLASS(SOFT,       0x0F,   "Software events")              \
 156         __PMC_CLASS(ARMV7,      0x10,   "ARMv7")                        \
 157         __PMC_CLASS(ARMV8,      0x11,   "ARMv8")                        \
 158         __PMC_CLASS(MIPS74K,    0x12,   "MIPS 74K")                     \
 159         __PMC_CLASS(E500,       0x13,   "Freescale e500 class")
 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_E500
 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
 298 enum pmc_caps
 299 {
 300 #undef  __PMC_CAP
 301 #define __PMC_CAP(NAME, VALUE, DESCR)   PMC_CAP_##NAME = (1 << VALUE) ,
 302         __PMC_CAPS()
 303 };
 304
 305 #define PMC_CAP_FIRST           PMC_CAP_INTERRUPT
 306 #define PMC_CAP_LAST            PMC_CAP_CASCADE
 307
 308 /*
 309  * PMC Event Numbers
 310  *
 311  * These are generated from the definitions in "dev/hwpmc/pmc_events.h".
 312  */
 313
 314 enum pmc_event {
 315 #undef  __PMC_EV
 316 #undef  __PMC_EV_BLOCK
 317 #define __PMC_EV_BLOCK(C,V)     PMC_EV_ ## C ## __BLOCK_START = (V) - 1 ,
 318 #define __PMC_EV(C,N)           PMC_EV_ ## C ## _ ## N ,
 319         __PMC_EVENTS()
 320 };
 321
 322 /*
 323  * PMC SYSCALL INTERFACE
 324  */
 325
 326 /*
 327  * "PMC_OPS" -- these are the commands recognized by the kernel
 328  * module, and are used when performing a system call from userland.
 329  */
 330 #define __PMC_OPS()                                                     \
 331         __PMC_OP(CONFIGURELOG, "Set log file")                          \
 332         __PMC_OP(FLUSHLOG, "Flush log file")                            \
 333         __PMC_OP(GETCPUINFO, "Get system CPU information")              \
 334         __PMC_OP(GETDRIVERSTATS, "Get driver statistics")               \
 335         __PMC_OP(GETMODULEVERSION, "Get module version")                \
 336         __PMC_OP(GETPMCINFO, "Get per-cpu PMC information")             \
 337         __PMC_OP(PMCADMIN, "Set PMC state")                             \
 338         __PMC_OP(PMCALLOCATE, "Allocate and configure a PMC")           \
 339         __PMC_OP(PMCATTACH, "Attach a PMC to a process")                \
 340         __PMC_OP(PMCDETACH, "Detach a PMC from a process")              \
 341         __PMC_OP(PMCGETMSR, "Get a PMC's hardware address")             \
 342         __PMC_OP(PMCRELEASE, "Release a PMC")                           \
 343         __PMC_OP(PMCRW, "Read/Set a PMC")                               \
 344         __PMC_OP(PMCSETCOUNT, "Set initial count/sampling rate")        \
 345         __PMC_OP(PMCSTART, "Start a PMC")                               \
 346         __PMC_OP(PMCSTOP, "Stop a PMC")                                 \
 347         __PMC_OP(WRITELOG, "Write a cookie to the log file")            \
 348         __PMC_OP(CLOSELOG, "Close log file")                            \
 349         __PMC_OP(GETDYNEVENTINFO, "Get dynamic events list")
 350
 351
 352 enum pmc_ops {
 353 #undef  __PMC_OP
 354 #define __PMC_OP(N, D)  PMC_OP_##N,
 355         __PMC_OPS()
 356 };
 357
 358
 359 /*
 360  * Flags used in operations on PMCs.
 361  */
 362
 363 #define PMC_F_FORCE             0x00000001 /*OP ADMIN force operation */
 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 #define PMC_F_KGMON             0x00000040 /*OP ALLOCATE kgmon(8) profiling */
 370 /* V2 API */
 371 #define PMC_F_CALLCHAIN         0x00000080 /*OP ALLOCATE capture callchains */
 372
 373 /* internal flags */
 374 #define PMC_F_ATTACHED_TO_OWNER 0x00010000 /*attached to owner*/
 375 #define PMC_F_NEEDS_LOGFILE     0x00020000 /*needs log file */
 376 #define PMC_F_ATTACH_DONE       0x00040000 /*attached at least once */
 377
 378 #define PMC_CALLCHAIN_DEPTH_MAX 128
 379
 380 #define PMC_CC_F_USERSPACE      0x01       /*userspace callchain*/
 381
 382 /*
 383  * Cookies used to denote allocated PMCs, and the values of PMCs.
 384  */
 385
 386 typedef uint32_t        pmc_id_t;
 387 typedef uint64_t        pmc_value_t;
 388
 389 #define PMC_ID_INVALID          (~ (pmc_id_t) 0)
 390
 391 /*
 392  * PMC IDs have the following format:
 393  *
 394  * +--------+----------+-----------+-----------+
 395  * |   CPU  | PMC MODE | PMC CLASS | ROW INDEX |
 396  * +--------+----------+-----------+-----------+
 397  *
 398  * where each field is 8 bits wide.  Field 'CPU' is set to the
 399  * requested CPU for system-wide PMCs or PMC_CPU_ANY for process-mode
 400  * PMCs.  Field 'PMC MODE' is the allocated PMC mode.  Field 'PMC
 401  * CLASS' is the class of the PMC.  Field 'ROW INDEX' is the row index
 402  * for the PMC.
 403  *
 404  * The 'ROW INDEX' ranges over 0..NWPMCS where NHWPMCS is the total
 405  * number of hardware PMCs on this cpu.
 406  */
 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) & 0xFF0000) >> 16)
 412 #define PMC_ID_TO_CPU(ID)       (((ID) & 0xFF000000) >> 24)
 413 #define PMC_ID_MAKE_ID(CPU,MODE,CLASS,ROWINDEX)                 \
 414         ((((CPU) & 0xFF) << 24) | (((MODE) & 0xFF) << 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
 438         union pmc_md_op_pmcallocate pm_md; /* MD layer extensions */
 439 };
 440
 441 /*
 442  * OP PMCADMIN
 443  *
 444  * Set the administrative state (i.e., whether enabled or disabled) of
 445  * a PMC 'pm_pmc' on CPU 'pm_cpu'.  Note that 'pm_pmc' specifies an
 446  * absolute PMC number and need not have been first allocated by the
 447  * calling process.
 448  */
 449
 450 struct pmc_op_pmcadmin {
 451         int             pm_cpu;         /* CPU# */
 452         uint32_t        pm_flags;       /* flags */
 453         int             pm_pmc;         /* PMC# */
 454         enum pmc_state  pm_state;       /* desired state */
 455 };
 456
 457 /*
 458  * OP PMCATTACH / OP PMCDETACH
 459  *
 460  * Attach/detach a PMC and a process.
 461  */
 462
 463 struct pmc_op_pmcattach {
 464         pmc_id_t        pm_pmc;         /* PMC to attach to */
 465         pid_t           pm_pid;         /* target process */
 466 };
 467
 468 /*
 469  * OP PMCSETCOUNT
 470  *
 471  * Set the sampling rate (i.e., the reload count) for statistical counters.
 472  * 'pm_pmcid' need to have been previously allocated using PMCALLOCATE.
 473  */
 474
 475 struct pmc_op_pmcsetcount {
 476         pmc_value_t     pm_count;       /* initial/sample count */
 477         pmc_id_t        pm_pmcid;       /* PMC id to set */
 478 };
 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
 489 struct pmc_op_pmcrw {
 490         uint32_t        pm_flags;       /* PMC_F_{OLD,NEW}VALUE*/
 491         pmc_id_t        pm_pmcid;       /* pmc id */
 492         pmc_value_t     pm_value;       /* new&returned value */
 493 };
 494
 495
 496 /*
 497  * OP GETPMCINFO
 498  *
 499  * retrieve PMC state for a named CPU.  The caller is expected to
 500  * allocate 'npmc' * 'struct pmc_info' bytes of space for the return
 501  * values.
 502  */
 503
 504 struct pmc_info {
 505         char            pm_name[PMC_NAME_MAX]; /* pmc name */
 506         enum pmc_class  pm_class;       /* enum pmc_class */
 507         int             pm_enabled;     /* whether enabled */
 508         enum pmc_disp   pm_rowdisp;     /* FREE, THREAD or STANDLONE */
 509         pid_t           pm_ownerpid;    /* owner, or -1 */
 510         enum pmc_mode   pm_mode;        /* current mode [enum pmc_mode] */
 511         enum pmc_event  pm_event;       /* current event */
 512         uint32_t        pm_flags;       /* current flags */
 513         pmc_value_t     pm_reloadcount; /* sampling counters only */
 514 };
 515
 516 struct pmc_op_getpmcinfo {
 517         int32_t         pm_cpu;         /* 0 <= cpu < mp_maxid */
 518         struct pmc_info pm_pmcs[];      /* space for 'npmc' structures */
 519 };
 520
 521
 522 /*
 523  * OP GETCPUINFO
 524  *
 525  * Retrieve system CPU information.
 526  */
 527
 528
 529 struct pmc_classinfo {
 530         enum pmc_class  pm_class;       /* class id */
 531         uint32_t        pm_caps;        /* counter capabilities */
 532         uint32_t        pm_width;       /* width of the PMC */
 533         uint32_t        pm_num;         /* number of PMCs in class */
 534 };
 535
 536 struct pmc_op_getcpuinfo {
 537         enum pmc_cputype pm_cputype; /* what kind of CPU */
 538         uint32_t        pm_ncpu;    /* max CPU number */
 539         uint32_t        pm_npmc;    /* #PMCs per CPU */
 540         uint32_t        pm_nclass;  /* #classes of PMCs */
 541         struct pmc_classinfo  pm_classes[PMC_CLASS_MAX];
 542 };
 543
 544 /*
 545  * OP CONFIGURELOG
 546  *
 547  * Configure a log file for writing system-wide statistics to.
 548  */
 549
 550 struct pmc_op_configurelog {
 551         int             pm_flags;
 552         int             pm_logfd;   /* logfile fd (or -1) */
 553 };
 554
 555 /*
 556  * OP GETDRIVERSTATS
 557  *
 558  * Retrieve pmc(4) driver-wide statistics.
 559  */
 560 #ifdef _KERNEL
 561 struct pmc_driverstats {
 562         counter_u64_t   pm_intr_ignored;        /* #interrupts ignored */
 563         counter_u64_t   pm_intr_processed;      /* #interrupts processed */
 564         counter_u64_t   pm_intr_bufferfull;     /* #interrupts with ENOSPC */
 565         counter_u64_t   pm_syscalls;            /* #syscalls */
 566         counter_u64_t   pm_syscall_errors;      /* #syscalls with errors */
 567         counter_u64_t   pm_buffer_requests;     /* #buffer requests */
 568         counter_u64_t   pm_buffer_requests_failed; /* #failed buffer requests */
 569         counter_u64_t   pm_log_sweeps;          /* #sample buffer processing
 570                                                    passes */
 571 };
 572 #endif
 573
 574 struct pmc_op_getdriverstats {
 575         unsigned int    pm_intr_ignored;        /* #interrupts ignored */
 576         unsigned int    pm_intr_processed;      /* #interrupts processed */
 577         unsigned int    pm_intr_bufferfull;     /* #interrupts with ENOSPC */
 578         unsigned int    pm_syscalls;            /* #syscalls */
 579         unsigned int    pm_syscall_errors;      /* #syscalls with errors */
 580         unsigned int    pm_buffer_requests;     /* #buffer requests */
 581         unsigned int    pm_buffer_requests_failed; /* #failed buffer requests */
 582         unsigned int    pm_log_sweeps;          /* #sample buffer processing
 583                                                    passes */
 584 };
 585
 586 /*
 587  * OP RELEASE / OP START / OP STOP
 588  *
 589  * Simple operations on a PMC id.
 590  */
 591
 592 struct pmc_op_simple {
 593         pmc_id_t        pm_pmcid;
 594 };
 595
 596 /*
 597  * OP WRITELOG
 598  *
 599  * Flush the current log buffer and write 4 bytes of user data to it.
 600  */
 601
 602 struct pmc_op_writelog {
 603         uint32_t        pm_userdata;
 604 };
 605
 606 /*
 607  * OP GETMSR
 608  *
 609  * Retrieve the machine specific address associated with the allocated
 610  * PMC.  This number can be used subsequently with a read-performance-counter
 611  * instruction.
 612  */
 613
 614 struct pmc_op_getmsr {
 615         uint32_t        pm_msr;         /* machine specific address */
 616         pmc_id_t        pm_pmcid;       /* allocated pmc id */
 617 };
 618
 619 /*
 620  * OP GETDYNEVENTINFO
 621  *
 622  * Retrieve a PMC dynamic class events list.
 623  */
 624
 625 struct pmc_dyn_event_descr {
 626         char            pm_ev_name[PMC_NAME_MAX];
 627         enum pmc_event  pm_ev_code;
 628 };
 629
 630 struct pmc_op_getdyneventinfo {
 631         enum pmc_class                  pm_class;
 632         unsigned int                    pm_nevent;
 633         struct pmc_dyn_event_descr      pm_events[PMC_EV_DYN_COUNT];
 634 };
 635
 636 #ifdef _KERNEL
 637
 638 #include <sys/malloc.h>
 639 #include <sys/sysctl.h>
 640 #include <sys/_cpuset.h>
 641
 642 #include <machine/frame.h>
 643
 644 #define PMC_HASH_SIZE                           1024
 645 #define PMC_MTXPOOL_SIZE                        2048
 646 #define PMC_LOG_BUFFER_SIZE                     128
 647 #define PMC_NLOGBUFFERS_PCPU            8
 648 #define PMC_NSAMPLES                            64
 649 #define PMC_CALLCHAIN_DEPTH                     32
 650 #define PMC_THREADLIST_MAX                      64
 651
 652 #define PMC_SYSCTL_NAME_PREFIX "kern." PMC_MODULE_NAME "."
 653
 654 /*
 655  * Locking keys
 656  *
 657  * (b) - pmc_bufferlist_mtx (spin lock)
 658  * (k) - pmc_kthread_mtx (sleep lock)
 659  * (o) - po->po_mtx (spin lock)
 660  * (g) - global_epoch_preempt (epoch)
 661  * (p) - pmc_sx (sx)
 662  */
 663
 664 /*
 665  * PMC commands
 666  */
 667
 668 struct pmc_syscall_args {
 669         register_t      pmop_code;      /* one of PMC_OP_* */
 670         void            *pmop_data;     /* syscall parameter */
 671 };
 672
 673 /*
 674  * Interface to processor specific s1tuff
 675  */
 676
 677 /*
 678  * struct pmc_descr
 679  *
 680  * Machine independent (i.e., the common parts) of a human readable
 681  * PMC description.
 682  */
 683
 684 struct pmc_descr {
 685         char            pd_name[PMC_NAME_MAX]; /* name */
 686         uint32_t        pd_caps;        /* capabilities */
 687         enum pmc_class  pd_class;       /* class of the PMC */
 688         uint32_t        pd_width;       /* width in bits */
 689 };
 690
 691 /*
 692  * struct pmc_target
 693  *
 694  * This structure records all the target processes associated with a
 695  * PMC.
 696  */
 697
 698 struct pmc_target {
 699         LIST_ENTRY(pmc_target)  pt_next;
 700         struct pmc_process      *pt_process; /* target descriptor */
 701 };
 702
 703 /*
 704  * struct pmc
 705  *
 706  * Describes each allocated PMC.
 707  *
 708  * Each PMC has precisely one owner, namely the process that allocated
 709  * the PMC.
 710  *
 711  * A PMC may be attached to multiple target processes.  The
 712  * 'pm_targets' field links all the target processes being monitored
 713  * by this PMC.
 714  *
 715  * The 'pm_savedvalue' field is protected by a mutex.
 716  *
 717  * On a multi-cpu machine, multiple target threads associated with a
 718  * process-virtual PMC could be concurrently executing on different
 719  * CPUs.  The 'pm_runcount' field is atomically incremented every time
 720  * the PMC gets scheduled on a CPU and atomically decremented when it
 721  * get descheduled.  Deletion of a PMC is only permitted when this
 722  * field is '0'.
 723  *
 724  */
 725 struct pmc_pcpu_state {
 726         uint8_t pps_stalled;
 727         uint8_t pps_cpustate;
 728 } __aligned(CACHE_LINE_SIZE);
 729 struct pmc {
 730         LIST_HEAD(,pmc_target)  pm_targets;     /* list of target processes */
 731         LIST_ENTRY(pmc)         pm_next;        /* owner's list */
 732
 733         /*
 734          * System-wide PMCs are allocated on a CPU and are not moved
 735          * around.  For system-wide PMCs we record the CPU the PMC was
 736          * allocated on in the 'CPU' field of the pmc ID.
 737          *
 738          * Virtual PMCs run on whichever CPU is currently executing
 739          * their targets' threads.  For these PMCs we need to save
 740          * their current PMC counter values when they are taken off
 741          * CPU.
 742          */
 743
 744         union {
 745                 pmc_value_t     pm_savedvalue;  /* Virtual PMCS */
 746         } pm_gv;
 747
 748         /*
 749          * For sampling mode PMCs, we keep track of the PMC's "reload
 750          * count", which is the counter value to be loaded in when
 751          * arming the PMC for the next counting session.  For counting
 752          * modes on PMCs that are read-only (e.g., the x86 TSC), we
 753          * keep track of the initial value at the start of
 754          * counting-mode operation.
 755          */
 756
 757         union {
 758                 pmc_value_t     pm_reloadcount; /* sampling PMC modes */
 759                 pmc_value_t     pm_initial;     /* counting PMC modes */
 760         } pm_sc;
 761
 762         struct pmc_pcpu_state *pm_pcpu_state;
 763         volatile cpuset_t pm_cpustate;  /* CPUs where PMC should be active */
 764         uint32_t        pm_caps;        /* PMC capabilities */
 765         enum pmc_event  pm_event;       /* event being measured */
 766         uint32_t        pm_flags;       /* additional flags PMC_F_... */
 767         struct pmc_owner *pm_owner;     /* owner thread state */
 768         counter_u64_t           pm_runcount;    /* #cpus currently on */
 769         enum pmc_state  pm_state;       /* current PMC state */
 770         uint32_t        pm_overflowcnt; /* count overflow interrupts */
 771
 772         /*
 773          * The PMC ID field encodes the row-index for the PMC, its
 774          * mode, class and the CPU# associated with the PMC.
 775          */
 776
 777         pmc_id_t        pm_id;          /* allocated PMC id */
 778         enum pmc_class pm_class;
 779
 780         /* md extensions */
 781         union pmc_md_pmc        pm_md;
 782 };
 783
 784 /*
 785  * Accessor macros for 'struct pmc'
 786  */
 787
 788 #define PMC_TO_MODE(P)          PMC_ID_TO_MODE((P)->pm_id)
 789 #define PMC_TO_CLASS(P)         PMC_ID_TO_CLASS((P)->pm_id)
 790 #define PMC_TO_ROWINDEX(P)      PMC_ID_TO_ROWINDEX((P)->pm_id)
 791 #define PMC_TO_CPU(P)           PMC_ID_TO_CPU((P)->pm_id)
 792
 793 /*
 794  * struct pmc_threadpmcstate
 795  *
 796  * Record per-PMC, per-thread state.
 797  */
 798 struct pmc_threadpmcstate {
 799         pmc_value_t     pt_pmcval;      /* per-thread reload count */
 800 };
 801
 802 /*
 803  * struct pmc_thread
 804  *
 805  * Record a 'target' thread being profiled.
 806  */
 807 struct pmc_thread {
 808         LIST_ENTRY(pmc_thread) pt_next;         /* linked list */
 809         struct thread   *pt_td;                 /* target thread */
 810         struct pmc_threadpmcstate pt_pmcs[];    /* per-PMC state */
 811 };
 812
 813 /*
 814  * struct pmc_process
 815  *
 816  * Record a 'target' process being profiled.
 817  *
 818  * The target process being profiled could be different from the owner
 819  * process which allocated the PMCs.  Each target process descriptor
 820  * is associated with NHWPMC 'struct pmc *' pointers.  Each PMC at a
 821  * given hardware row-index 'n' will use slot 'n' of the 'pp_pmcs[]'
 822  * array.  The size of this structure is thus PMC architecture
 823  * dependent.
 824  *
 825  */
 826
 827 struct pmc_targetstate {
 828         struct pmc      *pp_pmc;   /* target PMC */
 829         pmc_value_t     pp_pmcval; /* per-process value */
 830 };
 831
 832 struct pmc_process {
 833         LIST_ENTRY(pmc_process) pp_next;        /* hash chain */
 834         LIST_HEAD(,pmc_thread) pp_tds;          /* list of threads */
 835         struct mtx      *pp_tdslock;            /* lock on pp_tds thread list */
 836         int             pp_refcnt;              /* reference count */
 837         uint32_t        pp_flags;               /* flags PMC_PP_* */
 838         struct proc     *pp_proc;               /* target process */
 839         struct pmc_targetstate pp_pmcs[];       /* NHWPMCs */
 840 };
 841
 842 #define PMC_PP_ENABLE_MSR_ACCESS        0x00000001
 843
 844 /*
 845  * struct pmc_owner
 846  *
 847  * We associate a PMC with an 'owner' process.
 848  *
 849  * A process can be associated with 0..NCPUS*NHWPMC PMCs during its
 850  * lifetime, where NCPUS is the numbers of CPUS in the system and
 851  * NHWPMC is the number of hardware PMCs per CPU.  These are
 852  * maintained in the list headed by the 'po_pmcs' to save on space.
 853  *
 854  */
 855
 856 struct pmc_owner  {
 857         LIST_ENTRY(pmc_owner)   po_next;        /* hash chain */
 858         CK_LIST_ENTRY(pmc_owner)        po_ssnext;      /* (g/p) list of SS PMC owners */
 859         LIST_HEAD(, pmc)        po_pmcs;        /* owned PMC list */
 860         TAILQ_HEAD(, pmclog_buffer) po_logbuffers; /* (o) logbuffer list */
 861         struct mtx              po_mtx;         /* spin lock for (o) */
 862         struct proc             *po_owner;      /* owner proc */
 863         uint32_t                po_flags;       /* (k) flags PMC_PO_* */
 864         struct proc             *po_kthread;    /* (k) helper kthread */
 865         struct file             *po_file;       /* file reference */
 866         int                     po_error;       /* recorded error */
 867         short                   po_sscount;     /* # SS PMCs owned */
 868         short                   po_logprocmaps; /* global mappings done */
 869         struct pmclog_buffer    *po_curbuf[MAXCPU];     /* current log buffer */
 870 };
 871
 872 #define PMC_PO_OWNS_LOGFILE             0x00000001 /* has a log file */
 873 #define PMC_PO_SHUTDOWN                 0x00000010 /* in the process of shutdown */
 874 #define PMC_PO_INITIAL_MAPPINGS_DONE    0x00000020
 875
 876 /*
 877  * struct pmc_hw -- describe the state of the PMC hardware
 878  *
 879  * When in use, a HW PMC is associated with one allocated 'struct pmc'
 880  * pointed to by field 'phw_pmc'.  When inactive, this field is NULL.
 881  *
 882  * On an SMP box, one or more HW PMC's in process virtual mode with
 883  * the same 'phw_pmc' could be executing on different CPUs.  In order
 884  * to handle this case correctly, we need to ensure that only
 885  * incremental counts get added to the saved value in the associated
 886  * 'struct pmc'.  The 'phw_save' field is used to keep the saved PMC
 887  * value at the time the hardware is started during this context
 888  * switch (i.e., the difference between the new (hardware) count and
 889  * the saved count is atomically added to the count field in 'struct
 890  * pmc' at context switch time).
 891  *
 892  */
 893
 894 struct pmc_hw {
 895         uint32_t        phw_state;      /* see PHW_* macros below */
 896         struct pmc      *phw_pmc;       /* current thread PMC */
 897 };
 898
 899 #define PMC_PHW_RI_MASK         0x000000FF
 900 #define PMC_PHW_CPU_SHIFT       8
 901 #define PMC_PHW_CPU_MASK        0x0000FF00
 902 #define PMC_PHW_FLAGS_SHIFT     16
 903 #define PMC_PHW_FLAGS_MASK      0xFFFF0000
 904
 905 #define PMC_PHW_INDEX_TO_STATE(ri)      ((ri) & PMC_PHW_RI_MASK)
 906 #define PMC_PHW_STATE_TO_INDEX(state)   ((state) & PMC_PHW_RI_MASK)
 907 #define PMC_PHW_CPU_TO_STATE(cpu)       (((cpu) << PMC_PHW_CPU_SHIFT) & \
 908         PMC_PHW_CPU_MASK)
 909 #define PMC_PHW_STATE_TO_CPU(state)     (((state) & PMC_PHW_CPU_MASK) >> \
 910         PMC_PHW_CPU_SHIFT)
 911 #define PMC_PHW_FLAGS_TO_STATE(flags)   (((flags) << PMC_PHW_FLAGS_SHIFT) & \
 912         PMC_PHW_FLAGS_MASK)
 913 #define PMC_PHW_STATE_TO_FLAGS(state)   (((state) & PMC_PHW_FLAGS_MASK) >> \
 914         PMC_PHW_FLAGS_SHIFT)
 915 #define PMC_PHW_FLAG_IS_ENABLED         (PMC_PHW_FLAGS_TO_STATE(0x01))
 916 #define PMC_PHW_FLAG_IS_SHAREABLE       (PMC_PHW_FLAGS_TO_STATE(0x02))
 917
 918 /*
 919  * struct pmc_sample
 920  *
 921  * Space for N (tunable) PC samples and associated control data.
 922  */
 923
 924 struct pmc_sample {
 925         uint16_t                ps_nsamples;    /* callchain depth */
 926         uint16_t                ps_cpu;         /* cpu number */
 927         uint16_t                ps_flags;       /* other flags */
 928         uint8_t                 ps_pad[2];
 929         lwpid_t                 ps_tid;         /* thread id */
 930         pid_t                   ps_pid;         /* process PID or -1 */
 931         struct thread           *ps_td;         /* which thread */
 932         struct pmc              *ps_pmc;        /* interrupting PMC */
 933         uintptr_t               *ps_pc;         /* (const) callchain start */
 934 };
 935
 936 #define         PMC_SAMPLE_FREE         ((uint16_t) 0)
 937 #define         PMC_SAMPLE_INUSE        ((uint16_t) 0xFFFF)
 938
 939 struct pmc_samplebuffer {
 940         struct pmc_sample * volatile ps_read;   /* read pointer */
 941         struct pmc_sample * volatile ps_write;  /* write pointer */
 942         uintptr_t               *ps_callchains; /* all saved call chains */
 943         struct pmc_sample       *ps_fence;      /* one beyond ps_samples[] */
 944         struct pmc_sample       ps_samples[];   /* array of sample entries */
 945 };
 946
 947
 948 /*
 949  * struct pmc_cpustate
 950  *
 951  * A CPU is modelled as a collection of HW PMCs with space for additional
 952  * flags.
 953  */
 954
 955 struct pmc_cpu {
 956         uint32_t        pc_state;       /* physical cpu number + flags */
 957         struct pmc_samplebuffer *pc_sb[2]; /* space for samples */
 958         struct pmc_hw   *pc_hwpmcs[];   /* 'npmc' pointers */
 959 };
 960
 961 #define PMC_PCPU_CPU_MASK               0x000000FF
 962 #define PMC_PCPU_FLAGS_MASK             0xFFFFFF00
 963 #define PMC_PCPU_FLAGS_SHIFT            8
 964 #define PMC_PCPU_STATE_TO_CPU(S)        ((S) & PMC_PCPU_CPU_MASK)
 965 #define PMC_PCPU_STATE_TO_FLAGS(S)      (((S) & PMC_PCPU_FLAGS_MASK) >> PMC_PCPU_FLAGS_SHIFT)
 966 #define PMC_PCPU_FLAGS_TO_STATE(F)      (((F) << PMC_PCPU_FLAGS_SHIFT) & PMC_PCPU_FLAGS_MASK)
 967 #define PMC_PCPU_CPU_TO_STATE(C)        ((C) & PMC_PCPU_CPU_MASK)
 968 #define PMC_PCPU_FLAG_HTT               (PMC_PCPU_FLAGS_TO_STATE(0x1))
 969
 970 /*
 971  * struct pmc_binding
 972  *
 973  * CPU binding information.
 974  */
 975
 976 struct pmc_binding {
 977         int     pb_bound;       /* is bound? */
 978         int     pb_cpu;         /* if so, to which CPU */
 979 };
 980
 981
 982 struct pmc_mdep;
 983
 984 /*
 985  * struct pmc_classdep
 986  *
 987  * PMC class-dependent operations.
 988  */
 989 struct pmc_classdep {
 990         uint32_t        pcd_caps;       /* class capabilities */
 991         enum pmc_class  pcd_class;      /* class id */
 992         int             pcd_num;        /* number of PMCs */
 993         int             pcd_ri;         /* row index of the first PMC in class */
 994         int             pcd_width;      /* width of the PMC */
 995
 996         /* configuring/reading/writing the hardware PMCs */
 997         int (*pcd_config_pmc)(int _cpu, int _ri, struct pmc *_pm);
 998         int (*pcd_get_config)(int _cpu, int _ri, struct pmc **_ppm);
 999         int (*pcd_read_pmc)(int _cpu, int _ri, pmc_value_t *_value);
1000         int (*pcd_write_pmc)(int _cpu, int _ri, pmc_value_t _value);
1001
1002         /* pmc allocation/release */
1003         int (*pcd_allocate_pmc)(int _cpu, int _ri, struct pmc *_t,
1004                 const struct pmc_op_pmcallocate *_a);
1005         int (*pcd_release_pmc)(int _cpu, int _ri, struct pmc *_pm);
1006
1007         /* starting and stopping PMCs */
1008         int (*pcd_start_pmc)(int _cpu, int _ri);
1009         int (*pcd_stop_pmc)(int _cpu, int _ri);
1010
1011         /* description */
1012         int (*pcd_describe)(int _cpu, int _ri, struct pmc_info *_pi,
1013                 struct pmc **_ppmc);
1014
1015         /* class-dependent initialization & finalization */
1016         int (*pcd_pcpu_init)(struct pmc_mdep *_md, int _cpu);
1017         int (*pcd_pcpu_fini)(struct pmc_mdep *_md, int _cpu);
1018
1019         /* machine-specific interface */
1020         int (*pcd_get_msr)(int _ri, uint32_t *_msr);
1021 };
1022
1023 /*
1024  * struct pmc_mdep
1025  *
1026  * Machine dependent bits needed per CPU type.
1027  */
1028
1029 struct pmc_mdep  {
1030         uint32_t        pmd_cputype;    /* from enum pmc_cputype */
1031         uint32_t        pmd_npmc;       /* number of PMCs per CPU */
1032         uint32_t        pmd_nclass;     /* number of PMC classes present */
1033
1034         /*
1035          * Machine dependent methods.
1036          */
1037
1038         /* per-cpu initialization and finalization */
1039         int (*pmd_pcpu_init)(struct pmc_mdep *_md, int _cpu);
1040         int (*pmd_pcpu_fini)(struct pmc_mdep *_md, int _cpu);
1041
1042         /* thread context switch in/out */
1043         int (*pmd_switch_in)(struct pmc_cpu *_p, struct pmc_process *_pp);
1044         int (*pmd_switch_out)(struct pmc_cpu *_p, struct pmc_process *_pp);
1045
1046         /* handle a PMC interrupt */
1047         int (*pmd_intr)(int _cpu, struct trapframe *_tf);
1048
1049         /*
1050          * PMC class dependent information.
1051          */
1052         struct pmc_classdep pmd_classdep[];
1053 };
1054
1055 /*
1056  * Per-CPU state.  This is an array of 'mp_ncpu' pointers
1057  * to struct pmc_cpu descriptors.
1058  */
1059
1060 extern struct pmc_cpu **pmc_pcpu;
1061
1062 /* driver statistics */
1063 extern struct pmc_driverstats pmc_stats;
1064
1065 /* cpu model name for pmu lookup */
1066 extern char pmc_cpuid[64];
1067
1068 #if     defined(HWPMC_DEBUG)
1069 #include <sys/ktr.h>
1070
1071 /* debug flags, major flag groups */
1072 struct pmc_debugflags {
1073         int     pdb_CPU;
1074         int     pdb_CSW;
1075         int     pdb_LOG;
1076         int     pdb_MDP;
1077         int     pdb_MOD;
1078         int     pdb_OWN;
1079         int     pdb_PMC;
1080         int     pdb_PRC;
1081         int     pdb_SAM;
1082 };
1083
1084 extern struct pmc_debugflags pmc_debugflags;
1085
1086 #define KTR_PMC                 KTR_SUBSYS
1087
1088 #define PMC_DEBUG_STRSIZE               128
1089 #define PMC_DEBUG_DEFAULT_FLAGS         { 0, 0, 0, 0, 0, 0, 0, 0, 0 }
1090
1091 #define PMCDBG0(M, N, L, F) do {                                        \
1092         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1093                 CTR0(KTR_PMC, #M ":" #N ":" #L  ": " F);                \
1094 } while (0)
1095 #define PMCDBG1(M, N, L, F, p1) do {                                    \
1096         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1097                 CTR1(KTR_PMC, #M ":" #N ":" #L  ": " F, p1);            \
1098 } while (0)
1099 #define PMCDBG2(M, N, L, F, p1, p2) do {                                \
1100         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1101                 CTR2(KTR_PMC, #M ":" #N ":" #L  ": " F, p1, p2);        \
1102 } while (0)
1103 #define PMCDBG3(M, N, L, F, p1, p2, p3) do {                            \
1104         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1105                 CTR3(KTR_PMC, #M ":" #N ":" #L  ": " F, p1, p2, p3);    \
1106 } while (0)
1107 #define PMCDBG4(M, N, L, F, p1, p2, p3, p4) do {                        \
1108         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1109                 CTR4(KTR_PMC, #M ":" #N ":" #L  ": " F, p1, p2, p3, p4);\
1110 } while (0)
1111 #define PMCDBG5(M, N, L, F, p1, p2, p3, p4, p5) do {                    \
1112         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1113                 CTR5(KTR_PMC, #M ":" #N ":" #L  ": " F, p1, p2, p3, p4, \
1114                     p5);                                                \
1115 } while (0)
1116 #define PMCDBG6(M, N, L, F, p1, p2, p3, p4, p5, p6) do {                \
1117         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
1118                 CTR6(KTR_PMC, #M ":" #N ":" #L  ": " F, p1, p2, p3, p4, \
1119                     p5, p6);                                            \
1120 } while (0)
1121
1122 /* Major numbers */
1123 #define PMC_DEBUG_MAJ_CPU               0 /* cpu switches */
1124 #define PMC_DEBUG_MAJ_CSW               1 /* context switches */
1125 #define PMC_DEBUG_MAJ_LOG               2 /* logging */
1126 #define PMC_DEBUG_MAJ_MDP               3 /* machine dependent */
1127 #define PMC_DEBUG_MAJ_MOD               4 /* misc module infrastructure */
1128 #define PMC_DEBUG_MAJ_OWN               5 /* owner */
1129 #define PMC_DEBUG_MAJ_PMC               6 /* pmc management */
1130 #define PMC_DEBUG_MAJ_PRC               7 /* processes */
1131 #define PMC_DEBUG_MAJ_SAM               8 /* sampling */
1132
1133 /* Minor numbers */
1134
1135 /* Common (8 bits) */
1136 #define PMC_DEBUG_MIN_ALL               0 /* allocation */
1137 #define PMC_DEBUG_MIN_REL               1 /* release */
1138 #define PMC_DEBUG_MIN_OPS               2 /* ops: start, stop, ... */
1139 #define PMC_DEBUG_MIN_INI               3 /* init */
1140 #define PMC_DEBUG_MIN_FND               4 /* find */
1141
1142 /* MODULE */
1143 #define PMC_DEBUG_MIN_PMH              14 /* pmc_hook */
1144 #define PMC_DEBUG_MIN_PMS              15 /* pmc_syscall */
1145
1146 /* OWN */
1147 #define PMC_DEBUG_MIN_ORM               8 /* owner remove */
1148 #define PMC_DEBUG_MIN_OMR               9 /* owner maybe remove */
1149
1150 /* PROCESSES */
1151 #define PMC_DEBUG_MIN_TLK               8 /* link target */
1152 #define PMC_DEBUG_MIN_TUL               9 /* unlink target */
1153 #define PMC_DEBUG_MIN_EXT              10 /* process exit */
1154 #define PMC_DEBUG_MIN_EXC              11 /* process exec */
1155 #define PMC_DEBUG_MIN_FRK              12 /* process fork */
1156 #define PMC_DEBUG_MIN_ATT              13 /* attach/detach */
1157 #define PMC_DEBUG_MIN_SIG              14 /* signalling */
1158
1159 /* CONTEXT SWITCHES */
1160 #define PMC_DEBUG_MIN_SWI               8 /* switch in */
1161 #define PMC_DEBUG_MIN_SWO               9 /* switch out */
1162
1163 /* PMC */
1164 #define PMC_DEBUG_MIN_REG               8 /* pmc register */
1165 #define PMC_DEBUG_MIN_ALR               9 /* allocate row */
1166
1167 /* MACHINE DEPENDENT LAYER */
1168 #define PMC_DEBUG_MIN_REA               8 /* read */
1169 #define PMC_DEBUG_MIN_WRI               9 /* write */
1170 #define PMC_DEBUG_MIN_CFG              10 /* config */
1171 #define PMC_DEBUG_MIN_STA              11 /* start */
1172 #define PMC_DEBUG_MIN_STO              12 /* stop */
1173 #define PMC_DEBUG_MIN_INT              13 /* interrupts */
1174
1175 /* CPU */
1176 #define PMC_DEBUG_MIN_BND               8 /* bind */
1177 #define PMC_DEBUG_MIN_SEL               9 /* select */
1178
1179 /* LOG */
1180 #define PMC_DEBUG_MIN_GTB               8 /* get buf */
1181 #define PMC_DEBUG_MIN_SIO               9 /* schedule i/o */
1182 #define PMC_DEBUG_MIN_FLS              10 /* flush */
1183 #define PMC_DEBUG_MIN_SAM              11 /* sample */
1184 #define PMC_DEBUG_MIN_CLO              12 /* close */
1185
1186 #else
1187 #define PMCDBG0(M, N, L, F)             /* nothing */
1188 #define PMCDBG1(M, N, L, F, p1)
1189 #define PMCDBG2(M, N, L, F, p1, p2)
1190 #define PMCDBG3(M, N, L, F, p1, p2, p3)
1191 #define PMCDBG4(M, N, L, F, p1, p2, p3, p4)
1192 #define PMCDBG5(M, N, L, F, p1, p2, p3, p4, p5)
1193 #define PMCDBG6(M, N, L, F, p1, p2, p3, p4, p5, p6)
1194 #endif
1195
1196 /* declare a dedicated memory pool */
1197 MALLOC_DECLARE(M_PMC);
1198
1199 /*
1200  * Functions
1201  */
1202
1203 struct pmc_mdep *pmc_md_initialize(void);       /* MD init function */
1204 void    pmc_md_finalize(struct pmc_mdep *_md);  /* MD fini function */
1205 int     pmc_getrowdisp(int _ri);
1206 int     pmc_process_interrupt(int _cpu, int _soft, struct pmc *_pm,
1207     struct trapframe *_tf, int _inuserspace);
1208 int     pmc_save_kernel_callchain(uintptr_t *_cc, int _maxsamples,
1209     struct trapframe *_tf);
1210 int     pmc_save_user_callchain(uintptr_t *_cc, int _maxsamples,
1211     struct trapframe *_tf);
1212 struct pmc_mdep *pmc_mdep_alloc(int nclasses);
1213 void pmc_mdep_free(struct pmc_mdep *md);
1214 #endif /* _KERNEL */
1215 #endif /* _SYS_PMC_H_ */