1 /* Ada language support definitions for GDB, the GNU debugger.
2 
3    Copyright 1992, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4    2005 Free Software Foundation, Inc.
5 
6 This file is part of GDB.
7 
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
12 
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 GNU General Public License for more details.
17 
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
21 
22 #if !defined (ADA_LANG_H)
23 #define ADA_LANG_H 1
24 
25 struct partial_symbol;
26 struct frame_info;
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(__alpha__) && defined(__osf__)
37 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
38    "^[agis]-.*\\.ad[bs]$", \
39    "/usr/shlib/libpthread\\.so",
40 #elif defined (__linux__)
41 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
42    "^[agis]-.*\\.ad[bs]$", \
43    "/lib.*/libpthread\\.so[.0-9]*$", "/lib.*/libpthread\\.a$", \
44    "/lib.*/libc\\.so[.0-9]*$", "/lib.*/libc\\.a$",
45 #endif
46 
47 #if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS)
48 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
49    "^[agis]-.*\\.ad[bs]$",
50 #endif
51 
52 /* Names of compiler-generated auxiliary functions probably of no
53    interest to users. Each name (a basic regular expression string)
54    is followed by a comma. */
55 #define ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS \
56    "___clean[.a-zA-Z0-9_]*$",
57 
58 /* The maximum number of frame levels searched for non-local,
59  * non-global symbols.  This limit exists as a precaution to prevent
60  * infinite search loops when the stack is screwed up. */
61 #define MAX_ENCLOSING_FRAME_LEVELS 7
62 
63 /* Maximum number of steps followed in looking for the ultimate
64    referent of a renaming.  This prevents certain infinite loops that
65    can otherwise result. */
66 #define MAX_RENAMING_CHAIN_LENGTH 10
67 
68 struct block;
69 
70 /* Corresponding encoded/decoded names and opcodes for Ada user-definable
71    operators. */
72 struct ada_opname_map
73 {
74   const char *encoded;
75   const char *decoded;
76   enum exp_opcode op;
77 };
78 
79 /* Table of Ada operators in encoded and decoded forms. */
80 /* Defined in ada-lang.c */
81 extern const struct ada_opname_map ada_opname_table[];
82 
83 enum ada_operator
84   {
85     /* X IN A'RANGE(N).  N is an immediate operand, surrounded by
86        BINOP_IN_BOUNDS before and after.  A is an array, X an index
87        value.  Evaluates to true iff X is within range of the Nth
88        dimension (1-based) of A.  (A multi-dimensional array
89        type is represented as array of array of ...) */
90     BINOP_IN_BOUNDS = OP_EXTENDED0,
91 
92     /* X IN L .. U.  True iff L <= X <= U.  */
93     TERNOP_IN_RANGE,
94 
95     /* Ada attributes ('Foo). */
96     OP_ATR_FIRST,
97     OP_ATR_LAST,
98     OP_ATR_LENGTH,
99     OP_ATR_IMAGE,
100     OP_ATR_MAX,
101     OP_ATR_MIN,
102     OP_ATR_MODULUS,
103     OP_ATR_POS,
104     OP_ATR_SIZE,
105     OP_ATR_TAG,
106     OP_ATR_VAL,
107 
108     /* Ada type qualification.  It is encoded as for UNOP_CAST, above,
109        and denotes the TYPE'(EXPR) construct. */
110     UNOP_QUAL,
111 
112     /* X IN TYPE.  The `TYPE' argument is immediate, with
113        UNOP_IN_RANGE before and after it. True iff X is a member of
114        type TYPE (typically a subrange). */
115     UNOP_IN_RANGE,
116 
117     /* End marker */
118     OP_ADA_LAST
119   };
120 
121 /* A triple, (symbol, block, symtab), representing one instance of a
122  * symbol-lookup operation. */
123 struct ada_symbol_info {
124   struct symbol* sym;
125   struct block* block;
126   struct symtab* symtab;
127 };
128 
129 /* Ada task structures.  */
130 
131 /* Ada task control block, as defined in the GNAT runt-time library.  */
132 
133 struct task_control_block
134 {
135   char state;
136   CORE_ADDR parent;
137   int priority;
138   char image [32];
139   int image_len;    /* This field is not always present in the ATCB.  */
140   CORE_ADDR call;
141   CORE_ADDR thread;
142   CORE_ADDR lwp;    /* This field is not always present in the ATCB.  */
143 };
144 
145 struct task_ptid
146 {
147   int pid;                      /* The Process id */
148   long lwp;                     /* The Light Weight Process id */
149   long tid;                     /* The Thread id */
150 };
151 typedef struct task_ptid task_ptid_t;
152 
153 struct task_entry
154 {
155   CORE_ADDR task_id;
156   struct task_control_block atcb;
157   int task_num;
158   int known_tasks_index;
159   struct task_entry *next_task;
160   task_ptid_t task_ptid;
161   int stack_per;
162 };
163 
164 /* The maximum number of tasks known to the Ada runtime.  */
165 extern const int MAX_NUMBER_OF_KNOWN_TASKS;
166 
167 /* task entry list.  */
168 extern struct task_entry *task_list;
169 
170 
171 /* Assuming V points to an array of S objects,  make sure that it contains at
172    least M objects, updating V and S as necessary. */
173 
174 #define GROW_VECT(v, s, m)                                              \
175    if ((s) < (m)) (v) = grow_vect (v, &(s), m, sizeof *(v));
176 
177 extern void *grow_vect (void *, size_t *, size_t, int);
178 
179 extern int ada_get_field_index (const struct type *type,
180                                 const char *field_name,
181                                 int maybe_missing);
182 
183 extern int ada_parse (void);    /* Defined in ada-exp.y */
184 
185 extern void ada_error (char *); /* Defined in ada-exp.y */
186 
187                         /* Defined in ada-typeprint.c */
188 extern void ada_print_type (struct type *, char *, struct ui_file *, int,
189                             int);
190 
191 extern int ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
192                           struct ui_file *, int, int, int,
193                           enum val_prettyprint);
194 
195 extern int ada_value_print (struct value *, struct ui_file *, int,
196                             enum val_prettyprint);
197 
198                                 /* Defined in ada-lang.c */
199 
200 extern struct value *value_from_contents_and_address (struct type *,
201 						      const gdb_byte *,
202                                                       CORE_ADDR);
203 
204 extern void ada_emit_char (int, struct ui_file *, int, int);
205 
206 extern void ada_printchar (int, struct ui_file *);
207 
208 extern void ada_printstr (struct ui_file *, const gdb_byte *,
209 			  unsigned int, int, int);
210 
211 extern void ada_convert_actuals (struct value *, int, struct value **,
212                                  CORE_ADDR *);
213 
214 extern struct value *ada_value_subscript (struct value *, int,
215                                           struct value **);
216 
217 extern struct type *ada_array_element_type (struct type *, int);
218 
219 extern int ada_array_arity (struct type *);
220 
221 struct type *ada_type_of_array (struct value *, int);
222 
223 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
224 
225 extern int ada_is_simple_array_type (struct type *);
226 
227 extern int ada_is_array_descriptor_type (struct type *);
228 
229 extern int ada_is_bogus_array_descriptor (struct type *);
230 
231 extern struct type *ada_index_type (struct type *, int);
232 
233 extern struct value *ada_array_bound (struct value *, int, int);
234 
235 extern char *ada_decode_symbol (const struct general_symbol_info*);
236 
237 extern const char *ada_decode (const char*);
238 
239 extern enum language ada_update_initial_language (enum language,
240 						  struct partial_symtab*);
241 
242 extern void clear_ada_sym_cache (void);
243 
244 extern char **ada_make_symbol_completion_list (const char *text0,
245                                                const char *word);
246 
247 extern int ada_lookup_symbol_list (const char *, const struct block *,
248                                    domain_enum, struct ada_symbol_info**);
249 
250 extern char *ada_fold_name (const char *);
251 
252 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
253                                          domain_enum, int *,
254 					 struct symtab **);
255 
256 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
257 
258 extern void ada_fill_in_ada_prototype (struct symbol *);
259 
260 extern int user_select_syms (struct ada_symbol_info *, int, int);
261 
262 extern int get_selections (int *, int, int, int, char *);
263 
264 extern char *ada_start_decode_line_1 (char *);
265 
266 extern struct symtabs_and_lines ada_finish_decode_line_1 (char **,
267                                                           struct symtab *,
268                                                           int, char ***);
269 
270 extern struct symtabs_and_lines ada_sals_for_line (const char*, int,
271 						   int, char***, int);
272 
273 extern int ada_scan_number (const char *, int, LONGEST *, int *);
274 
275 extern struct type *ada_parent_type (struct type *);
276 
277 extern int ada_is_ignored_field (struct type *, int);
278 
279 extern int ada_is_packed_array_type (struct type *);
280 
281 extern struct value *ada_value_primitive_packed_val (struct value *,
282 						     const gdb_byte *,
283                                                      long, int, int,
284                                                      struct type *);
285 
286 extern struct type *ada_coerce_to_simple_array_type (struct type *);
287 
288 extern int ada_is_character_type (struct type *);
289 
290 extern int ada_is_string_type (struct type *);
291 
292 extern int ada_is_tagged_type (struct type *, int);
293 
294 extern int ada_is_tag_type (struct type *);
295 
296 extern struct type *ada_tag_type (struct value *);
297 
298 extern struct value *ada_value_tag (struct value *);
299 
300 extern const char *ada_tag_name (struct value *);
301 
302 extern int ada_is_parent_field (struct type *, int);
303 
304 extern int ada_is_wrapper_field (struct type *, int);
305 
306 extern int ada_is_variant_part (struct type *, int);
307 
308 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
309 
310 extern int ada_is_others_clause (struct type *, int);
311 
312 extern int ada_in_variant (LONGEST, struct type *, int);
313 
314 extern char *ada_variant_discrim_name (struct type *);
315 
316 extern struct value *ada_value_struct_elt (struct value *, char *, char *);
317 
318 extern int ada_is_aligner_type (struct type *);
319 
320 extern struct type *ada_aligned_type (struct type *);
321 
322 extern const gdb_byte *ada_aligned_value_addr (struct type *,
323 					       const gdb_byte *);
324 
325 extern const char *ada_attribute_name (enum exp_opcode);
326 
327 extern int ada_is_fixed_point_type (struct type *);
328 
329 extern int ada_is_system_address_type (struct type *);
330 
331 extern DOUBLEST ada_delta (struct type *);
332 
333 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
334 
335 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
336 
337 extern int ada_is_vax_floating_type (struct type *);
338 
339 extern int ada_vax_float_type_suffix (struct type *);
340 
341 extern struct value *ada_vax_float_print_function (struct type *);
342 
343 extern struct type *ada_system_address_type (void);
344 
345 extern int ada_which_variant_applies (struct type *, struct type *,
346 				      const gdb_byte *);
347 
348 extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
349 				       CORE_ADDR, struct value *);
350 
351 extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
352 							 const gdb_byte *valaddr,
353 							 CORE_ADDR address,
354 							 struct value *dval0,
355 							 int keep_dynamic_fields);
356 
357 extern int ada_name_prefix_len (const char *);
358 
359 extern char *ada_type_name (struct type *);
360 
361 extern struct type *ada_find_parallel_type (struct type *,
362                                             const char *suffix);
363 
364 extern LONGEST get_int_var_value (char *, int *);
365 
366 extern struct symbol *ada_find_any_symbol (const char *name);
367 
368 extern struct type *ada_find_any_type (const char *name);
369 
370 extern struct symbol *ada_find_renaming_symbol (const char *name,
371                                                 struct block *block);
372 
373 extern int ada_prefer_type (struct type *, struct type *);
374 
375 extern struct type *ada_get_base_type (struct type *);
376 
377 extern struct type *ada_check_typedef (struct type *);
378 
379 extern char *ada_encode (const char *);
380 
381 extern const char *ada_enum_name (const char *);
382 
383 extern int ada_is_modular_type (struct type *);
384 
385 extern ULONGEST ada_modulus (struct type *);
386 
387 extern struct value *ada_value_ind (struct value *);
388 
389 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
390 
391 extern int ada_is_range_type_name (const char *);
392 
393 extern const char *ada_renaming_type (struct type *);
394 
395 extern int ada_is_object_renaming (struct symbol *);
396 
397 extern char *ada_simple_renamed_entity (struct symbol *);
398 
399 extern char *ada_breakpoint_rewrite (char *, int *);
400 
401 extern char *ada_main_name (void);
402 
403 /* Tasking-related: ada-tasks.c */
404 
405 extern int valid_task_id (int);
406 
407 extern void init_task_list (void);
408 
409 extern int ada_is_exception_breakpoint (bpstat bs);
410 
411 extern void ada_adjust_exception_stop (bpstat bs);
412 
413 extern void ada_print_exception_stop (bpstat bs);
414 
415 extern int ada_get_current_task (ptid_t);
416 
417 extern int breakpoint_ada_task_match (CORE_ADDR, ptid_t);
418 
419 extern int ada_print_exception_breakpoint_nontask (struct breakpoint *);
420 
421 extern void ada_print_exception_breakpoint_task (struct breakpoint *);
422 
423 extern void ada_find_printable_frame (struct frame_info *fi);
424 
425 extern void ada_reset_thread_registers (void);
426 
427 extern int ada_build_task_list (void);
428 
429 /* Look up a symbol by name using the search conventions of
430    a specific language (optional block, optional symtab).
431    FIXME: Should be symtab.h. */
432 
433 extern struct symbol *lookup_symbol_in_language (const char *,
434 						 const struct block *,
435 						 domain_enum,
436 						 enum language,
437 						 int *,
438 						 struct symtab **);
439 #endif
440