Simple unused variable removals
[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,
8b88a78e 259 current_top_target ());
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;
8b88a78e
PA
310 funaddr
311 = gdbarch_convert_from_func_ptr_addr (gdbarch, funaddr,
312 current_top_target ());
2bbe3cc1
DJ
313 if (funaddr != nfunaddr)
314 found_descriptor = 1;
315 }
316 if (!found_descriptor)
317 /* Handle integer used as address of a function. */
318 funaddr = (CORE_ADDR) value_as_long (function);
319 }
04714b91
AC
320 }
321 else
8a3fe4f8 322 error (_("Invalid data type for function to be called."));
04714b91 323
7d9b040b
RC
324 if (retval_type != NULL)
325 *retval_type = value_type;
8388016d
PA
326 if (function_type != NULL)
327 *function_type = ftype;
50810684 328 return funaddr + gdbarch_deprecated_function_start_offset (gdbarch);
04714b91
AC
329}
330
d3712828
AC
331/* For CALL_DUMMY_ON_STACK, push a breakpoint sequence that the called
332 function returns to. */
7043d8dc
AC
333
334static CORE_ADDR
335push_dummy_code (struct gdbarch *gdbarch,
82585c72 336 CORE_ADDR sp, CORE_ADDR funaddr,
7043d8dc
AC
337 struct value **args, int nargs,
338 struct type *value_type,
e4fd649a
UW
339 CORE_ADDR *real_pc, CORE_ADDR *bp_addr,
340 struct regcache *regcache)
7043d8dc 341{
50a834af
MK
342 gdb_assert (gdbarch_push_dummy_code_p (gdbarch));
343
344 return gdbarch_push_dummy_code (gdbarch, sp, funaddr,
345 args, nargs, value_type, real_pc, bp_addr,
346 regcache);
7043d8dc
AC
347}
348
7022349d
PA
349/* See infcall.h. */
350
351void
352error_call_unknown_return_type (const char *func_name)
353{
354 if (func_name != NULL)
355 error (_("'%s' has unknown return type; "
356 "cast the call to its declared return type"),
357 func_name);
358 else
359 error (_("function has unknown return type; "
360 "cast the call to its declared return type"));
361}
362
b89667eb
DE
363/* Fetch the name of the function at FUNADDR.
364 This is used in printing an error message for call_function_by_hand.
365 BUF is used to print FUNADDR in hex if the function name cannot be
366 determined. It must be large enough to hold formatted result of
367 RAW_FUNCTION_ADDRESS_FORMAT. */
368
369static const char *
370get_function_name (CORE_ADDR funaddr, char *buf, int buf_size)
371{
372 {
373 struct symbol *symbol = find_pc_function (funaddr);
abbb1732 374
b89667eb
DE
375 if (symbol)
376 return SYMBOL_PRINT_NAME (symbol);
377 }
378
379 {
380 /* Try the minimal symbols. */
7cbd4a93 381 struct bound_minimal_symbol msymbol = lookup_minimal_symbol_by_pc (funaddr);
abbb1732 382
7cbd4a93 383 if (msymbol.minsym)
efd66ac6 384 return MSYMBOL_PRINT_NAME (msymbol.minsym);
b89667eb
DE
385 }
386
387 {
388 char *tmp = xstrprintf (_(RAW_FUNCTION_ADDRESS_FORMAT),
389 hex_string (funaddr));
abbb1732 390
b89667eb
DE
391 gdb_assert (strlen (tmp) + 1 <= buf_size);
392 strcpy (buf, tmp);
393 xfree (tmp);
394 return buf;
395 }
396}
397
388a7084
PA
398/* All the meta data necessary to extract the call's return value. */
399
400struct call_return_meta_info
401{
402 /* The caller frame's architecture. */
403 struct gdbarch *gdbarch;
404
405 /* The called function. */
406 struct value *function;
407
408 /* The return value's type. */
409 struct type *value_type;
410
411 /* Are we returning a value using a structure return or a normal
412 value return? */
413 int struct_return_p;
414
415 /* If using a structure return, this is the structure's address. */
416 CORE_ADDR struct_addr;
388a7084
PA
417};
418
419/* Extract the called function's return value. */
420
421static struct value *
422get_call_return_value (struct call_return_meta_info *ri)
423{
424 struct value *retval = NULL;
00431a78
PA
425 thread_info *thr = inferior_thread ();
426 bool stack_temporaries = thread_stack_temporaries_enabled_p (thr);
388a7084
PA
427
428 if (TYPE_CODE (ri->value_type) == TYPE_CODE_VOID)
429 retval = allocate_value (ri->value_type);
430 else if (ri->struct_return_p)
431 {
432 if (stack_temporaries)
433 {
434 retval = value_from_contents_and_address (ri->value_type, NULL,
435 ri->struct_addr);
00431a78 436 push_thread_stack_temporary (thr, retval);
388a7084
PA
437 }
438 else
439 {
440 retval = allocate_value (ri->value_type);
441 read_value_memory (retval, 0, 1, ri->struct_addr,
442 value_contents_raw (retval),
443 TYPE_LENGTH (ri->value_type));
444 }
445 }
446 else
447 {
448 retval = allocate_value (ri->value_type);
449 gdbarch_return_value (ri->gdbarch, ri->function, ri->value_type,
450 get_current_regcache (),
451 value_contents_raw (retval), NULL);
452 if (stack_temporaries && class_or_union_p (ri->value_type))
453 {
454 /* Values of class type returned in registers are copied onto
455 the stack and their lval_type set to lval_memory. This is
456 required because further evaluation of the expression
457 could potentially invoke methods on the return value
458 requiring GDB to evaluate the "this" pointer. To evaluate
459 the this pointer, GDB needs the memory address of the
460 value. */
461 value_force_lval (retval, ri->struct_addr);
00431a78 462 push_thread_stack_temporary (thr, retval);
388a7084
PA
463 }
464 }
465
466 gdb_assert (retval != NULL);
467 return retval;
468}
469
470/* Data for the FSM that manages an infcall. It's main job is to
471 record the called function's return value. */
472
473struct call_thread_fsm
474{
475 /* The base class. */
476 struct thread_fsm thread_fsm;
477
478 /* All the info necessary to be able to extract the return
479 value. */
480 struct call_return_meta_info return_meta_info;
481
482 /* The called function's return value. This is extracted from the
483 target before the dummy frame is popped. */
484 struct value *return_value;
3b12939d
PA
485
486 /* The top level that started the infcall (and is synchronously
487 waiting for it to end). */
488 struct ui *waiting_ui;
388a7084
PA
489};
490
8980e177
PA
491static int call_thread_fsm_should_stop (struct thread_fsm *self,
492 struct thread_info *thread);
388a7084
PA
493static int call_thread_fsm_should_notify_stop (struct thread_fsm *self);
494
495/* call_thread_fsm's vtable. */
496
497static struct thread_fsm_ops call_thread_fsm_ops =
498{
499 NULL, /*dtor */
500 NULL, /* clean_up */
501 call_thread_fsm_should_stop,
502 NULL, /* return_value */
503 NULL, /* async_reply_reason*/
504 call_thread_fsm_should_notify_stop,
505};
506
507/* Allocate a new call_thread_fsm object. */
508
509static struct call_thread_fsm *
8980e177 510new_call_thread_fsm (struct ui *waiting_ui, struct interp *cmd_interp,
3b12939d 511 struct gdbarch *gdbarch, struct value *function,
388a7084
PA
512 struct type *value_type,
513 int struct_return_p, CORE_ADDR struct_addr)
514{
515 struct call_thread_fsm *sm;
516
517 sm = XCNEW (struct call_thread_fsm);
8980e177 518 thread_fsm_ctor (&sm->thread_fsm, &call_thread_fsm_ops, cmd_interp);
388a7084
PA
519
520 sm->return_meta_info.gdbarch = gdbarch;
521 sm->return_meta_info.function = function;
522 sm->return_meta_info.value_type = value_type;
523 sm->return_meta_info.struct_return_p = struct_return_p;
524 sm->return_meta_info.struct_addr = struct_addr;
525
3b12939d
PA
526 sm->waiting_ui = waiting_ui;
527
388a7084
PA
528 return sm;
529}
530
531/* Implementation of should_stop method for infcalls. */
532
533static int
8980e177
PA
534call_thread_fsm_should_stop (struct thread_fsm *self,
535 struct thread_info *thread)
388a7084
PA
536{
537 struct call_thread_fsm *f = (struct call_thread_fsm *) self;
538
539 if (stop_stack_dummy == STOP_STACK_DUMMY)
540 {
541 /* Done. */
542 thread_fsm_set_finished (self);
543
544 /* Stash the return value before the dummy frame is popped and
545 registers are restored to what they were before the
546 call.. */
547 f->return_value = get_call_return_value (&f->return_meta_info);
548
549 /* Break out of wait_sync_command_done. */
4b6749b9 550 scoped_restore save_ui = make_scoped_restore (&current_ui, f->waiting_ui);
223ffa71 551 target_terminal::ours ();
3b12939d 552 f->waiting_ui->prompt_state = PROMPT_NEEDED;
388a7084
PA
553 }
554
555 return 1;
556}
557
558/* Implementation of should_notify_stop method for infcalls. */
559
560static int
561call_thread_fsm_should_notify_stop (struct thread_fsm *self)
562{
563 if (thread_fsm_finished_p (self))
564 {
565 /* Infcall succeeded. Be silent and proceed with evaluating the
566 expression. */
567 return 0;
568 }
569
570 /* Something wrong happened. E.g., an unexpected breakpoint
571 triggered, or a signal was intercepted. Notify the stop. */
572 return 1;
573}
574
b89667eb
DE
575/* Subroutine of call_function_by_hand to simplify it.
576 Start up the inferior and wait for it to stop.
577 Return the exception if there's an error, or an exception with
578 reason >= 0 if there's no error.
579
580 This is done inside a TRY_CATCH so the caller needn't worry about
581 thrown errors. The caller should rethrow if there's an error. */
582
583static struct gdb_exception
388a7084
PA
584run_inferior_call (struct call_thread_fsm *sm,
585 struct thread_info *call_thread, CORE_ADDR real_pc)
b89667eb 586{
492d29ea 587 struct gdb_exception caught_error = exception_none;
16c381f0 588 int saved_in_infcall = call_thread->control.in_infcall;
b89667eb 589 ptid_t call_thread_ptid = call_thread->ptid;
3b12939d 590 enum prompt_state saved_prompt_state = current_ui->prompt_state;
28bf096c 591 int was_running = call_thread->state == THREAD_RUNNING;
cb814510 592 int saved_ui_async = current_ui->async;
c933f875
PA
593
594 /* Infcalls run synchronously, in the foreground. */
3b12939d 595 current_ui->prompt_state = PROMPT_BLOCKED;
0b333c5e
PA
596 /* So that we don't print the prompt prematurely in
597 fetch_inferior_event. */
cb814510 598 current_ui->async = 0;
b89667eb 599
6d61dee5
PA
600 delete_file_handler (current_ui->input_fd);
601
16c381f0 602 call_thread->control.in_infcall = 1;
c5a4d20b 603
70509625 604 clear_proceed_status (0);
b89667eb 605
388a7084
PA
606 /* Associate the FSM with the thread after clear_proceed_status
607 (otherwise it'd clear this FSM), and before anything throws, so
608 we don't leak it (and any resources it manages). */
609 call_thread->thread_fsm = &sm->thread_fsm;
610
b89667eb 611 disable_watchpoints_before_interactive_call_start ();
16c381f0 612
46c03469 613 /* We want to print return value, please... */
16c381f0 614 call_thread->control.proceed_to_finish = 1;
b89667eb 615
492d29ea 616 TRY
3dd5b83d 617 {
64ce06e4 618 proceed (real_pc, GDB_SIGNAL_0);
3dd5b83d
PA
619
620 /* Inferior function calls are always synchronous, even if the
0b333c5e
PA
621 target supports asynchronous execution. */
622 wait_sync_command_done ();
3dd5b83d 623 }
492d29ea
PA
624 CATCH (e, RETURN_MASK_ALL)
625 {
626 caught_error = e;
627 }
628 END_CATCH
b89667eb 629
3b12939d
PA
630 /* If GDB has the prompt blocked before, then ensure that it remains
631 so. normal_stop calls async_enable_stdin, so reset the prompt
632 state again here. In other cases, stdin will be re-enabled by
0b333c5e 633 inferior_event_handler, when an exception is thrown. */
3b12939d 634 current_ui->prompt_state = saved_prompt_state;
6d61dee5
PA
635 if (current_ui->prompt_state == PROMPT_BLOCKED)
636 delete_file_handler (current_ui->input_fd);
637 else
638 ui_register_input_event_handler (current_ui);
cb814510 639 current_ui->async = saved_ui_async;
0b333c5e 640
28bf096c
PA
641 /* If the infcall does NOT succeed, normal_stop will have already
642 finished the thread states. However, on success, normal_stop
643 defers here, so that we can set back the thread states to what
644 they were before the call. Note that we must also finish the
645 state of new threads that might have spawned while the call was
646 running. The main cases to handle are:
647
648 - "(gdb) print foo ()", or any other command that evaluates an
649 expression at the prompt. (The thread was marked stopped before.)
650
651 - "(gdb) break foo if return_false()" or similar cases where we
652 do an infcall while handling an event (while the thread is still
653 marked running). In this example, whether the condition
654 evaluates true and thus we'll present a user-visible stop is
655 decided elsewhere. */
656 if (!was_running
00431a78 657 && call_thread_ptid == inferior_ptid
28bf096c
PA
658 && stop_stack_dummy == STOP_STACK_DUMMY)
659 finish_thread_state (user_visible_resume_ptid (0));
660
b89667eb
DE
661 enable_watchpoints_after_interactive_call_stop ();
662
663 /* Call breakpoint_auto_delete on the current contents of the bpstat
664 of inferior call thread.
665 If all error()s out of proceed ended up calling normal_stop
666 (and perhaps they should; it already does in the special case
667 of error out of resume()), then we wouldn't need this. */
492d29ea 668 if (caught_error.reason < 0)
b89667eb 669 {
00431a78 670 if (call_thread->state != THREAD_EXITED)
16c381f0 671 breakpoint_auto_delete (call_thread->control.stop_bpstat);
b89667eb
DE
672 }
673
00431a78 674 call_thread->control.in_infcall = saved_in_infcall;
c5a4d20b 675
492d29ea 676 return caught_error;
b89667eb
DE
677}
678
aa7d318d
TT
679/* A cleanup function that calls delete_std_terminate_breakpoint. */
680static void
681cleanup_delete_std_terminate_breakpoint (void *ignore)
682{
683 delete_std_terminate_breakpoint ();
684}
685
ed12ef62
JK
686/* See infcall.h. */
687
688struct value *
7022349d
PA
689call_function_by_hand (struct value *function,
690 type *default_return_type,
691 int nargs, struct value **args)
ed12ef62 692{
7022349d
PA
693 return call_function_by_hand_dummy (function, default_return_type,
694 nargs, args, NULL, NULL);
ed12ef62
JK
695}
696
04714b91
AC
697/* All this stuff with a dummy frame may seem unnecessarily complicated
698 (why not just save registers in GDB?). The purpose of pushing a dummy
699 frame which looks just like a real frame is so that if you call a
700 function and then hit a breakpoint (get a signal, etc), "backtrace"
701 will look right. Whether the backtrace needs to actually show the
702 stack at the time the inferior function was called is debatable, but
703 it certainly needs to not display garbage. So if you are contemplating
704 making dummy frames be different from normal frames, consider that. */
705
706/* Perform a function call in the inferior.
707 ARGS is a vector of values of arguments (NARGS of them).
708 FUNCTION is a value, the function to be called.
709 Returns a value representing what the function returned.
710 May fail to return, if a breakpoint or signal is hit
711 during the execution of the function.
712
1777feb0 713 ARGS is modified to contain coerced values. */
04714b91
AC
714
715struct value *
ed12ef62 716call_function_by_hand_dummy (struct value *function,
7022349d 717 type *default_return_type,
ed12ef62 718 int nargs, struct value **args,
558e5469 719 dummy_frame_dtor_ftype *dummy_dtor,
ed12ef62 720 void *dummy_dtor_data)
04714b91 721{
52f0bd74 722 CORE_ADDR sp;
8388016d 723 struct type *target_values_type;
18648a37 724 unsigned char struct_return = 0, hidden_first_param_p = 0;
04714b91 725 CORE_ADDR struct_addr = 0;
16c381f0 726 struct infcall_control_state *inf_status;
04714b91 727 struct cleanup *inf_status_cleanup;
16c381f0 728 struct infcall_suspend_state *caller_state;
04714b91 729 CORE_ADDR real_pc;
d585e13a 730 CORE_ADDR bp_addr;
96860204 731 struct frame_id dummy_id;
0b9dfe2b
MD
732 struct frame_info *frame;
733 struct gdbarch *gdbarch;
aa7d318d 734 struct cleanup *terminate_bp_cleanup;
b89667eb
DE
735 ptid_t call_thread_ptid;
736 struct gdb_exception e;
b89667eb 737 char name_buf[RAW_FUNCTION_ADDRESS_SIZE];
04714b91 738
04714b91
AC
739 if (!target_has_execution)
740 noprocess ();
741
573cda03
SS
742 if (get_traceframe_number () >= 0)
743 error (_("May not call functions while looking at trace frames."));
744
949dc678 745 if (execution_direction == EXEC_REVERSE)
c2949be0 746 error (_("Cannot call functions in reverse mode."));
949dc678 747
00431a78
PA
748 /* We're going to run the target, and inspect the thread's state
749 afterwards. Hold a strong reference so that the pointer remains
750 valid even if the thread exits. */
751 thread_info_ref call_thread
752 = thread_info_ref::new_reference (inferior_thread ());
753
754 bool stack_temporaries = thread_stack_temporaries_enabled_p (call_thread.get ());
755
0b9dfe2b
MD
756 frame = get_current_frame ();
757 gdbarch = get_frame_arch (frame);
758
759 if (!gdbarch_push_dummy_call_p (gdbarch))
2e74121d 760 error (_("This target does not support function calls."));
a86c5fc9 761
b89667eb
DE
762 /* A cleanup for the inferior status.
763 This is only needed while we're preparing the inferior function call. */
16c381f0
JK
764 inf_status = save_infcall_control_state ();
765 inf_status_cleanup
766 = make_cleanup_restore_infcall_control_state (inf_status);
04714b91 767
b89667eb
DE
768 /* Save the caller's registers and other state associated with the
769 inferior itself so that they can be restored once the
96860204
AC
770 callee returns. To allow nested calls the registers are (further
771 down) pushed onto a dummy frame stack. Include a cleanup (which
772 is tossed once the regcache has been pushed). */
16c381f0
JK
773 caller_state = save_infcall_suspend_state ();
774 make_cleanup_restore_infcall_suspend_state (caller_state);
04714b91 775
04714b91 776 /* Ensure that the initial SP is correctly aligned. */
ebc7896c 777 {
0b9dfe2b 778 CORE_ADDR old_sp = get_frame_sp (frame);
abbb1732 779
0b9dfe2b 780 if (gdbarch_frame_align_p (gdbarch))
ebc7896c 781 {
0b9dfe2b 782 sp = gdbarch_frame_align (gdbarch, old_sp);
8b148df9
AC
783 /* NOTE: cagney/2003-08-13: Skip the "red zone". For some
784 ABIs, a function can use memory beyond the inner most stack
785 address. AMD64 called that region the "red zone". Skip at
786 least the "red zone" size before allocating any space on
787 the stack. */
0b9dfe2b
MD
788 if (gdbarch_inner_than (gdbarch, 1, 2))
789 sp -= gdbarch_frame_red_zone_size (gdbarch);
8b148df9 790 else
0b9dfe2b 791 sp += gdbarch_frame_red_zone_size (gdbarch);
8b148df9 792 /* Still aligned? */
0b9dfe2b 793 gdb_assert (sp == gdbarch_frame_align (gdbarch, sp));
ebc7896c
AC
794 /* NOTE: cagney/2002-09-18:
795
796 On a RISC architecture, a void parameterless generic dummy
797 frame (i.e., no parameters, no result) typically does not
798 need to push anything the stack and hence can leave SP and
c48a845b 799 FP. Similarly, a frameless (possibly leaf) function does
ebc7896c
AC
800 not push anything on the stack and, hence, that too can
801 leave FP and SP unchanged. As a consequence, a sequence of
802 void parameterless generic dummy frame calls to frameless
803 functions will create a sequence of effectively identical
804 frames (SP, FP and TOS and PC the same). This, not
805 suprisingly, results in what appears to be a stack in an
806 infinite loop --- when GDB tries to find a generic dummy
807 frame on the internal dummy frame stack, it will always
808 find the first one.
809
810 To avoid this problem, the code below always grows the
811 stack. That way, two dummy frames can never be identical.
812 It does burn a few bytes of stack but that is a small price
813 to pay :-). */
ebc7896c
AC
814 if (sp == old_sp)
815 {
0b9dfe2b 816 if (gdbarch_inner_than (gdbarch, 1, 2))
ebc7896c 817 /* Stack grows down. */
0b9dfe2b 818 sp = gdbarch_frame_align (gdbarch, old_sp - 1);
ebc7896c
AC
819 else
820 /* Stack grows up. */
0b9dfe2b 821 sp = gdbarch_frame_align (gdbarch, old_sp + 1);
ebc7896c 822 }
0e095b7e
JK
823 /* SP may have underflown address zero here from OLD_SP. Memory access
824 functions will probably fail in such case but that is a target's
825 problem. */
ebc7896c
AC
826 }
827 else
a59fe496
AC
828 /* FIXME: cagney/2002-09-18: Hey, you loose!
829
8b148df9
AC
830 Who knows how badly aligned the SP is!
831
832 If the generic dummy frame ends up empty (because nothing is
833 pushed) GDB won't be able to correctly perform back traces.
834 If a target is having trouble with backtraces, first thing to
1777feb0 835 do is add FRAME_ALIGN() to the architecture vector. If that
669fac23 836 fails, try dummy_id().
8b148df9
AC
837
838 If the ABI specifies a "Red Zone" (see the doco) the code
839 below will quietly trash it. */
ebc7896c 840 sp = old_sp;
6c659fc2
SC
841
842 /* Skip over the stack temporaries that might have been generated during
843 the evaluation of an expression. */
844 if (stack_temporaries)
845 {
846 struct value *lastval;
847
00431a78 848 lastval = get_last_thread_stack_temporary (call_thread.get ());
6c659fc2
SC
849 if (lastval != NULL)
850 {
851 CORE_ADDR lastval_addr = value_address (lastval);
852
853 if (gdbarch_inner_than (gdbarch, 1, 2))
854 {
855 gdb_assert (sp >= lastval_addr);
856 sp = lastval_addr;
857 }
858 else
859 {
860 gdb_assert (sp <= lastval_addr);
861 sp = lastval_addr + TYPE_LENGTH (value_type (lastval));
862 }
863
864 if (gdbarch_frame_align_p (gdbarch))
865 sp = gdbarch_frame_align (gdbarch, sp);
866 }
867 }
ebc7896c 868 }
04714b91 869
8388016d
PA
870 type *ftype;
871 type *values_type;
872 CORE_ADDR funaddr = find_function_addr (function, &values_type, &ftype);
873
7022349d
PA
874 if (values_type == NULL)
875 values_type = default_return_type;
876 if (values_type == NULL)
877 {
878 const char *name = get_function_name (funaddr,
879 name_buf, sizeof (name_buf));
880 error (_("'%s' has unknown return type; "
881 "cast the call to its declared return type"),
882 name);
883 }
7788af6d 884
f168693b 885 values_type = check_typedef (values_type);
04714b91 886
41f1b697
DJ
887 /* Are we returning a value using a structure return (passing a
888 hidden argument pointing to storage) or a normal value return?
889 There are two cases: language-mandated structure return and
890 target ABI structure return. The variable STRUCT_RETURN only
891 describes the latter. The language version is handled by passing
892 the return location as the first parameter to the function,
893 even preceding "this". This is different from the target
894 ABI version, which is target-specific; for instance, on ia64
895 the first argument is passed in out0 but the hidden structure
896 return pointer would normally be passed in r8. */
897
18648a37 898 if (gdbarch_return_in_first_hidden_param_p (gdbarch, values_type))
41f1b697 899 {
18648a37 900 hidden_first_param_p = 1;
04714b91 901
41f1b697
DJ
902 /* Tell the target specific argument pushing routine not to
903 expect a value. */
48319d1f 904 target_values_type = builtin_type (gdbarch)->builtin_void;
41f1b697
DJ
905 }
906 else
907 {
6a3a010b 908 struct_return = using_struct_return (gdbarch, function, values_type);
41f1b697
DJ
909 target_values_type = values_type;
910 }
04714b91 911
76727919 912 gdb::observers::inferior_call_pre.notify (inferior_ptid, funaddr);
162078c8 913
7043d8dc
AC
914 /* Determine the location of the breakpoint (and possibly other
915 stuff) that the called function will return to. The SPARC, for a
916 function returning a structure or union, needs to make space for
917 not just the breakpoint but also an extra word containing the
918 size (?) of the structure being passed. */
919
0b9dfe2b 920 switch (gdbarch_call_dummy_location (gdbarch))
04714b91
AC
921 {
922 case ON_STACK:
a14dd77e
JK
923 {
924 const gdb_byte *bp_bytes;
925 CORE_ADDR bp_addr_as_address;
926 int bp_size;
927
928 /* Be careful BP_ADDR is in inferior PC encoding while
929 BP_ADDR_AS_ADDRESS is a plain memory address. */
930
931 sp = push_dummy_code (gdbarch, sp, funaddr, args, nargs,
932 target_values_type, &real_pc, &bp_addr,
933 get_current_regcache ());
934
935 /* Write a legitimate instruction at the point where the infcall
936 breakpoint is going to be inserted. While this instruction
937 is never going to be executed, a user investigating the
938 memory from GDB would see this instruction instead of random
939 uninitialized bytes. We chose the breakpoint instruction
940 as it may look as the most logical one to the user and also
941 valgrind 3.7.0 needs it for proper vgdb inferior calls.
942
943 If software breakpoints are unsupported for this target we
944 leave the user visible memory content uninitialized. */
945
946 bp_addr_as_address = bp_addr;
947 bp_bytes = gdbarch_breakpoint_from_pc (gdbarch, &bp_addr_as_address,
948 &bp_size);
949 if (bp_bytes != NULL)
950 write_memory (bp_addr_as_address, bp_bytes, bp_size);
951 }
7043d8dc 952 break;
5931a2fa
JK
953 case AT_ENTRY_POINT:
954 {
955 CORE_ADDR dummy_addr;
956
957 real_pc = funaddr;
958 dummy_addr = entry_point_address ();
a14dd77e 959
5931a2fa 960 /* A call dummy always consists of just a single breakpoint, so
a14dd77e
JK
961 its address is the same as the address of the dummy.
962
963 The actual breakpoint is inserted separatly so there is no need to
964 write that out. */
5931a2fa
JK
965 bp_addr = dummy_addr;
966 break;
967 }
04714b91 968 default:
e2e0b3e5 969 internal_error (__FILE__, __LINE__, _("bad switch"));
04714b91
AC
970 }
971
04714b91 972 if (nargs < TYPE_NFIELDS (ftype))
2e74121d 973 error (_("Too few arguments in function call."));
04714b91 974
ebc7896c
AC
975 {
976 int i;
abbb1732 977
ebc7896c
AC
978 for (i = nargs - 1; i >= 0; i--)
979 {
980 int prototyped;
981 struct type *param_type;
982
983 /* FIXME drow/2002-05-31: Should just always mark methods as
984 prototyped. Can we respect TYPE_VARARGS? Probably not. */
985 if (TYPE_CODE (ftype) == TYPE_CODE_METHOD)
986 prototyped = 1;
7022349d
PA
987 if (TYPE_TARGET_TYPE (ftype) == NULL && TYPE_NFIELDS (ftype) == 0
988 && default_return_type != NULL)
989 {
990 /* Calling a no-debug function with the return type
991 explicitly cast. Assume the function is prototyped,
992 with a prototype matching the types of the arguments.
993 E.g., with:
994 float mult (float v1, float v2) { return v1 * v2; }
995 This:
996 (gdb) p (float) mult (2.0f, 3.0f)
997 Is a simpler alternative to:
998 (gdb) p ((float (*) (float, float)) mult) (2.0f, 3.0f)
999 */
1000 prototyped = 1;
1001 }
ebc7896c
AC
1002 else if (i < TYPE_NFIELDS (ftype))
1003 prototyped = TYPE_PROTOTYPED (ftype);
1004 else
1005 prototyped = 0;
1006
1007 if (i < TYPE_NFIELDS (ftype))
1008 param_type = TYPE_FIELD_TYPE (ftype, i);
1009 else
1010 param_type = NULL;
41f1b697 1011
7788af6d
UW
1012 args[i] = value_arg_coerce (gdbarch, args[i],
1013 param_type, prototyped, &sp);
ebc7896c 1014
41f1b697
DJ
1015 if (param_type != NULL && language_pass_by_reference (param_type))
1016 args[i] = value_addr (args[i]);
ebc7896c
AC
1017 }
1018 }
04714b91 1019
04714b91
AC
1020 /* Reserve space for the return structure to be written on the
1021 stack, if necessary. Make certain that the value is correctly
6c659fc2
SC
1022 aligned.
1023
1024 While evaluating expressions, we reserve space on the stack for
1025 return values of class type even if the language ABI and the target
1026 ABI do not require that the return value be passed as a hidden first
1027 argument. This is because we want to store the return value as an
1028 on-stack temporary while the expression is being evaluated. This
1029 enables us to have chained function calls in expressions.
04714b91 1030
6c659fc2
SC
1031 Keeping the return values as on-stack temporaries while the expression
1032 is being evaluated is OK because the thread is stopped until the
1033 expression is completely evaluated. */
1034
1035 if (struct_return || hidden_first_param_p
1036 || (stack_temporaries && class_or_union_p (values_type)))
04714b91 1037 {
0b9dfe2b 1038 if (gdbarch_inner_than (gdbarch, 1, 2))
04714b91
AC
1039 {
1040 /* Stack grows downward. Align STRUCT_ADDR and SP after
1041 making space for the return value. */
744a8059 1042 sp -= TYPE_LENGTH (values_type);
0b9dfe2b
MD
1043 if (gdbarch_frame_align_p (gdbarch))
1044 sp = gdbarch_frame_align (gdbarch, sp);
04714b91
AC
1045 struct_addr = sp;
1046 }
1047 else
1048 {
1049 /* Stack grows upward. Align the frame, allocate space, and
1777feb0 1050 then again, re-align the frame??? */
0b9dfe2b
MD
1051 if (gdbarch_frame_align_p (gdbarch))
1052 sp = gdbarch_frame_align (gdbarch, sp);
04714b91 1053 struct_addr = sp;
744a8059 1054 sp += TYPE_LENGTH (values_type);
0b9dfe2b
MD
1055 if (gdbarch_frame_align_p (gdbarch))
1056 sp = gdbarch_frame_align (gdbarch, sp);
04714b91
AC
1057 }
1058 }
1059
6ccb583f 1060 std::vector<struct value *> new_args;
18648a37 1061 if (hidden_first_param_p)
41f1b697 1062 {
41f1b697 1063 /* Add the new argument to the front of the argument list. */
6ccb583f
TT
1064 new_args.push_back
1065 (value_from_pointer (lookup_pointer_type (values_type), struct_addr));
1066 std::copy (&args[0], &args[nargs], std::back_inserter (new_args));
1067 args = new_args.data ();
41f1b697 1068 nargs++;
41f1b697 1069 }
41f1b697 1070
04714b91
AC
1071 /* Create the dummy stack frame. Pass in the call dummy address as,
1072 presumably, the ABI code knows where, in the call dummy, the
1073 return address should be pointed. */
0b9dfe2b
MD
1074 sp = gdbarch_push_dummy_call (gdbarch, function, get_current_regcache (),
1075 bp_addr, nargs, args,
594f7785 1076 sp, struct_return, struct_addr);
04714b91 1077
96860204
AC
1078 /* Set up a frame ID for the dummy frame so we can pass it to
1079 set_momentary_breakpoint. We need to give the breakpoint a frame
1080 ID so that the breakpoint code can correctly re-identify the
1081 dummy breakpoint. */
8241eaa6 1082 /* Sanity. The exact same SP value is returned by PUSH_DUMMY_CALL,
669fac23 1083 saved as the dummy-frame TOS, and used by dummy_id to form
8241eaa6 1084 the frame ID's stack address. */
96860204 1085 dummy_id = frame_id_build (sp, bp_addr);
04714b91 1086
74cfe982
AC
1087 /* Create a momentary breakpoint at the return address of the
1088 inferior. That way it breaks when it returns. */
04714b91 1089
74cfe982 1090 {
51abb421 1091 symtab_and_line sal;
6c95b8df 1092 sal.pspace = current_program_space;
74cfe982
AC
1093 sal.pc = bp_addr;
1094 sal.section = find_pc_overlay (sal.pc);
51abb421 1095
8241eaa6
AC
1096 /* Sanity. The exact same SP value is returned by
1097 PUSH_DUMMY_CALL, saved as the dummy-frame TOS, and used by
669fac23 1098 dummy_id to form the frame ID's stack address. */
454dafbd
TT
1099 breakpoint *bpt
1100 = set_momentary_breakpoint (gdbarch, sal,
1101 dummy_id, bp_call_dummy).release ();
c70a6932
JK
1102
1103 /* set_momentary_breakpoint invalidates FRAME. */
1104 frame = NULL;
1105
74cfe982 1106 bpt->disposition = disp_del;
e2e4d78b
JK
1107 gdb_assert (bpt->related_breakpoint == bpt);
1108
51abb421 1109 breakpoint *longjmp_b = set_longjmp_breakpoint_for_call_dummy ();
e2e4d78b
JK
1110 if (longjmp_b)
1111 {
1112 /* Link BPT into the chain of LONGJMP_B. */
1113 bpt->related_breakpoint = longjmp_b;
1114 while (longjmp_b->related_breakpoint != bpt->related_breakpoint)
1115 longjmp_b = longjmp_b->related_breakpoint;
1116 longjmp_b->related_breakpoint = bpt;
1117 }
74cfe982 1118 }
04714b91 1119
7cd1089b
PM
1120 /* Create a breakpoint in std::terminate.
1121 If a C++ exception is raised in the dummy-frame, and the
1122 exception handler is (normally, and expected to be) out-of-frame,
1123 the default C++ handler will (wrongly) be called in an inferior
1124 function call. This is wrong, as an exception can be normally
1125 and legally handled out-of-frame. The confines of the dummy frame
1126 prevent the unwinder from finding the correct handler (or any
1127 handler, unless it is in-frame). The default handler calls
1128 std::terminate. This will kill the inferior. Assert that
1129 terminate should never be called in an inferior function
1130 call. Place a momentary breakpoint in the std::terminate function
1131 and if triggered in the call, rewind. */
1132 if (unwind_on_terminating_exception_p)
aa7d318d 1133 set_std_terminate_breakpoint ();
7cd1089b 1134
8a6c4031
JK
1135 /* Discard both inf_status and caller_state cleanups.
1136 From this point on we explicitly restore the associated state
1137 or discard it. */
1138 discard_cleanups (inf_status_cleanup);
1139
96860204
AC
1140 /* Everything's ready, push all the info needed to restore the
1141 caller (and identify the dummy-frame) onto the dummy-frame
1142 stack. */
00431a78 1143 dummy_frame_push (caller_state, &dummy_id, call_thread.get ());
ed12ef62 1144 if (dummy_dtor != NULL)
00431a78 1145 register_dummy_frame_dtor (dummy_id, call_thread.get (),
ed12ef62 1146 dummy_dtor, dummy_dtor_data);
b89667eb 1147
7cd1089b 1148 /* Register a clean-up for unwind_on_terminating_exception_breakpoint. */
aa7d318d
TT
1149 terminate_bp_cleanup = make_cleanup (cleanup_delete_std_terminate_breakpoint,
1150 NULL);
7cd1089b 1151
96860204
AC
1152 /* - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP -
1153 If you're looking to implement asynchronous dummy-frames, then
1154 just below is the place to chop this function in two.. */
1155
74cfe982 1156 {
388a7084
PA
1157 struct thread_fsm *saved_sm;
1158 struct call_thread_fsm *sm;
1159
1160 /* Save the current FSM. We'll override it. */
00431a78
PA
1161 saved_sm = call_thread->thread_fsm;
1162 call_thread->thread_fsm = NULL;
74cfe982 1163
b89667eb
DE
1164 /* Save this thread's ptid, we need it later but the thread
1165 may have exited. */
00431a78 1166 call_thread_ptid = call_thread->ptid;
74cfe982 1167
b89667eb 1168 /* Run the inferior until it stops. */
f5871ec0 1169
388a7084
PA
1170 /* Create the FSM used to manage the infcall. It tells infrun to
1171 not report the stop to the user, and captures the return value
1172 before the dummy frame is popped. run_inferior_call registers
1173 it with the thread ASAP. */
8980e177 1174 sm = new_call_thread_fsm (current_ui, command_interp (),
3b12939d 1175 gdbarch, function,
388a7084
PA
1176 values_type,
1177 struct_return || hidden_first_param_p,
1178 struct_addr);
1179
00431a78 1180 e = run_inferior_call (sm, call_thread.get (), real_pc);
388a7084 1181
76727919 1182 gdb::observers::inferior_call_post.notify (call_thread_ptid, funaddr);
388a7084 1183
00431a78 1184 if (call_thread->state != THREAD_EXITED)
388a7084
PA
1185 {
1186 /* The FSM should still be the same. */
00431a78 1187 gdb_assert (call_thread->thread_fsm == &sm->thread_fsm);
388a7084 1188
00431a78 1189 if (thread_fsm_finished_p (call_thread->thread_fsm))
388a7084
PA
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. */
00431a78 1197 dummy_frame_pop (dummy_id, call_thread.get ());
388a7084
PA
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. */
00431a78
PA
1205 thread_fsm_clean_up (call_thread->thread_fsm, call_thread.get ());
1206 thread_fsm_delete (call_thread->thread_fsm);
1207 call_thread->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. */
00431a78 1218 call_thread->thread_fsm = saved_sm;
388a7084
PA
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
d7e15655 1273 if (call_thread_ptid != inferior_ptid)
b89667eb
DE
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. */
00431a78 1319 dummy_frame_pop (dummy_id, call_thread.get ());
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. */
00431a78 1360 dummy_frame_pop (dummy_id, call_thread.get ());
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.814656 seconds and 4 git commands to generate.