gdb/ada-lang.h

   1 /* Ada language support definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 1992, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
   4    2007 Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #if !defined (ADA_LANG_H)
  22 #define ADA_LANG_H 1
  23
  24 struct partial_symbol;
  25 struct frame_info;
  26
  27 #include "value.h"
  28 #include "gdbtypes.h"
  29 #include "breakpoint.h"
  30
  31 /* Names of specific files known to be part of the runtime
  32    system and that might consider (confusing) debugging information.
  33    Each name (a basic regular expression string) is followed by a
  34    comma.  FIXME: Should be part of a configuration file. */
  35 #if defined(__alpha__) && defined(__osf__)
  36 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
  37    "^[agis]-.*\\.ad[bs]$", \
  38    "/usr/shlib/libpthread\\.so",
  39 #elif defined (__linux__)
  40 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
  41    "^[agis]-.*\\.ad[bs]$", \
  42    "/lib.*/libpthread\\.so[.0-9]*$", "/lib.*/libpthread\\.a$", \
  43    "/lib.*/libc\\.so[.0-9]*$", "/lib.*/libc\\.a$",
  44 #endif
  45
  46 #if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS)
  47 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
  48    "^[agis]-.*\\.ad[bs]$",
  49 #endif
  50
  51 /* Names of compiler-generated auxiliary functions probably of no
  52    interest to users. Each name (a basic regular expression string)
  53    is followed by a comma. */
  54 #define ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS \
  55    "___clean[.$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 enum ada_operator
  83   {
  84     /* X IN A'RANGE(N).  N is an immediate operand, surrounded by
  85        BINOP_IN_BOUNDS before and after.  A is an array, X an index
  86        value.  Evaluates to true iff X is within range of the Nth
  87        dimension (1-based) of A.  (A multi-dimensional array
  88        type is represented as array of array of ...) */
  89     BINOP_IN_BOUNDS = OP_EXTENDED0,
  90
  91     /* X IN L .. U.  True iff L <= X <= U.  */
  92     TERNOP_IN_RANGE,
  93
  94     /* Ada attributes ('Foo). */
  95     OP_ATR_FIRST,
  96     OP_ATR_LAST,
  97     OP_ATR_LENGTH,
  98     OP_ATR_IMAGE,
  99     OP_ATR_MAX,
 100     OP_ATR_MIN,
 101     OP_ATR_MODULUS,
 102     OP_ATR_POS,
 103     OP_ATR_SIZE,
 104     OP_ATR_TAG,
 105     OP_ATR_VAL,
 106
 107     /* Ada type qualification.  It is encoded as for UNOP_CAST, above,
 108        and denotes the TYPE'(EXPR) construct. */
 109     UNOP_QUAL,
 110
 111     /* X IN TYPE.  The `TYPE' argument is immediate, with
 112        UNOP_IN_RANGE before and after it. True iff X is a member of
 113        type TYPE (typically a subrange). */
 114     UNOP_IN_RANGE,
 115
 116     /* An aggregate.   A single immediate operand, N>0, gives
 117        the number of component specifications that follow.  The
 118        immediate operand is followed by a second OP_AGGREGATE.
 119        Next come N component specifications.  A component
 120        specification is either an OP_OTHERS (others=>...), an
 121        OP_CHOICES (for named associations), or other expression (for
 122        positional aggregates only).  Aggregates currently
 123        occur only as the right sides of assignments. */
 124     OP_AGGREGATE,
 125
 126     /* An others clause.  Followed by a single expression. */
 127     OP_OTHERS,
 128
 129     /* An aggregate component association.  A single immediate operand, N,
 130        gives the number of choices that follow.  This is followed by a second
 131        OP_CHOICES operator.  Next come N operands, each of which is an
 132        expression, an OP_DISCRETE_RANGE, or an OP_NAME---the latter
 133        for a simple name that must be a record component name and does
 134        not correspond to a single existing symbol.  After the N choice
 135        indicators comes an expression giving the value.
 136
 137        In an aggregate such as (X => E1, ...), where X is a simple
 138        name, X could syntactically be either a component_selector_name
 139        or an expression used as a discrete_choice, depending on the
 140        aggregate's type context.  Since this is not known at parsing
 141        time, we don't attempt to disambiguate X if it has multiple
 142        definitions, but instead supply an OP_NAME.  If X has a single
 143        definition, we represent it with an OP_VAR_VALUE, even though
 144        it may turn out to be within a record aggregate.  Aggregate
 145        evaluation can use either OP_NAMEs or OP_VAR_VALUEs to get a
 146        record field name, and can evaluate OP_VAR_VALUE normally to
 147        get its value as an expression.  Unfortunately, we lose out in
 148        cases where X has multiple meanings and is part of an array
 149        aggregate.  I hope these are not common enough to annoy users,
 150        who can work around the problem in any case by putting
 151        parentheses around X. */
 152     OP_CHOICES,
 153
 154     /* A positional aggregate component association.  The operator is
 155        followed by a single integer indicating the position in the
 156        aggregate (0-based), followed by a second OP_POSITIONAL.  Next
 157        follows a single expression giving the component value.  */
 158     OP_POSITIONAL,
 159
 160     /* A range of values.  Followed by two expressions giving the
 161        upper and lower bounds of the range. */
 162     OP_DISCRETE_RANGE,
 163
 164     /* End marker */
 165     OP_ADA_LAST
 166   };
 167
 168 /* A triple, (symbol, block, symtab), representing one instance of a
 169  * symbol-lookup operation. */
 170 struct ada_symbol_info {
 171   struct symbol* sym;
 172   struct block* block;
 173   struct symtab* symtab;
 174 };
 175
 176 /* Ada task structures.  */
 177
 178 /* Ada task control block, as defined in the GNAT runt-time library.  */
 179
 180 struct task_control_block
 181 {
 182   char state;
 183   CORE_ADDR parent;
 184   int priority;
 185   char image [32];
 186   int image_len;    /* This field is not always present in the ATCB.  */
 187   CORE_ADDR call;
 188   CORE_ADDR thread;
 189   CORE_ADDR lwp;    /* This field is not always present in the ATCB.  */
 190
 191   /* If the task is waiting on a task entry, this field contains the
 192    task_id of the other task.  */
 193   CORE_ADDR called_task;
 194 };
 195
 196 struct task_ptid
 197 {
 198   int pid;                      /* The Process id */
 199   long lwp;                     /* The Light Weight Process id */
 200   long tid;                     /* The Thread id */
 201 };
 202 typedef struct task_ptid task_ptid_t;
 203
 204 struct task_entry
 205 {
 206   CORE_ADDR task_id;
 207   struct task_control_block atcb;
 208   int task_num;
 209   int known_tasks_index;
 210   struct task_entry *next_task;
 211   task_ptid_t task_ptid;
 212   int stack_per;
 213 };
 214
 215 /* task entry list.  */
 216 extern struct task_entry *task_list;
 217
 218
 219 /* Assuming V points to an array of S objects,  make sure that it contains at
 220    least M objects, updating V and S as necessary. */
 221
 222 #define GROW_VECT(v, s, m)                                              \
 223    if ((s) < (m)) (v) = grow_vect (v, &(s), m, sizeof *(v));
 224
 225 extern void *grow_vect (void *, size_t *, size_t, int);
 226
 227 extern int ada_get_field_index (const struct type *type,
 228                                 const char *field_name,
 229                                 int maybe_missing);
 230
 231 extern int ada_parse (void);    /* Defined in ada-exp.y */
 232
 233 extern void ada_error (char *); /* Defined in ada-exp.y */
 234
 235                         /* Defined in ada-typeprint.c */
 236 extern void ada_print_type (struct type *, char *, struct ui_file *, int,
 237                             int);
 238
 239 extern int ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
 240                           struct ui_file *, int, int, int,
 241                           enum val_prettyprint);
 242
 243 extern int ada_value_print (struct value *, struct ui_file *, int,
 244                             enum val_prettyprint);
 245
 246                                 /* Defined in ada-lang.c */
 247
 248 extern struct value *value_from_contents_and_address (struct type *,
 249                                                       const gdb_byte *,
 250                                                       CORE_ADDR);
 251
 252 extern void ada_emit_char (int, struct ui_file *, int, int);
 253
 254 extern void ada_printchar (int, struct ui_file *);
 255
 256 extern void ada_printstr (struct ui_file *, const gdb_byte *,
 257                           unsigned int, int, int);
 258
 259 extern void ada_convert_actuals (struct value *, int, struct value **,
 260                                  CORE_ADDR *);
 261
 262 extern struct value *ada_value_subscript (struct value *, int,
 263                                           struct value **);
 264
 265 extern struct type *ada_array_element_type (struct type *, int);
 266
 267 extern int ada_array_arity (struct type *);
 268
 269 struct type *ada_type_of_array (struct value *, int);
 270
 271 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
 272
 273 extern int ada_is_simple_array_type (struct type *);
 274
 275 extern int ada_is_array_descriptor_type (struct type *);
 276
 277 extern int ada_is_bogus_array_descriptor (struct type *);
 278
 279 extern struct type *ada_index_type (struct type *, int);
 280
 281 extern struct value *ada_array_bound (struct value *, int, int);
 282
 283 extern char *ada_decode_symbol (const struct general_symbol_info*);
 284
 285 extern const char *ada_decode (const char*);
 286
 287 extern enum language ada_update_initial_language (enum language,
 288                                                   struct partial_symtab*);
 289
 290 extern void clear_ada_sym_cache (void);
 291
 292 extern char **ada_make_symbol_completion_list (const char *text0,
 293                                                const char *word);
 294
 295 extern int ada_lookup_symbol_list (const char *, const struct block *,
 296                                    domain_enum, struct ada_symbol_info**);
 297
 298 extern char *ada_fold_name (const char *);
 299
 300 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
 301                                          domain_enum, int *,
 302                                          struct symtab **);
 303
 304 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
 305
 306 extern void ada_fill_in_ada_prototype (struct symbol *);
 307
 308 extern int user_select_syms (struct ada_symbol_info *, int, int);
 309
 310 extern int get_selections (int *, int, int, int, char *);
 311
 312 extern char *ada_start_decode_line_1 (char *);
 313
 314 extern struct symtabs_and_lines ada_finish_decode_line_1 (char **,
 315                                                           struct symtab *,
 316                                                           int, char ***);
 317
 318 extern struct symtabs_and_lines ada_sals_for_line (const char*, int,
 319                                                    int, char***, int);
 320
 321 extern int ada_scan_number (const char *, int, LONGEST *, int *);
 322
 323 extern struct type *ada_parent_type (struct type *);
 324
 325 extern int ada_is_ignored_field (struct type *, int);
 326
 327 extern int ada_is_packed_array_type (struct type *);
 328
 329 extern struct value *ada_value_primitive_packed_val (struct value *,
 330                                                      const gdb_byte *,
 331                                                      long, int, int,
 332                                                      struct type *);
 333
 334 extern struct type *ada_coerce_to_simple_array_type (struct type *);
 335
 336 extern int ada_is_character_type (struct type *);
 337
 338 extern int ada_is_string_type (struct type *);
 339
 340 extern int ada_is_tagged_type (struct type *, int);
 341
 342 extern int ada_is_tag_type (struct type *);
 343
 344 extern struct type *ada_tag_type (struct value *);
 345
 346 extern struct value *ada_value_tag (struct value *);
 347
 348 extern const char *ada_tag_name (struct value *);
 349
 350 extern int ada_is_parent_field (struct type *, int);
 351
 352 extern int ada_is_wrapper_field (struct type *, int);
 353
 354 extern int ada_is_variant_part (struct type *, int);
 355
 356 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
 357
 358 extern int ada_is_others_clause (struct type *, int);
 359
 360 extern int ada_in_variant (LONGEST, struct type *, int);
 361
 362 extern char *ada_variant_discrim_name (struct type *);
 363
 364 extern struct value *ada_value_struct_elt (struct value *, char *, int);
 365
 366 extern int ada_is_aligner_type (struct type *);
 367
 368 extern struct type *ada_aligned_type (struct type *);
 369
 370 extern const gdb_byte *ada_aligned_value_addr (struct type *,
 371                                                const gdb_byte *);
 372
 373 extern const char *ada_attribute_name (enum exp_opcode);
 374
 375 extern int ada_is_fixed_point_type (struct type *);
 376
 377 extern int ada_is_system_address_type (struct type *);
 378
 379 extern DOUBLEST ada_delta (struct type *);
 380
 381 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
 382
 383 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
 384
 385 extern int ada_is_vax_floating_type (struct type *);
 386
 387 extern int ada_vax_float_type_suffix (struct type *);
 388
 389 extern struct value *ada_vax_float_print_function (struct type *);
 390
 391 extern struct type *ada_system_address_type (void);
 392
 393 extern int ada_which_variant_applies (struct type *, struct type *,
 394                                       const gdb_byte *);
 395
 396 extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
 397                                        CORE_ADDR, struct value *);
 398
 399 extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
 400                                                          const gdb_byte *valaddr,
 401                                                          CORE_ADDR address,
 402                                                          struct value *dval0,
 403                                                          int keep_dynamic_fields);
 404
 405 extern int ada_name_prefix_len (const char *);
 406
 407 extern char *ada_type_name (struct type *);
 408
 409 extern struct type *ada_find_parallel_type (struct type *,
 410                                             const char *suffix);
 411
 412 extern LONGEST get_int_var_value (char *, int *);
 413
 414 extern struct symbol *ada_find_any_symbol (const char *name);
 415
 416 extern struct type *ada_find_any_type (const char *name);
 417
 418 extern struct symbol *ada_find_renaming_symbol (const char *name,
 419                                                 struct block *block);
 420
 421 extern int ada_prefer_type (struct type *, struct type *);
 422
 423 extern struct type *ada_get_base_type (struct type *);
 424
 425 extern struct type *ada_check_typedef (struct type *);
 426
 427 extern char *ada_encode (const char *);
 428
 429 extern const char *ada_enum_name (const char *);
 430
 431 extern int ada_is_modular_type (struct type *);
 432
 433 extern ULONGEST ada_modulus (struct type *);
 434
 435 extern struct value *ada_value_ind (struct value *);
 436
 437 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
 438
 439 extern int ada_is_range_type_name (const char *);
 440
 441 extern const char *ada_renaming_type (struct type *);
 442
 443 extern int ada_is_object_renaming (struct symbol *);
 444
 445 extern char *ada_simple_renamed_entity (struct symbol *);
 446
 447 extern char *ada_breakpoint_rewrite (char *, int *);
 448
 449 extern char *ada_main_name (void);
 450
 451 /* Tasking-related: ada-tasks.c */
 452
 453 extern int valid_task_id (int);
 454
 455 extern void init_task_list (void);
 456
 457 extern int ada_is_exception_breakpoint (bpstat bs);
 458
 459 extern void ada_adjust_exception_stop (bpstat bs);
 460
 461 extern void ada_print_exception_stop (bpstat bs);
 462
 463 extern int ada_get_current_task (ptid_t);
 464
 465 extern int breakpoint_ada_task_match (CORE_ADDR, ptid_t);
 466
 467 extern int ada_print_exception_breakpoint_nontask (struct breakpoint *);
 468
 469 extern void ada_print_exception_breakpoint_task (struct breakpoint *);
 470
 471 extern void ada_reset_thread_registers (void);
 472
 473 extern int ada_build_task_list (void);
 474
 475 extern int ada_exception_catchpoint_p (struct breakpoint *b);
 476
 477 extern struct symtab_and_line
 478   ada_decode_exception_location (char *args, char **addr_string,
 479                                  char **exp_string, char **cond_string,
 480                                  struct expression **cond,
 481                                  struct breakpoint_ops **ops);
 482
 483 extern struct symtab_and_line
 484   ada_decode_assert_location (char *args, char **addr_string,
 485                               struct breakpoint_ops **ops);
 486
 487
 488 #endif