1 /* Get info from stack frames; convert between frames, blocks,
2 functions and pc values.
4 Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994,
5 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 Free Software
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, USA. */
32 #include "value.h" /* for read_register */
33 #include "target.h" /* for target_has_stack */
34 #include "inferior.h" /* for read_pc */
37 #include "gdb_assert.h"
38 #include "dummy-frame.h"
40 /* Prototypes for exported functions. */
42 void _initialize_blockframe (void);
44 /* A default FRAME_CHAIN_VALID, in the form that is suitable for most
45 targets. If FRAME_CHAIN_VALID returns zero it means that the given
46 frame is the outermost one and has no caller. */
49 file_frame_chain_valid (CORE_ADDR chain, struct frame_info *thisframe)
52 && !inside_entry_file (FRAME_SAVED_PC (thisframe)));
55 /* Use the alternate method of avoiding running up off the end of the
56 frame chain or following frames back into the startup code. See
57 the comments in objfiles.h. */
60 func_frame_chain_valid (CORE_ADDR chain, struct frame_info *thisframe)
63 && !inside_main_func ((thisframe)->pc)
64 && !inside_entry_func ((thisframe)->pc));
67 /* A very simple method of determining a valid frame */
70 nonnull_frame_chain_valid (CORE_ADDR chain, struct frame_info *thisframe)
72 return ((chain) != 0);
75 /* Is ADDR inside the startup file? Note that if your machine
76 has a way to detect the bottom of the stack, there is no need
77 to call this function from FRAME_CHAIN_VALID; the reason for
78 doing so is that some machines have no way of detecting bottom
81 A PC of zero is always considered to be the bottom of the stack. */
84 inside_entry_file (CORE_ADDR addr)
88 if (symfile_objfile == 0)
90 if (CALL_DUMMY_LOCATION == AT_ENTRY_POINT)
92 /* Do not stop backtracing if the pc is in the call dummy
93 at the entry point. */
94 /* FIXME: Won't always work with zeros for the last two arguments */
95 if (PC_IN_CALL_DUMMY (addr, 0, 0))
98 return (addr >= symfile_objfile->ei.entry_file_lowpc &&
99 addr < symfile_objfile->ei.entry_file_highpc);
102 /* Test a specified PC value to see if it is in the range of addresses
103 that correspond to the main() function. See comments above for why
104 we might want to do this.
106 Typically called from FRAME_CHAIN_VALID.
108 A PC of zero is always considered to be the bottom of the stack. */
111 inside_main_func (CORE_ADDR pc)
115 if (symfile_objfile == 0)
118 /* If the addr range is not set up at symbol reading time, set it up now.
119 This is for FRAME_CHAIN_VALID_ALTERNATE. I do this for coff, because
120 it is unable to set it up and symbol reading time. */
122 if (symfile_objfile->ei.main_func_lowpc == INVALID_ENTRY_LOWPC &&
123 symfile_objfile->ei.main_func_highpc == INVALID_ENTRY_HIGHPC)
125 struct symbol *mainsym;
127 mainsym = lookup_symbol (main_name (), NULL, VAR_NAMESPACE, NULL, NULL);
128 if (mainsym && SYMBOL_CLASS (mainsym) == LOC_BLOCK)
130 symfile_objfile->ei.main_func_lowpc =
131 BLOCK_START (SYMBOL_BLOCK_VALUE (mainsym));
132 symfile_objfile->ei.main_func_highpc =
133 BLOCK_END (SYMBOL_BLOCK_VALUE (mainsym));
136 return (symfile_objfile->ei.main_func_lowpc <= pc &&
137 symfile_objfile->ei.main_func_highpc > pc);
140 /* Test a specified PC value to see if it is in the range of addresses
141 that correspond to the process entry point function. See comments
142 in objfiles.h for why we might want to do this.
144 Typically called from FRAME_CHAIN_VALID.
146 A PC of zero is always considered to be the bottom of the stack. */
149 inside_entry_func (CORE_ADDR pc)
153 if (symfile_objfile == 0)
155 if (CALL_DUMMY_LOCATION == AT_ENTRY_POINT)
157 /* Do not stop backtracing if the pc is in the call dummy
158 at the entry point. */
159 /* FIXME: Won't always work with zeros for the last two arguments */
160 if (PC_IN_CALL_DUMMY (pc, 0, 0))
163 return (symfile_objfile->ei.entry_func_lowpc <= pc &&
164 symfile_objfile->ei.entry_func_highpc > pc);
167 /* Return nonzero if the function for this frame lacks a prologue. Many
168 machines can define FRAMELESS_FUNCTION_INVOCATION to just call this
172 frameless_look_for_prologue (struct frame_info *frame)
174 CORE_ADDR func_start, after_prologue;
176 func_start = get_pc_function_start (frame->pc);
179 func_start += FUNCTION_START_OFFSET;
180 /* This is faster, since only care whether there *is* a
181 prologue, not how long it is. */
182 return PROLOGUE_FRAMELESS_P (func_start);
184 else if (frame->pc == 0)
185 /* A frame with a zero PC is usually created by dereferencing a
186 NULL function pointer, normally causing an immediate core dump
187 of the inferior. Mark function as frameless, as the inferior
188 has no chance of setting up a stack frame. */
191 /* If we can't find the start of the function, we don't really
192 know whether the function is frameless, but we should be able
193 to get a reasonable (i.e. best we can do under the
194 circumstances) backtrace by saying that it isn't. */
198 /* return the address of the PC for the given FRAME, ie the current PC value
199 if FRAME is the innermost frame, or the address adjusted to point to the
200 call instruction if not. */
203 frame_address_in_block (struct frame_info *frame)
205 CORE_ADDR pc = frame->pc;
207 /* If we are not in the innermost frame, and we are not interrupted
208 by a signal, frame->pc points to the instruction following the
209 call. As a consequence, we need to get the address of the previous
210 instruction. Unfortunately, this is not straightforward to do, so
211 we just use the address minus one, which is a good enough
213 if (frame->next != 0 && frame->next->signal_handler_caller == 0)
219 /* Return the innermost lexical block in execution
220 in a specified stack frame. The frame address is assumed valid.
222 If ADDR_IN_BLOCK is non-zero, set *ADDR_IN_BLOCK to the exact code
223 address we used to choose the block. We use this to find a source
224 line, to decide which macro definitions are in scope.
226 The value returned in *ADDR_IN_BLOCK isn't necessarily the frame's
227 PC, and may not really be a valid PC at all. For example, in the
228 caller of a function declared to never return, the code at the
229 return address will never be reached, so the call instruction may
230 be the very last instruction in the block. So the address we use
231 to choose the block is actually one byte before the return address
232 --- hopefully pointing us at the call instruction, or its delay
236 get_frame_block (struct frame_info *frame, CORE_ADDR *addr_in_block)
238 const CORE_ADDR pc = frame_address_in_block (frame);
243 return block_for_pc (pc);
247 get_current_block (CORE_ADDR *addr_in_block)
249 CORE_ADDR pc = read_pc ();
254 return block_for_pc (pc);
258 get_pc_function_start (CORE_ADDR pc)
260 register struct block *bl;
261 register struct symbol *symbol;
262 register struct minimal_symbol *msymbol;
265 if ((bl = block_for_pc (pc)) != NULL &&
266 (symbol = block_function (bl)) != NULL)
268 bl = SYMBOL_BLOCK_VALUE (symbol);
269 fstart = BLOCK_START (bl);
271 else if ((msymbol = lookup_minimal_symbol_by_pc (pc)) != NULL)
273 fstart = SYMBOL_VALUE_ADDRESS (msymbol);
274 if (!find_pc_section (fstart))
284 /* Return the symbol for the function executing in frame FRAME. */
287 get_frame_function (struct frame_info *frame)
289 register struct block *bl = get_frame_block (frame, 0);
292 return block_function (bl);
296 /* Return the blockvector immediately containing the innermost lexical block
297 containing the specified pc value and section, or 0 if there is none.
298 PINDEX is a pointer to the index value of the block. If PINDEX
299 is NULL, we don't pass this information back to the caller. */
302 blockvector_for_pc_sect (register CORE_ADDR pc, struct sec *section,
303 int *pindex, struct symtab *symtab)
305 register struct block *b;
306 register int bot, top, half;
307 struct blockvector *bl;
309 if (symtab == 0) /* if no symtab specified by caller */
311 /* First search all symtabs for one whose file contains our pc */
312 if ((symtab = find_pc_sect_symtab (pc, section)) == 0)
316 bl = BLOCKVECTOR (symtab);
317 b = BLOCKVECTOR_BLOCK (bl, 0);
319 /* Then search that symtab for the smallest block that wins. */
320 /* Use binary search to find the last block that starts before PC. */
323 top = BLOCKVECTOR_NBLOCKS (bl);
325 while (top - bot > 1)
327 half = (top - bot + 1) >> 1;
328 b = BLOCKVECTOR_BLOCK (bl, bot + half);
329 if (BLOCK_START (b) <= pc)
335 /* Now search backward for a block that ends after PC. */
339 b = BLOCKVECTOR_BLOCK (bl, bot);
340 if (BLOCK_END (b) > pc)
351 /* Return the blockvector immediately containing the innermost lexical block
352 containing the specified pc value, or 0 if there is none.
353 Backward compatibility, no section. */
356 blockvector_for_pc (register CORE_ADDR pc, int *pindex)
358 return blockvector_for_pc_sect (pc, find_pc_mapped_section (pc),
362 /* Return the innermost lexical block containing the specified pc value
363 in the specified section, or 0 if there is none. */
366 block_for_pc_sect (register CORE_ADDR pc, struct sec *section)
368 register struct blockvector *bl;
371 bl = blockvector_for_pc_sect (pc, section, &index, NULL);
373 return BLOCKVECTOR_BLOCK (bl, index);
377 /* Return the innermost lexical block containing the specified pc value,
378 or 0 if there is none. Backward compatibility, no section. */
381 block_for_pc (register CORE_ADDR pc)
383 return block_for_pc_sect (pc, find_pc_mapped_section (pc));
386 /* Return the function containing pc value PC in section SECTION.
387 Returns 0 if function is not known. */
390 find_pc_sect_function (CORE_ADDR pc, struct sec *section)
392 register struct block *b = block_for_pc_sect (pc, section);
395 return block_function (b);
398 /* Return the function containing pc value PC.
399 Returns 0 if function is not known. Backward compatibility, no section */
402 find_pc_function (CORE_ADDR pc)
404 return find_pc_sect_function (pc, find_pc_mapped_section (pc));
407 /* These variables are used to cache the most recent result
408 * of find_pc_partial_function. */
410 static CORE_ADDR cache_pc_function_low = 0;
411 static CORE_ADDR cache_pc_function_high = 0;
412 static char *cache_pc_function_name = 0;
413 static struct sec *cache_pc_function_section = NULL;
415 /* Clear cache, e.g. when symbol table is discarded. */
418 clear_pc_function_cache (void)
420 cache_pc_function_low = 0;
421 cache_pc_function_high = 0;
422 cache_pc_function_name = (char *) 0;
423 cache_pc_function_section = NULL;
426 /* Finds the "function" (text symbol) that is smaller than PC but
427 greatest of all of the potential text symbols in SECTION. Sets
428 *NAME and/or *ADDRESS conditionally if that pointer is non-null.
429 If ENDADDR is non-null, then set *ENDADDR to be the end of the
430 function (exclusive), but passing ENDADDR as non-null means that
431 the function might cause symbols to be read. This function either
432 succeeds or fails (not halfway succeeds). If it succeeds, it sets
433 *NAME, *ADDRESS, and *ENDADDR to real information and returns 1.
434 If it fails, it sets *NAME, *ADDRESS, and *ENDADDR to zero and
438 find_pc_sect_partial_function (CORE_ADDR pc, asection *section, char **name,
439 CORE_ADDR *address, CORE_ADDR *endaddr)
441 struct partial_symtab *pst;
443 struct minimal_symbol *msymbol;
444 struct partial_symbol *psb;
445 struct obj_section *osect;
449 mapped_pc = overlay_mapped_address (pc, section);
451 if (mapped_pc >= cache_pc_function_low
452 && mapped_pc < cache_pc_function_high
453 && section == cache_pc_function_section)
454 goto return_cached_value;
456 /* If sigtramp is in the u area, it counts as a function (especially
457 important for step_1). */
458 if (SIGTRAMP_START_P () && PC_IN_SIGTRAMP (mapped_pc, (char *) NULL))
460 cache_pc_function_low = SIGTRAMP_START (mapped_pc);
461 cache_pc_function_high = SIGTRAMP_END (mapped_pc);
462 cache_pc_function_name = "<sigtramp>";
463 cache_pc_function_section = section;
464 goto return_cached_value;
467 msymbol = lookup_minimal_symbol_by_pc_section (mapped_pc, section);
468 pst = find_pc_sect_psymtab (mapped_pc, section);
471 /* Need to read the symbols to get a good value for the end address. */
472 if (endaddr != NULL && !pst->readin)
474 /* Need to get the terminal in case symbol-reading produces
476 target_terminal_ours_for_output ();
477 PSYMTAB_TO_SYMTAB (pst);
482 /* Checking whether the msymbol has a larger value is for the
483 "pathological" case mentioned in print_frame_info. */
484 f = find_pc_sect_function (mapped_pc, section);
487 || (BLOCK_START (SYMBOL_BLOCK_VALUE (f))
488 >= SYMBOL_VALUE_ADDRESS (msymbol))))
490 cache_pc_function_low = BLOCK_START (SYMBOL_BLOCK_VALUE (f));
491 cache_pc_function_high = BLOCK_END (SYMBOL_BLOCK_VALUE (f));
492 cache_pc_function_name = SYMBOL_NAME (f);
493 cache_pc_function_section = section;
494 goto return_cached_value;
499 /* Now that static symbols go in the minimal symbol table, perhaps
500 we could just ignore the partial symbols. But at least for now
501 we use the partial or minimal symbol, whichever is larger. */
502 psb = find_pc_sect_psymbol (pst, mapped_pc, section);
505 && (msymbol == NULL ||
506 (SYMBOL_VALUE_ADDRESS (psb)
507 >= SYMBOL_VALUE_ADDRESS (msymbol))))
509 /* This case isn't being cached currently. */
511 *address = SYMBOL_VALUE_ADDRESS (psb);
513 *name = SYMBOL_NAME (psb);
514 /* endaddr non-NULL can't happen here. */
520 /* Not in the normal symbol tables, see if the pc is in a known section.
521 If it's not, then give up. This ensures that anything beyond the end
522 of the text seg doesn't appear to be part of the last function in the
525 osect = find_pc_sect_section (mapped_pc, section);
530 /* Must be in the minimal symbol table. */
533 /* No available symbol. */
543 cache_pc_function_low = SYMBOL_VALUE_ADDRESS (msymbol);
544 cache_pc_function_name = SYMBOL_NAME (msymbol);
545 cache_pc_function_section = section;
547 /* Use the lesser of the next minimal symbol in the same section, or
548 the end of the section, as the end of the function. */
550 /* Step over other symbols at this same address, and symbols in
551 other sections, to find the next symbol in this section with
552 a different address. */
554 for (i = 1; SYMBOL_NAME (msymbol + i) != NULL; i++)
556 if (SYMBOL_VALUE_ADDRESS (msymbol + i) != SYMBOL_VALUE_ADDRESS (msymbol)
557 && SYMBOL_BFD_SECTION (msymbol + i) == SYMBOL_BFD_SECTION (msymbol))
561 if (SYMBOL_NAME (msymbol + i) != NULL
562 && SYMBOL_VALUE_ADDRESS (msymbol + i) < osect->endaddr)
563 cache_pc_function_high = SYMBOL_VALUE_ADDRESS (msymbol + i);
565 /* We got the start address from the last msymbol in the objfile.
566 So the end address is the end of the section. */
567 cache_pc_function_high = osect->endaddr;
573 if (pc_in_unmapped_range (pc, section))
574 *address = overlay_unmapped_address (cache_pc_function_low, section);
576 *address = cache_pc_function_low;
580 *name = cache_pc_function_name;
584 if (pc_in_unmapped_range (pc, section))
586 /* Because the high address is actually beyond the end of
587 the function (and therefore possibly beyond the end of
588 the overlay), we must actually convert (high - 1) and
589 then add one to that. */
591 *endaddr = 1 + overlay_unmapped_address (cache_pc_function_high - 1,
595 *endaddr = cache_pc_function_high;
601 /* Backward compatibility, no section argument. */
604 find_pc_partial_function (CORE_ADDR pc, char **name, CORE_ADDR *address,
609 section = find_pc_overlay (pc);
610 return find_pc_sect_partial_function (pc, section, name, address, endaddr);
613 /* Return the innermost stack frame executing inside of BLOCK,
614 or NULL if there is no such frame. If BLOCK is NULL, just return NULL. */
617 block_innermost_frame (struct block *block)
619 struct frame_info *frame;
620 register CORE_ADDR start;
621 register CORE_ADDR end;
622 CORE_ADDR calling_pc;
627 start = BLOCK_START (block);
628 end = BLOCK_END (block);
633 frame = get_prev_frame (frame);
636 calling_pc = frame_address_in_block (frame);
637 if (calling_pc >= start && calling_pc < end)
642 /* Return the full FRAME which corresponds to the given CORE_ADDR
643 or NULL if no FRAME on the chain corresponds to CORE_ADDR. */
646 find_frame_addr_in_frame_chain (CORE_ADDR frame_addr)
648 struct frame_info *frame = NULL;
650 if (frame_addr == (CORE_ADDR) 0)
655 frame = get_prev_frame (frame);
658 if (FRAME_FP (frame) == frame_addr)
663 #ifdef SIGCONTEXT_PC_OFFSET
664 /* Get saved user PC for sigtramp from sigcontext for BSD style sigtramp. */
667 sigtramp_saved_pc (struct frame_info *frame)
669 CORE_ADDR sigcontext_addr;
671 int ptrbytes = TYPE_LENGTH (builtin_type_void_func_ptr);
672 int sigcontext_offs = (2 * TARGET_INT_BIT) / TARGET_CHAR_BIT;
674 buf = alloca (ptrbytes);
675 /* Get sigcontext address, it is the third parameter on the stack. */
677 sigcontext_addr = read_memory_typed_address
678 (FRAME_ARGS_ADDRESS (frame->next) + FRAME_ARGS_SKIP + sigcontext_offs,
679 builtin_type_void_data_ptr);
681 sigcontext_addr = read_memory_typed_address
682 (read_register (SP_REGNUM) + sigcontext_offs, builtin_type_void_data_ptr);
684 /* Don't cause a memory_error when accessing sigcontext in case the stack
685 layout has changed or the stack is corrupt. */
686 target_read_memory (sigcontext_addr + SIGCONTEXT_PC_OFFSET, buf, ptrbytes);
687 return extract_typed_address (buf, builtin_type_void_func_ptr);
689 #endif /* SIGCONTEXT_PC_OFFSET */
692 /* Are we in a call dummy? The code below which allows DECR_PC_AFTER_BREAK
693 below is for infrun.c, which may give the macro a pc without that
696 extern CORE_ADDR text_end;
699 pc_in_call_dummy_before_text_end (CORE_ADDR pc, CORE_ADDR sp,
700 CORE_ADDR frame_address)
702 return ((pc) >= text_end - CALL_DUMMY_LENGTH
703 && (pc) <= text_end + DECR_PC_AFTER_BREAK);
707 pc_in_call_dummy_after_text_end (CORE_ADDR pc, CORE_ADDR sp,
708 CORE_ADDR frame_address)
710 return ((pc) >= text_end
711 && (pc) <= text_end + CALL_DUMMY_LENGTH + DECR_PC_AFTER_BREAK);
714 /* Is the PC in a call dummy? SP and FRAME_ADDRESS are the bottom and
715 top of the stack frame which we are checking, where "bottom" and
716 "top" refer to some section of memory which contains the code for
717 the call dummy. Calls to this macro assume that the contents of
718 SP_REGNUM and FP_REGNUM (or the saved values thereof), respectively,
719 are the things to pass.
721 This won't work on the 29k, where SP_REGNUM and FP_REGNUM don't
722 have that meaning, but the 29k doesn't use ON_STACK. This could be
723 fixed by generalizing this scheme, perhaps by passing in a frame
724 and adding a few fields, at least on machines which need them for
727 Something simpler, like checking for the stack segment, doesn't work,
728 since various programs (threads implementations, gcc nested function
729 stubs, etc) may either allocate stack frames in another segment, or
730 allocate other kinds of code on the stack. */
733 pc_in_call_dummy_on_stack (CORE_ADDR pc, CORE_ADDR sp, CORE_ADDR frame_address)
735 return (INNER_THAN ((sp), (pc))
736 && (frame_address != 0)
737 && INNER_THAN ((pc), (frame_address)));
741 pc_in_call_dummy_at_entry_point (CORE_ADDR pc, CORE_ADDR sp,
742 CORE_ADDR frame_address)
744 return ((pc) >= CALL_DUMMY_ADDRESS ()
745 && (pc) <= (CALL_DUMMY_ADDRESS () + DECR_PC_AFTER_BREAK));
749 /* Function: frame_chain_valid
750 Returns true for a user frame or a call_function_by_hand dummy frame,
751 and false for the CRT0 start-up frame. Purpose is to terminate backtrace */
754 generic_file_frame_chain_valid (CORE_ADDR fp, struct frame_info *fi)
756 if (PC_IN_CALL_DUMMY (FRAME_SAVED_PC (fi), fp, fp))
757 return 1; /* don't prune CALL_DUMMY frames */
758 else /* fall back to default algorithm (see frame.h) */
760 && (INNER_THAN (fi->frame, fp) || fi->frame == fp)
761 && !inside_entry_file (FRAME_SAVED_PC (fi)));
765 generic_func_frame_chain_valid (CORE_ADDR fp, struct frame_info *fi)
767 if (USE_GENERIC_DUMMY_FRAMES
768 && PC_IN_CALL_DUMMY ((fi)->pc, 0, 0))
769 return 1; /* don't prune CALL_DUMMY frames */
770 else /* fall back to default algorithm (see frame.h) */
772 && (INNER_THAN (fi->frame, fp) || fi->frame == fp)
773 && !inside_main_func ((fi)->pc)
774 && !inside_entry_func ((fi)->pc));