gdb/ada-lang.h

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