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