1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
5 -- E X P _ S P A R K --
9 -- Copyright (C) 1992-2020, 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 Einfo; use Einfo;
31 with Exp_Ch5; use Exp_Ch5;
32 with Exp_Dbug; use Exp_Dbug;
33 with Exp_Util; use Exp_Util;
34 with Namet; use Namet;
35 with Nlists; use Nlists;
36 with Nmake; use Nmake;
37 with Rtsfind; use Rtsfind;
39 with Sem_Ch8; use Sem_Ch8;
40 with Sem_Prag; use Sem_Prag;
41 with Sem_Res; use Sem_Res;
42 with Sem_Util; use Sem_Util;
43 with Sinfo; use Sinfo;
44 with Snames; use Snames;
45 with Stand; use Stand;
46 with Tbuild; use Tbuild;
47 with Uintp; use Uintp;
49 package body Exp_SPARK is
51 -----------------------
52 -- Local Subprograms --
53 -----------------------
55 procedure Expand_SPARK_N_Aggregate (N : Node_Id);
56 -- Perform aggregate-specific expansion
58 procedure Expand_SPARK_N_Attribute_Reference (N : Node_Id);
59 -- Perform attribute-reference-specific expansion
61 procedure Expand_SPARK_N_Delta_Aggregate (N : Node_Id);
62 -- Perform delta-aggregate-specific expansion
64 procedure Expand_SPARK_N_Freeze_Type (E : Entity_Id);
65 -- Build the DIC procedure of a type when needed, if not already done
67 procedure Expand_SPARK_N_Loop_Statement (N : Node_Id);
68 -- Perform loop-statement-specific expansion
70 procedure Expand_SPARK_N_Object_Declaration (N : Node_Id);
71 -- Perform object-declaration-specific expansion
73 procedure Expand_SPARK_N_Object_Renaming_Declaration (N : Node_Id);
74 -- Perform name evaluation for a renamed object
76 procedure Expand_SPARK_N_Op_Ne (N : Node_Id);
77 -- Rewrite operator /= based on operator = when defined explicitly
79 procedure Expand_SPARK_Delta_Or_Update (Typ : Entity_Id; Aggr : Node_Id);
80 -- Common expansion for attribute Update and delta aggregates
86 procedure Expand_SPARK (N : Node_Id) is
90 -- Qualification of entity names in formal verification mode
91 -- is limited to the addition of a suffix for homonyms (see
92 -- Exp_Dbug.Qualify_Entity_Name). We used to qualify entity names
93 -- as full expansion does, but this was removed as this prevents the
94 -- verification back-end from using a short name for debugging and
95 -- user interaction. The verification back-end already takes care
96 -- of qualifying names when needed.
98 when N_Block_Statement
101 | N_Package_Declaration
102 | N_Protected_Type_Declaration
104 | N_Task_Type_Declaration
106 Qualify_Entity_Names (N);
109 Expand_SPARK_N_Aggregate (N);
111 -- Replace occurrences of System'To_Address by calls to
112 -- System.Storage_Elements.To_Address.
114 when N_Attribute_Reference =>
115 Expand_SPARK_N_Attribute_Reference (N);
117 when N_Delta_Aggregate =>
118 Expand_SPARK_N_Delta_Aggregate (N);
123 Expand_SPARK_Potential_Renaming (N);
125 -- Loop iterations over arrays need to be expanded, to avoid getting
126 -- two names referring to the same object in memory (the array and
127 -- the iterator) in GNATprove, especially since both can be written
128 -- (thus possibly leading to interferences due to aliasing). No such
129 -- problem arises with quantified expressions over arrays, which are
130 -- dealt with specially in GNATprove.
132 when N_Loop_Statement =>
133 Expand_SPARK_N_Loop_Statement (N);
135 when N_Object_Declaration =>
136 Expand_SPARK_N_Object_Declaration (N);
138 when N_Object_Renaming_Declaration =>
139 Expand_SPARK_N_Object_Renaming_Declaration (N);
142 Expand_SPARK_N_Op_Ne (N);
144 when N_Freeze_Entity =>
145 if Is_Type (Entity (N)) then
146 Expand_SPARK_N_Freeze_Type (Entity (N));
149 -- In SPARK mode, no other constructs require expansion
156 ----------------------------------
157 -- Expand_SPARK_Delta_Or_Update --
158 ----------------------------------
160 procedure Expand_SPARK_Delta_Or_Update
167 Comp_Type : Entity_Id;
170 Index_Typ : Entity_Id;
174 -- Apply scalar range checks on the updated components, if needed
176 if Is_Array_Type (Typ) then
178 -- Multidimensional arrays
180 if Present (Next_Index (First_Index (Typ))) then
181 Assoc := First (Component_Associations (Aggr));
183 while Present (Assoc) loop
184 Expr := Expression (Assoc);
185 Comp_Type := Component_Type (Typ);
187 if Is_Scalar_Type (Comp_Type) then
188 Apply_Scalar_Range_Check (Expr, Comp_Type);
191 -- The current association contains a sequence of indexes
192 -- denoting an element of a multidimensional array:
194 -- (Index_1, ..., Index_N)
196 Expr := First (Choices (Assoc));
198 pragma Assert (Nkind (Aggr) = N_Aggregate);
200 while Present (Expr) loop
201 Index := First (Expressions (Expr));
202 Index_Typ := First_Index (Typ);
204 while Present (Index_Typ) loop
205 Apply_Scalar_Range_Check (Index, Etype (Index_Typ));
207 Next_Index (Index_Typ);
216 -- One-dimensional arrays
219 Assoc := First (Component_Associations (Aggr));
221 while Present (Assoc) loop
222 Expr := Expression (Assoc);
223 Comp_Type := Component_Type (Typ);
225 -- Analyze expression of the iterated_component_association
226 -- with its index parameter in scope.
228 if Nkind (Assoc) = N_Iterated_Component_Association then
229 Push_Scope (Scope (Defining_Identifier (Assoc)));
230 Analyze_And_Resolve (Expression (Assoc), Comp_Type);
233 if Is_Scalar_Type (Comp_Type) then
234 Apply_Scalar_Range_Check (Expr, Comp_Type);
237 -- Restore scope of the iterated_component_association
239 if Nkind (Assoc) = N_Iterated_Component_Association then
245 (if Nkind (Assoc) = N_Iterated_Component_Association
246 then Discrete_Choices (Assoc)
247 else Choices (Assoc));
248 Index_Typ := First_Index (Typ);
250 while Present (Index) loop
251 -- If the index denotes a range of elements or a constrained
252 -- subtype indication, then their low and high bounds
253 -- already have range checks applied.
255 if Nkind (Index) in N_Range | N_Subtype_Indication then
258 -- Otherwise the index denotes a single expression where
259 -- range checks need to be applied or a subtype name
260 -- (without range constraints) where applying checks is
263 -- In delta_aggregate and Update attribute on array the
264 -- others_choice is not allowed.
266 else pragma Assert (Nkind (Index) in N_Subexpr);
267 Apply_Scalar_Range_Check (Index, Etype (Index_Typ));
277 else pragma Assert (Is_Record_Type (Typ));
279 -- If the aggregate has multiple component choices, e.g.:
281 -- X'Update (A | B | C => 123)
283 -- then each component might be of a different type and might or
284 -- might not require a range check. We first rewrite associations
285 -- into single-component choices, e.g.:
287 -- X'Update (A => 123, B => 123, C => 123)
289 -- and then apply range checks to individual copies of the
290 -- expressions. We do the same for delta aggregates, accordingly.
292 -- Iterate over associations of the original aggregate
294 Assoc := First (Component_Associations (Aggr));
296 -- Rewrite into a new aggregate and decorate
303 (Sloc => Sloc (Aggr),
304 Component_Associations => New_List));
306 when N_Delta_Aggregate =>
310 (Sloc => Sloc (Aggr),
311 Expression => Expression (Aggr),
312 Component_Associations => New_List));
318 Set_Etype (Aggr, Typ);
320 -- Populate the new aggregate with component associations
322 while Present (Assoc) loop
323 Expr := Expression (Assoc);
324 Comp := First (Choices (Assoc));
326 while Present (Comp) loop
327 Comp_Id := Entity (Comp);
328 Comp_Type := Etype (Comp_Id);
331 Make_Component_Association
332 (Sloc => Sloc (Assoc),
335 (New_Occurrence_Of (Comp_Id, Sloc (Comp))),
336 Expression => New_Copy_Tree (Expr));
338 -- New association must be attached to the aggregate before we
341 Append (New_Assoc, Component_Associations (Aggr));
343 Analyze_And_Resolve (Expression (New_Assoc), Comp_Type);
345 if Is_Scalar_Type (Comp_Type) then
346 Apply_Scalar_Range_Check
347 (Expression (New_Assoc), Comp_Type);
356 end Expand_SPARK_Delta_Or_Update;
358 --------------------------------
359 -- Expand_SPARK_N_Freeze_Type --
360 --------------------------------
362 procedure Expand_SPARK_N_Freeze_Type (E : Entity_Id) is
364 -- When a DIC is inherited by a tagged type, it may need to be
365 -- specialized to the descendant type, hence build a separate DIC
366 -- procedure for it as done during regular expansion for compilation.
368 if Has_DIC (E) and then Is_Tagged_Type (E) then
369 Build_DIC_Procedure_Body (E, For_Freeze => True);
371 end Expand_SPARK_N_Freeze_Type;
373 ------------------------------
374 -- Expand_SPARK_N_Aggregate --
375 ------------------------------
377 procedure Expand_SPARK_N_Aggregate (N : Node_Id) is
378 Assoc : Node_Id := First (Component_Associations (N));
380 -- For compilation, frontend analyses a copy of the
381 -- iterated_component_association's expression for legality checking;
382 -- (then the expression is copied again when expanding association into
383 -- assignments for the individual choices). For SPARK we analyze the
384 -- original expression and apply range checks, if required.
386 while Present (Assoc) loop
387 if Nkind (Assoc) = N_Iterated_Component_Association then
389 Typ : constant Entity_Id := Etype (N);
391 Comp_Type : constant Entity_Id := Component_Type (Typ);
392 Expr : constant Node_Id := Expression (Assoc);
393 Index_Typ : constant Entity_Id := First_Index (Typ);
398 -- Analyze expression with index parameter in scope
400 Push_Scope (Scope (Defining_Identifier (Assoc)));
401 Enter_Name (Defining_Identifier (Assoc));
402 Analyze_And_Resolve (Expression (Assoc), Comp_Type);
404 if Is_Scalar_Type (Comp_Type) then
405 Apply_Scalar_Range_Check (Expr, Comp_Type);
410 -- Analyze discrete choices
412 Index := First (Discrete_Choices (Assoc));
414 while Present (Index) loop
416 -- The index denotes a range of elements where range checks
417 -- have been already applied.
419 if Nkind (Index) in N_Others_Choice
421 | N_Subtype_Indication
425 -- Otherwise the index denotes a single element (or a
426 -- subtype name which doesn't require range checks).
428 else pragma Assert (Nkind (Index) in N_Subexpr);
429 Apply_Scalar_Range_Check (Index, Etype (Index_Typ));
439 end Expand_SPARK_N_Aggregate;
441 ----------------------------------------
442 -- Expand_SPARK_N_Attribute_Reference --
443 ----------------------------------------
445 procedure Expand_SPARK_N_Attribute_Reference (N : Node_Id) is
446 Aname : constant Name_Id := Attribute_Name (N);
447 Attr_Id : constant Attribute_Id := Get_Attribute_Id (Aname);
448 Loc : constant Source_Ptr := Sloc (N);
449 Pref : constant Node_Id := Prefix (N);
450 Typ : constant Entity_Id := Etype (N);
454 if Attr_Id = Attribute_To_Address then
456 -- Extract and convert argument to expected type for call
459 Make_Type_Conversion (Loc,
461 New_Occurrence_Of (RTE (RE_Integer_Address), Loc),
462 Expression => Relocate_Node (First (Expressions (N))));
464 -- Replace attribute reference with call
467 Make_Function_Call (Loc,
469 New_Occurrence_Of (RTE (RE_To_Address), Loc),
470 Parameter_Associations => New_List (Expr)));
471 Analyze_And_Resolve (N, Typ);
473 elsif Attr_Id = Attribute_Object_Size
474 or else Attr_Id = Attribute_Size
475 or else Attr_Id = Attribute_Value_Size
476 or else Attr_Id = Attribute_VADS_Size
478 Exp_Attr.Expand_Size_Attribute (N);
480 -- For attributes which return Universal_Integer, introduce a conversion
481 -- to the expected type with the appropriate check flags set.
483 elsif Attr_Id = Attribute_Alignment
484 or else Attr_Id = Attribute_Bit
485 or else Attr_Id = Attribute_Bit_Position
486 or else Attr_Id = Attribute_Descriptor_Size
487 or else Attr_Id = Attribute_First_Bit
488 or else Attr_Id = Attribute_Last_Bit
489 or else Attr_Id = Attribute_Length
490 or else Attr_Id = Attribute_Max_Size_In_Storage_Elements
491 or else Attr_Id = Attribute_Pos
492 or else Attr_Id = Attribute_Position
493 or else Attr_Id = Attribute_Range_Length
494 or else Attr_Id = Attribute_Aft
495 or else Attr_Id = Attribute_Max_Alignment_For_Allocation
497 -- If the expected type is Long_Long_Integer, there will be no check
498 -- flag as the compiler assumes attributes always fit in this type.
499 -- Since in SPARK_Mode we do not take Storage_Error into account, we
500 -- cannot make this assumption and need to produce a check.
501 -- ??? It should be enough to add this check for attributes
502 -- 'Length, 'Range_Length and 'Pos when the type is as big
503 -- as Long_Long_Integer.
508 if Attr_Id = Attribute_Range_Length
509 or else Attr_Id = Attribute_Pos
511 Typ := Etype (Prefix (N));
513 elsif Attr_Id = Attribute_Length then
514 Typ := Get_Index_Subtype (N);
520 Apply_Universal_Integer_Attribute_Checks (N);
523 and then RM_Size (Typ) = RM_Size (Standard_Long_Long_Integer)
525 -- ??? This should rather be a range check, but this would
526 -- crash GNATprove which somehow recovers the proper kind
528 Set_Do_Overflow_Check (N);
532 elsif Attr_Id = Attribute_Constrained then
534 -- If the prefix is an access to object, the attribute applies to
535 -- the designated object, so rewrite with an explicit dereference.
537 if Is_Access_Type (Etype (Pref))
539 (not Is_Entity_Name (Pref) or else Is_Object (Entity (Pref)))
542 Make_Explicit_Dereference (Loc, Relocate_Node (Pref)));
543 Analyze_And_Resolve (N, Standard_Boolean);
546 elsif Attr_Id = Attribute_Update then
547 Expand_SPARK_Delta_Or_Update (Typ, First (Expressions (N)));
549 end Expand_SPARK_N_Attribute_Reference;
551 ------------------------------------
552 -- Expand_SPARK_N_Delta_Aggregate --
553 ------------------------------------
555 procedure Expand_SPARK_N_Delta_Aggregate (N : Node_Id) is
557 Expand_SPARK_Delta_Or_Update (Etype (N), N);
558 end Expand_SPARK_N_Delta_Aggregate;
560 -----------------------------------
561 -- Expand_SPARK_N_Loop_Statement --
562 -----------------------------------
564 procedure Expand_SPARK_N_Loop_Statement (N : Node_Id) is
565 Scheme : constant Node_Id := Iteration_Scheme (N);
568 -- Loop iterations over arrays need to be expanded, to avoid getting
569 -- two names referring to the same object in memory (the array and the
570 -- iterator) in GNATprove, especially since both can be written (thus
571 -- possibly leading to interferences due to aliasing). No such problem
572 -- arises with quantified expressions over arrays, which are dealt with
573 -- specially in GNATprove.
576 and then Present (Iterator_Specification (Scheme))
577 and then Is_Iterator_Over_Array (Iterator_Specification (Scheme))
579 Expand_Iterator_Loop_Over_Array (N);
581 end Expand_SPARK_N_Loop_Statement;
583 ---------------------------------------
584 -- Expand_SPARK_N_Object_Declaration --
585 ---------------------------------------
587 procedure Expand_SPARK_N_Object_Declaration (N : Node_Id) is
588 Loc : constant Source_Ptr := Sloc (N);
589 Obj_Id : constant Entity_Id := Defining_Identifier (N);
590 Typ : constant Entity_Id := Etype (Obj_Id);
595 -- If the object declaration denotes a variable without initialization
596 -- whose type is subject to pragma Default_Initial_Condition, create
597 -- and analyze a dummy call to the DIC procedure of the type in order
598 -- to detect potential elaboration issues.
600 if Comes_From_Source (Obj_Id)
601 and then Ekind (Obj_Id) = E_Variable
602 and then Has_DIC (Typ)
603 and then Present (DIC_Procedure (Typ))
604 and then not Has_Init_Expression (N)
606 Call := Build_DIC_Call (Loc, Obj_Id, Typ);
608 -- Partially insert the call into the tree by setting its parent
611 Set_Parent (Call, N);
614 end Expand_SPARK_N_Object_Declaration;
616 ------------------------------------------------
617 -- Expand_SPARK_N_Object_Renaming_Declaration --
618 ------------------------------------------------
620 procedure Expand_SPARK_N_Object_Renaming_Declaration (N : Node_Id) is
621 CFS : constant Boolean := Comes_From_Source (N);
622 Loc : constant Source_Ptr := Sloc (N);
623 Obj_Id : constant Entity_Id := Defining_Entity (N);
624 Nam : constant Node_Id := Name (N);
625 Typ : constant Entity_Id := Etype (Obj_Id);
628 -- Transform a renaming of the form
630 -- Obj_Id : <subtype mark> renames <function call>;
634 -- Obj_Id : constant <subtype mark> := <function call>;
636 -- Invoking Evaluate_Name and ultimately Remove_Side_Effects introduces
637 -- a temporary to capture the function result. Once potential renamings
638 -- are rewritten for SPARK, the temporary may be leaked out into source
639 -- constructs and lead to confusing error diagnostics. Using an object
640 -- declaration prevents this unwanted side effect.
642 if Nkind (Nam) = N_Function_Call then
644 Make_Object_Declaration (Loc,
645 Defining_Identifier => Obj_Id,
646 Constant_Present => True,
647 Object_Definition => New_Occurrence_Of (Typ, Loc),
650 -- Inherit the original Comes_From_Source status of the renaming
652 Set_Comes_From_Source (N, CFS);
654 -- Sever the link to the renamed function result because the entity
655 -- will no longer alias anything.
657 Set_Renamed_Object (Obj_Id, Empty);
659 -- Remove the entity of the renaming declaration from visibility as
660 -- the analysis of the object declaration will reintroduce it again.
662 Remove_Entity_And_Homonym (Obj_Id);
665 -- Otherwise unconditionally remove all side effects from the name
670 end Expand_SPARK_N_Object_Renaming_Declaration;
672 --------------------------
673 -- Expand_SPARK_N_Op_Ne --
674 --------------------------
676 procedure Expand_SPARK_N_Op_Ne (N : Node_Id) is
677 Typ : constant Entity_Id := Etype (Left_Opnd (N));
680 -- Case of elementary type with standard operator
682 if Is_Elementary_Type (Typ)
683 and then Sloc (Entity (N)) = Standard_Location
688 Exp_Ch4.Expand_N_Op_Ne (N);
690 end Expand_SPARK_N_Op_Ne;
692 -------------------------------------
693 -- Expand_SPARK_Potential_Renaming --
694 -------------------------------------
696 procedure Expand_SPARK_Potential_Renaming (N : Node_Id) is
697 function In_Insignificant_Pragma (Nod : Node_Id) return Boolean;
698 -- Determine whether arbitrary node Nod appears within a significant
701 -----------------------------
702 -- In_Insignificant_Pragma --
703 -----------------------------
705 function In_Insignificant_Pragma (Nod : Node_Id) return Boolean is
709 -- Climb the parent chain looking for an enclosing pragma
712 while Present (Par) loop
713 if Nkind (Par) = N_Pragma then
714 return not Pragma_Significant_In_SPARK (Get_Pragma_Id (Par));
716 -- Prevent the search from going too far
718 elsif Is_Body_Or_Package_Declaration (Par) then
726 end In_Insignificant_Pragma;
730 Loc : constant Source_Ptr := Sloc (N);
731 Obj_Id : constant Entity_Id := Entity (N);
732 Typ : constant Entity_Id := Etype (N);
735 -- Start of processing for Expand_SPARK_Potential_Renaming
738 -- Replace a reference to a renaming with the actual renamed object
740 if Is_Object (Obj_Id) then
741 Ren := Renamed_Object (Obj_Id);
743 if Present (Ren) then
745 -- Do not process a reference when it appears within a pragma of
746 -- no significance to SPARK. It is assumed that the replacement
747 -- will violate the semantics of the pragma and cause a spurious
750 if In_Insignificant_Pragma (N) then
753 -- Instantiations and inlining of subprograms employ "prologues"
754 -- which map actual to formal parameters by means of renamings.
755 -- Replace a reference to a formal by the corresponding actual
758 elsif Nkind (Ren) in N_Entity then
759 Rewrite (N, New_Occurrence_Of (Ren, Loc));
761 -- Otherwise the renamed object denotes a name
764 Rewrite (N, New_Copy_Tree (Ren, New_Sloc => Loc));
765 Reset_Analyzed_Flags (N);
768 Analyze_And_Resolve (N, Typ);
771 end Expand_SPARK_Potential_Renaming;