xref: /freebsd/sys/dev/hwpmc/hwpmc_intel.c (revision 35eb9b10c265a27ce1f80a6eb74887240c7f4305)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2008 Joseph Koshy
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 /*
30  * Common code for handling Intel CPUs.
31  */
32 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35 
36 #include <sys/param.h>
37 #include <sys/pmc.h>
38 #include <sys/pmckern.h>
39 #include <sys/systm.h>
40 
41 #include <machine/cpu.h>
42 #include <machine/cputypes.h>
43 #include <machine/md_var.h>
44 #include <machine/specialreg.h>
45 
46 static int
47 intel_switch_in(struct pmc_cpu *pc, struct pmc_process *pp)
48 {
49 	(void) pc;
50 
51 	PMCDBG3(MDP,SWI,1, "pc=%p pp=%p enable-msr=%d", pc, pp,
52 	    pp->pp_flags & PMC_PP_ENABLE_MSR_ACCESS);
53 
54 	/* allow the RDPMC instruction if needed */
55 	if (pp->pp_flags & PMC_PP_ENABLE_MSR_ACCESS)
56 		load_cr4(rcr4() | CR4_PCE);
57 
58 	PMCDBG1(MDP,SWI,1, "cr4=0x%jx", (uintmax_t) rcr4());
59 
60 	return 0;
61 }
62 
63 static int
64 intel_switch_out(struct pmc_cpu *pc, struct pmc_process *pp)
65 {
66 	(void) pc;
67 	(void) pp;		/* can be NULL */
68 
69 	PMCDBG3(MDP,SWO,1, "pc=%p pp=%p cr4=0x%jx", pc, pp,
70 	    (uintmax_t) rcr4());
71 
72 	/* always turn off the RDPMC instruction */
73 	load_cr4(rcr4() & ~CR4_PCE);
74 
75 	return 0;
76 }
77 
78 struct pmc_mdep *
79 pmc_intel_initialize(void)
80 {
81 	struct pmc_mdep *pmc_mdep;
82 	enum pmc_cputype cputype;
83 	int error, family, model, nclasses, ncpus, stepping, verov;
84 
85 	KASSERT(cpu_vendor_id == CPU_VENDOR_INTEL,
86 	    ("[intel,%d] Initializing non-intel processor", __LINE__));
87 
88 	PMCDBG1(MDP,INI,0, "intel-initialize cpuid=0x%x", cpu_id);
89 
90 	cputype = -1;
91 	nclasses = 2;
92 	error = 0;
93 	verov = 0;
94 	family = CPUID_TO_FAMILY(cpu_id);
95 	model = CPUID_TO_MODEL(cpu_id);
96 	stepping = CPUID_TO_STEPPING(cpu_id);
97 
98 	snprintf(pmc_cpuid, sizeof(pmc_cpuid), "GenuineIntel-%d-%02X-%X",
99 	    family, model, stepping);
100 
101 	switch (cpu_id & 0xF00) {
102 	case 0x600:		/* Pentium Pro, Celeron, Pentium II & III */
103 		switch (model) {
104 		case 0xE:
105 			cputype = PMC_CPU_INTEL_CORE;
106 			break;
107 		case 0xF:
108 			/* Per Intel document 315338-020. */
109 			if (stepping == 0x7) {
110 				cputype = PMC_CPU_INTEL_CORE;
111 				verov = 1;
112 			} else {
113 				cputype = PMC_CPU_INTEL_CORE2;
114 				nclasses = 3;
115 			}
116 			break;
117 		case 0x17:
118 			cputype = PMC_CPU_INTEL_CORE2EXTREME;
119 			nclasses = 3;
120 			break;
121 		case 0x1C:	/* Per Intel document 320047-002. */
122 			cputype = PMC_CPU_INTEL_ATOM;
123 			nclasses = 3;
124 			break;
125 		case 0x1A:
126 		case 0x1E:	/*
127 				 * Per Intel document 253669-032 9/2009,
128 				 * pages A-2 and A-57
129 				 */
130 		case 0x1F:	/*
131 				 * Per Intel document 253669-032 9/2009,
132 				 * pages A-2 and A-57
133 				 */
134 			cputype = PMC_CPU_INTEL_COREI7;
135 			nclasses = 5;
136 			break;
137 		case 0x2E:
138 			cputype = PMC_CPU_INTEL_NEHALEM_EX;
139 			nclasses = 3;
140 			break;
141 		case 0x25:	/* Per Intel document 253669-033US 12/2009. */
142 		case 0x2C:	/* Per Intel document 253669-033US 12/2009. */
143 			cputype = PMC_CPU_INTEL_WESTMERE;
144 			nclasses = 5;
145 			break;
146 		case 0x2F:	/* Westmere-EX, seen in wild */
147 			cputype = PMC_CPU_INTEL_WESTMERE_EX;
148 			nclasses = 3;
149 			break;
150 		case 0x2A:	/* Per Intel document 253669-039US 05/2011. */
151 			cputype = PMC_CPU_INTEL_SANDYBRIDGE;
152 			nclasses = 3;
153 			break;
154 		case 0x2D:	/* Per Intel document 253669-044US 08/2012. */
155 			cputype = PMC_CPU_INTEL_SANDYBRIDGE_XEON;
156 			nclasses = 3;
157 			break;
158 		case 0x3A:	/* Per Intel document 253669-043US 05/2012. */
159 			cputype = PMC_CPU_INTEL_IVYBRIDGE;
160 			nclasses = 3;
161 			break;
162 		case 0x3E:	/* Per Intel document 325462-045US 01/2013. */
163 			cputype = PMC_CPU_INTEL_IVYBRIDGE_XEON;
164 			nclasses = 3;
165 			break;
166 		case 0x3D:
167 		case 0x47:
168 			cputype = PMC_CPU_INTEL_BROADWELL;
169 			nclasses = 3;
170 			break;
171 		case 0x4f:
172 		case 0x56:
173 			cputype = PMC_CPU_INTEL_BROADWELL_XEON;
174 			nclasses = 3;
175 			break;
176 		case 0x3C:	/* Per Intel document 325462-045US 01/2013. */
177 		case 0x45:	/* Per Intel document 325462-045US 09/2014. */
178 			cputype = PMC_CPU_INTEL_HASWELL;
179 			nclasses = 3;
180 			break;
181 		case 0x3F:	/* Per Intel document 325462-045US 09/2014. */
182 		case 0x46:	/* Per Intel document 325462-045US 09/2014. */
183 			        /* Should 46 be XEON. probably its own? */
184 			cputype = PMC_CPU_INTEL_HASWELL_XEON;
185 			nclasses = 3;
186 			break;
187 			/* Skylake */
188 		case 0x4e:
189 		case 0x5e:
190 			/* Kabylake */
191 		case 0x8E:	/* Per Intel document 325462-063US July 2017. */
192 		case 0x9E:	/* Per Intel document 325462-063US July 2017. */
193 			/* Cometlake */
194 		case 0xA5:
195 		case 0xA6:
196 			cputype = PMC_CPU_INTEL_SKYLAKE;
197 			nclasses = 3;
198 			break;
199 		case 0x55:	/* SDM rev 63 */
200 			cputype = PMC_CPU_INTEL_SKYLAKE_XEON;
201 			nclasses = 3;
202 			break;
203 			/* Icelake */
204 		case 0x7D:
205 		case 0x7E:
206 			/* Tigerlake */
207 		case 0x8C:
208 		case 0x8D:
209 			/* Rocketlake */
210 		case 0xA7:
211 			cputype = PMC_CPU_INTEL_ICELAKE;
212 			nclasses = 3;
213 			break;
214 		case 0x6A:
215 		case 0x6C:
216 			cputype = PMC_CPU_INTEL_ICELAKE_XEON;
217 			nclasses = 3;
218 			break;
219 		case 0x97:
220 		case 0x9A:
221 			cputype = PMC_CPU_INTEL_ALDERLAKE;
222 			nclasses = 3;
223 			break;
224 		case 0x37:
225 		case 0x4A:
226 		case 0x4D:      /* Per Intel document 330061-001 01/2014. */
227 		case 0x5A:
228 		case 0x5D:
229 			cputype = PMC_CPU_INTEL_ATOM_SILVERMONT;
230 			nclasses = 3;
231 			break;
232 		case 0x5C:	/* Per Intel document 325462-071US 10/2019. */
233 		case 0x5F:
234 			cputype = PMC_CPU_INTEL_ATOM_GOLDMONT;
235 			nclasses = 3;
236 			break;
237 		}
238 		break;
239 	}
240 
241 
242 	if ((int) cputype == -1) {
243 		printf("pmc: Unknown Intel CPU.\n");
244 		return (NULL);
245 	}
246 
247 	/* Allocate base class and initialize machine dependent struct */
248 	pmc_mdep = pmc_mdep_alloc(nclasses);
249 
250 	pmc_mdep->pmd_cputype	 = cputype;
251 	pmc_mdep->pmd_switch_in	 = intel_switch_in;
252 	pmc_mdep->pmd_switch_out = intel_switch_out;
253 
254 	ncpus = pmc_cpu_max();
255 	error = pmc_tsc_initialize(pmc_mdep, ncpus);
256 	if (error)
257 		goto error;
258 
259 	MPASS(nclasses >= PMC_MDEP_CLASS_INDEX_IAF);
260 	error = pmc_core_initialize(pmc_mdep, ncpus, verov);
261 	if (error) {
262 		pmc_tsc_finalize(pmc_mdep);
263 		goto error;
264 	}
265 
266 	/*
267 	 * Init the uncore class.
268 	 */
269 	switch (cputype) {
270 		/*
271 		 * Intel Corei7 and Westmere processors.
272 		 */
273 	case PMC_CPU_INTEL_COREI7:
274 	case PMC_CPU_INTEL_WESTMERE:
275 #ifdef notyet
276 	/*
277 	 * TODO: re-enable uncore class on these processors.
278 	 *
279 	 * The uncore unit was reworked beginning with Sandy Bridge, including
280 	 * the MSRs required to program it. In particular, we need to:
281 	 *  - Parse the MSR_UNC_CBO_CONFIG MSR for number of C-box units in the
282 	 *    system
283 	 *  - Support reading and writing to ARB and C-box units, depending on
284 	 *    the requested event
285 	 *  - Create some kind of mapping between C-box <--> CPU
286 	 *
287 	 * Also TODO: support other later changes to these interfaces, to
288 	 * enable the uncore class on generations newer than Broadwell.
289 	 * Skylake+ appears to use newer addresses for the uncore MSRs.
290 	 */
291 	case PMC_CPU_INTEL_HASWELL:
292 	case PMC_CPU_INTEL_BROADWELL:
293 	case PMC_CPU_INTEL_SANDYBRIDGE:
294 #endif
295 		MPASS(nclasses >= PMC_MDEP_CLASS_INDEX_UCF);
296 		error = pmc_uncore_initialize(pmc_mdep, ncpus);
297 		break;
298 	default:
299 		break;
300 	}
301   error:
302 	if (error) {
303 		pmc_mdep_free(pmc_mdep);
304 		pmc_mdep = NULL;
305 	}
306 
307 	return (pmc_mdep);
308 }
309 
310 void
311 pmc_intel_finalize(struct pmc_mdep *md)
312 {
313 	pmc_tsc_finalize(md);
314 
315 	pmc_core_finalize(md);
316 
317 	/*
318 	 * Uncore.
319 	 */
320 	switch (md->pmd_cputype) {
321 	case PMC_CPU_INTEL_COREI7:
322 	case PMC_CPU_INTEL_WESTMERE:
323 #ifdef notyet
324 	case PMC_CPU_INTEL_HASWELL:
325 	case PMC_CPU_INTEL_BROADWELL:
326 	case PMC_CPU_INTEL_SANDYBRIDGE:
327 #endif
328 		pmc_uncore_finalize(md);
329 		break;
330 	default:
331 		break;
332 	}
333 }
334