disasm.h revision 1.6 
1/* Disassemble support for GDB.
2   Copyright (C) 2002-2016 Free Software Foundation, Inc.
3
4   This file is part of GDB.
5
6   This program is free software; you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation; either version 3 of the License, or
9   (at your option) any later version.
10
11   This program is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19#ifndef DISASM_H
20#define DISASM_H
21
22#include "dis-asm.h"
23
24#define DISASSEMBLY_SOURCE_DEPRECATED (0x1 << 0)
25#define DISASSEMBLY_RAW_INSN	(0x1 << 1)
26#define DISASSEMBLY_OMIT_FNAME	(0x1 << 2)
27#define DISASSEMBLY_FILENAME	(0x1 << 3)
28#define DISASSEMBLY_OMIT_PC	(0x1 << 4)
29#define DISASSEMBLY_SOURCE	(0x1 << 5)
30#define DISASSEMBLY_SPECULATIVE	(0x1 << 6)
31
32struct gdbarch;
33struct ui_out;
34struct ui_file;
35
36/* An instruction to be disassembled.  */
37
38struct disasm_insn
39{
40  /* The address of the memory containing the instruction.  */
41  CORE_ADDR addr;
42
43  /* An optional instruction number.  If non-zero, it is printed first.  */
44  unsigned int number;
45
46  /* True if the instruction was executed speculatively.  */
47  unsigned int is_speculative:1;
48};
49
50/* Prints the instruction INSN into UIOUT and returns the length of the
51   printed instruction in bytes.  */
52
53extern int gdb_pretty_print_insn (struct gdbarch *gdbarch, struct ui_out *uiout,
54				  struct disassemble_info * di,
55				  const struct disasm_insn *insn, int flags,
56				  struct ui_file *stb);
57
58/* Return a filled in disassemble_info object for use by gdb.  */
59
60extern struct disassemble_info gdb_disassemble_info (struct gdbarch *gdbarch,
61						     struct ui_file *file);
62
63extern void gdb_disassembly (struct gdbarch *gdbarch, struct ui_out *uiout,
64			     char *file_string, int flags, int how_many,
65			     CORE_ADDR low, CORE_ADDR high);
66
67/* Print the instruction at address MEMADDR in debugged memory,
68   on STREAM.  Returns the length of the instruction, in bytes,
69   and, if requested, the number of branch delay slot instructions.  */
70
71extern int gdb_print_insn (struct gdbarch *gdbarch, CORE_ADDR memaddr,
72			   struct ui_file *stream, int *branch_delay_insns);
73
74/* Return the length in bytes of the instruction at address MEMADDR in
75   debugged memory.  */
76
77extern int gdb_insn_length (struct gdbarch *gdbarch, CORE_ADDR memaddr);
78
79/* Return the length in bytes of INSN, originally at MEMADDR.  MAX_LEN
80   is the size of the buffer containing INSN.  */
81
82extern int gdb_buffered_insn_length (struct gdbarch *gdbarch,
83				     const gdb_byte *insn, int max_len,
84				     CORE_ADDR memaddr);
85
86#endif
87