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
171
172
173
174
|
/*
* 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_EVENT_QUEUE_H
#define PT_EVENT_QUEUE_H
#include "intel-pt.h"
#include <stdint.h>
/* Events are grouped by the packet the event binds to. */
enum pt_event_binding {
evb_psbend = 1 << 0,
evb_tip = 1 << 1,
evb_fup = 1 << 2,
evb_fup_bound = 1 << 3,
evb_exstop = 1 << 4,
evb_cfe = 1 << 5,
};
enum {
/* The maximal number of pending events - should be a power of two. */
evq_max = 16
};
/* An event queue entry. */
struct pt_evq_entry {
/* The event. */
struct pt_event event;
/* The event binding as a bit vector of enum pt_event_binding. */
uint32_t binding;
};
/* A queue of events. */
struct pt_event_queue {
/* A fixed-sized array of event queue entries. */
struct pt_evq_entry queue[evq_max];
/* The begin and end index for the above event queue. */
uint8_t begin;
uint8_t end;
/* A standalone event to be published immediately. */
struct pt_event standalone;
};
/* Initialize (or reset) an event queue. */
extern void pt_evq_init(struct pt_event_queue *);
/* Get a standalone event.
*
* Returns a pointer to the standalone event on success.
* Returns NULL if @evq is NULL.
*/
extern struct pt_event *pt_evq_standalone(struct pt_event_queue *evq);
/* Enqueue an event.
*
* Adds a new event to @evq for binding @evb.
*
* Returns a pointer to the new event on success.
* Returns NULL if @evq is NULL or @evb is invalid.
* Returns NULL if @evq is full.
*/
extern struct pt_event *pt_evq_enqueue(struct pt_event_queue *evq,
uint32_t evb);
/* Dequeue an event.
*
* Removes the first event for binding @evb from @evq.
*
* Returns a pointer to the dequeued event on success.
* Returns NULL if @evq is NULL or @evb is invalid.
* Returns NULL if @evq is empty.
*/
extern struct pt_event *pt_evq_dequeue(struct pt_event_queue *evq,
uint32_t evb);
/* Requeue an event.
*
* Adds @ev to @evq for binding @evb, where @ev must be a recently dequeued or
* standalone event of @evq.
*
* Returns a pointer to the event on success.
* Returns NULL if @evq or @ev is NULL or @evb is invalid.
* Returns NULL if @evq is full.
*/
extern struct pt_event *pt_evq_requeue(struct pt_event_queue *evq,
struct pt_event *ev,
uint32_t evb);
/* Clear a queue and discard events.
*
* Removes all events from @evq.
*
* Returns zero on success, a negative error code otherwise.
* Returns -pte_internal if @evq is NULL or @evb is invalid.
*/
extern int pt_evq_clear(struct pt_event_queue *evq);
/* Check for emptiness.
*
* Check if @evq for binding @evb is empty.
*
* Returns a positive number if @evq is empty.
* Returns zero if @evq is not empty.
* Returns -pte_internal if @evq is NULL or @evb is invalid.
*/
extern int pt_evq_empty(const struct pt_event_queue *evq, uint32_t evb);
/* Check for non-emptiness.
*
* Check if @evq for binding @evb contains pending events.
*
* Returns a positive number if @evq is not empty.
* Returns zero if @evq is empty.
* Returns -pte_internal if @evq is NULL or @evb is invalid.
*/
extern int pt_evq_pending(const struct pt_event_queue *evq, uint32_t evb);
/* Find an event by type.
*
* Searches @evq for an event of type @evt with binding @evb.
*
* Returns a pointer to the first matching event on success.
* Returns NULL if there is no such event.
* Returns NULL if @evq is NULL.
* Returns NULL if @evb or @evt is invalid.
*/
extern struct pt_event *pt_evq_find(struct pt_event_queue *evq, uint32_t evb,
enum pt_event_type evt);
/* Find an event by binding.
*
* Searches @evq for an event with binding @evb.
*
* Returns a pointer to the first matching event on success.
* Returns NULL if there is no such event.
* Returns NULL if @evq is NULL.
* Returns NULL if @evb is invalid.
*/
extern struct pt_event *pt_evq_peek(struct pt_event_queue *evq, uint32_t evb);
#endif /* PT_EVENT_QUEUE_H */
|
