Remove "noisy" parameter from clear_complaints
[deliverable/binutils-gdb.git] / gdb / infcall.c
CommitLineData
04714b91
AC
1/* Perform an inferior function call, for GDB, the GNU debugger.
2
e2882c85 3 Copyright (C) 1986-2018 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"
347bddb7 36#include "gdbthread.h"
beb460e8 37#include "event-top.h"
76727919 38#include "observable.h"
0b333c5e
PA
39#include "top.h"
40#include "interps.h"
388a7084 41#include "thread-fsm.h"
6ccb583f 42#include <algorithm>
b89667eb
DE
43
44/* If we can't find a function's name from its address,
45 we print this instead. */
46#define RAW_FUNCTION_ADDRESS_FORMAT "at 0x%s"
47#define RAW_FUNCTION_ADDRESS_SIZE (sizeof (RAW_FUNCTION_ADDRESS_FORMAT) \
48 + 2 * sizeof (CORE_ADDR))
04714b91
AC
49
50/* NOTE: cagney/2003-04-16: What's the future of this code?
51
52 GDB needs an asynchronous expression evaluator, that means an
53 asynchronous inferior function call implementation, and that in
54 turn means restructuring the code so that it is event driven. */
55
56/* How you should pass arguments to a function depends on whether it
57 was defined in K&R style or prototype style. If you define a
58 function using the K&R syntax that takes a `float' argument, then
59 callers must pass that argument as a `double'. If you define the
60 function using the prototype syntax, then you must pass the
61 argument as a `float', with no promotion.
62
63 Unfortunately, on certain older platforms, the debug info doesn't
64 indicate reliably how each function was defined. A function type's
a9ff5f12
UW
65 TYPE_PROTOTYPED flag may be clear, even if the function was defined
66 in prototype style. When calling a function whose TYPE_PROTOTYPED
67 flag is clear, GDB consults this flag to decide what to do.
04714b91
AC
68
69 For modern targets, it is proper to assume that, if the prototype
70 flag is clear, that can be trusted: `float' arguments should be
71 promoted to `double'. For some older targets, if the prototype
72 flag is clear, that doesn't tell us anything. The default is to
73 trust the debug information; the user can override this behavior
74 with "set coerce-float-to-double 0". */
75
76static int coerce_float_to_double_p = 1;
920d2a44
AC
77static void
78show_coerce_float_to_double_p (struct ui_file *file, int from_tty,
79 struct cmd_list_element *c, const char *value)
80{
3e43a32a
MS
81 fprintf_filtered (file,
82 _("Coercion of floats to doubles "
83 "when calling functions is %s.\n"),
920d2a44
AC
84 value);
85}
04714b91
AC
86
87/* This boolean tells what gdb should do if a signal is received while
88 in a function called from gdb (call dummy). If set, gdb unwinds
89 the stack and restore the context to what as it was before the
90 call.
91
1777feb0 92 The default is to stop in the frame where the signal was received. */
04714b91 93
ef61f180 94static int unwind_on_signal_p = 0;
920d2a44
AC
95static void
96show_unwind_on_signal_p (struct ui_file *file, int from_tty,
97 struct cmd_list_element *c, const char *value)
98{
3e43a32a
MS
99 fprintf_filtered (file,
100 _("Unwinding of stack if a signal is "
101 "received while in a call dummy is %s.\n"),
920d2a44
AC
102 value);
103}
104
7cd1089b
PM
105/* This boolean tells what gdb should do if a std::terminate call is
106 made while in a function called from gdb (call dummy).
107 As the confines of a single dummy stack prohibit out-of-frame
108 handlers from handling a raised exception, and as out-of-frame
109 handlers are common in C++, this can lead to no handler being found
110 by the unwinder, and a std::terminate call. This is a false positive.
111 If set, gdb unwinds the stack and restores the context to what it
112 was before the call.
113
114 The default is to unwind the frame if a std::terminate call is
115 made. */
116
117static int unwind_on_terminating_exception_p = 1;
118
119static void
120show_unwind_on_terminating_exception_p (struct ui_file *file, int from_tty,
121 struct cmd_list_element *c,
122 const char *value)
123
124{
3e43a32a
MS
125 fprintf_filtered (file,
126 _("Unwind stack if a C++ exception is "
127 "unhandled while in a call dummy is %s.\n"),
7cd1089b
PM
128 value);
129}
04714b91
AC
130
131/* Perform the standard coercions that are specified
a93c0eb6 132 for arguments to be passed to C or Ada functions.
04714b91
AC
133
134 If PARAM_TYPE is non-NULL, it is the expected parameter type.
a93c0eb6
JB
135 IS_PROTOTYPED is non-zero if the function declaration is prototyped.
136 SP is the stack pointer were additional data can be pushed (updating
137 its value as needed). */
04714b91
AC
138
139static struct value *
7788af6d
UW
140value_arg_coerce (struct gdbarch *gdbarch, struct value *arg,
141 struct type *param_type, int is_prototyped, CORE_ADDR *sp)
04714b91 142{
7788af6d 143 const struct builtin_type *builtin = builtin_type (gdbarch);
df407dfe 144 struct type *arg_type = check_typedef (value_type (arg));
52f0bd74 145 struct type *type
04714b91
AC
146 = param_type ? check_typedef (param_type) : arg_type;
147
a93c0eb6
JB
148 /* Perform any Ada-specific coercion first. */
149 if (current_language->la_language == language_ada)
40bc484c 150 arg = ada_convert_actual (arg, type);
a93c0eb6 151
63092375
DJ
152 /* Force the value to the target if we will need its address. At
153 this point, we could allocate arguments on the stack instead of
154 calling malloc if we knew that their addresses would not be
155 saved by the called function. */
156 arg = value_coerce_to_target (arg);
157
04714b91
AC
158 switch (TYPE_CODE (type))
159 {
160 case TYPE_CODE_REF:
aa006118 161 case TYPE_CODE_RVALUE_REF:
fb933624
DJ
162 {
163 struct value *new_value;
164
aa006118 165 if (TYPE_IS_REFERENCE (arg_type))
b1af9e97 166 return value_cast_pointers (type, arg, 0);
fb933624
DJ
167
168 /* Cast the value to the reference's target type, and then
169 convert it back to a reference. This will issue an error
170 if the value was not previously in memory - in some cases
171 we should clearly be allowing this, but how? */
172 new_value = value_cast (TYPE_TARGET_TYPE (type), arg);
a65cfae5 173 new_value = value_ref (new_value, TYPE_CODE (type));
fb933624
DJ
174 return new_value;
175 }
04714b91
AC
176 case TYPE_CODE_INT:
177 case TYPE_CODE_CHAR:
178 case TYPE_CODE_BOOL:
179 case TYPE_CODE_ENUM:
180 /* If we don't have a prototype, coerce to integer type if necessary. */
181 if (!is_prototyped)
182 {
7788af6d
UW
183 if (TYPE_LENGTH (type) < TYPE_LENGTH (builtin->builtin_int))
184 type = builtin->builtin_int;
04714b91
AC
185 }
186 /* Currently all target ABIs require at least the width of an integer
187 type for an argument. We may have to conditionalize the following
188 type coercion for future targets. */
7788af6d
UW
189 if (TYPE_LENGTH (type) < TYPE_LENGTH (builtin->builtin_int))
190 type = builtin->builtin_int;
04714b91
AC
191 break;
192 case TYPE_CODE_FLT:
193 if (!is_prototyped && coerce_float_to_double_p)
194 {
7788af6d
UW
195 if (TYPE_LENGTH (type) < TYPE_LENGTH (builtin->builtin_double))
196 type = builtin->builtin_double;
197 else if (TYPE_LENGTH (type) > TYPE_LENGTH (builtin->builtin_double))
198 type = builtin->builtin_long_double;
04714b91
AC
199 }
200 break;
201 case TYPE_CODE_FUNC:
202 type = lookup_pointer_type (type);
203 break;
204 case TYPE_CODE_ARRAY:
205 /* Arrays are coerced to pointers to their first element, unless
206 they are vectors, in which case we want to leave them alone,
207 because they are passed by value. */
208 if (current_language->c_style_arrays)
209 if (!TYPE_VECTOR (type))
210 type = lookup_pointer_type (TYPE_TARGET_TYPE (type));
211 break;
212 case TYPE_CODE_UNDEF:
213 case TYPE_CODE_PTR:
214 case TYPE_CODE_STRUCT:
215 case TYPE_CODE_UNION:
216 case TYPE_CODE_VOID:
217 case TYPE_CODE_SET:
218 case TYPE_CODE_RANGE:
219 case TYPE_CODE_STRING:
04714b91 220 case TYPE_CODE_ERROR:
0d5de010
DJ
221 case TYPE_CODE_MEMBERPTR:
222 case TYPE_CODE_METHODPTR:
04714b91
AC
223 case TYPE_CODE_METHOD:
224 case TYPE_CODE_COMPLEX:
225 default:
226 break;
227 }
228
229 return value_cast (type, arg);
230}
231
8388016d 232/* See infcall.h. */
04714b91 233
a9fa03de 234CORE_ADDR
8388016d
PA
235find_function_addr (struct value *function,
236 struct type **retval_type,
237 struct type **function_type)
04714b91 238{
df407dfe 239 struct type *ftype = check_typedef (value_type (function));
50810684 240 struct gdbarch *gdbarch = get_type_arch (ftype);
7788af6d 241 struct type *value_type = NULL;
09b58708
JK
242 /* Initialize it just to avoid a GCC false warning. */
243 CORE_ADDR funaddr = 0;
04714b91
AC
244
245 /* If it's a member function, just look at the function
246 part of it. */
247
248 /* Determine address to call. */
300f8e10
JK
249 if (TYPE_CODE (ftype) == TYPE_CODE_FUNC
250 || TYPE_CODE (ftype) == TYPE_CODE_METHOD)
251 funaddr = value_address (function);
252 else if (TYPE_CODE (ftype) == TYPE_CODE_PTR)
04714b91
AC
253 {
254 funaddr = value_as_address (function);
255 ftype = check_typedef (TYPE_TARGET_TYPE (ftype));
256 if (TYPE_CODE (ftype) == TYPE_CODE_FUNC
257 || TYPE_CODE (ftype) == TYPE_CODE_METHOD)
300f8e10 258 funaddr = gdbarch_convert_from_func_ptr_addr (gdbarch, funaddr,
f6ac5f3d 259 target_stack);
04714b91 260 }
300f8e10
JK
261 if (TYPE_CODE (ftype) == TYPE_CODE_FUNC
262 || TYPE_CODE (ftype) == TYPE_CODE_METHOD)
07be84bf 263 {
07be84bf
JK
264 if (TYPE_GNU_IFUNC (ftype))
265 {
8388016d 266 CORE_ADDR resolver_addr = funaddr;
07be84bf 267
8388016d
PA
268 /* Resolve the ifunc. Note this may call the resolver
269 function in the inferior. */
270 funaddr = gnu_ifunc_resolve_addr (gdbarch, resolver_addr);
271
272 /* Skip querying the function symbol if no RETVAL_TYPE or
273 FUNCTION_TYPE have been asked for. */
274 if (retval_type != NULL || function_type != NULL)
275 {
276 type *target_ftype = find_function_type (funaddr);
277 /* If we don't have debug info for the target function,
278 see if we can instead extract the target function's
279 type from the type that the resolver returns. */
280 if (target_ftype == NULL)
281 target_ftype = find_gnu_ifunc_target_type (resolver_addr);
282 if (target_ftype != NULL)
283 {
284 value_type = TYPE_TARGET_TYPE (check_typedef (target_ftype));
285 ftype = target_ftype;
286 }
287 }
07be84bf 288 }
8388016d
PA
289 else
290 value_type = TYPE_TARGET_TYPE (ftype);
07be84bf 291 }
300f8e10 292 else if (TYPE_CODE (ftype) == TYPE_CODE_INT)
04714b91
AC
293 {
294 /* Handle the case of functions lacking debugging info.
1777feb0 295 Their values are characters since their addresses are char. */
04714b91
AC
296 if (TYPE_LENGTH (ftype) == 1)
297 funaddr = value_as_address (value_addr (function));
298 else
2bbe3cc1
DJ
299 {
300 /* Handle function descriptors lacking debug info. */
301 int found_descriptor = 0;
abbb1732 302
87bc73ea 303 funaddr = 0; /* pacify "gcc -Werror" */
2bbe3cc1
DJ
304 if (VALUE_LVAL (function) == lval_memory)
305 {
306 CORE_ADDR nfunaddr;
abbb1732 307
2bbe3cc1
DJ
308 funaddr = value_as_address (value_addr (function));
309 nfunaddr = funaddr;
50810684 310 funaddr = gdbarch_convert_from_func_ptr_addr (gdbarch, funaddr,
f6ac5f3d 311 target_stack);
2bbe3cc1
DJ
312 if (funaddr != nfunaddr)
313 found_descriptor = 1;
314 }
315 if (!found_descriptor)
316 /* Handle integer used as address of a function. */
317 funaddr = (CORE_ADDR) value_as_long (function);
318 }
04714b91
AC
319 }
320 else
8a3fe4f8 321 error (_("Invalid data type for function to be called."));
04714b91 322
7d9b040b
RC
323 if (retval_type != NULL)
324 *retval_type = value_type;
8388016d
PA
325 if (function_type != NULL)
326 *function_type = ftype;
50810684 327 return funaddr + gdbarch_deprecated_function_start_offset (gdbarch);
04714b91
AC
328}
329
d3712828
AC
330/* For CALL_DUMMY_ON_STACK, push a breakpoint sequence that the called
331 function returns to. */
7043d8dc
AC
332
333static CORE_ADDR
334push_dummy_code (struct gdbarch *gdbarch,
82585c72 335 CORE_ADDR sp, CORE_ADDR funaddr,
7043d8dc
AC
336 struct value **args, int nargs,
337 struct type *value_type,
e4fd649a
UW
338 CORE_ADDR *real_pc, CORE_ADDR *bp_addr,
339 struct regcache *regcache)
7043d8dc 340{
50a834af
MK
341 gdb_assert (gdbarch_push_dummy_code_p (gdbarch));
342
343 return gdbarch_push_dummy_code (gdbarch, sp, funaddr,
344 args, nargs, value_type, real_pc, bp_addr,
345 regcache);
7043d8dc
AC
346}
347
7022349d
PA
348/* See infcall.h. */
349
350void
351error_call_unknown_return_type (const char *func_name)
352{
353 if (func_name != NULL)
354 error (_("'%s' has unknown return type; "
355 "cast the call to its declared return type"),
356 func_name);
357 else
358 error (_("function has unknown return type; "
359 "cast the call to its declared return type"));
360}
361
b89667eb
DE
362/* Fetch the name of the function at FUNADDR.
363 This is used in printing an error message for call_function_by_hand.
364 BUF is used to print FUNADDR in hex if the function name cannot be
365 determined. It must be large enough to hold formatted result of
366 RAW_FUNCTION_ADDRESS_FORMAT. */
367
368static const char *
369get_function_name (CORE_ADDR funaddr, char *buf, int buf_size)
370{
371 {
372 struct symbol *symbol = find_pc_function (funaddr);
abbb1732 373
b89667eb
DE
374 if (symbol)
375 return SYMBOL_PRINT_NAME (symbol);
376 }
377
378 {
379 /* Try the minimal symbols. */
7cbd4a93 380 struct bound_minimal_symbol msymbol = lookup_minimal_symbol_by_pc (funaddr);
abbb1732 381
7cbd4a93 382 if (msymbol.minsym)
efd66ac6 383 return MSYMBOL_PRINT_NAME (msymbol.minsym);
b89667eb
DE
384 }
385
386 {
387 char *tmp = xstrprintf (_(RAW_FUNCTION_ADDRESS_FORMAT),
388 hex_string (funaddr));
abbb1732 389
b89667eb
DE
390 gdb_assert (strlen (tmp) + 1 <= buf_size);
391 strcpy (buf, tmp);
392 xfree (tmp);
393 return buf;
394 }
395}
396
388a7084
PA
397/* All the meta data necessary to extract the call's return value. */
398
399struct call_return_meta_info
400{
401 /* The caller frame's architecture. */
402 struct gdbarch *gdbarch;
403
404 /* The called function. */
405 struct value *function;
406
407 /* The return value's type. */
408 struct type *value_type;
409
410 /* Are we returning a value using a structure return or a normal
411 value return? */
412 int struct_return_p;
413
414 /* If using a structure return, this is the structure's address. */
415 CORE_ADDR struct_addr;
388a7084
PA
416};
417
418/* Extract the called function's return value. */
419
420static struct value *
421get_call_return_value (struct call_return_meta_info *ri)
422{
423 struct value *retval = NULL;
fdf07f3a 424 bool stack_temporaries = thread_stack_temporaries_enabled_p (inferior_ptid);
388a7084
PA
425
426 if (TYPE_CODE (ri->value_type) == TYPE_CODE_VOID)
427 retval = allocate_value (ri->value_type);
428 else if (ri->struct_return_p)
429 {
430 if (stack_temporaries)
431 {
432 retval = value_from_contents_and_address (ri->value_type, NULL,
433 ri->struct_addr);
434 push_thread_stack_temporary (inferior_ptid, retval);
435 }
436 else
437 {
438 retval = allocate_value (ri->value_type);
439 read_value_memory (retval, 0, 1, ri->struct_addr,
440 value_contents_raw (retval),
441 TYPE_LENGTH (ri->value_type));
442 }
443 }
444 else
445 {
446 retval = allocate_value (ri->value_type);
447 gdbarch_return_value (ri->gdbarch, ri->function, ri->value_type,
448 get_current_regcache (),
449 value_contents_raw (retval), NULL);
450 if (stack_temporaries && class_or_union_p (ri->value_type))
451 {
452 /* Values of class type returned in registers are copied onto
453 the stack and their lval_type set to lval_memory. This is
454 required because further evaluation of the expression
455 could potentially invoke methods on the return value
456 requiring GDB to evaluate the "this" pointer. To evaluate
457 the this pointer, GDB needs the memory address of the
458 value. */
459 value_force_lval (retval, ri->struct_addr);
460 push_thread_stack_temporary (inferior_ptid, retval);
461 }
462 }
463
464 gdb_assert (retval != NULL);
465 return retval;
466}
467
468/* Data for the FSM that manages an infcall. It's main job is to
469 record the called function's return value. */
470
471struct call_thread_fsm
472{
473 /* The base class. */
474 struct thread_fsm thread_fsm;
475
476 /* All the info necessary to be able to extract the return
477 value. */
478 struct call_return_meta_info return_meta_info;
479
480 /* The called function's return value. This is extracted from the
481 target before the dummy frame is popped. */
482 struct value *return_value;
3b12939d
PA
483
484 /* The top level that started the infcall (and is synchronously
485 waiting for it to end). */
486 struct ui *waiting_ui;
388a7084
PA
487};
488
8980e177
PA
489static int call_thread_fsm_should_stop (struct thread_fsm *self,
490 struct thread_info *thread);
388a7084
PA
491static int call_thread_fsm_should_notify_stop (struct thread_fsm *self);
492
493/* call_thread_fsm's vtable. */
494
495static struct thread_fsm_ops call_thread_fsm_ops =
496{
497 NULL, /*dtor */
498 NULL, /* clean_up */
499 call_thread_fsm_should_stop,
500 NULL, /* return_value */
501 NULL, /* async_reply_reason*/
502 call_thread_fsm_should_notify_stop,
503};
504
505/* Allocate a new call_thread_fsm object. */
506
507static struct call_thread_fsm *
8980e177 508new_call_thread_fsm (struct ui *waiting_ui, struct interp *cmd_interp,
3b12939d 509 struct gdbarch *gdbarch, struct value *function,
388a7084
PA
510 struct type *value_type,
511 int struct_return_p, CORE_ADDR struct_addr)
512{
513 struct call_thread_fsm *sm;
514
515 sm = XCNEW (struct call_thread_fsm);
8980e177 516 thread_fsm_ctor (&sm->thread_fsm, &call_thread_fsm_ops, cmd_interp);
388a7084
PA
517
518 sm->return_meta_info.gdbarch = gdbarch;
519 sm->return_meta_info.function = function;
520 sm->return_meta_info.value_type = value_type;
521 sm->return_meta_info.struct_return_p = struct_return_p;
522 sm->return_meta_info.struct_addr = struct_addr;
523
3b12939d
PA
524 sm->waiting_ui = waiting_ui;
525
388a7084
PA
526 return sm;
527}
528
529/* Implementation of should_stop method for infcalls. */
530
531static int
8980e177
PA
532call_thread_fsm_should_stop (struct thread_fsm *self,
533 struct thread_info *thread)
388a7084
PA
534{
535 struct call_thread_fsm *f = (struct call_thread_fsm *) self;
536
537 if (stop_stack_dummy == STOP_STACK_DUMMY)
538 {
539 /* Done. */
540 thread_fsm_set_finished (self);
541
542 /* Stash the return value before the dummy frame is popped and
543 registers are restored to what they were before the
544 call.. */
545 f->return_value = get_call_return_value (&f->return_meta_info);
546
547 /* Break out of wait_sync_command_done. */
4b6749b9 548 scoped_restore save_ui = make_scoped_restore (&current_ui, f->waiting_ui);
223ffa71 549 target_terminal::ours ();
3b12939d 550 f->waiting_ui->prompt_state = PROMPT_NEEDED;
388a7084
PA
551 }
552
553 return 1;
554}
555
556/* Implementation of should_notify_stop method for infcalls. */
557
558static int
559call_thread_fsm_should_notify_stop (struct thread_fsm *self)
560{
561 if (thread_fsm_finished_p (self))
562 {
563 /* Infcall succeeded. Be silent and proceed with evaluating the
564 expression. */
565 return 0;
566 }
567
568 /* Something wrong happened. E.g., an unexpected breakpoint
569 triggered, or a signal was intercepted. Notify the stop. */
570 return 1;
571}
572
b89667eb
DE
573/* Subroutine of call_function_by_hand to simplify it.
574 Start up the inferior and wait for it to stop.
575 Return the exception if there's an error, or an exception with
576 reason >= 0 if there's no error.
577
578 This is done inside a TRY_CATCH so the caller needn't worry about
579 thrown errors. The caller should rethrow if there's an error. */
580
581static struct gdb_exception
388a7084
PA
582run_inferior_call (struct call_thread_fsm *sm,
583 struct thread_info *call_thread, CORE_ADDR real_pc)
b89667eb 584{
492d29ea 585 struct gdb_exception caught_error = exception_none;
16c381f0 586 int saved_in_infcall = call_thread->control.in_infcall;
b89667eb 587 ptid_t call_thread_ptid = call_thread->ptid;
3b12939d 588 enum prompt_state saved_prompt_state = current_ui->prompt_state;
28bf096c 589 int was_running = call_thread->state == THREAD_RUNNING;
cb814510 590 int saved_ui_async = current_ui->async;
c933f875
PA
591
592 /* Infcalls run synchronously, in the foreground. */
3b12939d 593 current_ui->prompt_state = PROMPT_BLOCKED;
0b333c5e
PA
594 /* So that we don't print the prompt prematurely in
595 fetch_inferior_event. */
cb814510 596 current_ui->async = 0;
b89667eb 597
6d61dee5
PA
598 delete_file_handler (current_ui->input_fd);
599
16c381f0 600 call_thread->control.in_infcall = 1;
c5a4d20b 601
70509625 602 clear_proceed_status (0);
b89667eb 603
388a7084
PA
604 /* Associate the FSM with the thread after clear_proceed_status
605 (otherwise it'd clear this FSM), and before anything throws, so
606 we don't leak it (and any resources it manages). */
607 call_thread->thread_fsm = &sm->thread_fsm;
608
b89667eb 609 disable_watchpoints_before_interactive_call_start ();
16c381f0 610
46c03469 611 /* We want to print return value, please... */
16c381f0 612 call_thread->control.proceed_to_finish = 1;
b89667eb 613
492d29ea 614 TRY
3dd5b83d 615 {
64ce06e4 616 proceed (real_pc, GDB_SIGNAL_0);
3dd5b83d
PA
617
618 /* Inferior function calls are always synchronous, even if the
0b333c5e
PA
619 target supports asynchronous execution. */
620 wait_sync_command_done ();
3dd5b83d 621 }
492d29ea
PA
622 CATCH (e, RETURN_MASK_ALL)
623 {
624 caught_error = e;
625 }
626 END_CATCH
b89667eb 627
3b12939d
PA
628 /* If GDB has the prompt blocked before, then ensure that it remains
629 so. normal_stop calls async_enable_stdin, so reset the prompt
630 state again here. In other cases, stdin will be re-enabled by
0b333c5e 631 inferior_event_handler, when an exception is thrown. */
3b12939d 632 current_ui->prompt_state = saved_prompt_state;
6d61dee5
PA
633 if (current_ui->prompt_state == PROMPT_BLOCKED)
634 delete_file_handler (current_ui->input_fd);
635 else
636 ui_register_input_event_handler (current_ui);
cb814510 637 current_ui->async = saved_ui_async;
0b333c5e 638
c5a4d20b
PA
639 /* At this point the current thread may have changed. Refresh
640 CALL_THREAD as it could be invalid if its thread has exited. */
e09875d4 641 call_thread = find_thread_ptid (call_thread_ptid);
b89667eb 642
28bf096c
PA
643 /* If the infcall does NOT succeed, normal_stop will have already
644 finished the thread states. However, on success, normal_stop
645 defers here, so that we can set back the thread states to what
646 they were before the call. Note that we must also finish the
647 state of new threads that might have spawned while the call was
648 running. The main cases to handle are:
649
650 - "(gdb) print foo ()", or any other command that evaluates an
651 expression at the prompt. (The thread was marked stopped before.)
652
653 - "(gdb) break foo if return_false()" or similar cases where we
654 do an infcall while handling an event (while the thread is still
655 marked running). In this example, whether the condition
656 evaluates true and thus we'll present a user-visible stop is
657 decided elsewhere. */
658 if (!was_running
659 && ptid_equal (call_thread_ptid, inferior_ptid)
660 && stop_stack_dummy == STOP_STACK_DUMMY)
661 finish_thread_state (user_visible_resume_ptid (0));
662
b89667eb
DE
663 enable_watchpoints_after_interactive_call_stop ();
664
665 /* Call breakpoint_auto_delete on the current contents of the bpstat
666 of inferior call thread.
667 If all error()s out of proceed ended up calling normal_stop
668 (and perhaps they should; it already does in the special case
669 of error out of resume()), then we wouldn't need this. */
492d29ea 670 if (caught_error.reason < 0)
b89667eb 671 {
c5a4d20b 672 if (call_thread != NULL)
16c381f0 673 breakpoint_auto_delete (call_thread->control.stop_bpstat);
b89667eb
DE
674 }
675
c5a4d20b 676 if (call_thread != NULL)
16c381f0 677 call_thread->control.in_infcall = saved_in_infcall;
c5a4d20b 678
492d29ea 679 return caught_error;
b89667eb
DE
680}
681
aa7d318d
TT
682/* A cleanup function that calls delete_std_terminate_breakpoint. */
683static void
684cleanup_delete_std_terminate_breakpoint (void *ignore)
685{
686 delete_std_terminate_breakpoint ();
687}
688
ed12ef62
JK
689/* See infcall.h. */
690
691struct value *
7022349d
PA
692call_function_by_hand (struct value *function,
693 type *default_return_type,
694 int nargs, struct value **args)
ed12ef62 695{
7022349d
PA
696 return call_function_by_hand_dummy (function, default_return_type,
697 nargs, args, NULL, NULL);
ed12ef62
JK
698}
699
04714b91
AC
700/* All this stuff with a dummy frame may seem unnecessarily complicated
701 (why not just save registers in GDB?). The purpose of pushing a dummy
702 frame which looks just like a real frame is so that if you call a
703 function and then hit a breakpoint (get a signal, etc), "backtrace"
704 will look right. Whether the backtrace needs to actually show the
705 stack at the time the inferior function was called is debatable, but
706 it certainly needs to not display garbage. So if you are contemplating
707 making dummy frames be different from normal frames, consider that. */
708
709/* Perform a function call in the inferior.
710 ARGS is a vector of values of arguments (NARGS of them).
711 FUNCTION is a value, the function to be called.
712 Returns a value representing what the function returned.
713 May fail to return, if a breakpoint or signal is hit
714 during the execution of the function.
715
1777feb0 716 ARGS is modified to contain coerced values. */
04714b91
AC
717
718struct value *
ed12ef62 719call_function_by_hand_dummy (struct value *function,
7022349d 720 type *default_return_type,
ed12ef62 721 int nargs, struct value **args,
558e5469 722 dummy_frame_dtor_ftype *dummy_dtor,
ed12ef62 723 void *dummy_dtor_data)
04714b91 724{
52f0bd74 725 CORE_ADDR sp;
8388016d 726 struct type *target_values_type;
18648a37 727 unsigned char struct_return = 0, hidden_first_param_p = 0;
04714b91 728 CORE_ADDR struct_addr = 0;
16c381f0 729 struct infcall_control_state *inf_status;
04714b91 730 struct cleanup *inf_status_cleanup;
16c381f0 731 struct infcall_suspend_state *caller_state;
04714b91 732 CORE_ADDR real_pc;
d585e13a 733 CORE_ADDR bp_addr;
96860204 734 struct frame_id dummy_id;
0b9dfe2b
MD
735 struct frame_info *frame;
736 struct gdbarch *gdbarch;
aa7d318d 737 struct cleanup *terminate_bp_cleanup;
b89667eb
DE
738 ptid_t call_thread_ptid;
739 struct gdb_exception e;
b89667eb 740 char name_buf[RAW_FUNCTION_ADDRESS_SIZE];
fdf07f3a 741 bool stack_temporaries = thread_stack_temporaries_enabled_p (inferior_ptid);
04714b91 742
04714b91
AC
743 if (!target_has_execution)
744 noprocess ();
745
573cda03
SS
746 if (get_traceframe_number () >= 0)
747 error (_("May not call functions while looking at trace frames."));
748
949dc678 749 if (execution_direction == EXEC_REVERSE)
c2949be0 750 error (_("Cannot call functions in reverse mode."));
949dc678 751
0b9dfe2b
MD
752 frame = get_current_frame ();
753 gdbarch = get_frame_arch (frame);
754
755 if (!gdbarch_push_dummy_call_p (gdbarch))
2e74121d 756 error (_("This target does not support function calls."));
a86c5fc9 757
b89667eb
DE
758 /* A cleanup for the inferior status.
759 This is only needed while we're preparing the inferior function call. */
16c381f0
JK
760 inf_status = save_infcall_control_state ();
761 inf_status_cleanup
762 = make_cleanup_restore_infcall_control_state (inf_status);
04714b91 763
b89667eb
DE
764 /* Save the caller's registers and other state associated with the
765 inferior itself so that they can be restored once the
96860204
AC
766 callee returns. To allow nested calls the registers are (further
767 down) pushed onto a dummy frame stack. Include a cleanup (which
768 is tossed once the regcache has been pushed). */
16c381f0
JK
769 caller_state = save_infcall_suspend_state ();
770 make_cleanup_restore_infcall_suspend_state (caller_state);
04714b91 771
04714b91 772 /* Ensure that the initial SP is correctly aligned. */
ebc7896c 773 {
0b9dfe2b 774 CORE_ADDR old_sp = get_frame_sp (frame);
abbb1732 775
0b9dfe2b 776 if (gdbarch_frame_align_p (gdbarch))
ebc7896c 777 {
0b9dfe2b 778 sp = gdbarch_frame_align (gdbarch, old_sp);
8b148df9
AC
779 /* NOTE: cagney/2003-08-13: Skip the "red zone". For some
780 ABIs, a function can use memory beyond the inner most stack
781 address. AMD64 called that region the "red zone". Skip at
782 least the "red zone" size before allocating any space on
783 the stack. */
0b9dfe2b
MD
784 if (gdbarch_inner_than (gdbarch, 1, 2))
785 sp -= gdbarch_frame_red_zone_size (gdbarch);
8b148df9 786 else
0b9dfe2b 787 sp += gdbarch_frame_red_zone_size (gdbarch);
8b148df9 788 /* Still aligned? */
0b9dfe2b 789 gdb_assert (sp == gdbarch_frame_align (gdbarch, sp));
ebc7896c
AC
790 /* NOTE: cagney/2002-09-18:
791
792 On a RISC architecture, a void parameterless generic dummy
793 frame (i.e., no parameters, no result) typically does not
794 need to push anything the stack and hence can leave SP and
c48a845b 795 FP. Similarly, a frameless (possibly leaf) function does
ebc7896c
AC
796 not push anything on the stack and, hence, that too can
797 leave FP and SP unchanged. As a consequence, a sequence of
798 void parameterless generic dummy frame calls to frameless
799 functions will create a sequence of effectively identical
800 frames (SP, FP and TOS and PC the same). This, not
801 suprisingly, results in what appears to be a stack in an
802 infinite loop --- when GDB tries to find a generic dummy
803 frame on the internal dummy frame stack, it will always
804 find the first one.
805
806 To avoid this problem, the code below always grows the
807 stack. That way, two dummy frames can never be identical.
808 It does burn a few bytes of stack but that is a small price
809 to pay :-). */
ebc7896c
AC
810 if (sp == old_sp)
811 {
0b9dfe2b 812 if (gdbarch_inner_than (gdbarch, 1, 2))
ebc7896c 813 /* Stack grows down. */
0b9dfe2b 814 sp = gdbarch_frame_align (gdbarch, old_sp - 1);
ebc7896c
AC
815 else
816 /* Stack grows up. */
0b9dfe2b 817 sp = gdbarch_frame_align (gdbarch, old_sp + 1);
ebc7896c 818 }
0e095b7e
JK
819 /* SP may have underflown address zero here from OLD_SP. Memory access
820 functions will probably fail in such case but that is a target's
821 problem. */
ebc7896c
AC
822 }
823 else
a59fe496
AC
824 /* FIXME: cagney/2002-09-18: Hey, you loose!
825
8b148df9
AC
826 Who knows how badly aligned the SP is!
827
828 If the generic dummy frame ends up empty (because nothing is
829 pushed) GDB won't be able to correctly perform back traces.
830 If a target is having trouble with backtraces, first thing to
1777feb0 831 do is add FRAME_ALIGN() to the architecture vector. If that
669fac23 832 fails, try dummy_id().
8b148df9
AC
833
834 If the ABI specifies a "Red Zone" (see the doco) the code
835 below will quietly trash it. */
ebc7896c 836 sp = old_sp;
6c659fc2
SC
837
838 /* Skip over the stack temporaries that might have been generated during
839 the evaluation of an expression. */
840 if (stack_temporaries)
841 {
842 struct value *lastval;
843
844 lastval = get_last_thread_stack_temporary (inferior_ptid);
845 if (lastval != NULL)
846 {
847 CORE_ADDR lastval_addr = value_address (lastval);
848
849 if (gdbarch_inner_than (gdbarch, 1, 2))
850 {
851 gdb_assert (sp >= lastval_addr);
852 sp = lastval_addr;
853 }
854 else
855 {
856 gdb_assert (sp <= lastval_addr);
857 sp = lastval_addr + TYPE_LENGTH (value_type (lastval));
858 }
859
860 if (gdbarch_frame_align_p (gdbarch))
861 sp = gdbarch_frame_align (gdbarch, sp);
862 }
863 }
ebc7896c 864 }
04714b91 865
8388016d
PA
866 type *ftype;
867 type *values_type;
868 CORE_ADDR funaddr = find_function_addr (function, &values_type, &ftype);
869
7022349d
PA
870 if (values_type == NULL)
871 values_type = default_return_type;
872 if (values_type == NULL)
873 {
874 const char *name = get_function_name (funaddr,
875 name_buf, sizeof (name_buf));
876 error (_("'%s' has unknown return type; "
877 "cast the call to its declared return type"),
878 name);
879 }
7788af6d 880
f168693b 881 values_type = check_typedef (values_type);
04714b91 882
41f1b697
DJ
883 /* Are we returning a value using a structure return (passing a
884 hidden argument pointing to storage) or a normal value return?
885 There are two cases: language-mandated structure return and
886 target ABI structure return. The variable STRUCT_RETURN only
887 describes the latter. The language version is handled by passing
888 the return location as the first parameter to the function,
889 even preceding "this". This is different from the target
890 ABI version, which is target-specific; for instance, on ia64
891 the first argument is passed in out0 but the hidden structure
892 return pointer would normally be passed in r8. */
893
18648a37 894 if (gdbarch_return_in_first_hidden_param_p (gdbarch, values_type))
41f1b697 895 {
18648a37 896 hidden_first_param_p = 1;
04714b91 897
41f1b697
DJ
898 /* Tell the target specific argument pushing routine not to
899 expect a value. */
48319d1f 900 target_values_type = builtin_type (gdbarch)->builtin_void;
41f1b697
DJ
901 }
902 else
903 {
6a3a010b 904 struct_return = using_struct_return (gdbarch, function, values_type);
41f1b697
DJ
905 target_values_type = values_type;
906 }
04714b91 907
76727919 908 gdb::observers::inferior_call_pre.notify (inferior_ptid, funaddr);
162078c8 909
7043d8dc
AC
910 /* Determine the location of the breakpoint (and possibly other
911 stuff) that the called function will return to. The SPARC, for a
912 function returning a structure or union, needs to make space for
913 not just the breakpoint but also an extra word containing the
914 size (?) of the structure being passed. */
915
0b9dfe2b 916 switch (gdbarch_call_dummy_location (gdbarch))
04714b91
AC
917 {
918 case ON_STACK:
a14dd77e
JK
919 {
920 const gdb_byte *bp_bytes;
921 CORE_ADDR bp_addr_as_address;
922 int bp_size;
923
924 /* Be careful BP_ADDR is in inferior PC encoding while
925 BP_ADDR_AS_ADDRESS is a plain memory address. */
926
927 sp = push_dummy_code (gdbarch, sp, funaddr, args, nargs,
928 target_values_type, &real_pc, &bp_addr,
929 get_current_regcache ());
930
931 /* Write a legitimate instruction at the point where the infcall
932 breakpoint is going to be inserted. While this instruction
933 is never going to be executed, a user investigating the
934 memory from GDB would see this instruction instead of random
935 uninitialized bytes. We chose the breakpoint instruction
936 as it may look as the most logical one to the user and also
937 valgrind 3.7.0 needs it for proper vgdb inferior calls.
938
939 If software breakpoints are unsupported for this target we
940 leave the user visible memory content uninitialized. */
941
942 bp_addr_as_address = bp_addr;
943 bp_bytes = gdbarch_breakpoint_from_pc (gdbarch, &bp_addr_as_address,
944 &bp_size);
945 if (bp_bytes != NULL)
946 write_memory (bp_addr_as_address, bp_bytes, bp_size);
947 }
7043d8dc 948 break;
5931a2fa
JK
949 case AT_ENTRY_POINT:
950 {
951 CORE_ADDR dummy_addr;
952
953 real_pc = funaddr;
954 dummy_addr = entry_point_address ();
a14dd77e 955
5931a2fa 956 /* A call dummy always consists of just a single breakpoint, so
a14dd77e
JK
957 its address is the same as the address of the dummy.
958
959 The actual breakpoint is inserted separatly so there is no need to
960 write that out. */
5931a2fa
JK
961 bp_addr = dummy_addr;
962 break;
963 }
04714b91 964 default:
e2e0b3e5 965 internal_error (__FILE__, __LINE__, _("bad switch"));
04714b91
AC
966 }
967
04714b91 968 if (nargs < TYPE_NFIELDS (ftype))
2e74121d 969 error (_("Too few arguments in function call."));
04714b91 970
ebc7896c
AC
971 {
972 int i;
abbb1732 973
ebc7896c
AC
974 for (i = nargs - 1; i >= 0; i--)
975 {
976 int prototyped;
977 struct type *param_type;
978
979 /* FIXME drow/2002-05-31: Should just always mark methods as
980 prototyped. Can we respect TYPE_VARARGS? Probably not. */
981 if (TYPE_CODE (ftype) == TYPE_CODE_METHOD)
982 prototyped = 1;
7022349d
PA
983 if (TYPE_TARGET_TYPE (ftype) == NULL && TYPE_NFIELDS (ftype) == 0
984 && default_return_type != NULL)
985 {
986 /* Calling a no-debug function with the return type
987 explicitly cast. Assume the function is prototyped,
988 with a prototype matching the types of the arguments.
989 E.g., with:
990 float mult (float v1, float v2) { return v1 * v2; }
991 This:
992 (gdb) p (float) mult (2.0f, 3.0f)
993 Is a simpler alternative to:
994 (gdb) p ((float (*) (float, float)) mult) (2.0f, 3.0f)
995 */
996 prototyped = 1;
997 }
ebc7896c
AC
998 else if (i < TYPE_NFIELDS (ftype))
999 prototyped = TYPE_PROTOTYPED (ftype);
1000 else
1001 prototyped = 0;
1002
1003 if (i < TYPE_NFIELDS (ftype))
1004 param_type = TYPE_FIELD_TYPE (ftype, i);
1005 else
1006 param_type = NULL;
41f1b697 1007
7788af6d
UW
1008 args[i] = value_arg_coerce (gdbarch, args[i],
1009 param_type, prototyped, &sp);
ebc7896c 1010
41f1b697
DJ
1011 if (param_type != NULL && language_pass_by_reference (param_type))
1012 args[i] = value_addr (args[i]);
ebc7896c
AC
1013 }
1014 }
04714b91 1015
04714b91
AC
1016 /* Reserve space for the return structure to be written on the
1017 stack, if necessary. Make certain that the value is correctly
6c659fc2
SC
1018 aligned.
1019
1020 While evaluating expressions, we reserve space on the stack for
1021 return values of class type even if the language ABI and the target
1022 ABI do not require that the return value be passed as a hidden first
1023 argument. This is because we want to store the return value as an
1024 on-stack temporary while the expression is being evaluated. This
1025 enables us to have chained function calls in expressions.
04714b91 1026
6c659fc2
SC
1027 Keeping the return values as on-stack temporaries while the expression
1028 is being evaluated is OK because the thread is stopped until the
1029 expression is completely evaluated. */
1030
1031 if (struct_return || hidden_first_param_p
1032 || (stack_temporaries && class_or_union_p (values_type)))
04714b91 1033 {
0b9dfe2b 1034 if (gdbarch_inner_than (gdbarch, 1, 2))
04714b91
AC
1035 {
1036 /* Stack grows downward. Align STRUCT_ADDR and SP after
1037 making space for the return value. */
744a8059 1038 sp -= TYPE_LENGTH (values_type);
0b9dfe2b
MD
1039 if (gdbarch_frame_align_p (gdbarch))
1040 sp = gdbarch_frame_align (gdbarch, sp);
04714b91
AC
1041 struct_addr = sp;
1042 }
1043 else
1044 {
1045 /* Stack grows upward. Align the frame, allocate space, and
1777feb0 1046 then again, re-align the frame??? */
0b9dfe2b
MD
1047 if (gdbarch_frame_align_p (gdbarch))
1048 sp = gdbarch_frame_align (gdbarch, sp);
04714b91 1049 struct_addr = sp;
744a8059 1050 sp += TYPE_LENGTH (values_type);
0b9dfe2b
MD
1051 if (gdbarch_frame_align_p (gdbarch))
1052 sp = gdbarch_frame_align (gdbarch, sp);
04714b91
AC
1053 }
1054 }
1055
6ccb583f 1056 std::vector<struct value *> new_args;
18648a37 1057 if (hidden_first_param_p)
41f1b697 1058 {
41f1b697 1059 /* Add the new argument to the front of the argument list. */
6ccb583f
TT
1060 new_args.push_back
1061 (value_from_pointer (lookup_pointer_type (values_type), struct_addr));
1062 std::copy (&args[0], &args[nargs], std::back_inserter (new_args));
1063 args = new_args.data ();
41f1b697 1064 nargs++;
41f1b697 1065 }
41f1b697 1066
04714b91
AC
1067 /* Create the dummy stack frame. Pass in the call dummy address as,
1068 presumably, the ABI code knows where, in the call dummy, the
1069 return address should be pointed. */
0b9dfe2b
MD
1070 sp = gdbarch_push_dummy_call (gdbarch, function, get_current_regcache (),
1071 bp_addr, nargs, args,
594f7785 1072 sp, struct_return, struct_addr);
04714b91 1073
96860204
AC
1074 /* Set up a frame ID for the dummy frame so we can pass it to
1075 set_momentary_breakpoint. We need to give the breakpoint a frame
1076 ID so that the breakpoint code can correctly re-identify the
1077 dummy breakpoint. */
8241eaa6 1078 /* Sanity. The exact same SP value is returned by PUSH_DUMMY_CALL,
669fac23 1079 saved as the dummy-frame TOS, and used by dummy_id to form
8241eaa6 1080 the frame ID's stack address. */
96860204 1081 dummy_id = frame_id_build (sp, bp_addr);
04714b91 1082
74cfe982
AC
1083 /* Create a momentary breakpoint at the return address of the
1084 inferior. That way it breaks when it returns. */
04714b91 1085
74cfe982 1086 {
51abb421 1087 symtab_and_line sal;
6c95b8df 1088 sal.pspace = current_program_space;
74cfe982
AC
1089 sal.pc = bp_addr;
1090 sal.section = find_pc_overlay (sal.pc);
51abb421 1091
8241eaa6
AC
1092 /* Sanity. The exact same SP value is returned by
1093 PUSH_DUMMY_CALL, saved as the dummy-frame TOS, and used by
669fac23 1094 dummy_id to form the frame ID's stack address. */
454dafbd
TT
1095 breakpoint *bpt
1096 = set_momentary_breakpoint (gdbarch, sal,
1097 dummy_id, bp_call_dummy).release ();
c70a6932
JK
1098
1099 /* set_momentary_breakpoint invalidates FRAME. */
1100 frame = NULL;
1101
74cfe982 1102 bpt->disposition = disp_del;
e2e4d78b
JK
1103 gdb_assert (bpt->related_breakpoint == bpt);
1104
51abb421 1105 breakpoint *longjmp_b = set_longjmp_breakpoint_for_call_dummy ();
e2e4d78b
JK
1106 if (longjmp_b)
1107 {
1108 /* Link BPT into the chain of LONGJMP_B. */
1109 bpt->related_breakpoint = longjmp_b;
1110 while (longjmp_b->related_breakpoint != bpt->related_breakpoint)
1111 longjmp_b = longjmp_b->related_breakpoint;
1112 longjmp_b->related_breakpoint = bpt;
1113 }
74cfe982 1114 }
04714b91 1115
7cd1089b
PM
1116 /* Create a breakpoint in std::terminate.
1117 If a C++ exception is raised in the dummy-frame, and the
1118 exception handler is (normally, and expected to be) out-of-frame,
1119 the default C++ handler will (wrongly) be called in an inferior
1120 function call. This is wrong, as an exception can be normally
1121 and legally handled out-of-frame. The confines of the dummy frame
1122 prevent the unwinder from finding the correct handler (or any
1123 handler, unless it is in-frame). The default handler calls
1124 std::terminate. This will kill the inferior. Assert that
1125 terminate should never be called in an inferior function
1126 call. Place a momentary breakpoint in the std::terminate function
1127 and if triggered in the call, rewind. */
1128 if (unwind_on_terminating_exception_p)
aa7d318d 1129 set_std_terminate_breakpoint ();
7cd1089b 1130
8a6c4031
JK
1131 /* Discard both inf_status and caller_state cleanups.
1132 From this point on we explicitly restore the associated state
1133 or discard it. */
1134 discard_cleanups (inf_status_cleanup);
1135
96860204
AC
1136 /* Everything's ready, push all the info needed to restore the
1137 caller (and identify the dummy-frame) onto the dummy-frame
1138 stack. */
b67a2c6f 1139 dummy_frame_push (caller_state, &dummy_id, inferior_ptid);
ed12ef62
JK
1140 if (dummy_dtor != NULL)
1141 register_dummy_frame_dtor (dummy_id, inferior_ptid,
1142 dummy_dtor, dummy_dtor_data);
b89667eb 1143
7cd1089b 1144 /* Register a clean-up for unwind_on_terminating_exception_breakpoint. */
aa7d318d
TT
1145 terminate_bp_cleanup = make_cleanup (cleanup_delete_std_terminate_breakpoint,
1146 NULL);
7cd1089b 1147
96860204
AC
1148 /* - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP -
1149 If you're looking to implement asynchronous dummy-frames, then
1150 just below is the place to chop this function in two.. */
1151
b89667eb
DE
1152 /* TP is invalid after run_inferior_call returns, so enclose this
1153 in a block so that it's only in scope during the time it's valid. */
74cfe982 1154 {
32400beb 1155 struct thread_info *tp = inferior_thread ();
388a7084
PA
1156 struct thread_fsm *saved_sm;
1157 struct call_thread_fsm *sm;
1158
1159 /* Save the current FSM. We'll override it. */
1160 saved_sm = tp->thread_fsm;
1161 tp->thread_fsm = NULL;
74cfe982 1162
b89667eb
DE
1163 /* Save this thread's ptid, we need it later but the thread
1164 may have exited. */
1165 call_thread_ptid = tp->ptid;
74cfe982 1166
b89667eb 1167 /* Run the inferior until it stops. */
f5871ec0 1168
388a7084
PA
1169 /* Create the FSM used to manage the infcall. It tells infrun to
1170 not report the stop to the user, and captures the return value
1171 before the dummy frame is popped. run_inferior_call registers
1172 it with the thread ASAP. */
8980e177 1173 sm = new_call_thread_fsm (current_ui, command_interp (),
3b12939d 1174 gdbarch, function,
388a7084
PA
1175 values_type,
1176 struct_return || hidden_first_param_p,
1177 struct_addr);
1178
1179 e = run_inferior_call (sm, tp, real_pc);
1180
76727919 1181 gdb::observers::inferior_call_post.notify (call_thread_ptid, funaddr);
388a7084
PA
1182
1183 tp = find_thread_ptid (call_thread_ptid);
1184 if (tp != NULL)
1185 {
1186 /* The FSM should still be the same. */
1187 gdb_assert (tp->thread_fsm == &sm->thread_fsm);
1188
1189 if (thread_fsm_finished_p (tp->thread_fsm))
1190 {
1191 struct value *retval;
1192
1193 /* The inferior call is successful. Pop the dummy frame,
1194 which runs its destructors and restores the inferior's
1195 suspend state, and restore the inferior control
1196 state. */
1197 dummy_frame_pop (dummy_id, call_thread_ptid);
1198 restore_infcall_control_state (inf_status);
1199
1200 /* Get the return value. */
1201 retval = sm->return_value;
1202
1203 /* Clean up / destroy the call FSM, and restore the
1204 original one. */
8980e177 1205 thread_fsm_clean_up (tp->thread_fsm, tp);
388a7084
PA
1206 thread_fsm_delete (tp->thread_fsm);
1207 tp->thread_fsm = saved_sm;
04714b91 1208
388a7084
PA
1209 maybe_remove_breakpoints ();
1210
1211 do_cleanups (terminate_bp_cleanup);
1212 gdb_assert (retval != NULL);
1213 return retval;
1214 }
1215
1216 /* Didn't complete. Restore previous state machine, and
1217 handle the error. */
1218 tp->thread_fsm = saved_sm;
1219 }
1220 }
162078c8 1221
b89667eb
DE
1222 /* Rethrow an error if we got one trying to run the inferior. */
1223
1224 if (e.reason < 0)
1225 {
1226 const char *name = get_function_name (funaddr,
1227 name_buf, sizeof (name_buf));
1228
16c381f0 1229 discard_infcall_control_state (inf_status);
b89667eb
DE
1230
1231 /* We could discard the dummy frame here if the program exited,
1232 but it will get garbage collected the next time the program is
1233 run anyway. */
1234
1235 switch (e.reason)
1236 {
1237 case RETURN_ERROR:
ac74f770
MS
1238 throw_error (e.error, _("%s\n\
1239An error occurred while in a function called from GDB.\n\
1240Evaluation of the expression containing the function\n\
1241(%s) will be abandoned.\n\
1242When the function is done executing, GDB will silently stop."),
b89667eb
DE
1243 e.message, name);
1244 case RETURN_QUIT:
1245 default:
1246 throw_exception (e);
1247 }
1248 }
1249
1250 /* If the program has exited, or we stopped at a different thread,
1251 exit and inform the user. */
1252
de04a248
DE
1253 if (! target_has_execution)
1254 {
b89667eb
DE
1255 const char *name = get_function_name (funaddr,
1256 name_buf, sizeof (name_buf));
1257
1258 /* If we try to restore the inferior status,
de04a248 1259 we'll crash as the inferior is no longer running. */
16c381f0 1260 discard_infcall_control_state (inf_status);
b89667eb
DE
1261
1262 /* We could discard the dummy frame here given that the program exited,
1263 but it will get garbage collected the next time the program is
1264 run anyway. */
1265
3e43a32a
MS
1266 error (_("The program being debugged exited while in a function "
1267 "called from GDB.\n"
1268 "Evaluation of the expression containing the function\n"
1269 "(%s) will be abandoned."),
b89667eb
DE
1270 name);
1271 }
1272
1273 if (! ptid_equal (call_thread_ptid, inferior_ptid))
1274 {
1275 const char *name = get_function_name (funaddr,
1276 name_buf, sizeof (name_buf));
1277
1278 /* We've switched threads. This can happen if another thread gets a
1279 signal or breakpoint while our thread was running.
1280 There's no point in restoring the inferior status,
1281 we're in a different thread. */
16c381f0 1282 discard_infcall_control_state (inf_status);
b89667eb
DE
1283 /* Keep the dummy frame record, if the user switches back to the
1284 thread with the hand-call, we'll need it. */
1285 if (stopped_by_random_signal)
ac74f770
MS
1286 error (_("\
1287The program received a signal in another thread while\n\
1288making a function call from GDB.\n\
1289Evaluation of the expression containing the function\n\
1290(%s) will be abandoned.\n\
1291When the function is done executing, GDB will silently stop."),
b89667eb
DE
1292 name);
1293 else
ac74f770
MS
1294 error (_("\
1295The program stopped in another thread while making a function call from GDB.\n\
1296Evaluation of the expression containing the function\n\
1297(%s) will be abandoned.\n\
1298When the function is done executing, GDB will silently stop."),
b89667eb 1299 name);
de04a248
DE
1300 }
1301
52557533 1302 {
5fe75eec 1303 /* Make a copy as NAME may be in an objfile freed by dummy_frame_pop. */
395423c4
TT
1304 std::string name = get_function_name (funaddr, name_buf,
1305 sizeof (name_buf));
b89667eb 1306
52557533
AC
1307 if (stopped_by_random_signal)
1308 {
1309 /* We stopped inside the FUNCTION because of a random
1310 signal. Further execution of the FUNCTION is not
1777feb0 1311 allowed. */
04714b91 1312
52557533
AC
1313 if (unwind_on_signal_p)
1314 {
1777feb0 1315 /* The user wants the context restored. */
52557533
AC
1316
1317 /* We must get back to the frame we were before the
b89667eb 1318 dummy call. */
b67a2c6f 1319 dummy_frame_pop (dummy_id, call_thread_ptid);
b89667eb
DE
1320
1321 /* We also need to restore inferior status to that before the
1322 dummy call. */
16c381f0 1323 restore_infcall_control_state (inf_status);
04714b91 1324
52557533
AC
1325 /* FIXME: Insert a bunch of wrap_here; name can be very
1326 long if it's a C++ name with arguments and stuff. */
ac74f770
MS
1327 error (_("\
1328The program being debugged was signaled while in a function called from GDB.\n\
1329GDB has restored the context to what it was before the call.\n\
1330To change this behavior use \"set unwindonsignal off\".\n\
1331Evaluation of the expression containing the function\n\
1332(%s) will be abandoned."),
395423c4 1333 name.c_str ());
52557533
AC
1334 }
1335 else
1336 {
1337 /* The user wants to stay in the frame where we stopped
b89667eb
DE
1338 (default).
1339 Discard inferior status, we're not at the same point
1340 we started at. */
16c381f0 1341 discard_infcall_control_state (inf_status);
b89667eb 1342
52557533
AC
1343 /* FIXME: Insert a bunch of wrap_here; name can be very
1344 long if it's a C++ name with arguments and stuff. */
ac74f770
MS
1345 error (_("\
1346The program being debugged was signaled while in a function called from GDB.\n\
1347GDB remains in the frame where the signal was received.\n\
1348To change this behavior use \"set unwindonsignal on\".\n\
1349Evaluation of the expression containing the function\n\
1350(%s) will be abandoned.\n\
1351When the function is done executing, GDB will silently stop."),
395423c4 1352 name.c_str ());
52557533
AC
1353 }
1354 }
04714b91 1355
aa7d318d 1356 if (stop_stack_dummy == STOP_STD_TERMINATE)
52557533 1357 {
aa7d318d
TT
1358 /* We must get back to the frame we were before the dummy
1359 call. */
b67a2c6f 1360 dummy_frame_pop (dummy_id, call_thread_ptid);
7cd1089b 1361
aa7d318d
TT
1362 /* We also need to restore inferior status to that before
1363 the dummy call. */
16c381f0 1364 restore_infcall_control_state (inf_status);
aa7d318d 1365
ac74f770
MS
1366 error (_("\
1367The program being debugged entered a std::terminate call, most likely\n\
1368caused by an unhandled C++ exception. GDB blocked this call in order\n\
1369to prevent the program from being terminated, and has restored the\n\
1370context to its original state before the call.\n\
1371To change this behaviour use \"set unwind-on-terminating-exception off\".\n\
1372Evaluation of the expression containing the function (%s)\n\
1373will be abandoned."),
395423c4 1374 name.c_str ());
aa7d318d
TT
1375 }
1376 else if (stop_stack_dummy == STOP_NONE)
1377 {
1378
b89667eb
DE
1379 /* We hit a breakpoint inside the FUNCTION.
1380 Keep the dummy frame, the user may want to examine its state.
1381 Discard inferior status, we're not at the same point
1382 we started at. */
16c381f0 1383 discard_infcall_control_state (inf_status);
b89667eb 1384
52557533
AC
1385 /* The following error message used to say "The expression
1386 which contained the function call has been discarded."
1387 It is a hard concept to explain in a few words. Ideally,
1388 GDB would be able to resume evaluation of the expression
1389 when the function finally is done executing. Perhaps
1390 someday this will be implemented (it would not be easy). */
1391 /* FIXME: Insert a bunch of wrap_here; name can be very long if it's
1392 a C++ name with arguments and stuff. */
ac74f770
MS
1393 error (_("\
1394The program being debugged stopped while in a function called from GDB.\n\
1395Evaluation of the expression containing the function\n\
1396(%s) will be abandoned.\n\
1397When the function is done executing, GDB will silently stop."),
395423c4 1398 name.c_str ());
52557533
AC
1399 }
1400
52557533 1401 }
04714b91 1402
388a7084
PA
1403 /* The above code errors out, so ... */
1404 gdb_assert_not_reached ("... should not be here");
04714b91 1405}
04714b91
AC
1406
1407void
1408_initialize_infcall (void)
1409{
1410 add_setshow_boolean_cmd ("coerce-float-to-double", class_obscure,
7915a72c
AC
1411 &coerce_float_to_double_p, _("\
1412Set coercion of floats to doubles when calling functions."), _("\
1413Show coercion of floats to doubles when calling functions"), _("\
04714b91
AC
1414Variables of type float should generally be converted to doubles before\n\
1415calling an unprototyped function, and left alone when calling a prototyped\n\
1416function. However, some older debug info formats do not provide enough\n\
1417information to determine that a function is prototyped. If this flag is\n\
1418set, GDB will perform the conversion for a function it considers\n\
1419unprototyped.\n\
7915a72c 1420The default is to perform the conversion.\n"),
2c5b56ce 1421 NULL,
920d2a44 1422 show_coerce_float_to_double_p,
2c5b56ce 1423 &setlist, &showlist);
04714b91
AC
1424
1425 add_setshow_boolean_cmd ("unwindonsignal", no_class,
7915a72c
AC
1426 &unwind_on_signal_p, _("\
1427Set unwinding of stack if a signal is received while in a call dummy."), _("\
1428Show unwinding of stack if a signal is received while in a call dummy."), _("\
04714b91
AC
1429The unwindonsignal lets the user determine what gdb should do if a signal\n\
1430is received while in a function called from gdb (call dummy). If set, gdb\n\
1431unwinds the stack and restore the context to what as it was before the call.\n\
7915a72c 1432The default is to stop in the frame where the signal was received."),
2c5b56ce 1433 NULL,
920d2a44 1434 show_unwind_on_signal_p,
2c5b56ce 1435 &setlist, &showlist);
7cd1089b
PM
1436
1437 add_setshow_boolean_cmd ("unwind-on-terminating-exception", no_class,
1438 &unwind_on_terminating_exception_p, _("\
1439Set unwinding of stack if std::terminate is called while in call dummy."), _("\
3e43a32a
MS
1440Show unwinding of stack if std::terminate() is called while in a call dummy."),
1441 _("\
7cd1089b
PM
1442The unwind on terminating exception flag lets the user determine\n\
1443what gdb should do if a std::terminate() call is made from the\n\
1444default exception handler. If set, gdb unwinds the stack and restores\n\
1445the context to what it was before the call. If unset, gdb allows the\n\
1446std::terminate call to proceed.\n\
1447The default is to unwind the frame."),
1448 NULL,
1449 show_unwind_on_terminating_exception_p,
1450 &setlist, &showlist);
1451
04714b91 1452}
This page took 1.30274 seconds and 4 git commands to generate.