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