1 /* Ada language support definitions for GDB, the GNU debugger.
3 Copyright (C) 1992-2021 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
20 #if !defined (ADA_LANG_H)
25 struct type_print_options
;
30 #include "breakpoint.h"
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
35 comma. FIXME: Should be part of a configuration file. */
36 #if defined (__linux__)
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$",
43 #if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS)
44 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
46 "^[agis]-.*\\.ad[bs]$",
49 /* Names of compiler-generated auxiliary functions probably of no
50 interest to users. Each name (a basic regular expression string)
51 is followed by a comma. */
52 #define ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS \
53 "___clean[.$a-zA-Z0-9_]*$", \
54 "___finalizer[.$a-zA-Z0-9_]*$",
56 /* The maximum number of frame levels searched for non-local,
57 * non-global symbols. This limit exists as a precaution to prevent
58 * infinite search loops when the stack is screwed up. */
59 #define MAX_ENCLOSING_FRAME_LEVELS 7
61 /* Maximum number of steps followed in looking for the ultimate
62 referent of a renaming. This prevents certain infinite loops that
63 can otherwise result. */
64 #define MAX_RENAMING_CHAIN_LENGTH 10
68 /* Corresponding encoded/decoded names and opcodes for Ada user-definable
77 /* Table of Ada operators in encoded and decoded forms. */
78 /* Defined in ada-lang.c */
79 extern const struct ada_opname_map ada_opname_table
[];
81 /* Denotes a type of renaming symbol (see ada_parse_renaming). */
82 enum ada_renaming_category
84 /* Indicates a symbol that does not encode a renaming. */
87 /* For symbols declared
88 Foo : TYPE renamed OBJECT; */
91 /* For symbols declared
92 Foo : exception renames EXCEPTION; */
93 ADA_EXCEPTION_RENAMING
,
94 /* For packages declared
95 package Foo renames PACKAGE; */
97 /* For subprograms declared
98 SUBPROGRAM_SPEC renames SUBPROGRAM;
99 (Currently not used). */
100 ADA_SUBPROGRAM_RENAMING
103 /* The different types of catchpoints that we introduced for catching
106 enum ada_exception_catchpoint_kind
109 ada_catch_exception_unhandled
,
114 /* Ada task structures. */
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. */
122 /* The ID of the task. */
125 /* The name of the task. */
128 /* The current state of the task. */
131 /* The priority associated to the task. */
134 /* If non-zero, the task ID of the parent task. */
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
;
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
;
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. */
152 extern void ada_ensure_varsize_limit (const struct type
*type
);
154 extern int ada_get_field_index (const struct type
*type
,
155 const char *field_name
,
158 extern int ada_parse (struct parser_state
*); /* Defined in ada-exp.y */
160 /* Defined in ada-typeprint.c */
161 extern void ada_print_type (struct type
*, const char *, struct ui_file
*, int,
162 int, const struct type_print_options
*);
164 extern void ada_print_typedef (struct type
*type
, struct symbol
*new_symbol
,
165 struct ui_file
*stream
);
167 /* Implement la_value_print_inner for Ada. */
169 extern void ada_value_print_inner (struct value
*, struct ui_file
*, int,
170 const struct value_print_options
*);
172 extern void ada_value_print (struct value
*, struct ui_file
*,
173 const struct value_print_options
*);
175 /* Defined in ada-lang.c */
177 extern void ada_emit_char (int, struct type
*, struct ui_file
*, int, int);
179 extern void ada_printchar (int, struct type
*, struct ui_file
*);
181 extern void ada_printstr (struct ui_file
*, struct type
*, const gdb_byte
*,
182 unsigned int, const char *, int,
183 const struct value_print_options
*);
185 struct value
*ada_convert_actual (struct value
*actual
,
186 struct type
*formal_type0
);
188 extern bool ada_is_access_to_unconstrained_array (struct type
*type
);
190 extern struct value
*ada_value_subscript (struct value
*, int,
193 extern void ada_fixup_array_indexes_type (struct type
*index_desc_type
);
195 extern struct type
*ada_array_element_type (struct type
*, int);
197 extern int ada_array_arity (struct type
*);
199 extern struct value
*ada_coerce_to_simple_array_ptr (struct value
*);
201 struct value
*ada_coerce_to_simple_array (struct value
*);
203 extern int ada_is_simple_array_type (struct type
*);
205 extern int ada_is_array_descriptor_type (struct type
*);
207 extern int ada_is_bogus_array_descriptor (struct type
*);
209 extern LONGEST
ada_discrete_type_low_bound (struct type
*);
211 extern LONGEST
ada_discrete_type_high_bound (struct type
*);
213 extern struct value
*ada_get_decoded_value (struct value
*value
);
215 extern struct type
*ada_get_decoded_type (struct type
*type
);
217 extern const char *ada_decode_symbol (const struct general_symbol_info
*);
219 /* Decode the GNAT-encoded name NAME, returning the decoded name. If
220 the name does not appear to be GNAT-encoded, then the result
221 depends on WRAP. If WRAP is true (the default), then the result is
222 simply wrapped in <...>. If WRAP is false, then the empty string
224 extern std::string
ada_decode (const char *name
, bool wrap
= true);
226 extern std::vector
<struct block_symbol
> ada_lookup_symbol_list
227 (const char *, const struct block
*, domain_enum
);
229 extern struct block_symbol
ada_lookup_symbol (const char *,
230 const struct block
*,
233 extern void ada_lookup_encoded_symbol
234 (const char *name
, const struct block
*block
, domain_enum domain
,
235 struct block_symbol
*symbol_info
);
237 extern struct bound_minimal_symbol
ada_lookup_simple_minsym (const char *);
239 extern int ada_scan_number (const char *, int, LONGEST
*, int *);
241 extern struct value
*ada_value_primitive_field (struct value
*arg1
,
244 struct type
*arg_type
);
246 extern struct type
*ada_parent_type (struct type
*);
248 extern int ada_is_ignored_field (struct type
*, int);
250 extern int ada_is_constrained_packed_array_type (struct type
*);
252 extern struct value
*ada_value_primitive_packed_val (struct value
*,
257 extern struct type
*ada_coerce_to_simple_array_type (struct type
*);
259 extern bool ada_is_character_type (struct type
*);
261 extern bool ada_is_string_type (struct type
*);
263 extern int ada_is_tagged_type (struct type
*, int);
265 extern int ada_is_tag_type (struct type
*);
267 extern gdb::unique_xmalloc_ptr
<char> ada_tag_name (struct value
*);
269 extern struct value
*ada_tag_value_at_base_address (struct value
*obj
);
271 extern int ada_is_parent_field (struct type
*, int);
273 extern int ada_is_wrapper_field (struct type
*, int);
275 extern int ada_is_variant_part (struct type
*, int);
277 extern struct type
*ada_variant_discrim_type (struct type
*, struct type
*);
279 extern const char *ada_variant_discrim_name (struct type
*);
281 extern int ada_is_aligner_type (struct type
*);
283 extern struct type
*ada_aligned_type (struct type
*);
285 extern const gdb_byte
*ada_aligned_value_addr (struct type
*,
288 extern int ada_is_system_address_type (struct type
*);
290 extern int ada_which_variant_applies (struct type
*, struct value
*);
292 extern struct type
*ada_to_fixed_type (struct type
*, const gdb_byte
*,
293 CORE_ADDR
, struct value
*,
296 extern struct value
*ada_to_fixed_value (struct value
*val
);
298 extern struct type
*ada_template_to_fixed_record_type_1 (struct type
*type
,
299 const gdb_byte
*valaddr
,
302 int keep_dynamic_fields
);
304 extern int ada_name_prefix_len (const char *);
306 extern const char *ada_type_name (struct type
*);
308 extern struct type
*ada_find_parallel_type (struct type
*,
311 extern bool get_int_var_value (const char *, LONGEST
&value
);
313 extern int ada_prefer_type (struct type
*, struct type
*);
315 extern struct type
*ada_get_base_type (struct type
*);
317 extern struct type
*ada_check_typedef (struct type
*);
319 extern std::string
ada_encode (const char *);
321 extern const char *ada_enum_name (const char *);
323 extern int ada_is_modular_type (struct type
*);
325 extern ULONGEST
ada_modulus (struct type
*);
327 extern struct value
*ada_value_ind (struct value
*);
329 extern void ada_print_scalar (struct type
*, LONGEST
, struct ui_file
*);
331 extern int ada_is_range_type_name (const char *);
333 extern enum ada_renaming_category
ada_parse_renaming (struct symbol
*,
335 int *, const char **);
337 extern void ada_find_printable_frame (struct frame_info
*fi
);
339 extern char *ada_breakpoint_rewrite (char *, int *);
341 extern char *ada_main_name (void);
343 extern void create_ada_exception_catchpoint
344 (struct gdbarch
*gdbarch
, enum ada_exception_catchpoint_kind ex_kind
,
345 const std::string
&excep_string
, const std::string
&cond_string
, int tempflag
,
346 int disabled
, int from_tty
);
348 /* Return true if BP is an Ada catchpoint. */
350 extern bool is_ada_exception_catchpoint (breakpoint
*bp
);
352 /* Some information about a given Ada exception. */
356 /* The name of the exception. */
359 /* The address of the symbol corresponding to that exception. */
362 bool operator< (const ada_exc_info
&) const;
363 bool operator== (const ada_exc_info
&) const;
366 extern std::vector
<ada_exc_info
> ada_exceptions_list (const char *regexp
);
368 /* Tasking-related: ada-tasks.c */
370 extern int valid_task_id (int);
372 extern struct ada_task_info
*ada_get_task_info_from_ptid (ptid_t ptid
);
374 extern int ada_get_task_number (thread_info
*thread
);
376 typedef gdb::function_view
<void (struct ada_task_info
*task
)>
377 ada_task_list_iterator_ftype
;
378 extern void iterate_over_live_ada_tasks
379 (ada_task_list_iterator_ftype iterator
);
381 extern const char *ada_get_tcb_types_info (void);
383 extern void print_ada_task_info (struct ui_out
*uiout
,
384 const char *taskno_str
,
385 struct inferior
*inf
);
387 /* Look for a symbol for an overloaded operator for the operation OP.
388 PARSE_COMPLETION is true if currently parsing for completion.
389 NARGS and ARGVEC describe the arguments to the call. Returns a
390 "null" block_symbol if no such operator is found. */
392 extern block_symbol
ada_find_operator_symbol (enum exp_opcode op
,
393 bool parse_completion
,
394 int nargs
, value
*argvec
[]);
396 /* Resolve a function call, selecting among possible function symbols.
397 SYM and BLOCK are passed to ada_lookup_symbol_list. CONTEXT_TYPE
398 describes the calling context. PARSE_COMPLETION is true if
399 currently parsing for completion. NARGS and ARGVEC describe the
400 arguments to the call. This returns the chosen symbol and will
401 update TRACKER accordingly. */
403 extern block_symbol
ada_resolve_funcall (struct symbol
*sym
,
404 const struct block
*block
,
405 struct type
*context_type
,
406 bool parse_completion
,
407 int nargs
, value
*argvec
[],
408 innermost_block_tracker
*tracker
);
410 /* Resolve a symbol reference, selecting among possible values. SYM
411 and BLOCK are passed to ada_lookup_symbol_list. CONTEXT_TYPE
412 describes the calling context. PARSE_COMPLETION is true if
413 currently parsing for completion. If DEPROCEDURE_P is nonzero,
414 then a symbol that names a zero-argument function will be passed
415 through ada_resolve_function. This returns the chosen symbol and
416 will update TRACKER accordingly. */
418 extern block_symbol
ada_resolve_variable (struct symbol
*sym
,
419 const struct block
*block
,
420 struct type
*context_type
,
421 bool parse_completion
,
423 innermost_block_tracker
*tracker
);
425 /* The type of nth index in arrays of given type (n numbering from 1).
426 Does not examine memory. Throws an error if N is invalid or TYPE
427 is not an array type. NAME is the name of the Ada attribute being
428 evaluated ('range, 'first, 'last, or 'length); it is used in building
429 the error message. */
430 extern struct type
*ada_index_type (struct type
*type
, int n
,