* x86-64-tdep.c (x86_64_supply_fxsave): Add `regnum' argument.
[binutils-gdb.git] / gdb / infcall.c
1 /* Perform an inferior function call, for GDB, the GNU debugger.
2
3 Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994,
4 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software
5 Foundation, Inc.
6
7 This file is part of GDB.
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
23
24 #include "defs.h"
25 #include "breakpoint.h"
26 #include "target.h"
27 #include "regcache.h"
28 #include "inferior.h"
29 #include "gdb_assert.h"
30 #include "block.h"
31 #include "gdbcore.h"
32 #include "language.h"
33 #include "symfile.h"
34 #include "gdbcmd.h"
35 #include "command.h"
36 #include "gdb_string.h"
37 #include "infcall.h"
38
39 /* NOTE: cagney/2003-04-16: What's the future of this code?
40
41 GDB needs an asynchronous expression evaluator, that means an
42 asynchronous inferior function call implementation, and that in
43 turn means restructuring the code so that it is event driven. */
44
45 /* How you should pass arguments to a function depends on whether it
46 was defined in K&R style or prototype style. If you define a
47 function using the K&R syntax that takes a `float' argument, then
48 callers must pass that argument as a `double'. If you define the
49 function using the prototype syntax, then you must pass the
50 argument as a `float', with no promotion.
51
52 Unfortunately, on certain older platforms, the debug info doesn't
53 indicate reliably how each function was defined. A function type's
54 TYPE_FLAG_PROTOTYPED flag may be clear, even if the function was
55 defined in prototype style. When calling a function whose
56 TYPE_FLAG_PROTOTYPED flag is clear, GDB consults this flag to
57 decide what to do.
58
59 For modern targets, it is proper to assume that, if the prototype
60 flag is clear, that can be trusted: `float' arguments should be
61 promoted to `double'. For some older targets, if the prototype
62 flag is clear, that doesn't tell us anything. The default is to
63 trust the debug information; the user can override this behavior
64 with "set coerce-float-to-double 0". */
65
66 static int coerce_float_to_double_p = 1;
67
68 /* This boolean tells what gdb should do if a signal is received while
69 in a function called from gdb (call dummy). If set, gdb unwinds
70 the stack and restore the context to what as it was before the
71 call.
72
73 The default is to stop in the frame where the signal was received. */
74
75 int unwind_on_signal_p = 0;
76
77 /* Perform the standard coercions that are specified
78 for arguments to be passed to C functions.
79
80 If PARAM_TYPE is non-NULL, it is the expected parameter type.
81 IS_PROTOTYPED is non-zero if the function declaration is prototyped. */
82
83 static struct value *
84 value_arg_coerce (struct value *arg, struct type *param_type,
85 int is_prototyped)
86 {
87 register struct type *arg_type = check_typedef (VALUE_TYPE (arg));
88 register struct type *type
89 = param_type ? check_typedef (param_type) : arg_type;
90
91 switch (TYPE_CODE (type))
92 {
93 case TYPE_CODE_REF:
94 if (TYPE_CODE (arg_type) != TYPE_CODE_REF
95 && TYPE_CODE (arg_type) != TYPE_CODE_PTR)
96 {
97 arg = value_addr (arg);
98 VALUE_TYPE (arg) = param_type;
99 return arg;
100 }
101 break;
102 case TYPE_CODE_INT:
103 case TYPE_CODE_CHAR:
104 case TYPE_CODE_BOOL:
105 case TYPE_CODE_ENUM:
106 /* If we don't have a prototype, coerce to integer type if necessary. */
107 if (!is_prototyped)
108 {
109 if (TYPE_LENGTH (type) < TYPE_LENGTH (builtin_type_int))
110 type = builtin_type_int;
111 }
112 /* Currently all target ABIs require at least the width of an integer
113 type for an argument. We may have to conditionalize the following
114 type coercion for future targets. */
115 if (TYPE_LENGTH (type) < TYPE_LENGTH (builtin_type_int))
116 type = builtin_type_int;
117 break;
118 case TYPE_CODE_FLT:
119 if (!is_prototyped && coerce_float_to_double_p)
120 {
121 if (TYPE_LENGTH (type) < TYPE_LENGTH (builtin_type_double))
122 type = builtin_type_double;
123 else if (TYPE_LENGTH (type) > TYPE_LENGTH (builtin_type_double))
124 type = builtin_type_long_double;
125 }
126 break;
127 case TYPE_CODE_FUNC:
128 type = lookup_pointer_type (type);
129 break;
130 case TYPE_CODE_ARRAY:
131 /* Arrays are coerced to pointers to their first element, unless
132 they are vectors, in which case we want to leave them alone,
133 because they are passed by value. */
134 if (current_language->c_style_arrays)
135 if (!TYPE_VECTOR (type))
136 type = lookup_pointer_type (TYPE_TARGET_TYPE (type));
137 break;
138 case TYPE_CODE_UNDEF:
139 case TYPE_CODE_PTR:
140 case TYPE_CODE_STRUCT:
141 case TYPE_CODE_UNION:
142 case TYPE_CODE_VOID:
143 case TYPE_CODE_SET:
144 case TYPE_CODE_RANGE:
145 case TYPE_CODE_STRING:
146 case TYPE_CODE_BITSTRING:
147 case TYPE_CODE_ERROR:
148 case TYPE_CODE_MEMBER:
149 case TYPE_CODE_METHOD:
150 case TYPE_CODE_COMPLEX:
151 default:
152 break;
153 }
154
155 return value_cast (type, arg);
156 }
157
158 /* Determine a function's address and its return type from its value.
159 Calls error() if the function is not valid for calling. */
160
161 CORE_ADDR
162 find_function_addr (struct value *function, struct type **retval_type)
163 {
164 register struct type *ftype = check_typedef (VALUE_TYPE (function));
165 register enum type_code code = TYPE_CODE (ftype);
166 struct type *value_type;
167 CORE_ADDR funaddr;
168
169 /* If it's a member function, just look at the function
170 part of it. */
171
172 /* Determine address to call. */
173 if (code == TYPE_CODE_FUNC || code == TYPE_CODE_METHOD)
174 {
175 funaddr = VALUE_ADDRESS (function);
176 value_type = TYPE_TARGET_TYPE (ftype);
177 }
178 else if (code == TYPE_CODE_PTR)
179 {
180 funaddr = value_as_address (function);
181 ftype = check_typedef (TYPE_TARGET_TYPE (ftype));
182 if (TYPE_CODE (ftype) == TYPE_CODE_FUNC
183 || TYPE_CODE (ftype) == TYPE_CODE_METHOD)
184 {
185 funaddr = CONVERT_FROM_FUNC_PTR_ADDR (funaddr);
186 value_type = TYPE_TARGET_TYPE (ftype);
187 }
188 else
189 value_type = builtin_type_int;
190 }
191 else if (code == TYPE_CODE_INT)
192 {
193 /* Handle the case of functions lacking debugging info.
194 Their values are characters since their addresses are char */
195 if (TYPE_LENGTH (ftype) == 1)
196 funaddr = value_as_address (value_addr (function));
197 else
198 /* Handle integer used as address of a function. */
199 funaddr = (CORE_ADDR) value_as_long (function);
200
201 value_type = builtin_type_int;
202 }
203 else
204 error ("Invalid data type for function to be called.");
205
206 *retval_type = value_type;
207 return funaddr;
208 }
209
210 /* Call breakpoint_auto_delete on the current contents of the bpstat
211 pointed to by arg (which is really a bpstat *). */
212
213 static void
214 breakpoint_auto_delete_contents (void *arg)
215 {
216 breakpoint_auto_delete (*(bpstat *) arg);
217 }
218
219 static CORE_ADDR
220 legacy_push_dummy_code (struct gdbarch *gdbarch,
221 CORE_ADDR sp, CORE_ADDR funaddr, int using_gcc,
222 struct value **args, int nargs,
223 struct type *value_type,
224 CORE_ADDR *real_pc, CORE_ADDR *bp_addr)
225 {
226 /* CALL_DUMMY is an array of words (DEPRECATED_REGISTER_SIZE), but
227 each word is in host byte order. Before calling
228 DEPRECATED_FIX_CALL_DUMMY, we byteswap it and remove any extra
229 bytes which might exist because ULONGEST is bigger than
230 DEPRECATED_REGISTER_SIZE. */
231 /* NOTE: This is pretty wierd, as the call dummy is actually a
232 sequence of instructions. But CISC machines will have to pack
233 the instructions into DEPRECATED_REGISTER_SIZE units (and so will
234 RISC machines for which INSTRUCTION_SIZE is not
235 DEPRECATED_REGISTER_SIZE). */
236 /* NOTE: This is pretty stupid. CALL_DUMMY should be in strict
237 target byte order. */
238 CORE_ADDR start_sp;
239 ULONGEST *dummy = alloca (DEPRECATED_SIZEOF_CALL_DUMMY_WORDS);
240 int sizeof_dummy1 = (DEPRECATED_REGISTER_SIZE
241 * DEPRECATED_SIZEOF_CALL_DUMMY_WORDS
242 / sizeof (ULONGEST));
243 char *dummy1 = alloca (sizeof_dummy1);
244 memcpy (dummy, DEPRECATED_CALL_DUMMY_WORDS,
245 DEPRECATED_SIZEOF_CALL_DUMMY_WORDS);
246 if (INNER_THAN (1, 2))
247 {
248 /* Stack grows down */
249 sp -= sizeof_dummy1;
250 start_sp = sp;
251 }
252 else
253 {
254 /* Stack grows up */
255 start_sp = sp;
256 sp += sizeof_dummy1;
257 }
258 /* NOTE: cagney/2002-09-10: Don't bother re-adjusting the stack
259 after allocating space for the call dummy. A target can specify
260 a SIZEOF_DUMMY1 (via DEPRECATED_SIZEOF_CALL_DUMMY_WORDS) such
261 that all local alignment requirements are met. */
262 /* Create a call sequence customized for this function and the
263 number of arguments for it. */
264 {
265 int i;
266 for (i = 0; i < (int) (DEPRECATED_SIZEOF_CALL_DUMMY_WORDS / sizeof (dummy[0]));
267 i++)
268 store_unsigned_integer (&dummy1[i * DEPRECATED_REGISTER_SIZE],
269 DEPRECATED_REGISTER_SIZE,
270 (ULONGEST) dummy[i]);
271 }
272 /* NOTE: cagney/2003-04-22: This computation of REAL_PC, BP_ADDR and
273 DUMMY_ADDR is pretty messed up. It comes from constant tinkering
274 with the values. Instead a DEPRECATED_FIX_CALL_DUMMY replacement
275 (PUSH_DUMMY_BREAKPOINT?) should just do everything. */
276 #ifdef GDB_TARGET_IS_HPPA
277 (*real_pc) = DEPRECATED_FIX_CALL_DUMMY (dummy1, start_sp, funaddr, nargs,
278 args, value_type, using_gcc);
279 #else
280 if (DEPRECATED_FIX_CALL_DUMMY_P ())
281 {
282 /* gdb_assert (CALL_DUMMY_LOCATION == ON_STACK) true? */
283 DEPRECATED_FIX_CALL_DUMMY (dummy1, start_sp, funaddr, nargs, args,
284 value_type, using_gcc);
285 }
286 (*real_pc) = start_sp;
287 #endif
288 /* Yes, the offset is applied to the real_pc and not the dummy addr.
289 Ulgh! Blame the HP/UX target. */
290 (*bp_addr) = (*real_pc) + DEPRECATED_CALL_DUMMY_BREAKPOINT_OFFSET;
291 /* Yes, the offset is applied to the real_pc and not the
292 dummy_addr. Ulgh! Blame the HP/UX target. */
293 (*real_pc) += DEPRECATED_CALL_DUMMY_START_OFFSET;
294 write_memory (start_sp, (char *) dummy1, sizeof_dummy1);
295 if (DEPRECATED_USE_GENERIC_DUMMY_FRAMES)
296 generic_save_call_dummy_addr (start_sp, start_sp + sizeof_dummy1);
297 return sp;
298 }
299
300 static CORE_ADDR
301 generic_push_dummy_code (struct gdbarch *gdbarch,
302 CORE_ADDR sp, CORE_ADDR funaddr, int using_gcc,
303 struct value **args, int nargs,
304 struct type *value_type,
305 CORE_ADDR *real_pc, CORE_ADDR *bp_addr)
306 {
307 /* Something here to findout the size of a breakpoint and then
308 allocate space for it on the stack. */
309 int bplen;
310 /* This code assumes frame align. */
311 gdb_assert (gdbarch_frame_align_p (gdbarch));
312 /* Force the stack's alignment. The intent is to ensure that the SP
313 is aligned to at least a breakpoint instruction's boundary. */
314 sp = gdbarch_frame_align (gdbarch, sp);
315 /* Allocate space for, and then position the breakpoint on the
316 stack. */
317 if (gdbarch_inner_than (gdbarch, 1, 2))
318 {
319 CORE_ADDR bppc = sp;
320 gdbarch_breakpoint_from_pc (gdbarch, &bppc, &bplen);
321 sp = gdbarch_frame_align (gdbarch, sp - bplen);
322 (*bp_addr) = sp;
323 /* Should the breakpoint size/location be re-computed here? */
324 }
325 else
326 {
327 (*bp_addr) = sp;
328 gdbarch_breakpoint_from_pc (gdbarch, bp_addr, &bplen);
329 sp = gdbarch_frame_align (gdbarch, sp + bplen);
330 }
331 /* Inferior resumes at the function entry point. */
332 (*real_pc) = funaddr;
333 return sp;
334 }
335
336 /* Provide backward compatibility. Once DEPRECATED_FIX_CALL_DUMMY is
337 eliminated, this can be simplified. */
338
339 static CORE_ADDR
340 push_dummy_code (struct gdbarch *gdbarch,
341 CORE_ADDR sp, CORE_ADDR funaddr, int using_gcc,
342 struct value **args, int nargs,
343 struct type *value_type,
344 CORE_ADDR *real_pc, CORE_ADDR *bp_addr)
345 {
346 if (gdbarch_push_dummy_code_p (gdbarch))
347 return gdbarch_push_dummy_code (gdbarch, sp, funaddr, using_gcc,
348 args, nargs, value_type, real_pc, bp_addr);
349 else if (DEPRECATED_FIX_CALL_DUMMY_P ())
350 return legacy_push_dummy_code (gdbarch, sp, funaddr, using_gcc,
351 args, nargs, value_type, real_pc, bp_addr);
352 else
353 return generic_push_dummy_code (gdbarch, sp, funaddr, using_gcc,
354 args, nargs, value_type, real_pc, bp_addr);
355 }
356
357 /* All this stuff with a dummy frame may seem unnecessarily complicated
358 (why not just save registers in GDB?). The purpose of pushing a dummy
359 frame which looks just like a real frame is so that if you call a
360 function and then hit a breakpoint (get a signal, etc), "backtrace"
361 will look right. Whether the backtrace needs to actually show the
362 stack at the time the inferior function was called is debatable, but
363 it certainly needs to not display garbage. So if you are contemplating
364 making dummy frames be different from normal frames, consider that. */
365
366 /* Perform a function call in the inferior.
367 ARGS is a vector of values of arguments (NARGS of them).
368 FUNCTION is a value, the function to be called.
369 Returns a value representing what the function returned.
370 May fail to return, if a breakpoint or signal is hit
371 during the execution of the function.
372
373 ARGS is modified to contain coerced values. */
374
375 struct value *
376 call_function_by_hand (struct value *function, int nargs, struct value **args)
377 {
378 register CORE_ADDR sp;
379 CORE_ADDR dummy_addr;
380 struct type *value_type;
381 unsigned char struct_return;
382 CORE_ADDR struct_addr = 0;
383 struct regcache *retbuf;
384 struct cleanup *retbuf_cleanup;
385 struct inferior_status *inf_status;
386 struct cleanup *inf_status_cleanup;
387 CORE_ADDR funaddr;
388 int using_gcc; /* Set to version of gcc in use, or zero if not gcc */
389 CORE_ADDR real_pc;
390 struct type *ftype = check_typedef (SYMBOL_TYPE (function));
391 CORE_ADDR bp_addr;
392
393 if (!target_has_execution)
394 noprocess ();
395
396 /* Create a cleanup chain that contains the retbuf (buffer
397 containing the register values). This chain is create BEFORE the
398 inf_status chain so that the inferior status can cleaned up
399 (restored or discarded) without having the retbuf freed. */
400 retbuf = regcache_xmalloc (current_gdbarch);
401 retbuf_cleanup = make_cleanup_regcache_xfree (retbuf);
402
403 /* A cleanup for the inferior status. Create this AFTER the retbuf
404 so that this can be discarded or applied without interfering with
405 the regbuf. */
406 inf_status = save_inferior_status (1);
407 inf_status_cleanup = make_cleanup_restore_inferior_status (inf_status);
408
409 if (DEPRECATED_PUSH_DUMMY_FRAME_P ())
410 {
411 /* DEPRECATED_PUSH_DUMMY_FRAME is responsible for saving the
412 inferior registers (and frame_pop() for restoring them). (At
413 least on most machines) they are saved on the stack in the
414 inferior. */
415 DEPRECATED_PUSH_DUMMY_FRAME;
416 }
417 else
418 {
419 /* FIXME: cagney/2003-02-26: Step zero of this little tinker is
420 to extract the generic dummy frame code from the architecture
421 vector. Hence this direct call.
422
423 A follow-on change is to modify this interface so that it takes
424 thread OR frame OR ptid as a parameter, and returns a dummy
425 frame handle. The handle can then be used further down as a
426 parameter to generic_save_dummy_frame_tos(). Hmm, thinking
427 about it, since everything is ment to be using generic dummy
428 frames, why not even use some of the dummy frame code to here -
429 do a regcache dup and then pass the duped regcache, along with
430 all the other stuff, at one single point.
431
432 In fact, you can even save the structure's return address in the
433 dummy frame and fix one of those nasty lost struct return edge
434 conditions. */
435 generic_push_dummy_frame ();
436 }
437
438 /* Ensure that the initial SP is correctly aligned. */
439 {
440 CORE_ADDR old_sp = read_sp ();
441 if (gdbarch_frame_align_p (current_gdbarch))
442 {
443 sp = gdbarch_frame_align (current_gdbarch, old_sp);
444 /* NOTE: cagney/2003-08-13: Skip the "red zone". For some
445 ABIs, a function can use memory beyond the inner most stack
446 address. AMD64 called that region the "red zone". Skip at
447 least the "red zone" size before allocating any space on
448 the stack. */
449 if (INNER_THAN (1, 2))
450 sp -= gdbarch_frame_red_zone_size (current_gdbarch);
451 else
452 sp += gdbarch_frame_red_zone_size (current_gdbarch);
453 /* Still aligned? */
454 gdb_assert (sp == gdbarch_frame_align (current_gdbarch, sp));
455 /* NOTE: cagney/2002-09-18:
456
457 On a RISC architecture, a void parameterless generic dummy
458 frame (i.e., no parameters, no result) typically does not
459 need to push anything the stack and hence can leave SP and
460 FP. Similarly, a frameless (possibly leaf) function does
461 not push anything on the stack and, hence, that too can
462 leave FP and SP unchanged. As a consequence, a sequence of
463 void parameterless generic dummy frame calls to frameless
464 functions will create a sequence of effectively identical
465 frames (SP, FP and TOS and PC the same). This, not
466 suprisingly, results in what appears to be a stack in an
467 infinite loop --- when GDB tries to find a generic dummy
468 frame on the internal dummy frame stack, it will always
469 find the first one.
470
471 To avoid this problem, the code below always grows the
472 stack. That way, two dummy frames can never be identical.
473 It does burn a few bytes of stack but that is a small price
474 to pay :-). */
475 if (sp == old_sp)
476 {
477 if (INNER_THAN (1, 2))
478 /* Stack grows down. */
479 sp = gdbarch_frame_align (current_gdbarch, old_sp - 1);
480 else
481 /* Stack grows up. */
482 sp = gdbarch_frame_align (current_gdbarch, old_sp + 1);
483 }
484 gdb_assert ((INNER_THAN (1, 2) && sp <= old_sp)
485 || (INNER_THAN (2, 1) && sp >= old_sp));
486 }
487 else
488 /* FIXME: cagney/2002-09-18: Hey, you loose!
489
490 Who knows how badly aligned the SP is!
491
492 If the generic dummy frame ends up empty (because nothing is
493 pushed) GDB won't be able to correctly perform back traces.
494 If a target is having trouble with backtraces, first thing to
495 do is add FRAME_ALIGN() to the architecture vector. If that
496 fails, try unwind_dummy_id().
497
498 If the ABI specifies a "Red Zone" (see the doco) the code
499 below will quietly trash it. */
500 sp = old_sp;
501 }
502
503 funaddr = find_function_addr (function, &value_type);
504 CHECK_TYPEDEF (value_type);
505
506 {
507 struct block *b = block_for_pc (funaddr);
508 /* If compiled without -g, assume GCC 2. */
509 using_gcc = (b == NULL ? 2 : BLOCK_GCC_COMPILED (b));
510 }
511
512 /* Are we returning a value using a structure return or a normal
513 value return? */
514
515 struct_return = using_struct_return (function, funaddr, value_type,
516 using_gcc);
517
518 /* Determine the location of the breakpoint (and possibly other
519 stuff) that the called function will return to. The SPARC, for a
520 function returning a structure or union, needs to make space for
521 not just the breakpoint but also an extra word containing the
522 size (?) of the structure being passed. */
523
524 /* The actual breakpoint (at BP_ADDR) is inserted separatly so there
525 is no need to write that out. */
526
527 switch (CALL_DUMMY_LOCATION)
528 {
529 case ON_STACK:
530 /* "dummy_addr" is here just to keep old targets happy. New
531 targets return that same information via "sp" and "bp_addr". */
532 if (INNER_THAN (1, 2))
533 {
534 sp = push_dummy_code (current_gdbarch, sp, funaddr,
535 using_gcc, args, nargs, value_type,
536 &real_pc, &bp_addr);
537 dummy_addr = sp;
538 }
539 else
540 {
541 dummy_addr = sp;
542 sp = push_dummy_code (current_gdbarch, sp, funaddr,
543 using_gcc, args, nargs, value_type,
544 &real_pc, &bp_addr);
545 }
546 break;
547 case AT_ENTRY_POINT:
548 if (DEPRECATED_FIX_CALL_DUMMY_P ())
549 {
550 /* Sigh. Some targets use DEPRECATED_FIX_CALL_DUMMY to
551 shove extra stuff onto the stack or into registers. That
552 code should be in PUSH_DUMMY_CALL, however, in the mean
553 time ... */
554 /* If the target is manipulating DUMMY1, it looses big time. */
555 void *dummy1 = NULL;
556 DEPRECATED_FIX_CALL_DUMMY (dummy1, sp, funaddr, nargs, args,
557 value_type, using_gcc);
558 }
559 real_pc = funaddr;
560 dummy_addr = CALL_DUMMY_ADDRESS ();
561 /* A call dummy always consists of just a single breakpoint, so
562 it's address is the same as the address of the dummy. */
563 bp_addr = dummy_addr;
564 break;
565 case AT_SYMBOL:
566 /* Some executables define a symbol __CALL_DUMMY_ADDRESS whose
567 address is the location where the breakpoint should be
568 placed. Once all targets are using the overhauled frame code
569 this can be deleted - ON_STACK is a better option. */
570 {
571 struct minimal_symbol *sym;
572
573 sym = lookup_minimal_symbol ("__CALL_DUMMY_ADDRESS", NULL, NULL);
574 real_pc = funaddr;
575 if (sym)
576 dummy_addr = SYMBOL_VALUE_ADDRESS (sym);
577 else
578 dummy_addr = entry_point_address ();
579 bp_addr = dummy_addr;
580 break;
581 }
582 default:
583 internal_error (__FILE__, __LINE__, "bad switch");
584 }
585
586 if (DEPRECATED_USE_GENERIC_DUMMY_FRAMES)
587 /* Save where the breakpoint is going to be inserted so that the
588 dummy-frame code is later able to re-identify it. */
589 generic_save_call_dummy_addr (bp_addr, bp_addr + 1);
590
591 if (nargs < TYPE_NFIELDS (ftype))
592 error ("too few arguments in function call");
593
594 {
595 int i;
596 for (i = nargs - 1; i >= 0; i--)
597 {
598 int prototyped;
599 struct type *param_type;
600
601 /* FIXME drow/2002-05-31: Should just always mark methods as
602 prototyped. Can we respect TYPE_VARARGS? Probably not. */
603 if (TYPE_CODE (ftype) == TYPE_CODE_METHOD)
604 prototyped = 1;
605 else if (i < TYPE_NFIELDS (ftype))
606 prototyped = TYPE_PROTOTYPED (ftype);
607 else
608 prototyped = 0;
609
610 if (i < TYPE_NFIELDS (ftype))
611 param_type = TYPE_FIELD_TYPE (ftype, i);
612 else
613 param_type = NULL;
614
615 args[i] = value_arg_coerce (args[i], param_type, prototyped);
616
617 /* elz: this code is to handle the case in which the function
618 to be called has a pointer to function as parameter and the
619 corresponding actual argument is the address of a function
620 and not a pointer to function variable. In aCC compiled
621 code, the calls through pointers to functions (in the body
622 of the function called by hand) are made via
623 $$dyncall_external which requires some registers setting,
624 this is taken care of if we call via a function pointer
625 variable, but not via a function address. In cc this is
626 not a problem. */
627
628 if (using_gcc == 0)
629 {
630 if (param_type != NULL && TYPE_CODE (ftype) != TYPE_CODE_METHOD)
631 {
632 /* if this parameter is a pointer to function. */
633 if (TYPE_CODE (param_type) == TYPE_CODE_PTR)
634 if (TYPE_CODE (TYPE_TARGET_TYPE (param_type)) == TYPE_CODE_FUNC)
635 /* elz: FIXME here should go the test about the
636 compiler used to compile the target. We want to
637 issue the error message only if the compiler
638 used was HP's aCC. If we used HP's cc, then
639 there is no problem and no need to return at
640 this point. */
641 /* Go see if the actual parameter is a variable of
642 type pointer to function or just a function. */
643 if (args[i]->lval == not_lval)
644 {
645 char *arg_name;
646 if (find_pc_partial_function ((CORE_ADDR) args[i]->aligner.contents[0], &arg_name, NULL, NULL))
647 error ("\
648 You cannot use function <%s> as argument. \n\
649 You must use a pointer to function type variable. Command ignored.", arg_name);
650 }
651 }
652 }
653 }
654 }
655
656 if (REG_STRUCT_HAS_ADDR_P ())
657 {
658 int i;
659 /* This is a machine like the sparc, where we may need to pass a
660 pointer to the structure, not the structure itself. */
661 for (i = nargs - 1; i >= 0; i--)
662 {
663 struct type *arg_type = check_typedef (VALUE_TYPE (args[i]));
664 if ((TYPE_CODE (arg_type) == TYPE_CODE_STRUCT
665 || TYPE_CODE (arg_type) == TYPE_CODE_UNION
666 || TYPE_CODE (arg_type) == TYPE_CODE_ARRAY
667 || TYPE_CODE (arg_type) == TYPE_CODE_STRING
668 || TYPE_CODE (arg_type) == TYPE_CODE_BITSTRING
669 || TYPE_CODE (arg_type) == TYPE_CODE_SET
670 || (TYPE_CODE (arg_type) == TYPE_CODE_FLT
671 && TYPE_LENGTH (arg_type) > 8)
672 )
673 && REG_STRUCT_HAS_ADDR (using_gcc, arg_type))
674 {
675 CORE_ADDR addr;
676 int len; /* = TYPE_LENGTH (arg_type); */
677 int aligned_len;
678 arg_type = check_typedef (VALUE_ENCLOSING_TYPE (args[i]));
679 len = TYPE_LENGTH (arg_type);
680
681 if (STACK_ALIGN_P ())
682 /* MVS 11/22/96: I think at least some of this
683 stack_align code is really broken. Better to let
684 PUSH_ARGUMENTS adjust the stack in a target-defined
685 manner. */
686 aligned_len = STACK_ALIGN (len);
687 else
688 aligned_len = len;
689 if (INNER_THAN (1, 2))
690 {
691 /* stack grows downward */
692 sp -= aligned_len;
693 /* ... so the address of the thing we push is the
694 stack pointer after we push it. */
695 addr = sp;
696 }
697 else
698 {
699 /* The stack grows up, so the address of the thing
700 we push is the stack pointer before we push it. */
701 addr = sp;
702 sp += aligned_len;
703 }
704 /* Push the structure. */
705 write_memory (addr, VALUE_CONTENTS_ALL (args[i]), len);
706 /* The value we're going to pass is the address of the
707 thing we just pushed. */
708 /*args[i] = value_from_longest (lookup_pointer_type (value_type),
709 (LONGEST) addr); */
710 args[i] = value_from_pointer (lookup_pointer_type (arg_type),
711 addr);
712 }
713 }
714 }
715
716
717 /* Reserve space for the return structure to be written on the
718 stack, if necessary. Make certain that the value is correctly
719 aligned. */
720
721 if (struct_return)
722 {
723 int len = TYPE_LENGTH (value_type);
724 if (STACK_ALIGN_P ())
725 /* NOTE: cagney/2003-03-22: Should rely on frame align, rather
726 than stack align to force the alignment of the stack. */
727 len = STACK_ALIGN (len);
728 if (INNER_THAN (1, 2))
729 {
730 /* Stack grows downward. Align STRUCT_ADDR and SP after
731 making space for the return value. */
732 sp -= len;
733 if (gdbarch_frame_align_p (current_gdbarch))
734 sp = gdbarch_frame_align (current_gdbarch, sp);
735 struct_addr = sp;
736 }
737 else
738 {
739 /* Stack grows upward. Align the frame, allocate space, and
740 then again, re-align the frame??? */
741 if (gdbarch_frame_align_p (current_gdbarch))
742 sp = gdbarch_frame_align (current_gdbarch, sp);
743 struct_addr = sp;
744 sp += len;
745 if (gdbarch_frame_align_p (current_gdbarch))
746 sp = gdbarch_frame_align (current_gdbarch, sp);
747 }
748 }
749
750 /* elz: on HPPA no need for this extra alignment, maybe it is needed
751 on other architectures. This is because all the alignment is
752 taken care of in the above code (ifdef REG_STRUCT_HAS_ADDR) and
753 in hppa_push_arguments */
754 /* NOTE: cagney/2003-03-24: The below code is very broken. Given an
755 odd sized parameter the below will mis-align the stack. As was
756 suggested back in '96, better to let PUSH_ARGUMENTS handle it. */
757 if (DEPRECATED_EXTRA_STACK_ALIGNMENT_NEEDED)
758 {
759 /* MVS 11/22/96: I think at least some of this stack_align code
760 is really broken. Better to let push_dummy_call() adjust the
761 stack in a target-defined manner. */
762 if (STACK_ALIGN_P () && INNER_THAN (1, 2))
763 {
764 /* If stack grows down, we must leave a hole at the top. */
765 int len = 0;
766 int i;
767 for (i = nargs - 1; i >= 0; i--)
768 len += TYPE_LENGTH (VALUE_ENCLOSING_TYPE (args[i]));
769 if (DEPRECATED_CALL_DUMMY_STACK_ADJUST_P ())
770 len += DEPRECATED_CALL_DUMMY_STACK_ADJUST;
771 sp -= STACK_ALIGN (len) - len;
772 }
773 }
774
775 /* Create the dummy stack frame. Pass in the call dummy address as,
776 presumably, the ABI code knows where, in the call dummy, the
777 return address should be pointed. */
778 if (gdbarch_push_dummy_call_p (current_gdbarch))
779 /* When there is no push_dummy_call method, should this code
780 simply error out. That would the implementation of this method
781 for all ABIs (which is probably a good thing). */
782 sp = gdbarch_push_dummy_call (current_gdbarch, funaddr, current_regcache,
783 bp_addr, nargs, args, sp, struct_return,
784 struct_addr);
785 else if (DEPRECATED_PUSH_ARGUMENTS_P ())
786 /* Keep old targets working. */
787 sp = DEPRECATED_PUSH_ARGUMENTS (nargs, args, sp, struct_return,
788 struct_addr);
789 else
790 sp = legacy_push_arguments (nargs, args, sp, struct_return, struct_addr);
791
792 if (DEPRECATED_PUSH_RETURN_ADDRESS_P ())
793 /* for targets that use no CALL_DUMMY */
794 /* There are a number of targets now which actually don't write
795 any CALL_DUMMY instructions into the target, but instead just
796 save the machine state, push the arguments, and jump directly
797 to the callee function. Since this doesn't actually involve
798 executing a JSR/BSR instruction, the return address must be set
799 up by hand, either by pushing onto the stack or copying into a
800 return-address register as appropriate. Formerly this has been
801 done in PUSH_ARGUMENTS, but that's overloading its
802 functionality a bit, so I'm making it explicit to do it here. */
803 /* NOTE: cagney/2003-04-22: The first parameter ("real_pc") has
804 been replaced with zero, it turns out that no implementation
805 used that parameter. This occured because the value being
806 supplied - the address of the called function's entry point
807 instead of the address of the breakpoint that the called
808 function should return to - wasn't useful. */
809 sp = DEPRECATED_PUSH_RETURN_ADDRESS (0, sp);
810
811 /* NOTE: cagney/2003-03-23: Diable this code when there is a
812 push_dummy_call() method. Since that method will have already
813 handled any alignment issues, the code below is entirely
814 redundant. */
815 if (!gdbarch_push_dummy_call_p (current_gdbarch)
816 && STACK_ALIGN_P () && !INNER_THAN (1, 2))
817 {
818 /* If stack grows up, we must leave a hole at the bottom, note
819 that sp already has been advanced for the arguments! */
820 if (DEPRECATED_CALL_DUMMY_STACK_ADJUST_P ())
821 sp += DEPRECATED_CALL_DUMMY_STACK_ADJUST;
822 sp = STACK_ALIGN (sp);
823 }
824
825 /* XXX This seems wrong. For stacks that grow down we shouldn't do
826 anything here! */
827 /* MVS 11/22/96: I think at least some of this stack_align code is
828 really broken. Better to let PUSH_ARGUMENTS adjust the stack in
829 a target-defined manner. */
830 if (DEPRECATED_CALL_DUMMY_STACK_ADJUST_P ())
831 if (INNER_THAN (1, 2))
832 {
833 /* stack grows downward */
834 sp -= DEPRECATED_CALL_DUMMY_STACK_ADJUST;
835 }
836
837 /* Store the address at which the structure is supposed to be
838 written. */
839 /* NOTE: 2003-03-24: Since PUSH_ARGUMENTS can (and typically does)
840 store the struct return address, this call is entirely redundant. */
841 if (struct_return && DEPRECATED_STORE_STRUCT_RETURN_P ())
842 DEPRECATED_STORE_STRUCT_RETURN (struct_addr, sp);
843
844 /* Write the stack pointer. This is here because the statements
845 above might fool with it. On SPARC, this write also stores the
846 register window into the right place in the new stack frame,
847 which otherwise wouldn't happen (see store_inferior_registers in
848 sparc-nat.c). */
849 /* NOTE: cagney/2003-03-23: Since the architecture method
850 push_dummy_call() should have already stored the stack pointer
851 (as part of creating the fake call frame), and none of the code
852 following that call adjusts the stack-pointer value, the below
853 call is entirely redundant. */
854 if (DEPRECATED_DUMMY_WRITE_SP_P ())
855 DEPRECATED_DUMMY_WRITE_SP (sp);
856
857 if (gdbarch_unwind_dummy_id_p (current_gdbarch))
858 {
859 /* Sanity. The exact same SP value is returned by
860 PUSH_DUMMY_CALL, saved as the dummy-frame TOS, and used by
861 unwind_dummy_id to form the frame ID's stack address. */
862 gdb_assert (DEPRECATED_USE_GENERIC_DUMMY_FRAMES);
863 generic_save_dummy_frame_tos (sp);
864 }
865 else if (DEPRECATED_SAVE_DUMMY_FRAME_TOS_P ())
866 DEPRECATED_SAVE_DUMMY_FRAME_TOS (sp);
867
868 /* Now proceed, having reached the desired place. */
869 clear_proceed_status ();
870
871 /* Create a momentary breakpoint at the return address of the
872 inferior. That way it breaks when it returns. */
873
874 {
875 struct breakpoint *bpt;
876 struct symtab_and_line sal;
877 struct frame_id frame;
878 init_sal (&sal); /* initialize to zeroes */
879 sal.pc = bp_addr;
880 sal.section = find_pc_overlay (sal.pc);
881 /* Set up a frame ID for the dummy frame so we can pass it to
882 set_momentary_breakpoint. We need to give the breakpoint a
883 frame ID so that the breakpoint code can correctly re-identify
884 the dummy breakpoint. */
885 if (gdbarch_unwind_dummy_id_p (current_gdbarch))
886 {
887 /* Sanity. The exact same SP value is returned by
888 PUSH_DUMMY_CALL, saved as the dummy-frame TOS, and used by
889 unwind_dummy_id to form the frame ID's stack address. */
890 gdb_assert (DEPRECATED_USE_GENERIC_DUMMY_FRAMES);
891 frame = frame_id_build (sp, sal.pc);
892 }
893 else
894 {
895 /* The assumption here is that push_dummy_call() returned the
896 stack part of the frame ID. Unfortunatly, many older
897 architectures were, via a convoluted mess, relying on the
898 poorly defined and greatly overloaded
899 DEPRECATED_TARGET_READ_FP or DEPRECATED_FP_REGNUM to supply
900 the value. */
901 if (DEPRECATED_TARGET_READ_FP_P ())
902 frame = frame_id_build (DEPRECATED_TARGET_READ_FP (), sal.pc);
903 else if (DEPRECATED_FP_REGNUM >= 0)
904 frame = frame_id_build (read_register (DEPRECATED_FP_REGNUM), sal.pc);
905 else
906 frame = frame_id_build (sp, sal.pc);
907 }
908 bpt = set_momentary_breakpoint (sal, frame, bp_call_dummy);
909 bpt->disposition = disp_del;
910 }
911
912 /* Execute a "stack dummy", a piece of code stored in the stack by
913 the debugger to be executed in the inferior.
914
915 The dummy's frame is automatically popped whenever that break is
916 hit. If that is the first time the program stops,
917 call_function_by_hand returns to its caller with that frame
918 already gone and sets RC to 0.
919
920 Otherwise, set RC to a non-zero value. If the called function
921 receives a random signal, we do not allow the user to continue
922 executing it as this may not work. The dummy frame is poped and
923 we return 1. If we hit a breakpoint, we leave the frame in place
924 and return 2 (the frame will eventually be popped when we do hit
925 the dummy end breakpoint). */
926
927 {
928 struct cleanup *old_cleanups = make_cleanup (null_cleanup, 0);
929 int saved_async = 0;
930
931 /* If all error()s out of proceed ended up calling normal_stop
932 (and perhaps they should; it already does in the special case
933 of error out of resume()), then we wouldn't need this. */
934 make_cleanup (breakpoint_auto_delete_contents, &stop_bpstat);
935
936 disable_watchpoints_before_interactive_call_start ();
937 proceed_to_finish = 1; /* We want stop_registers, please... */
938
939 if (target_can_async_p ())
940 saved_async = target_async_mask (0);
941
942 proceed (real_pc, TARGET_SIGNAL_0, 0);
943
944 if (saved_async)
945 target_async_mask (saved_async);
946
947 enable_watchpoints_after_interactive_call_stop ();
948
949 discard_cleanups (old_cleanups);
950 }
951
952 if (stopped_by_random_signal || !stop_stack_dummy)
953 {
954 /* Find the name of the function we're about to complain about. */
955 const char *name = NULL;
956 {
957 struct symbol *symbol = find_pc_function (funaddr);
958 if (symbol)
959 name = SYMBOL_PRINT_NAME (symbol);
960 else
961 {
962 /* Try the minimal symbols. */
963 struct minimal_symbol *msymbol = lookup_minimal_symbol_by_pc (funaddr);
964 if (msymbol)
965 name = SYMBOL_PRINT_NAME (msymbol);
966 }
967 if (name == NULL)
968 {
969 /* Can't use a cleanup here. It is discarded, instead use
970 an alloca. */
971 char *tmp = xstrprintf ("at %s", local_hex_string (funaddr));
972 char *a = alloca (strlen (tmp) + 1);
973 strcpy (a, tmp);
974 xfree (tmp);
975 name = a;
976 }
977 }
978 if (stopped_by_random_signal)
979 {
980 /* We stopped inside the FUNCTION because of a random
981 signal. Further execution of the FUNCTION is not
982 allowed. */
983
984 if (unwind_on_signal_p)
985 {
986 /* The user wants the context restored. */
987
988 /* We must get back to the frame we were before the
989 dummy call. */
990 frame_pop (get_current_frame ());
991
992 /* FIXME: Insert a bunch of wrap_here; name can be very
993 long if it's a C++ name with arguments and stuff. */
994 error ("\
995 The program being debugged was signaled while in a function called from GDB.\n\
996 GDB has restored the context to what it was before the call.\n\
997 To change this behavior use \"set unwindonsignal off\"\n\
998 Evaluation of the expression containing the function (%s) will be abandoned.",
999 name);
1000 }
1001 else
1002 {
1003 /* The user wants to stay in the frame where we stopped
1004 (default).*/
1005 /* If we restored the inferior status (via the cleanup),
1006 we would print a spurious error message (Unable to
1007 restore previously selected frame), would write the
1008 registers from the inf_status (which is wrong), and
1009 would do other wrong things. */
1010 discard_cleanups (inf_status_cleanup);
1011 discard_inferior_status (inf_status);
1012 /* FIXME: Insert a bunch of wrap_here; name can be very
1013 long if it's a C++ name with arguments and stuff. */
1014 error ("\
1015 The program being debugged was signaled while in a function called from GDB.\n\
1016 GDB remains in the frame where the signal was received.\n\
1017 To change this behavior use \"set unwindonsignal on\"\n\
1018 Evaluation of the expression containing the function (%s) will be abandoned.",
1019 name);
1020 }
1021 }
1022
1023 if (!stop_stack_dummy)
1024 {
1025 /* We hit a breakpoint inside the FUNCTION. */
1026 /* If we restored the inferior status (via the cleanup), we
1027 would print a spurious error message (Unable to restore
1028 previously selected frame), would write the registers
1029 from the inf_status (which is wrong), and would do other
1030 wrong things. */
1031 discard_cleanups (inf_status_cleanup);
1032 discard_inferior_status (inf_status);
1033 /* The following error message used to say "The expression
1034 which contained the function call has been discarded."
1035 It is a hard concept to explain in a few words. Ideally,
1036 GDB would be able to resume evaluation of the expression
1037 when the function finally is done executing. Perhaps
1038 someday this will be implemented (it would not be easy). */
1039 /* FIXME: Insert a bunch of wrap_here; name can be very long if it's
1040 a C++ name with arguments and stuff. */
1041 error ("\
1042 The program being debugged stopped while in a function called from GDB.\n\
1043 When the function (%s) is done executing, GDB will silently\n\
1044 stop (instead of continuing to evaluate the expression containing\n\
1045 the function call).", name);
1046 }
1047
1048 /* The above code errors out, so ... */
1049 internal_error (__FILE__, __LINE__, "... should not be here");
1050 }
1051
1052 /* If we get here the called FUNCTION run to completion. */
1053
1054 /* On normal return, the stack dummy has been popped already. */
1055 regcache_cpy_no_passthrough (retbuf, stop_registers);
1056
1057 /* Restore the inferior status, via its cleanup. At this stage,
1058 leave the RETBUF alone. */
1059 do_cleanups (inf_status_cleanup);
1060
1061 /* Figure out the value returned by the function. */
1062 /* elz: I defined this new macro for the hppa architecture only.
1063 this gives us a way to get the value returned by the function
1064 from the stack, at the same address we told the function to put
1065 it. We cannot assume on the pa that r28 still contains the
1066 address of the returned structure. Usually this will be
1067 overwritten by the callee. I don't know about other
1068 architectures, so I defined this macro */
1069 #ifdef VALUE_RETURNED_FROM_STACK
1070 if (struct_return)
1071 {
1072 do_cleanups (retbuf_cleanup);
1073 return VALUE_RETURNED_FROM_STACK (value_type, struct_addr);
1074 }
1075 #endif
1076 /* NOTE: cagney/2002-09-10: Only when the stack has been correctly
1077 aligned (using frame_align()) do we can trust STRUCT_ADDR and
1078 fetch the return value direct from the stack. This lack of trust
1079 comes about because legacy targets have a nasty habit of
1080 silently, and local to PUSH_ARGUMENTS(), moving STRUCT_ADDR. For
1081 such targets, just hope that value_being_returned() can find the
1082 adjusted value. */
1083 if (struct_return && gdbarch_frame_align_p (current_gdbarch))
1084 {
1085 struct value *retval = value_at (value_type, struct_addr, NULL);
1086 do_cleanups (retbuf_cleanup);
1087 return retval;
1088 }
1089 else
1090 {
1091 struct value *retval = value_being_returned (value_type, retbuf,
1092 struct_return);
1093 do_cleanups (retbuf_cleanup);
1094 return retval;
1095 }
1096 }
1097
1098 void _initialize_infcall (void);
1099
1100 void
1101 _initialize_infcall (void)
1102 {
1103 add_setshow_boolean_cmd ("coerce-float-to-double", class_obscure,
1104 &coerce_float_to_double_p, "\
1105 Set coercion of floats to doubles when calling functions\n\
1106 Variables of type float should generally be converted to doubles before\n\
1107 calling an unprototyped function, and left alone when calling a prototyped\n\
1108 function. However, some older debug info formats do not provide enough\n\
1109 information to determine that a function is prototyped. If this flag is\n\
1110 set, GDB will perform the conversion for a function it considers\n\
1111 unprototyped.\n\
1112 The default is to perform the conversion.\n", "\
1113 Show coercion of floats to doubles when calling functions\n\
1114 Variables of type float should generally be converted to doubles before\n\
1115 calling an unprototyped function, and left alone when calling a prototyped\n\
1116 function. However, some older debug info formats do not provide enough\n\
1117 information to determine that a function is prototyped. If this flag is\n\
1118 set, GDB will perform the conversion for a function it considers\n\
1119 unprototyped.\n\
1120 The default is to perform the conversion.\n",
1121 NULL, NULL, &setlist, &showlist);
1122
1123 add_setshow_boolean_cmd ("unwindonsignal", no_class,
1124 &unwind_on_signal_p, "\
1125 Set unwinding of stack if a signal is received while in a call dummy.\n\
1126 The unwindonsignal lets the user determine what gdb should do if a signal\n\
1127 is received while in a function called from gdb (call dummy). If set, gdb\n\
1128 unwinds the stack and restore the context to what as it was before the call.\n\
1129 The default is to stop in the frame where the signal was received.", "\
1130 Set unwinding of stack if a signal is received while in a call dummy.\n\
1131 The unwindonsignal lets the user determine what gdb should do if a signal\n\
1132 is received while in a function called from gdb (call dummy). If set, gdb\n\
1133 unwinds the stack and restore the context to what as it was before the call.\n\
1134 The default is to stop in the frame where the signal was received.",
1135 NULL, NULL, &setlist, &showlist);
1136 }