OSDN Git Service

* exp_pakd.adb (Create_Packed_Array_Type): Always use a modular type
[pf3gnuchains/gcc-fork.git] / gcc / ada / exp_pakd.adb
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                             E X P _ P A K D                              --
6 --                                                                          --
7 --                                 B o d y                                  --
8 --                                                                          --
9 --          Copyright (C) 1992-2009, 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 3,  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 COPYING3.  If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license.          --
20 --                                                                          --
21 -- GNAT was originally developed  by the GNAT team at  New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
23 --                                                                          --
24 ------------------------------------------------------------------------------
25
26 with Atree;    use Atree;
27 with Checks;   use Checks;
28 with Einfo;    use Einfo;
29 with Errout;   use Errout;
30 with Exp_Dbug; use Exp_Dbug;
31 with Exp_Util; use Exp_Util;
32 with Layout;   use Layout;
33 with Namet;    use Namet;
34 with Nlists;   use Nlists;
35 with Nmake;    use Nmake;
36 with Opt;      use Opt;
37 with Rtsfind;  use Rtsfind;
38 with Sem;      use Sem;
39 with Sem_Aux;  use Sem_Aux;
40 with Sem_Ch3;  use Sem_Ch3;
41 with Sem_Ch8;  use Sem_Ch8;
42 with Sem_Ch13; use Sem_Ch13;
43 with Sem_Eval; use Sem_Eval;
44 with Sem_Res;  use Sem_Res;
45 with Sem_Util; use Sem_Util;
46 with Sinfo;    use Sinfo;
47 with Snames;   use Snames;
48 with Stand;    use Stand;
49 with Targparm; use Targparm;
50 with Tbuild;   use Tbuild;
51 with Ttypes;   use Ttypes;
52 with Uintp;    use Uintp;
53
54 package body Exp_Pakd is
55
56    ---------------------------
57    -- Endian Considerations --
58    ---------------------------
59
60    --  As described in the specification, bit numbering in a packed array
61    --  is consistent with bit numbering in a record representation clause,
62    --  and hence dependent on the endianness of the machine:
63
64    --    For little-endian machines, element zero is at the right hand end
65    --    (low order end) of a bit field.
66
67    --    For big-endian machines, element zero is at the left hand end
68    --    (high order end) of a bit field.
69
70    --  The shifts that are used to right justify a field therefore differ
71    --  in the two cases. For the little-endian case, we can simply use the
72    --  bit number (i.e. the element number * element size) as the count for
73    --  a right shift. For the big-endian case, we have to subtract the shift
74    --  count from an appropriate constant to use in the right shift. We use
75    --  rotates instead of shifts (which is necessary in the store case to
76    --  preserve other fields), and we expect that the backend will be able
77    --  to change the right rotate into a left rotate, avoiding the subtract,
78    --  if the architecture provides such an instruction.
79
80    ----------------------------------------------
81    -- Entity Tables for Packed Access Routines --
82    ----------------------------------------------
83
84    --  For the cases of component size = 3,5-7,9-15,17-31,33-63 we call
85    --  library routines. This table is used to obtain the entity for the
86    --  proper routine.
87
88    type E_Array is array (Int range 01 .. 63) of RE_Id;
89
90    --  Array of Bits_nn entities. Note that we do not use library routines
91    --  for the 8-bit and 16-bit cases, but we still fill in the table, using
92    --  entries from System.Unsigned, because we also use this table for
93    --  certain special unchecked conversions in the big-endian case.
94
95    Bits_Id : constant E_Array :=
96      (01 => RE_Bits_1,
97       02 => RE_Bits_2,
98       03 => RE_Bits_03,
99       04 => RE_Bits_4,
100       05 => RE_Bits_05,
101       06 => RE_Bits_06,
102       07 => RE_Bits_07,
103       08 => RE_Unsigned_8,
104       09 => RE_Bits_09,
105       10 => RE_Bits_10,
106       11 => RE_Bits_11,
107       12 => RE_Bits_12,
108       13 => RE_Bits_13,
109       14 => RE_Bits_14,
110       15 => RE_Bits_15,
111       16 => RE_Unsigned_16,
112       17 => RE_Bits_17,
113       18 => RE_Bits_18,
114       19 => RE_Bits_19,
115       20 => RE_Bits_20,
116       21 => RE_Bits_21,
117       22 => RE_Bits_22,
118       23 => RE_Bits_23,
119       24 => RE_Bits_24,
120       25 => RE_Bits_25,
121       26 => RE_Bits_26,
122       27 => RE_Bits_27,
123       28 => RE_Bits_28,
124       29 => RE_Bits_29,
125       30 => RE_Bits_30,
126       31 => RE_Bits_31,
127       32 => RE_Unsigned_32,
128       33 => RE_Bits_33,
129       34 => RE_Bits_34,
130       35 => RE_Bits_35,
131       36 => RE_Bits_36,
132       37 => RE_Bits_37,
133       38 => RE_Bits_38,
134       39 => RE_Bits_39,
135       40 => RE_Bits_40,
136       41 => RE_Bits_41,
137       42 => RE_Bits_42,
138       43 => RE_Bits_43,
139       44 => RE_Bits_44,
140       45 => RE_Bits_45,
141       46 => RE_Bits_46,
142       47 => RE_Bits_47,
143       48 => RE_Bits_48,
144       49 => RE_Bits_49,
145       50 => RE_Bits_50,
146       51 => RE_Bits_51,
147       52 => RE_Bits_52,
148       53 => RE_Bits_53,
149       54 => RE_Bits_54,
150       55 => RE_Bits_55,
151       56 => RE_Bits_56,
152       57 => RE_Bits_57,
153       58 => RE_Bits_58,
154       59 => RE_Bits_59,
155       60 => RE_Bits_60,
156       61 => RE_Bits_61,
157       62 => RE_Bits_62,
158       63 => RE_Bits_63);
159
160    --  Array of Get routine entities. These are used to obtain an element
161    --  from a packed array. The N'th entry is used to obtain elements from
162    --  a packed array whose component size is N. RE_Null is used as a null
163    --  entry, for the cases where a library routine is not used.
164
165    Get_Id : constant E_Array :=
166      (01 => RE_Null,
167       02 => RE_Null,
168       03 => RE_Get_03,
169       04 => RE_Null,
170       05 => RE_Get_05,
171       06 => RE_Get_06,
172       07 => RE_Get_07,
173       08 => RE_Null,
174       09 => RE_Get_09,
175       10 => RE_Get_10,
176       11 => RE_Get_11,
177       12 => RE_Get_12,
178       13 => RE_Get_13,
179       14 => RE_Get_14,
180       15 => RE_Get_15,
181       16 => RE_Null,
182       17 => RE_Get_17,
183       18 => RE_Get_18,
184       19 => RE_Get_19,
185       20 => RE_Get_20,
186       21 => RE_Get_21,
187       22 => RE_Get_22,
188       23 => RE_Get_23,
189       24 => RE_Get_24,
190       25 => RE_Get_25,
191       26 => RE_Get_26,
192       27 => RE_Get_27,
193       28 => RE_Get_28,
194       29 => RE_Get_29,
195       30 => RE_Get_30,
196       31 => RE_Get_31,
197       32 => RE_Null,
198       33 => RE_Get_33,
199       34 => RE_Get_34,
200       35 => RE_Get_35,
201       36 => RE_Get_36,
202       37 => RE_Get_37,
203       38 => RE_Get_38,
204       39 => RE_Get_39,
205       40 => RE_Get_40,
206       41 => RE_Get_41,
207       42 => RE_Get_42,
208       43 => RE_Get_43,
209       44 => RE_Get_44,
210       45 => RE_Get_45,
211       46 => RE_Get_46,
212       47 => RE_Get_47,
213       48 => RE_Get_48,
214       49 => RE_Get_49,
215       50 => RE_Get_50,
216       51 => RE_Get_51,
217       52 => RE_Get_52,
218       53 => RE_Get_53,
219       54 => RE_Get_54,
220       55 => RE_Get_55,
221       56 => RE_Get_56,
222       57 => RE_Get_57,
223       58 => RE_Get_58,
224       59 => RE_Get_59,
225       60 => RE_Get_60,
226       61 => RE_Get_61,
227       62 => RE_Get_62,
228       63 => RE_Get_63);
229
230    --  Array of Get routine entities to be used in the case where the packed
231    --  array is itself a component of a packed structure, and therefore may
232    --  not be fully aligned. This only affects the even sizes, since for the
233    --  odd sizes, we do not get any fixed alignment in any case.
234
235    GetU_Id : constant E_Array :=
236      (01 => RE_Null,
237       02 => RE_Null,
238       03 => RE_Get_03,
239       04 => RE_Null,
240       05 => RE_Get_05,
241       06 => RE_GetU_06,
242       07 => RE_Get_07,
243       08 => RE_Null,
244       09 => RE_Get_09,
245       10 => RE_GetU_10,
246       11 => RE_Get_11,
247       12 => RE_GetU_12,
248       13 => RE_Get_13,
249       14 => RE_GetU_14,
250       15 => RE_Get_15,
251       16 => RE_Null,
252       17 => RE_Get_17,
253       18 => RE_GetU_18,
254       19 => RE_Get_19,
255       20 => RE_GetU_20,
256       21 => RE_Get_21,
257       22 => RE_GetU_22,
258       23 => RE_Get_23,
259       24 => RE_GetU_24,
260       25 => RE_Get_25,
261       26 => RE_GetU_26,
262       27 => RE_Get_27,
263       28 => RE_GetU_28,
264       29 => RE_Get_29,
265       30 => RE_GetU_30,
266       31 => RE_Get_31,
267       32 => RE_Null,
268       33 => RE_Get_33,
269       34 => RE_GetU_34,
270       35 => RE_Get_35,
271       36 => RE_GetU_36,
272       37 => RE_Get_37,
273       38 => RE_GetU_38,
274       39 => RE_Get_39,
275       40 => RE_GetU_40,
276       41 => RE_Get_41,
277       42 => RE_GetU_42,
278       43 => RE_Get_43,
279       44 => RE_GetU_44,
280       45 => RE_Get_45,
281       46 => RE_GetU_46,
282       47 => RE_Get_47,
283       48 => RE_GetU_48,
284       49 => RE_Get_49,
285       50 => RE_GetU_50,
286       51 => RE_Get_51,
287       52 => RE_GetU_52,
288       53 => RE_Get_53,
289       54 => RE_GetU_54,
290       55 => RE_Get_55,
291       56 => RE_GetU_56,
292       57 => RE_Get_57,
293       58 => RE_GetU_58,
294       59 => RE_Get_59,
295       60 => RE_GetU_60,
296       61 => RE_Get_61,
297       62 => RE_GetU_62,
298       63 => RE_Get_63);
299
300    --  Array of Set routine entities. These are used to assign an element
301    --  of a packed array. The N'th entry is used to assign elements for
302    --  a packed array whose component size is N. RE_Null is used as a null
303    --  entry, for the cases where a library routine is not used.
304
305    Set_Id : constant E_Array :=
306      (01 => RE_Null,
307       02 => RE_Null,
308       03 => RE_Set_03,
309       04 => RE_Null,
310       05 => RE_Set_05,
311       06 => RE_Set_06,
312       07 => RE_Set_07,
313       08 => RE_Null,
314       09 => RE_Set_09,
315       10 => RE_Set_10,
316       11 => RE_Set_11,
317       12 => RE_Set_12,
318       13 => RE_Set_13,
319       14 => RE_Set_14,
320       15 => RE_Set_15,
321       16 => RE_Null,
322       17 => RE_Set_17,
323       18 => RE_Set_18,
324       19 => RE_Set_19,
325       20 => RE_Set_20,
326       21 => RE_Set_21,
327       22 => RE_Set_22,
328       23 => RE_Set_23,
329       24 => RE_Set_24,
330       25 => RE_Set_25,
331       26 => RE_Set_26,
332       27 => RE_Set_27,
333       28 => RE_Set_28,
334       29 => RE_Set_29,
335       30 => RE_Set_30,
336       31 => RE_Set_31,
337       32 => RE_Null,
338       33 => RE_Set_33,
339       34 => RE_Set_34,
340       35 => RE_Set_35,
341       36 => RE_Set_36,
342       37 => RE_Set_37,
343       38 => RE_Set_38,
344       39 => RE_Set_39,
345       40 => RE_Set_40,
346       41 => RE_Set_41,
347       42 => RE_Set_42,
348       43 => RE_Set_43,
349       44 => RE_Set_44,
350       45 => RE_Set_45,
351       46 => RE_Set_46,
352       47 => RE_Set_47,
353       48 => RE_Set_48,
354       49 => RE_Set_49,
355       50 => RE_Set_50,
356       51 => RE_Set_51,
357       52 => RE_Set_52,
358       53 => RE_Set_53,
359       54 => RE_Set_54,
360       55 => RE_Set_55,
361       56 => RE_Set_56,
362       57 => RE_Set_57,
363       58 => RE_Set_58,
364       59 => RE_Set_59,
365       60 => RE_Set_60,
366       61 => RE_Set_61,
367       62 => RE_Set_62,
368       63 => RE_Set_63);
369
370    --  Array of Set routine entities to be used in the case where the packed
371    --  array is itself a component of a packed structure, and therefore may
372    --  not be fully aligned. This only affects the even sizes, since for the
373    --  odd sizes, we do not get any fixed alignment in any case.
374
375    SetU_Id : constant E_Array :=
376      (01 => RE_Null,
377       02 => RE_Null,
378       03 => RE_Set_03,
379       04 => RE_Null,
380       05 => RE_Set_05,
381       06 => RE_SetU_06,
382       07 => RE_Set_07,
383       08 => RE_Null,
384       09 => RE_Set_09,
385       10 => RE_SetU_10,
386       11 => RE_Set_11,
387       12 => RE_SetU_12,
388       13 => RE_Set_13,
389       14 => RE_SetU_14,
390       15 => RE_Set_15,
391       16 => RE_Null,
392       17 => RE_Set_17,
393       18 => RE_SetU_18,
394       19 => RE_Set_19,
395       20 => RE_SetU_20,
396       21 => RE_Set_21,
397       22 => RE_SetU_22,
398       23 => RE_Set_23,
399       24 => RE_SetU_24,
400       25 => RE_Set_25,
401       26 => RE_SetU_26,
402       27 => RE_Set_27,
403       28 => RE_SetU_28,
404       29 => RE_Set_29,
405       30 => RE_SetU_30,
406       31 => RE_Set_31,
407       32 => RE_Null,
408       33 => RE_Set_33,
409       34 => RE_SetU_34,
410       35 => RE_Set_35,
411       36 => RE_SetU_36,
412       37 => RE_Set_37,
413       38 => RE_SetU_38,
414       39 => RE_Set_39,
415       40 => RE_SetU_40,
416       41 => RE_Set_41,
417       42 => RE_SetU_42,
418       43 => RE_Set_43,
419       44 => RE_SetU_44,
420       45 => RE_Set_45,
421       46 => RE_SetU_46,
422       47 => RE_Set_47,
423       48 => RE_SetU_48,
424       49 => RE_Set_49,
425       50 => RE_SetU_50,
426       51 => RE_Set_51,
427       52 => RE_SetU_52,
428       53 => RE_Set_53,
429       54 => RE_SetU_54,
430       55 => RE_Set_55,
431       56 => RE_SetU_56,
432       57 => RE_Set_57,
433       58 => RE_SetU_58,
434       59 => RE_Set_59,
435       60 => RE_SetU_60,
436       61 => RE_Set_61,
437       62 => RE_SetU_62,
438       63 => RE_Set_63);
439
440    -----------------------
441    -- Local Subprograms --
442    -----------------------
443
444    procedure Compute_Linear_Subscript
445      (Atyp   : Entity_Id;
446       N      : Node_Id;
447       Subscr : out Node_Id);
448    --  Given a constrained array type Atyp, and an indexed component node
449    --  N referencing an array object of this type, build an expression of
450    --  type Standard.Integer representing the zero-based linear subscript
451    --  value. This expression includes any required range checks.
452
453    procedure Convert_To_PAT_Type (Aexp : Node_Id);
454    --  Given an expression of a packed array type, builds a corresponding
455    --  expression whose type is the implementation type used to represent
456    --  the packed array. Aexp is analyzed and resolved on entry and on exit.
457
458    function Known_Aligned_Enough (Obj : Node_Id; Csiz : Nat) return Boolean;
459    --  There are two versions of the Set routines, the ones used when the
460    --  object is known to be sufficiently well aligned given the number of
461    --  bits, and the ones used when the object is not known to be aligned.
462    --  This routine is used to determine which set to use. Obj is a reference
463    --  to the object, and Csiz is the component size of the packed array.
464    --  True is returned if the alignment of object is known to be sufficient,
465    --  defined as 1 for odd bit sizes, 4 for bit sizes divisible by 4, and
466    --  2 otherwise.
467
468    function Make_Shift_Left (N : Node_Id; S : Node_Id) return Node_Id;
469    --  Build a left shift node, checking for the case of a shift count of zero
470
471    function Make_Shift_Right (N : Node_Id; S : Node_Id) return Node_Id;
472    --  Build a right shift node, checking for the case of a shift count of zero
473
474    function RJ_Unchecked_Convert_To
475      (Typ  : Entity_Id;
476       Expr : Node_Id) return Node_Id;
477    --  The packed array code does unchecked conversions which in some cases
478    --  may involve non-discrete types with differing sizes. The semantics of
479    --  such conversions is potentially endian dependent, and the effect we
480    --  want here for such a conversion is to do the conversion in size as
481    --  though numeric items are involved, and we extend or truncate on the
482    --  left side. This happens naturally in the little-endian case, but in
483    --  the big endian case we can get left justification, when what we want
484    --  is right justification. This routine does the unchecked conversion in
485    --  a stepwise manner to ensure that it gives the expected result. Hence
486    --  the name (RJ = Right justified). The parameters Typ and Expr are as
487    --  for the case of a normal Unchecked_Convert_To call.
488
489    procedure Setup_Enumeration_Packed_Array_Reference (N : Node_Id);
490    --  This routine is called in the Get and Set case for arrays that are
491    --  packed but not bit-packed, meaning that they have at least one
492    --  subscript that is of an enumeration type with a non-standard
493    --  representation. This routine modifies the given node to properly
494    --  reference the corresponding packed array type.
495
496    procedure Setup_Inline_Packed_Array_Reference
497      (N      : Node_Id;
498       Atyp   : Entity_Id;
499       Obj    : in out Node_Id;
500       Cmask  : out Uint;
501       Shift  : out Node_Id);
502    --  This procedure performs common processing on the N_Indexed_Component
503    --  parameter given as N, whose prefix is a reference to a packed array.
504    --  This is used for the get and set when the component size is 1,2,4
505    --  or for other component sizes when the packed array type is a modular
506    --  type (i.e. the cases that are handled with inline code).
507    --
508    --  On entry:
509    --
510    --    N is the N_Indexed_Component node for the packed array reference
511    --
512    --    Atyp is the constrained array type (the actual subtype has been
513    --    computed if necessary to obtain the constraints, but this is still
514    --    the original array type, not the Packed_Array_Type value).
515    --
516    --    Obj is the object which is to be indexed. It is always of type Atyp.
517    --
518    --  On return:
519    --
520    --    Obj is the object containing the desired bit field. It is of type
521    --    Unsigned, Long_Unsigned, or Long_Long_Unsigned, and is either the
522    --    entire value, for the small static case, or the proper selected byte
523    --    from the array in the large or dynamic case. This node is analyzed
524    --    and resolved on return.
525    --
526    --    Shift is a node representing the shift count to be used in the
527    --    rotate right instruction that positions the field for access.
528    --    This node is analyzed and resolved on return.
529    --
530    --    Cmask is a mask corresponding to the width of the component field.
531    --    Its value is 2 ** Csize - 1 (e.g. 2#1111# for component size of 4).
532    --
533    --  Note: in some cases the call to this routine may generate actions
534    --  (for handling multi-use references and the generation of the packed
535    --  array type on the fly). Such actions are inserted into the tree
536    --  directly using Insert_Action.
537
538    ------------------------------
539    -- Compute_Linear_Subscript --
540    ------------------------------
541
542    procedure Compute_Linear_Subscript
543      (Atyp   : Entity_Id;
544       N      : Node_Id;
545       Subscr : out Node_Id)
546    is
547       Loc    : constant Source_Ptr := Sloc (N);
548       Oldsub : Node_Id;
549       Newsub : Node_Id;
550       Indx   : Node_Id;
551       Styp   : Entity_Id;
552
553    begin
554       Subscr := Empty;
555
556       --  Loop through dimensions
557
558       Indx   := First_Index (Atyp);
559       Oldsub := First (Expressions (N));
560
561       while Present (Indx) loop
562          Styp := Etype (Indx);
563          Newsub := Relocate_Node (Oldsub);
564
565          --  Get expression for the subscript value. First, if Do_Range_Check
566          --  is set on a subscript, then we must do a range check against the
567          --  original bounds (not the bounds of the packed array type). We do
568          --  this by introducing a subtype conversion.
569
570          if Do_Range_Check (Newsub)
571            and then Etype (Newsub) /= Styp
572          then
573             Newsub := Convert_To (Styp, Newsub);
574          end if;
575
576          --  Now evolve the expression for the subscript. First convert
577          --  the subscript to be zero based and of an integer type.
578
579          --  Case of integer type, where we just subtract to get lower bound
580
581          if Is_Integer_Type (Styp) then
582
583             --  If length of integer type is smaller than standard integer,
584             --  then we convert to integer first, then do the subtract
585
586             --  Integer (subscript) - Integer (Styp'First)
587
588             if Esize (Styp) < Esize (Standard_Integer) then
589                Newsub :=
590                  Make_Op_Subtract (Loc,
591                    Left_Opnd => Convert_To (Standard_Integer, Newsub),
592                  Right_Opnd =>
593                    Convert_To (Standard_Integer,
594                      Make_Attribute_Reference (Loc,
595                        Prefix         => New_Occurrence_Of (Styp, Loc),
596                        Attribute_Name => Name_First)));
597
598             --  For larger integer types, subtract first, then convert to
599             --  integer, this deals with strange long long integer bounds.
600
601             --    Integer (subscript - Styp'First)
602
603             else
604                Newsub :=
605                  Convert_To (Standard_Integer,
606                    Make_Op_Subtract (Loc,
607                      Left_Opnd => Newsub,
608                    Right_Opnd =>
609                      Make_Attribute_Reference (Loc,
610                        Prefix         => New_Occurrence_Of (Styp, Loc),
611                        Attribute_Name => Name_First)));
612             end if;
613
614          --  For the enumeration case, we have to use 'Pos to get the value
615          --  to work with before subtracting the lower bound.
616
617          --    Integer (Styp'Pos (subscr)) - Integer (Styp'Pos (Styp'First));
618
619          --  This is not quite right for bizarre cases where the size of the
620          --  enumeration type is > Integer'Size bits due to rep clause ???
621
622          else
623             pragma Assert (Is_Enumeration_Type (Styp));
624
625             Newsub :=
626               Make_Op_Subtract (Loc,
627                 Left_Opnd => Convert_To (Standard_Integer,
628                   Make_Attribute_Reference (Loc,
629                     Prefix         => New_Occurrence_Of (Styp, Loc),
630                     Attribute_Name => Name_Pos,
631                     Expressions    => New_List (Newsub))),
632
633                 Right_Opnd =>
634                   Convert_To (Standard_Integer,
635                     Make_Attribute_Reference (Loc,
636                       Prefix         => New_Occurrence_Of (Styp, Loc),
637                       Attribute_Name => Name_Pos,
638                       Expressions    => New_List (
639                         Make_Attribute_Reference (Loc,
640                           Prefix         => New_Occurrence_Of (Styp, Loc),
641                           Attribute_Name => Name_First)))));
642          end if;
643
644          Set_Paren_Count (Newsub, 1);
645
646          --  For the first subscript, we just copy that subscript value
647
648          if No (Subscr) then
649             Subscr := Newsub;
650
651          --  Otherwise, we must multiply what we already have by the current
652          --  stride and then add in the new value to the evolving subscript.
653
654          else
655             Subscr :=
656               Make_Op_Add (Loc,
657                 Left_Opnd =>
658                   Make_Op_Multiply (Loc,
659                     Left_Opnd  => Subscr,
660                     Right_Opnd =>
661                       Make_Attribute_Reference (Loc,
662                         Attribute_Name => Name_Range_Length,
663                         Prefix         => New_Occurrence_Of (Styp, Loc))),
664                 Right_Opnd => Newsub);
665          end if;
666
667          --  Move to next subscript
668
669          Next_Index (Indx);
670          Next (Oldsub);
671       end loop;
672    end Compute_Linear_Subscript;
673
674    -------------------------
675    -- Convert_To_PAT_Type --
676    -------------------------
677
678    --  The PAT is always obtained from the actual subtype
679
680    procedure Convert_To_PAT_Type (Aexp : Node_Id) is
681       Act_ST : Entity_Id;
682
683    begin
684       Convert_To_Actual_Subtype (Aexp);
685       Act_ST := Underlying_Type (Etype (Aexp));
686       Create_Packed_Array_Type (Act_ST);
687
688       --  Just replace the etype with the packed array type. This works because
689       --  the expression will not be further analyzed, and Gigi considers the
690       --  two types equivalent in any case.
691
692       --  This is not strictly the case ??? If the reference is an actual in
693       --  call, the expansion of the prefix is delayed, and must be reanalyzed,
694       --  see Reset_Packed_Prefix. On the other hand, if the prefix is a simple
695       --  array reference, reanalysis can produce spurious type errors when the
696       --  PAT type is replaced again with the original type of the array. Same
697       --  for the case of a dereference. The following is correct and minimal,
698       --  but the handling of more complex packed expressions in actuals is
699       --  confused. Probably the problem only remains for actuals in calls.
700
701       Set_Etype (Aexp, Packed_Array_Type (Act_ST));
702
703       if Is_Entity_Name (Aexp)
704         or else
705            (Nkind (Aexp) = N_Indexed_Component
706              and then Is_Entity_Name (Prefix (Aexp)))
707         or else Nkind (Aexp) = N_Explicit_Dereference
708       then
709          Set_Analyzed (Aexp);
710       end if;
711    end Convert_To_PAT_Type;
712
713    ------------------------------
714    -- Create_Packed_Array_Type --
715    ------------------------------
716
717    procedure Create_Packed_Array_Type (Typ : Entity_Id) is
718       Loc      : constant Source_Ptr := Sloc (Typ);
719       Ctyp     : constant Entity_Id  := Component_Type (Typ);
720       Csize    : constant Uint       := Component_Size (Typ);
721
722       Ancest   : Entity_Id;
723       PB_Type  : Entity_Id;
724       PASize   : Uint;
725       Decl     : Node_Id;
726       PAT      : Entity_Id;
727       Len_Dim  : Node_Id;
728       Len_Expr : Node_Id;
729       Len_Bits : Uint;
730       Bits_U1  : Node_Id;
731       PAT_High : Node_Id;
732       Btyp     : Entity_Id;
733       Lit      : Node_Id;
734
735       procedure Install_PAT;
736       --  This procedure is called with Decl set to the declaration for the
737       --  packed array type. It creates the type and installs it as required.
738
739       procedure Set_PB_Type;
740       --  Sets PB_Type to Packed_Bytes{1,2,4} as required by the alignment
741       --  requirements (see documentation in the spec of this package).
742
743       -----------------
744       -- Install_PAT --
745       -----------------
746
747       procedure Install_PAT is
748          Pushed_Scope : Boolean := False;
749
750       begin
751          --  We do not want to put the declaration we have created in the tree
752          --  since it is often hard, and sometimes impossible to find a proper
753          --  place for it (the impossible case arises for a packed array type
754          --  with bounds depending on the discriminant, a declaration cannot
755          --  be put inside the record, and the reference to the discriminant
756          --  cannot be outside the record).
757
758          --  The solution is to analyze the declaration while temporarily
759          --  attached to the tree at an appropriate point, and then we install
760          --  the resulting type as an Itype in the packed array type field of
761          --  the original type, so that no explicit declaration is required.
762
763          --  Note: the packed type is created in the scope of its parent
764          --  type. There are at least some cases where the current scope
765          --  is deeper, and so when this is the case, we temporarily reset
766          --  the scope for the definition. This is clearly safe, since the
767          --  first use of the packed array type will be the implicit
768          --  reference from the corresponding unpacked type when it is
769          --  elaborated.
770
771          if Is_Itype (Typ) then
772             Set_Parent (Decl, Associated_Node_For_Itype (Typ));
773          else
774             Set_Parent (Decl, Declaration_Node (Typ));
775          end if;
776
777          if Scope (Typ) /= Current_Scope then
778             Push_Scope (Scope (Typ));
779             Pushed_Scope := True;
780          end if;
781
782          Set_Is_Itype (PAT, True);
783          Set_Packed_Array_Type (Typ, PAT);
784          Analyze (Decl, Suppress => All_Checks);
785
786          if Pushed_Scope then
787             Pop_Scope;
788          end if;
789
790          --  Set Esize and RM_Size to the actual size of the packed object
791          --  Do not reset RM_Size if already set, as happens in the case of
792          --  a modular type.
793
794          if Unknown_Esize (PAT) then
795             Set_Esize (PAT, PASize);
796          end if;
797
798          if Unknown_RM_Size (PAT) then
799             Set_RM_Size (PAT, PASize);
800          end if;
801
802          Adjust_Esize_Alignment (PAT);
803
804          --  Set remaining fields of packed array type
805
806          Init_Alignment                (PAT);
807          Set_Parent                    (PAT, Empty);
808          Set_Associated_Node_For_Itype (PAT, Typ);
809          Set_Is_Packed_Array_Type      (PAT, True);
810          Set_Original_Array_Type       (PAT, Typ);
811
812          --  We definitely do not want to delay freezing for packed array
813          --  types. This is of particular importance for the itypes that
814          --  are generated for record components depending on discriminants
815          --  where there is no place to put the freeze node.
816
817          Set_Has_Delayed_Freeze (PAT, False);
818          Set_Has_Delayed_Freeze (Etype (PAT), False);
819
820          --  If we did allocate a freeze node, then clear out the reference
821          --  since it is obsolete (should we delete the freeze node???)
822
823          Set_Freeze_Node (PAT, Empty);
824          Set_Freeze_Node (Etype (PAT), Empty);
825       end Install_PAT;
826
827       -----------------
828       -- Set_PB_Type --
829       -----------------
830
831       procedure Set_PB_Type is
832       begin
833          --  If the user has specified an explicit alignment for the
834          --  type or component, take it into account.
835
836          if Csize <= 2 or else Csize = 4 or else Csize mod 2 /= 0
837            or else Alignment (Typ) = 1
838            or else Component_Alignment (Typ) = Calign_Storage_Unit
839          then
840             PB_Type := RTE (RE_Packed_Bytes1);
841
842          elsif Csize mod 4 /= 0
843            or else Alignment (Typ) = 2
844          then
845             PB_Type := RTE (RE_Packed_Bytes2);
846
847          else
848             PB_Type := RTE (RE_Packed_Bytes4);
849          end if;
850       end Set_PB_Type;
851
852    --  Start of processing for Create_Packed_Array_Type
853
854    begin
855       --  If we already have a packed array type, nothing to do
856
857       if Present (Packed_Array_Type (Typ)) then
858          return;
859       end if;
860
861       --  If our immediate ancestor subtype is constrained, and it already
862       --  has a packed array type, then just share the same type, since the
863       --  bounds must be the same. If the ancestor is not an array type but
864       --  a private type, as can happen with multiple instantiations, create
865       --  a new packed type, to avoid privacy issues.
866
867       if Ekind (Typ) = E_Array_Subtype then
868          Ancest := Ancestor_Subtype (Typ);
869
870          if Present (Ancest)
871            and then Is_Array_Type (Ancest)
872            and then Is_Constrained (Ancest)
873            and then Present (Packed_Array_Type (Ancest))
874          then
875             Set_Packed_Array_Type (Typ, Packed_Array_Type (Ancest));
876             return;
877          end if;
878       end if;
879
880       --  We preset the result type size from the size of the original array
881       --  type, since this size clearly belongs to the packed array type. The
882       --  size of the conceptual unpacked type is always set to unknown.
883
884       PASize := RM_Size (Typ);
885
886       --  Case of an array where at least one index is of an enumeration
887       --  type with a non-standard representation, but the component size
888       --  is not appropriate for bit packing. This is the case where we
889       --  have Is_Packed set (we would never be in this unit otherwise),
890       --  but Is_Bit_Packed_Array is false.
891
892       --  Note that if the component size is appropriate for bit packing,
893       --  then the circuit for the computation of the subscript properly
894       --  deals with the non-standard enumeration type case by taking the
895       --  Pos anyway.
896
897       if not Is_Bit_Packed_Array (Typ) then
898
899          --  Here we build a declaration:
900
901          --    type tttP is array (index1, index2, ...) of component_type
902
903          --  where index1, index2, are the index types. These are the same
904          --  as the index types of the original array, except for the non-
905          --  standard representation enumeration type case, where we have
906          --  two subcases.
907
908          --  For the unconstrained array case, we use
909
910          --    Natural range <>
911
912          --  For the constrained case, we use
913
914          --    Natural range Enum_Type'Pos (Enum_Type'First) ..
915          --                  Enum_Type'Pos (Enum_Type'Last);
916
917          PAT :=
918            Make_Defining_Identifier (Loc,
919              Chars => New_External_Name (Chars (Typ), 'P'));
920
921          Set_Packed_Array_Type (Typ, PAT);
922
923          declare
924             Indexes   : constant List_Id := New_List;
925             Indx      : Node_Id;
926             Indx_Typ  : Entity_Id;
927             Enum_Case : Boolean;
928             Typedef   : Node_Id;
929
930          begin
931             Indx := First_Index (Typ);
932
933             while Present (Indx) loop
934                Indx_Typ := Etype (Indx);
935
936                Enum_Case := Is_Enumeration_Type (Indx_Typ)
937                               and then Has_Non_Standard_Rep (Indx_Typ);
938
939                --  Unconstrained case
940
941                if not Is_Constrained (Typ) then
942                   if Enum_Case then
943                      Indx_Typ := Standard_Natural;
944                   end if;
945
946                   Append_To (Indexes, New_Occurrence_Of (Indx_Typ, Loc));
947
948                --  Constrained case
949
950                else
951                   if not Enum_Case then
952                      Append_To (Indexes, New_Occurrence_Of (Indx_Typ, Loc));
953
954                   else
955                      Append_To (Indexes,
956                        Make_Subtype_Indication (Loc,
957                          Subtype_Mark =>
958                            New_Occurrence_Of (Standard_Natural, Loc),
959                          Constraint =>
960                            Make_Range_Constraint (Loc,
961                              Range_Expression =>
962                                Make_Range (Loc,
963                                  Low_Bound =>
964                                    Make_Attribute_Reference (Loc,
965                                      Prefix         =>
966                                        New_Occurrence_Of (Indx_Typ, Loc),
967                                      Attribute_Name => Name_Pos,
968                                      Expressions    => New_List (
969                                        Make_Attribute_Reference (Loc,
970                                          Prefix         =>
971                                            New_Occurrence_Of (Indx_Typ, Loc),
972                                          Attribute_Name => Name_First))),
973
974                                  High_Bound =>
975                                    Make_Attribute_Reference (Loc,
976                                      Prefix         =>
977                                        New_Occurrence_Of (Indx_Typ, Loc),
978                                      Attribute_Name => Name_Pos,
979                                      Expressions    => New_List (
980                                        Make_Attribute_Reference (Loc,
981                                          Prefix         =>
982                                            New_Occurrence_Of (Indx_Typ, Loc),
983                                          Attribute_Name => Name_Last)))))));
984
985                   end if;
986                end if;
987
988                Next_Index (Indx);
989             end loop;
990
991             if not Is_Constrained (Typ) then
992                Typedef :=
993                  Make_Unconstrained_Array_Definition (Loc,
994                    Subtype_Marks => Indexes,
995                    Component_Definition =>
996                      Make_Component_Definition (Loc,
997                        Aliased_Present    => False,
998                        Subtype_Indication =>
999                           New_Occurrence_Of (Ctyp, Loc)));
1000
1001             else
1002                Typedef :=
1003                   Make_Constrained_Array_Definition (Loc,
1004                     Discrete_Subtype_Definitions => Indexes,
1005                     Component_Definition =>
1006                       Make_Component_Definition (Loc,
1007                         Aliased_Present    => False,
1008                         Subtype_Indication =>
1009                           New_Occurrence_Of (Ctyp, Loc)));
1010             end if;
1011
1012             Decl :=
1013               Make_Full_Type_Declaration (Loc,
1014                 Defining_Identifier => PAT,
1015                 Type_Definition => Typedef);
1016          end;
1017
1018          --  Set type as packed array type and install it
1019
1020          Set_Is_Packed_Array_Type (PAT);
1021          Install_PAT;
1022          return;
1023
1024       --  Case of bit-packing required for unconstrained array. We create
1025       --  a subtype that is equivalent to use Packed_Bytes{1,2,4} as needed.
1026
1027       elsif not Is_Constrained (Typ) then
1028          PAT :=
1029            Make_Defining_Identifier (Loc,
1030              Chars => Make_Packed_Array_Type_Name (Typ, Csize));
1031
1032          Set_Packed_Array_Type (Typ, PAT);
1033          Set_PB_Type;
1034
1035          Decl :=
1036            Make_Subtype_Declaration (Loc,
1037              Defining_Identifier => PAT,
1038                Subtype_Indication => New_Occurrence_Of (PB_Type, Loc));
1039          Install_PAT;
1040          return;
1041
1042       --  Remaining code is for the case of bit-packing for constrained array
1043
1044       --  The name of the packed array subtype is
1045
1046       --    ttt___Xsss
1047
1048       --  where sss is the component size in bits and ttt is the name of
1049       --  the parent packed type.
1050
1051       else
1052          PAT :=
1053            Make_Defining_Identifier (Loc,
1054              Chars => Make_Packed_Array_Type_Name (Typ, Csize));
1055
1056          Set_Packed_Array_Type (Typ, PAT);
1057
1058          --  Build an expression for the length of the array in bits.
1059          --  This is the product of the length of each of the dimensions
1060
1061          declare
1062             J : Nat := 1;
1063
1064          begin
1065             Len_Expr := Empty; -- suppress junk warning
1066
1067             loop
1068                Len_Dim :=
1069                  Make_Attribute_Reference (Loc,
1070                    Attribute_Name => Name_Length,
1071                    Prefix         => New_Occurrence_Of (Typ, Loc),
1072                    Expressions    => New_List (
1073                      Make_Integer_Literal (Loc, J)));
1074
1075                if J = 1 then
1076                   Len_Expr := Len_Dim;
1077
1078                else
1079                   Len_Expr :=
1080                     Make_Op_Multiply (Loc,
1081                       Left_Opnd  => Len_Expr,
1082                       Right_Opnd => Len_Dim);
1083                end if;
1084
1085                J := J + 1;
1086                exit when J > Number_Dimensions (Typ);
1087             end loop;
1088          end;
1089
1090          --  Temporarily attach the length expression to the tree and analyze
1091          --  and resolve it, so that we can test its value. We assume that the
1092          --  total length fits in type Integer. This expression may involve
1093          --  discriminants, so we treat it as a default/per-object expression.
1094
1095          Set_Parent (Len_Expr, Typ);
1096          Preanalyze_Spec_Expression (Len_Expr, Standard_Long_Long_Integer);
1097
1098          --  Use a modular type if possible. We can do this if we have
1099          --  static bounds, and the length is small enough, and the length
1100          --  is not zero. We exclude the zero length case because the size
1101          --  of things is always at least one, and the zero length object
1102          --  would have an anomalous size.
1103
1104          if Compile_Time_Known_Value (Len_Expr) then
1105             Len_Bits := Expr_Value (Len_Expr) * Csize;
1106
1107             --  Check for size known to be too large
1108
1109             if Len_Bits >
1110               Uint_2 ** (Standard_Integer_Size - 1) * System_Storage_Unit
1111             then
1112                if System_Storage_Unit = 8 then
1113                   Error_Msg_N
1114                     ("packed array size cannot exceed " &
1115                      "Integer''Last bytes", Typ);
1116                else
1117                   Error_Msg_N
1118                     ("packed array size cannot exceed " &
1119                      "Integer''Last storage units", Typ);
1120                end if;
1121
1122                --  Reset length to arbitrary not too high value to continue
1123
1124                Len_Expr := Make_Integer_Literal (Loc, 65535);
1125                Analyze_And_Resolve (Len_Expr, Standard_Long_Long_Integer);
1126             end if;
1127
1128             --  We normally consider small enough to mean no larger than the
1129             --  value of System_Max_Binary_Modulus_Power, checking that in the
1130             --  case of values longer than word size, we have long shifts.
1131
1132             if Len_Bits > 0
1133               and then
1134                 (Len_Bits <= System_Word_Size
1135                    or else (Len_Bits <= System_Max_Binary_Modulus_Power
1136                               and then Support_Long_Shifts_On_Target))
1137             then
1138                --  We can use the modular type, it has the form:
1139
1140                --    subtype tttPn is btyp
1141                --      range 0 .. 2 ** ((Typ'Length (1)
1142                --                * ... * Typ'Length (n)) * Csize) - 1;
1143
1144                --  The bounds are statically known, and btyp is one of the
1145                --  unsigned types, depending on the length.
1146
1147                if Len_Bits <= Standard_Short_Short_Integer_Size then
1148                   Btyp := RTE (RE_Short_Short_Unsigned);
1149
1150                elsif Len_Bits <= Standard_Short_Integer_Size then
1151                   Btyp := RTE (RE_Short_Unsigned);
1152
1153                elsif Len_Bits <= Standard_Integer_Size then
1154                   Btyp := RTE (RE_Unsigned);
1155
1156                elsif Len_Bits <= Standard_Long_Integer_Size then
1157                   Btyp := RTE (RE_Long_Unsigned);
1158
1159                else
1160                   Btyp := RTE (RE_Long_Long_Unsigned);
1161                end if;
1162
1163                Lit := Make_Integer_Literal (Loc, 2 ** Len_Bits - 1);
1164                Set_Print_In_Hex (Lit);
1165
1166                Decl :=
1167                  Make_Subtype_Declaration (Loc,
1168                    Defining_Identifier => PAT,
1169                      Subtype_Indication =>
1170                        Make_Subtype_Indication (Loc,
1171                          Subtype_Mark => New_Occurrence_Of (Btyp, Loc),
1172
1173                          Constraint =>
1174                            Make_Range_Constraint (Loc,
1175                              Range_Expression =>
1176                                Make_Range (Loc,
1177                                  Low_Bound =>
1178                                    Make_Integer_Literal (Loc, 0),
1179                                  High_Bound => Lit))));
1180
1181                if PASize = Uint_0 then
1182                   PASize := Len_Bits;
1183                end if;
1184
1185                Install_PAT;
1186
1187                --  Propagate a given alignment to the modular type. This can
1188                --  cause it to be under-aligned, but that's OK.
1189
1190                if Present (Alignment_Clause (Typ)) then
1191                   Set_Alignment (PAT, Alignment (Typ));
1192                end if;
1193
1194                return;
1195             end if;
1196          end if;
1197
1198          --  Could not use a modular type, for all other cases, we build
1199          --  a packed array subtype:
1200
1201          --    subtype tttPn is
1202          --      System.Packed_Bytes{1,2,4} (0 .. (Bits + 7) / 8 - 1);
1203
1204          --  Bits is the length of the array in bits
1205
1206          Set_PB_Type;
1207
1208          Bits_U1 :=
1209            Make_Op_Add (Loc,
1210              Left_Opnd =>
1211                Make_Op_Multiply (Loc,
1212                  Left_Opnd  =>
1213                    Make_Integer_Literal (Loc, Csize),
1214                  Right_Opnd => Len_Expr),
1215
1216              Right_Opnd =>
1217                Make_Integer_Literal (Loc, 7));
1218
1219          Set_Paren_Count (Bits_U1, 1);
1220
1221          PAT_High :=
1222            Make_Op_Subtract (Loc,
1223              Left_Opnd =>
1224                Make_Op_Divide (Loc,
1225                  Left_Opnd => Bits_U1,
1226                  Right_Opnd => Make_Integer_Literal (Loc, 8)),
1227              Right_Opnd => Make_Integer_Literal (Loc, 1));
1228
1229          Decl :=
1230            Make_Subtype_Declaration (Loc,
1231              Defining_Identifier => PAT,
1232                Subtype_Indication =>
1233                  Make_Subtype_Indication (Loc,
1234                    Subtype_Mark => New_Occurrence_Of (PB_Type, Loc),
1235                    Constraint =>
1236                      Make_Index_Or_Discriminant_Constraint (Loc,
1237                        Constraints => New_List (
1238                          Make_Range (Loc,
1239                            Low_Bound =>
1240                              Make_Integer_Literal (Loc, 0),
1241                            High_Bound =>
1242                              Convert_To (Standard_Integer, PAT_High))))));
1243
1244          Install_PAT;
1245
1246          --  Currently the code in this unit requires that packed arrays
1247          --  represented by non-modular arrays of bytes be on a byte
1248          --  boundary for bit sizes handled by System.Pack_nn units.
1249          --  That's because these units assume the array being accessed
1250          --  starts on a byte boundary.
1251
1252          if Get_Id (UI_To_Int (Csize)) /= RE_Null then
1253             Set_Must_Be_On_Byte_Boundary (Typ);
1254          end if;
1255       end if;
1256    end Create_Packed_Array_Type;
1257
1258    -----------------------------------
1259    -- Expand_Bit_Packed_Element_Set --
1260    -----------------------------------
1261
1262    procedure Expand_Bit_Packed_Element_Set (N : Node_Id) is
1263       Loc : constant Source_Ptr := Sloc (N);
1264       Lhs : constant Node_Id    := Name (N);
1265
1266       Ass_OK : constant Boolean := Assignment_OK (Lhs);
1267       --  Used to preserve assignment OK status when assignment is rewritten
1268
1269       Rhs : Node_Id := Expression (N);
1270       --  Initially Rhs is the right hand side value, it will be replaced
1271       --  later by an appropriate unchecked conversion for the assignment.
1272
1273       Obj    : Node_Id;
1274       Atyp   : Entity_Id;
1275       PAT    : Entity_Id;
1276       Ctyp   : Entity_Id;
1277       Csiz   : Int;
1278       Cmask  : Uint;
1279
1280       Shift : Node_Id;
1281       --  The expression for the shift value that is required
1282
1283       Shift_Used : Boolean := False;
1284       --  Set True if Shift has been used in the generated code at least
1285       --  once, so that it must be duplicated if used again
1286
1287       New_Lhs : Node_Id;
1288       New_Rhs : Node_Id;
1289
1290       Rhs_Val_Known : Boolean;
1291       Rhs_Val       : Uint;
1292       --  If the value of the right hand side as an integer constant is
1293       --  known at compile time, Rhs_Val_Known is set True, and Rhs_Val
1294       --  contains the value. Otherwise Rhs_Val_Known is set False, and
1295       --  the Rhs_Val is undefined.
1296
1297       function Get_Shift return Node_Id;
1298       --  Function used to get the value of Shift, making sure that it
1299       --  gets duplicated if the function is called more than once.
1300
1301       ---------------
1302       -- Get_Shift --
1303       ---------------
1304
1305       function Get_Shift return Node_Id is
1306       begin
1307          --  If we used the shift value already, then duplicate it. We
1308          --  set a temporary parent in case actions have to be inserted.
1309
1310          if Shift_Used then
1311             Set_Parent (Shift, N);
1312             return Duplicate_Subexpr_No_Checks (Shift);
1313
1314          --  If first time, use Shift unchanged, and set flag for first use
1315
1316          else
1317             Shift_Used := True;
1318             return Shift;
1319          end if;
1320       end Get_Shift;
1321
1322    --  Start of processing for Expand_Bit_Packed_Element_Set
1323
1324    begin
1325       pragma Assert (Is_Bit_Packed_Array (Etype (Prefix (Lhs))));
1326
1327       Obj := Relocate_Node (Prefix (Lhs));
1328       Convert_To_Actual_Subtype (Obj);
1329       Atyp := Etype (Obj);
1330       PAT  := Packed_Array_Type (Atyp);
1331       Ctyp := Component_Type (Atyp);
1332       Csiz := UI_To_Int (Component_Size (Atyp));
1333
1334       --  We convert the right hand side to the proper subtype to ensure
1335       --  that an appropriate range check is made (since the normal range
1336       --  check from assignment will be lost in the transformations). This
1337       --  conversion is analyzed immediately so that subsequent processing
1338       --  can work with an analyzed Rhs (and e.g. look at its Etype)
1339
1340       --  If the right-hand side is a string literal, create a temporary for
1341       --  it, constant-folding is not ready to wrap the bit representation
1342       --  of a string literal.
1343
1344       if Nkind (Rhs) = N_String_Literal then
1345          declare
1346             Decl : Node_Id;
1347          begin
1348             Decl :=
1349               Make_Object_Declaration (Loc,
1350                 Defining_Identifier =>
1351                   Make_Defining_Identifier (Loc,  New_Internal_Name ('T')),
1352                 Object_Definition => New_Occurrence_Of (Ctyp, Loc),
1353                 Expression => New_Copy_Tree (Rhs));
1354
1355             Insert_Actions (N, New_List (Decl));
1356             Rhs := New_Occurrence_Of (Defining_Identifier (Decl), Loc);
1357          end;
1358       end if;
1359
1360       Rhs := Convert_To (Ctyp, Rhs);
1361       Set_Parent (Rhs, N);
1362
1363       --  If we are building the initialization procedure for a packed array,
1364       --  and Initialize_Scalars is enabled, each component assignment is an
1365       --  out-of-range value by design.  Compile this value without checks,
1366       --  because a call to the array init_proc must not raise an exception.
1367
1368       if Within_Init_Proc
1369         and then Initialize_Scalars
1370       then
1371          Analyze_And_Resolve (Rhs, Ctyp, Suppress => All_Checks);
1372       else
1373          Analyze_And_Resolve (Rhs, Ctyp);
1374       end if;
1375
1376       --  Case of component size 1,2,4 or any component size for the modular
1377       --  case. These are the cases for which we can inline the code.
1378
1379       if Csiz = 1 or else Csiz = 2 or else Csiz = 4
1380         or else (Present (PAT) and then Is_Modular_Integer_Type (PAT))
1381       then
1382          Setup_Inline_Packed_Array_Reference (Lhs, Atyp, Obj, Cmask, Shift);
1383
1384          --  The statement to be generated is:
1385
1386          --    Obj := atyp!((Obj and Mask1) or (shift_left (rhs, shift)))
1387
1388          --      where mask1 is obtained by shifting Cmask left Shift bits
1389          --      and then complementing the result.
1390
1391          --      the "and Mask1" is omitted if rhs is constant and all 1 bits
1392
1393          --      the "or ..." is omitted if rhs is constant and all 0 bits
1394
1395          --      rhs is converted to the appropriate type
1396
1397          --      The result is converted back to the array type, since
1398          --      otherwise we lose knowledge of the packed nature.
1399
1400          --  Determine if right side is all 0 bits or all 1 bits
1401
1402          if Compile_Time_Known_Value (Rhs) then
1403             Rhs_Val       := Expr_Rep_Value (Rhs);
1404             Rhs_Val_Known := True;
1405
1406          --  The following test catches the case of an unchecked conversion
1407          --  of an integer literal. This results from optimizing aggregates
1408          --  of packed types.
1409
1410          elsif Nkind (Rhs) = N_Unchecked_Type_Conversion
1411            and then Compile_Time_Known_Value (Expression (Rhs))
1412          then
1413             Rhs_Val       := Expr_Rep_Value (Expression (Rhs));
1414             Rhs_Val_Known := True;
1415
1416          else
1417             Rhs_Val       := No_Uint;
1418             Rhs_Val_Known := False;
1419          end if;
1420
1421          --  Some special checks for the case where the right hand value
1422          --  is known at compile time. Basically we have to take care of
1423          --  the implicit conversion to the subtype of the component object.
1424
1425          if Rhs_Val_Known then
1426
1427             --  If we have a biased component type then we must manually do
1428             --  the biasing, since we are taking responsibility in this case
1429             --  for constructing the exact bit pattern to be used.
1430
1431             if Has_Biased_Representation (Ctyp) then
1432                Rhs_Val := Rhs_Val - Expr_Rep_Value (Type_Low_Bound (Ctyp));
1433             end if;
1434
1435             --  For a negative value, we manually convert the twos complement
1436             --  value to a corresponding unsigned value, so that the proper
1437             --  field width is maintained. If we did not do this, we would
1438             --  get too many leading sign bits later on.
1439
1440             if Rhs_Val < 0 then
1441                Rhs_Val := 2 ** UI_From_Int (Csiz) + Rhs_Val;
1442             end if;
1443          end if;
1444
1445          --  Now create copies removing side effects. Note that in some
1446          --  complex cases, this may cause the fact that we have already
1447          --  set a packed array type on Obj to get lost. So we save the
1448          --  type of Obj, and make sure it is reset properly.
1449
1450          declare
1451             T : constant Entity_Id := Etype (Obj);
1452          begin
1453             New_Lhs := Duplicate_Subexpr (Obj, True);
1454             New_Rhs := Duplicate_Subexpr_No_Checks (Obj);
1455             Set_Etype (Obj, T);
1456             Set_Etype (New_Lhs, T);
1457             Set_Etype (New_Rhs, T);
1458          end;
1459
1460          --  First we deal with the "and"
1461
1462          if not Rhs_Val_Known or else Rhs_Val /= Cmask then
1463             declare
1464                Mask1 : Node_Id;
1465                Lit   : Node_Id;
1466
1467             begin
1468                if Compile_Time_Known_Value (Shift) then
1469                   Mask1 :=
1470                     Make_Integer_Literal (Loc,
1471                       Modulus (Etype (Obj)) - 1 -
1472                                  (Cmask * (2 ** Expr_Value (Get_Shift))));
1473                   Set_Print_In_Hex (Mask1);
1474
1475                else
1476                   Lit := Make_Integer_Literal (Loc, Cmask);
1477                   Set_Print_In_Hex (Lit);
1478                   Mask1 :=
1479                     Make_Op_Not (Loc,
1480                       Right_Opnd => Make_Shift_Left (Lit, Get_Shift));
1481                end if;
1482
1483                New_Rhs :=
1484                  Make_Op_And (Loc,
1485                    Left_Opnd  => New_Rhs,
1486                    Right_Opnd => Mask1);
1487             end;
1488          end if;
1489
1490          --  Then deal with the "or"
1491
1492          if not Rhs_Val_Known or else Rhs_Val /= 0 then
1493             declare
1494                Or_Rhs : Node_Id;
1495
1496                procedure Fixup_Rhs;
1497                --  Adjust Rhs by bias if biased representation for components
1498                --  or remove extraneous high order sign bits if signed.
1499
1500                procedure Fixup_Rhs is
1501                   Etyp : constant Entity_Id := Etype (Rhs);
1502
1503                begin
1504                   --  For biased case, do the required biasing by simply
1505                   --  converting to the biased subtype (the conversion
1506                   --  will generate the required bias).
1507
1508                   if Has_Biased_Representation (Ctyp) then
1509                      Rhs := Convert_To (Ctyp, Rhs);
1510
1511                   --  For a signed integer type that is not biased, generate
1512                   --  a conversion to unsigned to strip high order sign bits.
1513
1514                   elsif Is_Signed_Integer_Type (Ctyp) then
1515                      Rhs := Unchecked_Convert_To (RTE (Bits_Id (Csiz)), Rhs);
1516                   end if;
1517
1518                   --  Set Etype, since it can be referenced before the
1519                   --  node is completely analyzed.
1520
1521                   Set_Etype (Rhs, Etyp);
1522
1523                   --  We now need to do an unchecked conversion of the
1524                   --  result to the target type, but it is important that
1525                   --  this conversion be a right justified conversion and
1526                   --  not a left justified conversion.
1527
1528                   Rhs := RJ_Unchecked_Convert_To (Etype (Obj), Rhs);
1529
1530                end Fixup_Rhs;
1531
1532             begin
1533                if Rhs_Val_Known
1534                  and then Compile_Time_Known_Value (Get_Shift)
1535                then
1536                   Or_Rhs :=
1537                     Make_Integer_Literal (Loc,
1538                       Rhs_Val * (2 ** Expr_Value (Get_Shift)));
1539                   Set_Print_In_Hex (Or_Rhs);
1540
1541                else
1542                   --  We have to convert the right hand side to Etype (Obj).
1543                   --  A special case arises if what we have now is a Val
1544                   --  attribute reference whose expression type is Etype (Obj).
1545                   --  This happens for assignments of fields from the same
1546                   --  array. In this case we get the required right hand side
1547                   --  by simply removing the inner attribute reference.
1548
1549                   if Nkind (Rhs) = N_Attribute_Reference
1550                     and then Attribute_Name (Rhs) = Name_Val
1551                     and then Etype (First (Expressions (Rhs))) = Etype (Obj)
1552                   then
1553                      Rhs := Relocate_Node (First (Expressions (Rhs)));
1554                      Fixup_Rhs;
1555
1556                   --  If the value of the right hand side is a known integer
1557                   --  value, then just replace it by an untyped constant,
1558                   --  which will be properly retyped when we analyze and
1559                   --  resolve the expression.
1560
1561                   elsif Rhs_Val_Known then
1562
1563                      --  Note that Rhs_Val has already been normalized to
1564                      --  be an unsigned value with the proper number of bits.
1565
1566                      Rhs :=
1567                        Make_Integer_Literal (Loc, Rhs_Val);
1568
1569                   --  Otherwise we need an unchecked conversion
1570
1571                   else
1572                      Fixup_Rhs;
1573                   end if;
1574
1575                   Or_Rhs := Make_Shift_Left (Rhs, Get_Shift);
1576                end if;
1577
1578                if Nkind (New_Rhs) = N_Op_And then
1579                   Set_Paren_Count (New_Rhs, 1);
1580                end if;
1581
1582                New_Rhs :=
1583                  Make_Op_Or (Loc,
1584                    Left_Opnd  => New_Rhs,
1585                    Right_Opnd => Or_Rhs);
1586             end;
1587          end if;
1588
1589          --  Now do the rewrite
1590
1591          Rewrite (N,
1592            Make_Assignment_Statement (Loc,
1593              Name       => New_Lhs,
1594              Expression =>
1595                Unchecked_Convert_To (Etype (New_Lhs), New_Rhs)));
1596          Set_Assignment_OK (Name (N), Ass_OK);
1597
1598       --  All other component sizes for non-modular case
1599
1600       else
1601          --  We generate
1602
1603          --    Set_nn (Arr'address, Subscr, Bits_nn!(Rhs))
1604
1605          --  where Subscr is the computed linear subscript
1606
1607          declare
1608             Bits_nn : constant Entity_Id := RTE (Bits_Id (Csiz));
1609             Set_nn  : Entity_Id;
1610             Subscr  : Node_Id;
1611             Atyp    : Entity_Id;
1612
1613          begin
1614             if No (Bits_nn) then
1615
1616                --  Error, most likely High_Integrity_Mode restriction
1617
1618                return;
1619             end if;
1620
1621             --  Acquire proper Set entity. We use the aligned or unaligned
1622             --  case as appropriate.
1623
1624             if Known_Aligned_Enough (Obj, Csiz) then
1625                Set_nn := RTE (Set_Id (Csiz));
1626             else
1627                Set_nn := RTE (SetU_Id (Csiz));
1628             end if;
1629
1630             --  Now generate the set reference
1631
1632             Obj := Relocate_Node (Prefix (Lhs));
1633             Convert_To_Actual_Subtype (Obj);
1634             Atyp := Etype (Obj);
1635             Compute_Linear_Subscript (Atyp, Lhs, Subscr);
1636
1637             --  Below we must make the assumption that Obj is
1638             --  at least byte aligned, since otherwise its address
1639             --  cannot be taken. The assumption holds since the
1640             --  only arrays that can be misaligned are small packed
1641             --  arrays which are implemented as a modular type, and
1642             --  that is not the case here.
1643
1644             Rewrite (N,
1645               Make_Procedure_Call_Statement (Loc,
1646                   Name => New_Occurrence_Of (Set_nn, Loc),
1647                   Parameter_Associations => New_List (
1648                     Make_Attribute_Reference (Loc,
1649                       Prefix         => Obj,
1650                       Attribute_Name => Name_Address),
1651                     Subscr,
1652                     Unchecked_Convert_To (Bits_nn,
1653                       Convert_To (Ctyp, Rhs)))));
1654
1655          end;
1656       end if;
1657
1658       Analyze (N, Suppress => All_Checks);
1659    end Expand_Bit_Packed_Element_Set;
1660
1661    -------------------------------------
1662    -- Expand_Packed_Address_Reference --
1663    -------------------------------------
1664
1665    procedure Expand_Packed_Address_Reference (N : Node_Id) is
1666       Loc    : constant Source_Ptr := Sloc (N);
1667       Ploc   : Source_Ptr;
1668       Pref   : Node_Id;
1669       Expr   : Node_Id;
1670       Term   : Node_Id;
1671       Atyp   : Entity_Id;
1672       Subscr : Node_Id;
1673
1674    begin
1675       Pref := Prefix (N);
1676       Expr := Empty;
1677
1678       --  We build up an expression serially that has the form
1679
1680       --    outer_object'Address
1681       --      + (linear-subscript * component_size  for each array reference
1682       --      +  field'Bit_Position                 for each record field
1683       --      +  ...
1684       --      +  ...) / Storage_Unit;
1685
1686       --  Some additional conversions are required to deal with the addition
1687       --  operation, which is not normally visible to generated code.
1688
1689       loop
1690          Ploc := Sloc (Pref);
1691
1692          if Nkind (Pref) = N_Indexed_Component then
1693             Convert_To_Actual_Subtype (Prefix (Pref));
1694             Atyp := Etype (Prefix (Pref));
1695             Compute_Linear_Subscript (Atyp, Pref, Subscr);
1696
1697             Term :=
1698               Make_Op_Multiply (Ploc,
1699                 Left_Opnd => Subscr,
1700                 Right_Opnd =>
1701                  Make_Attribute_Reference (Ploc,
1702                    Prefix         => New_Occurrence_Of (Atyp, Ploc),
1703                    Attribute_Name => Name_Component_Size));
1704
1705          elsif Nkind (Pref) = N_Selected_Component then
1706             Term :=
1707               Make_Attribute_Reference (Ploc,
1708                 Prefix         => Selector_Name (Pref),
1709                 Attribute_Name => Name_Bit_Position);
1710
1711          else
1712             exit;
1713          end if;
1714
1715          Term := Convert_To (RTE (RE_Integer_Address), Term);
1716
1717          if No (Expr) then
1718             Expr := Term;
1719
1720          else
1721             Expr :=
1722               Make_Op_Add (Ploc,
1723                 Left_Opnd  => Expr,
1724                 Right_Opnd => Term);
1725          end if;
1726
1727          Pref := Prefix (Pref);
1728       end loop;
1729
1730       Rewrite (N,
1731         Unchecked_Convert_To (RTE (RE_Address),
1732           Make_Op_Add (Loc,
1733             Left_Opnd =>
1734               Unchecked_Convert_To (RTE (RE_Integer_Address),
1735                 Make_Attribute_Reference (Loc,
1736                   Prefix         => Pref,
1737                   Attribute_Name => Name_Address)),
1738
1739             Right_Opnd =>
1740               Make_Op_Divide (Loc,
1741                 Left_Opnd => Expr,
1742                 Right_Opnd =>
1743                   Make_Integer_Literal (Loc, System_Storage_Unit)))));
1744
1745       Analyze_And_Resolve (N, RTE (RE_Address));
1746    end Expand_Packed_Address_Reference;
1747
1748    ------------------------------------
1749    -- Expand_Packed_Boolean_Operator --
1750    ------------------------------------
1751
1752    --  This routine expands "a op b" for the packed cases
1753
1754    procedure Expand_Packed_Boolean_Operator (N : Node_Id) is
1755       Loc : constant Source_Ptr := Sloc (N);
1756       Typ : constant Entity_Id  := Etype (N);
1757       L   : constant Node_Id    := Relocate_Node (Left_Opnd  (N));
1758       R   : constant Node_Id    := Relocate_Node (Right_Opnd (N));
1759
1760       Ltyp : Entity_Id;
1761       Rtyp : Entity_Id;
1762       PAT  : Entity_Id;
1763
1764    begin
1765       Convert_To_Actual_Subtype (L);
1766       Convert_To_Actual_Subtype (R);
1767
1768       Ensure_Defined (Etype (L), N);
1769       Ensure_Defined (Etype (R), N);
1770
1771       Apply_Length_Check (R, Etype (L));
1772
1773       Ltyp := Etype (L);
1774       Rtyp := Etype (R);
1775
1776       --  Deal with silly case of XOR where the subcomponent has a range
1777       --  True .. True where an exception must be raised.
1778
1779       if Nkind (N) = N_Op_Xor then
1780          Silly_Boolean_Array_Xor_Test (N, Rtyp);
1781       end if;
1782
1783       --  Now that that silliness is taken care of, get packed array type
1784
1785       Convert_To_PAT_Type (L);
1786       Convert_To_PAT_Type (R);
1787
1788       PAT := Etype (L);
1789
1790       --  For the modular case, we expand a op b into
1791
1792       --    rtyp!(pat!(a) op pat!(b))
1793
1794       --  where rtyp is the Etype of the left operand. Note that we do not
1795       --  convert to the base type, since this would be unconstrained, and
1796       --  hence not have a corresponding packed array type set.
1797
1798       --  Note that both operands must be modular for this code to be used
1799
1800       if Is_Modular_Integer_Type (PAT)
1801            and then
1802          Is_Modular_Integer_Type (Etype (R))
1803       then
1804          declare
1805             P : Node_Id;
1806
1807          begin
1808             if Nkind (N) = N_Op_And then
1809                P := Make_Op_And (Loc, L, R);
1810
1811             elsif Nkind (N) = N_Op_Or then
1812                P := Make_Op_Or  (Loc, L, R);
1813
1814             else -- Nkind (N) = N_Op_Xor
1815                P := Make_Op_Xor (Loc, L, R);
1816             end if;
1817
1818             Rewrite (N, Unchecked_Convert_To (Ltyp, P));
1819          end;
1820
1821       --  For the array case, we insert the actions
1822
1823       --    Result : Ltype;
1824
1825       --    System.Bit_Ops.Bit_And/Or/Xor
1826       --     (Left'Address,
1827       --      Ltype'Length * Ltype'Component_Size;
1828       --      Right'Address,
1829       --      Rtype'Length * Rtype'Component_Size
1830       --      Result'Address);
1831
1832       --  where Left and Right are the Packed_Bytes{1,2,4} operands and
1833       --  the second argument and fourth arguments are the lengths of the
1834       --  operands in bits. Then we replace the expression by a reference
1835       --  to Result.
1836
1837       --  Note that if we are mixing a modular and array operand, everything
1838       --  works fine, since we ensure that the modular representation has the
1839       --  same physical layout as the array representation (that's what the
1840       --  left justified modular stuff in the big-endian case is about).
1841
1842       else
1843          declare
1844             Result_Ent : constant Entity_Id :=
1845                            Make_Defining_Identifier (Loc,
1846                              Chars => New_Internal_Name ('T'));
1847
1848             E_Id : RE_Id;
1849
1850          begin
1851             if Nkind (N) = N_Op_And then
1852                E_Id := RE_Bit_And;
1853
1854             elsif Nkind (N) = N_Op_Or then
1855                E_Id := RE_Bit_Or;
1856
1857             else -- Nkind (N) = N_Op_Xor
1858                E_Id := RE_Bit_Xor;
1859             end if;
1860
1861             Insert_Actions (N, New_List (
1862
1863               Make_Object_Declaration (Loc,
1864                 Defining_Identifier => Result_Ent,
1865                 Object_Definition => New_Occurrence_Of (Ltyp, Loc)),
1866
1867               Make_Procedure_Call_Statement (Loc,
1868                 Name => New_Occurrence_Of (RTE (E_Id), Loc),
1869                   Parameter_Associations => New_List (
1870
1871                     Make_Byte_Aligned_Attribute_Reference (Loc,
1872                       Prefix         => L,
1873                       Attribute_Name => Name_Address),
1874
1875                     Make_Op_Multiply (Loc,
1876                       Left_Opnd =>
1877                         Make_Attribute_Reference (Loc,
1878                           Prefix         =>
1879                             New_Occurrence_Of
1880                               (Etype (First_Index (Ltyp)), Loc),
1881                           Attribute_Name => Name_Range_Length),
1882
1883                       Right_Opnd =>
1884                         Make_Integer_Literal (Loc, Component_Size (Ltyp))),
1885
1886                     Make_Byte_Aligned_Attribute_Reference (Loc,
1887                       Prefix         => R,
1888                       Attribute_Name => Name_Address),
1889
1890                     Make_Op_Multiply (Loc,
1891                       Left_Opnd =>
1892                         Make_Attribute_Reference (Loc,
1893                           Prefix         =>
1894                             New_Occurrence_Of
1895                               (Etype (First_Index (Rtyp)), Loc),
1896                           Attribute_Name => Name_Range_Length),
1897
1898                       Right_Opnd =>
1899                         Make_Integer_Literal (Loc, Component_Size (Rtyp))),
1900
1901                     Make_Byte_Aligned_Attribute_Reference (Loc,
1902                       Prefix => New_Occurrence_Of (Result_Ent, Loc),
1903                       Attribute_Name => Name_Address)))));
1904
1905             Rewrite (N,
1906               New_Occurrence_Of (Result_Ent, Loc));
1907          end;
1908       end if;
1909
1910       Analyze_And_Resolve (N, Typ, Suppress => All_Checks);
1911    end Expand_Packed_Boolean_Operator;
1912
1913    -------------------------------------
1914    -- Expand_Packed_Element_Reference --
1915    -------------------------------------
1916
1917    procedure Expand_Packed_Element_Reference (N : Node_Id) is
1918       Loc   : constant Source_Ptr := Sloc (N);
1919       Obj   : Node_Id;
1920       Atyp  : Entity_Id;
1921       PAT   : Entity_Id;
1922       Ctyp  : Entity_Id;
1923       Csiz  : Int;
1924       Shift : Node_Id;
1925       Cmask : Uint;
1926       Lit   : Node_Id;
1927       Arg   : Node_Id;
1928
1929    begin
1930       --  If not bit packed, we have the enumeration case, which is easily
1931       --  dealt with (just adjust the subscripts of the indexed component)
1932
1933       --  Note: this leaves the result as an indexed component, which is
1934       --  still a variable, so can be used in the assignment case, as is
1935       --  required in the enumeration case.
1936
1937       if not Is_Bit_Packed_Array (Etype (Prefix (N))) then
1938          Setup_Enumeration_Packed_Array_Reference (N);
1939          return;
1940       end if;
1941
1942       --  Remaining processing is for the bit-packed case
1943
1944       Obj := Relocate_Node (Prefix (N));
1945       Convert_To_Actual_Subtype (Obj);
1946       Atyp := Etype (Obj);
1947       PAT  := Packed_Array_Type (Atyp);
1948       Ctyp := Component_Type (Atyp);
1949       Csiz := UI_To_Int (Component_Size (Atyp));
1950
1951       --  Case of component size 1,2,4 or any component size for the modular
1952       --  case. These are the cases for which we can inline the code.
1953
1954       if Csiz = 1 or else Csiz = 2 or else Csiz = 4
1955         or else (Present (PAT) and then Is_Modular_Integer_Type (PAT))
1956       then
1957          Setup_Inline_Packed_Array_Reference (N, Atyp, Obj, Cmask, Shift);
1958          Lit := Make_Integer_Literal (Loc, Cmask);
1959          Set_Print_In_Hex (Lit);
1960
1961          --  We generate a shift right to position the field, followed by a
1962          --  masking operation to extract the bit field, and we finally do an
1963          --  unchecked conversion to convert the result to the required target.
1964
1965          --  Note that the unchecked conversion automatically deals with the
1966          --  bias if we are dealing with a biased representation. What will
1967          --  happen is that we temporarily generate the biased representation,
1968          --  but almost immediately that will be converted to the original
1969          --  unbiased component type, and the bias will disappear.
1970
1971          Arg :=
1972            Make_Op_And (Loc,
1973              Left_Opnd  => Make_Shift_Right (Obj, Shift),
1974              Right_Opnd => Lit);
1975
1976          --  We needed to analyze this before we do the unchecked convert
1977          --  below, but we need it temporarily attached to the tree for
1978          --  this analysis (hence the temporary Set_Parent call).
1979
1980          Set_Parent (Arg, Parent (N));
1981          Analyze_And_Resolve (Arg);
1982
1983          Rewrite (N,
1984            RJ_Unchecked_Convert_To (Ctyp, Arg));
1985
1986       --  All other component sizes for non-modular case
1987
1988       else
1989          --  We generate
1990
1991          --    Component_Type!(Get_nn (Arr'address, Subscr))
1992
1993          --  where Subscr is the computed linear subscript
1994
1995          declare
1996             Get_nn : Entity_Id;
1997             Subscr : Node_Id;
1998
1999          begin
2000             --  Acquire proper Get entity. We use the aligned or unaligned
2001             --  case as appropriate.
2002
2003             if Known_Aligned_Enough (Obj, Csiz) then
2004                Get_nn := RTE (Get_Id (Csiz));
2005             else
2006                Get_nn := RTE (GetU_Id (Csiz));
2007             end if;
2008
2009             --  Now generate the get reference
2010
2011             Compute_Linear_Subscript (Atyp, N, Subscr);
2012
2013             --  Below we make the assumption that Obj is at least byte
2014             --  aligned, since otherwise its address cannot be taken.
2015             --  The assumption holds since the only arrays that can be
2016             --  misaligned are small packed arrays which are implemented
2017             --  as a modular type, and that is not the case here.
2018
2019             Rewrite (N,
2020               Unchecked_Convert_To (Ctyp,
2021                 Make_Function_Call (Loc,
2022                   Name => New_Occurrence_Of (Get_nn, Loc),
2023                   Parameter_Associations => New_List (
2024                     Make_Attribute_Reference (Loc,
2025                       Prefix         => Obj,
2026                       Attribute_Name => Name_Address),
2027                     Subscr))));
2028          end;
2029       end if;
2030
2031       Analyze_And_Resolve (N, Ctyp, Suppress => All_Checks);
2032
2033    end Expand_Packed_Element_Reference;
2034
2035    ----------------------
2036    -- Expand_Packed_Eq --
2037    ----------------------
2038
2039    --  Handles expansion of "=" on packed array types
2040
2041    procedure Expand_Packed_Eq (N : Node_Id) is
2042       Loc : constant Source_Ptr := Sloc (N);
2043       L   : constant Node_Id    := Relocate_Node (Left_Opnd  (N));
2044       R   : constant Node_Id    := Relocate_Node (Right_Opnd (N));
2045
2046       LLexpr : Node_Id;
2047       RLexpr : Node_Id;
2048
2049       Ltyp : Entity_Id;
2050       Rtyp : Entity_Id;
2051       PAT  : Entity_Id;
2052
2053    begin
2054       Convert_To_Actual_Subtype (L);
2055       Convert_To_Actual_Subtype (R);
2056       Ltyp := Underlying_Type (Etype (L));
2057       Rtyp := Underlying_Type (Etype (R));
2058
2059       Convert_To_PAT_Type (L);
2060       Convert_To_PAT_Type (R);
2061       PAT := Etype (L);
2062
2063       LLexpr :=
2064         Make_Op_Multiply (Loc,
2065           Left_Opnd =>
2066             Make_Attribute_Reference (Loc,
2067               Prefix         => New_Occurrence_Of (Ltyp, Loc),
2068               Attribute_Name => Name_Length),
2069           Right_Opnd =>
2070             Make_Integer_Literal (Loc, Component_Size (Ltyp)));
2071
2072       RLexpr :=
2073         Make_Op_Multiply (Loc,
2074           Left_Opnd =>
2075             Make_Attribute_Reference (Loc,
2076               Prefix         => New_Occurrence_Of (Rtyp, Loc),
2077               Attribute_Name => Name_Length),
2078           Right_Opnd =>
2079             Make_Integer_Literal (Loc, Component_Size (Rtyp)));
2080
2081       --  For the modular case, we transform the comparison to:
2082
2083       --    Ltyp'Length = Rtyp'Length and then PAT!(L) = PAT!(R)
2084
2085       --  where PAT is the packed array type. This works fine, since in the
2086       --  modular case we guarantee that the unused bits are always zeroes.
2087       --  We do have to compare the lengths because we could be comparing
2088       --  two different subtypes of the same base type.
2089
2090       if Is_Modular_Integer_Type (PAT) then
2091          Rewrite (N,
2092            Make_And_Then (Loc,
2093              Left_Opnd =>
2094                Make_Op_Eq (Loc,
2095                  Left_Opnd  => LLexpr,
2096                  Right_Opnd => RLexpr),
2097
2098              Right_Opnd =>
2099                Make_Op_Eq (Loc,
2100                  Left_Opnd => L,
2101                  Right_Opnd => R)));
2102
2103       --  For the non-modular case, we call a runtime routine
2104
2105       --    System.Bit_Ops.Bit_Eq
2106       --      (L'Address, L_Length, R'Address, R_Length)
2107
2108       --  where PAT is the packed array type, and the lengths are the lengths
2109       --  in bits of the original packed arrays. This routine takes care of
2110       --  not comparing the unused bits in the last byte.
2111
2112       else
2113          Rewrite (N,
2114            Make_Function_Call (Loc,
2115              Name => New_Occurrence_Of (RTE (RE_Bit_Eq), Loc),
2116              Parameter_Associations => New_List (
2117                Make_Byte_Aligned_Attribute_Reference (Loc,
2118                  Prefix         => L,
2119                  Attribute_Name => Name_Address),
2120
2121                LLexpr,
2122
2123                Make_Byte_Aligned_Attribute_Reference (Loc,
2124                  Prefix         => R,
2125                  Attribute_Name => Name_Address),
2126
2127                RLexpr)));
2128       end if;
2129
2130       Analyze_And_Resolve (N, Standard_Boolean, Suppress => All_Checks);
2131    end Expand_Packed_Eq;
2132
2133    -----------------------
2134    -- Expand_Packed_Not --
2135    -----------------------
2136
2137    --  Handles expansion of "not" on packed array types
2138
2139    procedure Expand_Packed_Not (N : Node_Id) is
2140       Loc  : constant Source_Ptr := Sloc (N);
2141       Typ  : constant Entity_Id  := Etype (N);
2142       Opnd : constant Node_Id    := Relocate_Node (Right_Opnd (N));
2143
2144       Rtyp : Entity_Id;
2145       PAT  : Entity_Id;
2146       Lit  : Node_Id;
2147
2148    begin
2149       Convert_To_Actual_Subtype (Opnd);
2150       Rtyp := Etype (Opnd);
2151
2152       --  Deal with silly False..False and True..True subtype case
2153
2154       Silly_Boolean_Array_Not_Test (N, Rtyp);
2155
2156       --  Now that the silliness is taken care of, get packed array type
2157
2158       Convert_To_PAT_Type (Opnd);
2159       PAT := Etype (Opnd);
2160
2161       --  For the case where the packed array type is a modular type,
2162       --  not A expands simply into:
2163
2164       --     rtyp!(PAT!(A) xor mask)
2165
2166       --  where PAT is the packed array type, and mask is a mask of all
2167       --  one bits of length equal to the size of this packed type and
2168       --  rtyp is the actual subtype of the operand
2169
2170       Lit := Make_Integer_Literal (Loc, 2 ** RM_Size (PAT) - 1);
2171       Set_Print_In_Hex (Lit);
2172
2173       if not Is_Array_Type (PAT) then
2174          Rewrite (N,
2175            Unchecked_Convert_To (Rtyp,
2176              Make_Op_Xor (Loc,
2177                Left_Opnd  => Opnd,
2178                Right_Opnd => Lit)));
2179
2180       --  For the array case, we insert the actions
2181
2182       --    Result : Typ;
2183
2184       --    System.Bit_Ops.Bit_Not
2185       --     (Opnd'Address,
2186       --      Typ'Length * Typ'Component_Size;
2187       --      Result'Address);
2188
2189       --  where Opnd is the Packed_Bytes{1,2,4} operand and the second
2190       --  argument is the length of the operand in bits. Then we replace
2191       --  the expression by a reference to Result.
2192
2193       else
2194          declare
2195             Result_Ent : constant Entity_Id :=
2196                            Make_Defining_Identifier (Loc,
2197                              Chars => New_Internal_Name ('T'));
2198
2199          begin
2200             Insert_Actions (N, New_List (
2201
2202               Make_Object_Declaration (Loc,
2203                 Defining_Identifier => Result_Ent,
2204                 Object_Definition => New_Occurrence_Of (Rtyp, Loc)),
2205
2206               Make_Procedure_Call_Statement (Loc,
2207                 Name => New_Occurrence_Of (RTE (RE_Bit_Not), Loc),
2208                   Parameter_Associations => New_List (
2209
2210                     Make_Byte_Aligned_Attribute_Reference (Loc,
2211                       Prefix         => Opnd,
2212                       Attribute_Name => Name_Address),
2213
2214                     Make_Op_Multiply (Loc,
2215                       Left_Opnd =>
2216                         Make_Attribute_Reference (Loc,
2217                           Prefix         =>
2218                             New_Occurrence_Of
2219                               (Etype (First_Index (Rtyp)), Loc),
2220                           Attribute_Name => Name_Range_Length),
2221
2222                       Right_Opnd =>
2223                         Make_Integer_Literal (Loc, Component_Size (Rtyp))),
2224
2225                     Make_Byte_Aligned_Attribute_Reference (Loc,
2226                       Prefix => New_Occurrence_Of (Result_Ent, Loc),
2227                       Attribute_Name => Name_Address)))));
2228
2229             Rewrite (N,
2230               New_Occurrence_Of (Result_Ent, Loc));
2231          end;
2232       end if;
2233
2234       Analyze_And_Resolve (N, Typ, Suppress => All_Checks);
2235
2236    end Expand_Packed_Not;
2237
2238    -------------------------------------
2239    -- Involves_Packed_Array_Reference --
2240    -------------------------------------
2241
2242    function Involves_Packed_Array_Reference (N : Node_Id) return Boolean is
2243    begin
2244       if Nkind (N) = N_Indexed_Component
2245         and then Is_Bit_Packed_Array (Etype (Prefix (N)))
2246       then
2247          return True;
2248
2249       elsif Nkind (N) = N_Selected_Component then
2250          return Involves_Packed_Array_Reference (Prefix (N));
2251
2252       else
2253          return False;
2254       end if;
2255    end Involves_Packed_Array_Reference;
2256
2257    --------------------------
2258    -- Known_Aligned_Enough --
2259    --------------------------
2260
2261    function Known_Aligned_Enough (Obj : Node_Id; Csiz : Nat) return Boolean is
2262       Typ : constant Entity_Id := Etype (Obj);
2263
2264       function In_Partially_Packed_Record (Comp : Entity_Id) return Boolean;
2265       --  If the component is in a record that contains previous packed
2266       --  components, consider it unaligned because the back-end might
2267       --  choose to pack the rest of the record. Lead to less efficient code,
2268       --  but safer vis-a-vis of back-end choices.
2269
2270       --------------------------------
2271       -- In_Partially_Packed_Record --
2272       --------------------------------
2273
2274       function In_Partially_Packed_Record (Comp : Entity_Id) return Boolean is
2275          Rec_Type  : constant Entity_Id := Scope (Comp);
2276          Prev_Comp : Entity_Id;
2277
2278       begin
2279          Prev_Comp := First_Entity (Rec_Type);
2280          while Present (Prev_Comp) loop
2281             if Is_Packed (Etype (Prev_Comp)) then
2282                return True;
2283
2284             elsif Prev_Comp = Comp then
2285                return False;
2286             end if;
2287
2288             Next_Entity (Prev_Comp);
2289          end loop;
2290
2291          return False;
2292       end  In_Partially_Packed_Record;
2293
2294    --  Start of processing for Known_Aligned_Enough
2295
2296    begin
2297       --  Odd bit sizes don't need alignment anyway
2298
2299       if Csiz mod 2 = 1 then
2300          return True;
2301
2302       --  If we have a specified alignment, see if it is sufficient, if not
2303       --  then we can't possibly be aligned enough in any case.
2304
2305       elsif Known_Alignment (Etype (Obj)) then
2306          --  Alignment required is 4 if size is a multiple of 4, and
2307          --  2 otherwise (e.g. 12 bits requires 4, 10 bits requires 2)
2308
2309          if Alignment (Etype (Obj)) < 4 - (Csiz mod 4) then
2310             return False;
2311          end if;
2312       end if;
2313
2314       --  OK, alignment should be sufficient, if object is aligned
2315
2316       --  If object is strictly aligned, then it is definitely aligned
2317
2318       if Strict_Alignment (Typ) then
2319          return True;
2320
2321       --  Case of subscripted array reference
2322
2323       elsif Nkind (Obj) = N_Indexed_Component then
2324
2325          --  If we have a pointer to an array, then this is definitely
2326          --  aligned, because pointers always point to aligned versions.
2327
2328          if Is_Access_Type (Etype (Prefix (Obj))) then
2329             return True;
2330
2331          --  Otherwise, go look at the prefix
2332
2333          else
2334             return Known_Aligned_Enough (Prefix (Obj), Csiz);
2335          end if;
2336
2337       --  Case of record field
2338
2339       elsif Nkind (Obj) = N_Selected_Component then
2340
2341          --  What is significant here is whether the record type is packed
2342
2343          if Is_Record_Type (Etype (Prefix (Obj)))
2344            and then Is_Packed (Etype (Prefix (Obj)))
2345          then
2346             return False;
2347
2348          --  Or the component has a component clause which might cause
2349          --  the component to become unaligned (we can't tell if the
2350          --  backend is doing alignment computations).
2351
2352          elsif Present (Component_Clause (Entity (Selector_Name (Obj)))) then
2353             return False;
2354
2355          elsif In_Partially_Packed_Record (Entity (Selector_Name (Obj))) then
2356             return False;
2357
2358          --  In all other cases, go look at prefix
2359
2360          else
2361             return Known_Aligned_Enough (Prefix (Obj), Csiz);
2362          end if;
2363
2364       elsif Nkind (Obj) = N_Type_Conversion then
2365          return Known_Aligned_Enough (Expression (Obj), Csiz);
2366
2367       --  For a formal parameter, it is safer to assume that it is not
2368       --  aligned, because the formal may be unconstrained while the actual
2369       --  is constrained. In this situation, a small constrained packed
2370       --  array, represented in modular form, may be unaligned.
2371
2372       elsif Is_Entity_Name (Obj) then
2373          return not Is_Formal (Entity (Obj));
2374       else
2375
2376       --  If none of the above, must be aligned
2377          return True;
2378       end if;
2379    end Known_Aligned_Enough;
2380
2381    ---------------------
2382    -- Make_Shift_Left --
2383    ---------------------
2384
2385    function Make_Shift_Left (N : Node_Id; S : Node_Id) return Node_Id is
2386       Nod : Node_Id;
2387
2388    begin
2389       if Compile_Time_Known_Value (S) and then Expr_Value (S) = 0 then
2390          return N;
2391       else
2392          Nod :=
2393            Make_Op_Shift_Left (Sloc (N),
2394              Left_Opnd  => N,
2395              Right_Opnd => S);
2396          Set_Shift_Count_OK (Nod, True);
2397          return Nod;
2398       end if;
2399    end Make_Shift_Left;
2400
2401    ----------------------
2402    -- Make_Shift_Right --
2403    ----------------------
2404
2405    function Make_Shift_Right (N : Node_Id; S : Node_Id) return Node_Id is
2406       Nod : Node_Id;
2407
2408    begin
2409       if Compile_Time_Known_Value (S) and then Expr_Value (S) = 0 then
2410          return N;
2411       else
2412          Nod :=
2413            Make_Op_Shift_Right (Sloc (N),
2414              Left_Opnd  => N,
2415              Right_Opnd => S);
2416          Set_Shift_Count_OK (Nod, True);
2417          return Nod;
2418       end if;
2419    end Make_Shift_Right;
2420
2421    -----------------------------
2422    -- RJ_Unchecked_Convert_To --
2423    -----------------------------
2424
2425    function RJ_Unchecked_Convert_To
2426      (Typ  : Entity_Id;
2427       Expr : Node_Id) return Node_Id
2428    is
2429       Source_Typ : constant Entity_Id := Etype (Expr);
2430       Target_Typ : constant Entity_Id := Typ;
2431
2432       Src : Node_Id := Expr;
2433
2434       Source_Siz : Nat;
2435       Target_Siz : Nat;
2436
2437    begin
2438       Source_Siz := UI_To_Int (RM_Size (Source_Typ));
2439       Target_Siz := UI_To_Int (RM_Size (Target_Typ));
2440
2441       --  First step, if the source type is not a discrete type, then we
2442       --  first convert to a modular type of the source length, since
2443       --  otherwise, on a big-endian machine, we get left-justification.
2444       --  We do it for little-endian machines as well, because there might
2445       --  be junk bits that are not cleared if the type is not numeric.
2446
2447       if Source_Siz /= Target_Siz
2448         and then  not Is_Discrete_Type (Source_Typ)
2449       then
2450          Src := Unchecked_Convert_To (RTE (Bits_Id (Source_Siz)), Src);
2451       end if;
2452
2453       --  In the big endian case, if the lengths of the two types differ,
2454       --  then we must worry about possible left justification in the
2455       --  conversion, and avoiding that is what this is all about.
2456
2457       if Bytes_Big_Endian and then Source_Siz /= Target_Siz then
2458
2459          --  Next step. If the target is not a discrete type, then we first
2460          --  convert to a modular type of the target length, since
2461          --  otherwise, on a big-endian machine, we get left-justification.
2462
2463          if not Is_Discrete_Type (Target_Typ) then
2464             Src := Unchecked_Convert_To (RTE (Bits_Id (Target_Siz)), Src);
2465          end if;
2466       end if;
2467
2468       --  And now we can do the final conversion to the target type
2469
2470       return Unchecked_Convert_To (Target_Typ, Src);
2471    end RJ_Unchecked_Convert_To;
2472
2473    ----------------------------------------------
2474    -- Setup_Enumeration_Packed_Array_Reference --
2475    ----------------------------------------------
2476
2477    --  All we have to do here is to find the subscripts that correspond
2478    --  to the index positions that have non-standard enumeration types
2479    --  and insert a Pos attribute to get the proper subscript value.
2480
2481    --  Finally the prefix must be uncheck converted to the corresponding
2482    --  packed array type.
2483
2484    --  Note that the component type is unchanged, so we do not need to
2485    --  fiddle with the types (Gigi always automatically takes the packed
2486    --  array type if it is set, as it will be in this case).
2487
2488    procedure Setup_Enumeration_Packed_Array_Reference (N : Node_Id) is
2489       Pfx   : constant Node_Id   := Prefix (N);
2490       Typ   : constant Entity_Id := Etype (N);
2491       Exprs : constant List_Id   := Expressions (N);
2492       Expr  : Node_Id;
2493
2494    begin
2495       --  If the array is unconstrained, then we replace the array
2496       --  reference with its actual subtype. This actual subtype will
2497       --  have a packed array type with appropriate bounds.
2498
2499       if not Is_Constrained (Packed_Array_Type (Etype (Pfx))) then
2500          Convert_To_Actual_Subtype (Pfx);
2501       end if;
2502
2503       Expr := First (Exprs);
2504       while Present (Expr) loop
2505          declare
2506             Loc      : constant Source_Ptr := Sloc (Expr);
2507             Expr_Typ : constant Entity_Id := Etype (Expr);
2508
2509          begin
2510             if Is_Enumeration_Type (Expr_Typ)
2511               and then Has_Non_Standard_Rep (Expr_Typ)
2512             then
2513                Rewrite (Expr,
2514                  Make_Attribute_Reference (Loc,
2515                    Prefix         => New_Occurrence_Of (Expr_Typ, Loc),
2516                    Attribute_Name => Name_Pos,
2517                    Expressions    => New_List (Relocate_Node (Expr))));
2518                Analyze_And_Resolve (Expr, Standard_Natural);
2519             end if;
2520          end;
2521
2522          Next (Expr);
2523       end loop;
2524
2525       Rewrite (N,
2526         Make_Indexed_Component (Sloc (N),
2527           Prefix      =>
2528             Unchecked_Convert_To (Packed_Array_Type (Etype (Pfx)), Pfx),
2529           Expressions => Exprs));
2530
2531       Analyze_And_Resolve (N, Typ);
2532
2533    end Setup_Enumeration_Packed_Array_Reference;
2534
2535    -----------------------------------------
2536    -- Setup_Inline_Packed_Array_Reference --
2537    -----------------------------------------
2538
2539    procedure Setup_Inline_Packed_Array_Reference
2540      (N      : Node_Id;
2541       Atyp   : Entity_Id;
2542       Obj    : in out Node_Id;
2543       Cmask  : out Uint;
2544       Shift  : out Node_Id)
2545    is
2546       Loc    : constant Source_Ptr := Sloc (N);
2547       PAT    : Entity_Id;
2548       Otyp   : Entity_Id;
2549       Csiz   : Uint;
2550       Osiz   : Uint;
2551
2552    begin
2553       Csiz := Component_Size (Atyp);
2554
2555       Convert_To_PAT_Type (Obj);
2556       PAT := Etype (Obj);
2557
2558       Cmask := 2 ** Csiz - 1;
2559
2560       if Is_Array_Type (PAT) then
2561          Otyp := Component_Type (PAT);
2562          Osiz := Component_Size (PAT);
2563
2564       else
2565          Otyp := PAT;
2566
2567          --  In the case where the PAT is a modular type, we want the actual
2568          --  size in bits of the modular value we use. This is neither the
2569          --  Object_Size nor the Value_Size, either of which may have been
2570          --  reset to strange values, but rather the minimum size. Note that
2571          --  since this is a modular type with full range, the issue of
2572          --  biased representation does not arise.
2573
2574          Osiz := UI_From_Int (Minimum_Size (Otyp));
2575       end if;
2576
2577       Compute_Linear_Subscript (Atyp, N, Shift);
2578
2579       --  If the component size is not 1, then the subscript must be
2580       --  multiplied by the component size to get the shift count.
2581
2582       if Csiz /= 1 then
2583          Shift :=
2584            Make_Op_Multiply (Loc,
2585              Left_Opnd => Make_Integer_Literal (Loc, Csiz),
2586              Right_Opnd => Shift);
2587       end if;
2588
2589       --  If we have the array case, then this shift count must be broken
2590       --  down into a byte subscript, and a shift within the byte.
2591
2592       if Is_Array_Type (PAT) then
2593
2594          declare
2595             New_Shift : Node_Id;
2596
2597          begin
2598             --  We must analyze shift, since we will duplicate it
2599
2600             Set_Parent (Shift, N);
2601             Analyze_And_Resolve
2602               (Shift, Standard_Integer, Suppress => All_Checks);
2603
2604             --  The shift count within the word is
2605             --    shift mod Osiz
2606
2607             New_Shift :=
2608               Make_Op_Mod (Loc,
2609                 Left_Opnd  => Duplicate_Subexpr (Shift),
2610                 Right_Opnd => Make_Integer_Literal (Loc, Osiz));
2611
2612             --  The subscript to be used on the PAT array is
2613             --    shift / Osiz
2614
2615             Obj :=
2616               Make_Indexed_Component (Loc,
2617                 Prefix => Obj,
2618                 Expressions => New_List (
2619                   Make_Op_Divide (Loc,
2620                     Left_Opnd => Duplicate_Subexpr (Shift),
2621                     Right_Opnd => Make_Integer_Literal (Loc, Osiz))));
2622
2623             Shift := New_Shift;
2624          end;
2625
2626       --  For the modular integer case, the object to be manipulated is
2627       --  the entire array, so Obj is unchanged. Note that we will reset
2628       --  its type to PAT before returning to the caller.
2629
2630       else
2631          null;
2632       end if;
2633
2634       --  The one remaining step is to modify the shift count for the
2635       --  big-endian case. Consider the following example in a byte:
2636
2637       --     xxxxxxxx  bits of byte
2638       --     vvvvvvvv  bits of value
2639       --     33221100  little-endian numbering
2640       --     00112233  big-endian numbering
2641
2642       --  Here we have the case of 2-bit fields
2643
2644       --  For the little-endian case, we already have the proper shift
2645       --  count set, e.g. for element 2, the shift count is 2*2 = 4.
2646
2647       --  For the big endian case, we have to adjust the shift count,
2648       --  computing it as (N - F) - shift, where N is the number of bits
2649       --  in an element of the array used to implement the packed array,
2650       --  F is the number of bits in a source level array element, and
2651       --  shift is the count so far computed.
2652
2653       if Bytes_Big_Endian then
2654          Shift :=
2655            Make_Op_Subtract (Loc,
2656              Left_Opnd  => Make_Integer_Literal (Loc, Osiz - Csiz),
2657              Right_Opnd => Shift);
2658       end if;
2659
2660       Set_Parent (Shift, N);
2661       Set_Parent (Obj, N);
2662       Analyze_And_Resolve (Obj,   Otyp,             Suppress => All_Checks);
2663       Analyze_And_Resolve (Shift, Standard_Integer, Suppress => All_Checks);
2664
2665       --  Make sure final type of object is the appropriate packed type
2666
2667       Set_Etype (Obj, Otyp);
2668
2669    end Setup_Inline_Packed_Array_Reference;
2670
2671 end Exp_Pakd;