1 /* Disassembly display.
3 Copyright (C) 1998-2020 Free Software Foundation, Inc.
5 Contributed by Hewlett-Packard Company.
7 This file is part of GDB.
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 3 of the License, or
12 (at your option) any later version.
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.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "arch-utils.h"
25 #include "breakpoint.h"
31 #include "tui/tui-command.h"
32 #include "tui/tui-data.h"
33 #include "tui/tui-win.h"
34 #include "tui/tui-layout.h"
35 #include "tui/tui-winsource.h"
36 #include "tui/tui-stack.h"
37 #include "tui/tui-file.h"
38 #include "tui/tui-disasm.h"
39 #include "tui/tui-source.h"
40 #include "progspace.h"
42 #include "cli/cli-style.h"
44 #include "gdb_curses.h"
49 std::string addr_string
;
54 /* Helper function to find the number of characters in STR, skipping
55 any ANSI escape sequences. */
57 len_without_escapes (const std::string
&str
)
60 const char *ptr
= str
.c_str ();
63 while ((c
= *ptr
++) != '\0')
69 if (style
.parse (ptr
, &n_read
))
73 /* Shouldn't happen, but just skip the ESC if it somehow
84 /* Function to set the disassembly window's content.
85 Disassemble count lines starting at pc.
86 Return address of the count'th instruction after pc. */
88 tui_disassemble (struct gdbarch
*gdbarch
,
89 std::vector
<tui_asm_line
> &asm_lines
,
90 CORE_ADDR pc
, int pos
, int count
,
91 size_t *addr_size
= nullptr)
93 bool term_out
= source_styling
&& gdb_stdout
->can_emit_style_escape ();
94 string_file
gdb_dis_out (term_out
);
96 /* Now construct each line. */
97 for (int i
= 0; i
< count
; ++i
)
99 print_address (gdbarch
, pc
, &gdb_dis_out
);
100 asm_lines
[pos
+ i
].addr
= pc
;
101 asm_lines
[pos
+ i
].addr_string
= std::move (gdb_dis_out
.string ());
103 gdb_dis_out
.clear ();
105 if (addr_size
!= nullptr)
110 new_size
= len_without_escapes (asm_lines
[pos
+ i
].addr_string
);
112 new_size
= asm_lines
[pos
+ i
].addr_string
.size ();
113 *addr_size
= std::max (*addr_size
, new_size
);
114 asm_lines
[pos
+ i
].addr_size
= new_size
;
117 pc
= pc
+ gdb_print_insn (gdbarch
, pc
, &gdb_dis_out
, NULL
);
119 asm_lines
[pos
+ i
].insn
= std::move (gdb_dis_out
.string ());
121 /* Reset the buffer to empty. */
122 gdb_dis_out
.clear ();
127 /* Find the disassembly address that corresponds to FROM lines above
128 or below the PC. Variable sized instructions are taken into
129 account by the algorithm. */
131 tui_find_disassembly_address (struct gdbarch
*gdbarch
, CORE_ADDR pc
, int from
)
136 max_lines
= (from
> 0) ? from
: - from
;
140 std::vector
<tui_asm_line
> asm_lines (max_lines
);
145 tui_disassemble (gdbarch
, asm_lines
, pc
, 0, max_lines
);
146 new_low
= asm_lines
[max_lines
- 1].addr
;
152 struct bound_minimal_symbol msymbol
;
154 /* Find backward an address which is a symbol and for which
155 disassembling from that address will fill completely the
159 new_low
-= 1 * max_lines
;
160 msymbol
= lookup_minimal_symbol_by_pc_section (new_low
, 0);
163 new_low
= BMSYMBOL_VALUE_ADDRESS (msymbol
);
165 new_low
+= 1 * max_lines
;
167 tui_disassemble (gdbarch
, asm_lines
, new_low
, 0, max_lines
);
168 last_addr
= asm_lines
[pos
].addr
;
169 } while (last_addr
> pc
&& msymbol
.minsym
);
171 /* Scan forward disassembling one instruction at a time until
172 the last visible instruction of the window matches the pc.
173 We keep the disassembled instructions in the 'lines' window
174 and shift it downward (increasing its addresses). */
181 if (pos
>= max_lines
)
184 next_addr
= tui_disassemble (gdbarch
, asm_lines
,
187 /* If there are some problems while disassembling exit. */
188 if (next_addr
<= last_addr
)
190 last_addr
= next_addr
;
191 } while (last_addr
<= pc
);
193 if (pos
>= max_lines
)
195 new_low
= asm_lines
[pos
].addr
;
200 /* Function to set the disassembly window's content. */
202 tui_disasm_window::set_contents (struct gdbarch
*arch
,
203 const struct symtab_and_line
&sal
)
206 int offset
= horizontal_offset
;
207 int max_lines
, line_width
;
209 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
210 int tab_len
= tui_tab_width
;
213 CORE_ADDR pc
= sal
.pc
;
218 start_line_or_addr
.loa
= LOA_ADDRESS
;
219 start_line_or_addr
.u
.addr
= pc
;
220 cur_pc
= locator
->addr
;
222 /* Window size, excluding highlight box. */
223 max_lines
= height
- 2;
224 line_width
= width
- TUI_EXECINFO_SIZE
- 2;
226 /* Get temporary table that will hold all strings (addr & insn). */
227 std::vector
<tui_asm_line
> asm_lines (max_lines
);
228 size_t addr_size
= 0;
229 tui_disassemble (gdbarch
, asm_lines
, pc
, 0, max_lines
, &addr_size
);
231 /* Align instructions to the same column. */
232 insn_pos
= (1 + (addr_size
/ tab_len
)) * tab_len
;
234 /* Now construct each line. */
235 content
.resize (max_lines
);
236 for (i
= 0; i
< max_lines
; i
++)
238 tui_source_element
*src
= &content
[i
];
241 = (asm_lines
[i
].addr_string
242 + n_spaces (insn_pos
- asm_lines
[i
].addr_size
)
243 + asm_lines
[i
].insn
);
245 const char *ptr
= line
.c_str ();
246 src
->line
= tui_copy_source_line (&ptr
, -1, offset
, line_width
, 0);
248 src
->line_or_addr
.loa
= LOA_ADDRESS
;
249 src
->line_or_addr
.u
.addr
= asm_lines
[i
].addr
;
250 src
->is_exec_point
= asm_lines
[i
].addr
== cur_pc
;
257 tui_get_begin_asm_address (struct gdbarch
**gdbarch_p
, CORE_ADDR
*addr_p
)
259 struct tui_locator_window
*locator
;
260 struct gdbarch
*gdbarch
= get_current_arch ();
263 locator
= tui_locator_win_info_ptr ();
265 if (locator
->addr
== 0)
267 if (have_full_symbols () || have_partial_symbols ())
269 set_default_source_symtab_and_line ();
270 struct symtab_and_line sal
= get_current_source_symtab_and_line ();
272 if (sal
.symtab
!= nullptr)
273 find_line_pc (sal
.symtab
, sal
.line
, &addr
);
278 struct bound_minimal_symbol main_symbol
279 = lookup_minimal_symbol (main_name (), nullptr, nullptr);
280 if (main_symbol
.minsym
!= nullptr)
281 addr
= BMSYMBOL_VALUE_ADDRESS (main_symbol
);
284 else /* The target is executing. */
286 gdbarch
= locator
->gdbarch
;
287 addr
= locator
->addr
;
290 *gdbarch_p
= gdbarch
;
294 /* Determine what the low address will be to display in the TUI's
295 disassembly window. This may or may not be the same as the low
298 tui_get_low_disassembly_address (struct gdbarch
*gdbarch
,
299 CORE_ADDR low
, CORE_ADDR pc
)
303 /* Determine where to start the disassembly so that the pc is about
304 in the middle of the viewport. */
305 if (tui_win_list
[DISASSEM_WIN
] != NULL
)
306 pos
= tui_win_list
[DISASSEM_WIN
]->height
;
307 else if (TUI_CMD_WIN
== NULL
)
308 pos
= tui_term_height () / 2 - 2;
310 pos
= tui_term_height () - TUI_CMD_WIN
->height
- 2;
313 pc
= tui_find_disassembly_address (gdbarch
, pc
, -pos
);
320 /* Scroll the disassembly forward or backward vertically. */
322 tui_disasm_window::do_scroll_vertical (int num_to_scroll
)
324 if (!content
.empty ())
328 pc
= start_line_or_addr
.u
.addr
;
329 if (num_to_scroll
>= 0)
334 symtab_and_line sal
{};
335 sal
.pspace
= current_program_space
;
336 sal
.pc
= tui_find_disassembly_address (gdbarch
, pc
, num_to_scroll
);
337 update_source_window_as_is (gdbarch
, sal
);
342 tui_disasm_window::location_matches_p (struct bp_location
*loc
, int line_no
)
344 return (content
[line_no
].line_or_addr
.loa
== LOA_ADDRESS
345 && content
[line_no
].line_or_addr
.u
.addr
== loc
->address
);
349 tui_disasm_window::addr_is_displayed (CORE_ADDR addr
) const
351 bool is_displayed
= false;
352 int threshold
= SCROLL_THRESHOLD
;
355 while (i
< content
.size () - threshold
&& !is_displayed
)
358 = (content
[i
].line_or_addr
.loa
== LOA_ADDRESS
359 && content
[i
].line_or_addr
.u
.addr
== addr
);
367 tui_disasm_window::maybe_update (struct frame_info
*fi
, symtab_and_line sal
)
371 struct gdbarch
*frame_arch
= get_frame_arch (fi
);
373 if (find_pc_partial_function (sal
.pc
, NULL
, &low
, NULL
) == 0)
375 /* There is no symbol available for current PC. There is no
376 safe way how to "disassemble backwards". */
380 low
= tui_get_low_disassembly_address (frame_arch
, low
, sal
.pc
);
382 struct tui_line_or_address a
;
386 if (!addr_is_displayed (sal
.pc
))
389 update_source_window (frame_arch
, sal
);
394 set_is_exec_point_at (a
);