gdb/ada-lang.h

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