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