gdb/ada-lang.h

   1 /* Ada language support definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 1992-2015 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 "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 /* A tuple representing one instance of a symbol-lookup operation.  */
  83
  84 struct ada_symbol_info
  85 {
  86   /* The symbol that was found.  */
  87   struct symbol *sym;
  88
  89   /* The block where the symbol was found.  */
  90   const struct block *block;
  91 };
  92
  93 /* Denotes a type of renaming symbol (see ada_parse_renaming).  */
  94 enum ada_renaming_category
  95   {
  96     /* Indicates a symbol that does not encode a renaming.  */
  97     ADA_NOT_RENAMING,
  98
  99     /* For symbols declared
 100          Foo : TYPE renamed OBJECT;  */
 101     ADA_OBJECT_RENAMING,
 102
 103     /* For symbols declared
 104          Foo : exception renames EXCEPTION;  */
 105     ADA_EXCEPTION_RENAMING,
 106     /* For packages declared
 107           package Foo renames PACKAGE; */
 108     ADA_PACKAGE_RENAMING,
 109     /* For subprograms declared
 110           SUBPROGRAM_SPEC renames SUBPROGRAM;
 111        (Currently not used).  */
 112     ADA_SUBPROGRAM_RENAMING
 113   };
 114
 115 /* The different types of catchpoints that we introduced for catching
 116    Ada exceptions.  */
 117
 118 enum ada_exception_catchpoint_kind
 119 {
 120   ada_catch_exception,
 121   ada_catch_exception_unhandled,
 122   ada_catch_assert
 123 };
 124
 125 /* Ada task structures.  */
 126
 127 struct ada_task_info
 128 {
 129   /* The PTID of the thread that this task runs on.  This ptid is computed
 130      in a target-dependent way from the associated Task Control Block.  */
 131   ptid_t ptid;
 132
 133   /* The ID of the task.  */
 134   CORE_ADDR task_id;
 135
 136   /* The name of the task.  */
 137   char name[257];
 138
 139   /* The current state of the task.  */
 140   int state;
 141
 142   /* The priority associated to the task.  */
 143   int priority;
 144
 145   /* If non-zero, the task ID of the parent task.  */
 146   CORE_ADDR parent;
 147
 148   /* If the task is waiting on a task entry, this field contains
 149      the ID of the other task.  Zero otherwise.  */
 150   CORE_ADDR called_task;
 151
 152   /* If the task is accepting a rendezvous with another task, this field
 153      contains the ID of the calling task.  Zero otherwise.  */
 154   CORE_ADDR caller_task;
 155 };
 156
 157 /* Assuming V points to an array of S objects,  make sure that it contains at
 158    least M objects, updating V and S as necessary.  */
 159
 160 #define GROW_VECT(v, s, m)                                    \
 161    if ((s) < (m)) (v) = grow_vect (v, &(s), m, sizeof *(v));
 162
 163 extern void *grow_vect (void *, size_t *, size_t, int);
 164
 165 extern void ada_ensure_varsize_limit (const struct type *type);
 166
 167 extern int ada_get_field_index (const struct type *type,
 168                                 const char *field_name,
 169                                 int maybe_missing);
 170
 171 extern int ada_parse (struct parser_state *);    /* Defined in ada-exp.y */
 172
 173 extern void ada_error (char *); /* Defined in ada-exp.y */
 174
 175                         /* Defined in ada-typeprint.c */
 176 extern void ada_print_type (struct type *, const char *, struct ui_file *, int,
 177                             int, const struct type_print_options *);
 178
 179 extern void ada_print_typedef (struct type *type, struct symbol *new_symbol,
 180                                struct ui_file *stream);
 181
 182 extern void ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
 183                            struct ui_file *, int,
 184                            const struct value *,
 185                            const struct value_print_options *);
 186
 187 extern void ada_value_print (struct value *, struct ui_file *,
 188                              const struct value_print_options *);
 189
 190                                 /* Defined in ada-lang.c */
 191
 192 extern void ada_emit_char (int, struct type *, struct ui_file *, int, int);
 193
 194 extern void ada_printchar (int, struct type *, struct ui_file *);
 195
 196 extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *,
 197                           unsigned int, const char *, int,
 198                           const struct value_print_options *);
 199
 200 struct value *ada_convert_actual (struct value *actual,
 201                                   struct type *formal_type0);
 202
 203 extern struct value *ada_value_subscript (struct value *, int,
 204                                           struct value **);
 205
 206 extern void ada_fixup_array_indexes_type (struct type *index_desc_type);
 207
 208 extern struct type *ada_array_element_type (struct type *, int);
 209
 210 extern int ada_array_arity (struct type *);
 211
 212 struct type *ada_type_of_array (struct value *, int);
 213
 214 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
 215
 216 struct value *ada_coerce_to_simple_array (struct value *);
 217
 218 extern int ada_is_simple_array_type (struct type *);
 219
 220 extern int ada_is_array_descriptor_type (struct type *);
 221
 222 extern int ada_is_bogus_array_descriptor (struct type *);
 223
 224 extern LONGEST ada_discrete_type_low_bound (struct type *);
 225
 226 extern LONGEST ada_discrete_type_high_bound (struct type *);
 227
 228 extern struct value *ada_get_decoded_value (struct value *value);
 229
 230 extern struct type *ada_get_decoded_type (struct type *type);
 231
 232 extern const char *ada_decode_symbol (const struct general_symbol_info *);
 233
 234 extern const char *ada_decode (const char*);
 235
 236 extern enum language ada_update_initial_language (enum language);
 237
 238 extern int ada_lookup_symbol_list (const char *, const struct block *,
 239                                    domain_enum, struct ada_symbol_info**);
 240
 241 extern char *ada_fold_name (const char *);
 242
 243 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
 244                                          domain_enum, int *);
 245
 246 extern void ada_lookup_encoded_symbol
 247   (const char *name, const struct block *block, domain_enum domain,
 248    struct ada_symbol_info *symbol_info);
 249
 250 extern struct bound_minimal_symbol ada_lookup_simple_minsym (const char *);
 251
 252 extern void ada_fill_in_ada_prototype (struct symbol *);
 253
 254 extern int user_select_syms (struct ada_symbol_info *, int, int);
 255
 256 extern int get_selections (int *, int, int, int, char *);
 257
 258 extern int ada_scan_number (const char *, int, LONGEST *, int *);
 259
 260 extern struct type *ada_parent_type (struct type *);
 261
 262 extern int ada_is_ignored_field (struct type *, int);
 263
 264 extern int ada_is_constrained_packed_array_type (struct type *);
 265
 266 extern struct value *ada_value_primitive_packed_val (struct value *,
 267                                                      const gdb_byte *,
 268                                                      long, int, int,
 269                                                      struct type *);
 270
 271 extern struct type *ada_coerce_to_simple_array_type (struct type *);
 272
 273 extern int ada_is_character_type (struct type *);
 274
 275 extern int ada_is_string_type (struct type *);
 276
 277 extern int ada_is_tagged_type (struct type *, int);
 278
 279 extern int ada_is_tag_type (struct type *);
 280
 281 extern struct type *ada_tag_type (struct value *);
 282
 283 extern struct value *ada_value_tag (struct value *);
 284
 285 extern const char *ada_tag_name (struct value *);
 286
 287 extern struct value *ada_tag_value_at_base_address (struct value *obj);
 288
 289 extern int ada_is_parent_field (struct type *, int);
 290
 291 extern int ada_is_wrapper_field (struct type *, int);
 292
 293 extern int ada_is_variant_part (struct type *, int);
 294
 295 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
 296
 297 extern int ada_is_others_clause (struct type *, int);
 298
 299 extern int ada_in_variant (LONGEST, struct type *, int);
 300
 301 extern char *ada_variant_discrim_name (struct type *);
 302
 303 extern struct value *ada_value_struct_elt (struct value *, char *, int);
 304
 305 extern int ada_is_aligner_type (struct type *);
 306
 307 extern struct type *ada_aligned_type (struct type *);
 308
 309 extern const gdb_byte *ada_aligned_value_addr (struct type *,
 310                                                const gdb_byte *);
 311
 312 extern const char *ada_attribute_name (enum exp_opcode);
 313
 314 extern int ada_is_fixed_point_type (struct type *);
 315
 316 extern int ada_is_system_address_type (struct type *);
 317
 318 extern DOUBLEST ada_delta (struct type *);
 319
 320 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
 321
 322 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
 323
 324 extern struct type *ada_system_address_type (void);
 325
 326 extern int ada_which_variant_applies (struct type *, struct type *,
 327                                       const gdb_byte *);
 328
 329 extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
 330                                        CORE_ADDR, struct value *,
 331                                        int check_tag);
 332
 333 extern struct value *ada_to_fixed_value (struct value *val);
 334
 335 extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
 336                                                          const gdb_byte *valaddr,
 337                                                          CORE_ADDR address,
 338                                                          struct value *dval0,
 339                                                          int keep_dynamic_fields);
 340
 341 extern int ada_name_prefix_len (const char *);
 342
 343 extern const char *ada_type_name (struct type *);
 344
 345 extern struct type *ada_find_parallel_type (struct type *,
 346                                             const char *suffix);
 347
 348 extern LONGEST get_int_var_value (char *, int *);
 349
 350 extern struct symbol *ada_find_renaming_symbol (struct symbol *name_sym,
 351                                                 const struct block *block);
 352
 353 extern int ada_prefer_type (struct type *, struct type *);
 354
 355 extern struct type *ada_get_base_type (struct type *);
 356
 357 extern struct type *ada_check_typedef (struct type *);
 358
 359 extern char *ada_encode (const char *);
 360
 361 extern const char *ada_enum_name (const char *);
 362
 363 extern int ada_is_modular_type (struct type *);
 364
 365 extern ULONGEST ada_modulus (struct type *);
 366
 367 extern struct value *ada_value_ind (struct value *);
 368
 369 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
 370
 371 extern int ada_is_range_type_name (const char *);
 372
 373 extern enum ada_renaming_category ada_parse_renaming (struct symbol *,
 374                                                       const char **,
 375                                                       int *, const char **);
 376
 377 extern void ada_find_printable_frame (struct frame_info *fi);
 378
 379 extern char *ada_breakpoint_rewrite (char *, int *);
 380
 381 extern char *ada_main_name (void);
 382
 383 extern char *ada_name_for_lookup (const char *name);
 384
 385 extern void create_ada_exception_catchpoint
 386   (struct gdbarch *gdbarch, enum ada_exception_catchpoint_kind ex_kind,
 387    char *excep_string, char *cond_string, int tempflag, int disabled,
 388    int from_tty);
 389
 390 /* Some information about a given Ada exception.  */
 391
 392 typedef struct ada_exc_info
 393 {
 394   /* The name of the exception.  */
 395   const char *name;
 396
 397   /* The address of the symbol corresponding to that exception.  */
 398   CORE_ADDR addr;
 399 } ada_exc_info;
 400
 401 DEF_VEC_O(ada_exc_info);
 402
 403 extern VEC(ada_exc_info) *ada_exceptions_list (const char *regexp);
 404
 405 /* Tasking-related: ada-tasks.c */
 406
 407 extern int valid_task_id (int);
 408
 409 extern int ada_get_task_number (ptid_t);
 410
 411 typedef void (ada_task_list_iterator_ftype) (struct ada_task_info *task);
 412 extern void iterate_over_live_ada_tasks
 413   (ada_task_list_iterator_ftype *iterator);
 414
 415 extern int ada_build_task_list (void);
 416
 417 extern void print_ada_task_info (struct ui_out *uiout,
 418                                  char *taskno_str,
 419                                  struct inferior *inf);
 420
 421 #endif