1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2003-2007, Joseph Koshy 5 * Copyright (c) 2007 The FreeBSD Foundation 6 * All rights reserved. 7 * 8 * Portions of this software were developed by A. Joseph Koshy under 9 * sponsorship from the FreeBSD Foundation and Google, Inc. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * $FreeBSD$ 33 */ 34 35 /* 36 * PMC interface used by the base kernel. 37 */ 38 39 #ifndef _SYS_PMCKERN_H_ 40 #define _SYS_PMCKERN_H_ 41 42 #include <sys/param.h> 43 #include <sys/systm.h> 44 #include <sys/kernel.h> 45 #include <sys/lock.h> 46 #include <sys/proc.h> 47 #include <sys/sx.h> 48 #include <sys/pmc.h> 49 50 #include <machine/cpufunc.h> 51 52 #define PMC_FN_PROCESS_EXEC 1 53 #define PMC_FN_CSW_IN 2 54 #define PMC_FN_CSW_OUT 3 55 #define PMC_FN_DO_SAMPLES 4 56 #define PMC_FN_UNUSED1 5 57 #define PMC_FN_UNUSED2 6 58 #define PMC_FN_MMAP 7 59 #define PMC_FN_MUNMAP 8 60 #define PMC_FN_USER_CALLCHAIN 9 61 #define PMC_FN_USER_CALLCHAIN_SOFT 10 62 #define PMC_FN_SOFT_SAMPLING 11 63 #define PMC_FN_THR_CREATE 12 64 #define PMC_FN_THR_EXIT 13 65 #define PMC_FN_THR_USERRET 14 66 #define PMC_FN_THR_CREATE_LOG 15 67 #define PMC_FN_THR_EXIT_LOG 16 68 #define PMC_FN_PROC_CREATE_LOG 17 69 70 typedef enum ring_type { 71 PMC_HR = 0, /* Hardware ring buffer */ 72 PMC_SR = 1, /* Software ring buffer */ 73 PMC_UR = 2, /* userret ring buffer */ 74 PMC_NUM_SR = PMC_UR+1 75 } ring_type_t; 76 77 struct pmckern_procexec { 78 int pm_credentialschanged; 79 uintptr_t pm_baseaddr; 80 uintptr_t pm_dynaddr; 81 }; 82 83 struct pmckern_map_in { 84 void *pm_file; /* filename or vnode pointer */ 85 uintfptr_t pm_address; /* address object is loaded at */ 86 }; 87 88 struct pmckern_map_out { 89 uintfptr_t pm_address; /* start address of region */ 90 size_t pm_size; /* size of unmapped region */ 91 }; 92 93 struct pmckern_soft { 94 enum pmc_event pm_ev; 95 int pm_cpu; 96 struct trapframe *pm_tf; 97 }; 98 99 /* 100 * Soft PMC. 101 */ 102 103 #define PMC_SOFT_DEFINE_EX(prov, mod, func, name, alloc, release) \ 104 struct pmc_soft pmc_##prov##_##mod##_##func##_##name = \ 105 { 0, alloc, release, { #prov "_" #mod "_" #func "." #name, 0 } }; \ 106 SYSINIT(pmc_##prov##_##mod##_##func##_##name##_init, SI_SUB_KDTRACE, \ 107 SI_ORDER_SECOND + 1, pmc_soft_ev_register, \ 108 &pmc_##prov##_##mod##_##func##_##name ); \ 109 SYSUNINIT(pmc_##prov##_##mod##_##func##_##name##_uninit, \ 110 SI_SUB_KDTRACE, SI_ORDER_SECOND + 1, pmc_soft_ev_deregister, \ 111 &pmc_##prov##_##mod##_##func##_##name ) 112 113 #define PMC_SOFT_DEFINE(prov, mod, func, name) \ 114 PMC_SOFT_DEFINE_EX(prov, mod, func, name, NULL, NULL) 115 116 #define PMC_SOFT_DECLARE(prov, mod, func, name) \ 117 extern struct pmc_soft pmc_##prov##_##mod##_##func##_##name 118 119 /* 120 * PMC_SOFT_CALL can be used anywhere in the kernel. 121 * Require md defined PMC_FAKE_TRAPFRAME. 122 */ 123 #ifdef PMC_FAKE_TRAPFRAME 124 #define PMC_SOFT_CALL(pr, mo, fu, na) \ 125 do { \ 126 if (__predict_false(pmc_##pr##_##mo##_##fu##_##na.ps_running)) { \ 127 struct pmckern_soft ks; \ 128 register_t intr; \ 129 intr = intr_disable(); \ 130 PMC_FAKE_TRAPFRAME(&pmc_tf[curcpu]); \ 131 ks.pm_ev = pmc_##pr##_##mo##_##fu##_##na.ps_ev.pm_ev_code; \ 132 ks.pm_cpu = PCPU_GET(cpuid); \ 133 ks.pm_tf = &pmc_tf[curcpu]; \ 134 PMC_CALL_HOOK_UNLOCKED(curthread, \ 135 PMC_FN_SOFT_SAMPLING, (void *) &ks); \ 136 intr_restore(intr); \ 137 } \ 138 } while (0) 139 #else 140 #define PMC_SOFT_CALL(pr, mo, fu, na) \ 141 do { \ 142 } while (0) 143 #endif 144 145 /* 146 * PMC_SOFT_CALL_TF need to be used carefully. 147 * Userland capture will be done during AST processing. 148 */ 149 #define PMC_SOFT_CALL_TF(pr, mo, fu, na, tf) \ 150 do { \ 151 if (__predict_false(pmc_##pr##_##mo##_##fu##_##na.ps_running)) { \ 152 struct pmckern_soft ks; \ 153 register_t intr; \ 154 intr = intr_disable(); \ 155 ks.pm_ev = pmc_##pr##_##mo##_##fu##_##na.ps_ev.pm_ev_code; \ 156 ks.pm_cpu = PCPU_GET(cpuid); \ 157 ks.pm_tf = tf; \ 158 PMC_CALL_HOOK_UNLOCKED(curthread, \ 159 PMC_FN_SOFT_SAMPLING, (void *) &ks); \ 160 intr_restore(intr); \ 161 } \ 162 } while (0) 163 164 struct pmc_soft { 165 int ps_running; 166 void (*ps_alloc)(void); 167 void (*ps_release)(void); 168 struct pmc_dyn_event_descr ps_ev; 169 }; 170 171 struct pmclog_buffer; 172 173 struct pmc_domain_buffer_header { 174 struct mtx pdbh_mtx; 175 TAILQ_HEAD(, pmclog_buffer) pdbh_head; 176 struct pmclog_buffer *pdbh_plbs; 177 int pdbh_ncpus; 178 } __aligned(CACHE_LINE_SIZE); 179 180 /* hook */ 181 extern int (*pmc_hook)(struct thread *_td, int _function, void *_arg); 182 extern int (*pmc_intr)(struct trapframe *_frame); 183 184 /* SX lock protecting the hook */ 185 extern struct sx pmc_sx; 186 187 /* Per-cpu flags indicating availability of sampling data */ 188 DPCPU_DECLARE(uint8_t, pmc_sampled); 189 190 /* Count of system-wide sampling PMCs in existence */ 191 extern volatile int pmc_ss_count; 192 193 /* kernel version number */ 194 extern const int pmc_kernel_version; 195 196 /* PMC soft per cpu trapframe */ 197 extern struct trapframe pmc_tf[MAXCPU]; 198 199 /* per domain buffer header list */ 200 extern struct pmc_domain_buffer_header *pmc_dom_hdrs[MAXMEMDOM]; 201 202 /* Quick check if preparatory work is necessary */ 203 #define PMC_HOOK_INSTALLED(cmd) __predict_false(pmc_hook != NULL) 204 205 /* Hook invocation; for use within the kernel */ 206 #define PMC_CALL_HOOK(t, cmd, arg) \ 207 do { \ 208 struct epoch_tracker et; \ 209 epoch_enter_preempt(global_epoch_preempt, &et); \ 210 if (pmc_hook != NULL) \ 211 (pmc_hook)((t), (cmd), (arg)); \ 212 epoch_exit_preempt(global_epoch_preempt, &et); \ 213 } while (0) 214 215 /* Hook invocation that needs an exclusive lock */ 216 #define PMC_CALL_HOOK_X(t, cmd, arg) \ 217 do { \ 218 sx_xlock(&pmc_sx); \ 219 if (pmc_hook != NULL) \ 220 (pmc_hook)((t), (cmd), (arg)); \ 221 sx_xunlock(&pmc_sx); \ 222 } while (0) 223 224 /* 225 * Some hook invocations (e.g., from context switch and clock handling 226 * code) need to be lock-free. 227 */ 228 #define PMC_CALL_HOOK_UNLOCKED(t, cmd, arg) \ 229 do { \ 230 if (pmc_hook != NULL) \ 231 (pmc_hook)((t), (cmd), (arg)); \ 232 } while (0) 233 234 #define PMC_SWITCH_CONTEXT(t,cmd) PMC_CALL_HOOK_UNLOCKED(t,cmd,NULL) 235 236 /* Check if a process is using HWPMCs.*/ 237 #define PMC_PROC_IS_USING_PMCS(p) \ 238 (__predict_false(p->p_flag & P_HWPMC)) 239 240 #define PMC_THREAD_HAS_SAMPLES(td) \ 241 (__predict_false((td)->td_pmcpend)) 242 243 /* Check if a thread have pending user capture. */ 244 #define PMC_IS_PENDING_CALLCHAIN(p) \ 245 (__predict_false((p)->td_pflags & TDP_CALLCHAIN)) 246 247 #define PMC_SYSTEM_SAMPLING_ACTIVE() (pmc_ss_count > 0) 248 249 /* Check if a CPU has recorded samples. */ 250 #define PMC_CPU_HAS_SAMPLES(C) (__predict_false(DPCPU_ID_GET((C), pmc_sampled))) 251 252 /* 253 * Helper functions. 254 */ 255 int pmc_cpu_is_disabled(int _cpu); /* deprecated */ 256 int pmc_cpu_is_active(int _cpu); 257 int pmc_cpu_is_present(int _cpu); 258 int pmc_cpu_is_primary(int _cpu); 259 unsigned int pmc_cpu_max(void); 260 261 #ifdef INVARIANTS 262 int pmc_cpu_max_active(void); 263 #endif 264 265 /* 266 * Soft events functions. 267 */ 268 void pmc_soft_ev_register(struct pmc_soft *ps); 269 void pmc_soft_ev_deregister(struct pmc_soft *ps); 270 struct pmc_soft *pmc_soft_ev_acquire(enum pmc_event ev); 271 void pmc_soft_ev_release(struct pmc_soft *ps); 272 273 #endif /* _SYS_PMCKERN_H_ */ 274