1 /* Target waitstatus definitions and prototypes.
3 Copyright (C) 1990-2021 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #ifndef TARGET_WAITSTATUS_H
21 #define TARGET_WAITSTATUS_H
23 #include "gdbsupport/gdb_signals.h"
25 /* Stuff for target_wait. */
27 /* Generally, what has the program done? */
30 /* The program has exited. The exit status is in value.integer. */
31 TARGET_WAITKIND_EXITED
,
33 /* The program has stopped with a signal. Which signal is in
35 TARGET_WAITKIND_STOPPED
,
37 /* The program has terminated with a signal. Which signal is in
39 TARGET_WAITKIND_SIGNALLED
,
41 /* The program is letting us know that it dynamically loaded
42 something (e.g. it called load(2) on AIX). */
43 TARGET_WAITKIND_LOADED
,
45 /* The program has forked. A "related" process' PTID is in
46 value.related_pid. I.e., if the child forks, value.related_pid
47 is the parent's ID. */
48 TARGET_WAITKIND_FORKED
,
50 /* The program has vforked. A "related" process's PTID is in
52 TARGET_WAITKIND_VFORKED
,
54 /* The program has exec'ed a new executable file. The new file's
55 pathname is pointed to by value.execd_pathname. */
56 TARGET_WAITKIND_EXECD
,
58 /* The program had previously vforked, and now the child is done
59 with the shared memory region, because it exec'ed or exited.
60 Note that the event is reported to the vfork parent. This is
61 only used if GDB did not stay attached to the vfork child,
62 otherwise, a TARGET_WAITKIND_EXECD or
63 TARGET_WAITKIND_EXIT|SIGNALLED event associated with the child
64 has the same effect. */
65 TARGET_WAITKIND_VFORK_DONE
,
67 /* The program has entered or returned from a system call. On
68 HP-UX, this is used in the hardware watchpoint implementation.
69 The syscall's unique integer ID number is in
71 TARGET_WAITKIND_SYSCALL_ENTRY
,
72 TARGET_WAITKIND_SYSCALL_RETURN
,
74 /* Nothing happened, but we stopped anyway. This perhaps should
75 be handled within target_wait, but I'm not sure target_wait
76 should be resuming the inferior. */
77 TARGET_WAITKIND_SPURIOUS
,
79 /* An event has occured, but we should wait again.
80 Remote_async_wait() returns this when there is an event
81 on the inferior, but the rest of the world is not interested in
82 it. The inferior has not stopped, but has just sent some output
83 to the console, for instance. In this case, we want to go back
84 to the event loop and wait there for another event from the
85 inferior, rather than being stuck in the remote_async_wait()
86 function. This way the event loop is responsive to other events,
87 like for instance the user typing. */
88 TARGET_WAITKIND_IGNORE
,
90 /* The target has run out of history information,
91 and cannot run backward any further. */
92 TARGET_WAITKIND_NO_HISTORY
,
94 /* There are no resumed children left in the program. */
95 TARGET_WAITKIND_NO_RESUMED
,
97 /* The thread was created. */
98 TARGET_WAITKIND_THREAD_CREATED
,
100 /* The thread has exited. The exit status is in value.integer. */
101 TARGET_WAITKIND_THREAD_EXITED
,
104 struct target_waitstatus
106 /* Default constructor. */
107 target_waitstatus () = default;
109 /* Copy constructor. */
111 target_waitstatus (const target_waitstatus
&other
)
113 m_kind
= other
.m_kind
;
114 m_value
= other
.m_value
;
116 if (m_kind
== TARGET_WAITKIND_EXECD
)
117 m_value
.execd_pathname
= xstrdup (m_value
.execd_pathname
);
120 /* Move constructor. */
122 target_waitstatus (target_waitstatus
&&other
)
124 m_kind
= other
.m_kind
;
125 m_value
= other
.m_value
;
127 if (m_kind
== TARGET_WAITKIND_EXECD
)
128 other
.m_value
.execd_pathname
= nullptr;
133 /* Copy assignment operator. */
135 target_waitstatus
&operator= (const target_waitstatus
&rhs
)
139 m_value
= rhs
.m_value
;
141 if (m_kind
== TARGET_WAITKIND_EXECD
)
142 m_value
.execd_pathname
= xstrdup (m_value
.execd_pathname
);
147 /* Move assignment operator. */
149 target_waitstatus
&operator= (target_waitstatus
&&rhs
)
153 m_value
= rhs
.m_value
;
155 if (m_kind
== TARGET_WAITKIND_EXECD
)
156 rhs
.m_value
.execd_pathname
= nullptr;
165 ~target_waitstatus ()
170 /* Setters: set the wait status kind plus any associated data. */
172 void set_exited (int exit_status
)
175 m_kind
= TARGET_WAITKIND_EXITED
;
176 m_value
.exit_status
= exit_status
;
179 void set_stopped (gdb_signal sig
)
182 m_kind
= TARGET_WAITKIND_STOPPED
;
186 void set_signalled (gdb_signal sig
)
189 m_kind
= TARGET_WAITKIND_SIGNALLED
;
196 m_kind
= TARGET_WAITKIND_LOADED
;
199 void set_forked (ptid_t child_ptid
)
202 m_kind
= TARGET_WAITKIND_FORKED
;
203 m_value
.child_ptid
= child_ptid
;
206 void set_vforked (ptid_t child_ptid
)
209 m_kind
= TARGET_WAITKIND_VFORKED
;
210 m_value
.child_ptid
= child_ptid
;
213 void set_execd (gdb::unique_xmalloc_ptr
<char> execd_pathname
)
216 m_kind
= TARGET_WAITKIND_EXECD
;
217 m_value
.execd_pathname
= execd_pathname
.release ();
220 void set_vfork_done ()
223 m_kind
= TARGET_WAITKIND_VFORK_DONE
;
226 void set_syscall_entry (int syscall_number
)
229 m_kind
= TARGET_WAITKIND_SYSCALL_ENTRY
;
230 m_value
.syscall_number
= syscall_number
;
233 void set_syscall_return (int syscall_number
)
236 m_kind
= TARGET_WAITKIND_SYSCALL_RETURN
;
237 m_value
.syscall_number
= syscall_number
;
243 m_kind
= TARGET_WAITKIND_SPURIOUS
;
249 m_kind
= TARGET_WAITKIND_IGNORE
;
252 void set_no_history ()
255 m_kind
= TARGET_WAITKIND_NO_HISTORY
;
258 void set_no_resumed ()
261 m_kind
= TARGET_WAITKIND_NO_RESUMED
;
264 void set_thread_created ()
267 m_kind
= TARGET_WAITKIND_THREAD_CREATED
;
270 void set_thread_exited (int exit_status
)
273 m_kind
= TARGET_WAITKIND_THREAD_EXITED
;
274 m_value
.exit_status
= exit_status
;
277 /* Get the kind of this wait status. */
279 target_waitkind
kind () const
284 /* Getters for the associated data.
286 Getters can only be used if the wait status is of the appropriate kind.
287 See the setters above or the assertions below to know which data is
288 associated to which kind. */
290 int exit_status () const
292 gdb_assert (m_kind
== TARGET_WAITKIND_EXITED
293 || m_kind
== TARGET_WAITKIND_THREAD_EXITED
);
294 return m_value
.exit_status
;
297 gdb_signal
sig () const
299 gdb_assert (m_kind
== TARGET_WAITKIND_STOPPED
300 || m_kind
== TARGET_WAITKIND_SIGNALLED
);
304 ptid_t
child_ptid () const
306 gdb_assert (m_kind
== TARGET_WAITKIND_FORKED
307 || m_kind
== TARGET_WAITKIND_VFORKED
);
308 return m_value
.child_ptid
;
311 const char *execd_pathname () const
313 gdb_assert (m_kind
== TARGET_WAITKIND_EXECD
);
314 return m_value
.execd_pathname
;
317 int syscall_number () const
319 gdb_assert (m_kind
== TARGET_WAITKIND_SYSCALL_ENTRY
320 || m_kind
== TARGET_WAITKIND_SYSCALL_RETURN
);
321 return m_value
.syscall_number
;
324 /* Return a pretty printed form of target_waitstatus.
326 This is only meant to be used in debug messages, not for user-visible
328 std::string
to_string () const;
331 /* Reset the wait status to its original state. */
334 if (m_kind
== TARGET_WAITKIND_EXECD
)
335 xfree (m_value
.execd_pathname
);
337 m_kind
= TARGET_WAITKIND_IGNORE
;
340 target_waitkind m_kind
= TARGET_WAITKIND_IGNORE
;
342 /* Additional information about the event. */
349 /* Forked child pid */
352 char *execd_pathname
;
358 /* Extended reasons that can explain why a target/thread stopped for a
361 enum target_stop_reason
363 /* Either not stopped, or stopped for a reason that doesn't require
365 TARGET_STOPPED_BY_NO_REASON
,
367 /* Stopped by a software breakpoint. */
368 TARGET_STOPPED_BY_SW_BREAKPOINT
,
370 /* Stopped by a hardware breakpoint. */
371 TARGET_STOPPED_BY_HW_BREAKPOINT
,
373 /* Stopped by a watchpoint. */
374 TARGET_STOPPED_BY_WATCHPOINT
,
376 /* Stopped by a single step finishing. */
377 TARGET_STOPPED_BY_SINGLE_STEP
380 #endif /* TARGET_WAITSTATUS_H */