xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/ada-lang.h (revision 82d56013d7b633d116a93943de88e08335357a7c)
1 /* Ada language support definitions for GDB, the GNU debugger.
2 
3    Copyright (C) 1992-2019 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 "common/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   ada_catch_handlers
113 };
114 
115 /* Ada task structures.  */
116 
117 struct ada_task_info
118 {
119   /* The PTID of the thread that this task runs on.  This ptid is computed
120      in a target-dependent way from the associated Task Control Block.  */
121   ptid_t ptid;
122 
123   /* The ID of the task.  */
124   CORE_ADDR task_id;
125 
126   /* The name of the task.  */
127   char name[257];
128 
129   /* The current state of the task.  */
130   int state;
131 
132   /* The priority associated to the task.  */
133   int priority;
134 
135   /* If non-zero, the task ID of the parent task.  */
136   CORE_ADDR parent;
137 
138   /* If the task is waiting on a task entry, this field contains
139      the ID of the other task.  Zero otherwise.  */
140   CORE_ADDR called_task;
141 
142   /* If the task is accepting a rendezvous with another task, this field
143      contains the ID of the calling task.  Zero otherwise.  */
144   CORE_ADDR caller_task;
145 
146   /* The CPU on which the task is running.  This is dependent on
147      the runtime actually providing that info, which is not always
148      the case.  Normally, we should be able to count on it on
149      bare-metal targets.  */
150   int base_cpu;
151 };
152 
153 /* Assuming V points to an array of S objects,  make sure that it contains at
154    least M objects, updating V and S as necessary.  */
155 
156 #define GROW_VECT(v, s, m)                                    \
157    if ((s) < (m)) (v) = (char *) grow_vect (v, &(s), m, sizeof *(v));
158 
159 extern void *grow_vect (void *, size_t *, size_t, int);
160 
161 extern void ada_ensure_varsize_limit (const struct type *type);
162 
163 extern int ada_get_field_index (const struct type *type,
164                                 const char *field_name,
165                                 int maybe_missing);
166 
167 extern int ada_parse (struct parser_state *);    /* Defined in ada-exp.y */
168 
169                         /* Defined in ada-typeprint.c */
170 extern void ada_print_type (struct type *, const char *, struct ui_file *, int,
171                             int, const struct type_print_options *);
172 
173 extern void ada_print_typedef (struct type *type, struct symbol *new_symbol,
174 			       struct ui_file *stream);
175 
176 extern void ada_val_print (struct type *, int, CORE_ADDR,
177 			   struct ui_file *, int,
178 			   struct value *,
179 			   const struct value_print_options *);
180 
181 extern void ada_value_print (struct value *, struct ui_file *,
182 			     const struct value_print_options *);
183 
184                                 /* Defined in ada-lang.c */
185 
186 extern void ada_emit_char (int, struct type *, struct ui_file *, int, int);
187 
188 extern void ada_printchar (int, struct type *, struct ui_file *);
189 
190 extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *,
191 			  unsigned int, const char *, int,
192 			  const struct value_print_options *);
193 
194 struct value *ada_convert_actual (struct value *actual,
195                                   struct type *formal_type0);
196 
197 extern bool ada_is_access_to_unconstrained_array (struct type *type);
198 
199 extern struct value *ada_value_subscript (struct value *, int,
200                                           struct value **);
201 
202 extern void ada_fixup_array_indexes_type (struct type *index_desc_type);
203 
204 extern struct type *ada_array_element_type (struct type *, int);
205 
206 extern int ada_array_arity (struct type *);
207 
208 struct type *ada_type_of_array (struct value *, int);
209 
210 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
211 
212 struct value *ada_coerce_to_simple_array (struct value *);
213 
214 extern int ada_is_simple_array_type (struct type *);
215 
216 extern int ada_is_array_descriptor_type (struct type *);
217 
218 extern int ada_is_bogus_array_descriptor (struct type *);
219 
220 extern LONGEST ada_discrete_type_low_bound (struct type *);
221 
222 extern LONGEST ada_discrete_type_high_bound (struct type *);
223 
224 extern struct value *ada_get_decoded_value (struct value *value);
225 
226 extern struct type *ada_get_decoded_type (struct type *type);
227 
228 extern const char *ada_decode_symbol (const struct general_symbol_info *);
229 
230 extern const char *ada_decode (const char*);
231 
232 extern enum language ada_update_initial_language (enum language);
233 
234 extern int ada_lookup_symbol_list (const char *, const struct block *,
235                                    domain_enum,
236 				   std::vector<struct block_symbol> *);
237 
238 extern char *ada_fold_name (const char *);
239 
240 extern struct block_symbol ada_lookup_symbol (const char *,
241 					      const struct block *,
242 					      domain_enum, int *);
243 
244 extern void ada_lookup_encoded_symbol
245   (const char *name, const struct block *block, domain_enum domain,
246    struct block_symbol *symbol_info);
247 
248 extern struct bound_minimal_symbol ada_lookup_simple_minsym (const char *);
249 
250 extern void ada_fill_in_ada_prototype (struct symbol *);
251 
252 extern int user_select_syms (struct block_symbol *, int, int);
253 
254 extern int get_selections (int *, int, int, int, const char *);
255 
256 extern int ada_scan_number (const char *, int, LONGEST *, int *);
257 
258 extern struct type *ada_parent_type (struct type *);
259 
260 extern int ada_is_ignored_field (struct type *, int);
261 
262 extern int ada_is_constrained_packed_array_type (struct type *);
263 
264 extern struct value *ada_value_primitive_packed_val (struct value *,
265 						     const gdb_byte *,
266                                                      long, int, int,
267                                                      struct type *);
268 
269 extern struct type *ada_coerce_to_simple_array_type (struct type *);
270 
271 extern int ada_is_character_type (struct type *);
272 
273 extern int ada_is_string_type (struct type *);
274 
275 extern int ada_is_tagged_type (struct type *, int);
276 
277 extern int ada_is_tag_type (struct type *);
278 
279 extern struct type *ada_tag_type (struct value *);
280 
281 extern struct value *ada_value_tag (struct value *);
282 
283 extern const char *ada_tag_name (struct value *);
284 
285 extern struct value *ada_tag_value_at_base_address (struct value *obj);
286 
287 extern int ada_is_parent_field (struct type *, int);
288 
289 extern int ada_is_wrapper_field (struct type *, int);
290 
291 extern int ada_is_variant_part (struct type *, int);
292 
293 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
294 
295 extern int ada_is_others_clause (struct type *, int);
296 
297 extern int ada_in_variant (LONGEST, struct type *, int);
298 
299 extern const char *ada_variant_discrim_name (struct type *);
300 
301 extern struct value *ada_value_struct_elt (struct value *, const char *, int);
302 
303 extern int ada_is_aligner_type (struct type *);
304 
305 extern struct type *ada_aligned_type (struct type *);
306 
307 extern const gdb_byte *ada_aligned_value_addr (struct type *,
308 					       const gdb_byte *);
309 
310 extern const char *ada_attribute_name (enum exp_opcode);
311 
312 extern int ada_is_fixed_point_type (struct type *);
313 
314 extern int ada_is_system_address_type (struct type *);
315 
316 extern struct value *ada_delta (struct type *);
317 
318 extern struct value *ada_scaling_factor (struct type *);
319 
320 extern struct type *ada_system_address_type (void);
321 
322 extern int ada_which_variant_applies (struct type *, struct type *,
323 				      const gdb_byte *);
324 
325 extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
326 				       CORE_ADDR, struct value *,
327                                        int check_tag);
328 
329 extern struct value *ada_to_fixed_value (struct value *val);
330 
331 extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
332 							 const gdb_byte *valaddr,
333 							 CORE_ADDR address,
334 							 struct value *dval0,
335 							 int keep_dynamic_fields);
336 
337 extern int ada_name_prefix_len (const char *);
338 
339 extern const char *ada_type_name (struct type *);
340 
341 extern struct type *ada_find_parallel_type (struct type *,
342                                             const char *suffix);
343 
344 extern bool get_int_var_value (const char *, LONGEST &value);
345 
346 extern struct symbol *ada_find_renaming_symbol (struct symbol *name_sym,
347                                                 const struct block *block);
348 
349 extern int ada_prefer_type (struct type *, struct type *);
350 
351 extern struct type *ada_get_base_type (struct type *);
352 
353 extern struct type *ada_check_typedef (struct type *);
354 
355 extern char *ada_encode (const char *);
356 
357 extern const char *ada_enum_name (const char *);
358 
359 extern int ada_is_modular_type (struct type *);
360 
361 extern ULONGEST ada_modulus (struct type *);
362 
363 extern struct value *ada_value_ind (struct value *);
364 
365 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
366 
367 extern int ada_is_range_type_name (const char *);
368 
369 extern enum ada_renaming_category ada_parse_renaming (struct symbol *,
370 						      const char **,
371 						      int *, const char **);
372 
373 extern void ada_find_printable_frame (struct frame_info *fi);
374 
375 extern char *ada_breakpoint_rewrite (char *, int *);
376 
377 extern char *ada_main_name (void);
378 
379 extern void create_ada_exception_catchpoint
380   (struct gdbarch *gdbarch, enum ada_exception_catchpoint_kind ex_kind,
381    const std::string &excep_string, const std::string &cond_string, int tempflag,
382    int disabled, 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 (thread_info *thread);
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 void print_ada_task_info (struct ui_out *uiout,
415 				 char *taskno_str,
416 				 struct inferior *inf);
417 
418 #endif
419