Avoid memcpys in regcache read_part/write_part for full registers.
[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;
fdf07f3a 425 bool stack_temporaries = thread_stack_temporaries_enabled_p (inferior_ptid);
388a7084
PA
426
427 if (TYPE_CODE (ri->value_type) == TYPE_CODE_VOID)
428 retval = allocate_value (ri->value_type);
429 else if (ri->struct_return_p)
430 {
431 if (stack_temporaries)
432 {
433 retval = value_from_contents_and_address (ri->value_type, NULL,
434 ri->struct_addr);
435 push_thread_stack_temporary (inferior_ptid, retval);
436 }
437 else
438 {
439 retval = allocate_value (ri->value_type);
440 read_value_memory (retval, 0, 1, ri->struct_addr,
441 value_contents_raw (retval),
442 TYPE_LENGTH (ri->value_type));
443 }
444 }
445 else
446 {
447 retval = allocate_value (ri->value_type);
448 gdbarch_return_value (ri->gdbarch, ri->function, ri->value_type,
449 get_current_regcache (),
450 value_contents_raw (retval), NULL);
451 if (stack_temporaries && class_or_union_p (ri->value_type))
452 {
453 /* Values of class type returned in registers are copied onto
454 the stack and their lval_type set to lval_memory. This is
455 required because further evaluation of the expression
456 could potentially invoke methods on the return value
457 requiring GDB to evaluate the "this" pointer. To evaluate
458 the this pointer, GDB needs the memory address of the
459 value. */
460 value_force_lval (retval, ri->struct_addr);
461 push_thread_stack_temporary (inferior_ptid, retval);
462 }
463 }
464
465 gdb_assert (retval != NULL);
466 return retval;
467}
468
469/* Data for the FSM that manages an infcall. It's main job is to
470 record the called function's return value. */
471
472struct call_thread_fsm
473{
474 /* The base class. */
475 struct thread_fsm thread_fsm;
476
477 /* All the info necessary to be able to extract the return
478 value. */
479 struct call_return_meta_info return_meta_info;
480
481 /* The called function's return value. This is extracted from the
482 target before the dummy frame is popped. */
483 struct value *return_value;
3b12939d
PA
484
485 /* The top level that started the infcall (and is synchronously
486 waiting for it to end). */
487 struct ui *waiting_ui;
388a7084
PA
488};
489
8980e177
PA
490static int call_thread_fsm_should_stop (struct thread_fsm *self,
491 struct thread_info *thread);
388a7084
PA
492static int call_thread_fsm_should_notify_stop (struct thread_fsm *self);
493
494/* call_thread_fsm's vtable. */
495
496static struct thread_fsm_ops call_thread_fsm_ops =
497{
498 NULL, /*dtor */
499 NULL, /* clean_up */
500 call_thread_fsm_should_stop,
501 NULL, /* return_value */
502 NULL, /* async_reply_reason*/
503 call_thread_fsm_should_notify_stop,
504};
505
506/* Allocate a new call_thread_fsm object. */
507
508static struct call_thread_fsm *
8980e177 509new_call_thread_fsm (struct ui *waiting_ui, struct interp *cmd_interp,
3b12939d 510 struct gdbarch *gdbarch, struct value *function,
388a7084
PA
511 struct type *value_type,
512 int struct_return_p, CORE_ADDR struct_addr)
513{
514 struct call_thread_fsm *sm;
515
516 sm = XCNEW (struct call_thread_fsm);
8980e177 517 thread_fsm_ctor (&sm->thread_fsm, &call_thread_fsm_ops, cmd_interp);
388a7084
PA
518
519 sm->return_meta_info.gdbarch = gdbarch;
520 sm->return_meta_info.function = function;
521 sm->return_meta_info.value_type = value_type;
522 sm->return_meta_info.struct_return_p = struct_return_p;
523 sm->return_meta_info.struct_addr = struct_addr;
524
3b12939d
PA
525 sm->waiting_ui = waiting_ui;
526
388a7084
PA
527 return sm;
528}
529
530/* Implementation of should_stop method for infcalls. */
531
532static int
8980e177
PA
533call_thread_fsm_should_stop (struct thread_fsm *self,
534 struct thread_info *thread)
388a7084
PA
535{
536 struct call_thread_fsm *f = (struct call_thread_fsm *) self;
537
538 if (stop_stack_dummy == STOP_STACK_DUMMY)
539 {
540 /* Done. */
541 thread_fsm_set_finished (self);
542
543 /* Stash the return value before the dummy frame is popped and
544 registers are restored to what they were before the
545 call.. */
546 f->return_value = get_call_return_value (&f->return_meta_info);
547
548 /* Break out of wait_sync_command_done. */
4b6749b9 549 scoped_restore save_ui = make_scoped_restore (&current_ui, f->waiting_ui);
223ffa71 550 target_terminal::ours ();
3b12939d 551 f->waiting_ui->prompt_state = PROMPT_NEEDED;
388a7084
PA
552 }
553
554 return 1;
555}
556
557/* Implementation of should_notify_stop method for infcalls. */
558
559static int
560call_thread_fsm_should_notify_stop (struct thread_fsm *self)
561{
562 if (thread_fsm_finished_p (self))
563 {
564 /* Infcall succeeded. Be silent and proceed with evaluating the
565 expression. */
566 return 0;
567 }
568
569 /* Something wrong happened. E.g., an unexpected breakpoint
570 triggered, or a signal was intercepted. Notify the stop. */
571 return 1;
572}
573
b89667eb
DE
574/* Subroutine of call_function_by_hand to simplify it.
575 Start up the inferior and wait for it to stop.
576 Return the exception if there's an error, or an exception with
577 reason >= 0 if there's no error.
578
579 This is done inside a TRY_CATCH so the caller needn't worry about
580 thrown errors. The caller should rethrow if there's an error. */
581
582static struct gdb_exception
388a7084
PA
583run_inferior_call (struct call_thread_fsm *sm,
584 struct thread_info *call_thread, CORE_ADDR real_pc)
b89667eb 585{
492d29ea 586 struct gdb_exception caught_error = exception_none;
16c381f0 587 int saved_in_infcall = call_thread->control.in_infcall;
b89667eb 588 ptid_t call_thread_ptid = call_thread->ptid;
3b12939d 589 enum prompt_state saved_prompt_state = current_ui->prompt_state;
28bf096c 590 int was_running = call_thread->state == THREAD_RUNNING;
cb814510 591 int saved_ui_async = current_ui->async;
c933f875
PA
592
593 /* Infcalls run synchronously, in the foreground. */
3b12939d 594 current_ui->prompt_state = PROMPT_BLOCKED;
0b333c5e
PA
595 /* So that we don't print the prompt prematurely in
596 fetch_inferior_event. */
cb814510 597 current_ui->async = 0;
b89667eb 598
6d61dee5
PA
599 delete_file_handler (current_ui->input_fd);
600
16c381f0 601 call_thread->control.in_infcall = 1;
c5a4d20b 602
70509625 603 clear_proceed_status (0);
b89667eb 604
388a7084
PA
605 /* Associate the FSM with the thread after clear_proceed_status
606 (otherwise it'd clear this FSM), and before anything throws, so
607 we don't leak it (and any resources it manages). */
608 call_thread->thread_fsm = &sm->thread_fsm;
609
b89667eb 610 disable_watchpoints_before_interactive_call_start ();
16c381f0 611
46c03469 612 /* We want to print return value, please... */
16c381f0 613 call_thread->control.proceed_to_finish = 1;
b89667eb 614
492d29ea 615 TRY
3dd5b83d 616 {
64ce06e4 617 proceed (real_pc, GDB_SIGNAL_0);
3dd5b83d
PA
618
619 /* Inferior function calls are always synchronous, even if the
0b333c5e
PA
620 target supports asynchronous execution. */
621 wait_sync_command_done ();
3dd5b83d 622 }
492d29ea
PA
623 CATCH (e, RETURN_MASK_ALL)
624 {
625 caught_error = e;
626 }
627 END_CATCH
b89667eb 628
3b12939d
PA
629 /* If GDB has the prompt blocked before, then ensure that it remains
630 so. normal_stop calls async_enable_stdin, so reset the prompt
631 state again here. In other cases, stdin will be re-enabled by
0b333c5e 632 inferior_event_handler, when an exception is thrown. */
3b12939d 633 current_ui->prompt_state = saved_prompt_state;
6d61dee5
PA
634 if (current_ui->prompt_state == PROMPT_BLOCKED)
635 delete_file_handler (current_ui->input_fd);
636 else
637 ui_register_input_event_handler (current_ui);
cb814510 638 current_ui->async = saved_ui_async;
0b333c5e 639
c5a4d20b
PA
640 /* At this point the current thread may have changed. Refresh
641 CALL_THREAD as it could be invalid if its thread has exited. */
e09875d4 642 call_thread = find_thread_ptid (call_thread_ptid);
b89667eb 643
28bf096c
PA
644 /* If the infcall does NOT succeed, normal_stop will have already
645 finished the thread states. However, on success, normal_stop
646 defers here, so that we can set back the thread states to what
647 they were before the call. Note that we must also finish the
648 state of new threads that might have spawned while the call was
649 running. The main cases to handle are:
650
651 - "(gdb) print foo ()", or any other command that evaluates an
652 expression at the prompt. (The thread was marked stopped before.)
653
654 - "(gdb) break foo if return_false()" or similar cases where we
655 do an infcall while handling an event (while the thread is still
656 marked running). In this example, whether the condition
657 evaluates true and thus we'll present a user-visible stop is
658 decided elsewhere. */
659 if (!was_running
660 && ptid_equal (call_thread_ptid, inferior_ptid)
661 && stop_stack_dummy == STOP_STACK_DUMMY)
662 finish_thread_state (user_visible_resume_ptid (0));
663
b89667eb
DE
664 enable_watchpoints_after_interactive_call_stop ();
665
666 /* Call breakpoint_auto_delete on the current contents of the bpstat
667 of inferior call thread.
668 If all error()s out of proceed ended up calling normal_stop
669 (and perhaps they should; it already does in the special case
670 of error out of resume()), then we wouldn't need this. */
492d29ea 671 if (caught_error.reason < 0)
b89667eb 672 {
c5a4d20b 673 if (call_thread != NULL)
16c381f0 674 breakpoint_auto_delete (call_thread->control.stop_bpstat);
b89667eb
DE
675 }
676
c5a4d20b 677 if (call_thread != NULL)
16c381f0 678 call_thread->control.in_infcall = saved_in_infcall;
c5a4d20b 679
492d29ea 680 return caught_error;
b89667eb
DE
681}
682
aa7d318d
TT
683/* A cleanup function that calls delete_std_terminate_breakpoint. */
684static void
685cleanup_delete_std_terminate_breakpoint (void *ignore)
686{
687 delete_std_terminate_breakpoint ();
688}
689
ed12ef62
JK
690/* See infcall.h. */
691
692struct value *
7022349d
PA
693call_function_by_hand (struct value *function,
694 type *default_return_type,
695 int nargs, struct value **args)
ed12ef62 696{
7022349d
PA
697 return call_function_by_hand_dummy (function, default_return_type,
698 nargs, args, NULL, NULL);
ed12ef62
JK
699}
700
04714b91
AC
701/* All this stuff with a dummy frame may seem unnecessarily complicated
702 (why not just save registers in GDB?). The purpose of pushing a dummy
703 frame which looks just like a real frame is so that if you call a
704 function and then hit a breakpoint (get a signal, etc), "backtrace"
705 will look right. Whether the backtrace needs to actually show the
706 stack at the time the inferior function was called is debatable, but
707 it certainly needs to not display garbage. So if you are contemplating
708 making dummy frames be different from normal frames, consider that. */
709
710/* Perform a function call in the inferior.
711 ARGS is a vector of values of arguments (NARGS of them).
712 FUNCTION is a value, the function to be called.
713 Returns a value representing what the function returned.
714 May fail to return, if a breakpoint or signal is hit
715 during the execution of the function.
716
1777feb0 717 ARGS is modified to contain coerced values. */
04714b91
AC
718
719struct value *
ed12ef62 720call_function_by_hand_dummy (struct value *function,
7022349d 721 type *default_return_type,
ed12ef62 722 int nargs, struct value **args,
558e5469 723 dummy_frame_dtor_ftype *dummy_dtor,
ed12ef62 724 void *dummy_dtor_data)
04714b91 725{
52f0bd74 726 CORE_ADDR sp;
8388016d 727 struct type *target_values_type;
18648a37 728 unsigned char struct_return = 0, hidden_first_param_p = 0;
04714b91 729 CORE_ADDR struct_addr = 0;
16c381f0 730 struct infcall_control_state *inf_status;
04714b91 731 struct cleanup *inf_status_cleanup;
16c381f0 732 struct infcall_suspend_state *caller_state;
04714b91 733 CORE_ADDR real_pc;
d585e13a 734 CORE_ADDR bp_addr;
96860204 735 struct frame_id dummy_id;
0b9dfe2b
MD
736 struct frame_info *frame;
737 struct gdbarch *gdbarch;
aa7d318d 738 struct cleanup *terminate_bp_cleanup;
b89667eb
DE
739 ptid_t call_thread_ptid;
740 struct gdb_exception e;
b89667eb 741 char name_buf[RAW_FUNCTION_ADDRESS_SIZE];
fdf07f3a 742 bool stack_temporaries = thread_stack_temporaries_enabled_p (inferior_ptid);
04714b91 743
04714b91
AC
744 if (!target_has_execution)
745 noprocess ();
746
573cda03
SS
747 if (get_traceframe_number () >= 0)
748 error (_("May not call functions while looking at trace frames."));
749
949dc678 750 if (execution_direction == EXEC_REVERSE)
c2949be0 751 error (_("Cannot call functions in reverse mode."));
949dc678 752
0b9dfe2b
MD
753 frame = get_current_frame ();
754 gdbarch = get_frame_arch (frame);
755
756 if (!gdbarch_push_dummy_call_p (gdbarch))
2e74121d 757 error (_("This target does not support function calls."));
a86c5fc9 758
b89667eb
DE
759 /* A cleanup for the inferior status.
760 This is only needed while we're preparing the inferior function call. */
16c381f0
JK
761 inf_status = save_infcall_control_state ();
762 inf_status_cleanup
763 = make_cleanup_restore_infcall_control_state (inf_status);
04714b91 764
b89667eb
DE
765 /* Save the caller's registers and other state associated with the
766 inferior itself so that they can be restored once the
96860204
AC
767 callee returns. To allow nested calls the registers are (further
768 down) pushed onto a dummy frame stack. Include a cleanup (which
769 is tossed once the regcache has been pushed). */
16c381f0
JK
770 caller_state = save_infcall_suspend_state ();
771 make_cleanup_restore_infcall_suspend_state (caller_state);
04714b91 772
04714b91 773 /* Ensure that the initial SP is correctly aligned. */
ebc7896c 774 {
0b9dfe2b 775 CORE_ADDR old_sp = get_frame_sp (frame);
abbb1732 776
0b9dfe2b 777 if (gdbarch_frame_align_p (gdbarch))
ebc7896c 778 {
0b9dfe2b 779 sp = gdbarch_frame_align (gdbarch, old_sp);
8b148df9
AC
780 /* NOTE: cagney/2003-08-13: Skip the "red zone". For some
781 ABIs, a function can use memory beyond the inner most stack
782 address. AMD64 called that region the "red zone". Skip at
783 least the "red zone" size before allocating any space on
784 the stack. */
0b9dfe2b
MD
785 if (gdbarch_inner_than (gdbarch, 1, 2))
786 sp -= gdbarch_frame_red_zone_size (gdbarch);
8b148df9 787 else
0b9dfe2b 788 sp += gdbarch_frame_red_zone_size (gdbarch);
8b148df9 789 /* Still aligned? */
0b9dfe2b 790 gdb_assert (sp == gdbarch_frame_align (gdbarch, sp));
ebc7896c
AC
791 /* NOTE: cagney/2002-09-18:
792
793 On a RISC architecture, a void parameterless generic dummy
794 frame (i.e., no parameters, no result) typically does not
795 need to push anything the stack and hence can leave SP and
c48a845b 796 FP. Similarly, a frameless (possibly leaf) function does
ebc7896c
AC
797 not push anything on the stack and, hence, that too can
798 leave FP and SP unchanged. As a consequence, a sequence of
799 void parameterless generic dummy frame calls to frameless
800 functions will create a sequence of effectively identical
801 frames (SP, FP and TOS and PC the same). This, not
802 suprisingly, results in what appears to be a stack in an
803 infinite loop --- when GDB tries to find a generic dummy
804 frame on the internal dummy frame stack, it will always
805 find the first one.
806
807 To avoid this problem, the code below always grows the
808 stack. That way, two dummy frames can never be identical.
809 It does burn a few bytes of stack but that is a small price
810 to pay :-). */
ebc7896c
AC
811 if (sp == old_sp)
812 {
0b9dfe2b 813 if (gdbarch_inner_than (gdbarch, 1, 2))
ebc7896c 814 /* Stack grows down. */
0b9dfe2b 815 sp = gdbarch_frame_align (gdbarch, old_sp - 1);
ebc7896c
AC
816 else
817 /* Stack grows up. */
0b9dfe2b 818 sp = gdbarch_frame_align (gdbarch, old_sp + 1);
ebc7896c 819 }
0e095b7e
JK
820 /* SP may have underflown address zero here from OLD_SP. Memory access
821 functions will probably fail in such case but that is a target's
822 problem. */
ebc7896c
AC
823 }
824 else
a59fe496
AC
825 /* FIXME: cagney/2002-09-18: Hey, you loose!
826
8b148df9
AC
827 Who knows how badly aligned the SP is!
828
829 If the generic dummy frame ends up empty (because nothing is
830 pushed) GDB won't be able to correctly perform back traces.
831 If a target is having trouble with backtraces, first thing to
1777feb0 832 do is add FRAME_ALIGN() to the architecture vector. If that
669fac23 833 fails, try dummy_id().
8b148df9
AC
834
835 If the ABI specifies a "Red Zone" (see the doco) the code
836 below will quietly trash it. */
ebc7896c 837 sp = old_sp;
6c659fc2
SC
838
839 /* Skip over the stack temporaries that might have been generated during
840 the evaluation of an expression. */
841 if (stack_temporaries)
842 {
843 struct value *lastval;
844
845 lastval = get_last_thread_stack_temporary (inferior_ptid);
846 if (lastval != NULL)
847 {
848 CORE_ADDR lastval_addr = value_address (lastval);
849
850 if (gdbarch_inner_than (gdbarch, 1, 2))
851 {
852 gdb_assert (sp >= lastval_addr);
853 sp = lastval_addr;
854 }
855 else
856 {
857 gdb_assert (sp <= lastval_addr);
858 sp = lastval_addr + TYPE_LENGTH (value_type (lastval));
859 }
860
861 if (gdbarch_frame_align_p (gdbarch))
862 sp = gdbarch_frame_align (gdbarch, sp);
863 }
864 }
ebc7896c 865 }
04714b91 866
8388016d
PA
867 type *ftype;
868 type *values_type;
869 CORE_ADDR funaddr = find_function_addr (function, &values_type, &ftype);
870
7022349d
PA
871 if (values_type == NULL)
872 values_type = default_return_type;
873 if (values_type == NULL)
874 {
875 const char *name = get_function_name (funaddr,
876 name_buf, sizeof (name_buf));
877 error (_("'%s' has unknown return type; "
878 "cast the call to its declared return type"),
879 name);
880 }
7788af6d 881
f168693b 882 values_type = check_typedef (values_type);
04714b91 883
41f1b697
DJ
884 /* Are we returning a value using a structure return (passing a
885 hidden argument pointing to storage) or a normal value return?
886 There are two cases: language-mandated structure return and
887 target ABI structure return. The variable STRUCT_RETURN only
888 describes the latter. The language version is handled by passing
889 the return location as the first parameter to the function,
890 even preceding "this". This is different from the target
891 ABI version, which is target-specific; for instance, on ia64
892 the first argument is passed in out0 but the hidden structure
893 return pointer would normally be passed in r8. */
894
18648a37 895 if (gdbarch_return_in_first_hidden_param_p (gdbarch, values_type))
41f1b697 896 {
18648a37 897 hidden_first_param_p = 1;
04714b91 898
41f1b697
DJ
899 /* Tell the target specific argument pushing routine not to
900 expect a value. */
48319d1f 901 target_values_type = builtin_type (gdbarch)->builtin_void;
41f1b697
DJ
902 }
903 else
904 {
6a3a010b 905 struct_return = using_struct_return (gdbarch, function, values_type);
41f1b697
DJ
906 target_values_type = values_type;
907 }
04714b91 908
76727919 909 gdb::observers::inferior_call_pre.notify (inferior_ptid, funaddr);
162078c8 910
7043d8dc
AC
911 /* Determine the location of the breakpoint (and possibly other
912 stuff) that the called function will return to. The SPARC, for a
913 function returning a structure or union, needs to make space for
914 not just the breakpoint but also an extra word containing the
915 size (?) of the structure being passed. */
916
0b9dfe2b 917 switch (gdbarch_call_dummy_location (gdbarch))
04714b91
AC
918 {
919 case ON_STACK:
a14dd77e
JK
920 {
921 const gdb_byte *bp_bytes;
922 CORE_ADDR bp_addr_as_address;
923 int bp_size;
924
925 /* Be careful BP_ADDR is in inferior PC encoding while
926 BP_ADDR_AS_ADDRESS is a plain memory address. */
927
928 sp = push_dummy_code (gdbarch, sp, funaddr, args, nargs,
929 target_values_type, &real_pc, &bp_addr,
930 get_current_regcache ());
931
932 /* Write a legitimate instruction at the point where the infcall
933 breakpoint is going to be inserted. While this instruction
934 is never going to be executed, a user investigating the
935 memory from GDB would see this instruction instead of random
936 uninitialized bytes. We chose the breakpoint instruction
937 as it may look as the most logical one to the user and also
938 valgrind 3.7.0 needs it for proper vgdb inferior calls.
939
940 If software breakpoints are unsupported for this target we
941 leave the user visible memory content uninitialized. */
942
943 bp_addr_as_address = bp_addr;
944 bp_bytes = gdbarch_breakpoint_from_pc (gdbarch, &bp_addr_as_address,
945 &bp_size);
946 if (bp_bytes != NULL)
947 write_memory (bp_addr_as_address, bp_bytes, bp_size);
948 }
7043d8dc 949 break;
5931a2fa
JK
950 case AT_ENTRY_POINT:
951 {
952 CORE_ADDR dummy_addr;
953
954 real_pc = funaddr;
955 dummy_addr = entry_point_address ();
a14dd77e 956
5931a2fa 957 /* A call dummy always consists of just a single breakpoint, so
a14dd77e
JK
958 its address is the same as the address of the dummy.
959
960 The actual breakpoint is inserted separatly so there is no need to
961 write that out. */
5931a2fa
JK
962 bp_addr = dummy_addr;
963 break;
964 }
04714b91 965 default:
e2e0b3e5 966 internal_error (__FILE__, __LINE__, _("bad switch"));
04714b91
AC
967 }
968
04714b91 969 if (nargs < TYPE_NFIELDS (ftype))
2e74121d 970 error (_("Too few arguments in function call."));
04714b91 971
ebc7896c
AC
972 {
973 int i;
abbb1732 974
ebc7896c
AC
975 for (i = nargs - 1; i >= 0; i--)
976 {
977 int prototyped;
978 struct type *param_type;
979
980 /* FIXME drow/2002-05-31: Should just always mark methods as
981 prototyped. Can we respect TYPE_VARARGS? Probably not. */
982 if (TYPE_CODE (ftype) == TYPE_CODE_METHOD)
983 prototyped = 1;
7022349d
PA
984 if (TYPE_TARGET_TYPE (ftype) == NULL && TYPE_NFIELDS (ftype) == 0
985 && default_return_type != NULL)
986 {
987 /* Calling a no-debug function with the return type
988 explicitly cast. Assume the function is prototyped,
989 with a prototype matching the types of the arguments.
990 E.g., with:
991 float mult (float v1, float v2) { return v1 * v2; }
992 This:
993 (gdb) p (float) mult (2.0f, 3.0f)
994 Is a simpler alternative to:
995 (gdb) p ((float (*) (float, float)) mult) (2.0f, 3.0f)
996 */
997 prototyped = 1;
998 }
ebc7896c
AC
999 else if (i < TYPE_NFIELDS (ftype))
1000 prototyped = TYPE_PROTOTYPED (ftype);
1001 else
1002 prototyped = 0;
1003
1004 if (i < TYPE_NFIELDS (ftype))
1005 param_type = TYPE_FIELD_TYPE (ftype, i);
1006 else
1007 param_type = NULL;
41f1b697 1008
7788af6d
UW
1009 args[i] = value_arg_coerce (gdbarch, args[i],
1010 param_type, prototyped, &sp);
ebc7896c 1011
41f1b697
DJ
1012 if (param_type != NULL && language_pass_by_reference (param_type))
1013 args[i] = value_addr (args[i]);
ebc7896c
AC
1014 }
1015 }
04714b91 1016
04714b91
AC
1017 /* Reserve space for the return structure to be written on the
1018 stack, if necessary. Make certain that the value is correctly
6c659fc2
SC
1019 aligned.
1020
1021 While evaluating expressions, we reserve space on the stack for
1022 return values of class type even if the language ABI and the target
1023 ABI do not require that the return value be passed as a hidden first
1024 argument. This is because we want to store the return value as an
1025 on-stack temporary while the expression is being evaluated. This
1026 enables us to have chained function calls in expressions.
04714b91 1027
6c659fc2
SC
1028 Keeping the return values as on-stack temporaries while the expression
1029 is being evaluated is OK because the thread is stopped until the
1030 expression is completely evaluated. */
1031
1032 if (struct_return || hidden_first_param_p
1033 || (stack_temporaries && class_or_union_p (values_type)))
04714b91 1034 {
0b9dfe2b 1035 if (gdbarch_inner_than (gdbarch, 1, 2))
04714b91
AC
1036 {
1037 /* Stack grows downward. Align STRUCT_ADDR and SP after
1038 making space for the return value. */
744a8059 1039 sp -= TYPE_LENGTH (values_type);
0b9dfe2b
MD
1040 if (gdbarch_frame_align_p (gdbarch))
1041 sp = gdbarch_frame_align (gdbarch, sp);
04714b91
AC
1042 struct_addr = sp;
1043 }
1044 else
1045 {
1046 /* Stack grows upward. Align the frame, allocate space, and
1777feb0 1047 then again, re-align the frame??? */
0b9dfe2b
MD
1048 if (gdbarch_frame_align_p (gdbarch))
1049 sp = gdbarch_frame_align (gdbarch, sp);
04714b91 1050 struct_addr = sp;
744a8059 1051 sp += TYPE_LENGTH (values_type);
0b9dfe2b
MD
1052 if (gdbarch_frame_align_p (gdbarch))
1053 sp = gdbarch_frame_align (gdbarch, sp);
04714b91
AC
1054 }
1055 }
1056
6ccb583f 1057 std::vector<struct value *> new_args;
18648a37 1058 if (hidden_first_param_p)
41f1b697 1059 {
41f1b697 1060 /* Add the new argument to the front of the argument list. */
6ccb583f
TT
1061 new_args.push_back
1062 (value_from_pointer (lookup_pointer_type (values_type), struct_addr));
1063 std::copy (&args[0], &args[nargs], std::back_inserter (new_args));
1064 args = new_args.data ();
41f1b697 1065 nargs++;
41f1b697 1066 }
41f1b697 1067
04714b91
AC
1068 /* Create the dummy stack frame. Pass in the call dummy address as,
1069 presumably, the ABI code knows where, in the call dummy, the
1070 return address should be pointed. */
0b9dfe2b
MD
1071 sp = gdbarch_push_dummy_call (gdbarch, function, get_current_regcache (),
1072 bp_addr, nargs, args,
594f7785 1073 sp, struct_return, struct_addr);
04714b91 1074
96860204
AC
1075 /* Set up a frame ID for the dummy frame so we can pass it to
1076 set_momentary_breakpoint. We need to give the breakpoint a frame
1077 ID so that the breakpoint code can correctly re-identify the
1078 dummy breakpoint. */
8241eaa6 1079 /* Sanity. The exact same SP value is returned by PUSH_DUMMY_CALL,
669fac23 1080 saved as the dummy-frame TOS, and used by dummy_id to form
8241eaa6 1081 the frame ID's stack address. */
96860204 1082 dummy_id = frame_id_build (sp, bp_addr);
04714b91 1083
74cfe982
AC
1084 /* Create a momentary breakpoint at the return address of the
1085 inferior. That way it breaks when it returns. */
04714b91 1086
74cfe982 1087 {
51abb421 1088 symtab_and_line sal;
6c95b8df 1089 sal.pspace = current_program_space;
74cfe982
AC
1090 sal.pc = bp_addr;
1091 sal.section = find_pc_overlay (sal.pc);
51abb421 1092
8241eaa6
AC
1093 /* Sanity. The exact same SP value is returned by
1094 PUSH_DUMMY_CALL, saved as the dummy-frame TOS, and used by
669fac23 1095 dummy_id to form the frame ID's stack address. */
454dafbd
TT
1096 breakpoint *bpt
1097 = set_momentary_breakpoint (gdbarch, sal,
1098 dummy_id, bp_call_dummy).release ();
c70a6932
JK
1099
1100 /* set_momentary_breakpoint invalidates FRAME. */
1101 frame = NULL;
1102
74cfe982 1103 bpt->disposition = disp_del;
e2e4d78b
JK
1104 gdb_assert (bpt->related_breakpoint == bpt);
1105
51abb421 1106 breakpoint *longjmp_b = set_longjmp_breakpoint_for_call_dummy ();
e2e4d78b
JK
1107 if (longjmp_b)
1108 {
1109 /* Link BPT into the chain of LONGJMP_B. */
1110 bpt->related_breakpoint = longjmp_b;
1111 while (longjmp_b->related_breakpoint != bpt->related_breakpoint)
1112 longjmp_b = longjmp_b->related_breakpoint;
1113 longjmp_b->related_breakpoint = bpt;
1114 }
74cfe982 1115 }
04714b91 1116
7cd1089b
PM
1117 /* Create a breakpoint in std::terminate.
1118 If a C++ exception is raised in the dummy-frame, and the
1119 exception handler is (normally, and expected to be) out-of-frame,
1120 the default C++ handler will (wrongly) be called in an inferior
1121 function call. This is wrong, as an exception can be normally
1122 and legally handled out-of-frame. The confines of the dummy frame
1123 prevent the unwinder from finding the correct handler (or any
1124 handler, unless it is in-frame). The default handler calls
1125 std::terminate. This will kill the inferior. Assert that
1126 terminate should never be called in an inferior function
1127 call. Place a momentary breakpoint in the std::terminate function
1128 and if triggered in the call, rewind. */
1129 if (unwind_on_terminating_exception_p)
aa7d318d 1130 set_std_terminate_breakpoint ();
7cd1089b 1131
8a6c4031
JK
1132 /* Discard both inf_status and caller_state cleanups.
1133 From this point on we explicitly restore the associated state
1134 or discard it. */
1135 discard_cleanups (inf_status_cleanup);
1136
96860204
AC
1137 /* Everything's ready, push all the info needed to restore the
1138 caller (and identify the dummy-frame) onto the dummy-frame
1139 stack. */
b67a2c6f 1140 dummy_frame_push (caller_state, &dummy_id, inferior_ptid);
ed12ef62
JK
1141 if (dummy_dtor != NULL)
1142 register_dummy_frame_dtor (dummy_id, inferior_ptid,
1143 dummy_dtor, dummy_dtor_data);
b89667eb 1144
7cd1089b 1145 /* Register a clean-up for unwind_on_terminating_exception_breakpoint. */
aa7d318d
TT
1146 terminate_bp_cleanup = make_cleanup (cleanup_delete_std_terminate_breakpoint,
1147 NULL);
7cd1089b 1148
96860204
AC
1149 /* - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP - SNIP -
1150 If you're looking to implement asynchronous dummy-frames, then
1151 just below is the place to chop this function in two.. */
1152
b89667eb
DE
1153 /* TP is invalid after run_inferior_call returns, so enclose this
1154 in a block so that it's only in scope during the time it's valid. */
74cfe982 1155 {
32400beb 1156 struct thread_info *tp = inferior_thread ();
388a7084
PA
1157 struct thread_fsm *saved_sm;
1158 struct call_thread_fsm *sm;
1159
1160 /* Save the current FSM. We'll override it. */
1161 saved_sm = tp->thread_fsm;
1162 tp->thread_fsm = NULL;
74cfe982 1163
b89667eb
DE
1164 /* Save this thread's ptid, we need it later but the thread
1165 may have exited. */
1166 call_thread_ptid = tp->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
1180 e = run_inferior_call (sm, tp, real_pc);
1181
76727919 1182 gdb::observers::inferior_call_post.notify (call_thread_ptid, funaddr);
388a7084
PA
1183
1184 tp = find_thread_ptid (call_thread_ptid);
1185 if (tp != NULL)
1186 {
1187 /* The FSM should still be the same. */
1188 gdb_assert (tp->thread_fsm == &sm->thread_fsm);
1189
1190 if (thread_fsm_finished_p (tp->thread_fsm))
1191 {
1192 struct value *retval;
1193
1194 /* The inferior call is successful. Pop the dummy frame,
1195 which runs its destructors and restores the inferior's
1196 suspend state, and restore the inferior control
1197 state. */
1198 dummy_frame_pop (dummy_id, call_thread_ptid);
1199 restore_infcall_control_state (inf_status);
1200
1201 /* Get the return value. */
1202 retval = sm->return_value;
1203
1204 /* Clean up / destroy the call FSM, and restore the
1205 original one. */
8980e177 1206 thread_fsm_clean_up (tp->thread_fsm, tp);
388a7084
PA
1207 thread_fsm_delete (tp->thread_fsm);
1208 tp->thread_fsm = saved_sm;
04714b91 1209
388a7084
PA
1210 maybe_remove_breakpoints ();
1211
1212 do_cleanups (terminate_bp_cleanup);
1213 gdb_assert (retval != NULL);
1214 return retval;
1215 }
1216
1217 /* Didn't complete. Restore previous state machine, and
1218 handle the error. */
1219 tp->thread_fsm = saved_sm;
1220 }
1221 }
162078c8 1222
b89667eb
DE
1223 /* Rethrow an error if we got one trying to run the inferior. */
1224
1225 if (e.reason < 0)
1226 {
1227 const char *name = get_function_name (funaddr,
1228 name_buf, sizeof (name_buf));
1229
16c381f0 1230 discard_infcall_control_state (inf_status);
b89667eb
DE
1231
1232 /* We could discard the dummy frame here if the program exited,
1233 but it will get garbage collected the next time the program is
1234 run anyway. */
1235
1236 switch (e.reason)
1237 {
1238 case RETURN_ERROR:
ac74f770
MS
1239 throw_error (e.error, _("%s\n\
1240An error occurred while in a function called from GDB.\n\
1241Evaluation of the expression containing the function\n\
1242(%s) will be abandoned.\n\
1243When the function is done executing, GDB will silently stop."),
b89667eb
DE
1244 e.message, name);
1245 case RETURN_QUIT:
1246 default:
1247 throw_exception (e);
1248 }
1249 }
1250
1251 /* If the program has exited, or we stopped at a different thread,
1252 exit and inform the user. */
1253
de04a248
DE
1254 if (! target_has_execution)
1255 {
b89667eb
DE
1256 const char *name = get_function_name (funaddr,
1257 name_buf, sizeof (name_buf));
1258
1259 /* If we try to restore the inferior status,
de04a248 1260 we'll crash as the inferior is no longer running. */
16c381f0 1261 discard_infcall_control_state (inf_status);
b89667eb
DE
1262
1263 /* We could discard the dummy frame here given that the program exited,
1264 but it will get garbage collected the next time the program is
1265 run anyway. */
1266
3e43a32a
MS
1267 error (_("The program being debugged exited while in a function "
1268 "called from GDB.\n"
1269 "Evaluation of the expression containing the function\n"
1270 "(%s) will be abandoned."),
b89667eb
DE
1271 name);
1272 }
1273
1274 if (! ptid_equal (call_thread_ptid, inferior_ptid))
1275 {
1276 const char *name = get_function_name (funaddr,
1277 name_buf, sizeof (name_buf));
1278
1279 /* We've switched threads. This can happen if another thread gets a
1280 signal or breakpoint while our thread was running.
1281 There's no point in restoring the inferior status,
1282 we're in a different thread. */
16c381f0 1283 discard_infcall_control_state (inf_status);
b89667eb
DE
1284 /* Keep the dummy frame record, if the user switches back to the
1285 thread with the hand-call, we'll need it. */
1286 if (stopped_by_random_signal)
ac74f770
MS
1287 error (_("\
1288The program received a signal in another thread while\n\
1289making a function call from GDB.\n\
1290Evaluation of the expression containing the function\n\
1291(%s) will be abandoned.\n\
1292When the function is done executing, GDB will silently stop."),
b89667eb
DE
1293 name);
1294 else
ac74f770
MS
1295 error (_("\
1296The program stopped in another thread while making a function call from GDB.\n\
1297Evaluation of the expression containing the function\n\
1298(%s) will be abandoned.\n\
1299When the function is done executing, GDB will silently stop."),
b89667eb 1300 name);
de04a248
DE
1301 }
1302
52557533 1303 {
5fe75eec 1304 /* Make a copy as NAME may be in an objfile freed by dummy_frame_pop. */
395423c4
TT
1305 std::string name = get_function_name (funaddr, name_buf,
1306 sizeof (name_buf));
b89667eb 1307
52557533
AC
1308 if (stopped_by_random_signal)
1309 {
1310 /* We stopped inside the FUNCTION because of a random
1311 signal. Further execution of the FUNCTION is not
1777feb0 1312 allowed. */
04714b91 1313
52557533
AC
1314 if (unwind_on_signal_p)
1315 {
1777feb0 1316 /* The user wants the context restored. */
52557533
AC
1317
1318 /* We must get back to the frame we were before the
b89667eb 1319 dummy call. */
b67a2c6f 1320 dummy_frame_pop (dummy_id, call_thread_ptid);
b89667eb
DE
1321
1322 /* We also need to restore inferior status to that before the
1323 dummy call. */
16c381f0 1324 restore_infcall_control_state (inf_status);
04714b91 1325
52557533
AC
1326 /* FIXME: Insert a bunch of wrap_here; name can be very
1327 long if it's a C++ name with arguments and stuff. */
ac74f770
MS
1328 error (_("\
1329The program being debugged was signaled while in a function called from GDB.\n\
1330GDB has restored the context to what it was before the call.\n\
1331To change this behavior use \"set unwindonsignal off\".\n\
1332Evaluation of the expression containing the function\n\
1333(%s) will be abandoned."),
395423c4 1334 name.c_str ());
52557533
AC
1335 }
1336 else
1337 {
1338 /* The user wants to stay in the frame where we stopped
b89667eb
DE
1339 (default).
1340 Discard inferior status, we're not at the same point
1341 we started at. */
16c381f0 1342 discard_infcall_control_state (inf_status);
b89667eb 1343
52557533
AC
1344 /* FIXME: Insert a bunch of wrap_here; name can be very
1345 long if it's a C++ name with arguments and stuff. */
ac74f770
MS
1346 error (_("\
1347The program being debugged was signaled while in a function called from GDB.\n\
1348GDB remains in the frame where the signal was received.\n\
1349To change this behavior use \"set unwindonsignal on\".\n\
1350Evaluation of the expression containing the function\n\
1351(%s) will be abandoned.\n\
1352When the function is done executing, GDB will silently stop."),
395423c4 1353 name.c_str ());
52557533
AC
1354 }
1355 }
04714b91 1356
aa7d318d 1357 if (stop_stack_dummy == STOP_STD_TERMINATE)
52557533 1358 {
aa7d318d
TT
1359 /* We must get back to the frame we were before the dummy
1360 call. */
b67a2c6f 1361 dummy_frame_pop (dummy_id, call_thread_ptid);
7cd1089b 1362
aa7d318d
TT
1363 /* We also need to restore inferior status to that before
1364 the dummy call. */
16c381f0 1365 restore_infcall_control_state (inf_status);
aa7d318d 1366
ac74f770
MS
1367 error (_("\
1368The program being debugged entered a std::terminate call, most likely\n\
1369caused by an unhandled C++ exception. GDB blocked this call in order\n\
1370to prevent the program from being terminated, and has restored the\n\
1371context to its original state before the call.\n\
1372To change this behaviour use \"set unwind-on-terminating-exception off\".\n\
1373Evaluation of the expression containing the function (%s)\n\
1374will be abandoned."),
395423c4 1375 name.c_str ());
aa7d318d
TT
1376 }
1377 else if (stop_stack_dummy == STOP_NONE)
1378 {
1379
b89667eb
DE
1380 /* We hit a breakpoint inside the FUNCTION.
1381 Keep the dummy frame, the user may want to examine its state.
1382 Discard inferior status, we're not at the same point
1383 we started at. */
16c381f0 1384 discard_infcall_control_state (inf_status);
b89667eb 1385
52557533
AC
1386 /* The following error message used to say "The expression
1387 which contained the function call has been discarded."
1388 It is a hard concept to explain in a few words. Ideally,
1389 GDB would be able to resume evaluation of the expression
1390 when the function finally is done executing. Perhaps
1391 someday this will be implemented (it would not be easy). */
1392 /* FIXME: Insert a bunch of wrap_here; name can be very long if it's
1393 a C++ name with arguments and stuff. */
ac74f770
MS
1394 error (_("\
1395The program being debugged stopped while in a function called from GDB.\n\
1396Evaluation of the expression containing the function\n\
1397(%s) will be abandoned.\n\
1398When the function is done executing, GDB will silently stop."),
395423c4 1399 name.c_str ());
52557533
AC
1400 }
1401
52557533 1402 }
04714b91 1403
388a7084
PA
1404 /* The above code errors out, so ... */
1405 gdb_assert_not_reached ("... should not be here");
04714b91 1406}
04714b91
AC
1407
1408void
1409_initialize_infcall (void)
1410{
1411 add_setshow_boolean_cmd ("coerce-float-to-double", class_obscure,
7915a72c
AC
1412 &coerce_float_to_double_p, _("\
1413Set coercion of floats to doubles when calling functions."), _("\
1414Show coercion of floats to doubles when calling functions"), _("\
04714b91
AC
1415Variables of type float should generally be converted to doubles before\n\
1416calling an unprototyped function, and left alone when calling a prototyped\n\
1417function. However, some older debug info formats do not provide enough\n\
1418information to determine that a function is prototyped. If this flag is\n\
1419set, GDB will perform the conversion for a function it considers\n\
1420unprototyped.\n\
7915a72c 1421The default is to perform the conversion.\n"),
2c5b56ce 1422 NULL,
920d2a44 1423 show_coerce_float_to_double_p,
2c5b56ce 1424 &setlist, &showlist);
04714b91
AC
1425
1426 add_setshow_boolean_cmd ("unwindonsignal", no_class,
7915a72c
AC
1427 &unwind_on_signal_p, _("\
1428Set unwinding of stack if a signal is received while in a call dummy."), _("\
1429Show unwinding of stack if a signal is received while in a call dummy."), _("\
04714b91
AC
1430The unwindonsignal lets the user determine what gdb should do if a signal\n\
1431is received while in a function called from gdb (call dummy). If set, gdb\n\
1432unwinds the stack and restore the context to what as it was before the call.\n\
7915a72c 1433The default is to stop in the frame where the signal was received."),
2c5b56ce 1434 NULL,
920d2a44 1435 show_unwind_on_signal_p,
2c5b56ce 1436 &setlist, &showlist);
7cd1089b
PM
1437
1438 add_setshow_boolean_cmd ("unwind-on-terminating-exception", no_class,
1439 &unwind_on_terminating_exception_p, _("\
1440Set unwinding of stack if std::terminate is called while in call dummy."), _("\
3e43a32a
MS
1441Show unwinding of stack if std::terminate() is called while in a call dummy."),
1442 _("\
7cd1089b
PM
1443The unwind on terminating exception flag lets the user determine\n\
1444what gdb should do if a std::terminate() call is made from the\n\
1445default exception handler. If set, gdb unwinds the stack and restores\n\
1446the context to what it was before the call. If unset, gdb allows the\n\
1447std::terminate call to proceed.\n\
1448The default is to unwind the frame."),
1449 NULL,
1450 show_unwind_on_terminating_exception_p,
1451 &setlist, &showlist);
1452
04714b91 1453}
This page took 1.786865 seconds and 4 git commands to generate.