2 * Copyright (c) 2003-2005, Joseph Koshy
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * PMC interface used by the base kernel.
33 #ifndef _SYS_PMCKERN_H_
34 #define _SYS_PMCKERN_H_
36 #include <sys/param.h>
37 #include <sys/kernel.h>
42 #define PMC_FN_PROCESS_EXEC 1
43 #define PMC_FN_CSW_IN 2
44 #define PMC_FN_CSW_OUT 3
45 #define PMC_FN_DO_SAMPLES 4
47 struct pmckern_procexec {
48 int pm_credentialschanged;
49 uintptr_t pm_entryaddr;
53 extern int (*pmc_hook)(struct thread *_td, int _function, void *_arg);
54 extern int (*pmc_intr)(int _cpu, uintptr_t _pc, int _usermode);
56 /* SX lock protecting the hook */
57 extern struct sx pmc_sx;
59 /* Per-cpu flags indicating availability of sampling data */
60 extern volatile cpumask_t pmc_cpumask;
62 /* Count of system-wide sampling PMCs in existence */
63 extern volatile int pmc_ss_count;
65 /* kernel version number */
66 extern const int pmc_kernel_version;
68 /* Hook invocation; for use within the kernel */
69 #define PMC_CALL_HOOK(t, cmd, arg) \
72 if (pmc_hook != NULL) \
73 (pmc_hook)((t), (cmd), (arg)); \
74 sx_sunlock(&pmc_sx); \
77 /* Hook invocation that needs an exclusive lock */
78 #define PMC_CALL_HOOK_X(t, cmd, arg) \
81 if (pmc_hook != NULL) \
82 (pmc_hook)((t), (cmd), (arg)); \
83 sx_xunlock(&pmc_sx); \
87 * Some hook invocations (e.g., from context switch and clock handling
88 * code) need to be lock-free.
90 #define PMC_CALL_HOOK_UNLOCKED(t, cmd, arg) \
92 if (pmc_hook != NULL) \
93 (pmc_hook)((t), (cmd), (arg)); \
96 #define PMC_SWITCH_CONTEXT(t,cmd) PMC_CALL_HOOK_UNLOCKED(t,cmd,NULL)
98 /* Check if a process is using HWPMCs.*/
99 #define PMC_PROC_IS_USING_PMCS(p) \
100 (__predict_false(atomic_load_acq_int(&(p)->p_flag) & \
103 #define PMC_SYSTEM_SAMPLING_ACTIVE() (pmc_ss_count > 0)
105 /* Check if a CPU has recorded samples. */
106 #define PMC_CPU_HAS_SAMPLES(C) (__predict_false(pmc_cpumask & (1 << (C))))
108 /* helper functions */
109 int pmc_cpu_is_disabled(int _cpu);
110 int pmc_cpu_is_logical(int _cpu);
112 #endif /* _SYS_PMCKERN_H_ */