1 /* Internal interfaces for the Windows code
2 Copyright (C) 1995-2020 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #ifndef NAT_WINDOWS_NAT_H
20 #define NAT_WINDOWS_NAT_H
25 #include "gdbsupport/gdb_optional.h"
26 #include "target/waitstatus.h"
28 #define STATUS_WX86_BREAKPOINT 0x4000001F
29 #define STATUS_WX86_SINGLE_STEP 0x4000001E
34 /* Thread information structure used to track extra information about
36 struct windows_thread_info
38 windows_thread_info (DWORD tid_
, HANDLE h_
, CORE_ADDR tlb
)
41 thread_local_base (tlb
)
45 ~windows_thread_info ();
47 DISABLE_COPY_AND_ASSIGN (windows_thread_info
);
49 /* Ensure that this thread has been suspended. */
52 /* Resume the thread if it has been suspended. */
55 /* The Win32 thread identifier. */
58 /* The handle to the thread. */
61 /* Thread Information Block address. */
62 CORE_ADDR thread_local_base
;
64 /* This keeps track of whether SuspendThread was called on this
65 thread. -1 means there was a failure or that the thread was
66 explicitly not suspended, 1 means it was called, and 0 means it
71 /* The context as retrieved right after suspending the thread. */
72 CONTEXT base_context
{};
75 /* The context of the thread, including any manipulations. */
80 WOW64_CONTEXT wow64_context
;
84 /* Whether debug registers changed since we last set CONTEXT back to
86 bool debug_registers_changed
= false;
88 /* Nonzero if CONTEXT is invalidated and must be re-read from the
90 bool reload_context
= false;
92 /* True if this thread is currently stopped at a software
93 breakpoint. This is used to offset the PC when needed. */
94 bool stopped_at_software_breakpoint
= false;
96 /* True if we've adjusted the PC after hitting a software
97 breakpoint, false otherwise. This lets us avoid multiple
98 adjustments if the registers are read multiple times. */
99 bool pc_adjusted
= false;
101 /* The name of the thread, allocated by xmalloc. */
102 gdb::unique_xmalloc_ptr
<char> name
;
106 /* Possible values to pass to 'thread_rec'. */
107 enum thread_disposition_type
109 /* Do not invalidate the thread's context, and do not suspend the
111 DONT_INVALIDATE_CONTEXT
,
112 /* Invalidate the context, but do not suspend the thread. */
114 /* Invalidate the context and suspend the thread. */
118 /* Find a thread record given a thread id. THREAD_DISPOSITION
119 controls whether the thread is suspended, and whether the context
122 This function must be supplied by the embedding application. */
123 extern windows_thread_info
*thread_rec (ptid_t ptid
,
124 thread_disposition_type disposition
);
127 /* Handle OUTPUT_DEBUG_STRING_EVENT from child process. Updates
128 OURSTATUS and returns the thread id if this represents a thread
129 change (this is specific to Cygwin), otherwise 0.
131 Cygwin prepends its messages with a "cygwin:". Interpret this as
132 a Cygwin signal. Otherwise just print the string as a warning.
134 This function must be supplied by the embedding application. */
135 extern int handle_output_debug_string (struct target_waitstatus
*ourstatus
);
137 /* Handle a DLL load event.
139 This function assumes that the current event did not occur during
140 inferior initialization.
142 This function must be supplied by the embedding application. */
144 extern void handle_load_dll ();
146 /* Handle a DLL unload event.
148 This function assumes that this event did not occur during inferior
151 This function must be supplied by the embedding application. */
153 extern void handle_unload_dll ();
155 /* Handle MS_VC_EXCEPTION when processing a stop. MS_VC_EXCEPTION is
156 somewhat undocumented but is used to tell the debugger the name of
159 Return true if the exception was handled; return false otherwise.
161 This function must be supplied by the embedding application. */
163 extern bool handle_ms_vc_exception (const EXCEPTION_RECORD
*rec
);
165 /* When EXCEPTION_ACCESS_VIOLATION is processed, we give the embedding
166 application a chance to change it to be considered "unhandled".
167 This function must be supplied by the embedding application. If it
168 returns true, then the exception is "unhandled". */
170 extern bool handle_access_violation (const EXCEPTION_RECORD
*rec
);
173 /* Currently executing process */
174 extern HANDLE current_process_handle
;
175 extern DWORD current_process_id
;
176 extern DWORD main_thread_id
;
177 extern enum gdb_signal last_sig
;
179 /* The current debug event from WaitForDebugEvent or from a pending
181 extern DEBUG_EVENT current_event
;
183 /* Info on currently selected thread */
184 extern windows_thread_info
*current_windows_thread
;
186 /* The ID of the thread for which we anticipate a stop event.
187 Normally this is -1, meaning we'll accept an event in any
189 extern DWORD desired_stop_thread_id
;
191 /* A single pending stop. See "pending_stops" for more
198 /* The target waitstatus we computed. */
199 target_waitstatus status
;
201 /* The event. A few fields of this can be referenced after a stop,
202 and it seemed simplest to store the entire event. */
206 /* A vector of pending stops. Sometimes, Windows will report a stop
207 on a thread that has been ostensibly suspended. We believe what
208 happens here is that two threads hit a breakpoint simultaneously,
209 and the Windows kernel queues the stop events. However, this can
210 result in the strange effect of trying to single step thread A --
211 leaving all other threads suspended -- and then seeing a stop in
212 thread B. To handle this scenario, we queue all such "pending"
213 stops here, and then process them once the step has completed. See
215 extern std::vector
<pending_stop
> pending_stops
;
217 /* Contents of $_siginfo */
218 extern EXCEPTION_RECORD siginfo_er
;
221 /* Ignore first breakpoint exception of WOW64 process */
222 extern bool ignore_first_breakpoint
;
225 /* Return the name of the DLL referenced by H at ADDRESS. UNICODE
226 determines what sort of string is read from the inferior. Returns
227 the name of the DLL, or NULL on error. If a name is returned, it
228 is stored in a static buffer which is valid until the next call to
230 extern const char *get_image_name (HANDLE h
, void *address
, int unicode
);
234 HANDLE_EXCEPTION_UNHANDLED
= 0,
235 HANDLE_EXCEPTION_HANDLED
,
236 HANDLE_EXCEPTION_IGNORED
237 } handle_exception_result
;
239 extern handle_exception_result handle_exception
240 (struct target_waitstatus
*ourstatus
, bool debug_exceptions
);
242 /* Return true if there is a pending stop matching
243 desired_stop_thread_id. If DEBUG_EVENTS is true, logging will be
246 extern bool matching_pending_stop (bool debug_events
);
248 /* See if a pending stop matches DESIRED_STOP_THREAD_ID. If so,
249 remove it from the list of pending stops, set 'current_event', and
250 return it. Otherwise, return an empty optional. */
252 extern gdb::optional
<pending_stop
> fetch_pending_stop (bool debug_events
);
254 /* A simple wrapper for ContinueDebugEvent that continues the last
255 waited-for event. If DEBUG_EVENTS is true, logging will be
258 extern BOOL
continue_last_debug_event (DWORD continue_status
,
261 /* A simple wrapper for WaitForDebugEvent that also sets the internal
262 'last_wait_event' on success. */
264 extern BOOL
wait_for_debug_event (DEBUG_EVENT
*event
, DWORD timeout
);