]>
Commit | Line | Data |
---|---|---|
04714b91 AC |
1 | /* Perform an inferior function call, for GDB, the GNU debugger. |
2 | ||
213516ef | 3 | Copyright (C) 1986-2023 Free Software Foundation, Inc. |
04714b91 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 |
04714b91 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/>. */ |
04714b91 AC |
19 | |
20 | #include "defs.h" | |
0700e23e | 21 | #include "infcall.h" |
04714b91 | 22 | #include "breakpoint.h" |
573cda03 | 23 | #include "tracepoint.h" |
04714b91 AC |
24 | #include "target.h" |
25 | #include "regcache.h" | |
26 | #include "inferior.h" | |
45741a9c | 27 | #include "infrun.h" |
04714b91 AC |
28 | #include "block.h" |
29 | #include "gdbcore.h" | |
30 | #include "language.h" | |
9ab9195f | 31 | #include "objfiles.h" |
04714b91 AC |
32 | #include "gdbcmd.h" |
33 | #include "command.h" | |
96860204 | 34 | #include "dummy-frame.h" |
a93c0eb6 | 35 | #include "ada-lang.h" |
aa3cfbda | 36 | #include "f-lang.h" |
347bddb7 | 37 | #include "gdbthread.h" |
beb460e8 | 38 | #include "event-top.h" |
76727919 | 39 | #include "observable.h" |
0b333c5e | 40 | #include "top.h" |
13d03262 | 41 | #include "ui.h" |
0b333c5e | 42 | #include "interps.h" |
388a7084 | 43 | #include "thread-fsm.h" |
6ccb583f | 44 | #include <algorithm> |
268a13a5 | 45 | #include "gdbsupport/scope-exit.h" |
099a6354 | 46 | #include <list> |
b89667eb | 47 | |
e4014689 AB |
48 | /* True if we are debugging inferior calls. */ |
49 | ||
50 | static bool debug_infcall = false; | |
51 | ||
52 | /* Print an "infcall" debug statement. */ | |
53 | ||
54 | #define infcall_debug_printf(fmt, ...) \ | |
55 | debug_prefixed_printf_cond (debug_infcall, "infcall", fmt, ##__VA_ARGS__) | |
56 | ||
57 | /* Print "infcall" enter/exit debug statements. */ | |
58 | ||
59 | #define INFCALL_SCOPED_DEBUG_ENTER_EXIT \ | |
60 | scoped_debug_enter_exit (debug_infcall, "infcall") | |
61 | ||
62 | /* Print "infcall" start/end debug statements. */ | |
63 | ||
64 | #define INFCALL_SCOPED_DEBUG_START_END(fmt, ...) \ | |
65 | scoped_debug_start_end (debug_infrun, "infcall", fmt, ##__VA_ARGS__) | |
66 | ||
67 | /* Implement 'show debug infcall'. */ | |
68 | ||
69 | static void | |
70 | show_debug_infcall (struct ui_file *file, int from_tty, | |
71 | struct cmd_list_element *c, const char *value) | |
72 | { | |
73 | gdb_printf (file, _("Inferior call debugging is %s.\n"), value); | |
74 | } | |
75 | ||
b89667eb DE |
76 | /* If we can't find a function's name from its address, |
77 | we print this instead. */ | |
78 | #define RAW_FUNCTION_ADDRESS_FORMAT "at 0x%s" | |
79 | #define RAW_FUNCTION_ADDRESS_SIZE (sizeof (RAW_FUNCTION_ADDRESS_FORMAT) \ | |
dda83cd7 | 80 | + 2 * sizeof (CORE_ADDR)) |
04714b91 AC |
81 | |
82 | /* NOTE: cagney/2003-04-16: What's the future of this code? | |
83 | ||
84 | GDB needs an asynchronous expression evaluator, that means an | |
85 | asynchronous inferior function call implementation, and that in | |
86 | turn means restructuring the code so that it is event driven. */ | |
87 | ||
491144b5 | 88 | static bool may_call_functions_p = true; |
136afab8 PW |
89 | static void |
90 | show_may_call_functions_p (struct ui_file *file, int from_tty, | |
91 | struct cmd_list_element *c, | |
92 | const char *value) | |
93 | { | |
6cb06a8c TT |
94 | gdb_printf (file, |
95 | _("Permission to call functions in the program is %s.\n"), | |
96 | value); | |
136afab8 PW |
97 | } |
98 | ||
04714b91 AC |
99 | /* How you should pass arguments to a function depends on whether it |
100 | was defined in K&R style or prototype style. If you define a | |
101 | function using the K&R syntax that takes a `float' argument, then | |
102 | callers must pass that argument as a `double'. If you define the | |
103 | function using the prototype syntax, then you must pass the | |
104 | argument as a `float', with no promotion. | |
105 | ||
106 | Unfortunately, on certain older platforms, the debug info doesn't | |
107 | indicate reliably how each function was defined. A function type's | |
a9ff5f12 UW |
108 | TYPE_PROTOTYPED flag may be clear, even if the function was defined |
109 | in prototype style. When calling a function whose TYPE_PROTOTYPED | |
110 | flag is clear, GDB consults this flag to decide what to do. | |
04714b91 AC |
111 | |
112 | For modern targets, it is proper to assume that, if the prototype | |
113 | flag is clear, that can be trusted: `float' arguments should be | |
114 | promoted to `double'. For some older targets, if the prototype | |
115 | flag is clear, that doesn't tell us anything. The default is to | |
116 | trust the debug information; the user can override this behavior | |
117 | with "set coerce-float-to-double 0". */ | |
118 | ||
491144b5 | 119 | static bool coerce_float_to_double_p = true; |
920d2a44 AC |
120 | static void |
121 | show_coerce_float_to_double_p (struct ui_file *file, int from_tty, | |
122 | struct cmd_list_element *c, const char *value) | |
123 | { | |
6cb06a8c TT |
124 | gdb_printf (file, |
125 | _("Coercion of floats to doubles " | |
126 | "when calling functions is %s.\n"), | |
127 | value); | |
920d2a44 | 128 | } |
04714b91 AC |
129 | |
130 | /* This boolean tells what gdb should do if a signal is received while | |
131 | in a function called from gdb (call dummy). If set, gdb unwinds | |
132 | the stack and restore the context to what as it was before the | |
133 | call. | |
134 | ||
1777feb0 | 135 | The default is to stop in the frame where the signal was received. */ |
04714b91 | 136 | |
491144b5 | 137 | static bool unwind_on_signal_p = false; |
920d2a44 AC |
138 | static void |
139 | show_unwind_on_signal_p (struct ui_file *file, int from_tty, | |
140 | struct cmd_list_element *c, const char *value) | |
141 | { | |
6cb06a8c TT |
142 | gdb_printf (file, |
143 | _("Unwinding of stack if a signal is " | |
144 | "received while in a call dummy is %s.\n"), | |
145 | value); | |
920d2a44 AC |
146 | } |
147 | ||
7cd1089b PM |
148 | /* This boolean tells what gdb should do if a std::terminate call is |
149 | made while in a function called from gdb (call dummy). | |
150 | As the confines of a single dummy stack prohibit out-of-frame | |
151 | handlers from handling a raised exception, and as out-of-frame | |
152 | handlers are common in C++, this can lead to no handler being found | |
153 | by the unwinder, and a std::terminate call. This is a false positive. | |
154 | If set, gdb unwinds the stack and restores the context to what it | |
155 | was before the call. | |
156 | ||
157 | The default is to unwind the frame if a std::terminate call is | |
158 | made. */ | |
159 | ||
491144b5 | 160 | static bool unwind_on_terminating_exception_p = true; |
7cd1089b PM |
161 | |
162 | static void | |
163 | show_unwind_on_terminating_exception_p (struct ui_file *file, int from_tty, | |
164 | struct cmd_list_element *c, | |
165 | const char *value) | |
166 | ||
167 | { | |
6cb06a8c TT |
168 | gdb_printf (file, |
169 | _("Unwind stack if a C++ exception is " | |
170 | "unhandled while in a call dummy is %s.\n"), | |
171 | value); | |
7cd1089b | 172 | } |
04714b91 AC |
173 | |
174 | /* Perform the standard coercions that are specified | |
aa3cfbda | 175 | for arguments to be passed to C, Ada or Fortran functions. |
04714b91 AC |
176 | |
177 | If PARAM_TYPE is non-NULL, it is the expected parameter type. | |
37055cad | 178 | IS_PROTOTYPED is non-zero if the function declaration is prototyped. */ |
04714b91 AC |
179 | |
180 | static struct value * | |
7788af6d | 181 | value_arg_coerce (struct gdbarch *gdbarch, struct value *arg, |
37055cad | 182 | struct type *param_type, int is_prototyped) |
04714b91 | 183 | { |
7788af6d | 184 | const struct builtin_type *builtin = builtin_type (gdbarch); |
d0c97917 | 185 | struct type *arg_type = check_typedef (arg->type ()); |
52f0bd74 | 186 | struct type *type |
04714b91 AC |
187 | = param_type ? check_typedef (param_type) : arg_type; |
188 | ||
aa3cfbda | 189 | /* Perform any Ada- and Fortran-specific coercion first. */ |
a93c0eb6 | 190 | if (current_language->la_language == language_ada) |
40bc484c | 191 | arg = ada_convert_actual (arg, type); |
aa3cfbda RB |
192 | else if (current_language->la_language == language_fortran) |
193 | type = fortran_preserve_arg_pointer (arg, type); | |
a93c0eb6 | 194 | |
63092375 DJ |
195 | /* Force the value to the target if we will need its address. At |
196 | this point, we could allocate arguments on the stack instead of | |
197 | calling malloc if we knew that their addresses would not be | |
198 | saved by the called function. */ | |
199 | arg = value_coerce_to_target (arg); | |
200 | ||
78134374 | 201 | switch (type->code ()) |
04714b91 AC |
202 | { |
203 | case TYPE_CODE_REF: | |
aa006118 | 204 | case TYPE_CODE_RVALUE_REF: |
fb933624 DJ |
205 | { |
206 | struct value *new_value; | |
207 | ||
aa006118 | 208 | if (TYPE_IS_REFERENCE (arg_type)) |
b1af9e97 | 209 | return value_cast_pointers (type, arg, 0); |
fb933624 DJ |
210 | |
211 | /* Cast the value to the reference's target type, and then | |
212 | convert it back to a reference. This will issue an error | |
213 | if the value was not previously in memory - in some cases | |
214 | we should clearly be allowing this, but how? */ | |
27710edb | 215 | new_value = value_cast (type->target_type (), arg); |
78134374 | 216 | new_value = value_ref (new_value, type->code ()); |
fb933624 DJ |
217 | return new_value; |
218 | } | |
04714b91 AC |
219 | case TYPE_CODE_INT: |
220 | case TYPE_CODE_CHAR: | |
221 | case TYPE_CODE_BOOL: | |
222 | case TYPE_CODE_ENUM: | |
223 | /* If we don't have a prototype, coerce to integer type if necessary. */ | |
224 | if (!is_prototyped) | |
225 | { | |
df86565b | 226 | if (type->length () < builtin->builtin_int->length ()) |
7788af6d | 227 | type = builtin->builtin_int; |
04714b91 AC |
228 | } |
229 | /* Currently all target ABIs require at least the width of an integer | |
dda83cd7 SM |
230 | type for an argument. We may have to conditionalize the following |
231 | type coercion for future targets. */ | |
df86565b | 232 | if (type->length () < builtin->builtin_int->length ()) |
7788af6d | 233 | type = builtin->builtin_int; |
04714b91 AC |
234 | break; |
235 | case TYPE_CODE_FLT: | |
236 | if (!is_prototyped && coerce_float_to_double_p) | |
237 | { | |
df86565b | 238 | if (type->length () < builtin->builtin_double->length ()) |
7788af6d | 239 | type = builtin->builtin_double; |
df86565b | 240 | else if (type->length () > builtin->builtin_double->length ()) |
7788af6d | 241 | type = builtin->builtin_long_double; |
04714b91 AC |
242 | } |
243 | break; | |
244 | case TYPE_CODE_FUNC: | |
245 | type = lookup_pointer_type (type); | |
246 | break; | |
247 | case TYPE_CODE_ARRAY: | |
248 | /* Arrays are coerced to pointers to their first element, unless | |
dda83cd7 SM |
249 | they are vectors, in which case we want to leave them alone, |
250 | because they are passed by value. */ | |
67bd3fd5 | 251 | if (current_language->c_style_arrays_p ()) |
bd63c870 | 252 | if (!type->is_vector ()) |
27710edb | 253 | type = lookup_pointer_type (type->target_type ()); |
04714b91 AC |
254 | break; |
255 | case TYPE_CODE_UNDEF: | |
256 | case TYPE_CODE_PTR: | |
257 | case TYPE_CODE_STRUCT: | |
258 | case TYPE_CODE_UNION: | |
259 | case TYPE_CODE_VOID: | |
260 | case TYPE_CODE_SET: | |
261 | case TYPE_CODE_RANGE: | |
262 | case TYPE_CODE_STRING: | |
04714b91 | 263 | case TYPE_CODE_ERROR: |
0d5de010 DJ |
264 | case TYPE_CODE_MEMBERPTR: |
265 | case TYPE_CODE_METHODPTR: | |
04714b91 AC |
266 | case TYPE_CODE_METHOD: |
267 | case TYPE_CODE_COMPLEX: | |
268 | default: | |
269 | break; | |
270 | } | |
271 | ||
272 | return value_cast (type, arg); | |
273 | } | |
274 | ||
8388016d | 275 | /* See infcall.h. */ |
04714b91 | 276 | |
a9fa03de | 277 | CORE_ADDR |
8388016d PA |
278 | find_function_addr (struct value *function, |
279 | struct type **retval_type, | |
280 | struct type **function_type) | |
04714b91 | 281 | { |
d0c97917 | 282 | struct type *ftype = check_typedef (function->type ()); |
8ee511af | 283 | struct gdbarch *gdbarch = ftype->arch (); |
7788af6d | 284 | struct type *value_type = NULL; |
09b58708 JK |
285 | /* Initialize it just to avoid a GCC false warning. */ |
286 | CORE_ADDR funaddr = 0; | |
04714b91 AC |
287 | |
288 | /* If it's a member function, just look at the function | |
289 | part of it. */ | |
290 | ||
291 | /* Determine address to call. */ | |
78134374 SM |
292 | if (ftype->code () == TYPE_CODE_FUNC |
293 | || ftype->code () == TYPE_CODE_METHOD) | |
9feb2d07 | 294 | funaddr = function->address (); |
78134374 | 295 | else if (ftype->code () == TYPE_CODE_PTR) |
04714b91 AC |
296 | { |
297 | funaddr = value_as_address (function); | |
27710edb | 298 | ftype = check_typedef (ftype->target_type ()); |
78134374 SM |
299 | if (ftype->code () == TYPE_CODE_FUNC |
300 | || ftype->code () == TYPE_CODE_METHOD) | |
328d42d8 SM |
301 | funaddr = gdbarch_convert_from_func_ptr_addr |
302 | (gdbarch, funaddr, current_inferior ()->top_target()); | |
04714b91 | 303 | } |
78134374 SM |
304 | if (ftype->code () == TYPE_CODE_FUNC |
305 | || ftype->code () == TYPE_CODE_METHOD) | |
07be84bf | 306 | { |
0becda7a | 307 | if (ftype->is_gnu_ifunc ()) |
07be84bf | 308 | { |
8388016d | 309 | CORE_ADDR resolver_addr = funaddr; |
07be84bf | 310 | |
8388016d PA |
311 | /* Resolve the ifunc. Note this may call the resolver |
312 | function in the inferior. */ | |
313 | funaddr = gnu_ifunc_resolve_addr (gdbarch, resolver_addr); | |
314 | ||
315 | /* Skip querying the function symbol if no RETVAL_TYPE or | |
316 | FUNCTION_TYPE have been asked for. */ | |
317 | if (retval_type != NULL || function_type != NULL) | |
318 | { | |
319 | type *target_ftype = find_function_type (funaddr); | |
320 | /* If we don't have debug info for the target function, | |
321 | see if we can instead extract the target function's | |
322 | type from the type that the resolver returns. */ | |
323 | if (target_ftype == NULL) | |
324 | target_ftype = find_gnu_ifunc_target_type (resolver_addr); | |
325 | if (target_ftype != NULL) | |
326 | { | |
27710edb | 327 | value_type = check_typedef (target_ftype)->target_type (); |
8388016d PA |
328 | ftype = target_ftype; |
329 | } | |
330 | } | |
07be84bf | 331 | } |
8388016d | 332 | else |
27710edb | 333 | value_type = ftype->target_type (); |
07be84bf | 334 | } |
78134374 | 335 | else if (ftype->code () == TYPE_CODE_INT) |
04714b91 AC |
336 | { |
337 | /* Handle the case of functions lacking debugging info. | |
dda83cd7 | 338 | Their values are characters since their addresses are char. */ |
df86565b | 339 | if (ftype->length () == 1) |
04714b91 AC |
340 | funaddr = value_as_address (value_addr (function)); |
341 | else | |
2bbe3cc1 DJ |
342 | { |
343 | /* Handle function descriptors lacking debug info. */ | |
344 | int found_descriptor = 0; | |
abbb1732 | 345 | |
87bc73ea | 346 | funaddr = 0; /* pacify "gcc -Werror" */ |
736355f2 | 347 | if (function->lval () == lval_memory) |
2bbe3cc1 DJ |
348 | { |
349 | CORE_ADDR nfunaddr; | |
abbb1732 | 350 | |
2bbe3cc1 DJ |
351 | funaddr = value_as_address (value_addr (function)); |
352 | nfunaddr = funaddr; | |
328d42d8 SM |
353 | funaddr = gdbarch_convert_from_func_ptr_addr |
354 | (gdbarch, funaddr, current_inferior ()->top_target ()); | |
2bbe3cc1 DJ |
355 | if (funaddr != nfunaddr) |
356 | found_descriptor = 1; | |
357 | } | |
358 | if (!found_descriptor) | |
359 | /* Handle integer used as address of a function. */ | |
360 | funaddr = (CORE_ADDR) value_as_long (function); | |
361 | } | |
04714b91 AC |
362 | } |
363 | else | |
8a3fe4f8 | 364 | error (_("Invalid data type for function to be called.")); |
04714b91 | 365 | |
7d9b040b RC |
366 | if (retval_type != NULL) |
367 | *retval_type = value_type; | |
8388016d PA |
368 | if (function_type != NULL) |
369 | *function_type = ftype; | |
50810684 | 370 | return funaddr + gdbarch_deprecated_function_start_offset (gdbarch); |
04714b91 AC |
371 | } |
372 | ||
d3712828 AC |
373 | /* For CALL_DUMMY_ON_STACK, push a breakpoint sequence that the called |
374 | function returns to. */ | |
7043d8dc AC |
375 | |
376 | static CORE_ADDR | |
377 | push_dummy_code (struct gdbarch *gdbarch, | |
82585c72 | 378 | CORE_ADDR sp, CORE_ADDR funaddr, |
e71585ff | 379 | gdb::array_view<value *> args, |
7043d8dc | 380 | struct type *value_type, |
e4fd649a UW |
381 | CORE_ADDR *real_pc, CORE_ADDR *bp_addr, |
382 | struct regcache *regcache) | |
7043d8dc | 383 | { |
50a834af MK |
384 | gdb_assert (gdbarch_push_dummy_code_p (gdbarch)); |
385 | ||
386 | return gdbarch_push_dummy_code (gdbarch, sp, funaddr, | |
e71585ff PA |
387 | args.data (), args.size (), |
388 | value_type, real_pc, bp_addr, | |
50a834af | 389 | regcache); |
7043d8dc AC |
390 | } |
391 | ||
7022349d PA |
392 | /* See infcall.h. */ |
393 | ||
394 | void | |
395 | error_call_unknown_return_type (const char *func_name) | |
396 | { | |
397 | if (func_name != NULL) | |
398 | error (_("'%s' has unknown return type; " | |
399 | "cast the call to its declared return type"), | |
400 | func_name); | |
401 | else | |
402 | error (_("function has unknown return type; " | |
403 | "cast the call to its declared return type")); | |
404 | } | |
405 | ||
b89667eb DE |
406 | /* Fetch the name of the function at FUNADDR. |
407 | This is used in printing an error message for call_function_by_hand. | |
408 | BUF is used to print FUNADDR in hex if the function name cannot be | |
409 | determined. It must be large enough to hold formatted result of | |
410 | RAW_FUNCTION_ADDRESS_FORMAT. */ | |
411 | ||
412 | static const char * | |
413 | get_function_name (CORE_ADDR funaddr, char *buf, int buf_size) | |
414 | { | |
415 | { | |
416 | struct symbol *symbol = find_pc_function (funaddr); | |
abbb1732 | 417 | |
b89667eb | 418 | if (symbol) |
987012b8 | 419 | return symbol->print_name (); |
b89667eb DE |
420 | } |
421 | ||
422 | { | |
423 | /* Try the minimal symbols. */ | |
7cbd4a93 | 424 | struct bound_minimal_symbol msymbol = lookup_minimal_symbol_by_pc (funaddr); |
abbb1732 | 425 | |
7cbd4a93 | 426 | if (msymbol.minsym) |
c9d95fa3 | 427 | return msymbol.minsym->print_name (); |
b89667eb DE |
428 | } |
429 | ||
430 | { | |
528e1572 SM |
431 | std::string tmp = string_printf (_(RAW_FUNCTION_ADDRESS_FORMAT), |
432 | hex_string (funaddr)); | |
abbb1732 | 433 | |
528e1572 SM |
434 | gdb_assert (tmp.length () + 1 <= buf_size); |
435 | return strcpy (buf, tmp.c_str ()); | |
b89667eb DE |
436 | } |
437 | } | |
438 | ||
388a7084 PA |
439 | /* All the meta data necessary to extract the call's return value. */ |
440 | ||
441 | struct call_return_meta_info | |
442 | { | |
443 | /* The caller frame's architecture. */ | |
444 | struct gdbarch *gdbarch; | |
445 | ||
446 | /* The called function. */ | |
447 | struct value *function; | |
448 | ||
449 | /* The return value's type. */ | |
450 | struct type *value_type; | |
451 | ||
452 | /* Are we returning a value using a structure return or a normal | |
453 | value return? */ | |
454 | int struct_return_p; | |
455 | ||
456 | /* If using a structure return, this is the structure's address. */ | |
457 | CORE_ADDR struct_addr; | |
388a7084 PA |
458 | }; |
459 | ||
460 | /* Extract the called function's return value. */ | |
461 | ||
462 | static struct value * | |
463 | get_call_return_value (struct call_return_meta_info *ri) | |
464 | { | |
465 | struct value *retval = NULL; | |
00431a78 PA |
466 | thread_info *thr = inferior_thread (); |
467 | bool stack_temporaries = thread_stack_temporaries_enabled_p (thr); | |
388a7084 | 468 | |
78134374 | 469 | if (ri->value_type->code () == TYPE_CODE_VOID) |
317c3ed9 | 470 | retval = value::allocate (ri->value_type); |
388a7084 PA |
471 | else if (ri->struct_return_p) |
472 | { | |
473 | if (stack_temporaries) | |
474 | { | |
475 | retval = value_from_contents_and_address (ri->value_type, NULL, | |
476 | ri->struct_addr); | |
00431a78 | 477 | push_thread_stack_temporary (thr, retval); |
388a7084 PA |
478 | } |
479 | else | |
3360bae6 | 480 | retval = value_at_non_lval (ri->value_type, ri->struct_addr); |
388a7084 PA |
481 | } |
482 | else | |
483 | { | |
4e1d2f58 TT |
484 | gdbarch_return_value_as_value (ri->gdbarch, ri->function, ri->value_type, |
485 | get_current_regcache (), | |
486 | &retval, NULL); | |
388a7084 PA |
487 | if (stack_temporaries && class_or_union_p (ri->value_type)) |
488 | { | |
489 | /* Values of class type returned in registers are copied onto | |
490 | the stack and their lval_type set to lval_memory. This is | |
491 | required because further evaluation of the expression | |
492 | could potentially invoke methods on the return value | |
493 | requiring GDB to evaluate the "this" pointer. To evaluate | |
494 | the this pointer, GDB needs the memory address of the | |
495 | value. */ | |
aa9f4538 | 496 | retval->force_lval (ri->struct_addr); |
00431a78 | 497 | push_thread_stack_temporary (thr, retval); |
388a7084 PA |
498 | } |
499 | } | |
500 | ||
501 | gdb_assert (retval != NULL); | |
502 | return retval; | |
503 | } | |
504 | ||
505 | /* Data for the FSM that manages an infcall. It's main job is to | |
506 | record the called function's return value. */ | |
507 | ||
46e3ed7f | 508 | struct call_thread_fsm : public thread_fsm |
388a7084 | 509 | { |
388a7084 PA |
510 | /* All the info necessary to be able to extract the return |
511 | value. */ | |
512 | struct call_return_meta_info return_meta_info; | |
513 | ||
514 | /* The called function's return value. This is extracted from the | |
515 | target before the dummy frame is popped. */ | |
46e3ed7f | 516 | struct value *return_value = nullptr; |
3b12939d PA |
517 | |
518 | /* The top level that started the infcall (and is synchronously | |
519 | waiting for it to end). */ | |
520 | struct ui *waiting_ui; | |
388a7084 | 521 | |
46e3ed7f TT |
522 | call_thread_fsm (struct ui *waiting_ui, struct interp *cmd_interp, |
523 | struct gdbarch *gdbarch, struct value *function, | |
524 | struct type *value_type, | |
525 | int struct_return_p, CORE_ADDR struct_addr); | |
388a7084 | 526 | |
46e3ed7f | 527 | bool should_stop (struct thread_info *thread) override; |
388a7084 | 528 | |
46e3ed7f | 529 | bool should_notify_stop () override; |
388a7084 PA |
530 | }; |
531 | ||
532 | /* Allocate a new call_thread_fsm object. */ | |
533 | ||
46e3ed7f TT |
534 | call_thread_fsm::call_thread_fsm (struct ui *waiting_ui, |
535 | struct interp *cmd_interp, | |
536 | struct gdbarch *gdbarch, | |
537 | struct value *function, | |
538 | struct type *value_type, | |
539 | int struct_return_p, CORE_ADDR struct_addr) | |
540 | : thread_fsm (cmd_interp), | |
541 | waiting_ui (waiting_ui) | |
388a7084 | 542 | { |
46e3ed7f TT |
543 | return_meta_info.gdbarch = gdbarch; |
544 | return_meta_info.function = function; | |
545 | return_meta_info.value_type = value_type; | |
546 | return_meta_info.struct_return_p = struct_return_p; | |
547 | return_meta_info.struct_addr = struct_addr; | |
388a7084 PA |
548 | } |
549 | ||
550 | /* Implementation of should_stop method for infcalls. */ | |
551 | ||
46e3ed7f TT |
552 | bool |
553 | call_thread_fsm::should_stop (struct thread_info *thread) | |
388a7084 | 554 | { |
e4014689 AB |
555 | INFCALL_SCOPED_DEBUG_ENTER_EXIT; |
556 | ||
388a7084 PA |
557 | if (stop_stack_dummy == STOP_STACK_DUMMY) |
558 | { | |
559 | /* Done. */ | |
46e3ed7f | 560 | set_finished (); |
388a7084 PA |
561 | |
562 | /* Stash the return value before the dummy frame is popped and | |
563 | registers are restored to what they were before the | |
564 | call.. */ | |
46e3ed7f | 565 | return_value = get_call_return_value (&return_meta_info); |
388a7084 | 566 | |
b1c0ab20 AB |
567 | /* Break out of wait_sync_command_done. This is similar to the |
568 | async_enable_stdin call in normal_stop (which we don't call), | |
569 | however, in this case we only change the WAITING_UI. This is | |
570 | enough for wait_sync_command_done. */ | |
46e3ed7f | 571 | scoped_restore save_ui = make_scoped_restore (¤t_ui, waiting_ui); |
b1c0ab20 AB |
572 | gdb_assert (current_ui->prompt_state == PROMPT_BLOCKED); |
573 | async_enable_stdin (); | |
388a7084 PA |
574 | } |
575 | ||
46e3ed7f | 576 | return true; |
388a7084 PA |
577 | } |
578 | ||
579 | /* Implementation of should_notify_stop method for infcalls. */ | |
580 | ||
46e3ed7f TT |
581 | bool |
582 | call_thread_fsm::should_notify_stop () | |
388a7084 | 583 | { |
46e3ed7f | 584 | if (finished_p ()) |
388a7084 PA |
585 | { |
586 | /* Infcall succeeded. Be silent and proceed with evaluating the | |
587 | expression. */ | |
46e3ed7f | 588 | return false; |
388a7084 PA |
589 | } |
590 | ||
591 | /* Something wrong happened. E.g., an unexpected breakpoint | |
592 | triggered, or a signal was intercepted. Notify the stop. */ | |
46e3ed7f | 593 | return true; |
388a7084 PA |
594 | } |
595 | ||
b89667eb DE |
596 | /* Subroutine of call_function_by_hand to simplify it. |
597 | Start up the inferior and wait for it to stop. | |
598 | Return the exception if there's an error, or an exception with | |
599 | reason >= 0 if there's no error. | |
600 | ||
601 | This is done inside a TRY_CATCH so the caller needn't worry about | |
602 | thrown errors. The caller should rethrow if there's an error. */ | |
603 | ||
604 | static struct gdb_exception | |
573269a8 | 605 | run_inferior_call (std::unique_ptr<call_thread_fsm> sm, |
388a7084 | 606 | struct thread_info *call_thread, CORE_ADDR real_pc) |
b89667eb | 607 | { |
e4014689 AB |
608 | INFCALL_SCOPED_DEBUG_ENTER_EXIT; |
609 | ||
cc06b668 | 610 | struct gdb_exception caught_error; |
b89667eb | 611 | ptid_t call_thread_ptid = call_thread->ptid; |
28bf096c | 612 | int was_running = call_thread->state == THREAD_RUNNING; |
b89667eb | 613 | |
e4014689 AB |
614 | infcall_debug_printf ("call function at %s in thread %s, was_running = %d", |
615 | core_addr_to_string (real_pc), | |
616 | call_thread_ptid.to_string ().c_str (), | |
617 | was_running); | |
618 | ||
8f7f9b3a | 619 | current_ui->unregister_file_handler (); |
6d61dee5 | 620 | |
a32c1a92 AB |
621 | scoped_restore restore_in_infcall |
622 | = make_scoped_restore (&call_thread->control.in_infcall, 1); | |
c5a4d20b | 623 | |
70509625 | 624 | clear_proceed_status (0); |
b89667eb | 625 | |
388a7084 | 626 | /* Associate the FSM with the thread after clear_proceed_status |
573269a8 LS |
627 | (otherwise it'd clear this FSM). */ |
628 | call_thread->set_thread_fsm (std::move (sm)); | |
388a7084 | 629 | |
b89667eb | 630 | disable_watchpoints_before_interactive_call_start (); |
16c381f0 | 631 | |
b986eec5 CL |
632 | /* We want to print return value, please... */ |
633 | call_thread->control.proceed_to_finish = 1; | |
634 | ||
a70b8144 | 635 | try |
3dd5b83d | 636 | { |
a32c1a92 AB |
637 | /* Infcalls run synchronously, in the foreground. */ |
638 | scoped_restore restore_prompt_state | |
639 | = make_scoped_restore (¤t_ui->prompt_state, PROMPT_BLOCKED); | |
640 | ||
641 | /* So that we don't print the prompt prematurely in | |
642 | fetch_inferior_event. */ | |
643 | scoped_restore restore_ui_async | |
644 | = make_scoped_restore (¤t_ui->async, 0); | |
645 | ||
64ce06e4 | 646 | proceed (real_pc, GDB_SIGNAL_0); |
3dd5b83d | 647 | |
e4014689 AB |
648 | infrun_debug_show_threads ("non-exited threads after proceed for inferior-call", |
649 | all_non_exited_threads ()); | |
650 | ||
3dd5b83d | 651 | /* Inferior function calls are always synchronous, even if the |
0b333c5e PA |
652 | target supports asynchronous execution. */ |
653 | wait_sync_command_done (); | |
e4014689 AB |
654 | |
655 | infcall_debug_printf ("inferior call completed successfully"); | |
3dd5b83d | 656 | } |
94aeb44b | 657 | catch (gdb_exception &e) |
492d29ea | 658 | { |
e4014689 AB |
659 | infcall_debug_printf ("exception while making inferior call (%d): %s", |
660 | e.reason, e.what ()); | |
94aeb44b | 661 | caught_error = std::move (e); |
492d29ea | 662 | } |
b89667eb | 663 | |
e4014689 AB |
664 | infcall_debug_printf ("thread is now: %s", |
665 | inferior_ptid.to_string ().c_str ()); | |
666 | ||
b1c0ab20 AB |
667 | /* After the inferior call finished, async_enable_stdin has been |
668 | called, either from normal_stop or from | |
669 | call_thread_fsm::should_stop, and the prompt state has been | |
670 | restored by the scoped_restore in the try block above. | |
671 | ||
672 | If the inferior call finished successfully, then we should | |
673 | disable stdin as we don't know yet whether the inferior will be | |
674 | stopping. Calling async_disable_stdin restores things to how | |
675 | they were when this function was called. | |
676 | ||
677 | If the inferior call didn't complete successfully, then | |
678 | normal_stop has already been called, and we know for sure that we | |
679 | are going to present this stop to the user. In this case, we | |
680 | call async_enable_stdin. This changes the prompt state to | |
681 | PROMPT_NEEDED. | |
682 | ||
683 | If the previous prompt state was PROMPT_NEEDED, then as | |
684 | async_enable_stdin has already been called, nothing additional | |
685 | needs to be done here. */ | |
6d61dee5 | 686 | if (current_ui->prompt_state == PROMPT_BLOCKED) |
b1c0ab20 AB |
687 | { |
688 | if (call_thread->thread_fsm ()->finished_p ()) | |
689 | async_disable_stdin (); | |
690 | else | |
691 | async_enable_stdin (); | |
692 | } | |
0b333c5e | 693 | |
28bf096c PA |
694 | /* If the infcall does NOT succeed, normal_stop will have already |
695 | finished the thread states. However, on success, normal_stop | |
696 | defers here, so that we can set back the thread states to what | |
697 | they were before the call. Note that we must also finish the | |
698 | state of new threads that might have spawned while the call was | |
699 | running. The main cases to handle are: | |
700 | ||
701 | - "(gdb) print foo ()", or any other command that evaluates an | |
702 | expression at the prompt. (The thread was marked stopped before.) | |
703 | ||
704 | - "(gdb) break foo if return_false()" or similar cases where we | |
705 | do an infcall while handling an event (while the thread is still | |
706 | marked running). In this example, whether the condition | |
707 | evaluates true and thus we'll present a user-visible stop is | |
708 | decided elsewhere. */ | |
709 | if (!was_running | |
00431a78 | 710 | && call_thread_ptid == inferior_ptid |
28bf096c | 711 | && stop_stack_dummy == STOP_STACK_DUMMY) |
5b6d1e4f PA |
712 | finish_thread_state (call_thread->inf->process_target (), |
713 | user_visible_resume_ptid (0)); | |
28bf096c | 714 | |
b89667eb DE |
715 | enable_watchpoints_after_interactive_call_stop (); |
716 | ||
717 | /* Call breakpoint_auto_delete on the current contents of the bpstat | |
718 | of inferior call thread. | |
719 | If all error()s out of proceed ended up calling normal_stop | |
720 | (and perhaps they should; it already does in the special case | |
721 | of error out of resume()), then we wouldn't need this. */ | |
492d29ea | 722 | if (caught_error.reason < 0) |
b89667eb | 723 | { |
00431a78 | 724 | if (call_thread->state != THREAD_EXITED) |
16c381f0 | 725 | breakpoint_auto_delete (call_thread->control.stop_bpstat); |
b89667eb DE |
726 | } |
727 | ||
492d29ea | 728 | return caught_error; |
b89667eb DE |
729 | } |
730 | ||
12e7c35e TBA |
731 | /* Reserve space on the stack for a value of the given type. |
732 | Return the address of the allocated space. | |
733 | Make certain that the value is correctly aligned. | |
734 | The SP argument is modified. */ | |
735 | ||
736 | static CORE_ADDR | |
737 | reserve_stack_space (const type *values_type, CORE_ADDR &sp) | |
738 | { | |
bd2b40ac | 739 | frame_info_ptr frame = get_current_frame (); |
12e7c35e TBA |
740 | struct gdbarch *gdbarch = get_frame_arch (frame); |
741 | CORE_ADDR addr = 0; | |
742 | ||
743 | if (gdbarch_inner_than (gdbarch, 1, 2)) | |
744 | { | |
745 | /* Stack grows downward. Align STRUCT_ADDR and SP after | |
746 | making space. */ | |
df86565b | 747 | sp -= values_type->length (); |
12e7c35e TBA |
748 | if (gdbarch_frame_align_p (gdbarch)) |
749 | sp = gdbarch_frame_align (gdbarch, sp); | |
750 | addr = sp; | |
751 | } | |
752 | else | |
753 | { | |
754 | /* Stack grows upward. Align the frame, allocate space, and | |
755 | then again, re-align the frame??? */ | |
756 | if (gdbarch_frame_align_p (gdbarch)) | |
757 | sp = gdbarch_frame_align (gdbarch, sp); | |
758 | addr = sp; | |
df86565b | 759 | sp += values_type->length (); |
12e7c35e TBA |
760 | if (gdbarch_frame_align_p (gdbarch)) |
761 | sp = gdbarch_frame_align (gdbarch, sp); | |
762 | } | |
763 | ||
764 | return addr; | |
765 | } | |
766 | ||
099a6354 TBA |
767 | /* The data structure which keeps a destructor function and |
768 | its implicit 'this' parameter. */ | |
769 | ||
770 | struct destructor_info | |
771 | { | |
772 | destructor_info (struct value *function, struct value *self) | |
773 | : function (function), self (self) { } | |
774 | ||
775 | struct value *function; | |
776 | struct value *self; | |
777 | }; | |
778 | ||
779 | ||
780 | /* Auxiliary function that takes a list of destructor functions | |
781 | with their 'this' parameters, and invokes the functions. */ | |
782 | ||
783 | static void | |
784 | call_destructors (const std::list<destructor_info> &dtors_to_invoke, | |
785 | struct type *default_return_type) | |
786 | { | |
787 | for (auto vals : dtors_to_invoke) | |
788 | { | |
789 | call_function_by_hand (vals.function, default_return_type, | |
790 | gdb::make_array_view (&(vals.self), 1)); | |
791 | } | |
792 | } | |
793 | ||
ed12ef62 JK |
794 | /* See infcall.h. */ |
795 | ||
796 | struct value * | |
7022349d PA |
797 | call_function_by_hand (struct value *function, |
798 | type *default_return_type, | |
e71585ff | 799 | gdb::array_view<value *> args) |
ed12ef62 | 800 | { |
7022349d | 801 | return call_function_by_hand_dummy (function, default_return_type, |
e71585ff | 802 | args, NULL, NULL); |
ed12ef62 JK |
803 | } |
804 | ||
04714b91 AC |
805 | /* All this stuff with a dummy frame may seem unnecessarily complicated |
806 | (why not just save registers in GDB?). The purpose of pushing a dummy | |
807 | frame which looks just like a real frame is so that if you call a | |
808 | function and then hit a breakpoint (get a signal, etc), "backtrace" | |
809 | will look right. Whether the backtrace needs to actually show the | |
810 | stack at the time the inferior function was called is debatable, but | |
811 | it certainly needs to not display garbage. So if you are contemplating | |
812 | making dummy frames be different from normal frames, consider that. */ | |
813 | ||
814 | /* Perform a function call in the inferior. | |
12e7c35e | 815 | ARGS is a vector of values of arguments. |
04714b91 AC |
816 | FUNCTION is a value, the function to be called. |
817 | Returns a value representing what the function returned. | |
818 | May fail to return, if a breakpoint or signal is hit | |
819 | during the execution of the function. | |
820 | ||
1777feb0 | 821 | ARGS is modified to contain coerced values. */ |
04714b91 AC |
822 | |
823 | struct value * | |
ed12ef62 | 824 | call_function_by_hand_dummy (struct value *function, |
7022349d | 825 | type *default_return_type, |
e71585ff | 826 | gdb::array_view<value *> args, |
558e5469 | 827 | dummy_frame_dtor_ftype *dummy_dtor, |
ed12ef62 | 828 | void *dummy_dtor_data) |
04714b91 | 829 | { |
e4014689 AB |
830 | INFCALL_SCOPED_DEBUG_ENTER_EXIT; |
831 | ||
52f0bd74 | 832 | CORE_ADDR sp; |
8388016d | 833 | struct type *target_values_type; |
c5ac5cbb | 834 | function_call_return_method return_method = return_method_normal; |
04714b91 | 835 | CORE_ADDR struct_addr = 0; |
04714b91 | 836 | CORE_ADDR real_pc; |
d585e13a | 837 | CORE_ADDR bp_addr; |
96860204 | 838 | struct frame_id dummy_id; |
bd2b40ac | 839 | frame_info_ptr frame; |
0b9dfe2b | 840 | struct gdbarch *gdbarch; |
b89667eb DE |
841 | ptid_t call_thread_ptid; |
842 | struct gdb_exception e; | |
b89667eb | 843 | char name_buf[RAW_FUNCTION_ADDRESS_SIZE]; |
04714b91 | 844 | |
136afab8 PW |
845 | if (!may_call_functions_p) |
846 | error (_("Cannot call functions in the program: " | |
847 | "may-call-functions is off.")); | |
848 | ||
55f6301a | 849 | if (!target_has_execution ()) |
04714b91 AC |
850 | noprocess (); |
851 | ||
573cda03 SS |
852 | if (get_traceframe_number () >= 0) |
853 | error (_("May not call functions while looking at trace frames.")); | |
854 | ||
949dc678 | 855 | if (execution_direction == EXEC_REVERSE) |
c2949be0 | 856 | error (_("Cannot call functions in reverse mode.")); |
949dc678 | 857 | |
00431a78 PA |
858 | /* We're going to run the target, and inspect the thread's state |
859 | afterwards. Hold a strong reference so that the pointer remains | |
860 | valid even if the thread exits. */ | |
861 | thread_info_ref call_thread | |
862 | = thread_info_ref::new_reference (inferior_thread ()); | |
863 | ||
864 | bool stack_temporaries = thread_stack_temporaries_enabled_p (call_thread.get ()); | |
865 | ||
0b9dfe2b MD |
866 | frame = get_current_frame (); |
867 | gdbarch = get_frame_arch (frame); | |
868 | ||
869 | if (!gdbarch_push_dummy_call_p (gdbarch)) | |
2e74121d | 870 | error (_("This target does not support function calls.")); |
a86c5fc9 | 871 | |
39bcc47c TBA |
872 | /* Find the function type and do a sanity check. */ |
873 | type *ftype; | |
874 | type *values_type; | |
875 | CORE_ADDR funaddr = find_function_addr (function, &values_type, &ftype); | |
876 | ||
0b35f123 LS |
877 | if (is_nocall_function (ftype)) |
878 | error (_("Cannot call the function '%s' which does not follow the " | |
879 | "target calling convention."), | |
880 | get_function_name (funaddr, name_buf, sizeof (name_buf))); | |
881 | ||
a34a9099 | 882 | if (values_type == NULL || values_type->is_stub ()) |
39bcc47c TBA |
883 | values_type = default_return_type; |
884 | if (values_type == NULL) | |
885 | { | |
886 | const char *name = get_function_name (funaddr, | |
887 | name_buf, sizeof (name_buf)); | |
888 | error (_("'%s' has unknown return type; " | |
889 | "cast the call to its declared return type"), | |
890 | name); | |
891 | } | |
892 | ||
893 | values_type = check_typedef (values_type); | |
894 | ||
1f704f76 | 895 | if (args.size () < ftype->num_fields ()) |
39bcc47c TBA |
896 | error (_("Too few arguments in function call.")); |
897 | ||
e4014689 AB |
898 | infcall_debug_printf ("calling %s", get_function_name (funaddr, name_buf, |
899 | sizeof (name_buf))); | |
900 | ||
c7c4d3fa | 901 | /* A holder for the inferior status. |
b89667eb | 902 | This is only needed while we're preparing the inferior function call. */ |
c7c4d3fa | 903 | infcall_control_state_up inf_status (save_infcall_control_state ()); |
04714b91 | 904 | |
b89667eb DE |
905 | /* Save the caller's registers and other state associated with the |
906 | inferior itself so that they can be restored once the | |
96860204 | 907 | callee returns. To allow nested calls the registers are (further |
c7c4d3fa TT |
908 | down) pushed onto a dummy frame stack. This unique pointer |
909 | is released once the regcache has been pushed). */ | |
910 | infcall_suspend_state_up caller_state (save_infcall_suspend_state ()); | |
04714b91 | 911 | |
04714b91 | 912 | /* Ensure that the initial SP is correctly aligned. */ |
ebc7896c | 913 | { |
0b9dfe2b | 914 | CORE_ADDR old_sp = get_frame_sp (frame); |
abbb1732 | 915 | |
0b9dfe2b | 916 | if (gdbarch_frame_align_p (gdbarch)) |
ebc7896c | 917 | { |
0b9dfe2b | 918 | sp = gdbarch_frame_align (gdbarch, old_sp); |
8b148df9 AC |
919 | /* NOTE: cagney/2003-08-13: Skip the "red zone". For some |
920 | ABIs, a function can use memory beyond the inner most stack | |
921 | address. AMD64 called that region the "red zone". Skip at | |
922 | least the "red zone" size before allocating any space on | |
923 | the stack. */ | |
0b9dfe2b MD |
924 | if (gdbarch_inner_than (gdbarch, 1, 2)) |
925 | sp -= gdbarch_frame_red_zone_size (gdbarch); | |
8b148df9 | 926 | else |
0b9dfe2b | 927 | sp += gdbarch_frame_red_zone_size (gdbarch); |
8b148df9 | 928 | /* Still aligned? */ |
0b9dfe2b | 929 | gdb_assert (sp == gdbarch_frame_align (gdbarch, sp)); |
ebc7896c AC |
930 | /* NOTE: cagney/2002-09-18: |
931 | ||
932 | On a RISC architecture, a void parameterless generic dummy | |
933 | frame (i.e., no parameters, no result) typically does not | |
934 | need to push anything the stack and hence can leave SP and | |
c48a845b | 935 | FP. Similarly, a frameless (possibly leaf) function does |
ebc7896c AC |
936 | not push anything on the stack and, hence, that too can |
937 | leave FP and SP unchanged. As a consequence, a sequence of | |
938 | void parameterless generic dummy frame calls to frameless | |
939 | functions will create a sequence of effectively identical | |
940 | frames (SP, FP and TOS and PC the same). This, not | |
30baf67b | 941 | surprisingly, results in what appears to be a stack in an |
ebc7896c AC |
942 | infinite loop --- when GDB tries to find a generic dummy |
943 | frame on the internal dummy frame stack, it will always | |
944 | find the first one. | |
945 | ||
946 | To avoid this problem, the code below always grows the | |
947 | stack. That way, two dummy frames can never be identical. | |
948 | It does burn a few bytes of stack but that is a small price | |
949 | to pay :-). */ | |
ebc7896c AC |
950 | if (sp == old_sp) |
951 | { | |
0b9dfe2b | 952 | if (gdbarch_inner_than (gdbarch, 1, 2)) |
ebc7896c | 953 | /* Stack grows down. */ |
0b9dfe2b | 954 | sp = gdbarch_frame_align (gdbarch, old_sp - 1); |
ebc7896c AC |
955 | else |
956 | /* Stack grows up. */ | |
0b9dfe2b | 957 | sp = gdbarch_frame_align (gdbarch, old_sp + 1); |
ebc7896c | 958 | } |
0e095b7e JK |
959 | /* SP may have underflown address zero here from OLD_SP. Memory access |
960 | functions will probably fail in such case but that is a target's | |
961 | problem. */ | |
ebc7896c AC |
962 | } |
963 | else | |
a59fe496 AC |
964 | /* FIXME: cagney/2002-09-18: Hey, you loose! |
965 | ||
8b148df9 AC |
966 | Who knows how badly aligned the SP is! |
967 | ||
968 | If the generic dummy frame ends up empty (because nothing is | |
969 | pushed) GDB won't be able to correctly perform back traces. | |
970 | If a target is having trouble with backtraces, first thing to | |
1777feb0 | 971 | do is add FRAME_ALIGN() to the architecture vector. If that |
669fac23 | 972 | fails, try dummy_id(). |
8b148df9 | 973 | |
dda83cd7 SM |
974 | If the ABI specifies a "Red Zone" (see the doco) the code |
975 | below will quietly trash it. */ | |
ebc7896c | 976 | sp = old_sp; |
6c659fc2 SC |
977 | |
978 | /* Skip over the stack temporaries that might have been generated during | |
979 | the evaluation of an expression. */ | |
980 | if (stack_temporaries) | |
981 | { | |
982 | struct value *lastval; | |
983 | ||
00431a78 | 984 | lastval = get_last_thread_stack_temporary (call_thread.get ()); |
dda83cd7 | 985 | if (lastval != NULL) |
6c659fc2 | 986 | { |
9feb2d07 | 987 | CORE_ADDR lastval_addr = lastval->address (); |
6c659fc2 SC |
988 | |
989 | if (gdbarch_inner_than (gdbarch, 1, 2)) | |
990 | { | |
991 | gdb_assert (sp >= lastval_addr); | |
992 | sp = lastval_addr; | |
993 | } | |
994 | else | |
995 | { | |
996 | gdb_assert (sp <= lastval_addr); | |
d0c97917 | 997 | sp = lastval_addr + lastval->type ()->length (); |
6c659fc2 SC |
998 | } |
999 | ||
1000 | if (gdbarch_frame_align_p (gdbarch)) | |
1001 | sp = gdbarch_frame_align (gdbarch, sp); | |
1002 | } | |
1003 | } | |
ebc7896c | 1004 | } |
04714b91 | 1005 | |
c5ac5cbb | 1006 | /* Are we returning a value using a structure return? */ |
41f1b697 | 1007 | |
18648a37 | 1008 | if (gdbarch_return_in_first_hidden_param_p (gdbarch, values_type)) |
41f1b697 | 1009 | { |
c5ac5cbb | 1010 | return_method = return_method_hidden_param; |
04714b91 | 1011 | |
41f1b697 DJ |
1012 | /* Tell the target specific argument pushing routine not to |
1013 | expect a value. */ | |
48319d1f | 1014 | target_values_type = builtin_type (gdbarch)->builtin_void; |
41f1b697 DJ |
1015 | } |
1016 | else | |
1017 | { | |
c5ac5cbb AH |
1018 | if (using_struct_return (gdbarch, function, values_type)) |
1019 | return_method = return_method_struct; | |
41f1b697 DJ |
1020 | target_values_type = values_type; |
1021 | } | |
04714b91 | 1022 | |
76727919 | 1023 | gdb::observers::inferior_call_pre.notify (inferior_ptid, funaddr); |
162078c8 | 1024 | |
7043d8dc AC |
1025 | /* Determine the location of the breakpoint (and possibly other |
1026 | stuff) that the called function will return to. The SPARC, for a | |
1027 | function returning a structure or union, needs to make space for | |
1028 | not just the breakpoint but also an extra word containing the | |
1029 | size (?) of the structure being passed. */ | |
1030 | ||
0b9dfe2b | 1031 | switch (gdbarch_call_dummy_location (gdbarch)) |
04714b91 AC |
1032 | { |
1033 | case ON_STACK: | |
a14dd77e JK |
1034 | { |
1035 | const gdb_byte *bp_bytes; | |
1036 | CORE_ADDR bp_addr_as_address; | |
1037 | int bp_size; | |
1038 | ||
1039 | /* Be careful BP_ADDR is in inferior PC encoding while | |
1040 | BP_ADDR_AS_ADDRESS is a plain memory address. */ | |
1041 | ||
e71585ff | 1042 | sp = push_dummy_code (gdbarch, sp, funaddr, args, |
a14dd77e JK |
1043 | target_values_type, &real_pc, &bp_addr, |
1044 | get_current_regcache ()); | |
1045 | ||
1046 | /* Write a legitimate instruction at the point where the infcall | |
1047 | breakpoint is going to be inserted. While this instruction | |
1048 | is never going to be executed, a user investigating the | |
1049 | memory from GDB would see this instruction instead of random | |
1050 | uninitialized bytes. We chose the breakpoint instruction | |
1051 | as it may look as the most logical one to the user and also | |
1052 | valgrind 3.7.0 needs it for proper vgdb inferior calls. | |
1053 | ||
1054 | If software breakpoints are unsupported for this target we | |
1055 | leave the user visible memory content uninitialized. */ | |
1056 | ||
1057 | bp_addr_as_address = bp_addr; | |
1058 | bp_bytes = gdbarch_breakpoint_from_pc (gdbarch, &bp_addr_as_address, | |
1059 | &bp_size); | |
1060 | if (bp_bytes != NULL) | |
1061 | write_memory (bp_addr_as_address, bp_bytes, bp_size); | |
1062 | } | |
7043d8dc | 1063 | break; |
5931a2fa JK |
1064 | case AT_ENTRY_POINT: |
1065 | { | |
1066 | CORE_ADDR dummy_addr; | |
1067 | ||
1068 | real_pc = funaddr; | |
1069 | dummy_addr = entry_point_address (); | |
a14dd77e | 1070 | |
5931a2fa | 1071 | /* A call dummy always consists of just a single breakpoint, so |
a14dd77e JK |
1072 | its address is the same as the address of the dummy. |
1073 | ||
1074 | The actual breakpoint is inserted separatly so there is no need to | |
1075 | write that out. */ | |
5931a2fa JK |
1076 | bp_addr = dummy_addr; |
1077 | break; | |
1078 | } | |
04714b91 | 1079 | default: |
f34652de | 1080 | internal_error (_("bad switch")); |
04714b91 AC |
1081 | } |
1082 | ||
099a6354 TBA |
1083 | /* Coerce the arguments and handle pass-by-reference. |
1084 | We want to remember the destruction required for pass-by-ref values. | |
1085 | For these, store the dtor function and the 'this' argument | |
1086 | in DTORS_TO_INVOKE. */ | |
1087 | std::list<destructor_info> dtors_to_invoke; | |
1088 | ||
e71585ff | 1089 | for (int i = args.size () - 1; i >= 0; i--) |
b4b08fa2 TT |
1090 | { |
1091 | int prototyped; | |
1092 | struct type *param_type; | |
e71585ff | 1093 | |
b4b08fa2 TT |
1094 | /* FIXME drow/2002-05-31: Should just always mark methods as |
1095 | prototyped. Can we respect TYPE_VARARGS? Probably not. */ | |
78134374 | 1096 | if (ftype->code () == TYPE_CODE_METHOD) |
b4b08fa2 | 1097 | prototyped = 1; |
27710edb | 1098 | else if (ftype->target_type () == NULL && ftype->num_fields () == 0 |
d038ce48 | 1099 | && default_return_type != NULL) |
b4b08fa2 TT |
1100 | { |
1101 | /* Calling a no-debug function with the return type | |
1102 | explicitly cast. Assume the function is prototyped, | |
1103 | with a prototype matching the types of the arguments. | |
1104 | E.g., with: | |
1105 | float mult (float v1, float v2) { return v1 * v2; } | |
1106 | This: | |
1107 | (gdb) p (float) mult (2.0f, 3.0f) | |
1108 | Is a simpler alternative to: | |
1109 | (gdb) p ((float (*) (float, float)) mult) (2.0f, 3.0f) | |
1110 | */ | |
ebc7896c | 1111 | prototyped = 1; |
b4b08fa2 | 1112 | } |
1f704f76 | 1113 | else if (i < ftype->num_fields ()) |
7f9f399b | 1114 | prototyped = ftype->is_prototyped (); |
b4b08fa2 TT |
1115 | else |
1116 | prototyped = 0; | |
ebc7896c | 1117 | |
1f704f76 | 1118 | if (i < ftype->num_fields ()) |
940da03e | 1119 | param_type = ftype->field (i).type (); |
b4b08fa2 TT |
1120 | else |
1121 | param_type = NULL; | |
41f1b697 | 1122 | |
099a6354 | 1123 | value *original_arg = args[i]; |
b4b08fa2 | 1124 | args[i] = value_arg_coerce (gdbarch, args[i], |
37055cad | 1125 | param_type, prototyped); |
ebc7896c | 1126 | |
099a6354 TBA |
1127 | if (param_type == NULL) |
1128 | continue; | |
1129 | ||
1130 | auto info = language_pass_by_reference (param_type); | |
1131 | if (!info.copy_constructible) | |
1132 | error (_("expression cannot be evaluated because the type '%s' " | |
7d93a1e0 | 1133 | "is not copy constructible"), param_type->name ()); |
099a6354 TBA |
1134 | |
1135 | if (!info.destructible) | |
1136 | error (_("expression cannot be evaluated because the type '%s' " | |
7d93a1e0 | 1137 | "is not destructible"), param_type->name ()); |
099a6354 TBA |
1138 | |
1139 | if (info.trivially_copyable) | |
1140 | continue; | |
1141 | ||
1142 | /* Make a copy of the argument on the stack. If the argument is | |
1143 | trivially copy ctor'able, copy bit by bit. Otherwise, call | |
1144 | the copy ctor to initialize the clone. */ | |
1145 | CORE_ADDR addr = reserve_stack_space (param_type, sp); | |
1146 | value *clone | |
1147 | = value_from_contents_and_address (param_type, nullptr, addr); | |
1148 | push_thread_stack_temporary (call_thread.get (), clone); | |
1149 | value *clone_ptr | |
1150 | = value_from_pointer (lookup_pointer_type (param_type), addr); | |
1151 | ||
1152 | if (info.trivially_copy_constructible) | |
1153 | { | |
df86565b | 1154 | int length = param_type->length (); |
efaf1ae0 | 1155 | write_memory (addr, args[i]->contents ().data (), length); |
099a6354 TBA |
1156 | } |
1157 | else | |
1158 | { | |
1159 | value *copy_ctor; | |
1160 | value *cctor_args[2] = { clone_ptr, original_arg }; | |
1161 | find_overload_match (gdb::make_array_view (cctor_args, 2), | |
7d93a1e0 | 1162 | param_type->name (), METHOD, |
099a6354 TBA |
1163 | &clone_ptr, nullptr, ©_ctor, nullptr, |
1164 | nullptr, 0, EVAL_NORMAL); | |
1165 | ||
1166 | if (copy_ctor == nullptr) | |
1167 | error (_("expression cannot be evaluated because a copy " | |
1168 | "constructor for the type '%s' could not be found " | |
7d93a1e0 | 1169 | "(maybe inlined?)"), param_type->name ()); |
099a6354 TBA |
1170 | |
1171 | call_function_by_hand (copy_ctor, default_return_type, | |
1172 | gdb::make_array_view (cctor_args, 2)); | |
1173 | } | |
1174 | ||
1175 | /* If the argument has a destructor, remember it so that we | |
1176 | invoke it after the infcall is complete. */ | |
1177 | if (!info.trivially_destructible) | |
1178 | { | |
1179 | /* Looking up the function via overload resolution does not | |
1180 | work because the compiler (in particular, gcc) adds an | |
1181 | artificial int parameter in some cases. So we look up | |
1182 | the function by using the "~" name. This should be OK | |
1183 | because there can be only one dtor definition. */ | |
1184 | const char *dtor_name = nullptr; | |
1185 | for (int fieldnum = 0; | |
1186 | fieldnum < TYPE_NFN_FIELDS (param_type); | |
1187 | fieldnum++) | |
1188 | { | |
1189 | fn_field *fn | |
1190 | = TYPE_FN_FIELDLIST1 (param_type, fieldnum); | |
1191 | const char *field_name | |
1192 | = TYPE_FN_FIELDLIST_NAME (param_type, fieldnum); | |
1193 | ||
1194 | if (field_name[0] == '~') | |
1195 | dtor_name = TYPE_FN_FIELD_PHYSNAME (fn, 0); | |
1196 | } | |
1197 | ||
1198 | if (dtor_name == nullptr) | |
1199 | error (_("expression cannot be evaluated because a destructor " | |
1200 | "for the type '%s' could not be found " | |
7d93a1e0 | 1201 | "(maybe inlined?)"), param_type->name ()); |
099a6354 TBA |
1202 | |
1203 | value *dtor | |
1204 | = find_function_in_inferior (dtor_name, 0); | |
1205 | ||
1206 | /* Insert the dtor to the front of the list to call them | |
1207 | in reverse order later. */ | |
1208 | dtors_to_invoke.emplace_front (dtor, clone_ptr); | |
1209 | } | |
1210 | ||
1211 | args[i] = clone_ptr; | |
b4b08fa2 | 1212 | } |
04714b91 | 1213 | |
04714b91 | 1214 | /* Reserve space for the return structure to be written on the |
12e7c35e | 1215 | stack, if necessary. |
6c659fc2 SC |
1216 | |
1217 | While evaluating expressions, we reserve space on the stack for | |
1218 | return values of class type even if the language ABI and the target | |
1219 | ABI do not require that the return value be passed as a hidden first | |
1220 | argument. This is because we want to store the return value as an | |
1221 | on-stack temporary while the expression is being evaluated. This | |
1222 | enables us to have chained function calls in expressions. | |
04714b91 | 1223 | |
6c659fc2 SC |
1224 | Keeping the return values as on-stack temporaries while the expression |
1225 | is being evaluated is OK because the thread is stopped until the | |
1226 | expression is completely evaluated. */ | |
1227 | ||
c5ac5cbb | 1228 | if (return_method != return_method_normal |
6c659fc2 | 1229 | || (stack_temporaries && class_or_union_p (values_type))) |
12e7c35e | 1230 | struct_addr = reserve_stack_space (values_type, sp); |
04714b91 | 1231 | |
6ccb583f | 1232 | std::vector<struct value *> new_args; |
c5ac5cbb | 1233 | if (return_method == return_method_hidden_param) |
41f1b697 | 1234 | { |
41f1b697 | 1235 | /* Add the new argument to the front of the argument list. */ |
28bb4811 | 1236 | new_args.reserve (1 + args.size ()); |
6ccb583f TT |
1237 | new_args.push_back |
1238 | (value_from_pointer (lookup_pointer_type (values_type), struct_addr)); | |
e71585ff PA |
1239 | new_args.insert (new_args.end (), args.begin (), args.end ()); |
1240 | args = new_args; | |
41f1b697 | 1241 | } |
41f1b697 | 1242 | |
04714b91 AC |
1243 | /* Create the dummy stack frame. Pass in the call dummy address as, |
1244 | presumably, the ABI code knows where, in the call dummy, the | |
1245 | return address should be pointed. */ | |
0b9dfe2b | 1246 | sp = gdbarch_push_dummy_call (gdbarch, function, get_current_regcache (), |
e71585ff PA |
1247 | bp_addr, args.size (), args.data (), |
1248 | sp, return_method, struct_addr); | |
04714b91 | 1249 | |
96860204 AC |
1250 | /* Set up a frame ID for the dummy frame so we can pass it to |
1251 | set_momentary_breakpoint. We need to give the breakpoint a frame | |
1252 | ID so that the breakpoint code can correctly re-identify the | |
1253 | dummy breakpoint. */ | |
8241eaa6 | 1254 | /* Sanity. The exact same SP value is returned by PUSH_DUMMY_CALL, |
669fac23 | 1255 | saved as the dummy-frame TOS, and used by dummy_id to form |
8241eaa6 | 1256 | the frame ID's stack address. */ |
96860204 | 1257 | dummy_id = frame_id_build (sp, bp_addr); |
04714b91 | 1258 | |
74cfe982 AC |
1259 | /* Create a momentary breakpoint at the return address of the |
1260 | inferior. That way it breaks when it returns. */ | |
04714b91 | 1261 | |
74cfe982 | 1262 | { |
51abb421 | 1263 | symtab_and_line sal; |
6c95b8df | 1264 | sal.pspace = current_program_space; |
74cfe982 AC |
1265 | sal.pc = bp_addr; |
1266 | sal.section = find_pc_overlay (sal.pc); | |
51abb421 | 1267 | |
8241eaa6 AC |
1268 | /* Sanity. The exact same SP value is returned by |
1269 | PUSH_DUMMY_CALL, saved as the dummy-frame TOS, and used by | |
669fac23 | 1270 | dummy_id to form the frame ID's stack address. */ |
454dafbd TT |
1271 | breakpoint *bpt |
1272 | = set_momentary_breakpoint (gdbarch, sal, | |
1273 | dummy_id, bp_call_dummy).release (); | |
c70a6932 JK |
1274 | |
1275 | /* set_momentary_breakpoint invalidates FRAME. */ | |
1276 | frame = NULL; | |
1277 | ||
74cfe982 | 1278 | bpt->disposition = disp_del; |
e2e4d78b JK |
1279 | gdb_assert (bpt->related_breakpoint == bpt); |
1280 | ||
51abb421 | 1281 | breakpoint *longjmp_b = set_longjmp_breakpoint_for_call_dummy (); |
e2e4d78b JK |
1282 | if (longjmp_b) |
1283 | { | |
1284 | /* Link BPT into the chain of LONGJMP_B. */ | |
1285 | bpt->related_breakpoint = longjmp_b; | |
1286 | while (longjmp_b->related_breakpoint != bpt->related_breakpoint) | |
1287 | longjmp_b = longjmp_b->related_breakpoint; | |
1288 | longjmp_b->related_breakpoint = bpt; | |
1289 | } | |
74cfe982 | 1290 | } |
04714b91 | 1291 | |
7cd1089b PM |
1292 | /* Create a breakpoint in std::terminate. |
1293 | If a C++ exception is raised in the dummy-frame, and the | |
1294 | exception handler is (normally, and expected to be) out-of-frame, | |
1295 | the default C++ handler will (wrongly) be called in an inferior | |
1296 | function call. This is wrong, as an exception can be normally | |
1297 | and legally handled out-of-frame. The confines of the dummy frame | |
1298 | prevent the unwinder from finding the correct handler (or any | |
1299 | handler, unless it is in-frame). The default handler calls | |
1300 | std::terminate. This will kill the inferior. Assert that | |
1301 | terminate should never be called in an inferior function | |
1302 | call. Place a momentary breakpoint in the std::terminate function | |
1303 | and if triggered in the call, rewind. */ | |
1304 | if (unwind_on_terminating_exception_p) | |
aa7d318d | 1305 | set_std_terminate_breakpoint (); |
7cd1089b | 1306 | |
96860204 AC |
1307 | /* Everything's ready, push all the info needed to restore the |
1308 | caller (and identify the dummy-frame) onto the dummy-frame | |
1309 | stack. */ | |
c7c4d3fa | 1310 | dummy_frame_push (caller_state.release (), &dummy_id, call_thread.get ()); |
ed12ef62 | 1311 | if (dummy_dtor != NULL) |
00431a78 | 1312 | register_dummy_frame_dtor (dummy_id, call_thread.get (), |
ed12ef62 | 1313 | dummy_dtor, dummy_dtor_data); |
b89667eb | 1314 | |
7cd1089b | 1315 | /* Register a clean-up for unwind_on_terminating_exception_breakpoint. */ |
2cc83d1e | 1316 | SCOPE_EXIT { delete_std_terminate_breakpoint (); }; |
7cd1089b | 1317 | |
1bdcdb41 AB |
1318 | /* The stopped_by_random_signal variable is global. If we are here |
1319 | as part of a breakpoint condition check then the global will have | |
1320 | already been setup as part of the original breakpoint stop. By | |
1321 | making the inferior call the global will be changed when GDB | |
1322 | handles the stop after the inferior call. Avoid confusion by | |
1323 | restoring the current value after the inferior call. */ | |
1324 | scoped_restore restore_stopped_by_random_signal | |
1325 | = make_scoped_restore (&stopped_by_random_signal, 0); | |
1326 | ||
96860204 AC |
1327 | /* - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - |
1328 | If you're looking to implement asynchronous dummy-frames, then | |
1329 | just below is the place to chop this function in two.. */ | |
1330 | ||
74cfe982 | 1331 | { |
388a7084 | 1332 | /* Save the current FSM. We'll override it. */ |
573269a8 LS |
1333 | std::unique_ptr<thread_fsm> saved_sm = call_thread->release_thread_fsm (); |
1334 | struct call_thread_fsm *sm; | |
74cfe982 | 1335 | |
b89667eb DE |
1336 | /* Save this thread's ptid, we need it later but the thread |
1337 | may have exited. */ | |
00431a78 | 1338 | call_thread_ptid = call_thread->ptid; |
74cfe982 | 1339 | |
b89667eb | 1340 | /* Run the inferior until it stops. */ |
f5871ec0 | 1341 | |
388a7084 PA |
1342 | /* Create the FSM used to manage the infcall. It tells infrun to |
1343 | not report the stop to the user, and captures the return value | |
1344 | before the dummy frame is popped. run_inferior_call registers | |
1345 | it with the thread ASAP. */ | |
46e3ed7f | 1346 | sm = new call_thread_fsm (current_ui, command_interp (), |
3b12939d | 1347 | gdbarch, function, |
388a7084 | 1348 | values_type, |
c5ac5cbb | 1349 | return_method != return_method_normal, |
388a7084 | 1350 | struct_addr); |
573269a8 LS |
1351 | { |
1352 | std::unique_ptr<call_thread_fsm> sm_up (sm); | |
1353 | e = run_inferior_call (std::move (sm_up), call_thread.get (), real_pc); | |
1354 | } | |
388a7084 | 1355 | |
e4014689 AB |
1356 | if (e.reason < 0) |
1357 | infcall_debug_printf ("after inferior call, exception (%d): %s", | |
1358 | e.reason, e.what ()); | |
1359 | infcall_debug_printf ("after inferior call, thread state is: %s", | |
1360 | thread_state_string (call_thread->state)); | |
1361 | ||
76727919 | 1362 | gdb::observers::inferior_call_post.notify (call_thread_ptid, funaddr); |
388a7084 | 1363 | |
00431a78 | 1364 | if (call_thread->state != THREAD_EXITED) |
388a7084 PA |
1365 | { |
1366 | /* The FSM should still be the same. */ | |
573269a8 | 1367 | gdb_assert (call_thread->thread_fsm () == sm); |
388a7084 | 1368 | |
573269a8 | 1369 | if (call_thread->thread_fsm ()->finished_p ()) |
388a7084 PA |
1370 | { |
1371 | struct value *retval; | |
1372 | ||
e4014689 AB |
1373 | infcall_debug_printf ("call completed"); |
1374 | ||
388a7084 PA |
1375 | /* The inferior call is successful. Pop the dummy frame, |
1376 | which runs its destructors and restores the inferior's | |
1377 | suspend state, and restore the inferior control | |
1378 | state. */ | |
00431a78 | 1379 | dummy_frame_pop (dummy_id, call_thread.get ()); |
c7c4d3fa | 1380 | restore_infcall_control_state (inf_status.release ()); |
388a7084 PA |
1381 | |
1382 | /* Get the return value. */ | |
1383 | retval = sm->return_value; | |
1384 | ||
33b5899f | 1385 | /* Restore the original FSM and clean up / destroy the call FSM. |
573269a8 LS |
1386 | Doing it in this order ensures that if the call to clean_up |
1387 | throws, the original FSM is properly restored. */ | |
1388 | { | |
1389 | std::unique_ptr<thread_fsm> finalizing | |
1390 | = call_thread->release_thread_fsm (); | |
1391 | call_thread->set_thread_fsm (std::move (saved_sm)); | |
1392 | ||
1393 | finalizing->clean_up (call_thread.get ()); | |
1394 | } | |
04714b91 | 1395 | |
388a7084 PA |
1396 | maybe_remove_breakpoints (); |
1397 | ||
388a7084 | 1398 | gdb_assert (retval != NULL); |
099a6354 TBA |
1399 | |
1400 | /* Destruct the pass-by-ref argument clones. */ | |
1401 | call_destructors (dtors_to_invoke, default_return_type); | |
1402 | ||
388a7084 PA |
1403 | return retval; |
1404 | } | |
e4014689 AB |
1405 | else |
1406 | infcall_debug_printf ("call did not complete"); | |
388a7084 | 1407 | |
e3319240 PW |
1408 | /* Didn't complete. Clean up / destroy the call FSM, and restore the |
1409 | previous state machine, and handle the error. */ | |
573269a8 LS |
1410 | { |
1411 | std::unique_ptr<thread_fsm> finalizing | |
1412 | = call_thread->release_thread_fsm (); | |
1413 | call_thread->set_thread_fsm (std::move (saved_sm)); | |
1414 | ||
1415 | finalizing->clean_up (call_thread.get ()); | |
1416 | } | |
388a7084 PA |
1417 | } |
1418 | } | |
162078c8 | 1419 | |
b89667eb DE |
1420 | /* Rethrow an error if we got one trying to run the inferior. */ |
1421 | ||
1422 | if (e.reason < 0) | |
1423 | { | |
1424 | const char *name = get_function_name (funaddr, | |
dda83cd7 | 1425 | name_buf, sizeof (name_buf)); |
b89667eb | 1426 | |
c7c4d3fa | 1427 | discard_infcall_control_state (inf_status.release ()); |
b89667eb DE |
1428 | |
1429 | /* We could discard the dummy frame here if the program exited, | |
dda83cd7 SM |
1430 | but it will get garbage collected the next time the program is |
1431 | run anyway. */ | |
b89667eb DE |
1432 | |
1433 | switch (e.reason) | |
1434 | { | |
1435 | case RETURN_ERROR: | |
ac74f770 MS |
1436 | throw_error (e.error, _("%s\n\ |
1437 | An error occurred while in a function called from GDB.\n\ | |
1438 | Evaluation of the expression containing the function\n\ | |
1439 | (%s) will be abandoned.\n\ | |
1440 | When the function is done executing, GDB will silently stop."), | |
3d6e9d23 | 1441 | e.what (), name); |
b89667eb DE |
1442 | case RETURN_QUIT: |
1443 | default: | |
94aeb44b | 1444 | throw_exception (std::move (e)); |
b89667eb DE |
1445 | } |
1446 | } | |
1447 | ||
1448 | /* If the program has exited, or we stopped at a different thread, | |
1449 | exit and inform the user. */ | |
1450 | ||
55f6301a | 1451 | if (! target_has_execution ()) |
de04a248 | 1452 | { |
b89667eb DE |
1453 | const char *name = get_function_name (funaddr, |
1454 | name_buf, sizeof (name_buf)); | |
1455 | ||
1456 | /* If we try to restore the inferior status, | |
de04a248 | 1457 | we'll crash as the inferior is no longer running. */ |
c7c4d3fa | 1458 | discard_infcall_control_state (inf_status.release ()); |
b89667eb DE |
1459 | |
1460 | /* We could discard the dummy frame here given that the program exited, | |
dda83cd7 SM |
1461 | but it will get garbage collected the next time the program is |
1462 | run anyway. */ | |
b89667eb | 1463 | |
3e43a32a MS |
1464 | error (_("The program being debugged exited while in a function " |
1465 | "called from GDB.\n" | |
1466 | "Evaluation of the expression containing the function\n" | |
1467 | "(%s) will be abandoned."), | |
b89667eb DE |
1468 | name); |
1469 | } | |
1470 | ||
d7e15655 | 1471 | if (call_thread_ptid != inferior_ptid) |
b89667eb DE |
1472 | { |
1473 | const char *name = get_function_name (funaddr, | |
1474 | name_buf, sizeof (name_buf)); | |
1475 | ||
1476 | /* We've switched threads. This can happen if another thread gets a | |
1477 | signal or breakpoint while our thread was running. | |
1478 | There's no point in restoring the inferior status, | |
1479 | we're in a different thread. */ | |
c7c4d3fa | 1480 | discard_infcall_control_state (inf_status.release ()); |
b89667eb DE |
1481 | /* Keep the dummy frame record, if the user switches back to the |
1482 | thread with the hand-call, we'll need it. */ | |
1483 | if (stopped_by_random_signal) | |
ac74f770 MS |
1484 | error (_("\ |
1485 | The program received a signal in another thread while\n\ | |
1486 | making a function call from GDB.\n\ | |
1487 | Evaluation of the expression containing the function\n\ | |
1488 | (%s) will be abandoned.\n\ | |
1489 | When the function is done executing, GDB will silently stop."), | |
b89667eb DE |
1490 | name); |
1491 | else | |
ac74f770 MS |
1492 | error (_("\ |
1493 | The program stopped in another thread while making a function call from GDB.\n\ | |
1494 | Evaluation of the expression containing the function\n\ | |
1495 | (%s) will be abandoned.\n\ | |
1496 | When the function is done executing, GDB will silently stop."), | |
b89667eb | 1497 | name); |
de04a248 DE |
1498 | } |
1499 | ||
52557533 | 1500 | { |
5fe75eec | 1501 | /* Make a copy as NAME may be in an objfile freed by dummy_frame_pop. */ |
395423c4 TT |
1502 | std::string name = get_function_name (funaddr, name_buf, |
1503 | sizeof (name_buf)); | |
b89667eb | 1504 | |
52557533 AC |
1505 | if (stopped_by_random_signal) |
1506 | { | |
1507 | /* We stopped inside the FUNCTION because of a random | |
1508 | signal. Further execution of the FUNCTION is not | |
1777feb0 | 1509 | allowed. */ |
04714b91 | 1510 | |
52557533 AC |
1511 | if (unwind_on_signal_p) |
1512 | { | |
1777feb0 | 1513 | /* The user wants the context restored. */ |
52557533 AC |
1514 | |
1515 | /* We must get back to the frame we were before the | |
b89667eb | 1516 | dummy call. */ |
00431a78 | 1517 | dummy_frame_pop (dummy_id, call_thread.get ()); |
b89667eb DE |
1518 | |
1519 | /* We also need to restore inferior status to that before the | |
1520 | dummy call. */ | |
c7c4d3fa | 1521 | restore_infcall_control_state (inf_status.release ()); |
04714b91 | 1522 | |
52557533 AC |
1523 | /* FIXME: Insert a bunch of wrap_here; name can be very |
1524 | long if it's a C++ name with arguments and stuff. */ | |
ac74f770 MS |
1525 | error (_("\ |
1526 | The program being debugged was signaled while in a function called from GDB.\n\ | |
1527 | GDB has restored the context to what it was before the call.\n\ | |
1528 | To change this behavior use \"set unwindonsignal off\".\n\ | |
1529 | Evaluation of the expression containing the function\n\ | |
1530 | (%s) will be abandoned."), | |
395423c4 | 1531 | name.c_str ()); |
52557533 AC |
1532 | } |
1533 | else | |
1534 | { | |
1535 | /* The user wants to stay in the frame where we stopped | |
b89667eb DE |
1536 | (default). |
1537 | Discard inferior status, we're not at the same point | |
1538 | we started at. */ | |
c7c4d3fa | 1539 | discard_infcall_control_state (inf_status.release ()); |
b89667eb | 1540 | |
52557533 AC |
1541 | /* FIXME: Insert a bunch of wrap_here; name can be very |
1542 | long if it's a C++ name with arguments and stuff. */ | |
ac74f770 MS |
1543 | error (_("\ |
1544 | The program being debugged was signaled while in a function called from GDB.\n\ | |
1545 | GDB remains in the frame where the signal was received.\n\ | |
1546 | To change this behavior use \"set unwindonsignal on\".\n\ | |
1547 | Evaluation of the expression containing the function\n\ | |
1548 | (%s) will be abandoned.\n\ | |
1549 | When the function is done executing, GDB will silently stop."), | |
395423c4 | 1550 | name.c_str ()); |
52557533 AC |
1551 | } |
1552 | } | |
04714b91 | 1553 | |
aa7d318d | 1554 | if (stop_stack_dummy == STOP_STD_TERMINATE) |
52557533 | 1555 | { |
aa7d318d TT |
1556 | /* We must get back to the frame we were before the dummy |
1557 | call. */ | |
00431a78 | 1558 | dummy_frame_pop (dummy_id, call_thread.get ()); |
7cd1089b | 1559 | |
aa7d318d TT |
1560 | /* We also need to restore inferior status to that before |
1561 | the dummy call. */ | |
c7c4d3fa | 1562 | restore_infcall_control_state (inf_status.release ()); |
aa7d318d | 1563 | |
ac74f770 MS |
1564 | error (_("\ |
1565 | The program being debugged entered a std::terminate call, most likely\n\ | |
1566 | caused by an unhandled C++ exception. GDB blocked this call in order\n\ | |
1567 | to prevent the program from being terminated, and has restored the\n\ | |
1568 | context to its original state before the call.\n\ | |
1569 | To change this behaviour use \"set unwind-on-terminating-exception off\".\n\ | |
1570 | Evaluation of the expression containing the function (%s)\n\ | |
1571 | will be abandoned."), | |
395423c4 | 1572 | name.c_str ()); |
aa7d318d TT |
1573 | } |
1574 | else if (stop_stack_dummy == STOP_NONE) | |
1575 | { | |
1576 | ||
b89667eb DE |
1577 | /* We hit a breakpoint inside the FUNCTION. |
1578 | Keep the dummy frame, the user may want to examine its state. | |
1579 | Discard inferior status, we're not at the same point | |
1580 | we started at. */ | |
c7c4d3fa | 1581 | discard_infcall_control_state (inf_status.release ()); |
b89667eb | 1582 | |
52557533 AC |
1583 | /* The following error message used to say "The expression |
1584 | which contained the function call has been discarded." | |
1585 | It is a hard concept to explain in a few words. Ideally, | |
1586 | GDB would be able to resume evaluation of the expression | |
1587 | when the function finally is done executing. Perhaps | |
1588 | someday this will be implemented (it would not be easy). */ | |
1589 | /* FIXME: Insert a bunch of wrap_here; name can be very long if it's | |
1590 | a C++ name with arguments and stuff. */ | |
ac74f770 MS |
1591 | error (_("\ |
1592 | The program being debugged stopped while in a function called from GDB.\n\ | |
1593 | Evaluation of the expression containing the function\n\ | |
1594 | (%s) will be abandoned.\n\ | |
1595 | When the function is done executing, GDB will silently stop."), | |
395423c4 | 1596 | name.c_str ()); |
52557533 AC |
1597 | } |
1598 | ||
52557533 | 1599 | } |
04714b91 | 1600 | |
388a7084 PA |
1601 | /* The above code errors out, so ... */ |
1602 | gdb_assert_not_reached ("... should not be here"); | |
04714b91 | 1603 | } |
04714b91 | 1604 | |
6c265988 | 1605 | void _initialize_infcall (); |
04714b91 | 1606 | void |
6c265988 | 1607 | _initialize_infcall () |
04714b91 | 1608 | { |
136afab8 PW |
1609 | add_setshow_boolean_cmd ("may-call-functions", no_class, |
1610 | &may_call_functions_p, _("\ | |
1611 | Set permission to call functions in the program."), _("\ | |
1612 | Show permission to call functions in the program."), _("\ | |
1613 | When this permission is on, GDB may call functions in the program.\n\ | |
1614 | Otherwise, any sort of attempt to call a function in the program\n\ | |
1615 | will result in an error."), | |
1616 | NULL, | |
1617 | show_may_call_functions_p, | |
1618 | &setlist, &showlist); | |
1619 | ||
04714b91 | 1620 | add_setshow_boolean_cmd ("coerce-float-to-double", class_obscure, |
7915a72c AC |
1621 | &coerce_float_to_double_p, _("\ |
1622 | Set coercion of floats to doubles when calling functions."), _("\ | |
590042fc | 1623 | Show coercion of floats to doubles when calling functions."), _("\ |
04714b91 AC |
1624 | Variables of type float should generally be converted to doubles before\n\ |
1625 | calling an unprototyped function, and left alone when calling a prototyped\n\ | |
1626 | function. However, some older debug info formats do not provide enough\n\ | |
1627 | information to determine that a function is prototyped. If this flag is\n\ | |
1628 | set, GDB will perform the conversion for a function it considers\n\ | |
1629 | unprototyped.\n\ | |
89549d7f | 1630 | The default is to perform the conversion."), |
2c5b56ce | 1631 | NULL, |
920d2a44 | 1632 | show_coerce_float_to_double_p, |
2c5b56ce | 1633 | &setlist, &showlist); |
04714b91 AC |
1634 | |
1635 | add_setshow_boolean_cmd ("unwindonsignal", no_class, | |
7915a72c AC |
1636 | &unwind_on_signal_p, _("\ |
1637 | Set unwinding of stack if a signal is received while in a call dummy."), _("\ | |
1638 | Show unwinding of stack if a signal is received while in a call dummy."), _("\ | |
04714b91 AC |
1639 | The unwindonsignal lets the user determine what gdb should do if a signal\n\ |
1640 | is received while in a function called from gdb (call dummy). If set, gdb\n\ | |
1641 | unwinds the stack and restore the context to what as it was before the call.\n\ | |
7915a72c | 1642 | The default is to stop in the frame where the signal was received."), |
2c5b56ce | 1643 | NULL, |
920d2a44 | 1644 | show_unwind_on_signal_p, |
2c5b56ce | 1645 | &setlist, &showlist); |
7cd1089b PM |
1646 | |
1647 | add_setshow_boolean_cmd ("unwind-on-terminating-exception", no_class, | |
1648 | &unwind_on_terminating_exception_p, _("\ | |
1649 | Set unwinding of stack if std::terminate is called while in call dummy."), _("\ | |
3e43a32a MS |
1650 | Show unwinding of stack if std::terminate() is called while in a call dummy."), |
1651 | _("\ | |
7cd1089b PM |
1652 | The unwind on terminating exception flag lets the user determine\n\ |
1653 | what gdb should do if a std::terminate() call is made from the\n\ | |
1654 | default exception handler. If set, gdb unwinds the stack and restores\n\ | |
1655 | the context to what it was before the call. If unset, gdb allows the\n\ | |
1656 | std::terminate call to proceed.\n\ | |
1657 | The default is to unwind the frame."), | |
1658 | NULL, | |
1659 | show_unwind_on_terminating_exception_p, | |
1660 | &setlist, &showlist); | |
1661 | ||
e4014689 AB |
1662 | add_setshow_boolean_cmd |
1663 | ("infcall", class_maintenance, &debug_infcall, | |
1664 | _("Set inferior call debugging."), | |
1665 | _("Show inferior call debugging."), | |
1666 | _("When on, inferior function call specific debugging is enabled."), | |
1667 | NULL, show_debug_infcall, &setdebuglist, &showdebuglist); | |
04714b91 | 1668 | } |