1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
/*
* Copyright (c) 2018-2025, Intel Corporation
* SPDX-License-Identifier: BSD-3-Clause
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* * Neither the name of Intel Corporation nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef PT_EVENT_DECODER_H
#define PT_EVENT_DECODER_H
#include "pt_packet_decoder.h"
#include "pt_event_queue.h"
#include "pt_last_ip.h"
#include "pt_time.h"
#include "intel-pt.h"
/* An Intel PT event decoder.
*
* It decodes sequences of Intel PT packets into events.
*/
struct pt_event_decoder {
/* The Intel PT packet decoder. */
struct pt_packet_decoder pacdec;
/* The configuration flags.
*
* Those are our flags set by the user. In @pacdec.config.flags, we
* set the flags we need for the packet decoder.
*/
struct pt_conf_flags flags;
/* The current packet to be processed.
*
* This will be valid as long as there are packets available. It will
* be of type ppt_invalid when the packet decoder returned an error
* (which will be stored in @status).
*
* The decoder starts by reading the first packet after synchronizing
* onto the trace stream.
*
* When it is done processing a packet, it fetches the next packet for
* the next iteration.
*/
struct pt_packet packet;
/* The last-ip. */
struct pt_last_ip ip;
/* Timing information. */
struct pt_time time;
/* Timing calibration. */
struct pt_time_cal tcal;
/* Pending (incomplete) events. */
struct pt_event_queue evq;
/* The current event. */
struct pt_event *event;
/* The last status of the packet decoder.
*
* It will be zero most of the time. Since we fetch new packets at the
* end of an iteration, we need to store the status until the next
* pt_evt_next() call.
*/
int status;
/* The current mode.exec state.
*
* This is updated when processing mode.exec packets and it is used for
* mapping mode.exec packets to events depending on which part of the
* state changed.
*
* Since we use only one bit for each piece, we need a separate valid
* flag. The below mode.exec state bits are only valid if
* @mode_exec_valid is set.
*/
unsigned int mode_exec_valid:1;
unsigned int iflag:1;
unsigned int csd:1;
unsigned int csl:1;
/* A collection of flags saying whether:
*
* - tracing is enabled.
*/
unsigned int enabled:1;
/* - the current packet is already bound and must not be interpreted as
* standalone packet once events have been processed.
*/
unsigned int bound:1;
};
/* A special, internal-only event type used for binding packets without
* generating an event.
*
* We alias the tick event since compilers diagnose values outside of the
* enumerated type in switch statements and we want to keep compilers to
* diagnose unhandled cases, which is guarded by the same compiler option.
*
* The tick event is synthesized by higher-level decoders and does not appear
* on event level.
*/
#define ptev_ignore ptev_tick
/* Initialize the event decoder.
*
* Returns zero on success, a negative error code otherwise.
*/
extern int pt_evt_decoder_init(struct pt_event_decoder *decoder,
const struct pt_config *config);
/* Finalize the event decoder. */
extern void pt_evt_decoder_fini(struct pt_event_decoder *decoder);
static inline const struct pt_config *
pt_evt_config(const struct pt_event_decoder *decoder)
{
if (!decoder)
return NULL;
return pt_pkt_config(&decoder->pacdec);
}
static inline const uint8_t *pt_evt_pos(const struct pt_event_decoder *decoder)
{
if (!decoder)
return NULL;
return pt_pkt_pos(&decoder->pacdec);
}
static inline const uint8_t *pt_evt_end(const struct pt_event_decoder *decoder)
{
const struct pt_config *config;
config = pt_evt_config(decoder);
if (!config)
return NULL;
return config->end;
}
#endif /* PT_EVENT_DECODER_H */
|
