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
|
/*
* Copyright (c) 2013-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_INSN_DECODER_H
#define PT_INSN_DECODER_H
#include "pt_query_decoder.h"
#include "pt_image.h"
#include "pt_retstack.h"
#include "pt_ild.h"
#include "pt_msec_cache.h"
#include <inttypes.h>
struct pt_insn_decoder {
/* The Intel(R) Processor Trace query decoder. */
struct pt_query_decoder query;
/* The configuration flags.
*
* Those are our flags set by the user. In @query.config.flags, we set
* the flags we need for the query decoder.
*/
struct pt_conf_flags flags;
/* The default image. */
struct pt_image default_image;
/* The image. */
struct pt_image *image;
/* The current cached section. */
struct pt_msec_cache scache;
/* The current address space. */
struct pt_asid asid;
/* The current Intel(R) Processor Trace event. */
struct pt_event event;
/* The call/return stack for ret compression. */
struct pt_retstack retstack;
/* The current instruction.
*
* This is only valid if @process_insn is set.
*/
struct pt_insn insn;
struct pt_insn_ext iext;
/* The current IP.
*
* If tracing is disabled, this is the IP at which we assume tracing to
* be resumed.
*/
uint64_t ip;
/* The current execution mode. */
enum pt_exec_mode mode;
/* The status of the last successful decoder query.
*
* Errors are reported directly; the status is always a non-negative
* pt_status_flag bit-vector.
*/
int status;
/* A collection of flags defining how to proceed flow reconstruction:
*
* - tracing is enabled.
*/
uint32_t enabled:1;
/* - process @event. */
uint32_t process_event:1;
/* - instructions are executed speculatively. */
uint32_t speculative:1;
/* - process @insn/@iext.
*
* We have started processing events binding to @insn/@iext. We have
* not yet proceeded past it.
*
* We will do so in pt_insn_event() after processing all events that
* bind to it.
*/
uint32_t process_insn:1;
/* - a paging event has already been bound to @insn/@iext. */
uint32_t bound_paging:1;
/* - a vmcs event has already been bound to @insn/@iext. */
uint32_t bound_vmcs:1;
/* - a ptwrite event has already been bound to @insn/@iext. */
uint32_t bound_ptwrite:1;
/* - an iret event has already been bound to @insn/@iext. */
uint32_t bound_iret:1;
/* - a vmentry event has already been bound to @insn/@iext. */
uint32_t bound_vmentry:1;
/* - an uiret event has already been bound to @insn/@iext. */
uint32_t bound_uiret:1;
};
/* Initialize an instruction flow decoder.
*
* Returns zero on success; a negative error code otherwise.
* Returns -pte_internal, if @decoder is NULL.
* Returns -pte_invalid, if @config is NULL.
*/
extern int pt_insn_decoder_init(struct pt_insn_decoder *decoder,
const struct pt_config *config);
/* Finalize an instruction flow decoder. */
extern void pt_insn_decoder_fini(struct pt_insn_decoder *decoder);
static inline const struct pt_config *
pt_insn_config(const struct pt_insn_decoder *decoder)
{
if (!decoder)
return NULL;
return pt_qry_config(&decoder->query);
}
#endif /* PT_INSN_DECODER_H */
|
