Commit | Line | Data |
---|---|---|
60250e8b AC |
1 | /* Exception (throw catch) mechanism, for GDB, the GNU debugger. |
2 | ||
32d0add0 | 3 | Copyright (C) 1986-2015 Free Software Foundation, Inc. |
60250e8b AC |
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 | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
60250e8b AC |
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 | |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
60250e8b AC |
19 | |
20 | #include "defs.h" | |
21 | #include "exceptions.h" | |
60250e8b AC |
22 | #include "breakpoint.h" |
23 | #include "target.h" | |
24 | #include "inferior.h" | |
25 | #include "annotate.h" | |
26 | #include "ui-out.h" | |
e06e2353 | 27 | #include "serial.h" |
347bddb7 | 28 | #include "gdbthread.h" |
60250e8b | 29 | |
c25c4a8b | 30 | void |
ff55e1b5 | 31 | prepare_to_throw_exception (void) |
60250e8b | 32 | { |
522002f9 | 33 | clear_quit_flag (); |
60250e8b | 34 | immediate_quit = 0; |
2a78bfb5 AC |
35 | } |
36 | ||
6b1b7650 | 37 | static void |
c6da7a6d | 38 | print_flush (void) |
6b1b7650 | 39 | { |
e06e2353 AC |
40 | struct serial *gdb_stdout_serial; |
41 | ||
c6da7a6d AC |
42 | if (deprecated_error_begin_hook) |
43 | deprecated_error_begin_hook (); | |
5df43998 GB |
44 | |
45 | if (target_supports_terminal_ours ()) | |
46 | target_terminal_ours (); | |
e06e2353 AC |
47 | |
48 | /* We want all output to appear now, before we print the error. We | |
49 | have 3 levels of buffering we have to flush (it's possible that | |
50 | some of these should be changed to flush the lower-level ones | |
51 | too): */ | |
52 | ||
53 | /* 1. The _filtered buffer. */ | |
5df43998 GB |
54 | if (filtered_printing_initialized ()) |
55 | wrap_here (""); | |
e06e2353 AC |
56 | |
57 | /* 2. The stdio buffer. */ | |
c6da7a6d | 58 | gdb_flush (gdb_stdout); |
e06e2353 AC |
59 | gdb_flush (gdb_stderr); |
60 | ||
61 | /* 3. The system-level buffer. */ | |
62 | gdb_stdout_serial = serial_fdopen (1); | |
cade9e54 PB |
63 | if (gdb_stdout_serial) |
64 | { | |
65 | serial_drain_output (gdb_stdout_serial); | |
66 | serial_un_fdopen (gdb_stdout_serial); | |
67 | } | |
e06e2353 | 68 | |
c6da7a6d | 69 | annotate_error_begin (); |
6b1b7650 AC |
70 | } |
71 | ||
9cbc821d | 72 | static void |
71fff37b | 73 | print_exception (struct ui_file *file, struct gdb_exception e) |
9cbc821d AC |
74 | { |
75 | /* KLUGE: cagney/2005-01-13: Write the string out one line at a time | |
76 | as that way the MI's behavior is preserved. */ | |
77 | const char *start; | |
78 | const char *end; | |
d7f9d729 | 79 | |
9cbc821d AC |
80 | for (start = e.message; start != NULL; start = end) |
81 | { | |
82 | end = strchr (start, '\n'); | |
83 | if (end == NULL) | |
84 | fputs_filtered (start, file); | |
85 | else | |
86 | { | |
87 | end++; | |
88 | ui_file_write (file, start, end - start); | |
89 | } | |
90 | } | |
c6da7a6d | 91 | fprintf_filtered (file, "\n"); |
e48f5bee AC |
92 | |
93 | /* Now append the annotation. */ | |
94 | switch (e.reason) | |
95 | { | |
96 | case RETURN_QUIT: | |
97 | annotate_quit (); | |
98 | break; | |
99 | case RETURN_ERROR: | |
100 | /* Assume that these are all errors. */ | |
101 | annotate_error (); | |
102 | break; | |
103 | default: | |
104 | internal_error (__FILE__, __LINE__, _("Bad switch.")); | |
105 | } | |
9cbc821d AC |
106 | } |
107 | ||
8a076db9 | 108 | void |
71fff37b | 109 | exception_print (struct ui_file *file, struct gdb_exception e) |
8a076db9 AC |
110 | { |
111 | if (e.reason < 0 && e.message != NULL) | |
112 | { | |
c6da7a6d | 113 | print_flush (); |
9cbc821d | 114 | print_exception (file, e); |
9cbc821d AC |
115 | } |
116 | } | |
8a076db9 | 117 | |
9cbc821d | 118 | void |
71fff37b | 119 | exception_fprintf (struct ui_file *file, struct gdb_exception e, |
9cbc821d AC |
120 | const char *prefix, ...) |
121 | { | |
122 | if (e.reason < 0 && e.message != NULL) | |
123 | { | |
124 | va_list args; | |
c6da7a6d AC |
125 | |
126 | print_flush (); | |
9cbc821d AC |
127 | |
128 | /* Print the prefix. */ | |
129 | va_start (args, prefix); | |
130 | vfprintf_filtered (file, prefix, args); | |
131 | va_end (args); | |
132 | ||
133 | print_exception (file, e); | |
8a076db9 AC |
134 | } |
135 | } | |
136 | ||
787274f0 DE |
137 | /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception |
138 | handler. If an exception (enum return_reason) is thrown using | |
139 | throw_exception() than all cleanups installed since | |
140 | catch_exceptions() was entered are invoked, the (-ve) exception | |
141 | value is then returned by catch_exceptions. If FUNC() returns | |
142 | normally (with a positive or zero return value) then that value is | |
143 | returned by catch_exceptions(). It is an internal_error() for | |
144 | FUNC() to return a negative value. | |
145 | ||
146 | See exceptions.h for further usage details. | |
60250e8b AC |
147 | |
148 | Must not be called with immediate_quit in effect (bad things might | |
149 | happen, say we got a signal in the middle of a memcpy to quit_return). | |
150 | This is an OK restriction; with very few exceptions immediate_quit can | |
787274f0 | 151 | be replaced by judicious use of QUIT. */ |
60250e8b AC |
152 | |
153 | /* MAYBE: cagney/1999-11-05: catch_errors() in conjunction with | |
7a9dd1b2 | 154 | error() et al. could maintain a set of flags that indicate the |
60250e8b AC |
155 | current state of each of the longjmp buffers. This would give the |
156 | longjmp code the chance to detect a longjmp botch (before it gets | |
157 | to longjmperror()). Prior to 1999-11-05 this wasn't possible as | |
158 | code also randomly used a SET_TOP_LEVEL macro that directly | |
0963b4bd | 159 | initialized the longjmp buffers. */ |
60250e8b | 160 | |
60250e8b AC |
161 | int |
162 | catch_exceptions (struct ui_out *uiout, | |
163 | catch_exceptions_ftype *func, | |
164 | void *func_args, | |
60250e8b AC |
165 | return_mask mask) |
166 | { | |
1c3c7ee7 | 167 | return catch_exceptions_with_msg (uiout, func, func_args, NULL, mask); |
60250e8b AC |
168 | } |
169 | ||
170 | int | |
f9679975 | 171 | catch_exceptions_with_msg (struct ui_out *func_uiout, |
60250e8b AC |
172 | catch_exceptions_ftype *func, |
173 | void *func_args, | |
60250e8b AC |
174 | char **gdberrmsg, |
175 | return_mask mask) | |
176 | { | |
71fff37b | 177 | volatile struct gdb_exception exception; |
2a78bfb5 | 178 | volatile int val = 0; |
f9679975 | 179 | struct ui_out *saved_uiout; |
d7f9d729 | 180 | |
f9679975 | 181 | /* Save and override the global ``struct ui_out'' builder. */ |
79a45e25 PA |
182 | saved_uiout = current_uiout; |
183 | current_uiout = func_uiout; | |
f9679975 PA |
184 | |
185 | TRY_CATCH (exception, RETURN_MASK_ALL) | |
6941d02a | 186 | { |
79a45e25 | 187 | val = (*func) (current_uiout, func_args); |
6941d02a | 188 | } |
f9679975 PA |
189 | |
190 | /* Restore the global builder. */ | |
79a45e25 | 191 | current_uiout = saved_uiout; |
f9679975 PA |
192 | |
193 | if (exception.reason < 0 && (mask & RETURN_MASK (exception.reason)) == 0) | |
194 | { | |
195 | /* The caller didn't request that the event be caught. | |
196 | Rethrow. */ | |
197 | throw_exception (exception); | |
198 | } | |
199 | ||
feefc97b | 200 | exception_print (gdb_stderr, exception); |
60250e8b | 201 | gdb_assert (val >= 0); |
2a78bfb5 AC |
202 | gdb_assert (exception.reason <= 0); |
203 | if (exception.reason < 0) | |
204 | { | |
205 | /* If caller wants a copy of the low-level error message, make | |
206 | one. This is used in the case of a silent error whereby the | |
207 | caller may optionally want to issue the message. */ | |
208 | if (gdberrmsg != NULL) | |
6b1b7650 AC |
209 | { |
210 | if (exception.message != NULL) | |
211 | *gdberrmsg = xstrdup (exception.message); | |
212 | else | |
213 | *gdberrmsg = NULL; | |
214 | } | |
2a78bfb5 AC |
215 | return exception.reason; |
216 | } | |
60250e8b AC |
217 | return val; |
218 | } | |
219 | ||
787274f0 DE |
220 | /* This function is superseded by catch_exceptions(). */ |
221 | ||
60250e8b AC |
222 | int |
223 | catch_errors (catch_errors_ftype *func, void *func_args, char *errstring, | |
224 | return_mask mask) | |
225 | { | |
2a78bfb5 | 226 | volatile int val = 0; |
71fff37b | 227 | volatile struct gdb_exception exception; |
f9679975 | 228 | struct ui_out *saved_uiout; |
d7f9d729 | 229 | |
f9679975 | 230 | /* Save the global ``struct ui_out'' builder. */ |
79a45e25 | 231 | saved_uiout = current_uiout; |
f9679975 PA |
232 | |
233 | TRY_CATCH (exception, RETURN_MASK_ALL) | |
6941d02a AC |
234 | { |
235 | val = func (func_args); | |
236 | } | |
f9679975 PA |
237 | |
238 | /* Restore the global builder. */ | |
79a45e25 | 239 | current_uiout = saved_uiout; |
f9679975 PA |
240 | |
241 | if (exception.reason < 0 && (mask & RETURN_MASK (exception.reason)) == 0) | |
242 | { | |
243 | /* The caller didn't request that the event be caught. | |
244 | Rethrow. */ | |
245 | throw_exception (exception); | |
246 | } | |
247 | ||
feefc97b | 248 | exception_fprintf (gdb_stderr, exception, "%s", errstring); |
2a78bfb5 | 249 | if (exception.reason != 0) |
60250e8b AC |
250 | return 0; |
251 | return val; | |
252 | } |