OSDN Git Service

* exp_dbug.ads: Update documentation to reflect simpler encoding for
[pf3gnuchains/gcc-fork.git] / gcc / ada / exp_dbug.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                             E X P _ D B U G                              --
6 --                                                                          --
7 --                                 S p e c                                  --
8 --                                                                          --
9 --          Copyright (C) 1996-2004 Free Software Foundation, Inc.          --
10 --                                                                          --
11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
12 -- terms of the  GNU General Public License as published  by the Free Soft- --
13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
17 -- for  more details.  You should have  received  a copy of the GNU General --
18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
19 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
20 -- MA 02111-1307, USA.                                                      --
21 --                                                                          --
22 -- GNAT was originally developed  by the GNAT team at  New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
24 --                                                                          --
25 ------------------------------------------------------------------------------
26
27 --  Expand routines for generation of special declarations used by the
28 --  debugger. In accordance with the Dwarf 2.2 specification, certain
29 --  type names are encoded to provide information to the debugger.
30
31 with Types; use Types;
32 with Uintp; use Uintp;
33
34 package Exp_Dbug is
35
36    -----------------------------------------------------
37    -- Encoding and Qualification of Names of Entities --
38    -----------------------------------------------------
39
40    --  This section describes how the names of entities are encoded in
41    --  the generated debugging information.
42
43    --  An entity in Ada has a name of the form X.Y.Z ... E where X,Y,Z
44    --  are the enclosing scopes (not including Standard at the start).
45
46    --  The encoding of the name follows this basic qualified naming scheme,
47    --  where the encoding of individual entity names is as described in
48    --  Namet (i.e. in particular names present in the original source are
49    --  folded to all lower case, with upper half and wide characters encoded
50    --  as described in Namet). Upper case letters are used only for entities
51    --  generated by the compiler.
52
53    --  There are two cases, global entities, and local entities. In more
54    --  formal terms, local entities are those which have a dynamic enclosing
55    --  scope, and global entities are at the library level, except that we
56    --  always consider procedures to be global entities, even if they are
57    --  nested (that's because at the debugger level a procedure name refers
58    --  to the code, and the code is indeed a global entity, including the
59    --  case of nested procedures.) In addition, we also consider all types
60    --  to be global entities, even if they are defined within a procedure.
61
62    --  The reason for treating all type names as global entities is that
63    --  a number of our type encodings work by having related type names,
64    --  and we need the full qualification to keep this unique.
65
66    --  For global entities, the encoded name includes all components of the
67    --  fully expanded name (but omitting Standard at the start). For example,
68    --  if a library level child package P.Q has an embedded package R, and
69    --  there is an entity in this embdded package whose name is S, the encoded
70    --  name will include the components p.q.r.s.
71
72    --  For local entities, the encoded name only includes the components
73    --  up to the enclosing dynamic scope (other than a block). At run time,
74    --  such a dynamic scope is a subprogram, and the debugging formats know
75    --  about local variables of procedures, so it is not necessary to have
76    --  full qualification for such entities. In particular this means that
77    --  direct local variables of a procedure are not qualified.
78
79    --  As an example of the local name convention, consider a procedure V.W
80    --  with a local variable X, and a nested block Y containing an entity
81    --  Z. The fully qualified names of the entities X and Z are:
82
83    --    V.W.X
84    --    V.W.Y.Z
85
86    --  but since V.W is a subprogram, the encoded names will end up
87    --  encoding only
88
89    --    x
90    --    y.z
91
92    --  The separating dots are translated into double underscores.
93
94       -----------------------------
95       -- Handling of Overloading --
96       -----------------------------
97
98       --  The above scheme is incomplete with respect to overloaded
99       --  subprograms, since overloading can legitimately result in a
100       --  case of two entities with exactly the same fully qualified names.
101       --  To distinguish between entries in a set of overloaded subprograms,
102       --  the encoded names are serialized by adding the suffix:
103
104       --    __nn  (two underscores)
105
106       --  where nn is a serial number (2 for the second overloaded function,
107       --  3 for the third, etc.). A suffix of __1 is always omitted (i.e. no
108       --  suffix implies the first instance).
109
110       --  These names are prefixed by the normal full qualification. So
111       --  for example, the third instance of the subprogram qrs in package
112       --  yz would have the name:
113
114       --    yz__qrs__3
115
116       --  A more subtle case arises with entities declared within overloaded
117       --  subprograms. If we have two overloaded subprograms, and both declare
118       --  an entity xyz, then the fully expanded name of the two xyz's is the
119       --  same. To distinguish these, we add the same __n suffix at the end of
120       --  the inner entity names.
121
122       --  In more complex cases, we can have multiple levels of overloading,
123       --  and we must make sure to distinguish which final declarative region
124       --  we are talking about. For this purpose, we use a more complex suffix
125       --  which has the form:
126
127       --    __nn_nn_nn ...
128
129       --  where the nn values are the homonym numbers as needed for any of
130       --  the qualifying entities, separated by a single underscore. If all
131       --  the nn values are 1, the suffix is omitted, Otherwise the suffix
132       --  is present (including any values of 1). The following example
133       --  shows how this suffixing works.
134
135       --    package body Yz is
136       --      procedure Qrs is               -- Name is yz__qrs
137       --        procedure Tuv is ... end;    -- Name is yz__qrs__tuv
138       --      begin ... end Qrs;
139
140       --      procedure Qrs (X: Int) is      -- Name is yz__qrs__2
141       --        procedure Tuv is ... end;    -- Name is yz__qrs__tuv__2_1
142       --        procedure Tuv (X: Int) is    -- Name is yz__qrs__tuv__2_2
143       --        begin ... end Tuv;
144
145       --        procedure Tuv (X: Float) is  -- Name is yz__qrs__tuv__2_3
146       --          type m is new float;       -- Name is yz__qrs__tuv__m__2_3
147       --        begin ... end Tuv;
148       --      begin ... end Qrs;
149       --    end Yz;
150
151       --------------------
152       -- Operator Names --
153       --------------------
154
155       --   The above rules applied to operator names would result in names
156       --   with quotation marks, which are not typically allowed by assemblers
157       --   and linkers, and even if allowed would be odd and hard to deal with.
158       --   To avoid this problem, operator names are encoded as follows:
159
160       --    Oabs       abs
161       --    Oand       and
162       --    Omod       mod
163       --    Onot       not
164       --    Oor        or
165       --    Orem       rem
166       --    Oxor       xor
167       --    Oeq        =
168       --    One        /=
169       --    Olt        <
170       --    Ole        <=
171       --    Ogt        >
172       --    Oge        >=
173       --    Oadd       +
174       --    Osubtract  -
175       --    Oconcat    &
176       --    Omultiply  *
177       --    Odivide    /
178       --    Oexpon     **
179
180       --  These names are prefixed by the normal full qualification, and
181       --  suffixed by the overloading identification. So for example, the
182       --  second operator "=" defined in package Extra.Messages would
183       --  have the name:
184
185       --    extra__messages__Oeq__2
186
187       ----------------------------------
188       -- Resolving Other Name Clashes --
189       ----------------------------------
190
191       --  It might be thought that the above scheme is complete, but in Ada 95,
192       --  full qualification is insufficient to uniquely identify an entity
193       --  in the program, even if it is not an overloaded subprogram. There
194       --  are two possible confusions:
195
196       --     a.b
197
198       --       interpretation 1: entity b in body of package a
199       --       interpretation 2: child procedure b of package a
200
201       --     a.b.c
202
203       --       interpretation 1: entity c in child package a.b
204       --       interpretation 2: entity c in nested package b in body of a
205
206       --  It is perfectly legal in both cases for both interpretations to
207       --  be valid within a single program. This is a bit of a surprise since
208       --  certainly in Ada 83, full qualification was sufficient, but not in
209       --  Ada 95. The result is that the above scheme can result in duplicate
210       --  names. This would not be so bad if the effect were just restricted
211       --  to debugging information, but in fact in both the above cases, it
212       --  is possible for both symbols to be external names, and so we have
213       --  a real problem of name clashes.
214
215       --  To deal with this situation, we provide two additional encoding
216       --  rules for names
217
218       --    First: all library subprogram names are preceded by the string
219       --    _ada_ (which causes no duplications, since normal Ada names can
220       --    never start with an underscore. This not only solves the first
221       --    case of duplication, but also solves another pragmatic problem
222       --    which is that otherwise Ada procedures can generate names that
223       --    clash with existing system function names. Most notably, we can
224       --    have clashes in the case of procedure Main with the C main that
225       --    in some systems is always present.
226
227       --    Second, for the case where nested packages declared in package
228       --    bodies can cause trouble, we add a suffix which shows which
229       --    entities in the list are body-nested packages, i.e. packages
230       --    whose spec is within a package body. The rules are as follows,
231       --    given a list of names in a qualified name name1.name2....
232
233       --    If none are body-nested package entities, then there is no suffix
234
235       --    If at least one is a body-nested package entity, then the suffix
236       --    is X followed by a string of b's and n's (b = body-nested package
237       --    entity, n = not a body-nested package).
238
239       --    There is one element in this string for each entity in the encoded
240       --    expanded name except the first (the rules are such that the first
241       --    entity of the encoded expanded name can never be a body-nested'
242       --    package. Trailing n's are omitted, as is the last b (there must
243       --    be at least one b, or we would not be generating a suffix at all).
244
245       --  For example, suppose we have
246
247       --    package x is
248       --       pragma Elaborate_Body;
249       --       m1 : integer;                                    -- #1
250       --    end x;
251
252       --    package body x is
253       --      package y is m2 : integer; end y;                 -- #2
254       --      package body y is
255       --         package z is r : integer; end z;               -- #3
256       --      end;
257       --      m3 : integer;                                     -- #4
258       --    end x;
259
260       --    package x.y is
261       --       pragma Elaborate_Body;
262       --       m2 : integer;                                    -- #5
263       --    end x.y;
264
265       --    package body x.y is
266       --       m3 : integer;                                    -- #6
267       --       procedure j is                                   -- #7
268       --         package k is
269       --            z : integer;                                -- #8
270       --         end k;
271       --       begin
272       --          null;
273       --       end j;
274       --    end x.y;
275
276       --    procedure x.m3 is begin null; end;                  -- #9
277
278       --  Then the encodings would be:
279
280       --    #1.  x__m1             (no BNPE's in sight)
281       --    #2.  x__y__m2X         (y is a BNPE)
282       --    #3.  x__y__z__rXb      (y is a BNPE, so is z)
283       --    #4.  x__m3             (no BNPE's in sight)
284       --    #5.  x__y__m2          (no BNPE's in sight)
285       --    #6.  x__y__m3          (no BNPE's in signt)
286       --    #7.  x__y__j           (no BNPE's in sight)
287       --    #8.  k__z              (no BNPE's, only up to procedure)
288       --    #9   _ada_x__m3        (library level subprogram)
289
290       --  Note that we have instances here of both kind of potential name
291       --  clashes, and the above examples show how the encodings avoid the
292       --  clash as follows:
293
294       --    Lines #4 and #9 both refer to the entity x.m3, but #9 is a library
295       --    level subprogram, so it is preceded by the string _ada_ which acts
296       --    to distinguish it from the package body entity.
297
298       --    Lines #2 and #5 both refer to the entity x.y.m2, but the first
299       --    instance is inside the body-nested package y, so there is an X
300       --    suffix to distinguish it from the child library entity.
301
302       --  Note that enumeration literals never need Xb type suffixes, since
303       --  they are never referenced using global external names.
304
305       ---------------------
306       -- Interface Names --
307       ---------------------
308
309       --  Note: if an interface name is present, then the external name
310       --  is taken from the specified interface name. Given the current
311       --  limitations of the gcc backend, this means that the debugging
312       --  name is also set to the interface name, but conceptually, it
313       --  would be possible (and indeed desirable) to have the debugging
314       --  information still use the Ada name as qualified above, so we
315       --  still fully qualify the name in the front end.
316
317       -------------------------------------
318       -- Encodings Related to Task Types --
319       -------------------------------------
320
321       --  Each task object defined by a single task declaration is associated
322       --  with a prefix that is used to qualify procedures defined in that
323       --  task. Given
324       --
325       --    package body P is
326       --      task body TaskObj is
327       --        procedure F1 is ... end;
328       --      begin
329       --        B;
330       --      end TaskObj;
331       --    end P;
332       --
333       --  The name of subprogram TaskObj.F1 is encoded as p__taskobjTK__f1,
334       --  The body, B, is contained in a subprogram whose name is
335       --  p__taskobjTKB.
336
337       ------------------------------------------
338       -- Encodings Related to Protected Types --
339       ------------------------------------------
340
341       --  Each protected type has an associated record type, that describes
342       --  the actual layout of the private data. In addition to the private
343       --  components of the type, the Corresponding_Record_Type includes one
344       --  component of type Protection, which is the actual lock structure.
345       --  The run-time size of the protected type is the size of the corres-
346       --  ponding record.
347
348       --  For a protected type prot, the Corresponding_Record_Type is encoded
349       --  as protV.
350
351       --  The operations of a protected type are encoded as follows: each
352       --  operation results in two subprograms, a locking one that is called
353       --  from outside of the object, and a non-locking one that is used for
354       --  calls from other operations on the same object. The locking operation
355       --  simply acquires the lock, and then calls the non-locking version.
356       --  The names of all of these have a prefix constructed from the name of
357       --  the type, and a suffix which is P or N, depending on whether this is
358       --  the protected/non-locking version of the operation.
359
360       --  Operations generated for protected entries follow the same encoding.
361       --  Each entry results in two suprograms: a procedure that holds the
362       --  entry body, and a function that holds the evaluation of the barrier.
363       --  The names of these subprograms include the prefix 'E' or 'B' res-
364       --  pectively. The names also include a numeric suffix to render them
365       --  unique in the presence of overloaded entries.
366
367       --  Given the declaration:
368
369       --    protected type Lock is
370       --       function  Get return Integer;
371       --       procedure Set (X: Integer);
372       --       entry Update  (Val : Integer);
373       --    private
374       --       Value : Integer := 0;
375       --    end Lock;
376
377       --  the following operations are created:
378
379       --    lock_getN
380       --    lock_getP,
381
382       --    lock_setN
383       --    lock_setP
384
385       --    lock_update1sE
386       --    lock_udpate2sB
387
388    ----------------------------------------------------
389    -- Conversion between Entities and External Names --
390    ----------------------------------------------------
391
392    No_Dollar_In_Label : constant Boolean := True;
393    --  True iff the target does not allow dollar signs ("$") in external names
394    --  ??? We want to migrate all platforms to use the same convention.
395    --  As a first step, we force this constant to always be True. This
396    --  constant will eventually be deleted after we have verified that
397    --  the migration does not cause any unforseen adverse impact.
398    --  We chose "__" because it is supported on all platforms, which is
399    --  not the case of "$".
400
401    procedure Get_External_Name
402      (Entity     : Entity_Id;
403       Has_Suffix : Boolean);
404    --  Set Name_Buffer and Name_Len to the external name of entity E.
405    --  The external name is the Interface_Name, if specified, unless
406    --  the entity has an address clause or a suffix.
407    --
408    --  If the Interface is not present, or not used, the external name
409    --  is the concatenation of:
410    --
411    --    - the string "_ada_", if the entity is a library subprogram,
412    --    - the names of any enclosing scopes, each followed by "__",
413    --        or "X_" if the next entity is a subunit)
414    --    - the name of the entity
415    --    - the string "$" (or "__" if target does not allow "$"), followed
416    --        by homonym suffix, if the entity is an overloaded subprogram
417    --        or is defined within an overloaded subprogram.
418
419    procedure Get_External_Name_With_Suffix
420      (Entity : Entity_Id;
421       Suffix : String);
422    --  Set Name_Buffer and Name_Len to the external name of entity E.
423    --  If Suffix is the empty string the external name is as above,
424    --  otherwise the external name is the concatenation of:
425    --
426    --    - the string "_ada_", if the entity is a library subprogram,
427    --    - the names of any enclosing scopes, each followed by "__",
428    --        or "X_" if the next entity is a subunit)
429    --    - the name of the entity
430    --    - the string "$" (or "__" if target does not allow "$"), followed
431    --        by homonym suffix, if the entity is an overloaded subprogram
432    --        or is defined within an overloaded subprogram.
433    --    - the string "___" followed by Suffix
434    --
435    --  If this procedure is called in the ASIS mode, it does nothing. See the
436    --  comments in the body for more details.
437
438    --------------------------------------------
439    -- Subprograms for Handling Qualification --
440    --------------------------------------------
441
442    procedure Qualify_Entity_Names (N : Node_Id);
443    --  Given a node N, that represents a block, subprogram body, or package
444    --  body or spec, or protected or task type, sets a fully qualified name
445    --  for the defining entity of given construct, and also sets fully
446    --  qualified names for all enclosed entities of the construct (using
447    --  First_Entity/Next_Entity). Note that the actual modifications of the
448    --  names is postponed till a subsequent call to Qualify_All_Entity_Names.
449    --  Note: this routine does not deal with prepending _ada_ to library
450    --  subprogram names. The reason for this is that we only prepend _ada_
451    --  to the library entity itself, and not to names built from this name.
452
453    procedure Qualify_All_Entity_Names;
454    --  When Qualify_Entity_Names is called, no actual name changes are made,
455    --  i.e. the actual calls to Qualify_Entity_Name are deferred until a call
456    --  is made to this procedure. The reason for this deferral is that when
457    --  names are changed semantic processing may be affected. By deferring
458    --  the changes till just before gigi is called, we avoid any concerns
459    --  about such effects. Gigi itself does not use the names except for
460    --  output of names for debugging purposes (which is why we are doing
461    --  the name changes in the first place.
462
463    --  Note: the routines Get_Unqualified_[Decoded]_Name_String in Namet
464    --  are useful to remove qualification from a name qualified by the
465    --  call to Qualify_All_Entity_Names.
466
467    --------------------------------
468    -- Handling of Numeric Values --
469    --------------------------------
470
471    --  All numeric values here are encoded as strings of decimal digits.
472    --  Only integer values need to be encoded. A negative value is encoded
473    --  as the corresponding positive value followed by a lower case m for
474    --  minus to indicate that the value is negative (e.g. 2m for -2).
475
476    -------------------------
477    -- Type Name Encodings --
478    -------------------------
479
480    --  In the following typ is the name of the type as normally encoded by
481    --  the debugger rules, i.e. a non-qualified name, all in lower case,
482    --  with standard encoding of upper half and wide characters
483
484       ------------------------
485       -- Encapsulated Types --
486       ------------------------
487
488       --  In some cases, the compiler encapsulates a type by wrapping it in
489       --  a structure. For example, this is used when a size or alignment
490       --  specification requires a larger type. Consider:
491
492       --    type y is mod 2 ** 64;
493       --    for y'size use 256;
494
495       --  In this case the compile generates a structure type y___PAD, which
496       --  has a single field whose name is F. This single field is 64 bits
497       --  long and contains the actual value. This kind of padding is used
498       --  when the logical value to be stored is shorter than the object in
499       --  which it is allocated. For example if a size clause is used to set
500       --  a size of 256 for a signed integer value, then a typical choice is
501       --  to wrap a 64-bit integer in a 256 bit PAD structure.
502
503       --  A similar encapsulation is done for some packed array types,
504       --  in which case the structure type is y___JM and the field name
505       --  is OBJECT. This is used in the case of a packed array stored
506       --  in modular representation (see section on representation of
507       --  packed array objects). In this case the JM wrapping is used to
508       --  achieve correct positioning of the packed array value (left or
509       --  right justified in its field depending on endianness.
510
511       --  When the debugger sees an object of a type whose name has a
512       --  suffix of ___PAD or ___JM, the type will be a record containing
513       --  a single field, and the name of that field will be all upper case.
514       --  In this case, it should look inside to get the value of the inner
515       --  field, and neither the outer structure name, nor the field name
516       --  should appear when the value is printed.
517
518       -----------------------
519       -- Fixed-Point Types --
520       -----------------------
521
522       --   Fixed-point types are encoded using a suffix that indicates the
523       --   delta and small values. The actual type itself is a normal
524       --   integer type.
525
526       --     typ___XF_nn_dd
527       --     typ___XF_nn_dd_nn_dd
528
529       --   The first form is used when small = delta. The value of delta (and
530       --   small) is given by the rational nn/dd, where nn and dd are decimal
531       --   integers.
532       --
533       --   The second form is used if the small value is different from the
534       --   delta. In this case, the first nn/dd rational value is for delta,
535       --   and the second value is for small.
536
537       ------------------------------
538       -- VAX Floating-Point Types --
539       ------------------------------
540
541       --   Vax floating-point types are represented at run time as integer
542       --   types, which are treated specially by the code generator. Their
543       --   type names are encoded with the following suffix:
544
545       --     typ___XFF
546       --     typ___XFD
547       --     typ___XFG
548
549       --   representing the Vax F Float, D Float, and G Float types. The
550       --   debugger must treat these specially. In particular, printing
551       --   these values can be achieved using the debug procedures that
552       --   are provided in package System.Vax_Float_Operations:
553
554       --     procedure Debug_Output_D (Arg : D);
555       --     procedure Debug_Output_F (Arg : F);
556       --     procedure Debug_Output_G (Arg : G);
557
558       --   These three procedures take a Vax floating-point argument, and
559       --   output a corresponding decimal representation to standard output
560       --   with no terminating line return.
561
562       --------------------
563       -- Discrete Types --
564       --------------------
565
566       --   Discrete types are coded with a suffix indicating the range in
567       --   the case where one or both of the bounds are discriminants or
568       --   variable.
569
570       --   Note: at the current time, we also encode compile time known
571       --   bounds if they do not match the natural machine type bounds,
572       --   but this may be removed in the future, since it is redundant
573       --   for most debugging formats. However, we do not ever need XD
574       --   encoding for enumeration base types, since here it is always
575       --   clear what the bounds are from the total number of enumeration
576       --   literals, and of course we do not need to encode the dummy XR
577       --   types generated for renamings.
578
579       --     typ___XD
580       --     typ___XDL_lowerbound
581       --     typ___XDU_upperbound
582       --     typ___XDLU_lowerbound__upperbound
583
584       --   If a discrete type is a natural machine type (i.e. its bounds
585       --   correspond in a natural manner to its size), then it is left
586       --   unencoded. The above encoding forms are used when there is a
587       --   constrained range that does not correspond to the size or that
588       --   has discriminant references or other compile time known bounds.
589
590       --   The first form is used if both bounds are dynamic, in which case
591       --   two constant objects are present whose names are typ___L and
592       --   typ___U in the same scope as typ, and the values of these constants
593       --   indicate the bounds. As far as the debugger is concerned, these
594       --   are simply variables that can be accessed like any other variables.
595       --   In the enumeration case, these values correspond to the Enum_Rep
596       --   values for the lower and upper bounds.
597
598       --   The second form is used if the upper bound is dynamic, but the
599       --   lower bound is either constant or depends on a discriminant of
600       --   the record with which the type is associated. The upper bound
601       --   is stored in a constant object of name typ___U as previously
602       --   described, but the lower bound is encoded directly into the
603       --   name as either a decimal integer, or as the discriminant name.
604
605       --   The third form is similarly used if the lower bound is dynamic,
606       --   but the upper bound is compile time known or a discriminant
607       --   reference, in which case the lower bound is stored in a constant
608       --   object of name typ___L, and the upper bound is encoded directly
609       --   into the name as either a decimal integer, or as the discriminant
610       --   name.
611
612       --   The fourth form is used if both bounds are discriminant references
613       --   or compile time known values, with the encoding first for the lower
614       --   bound, then for the upper bound, as previously described.
615
616       -------------------
617       -- Modular Types --
618       -------------------
619
620       --  A type declared
621
622       --    type x is mod N;
623
624       --  Is encoded as a subrange of an unsigned base type with lower bound
625       --  0 and upper bound N. That is, there is no name encoding. We use
626       --  the standard encodings provided by the debugging format. Thus
627       --  we give these types a non-standard interpretation: the standard
628       --  interpretation of our encoding would not, in general, imply that
629       --  arithmetic on type x was to be performed modulo N (especially not
630       --  when N is not a power of 2).
631
632       ------------------
633       -- Biased Types --
634       ------------------
635
636       --   Only discrete types can be biased, and the fact that they are
637       --   biased is indicated by a suffix of the form:
638
639       --     typ___XB_lowerbound__upperbound
640
641       --   Here lowerbound and upperbound are decimal integers, with the
642       --   usual (postfix "m") encoding for negative numbers. Biased
643       --   types are only possible where the bounds are compile time
644       --   known, and the values are represented as unsigned offsets
645       --   from the lower bound given. For example:
646
647       --     type Q is range 10 .. 15;
648       --     for Q'size use 3;
649
650       --   The size clause will force values of type Q in memory to be
651       --   stored in biased form (e.g. 11 will be represented by the
652       --   bit pattern 001).
653
654       ----------------------------------------------
655       -- Record Types with Variable-Length Fields --
656       ----------------------------------------------
657
658       --  The debugging formats do not fully support these types, and indeed
659       --  some formats simply generate no useful information at all for such
660       --  types. In order to provide information for the debugger, gigi creates
661       --  a parallel type in the same scope with one of the names
662
663       --    type___XVE
664       --    type___XVU
665
666       --  The former name is used for a record and the latter for the union
667       --  that is made for a variant record (see below) if that record or
668       --  union has a field of variable size or if the record or union itself
669       --  has a variable size. These encodings suffix any other encodings that
670       --  that might be suffixed to the type name.
671
672       --  The idea here is to provide all the needed information to interpret
673       --  objects of the original type in the form of a "fixed up" type, which
674       --  is representable using the normal debugging information.
675
676       --  There are three cases to be dealt with. First, some fields may have
677       --  variable positions because they appear after variable-length fields.
678       --  To deal with this, we encode *all* the field bit positions of the
679       --  special ___XV type in a non-standard manner.
680
681       --  The idea is to encode not the position, but rather information
682       --  that allows computing the position of a field from the position
683       --  of the previous field. The algorithm for computing the actual
684       --  positions of all fields and the length of the record is as
685       --  follows. In this description, let P represent the current
686       --  bit position in the record.
687
688       --    1. Initialize P to 0.
689
690       --    2. For each field in the record,
691
692       --       2a. If an alignment is given (see below), then round P
693       --       up, if needed, to the next multiple of that alignment.
694
695       --       2b. If a bit position is given, then increment P by that
696       --       amount (that is, treat it as an offset from the end of the
697       --       preceding record).
698
699       --       2c. Assign P as the actual position of the field.
700
701       --       2d. Compute the length, L, of the represented field (see below)
702       --       and compute P'=P+L. Unless the field represents a variant part
703       --       (see below and also Variant Record Encoding), set P to P'.
704
705       --  The alignment, if present, is encoded in the field name of the
706       --  record, which has a suffix:
707
708       --    fieldname___XVAnn
709
710       --  where the nn after the XVA indicates the alignment value in storage
711       --  units. This encoding is present only if an alignment is present.
712
713       --  The size of the record described by an XVE-encoded type (in bits)
714       --  is generally the maximum value attained by P' in step 2d above,
715       --  rounded up according to the record's alignment.
716
717       --  Second, the variable-length fields themselves are represented by
718       --  replacing the type by a special access type. The designated type
719       --  of this access type is the original variable-length type, and the
720       --  fact that this field has been transformed in this way is signalled
721       --  by encoding the field name as:
722
723       --    field___XVL
724
725       --  where field is the original field name. If a field is both
726       --  variable-length and also needs an alignment encoding, then the
727       --  encodings are combined using:
728
729       --    field___XVLnn
730
731       --  Note: the reason that we change the type is so that the resulting
732       --  type has no variable-length fields. At least some of the formats
733       --  used for debugging information simply cannot tolerate variable-
734       --  length fields, so the encoded information would get lost.
735
736       --  Third, in the case of a variant record, the special union
737       --  that contains the variants is replaced by a normal C union.
738       --  In this case, the positions are all zero.
739
740       --  Discriminants appear before any variable-length fields that depend
741       --  on them, with one exception. In some cases, a discriminant
742       --  governing the choice of a variant clause may appear in the list
743       --  of fields of an XVE type after the entry for the variant clause
744       --  itself (this can happen in the presence of a representation clause
745       --  for the record type in the source program). However, when this
746       --  happens, the discriminant's position may be determined by first
747       --  applying the rules described in this section, ignoring the variant
748       --  clause. As a result, discriminants can always be located
749       --  independently of the variable-length fields that depend on them.
750
751       --  The size of the ___XVE or ___XVU record or union is set to the
752       --  alignment (in bytes) of the original object so that the debugger
753       --  can calculate the size of the original type.
754
755       --  As an example of this encoding, consider the declarations:
756
757       --    type Q is array (1 .. V1) of Float;       -- alignment 4
758       --    type R is array (1 .. V2) of Long_Float;  -- alignment 8
759
760       --    type X is record
761       --       A : Character;
762       --       B : Float;
763       --       C : String (1 .. V3);
764       --       D : Float;
765       --       E : Q;
766       --       F : R;
767       --       G : Float;
768       --    end record;
769
770       --  The encoded type looks like:
771
772       --    type anonymousQ is access Q;
773       --    type anonymousR is access R;
774
775       --    type X___XVE is record
776       --       A        : Character;               -- position contains 0
777       --       B        : Float;                   -- position contains 24
778       --       C___XVL  : access String (1 .. V3); -- position contains 0
779       --       D___XVA4 : Float;                   -- position contains 0
780       --       E___XVL4 : anonymousQ;              -- position contains 0
781       --       F___XVL8 : anonymousR;              -- position contains 0
782       --       G        : Float;                   -- position contains 0
783       --    end record;
784
785       --  Any bit sizes recorded for fields other than dynamic fields and
786       --  variants are honored as for ordinary records.
787
788       --  Notes:
789
790       --  1) The B field could also have been encoded by using a position
791       --  of zero, and an alignment of 4, but in such a case, the coding by
792       --  position is preferred (since it takes up less space). We have used
793       --  the (illegal) notation access xxx as field types in the example
794       --  above.
795
796       --  2) The E field does not actually need the alignment indication
797       --  but this may not be detected in this case by the conversion
798       --  routines.
799
800       --  3) Our conventions do not cover all XVE-encoded records in which
801       --  some, but not all, fields have representation clauses. Such
802       --  records may, therefore, be displayed incorrectly by debuggers.
803       --  This situation is not common.
804
805       -----------------------
806       -- Base Record Types --
807       -----------------------
808
809       --  Under certain circumstances, debuggers need two descriptions
810       --  of a record type, one that gives the actual details of the
811       --  base type's structure (as described elsewhere in these
812       --  comments) and one that may be used to obtain information
813       --  about the particular subtype and the size of the objects
814       --  being typed. In such cases the compiler will substitute a
815       --  type whose name is typically compiler-generated and
816       --  irrelevant except as a key for obtaining the actual type.
817       --  Specifically, if this name is x, then we produce a record
818       --  type named x___XVS consisting of one field. The name of
819       --  this field is that of the actual type being encoded, which
820       --  we'll call y (the type of this single field is arbitrary).
821       --  Both x and y may have corresponding ___XVE types.
822
823       --  The size of the objects typed as x should be obtained from
824       --  the structure of x (and x___XVE, if applicable) as for
825       --  ordinary types unless there is a variable named x___XVZ, which,
826       --  if present, will hold the the size (in bits) of x.
827
828       --  The type x will either be a subtype of y (see also Subtypes
829       --  of Variant Records, below) or will contain no fields at
830       --  all. The layout, types, and positions of these fields will
831       --  be accurate, if present. (Currently, however, the GDB
832       --  debugger makes no use of x except to determine its size).
833
834       --  Among other uses, XVS types are sometimes used to encode
835       --  unconstrained types. For example, given
836       --
837       --     subtype Int is INTEGER range 0..10;
838       --     type T1 (N: Int := 0) is record
839       --        F1: String (1 .. N);
840       --     end record;
841       --     type AT1 is array (INTEGER range <>) of T1;
842       --
843       --  the element type for AT1 might have a type defined as if it had
844       --  been written:
845       --
846       --     type at1___C_PAD is record null; end record;
847       --     for at1___C_PAD'Size use 16 * 8;
848       --
849       --  and there would also be
850       --
851       --     type at1___C_PAD___XVS is record t1: Integer; end record;
852       --     type t1 is ...
853       --
854       --  Had the subtype Int been dynamic:
855       --
856       --     subtype Int is INTEGER range 0 .. M;  -- M a variable
857       --
858       --  Then the compiler would also generate a declaration whose effect
859       --  would be
860       --
861       --     at1___C_PAD___XVZ: constant Integer := 32 + M * 8 + padding term;
862       --
863       --  Not all unconstrained types are so encoded; the XVS
864       --  convention may be unnecessary for unconstrained types of
865       --  fixed size. However, this encoding is always necessary when
866       --  a subcomponent type (array element's type or record field's
867       --  type) is an unconstrained record type some of whose
868       --  components depend on discriminant values.
869
870       -----------------
871       -- Array Types --
872       -----------------
873
874       --  Since there is no way for the debugger to obtain the index subtypes
875       --  for an array type, we produce a type that has the name of the
876       --  array type followed by "___XA" and is a record whose field names
877       --  are the names of the types for the bounds. The types of these
878       --  fields is an integer type which is meaningless.
879
880       --  To conserve space, we do not produce this type unless one of
881       --  the index types is either an enumeration type, has a variable
882       --  upper bound, has a lower bound different from the constant 1,
883       --  is a biased type, or is wider than "sizetype".
884
885       --  Given the full encoding of these types (see above description for
886       --  the encoding of discrete types), this means that all necessary
887       --  information for addressing arrays is available. In some
888       --  debugging formats, some or all of the bounds information may
889       --  be available redundantly, particularly in the fixed-point case,
890       --  but this information can in any case be ignored by the debugger.
891
892       ----------------------------
893       -- Note on Implicit Types --
894       ----------------------------
895
896       --  The compiler creates implicit type names in many situations where
897       --  a type is present semantically, but no specific name is present.
898       --  For example:
899
900       --     S : Integer range M .. N;
901
902       --  Here the subtype of S is not integer, but rather an anonymous
903       --  subtype of Integer. Where possible, the compiler generates names
904       --  for such anonymous types that are related to the type from which
905       --  the subtype is obtained as follows:
906
907       --     T name suffix
908
909       --  where name is the name from which the subtype is obtained, using
910       --  lower case letters and underscores, and suffix starts with an upper
911       --  case letter. For example, the name for the above declaration of S
912       --  might be:
913
914       --     TintegerS4b
915
916       --  If the debugger is asked to give the type of an entity and the type
917       --  has the form T name suffix, it is probably appropriate to just use
918       --  "name" in the response since this is what is meaningful to the
919       --  programmer.
920
921    -------------------------------------------------
922    -- Subprograms for Handling Encoded Type Names --
923    -------------------------------------------------
924
925    procedure Get_Encoded_Name (E : Entity_Id);
926    --  If the entity is a typename, store the external name of
927    --  the entity as in Get_External_Name, followed by three underscores
928    --  plus the type encoding in Name_Buffer with the length in Name_Len,
929    --  and an ASCII.NUL character stored following the name.
930    --  Otherwise set Name_Buffer and Name_Len to hold the entity name.
931
932    --------------
933    -- Renaming --
934    --------------
935
936    --  Debugging information is generated for exception, object, package,
937    --  and subprogram renaming (generic renamings are not significant, since
938    --  generic templates are not relevant at debugging time).
939
940    --  Consider a renaming declaration of the form
941
942    --    x typ renames y;
943
944    --  There is one case in which no special debugging information is required,
945    --  namely the case of an object renaming where the backend allocates a
946    --  reference for the renamed variable, and the entity x is this reference.
947    --  The debugger can handle this case without any special processing or
948    --  encoding (it won't know it was a renaming, but that does not matter).
949
950    --  All other cases of renaming generate a dummy type definition for
951    --  an entity whose name is:
952
953    --    x___XR    for an object renaming
954    --    x___XRE   for an exception renaming
955    --    x___XRP   for a package renaming
956
957    --  The name is fully qualified in the usual manner, i.e. qualified in
958    --  the same manner as the entity x would be. In the case of a package
959    --  renaming where x is a child unit, the qualification includes the
960    --  name of the parent unit, to disambiguate child units with the same
961    --  simple name and (of necessity) different parents.
962
963    --  Note: subprogram renamings are not encoded at the present time.
964
965    --  The type is an enumeration type with a single enumeration literal
966    --  that is an identifier which describes the renamed variable.
967
968    --    For the simple entity case, where y is an entity name,
969    --    the enumeration is of the form:
970
971    --       (y___XE)
972
973    --          i.e. the enumeration type has a single field, whose name
974    --          matches the name y, with the XE suffix. The entity for this
975    --          enumeration literal is fully qualified in the usual manner.
976    --          All subprogram, exception, and package renamings fall into
977    --          this category, as well as simple object renamings.
978
979    --    For the object renaming case where y is a selected component or an
980    --    indexed component, the literal name is suffixed by additional fields
981    --    that give details of the components. The name starts as above with
982    --    a y___XE entity indicating the outer level variable. Then a series
983    --    of selections and indexing operations can be specified as follows:
984
985    --      Indexed component
986
987    --        A series of subscript values appear in sequence, the number
988    --        corresponds to the number of dimensions of the array. The
989    --        subscripts have one of the following two forms:
990
991    --          XSnnn
992
993    --            Here nnn is a constant value, encoded as a decimal
994    --            integer (pos value for enumeration type case). Negative
995    --            values have a trailing 'm' as usual.
996
997    --          XSe
998
999    --            Here e is the (unqualified) name of a constant entity in
1000    --            the same scope as the renaming which contains the subscript
1001    --            value.
1002
1003    --      Slice
1004
1005    --        For the slice case, we have two entries. The first is for
1006    --        the lower bound of the slice, and has the form
1007
1008    --          XLnnn
1009    --          XLe
1010
1011    --            Specifies the lower bound, using exactly the same encoding
1012    --            as for an XS subscript as described above.
1013
1014    --        Then the upper bound appears in the usual XSnnn/XSe form
1015
1016    --      Selected component
1017
1018    --        For a selected component, we have a single entry
1019
1020    --          XRf
1021
1022    --            Here f is the field name for the selection
1023
1024    --        For an explicit deference (.all), we have a single entry
1025
1026    --          XA
1027
1028    --      As an example, consider the declarations:
1029
1030    --        package p is
1031    --           type q is record
1032    --              m : string (2 .. 5);
1033    --           end record;
1034    --
1035    --           type r is array (1 .. 10, 1 .. 20) of q;
1036    --
1037    --           g : r;
1038    --
1039    --           z : string renames g (1,5).m(2 ..3)
1040    --        end p;
1041
1042    --     The generated type definition would appear as
1043
1044    --       type p__z___XR is
1045    --         (p__g___XEXS1XS5XRmXL2XS3);
1046    --          p__g___XE--------------------outer entity is g
1047    --                   XS1-----------------first subscript for g
1048    --                      XS5--------------second subscript for g
1049    --                         XRm-----------select field m
1050    --                            XL2--------lower bound of slice
1051    --                               XS3-----upper bound of slice
1052
1053    function Debug_Renaming_Declaration (N : Node_Id) return Node_Id;
1054    --  The argument N is a renaming declaration. The result is a type
1055    --  declaration as described in the above paragraphs. If not special
1056    --  debug declaration, than Empty is returned.
1057
1058    ---------------------------
1059    -- Packed Array Encoding --
1060    ---------------------------
1061
1062    --  For every packed array, two types are created, and both appear in
1063    --  the debugging output.
1064
1065    --    The original declared array type is a perfectly normal array type,
1066    --    and its index bounds indicate the original bounds of the array.
1067
1068    --    The corresponding packed array type, which may be a modular type, or
1069    --    may be an array of bytes type (see Exp_Pakd for full details). This
1070    --    is the type that is actually used in the generated code and for
1071    --    debugging information for all objects of the packed type.
1072
1073    --  The name of the corresponding packed array type is:
1074
1075    --    ttt___XPnnn
1076
1077    --  where
1078    --    ttt is the name of the original declared array
1079    --    nnn is the component size in bits (1-31)
1080
1081    --  When the debugger sees that an object is of a type that is encoded
1082    --  in this manner, it can use the original type to determine the bounds,
1083    --  and the component size to determine the packing details.
1084
1085    -------------------------------------------
1086    -- Packed Array Representation in Memory --
1087    -------------------------------------------
1088
1089    --  Packed arrays are represented in tightly packed form, with no extra
1090    --  bits between components. This is true even when the component size
1091    --  is not a factor of the storage unit size, so that as a result it is
1092    --  possible for components to cross storage unit boundaries.
1093
1094    --  The layout in storage is identical, regardless of whether the
1095    --  implementation type is a modular type or an array-of-bytes type.
1096    --  See Exp_Pakd for details of how these implementation types are used,
1097    --  but for the purpose of the debugger, only the starting address of
1098    --  the object in memory is significant.
1099
1100    --  The following example should show clearly how the packing works in
1101    --  the little-endian and big-endian cases:
1102
1103    --     type B is range 0 .. 7;
1104    --     for B'Size use 3;
1105
1106    --     type BA is array (0 .. 5) of B;
1107    --     pragma Pack (BA);
1108
1109    --     BV : constant BA := (1,2,3,4,5,6);
1110
1111    --  Little endian case
1112
1113    --        BV'Address + 2   BV'Address + 1    BV'Address + 0
1114    --     +-----------------+-----------------+-----------------+
1115    --     | ? ? ? ? ? ? 1 1 | 0 1 0 1 1 0 0 0 | 1 1 0 1 0 0 0 1 |
1116    --     +-----------------+-----------------+-----------------+
1117    --       <---------> <-----> <---> <---> <-----> <---> <--->
1118    --       unused bits  BV(5)  BV(4) BV(3)  BV(2)  BV(1) BV(0)
1119    --
1120    --  Big endian case
1121    --
1122    --        BV'Address + 0  BV'Address + 1    BV'Address + 2
1123    --     +-----------------+-----------------+-----------------+
1124    --     | 0 0 1 0 1 0 0 1 | 1 1 0 0 1 0 1 1 | 1 0 ? ? ? ? ? ? |
1125    --     +-----------------+-----------------+-----------------+
1126    --       <---> <---> <-----> <---> <---> <-----> <--------->
1127    --       BV(0) BV(1)  BV(2)  BV(3) BV(4)  BV(5)  unused bits
1128
1129    --  Note that if a modular type is used to represent the array, the
1130    --  allocation in memory is not the same as a normal modular type.
1131    --  The difference occurs when the allocated object is larger than
1132    --  the size of the array. For a normal modular type, we extend the
1133    --  value on the left with zeroes.
1134
1135    --  For example, in the normal modular case, if we have a 6-bit
1136    --  modular type, declared as mod 2**6, and we allocate an 8-bit
1137    --  object for this type, then we extend the value with two bits
1138    --  on the most significant end, and in either the little-endian
1139    --  or big-endian case, the value 63 is represented as 00111111
1140    --  in binary in memory.
1141
1142    --  For a modular type used to represent a packed array, the rule is
1143    --  different. In this case, if we have to extend the value, then we
1144    --  do it with undefined bits (which are not initialized and whose value
1145    --  is irrelevant to any generated code). Furthermore these bits are on
1146    --  the right (least significant bits) in the big-endian case, and on the
1147    --  left (most significant bits) in the little-endian case.
1148
1149    --  For example, if we have a packed boolean array of 6 bits, all set
1150    --  to True, stored in an 8-bit object, then the value in memory in
1151    --  binary is ??111111 in the little-endian case, and 111111?? in the
1152    --  big-endian case.
1153
1154    --  This is done so that the representation of packed arrays does not
1155    --  depend on whether we use a modular representation or array of bytes
1156    --  as previously described. This ensures that we can pass such values
1157    --  by reference in the case where a subprogram has to be able to handle
1158    --  values stored in either form.
1159
1160    --  Note that when we extract the value of such a modular packed array,
1161    --  we expect to retrieve only the relevant bits, so in this same example,
1162    --  when we extract the value, we get 111111 in both cases, and the code
1163    --  generated by the front end assumes this, although it does not assume
1164    --  that any high order bits are defined.
1165
1166    --  There are opportunities for optimization based on the knowledge that
1167    --  the unused bits are irrelevant for these type of packed arrays. For
1168    --  example if we have two such 6-bit-in-8-bit values and we do an
1169    --  assignment:
1170
1171    --     a := b;
1172
1173    --  Then logically, we extract the 6 bits and store only 6 bits in the
1174    --  result, but the back end is free to simply assign the entire 8-bits
1175    --  in this case, since we don't actually care about the undefined bits.
1176    --  However, in the equality case, it is important to ensure that the
1177    --  undefined bits do not participate in an equality test.
1178
1179    --  If a modular packed array value is assigned to a register, then
1180    --  logically it could always be held right justified, to avoid any
1181    --  need to shift, e.g. when doing comparisons. But probably this is
1182    --  a bad choice, as it would mean that an assignment such as a := b
1183    --  above would require shifts when one value is in a register and the
1184    --  other value is in memory.
1185
1186    ------------------------------------------------------
1187    -- Subprograms for Handling Packed Array Type Names --
1188    ------------------------------------------------------
1189
1190    function Make_Packed_Array_Type_Name
1191      (Typ   : Entity_Id;
1192       Csize : Uint)
1193       return  Name_Id;
1194    --  This function is used in Exp_Pakd to create the name that is encoded
1195    --  as described above. The entity Typ provides the name ttt, and the
1196    --  value Csize is the component size that provides the nnn value.
1197
1198    --------------------------------------
1199    -- Pointers to Unconstrained Arrays --
1200    --------------------------------------
1201
1202    --  There are two kinds of pointers to arrays. The debugger can tell
1203    --  which format is in use by the form of the type of the pointer.
1204
1205    --    Fat Pointers
1206
1207    --      Fat pointers are represented as a struct with two fields. This
1208    --      struct has two distinguished field names:
1209
1210    --        P_ARRAY is a pointer to the array type. The name of this
1211    --        type is the unconstrained type followed by "___XUA". This
1212    --        array will have bounds which are the discriminants, and
1213    --        hence are unparsable, but will give the number of
1214    --        subscripts and the component type.
1215
1216    --        P_BOUNDS is a pointer to a struct, the name of  whose type is the
1217    --        unconstrained array name followed by "___XUB" and which has
1218    --        fields of the form
1219
1220    --           LBn (n a decimal integer) lower bound of n'th dimension
1221    --           UBn (n a decimal integer) upper bound of n'th dimension
1222
1223    --        The bounds may be any integral type. In the case of an
1224    --        enumeration type, Enum_Rep values are used.
1225
1226    --      The debugging information will sometimes reference an anonymous
1227    --      fat pointer type. Such types are given the name xxx___XUP, where
1228    --      xxx is the name of the designated type. If the debugger is asked
1229    --      to output such a type name, the appropriate form is "access xxx".
1230
1231    --    Thin Pointers
1232
1233    --      The value of a thin pointer is a pointer to the second field
1234    --      of a structure with two fields. The name of this structure's
1235    --      type is "arr___XUT", where "arr" is the name of the
1236    --      unconstrained array type. Even though it actually points into
1237    --      middle of this structure, the thin pointer's type in debugging
1238    --      information is pointer-to-arr___XUT.
1239
1240    --      The first field of arr___XUT is named BOUNDS, and has a type
1241    --      named arr___XUB, with the structure described for such types
1242    --      in fat pointers, as described above.
1243
1244    --      The second field of arr___XUT is named ARRAY, and contains
1245    --      the actual array. Because this array has a dynamic size,
1246    --      determined by the BOUNDS field that precedes it, all of the
1247    --      information about arr___XUT is encoded in a parallel type named
1248    --      arr___XUT___XVE, with fields BOUNDS and ARRAY___XVL. As for
1249    --      previously described ___XVE types, ARRAY___XVL has
1250    --      a pointer-to-array type. However, the array type in this case
1251    --      is named arr___XUA and only its element type is meaningful,
1252    --      just as described for fat pointers.
1253
1254    --------------------------------------
1255    -- Tagged Types and Type Extensions --
1256    --------------------------------------
1257
1258    --  A type C derived from a tagged type P has a field named "_parent"
1259    --  of type P that contains its inherited fields. The type of this
1260    --  field is usually P (encoded as usual if it has a dynamic size),
1261    --  but may be a more distant ancestor, if P is a null extension of
1262    --  that type.
1263
1264    --  The type tag of a tagged type is a field named _tag, of type void*.
1265    --  If the type is derived from another tagged type, its _tag field is
1266    --  found in its _parent field.
1267
1268    -----------------------------
1269    -- Variant Record Encoding --
1270    -----------------------------
1271
1272    --  The variant part of a variant record is encoded as a single field
1273    --  in the enclosing record, whose name is:
1274
1275    --     discrim___XVN
1276
1277    --  where discrim is the unqualified name of the variant. This field name
1278    --  is built by gigi (not by code in this unit). In the case of an
1279    --  Unchecked_Union record, this discriminant will not appear in the
1280    --  record, and the debugger must proceed accordingly (basically it
1281    --  can treat this case as it would a C union).
1282
1283    --  The type corresponding to this field has a name that is obtained
1284    --  by concatenating the type name with the above string and is similar
1285    --  to a C union, in which each member of the union corresponds to one
1286    --  variant. However, unlike a C union, the size of the type may be
1287    --  variable even if each of the components are fixed size, since it
1288    --  includes a computation of which variant is present. In that case,
1289    --  it will be encoded as above and a type with the suffix "___XVN___XVU"
1290    --  will be present.
1291
1292    --  The name of the union member is encoded to indicate the choices, and
1293    --  is a string given by the following grammar:
1294
1295    --    union_name ::= {choice} | others_choice
1296    --    choice ::= simple_choice | range_choice
1297    --    simple_choice ::= S number
1298    --    range_choice  ::= R number T number
1299    --    number ::= {decimal_digit} [m]
1300    --    others_choice ::= O (upper case letter O)
1301
1302    --  The m in a number indicates a negative value. As an example of this
1303    --  encoding scheme, the choice 1 .. 4 | 7 | -10 would be represented by
1304
1305    --    R1T4S7S10m
1306
1307    --  In the case of enumeration values, the values used are the
1308    --  actual representation values in the case where an enumeration type
1309    --  has an enumeration representation spec (i.e. they are values that
1310    --  correspond to the use of the Enum_Rep attribute).
1311
1312    --  The type of the inner record is given by the name of the union
1313    --  type (as above) concatenated with the above string. Since that
1314    --  type may itself be variable-sized, it may also be encoded as above
1315    --  with a new type with a further suffix of "___XVU".
1316
1317    --  As an example, consider:
1318
1319    --    type Var (Disc : Boolean := True) is record
1320    --       M : Integer;
1321
1322    --       case Disc is
1323    --         when True =>
1324    --           R : Integer;
1325    --           S : Integer;
1326
1327    --         when False =>
1328    --           T : Integer;
1329    --       end case;
1330    --    end record;
1331
1332    --    V1 : Var;
1333
1334    --  In this case, the type var is represented as a struct with three
1335    --  fields, the first two are "disc" and "m", representing the values
1336    --  of these record  components.
1337
1338    --  The third field is a union of two types, with field names S1 and O.
1339    --  S1 is a struct with fields "r" and "s", and O is a struct with
1340    --  fields "t".
1341
1342    ------------------------------------------------
1343    -- Subprograms for Handling Variant Encodings --
1344    ------------------------------------------------
1345
1346    procedure Get_Variant_Encoding (V : Node_Id);
1347    --  This procedure is called by Gigi with V being the variant node.
1348    --  The corresponding encoding string is returned in Name_Buffer with
1349    --  the length of the string in Name_Len, and an ASCII.NUL character
1350    --  stored following the name.
1351
1352    ---------------------------------
1353    -- Subtypes of Variant Records --
1354    ---------------------------------
1355
1356    --  A subtype of a variant record is represented by a type in which the
1357    --  union field from the base type is replaced by one of the possible
1358    --  values. For example, if we have:
1359
1360    --    type Var (Disc : Boolean := True) is record
1361    --       M : Integer;
1362
1363    --       case Disc is
1364    --         when True =>
1365    --           R : Integer;
1366    --           S : Integer;
1367
1368    --         when False =>
1369    --           T : Integer;
1370    --       end case;
1371
1372    --    end record;
1373    --    V1 : Var;
1374    --    V2 : Var (True);
1375    --    V3 : Var (False);
1376
1377    --  Here V2 for example is represented with a subtype whose name is
1378    --  something like TvarS3b, which is a struct with three fields. The
1379    --  first two fields are "disc" and "m" as for the base type, and
1380    --  the third field is S1, which contains the fields "r" and "s".
1381
1382    --  The debugger should simply ignore structs with names of the form
1383    --  corresponding to variants, and consider the fields inside as
1384    --  belonging to the containing record.
1385
1386    -------------------------------------------
1387    -- Character literals in Character Types --
1388    -------------------------------------------
1389
1390    --  Character types are enumeration types at least one of whose
1391    --  enumeration literals is a character literal. Enumeration literals
1392    --  are usually simply represented using their identifier names. In
1393    --  the case where an enumeration literal is a character literal, the
1394    --  name aencoded as described in the following paragraph.
1395
1396    --  A name QUhh, where each 'h' is a lower-case hexadecimal digit,
1397    --  stands for a character whose Unicode encoding is hh, and
1398    --  QWhhhh likewise stands for a wide character whose encoding
1399    --  is hhhh. The representation values are encoded as for ordinary
1400    --  enumeration literals (and have no necessary relationship to the
1401    --  values encoded in the names).
1402
1403    --  For example, given the type declaration
1404
1405    --    type x is (A, 'C', B);
1406
1407    --  the second enumeration literal would be named QU43 and the
1408    --  value assigned to it would be 1.
1409
1410    ----------------------------
1411    -- Effect of Optimization --
1412    ----------------------------
1413
1414    --  If the program is compiled with optimization on (e.g. -O1 switch
1415    --  specified), then there may be variations in the output from the
1416    --  above specification. In particular, objects may disappear from
1417    --  the output. This includes not only constants and variables that
1418    --  the program declares at the source level, but also the x___L and
1419    --  x___U constants created to describe the lower and upper bounds of
1420    --  subtypes with dynamic bounds. This means for example, that array
1421    --  bounds may disappear if optimization is turned on. The debugger
1422    --  is expected to recognize that these constants are missing and
1423    --  deal as best as it can with the limited information available.
1424
1425 end Exp_Dbug;