1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2003-2008 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/* Machine dependent interfaces */
36
37#ifndef _MACHINE_PMC_MDEP_H
38#define	_MACHINE_PMC_MDEP_H 1
39
40#ifdef	_KERNEL
41struct pmc_mdep;
42#endif
43
44#include <dev/hwpmc/hwpmc_amd.h>
45#include <dev/hwpmc/hwpmc_core.h>
46#include <dev/hwpmc/hwpmc_tsc.h>
47#include <dev/hwpmc/hwpmc_uncore.h>
48
49/*
50 * Intel processors implementing V2 and later of the Intel performance
51 * measurement architecture have PMCs of the following classes: TSC,
52 * IAF, IAP, UCF and UCP.
53 */
54#define	PMC_MDEP_CLASS_INDEX_TSC	1
55#define	PMC_MDEP_CLASS_INDEX_K8		2
56#define	PMC_MDEP_CLASS_INDEX_P4		2
57#define	PMC_MDEP_CLASS_INDEX_IAP	2
58#define	PMC_MDEP_CLASS_INDEX_IAF	3
59#define	PMC_MDEP_CLASS_INDEX_UCP	4
60#define	PMC_MDEP_CLASS_INDEX_UCF	5
61
62/*
63 * On the amd64 platform we support the following PMCs.
64 *
65 * TSC		The timestamp counter
66 * K8		AMD Athlon64 and Opteron PMCs in 64 bit mode.
67 * PIV		Intel P4/HTT and P4/EMT64
68 * IAP		Intel Core/Core2/Atom CPUs in 64 bits mode.
69 * IAF		Intel fixed-function PMCs in Core2 and later CPUs.
70 * UCP		Intel Uncore programmable PMCs.
71 * UCF		Intel Uncore fixed-function PMCs.
72 */
73
74union pmc_md_op_pmcallocate  {
75	struct pmc_md_amd_op_pmcallocate	pm_amd;
76	struct pmc_md_iap_op_pmcallocate	pm_iap;
77	struct pmc_md_ucf_op_pmcallocate	pm_ucf;
78	struct pmc_md_ucp_op_pmcallocate	pm_ucp;
79	uint64_t				__pad[4];
80};
81
82/* Logging */
83#define	PMCLOG_READADDR		PMCLOG_READ64
84#define	PMCLOG_EMITADDR		PMCLOG_EMIT64
85
86#ifdef	_KERNEL
87
88union pmc_md_pmc {
89	struct pmc_md_amd_pmc	pm_amd;
90	struct pmc_md_iaf_pmc	pm_iaf;
91	struct pmc_md_iap_pmc	pm_iap;
92	struct pmc_md_ucf_pmc	pm_ucf;
93	struct pmc_md_ucp_pmc	pm_ucp;
94};
95
96#define	PMC_TRAPFRAME_TO_PC(TF)	((TF)->tf_rip)
97#define	PMC_TRAPFRAME_TO_FP(TF)	((TF)->tf_rbp)
98#define	PMC_TRAPFRAME_TO_USER_SP(TF)	((TF)->tf_rsp)
99#define	PMC_TRAPFRAME_TO_KERNEL_SP(TF)	((TF)->tf_rsp)
100
101#define	PMC_AT_FUNCTION_PROLOGUE_PUSH_BP(I)		\
102	(((I) & 0xffffffff) == 0xe5894855) /* pushq %rbp; movq %rsp,%rbp */
103#define	PMC_AT_FUNCTION_PROLOGUE_MOV_SP_BP(I)		\
104	(((I) & 0x00ffffff) == 0x00e58948) /* movq %rsp,%rbp */
105#define	PMC_AT_FUNCTION_EPILOGUE_RET(I)			\
106	(((I) & 0xFF) == 0xC3)		   /* ret */
107
108#define	PMC_IN_TRAP_HANDLER(PC) 			\
109	((PC) >= (uintptr_t) start_exceptions &&	\
110	 (PC) < (uintptr_t) end_exceptions)
111
112#define	PMC_IN_KERNEL_STACK(S,START,END)		\
113	((S) >= (START) && (S) < (END))
114#define	PMC_IN_KERNEL(va) INKERNEL(va)
115
116#define	PMC_IN_USERSPACE(va) ((va) <= VM_MAXUSER_ADDRESS)
117
118/* Build a fake kernel trapframe from current instruction pointer. */
119#define PMC_FAKE_TRAPFRAME(TF)						\
120	do {								\
121	(TF)->tf_cs = 0; (TF)->tf_rflags = 0;				\
122	__asm __volatile("movq %%rbp,%0" : "=r" ((TF)->tf_rbp));	\
123	__asm __volatile("movq %%rsp,%0" : "=r" ((TF)->tf_rsp));	\
124	__asm __volatile("call 1f \n\t1: pop %0" : "=r"((TF)->tf_rip));	\
125	} while (0)
126
127/*
128 * Prototypes
129 */
130
131void	start_exceptions(void), end_exceptions(void);
132
133struct pmc_mdep *pmc_amd_initialize(void);
134void	pmc_amd_finalize(struct pmc_mdep *_md);
135struct pmc_mdep *pmc_intel_initialize(void);
136void	pmc_intel_finalize(struct pmc_mdep *_md);
137
138#endif /* _KERNEL */
139#endif /* _MACHINE_PMC_MDEP_H */
140