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