xref: /freebsd/lib/libpmc/pmclog.h (revision 94426d21bf62f2b36dc9b556ab27c401a412a026)
1f263522aSJoseph Koshy /*-
24d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
35e53a4f9SPedro F. Giffuni  *
4c5e73985SJoseph Koshy  * Copyright (c) 2005-2007 Joseph Koshy
5c5e73985SJoseph Koshy  * Copyright (c) 2007 The FreeBSD Foundation
6f263522aSJoseph Koshy  * All rights reserved.
7f263522aSJoseph Koshy  *
8c5e73985SJoseph Koshy  * Portions of this software were developed by A. Joseph Koshy under
9c5e73985SJoseph Koshy  * sponsorship from the FreeBSD Foundation and Google, Inc.
10c5e73985SJoseph Koshy  *
11f263522aSJoseph Koshy  * Redistribution and use in source and binary forms, with or without
12f263522aSJoseph Koshy  * modification, are permitted provided that the following conditions
13f263522aSJoseph Koshy  * are met:
14f263522aSJoseph Koshy  * 1. Redistributions of source code must retain the above copyright
15f263522aSJoseph Koshy  *    notice, this list of conditions and the following disclaimer.
16f263522aSJoseph Koshy  * 2. Redistributions in binary form must reproduce the above copyright
17f263522aSJoseph Koshy  *    notice, this list of conditions and the following disclaimer in the
18f263522aSJoseph Koshy  *    documentation and/or other materials provided with the distribution.
19f263522aSJoseph Koshy  *
20f263522aSJoseph Koshy  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21f263522aSJoseph Koshy  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22f263522aSJoseph Koshy  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23f263522aSJoseph Koshy  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24f263522aSJoseph Koshy  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25f263522aSJoseph Koshy  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26f263522aSJoseph Koshy  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27f263522aSJoseph Koshy  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28f263522aSJoseph Koshy  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29f263522aSJoseph Koshy  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30f263522aSJoseph Koshy  * SUCH DAMAGE.
31f263522aSJoseph Koshy  *
32f263522aSJoseph Koshy  * $FreeBSD$
33f263522aSJoseph Koshy  */
34f263522aSJoseph Koshy 
35f263522aSJoseph Koshy #ifndef	_PMCLOG_H_
36f263522aSJoseph Koshy #define	_PMCLOG_H_
37f263522aSJoseph Koshy 
38c2a3620fSFabien Thomas #include <sys/cdefs.h>
39f263522aSJoseph Koshy #include <sys/pmclog.h>
40f263522aSJoseph Koshy 
41f263522aSJoseph Koshy enum pmclog_state {
42f263522aSJoseph Koshy 	PMCLOG_OK,
43f263522aSJoseph Koshy 	PMCLOG_EOF,
44f263522aSJoseph Koshy 	PMCLOG_REQUIRE_DATA,
45f263522aSJoseph Koshy 	PMCLOG_ERROR
46f263522aSJoseph Koshy };
47f263522aSJoseph Koshy 
48c5e73985SJoseph Koshy struct pmclog_ev_callchain {
49c5e73985SJoseph Koshy 	uint32_t	pl_pid;
500b5dc7f6SMatt Macy 	uint32_t	pl_tid;
51c5e73985SJoseph Koshy 	uint32_t	pl_pmcid;
52c5e73985SJoseph Koshy 	uint32_t	pl_cpuflags;
530b5dc7f6SMatt Macy 	uint32_t	pl_cpuflags2;
54c5e73985SJoseph Koshy 	uint32_t	pl_npc;
55c5e73985SJoseph Koshy 	uintfptr_t	pl_pc[PMC_CALLCHAIN_DEPTH_MAX];
56c5e73985SJoseph Koshy };
57c5e73985SJoseph Koshy 
58f263522aSJoseph Koshy struct pmclog_ev_dropnotify {
59f263522aSJoseph Koshy };
60f263522aSJoseph Koshy 
61f263522aSJoseph Koshy struct pmclog_ev_closelog {
62f263522aSJoseph Koshy };
63f263522aSJoseph Koshy 
64f263522aSJoseph Koshy struct pmclog_ev_initialize {
65f263522aSJoseph Koshy 	uint32_t	pl_version;
66f263522aSJoseph Koshy 	uint32_t	pl_arch;
67f992dd4bSMatt Macy 	uint64_t	pl_tsc_freq;
68f992dd4bSMatt Macy 	struct timespec pl_ts;
6907d80fd8SMatt Macy 	char		pl_cpuid[PATH_MAX];
70f263522aSJoseph Koshy };
71f263522aSJoseph Koshy 
7249874f6eSJoseph Koshy struct pmclog_ev_map_in {
7349874f6eSJoseph Koshy 	pid_t		pl_pid;
7449874f6eSJoseph Koshy 	uintfptr_t	pl_start;
7549874f6eSJoseph Koshy 	char		pl_pathname[PATH_MAX];
7649874f6eSJoseph Koshy };
7749874f6eSJoseph Koshy 
7849874f6eSJoseph Koshy struct pmclog_ev_map_out {
79f263522aSJoseph Koshy 	pid_t		pl_pid;
80f263522aSJoseph Koshy 	uintfptr_t	pl_start;
81f263522aSJoseph Koshy 	uintfptr_t	pl_end;
82f263522aSJoseph Koshy };
83f263522aSJoseph Koshy 
84f263522aSJoseph Koshy struct pmclog_ev_pcsample {
85f263522aSJoseph Koshy 	uintfptr_t	pl_pc;
86f263522aSJoseph Koshy 	pid_t		pl_pid;
870b5dc7f6SMatt Macy 	pid_t		pl_tid;
88f263522aSJoseph Koshy 	pmc_id_t	pl_pmcid;
890b5dc7f6SMatt Macy 	uint32_t	pl_flags;
9015139246SJoseph Koshy 	uint32_t	pl_usermode;
91f263522aSJoseph Koshy };
92f263522aSJoseph Koshy 
93f263522aSJoseph Koshy struct pmclog_ev_pmcallocate {
94f263522aSJoseph Koshy 	const char *	pl_evname;
95b2ca2e50SMatt Macy 	uint64_t	pl_rate;
96b2ca2e50SMatt Macy 	uint32_t	pl_event;
97f263522aSJoseph Koshy 	uint32_t	pl_flags;
98f263522aSJoseph Koshy 	pmc_id_t	pl_pmcid;
99f263522aSJoseph Koshy };
100f263522aSJoseph Koshy 
101f5f9340bSFabien Thomas struct pmclog_ev_pmcallocatedyn {
102f5f9340bSFabien Thomas 	char 		pl_evname[PMC_NAME_MAX];
103b2ca2e50SMatt Macy 	uint32_t	pl_event;
104f5f9340bSFabien Thomas 	uint32_t	pl_flags;
105f5f9340bSFabien Thomas 	pmc_id_t	pl_pmcid;
106f5f9340bSFabien Thomas };
107f5f9340bSFabien Thomas 
108f263522aSJoseph Koshy struct pmclog_ev_pmcattach {
109f263522aSJoseph Koshy 	pmc_id_t	pl_pmcid;
110f263522aSJoseph Koshy 	pid_t		pl_pid;
111f263522aSJoseph Koshy 	char		pl_pathname[PATH_MAX];
112f263522aSJoseph Koshy };
113f263522aSJoseph Koshy 
114f263522aSJoseph Koshy struct pmclog_ev_pmcdetach {
115f263522aSJoseph Koshy 	pmc_id_t	pl_pmcid;
116f263522aSJoseph Koshy 	pid_t		pl_pid;
117f263522aSJoseph Koshy };
118f263522aSJoseph Koshy 
119f263522aSJoseph Koshy struct pmclog_ev_proccsw {
120f263522aSJoseph Koshy 	pid_t		pl_pid;
1210b5dc7f6SMatt Macy 	pid_t		pl_tid;
122f263522aSJoseph Koshy 	pmc_id_t	pl_pmcid;
123f263522aSJoseph Koshy 	pmc_value_t	pl_value;
124f263522aSJoseph Koshy };
125f263522aSJoseph Koshy 
126ebfaf69cSMatt Macy struct pmclog_ev_proccreate {
127ebfaf69cSMatt Macy 	pid_t		pl_pid;
128b2ca2e50SMatt Macy 	uint32_t	pl_flags;
129ebfaf69cSMatt Macy 	char		pl_pcomm[MAXCOMLEN+1];
130ebfaf69cSMatt Macy };
131ebfaf69cSMatt Macy 
132f263522aSJoseph Koshy struct pmclog_ev_procexec {
133f263522aSJoseph Koshy 	pid_t		pl_pid;
13415139246SJoseph Koshy 	pmc_id_t	pl_pmcid;
135*94426d21SJessica Clarke 	uintptr_t	pl_baseaddr;
136*94426d21SJessica Clarke 	uintptr_t	pl_dynaddr;
137f263522aSJoseph Koshy 	char		pl_pathname[PATH_MAX];
138f263522aSJoseph Koshy };
139f263522aSJoseph Koshy 
140f263522aSJoseph Koshy struct pmclog_ev_procexit {
141f263522aSJoseph Koshy 	uint32_t	pl_pid;
142f263522aSJoseph Koshy 	pmc_id_t	pl_pmcid;
143f263522aSJoseph Koshy 	pmc_value_t	pl_value;
144f263522aSJoseph Koshy };
145f263522aSJoseph Koshy 
146f263522aSJoseph Koshy struct pmclog_ev_procfork {
147f263522aSJoseph Koshy 	pid_t		pl_oldpid;
148f263522aSJoseph Koshy 	pid_t		pl_newpid;
149f263522aSJoseph Koshy };
150f263522aSJoseph Koshy 
151f263522aSJoseph Koshy struct pmclog_ev_sysexit {
152f263522aSJoseph Koshy 	pid_t		pl_pid;
153f263522aSJoseph Koshy };
154f263522aSJoseph Koshy 
155ebfaf69cSMatt Macy struct pmclog_ev_threadcreate {
156ebfaf69cSMatt Macy 	pid_t		pl_tid;
157ebfaf69cSMatt Macy 	pid_t		pl_pid;
158b2ca2e50SMatt Macy 	uint32_t	pl_flags;
159ebfaf69cSMatt Macy 	char		pl_tdname[MAXCOMLEN+1];
160ebfaf69cSMatt Macy };
161ebfaf69cSMatt Macy 
162ebfaf69cSMatt Macy struct pmclog_ev_threadexit {
163ebfaf69cSMatt Macy 	pid_t		pl_tid;
164ebfaf69cSMatt Macy };
165ebfaf69cSMatt Macy 
166f263522aSJoseph Koshy struct pmclog_ev_userdata {
167f263522aSJoseph Koshy 	uint32_t	pl_userdata;
168f263522aSJoseph Koshy };
169f263522aSJoseph Koshy 
170f263522aSJoseph Koshy struct pmclog_ev {
171f263522aSJoseph Koshy 	enum pmclog_state pl_state;	/* state after 'get_event()' */
172f263522aSJoseph Koshy 	off_t		  pl_offset;	/* byte offset in stream */
173f263522aSJoseph Koshy 	size_t		  pl_count;	/* count of records so far */
174f263522aSJoseph Koshy 	struct timespec   pl_ts;	/* log entry timestamp */
175f263522aSJoseph Koshy 	enum pmclog_type  pl_type;	/* type of log entry */
176bfb46e2bSMatt Macy 	void		 *pl_data;
177bfb46e2bSMatt Macy 	int		  pl_len;
178f263522aSJoseph Koshy 	union { 			/* log entry data */
179c5e73985SJoseph Koshy 		struct pmclog_ev_callchain	pl_cc;
180f263522aSJoseph Koshy 		struct pmclog_ev_closelog	pl_cl;
181f263522aSJoseph Koshy 		struct pmclog_ev_dropnotify	pl_dn;
182f263522aSJoseph Koshy 		struct pmclog_ev_initialize	pl_i;
18349874f6eSJoseph Koshy 		struct pmclog_ev_map_in		pl_mi;
18449874f6eSJoseph Koshy 		struct pmclog_ev_map_out	pl_mo;
185f263522aSJoseph Koshy 		struct pmclog_ev_pmcallocate	pl_a;
186f5f9340bSFabien Thomas 		struct pmclog_ev_pmcallocatedyn	pl_ad;
187f263522aSJoseph Koshy 		struct pmclog_ev_pmcattach	pl_t;
188f263522aSJoseph Koshy 		struct pmclog_ev_pmcdetach	pl_d;
189f263522aSJoseph Koshy 		struct pmclog_ev_proccsw	pl_c;
190ebfaf69cSMatt Macy 		struct pmclog_ev_proccreate	pl_pc;
191f263522aSJoseph Koshy 		struct pmclog_ev_procexec	pl_x;
192f263522aSJoseph Koshy 		struct pmclog_ev_procexit	pl_e;
193f263522aSJoseph Koshy 		struct pmclog_ev_procfork	pl_f;
194f263522aSJoseph Koshy 		struct pmclog_ev_sysexit	pl_se;
195ebfaf69cSMatt Macy 		struct pmclog_ev_threadcreate	pl_tc;
196ebfaf69cSMatt Macy 		struct pmclog_ev_threadexit	pl_te;
197f263522aSJoseph Koshy 		struct pmclog_ev_userdata	pl_u;
198f263522aSJoseph Koshy 	} pl_u;
199f263522aSJoseph Koshy };
200f263522aSJoseph Koshy 
201bfb46e2bSMatt Macy enum pmclog_parser_state {
202bfb46e2bSMatt Macy 	PL_STATE_NEW_RECORD,		/* in-between records */
203bfb46e2bSMatt Macy 	PL_STATE_EXPECTING_HEADER,	/* header being read */
204bfb46e2bSMatt Macy 	PL_STATE_PARTIAL_RECORD,	/* header present but not the record */
205bfb46e2bSMatt Macy 	PL_STATE_ERROR			/* parsing error encountered */
206bfb46e2bSMatt Macy };
207bfb46e2bSMatt Macy 
208bfb46e2bSMatt Macy struct pmclog_parse_state {
209bfb46e2bSMatt Macy 	enum pmclog_parser_state ps_state;
210bfb46e2bSMatt Macy 	enum pmc_cputype	ps_arch;	/* log file architecture */
211bfb46e2bSMatt Macy 	uint32_t		ps_version;	/* hwpmc version */
212bfb46e2bSMatt Macy 	int			ps_initialized;	/* whether initialized */
213bfb46e2bSMatt Macy 	int			ps_count;	/* count of records processed */
214bfb46e2bSMatt Macy 	off_t			ps_offset;	/* stream byte offset */
215bfb46e2bSMatt Macy 	union pmclog_entry	ps_saved;	/* saved partial log entry */
216bfb46e2bSMatt Macy 	int			ps_svcount;	/* #bytes saved */
217bfb46e2bSMatt Macy 	int			ps_fd;		/* active fd or -1 */
218bfb46e2bSMatt Macy 	char			*ps_buffer;	/* scratch buffer if fd != -1 */
219bfb46e2bSMatt Macy 	char			*ps_data;	/* current parse pointer */
220b2ca2e50SMatt Macy 	char			*ps_cpuid;	/* log cpuid */
221bfb46e2bSMatt Macy 	size_t			ps_len;		/* length of buffered data */
222bfb46e2bSMatt Macy };
223bfb46e2bSMatt Macy 
224f263522aSJoseph Koshy #define	PMCLOG_FD_NONE				(-1)
225f263522aSJoseph Koshy 
226c2a3620fSFabien Thomas __BEGIN_DECLS
227f263522aSJoseph Koshy void	*pmclog_open(int _fd);
228f263522aSJoseph Koshy int	pmclog_feed(void *_cookie, char *_data, int _len);
229f263522aSJoseph Koshy int	pmclog_read(void *_cookie, struct pmclog_ev *_ev);
230f263522aSJoseph Koshy void	pmclog_close(void *_cookie);
231c2a3620fSFabien Thomas __END_DECLS
232f263522aSJoseph Koshy 
233f263522aSJoseph Koshy #endif
234f263522aSJoseph Koshy 
235