1 /* Ada language support routines for GDB, the GNU debugger.
3 Copyright (C) 1992-2022 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
23 #include "gdbsupport/gdb_regex.h"
28 #include "expression.h"
29 #include "parser-defs.h"
35 #include "breakpoint.h"
38 #include "gdbsupport/gdb_obstack.h"
40 #include "completer.h"
47 #include "observable.h"
49 #include "typeprint.h"
50 #include "namespace.h"
51 #include "cli/cli-style.h"
52 #include "cli/cli-decode.h"
55 #include "mi/mi-common.h"
56 #include "arch-utils.h"
57 #include "cli/cli-utils.h"
58 #include "gdbsupport/function-view.h"
59 #include "gdbsupport/byte-vector.h"
64 /* Define whether or not the C operator '/' truncates towards zero for
65 differently signed operands (truncation direction is undefined in C).
66 Copied from valarith.c. */
68 #ifndef TRUNCATION_TOWARDS_ZERO
69 #define TRUNCATION_TOWARDS_ZERO ((-5 / 2) == -2)
72 static struct type
*desc_base_type (struct type
*);
74 static struct type
*desc_bounds_type (struct type
*);
76 static struct value
*desc_bounds (struct value
*);
78 static int fat_pntr_bounds_bitpos (struct type
*);
80 static int fat_pntr_bounds_bitsize (struct type
*);
82 static struct type
*desc_data_target_type (struct type
*);
84 static struct value
*desc_data (struct value
*);
86 static int fat_pntr_data_bitpos (struct type
*);
88 static int fat_pntr_data_bitsize (struct type
*);
90 static struct value
*desc_one_bound (struct value
*, int, int);
92 static int desc_bound_bitpos (struct type
*, int, int);
94 static int desc_bound_bitsize (struct type
*, int, int);
96 static struct type
*desc_index_type (struct type
*, int);
98 static int desc_arity (struct type
*);
100 static int ada_args_match (struct symbol
*, struct value
**, int);
102 static struct value
*make_array_descriptor (struct type
*, struct value
*);
104 static void ada_add_block_symbols (std::vector
<struct block_symbol
> &,
105 const struct block
*,
106 const lookup_name_info
&lookup_name
,
107 domain_enum
, struct objfile
*);
109 static void ada_add_all_symbols (std::vector
<struct block_symbol
> &,
110 const struct block
*,
111 const lookup_name_info
&lookup_name
,
112 domain_enum
, int, int *);
114 static int is_nonfunction (const std::vector
<struct block_symbol
> &);
116 static void add_defn_to_vec (std::vector
<struct block_symbol
> &,
118 const struct block
*);
120 static int possible_user_operator_p (enum exp_opcode
, struct value
**);
122 static const char *ada_decoded_op_name (enum exp_opcode
);
124 static int numeric_type_p (struct type
*);
126 static int integer_type_p (struct type
*);
128 static int scalar_type_p (struct type
*);
130 static int discrete_type_p (struct type
*);
132 static struct type
*ada_lookup_struct_elt_type (struct type
*, const char *,
135 static struct type
*ada_find_parallel_type_with_name (struct type
*,
138 static int is_dynamic_field (struct type
*, int);
140 static struct type
*to_fixed_variant_branch_type (struct type
*,
142 CORE_ADDR
, struct value
*);
144 static struct type
*to_fixed_array_type (struct type
*, struct value
*, int);
146 static struct type
*to_fixed_range_type (struct type
*, struct value
*);
148 static struct type
*to_static_fixed_type (struct type
*);
149 static struct type
*static_unwrap_type (struct type
*type
);
151 static struct value
*unwrap_value (struct value
*);
153 static struct type
*constrained_packed_array_type (struct type
*, long *);
155 static struct type
*decode_constrained_packed_array_type (struct type
*);
157 static long decode_packed_array_bitsize (struct type
*);
159 static struct value
*decode_constrained_packed_array (struct value
*);
161 static int ada_is_unconstrained_packed_array_type (struct type
*);
163 static struct value
*value_subscript_packed (struct value
*, int,
166 static struct value
*coerce_unspec_val_to_type (struct value
*,
169 static int lesseq_defined_than (struct symbol
*, struct symbol
*);
171 static int equiv_types (struct type
*, struct type
*);
173 static int is_name_suffix (const char *);
175 static int advance_wild_match (const char **, const char *, char);
177 static bool wild_match (const char *name
, const char *patn
);
179 static struct value
*ada_coerce_ref (struct value
*);
181 static LONGEST
pos_atr (struct value
*);
183 static struct value
*val_atr (struct type
*, LONGEST
);
185 static struct symbol
*standard_lookup (const char *, const struct block
*,
188 static struct value
*ada_search_struct_field (const char *, struct value
*, int,
191 static int find_struct_field (const char *, struct type
*, int,
192 struct type
**, int *, int *, int *, int *);
194 static int ada_resolve_function (std::vector
<struct block_symbol
> &,
195 struct value
**, int, const char *,
196 struct type
*, bool);
198 static int ada_is_direct_array_type (struct type
*);
200 static struct value
*ada_index_struct_field (int, struct value
*, int,
203 static void add_component_interval (LONGEST
, LONGEST
, std::vector
<LONGEST
> &);
206 static struct type
*ada_find_any_type (const char *name
);
208 static symbol_name_matcher_ftype
*ada_get_symbol_name_matcher
209 (const lookup_name_info
&lookup_name
);
213 /* The character set used for source files. */
214 static const char *ada_source_charset
;
216 /* The string "UTF-8". This is here so we can check for the UTF-8
217 charset using == rather than strcmp. */
218 static const char ada_utf8
[] = "UTF-8";
220 /* Each entry in the UTF-32 case-folding table is of this form. */
223 /* The start and end, inclusive, of this range of codepoints. */
225 /* The delta to apply to get the upper-case form. 0 if this is
226 already upper-case. */
228 /* The delta to apply to get the lower-case form. 0 if this is
229 already lower-case. */
232 bool operator< (uint32_t val
) const
238 static const utf8_entry ada_case_fold
[] =
240 #include "ada-casefold.h"
245 /* The result of a symbol lookup to be stored in our symbol cache. */
249 /* The name used to perform the lookup. */
251 /* The namespace used during the lookup. */
253 /* The symbol returned by the lookup, or NULL if no matching symbol
256 /* The block where the symbol was found, or NULL if no matching
258 const struct block
*block
;
259 /* A pointer to the next entry with the same hash. */
260 struct cache_entry
*next
;
263 /* The Ada symbol cache, used to store the result of Ada-mode symbol
264 lookups in the course of executing the user's commands.
266 The cache is implemented using a simple, fixed-sized hash.
267 The size is fixed on the grounds that there are not likely to be
268 all that many symbols looked up during any given session, regardless
269 of the size of the symbol table. If we decide to go to a resizable
270 table, let's just use the stuff from libiberty instead. */
272 #define HASH_SIZE 1009
274 struct ada_symbol_cache
276 /* An obstack used to store the entries in our cache. */
277 struct auto_obstack cache_space
;
279 /* The root of the hash table used to implement our symbol cache. */
280 struct cache_entry
*root
[HASH_SIZE
] {};
283 static const char ada_completer_word_break_characters
[] =
285 " \t\n!@#%^&*()+=|~`}{[]\";:?/,-";
287 " \t\n!@#$%^&*()+=|~`}{[]\";:?/,-";
290 /* The name of the symbol to use to get the name of the main subprogram. */
291 static const char ADA_MAIN_PROGRAM_SYMBOL_NAME
[]
292 = "__gnat_ada_main_program_name";
294 /* Limit on the number of warnings to raise per expression evaluation. */
295 static int warning_limit
= 2;
297 /* Number of warning messages issued; reset to 0 by cleanups after
298 expression evaluation. */
299 static int warnings_issued
= 0;
301 static const char * const known_runtime_file_name_patterns
[] = {
302 ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS NULL
305 static const char * const known_auxiliary_function_name_patterns
[] = {
306 ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS NULL
309 /* Maintenance-related settings for this module. */
311 static struct cmd_list_element
*maint_set_ada_cmdlist
;
312 static struct cmd_list_element
*maint_show_ada_cmdlist
;
314 /* The "maintenance ada set/show ignore-descriptive-type" value. */
316 static bool ada_ignore_descriptive_types_p
= false;
318 /* Inferior-specific data. */
320 /* Per-inferior data for this module. */
322 struct ada_inferior_data
324 /* The ada__tags__type_specific_data type, which is used when decoding
325 tagged types. With older versions of GNAT, this type was directly
326 accessible through a component ("tsd") in the object tag. But this
327 is no longer the case, so we cache it for each inferior. */
328 struct type
*tsd_type
= nullptr;
330 /* The exception_support_info data. This data is used to determine
331 how to implement support for Ada exception catchpoints in a given
333 const struct exception_support_info
*exception_info
= nullptr;
336 /* Our key to this module's inferior data. */
337 static const struct inferior_key
<ada_inferior_data
> ada_inferior_data
;
339 /* Return our inferior data for the given inferior (INF).
341 This function always returns a valid pointer to an allocated
342 ada_inferior_data structure. If INF's inferior data has not
343 been previously set, this functions creates a new one with all
344 fields set to zero, sets INF's inferior to it, and then returns
345 a pointer to that newly allocated ada_inferior_data. */
347 static struct ada_inferior_data
*
348 get_ada_inferior_data (struct inferior
*inf
)
350 struct ada_inferior_data
*data
;
352 data
= ada_inferior_data
.get (inf
);
354 data
= ada_inferior_data
.emplace (inf
);
359 /* Perform all necessary cleanups regarding our module's inferior data
360 that is required after the inferior INF just exited. */
363 ada_inferior_exit (struct inferior
*inf
)
365 ada_inferior_data
.clear (inf
);
369 /* program-space-specific data. */
371 /* This module's per-program-space data. */
372 struct ada_pspace_data
374 /* The Ada symbol cache. */
375 std::unique_ptr
<ada_symbol_cache
> sym_cache
;
378 /* Key to our per-program-space data. */
379 static const struct program_space_key
<ada_pspace_data
> ada_pspace_data_handle
;
381 /* Return this module's data for the given program space (PSPACE).
382 If not is found, add a zero'ed one now.
384 This function always returns a valid object. */
386 static struct ada_pspace_data
*
387 get_ada_pspace_data (struct program_space
*pspace
)
389 struct ada_pspace_data
*data
;
391 data
= ada_pspace_data_handle
.get (pspace
);
393 data
= ada_pspace_data_handle
.emplace (pspace
);
400 /* If TYPE is a TYPE_CODE_TYPEDEF type, return the target type after
401 all typedef layers have been peeled. Otherwise, return TYPE.
403 Normally, we really expect a typedef type to only have 1 typedef layer.
404 In other words, we really expect the target type of a typedef type to be
405 a non-typedef type. This is particularly true for Ada units, because
406 the language does not have a typedef vs not-typedef distinction.
407 In that respect, the Ada compiler has been trying to eliminate as many
408 typedef definitions in the debugging information, since they generally
409 do not bring any extra information (we still use typedef under certain
410 circumstances related mostly to the GNAT encoding).
412 Unfortunately, we have seen situations where the debugging information
413 generated by the compiler leads to such multiple typedef layers. For
414 instance, consider the following example with stabs:
416 .stabs "pck__float_array___XUP:Tt(0,46)=s16P_ARRAY:(0,47)=[...]"[...]
417 .stabs "pck__float_array___XUP:t(0,36)=(0,46)",128,0,6,0
419 This is an error in the debugging information which causes type
420 pck__float_array___XUP to be defined twice, and the second time,
421 it is defined as a typedef of a typedef.
423 This is on the fringe of legality as far as debugging information is
424 concerned, and certainly unexpected. But it is easy to handle these
425 situations correctly, so we can afford to be lenient in this case. */
428 ada_typedef_target_type (struct type
*type
)
430 while (type
->code () == TYPE_CODE_TYPEDEF
)
431 type
= TYPE_TARGET_TYPE (type
);
435 /* Given DECODED_NAME a string holding a symbol name in its
436 decoded form (ie using the Ada dotted notation), returns
437 its unqualified name. */
440 ada_unqualified_name (const char *decoded_name
)
444 /* If the decoded name starts with '<', it means that the encoded
445 name does not follow standard naming conventions, and thus that
446 it is not your typical Ada symbol name. Trying to unqualify it
447 is therefore pointless and possibly erroneous. */
448 if (decoded_name
[0] == '<')
451 result
= strrchr (decoded_name
, '.');
453 result
++; /* Skip the dot... */
455 result
= decoded_name
;
460 /* Return a string starting with '<', followed by STR, and '>'. */
463 add_angle_brackets (const char *str
)
465 return string_printf ("<%s>", str
);
468 /* True (non-zero) iff TARGET matches FIELD_NAME up to any trailing
469 suffix of FIELD_NAME beginning "___". */
472 field_name_match (const char *field_name
, const char *target
)
474 int len
= strlen (target
);
477 (strncmp (field_name
, target
, len
) == 0
478 && (field_name
[len
] == '\0'
479 || (startswith (field_name
+ len
, "___")
480 && strcmp (field_name
+ strlen (field_name
) - 6,
485 /* Assuming TYPE is a TYPE_CODE_STRUCT or a TYPE_CODE_TYPDEF to
486 a TYPE_CODE_STRUCT, find the field whose name matches FIELD_NAME,
487 and return its index. This function also handles fields whose name
488 have ___ suffixes because the compiler sometimes alters their name
489 by adding such a suffix to represent fields with certain constraints.
490 If the field could not be found, return a negative number if
491 MAYBE_MISSING is set. Otherwise raise an error. */
494 ada_get_field_index (const struct type
*type
, const char *field_name
,
498 struct type
*struct_type
= check_typedef ((struct type
*) type
);
500 for (fieldno
= 0; fieldno
< struct_type
->num_fields (); fieldno
++)
501 if (field_name_match (struct_type
->field (fieldno
).name (), field_name
))
505 error (_("Unable to find field %s in struct %s. Aborting"),
506 field_name
, struct_type
->name ());
511 /* The length of the prefix of NAME prior to any "___" suffix. */
514 ada_name_prefix_len (const char *name
)
520 const char *p
= strstr (name
, "___");
523 return strlen (name
);
529 /* Return non-zero if SUFFIX is a suffix of STR.
530 Return zero if STR is null. */
533 is_suffix (const char *str
, const char *suffix
)
540 len2
= strlen (suffix
);
541 return (len1
>= len2
&& strcmp (str
+ len1
- len2
, suffix
) == 0);
544 /* The contents of value VAL, treated as a value of type TYPE. The
545 result is an lval in memory if VAL is. */
547 static struct value
*
548 coerce_unspec_val_to_type (struct value
*val
, struct type
*type
)
550 type
= ada_check_typedef (type
);
551 if (value_type (val
) == type
)
555 struct value
*result
;
557 if (value_optimized_out (val
))
558 result
= allocate_optimized_out_value (type
);
559 else if (value_lazy (val
)
560 /* Be careful not to make a lazy not_lval value. */
561 || (VALUE_LVAL (val
) != not_lval
562 && TYPE_LENGTH (type
) > TYPE_LENGTH (value_type (val
))))
563 result
= allocate_value_lazy (type
);
566 result
= allocate_value (type
);
567 value_contents_copy (result
, 0, val
, 0, TYPE_LENGTH (type
));
569 set_value_component_location (result
, val
);
570 set_value_bitsize (result
, value_bitsize (val
));
571 set_value_bitpos (result
, value_bitpos (val
));
572 if (VALUE_LVAL (result
) == lval_memory
)
573 set_value_address (result
, value_address (val
));
578 static const gdb_byte
*
579 cond_offset_host (const gdb_byte
*valaddr
, long offset
)
584 return valaddr
+ offset
;
588 cond_offset_target (CORE_ADDR address
, long offset
)
593 return address
+ offset
;
596 /* Issue a warning (as for the definition of warning in utils.c, but
597 with exactly one argument rather than ...), unless the limit on the
598 number of warnings has passed during the evaluation of the current
601 /* FIXME: cagney/2004-10-10: This function is mimicking the behavior
602 provided by "complaint". */
603 static void lim_warning (const char *format
, ...) ATTRIBUTE_PRINTF (1, 2);
606 lim_warning (const char *format
, ...)
610 va_start (args
, format
);
611 warnings_issued
+= 1;
612 if (warnings_issued
<= warning_limit
)
613 vwarning (format
, args
);
618 /* Maximum value of a SIZE-byte signed integer type. */
620 max_of_size (int size
)
622 LONGEST top_bit
= (LONGEST
) 1 << (size
* 8 - 2);
624 return top_bit
| (top_bit
- 1);
627 /* Minimum value of a SIZE-byte signed integer type. */
629 min_of_size (int size
)
631 return -max_of_size (size
) - 1;
634 /* Maximum value of a SIZE-byte unsigned integer type. */
636 umax_of_size (int size
)
638 ULONGEST top_bit
= (ULONGEST
) 1 << (size
* 8 - 1);
640 return top_bit
| (top_bit
- 1);
643 /* Maximum value of integral type T, as a signed quantity. */
645 max_of_type (struct type
*t
)
647 if (t
->is_unsigned ())
648 return (LONGEST
) umax_of_size (TYPE_LENGTH (t
));
650 return max_of_size (TYPE_LENGTH (t
));
653 /* Minimum value of integral type T, as a signed quantity. */
655 min_of_type (struct type
*t
)
657 if (t
->is_unsigned ())
660 return min_of_size (TYPE_LENGTH (t
));
663 /* The largest value in the domain of TYPE, a discrete type, as an integer. */
665 ada_discrete_type_high_bound (struct type
*type
)
667 type
= resolve_dynamic_type (type
, {}, 0);
668 switch (type
->code ())
670 case TYPE_CODE_RANGE
:
672 const dynamic_prop
&high
= type
->bounds ()->high
;
674 if (high
.kind () == PROP_CONST
)
675 return high
.const_val ();
678 gdb_assert (high
.kind () == PROP_UNDEFINED
);
680 /* This happens when trying to evaluate a type's dynamic bound
681 without a live target. There is nothing relevant for us to
682 return here, so return 0. */
687 return type
->field (type
->num_fields () - 1).loc_enumval ();
692 return max_of_type (type
);
694 error (_("Unexpected type in ada_discrete_type_high_bound."));
698 /* The smallest value in the domain of TYPE, a discrete type, as an integer. */
700 ada_discrete_type_low_bound (struct type
*type
)
702 type
= resolve_dynamic_type (type
, {}, 0);
703 switch (type
->code ())
705 case TYPE_CODE_RANGE
:
707 const dynamic_prop
&low
= type
->bounds ()->low
;
709 if (low
.kind () == PROP_CONST
)
710 return low
.const_val ();
713 gdb_assert (low
.kind () == PROP_UNDEFINED
);
715 /* This happens when trying to evaluate a type's dynamic bound
716 without a live target. There is nothing relevant for us to
717 return here, so return 0. */
722 return type
->field (0).loc_enumval ();
727 return min_of_type (type
);
729 error (_("Unexpected type in ada_discrete_type_low_bound."));
733 /* The identity on non-range types. For range types, the underlying
734 non-range scalar type. */
737 get_base_type (struct type
*type
)
739 while (type
!= NULL
&& type
->code () == TYPE_CODE_RANGE
)
741 if (type
== TYPE_TARGET_TYPE (type
) || TYPE_TARGET_TYPE (type
) == NULL
)
743 type
= TYPE_TARGET_TYPE (type
);
748 /* Return a decoded version of the given VALUE. This means returning
749 a value whose type is obtained by applying all the GNAT-specific
750 encodings, making the resulting type a static but standard description
751 of the initial type. */
754 ada_get_decoded_value (struct value
*value
)
756 struct type
*type
= ada_check_typedef (value_type (value
));
758 if (ada_is_array_descriptor_type (type
)
759 || (ada_is_constrained_packed_array_type (type
)
760 && type
->code () != TYPE_CODE_PTR
))
762 if (type
->code () == TYPE_CODE_TYPEDEF
) /* array access type. */
763 value
= ada_coerce_to_simple_array_ptr (value
);
765 value
= ada_coerce_to_simple_array (value
);
768 value
= ada_to_fixed_value (value
);
773 /* Same as ada_get_decoded_value, but with the given TYPE.
774 Because there is no associated actual value for this type,
775 the resulting type might be a best-effort approximation in
776 the case of dynamic types. */
779 ada_get_decoded_type (struct type
*type
)
781 type
= to_static_fixed_type (type
);
782 if (ada_is_constrained_packed_array_type (type
))
783 type
= ada_coerce_to_simple_array_type (type
);
789 /* Language Selection */
791 /* If the main program is in Ada, return language_ada, otherwise return LANG
792 (the main program is in Ada iif the adainit symbol is found). */
795 ada_update_initial_language (enum language lang
)
797 if (lookup_minimal_symbol ("adainit", NULL
, NULL
).minsym
!= NULL
)
803 /* If the main procedure is written in Ada, then return its name.
804 The result is good until the next call. Return NULL if the main
805 procedure doesn't appear to be in Ada. */
810 struct bound_minimal_symbol msym
;
811 static gdb::unique_xmalloc_ptr
<char> main_program_name
;
813 /* For Ada, the name of the main procedure is stored in a specific
814 string constant, generated by the binder. Look for that symbol,
815 extract its address, and then read that string. If we didn't find
816 that string, then most probably the main procedure is not written
818 msym
= lookup_minimal_symbol (ADA_MAIN_PROGRAM_SYMBOL_NAME
, NULL
, NULL
);
820 if (msym
.minsym
!= NULL
)
822 CORE_ADDR main_program_name_addr
= BMSYMBOL_VALUE_ADDRESS (msym
);
823 if (main_program_name_addr
== 0)
824 error (_("Invalid address for Ada main program name."));
826 main_program_name
= target_read_string (main_program_name_addr
, 1024);
827 return main_program_name
.get ();
830 /* The main procedure doesn't seem to be in Ada. */
836 /* Table of Ada operators and their GNAT-encoded names. Last entry is pair
839 const struct ada_opname_map ada_opname_table
[] = {
840 {"Oadd", "\"+\"", BINOP_ADD
},
841 {"Osubtract", "\"-\"", BINOP_SUB
},
842 {"Omultiply", "\"*\"", BINOP_MUL
},
843 {"Odivide", "\"/\"", BINOP_DIV
},
844 {"Omod", "\"mod\"", BINOP_MOD
},
845 {"Orem", "\"rem\"", BINOP_REM
},
846 {"Oexpon", "\"**\"", BINOP_EXP
},
847 {"Olt", "\"<\"", BINOP_LESS
},
848 {"Ole", "\"<=\"", BINOP_LEQ
},
849 {"Ogt", "\">\"", BINOP_GTR
},
850 {"Oge", "\">=\"", BINOP_GEQ
},
851 {"Oeq", "\"=\"", BINOP_EQUAL
},
852 {"One", "\"/=\"", BINOP_NOTEQUAL
},
853 {"Oand", "\"and\"", BINOP_BITWISE_AND
},
854 {"Oor", "\"or\"", BINOP_BITWISE_IOR
},
855 {"Oxor", "\"xor\"", BINOP_BITWISE_XOR
},
856 {"Oconcat", "\"&\"", BINOP_CONCAT
},
857 {"Oabs", "\"abs\"", UNOP_ABS
},
858 {"Onot", "\"not\"", UNOP_LOGICAL_NOT
},
859 {"Oadd", "\"+\"", UNOP_PLUS
},
860 {"Osubtract", "\"-\"", UNOP_NEG
},
864 /* If STR is a decoded version of a compiler-provided suffix (like the
865 "[cold]" in "symbol[cold]"), return true. Otherwise, return
869 is_compiler_suffix (const char *str
)
871 gdb_assert (*str
== '[');
873 while (*str
!= '\0' && isalpha (*str
))
875 /* We accept a missing "]" in order to support completion. */
876 return *str
== '\0' || (str
[0] == ']' && str
[1] == '\0');
879 /* Append a non-ASCII character to RESULT. */
881 append_hex_encoded (std::string
&result
, uint32_t one_char
)
883 if (one_char
<= 0xff)
886 result
.append (phex (one_char
, 1));
888 else if (one_char
<= 0xffff)
891 result
.append (phex (one_char
, 2));
895 result
.append ("WW");
896 result
.append (phex (one_char
, 4));
900 /* Return a string that is a copy of the data in STORAGE, with
901 non-ASCII characters replaced by the appropriate hex encoding. A
902 template is used because, for UTF-8, we actually want to work with
903 UTF-32 codepoints. */
906 copy_and_hex_encode (struct obstack
*storage
)
908 const T
*chars
= (T
*) obstack_base (storage
);
909 int num_chars
= obstack_object_size (storage
) / sizeof (T
);
911 for (int i
= 0; i
< num_chars
; ++i
)
913 if (chars
[i
] <= 0x7f)
915 /* The host character set has to be a superset of ASCII, as
916 are all the other character sets we can use. */
917 result
.push_back (chars
[i
]);
920 append_hex_encoded (result
, chars
[i
]);
925 /* The "encoded" form of DECODED, according to GNAT conventions. If
926 THROW_ERRORS, throw an error if invalid operator name is found.
927 Otherwise, return the empty string in that case. */
930 ada_encode_1 (const char *decoded
, bool throw_errors
)
935 std::string encoding_buffer
;
936 bool saw_non_ascii
= false;
937 for (const char *p
= decoded
; *p
!= '\0'; p
+= 1)
939 if ((*p
& 0x80) != 0)
940 saw_non_ascii
= true;
943 encoding_buffer
.append ("__");
944 else if (*p
== '[' && is_compiler_suffix (p
))
946 encoding_buffer
= encoding_buffer
+ "." + (p
+ 1);
947 if (encoding_buffer
.back () == ']')
948 encoding_buffer
.pop_back ();
953 const struct ada_opname_map
*mapping
;
955 for (mapping
= ada_opname_table
;
956 mapping
->encoded
!= NULL
957 && !startswith (p
, mapping
->decoded
); mapping
+= 1)
959 if (mapping
->encoded
== NULL
)
962 error (_("invalid Ada operator name: %s"), p
);
966 encoding_buffer
.append (mapping
->encoded
);
970 encoding_buffer
.push_back (*p
);
973 /* If a non-ASCII character is seen, we must convert it to the
974 appropriate hex form. As this is more expensive, we keep track
975 of whether it is even necessary. */
978 auto_obstack storage
;
979 bool is_utf8
= ada_source_charset
== ada_utf8
;
982 convert_between_encodings
984 is_utf8
? HOST_UTF32
: ada_source_charset
,
985 (const gdb_byte
*) encoding_buffer
.c_str (),
986 encoding_buffer
.length (), 1,
987 &storage
, translit_none
);
989 catch (const gdb_exception
&)
991 static bool warned
= false;
993 /* Converting to UTF-32 shouldn't fail, so if it doesn't, we
994 might like to know why. */
998 warning (_("charset conversion failure for '%s'.\n"
999 "You may have the wrong value for 'set ada source-charset'."),
1000 encoding_buffer
.c_str ());
1003 /* We don't try to recover from errors. */
1004 return encoding_buffer
;
1008 return copy_and_hex_encode
<uint32_t> (&storage
);
1009 return copy_and_hex_encode
<gdb_byte
> (&storage
);
1012 return encoding_buffer
;
1015 /* Find the entry for C in the case-folding table. Return nullptr if
1016 the entry does not cover C. */
1017 static const utf8_entry
*
1018 find_case_fold_entry (uint32_t c
)
1020 auto iter
= std::lower_bound (std::begin (ada_case_fold
),
1021 std::end (ada_case_fold
),
1023 if (iter
== std::end (ada_case_fold
)
1030 /* Return NAME folded to lower case, or, if surrounded by single
1031 quotes, unfolded, but with the quotes stripped away. If
1032 THROW_ON_ERROR is true, encoding failures will throw an exception
1033 rather than emitting a warning. Result good to next call. */
1036 ada_fold_name (gdb::string_view name
, bool throw_on_error
= false)
1038 static std::string fold_storage
;
1040 if (!name
.empty () && name
[0] == '\'')
1041 fold_storage
= gdb::to_string (name
.substr (1, name
.size () - 2));
1044 /* Why convert to UTF-32 and implement our own case-folding,
1045 rather than convert to wchar_t and use the platform's
1046 functions? I'm glad you asked.
1048 The main problem is that GNAT implements an unusual rule for
1049 case folding. For ASCII letters, letters in single-byte
1050 encodings (such as ISO-8859-*), and Unicode letters that fit
1051 in a single byte (i.e., code point is <= 0xff), the letter is
1052 folded to lower case. Other Unicode letters are folded to
1055 This rule means that the code must be able to examine the
1056 value of the character. And, some hosts do not use Unicode
1057 for wchar_t, so examining the value of such characters is
1059 auto_obstack storage
;
1062 convert_between_encodings
1063 (host_charset (), HOST_UTF32
,
1064 (const gdb_byte
*) name
.data (),
1066 &storage
, translit_none
);
1068 catch (const gdb_exception
&)
1073 static bool warned
= false;
1075 /* Converting to UTF-32 shouldn't fail, so if it doesn't, we
1076 might like to know why. */
1080 warning (_("could not convert '%s' from the host encoding (%s) to UTF-32.\n"
1081 "This normally should not happen, please file a bug report."),
1082 gdb::to_string (name
).c_str (), host_charset ());
1085 /* We don't try to recover from errors; just return the
1087 fold_storage
= gdb::to_string (name
);
1088 return fold_storage
.c_str ();
1091 bool is_utf8
= ada_source_charset
== ada_utf8
;
1092 uint32_t *chars
= (uint32_t *) obstack_base (&storage
);
1093 int num_chars
= obstack_object_size (&storage
) / sizeof (uint32_t);
1094 for (int i
= 0; i
< num_chars
; ++i
)
1096 const struct utf8_entry
*entry
= find_case_fold_entry (chars
[i
]);
1097 if (entry
!= nullptr)
1099 uint32_t low
= chars
[i
] + entry
->lower_delta
;
1100 if (!is_utf8
|| low
<= 0xff)
1103 chars
[i
] = chars
[i
] + entry
->upper_delta
;
1107 /* Now convert back to ordinary characters. */
1108 auto_obstack reconverted
;
1111 convert_between_encodings (HOST_UTF32
,
1113 (const gdb_byte
*) chars
,
1114 num_chars
* sizeof (uint32_t),
1118 obstack_1grow (&reconverted
, '\0');
1119 fold_storage
= std::string ((const char *) obstack_base (&reconverted
));
1121 catch (const gdb_exception
&)
1126 static bool warned
= false;
1128 /* Converting back from UTF-32 shouldn't normally fail, but
1129 there are some host encodings without upper/lower
1134 warning (_("could not convert the lower-cased variant of '%s'\n"
1135 "from UTF-32 to the host encoding (%s)."),
1136 gdb::to_string (name
).c_str (), host_charset ());
1139 /* We don't try to recover from errors; just return the
1141 fold_storage
= gdb::to_string (name
);
1145 return fold_storage
.c_str ();
1148 /* The "encoded" form of DECODED, according to GNAT conventions. */
1151 ada_encode (const char *decoded
)
1153 if (decoded
[0] != '<')
1154 decoded
= ada_fold_name (decoded
);
1155 return ada_encode_1 (decoded
, true);
1158 /* Return nonzero if C is either a digit or a lowercase alphabet character. */
1161 is_lower_alphanum (const char c
)
1163 return (isdigit (c
) || (isalpha (c
) && islower (c
)));
1166 /* ENCODED is the linkage name of a symbol and LEN contains its length.
1167 This function saves in LEN the length of that same symbol name but
1168 without either of these suffixes:
1174 These are suffixes introduced by the compiler for entities such as
1175 nested subprogram for instance, in order to avoid name clashes.
1176 They do not serve any purpose for the debugger. */
1179 ada_remove_trailing_digits (const char *encoded
, int *len
)
1181 if (*len
> 1 && isdigit (encoded
[*len
- 1]))
1185 while (i
> 0 && isdigit (encoded
[i
]))
1187 if (i
>= 0 && encoded
[i
] == '.')
1189 else if (i
>= 0 && encoded
[i
] == '$')
1191 else if (i
>= 2 && startswith (encoded
+ i
- 2, "___"))
1193 else if (i
>= 1 && startswith (encoded
+ i
- 1, "__"))
1198 /* Remove the suffix introduced by the compiler for protected object
1202 ada_remove_po_subprogram_suffix (const char *encoded
, int *len
)
1204 /* Remove trailing N. */
1206 /* Protected entry subprograms are broken into two
1207 separate subprograms: The first one is unprotected, and has
1208 a 'N' suffix; the second is the protected version, and has
1209 the 'P' suffix. The second calls the first one after handling
1210 the protection. Since the P subprograms are internally generated,
1211 we leave these names undecoded, giving the user a clue that this
1212 entity is internal. */
1215 && encoded
[*len
- 1] == 'N'
1216 && (isdigit (encoded
[*len
- 2]) || islower (encoded
[*len
- 2])))
1220 /* If ENCODED ends with a compiler-provided suffix (like ".cold"),
1221 then update *LEN to remove the suffix and return the offset of the
1222 character just past the ".". Otherwise, return -1. */
1225 remove_compiler_suffix (const char *encoded
, int *len
)
1227 int offset
= *len
- 1;
1228 while (offset
> 0 && isalpha (encoded
[offset
]))
1230 if (offset
> 0 && encoded
[offset
] == '.')
1238 /* Convert an ASCII hex string to a number. Reads exactly N
1239 characters from STR. Returns true on success, false if one of the
1240 digits was not a hex digit. */
1242 convert_hex (const char *str
, int n
, uint32_t *out
)
1244 uint32_t result
= 0;
1246 for (int i
= 0; i
< n
; ++i
)
1248 if (!isxdigit (str
[i
]))
1251 result
|= fromhex (str
[i
]);
1258 /* Convert a wide character from its ASCII hex representation in STR
1259 (consisting of exactly N characters) to the host encoding,
1260 appending the resulting bytes to OUT. If N==2 and the Ada source
1261 charset is not UTF-8, then hex refers to an encoding in the
1262 ADA_SOURCE_CHARSET; otherwise, use UTF-32. Return true on success.
1263 Return false and do not modify OUT on conversion failure. */
1265 convert_from_hex_encoded (std::string
&out
, const char *str
, int n
)
1269 if (!convert_hex (str
, n
, &value
))
1274 /* In the 'U' case, the hex digits encode the character in the
1275 Ada source charset. However, if the source charset is UTF-8,
1276 this really means it is a single-byte UTF-32 character. */
1277 if (n
== 2 && ada_source_charset
!= ada_utf8
)
1279 gdb_byte one_char
= (gdb_byte
) value
;
1281 convert_between_encodings (ada_source_charset
, host_charset (),
1283 sizeof (one_char
), sizeof (one_char
),
1284 &bytes
, translit_none
);
1287 convert_between_encodings (HOST_UTF32
, host_charset (),
1288 (const gdb_byte
*) &value
,
1289 sizeof (value
), sizeof (value
),
1290 &bytes
, translit_none
);
1291 obstack_1grow (&bytes
, '\0');
1292 out
.append ((const char *) obstack_base (&bytes
));
1294 catch (const gdb_exception
&)
1296 /* On failure, the caller will just let the encoded form
1297 through, which seems basically reasonable. */
1304 /* See ada-lang.h. */
1307 ada_decode (const char *encoded
, bool wrap
)
1313 std::string decoded
;
1316 /* With function descriptors on PPC64, the value of a symbol named
1317 ".FN", if it exists, is the entry point of the function "FN". */
1318 if (encoded
[0] == '.')
1321 /* The name of the Ada main procedure starts with "_ada_".
1322 This prefix is not part of the decoded name, so skip this part
1323 if we see this prefix. */
1324 if (startswith (encoded
, "_ada_"))
1326 /* The "___ghost_" prefix is used for ghost entities. Normally
1327 these aren't preserved but when they are, it's useful to see
1329 if (startswith (encoded
, "___ghost_"))
1332 /* If the name starts with '_', then it is not a properly encoded
1333 name, so do not attempt to decode it. Similarly, if the name
1334 starts with '<', the name should not be decoded. */
1335 if (encoded
[0] == '_' || encoded
[0] == '<')
1338 len0
= strlen (encoded
);
1340 suffix
= remove_compiler_suffix (encoded
, &len0
);
1342 ada_remove_trailing_digits (encoded
, &len0
);
1343 ada_remove_po_subprogram_suffix (encoded
, &len0
);
1345 /* Remove the ___X.* suffix if present. Do not forget to verify that
1346 the suffix is located before the current "end" of ENCODED. We want
1347 to avoid re-matching parts of ENCODED that have previously been
1348 marked as discarded (by decrementing LEN0). */
1349 p
= strstr (encoded
, "___");
1350 if (p
!= NULL
&& p
- encoded
< len0
- 3)
1358 /* Remove any trailing TKB suffix. It tells us that this symbol
1359 is for the body of a task, but that information does not actually
1360 appear in the decoded name. */
1362 if (len0
> 3 && startswith (encoded
+ len0
- 3, "TKB"))
1365 /* Remove any trailing TB suffix. The TB suffix is slightly different
1366 from the TKB suffix because it is used for non-anonymous task
1369 if (len0
> 2 && startswith (encoded
+ len0
- 2, "TB"))
1372 /* Remove trailing "B" suffixes. */
1373 /* FIXME: brobecker/2006-04-19: Not sure what this are used for... */
1375 if (len0
> 1 && startswith (encoded
+ len0
- 1, "B"))
1378 /* Remove trailing __{digit}+ or trailing ${digit}+. */
1380 if (len0
> 1 && isdigit (encoded
[len0
- 1]))
1383 while ((i
>= 0 && isdigit (encoded
[i
]))
1384 || (i
>= 1 && encoded
[i
] == '_' && isdigit (encoded
[i
- 1])))
1386 if (i
> 1 && encoded
[i
] == '_' && encoded
[i
- 1] == '_')
1388 else if (encoded
[i
] == '$')
1392 /* The first few characters that are not alphabetic are not part
1393 of any encoding we use, so we can copy them over verbatim. */
1395 for (i
= 0; i
< len0
&& !isalpha (encoded
[i
]); i
+= 1)
1396 decoded
.push_back (encoded
[i
]);
1401 /* Is this a symbol function? */
1402 if (at_start_name
&& encoded
[i
] == 'O')
1406 for (k
= 0; ada_opname_table
[k
].encoded
!= NULL
; k
+= 1)
1408 int op_len
= strlen (ada_opname_table
[k
].encoded
);
1409 if ((strncmp (ada_opname_table
[k
].encoded
+ 1, encoded
+ i
+ 1,
1411 && !isalnum (encoded
[i
+ op_len
]))
1413 decoded
.append (ada_opname_table
[k
].decoded
);
1419 if (ada_opname_table
[k
].encoded
!= NULL
)
1424 /* Replace "TK__" with "__", which will eventually be translated
1425 into "." (just below). */
1427 if (i
< len0
- 4 && startswith (encoded
+ i
, "TK__"))
1430 /* Replace "__B_{DIGITS}+__" sequences by "__", which will eventually
1431 be translated into "." (just below). These are internal names
1432 generated for anonymous blocks inside which our symbol is nested. */
1434 if (len0
- i
> 5 && encoded
[i
] == '_' && encoded
[i
+1] == '_'
1435 && encoded
[i
+2] == 'B' && encoded
[i
+3] == '_'
1436 && isdigit (encoded
[i
+4]))
1440 while (k
< len0
&& isdigit (encoded
[k
]))
1441 k
++; /* Skip any extra digit. */
1443 /* Double-check that the "__B_{DIGITS}+" sequence we found
1444 is indeed followed by "__". */
1445 if (len0
- k
> 2 && encoded
[k
] == '_' && encoded
[k
+1] == '_')
1449 /* Remove _E{DIGITS}+[sb] */
1451 /* Just as for protected object subprograms, there are 2 categories
1452 of subprograms created by the compiler for each entry. The first
1453 one implements the actual entry code, and has a suffix following
1454 the convention above; the second one implements the barrier and
1455 uses the same convention as above, except that the 'E' is replaced
1458 Just as above, we do not decode the name of barrier functions
1459 to give the user a clue that the code he is debugging has been
1460 internally generated. */
1462 if (len0
- i
> 3 && encoded
[i
] == '_' && encoded
[i
+1] == 'E'
1463 && isdigit (encoded
[i
+2]))
1467 while (k
< len0
&& isdigit (encoded
[k
]))
1471 && (encoded
[k
] == 'b' || encoded
[k
] == 's'))
1474 /* Just as an extra precaution, make sure that if this
1475 suffix is followed by anything else, it is a '_'.
1476 Otherwise, we matched this sequence by accident. */
1478 || (k
< len0
&& encoded
[k
] == '_'))
1483 /* Remove trailing "N" in [a-z0-9]+N__. The N is added by
1484 the GNAT front-end in protected object subprograms. */
1487 && encoded
[i
] == 'N' && encoded
[i
+1] == '_' && encoded
[i
+2] == '_')
1489 /* Backtrack a bit up until we reach either the begining of
1490 the encoded name, or "__". Make sure that we only find
1491 digits or lowercase characters. */
1492 const char *ptr
= encoded
+ i
- 1;
1494 while (ptr
>= encoded
&& is_lower_alphanum (ptr
[0]))
1497 || (ptr
> encoded
&& ptr
[0] == '_' && ptr
[-1] == '_'))
1501 if (i
< len0
+ 3 && encoded
[i
] == 'U' && isxdigit (encoded
[i
+ 1]))
1503 if (convert_from_hex_encoded (decoded
, &encoded
[i
+ 1], 2))
1509 else if (i
< len0
+ 5 && encoded
[i
] == 'W' && isxdigit (encoded
[i
+ 1]))
1511 if (convert_from_hex_encoded (decoded
, &encoded
[i
+ 1], 4))
1517 else if (i
< len0
+ 10 && encoded
[i
] == 'W' && encoded
[i
+ 1] == 'W'
1518 && isxdigit (encoded
[i
+ 2]))
1520 if (convert_from_hex_encoded (decoded
, &encoded
[i
+ 2], 8))
1527 if (encoded
[i
] == 'X' && i
!= 0 && isalnum (encoded
[i
- 1]))
1529 /* This is a X[bn]* sequence not separated from the previous
1530 part of the name with a non-alpha-numeric character (in other
1531 words, immediately following an alpha-numeric character), then
1532 verify that it is placed at the end of the encoded name. If
1533 not, then the encoding is not valid and we should abort the
1534 decoding. Otherwise, just skip it, it is used in body-nested
1538 while (i
< len0
&& (encoded
[i
] == 'b' || encoded
[i
] == 'n'));
1542 else if (i
< len0
- 2 && encoded
[i
] == '_' && encoded
[i
+ 1] == '_')
1544 /* Replace '__' by '.'. */
1545 decoded
.push_back ('.');
1551 /* It's a character part of the decoded name, so just copy it
1553 decoded
.push_back (encoded
[i
]);
1558 /* Decoded names should never contain any uppercase character.
1559 Double-check this, and abort the decoding if we find one. */
1561 for (i
= 0; i
< decoded
.length(); ++i
)
1562 if (isupper (decoded
[i
]) || decoded
[i
] == ' ')
1565 /* If the compiler added a suffix, append it now. */
1567 decoded
= decoded
+ "[" + &encoded
[suffix
] + "]";
1575 if (encoded
[0] == '<')
1578 decoded
= '<' + std::string(encoded
) + '>';
1582 /* Table for keeping permanent unique copies of decoded names. Once
1583 allocated, names in this table are never released. While this is a
1584 storage leak, it should not be significant unless there are massive
1585 changes in the set of decoded names in successive versions of a
1586 symbol table loaded during a single session. */
1587 static struct htab
*decoded_names_store
;
1589 /* Returns the decoded name of GSYMBOL, as for ada_decode, caching it
1590 in the language-specific part of GSYMBOL, if it has not been
1591 previously computed. Tries to save the decoded name in the same
1592 obstack as GSYMBOL, if possible, and otherwise on the heap (so that,
1593 in any case, the decoded symbol has a lifetime at least that of
1595 The GSYMBOL parameter is "mutable" in the C++ sense: logically
1596 const, but nevertheless modified to a semantically equivalent form
1597 when a decoded name is cached in it. */
1600 ada_decode_symbol (const struct general_symbol_info
*arg
)
1602 struct general_symbol_info
*gsymbol
= (struct general_symbol_info
*) arg
;
1603 const char **resultp
=
1604 &gsymbol
->language_specific
.demangled_name
;
1606 if (!gsymbol
->ada_mangled
)
1608 std::string decoded
= ada_decode (gsymbol
->linkage_name ());
1609 struct obstack
*obstack
= gsymbol
->language_specific
.obstack
;
1611 gsymbol
->ada_mangled
= 1;
1613 if (obstack
!= NULL
)
1614 *resultp
= obstack_strdup (obstack
, decoded
.c_str ());
1617 /* Sometimes, we can't find a corresponding objfile, in
1618 which case, we put the result on the heap. Since we only
1619 decode when needed, we hope this usually does not cause a
1620 significant memory leak (FIXME). */
1622 char **slot
= (char **) htab_find_slot (decoded_names_store
,
1623 decoded
.c_str (), INSERT
);
1626 *slot
= xstrdup (decoded
.c_str ());
1638 /* Assuming that INDEX_DESC_TYPE is an ___XA structure, a structure
1639 generated by the GNAT compiler to describe the index type used
1640 for each dimension of an array, check whether it follows the latest
1641 known encoding. If not, fix it up to conform to the latest encoding.
1642 Otherwise, do nothing. This function also does nothing if
1643 INDEX_DESC_TYPE is NULL.
1645 The GNAT encoding used to describe the array index type evolved a bit.
1646 Initially, the information would be provided through the name of each
1647 field of the structure type only, while the type of these fields was
1648 described as unspecified and irrelevant. The debugger was then expected
1649 to perform a global type lookup using the name of that field in order
1650 to get access to the full index type description. Because these global
1651 lookups can be very expensive, the encoding was later enhanced to make
1652 the global lookup unnecessary by defining the field type as being
1653 the full index type description.
1655 The purpose of this routine is to allow us to support older versions
1656 of the compiler by detecting the use of the older encoding, and by
1657 fixing up the INDEX_DESC_TYPE to follow the new one (at this point,
1658 we essentially replace each field's meaningless type by the associated
1662 ada_fixup_array_indexes_type (struct type
*index_desc_type
)
1666 if (index_desc_type
== NULL
)
1668 gdb_assert (index_desc_type
->num_fields () > 0);
1670 /* Check if INDEX_DESC_TYPE follows the older encoding (it is sufficient
1671 to check one field only, no need to check them all). If not, return
1674 If our INDEX_DESC_TYPE was generated using the older encoding,
1675 the field type should be a meaningless integer type whose name
1676 is not equal to the field name. */
1677 if (index_desc_type
->field (0).type ()->name () != NULL
1678 && strcmp (index_desc_type
->field (0).type ()->name (),
1679 index_desc_type
->field (0).name ()) == 0)
1682 /* Fixup each field of INDEX_DESC_TYPE. */
1683 for (i
= 0; i
< index_desc_type
->num_fields (); i
++)
1685 const char *name
= index_desc_type
->field (i
).name ();
1686 struct type
*raw_type
= ada_check_typedef (ada_find_any_type (name
));
1689 index_desc_type
->field (i
).set_type (raw_type
);
1693 /* The desc_* routines return primitive portions of array descriptors
1696 /* The descriptor or array type, if any, indicated by TYPE; removes
1697 level of indirection, if needed. */
1699 static struct type
*
1700 desc_base_type (struct type
*type
)
1704 type
= ada_check_typedef (type
);
1705 if (type
->code () == TYPE_CODE_TYPEDEF
)
1706 type
= ada_typedef_target_type (type
);
1709 && (type
->code () == TYPE_CODE_PTR
1710 || type
->code () == TYPE_CODE_REF
))
1711 return ada_check_typedef (TYPE_TARGET_TYPE (type
));
1716 /* True iff TYPE indicates a "thin" array pointer type. */
1719 is_thin_pntr (struct type
*type
)
1722 is_suffix (ada_type_name (desc_base_type (type
)), "___XUT")
1723 || is_suffix (ada_type_name (desc_base_type (type
)), "___XUT___XVE");
1726 /* The descriptor type for thin pointer type TYPE. */
1728 static struct type
*
1729 thin_descriptor_type (struct type
*type
)
1731 struct type
*base_type
= desc_base_type (type
);
1733 if (base_type
== NULL
)
1735 if (is_suffix (ada_type_name (base_type
), "___XVE"))
1739 struct type
*alt_type
= ada_find_parallel_type (base_type
, "___XVE");
1741 if (alt_type
== NULL
)
1748 /* A pointer to the array data for thin-pointer value VAL. */
1750 static struct value
*
1751 thin_data_pntr (struct value
*val
)
1753 struct type
*type
= ada_check_typedef (value_type (val
));
1754 struct type
*data_type
= desc_data_target_type (thin_descriptor_type (type
));
1756 data_type
= lookup_pointer_type (data_type
);
1758 if (type
->code () == TYPE_CODE_PTR
)
1759 return value_cast (data_type
, value_copy (val
));
1761 return value_from_longest (data_type
, value_address (val
));
1764 /* True iff TYPE indicates a "thick" array pointer type. */
1767 is_thick_pntr (struct type
*type
)
1769 type
= desc_base_type (type
);
1770 return (type
!= NULL
&& type
->code () == TYPE_CODE_STRUCT
1771 && lookup_struct_elt_type (type
, "P_BOUNDS", 1) != NULL
);
1774 /* If TYPE is the type of an array descriptor (fat or thin pointer) or a
1775 pointer to one, the type of its bounds data; otherwise, NULL. */
1777 static struct type
*
1778 desc_bounds_type (struct type
*type
)
1782 type
= desc_base_type (type
);
1786 else if (is_thin_pntr (type
))
1788 type
= thin_descriptor_type (type
);
1791 r
= lookup_struct_elt_type (type
, "BOUNDS", 1);
1793 return ada_check_typedef (r
);
1795 else if (type
->code () == TYPE_CODE_STRUCT
)
1797 r
= lookup_struct_elt_type (type
, "P_BOUNDS", 1);
1799 return ada_check_typedef (TYPE_TARGET_TYPE (ada_check_typedef (r
)));
1804 /* If ARR is an array descriptor (fat or thin pointer), or pointer to
1805 one, a pointer to its bounds data. Otherwise NULL. */
1807 static struct value
*
1808 desc_bounds (struct value
*arr
)
1810 struct type
*type
= ada_check_typedef (value_type (arr
));
1812 if (is_thin_pntr (type
))
1814 struct type
*bounds_type
=
1815 desc_bounds_type (thin_descriptor_type (type
));
1818 if (bounds_type
== NULL
)
1819 error (_("Bad GNAT array descriptor"));
1821 /* NOTE: The following calculation is not really kosher, but
1822 since desc_type is an XVE-encoded type (and shouldn't be),
1823 the correct calculation is a real pain. FIXME (and fix GCC). */
1824 if (type
->code () == TYPE_CODE_PTR
)
1825 addr
= value_as_long (arr
);
1827 addr
= value_address (arr
);
1830 value_from_longest (lookup_pointer_type (bounds_type
),
1831 addr
- TYPE_LENGTH (bounds_type
));
1834 else if (is_thick_pntr (type
))
1836 struct value
*p_bounds
= value_struct_elt (&arr
, {}, "P_BOUNDS", NULL
,
1837 _("Bad GNAT array descriptor"));
1838 struct type
*p_bounds_type
= value_type (p_bounds
);
1841 && p_bounds_type
->code () == TYPE_CODE_PTR
)
1843 struct type
*target_type
= TYPE_TARGET_TYPE (p_bounds_type
);
1845 if (target_type
->is_stub ())
1846 p_bounds
= value_cast (lookup_pointer_type
1847 (ada_check_typedef (target_type
)),
1851 error (_("Bad GNAT array descriptor"));
1859 /* If TYPE is the type of an array-descriptor (fat pointer), the bit
1860 position of the field containing the address of the bounds data. */
1863 fat_pntr_bounds_bitpos (struct type
*type
)
1865 return desc_base_type (type
)->field (1).loc_bitpos ();
1868 /* If TYPE is the type of an array-descriptor (fat pointer), the bit
1869 size of the field containing the address of the bounds data. */
1872 fat_pntr_bounds_bitsize (struct type
*type
)
1874 type
= desc_base_type (type
);
1876 if (TYPE_FIELD_BITSIZE (type
, 1) > 0)
1877 return TYPE_FIELD_BITSIZE (type
, 1);
1879 return 8 * TYPE_LENGTH (ada_check_typedef (type
->field (1).type ()));
1882 /* If TYPE is the type of an array descriptor (fat or thin pointer) or a
1883 pointer to one, the type of its array data (a array-with-no-bounds type);
1884 otherwise, NULL. Use ada_type_of_array to get an array type with bounds
1887 static struct type
*
1888 desc_data_target_type (struct type
*type
)
1890 type
= desc_base_type (type
);
1892 /* NOTE: The following is bogus; see comment in desc_bounds. */
1893 if (is_thin_pntr (type
))
1894 return desc_base_type (thin_descriptor_type (type
)->field (1).type ());
1895 else if (is_thick_pntr (type
))
1897 struct type
*data_type
= lookup_struct_elt_type (type
, "P_ARRAY", 1);
1900 && ada_check_typedef (data_type
)->code () == TYPE_CODE_PTR
)
1901 return ada_check_typedef (TYPE_TARGET_TYPE (data_type
));
1907 /* If ARR is an array descriptor (fat or thin pointer), a pointer to
1910 static struct value
*
1911 desc_data (struct value
*arr
)
1913 struct type
*type
= value_type (arr
);
1915 if (is_thin_pntr (type
))
1916 return thin_data_pntr (arr
);
1917 else if (is_thick_pntr (type
))
1918 return value_struct_elt (&arr
, {}, "P_ARRAY", NULL
,
1919 _("Bad GNAT array descriptor"));
1925 /* If TYPE is the type of an array-descriptor (fat pointer), the bit
1926 position of the field containing the address of the data. */
1929 fat_pntr_data_bitpos (struct type
*type
)
1931 return desc_base_type (type
)->field (0).loc_bitpos ();
1934 /* If TYPE is the type of an array-descriptor (fat pointer), the bit
1935 size of the field containing the address of the data. */
1938 fat_pntr_data_bitsize (struct type
*type
)
1940 type
= desc_base_type (type
);
1942 if (TYPE_FIELD_BITSIZE (type
, 0) > 0)
1943 return TYPE_FIELD_BITSIZE (type
, 0);
1945 return TARGET_CHAR_BIT
* TYPE_LENGTH (type
->field (0).type ());
1948 /* If BOUNDS is an array-bounds structure (or pointer to one), return
1949 the Ith lower bound stored in it, if WHICH is 0, and the Ith upper
1950 bound, if WHICH is 1. The first bound is I=1. */
1952 static struct value
*
1953 desc_one_bound (struct value
*bounds
, int i
, int which
)
1955 char bound_name
[20];
1956 xsnprintf (bound_name
, sizeof (bound_name
), "%cB%d",
1957 which
? 'U' : 'L', i
- 1);
1958 return value_struct_elt (&bounds
, {}, bound_name
, NULL
,
1959 _("Bad GNAT array descriptor bounds"));
1962 /* If BOUNDS is an array-bounds structure type, return the bit position
1963 of the Ith lower bound stored in it, if WHICH is 0, and the Ith upper
1964 bound, if WHICH is 1. The first bound is I=1. */
1967 desc_bound_bitpos (struct type
*type
, int i
, int which
)
1969 return desc_base_type (type
)->field (2 * i
+ which
- 2).loc_bitpos ();
1972 /* If BOUNDS is an array-bounds structure type, return the bit field size
1973 of the Ith lower bound stored in it, if WHICH is 0, and the Ith upper
1974 bound, if WHICH is 1. The first bound is I=1. */
1977 desc_bound_bitsize (struct type
*type
, int i
, int which
)
1979 type
= desc_base_type (type
);
1981 if (TYPE_FIELD_BITSIZE (type
, 2 * i
+ which
- 2) > 0)
1982 return TYPE_FIELD_BITSIZE (type
, 2 * i
+ which
- 2);
1984 return 8 * TYPE_LENGTH (type
->field (2 * i
+ which
- 2).type ());
1987 /* If TYPE is the type of an array-bounds structure, the type of its
1988 Ith bound (numbering from 1). Otherwise, NULL. */
1990 static struct type
*
1991 desc_index_type (struct type
*type
, int i
)
1993 type
= desc_base_type (type
);
1995 if (type
->code () == TYPE_CODE_STRUCT
)
1997 char bound_name
[20];
1998 xsnprintf (bound_name
, sizeof (bound_name
), "LB%d", i
- 1);
1999 return lookup_struct_elt_type (type
, bound_name
, 1);
2005 /* The number of index positions in the array-bounds type TYPE.
2006 Return 0 if TYPE is NULL. */
2009 desc_arity (struct type
*type
)
2011 type
= desc_base_type (type
);
2014 return type
->num_fields () / 2;
2018 /* Non-zero iff TYPE is a simple array type (not a pointer to one) or
2019 an array descriptor type (representing an unconstrained array
2023 ada_is_direct_array_type (struct type
*type
)
2027 type
= ada_check_typedef (type
);
2028 return (type
->code () == TYPE_CODE_ARRAY
2029 || ada_is_array_descriptor_type (type
));
2032 /* Non-zero iff TYPE represents any kind of array in Ada, or a pointer
2036 ada_is_array_type (struct type
*type
)
2039 && (type
->code () == TYPE_CODE_PTR
2040 || type
->code () == TYPE_CODE_REF
))
2041 type
= TYPE_TARGET_TYPE (type
);
2042 return ada_is_direct_array_type (type
);
2045 /* Non-zero iff TYPE is a simple array type or pointer to one. */
2048 ada_is_simple_array_type (struct type
*type
)
2052 type
= ada_check_typedef (type
);
2053 return (type
->code () == TYPE_CODE_ARRAY
2054 || (type
->code () == TYPE_CODE_PTR
2055 && (ada_check_typedef (TYPE_TARGET_TYPE (type
))->code ()
2056 == TYPE_CODE_ARRAY
)));
2059 /* Non-zero iff TYPE belongs to a GNAT array descriptor. */
2062 ada_is_array_descriptor_type (struct type
*type
)
2064 struct type
*data_type
= desc_data_target_type (type
);
2068 type
= ada_check_typedef (type
);
2069 return (data_type
!= NULL
2070 && data_type
->code () == TYPE_CODE_ARRAY
2071 && desc_arity (desc_bounds_type (type
)) > 0);
2074 /* Non-zero iff type is a partially mal-formed GNAT array
2075 descriptor. FIXME: This is to compensate for some problems with
2076 debugging output from GNAT. Re-examine periodically to see if it
2080 ada_is_bogus_array_descriptor (struct type
*type
)
2084 && type
->code () == TYPE_CODE_STRUCT
2085 && (lookup_struct_elt_type (type
, "P_BOUNDS", 1) != NULL
2086 || lookup_struct_elt_type (type
, "P_ARRAY", 1) != NULL
)
2087 && !ada_is_array_descriptor_type (type
);
2091 /* If ARR has a record type in the form of a standard GNAT array descriptor,
2092 (fat pointer) returns the type of the array data described---specifically,
2093 a pointer-to-array type. If BOUNDS is non-zero, the bounds data are filled
2094 in from the descriptor; otherwise, they are left unspecified. If
2095 the ARR denotes a null array descriptor and BOUNDS is non-zero,
2096 returns NULL. The result is simply the type of ARR if ARR is not
2099 static struct type
*
2100 ada_type_of_array (struct value
*arr
, int bounds
)
2102 if (ada_is_constrained_packed_array_type (value_type (arr
)))
2103 return decode_constrained_packed_array_type (value_type (arr
));
2105 if (!ada_is_array_descriptor_type (value_type (arr
)))
2106 return value_type (arr
);
2110 struct type
*array_type
=
2111 ada_check_typedef (desc_data_target_type (value_type (arr
)));
2113 if (ada_is_unconstrained_packed_array_type (value_type (arr
)))
2114 TYPE_FIELD_BITSIZE (array_type
, 0) =
2115 decode_packed_array_bitsize (value_type (arr
));
2121 struct type
*elt_type
;
2123 struct value
*descriptor
;
2125 elt_type
= ada_array_element_type (value_type (arr
), -1);
2126 arity
= ada_array_arity (value_type (arr
));
2128 if (elt_type
== NULL
|| arity
== 0)
2129 return ada_check_typedef (value_type (arr
));
2131 descriptor
= desc_bounds (arr
);
2132 if (value_as_long (descriptor
) == 0)
2136 struct type
*range_type
= alloc_type_copy (value_type (arr
));
2137 struct type
*array_type
= alloc_type_copy (value_type (arr
));
2138 struct value
*low
= desc_one_bound (descriptor
, arity
, 0);
2139 struct value
*high
= desc_one_bound (descriptor
, arity
, 1);
2142 create_static_range_type (range_type
, value_type (low
),
2143 longest_to_int (value_as_long (low
)),
2144 longest_to_int (value_as_long (high
)));
2145 elt_type
= create_array_type (array_type
, elt_type
, range_type
);
2147 if (ada_is_unconstrained_packed_array_type (value_type (arr
)))
2149 /* We need to store the element packed bitsize, as well as
2150 recompute the array size, because it was previously
2151 computed based on the unpacked element size. */
2152 LONGEST lo
= value_as_long (low
);
2153 LONGEST hi
= value_as_long (high
);
2155 TYPE_FIELD_BITSIZE (elt_type
, 0) =
2156 decode_packed_array_bitsize (value_type (arr
));
2157 /* If the array has no element, then the size is already
2158 zero, and does not need to be recomputed. */
2162 (hi
- lo
+ 1) * TYPE_FIELD_BITSIZE (elt_type
, 0);
2164 TYPE_LENGTH (array_type
) = (array_bitsize
+ 7) / 8;
2169 return lookup_pointer_type (elt_type
);
2173 /* If ARR does not represent an array, returns ARR unchanged.
2174 Otherwise, returns either a standard GDB array with bounds set
2175 appropriately or, if ARR is a non-null fat pointer, a pointer to a standard
2176 GDB array. Returns NULL if ARR is a null fat pointer. */
2179 ada_coerce_to_simple_array_ptr (struct value
*arr
)
2181 if (ada_is_array_descriptor_type (value_type (arr
)))
2183 struct type
*arrType
= ada_type_of_array (arr
, 1);
2185 if (arrType
== NULL
)
2187 return value_cast (arrType
, value_copy (desc_data (arr
)));
2189 else if (ada_is_constrained_packed_array_type (value_type (arr
)))
2190 return decode_constrained_packed_array (arr
);
2195 /* If ARR does not represent an array, returns ARR unchanged.
2196 Otherwise, returns a standard GDB array describing ARR (which may
2197 be ARR itself if it already is in the proper form). */
2200 ada_coerce_to_simple_array (struct value
*arr
)
2202 if (ada_is_array_descriptor_type (value_type (arr
)))
2204 struct value
*arrVal
= ada_coerce_to_simple_array_ptr (arr
);
2207 error (_("Bounds unavailable for null array pointer."));
2208 return value_ind (arrVal
);
2210 else if (ada_is_constrained_packed_array_type (value_type (arr
)))
2211 return decode_constrained_packed_array (arr
);
2216 /* If TYPE represents a GNAT array type, return it translated to an
2217 ordinary GDB array type (possibly with BITSIZE fields indicating
2218 packing). For other types, is the identity. */
2221 ada_coerce_to_simple_array_type (struct type
*type
)
2223 if (ada_is_constrained_packed_array_type (type
))
2224 return decode_constrained_packed_array_type (type
);
2226 if (ada_is_array_descriptor_type (type
))
2227 return ada_check_typedef (desc_data_target_type (type
));
2232 /* Non-zero iff TYPE represents a standard GNAT packed-array type. */
2235 ada_is_gnat_encoded_packed_array_type (struct type
*type
)
2239 type
= desc_base_type (type
);
2240 type
= ada_check_typedef (type
);
2242 ada_type_name (type
) != NULL
2243 && strstr (ada_type_name (type
), "___XP") != NULL
;
2246 /* Non-zero iff TYPE represents a standard GNAT constrained
2247 packed-array type. */
2250 ada_is_constrained_packed_array_type (struct type
*type
)
2252 return ada_is_gnat_encoded_packed_array_type (type
)
2253 && !ada_is_array_descriptor_type (type
);
2256 /* Non-zero iff TYPE represents an array descriptor for a
2257 unconstrained packed-array type. */
2260 ada_is_unconstrained_packed_array_type (struct type
*type
)
2262 if (!ada_is_array_descriptor_type (type
))
2265 if (ada_is_gnat_encoded_packed_array_type (type
))
2268 /* If we saw GNAT encodings, then the above code is sufficient.
2269 However, with minimal encodings, we will just have a thick
2271 if (is_thick_pntr (type
))
2273 type
= desc_base_type (type
);
2274 /* The structure's first field is a pointer to an array, so this
2275 fetches the array type. */
2276 type
= TYPE_TARGET_TYPE (type
->field (0).type ());
2277 if (type
->code () == TYPE_CODE_TYPEDEF
)
2278 type
= ada_typedef_target_type (type
);
2279 /* Now we can see if the array elements are packed. */
2280 return TYPE_FIELD_BITSIZE (type
, 0) > 0;
2286 /* Return true if TYPE is a (Gnat-encoded) constrained packed array
2287 type, or if it is an ordinary (non-Gnat-encoded) packed array. */
2290 ada_is_any_packed_array_type (struct type
*type
)
2292 return (ada_is_constrained_packed_array_type (type
)
2293 || (type
->code () == TYPE_CODE_ARRAY
2294 && TYPE_FIELD_BITSIZE (type
, 0) % 8 != 0));
2297 /* Given that TYPE encodes a packed array type (constrained or unconstrained),
2298 return the size of its elements in bits. */
2301 decode_packed_array_bitsize (struct type
*type
)
2303 const char *raw_name
;
2307 /* Access to arrays implemented as fat pointers are encoded as a typedef
2308 of the fat pointer type. We need the name of the fat pointer type
2309 to do the decoding, so strip the typedef layer. */
2310 if (type
->code () == TYPE_CODE_TYPEDEF
)
2311 type
= ada_typedef_target_type (type
);
2313 raw_name
= ada_type_name (ada_check_typedef (type
));
2315 raw_name
= ada_type_name (desc_base_type (type
));
2320 tail
= strstr (raw_name
, "___XP");
2321 if (tail
== nullptr)
2323 gdb_assert (is_thick_pntr (type
));
2324 /* The structure's first field is a pointer to an array, so this
2325 fetches the array type. */
2326 type
= TYPE_TARGET_TYPE (type
->field (0).type ());
2327 /* Now we can see if the array elements are packed. */
2328 return TYPE_FIELD_BITSIZE (type
, 0);
2331 if (sscanf (tail
+ sizeof ("___XP") - 1, "%ld", &bits
) != 1)
2334 (_("could not understand bit size information on packed array"));
2341 /* Given that TYPE is a standard GDB array type with all bounds filled
2342 in, and that the element size of its ultimate scalar constituents
2343 (that is, either its elements, or, if it is an array of arrays, its
2344 elements' elements, etc.) is *ELT_BITS, return an identical type,
2345 but with the bit sizes of its elements (and those of any
2346 constituent arrays) recorded in the BITSIZE components of its
2347 TYPE_FIELD_BITSIZE values, and with *ELT_BITS set to its total size
2350 Note that, for arrays whose index type has an XA encoding where
2351 a bound references a record discriminant, getting that discriminant,
2352 and therefore the actual value of that bound, is not possible
2353 because none of the given parameters gives us access to the record.
2354 This function assumes that it is OK in the context where it is being
2355 used to return an array whose bounds are still dynamic and where
2356 the length is arbitrary. */
2358 static struct type
*
2359 constrained_packed_array_type (struct type
*type
, long *elt_bits
)
2361 struct type
*new_elt_type
;
2362 struct type
*new_type
;
2363 struct type
*index_type_desc
;
2364 struct type
*index_type
;
2365 LONGEST low_bound
, high_bound
;
2367 type
= ada_check_typedef (type
);
2368 if (type
->code () != TYPE_CODE_ARRAY
)
2371 index_type_desc
= ada_find_parallel_type (type
, "___XA");
2372 if (index_type_desc
)
2373 index_type
= to_fixed_range_type (index_type_desc
->field (0).type (),
2376 index_type
= type
->index_type ();
2378 new_type
= alloc_type_copy (type
);
2380 constrained_packed_array_type (ada_check_typedef (TYPE_TARGET_TYPE (type
)),
2382 create_array_type (new_type
, new_elt_type
, index_type
);
2383 TYPE_FIELD_BITSIZE (new_type
, 0) = *elt_bits
;
2384 new_type
->set_name (ada_type_name (type
));
2386 if ((check_typedef (index_type
)->code () == TYPE_CODE_RANGE
2387 && is_dynamic_type (check_typedef (index_type
)))
2388 || !get_discrete_bounds (index_type
, &low_bound
, &high_bound
))
2389 low_bound
= high_bound
= 0;
2390 if (high_bound
< low_bound
)
2391 *elt_bits
= TYPE_LENGTH (new_type
) = 0;
2394 *elt_bits
*= (high_bound
- low_bound
+ 1);
2395 TYPE_LENGTH (new_type
) =
2396 (*elt_bits
+ HOST_CHAR_BIT
- 1) / HOST_CHAR_BIT
;
2399 new_type
->set_is_fixed_instance (true);
2403 /* The array type encoded by TYPE, where
2404 ada_is_constrained_packed_array_type (TYPE). */
2406 static struct type
*
2407 decode_constrained_packed_array_type (struct type
*type
)
2409 const char *raw_name
= ada_type_name (ada_check_typedef (type
));
2412 struct type
*shadow_type
;
2416 raw_name
= ada_type_name (desc_base_type (type
));
2421 name
= (char *) alloca (strlen (raw_name
) + 1);
2422 tail
= strstr (raw_name
, "___XP");
2423 type
= desc_base_type (type
);
2425 memcpy (name
, raw_name
, tail
- raw_name
);
2426 name
[tail
- raw_name
] = '\000';
2428 shadow_type
= ada_find_parallel_type_with_name (type
, name
);
2430 if (shadow_type
== NULL
)
2432 lim_warning (_("could not find bounds information on packed array"));
2435 shadow_type
= check_typedef (shadow_type
);
2437 if (shadow_type
->code () != TYPE_CODE_ARRAY
)
2439 lim_warning (_("could not understand bounds "
2440 "information on packed array"));
2444 bits
= decode_packed_array_bitsize (type
);
2445 return constrained_packed_array_type (shadow_type
, &bits
);
2448 /* Helper function for decode_constrained_packed_array. Set the field
2449 bitsize on a series of packed arrays. Returns the number of
2450 elements in TYPE. */
2453 recursively_update_array_bitsize (struct type
*type
)
2455 gdb_assert (type
->code () == TYPE_CODE_ARRAY
);
2458 if (!get_discrete_bounds (type
->index_type (), &low
, &high
)
2461 LONGEST our_len
= high
- low
+ 1;
2463 struct type
*elt_type
= TYPE_TARGET_TYPE (type
);
2464 if (elt_type
->code () == TYPE_CODE_ARRAY
)
2466 LONGEST elt_len
= recursively_update_array_bitsize (elt_type
);
2467 LONGEST elt_bitsize
= elt_len
* TYPE_FIELD_BITSIZE (elt_type
, 0);
2468 TYPE_FIELD_BITSIZE (type
, 0) = elt_bitsize
;
2470 TYPE_LENGTH (type
) = ((our_len
* elt_bitsize
+ HOST_CHAR_BIT
- 1)
2477 /* Given that ARR is a struct value *indicating a GNAT constrained packed
2478 array, returns a simple array that denotes that array. Its type is a
2479 standard GDB array type except that the BITSIZEs of the array
2480 target types are set to the number of bits in each element, and the
2481 type length is set appropriately. */
2483 static struct value
*
2484 decode_constrained_packed_array (struct value
*arr
)
2488 /* If our value is a pointer, then dereference it. Likewise if
2489 the value is a reference. Make sure that this operation does not
2490 cause the target type to be fixed, as this would indirectly cause
2491 this array to be decoded. The rest of the routine assumes that
2492 the array hasn't been decoded yet, so we use the basic "coerce_ref"
2493 and "value_ind" routines to perform the dereferencing, as opposed
2494 to using "ada_coerce_ref" or "ada_value_ind". */
2495 arr
= coerce_ref (arr
);
2496 if (ada_check_typedef (value_type (arr
))->code () == TYPE_CODE_PTR
)
2497 arr
= value_ind (arr
);
2499 type
= decode_constrained_packed_array_type (value_type (arr
));
2502 error (_("can't unpack array"));
2506 /* Decoding the packed array type could not correctly set the field
2507 bitsizes for any dimension except the innermost, because the
2508 bounds may be variable and were not passed to that function. So,
2509 we further resolve the array bounds here and then update the
2511 const gdb_byte
*valaddr
= value_contents_for_printing (arr
).data ();
2512 CORE_ADDR address
= value_address (arr
);
2513 gdb::array_view
<const gdb_byte
> view
2514 = gdb::make_array_view (valaddr
, TYPE_LENGTH (type
));
2515 type
= resolve_dynamic_type (type
, view
, address
);
2516 recursively_update_array_bitsize (type
);
2518 if (type_byte_order (value_type (arr
)) == BFD_ENDIAN_BIG
2519 && ada_is_modular_type (value_type (arr
)))
2521 /* This is a (right-justified) modular type representing a packed
2522 array with no wrapper. In order to interpret the value through
2523 the (left-justified) packed array type we just built, we must
2524 first left-justify it. */
2525 int bit_size
, bit_pos
;
2528 mod
= ada_modulus (value_type (arr
)) - 1;
2535 bit_pos
= HOST_CHAR_BIT
* TYPE_LENGTH (value_type (arr
)) - bit_size
;
2536 arr
= ada_value_primitive_packed_val (arr
, NULL
,
2537 bit_pos
/ HOST_CHAR_BIT
,
2538 bit_pos
% HOST_CHAR_BIT
,
2543 return coerce_unspec_val_to_type (arr
, type
);
2547 /* The value of the element of packed array ARR at the ARITY indices
2548 given in IND. ARR must be a simple array. */
2550 static struct value
*
2551 value_subscript_packed (struct value
*arr
, int arity
, struct value
**ind
)
2554 int bits
, elt_off
, bit_off
;
2555 long elt_total_bit_offset
;
2556 struct type
*elt_type
;
2560 elt_total_bit_offset
= 0;
2561 elt_type
= ada_check_typedef (value_type (arr
));
2562 for (i
= 0; i
< arity
; i
+= 1)
2564 if (elt_type
->code () != TYPE_CODE_ARRAY
2565 || TYPE_FIELD_BITSIZE (elt_type
, 0) == 0)
2567 (_("attempt to do packed indexing of "
2568 "something other than a packed array"));
2571 struct type
*range_type
= elt_type
->index_type ();
2572 LONGEST lowerbound
, upperbound
;
2575 if (!get_discrete_bounds (range_type
, &lowerbound
, &upperbound
))
2577 lim_warning (_("don't know bounds of array"));
2578 lowerbound
= upperbound
= 0;
2581 idx
= pos_atr (ind
[i
]);
2582 if (idx
< lowerbound
|| idx
> upperbound
)
2583 lim_warning (_("packed array index %ld out of bounds"),
2585 bits
= TYPE_FIELD_BITSIZE (elt_type
, 0);
2586 elt_total_bit_offset
+= (idx
- lowerbound
) * bits
;
2587 elt_type
= ada_check_typedef (TYPE_TARGET_TYPE (elt_type
));
2590 elt_off
= elt_total_bit_offset
/ HOST_CHAR_BIT
;
2591 bit_off
= elt_total_bit_offset
% HOST_CHAR_BIT
;
2593 v
= ada_value_primitive_packed_val (arr
, NULL
, elt_off
, bit_off
,
2598 /* Non-zero iff TYPE includes negative integer values. */
2601 has_negatives (struct type
*type
)
2603 switch (type
->code ())
2608 return !type
->is_unsigned ();
2609 case TYPE_CODE_RANGE
:
2610 return type
->bounds ()->low
.const_val () - type
->bounds ()->bias
< 0;
2614 /* With SRC being a buffer containing BIT_SIZE bits of data at BIT_OFFSET,
2615 unpack that data into UNPACKED. UNPACKED_LEN is the size in bytes of
2616 the unpacked buffer.
2618 The size of the unpacked buffer (UNPACKED_LEN) is expected to be large
2619 enough to contain at least BIT_OFFSET bits. If not, an error is raised.
2621 IS_BIG_ENDIAN is nonzero if the data is stored in big endian mode,
2624 IS_SIGNED_TYPE is nonzero if the data corresponds to a signed type.
2626 IS_SCALAR is nonzero if the data corresponds to a signed type. */
2629 ada_unpack_from_contents (const gdb_byte
*src
, int bit_offset
, int bit_size
,
2630 gdb_byte
*unpacked
, int unpacked_len
,
2631 int is_big_endian
, int is_signed_type
,
2634 int src_len
= (bit_size
+ bit_offset
+ HOST_CHAR_BIT
- 1) / 8;
2635 int src_idx
; /* Index into the source area */
2636 int src_bytes_left
; /* Number of source bytes left to process. */
2637 int srcBitsLeft
; /* Number of source bits left to move */
2638 int unusedLS
; /* Number of bits in next significant
2639 byte of source that are unused */
2641 int unpacked_idx
; /* Index into the unpacked buffer */
2642 int unpacked_bytes_left
; /* Number of bytes left to set in unpacked. */
2644 unsigned long accum
; /* Staging area for bits being transferred */
2645 int accumSize
; /* Number of meaningful bits in accum */
2648 /* Transmit bytes from least to most significant; delta is the direction
2649 the indices move. */
2650 int delta
= is_big_endian
? -1 : 1;
2652 /* Make sure that unpacked is large enough to receive the BIT_SIZE
2654 if ((bit_size
+ HOST_CHAR_BIT
- 1) / HOST_CHAR_BIT
> unpacked_len
)
2655 error (_("Cannot unpack %d bits into buffer of %d bytes"),
2656 bit_size
, unpacked_len
);
2658 srcBitsLeft
= bit_size
;
2659 src_bytes_left
= src_len
;
2660 unpacked_bytes_left
= unpacked_len
;
2665 src_idx
= src_len
- 1;
2667 && ((src
[0] << bit_offset
) & (1 << (HOST_CHAR_BIT
- 1))))
2671 (HOST_CHAR_BIT
- (bit_size
+ bit_offset
) % HOST_CHAR_BIT
)
2677 unpacked_idx
= unpacked_len
- 1;
2681 /* Non-scalar values must be aligned at a byte boundary... */
2683 (HOST_CHAR_BIT
- bit_size
% HOST_CHAR_BIT
) % HOST_CHAR_BIT
;
2684 /* ... And are placed at the beginning (most-significant) bytes
2686 unpacked_idx
= (bit_size
+ HOST_CHAR_BIT
- 1) / HOST_CHAR_BIT
- 1;
2687 unpacked_bytes_left
= unpacked_idx
+ 1;
2692 int sign_bit_offset
= (bit_size
+ bit_offset
- 1) % 8;
2694 src_idx
= unpacked_idx
= 0;
2695 unusedLS
= bit_offset
;
2698 if (is_signed_type
&& (src
[src_len
- 1] & (1 << sign_bit_offset
)))
2703 while (src_bytes_left
> 0)
2705 /* Mask for removing bits of the next source byte that are not
2706 part of the value. */
2707 unsigned int unusedMSMask
=
2708 (1 << (srcBitsLeft
>= HOST_CHAR_BIT
? HOST_CHAR_BIT
: srcBitsLeft
)) -
2710 /* Sign-extend bits for this byte. */
2711 unsigned int signMask
= sign
& ~unusedMSMask
;
2714 (((src
[src_idx
] >> unusedLS
) & unusedMSMask
) | signMask
) << accumSize
;
2715 accumSize
+= HOST_CHAR_BIT
- unusedLS
;
2716 if (accumSize
>= HOST_CHAR_BIT
)
2718 unpacked
[unpacked_idx
] = accum
& ~(~0UL << HOST_CHAR_BIT
);
2719 accumSize
-= HOST_CHAR_BIT
;
2720 accum
>>= HOST_CHAR_BIT
;
2721 unpacked_bytes_left
-= 1;
2722 unpacked_idx
+= delta
;
2724 srcBitsLeft
-= HOST_CHAR_BIT
- unusedLS
;
2726 src_bytes_left
-= 1;
2729 while (unpacked_bytes_left
> 0)
2731 accum
|= sign
<< accumSize
;
2732 unpacked
[unpacked_idx
] = accum
& ~(~0UL << HOST_CHAR_BIT
);
2733 accumSize
-= HOST_CHAR_BIT
;
2736 accum
>>= HOST_CHAR_BIT
;
2737 unpacked_bytes_left
-= 1;
2738 unpacked_idx
+= delta
;
2742 /* Create a new value of type TYPE from the contents of OBJ starting
2743 at byte OFFSET, and bit offset BIT_OFFSET within that byte,
2744 proceeding for BIT_SIZE bits. If OBJ is an lval in memory, then
2745 assigning through the result will set the field fetched from.
2746 VALADDR is ignored unless OBJ is NULL, in which case,
2747 VALADDR+OFFSET must address the start of storage containing the
2748 packed value. The value returned in this case is never an lval.
2749 Assumes 0 <= BIT_OFFSET < HOST_CHAR_BIT. */
2752 ada_value_primitive_packed_val (struct value
*obj
, const gdb_byte
*valaddr
,
2753 long offset
, int bit_offset
, int bit_size
,
2757 const gdb_byte
*src
; /* First byte containing data to unpack */
2759 const int is_scalar
= is_scalar_type (type
);
2760 const int is_big_endian
= type_byte_order (type
) == BFD_ENDIAN_BIG
;
2761 gdb::byte_vector staging
;
2763 type
= ada_check_typedef (type
);
2766 src
= valaddr
+ offset
;
2768 src
= value_contents (obj
).data () + offset
;
2770 if (is_dynamic_type (type
))
2772 /* The length of TYPE might by dynamic, so we need to resolve
2773 TYPE in order to know its actual size, which we then use
2774 to create the contents buffer of the value we return.
2775 The difficulty is that the data containing our object is
2776 packed, and therefore maybe not at a byte boundary. So, what
2777 we do, is unpack the data into a byte-aligned buffer, and then
2778 use that buffer as our object's value for resolving the type. */
2779 int staging_len
= (bit_size
+ HOST_CHAR_BIT
- 1) / HOST_CHAR_BIT
;
2780 staging
.resize (staging_len
);
2782 ada_unpack_from_contents (src
, bit_offset
, bit_size
,
2783 staging
.data (), staging
.size (),
2784 is_big_endian
, has_negatives (type
),
2786 type
= resolve_dynamic_type (type
, staging
, 0);
2787 if (TYPE_LENGTH (type
) < (bit_size
+ HOST_CHAR_BIT
- 1) / HOST_CHAR_BIT
)
2789 /* This happens when the length of the object is dynamic,
2790 and is actually smaller than the space reserved for it.
2791 For instance, in an array of variant records, the bit_size
2792 we're given is the array stride, which is constant and
2793 normally equal to the maximum size of its element.
2794 But, in reality, each element only actually spans a portion
2796 bit_size
= TYPE_LENGTH (type
) * HOST_CHAR_BIT
;
2802 v
= allocate_value (type
);
2803 src
= valaddr
+ offset
;
2805 else if (VALUE_LVAL (obj
) == lval_memory
&& value_lazy (obj
))
2807 int src_len
= (bit_size
+ bit_offset
+ HOST_CHAR_BIT
- 1) / 8;
2810 v
= value_at (type
, value_address (obj
) + offset
);
2811 buf
= (gdb_byte
*) alloca (src_len
);
2812 read_memory (value_address (v
), buf
, src_len
);
2817 v
= allocate_value (type
);
2818 src
= value_contents (obj
).data () + offset
;
2823 long new_offset
= offset
;
2825 set_value_component_location (v
, obj
);
2826 set_value_bitpos (v
, bit_offset
+ value_bitpos (obj
));
2827 set_value_bitsize (v
, bit_size
);
2828 if (value_bitpos (v
) >= HOST_CHAR_BIT
)
2831 set_value_bitpos (v
, value_bitpos (v
) - HOST_CHAR_BIT
);
2833 set_value_offset (v
, new_offset
);
2835 /* Also set the parent value. This is needed when trying to
2836 assign a new value (in inferior memory). */
2837 set_value_parent (v
, obj
);
2840 set_value_bitsize (v
, bit_size
);
2841 unpacked
= value_contents_writeable (v
).data ();
2845 memset (unpacked
, 0, TYPE_LENGTH (type
));
2849 if (staging
.size () == TYPE_LENGTH (type
))
2851 /* Small short-cut: If we've unpacked the data into a buffer
2852 of the same size as TYPE's length, then we can reuse that,
2853 instead of doing the unpacking again. */
2854 memcpy (unpacked
, staging
.data (), staging
.size ());
2857 ada_unpack_from_contents (src
, bit_offset
, bit_size
,
2858 unpacked
, TYPE_LENGTH (type
),
2859 is_big_endian
, has_negatives (type
), is_scalar
);
2864 /* Store the contents of FROMVAL into the location of TOVAL.
2865 Return a new value with the location of TOVAL and contents of
2866 FROMVAL. Handles assignment into packed fields that have
2867 floating-point or non-scalar types. */
2869 static struct value
*
2870 ada_value_assign (struct value
*toval
, struct value
*fromval
)
2872 struct type
*type
= value_type (toval
);
2873 int bits
= value_bitsize (toval
);
2875 toval
= ada_coerce_ref (toval
);
2876 fromval
= ada_coerce_ref (fromval
);
2878 if (ada_is_direct_array_type (value_type (toval
)))
2879 toval
= ada_coerce_to_simple_array (toval
);
2880 if (ada_is_direct_array_type (value_type (fromval
)))
2881 fromval
= ada_coerce_to_simple_array (fromval
);
2883 if (!deprecated_value_modifiable (toval
))
2884 error (_("Left operand of assignment is not a modifiable lvalue."));
2886 if (VALUE_LVAL (toval
) == lval_memory
2888 && (type
->code () == TYPE_CODE_FLT
2889 || type
->code () == TYPE_CODE_STRUCT
))
2891 int len
= (value_bitpos (toval
)
2892 + bits
+ HOST_CHAR_BIT
- 1) / HOST_CHAR_BIT
;
2894 gdb_byte
*buffer
= (gdb_byte
*) alloca (len
);
2896 CORE_ADDR to_addr
= value_address (toval
);
2898 if (type
->code () == TYPE_CODE_FLT
)
2899 fromval
= value_cast (type
, fromval
);
2901 read_memory (to_addr
, buffer
, len
);
2902 from_size
= value_bitsize (fromval
);
2904 from_size
= TYPE_LENGTH (value_type (fromval
)) * TARGET_CHAR_BIT
;
2906 const int is_big_endian
= type_byte_order (type
) == BFD_ENDIAN_BIG
;
2907 ULONGEST from_offset
= 0;
2908 if (is_big_endian
&& is_scalar_type (value_type (fromval
)))
2909 from_offset
= from_size
- bits
;
2910 copy_bitwise (buffer
, value_bitpos (toval
),
2911 value_contents (fromval
).data (), from_offset
,
2912 bits
, is_big_endian
);
2913 write_memory_with_notification (to_addr
, buffer
, len
);
2915 val
= value_copy (toval
);
2916 memcpy (value_contents_raw (val
).data (),
2917 value_contents (fromval
).data (),
2918 TYPE_LENGTH (type
));
2919 deprecated_set_value_type (val
, type
);
2924 return value_assign (toval
, fromval
);
2928 /* Given that COMPONENT is a memory lvalue that is part of the lvalue
2929 CONTAINER, assign the contents of VAL to COMPONENTS's place in
2930 CONTAINER. Modifies the VALUE_CONTENTS of CONTAINER only, not
2931 COMPONENT, and not the inferior's memory. The current contents
2932 of COMPONENT are ignored.
2934 Although not part of the initial design, this function also works
2935 when CONTAINER and COMPONENT are not_lval's: it works as if CONTAINER
2936 had a null address, and COMPONENT had an address which is equal to
2937 its offset inside CONTAINER. */
2940 value_assign_to_component (struct value
*container
, struct value
*component
,
2943 LONGEST offset_in_container
=
2944 (LONGEST
) (value_address (component
) - value_address (container
));
2945 int bit_offset_in_container
=
2946 value_bitpos (component
) - value_bitpos (container
);
2949 val
= value_cast (value_type (component
), val
);
2951 if (value_bitsize (component
) == 0)
2952 bits
= TARGET_CHAR_BIT
* TYPE_LENGTH (value_type (component
));
2954 bits
= value_bitsize (component
);
2956 if (type_byte_order (value_type (container
)) == BFD_ENDIAN_BIG
)
2960 if (is_scalar_type (check_typedef (value_type (component
))))
2962 = TYPE_LENGTH (value_type (component
)) * TARGET_CHAR_BIT
- bits
;
2965 copy_bitwise ((value_contents_writeable (container
).data ()
2966 + offset_in_container
),
2967 value_bitpos (container
) + bit_offset_in_container
,
2968 value_contents (val
).data (), src_offset
, bits
, 1);
2971 copy_bitwise ((value_contents_writeable (container
).data ()
2972 + offset_in_container
),
2973 value_bitpos (container
) + bit_offset_in_container
,
2974 value_contents (val
).data (), 0, bits
, 0);
2977 /* Determine if TYPE is an access to an unconstrained array. */
2980 ada_is_access_to_unconstrained_array (struct type
*type
)
2982 return (type
->code () == TYPE_CODE_TYPEDEF
2983 && is_thick_pntr (ada_typedef_target_type (type
)));
2986 /* The value of the element of array ARR at the ARITY indices given in IND.
2987 ARR may be either a simple array, GNAT array descriptor, or pointer
2991 ada_value_subscript (struct value
*arr
, int arity
, struct value
**ind
)
2995 struct type
*elt_type
;
2997 elt
= ada_coerce_to_simple_array (arr
);
2999 elt_type
= ada_check_typedef (value_type (elt
));
3000 if (elt_type
->code () == TYPE_CODE_ARRAY
3001 && TYPE_FIELD_BITSIZE (elt_type
, 0) > 0)
3002 return value_subscript_packed (elt
, arity
, ind
);
3004 for (k
= 0; k
< arity
; k
+= 1)
3006 struct type
*saved_elt_type
= TYPE_TARGET_TYPE (elt_type
);
3008 if (elt_type
->code () != TYPE_CODE_ARRAY
)
3009 error (_("too many subscripts (%d expected)"), k
);
3011 elt
= value_subscript (elt
, pos_atr (ind
[k
]));
3013 if (ada_is_access_to_unconstrained_array (saved_elt_type
)
3014 && value_type (elt
)->code () != TYPE_CODE_TYPEDEF
)
3016 /* The element is a typedef to an unconstrained array,
3017 except that the value_subscript call stripped the
3018 typedef layer. The typedef layer is GNAT's way to
3019 specify that the element is, at the source level, an
3020 access to the unconstrained array, rather than the
3021 unconstrained array. So, we need to restore that
3022 typedef layer, which we can do by forcing the element's
3023 type back to its original type. Otherwise, the returned
3024 value is going to be printed as the array, rather
3025 than as an access. Another symptom of the same issue
3026 would be that an expression trying to dereference the
3027 element would also be improperly rejected. */
3028 deprecated_set_value_type (elt
, saved_elt_type
);
3031 elt_type
= ada_check_typedef (value_type (elt
));
3037 /* Assuming ARR is a pointer to a GDB array, the value of the element
3038 of *ARR at the ARITY indices given in IND.
3039 Does not read the entire array into memory.
3041 Note: Unlike what one would expect, this function is used instead of
3042 ada_value_subscript for basically all non-packed array types. The reason
3043 for this is that a side effect of doing our own pointer arithmetics instead
3044 of relying on value_subscript is that there is no implicit typedef peeling.
3045 This is important for arrays of array accesses, where it allows us to
3046 preserve the fact that the array's element is an array access, where the
3047 access part os encoded in a typedef layer. */
3049 static struct value
*
3050 ada_value_ptr_subscript (struct value
*arr
, int arity
, struct value
**ind
)
3053 struct value
*array_ind
= ada_value_ind (arr
);
3055 = check_typedef (value_enclosing_type (array_ind
));
3057 if (type
->code () == TYPE_CODE_ARRAY
3058 && TYPE_FIELD_BITSIZE (type
, 0) > 0)
3059 return value_subscript_packed (array_ind
, arity
, ind
);
3061 for (k
= 0; k
< arity
; k
+= 1)
3065 if (type
->code () != TYPE_CODE_ARRAY
)
3066 error (_("too many subscripts (%d expected)"), k
);
3067 arr
= value_cast (lookup_pointer_type (TYPE_TARGET_TYPE (type
)),
3069 get_discrete_bounds (type
->index_type (), &lwb
, &upb
);
3070 arr
= value_ptradd (arr
, pos_atr (ind
[k
]) - lwb
);
3071 type
= TYPE_TARGET_TYPE (type
);
3074 return value_ind (arr
);
3077 /* Given that ARRAY_PTR is a pointer or reference to an array of type TYPE (the
3078 actual type of ARRAY_PTR is ignored), returns the Ada slice of
3079 HIGH'Pos-LOW'Pos+1 elements starting at index LOW. The lower bound of
3080 this array is LOW, as per Ada rules. */
3081 static struct value
*
3082 ada_value_slice_from_ptr (struct value
*array_ptr
, struct type
*type
,
3085 struct type
*type0
= ada_check_typedef (type
);
3086 struct type
*base_index_type
= TYPE_TARGET_TYPE (type0
->index_type ());
3087 struct type
*index_type
3088 = create_static_range_type (NULL
, base_index_type
, low
, high
);
3089 struct type
*slice_type
= create_array_type_with_stride
3090 (NULL
, TYPE_TARGET_TYPE (type0
), index_type
,
3091 type0
->dyn_prop (DYN_PROP_BYTE_STRIDE
),
3092 TYPE_FIELD_BITSIZE (type0
, 0));
3093 int base_low
= ada_discrete_type_low_bound (type0
->index_type ());
3094 gdb::optional
<LONGEST
> base_low_pos
, low_pos
;
3097 low_pos
= discrete_position (base_index_type
, low
);
3098 base_low_pos
= discrete_position (base_index_type
, base_low
);
3100 if (!low_pos
.has_value () || !base_low_pos
.has_value ())
3102 warning (_("unable to get positions in slice, use bounds instead"));
3104 base_low_pos
= base_low
;
3107 ULONGEST stride
= TYPE_FIELD_BITSIZE (slice_type
, 0) / 8;
3109 stride
= TYPE_LENGTH (TYPE_TARGET_TYPE (type0
));
3111 base
= value_as_address (array_ptr
) + (*low_pos
- *base_low_pos
) * stride
;
3112 return value_at_lazy (slice_type
, base
);
3116 static struct value
*
3117 ada_value_slice (struct value
*array
, int low
, int high
)
3119 struct type
*type
= ada_check_typedef (value_type (array
));
3120 struct type
*base_index_type
= TYPE_TARGET_TYPE (type
->index_type ());
3121 struct type
*index_type
3122 = create_static_range_type (NULL
, type
->index_type (), low
, high
);
3123 struct type
*slice_type
= create_array_type_with_stride
3124 (NULL
, TYPE_TARGET_TYPE (type
), index_type
,
3125 type
->dyn_prop (DYN_PROP_BYTE_STRIDE
),
3126 TYPE_FIELD_BITSIZE (type
, 0));
3127 gdb::optional
<LONGEST
> low_pos
, high_pos
;
3130 low_pos
= discrete_position (base_index_type
, low
);
3131 high_pos
= discrete_position (base_index_type
, high
);
3133 if (!low_pos
.has_value () || !high_pos
.has_value ())
3135 warning (_("unable to get positions in slice, use bounds instead"));
3140 return value_cast (slice_type
,
3141 value_slice (array
, low
, *high_pos
- *low_pos
+ 1));
3144 /* If type is a record type in the form of a standard GNAT array
3145 descriptor, returns the number of dimensions for type. If arr is a
3146 simple array, returns the number of "array of"s that prefix its
3147 type designation. Otherwise, returns 0. */
3150 ada_array_arity (struct type
*type
)
3157 type
= desc_base_type (type
);
3160 if (type
->code () == TYPE_CODE_STRUCT
)
3161 return desc_arity (desc_bounds_type (type
));
3163 while (type
->code () == TYPE_CODE_ARRAY
)
3166 type
= ada_check_typedef (TYPE_TARGET_TYPE (type
));
3172 /* If TYPE is a record type in the form of a standard GNAT array
3173 descriptor or a simple array type, returns the element type for
3174 TYPE after indexing by NINDICES indices, or by all indices if
3175 NINDICES is -1. Otherwise, returns NULL. */
3178 ada_array_element_type (struct type
*type
, int nindices
)
3180 type
= desc_base_type (type
);
3182 if (type
->code () == TYPE_CODE_STRUCT
)
3185 struct type
*p_array_type
;
3187 p_array_type
= desc_data_target_type (type
);
3189 k
= ada_array_arity (type
);
3193 /* Initially p_array_type = elt_type(*)[]...(k times)...[]. */
3194 if (nindices
>= 0 && k
> nindices
)
3196 while (k
> 0 && p_array_type
!= NULL
)
3198 p_array_type
= ada_check_typedef (TYPE_TARGET_TYPE (p_array_type
));
3201 return p_array_type
;
3203 else if (type
->code () == TYPE_CODE_ARRAY
)
3205 while (nindices
!= 0 && type
->code () == TYPE_CODE_ARRAY
)
3207 type
= TYPE_TARGET_TYPE (type
);
3216 /* See ada-lang.h. */
3219 ada_index_type (struct type
*type
, int n
, const char *name
)
3221 struct type
*result_type
;
3223 type
= desc_base_type (type
);
3225 if (n
< 0 || n
> ada_array_arity (type
))
3226 error (_("invalid dimension number to '%s"), name
);
3228 if (ada_is_simple_array_type (type
))
3232 for (i
= 1; i
< n
; i
+= 1)
3234 type
= ada_check_typedef (type
);
3235 type
= TYPE_TARGET_TYPE (type
);
3237 result_type
= TYPE_TARGET_TYPE (ada_check_typedef (type
)->index_type ());
3238 /* FIXME: The stabs type r(0,0);bound;bound in an array type
3239 has a target type of TYPE_CODE_UNDEF. We compensate here, but
3240 perhaps stabsread.c would make more sense. */
3241 if (result_type
&& result_type
->code () == TYPE_CODE_UNDEF
)
3246 result_type
= desc_index_type (desc_bounds_type (type
), n
);
3247 if (result_type
== NULL
)
3248 error (_("attempt to take bound of something that is not an array"));
3254 /* Given that arr is an array type, returns the lower bound of the
3255 Nth index (numbering from 1) if WHICH is 0, and the upper bound if
3256 WHICH is 1. This returns bounds 0 .. -1 if ARR_TYPE is an
3257 array-descriptor type. It works for other arrays with bounds supplied
3258 by run-time quantities other than discriminants. */
3261 ada_array_bound_from_type (struct type
*arr_type
, int n
, int which
)
3263 struct type
*type
, *index_type_desc
, *index_type
;
3266 gdb_assert (which
== 0 || which
== 1);
3268 if (ada_is_constrained_packed_array_type (arr_type
))
3269 arr_type
= decode_constrained_packed_array_type (arr_type
);
3271 if (arr_type
== NULL
|| !ada_is_simple_array_type (arr_type
))
3272 return (LONGEST
) - which
;
3274 if (arr_type
->code () == TYPE_CODE_PTR
)
3275 type
= TYPE_TARGET_TYPE (arr_type
);
3279 if (type
->is_fixed_instance ())
3281 /* The array has already been fixed, so we do not need to
3282 check the parallel ___XA type again. That encoding has
3283 already been applied, so ignore it now. */
3284 index_type_desc
= NULL
;
3288 index_type_desc
= ada_find_parallel_type (type
, "___XA");
3289 ada_fixup_array_indexes_type (index_type_desc
);
3292 if (index_type_desc
!= NULL
)
3293 index_type
= to_fixed_range_type (index_type_desc
->field (n
- 1).type (),
3297 struct type
*elt_type
= check_typedef (type
);
3299 for (i
= 1; i
< n
; i
++)
3300 elt_type
= check_typedef (TYPE_TARGET_TYPE (elt_type
));
3302 index_type
= elt_type
->index_type ();
3306 (LONGEST
) (which
== 0
3307 ? ada_discrete_type_low_bound (index_type
)
3308 : ada_discrete_type_high_bound (index_type
));
3311 /* Given that arr is an array value, returns the lower bound of the
3312 nth index (numbering from 1) if WHICH is 0, and the upper bound if
3313 WHICH is 1. This routine will also work for arrays with bounds
3314 supplied by run-time quantities other than discriminants. */
3317 ada_array_bound (struct value
*arr
, int n
, int which
)
3319 struct type
*arr_type
;
3321 if (check_typedef (value_type (arr
))->code () == TYPE_CODE_PTR
)
3322 arr
= value_ind (arr
);
3323 arr_type
= value_enclosing_type (arr
);
3325 if (ada_is_constrained_packed_array_type (arr_type
))
3326 return ada_array_bound (decode_constrained_packed_array (arr
), n
, which
);
3327 else if (ada_is_simple_array_type (arr_type
))
3328 return ada_array_bound_from_type (arr_type
, n
, which
);
3330 return value_as_long (desc_one_bound (desc_bounds (arr
), n
, which
));
3333 /* Given that arr is an array value, returns the length of the
3334 nth index. This routine will also work for arrays with bounds
3335 supplied by run-time quantities other than discriminants.
3336 Does not work for arrays indexed by enumeration types with representation
3337 clauses at the moment. */
3340 ada_array_length (struct value
*arr
, int n
)
3342 struct type
*arr_type
, *index_type
;
3345 if (check_typedef (value_type (arr
))->code () == TYPE_CODE_PTR
)
3346 arr
= value_ind (arr
);
3347 arr_type
= value_enclosing_type (arr
);
3349 if (ada_is_constrained_packed_array_type (arr_type
))
3350 return ada_array_length (decode_constrained_packed_array (arr
), n
);
3352 if (ada_is_simple_array_type (arr_type
))
3354 low
= ada_array_bound_from_type (arr_type
, n
, 0);
3355 high
= ada_array_bound_from_type (arr_type
, n
, 1);
3359 low
= value_as_long (desc_one_bound (desc_bounds (arr
), n
, 0));
3360 high
= value_as_long (desc_one_bound (desc_bounds (arr
), n
, 1));
3363 arr_type
= check_typedef (arr_type
);
3364 index_type
= ada_index_type (arr_type
, n
, "length");
3365 if (index_type
!= NULL
)
3367 struct type
*base_type
;
3368 if (index_type
->code () == TYPE_CODE_RANGE
)
3369 base_type
= TYPE_TARGET_TYPE (index_type
);
3371 base_type
= index_type
;
3373 low
= pos_atr (value_from_longest (base_type
, low
));
3374 high
= pos_atr (value_from_longest (base_type
, high
));
3376 return high
- low
+ 1;
3379 /* An array whose type is that of ARR_TYPE (an array type), with
3380 bounds LOW to HIGH, but whose contents are unimportant. If HIGH is
3381 less than LOW, then LOW-1 is used. */
3383 static struct value
*
3384 empty_array (struct type
*arr_type
, int low
, int high
)
3386 struct type
*arr_type0
= ada_check_typedef (arr_type
);
3387 struct type
*index_type
3388 = create_static_range_type
3389 (NULL
, TYPE_TARGET_TYPE (arr_type0
->index_type ()), low
,
3390 high
< low
? low
- 1 : high
);
3391 struct type
*elt_type
= ada_array_element_type (arr_type0
, 1);
3393 return allocate_value (create_array_type (NULL
, elt_type
, index_type
));
3397 /* Name resolution */
3399 /* The "decoded" name for the user-definable Ada operator corresponding
3403 ada_decoded_op_name (enum exp_opcode op
)
3407 for (i
= 0; ada_opname_table
[i
].encoded
!= NULL
; i
+= 1)
3409 if (ada_opname_table
[i
].op
== op
)
3410 return ada_opname_table
[i
].decoded
;
3412 error (_("Could not find operator name for opcode"));
3415 /* Returns true (non-zero) iff decoded name N0 should appear before N1
3416 in a listing of choices during disambiguation (see sort_choices, below).
3417 The idea is that overloadings of a subprogram name from the
3418 same package should sort in their source order. We settle for ordering
3419 such symbols by their trailing number (__N or $N). */
3422 encoded_ordered_before (const char *N0
, const char *N1
)
3426 else if (N0
== NULL
)
3432 for (k0
= strlen (N0
) - 1; k0
> 0 && isdigit (N0
[k0
]); k0
-= 1)
3434 for (k1
= strlen (N1
) - 1; k1
> 0 && isdigit (N1
[k1
]); k1
-= 1)
3436 if ((N0
[k0
] == '_' || N0
[k0
] == '$') && N0
[k0
+ 1] != '\000'
3437 && (N1
[k1
] == '_' || N1
[k1
] == '$') && N1
[k1
+ 1] != '\000')
3442 while (N0
[n0
] == '_' && n0
> 0 && N0
[n0
- 1] == '_')
3445 while (N1
[n1
] == '_' && n1
> 0 && N1
[n1
- 1] == '_')
3447 if (n0
== n1
&& strncmp (N0
, N1
, n0
) == 0)
3448 return (atoi (N0
+ k0
+ 1) < atoi (N1
+ k1
+ 1));
3450 return (strcmp (N0
, N1
) < 0);
3454 /* Sort SYMS[0..NSYMS-1] to put the choices in a canonical order by the
3458 sort_choices (struct block_symbol syms
[], int nsyms
)
3462 for (i
= 1; i
< nsyms
; i
+= 1)
3464 struct block_symbol sym
= syms
[i
];
3467 for (j
= i
- 1; j
>= 0; j
-= 1)
3469 if (encoded_ordered_before (syms
[j
].symbol
->linkage_name (),
3470 sym
.symbol
->linkage_name ()))
3472 syms
[j
+ 1] = syms
[j
];
3478 /* Whether GDB should display formals and return types for functions in the
3479 overloads selection menu. */
3480 static bool print_signatures
= true;
3482 /* Print the signature for SYM on STREAM according to the FLAGS options. For
3483 all but functions, the signature is just the name of the symbol. For
3484 functions, this is the name of the function, the list of types for formals
3485 and the return type (if any). */
3488 ada_print_symbol_signature (struct ui_file
*stream
, struct symbol
*sym
,
3489 const struct type_print_options
*flags
)
3491 struct type
*type
= sym
->type ();
3493 gdb_printf (stream
, "%s", sym
->print_name ());
3494 if (!print_signatures
3496 || type
->code () != TYPE_CODE_FUNC
)
3499 if (type
->num_fields () > 0)
3503 gdb_printf (stream
, " (");
3504 for (i
= 0; i
< type
->num_fields (); ++i
)
3507 gdb_printf (stream
, "; ");
3508 ada_print_type (type
->field (i
).type (), NULL
, stream
, -1, 0,
3511 gdb_printf (stream
, ")");
3513 if (TYPE_TARGET_TYPE (type
) != NULL
3514 && TYPE_TARGET_TYPE (type
)->code () != TYPE_CODE_VOID
)
3516 gdb_printf (stream
, " return ");
3517 ada_print_type (TYPE_TARGET_TYPE (type
), NULL
, stream
, -1, 0, flags
);
3521 /* Read and validate a set of numeric choices from the user in the
3522 range 0 .. N_CHOICES-1. Place the results in increasing
3523 order in CHOICES[0 .. N-1], and return N.
3525 The user types choices as a sequence of numbers on one line
3526 separated by blanks, encoding them as follows:
3528 + A choice of 0 means to cancel the selection, throwing an error.
3529 + If IS_ALL_CHOICE, a choice of 1 selects the entire set 0 .. N_CHOICES-1.
3530 + The user chooses k by typing k+IS_ALL_CHOICE+1.
3532 The user is not allowed to choose more than MAX_RESULTS values.
3534 ANNOTATION_SUFFIX, if present, is used to annotate the input
3535 prompts (for use with the -f switch). */
3538 get_selections (int *choices
, int n_choices
, int max_results
,
3539 int is_all_choice
, const char *annotation_suffix
)
3544 int first_choice
= is_all_choice
? 2 : 1;
3546 prompt
= getenv ("PS2");
3550 args
= command_line_input (prompt
, annotation_suffix
);
3553 error_no_arg (_("one or more choice numbers"));
3557 /* Set choices[0 .. n_chosen-1] to the users' choices in ascending
3558 order, as given in args. Choices are validated. */
3564 args
= skip_spaces (args
);
3565 if (*args
== '\0' && n_chosen
== 0)
3566 error_no_arg (_("one or more choice numbers"));
3567 else if (*args
== '\0')
3570 choice
= strtol (args
, &args2
, 10);
3571 if (args
== args2
|| choice
< 0
3572 || choice
> n_choices
+ first_choice
- 1)
3573 error (_("Argument must be choice number"));
3577 error (_("cancelled"));
3579 if (choice
< first_choice
)
3581 n_chosen
= n_choices
;
3582 for (j
= 0; j
< n_choices
; j
+= 1)
3586 choice
-= first_choice
;
3588 for (j
= n_chosen
- 1; j
>= 0 && choice
< choices
[j
]; j
-= 1)
3592 if (j
< 0 || choice
!= choices
[j
])
3596 for (k
= n_chosen
- 1; k
> j
; k
-= 1)
3597 choices
[k
+ 1] = choices
[k
];
3598 choices
[j
+ 1] = choice
;
3603 if (n_chosen
> max_results
)
3604 error (_("Select no more than %d of the above"), max_results
);
3609 /* Given a list of NSYMS symbols in SYMS, select up to MAX_RESULTS>0
3610 by asking the user (if necessary), returning the number selected,
3611 and setting the first elements of SYMS items. Error if no symbols
3614 /* NOTE: Adapted from decode_line_2 in symtab.c, with which it ought
3615 to be re-integrated one of these days. */
3618 user_select_syms (struct block_symbol
*syms
, int nsyms
, int max_results
)
3621 int *chosen
= XALLOCAVEC (int , nsyms
);
3623 int first_choice
= (max_results
== 1) ? 1 : 2;
3624 const char *select_mode
= multiple_symbols_select_mode ();
3626 if (max_results
< 1)
3627 error (_("Request to select 0 symbols!"));
3631 if (select_mode
== multiple_symbols_cancel
)
3633 canceled because the command is ambiguous\n\
3634 See set/show multiple-symbol."));
3636 /* If select_mode is "all", then return all possible symbols.
3637 Only do that if more than one symbol can be selected, of course.
3638 Otherwise, display the menu as usual. */
3639 if (select_mode
== multiple_symbols_all
&& max_results
> 1)
3642 gdb_printf (_("[0] cancel\n"));
3643 if (max_results
> 1)
3644 gdb_printf (_("[1] all\n"));
3646 sort_choices (syms
, nsyms
);
3648 for (i
= 0; i
< nsyms
; i
+= 1)
3650 if (syms
[i
].symbol
== NULL
)
3653 if (syms
[i
].symbol
->aclass () == LOC_BLOCK
)
3655 struct symtab_and_line sal
=
3656 find_function_start_sal (syms
[i
].symbol
, 1);
3658 gdb_printf ("[%d] ", i
+ first_choice
);
3659 ada_print_symbol_signature (gdb_stdout
, syms
[i
].symbol
,
3660 &type_print_raw_options
);
3661 if (sal
.symtab
== NULL
)
3662 gdb_printf (_(" at %p[<no source file available>%p]:%d\n"),
3663 metadata_style
.style ().ptr (), nullptr, sal
.line
);
3667 styled_string (file_name_style
.style (),
3668 symtab_to_filename_for_display (sal
.symtab
)),
3675 (syms
[i
].symbol
->aclass () == LOC_CONST
3676 && syms
[i
].symbol
->type () != NULL
3677 && syms
[i
].symbol
->type ()->code () == TYPE_CODE_ENUM
);
3678 struct symtab
*symtab
= NULL
;
3680 if (syms
[i
].symbol
->is_objfile_owned ())
3681 symtab
= symbol_symtab (syms
[i
].symbol
);
3683 if (syms
[i
].symbol
->line () != 0 && symtab
!= NULL
)
3685 gdb_printf ("[%d] ", i
+ first_choice
);
3686 ada_print_symbol_signature (gdb_stdout
, syms
[i
].symbol
,
3687 &type_print_raw_options
);
3688 gdb_printf (_(" at %s:%d\n"),
3689 symtab_to_filename_for_display (symtab
),
3690 syms
[i
].symbol
->line ());
3692 else if (is_enumeral
3693 && syms
[i
].symbol
->type ()->name () != NULL
)
3695 gdb_printf (("[%d] "), i
+ first_choice
);
3696 ada_print_type (syms
[i
].symbol
->type (), NULL
,
3697 gdb_stdout
, -1, 0, &type_print_raw_options
);
3698 gdb_printf (_("'(%s) (enumeral)\n"),
3699 syms
[i
].symbol
->print_name ());
3703 gdb_printf ("[%d] ", i
+ first_choice
);
3704 ada_print_symbol_signature (gdb_stdout
, syms
[i
].symbol
,
3705 &type_print_raw_options
);
3708 gdb_printf (is_enumeral
3709 ? _(" in %s (enumeral)\n")
3711 symtab_to_filename_for_display (symtab
));
3713 gdb_printf (is_enumeral
3714 ? _(" (enumeral)\n")
3720 n_chosen
= get_selections (chosen
, nsyms
, max_results
, max_results
> 1,
3723 for (i
= 0; i
< n_chosen
; i
+= 1)
3724 syms
[i
] = syms
[chosen
[i
]];
3729 /* See ada-lang.h. */
3732 ada_find_operator_symbol (enum exp_opcode op
, bool parse_completion
,
3733 int nargs
, value
*argvec
[])
3735 if (possible_user_operator_p (op
, argvec
))
3737 std::vector
<struct block_symbol
> candidates
3738 = ada_lookup_symbol_list (ada_decoded_op_name (op
),
3741 int i
= ada_resolve_function (candidates
, argvec
,
3742 nargs
, ada_decoded_op_name (op
), NULL
,
3745 return candidates
[i
];
3750 /* See ada-lang.h. */
3753 ada_resolve_funcall (struct symbol
*sym
, const struct block
*block
,
3754 struct type
*context_type
,
3755 bool parse_completion
,
3756 int nargs
, value
*argvec
[],
3757 innermost_block_tracker
*tracker
)
3759 std::vector
<struct block_symbol
> candidates
3760 = ada_lookup_symbol_list (sym
->linkage_name (), block
, VAR_DOMAIN
);
3763 if (candidates
.size () == 1)
3767 i
= ada_resolve_function
3770 sym
->linkage_name (),
3771 context_type
, parse_completion
);
3773 error (_("Could not find a match for %s"), sym
->print_name ());
3776 tracker
->update (candidates
[i
]);
3777 return candidates
[i
];
3780 /* Resolve a mention of a name where the context type is an
3781 enumeration type. */
3784 ada_resolve_enum (std::vector
<struct block_symbol
> &syms
,
3785 const char *name
, struct type
*context_type
,
3786 bool parse_completion
)
3788 gdb_assert (context_type
->code () == TYPE_CODE_ENUM
);
3789 context_type
= ada_check_typedef (context_type
);
3791 for (int i
= 0; i
< syms
.size (); ++i
)
3793 /* We already know the name matches, so we're just looking for
3794 an element of the correct enum type. */
3795 if (ada_check_typedef (syms
[i
].symbol
->type ()) == context_type
)
3799 error (_("No name '%s' in enumeration type '%s'"), name
,
3800 ada_type_name (context_type
));
3803 /* See ada-lang.h. */
3806 ada_resolve_variable (struct symbol
*sym
, const struct block
*block
,
3807 struct type
*context_type
,
3808 bool parse_completion
,
3810 innermost_block_tracker
*tracker
)
3812 std::vector
<struct block_symbol
> candidates
3813 = ada_lookup_symbol_list (sym
->linkage_name (), block
, VAR_DOMAIN
);
3815 if (std::any_of (candidates
.begin (),
3817 [] (block_symbol
&bsym
)
3819 switch (bsym
.symbol
->aclass ())
3824 case LOC_REGPARM_ADDR
:
3833 /* Types tend to get re-introduced locally, so if there
3834 are any local symbols that are not types, first filter
3838 (candidates
.begin (),
3840 [] (block_symbol
&bsym
)
3842 return bsym
.symbol
->aclass () == LOC_TYPEDEF
;
3847 /* Filter out artificial symbols. */
3850 (candidates
.begin (),
3852 [] (block_symbol
&bsym
)
3854 return bsym
.symbol
->artificial
;
3859 if (candidates
.empty ())
3860 error (_("No definition found for %s"), sym
->print_name ());
3861 else if (candidates
.size () == 1)
3863 else if (context_type
!= nullptr
3864 && context_type
->code () == TYPE_CODE_ENUM
)
3865 i
= ada_resolve_enum (candidates
, sym
->linkage_name (), context_type
,
3867 else if (deprocedure_p
&& !is_nonfunction (candidates
))
3869 i
= ada_resolve_function
3870 (candidates
, NULL
, 0,
3871 sym
->linkage_name (),
3872 context_type
, parse_completion
);
3874 error (_("Could not find a match for %s"), sym
->print_name ());
3878 gdb_printf (_("Multiple matches for %s\n"), sym
->print_name ());
3879 user_select_syms (candidates
.data (), candidates
.size (), 1);
3883 tracker
->update (candidates
[i
]);
3884 return candidates
[i
];
3887 /* Return non-zero if formal type FTYPE matches actual type ATYPE. */
3888 /* The term "match" here is rather loose. The match is heuristic and
3892 ada_type_match (struct type
*ftype
, struct type
*atype
)
3894 ftype
= ada_check_typedef (ftype
);
3895 atype
= ada_check_typedef (atype
);
3897 if (ftype
->code () == TYPE_CODE_REF
)
3898 ftype
= TYPE_TARGET_TYPE (ftype
);
3899 if (atype
->code () == TYPE_CODE_REF
)
3900 atype
= TYPE_TARGET_TYPE (atype
);
3902 switch (ftype
->code ())
3905 return ftype
->code () == atype
->code ();
3907 if (atype
->code () != TYPE_CODE_PTR
)
3909 atype
= TYPE_TARGET_TYPE (atype
);
3910 /* This can only happen if the actual argument is 'null'. */
3911 if (atype
->code () == TYPE_CODE_INT
&& TYPE_LENGTH (atype
) == 0)
3913 return ada_type_match (TYPE_TARGET_TYPE (ftype
), atype
);
3915 case TYPE_CODE_ENUM
:
3916 case TYPE_CODE_RANGE
:
3917 switch (atype
->code ())
3920 case TYPE_CODE_ENUM
:
3921 case TYPE_CODE_RANGE
:
3927 case TYPE_CODE_ARRAY
:
3928 return (atype
->code () == TYPE_CODE_ARRAY
3929 || ada_is_array_descriptor_type (atype
));
3931 case TYPE_CODE_STRUCT
:
3932 if (ada_is_array_descriptor_type (ftype
))
3933 return (atype
->code () == TYPE_CODE_ARRAY
3934 || ada_is_array_descriptor_type (atype
));
3936 return (atype
->code () == TYPE_CODE_STRUCT
3937 && !ada_is_array_descriptor_type (atype
));
3939 case TYPE_CODE_UNION
:
3941 return (atype
->code () == ftype
->code ());
3945 /* Return non-zero if the formals of FUNC "sufficiently match" the
3946 vector of actual argument types ACTUALS of size N_ACTUALS. FUNC
3947 may also be an enumeral, in which case it is treated as a 0-
3948 argument function. */
3951 ada_args_match (struct symbol
*func
, struct value
**actuals
, int n_actuals
)
3954 struct type
*func_type
= func
->type ();
3956 if (func
->aclass () == LOC_CONST
3957 && func_type
->code () == TYPE_CODE_ENUM
)
3958 return (n_actuals
== 0);
3959 else if (func_type
== NULL
|| func_type
->code () != TYPE_CODE_FUNC
)
3962 if (func_type
->num_fields () != n_actuals
)
3965 for (i
= 0; i
< n_actuals
; i
+= 1)
3967 if (actuals
[i
] == NULL
)
3971 struct type
*ftype
= ada_check_typedef (func_type
->field (i
).type ());
3972 struct type
*atype
= ada_check_typedef (value_type (actuals
[i
]));
3974 if (!ada_type_match (ftype
, atype
))
3981 /* False iff function type FUNC_TYPE definitely does not produce a value
3982 compatible with type CONTEXT_TYPE. Conservatively returns 1 if
3983 FUNC_TYPE is not a valid function type with a non-null return type
3984 or an enumerated type. A null CONTEXT_TYPE indicates any non-void type. */
3987 return_match (struct type
*func_type
, struct type
*context_type
)
3989 struct type
*return_type
;
3991 if (func_type
== NULL
)
3994 if (func_type
->code () == TYPE_CODE_FUNC
)
3995 return_type
= get_base_type (TYPE_TARGET_TYPE (func_type
));
3997 return_type
= get_base_type (func_type
);
3998 if (return_type
== NULL
)
4001 context_type
= get_base_type (context_type
);
4003 if (return_type
->code () == TYPE_CODE_ENUM
)
4004 return context_type
== NULL
|| return_type
== context_type
;
4005 else if (context_type
== NULL
)
4006 return return_type
->code () != TYPE_CODE_VOID
;
4008 return return_type
->code () == context_type
->code ();
4012 /* Returns the index in SYMS that contains the symbol for the
4013 function (if any) that matches the types of the NARGS arguments in
4014 ARGS. If CONTEXT_TYPE is non-null and there is at least one match
4015 that returns that type, then eliminate matches that don't. If
4016 CONTEXT_TYPE is void and there is at least one match that does not
4017 return void, eliminate all matches that do.
4019 Asks the user if there is more than one match remaining. Returns -1
4020 if there is no such symbol or none is selected. NAME is used
4021 solely for messages. May re-arrange and modify SYMS in
4022 the process; the index returned is for the modified vector. */
4025 ada_resolve_function (std::vector
<struct block_symbol
> &syms
,
4026 struct value
**args
, int nargs
,
4027 const char *name
, struct type
*context_type
,
4028 bool parse_completion
)
4032 int m
; /* Number of hits */
4035 /* In the first pass of the loop, we only accept functions matching
4036 context_type. If none are found, we add a second pass of the loop
4037 where every function is accepted. */
4038 for (fallback
= 0; m
== 0 && fallback
< 2; fallback
++)
4040 for (k
= 0; k
< syms
.size (); k
+= 1)
4042 struct type
*type
= ada_check_typedef (syms
[k
].symbol
->type ());
4044 if (ada_args_match (syms
[k
].symbol
, args
, nargs
)
4045 && (fallback
|| return_match (type
, context_type
)))
4053 /* If we got multiple matches, ask the user which one to use. Don't do this
4054 interactive thing during completion, though, as the purpose of the
4055 completion is providing a list of all possible matches. Prompting the
4056 user to filter it down would be completely unexpected in this case. */
4059 else if (m
> 1 && !parse_completion
)
4061 gdb_printf (_("Multiple matches for %s\n"), name
);
4062 user_select_syms (syms
.data (), m
, 1);
4068 /* Type-class predicates */
4070 /* True iff TYPE is numeric (i.e., an INT, RANGE (of numeric type),
4074 numeric_type_p (struct type
*type
)
4080 switch (type
->code ())
4084 case TYPE_CODE_FIXED_POINT
:
4086 case TYPE_CODE_RANGE
:
4087 return (type
== TYPE_TARGET_TYPE (type
)
4088 || numeric_type_p (TYPE_TARGET_TYPE (type
)));
4095 /* True iff TYPE is integral (an INT or RANGE of INTs). */
4098 integer_type_p (struct type
*type
)
4104 switch (type
->code ())
4108 case TYPE_CODE_RANGE
:
4109 return (type
== TYPE_TARGET_TYPE (type
)
4110 || integer_type_p (TYPE_TARGET_TYPE (type
)));
4117 /* True iff TYPE is scalar (INT, RANGE, FLOAT, ENUM). */
4120 scalar_type_p (struct type
*type
)
4126 switch (type
->code ())
4129 case TYPE_CODE_RANGE
:
4130 case TYPE_CODE_ENUM
:
4132 case TYPE_CODE_FIXED_POINT
:
4140 /* True iff TYPE is discrete (INT, RANGE, ENUM). */
4143 discrete_type_p (struct type
*type
)
4149 switch (type
->code ())
4152 case TYPE_CODE_RANGE
:
4153 case TYPE_CODE_ENUM
:
4154 case TYPE_CODE_BOOL
:
4162 /* Returns non-zero if OP with operands in the vector ARGS could be
4163 a user-defined function. Errs on the side of pre-defined operators
4164 (i.e., result 0). */
4167 possible_user_operator_p (enum exp_opcode op
, struct value
*args
[])
4169 struct type
*type0
=
4170 (args
[0] == NULL
) ? NULL
: ada_check_typedef (value_type (args
[0]));
4171 struct type
*type1
=
4172 (args
[1] == NULL
) ? NULL
: ada_check_typedef (value_type (args
[1]));
4186 return (!(numeric_type_p (type0
) && numeric_type_p (type1
)));
4190 case BINOP_BITWISE_AND
:
4191 case BINOP_BITWISE_IOR
:
4192 case BINOP_BITWISE_XOR
:
4193 return (!(integer_type_p (type0
) && integer_type_p (type1
)));
4196 case BINOP_NOTEQUAL
:
4201 return (!(scalar_type_p (type0
) && scalar_type_p (type1
)));
4204 return !ada_is_array_type (type0
) || !ada_is_array_type (type1
);
4207 return (!(numeric_type_p (type0
) && integer_type_p (type1
)));
4211 case UNOP_LOGICAL_NOT
:
4213 return (!numeric_type_p (type0
));
4222 1. In the following, we assume that a renaming type's name may
4223 have an ___XD suffix. It would be nice if this went away at some
4225 2. We handle both the (old) purely type-based representation of
4226 renamings and the (new) variable-based encoding. At some point,
4227 it is devoutly to be hoped that the former goes away
4228 (FIXME: hilfinger-2007-07-09).
4229 3. Subprogram renamings are not implemented, although the XRS
4230 suffix is recognized (FIXME: hilfinger-2007-07-09). */
4232 /* If SYM encodes a renaming,
4234 <renaming> renames <renamed entity>,
4236 sets *LEN to the length of the renamed entity's name,
4237 *RENAMED_ENTITY to that name (not null-terminated), and *RENAMING_EXPR to
4238 the string describing the subcomponent selected from the renamed
4239 entity. Returns ADA_NOT_RENAMING if SYM does not encode a renaming
4240 (in which case, the values of *RENAMED_ENTITY, *LEN, and *RENAMING_EXPR
4241 are undefined). Otherwise, returns a value indicating the category
4242 of entity renamed: an object (ADA_OBJECT_RENAMING), exception
4243 (ADA_EXCEPTION_RENAMING), package (ADA_PACKAGE_RENAMING), or
4244 subprogram (ADA_SUBPROGRAM_RENAMING). Does no allocation; the
4245 strings returned in *RENAMED_ENTITY and *RENAMING_EXPR should not be
4246 deallocated. The values of RENAMED_ENTITY, LEN, or RENAMING_EXPR
4247 may be NULL, in which case they are not assigned.
4249 [Currently, however, GCC does not generate subprogram renamings.] */
4251 enum ada_renaming_category
4252 ada_parse_renaming (struct symbol
*sym
,
4253 const char **renamed_entity
, int *len
,
4254 const char **renaming_expr
)
4256 enum ada_renaming_category kind
;
4261 return ADA_NOT_RENAMING
;
4262 switch (sym
->aclass ())
4265 return ADA_NOT_RENAMING
;
4269 case LOC_OPTIMIZED_OUT
:
4270 info
= strstr (sym
->linkage_name (), "___XR");
4272 return ADA_NOT_RENAMING
;
4276 kind
= ADA_OBJECT_RENAMING
;
4280 kind
= ADA_EXCEPTION_RENAMING
;
4284 kind
= ADA_PACKAGE_RENAMING
;
4288 kind
= ADA_SUBPROGRAM_RENAMING
;
4292 return ADA_NOT_RENAMING
;
4296 if (renamed_entity
!= NULL
)
4297 *renamed_entity
= info
;
4298 suffix
= strstr (info
, "___XE");
4299 if (suffix
== NULL
|| suffix
== info
)
4300 return ADA_NOT_RENAMING
;
4302 *len
= strlen (info
) - strlen (suffix
);
4304 if (renaming_expr
!= NULL
)
4305 *renaming_expr
= suffix
;
4309 /* Compute the value of the given RENAMING_SYM, which is expected to
4310 be a symbol encoding a renaming expression. BLOCK is the block
4311 used to evaluate the renaming. */
4313 static struct value
*
4314 ada_read_renaming_var_value (struct symbol
*renaming_sym
,
4315 const struct block
*block
)
4317 const char *sym_name
;
4319 sym_name
= renaming_sym
->linkage_name ();
4320 expression_up expr
= parse_exp_1 (&sym_name
, 0, block
, 0);
4321 return evaluate_expression (expr
.get ());
4325 /* Evaluation: Function Calls */
4327 /* Return an lvalue containing the value VAL. This is the identity on
4328 lvalues, and otherwise has the side-effect of allocating memory
4329 in the inferior where a copy of the value contents is copied. */
4331 static struct value
*
4332 ensure_lval (struct value
*val
)
4334 if (VALUE_LVAL (val
) == not_lval
4335 || VALUE_LVAL (val
) == lval_internalvar
)
4337 int len
= TYPE_LENGTH (ada_check_typedef (value_type (val
)));
4338 const CORE_ADDR addr
=
4339 value_as_long (value_allocate_space_in_inferior (len
));
4341 VALUE_LVAL (val
) = lval_memory
;
4342 set_value_address (val
, addr
);
4343 write_memory (addr
, value_contents (val
).data (), len
);
4349 /* Given ARG, a value of type (pointer or reference to a)*
4350 structure/union, extract the component named NAME from the ultimate
4351 target structure/union and return it as a value with its
4354 The routine searches for NAME among all members of the structure itself
4355 and (recursively) among all members of any wrapper members
4358 If NO_ERR, then simply return NULL in case of error, rather than
4361 static struct value
*
4362 ada_value_struct_elt (struct value
*arg
, const char *name
, int no_err
)
4364 struct type
*t
, *t1
;
4369 t1
= t
= ada_check_typedef (value_type (arg
));
4370 if (t
->code () == TYPE_CODE_REF
)
4372 t1
= TYPE_TARGET_TYPE (t
);
4375 t1
= ada_check_typedef (t1
);
4376 if (t1
->code () == TYPE_CODE_PTR
)
4378 arg
= coerce_ref (arg
);
4383 while (t
->code () == TYPE_CODE_PTR
)
4385 t1
= TYPE_TARGET_TYPE (t
);
4388 t1
= ada_check_typedef (t1
);
4389 if (t1
->code () == TYPE_CODE_PTR
)
4391 arg
= value_ind (arg
);
4398 if (t1
->code () != TYPE_CODE_STRUCT
&& t1
->code () != TYPE_CODE_UNION
)
4402 v
= ada_search_struct_field (name
, arg
, 0, t
);
4405 int bit_offset
, bit_size
, byte_offset
;
4406 struct type
*field_type
;
4409 if (t
->code () == TYPE_CODE_PTR
)
4410 address
= value_address (ada_value_ind (arg
));
4412 address
= value_address (ada_coerce_ref (arg
));
4414 /* Check to see if this is a tagged type. We also need to handle
4415 the case where the type is a reference to a tagged type, but
4416 we have to be careful to exclude pointers to tagged types.
4417 The latter should be shown as usual (as a pointer), whereas
4418 a reference should mostly be transparent to the user. */
4420 if (ada_is_tagged_type (t1
, 0)
4421 || (t1
->code () == TYPE_CODE_REF
4422 && ada_is_tagged_type (TYPE_TARGET_TYPE (t1
), 0)))
4424 /* We first try to find the searched field in the current type.
4425 If not found then let's look in the fixed type. */
4427 if (!find_struct_field (name
, t1
, 0,
4428 nullptr, nullptr, nullptr,
4437 /* Convert to fixed type in all cases, so that we have proper
4438 offsets to each field in unconstrained record types. */
4439 t1
= ada_to_fixed_type (ada_get_base_type (t1
), NULL
,
4440 address
, NULL
, check_tag
);
4442 /* Resolve the dynamic type as well. */
4443 arg
= value_from_contents_and_address (t1
, nullptr, address
);
4444 t1
= value_type (arg
);
4446 if (find_struct_field (name
, t1
, 0,
4447 &field_type
, &byte_offset
, &bit_offset
,
4452 if (t
->code () == TYPE_CODE_REF
)
4453 arg
= ada_coerce_ref (arg
);
4455 arg
= ada_value_ind (arg
);
4456 v
= ada_value_primitive_packed_val (arg
, NULL
, byte_offset
,
4457 bit_offset
, bit_size
,
4461 v
= value_at_lazy (field_type
, address
+ byte_offset
);
4465 if (v
!= NULL
|| no_err
)
4468 error (_("There is no member named %s."), name
);
4474 error (_("Attempt to extract a component of "
4475 "a value that is not a record."));
4478 /* Return the value ACTUAL, converted to be an appropriate value for a
4479 formal of type FORMAL_TYPE. Use *SP as a stack pointer for
4480 allocating any necessary descriptors (fat pointers), or copies of
4481 values not residing in memory, updating it as needed. */
4484 ada_convert_actual (struct value
*actual
, struct type
*formal_type0
)
4486 struct type
*actual_type
= ada_check_typedef (value_type (actual
));
4487 struct type
*formal_type
= ada_check_typedef (formal_type0
);
4488 struct type
*formal_target
=
4489 formal_type
->code () == TYPE_CODE_PTR
4490 ? ada_check_typedef (TYPE_TARGET_TYPE (formal_type
)) : formal_type
;
4491 struct type
*actual_target
=
4492 actual_type
->code () == TYPE_CODE_PTR
4493 ? ada_check_typedef (TYPE_TARGET_TYPE (actual_type
)) : actual_type
;
4495 if (ada_is_array_descriptor_type (formal_target
)
4496 && actual_target
->code () == TYPE_CODE_ARRAY
)
4497 return make_array_descriptor (formal_type
, actual
);
4498 else if (formal_type
->code () == TYPE_CODE_PTR
4499 || formal_type
->code () == TYPE_CODE_REF
)
4501 struct value
*result
;
4503 if (formal_target
->code () == TYPE_CODE_ARRAY
4504 && ada_is_array_descriptor_type (actual_target
))
4505 result
= desc_data (actual
);
4506 else if (formal_type
->code () != TYPE_CODE_PTR
)
4508 if (VALUE_LVAL (actual
) != lval_memory
)
4512 actual_type
= ada_check_typedef (value_type (actual
));
4513 val
= allocate_value (actual_type
);
4514 copy (value_contents (actual
), value_contents_raw (val
));
4515 actual
= ensure_lval (val
);
4517 result
= value_addr (actual
);
4521 return value_cast_pointers (formal_type
, result
, 0);
4523 else if (actual_type
->code () == TYPE_CODE_PTR
)
4524 return ada_value_ind (actual
);
4525 else if (ada_is_aligner_type (formal_type
))
4527 /* We need to turn this parameter into an aligner type
4529 struct value
*aligner
= allocate_value (formal_type
);
4530 struct value
*component
= ada_value_struct_elt (aligner
, "F", 0);
4532 value_assign_to_component (aligner
, component
, actual
);
4539 /* Convert VALUE (which must be an address) to a CORE_ADDR that is a pointer of
4540 type TYPE. This is usually an inefficient no-op except on some targets
4541 (such as AVR) where the representation of a pointer and an address
4545 value_pointer (struct value
*value
, struct type
*type
)
4547 unsigned len
= TYPE_LENGTH (type
);
4548 gdb_byte
*buf
= (gdb_byte
*) alloca (len
);
4551 addr
= value_address (value
);
4552 gdbarch_address_to_pointer (type
->arch (), type
, buf
, addr
);
4553 addr
= extract_unsigned_integer (buf
, len
, type_byte_order (type
));
4558 /* Push a descriptor of type TYPE for array value ARR on the stack at
4559 *SP, updating *SP to reflect the new descriptor. Return either
4560 an lvalue representing the new descriptor, or (if TYPE is a pointer-
4561 to-descriptor type rather than a descriptor type), a struct value *
4562 representing a pointer to this descriptor. */
4564 static struct value
*
4565 make_array_descriptor (struct type
*type
, struct value
*arr
)
4567 struct type
*bounds_type
= desc_bounds_type (type
);
4568 struct type
*desc_type
= desc_base_type (type
);
4569 struct value
*descriptor
= allocate_value (desc_type
);
4570 struct value
*bounds
= allocate_value (bounds_type
);
4573 for (i
= ada_array_arity (ada_check_typedef (value_type (arr
)));
4576 modify_field (value_type (bounds
),
4577 value_contents_writeable (bounds
).data (),
4578 ada_array_bound (arr
, i
, 0),
4579 desc_bound_bitpos (bounds_type
, i
, 0),
4580 desc_bound_bitsize (bounds_type
, i
, 0));
4581 modify_field (value_type (bounds
),
4582 value_contents_writeable (bounds
).data (),
4583 ada_array_bound (arr
, i
, 1),
4584 desc_bound_bitpos (bounds_type
, i
, 1),
4585 desc_bound_bitsize (bounds_type
, i
, 1));
4588 bounds
= ensure_lval (bounds
);
4590 modify_field (value_type (descriptor
),
4591 value_contents_writeable (descriptor
).data (),
4592 value_pointer (ensure_lval (arr
),
4593 desc_type
->field (0).type ()),
4594 fat_pntr_data_bitpos (desc_type
),
4595 fat_pntr_data_bitsize (desc_type
));
4597 modify_field (value_type (descriptor
),
4598 value_contents_writeable (descriptor
).data (),
4599 value_pointer (bounds
,
4600 desc_type
->field (1).type ()),
4601 fat_pntr_bounds_bitpos (desc_type
),
4602 fat_pntr_bounds_bitsize (desc_type
));
4604 descriptor
= ensure_lval (descriptor
);
4606 if (type
->code () == TYPE_CODE_PTR
)
4607 return value_addr (descriptor
);
4612 /* Symbol Cache Module */
4614 /* Performance measurements made as of 2010-01-15 indicate that
4615 this cache does bring some noticeable improvements. Depending
4616 on the type of entity being printed, the cache can make it as much
4617 as an order of magnitude faster than without it.
4619 The descriptive type DWARF extension has significantly reduced
4620 the need for this cache, at least when DWARF is being used. However,
4621 even in this case, some expensive name-based symbol searches are still
4622 sometimes necessary - to find an XVZ variable, mostly. */
4624 /* Return the symbol cache associated to the given program space PSPACE.
4625 If not allocated for this PSPACE yet, allocate and initialize one. */
4627 static struct ada_symbol_cache
*
4628 ada_get_symbol_cache (struct program_space
*pspace
)
4630 struct ada_pspace_data
*pspace_data
= get_ada_pspace_data (pspace
);
4632 if (pspace_data
->sym_cache
== nullptr)
4633 pspace_data
->sym_cache
.reset (new ada_symbol_cache
);
4635 return pspace_data
->sym_cache
.get ();
4638 /* Clear all entries from the symbol cache. */
4641 ada_clear_symbol_cache ()
4643 struct ada_pspace_data
*pspace_data
4644 = get_ada_pspace_data (current_program_space
);
4646 if (pspace_data
->sym_cache
!= nullptr)
4647 pspace_data
->sym_cache
.reset ();
4650 /* Search our cache for an entry matching NAME and DOMAIN.
4651 Return it if found, or NULL otherwise. */
4653 static struct cache_entry
**
4654 find_entry (const char *name
, domain_enum domain
)
4656 struct ada_symbol_cache
*sym_cache
4657 = ada_get_symbol_cache (current_program_space
);
4658 int h
= msymbol_hash (name
) % HASH_SIZE
;
4659 struct cache_entry
**e
;
4661 for (e
= &sym_cache
->root
[h
]; *e
!= NULL
; e
= &(*e
)->next
)
4663 if (domain
== (*e
)->domain
&& strcmp (name
, (*e
)->name
) == 0)
4669 /* Search the symbol cache for an entry matching NAME and DOMAIN.
4670 Return 1 if found, 0 otherwise.
4672 If an entry was found and SYM is not NULL, set *SYM to the entry's
4673 SYM. Same principle for BLOCK if not NULL. */
4676 lookup_cached_symbol (const char *name
, domain_enum domain
,
4677 struct symbol
**sym
, const struct block
**block
)
4679 struct cache_entry
**e
= find_entry (name
, domain
);
4686 *block
= (*e
)->block
;
4690 /* Assuming that (SYM, BLOCK) is the result of the lookup of NAME
4691 in domain DOMAIN, save this result in our symbol cache. */
4694 cache_symbol (const char *name
, domain_enum domain
, struct symbol
*sym
,
4695 const struct block
*block
)
4697 struct ada_symbol_cache
*sym_cache
4698 = ada_get_symbol_cache (current_program_space
);
4700 struct cache_entry
*e
;
4702 /* Symbols for builtin types don't have a block.
4703 For now don't cache such symbols. */
4704 if (sym
!= NULL
&& !sym
->is_objfile_owned ())
4707 /* If the symbol is a local symbol, then do not cache it, as a search
4708 for that symbol depends on the context. To determine whether
4709 the symbol is local or not, we check the block where we found it
4710 against the global and static blocks of its associated symtab. */
4712 && BLOCKVECTOR_BLOCK (symbol_symtab (sym
)->blockvector (),
4713 GLOBAL_BLOCK
) != block
4714 && BLOCKVECTOR_BLOCK (symbol_symtab (sym
)->blockvector (),
4715 STATIC_BLOCK
) != block
)
4718 h
= msymbol_hash (name
) % HASH_SIZE
;
4719 e
= XOBNEW (&sym_cache
->cache_space
, cache_entry
);
4720 e
->next
= sym_cache
->root
[h
];
4721 sym_cache
->root
[h
] = e
;
4722 e
->name
= obstack_strdup (&sym_cache
->cache_space
, name
);
4730 /* Return the symbol name match type that should be used used when
4731 searching for all symbols matching LOOKUP_NAME.
4733 LOOKUP_NAME is expected to be a symbol name after transformation
4736 static symbol_name_match_type
4737 name_match_type_from_name (const char *lookup_name
)
4739 return (strstr (lookup_name
, "__") == NULL
4740 ? symbol_name_match_type::WILD
4741 : symbol_name_match_type::FULL
);
4744 /* Return the result of a standard (literal, C-like) lookup of NAME in
4745 given DOMAIN, visible from lexical block BLOCK. */
4747 static struct symbol
*
4748 standard_lookup (const char *name
, const struct block
*block
,
4751 /* Initialize it just to avoid a GCC false warning. */
4752 struct block_symbol sym
= {};
4754 if (lookup_cached_symbol (name
, domain
, &sym
.symbol
, NULL
))
4756 ada_lookup_encoded_symbol (name
, block
, domain
, &sym
);
4757 cache_symbol (name
, domain
, sym
.symbol
, sym
.block
);
4762 /* Non-zero iff there is at least one non-function/non-enumeral symbol
4763 in the symbol fields of SYMS. We treat enumerals as functions,
4764 since they contend in overloading in the same way. */
4766 is_nonfunction (const std::vector
<struct block_symbol
> &syms
)
4768 for (const block_symbol
&sym
: syms
)
4769 if (sym
.symbol
->type ()->code () != TYPE_CODE_FUNC
4770 && (sym
.symbol
->type ()->code () != TYPE_CODE_ENUM
4771 || sym
.symbol
->aclass () != LOC_CONST
))
4777 /* If true (non-zero), then TYPE0 and TYPE1 represent equivalent
4778 struct types. Otherwise, they may not. */
4781 equiv_types (struct type
*type0
, struct type
*type1
)
4785 if (type0
== NULL
|| type1
== NULL
4786 || type0
->code () != type1
->code ())
4788 if ((type0
->code () == TYPE_CODE_STRUCT
4789 || type0
->code () == TYPE_CODE_ENUM
)
4790 && ada_type_name (type0
) != NULL
&& ada_type_name (type1
) != NULL
4791 && strcmp (ada_type_name (type0
), ada_type_name (type1
)) == 0)
4797 /* True iff SYM0 represents the same entity as SYM1, or one that is
4798 no more defined than that of SYM1. */
4801 lesseq_defined_than (struct symbol
*sym0
, struct symbol
*sym1
)
4805 if (sym0
->domain () != sym1
->domain ()
4806 || sym0
->aclass () != sym1
->aclass ())
4809 switch (sym0
->aclass ())
4815 struct type
*type0
= sym0
->type ();
4816 struct type
*type1
= sym1
->type ();
4817 const char *name0
= sym0
->linkage_name ();
4818 const char *name1
= sym1
->linkage_name ();
4819 int len0
= strlen (name0
);
4822 type0
->code () == type1
->code ()
4823 && (equiv_types (type0
, type1
)
4824 || (len0
< strlen (name1
) && strncmp (name0
, name1
, len0
) == 0
4825 && startswith (name1
+ len0
, "___XV")));
4828 return SYMBOL_VALUE (sym0
) == SYMBOL_VALUE (sym1
)
4829 && equiv_types (sym0
->type (), sym1
->type ());
4833 const char *name0
= sym0
->linkage_name ();
4834 const char *name1
= sym1
->linkage_name ();
4835 return (strcmp (name0
, name1
) == 0
4836 && SYMBOL_VALUE_ADDRESS (sym0
) == SYMBOL_VALUE_ADDRESS (sym1
));
4844 /* Append (SYM,BLOCK) to the end of the array of struct block_symbol
4845 records in RESULT. Do nothing if SYM is a duplicate. */
4848 add_defn_to_vec (std::vector
<struct block_symbol
> &result
,
4850 const struct block
*block
)
4852 /* Do not try to complete stub types, as the debugger is probably
4853 already scanning all symbols matching a certain name at the
4854 time when this function is called. Trying to replace the stub
4855 type by its associated full type will cause us to restart a scan
4856 which may lead to an infinite recursion. Instead, the client
4857 collecting the matching symbols will end up collecting several
4858 matches, with at least one of them complete. It can then filter
4859 out the stub ones if needed. */
4861 for (int i
= result
.size () - 1; i
>= 0; i
-= 1)
4863 if (lesseq_defined_than (sym
, result
[i
].symbol
))
4865 else if (lesseq_defined_than (result
[i
].symbol
, sym
))
4867 result
[i
].symbol
= sym
;
4868 result
[i
].block
= block
;
4873 struct block_symbol info
;
4876 result
.push_back (info
);
4879 /* Return a bound minimal symbol matching NAME according to Ada
4880 decoding rules. Returns an invalid symbol if there is no such
4881 minimal symbol. Names prefixed with "standard__" are handled
4882 specially: "standard__" is first stripped off, and only static and
4883 global symbols are searched. */
4885 struct bound_minimal_symbol
4886 ada_lookup_simple_minsym (const char *name
)
4888 struct bound_minimal_symbol result
;
4890 symbol_name_match_type match_type
= name_match_type_from_name (name
);
4891 lookup_name_info
lookup_name (name
, match_type
);
4893 symbol_name_matcher_ftype
*match_name
4894 = ada_get_symbol_name_matcher (lookup_name
);
4896 for (objfile
*objfile
: current_program_space
->objfiles ())
4898 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
4900 if (match_name (msymbol
->linkage_name (), lookup_name
, NULL
)
4901 && MSYMBOL_TYPE (msymbol
) != mst_solib_trampoline
)
4903 result
.minsym
= msymbol
;
4904 result
.objfile
= objfile
;
4913 /* True if TYPE is definitely an artificial type supplied to a symbol
4914 for which no debugging information was given in the symbol file. */
4917 is_nondebugging_type (struct type
*type
)
4919 const char *name
= ada_type_name (type
);
4921 return (name
!= NULL
&& strcmp (name
, "<variable, no debug info>") == 0);
4924 /* Return nonzero if TYPE1 and TYPE2 are two enumeration types
4925 that are deemed "identical" for practical purposes.
4927 This function assumes that TYPE1 and TYPE2 are both TYPE_CODE_ENUM
4928 types and that their number of enumerals is identical (in other
4929 words, type1->num_fields () == type2->num_fields ()). */
4932 ada_identical_enum_types_p (struct type
*type1
, struct type
*type2
)
4936 /* The heuristic we use here is fairly conservative. We consider
4937 that 2 enumerate types are identical if they have the same
4938 number of enumerals and that all enumerals have the same
4939 underlying value and name. */
4941 /* All enums in the type should have an identical underlying value. */
4942 for (i
= 0; i
< type1
->num_fields (); i
++)
4943 if (type1
->field (i
).loc_enumval () != type2
->field (i
).loc_enumval ())
4946 /* All enumerals should also have the same name (modulo any numerical
4948 for (i
= 0; i
< type1
->num_fields (); i
++)
4950 const char *name_1
= type1
->field (i
).name ();
4951 const char *name_2
= type2
->field (i
).name ();
4952 int len_1
= strlen (name_1
);
4953 int len_2
= strlen (name_2
);
4955 ada_remove_trailing_digits (type1
->field (i
).name (), &len_1
);
4956 ada_remove_trailing_digits (type2
->field (i
).name (), &len_2
);
4958 || strncmp (type1
->field (i
).name (),
4959 type2
->field (i
).name (),
4967 /* Return nonzero if all the symbols in SYMS are all enumeral symbols
4968 that are deemed "identical" for practical purposes. Sometimes,
4969 enumerals are not strictly identical, but their types are so similar
4970 that they can be considered identical.
4972 For instance, consider the following code:
4974 type Color is (Black, Red, Green, Blue, White);
4975 type RGB_Color is new Color range Red .. Blue;
4977 Type RGB_Color is a subrange of an implicit type which is a copy
4978 of type Color. If we call that implicit type RGB_ColorB ("B" is
4979 for "Base Type"), then type RGB_ColorB is a copy of type Color.
4980 As a result, when an expression references any of the enumeral
4981 by name (Eg. "print green"), the expression is technically
4982 ambiguous and the user should be asked to disambiguate. But
4983 doing so would only hinder the user, since it wouldn't matter
4984 what choice he makes, the outcome would always be the same.
4985 So, for practical purposes, we consider them as the same. */
4988 symbols_are_identical_enums (const std::vector
<struct block_symbol
> &syms
)
4992 /* Before performing a thorough comparison check of each type,
4993 we perform a series of inexpensive checks. We expect that these
4994 checks will quickly fail in the vast majority of cases, and thus
4995 help prevent the unnecessary use of a more expensive comparison.
4996 Said comparison also expects us to make some of these checks
4997 (see ada_identical_enum_types_p). */
4999 /* Quick check: All symbols should have an enum type. */
5000 for (i
= 0; i
< syms
.size (); i
++)
5001 if (syms
[i
].symbol
->type ()->code () != TYPE_CODE_ENUM
)
5004 /* Quick check: They should all have the same value. */
5005 for (i
= 1; i
< syms
.size (); i
++)
5006 if (SYMBOL_VALUE (syms
[i
].symbol
) != SYMBOL_VALUE (syms
[0].symbol
))
5009 /* Quick check: They should all have the same number of enumerals. */
5010 for (i
= 1; i
< syms
.size (); i
++)
5011 if (syms
[i
].symbol
->type ()->num_fields ()
5012 != syms
[0].symbol
->type ()->num_fields ())
5015 /* All the sanity checks passed, so we might have a set of
5016 identical enumeration types. Perform a more complete
5017 comparison of the type of each symbol. */
5018 for (i
= 1; i
< syms
.size (); i
++)
5019 if (!ada_identical_enum_types_p (syms
[i
].symbol
->type (),
5020 syms
[0].symbol
->type ()))
5026 /* Remove any non-debugging symbols in SYMS that definitely
5027 duplicate other symbols in the list (The only case I know of where
5028 this happens is when object files containing stabs-in-ecoff are
5029 linked with files containing ordinary ecoff debugging symbols (or no
5030 debugging symbols)). Modifies SYMS to squeeze out deleted entries. */
5033 remove_extra_symbols (std::vector
<struct block_symbol
> *syms
)
5037 /* We should never be called with less than 2 symbols, as there
5038 cannot be any extra symbol in that case. But it's easy to
5039 handle, since we have nothing to do in that case. */
5040 if (syms
->size () < 2)
5044 while (i
< syms
->size ())
5048 /* If two symbols have the same name and one of them is a stub type,
5049 the get rid of the stub. */
5051 if ((*syms
)[i
].symbol
->type ()->is_stub ()
5052 && (*syms
)[i
].symbol
->linkage_name () != NULL
)
5054 for (j
= 0; j
< syms
->size (); j
++)
5057 && !(*syms
)[j
].symbol
->type ()->is_stub ()
5058 && (*syms
)[j
].symbol
->linkage_name () != NULL
5059 && strcmp ((*syms
)[i
].symbol
->linkage_name (),
5060 (*syms
)[j
].symbol
->linkage_name ()) == 0)
5065 /* Two symbols with the same name, same class and same address
5066 should be identical. */
5068 else if ((*syms
)[i
].symbol
->linkage_name () != NULL
5069 && (*syms
)[i
].symbol
->aclass () == LOC_STATIC
5070 && is_nondebugging_type ((*syms
)[i
].symbol
->type ()))
5072 for (j
= 0; j
< syms
->size (); j
+= 1)
5075 && (*syms
)[j
].symbol
->linkage_name () != NULL
5076 && strcmp ((*syms
)[i
].symbol
->linkage_name (),
5077 (*syms
)[j
].symbol
->linkage_name ()) == 0
5078 && ((*syms
)[i
].symbol
->aclass ()
5079 == (*syms
)[j
].symbol
->aclass ())
5080 && SYMBOL_VALUE_ADDRESS ((*syms
)[i
].symbol
)
5081 == SYMBOL_VALUE_ADDRESS ((*syms
)[j
].symbol
))
5087 syms
->erase (syms
->begin () + i
);
5092 /* If all the remaining symbols are identical enumerals, then
5093 just keep the first one and discard the rest.
5095 Unlike what we did previously, we do not discard any entry
5096 unless they are ALL identical. This is because the symbol
5097 comparison is not a strict comparison, but rather a practical
5098 comparison. If all symbols are considered identical, then
5099 we can just go ahead and use the first one and discard the rest.
5100 But if we cannot reduce the list to a single element, we have
5101 to ask the user to disambiguate anyways. And if we have to
5102 present a multiple-choice menu, it's less confusing if the list
5103 isn't missing some choices that were identical and yet distinct. */
5104 if (symbols_are_identical_enums (*syms
))
5108 /* Given a type that corresponds to a renaming entity, use the type name
5109 to extract the scope (package name or function name, fully qualified,
5110 and following the GNAT encoding convention) where this renaming has been
5114 xget_renaming_scope (struct type
*renaming_type
)
5116 /* The renaming types adhere to the following convention:
5117 <scope>__<rename>___<XR extension>.
5118 So, to extract the scope, we search for the "___XR" extension,
5119 and then backtrack until we find the first "__". */
5121 const char *name
= renaming_type
->name ();
5122 const char *suffix
= strstr (name
, "___XR");
5125 /* Now, backtrack a bit until we find the first "__". Start looking
5126 at suffix - 3, as the <rename> part is at least one character long. */
5128 for (last
= suffix
- 3; last
> name
; last
--)
5129 if (last
[0] == '_' && last
[1] == '_')
5132 /* Make a copy of scope and return it. */
5133 return std::string (name
, last
);
5136 /* Return nonzero if NAME corresponds to a package name. */
5139 is_package_name (const char *name
)
5141 /* Here, We take advantage of the fact that no symbols are generated
5142 for packages, while symbols are generated for each function.
5143 So the condition for NAME represent a package becomes equivalent
5144 to NAME not existing in our list of symbols. There is only one
5145 small complication with library-level functions (see below). */
5147 /* If it is a function that has not been defined at library level,
5148 then we should be able to look it up in the symbols. */
5149 if (standard_lookup (name
, NULL
, VAR_DOMAIN
) != NULL
)
5152 /* Library-level function names start with "_ada_". See if function
5153 "_ada_" followed by NAME can be found. */
5155 /* Do a quick check that NAME does not contain "__", since library-level
5156 functions names cannot contain "__" in them. */
5157 if (strstr (name
, "__") != NULL
)
5160 std::string fun_name
= string_printf ("_ada_%s", name
);
5162 return (standard_lookup (fun_name
.c_str (), NULL
, VAR_DOMAIN
) == NULL
);
5165 /* Return nonzero if SYM corresponds to a renaming entity that is
5166 not visible from FUNCTION_NAME. */
5169 old_renaming_is_invisible (const struct symbol
*sym
, const char *function_name
)
5171 if (sym
->aclass () != LOC_TYPEDEF
)
5174 std::string scope
= xget_renaming_scope (sym
->type ());
5176 /* If the rename has been defined in a package, then it is visible. */
5177 if (is_package_name (scope
.c_str ()))
5180 /* Check that the rename is in the current function scope by checking
5181 that its name starts with SCOPE. */
5183 /* If the function name starts with "_ada_", it means that it is
5184 a library-level function. Strip this prefix before doing the
5185 comparison, as the encoding for the renaming does not contain
5187 if (startswith (function_name
, "_ada_"))
5190 return !startswith (function_name
, scope
.c_str ());
5193 /* Remove entries from SYMS that corresponds to a renaming entity that
5194 is not visible from the function associated with CURRENT_BLOCK or
5195 that is superfluous due to the presence of more specific renaming
5196 information. Places surviving symbols in the initial entries of
5200 First, in cases where an object renaming is implemented as a
5201 reference variable, GNAT may produce both the actual reference
5202 variable and the renaming encoding. In this case, we discard the
5205 Second, GNAT emits a type following a specified encoding for each renaming
5206 entity. Unfortunately, STABS currently does not support the definition
5207 of types that are local to a given lexical block, so all renamings types
5208 are emitted at library level. As a consequence, if an application
5209 contains two renaming entities using the same name, and a user tries to
5210 print the value of one of these entities, the result of the ada symbol
5211 lookup will also contain the wrong renaming type.
5213 This function partially covers for this limitation by attempting to
5214 remove from the SYMS list renaming symbols that should be visible
5215 from CURRENT_BLOCK. However, there does not seem be a 100% reliable
5216 method with the current information available. The implementation
5217 below has a couple of limitations (FIXME: brobecker-2003-05-12):
5219 - When the user tries to print a rename in a function while there
5220 is another rename entity defined in a package: Normally, the
5221 rename in the function has precedence over the rename in the
5222 package, so the latter should be removed from the list. This is
5223 currently not the case.
5225 - This function will incorrectly remove valid renames if
5226 the CURRENT_BLOCK corresponds to a function which symbol name
5227 has been changed by an "Export" pragma. As a consequence,
5228 the user will be unable to print such rename entities. */
5231 remove_irrelevant_renamings (std::vector
<struct block_symbol
> *syms
,
5232 const struct block
*current_block
)
5234 struct symbol
*current_function
;
5235 const char *current_function_name
;
5237 int is_new_style_renaming
;
5239 /* If there is both a renaming foo___XR... encoded as a variable and
5240 a simple variable foo in the same block, discard the latter.
5241 First, zero out such symbols, then compress. */
5242 is_new_style_renaming
= 0;
5243 for (i
= 0; i
< syms
->size (); i
+= 1)
5245 struct symbol
*sym
= (*syms
)[i
].symbol
;
5246 const struct block
*block
= (*syms
)[i
].block
;
5250 if (sym
== NULL
|| sym
->aclass () == LOC_TYPEDEF
)
5252 name
= sym
->linkage_name ();
5253 suffix
= strstr (name
, "___XR");
5257 int name_len
= suffix
- name
;
5260 is_new_style_renaming
= 1;
5261 for (j
= 0; j
< syms
->size (); j
+= 1)
5262 if (i
!= j
&& (*syms
)[j
].symbol
!= NULL
5263 && strncmp (name
, (*syms
)[j
].symbol
->linkage_name (),
5265 && block
== (*syms
)[j
].block
)
5266 (*syms
)[j
].symbol
= NULL
;
5269 if (is_new_style_renaming
)
5273 for (j
= k
= 0; j
< syms
->size (); j
+= 1)
5274 if ((*syms
)[j
].symbol
!= NULL
)
5276 (*syms
)[k
] = (*syms
)[j
];
5283 /* Extract the function name associated to CURRENT_BLOCK.
5284 Abort if unable to do so. */
5286 if (current_block
== NULL
)
5289 current_function
= block_linkage_function (current_block
);
5290 if (current_function
== NULL
)
5293 current_function_name
= current_function
->linkage_name ();
5294 if (current_function_name
== NULL
)
5297 /* Check each of the symbols, and remove it from the list if it is
5298 a type corresponding to a renaming that is out of the scope of
5299 the current block. */
5302 while (i
< syms
->size ())
5304 if (ada_parse_renaming ((*syms
)[i
].symbol
, NULL
, NULL
, NULL
)
5305 == ADA_OBJECT_RENAMING
5306 && old_renaming_is_invisible ((*syms
)[i
].symbol
,
5307 current_function_name
))
5308 syms
->erase (syms
->begin () + i
);
5314 /* Add to RESULT all symbols from BLOCK (and its super-blocks)
5315 whose name and domain match LOOKUP_NAME and DOMAIN respectively.
5317 Note: This function assumes that RESULT is empty. */
5320 ada_add_local_symbols (std::vector
<struct block_symbol
> &result
,
5321 const lookup_name_info
&lookup_name
,
5322 const struct block
*block
, domain_enum domain
)
5324 while (block
!= NULL
)
5326 ada_add_block_symbols (result
, block
, lookup_name
, domain
, NULL
);
5328 /* If we found a non-function match, assume that's the one. We
5329 only check this when finding a function boundary, so that we
5330 can accumulate all results from intervening blocks first. */
5331 if (BLOCK_FUNCTION (block
) != nullptr && is_nonfunction (result
))
5334 block
= BLOCK_SUPERBLOCK (block
);
5338 /* An object of this type is used as the callback argument when
5339 calling the map_matching_symbols method. */
5343 explicit match_data (std::vector
<struct block_symbol
> *rp
)
5347 DISABLE_COPY_AND_ASSIGN (match_data
);
5349 bool operator() (struct block_symbol
*bsym
);
5351 struct objfile
*objfile
= nullptr;
5352 std::vector
<struct block_symbol
> *resultp
;
5353 struct symbol
*arg_sym
= nullptr;
5354 bool found_sym
= false;
5357 /* A callback for add_nonlocal_symbols that adds symbol, found in
5358 BSYM, to a list of symbols. */
5361 match_data::operator() (struct block_symbol
*bsym
)
5363 const struct block
*block
= bsym
->block
;
5364 struct symbol
*sym
= bsym
->symbol
;
5368 if (!found_sym
&& arg_sym
!= NULL
)
5369 add_defn_to_vec (*resultp
,
5370 fixup_symbol_section (arg_sym
, objfile
),
5377 if (sym
->aclass () == LOC_UNRESOLVED
)
5379 else if (sym
->is_argument ())
5384 add_defn_to_vec (*resultp
,
5385 fixup_symbol_section (sym
, objfile
),
5392 /* Helper for add_nonlocal_symbols. Find symbols in DOMAIN which are
5393 targeted by renamings matching LOOKUP_NAME in BLOCK. Add these
5394 symbols to RESULT. Return whether we found such symbols. */
5397 ada_add_block_renamings (std::vector
<struct block_symbol
> &result
,
5398 const struct block
*block
,
5399 const lookup_name_info
&lookup_name
,
5402 struct using_direct
*renaming
;
5403 int defns_mark
= result
.size ();
5405 symbol_name_matcher_ftype
*name_match
5406 = ada_get_symbol_name_matcher (lookup_name
);
5408 for (renaming
= block_using (block
);
5410 renaming
= renaming
->next
)
5414 /* Avoid infinite recursions: skip this renaming if we are actually
5415 already traversing it.
5417 Currently, symbol lookup in Ada don't use the namespace machinery from
5418 C++/Fortran support: skip namespace imports that use them. */
5419 if (renaming
->searched
5420 || (renaming
->import_src
!= NULL
5421 && renaming
->import_src
[0] != '\0')
5422 || (renaming
->import_dest
!= NULL
5423 && renaming
->import_dest
[0] != '\0'))
5425 renaming
->searched
= 1;
5427 /* TODO: here, we perform another name-based symbol lookup, which can
5428 pull its own multiple overloads. In theory, we should be able to do
5429 better in this case since, in DWARF, DW_AT_import is a DIE reference,
5430 not a simple name. But in order to do this, we would need to enhance
5431 the DWARF reader to associate a symbol to this renaming, instead of a
5432 name. So, for now, we do something simpler: re-use the C++/Fortran
5433 namespace machinery. */
5434 r_name
= (renaming
->alias
!= NULL
5436 : renaming
->declaration
);
5437 if (name_match (r_name
, lookup_name
, NULL
))
5439 lookup_name_info
decl_lookup_name (renaming
->declaration
,
5440 lookup_name
.match_type ());
5441 ada_add_all_symbols (result
, block
, decl_lookup_name
, domain
,
5444 renaming
->searched
= 0;
5446 return result
.size () != defns_mark
;
5449 /* Implements compare_names, but only applying the comparision using
5450 the given CASING. */
5453 compare_names_with_case (const char *string1
, const char *string2
,
5454 enum case_sensitivity casing
)
5456 while (*string1
!= '\0' && *string2
!= '\0')
5460 if (isspace (*string1
) || isspace (*string2
))
5461 return strcmp_iw_ordered (string1
, string2
);
5463 if (casing
== case_sensitive_off
)
5465 c1
= tolower (*string1
);
5466 c2
= tolower (*string2
);
5483 return strcmp_iw_ordered (string1
, string2
);
5485 if (*string2
== '\0')
5487 if (is_name_suffix (string1
))
5494 if (*string2
== '(')
5495 return strcmp_iw_ordered (string1
, string2
);
5498 if (casing
== case_sensitive_off
)
5499 return tolower (*string1
) - tolower (*string2
);
5501 return *string1
- *string2
;
5506 /* Compare STRING1 to STRING2, with results as for strcmp.
5507 Compatible with strcmp_iw_ordered in that...
5509 strcmp_iw_ordered (STRING1, STRING2) <= 0
5513 compare_names (STRING1, STRING2) <= 0
5515 (they may differ as to what symbols compare equal). */
5518 compare_names (const char *string1
, const char *string2
)
5522 /* Similar to what strcmp_iw_ordered does, we need to perform
5523 a case-insensitive comparison first, and only resort to
5524 a second, case-sensitive, comparison if the first one was
5525 not sufficient to differentiate the two strings. */
5527 result
= compare_names_with_case (string1
, string2
, case_sensitive_off
);
5529 result
= compare_names_with_case (string1
, string2
, case_sensitive_on
);
5534 /* Convenience function to get at the Ada encoded lookup name for
5535 LOOKUP_NAME, as a C string. */
5538 ada_lookup_name (const lookup_name_info
&lookup_name
)
5540 return lookup_name
.ada ().lookup_name ().c_str ();
5543 /* A helper for add_nonlocal_symbols. Call expand_matching_symbols
5544 for OBJFILE, then walk the objfile's symtabs and update the
5548 map_matching_symbols (struct objfile
*objfile
,
5549 const lookup_name_info
&lookup_name
,
5555 data
.objfile
= objfile
;
5556 objfile
->expand_matching_symbols (lookup_name
, domain
, global
,
5557 is_wild_match
? nullptr : compare_names
);
5559 const int block_kind
= global
? GLOBAL_BLOCK
: STATIC_BLOCK
;
5560 for (compunit_symtab
*symtab
: objfile
->compunits ())
5562 const struct block
*block
5563 = BLOCKVECTOR_BLOCK (symtab
->blockvector (), block_kind
);
5564 if (!iterate_over_symbols_terminated (block
, lookup_name
,
5570 /* Add to RESULT all non-local symbols whose name and domain match
5571 LOOKUP_NAME and DOMAIN respectively. The search is performed on
5572 GLOBAL_BLOCK symbols if GLOBAL is non-zero, or on STATIC_BLOCK
5573 symbols otherwise. */
5576 add_nonlocal_symbols (std::vector
<struct block_symbol
> &result
,
5577 const lookup_name_info
&lookup_name
,
5578 domain_enum domain
, int global
)
5580 struct match_data
data (&result
);
5582 bool is_wild_match
= lookup_name
.ada ().wild_match_p ();
5584 for (objfile
*objfile
: current_program_space
->objfiles ())
5586 map_matching_symbols (objfile
, lookup_name
, is_wild_match
, domain
,
5589 for (compunit_symtab
*cu
: objfile
->compunits ())
5591 const struct block
*global_block
5592 = BLOCKVECTOR_BLOCK (cu
->blockvector (), GLOBAL_BLOCK
);
5594 if (ada_add_block_renamings (result
, global_block
, lookup_name
,
5596 data
.found_sym
= true;
5600 if (result
.empty () && global
&& !is_wild_match
)
5602 const char *name
= ada_lookup_name (lookup_name
);
5603 std::string bracket_name
= std::string ("<_ada_") + name
+ '>';
5604 lookup_name_info
name1 (bracket_name
, symbol_name_match_type::FULL
);
5606 for (objfile
*objfile
: current_program_space
->objfiles ())
5607 map_matching_symbols (objfile
, name1
, false, domain
, global
, data
);
5611 /* Find symbols in DOMAIN matching LOOKUP_NAME, in BLOCK and, if
5612 FULL_SEARCH is non-zero, enclosing scope and in global scopes,
5613 returning the number of matches. Add these to RESULT.
5615 When FULL_SEARCH is non-zero, any non-function/non-enumeral
5616 symbol match within the nest of blocks whose innermost member is BLOCK,
5617 is the one match returned (no other matches in that or
5618 enclosing blocks is returned). If there are any matches in or
5619 surrounding BLOCK, then these alone are returned.
5621 Names prefixed with "standard__" are handled specially:
5622 "standard__" is first stripped off (by the lookup_name
5623 constructor), and only static and global symbols are searched.
5625 If MADE_GLOBAL_LOOKUP_P is non-null, set it before return to whether we had
5626 to lookup global symbols. */
5629 ada_add_all_symbols (std::vector
<struct block_symbol
> &result
,
5630 const struct block
*block
,
5631 const lookup_name_info
&lookup_name
,
5634 int *made_global_lookup_p
)
5638 if (made_global_lookup_p
)
5639 *made_global_lookup_p
= 0;
5641 /* Special case: If the user specifies a symbol name inside package
5642 Standard, do a non-wild matching of the symbol name without
5643 the "standard__" prefix. This was primarily introduced in order
5644 to allow the user to specifically access the standard exceptions
5645 using, for instance, Standard.Constraint_Error when Constraint_Error
5646 is ambiguous (due to the user defining its own Constraint_Error
5647 entity inside its program). */
5648 if (lookup_name
.ada ().standard_p ())
5651 /* Check the non-global symbols. If we have ANY match, then we're done. */
5656 ada_add_local_symbols (result
, lookup_name
, block
, domain
);
5659 /* In the !full_search case we're are being called by
5660 iterate_over_symbols, and we don't want to search
5662 ada_add_block_symbols (result
, block
, lookup_name
, domain
, NULL
);
5664 if (!result
.empty () || !full_search
)
5668 /* No non-global symbols found. Check our cache to see if we have
5669 already performed this search before. If we have, then return
5672 if (lookup_cached_symbol (ada_lookup_name (lookup_name
),
5673 domain
, &sym
, &block
))
5676 add_defn_to_vec (result
, sym
, block
);
5680 if (made_global_lookup_p
)
5681 *made_global_lookup_p
= 1;
5683 /* Search symbols from all global blocks. */
5685 add_nonlocal_symbols (result
, lookup_name
, domain
, 1);
5687 /* Now add symbols from all per-file blocks if we've gotten no hits
5688 (not strictly correct, but perhaps better than an error). */
5690 if (result
.empty ())
5691 add_nonlocal_symbols (result
, lookup_name
, domain
, 0);
5694 /* Find symbols in DOMAIN matching LOOKUP_NAME, in BLOCK and, if FULL_SEARCH
5695 is non-zero, enclosing scope and in global scopes.
5697 Returns (SYM,BLOCK) tuples, indicating the symbols found and the
5698 blocks and symbol tables (if any) in which they were found.
5700 When full_search is non-zero, any non-function/non-enumeral
5701 symbol match within the nest of blocks whose innermost member is BLOCK,
5702 is the one match returned (no other matches in that or
5703 enclosing blocks is returned). If there are any matches in or
5704 surrounding BLOCK, then these alone are returned.
5706 Names prefixed with "standard__" are handled specially: "standard__"
5707 is first stripped off, and only static and global symbols are searched. */
5709 static std::vector
<struct block_symbol
>
5710 ada_lookup_symbol_list_worker (const lookup_name_info
&lookup_name
,
5711 const struct block
*block
,
5715 int syms_from_global_search
;
5716 std::vector
<struct block_symbol
> results
;
5718 ada_add_all_symbols (results
, block
, lookup_name
,
5719 domain
, full_search
, &syms_from_global_search
);
5721 remove_extra_symbols (&results
);
5723 if (results
.empty () && full_search
&& syms_from_global_search
)
5724 cache_symbol (ada_lookup_name (lookup_name
), domain
, NULL
, NULL
);
5726 if (results
.size () == 1 && full_search
&& syms_from_global_search
)
5727 cache_symbol (ada_lookup_name (lookup_name
), domain
,
5728 results
[0].symbol
, results
[0].block
);
5730 remove_irrelevant_renamings (&results
, block
);
5734 /* Find symbols in DOMAIN matching NAME, in BLOCK and enclosing scope and
5735 in global scopes, returning (SYM,BLOCK) tuples.
5737 See ada_lookup_symbol_list_worker for further details. */
5739 std::vector
<struct block_symbol
>
5740 ada_lookup_symbol_list (const char *name
, const struct block
*block
,
5743 symbol_name_match_type name_match_type
= name_match_type_from_name (name
);
5744 lookup_name_info
lookup_name (name
, name_match_type
);
5746 return ada_lookup_symbol_list_worker (lookup_name
, block
, domain
, 1);
5749 /* The result is as for ada_lookup_symbol_list with FULL_SEARCH set
5750 to 1, but choosing the first symbol found if there are multiple
5753 The result is stored in *INFO, which must be non-NULL.
5754 If no match is found, INFO->SYM is set to NULL. */
5757 ada_lookup_encoded_symbol (const char *name
, const struct block
*block
,
5759 struct block_symbol
*info
)
5761 /* Since we already have an encoded name, wrap it in '<>' to force a
5762 verbatim match. Otherwise, if the name happens to not look like
5763 an encoded name (because it doesn't include a "__"),
5764 ada_lookup_name_info would re-encode/fold it again, and that
5765 would e.g., incorrectly lowercase object renaming names like
5766 "R28b" -> "r28b". */
5767 std::string verbatim
= add_angle_brackets (name
);
5769 gdb_assert (info
!= NULL
);
5770 *info
= ada_lookup_symbol (verbatim
.c_str (), block
, domain
);
5773 /* Return a symbol in DOMAIN matching NAME, in BLOCK0 and enclosing
5774 scope and in global scopes, or NULL if none. NAME is folded and
5775 encoded first. Otherwise, the result is as for ada_lookup_symbol_list,
5776 choosing the first symbol if there are multiple choices. */
5779 ada_lookup_symbol (const char *name
, const struct block
*block0
,
5782 std::vector
<struct block_symbol
> candidates
5783 = ada_lookup_symbol_list (name
, block0
, domain
);
5785 if (candidates
.empty ())
5788 block_symbol info
= candidates
[0];
5789 info
.symbol
= fixup_symbol_section (info
.symbol
, NULL
);
5794 /* True iff STR is a possible encoded suffix of a normal Ada name
5795 that is to be ignored for matching purposes. Suffixes of parallel
5796 names (e.g., XVE) are not included here. Currently, the possible suffixes
5797 are given by any of the regular expressions:
5799 [.$][0-9]+ [nested subprogram suffix, on platforms such as GNU/Linux]
5800 ___[0-9]+ [nested subprogram suffix, on platforms such as HP/UX]
5801 TKB [subprogram suffix for task bodies]
5802 _E[0-9]+[bs]$ [protected object entry suffixes]
5803 (X[nb]*)?((\$|__)[0-9](_?[0-9]+)|___(JM|LJM|X([FDBUP].*|R[^T]?)))?$
5805 Also, any leading "__[0-9]+" sequence is skipped before the suffix
5806 match is performed. This sequence is used to differentiate homonyms,
5807 is an optional part of a valid name suffix. */
5810 is_name_suffix (const char *str
)
5813 const char *matching
;
5814 const int len
= strlen (str
);
5816 /* Skip optional leading __[0-9]+. */
5818 if (len
> 3 && str
[0] == '_' && str
[1] == '_' && isdigit (str
[2]))
5821 while (isdigit (str
[0]))
5827 if (str
[0] == '.' || str
[0] == '$')
5830 while (isdigit (matching
[0]))
5832 if (matching
[0] == '\0')
5838 if (len
> 3 && str
[0] == '_' && str
[1] == '_' && str
[2] == '_')
5841 while (isdigit (matching
[0]))
5843 if (matching
[0] == '\0')
5847 /* "TKB" suffixes are used for subprograms implementing task bodies. */
5849 if (strcmp (str
, "TKB") == 0)
5853 /* FIXME: brobecker/2005-09-23: Protected Object subprograms end
5854 with a N at the end. Unfortunately, the compiler uses the same
5855 convention for other internal types it creates. So treating
5856 all entity names that end with an "N" as a name suffix causes
5857 some regressions. For instance, consider the case of an enumerated
5858 type. To support the 'Image attribute, it creates an array whose
5860 Having a single character like this as a suffix carrying some
5861 information is a bit risky. Perhaps we should change the encoding
5862 to be something like "_N" instead. In the meantime, do not do
5863 the following check. */
5864 /* Protected Object Subprograms */
5865 if (len
== 1 && str
[0] == 'N')
5870 if (len
> 3 && str
[0] == '_' && str
[1] == 'E' && isdigit (str
[2]))
5873 while (isdigit (matching
[0]))
5875 if ((matching
[0] == 'b' || matching
[0] == 's')
5876 && matching
[1] == '\0')
5880 /* ??? We should not modify STR directly, as we are doing below. This
5881 is fine in this case, but may become problematic later if we find
5882 that this alternative did not work, and want to try matching
5883 another one from the begining of STR. Since we modified it, we
5884 won't be able to find the begining of the string anymore! */
5888 while (str
[0] != '_' && str
[0] != '\0')
5890 if (str
[0] != 'n' && str
[0] != 'b')
5896 if (str
[0] == '\000')
5901 if (str
[1] != '_' || str
[2] == '\000')
5905 if (strcmp (str
+ 3, "JM") == 0)
5907 /* FIXME: brobecker/2004-09-30: GNAT will soon stop using
5908 the LJM suffix in favor of the JM one. But we will
5909 still accept LJM as a valid suffix for a reasonable
5910 amount of time, just to allow ourselves to debug programs
5911 compiled using an older version of GNAT. */
5912 if (strcmp (str
+ 3, "LJM") == 0)
5916 if (str
[4] == 'F' || str
[4] == 'D' || str
[4] == 'B'
5917 || str
[4] == 'U' || str
[4] == 'P')
5919 if (str
[4] == 'R' && str
[5] != 'T')
5923 if (!isdigit (str
[2]))
5925 for (k
= 3; str
[k
] != '\0'; k
+= 1)
5926 if (!isdigit (str
[k
]) && str
[k
] != '_')
5930 if (str
[0] == '$' && isdigit (str
[1]))
5932 for (k
= 2; str
[k
] != '\0'; k
+= 1)
5933 if (!isdigit (str
[k
]) && str
[k
] != '_')
5940 /* Return non-zero if the string starting at NAME and ending before
5941 NAME_END contains no capital letters. */
5944 is_valid_name_for_wild_match (const char *name0
)
5946 std::string decoded_name
= ada_decode (name0
);
5949 /* If the decoded name starts with an angle bracket, it means that
5950 NAME0 does not follow the GNAT encoding format. It should then
5951 not be allowed as a possible wild match. */
5952 if (decoded_name
[0] == '<')
5955 for (i
=0; decoded_name
[i
] != '\0'; i
++)
5956 if (isalpha (decoded_name
[i
]) && !islower (decoded_name
[i
]))
5962 /* Advance *NAMEP to next occurrence in the string NAME0 of the TARGET0
5963 character which could start a simple name. Assumes that *NAMEP points
5964 somewhere inside the string beginning at NAME0. */
5967 advance_wild_match (const char **namep
, const char *name0
, char target0
)
5969 const char *name
= *namep
;
5979 if ((t1
>= 'a' && t1
<= 'z') || (t1
>= '0' && t1
<= '9'))
5982 if (name
== name0
+ 5 && startswith (name0
, "_ada"))
5987 else if (t1
== '_' && ((name
[2] >= 'a' && name
[2] <= 'z')
5988 || name
[2] == target0
))
5993 else if (t1
== '_' && name
[2] == 'B' && name
[3] == '_')
5995 /* Names like "pkg__B_N__name", where N is a number, are
5996 block-local. We can handle these by simply skipping
6003 else if ((t0
>= 'a' && t0
<= 'z') || (t0
>= '0' && t0
<= '9'))
6013 /* Return true iff NAME encodes a name of the form prefix.PATN.
6014 Ignores any informational suffixes of NAME (i.e., for which
6015 is_name_suffix is true). Assumes that PATN is a lower-cased Ada
6019 wild_match (const char *name
, const char *patn
)
6022 const char *name0
= name
;
6024 if (startswith (name
, "___ghost_"))
6029 const char *match
= name
;
6033 for (name
+= 1, p
= patn
+ 1; *p
!= '\0'; name
+= 1, p
+= 1)
6036 if (*p
== '\0' && is_name_suffix (name
))
6037 return match
== name0
|| is_valid_name_for_wild_match (name0
);
6039 if (name
[-1] == '_')
6042 if (!advance_wild_match (&name
, name0
, *patn
))
6047 /* Add symbols from BLOCK matching LOOKUP_NAME in DOMAIN to RESULT (if
6048 necessary). OBJFILE is the section containing BLOCK. */
6051 ada_add_block_symbols (std::vector
<struct block_symbol
> &result
,
6052 const struct block
*block
,
6053 const lookup_name_info
&lookup_name
,
6054 domain_enum domain
, struct objfile
*objfile
)
6056 struct block_iterator iter
;
6057 /* A matching argument symbol, if any. */
6058 struct symbol
*arg_sym
;
6059 /* Set true when we find a matching non-argument symbol. */
6065 for (sym
= block_iter_match_first (block
, lookup_name
, &iter
);
6067 sym
= block_iter_match_next (lookup_name
, &iter
))
6069 if (symbol_matches_domain (sym
->language (), sym
->domain (), domain
))
6071 if (sym
->aclass () != LOC_UNRESOLVED
)
6073 if (sym
->is_argument ())
6078 add_defn_to_vec (result
,
6079 fixup_symbol_section (sym
, objfile
),
6086 /* Handle renamings. */
6088 if (ada_add_block_renamings (result
, block
, lookup_name
, domain
))
6091 if (!found_sym
&& arg_sym
!= NULL
)
6093 add_defn_to_vec (result
,
6094 fixup_symbol_section (arg_sym
, objfile
),
6098 if (!lookup_name
.ada ().wild_match_p ())
6102 const std::string
&ada_lookup_name
= lookup_name
.ada ().lookup_name ();
6103 const char *name
= ada_lookup_name
.c_str ();
6104 size_t name_len
= ada_lookup_name
.size ();
6106 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
6108 if (symbol_matches_domain (sym
->language (),
6109 sym
->domain (), domain
))
6113 cmp
= (int) '_' - (int) sym
->linkage_name ()[0];
6116 cmp
= !startswith (sym
->linkage_name (), "_ada_");
6118 cmp
= strncmp (name
, sym
->linkage_name () + 5,
6123 && is_name_suffix (sym
->linkage_name () + name_len
+ 5))
6125 if (sym
->aclass () != LOC_UNRESOLVED
)
6127 if (sym
->is_argument ())
6132 add_defn_to_vec (result
,
6133 fixup_symbol_section (sym
, objfile
),
6141 /* NOTE: This really shouldn't be needed for _ada_ symbols.
6142 They aren't parameters, right? */
6143 if (!found_sym
&& arg_sym
!= NULL
)
6145 add_defn_to_vec (result
,
6146 fixup_symbol_section (arg_sym
, objfile
),
6153 /* Symbol Completion */
6158 ada_lookup_name_info::matches
6159 (const char *sym_name
,
6160 symbol_name_match_type match_type
,
6161 completion_match_result
*comp_match_res
) const
6164 const char *text
= m_encoded_name
.c_str ();
6165 size_t text_len
= m_encoded_name
.size ();
6167 /* First, test against the fully qualified name of the symbol. */
6169 if (strncmp (sym_name
, text
, text_len
) == 0)
6172 std::string decoded_name
= ada_decode (sym_name
);
6173 if (match
&& !m_encoded_p
)
6175 /* One needed check before declaring a positive match is to verify
6176 that iff we are doing a verbatim match, the decoded version
6177 of the symbol name starts with '<'. Otherwise, this symbol name
6178 is not a suitable completion. */
6180 bool has_angle_bracket
= (decoded_name
[0] == '<');
6181 match
= (has_angle_bracket
== m_verbatim_p
);
6184 if (match
&& !m_verbatim_p
)
6186 /* When doing non-verbatim match, another check that needs to
6187 be done is to verify that the potentially matching symbol name
6188 does not include capital letters, because the ada-mode would
6189 not be able to understand these symbol names without the
6190 angle bracket notation. */
6193 for (tmp
= sym_name
; *tmp
!= '\0' && !isupper (*tmp
); tmp
++);
6198 /* Second: Try wild matching... */
6200 if (!match
&& m_wild_match_p
)
6202 /* Since we are doing wild matching, this means that TEXT
6203 may represent an unqualified symbol name. We therefore must
6204 also compare TEXT against the unqualified name of the symbol. */
6205 sym_name
= ada_unqualified_name (decoded_name
.c_str ());
6207 if (strncmp (sym_name
, text
, text_len
) == 0)
6211 /* Finally: If we found a match, prepare the result to return. */
6216 if (comp_match_res
!= NULL
)
6218 std::string
&match_str
= comp_match_res
->match
.storage ();
6221 match_str
= ada_decode (sym_name
);
6225 match_str
= add_angle_brackets (sym_name
);
6227 match_str
= sym_name
;
6231 comp_match_res
->set_match (match_str
.c_str ());
6239 /* Return non-zero if TYPE is a pointer to the GNAT dispatch table used
6240 for tagged types. */
6243 ada_is_dispatch_table_ptr_type (struct type
*type
)
6247 if (type
->code () != TYPE_CODE_PTR
)
6250 name
= TYPE_TARGET_TYPE (type
)->name ();
6254 return (strcmp (name
, "ada__tags__dispatch_table") == 0);
6257 /* Return non-zero if TYPE is an interface tag. */
6260 ada_is_interface_tag (struct type
*type
)
6262 const char *name
= type
->name ();
6267 return (strcmp (name
, "ada__tags__interface_tag") == 0);
6270 /* True if field number FIELD_NUM in struct or union type TYPE is supposed
6271 to be invisible to users. */
6274 ada_is_ignored_field (struct type
*type
, int field_num
)
6276 if (field_num
< 0 || field_num
> type
->num_fields ())
6279 /* Check the name of that field. */
6281 const char *name
= type
->field (field_num
).name ();
6283 /* Anonymous field names should not be printed.
6284 brobecker/2007-02-20: I don't think this can actually happen
6285 but we don't want to print the value of anonymous fields anyway. */
6289 /* Normally, fields whose name start with an underscore ("_")
6290 are fields that have been internally generated by the compiler,
6291 and thus should not be printed. The "_parent" field is special,
6292 however: This is a field internally generated by the compiler
6293 for tagged types, and it contains the components inherited from
6294 the parent type. This field should not be printed as is, but
6295 should not be ignored either. */
6296 if (name
[0] == '_' && !startswith (name
, "_parent"))
6299 /* The compiler doesn't document this, but sometimes it emits
6300 a field whose name starts with a capital letter, like 'V148s'.
6301 These aren't marked as artificial in any way, but we know they
6302 should be ignored. However, wrapper fields should not be
6304 if (name
[0] == 'S' || name
[0] == 'R' || name
[0] == 'O')
6306 /* Wrapper field. */
6308 else if (isupper (name
[0]))
6312 /* If this is the dispatch table of a tagged type or an interface tag,
6314 if (ada_is_tagged_type (type
, 1)
6315 && (ada_is_dispatch_table_ptr_type (type
->field (field_num
).type ())
6316 || ada_is_interface_tag (type
->field (field_num
).type ())))
6319 /* Not a special field, so it should not be ignored. */
6323 /* True iff TYPE has a tag field. If REFOK, then TYPE may also be a
6324 pointer or reference type whose ultimate target has a tag field. */
6327 ada_is_tagged_type (struct type
*type
, int refok
)
6329 return (ada_lookup_struct_elt_type (type
, "_tag", refok
, 1) != NULL
);
6332 /* True iff TYPE represents the type of X'Tag */
6335 ada_is_tag_type (struct type
*type
)
6337 type
= ada_check_typedef (type
);
6339 if (type
== NULL
|| type
->code () != TYPE_CODE_PTR
)
6343 const char *name
= ada_type_name (TYPE_TARGET_TYPE (type
));
6345 return (name
!= NULL
6346 && strcmp (name
, "ada__tags__dispatch_table") == 0);
6350 /* The type of the tag on VAL. */
6352 static struct type
*
6353 ada_tag_type (struct value
*val
)
6355 return ada_lookup_struct_elt_type (value_type (val
), "_tag", 1, 0);
6358 /* Return 1 if TAG follows the old scheme for Ada tags (used for Ada 95,
6359 retired at Ada 05). */
6362 is_ada95_tag (struct value
*tag
)
6364 return ada_value_struct_elt (tag
, "tsd", 1) != NULL
;
6367 /* The value of the tag on VAL. */
6369 static struct value
*
6370 ada_value_tag (struct value
*val
)
6372 return ada_value_struct_elt (val
, "_tag", 0);
6375 /* The value of the tag on the object of type TYPE whose contents are
6376 saved at VALADDR, if it is non-null, or is at memory address
6379 static struct value
*
6380 value_tag_from_contents_and_address (struct type
*type
,
6381 const gdb_byte
*valaddr
,
6384 int tag_byte_offset
;
6385 struct type
*tag_type
;
6387 gdb::array_view
<const gdb_byte
> contents
;
6388 if (valaddr
!= nullptr)
6389 contents
= gdb::make_array_view (valaddr
, TYPE_LENGTH (type
));
6390 struct type
*resolved_type
= resolve_dynamic_type (type
, contents
, address
);
6391 if (find_struct_field ("_tag", resolved_type
, 0, &tag_type
, &tag_byte_offset
,
6394 const gdb_byte
*valaddr1
= ((valaddr
== NULL
)
6396 : valaddr
+ tag_byte_offset
);
6397 CORE_ADDR address1
= (address
== 0) ? 0 : address
+ tag_byte_offset
;
6399 return value_from_contents_and_address (tag_type
, valaddr1
, address1
);
6404 static struct type
*
6405 type_from_tag (struct value
*tag
)
6407 gdb::unique_xmalloc_ptr
<char> type_name
= ada_tag_name (tag
);
6409 if (type_name
!= NULL
)
6410 return ada_find_any_type (ada_encode (type_name
.get ()).c_str ());
6414 /* Given a value OBJ of a tagged type, return a value of this
6415 type at the base address of the object. The base address, as
6416 defined in Ada.Tags, it is the address of the primary tag of
6417 the object, and therefore where the field values of its full
6418 view can be fetched. */
6421 ada_tag_value_at_base_address (struct value
*obj
)
6424 LONGEST offset_to_top
= 0;
6425 struct type
*ptr_type
, *obj_type
;
6427 CORE_ADDR base_address
;
6429 obj_type
= value_type (obj
);
6431 /* It is the responsability of the caller to deref pointers. */
6433 if (obj_type
->code () == TYPE_CODE_PTR
|| obj_type
->code () == TYPE_CODE_REF
)
6436 tag
= ada_value_tag (obj
);
6440 /* Base addresses only appeared with Ada 05 and multiple inheritance. */
6442 if (is_ada95_tag (tag
))
6445 struct type
*offset_type
6446 = language_lookup_primitive_type (language_def (language_ada
),
6447 target_gdbarch(), "storage_offset");
6448 ptr_type
= lookup_pointer_type (offset_type
);
6449 val
= value_cast (ptr_type
, tag
);
6453 /* It is perfectly possible that an exception be raised while
6454 trying to determine the base address, just like for the tag;
6455 see ada_tag_name for more details. We do not print the error
6456 message for the same reason. */
6460 offset_to_top
= value_as_long (value_ind (value_ptradd (val
, -2)));
6463 catch (const gdb_exception_error
&e
)
6468 /* If offset is null, nothing to do. */
6470 if (offset_to_top
== 0)
6473 /* -1 is a special case in Ada.Tags; however, what should be done
6474 is not quite clear from the documentation. So do nothing for
6477 if (offset_to_top
== -1)
6480 /* Storage_Offset'Last is used to indicate that a dynamic offset to
6481 top is used. In this situation the offset is stored just after
6482 the tag, in the object itself. */
6483 ULONGEST last
= (((ULONGEST
) 1) << (8 * TYPE_LENGTH (offset_type
) - 1)) - 1;
6484 if (offset_to_top
== last
)
6486 struct value
*tem
= value_addr (tag
);
6487 tem
= value_ptradd (tem
, 1);
6488 tem
= value_cast (ptr_type
, tem
);
6489 offset_to_top
= value_as_long (value_ind (tem
));
6491 else if (offset_to_top
> 0)
6493 /* OFFSET_TO_TOP used to be a positive value to be subtracted
6494 from the base address. This was however incompatible with
6495 C++ dispatch table: C++ uses a *negative* value to *add*
6496 to the base address. Ada's convention has therefore been
6497 changed in GNAT 19.0w 20171023: since then, C++ and Ada
6498 use the same convention. Here, we support both cases by
6499 checking the sign of OFFSET_TO_TOP. */
6500 offset_to_top
= -offset_to_top
;
6503 base_address
= value_address (obj
) + offset_to_top
;
6504 tag
= value_tag_from_contents_and_address (obj_type
, NULL
, base_address
);
6506 /* Make sure that we have a proper tag at the new address.
6507 Otherwise, offset_to_top is bogus (which can happen when
6508 the object is not initialized yet). */
6513 obj_type
= type_from_tag (tag
);
6518 return value_from_contents_and_address (obj_type
, NULL
, base_address
);
6521 /* Return the "ada__tags__type_specific_data" type. */
6523 static struct type
*
6524 ada_get_tsd_type (struct inferior
*inf
)
6526 struct ada_inferior_data
*data
= get_ada_inferior_data (inf
);
6528 if (data
->tsd_type
== 0)
6529 data
->tsd_type
= ada_find_any_type ("ada__tags__type_specific_data");
6530 return data
->tsd_type
;
6533 /* Return the TSD (type-specific data) associated to the given TAG.
6534 TAG is assumed to be the tag of a tagged-type entity.
6536 May return NULL if we are unable to get the TSD. */
6538 static struct value
*
6539 ada_get_tsd_from_tag (struct value
*tag
)
6544 /* First option: The TSD is simply stored as a field of our TAG.
6545 Only older versions of GNAT would use this format, but we have
6546 to test it first, because there are no visible markers for
6547 the current approach except the absence of that field. */
6549 val
= ada_value_struct_elt (tag
, "tsd", 1);
6553 /* Try the second representation for the dispatch table (in which
6554 there is no explicit 'tsd' field in the referent of the tag pointer,
6555 and instead the tsd pointer is stored just before the dispatch
6558 type
= ada_get_tsd_type (current_inferior());
6561 type
= lookup_pointer_type (lookup_pointer_type (type
));
6562 val
= value_cast (type
, tag
);
6565 return value_ind (value_ptradd (val
, -1));
6568 /* Given the TSD of a tag (type-specific data), return a string
6569 containing the name of the associated type.
6571 May return NULL if we are unable to determine the tag name. */
6573 static gdb::unique_xmalloc_ptr
<char>
6574 ada_tag_name_from_tsd (struct value
*tsd
)
6578 val
= ada_value_struct_elt (tsd
, "expanded_name", 1);
6581 gdb::unique_xmalloc_ptr
<char> buffer
6582 = target_read_string (value_as_address (val
), INT_MAX
);
6583 if (buffer
== nullptr)
6588 /* Let this throw an exception on error. If the data is
6589 uninitialized, we'd rather not have the user see a
6591 const char *folded
= ada_fold_name (buffer
.get (), true);
6592 return make_unique_xstrdup (folded
);
6594 catch (const gdb_exception
&)
6600 /* The type name of the dynamic type denoted by the 'tag value TAG, as
6603 Return NULL if the TAG is not an Ada tag, or if we were unable to
6604 determine the name of that tag. */
6606 gdb::unique_xmalloc_ptr
<char>
6607 ada_tag_name (struct value
*tag
)
6609 gdb::unique_xmalloc_ptr
<char> name
;
6611 if (!ada_is_tag_type (value_type (tag
)))
6614 /* It is perfectly possible that an exception be raised while trying
6615 to determine the TAG's name, even under normal circumstances:
6616 The associated variable may be uninitialized or corrupted, for
6617 instance. We do not let any exception propagate past this point.
6618 instead we return NULL.
6620 We also do not print the error message either (which often is very
6621 low-level (Eg: "Cannot read memory at 0x[...]"), but instead let
6622 the caller print a more meaningful message if necessary. */
6625 struct value
*tsd
= ada_get_tsd_from_tag (tag
);
6628 name
= ada_tag_name_from_tsd (tsd
);
6630 catch (const gdb_exception_error
&e
)
6637 /* The parent type of TYPE, or NULL if none. */
6640 ada_parent_type (struct type
*type
)
6644 type
= ada_check_typedef (type
);
6646 if (type
== NULL
|| type
->code () != TYPE_CODE_STRUCT
)
6649 for (i
= 0; i
< type
->num_fields (); i
+= 1)
6650 if (ada_is_parent_field (type
, i
))
6652 struct type
*parent_type
= type
->field (i
).type ();
6654 /* If the _parent field is a pointer, then dereference it. */
6655 if (parent_type
->code () == TYPE_CODE_PTR
)
6656 parent_type
= TYPE_TARGET_TYPE (parent_type
);
6657 /* If there is a parallel XVS type, get the actual base type. */
6658 parent_type
= ada_get_base_type (parent_type
);
6660 return ada_check_typedef (parent_type
);
6666 /* True iff field number FIELD_NUM of structure type TYPE contains the
6667 parent-type (inherited) fields of a derived type. Assumes TYPE is
6668 a structure type with at least FIELD_NUM+1 fields. */
6671 ada_is_parent_field (struct type
*type
, int field_num
)
6673 const char *name
= ada_check_typedef (type
)->field (field_num
).name ();
6675 return (name
!= NULL
6676 && (startswith (name
, "PARENT")
6677 || startswith (name
, "_parent")));
6680 /* True iff field number FIELD_NUM of structure type TYPE is a
6681 transparent wrapper field (which should be silently traversed when doing
6682 field selection and flattened when printing). Assumes TYPE is a
6683 structure type with at least FIELD_NUM+1 fields. Such fields are always
6687 ada_is_wrapper_field (struct type
*type
, int field_num
)
6689 const char *name
= type
->field (field_num
).name ();
6691 if (name
!= NULL
&& strcmp (name
, "RETVAL") == 0)
6693 /* This happens in functions with "out" or "in out" parameters
6694 which are passed by copy. For such functions, GNAT describes
6695 the function's return type as being a struct where the return
6696 value is in a field called RETVAL, and where the other "out"
6697 or "in out" parameters are fields of that struct. This is not
6702 return (name
!= NULL
6703 && (startswith (name
, "PARENT")
6704 || strcmp (name
, "REP") == 0
6705 || startswith (name
, "_parent")
6706 || name
[0] == 'S' || name
[0] == 'R' || name
[0] == 'O'));
6709 /* True iff field number FIELD_NUM of structure or union type TYPE
6710 is a variant wrapper. Assumes TYPE is a structure type with at least
6711 FIELD_NUM+1 fields. */
6714 ada_is_variant_part (struct type
*type
, int field_num
)
6716 /* Only Ada types are eligible. */
6717 if (!ADA_TYPE_P (type
))
6720 struct type
*field_type
= type
->field (field_num
).type ();
6722 return (field_type
->code () == TYPE_CODE_UNION
6723 || (is_dynamic_field (type
, field_num
)
6724 && (TYPE_TARGET_TYPE (field_type
)->code ()
6725 == TYPE_CODE_UNION
)));
6728 /* Assuming that VAR_TYPE is a variant wrapper (type of the variant part)
6729 whose discriminants are contained in the record type OUTER_TYPE,
6730 returns the type of the controlling discriminant for the variant.
6731 May return NULL if the type could not be found. */
6734 ada_variant_discrim_type (struct type
*var_type
, struct type
*outer_type
)
6736 const char *name
= ada_variant_discrim_name (var_type
);
6738 return ada_lookup_struct_elt_type (outer_type
, name
, 1, 1);
6741 /* Assuming that TYPE is the type of a variant wrapper, and FIELD_NUM is a
6742 valid field number within it, returns 1 iff field FIELD_NUM of TYPE
6743 represents a 'when others' clause; otherwise 0. */
6746 ada_is_others_clause (struct type
*type
, int field_num
)
6748 const char *name
= type
->field (field_num
).name ();
6750 return (name
!= NULL
&& name
[0] == 'O');
6753 /* Assuming that TYPE0 is the type of the variant part of a record,
6754 returns the name of the discriminant controlling the variant.
6755 The value is valid until the next call to ada_variant_discrim_name. */
6758 ada_variant_discrim_name (struct type
*type0
)
6760 static std::string result
;
6763 const char *discrim_end
;
6764 const char *discrim_start
;
6766 if (type0
->code () == TYPE_CODE_PTR
)
6767 type
= TYPE_TARGET_TYPE (type0
);
6771 name
= ada_type_name (type
);
6773 if (name
== NULL
|| name
[0] == '\000')
6776 for (discrim_end
= name
+ strlen (name
) - 6; discrim_end
!= name
;
6779 if (startswith (discrim_end
, "___XVN"))
6782 if (discrim_end
== name
)
6785 for (discrim_start
= discrim_end
; discrim_start
!= name
+ 3;
6788 if (discrim_start
== name
+ 1)
6790 if ((discrim_start
> name
+ 3
6791 && startswith (discrim_start
- 3, "___"))
6792 || discrim_start
[-1] == '.')
6796 result
= std::string (discrim_start
, discrim_end
- discrim_start
);
6797 return result
.c_str ();
6800 /* Scan STR for a subtype-encoded number, beginning at position K.
6801 Put the position of the character just past the number scanned in
6802 *NEW_K, if NEW_K!=NULL. Put the scanned number in *R, if R!=NULL.
6803 Return 1 if there was a valid number at the given position, and 0
6804 otherwise. A "subtype-encoded" number consists of the absolute value
6805 in decimal, followed by the letter 'm' to indicate a negative number.
6806 Assumes 0m does not occur. */
6809 ada_scan_number (const char str
[], int k
, LONGEST
* R
, int *new_k
)
6813 if (!isdigit (str
[k
]))
6816 /* Do it the hard way so as not to make any assumption about
6817 the relationship of unsigned long (%lu scan format code) and
6820 while (isdigit (str
[k
]))
6822 RU
= RU
* 10 + (str
[k
] - '0');
6829 *R
= (-(LONGEST
) (RU
- 1)) - 1;
6835 /* NOTE on the above: Technically, C does not say what the results of
6836 - (LONGEST) RU or (LONGEST) -RU are for RU == largest positive
6837 number representable as a LONGEST (although either would probably work
6838 in most implementations). When RU>0, the locution in the then branch
6839 above is always equivalent to the negative of RU. */
6846 /* Assuming that TYPE is a variant part wrapper type (a VARIANTS field),
6847 and FIELD_NUM is a valid field number within it, returns 1 iff VAL is
6848 in the range encoded by field FIELD_NUM of TYPE; otherwise 0. */
6851 ada_in_variant (LONGEST val
, struct type
*type
, int field_num
)
6853 const char *name
= type
->field (field_num
).name ();
6867 if (!ada_scan_number (name
, p
+ 1, &W
, &p
))
6877 if (!ada_scan_number (name
, p
+ 1, &L
, &p
)
6878 || name
[p
] != 'T' || !ada_scan_number (name
, p
+ 1, &U
, &p
))
6880 if (val
>= L
&& val
<= U
)
6892 /* FIXME: Lots of redundancy below. Try to consolidate. */
6894 /* Given a value ARG1 (offset by OFFSET bytes) of a struct or union type
6895 ARG_TYPE, extract and return the value of one of its (non-static)
6896 fields. FIELDNO says which field. Differs from value_primitive_field
6897 only in that it can handle packed values of arbitrary type. */
6900 ada_value_primitive_field (struct value
*arg1
, int offset
, int fieldno
,
6901 struct type
*arg_type
)
6905 arg_type
= ada_check_typedef (arg_type
);
6906 type
= arg_type
->field (fieldno
).type ();
6908 /* Handle packed fields. It might be that the field is not packed
6909 relative to its containing structure, but the structure itself is
6910 packed; in this case we must take the bit-field path. */
6911 if (TYPE_FIELD_BITSIZE (arg_type
, fieldno
) != 0 || value_bitpos (arg1
) != 0)
6913 int bit_pos
= arg_type
->field (fieldno
).loc_bitpos ();
6914 int bit_size
= TYPE_FIELD_BITSIZE (arg_type
, fieldno
);
6916 return ada_value_primitive_packed_val (arg1
,
6917 value_contents (arg1
).data (),
6918 offset
+ bit_pos
/ 8,
6919 bit_pos
% 8, bit_size
, type
);
6922 return value_primitive_field (arg1
, offset
, fieldno
, arg_type
);
6925 /* Find field with name NAME in object of type TYPE. If found,
6926 set the following for each argument that is non-null:
6927 - *FIELD_TYPE_P to the field's type;
6928 - *BYTE_OFFSET_P to OFFSET + the byte offset of the field within
6929 an object of that type;
6930 - *BIT_OFFSET_P to the bit offset modulo byte size of the field;
6931 - *BIT_SIZE_P to its size in bits if the field is packed, and
6933 If INDEX_P is non-null, increment *INDEX_P by the number of source-visible
6934 fields up to but not including the desired field, or by the total
6935 number of fields if not found. A NULL value of NAME never
6936 matches; the function just counts visible fields in this case.
6938 Notice that we need to handle when a tagged record hierarchy
6939 has some components with the same name, like in this scenario:
6941 type Top_T is tagged record
6947 type Middle_T is new Top.Top_T with record
6948 N : Character := 'a';
6952 type Bottom_T is new Middle.Middle_T with record
6954 C : Character := '5';
6956 A : Character := 'J';
6959 Let's say we now have a variable declared and initialized as follow:
6961 TC : Top_A := new Bottom_T;
6963 And then we use this variable to call this function
6965 procedure Assign (Obj: in out Top_T; TV : Integer);
6969 Assign (Top_T (B), 12);
6971 Now, we're in the debugger, and we're inside that procedure
6972 then and we want to print the value of obj.c:
6974 Usually, the tagged record or one of the parent type owns the
6975 component to print and there's no issue but in this particular
6976 case, what does it mean to ask for Obj.C? Since the actual
6977 type for object is type Bottom_T, it could mean two things: type
6978 component C from the Middle_T view, but also component C from
6979 Bottom_T. So in that "undefined" case, when the component is
6980 not found in the non-resolved type (which includes all the
6981 components of the parent type), then resolve it and see if we
6982 get better luck once expanded.
6984 In the case of homonyms in the derived tagged type, we don't
6985 guaranty anything, and pick the one that's easiest for us
6988 Returns 1 if found, 0 otherwise. */
6991 find_struct_field (const char *name
, struct type
*type
, int offset
,
6992 struct type
**field_type_p
,
6993 int *byte_offset_p
, int *bit_offset_p
, int *bit_size_p
,
6997 int parent_offset
= -1;
6999 type
= ada_check_typedef (type
);
7001 if (field_type_p
!= NULL
)
7002 *field_type_p
= NULL
;
7003 if (byte_offset_p
!= NULL
)
7005 if (bit_offset_p
!= NULL
)
7007 if (bit_size_p
!= NULL
)
7010 for (i
= 0; i
< type
->num_fields (); i
+= 1)
7012 /* These can't be computed using TYPE_FIELD_BITPOS for a dynamic
7013 type. However, we only need the values to be correct when
7014 the caller asks for them. */
7015 int bit_pos
= 0, fld_offset
= 0;
7016 if (byte_offset_p
!= nullptr || bit_offset_p
!= nullptr)
7018 bit_pos
= type
->field (i
).loc_bitpos ();
7019 fld_offset
= offset
+ bit_pos
/ 8;
7022 const char *t_field_name
= type
->field (i
).name ();
7024 if (t_field_name
== NULL
)
7027 else if (ada_is_parent_field (type
, i
))
7029 /* This is a field pointing us to the parent type of a tagged
7030 type. As hinted in this function's documentation, we give
7031 preference to fields in the current record first, so what
7032 we do here is just record the index of this field before
7033 we skip it. If it turns out we couldn't find our field
7034 in the current record, then we'll get back to it and search
7035 inside it whether the field might exist in the parent. */
7041 else if (name
!= NULL
&& field_name_match (t_field_name
, name
))
7043 int bit_size
= TYPE_FIELD_BITSIZE (type
, i
);
7045 if (field_type_p
!= NULL
)
7046 *field_type_p
= type
->field (i
).type ();
7047 if (byte_offset_p
!= NULL
)
7048 *byte_offset_p
= fld_offset
;
7049 if (bit_offset_p
!= NULL
)
7050 *bit_offset_p
= bit_pos
% 8;
7051 if (bit_size_p
!= NULL
)
7052 *bit_size_p
= bit_size
;
7055 else if (ada_is_wrapper_field (type
, i
))
7057 if (find_struct_field (name
, type
->field (i
).type (), fld_offset
,
7058 field_type_p
, byte_offset_p
, bit_offset_p
,
7059 bit_size_p
, index_p
))
7062 else if (ada_is_variant_part (type
, i
))
7064 /* PNH: Wait. Do we ever execute this section, or is ARG always of
7067 struct type
*field_type
7068 = ada_check_typedef (type
->field (i
).type ());
7070 for (j
= 0; j
< field_type
->num_fields (); j
+= 1)
7072 if (find_struct_field (name
, field_type
->field (j
).type (),
7074 + field_type
->field (j
).loc_bitpos () / 8,
7075 field_type_p
, byte_offset_p
,
7076 bit_offset_p
, bit_size_p
, index_p
))
7080 else if (index_p
!= NULL
)
7084 /* Field not found so far. If this is a tagged type which
7085 has a parent, try finding that field in the parent now. */
7087 if (parent_offset
!= -1)
7089 /* As above, only compute the offset when truly needed. */
7090 int fld_offset
= offset
;
7091 if (byte_offset_p
!= nullptr || bit_offset_p
!= nullptr)
7093 int bit_pos
= type
->field (parent_offset
).loc_bitpos ();
7094 fld_offset
+= bit_pos
/ 8;
7097 if (find_struct_field (name
, type
->field (parent_offset
).type (),
7098 fld_offset
, field_type_p
, byte_offset_p
,
7099 bit_offset_p
, bit_size_p
, index_p
))
7106 /* Number of user-visible fields in record type TYPE. */
7109 num_visible_fields (struct type
*type
)
7114 find_struct_field (NULL
, type
, 0, NULL
, NULL
, NULL
, NULL
, &n
);
7118 /* Look for a field NAME in ARG. Adjust the address of ARG by OFFSET bytes,
7119 and search in it assuming it has (class) type TYPE.
7120 If found, return value, else return NULL.
7122 Searches recursively through wrapper fields (e.g., '_parent').
7124 In the case of homonyms in the tagged types, please refer to the
7125 long explanation in find_struct_field's function documentation. */
7127 static struct value
*
7128 ada_search_struct_field (const char *name
, struct value
*arg
, int offset
,
7132 int parent_offset
= -1;
7134 type
= ada_check_typedef (type
);
7135 for (i
= 0; i
< type
->num_fields (); i
+= 1)
7137 const char *t_field_name
= type
->field (i
).name ();
7139 if (t_field_name
== NULL
)
7142 else if (ada_is_parent_field (type
, i
))
7144 /* This is a field pointing us to the parent type of a tagged
7145 type. As hinted in this function's documentation, we give
7146 preference to fields in the current record first, so what
7147 we do here is just record the index of this field before
7148 we skip it. If it turns out we couldn't find our field
7149 in the current record, then we'll get back to it and search
7150 inside it whether the field might exist in the parent. */
7156 else if (field_name_match (t_field_name
, name
))
7157 return ada_value_primitive_field (arg
, offset
, i
, type
);
7159 else if (ada_is_wrapper_field (type
, i
))
7161 struct value
*v
= /* Do not let indent join lines here. */
7162 ada_search_struct_field (name
, arg
,
7163 offset
+ type
->field (i
).loc_bitpos () / 8,
7164 type
->field (i
).type ());
7170 else if (ada_is_variant_part (type
, i
))
7172 /* PNH: Do we ever get here? See find_struct_field. */
7174 struct type
*field_type
= ada_check_typedef (type
->field (i
).type ());
7175 int var_offset
= offset
+ type
->field (i
).loc_bitpos () / 8;
7177 for (j
= 0; j
< field_type
->num_fields (); j
+= 1)
7179 struct value
*v
= ada_search_struct_field
/* Force line
7182 var_offset
+ field_type
->field (j
).loc_bitpos () / 8,
7183 field_type
->field (j
).type ());
7191 /* Field not found so far. If this is a tagged type which
7192 has a parent, try finding that field in the parent now. */
7194 if (parent_offset
!= -1)
7196 struct value
*v
= ada_search_struct_field (
7197 name
, arg
, offset
+ type
->field (parent_offset
).loc_bitpos () / 8,
7198 type
->field (parent_offset
).type ());
7207 static struct value
*ada_index_struct_field_1 (int *, struct value
*,
7208 int, struct type
*);
7211 /* Return field #INDEX in ARG, where the index is that returned by
7212 * find_struct_field through its INDEX_P argument. Adjust the address
7213 * of ARG by OFFSET bytes, and search in it assuming it has (class) type TYPE.
7214 * If found, return value, else return NULL. */
7216 static struct value
*
7217 ada_index_struct_field (int index
, struct value
*arg
, int offset
,
7220 return ada_index_struct_field_1 (&index
, arg
, offset
, type
);
7224 /* Auxiliary function for ada_index_struct_field. Like
7225 * ada_index_struct_field, but takes index from *INDEX_P and modifies
7228 static struct value
*
7229 ada_index_struct_field_1 (int *index_p
, struct value
*arg
, int offset
,
7233 type
= ada_check_typedef (type
);
7235 for (i
= 0; i
< type
->num_fields (); i
+= 1)
7237 if (type
->field (i
).name () == NULL
)
7239 else if (ada_is_wrapper_field (type
, i
))
7241 struct value
*v
= /* Do not let indent join lines here. */
7242 ada_index_struct_field_1 (index_p
, arg
,
7243 offset
+ type
->field (i
).loc_bitpos () / 8,
7244 type
->field (i
).type ());
7250 else if (ada_is_variant_part (type
, i
))
7252 /* PNH: Do we ever get here? See ada_search_struct_field,
7253 find_struct_field. */
7254 error (_("Cannot assign this kind of variant record"));
7256 else if (*index_p
== 0)
7257 return ada_value_primitive_field (arg
, offset
, i
, type
);
7264 /* Return a string representation of type TYPE. */
7267 type_as_string (struct type
*type
)
7269 string_file tmp_stream
;
7271 type_print (type
, "", &tmp_stream
, -1);
7273 return tmp_stream
.release ();
7276 /* Given a type TYPE, look up the type of the component of type named NAME.
7277 If DISPP is non-null, add its byte displacement from the beginning of a
7278 structure (pointed to by a value) of type TYPE to *DISPP (does not
7279 work for packed fields).
7281 Matches any field whose name has NAME as a prefix, possibly
7284 TYPE can be either a struct or union. If REFOK, TYPE may also
7285 be a (pointer or reference)+ to a struct or union, and the
7286 ultimate target type will be searched.
7288 Looks recursively into variant clauses and parent types.
7290 In the case of homonyms in the tagged types, please refer to the
7291 long explanation in find_struct_field's function documentation.
7293 If NOERR is nonzero, return NULL if NAME is not suitably defined or
7294 TYPE is not a type of the right kind. */
7296 static struct type
*
7297 ada_lookup_struct_elt_type (struct type
*type
, const char *name
, int refok
,
7301 int parent_offset
= -1;
7306 if (refok
&& type
!= NULL
)
7309 type
= ada_check_typedef (type
);
7310 if (type
->code () != TYPE_CODE_PTR
&& type
->code () != TYPE_CODE_REF
)
7312 type
= TYPE_TARGET_TYPE (type
);
7316 || (type
->code () != TYPE_CODE_STRUCT
7317 && type
->code () != TYPE_CODE_UNION
))
7322 error (_("Type %s is not a structure or union type"),
7323 type
!= NULL
? type_as_string (type
).c_str () : _("(null)"));
7326 type
= to_static_fixed_type (type
);
7328 for (i
= 0; i
< type
->num_fields (); i
+= 1)
7330 const char *t_field_name
= type
->field (i
).name ();
7333 if (t_field_name
== NULL
)
7336 else if (ada_is_parent_field (type
, i
))
7338 /* This is a field pointing us to the parent type of a tagged
7339 type. As hinted in this function's documentation, we give
7340 preference to fields in the current record first, so what
7341 we do here is just record the index of this field before
7342 we skip it. If it turns out we couldn't find our field
7343 in the current record, then we'll get back to it and search
7344 inside it whether the field might exist in the parent. */
7350 else if (field_name_match (t_field_name
, name
))
7351 return type
->field (i
).type ();
7353 else if (ada_is_wrapper_field (type
, i
))
7355 t
= ada_lookup_struct_elt_type (type
->field (i
).type (), name
,
7361 else if (ada_is_variant_part (type
, i
))
7364 struct type
*field_type
= ada_check_typedef (type
->field (i
).type ());
7366 for (j
= field_type
->num_fields () - 1; j
>= 0; j
-= 1)
7368 /* FIXME pnh 2008/01/26: We check for a field that is
7369 NOT wrapped in a struct, since the compiler sometimes
7370 generates these for unchecked variant types. Revisit
7371 if the compiler changes this practice. */
7372 const char *v_field_name
= field_type
->field (j
).name ();
7374 if (v_field_name
!= NULL
7375 && field_name_match (v_field_name
, name
))
7376 t
= field_type
->field (j
).type ();
7378 t
= ada_lookup_struct_elt_type (field_type
->field (j
).type (),
7388 /* Field not found so far. If this is a tagged type which
7389 has a parent, try finding that field in the parent now. */
7391 if (parent_offset
!= -1)
7395 t
= ada_lookup_struct_elt_type (type
->field (parent_offset
).type (),
7404 const char *name_str
= name
!= NULL
? name
: _("<null>");
7406 error (_("Type %s has no component named %s"),
7407 type_as_string (type
).c_str (), name_str
);
7413 /* Assuming that VAR_TYPE is the type of a variant part of a record (a union),
7414 within a value of type OUTER_TYPE, return true iff VAR_TYPE
7415 represents an unchecked union (that is, the variant part of a
7416 record that is named in an Unchecked_Union pragma). */
7419 is_unchecked_variant (struct type
*var_type
, struct type
*outer_type
)
7421 const char *discrim_name
= ada_variant_discrim_name (var_type
);
7423 return (ada_lookup_struct_elt_type (outer_type
, discrim_name
, 0, 1) == NULL
);
7427 /* Assuming that VAR_TYPE is the type of a variant part of a record (a union),
7428 within OUTER, determine which variant clause (field number in VAR_TYPE,
7429 numbering from 0) is applicable. Returns -1 if none are. */
7432 ada_which_variant_applies (struct type
*var_type
, struct value
*outer
)
7436 const char *discrim_name
= ada_variant_discrim_name (var_type
);
7437 struct value
*discrim
;
7438 LONGEST discrim_val
;
7440 /* Using plain value_from_contents_and_address here causes problems
7441 because we will end up trying to resolve a type that is currently
7442 being constructed. */
7443 discrim
= ada_value_struct_elt (outer
, discrim_name
, 1);
7444 if (discrim
== NULL
)
7446 discrim_val
= value_as_long (discrim
);
7449 for (i
= 0; i
< var_type
->num_fields (); i
+= 1)
7451 if (ada_is_others_clause (var_type
, i
))
7453 else if (ada_in_variant (discrim_val
, var_type
, i
))
7457 return others_clause
;
7462 /* Dynamic-Sized Records */
7464 /* Strategy: The type ostensibly attached to a value with dynamic size
7465 (i.e., a size that is not statically recorded in the debugging
7466 data) does not accurately reflect the size or layout of the value.
7467 Our strategy is to convert these values to values with accurate,
7468 conventional types that are constructed on the fly. */
7470 /* There is a subtle and tricky problem here. In general, we cannot
7471 determine the size of dynamic records without its data. However,
7472 the 'struct value' data structure, which GDB uses to represent
7473 quantities in the inferior process (the target), requires the size
7474 of the type at the time of its allocation in order to reserve space
7475 for GDB's internal copy of the data. That's why the
7476 'to_fixed_xxx_type' routines take (target) addresses as parameters,
7477 rather than struct value*s.
7479 However, GDB's internal history variables ($1, $2, etc.) are
7480 struct value*s containing internal copies of the data that are not, in
7481 general, the same as the data at their corresponding addresses in
7482 the target. Fortunately, the types we give to these values are all
7483 conventional, fixed-size types (as per the strategy described
7484 above), so that we don't usually have to perform the
7485 'to_fixed_xxx_type' conversions to look at their values.
7486 Unfortunately, there is one exception: if one of the internal
7487 history variables is an array whose elements are unconstrained
7488 records, then we will need to create distinct fixed types for each
7489 element selected. */
7491 /* The upshot of all of this is that many routines take a (type, host
7492 address, target address) triple as arguments to represent a value.
7493 The host address, if non-null, is supposed to contain an internal
7494 copy of the relevant data; otherwise, the program is to consult the
7495 target at the target address. */
7497 /* Assuming that VAL0 represents a pointer value, the result of
7498 dereferencing it. Differs from value_ind in its treatment of
7499 dynamic-sized types. */
7502 ada_value_ind (struct value
*val0
)
7504 struct value
*val
= value_ind (val0
);
7506 if (ada_is_tagged_type (value_type (val
), 0))
7507 val
= ada_tag_value_at_base_address (val
);
7509 return ada_to_fixed_value (val
);
7512 /* The value resulting from dereferencing any "reference to"
7513 qualifiers on VAL0. */
7515 static struct value
*
7516 ada_coerce_ref (struct value
*val0
)
7518 if (value_type (val0
)->code () == TYPE_CODE_REF
)
7520 struct value
*val
= val0
;
7522 val
= coerce_ref (val
);
7524 if (ada_is_tagged_type (value_type (val
), 0))
7525 val
= ada_tag_value_at_base_address (val
);
7527 return ada_to_fixed_value (val
);
7533 /* Return the bit alignment required for field #F of template type TYPE. */
7536 field_alignment (struct type
*type
, int f
)
7538 const char *name
= type
->field (f
).name ();
7542 /* The field name should never be null, unless the debugging information
7543 is somehow malformed. In this case, we assume the field does not
7544 require any alignment. */
7548 len
= strlen (name
);
7550 if (!isdigit (name
[len
- 1]))
7553 if (isdigit (name
[len
- 2]))
7554 align_offset
= len
- 2;
7556 align_offset
= len
- 1;
7558 if (align_offset
< 7 || !startswith (name
+ align_offset
- 6, "___XV"))
7559 return TARGET_CHAR_BIT
;
7561 return atoi (name
+ align_offset
) * TARGET_CHAR_BIT
;
7564 /* Find a typedef or tag symbol named NAME. Ignores ambiguity. */
7566 static struct symbol
*
7567 ada_find_any_type_symbol (const char *name
)
7571 sym
= standard_lookup (name
, get_selected_block (NULL
), VAR_DOMAIN
);
7572 if (sym
!= NULL
&& sym
->aclass () == LOC_TYPEDEF
)
7575 sym
= standard_lookup (name
, NULL
, STRUCT_DOMAIN
);
7579 /* Find a type named NAME. Ignores ambiguity. This routine will look
7580 solely for types defined by debug info, it will not search the GDB
7583 static struct type
*
7584 ada_find_any_type (const char *name
)
7586 struct symbol
*sym
= ada_find_any_type_symbol (name
);
7589 return sym
->type ();
7594 /* Given NAME_SYM and an associated BLOCK, find a "renaming" symbol
7595 associated with NAME_SYM's name. NAME_SYM may itself be a renaming
7596 symbol, in which case it is returned. Otherwise, this looks for
7597 symbols whose name is that of NAME_SYM suffixed with "___XR".
7598 Return symbol if found, and NULL otherwise. */
7601 ada_is_renaming_symbol (struct symbol
*name_sym
)
7603 const char *name
= name_sym
->linkage_name ();
7604 return strstr (name
, "___XR") != NULL
;
7607 /* Because of GNAT encoding conventions, several GDB symbols may match a
7608 given type name. If the type denoted by TYPE0 is to be preferred to
7609 that of TYPE1 for purposes of type printing, return non-zero;
7610 otherwise return 0. */
7613 ada_prefer_type (struct type
*type0
, struct type
*type1
)
7617 else if (type0
== NULL
)
7619 else if (type1
->code () == TYPE_CODE_VOID
)
7621 else if (type0
->code () == TYPE_CODE_VOID
)
7623 else if (type1
->name () == NULL
&& type0
->name () != NULL
)
7625 else if (ada_is_constrained_packed_array_type (type0
))
7627 else if (ada_is_array_descriptor_type (type0
)
7628 && !ada_is_array_descriptor_type (type1
))
7632 const char *type0_name
= type0
->name ();
7633 const char *type1_name
= type1
->name ();
7635 if (type0_name
!= NULL
&& strstr (type0_name
, "___XR") != NULL
7636 && (type1_name
== NULL
|| strstr (type1_name
, "___XR") == NULL
))
7642 /* The name of TYPE, which is its TYPE_NAME. Null if TYPE is
7646 ada_type_name (struct type
*type
)
7650 return type
->name ();
7653 /* Search the list of "descriptive" types associated to TYPE for a type
7654 whose name is NAME. */
7656 static struct type
*
7657 find_parallel_type_by_descriptive_type (struct type
*type
, const char *name
)
7659 struct type
*result
, *tmp
;
7661 if (ada_ignore_descriptive_types_p
)
7664 /* If there no descriptive-type info, then there is no parallel type
7666 if (!HAVE_GNAT_AUX_INFO (type
))
7669 result
= TYPE_DESCRIPTIVE_TYPE (type
);
7670 while (result
!= NULL
)
7672 const char *result_name
= ada_type_name (result
);
7674 if (result_name
== NULL
)
7676 warning (_("unexpected null name on descriptive type"));
7680 /* If the names match, stop. */
7681 if (strcmp (result_name
, name
) == 0)
7684 /* Otherwise, look at the next item on the list, if any. */
7685 if (HAVE_GNAT_AUX_INFO (result
))
7686 tmp
= TYPE_DESCRIPTIVE_TYPE (result
);
7690 /* If not found either, try after having resolved the typedef. */
7695 result
= check_typedef (result
);
7696 if (HAVE_GNAT_AUX_INFO (result
))
7697 result
= TYPE_DESCRIPTIVE_TYPE (result
);
7703 /* If we didn't find a match, see whether this is a packed array. With
7704 older compilers, the descriptive type information is either absent or
7705 irrelevant when it comes to packed arrays so the above lookup fails.
7706 Fall back to using a parallel lookup by name in this case. */
7707 if (result
== NULL
&& ada_is_constrained_packed_array_type (type
))
7708 return ada_find_any_type (name
);
7713 /* Find a parallel type to TYPE with the specified NAME, using the
7714 descriptive type taken from the debugging information, if available,
7715 and otherwise using the (slower) name-based method. */
7717 static struct type
*
7718 ada_find_parallel_type_with_name (struct type
*type
, const char *name
)
7720 struct type
*result
= NULL
;
7722 if (HAVE_GNAT_AUX_INFO (type
))
7723 result
= find_parallel_type_by_descriptive_type (type
, name
);
7725 result
= ada_find_any_type (name
);
7730 /* Same as above, but specify the name of the parallel type by appending
7731 SUFFIX to the name of TYPE. */
7734 ada_find_parallel_type (struct type
*type
, const char *suffix
)
7737 const char *type_name
= ada_type_name (type
);
7740 if (type_name
== NULL
)
7743 len
= strlen (type_name
);
7745 name
= (char *) alloca (len
+ strlen (suffix
) + 1);
7747 strcpy (name
, type_name
);
7748 strcpy (name
+ len
, suffix
);
7750 return ada_find_parallel_type_with_name (type
, name
);
7753 /* If TYPE is a variable-size record type, return the corresponding template
7754 type describing its fields. Otherwise, return NULL. */
7756 static struct type
*
7757 dynamic_template_type (struct type
*type
)
7759 type
= ada_check_typedef (type
);
7761 if (type
== NULL
|| type
->code () != TYPE_CODE_STRUCT
7762 || ada_type_name (type
) == NULL
)
7766 int len
= strlen (ada_type_name (type
));
7768 if (len
> 6 && strcmp (ada_type_name (type
) + len
- 6, "___XVE") == 0)
7771 return ada_find_parallel_type (type
, "___XVE");
7775 /* Assuming that TEMPL_TYPE is a union or struct type, returns
7776 non-zero iff field FIELD_NUM of TEMPL_TYPE has dynamic size. */
7779 is_dynamic_field (struct type
*templ_type
, int field_num
)
7781 const char *name
= templ_type
->field (field_num
).name ();
7784 && templ_type
->field (field_num
).type ()->code () == TYPE_CODE_PTR
7785 && strstr (name
, "___XVL") != NULL
;
7788 /* The index of the variant field of TYPE, or -1 if TYPE does not
7789 represent a variant record type. */
7792 variant_field_index (struct type
*type
)
7796 if (type
== NULL
|| type
->code () != TYPE_CODE_STRUCT
)
7799 for (f
= 0; f
< type
->num_fields (); f
+= 1)
7801 if (ada_is_variant_part (type
, f
))
7807 /* A record type with no fields. */
7809 static struct type
*
7810 empty_record (struct type
*templ
)
7812 struct type
*type
= alloc_type_copy (templ
);
7814 type
->set_code (TYPE_CODE_STRUCT
);
7815 INIT_NONE_SPECIFIC (type
);
7816 type
->set_name ("<empty>");
7817 TYPE_LENGTH (type
) = 0;
7821 /* An ordinary record type (with fixed-length fields) that describes
7822 the value of type TYPE at VALADDR or ADDRESS (see comments at
7823 the beginning of this section) VAL according to GNAT conventions.
7824 DVAL0 should describe the (portion of a) record that contains any
7825 necessary discriminants. It should be NULL if value_type (VAL) is
7826 an outer-level type (i.e., as opposed to a branch of a variant.) A
7827 variant field (unless unchecked) is replaced by a particular branch
7830 If not KEEP_DYNAMIC_FIELDS, then all fields whose position or
7831 length are not statically known are discarded. As a consequence,
7832 VALADDR, ADDRESS and DVAL0 are ignored.
7834 NOTE: Limitations: For now, we assume that dynamic fields and
7835 variants occupy whole numbers of bytes. However, they need not be
7839 ada_template_to_fixed_record_type_1 (struct type
*type
,
7840 const gdb_byte
*valaddr
,
7841 CORE_ADDR address
, struct value
*dval0
,
7842 int keep_dynamic_fields
)
7844 struct value
*mark
= value_mark ();
7847 int nfields
, bit_len
;
7853 /* Compute the number of fields in this record type that are going
7854 to be processed: unless keep_dynamic_fields, this includes only
7855 fields whose position and length are static will be processed. */
7856 if (keep_dynamic_fields
)
7857 nfields
= type
->num_fields ();
7861 while (nfields
< type
->num_fields ()
7862 && !ada_is_variant_part (type
, nfields
)
7863 && !is_dynamic_field (type
, nfields
))
7867 rtype
= alloc_type_copy (type
);
7868 rtype
->set_code (TYPE_CODE_STRUCT
);
7869 INIT_NONE_SPECIFIC (rtype
);
7870 rtype
->set_num_fields (nfields
);
7872 ((struct field
*) TYPE_ZALLOC (rtype
, nfields
* sizeof (struct field
)));
7873 rtype
->set_name (ada_type_name (type
));
7874 rtype
->set_is_fixed_instance (true);
7880 for (f
= 0; f
< nfields
; f
+= 1)
7882 off
= align_up (off
, field_alignment (type
, f
))
7883 + type
->field (f
).loc_bitpos ();
7884 rtype
->field (f
).set_loc_bitpos (off
);
7885 TYPE_FIELD_BITSIZE (rtype
, f
) = 0;
7887 if (ada_is_variant_part (type
, f
))
7892 else if (is_dynamic_field (type
, f
))
7894 const gdb_byte
*field_valaddr
= valaddr
;
7895 CORE_ADDR field_address
= address
;
7896 struct type
*field_type
=
7897 TYPE_TARGET_TYPE (type
->field (f
).type ());
7901 /* Using plain value_from_contents_and_address here
7902 causes problems because we will end up trying to
7903 resolve a type that is currently being
7905 dval
= value_from_contents_and_address_unresolved (rtype
,
7908 rtype
= value_type (dval
);
7913 /* If the type referenced by this field is an aligner type, we need
7914 to unwrap that aligner type, because its size might not be set.
7915 Keeping the aligner type would cause us to compute the wrong
7916 size for this field, impacting the offset of the all the fields
7917 that follow this one. */
7918 if (ada_is_aligner_type (field_type
))
7920 long field_offset
= type
->field (f
).loc_bitpos ();
7922 field_valaddr
= cond_offset_host (field_valaddr
, field_offset
);
7923 field_address
= cond_offset_target (field_address
, field_offset
);
7924 field_type
= ada_aligned_type (field_type
);
7927 field_valaddr
= cond_offset_host (field_valaddr
,
7928 off
/ TARGET_CHAR_BIT
);
7929 field_address
= cond_offset_target (field_address
,
7930 off
/ TARGET_CHAR_BIT
);
7932 /* Get the fixed type of the field. Note that, in this case,
7933 we do not want to get the real type out of the tag: if
7934 the current field is the parent part of a tagged record,
7935 we will get the tag of the object. Clearly wrong: the real
7936 type of the parent is not the real type of the child. We
7937 would end up in an infinite loop. */
7938 field_type
= ada_get_base_type (field_type
);
7939 field_type
= ada_to_fixed_type (field_type
, field_valaddr
,
7940 field_address
, dval
, 0);
7942 rtype
->field (f
).set_type (field_type
);
7943 rtype
->field (f
).set_name (type
->field (f
).name ());
7944 /* The multiplication can potentially overflow. But because
7945 the field length has been size-checked just above, and
7946 assuming that the maximum size is a reasonable value,
7947 an overflow should not happen in practice. So rather than
7948 adding overflow recovery code to this already complex code,
7949 we just assume that it's not going to happen. */
7951 TYPE_LENGTH (rtype
->field (f
).type ()) * TARGET_CHAR_BIT
;
7955 /* Note: If this field's type is a typedef, it is important
7956 to preserve the typedef layer.
7958 Otherwise, we might be transforming a typedef to a fat
7959 pointer (encoding a pointer to an unconstrained array),
7960 into a basic fat pointer (encoding an unconstrained
7961 array). As both types are implemented using the same
7962 structure, the typedef is the only clue which allows us
7963 to distinguish between the two options. Stripping it
7964 would prevent us from printing this field appropriately. */
7965 rtype
->field (f
).set_type (type
->field (f
).type ());
7966 rtype
->field (f
).set_name (type
->field (f
).name ());
7967 if (TYPE_FIELD_BITSIZE (type
, f
) > 0)
7969 TYPE_FIELD_BITSIZE (rtype
, f
) = TYPE_FIELD_BITSIZE (type
, f
);
7972 struct type
*field_type
= type
->field (f
).type ();
7974 /* We need to be careful of typedefs when computing
7975 the length of our field. If this is a typedef,
7976 get the length of the target type, not the length
7978 if (field_type
->code () == TYPE_CODE_TYPEDEF
)
7979 field_type
= ada_typedef_target_type (field_type
);
7982 TYPE_LENGTH (ada_check_typedef (field_type
)) * TARGET_CHAR_BIT
;
7985 if (off
+ fld_bit_len
> bit_len
)
7986 bit_len
= off
+ fld_bit_len
;
7988 TYPE_LENGTH (rtype
) =
7989 align_up (bit_len
, TARGET_CHAR_BIT
) / TARGET_CHAR_BIT
;
7992 /* We handle the variant part, if any, at the end because of certain
7993 odd cases in which it is re-ordered so as NOT to be the last field of
7994 the record. This can happen in the presence of representation
7996 if (variant_field
>= 0)
7998 struct type
*branch_type
;
8000 off
= rtype
->field (variant_field
).loc_bitpos ();
8004 /* Using plain value_from_contents_and_address here causes
8005 problems because we will end up trying to resolve a type
8006 that is currently being constructed. */
8007 dval
= value_from_contents_and_address_unresolved (rtype
, valaddr
,
8009 rtype
= value_type (dval
);
8015 to_fixed_variant_branch_type
8016 (type
->field (variant_field
).type (),
8017 cond_offset_host (valaddr
, off
/ TARGET_CHAR_BIT
),
8018 cond_offset_target (address
, off
/ TARGET_CHAR_BIT
), dval
);
8019 if (branch_type
== NULL
)
8021 for (f
= variant_field
+ 1; f
< rtype
->num_fields (); f
+= 1)
8022 rtype
->field (f
- 1) = rtype
->field (f
);
8023 rtype
->set_num_fields (rtype
->num_fields () - 1);
8027 rtype
->field (variant_field
).set_type (branch_type
);
8028 rtype
->field (variant_field
).set_name ("S");
8030 TYPE_LENGTH (rtype
->field (variant_field
).type ()) *
8032 if (off
+ fld_bit_len
> bit_len
)
8033 bit_len
= off
+ fld_bit_len
;
8034 TYPE_LENGTH (rtype
) =
8035 align_up (bit_len
, TARGET_CHAR_BIT
) / TARGET_CHAR_BIT
;
8039 /* According to exp_dbug.ads, the size of TYPE for variable-size records
8040 should contain the alignment of that record, which should be a strictly
8041 positive value. If null or negative, then something is wrong, most
8042 probably in the debug info. In that case, we don't round up the size
8043 of the resulting type. If this record is not part of another structure,
8044 the current RTYPE length might be good enough for our purposes. */
8045 if (TYPE_LENGTH (type
) <= 0)
8048 warning (_("Invalid type size for `%s' detected: %s."),
8049 rtype
->name (), pulongest (TYPE_LENGTH (type
)));
8051 warning (_("Invalid type size for <unnamed> detected: %s."),
8052 pulongest (TYPE_LENGTH (type
)));
8056 TYPE_LENGTH (rtype
) = align_up (TYPE_LENGTH (rtype
),
8057 TYPE_LENGTH (type
));
8060 value_free_to_mark (mark
);
8064 /* As for ada_template_to_fixed_record_type_1 with KEEP_DYNAMIC_FIELDS
8067 static struct type
*
8068 template_to_fixed_record_type (struct type
*type
, const gdb_byte
*valaddr
,
8069 CORE_ADDR address
, struct value
*dval0
)
8071 return ada_template_to_fixed_record_type_1 (type
, valaddr
,
8075 /* An ordinary record type in which ___XVL-convention fields and
8076 ___XVU- and ___XVN-convention field types in TYPE0 are replaced with
8077 static approximations, containing all possible fields. Uses
8078 no runtime values. Useless for use in values, but that's OK,
8079 since the results are used only for type determinations. Works on both
8080 structs and unions. Representation note: to save space, we memorize
8081 the result of this function in the TYPE_TARGET_TYPE of the
8084 static struct type
*
8085 template_to_static_fixed_type (struct type
*type0
)
8091 /* No need no do anything if the input type is already fixed. */
8092 if (type0
->is_fixed_instance ())
8095 /* Likewise if we already have computed the static approximation. */
8096 if (TYPE_TARGET_TYPE (type0
) != NULL
)
8097 return TYPE_TARGET_TYPE (type0
);
8099 /* Don't clone TYPE0 until we are sure we are going to need a copy. */
8101 nfields
= type0
->num_fields ();
8103 /* Whether or not we cloned TYPE0, cache the result so that we don't do
8104 recompute all over next time. */
8105 TYPE_TARGET_TYPE (type0
) = type
;
8107 for (f
= 0; f
< nfields
; f
+= 1)
8109 struct type
*field_type
= type0
->field (f
).type ();
8110 struct type
*new_type
;
8112 if (is_dynamic_field (type0
, f
))
8114 field_type
= ada_check_typedef (field_type
);
8115 new_type
= to_static_fixed_type (TYPE_TARGET_TYPE (field_type
));
8118 new_type
= static_unwrap_type (field_type
);
8120 if (new_type
!= field_type
)
8122 /* Clone TYPE0 only the first time we get a new field type. */
8125 TYPE_TARGET_TYPE (type0
) = type
= alloc_type_copy (type0
);
8126 type
->set_code (type0
->code ());
8127 INIT_NONE_SPECIFIC (type
);
8128 type
->set_num_fields (nfields
);
8132 TYPE_ALLOC (type
, nfields
* sizeof (struct field
)));
8133 memcpy (fields
, type0
->fields (),
8134 sizeof (struct field
) * nfields
);
8135 type
->set_fields (fields
);
8137 type
->set_name (ada_type_name (type0
));
8138 type
->set_is_fixed_instance (true);
8139 TYPE_LENGTH (type
) = 0;
8141 type
->field (f
).set_type (new_type
);
8142 type
->field (f
).set_name (type0
->field (f
).name ());
8149 /* Given an object of type TYPE whose contents are at VALADDR and
8150 whose address in memory is ADDRESS, returns a revision of TYPE,
8151 which should be a non-dynamic-sized record, in which the variant
8152 part, if any, is replaced with the appropriate branch. Looks
8153 for discriminant values in DVAL0, which can be NULL if the record
8154 contains the necessary discriminant values. */
8156 static struct type
*
8157 to_record_with_fixed_variant_part (struct type
*type
, const gdb_byte
*valaddr
,
8158 CORE_ADDR address
, struct value
*dval0
)
8160 struct value
*mark
= value_mark ();
8163 struct type
*branch_type
;
8164 int nfields
= type
->num_fields ();
8165 int variant_field
= variant_field_index (type
);
8167 if (variant_field
== -1)
8172 dval
= value_from_contents_and_address (type
, valaddr
, address
);
8173 type
= value_type (dval
);
8178 rtype
= alloc_type_copy (type
);
8179 rtype
->set_code (TYPE_CODE_STRUCT
);
8180 INIT_NONE_SPECIFIC (rtype
);
8181 rtype
->set_num_fields (nfields
);
8184 (struct field
*) TYPE_ALLOC (rtype
, nfields
* sizeof (struct field
));
8185 memcpy (fields
, type
->fields (), sizeof (struct field
) * nfields
);
8186 rtype
->set_fields (fields
);
8188 rtype
->set_name (ada_type_name (type
));
8189 rtype
->set_is_fixed_instance (true);
8190 TYPE_LENGTH (rtype
) = TYPE_LENGTH (type
);
8192 branch_type
= to_fixed_variant_branch_type
8193 (type
->field (variant_field
).type (),
8194 cond_offset_host (valaddr
,
8195 type
->field (variant_field
).loc_bitpos ()
8197 cond_offset_target (address
,
8198 type
->field (variant_field
).loc_bitpos ()
8199 / TARGET_CHAR_BIT
), dval
);
8200 if (branch_type
== NULL
)
8204 for (f
= variant_field
+ 1; f
< nfields
; f
+= 1)
8205 rtype
->field (f
- 1) = rtype
->field (f
);
8206 rtype
->set_num_fields (rtype
->num_fields () - 1);
8210 rtype
->field (variant_field
).set_type (branch_type
);
8211 rtype
->field (variant_field
).set_name ("S");
8212 TYPE_FIELD_BITSIZE (rtype
, variant_field
) = 0;
8213 TYPE_LENGTH (rtype
) += TYPE_LENGTH (branch_type
);
8215 TYPE_LENGTH (rtype
) -= TYPE_LENGTH (type
->field (variant_field
).type ());
8217 value_free_to_mark (mark
);
8221 /* An ordinary record type (with fixed-length fields) that describes
8222 the value at (TYPE0, VALADDR, ADDRESS) [see explanation at
8223 beginning of this section]. Any necessary discriminants' values
8224 should be in DVAL, a record value; it may be NULL if the object
8225 at ADDR itself contains any necessary discriminant values.
8226 Additionally, VALADDR and ADDRESS may also be NULL if no discriminant
8227 values from the record are needed. Except in the case that DVAL,
8228 VALADDR, and ADDRESS are all 0 or NULL, a variant field (unless
8229 unchecked) is replaced by a particular branch of the variant.
8231 NOTE: the case in which DVAL and VALADDR are NULL and ADDRESS is 0
8232 is questionable and may be removed. It can arise during the
8233 processing of an unconstrained-array-of-record type where all the
8234 variant branches have exactly the same size. This is because in
8235 such cases, the compiler does not bother to use the XVS convention
8236 when encoding the record. I am currently dubious of this
8237 shortcut and suspect the compiler should be altered. FIXME. */
8239 static struct type
*
8240 to_fixed_record_type (struct type
*type0
, const gdb_byte
*valaddr
,
8241 CORE_ADDR address
, struct value
*dval
)
8243 struct type
*templ_type
;
8245 if (type0
->is_fixed_instance ())
8248 templ_type
= dynamic_template_type (type0
);
8250 if (templ_type
!= NULL
)
8251 return template_to_fixed_record_type (templ_type
, valaddr
, address
, dval
);
8252 else if (variant_field_index (type0
) >= 0)
8254 if (dval
== NULL
&& valaddr
== NULL
&& address
== 0)
8256 return to_record_with_fixed_variant_part (type0
, valaddr
, address
,
8261 type0
->set_is_fixed_instance (true);
8267 /* An ordinary record type (with fixed-length fields) that describes
8268 the value at (VAR_TYPE0, VALADDR, ADDRESS), where VAR_TYPE0 is a
8269 union type. Any necessary discriminants' values should be in DVAL,
8270 a record value. That is, this routine selects the appropriate
8271 branch of the union at ADDR according to the discriminant value
8272 indicated in the union's type name. Returns VAR_TYPE0 itself if
8273 it represents a variant subject to a pragma Unchecked_Union. */
8275 static struct type
*
8276 to_fixed_variant_branch_type (struct type
*var_type0
, const gdb_byte
*valaddr
,
8277 CORE_ADDR address
, struct value
*dval
)
8280 struct type
*templ_type
;
8281 struct type
*var_type
;
8283 if (var_type0
->code () == TYPE_CODE_PTR
)
8284 var_type
= TYPE_TARGET_TYPE (var_type0
);
8286 var_type
= var_type0
;
8288 templ_type
= ada_find_parallel_type (var_type
, "___XVU");
8290 if (templ_type
!= NULL
)
8291 var_type
= templ_type
;
8293 if (is_unchecked_variant (var_type
, value_type (dval
)))
8295 which
= ada_which_variant_applies (var_type
, dval
);
8298 return empty_record (var_type
);
8299 else if (is_dynamic_field (var_type
, which
))
8300 return to_fixed_record_type
8301 (TYPE_TARGET_TYPE (var_type
->field (which
).type ()),
8302 valaddr
, address
, dval
);
8303 else if (variant_field_index (var_type
->field (which
).type ()) >= 0)
8305 to_fixed_record_type
8306 (var_type
->field (which
).type (), valaddr
, address
, dval
);
8308 return var_type
->field (which
).type ();
8311 /* Assuming RANGE_TYPE is a TYPE_CODE_RANGE, return nonzero if
8312 ENCODING_TYPE, a type following the GNAT conventions for discrete
8313 type encodings, only carries redundant information. */
8316 ada_is_redundant_range_encoding (struct type
*range_type
,
8317 struct type
*encoding_type
)
8319 const char *bounds_str
;
8323 gdb_assert (range_type
->code () == TYPE_CODE_RANGE
);
8325 if (get_base_type (range_type
)->code ()
8326 != get_base_type (encoding_type
)->code ())
8328 /* The compiler probably used a simple base type to describe
8329 the range type instead of the range's actual base type,
8330 expecting us to get the real base type from the encoding
8331 anyway. In this situation, the encoding cannot be ignored
8336 if (is_dynamic_type (range_type
))
8339 if (encoding_type
->name () == NULL
)
8342 bounds_str
= strstr (encoding_type
->name (), "___XDLU_");
8343 if (bounds_str
== NULL
)
8346 n
= 8; /* Skip "___XDLU_". */
8347 if (!ada_scan_number (bounds_str
, n
, &lo
, &n
))
8349 if (range_type
->bounds ()->low
.const_val () != lo
)
8352 n
+= 2; /* Skip the "__" separator between the two bounds. */
8353 if (!ada_scan_number (bounds_str
, n
, &hi
, &n
))
8355 if (range_type
->bounds ()->high
.const_val () != hi
)
8361 /* Given the array type ARRAY_TYPE, return nonzero if DESC_TYPE,
8362 a type following the GNAT encoding for describing array type
8363 indices, only carries redundant information. */
8366 ada_is_redundant_index_type_desc (struct type
*array_type
,
8367 struct type
*desc_type
)
8369 struct type
*this_layer
= check_typedef (array_type
);
8372 for (i
= 0; i
< desc_type
->num_fields (); i
++)
8374 if (!ada_is_redundant_range_encoding (this_layer
->index_type (),
8375 desc_type
->field (i
).type ()))
8377 this_layer
= check_typedef (TYPE_TARGET_TYPE (this_layer
));
8383 /* Assuming that TYPE0 is an array type describing the type of a value
8384 at ADDR, and that DVAL describes a record containing any
8385 discriminants used in TYPE0, returns a type for the value that
8386 contains no dynamic components (that is, no components whose sizes
8387 are determined by run-time quantities). Unless IGNORE_TOO_BIG is
8388 true, gives an error message if the resulting type's size is over
8391 static struct type
*
8392 to_fixed_array_type (struct type
*type0
, struct value
*dval
,
8395 struct type
*index_type_desc
;
8396 struct type
*result
;
8397 int constrained_packed_array_p
;
8398 static const char *xa_suffix
= "___XA";
8400 type0
= ada_check_typedef (type0
);
8401 if (type0
->is_fixed_instance ())
8404 constrained_packed_array_p
= ada_is_constrained_packed_array_type (type0
);
8405 if (constrained_packed_array_p
)
8407 type0
= decode_constrained_packed_array_type (type0
);
8408 if (type0
== nullptr)
8409 error (_("could not decode constrained packed array type"));
8412 index_type_desc
= ada_find_parallel_type (type0
, xa_suffix
);
8414 /* As mentioned in exp_dbug.ads, for non bit-packed arrays an
8415 encoding suffixed with 'P' may still be generated. If so,
8416 it should be used to find the XA type. */
8418 if (index_type_desc
== NULL
)
8420 const char *type_name
= ada_type_name (type0
);
8422 if (type_name
!= NULL
)
8424 const int len
= strlen (type_name
);
8425 char *name
= (char *) alloca (len
+ strlen (xa_suffix
));
8427 if (type_name
[len
- 1] == 'P')
8429 strcpy (name
, type_name
);
8430 strcpy (name
+ len
- 1, xa_suffix
);
8431 index_type_desc
= ada_find_parallel_type_with_name (type0
, name
);
8436 ada_fixup_array_indexes_type (index_type_desc
);
8437 if (index_type_desc
!= NULL
8438 && ada_is_redundant_index_type_desc (type0
, index_type_desc
))
8440 /* Ignore this ___XA parallel type, as it does not bring any
8441 useful information. This allows us to avoid creating fixed
8442 versions of the array's index types, which would be identical
8443 to the original ones. This, in turn, can also help avoid
8444 the creation of fixed versions of the array itself. */
8445 index_type_desc
= NULL
;
8448 if (index_type_desc
== NULL
)
8450 struct type
*elt_type0
= ada_check_typedef (TYPE_TARGET_TYPE (type0
));
8452 /* NOTE: elt_type---the fixed version of elt_type0---should never
8453 depend on the contents of the array in properly constructed
8455 /* Create a fixed version of the array element type.
8456 We're not providing the address of an element here,
8457 and thus the actual object value cannot be inspected to do
8458 the conversion. This should not be a problem, since arrays of
8459 unconstrained objects are not allowed. In particular, all
8460 the elements of an array of a tagged type should all be of
8461 the same type specified in the debugging info. No need to
8462 consult the object tag. */
8463 struct type
*elt_type
= ada_to_fixed_type (elt_type0
, 0, 0, dval
, 1);
8465 /* Make sure we always create a new array type when dealing with
8466 packed array types, since we're going to fix-up the array
8467 type length and element bitsize a little further down. */
8468 if (elt_type0
== elt_type
&& !constrained_packed_array_p
)
8471 result
= create_array_type (alloc_type_copy (type0
),
8472 elt_type
, type0
->index_type ());
8477 struct type
*elt_type0
;
8480 for (i
= index_type_desc
->num_fields (); i
> 0; i
-= 1)
8481 elt_type0
= TYPE_TARGET_TYPE (elt_type0
);
8483 /* NOTE: result---the fixed version of elt_type0---should never
8484 depend on the contents of the array in properly constructed
8486 /* Create a fixed version of the array element type.
8487 We're not providing the address of an element here,
8488 and thus the actual object value cannot be inspected to do
8489 the conversion. This should not be a problem, since arrays of
8490 unconstrained objects are not allowed. In particular, all
8491 the elements of an array of a tagged type should all be of
8492 the same type specified in the debugging info. No need to
8493 consult the object tag. */
8495 ada_to_fixed_type (ada_check_typedef (elt_type0
), 0, 0, dval
, 1);
8498 for (i
= index_type_desc
->num_fields () - 1; i
>= 0; i
-= 1)
8500 struct type
*range_type
=
8501 to_fixed_range_type (index_type_desc
->field (i
).type (), dval
);
8503 result
= create_array_type (alloc_type_copy (elt_type0
),
8504 result
, range_type
);
8505 elt_type0
= TYPE_TARGET_TYPE (elt_type0
);
8509 /* We want to preserve the type name. This can be useful when
8510 trying to get the type name of a value that has already been
8511 printed (for instance, if the user did "print VAR; whatis $". */
8512 result
->set_name (type0
->name ());
8514 if (constrained_packed_array_p
)
8516 /* So far, the resulting type has been created as if the original
8517 type was a regular (non-packed) array type. As a result, the
8518 bitsize of the array elements needs to be set again, and the array
8519 length needs to be recomputed based on that bitsize. */
8520 int len
= TYPE_LENGTH (result
) / TYPE_LENGTH (TYPE_TARGET_TYPE (result
));
8521 int elt_bitsize
= TYPE_FIELD_BITSIZE (type0
, 0);
8523 TYPE_FIELD_BITSIZE (result
, 0) = TYPE_FIELD_BITSIZE (type0
, 0);
8524 TYPE_LENGTH (result
) = len
* elt_bitsize
/ HOST_CHAR_BIT
;
8525 if (TYPE_LENGTH (result
) * HOST_CHAR_BIT
< len
* elt_bitsize
)
8526 TYPE_LENGTH (result
)++;
8529 result
->set_is_fixed_instance (true);
8534 /* A standard type (containing no dynamically sized components)
8535 corresponding to TYPE for the value (TYPE, VALADDR, ADDRESS)
8536 DVAL describes a record containing any discriminants used in TYPE0,
8537 and may be NULL if there are none, or if the object of type TYPE at
8538 ADDRESS or in VALADDR contains these discriminants.
8540 If CHECK_TAG is not null, in the case of tagged types, this function
8541 attempts to locate the object's tag and use it to compute the actual
8542 type. However, when ADDRESS is null, we cannot use it to determine the
8543 location of the tag, and therefore compute the tagged type's actual type.
8544 So we return the tagged type without consulting the tag. */
8546 static struct type
*
8547 ada_to_fixed_type_1 (struct type
*type
, const gdb_byte
*valaddr
,
8548 CORE_ADDR address
, struct value
*dval
, int check_tag
)
8550 type
= ada_check_typedef (type
);
8552 /* Only un-fixed types need to be handled here. */
8553 if (!HAVE_GNAT_AUX_INFO (type
))
8556 switch (type
->code ())
8560 case TYPE_CODE_STRUCT
:
8562 struct type
*static_type
= to_static_fixed_type (type
);
8563 struct type
*fixed_record_type
=
8564 to_fixed_record_type (type
, valaddr
, address
, NULL
);
8566 /* If STATIC_TYPE is a tagged type and we know the object's address,
8567 then we can determine its tag, and compute the object's actual
8568 type from there. Note that we have to use the fixed record
8569 type (the parent part of the record may have dynamic fields
8570 and the way the location of _tag is expressed may depend on
8573 if (check_tag
&& address
!= 0 && ada_is_tagged_type (static_type
, 0))
8576 value_tag_from_contents_and_address
8580 struct type
*real_type
= type_from_tag (tag
);
8582 value_from_contents_and_address (fixed_record_type
,
8585 fixed_record_type
= value_type (obj
);
8586 if (real_type
!= NULL
)
8587 return to_fixed_record_type
8589 value_address (ada_tag_value_at_base_address (obj
)), NULL
);
8592 /* Check to see if there is a parallel ___XVZ variable.
8593 If there is, then it provides the actual size of our type. */
8594 else if (ada_type_name (fixed_record_type
) != NULL
)
8596 const char *name
= ada_type_name (fixed_record_type
);
8598 = (char *) alloca (strlen (name
) + 7 /* "___XVZ\0" */);
8599 bool xvz_found
= false;
8602 xsnprintf (xvz_name
, strlen (name
) + 7, "%s___XVZ", name
);
8605 xvz_found
= get_int_var_value (xvz_name
, size
);
8607 catch (const gdb_exception_error
&except
)
8609 /* We found the variable, but somehow failed to read
8610 its value. Rethrow the same error, but with a little
8611 bit more information, to help the user understand
8612 what went wrong (Eg: the variable might have been
8614 throw_error (except
.error
,
8615 _("unable to read value of %s (%s)"),
8616 xvz_name
, except
.what ());
8619 if (xvz_found
&& TYPE_LENGTH (fixed_record_type
) != size
)
8621 fixed_record_type
= copy_type (fixed_record_type
);
8622 TYPE_LENGTH (fixed_record_type
) = size
;
8624 /* The FIXED_RECORD_TYPE may have be a stub. We have
8625 observed this when the debugging info is STABS, and
8626 apparently it is something that is hard to fix.
8628 In practice, we don't need the actual type definition
8629 at all, because the presence of the XVZ variable allows us
8630 to assume that there must be a XVS type as well, which we
8631 should be able to use later, when we need the actual type
8634 In the meantime, pretend that the "fixed" type we are
8635 returning is NOT a stub, because this can cause trouble
8636 when using this type to create new types targeting it.
8637 Indeed, the associated creation routines often check
8638 whether the target type is a stub and will try to replace
8639 it, thus using a type with the wrong size. This, in turn,
8640 might cause the new type to have the wrong size too.
8641 Consider the case of an array, for instance, where the size
8642 of the array is computed from the number of elements in
8643 our array multiplied by the size of its element. */
8644 fixed_record_type
->set_is_stub (false);
8647 return fixed_record_type
;
8649 case TYPE_CODE_ARRAY
:
8650 return to_fixed_array_type (type
, dval
, 1);
8651 case TYPE_CODE_UNION
:
8655 return to_fixed_variant_branch_type (type
, valaddr
, address
, dval
);
8659 /* The same as ada_to_fixed_type_1, except that it preserves the type
8660 if it is a TYPE_CODE_TYPEDEF of a type that is already fixed.
8662 The typedef layer needs be preserved in order to differentiate between
8663 arrays and array pointers when both types are implemented using the same
8664 fat pointer. In the array pointer case, the pointer is encoded as
8665 a typedef of the pointer type. For instance, considering:
8667 type String_Access is access String;
8668 S1 : String_Access := null;
8670 To the debugger, S1 is defined as a typedef of type String. But
8671 to the user, it is a pointer. So if the user tries to print S1,
8672 we should not dereference the array, but print the array address
8675 If we didn't preserve the typedef layer, we would lose the fact that
8676 the type is to be presented as a pointer (needs de-reference before
8677 being printed). And we would also use the source-level type name. */
8680 ada_to_fixed_type (struct type
*type
, const gdb_byte
*valaddr
,
8681 CORE_ADDR address
, struct value
*dval
, int check_tag
)
8684 struct type
*fixed_type
=
8685 ada_to_fixed_type_1 (type
, valaddr
, address
, dval
, check_tag
);
8687 /* If TYPE is a typedef and its target type is the same as the FIXED_TYPE,
8688 then preserve the typedef layer.
8690 Implementation note: We can only check the main-type portion of
8691 the TYPE and FIXED_TYPE, because eliminating the typedef layer
8692 from TYPE now returns a type that has the same instance flags
8693 as TYPE. For instance, if TYPE is a "typedef const", and its
8694 target type is a "struct", then the typedef elimination will return
8695 a "const" version of the target type. See check_typedef for more
8696 details about how the typedef layer elimination is done.
8698 brobecker/2010-11-19: It seems to me that the only case where it is
8699 useful to preserve the typedef layer is when dealing with fat pointers.
8700 Perhaps, we could add a check for that and preserve the typedef layer
8701 only in that situation. But this seems unnecessary so far, probably
8702 because we call check_typedef/ada_check_typedef pretty much everywhere.
8704 if (type
->code () == TYPE_CODE_TYPEDEF
8705 && (TYPE_MAIN_TYPE (ada_typedef_target_type (type
))
8706 == TYPE_MAIN_TYPE (fixed_type
)))
8712 /* A standard (static-sized) type corresponding as well as possible to
8713 TYPE0, but based on no runtime data. */
8715 static struct type
*
8716 to_static_fixed_type (struct type
*type0
)
8723 if (type0
->is_fixed_instance ())
8726 type0
= ada_check_typedef (type0
);
8728 switch (type0
->code ())
8732 case TYPE_CODE_STRUCT
:
8733 type
= dynamic_template_type (type0
);
8735 return template_to_static_fixed_type (type
);
8737 return template_to_static_fixed_type (type0
);
8738 case TYPE_CODE_UNION
:
8739 type
= ada_find_parallel_type (type0
, "___XVU");
8741 return template_to_static_fixed_type (type
);
8743 return template_to_static_fixed_type (type0
);
8747 /* A static approximation of TYPE with all type wrappers removed. */
8749 static struct type
*
8750 static_unwrap_type (struct type
*type
)
8752 if (ada_is_aligner_type (type
))
8754 struct type
*type1
= ada_check_typedef (type
)->field (0).type ();
8755 if (ada_type_name (type1
) == NULL
)
8756 type1
->set_name (ada_type_name (type
));
8758 return static_unwrap_type (type1
);
8762 struct type
*raw_real_type
= ada_get_base_type (type
);
8764 if (raw_real_type
== type
)
8767 return to_static_fixed_type (raw_real_type
);
8771 /* In some cases, incomplete and private types require
8772 cross-references that are not resolved as records (for example,
8774 type FooP is access Foo;
8776 type Foo is array ...;
8777 ). In these cases, since there is no mechanism for producing
8778 cross-references to such types, we instead substitute for FooP a
8779 stub enumeration type that is nowhere resolved, and whose tag is
8780 the name of the actual type. Call these types "non-record stubs". */
8782 /* A type equivalent to TYPE that is not a non-record stub, if one
8783 exists, otherwise TYPE. */
8786 ada_check_typedef (struct type
*type
)
8791 /* If our type is an access to an unconstrained array, which is encoded
8792 as a TYPE_CODE_TYPEDEF of a fat pointer, then we're done.
8793 We don't want to strip the TYPE_CODE_TYPDEF layer, because this is
8794 what allows us to distinguish between fat pointers that represent
8795 array types, and fat pointers that represent array access types
8796 (in both cases, the compiler implements them as fat pointers). */
8797 if (ada_is_access_to_unconstrained_array (type
))
8800 type
= check_typedef (type
);
8801 if (type
== NULL
|| type
->code () != TYPE_CODE_ENUM
8802 || !type
->is_stub ()
8803 || type
->name () == NULL
)
8807 const char *name
= type
->name ();
8808 struct type
*type1
= ada_find_any_type (name
);
8813 /* TYPE1 might itself be a TYPE_CODE_TYPEDEF (this can happen with
8814 stubs pointing to arrays, as we don't create symbols for array
8815 types, only for the typedef-to-array types). If that's the case,
8816 strip the typedef layer. */
8817 if (type1
->code () == TYPE_CODE_TYPEDEF
)
8818 type1
= ada_check_typedef (type1
);
8824 /* A value representing the data at VALADDR/ADDRESS as described by
8825 type TYPE0, but with a standard (static-sized) type that correctly
8826 describes it. If VAL0 is not NULL and TYPE0 already is a standard
8827 type, then return VAL0 [this feature is simply to avoid redundant
8828 creation of struct values]. */
8830 static struct value
*
8831 ada_to_fixed_value_create (struct type
*type0
, CORE_ADDR address
,
8834 struct type
*type
= ada_to_fixed_type (type0
, 0, address
, NULL
, 1);
8836 if (type
== type0
&& val0
!= NULL
)
8839 if (VALUE_LVAL (val0
) != lval_memory
)
8841 /* Our value does not live in memory; it could be a convenience
8842 variable, for instance. Create a not_lval value using val0's
8844 return value_from_contents (type
, value_contents (val0
).data ());
8847 return value_from_contents_and_address (type
, 0, address
);
8850 /* A value representing VAL, but with a standard (static-sized) type
8851 that correctly describes it. Does not necessarily create a new
8855 ada_to_fixed_value (struct value
*val
)
8857 val
= unwrap_value (val
);
8858 val
= ada_to_fixed_value_create (value_type (val
), value_address (val
), val
);
8865 /* Table mapping attribute numbers to names.
8866 NOTE: Keep up to date with enum ada_attribute definition in ada-lang.h. */
8868 static const char * const attribute_names
[] = {
8886 ada_attribute_name (enum exp_opcode n
)
8888 if (n
>= OP_ATR_FIRST
&& n
<= (int) OP_ATR_VAL
)
8889 return attribute_names
[n
- OP_ATR_FIRST
+ 1];
8891 return attribute_names
[0];
8894 /* Evaluate the 'POS attribute applied to ARG. */
8897 pos_atr (struct value
*arg
)
8899 struct value
*val
= coerce_ref (arg
);
8900 struct type
*type
= value_type (val
);
8902 if (!discrete_type_p (type
))
8903 error (_("'POS only defined on discrete types"));
8905 gdb::optional
<LONGEST
> result
= discrete_position (type
, value_as_long (val
));
8906 if (!result
.has_value ())
8907 error (_("enumeration value is invalid: can't find 'POS"));
8913 ada_pos_atr (struct type
*expect_type
,
8914 struct expression
*exp
,
8915 enum noside noside
, enum exp_opcode op
,
8918 struct type
*type
= builtin_type (exp
->gdbarch
)->builtin_int
;
8919 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
8920 return value_zero (type
, not_lval
);
8921 return value_from_longest (type
, pos_atr (arg
));
8924 /* Evaluate the TYPE'VAL attribute applied to ARG. */
8926 static struct value
*
8927 val_atr (struct type
*type
, LONGEST val
)
8929 gdb_assert (discrete_type_p (type
));
8930 if (type
->code () == TYPE_CODE_RANGE
)
8931 type
= TYPE_TARGET_TYPE (type
);
8932 if (type
->code () == TYPE_CODE_ENUM
)
8934 if (val
< 0 || val
>= type
->num_fields ())
8935 error (_("argument to 'VAL out of range"));
8936 val
= type
->field (val
).loc_enumval ();
8938 return value_from_longest (type
, val
);
8942 ada_val_atr (enum noside noside
, struct type
*type
, struct value
*arg
)
8944 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
8945 return value_zero (type
, not_lval
);
8947 if (!discrete_type_p (type
))
8948 error (_("'VAL only defined on discrete types"));
8949 if (!integer_type_p (value_type (arg
)))
8950 error (_("'VAL requires integral argument"));
8952 return val_atr (type
, value_as_long (arg
));
8958 /* True if TYPE appears to be an Ada character type.
8959 [At the moment, this is true only for Character and Wide_Character;
8960 It is a heuristic test that could stand improvement]. */
8963 ada_is_character_type (struct type
*type
)
8967 /* If the type code says it's a character, then assume it really is,
8968 and don't check any further. */
8969 if (type
->code () == TYPE_CODE_CHAR
)
8972 /* Otherwise, assume it's a character type iff it is a discrete type
8973 with a known character type name. */
8974 name
= ada_type_name (type
);
8975 return (name
!= NULL
8976 && (type
->code () == TYPE_CODE_INT
8977 || type
->code () == TYPE_CODE_RANGE
)
8978 && (strcmp (name
, "character") == 0
8979 || strcmp (name
, "wide_character") == 0
8980 || strcmp (name
, "wide_wide_character") == 0
8981 || strcmp (name
, "unsigned char") == 0));
8984 /* True if TYPE appears to be an Ada string type. */
8987 ada_is_string_type (struct type
*type
)
8989 type
= ada_check_typedef (type
);
8991 && type
->code () != TYPE_CODE_PTR
8992 && (ada_is_simple_array_type (type
)
8993 || ada_is_array_descriptor_type (type
))
8994 && ada_array_arity (type
) == 1)
8996 struct type
*elttype
= ada_array_element_type (type
, 1);
8998 return ada_is_character_type (elttype
);
9004 /* The compiler sometimes provides a parallel XVS type for a given
9005 PAD type. Normally, it is safe to follow the PAD type directly,
9006 but older versions of the compiler have a bug that causes the offset
9007 of its "F" field to be wrong. Following that field in that case
9008 would lead to incorrect results, but this can be worked around
9009 by ignoring the PAD type and using the associated XVS type instead.
9011 Set to True if the debugger should trust the contents of PAD types.
9012 Otherwise, ignore the PAD type if there is a parallel XVS type. */
9013 static bool trust_pad_over_xvs
= true;
9015 /* True if TYPE is a struct type introduced by the compiler to force the
9016 alignment of a value. Such types have a single field with a
9017 distinctive name. */
9020 ada_is_aligner_type (struct type
*type
)
9022 type
= ada_check_typedef (type
);
9024 if (!trust_pad_over_xvs
&& ada_find_parallel_type (type
, "___XVS") != NULL
)
9027 return (type
->code () == TYPE_CODE_STRUCT
9028 && type
->num_fields () == 1
9029 && strcmp (type
->field (0).name (), "F") == 0);
9032 /* If there is an ___XVS-convention type parallel to SUBTYPE, return
9033 the parallel type. */
9036 ada_get_base_type (struct type
*raw_type
)
9038 struct type
*real_type_namer
;
9039 struct type
*raw_real_type
;
9041 if (raw_type
== NULL
|| raw_type
->code () != TYPE_CODE_STRUCT
)
9044 if (ada_is_aligner_type (raw_type
))
9045 /* The encoding specifies that we should always use the aligner type.
9046 So, even if this aligner type has an associated XVS type, we should
9049 According to the compiler gurus, an XVS type parallel to an aligner
9050 type may exist because of a stabs limitation. In stabs, aligner
9051 types are empty because the field has a variable-sized type, and
9052 thus cannot actually be used as an aligner type. As a result,
9053 we need the associated parallel XVS type to decode the type.
9054 Since the policy in the compiler is to not change the internal
9055 representation based on the debugging info format, we sometimes
9056 end up having a redundant XVS type parallel to the aligner type. */
9059 real_type_namer
= ada_find_parallel_type (raw_type
, "___XVS");
9060 if (real_type_namer
== NULL
9061 || real_type_namer
->code () != TYPE_CODE_STRUCT
9062 || real_type_namer
->num_fields () != 1)
9065 if (real_type_namer
->field (0).type ()->code () != TYPE_CODE_REF
)
9067 /* This is an older encoding form where the base type needs to be
9068 looked up by name. We prefer the newer encoding because it is
9070 raw_real_type
= ada_find_any_type (real_type_namer
->field (0).name ());
9071 if (raw_real_type
== NULL
)
9074 return raw_real_type
;
9077 /* The field in our XVS type is a reference to the base type. */
9078 return TYPE_TARGET_TYPE (real_type_namer
->field (0).type ());
9081 /* The type of value designated by TYPE, with all aligners removed. */
9084 ada_aligned_type (struct type
*type
)
9086 if (ada_is_aligner_type (type
))
9087 return ada_aligned_type (type
->field (0).type ());
9089 return ada_get_base_type (type
);
9093 /* The address of the aligned value in an object at address VALADDR
9094 having type TYPE. Assumes ada_is_aligner_type (TYPE). */
9097 ada_aligned_value_addr (struct type
*type
, const gdb_byte
*valaddr
)
9099 if (ada_is_aligner_type (type
))
9100 return ada_aligned_value_addr
9101 (type
->field (0).type (),
9102 valaddr
+ type
->field (0).loc_bitpos () / TARGET_CHAR_BIT
);
9109 /* The printed representation of an enumeration literal with encoded
9110 name NAME. The value is good to the next call of ada_enum_name. */
9112 ada_enum_name (const char *name
)
9114 static std::string storage
;
9117 /* First, unqualify the enumeration name:
9118 1. Search for the last '.' character. If we find one, then skip
9119 all the preceding characters, the unqualified name starts
9120 right after that dot.
9121 2. Otherwise, we may be debugging on a target where the compiler
9122 translates dots into "__". Search forward for double underscores,
9123 but stop searching when we hit an overloading suffix, which is
9124 of the form "__" followed by digits. */
9126 tmp
= strrchr (name
, '.');
9131 while ((tmp
= strstr (name
, "__")) != NULL
)
9133 if (isdigit (tmp
[2]))
9144 if (name
[1] == 'U' || name
[1] == 'W')
9147 if (name
[1] == 'W' && name
[2] == 'W')
9149 /* Also handle the QWW case. */
9152 if (sscanf (name
+ offset
, "%x", &v
) != 1)
9155 else if (((name
[1] >= '0' && name
[1] <= '9')
9156 || (name
[1] >= 'a' && name
[1] <= 'z'))
9159 storage
= string_printf ("'%c'", name
[1]);
9160 return storage
.c_str ();
9165 if (isascii (v
) && isprint (v
))
9166 storage
= string_printf ("'%c'", v
);
9167 else if (name
[1] == 'U')
9168 storage
= string_printf ("'[\"%02x\"]'", v
);
9169 else if (name
[2] != 'W')
9170 storage
= string_printf ("'[\"%04x\"]'", v
);
9172 storage
= string_printf ("'[\"%06x\"]'", v
);
9174 return storage
.c_str ();
9178 tmp
= strstr (name
, "__");
9180 tmp
= strstr (name
, "$");
9183 storage
= std::string (name
, tmp
- name
);
9184 return storage
.c_str ();
9191 /* If VAL is wrapped in an aligner or subtype wrapper, return the
9194 static struct value
*
9195 unwrap_value (struct value
*val
)
9197 struct type
*type
= ada_check_typedef (value_type (val
));
9199 if (ada_is_aligner_type (type
))
9201 struct value
*v
= ada_value_struct_elt (val
, "F", 0);
9202 struct type
*val_type
= ada_check_typedef (value_type (v
));
9204 if (ada_type_name (val_type
) == NULL
)
9205 val_type
->set_name (ada_type_name (type
));
9207 return unwrap_value (v
);
9211 struct type
*raw_real_type
=
9212 ada_check_typedef (ada_get_base_type (type
));
9214 /* If there is no parallel XVS or XVE type, then the value is
9215 already unwrapped. Return it without further modification. */
9216 if ((type
== raw_real_type
)
9217 && ada_find_parallel_type (type
, "___XVE") == NULL
)
9221 coerce_unspec_val_to_type
9222 (val
, ada_to_fixed_type (raw_real_type
, 0,
9223 value_address (val
),
9228 /* Given two array types T1 and T2, return nonzero iff both arrays
9229 contain the same number of elements. */
9232 ada_same_array_size_p (struct type
*t1
, struct type
*t2
)
9234 LONGEST lo1
, hi1
, lo2
, hi2
;
9236 /* Get the array bounds in order to verify that the size of
9237 the two arrays match. */
9238 if (!get_array_bounds (t1
, &lo1
, &hi1
)
9239 || !get_array_bounds (t2
, &lo2
, &hi2
))
9240 error (_("unable to determine array bounds"));
9242 /* To make things easier for size comparison, normalize a bit
9243 the case of empty arrays by making sure that the difference
9244 between upper bound and lower bound is always -1. */
9250 return (hi1
- lo1
== hi2
- lo2
);
9253 /* Assuming that VAL is an array of integrals, and TYPE represents
9254 an array with the same number of elements, but with wider integral
9255 elements, return an array "casted" to TYPE. In practice, this
9256 means that the returned array is built by casting each element
9257 of the original array into TYPE's (wider) element type. */
9259 static struct value
*
9260 ada_promote_array_of_integrals (struct type
*type
, struct value
*val
)
9262 struct type
*elt_type
= TYPE_TARGET_TYPE (type
);
9266 /* Verify that both val and type are arrays of scalars, and
9267 that the size of val's elements is smaller than the size
9268 of type's element. */
9269 gdb_assert (type
->code () == TYPE_CODE_ARRAY
);
9270 gdb_assert (is_integral_type (TYPE_TARGET_TYPE (type
)));
9271 gdb_assert (value_type (val
)->code () == TYPE_CODE_ARRAY
);
9272 gdb_assert (is_integral_type (TYPE_TARGET_TYPE (value_type (val
))));
9273 gdb_assert (TYPE_LENGTH (TYPE_TARGET_TYPE (type
))
9274 > TYPE_LENGTH (TYPE_TARGET_TYPE (value_type (val
))));
9276 if (!get_array_bounds (type
, &lo
, &hi
))
9277 error (_("unable to determine array bounds"));
9279 value
*res
= allocate_value (type
);
9280 gdb::array_view
<gdb_byte
> res_contents
= value_contents_writeable (res
);
9282 /* Promote each array element. */
9283 for (i
= 0; i
< hi
- lo
+ 1; i
++)
9285 struct value
*elt
= value_cast (elt_type
, value_subscript (val
, lo
+ i
));
9286 int elt_len
= TYPE_LENGTH (elt_type
);
9288 copy (value_contents_all (elt
), res_contents
.slice (elt_len
* i
, elt_len
));
9294 /* Coerce VAL as necessary for assignment to an lval of type TYPE, and
9295 return the converted value. */
9297 static struct value
*
9298 coerce_for_assign (struct type
*type
, struct value
*val
)
9300 struct type
*type2
= value_type (val
);
9305 type2
= ada_check_typedef (type2
);
9306 type
= ada_check_typedef (type
);
9308 if (type2
->code () == TYPE_CODE_PTR
9309 && type
->code () == TYPE_CODE_ARRAY
)
9311 val
= ada_value_ind (val
);
9312 type2
= value_type (val
);
9315 if (type2
->code () == TYPE_CODE_ARRAY
9316 && type
->code () == TYPE_CODE_ARRAY
)
9318 if (!ada_same_array_size_p (type
, type2
))
9319 error (_("cannot assign arrays of different length"));
9321 if (is_integral_type (TYPE_TARGET_TYPE (type
))
9322 && is_integral_type (TYPE_TARGET_TYPE (type2
))
9323 && TYPE_LENGTH (TYPE_TARGET_TYPE (type2
))
9324 < TYPE_LENGTH (TYPE_TARGET_TYPE (type
)))
9326 /* Allow implicit promotion of the array elements to
9328 return ada_promote_array_of_integrals (type
, val
);
9331 if (TYPE_LENGTH (TYPE_TARGET_TYPE (type2
))
9332 != TYPE_LENGTH (TYPE_TARGET_TYPE (type
)))
9333 error (_("Incompatible types in assignment"));
9334 deprecated_set_value_type (val
, type
);
9339 static struct value
*
9340 ada_value_binop (struct value
*arg1
, struct value
*arg2
, enum exp_opcode op
)
9343 struct type
*type1
, *type2
;
9346 arg1
= coerce_ref (arg1
);
9347 arg2
= coerce_ref (arg2
);
9348 type1
= get_base_type (ada_check_typedef (value_type (arg1
)));
9349 type2
= get_base_type (ada_check_typedef (value_type (arg2
)));
9351 if (type1
->code () != TYPE_CODE_INT
9352 || type2
->code () != TYPE_CODE_INT
)
9353 return value_binop (arg1
, arg2
, op
);
9362 return value_binop (arg1
, arg2
, op
);
9365 v2
= value_as_long (arg2
);
9369 if (op
== BINOP_MOD
)
9371 else if (op
== BINOP_DIV
)
9375 gdb_assert (op
== BINOP_REM
);
9379 error (_("second operand of %s must not be zero."), name
);
9382 if (type1
->is_unsigned () || op
== BINOP_MOD
)
9383 return value_binop (arg1
, arg2
, op
);
9385 v1
= value_as_long (arg1
);
9390 if (!TRUNCATION_TOWARDS_ZERO
&& v1
* (v1
% v2
) < 0)
9391 v
+= v
> 0 ? -1 : 1;
9399 /* Should not reach this point. */
9403 val
= allocate_value (type1
);
9404 store_unsigned_integer (value_contents_raw (val
).data (),
9405 TYPE_LENGTH (value_type (val
)),
9406 type_byte_order (type1
), v
);
9411 ada_value_equal (struct value
*arg1
, struct value
*arg2
)
9413 if (ada_is_direct_array_type (value_type (arg1
))
9414 || ada_is_direct_array_type (value_type (arg2
)))
9416 struct type
*arg1_type
, *arg2_type
;
9418 /* Automatically dereference any array reference before
9419 we attempt to perform the comparison. */
9420 arg1
= ada_coerce_ref (arg1
);
9421 arg2
= ada_coerce_ref (arg2
);
9423 arg1
= ada_coerce_to_simple_array (arg1
);
9424 arg2
= ada_coerce_to_simple_array (arg2
);
9426 arg1_type
= ada_check_typedef (value_type (arg1
));
9427 arg2_type
= ada_check_typedef (value_type (arg2
));
9429 if (arg1_type
->code () != TYPE_CODE_ARRAY
9430 || arg2_type
->code () != TYPE_CODE_ARRAY
)
9431 error (_("Attempt to compare array with non-array"));
9432 /* FIXME: The following works only for types whose
9433 representations use all bits (no padding or undefined bits)
9434 and do not have user-defined equality. */
9435 return (TYPE_LENGTH (arg1_type
) == TYPE_LENGTH (arg2_type
)
9436 && memcmp (value_contents (arg1
).data (),
9437 value_contents (arg2
).data (),
9438 TYPE_LENGTH (arg1_type
)) == 0);
9440 return value_equal (arg1
, arg2
);
9447 check_objfile (const std::unique_ptr
<ada_component
> &comp
,
9448 struct objfile
*objfile
)
9450 return comp
->uses_objfile (objfile
);
9453 /* Assign the result of evaluating ARG starting at *POS to the INDEXth
9454 component of LHS (a simple array or a record). Does not modify the
9455 inferior's memory, nor does it modify LHS (unless LHS ==
9459 assign_component (struct value
*container
, struct value
*lhs
, LONGEST index
,
9460 struct expression
*exp
, operation_up
&arg
)
9462 scoped_value_mark mark
;
9465 struct type
*lhs_type
= check_typedef (value_type (lhs
));
9467 if (lhs_type
->code () == TYPE_CODE_ARRAY
)
9469 struct type
*index_type
= builtin_type (exp
->gdbarch
)->builtin_int
;
9470 struct value
*index_val
= value_from_longest (index_type
, index
);
9472 elt
= unwrap_value (ada_value_subscript (lhs
, 1, &index_val
));
9476 elt
= ada_index_struct_field (index
, lhs
, 0, value_type (lhs
));
9477 elt
= ada_to_fixed_value (elt
);
9480 ada_aggregate_operation
*ag_op
9481 = dynamic_cast<ada_aggregate_operation
*> (arg
.get ());
9482 if (ag_op
!= nullptr)
9483 ag_op
->assign_aggregate (container
, elt
, exp
);
9485 value_assign_to_component (container
, elt
,
9486 arg
->evaluate (nullptr, exp
,
9491 ada_aggregate_component::uses_objfile (struct objfile
*objfile
)
9493 for (const auto &item
: m_components
)
9494 if (item
->uses_objfile (objfile
))
9500 ada_aggregate_component::dump (ui_file
*stream
, int depth
)
9502 gdb_printf (stream
, _("%*sAggregate\n"), depth
, "");
9503 for (const auto &item
: m_components
)
9504 item
->dump (stream
, depth
+ 1);
9508 ada_aggregate_component::assign (struct value
*container
,
9509 struct value
*lhs
, struct expression
*exp
,
9510 std::vector
<LONGEST
> &indices
,
9511 LONGEST low
, LONGEST high
)
9513 for (auto &item
: m_components
)
9514 item
->assign (container
, lhs
, exp
, indices
, low
, high
);
9517 /* See ada-exp.h. */
9520 ada_aggregate_operation::assign_aggregate (struct value
*container
,
9522 struct expression
*exp
)
9524 struct type
*lhs_type
;
9525 LONGEST low_index
, high_index
;
9527 container
= ada_coerce_ref (container
);
9528 if (ada_is_direct_array_type (value_type (container
)))
9529 container
= ada_coerce_to_simple_array (container
);
9530 lhs
= ada_coerce_ref (lhs
);
9531 if (!deprecated_value_modifiable (lhs
))
9532 error (_("Left operand of assignment is not a modifiable lvalue."));
9534 lhs_type
= check_typedef (value_type (lhs
));
9535 if (ada_is_direct_array_type (lhs_type
))
9537 lhs
= ada_coerce_to_simple_array (lhs
);
9538 lhs_type
= check_typedef (value_type (lhs
));
9539 low_index
= lhs_type
->bounds ()->low
.const_val ();
9540 high_index
= lhs_type
->bounds ()->high
.const_val ();
9542 else if (lhs_type
->code () == TYPE_CODE_STRUCT
)
9545 high_index
= num_visible_fields (lhs_type
) - 1;
9548 error (_("Left-hand side must be array or record."));
9550 std::vector
<LONGEST
> indices (4);
9551 indices
[0] = indices
[1] = low_index
- 1;
9552 indices
[2] = indices
[3] = high_index
+ 1;
9554 std::get
<0> (m_storage
)->assign (container
, lhs
, exp
, indices
,
9555 low_index
, high_index
);
9561 ada_positional_component::uses_objfile (struct objfile
*objfile
)
9563 return m_op
->uses_objfile (objfile
);
9567 ada_positional_component::dump (ui_file
*stream
, int depth
)
9569 gdb_printf (stream
, _("%*sPositional, index = %d\n"),
9570 depth
, "", m_index
);
9571 m_op
->dump (stream
, depth
+ 1);
9574 /* Assign into the component of LHS indexed by the OP_POSITIONAL
9575 construct, given that the positions are relative to lower bound
9576 LOW, where HIGH is the upper bound. Record the position in
9577 INDICES. CONTAINER is as for assign_aggregate. */
9579 ada_positional_component::assign (struct value
*container
,
9580 struct value
*lhs
, struct expression
*exp
,
9581 std::vector
<LONGEST
> &indices
,
9582 LONGEST low
, LONGEST high
)
9584 LONGEST ind
= m_index
+ low
;
9586 if (ind
- 1 == high
)
9587 warning (_("Extra components in aggregate ignored."));
9590 add_component_interval (ind
, ind
, indices
);
9591 assign_component (container
, lhs
, ind
, exp
, m_op
);
9596 ada_discrete_range_association::uses_objfile (struct objfile
*objfile
)
9598 return m_low
->uses_objfile (objfile
) || m_high
->uses_objfile (objfile
);
9602 ada_discrete_range_association::dump (ui_file
*stream
, int depth
)
9604 gdb_printf (stream
, _("%*sDiscrete range:\n"), depth
, "");
9605 m_low
->dump (stream
, depth
+ 1);
9606 m_high
->dump (stream
, depth
+ 1);
9610 ada_discrete_range_association::assign (struct value
*container
,
9612 struct expression
*exp
,
9613 std::vector
<LONGEST
> &indices
,
9614 LONGEST low
, LONGEST high
,
9617 LONGEST lower
= value_as_long (m_low
->evaluate (nullptr, exp
, EVAL_NORMAL
));
9618 LONGEST upper
= value_as_long (m_high
->evaluate (nullptr, exp
, EVAL_NORMAL
));
9620 if (lower
<= upper
&& (lower
< low
|| upper
> high
))
9621 error (_("Index in component association out of bounds."));
9623 add_component_interval (lower
, upper
, indices
);
9624 while (lower
<= upper
)
9626 assign_component (container
, lhs
, lower
, exp
, op
);
9632 ada_name_association::uses_objfile (struct objfile
*objfile
)
9634 return m_val
->uses_objfile (objfile
);
9638 ada_name_association::dump (ui_file
*stream
, int depth
)
9640 gdb_printf (stream
, _("%*sName:\n"), depth
, "");
9641 m_val
->dump (stream
, depth
+ 1);
9645 ada_name_association::assign (struct value
*container
,
9647 struct expression
*exp
,
9648 std::vector
<LONGEST
> &indices
,
9649 LONGEST low
, LONGEST high
,
9654 if (ada_is_direct_array_type (value_type (lhs
)))
9655 index
= longest_to_int (value_as_long (m_val
->evaluate (nullptr, exp
,
9659 ada_string_operation
*strop
9660 = dynamic_cast<ada_string_operation
*> (m_val
.get ());
9663 if (strop
!= nullptr)
9664 name
= strop
->get_name ();
9667 ada_var_value_operation
*vvo
9668 = dynamic_cast<ada_var_value_operation
*> (m_val
.get ());
9670 error (_("Invalid record component association."));
9671 name
= vvo
->get_symbol ()->natural_name ();
9675 if (! find_struct_field (name
, value_type (lhs
), 0,
9676 NULL
, NULL
, NULL
, NULL
, &index
))
9677 error (_("Unknown component name: %s."), name
);
9680 add_component_interval (index
, index
, indices
);
9681 assign_component (container
, lhs
, index
, exp
, op
);
9685 ada_choices_component::uses_objfile (struct objfile
*objfile
)
9687 if (m_op
->uses_objfile (objfile
))
9689 for (const auto &item
: m_assocs
)
9690 if (item
->uses_objfile (objfile
))
9696 ada_choices_component::dump (ui_file
*stream
, int depth
)
9698 gdb_printf (stream
, _("%*sChoices:\n"), depth
, "");
9699 m_op
->dump (stream
, depth
+ 1);
9700 for (const auto &item
: m_assocs
)
9701 item
->dump (stream
, depth
+ 1);
9704 /* Assign into the components of LHS indexed by the OP_CHOICES
9705 construct at *POS, updating *POS past the construct, given that
9706 the allowable indices are LOW..HIGH. Record the indices assigned
9707 to in INDICES. CONTAINER is as for assign_aggregate. */
9709 ada_choices_component::assign (struct value
*container
,
9710 struct value
*lhs
, struct expression
*exp
,
9711 std::vector
<LONGEST
> &indices
,
9712 LONGEST low
, LONGEST high
)
9714 for (auto &item
: m_assocs
)
9715 item
->assign (container
, lhs
, exp
, indices
, low
, high
, m_op
);
9719 ada_others_component::uses_objfile (struct objfile
*objfile
)
9721 return m_op
->uses_objfile (objfile
);
9725 ada_others_component::dump (ui_file
*stream
, int depth
)
9727 gdb_printf (stream
, _("%*sOthers:\n"), depth
, "");
9728 m_op
->dump (stream
, depth
+ 1);
9731 /* Assign the value of the expression in the OP_OTHERS construct in
9732 EXP at *POS into the components of LHS indexed from LOW .. HIGH that
9733 have not been previously assigned. The index intervals already assigned
9734 are in INDICES. CONTAINER is as for assign_aggregate. */
9736 ada_others_component::assign (struct value
*container
,
9737 struct value
*lhs
, struct expression
*exp
,
9738 std::vector
<LONGEST
> &indices
,
9739 LONGEST low
, LONGEST high
)
9741 int num_indices
= indices
.size ();
9742 for (int i
= 0; i
< num_indices
- 2; i
+= 2)
9744 for (LONGEST ind
= indices
[i
+ 1] + 1; ind
< indices
[i
+ 2]; ind
+= 1)
9745 assign_component (container
, lhs
, ind
, exp
, m_op
);
9750 ada_assign_operation::evaluate (struct type
*expect_type
,
9751 struct expression
*exp
,
9754 value
*arg1
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
, noside
);
9756 ada_aggregate_operation
*ag_op
9757 = dynamic_cast<ada_aggregate_operation
*> (std::get
<1> (m_storage
).get ());
9758 if (ag_op
!= nullptr)
9760 if (noside
!= EVAL_NORMAL
)
9763 arg1
= ag_op
->assign_aggregate (arg1
, arg1
, exp
);
9764 return ada_value_assign (arg1
, arg1
);
9766 /* Force the evaluation of the rhs ARG2 to the type of the lhs ARG1,
9767 except if the lhs of our assignment is a convenience variable.
9768 In the case of assigning to a convenience variable, the lhs
9769 should be exactly the result of the evaluation of the rhs. */
9770 struct type
*type
= value_type (arg1
);
9771 if (VALUE_LVAL (arg1
) == lval_internalvar
)
9773 value
*arg2
= std::get
<1> (m_storage
)->evaluate (type
, exp
, noside
);
9774 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
9776 if (VALUE_LVAL (arg1
) == lval_internalvar
)
9781 arg2
= coerce_for_assign (value_type (arg1
), arg2
);
9782 return ada_value_assign (arg1
, arg2
);
9785 } /* namespace expr */
9787 /* Add the interval [LOW .. HIGH] to the sorted set of intervals
9788 [ INDICES[0] .. INDICES[1] ],... The resulting intervals do not
9791 add_component_interval (LONGEST low
, LONGEST high
,
9792 std::vector
<LONGEST
> &indices
)
9796 int size
= indices
.size ();
9797 for (i
= 0; i
< size
; i
+= 2) {
9798 if (high
>= indices
[i
] && low
<= indices
[i
+ 1])
9802 for (kh
= i
+ 2; kh
< size
; kh
+= 2)
9803 if (high
< indices
[kh
])
9805 if (low
< indices
[i
])
9807 indices
[i
+ 1] = indices
[kh
- 1];
9808 if (high
> indices
[i
+ 1])
9809 indices
[i
+ 1] = high
;
9810 memcpy (indices
.data () + i
+ 2, indices
.data () + kh
, size
- kh
);
9811 indices
.resize (kh
- i
- 2);
9814 else if (high
< indices
[i
])
9818 indices
.resize (indices
.size () + 2);
9819 for (j
= indices
.size () - 1; j
>= i
+ 2; j
-= 1)
9820 indices
[j
] = indices
[j
- 2];
9822 indices
[i
+ 1] = high
;
9825 /* Perform and Ada cast of ARG2 to type TYPE if the type of ARG2
9828 static struct value
*
9829 ada_value_cast (struct type
*type
, struct value
*arg2
)
9831 if (type
== ada_check_typedef (value_type (arg2
)))
9834 return value_cast (type
, arg2
);
9837 /* Evaluating Ada expressions, and printing their result.
9838 ------------------------------------------------------
9843 We usually evaluate an Ada expression in order to print its value.
9844 We also evaluate an expression in order to print its type, which
9845 happens during the EVAL_AVOID_SIDE_EFFECTS phase of the evaluation,
9846 but we'll focus mostly on the EVAL_NORMAL phase. In practice, the
9847 EVAL_AVOID_SIDE_EFFECTS phase allows us to simplify certain aspects of
9848 the evaluation compared to the EVAL_NORMAL, but is otherwise very
9851 Evaluating expressions is a little more complicated for Ada entities
9852 than it is for entities in languages such as C. The main reason for
9853 this is that Ada provides types whose definition might be dynamic.
9854 One example of such types is variant records. Or another example
9855 would be an array whose bounds can only be known at run time.
9857 The following description is a general guide as to what should be
9858 done (and what should NOT be done) in order to evaluate an expression
9859 involving such types, and when. This does not cover how the semantic
9860 information is encoded by GNAT as this is covered separatly. For the
9861 document used as the reference for the GNAT encoding, see exp_dbug.ads
9862 in the GNAT sources.
9864 Ideally, we should embed each part of this description next to its
9865 associated code. Unfortunately, the amount of code is so vast right
9866 now that it's hard to see whether the code handling a particular
9867 situation might be duplicated or not. One day, when the code is
9868 cleaned up, this guide might become redundant with the comments
9869 inserted in the code, and we might want to remove it.
9871 2. ``Fixing'' an Entity, the Simple Case:
9872 -----------------------------------------
9874 When evaluating Ada expressions, the tricky issue is that they may
9875 reference entities whose type contents and size are not statically
9876 known. Consider for instance a variant record:
9878 type Rec (Empty : Boolean := True) is record
9881 when False => Value : Integer;
9884 Yes : Rec := (Empty => False, Value => 1);
9885 No : Rec := (empty => True);
9887 The size and contents of that record depends on the value of the
9888 descriminant (Rec.Empty). At this point, neither the debugging
9889 information nor the associated type structure in GDB are able to
9890 express such dynamic types. So what the debugger does is to create
9891 "fixed" versions of the type that applies to the specific object.
9892 We also informally refer to this operation as "fixing" an object,
9893 which means creating its associated fixed type.
9895 Example: when printing the value of variable "Yes" above, its fixed
9896 type would look like this:
9903 On the other hand, if we printed the value of "No", its fixed type
9910 Things become a little more complicated when trying to fix an entity
9911 with a dynamic type that directly contains another dynamic type,
9912 such as an array of variant records, for instance. There are
9913 two possible cases: Arrays, and records.
9915 3. ``Fixing'' Arrays:
9916 ---------------------
9918 The type structure in GDB describes an array in terms of its bounds,
9919 and the type of its elements. By design, all elements in the array
9920 have the same type and we cannot represent an array of variant elements
9921 using the current type structure in GDB. When fixing an array,
9922 we cannot fix the array element, as we would potentially need one
9923 fixed type per element of the array. As a result, the best we can do
9924 when fixing an array is to produce an array whose bounds and size
9925 are correct (allowing us to read it from memory), but without having
9926 touched its element type. Fixing each element will be done later,
9927 when (if) necessary.
9929 Arrays are a little simpler to handle than records, because the same
9930 amount of memory is allocated for each element of the array, even if
9931 the amount of space actually used by each element differs from element
9932 to element. Consider for instance the following array of type Rec:
9934 type Rec_Array is array (1 .. 2) of Rec;
9936 The actual amount of memory occupied by each element might be different
9937 from element to element, depending on the value of their discriminant.
9938 But the amount of space reserved for each element in the array remains
9939 fixed regardless. So we simply need to compute that size using
9940 the debugging information available, from which we can then determine
9941 the array size (we multiply the number of elements of the array by
9942 the size of each element).
9944 The simplest case is when we have an array of a constrained element
9945 type. For instance, consider the following type declarations:
9947 type Bounded_String (Max_Size : Integer) is
9949 Buffer : String (1 .. Max_Size);
9951 type Bounded_String_Array is array (1 ..2) of Bounded_String (80);
9953 In this case, the compiler describes the array as an array of
9954 variable-size elements (identified by its XVS suffix) for which
9955 the size can be read in the parallel XVZ variable.
9957 In the case of an array of an unconstrained element type, the compiler
9958 wraps the array element inside a private PAD type. This type should not
9959 be shown to the user, and must be "unwrap"'ed before printing. Note
9960 that we also use the adjective "aligner" in our code to designate
9961 these wrapper types.
9963 In some cases, the size allocated for each element is statically
9964 known. In that case, the PAD type already has the correct size,
9965 and the array element should remain unfixed.
9967 But there are cases when this size is not statically known.
9968 For instance, assuming that "Five" is an integer variable:
9970 type Dynamic is array (1 .. Five) of Integer;
9971 type Wrapper (Has_Length : Boolean := False) is record
9974 when True => Length : Integer;
9978 type Wrapper_Array is array (1 .. 2) of Wrapper;
9980 Hello : Wrapper_Array := (others => (Has_Length => True,
9981 Data => (others => 17),
9985 The debugging info would describe variable Hello as being an
9986 array of a PAD type. The size of that PAD type is not statically
9987 known, but can be determined using a parallel XVZ variable.
9988 In that case, a copy of the PAD type with the correct size should
9989 be used for the fixed array.
9991 3. ``Fixing'' record type objects:
9992 ----------------------------------
9994 Things are slightly different from arrays in the case of dynamic
9995 record types. In this case, in order to compute the associated
9996 fixed type, we need to determine the size and offset of each of
9997 its components. This, in turn, requires us to compute the fixed
9998 type of each of these components.
10000 Consider for instance the example:
10002 type Bounded_String (Max_Size : Natural) is record
10003 Str : String (1 .. Max_Size);
10006 My_String : Bounded_String (Max_Size => 10);
10008 In that case, the position of field "Length" depends on the size
10009 of field Str, which itself depends on the value of the Max_Size
10010 discriminant. In order to fix the type of variable My_String,
10011 we need to fix the type of field Str. Therefore, fixing a variant
10012 record requires us to fix each of its components.
10014 However, if a component does not have a dynamic size, the component
10015 should not be fixed. In particular, fields that use a PAD type
10016 should not fixed. Here is an example where this might happen
10017 (assuming type Rec above):
10019 type Container (Big : Boolean) is record
10023 when True => Another : Integer;
10024 when False => null;
10027 My_Container : Container := (Big => False,
10028 First => (Empty => True),
10031 In that example, the compiler creates a PAD type for component First,
10032 whose size is constant, and then positions the component After just
10033 right after it. The offset of component After is therefore constant
10036 The debugger computes the position of each field based on an algorithm
10037 that uses, among other things, the actual position and size of the field
10038 preceding it. Let's now imagine that the user is trying to print
10039 the value of My_Container. If the type fixing was recursive, we would
10040 end up computing the offset of field After based on the size of the
10041 fixed version of field First. And since in our example First has
10042 only one actual field, the size of the fixed type is actually smaller
10043 than the amount of space allocated to that field, and thus we would
10044 compute the wrong offset of field After.
10046 To make things more complicated, we need to watch out for dynamic
10047 components of variant records (identified by the ___XVL suffix in
10048 the component name). Even if the target type is a PAD type, the size
10049 of that type might not be statically known. So the PAD type needs
10050 to be unwrapped and the resulting type needs to be fixed. Otherwise,
10051 we might end up with the wrong size for our component. This can be
10052 observed with the following type declarations:
10054 type Octal is new Integer range 0 .. 7;
10055 type Octal_Array is array (Positive range <>) of Octal;
10056 pragma Pack (Octal_Array);
10058 type Octal_Buffer (Size : Positive) is record
10059 Buffer : Octal_Array (1 .. Size);
10063 In that case, Buffer is a PAD type whose size is unset and needs
10064 to be computed by fixing the unwrapped type.
10066 4. When to ``Fix'' un-``Fixed'' sub-elements of an entity:
10067 ----------------------------------------------------------
10069 Lastly, when should the sub-elements of an entity that remained unfixed
10070 thus far, be actually fixed?
10072 The answer is: Only when referencing that element. For instance
10073 when selecting one component of a record, this specific component
10074 should be fixed at that point in time. Or when printing the value
10075 of a record, each component should be fixed before its value gets
10076 printed. Similarly for arrays, the element of the array should be
10077 fixed when printing each element of the array, or when extracting
10078 one element out of that array. On the other hand, fixing should
10079 not be performed on the elements when taking a slice of an array!
10081 Note that one of the side effects of miscomputing the offset and
10082 size of each field is that we end up also miscomputing the size
10083 of the containing type. This can have adverse results when computing
10084 the value of an entity. GDB fetches the value of an entity based
10085 on the size of its type, and thus a wrong size causes GDB to fetch
10086 the wrong amount of memory. In the case where the computed size is
10087 too small, GDB fetches too little data to print the value of our
10088 entity. Results in this case are unpredictable, as we usually read
10089 past the buffer containing the data =:-o. */
10091 /* A helper function for TERNOP_IN_RANGE. */
10094 eval_ternop_in_range (struct type
*expect_type
, struct expression
*exp
,
10095 enum noside noside
,
10096 value
*arg1
, value
*arg2
, value
*arg3
)
10098 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg2
);
10099 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg3
);
10100 struct type
*type
= language_bool_type (exp
->language_defn
, exp
->gdbarch
);
10102 value_from_longest (type
,
10103 (value_less (arg1
, arg3
)
10104 || value_equal (arg1
, arg3
))
10105 && (value_less (arg2
, arg1
)
10106 || value_equal (arg2
, arg1
)));
10109 /* A helper function for UNOP_NEG. */
10112 ada_unop_neg (struct type
*expect_type
,
10113 struct expression
*exp
,
10114 enum noside noside
, enum exp_opcode op
,
10115 struct value
*arg1
)
10117 unop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
);
10118 return value_neg (arg1
);
10121 /* A helper function for UNOP_IN_RANGE. */
10124 ada_unop_in_range (struct type
*expect_type
,
10125 struct expression
*exp
,
10126 enum noside noside
, enum exp_opcode op
,
10127 struct value
*arg1
, struct type
*type
)
10129 struct value
*arg2
, *arg3
;
10130 switch (type
->code ())
10133 lim_warning (_("Membership test incompletely implemented; "
10134 "always returns true"));
10135 type
= language_bool_type (exp
->language_defn
, exp
->gdbarch
);
10136 return value_from_longest (type
, (LONGEST
) 1);
10138 case TYPE_CODE_RANGE
:
10139 arg2
= value_from_longest (type
,
10140 type
->bounds ()->low
.const_val ());
10141 arg3
= value_from_longest (type
,
10142 type
->bounds ()->high
.const_val ());
10143 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg2
);
10144 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg3
);
10145 type
= language_bool_type (exp
->language_defn
, exp
->gdbarch
);
10147 value_from_longest (type
,
10148 (value_less (arg1
, arg3
)
10149 || value_equal (arg1
, arg3
))
10150 && (value_less (arg2
, arg1
)
10151 || value_equal (arg2
, arg1
)));
10155 /* A helper function for OP_ATR_TAG. */
10158 ada_atr_tag (struct type
*expect_type
,
10159 struct expression
*exp
,
10160 enum noside noside
, enum exp_opcode op
,
10161 struct value
*arg1
)
10163 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10164 return value_zero (ada_tag_type (arg1
), not_lval
);
10166 return ada_value_tag (arg1
);
10169 /* A helper function for OP_ATR_SIZE. */
10172 ada_atr_size (struct type
*expect_type
,
10173 struct expression
*exp
,
10174 enum noside noside
, enum exp_opcode op
,
10175 struct value
*arg1
)
10177 struct type
*type
= value_type (arg1
);
10179 /* If the argument is a reference, then dereference its type, since
10180 the user is really asking for the size of the actual object,
10181 not the size of the pointer. */
10182 if (type
->code () == TYPE_CODE_REF
)
10183 type
= TYPE_TARGET_TYPE (type
);
10185 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10186 return value_zero (builtin_type (exp
->gdbarch
)->builtin_int
, not_lval
);
10188 return value_from_longest (builtin_type (exp
->gdbarch
)->builtin_int
,
10189 TARGET_CHAR_BIT
* TYPE_LENGTH (type
));
10192 /* A helper function for UNOP_ABS. */
10195 ada_abs (struct type
*expect_type
,
10196 struct expression
*exp
,
10197 enum noside noside
, enum exp_opcode op
,
10198 struct value
*arg1
)
10200 unop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
);
10201 if (value_less (arg1
, value_zero (value_type (arg1
), not_lval
)))
10202 return value_neg (arg1
);
10207 /* A helper function for BINOP_MUL. */
10210 ada_mult_binop (struct type
*expect_type
,
10211 struct expression
*exp
,
10212 enum noside noside
, enum exp_opcode op
,
10213 struct value
*arg1
, struct value
*arg2
)
10215 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10217 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg2
);
10218 return value_zero (value_type (arg1
), not_lval
);
10222 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg2
);
10223 return ada_value_binop (arg1
, arg2
, op
);
10227 /* A helper function for BINOP_EQUAL and BINOP_NOTEQUAL. */
10230 ada_equal_binop (struct type
*expect_type
,
10231 struct expression
*exp
,
10232 enum noside noside
, enum exp_opcode op
,
10233 struct value
*arg1
, struct value
*arg2
)
10236 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10240 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg2
);
10241 tem
= ada_value_equal (arg1
, arg2
);
10243 if (op
== BINOP_NOTEQUAL
)
10245 struct type
*type
= language_bool_type (exp
->language_defn
, exp
->gdbarch
);
10246 return value_from_longest (type
, (LONGEST
) tem
);
10249 /* A helper function for TERNOP_SLICE. */
10252 ada_ternop_slice (struct expression
*exp
,
10253 enum noside noside
,
10254 struct value
*array
, struct value
*low_bound_val
,
10255 struct value
*high_bound_val
)
10258 LONGEST high_bound
;
10260 low_bound_val
= coerce_ref (low_bound_val
);
10261 high_bound_val
= coerce_ref (high_bound_val
);
10262 low_bound
= value_as_long (low_bound_val
);
10263 high_bound
= value_as_long (high_bound_val
);
10265 /* If this is a reference to an aligner type, then remove all
10267 if (value_type (array
)->code () == TYPE_CODE_REF
10268 && ada_is_aligner_type (TYPE_TARGET_TYPE (value_type (array
))))
10269 TYPE_TARGET_TYPE (value_type (array
)) =
10270 ada_aligned_type (TYPE_TARGET_TYPE (value_type (array
)));
10272 if (ada_is_any_packed_array_type (value_type (array
)))
10273 error (_("cannot slice a packed array"));
10275 /* If this is a reference to an array or an array lvalue,
10276 convert to a pointer. */
10277 if (value_type (array
)->code () == TYPE_CODE_REF
10278 || (value_type (array
)->code () == TYPE_CODE_ARRAY
10279 && VALUE_LVAL (array
) == lval_memory
))
10280 array
= value_addr (array
);
10282 if (noside
== EVAL_AVOID_SIDE_EFFECTS
10283 && ada_is_array_descriptor_type (ada_check_typedef
10284 (value_type (array
))))
10285 return empty_array (ada_type_of_array (array
, 0), low_bound
,
10288 array
= ada_coerce_to_simple_array_ptr (array
);
10290 /* If we have more than one level of pointer indirection,
10291 dereference the value until we get only one level. */
10292 while (value_type (array
)->code () == TYPE_CODE_PTR
10293 && (TYPE_TARGET_TYPE (value_type (array
))->code ()
10295 array
= value_ind (array
);
10297 /* Make sure we really do have an array type before going further,
10298 to avoid a SEGV when trying to get the index type or the target
10299 type later down the road if the debug info generated by
10300 the compiler is incorrect or incomplete. */
10301 if (!ada_is_simple_array_type (value_type (array
)))
10302 error (_("cannot take slice of non-array"));
10304 if (ada_check_typedef (value_type (array
))->code ()
10307 struct type
*type0
= ada_check_typedef (value_type (array
));
10309 if (high_bound
< low_bound
|| noside
== EVAL_AVOID_SIDE_EFFECTS
)
10310 return empty_array (TYPE_TARGET_TYPE (type0
), low_bound
, high_bound
);
10313 struct type
*arr_type0
=
10314 to_fixed_array_type (TYPE_TARGET_TYPE (type0
), NULL
, 1);
10316 return ada_value_slice_from_ptr (array
, arr_type0
,
10317 longest_to_int (low_bound
),
10318 longest_to_int (high_bound
));
10321 else if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10323 else if (high_bound
< low_bound
)
10324 return empty_array (value_type (array
), low_bound
, high_bound
);
10326 return ada_value_slice (array
, longest_to_int (low_bound
),
10327 longest_to_int (high_bound
));
10330 /* A helper function for BINOP_IN_BOUNDS. */
10333 ada_binop_in_bounds (struct expression
*exp
, enum noside noside
,
10334 struct value
*arg1
, struct value
*arg2
, int n
)
10336 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10338 struct type
*type
= language_bool_type (exp
->language_defn
,
10340 return value_zero (type
, not_lval
);
10343 struct type
*type
= ada_index_type (value_type (arg2
), n
, "range");
10345 type
= value_type (arg1
);
10347 value
*arg3
= value_from_longest (type
, ada_array_bound (arg2
, n
, 1));
10348 arg2
= value_from_longest (type
, ada_array_bound (arg2
, n
, 0));
10350 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg2
);
10351 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg3
);
10352 type
= language_bool_type (exp
->language_defn
, exp
->gdbarch
);
10353 return value_from_longest (type
,
10354 (value_less (arg1
, arg3
)
10355 || value_equal (arg1
, arg3
))
10356 && (value_less (arg2
, arg1
)
10357 || value_equal (arg2
, arg1
)));
10360 /* A helper function for some attribute operations. */
10363 ada_unop_atr (struct expression
*exp
, enum noside noside
, enum exp_opcode op
,
10364 struct value
*arg1
, struct type
*type_arg
, int tem
)
10366 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10368 if (type_arg
== NULL
)
10369 type_arg
= value_type (arg1
);
10371 if (ada_is_constrained_packed_array_type (type_arg
))
10372 type_arg
= decode_constrained_packed_array_type (type_arg
);
10374 if (!discrete_type_p (type_arg
))
10378 default: /* Should never happen. */
10379 error (_("unexpected attribute encountered"));
10382 type_arg
= ada_index_type (type_arg
, tem
,
10383 ada_attribute_name (op
));
10385 case OP_ATR_LENGTH
:
10386 type_arg
= builtin_type (exp
->gdbarch
)->builtin_int
;
10391 return value_zero (type_arg
, not_lval
);
10393 else if (type_arg
== NULL
)
10395 arg1
= ada_coerce_ref (arg1
);
10397 if (ada_is_constrained_packed_array_type (value_type (arg1
)))
10398 arg1
= ada_coerce_to_simple_array (arg1
);
10401 if (op
== OP_ATR_LENGTH
)
10402 type
= builtin_type (exp
->gdbarch
)->builtin_int
;
10405 type
= ada_index_type (value_type (arg1
), tem
,
10406 ada_attribute_name (op
));
10408 type
= builtin_type (exp
->gdbarch
)->builtin_int
;
10413 default: /* Should never happen. */
10414 error (_("unexpected attribute encountered"));
10416 return value_from_longest
10417 (type
, ada_array_bound (arg1
, tem
, 0));
10419 return value_from_longest
10420 (type
, ada_array_bound (arg1
, tem
, 1));
10421 case OP_ATR_LENGTH
:
10422 return value_from_longest
10423 (type
, ada_array_length (arg1
, tem
));
10426 else if (discrete_type_p (type_arg
))
10428 struct type
*range_type
;
10429 const char *name
= ada_type_name (type_arg
);
10432 if (name
!= NULL
&& type_arg
->code () != TYPE_CODE_ENUM
)
10433 range_type
= to_fixed_range_type (type_arg
, NULL
);
10434 if (range_type
== NULL
)
10435 range_type
= type_arg
;
10439 error (_("unexpected attribute encountered"));
10441 return value_from_longest
10442 (range_type
, ada_discrete_type_low_bound (range_type
));
10444 return value_from_longest
10445 (range_type
, ada_discrete_type_high_bound (range_type
));
10446 case OP_ATR_LENGTH
:
10447 error (_("the 'length attribute applies only to array types"));
10450 else if (type_arg
->code () == TYPE_CODE_FLT
)
10451 error (_("unimplemented type attribute"));
10456 if (ada_is_constrained_packed_array_type (type_arg
))
10457 type_arg
= decode_constrained_packed_array_type (type_arg
);
10460 if (op
== OP_ATR_LENGTH
)
10461 type
= builtin_type (exp
->gdbarch
)->builtin_int
;
10464 type
= ada_index_type (type_arg
, tem
, ada_attribute_name (op
));
10466 type
= builtin_type (exp
->gdbarch
)->builtin_int
;
10472 error (_("unexpected attribute encountered"));
10474 low
= ada_array_bound_from_type (type_arg
, tem
, 0);
10475 return value_from_longest (type
, low
);
10477 high
= ada_array_bound_from_type (type_arg
, tem
, 1);
10478 return value_from_longest (type
, high
);
10479 case OP_ATR_LENGTH
:
10480 low
= ada_array_bound_from_type (type_arg
, tem
, 0);
10481 high
= ada_array_bound_from_type (type_arg
, tem
, 1);
10482 return value_from_longest (type
, high
- low
+ 1);
10487 /* A helper function for OP_ATR_MIN and OP_ATR_MAX. */
10490 ada_binop_minmax (struct type
*expect_type
,
10491 struct expression
*exp
,
10492 enum noside noside
, enum exp_opcode op
,
10493 struct value
*arg1
, struct value
*arg2
)
10495 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10496 return value_zero (value_type (arg1
), not_lval
);
10499 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg2
);
10500 return value_binop (arg1
, arg2
, op
);
10504 /* A helper function for BINOP_EXP. */
10507 ada_binop_exp (struct type
*expect_type
,
10508 struct expression
*exp
,
10509 enum noside noside
, enum exp_opcode op
,
10510 struct value
*arg1
, struct value
*arg2
)
10512 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10513 return value_zero (value_type (arg1
), not_lval
);
10516 /* For integer exponentiation operations,
10517 only promote the first argument. */
10518 if (is_integral_type (value_type (arg2
)))
10519 unop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
);
10521 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg2
);
10523 return value_binop (arg1
, arg2
, op
);
10530 /* See ada-exp.h. */
10533 ada_resolvable::replace (operation_up
&&owner
,
10534 struct expression
*exp
,
10535 bool deprocedure_p
,
10536 bool parse_completion
,
10537 innermost_block_tracker
*tracker
,
10538 struct type
*context_type
)
10540 if (resolve (exp
, deprocedure_p
, parse_completion
, tracker
, context_type
))
10541 return (make_operation
<ada_funcall_operation
>
10542 (std::move (owner
),
10543 std::vector
<operation_up
> ()));
10544 return std::move (owner
);
10547 /* Convert the character literal whose value would be VAL to the
10548 appropriate value of type TYPE, if there is a translation.
10549 Otherwise return VAL. Hence, in an enumeration type ('A', 'B'),
10550 the literal 'A' (VAL == 65), returns 0. */
10553 convert_char_literal (struct type
*type
, LONGEST val
)
10560 type
= check_typedef (type
);
10561 if (type
->code () != TYPE_CODE_ENUM
)
10564 if ((val
>= 'a' && val
<= 'z') || (val
>= '0' && val
<= '9'))
10565 xsnprintf (name
, sizeof (name
), "Q%c", (int) val
);
10566 else if (val
>= 0 && val
< 256)
10567 xsnprintf (name
, sizeof (name
), "QU%02x", (unsigned) val
);
10568 else if (val
>= 0 && val
< 0x10000)
10569 xsnprintf (name
, sizeof (name
), "QW%04x", (unsigned) val
);
10571 xsnprintf (name
, sizeof (name
), "QWW%08lx", (unsigned long) val
);
10572 size_t len
= strlen (name
);
10573 for (f
= 0; f
< type
->num_fields (); f
+= 1)
10575 /* Check the suffix because an enum constant in a package will
10576 have a name like "pkg__QUxx". This is safe enough because we
10577 already have the correct type, and because mangling means
10578 there can't be clashes. */
10579 const char *ename
= type
->field (f
).name ();
10580 size_t elen
= strlen (ename
);
10582 if (elen
>= len
&& strcmp (name
, ename
+ elen
- len
) == 0)
10583 return type
->field (f
).loc_enumval ();
10589 ada_char_operation::evaluate (struct type
*expect_type
,
10590 struct expression
*exp
,
10591 enum noside noside
)
10593 value
*result
= long_const_operation::evaluate (expect_type
, exp
, noside
);
10594 if (expect_type
!= nullptr)
10595 result
= ada_value_cast (expect_type
, result
);
10599 /* See ada-exp.h. */
10602 ada_char_operation::replace (operation_up
&&owner
,
10603 struct expression
*exp
,
10604 bool deprocedure_p
,
10605 bool parse_completion
,
10606 innermost_block_tracker
*tracker
,
10607 struct type
*context_type
)
10609 operation_up result
= std::move (owner
);
10611 if (context_type
!= nullptr && context_type
->code () == TYPE_CODE_ENUM
)
10613 gdb_assert (result
.get () == this);
10614 std::get
<0> (m_storage
) = context_type
;
10615 std::get
<1> (m_storage
)
10616 = convert_char_literal (context_type
, std::get
<1> (m_storage
));
10623 ada_wrapped_operation::evaluate (struct type
*expect_type
,
10624 struct expression
*exp
,
10625 enum noside noside
)
10627 value
*result
= std::get
<0> (m_storage
)->evaluate (expect_type
, exp
, noside
);
10628 if (noside
== EVAL_NORMAL
)
10629 result
= unwrap_value (result
);
10631 /* If evaluating an OP_FLOAT and an EXPECT_TYPE was provided,
10632 then we need to perform the conversion manually, because
10633 evaluate_subexp_standard doesn't do it. This conversion is
10634 necessary in Ada because the different kinds of float/fixed
10635 types in Ada have different representations.
10637 Similarly, we need to perform the conversion from OP_LONG
10639 if ((opcode () == OP_FLOAT
|| opcode () == OP_LONG
) && expect_type
!= NULL
)
10640 result
= ada_value_cast (expect_type
, result
);
10646 ada_string_operation::evaluate (struct type
*expect_type
,
10647 struct expression
*exp
,
10648 enum noside noside
)
10650 struct type
*char_type
;
10651 if (expect_type
!= nullptr && ada_is_string_type (expect_type
))
10652 char_type
= ada_array_element_type (expect_type
, 1);
10654 char_type
= language_string_char_type (exp
->language_defn
, exp
->gdbarch
);
10656 const std::string
&str
= std::get
<0> (m_storage
);
10657 const char *encoding
;
10658 switch (TYPE_LENGTH (char_type
))
10662 /* Simply copy over the data -- this isn't perhaps strictly
10663 correct according to the encodings, but it is gdb's
10664 historical behavior. */
10665 struct type
*stringtype
10666 = lookup_array_range_type (char_type
, 1, str
.length ());
10667 struct value
*val
= allocate_value (stringtype
);
10668 memcpy (value_contents_raw (val
).data (), str
.c_str (),
10674 if (gdbarch_byte_order (exp
->gdbarch
) == BFD_ENDIAN_BIG
)
10675 encoding
= "UTF-16BE";
10677 encoding
= "UTF-16LE";
10681 if (gdbarch_byte_order (exp
->gdbarch
) == BFD_ENDIAN_BIG
)
10682 encoding
= "UTF-32BE";
10684 encoding
= "UTF-32LE";
10688 error (_("unexpected character type size %s"),
10689 pulongest (TYPE_LENGTH (char_type
)));
10692 auto_obstack converted
;
10693 convert_between_encodings (host_charset (), encoding
,
10694 (const gdb_byte
*) str
.c_str (),
10696 &converted
, translit_none
);
10698 struct type
*stringtype
10699 = lookup_array_range_type (char_type
, 1,
10700 obstack_object_size (&converted
)
10701 / TYPE_LENGTH (char_type
));
10702 struct value
*val
= allocate_value (stringtype
);
10703 memcpy (value_contents_raw (val
).data (),
10704 obstack_base (&converted
),
10705 obstack_object_size (&converted
));
10710 ada_concat_operation::evaluate (struct type
*expect_type
,
10711 struct expression
*exp
,
10712 enum noside noside
)
10714 /* If one side is a literal, evaluate the other side first so that
10715 the expected type can be set properly. */
10716 const operation_up
&lhs_expr
= std::get
<0> (m_storage
);
10717 const operation_up
&rhs_expr
= std::get
<1> (m_storage
);
10720 if (dynamic_cast<ada_string_operation
*> (lhs_expr
.get ()) != nullptr)
10722 rhs
= rhs_expr
->evaluate (nullptr, exp
, noside
);
10723 lhs
= lhs_expr
->evaluate (value_type (rhs
), exp
, noside
);
10725 else if (dynamic_cast<ada_char_operation
*> (lhs_expr
.get ()) != nullptr)
10727 rhs
= rhs_expr
->evaluate (nullptr, exp
, noside
);
10728 struct type
*rhs_type
= check_typedef (value_type (rhs
));
10729 struct type
*elt_type
= nullptr;
10730 if (rhs_type
->code () == TYPE_CODE_ARRAY
)
10731 elt_type
= TYPE_TARGET_TYPE (rhs_type
);
10732 lhs
= lhs_expr
->evaluate (elt_type
, exp
, noside
);
10734 else if (dynamic_cast<ada_string_operation
*> (rhs_expr
.get ()) != nullptr)
10736 lhs
= lhs_expr
->evaluate (nullptr, exp
, noside
);
10737 rhs
= rhs_expr
->evaluate (value_type (lhs
), exp
, noside
);
10739 else if (dynamic_cast<ada_char_operation
*> (rhs_expr
.get ()) != nullptr)
10741 lhs
= lhs_expr
->evaluate (nullptr, exp
, noside
);
10742 struct type
*lhs_type
= check_typedef (value_type (lhs
));
10743 struct type
*elt_type
= nullptr;
10744 if (lhs_type
->code () == TYPE_CODE_ARRAY
)
10745 elt_type
= TYPE_TARGET_TYPE (lhs_type
);
10746 rhs
= rhs_expr
->evaluate (elt_type
, exp
, noside
);
10749 return concat_operation::evaluate (expect_type
, exp
, noside
);
10751 return value_concat (lhs
, rhs
);
10755 ada_qual_operation::evaluate (struct type
*expect_type
,
10756 struct expression
*exp
,
10757 enum noside noside
)
10759 struct type
*type
= std::get
<1> (m_storage
);
10760 return std::get
<0> (m_storage
)->evaluate (type
, exp
, noside
);
10764 ada_ternop_range_operation::evaluate (struct type
*expect_type
,
10765 struct expression
*exp
,
10766 enum noside noside
)
10768 value
*arg0
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
, noside
);
10769 value
*arg1
= std::get
<1> (m_storage
)->evaluate (nullptr, exp
, noside
);
10770 value
*arg2
= std::get
<2> (m_storage
)->evaluate (nullptr, exp
, noside
);
10771 return eval_ternop_in_range (expect_type
, exp
, noside
, arg0
, arg1
, arg2
);
10775 ada_binop_addsub_operation::evaluate (struct type
*expect_type
,
10776 struct expression
*exp
,
10777 enum noside noside
)
10779 value
*arg1
= std::get
<1> (m_storage
)->evaluate_with_coercion (exp
, noside
);
10780 value
*arg2
= std::get
<2> (m_storage
)->evaluate_with_coercion (exp
, noside
);
10782 auto do_op
= [=] (LONGEST x
, LONGEST y
)
10784 if (std::get
<0> (m_storage
) == BINOP_ADD
)
10789 if (value_type (arg1
)->code () == TYPE_CODE_PTR
)
10790 return (value_from_longest
10791 (value_type (arg1
),
10792 do_op (value_as_long (arg1
), value_as_long (arg2
))));
10793 if (value_type (arg2
)->code () == TYPE_CODE_PTR
)
10794 return (value_from_longest
10795 (value_type (arg2
),
10796 do_op (value_as_long (arg1
), value_as_long (arg2
))));
10797 /* Preserve the original type for use by the range case below.
10798 We cannot cast the result to a reference type, so if ARG1 is
10799 a reference type, find its underlying type. */
10800 struct type
*type
= value_type (arg1
);
10801 while (type
->code () == TYPE_CODE_REF
)
10802 type
= TYPE_TARGET_TYPE (type
);
10803 binop_promote (exp
->language_defn
, exp
->gdbarch
, &arg1
, &arg2
);
10804 arg1
= value_binop (arg1
, arg2
, std::get
<0> (m_storage
));
10805 /* We need to special-case the result with a range.
10806 This is done for the benefit of "ptype". gdb's Ada support
10807 historically used the LHS to set the result type here, so
10808 preserve this behavior. */
10809 if (type
->code () == TYPE_CODE_RANGE
)
10810 arg1
= value_cast (type
, arg1
);
10815 ada_unop_atr_operation::evaluate (struct type
*expect_type
,
10816 struct expression
*exp
,
10817 enum noside noside
)
10819 struct type
*type_arg
= nullptr;
10820 value
*val
= nullptr;
10822 if (std::get
<0> (m_storage
)->opcode () == OP_TYPE
)
10824 value
*tem
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
,
10825 EVAL_AVOID_SIDE_EFFECTS
);
10826 type_arg
= value_type (tem
);
10829 val
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
, noside
);
10831 return ada_unop_atr (exp
, noside
, std::get
<1> (m_storage
),
10832 val
, type_arg
, std::get
<2> (m_storage
));
10836 ada_var_msym_value_operation::evaluate_for_cast (struct type
*expect_type
,
10837 struct expression
*exp
,
10838 enum noside noside
)
10840 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10841 return value_zero (expect_type
, not_lval
);
10843 const bound_minimal_symbol
&b
= std::get
<0> (m_storage
);
10844 value
*val
= evaluate_var_msym_value (noside
, b
.objfile
, b
.minsym
);
10846 val
= ada_value_cast (expect_type
, val
);
10848 /* Follow the Ada language semantics that do not allow taking
10849 an address of the result of a cast (view conversion in Ada). */
10850 if (VALUE_LVAL (val
) == lval_memory
)
10852 if (value_lazy (val
))
10853 value_fetch_lazy (val
);
10854 VALUE_LVAL (val
) = not_lval
;
10860 ada_var_value_operation::evaluate_for_cast (struct type
*expect_type
,
10861 struct expression
*exp
,
10862 enum noside noside
)
10864 value
*val
= evaluate_var_value (noside
,
10865 std::get
<0> (m_storage
).block
,
10866 std::get
<0> (m_storage
).symbol
);
10868 val
= ada_value_cast (expect_type
, val
);
10870 /* Follow the Ada language semantics that do not allow taking
10871 an address of the result of a cast (view conversion in Ada). */
10872 if (VALUE_LVAL (val
) == lval_memory
)
10874 if (value_lazy (val
))
10875 value_fetch_lazy (val
);
10876 VALUE_LVAL (val
) = not_lval
;
10882 ada_var_value_operation::evaluate (struct type
*expect_type
,
10883 struct expression
*exp
,
10884 enum noside noside
)
10886 symbol
*sym
= std::get
<0> (m_storage
).symbol
;
10888 if (sym
->domain () == UNDEF_DOMAIN
)
10889 /* Only encountered when an unresolved symbol occurs in a
10890 context other than a function call, in which case, it is
10892 error (_("Unexpected unresolved symbol, %s, during evaluation"),
10893 sym
->print_name ());
10895 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
10897 struct type
*type
= static_unwrap_type (sym
->type ());
10898 /* Check to see if this is a tagged type. We also need to handle
10899 the case where the type is a reference to a tagged type, but
10900 we have to be careful to exclude pointers to tagged types.
10901 The latter should be shown as usual (as a pointer), whereas
10902 a reference should mostly be transparent to the user. */
10903 if (ada_is_tagged_type (type
, 0)
10904 || (type
->code () == TYPE_CODE_REF
10905 && ada_is_tagged_type (TYPE_TARGET_TYPE (type
), 0)))
10907 /* Tagged types are a little special in the fact that the real
10908 type is dynamic and can only be determined by inspecting the
10909 object's tag. This means that we need to get the object's
10910 value first (EVAL_NORMAL) and then extract the actual object
10913 Note that we cannot skip the final step where we extract
10914 the object type from its tag, because the EVAL_NORMAL phase
10915 results in dynamic components being resolved into fixed ones.
10916 This can cause problems when trying to print the type
10917 description of tagged types whose parent has a dynamic size:
10918 We use the type name of the "_parent" component in order
10919 to print the name of the ancestor type in the type description.
10920 If that component had a dynamic size, the resolution into
10921 a fixed type would result in the loss of that type name,
10922 thus preventing us from printing the name of the ancestor
10923 type in the type description. */
10924 value
*arg1
= evaluate (nullptr, exp
, EVAL_NORMAL
);
10926 if (type
->code () != TYPE_CODE_REF
)
10928 struct type
*actual_type
;
10930 actual_type
= type_from_tag (ada_value_tag (arg1
));
10931 if (actual_type
== NULL
)
10932 /* If, for some reason, we were unable to determine
10933 the actual type from the tag, then use the static
10934 approximation that we just computed as a fallback.
10935 This can happen if the debugging information is
10936 incomplete, for instance. */
10937 actual_type
= type
;
10938 return value_zero (actual_type
, not_lval
);
10942 /* In the case of a ref, ada_coerce_ref takes care
10943 of determining the actual type. But the evaluation
10944 should return a ref as it should be valid to ask
10945 for its address; so rebuild a ref after coerce. */
10946 arg1
= ada_coerce_ref (arg1
);
10947 return value_ref (arg1
, TYPE_CODE_REF
);
10951 /* Records and unions for which GNAT encodings have been
10952 generated need to be statically fixed as well.
10953 Otherwise, non-static fixing produces a type where
10954 all dynamic properties are removed, which prevents "ptype"
10955 from being able to completely describe the type.
10956 For instance, a case statement in a variant record would be
10957 replaced by the relevant components based on the actual
10958 value of the discriminants. */
10959 if ((type
->code () == TYPE_CODE_STRUCT
10960 && dynamic_template_type (type
) != NULL
)
10961 || (type
->code () == TYPE_CODE_UNION
10962 && ada_find_parallel_type (type
, "___XVU") != NULL
))
10963 return value_zero (to_static_fixed_type (type
), not_lval
);
10966 value
*arg1
= var_value_operation::evaluate (expect_type
, exp
, noside
);
10967 return ada_to_fixed_value (arg1
);
10971 ada_var_value_operation::resolve (struct expression
*exp
,
10972 bool deprocedure_p
,
10973 bool parse_completion
,
10974 innermost_block_tracker
*tracker
,
10975 struct type
*context_type
)
10977 symbol
*sym
= std::get
<0> (m_storage
).symbol
;
10978 if (sym
->domain () == UNDEF_DOMAIN
)
10980 block_symbol resolved
10981 = ada_resolve_variable (sym
, std::get
<0> (m_storage
).block
,
10982 context_type
, parse_completion
,
10983 deprocedure_p
, tracker
);
10984 std::get
<0> (m_storage
) = resolved
;
10988 && (std::get
<0> (m_storage
).symbol
->type ()->code ()
10989 == TYPE_CODE_FUNC
))
10996 ada_atr_val_operation::evaluate (struct type
*expect_type
,
10997 struct expression
*exp
,
10998 enum noside noside
)
11000 value
*arg
= std::get
<1> (m_storage
)->evaluate (nullptr, exp
, noside
);
11001 return ada_val_atr (noside
, std::get
<0> (m_storage
), arg
);
11005 ada_unop_ind_operation::evaluate (struct type
*expect_type
,
11006 struct expression
*exp
,
11007 enum noside noside
)
11009 value
*arg1
= std::get
<0> (m_storage
)->evaluate (expect_type
, exp
, noside
);
11011 struct type
*type
= ada_check_typedef (value_type (arg1
));
11012 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
11014 if (ada_is_array_descriptor_type (type
))
11015 /* GDB allows dereferencing GNAT array descriptors. */
11017 struct type
*arrType
= ada_type_of_array (arg1
, 0);
11019 if (arrType
== NULL
)
11020 error (_("Attempt to dereference null array pointer."));
11021 return value_at_lazy (arrType
, 0);
11023 else if (type
->code () == TYPE_CODE_PTR
11024 || type
->code () == TYPE_CODE_REF
11025 /* In C you can dereference an array to get the 1st elt. */
11026 || type
->code () == TYPE_CODE_ARRAY
)
11028 /* As mentioned in the OP_VAR_VALUE case, tagged types can
11029 only be determined by inspecting the object's tag.
11030 This means that we need to evaluate completely the
11031 expression in order to get its type. */
11033 if ((type
->code () == TYPE_CODE_REF
11034 || type
->code () == TYPE_CODE_PTR
)
11035 && ada_is_tagged_type (TYPE_TARGET_TYPE (type
), 0))
11037 arg1
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
,
11039 type
= value_type (ada_value_ind (arg1
));
11043 type
= to_static_fixed_type
11045 (ada_check_typedef (TYPE_TARGET_TYPE (type
))));
11047 return value_zero (type
, lval_memory
);
11049 else if (type
->code () == TYPE_CODE_INT
)
11051 /* GDB allows dereferencing an int. */
11052 if (expect_type
== NULL
)
11053 return value_zero (builtin_type (exp
->gdbarch
)->builtin_int
,
11058 to_static_fixed_type (ada_aligned_type (expect_type
));
11059 return value_zero (expect_type
, lval_memory
);
11063 error (_("Attempt to take contents of a non-pointer value."));
11065 arg1
= ada_coerce_ref (arg1
); /* FIXME: What is this for?? */
11066 type
= ada_check_typedef (value_type (arg1
));
11068 if (type
->code () == TYPE_CODE_INT
)
11069 /* GDB allows dereferencing an int. If we were given
11070 the expect_type, then use that as the target type.
11071 Otherwise, assume that the target type is an int. */
11073 if (expect_type
!= NULL
)
11074 return ada_value_ind (value_cast (lookup_pointer_type (expect_type
),
11077 return value_at_lazy (builtin_type (exp
->gdbarch
)->builtin_int
,
11078 (CORE_ADDR
) value_as_address (arg1
));
11081 if (ada_is_array_descriptor_type (type
))
11082 /* GDB allows dereferencing GNAT array descriptors. */
11083 return ada_coerce_to_simple_array (arg1
);
11085 return ada_value_ind (arg1
);
11089 ada_structop_operation::evaluate (struct type
*expect_type
,
11090 struct expression
*exp
,
11091 enum noside noside
)
11093 value
*arg1
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
, noside
);
11094 const char *str
= std::get
<1> (m_storage
).c_str ();
11095 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
11098 struct type
*type1
= value_type (arg1
);
11100 if (ada_is_tagged_type (type1
, 1))
11102 type
= ada_lookup_struct_elt_type (type1
, str
, 1, 1);
11104 /* If the field is not found, check if it exists in the
11105 extension of this object's type. This means that we
11106 need to evaluate completely the expression. */
11110 arg1
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
,
11112 arg1
= ada_value_struct_elt (arg1
, str
, 0);
11113 arg1
= unwrap_value (arg1
);
11114 type
= value_type (ada_to_fixed_value (arg1
));
11118 type
= ada_lookup_struct_elt_type (type1
, str
, 1, 0);
11120 return value_zero (ada_aligned_type (type
), lval_memory
);
11124 arg1
= ada_value_struct_elt (arg1
, str
, 0);
11125 arg1
= unwrap_value (arg1
);
11126 return ada_to_fixed_value (arg1
);
11131 ada_funcall_operation::evaluate (struct type
*expect_type
,
11132 struct expression
*exp
,
11133 enum noside noside
)
11135 const std::vector
<operation_up
> &args_up
= std::get
<1> (m_storage
);
11136 int nargs
= args_up
.size ();
11137 std::vector
<value
*> argvec (nargs
);
11138 operation_up
&callee_op
= std::get
<0> (m_storage
);
11140 ada_var_value_operation
*avv
11141 = dynamic_cast<ada_var_value_operation
*> (callee_op
.get ());
11143 && avv
->get_symbol ()->domain () == UNDEF_DOMAIN
)
11144 error (_("Unexpected unresolved symbol, %s, during evaluation"),
11145 avv
->get_symbol ()->print_name ());
11147 value
*callee
= callee_op
->evaluate (nullptr, exp
, noside
);
11148 for (int i
= 0; i
< args_up
.size (); ++i
)
11149 argvec
[i
] = args_up
[i
]->evaluate (nullptr, exp
, noside
);
11151 if (ada_is_constrained_packed_array_type
11152 (desc_base_type (value_type (callee
))))
11153 callee
= ada_coerce_to_simple_array (callee
);
11154 else if (value_type (callee
)->code () == TYPE_CODE_ARRAY
11155 && TYPE_FIELD_BITSIZE (value_type (callee
), 0) != 0)
11156 /* This is a packed array that has already been fixed, and
11157 therefore already coerced to a simple array. Nothing further
11160 else if (value_type (callee
)->code () == TYPE_CODE_REF
)
11162 /* Make sure we dereference references so that all the code below
11163 feels like it's really handling the referenced value. Wrapping
11164 types (for alignment) may be there, so make sure we strip them as
11166 callee
= ada_to_fixed_value (coerce_ref (callee
));
11168 else if (value_type (callee
)->code () == TYPE_CODE_ARRAY
11169 && VALUE_LVAL (callee
) == lval_memory
)
11170 callee
= value_addr (callee
);
11172 struct type
*type
= ada_check_typedef (value_type (callee
));
11174 /* Ada allows us to implicitly dereference arrays when subscripting
11175 them. So, if this is an array typedef (encoding use for array
11176 access types encoded as fat pointers), strip it now. */
11177 if (type
->code () == TYPE_CODE_TYPEDEF
)
11178 type
= ada_typedef_target_type (type
);
11180 if (type
->code () == TYPE_CODE_PTR
)
11182 switch (ada_check_typedef (TYPE_TARGET_TYPE (type
))->code ())
11184 case TYPE_CODE_FUNC
:
11185 type
= ada_check_typedef (TYPE_TARGET_TYPE (type
));
11187 case TYPE_CODE_ARRAY
:
11189 case TYPE_CODE_STRUCT
:
11190 if (noside
!= EVAL_AVOID_SIDE_EFFECTS
)
11191 callee
= ada_value_ind (callee
);
11192 type
= ada_check_typedef (TYPE_TARGET_TYPE (type
));
11195 error (_("cannot subscript or call something of type `%s'"),
11196 ada_type_name (value_type (callee
)));
11201 switch (type
->code ())
11203 case TYPE_CODE_FUNC
:
11204 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
11206 if (TYPE_TARGET_TYPE (type
) == NULL
)
11207 error_call_unknown_return_type (NULL
);
11208 return allocate_value (TYPE_TARGET_TYPE (type
));
11210 return call_function_by_hand (callee
, NULL
, argvec
);
11211 case TYPE_CODE_INTERNAL_FUNCTION
:
11212 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
11213 /* We don't know anything about what the internal
11214 function might return, but we have to return
11216 return value_zero (builtin_type (exp
->gdbarch
)->builtin_int
,
11219 return call_internal_function (exp
->gdbarch
, exp
->language_defn
,
11223 case TYPE_CODE_STRUCT
:
11227 arity
= ada_array_arity (type
);
11228 type
= ada_array_element_type (type
, nargs
);
11230 error (_("cannot subscript or call a record"));
11231 if (arity
!= nargs
)
11232 error (_("wrong number of subscripts; expecting %d"), arity
);
11233 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
11234 return value_zero (ada_aligned_type (type
), lval_memory
);
11236 unwrap_value (ada_value_subscript
11237 (callee
, nargs
, argvec
.data ()));
11239 case TYPE_CODE_ARRAY
:
11240 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
11242 type
= ada_array_element_type (type
, nargs
);
11244 error (_("element type of array unknown"));
11246 return value_zero (ada_aligned_type (type
), lval_memory
);
11249 unwrap_value (ada_value_subscript
11250 (ada_coerce_to_simple_array (callee
),
11251 nargs
, argvec
.data ()));
11252 case TYPE_CODE_PTR
: /* Pointer to array */
11253 if (noside
== EVAL_AVOID_SIDE_EFFECTS
)
11255 type
= to_fixed_array_type (TYPE_TARGET_TYPE (type
), NULL
, 1);
11256 type
= ada_array_element_type (type
, nargs
);
11258 error (_("element type of array unknown"));
11260 return value_zero (ada_aligned_type (type
), lval_memory
);
11263 unwrap_value (ada_value_ptr_subscript (callee
, nargs
,
11267 error (_("Attempt to index or call something other than an "
11268 "array or function"));
11273 ada_funcall_operation::resolve (struct expression
*exp
,
11274 bool deprocedure_p
,
11275 bool parse_completion
,
11276 innermost_block_tracker
*tracker
,
11277 struct type
*context_type
)
11279 operation_up
&callee_op
= std::get
<0> (m_storage
);
11281 ada_var_value_operation
*avv
11282 = dynamic_cast<ada_var_value_operation
*> (callee_op
.get ());
11283 if (avv
== nullptr)
11286 symbol
*sym
= avv
->get_symbol ();
11287 if (sym
->domain () != UNDEF_DOMAIN
)
11290 const std::vector
<operation_up
> &args_up
= std::get
<1> (m_storage
);
11291 int nargs
= args_up
.size ();
11292 std::vector
<value
*> argvec (nargs
);
11294 for (int i
= 0; i
< args_up
.size (); ++i
)
11295 argvec
[i
] = args_up
[i
]->evaluate (nullptr, exp
, EVAL_AVOID_SIDE_EFFECTS
);
11297 const block
*block
= avv
->get_block ();
11298 block_symbol resolved
11299 = ada_resolve_funcall (sym
, block
,
11300 context_type
, parse_completion
,
11301 nargs
, argvec
.data (),
11304 std::get
<0> (m_storage
)
11305 = make_operation
<ada_var_value_operation
> (resolved
);
11310 ada_ternop_slice_operation::resolve (struct expression
*exp
,
11311 bool deprocedure_p
,
11312 bool parse_completion
,
11313 innermost_block_tracker
*tracker
,
11314 struct type
*context_type
)
11316 /* Historically this check was done during resolution, so we
11317 continue that here. */
11318 value
*v
= std::get
<0> (m_storage
)->evaluate (context_type
, exp
,
11319 EVAL_AVOID_SIDE_EFFECTS
);
11320 if (ada_is_any_packed_array_type (value_type (v
)))
11321 error (_("cannot slice a packed array"));
11329 /* Return non-zero iff TYPE represents a System.Address type. */
11332 ada_is_system_address_type (struct type
*type
)
11334 return (type
->name () && strcmp (type
->name (), "system__address") == 0);
11341 /* Scan STR beginning at position K for a discriminant name, and
11342 return the value of that discriminant field of DVAL in *PX. If
11343 PNEW_K is not null, put the position of the character beyond the
11344 name scanned in *PNEW_K. Return 1 if successful; return 0 and do
11345 not alter *PX and *PNEW_K if unsuccessful. */
11348 scan_discrim_bound (const char *str
, int k
, struct value
*dval
, LONGEST
* px
,
11351 static std::string storage
;
11352 const char *pstart
, *pend
, *bound
;
11353 struct value
*bound_val
;
11355 if (dval
== NULL
|| str
== NULL
|| str
[k
] == '\0')
11359 pend
= strstr (pstart
, "__");
11363 k
+= strlen (bound
);
11367 int len
= pend
- pstart
;
11369 /* Strip __ and beyond. */
11370 storage
= std::string (pstart
, len
);
11371 bound
= storage
.c_str ();
11375 bound_val
= ada_search_struct_field (bound
, dval
, 0, value_type (dval
));
11376 if (bound_val
== NULL
)
11379 *px
= value_as_long (bound_val
);
11380 if (pnew_k
!= NULL
)
11385 /* Value of variable named NAME. Only exact matches are considered.
11386 If no such variable found, then if ERR_MSG is null, returns 0, and
11387 otherwise causes an error with message ERR_MSG. */
11389 static struct value
*
11390 get_var_value (const char *name
, const char *err_msg
)
11392 std::string quoted_name
= add_angle_brackets (name
);
11394 lookup_name_info
lookup_name (quoted_name
, symbol_name_match_type::FULL
);
11396 std::vector
<struct block_symbol
> syms
11397 = ada_lookup_symbol_list_worker (lookup_name
,
11398 get_selected_block (0),
11401 if (syms
.size () != 1)
11403 if (err_msg
== NULL
)
11406 error (("%s"), err_msg
);
11409 return value_of_variable (syms
[0].symbol
, syms
[0].block
);
11412 /* Value of integer variable named NAME in the current environment.
11413 If no such variable is found, returns false. Otherwise, sets VALUE
11414 to the variable's value and returns true. */
11417 get_int_var_value (const char *name
, LONGEST
&value
)
11419 struct value
*var_val
= get_var_value (name
, 0);
11424 value
= value_as_long (var_val
);
11429 /* Return a range type whose base type is that of the range type named
11430 NAME in the current environment, and whose bounds are calculated
11431 from NAME according to the GNAT range encoding conventions.
11432 Extract discriminant values, if needed, from DVAL. ORIG_TYPE is the
11433 corresponding range type from debug information; fall back to using it
11434 if symbol lookup fails. If a new type must be created, allocate it
11435 like ORIG_TYPE was. The bounds information, in general, is encoded
11436 in NAME, the base type given in the named range type. */
11438 static struct type
*
11439 to_fixed_range_type (struct type
*raw_type
, struct value
*dval
)
11442 struct type
*base_type
;
11443 const char *subtype_info
;
11445 gdb_assert (raw_type
!= NULL
);
11446 gdb_assert (raw_type
->name () != NULL
);
11448 if (raw_type
->code () == TYPE_CODE_RANGE
)
11449 base_type
= TYPE_TARGET_TYPE (raw_type
);
11451 base_type
= raw_type
;
11453 name
= raw_type
->name ();
11454 subtype_info
= strstr (name
, "___XD");
11455 if (subtype_info
== NULL
)
11457 LONGEST L
= ada_discrete_type_low_bound (raw_type
);
11458 LONGEST U
= ada_discrete_type_high_bound (raw_type
);
11460 if (L
< INT_MIN
|| U
> INT_MAX
)
11463 return create_static_range_type (alloc_type_copy (raw_type
), raw_type
,
11468 int prefix_len
= subtype_info
- name
;
11471 const char *bounds_str
;
11475 bounds_str
= strchr (subtype_info
, '_');
11478 if (*subtype_info
== 'L')
11480 if (!ada_scan_number (bounds_str
, n
, &L
, &n
)
11481 && !scan_discrim_bound (bounds_str
, n
, dval
, &L
, &n
))
11483 if (bounds_str
[n
] == '_')
11485 else if (bounds_str
[n
] == '.') /* FIXME? SGI Workshop kludge. */
11491 std::string name_buf
= std::string (name
, prefix_len
) + "___L";
11492 if (!get_int_var_value (name_buf
.c_str (), L
))
11494 lim_warning (_("Unknown lower bound, using 1."));
11499 if (*subtype_info
== 'U')
11501 if (!ada_scan_number (bounds_str
, n
, &U
, &n
)
11502 && !scan_discrim_bound (bounds_str
, n
, dval
, &U
, &n
))
11507 std::string name_buf
= std::string (name
, prefix_len
) + "___U";
11508 if (!get_int_var_value (name_buf
.c_str (), U
))
11510 lim_warning (_("Unknown upper bound, using %ld."), (long) L
);
11515 type
= create_static_range_type (alloc_type_copy (raw_type
),
11517 /* create_static_range_type alters the resulting type's length
11518 to match the size of the base_type, which is not what we want.
11519 Set it back to the original range type's length. */
11520 TYPE_LENGTH (type
) = TYPE_LENGTH (raw_type
);
11521 type
->set_name (name
);
11526 /* True iff NAME is the name of a range type. */
11529 ada_is_range_type_name (const char *name
)
11531 return (name
!= NULL
&& strstr (name
, "___XD"));
11535 /* Modular types */
11537 /* True iff TYPE is an Ada modular type. */
11540 ada_is_modular_type (struct type
*type
)
11542 struct type
*subranged_type
= get_base_type (type
);
11544 return (subranged_type
!= NULL
&& type
->code () == TYPE_CODE_RANGE
11545 && subranged_type
->code () == TYPE_CODE_INT
11546 && subranged_type
->is_unsigned ());
11549 /* Assuming ada_is_modular_type (TYPE), the modulus of TYPE. */
11552 ada_modulus (struct type
*type
)
11554 const dynamic_prop
&high
= type
->bounds ()->high
;
11556 if (high
.kind () == PROP_CONST
)
11557 return (ULONGEST
) high
.const_val () + 1;
11559 /* If TYPE is unresolved, the high bound might be a location list. Return
11560 0, for lack of a better value to return. */
11565 /* Ada exception catchpoint support:
11566 ---------------------------------
11568 We support 3 kinds of exception catchpoints:
11569 . catchpoints on Ada exceptions
11570 . catchpoints on unhandled Ada exceptions
11571 . catchpoints on failed assertions
11573 Exceptions raised during failed assertions, or unhandled exceptions
11574 could perfectly be caught with the general catchpoint on Ada exceptions.
11575 However, we can easily differentiate these two special cases, and having
11576 the option to distinguish these two cases from the rest can be useful
11577 to zero-in on certain situations.
11579 Exception catchpoints are a specialized form of breakpoint,
11580 since they rely on inserting breakpoints inside known routines
11581 of the GNAT runtime. The implementation therefore uses a standard
11582 breakpoint structure of the BP_BREAKPOINT type, but with its own set
11585 Support in the runtime for exception catchpoints have been changed
11586 a few times already, and these changes affect the implementation
11587 of these catchpoints. In order to be able to support several
11588 variants of the runtime, we use a sniffer that will determine
11589 the runtime variant used by the program being debugged. */
11591 /* Ada's standard exceptions.
11593 The Ada 83 standard also defined Numeric_Error. But there so many
11594 situations where it was unclear from the Ada 83 Reference Manual
11595 (RM) whether Constraint_Error or Numeric_Error should be raised,
11596 that the ARG (Ada Rapporteur Group) eventually issued a Binding
11597 Interpretation saying that anytime the RM says that Numeric_Error
11598 should be raised, the implementation may raise Constraint_Error.
11599 Ada 95 went one step further and pretty much removed Numeric_Error
11600 from the list of standard exceptions (it made it a renaming of
11601 Constraint_Error, to help preserve compatibility when compiling
11602 an Ada83 compiler). As such, we do not include Numeric_Error from
11603 this list of standard exceptions. */
11605 static const char * const standard_exc
[] = {
11606 "constraint_error",
11612 typedef CORE_ADDR (ada_unhandled_exception_name_addr_ftype
) (void);
11614 /* A structure that describes how to support exception catchpoints
11615 for a given executable. */
11617 struct exception_support_info
11619 /* The name of the symbol to break on in order to insert
11620 a catchpoint on exceptions. */
11621 const char *catch_exception_sym
;
11623 /* The name of the symbol to break on in order to insert
11624 a catchpoint on unhandled exceptions. */
11625 const char *catch_exception_unhandled_sym
;
11627 /* The name of the symbol to break on in order to insert
11628 a catchpoint on failed assertions. */
11629 const char *catch_assert_sym
;
11631 /* The name of the symbol to break on in order to insert
11632 a catchpoint on exception handling. */
11633 const char *catch_handlers_sym
;
11635 /* Assuming that the inferior just triggered an unhandled exception
11636 catchpoint, this function is responsible for returning the address
11637 in inferior memory where the name of that exception is stored.
11638 Return zero if the address could not be computed. */
11639 ada_unhandled_exception_name_addr_ftype
*unhandled_exception_name_addr
;
11642 static CORE_ADDR
ada_unhandled_exception_name_addr (void);
11643 static CORE_ADDR
ada_unhandled_exception_name_addr_from_raise (void);
11645 /* The following exception support info structure describes how to
11646 implement exception catchpoints with the latest version of the
11647 Ada runtime (as of 2019-08-??). */
11649 static const struct exception_support_info default_exception_support_info
=
11651 "__gnat_debug_raise_exception", /* catch_exception_sym */
11652 "__gnat_unhandled_exception", /* catch_exception_unhandled_sym */
11653 "__gnat_debug_raise_assert_failure", /* catch_assert_sym */
11654 "__gnat_begin_handler_v1", /* catch_handlers_sym */
11655 ada_unhandled_exception_name_addr
11658 /* The following exception support info structure describes how to
11659 implement exception catchpoints with an earlier version of the
11660 Ada runtime (as of 2007-03-06) using v0 of the EH ABI. */
11662 static const struct exception_support_info exception_support_info_v0
=
11664 "__gnat_debug_raise_exception", /* catch_exception_sym */
11665 "__gnat_unhandled_exception", /* catch_exception_unhandled_sym */
11666 "__gnat_debug_raise_assert_failure", /* catch_assert_sym */
11667 "__gnat_begin_handler", /* catch_handlers_sym */
11668 ada_unhandled_exception_name_addr
11671 /* The following exception support info structure describes how to
11672 implement exception catchpoints with a slightly older version
11673 of the Ada runtime. */
11675 static const struct exception_support_info exception_support_info_fallback
=
11677 "__gnat_raise_nodefer_with_msg", /* catch_exception_sym */
11678 "__gnat_unhandled_exception", /* catch_exception_unhandled_sym */
11679 "system__assertions__raise_assert_failure", /* catch_assert_sym */
11680 "__gnat_begin_handler", /* catch_handlers_sym */
11681 ada_unhandled_exception_name_addr_from_raise
11684 /* Return nonzero if we can detect the exception support routines
11685 described in EINFO.
11687 This function errors out if an abnormal situation is detected
11688 (for instance, if we find the exception support routines, but
11689 that support is found to be incomplete). */
11692 ada_has_this_exception_support (const struct exception_support_info
*einfo
)
11694 struct symbol
*sym
;
11696 /* The symbol we're looking up is provided by a unit in the GNAT runtime
11697 that should be compiled with debugging information. As a result, we
11698 expect to find that symbol in the symtabs. */
11700 sym
= standard_lookup (einfo
->catch_exception_sym
, NULL
, VAR_DOMAIN
);
11703 /* Perhaps we did not find our symbol because the Ada runtime was
11704 compiled without debugging info, or simply stripped of it.
11705 It happens on some GNU/Linux distributions for instance, where
11706 users have to install a separate debug package in order to get
11707 the runtime's debugging info. In that situation, let the user
11708 know why we cannot insert an Ada exception catchpoint.
11710 Note: Just for the purpose of inserting our Ada exception
11711 catchpoint, we could rely purely on the associated minimal symbol.
11712 But we would be operating in degraded mode anyway, since we are
11713 still lacking the debugging info needed later on to extract
11714 the name of the exception being raised (this name is printed in
11715 the catchpoint message, and is also used when trying to catch
11716 a specific exception). We do not handle this case for now. */
11717 struct bound_minimal_symbol msym
11718 = lookup_minimal_symbol (einfo
->catch_exception_sym
, NULL
, NULL
);
11720 if (msym
.minsym
&& MSYMBOL_TYPE (msym
.minsym
) != mst_solib_trampoline
)
11721 error (_("Your Ada runtime appears to be missing some debugging "
11722 "information.\nCannot insert Ada exception catchpoint "
11723 "in this configuration."));
11728 /* Make sure that the symbol we found corresponds to a function. */
11730 if (sym
->aclass () != LOC_BLOCK
)
11732 error (_("Symbol \"%s\" is not a function (class = %d)"),
11733 sym
->linkage_name (), sym
->aclass ());
11737 sym
= standard_lookup (einfo
->catch_handlers_sym
, NULL
, VAR_DOMAIN
);
11740 struct bound_minimal_symbol msym
11741 = lookup_minimal_symbol (einfo
->catch_handlers_sym
, NULL
, NULL
);
11743 if (msym
.minsym
&& MSYMBOL_TYPE (msym
.minsym
) != mst_solib_trampoline
)
11744 error (_("Your Ada runtime appears to be missing some debugging "
11745 "information.\nCannot insert Ada exception catchpoint "
11746 "in this configuration."));
11751 /* Make sure that the symbol we found corresponds to a function. */
11753 if (sym
->aclass () != LOC_BLOCK
)
11755 error (_("Symbol \"%s\" is not a function (class = %d)"),
11756 sym
->linkage_name (), sym
->aclass ());
11763 /* Inspect the Ada runtime and determine which exception info structure
11764 should be used to provide support for exception catchpoints.
11766 This function will always set the per-inferior exception_info,
11767 or raise an error. */
11770 ada_exception_support_info_sniffer (void)
11772 struct ada_inferior_data
*data
= get_ada_inferior_data (current_inferior ());
11774 /* If the exception info is already known, then no need to recompute it. */
11775 if (data
->exception_info
!= NULL
)
11778 /* Check the latest (default) exception support info. */
11779 if (ada_has_this_exception_support (&default_exception_support_info
))
11781 data
->exception_info
= &default_exception_support_info
;
11785 /* Try the v0 exception suport info. */
11786 if (ada_has_this_exception_support (&exception_support_info_v0
))
11788 data
->exception_info
= &exception_support_info_v0
;
11792 /* Try our fallback exception suport info. */
11793 if (ada_has_this_exception_support (&exception_support_info_fallback
))
11795 data
->exception_info
= &exception_support_info_fallback
;
11799 /* Sometimes, it is normal for us to not be able to find the routine
11800 we are looking for. This happens when the program is linked with
11801 the shared version of the GNAT runtime, and the program has not been
11802 started yet. Inform the user of these two possible causes if
11805 if (ada_update_initial_language (language_unknown
) != language_ada
)
11806 error (_("Unable to insert catchpoint. Is this an Ada main program?"));
11808 /* If the symbol does not exist, then check that the program is
11809 already started, to make sure that shared libraries have been
11810 loaded. If it is not started, this may mean that the symbol is
11811 in a shared library. */
11813 if (inferior_ptid
.pid () == 0)
11814 error (_("Unable to insert catchpoint. Try to start the program first."));
11816 /* At this point, we know that we are debugging an Ada program and
11817 that the inferior has been started, but we still are not able to
11818 find the run-time symbols. That can mean that we are in
11819 configurable run time mode, or that a-except as been optimized
11820 out by the linker... In any case, at this point it is not worth
11821 supporting this feature. */
11823 error (_("Cannot insert Ada exception catchpoints in this configuration."));
11826 /* True iff FRAME is very likely to be that of a function that is
11827 part of the runtime system. This is all very heuristic, but is
11828 intended to be used as advice as to what frames are uninteresting
11832 is_known_support_routine (struct frame_info
*frame
)
11834 enum language func_lang
;
11836 const char *fullname
;
11838 /* If this code does not have any debugging information (no symtab),
11839 This cannot be any user code. */
11841 symtab_and_line sal
= find_frame_sal (frame
);
11842 if (sal
.symtab
== NULL
)
11845 /* If there is a symtab, but the associated source file cannot be
11846 located, then assume this is not user code: Selecting a frame
11847 for which we cannot display the code would not be very helpful
11848 for the user. This should also take care of case such as VxWorks
11849 where the kernel has some debugging info provided for a few units. */
11851 fullname
= symtab_to_fullname (sal
.symtab
);
11852 if (access (fullname
, R_OK
) != 0)
11855 /* Check the unit filename against the Ada runtime file naming.
11856 We also check the name of the objfile against the name of some
11857 known system libraries that sometimes come with debugging info
11860 for (i
= 0; known_runtime_file_name_patterns
[i
] != NULL
; i
+= 1)
11862 re_comp (known_runtime_file_name_patterns
[i
]);
11863 if (re_exec (lbasename (sal
.symtab
->filename
)))
11865 if (sal
.symtab
->objfile () != NULL
11866 && re_exec (objfile_name (sal
.symtab
->objfile ())))
11870 /* Check whether the function is a GNAT-generated entity. */
11872 gdb::unique_xmalloc_ptr
<char> func_name
11873 = find_frame_funname (frame
, &func_lang
, NULL
);
11874 if (func_name
== NULL
)
11877 for (i
= 0; known_auxiliary_function_name_patterns
[i
] != NULL
; i
+= 1)
11879 re_comp (known_auxiliary_function_name_patterns
[i
]);
11880 if (re_exec (func_name
.get ()))
11887 /* Find the first frame that contains debugging information and that is not
11888 part of the Ada run-time, starting from FI and moving upward. */
11891 ada_find_printable_frame (struct frame_info
*fi
)
11893 for (; fi
!= NULL
; fi
= get_prev_frame (fi
))
11895 if (!is_known_support_routine (fi
))
11904 /* Assuming that the inferior just triggered an unhandled exception
11905 catchpoint, return the address in inferior memory where the name
11906 of the exception is stored.
11908 Return zero if the address could not be computed. */
11911 ada_unhandled_exception_name_addr (void)
11913 return parse_and_eval_address ("e.full_name");
11916 /* Same as ada_unhandled_exception_name_addr, except that this function
11917 should be used when the inferior uses an older version of the runtime,
11918 where the exception name needs to be extracted from a specific frame
11919 several frames up in the callstack. */
11922 ada_unhandled_exception_name_addr_from_raise (void)
11925 struct frame_info
*fi
;
11926 struct ada_inferior_data
*data
= get_ada_inferior_data (current_inferior ());
11928 /* To determine the name of this exception, we need to select
11929 the frame corresponding to RAISE_SYM_NAME. This frame is
11930 at least 3 levels up, so we simply skip the first 3 frames
11931 without checking the name of their associated function. */
11932 fi
= get_current_frame ();
11933 for (frame_level
= 0; frame_level
< 3; frame_level
+= 1)
11935 fi
= get_prev_frame (fi
);
11939 enum language func_lang
;
11941 gdb::unique_xmalloc_ptr
<char> func_name
11942 = find_frame_funname (fi
, &func_lang
, NULL
);
11943 if (func_name
!= NULL
)
11945 if (strcmp (func_name
.get (),
11946 data
->exception_info
->catch_exception_sym
) == 0)
11947 break; /* We found the frame we were looking for... */
11949 fi
= get_prev_frame (fi
);
11956 return parse_and_eval_address ("id.full_name");
11959 /* Assuming the inferior just triggered an Ada exception catchpoint
11960 (of any type), return the address in inferior memory where the name
11961 of the exception is stored, if applicable.
11963 Assumes the selected frame is the current frame.
11965 Return zero if the address could not be computed, or if not relevant. */
11968 ada_exception_name_addr_1 (enum ada_exception_catchpoint_kind ex
,
11969 struct breakpoint
*b
)
11971 struct ada_inferior_data
*data
= get_ada_inferior_data (current_inferior ());
11975 case ada_catch_exception
:
11976 return (parse_and_eval_address ("e.full_name"));
11979 case ada_catch_exception_unhandled
:
11980 return data
->exception_info
->unhandled_exception_name_addr ();
11983 case ada_catch_handlers
:
11984 return 0; /* The runtimes does not provide access to the exception
11988 case ada_catch_assert
:
11989 return 0; /* Exception name is not relevant in this case. */
11993 internal_error (__FILE__
, __LINE__
, _("unexpected catchpoint type"));
11997 return 0; /* Should never be reached. */
12000 /* Assuming the inferior is stopped at an exception catchpoint,
12001 return the message which was associated to the exception, if
12002 available. Return NULL if the message could not be retrieved.
12004 Note: The exception message can be associated to an exception
12005 either through the use of the Raise_Exception function, or
12006 more simply (Ada 2005 and later), via:
12008 raise Exception_Name with "exception message";
12012 static gdb::unique_xmalloc_ptr
<char>
12013 ada_exception_message_1 (void)
12015 struct value
*e_msg_val
;
12018 /* For runtimes that support this feature, the exception message
12019 is passed as an unbounded string argument called "message". */
12020 e_msg_val
= parse_and_eval ("message");
12021 if (e_msg_val
== NULL
)
12022 return NULL
; /* Exception message not supported. */
12024 e_msg_val
= ada_coerce_to_simple_array (e_msg_val
);
12025 gdb_assert (e_msg_val
!= NULL
);
12026 e_msg_len
= TYPE_LENGTH (value_type (e_msg_val
));
12028 /* If the message string is empty, then treat it as if there was
12029 no exception message. */
12030 if (e_msg_len
<= 0)
12033 gdb::unique_xmalloc_ptr
<char> e_msg ((char *) xmalloc (e_msg_len
+ 1));
12034 read_memory (value_address (e_msg_val
), (gdb_byte
*) e_msg
.get (),
12036 e_msg
.get ()[e_msg_len
] = '\0';
12041 /* Same as ada_exception_message_1, except that all exceptions are
12042 contained here (returning NULL instead). */
12044 static gdb::unique_xmalloc_ptr
<char>
12045 ada_exception_message (void)
12047 gdb::unique_xmalloc_ptr
<char> e_msg
;
12051 e_msg
= ada_exception_message_1 ();
12053 catch (const gdb_exception_error
&e
)
12055 e_msg
.reset (nullptr);
12061 /* Same as ada_exception_name_addr_1, except that it intercepts and contains
12062 any error that ada_exception_name_addr_1 might cause to be thrown.
12063 When an error is intercepted, a warning with the error message is printed,
12064 and zero is returned. */
12067 ada_exception_name_addr (enum ada_exception_catchpoint_kind ex
,
12068 struct breakpoint
*b
)
12070 CORE_ADDR result
= 0;
12074 result
= ada_exception_name_addr_1 (ex
, b
);
12077 catch (const gdb_exception_error
&e
)
12079 warning (_("failed to get exception name: %s"), e
.what ());
12086 static std::string ada_exception_catchpoint_cond_string
12087 (const char *excep_string
,
12088 enum ada_exception_catchpoint_kind ex
);
12090 /* Ada catchpoints.
12092 In the case of catchpoints on Ada exceptions, the catchpoint will
12093 stop the target on every exception the program throws. When a user
12094 specifies the name of a specific exception, we translate this
12095 request into a condition expression (in text form), and then parse
12096 it into an expression stored in each of the catchpoint's locations.
12097 We then use this condition to check whether the exception that was
12098 raised is the one the user is interested in. If not, then the
12099 target is resumed again. We store the name of the requested
12100 exception, in order to be able to re-set the condition expression
12101 when symbols change. */
12103 /* An instance of this type is used to represent an Ada catchpoint
12104 breakpoint location. */
12106 class ada_catchpoint_location
: public bp_location
12109 ada_catchpoint_location (breakpoint
*owner
)
12110 : bp_location (owner
, bp_loc_software_breakpoint
)
12113 /* The condition that checks whether the exception that was raised
12114 is the specific exception the user specified on catchpoint
12116 expression_up excep_cond_expr
;
12119 /* An instance of this type is used to represent an Ada catchpoint. */
12121 struct ada_catchpoint
: public breakpoint
12123 explicit ada_catchpoint (enum ada_exception_catchpoint_kind kind
)
12128 /* The name of the specific exception the user specified. */
12129 std::string excep_string
;
12131 /* What kind of catchpoint this is. */
12132 enum ada_exception_catchpoint_kind m_kind
;
12135 /* Parse the exception condition string in the context of each of the
12136 catchpoint's locations, and store them for later evaluation. */
12139 create_excep_cond_exprs (struct ada_catchpoint
*c
,
12140 enum ada_exception_catchpoint_kind ex
)
12142 /* Nothing to do if there's no specific exception to catch. */
12143 if (c
->excep_string
.empty ())
12146 /* Same if there are no locations... */
12147 if (c
->loc
== NULL
)
12150 /* Compute the condition expression in text form, from the specific
12151 expection we want to catch. */
12152 std::string cond_string
12153 = ada_exception_catchpoint_cond_string (c
->excep_string
.c_str (), ex
);
12155 /* Iterate over all the catchpoint's locations, and parse an
12156 expression for each. */
12157 for (bp_location
*bl
: c
->locations ())
12159 struct ada_catchpoint_location
*ada_loc
12160 = (struct ada_catchpoint_location
*) bl
;
12163 if (!bl
->shlib_disabled
)
12167 s
= cond_string
.c_str ();
12170 exp
= parse_exp_1 (&s
, bl
->address
,
12171 block_for_pc (bl
->address
),
12174 catch (const gdb_exception_error
&e
)
12176 warning (_("failed to reevaluate internal exception condition "
12177 "for catchpoint %d: %s"),
12178 c
->number
, e
.what ());
12182 ada_loc
->excep_cond_expr
= std::move (exp
);
12186 /* Implement the ALLOCATE_LOCATION method in the breakpoint_ops
12187 structure for all exception catchpoint kinds. */
12189 static struct bp_location
*
12190 allocate_location_exception (struct breakpoint
*self
)
12192 return new ada_catchpoint_location (self
);
12195 /* Implement the RE_SET method in the breakpoint_ops structure for all
12196 exception catchpoint kinds. */
12199 re_set_exception (struct breakpoint
*b
)
12201 struct ada_catchpoint
*c
= (struct ada_catchpoint
*) b
;
12203 /* Call the base class's method. This updates the catchpoint's
12205 bkpt_breakpoint_ops
.re_set (b
);
12207 /* Reparse the exception conditional expressions. One for each
12209 create_excep_cond_exprs (c
, c
->m_kind
);
12212 /* Returns true if we should stop for this breakpoint hit. If the
12213 user specified a specific exception, we only want to cause a stop
12214 if the program thrown that exception. */
12217 should_stop_exception (const struct bp_location
*bl
)
12219 struct ada_catchpoint
*c
= (struct ada_catchpoint
*) bl
->owner
;
12220 const struct ada_catchpoint_location
*ada_loc
12221 = (const struct ada_catchpoint_location
*) bl
;
12224 struct internalvar
*var
= lookup_internalvar ("_ada_exception");
12225 if (c
->m_kind
== ada_catch_assert
)
12226 clear_internalvar (var
);
12233 if (c
->m_kind
== ada_catch_handlers
)
12234 expr
= ("GNAT_GCC_exception_Access(gcc_exception)"
12235 ".all.occurrence.id");
12239 struct value
*exc
= parse_and_eval (expr
);
12240 set_internalvar (var
, exc
);
12242 catch (const gdb_exception_error
&ex
)
12244 clear_internalvar (var
);
12248 /* With no specific exception, should always stop. */
12249 if (c
->excep_string
.empty ())
12252 if (ada_loc
->excep_cond_expr
== NULL
)
12254 /* We will have a NULL expression if back when we were creating
12255 the expressions, this location's had failed to parse. */
12262 struct value
*mark
;
12264 mark
= value_mark ();
12265 stop
= value_true (evaluate_expression (ada_loc
->excep_cond_expr
.get ()));
12266 value_free_to_mark (mark
);
12268 catch (const gdb_exception
&ex
)
12270 exception_fprintf (gdb_stderr
, ex
,
12271 _("Error in testing exception condition:\n"));
12277 /* Implement the CHECK_STATUS method in the breakpoint_ops structure
12278 for all exception catchpoint kinds. */
12281 check_status_exception (bpstat
*bs
)
12283 bs
->stop
= should_stop_exception (bs
->bp_location_at
.get ());
12286 /* Implement the PRINT_IT method in the breakpoint_ops structure
12287 for all exception catchpoint kinds. */
12289 static enum print_stop_action
12290 print_it_exception (bpstat
*bs
)
12292 struct ui_out
*uiout
= current_uiout
;
12293 struct breakpoint
*b
= bs
->breakpoint_at
;
12295 annotate_catchpoint (b
->number
);
12297 if (uiout
->is_mi_like_p ())
12299 uiout
->field_string ("reason",
12300 async_reason_lookup (EXEC_ASYNC_BREAKPOINT_HIT
));
12301 uiout
->field_string ("disp", bpdisp_text (b
->disposition
));
12304 uiout
->text (b
->disposition
== disp_del
12305 ? "\nTemporary catchpoint " : "\nCatchpoint ");
12306 uiout
->field_signed ("bkptno", b
->number
);
12307 uiout
->text (", ");
12309 /* ada_exception_name_addr relies on the selected frame being the
12310 current frame. Need to do this here because this function may be
12311 called more than once when printing a stop, and below, we'll
12312 select the first frame past the Ada run-time (see
12313 ada_find_printable_frame). */
12314 select_frame (get_current_frame ());
12316 struct ada_catchpoint
*c
= (struct ada_catchpoint
*) b
;
12319 case ada_catch_exception
:
12320 case ada_catch_exception_unhandled
:
12321 case ada_catch_handlers
:
12323 const CORE_ADDR addr
= ada_exception_name_addr (c
->m_kind
, b
);
12324 char exception_name
[256];
12328 read_memory (addr
, (gdb_byte
*) exception_name
,
12329 sizeof (exception_name
) - 1);
12330 exception_name
[sizeof (exception_name
) - 1] = '\0';
12334 /* For some reason, we were unable to read the exception
12335 name. This could happen if the Runtime was compiled
12336 without debugging info, for instance. In that case,
12337 just replace the exception name by the generic string
12338 "exception" - it will read as "an exception" in the
12339 notification we are about to print. */
12340 memcpy (exception_name
, "exception", sizeof ("exception"));
12342 /* In the case of unhandled exception breakpoints, we print
12343 the exception name as "unhandled EXCEPTION_NAME", to make
12344 it clearer to the user which kind of catchpoint just got
12345 hit. We used ui_out_text to make sure that this extra
12346 info does not pollute the exception name in the MI case. */
12347 if (c
->m_kind
== ada_catch_exception_unhandled
)
12348 uiout
->text ("unhandled ");
12349 uiout
->field_string ("exception-name", exception_name
);
12352 case ada_catch_assert
:
12353 /* In this case, the name of the exception is not really
12354 important. Just print "failed assertion" to make it clearer
12355 that his program just hit an assertion-failure catchpoint.
12356 We used ui_out_text because this info does not belong in
12358 uiout
->text ("failed assertion");
12362 gdb::unique_xmalloc_ptr
<char> exception_message
= ada_exception_message ();
12363 if (exception_message
!= NULL
)
12365 uiout
->text (" (");
12366 uiout
->field_string ("exception-message", exception_message
.get ());
12370 uiout
->text (" at ");
12371 ada_find_printable_frame (get_current_frame ());
12373 return PRINT_SRC_AND_LOC
;
12376 /* Implement the PRINT_ONE method in the breakpoint_ops structure
12377 for all exception catchpoint kinds. */
12380 print_one_exception (struct breakpoint
*b
, struct bp_location
**last_loc
)
12382 struct ui_out
*uiout
= current_uiout
;
12383 struct ada_catchpoint
*c
= (struct ada_catchpoint
*) b
;
12384 struct value_print_options opts
;
12386 get_user_print_options (&opts
);
12388 if (opts
.addressprint
)
12389 uiout
->field_skip ("addr");
12391 annotate_field (5);
12394 case ada_catch_exception
:
12395 if (!c
->excep_string
.empty ())
12397 std::string msg
= string_printf (_("`%s' Ada exception"),
12398 c
->excep_string
.c_str ());
12400 uiout
->field_string ("what", msg
);
12403 uiout
->field_string ("what", "all Ada exceptions");
12407 case ada_catch_exception_unhandled
:
12408 uiout
->field_string ("what", "unhandled Ada exceptions");
12411 case ada_catch_handlers
:
12412 if (!c
->excep_string
.empty ())
12414 uiout
->field_fmt ("what",
12415 _("`%s' Ada exception handlers"),
12416 c
->excep_string
.c_str ());
12419 uiout
->field_string ("what", "all Ada exceptions handlers");
12422 case ada_catch_assert
:
12423 uiout
->field_string ("what", "failed Ada assertions");
12427 internal_error (__FILE__
, __LINE__
, _("unexpected catchpoint type"));
12432 /* Implement the PRINT_MENTION method in the breakpoint_ops structure
12433 for all exception catchpoint kinds. */
12436 print_mention_exception (struct breakpoint
*b
)
12438 struct ada_catchpoint
*c
= (struct ada_catchpoint
*) b
;
12439 struct ui_out
*uiout
= current_uiout
;
12441 uiout
->text (b
->disposition
== disp_del
? _("Temporary catchpoint ")
12442 : _("Catchpoint "));
12443 uiout
->field_signed ("bkptno", b
->number
);
12444 uiout
->text (": ");
12448 case ada_catch_exception
:
12449 if (!c
->excep_string
.empty ())
12451 std::string info
= string_printf (_("`%s' Ada exception"),
12452 c
->excep_string
.c_str ());
12453 uiout
->text (info
);
12456 uiout
->text (_("all Ada exceptions"));
12459 case ada_catch_exception_unhandled
:
12460 uiout
->text (_("unhandled Ada exceptions"));
12463 case ada_catch_handlers
:
12464 if (!c
->excep_string
.empty ())
12467 = string_printf (_("`%s' Ada exception handlers"),
12468 c
->excep_string
.c_str ());
12469 uiout
->text (info
);
12472 uiout
->text (_("all Ada exceptions handlers"));
12475 case ada_catch_assert
:
12476 uiout
->text (_("failed Ada assertions"));
12480 internal_error (__FILE__
, __LINE__
, _("unexpected catchpoint type"));
12485 /* Implement the PRINT_RECREATE method in the breakpoint_ops structure
12486 for all exception catchpoint kinds. */
12489 print_recreate_exception (struct breakpoint
*b
, struct ui_file
*fp
)
12491 struct ada_catchpoint
*c
= (struct ada_catchpoint
*) b
;
12495 case ada_catch_exception
:
12496 gdb_printf (fp
, "catch exception");
12497 if (!c
->excep_string
.empty ())
12498 gdb_printf (fp
, " %s", c
->excep_string
.c_str ());
12501 case ada_catch_exception_unhandled
:
12502 gdb_printf (fp
, "catch exception unhandled");
12505 case ada_catch_handlers
:
12506 gdb_printf (fp
, "catch handlers");
12509 case ada_catch_assert
:
12510 gdb_printf (fp
, "catch assert");
12514 internal_error (__FILE__
, __LINE__
, _("unexpected catchpoint type"));
12516 print_recreate_thread (b
, fp
);
12519 /* Virtual table for breakpoint type. */
12520 static struct breakpoint_ops catch_exception_breakpoint_ops
;
12522 /* See ada-lang.h. */
12525 is_ada_exception_catchpoint (breakpoint
*bp
)
12527 return bp
->ops
== &catch_exception_breakpoint_ops
;
12530 /* Split the arguments specified in a "catch exception" command.
12531 Set EX to the appropriate catchpoint type.
12532 Set EXCEP_STRING to the name of the specific exception if
12533 specified by the user.
12534 IS_CATCH_HANDLERS_CMD: True if the arguments are for a
12535 "catch handlers" command. False otherwise.
12536 If a condition is found at the end of the arguments, the condition
12537 expression is stored in COND_STRING (memory must be deallocated
12538 after use). Otherwise COND_STRING is set to NULL. */
12541 catch_ada_exception_command_split (const char *args
,
12542 bool is_catch_handlers_cmd
,
12543 enum ada_exception_catchpoint_kind
*ex
,
12544 std::string
*excep_string
,
12545 std::string
*cond_string
)
12547 std::string exception_name
;
12549 exception_name
= extract_arg (&args
);
12550 if (exception_name
== "if")
12552 /* This is not an exception name; this is the start of a condition
12553 expression for a catchpoint on all exceptions. So, "un-get"
12554 this token, and set exception_name to NULL. */
12555 exception_name
.clear ();
12559 /* Check to see if we have a condition. */
12561 args
= skip_spaces (args
);
12562 if (startswith (args
, "if")
12563 && (isspace (args
[2]) || args
[2] == '\0'))
12566 args
= skip_spaces (args
);
12568 if (args
[0] == '\0')
12569 error (_("Condition missing after `if' keyword"));
12570 *cond_string
= args
;
12572 args
+= strlen (args
);
12575 /* Check that we do not have any more arguments. Anything else
12578 if (args
[0] != '\0')
12579 error (_("Junk at end of expression"));
12581 if (is_catch_handlers_cmd
)
12583 /* Catch handling of exceptions. */
12584 *ex
= ada_catch_handlers
;
12585 *excep_string
= exception_name
;
12587 else if (exception_name
.empty ())
12589 /* Catch all exceptions. */
12590 *ex
= ada_catch_exception
;
12591 excep_string
->clear ();
12593 else if (exception_name
== "unhandled")
12595 /* Catch unhandled exceptions. */
12596 *ex
= ada_catch_exception_unhandled
;
12597 excep_string
->clear ();
12601 /* Catch a specific exception. */
12602 *ex
= ada_catch_exception
;
12603 *excep_string
= exception_name
;
12607 /* Return the name of the symbol on which we should break in order to
12608 implement a catchpoint of the EX kind. */
12610 static const char *
12611 ada_exception_sym_name (enum ada_exception_catchpoint_kind ex
)
12613 struct ada_inferior_data
*data
= get_ada_inferior_data (current_inferior ());
12615 gdb_assert (data
->exception_info
!= NULL
);
12619 case ada_catch_exception
:
12620 return (data
->exception_info
->catch_exception_sym
);
12622 case ada_catch_exception_unhandled
:
12623 return (data
->exception_info
->catch_exception_unhandled_sym
);
12625 case ada_catch_assert
:
12626 return (data
->exception_info
->catch_assert_sym
);
12628 case ada_catch_handlers
:
12629 return (data
->exception_info
->catch_handlers_sym
);
12632 internal_error (__FILE__
, __LINE__
,
12633 _("unexpected catchpoint kind (%d)"), ex
);
12637 /* Return the condition that will be used to match the current exception
12638 being raised with the exception that the user wants to catch. This
12639 assumes that this condition is used when the inferior just triggered
12640 an exception catchpoint.
12641 EX: the type of catchpoints used for catching Ada exceptions. */
12644 ada_exception_catchpoint_cond_string (const char *excep_string
,
12645 enum ada_exception_catchpoint_kind ex
)
12647 bool is_standard_exc
= false;
12648 std::string result
;
12650 if (ex
== ada_catch_handlers
)
12652 /* For exception handlers catchpoints, the condition string does
12653 not use the same parameter as for the other exceptions. */
12654 result
= ("long_integer (GNAT_GCC_exception_Access"
12655 "(gcc_exception).all.occurrence.id)");
12658 result
= "long_integer (e)";
12660 /* The standard exceptions are a special case. They are defined in
12661 runtime units that have been compiled without debugging info; if
12662 EXCEP_STRING is the not-fully-qualified name of a standard
12663 exception (e.g. "constraint_error") then, during the evaluation
12664 of the condition expression, the symbol lookup on this name would
12665 *not* return this standard exception. The catchpoint condition
12666 may then be set only on user-defined exceptions which have the
12667 same not-fully-qualified name (e.g. my_package.constraint_error).
12669 To avoid this unexcepted behavior, these standard exceptions are
12670 systematically prefixed by "standard". This means that "catch
12671 exception constraint_error" is rewritten into "catch exception
12672 standard.constraint_error".
12674 If an exception named constraint_error is defined in another package of
12675 the inferior program, then the only way to specify this exception as a
12676 breakpoint condition is to use its fully-qualified named:
12677 e.g. my_package.constraint_error. */
12679 for (const char *name
: standard_exc
)
12681 if (strcmp (name
, excep_string
) == 0)
12683 is_standard_exc
= true;
12690 if (is_standard_exc
)
12691 string_appendf (result
, "long_integer (&standard.%s)", excep_string
);
12693 string_appendf (result
, "long_integer (&%s)", excep_string
);
12698 /* Return the symtab_and_line that should be used to insert an exception
12699 catchpoint of the TYPE kind.
12701 ADDR_STRING returns the name of the function where the real
12702 breakpoint that implements the catchpoints is set, depending on the
12703 type of catchpoint we need to create. */
12705 static struct symtab_and_line
12706 ada_exception_sal (enum ada_exception_catchpoint_kind ex
,
12707 std::string
*addr_string
, const struct breakpoint_ops
**ops
)
12709 const char *sym_name
;
12710 struct symbol
*sym
;
12712 /* First, find out which exception support info to use. */
12713 ada_exception_support_info_sniffer ();
12715 /* Then lookup the function on which we will break in order to catch
12716 the Ada exceptions requested by the user. */
12717 sym_name
= ada_exception_sym_name (ex
);
12718 sym
= standard_lookup (sym_name
, NULL
, VAR_DOMAIN
);
12721 error (_("Catchpoint symbol not found: %s"), sym_name
);
12723 if (sym
->aclass () != LOC_BLOCK
)
12724 error (_("Unable to insert catchpoint. %s is not a function."), sym_name
);
12726 /* Set ADDR_STRING. */
12727 *addr_string
= sym_name
;
12730 *ops
= &catch_exception_breakpoint_ops
;
12732 return find_function_start_sal (sym
, 1);
12735 /* Create an Ada exception catchpoint.
12737 EX_KIND is the kind of exception catchpoint to be created.
12739 If EXCEPT_STRING is empty, this catchpoint is expected to trigger
12740 for all exceptions. Otherwise, EXCEPT_STRING indicates the name
12741 of the exception to which this catchpoint applies.
12743 COND_STRING, if not empty, is the catchpoint condition.
12745 TEMPFLAG, if nonzero, means that the underlying breakpoint
12746 should be temporary.
12748 FROM_TTY is the usual argument passed to all commands implementations. */
12751 create_ada_exception_catchpoint (struct gdbarch
*gdbarch
,
12752 enum ada_exception_catchpoint_kind ex_kind
,
12753 const std::string
&excep_string
,
12754 const std::string
&cond_string
,
12759 std::string addr_string
;
12760 const struct breakpoint_ops
*ops
= NULL
;
12761 struct symtab_and_line sal
= ada_exception_sal (ex_kind
, &addr_string
, &ops
);
12763 std::unique_ptr
<ada_catchpoint
> c (new ada_catchpoint (ex_kind
));
12764 init_ada_exception_breakpoint (c
.get (), gdbarch
, sal
, addr_string
.c_str (),
12765 ops
, tempflag
, disabled
, from_tty
);
12766 c
->excep_string
= excep_string
;
12767 create_excep_cond_exprs (c
.get (), ex_kind
);
12768 if (!cond_string
.empty ())
12769 set_breakpoint_condition (c
.get (), cond_string
.c_str (), from_tty
, false);
12770 install_breakpoint (0, std::move (c
), 1);
12773 /* Implement the "catch exception" command. */
12776 catch_ada_exception_command (const char *arg_entry
, int from_tty
,
12777 struct cmd_list_element
*command
)
12779 const char *arg
= arg_entry
;
12780 struct gdbarch
*gdbarch
= get_current_arch ();
12782 enum ada_exception_catchpoint_kind ex_kind
;
12783 std::string excep_string
;
12784 std::string cond_string
;
12786 tempflag
= command
->context () == CATCH_TEMPORARY
;
12790 catch_ada_exception_command_split (arg
, false, &ex_kind
, &excep_string
,
12792 create_ada_exception_catchpoint (gdbarch
, ex_kind
,
12793 excep_string
, cond_string
,
12794 tempflag
, 1 /* enabled */,
12798 /* Implement the "catch handlers" command. */
12801 catch_ada_handlers_command (const char *arg_entry
, int from_tty
,
12802 struct cmd_list_element
*command
)
12804 const char *arg
= arg_entry
;
12805 struct gdbarch
*gdbarch
= get_current_arch ();
12807 enum ada_exception_catchpoint_kind ex_kind
;
12808 std::string excep_string
;
12809 std::string cond_string
;
12811 tempflag
= command
->context () == CATCH_TEMPORARY
;
12815 catch_ada_exception_command_split (arg
, true, &ex_kind
, &excep_string
,
12817 create_ada_exception_catchpoint (gdbarch
, ex_kind
,
12818 excep_string
, cond_string
,
12819 tempflag
, 1 /* enabled */,
12823 /* Completion function for the Ada "catch" commands. */
12826 catch_ada_completer (struct cmd_list_element
*cmd
, completion_tracker
&tracker
,
12827 const char *text
, const char *word
)
12829 std::vector
<ada_exc_info
> exceptions
= ada_exceptions_list (NULL
);
12831 for (const ada_exc_info
&info
: exceptions
)
12833 if (startswith (info
.name
, word
))
12834 tracker
.add_completion (make_unique_xstrdup (info
.name
));
12838 /* Split the arguments specified in a "catch assert" command.
12840 ARGS contains the command's arguments (or the empty string if
12841 no arguments were passed).
12843 If ARGS contains a condition, set COND_STRING to that condition
12844 (the memory needs to be deallocated after use). */
12847 catch_ada_assert_command_split (const char *args
, std::string
&cond_string
)
12849 args
= skip_spaces (args
);
12851 /* Check whether a condition was provided. */
12852 if (startswith (args
, "if")
12853 && (isspace (args
[2]) || args
[2] == '\0'))
12856 args
= skip_spaces (args
);
12857 if (args
[0] == '\0')
12858 error (_("condition missing after `if' keyword"));
12859 cond_string
.assign (args
);
12862 /* Otherwise, there should be no other argument at the end of
12864 else if (args
[0] != '\0')
12865 error (_("Junk at end of arguments."));
12868 /* Implement the "catch assert" command. */
12871 catch_assert_command (const char *arg_entry
, int from_tty
,
12872 struct cmd_list_element
*command
)
12874 const char *arg
= arg_entry
;
12875 struct gdbarch
*gdbarch
= get_current_arch ();
12877 std::string cond_string
;
12879 tempflag
= command
->context () == CATCH_TEMPORARY
;
12883 catch_ada_assert_command_split (arg
, cond_string
);
12884 create_ada_exception_catchpoint (gdbarch
, ada_catch_assert
,
12886 tempflag
, 1 /* enabled */,
12890 /* Return non-zero if the symbol SYM is an Ada exception object. */
12893 ada_is_exception_sym (struct symbol
*sym
)
12895 const char *type_name
= sym
->type ()->name ();
12897 return (sym
->aclass () != LOC_TYPEDEF
12898 && sym
->aclass () != LOC_BLOCK
12899 && sym
->aclass () != LOC_CONST
12900 && sym
->aclass () != LOC_UNRESOLVED
12901 && type_name
!= NULL
&& strcmp (type_name
, "exception") == 0);
12904 /* Given a global symbol SYM, return non-zero iff SYM is a non-standard
12905 Ada exception object. This matches all exceptions except the ones
12906 defined by the Ada language. */
12909 ada_is_non_standard_exception_sym (struct symbol
*sym
)
12911 if (!ada_is_exception_sym (sym
))
12914 for (const char *name
: standard_exc
)
12915 if (strcmp (sym
->linkage_name (), name
) == 0)
12916 return 0; /* A standard exception. */
12918 /* Numeric_Error is also a standard exception, so exclude it.
12919 See the STANDARD_EXC description for more details as to why
12920 this exception is not listed in that array. */
12921 if (strcmp (sym
->linkage_name (), "numeric_error") == 0)
12927 /* A helper function for std::sort, comparing two struct ada_exc_info
12930 The comparison is determined first by exception name, and then
12931 by exception address. */
12934 ada_exc_info::operator< (const ada_exc_info
&other
) const
12938 result
= strcmp (name
, other
.name
);
12941 if (result
== 0 && addr
< other
.addr
)
12947 ada_exc_info::operator== (const ada_exc_info
&other
) const
12949 return addr
== other
.addr
&& strcmp (name
, other
.name
) == 0;
12952 /* Sort EXCEPTIONS using compare_ada_exception_info as the comparison
12953 routine, but keeping the first SKIP elements untouched.
12955 All duplicates are also removed. */
12958 sort_remove_dups_ada_exceptions_list (std::vector
<ada_exc_info
> *exceptions
,
12961 std::sort (exceptions
->begin () + skip
, exceptions
->end ());
12962 exceptions
->erase (std::unique (exceptions
->begin () + skip
, exceptions
->end ()),
12963 exceptions
->end ());
12966 /* Add all exceptions defined by the Ada standard whose name match
12967 a regular expression.
12969 If PREG is not NULL, then this regexp_t object is used to
12970 perform the symbol name matching. Otherwise, no name-based
12971 filtering is performed.
12973 EXCEPTIONS is a vector of exceptions to which matching exceptions
12977 ada_add_standard_exceptions (compiled_regex
*preg
,
12978 std::vector
<ada_exc_info
> *exceptions
)
12980 for (const char *name
: standard_exc
)
12982 if (preg
== NULL
|| preg
->exec (name
, 0, NULL
, 0) == 0)
12984 struct bound_minimal_symbol msymbol
12985 = ada_lookup_simple_minsym (name
);
12987 if (msymbol
.minsym
!= NULL
)
12989 struct ada_exc_info info
12990 = {name
, BMSYMBOL_VALUE_ADDRESS (msymbol
)};
12992 exceptions
->push_back (info
);
12998 /* Add all Ada exceptions defined locally and accessible from the given
13001 If PREG is not NULL, then this regexp_t object is used to
13002 perform the symbol name matching. Otherwise, no name-based
13003 filtering is performed.
13005 EXCEPTIONS is a vector of exceptions to which matching exceptions
13009 ada_add_exceptions_from_frame (compiled_regex
*preg
,
13010 struct frame_info
*frame
,
13011 std::vector
<ada_exc_info
> *exceptions
)
13013 const struct block
*block
= get_frame_block (frame
, 0);
13017 struct block_iterator iter
;
13018 struct symbol
*sym
;
13020 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
13022 switch (sym
->aclass ())
13029 if (ada_is_exception_sym (sym
))
13031 struct ada_exc_info info
= {sym
->print_name (),
13032 SYMBOL_VALUE_ADDRESS (sym
)};
13034 exceptions
->push_back (info
);
13038 if (BLOCK_FUNCTION (block
) != NULL
)
13040 block
= BLOCK_SUPERBLOCK (block
);
13044 /* Return true if NAME matches PREG or if PREG is NULL. */
13047 name_matches_regex (const char *name
, compiled_regex
*preg
)
13049 return (preg
== NULL
13050 || preg
->exec (ada_decode (name
).c_str (), 0, NULL
, 0) == 0);
13053 /* Add all exceptions defined globally whose name name match
13054 a regular expression, excluding standard exceptions.
13056 The reason we exclude standard exceptions is that they need
13057 to be handled separately: Standard exceptions are defined inside
13058 a runtime unit which is normally not compiled with debugging info,
13059 and thus usually do not show up in our symbol search. However,
13060 if the unit was in fact built with debugging info, we need to
13061 exclude them because they would duplicate the entry we found
13062 during the special loop that specifically searches for those
13063 standard exceptions.
13065 If PREG is not NULL, then this regexp_t object is used to
13066 perform the symbol name matching. Otherwise, no name-based
13067 filtering is performed.
13069 EXCEPTIONS is a vector of exceptions to which matching exceptions
13073 ada_add_global_exceptions (compiled_regex
*preg
,
13074 std::vector
<ada_exc_info
> *exceptions
)
13076 /* In Ada, the symbol "search name" is a linkage name, whereas the
13077 regular expression used to do the matching refers to the natural
13078 name. So match against the decoded name. */
13079 expand_symtabs_matching (NULL
,
13080 lookup_name_info::match_any (),
13081 [&] (const char *search_name
)
13083 std::string decoded
= ada_decode (search_name
);
13084 return name_matches_regex (decoded
.c_str (), preg
);
13087 SEARCH_GLOBAL_BLOCK
| SEARCH_STATIC_BLOCK
,
13090 for (objfile
*objfile
: current_program_space
->objfiles ())
13092 for (compunit_symtab
*s
: objfile
->compunits ())
13094 const struct blockvector
*bv
= s
->blockvector ();
13097 for (i
= GLOBAL_BLOCK
; i
<= STATIC_BLOCK
; i
++)
13099 const struct block
*b
= BLOCKVECTOR_BLOCK (bv
, i
);
13100 struct block_iterator iter
;
13101 struct symbol
*sym
;
13103 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
13104 if (ada_is_non_standard_exception_sym (sym
)
13105 && name_matches_regex (sym
->natural_name (), preg
))
13107 struct ada_exc_info info
13108 = {sym
->print_name (), SYMBOL_VALUE_ADDRESS (sym
)};
13110 exceptions
->push_back (info
);
13117 /* Implements ada_exceptions_list with the regular expression passed
13118 as a regex_t, rather than a string.
13120 If not NULL, PREG is used to filter out exceptions whose names
13121 do not match. Otherwise, all exceptions are listed. */
13123 static std::vector
<ada_exc_info
>
13124 ada_exceptions_list_1 (compiled_regex
*preg
)
13126 std::vector
<ada_exc_info
> result
;
13129 /* First, list the known standard exceptions. These exceptions
13130 need to be handled separately, as they are usually defined in
13131 runtime units that have been compiled without debugging info. */
13133 ada_add_standard_exceptions (preg
, &result
);
13135 /* Next, find all exceptions whose scope is local and accessible
13136 from the currently selected frame. */
13138 if (has_stack_frames ())
13140 prev_len
= result
.size ();
13141 ada_add_exceptions_from_frame (preg
, get_selected_frame (NULL
),
13143 if (result
.size () > prev_len
)
13144 sort_remove_dups_ada_exceptions_list (&result
, prev_len
);
13147 /* Add all exceptions whose scope is global. */
13149 prev_len
= result
.size ();
13150 ada_add_global_exceptions (preg
, &result
);
13151 if (result
.size () > prev_len
)
13152 sort_remove_dups_ada_exceptions_list (&result
, prev_len
);
13157 /* Return a vector of ada_exc_info.
13159 If REGEXP is NULL, all exceptions are included in the result.
13160 Otherwise, it should contain a valid regular expression,
13161 and only the exceptions whose names match that regular expression
13162 are included in the result.
13164 The exceptions are sorted in the following order:
13165 - Standard exceptions (defined by the Ada language), in
13166 alphabetical order;
13167 - Exceptions only visible from the current frame, in
13168 alphabetical order;
13169 - Exceptions whose scope is global, in alphabetical order. */
13171 std::vector
<ada_exc_info
>
13172 ada_exceptions_list (const char *regexp
)
13174 if (regexp
== NULL
)
13175 return ada_exceptions_list_1 (NULL
);
13177 compiled_regex
reg (regexp
, REG_NOSUB
, _("invalid regular expression"));
13178 return ada_exceptions_list_1 (®
);
13181 /* Implement the "info exceptions" command. */
13184 info_exceptions_command (const char *regexp
, int from_tty
)
13186 struct gdbarch
*gdbarch
= get_current_arch ();
13188 std::vector
<ada_exc_info
> exceptions
= ada_exceptions_list (regexp
);
13190 if (regexp
!= NULL
)
13192 (_("All Ada exceptions matching regular expression \"%s\":\n"), regexp
);
13194 gdb_printf (_("All defined Ada exceptions:\n"));
13196 for (const ada_exc_info
&info
: exceptions
)
13197 gdb_printf ("%s: %s\n", info
.name
, paddress (gdbarch
, info
.addr
));
13201 /* Language vector */
13203 /* symbol_name_matcher_ftype adapter for wild_match. */
13206 do_wild_match (const char *symbol_search_name
,
13207 const lookup_name_info
&lookup_name
,
13208 completion_match_result
*comp_match_res
)
13210 return wild_match (symbol_search_name
, ada_lookup_name (lookup_name
));
13213 /* symbol_name_matcher_ftype adapter for full_match. */
13216 do_full_match (const char *symbol_search_name
,
13217 const lookup_name_info
&lookup_name
,
13218 completion_match_result
*comp_match_res
)
13220 const char *lname
= lookup_name
.ada ().lookup_name ().c_str ();
13222 /* If both symbols start with "_ada_", just let the loop below
13223 handle the comparison. However, if only the symbol name starts
13224 with "_ada_", skip the prefix and let the match proceed as
13226 if (startswith (symbol_search_name
, "_ada_")
13227 && !startswith (lname
, "_ada"))
13228 symbol_search_name
+= 5;
13229 /* Likewise for ghost entities. */
13230 if (startswith (symbol_search_name
, "___ghost_")
13231 && !startswith (lname
, "___ghost_"))
13232 symbol_search_name
+= 9;
13234 int uscore_count
= 0;
13235 while (*lname
!= '\0')
13237 if (*symbol_search_name
!= *lname
)
13239 if (*symbol_search_name
== 'B' && uscore_count
== 2
13240 && symbol_search_name
[1] == '_')
13242 symbol_search_name
+= 2;
13243 while (isdigit (*symbol_search_name
))
13244 ++symbol_search_name
;
13245 if (symbol_search_name
[0] == '_'
13246 && symbol_search_name
[1] == '_')
13248 symbol_search_name
+= 2;
13255 if (*symbol_search_name
== '_')
13260 ++symbol_search_name
;
13264 return is_name_suffix (symbol_search_name
);
13267 /* symbol_name_matcher_ftype for exact (verbatim) matches. */
13270 do_exact_match (const char *symbol_search_name
,
13271 const lookup_name_info
&lookup_name
,
13272 completion_match_result
*comp_match_res
)
13274 return strcmp (symbol_search_name
, ada_lookup_name (lookup_name
)) == 0;
13277 /* Build the Ada lookup name for LOOKUP_NAME. */
13279 ada_lookup_name_info::ada_lookup_name_info (const lookup_name_info
&lookup_name
)
13281 gdb::string_view user_name
= lookup_name
.name ();
13283 if (!user_name
.empty () && user_name
[0] == '<')
13285 if (user_name
.back () == '>')
13287 = gdb::to_string (user_name
.substr (1, user_name
.size () - 2));
13290 = gdb::to_string (user_name
.substr (1, user_name
.size () - 1));
13291 m_encoded_p
= true;
13292 m_verbatim_p
= true;
13293 m_wild_match_p
= false;
13294 m_standard_p
= false;
13298 m_verbatim_p
= false;
13300 m_encoded_p
= user_name
.find ("__") != gdb::string_view::npos
;
13304 const char *folded
= ada_fold_name (user_name
);
13305 m_encoded_name
= ada_encode_1 (folded
, false);
13306 if (m_encoded_name
.empty ())
13307 m_encoded_name
= gdb::to_string (user_name
);
13310 m_encoded_name
= gdb::to_string (user_name
);
13312 /* Handle the 'package Standard' special case. See description
13313 of m_standard_p. */
13314 if (startswith (m_encoded_name
.c_str (), "standard__"))
13316 m_encoded_name
= m_encoded_name
.substr (sizeof ("standard__") - 1);
13317 m_standard_p
= true;
13320 m_standard_p
= false;
13322 /* If the name contains a ".", then the user is entering a fully
13323 qualified entity name, and the match must not be done in wild
13324 mode. Similarly, if the user wants to complete what looks
13325 like an encoded name, the match must not be done in wild
13326 mode. Also, in the standard__ special case always do
13327 non-wild matching. */
13329 = (lookup_name
.match_type () != symbol_name_match_type::FULL
13332 && user_name
.find ('.') == std::string::npos
);
13336 /* symbol_name_matcher_ftype method for Ada. This only handles
13337 completion mode. */
13340 ada_symbol_name_matches (const char *symbol_search_name
,
13341 const lookup_name_info
&lookup_name
,
13342 completion_match_result
*comp_match_res
)
13344 return lookup_name
.ada ().matches (symbol_search_name
,
13345 lookup_name
.match_type (),
13349 /* A name matcher that matches the symbol name exactly, with
13353 literal_symbol_name_matcher (const char *symbol_search_name
,
13354 const lookup_name_info
&lookup_name
,
13355 completion_match_result
*comp_match_res
)
13357 gdb::string_view name_view
= lookup_name
.name ();
13359 if (lookup_name
.completion_mode ()
13360 ? (strncmp (symbol_search_name
, name_view
.data (),
13361 name_view
.size ()) == 0)
13362 : symbol_search_name
== name_view
)
13364 if (comp_match_res
!= NULL
)
13365 comp_match_res
->set_match (symbol_search_name
);
13372 /* Implement the "get_symbol_name_matcher" language_defn method for
13375 static symbol_name_matcher_ftype
*
13376 ada_get_symbol_name_matcher (const lookup_name_info
&lookup_name
)
13378 if (lookup_name
.match_type () == symbol_name_match_type::SEARCH_NAME
)
13379 return literal_symbol_name_matcher
;
13381 if (lookup_name
.completion_mode ())
13382 return ada_symbol_name_matches
;
13385 if (lookup_name
.ada ().wild_match_p ())
13386 return do_wild_match
;
13387 else if (lookup_name
.ada ().verbatim_p ())
13388 return do_exact_match
;
13390 return do_full_match
;
13394 /* Class representing the Ada language. */
13396 class ada_language
: public language_defn
13400 : language_defn (language_ada
)
13403 /* See language.h. */
13405 const char *name () const override
13408 /* See language.h. */
13410 const char *natural_name () const override
13413 /* See language.h. */
13415 const std::vector
<const char *> &filename_extensions () const override
13417 static const std::vector
<const char *> extensions
13418 = { ".adb", ".ads", ".a", ".ada", ".dg" };
13422 /* Print an array element index using the Ada syntax. */
13424 void print_array_index (struct type
*index_type
,
13426 struct ui_file
*stream
,
13427 const value_print_options
*options
) const override
13429 struct value
*index_value
= val_atr (index_type
, index
);
13431 value_print (index_value
, stream
, options
);
13432 gdb_printf (stream
, " => ");
13435 /* Implement the "read_var_value" language_defn method for Ada. */
13437 struct value
*read_var_value (struct symbol
*var
,
13438 const struct block
*var_block
,
13439 struct frame_info
*frame
) const override
13441 /* The only case where default_read_var_value is not sufficient
13442 is when VAR is a renaming... */
13443 if (frame
!= nullptr)
13445 const struct block
*frame_block
= get_frame_block (frame
, NULL
);
13446 if (frame_block
!= nullptr && ada_is_renaming_symbol (var
))
13447 return ada_read_renaming_var_value (var
, frame_block
);
13450 /* This is a typical case where we expect the default_read_var_value
13451 function to work. */
13452 return language_defn::read_var_value (var
, var_block
, frame
);
13455 /* See language.h. */
13456 virtual bool symbol_printing_suppressed (struct symbol
*symbol
) const override
13458 return symbol
->artificial
;
13461 /* See language.h. */
13462 void language_arch_info (struct gdbarch
*gdbarch
,
13463 struct language_arch_info
*lai
) const override
13465 const struct builtin_type
*builtin
= builtin_type (gdbarch
);
13467 /* Helper function to allow shorter lines below. */
13468 auto add
= [&] (struct type
*t
)
13470 lai
->add_primitive_type (t
);
13473 add (arch_integer_type (gdbarch
, gdbarch_int_bit (gdbarch
),
13475 add (arch_integer_type (gdbarch
, gdbarch_long_bit (gdbarch
),
13476 0, "long_integer"));
13477 add (arch_integer_type (gdbarch
, gdbarch_short_bit (gdbarch
),
13478 0, "short_integer"));
13479 struct type
*char_type
= arch_character_type (gdbarch
, TARGET_CHAR_BIT
,
13481 lai
->set_string_char_type (char_type
);
13483 add (arch_character_type (gdbarch
, 16, 1, "wide_character"));
13484 add (arch_character_type (gdbarch
, 32, 1, "wide_wide_character"));
13485 add (arch_float_type (gdbarch
, gdbarch_float_bit (gdbarch
),
13486 "float", gdbarch_float_format (gdbarch
)));
13487 add (arch_float_type (gdbarch
, gdbarch_double_bit (gdbarch
),
13488 "long_float", gdbarch_double_format (gdbarch
)));
13489 add (arch_integer_type (gdbarch
, gdbarch_long_long_bit (gdbarch
),
13490 0, "long_long_integer"));
13491 add (arch_float_type (gdbarch
, gdbarch_long_double_bit (gdbarch
),
13493 gdbarch_long_double_format (gdbarch
)));
13494 add (arch_integer_type (gdbarch
, gdbarch_int_bit (gdbarch
),
13496 add (arch_integer_type (gdbarch
, gdbarch_int_bit (gdbarch
),
13498 add (builtin
->builtin_void
);
13500 struct type
*system_addr_ptr
13501 = lookup_pointer_type (arch_type (gdbarch
, TYPE_CODE_VOID
, TARGET_CHAR_BIT
,
13503 system_addr_ptr
->set_name ("system__address");
13504 add (system_addr_ptr
);
13506 /* Create the equivalent of the System.Storage_Elements.Storage_Offset
13507 type. This is a signed integral type whose size is the same as
13508 the size of addresses. */
13509 unsigned int addr_length
= TYPE_LENGTH (system_addr_ptr
);
13510 add (arch_integer_type (gdbarch
, addr_length
* HOST_CHAR_BIT
, 0,
13511 "storage_offset"));
13513 lai
->set_bool_type (builtin
->builtin_bool
);
13516 /* See language.h. */
13518 bool iterate_over_symbols
13519 (const struct block
*block
, const lookup_name_info
&name
,
13520 domain_enum domain
,
13521 gdb::function_view
<symbol_found_callback_ftype
> callback
) const override
13523 std::vector
<struct block_symbol
> results
13524 = ada_lookup_symbol_list_worker (name
, block
, domain
, 0);
13525 for (block_symbol
&sym
: results
)
13527 if (!callback (&sym
))
13534 /* See language.h. */
13535 bool sniff_from_mangled_name
13536 (const char *mangled
,
13537 gdb::unique_xmalloc_ptr
<char> *out
) const override
13539 std::string demangled
= ada_decode (mangled
);
13543 if (demangled
!= mangled
&& demangled
[0] != '<')
13545 /* Set the gsymbol language to Ada, but still return 0.
13546 Two reasons for that:
13548 1. For Ada, we prefer computing the symbol's decoded name
13549 on the fly rather than pre-compute it, in order to save
13550 memory (Ada projects are typically very large).
13552 2. There are some areas in the definition of the GNAT
13553 encoding where, with a bit of bad luck, we might be able
13554 to decode a non-Ada symbol, generating an incorrect
13555 demangled name (Eg: names ending with "TB" for instance
13556 are identified as task bodies and so stripped from
13557 the decoded name returned).
13559 Returning true, here, but not setting *DEMANGLED, helps us get
13560 a little bit of the best of both worlds. Because we're last,
13561 we should not affect any of the other languages that were
13562 able to demangle the symbol before us; we get to correctly
13563 tag Ada symbols as such; and even if we incorrectly tagged a
13564 non-Ada symbol, which should be rare, any routing through the
13565 Ada language should be transparent (Ada tries to behave much
13566 like C/C++ with non-Ada symbols). */
13573 /* See language.h. */
13575 gdb::unique_xmalloc_ptr
<char> demangle_symbol (const char *mangled
,
13576 int options
) const override
13578 return make_unique_xstrdup (ada_decode (mangled
).c_str ());
13581 /* See language.h. */
13583 void print_type (struct type
*type
, const char *varstring
,
13584 struct ui_file
*stream
, int show
, int level
,
13585 const struct type_print_options
*flags
) const override
13587 ada_print_type (type
, varstring
, stream
, show
, level
, flags
);
13590 /* See language.h. */
13592 const char *word_break_characters (void) const override
13594 return ada_completer_word_break_characters
;
13597 /* See language.h. */
13599 void collect_symbol_completion_matches (completion_tracker
&tracker
,
13600 complete_symbol_mode mode
,
13601 symbol_name_match_type name_match_type
,
13602 const char *text
, const char *word
,
13603 enum type_code code
) const override
13605 struct symbol
*sym
;
13606 const struct block
*b
, *surrounding_static_block
= 0;
13607 struct block_iterator iter
;
13609 gdb_assert (code
== TYPE_CODE_UNDEF
);
13611 lookup_name_info
lookup_name (text
, name_match_type
, true);
13613 /* First, look at the partial symtab symbols. */
13614 expand_symtabs_matching (NULL
,
13618 SEARCH_GLOBAL_BLOCK
| SEARCH_STATIC_BLOCK
,
13621 /* At this point scan through the misc symbol vectors and add each
13622 symbol you find to the list. Eventually we want to ignore
13623 anything that isn't a text symbol (everything else will be
13624 handled by the psymtab code above). */
13626 for (objfile
*objfile
: current_program_space
->objfiles ())
13628 for (minimal_symbol
*msymbol
: objfile
->msymbols ())
13632 if (completion_skip_symbol (mode
, msymbol
))
13635 language symbol_language
= msymbol
->language ();
13637 /* Ada minimal symbols won't have their language set to Ada. If
13638 we let completion_list_add_name compare using the
13639 default/C-like matcher, then when completing e.g., symbols in a
13640 package named "pck", we'd match internal Ada symbols like
13641 "pckS", which are invalid in an Ada expression, unless you wrap
13642 them in '<' '>' to request a verbatim match.
13644 Unfortunately, some Ada encoded names successfully demangle as
13645 C++ symbols (using an old mangling scheme), such as "name__2Xn"
13646 -> "Xn::name(void)" and thus some Ada minimal symbols end up
13647 with the wrong language set. Paper over that issue here. */
13648 if (symbol_language
== language_auto
13649 || symbol_language
== language_cplus
)
13650 symbol_language
= language_ada
;
13652 completion_list_add_name (tracker
,
13654 msymbol
->linkage_name (),
13655 lookup_name
, text
, word
);
13659 /* Search upwards from currently selected frame (so that we can
13660 complete on local vars. */
13662 for (b
= get_selected_block (0); b
!= NULL
; b
= BLOCK_SUPERBLOCK (b
))
13664 if (!BLOCK_SUPERBLOCK (b
))
13665 surrounding_static_block
= b
; /* For elmin of dups */
13667 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
13669 if (completion_skip_symbol (mode
, sym
))
13672 completion_list_add_name (tracker
,
13674 sym
->linkage_name (),
13675 lookup_name
, text
, word
);
13679 /* Go through the symtabs and check the externs and statics for
13680 symbols which match. */
13682 for (objfile
*objfile
: current_program_space
->objfiles ())
13684 for (compunit_symtab
*s
: objfile
->compunits ())
13687 b
= BLOCKVECTOR_BLOCK (s
->blockvector (), GLOBAL_BLOCK
);
13688 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
13690 if (completion_skip_symbol (mode
, sym
))
13693 completion_list_add_name (tracker
,
13695 sym
->linkage_name (),
13696 lookup_name
, text
, word
);
13701 for (objfile
*objfile
: current_program_space
->objfiles ())
13703 for (compunit_symtab
*s
: objfile
->compunits ())
13706 b
= BLOCKVECTOR_BLOCK (s
->blockvector (), STATIC_BLOCK
);
13707 /* Don't do this block twice. */
13708 if (b
== surrounding_static_block
)
13710 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
13712 if (completion_skip_symbol (mode
, sym
))
13715 completion_list_add_name (tracker
,
13717 sym
->linkage_name (),
13718 lookup_name
, text
, word
);
13724 /* See language.h. */
13726 gdb::unique_xmalloc_ptr
<char> watch_location_expression
13727 (struct type
*type
, CORE_ADDR addr
) const override
13729 type
= check_typedef (TYPE_TARGET_TYPE (check_typedef (type
)));
13730 std::string name
= type_to_string (type
);
13731 return xstrprintf ("{%s} %s", name
.c_str (), core_addr_to_string (addr
));
13734 /* See language.h. */
13736 void value_print (struct value
*val
, struct ui_file
*stream
,
13737 const struct value_print_options
*options
) const override
13739 return ada_value_print (val
, stream
, options
);
13742 /* See language.h. */
13744 void value_print_inner
13745 (struct value
*val
, struct ui_file
*stream
, int recurse
,
13746 const struct value_print_options
*options
) const override
13748 return ada_value_print_inner (val
, stream
, recurse
, options
);
13751 /* See language.h. */
13753 struct block_symbol lookup_symbol_nonlocal
13754 (const char *name
, const struct block
*block
,
13755 const domain_enum domain
) const override
13757 struct block_symbol sym
;
13759 sym
= ada_lookup_symbol (name
, block_static_block (block
), domain
);
13760 if (sym
.symbol
!= NULL
)
13763 /* If we haven't found a match at this point, try the primitive
13764 types. In other languages, this search is performed before
13765 searching for global symbols in order to short-circuit that
13766 global-symbol search if it happens that the name corresponds
13767 to a primitive type. But we cannot do the same in Ada, because
13768 it is perfectly legitimate for a program to declare a type which
13769 has the same name as a standard type. If looking up a type in
13770 that situation, we have traditionally ignored the primitive type
13771 in favor of user-defined types. This is why, unlike most other
13772 languages, we search the primitive types this late and only after
13773 having searched the global symbols without success. */
13775 if (domain
== VAR_DOMAIN
)
13777 struct gdbarch
*gdbarch
;
13780 gdbarch
= target_gdbarch ();
13782 gdbarch
= block_gdbarch (block
);
13784 = language_lookup_primitive_type_as_symbol (this, gdbarch
, name
);
13785 if (sym
.symbol
!= NULL
)
13792 /* See language.h. */
13794 int parser (struct parser_state
*ps
) const override
13796 warnings_issued
= 0;
13797 return ada_parse (ps
);
13800 /* See language.h. */
13802 void emitchar (int ch
, struct type
*chtype
,
13803 struct ui_file
*stream
, int quoter
) const override
13805 ada_emit_char (ch
, chtype
, stream
, quoter
, 1);
13808 /* See language.h. */
13810 void printchar (int ch
, struct type
*chtype
,
13811 struct ui_file
*stream
) const override
13813 ada_printchar (ch
, chtype
, stream
);
13816 /* See language.h. */
13818 void printstr (struct ui_file
*stream
, struct type
*elttype
,
13819 const gdb_byte
*string
, unsigned int length
,
13820 const char *encoding
, int force_ellipses
,
13821 const struct value_print_options
*options
) const override
13823 ada_printstr (stream
, elttype
, string
, length
, encoding
,
13824 force_ellipses
, options
);
13827 /* See language.h. */
13829 void print_typedef (struct type
*type
, struct symbol
*new_symbol
,
13830 struct ui_file
*stream
) const override
13832 ada_print_typedef (type
, new_symbol
, stream
);
13835 /* See language.h. */
13837 bool is_string_type_p (struct type
*type
) const override
13839 return ada_is_string_type (type
);
13842 /* See language.h. */
13844 const char *struct_too_deep_ellipsis () const override
13845 { return "(...)"; }
13847 /* See language.h. */
13849 bool c_style_arrays_p () const override
13852 /* See language.h. */
13854 bool store_sym_names_in_linkage_form_p () const override
13857 /* See language.h. */
13859 const struct lang_varobj_ops
*varobj_ops () const override
13860 { return &ada_varobj_ops
; }
13863 /* See language.h. */
13865 symbol_name_matcher_ftype
*get_symbol_name_matcher_inner
13866 (const lookup_name_info
&lookup_name
) const override
13868 return ada_get_symbol_name_matcher (lookup_name
);
13872 /* Single instance of the Ada language class. */
13874 static ada_language ada_language_defn
;
13876 /* Command-list for the "set/show ada" prefix command. */
13877 static struct cmd_list_element
*set_ada_list
;
13878 static struct cmd_list_element
*show_ada_list
;
13881 initialize_ada_catchpoint_ops (void)
13883 struct breakpoint_ops
*ops
;
13885 initialize_breakpoint_ops ();
13887 ops
= &catch_exception_breakpoint_ops
;
13888 *ops
= bkpt_breakpoint_ops
;
13889 ops
->allocate_location
= allocate_location_exception
;
13890 ops
->re_set
= re_set_exception
;
13891 ops
->check_status
= check_status_exception
;
13892 ops
->print_it
= print_it_exception
;
13893 ops
->print_one
= print_one_exception
;
13894 ops
->print_mention
= print_mention_exception
;
13895 ops
->print_recreate
= print_recreate_exception
;
13898 /* This module's 'new_objfile' observer. */
13901 ada_new_objfile_observer (struct objfile
*objfile
)
13903 ada_clear_symbol_cache ();
13906 /* This module's 'free_objfile' observer. */
13909 ada_free_objfile_observer (struct objfile
*objfile
)
13911 ada_clear_symbol_cache ();
13914 /* Charsets known to GNAT. */
13915 static const char * const gnat_source_charsets
[] =
13917 /* Note that code below assumes that the default comes first.
13918 Latin-1 is the default here, because that is also GNAT's
13928 /* Note that this value is special-cased in the encoder and
13934 void _initialize_ada_language ();
13936 _initialize_ada_language ()
13938 initialize_ada_catchpoint_ops ();
13940 add_setshow_prefix_cmd
13942 _("Prefix command for changing Ada-specific settings."),
13943 _("Generic command for showing Ada-specific settings."),
13944 &set_ada_list
, &show_ada_list
,
13945 &setlist
, &showlist
);
13947 add_setshow_boolean_cmd ("trust-PAD-over-XVS", class_obscure
,
13948 &trust_pad_over_xvs
, _("\
13949 Enable or disable an optimization trusting PAD types over XVS types."), _("\
13950 Show whether an optimization trusting PAD types over XVS types is activated."),
13952 This is related to the encoding used by the GNAT compiler. The debugger\n\
13953 should normally trust the contents of PAD types, but certain older versions\n\
13954 of GNAT have a bug that sometimes causes the information in the PAD type\n\
13955 to be incorrect. Turning this setting \"off\" allows the debugger to\n\
13956 work around this bug. It is always safe to turn this option \"off\", but\n\
13957 this incurs a slight performance penalty, so it is recommended to NOT change\n\
13958 this option to \"off\" unless necessary."),
13959 NULL
, NULL
, &set_ada_list
, &show_ada_list
);
13961 add_setshow_boolean_cmd ("print-signatures", class_vars
,
13962 &print_signatures
, _("\
13963 Enable or disable the output of formal and return types for functions in the \
13964 overloads selection menu."), _("\
13965 Show whether the output of formal and return types for functions in the \
13966 overloads selection menu is activated."),
13967 NULL
, NULL
, NULL
, &set_ada_list
, &show_ada_list
);
13969 ada_source_charset
= gnat_source_charsets
[0];
13970 add_setshow_enum_cmd ("source-charset", class_files
,
13971 gnat_source_charsets
,
13972 &ada_source_charset
, _("\
13973 Set the Ada source character set."), _("\
13974 Show the Ada source character set."), _("\
13975 The character set used for Ada source files.\n\
13976 This must correspond to the '-gnati' or '-gnatW' option passed to GNAT."),
13978 &set_ada_list
, &show_ada_list
);
13980 add_catch_command ("exception", _("\
13981 Catch Ada exceptions, when raised.\n\
13982 Usage: catch exception [ARG] [if CONDITION]\n\
13983 Without any argument, stop when any Ada exception is raised.\n\
13984 If ARG is \"unhandled\" (without the quotes), only stop when the exception\n\
13985 being raised does not have a handler (and will therefore lead to the task's\n\
13987 Otherwise, the catchpoint only stops when the name of the exception being\n\
13988 raised is the same as ARG.\n\
13989 CONDITION is a boolean expression that is evaluated to see whether the\n\
13990 exception should cause a stop."),
13991 catch_ada_exception_command
,
13992 catch_ada_completer
,
13996 add_catch_command ("handlers", _("\
13997 Catch Ada exceptions, when handled.\n\
13998 Usage: catch handlers [ARG] [if CONDITION]\n\
13999 Without any argument, stop when any Ada exception is handled.\n\
14000 With an argument, catch only exceptions with the given name.\n\
14001 CONDITION is a boolean expression that is evaluated to see whether the\n\
14002 exception should cause a stop."),
14003 catch_ada_handlers_command
,
14004 catch_ada_completer
,
14007 add_catch_command ("assert", _("\
14008 Catch failed Ada assertions, when raised.\n\
14009 Usage: catch assert [if CONDITION]\n\
14010 CONDITION is a boolean expression that is evaluated to see whether the\n\
14011 exception should cause a stop."),
14012 catch_assert_command
,
14017 add_info ("exceptions", info_exceptions_command
,
14019 List all Ada exception names.\n\
14020 Usage: info exceptions [REGEXP]\n\
14021 If a regular expression is passed as an argument, only those matching\n\
14022 the regular expression are listed."));
14024 add_setshow_prefix_cmd ("ada", class_maintenance
,
14025 _("Set Ada maintenance-related variables."),
14026 _("Show Ada maintenance-related variables."),
14027 &maint_set_ada_cmdlist
, &maint_show_ada_cmdlist
,
14028 &maintenance_set_cmdlist
, &maintenance_show_cmdlist
);
14030 add_setshow_boolean_cmd
14031 ("ignore-descriptive-types", class_maintenance
,
14032 &ada_ignore_descriptive_types_p
,
14033 _("Set whether descriptive types generated by GNAT should be ignored."),
14034 _("Show whether descriptive types generated by GNAT should be ignored."),
14036 When enabled, the debugger will stop using the DW_AT_GNAT_descriptive_type\n\
14037 DWARF attribute."),
14038 NULL
, NULL
, &maint_set_ada_cmdlist
, &maint_show_ada_cmdlist
);
14040 decoded_names_store
= htab_create_alloc (256, htab_hash_string
,
14042 NULL
, xcalloc
, xfree
);
14044 /* The ada-lang observers. */
14045 gdb::observers::new_objfile
.attach (ada_new_objfile_observer
, "ada-lang");
14046 gdb::observers::free_objfile
.attach (ada_free_objfile_observer
, "ada-lang");
14047 gdb::observers::inferior_exit
.attach (ada_inferior_exit
, "ada-lang");