sys/sys/pmc.h

   1 /*-
   2  * Copyright (c) 2003-2007, Joseph Koshy
   3  * Copyright (c) 2007 The FreeBSD Foundation
   4  * All rights reserved.
   5  *
   6  * Portions of this software were developed by A. Joseph Koshy under
   7  * sponsorship from the FreeBSD Foundation and Google, Inc.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_PMC_H_
  34 #define _SYS_PMC_H_
  35
  36 #include <dev/hwpmc/pmc_events.h>
  37
  38 #include <machine/pmc_mdep.h>
  39 #include <machine/profile.h>
  40
  41 #define PMC_MODULE_NAME         "hwpmc"
  42 #define PMC_NAME_MAX            16 /* HW counter name size */
  43 #define PMC_CLASS_MAX           4  /* #classes of PMCs in a system */
  44
  45 /*
  46  * Kernel<->userland API version number [MMmmpppp]
  47  *
  48  * Major numbers are to be incremented when an incompatible change to
  49  * the ABI occurs that older clients will not be able to handle.
  50  *
  51  * Minor numbers are incremented when a backwards compatible change
  52  * occurs that allows older correct programs to run unchanged.  For
  53  * example, when support for a new PMC type is added.
  54  *
  55  * The patch version is incremented for every bug fix.
  56  */
  57 #define PMC_VERSION_MAJOR       0x03
  58 #define PMC_VERSION_MINOR       0x00
  59 #define PMC_VERSION_PATCH       0x0000
  60
  61 #define PMC_VERSION             (PMC_VERSION_MAJOR << 24 |              \
  62         PMC_VERSION_MINOR << 16 | PMC_VERSION_PATCH)
  63
  64 /*
  65  * Kinds of CPUs known
  66  */
  67
  68 #define __PMC_CPUS()                                    \
  69         __PMC_CPU(AMD_K7,     "AMD K7")                 \
  70         __PMC_CPU(AMD_K8,     "AMD K8")                 \
  71         __PMC_CPU(INTEL_P5,   "Intel Pentium")          \
  72         __PMC_CPU(INTEL_P6,   "Intel Pentium Pro")      \
  73         __PMC_CPU(INTEL_CL,   "Intel Celeron")          \
  74         __PMC_CPU(INTEL_PII,  "Intel Pentium II")       \
  75         __PMC_CPU(INTEL_PIII, "Intel Pentium III")      \
  76         __PMC_CPU(INTEL_PM,   "Intel Pentium M")        \
  77         __PMC_CPU(INTEL_PIV,  "Intel Pentium IV")
  78
  79 enum pmc_cputype {
  80 #undef  __PMC_CPU
  81 #define __PMC_CPU(S,D)  PMC_CPU_##S ,
  82         __PMC_CPUS()
  83 };
  84
  85 #define PMC_CPU_FIRST   PMC_CPU_AMD_K7
  86 #define PMC_CPU_LAST    PMC_CPU_INTEL_PIV
  87
  88 /*
  89  * Classes of PMCs
  90  */
  91
  92 #define __PMC_CLASSES()                                                 \
  93         __PMC_CLASS(TSC)        /* CPU Timestamp counter */             \
  94         __PMC_CLASS(K7)         /* AMD K7 performance counters */       \
  95         __PMC_CLASS(K8)         /* AMD K8 performance counters */       \
  96         __PMC_CLASS(P5)         /* Intel Pentium counters */            \
  97         __PMC_CLASS(P6)         /* Intel Pentium Pro counters */        \
  98         __PMC_CLASS(P4)         /* Intel Pentium-IV counters */
  99
 100 enum pmc_class {
 101 #undef  __PMC_CLASS
 102 #define __PMC_CLASS(N)  PMC_CLASS_##N ,
 103         __PMC_CLASSES()
 104 };
 105
 106 #define PMC_CLASS_FIRST PMC_CLASS_TSC
 107 #define PMC_CLASS_LAST  PMC_CLASS_P4
 108
 109 /*
 110  * A PMC can be in the following states:
 111  *
 112  * Hardware states:
 113  *   DISABLED   -- administratively prohibited from being used.
 114  *   FREE       -- HW available for use
 115  * Software states:
 116  *   ALLOCATED  -- allocated
 117  *   STOPPED    -- allocated, but not counting events
 118  *   RUNNING    -- allocated, and in operation; 'pm_runcount'
 119  *                 holds the number of CPUs using this PMC at
 120  *                 a given instant
 121  *   DELETED    -- being destroyed
 122  */
 123
 124 #define __PMC_HWSTATES()                        \
 125         __PMC_STATE(DISABLED)                   \
 126         __PMC_STATE(FREE)
 127
 128 #define __PMC_SWSTATES()                        \
 129         __PMC_STATE(ALLOCATED)                  \
 130         __PMC_STATE(STOPPED)                    \
 131         __PMC_STATE(RUNNING)                    \
 132         __PMC_STATE(DELETED)
 133
 134 #define __PMC_STATES()                          \
 135         __PMC_HWSTATES()                        \
 136         __PMC_SWSTATES()
 137
 138 enum pmc_state {
 139 #undef  __PMC_STATE
 140 #define __PMC_STATE(S)  PMC_STATE_##S,
 141         __PMC_STATES()
 142         __PMC_STATE(MAX)
 143 };
 144
 145 #define PMC_STATE_FIRST PMC_STATE_DISABLED
 146 #define PMC_STATE_LAST  PMC_STATE_DELETED
 147
 148 /*
 149  * An allocated PMC may used as a 'global' counter or as a
 150  * 'thread-private' one.  Each such mode of use can be in either
 151  * statistical sampling mode or in counting mode.  Thus a PMC in use
 152  *
 153  * SS i.e., SYSTEM STATISTICAL  -- system-wide statistical profiling
 154  * SC i.e., SYSTEM COUNTER      -- system-wide counting mode
 155  * TS i.e., THREAD STATISTICAL  -- thread virtual, statistical profiling
 156  * TC i.e., THREAD COUNTER      -- thread virtual, counting mode
 157  *
 158  * Statistical profiling modes rely on the PMC periodically delivering
 159  * a interrupt to the CPU (when the configured number of events have
 160  * been measured), so the PMC must have the ability to generate
 161  * interrupts.
 162  *
 163  * In counting modes, the PMC counts its configured events, with the
 164  * value of the PMC being read whenever needed by its owner process.
 165  *
 166  * The thread specific modes "virtualize" the PMCs -- the PMCs appear
 167  * to be thread private and count events only when the profiled thread
 168  * actually executes on the CPU.
 169  *
 170  * The system-wide "global" modes keep the PMCs running all the time
 171  * and are used to measure the behaviour of the whole system.
 172  */
 173
 174 #define __PMC_MODES()                           \
 175         __PMC_MODE(SS,  0)                      \
 176         __PMC_MODE(SC,  1)                      \
 177         __PMC_MODE(TS,  2)                      \
 178         __PMC_MODE(TC,  3)
 179
 180 enum pmc_mode {
 181 #undef  __PMC_MODE
 182 #define __PMC_MODE(M,N) PMC_MODE_##M = N,
 183         __PMC_MODES()
 184 };
 185
 186 #define PMC_MODE_FIRST  PMC_MODE_SS
 187 #define PMC_MODE_LAST   PMC_MODE_TC
 188
 189 #define PMC_IS_COUNTING_MODE(mode)                              \
 190         ((mode) == PMC_MODE_SC || (mode) == PMC_MODE_TC)
 191 #define PMC_IS_SYSTEM_MODE(mode)                                \
 192         ((mode) == PMC_MODE_SS || (mode) == PMC_MODE_SC)
 193 #define PMC_IS_SAMPLING_MODE(mode)                              \
 194         ((mode) == PMC_MODE_SS || (mode) == PMC_MODE_TS)
 195 #define PMC_IS_VIRTUAL_MODE(mode)                               \
 196         ((mode) == PMC_MODE_TS || (mode) == PMC_MODE_TC)
 197
 198 /*
 199  * PMC row disposition
 200  */
 201
 202 #define __PMC_DISPOSITIONS(N)                                   \
 203         __PMC_DISP(STANDALONE)  /* global/disabled counters */  \
 204         __PMC_DISP(FREE)        /* free/available */            \
 205         __PMC_DISP(THREAD)      /* thread-virtual PMCs */       \
 206         __PMC_DISP(UNKNOWN)     /* sentinel */
 207
 208 enum pmc_disp {
 209 #undef  __PMC_DISP
 210 #define __PMC_DISP(D)   PMC_DISP_##D ,
 211         __PMC_DISPOSITIONS()
 212 };
 213
 214 #define PMC_DISP_FIRST  PMC_DISP_STANDALONE
 215 #define PMC_DISP_LAST   PMC_DISP_THREAD
 216
 217 /*
 218  * Counter capabilities
 219  *
 220  * __PMC_CAPS(NAME, VALUE, DESCRIPTION)
 221  */
 222
 223 #define __PMC_CAPS()                                                    \
 224         __PMC_CAP(INTERRUPT,    0, "generate interrupts")               \
 225         __PMC_CAP(USER,         1, "count user-mode events")            \
 226         __PMC_CAP(SYSTEM,       2, "count system-mode events")          \
 227         __PMC_CAP(EDGE,         3, "do edge detection of events")       \
 228         __PMC_CAP(THRESHOLD,    4, "ignore events below a threshold")   \
 229         __PMC_CAP(READ,         5, "read PMC counter")                  \
 230         __PMC_CAP(WRITE,        6, "reprogram PMC counter")             \
 231         __PMC_CAP(INVERT,       7, "invert comparision sense")          \
 232         __PMC_CAP(QUALIFIER,    8, "further qualify monitored events")  \
 233         __PMC_CAP(PRECISE,      9, "perform precise sampling")          \
 234         __PMC_CAP(TAGGING,      10, "tag upstream events")              \
 235         __PMC_CAP(CASCADE,      11, "cascade counters")
 236
 237 enum pmc_caps
 238 {
 239 #undef  __PMC_CAP
 240 #define __PMC_CAP(NAME, VALUE, DESCR)   PMC_CAP_##NAME = (1 << VALUE) ,
 241         __PMC_CAPS()
 242 };
 243
 244 #define PMC_CAP_FIRST           PMC_CAP_INTERRUPT
 245 #define PMC_CAP_LAST            PMC_CAP_CASCADE
 246
 247 /*
 248  * PMC Event Numbers
 249  *
 250  * These are generated from the definitions in "dev/hwpmc/pmc_events.h".
 251  */
 252
 253 enum pmc_event {
 254 #undef  __PMC_EV
 255 #define __PMC_EV(C,N,D) PMC_EV_ ## C ## _ ## N ,
 256         __PMC_EVENTS()
 257 };
 258
 259 #define PMC_EVENT_FIRST PMC_EV_TSC_TSC
 260 #define PMC_EVENT_LAST  PMC_EV_P5_LAST
 261
 262 /*
 263  * PMC SYSCALL INTERFACE
 264  */
 265
 266 /*
 267  * "PMC_OPS" -- these are the commands recognized by the kernel
 268  * module, and are used when performing a system call from userland.
 269  */
 270 #define __PMC_OPS()                                                     \
 271         __PMC_OP(CONFIGURELOG, "Set log file")                          \
 272         __PMC_OP(FLUSHLOG, "Flush log file")                            \
 273         __PMC_OP(GETCPUINFO, "Get system CPU information")              \
 274         __PMC_OP(GETDRIVERSTATS, "Get driver statistics")               \
 275         __PMC_OP(GETMODULEVERSION, "Get module version")                \
 276         __PMC_OP(GETPMCINFO, "Get per-cpu PMC information")             \
 277         __PMC_OP(PMCADMIN, "Set PMC state")                             \
 278         __PMC_OP(PMCALLOCATE, "Allocate and configure a PMC")           \
 279         __PMC_OP(PMCATTACH, "Attach a PMC to a process")                \
 280         __PMC_OP(PMCDETACH, "Detach a PMC from a process")              \
 281         __PMC_OP(PMCGETMSR, "Get a PMC's hardware address")             \
 282         __PMC_OP(PMCRELEASE, "Release a PMC")                           \
 283         __PMC_OP(PMCRW, "Read/Set a PMC")                               \
 284         __PMC_OP(PMCSETCOUNT, "Set initial count/sampling rate")        \
 285         __PMC_OP(PMCSTART, "Start a PMC")                               \
 286         __PMC_OP(PMCSTOP, "Start a PMC")                                \
 287         __PMC_OP(WRITELOG, "Write a cookie to the log file")
 288
 289 enum pmc_ops {
 290 #undef  __PMC_OP
 291 #define __PMC_OP(N, D)  PMC_OP_##N,
 292         __PMC_OPS()
 293 };
 294
 295
 296 /*
 297  * Flags used in operations on PMCs.
 298  */
 299
 300 #define PMC_F_FORCE             0x00000001 /*OP ADMIN force operation */
 301 #define PMC_F_DESCENDANTS       0x00000002 /*OP ALLOCATE track descendants */
 302 #define PMC_F_LOG_PROCCSW       0x00000004 /*OP ALLOCATE track ctx switches */
 303 #define PMC_F_LOG_PROCEXIT      0x00000008 /*OP ALLOCATE log proc exits */
 304 #define PMC_F_NEWVALUE          0x00000010 /*OP RW write new value */
 305 #define PMC_F_OLDVALUE          0x00000020 /*OP RW get old value */
 306 #define PMC_F_KGMON             0x00000040 /*OP ALLOCATE kgmon(8) profiling */
 307 /* V2 API */
 308 #define PMC_F_CALLCHAIN         0x00000080 /*OP ALLOCATE capture callchains */
 309
 310 /* internal flags */
 311 #define PMC_F_ATTACHED_TO_OWNER 0x00010000 /*attached to owner*/
 312 #define PMC_F_NEEDS_LOGFILE     0x00020000 /*needs log file */
 313 #define PMC_F_ATTACH_DONE       0x00040000 /*attached at least once */
 314
 315 #define PMC_CALLCHAIN_DEPTH_MAX 32
 316 #define PMC_CC_F_USERSPACE      0x01       /*userspace callchain*/
 317
 318 /*
 319  * Cookies used to denote allocated PMCs, and the values of PMCs.
 320  */
 321
 322 typedef uint32_t        pmc_id_t;
 323 typedef uint64_t        pmc_value_t;
 324
 325 #define PMC_ID_INVALID          (~ (pmc_id_t) 0)
 326
 327 /*
 328  * PMC IDs have the following format:
 329  *
 330  * +--------+----------+-----------+-----------+
 331  * |   CPU  | PMC MODE | PMC CLASS | ROW INDEX |
 332  * +--------+----------+-----------+-----------+
 333  *
 334  * where each field is 8 bits wide.  Field 'CPU' is set to the
 335  * requested CPU for system-wide PMCs or PMC_CPU_ANY for process-mode
 336  * PMCs.  Field 'PMC MODE' is the allocated PMC mode.  Field 'PMC
 337  * CLASS' is the class of the PMC.  Field 'ROW INDEX' is the row index
 338  * for the PMC.
 339  *
 340  * The 'ROW INDEX' ranges over 0..NWPMCS where NHWPMCS is the total
 341  * number of hardware PMCs on this cpu.
 342  */
 343
 344
 345 #define PMC_ID_TO_ROWINDEX(ID)  ((ID) & 0xFF)
 346 #define PMC_ID_TO_CLASS(ID)     (((ID) & 0xFF00) >> 8)
 347 #define PMC_ID_TO_MODE(ID)      (((ID) & 0xFF0000) >> 16)
 348 #define PMC_ID_TO_CPU(ID)       (((ID) & 0xFF000000) >> 24)
 349 #define PMC_ID_MAKE_ID(CPU,MODE,CLASS,ROWINDEX)                 \
 350         ((((CPU) & 0xFF) << 24) | (((MODE) & 0xFF) << 16) |     \
 351         (((CLASS) & 0xFF) << 8) | ((ROWINDEX) & 0xFF))
 352
 353 /*
 354  * Data structures for system calls supported by the pmc driver.
 355  */
 356
 357 /*
 358  * OP PMCALLOCATE
 359  *
 360  * Allocate a PMC on the named CPU.
 361  */
 362
 363 #define PMC_CPU_ANY     ~0
 364
 365 struct pmc_op_pmcallocate {
 366         uint32_t        pm_caps;        /* PMC_CAP_* */
 367         uint32_t        pm_cpu;         /* CPU number or PMC_CPU_ANY */
 368         enum pmc_class  pm_class;       /* class of PMC desired */
 369         enum pmc_event  pm_ev;          /* [enum pmc_event] desired */
 370         uint32_t        pm_flags;       /* additional modifiers PMC_F_* */
 371         enum pmc_mode   pm_mode;        /* desired mode */
 372         pmc_id_t        pm_pmcid;       /* [return] process pmc id */
 373
 374         union pmc_md_op_pmcallocate pm_md; /* MD layer extensions */
 375 };
 376
 377 /*
 378  * OP PMCADMIN
 379  *
 380  * Set the administrative state (i.e., whether enabled or disabled) of
 381  * a PMC 'pm_pmc' on CPU 'pm_cpu'.  Note that 'pm_pmc' specifies an
 382  * absolute PMC number and need not have been first allocated by the
 383  * calling process.
 384  */
 385
 386 struct pmc_op_pmcadmin {
 387         int             pm_cpu;         /* CPU# */
 388         uint32_t        pm_flags;       /* flags */
 389         int             pm_pmc;         /* PMC# */
 390         enum pmc_state  pm_state;       /* desired state */
 391 };
 392
 393 /*
 394  * OP PMCATTACH / OP PMCDETACH
 395  *
 396  * Attach/detach a PMC and a process.
 397  */
 398
 399 struct pmc_op_pmcattach {
 400         pmc_id_t        pm_pmc;         /* PMC to attach to */
 401         pid_t           pm_pid;         /* target process */
 402 };
 403
 404 /*
 405  * OP PMCSETCOUNT
 406  *
 407  * Set the sampling rate (i.e., the reload count) for statistical counters.
 408  * 'pm_pmcid' need to have been previously allocated using PMCALLOCATE.
 409  */
 410
 411 struct pmc_op_pmcsetcount {
 412         pmc_value_t     pm_count;       /* initial/sample count */
 413         pmc_id_t        pm_pmcid;       /* PMC id to set */
 414 };
 415
 416
 417 /*
 418  * OP PMCRW
 419  *
 420  * Read the value of a PMC named by 'pm_pmcid'.  'pm_pmcid' needs
 421  * to have been previously allocated using PMCALLOCATE.
 422  */
 423
 424
 425 struct pmc_op_pmcrw {
 426         uint32_t        pm_flags;       /* PMC_F_{OLD,NEW}VALUE*/
 427         pmc_id_t        pm_pmcid;       /* pmc id */
 428         pmc_value_t     pm_value;       /* new&returned value */
 429 };
 430
 431
 432 /*
 433  * OP GETPMCINFO
 434  *
 435  * retrieve PMC state for a named CPU.  The caller is expected to
 436  * allocate 'npmc' * 'struct pmc_info' bytes of space for the return
 437  * values.
 438  */
 439
 440 struct pmc_info {
 441         char            pm_name[PMC_NAME_MAX]; /* pmc name */
 442         enum pmc_class  pm_class;       /* enum pmc_class */
 443         int             pm_enabled;     /* whether enabled */
 444         enum pmc_disp   pm_rowdisp;     /* FREE, THREAD or STANDLONE */
 445         pid_t           pm_ownerpid;    /* owner, or -1 */
 446         enum pmc_mode   pm_mode;        /* current mode [enum pmc_mode] */
 447         enum pmc_event  pm_event;       /* current event */
 448         uint32_t        pm_flags;       /* current flags */
 449         pmc_value_t     pm_reloadcount; /* sampling counters only */
 450 };
 451
 452 struct pmc_op_getpmcinfo {
 453         int32_t         pm_cpu;         /* 0 <= cpu < mp_maxid */
 454         struct pmc_info pm_pmcs[];      /* space for 'npmc' structures */
 455 };
 456
 457
 458 /*
 459  * OP GETCPUINFO
 460  *
 461  * Retrieve system CPU information.
 462  */
 463
 464 struct pmc_classinfo {
 465         enum pmc_class  pm_class;       /* class id */
 466         uint32_t        pm_caps;        /* counter capabilities */
 467         uint32_t        pm_width;       /* width of the PMC */
 468 };
 469
 470 struct pmc_op_getcpuinfo {
 471         enum pmc_cputype pm_cputype; /* what kind of CPU */
 472         uint32_t        pm_ncpu;    /* number of CPUs */
 473         uint32_t        pm_npmc;    /* #PMCs per CPU */
 474         uint32_t        pm_nclass;  /* #classes of PMCs */
 475         struct pmc_classinfo  pm_classes[PMC_CLASS_MAX];
 476 };
 477
 478 /*
 479  * OP CONFIGURELOG
 480  *
 481  * Configure a log file for writing system-wide statistics to.
 482  */
 483
 484 struct pmc_op_configurelog {
 485         int             pm_flags;
 486         int             pm_logfd;   /* logfile fd (or -1) */
 487 };
 488
 489 /*
 490  * OP GETDRIVERSTATS
 491  *
 492  * Retrieve pmc(4) driver-wide statistics.
 493  */
 494
 495 struct pmc_op_getdriverstats {
 496         int     pm_intr_ignored;        /* #interrupts ignored */
 497         int     pm_intr_processed;      /* #interrupts processed */
 498         int     pm_intr_bufferfull;     /* #interrupts with ENOSPC */
 499         int     pm_syscalls;            /* #syscalls */
 500         int     pm_syscall_errors;      /* #syscalls with errors */
 501         int     pm_buffer_requests;     /* #buffer requests */
 502         int     pm_buffer_requests_failed; /* #failed buffer requests */
 503         int     pm_log_sweeps;          /* #sample buffer processing passes */
 504 };
 505
 506 /*
 507  * OP RELEASE / OP START / OP STOP
 508  *
 509  * Simple operations on a PMC id.
 510  */
 511
 512 struct pmc_op_simple {
 513         pmc_id_t        pm_pmcid;
 514 };
 515
 516 /*
 517  * OP WRITELOG
 518  *
 519  * Flush the current log buffer and write 4 bytes of user data to it.
 520  */
 521
 522 struct pmc_op_writelog {
 523         uint32_t        pm_userdata;
 524 };
 525
 526 /*
 527  * OP GETMSR
 528  *
 529  * Retrieve the machine specific address assoicated with the allocated
 530  * PMC.  This number can be used subsequently with a read-performance-counter
 531  * instruction.
 532  */
 533
 534 struct pmc_op_getmsr {
 535         uint32_t        pm_msr;         /* machine specific address */
 536         pmc_id_t        pm_pmcid;       /* allocated pmc id */
 537 };
 538
 539 #ifdef _KERNEL
 540
 541 #include <sys/malloc.h>
 542 #include <sys/sysctl.h>
 543
 544 #include <machine/frame.h>
 545
 546 #define PMC_HASH_SIZE                           16
 547 #define PMC_MTXPOOL_SIZE                        32
 548 #define PMC_LOG_BUFFER_SIZE                     4
 549 #define PMC_NLOGBUFFERS                         16
 550 #define PMC_NSAMPLES                            32
 551 #define PMC_CALLCHAIN_DEPTH                     8
 552
 553 #define PMC_SYSCTL_NAME_PREFIX "kern." PMC_MODULE_NAME "."
 554
 555 /*
 556  * Locking keys
 557  *
 558  * (b) - pmc_bufferlist_mtx (spin lock)
 559  * (k) - pmc_kthread_mtx (sleep lock)
 560  * (o) - po->po_mtx (spin lock)
 561  */
 562
 563 /*
 564  * PMC commands
 565  */
 566
 567 struct pmc_syscall_args {
 568         uint32_t        pmop_code;      /* one of PMC_OP_* */
 569         void            *pmop_data;     /* syscall parameter */
 570 };
 571
 572 /*
 573  * Interface to processor specific s1tuff
 574  */
 575
 576 /*
 577  * struct pmc_descr
 578  *
 579  * Machine independent (i.e., the common parts) of a human readable
 580  * PMC description.
 581  */
 582
 583 struct pmc_descr {
 584         char            pd_name[PMC_NAME_MAX]; /* name */
 585         uint32_t        pd_caps;        /* capabilities */
 586         enum pmc_class  pd_class;       /* class of the PMC */
 587         uint32_t        pd_width;       /* width in bits */
 588 };
 589
 590 /*
 591  * struct pmc_target
 592  *
 593  * This structure records all the target processes associated with a
 594  * PMC.
 595  */
 596
 597 struct pmc_target {
 598         LIST_ENTRY(pmc_target)  pt_next;
 599         struct pmc_process      *pt_process; /* target descriptor */
 600 };
 601
 602 /*
 603  * struct pmc
 604  *
 605  * Describes each allocated PMC.
 606  *
 607  * Each PMC has precisely one owner, namely the process that allocated
 608  * the PMC.
 609  *
 610  * A PMC may be attached to multiple target processes.  The
 611  * 'pm_targets' field links all the target processes being monitored
 612  * by this PMC.
 613  *
 614  * The 'pm_savedvalue' field is protected by a mutex.
 615  *
 616  * On a multi-cpu machine, multiple target threads associated with a
 617  * process-virtual PMC could be concurrently executing on different
 618  * CPUs.  The 'pm_runcount' field is atomically incremented every time
 619  * the PMC gets scheduled on a CPU and atomically decremented when it
 620  * get descheduled.  Deletion of a PMC is only permitted when this
 621  * field is '0'.
 622  *
 623  */
 624
 625 struct pmc {
 626         LIST_HEAD(,pmc_target)  pm_targets;     /* list of target processes */
 627         LIST_ENTRY(pmc)         pm_next;        /* owner's list */
 628
 629         /*
 630          * System-wide PMCs are allocated on a CPU and are not moved
 631          * around.  For system-wide PMCs we record the CPU the PMC was
 632          * allocated on in the 'CPU' field of the pmc ID.
 633          *
 634          * Virtual PMCs run on whichever CPU is currently executing
 635          * their targets' threads.  For these PMCs we need to save
 636          * their current PMC counter values when they are taken off
 637          * CPU.
 638          */
 639
 640         union {
 641                 pmc_value_t     pm_savedvalue;  /* Virtual PMCS */
 642         } pm_gv;
 643
 644         /*
 645          * For sampling mode PMCs, we keep track of the PMC's "reload
 646          * count", which is the counter value to be loaded in when
 647          * arming the PMC for the next counting session.  For counting
 648          * modes on PMCs that are read-only (e.g., the x86 TSC), we
 649          * keep track of the initial value at the start of
 650          * counting-mode operation.
 651          */
 652
 653         union {
 654                 pmc_value_t     pm_reloadcount; /* sampling PMC modes */
 655                 pmc_value_t     pm_initial;     /* counting PMC modes */
 656         } pm_sc;
 657
 658         uint32_t        pm_stalled;     /* marks stalled sampling PMCs */
 659         uint32_t        pm_caps;        /* PMC capabilities */
 660         enum pmc_event  pm_event;       /* event being measured */
 661         uint32_t        pm_flags;       /* additional flags PMC_F_... */
 662         struct pmc_owner *pm_owner;     /* owner thread state */
 663         uint32_t        pm_runcount;    /* #cpus currently on */
 664         enum pmc_state  pm_state;       /* current PMC state */
 665
 666         /*
 667          * The PMC ID field encodes the row-index for the PMC, its
 668          * mode, class and the CPU# associated with the PMC.
 669          */
 670
 671         pmc_id_t        pm_id;          /* allocated PMC id */
 672
 673         /* md extensions */
 674         union pmc_md_pmc        pm_md;
 675 };
 676
 677 /*
 678  * Accessor macros for 'struct pmc'
 679  */
 680
 681 #define PMC_TO_MODE(P)          PMC_ID_TO_MODE((P)->pm_id)
 682 #define PMC_TO_CLASS(P)         PMC_ID_TO_CLASS((P)->pm_id)
 683 #define PMC_TO_ROWINDEX(P)      PMC_ID_TO_ROWINDEX((P)->pm_id)
 684 #define PMC_TO_CPU(P)           PMC_ID_TO_CPU((P)->pm_id)
 685
 686
 687 /*
 688  * struct pmc_process
 689  *
 690  * Record a 'target' process being profiled.
 691  *
 692  * The target process being profiled could be different from the owner
 693  * process which allocated the PMCs.  Each target process descriptor
 694  * is associated with NHWPMC 'struct pmc *' pointers.  Each PMC at a
 695  * given hardware row-index 'n' will use slot 'n' of the 'pp_pmcs[]'
 696  * array.  The size of this structure is thus PMC architecture
 697  * dependent.
 698  *
 699  * TODO: Only process-private counting mode PMCs may be attached to a
 700  * process different from the allocator process (since we do not have
 701  * the infrastructure to make sense of an interrupted PC value from a
 702  * 'target' process (yet)).
 703  *
 704  */
 705
 706 struct pmc_targetstate {
 707         struct pmc      *pp_pmc;   /* target PMC */
 708         pmc_value_t     pp_pmcval; /* per-process value */
 709 };
 710
 711 struct pmc_process {
 712         LIST_ENTRY(pmc_process) pp_next;        /* hash chain */
 713         int             pp_refcnt;              /* reference count */
 714         uint32_t        pp_flags;               /* flags PMC_PP_* */
 715         struct proc     *pp_proc;               /* target thread */
 716         struct pmc_targetstate pp_pmcs[];       /* NHWPMCs */
 717 };
 718
 719 #define PMC_PP_ENABLE_MSR_ACCESS        0x00000001
 720
 721 /*
 722  * struct pmc_owner
 723  *
 724  * We associate a PMC with an 'owner' process.
 725  *
 726  * A process can be associated with 0..NCPUS*NHWPMC PMCs during its
 727  * lifetime, where NCPUS is the numbers of CPUS in the system and
 728  * NHWPMC is the number of hardware PMCs per CPU.  These are
 729  * maintained in the list headed by the 'po_pmcs' to save on space.
 730  *
 731  */
 732
 733 struct pmc_owner  {
 734         LIST_ENTRY(pmc_owner)   po_next;        /* hash chain */
 735         LIST_ENTRY(pmc_owner)   po_ssnext;      /* list of SS PMC owners */
 736         LIST_HEAD(, pmc)        po_pmcs;        /* owned PMC list */
 737         TAILQ_HEAD(, pmclog_buffer) po_logbuffers; /* (o) logbuffer list */
 738         struct mtx              po_mtx;         /* spin lock for (o) */
 739         struct proc             *po_owner;      /* owner proc */
 740         uint32_t                po_flags;       /* (k) flags PMC_PO_* */
 741         struct proc             *po_kthread;    /* (k) helper kthread */
 742         struct pmclog_buffer    *po_curbuf;     /* current log buffer */
 743         struct file             *po_file;       /* file reference */
 744         int                     po_error;       /* recorded error */
 745         int                     po_sscount;     /* # SS PMCs owned */
 746 };
 747
 748 #define PMC_PO_OWNS_LOGFILE             0x00000001 /* has a log file */
 749 #define PMC_PO_IN_FLUSH                 0x00000010 /* in the middle of a flush */
 750 #define PMC_PO_INITIAL_MAPPINGS_DONE    0x00000020
 751
 752 /*
 753  * struct pmc_hw -- describe the state of the PMC hardware
 754  *
 755  * When in use, a HW PMC is associated with one allocated 'struct pmc'
 756  * pointed to by field 'phw_pmc'.  When inactive, this field is NULL.
 757  *
 758  * On an SMP box, one or more HW PMC's in process virtual mode with
 759  * the same 'phw_pmc' could be executing on different CPUs.  In order
 760  * to handle this case correctly, we need to ensure that only
 761  * incremental counts get added to the saved value in the associated
 762  * 'struct pmc'.  The 'phw_save' field is used to keep the saved PMC
 763  * value at the time the hardware is started during this context
 764  * switch (i.e., the difference between the new (hardware) count and
 765  * the saved count is atomically added to the count field in 'struct
 766  * pmc' at context switch time).
 767  *
 768  */
 769
 770 struct pmc_hw {
 771         uint32_t        phw_state;      /* see PHW_* macros below */
 772         struct pmc      *phw_pmc;       /* current thread PMC */
 773 };
 774
 775 #define PMC_PHW_RI_MASK         0x000000FF
 776 #define PMC_PHW_CPU_SHIFT       8
 777 #define PMC_PHW_CPU_MASK        0x0000FF00
 778 #define PMC_PHW_FLAGS_SHIFT     16
 779 #define PMC_PHW_FLAGS_MASK      0xFFFF0000
 780
 781 #define PMC_PHW_INDEX_TO_STATE(ri)      ((ri) & PMC_PHW_RI_MASK)
 782 #define PMC_PHW_STATE_TO_INDEX(state)   ((state) & PMC_PHW_RI_MASK)
 783 #define PMC_PHW_CPU_TO_STATE(cpu)       (((cpu) << PMC_PHW_CPU_SHIFT) & \
 784         PMC_PHW_CPU_MASK)
 785 #define PMC_PHW_STATE_TO_CPU(state)     (((state) & PMC_PHW_CPU_MASK) >> \
 786         PMC_PHW_CPU_SHIFT)
 787 #define PMC_PHW_FLAGS_TO_STATE(flags)   (((flags) << PMC_PHW_FLAGS_SHIFT) & \
 788         PMC_PHW_FLAGS_MASK)
 789 #define PMC_PHW_STATE_TO_FLAGS(state)   (((state) & PMC_PHW_FLAGS_MASK) >> \
 790         PMC_PHW_FLAGS_SHIFT)
 791 #define PMC_PHW_FLAG_IS_ENABLED         (PMC_PHW_FLAGS_TO_STATE(0x01))
 792 #define PMC_PHW_FLAG_IS_SHAREABLE       (PMC_PHW_FLAGS_TO_STATE(0x02))
 793
 794 /*
 795  * struct pmc_sample
 796  *
 797  * Space for N (tunable) PC samples and associated control data.
 798  */
 799
 800 struct pmc_sample {
 801         uint16_t                ps_nsamples;    /* callchain depth */
 802         uint8_t                 ps_cpu;         /* cpu number */
 803         uint8_t                 ps_flags;       /* other flags */
 804         pid_t                   ps_pid;         /* process PID or -1 */
 805         struct pmc              *ps_pmc;        /* interrupting PMC */
 806         uintptr_t               *ps_pc;         /* (const) callchain start */
 807 };
 808
 809 #define PMC_SAMPLE_FREE         ((uint16_t) 0)
 810 #define PMC_SAMPLE_INUSE        ((uint16_t) 0xFFFF)
 811
 812 struct pmc_samplebuffer {
 813         struct pmc_sample * volatile ps_read;   /* read pointer */
 814         struct pmc_sample * volatile ps_write;  /* write pointer */
 815         uintptr_t               *ps_callchains; /* all saved call chains */
 816         struct pmc_sample       *ps_fence;      /* one beyond ps_samples[] */
 817         struct pmc_sample       ps_samples[];   /* array of sample entries */
 818 };
 819
 820
 821 /*
 822  * struct pmc_cpustate
 823  *
 824  * A CPU is modelled as a collection of HW PMCs with space for additional
 825  * flags.
 826  */
 827
 828 struct pmc_cpu {
 829         uint32_t        pc_state;       /* physical cpu number + flags */
 830         struct pmc_samplebuffer *pc_sb; /* space for samples */
 831         struct pmc_hw   *pc_hwpmcs[];   /* 'npmc' pointers */
 832         /* other machine dependent fields come here */
 833 };
 834
 835 #define PMC_PCPU_CPU_MASK               0x000000FF
 836 #define PMC_PCPU_FLAGS_MASK             0xFFFFFF00
 837 #define PMC_PCPU_FLAGS_SHIFT            8
 838 #define PMC_PCPU_STATE_TO_CPU(S)        ((S) & PMC_PCPU_CPU_MASK)
 839 #define PMC_PCPU_STATE_TO_FLAGS(S)      (((S) & PMC_PCPU_FLAGS_MASK) >> PMC_PCPU_FLAGS_SHIFT)
 840 #define PMC_PCPU_FLAGS_TO_STATE(F)      (((F) << PMC_PCPU_FLAGS_SHIFT) & PMC_PCPU_FLAGS_MASK)
 841 #define PMC_PCPU_CPU_TO_STATE(C)        ((C) & PMC_PCPU_CPU_MASK)
 842 #define PMC_PCPU_FLAG_HTT               (PMC_PCPU_FLAGS_TO_STATE(0x1))
 843
 844 /*
 845  * struct pmc_binding
 846  *
 847  * CPU binding information.
 848  */
 849
 850 struct pmc_binding {
 851         int     pb_bound;       /* is bound? */
 852         int     pb_cpu;         /* if so, to which CPU */
 853 };
 854
 855 /*
 856  * struct pmc_mdep
 857  *
 858  * Machine dependent bits needed per CPU type.
 859  */
 860
 861 struct pmc_mdep  {
 862         uint32_t        pmd_cputype;    /* from enum pmc_cputype */
 863         uint32_t        pmd_npmc;       /* max PMCs per CPU */
 864         uint32_t        pmd_nclass;     /* # PMC classes supported */
 865         struct pmc_classinfo  pmd_classes[PMC_CLASS_MAX];
 866         int             pmd_nclasspmcs[PMC_CLASS_MAX];
 867
 868         /*
 869          * Methods
 870          */
 871
 872         int (*pmd_init)(int _cpu);    /* machine dependent initialization */
 873         int (*pmd_cleanup)(int _cpu); /* machine dependent cleanup  */
 874
 875         /* thread context switch in/out */
 876         int (*pmd_switch_in)(struct pmc_cpu *_p, struct pmc_process *_pp);
 877         int (*pmd_switch_out)(struct pmc_cpu *_p, struct pmc_process *_pp);
 878
 879         /* configuring/reading/writing the hardware PMCs */
 880         int (*pmd_config_pmc)(int _cpu, int _ri, struct pmc *_pm);
 881         int (*pmd_get_config)(int _cpu, int _ri, struct pmc **_ppm);
 882         int (*pmd_read_pmc)(int _cpu, int _ri, pmc_value_t *_value);
 883         int (*pmd_write_pmc)(int _cpu, int _ri, pmc_value_t _value);
 884
 885         /* pmc allocation/release */
 886         int (*pmd_allocate_pmc)(int _cpu, int _ri, struct pmc *_t,
 887                 const struct pmc_op_pmcallocate *_a);
 888         int (*pmd_release_pmc)(int _cpu, int _ri, struct pmc *_pm);
 889
 890         /* starting and stopping PMCs */
 891         int (*pmd_start_pmc)(int _cpu, int _ri);
 892         int (*pmd_stop_pmc)(int _cpu, int _ri);
 893
 894         /* handle a PMC interrupt */
 895         int (*pmd_intr)(int _cpu, struct trapframe *_tf);
 896
 897         int (*pmd_describe)(int _cpu, int _ri, struct pmc_info *_pi,
 898                 struct pmc **_ppmc);
 899
 900         int (*pmd_get_msr)(int _ri, uint32_t *_msr);
 901
 902 };
 903
 904 /*
 905  * Per-CPU state.  This is an array of 'mp_ncpu' pointers
 906  * to struct pmc_cpu descriptors.
 907  */
 908
 909 extern struct pmc_cpu **pmc_pcpu;
 910 extern struct pmc_mdep *md;
 911
 912 /* driver statistics */
 913 extern struct pmc_op_getdriverstats pmc_stats;
 914
 915 #if     defined(DEBUG) && DEBUG
 916
 917 /* debug flags, major flag groups */
 918 struct pmc_debugflags {
 919         int     pdb_CPU;
 920         int     pdb_CSW;
 921         int     pdb_LOG;
 922         int     pdb_MDP;
 923         int     pdb_MOD;
 924         int     pdb_OWN;
 925         int     pdb_PMC;
 926         int     pdb_PRC;
 927         int     pdb_SAM;
 928 };
 929
 930 extern struct pmc_debugflags pmc_debugflags;
 931
 932 #define PMC_DEBUG_STRSIZE               128
 933 #define PMC_DEBUG_DEFAULT_FLAGS         { 0, 0, 0, 0, 0, 0, 0, 0 }
 934
 935 #define PMCDBG(M,N,L,F,...) do {                                        \
 936         if (pmc_debugflags.pdb_ ## M & (1 << PMC_DEBUG_MIN_ ## N))      \
 937                 printf(#M ":" #N ":" #L  ": " F "\n", __VA_ARGS__);     \
 938 } while (0)
 939
 940 /* Major numbers */
 941 #define PMC_DEBUG_MAJ_CPU               0 /* cpu switches */
 942 #define PMC_DEBUG_MAJ_CSW               1 /* context switches */
 943 #define PMC_DEBUG_MAJ_LOG               2 /* logging */
 944 #define PMC_DEBUG_MAJ_MDP               3 /* machine dependent */
 945 #define PMC_DEBUG_MAJ_MOD               4 /* misc module infrastructure */
 946 #define PMC_DEBUG_MAJ_OWN               5 /* owner */
 947 #define PMC_DEBUG_MAJ_PMC               6 /* pmc management */
 948 #define PMC_DEBUG_MAJ_PRC               7 /* processes */
 949 #define PMC_DEBUG_MAJ_SAM               8 /* sampling */
 950
 951 /* Minor numbers */
 952
 953 /* Common (8 bits) */
 954 #define PMC_DEBUG_MIN_ALL               0 /* allocation */
 955 #define PMC_DEBUG_MIN_REL               1 /* release */
 956 #define PMC_DEBUG_MIN_OPS               2 /* ops: start, stop, ... */
 957 #define PMC_DEBUG_MIN_INI               3 /* init */
 958 #define PMC_DEBUG_MIN_FND               4 /* find */
 959
 960 /* MODULE */
 961 #define PMC_DEBUG_MIN_PMH              14 /* pmc_hook */
 962 #define PMC_DEBUG_MIN_PMS              15 /* pmc_syscall */
 963
 964 /* OWN */
 965 #define PMC_DEBUG_MIN_ORM               8 /* owner remove */
 966 #define PMC_DEBUG_MIN_OMR               9 /* owner maybe remove */
 967
 968 /* PROCESSES */
 969 #define PMC_DEBUG_MIN_TLK               8 /* link target */
 970 #define PMC_DEBUG_MIN_TUL               9 /* unlink target */
 971 #define PMC_DEBUG_MIN_EXT              10 /* process exit */
 972 #define PMC_DEBUG_MIN_EXC              11 /* process exec */
 973 #define PMC_DEBUG_MIN_FRK              12 /* process fork */
 974 #define PMC_DEBUG_MIN_ATT              13 /* attach/detach */
 975 #define PMC_DEBUG_MIN_SIG              14 /* signalling */
 976
 977 /* CONTEXT SWITCHES */
 978 #define PMC_DEBUG_MIN_SWI               8 /* switch in */
 979 #define PMC_DEBUG_MIN_SWO               9 /* switch out */
 980
 981 /* PMC */
 982 #define PMC_DEBUG_MIN_REG               8 /* pmc register */
 983 #define PMC_DEBUG_MIN_ALR               9 /* allocate row */
 984
 985 /* MACHINE DEPENDENT LAYER */
 986 #define PMC_DEBUG_MIN_REA               8 /* read */
 987 #define PMC_DEBUG_MIN_WRI               9 /* write */
 988 #define PMC_DEBUG_MIN_CFG              10 /* config */
 989 #define PMC_DEBUG_MIN_STA              11 /* start */
 990 #define PMC_DEBUG_MIN_STO              12 /* stop */
 991 #define PMC_DEBUG_MIN_INT              13 /* interrupts */
 992
 993 /* CPU */
 994 #define PMC_DEBUG_MIN_BND               8 /* bind */
 995 #define PMC_DEBUG_MIN_SEL               9 /* select */
 996
 997 /* LOG */
 998 #define PMC_DEBUG_MIN_GTB               8 /* get buf */
 999 #define PMC_DEBUG_MIN_SIO               9 /* schedule i/o */
1000 #define PMC_DEBUG_MIN_FLS              10 /* flush */
1001 #define PMC_DEBUG_MIN_SAM              11 /* sample */
1002
1003 #else
1004 #define PMCDBG(M,N,L,F,...)             /* nothing */
1005 #endif
1006
1007 /* declare a dedicated memory pool */
1008 MALLOC_DECLARE(M_PMC);
1009
1010 /*
1011  * Functions
1012  */
1013
1014 struct pmc_mdep *pmc_md_initialize(void);       /* MD init function */
1015 int     pmc_getrowdisp(int _ri);
1016 int     pmc_process_interrupt(int _cpu, struct pmc *_pm,
1017     struct trapframe *_tf, int _inuserspace);
1018 int     pmc_save_kernel_callchain(uintptr_t *_cc, int _maxsamples,
1019     struct trapframe *_tf);
1020 int     pmc_save_user_callchain(uintptr_t *_cc, int _maxsamples,
1021     struct trapframe *_tf);
1022 #endif /* _KERNEL */
1023 #endif /* _SYS_PMC_H_ */