]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/disasm.c
2004-01-06 Michael Chastain <mec.gnu@mindspring.com>
[thirdparty/binutils-gdb.git] / gdb / disasm.c
CommitLineData
92df71f0 1/* Disassemble support for GDB.
1bac305b
AC
2
3 Copyright 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
92df71f0
FN
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
9 the Free Software Foundation; either version 2 of the License, or
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
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22#include "defs.h"
23#include "target.h"
24#include "value.h"
25#include "ui-out.h"
26#include "gdb_string.h"
92df71f0 27#include "disasm.h"
810ecf9f 28#include "gdbcore.h"
a89aa300 29#include "dis-asm.h"
92df71f0
FN
30
31/* Disassemble functions.
32 FIXME: We should get rid of all the duplicate code in gdb that does
33 the same thing: disassemble_command() and the gdbtk variation. */
34
35/* This Structure is used to store line number information.
36 We need a different sort of line table from the normal one cuz we can't
37 depend upon implicit line-end pc's for lines to do the
38 reordering in this function. */
39
40struct dis_line_entry
41{
42 int line;
43 CORE_ADDR start_pc;
44 CORE_ADDR end_pc;
45};
46
810ecf9f
AC
47/* Like target_read_memory, but slightly different parameters. */
48static int
49dis_asm_read_memory (bfd_vma memaddr, bfd_byte *myaddr, unsigned int len,
a89aa300 50 struct disassemble_info *info)
810ecf9f
AC
51{
52 return target_read_memory (memaddr, (char *) myaddr, len);
53}
54
55/* Like memory_error with slightly different parameters. */
56static void
a89aa300
AC
57dis_asm_memory_error (int status, bfd_vma memaddr,
58 struct disassemble_info *info)
810ecf9f
AC
59{
60 memory_error (status, memaddr);
61}
62
63/* Like print_address with slightly different parameters. */
64static void
65dis_asm_print_address (bfd_vma addr, struct disassemble_info *info)
66{
67 print_address (addr, info->stream);
68}
69
92df71f0 70static int
bde58177 71compare_lines (const void *mle1p, const void *mle2p)
92df71f0
FN
72{
73 struct dis_line_entry *mle1, *mle2;
74 int val;
75
76 mle1 = (struct dis_line_entry *) mle1p;
77 mle2 = (struct dis_line_entry *) mle2p;
78
79 val = mle1->line - mle2->line;
80
81 if (val != 0)
82 return val;
83
84 return mle1->start_pc - mle2->start_pc;
85}
86
87static int
a89aa300 88dump_insns (struct ui_out *uiout, struct disassemble_info * di,
92df71f0
FN
89 CORE_ADDR low, CORE_ADDR high,
90 int how_many, struct ui_stream *stb)
91{
92 int num_displayed = 0;
93 CORE_ADDR pc;
94
95 /* parts of the symbolic representation of the address */
96 int unmapped;
92df71f0
FN
97 int offset;
98 int line;
3b31d625 99 struct cleanup *ui_out_chain;
92df71f0
FN
100
101 for (pc = low; pc < high;)
102 {
1211bce3
EZ
103 char *filename = NULL;
104 char *name = NULL;
105
92df71f0
FN
106 QUIT;
107 if (how_many >= 0)
108 {
109 if (num_displayed >= how_many)
110 break;
111 else
112 num_displayed++;
113 }
3b31d625 114 ui_out_chain = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
92df71f0
FN
115 ui_out_field_core_addr (uiout, "address", pc);
116
117 if (!build_address_symbolic (pc, 0, &name, &offset, &filename,
118 &line, &unmapped))
119 {
120 /* We don't care now about line, filename and
121 unmapped. But we might in the future. */
122 ui_out_text (uiout, " <");
123 ui_out_field_string (uiout, "func-name", name);
124 ui_out_text (uiout, "+");
125 ui_out_field_int (uiout, "offset", offset);
126 ui_out_text (uiout, ">:\t");
127 }
13adf674
DJ
128 else
129 ui_out_text (uiout, ":\t");
130
92df71f0
FN
131 if (filename != NULL)
132 xfree (filename);
133 if (name != NULL)
134 xfree (name);
135
136 ui_file_rewind (stb->stream);
137 pc += TARGET_PRINT_INSN (pc, di);
138 ui_out_field_stream (uiout, "inst", stb);
139 ui_file_rewind (stb->stream);
3b31d625 140 do_cleanups (ui_out_chain);
92df71f0
FN
141 ui_out_text (uiout, "\n");
142 }
143 return num_displayed;
144}
145
146/* The idea here is to present a source-O-centric view of a
147 function to the user. This means that things are presented
148 in source order, with (possibly) out of order assembly
149 immediately following. */
150static void
151do_mixed_source_and_assembly (struct ui_out *uiout,
152 struct disassemble_info *di, int nlines,
153 struct linetable_entry *le,
154 CORE_ADDR low, CORE_ADDR high,
155 struct symtab *symtab,
156 int how_many, struct ui_stream *stb)
157{
158 int newlines = 0;
159 struct dis_line_entry *mle;
160 struct symtab_and_line sal;
161 int i;
162 int out_of_order = 0;
163 int next_line = 0;
164 CORE_ADDR pc;
165 int num_displayed = 0;
3b31d625 166 struct cleanup *ui_out_chain;
92df71f0
FN
167
168 mle = (struct dis_line_entry *) alloca (nlines
169 * sizeof (struct dis_line_entry));
170
171 /* Copy linetable entries for this function into our data
172 structure, creating end_pc's and setting out_of_order as
173 appropriate. */
174
175 /* First, skip all the preceding functions. */
176
177 for (i = 0; i < nlines - 1 && le[i].pc < low; i++);
178
179 /* Now, copy all entries before the end of this function. */
180
181 for (; i < nlines - 1 && le[i].pc < high; i++)
182 {
183 if (le[i].line == le[i + 1].line && le[i].pc == le[i + 1].pc)
184 continue; /* Ignore duplicates */
185
186 /* Skip any end-of-function markers. */
187 if (le[i].line == 0)
188 continue;
189
190 mle[newlines].line = le[i].line;
191 if (le[i].line > le[i + 1].line)
192 out_of_order = 1;
193 mle[newlines].start_pc = le[i].pc;
194 mle[newlines].end_pc = le[i + 1].pc;
195 newlines++;
196 }
197
198 /* If we're on the last line, and it's part of the function,
199 then we need to get the end pc in a special way. */
200
201 if (i == nlines - 1 && le[i].pc < high)
202 {
203 mle[newlines].line = le[i].line;
204 mle[newlines].start_pc = le[i].pc;
205 sal = find_pc_line (le[i].pc, 0);
206 mle[newlines].end_pc = sal.end;
207 newlines++;
208 }
209
210 /* Now, sort mle by line #s (and, then by addresses within
211 lines). */
212
213 if (out_of_order)
214 qsort (mle, newlines, sizeof (struct dis_line_entry), compare_lines);
215
216 /* Now, for each line entry, emit the specified lines (unless
217 they have been emitted before), followed by the assembly code
218 for that line. */
219
3b31d625 220 ui_out_chain = make_cleanup_ui_out_list_begin_end (uiout, "asm_insns");
92df71f0
FN
221
222 for (i = 0; i < newlines; i++)
223 {
3b31d625
EZ
224 struct cleanup *ui_out_tuple_chain = NULL;
225 struct cleanup *ui_out_list_chain = NULL;
92df71f0 226 int close_list = 1;
3b31d625 227
92df71f0
FN
228 /* Print out everything from next_line to the current line. */
229 if (mle[i].line >= next_line)
230 {
231 if (next_line != 0)
232 {
233 /* Just one line to print. */
234 if (next_line == mle[i].line)
235 {
3b31d625
EZ
236 ui_out_tuple_chain
237 = make_cleanup_ui_out_tuple_begin_end (uiout,
238 "src_and_asm_line");
92df71f0
FN
239 print_source_lines (symtab, next_line, mle[i].line + 1, 0);
240 }
241 else
242 {
243 /* Several source lines w/o asm instructions associated. */
244 for (; next_line < mle[i].line; next_line++)
245 {
3b31d625
EZ
246 struct cleanup *ui_out_list_chain_line;
247 struct cleanup *ui_out_tuple_chain_line;
248
249 ui_out_tuple_chain_line
250 = make_cleanup_ui_out_tuple_begin_end (uiout,
251 "src_and_asm_line");
92df71f0
FN
252 print_source_lines (symtab, next_line, next_line + 1,
253 0);
3b31d625
EZ
254 ui_out_list_chain_line
255 = make_cleanup_ui_out_list_begin_end (uiout,
256 "line_asm_insn");
257 do_cleanups (ui_out_list_chain_line);
258 do_cleanups (ui_out_tuple_chain_line);
92df71f0
FN
259 }
260 /* Print the last line and leave list open for
261 asm instructions to be added. */
3b31d625
EZ
262 ui_out_tuple_chain
263 = make_cleanup_ui_out_tuple_begin_end (uiout,
264 "src_and_asm_line");
92df71f0
FN
265 print_source_lines (symtab, next_line, mle[i].line + 1, 0);
266 }
267 }
268 else
269 {
3b31d625
EZ
270 ui_out_tuple_chain
271 = make_cleanup_ui_out_tuple_begin_end (uiout, "src_and_asm_line");
92df71f0
FN
272 print_source_lines (symtab, mle[i].line, mle[i].line + 1, 0);
273 }
274
275 next_line = mle[i].line + 1;
3b31d625
EZ
276 ui_out_list_chain
277 = make_cleanup_ui_out_list_begin_end (uiout, "line_asm_insn");
92df71f0
FN
278 /* Don't close the list if the lines are not in order. */
279 if (i < (newlines - 1) && mle[i + 1].line <= mle[i].line)
280 close_list = 0;
281 }
282
283 num_displayed += dump_insns (uiout, di, mle[i].start_pc, mle[i].end_pc,
284 how_many, stb);
285 if (close_list)
286 {
3b31d625
EZ
287 do_cleanups (ui_out_list_chain);
288 do_cleanups (ui_out_tuple_chain);
92df71f0
FN
289 ui_out_text (uiout, "\n");
290 close_list = 0;
291 }
292 if (how_many >= 0)
293 if (num_displayed >= how_many)
294 break;
295 }
3b31d625 296 do_cleanups (ui_out_chain);
92df71f0
FN
297}
298
299
300static void
a89aa300 301do_assembly_only (struct ui_out *uiout, struct disassemble_info * di,
92df71f0
FN
302 CORE_ADDR low, CORE_ADDR high,
303 int how_many, struct ui_stream *stb)
304{
305 int num_displayed = 0;
3b31d625 306 struct cleanup *ui_out_chain;
92df71f0 307
3b31d625 308 ui_out_chain = make_cleanup_ui_out_list_begin_end (uiout, "asm_insns");
92df71f0
FN
309
310 num_displayed = dump_insns (uiout, di, low, high, how_many, stb);
311
3b31d625 312 do_cleanups (ui_out_chain);
92df71f0
FN
313}
314
92bf2b80
AC
315/* Initialize the disassemble info struct ready for the specified
316 stream. */
317
242e8be5
AC
318static int
319fprintf_disasm (void *stream, const char *format, ...)
320{
321 va_list args;
322 va_start (args, format);
323 vfprintf_filtered (stream, format, args);
324 va_end (args);
325 /* Something non -ve. */
326 return 0;
327}
328
a89aa300 329static struct disassemble_info
92bf2b80 330gdb_disassemble_info (struct gdbarch *gdbarch, struct ui_file *file)
92df71f0 331{
a89aa300 332 struct disassemble_info di;
242e8be5 333 init_disassemble_info (&di, file, fprintf_disasm);
2b6fd0d8
AC
334 di.flavour = bfd_target_unknown_flavour;
335 di.memory_error_func = dis_asm_memory_error;
336 di.print_address_func = dis_asm_print_address;
337 /* NOTE: cagney/2003-04-28: The original code, from the old Insight
338 disassembler had a local optomization here. By default it would
339 access the executable file, instead of the target memory (there
ce2826aa 340 was a growing list of exceptions though). Unfortunately, the
2b6fd0d8
AC
341 heuristic was flawed. Commands like "disassemble &variable"
342 didn't work as they relied on the access going to the target.
343 Further, it has been supperseeded by trust-read-only-sections
344 (although that should be superseeded by target_trust..._p()). */
345 di.read_memory_func = dis_asm_read_memory;
22b0d388 346 di.arch = gdbarch_bfd_arch_info (gdbarch)->arch;
92bf2b80
AC
347 di.mach = gdbarch_bfd_arch_info (gdbarch)->mach;
348 di.endian = gdbarch_byte_order (gdbarch);
349 return di;
350}
351
352void
353gdb_disassembly (struct ui_out *uiout,
354 char *file_string,
355 int line_num,
356 int mixed_source_and_assembly,
357 int how_many, CORE_ADDR low, CORE_ADDR high)
358{
359 struct ui_stream *stb = ui_out_stream_new (uiout);
360 struct cleanup *cleanups = make_cleanup_ui_out_stream_delete (stb);
a89aa300 361 struct disassemble_info di = gdb_disassemble_info (current_gdbarch, stb->stream);
92bf2b80
AC
362 /* To collect the instruction outputted from opcodes. */
363 struct symtab *symtab = NULL;
364 struct linetable_entry *le = NULL;
365 int nlines = -1;
92df71f0 366
92df71f0
FN
367 /* Assume symtab is valid for whole PC range */
368 symtab = find_pc_symtab (low);
369
370 if (symtab != NULL && symtab->linetable != NULL)
371 {
372 /* Convert the linetable to a bunch of my_line_entry's. */
373 le = symtab->linetable->item;
374 nlines = symtab->linetable->nitems;
375 }
376
377 if (!mixed_source_and_assembly || nlines <= 0
378 || symtab == NULL || symtab->linetable == NULL)
379 do_assembly_only (uiout, &di, low, high, how_many, stb);
380
381 else if (mixed_source_and_assembly)
382 do_mixed_source_and_assembly (uiout, &di, nlines, le, low,
383 high, symtab, how_many, stb);
384
2b6fd0d8 385 do_cleanups (cleanups);
92df71f0
FN
386 gdb_flush (gdb_stdout);
387}
810ecf9f 388
92bf2b80
AC
389/* Print the instruction at address MEMADDR in debugged memory,
390 on STREAM. Returns length of the instruction, in bytes. */
391
392int
393gdb_print_insn (CORE_ADDR memaddr, struct ui_file *stream)
394{
a89aa300 395 struct disassemble_info di = gdb_disassemble_info (current_gdbarch, stream);
92bf2b80
AC
396 return TARGET_PRINT_INSN (memaddr, &di);
397}