gdb/ada-lang.h

   1 /* Ada language support definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 1992-2025 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 #ifndef GDB_ADA_LANG_H
  21 #define GDB_ADA_LANG_H
  22
  23 class frame_info_ptr;
  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 extern int ada_get_field_index (const struct type *type,
 153                                 const char *field_name,
 154                                 int maybe_missing);
 155
 156 extern int ada_parse (struct parser_state *);    /* Defined in ada-exp.y */
 157
 158                         /* Defined in ada-typeprint.c */
 159 extern void ada_print_type (struct type *, const char *, struct ui_file *, int,
 160                             int, const struct type_print_options *);
 161
 162 extern void ada_print_typedef (struct type *type, struct symbol *new_symbol,
 163                                struct ui_file *stream);
 164
 165 /* Implement la_value_print_inner for Ada.  */
 166
 167 extern void ada_value_print_inner (struct value *, struct ui_file *, int,
 168                                    const struct value_print_options *);
 169
 170 extern void ada_value_print (struct value *, struct ui_file *,
 171                              const struct value_print_options *);
 172
 173                                 /* Defined in ada-lang.c */
 174
 175 extern void ada_emit_char (int, struct type *, struct ui_file *, int, int);
 176
 177 extern void ada_printchar (int, struct type *, struct ui_file *);
 178
 179 extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *,
 180                           unsigned int, const char *, int,
 181                           const struct value_print_options *);
 182
 183 struct value *ada_convert_actual (struct value *actual,
 184                                   struct type *formal_type0);
 185
 186 extern bool ada_is_access_to_unconstrained_array (struct type *type);
 187
 188 extern struct value *ada_value_subscript (struct value *, int,
 189                                           struct value **);
 190
 191 extern void ada_fixup_array_indexes_type (struct type *index_desc_type);
 192
 193 extern struct type *ada_array_element_type (struct type *, int);
 194
 195 extern int ada_array_arity (struct type *);
 196
 197 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
 198
 199 struct value *ada_coerce_to_simple_array (struct value *);
 200
 201 extern int ada_is_simple_array_type (struct type *);
 202
 203 extern int ada_is_array_descriptor_type (struct type *);
 204
 205 extern LONGEST ada_discrete_type_low_bound (struct type *);
 206
 207 extern LONGEST ada_discrete_type_high_bound (struct type *);
 208
 209 extern struct value *ada_get_decoded_value (struct value *value);
 210
 211 extern struct type *ada_get_decoded_type (struct type *type);
 212
 213 extern const char *ada_decode_symbol (const struct general_symbol_info *);
 214
 215 /* Decode the GNAT-encoded name NAME, returning the decoded name.  If
 216    the name does not appear to be GNAT-encoded, then the result
 217    depends on WRAP.  If WRAP is true (the default), then the result is
 218    simply wrapped in <...>.  If WRAP is false, then the empty string
 219    will be returned.
 220
 221    TRANSLATE has two effects.  When true (the default), operator names
 222    and wide characters will be decoded.  E.g., 'Oadd' will be
 223    transformed to '"+"', and wide characters converted from their hex
 224    encoding to the host charset.  When false, these will be left
 225    alone.  */
 226 extern std::string ada_decode (const char *name, bool wrap = true,
 227                                bool translate = true);
 228
 229 extern std::vector<struct block_symbol> ada_lookup_symbol_list
 230      (const char *, const struct block *, domain_search_flags);
 231
 232 extern struct block_symbol ada_lookup_symbol (const char *,
 233                                               const struct block *,
 234                                               domain_search_flags);
 235
 236 extern block_symbol ada_lookup_encoded_symbol
 237   (const char *name, const struct block *block, domain_search_flags domain);
 238
 239 extern bound_minimal_symbol ada_lookup_simple_minsym (const char *, objfile *);
 240
 241 extern int ada_scan_number (const char *, int, LONGEST *, int *);
 242
 243 extern struct value *ada_value_primitive_field (struct value *arg1,
 244                                                 int offset,
 245                                                 int fieldno,
 246                                                 struct type *arg_type);
 247
 248 extern struct type *ada_parent_type (struct type *);
 249
 250 extern int ada_is_ignored_field (struct type *, int);
 251
 252 extern int ada_is_constrained_packed_array_type (struct type *);
 253
 254 extern struct value *ada_value_primitive_packed_val (struct value *,
 255                                                      const gdb_byte *,
 256                                                      long, int, int,
 257                                                      struct type *);
 258
 259 extern struct type *ada_coerce_to_simple_array_type (struct type *);
 260
 261 extern bool ada_is_character_type (struct type *);
 262
 263 extern bool ada_is_string_type (struct type *);
 264
 265 extern int ada_is_tagged_type (struct type *, int);
 266
 267 extern int ada_is_tag_type (struct type *);
 268
 269 extern gdb::unique_xmalloc_ptr<char> ada_tag_name (struct value *);
 270
 271 extern struct value *ada_tag_value_at_base_address (struct value *obj);
 272
 273 extern int ada_is_parent_field (struct type *, int);
 274
 275 extern int ada_is_wrapper_field (struct type *, int);
 276
 277 extern int ada_is_variant_part (struct type *, int);
 278
 279 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
 280
 281 extern const char *ada_variant_discrim_name (struct type *);
 282
 283 extern int ada_is_aligner_type (struct type *);
 284
 285 extern struct type *ada_aligned_type (struct type *);
 286
 287 extern const gdb_byte *ada_aligned_value_addr (struct type *,
 288                                                const gdb_byte *);
 289
 290 extern int ada_is_system_address_type (struct type *);
 291
 292 extern int ada_which_variant_applies (struct type *, struct value *);
 293
 294 extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
 295                                        CORE_ADDR, struct value *,
 296                                        int check_tag);
 297
 298 extern struct value *ada_to_fixed_value (struct value *val);
 299
 300 extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
 301                                                          const gdb_byte *valaddr,
 302                                                          CORE_ADDR address,
 303                                                          struct value *dval0,
 304                                                          int keep_dynamic_fields);
 305
 306 extern int ada_name_prefix_len (const char *);
 307
 308 extern const char *ada_type_name (struct type *);
 309
 310 extern struct type *ada_find_parallel_type (struct type *,
 311                                             const char *suffix);
 312
 313 extern bool get_int_var_value (const char *, LONGEST &value);
 314
 315 extern int ada_prefer_type (struct type *, struct type *);
 316
 317 extern struct type *ada_get_base_type (struct type *);
 318
 319 extern struct type *ada_check_typedef (struct type *);
 320
 321 extern std::string ada_encode (const char *, bool fold = true);
 322
 323 extern const char *ada_enum_name (const char *);
 324
 325 /* True iff TYPE is an Ada modular type.  */
 326
 327 extern bool ada_is_modular_type (struct type *);
 328
 329 /* Return the upper bound of a modular type.  If the upper bound is
 330    non-constant, returns an empty optional.  */
 331
 332 extern std::optional<ULONGEST> ada_modular_bound (struct type *);
 333
 334 extern struct value *ada_value_ind (struct value *);
 335
 336 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
 337
 338 extern int ada_is_range_type_name (const char *);
 339
 340 extern enum ada_renaming_category ada_parse_renaming (struct symbol *,
 341                                                       const char **,
 342                                                       int *, const char **);
 343
 344 extern void ada_find_printable_frame (const frame_info_ptr &fi);
 345
 346 extern const char *ada_main_name ();
 347
 348 extern void create_ada_exception_catchpoint
 349   (struct gdbarch *gdbarch, enum ada_exception_catchpoint_kind ex_kind,
 350    std::string &&excep_string, const std::string &cond_string, int tempflag,
 351    int enabled, int from_tty);
 352
 353 /* Return true if BP is an Ada catchpoint.  */
 354
 355 extern bool is_ada_exception_catchpoint (breakpoint *bp);
 356
 357 /* Some information about a given Ada exception.  */
 358
 359 struct ada_exc_info
 360 {
 361   /* The name of the exception.  */
 362   const char *name;
 363
 364   /* The address of the symbol corresponding to that exception.  */
 365   CORE_ADDR addr;
 366
 367   bool operator< (const ada_exc_info &) const;
 368   bool operator== (const ada_exc_info &) const;
 369 };
 370
 371 extern std::vector<ada_exc_info> ada_exceptions_list (const char *regexp);
 372
 373 /* Tasking-related: ada-tasks.c */
 374
 375 extern int valid_task_id (int);
 376
 377 extern struct ada_task_info *ada_get_task_info_from_ptid (ptid_t ptid);
 378
 379 extern int ada_get_task_number (thread_info *thread);
 380
 381 typedef gdb::function_view<void (struct ada_task_info *task)>
 382   ada_task_list_iterator_ftype;
 383 extern void iterate_over_live_ada_tasks
 384   (ada_task_list_iterator_ftype iterator);
 385
 386 extern const char *ada_get_tcb_types_info (void);
 387
 388 extern void print_ada_task_info (struct ui_out *uiout,
 389                                  const char *taskno_str,
 390                                  struct inferior *inf);
 391
 392 /* Look for a symbol for an overloaded operator for the operation OP.
 393    PARSE_COMPLETION is true if currently parsing for completion.
 394    NARGS and ARGVEC describe the arguments to the call.  Returns a
 395    "null" block_symbol if no such operator is found.  */
 396
 397 extern block_symbol ada_find_operator_symbol (enum exp_opcode op,
 398                                               bool parse_completion,
 399                                               int nargs, value *argvec[]);
 400
 401 /* Resolve a function call, selecting among possible function symbols.
 402    SYM and BLOCK are passed to ada_lookup_symbol_list.  CONTEXT_TYPE
 403    describes the calling context.  PARSE_COMPLETION is true if
 404    currently parsing for completion.  NARGS and ARGVEC describe the
 405    arguments to the call.  This returns the chosen symbol and will
 406    update TRACKER accordingly.  */
 407
 408 extern block_symbol ada_resolve_funcall (struct symbol *sym,
 409                                          const struct block *block,
 410                                          struct type *context_type,
 411                                          bool parse_completion,
 412                                          int nargs, value *argvec[],
 413                                          innermost_block_tracker *tracker);
 414
 415 /* Resolve a symbol reference, selecting among possible values.  SYM
 416    and BLOCK are passed to ada_lookup_symbol_list.  CONTEXT_TYPE
 417    describes the calling context.  PARSE_COMPLETION is true if
 418    currently parsing for completion.  If DEPROCEDURE_P is nonzero,
 419    then a symbol that names a zero-argument function will be passed
 420    through ada_resolve_function.  This returns the chosen symbol and
 421    will update TRACKER accordingly.  */
 422
 423 extern block_symbol ada_resolve_variable (struct symbol *sym,
 424                                           const struct block *block,
 425                                           struct type *context_type,
 426                                           bool parse_completion,
 427                                           int deprocedure_p,
 428                                           innermost_block_tracker *tracker);
 429
 430 /* The type of nth index in arrays of given type (n numbering from 1).
 431    Does not examine memory.  Throws an error if N is invalid or TYPE
 432    is not an array type.  NAME is the name of the Ada attribute being
 433    evaluated ('range, 'first, 'last, or 'length); it is used in building
 434    the error message.  */
 435 extern struct type *ada_index_type (struct type *type, int n,
 436                                     const char *name);
 437
 438 /* Clear the Ada symbol cache.  */
 439
 440 extern void ada_clear_symbol_cache (program_space *pspace);
 441
 442 #endif /* GDB_ADA_LANG_H */