1 /* Target waitstatus definitions and prototypes.
2 
3    Copyright (C) 1990-2020 Free Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
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.
11 
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.
16 
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/>.  */
19 
20 #ifndef TARGET_WAITSTATUS_H
21 #define TARGET_WAITSTATUS_H
22 
23 #include "gdbsupport/gdb_signals.h"
24 
25 /* Stuff for target_wait.  */
26 
27 /* Generally, what has the program done?  */
28 enum target_waitkind
29 {
30   /* The program has exited.  The exit status is in value.integer.  */
31   TARGET_WAITKIND_EXITED,
32 
33   /* The program has stopped with a signal.  Which signal is in
34      value.sig.  */
35   TARGET_WAITKIND_STOPPED,
36 
37   /* The program has terminated with a signal.  Which signal is in
38      value.sig.  */
39   TARGET_WAITKIND_SIGNALLED,
40 
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,
44 
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,
49 
50   /* The program has vforked.  A "related" process's PTID is in
51      value.related_pid.  */
52   TARGET_WAITKIND_VFORKED,
53 
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,
57 
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,
66 
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
70      value.syscall_id.  */
71   TARGET_WAITKIND_SYSCALL_ENTRY,
72   TARGET_WAITKIND_SYSCALL_RETURN,
73 
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,
78 
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,
89 
90   /* The target has run out of history information,
91      and cannot run backward any further.  */
92   TARGET_WAITKIND_NO_HISTORY,
93 
94   /* There are no resumed children left in the program.  */
95   TARGET_WAITKIND_NO_RESUMED,
96 
97   /* The thread was created.  */
98   TARGET_WAITKIND_THREAD_CREATED,
99 
100   /* The thread has exited.  The exit status is in value.integer.  */
101   TARGET_WAITKIND_THREAD_EXITED,
102 };
103 
104 struct target_waitstatus
105 {
106   enum target_waitkind kind;
107 
108   /* Additional information about the event.  */
109   union
110     {
111       /* Exit status */
112       int integer;
113       /* Signal number */
114       enum gdb_signal sig;
115       /* Forked child pid */
116       ptid_t related_pid;
117       /* execd pathname */
118       char *execd_pathname;
119       /* Syscall number */
120       int syscall_number;
121     } value;
122 };
123 
124 /* Extended reasons that can explain why a target/thread stopped for a
125    trap signal.  */
126 
127 enum target_stop_reason
128 {
129   /* Either not stopped, or stopped for a reason that doesn't require
130      special tracking.  */
131   TARGET_STOPPED_BY_NO_REASON,
132 
133   /* Stopped by a software breakpoint.  */
134   TARGET_STOPPED_BY_SW_BREAKPOINT,
135 
136   /* Stopped by a hardware breakpoint.  */
137   TARGET_STOPPED_BY_HW_BREAKPOINT,
138 
139   /* Stopped by a watchpoint.  */
140   TARGET_STOPPED_BY_WATCHPOINT,
141 
142   /* Stopped by a single step finishing.  */
143   TARGET_STOPPED_BY_SINGLE_STEP
144 };
145 
146 /* Prototypes */
147 
148 /* Return a pretty printed form of target_waitstatus.  */
149 std::string target_waitstatus_to_string (const struct target_waitstatus *);
150 
151 #endif /* TARGET_WAITSTATUS_H */
152