GDB (xrefs)
Loading...
Searching...
No Matches
ada-lang.h
Go to the documentation of this file.
1/* Ada language support definitions for GDB, the GNU debugger.
2
3 Copyright (C) 1992-2023 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
23class frame_info_ptr;
24struct inferior;
26struct parser_state;
27
28#include "value.h"
29#include "gdbtypes.h"
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
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$",
41#endif
42
43#if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS)
44#define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
45 "^unwind-seh.c$", \
46 "^[agis]-.*\\.ad[bs]$",
47#endif
48
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_]*$",
55
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
60
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
65
66struct block;
67
68/* Corresponding encoded/decoded names and opcodes for Ada user-definable
69 operators. */
71{
72 const char *encoded;
73 const char *decoded;
75};
76
77/* Table of Ada operators in encoded and decoded forms. */
78/* Defined in ada-lang.c */
79extern const struct ada_opname_map ada_opname_table[];
80
81/* Denotes a type of renaming symbol (see ada_parse_renaming). */
83 {
84 /* Indicates a symbol that does not encode a renaming. */
86
87 /* For symbols declared
88 Foo : TYPE renamed OBJECT; */
90
91 /* For symbols declared
92 Foo : exception renames EXCEPTION; */
94 /* For packages declared
95 package Foo renames PACKAGE; */
97 /* For subprograms declared
98 SUBPROGRAM_SPEC renames SUBPROGRAM;
99 (Currently not used). */
101 };
102
103/* The different types of catchpoints that we introduced for catching
104 Ada exceptions. */
105
107{
113
114/* Ada task structures. */
115
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. */
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. */
150};
151
152extern int ada_get_field_index (const struct type *type,
153 const char *field_name,
154 int maybe_missing);
155
156extern int ada_parse (struct parser_state *); /* Defined in ada-exp.y */
157
158 /* Defined in ada-typeprint.c */
159extern void ada_print_type (struct type *, const char *, struct ui_file *, int,
160 int, const struct type_print_options *);
161
162extern void ada_print_typedef (struct type *type, struct symbol *new_symbol,
163 struct ui_file *stream);
164
165/* Implement la_value_print_inner for Ada. */
166
167extern void ada_value_print_inner (struct value *, struct ui_file *, int,
168 const struct value_print_options *);
169
170extern void ada_value_print (struct value *, struct ui_file *,
171 const struct value_print_options *);
172
173 /* Defined in ada-lang.c */
174
175extern void ada_emit_char (int, struct type *, struct ui_file *, int, int);
176
177extern void ada_printchar (int, struct type *, struct ui_file *);
178
179extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *,
180 unsigned int, const char *, int,
181 const struct value_print_options *);
182
183struct value *ada_convert_actual (struct value *actual,
184 struct type *formal_type0);
185
187
188extern struct value *ada_value_subscript (struct value *, int,
189 struct value **);
190
191extern void ada_fixup_array_indexes_type (struct type *index_desc_type);
192
193extern struct type *ada_array_element_type (struct type *, int);
194
195extern int ada_array_arity (struct type *);
196
197extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
198
199struct value *ada_coerce_to_simple_array (struct value *);
200
201extern int ada_is_simple_array_type (struct type *);
202
203extern int ada_is_array_descriptor_type (struct type *);
204
205extern int ada_is_bogus_array_descriptor (struct type *);
206
207extern LONGEST ada_discrete_type_low_bound (struct type *);
208
209extern LONGEST ada_discrete_type_high_bound (struct type *);
210
211extern struct value *ada_get_decoded_value (struct value *value);
212
213extern struct type *ada_get_decoded_type (struct type *type);
214
215extern const char *ada_decode_symbol (const struct general_symbol_info *);
216
217/* Decode the GNAT-encoded name NAME, returning the decoded name. If
218 the name does not appear to be GNAT-encoded, then the result
219 depends on WRAP. If WRAP is true (the default), then the result is
220 simply wrapped in <...>. If WRAP is false, then the empty string
221 will be returned. Also, when OPERATORS is false, operator names
222 will not be decoded. */
223extern std::string ada_decode (const char *name, bool wrap = true,
224 bool operators = true);
225
226extern std::vector<struct block_symbol> ada_lookup_symbol_list
227 (const char *, const struct block *, domain_enum);
228
229extern struct block_symbol ada_lookup_symbol (const char *,
230 const struct block *,
232
234 (const char *name, const struct block *block, domain_enum domain,
235 struct block_symbol *symbol_info);
236
237extern struct bound_minimal_symbol ada_lookup_simple_minsym (const char *,
238 objfile *);
239
240extern int ada_scan_number (const char *, int, LONGEST *, int *);
241
242extern struct value *ada_value_primitive_field (struct value *arg1,
243 int offset,
244 int fieldno,
245 struct type *arg_type);
246
247extern struct type *ada_parent_type (struct type *);
248
249extern int ada_is_ignored_field (struct type *, int);
250
251extern int ada_is_constrained_packed_array_type (struct type *);
252
253extern struct value *ada_value_primitive_packed_val (struct value *,
254 const gdb_byte *,
255 long, int, int,
256 struct type *);
257
258extern struct type *ada_coerce_to_simple_array_type (struct type *);
259
260extern bool ada_is_character_type (struct type *);
261
262extern bool ada_is_string_type (struct type *);
263
264extern int ada_is_tagged_type (struct type *, int);
265
266extern int ada_is_tag_type (struct type *);
267
268extern gdb::unique_xmalloc_ptr<char> ada_tag_name (struct value *);
269
270extern struct value *ada_tag_value_at_base_address (struct value *obj);
271
272extern int ada_is_parent_field (struct type *, int);
273
274extern int ada_is_wrapper_field (struct type *, int);
275
276extern int ada_is_variant_part (struct type *, int);
277
278extern struct type *ada_variant_discrim_type (struct type *, struct type *);
279
280extern const char *ada_variant_discrim_name (struct type *);
281
282extern int ada_is_aligner_type (struct type *);
283
284extern struct type *ada_aligned_type (struct type *);
285
286extern const gdb_byte *ada_aligned_value_addr (struct type *,
287 const gdb_byte *);
288
289extern int ada_is_system_address_type (struct type *);
290
291extern int ada_which_variant_applies (struct type *, struct value *);
292
293extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
294 CORE_ADDR, struct value *,
295 int check_tag);
296
297extern struct value *ada_to_fixed_value (struct value *val);
298
299extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
300 const gdb_byte *valaddr,
301 CORE_ADDR address,
302 struct value *dval0,
303 int keep_dynamic_fields);
304
305extern int ada_name_prefix_len (const char *);
306
307extern const char *ada_type_name (struct type *);
308
309extern struct type *ada_find_parallel_type (struct type *,
310 const char *suffix);
311
312extern bool get_int_var_value (const char *, LONGEST &value);
313
314extern int ada_prefer_type (struct type *, struct type *);
315
316extern struct type *ada_get_base_type (struct type *);
317
318extern struct type *ada_check_typedef (struct type *);
319
320extern std::string ada_encode (const char *, bool fold = true);
321
322extern const char *ada_enum_name (const char *);
323
324extern int ada_is_modular_type (struct type *);
325
326extern ULONGEST ada_modulus (struct type *);
327
328extern struct value *ada_value_ind (struct value *);
329
330extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
331
332extern int ada_is_range_type_name (const char *);
333
335 const char **,
336 int *, const char **);
337
339
340extern char *ada_breakpoint_rewrite (char *, int *);
341
342extern char *ada_main_name (void);
343
345 (struct gdbarch *gdbarch, enum ada_exception_catchpoint_kind ex_kind,
346 const std::string &excep_string, const std::string &cond_string, int tempflag,
347 int disabled, int from_tty);
348
349/* Return true if BP is an Ada catchpoint. */
350
352
353/* Some information about a given Ada exception. */
354
356{
357 /* The name of the exception. */
358 const char *name;
359
360 /* The address of the symbol corresponding to that exception. */
361 CORE_ADDR addr;
362
363 bool operator< (const ada_exc_info &) const;
364 bool operator== (const ada_exc_info &) const;
365};
366
367extern std::vector<ada_exc_info> ada_exceptions_list (const char *regexp);
368
369/* Tasking-related: ada-tasks.c */
370
371extern int valid_task_id (int);
372
373extern struct ada_task_info *ada_get_task_info_from_ptid (ptid_t ptid);
374
375extern int ada_get_task_number (thread_info *thread);
376
377typedef gdb::function_view<void (struct ada_task_info *task)>
381
382extern const char *ada_get_tcb_types_info (void);
383
384extern void print_ada_task_info (struct ui_out *uiout,
385 const char *taskno_str,
386 struct inferior *inf);
387
388/* Look for a symbol for an overloaded operator for the operation OP.
389 PARSE_COMPLETION is true if currently parsing for completion.
390 NARGS and ARGVEC describe the arguments to the call. Returns a
391 "null" block_symbol if no such operator is found. */
392
394 bool parse_completion,
395 int nargs, value *argvec[]);
396
397/* Resolve a function call, selecting among possible function symbols.
398 SYM and BLOCK are passed to ada_lookup_symbol_list. CONTEXT_TYPE
399 describes the calling context. PARSE_COMPLETION is true if
400 currently parsing for completion. NARGS and ARGVEC describe the
401 arguments to the call. This returns the chosen symbol and will
402 update TRACKER accordingly. */
403
404extern block_symbol ada_resolve_funcall (struct symbol *sym,
405 const struct block *block,
406 struct type *context_type,
407 bool parse_completion,
408 int nargs, value *argvec[],
409 innermost_block_tracker *tracker);
410
411/* Resolve a symbol reference, selecting among possible values. SYM
412 and BLOCK are passed to ada_lookup_symbol_list. CONTEXT_TYPE
413 describes the calling context. PARSE_COMPLETION is true if
414 currently parsing for completion. If DEPROCEDURE_P is nonzero,
415 then a symbol that names a zero-argument function will be passed
416 through ada_resolve_function. This returns the chosen symbol and
417 will update TRACKER accordingly. */
418
419extern block_symbol ada_resolve_variable (struct symbol *sym,
420 const struct block *block,
421 struct type *context_type,
422 bool parse_completion,
423 int deprocedure_p,
424 innermost_block_tracker *tracker);
425
426/* The type of nth index in arrays of given type (n numbering from 1).
427 Does not examine memory. Throws an error if N is invalid or TYPE
428 is not an array type. NAME is the name of the Ada attribute being
429 evaluated ('range, 'first, 'last, or 'length); it is used in building
430 the error message. */
431extern struct type *ada_index_type (struct type *type, int n,
432 const char *name);
433
434#endif
const char *const name
bool is_ada_exception_catchpoint(breakpoint *bp)
Definition ada-lang.c:12573
LONGEST ada_discrete_type_low_bound(struct type *)
Definition ada-lang.c:701
struct type * ada_parent_type(struct type *)
Definition ada-lang.c:6664
const char * ada_variant_discrim_name(struct type *)
Definition ada-lang.c:6782
int ada_get_task_number(thread_info *thread)
Definition ada-tasks.c:334
void ada_value_print(struct value *, struct ui_file *, const struct value_print_options *)
struct type * ada_index_type(struct type *type, int n, const char *name)
Definition ada-lang.c:3233
int ada_which_variant_applies(struct type *, struct value *)
Definition ada-lang.c:7456
struct value * ada_value_subscript(struct value *, int, struct value **)
Definition ada-lang.c:2999
struct ada_task_info * ada_get_task_info_from_ptid(ptid_t ptid)
Definition ada-tasks.c:392
int ada_is_range_type_name(const char *)
Definition ada-lang.c:11546
struct value * ada_get_decoded_value(struct value *value)
Definition ada-lang.c:755
block_symbol ada_resolve_funcall(struct symbol *sym, const struct block *block, struct type *context_type, bool parse_completion, int nargs, value *argvec[], innermost_block_tracker *tracker)
Definition ada-lang.c:3768
void ada_print_scalar(struct type *, LONGEST, struct ui_file *)
void create_ada_exception_catchpoint(struct gdbarch *gdbarch, enum ada_exception_catchpoint_kind ex_kind, const std::string &excep_string, const std::string &cond_string, int tempflag, int disabled, int from_tty)
Definition ada-lang.c:12795
char * ada_main_name(void)
Definition ada-lang.c:809
char * ada_breakpoint_rewrite(char *, int *)
void ada_print_type(struct type *, const char *, struct ui_file *, int, int, const struct type_print_options *)
int ada_is_tag_type(struct type *)
Definition ada-lang.c:6358
std::vector< struct block_symbol > ada_lookup_symbol_list(const char *, const struct block *, domain_enum)
Definition ada-lang.c:5763
block_symbol ada_find_operator_symbol(enum exp_opcode op, bool parse_completion, int nargs, value *argvec[])
Definition ada-lang.c:3747
struct value * ada_value_primitive_packed_val(struct value *, const gdb_byte *, long, int, int, struct type *)
Definition ada-lang.c:2760
void ada_printchar(int, struct type *, struct ui_file *)
std::string ada_decode(const char *name, bool wrap=true, bool operators=true)
Definition ada-lang.c:1310
LONGEST ada_discrete_type_high_bound(struct type *)
Definition ada-lang.c:666
bool ada_is_access_to_unconstrained_array(struct type *type)
Definition ada-lang.c:2988
void ada_emit_char(int, struct type *, struct ui_file *, int, int)
void ada_print_typedef(struct type *type, struct symbol *new_symbol, struct ui_file *stream)
ada_renaming_category
Definition ada-lang.h:83
@ ADA_EXCEPTION_RENAMING
Definition ada-lang.h:93
@ ADA_OBJECT_RENAMING
Definition ada-lang.h:89
@ ADA_NOT_RENAMING
Definition ada-lang.h:85
@ ADA_PACKAGE_RENAMING
Definition ada-lang.h:96
@ ADA_SUBPROGRAM_RENAMING
Definition ada-lang.h:100
struct bound_minimal_symbol ada_lookup_simple_minsym(const char *, objfile *)
Definition ada-lang.c:4905
const char * ada_decode_symbol(const struct general_symbol_info *)
Definition ada-lang.c:1606
int ada_is_system_address_type(struct type *)
Definition ada-lang.c:11349
struct block_symbol ada_lookup_symbol(const char *, const struct block *, domain_enum)
Definition ada-lang.c:5802
struct type * ada_get_base_type(struct type *)
Definition ada-lang.c:9055
int ada_name_prefix_len(const char *)
Definition ada-lang.c:515
struct type * ada_to_fixed_type(struct type *, const gdb_byte *, CORE_ADDR, struct value *, int check_tag)
Definition ada-lang.c:8699
struct type * ada_variant_discrim_type(struct type *, struct type *)
Definition ada-lang.c:6758
int ada_is_ignored_field(struct type *, int)
Definition ada-lang.c:6297
const char * ada_type_name(struct type *)
Definition ada-lang.c:7670
struct type * ada_find_parallel_type(struct type *, const char *suffix)
Definition ada-lang.c:7758
void ada_value_print_inner(struct value *, struct ui_file *, int, const struct value_print_options *)
void ada_find_printable_frame(frame_info_ptr fi)
Definition ada-lang.c:11908
int ada_is_bogus_array_descriptor(struct type *)
Definition ada-lang.c:2086
struct type * ada_coerce_to_simple_array_type(struct type *)
Definition ada-lang.c:2227
int ada_is_tagged_type(struct type *, int)
Definition ada-lang.c:6350
std::vector< ada_exc_info > ada_exceptions_list(const char *regexp)
Definition ada-lang.c:13231
enum ada_renaming_category ada_parse_renaming(struct symbol *, const char **, int *, const char **)
Definition ada-lang.c:4270
bool ada_is_string_type(struct type *)
Definition ada-lang.c:9006
struct value * ada_coerce_to_simple_array_ptr(struct value *)
Definition ada-lang.c:2185
struct value * ada_value_ind(struct value *)
Definition ada-lang.c:7526
void print_ada_task_info(struct ui_out *uiout, const char *taskno_str, struct inferior *inf)
Definition ada-tasks.c:1065
struct type * ada_get_decoded_type(struct type *type)
Definition ada-lang.c:780
void ada_printstr(struct ui_file *, struct type *, const gdb_byte *, unsigned int, const char *, int, const struct value_print_options *)
const gdb_byte * ada_aligned_value_addr(struct type *, const gdb_byte *)
Definition ada-lang.c:9116
const char * ada_enum_name(const char *)
Definition ada-lang.c:9131
struct type * ada_check_typedef(struct type *)
Definition ada-lang.c:8805
struct value * ada_tag_value_at_base_address(struct value *obj)
Definition ada-lang.c:6444
struct value * ada_convert_actual(struct value *actual, struct type *formal_type0)
Definition ada-lang.c:4502
std::string ada_encode(const char *, bool fold=true)
Definition ada-lang.c:1154
int ada_is_constrained_packed_array_type(struct type *)
Definition ada-lang.c:2256
const char * ada_get_tcb_types_info(void)
Definition ada-tasks.c:503
block_symbol ada_resolve_variable(struct symbol *sym, const struct block *block, struct type *context_type, bool parse_completion, int deprocedure_p, innermost_block_tracker *tracker)
Definition ada-lang.c:3821
int ada_array_arity(struct type *)
Definition ada-lang.c:3158
int ada_is_variant_part(struct type *, int)
Definition ada-lang.c:6738
bool get_int_var_value(const char *, LONGEST &value)
Definition ada-lang.c:11434
void ada_lookup_encoded_symbol(const char *name, const struct block *block, domain_enum domain, struct block_symbol *symbol_info)
Definition ada-lang.c:5780
void iterate_over_live_ada_tasks(ada_task_list_iterator_ftype iterator)
Definition ada-tasks.c:412
struct type * ada_template_to_fixed_record_type_1(struct type *type, const gdb_byte *valaddr, CORE_ADDR address, struct value *dval0, int keep_dynamic_fields)
Definition ada-lang.c:7863
struct type * ada_aligned_type(struct type *)
Definition ada-lang.c:9103
int ada_prefer_type(struct type *, struct type *)
Definition ada-lang.c:7637
struct type * ada_array_element_type(struct type *, int)
Definition ada-lang.c:3186
int ada_is_wrapper_field(struct type *, int)
Definition ada-lang.c:6711
int valid_task_id(int)
Definition ada-tasks.c:370
int ada_is_parent_field(struct type *, int)
Definition ada-lang.c:6695
int ada_is_aligner_type(struct type *)
Definition ada-lang.c:9039
ULONGEST ada_modulus(struct type *)
Definition ada-lang.c:11569
int ada_get_field_index(const struct type *type, const char *field_name, int maybe_missing)
Definition ada-lang.c:495
const struct ada_opname_map ada_opname_table[]
Definition ada-lang.c:840
int ada_scan_number(const char *, int, LONGEST *, int *)
bool ada_is_character_type(struct type *)
Definition ada-lang.c:8982
struct value * ada_value_primitive_field(struct value *arg1, int offset, int fieldno, struct type *arg_type)
Definition ada-lang.c:6924
void ada_fixup_array_indexes_type(struct type *index_desc_type)
Definition ada-lang.c:1668
int ada_is_modular_type(struct type *)
Definition ada-lang.c:11557
gdb::function_view< void(struct ada_task_info *task)> ada_task_list_iterator_ftype
Definition ada-lang.h:378
gdb::unique_xmalloc_ptr< char > ada_tag_name(struct value *)
Definition ada-lang.c:6631
int ada_is_simple_array_type(struct type *)
Definition ada-lang.c:2054
ada_exception_catchpoint_kind
Definition ada-lang.h:107
@ ada_catch_exception
Definition ada-lang.h:108
@ ada_catch_exception_unhandled
Definition ada-lang.h:109
@ ada_catch_handlers
Definition ada-lang.h:111
@ ada_catch_assert
Definition ada-lang.h:110
struct value * ada_to_fixed_value(struct value *val)
Definition ada-lang.c:8874
int ada_parse(struct parser_state *)
Definition ada-exp.c:3064
int ada_is_array_descriptor_type(struct type *)
Definition ada-lang.c:2068
struct value * ada_coerce_to_simple_array(struct value *)
Definition ada-lang.c:2206
exp_opcode
Definition expression.h:44
static gdbpy_ref field_name(struct type *type, int field)
Definition py-type.c:234
static struct symbol * new_symbol(struct die_info *, struct type *, struct dwarf2_cu *, struct symbol *=NULL)
Definition read.c:20766
CORE_ADDR addr
Definition ada-lang.h:361
bool operator<(const ada_exc_info &) const
Definition ada-lang.c:12977
const char * name
Definition ada-lang.h:358
bool operator==(const ada_exc_info &) const
Definition ada-lang.c:12990
const char * decoded
Definition ada-lang.h:73
enum exp_opcode op
Definition ada-lang.h:74
const char * encoded
Definition ada-lang.h:72
CORE_ADDR task_id
Definition ada-lang.h:123
char name[257]
Definition ada-lang.h:126
CORE_ADDR caller_task
Definition ada-lang.h:143
CORE_ADDR called_task
Definition ada-lang.h:139
ptid_t ptid
Definition ada-lang.h:120
CORE_ADDR parent
Definition ada-lang.h:135
Definition block.h:109
Definition gnu-nat.c:154
Definition value.c:181
LONGEST offset
Definition value.c:281
domain_enum
Definition symtab.h:871