Minor cosmetic and comments modifications
[clinton/Virtual-Jaguar-Rx.git] / src / debugger / DBGManager.h
CommitLineData
2d0121d4
JPM
1\r
2\r
3#ifndef __DBGMANAGER_H__\r
4#define __DBGMANAGER_H__\r
5\r
6\r
7typedef enum {\r
8 DBG_NO_TYPE = 0x0,\r
9 DBG_ELF = 0x1,\r
10 DBG_DWARF = 0x2,\r
11 DBG_ELFDWARF = 0x4,\r
12 DBG_HWLABEL = 0x8,\r
13 DBG_END_TYPE\r
14}DBGTYPE;\r
15\r
16// Tag based in the DW_TAG_... list from the dwarf.h\r
17typedef enum {\r
18 DBG_NO_TAG = 0x0,\r
19 DBG_TAG_pointer_type = 0x0f,\r
20 DBG_TAG_compile_unit = 0x11,\r
21 DBG_TAG_base_type = 0x24,\r
22 DBG_TAG_subprogram = 0x2e,\r
23 DBG_END_TAG\r
24}DBGTAG;\r
25\r
0203b5fd
JPM
26//\r
27typedef enum {\r
f8dde18d
JPM
28 DBG_TAG_TYPE_structure = 0x1, // structure\r
29 DBG_TAG_TYPE_pointer = 0x2, // pointer\r
30 DBG_TAG_TYPE_subrange = 0x4, // (subrange_type?)\r
31 DBG_TAG_TYPE_array = 0x8, // array type\r
32 DBG_TAG_TYPE_const = 0x10, // const type\r
33 DBG_TAG_TYPE_typedef = 0x20, // typedef\r
34 DBG_TAG_TYPE_enumeration_type = 0x40, // enumeration\r
35 DBG_TAG_TYPE_subroutine_type = 0x80 // subroutine\r
0203b5fd
JPM
36}DBGTAGTYPE;\r
37\r
2d0121d4
JPM
38// Encoding based in the DW_ATE_... list from the dwarf.h\r
39// Except for the DBG_ATE_ptr\r
40typedef enum {\r
41 DBG_NO_TYPEENCODING,\r
42 DBG_ATE_address = 0x1, // linear machine address\r
43 DBG_ATE_boolean = 0x2, // true or false\r
44 DBG_ATE_complex_float = 0x3, // complex floating-point number\r
45 DBG_ATE_float = 0x4, // floating-point number\r
46 DBG_ATE_signed = 0x5, // signed binary integer\r
47 DBG_ATE_signed_char = 0x6, // signed character\r
48 DBG_ATE_unsigned = 0x7, // unsigned binary integer\r
49 DBG_ATE_unsigned_char = 0x8, // unsigned character\r
50 DBG_ATE_imaginary_float = 0x9, /* DWARF3 */\r
51 DBG_ATE_packed_decimal = 0xa, /* DWARF3f */\r
52 DBG_ATE_numeric_string = 0xb, /* DWARF3f */\r
53 DBG_ATE_edited = 0xc, /* DWARF3f */\r
54 DBG_ATE_signed_fixed = 0xd, /* DWARF3f */\r
55 DBG_ATE_unsigned_fixed = 0xe, /* DWARF3f */\r
56 DBG_ATE_decimal_float = 0xf, /* DWARF3f */\r
57 DBG_ATE_ptr = 0x10, // Specific to DBG Manager to represent pointer type\r
58 DBG_END_TYPEENCODING\r
59}DBGTYPEENCODING;\r
60\r
0203b5fd
JPM
61// Encoding based in the DW_OP_... list from the dwarf.h\r
62typedef enum {\r
63 DBG_NO_OP,\r
64 DBG_OP_addr = 0x03,\r
65 DBG_OP_deref = 0x06,\r
66 DBG_OP_const1u = 0x08,\r
67 DBG_OP_const1s = 0x09,\r
68 DBG_OP_const2u = 0x0a,\r
69 DBG_OP_const2s = 0x0b,\r
70 DBG_OP_const4u = 0x0c,\r
71 DBG_OP_const4s = 0x0d,\r
72 DBG_OP_const8u = 0x0e,\r
73 DBG_OP_const8s = 0x0f,\r
74 DBG_OP_constu = 0x10,\r
75 DBG_OP_consts = 0x11,\r
76 DBG_OP_dup = 0x12,\r
77 DBG_OP_drop = 0x13,\r
78 DBG_OP_over = 0x14,\r
79 DBG_OP_pick = 0x15,\r
80 DBG_OP_swap = 0x16,\r
81 DBG_OP_rot = 0x17,\r
82 DBG_OP_xderef = 0x18,\r
83 DBG_OP_abs = 0x19,\r
84 DBG_OP_and = 0x1a,\r
85 DBG_OP_div = 0x1b,\r
86 DBG_OP_minus = 0x1c,\r
87 DBG_OP_mod = 0x1d,\r
88 DBG_OP_mul = 0x1e,\r
89 DBG_OP_neg = 0x1f,\r
90 DBG_OP_not = 0x20,\r
91 DBG_OP_or = 0x21,\r
92 DBG_OP_plus = 0x22,\r
93 DBG_OP_plus_uconst = 0x23,\r
94 DBG_OP_shl = 0x24,\r
95 DBG_OP_shr = 0x25,\r
96 DBG_OP_shra = 0x26,\r
97 DBG_OP_xor = 0x27,\r
98 DBG_OP_bra = 0x28,\r
99 DBG_OP_eq = 0x29,\r
100 DBG_OP_ge = 0x2a,\r
101 DBG_OP_gt = 0x2b,\r
102 DBG_OP_le = 0x2c,\r
103 DBG_OP_lt = 0x2d,\r
104 DBG_OP_ne = 0x2e,\r
105 DBG_OP_skip = 0x2f,\r
106 DBG_OP_lit0 = 0x30,\r
107 DBG_OP_lit1 = 0x31,\r
108 DBG_OP_lit2 = 0x32,\r
109 DBG_OP_lit3 = 0x33,\r
110 DBG_OP_lit4 = 0x34,\r
111 DBG_OP_lit5 = 0x35,\r
112 DBG_OP_lit6 = 0x36,\r
113 DBG_OP_lit7 = 0x37,\r
114 DBG_OP_lit8 = 0x38,\r
115 DBG_OP_lit9 = 0x39,\r
116 DBG_OP_lit10 = 0x3a,\r
117 DBG_OP_lit11 = 0x3b,\r
118 DBG_OP_lit12 = 0x3c,\r
119 DBG_OP_lit13 = 0x3d,\r
120 DBG_OP_lit14 = 0x3e,\r
121 DBG_OP_lit15 = 0x3f,\r
122 DBG_OP_lit16 = 0x40,\r
123 DBG_OP_lit17 = 0x41,\r
124 DBG_OP_lit18 = 0x42,\r
125 DBG_OP_lit19 = 0x43,\r
126 DBG_OP_lit20 = 0x44,\r
127 DBG_OP_lit21 = 0x45,\r
128 DBG_OP_lit22 = 0x46,\r
129 DBG_OP_lit23 = 0x47,\r
130 DBG_OP_lit24 = 0x48,\r
131 DBG_OP_lit25 = 0x49,\r
132 DBG_OP_lit26 = 0x4a,\r
133 DBG_OP_lit27 = 0x4b,\r
134 DBG_OP_lit28 = 0x4c,\r
135 DBG_OP_lit29 = 0x4d,\r
136 DBG_OP_lit30 = 0x4e,\r
137 DBG_OP_lit31 = 0x4f,\r
138 DBG_OP_reg0 = 0x50,\r
139 DBG_OP_reg1 = 0x51,\r
140 DBG_OP_reg2 = 0x52,\r
141 DBG_OP_reg3 = 0x53,\r
142 DBG_OP_reg4 = 0x54,\r
143 DBG_OP_reg5 = 0x55,\r
144 DBG_OP_reg6 = 0x56,\r
145 DBG_OP_reg7 = 0x57,\r
146 DBG_OP_reg8 = 0x58,\r
147 DBG_OP_reg9 = 0x59,\r
148 DBG_OP_reg10 = 0x5a,\r
149 DBG_OP_reg11 = 0x5b,\r
150 DBG_OP_reg12 = 0x5c,\r
151 DBG_OP_reg13 = 0x5d,\r
152 DBG_OP_reg14 = 0x5e,\r
153 DBG_OP_reg15 = 0x5f,\r
154 DBG_OP_reg16 = 0x60,\r
155 DBG_OP_reg17 = 0x61,\r
156 DBG_OP_reg18 = 0x62,\r
157 DBG_OP_reg19 = 0x63,\r
158 DBG_OP_reg20 = 0x64,\r
159 DBG_OP_reg21 = 0x65,\r
160 DBG_OP_reg22 = 0x66,\r
161 DBG_OP_reg23 = 0x67,\r
162 DBG_OP_reg24 = 0x68,\r
163 DBG_OP_reg25 = 0x69,\r
164 DBG_OP_reg26 = 0x6a,\r
165 DBG_OP_reg27 = 0x6b,\r
166 DBG_OP_reg28 = 0x6c,\r
167 DBG_OP_reg29 = 0x6d,\r
168 DBG_OP_reg30 = 0x6e,\r
169 DBG_OP_reg31 = 0x6f,\r
170 DBG_OP_breg0 = 0x70,\r
171 DBG_OP_breg1 = 0x71,\r
172 DBG_OP_breg2 = 0x72,\r
173 DBG_OP_breg3 = 0x73,\r
174 DBG_OP_breg4 = 0x74,\r
175 DBG_OP_breg5 = 0x75,\r
176 DBG_OP_breg6 = 0x76,\r
177 DBG_OP_breg7 = 0x77,\r
178 DBG_OP_breg8 = 0x78,\r
179 DBG_OP_breg9 = 0x79,\r
180 DBG_OP_breg10 = 0x7a,\r
181 DBG_OP_breg11 = 0x7b,\r
182 DBG_OP_breg12 = 0x7c,\r
183 DBG_OP_breg13 = 0x7d,\r
184 DBG_OP_breg14 = 0x7e,\r
185 DBG_OP_breg15 = 0x7f,\r
186 DBG_OP_breg16 = 0x80,\r
187 DBG_OP_breg17 = 0x81,\r
188 DBG_OP_breg18 = 0x82,\r
189 DBG_OP_breg19 = 0x83,\r
190 DBG_OP_breg20 = 0x84,\r
191 DBG_OP_breg21 = 0x85,\r
192 DBG_OP_breg22 = 0x86,\r
193 DBG_OP_breg23 = 0x87,\r
194 DBG_OP_breg24 = 0x88,\r
195 DBG_OP_breg25 = 0x89,\r
196 DBG_OP_breg26 = 0x8a,\r
197 DBG_OP_breg27 = 0x8b,\r
198 DBG_OP_breg28 = 0x8c,\r
199 DBG_OP_breg29 = 0x8d,\r
200 DBG_OP_breg30 = 0x8e,\r
201 DBG_OP_breg31 = 0x8f,\r
202 DBG_OP_regx = 0x90,\r
203 DBG_OP_fbreg = 0x91,\r
204 DBG_OP_bregx = 0x92,\r
205 DBG_OP_piece = 0x93,\r
206 DBG_OP_deref_size = 0x94,\r
207 DBG_OP_xderef_size = 0x95,\r
208 DBG_OP_nop = 0x96,\r
209 DBG_OP_push_object_address = 0x97, /* DWARF3 */\r
210 DBG_OP_call2 = 0x98, /* DWARF3 */\r
211 DBG_OP_call4 = 0x99, /* DWARF3 */\r
212 DBG_OP_call_ref = 0x9a, /* DWARF3 */\r
213 DBG_OP_form_tls_address = 0x9b, /* DWARF3f */\r
214 DBG_OP_call_frame_cfa = 0x9c, /* DWARF3f */\r
215 DBG_OP_bit_piece = 0x9d, /* DWARF3f */\r
216 DBG_OP_implicit_value = 0x9e, /* DWARF4 */\r
217 DBG_OP_stack_value = 0x9f, /* DWARF4 */\r
218 DBG_END_OP\r
219}\r
220DBGOP;\r
221\r
2d0121d4 222\r
a4e46c05 223// Internal manager\r
2d0121d4
JPM
224extern void DBGManager_Init(void);\r
225extern void DBGManager_SetType(size_t DBGTypeSet);\r
a4e46c05 226extern size_t DBGManager_GetType(void);\r
2d0121d4
JPM
227extern void DBGManager_Reset(void);\r
228extern void DBGManager_Close(void);\r
229\r
fe3b257d 230// Source text lines manager\r
2d0121d4
JPM
231extern size_t DBGManager_GetNumLineFromAdr(size_t Adr, size_t Tag);\r
232extern char *DBGManager_GetLineSrcFromAdr(size_t Adr, size_t Tag);\r
233extern char *DBGManager_GetLineSrcFromAdrNumLine(size_t Adr, size_t NumLine);\r
234extern char *DBGManager_GetLineSrcFromNumLineBaseAdr(size_t Adr, size_t NumLine);\r
fe3b257d
JPM
235\r
236// General manager\r
0203b5fd
JPM
237extern char *DBGManager_GetFunctionName(size_t Adr);\r
238extern char *DBGManager_GetVariableValueFromAdr(size_t Adr, size_t TypeEncoding, size_t TypeByteSize);\r
fe3b257d
JPM
239\r
240// Symbols manager\r
241extern char *DBGManager_GetSymbolNameFromAdr(size_t Adr);\r
242extern size_t DBGManager_GetAdrFromSymbolName(char *SymbolName);\r
243\r
244// Source text files manager\r
245extern char *DBGManager_GetFullSourceFilenameFromAdr(size_t Adr, bool *Error);\r
6564336c
JPM
246extern size_t DBGManager_GetNbFullSourceFilename(void);\r
247extern char *DBGManager_GetNumFullSourceFilename(size_t Index);\r
0203b5fd
JPM
248\r
249// Global variables manager\r
250extern size_t DBGManager_GetNbGlobalVariables(void);\r
251extern char *DBGManager_GetGlobalVariableName(size_t Index);\r
252extern size_t DBGManager_GetGlobalVariableTypeEncoding(size_t Index);\r
253extern char *DBGManager_GetGlobalVariableTypeName(size_t Index);\r
254extern size_t DBGManager_GetGlobalVariableTypeByteSize(size_t Index);\r
255extern size_t DBGManager_GetGlobalVariableAdr(size_t Index);\r
256extern size_t DBGManager_GetGlobalVariableAdrFromName(char *VariableName);\r
257extern char *DBGManager_GetGlobalVariableValue(size_t Index);\r
258extern size_t DBGManager_GetGlobalVariableTypeTag(size_t Index);\r
259\r
260// Local variables manager\r
261extern size_t DBGManager_GetNbLocalVariables(size_t Adr);\r
262extern char *DBGManager_GetLocalVariableName(size_t Adr, size_t Index);\r
263extern size_t DBGManager_GetLocalVariableTypeEncoding(size_t Adr, size_t Index);\r
264extern char *DBGManager_GetLocalVariableTypeName(size_t Adr, size_t Index);\r
265extern size_t DBGManager_GetLocalVariableTypeByteSize(size_t Adr, size_t Index);\r
266extern size_t DBGManager_GetLocalVariableTypeTag(size_t Adr, size_t Index);\r
267extern size_t DBGManager_GetLocalVariableOp(size_t Adr, size_t Index);\r
268extern int DBGManager_GetLocalVariableOffset(size_t Adr, size_t Index);\r
2d0121d4
JPM
269\r
270\r
271#endif // __DBGMANAGER_H__\r