| 1 | /* Ada language support definitions for GDB, the GNU debugger. |
| 2 | |
| 3 | Copyright (C) 1992-2017 Free Software Foundation, Inc. |
| 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 3 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, see <http://www.gnu.org/licenses/>. */ |
| 19 | |
| 20 | #if !defined (ADA_LANG_H) |
| 21 | #define ADA_LANG_H 1 |
| 22 | |
| 23 | struct frame_info; |
| 24 | struct inferior; |
| 25 | struct type_print_options; |
| 26 | struct parser_state; |
| 27 | |
| 28 | #include "value.h" |
| 29 | #include "gdbtypes.h" |
| 30 | #include "breakpoint.h" |
| 31 | #include "vec.h" |
| 32 | |
| 33 | /* Names of specific files known to be part of the runtime |
| 34 | system and that might consider (confusing) debugging information. |
| 35 | Each name (a basic regular expression string) is followed by a |
| 36 | comma. FIXME: Should be part of a configuration file. */ |
| 37 | #if defined (__linux__) |
| 38 | #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \ |
| 39 | "^[agis]-.*\\.ad[bs]$", \ |
| 40 | "/lib.*/libpthread\\.so[.0-9]*$", "/lib.*/libpthread\\.a$", \ |
| 41 | "/lib.*/libc\\.so[.0-9]*$", "/lib.*/libc\\.a$", |
| 42 | #endif |
| 43 | |
| 44 | #if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS) |
| 45 | #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \ |
| 46 | "^unwind-seh.c$", \ |
| 47 | "^[agis]-.*\\.ad[bs]$", |
| 48 | #endif |
| 49 | |
| 50 | /* Names of compiler-generated auxiliary functions probably of no |
| 51 | interest to users. Each name (a basic regular expression string) |
| 52 | is followed by a comma. */ |
| 53 | #define ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS \ |
| 54 | "___clean[.$a-zA-Z0-9_]*$", \ |
| 55 | "___finalizer[.$a-zA-Z0-9_]*$", |
| 56 | |
| 57 | /* The maximum number of frame levels searched for non-local, |
| 58 | * non-global symbols. This limit exists as a precaution to prevent |
| 59 | * infinite search loops when the stack is screwed up. */ |
| 60 | #define MAX_ENCLOSING_FRAME_LEVELS 7 |
| 61 | |
| 62 | /* Maximum number of steps followed in looking for the ultimate |
| 63 | referent of a renaming. This prevents certain infinite loops that |
| 64 | can otherwise result. */ |
| 65 | #define MAX_RENAMING_CHAIN_LENGTH 10 |
| 66 | |
| 67 | struct block; |
| 68 | |
| 69 | /* Corresponding encoded/decoded names and opcodes for Ada user-definable |
| 70 | operators. */ |
| 71 | struct ada_opname_map |
| 72 | { |
| 73 | const char *encoded; |
| 74 | const char *decoded; |
| 75 | enum exp_opcode op; |
| 76 | }; |
| 77 | |
| 78 | /* Table of Ada operators in encoded and decoded forms. */ |
| 79 | /* Defined in ada-lang.c */ |
| 80 | extern const struct ada_opname_map ada_opname_table[]; |
| 81 | |
| 82 | /* Denotes a type of renaming symbol (see ada_parse_renaming). */ |
| 83 | enum ada_renaming_category |
| 84 | { |
| 85 | /* Indicates a symbol that does not encode a renaming. */ |
| 86 | ADA_NOT_RENAMING, |
| 87 | |
| 88 | /* For symbols declared |
| 89 | Foo : TYPE renamed OBJECT; */ |
| 90 | ADA_OBJECT_RENAMING, |
| 91 | |
| 92 | /* For symbols declared |
| 93 | Foo : exception renames EXCEPTION; */ |
| 94 | ADA_EXCEPTION_RENAMING, |
| 95 | /* For packages declared |
| 96 | package Foo renames PACKAGE; */ |
| 97 | ADA_PACKAGE_RENAMING, |
| 98 | /* For subprograms declared |
| 99 | SUBPROGRAM_SPEC renames SUBPROGRAM; |
| 100 | (Currently not used). */ |
| 101 | ADA_SUBPROGRAM_RENAMING |
| 102 | }; |
| 103 | |
| 104 | /* The different types of catchpoints that we introduced for catching |
| 105 | Ada exceptions. */ |
| 106 | |
| 107 | enum ada_exception_catchpoint_kind |
| 108 | { |
| 109 | ada_catch_exception, |
| 110 | ada_catch_exception_unhandled, |
| 111 | ada_catch_assert |
| 112 | }; |
| 113 | |
| 114 | /* Ada task structures. */ |
| 115 | |
| 116 | struct ada_task_info |
| 117 | { |
| 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. */ |
| 132 | int priority; |
| 133 | |
| 134 | /* If non-zero, the task ID of the parent task. */ |
| 135 | CORE_ADDR parent; |
| 136 | |
| 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; |
| 140 | |
| 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; |
| 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; |
| 150 | }; |
| 151 | |
| 152 | /* Assuming V points to an array of S objects, make sure that it contains at |
| 153 | least M objects, updating V and S as necessary. */ |
| 154 | |
| 155 | #define GROW_VECT(v, s, m) \ |
| 156 | if ((s) < (m)) (v) = (char *) grow_vect (v, &(s), m, sizeof *(v)); |
| 157 | |
| 158 | extern void *grow_vect (void *, size_t *, size_t, int); |
| 159 | |
| 160 | extern void ada_ensure_varsize_limit (const struct type *type); |
| 161 | |
| 162 | extern int ada_get_field_index (const struct type *type, |
| 163 | const char *field_name, |
| 164 | int maybe_missing); |
| 165 | |
| 166 | extern int ada_parse (struct parser_state *); /* Defined in ada-exp.y */ |
| 167 | |
| 168 | extern void ada_yyerror (const char *); /* Defined in ada-exp.y */ |
| 169 | |
| 170 | /* Defined in ada-typeprint.c */ |
| 171 | extern void ada_print_type (struct type *, const char *, struct ui_file *, int, |
| 172 | int, const struct type_print_options *); |
| 173 | |
| 174 | extern void ada_print_typedef (struct type *type, struct symbol *new_symbol, |
| 175 | struct ui_file *stream); |
| 176 | |
| 177 | extern void ada_val_print (struct type *, int, CORE_ADDR, |
| 178 | struct ui_file *, int, |
| 179 | struct value *, |
| 180 | const struct value_print_options *); |
| 181 | |
| 182 | extern void ada_value_print (struct value *, struct ui_file *, |
| 183 | const struct value_print_options *); |
| 184 | |
| 185 | /* Defined in ada-lang.c */ |
| 186 | |
| 187 | extern void ada_emit_char (int, struct type *, struct ui_file *, int, int); |
| 188 | |
| 189 | extern void ada_printchar (int, struct type *, struct ui_file *); |
| 190 | |
| 191 | extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *, |
| 192 | unsigned int, const char *, int, |
| 193 | const struct value_print_options *); |
| 194 | |
| 195 | struct value *ada_convert_actual (struct value *actual, |
| 196 | struct type *formal_type0); |
| 197 | |
| 198 | extern struct value *ada_value_subscript (struct value *, int, |
| 199 | struct value **); |
| 200 | |
| 201 | extern void ada_fixup_array_indexes_type (struct type *index_desc_type); |
| 202 | |
| 203 | extern struct type *ada_array_element_type (struct type *, int); |
| 204 | |
| 205 | extern int ada_array_arity (struct type *); |
| 206 | |
| 207 | struct type *ada_type_of_array (struct value *, int); |
| 208 | |
| 209 | extern struct value *ada_coerce_to_simple_array_ptr (struct value *); |
| 210 | |
| 211 | struct value *ada_coerce_to_simple_array (struct value *); |
| 212 | |
| 213 | extern int ada_is_simple_array_type (struct type *); |
| 214 | |
| 215 | extern int ada_is_array_descriptor_type (struct type *); |
| 216 | |
| 217 | extern int ada_is_bogus_array_descriptor (struct type *); |
| 218 | |
| 219 | extern LONGEST ada_discrete_type_low_bound (struct type *); |
| 220 | |
| 221 | extern LONGEST ada_discrete_type_high_bound (struct type *); |
| 222 | |
| 223 | extern struct value *ada_get_decoded_value (struct value *value); |
| 224 | |
| 225 | extern struct type *ada_get_decoded_type (struct type *type); |
| 226 | |
| 227 | extern const char *ada_decode_symbol (const struct general_symbol_info *); |
| 228 | |
| 229 | extern const char *ada_decode (const char*); |
| 230 | |
| 231 | extern enum language ada_update_initial_language (enum language); |
| 232 | |
| 233 | extern int ada_lookup_symbol_list (const char *, const struct block *, |
| 234 | domain_enum, struct block_symbol**); |
| 235 | |
| 236 | extern char *ada_fold_name (const char *); |
| 237 | |
| 238 | extern struct block_symbol ada_lookup_symbol (const char *, |
| 239 | const struct block *, |
| 240 | domain_enum, int *); |
| 241 | |
| 242 | extern void ada_lookup_encoded_symbol |
| 243 | (const char *name, const struct block *block, domain_enum domain, |
| 244 | struct block_symbol *symbol_info); |
| 245 | |
| 246 | extern struct bound_minimal_symbol ada_lookup_simple_minsym (const char *); |
| 247 | |
| 248 | extern void ada_fill_in_ada_prototype (struct symbol *); |
| 249 | |
| 250 | extern int user_select_syms (struct block_symbol *, int, int); |
| 251 | |
| 252 | extern int get_selections (int *, int, int, int, const char *); |
| 253 | |
| 254 | extern int ada_scan_number (const char *, int, LONGEST *, int *); |
| 255 | |
| 256 | extern struct type *ada_parent_type (struct type *); |
| 257 | |
| 258 | extern int ada_is_ignored_field (struct type *, int); |
| 259 | |
| 260 | extern int ada_is_constrained_packed_array_type (struct type *); |
| 261 | |
| 262 | extern struct value *ada_value_primitive_packed_val (struct value *, |
| 263 | const gdb_byte *, |
| 264 | long, int, int, |
| 265 | struct type *); |
| 266 | |
| 267 | extern struct type *ada_coerce_to_simple_array_type (struct type *); |
| 268 | |
| 269 | extern int ada_is_character_type (struct type *); |
| 270 | |
| 271 | extern int ada_is_string_type (struct type *); |
| 272 | |
| 273 | extern int ada_is_tagged_type (struct type *, int); |
| 274 | |
| 275 | extern int ada_is_tag_type (struct type *); |
| 276 | |
| 277 | extern struct type *ada_tag_type (struct value *); |
| 278 | |
| 279 | extern struct value *ada_value_tag (struct value *); |
| 280 | |
| 281 | extern const char *ada_tag_name (struct value *); |
| 282 | |
| 283 | extern struct value *ada_tag_value_at_base_address (struct value *obj); |
| 284 | |
| 285 | extern int ada_is_parent_field (struct type *, int); |
| 286 | |
| 287 | extern int ada_is_wrapper_field (struct type *, int); |
| 288 | |
| 289 | extern int ada_is_variant_part (struct type *, int); |
| 290 | |
| 291 | extern struct type *ada_variant_discrim_type (struct type *, struct type *); |
| 292 | |
| 293 | extern int ada_is_others_clause (struct type *, int); |
| 294 | |
| 295 | extern int ada_in_variant (LONGEST, struct type *, int); |
| 296 | |
| 297 | extern const char *ada_variant_discrim_name (struct type *); |
| 298 | |
| 299 | extern struct value *ada_value_struct_elt (struct value *, const char *, int); |
| 300 | |
| 301 | extern int ada_is_aligner_type (struct type *); |
| 302 | |
| 303 | extern struct type *ada_aligned_type (struct type *); |
| 304 | |
| 305 | extern const gdb_byte *ada_aligned_value_addr (struct type *, |
| 306 | const gdb_byte *); |
| 307 | |
| 308 | extern const char *ada_attribute_name (enum exp_opcode); |
| 309 | |
| 310 | extern int ada_is_fixed_point_type (struct type *); |
| 311 | |
| 312 | extern int ada_is_system_address_type (struct type *); |
| 313 | |
| 314 | extern struct value *ada_delta (struct type *); |
| 315 | |
| 316 | extern struct value *ada_scaling_factor (struct type *); |
| 317 | |
| 318 | extern struct type *ada_system_address_type (void); |
| 319 | |
| 320 | extern int ada_which_variant_applies (struct type *, struct type *, |
| 321 | const gdb_byte *); |
| 322 | |
| 323 | extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *, |
| 324 | CORE_ADDR, struct value *, |
| 325 | int check_tag); |
| 326 | |
| 327 | extern struct value *ada_to_fixed_value (struct value *val); |
| 328 | |
| 329 | extern struct type *ada_template_to_fixed_record_type_1 (struct type *type, |
| 330 | const gdb_byte *valaddr, |
| 331 | CORE_ADDR address, |
| 332 | struct value *dval0, |
| 333 | int keep_dynamic_fields); |
| 334 | |
| 335 | extern int ada_name_prefix_len (const char *); |
| 336 | |
| 337 | extern const char *ada_type_name (struct type *); |
| 338 | |
| 339 | extern struct type *ada_find_parallel_type (struct type *, |
| 340 | const char *suffix); |
| 341 | |
| 342 | extern bool get_int_var_value (const char *, LONGEST &value); |
| 343 | |
| 344 | extern struct symbol *ada_find_renaming_symbol (struct symbol *name_sym, |
| 345 | const struct block *block); |
| 346 | |
| 347 | extern int ada_prefer_type (struct type *, struct type *); |
| 348 | |
| 349 | extern struct type *ada_get_base_type (struct type *); |
| 350 | |
| 351 | extern struct type *ada_check_typedef (struct type *); |
| 352 | |
| 353 | extern char *ada_encode (const char *); |
| 354 | |
| 355 | extern const char *ada_enum_name (const char *); |
| 356 | |
| 357 | extern int ada_is_modular_type (struct type *); |
| 358 | |
| 359 | extern ULONGEST ada_modulus (struct type *); |
| 360 | |
| 361 | extern struct value *ada_value_ind (struct value *); |
| 362 | |
| 363 | extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *); |
| 364 | |
| 365 | extern int ada_is_range_type_name (const char *); |
| 366 | |
| 367 | extern enum ada_renaming_category ada_parse_renaming (struct symbol *, |
| 368 | const char **, |
| 369 | int *, const char **); |
| 370 | |
| 371 | extern void ada_find_printable_frame (struct frame_info *fi); |
| 372 | |
| 373 | extern char *ada_breakpoint_rewrite (char *, int *); |
| 374 | |
| 375 | extern char *ada_main_name (void); |
| 376 | |
| 377 | extern std::string ada_name_for_lookup (const char *name); |
| 378 | |
| 379 | extern void create_ada_exception_catchpoint |
| 380 | (struct gdbarch *gdbarch, enum ada_exception_catchpoint_kind ex_kind, |
| 381 | char *excep_string, char *cond_string, int tempflag, int disabled, |
| 382 | int from_tty); |
| 383 | |
| 384 | /* Some information about a given Ada exception. */ |
| 385 | |
| 386 | struct ada_exc_info |
| 387 | { |
| 388 | /* The name of the exception. */ |
| 389 | const char *name; |
| 390 | |
| 391 | /* The address of the symbol corresponding to that exception. */ |
| 392 | CORE_ADDR addr; |
| 393 | |
| 394 | bool operator< (const ada_exc_info &) const; |
| 395 | bool operator== (const ada_exc_info &) const; |
| 396 | }; |
| 397 | |
| 398 | extern std::vector<ada_exc_info> ada_exceptions_list (const char *regexp); |
| 399 | |
| 400 | /* Tasking-related: ada-tasks.c */ |
| 401 | |
| 402 | extern int valid_task_id (int); |
| 403 | |
| 404 | extern struct ada_task_info *ada_get_task_info_from_ptid (ptid_t ptid); |
| 405 | |
| 406 | extern int ada_get_task_number (ptid_t); |
| 407 | |
| 408 | typedef void (ada_task_list_iterator_ftype) (struct ada_task_info *task); |
| 409 | extern void iterate_over_live_ada_tasks |
| 410 | (ada_task_list_iterator_ftype *iterator); |
| 411 | |
| 412 | extern const char *ada_get_tcb_types_info (void); |
| 413 | |
| 414 | extern int ada_build_task_list (void); |
| 415 | |
| 416 | extern void print_ada_task_info (struct ui_out *uiout, |
| 417 | char *taskno_str, |
| 418 | struct inferior *inf); |
| 419 | |
| 420 | #endif |