1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2022, Free Software Foundation, Inc. --
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. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Atree
; use Atree
;
27 with Checks
; use Checks
;
28 with Debug
; use Debug
;
29 with Einfo
; use Einfo
;
30 with Einfo
.Entities
; use Einfo
.Entities
;
31 with Einfo
.Utils
; use Einfo
.Utils
;
32 with Elists
; use Elists
;
33 with Exp_Smem
; use Exp_Smem
;
34 with Exp_Tss
; use Exp_Tss
;
35 with Exp_Util
; use Exp_Util
;
36 with Namet
; use Namet
;
37 with Nmake
; use Nmake
;
39 with Output
; use Output
;
41 with Sem_Eval
; use Sem_Eval
;
42 with Sem_Res
; use Sem_Res
;
43 with Sem_Util
; use Sem_Util
;
44 with Sem_Warn
; use Sem_Warn
;
45 with Sinfo
; use Sinfo
;
46 with Sinfo
.Nodes
; use Sinfo
.Nodes
;
47 with Sinfo
.Utils
; use Sinfo
.Utils
;
48 with Sinput
; use Sinput
;
49 with Snames
; use Snames
;
50 with Tbuild
; use Tbuild
;
52 package body Exp_Ch2
is
54 -----------------------
55 -- Local Subprograms --
56 -----------------------
58 procedure Expand_Current_Value
(N
: Node_Id
);
59 -- N is a node for a variable whose Current_Value field is set. If N is
60 -- node is for a discrete type, replaces node with a copy of the referenced
61 -- value. This provides a limited form of value propagation for variables
62 -- which are initialized or assigned not been further modified at the time
63 -- of reference. The call has no effect if the Current_Value refers to a
64 -- conditional with condition other than equality.
66 procedure Expand_Discriminant
(N
: Node_Id
);
67 -- An occurrence of a discriminant within a discriminated type is replaced
68 -- with the corresponding discriminal, that is to say the formal parameter
69 -- of the initialization procedure for the type that is associated with
70 -- that particular discriminant. This replacement is not performed for
71 -- discriminants of records that appear in constraints of component of the
72 -- record, because Gigi uses the discriminant name to retrieve its value.
73 -- In the other hand, it has to be performed for default expressions of
74 -- components because they are used in the record init procedure. See Einfo
75 -- for more details, and Exp_Ch3, Exp_Ch9 for examples of use. For
76 -- discriminants of tasks and protected types, the transformation is more
77 -- complex when it occurs within a default expression for an entry or
78 -- protected operation. The corresponding default_expression_function has
79 -- an additional parameter which is the target of an entry call, and the
80 -- discriminant of the task must be replaced with a reference to the
81 -- discriminant of that formal parameter.
83 procedure Expand_Entity_Reference
(N
: Node_Id
);
84 -- Common processing for expansion of identifiers and expanded names
85 -- Dispatches to specific expansion procedures.
87 procedure Expand_Entry_Index_Parameter
(N
: Node_Id
);
88 -- A reference to the identifier in the entry index specification of an
89 -- entry body is modified to a reference to a constant definition equal to
90 -- the index of the entry family member being called. This constant is
91 -- calculated as part of the elaboration of the expanded code for the body,
92 -- and is calculated from the object-wide entry index returned by Next_
95 procedure Expand_Entry_Parameter
(N
: Node_Id
);
96 -- A reference to an entry parameter is modified to be a reference to the
97 -- corresponding component of the entry parameter record that is passed by
98 -- the runtime to the accept body procedure.
100 procedure Expand_Formal
(N
: Node_Id
);
101 -- A reference to a formal parameter of a protected subprogram is expanded
102 -- into the corresponding formal of the unprotected procedure used to
103 -- represent the operation within the protected object. In other cases
104 -- Expand_Formal is a no-op.
106 procedure Expand_Protected_Component
(N
: Node_Id
);
107 -- A reference to a private component of a protected type is expanded into
108 -- a reference to the corresponding prival in the current protected entry
111 procedure Expand_Renaming
(N
: Node_Id
);
112 -- For renamings, just replace the identifier by the corresponding
113 -- named expression. Note that this has been evaluated (see routine
114 -- Exp_Ch8.Expand_N_Object_Renaming.Evaluate_Name) so this gives
115 -- the correct renaming semantics.
117 --------------------------
118 -- Expand_Current_Value --
119 --------------------------
121 procedure Expand_Current_Value
(N
: Node_Id
) is
122 Loc
: constant Source_Ptr
:= Sloc
(N
);
123 E
: constant Entity_Id
:= Entity
(N
);
124 CV
: constant Node_Id
:= Current_Value
(E
);
125 T
: constant Entity_Id
:= Etype
(N
);
132 -- No replacement if value raises constraint error
134 and then Nkind
(CV
) /= N_Raise_Constraint_Error
136 -- Do this only for discrete types
138 and then Is_Discrete_Type
(T
)
140 -- Do not replace biased types, since it is problematic to
141 -- consistently generate a sensible constant value in this case.
143 and then not Has_Biased_Representation
(T
)
145 -- Do not replace lvalues
147 and then not Known_To_Be_Assigned
(N
)
149 -- Check that entity is suitable for replacement
151 and then OK_To_Do_Constant_Replacement
(E
)
153 -- Do not replace the prefixes of attribute references, since this
154 -- causes trouble with cases like 4'Size. Also for Name_Asm_Input and
155 -- Name_Asm_Output, don't do replacement anywhere, since we can have
156 -- lvalue references in the arguments.
158 and then not (Nkind
(Parent
(N
)) = N_Attribute_Reference
160 (Attribute_Name
(Parent
(N
)) in Name_Asm_Input
162 or else Prefix
(Parent
(N
)) = N
))
164 -- Case of Current_Value is a compile time known value
166 if Nkind
(CV
) in N_Subexpr
then
169 -- Case of Current_Value is an if expression reference
172 Get_Current_Value_Condition
(N
, Op
, Val
);
174 if Op
/= N_Op_Eq
then
179 -- If constant value is an occurrence of an enumeration literal,
180 -- then we just make another occurrence of the same literal.
182 if Is_Entity_Name
(Val
)
183 and then Ekind
(Entity
(Val
)) = E_Enumeration_Literal
186 Unchecked_Convert_To
(T
,
187 New_Occurrence_Of
(Entity
(Val
), Loc
)));
189 -- If constant is of a character type, just make an appropriate
190 -- character literal, which will get the proper type.
192 elsif Is_Character_Type
(T
) then
194 Make_Character_Literal
(Loc
,
195 Chars
=> Chars
(Val
),
196 Char_Literal_Value
=> Expr_Rep_Value
(Val
)));
198 -- If constant is of an integer type, just make an appropriate
199 -- integer literal, which will get the proper type.
201 elsif Is_Integer_Type
(T
) then
203 Make_Integer_Literal
(Loc
,
204 Intval
=> Expr_Rep_Value
(Val
)));
206 -- Otherwise do unchecked conversion of value to right type
210 Unchecked_Convert_To
(T
,
211 Make_Integer_Literal
(Loc
,
212 Intval
=> Expr_Rep_Value
(Val
))));
215 Analyze_And_Resolve
(N
, T
);
216 Set_Is_Static_Expression
(N
, False);
218 end Expand_Current_Value
;
220 -------------------------
221 -- Expand_Discriminant --
222 -------------------------
224 procedure Expand_Discriminant
(N
: Node_Id
) is
225 Scop
: constant Entity_Id
:= Scope
(Entity
(N
));
227 Parent_P
: Node_Id
:= Parent
(P
);
228 In_Entry
: Boolean := False;
231 -- The Incomplete_Or_Private_Kind happens while resolving the
232 -- discriminant constraint involved in a derived full type,
235 -- type D is private;
236 -- type D(C : ...) is new T(C);
238 if Ekind
(Scop
) = E_Record_Type
239 or Ekind
(Scop
) in Incomplete_Or_Private_Kind
241 -- Find the origin by walking up the tree till the component
244 while Present
(Parent_P
)
245 and then Nkind
(Parent_P
) /= N_Component_Declaration
248 Parent_P
:= Parent
(P
);
251 -- If the discriminant reference was part of the default expression
252 -- it has to be "discriminalized"
254 if Present
(Parent_P
) and then P
= Expression
(Parent_P
) then
255 Set_Entity
(N
, Discriminal
(Entity
(N
)));
258 elsif Is_Concurrent_Type
(Scop
) then
259 while Present
(Parent_P
)
260 and then Nkind
(Parent_P
) /= N_Subprogram_Body
264 if Nkind
(P
) = N_Entry_Declaration
then
268 Parent_P
:= Parent
(Parent_P
);
271 -- If the discriminant occurs within the default expression for a
272 -- formal of an entry or protected operation, replace it with a
273 -- reference to the discriminant of the formal of the enclosing
276 if Present
(Parent_P
)
277 and then Present
(Corresponding_Spec
(Parent_P
))
280 Loc
: constant Source_Ptr
:= Sloc
(N
);
281 D_Fun
: constant Entity_Id
:= Corresponding_Spec
(Parent_P
);
282 Formal
: constant Entity_Id
:= First_Formal
(D_Fun
);
287 -- Verify that we are within the body of an entry or protected
288 -- operation. Its first formal parameter is the synchronized
292 and then Etype
(Formal
) = Scope
(Entity
(N
))
294 Disc
:= CR_Discriminant
(Entity
(N
));
297 Make_Selected_Component
(Loc
,
298 Prefix
=> New_Occurrence_Of
(Formal
, Loc
),
299 Selector_Name
=> New_Occurrence_Of
(Disc
, Loc
));
301 Set_Etype
(New_N
, Etype
(N
));
305 Set_Entity
(N
, Discriminal
(Entity
(N
)));
309 elsif Nkind
(Parent
(N
)) = N_Range
312 Set_Entity
(N
, CR_Discriminant
(Entity
(N
)));
314 -- Finally, if the entity is the discriminant of the original
315 -- type declaration, and we are within the initialization
316 -- procedure for a task, the designated entity is the
317 -- discriminal of the task body. This can happen when the
318 -- argument of pragma Task_Name mentions a discriminant,
319 -- because the pragma is analyzed in the task declaration
320 -- but is expanded in the call to Create_Task in the init_proc.
322 elsif Within_Init_Proc
then
323 Set_Entity
(N
, Discriminal
(CR_Discriminant
(Entity
(N
))));
325 Set_Entity
(N
, Discriminal
(Entity
(N
)));
329 Set_Entity
(N
, Discriminal
(Entity
(N
)));
331 end Expand_Discriminant
;
333 -----------------------------
334 -- Expand_Entity_Reference --
335 -----------------------------
337 procedure Expand_Entity_Reference
(N
: Node_Id
) is
339 function Is_Object_Renaming_Name
(N
: Node_Id
) return Boolean;
340 -- Indicates that N occurs (after accounting for qualified expressions
341 -- and type conversions) as the name of an object renaming declaration.
342 -- We don't want to fold values in that case.
344 -----------------------------
345 -- Is_Object_Renaming_Name --
346 -----------------------------
348 function Is_Object_Renaming_Name
(N
: Node_Id
) return Boolean is
349 Trailer
: Node_Id
:= N
;
353 Rover
:= Parent
(Trailer
);
354 case Nkind
(Rover
) is
355 when N_Qualified_Expression | N_Type_Conversion
=>
356 -- Conservative for type conversions; only necessary if
357 -- conversion does not introduce a new object (as opposed
358 -- to a new view of an existing object).
360 when N_Object_Renaming_Declaration
=>
361 return Trailer
= Name
(Rover
);
363 return False; -- the usual case
367 end Is_Object_Renaming_Name
;
371 E
: constant Entity_Id
:= Entity
(N
);
373 -- Start of processing for Expand_Entity_Reference
376 -- Defend against errors
379 Check_Error_Detected
;
383 if Ekind
(E
) = E_Discriminant
then
384 Expand_Discriminant
(N
);
386 elsif Is_Entry_Formal
(E
) then
387 Expand_Entry_Parameter
(N
);
389 elsif Is_Protected_Component
(E
) then
390 if No_Run_Time_Mode
then
393 Expand_Protected_Component
(N
);
396 elsif Ekind
(E
) = E_Entry_Index_Parameter
then
397 Expand_Entry_Index_Parameter
(N
);
399 elsif Is_Formal
(E
) then
402 elsif Is_Renaming_Of_Object
(E
) then
405 elsif Ekind
(E
) = E_Variable
406 and then Is_Shared_Passive
(E
)
408 Expand_Shared_Passive_Variable
(N
);
411 -- Test code for implementing the pragma Reviewable requirement of
412 -- classifying reads of scalars as referencing potentially uninitialized
416 and then Is_Scalar_Type
(Etype
(N
))
417 and then (Is_Assignable
(E
) or else Is_Constant_Object
(E
))
418 and then Comes_From_Source
(N
)
419 and then not Known_To_Be_Assigned
(N
)
420 and then not Is_Actual_Out_Parameter
(N
)
421 and then (Nkind
(Parent
(N
)) /= N_Attribute_Reference
422 or else Attribute_Name
(Parent
(N
)) /= Name_Valid
)
424 Write_Location
(Sloc
(N
));
425 Write_Str
(": Read from scalar """);
426 Write_Name
(Chars
(N
));
429 if Is_Known_Valid
(E
) then
430 Write_Str
(", Is_Known_Valid");
436 -- Set Atomic_Sync_Required if necessary for atomic variable. Note that
437 -- this processing does NOT apply to Volatile_Full_Access variables.
439 if Nkind
(N
) in N_Identifier | N_Expanded_Name
440 and then Ekind
(E
) = E_Variable
441 and then (Is_Atomic
(E
) or else Is_Atomic
(Etype
(E
)))
447 -- If variable is atomic, but type is not, setting depends on
448 -- disable/enable state for the variable.
450 if Is_Atomic
(E
) and then not Is_Atomic
(Etype
(E
)) then
451 Set
:= not Atomic_Synchronization_Disabled
(E
);
453 -- If variable is not atomic, but its type is atomic, setting
454 -- depends on disable/enable state for the type.
456 elsif not Is_Atomic
(E
) and then Is_Atomic
(Etype
(E
)) then
457 Set
:= not Atomic_Synchronization_Disabled
(Etype
(E
));
459 -- Else both variable and type are atomic (see outer if), and we
460 -- disable if either variable or its type have sync disabled.
463 Set
:= (not Atomic_Synchronization_Disabled
(E
))
465 (not Atomic_Synchronization_Disabled
(Etype
(E
)));
468 -- Set flag if required
471 Activate_Atomic_Synchronization
(N
);
476 -- Interpret possible Current_Value for variable case. The
477 -- Is_Object_Renaming_Name test is needed for cases such as
479 -- Y : Integer renames Integer'(X);
480 -- where the value of Y is changed by any subsequent assignments to X.
481 -- In cases like this, we do not want to use Current_Value even though
485 and then Present
(Current_Value
(E
))
486 and then not Is_Object_Renaming_Name
(N
)
488 Expand_Current_Value
(N
);
490 -- We do want to warn for the case of a boolean variable (not a
491 -- boolean constant) whose value is known at compile time.
493 if Is_Boolean_Type
(Etype
(N
)) then
494 Warn_On_Known_Condition
(N
);
497 -- Don't mess with Current_Value for compile time known values. Not
498 -- only is it unnecessary, but we could disturb an indication of a
499 -- static value, which could cause semantic trouble.
501 elsif Compile_Time_Known_Value
(N
) then
504 -- Interpret possible Current_Value for constant case
506 elsif Is_Constant_Object
(E
)
507 and then Present
(Current_Value
(E
))
509 Expand_Current_Value
(N
);
511 end Expand_Entity_Reference
;
513 ----------------------------------
514 -- Expand_Entry_Index_Parameter --
515 ----------------------------------
517 procedure Expand_Entry_Index_Parameter
(N
: Node_Id
) is
518 Index_Con
: constant Entity_Id
:= Entry_Index_Constant
(Entity
(N
));
520 Set_Entity
(N
, Index_Con
);
521 Set_Etype
(N
, Etype
(Index_Con
));
522 end Expand_Entry_Index_Parameter
;
524 ----------------------------
525 -- Expand_Entry_Parameter --
526 ----------------------------
528 procedure Expand_Entry_Parameter
(N
: Node_Id
) is
529 Loc
: constant Source_Ptr
:= Sloc
(N
);
530 Ent_Formal
: constant Entity_Id
:= Entity
(N
);
531 Ent_Spec
: constant Entity_Id
:= Scope
(Ent_Formal
);
532 Parm_Type
: constant Entity_Id
:= Entry_Parameters_Type
(Ent_Spec
);
533 Acc_Stack
: constant Elist_Id
:= Accept_Address
(Ent_Spec
);
534 Addr_Ent
: constant Entity_Id
:= Node
(Last_Elmt
(Acc_Stack
));
535 P_Comp_Ref
: Entity_Id
;
537 -- Start of processing for Expand_Entry_Parameter
540 if Is_Task_Type
(Scope
(Ent_Spec
))
541 and then Comes_From_Source
(Ent_Formal
)
543 -- Before replacing the formal with the local renaming that is used
544 -- in the accept block, note if this is an assignment context, and
545 -- note the modification to avoid spurious warnings, because the
546 -- original entity is not used further. If formal is unconstrained,
547 -- we also generate an extra parameter to hold the Constrained
548 -- attribute of the actual. No renaming is generated for this flag.
550 -- Calling Note_Possible_Modification in the expander is dubious,
551 -- because this generates a cross-reference entry, and should be
552 -- done during semantic processing so it is called in -gnatc mode???
554 if Ekind
(Entity
(N
)) /= E_In_Parameter
555 and then Known_To_Be_Assigned
(N
)
557 Note_Possible_Modification
(N
, Sure
=> True);
561 -- What we need is a reference to the corresponding component of the
562 -- parameter record object. The Accept_Address field of the entry entity
563 -- references the address variable that contains the address of the
564 -- accept parameters record. We first have to do an unchecked conversion
565 -- to turn this into a pointer to the parameter record and then we
566 -- select the required parameter field.
568 -- The same processing applies to protected entries, where the Accept_
569 -- Address is also the address of the Parameters record.
572 Make_Selected_Component
(Loc
,
574 Make_Explicit_Dereference
(Loc
,
575 Unchecked_Convert_To
(Parm_Type
,
576 New_Occurrence_Of
(Addr_Ent
, Loc
))),
578 New_Occurrence_Of
(Entry_Component
(Ent_Formal
), Loc
));
580 -- For all types of parameters, the constructed parameter record object
581 -- contains a pointer to the parameter. Thus we must dereference them to
582 -- access them (this will often be redundant, since the dereference is
583 -- implicit, but no harm is done by making it explicit).
586 Make_Explicit_Dereference
(Loc
, P_Comp_Ref
));
589 end Expand_Entry_Parameter
;
595 procedure Expand_Formal
(N
: Node_Id
) is
596 E
: constant Entity_Id
:= Entity
(N
);
597 Scop
: constant Entity_Id
:= Scope
(E
);
600 -- Check whether the subprogram of which this is a formal is
601 -- a protected operation. The initialization procedure for
602 -- the corresponding record type is not itself a protected operation.
604 if Is_Protected_Type
(Scope
(Scop
))
605 and then not Is_Init_Proc
(Scop
)
606 and then Present
(Protected_Formal
(E
))
608 Set_Entity
(N
, Protected_Formal
(E
));
612 ----------------------------
613 -- Expand_N_Expanded_Name --
614 ----------------------------
616 procedure Expand_N_Expanded_Name
(N
: Node_Id
) is
618 Expand_Entity_Reference
(N
);
619 end Expand_N_Expanded_Name
;
621 -------------------------
622 -- Expand_N_Identifier --
623 -------------------------
625 procedure Expand_N_Identifier
(N
: Node_Id
) is
627 Expand_Entity_Reference
(N
);
628 end Expand_N_Identifier
;
630 ---------------------------
631 -- Expand_N_Real_Literal --
632 ---------------------------
634 procedure Expand_N_Real_Literal
(N
: Node_Id
) is
635 pragma Unreferenced
(N
);
638 -- Historically, this routine existed because there were expansion
639 -- requirements for Vax real literals, but now Vax real literals
640 -- are now handled by gigi, so this routine no longer does anything.
643 end Expand_N_Real_Literal
;
645 --------------------------------
646 -- Expand_Protected_Component --
647 --------------------------------
649 procedure Expand_Protected_Component
(N
: Node_Id
) is
651 function Inside_Eliminated_Body
return Boolean;
652 -- Determine whether the current entity is inside a subprogram or an
653 -- entry which has been marked as eliminated.
655 ----------------------------
656 -- Inside_Eliminated_Body --
657 ----------------------------
659 function Inside_Eliminated_Body
return Boolean is
660 S
: Entity_Id
:= Current_Scope
;
663 while Present
(S
) loop
664 if (Ekind
(S
) = E_Entry
665 or else Ekind
(S
) = E_Entry_Family
666 or else Ekind
(S
) = E_Function
667 or else Ekind
(S
) = E_Procedure
)
668 and then Is_Eliminated
(S
)
677 end Inside_Eliminated_Body
;
679 -- Start of processing for Expand_Protected_Component
682 -- Eliminated bodies are not expanded and thus do not need privals
684 if not Inside_Eliminated_Body
then
686 Priv
: constant Entity_Id
:= Prival
(Entity
(N
));
688 Set_Entity
(N
, Priv
);
689 Set_Etype
(N
, Etype
(Priv
));
692 end Expand_Protected_Component
;
694 ---------------------
695 -- Expand_Renaming --
696 ---------------------
698 procedure Expand_Renaming
(N
: Node_Id
) is
699 E
: constant Entity_Id
:= Entity
(N
);
700 T
: constant Entity_Id
:= Etype
(N
);
703 Rewrite
(N
, New_Copy_Tree
(Renamed_Object
(E
)));
705 -- We mark the copy as unanalyzed, so that it is sure to be reanalyzed
706 -- at the top level. This is needed in the packed case since we
707 -- specifically avoided expanding packed array references when the
708 -- renaming declaration was analyzed.
710 Reset_Analyzed_Flags
(N
);
711 Analyze_And_Resolve
(N
, T
);