gdb/ada-lang.h

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