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
|
/* Remote notification in GDB protocol
Copyright (C) 1988-2023 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef REMOTE_NOTIF_H
#define REMOTE_NOTIF_H
#include <list>
#include <memory>
/* An event of a type of async remote notification. */
struct notif_event
{
virtual ~notif_event ()
{
}
};
/* A unique pointer holding a notif_event. */
typedef std::unique_ptr<notif_event> notif_event_up;
/* ID of the notif_client. */
enum REMOTE_NOTIF_ID
{
REMOTE_NOTIF_STOP = 0,
REMOTE_NOTIF_LAST,
};
struct remote_target;
/* A client to a sort of async remote notification. */
struct notif_client
{
/* The name of notification packet. */
const char *name;
/* The packet to acknowledge a previous reply. */
const char *ack_command;
/* Parse BUF to get the expected event and update EVENT. This
function may throw exception if contents in BUF is not the
expected event. */
void (*parse) (remote_target *remote,
const notif_client *self, const char *buf,
struct notif_event *event);
/* Send field <ack_command> to remote, and do some checking. If
something wrong, throw an exception. */
void (*ack) (remote_target *remote,
const notif_client *self, const char *buf,
notif_event_up event);
/* Check this notification client can get pending events in
'remote_notif_process'. */
int (*can_get_pending_events) (remote_target *remote,
const notif_client *self);
/* Allocate an event. */
notif_event_up (*alloc_event) ();
/* Id of this notif_client. */
const enum REMOTE_NOTIF_ID id;
};
/* State on remote async notification. */
struct remote_notif_state
{
remote_notif_state () = default;
~remote_notif_state ();
DISABLE_COPY_AND_ASSIGN (remote_notif_state);
/* The remote target. */
remote_target *remote;
/* Notification queue. */
std::list<const notif_client *> notif_queue;
/* Asynchronous signal handle registered as event loop source for when
the remote sent us a notification. The registered callback
will do a ACK sequence to pull the rest of the events out of
the remote side into our event queue. */
struct async_event_handler *get_pending_events_token;
/* One pending event for each notification client. This is where we
keep it until it is acknowledged. When there is a notification
packet, parse it, and create an object of 'struct notif_event' to
assign to it. This field is unchanged until GDB starts to ack
this notification (which is done by
remote.c:remote_notif_pending_replies). */
notif_event_up pending_event[REMOTE_NOTIF_LAST];
};
void remote_notif_ack (remote_target *remote, const notif_client *nc,
const char *buf);
notif_event_up remote_notif_parse (remote_target *remote,
const notif_client *nc,
const char *buf);
void handle_notification (struct remote_notif_state *notif_state,
const char *buf);
void remote_notif_process (struct remote_notif_state *state,
const notif_client *except);
remote_notif_state *remote_notif_state_allocate (remote_target *remote);
extern const notif_client notif_client_stop;
extern bool notif_debug;
#endif /* REMOTE_NOTIF_H */
|
