gdb/ada-lang.h

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