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
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 LONGEST ada_discrete_type_low_bound (struct type *);
206
207extern LONGEST ada_discrete_type_high_bound (struct type *);
208
209extern struct value *ada_get_decoded_value (struct value *value);
210
211extern struct type *ada_get_decoded_type (struct type *type);
212
213extern const char *ada_decode_symbol (const struct general_symbol_info *);
214
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
219 will be returned. Also, when OPERATORS is false, operator names
220 will not be decoded. */
221extern std::string ada_decode (const char *name, bool wrap = true,
222 bool operators = true);
223
224extern std::vector<struct block_symbol> ada_lookup_symbol_list
225 (const char *, const struct block *, domain_enum);
226
227extern struct block_symbol ada_lookup_symbol (const char *,
228 const struct block *,
230
232 (const char *name, const struct block *block, domain_enum domain,
233 struct block_symbol *symbol_info);
234
235extern struct bound_minimal_symbol ada_lookup_simple_minsym (const char *,
236 objfile *);
237
238extern int ada_scan_number (const char *, int, LONGEST *, int *);
239
240extern struct value *ada_value_primitive_field (struct value *arg1,
241 int offset,
242 int fieldno,
243 struct type *arg_type);
244
245extern struct type *ada_parent_type (struct type *);
246
247extern int ada_is_ignored_field (struct type *, int);
248
249extern int ada_is_constrained_packed_array_type (struct type *);
250
251extern struct value *ada_value_primitive_packed_val (struct value *,
252 const gdb_byte *,
253 long, int, int,
254 struct type *);
255
256extern struct type *ada_coerce_to_simple_array_type (struct type *);
257
258extern bool ada_is_character_type (struct type *);
259
260extern bool ada_is_string_type (struct type *);
261
262extern int ada_is_tagged_type (struct type *, int);
263
264extern int ada_is_tag_type (struct type *);
265
266extern gdb::unique_xmalloc_ptr<char> ada_tag_name (struct value *);
267
268extern struct value *ada_tag_value_at_base_address (struct value *obj);
269
270extern int ada_is_parent_field (struct type *, int);
271
272extern int ada_is_wrapper_field (struct type *, int);
273
274extern int ada_is_variant_part (struct type *, int);
275
276extern struct type *ada_variant_discrim_type (struct type *, struct type *);
277
278extern const char *ada_variant_discrim_name (struct type *);
279
280extern int ada_is_aligner_type (struct type *);
281
282extern struct type *ada_aligned_type (struct type *);
283
284extern const gdb_byte *ada_aligned_value_addr (struct type *,
285 const gdb_byte *);
286
287extern int ada_is_system_address_type (struct type *);
288
289extern int ada_which_variant_applies (struct type *, struct value *);
290
291extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
292 CORE_ADDR, struct value *,
293 int check_tag);
294
295extern struct value *ada_to_fixed_value (struct value *val);
296
297extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
298 const gdb_byte *valaddr,
299 CORE_ADDR address,
300 struct value *dval0,
301 int keep_dynamic_fields);
302
303extern int ada_name_prefix_len (const char *);
304
305extern const char *ada_type_name (struct type *);
306
307extern struct type *ada_find_parallel_type (struct type *,
308 const char *suffix);
309
310extern bool get_int_var_value (const char *, LONGEST &value);
311
312extern int ada_prefer_type (struct type *, struct type *);
313
314extern struct type *ada_get_base_type (struct type *);
315
316extern struct type *ada_check_typedef (struct type *);
317
318extern std::string ada_encode (const char *, bool fold = true);
319
320extern const char *ada_enum_name (const char *);
321
322extern int ada_is_modular_type (struct type *);
323
324extern ULONGEST ada_modulus (struct type *);
325
326extern struct value *ada_value_ind (struct value *);
327
328extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
329
330extern int ada_is_range_type_name (const char *);
331
333 const char **,
334 int *, const char **);
335
337
338extern const char *ada_main_name ();
339
341 (struct gdbarch *gdbarch, enum ada_exception_catchpoint_kind ex_kind,
342 std::string &&excep_string, const std::string &cond_string, int tempflag,
343 int enabled, int from_tty);
344
345/* Return true if BP is an Ada catchpoint. */
346
348
349/* Some information about a given Ada exception. */
350
352{
353 /* The name of the exception. */
354 const char *name;
355
356 /* The address of the symbol corresponding to that exception. */
357 CORE_ADDR addr;
358
359 bool operator< (const ada_exc_info &) const;
360 bool operator== (const ada_exc_info &) const;
361};
362
363extern std::vector<ada_exc_info> ada_exceptions_list (const char *regexp);
364
365/* Tasking-related: ada-tasks.c */
366
367extern int valid_task_id (int);
368
369extern struct ada_task_info *ada_get_task_info_from_ptid (ptid_t ptid);
370
371extern int ada_get_task_number (thread_info *thread);
372
373typedef gdb::function_view<void (struct ada_task_info *task)>
377
378extern const char *ada_get_tcb_types_info (void);
379
380extern void print_ada_task_info (struct ui_out *uiout,
381 const char *taskno_str,
382 struct inferior *inf);
383
384/* Look for a symbol for an overloaded operator for the operation OP.
385 PARSE_COMPLETION is true if currently parsing for completion.
386 NARGS and ARGVEC describe the arguments to the call. Returns a
387 "null" block_symbol if no such operator is found. */
388
390 bool parse_completion,
391 int nargs, value *argvec[]);
392
393/* Resolve a function call, selecting among possible function symbols.
394 SYM and BLOCK are passed to ada_lookup_symbol_list. CONTEXT_TYPE
395 describes the calling context. PARSE_COMPLETION is true if
396 currently parsing for completion. NARGS and ARGVEC describe the
397 arguments to the call. This returns the chosen symbol and will
398 update TRACKER accordingly. */
399
400extern block_symbol ada_resolve_funcall (struct symbol *sym,
401 const struct block *block,
402 struct type *context_type,
403 bool parse_completion,
404 int nargs, value *argvec[],
405 innermost_block_tracker *tracker);
406
407/* Resolve a symbol reference, selecting among possible values. SYM
408 and BLOCK are passed to ada_lookup_symbol_list. CONTEXT_TYPE
409 describes the calling context. PARSE_COMPLETION is true if
410 currently parsing for completion. If DEPROCEDURE_P is nonzero,
411 then a symbol that names a zero-argument function will be passed
412 through ada_resolve_function. This returns the chosen symbol and
413 will update TRACKER accordingly. */
414
415extern block_symbol ada_resolve_variable (struct symbol *sym,
416 const struct block *block,
417 struct type *context_type,
418 bool parse_completion,
419 int deprocedure_p,
420 innermost_block_tracker *tracker);
421
422/* The type of nth index in arrays of given type (n numbering from 1).
423 Does not examine memory. Throws an error if N is invalid or TYPE
424 is not an array type. NAME is the name of the Ada attribute being
425 evaluated ('range, 'first, 'last, or 'length); it is used in building
426 the error message. */
427extern struct type *ada_index_type (struct type *type, int n,
428 const char *name);
429
430#endif
const char *const name
bool is_ada_exception_catchpoint(breakpoint *bp)
Definition ada-lang.c:12502
LONGEST ada_discrete_type_low_bound(struct type *)
Definition ada-lang.c:707
struct type * ada_parent_type(struct type *)
Definition ada-lang.c:6645
const char * ada_variant_discrim_name(struct type *)
Definition ada-lang.c:6763
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:7364
struct value * ada_value_subscript(struct value *, int, struct value **)
Definition ada-lang.c:2997
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:11517
struct value * ada_get_decoded_value(struct value *value)
Definition ada-lang.c:761
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 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:6339
std::vector< struct block_symbol > ada_lookup_symbol_list(const char *, const struct block *, domain_enum)
Definition ada-lang.c:5759
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:2758
void ada_printchar(int, struct type *, struct ui_file *)
gdb::function_view< void(struct ada_task_info *task) ada_task_list_iterator_ftype)
Definition ada-lang.h:374
std::string ada_decode(const char *name, bool wrap=true, bool operators=true)
Definition ada-lang.c:1311
LONGEST ada_discrete_type_high_bound(struct type *)
Definition ada-lang.c:672
bool ada_is_access_to_unconstrained_array(struct type *type)
Definition ada-lang.c:2986
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:4906
const char * ada_decode_symbol(const struct general_symbol_info *)
Definition ada-lang.c:1619
int ada_is_system_address_type(struct type *)
Definition ada-lang.c:11318
struct block_symbol ada_lookup_symbol(const char *, const struct block *, domain_enum)
Definition ada-lang.c:5798
struct type * ada_get_base_type(struct type *)
Definition ada-lang.c:8972
int ada_name_prefix_len(const char *)
Definition ada-lang.c:521
struct type * ada_to_fixed_type(struct type *, const gdb_byte *, CORE_ADDR, struct value *, int check_tag)
Definition ada-lang.c:8598
struct type * ada_variant_discrim_type(struct type *, struct type *)
Definition ada-lang.c:6739
int ada_is_ignored_field(struct type *, int)
Definition ada-lang.c:6278
const char * ada_type_name(struct type *)
Definition ada-lang.c:7578
struct type * ada_find_parallel_type(struct type *, const char *suffix)
Definition ada-lang.c:7666
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:11850
void create_ada_exception_catchpoint(struct gdbarch *gdbarch, enum ada_exception_catchpoint_kind ex_kind, std::string &&excep_string, const std::string &cond_string, int tempflag, int enabled, int from_tty)
Definition ada-lang.c:12717
struct type * ada_coerce_to_simple_array_type(struct type *)
Definition ada-lang.c:2225
int ada_is_tagged_type(struct type *, int)
Definition ada-lang.c:6331
std::vector< ada_exc_info > ada_exceptions_list(const char *regexp)
Definition ada-lang.c:13143
enum ada_renaming_category ada_parse_renaming(struct symbol *, const char **, int *, const char **)
Definition ada-lang.c:4301
bool ada_is_string_type(struct type *)
Definition ada-lang.c:8923
struct value * ada_coerce_to_simple_array_ptr(struct value *)
Definition ada-lang.c:2183
struct value * ada_value_ind(struct value *)
Definition ada-lang.c:7434
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:786
const char * ada_main_name()
Definition ada-lang.c:803
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:9033
const char * ada_enum_name(const char *)
Definition ada-lang.c:9048
struct type * ada_check_typedef(struct type *)
Definition ada-lang.c:8704
struct value * ada_tag_value_at_base_address(struct value *obj)
Definition ada-lang.c:6425
struct value * ada_convert_actual(struct value *actual, struct type *formal_type0)
Definition ada-lang.c:4533
std::string ada_encode(const char *, bool fold=true)
Definition ada-lang.c:1155
int ada_is_constrained_packed_array_type(struct type *)
Definition ada-lang.c:2254
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:3834
int ada_array_arity(struct type *)
Definition ada-lang.c:3158
int ada_is_variant_part(struct type *, int)
Definition ada-lang.c:6719
bool get_int_var_value(const char *, LONGEST &value)
Definition ada-lang.c:11403
void ada_lookup_encoded_symbol(const char *name, const struct block *block, domain_enum domain, struct block_symbol *symbol_info)
Definition ada-lang.c:5776
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:7771
struct type * ada_aligned_type(struct type *)
Definition ada-lang.c:9020
int ada_prefer_type(struct type *, struct type *)
Definition ada-lang.c:7545
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:6692
int valid_task_id(int)
Definition ada-tasks.c:370
int ada_is_parent_field(struct type *, int)
Definition ada-lang.c:6676
int ada_is_aligner_type(struct type *)
Definition ada-lang.c:8956
ULONGEST ada_modulus(struct type *)
Definition ada-lang.c:11540
int ada_get_field_index(const struct type *type, const char *field_name, int maybe_missing)
Definition ada-lang.c:501
const struct ada_opname_map ada_opname_table[]
Definition ada-lang.c:841
int ada_scan_number(const char *, int, LONGEST *, int *)
bool ada_is_character_type(struct type *)
Definition ada-lang.c:8899
struct value * ada_value_primitive_field(struct value *arg1, int offset, int fieldno, struct type *arg_type)
Definition ada-lang.c:6905
void ada_fixup_array_indexes_type(struct type *index_desc_type)
Definition ada-lang.c:1681
int ada_is_modular_type(struct type *)
Definition ada-lang.c:11528
gdb::unique_xmalloc_ptr< char > ada_tag_name(struct value *)
Definition ada-lang.c:6612
int ada_is_simple_array_type(struct type *)
Definition ada-lang.c:2067
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:8773
int ada_parse(struct parser_state *)
Definition ada-exp.c:3133
int ada_is_array_descriptor_type(struct type *)
Definition ada-lang.c:2081
struct value * ada_coerce_to_simple_array(struct value *)
Definition ada-lang.c:2204
exp_opcode
Definition expression.h:45
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:18978
CORE_ADDR addr
Definition ada-lang.h:357
bool operator<(const ada_exc_info &) const
Definition ada-lang.c:12894
const char * name
Definition ada-lang.h:354
bool operator==(const ada_exc_info &) const
Definition ada-lang.c:12907
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:153
Definition value.h:130
LONGEST offset() const
Definition value.h:222
domain_enum
Definition symtab.h:900