]>
Commit | Line | Data |
---|---|---|
14f9c5c9 | 1 | /* Ada language support definitions for GDB, the GNU debugger. |
a2bd3dcd | 2 | |
1d506c26 | 3 | Copyright (C) 1992-2024 Free Software Foundation, Inc. |
14f9c5c9 | 4 | |
a9762ec7 | 5 | This file is part of GDB. |
14f9c5c9 | 6 | |
a9762ec7 JB |
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 3 of the License, or | |
10 | (at your option) any later version. | |
14f9c5c9 | 11 | |
a9762ec7 JB |
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. | |
14f9c5c9 | 16 | |
a9762ec7 JB |
17 | You should have received a copy of the GNU General Public License |
18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ | |
14f9c5c9 AS |
19 | |
20 | #if !defined (ADA_LANG_H) | |
21 | #define ADA_LANG_H 1 | |
22 | ||
bd2b40ac | 23 | class frame_info_ptr; |
75082e8c | 24 | struct inferior; |
79d43c61 | 25 | struct type_print_options; |
410a0ff2 | 26 | struct parser_state; |
da3331ec | 27 | |
14f9c5c9 AS |
28 | #include "value.h" |
29 | #include "gdbtypes.h" | |
4c4b4cd2 PH |
30 | #include "breakpoint.h" |
31 | ||
32 | /* Names of specific files known to be part of the runtime | |
33 | system and that might consider (confusing) debugging information. | |
34 | Each name (a basic regular expression string) is followed by a | |
0963b4bd | 35 | comma. FIXME: Should be part of a configuration file. */ |
32a8097b | 36 | #if defined (__linux__) |
4c4b4cd2 PH |
37 | #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \ |
38 | "^[agis]-.*\\.ad[bs]$", \ | |
39 | "/lib.*/libpthread\\.so[.0-9]*$", "/lib.*/libpthread\\.a$", \ | |
40 | "/lib.*/libc\\.so[.0-9]*$", "/lib.*/libc\\.a$", | |
41 | #endif | |
14f9c5c9 | 42 | |
4c4b4cd2 PH |
43 | #if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS) |
44 | #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \ | |
5a04cc98 | 45 | "^unwind-seh.c$", \ |
4c4b4cd2 PH |
46 | "^[agis]-.*\\.ad[bs]$", |
47 | #endif | |
48 | ||
49 | /* Names of compiler-generated auxiliary functions probably of no | |
0963b4bd MS |
50 | interest to users. Each name (a basic regular expression string) |
51 | is followed by a comma. */ | |
4c4b4cd2 | 52 | #define ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS \ |
df30368d JB |
53 | "___clean[.$a-zA-Z0-9_]*$", \ |
54 | "___finalizer[.$a-zA-Z0-9_]*$", | |
fe898f56 | 55 | |
4c4b4cd2 | 56 | /* The maximum number of frame levels searched for non-local, |
68ba44c4 JB |
57 | non-global symbols. This limit exists as a precaution to prevent |
58 | infinite search loops when the stack is screwed up. */ | |
4c4b4cd2 | 59 | #define MAX_ENCLOSING_FRAME_LEVELS 7 |
14f9c5c9 | 60 | |
4c4b4cd2 PH |
61 | /* Maximum number of steps followed in looking for the ultimate |
62 | referent of a renaming. This prevents certain infinite loops that | |
0963b4bd | 63 | can otherwise result. */ |
4c4b4cd2 | 64 | #define MAX_RENAMING_CHAIN_LENGTH 10 |
14f9c5c9 | 65 | |
4c4b4cd2 PH |
66 | struct block; |
67 | ||
68 | /* Corresponding encoded/decoded names and opcodes for Ada user-definable | |
0963b4bd | 69 | operators. */ |
d2e4a39e AS |
70 | struct ada_opname_map |
71 | { | |
4c4b4cd2 PH |
72 | const char *encoded; |
73 | const char *decoded; | |
14f9c5c9 AS |
74 | enum exp_opcode op; |
75 | }; | |
76 | ||
0963b4bd | 77 | /* Table of Ada operators in encoded and decoded forms. */ |
14f9c5c9 AS |
78 | /* Defined in ada-lang.c */ |
79 | extern const struct ada_opname_map ada_opname_table[]; | |
80 | ||
aeb5907d JB |
81 | /* Denotes a type of renaming symbol (see ada_parse_renaming). */ |
82 | enum ada_renaming_category | |
83 | { | |
84 | /* Indicates a symbol that does not encode a renaming. */ | |
85 | ADA_NOT_RENAMING, | |
86 | ||
87 | /* For symbols declared | |
dda83cd7 | 88 | Foo : TYPE renamed OBJECT; */ |
aeb5907d JB |
89 | ADA_OBJECT_RENAMING, |
90 | ||
91 | /* For symbols declared | |
dda83cd7 | 92 | Foo : exception renames EXCEPTION; */ |
aeb5907d JB |
93 | ADA_EXCEPTION_RENAMING, |
94 | /* For packages declared | |
dda83cd7 | 95 | package Foo renames PACKAGE; */ |
aeb5907d JB |
96 | ADA_PACKAGE_RENAMING, |
97 | /* For subprograms declared | |
dda83cd7 | 98 | SUBPROGRAM_SPEC renames SUBPROGRAM; |
aeb5907d JB |
99 | (Currently not used). */ |
100 | ADA_SUBPROGRAM_RENAMING | |
101 | }; | |
102 | ||
349774ef JB |
103 | /* The different types of catchpoints that we introduced for catching |
104 | Ada exceptions. */ | |
105 | ||
106 | enum ada_exception_catchpoint_kind | |
107 | { | |
108 | ada_catch_exception, | |
109 | ada_catch_exception_unhandled, | |
9f757bf7 XR |
110 | ada_catch_assert, |
111 | ada_catch_handlers | |
349774ef JB |
112 | }; |
113 | ||
96d887e8 PH |
114 | /* Ada task structures. */ |
115 | ||
0ef643c8 | 116 | struct ada_task_info |
96d887e8 | 117 | { |
0ef643c8 JB |
118 | /* The PTID of the thread that this task runs on. This ptid is computed |
119 | in a target-dependent way from the associated Task Control Block. */ | |
120 | ptid_t ptid; | |
121 | ||
122 | /* The ID of the task. */ | |
123 | CORE_ADDR task_id; | |
124 | ||
125 | /* The name of the task. */ | |
126 | char name[257]; | |
127 | ||
128 | /* The current state of the task. */ | |
129 | int state; | |
130 | ||
131 | /* The priority associated to the task. */ | |
96d887e8 | 132 | int priority; |
96d887e8 | 133 | |
0ef643c8 JB |
134 | /* If non-zero, the task ID of the parent task. */ |
135 | CORE_ADDR parent; | |
96d887e8 | 136 | |
0ef643c8 JB |
137 | /* If the task is waiting on a task entry, this field contains |
138 | the ID of the other task. Zero otherwise. */ | |
139 | CORE_ADDR called_task; | |
96d887e8 | 140 | |
0ef643c8 JB |
141 | /* If the task is accepting a rendezvous with another task, this field |
142 | contains the ID of the calling task. Zero otherwise. */ | |
143 | CORE_ADDR caller_task; | |
65d40437 JB |
144 | |
145 | /* The CPU on which the task is running. This is dependent on | |
146 | the runtime actually providing that info, which is not always | |
147 | the case. Normally, we should be able to count on it on | |
148 | bare-metal targets. */ | |
149 | int base_cpu; | |
0ef643c8 | 150 | }; |
96d887e8 | 151 | |
4c4b4cd2 | 152 | extern int ada_get_field_index (const struct type *type, |
dda83cd7 SM |
153 | const char *field_name, |
154 | int maybe_missing); | |
14f9c5c9 | 155 | |
410a0ff2 | 156 | extern int ada_parse (struct parser_state *); /* Defined in ada-exp.y */ |
14f9c5c9 | 157 | |
dda83cd7 | 158 | /* Defined in ada-typeprint.c */ |
25b524e8 | 159 | extern void ada_print_type (struct type *, const char *, struct ui_file *, int, |
dda83cd7 | 160 | int, const struct type_print_options *); |
14f9c5c9 | 161 | |
be942545 JB |
162 | extern void ada_print_typedef (struct type *type, struct symbol *new_symbol, |
163 | struct ui_file *stream); | |
164 | ||
26792ee0 TT |
165 | /* Implement la_value_print_inner for Ada. */ |
166 | ||
167 | extern void ada_value_print_inner (struct value *, struct ui_file *, int, | |
168 | const struct value_print_options *); | |
169 | ||
8e069a98 TT |
170 | extern void ada_value_print (struct value *, struct ui_file *, |
171 | const struct value_print_options *); | |
14f9c5c9 | 172 | |
dda83cd7 | 173 | /* Defined in ada-lang.c */ |
14f9c5c9 | 174 | |
6c7a06a3 | 175 | extern void ada_emit_char (int, struct type *, struct ui_file *, int, int); |
14f9c5c9 | 176 | |
6c7a06a3 | 177 | extern void ada_printchar (int, struct type *, struct ui_file *); |
14f9c5c9 | 178 | |
6c7a06a3 | 179 | extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *, |
be759fcf | 180 | unsigned int, const char *, int, |
79a45b7d | 181 | const struct value_print_options *); |
14f9c5c9 | 182 | |
a93c0eb6 | 183 | struct value *ada_convert_actual (struct value *actual, |
dda83cd7 | 184 | struct type *formal_type0); |
14f9c5c9 | 185 | |
d91e9ea8 XR |
186 | extern bool ada_is_access_to_unconstrained_array (struct type *type); |
187 | ||
d2e4a39e | 188 | extern struct value *ada_value_subscript (struct value *, int, |
dda83cd7 | 189 | struct value **); |
14f9c5c9 | 190 | |
28c85d6c JB |
191 | extern void ada_fixup_array_indexes_type (struct type *index_desc_type); |
192 | ||
d2e4a39e | 193 | extern struct type *ada_array_element_type (struct type *, int); |
14f9c5c9 | 194 | |
d2e4a39e | 195 | extern int ada_array_arity (struct type *); |
14f9c5c9 | 196 | |
d2e4a39e | 197 | extern struct value *ada_coerce_to_simple_array_ptr (struct value *); |
14f9c5c9 | 198 | |
720d1a40 JB |
199 | struct value *ada_coerce_to_simple_array (struct value *); |
200 | ||
4c4b4cd2 | 201 | extern int ada_is_simple_array_type (struct type *); |
14f9c5c9 | 202 | |
4c4b4cd2 | 203 | extern int ada_is_array_descriptor_type (struct type *); |
14f9c5c9 | 204 | |
43bbcdc2 PH |
205 | extern LONGEST ada_discrete_type_low_bound (struct type *); |
206 | ||
207 | extern LONGEST ada_discrete_type_high_bound (struct type *); | |
208 | ||
41246937 JB |
209 | extern struct value *ada_get_decoded_value (struct value *value); |
210 | ||
211 | extern struct type *ada_get_decoded_type (struct type *type); | |
212 | ||
45e6c716 | 213 | extern const char *ada_decode_symbol (const struct general_symbol_info *); |
14f9c5c9 | 214 | |
8a3df5ac TT |
215 | /* Decode the GNAT-encoded name NAME, returning the decoded name. If |
216 | the name does not appear to be GNAT-encoded, then the result | |
217 | depends on WRAP. If WRAP is true (the default), then the result is | |
218 | simply wrapped in <...>. If WRAP is false, then the empty string | |
957ce537 TT |
219 | will be returned. |
220 | ||
221 | When OPERATORS is false, operator names will not be decoded. By | |
222 | default, they are decoded, e.g., 'Oadd' will be transformed to | |
223 | '"+"'. | |
224 | ||
225 | When WIDE is false, wide characters will be left as-is. By | |
226 | default, they converted from their hex encoding to the host | |
227 | charset. */ | |
5c94f938 | 228 | extern std::string ada_decode (const char *name, bool wrap = true, |
957ce537 TT |
229 | bool operators = true, |
230 | bool wide = true); | |
14f9c5c9 | 231 | |
d1183b06 TT |
232 | extern std::vector<struct block_symbol> ada_lookup_symbol_list |
233 | (const char *, const struct block *, domain_enum); | |
4c4b4cd2 | 234 | |
d12307c1 PMR |
235 | extern struct block_symbol ada_lookup_symbol (const char *, |
236 | const struct block *, | |
65392b3e | 237 | domain_enum); |
4c4b4cd2 | 238 | |
4e5c77fe | 239 | extern void ada_lookup_encoded_symbol |
fe978cb0 | 240 | (const char *name, const struct block *block, domain_enum domain, |
d12307c1 | 241 | struct block_symbol *symbol_info); |
aeb5907d | 242 | |
06a670e2 MM |
243 | extern struct bound_minimal_symbol ada_lookup_simple_minsym (const char *, |
244 | objfile *); | |
14f9c5c9 | 245 | |
d2e4a39e | 246 | extern int ada_scan_number (const char *, int, LONGEST *, int *); |
14f9c5c9 | 247 | |
5eb68a39 TT |
248 | extern struct value *ada_value_primitive_field (struct value *arg1, |
249 | int offset, | |
250 | int fieldno, | |
251 | struct type *arg_type); | |
252 | ||
d2e4a39e | 253 | extern struct type *ada_parent_type (struct type *); |
14f9c5c9 | 254 | |
d2e4a39e | 255 | extern int ada_is_ignored_field (struct type *, int); |
14f9c5c9 | 256 | |
ad82864c | 257 | extern int ada_is_constrained_packed_array_type (struct type *); |
14f9c5c9 | 258 | |
a2bd3dcd | 259 | extern struct value *ada_value_primitive_packed_val (struct value *, |
fc1a4b47 | 260 | const gdb_byte *, |
dda83cd7 SM |
261 | long, int, int, |
262 | struct type *); | |
14f9c5c9 | 263 | |
d2e4a39e | 264 | extern struct type *ada_coerce_to_simple_array_type (struct type *); |
14f9c5c9 | 265 | |
fc913e53 | 266 | extern bool ada_is_character_type (struct type *); |
14f9c5c9 | 267 | |
fc913e53 | 268 | extern bool ada_is_string_type (struct type *); |
14f9c5c9 | 269 | |
4c4b4cd2 PH |
270 | extern int ada_is_tagged_type (struct type *, int); |
271 | ||
272 | extern int ada_is_tag_type (struct type *); | |
14f9c5c9 | 273 | |
f5272a3b | 274 | extern gdb::unique_xmalloc_ptr<char> ada_tag_name (struct value *); |
4c4b4cd2 | 275 | |
b50d69b5 JG |
276 | extern struct value *ada_tag_value_at_base_address (struct value *obj); |
277 | ||
d2e4a39e | 278 | extern int ada_is_parent_field (struct type *, int); |
14f9c5c9 | 279 | |
d2e4a39e | 280 | extern int ada_is_wrapper_field (struct type *, int); |
14f9c5c9 | 281 | |
d2e4a39e | 282 | extern int ada_is_variant_part (struct type *, int); |
14f9c5c9 | 283 | |
d2e4a39e | 284 | extern struct type *ada_variant_discrim_type (struct type *, struct type *); |
14f9c5c9 | 285 | |
a121b7c1 | 286 | extern const char *ada_variant_discrim_name (struct type *); |
14f9c5c9 | 287 | |
d2e4a39e | 288 | extern int ada_is_aligner_type (struct type *); |
14f9c5c9 | 289 | |
d2e4a39e | 290 | extern struct type *ada_aligned_type (struct type *); |
14f9c5c9 | 291 | |
fc1a4b47 AC |
292 | extern const gdb_byte *ada_aligned_value_addr (struct type *, |
293 | const gdb_byte *); | |
14f9c5c9 | 294 | |
4c4b4cd2 PH |
295 | extern int ada_is_system_address_type (struct type *); |
296 | ||
d8af9068 | 297 | extern int ada_which_variant_applies (struct type *, struct value *); |
14f9c5c9 | 298 | |
fc1a4b47 | 299 | extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *, |
1ed6ede0 | 300 | CORE_ADDR, struct value *, |
dda83cd7 | 301 | int check_tag); |
4c4b4cd2 | 302 | |
0c3acc09 JB |
303 | extern struct value *ada_to_fixed_value (struct value *val); |
304 | ||
10a2c479 | 305 | extern struct type *ada_template_to_fixed_record_type_1 (struct type *type, |
fc1a4b47 | 306 | const gdb_byte *valaddr, |
10a2c479 AC |
307 | CORE_ADDR address, |
308 | struct value *dval0, | |
309 | int keep_dynamic_fields); | |
14f9c5c9 | 310 | |
d2e4a39e | 311 | extern int ada_name_prefix_len (const char *); |
14f9c5c9 | 312 | |
0d5cff50 | 313 | extern const char *ada_type_name (struct type *); |
14f9c5c9 | 314 | |
d2e4a39e | 315 | extern struct type *ada_find_parallel_type (struct type *, |
dda83cd7 | 316 | const char *suffix); |
4c4b4cd2 | 317 | |
edb0c9cb | 318 | extern bool get_int_var_value (const char *, LONGEST &value); |
14f9c5c9 | 319 | |
d2e4a39e | 320 | extern int ada_prefer_type (struct type *, struct type *); |
14f9c5c9 | 321 | |
d2e4a39e | 322 | extern struct type *ada_get_base_type (struct type *); |
14f9c5c9 | 323 | |
61ee279c | 324 | extern struct type *ada_check_typedef (struct type *); |
14f9c5c9 | 325 | |
5fea9794 | 326 | extern std::string ada_encode (const char *, bool fold = true); |
14f9c5c9 | 327 | |
d2e4a39e | 328 | extern const char *ada_enum_name (const char *); |
14f9c5c9 | 329 | |
d2e4a39e | 330 | extern int ada_is_modular_type (struct type *); |
14f9c5c9 | 331 | |
61ee279c | 332 | extern ULONGEST ada_modulus (struct type *); |
14f9c5c9 | 333 | |
d2e4a39e | 334 | extern struct value *ada_value_ind (struct value *); |
14f9c5c9 | 335 | |
d2e4a39e | 336 | extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *); |
14f9c5c9 | 337 | |
d2e4a39e | 338 | extern int ada_is_range_type_name (const char *); |
14f9c5c9 | 339 | |
aeb5907d JB |
340 | extern enum ada_renaming_category ada_parse_renaming (struct symbol *, |
341 | const char **, | |
342 | int *, const char **); | |
14f9c5c9 | 343 | |
bd2b40ac | 344 | extern void ada_find_printable_frame (frame_info_ptr fi); |
0ef643c8 | 345 | |
6f63b61d | 346 | extern const char *ada_main_name (); |
4c4b4cd2 | 347 | |
349774ef JB |
348 | extern void create_ada_exception_catchpoint |
349 | (struct gdbarch *gdbarch, enum ada_exception_catchpoint_kind ex_kind, | |
898db0f7 | 350 | std::string &&excep_string, const std::string &cond_string, int tempflag, |
12d67b37 | 351 | int enabled, int from_tty); |
349774ef | 352 | |
f06f1252 TT |
353 | /* Return true if BP is an Ada catchpoint. */ |
354 | ||
355 | extern bool is_ada_exception_catchpoint (breakpoint *bp); | |
356 | ||
778865d3 JB |
357 | /* Some information about a given Ada exception. */ |
358 | ||
ab816a27 | 359 | struct ada_exc_info |
778865d3 JB |
360 | { |
361 | /* The name of the exception. */ | |
362 | const char *name; | |
363 | ||
364 | /* The address of the symbol corresponding to that exception. */ | |
365 | CORE_ADDR addr; | |
778865d3 | 366 | |
cc536b21 PA |
367 | bool operator< (const ada_exc_info &) const; |
368 | bool operator== (const ada_exc_info &) const; | |
ab816a27 | 369 | }; |
778865d3 | 370 | |
ab816a27 | 371 | extern std::vector<ada_exc_info> ada_exceptions_list (const char *regexp); |
778865d3 | 372 | |
14f9c5c9 AS |
373 | /* Tasking-related: ada-tasks.c */ |
374 | ||
375 | extern int valid_task_id (int); | |
376 | ||
9edcc12f JB |
377 | extern struct ada_task_info *ada_get_task_info_from_ptid (ptid_t ptid); |
378 | ||
00431a78 | 379 | extern int ada_get_task_number (thread_info *thread); |
4a306c9a | 380 | |
78c02f21 TT |
381 | typedef gdb::function_view<void (struct ada_task_info *task)> |
382 | ada_task_list_iterator_ftype; | |
474011fb | 383 | extern void iterate_over_live_ada_tasks |
78c02f21 | 384 | (ada_task_list_iterator_ftype iterator); |
474011fb | 385 | |
cf3fbed4 JB |
386 | extern const char *ada_get_tcb_types_info (void); |
387 | ||
75082e8c | 388 | extern void print_ada_task_info (struct ui_out *uiout, |
24c54127 | 389 | const char *taskno_str, |
75082e8c JB |
390 | struct inferior *inf); |
391 | ||
cd9a3148 | 392 | /* Look for a symbol for an overloaded operator for the operation OP. |
7056f312 | 393 | PARSE_COMPLETION is true if currently parsing for completion. |
cd9a3148 TT |
394 | NARGS and ARGVEC describe the arguments to the call. Returns a |
395 | "null" block_symbol if no such operator is found. */ | |
396 | ||
397 | extern block_symbol ada_find_operator_symbol (enum exp_opcode op, | |
7056f312 | 398 | bool parse_completion, |
cd9a3148 TT |
399 | int nargs, value *argvec[]); |
400 | ||
401 | /* Resolve a function call, selecting among possible function symbols. | |
402 | SYM and BLOCK are passed to ada_lookup_symbol_list. CONTEXT_TYPE | |
7056f312 | 403 | describes the calling context. PARSE_COMPLETION is true if |
cd9a3148 TT |
404 | currently parsing for completion. NARGS and ARGVEC describe the |
405 | arguments to the call. This returns the chosen symbol and will | |
406 | update TRACKER accordingly. */ | |
407 | ||
408 | extern block_symbol ada_resolve_funcall (struct symbol *sym, | |
409 | const struct block *block, | |
410 | struct type *context_type, | |
7056f312 | 411 | bool parse_completion, |
cd9a3148 TT |
412 | int nargs, value *argvec[], |
413 | innermost_block_tracker *tracker); | |
414 | ||
415 | /* Resolve a symbol reference, selecting among possible values. SYM | |
416 | and BLOCK are passed to ada_lookup_symbol_list. CONTEXT_TYPE | |
7056f312 | 417 | describes the calling context. PARSE_COMPLETION is true if |
cd9a3148 TT |
418 | currently parsing for completion. If DEPROCEDURE_P is nonzero, |
419 | then a symbol that names a zero-argument function will be passed | |
420 | through ada_resolve_function. This returns the chosen symbol and | |
421 | will update TRACKER accordingly. */ | |
422 | ||
423 | extern block_symbol ada_resolve_variable (struct symbol *sym, | |
424 | const struct block *block, | |
425 | struct type *context_type, | |
7056f312 | 426 | bool parse_completion, |
cd9a3148 TT |
427 | int deprocedure_p, |
428 | innermost_block_tracker *tracker); | |
429 | ||
08a057e6 TT |
430 | /* The type of nth index in arrays of given type (n numbering from 1). |
431 | Does not examine memory. Throws an error if N is invalid or TYPE | |
432 | is not an array type. NAME is the name of the Ada attribute being | |
433 | evaluated ('range, 'first, 'last, or 'length); it is used in building | |
434 | the error message. */ | |
435 | extern struct type *ada_index_type (struct type *type, int n, | |
436 | const char *name); | |
437 | ||
14f9c5c9 | 438 | #endif |