xref: /freebsd/usr.sbin/pmc/headers.hh (revision a79a051e7d16684b5bce7792dbfb4ad81f350b09)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2026, Netflix, Inc.
5  *
6  * This software was developed by Ali Mashtizadeh under the sponsorship from
7  * Netflix, 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  */
31 
32 #ifndef __HEADERS_HH__
33 #define __HEADERS_HH__
34 
35 #define PMC_HEADER_MAGIC	0x504D434C
36 #define PMC_HEADER_VERSION	0x00
37 
38 #define PMC_ARCH_AMD64		0x01
39 #define PMC_ARCH_ARM64		0x02
40 #define PMC_ARCH_PPC64		0x03
41 #define PMC_ARCH_RISCV64	0x04
42 #define PMC_ARCH_ARM		0x05
43 
44 struct pmchdr_header
45 {
46 	uint32_t	magic;
47 	uint16_t	version;
48 	uint16_t	arch;
49 };
50 
51 #define INFOHDR_TYPE_DONE	0x00
52 #define INFOHDR_TYPE_SYSINFO	0x01
53 #define INFOHDR_TYPE_PMCINFO	0x02
54 #define INFOHDR_TYPE_CPUID	0x03
55 
56 struct pmchdr_infohdr
57 {
58 	uint8_t		type;
59 	uint8_t		reserved0;
60 	uint16_t	length;
61 	uint32_t	_reserved1;
62 };
63 
64 struct pmchdr_sysinfo
65 {
66 	char		cpumodel[64];
67 	char		osrelease[64];
68 	char		buildid[64];
69 };
70 
71 struct pmchdr_pmcinfo
72 {
73 	uint64_t	rate;
74 	char		pmc[];
75 };
76 
77 struct pmchdr_cpuidinfo
78 {
79 	uint32_t	cpuid[];
80 };
81 
82 #endif
83 
84