ada: Rename Is_Constr_Subt_For_UN_Aliased flag
[official-gcc.git] / gcc / ada / exp_pakd.adb
blob19d158ffad0381d6f23044fdfc3b1dff7617ef41
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-2023, 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 ------------------------------------------------------------------------------
26 with Atree; use Atree;
27 with Checks; use Checks;
28 with Einfo; use Einfo;
29 with Einfo.Entities; use Einfo.Entities;
30 with Einfo.Utils; use Einfo.Utils;
31 with Errout; use Errout;
32 with Exp_Dbug; use Exp_Dbug;
33 with Exp_Util; use Exp_Util;
34 with Layout; use Layout;
35 with Lib.Xref; use Lib.Xref;
36 with Namet; use Namet;
37 with Nlists; use Nlists;
38 with Nmake; use Nmake;
39 with Opt; use Opt;
40 with Sem; use Sem;
41 with Sem_Aux; use Sem_Aux;
42 with Sem_Ch3; use Sem_Ch3;
43 with Sem_Ch8; use Sem_Ch8;
44 with Sem_Ch13; use Sem_Ch13;
45 with Sem_Eval; use Sem_Eval;
46 with Sem_Res; use Sem_Res;
47 with Sem_Util; use Sem_Util;
48 with Sinfo; use Sinfo;
49 with Sinfo.Nodes; use Sinfo.Nodes;
50 with Sinfo.Utils; use Sinfo.Utils;
51 with Snames; use Snames;
52 with Stand; use Stand;
53 with Targparm; use Targparm;
54 with Tbuild; use Tbuild;
55 with Ttypes; use Ttypes;
56 with Uintp; use Uintp;
58 package body Exp_Pakd is
60 ---------------------------
61 -- Endian Considerations --
62 ---------------------------
64 -- As described in the specification, bit numbering in a packed array
65 -- is consistent with bit numbering in a record representation clause,
66 -- and hence dependent on the endianness of the machine:
68 -- For little-endian machines, element zero is at the right hand end
69 -- (low order end) of a bit field.
71 -- For big-endian machines, element zero is at the left hand end
72 -- (high order end) of a bit field.
74 -- The shifts that are used to right justify a field therefore differ in
75 -- the two cases. For the little-endian case, we can simply use the bit
76 -- number (i.e. the element number * element size) as the count for a right
77 -- shift. For the big-endian case, we have to subtract the shift count from
78 -- an appropriate constant to use in the right shift. We use rotates
79 -- instead of shifts (which is necessary in the store case to preserve
80 -- other fields), and we expect that the backend will be able to change the
81 -- right rotate into a left rotate, avoiding the subtract, if the machine
82 -- architecture provides such an instruction.
84 -----------------------
85 -- Local Subprograms --
86 -----------------------
88 procedure Compute_Linear_Subscript
89 (Atyp : Entity_Id;
90 N : Node_Id;
91 Subscr : out Node_Id);
92 -- Given a constrained array type Atyp, and an indexed component node N
93 -- referencing an array object of this type, build an expression of type
94 -- Standard.Integer representing the zero-based linear subscript value.
95 -- This expression includes any required range checks.
97 function Compute_Number_Components
98 (N : Node_Id;
99 Typ : Entity_Id) return Node_Id;
100 -- Build an expression that multiplies the length of the dimensions of the
101 -- array, used to control array equality checks.
103 procedure Convert_To_PAT_Type (Aexp : Node_Id);
104 -- Given an expression of a packed array type, builds a corresponding
105 -- expression whose type is the implementation type used to represent
106 -- the packed array. Aexp is analyzed and resolved on entry and on exit.
108 procedure Get_Base_And_Bit_Offset
109 (N : Node_Id;
110 Base : out Node_Id;
111 Offset : out Node_Id);
112 -- Given a node N for a name which involves a packed array reference,
113 -- return the base object of the reference and build an expression of
114 -- type Standard.Integer representing the zero-based offset in bits
115 -- from Base'Address to the first bit of the reference.
117 function Known_Aligned_Enough (Obj : Node_Id; Csiz : Nat) return Boolean;
118 -- There are two versions of the Set routines, the ones used when the
119 -- object is known to be sufficiently well aligned given the number of
120 -- bits, and the ones used when the object is not known to be aligned.
121 -- This routine is used to determine which set to use. Obj is a reference
122 -- to the object, and Csiz is the component size of the packed array.
123 -- True is returned if the alignment of object is known to be sufficient,
124 -- defined as 1 for odd bit sizes, 4 for bit sizes divisible by 4, and
125 -- 2 otherwise.
127 function Make_Shift_Left (N : Node_Id; S : Node_Id) return Node_Id;
128 -- Build a left shift node, checking for the case of a shift count of zero
130 function Make_Shift_Right (N : Node_Id; S : Node_Id) return Node_Id;
131 -- Build a right shift node, checking for the case of a shift count of zero
133 function RJ_Unchecked_Convert_To
134 (Typ : Entity_Id;
135 Expr : Node_Id) return Node_Id;
136 -- The packed array code does unchecked conversions which in some cases
137 -- may involve non-discrete types with differing sizes. The semantics of
138 -- such conversions is potentially endianness dependent, and the effect
139 -- we want here for such a conversion is to do the conversion in size as
140 -- though numeric items are involved, and we extend or truncate on the
141 -- left side. This happens naturally in the little-endian case, but in
142 -- the big endian case we can get left justification, when what we want
143 -- is right justification. This routine does the unchecked conversion in
144 -- a stepwise manner to ensure that it gives the expected result. Hence
145 -- the name (RJ = Right justified). The parameters Typ and Expr are as
146 -- for the case of a normal Unchecked_Convert_To call.
148 procedure Setup_Enumeration_Packed_Array_Reference (N : Node_Id);
149 -- This routine is called in the Get and Set case for arrays that are
150 -- packed but not bit-packed, meaning that they have at least one
151 -- subscript that is of an enumeration type with a non-standard
152 -- representation. This routine modifies the given node to properly
153 -- reference the corresponding packed array type.
155 procedure Setup_Inline_Packed_Array_Reference
156 (N : Node_Id;
157 Atyp : Entity_Id;
158 Obj : in out Node_Id;
159 Cmask : out Uint;
160 Shift : out Node_Id);
161 -- This procedure performs common processing on the N_Indexed_Component
162 -- parameter given as N, whose prefix is a reference to a packed array.
163 -- This is used for the get and set when the component size is 1, 2, 4,
164 -- or for other component sizes when the packed array type is a modular
165 -- type (i.e. the cases that are handled with inline code).
167 -- On entry:
169 -- N is the N_Indexed_Component node for the packed array reference
171 -- Atyp is the constrained array type (the actual subtype has been
172 -- computed if necessary to obtain the constraints, but this is still
173 -- the original array type, not the Packed_Array_Impl_Type value).
175 -- Obj is the object which is to be indexed. It is always of type Atyp.
177 -- On return:
179 -- Obj is the object containing the desired bit field. It is of type
180 -- Unsigned, Long_Unsigned, or Long_Long_Unsigned, and is either the
181 -- entire value, for the small static case, or the proper selected byte
182 -- from the array in the large or dynamic case. This node is analyzed
183 -- and resolved on return.
185 -- Shift is a node representing the shift count to be used in the
186 -- rotate right instruction that positions the field for access.
187 -- This node is analyzed and resolved on return.
189 -- Cmask is a mask corresponding to the width of the component field.
190 -- Its value is 2 ** Csize - 1 (e.g. 2#1111# for component size of 4).
192 -- Note: in some cases the call to this routine may generate actions
193 -- (for handling multi-use references and the generation of the packed
194 -- array type on the fly). Such actions are inserted into the tree
195 -- directly using Insert_Action.
197 function Revert_Storage_Order (N : Node_Id) return Node_Id;
198 -- Perform appropriate justification and byte ordering adjustments for N,
199 -- an element of a packed array type, when both the component type and
200 -- the enclosing packed array type have reverse scalar storage order.
201 -- On little-endian targets, the value is left justified before byte
202 -- swapping. The Etype of the returned expression is an integer type of
203 -- an appropriate power-of-2 size.
205 --------------------------
206 -- Revert_Storage_Order --
207 --------------------------
209 function Revert_Storage_Order (N : Node_Id) return Node_Id is
210 Loc : constant Source_Ptr := Sloc (N);
211 T : constant Entity_Id := Etype (N);
212 T_Size : constant Uint := RM_Size (T);
214 Swap_RE : RE_Id;
215 Swap_F : Entity_Id;
216 Swap_T : Entity_Id;
217 -- Swapping function
219 Arg : Node_Id;
220 Adjusted : Node_Id;
221 Shift : Uint;
223 begin
224 if T_Size <= 8 then
226 -- Array component size is less than a byte: no swapping needed
228 Swap_F := Empty;
229 Swap_T := RTE (RE_Unsigned_8);
231 else
232 -- Select byte swapping function depending on array component size
234 if T_Size <= 16 then
235 Swap_RE := RE_Bswap_16;
237 elsif T_Size <= 32 then
238 Swap_RE := RE_Bswap_32;
240 elsif T_Size <= 64 then
241 Swap_RE := RE_Bswap_64;
243 else pragma Assert (T_Size <= 128);
244 Swap_RE := RE_Bswap_128;
245 end if;
247 Swap_F := RTE (Swap_RE);
248 Swap_T := Etype (Swap_F);
250 end if;
252 Shift := Esize (Swap_T) - T_Size;
254 Arg := RJ_Unchecked_Convert_To (Swap_T, N);
256 if not Bytes_Big_Endian and then Shift > Uint_0 then
257 Arg :=
258 Make_Op_Shift_Left (Loc,
259 Left_Opnd => Arg,
260 Right_Opnd => Make_Integer_Literal (Loc, Shift));
261 end if;
263 if Present (Swap_F) then
264 Adjusted :=
265 Make_Function_Call (Loc,
266 Name => New_Occurrence_Of (Swap_F, Loc),
267 Parameter_Associations => New_List (Arg));
268 else
269 Adjusted := Arg;
270 end if;
272 Set_Etype (Adjusted, Swap_T);
273 return Adjusted;
274 end Revert_Storage_Order;
276 ------------------------------
277 -- Compute_Linear_Subscript --
278 ------------------------------
280 procedure Compute_Linear_Subscript
281 (Atyp : Entity_Id;
282 N : Node_Id;
283 Subscr : out Node_Id)
285 Loc : constant Source_Ptr := Sloc (N);
286 Oldsub : Node_Id;
287 Newsub : Node_Id;
288 Indx : Node_Id;
289 Styp : Entity_Id;
291 begin
292 Subscr := Empty;
294 -- Loop through dimensions
296 Indx := First_Index (Atyp);
297 Oldsub := First (Expressions (N));
299 while Present (Indx) loop
300 Styp := Etype (Indx);
301 Newsub := Relocate_Node (Oldsub);
303 -- Get expression for the subscript value. First, if Do_Range_Check
304 -- is set on a subscript, then we must do a range check against the
305 -- original bounds (not the bounds of the packed array type). We do
306 -- this by introducing a subtype conversion.
308 if Do_Range_Check (Newsub)
309 and then Etype (Newsub) /= Styp
310 then
311 Newsub := Convert_To (Styp, Newsub);
312 end if;
314 -- Now evolve the expression for the subscript. First convert
315 -- the subscript to be zero based and of an integer type.
317 -- Case of integer type, where we just subtract to get lower bound
319 if Is_Integer_Type (Styp) then
321 -- If length of integer type is smaller than standard integer,
322 -- then we convert to integer first, then do the subtract
324 -- Integer (subscript) - Integer (Styp'First)
326 if Esize (Styp) < Standard_Integer_Size then
327 Newsub :=
328 Make_Op_Subtract (Loc,
329 Left_Opnd => Convert_To (Standard_Integer, Newsub),
330 Right_Opnd =>
331 Convert_To (Standard_Integer,
332 Make_Attribute_Reference (Loc,
333 Prefix => New_Occurrence_Of (Styp, Loc),
334 Attribute_Name => Name_First)));
336 -- For larger integer types, subtract first, then convert to
337 -- integer, this deals with strange long long integer bounds.
339 -- Integer (subscript - Styp'First)
341 else
342 Newsub :=
343 Convert_To (Standard_Integer,
344 Make_Op_Subtract (Loc,
345 Left_Opnd => Newsub,
346 Right_Opnd =>
347 Make_Attribute_Reference (Loc,
348 Prefix => New_Occurrence_Of (Styp, Loc),
349 Attribute_Name => Name_First)));
350 end if;
352 -- For the enumeration case, we have to use 'Pos to get the value
353 -- to work with before subtracting the lower bound.
355 -- Integer (Styp'Pos (subscr)) - Integer (Styp'Pos (Styp'First));
357 -- This is not quite right for bizarre cases where the size of the
358 -- enumeration type is > Integer'Size bits due to rep clause ???
360 else
361 pragma Assert (Is_Enumeration_Type (Styp));
363 Newsub :=
364 Make_Op_Subtract (Loc,
365 Left_Opnd => Convert_To (Standard_Integer,
366 Make_Attribute_Reference (Loc,
367 Prefix => New_Occurrence_Of (Styp, Loc),
368 Attribute_Name => Name_Pos,
369 Expressions => New_List (Newsub))),
371 Right_Opnd =>
372 Convert_To (Standard_Integer,
373 Make_Attribute_Reference (Loc,
374 Prefix => New_Occurrence_Of (Styp, Loc),
375 Attribute_Name => Name_Pos,
376 Expressions => New_List (
377 Make_Attribute_Reference (Loc,
378 Prefix => New_Occurrence_Of (Styp, Loc),
379 Attribute_Name => Name_First)))));
380 end if;
382 Set_Paren_Count (Newsub, 1);
384 -- For the first subscript, we just copy that subscript value
386 if No (Subscr) then
387 Subscr := Newsub;
389 -- Otherwise, we must multiply what we already have by the current
390 -- stride and then add in the new value to the evolving subscript.
392 else
393 Subscr :=
394 Make_Op_Add (Loc,
395 Left_Opnd =>
396 Make_Op_Multiply (Loc,
397 Left_Opnd => Subscr,
398 Right_Opnd =>
399 Make_Attribute_Reference (Loc,
400 Attribute_Name => Name_Range_Length,
401 Prefix => New_Occurrence_Of (Styp, Loc))),
402 Right_Opnd => Newsub);
403 end if;
405 -- Move to next subscript
407 Next_Index (Indx);
408 Next (Oldsub);
409 end loop;
410 end Compute_Linear_Subscript;
412 -------------------------------
413 -- Compute_Number_Components --
414 -------------------------------
416 function Compute_Number_Components
417 (N : Node_Id;
418 Typ : Entity_Id) return Node_Id
420 Loc : constant Source_Ptr := Sloc (N);
421 Len_Expr : Node_Id;
423 begin
424 Len_Expr :=
425 Make_Attribute_Reference (Loc,
426 Attribute_Name => Name_Length,
427 Prefix => New_Occurrence_Of (Typ, Loc),
428 Expressions => New_List (Make_Integer_Literal (Loc, 1)));
430 for J in 2 .. Number_Dimensions (Typ) loop
431 Len_Expr :=
432 Make_Op_Multiply (Loc,
433 Left_Opnd => Len_Expr,
434 Right_Opnd =>
435 Make_Attribute_Reference (Loc,
436 Attribute_Name => Name_Length,
437 Prefix => New_Occurrence_Of (Typ, Loc),
438 Expressions => New_List (Make_Integer_Literal (Loc, J))));
439 end loop;
441 return Len_Expr;
442 end Compute_Number_Components;
444 -------------------------
445 -- Convert_To_PAT_Type --
446 -------------------------
448 -- The PAT is always obtained from the actual subtype
450 procedure Convert_To_PAT_Type (Aexp : Node_Id) is
451 Act_ST : Entity_Id;
453 begin
454 Convert_To_Actual_Subtype (Aexp);
455 Act_ST := Underlying_Type (Etype (Aexp));
456 Create_Packed_Array_Impl_Type (Act_ST);
458 -- Just replace the etype with the packed array type. This works because
459 -- the expression will not be further analyzed, and Gigi considers the
460 -- two types equivalent in any case.
462 -- This is not strictly the case ??? If the reference is an actual in
463 -- call, the expansion of the prefix is delayed, and must be reanalyzed,
464 -- see Reset_Packed_Prefix. On the other hand, if the prefix is a simple
465 -- array reference, reanalysis can produce spurious type errors when the
466 -- PAT type is replaced again with the original type of the array. Same
467 -- for the case of a dereference. Ditto for function calls: expansion
468 -- may introduce additional actuals which will trigger errors if call is
469 -- reanalyzed. The following is correct and minimal, but the handling of
470 -- more complex packed expressions in actuals is confused. Probably the
471 -- problem only remains for actuals in calls.
473 Set_Etype (Aexp, Packed_Array_Impl_Type (Act_ST));
475 if Is_Entity_Name (Aexp)
476 or else
477 (Nkind (Aexp) = N_Indexed_Component
478 and then Is_Entity_Name (Prefix (Aexp)))
479 or else Nkind (Aexp) in N_Explicit_Dereference | N_Function_Call
480 then
481 Set_Analyzed (Aexp);
482 end if;
483 end Convert_To_PAT_Type;
485 -----------------------------------
486 -- Create_Packed_Array_Impl_Type --
487 -----------------------------------
489 procedure Create_Packed_Array_Impl_Type (Typ : Entity_Id) is
490 Loc : constant Source_Ptr := Sloc (Typ);
491 Ctyp : constant Entity_Id := Component_Type (Typ);
492 Csize : constant Uint := Component_Size (Typ);
494 Ancest : Entity_Id;
495 PB_Type : Entity_Id;
496 PASize : Uint := No_Uint;
497 Decl : Node_Id;
498 PAT : Entity_Id;
499 Len_Expr : Node_Id;
500 Len_Bits : Uint;
501 Bits_U1 : Node_Id;
502 PAT_High : Node_Id;
503 Btyp : Entity_Id;
504 Lit : Node_Id;
506 procedure Install_PAT;
507 -- This procedure is called with Decl set to the declaration for the
508 -- packed array type. It creates the type and installs it as required.
510 procedure Set_PB_Type;
511 -- Set PB_Type to [Rev_]Packed_Bytes{1,2,4} as required by the alignment
512 -- and the scalar storage order requirements (see documentation in the
513 -- spec of this package).
515 -----------------
516 -- Install_PAT --
517 -----------------
519 procedure Install_PAT is
520 Pushed_Scope : Boolean := False;
522 begin
523 -- We do not want to put the declaration we have created in the tree
524 -- since it is often hard, and sometimes impossible to find a proper
525 -- place for it (the impossible case arises for a packed array type
526 -- with bounds depending on the discriminant, a declaration cannot
527 -- be put inside the record, and the reference to the discriminant
528 -- cannot be outside the record).
530 -- The solution is to analyze the declaration while temporarily
531 -- attached to the tree at an appropriate point, and then we install
532 -- the resulting type as an Itype in the packed array type field of
533 -- the original type, so that no explicit declaration is required.
535 -- Note: the packed type is created in the scope of its parent type.
536 -- There are at least some cases where the current scope is deeper,
537 -- and so when this is the case, we temporarily reset the scope
538 -- for the definition. This is clearly safe, since the first use
539 -- of the packed array type will be the implicit reference from
540 -- the corresponding unpacked type when it is elaborated.
542 if Is_Itype (Typ) then
543 Set_Parent (Decl, Associated_Node_For_Itype (Typ));
544 else
545 Set_Parent (Decl, Declaration_Node (Typ));
546 end if;
548 if Scope (Typ) /= Current_Scope then
549 Push_Scope (Scope (Typ));
550 Pushed_Scope := True;
551 end if;
553 Set_Is_Itype (PAT, True);
554 Set_Is_Packed_Array_Impl_Type (PAT, True);
555 Set_Packed_Array_Impl_Type (Typ, PAT);
556 Analyze (Decl, Suppress => All_Checks);
558 if Pushed_Scope then
559 Pop_Scope;
560 end if;
562 -- Set Esize and RM_Size to the actual size of the packed object
563 -- Do not reset RM_Size if already set, as happens in the case of
564 -- a modular type.
566 if Present (PASize) then
567 if not Known_Esize (PAT) then
568 Set_Esize (PAT, PASize);
569 end if;
571 if not Known_RM_Size (PAT) then
572 Set_RM_Size (PAT, PASize);
573 end if;
574 end if;
576 -- In the case of a modular type, make sure the alignment is
577 -- consistent with the Esize.
579 if Is_Scalar_Type (PAT) then
580 while Alignment (PAT) * System_Storage_Unit < Esize (PAT)
581 and then Alignment (PAT) < Maximum_Alignment
582 loop
583 Set_Alignment (PAT, 2 * Alignment (PAT));
584 end loop;
585 end if;
587 -- Then, in all cases, make sure the opposite is also true
589 Adjust_Esize_Alignment (PAT);
591 -- Set remaining fields of packed array type
593 Set_Parent (PAT, Empty);
594 Set_Associated_Node_For_Itype (PAT, Typ);
595 Set_Original_Array_Type (PAT, Typ);
597 -- Propagate representation aspects
599 Set_Is_Atomic (PAT, Is_Atomic (Typ));
600 Set_Is_Independent (PAT, Is_Independent (Typ));
601 Set_Is_Volatile (PAT, Is_Volatile (Typ));
602 Set_Is_Volatile_Full_Access (PAT, Is_Volatile_Full_Access (Typ));
603 Set_Treat_As_Volatile (PAT, Treat_As_Volatile (Typ));
605 -- We definitely do not want to delay freezing for packed array
606 -- types. This is of particular importance for the itypes that are
607 -- generated for record components depending on discriminants where
608 -- there is no place to put the freeze node.
610 Set_Has_Delayed_Freeze (PAT, False);
611 Set_Has_Delayed_Freeze (Etype (PAT), False);
613 -- If we did allocate a freeze node, then clear out the reference
614 -- since it is obsolete (should we delete the freeze node???)
616 Set_Freeze_Node (PAT, Empty);
617 Set_Freeze_Node (Etype (PAT), Empty);
618 end Install_PAT;
620 -----------------
621 -- Set_PB_Type --
622 -----------------
624 procedure Set_PB_Type is
625 begin
626 -- If the user has specified an explicit alignment for the
627 -- type or component, take it into account.
629 if Csize <= 2 or else Csize = 4 or else Csize mod 2 /= 0
630 or else (Known_Alignment (Typ) and then Alignment (Typ) = 1)
631 or else Component_Alignment (Typ) = Calign_Storage_Unit
632 then
633 if Reverse_Storage_Order (Typ) then
634 PB_Type := RTE (RE_Rev_Packed_Bytes1);
635 else
636 PB_Type := RTE (RE_Packed_Bytes1);
637 end if;
639 elsif Csize mod 4 /= 0
640 or else (Known_Alignment (Typ) and then Alignment (Typ) = 2)
641 then
642 if Reverse_Storage_Order (Typ) then
643 PB_Type := RTE (RE_Rev_Packed_Bytes2);
644 else
645 PB_Type := RTE (RE_Packed_Bytes2);
646 end if;
648 else
649 if Reverse_Storage_Order (Typ) then
650 PB_Type := RTE (RE_Rev_Packed_Bytes4);
651 else
652 PB_Type := RTE (RE_Packed_Bytes4);
653 end if;
654 end if;
656 -- The Rev_Packed_Bytes{1,2,4} types cannot be directly declared with
657 -- the reverse scalar storage order in System.Unsigned_Types because
658 -- their component type is aliased and the combination would then be
659 -- flagged as illegal by the compiler. Moreover changing the compiler
660 -- would not address the bootstrap path issue with earlier versions.
662 Set_Reverse_Storage_Order (PB_Type, Reverse_Storage_Order (Typ));
663 end Set_PB_Type;
665 -- Start of processing for Create_Packed_Array_Impl_Type
667 begin
668 -- If we already have a packed array type, nothing to do
670 if Present (Packed_Array_Impl_Type (Typ)) then
671 return;
672 end if;
674 -- If our immediate ancestor subtype is constrained, and it already has
675 -- a packed array type, and it has the same size, then just share the
676 -- same type, since the bounds must be the same. If the ancestor is not
677 -- an array type but a private type, as can happen with multiple
678 -- instantiations, create a new packed type, to avoid privacy issues.
680 if Ekind (Typ) = E_Array_Subtype then
681 Ancest := Ancestor_Subtype (Typ);
683 if Present (Ancest)
684 and then Is_Array_Type (Ancest)
685 and then Is_Constrained (Ancest)
686 and then Present (Packed_Array_Impl_Type (Ancest))
687 and then Known_Esize (Typ)
688 and then Known_Esize (Ancest)
689 and then Esize (Typ) = Esize (Ancest)
690 then
691 Set_Packed_Array_Impl_Type (Typ, Packed_Array_Impl_Type (Ancest));
692 return;
693 end if;
694 end if;
696 -- We preset the result type size from the size of the original array
697 -- type, since this size clearly belongs to the packed array type. The
698 -- size of the conceptual unpacked type is always set to unknown.
700 if Known_RM_Size (Typ) then
701 PASize := RM_Size (Typ);
702 end if;
704 -- Case of an array where at least one index is of an enumeration
705 -- type with a non-standard representation, but the component size
706 -- is not appropriate for bit packing. This is the case where we
707 -- have Is_Packed set (we would never be in this unit otherwise),
708 -- but Is_Bit_Packed_Array is false.
710 -- Note that if the component size is appropriate for bit packing,
711 -- then the circuit for the computation of the subscript properly
712 -- deals with the non-standard enumeration type case by taking the
713 -- Pos anyway.
715 if not Is_Bit_Packed_Array (Typ) then
717 -- Here we build a declaration:
719 -- type tttP is array (index1, index2, ...) of component_type
721 -- where index1, index2, are the index types. These are the same
722 -- as the index types of the original array, except for the non-
723 -- standard representation enumeration type case, where we have
724 -- two subcases.
726 -- For the unconstrained array case, we use
728 -- Natural range <>
730 -- For the constrained case, we use
732 -- Natural range Enum_Type'Pos (Enum_Type'First) ..
733 -- Enum_Type'Pos (Enum_Type'Last);
735 -- Note that tttP is created even if no index subtype is a non
736 -- standard enumeration, because we still need to remove padding
737 -- normally inserted for component alignment.
739 PAT :=
740 Make_Defining_Identifier (Loc,
741 Chars => New_External_Name (Chars (Typ), 'P'));
743 declare
744 Indexes : constant List_Id := New_List;
745 Indx : Node_Id;
746 Indx_Typ : Entity_Id;
747 Enum_Case : Boolean;
748 Typedef : Node_Id;
750 begin
751 Indx := First_Index (Typ);
753 while Present (Indx) loop
754 Indx_Typ := Etype (Indx);
756 Enum_Case := Is_Enumeration_Type (Indx_Typ)
757 and then Has_Non_Standard_Rep (Indx_Typ);
759 -- Unconstrained case
761 if not Is_Constrained (Typ) then
762 if Enum_Case then
763 Indx_Typ := Standard_Natural;
764 end if;
766 Append_To (Indexes, New_Occurrence_Of (Indx_Typ, Loc));
768 -- Constrained case
770 else
771 if not Enum_Case then
772 Append_To (Indexes, New_Occurrence_Of (Indx_Typ, Loc));
774 else
775 Append_To (Indexes,
776 Make_Subtype_Indication (Loc,
777 Subtype_Mark =>
778 New_Occurrence_Of (Standard_Natural, Loc),
779 Constraint =>
780 Make_Range_Constraint (Loc,
781 Range_Expression =>
782 Make_Range (Loc,
783 Low_Bound =>
784 Make_Attribute_Reference (Loc,
785 Prefix =>
786 New_Occurrence_Of (Indx_Typ, Loc),
787 Attribute_Name => Name_Pos,
788 Expressions => New_List (
789 Make_Attribute_Reference (Loc,
790 Prefix =>
791 New_Occurrence_Of (Indx_Typ, Loc),
792 Attribute_Name => Name_First))),
794 High_Bound =>
795 Make_Attribute_Reference (Loc,
796 Prefix =>
797 New_Occurrence_Of (Indx_Typ, Loc),
798 Attribute_Name => Name_Pos,
799 Expressions => New_List (
800 Make_Attribute_Reference (Loc,
801 Prefix =>
802 New_Occurrence_Of (Indx_Typ, Loc),
803 Attribute_Name => Name_Last)))))));
805 end if;
806 end if;
808 Next_Index (Indx);
809 end loop;
811 if not Is_Constrained (Typ) then
812 Typedef :=
813 Make_Unconstrained_Array_Definition (Loc,
814 Subtype_Marks => Indexes,
815 Component_Definition =>
816 Make_Component_Definition (Loc,
817 Aliased_Present => False,
818 Subtype_Indication =>
819 New_Occurrence_Of (Ctyp, Loc)));
821 else
822 Typedef :=
823 Make_Constrained_Array_Definition (Loc,
824 Discrete_Subtype_Definitions => Indexes,
825 Component_Definition =>
826 Make_Component_Definition (Loc,
827 Aliased_Present => False,
828 Subtype_Indication =>
829 New_Occurrence_Of (Ctyp, Loc)));
830 end if;
832 Decl :=
833 Make_Full_Type_Declaration (Loc,
834 Defining_Identifier => PAT,
835 Type_Definition => Typedef);
836 end;
838 Install_PAT;
840 -- Propagate the reverse storage order flag to the base type
842 Set_Reverse_Storage_Order (Etype (PAT), Reverse_Storage_Order (Typ));
843 return;
845 -- Case of bit-packing required for unconstrained array. We create
846 -- a subtype that is equivalent to use Packed_Bytes{1,2,4} as needed.
848 elsif not Is_Constrained (Typ) then
850 -- When generating standard DWARF (i.e when GNAT_Encodings is not
851 -- DWARF_GNAT_Encodings_All), the ___XP suffix will be stripped
852 -- by the back-end but generate it anyway to ease compiler debugging.
853 -- This will help to distinguish implementation types from original
854 -- packed arrays.
856 PAT :=
857 Make_Defining_Identifier (Loc,
858 Chars => Make_Packed_Array_Impl_Type_Name (Typ, Csize));
860 Set_PB_Type;
862 Decl :=
863 Make_Subtype_Declaration (Loc,
864 Defining_Identifier => PAT,
865 Subtype_Indication => New_Occurrence_Of (PB_Type, Loc));
867 Install_PAT;
868 return;
870 -- Remaining code is for the case of bit-packing for constrained array
872 -- The name of the packed array subtype is
874 -- ttt___XPsss
876 -- where sss is the component size in bits and ttt is the name of
877 -- the parent packed type.
879 else
880 PAT :=
881 Make_Defining_Identifier (Loc,
882 Chars => Make_Packed_Array_Impl_Type_Name (Typ, Csize));
884 -- Build an expression for the length of the array in bits.
885 -- This is the product of the length of each of the dimensions
887 Len_Expr := Compute_Number_Components (Typ, Typ);
889 -- Temporarily attach the length expression to the tree and analyze
890 -- and resolve it, so that we can test its value. We assume that the
891 -- total length fits in type Integer. This expression may involve
892 -- discriminants, so we treat it as a default/per-object expression.
894 Set_Parent (Len_Expr, Typ);
895 Preanalyze_Spec_Expression (Len_Expr, Standard_Long_Long_Integer);
897 -- Use a modular type if possible. We can do this if we have
898 -- static bounds, and the length is small enough, and the length
899 -- is not zero. We exclude the zero length case because the size
900 -- of things is always at least one, and the zero length object
901 -- would have an anomalous size.
903 if Compile_Time_Known_Value (Len_Expr) then
904 Len_Bits := Expr_Value (Len_Expr) * Csize;
906 -- Check for size known to be too large
908 if Len_Bits >
909 Uint_2 ** (Standard_Integer_Size - 1) * System_Storage_Unit
910 then
911 if System_Storage_Unit = 8 then
912 Error_Msg_N
913 ("packed array size cannot exceed " &
914 "Integer''Last bytes", Typ);
915 else
916 Error_Msg_N
917 ("packed array size cannot exceed " &
918 "Integer''Last storage units", Typ);
919 end if;
921 -- Reset length to arbitrary not too high value to continue
923 Len_Expr := Make_Integer_Literal (Loc, 65535);
924 Analyze_And_Resolve (Len_Expr, Standard_Long_Long_Integer);
925 end if;
927 -- We normally consider small enough to mean no larger than the
928 -- value of System_Max_Binary_Modulus_Power, checking that in the
929 -- case of values longer than word size, we have long shifts.
931 if Len_Bits > 0
932 and then
933 (Len_Bits <= System_Word_Size
934 or else (Len_Bits <= System_Max_Binary_Modulus_Power
935 and then Support_Long_Shifts_On_Target))
936 then
937 -- We can use the modular type, it has the form:
939 -- subtype tttPn is btyp
940 -- range 0 .. 2 ** ((Typ'Length (1)
941 -- * ... * Typ'Length (n)) * Csize) - 1;
943 -- The bounds are statically known, and btyp is one of the
944 -- unsigned types, depending on the length.
946 Btyp := Small_Integer_Type_For (Len_Bits, Uns => True);
947 Lit := Make_Integer_Literal (Loc, 2 ** Len_Bits - 1);
948 Set_Print_In_Hex (Lit);
950 Decl :=
951 Make_Subtype_Declaration (Loc,
952 Defining_Identifier => PAT,
953 Subtype_Indication =>
954 Make_Subtype_Indication (Loc,
955 Subtype_Mark => New_Occurrence_Of (Btyp, Loc),
957 Constraint =>
958 Make_Range_Constraint (Loc,
959 Range_Expression =>
960 Make_Range (Loc,
961 Low_Bound =>
962 Make_Integer_Literal (Loc, 0),
963 High_Bound => Lit))));
965 if Present (PASize) then
966 PASize := Len_Bits;
967 end if;
969 Install_PAT;
971 -- Propagate a given alignment to the modular type. This can
972 -- cause it to be under-aligned, but that's OK.
974 if Present (Alignment_Clause (Typ)) then
975 Set_Alignment (PAT, Alignment (Typ));
976 end if;
978 return;
979 end if;
980 end if;
982 -- Could not use a modular type, for all other cases, we build
983 -- a packed array subtype:
985 -- subtype tttPn is
986 -- System.Packed_Bytes{1,2,4} (0 .. (Bits + 7) / 8 - 1);
988 -- Bits is the length of the array in bits
990 Set_PB_Type;
992 Bits_U1 :=
993 Make_Op_Add (Loc,
994 Left_Opnd =>
995 Make_Op_Multiply (Loc,
996 Left_Opnd =>
997 Make_Integer_Literal (Loc, Csize),
998 Right_Opnd => Len_Expr),
1000 Right_Opnd =>
1001 Make_Integer_Literal (Loc, 7));
1003 Set_Paren_Count (Bits_U1, 1);
1005 PAT_High :=
1006 Make_Op_Subtract (Loc,
1007 Left_Opnd =>
1008 Make_Op_Divide (Loc,
1009 Left_Opnd => Bits_U1,
1010 Right_Opnd => Make_Integer_Literal (Loc, 8)),
1011 Right_Opnd => Make_Integer_Literal (Loc, 1));
1013 Decl :=
1014 Make_Subtype_Declaration (Loc,
1015 Defining_Identifier => PAT,
1016 Subtype_Indication =>
1017 Make_Subtype_Indication (Loc,
1018 Subtype_Mark => New_Occurrence_Of (PB_Type, Loc),
1019 Constraint =>
1020 Make_Index_Or_Discriminant_Constraint (Loc,
1021 Constraints => New_List (
1022 Make_Range (Loc,
1023 Low_Bound =>
1024 Make_Integer_Literal (Loc, 0),
1025 High_Bound =>
1026 Convert_To (Standard_Integer, PAT_High))))));
1028 Install_PAT;
1030 -- Currently the code in this unit requires that packed arrays
1031 -- represented by non-modular arrays of bytes be on a byte
1032 -- boundary for bit sizes handled by System.Pack_nn units.
1033 -- That's because these units assume the array being accessed
1034 -- starts on a byte boundary.
1036 if Get_Id (UI_To_Int (Csize)) /= RE_Null then
1037 Set_Must_Be_On_Byte_Boundary (Typ);
1038 end if;
1039 end if;
1040 end Create_Packed_Array_Impl_Type;
1042 -----------------------------------
1043 -- Expand_Bit_Packed_Element_Set --
1044 -----------------------------------
1046 procedure Expand_Bit_Packed_Element_Set (N : Node_Id) is
1047 Loc : constant Source_Ptr := Sloc (N);
1048 Lhs : constant Node_Id := Name (N);
1050 Ass_OK : constant Boolean := Assignment_OK (Lhs);
1051 -- Used to preserve assignment OK status when assignment is rewritten
1053 Expr : Node_Id;
1055 Rhs : Node_Id := Expression (N);
1056 -- Initially Rhs is the right hand side value, it will be replaced
1057 -- later by an appropriate unchecked conversion for the assignment.
1059 Obj : Node_Id;
1060 Atyp : Entity_Id;
1061 PAT : Entity_Id;
1062 Cmask : Uint;
1064 Arr_Typ : constant Entity_Id := Etype (Prefix (Lhs));
1065 Ctyp : constant Entity_Id := Component_Type (Arr_Typ);
1066 Csiz : constant Int := UI_To_Int (Component_Size (Arr_Typ));
1068 Shift : Node_Id;
1069 -- The expression for the shift value that is required
1071 Shift_Used : Boolean := False;
1072 -- Set True if Shift has been used in the generated code at least once,
1073 -- so that it must be duplicated if used again.
1075 New_Lhs : Node_Id;
1076 New_Rhs : Node_Id;
1078 Rhs_Val : Uint;
1079 -- If the value of the right hand side as an integer constant is
1080 -- known at compile time, Rhs_Val contains the value.
1082 function Get_Shift return Node_Id;
1083 -- Function used to get the value of Shift, making sure that it
1084 -- gets duplicated if the function is called more than once.
1086 ---------------
1087 -- Get_Shift --
1088 ---------------
1090 function Get_Shift return Node_Id is
1091 begin
1092 -- If we used the shift value already, then duplicate it. We
1093 -- set a temporary parent in case actions have to be inserted.
1095 if Shift_Used then
1096 Set_Parent (Shift, N);
1097 return Duplicate_Subexpr_No_Checks (Shift);
1099 -- If first time, use Shift unchanged, and set flag for first use
1101 else
1102 Shift_Used := True;
1103 return Shift;
1104 end if;
1105 end Get_Shift;
1107 -- Start of processing for Expand_Bit_Packed_Element_Set
1109 begin
1110 pragma Assert (Is_Bit_Packed_Array (Etype (Prefix (Lhs))));
1112 Obj := Relocate_Node (Prefix (Lhs));
1113 Convert_To_Actual_Subtype (Obj);
1114 Atyp := Etype (Obj);
1115 PAT := Packed_Array_Impl_Type (Atyp);
1117 -- We remove side effects, in case the rhs modifies the lhs, because we
1118 -- are about to transform the rhs into an expression that first READS
1119 -- the lhs, so we can do the necessary shifting and masking. Example:
1120 -- "X(2) := F(...);" where F modifies X(3). Otherwise, the side effect
1121 -- will be lost.
1123 Remove_Side_Effects (Rhs);
1125 -- We convert the right hand side to the proper subtype to ensure
1126 -- that an appropriate range check is made (since the normal range
1127 -- check from assignment will be lost in the transformations). This
1128 -- conversion is analyzed immediately so that subsequent processing
1129 -- can work with an analyzed Rhs (and e.g. look at its Etype)
1131 -- If the right-hand side is a string literal, create a temporary for
1132 -- it, constant-folding is not ready to wrap the bit representation
1133 -- of a string literal.
1135 if Nkind (Rhs) = N_String_Literal then
1136 declare
1137 Decl : constant Node_Id :=
1138 Make_Object_Declaration (Loc,
1139 Defining_Identifier => Make_Temporary (Loc, 'T', Rhs),
1140 Object_Definition => New_Occurrence_Of (Ctyp, Loc),
1141 Expression => New_Copy_Tree (Rhs));
1142 begin
1143 Insert_Actions (N, New_List (Decl));
1144 Rhs := New_Occurrence_Of (Defining_Identifier (Decl), Loc);
1145 end;
1146 else
1147 Rhs := Convert_To (Ctyp, Rhs);
1148 end if;
1150 Set_Parent (Rhs, N);
1152 -- If we are building the initialization procedure for a packed array,
1153 -- and Initialize_Scalars is enabled, each component assignment is an
1154 -- out-of-range value by design. Compile this value without checks,
1155 -- because a call to the array init_proc must not raise an exception.
1157 -- Condition is not consistent with description above, Within_Init_Proc
1158 -- is True also when we are building the IP for a record or protected
1159 -- type that has a packed array component???
1161 if Within_Init_Proc
1162 and then Initialize_Scalars
1163 then
1164 Analyze_And_Resolve (Rhs, Ctyp, Suppress => All_Checks);
1165 else
1166 Analyze_And_Resolve (Rhs, Ctyp);
1167 end if;
1169 -- If any of the indices has a nonstandard representation, introduce
1170 -- the proper Rep_To_Pos conversion, which in turn will generate index
1171 -- checks when needed. We do this on a copy of the index expression,
1172 -- rather that rewriting the LHS altogether.
1174 Expr := First (Expressions (Lhs));
1175 while Present (Expr) loop
1176 declare
1177 Expr_Typ : constant Entity_Id := Etype (Expr);
1178 Loc : constant Source_Ptr := Sloc (Expr);
1180 Expr_Copy : Node_Id;
1182 begin
1183 if Is_Enumeration_Type (Expr_Typ)
1184 and then Has_Non_Standard_Rep (Expr_Typ)
1185 then
1186 Expr_Copy :=
1187 Make_Attribute_Reference (Loc,
1188 Prefix => New_Occurrence_Of (Expr_Typ, Loc),
1189 Attribute_Name => Name_Pos,
1190 Expressions => New_List (Relocate_Node (Expr)));
1191 Set_Parent (Expr_Copy, N);
1192 Analyze_And_Resolve (Expr_Copy, Standard_Natural);
1193 end if;
1194 end;
1196 Next (Expr);
1197 end loop;
1199 -- Case of component size 1,2,4 or any component size for the modular
1200 -- case. These are the cases for which we can inline the code.
1202 if Csiz = 1 or else Csiz = 2 or else Csiz = 4
1203 or else (Present (PAT) and then Is_Modular_Integer_Type (PAT))
1204 then
1205 Setup_Inline_Packed_Array_Reference (Lhs, Atyp, Obj, Cmask, Shift);
1207 -- The statement to be generated is:
1209 -- Obj := atyp!((Obj and Mask1) or (shift_left (rhs, Shift)))
1211 -- or in the case of a freestanding Reverse_Storage_Order object,
1213 -- Obj := Swap (atyp!((Swap (Obj) and Mask1)
1214 -- or (shift_left (rhs, Shift))))
1216 -- where Mask1 is obtained by shifting Cmask left Shift bits
1217 -- and then complementing the result.
1219 -- the "and Mask1" is omitted if rhs is constant and all 1 bits
1221 -- the "or ..." is omitted if rhs is constant and all 0 bits
1223 -- rhs is converted to the appropriate type
1225 -- The result is converted back to the array type, since
1226 -- otherwise we lose knowledge of the packed nature.
1228 -- Determine if right side is all 0 bits or all 1 bits
1230 if Compile_Time_Known_Value (Rhs) then
1231 Rhs_Val := Expr_Rep_Value (Rhs);
1233 -- The following test catches the case of an unchecked conversion of
1234 -- an integer literal. This results from optimizing aggregates of
1235 -- packed types.
1237 elsif Nkind (Rhs) = N_Unchecked_Type_Conversion
1238 and then Compile_Time_Known_Value (Expression (Rhs))
1239 then
1240 Rhs_Val := Expr_Rep_Value (Expression (Rhs));
1242 else
1243 Rhs_Val := No_Uint;
1244 end if;
1246 -- Some special checks for the case where the right hand value is
1247 -- known at compile time. Basically we have to take care of the
1248 -- implicit conversion to the subtype of the component object.
1250 if Present (Rhs_Val) then
1252 -- If we have a biased component type then we must manually do the
1253 -- biasing, since we are taking responsibility in this case for
1254 -- constructing the exact bit pattern to be used.
1256 if Has_Biased_Representation (Ctyp) then
1257 Rhs_Val := Rhs_Val - Expr_Rep_Value (Type_Low_Bound (Ctyp));
1258 end if;
1260 -- For a negative value, we manually convert the two's complement
1261 -- value to a corresponding unsigned value, so that the proper
1262 -- field width is maintained. If we did not do this, we would
1263 -- get too many leading sign bits later on.
1265 if Rhs_Val < 0 then
1266 Rhs_Val := 2 ** UI_From_Int (Csiz) + Rhs_Val;
1267 end if;
1268 end if;
1270 -- Now create copies removing side effects. Note that in some complex
1271 -- cases, this may cause the fact that we have already set a packed
1272 -- array type on Obj to get lost. So we save the type of Obj, and
1273 -- make sure it is reset properly.
1275 declare
1276 T : constant Entity_Id := Etype (Obj);
1277 begin
1278 New_Lhs := Duplicate_Subexpr (Obj, Name_Req => True);
1279 New_Rhs := Duplicate_Subexpr_No_Checks (Obj);
1280 Set_Etype (Obj, T);
1281 Set_Etype (New_Lhs, T);
1282 Set_Etype (New_Rhs, T);
1283 end;
1285 -- First we deal with the "and"
1287 if No (Rhs_Val) or else Rhs_Val /= Cmask then
1288 declare
1289 Mask1 : Node_Id;
1290 Lit : Node_Id;
1292 begin
1293 if Compile_Time_Known_Value (Shift) then
1294 Mask1 :=
1295 Make_Integer_Literal (Loc,
1296 Modulus (Etype (Obj)) - 1 -
1297 (Cmask * (2 ** Expr_Value (Get_Shift))));
1298 Set_Print_In_Hex (Mask1);
1300 else
1301 Lit := Make_Integer_Literal (Loc, Cmask);
1302 Set_Print_In_Hex (Lit);
1303 Mask1 :=
1304 Make_Op_Not (Loc,
1305 Right_Opnd => Make_Shift_Left (Lit, Get_Shift));
1306 end if;
1308 New_Rhs :=
1309 Make_Op_And (Loc,
1310 Left_Opnd => New_Rhs,
1311 Right_Opnd => Mask1);
1312 end;
1313 end if;
1315 -- Then deal with the "or"
1317 if No (Rhs_Val) or else Rhs_Val /= 0 then
1318 declare
1319 Or_Rhs : Node_Id;
1321 procedure Fixup_Rhs;
1322 -- Adjust Rhs by bias if biased representation for components
1323 -- or remove extraneous high order sign bits if signed.
1325 procedure Fixup_Rhs is
1326 Etyp : constant Entity_Id := Etype (Rhs);
1328 begin
1329 -- For biased case, do the required biasing by simply
1330 -- converting to the biased subtype (the conversion
1331 -- will generate the required bias).
1333 if Has_Biased_Representation (Ctyp) then
1334 Rhs := Convert_To (Ctyp, Rhs);
1336 -- For a signed integer type that is not biased, generate
1337 -- a conversion to unsigned to strip high order sign bits.
1339 elsif Is_Signed_Integer_Type (Ctyp) then
1340 Rhs := Unchecked_Convert_To (RTE (Bits_Id (Csiz)), Rhs);
1341 end if;
1343 -- Set Etype, since it can be referenced before the node is
1344 -- completely analyzed.
1346 Set_Etype (Rhs, Etyp);
1348 -- We now need to do an unchecked conversion of the
1349 -- result to the target type, but it is important that
1350 -- this conversion be a right justified conversion and
1351 -- not a left justified conversion.
1353 Rhs := RJ_Unchecked_Convert_To (Etype (Obj), Rhs);
1354 end Fixup_Rhs;
1356 begin
1357 if Present (Rhs_Val)
1358 and then Compile_Time_Known_Value (Get_Shift)
1359 then
1360 Or_Rhs :=
1361 Make_Integer_Literal (Loc,
1362 Rhs_Val * (2 ** Expr_Value (Get_Shift)));
1363 Set_Print_In_Hex (Or_Rhs);
1365 else
1366 -- We have to convert the right hand side to Etype (Obj).
1367 -- A special case arises if what we have now is a Val
1368 -- attribute reference whose expression type is Etype (Obj).
1369 -- This happens for assignments of fields from the same
1370 -- array. In this case we get the required right hand side
1371 -- by simply removing the inner attribute reference.
1373 if Nkind (Rhs) = N_Attribute_Reference
1374 and then Attribute_Name (Rhs) = Name_Val
1375 and then Etype (First (Expressions (Rhs))) = Etype (Obj)
1376 then
1377 Rhs := Relocate_Node (First (Expressions (Rhs)));
1378 Fixup_Rhs;
1380 -- If the value of the right hand side is a known integer
1381 -- value, then just replace it by an untyped constant,
1382 -- which will be properly retyped when we analyze and
1383 -- resolve the expression.
1385 elsif Present (Rhs_Val) then
1387 -- Note that Rhs_Val has already been normalized to
1388 -- be an unsigned value with the proper number of bits.
1390 Rhs := Make_Integer_Literal (Loc, Rhs_Val);
1392 -- Otherwise we need an unchecked conversion
1394 else
1395 Fixup_Rhs;
1396 end if;
1398 Or_Rhs := Make_Shift_Left (Rhs, Get_Shift);
1399 end if;
1401 if Nkind (New_Rhs) = N_Op_And then
1402 Set_Paren_Count (New_Rhs, 1);
1403 Set_Etype (New_Rhs, Etype (Left_Opnd (New_Rhs)));
1404 end if;
1406 New_Rhs :=
1407 Make_Op_Or (Loc,
1408 Left_Opnd => New_Rhs,
1409 Right_Opnd => Or_Rhs);
1410 end;
1411 end if;
1413 -- Now do the rewrite
1415 Rewrite (N,
1416 Make_Assignment_Statement (Loc,
1417 Name => New_Lhs,
1418 Expression =>
1419 Unchecked_Convert_To (Etype (New_Lhs), New_Rhs)));
1420 Set_Assignment_OK (Name (N), Ass_OK);
1422 -- All other component sizes for non-modular case
1424 else
1425 -- We generate
1427 -- Set_nn (Arr'address, Subscr, Bits_nn!(Rhs))
1429 -- where Subscr is the computed linear subscript
1431 declare
1432 Bits_nn : constant Entity_Id := RTE (Bits_Id (Csiz));
1433 Set_nn : Entity_Id;
1434 Subscr : Node_Id;
1435 Rev_SSO : Node_Id;
1437 begin
1438 if No (Bits_nn) then
1440 -- Error, most likely High_Integrity_Mode restriction
1442 return;
1443 end if;
1445 -- Acquire proper Set entity. We use the aligned or unaligned
1446 -- case as appropriate.
1448 if Known_Aligned_Enough (Obj, Csiz) then
1449 Set_nn := RTE (Set_Id (Csiz));
1450 else
1451 Set_nn := RTE (SetU_Id (Csiz));
1452 end if;
1454 -- Now generate the set reference
1456 Compute_Linear_Subscript (Atyp, Lhs, Subscr);
1458 -- Set indication of whether the packed array has reverse SSO
1460 Rev_SSO :=
1461 New_Occurrence_Of
1462 (Boolean_Literals (Reverse_Storage_Order (Atyp)), Loc);
1464 -- Below we must make the assumption that Obj is
1465 -- at least byte aligned, since otherwise its address
1466 -- cannot be taken. The assumption holds since the
1467 -- only arrays that can be misaligned are small packed
1468 -- arrays which are implemented as a modular type, and
1469 -- that is not the case here.
1471 Rewrite (N,
1472 Make_Procedure_Call_Statement (Loc,
1473 Name => New_Occurrence_Of (Set_nn, Loc),
1474 Parameter_Associations => New_List (
1475 Make_Attribute_Reference (Loc,
1476 Prefix => Obj,
1477 Attribute_Name => Name_Address),
1478 Subscr,
1479 Unchecked_Convert_To (Bits_nn, Convert_To (Ctyp, Rhs)),
1480 Rev_SSO)));
1482 end;
1483 end if;
1485 Analyze (N, Suppress => All_Checks);
1486 end Expand_Bit_Packed_Element_Set;
1488 -------------------------------------
1489 -- Expand_Packed_Address_Reference --
1490 -------------------------------------
1492 procedure Expand_Packed_Address_Reference (N : Node_Id) is
1493 Loc : constant Source_Ptr := Sloc (N);
1494 Base : Node_Id;
1495 Offset : Node_Id;
1497 begin
1498 -- We build an expression that has the form
1500 -- outer_object'Address
1501 -- + (linear-subscript * component_size for each array reference
1502 -- + field'Bit_Position for each record field
1503 -- + ...
1504 -- + ...) / Storage_Unit;
1506 Get_Base_And_Bit_Offset (Prefix (N), Base, Offset);
1508 Rewrite (N,
1509 Unchecked_Convert_To (RTE (RE_Address),
1510 Make_Op_Add (Loc,
1511 Left_Opnd =>
1512 Unchecked_Convert_To (RTE (RE_Integer_Address),
1513 Make_Attribute_Reference (Loc,
1514 Prefix => Base,
1515 Attribute_Name => Name_Address)),
1517 Right_Opnd =>
1518 Unchecked_Convert_To (RTE (RE_Integer_Address),
1519 Make_Op_Divide (Loc,
1520 Left_Opnd => Offset,
1521 Right_Opnd =>
1522 Make_Integer_Literal (Loc, System_Storage_Unit))))));
1524 Analyze_And_Resolve (N, RTE (RE_Address));
1525 end Expand_Packed_Address_Reference;
1527 ---------------------------------
1528 -- Expand_Packed_Bit_Reference --
1529 ---------------------------------
1531 procedure Expand_Packed_Bit_Reference (N : Node_Id) is
1532 Loc : constant Source_Ptr := Sloc (N);
1533 Base : Node_Id;
1534 Offset : Node_Id;
1536 begin
1537 -- We build an expression that has the form
1539 -- (linear-subscript * component_size for each array reference
1540 -- + field'Bit_Position for each record field
1541 -- + ...
1542 -- + ...) mod Storage_Unit;
1544 Get_Base_And_Bit_Offset (Prefix (N), Base, Offset);
1546 Rewrite (N,
1547 Unchecked_Convert_To (Standard_Natural,
1548 Make_Op_Mod (Loc,
1549 Left_Opnd => Offset,
1550 Right_Opnd => Make_Integer_Literal (Loc, System_Storage_Unit))));
1552 Analyze_And_Resolve (N, Standard_Natural);
1553 end Expand_Packed_Bit_Reference;
1555 ------------------------------------
1556 -- Expand_Packed_Boolean_Operator --
1557 ------------------------------------
1559 -- This routine expands "a op b" for the packed cases
1561 procedure Expand_Packed_Boolean_Operator (N : Node_Id) is
1562 Loc : constant Source_Ptr := Sloc (N);
1563 Typ : constant Entity_Id := Etype (N);
1564 L : constant Node_Id := Relocate_Node (Left_Opnd (N));
1565 R : Node_Id := Relocate_Node (Right_Opnd (N));
1567 Ltyp : Entity_Id;
1568 Rtyp : Entity_Id;
1569 PAT : Entity_Id;
1571 begin
1572 Convert_To_Actual_Subtype (L);
1573 Convert_To_Actual_Subtype (R);
1575 Ensure_Defined (Etype (L), N);
1576 Ensure_Defined (Etype (R), N);
1578 Apply_Length_Check (R, Etype (L));
1580 Ltyp := Etype (L);
1581 Rtyp := Etype (R);
1583 -- Deal with silly case of XOR where the subcomponent has a range
1584 -- True .. True where an exception must be raised.
1586 if Nkind (N) = N_Op_Xor then
1587 R := Duplicate_Subexpr (R);
1588 Silly_Boolean_Array_Xor_Test (N, R, Rtyp);
1589 end if;
1591 -- Now that silliness is taken care of, get packed array type
1593 Convert_To_PAT_Type (L);
1594 Convert_To_PAT_Type (R);
1596 PAT := Etype (L);
1598 -- For the modular case, we expand a op b into
1600 -- rtyp!(pat!(a) op pat!(b))
1602 -- where rtyp is the Etype of the left operand. Note that we do not
1603 -- convert to the base type, since this would be unconstrained, and
1604 -- hence not have a corresponding packed array type set.
1606 -- Note that both operands must be modular for this code to be used
1608 if Is_Modular_Integer_Type (PAT)
1609 and then
1610 Is_Modular_Integer_Type (Etype (R))
1611 then
1612 declare
1613 P : Node_Id;
1615 begin
1616 if Nkind (N) = N_Op_And then
1617 P := Make_Op_And (Loc, L, R);
1619 elsif Nkind (N) = N_Op_Or then
1620 P := Make_Op_Or (Loc, L, R);
1622 else -- Nkind (N) = N_Op_Xor
1623 P := Make_Op_Xor (Loc, L, R);
1624 end if;
1626 Rewrite (N, Unchecked_Convert_To (Ltyp, P));
1627 end;
1629 -- For the array case, we insert the actions
1631 -- Result : Ltype;
1633 -- System.Bit_Ops.Bit_And/Or/Xor
1634 -- (Left'Address,
1635 -- Ltype'Length * Ltype'Component_Size;
1636 -- Right'Address,
1637 -- Rtype'Length * Rtype'Component_Size
1638 -- Result'Address);
1640 -- where Left and Right are the Packed_Bytes{1,2,4} operands and
1641 -- the second argument and fourth arguments are the lengths of the
1642 -- operands in bits. Then we replace the expression by a reference
1643 -- to Result.
1645 -- Note that if we are mixing a modular and array operand, everything
1646 -- works fine, since we ensure that the modular representation has the
1647 -- same physical layout as the array representation (that's what the
1648 -- left justified modular stuff in the big-endian case is about).
1650 else
1651 declare
1652 Result_Ent : constant Entity_Id := Make_Temporary (Loc, 'T');
1653 E_Id : RE_Id;
1655 begin
1656 if Nkind (N) = N_Op_And then
1657 E_Id := RE_Bit_And;
1659 elsif Nkind (N) = N_Op_Or then
1660 E_Id := RE_Bit_Or;
1662 else -- Nkind (N) = N_Op_Xor
1663 E_Id := RE_Bit_Xor;
1664 end if;
1666 Insert_Actions (N, New_List (
1668 Make_Object_Declaration (Loc,
1669 Defining_Identifier => Result_Ent,
1670 Object_Definition => New_Occurrence_Of (Ltyp, Loc)),
1672 Make_Procedure_Call_Statement (Loc,
1673 Name => New_Occurrence_Of (RTE (E_Id), Loc),
1674 Parameter_Associations => New_List (
1676 Make_Byte_Aligned_Attribute_Reference (Loc,
1677 Prefix => L,
1678 Attribute_Name => Name_Address),
1680 Make_Op_Multiply (Loc,
1681 Left_Opnd =>
1682 Make_Attribute_Reference (Loc,
1683 Prefix =>
1684 New_Occurrence_Of
1685 (Etype (First_Index (Ltyp)), Loc),
1686 Attribute_Name => Name_Range_Length),
1688 Right_Opnd =>
1689 Make_Integer_Literal (Loc, Component_Size (Ltyp))),
1691 Make_Byte_Aligned_Attribute_Reference (Loc,
1692 Prefix => R,
1693 Attribute_Name => Name_Address),
1695 Make_Op_Multiply (Loc,
1696 Left_Opnd =>
1697 Make_Attribute_Reference (Loc,
1698 Prefix =>
1699 New_Occurrence_Of
1700 (Etype (First_Index (Rtyp)), Loc),
1701 Attribute_Name => Name_Range_Length),
1703 Right_Opnd =>
1704 Make_Integer_Literal (Loc, Component_Size (Rtyp))),
1706 Make_Byte_Aligned_Attribute_Reference (Loc,
1707 Prefix => New_Occurrence_Of (Result_Ent, Loc),
1708 Attribute_Name => Name_Address)))));
1710 Rewrite (N,
1711 New_Occurrence_Of (Result_Ent, Loc));
1712 end;
1713 end if;
1715 Analyze_And_Resolve (N, Typ, Suppress => All_Checks);
1716 end Expand_Packed_Boolean_Operator;
1718 -------------------------------------
1719 -- Expand_Packed_Element_Reference --
1720 -------------------------------------
1722 procedure Expand_Packed_Element_Reference (N : Node_Id) is
1723 Loc : constant Source_Ptr := Sloc (N);
1724 Obj : Node_Id;
1725 Atyp : Entity_Id;
1726 PAT : Entity_Id;
1727 Ctyp : Entity_Id;
1728 Csiz : Int;
1729 Shift : Node_Id;
1730 Cmask : Uint;
1731 Lit : Node_Id;
1732 Arg : Node_Id;
1734 begin
1735 -- If the node is an actual in a call, the prefix has not been fully
1736 -- expanded, to account for the additional expansion for in-out actuals
1737 -- (see expand_actuals for details). If the prefix itself is a packed
1738 -- reference as well, we have to recurse to complete the transformation
1739 -- of the prefix.
1741 if Nkind (Prefix (N)) = N_Indexed_Component
1742 and then not Analyzed (Prefix (N))
1743 and then Is_Bit_Packed_Array (Etype (Prefix (Prefix (N))))
1744 then
1745 Expand_Packed_Element_Reference (Prefix (N));
1746 end if;
1748 -- The prefix may be rewritten below as a conversion. If it is a source
1749 -- entity generate reference to it now, to prevent spurious warnings
1750 -- about unused entities.
1752 if Is_Entity_Name (Prefix (N))
1753 and then Comes_From_Source (Prefix (N))
1754 then
1755 Generate_Reference (Entity (Prefix (N)), Prefix (N), 'r');
1756 end if;
1758 -- If not bit packed, we have the enumeration case, which is easily
1759 -- dealt with (just adjust the subscripts of the indexed component)
1761 -- Note: this leaves the result as an indexed component, which is
1762 -- still a variable, so can be used in the assignment case, as is
1763 -- required in the enumeration case.
1765 if not Is_Bit_Packed_Array (Etype (Prefix (N))) then
1766 Setup_Enumeration_Packed_Array_Reference (N);
1767 return;
1768 end if;
1770 -- Remaining processing is for the bit-packed case
1772 Obj := Relocate_Node (Prefix (N));
1773 Convert_To_Actual_Subtype (Obj);
1774 Atyp := Etype (Obj);
1775 PAT := Packed_Array_Impl_Type (Atyp);
1776 Ctyp := Component_Type (Atyp);
1777 Csiz := UI_To_Int (Component_Size (Atyp));
1779 -- Case of component size 1,2,4 or any component size for the modular
1780 -- case. These are the cases for which we can inline the code.
1782 if Csiz = 1 or else Csiz = 2 or else Csiz = 4
1783 or else (Present (PAT) and then Is_Modular_Integer_Type (PAT))
1784 then
1785 Setup_Inline_Packed_Array_Reference (N, Atyp, Obj, Cmask, Shift);
1786 Lit := Make_Integer_Literal (Loc, Cmask);
1787 Set_Print_In_Hex (Lit);
1789 -- We generate a shift right to position the field, followed by a
1790 -- masking operation to extract the bit field, and we finally do an
1791 -- unchecked conversion to convert the result to the required target.
1793 -- Note that the unchecked conversion automatically deals with the
1794 -- bias if we are dealing with a biased representation. What will
1795 -- happen is that we temporarily generate the biased representation,
1796 -- but almost immediately that will be converted to the original
1797 -- unbiased component type, and the bias will disappear.
1799 Arg :=
1800 Make_Op_And (Loc,
1801 Left_Opnd => Make_Shift_Right (Obj, Shift),
1802 Right_Opnd => Lit);
1803 Set_Etype (Arg, Ctyp);
1805 -- Component extraction is performed on a native endianness scalar
1806 -- value: if Atyp has reverse storage order, then it has been byte
1807 -- swapped, and if the component being extracted is itself of a
1808 -- composite type with reverse storage order, then we need to swap
1809 -- it back to its expected endianness after extraction.
1811 if Reverse_Storage_Order (Atyp)
1812 and then (Is_Record_Type (Ctyp) or else Is_Array_Type (Ctyp))
1813 and then Reverse_Storage_Order (Ctyp)
1814 then
1815 Arg := Revert_Storage_Order (Arg);
1816 end if;
1818 -- We needed to analyze this before we do the unchecked convert
1819 -- below, but we need it temporarily attached to the tree for
1820 -- this analysis (hence the temporary Set_Parent call).
1822 Set_Parent (Arg, Parent (N));
1823 Analyze_And_Resolve (Arg);
1825 Rewrite (N, RJ_Unchecked_Convert_To (Ctyp, Arg));
1827 -- All other component sizes for non-modular case
1829 else
1830 -- We generate
1832 -- Component_Type!(Get_nn (Arr'address, Subscr))
1834 -- where Subscr is the computed linear subscript
1836 declare
1837 Get_nn : Entity_Id;
1838 Subscr : Node_Id;
1839 Rev_SSO : constant Node_Id :=
1840 New_Occurrence_Of
1841 (Boolean_Literals (Reverse_Storage_Order (Atyp)), Loc);
1843 begin
1844 -- Acquire proper Get entity. We use the aligned or unaligned
1845 -- case as appropriate.
1847 if Known_Aligned_Enough (Obj, Csiz) then
1848 Get_nn := RTE (Get_Id (Csiz));
1849 else
1850 Get_nn := RTE (GetU_Id (Csiz));
1851 end if;
1853 -- Now generate the get reference
1855 Compute_Linear_Subscript (Atyp, N, Subscr);
1857 -- Below we make the assumption that Obj is at least byte
1858 -- aligned, since otherwise its address cannot be taken.
1859 -- The assumption holds since the only arrays that can be
1860 -- misaligned are small packed arrays which are implemented
1861 -- as a modular type, and that is not the case here.
1863 Rewrite (N,
1864 Unchecked_Convert_To (Ctyp,
1865 Make_Function_Call (Loc,
1866 Name => New_Occurrence_Of (Get_nn, Loc),
1867 Parameter_Associations => New_List (
1868 Make_Attribute_Reference (Loc,
1869 Prefix => Obj,
1870 Attribute_Name => Name_Address),
1871 Subscr,
1872 Rev_SSO))));
1873 end;
1874 end if;
1876 Analyze_And_Resolve (N, Ctyp, Suppress => All_Checks);
1877 end Expand_Packed_Element_Reference;
1879 ----------------------
1880 -- Expand_Packed_Eq --
1881 ----------------------
1883 -- Handles expansion of "=" on packed array types
1885 procedure Expand_Packed_Eq (N : Node_Id) is
1886 Loc : constant Source_Ptr := Sloc (N);
1887 L : constant Node_Id := Relocate_Node (Left_Opnd (N));
1888 R : constant Node_Id := Relocate_Node (Right_Opnd (N));
1890 LLexpr : Node_Id;
1891 RLexpr : Node_Id;
1893 Ltyp : Entity_Id;
1894 Rtyp : Entity_Id;
1895 PAT : Entity_Id;
1897 begin
1898 Convert_To_Actual_Subtype (L);
1899 Convert_To_Actual_Subtype (R);
1900 Ltyp := Underlying_Type (Etype (L));
1901 Rtyp := Underlying_Type (Etype (R));
1903 Convert_To_PAT_Type (L);
1904 Convert_To_PAT_Type (R);
1905 PAT := Etype (L);
1907 LLexpr :=
1908 Make_Op_Multiply (Loc,
1909 Left_Opnd => Compute_Number_Components (N, Ltyp),
1910 Right_Opnd => Make_Integer_Literal (Loc, Component_Size (Ltyp)));
1912 RLexpr :=
1913 Make_Op_Multiply (Loc,
1914 Left_Opnd => Compute_Number_Components (N, Rtyp),
1915 Right_Opnd => Make_Integer_Literal (Loc, Component_Size (Rtyp)));
1917 -- For the modular case, we transform the comparison to:
1919 -- Ltyp'Length = Rtyp'Length and then PAT!(L) = PAT!(R)
1921 -- where PAT is the packed array type. This works fine, since in the
1922 -- modular case we guarantee that the unused bits are always zeroes.
1923 -- We do have to compare the lengths because we could be comparing
1924 -- two different subtypes of the same base type. We can only do this
1925 -- if the PATs on both sides are modular (in which case they are
1926 -- necessarily structurally the same -- same Modulus and so on);
1927 -- otherwise, we have a case where the right operand is not of
1928 -- compile time known size.
1930 if Is_Modular_Integer_Type (PAT)
1931 and then Is_Modular_Integer_Type (Etype (R))
1932 then
1933 pragma Assert (RM_Size (Etype (R)) = RM_Size (PAT));
1934 pragma Assert (Modulus (Etype (R)) = Modulus (PAT));
1936 Rewrite (N,
1937 Make_And_Then (Loc,
1938 Left_Opnd =>
1939 Make_Op_Eq (Loc,
1940 Left_Opnd => LLexpr,
1941 Right_Opnd => RLexpr),
1943 Right_Opnd =>
1944 Make_Op_Eq (Loc,
1945 Left_Opnd => L,
1946 Right_Opnd => R)));
1948 -- For the non-modular case, we call a runtime routine
1950 -- System.Bit_Ops.Bit_Eq
1951 -- (L'Address, L_Length, R'Address, R_Length)
1953 -- where PAT is the packed array type, and the lengths are the lengths
1954 -- in bits of the original packed arrays. This routine takes care of
1955 -- not comparing the unused bits in the last byte.
1957 else
1958 Rewrite (N,
1959 Make_Function_Call (Loc,
1960 Name => New_Occurrence_Of (RTE (RE_Bit_Eq), Loc),
1961 Parameter_Associations => New_List (
1962 Make_Byte_Aligned_Attribute_Reference (Loc,
1963 Prefix => L,
1964 Attribute_Name => Name_Address),
1966 LLexpr,
1968 Make_Byte_Aligned_Attribute_Reference (Loc,
1969 Prefix => R,
1970 Attribute_Name => Name_Address),
1972 RLexpr)));
1973 end if;
1975 Analyze_And_Resolve (N, Standard_Boolean, Suppress => All_Checks);
1976 end Expand_Packed_Eq;
1978 -----------------------
1979 -- Expand_Packed_Not --
1980 -----------------------
1982 -- Handles expansion of "not" on packed array types
1984 procedure Expand_Packed_Not (N : Node_Id) is
1985 Loc : constant Source_Ptr := Sloc (N);
1986 Typ : constant Entity_Id := Etype (N);
1987 Opnd : constant Node_Id := Relocate_Node (Right_Opnd (N));
1989 Rtyp : Entity_Id;
1990 PAT : Entity_Id;
1991 Lit : Node_Id;
1992 Size : Unat;
1994 begin
1995 Convert_To_Actual_Subtype (Opnd);
1996 Rtyp := Etype (Opnd);
1998 -- Deal with silly False..False and True..True subtype case
2000 Silly_Boolean_Array_Not_Test (N, Rtyp);
2002 -- Now that the silliness is taken care of, get packed array type
2004 Convert_To_PAT_Type (Opnd);
2005 PAT := Etype (Opnd);
2007 -- For the case where the packed array type is a modular type, "not A"
2008 -- expands simply into:
2010 -- Rtyp!(PAT!(A) xor Mask)
2012 -- where PAT is the packed array type, Mask is a mask of all 1 bits of
2013 -- length equal to the size of this packed type, and Rtyp is the actual
2014 -- actual subtype of the operand. Preserve old behavior in case size is
2015 -- not set.
2017 if Known_RM_Size (PAT) then
2018 Size := RM_Size (PAT);
2019 else
2020 Size := Uint_0;
2021 end if;
2022 Lit := Make_Integer_Literal (Loc, 2 ** Size - 1);
2023 Set_Print_In_Hex (Lit);
2025 if not Is_Array_Type (PAT) then
2026 Rewrite (N,
2027 Unchecked_Convert_To (Rtyp,
2028 Make_Op_Xor (Loc,
2029 Left_Opnd => Opnd,
2030 Right_Opnd => Lit)));
2032 -- For the array case, we insert the actions
2034 -- Result : Typ;
2036 -- System.Bit_Ops.Bit_Not
2037 -- (Opnd'Address,
2038 -- Typ'Length * Typ'Component_Size,
2039 -- Result'Address);
2041 -- where Opnd is the Packed_Bytes{1,2,4} operand and the second argument
2042 -- is the length of the operand in bits. We then replace the expression
2043 -- with a reference to Result.
2045 else
2046 declare
2047 Result_Ent : constant Entity_Id := Make_Temporary (Loc, 'T');
2049 begin
2050 Insert_Actions (N, New_List (
2051 Make_Object_Declaration (Loc,
2052 Defining_Identifier => Result_Ent,
2053 Object_Definition => New_Occurrence_Of (Rtyp, Loc)),
2055 Make_Procedure_Call_Statement (Loc,
2056 Name => New_Occurrence_Of (RTE (RE_Bit_Not), Loc),
2057 Parameter_Associations => New_List (
2058 Make_Byte_Aligned_Attribute_Reference (Loc,
2059 Prefix => Opnd,
2060 Attribute_Name => Name_Address),
2062 Make_Op_Multiply (Loc,
2063 Left_Opnd =>
2064 Make_Attribute_Reference (Loc,
2065 Prefix =>
2066 New_Occurrence_Of
2067 (Etype (First_Index (Rtyp)), Loc),
2068 Attribute_Name => Name_Range_Length),
2070 Right_Opnd =>
2071 Make_Integer_Literal (Loc, Component_Size (Rtyp))),
2073 Make_Byte_Aligned_Attribute_Reference (Loc,
2074 Prefix => New_Occurrence_Of (Result_Ent, Loc),
2075 Attribute_Name => Name_Address)))));
2077 Rewrite (N, New_Occurrence_Of (Result_Ent, Loc));
2078 end;
2079 end if;
2081 Analyze_And_Resolve (N, Typ, Suppress => All_Checks);
2082 end Expand_Packed_Not;
2084 -----------------------------
2085 -- Get_Base_And_Bit_Offset --
2086 -----------------------------
2088 procedure Get_Base_And_Bit_Offset
2089 (N : Node_Id;
2090 Base : out Node_Id;
2091 Offset : out Node_Id)
2093 Loc : Source_Ptr;
2094 Term : Node_Id;
2095 Atyp : Entity_Id;
2096 Subscr : Node_Id;
2098 begin
2099 Base := N;
2100 Offset := Empty;
2102 -- We build up an expression serially that has the form
2104 -- linear-subscript * component_size for each array component ref
2105 -- + pref.component'Bit_Position for each record component ref
2106 -- + ...
2108 loop
2109 Loc := Sloc (Base);
2111 if Nkind (Base) = N_Indexed_Component then
2112 Convert_To_Actual_Subtype (Prefix (Base));
2113 Atyp := Etype (Prefix (Base));
2114 Compute_Linear_Subscript (Atyp, Base, Subscr);
2116 Term :=
2117 Make_Op_Multiply (Loc,
2118 Left_Opnd => Subscr,
2119 Right_Opnd =>
2120 Make_Attribute_Reference (Loc,
2121 Prefix => New_Occurrence_Of (Atyp, Loc),
2122 Attribute_Name => Name_Component_Size));
2124 elsif Nkind (Base) = N_Selected_Component then
2125 Term :=
2126 Make_Attribute_Reference (Loc,
2127 Prefix => Base,
2128 Attribute_Name => Name_Bit_Position);
2130 else
2131 return;
2132 end if;
2134 if No (Offset) then
2135 Offset := Term;
2137 else
2138 Offset :=
2139 Make_Op_Add (Loc,
2140 Left_Opnd => Offset,
2141 Right_Opnd => Term);
2142 end if;
2144 Base := Prefix (Base);
2145 end loop;
2146 end Get_Base_And_Bit_Offset;
2148 -------------------------------------
2149 -- Involves_Packed_Array_Reference --
2150 -------------------------------------
2152 function Involves_Packed_Array_Reference (N : Node_Id) return Boolean is
2153 begin
2154 if Nkind (N) = N_Indexed_Component
2155 and then Is_Bit_Packed_Array (Etype (Prefix (N)))
2156 then
2157 return True;
2159 elsif Nkind (N) = N_Selected_Component then
2160 return Involves_Packed_Array_Reference (Prefix (N));
2162 else
2163 return False;
2164 end if;
2165 end Involves_Packed_Array_Reference;
2167 --------------------------
2168 -- Known_Aligned_Enough --
2169 --------------------------
2171 function Known_Aligned_Enough (Obj : Node_Id; Csiz : Nat) return Boolean is
2172 Typ : constant Entity_Id := Etype (Obj);
2174 function In_Partially_Packed_Record (Comp : Entity_Id) return Boolean;
2175 -- If the component is in a record that contains previous packed
2176 -- components, consider it unaligned because the back-end might
2177 -- choose to pack the rest of the record. Lead to less efficient code,
2178 -- but safer vis-a-vis of back-end choices.
2180 --------------------------------
2181 -- In_Partially_Packed_Record --
2182 --------------------------------
2184 function In_Partially_Packed_Record (Comp : Entity_Id) return Boolean is
2185 Rec_Type : constant Entity_Id := Scope (Comp);
2186 Prev_Comp : Entity_Id;
2188 begin
2189 Prev_Comp := First_Entity (Rec_Type);
2190 while Present (Prev_Comp) loop
2191 if Is_Packed (Etype (Prev_Comp)) then
2192 return True;
2194 elsif Prev_Comp = Comp then
2195 return False;
2196 end if;
2198 Next_Entity (Prev_Comp);
2199 end loop;
2201 return False;
2202 end In_Partially_Packed_Record;
2204 -- Start of processing for Known_Aligned_Enough
2206 begin
2207 -- Odd bit sizes don't need alignment anyway
2209 if Csiz mod 2 = 1 then
2210 return True;
2212 -- If we have a specified alignment, see if it is sufficient, if not
2213 -- then we can't possibly be aligned enough in any case.
2215 elsif Known_Alignment (Etype (Obj)) then
2216 -- Alignment required is 4 if size is a multiple of 4, and
2217 -- 2 otherwise (e.g. 12 bits requires 4, 10 bits requires 2)
2219 if Alignment (Etype (Obj)) < 4 - (Csiz mod 4) then
2220 return False;
2221 end if;
2222 end if;
2224 -- OK, alignment should be sufficient, if object is aligned
2226 -- If object is strictly aligned, then it is definitely aligned
2228 if Strict_Alignment (Typ) then
2229 return True;
2231 -- Case of subscripted array reference
2233 elsif Nkind (Obj) = N_Indexed_Component then
2235 -- If we have a pointer to an array, then this is definitely
2236 -- aligned, because pointers always point to aligned versions.
2238 if Is_Access_Type (Etype (Prefix (Obj))) then
2239 return True;
2241 -- Otherwise, go look at the prefix
2243 else
2244 return Known_Aligned_Enough (Prefix (Obj), Csiz);
2245 end if;
2247 -- Case of record field
2249 elsif Nkind (Obj) = N_Selected_Component then
2251 -- What is significant here is whether the record type is packed
2253 if Is_Record_Type (Etype (Prefix (Obj)))
2254 and then Is_Packed (Etype (Prefix (Obj)))
2255 then
2256 return False;
2258 -- Or the component has a component clause which might cause
2259 -- the component to become unaligned (we can't tell if the
2260 -- backend is doing alignment computations).
2262 elsif Present (Component_Clause (Entity (Selector_Name (Obj)))) then
2263 return False;
2265 elsif In_Partially_Packed_Record (Entity (Selector_Name (Obj))) then
2266 return False;
2268 -- In all other cases, go look at prefix
2270 else
2271 return Known_Aligned_Enough (Prefix (Obj), Csiz);
2272 end if;
2274 elsif Nkind (Obj) = N_Type_Conversion then
2275 return Known_Aligned_Enough (Expression (Obj), Csiz);
2277 -- For a formal parameter, it is safer to assume that it is not
2278 -- aligned, because the formal may be unconstrained while the actual
2279 -- is constrained. In this situation, a small constrained packed
2280 -- array, represented in modular form, may be unaligned.
2282 elsif Is_Entity_Name (Obj) then
2283 return not Is_Formal (Entity (Obj));
2284 else
2286 -- If none of the above, must be aligned
2287 return True;
2288 end if;
2289 end Known_Aligned_Enough;
2291 ---------------------
2292 -- Make_Shift_Left --
2293 ---------------------
2295 function Make_Shift_Left (N : Node_Id; S : Node_Id) return Node_Id is
2296 Nod : Node_Id;
2298 begin
2299 if Compile_Time_Known_Value (S) and then Expr_Value (S) = 0 then
2300 return N;
2301 else
2302 Nod :=
2303 Make_Op_Shift_Left (Sloc (N),
2304 Left_Opnd => N,
2305 Right_Opnd => S);
2306 Set_Shift_Count_OK (Nod, True);
2307 return Nod;
2308 end if;
2309 end Make_Shift_Left;
2311 ----------------------
2312 -- Make_Shift_Right --
2313 ----------------------
2315 function Make_Shift_Right (N : Node_Id; S : Node_Id) return Node_Id is
2316 Nod : Node_Id;
2318 begin
2319 if Compile_Time_Known_Value (S) and then Expr_Value (S) = 0 then
2320 return N;
2321 else
2322 Nod :=
2323 Make_Op_Shift_Right (Sloc (N),
2324 Left_Opnd => N,
2325 Right_Opnd => S);
2326 Set_Shift_Count_OK (Nod, True);
2327 return Nod;
2328 end if;
2329 end Make_Shift_Right;
2331 -----------------------------
2332 -- RJ_Unchecked_Convert_To --
2333 -----------------------------
2335 function RJ_Unchecked_Convert_To
2336 (Typ : Entity_Id;
2337 Expr : Node_Id) return Node_Id
2339 Source_Typ : constant Entity_Id := Etype (Expr);
2340 Target_Typ : constant Entity_Id := Typ;
2342 Src : Node_Id := Expr;
2344 Source_Siz : Nat;
2345 Target_Siz : Nat;
2347 begin
2348 Source_Siz := UI_To_Int (RM_Size (Source_Typ));
2349 Target_Siz := UI_To_Int (RM_Size (Target_Typ));
2351 -- For a little-endian target type stored byte-swapped on a
2352 -- big-endian machine, do not mask to Target_Siz bits.
2354 if Bytes_Big_Endian
2355 and then (Is_Record_Type (Target_Typ)
2356 or else
2357 Is_Array_Type (Target_Typ))
2358 and then Reverse_Storage_Order (Target_Typ)
2359 then
2360 Source_Siz := Target_Siz;
2361 end if;
2363 -- First step, if the source type is not a discrete type, then we first
2364 -- convert to a modular type of the source length, since otherwise, on
2365 -- a big-endian machine, we get left-justification. We do it for little-
2366 -- endian machines as well, because there might be junk bits that are
2367 -- not cleared if the type is not numeric. This can be done only if the
2368 -- source siz is different from 0 (i.e. known), otherwise we must trust
2369 -- the type declarations (case of non-discrete components).
2371 if Source_Siz /= 0
2372 and then Source_Siz /= Target_Siz
2373 and then not Is_Discrete_Type (Source_Typ)
2374 then
2375 Src := Unchecked_Convert_To (RTE (Bits_Id (Source_Siz)), Src);
2376 end if;
2378 -- In the big endian case, if the lengths of the two types differ, then
2379 -- we must worry about possible left justification in the conversion,
2380 -- and avoiding that is what this is all about.
2382 if Bytes_Big_Endian and then Source_Siz /= Target_Siz then
2384 -- Next step. If the target is not a discrete type, then we first
2385 -- convert to a modular type of the target length, since otherwise,
2386 -- on a big-endian machine, we get left-justification.
2388 if not Is_Discrete_Type (Target_Typ) then
2389 Src := Unchecked_Convert_To (RTE (Bits_Id (Target_Siz)), Src);
2390 end if;
2391 end if;
2393 -- And now we can do the final conversion to the target type
2395 return Unchecked_Convert_To (Target_Typ, Src);
2396 end RJ_Unchecked_Convert_To;
2398 ----------------------------------------------
2399 -- Setup_Enumeration_Packed_Array_Reference --
2400 ----------------------------------------------
2402 -- All we have to do here is to find the subscripts that correspond to the
2403 -- index positions that have non-standard enumeration types and insert a
2404 -- Pos attribute to get the proper subscript value.
2406 -- Finally the prefix must be uncheck-converted to the corresponding packed
2407 -- array type.
2409 -- Note that the component type is unchanged, so we do not need to fiddle
2410 -- with the types (Gigi always automatically takes the packed array type if
2411 -- it is set, as it will be in this case).
2413 procedure Setup_Enumeration_Packed_Array_Reference (N : Node_Id) is
2414 Pfx : constant Node_Id := Prefix (N);
2415 Typ : constant Entity_Id := Etype (N);
2416 Exprs : constant List_Id := Expressions (N);
2417 Expr : Node_Id;
2419 begin
2420 -- If the array is unconstrained, then we replace the array reference
2421 -- with its actual subtype. This actual subtype will have a packed array
2422 -- type with appropriate bounds.
2424 if not Is_Constrained (Packed_Array_Impl_Type (Etype (Pfx))) then
2425 Convert_To_Actual_Subtype (Pfx);
2426 end if;
2428 Expr := First (Exprs);
2429 while Present (Expr) loop
2430 declare
2431 Loc : constant Source_Ptr := Sloc (Expr);
2432 Expr_Typ : constant Entity_Id := Etype (Expr);
2434 begin
2435 if Is_Enumeration_Type (Expr_Typ)
2436 and then Has_Non_Standard_Rep (Expr_Typ)
2437 then
2438 Rewrite (Expr,
2439 Make_Attribute_Reference (Loc,
2440 Prefix => New_Occurrence_Of (Expr_Typ, Loc),
2441 Attribute_Name => Name_Pos,
2442 Expressions => New_List (Relocate_Node (Expr))));
2443 Analyze_And_Resolve (Expr, Standard_Natural);
2444 end if;
2445 end;
2447 Next (Expr);
2448 end loop;
2450 Rewrite (N,
2451 Make_Indexed_Component (Sloc (N),
2452 Prefix =>
2453 Unchecked_Convert_To (Packed_Array_Impl_Type (Etype (Pfx)), Pfx),
2454 Expressions => Exprs));
2456 Analyze_And_Resolve (N, Typ);
2457 end Setup_Enumeration_Packed_Array_Reference;
2459 -----------------------------------------
2460 -- Setup_Inline_Packed_Array_Reference --
2461 -----------------------------------------
2463 procedure Setup_Inline_Packed_Array_Reference
2464 (N : Node_Id;
2465 Atyp : Entity_Id;
2466 Obj : in out Node_Id;
2467 Cmask : out Uint;
2468 Shift : out Node_Id)
2470 Loc : constant Source_Ptr := Sloc (N);
2471 PAT : Entity_Id;
2472 Otyp : Entity_Id;
2473 Csiz : constant Uint := Component_Size (Atyp);
2474 Osiz : Uint;
2476 begin
2477 Convert_To_PAT_Type (Obj);
2478 PAT := Etype (Obj);
2480 Cmask := 2 ** Csiz - 1;
2482 if Is_Array_Type (PAT) then
2483 Otyp := Component_Type (PAT);
2484 Osiz := Component_Size (PAT);
2486 else
2487 Otyp := PAT;
2489 -- In the case where the PAT is a modular type, we want the actual
2490 -- size in bits of the modular value we use. This is neither the
2491 -- Object_Size nor the Value_Size, either of which may have been
2492 -- reset to strange values, but rather the minimum size. Note that
2493 -- since this is a modular type with full range, the issue of
2494 -- biased representation does not arise.
2496 Osiz := UI_From_Int (Minimum_Size (Otyp));
2497 end if;
2499 Compute_Linear_Subscript (Atyp, N, Shift);
2501 -- If the component size is not 1, then the subscript must be multiplied
2502 -- by the component size to get the shift count.
2504 if Csiz /= 1 then
2505 Shift :=
2506 Make_Op_Multiply (Loc,
2507 Left_Opnd => Make_Integer_Literal (Loc, Csiz),
2508 Right_Opnd => Shift);
2509 end if;
2511 -- If we have the array case, then this shift count must be broken down
2512 -- into a byte subscript, and a shift within the byte.
2514 if Is_Array_Type (PAT) then
2516 declare
2517 New_Shift : Node_Id;
2519 begin
2520 -- We must analyze shift, since we will duplicate it
2522 Set_Parent (Shift, N);
2523 Analyze_And_Resolve
2524 (Shift, Standard_Integer, Suppress => All_Checks);
2526 -- The shift count within the word is
2527 -- shift mod Osiz
2529 New_Shift :=
2530 Make_Op_Mod (Loc,
2531 Left_Opnd => Duplicate_Subexpr (Shift),
2532 Right_Opnd => Make_Integer_Literal (Loc, Osiz));
2534 -- The subscript to be used on the PAT array is
2535 -- shift / Osiz
2537 Obj :=
2538 Make_Indexed_Component (Loc,
2539 Prefix => Obj,
2540 Expressions => New_List (
2541 Make_Op_Divide (Loc,
2542 Left_Opnd => Duplicate_Subexpr (Shift),
2543 Right_Opnd => Make_Integer_Literal (Loc, Osiz))));
2545 Shift := New_Shift;
2546 end;
2548 -- For the modular integer case, the object to be manipulated is the
2549 -- entire array, so Obj is unchanged. Note that we will reset its type
2550 -- to PAT before returning to the caller.
2552 else
2553 null;
2554 end if;
2556 -- The one remaining step is to modify the shift count for the
2557 -- big-endian case. Consider the following example in a byte:
2559 -- xxxxxxxx bits of byte
2560 -- vvvvvvvv bits of value
2561 -- 33221100 little-endian numbering
2562 -- 00112233 big-endian numbering
2564 -- Here we have the case of 2-bit fields
2566 -- For the little-endian case, we already have the proper shift count
2567 -- set, e.g. for element 2, the shift count is 2*2 = 4.
2569 -- For the big endian case, we have to adjust the shift count, computing
2570 -- it as (N - F) - Shift, where N is the number of bits in an element of
2571 -- the array used to implement the packed array, F is the number of bits
2572 -- in a source array element, and Shift is the count so far computed.
2574 -- We also have to adjust if the storage order is reversed
2576 if Bytes_Big_Endian xor Reverse_Storage_Order (Base_Type (Atyp)) then
2577 Shift :=
2578 Make_Op_Subtract (Loc,
2579 Left_Opnd => Make_Integer_Literal (Loc, Osiz - Csiz),
2580 Right_Opnd => Shift);
2581 end if;
2583 Set_Parent (Shift, N);
2584 Set_Parent (Obj, N);
2585 Analyze_And_Resolve (Obj, Otyp, Suppress => All_Checks);
2586 Analyze_And_Resolve (Shift, Standard_Integer, Suppress => All_Checks);
2588 -- Make sure final type of object is the appropriate packed type
2590 Set_Etype (Obj, Otyp);
2592 end Setup_Inline_Packed_Array_Reference;
2594 end Exp_Pakd;