Reverting merge from trunk
[official-gcc.git] / gcc / ada / checks.adb
blob328e05e5aaf30db70b05525c23b8f706f46fa52c
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- C H E C K S --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2013, 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 Casing; use Casing;
28 with Debug; use Debug;
29 with Einfo; use Einfo;
30 with Errout; use Errout;
31 with Exp_Ch2; use Exp_Ch2;
32 with Exp_Ch4; use Exp_Ch4;
33 with Exp_Ch11; use Exp_Ch11;
34 with Exp_Pakd; use Exp_Pakd;
35 with Exp_Tss; use Exp_Tss;
36 with Exp_Util; use Exp_Util;
37 with Elists; use Elists;
38 with Expander; use Expander;
39 with Eval_Fat; use Eval_Fat;
40 with Freeze; use Freeze;
41 with Lib; use Lib;
42 with Nlists; use Nlists;
43 with Nmake; use Nmake;
44 with Opt; use Opt;
45 with Output; use Output;
46 with Restrict; use Restrict;
47 with Rident; use Rident;
48 with Rtsfind; use Rtsfind;
49 with Sem; use Sem;
50 with Sem_Aux; use Sem_Aux;
51 with Sem_Eval; use Sem_Eval;
52 with Sem_Ch3; use Sem_Ch3;
53 with Sem_Ch8; use Sem_Ch8;
54 with Sem_Res; use Sem_Res;
55 with Sem_Util; use Sem_Util;
56 with Sem_Warn; use Sem_Warn;
57 with Sinfo; use Sinfo;
58 with Sinput; use Sinput;
59 with Snames; use Snames;
60 with Sprint; use Sprint;
61 with Stand; use Stand;
62 with Stringt; use Stringt;
63 with Targparm; use Targparm;
64 with Tbuild; use Tbuild;
65 with Ttypes; use Ttypes;
66 with Urealp; use Urealp;
67 with Validsw; use Validsw;
69 package body Checks is
71 -- General note: many of these routines are concerned with generating
72 -- checking code to make sure that constraint error is raised at runtime.
73 -- Clearly this code is only needed if the expander is active, since
74 -- otherwise we will not be generating code or going into the runtime
75 -- execution anyway.
77 -- We therefore disconnect most of these checks if the expander is
78 -- inactive. This has the additional benefit that we do not need to
79 -- worry about the tree being messed up by previous errors (since errors
80 -- turn off expansion anyway).
82 -- There are a few exceptions to the above rule. For instance routines
83 -- such as Apply_Scalar_Range_Check that do not insert any code can be
84 -- safely called even when the Expander is inactive (but Errors_Detected
85 -- is 0). The benefit of executing this code when expansion is off, is
86 -- the ability to emit constraint error warning for static expressions
87 -- even when we are not generating code.
89 -------------------------------------
90 -- Suppression of Redundant Checks --
91 -------------------------------------
93 -- This unit implements a limited circuit for removal of redundant
94 -- checks. The processing is based on a tracing of simple sequential
95 -- flow. For any sequence of statements, we save expressions that are
96 -- marked to be checked, and then if the same expression appears later
97 -- with the same check, then under certain circumstances, the second
98 -- check can be suppressed.
100 -- Basically, we can suppress the check if we know for certain that
101 -- the previous expression has been elaborated (together with its
102 -- check), and we know that the exception frame is the same, and that
103 -- nothing has happened to change the result of the exception.
105 -- Let us examine each of these three conditions in turn to describe
106 -- how we ensure that this condition is met.
108 -- First, we need to know for certain that the previous expression has
109 -- been executed. This is done principally by the mechanism of calling
110 -- Conditional_Statements_Begin at the start of any statement sequence
111 -- and Conditional_Statements_End at the end. The End call causes all
112 -- checks remembered since the Begin call to be discarded. This does
113 -- miss a few cases, notably the case of a nested BEGIN-END block with
114 -- no exception handlers. But the important thing is to be conservative.
115 -- The other protection is that all checks are discarded if a label
116 -- is encountered, since then the assumption of sequential execution
117 -- is violated, and we don't know enough about the flow.
119 -- Second, we need to know that the exception frame is the same. We
120 -- do this by killing all remembered checks when we enter a new frame.
121 -- Again, that's over-conservative, but generally the cases we can help
122 -- with are pretty local anyway (like the body of a loop for example).
124 -- Third, we must be sure to forget any checks which are no longer valid.
125 -- This is done by two mechanisms, first the Kill_Checks_Variable call is
126 -- used to note any changes to local variables. We only attempt to deal
127 -- with checks involving local variables, so we do not need to worry
128 -- about global variables. Second, a call to any non-global procedure
129 -- causes us to abandon all stored checks, since such a all may affect
130 -- the values of any local variables.
132 -- The following define the data structures used to deal with remembering
133 -- checks so that redundant checks can be eliminated as described above.
135 -- Right now, the only expressions that we deal with are of the form of
136 -- simple local objects (either declared locally, or IN parameters) or
137 -- such objects plus/minus a compile time known constant. We can do
138 -- more later on if it seems worthwhile, but this catches many simple
139 -- cases in practice.
141 -- The following record type reflects a single saved check. An entry
142 -- is made in the stack of saved checks if and only if the expression
143 -- has been elaborated with the indicated checks.
145 type Saved_Check is record
146 Killed : Boolean;
147 -- Set True if entry is killed by Kill_Checks
149 Entity : Entity_Id;
150 -- The entity involved in the expression that is checked
152 Offset : Uint;
153 -- A compile time value indicating the result of adding or
154 -- subtracting a compile time value. This value is to be
155 -- added to the value of the Entity. A value of zero is
156 -- used for the case of a simple entity reference.
158 Check_Type : Character;
159 -- This is set to 'R' for a range check (in which case Target_Type
160 -- is set to the target type for the range check) or to 'O' for an
161 -- overflow check (in which case Target_Type is set to Empty).
163 Target_Type : Entity_Id;
164 -- Used only if Do_Range_Check is set. Records the target type for
165 -- the check. We need this, because a check is a duplicate only if
166 -- it has the same target type (or more accurately one with a
167 -- range that is smaller or equal to the stored target type of a
168 -- saved check).
169 end record;
171 -- The following table keeps track of saved checks. Rather than use an
172 -- extensible table. We just use a table of fixed size, and we discard
173 -- any saved checks that do not fit. That's very unlikely to happen and
174 -- this is only an optimization in any case.
176 Saved_Checks : array (Int range 1 .. 200) of Saved_Check;
177 -- Array of saved checks
179 Num_Saved_Checks : Nat := 0;
180 -- Number of saved checks
182 -- The following stack keeps track of statement ranges. It is treated
183 -- as a stack. When Conditional_Statements_Begin is called, an entry
184 -- is pushed onto this stack containing the value of Num_Saved_Checks
185 -- at the time of the call. Then when Conditional_Statements_End is
186 -- called, this value is popped off and used to reset Num_Saved_Checks.
188 -- Note: again, this is a fixed length stack with a size that should
189 -- always be fine. If the value of the stack pointer goes above the
190 -- limit, then we just forget all saved checks.
192 Saved_Checks_Stack : array (Int range 1 .. 100) of Nat;
193 Saved_Checks_TOS : Nat := 0;
195 -----------------------
196 -- Local Subprograms --
197 -----------------------
199 procedure Apply_Arithmetic_Overflow_Strict (N : Node_Id);
200 -- Used to apply arithmetic overflow checks for all cases except operators
201 -- on signed arithmetic types in MINIMIZED/ELIMINATED case (for which we
202 -- call Apply_Arithmetic_Overflow_Minimized_Eliminated below). N can be a
203 -- signed integer arithmetic operator (but not an if or case expression).
204 -- It is also called for types other than signed integers.
206 procedure Apply_Arithmetic_Overflow_Minimized_Eliminated (Op : Node_Id);
207 -- Used to apply arithmetic overflow checks for the case where the overflow
208 -- checking mode is MINIMIZED or ELIMINATED and we have a signed integer
209 -- arithmetic op (which includes the case of if and case expressions). Note
210 -- that Do_Overflow_Check may or may not be set for node Op. In these modes
211 -- we have work to do even if overflow checking is suppressed.
213 procedure Apply_Division_Check
214 (N : Node_Id;
215 Rlo : Uint;
216 Rhi : Uint;
217 ROK : Boolean);
218 -- N is an N_Op_Div, N_Op_Rem, or N_Op_Mod node. This routine applies
219 -- division checks as required if the Do_Division_Check flag is set.
220 -- Rlo and Rhi give the possible range of the right operand, these values
221 -- can be referenced and trusted only if ROK is set True.
223 procedure Apply_Float_Conversion_Check
224 (Ck_Node : Node_Id;
225 Target_Typ : Entity_Id);
226 -- The checks on a conversion from a floating-point type to an integer
227 -- type are delicate. They have to be performed before conversion, they
228 -- have to raise an exception when the operand is a NaN, and rounding must
229 -- be taken into account to determine the safe bounds of the operand.
231 procedure Apply_Selected_Length_Checks
232 (Ck_Node : Node_Id;
233 Target_Typ : Entity_Id;
234 Source_Typ : Entity_Id;
235 Do_Static : Boolean);
236 -- This is the subprogram that does all the work for Apply_Length_Check
237 -- and Apply_Static_Length_Check. Expr, Target_Typ and Source_Typ are as
238 -- described for the above routines. The Do_Static flag indicates that
239 -- only a static check is to be done.
241 procedure Apply_Selected_Range_Checks
242 (Ck_Node : Node_Id;
243 Target_Typ : Entity_Id;
244 Source_Typ : Entity_Id;
245 Do_Static : Boolean);
246 -- This is the subprogram that does all the work for Apply_Range_Check.
247 -- Expr, Target_Typ and Source_Typ are as described for the above
248 -- routine. The Do_Static flag indicates that only a static check is
249 -- to be done.
251 type Check_Type is new Check_Id range Access_Check .. Division_Check;
252 function Check_Needed (Nod : Node_Id; Check : Check_Type) return Boolean;
253 -- This function is used to see if an access or division by zero check is
254 -- needed. The check is to be applied to a single variable appearing in the
255 -- source, and N is the node for the reference. If N is not of this form,
256 -- True is returned with no further processing. If N is of the right form,
257 -- then further processing determines if the given Check is needed.
259 -- The particular circuit is to see if we have the case of a check that is
260 -- not needed because it appears in the right operand of a short circuited
261 -- conditional where the left operand guards the check. For example:
263 -- if Var = 0 or else Q / Var > 12 then
264 -- ...
265 -- end if;
267 -- In this example, the division check is not required. At the same time
268 -- we can issue warnings for suspicious use of non-short-circuited forms,
269 -- such as:
271 -- if Var = 0 or Q / Var > 12 then
272 -- ...
273 -- end if;
275 procedure Find_Check
276 (Expr : Node_Id;
277 Check_Type : Character;
278 Target_Type : Entity_Id;
279 Entry_OK : out Boolean;
280 Check_Num : out Nat;
281 Ent : out Entity_Id;
282 Ofs : out Uint);
283 -- This routine is used by Enable_Range_Check and Enable_Overflow_Check
284 -- to see if a check is of the form for optimization, and if so, to see
285 -- if it has already been performed. Expr is the expression to check,
286 -- and Check_Type is 'R' for a range check, 'O' for an overflow check.
287 -- Target_Type is the target type for a range check, and Empty for an
288 -- overflow check. If the entry is not of the form for optimization,
289 -- then Entry_OK is set to False, and the remaining out parameters
290 -- are undefined. If the entry is OK, then Ent/Ofs are set to the
291 -- entity and offset from the expression. Check_Num is the number of
292 -- a matching saved entry in Saved_Checks, or zero if no such entry
293 -- is located.
295 function Get_Discriminal (E : Entity_Id; Bound : Node_Id) return Node_Id;
296 -- If a discriminal is used in constraining a prival, Return reference
297 -- to the discriminal of the protected body (which renames the parameter
298 -- of the enclosing protected operation). This clumsy transformation is
299 -- needed because privals are created too late and their actual subtypes
300 -- are not available when analysing the bodies of the protected operations.
301 -- This function is called whenever the bound is an entity and the scope
302 -- indicates a protected operation. If the bound is an in-parameter of
303 -- a protected operation that is not a prival, the function returns the
304 -- bound itself.
305 -- To be cleaned up???
307 function Guard_Access
308 (Cond : Node_Id;
309 Loc : Source_Ptr;
310 Ck_Node : Node_Id) return Node_Id;
311 -- In the access type case, guard the test with a test to ensure
312 -- that the access value is non-null, since the checks do not
313 -- not apply to null access values.
315 procedure Install_Static_Check (R_Cno : Node_Id; Loc : Source_Ptr);
316 -- Called by Apply_{Length,Range}_Checks to rewrite the tree with the
317 -- Constraint_Error node.
319 function Is_Signed_Integer_Arithmetic_Op (N : Node_Id) return Boolean;
320 -- Returns True if node N is for an arithmetic operation with signed
321 -- integer operands. This includes unary and binary operators, and also
322 -- if and case expression nodes where the dependent expressions are of
323 -- a signed integer type. These are the kinds of nodes for which special
324 -- handling applies in MINIMIZED or ELIMINATED overflow checking mode.
326 function Range_Or_Validity_Checks_Suppressed
327 (Expr : Node_Id) return Boolean;
328 -- Returns True if either range or validity checks or both are suppressed
329 -- for the type of the given expression, or, if the expression is the name
330 -- of an entity, if these checks are suppressed for the entity.
332 function Selected_Length_Checks
333 (Ck_Node : Node_Id;
334 Target_Typ : Entity_Id;
335 Source_Typ : Entity_Id;
336 Warn_Node : Node_Id) return Check_Result;
337 -- Like Apply_Selected_Length_Checks, except it doesn't modify
338 -- anything, just returns a list of nodes as described in the spec of
339 -- this package for the Range_Check function.
341 function Selected_Range_Checks
342 (Ck_Node : Node_Id;
343 Target_Typ : Entity_Id;
344 Source_Typ : Entity_Id;
345 Warn_Node : Node_Id) return Check_Result;
346 -- Like Apply_Selected_Range_Checks, except it doesn't modify anything,
347 -- just returns a list of nodes as described in the spec of this package
348 -- for the Range_Check function.
350 ------------------------------
351 -- Access_Checks_Suppressed --
352 ------------------------------
354 function Access_Checks_Suppressed (E : Entity_Id) return Boolean is
355 begin
356 if Present (E) and then Checks_May_Be_Suppressed (E) then
357 return Is_Check_Suppressed (E, Access_Check);
358 else
359 return Scope_Suppress.Suppress (Access_Check);
360 end if;
361 end Access_Checks_Suppressed;
363 -------------------------------------
364 -- Accessibility_Checks_Suppressed --
365 -------------------------------------
367 function Accessibility_Checks_Suppressed (E : Entity_Id) return Boolean is
368 begin
369 if Present (E) and then Checks_May_Be_Suppressed (E) then
370 return Is_Check_Suppressed (E, Accessibility_Check);
371 else
372 return Scope_Suppress.Suppress (Accessibility_Check);
373 end if;
374 end Accessibility_Checks_Suppressed;
376 -----------------------------
377 -- Activate_Division_Check --
378 -----------------------------
380 procedure Activate_Division_Check (N : Node_Id) is
381 begin
382 Set_Do_Division_Check (N, True);
383 Possible_Local_Raise (N, Standard_Constraint_Error);
384 end Activate_Division_Check;
386 -----------------------------
387 -- Activate_Overflow_Check --
388 -----------------------------
390 procedure Activate_Overflow_Check (N : Node_Id) is
391 begin
392 if not Nkind_In (N, N_Op_Rem, N_Op_Mod, N_Op_Plus) then
393 Set_Do_Overflow_Check (N, True);
394 Possible_Local_Raise (N, Standard_Constraint_Error);
395 end if;
396 end Activate_Overflow_Check;
398 --------------------------
399 -- Activate_Range_Check --
400 --------------------------
402 procedure Activate_Range_Check (N : Node_Id) is
403 begin
404 Set_Do_Range_Check (N, True);
405 Possible_Local_Raise (N, Standard_Constraint_Error);
406 end Activate_Range_Check;
408 ---------------------------------
409 -- Alignment_Checks_Suppressed --
410 ---------------------------------
412 function Alignment_Checks_Suppressed (E : Entity_Id) return Boolean is
413 begin
414 if Present (E) and then Checks_May_Be_Suppressed (E) then
415 return Is_Check_Suppressed (E, Alignment_Check);
416 else
417 return Scope_Suppress.Suppress (Alignment_Check);
418 end if;
419 end Alignment_Checks_Suppressed;
421 -------------------------
422 -- Append_Range_Checks --
423 -------------------------
425 procedure Append_Range_Checks
426 (Checks : Check_Result;
427 Stmts : List_Id;
428 Suppress_Typ : Entity_Id;
429 Static_Sloc : Source_Ptr;
430 Flag_Node : Node_Id)
432 Internal_Flag_Node : constant Node_Id := Flag_Node;
433 Internal_Static_Sloc : constant Source_Ptr := Static_Sloc;
435 Checks_On : constant Boolean :=
436 (not Index_Checks_Suppressed (Suppress_Typ))
437 or else (not Range_Checks_Suppressed (Suppress_Typ));
439 begin
440 -- For now we just return if Checks_On is false, however this should
441 -- be enhanced to check for an always True value in the condition
442 -- and to generate a compilation warning???
444 if not Checks_On then
445 return;
446 end if;
448 for J in 1 .. 2 loop
449 exit when No (Checks (J));
451 if Nkind (Checks (J)) = N_Raise_Constraint_Error
452 and then Present (Condition (Checks (J)))
453 then
454 if not Has_Dynamic_Range_Check (Internal_Flag_Node) then
455 Append_To (Stmts, Checks (J));
456 Set_Has_Dynamic_Range_Check (Internal_Flag_Node);
457 end if;
459 else
460 Append_To
461 (Stmts,
462 Make_Raise_Constraint_Error (Internal_Static_Sloc,
463 Reason => CE_Range_Check_Failed));
464 end if;
465 end loop;
466 end Append_Range_Checks;
468 ------------------------
469 -- Apply_Access_Check --
470 ------------------------
472 procedure Apply_Access_Check (N : Node_Id) is
473 P : constant Node_Id := Prefix (N);
475 begin
476 -- We do not need checks if we are not generating code (i.e. the
477 -- expander is not active). This is not just an optimization, there
478 -- are cases (e.g. with pragma Debug) where generating the checks
479 -- can cause real trouble).
481 if not Full_Expander_Active then
482 return;
483 end if;
485 -- No check if short circuiting makes check unnecessary
487 if not Check_Needed (P, Access_Check) then
488 return;
489 end if;
491 -- No check if accessing the Offset_To_Top component of a dispatch
492 -- table. They are safe by construction.
494 if Tagged_Type_Expansion
495 and then Present (Etype (P))
496 and then RTU_Loaded (Ada_Tags)
497 and then RTE_Available (RE_Offset_To_Top_Ptr)
498 and then Etype (P) = RTE (RE_Offset_To_Top_Ptr)
499 then
500 return;
501 end if;
503 -- Otherwise go ahead and install the check
505 Install_Null_Excluding_Check (P);
506 end Apply_Access_Check;
508 -------------------------------
509 -- Apply_Accessibility_Check --
510 -------------------------------
512 procedure Apply_Accessibility_Check
513 (N : Node_Id;
514 Typ : Entity_Id;
515 Insert_Node : Node_Id)
517 Loc : constant Source_Ptr := Sloc (N);
518 Param_Ent : Entity_Id := Param_Entity (N);
519 Param_Level : Node_Id;
520 Type_Level : Node_Id;
522 begin
523 if Ada_Version >= Ada_2012
524 and then not Present (Param_Ent)
525 and then Is_Entity_Name (N)
526 and then Ekind_In (Entity (N), E_Constant, E_Variable)
527 and then Present (Effective_Extra_Accessibility (Entity (N)))
528 then
529 Param_Ent := Entity (N);
530 while Present (Renamed_Object (Param_Ent)) loop
532 -- Renamed_Object must return an Entity_Name here
533 -- because of preceding "Present (E_E_A (...))" test.
535 Param_Ent := Entity (Renamed_Object (Param_Ent));
536 end loop;
537 end if;
539 if Inside_A_Generic then
540 return;
542 -- Only apply the run-time check if the access parameter has an
543 -- associated extra access level parameter and when the level of the
544 -- type is less deep than the level of the access parameter, and
545 -- accessibility checks are not suppressed.
547 elsif Present (Param_Ent)
548 and then Present (Extra_Accessibility (Param_Ent))
549 and then UI_Gt (Object_Access_Level (N),
550 Deepest_Type_Access_Level (Typ))
551 and then not Accessibility_Checks_Suppressed (Param_Ent)
552 and then not Accessibility_Checks_Suppressed (Typ)
553 then
554 Param_Level :=
555 New_Occurrence_Of (Extra_Accessibility (Param_Ent), Loc);
557 Type_Level :=
558 Make_Integer_Literal (Loc, Deepest_Type_Access_Level (Typ));
560 -- Raise Program_Error if the accessibility level of the access
561 -- parameter is deeper than the level of the target access type.
563 Insert_Action (Insert_Node,
564 Make_Raise_Program_Error (Loc,
565 Condition =>
566 Make_Op_Gt (Loc,
567 Left_Opnd => Param_Level,
568 Right_Opnd => Type_Level),
569 Reason => PE_Accessibility_Check_Failed));
571 Analyze_And_Resolve (N);
572 end if;
573 end Apply_Accessibility_Check;
575 --------------------------------
576 -- Apply_Address_Clause_Check --
577 --------------------------------
579 procedure Apply_Address_Clause_Check (E : Entity_Id; N : Node_Id) is
580 pragma Assert (Nkind (N) = N_Freeze_Entity);
582 AC : constant Node_Id := Address_Clause (E);
583 Loc : constant Source_Ptr := Sloc (AC);
584 Typ : constant Entity_Id := Etype (E);
585 Aexp : constant Node_Id := Expression (AC);
587 Expr : Node_Id;
588 -- Address expression (not necessarily the same as Aexp, for example
589 -- when Aexp is a reference to a constant, in which case Expr gets
590 -- reset to reference the value expression of the constant.
592 procedure Compile_Time_Bad_Alignment;
593 -- Post error warnings when alignment is known to be incompatible. Note
594 -- that we do not go as far as inserting a raise of Program_Error since
595 -- this is an erroneous case, and it may happen that we are lucky and an
596 -- underaligned address turns out to be OK after all.
598 --------------------------------
599 -- Compile_Time_Bad_Alignment --
600 --------------------------------
602 procedure Compile_Time_Bad_Alignment is
603 begin
604 if Address_Clause_Overlay_Warnings then
605 Error_Msg_FE
606 ("?o?specified address for& may be inconsistent with alignment",
607 Aexp, E);
608 Error_Msg_FE
609 ("\?o?program execution may be erroneous (RM 13.3(27))",
610 Aexp, E);
611 Set_Address_Warning_Posted (AC);
612 end if;
613 end Compile_Time_Bad_Alignment;
615 -- Start of processing for Apply_Address_Clause_Check
617 begin
618 -- See if alignment check needed. Note that we never need a check if the
619 -- maximum alignment is one, since the check will always succeed.
621 -- Note: we do not check for checks suppressed here, since that check
622 -- was done in Sem_Ch13 when the address clause was processed. We are
623 -- only called if checks were not suppressed. The reason for this is
624 -- that we have to delay the call to Apply_Alignment_Check till freeze
625 -- time (so that all types etc are elaborated), but we have to check
626 -- the status of check suppressing at the point of the address clause.
628 if No (AC)
629 or else not Check_Address_Alignment (AC)
630 or else Maximum_Alignment = 1
631 then
632 return;
633 end if;
635 -- Obtain expression from address clause
637 Expr := Expression (AC);
639 -- The following loop digs for the real expression to use in the check
641 loop
642 -- For constant, get constant expression
644 if Is_Entity_Name (Expr)
645 and then Ekind (Entity (Expr)) = E_Constant
646 then
647 Expr := Constant_Value (Entity (Expr));
649 -- For unchecked conversion, get result to convert
651 elsif Nkind (Expr) = N_Unchecked_Type_Conversion then
652 Expr := Expression (Expr);
654 -- For (common case) of To_Address call, get argument
656 elsif Nkind (Expr) = N_Function_Call
657 and then Is_Entity_Name (Name (Expr))
658 and then Is_RTE (Entity (Name (Expr)), RE_To_Address)
659 then
660 Expr := First (Parameter_Associations (Expr));
662 if Nkind (Expr) = N_Parameter_Association then
663 Expr := Explicit_Actual_Parameter (Expr);
664 end if;
666 -- We finally have the real expression
668 else
669 exit;
670 end if;
671 end loop;
673 -- See if we know that Expr has a bad alignment at compile time
675 if Compile_Time_Known_Value (Expr)
676 and then (Known_Alignment (E) or else Known_Alignment (Typ))
677 then
678 declare
679 AL : Uint := Alignment (Typ);
681 begin
682 -- The object alignment might be more restrictive than the
683 -- type alignment.
685 if Known_Alignment (E) then
686 AL := Alignment (E);
687 end if;
689 if Expr_Value (Expr) mod AL /= 0 then
690 Compile_Time_Bad_Alignment;
691 else
692 return;
693 end if;
694 end;
696 -- If the expression has the form X'Address, then we can find out if
697 -- the object X has an alignment that is compatible with the object E.
698 -- If it hasn't or we don't know, we defer issuing the warning until
699 -- the end of the compilation to take into account back end annotations.
701 elsif Nkind (Expr) = N_Attribute_Reference
702 and then Attribute_Name (Expr) = Name_Address
703 and then Has_Compatible_Alignment (E, Prefix (Expr)) = Known_Compatible
704 then
705 return;
706 end if;
708 -- Here we do not know if the value is acceptable. Strictly we don't
709 -- have to do anything, since if the alignment is bad, we have an
710 -- erroneous program. However we are allowed to check for erroneous
711 -- conditions and we decide to do this by default if the check is not
712 -- suppressed.
714 -- However, don't do the check if elaboration code is unwanted
716 if Restriction_Active (No_Elaboration_Code) then
717 return;
719 -- Generate a check to raise PE if alignment may be inappropriate
721 else
722 -- If the original expression is a non-static constant, use the
723 -- name of the constant itself rather than duplicating its
724 -- defining expression, which was extracted above.
726 -- Note: Expr is empty if the address-clause is applied to in-mode
727 -- actuals (allowed by 13.1(22)).
729 if not Present (Expr)
730 or else
731 (Is_Entity_Name (Expression (AC))
732 and then Ekind (Entity (Expression (AC))) = E_Constant
733 and then Nkind (Parent (Entity (Expression (AC))))
734 = N_Object_Declaration)
735 then
736 Expr := New_Copy_Tree (Expression (AC));
737 else
738 Remove_Side_Effects (Expr);
739 end if;
741 if No (Actions (N)) then
742 Set_Actions (N, New_List);
743 end if;
745 Prepend_To (Actions (N),
746 Make_Raise_Program_Error (Loc,
747 Condition =>
748 Make_Op_Ne (Loc,
749 Left_Opnd =>
750 Make_Op_Mod (Loc,
751 Left_Opnd =>
752 Unchecked_Convert_To
753 (RTE (RE_Integer_Address), Expr),
754 Right_Opnd =>
755 Make_Attribute_Reference (Loc,
756 Prefix => New_Occurrence_Of (E, Loc),
757 Attribute_Name => Name_Alignment)),
758 Right_Opnd => Make_Integer_Literal (Loc, Uint_0)),
759 Reason => PE_Misaligned_Address_Value));
760 Analyze (First (Actions (N)), Suppress => All_Checks);
761 return;
762 end if;
764 exception
765 -- If we have some missing run time component in configurable run time
766 -- mode then just skip the check (it is not required in any case).
768 when RE_Not_Available =>
769 return;
770 end Apply_Address_Clause_Check;
772 -------------------------------------
773 -- Apply_Arithmetic_Overflow_Check --
774 -------------------------------------
776 procedure Apply_Arithmetic_Overflow_Check (N : Node_Id) is
777 begin
778 -- Use old routine in almost all cases (the only case we are treating
779 -- specially is the case of a signed integer arithmetic op with the
780 -- overflow checking mode set to MINIMIZED or ELIMINATED).
782 if Overflow_Check_Mode = Strict
783 or else not Is_Signed_Integer_Arithmetic_Op (N)
784 then
785 Apply_Arithmetic_Overflow_Strict (N);
787 -- Otherwise use the new routine for the case of a signed integer
788 -- arithmetic op, with Do_Overflow_Check set to True, and the checking
789 -- mode is MINIMIZED or ELIMINATED.
791 else
792 Apply_Arithmetic_Overflow_Minimized_Eliminated (N);
793 end if;
794 end Apply_Arithmetic_Overflow_Check;
796 --------------------------------------
797 -- Apply_Arithmetic_Overflow_Strict --
798 --------------------------------------
800 -- This routine is called only if the type is an integer type, and a
801 -- software arithmetic overflow check may be needed for op (add, subtract,
802 -- or multiply). This check is performed only if Software_Overflow_Checking
803 -- is enabled and Do_Overflow_Check is set. In this case we expand the
804 -- operation into a more complex sequence of tests that ensures that
805 -- overflow is properly caught.
807 -- This is used in CHECKED modes. It is identical to the code for this
808 -- cases before the big overflow earthquake, thus ensuring that in this
809 -- modes we have compatible behavior (and reliability) to what was there
810 -- before. It is also called for types other than signed integers, and if
811 -- the Do_Overflow_Check flag is off.
813 -- Note: we also call this routine if we decide in the MINIMIZED case
814 -- to give up and just generate an overflow check without any fuss.
816 procedure Apply_Arithmetic_Overflow_Strict (N : Node_Id) is
817 Loc : constant Source_Ptr := Sloc (N);
818 Typ : constant Entity_Id := Etype (N);
819 Rtyp : constant Entity_Id := Root_Type (Typ);
821 begin
822 -- Nothing to do if Do_Overflow_Check not set or overflow checks
823 -- suppressed.
825 if not Do_Overflow_Check (N) then
826 return;
827 end if;
829 -- An interesting special case. If the arithmetic operation appears as
830 -- the operand of a type conversion:
832 -- type1 (x op y)
834 -- and all the following conditions apply:
836 -- arithmetic operation is for a signed integer type
837 -- target type type1 is a static integer subtype
838 -- range of x and y are both included in the range of type1
839 -- range of x op y is included in the range of type1
840 -- size of type1 is at least twice the result size of op
842 -- then we don't do an overflow check in any case, instead we transform
843 -- the operation so that we end up with:
845 -- type1 (type1 (x) op type1 (y))
847 -- This avoids intermediate overflow before the conversion. It is
848 -- explicitly permitted by RM 3.5.4(24):
850 -- For the execution of a predefined operation of a signed integer
851 -- type, the implementation need not raise Constraint_Error if the
852 -- result is outside the base range of the type, so long as the
853 -- correct result is produced.
855 -- It's hard to imagine that any programmer counts on the exception
856 -- being raised in this case, and in any case it's wrong coding to
857 -- have this expectation, given the RM permission. Furthermore, other
858 -- Ada compilers do allow such out of range results.
860 -- Note that we do this transformation even if overflow checking is
861 -- off, since this is precisely about giving the "right" result and
862 -- avoiding the need for an overflow check.
864 -- Note: this circuit is partially redundant with respect to the similar
865 -- processing in Exp_Ch4.Expand_N_Type_Conversion, but the latter deals
866 -- with cases that do not come through here. We still need the following
867 -- processing even with the Exp_Ch4 code in place, since we want to be
868 -- sure not to generate the arithmetic overflow check in these cases
869 -- (Exp_Ch4 would have a hard time removing them once generated).
871 if Is_Signed_Integer_Type (Typ)
872 and then Nkind (Parent (N)) = N_Type_Conversion
873 then
874 Conversion_Optimization : declare
875 Target_Type : constant Entity_Id :=
876 Base_Type (Entity (Subtype_Mark (Parent (N))));
878 Llo, Lhi : Uint;
879 Rlo, Rhi : Uint;
880 LOK, ROK : Boolean;
882 Vlo : Uint;
883 Vhi : Uint;
884 VOK : Boolean;
886 Tlo : Uint;
887 Thi : Uint;
889 begin
890 if Is_Integer_Type (Target_Type)
891 and then RM_Size (Root_Type (Target_Type)) >= 2 * RM_Size (Rtyp)
892 then
893 Tlo := Expr_Value (Type_Low_Bound (Target_Type));
894 Thi := Expr_Value (Type_High_Bound (Target_Type));
896 Determine_Range
897 (Left_Opnd (N), LOK, Llo, Lhi, Assume_Valid => True);
898 Determine_Range
899 (Right_Opnd (N), ROK, Rlo, Rhi, Assume_Valid => True);
901 if (LOK and ROK)
902 and then Tlo <= Llo and then Lhi <= Thi
903 and then Tlo <= Rlo and then Rhi <= Thi
904 then
905 Determine_Range (N, VOK, Vlo, Vhi, Assume_Valid => True);
907 if VOK and then Tlo <= Vlo and then Vhi <= Thi then
908 Rewrite (Left_Opnd (N),
909 Make_Type_Conversion (Loc,
910 Subtype_Mark => New_Occurrence_Of (Target_Type, Loc),
911 Expression => Relocate_Node (Left_Opnd (N))));
913 Rewrite (Right_Opnd (N),
914 Make_Type_Conversion (Loc,
915 Subtype_Mark => New_Occurrence_Of (Target_Type, Loc),
916 Expression => Relocate_Node (Right_Opnd (N))));
918 -- Rewrite the conversion operand so that the original
919 -- node is retained, in order to avoid the warning for
920 -- redundant conversions in Resolve_Type_Conversion.
922 Rewrite (N, Relocate_Node (N));
924 Set_Etype (N, Target_Type);
926 Analyze_And_Resolve (Left_Opnd (N), Target_Type);
927 Analyze_And_Resolve (Right_Opnd (N), Target_Type);
929 -- Given that the target type is twice the size of the
930 -- source type, overflow is now impossible, so we can
931 -- safely kill the overflow check and return.
933 Set_Do_Overflow_Check (N, False);
934 return;
935 end if;
936 end if;
937 end if;
938 end Conversion_Optimization;
939 end if;
941 -- Now see if an overflow check is required
943 declare
944 Siz : constant Int := UI_To_Int (Esize (Rtyp));
945 Dsiz : constant Int := Siz * 2;
946 Opnod : Node_Id;
947 Ctyp : Entity_Id;
948 Opnd : Node_Id;
949 Cent : RE_Id;
951 begin
952 -- Skip check if back end does overflow checks, or the overflow flag
953 -- is not set anyway, or we are not doing code expansion, or the
954 -- parent node is a type conversion whose operand is an arithmetic
955 -- operation on signed integers on which the expander can promote
956 -- later the operands to type Integer (see Expand_N_Type_Conversion).
958 -- Special case CLI target, where arithmetic overflow checks can be
959 -- performed for integer and long_integer
961 if Backend_Overflow_Checks_On_Target
962 or else not Do_Overflow_Check (N)
963 or else not Full_Expander_Active
964 or else (Present (Parent (N))
965 and then Nkind (Parent (N)) = N_Type_Conversion
966 and then Integer_Promotion_Possible (Parent (N)))
967 or else
968 (VM_Target = CLI_Target and then Siz >= Standard_Integer_Size)
969 then
970 return;
971 end if;
973 -- Otherwise, generate the full general code for front end overflow
974 -- detection, which works by doing arithmetic in a larger type:
976 -- x op y
978 -- is expanded into
980 -- Typ (Checktyp (x) op Checktyp (y));
982 -- where Typ is the type of the original expression, and Checktyp is
983 -- an integer type of sufficient length to hold the largest possible
984 -- result.
986 -- If the size of check type exceeds the size of Long_Long_Integer,
987 -- we use a different approach, expanding to:
989 -- typ (xxx_With_Ovflo_Check (Integer_64 (x), Integer (y)))
991 -- where xxx is Add, Multiply or Subtract as appropriate
993 -- Find check type if one exists
995 if Dsiz <= Standard_Integer_Size then
996 Ctyp := Standard_Integer;
998 elsif Dsiz <= Standard_Long_Long_Integer_Size then
999 Ctyp := Standard_Long_Long_Integer;
1001 -- No check type exists, use runtime call
1003 else
1004 if Nkind (N) = N_Op_Add then
1005 Cent := RE_Add_With_Ovflo_Check;
1007 elsif Nkind (N) = N_Op_Multiply then
1008 Cent := RE_Multiply_With_Ovflo_Check;
1010 else
1011 pragma Assert (Nkind (N) = N_Op_Subtract);
1012 Cent := RE_Subtract_With_Ovflo_Check;
1013 end if;
1015 Rewrite (N,
1016 OK_Convert_To (Typ,
1017 Make_Function_Call (Loc,
1018 Name => New_Reference_To (RTE (Cent), Loc),
1019 Parameter_Associations => New_List (
1020 OK_Convert_To (RTE (RE_Integer_64), Left_Opnd (N)),
1021 OK_Convert_To (RTE (RE_Integer_64), Right_Opnd (N))))));
1023 Analyze_And_Resolve (N, Typ);
1024 return;
1025 end if;
1027 -- If we fall through, we have the case where we do the arithmetic
1028 -- in the next higher type and get the check by conversion. In these
1029 -- cases Ctyp is set to the type to be used as the check type.
1031 Opnod := Relocate_Node (N);
1033 Opnd := OK_Convert_To (Ctyp, Left_Opnd (Opnod));
1035 Analyze (Opnd);
1036 Set_Etype (Opnd, Ctyp);
1037 Set_Analyzed (Opnd, True);
1038 Set_Left_Opnd (Opnod, Opnd);
1040 Opnd := OK_Convert_To (Ctyp, Right_Opnd (Opnod));
1042 Analyze (Opnd);
1043 Set_Etype (Opnd, Ctyp);
1044 Set_Analyzed (Opnd, True);
1045 Set_Right_Opnd (Opnod, Opnd);
1047 -- The type of the operation changes to the base type of the check
1048 -- type, and we reset the overflow check indication, since clearly no
1049 -- overflow is possible now that we are using a double length type.
1050 -- We also set the Analyzed flag to avoid a recursive attempt to
1051 -- expand the node.
1053 Set_Etype (Opnod, Base_Type (Ctyp));
1054 Set_Do_Overflow_Check (Opnod, False);
1055 Set_Analyzed (Opnod, True);
1057 -- Now build the outer conversion
1059 Opnd := OK_Convert_To (Typ, Opnod);
1060 Analyze (Opnd);
1061 Set_Etype (Opnd, Typ);
1063 -- In the discrete type case, we directly generate the range check
1064 -- for the outer operand. This range check will implement the
1065 -- required overflow check.
1067 if Is_Discrete_Type (Typ) then
1068 Rewrite (N, Opnd);
1069 Generate_Range_Check
1070 (Expression (N), Typ, CE_Overflow_Check_Failed);
1072 -- For other types, we enable overflow checking on the conversion,
1073 -- after setting the node as analyzed to prevent recursive attempts
1074 -- to expand the conversion node.
1076 else
1077 Set_Analyzed (Opnd, True);
1078 Enable_Overflow_Check (Opnd);
1079 Rewrite (N, Opnd);
1080 end if;
1082 exception
1083 when RE_Not_Available =>
1084 return;
1085 end;
1086 end Apply_Arithmetic_Overflow_Strict;
1088 ----------------------------------------------------
1089 -- Apply_Arithmetic_Overflow_Minimized_Eliminated --
1090 ----------------------------------------------------
1092 procedure Apply_Arithmetic_Overflow_Minimized_Eliminated (Op : Node_Id) is
1093 pragma Assert (Is_Signed_Integer_Arithmetic_Op (Op));
1095 Loc : constant Source_Ptr := Sloc (Op);
1096 P : constant Node_Id := Parent (Op);
1098 LLIB : constant Entity_Id := Base_Type (Standard_Long_Long_Integer);
1099 -- Operands and results are of this type when we convert
1101 Result_Type : constant Entity_Id := Etype (Op);
1102 -- Original result type
1104 Check_Mode : constant Overflow_Mode_Type := Overflow_Check_Mode;
1105 pragma Assert (Check_Mode in Minimized_Or_Eliminated);
1107 Lo, Hi : Uint;
1108 -- Ranges of values for result
1110 begin
1111 -- Nothing to do if our parent is one of the following:
1113 -- Another signed integer arithmetic op
1114 -- A membership operation
1115 -- A comparison operation
1117 -- In all these cases, we will process at the higher level (and then
1118 -- this node will be processed during the downwards recursion that
1119 -- is part of the processing in Minimize_Eliminate_Overflows).
1121 if Is_Signed_Integer_Arithmetic_Op (P)
1122 or else Nkind (P) in N_Membership_Test
1123 or else Nkind (P) in N_Op_Compare
1125 -- This is also true for an alternative in a case expression
1127 or else Nkind (P) = N_Case_Expression_Alternative
1129 -- This is also true for a range operand in a membership test
1131 or else (Nkind (P) = N_Range
1132 and then Nkind (Parent (P)) in N_Membership_Test)
1133 then
1134 return;
1135 end if;
1137 -- Otherwise, we have a top level arithmetic operation node, and this
1138 -- is where we commence the special processing for MINIMIZED/ELIMINATED
1139 -- modes. This is the case where we tell the machinery not to move into
1140 -- Bignum mode at this top level (of course the top level operation
1141 -- will still be in Bignum mode if either of its operands are of type
1142 -- Bignum).
1144 Minimize_Eliminate_Overflows (Op, Lo, Hi, Top_Level => True);
1146 -- That call may but does not necessarily change the result type of Op.
1147 -- It is the job of this routine to undo such changes, so that at the
1148 -- top level, we have the proper type. This "undoing" is a point at
1149 -- which a final overflow check may be applied.
1151 -- If the result type was not fiddled we are all set. We go to base
1152 -- types here because things may have been rewritten to generate the
1153 -- base type of the operand types.
1155 if Base_Type (Etype (Op)) = Base_Type (Result_Type) then
1156 return;
1158 -- Bignum case
1160 elsif Is_RTE (Etype (Op), RE_Bignum) then
1162 -- We need a sequence that looks like:
1164 -- Rnn : Result_Type;
1166 -- declare
1167 -- M : Mark_Id := SS_Mark;
1168 -- begin
1169 -- Rnn := Long_Long_Integer'Base (From_Bignum (Op));
1170 -- SS_Release (M);
1171 -- end;
1173 -- This block is inserted (using Insert_Actions), and then the node
1174 -- is replaced with a reference to Rnn.
1176 -- A special case arises if our parent is a conversion node. In this
1177 -- case no point in generating a conversion to Result_Type, we will
1178 -- let the parent handle this. Note that this special case is not
1179 -- just about optimization. Consider
1181 -- A,B,C : Integer;
1182 -- ...
1183 -- X := Long_Long_Integer'Base (A * (B ** C));
1185 -- Now the product may fit in Long_Long_Integer but not in Integer.
1186 -- In MINIMIZED/ELIMINATED mode, we don't want to introduce an
1187 -- overflow exception for this intermediate value.
1189 declare
1190 Blk : constant Node_Id := Make_Bignum_Block (Loc);
1191 Rnn : constant Entity_Id := Make_Temporary (Loc, 'R', Op);
1192 RHS : Node_Id;
1194 Rtype : Entity_Id;
1196 begin
1197 RHS := Convert_From_Bignum (Op);
1199 if Nkind (P) /= N_Type_Conversion then
1200 Convert_To_And_Rewrite (Result_Type, RHS);
1201 Rtype := Result_Type;
1203 -- Interesting question, do we need a check on that conversion
1204 -- operation. Answer, not if we know the result is in range.
1205 -- At the moment we are not taking advantage of this. To be
1206 -- looked at later ???
1208 else
1209 Rtype := LLIB;
1210 end if;
1212 Insert_Before
1213 (First (Statements (Handled_Statement_Sequence (Blk))),
1214 Make_Assignment_Statement (Loc,
1215 Name => New_Occurrence_Of (Rnn, Loc),
1216 Expression => RHS));
1218 Insert_Actions (Op, New_List (
1219 Make_Object_Declaration (Loc,
1220 Defining_Identifier => Rnn,
1221 Object_Definition => New_Occurrence_Of (Rtype, Loc)),
1222 Blk));
1224 Rewrite (Op, New_Occurrence_Of (Rnn, Loc));
1225 Analyze_And_Resolve (Op);
1226 end;
1228 -- Here we know the result is Long_Long_Integer'Base, of that it has
1229 -- been rewritten because the parent operation is a conversion. See
1230 -- Apply_Arithmetic_Overflow_Strict.Conversion_Optimization.
1232 else
1233 pragma Assert
1234 (Etype (Op) = LLIB or else Nkind (Parent (Op)) = N_Type_Conversion);
1236 -- All we need to do here is to convert the result to the proper
1237 -- result type. As explained above for the Bignum case, we can
1238 -- omit this if our parent is a type conversion.
1240 if Nkind (P) /= N_Type_Conversion then
1241 Convert_To_And_Rewrite (Result_Type, Op);
1242 end if;
1244 Analyze_And_Resolve (Op);
1245 end if;
1246 end Apply_Arithmetic_Overflow_Minimized_Eliminated;
1248 ----------------------------
1249 -- Apply_Constraint_Check --
1250 ----------------------------
1252 procedure Apply_Constraint_Check
1253 (N : Node_Id;
1254 Typ : Entity_Id;
1255 No_Sliding : Boolean := False)
1257 Desig_Typ : Entity_Id;
1259 begin
1260 -- No checks inside a generic (check the instantiations)
1262 if Inside_A_Generic then
1263 return;
1264 end if;
1266 -- Apply required constraint checks
1268 if Is_Scalar_Type (Typ) then
1269 Apply_Scalar_Range_Check (N, Typ);
1271 elsif Is_Array_Type (Typ) then
1273 -- A useful optimization: an aggregate with only an others clause
1274 -- always has the right bounds.
1276 if Nkind (N) = N_Aggregate
1277 and then No (Expressions (N))
1278 and then Nkind
1279 (First (Choices (First (Component_Associations (N)))))
1280 = N_Others_Choice
1281 then
1282 return;
1283 end if;
1285 if Is_Constrained (Typ) then
1286 Apply_Length_Check (N, Typ);
1288 if No_Sliding then
1289 Apply_Range_Check (N, Typ);
1290 end if;
1291 else
1292 Apply_Range_Check (N, Typ);
1293 end if;
1295 elsif (Is_Record_Type (Typ) or else Is_Private_Type (Typ))
1296 and then Has_Discriminants (Base_Type (Typ))
1297 and then Is_Constrained (Typ)
1298 then
1299 Apply_Discriminant_Check (N, Typ);
1301 elsif Is_Access_Type (Typ) then
1303 Desig_Typ := Designated_Type (Typ);
1305 -- No checks necessary if expression statically null
1307 if Known_Null (N) then
1308 if Can_Never_Be_Null (Typ) then
1309 Install_Null_Excluding_Check (N);
1310 end if;
1312 -- No sliding possible on access to arrays
1314 elsif Is_Array_Type (Desig_Typ) then
1315 if Is_Constrained (Desig_Typ) then
1316 Apply_Length_Check (N, Typ);
1317 end if;
1319 Apply_Range_Check (N, Typ);
1321 elsif Has_Discriminants (Base_Type (Desig_Typ))
1322 and then Is_Constrained (Desig_Typ)
1323 then
1324 Apply_Discriminant_Check (N, Typ);
1325 end if;
1327 -- Apply the 2005 Null_Excluding check. Note that we do not apply
1328 -- this check if the constraint node is illegal, as shown by having
1329 -- an error posted. This additional guard prevents cascaded errors
1330 -- and compiler aborts on illegal programs involving Ada 2005 checks.
1332 if Can_Never_Be_Null (Typ)
1333 and then not Can_Never_Be_Null (Etype (N))
1334 and then not Error_Posted (N)
1335 then
1336 Install_Null_Excluding_Check (N);
1337 end if;
1338 end if;
1339 end Apply_Constraint_Check;
1341 ------------------------------
1342 -- Apply_Discriminant_Check --
1343 ------------------------------
1345 procedure Apply_Discriminant_Check
1346 (N : Node_Id;
1347 Typ : Entity_Id;
1348 Lhs : Node_Id := Empty)
1350 Loc : constant Source_Ptr := Sloc (N);
1351 Do_Access : constant Boolean := Is_Access_Type (Typ);
1352 S_Typ : Entity_Id := Etype (N);
1353 Cond : Node_Id;
1354 T_Typ : Entity_Id;
1356 function Denotes_Explicit_Dereference (Obj : Node_Id) return Boolean;
1357 -- A heap object with an indefinite subtype is constrained by its
1358 -- initial value, and assigning to it requires a constraint_check.
1359 -- The target may be an explicit dereference, or a renaming of one.
1361 function Is_Aliased_Unconstrained_Component return Boolean;
1362 -- It is possible for an aliased component to have a nominal
1363 -- unconstrained subtype (through instantiation). If this is a
1364 -- discriminated component assigned in the expansion of an aggregate
1365 -- in an initialization, the check must be suppressed. This unusual
1366 -- situation requires a predicate of its own.
1368 ----------------------------------
1369 -- Denotes_Explicit_Dereference --
1370 ----------------------------------
1372 function Denotes_Explicit_Dereference (Obj : Node_Id) return Boolean is
1373 begin
1374 return
1375 Nkind (Obj) = N_Explicit_Dereference
1376 or else
1377 (Is_Entity_Name (Obj)
1378 and then Present (Renamed_Object (Entity (Obj)))
1379 and then Nkind (Renamed_Object (Entity (Obj))) =
1380 N_Explicit_Dereference);
1381 end Denotes_Explicit_Dereference;
1383 ----------------------------------------
1384 -- Is_Aliased_Unconstrained_Component --
1385 ----------------------------------------
1387 function Is_Aliased_Unconstrained_Component return Boolean is
1388 Comp : Entity_Id;
1389 Pref : Node_Id;
1391 begin
1392 if Nkind (Lhs) /= N_Selected_Component then
1393 return False;
1394 else
1395 Comp := Entity (Selector_Name (Lhs));
1396 Pref := Prefix (Lhs);
1397 end if;
1399 if Ekind (Comp) /= E_Component
1400 or else not Is_Aliased (Comp)
1401 then
1402 return False;
1403 end if;
1405 return not Comes_From_Source (Pref)
1406 and then In_Instance
1407 and then not Is_Constrained (Etype (Comp));
1408 end Is_Aliased_Unconstrained_Component;
1410 -- Start of processing for Apply_Discriminant_Check
1412 begin
1413 if Do_Access then
1414 T_Typ := Designated_Type (Typ);
1415 else
1416 T_Typ := Typ;
1417 end if;
1419 -- Nothing to do if discriminant checks are suppressed or else no code
1420 -- is to be generated
1422 if not Full_Expander_Active
1423 or else Discriminant_Checks_Suppressed (T_Typ)
1424 then
1425 return;
1426 end if;
1428 -- No discriminant checks necessary for an access when expression is
1429 -- statically Null. This is not only an optimization, it is fundamental
1430 -- because otherwise discriminant checks may be generated in init procs
1431 -- for types containing an access to a not-yet-frozen record, causing a
1432 -- deadly forward reference.
1434 -- Also, if the expression is of an access type whose designated type is
1435 -- incomplete, then the access value must be null and we suppress the
1436 -- check.
1438 if Known_Null (N) then
1439 return;
1441 elsif Is_Access_Type (S_Typ) then
1442 S_Typ := Designated_Type (S_Typ);
1444 if Ekind (S_Typ) = E_Incomplete_Type then
1445 return;
1446 end if;
1447 end if;
1449 -- If an assignment target is present, then we need to generate the
1450 -- actual subtype if the target is a parameter or aliased object with
1451 -- an unconstrained nominal subtype.
1453 -- Ada 2005 (AI-363): For Ada 2005, we limit the building of the actual
1454 -- subtype to the parameter and dereference cases, since other aliased
1455 -- objects are unconstrained (unless the nominal subtype is explicitly
1456 -- constrained).
1458 if Present (Lhs)
1459 and then (Present (Param_Entity (Lhs))
1460 or else (Ada_Version < Ada_2005
1461 and then not Is_Constrained (T_Typ)
1462 and then Is_Aliased_View (Lhs)
1463 and then not Is_Aliased_Unconstrained_Component)
1464 or else (Ada_Version >= Ada_2005
1465 and then not Is_Constrained (T_Typ)
1466 and then Denotes_Explicit_Dereference (Lhs)
1467 and then Nkind (Original_Node (Lhs)) /=
1468 N_Function_Call))
1469 then
1470 T_Typ := Get_Actual_Subtype (Lhs);
1471 end if;
1473 -- Nothing to do if the type is unconstrained (this is the case where
1474 -- the actual subtype in the RM sense of N is unconstrained and no check
1475 -- is required).
1477 if not Is_Constrained (T_Typ) then
1478 return;
1480 -- Ada 2005: nothing to do if the type is one for which there is a
1481 -- partial view that is constrained.
1483 elsif Ada_Version >= Ada_2005
1484 and then Object_Type_Has_Constrained_Partial_View
1485 (Typ => Base_Type (T_Typ),
1486 Scop => Current_Scope)
1487 then
1488 return;
1489 end if;
1491 -- Nothing to do if the type is an Unchecked_Union
1493 if Is_Unchecked_Union (Base_Type (T_Typ)) then
1494 return;
1495 end if;
1497 -- Suppress checks if the subtypes are the same. the check must be
1498 -- preserved in an assignment to a formal, because the constraint is
1499 -- given by the actual.
1501 if Nkind (Original_Node (N)) /= N_Allocator
1502 and then (No (Lhs)
1503 or else not Is_Entity_Name (Lhs)
1504 or else No (Param_Entity (Lhs)))
1505 then
1506 if (Etype (N) = Typ
1507 or else (Do_Access and then Designated_Type (Typ) = S_Typ))
1508 and then not Is_Aliased_View (Lhs)
1509 then
1510 return;
1511 end if;
1513 -- We can also eliminate checks on allocators with a subtype mark that
1514 -- coincides with the context type. The context type may be a subtype
1515 -- without a constraint (common case, a generic actual).
1517 elsif Nkind (Original_Node (N)) = N_Allocator
1518 and then Is_Entity_Name (Expression (Original_Node (N)))
1519 then
1520 declare
1521 Alloc_Typ : constant Entity_Id :=
1522 Entity (Expression (Original_Node (N)));
1524 begin
1525 if Alloc_Typ = T_Typ
1526 or else (Nkind (Parent (T_Typ)) = N_Subtype_Declaration
1527 and then Is_Entity_Name (
1528 Subtype_Indication (Parent (T_Typ)))
1529 and then Alloc_Typ = Base_Type (T_Typ))
1531 then
1532 return;
1533 end if;
1534 end;
1535 end if;
1537 -- See if we have a case where the types are both constrained, and all
1538 -- the constraints are constants. In this case, we can do the check
1539 -- successfully at compile time.
1541 -- We skip this check for the case where the node is rewritten`as
1542 -- an allocator, because it already carries the context subtype,
1543 -- and extracting the discriminants from the aggregate is messy.
1545 if Is_Constrained (S_Typ)
1546 and then Nkind (Original_Node (N)) /= N_Allocator
1547 then
1548 declare
1549 DconT : Elmt_Id;
1550 Discr : Entity_Id;
1551 DconS : Elmt_Id;
1552 ItemS : Node_Id;
1553 ItemT : Node_Id;
1555 begin
1556 -- S_Typ may not have discriminants in the case where it is a
1557 -- private type completed by a default discriminated type. In that
1558 -- case, we need to get the constraints from the underlying_type.
1559 -- If the underlying type is unconstrained (i.e. has no default
1560 -- discriminants) no check is needed.
1562 if Has_Discriminants (S_Typ) then
1563 Discr := First_Discriminant (S_Typ);
1564 DconS := First_Elmt (Discriminant_Constraint (S_Typ));
1566 else
1567 Discr := First_Discriminant (Underlying_Type (S_Typ));
1568 DconS :=
1569 First_Elmt
1570 (Discriminant_Constraint (Underlying_Type (S_Typ)));
1572 if No (DconS) then
1573 return;
1574 end if;
1576 -- A further optimization: if T_Typ is derived from S_Typ
1577 -- without imposing a constraint, no check is needed.
1579 if Nkind (Original_Node (Parent (T_Typ))) =
1580 N_Full_Type_Declaration
1581 then
1582 declare
1583 Type_Def : constant Node_Id :=
1584 Type_Definition (Original_Node (Parent (T_Typ)));
1585 begin
1586 if Nkind (Type_Def) = N_Derived_Type_Definition
1587 and then Is_Entity_Name (Subtype_Indication (Type_Def))
1588 and then Entity (Subtype_Indication (Type_Def)) = S_Typ
1589 then
1590 return;
1591 end if;
1592 end;
1593 end if;
1594 end if;
1596 -- Constraint may appear in full view of type
1598 if Ekind (T_Typ) = E_Private_Subtype
1599 and then Present (Full_View (T_Typ))
1600 then
1601 DconT :=
1602 First_Elmt (Discriminant_Constraint (Full_View (T_Typ)));
1603 else
1604 DconT :=
1605 First_Elmt (Discriminant_Constraint (T_Typ));
1606 end if;
1608 while Present (Discr) loop
1609 ItemS := Node (DconS);
1610 ItemT := Node (DconT);
1612 -- For a discriminated component type constrained by the
1613 -- current instance of an enclosing type, there is no
1614 -- applicable discriminant check.
1616 if Nkind (ItemT) = N_Attribute_Reference
1617 and then Is_Access_Type (Etype (ItemT))
1618 and then Is_Entity_Name (Prefix (ItemT))
1619 and then Is_Type (Entity (Prefix (ItemT)))
1620 then
1621 return;
1622 end if;
1624 -- If the expressions for the discriminants are identical
1625 -- and it is side-effect free (for now just an entity),
1626 -- this may be a shared constraint, e.g. from a subtype
1627 -- without a constraint introduced as a generic actual.
1628 -- Examine other discriminants if any.
1630 if ItemS = ItemT
1631 and then Is_Entity_Name (ItemS)
1632 then
1633 null;
1635 elsif not Is_OK_Static_Expression (ItemS)
1636 or else not Is_OK_Static_Expression (ItemT)
1637 then
1638 exit;
1640 elsif Expr_Value (ItemS) /= Expr_Value (ItemT) then
1641 if Do_Access then -- needs run-time check.
1642 exit;
1643 else
1644 Apply_Compile_Time_Constraint_Error
1645 (N, "incorrect value for discriminant&??",
1646 CE_Discriminant_Check_Failed, Ent => Discr);
1647 return;
1648 end if;
1649 end if;
1651 Next_Elmt (DconS);
1652 Next_Elmt (DconT);
1653 Next_Discriminant (Discr);
1654 end loop;
1656 if No (Discr) then
1657 return;
1658 end if;
1659 end;
1660 end if;
1662 -- Here we need a discriminant check. First build the expression
1663 -- for the comparisons of the discriminants:
1665 -- (n.disc1 /= typ.disc1) or else
1666 -- (n.disc2 /= typ.disc2) or else
1667 -- ...
1668 -- (n.discn /= typ.discn)
1670 Cond := Build_Discriminant_Checks (N, T_Typ);
1672 -- If Lhs is set and is a parameter, then the condition is guarded by:
1673 -- lhs'constrained and then (condition built above)
1675 if Present (Param_Entity (Lhs)) then
1676 Cond :=
1677 Make_And_Then (Loc,
1678 Left_Opnd =>
1679 Make_Attribute_Reference (Loc,
1680 Prefix => New_Occurrence_Of (Param_Entity (Lhs), Loc),
1681 Attribute_Name => Name_Constrained),
1682 Right_Opnd => Cond);
1683 end if;
1685 if Do_Access then
1686 Cond := Guard_Access (Cond, Loc, N);
1687 end if;
1689 Insert_Action (N,
1690 Make_Raise_Constraint_Error (Loc,
1691 Condition => Cond,
1692 Reason => CE_Discriminant_Check_Failed));
1693 end Apply_Discriminant_Check;
1695 -------------------------
1696 -- Apply_Divide_Checks --
1697 -------------------------
1699 procedure Apply_Divide_Checks (N : Node_Id) is
1700 Loc : constant Source_Ptr := Sloc (N);
1701 Typ : constant Entity_Id := Etype (N);
1702 Left : constant Node_Id := Left_Opnd (N);
1703 Right : constant Node_Id := Right_Opnd (N);
1705 Mode : constant Overflow_Mode_Type := Overflow_Check_Mode;
1706 -- Current overflow checking mode
1708 LLB : Uint;
1709 Llo : Uint;
1710 Lhi : Uint;
1711 LOK : Boolean;
1712 Rlo : Uint;
1713 Rhi : Uint;
1714 ROK : Boolean;
1716 pragma Warnings (Off, Lhi);
1717 -- Don't actually use this value
1719 begin
1720 -- If we are operating in MINIMIZED or ELIMINATED mode, and we are
1721 -- operating on signed integer types, then the only thing this routine
1722 -- does is to call Apply_Arithmetic_Overflow_Minimized_Eliminated. That
1723 -- procedure will (possibly later on during recursive downward calls),
1724 -- ensure that any needed overflow/division checks are properly applied.
1726 if Mode in Minimized_Or_Eliminated
1727 and then Is_Signed_Integer_Type (Typ)
1728 then
1729 Apply_Arithmetic_Overflow_Minimized_Eliminated (N);
1730 return;
1731 end if;
1733 -- Proceed here in SUPPRESSED or CHECKED modes
1735 if Full_Expander_Active
1736 and then not Backend_Divide_Checks_On_Target
1737 and then Check_Needed (Right, Division_Check)
1738 then
1739 Determine_Range (Right, ROK, Rlo, Rhi, Assume_Valid => True);
1741 -- Deal with division check
1743 if Do_Division_Check (N)
1744 and then not Division_Checks_Suppressed (Typ)
1745 then
1746 Apply_Division_Check (N, Rlo, Rhi, ROK);
1747 end if;
1749 -- Deal with overflow check
1751 if Do_Overflow_Check (N)
1752 and then not Overflow_Checks_Suppressed (Etype (N))
1753 then
1755 -- Test for extremely annoying case of xxx'First divided by -1
1756 -- for division of signed integer types (only overflow case).
1758 if Nkind (N) = N_Op_Divide
1759 and then Is_Signed_Integer_Type (Typ)
1760 then
1761 Determine_Range (Left, LOK, Llo, Lhi, Assume_Valid => True);
1762 LLB := Expr_Value (Type_Low_Bound (Base_Type (Typ)));
1764 if ((not ROK) or else (Rlo <= (-1) and then (-1) <= Rhi))
1765 and then
1766 ((not LOK) or else (Llo = LLB))
1767 then
1768 Insert_Action (N,
1769 Make_Raise_Constraint_Error (Loc,
1770 Condition =>
1771 Make_And_Then (Loc,
1772 Left_Opnd =>
1773 Make_Op_Eq (Loc,
1774 Left_Opnd =>
1775 Duplicate_Subexpr_Move_Checks (Left),
1776 Right_Opnd => Make_Integer_Literal (Loc, LLB)),
1778 Right_Opnd =>
1779 Make_Op_Eq (Loc,
1780 Left_Opnd => Duplicate_Subexpr (Right),
1781 Right_Opnd => Make_Integer_Literal (Loc, -1))),
1783 Reason => CE_Overflow_Check_Failed));
1784 end if;
1785 end if;
1786 end if;
1787 end if;
1788 end Apply_Divide_Checks;
1790 --------------------------
1791 -- Apply_Division_Check --
1792 --------------------------
1794 procedure Apply_Division_Check
1795 (N : Node_Id;
1796 Rlo : Uint;
1797 Rhi : Uint;
1798 ROK : Boolean)
1800 pragma Assert (Do_Division_Check (N));
1802 Loc : constant Source_Ptr := Sloc (N);
1803 Right : constant Node_Id := Right_Opnd (N);
1805 begin
1806 if Full_Expander_Active
1807 and then not Backend_Divide_Checks_On_Target
1808 and then Check_Needed (Right, Division_Check)
1809 then
1810 -- See if division by zero possible, and if so generate test. This
1811 -- part of the test is not controlled by the -gnato switch, since
1812 -- it is a Division_Check and not an Overflow_Check.
1814 if Do_Division_Check (N) then
1815 if (not ROK) or else (Rlo <= 0 and then 0 <= Rhi) then
1816 Insert_Action (N,
1817 Make_Raise_Constraint_Error (Loc,
1818 Condition =>
1819 Make_Op_Eq (Loc,
1820 Left_Opnd => Duplicate_Subexpr_Move_Checks (Right),
1821 Right_Opnd => Make_Integer_Literal (Loc, 0)),
1822 Reason => CE_Divide_By_Zero));
1823 end if;
1824 end if;
1825 end if;
1826 end Apply_Division_Check;
1828 ----------------------------------
1829 -- Apply_Float_Conversion_Check --
1830 ----------------------------------
1832 -- Let F and I be the source and target types of the conversion. The RM
1833 -- specifies that a floating-point value X is rounded to the nearest
1834 -- integer, with halfway cases being rounded away from zero. The rounded
1835 -- value of X is checked against I'Range.
1837 -- The catch in the above paragraph is that there is no good way to know
1838 -- whether the round-to-integer operation resulted in overflow. A remedy is
1839 -- to perform a range check in the floating-point domain instead, however:
1841 -- (1) The bounds may not be known at compile time
1842 -- (2) The check must take into account rounding or truncation.
1843 -- (3) The range of type I may not be exactly representable in F.
1844 -- (4) For the rounding case, The end-points I'First - 0.5 and
1845 -- I'Last + 0.5 may or may not be in range, depending on the
1846 -- sign of I'First and I'Last.
1847 -- (5) X may be a NaN, which will fail any comparison
1849 -- The following steps correctly convert X with rounding:
1851 -- (1) If either I'First or I'Last is not known at compile time, use
1852 -- I'Base instead of I in the next three steps and perform a
1853 -- regular range check against I'Range after conversion.
1854 -- (2) If I'First - 0.5 is representable in F then let Lo be that
1855 -- value and define Lo_OK as (I'First > 0). Otherwise, let Lo be
1856 -- F'Machine (I'First) and let Lo_OK be (Lo >= I'First).
1857 -- In other words, take one of the closest floating-point numbers
1858 -- (which is an integer value) to I'First, and see if it is in
1859 -- range or not.
1860 -- (3) If I'Last + 0.5 is representable in F then let Hi be that value
1861 -- and define Hi_OK as (I'Last < 0). Otherwise, let Hi be
1862 -- F'Machine (I'Last) and let Hi_OK be (Hi <= I'Last).
1863 -- (4) Raise CE when (Lo_OK and X < Lo) or (not Lo_OK and X <= Lo)
1864 -- or (Hi_OK and X > Hi) or (not Hi_OK and X >= Hi)
1866 -- For the truncating case, replace steps (2) and (3) as follows:
1867 -- (2) If I'First > 0, then let Lo be F'Pred (I'First) and let Lo_OK
1868 -- be False. Otherwise, let Lo be F'Succ (I'First - 1) and let
1869 -- Lo_OK be True.
1870 -- (3) If I'Last < 0, then let Hi be F'Succ (I'Last) and let Hi_OK
1871 -- be False. Otherwise let Hi be F'Pred (I'Last + 1) and let
1872 -- Hi_OK be True.
1874 procedure Apply_Float_Conversion_Check
1875 (Ck_Node : Node_Id;
1876 Target_Typ : Entity_Id)
1878 LB : constant Node_Id := Type_Low_Bound (Target_Typ);
1879 HB : constant Node_Id := Type_High_Bound (Target_Typ);
1880 Loc : constant Source_Ptr := Sloc (Ck_Node);
1881 Expr_Type : constant Entity_Id := Base_Type (Etype (Ck_Node));
1882 Target_Base : constant Entity_Id :=
1883 Implementation_Base_Type (Target_Typ);
1885 Par : constant Node_Id := Parent (Ck_Node);
1886 pragma Assert (Nkind (Par) = N_Type_Conversion);
1887 -- Parent of check node, must be a type conversion
1889 Truncate : constant Boolean := Float_Truncate (Par);
1890 Max_Bound : constant Uint :=
1891 UI_Expon
1892 (Machine_Radix_Value (Expr_Type),
1893 Machine_Mantissa_Value (Expr_Type) - 1) - 1;
1895 -- Largest bound, so bound plus or minus half is a machine number of F
1897 Ifirst, Ilast : Uint;
1898 -- Bounds of integer type
1900 Lo, Hi : Ureal;
1901 -- Bounds to check in floating-point domain
1903 Lo_OK, Hi_OK : Boolean;
1904 -- True iff Lo resp. Hi belongs to I'Range
1906 Lo_Chk, Hi_Chk : Node_Id;
1907 -- Expressions that are False iff check fails
1909 Reason : RT_Exception_Code;
1911 begin
1912 -- We do not need checks if we are not generating code (i.e. the full
1913 -- expander is not active). In SPARK mode, we specifically don't want
1914 -- the frontend to expand these checks, which are dealt with directly
1915 -- in the formal verification backend.
1917 if not Full_Expander_Active then
1918 return;
1919 end if;
1921 if not Compile_Time_Known_Value (LB)
1922 or not Compile_Time_Known_Value (HB)
1923 then
1924 declare
1925 -- First check that the value falls in the range of the base type,
1926 -- to prevent overflow during conversion and then perform a
1927 -- regular range check against the (dynamic) bounds.
1929 pragma Assert (Target_Base /= Target_Typ);
1931 Temp : constant Entity_Id := Make_Temporary (Loc, 'T', Par);
1933 begin
1934 Apply_Float_Conversion_Check (Ck_Node, Target_Base);
1935 Set_Etype (Temp, Target_Base);
1937 Insert_Action (Parent (Par),
1938 Make_Object_Declaration (Loc,
1939 Defining_Identifier => Temp,
1940 Object_Definition => New_Occurrence_Of (Target_Typ, Loc),
1941 Expression => New_Copy_Tree (Par)),
1942 Suppress => All_Checks);
1944 Insert_Action (Par,
1945 Make_Raise_Constraint_Error (Loc,
1946 Condition =>
1947 Make_Not_In (Loc,
1948 Left_Opnd => New_Occurrence_Of (Temp, Loc),
1949 Right_Opnd => New_Occurrence_Of (Target_Typ, Loc)),
1950 Reason => CE_Range_Check_Failed));
1951 Rewrite (Par, New_Occurrence_Of (Temp, Loc));
1953 return;
1954 end;
1955 end if;
1957 -- Get the (static) bounds of the target type
1959 Ifirst := Expr_Value (LB);
1960 Ilast := Expr_Value (HB);
1962 -- A simple optimization: if the expression is a universal literal,
1963 -- we can do the comparison with the bounds and the conversion to
1964 -- an integer type statically. The range checks are unchanged.
1966 if Nkind (Ck_Node) = N_Real_Literal
1967 and then Etype (Ck_Node) = Universal_Real
1968 and then Is_Integer_Type (Target_Typ)
1969 and then Nkind (Parent (Ck_Node)) = N_Type_Conversion
1970 then
1971 declare
1972 Int_Val : constant Uint := UR_To_Uint (Realval (Ck_Node));
1974 begin
1975 if Int_Val <= Ilast and then Int_Val >= Ifirst then
1977 -- Conversion is safe
1979 Rewrite (Parent (Ck_Node),
1980 Make_Integer_Literal (Loc, UI_To_Int (Int_Val)));
1981 Analyze_And_Resolve (Parent (Ck_Node), Target_Typ);
1982 return;
1983 end if;
1984 end;
1985 end if;
1987 -- Check against lower bound
1989 if Truncate and then Ifirst > 0 then
1990 Lo := Pred (Expr_Type, UR_From_Uint (Ifirst));
1991 Lo_OK := False;
1993 elsif Truncate then
1994 Lo := Succ (Expr_Type, UR_From_Uint (Ifirst - 1));
1995 Lo_OK := True;
1997 elsif abs (Ifirst) < Max_Bound then
1998 Lo := UR_From_Uint (Ifirst) - Ureal_Half;
1999 Lo_OK := (Ifirst > 0);
2001 else
2002 Lo := Machine (Expr_Type, UR_From_Uint (Ifirst), Round_Even, Ck_Node);
2003 Lo_OK := (Lo >= UR_From_Uint (Ifirst));
2004 end if;
2006 if Lo_OK then
2008 -- Lo_Chk := (X >= Lo)
2010 Lo_Chk := Make_Op_Ge (Loc,
2011 Left_Opnd => Duplicate_Subexpr_No_Checks (Ck_Node),
2012 Right_Opnd => Make_Real_Literal (Loc, Lo));
2014 else
2015 -- Lo_Chk := (X > Lo)
2017 Lo_Chk := Make_Op_Gt (Loc,
2018 Left_Opnd => Duplicate_Subexpr_No_Checks (Ck_Node),
2019 Right_Opnd => Make_Real_Literal (Loc, Lo));
2020 end if;
2022 -- Check against higher bound
2024 if Truncate and then Ilast < 0 then
2025 Hi := Succ (Expr_Type, UR_From_Uint (Ilast));
2026 Hi_OK := False;
2028 elsif Truncate then
2029 Hi := Pred (Expr_Type, UR_From_Uint (Ilast + 1));
2030 Hi_OK := True;
2032 elsif abs (Ilast) < Max_Bound then
2033 Hi := UR_From_Uint (Ilast) + Ureal_Half;
2034 Hi_OK := (Ilast < 0);
2035 else
2036 Hi := Machine (Expr_Type, UR_From_Uint (Ilast), Round_Even, Ck_Node);
2037 Hi_OK := (Hi <= UR_From_Uint (Ilast));
2038 end if;
2040 if Hi_OK then
2042 -- Hi_Chk := (X <= Hi)
2044 Hi_Chk := Make_Op_Le (Loc,
2045 Left_Opnd => Duplicate_Subexpr_No_Checks (Ck_Node),
2046 Right_Opnd => Make_Real_Literal (Loc, Hi));
2048 else
2049 -- Hi_Chk := (X < Hi)
2051 Hi_Chk := Make_Op_Lt (Loc,
2052 Left_Opnd => Duplicate_Subexpr_No_Checks (Ck_Node),
2053 Right_Opnd => Make_Real_Literal (Loc, Hi));
2054 end if;
2056 -- If the bounds of the target type are the same as those of the base
2057 -- type, the check is an overflow check as a range check is not
2058 -- performed in these cases.
2060 if Expr_Value (Type_Low_Bound (Target_Base)) = Ifirst
2061 and then Expr_Value (Type_High_Bound (Target_Base)) = Ilast
2062 then
2063 Reason := CE_Overflow_Check_Failed;
2064 else
2065 Reason := CE_Range_Check_Failed;
2066 end if;
2068 -- Raise CE if either conditions does not hold
2070 Insert_Action (Ck_Node,
2071 Make_Raise_Constraint_Error (Loc,
2072 Condition => Make_Op_Not (Loc, Make_And_Then (Loc, Lo_Chk, Hi_Chk)),
2073 Reason => Reason));
2074 end Apply_Float_Conversion_Check;
2076 ------------------------
2077 -- Apply_Length_Check --
2078 ------------------------
2080 procedure Apply_Length_Check
2081 (Ck_Node : Node_Id;
2082 Target_Typ : Entity_Id;
2083 Source_Typ : Entity_Id := Empty)
2085 begin
2086 Apply_Selected_Length_Checks
2087 (Ck_Node, Target_Typ, Source_Typ, Do_Static => False);
2088 end Apply_Length_Check;
2090 -------------------------------------
2091 -- Apply_Parameter_Aliasing_Checks --
2092 -------------------------------------
2094 procedure Apply_Parameter_Aliasing_Checks
2095 (Call : Node_Id;
2096 Subp : Entity_Id)
2098 Loc : constant Source_Ptr := Sloc (Call);
2100 function May_Cause_Aliasing
2101 (Formal_1 : Entity_Id;
2102 Formal_2 : Entity_Id) return Boolean;
2103 -- Determine whether two formal parameters can alias each other
2104 -- depending on their modes.
2106 function Original_Actual (N : Node_Id) return Node_Id;
2107 -- The expander may replace an actual with a temporary for the sake of
2108 -- side effect removal. The temporary may hide a potential aliasing as
2109 -- it does not share the address of the actual. This routine attempts
2110 -- to retrieve the original actual.
2112 procedure Overlap_Check
2113 (Actual_1 : Node_Id;
2114 Actual_2 : Node_Id;
2115 Formal_1 : Entity_Id;
2116 Formal_2 : Entity_Id;
2117 Check : in out Node_Id);
2118 -- Create a check to determine whether Actual_1 overlaps with Actual_2.
2119 -- If detailed exception messages are enabled, the check is augmented to
2120 -- provide information about the names of the corresponding formals. See
2121 -- the body for details. Actual_1 and Actual_2 denote the two actuals to
2122 -- be tested. Formal_1 and Formal_2 denote the corresponding formals.
2123 -- Check contains all and-ed simple tests generated so far or remains
2124 -- unchanged in the case of detailed exception messaged.
2126 ------------------------
2127 -- May_Cause_Aliasing --
2128 ------------------------
2130 function May_Cause_Aliasing
2131 (Formal_1 : Entity_Id;
2132 Formal_2 : Entity_Id) return Boolean
2134 begin
2135 -- The following combination cannot lead to aliasing
2137 -- Formal 1 Formal 2
2138 -- IN IN
2140 if Ekind (Formal_1) = E_In_Parameter
2141 and then
2142 Ekind (Formal_2) = E_In_Parameter
2143 then
2144 return False;
2146 -- The following combinations may lead to aliasing
2148 -- Formal 1 Formal 2
2149 -- IN OUT
2150 -- IN IN OUT
2151 -- OUT IN
2152 -- OUT IN OUT
2153 -- OUT OUT
2155 else
2156 return True;
2157 end if;
2158 end May_Cause_Aliasing;
2160 ---------------------
2161 -- Original_Actual --
2162 ---------------------
2164 function Original_Actual (N : Node_Id) return Node_Id is
2165 begin
2166 if Nkind (N) = N_Type_Conversion then
2167 return Expression (N);
2169 -- The expander created a temporary to capture the result of a type
2170 -- conversion where the expression is the real actual.
2172 elsif Nkind (N) = N_Identifier
2173 and then Present (Original_Node (N))
2174 and then Nkind (Original_Node (N)) = N_Type_Conversion
2175 then
2176 return Expression (Original_Node (N));
2177 end if;
2179 return N;
2180 end Original_Actual;
2182 -------------------
2183 -- Overlap_Check --
2184 -------------------
2186 procedure Overlap_Check
2187 (Actual_1 : Node_Id;
2188 Actual_2 : Node_Id;
2189 Formal_1 : Entity_Id;
2190 Formal_2 : Entity_Id;
2191 Check : in out Node_Id)
2193 Cond : Node_Id;
2194 ID_Casing : constant Casing_Type :=
2195 Identifier_Casing (Source_Index (Current_Sem_Unit));
2197 begin
2198 -- Generate:
2199 -- Actual_1'Overlaps_Storage (Actual_2)
2201 Cond :=
2202 Make_Attribute_Reference (Loc,
2203 Prefix => New_Copy_Tree (Original_Actual (Actual_1)),
2204 Attribute_Name => Name_Overlaps_Storage,
2205 Expressions =>
2206 New_List (New_Copy_Tree (Original_Actual (Actual_2))));
2208 -- Generate the following check when detailed exception messages are
2209 -- enabled:
2211 -- if Actual_1'Overlaps_Storage (Actual_2) then
2212 -- raise Program_Error with <detailed message>;
2213 -- end if;
2215 if Exception_Extra_Info then
2216 Start_String;
2218 -- Do not generate location information for internal calls
2220 if Comes_From_Source (Call) then
2221 Store_String_Chars (Build_Location_String (Loc));
2222 Store_String_Char (' ');
2223 end if;
2225 Store_String_Chars ("aliased parameters, actuals for """);
2227 Get_Name_String (Chars (Formal_1));
2228 Set_Casing (ID_Casing);
2229 Store_String_Chars (Name_Buffer (1 .. Name_Len));
2231 Store_String_Chars (""" and """);
2233 Get_Name_String (Chars (Formal_2));
2234 Set_Casing (ID_Casing);
2235 Store_String_Chars (Name_Buffer (1 .. Name_Len));
2237 Store_String_Chars (""" overlap");
2239 Insert_Action (Call,
2240 Make_If_Statement (Loc,
2241 Condition => Cond,
2242 Then_Statements => New_List (
2243 Make_Raise_Statement (Loc,
2244 Name =>
2245 New_Reference_To (Standard_Program_Error, Loc),
2246 Expression => Make_String_Literal (Loc, End_String)))));
2248 -- Create a sequence of overlapping checks by and-ing them all
2249 -- together.
2251 else
2252 if No (Check) then
2253 Check := Cond;
2254 else
2255 Check :=
2256 Make_And_Then (Loc,
2257 Left_Opnd => Check,
2258 Right_Opnd => Cond);
2259 end if;
2260 end if;
2261 end Overlap_Check;
2263 -- Local variables
2265 Actual_1 : Node_Id;
2266 Actual_2 : Node_Id;
2267 Check : Node_Id;
2268 Formal_1 : Entity_Id;
2269 Formal_2 : Entity_Id;
2271 -- Start of processing for Apply_Parameter_Aliasing_Checks
2273 begin
2274 Check := Empty;
2276 Actual_1 := First_Actual (Call);
2277 Formal_1 := First_Formal (Subp);
2278 while Present (Actual_1) and then Present (Formal_1) loop
2280 -- Ensure that the actual is an object that is not passed by value.
2281 -- Elementary types are always passed by value, therefore actuals of
2282 -- such types cannot lead to aliasing.
2284 if Is_Object_Reference (Original_Actual (Actual_1))
2285 and then not Is_Elementary_Type (Etype (Original_Actual (Actual_1)))
2286 then
2287 Actual_2 := Next_Actual (Actual_1);
2288 Formal_2 := Next_Formal (Formal_1);
2289 while Present (Actual_2) and then Present (Formal_2) loop
2291 -- The other actual we are testing against must also denote
2292 -- a non pass-by-value object. Generate the check only when
2293 -- the mode of the two formals may lead to aliasing.
2295 if Is_Object_Reference (Original_Actual (Actual_2))
2296 and then not
2297 Is_Elementary_Type (Etype (Original_Actual (Actual_2)))
2298 and then May_Cause_Aliasing (Formal_1, Formal_2)
2299 then
2300 Overlap_Check
2301 (Actual_1 => Actual_1,
2302 Actual_2 => Actual_2,
2303 Formal_1 => Formal_1,
2304 Formal_2 => Formal_2,
2305 Check => Check);
2306 end if;
2308 Next_Actual (Actual_2);
2309 Next_Formal (Formal_2);
2310 end loop;
2311 end if;
2313 Next_Actual (Actual_1);
2314 Next_Formal (Formal_1);
2315 end loop;
2317 -- Place a simple check right before the call
2319 if Present (Check) and then not Exception_Extra_Info then
2320 Insert_Action (Call,
2321 Make_Raise_Program_Error (Loc,
2322 Condition => Check,
2323 Reason => PE_Aliased_Parameters));
2324 end if;
2325 end Apply_Parameter_Aliasing_Checks;
2327 -------------------------------------
2328 -- Apply_Parameter_Validity_Checks --
2329 -------------------------------------
2331 procedure Apply_Parameter_Validity_Checks (Subp : Entity_Id) is
2332 Subp_Decl : Node_Id;
2334 procedure Add_Validity_Check
2335 (Context : Entity_Id;
2336 PPC_Nam : Name_Id;
2337 For_Result : Boolean := False);
2338 -- Add a single 'Valid[_Scalar] check which verifies the initialization
2339 -- of Context. PPC_Nam denotes the pre or post condition pragma name.
2340 -- Set flag For_Result when to verify the result of a function.
2342 procedure Build_PPC_Pragma (PPC_Nam : Name_Id; Check : Node_Id);
2343 -- Create a pre or post condition pragma with name PPC_Nam which
2344 -- tests expression Check.
2346 ------------------------
2347 -- Add_Validity_Check --
2348 ------------------------
2350 procedure Add_Validity_Check
2351 (Context : Entity_Id;
2352 PPC_Nam : Name_Id;
2353 For_Result : Boolean := False)
2355 Loc : constant Source_Ptr := Sloc (Subp);
2356 Typ : constant Entity_Id := Etype (Context);
2357 Check : Node_Id;
2358 Nam : Name_Id;
2360 begin
2361 -- Pick the proper version of 'Valid depending on the type of the
2362 -- context. If the context is not eligible for such a check, return.
2364 if Is_Scalar_Type (Typ) then
2365 Nam := Name_Valid;
2366 elsif not No_Scalar_Parts (Typ) then
2367 Nam := Name_Valid_Scalars;
2368 else
2369 return;
2370 end if;
2372 -- Step 1: Create the expression to verify the validity of the
2373 -- context.
2375 Check := New_Reference_To (Context, Loc);
2377 -- When processing a function result, use 'Result. Generate
2378 -- Context'Result
2380 if For_Result then
2381 Check :=
2382 Make_Attribute_Reference (Loc,
2383 Prefix => Check,
2384 Attribute_Name => Name_Result);
2385 end if;
2387 -- Generate:
2388 -- Context['Result]'Valid[_Scalars]
2390 Check :=
2391 Make_Attribute_Reference (Loc,
2392 Prefix => Check,
2393 Attribute_Name => Nam);
2395 -- Step 2: Create a pre or post condition pragma
2397 Build_PPC_Pragma (PPC_Nam, Check);
2398 end Add_Validity_Check;
2400 ----------------------
2401 -- Build_PPC_Pragma --
2402 ----------------------
2404 procedure Build_PPC_Pragma (PPC_Nam : Name_Id; Check : Node_Id) is
2405 Loc : constant Source_Ptr := Sloc (Subp);
2406 Decls : List_Id;
2407 Prag : Node_Id;
2409 begin
2410 Prag :=
2411 Make_Pragma (Loc,
2412 Pragma_Identifier => Make_Identifier (Loc, PPC_Nam),
2413 Pragma_Argument_Associations => New_List (
2414 Make_Pragma_Argument_Association (Loc,
2415 Chars => Name_Check,
2416 Expression => Check)));
2418 -- Add a message unless exception messages are suppressed
2420 if not Exception_Locations_Suppressed then
2421 Append_To (Pragma_Argument_Associations (Prag),
2422 Make_Pragma_Argument_Association (Loc,
2423 Chars => Name_Message,
2424 Expression =>
2425 Make_String_Literal (Loc,
2426 Strval => "failed " & Get_Name_String (PPC_Nam) &
2427 " from " & Build_Location_String (Loc))));
2428 end if;
2430 -- Insert the pragma in the tree
2432 if Nkind (Parent (Subp_Decl)) = N_Compilation_Unit then
2433 Add_Global_Declaration (Prag);
2434 Analyze (Prag);
2436 -- PPC pragmas associated with subprogram bodies must be inserted in
2437 -- the declarative part of the body.
2439 elsif Nkind (Subp_Decl) = N_Subprogram_Body then
2440 Decls := Declarations (Subp_Decl);
2442 if No (Decls) then
2443 Decls := New_List;
2444 Set_Declarations (Subp_Decl, Decls);
2445 end if;
2447 Prepend_To (Decls, Prag);
2449 -- Ensure the proper visibility of the subprogram body and its
2450 -- parameters.
2452 Push_Scope (Subp);
2453 Analyze (Prag);
2454 Pop_Scope;
2456 -- For subprogram declarations insert the PPC pragma right after the
2457 -- declarative node.
2459 else
2460 Insert_After_And_Analyze (Subp_Decl, Prag);
2461 end if;
2462 end Build_PPC_Pragma;
2464 -- Local variables
2466 Formal : Entity_Id;
2467 Subp_Spec : Node_Id;
2469 -- Start of processing for Apply_Parameter_Validity_Checks
2471 begin
2472 -- Extract the subprogram specification and declaration nodes
2474 Subp_Spec := Parent (Subp);
2476 if Nkind (Subp_Spec) = N_Defining_Program_Unit_Name then
2477 Subp_Spec := Parent (Subp_Spec);
2478 end if;
2480 Subp_Decl := Parent (Subp_Spec);
2482 if not Comes_From_Source (Subp)
2484 -- Do not process formal subprograms because the corresponding actual
2485 -- will receive the proper checks when the instance is analyzed.
2487 or else Is_Formal_Subprogram (Subp)
2489 -- Do not process imported subprograms since pre and post conditions
2490 -- are never verified on routines coming from a different language.
2492 or else Is_Imported (Subp)
2493 or else Is_Intrinsic_Subprogram (Subp)
2495 -- The PPC pragmas generated by this routine do not correspond to
2496 -- source aspects, therefore they cannot be applied to abstract
2497 -- subprograms.
2499 or else Nkind (Subp_Decl) = N_Abstract_Subprogram_Declaration
2501 -- Do not consider subprogram renaminds because the renamed entity
2502 -- already has the proper PPC pragmas.
2504 or else Nkind (Subp_Decl) = N_Subprogram_Renaming_Declaration
2506 -- Do not process null procedures because there is no benefit of
2507 -- adding the checks to a no action routine.
2509 or else (Nkind (Subp_Spec) = N_Procedure_Specification
2510 and then Null_Present (Subp_Spec))
2511 then
2512 return;
2513 end if;
2515 -- Inspect all the formals applying aliasing and scalar initialization
2516 -- checks where applicable.
2518 Formal := First_Formal (Subp);
2519 while Present (Formal) loop
2521 -- Generate the following scalar initialization checks for each
2522 -- formal parameter:
2524 -- mode IN - Pre => Formal'Valid[_Scalars]
2525 -- mode IN OUT - Pre, Post => Formal'Valid[_Scalars]
2526 -- mode OUT - Post => Formal'Valid[_Scalars]
2528 if Check_Validity_Of_Parameters then
2529 if Ekind_In (Formal, E_In_Parameter, E_In_Out_Parameter) then
2530 Add_Validity_Check (Formal, Name_Precondition, False);
2531 end if;
2533 if Ekind_In (Formal, E_In_Out_Parameter, E_Out_Parameter) then
2534 Add_Validity_Check (Formal, Name_Postcondition, False);
2535 end if;
2536 end if;
2538 Next_Formal (Formal);
2539 end loop;
2541 -- Generate following scalar initialization check for function result:
2543 -- Post => Subp'Result'Valid[_Scalars]
2545 if Check_Validity_Of_Parameters and then Ekind (Subp) = E_Function then
2546 Add_Validity_Check (Subp, Name_Postcondition, True);
2547 end if;
2548 end Apply_Parameter_Validity_Checks;
2550 ---------------------------
2551 -- Apply_Predicate_Check --
2552 ---------------------------
2554 procedure Apply_Predicate_Check (N : Node_Id; Typ : Entity_Id) is
2555 S : Entity_Id;
2557 begin
2558 if Present (Predicate_Function (Typ)) then
2560 -- A predicate check does not apply within internally generated
2561 -- subprograms, such as TSS functions.
2563 S := Current_Scope;
2564 while Present (S) and then not Is_Subprogram (S) loop
2565 S := Scope (S);
2566 end loop;
2568 if Present (S) and then Get_TSS_Name (S) /= TSS_Null then
2569 return;
2571 -- If the check appears within the predicate function itself, it
2572 -- means that the user specified a check whose formal is the
2573 -- predicated subtype itself, rather than some covering type. This
2574 -- is likely to be a common error, and thus deserves a warning.
2576 elsif S = Predicate_Function (Typ) then
2577 Error_Msg_N
2578 ("predicate check includes a function call that "
2579 & "requires a predicate check??", Parent (N));
2580 Error_Msg_N
2581 ("\this will result in infinite recursion??", Parent (N));
2582 Insert_Action (N,
2583 Make_Raise_Storage_Error (Sloc (N),
2584 Reason => SE_Infinite_Recursion));
2586 -- Here for normal case of predicate active
2588 else
2589 -- If the type has a static predicate and the expression is known
2590 -- at compile time, see if the expression satisfies the predicate.
2592 Check_Expression_Against_Static_Predicate (N, Typ);
2594 Insert_Action (N,
2595 Make_Predicate_Check (Typ, Duplicate_Subexpr (N)));
2596 end if;
2597 end if;
2598 end Apply_Predicate_Check;
2600 -----------------------
2601 -- Apply_Range_Check --
2602 -----------------------
2604 procedure Apply_Range_Check
2605 (Ck_Node : Node_Id;
2606 Target_Typ : Entity_Id;
2607 Source_Typ : Entity_Id := Empty)
2609 begin
2610 Apply_Selected_Range_Checks
2611 (Ck_Node, Target_Typ, Source_Typ, Do_Static => False);
2612 end Apply_Range_Check;
2614 ------------------------------
2615 -- Apply_Scalar_Range_Check --
2616 ------------------------------
2618 -- Note that Apply_Scalar_Range_Check never turns the Do_Range_Check flag
2619 -- off if it is already set on.
2621 procedure Apply_Scalar_Range_Check
2622 (Expr : Node_Id;
2623 Target_Typ : Entity_Id;
2624 Source_Typ : Entity_Id := Empty;
2625 Fixed_Int : Boolean := False)
2627 Parnt : constant Node_Id := Parent (Expr);
2628 S_Typ : Entity_Id;
2629 Arr : Node_Id := Empty; -- initialize to prevent warning
2630 Arr_Typ : Entity_Id := Empty; -- initialize to prevent warning
2631 OK : Boolean;
2633 Is_Subscr_Ref : Boolean;
2634 -- Set true if Expr is a subscript
2636 Is_Unconstrained_Subscr_Ref : Boolean;
2637 -- Set true if Expr is a subscript of an unconstrained array. In this
2638 -- case we do not attempt to do an analysis of the value against the
2639 -- range of the subscript, since we don't know the actual subtype.
2641 Int_Real : Boolean;
2642 -- Set to True if Expr should be regarded as a real value even though
2643 -- the type of Expr might be discrete.
2645 procedure Bad_Value;
2646 -- Procedure called if value is determined to be out of range
2648 ---------------
2649 -- Bad_Value --
2650 ---------------
2652 procedure Bad_Value is
2653 begin
2654 Apply_Compile_Time_Constraint_Error
2655 (Expr, "value not in range of}??", CE_Range_Check_Failed,
2656 Ent => Target_Typ,
2657 Typ => Target_Typ);
2658 end Bad_Value;
2660 -- Start of processing for Apply_Scalar_Range_Check
2662 begin
2663 -- Return if check obviously not needed
2666 -- Not needed inside generic
2668 Inside_A_Generic
2670 -- Not needed if previous error
2672 or else Target_Typ = Any_Type
2673 or else Nkind (Expr) = N_Error
2675 -- Not needed for non-scalar type
2677 or else not Is_Scalar_Type (Target_Typ)
2679 -- Not needed if we know node raises CE already
2681 or else Raises_Constraint_Error (Expr)
2682 then
2683 return;
2684 end if;
2686 -- Now, see if checks are suppressed
2688 Is_Subscr_Ref :=
2689 Is_List_Member (Expr) and then Nkind (Parnt) = N_Indexed_Component;
2691 if Is_Subscr_Ref then
2692 Arr := Prefix (Parnt);
2693 Arr_Typ := Get_Actual_Subtype_If_Available (Arr);
2695 if Is_Access_Type (Arr_Typ) then
2696 Arr_Typ := Designated_Type (Arr_Typ);
2697 end if;
2698 end if;
2700 if not Do_Range_Check (Expr) then
2702 -- Subscript reference. Check for Index_Checks suppressed
2704 if Is_Subscr_Ref then
2706 -- Check array type and its base type
2708 if Index_Checks_Suppressed (Arr_Typ)
2709 or else Index_Checks_Suppressed (Base_Type (Arr_Typ))
2710 then
2711 return;
2713 -- Check array itself if it is an entity name
2715 elsif Is_Entity_Name (Arr)
2716 and then Index_Checks_Suppressed (Entity (Arr))
2717 then
2718 return;
2720 -- Check expression itself if it is an entity name
2722 elsif Is_Entity_Name (Expr)
2723 and then Index_Checks_Suppressed (Entity (Expr))
2724 then
2725 return;
2726 end if;
2728 -- All other cases, check for Range_Checks suppressed
2730 else
2731 -- Check target type and its base type
2733 if Range_Checks_Suppressed (Target_Typ)
2734 or else Range_Checks_Suppressed (Base_Type (Target_Typ))
2735 then
2736 return;
2738 -- Check expression itself if it is an entity name
2740 elsif Is_Entity_Name (Expr)
2741 and then Range_Checks_Suppressed (Entity (Expr))
2742 then
2743 return;
2745 -- If Expr is part of an assignment statement, then check left
2746 -- side of assignment if it is an entity name.
2748 elsif Nkind (Parnt) = N_Assignment_Statement
2749 and then Is_Entity_Name (Name (Parnt))
2750 and then Range_Checks_Suppressed (Entity (Name (Parnt)))
2751 then
2752 return;
2753 end if;
2754 end if;
2755 end if;
2757 -- Do not set range checks if they are killed
2759 if Nkind (Expr) = N_Unchecked_Type_Conversion
2760 and then Kill_Range_Check (Expr)
2761 then
2762 return;
2763 end if;
2765 -- Do not set range checks for any values from System.Scalar_Values
2766 -- since the whole idea of such values is to avoid checking them!
2768 if Is_Entity_Name (Expr)
2769 and then Is_RTU (Scope (Entity (Expr)), System_Scalar_Values)
2770 then
2771 return;
2772 end if;
2774 -- Now see if we need a check
2776 if No (Source_Typ) then
2777 S_Typ := Etype (Expr);
2778 else
2779 S_Typ := Source_Typ;
2780 end if;
2782 if not Is_Scalar_Type (S_Typ) or else S_Typ = Any_Type then
2783 return;
2784 end if;
2786 Is_Unconstrained_Subscr_Ref :=
2787 Is_Subscr_Ref and then not Is_Constrained (Arr_Typ);
2789 -- Special checks for floating-point type
2791 if Is_Floating_Point_Type (S_Typ) then
2793 -- Always do a range check if the source type includes infinities and
2794 -- the target type does not include infinities. We do not do this if
2795 -- range checks are killed.
2797 if Has_Infinities (S_Typ)
2798 and then not Has_Infinities (Target_Typ)
2799 then
2800 Enable_Range_Check (Expr);
2802 -- Always do a range check for operators if option set
2804 elsif Check_Float_Overflow and then Nkind (Expr) in N_Op then
2805 Enable_Range_Check (Expr);
2806 end if;
2807 end if;
2809 -- Return if we know expression is definitely in the range of the target
2810 -- type as determined by Determine_Range. Right now we only do this for
2811 -- discrete types, and not fixed-point or floating-point types.
2813 -- The additional less-precise tests below catch these cases
2815 -- Note: skip this if we are given a source_typ, since the point of
2816 -- supplying a Source_Typ is to stop us looking at the expression.
2817 -- We could sharpen this test to be out parameters only ???
2819 if Is_Discrete_Type (Target_Typ)
2820 and then Is_Discrete_Type (Etype (Expr))
2821 and then not Is_Unconstrained_Subscr_Ref
2822 and then No (Source_Typ)
2823 then
2824 declare
2825 Tlo : constant Node_Id := Type_Low_Bound (Target_Typ);
2826 Thi : constant Node_Id := Type_High_Bound (Target_Typ);
2827 Lo : Uint;
2828 Hi : Uint;
2830 begin
2831 if Compile_Time_Known_Value (Tlo)
2832 and then Compile_Time_Known_Value (Thi)
2833 then
2834 declare
2835 Lov : constant Uint := Expr_Value (Tlo);
2836 Hiv : constant Uint := Expr_Value (Thi);
2838 begin
2839 -- If range is null, we for sure have a constraint error
2840 -- (we don't even need to look at the value involved,
2841 -- since all possible values will raise CE).
2843 if Lov > Hiv then
2844 Bad_Value;
2845 return;
2846 end if;
2848 -- Otherwise determine range of value
2850 Determine_Range (Expr, OK, Lo, Hi, Assume_Valid => True);
2852 if OK then
2854 -- If definitely in range, all OK
2856 if Lo >= Lov and then Hi <= Hiv then
2857 return;
2859 -- If definitely not in range, warn
2861 elsif Lov > Hi or else Hiv < Lo then
2862 Bad_Value;
2863 return;
2865 -- Otherwise we don't know
2867 else
2868 null;
2869 end if;
2870 end if;
2871 end;
2872 end if;
2873 end;
2874 end if;
2876 Int_Real :=
2877 Is_Floating_Point_Type (S_Typ)
2878 or else (Is_Fixed_Point_Type (S_Typ) and then not Fixed_Int);
2880 -- Check if we can determine at compile time whether Expr is in the
2881 -- range of the target type. Note that if S_Typ is within the bounds
2882 -- of Target_Typ then this must be the case. This check is meaningful
2883 -- only if this is not a conversion between integer and real types.
2885 if not Is_Unconstrained_Subscr_Ref
2886 and then Is_Discrete_Type (S_Typ) = Is_Discrete_Type (Target_Typ)
2887 and then
2888 (In_Subrange_Of (S_Typ, Target_Typ, Fixed_Int)
2889 or else
2890 Is_In_Range (Expr, Target_Typ,
2891 Assume_Valid => True,
2892 Fixed_Int => Fixed_Int,
2893 Int_Real => Int_Real))
2894 then
2895 return;
2897 elsif Is_Out_Of_Range (Expr, Target_Typ,
2898 Assume_Valid => True,
2899 Fixed_Int => Fixed_Int,
2900 Int_Real => Int_Real)
2901 then
2902 Bad_Value;
2903 return;
2905 -- Floating-point case
2906 -- In the floating-point case, we only do range checks if the type is
2907 -- constrained. We definitely do NOT want range checks for unconstrained
2908 -- types, since we want to have infinities
2910 elsif Is_Floating_Point_Type (S_Typ) then
2912 -- Normally, we only do range checks if the type is constrained. We do
2913 -- NOT want range checks for unconstrained types, since we want to have
2914 -- infinities. Override this decision in Check_Float_Overflow mode.
2916 if Is_Constrained (S_Typ) or else Check_Float_Overflow then
2917 Enable_Range_Check (Expr);
2918 end if;
2920 -- For all other cases we enable a range check unconditionally
2922 else
2923 Enable_Range_Check (Expr);
2924 return;
2925 end if;
2926 end Apply_Scalar_Range_Check;
2928 ----------------------------------
2929 -- Apply_Selected_Length_Checks --
2930 ----------------------------------
2932 procedure Apply_Selected_Length_Checks
2933 (Ck_Node : Node_Id;
2934 Target_Typ : Entity_Id;
2935 Source_Typ : Entity_Id;
2936 Do_Static : Boolean)
2938 Cond : Node_Id;
2939 R_Result : Check_Result;
2940 R_Cno : Node_Id;
2942 Loc : constant Source_Ptr := Sloc (Ck_Node);
2943 Checks_On : constant Boolean :=
2944 (not Index_Checks_Suppressed (Target_Typ))
2945 or else (not Length_Checks_Suppressed (Target_Typ));
2947 begin
2948 if not Full_Expander_Active then
2949 return;
2950 end if;
2952 R_Result :=
2953 Selected_Length_Checks (Ck_Node, Target_Typ, Source_Typ, Empty);
2955 for J in 1 .. 2 loop
2956 R_Cno := R_Result (J);
2957 exit when No (R_Cno);
2959 -- A length check may mention an Itype which is attached to a
2960 -- subsequent node. At the top level in a package this can cause
2961 -- an order-of-elaboration problem, so we make sure that the itype
2962 -- is referenced now.
2964 if Ekind (Current_Scope) = E_Package
2965 and then Is_Compilation_Unit (Current_Scope)
2966 then
2967 Ensure_Defined (Target_Typ, Ck_Node);
2969 if Present (Source_Typ) then
2970 Ensure_Defined (Source_Typ, Ck_Node);
2972 elsif Is_Itype (Etype (Ck_Node)) then
2973 Ensure_Defined (Etype (Ck_Node), Ck_Node);
2974 end if;
2975 end if;
2977 -- If the item is a conditional raise of constraint error, then have
2978 -- a look at what check is being performed and ???
2980 if Nkind (R_Cno) = N_Raise_Constraint_Error
2981 and then Present (Condition (R_Cno))
2982 then
2983 Cond := Condition (R_Cno);
2985 -- Case where node does not now have a dynamic check
2987 if not Has_Dynamic_Length_Check (Ck_Node) then
2989 -- If checks are on, just insert the check
2991 if Checks_On then
2992 Insert_Action (Ck_Node, R_Cno);
2994 if not Do_Static then
2995 Set_Has_Dynamic_Length_Check (Ck_Node);
2996 end if;
2998 -- If checks are off, then analyze the length check after
2999 -- temporarily attaching it to the tree in case the relevant
3000 -- condition can be evaluated at compile time. We still want a
3001 -- compile time warning in this case.
3003 else
3004 Set_Parent (R_Cno, Ck_Node);
3005 Analyze (R_Cno);
3006 end if;
3007 end if;
3009 -- Output a warning if the condition is known to be True
3011 if Is_Entity_Name (Cond)
3012 and then Entity (Cond) = Standard_True
3013 then
3014 Apply_Compile_Time_Constraint_Error
3015 (Ck_Node, "wrong length for array of}??",
3016 CE_Length_Check_Failed,
3017 Ent => Target_Typ,
3018 Typ => Target_Typ);
3020 -- If we were only doing a static check, or if checks are not
3021 -- on, then we want to delete the check, since it is not needed.
3022 -- We do this by replacing the if statement by a null statement
3024 elsif Do_Static or else not Checks_On then
3025 Remove_Warning_Messages (R_Cno);
3026 Rewrite (R_Cno, Make_Null_Statement (Loc));
3027 end if;
3029 else
3030 Install_Static_Check (R_Cno, Loc);
3031 end if;
3032 end loop;
3033 end Apply_Selected_Length_Checks;
3035 ---------------------------------
3036 -- Apply_Selected_Range_Checks --
3037 ---------------------------------
3039 procedure Apply_Selected_Range_Checks
3040 (Ck_Node : Node_Id;
3041 Target_Typ : Entity_Id;
3042 Source_Typ : Entity_Id;
3043 Do_Static : Boolean)
3045 Cond : Node_Id;
3046 R_Result : Check_Result;
3047 R_Cno : Node_Id;
3049 Loc : constant Source_Ptr := Sloc (Ck_Node);
3050 Checks_On : constant Boolean :=
3051 (not Index_Checks_Suppressed (Target_Typ))
3052 or else (not Range_Checks_Suppressed (Target_Typ));
3054 begin
3055 if not Full_Expander_Active or else not Checks_On then
3056 return;
3057 end if;
3059 R_Result :=
3060 Selected_Range_Checks (Ck_Node, Target_Typ, Source_Typ, Empty);
3062 for J in 1 .. 2 loop
3064 R_Cno := R_Result (J);
3065 exit when No (R_Cno);
3067 -- If the item is a conditional raise of constraint error, then have
3068 -- a look at what check is being performed and ???
3070 if Nkind (R_Cno) = N_Raise_Constraint_Error
3071 and then Present (Condition (R_Cno))
3072 then
3073 Cond := Condition (R_Cno);
3075 if not Has_Dynamic_Range_Check (Ck_Node) then
3076 Insert_Action (Ck_Node, R_Cno);
3078 if not Do_Static then
3079 Set_Has_Dynamic_Range_Check (Ck_Node);
3080 end if;
3081 end if;
3083 -- Output a warning if the condition is known to be True
3085 if Is_Entity_Name (Cond)
3086 and then Entity (Cond) = Standard_True
3087 then
3088 -- Since an N_Range is technically not an expression, we have
3089 -- to set one of the bounds to C_E and then just flag the
3090 -- N_Range. The warning message will point to the lower bound
3091 -- and complain about a range, which seems OK.
3093 if Nkind (Ck_Node) = N_Range then
3094 Apply_Compile_Time_Constraint_Error
3095 (Low_Bound (Ck_Node), "static range out of bounds of}??",
3096 CE_Range_Check_Failed,
3097 Ent => Target_Typ,
3098 Typ => Target_Typ);
3100 Set_Raises_Constraint_Error (Ck_Node);
3102 else
3103 Apply_Compile_Time_Constraint_Error
3104 (Ck_Node, "static value out of range of}?",
3105 CE_Range_Check_Failed,
3106 Ent => Target_Typ,
3107 Typ => Target_Typ);
3108 end if;
3110 -- If we were only doing a static check, or if checks are not
3111 -- on, then we want to delete the check, since it is not needed.
3112 -- We do this by replacing the if statement by a null statement
3114 elsif Do_Static or else not Checks_On then
3115 Remove_Warning_Messages (R_Cno);
3116 Rewrite (R_Cno, Make_Null_Statement (Loc));
3117 end if;
3119 else
3120 Install_Static_Check (R_Cno, Loc);
3121 end if;
3122 end loop;
3123 end Apply_Selected_Range_Checks;
3125 -------------------------------
3126 -- Apply_Static_Length_Check --
3127 -------------------------------
3129 procedure Apply_Static_Length_Check
3130 (Expr : Node_Id;
3131 Target_Typ : Entity_Id;
3132 Source_Typ : Entity_Id := Empty)
3134 begin
3135 Apply_Selected_Length_Checks
3136 (Expr, Target_Typ, Source_Typ, Do_Static => True);
3137 end Apply_Static_Length_Check;
3139 -------------------------------------
3140 -- Apply_Subscript_Validity_Checks --
3141 -------------------------------------
3143 procedure Apply_Subscript_Validity_Checks (Expr : Node_Id) is
3144 Sub : Node_Id;
3146 begin
3147 pragma Assert (Nkind (Expr) = N_Indexed_Component);
3149 -- Loop through subscripts
3151 Sub := First (Expressions (Expr));
3152 while Present (Sub) loop
3154 -- Check one subscript. Note that we do not worry about enumeration
3155 -- type with holes, since we will convert the value to a Pos value
3156 -- for the subscript, and that convert will do the necessary validity
3157 -- check.
3159 Ensure_Valid (Sub, Holes_OK => True);
3161 -- Move to next subscript
3163 Sub := Next (Sub);
3164 end loop;
3165 end Apply_Subscript_Validity_Checks;
3167 ----------------------------------
3168 -- Apply_Type_Conversion_Checks --
3169 ----------------------------------
3171 procedure Apply_Type_Conversion_Checks (N : Node_Id) is
3172 Target_Type : constant Entity_Id := Etype (N);
3173 Target_Base : constant Entity_Id := Base_Type (Target_Type);
3174 Expr : constant Node_Id := Expression (N);
3176 Expr_Type : constant Entity_Id := Underlying_Type (Etype (Expr));
3177 -- Note: if Etype (Expr) is a private type without discriminants, its
3178 -- full view might have discriminants with defaults, so we need the
3179 -- full view here to retrieve the constraints.
3181 begin
3182 if Inside_A_Generic then
3183 return;
3185 -- Skip these checks if serious errors detected, there are some nasty
3186 -- situations of incomplete trees that blow things up.
3188 elsif Serious_Errors_Detected > 0 then
3189 return;
3191 -- Scalar type conversions of the form Target_Type (Expr) require a
3192 -- range check if we cannot be sure that Expr is in the base type of
3193 -- Target_Typ and also that Expr is in the range of Target_Typ. These
3194 -- are not quite the same condition from an implementation point of
3195 -- view, but clearly the second includes the first.
3197 elsif Is_Scalar_Type (Target_Type) then
3198 declare
3199 Conv_OK : constant Boolean := Conversion_OK (N);
3200 -- If the Conversion_OK flag on the type conversion is set and no
3201 -- floating point type is involved in the type conversion then
3202 -- fixed point values must be read as integral values.
3204 Float_To_Int : constant Boolean :=
3205 Is_Floating_Point_Type (Expr_Type)
3206 and then Is_Integer_Type (Target_Type);
3208 begin
3209 if not Overflow_Checks_Suppressed (Target_Base)
3210 and then not Overflow_Checks_Suppressed (Target_Type)
3211 and then not
3212 In_Subrange_Of (Expr_Type, Target_Base, Fixed_Int => Conv_OK)
3213 and then not Float_To_Int
3214 then
3215 Activate_Overflow_Check (N);
3216 end if;
3218 if not Range_Checks_Suppressed (Target_Type)
3219 and then not Range_Checks_Suppressed (Expr_Type)
3220 then
3221 if Float_To_Int then
3222 Apply_Float_Conversion_Check (Expr, Target_Type);
3223 else
3224 Apply_Scalar_Range_Check
3225 (Expr, Target_Type, Fixed_Int => Conv_OK);
3227 -- If the target type has predicates, we need to indicate
3228 -- the need for a check, even if Determine_Range finds
3229 -- that the value is within bounds. This may be the case
3230 -- e.g for a division with a constant denominator.
3232 if Has_Predicates (Target_Type) then
3233 Enable_Range_Check (Expr);
3234 end if;
3235 end if;
3236 end if;
3237 end;
3239 elsif Comes_From_Source (N)
3240 and then not Discriminant_Checks_Suppressed (Target_Type)
3241 and then Is_Record_Type (Target_Type)
3242 and then Is_Derived_Type (Target_Type)
3243 and then not Is_Tagged_Type (Target_Type)
3244 and then not Is_Constrained (Target_Type)
3245 and then Present (Stored_Constraint (Target_Type))
3246 then
3247 -- An unconstrained derived type may have inherited discriminant.
3248 -- Build an actual discriminant constraint list using the stored
3249 -- constraint, to verify that the expression of the parent type
3250 -- satisfies the constraints imposed by the (unconstrained!)
3251 -- derived type. This applies to value conversions, not to view
3252 -- conversions of tagged types.
3254 declare
3255 Loc : constant Source_Ptr := Sloc (N);
3256 Cond : Node_Id;
3257 Constraint : Elmt_Id;
3258 Discr_Value : Node_Id;
3259 Discr : Entity_Id;
3261 New_Constraints : constant Elist_Id := New_Elmt_List;
3262 Old_Constraints : constant Elist_Id :=
3263 Discriminant_Constraint (Expr_Type);
3265 begin
3266 Constraint := First_Elmt (Stored_Constraint (Target_Type));
3267 while Present (Constraint) loop
3268 Discr_Value := Node (Constraint);
3270 if Is_Entity_Name (Discr_Value)
3271 and then Ekind (Entity (Discr_Value)) = E_Discriminant
3272 then
3273 Discr := Corresponding_Discriminant (Entity (Discr_Value));
3275 if Present (Discr)
3276 and then Scope (Discr) = Base_Type (Expr_Type)
3277 then
3278 -- Parent is constrained by new discriminant. Obtain
3279 -- Value of original discriminant in expression. If the
3280 -- new discriminant has been used to constrain more than
3281 -- one of the stored discriminants, this will provide the
3282 -- required consistency check.
3284 Append_Elmt
3285 (Make_Selected_Component (Loc,
3286 Prefix =>
3287 Duplicate_Subexpr_No_Checks
3288 (Expr, Name_Req => True),
3289 Selector_Name =>
3290 Make_Identifier (Loc, Chars (Discr))),
3291 New_Constraints);
3293 else
3294 -- Discriminant of more remote ancestor ???
3296 return;
3297 end if;
3299 -- Derived type definition has an explicit value for this
3300 -- stored discriminant.
3302 else
3303 Append_Elmt
3304 (Duplicate_Subexpr_No_Checks (Discr_Value),
3305 New_Constraints);
3306 end if;
3308 Next_Elmt (Constraint);
3309 end loop;
3311 -- Use the unconstrained expression type to retrieve the
3312 -- discriminants of the parent, and apply momentarily the
3313 -- discriminant constraint synthesized above.
3315 Set_Discriminant_Constraint (Expr_Type, New_Constraints);
3316 Cond := Build_Discriminant_Checks (Expr, Expr_Type);
3317 Set_Discriminant_Constraint (Expr_Type, Old_Constraints);
3319 Insert_Action (N,
3320 Make_Raise_Constraint_Error (Loc,
3321 Condition => Cond,
3322 Reason => CE_Discriminant_Check_Failed));
3323 end;
3325 -- For arrays, checks are set now, but conversions are applied during
3326 -- expansion, to take into accounts changes of representation. The
3327 -- checks become range checks on the base type or length checks on the
3328 -- subtype, depending on whether the target type is unconstrained or
3329 -- constrained. Note that the range check is put on the expression of a
3330 -- type conversion, while the length check is put on the type conversion
3331 -- itself.
3333 elsif Is_Array_Type (Target_Type) then
3334 if Is_Constrained (Target_Type) then
3335 Set_Do_Length_Check (N);
3336 else
3337 Set_Do_Range_Check (Expr);
3338 end if;
3339 end if;
3340 end Apply_Type_Conversion_Checks;
3342 ----------------------------------------------
3343 -- Apply_Universal_Integer_Attribute_Checks --
3344 ----------------------------------------------
3346 procedure Apply_Universal_Integer_Attribute_Checks (N : Node_Id) is
3347 Loc : constant Source_Ptr := Sloc (N);
3348 Typ : constant Entity_Id := Etype (N);
3350 begin
3351 if Inside_A_Generic then
3352 return;
3354 -- Nothing to do if checks are suppressed
3356 elsif Range_Checks_Suppressed (Typ)
3357 and then Overflow_Checks_Suppressed (Typ)
3358 then
3359 return;
3361 -- Nothing to do if the attribute does not come from source. The
3362 -- internal attributes we generate of this type do not need checks,
3363 -- and furthermore the attempt to check them causes some circular
3364 -- elaboration orders when dealing with packed types.
3366 elsif not Comes_From_Source (N) then
3367 return;
3369 -- If the prefix is a selected component that depends on a discriminant
3370 -- the check may improperly expose a discriminant instead of using
3371 -- the bounds of the object itself. Set the type of the attribute to
3372 -- the base type of the context, so that a check will be imposed when
3373 -- needed (e.g. if the node appears as an index).
3375 elsif Nkind (Prefix (N)) = N_Selected_Component
3376 and then Ekind (Typ) = E_Signed_Integer_Subtype
3377 and then Depends_On_Discriminant (Scalar_Range (Typ))
3378 then
3379 Set_Etype (N, Base_Type (Typ));
3381 -- Otherwise, replace the attribute node with a type conversion node
3382 -- whose expression is the attribute, retyped to universal integer, and
3383 -- whose subtype mark is the target type. The call to analyze this
3384 -- conversion will set range and overflow checks as required for proper
3385 -- detection of an out of range value.
3387 else
3388 Set_Etype (N, Universal_Integer);
3389 Set_Analyzed (N, True);
3391 Rewrite (N,
3392 Make_Type_Conversion (Loc,
3393 Subtype_Mark => New_Occurrence_Of (Typ, Loc),
3394 Expression => Relocate_Node (N)));
3396 Analyze_And_Resolve (N, Typ);
3397 return;
3398 end if;
3399 end Apply_Universal_Integer_Attribute_Checks;
3401 -------------------------------------
3402 -- Atomic_Synchronization_Disabled --
3403 -------------------------------------
3405 -- Note: internally Disable/Enable_Atomic_Synchronization is implemented
3406 -- using a bogus check called Atomic_Synchronization. This is to make it
3407 -- more convenient to get exactly the same semantics as [Un]Suppress.
3409 function Atomic_Synchronization_Disabled (E : Entity_Id) return Boolean is
3410 begin
3411 -- If debug flag d.e is set, always return False, i.e. all atomic sync
3412 -- looks enabled, since it is never disabled.
3414 if Debug_Flag_Dot_E then
3415 return False;
3417 -- If debug flag d.d is set then always return True, i.e. all atomic
3418 -- sync looks disabled, since it always tests True.
3420 elsif Debug_Flag_Dot_D then
3421 return True;
3423 -- If entity present, then check result for that entity
3425 elsif Present (E) and then Checks_May_Be_Suppressed (E) then
3426 return Is_Check_Suppressed (E, Atomic_Synchronization);
3428 -- Otherwise result depends on current scope setting
3430 else
3431 return Scope_Suppress.Suppress (Atomic_Synchronization);
3432 end if;
3433 end Atomic_Synchronization_Disabled;
3435 -------------------------------
3436 -- Build_Discriminant_Checks --
3437 -------------------------------
3439 function Build_Discriminant_Checks
3440 (N : Node_Id;
3441 T_Typ : Entity_Id) return Node_Id
3443 Loc : constant Source_Ptr := Sloc (N);
3444 Cond : Node_Id;
3445 Disc : Elmt_Id;
3446 Disc_Ent : Entity_Id;
3447 Dref : Node_Id;
3448 Dval : Node_Id;
3450 function Aggregate_Discriminant_Val (Disc : Entity_Id) return Node_Id;
3452 ----------------------------------
3453 -- Aggregate_Discriminant_Value --
3454 ----------------------------------
3456 function Aggregate_Discriminant_Val (Disc : Entity_Id) return Node_Id is
3457 Assoc : Node_Id;
3459 begin
3460 -- The aggregate has been normalized with named associations. We use
3461 -- the Chars field to locate the discriminant to take into account
3462 -- discriminants in derived types, which carry the same name as those
3463 -- in the parent.
3465 Assoc := First (Component_Associations (N));
3466 while Present (Assoc) loop
3467 if Chars (First (Choices (Assoc))) = Chars (Disc) then
3468 return Expression (Assoc);
3469 else
3470 Next (Assoc);
3471 end if;
3472 end loop;
3474 -- Discriminant must have been found in the loop above
3476 raise Program_Error;
3477 end Aggregate_Discriminant_Val;
3479 -- Start of processing for Build_Discriminant_Checks
3481 begin
3482 -- Loop through discriminants evolving the condition
3484 Cond := Empty;
3485 Disc := First_Elmt (Discriminant_Constraint (T_Typ));
3487 -- For a fully private type, use the discriminants of the parent type
3489 if Is_Private_Type (T_Typ)
3490 and then No (Full_View (T_Typ))
3491 then
3492 Disc_Ent := First_Discriminant (Etype (Base_Type (T_Typ)));
3493 else
3494 Disc_Ent := First_Discriminant (T_Typ);
3495 end if;
3497 while Present (Disc) loop
3498 Dval := Node (Disc);
3500 if Nkind (Dval) = N_Identifier
3501 and then Ekind (Entity (Dval)) = E_Discriminant
3502 then
3503 Dval := New_Occurrence_Of (Discriminal (Entity (Dval)), Loc);
3504 else
3505 Dval := Duplicate_Subexpr_No_Checks (Dval);
3506 end if;
3508 -- If we have an Unchecked_Union node, we can infer the discriminants
3509 -- of the node.
3511 if Is_Unchecked_Union (Base_Type (T_Typ)) then
3512 Dref := New_Copy (
3513 Get_Discriminant_Value (
3514 First_Discriminant (T_Typ),
3515 T_Typ,
3516 Stored_Constraint (T_Typ)));
3518 elsif Nkind (N) = N_Aggregate then
3519 Dref :=
3520 Duplicate_Subexpr_No_Checks
3521 (Aggregate_Discriminant_Val (Disc_Ent));
3523 else
3524 Dref :=
3525 Make_Selected_Component (Loc,
3526 Prefix =>
3527 Duplicate_Subexpr_No_Checks (N, Name_Req => True),
3528 Selector_Name =>
3529 Make_Identifier (Loc, Chars (Disc_Ent)));
3531 Set_Is_In_Discriminant_Check (Dref);
3532 end if;
3534 Evolve_Or_Else (Cond,
3535 Make_Op_Ne (Loc,
3536 Left_Opnd => Dref,
3537 Right_Opnd => Dval));
3539 Next_Elmt (Disc);
3540 Next_Discriminant (Disc_Ent);
3541 end loop;
3543 return Cond;
3544 end Build_Discriminant_Checks;
3546 ------------------
3547 -- Check_Needed --
3548 ------------------
3550 function Check_Needed (Nod : Node_Id; Check : Check_Type) return Boolean is
3551 N : Node_Id;
3552 P : Node_Id;
3553 K : Node_Kind;
3554 L : Node_Id;
3555 R : Node_Id;
3557 function Left_Expression (Op : Node_Id) return Node_Id;
3558 -- Return the relevant expression from the left operand of the given
3559 -- short circuit form: this is LO itself, except if LO is a qualified
3560 -- expression, a type conversion, or an expression with actions, in
3561 -- which case this is Left_Expression (Expression (LO)).
3563 ---------------------
3564 -- Left_Expression --
3565 ---------------------
3567 function Left_Expression (Op : Node_Id) return Node_Id is
3568 LE : Node_Id := Left_Opnd (Op);
3569 begin
3570 while Nkind_In (LE,
3571 N_Qualified_Expression,
3572 N_Type_Conversion,
3573 N_Expression_With_Actions)
3574 loop
3575 LE := Expression (LE);
3576 end loop;
3578 return LE;
3579 end Left_Expression;
3581 -- Start of processing for Check_Needed
3583 begin
3584 -- Always check if not simple entity
3586 if Nkind (Nod) not in N_Has_Entity
3587 or else not Comes_From_Source (Nod)
3588 then
3589 return True;
3590 end if;
3592 -- Look up tree for short circuit
3594 N := Nod;
3595 loop
3596 P := Parent (N);
3597 K := Nkind (P);
3599 -- Done if out of subexpression (note that we allow generated stuff
3600 -- such as itype declarations in this context, to keep the loop going
3601 -- since we may well have generated such stuff in complex situations.
3602 -- Also done if no parent (probably an error condition, but no point
3603 -- in behaving nasty if we find it!)
3605 if No (P)
3606 or else (K not in N_Subexpr and then Comes_From_Source (P))
3607 then
3608 return True;
3610 -- Or/Or Else case, where test is part of the right operand, or is
3611 -- part of one of the actions associated with the right operand, and
3612 -- the left operand is an equality test.
3614 elsif K = N_Op_Or then
3615 exit when N = Right_Opnd (P)
3616 and then Nkind (Left_Expression (P)) = N_Op_Eq;
3618 elsif K = N_Or_Else then
3619 exit when (N = Right_Opnd (P)
3620 or else
3621 (Is_List_Member (N)
3622 and then List_Containing (N) = Actions (P)))
3623 and then Nkind (Left_Expression (P)) = N_Op_Eq;
3625 -- Similar test for the And/And then case, where the left operand
3626 -- is an inequality test.
3628 elsif K = N_Op_And then
3629 exit when N = Right_Opnd (P)
3630 and then Nkind (Left_Expression (P)) = N_Op_Ne;
3632 elsif K = N_And_Then then
3633 exit when (N = Right_Opnd (P)
3634 or else
3635 (Is_List_Member (N)
3636 and then List_Containing (N) = Actions (P)))
3637 and then Nkind (Left_Expression (P)) = N_Op_Ne;
3638 end if;
3640 N := P;
3641 end loop;
3643 -- If we fall through the loop, then we have a conditional with an
3644 -- appropriate test as its left operand, so look further.
3646 L := Left_Expression (P);
3648 -- L is an "=" or "/=" operator: extract its operands
3650 R := Right_Opnd (L);
3651 L := Left_Opnd (L);
3653 -- Left operand of test must match original variable
3655 if Nkind (L) not in N_Has_Entity
3656 or else Entity (L) /= Entity (Nod)
3657 then
3658 return True;
3659 end if;
3661 -- Right operand of test must be key value (zero or null)
3663 case Check is
3664 when Access_Check =>
3665 if not Known_Null (R) then
3666 return True;
3667 end if;
3669 when Division_Check =>
3670 if not Compile_Time_Known_Value (R)
3671 or else Expr_Value (R) /= Uint_0
3672 then
3673 return True;
3674 end if;
3676 when others =>
3677 raise Program_Error;
3678 end case;
3680 -- Here we have the optimizable case, warn if not short-circuited
3682 if K = N_Op_And or else K = N_Op_Or then
3683 case Check is
3684 when Access_Check =>
3685 Error_Msg_N
3686 ("Constraint_Error may be raised (access check)??",
3687 Parent (Nod));
3688 when Division_Check =>
3689 Error_Msg_N
3690 ("Constraint_Error may be raised (zero divide)??",
3691 Parent (Nod));
3693 when others =>
3694 raise Program_Error;
3695 end case;
3697 if K = N_Op_And then
3698 Error_Msg_N -- CODEFIX
3699 ("use `AND THEN` instead of AND??", P);
3700 else
3701 Error_Msg_N -- CODEFIX
3702 ("use `OR ELSE` instead of OR??", P);
3703 end if;
3705 -- If not short-circuited, we need the check
3707 return True;
3709 -- If short-circuited, we can omit the check
3711 else
3712 return False;
3713 end if;
3714 end Check_Needed;
3716 -----------------------------------
3717 -- Check_Valid_Lvalue_Subscripts --
3718 -----------------------------------
3720 procedure Check_Valid_Lvalue_Subscripts (Expr : Node_Id) is
3721 begin
3722 -- Skip this if range checks are suppressed
3724 if Range_Checks_Suppressed (Etype (Expr)) then
3725 return;
3727 -- Only do this check for expressions that come from source. We assume
3728 -- that expander generated assignments explicitly include any necessary
3729 -- checks. Note that this is not just an optimization, it avoids
3730 -- infinite recursions!
3732 elsif not Comes_From_Source (Expr) then
3733 return;
3735 -- For a selected component, check the prefix
3737 elsif Nkind (Expr) = N_Selected_Component then
3738 Check_Valid_Lvalue_Subscripts (Prefix (Expr));
3739 return;
3741 -- Case of indexed component
3743 elsif Nkind (Expr) = N_Indexed_Component then
3744 Apply_Subscript_Validity_Checks (Expr);
3746 -- Prefix may itself be or contain an indexed component, and these
3747 -- subscripts need checking as well.
3749 Check_Valid_Lvalue_Subscripts (Prefix (Expr));
3750 end if;
3751 end Check_Valid_Lvalue_Subscripts;
3753 ----------------------------------
3754 -- Null_Exclusion_Static_Checks --
3755 ----------------------------------
3757 procedure Null_Exclusion_Static_Checks (N : Node_Id) is
3758 Error_Node : Node_Id;
3759 Expr : Node_Id;
3760 Has_Null : constant Boolean := Has_Null_Exclusion (N);
3761 K : constant Node_Kind := Nkind (N);
3762 Typ : Entity_Id;
3764 begin
3765 pragma Assert
3766 (K = N_Component_Declaration
3767 or else K = N_Discriminant_Specification
3768 or else K = N_Function_Specification
3769 or else K = N_Object_Declaration
3770 or else K = N_Parameter_Specification);
3772 if K = N_Function_Specification then
3773 Typ := Etype (Defining_Entity (N));
3774 else
3775 Typ := Etype (Defining_Identifier (N));
3776 end if;
3778 case K is
3779 when N_Component_Declaration =>
3780 if Present (Access_Definition (Component_Definition (N))) then
3781 Error_Node := Component_Definition (N);
3782 else
3783 Error_Node := Subtype_Indication (Component_Definition (N));
3784 end if;
3786 when N_Discriminant_Specification =>
3787 Error_Node := Discriminant_Type (N);
3789 when N_Function_Specification =>
3790 Error_Node := Result_Definition (N);
3792 when N_Object_Declaration =>
3793 Error_Node := Object_Definition (N);
3795 when N_Parameter_Specification =>
3796 Error_Node := Parameter_Type (N);
3798 when others =>
3799 raise Program_Error;
3800 end case;
3802 if Has_Null then
3804 -- Enforce legality rule 3.10 (13): A null exclusion can only be
3805 -- applied to an access [sub]type.
3807 if not Is_Access_Type (Typ) then
3808 Error_Msg_N
3809 ("`NOT NULL` allowed only for an access type", Error_Node);
3811 -- Enforce legality rule RM 3.10(14/1): A null exclusion can only
3812 -- be applied to a [sub]type that does not exclude null already.
3814 elsif Can_Never_Be_Null (Typ)
3815 and then Comes_From_Source (Typ)
3816 then
3817 Error_Msg_NE
3818 ("`NOT NULL` not allowed (& already excludes null)",
3819 Error_Node, Typ);
3820 end if;
3821 end if;
3823 -- Check that null-excluding objects are always initialized, except for
3824 -- deferred constants, for which the expression will appear in the full
3825 -- declaration.
3827 if K = N_Object_Declaration
3828 and then No (Expression (N))
3829 and then not Constant_Present (N)
3830 and then not No_Initialization (N)
3831 then
3832 -- Add an expression that assigns null. This node is needed by
3833 -- Apply_Compile_Time_Constraint_Error, which will replace this with
3834 -- a Constraint_Error node.
3836 Set_Expression (N, Make_Null (Sloc (N)));
3837 Set_Etype (Expression (N), Etype (Defining_Identifier (N)));
3839 Apply_Compile_Time_Constraint_Error
3840 (N => Expression (N),
3841 Msg =>
3842 "(Ada 2005) null-excluding objects must be initialized??",
3843 Reason => CE_Null_Not_Allowed);
3844 end if;
3846 -- Check that a null-excluding component, formal or object is not being
3847 -- assigned a null value. Otherwise generate a warning message and
3848 -- replace Expression (N) by an N_Constraint_Error node.
3850 if K /= N_Function_Specification then
3851 Expr := Expression (N);
3853 if Present (Expr) and then Known_Null (Expr) then
3854 case K is
3855 when N_Component_Declaration |
3856 N_Discriminant_Specification =>
3857 Apply_Compile_Time_Constraint_Error
3858 (N => Expr,
3859 Msg => "(Ada 2005) null not allowed " &
3860 "in null-excluding components??",
3861 Reason => CE_Null_Not_Allowed);
3863 when N_Object_Declaration =>
3864 Apply_Compile_Time_Constraint_Error
3865 (N => Expr,
3866 Msg => "(Ada 2005) null not allowed " &
3867 "in null-excluding objects?",
3868 Reason => CE_Null_Not_Allowed);
3870 when N_Parameter_Specification =>
3871 Apply_Compile_Time_Constraint_Error
3872 (N => Expr,
3873 Msg => "(Ada 2005) null not allowed " &
3874 "in null-excluding formals??",
3875 Reason => CE_Null_Not_Allowed);
3877 when others =>
3878 null;
3879 end case;
3880 end if;
3881 end if;
3882 end Null_Exclusion_Static_Checks;
3884 ----------------------------------
3885 -- Conditional_Statements_Begin --
3886 ----------------------------------
3888 procedure Conditional_Statements_Begin is
3889 begin
3890 Saved_Checks_TOS := Saved_Checks_TOS + 1;
3892 -- If stack overflows, kill all checks, that way we know to simply reset
3893 -- the number of saved checks to zero on return. This should never occur
3894 -- in practice.
3896 if Saved_Checks_TOS > Saved_Checks_Stack'Last then
3897 Kill_All_Checks;
3899 -- In the normal case, we just make a new stack entry saving the current
3900 -- number of saved checks for a later restore.
3902 else
3903 Saved_Checks_Stack (Saved_Checks_TOS) := Num_Saved_Checks;
3905 if Debug_Flag_CC then
3906 w ("Conditional_Statements_Begin: Num_Saved_Checks = ",
3907 Num_Saved_Checks);
3908 end if;
3909 end if;
3910 end Conditional_Statements_Begin;
3912 --------------------------------
3913 -- Conditional_Statements_End --
3914 --------------------------------
3916 procedure Conditional_Statements_End is
3917 begin
3918 pragma Assert (Saved_Checks_TOS > 0);
3920 -- If the saved checks stack overflowed, then we killed all checks, so
3921 -- setting the number of saved checks back to zero is correct. This
3922 -- should never occur in practice.
3924 if Saved_Checks_TOS > Saved_Checks_Stack'Last then
3925 Num_Saved_Checks := 0;
3927 -- In the normal case, restore the number of saved checks from the top
3928 -- stack entry.
3930 else
3931 Num_Saved_Checks := Saved_Checks_Stack (Saved_Checks_TOS);
3932 if Debug_Flag_CC then
3933 w ("Conditional_Statements_End: Num_Saved_Checks = ",
3934 Num_Saved_Checks);
3935 end if;
3936 end if;
3938 Saved_Checks_TOS := Saved_Checks_TOS - 1;
3939 end Conditional_Statements_End;
3941 -------------------------
3942 -- Convert_From_Bignum --
3943 -------------------------
3945 function Convert_From_Bignum (N : Node_Id) return Node_Id is
3946 Loc : constant Source_Ptr := Sloc (N);
3948 begin
3949 pragma Assert (Is_RTE (Etype (N), RE_Bignum));
3951 -- Construct call From Bignum
3953 return
3954 Make_Function_Call (Loc,
3955 Name =>
3956 New_Occurrence_Of (RTE (RE_From_Bignum), Loc),
3957 Parameter_Associations => New_List (Relocate_Node (N)));
3958 end Convert_From_Bignum;
3960 -----------------------
3961 -- Convert_To_Bignum --
3962 -----------------------
3964 function Convert_To_Bignum (N : Node_Id) return Node_Id is
3965 Loc : constant Source_Ptr := Sloc (N);
3967 begin
3968 -- Nothing to do if Bignum already except call Relocate_Node
3970 if Is_RTE (Etype (N), RE_Bignum) then
3971 return Relocate_Node (N);
3973 -- Otherwise construct call to To_Bignum, converting the operand to the
3974 -- required Long_Long_Integer form.
3976 else
3977 pragma Assert (Is_Signed_Integer_Type (Etype (N)));
3978 return
3979 Make_Function_Call (Loc,
3980 Name =>
3981 New_Occurrence_Of (RTE (RE_To_Bignum), Loc),
3982 Parameter_Associations => New_List (
3983 Convert_To (Standard_Long_Long_Integer, Relocate_Node (N))));
3984 end if;
3985 end Convert_To_Bignum;
3987 ---------------------
3988 -- Determine_Range --
3989 ---------------------
3991 Cache_Size : constant := 2 ** 10;
3992 type Cache_Index is range 0 .. Cache_Size - 1;
3993 -- Determine size of below cache (power of 2 is more efficient!)
3995 Determine_Range_Cache_N : array (Cache_Index) of Node_Id;
3996 Determine_Range_Cache_V : array (Cache_Index) of Boolean;
3997 Determine_Range_Cache_Lo : array (Cache_Index) of Uint;
3998 Determine_Range_Cache_Hi : array (Cache_Index) of Uint;
3999 -- The above arrays are used to implement a small direct cache for
4000 -- Determine_Range calls. Because of the way Determine_Range recursively
4001 -- traces subexpressions, and because overflow checking calls the routine
4002 -- on the way up the tree, a quadratic behavior can otherwise be
4003 -- encountered in large expressions. The cache entry for node N is stored
4004 -- in the (N mod Cache_Size) entry, and can be validated by checking the
4005 -- actual node value stored there. The Range_Cache_V array records the
4006 -- setting of Assume_Valid for the cache entry.
4008 procedure Determine_Range
4009 (N : Node_Id;
4010 OK : out Boolean;
4011 Lo : out Uint;
4012 Hi : out Uint;
4013 Assume_Valid : Boolean := False)
4015 Typ : Entity_Id := Etype (N);
4016 -- Type to use, may get reset to base type for possibly invalid entity
4018 Lo_Left : Uint;
4019 Hi_Left : Uint;
4020 -- Lo and Hi bounds of left operand
4022 Lo_Right : Uint;
4023 Hi_Right : Uint;
4024 -- Lo and Hi bounds of right (or only) operand
4026 Bound : Node_Id;
4027 -- Temp variable used to hold a bound node
4029 Hbound : Uint;
4030 -- High bound of base type of expression
4032 Lor : Uint;
4033 Hir : Uint;
4034 -- Refined values for low and high bounds, after tightening
4036 OK1 : Boolean;
4037 -- Used in lower level calls to indicate if call succeeded
4039 Cindex : Cache_Index;
4040 -- Used to search cache
4042 Btyp : Entity_Id;
4043 -- Base type
4045 function OK_Operands return Boolean;
4046 -- Used for binary operators. Determines the ranges of the left and
4047 -- right operands, and if they are both OK, returns True, and puts
4048 -- the results in Lo_Right, Hi_Right, Lo_Left, Hi_Left.
4050 -----------------
4051 -- OK_Operands --
4052 -----------------
4054 function OK_Operands return Boolean is
4055 begin
4056 Determine_Range
4057 (Left_Opnd (N), OK1, Lo_Left, Hi_Left, Assume_Valid);
4059 if not OK1 then
4060 return False;
4061 end if;
4063 Determine_Range
4064 (Right_Opnd (N), OK1, Lo_Right, Hi_Right, Assume_Valid);
4065 return OK1;
4066 end OK_Operands;
4068 -- Start of processing for Determine_Range
4070 begin
4071 -- For temporary constants internally generated to remove side effects
4072 -- we must use the corresponding expression to determine the range of
4073 -- the expression.
4075 if Is_Entity_Name (N)
4076 and then Nkind (Parent (Entity (N))) = N_Object_Declaration
4077 and then Ekind (Entity (N)) = E_Constant
4078 and then Is_Internal_Name (Chars (Entity (N)))
4079 then
4080 Determine_Range
4081 (Expression (Parent (Entity (N))), OK, Lo, Hi, Assume_Valid);
4082 return;
4083 end if;
4085 -- Prevent junk warnings by initializing range variables
4087 Lo := No_Uint;
4088 Hi := No_Uint;
4089 Lor := No_Uint;
4090 Hir := No_Uint;
4092 -- If type is not defined, we can't determine its range
4094 if No (Typ)
4096 -- We don't deal with anything except discrete types
4098 or else not Is_Discrete_Type (Typ)
4100 -- Ignore type for which an error has been posted, since range in
4101 -- this case may well be a bogosity deriving from the error. Also
4102 -- ignore if error posted on the reference node.
4104 or else Error_Posted (N) or else Error_Posted (Typ)
4105 then
4106 OK := False;
4107 return;
4108 end if;
4110 -- For all other cases, we can determine the range
4112 OK := True;
4114 -- If value is compile time known, then the possible range is the one
4115 -- value that we know this expression definitely has!
4117 if Compile_Time_Known_Value (N) then
4118 Lo := Expr_Value (N);
4119 Hi := Lo;
4120 return;
4121 end if;
4123 -- Return if already in the cache
4125 Cindex := Cache_Index (N mod Cache_Size);
4127 if Determine_Range_Cache_N (Cindex) = N
4128 and then
4129 Determine_Range_Cache_V (Cindex) = Assume_Valid
4130 then
4131 Lo := Determine_Range_Cache_Lo (Cindex);
4132 Hi := Determine_Range_Cache_Hi (Cindex);
4133 return;
4134 end if;
4136 -- Otherwise, start by finding the bounds of the type of the expression,
4137 -- the value cannot be outside this range (if it is, then we have an
4138 -- overflow situation, which is a separate check, we are talking here
4139 -- only about the expression value).
4141 -- First a check, never try to find the bounds of a generic type, since
4142 -- these bounds are always junk values, and it is only valid to look at
4143 -- the bounds in an instance.
4145 if Is_Generic_Type (Typ) then
4146 OK := False;
4147 return;
4148 end if;
4150 -- First step, change to use base type unless we know the value is valid
4152 if (Is_Entity_Name (N) and then Is_Known_Valid (Entity (N)))
4153 or else Assume_No_Invalid_Values
4154 or else Assume_Valid
4155 then
4156 null;
4157 else
4158 Typ := Underlying_Type (Base_Type (Typ));
4159 end if;
4161 -- Retrieve the base type. Handle the case where the base type is a
4162 -- private enumeration type.
4164 Btyp := Base_Type (Typ);
4166 if Is_Private_Type (Btyp) and then Present (Full_View (Btyp)) then
4167 Btyp := Full_View (Btyp);
4168 end if;
4170 -- We use the actual bound unless it is dynamic, in which case use the
4171 -- corresponding base type bound if possible. If we can't get a bound
4172 -- then we figure we can't determine the range (a peculiar case, that
4173 -- perhaps cannot happen, but there is no point in bombing in this
4174 -- optimization circuit.
4176 -- First the low bound
4178 Bound := Type_Low_Bound (Typ);
4180 if Compile_Time_Known_Value (Bound) then
4181 Lo := Expr_Value (Bound);
4183 elsif Compile_Time_Known_Value (Type_Low_Bound (Btyp)) then
4184 Lo := Expr_Value (Type_Low_Bound (Btyp));
4186 else
4187 OK := False;
4188 return;
4189 end if;
4191 -- Now the high bound
4193 Bound := Type_High_Bound (Typ);
4195 -- We need the high bound of the base type later on, and this should
4196 -- always be compile time known. Again, it is not clear that this
4197 -- can ever be false, but no point in bombing.
4199 if Compile_Time_Known_Value (Type_High_Bound (Btyp)) then
4200 Hbound := Expr_Value (Type_High_Bound (Btyp));
4201 Hi := Hbound;
4203 else
4204 OK := False;
4205 return;
4206 end if;
4208 -- If we have a static subtype, then that may have a tighter bound so
4209 -- use the upper bound of the subtype instead in this case.
4211 if Compile_Time_Known_Value (Bound) then
4212 Hi := Expr_Value (Bound);
4213 end if;
4215 -- We may be able to refine this value in certain situations. If any
4216 -- refinement is possible, then Lor and Hir are set to possibly tighter
4217 -- bounds, and OK1 is set to True.
4219 case Nkind (N) is
4221 -- For unary plus, result is limited by range of operand
4223 when N_Op_Plus =>
4224 Determine_Range
4225 (Right_Opnd (N), OK1, Lor, Hir, Assume_Valid);
4227 -- For unary minus, determine range of operand, and negate it
4229 when N_Op_Minus =>
4230 Determine_Range
4231 (Right_Opnd (N), OK1, Lo_Right, Hi_Right, Assume_Valid);
4233 if OK1 then
4234 Lor := -Hi_Right;
4235 Hir := -Lo_Right;
4236 end if;
4238 -- For binary addition, get range of each operand and do the
4239 -- addition to get the result range.
4241 when N_Op_Add =>
4242 if OK_Operands then
4243 Lor := Lo_Left + Lo_Right;
4244 Hir := Hi_Left + Hi_Right;
4245 end if;
4247 -- Division is tricky. The only case we consider is where the right
4248 -- operand is a positive constant, and in this case we simply divide
4249 -- the bounds of the left operand
4251 when N_Op_Divide =>
4252 if OK_Operands then
4253 if Lo_Right = Hi_Right
4254 and then Lo_Right > 0
4255 then
4256 Lor := Lo_Left / Lo_Right;
4257 Hir := Hi_Left / Lo_Right;
4259 else
4260 OK1 := False;
4261 end if;
4262 end if;
4264 -- For binary subtraction, get range of each operand and do the worst
4265 -- case subtraction to get the result range.
4267 when N_Op_Subtract =>
4268 if OK_Operands then
4269 Lor := Lo_Left - Hi_Right;
4270 Hir := Hi_Left - Lo_Right;
4271 end if;
4273 -- For MOD, if right operand is a positive constant, then result must
4274 -- be in the allowable range of mod results.
4276 when N_Op_Mod =>
4277 if OK_Operands then
4278 if Lo_Right = Hi_Right
4279 and then Lo_Right /= 0
4280 then
4281 if Lo_Right > 0 then
4282 Lor := Uint_0;
4283 Hir := Lo_Right - 1;
4285 else -- Lo_Right < 0
4286 Lor := Lo_Right + 1;
4287 Hir := Uint_0;
4288 end if;
4290 else
4291 OK1 := False;
4292 end if;
4293 end if;
4295 -- For REM, if right operand is a positive constant, then result must
4296 -- be in the allowable range of mod results.
4298 when N_Op_Rem =>
4299 if OK_Operands then
4300 if Lo_Right = Hi_Right
4301 and then Lo_Right /= 0
4302 then
4303 declare
4304 Dval : constant Uint := (abs Lo_Right) - 1;
4306 begin
4307 -- The sign of the result depends on the sign of the
4308 -- dividend (but not on the sign of the divisor, hence
4309 -- the abs operation above).
4311 if Lo_Left < 0 then
4312 Lor := -Dval;
4313 else
4314 Lor := Uint_0;
4315 end if;
4317 if Hi_Left < 0 then
4318 Hir := Uint_0;
4319 else
4320 Hir := Dval;
4321 end if;
4322 end;
4324 else
4325 OK1 := False;
4326 end if;
4327 end if;
4329 -- Attribute reference cases
4331 when N_Attribute_Reference =>
4332 case Attribute_Name (N) is
4334 -- For Pos/Val attributes, we can refine the range using the
4335 -- possible range of values of the attribute expression.
4337 when Name_Pos | Name_Val =>
4338 Determine_Range
4339 (First (Expressions (N)), OK1, Lor, Hir, Assume_Valid);
4341 -- For Length attribute, use the bounds of the corresponding
4342 -- index type to refine the range.
4344 when Name_Length =>
4345 declare
4346 Atyp : Entity_Id := Etype (Prefix (N));
4347 Inum : Nat;
4348 Indx : Node_Id;
4350 LL, LU : Uint;
4351 UL, UU : Uint;
4353 begin
4354 if Is_Access_Type (Atyp) then
4355 Atyp := Designated_Type (Atyp);
4356 end if;
4358 -- For string literal, we know exact value
4360 if Ekind (Atyp) = E_String_Literal_Subtype then
4361 OK := True;
4362 Lo := String_Literal_Length (Atyp);
4363 Hi := String_Literal_Length (Atyp);
4364 return;
4365 end if;
4367 -- Otherwise check for expression given
4369 if No (Expressions (N)) then
4370 Inum := 1;
4371 else
4372 Inum :=
4373 UI_To_Int (Expr_Value (First (Expressions (N))));
4374 end if;
4376 Indx := First_Index (Atyp);
4377 for J in 2 .. Inum loop
4378 Indx := Next_Index (Indx);
4379 end loop;
4381 -- If the index type is a formal type or derived from
4382 -- one, the bounds are not static.
4384 if Is_Generic_Type (Root_Type (Etype (Indx))) then
4385 OK := False;
4386 return;
4387 end if;
4389 Determine_Range
4390 (Type_Low_Bound (Etype (Indx)), OK1, LL, LU,
4391 Assume_Valid);
4393 if OK1 then
4394 Determine_Range
4395 (Type_High_Bound (Etype (Indx)), OK1, UL, UU,
4396 Assume_Valid);
4398 if OK1 then
4400 -- The maximum value for Length is the biggest
4401 -- possible gap between the values of the bounds.
4402 -- But of course, this value cannot be negative.
4404 Hir := UI_Max (Uint_0, UU - LL + 1);
4406 -- For constrained arrays, the minimum value for
4407 -- Length is taken from the actual value of the
4408 -- bounds, since the index will be exactly of this
4409 -- subtype.
4411 if Is_Constrained (Atyp) then
4412 Lor := UI_Max (Uint_0, UL - LU + 1);
4414 -- For an unconstrained array, the minimum value
4415 -- for length is always zero.
4417 else
4418 Lor := Uint_0;
4419 end if;
4420 end if;
4421 end if;
4422 end;
4424 -- No special handling for other attributes
4425 -- Probably more opportunities exist here???
4427 when others =>
4428 OK1 := False;
4430 end case;
4432 -- For type conversion from one discrete type to another, we can
4433 -- refine the range using the converted value.
4435 when N_Type_Conversion =>
4436 Determine_Range (Expression (N), OK1, Lor, Hir, Assume_Valid);
4438 -- Nothing special to do for all other expression kinds
4440 when others =>
4441 OK1 := False;
4442 Lor := No_Uint;
4443 Hir := No_Uint;
4444 end case;
4446 -- At this stage, if OK1 is true, then we know that the actual result of
4447 -- the computed expression is in the range Lor .. Hir. We can use this
4448 -- to restrict the possible range of results.
4450 if OK1 then
4452 -- If the refined value of the low bound is greater than the type
4453 -- high bound, then reset it to the more restrictive value. However,
4454 -- we do NOT do this for the case of a modular type where the
4455 -- possible upper bound on the value is above the base type high
4456 -- bound, because that means the result could wrap.
4458 if Lor > Lo
4459 and then not (Is_Modular_Integer_Type (Typ) and then Hir > Hbound)
4460 then
4461 Lo := Lor;
4462 end if;
4464 -- Similarly, if the refined value of the high bound is less than the
4465 -- value so far, then reset it to the more restrictive value. Again,
4466 -- we do not do this if the refined low bound is negative for a
4467 -- modular type, since this would wrap.
4469 if Hir < Hi
4470 and then not (Is_Modular_Integer_Type (Typ) and then Lor < Uint_0)
4471 then
4472 Hi := Hir;
4473 end if;
4474 end if;
4476 -- Set cache entry for future call and we are all done
4478 Determine_Range_Cache_N (Cindex) := N;
4479 Determine_Range_Cache_V (Cindex) := Assume_Valid;
4480 Determine_Range_Cache_Lo (Cindex) := Lo;
4481 Determine_Range_Cache_Hi (Cindex) := Hi;
4482 return;
4484 -- If any exception occurs, it means that we have some bug in the compiler,
4485 -- possibly triggered by a previous error, or by some unforeseen peculiar
4486 -- occurrence. However, this is only an optimization attempt, so there is
4487 -- really no point in crashing the compiler. Instead we just decide, too
4488 -- bad, we can't figure out a range in this case after all.
4490 exception
4491 when others =>
4493 -- Debug flag K disables this behavior (useful for debugging)
4495 if Debug_Flag_K then
4496 raise;
4497 else
4498 OK := False;
4499 Lo := No_Uint;
4500 Hi := No_Uint;
4501 return;
4502 end if;
4503 end Determine_Range;
4505 ------------------------------------
4506 -- Discriminant_Checks_Suppressed --
4507 ------------------------------------
4509 function Discriminant_Checks_Suppressed (E : Entity_Id) return Boolean is
4510 begin
4511 if Present (E) then
4512 if Is_Unchecked_Union (E) then
4513 return True;
4514 elsif Checks_May_Be_Suppressed (E) then
4515 return Is_Check_Suppressed (E, Discriminant_Check);
4516 end if;
4517 end if;
4519 return Scope_Suppress.Suppress (Discriminant_Check);
4520 end Discriminant_Checks_Suppressed;
4522 --------------------------------
4523 -- Division_Checks_Suppressed --
4524 --------------------------------
4526 function Division_Checks_Suppressed (E : Entity_Id) return Boolean is
4527 begin
4528 if Present (E) and then Checks_May_Be_Suppressed (E) then
4529 return Is_Check_Suppressed (E, Division_Check);
4530 else
4531 return Scope_Suppress.Suppress (Division_Check);
4532 end if;
4533 end Division_Checks_Suppressed;
4535 -----------------------------------
4536 -- Elaboration_Checks_Suppressed --
4537 -----------------------------------
4539 function Elaboration_Checks_Suppressed (E : Entity_Id) return Boolean is
4540 begin
4541 -- The complication in this routine is that if we are in the dynamic
4542 -- model of elaboration, we also check All_Checks, since All_Checks
4543 -- does not set Elaboration_Check explicitly.
4545 if Present (E) then
4546 if Kill_Elaboration_Checks (E) then
4547 return True;
4549 elsif Checks_May_Be_Suppressed (E) then
4550 if Is_Check_Suppressed (E, Elaboration_Check) then
4551 return True;
4552 elsif Dynamic_Elaboration_Checks then
4553 return Is_Check_Suppressed (E, All_Checks);
4554 else
4555 return False;
4556 end if;
4557 end if;
4558 end if;
4560 if Scope_Suppress.Suppress (Elaboration_Check) then
4561 return True;
4562 elsif Dynamic_Elaboration_Checks then
4563 return Scope_Suppress.Suppress (All_Checks);
4564 else
4565 return False;
4566 end if;
4567 end Elaboration_Checks_Suppressed;
4569 ---------------------------
4570 -- Enable_Overflow_Check --
4571 ---------------------------
4573 procedure Enable_Overflow_Check (N : Node_Id) is
4574 Typ : constant Entity_Id := Base_Type (Etype (N));
4575 Mode : constant Overflow_Mode_Type := Overflow_Check_Mode;
4576 Chk : Nat;
4577 OK : Boolean;
4578 Ent : Entity_Id;
4579 Ofs : Uint;
4580 Lo : Uint;
4581 Hi : Uint;
4583 begin
4584 if Debug_Flag_CC then
4585 w ("Enable_Overflow_Check for node ", Int (N));
4586 Write_Str (" Source location = ");
4587 wl (Sloc (N));
4588 pg (Union_Id (N));
4589 end if;
4591 -- No check if overflow checks suppressed for type of node
4593 if Overflow_Checks_Suppressed (Etype (N)) then
4594 return;
4596 -- Nothing to do for unsigned integer types, which do not overflow
4598 elsif Is_Modular_Integer_Type (Typ) then
4599 return;
4600 end if;
4602 -- This is the point at which processing for STRICT mode diverges
4603 -- from processing for MINIMIZED/ELIMINATED modes. This divergence is
4604 -- probably more extreme that it needs to be, but what is going on here
4605 -- is that when we introduced MINIMIZED/ELIMINATED modes, we wanted
4606 -- to leave the processing for STRICT mode untouched. There were
4607 -- two reasons for this. First it avoided any incompatible change of
4608 -- behavior. Second, it guaranteed that STRICT mode continued to be
4609 -- legacy reliable.
4611 -- The big difference is that in STRICT mode there is a fair amount of
4612 -- circuitry to try to avoid setting the Do_Overflow_Check flag if we
4613 -- know that no check is needed. We skip all that in the two new modes,
4614 -- since really overflow checking happens over a whole subtree, and we
4615 -- do the corresponding optimizations later on when applying the checks.
4617 if Mode in Minimized_Or_Eliminated then
4618 if not (Overflow_Checks_Suppressed (Etype (N)))
4619 and then not (Is_Entity_Name (N)
4620 and then Overflow_Checks_Suppressed (Entity (N)))
4621 then
4622 Activate_Overflow_Check (N);
4623 end if;
4625 if Debug_Flag_CC then
4626 w ("Minimized/Eliminated mode");
4627 end if;
4629 return;
4630 end if;
4632 -- Remainder of processing is for STRICT case, and is unchanged from
4633 -- earlier versions preceding the addition of MINIMIZED/ELIMINATED.
4635 -- Nothing to do if the range of the result is known OK. We skip this
4636 -- for conversions, since the caller already did the check, and in any
4637 -- case the condition for deleting the check for a type conversion is
4638 -- different.
4640 if Nkind (N) /= N_Type_Conversion then
4641 Determine_Range (N, OK, Lo, Hi, Assume_Valid => True);
4643 -- Note in the test below that we assume that the range is not OK
4644 -- if a bound of the range is equal to that of the type. That's not
4645 -- quite accurate but we do this for the following reasons:
4647 -- a) The way that Determine_Range works, it will typically report
4648 -- the bounds of the value as being equal to the bounds of the
4649 -- type, because it either can't tell anything more precise, or
4650 -- does not think it is worth the effort to be more precise.
4652 -- b) It is very unusual to have a situation in which this would
4653 -- generate an unnecessary overflow check (an example would be
4654 -- a subtype with a range 0 .. Integer'Last - 1 to which the
4655 -- literal value one is added).
4657 -- c) The alternative is a lot of special casing in this routine
4658 -- which would partially duplicate Determine_Range processing.
4660 if OK
4661 and then Lo > Expr_Value (Type_Low_Bound (Typ))
4662 and then Hi < Expr_Value (Type_High_Bound (Typ))
4663 then
4664 if Debug_Flag_CC then
4665 w ("No overflow check required");
4666 end if;
4668 return;
4669 end if;
4670 end if;
4672 -- If not in optimizing mode, set flag and we are done. We are also done
4673 -- (and just set the flag) if the type is not a discrete type, since it
4674 -- is not worth the effort to eliminate checks for other than discrete
4675 -- types. In addition, we take this same path if we have stored the
4676 -- maximum number of checks possible already (a very unlikely situation,
4677 -- but we do not want to blow up!)
4679 if Optimization_Level = 0
4680 or else not Is_Discrete_Type (Etype (N))
4681 or else Num_Saved_Checks = Saved_Checks'Last
4682 then
4683 Activate_Overflow_Check (N);
4685 if Debug_Flag_CC then
4686 w ("Optimization off");
4687 end if;
4689 return;
4690 end if;
4692 -- Otherwise evaluate and check the expression
4694 Find_Check
4695 (Expr => N,
4696 Check_Type => 'O',
4697 Target_Type => Empty,
4698 Entry_OK => OK,
4699 Check_Num => Chk,
4700 Ent => Ent,
4701 Ofs => Ofs);
4703 if Debug_Flag_CC then
4704 w ("Called Find_Check");
4705 w (" OK = ", OK);
4707 if OK then
4708 w (" Check_Num = ", Chk);
4709 w (" Ent = ", Int (Ent));
4710 Write_Str (" Ofs = ");
4711 pid (Ofs);
4712 end if;
4713 end if;
4715 -- If check is not of form to optimize, then set flag and we are done
4717 if not OK then
4718 Activate_Overflow_Check (N);
4719 return;
4720 end if;
4722 -- If check is already performed, then return without setting flag
4724 if Chk /= 0 then
4725 if Debug_Flag_CC then
4726 w ("Check suppressed!");
4727 end if;
4729 return;
4730 end if;
4732 -- Here we will make a new entry for the new check
4734 Activate_Overflow_Check (N);
4735 Num_Saved_Checks := Num_Saved_Checks + 1;
4736 Saved_Checks (Num_Saved_Checks) :=
4737 (Killed => False,
4738 Entity => Ent,
4739 Offset => Ofs,
4740 Check_Type => 'O',
4741 Target_Type => Empty);
4743 if Debug_Flag_CC then
4744 w ("Make new entry, check number = ", Num_Saved_Checks);
4745 w (" Entity = ", Int (Ent));
4746 Write_Str (" Offset = ");
4747 pid (Ofs);
4748 w (" Check_Type = O");
4749 w (" Target_Type = Empty");
4750 end if;
4752 -- If we get an exception, then something went wrong, probably because of
4753 -- an error in the structure of the tree due to an incorrect program. Or it
4754 -- may be a bug in the optimization circuit. In either case the safest
4755 -- thing is simply to set the check flag unconditionally.
4757 exception
4758 when others =>
4759 Activate_Overflow_Check (N);
4761 if Debug_Flag_CC then
4762 w (" exception occurred, overflow flag set");
4763 end if;
4765 return;
4766 end Enable_Overflow_Check;
4768 ------------------------
4769 -- Enable_Range_Check --
4770 ------------------------
4772 procedure Enable_Range_Check (N : Node_Id) is
4773 Chk : Nat;
4774 OK : Boolean;
4775 Ent : Entity_Id;
4776 Ofs : Uint;
4777 Ttyp : Entity_Id;
4778 P : Node_Id;
4780 begin
4781 -- Return if unchecked type conversion with range check killed. In this
4782 -- case we never set the flag (that's what Kill_Range_Check is about!)
4784 if Nkind (N) = N_Unchecked_Type_Conversion
4785 and then Kill_Range_Check (N)
4786 then
4787 return;
4788 end if;
4790 -- Do not set range check flag if parent is assignment statement or
4791 -- object declaration with Suppress_Assignment_Checks flag set
4793 if Nkind_In (Parent (N), N_Assignment_Statement, N_Object_Declaration)
4794 and then Suppress_Assignment_Checks (Parent (N))
4795 then
4796 return;
4797 end if;
4799 -- Check for various cases where we should suppress the range check
4801 -- No check if range checks suppressed for type of node
4803 if Present (Etype (N))
4804 and then Range_Checks_Suppressed (Etype (N))
4805 then
4806 return;
4808 -- No check if node is an entity name, and range checks are suppressed
4809 -- for this entity, or for the type of this entity.
4811 elsif Is_Entity_Name (N)
4812 and then (Range_Checks_Suppressed (Entity (N))
4813 or else Range_Checks_Suppressed (Etype (Entity (N))))
4814 then
4815 return;
4817 -- No checks if index of array, and index checks are suppressed for
4818 -- the array object or the type of the array.
4820 elsif Nkind (Parent (N)) = N_Indexed_Component then
4821 declare
4822 Pref : constant Node_Id := Prefix (Parent (N));
4823 begin
4824 if Is_Entity_Name (Pref)
4825 and then Index_Checks_Suppressed (Entity (Pref))
4826 then
4827 return;
4828 elsif Index_Checks_Suppressed (Etype (Pref)) then
4829 return;
4830 end if;
4831 end;
4832 end if;
4834 -- Debug trace output
4836 if Debug_Flag_CC then
4837 w ("Enable_Range_Check for node ", Int (N));
4838 Write_Str (" Source location = ");
4839 wl (Sloc (N));
4840 pg (Union_Id (N));
4841 end if;
4843 -- If not in optimizing mode, set flag and we are done. We are also done
4844 -- (and just set the flag) if the type is not a discrete type, since it
4845 -- is not worth the effort to eliminate checks for other than discrete
4846 -- types. In addition, we take this same path if we have stored the
4847 -- maximum number of checks possible already (a very unlikely situation,
4848 -- but we do not want to blow up!)
4850 if Optimization_Level = 0
4851 or else No (Etype (N))
4852 or else not Is_Discrete_Type (Etype (N))
4853 or else Num_Saved_Checks = Saved_Checks'Last
4854 then
4855 Activate_Range_Check (N);
4857 if Debug_Flag_CC then
4858 w ("Optimization off");
4859 end if;
4861 return;
4862 end if;
4864 -- Otherwise find out the target type
4866 P := Parent (N);
4868 -- For assignment, use left side subtype
4870 if Nkind (P) = N_Assignment_Statement
4871 and then Expression (P) = N
4872 then
4873 Ttyp := Etype (Name (P));
4875 -- For indexed component, use subscript subtype
4877 elsif Nkind (P) = N_Indexed_Component then
4878 declare
4879 Atyp : Entity_Id;
4880 Indx : Node_Id;
4881 Subs : Node_Id;
4883 begin
4884 Atyp := Etype (Prefix (P));
4886 if Is_Access_Type (Atyp) then
4887 Atyp := Designated_Type (Atyp);
4889 -- If the prefix is an access to an unconstrained array,
4890 -- perform check unconditionally: it depends on the bounds of
4891 -- an object and we cannot currently recognize whether the test
4892 -- may be redundant.
4894 if not Is_Constrained (Atyp) then
4895 Activate_Range_Check (N);
4896 return;
4897 end if;
4899 -- Ditto if the prefix is an explicit dereference whose designated
4900 -- type is unconstrained.
4902 elsif Nkind (Prefix (P)) = N_Explicit_Dereference
4903 and then not Is_Constrained (Atyp)
4904 then
4905 Activate_Range_Check (N);
4906 return;
4907 end if;
4909 Indx := First_Index (Atyp);
4910 Subs := First (Expressions (P));
4911 loop
4912 if Subs = N then
4913 Ttyp := Etype (Indx);
4914 exit;
4915 end if;
4917 Next_Index (Indx);
4918 Next (Subs);
4919 end loop;
4920 end;
4922 -- For now, ignore all other cases, they are not so interesting
4924 else
4925 if Debug_Flag_CC then
4926 w (" target type not found, flag set");
4927 end if;
4929 Activate_Range_Check (N);
4930 return;
4931 end if;
4933 -- Evaluate and check the expression
4935 Find_Check
4936 (Expr => N,
4937 Check_Type => 'R',
4938 Target_Type => Ttyp,
4939 Entry_OK => OK,
4940 Check_Num => Chk,
4941 Ent => Ent,
4942 Ofs => Ofs);
4944 if Debug_Flag_CC then
4945 w ("Called Find_Check");
4946 w ("Target_Typ = ", Int (Ttyp));
4947 w (" OK = ", OK);
4949 if OK then
4950 w (" Check_Num = ", Chk);
4951 w (" Ent = ", Int (Ent));
4952 Write_Str (" Ofs = ");
4953 pid (Ofs);
4954 end if;
4955 end if;
4957 -- If check is not of form to optimize, then set flag and we are done
4959 if not OK then
4960 if Debug_Flag_CC then
4961 w (" expression not of optimizable type, flag set");
4962 end if;
4964 Activate_Range_Check (N);
4965 return;
4966 end if;
4968 -- If check is already performed, then return without setting flag
4970 if Chk /= 0 then
4971 if Debug_Flag_CC then
4972 w ("Check suppressed!");
4973 end if;
4975 return;
4976 end if;
4978 -- Here we will make a new entry for the new check
4980 Activate_Range_Check (N);
4981 Num_Saved_Checks := Num_Saved_Checks + 1;
4982 Saved_Checks (Num_Saved_Checks) :=
4983 (Killed => False,
4984 Entity => Ent,
4985 Offset => Ofs,
4986 Check_Type => 'R',
4987 Target_Type => Ttyp);
4989 if Debug_Flag_CC then
4990 w ("Make new entry, check number = ", Num_Saved_Checks);
4991 w (" Entity = ", Int (Ent));
4992 Write_Str (" Offset = ");
4993 pid (Ofs);
4994 w (" Check_Type = R");
4995 w (" Target_Type = ", Int (Ttyp));
4996 pg (Union_Id (Ttyp));
4997 end if;
4999 -- If we get an exception, then something went wrong, probably because of
5000 -- an error in the structure of the tree due to an incorrect program. Or
5001 -- it may be a bug in the optimization circuit. In either case the safest
5002 -- thing is simply to set the check flag unconditionally.
5004 exception
5005 when others =>
5006 Activate_Range_Check (N);
5008 if Debug_Flag_CC then
5009 w (" exception occurred, range flag set");
5010 end if;
5012 return;
5013 end Enable_Range_Check;
5015 ------------------
5016 -- Ensure_Valid --
5017 ------------------
5019 procedure Ensure_Valid (Expr : Node_Id; Holes_OK : Boolean := False) is
5020 Typ : constant Entity_Id := Etype (Expr);
5022 begin
5023 -- Ignore call if we are not doing any validity checking
5025 if not Validity_Checks_On then
5026 return;
5028 -- Ignore call if range or validity checks suppressed on entity or type
5030 elsif Range_Or_Validity_Checks_Suppressed (Expr) then
5031 return;
5033 -- No check required if expression is from the expander, we assume the
5034 -- expander will generate whatever checks are needed. Note that this is
5035 -- not just an optimization, it avoids infinite recursions!
5037 -- Unchecked conversions must be checked, unless they are initialized
5038 -- scalar values, as in a component assignment in an init proc.
5040 -- In addition, we force a check if Force_Validity_Checks is set
5042 elsif not Comes_From_Source (Expr)
5043 and then not Force_Validity_Checks
5044 and then (Nkind (Expr) /= N_Unchecked_Type_Conversion
5045 or else Kill_Range_Check (Expr))
5046 then
5047 return;
5049 -- No check required if expression is known to have valid value
5051 elsif Expr_Known_Valid (Expr) then
5052 return;
5054 -- Ignore case of enumeration with holes where the flag is set not to
5055 -- worry about holes, since no special validity check is needed
5057 elsif Is_Enumeration_Type (Typ)
5058 and then Has_Non_Standard_Rep (Typ)
5059 and then Holes_OK
5060 then
5061 return;
5063 -- No check required on the left-hand side of an assignment
5065 elsif Nkind (Parent (Expr)) = N_Assignment_Statement
5066 and then Expr = Name (Parent (Expr))
5067 then
5068 return;
5070 -- No check on a universal real constant. The context will eventually
5071 -- convert it to a machine number for some target type, or report an
5072 -- illegality.
5074 elsif Nkind (Expr) = N_Real_Literal
5075 and then Etype (Expr) = Universal_Real
5076 then
5077 return;
5079 -- If the expression denotes a component of a packed boolean array,
5080 -- no possible check applies. We ignore the old ACATS chestnuts that
5081 -- involve Boolean range True..True.
5083 -- Note: validity checks are generated for expressions that yield a
5084 -- scalar type, when it is possible to create a value that is outside of
5085 -- the type. If this is a one-bit boolean no such value exists. This is
5086 -- an optimization, and it also prevents compiler blowing up during the
5087 -- elaboration of improperly expanded packed array references.
5089 elsif Nkind (Expr) = N_Indexed_Component
5090 and then Is_Bit_Packed_Array (Etype (Prefix (Expr)))
5091 and then Root_Type (Etype (Expr)) = Standard_Boolean
5092 then
5093 return;
5095 -- For an expression with actions, we want to insert the validity check
5096 -- on the final Expression.
5098 elsif Nkind (Expr) = N_Expression_With_Actions then
5099 Ensure_Valid (Expression (Expr));
5100 return;
5102 -- An annoying special case. If this is an out parameter of a scalar
5103 -- type, then the value is not going to be accessed, therefore it is
5104 -- inappropriate to do any validity check at the call site.
5106 else
5107 -- Only need to worry about scalar types
5109 if Is_Scalar_Type (Typ) then
5110 declare
5111 P : Node_Id;
5112 N : Node_Id;
5113 E : Entity_Id;
5114 F : Entity_Id;
5115 A : Node_Id;
5116 L : List_Id;
5118 begin
5119 -- Find actual argument (which may be a parameter association)
5120 -- and the parent of the actual argument (the call statement)
5122 N := Expr;
5123 P := Parent (Expr);
5125 if Nkind (P) = N_Parameter_Association then
5126 N := P;
5127 P := Parent (N);
5128 end if;
5130 -- Only need to worry if we are argument of a procedure call
5131 -- since functions don't have out parameters. If this is an
5132 -- indirect or dispatching call, get signature from the
5133 -- subprogram type.
5135 if Nkind (P) = N_Procedure_Call_Statement then
5136 L := Parameter_Associations (P);
5138 if Is_Entity_Name (Name (P)) then
5139 E := Entity (Name (P));
5140 else
5141 pragma Assert (Nkind (Name (P)) = N_Explicit_Dereference);
5142 E := Etype (Name (P));
5143 end if;
5145 -- Only need to worry if there are indeed actuals, and if
5146 -- this could be a procedure call, otherwise we cannot get a
5147 -- match (either we are not an argument, or the mode of the
5148 -- formal is not OUT). This test also filters out the
5149 -- generic case.
5151 if Is_Non_Empty_List (L)
5152 and then Is_Subprogram (E)
5153 then
5154 -- This is the loop through parameters, looking for an
5155 -- OUT parameter for which we are the argument.
5157 F := First_Formal (E);
5158 A := First (L);
5159 while Present (F) loop
5160 if Ekind (F) = E_Out_Parameter and then A = N then
5161 return;
5162 end if;
5164 Next_Formal (F);
5165 Next (A);
5166 end loop;
5167 end if;
5168 end if;
5169 end;
5170 end if;
5171 end if;
5173 -- If this is a boolean expression, only its elementary operands need
5174 -- checking: if they are valid, a boolean or short-circuit operation
5175 -- with them will be valid as well.
5177 if Base_Type (Typ) = Standard_Boolean
5178 and then
5179 (Nkind (Expr) in N_Op or else Nkind (Expr) in N_Short_Circuit)
5180 then
5181 return;
5182 end if;
5184 -- If we fall through, a validity check is required
5186 Insert_Valid_Check (Expr);
5188 if Is_Entity_Name (Expr)
5189 and then Safe_To_Capture_Value (Expr, Entity (Expr))
5190 then
5191 Set_Is_Known_Valid (Entity (Expr));
5192 end if;
5193 end Ensure_Valid;
5195 ----------------------
5196 -- Expr_Known_Valid --
5197 ----------------------
5199 function Expr_Known_Valid (Expr : Node_Id) return Boolean is
5200 Typ : constant Entity_Id := Etype (Expr);
5202 begin
5203 -- Non-scalar types are always considered valid, since they never give
5204 -- rise to the issues of erroneous or bounded error behavior that are
5205 -- the concern. In formal reference manual terms the notion of validity
5206 -- only applies to scalar types. Note that even when packed arrays are
5207 -- represented using modular types, they are still arrays semantically,
5208 -- so they are also always valid (in particular, the unused bits can be
5209 -- random rubbish without affecting the validity of the array value).
5211 if not Is_Scalar_Type (Typ) or else Is_Packed_Array_Type (Typ) then
5212 return True;
5214 -- If no validity checking, then everything is considered valid
5216 elsif not Validity_Checks_On then
5217 return True;
5219 -- Floating-point types are considered valid unless floating-point
5220 -- validity checks have been specifically turned on.
5222 elsif Is_Floating_Point_Type (Typ)
5223 and then not Validity_Check_Floating_Point
5224 then
5225 return True;
5227 -- If the expression is the value of an object that is known to be
5228 -- valid, then clearly the expression value itself is valid.
5230 elsif Is_Entity_Name (Expr)
5231 and then Is_Known_Valid (Entity (Expr))
5232 then
5233 return True;
5235 -- References to discriminants are always considered valid. The value
5236 -- of a discriminant gets checked when the object is built. Within the
5237 -- record, we consider it valid, and it is important to do so, since
5238 -- otherwise we can try to generate bogus validity checks which
5239 -- reference discriminants out of scope. Discriminants of concurrent
5240 -- types are excluded for the same reason.
5242 elsif Is_Entity_Name (Expr)
5243 and then Denotes_Discriminant (Expr, Check_Concurrent => True)
5244 then
5245 return True;
5247 -- If the type is one for which all values are known valid, then we are
5248 -- sure that the value is valid except in the slightly odd case where
5249 -- the expression is a reference to a variable whose size has been
5250 -- explicitly set to a value greater than the object size.
5252 elsif Is_Known_Valid (Typ) then
5253 if Is_Entity_Name (Expr)
5254 and then Ekind (Entity (Expr)) = E_Variable
5255 and then Esize (Entity (Expr)) > Esize (Typ)
5256 then
5257 return False;
5258 else
5259 return True;
5260 end if;
5262 -- Integer and character literals always have valid values, where
5263 -- appropriate these will be range checked in any case.
5265 elsif Nkind (Expr) = N_Integer_Literal
5266 or else
5267 Nkind (Expr) = N_Character_Literal
5268 then
5269 return True;
5271 -- Real literals are assumed to be valid in VM targets
5273 elsif VM_Target /= No_VM
5274 and then Nkind (Expr) = N_Real_Literal
5275 then
5276 return True;
5278 -- If we have a type conversion or a qualification of a known valid
5279 -- value, then the result will always be valid.
5281 elsif Nkind (Expr) = N_Type_Conversion
5282 or else
5283 Nkind (Expr) = N_Qualified_Expression
5284 then
5285 return Expr_Known_Valid (Expression (Expr));
5287 -- The result of any operator is always considered valid, since we
5288 -- assume the necessary checks are done by the operator. For operators
5289 -- on floating-point operations, we must also check when the operation
5290 -- is the right-hand side of an assignment, or is an actual in a call.
5292 elsif Nkind (Expr) in N_Op then
5293 if Is_Floating_Point_Type (Typ)
5294 and then Validity_Check_Floating_Point
5295 and then
5296 (Nkind (Parent (Expr)) = N_Assignment_Statement
5297 or else Nkind (Parent (Expr)) = N_Function_Call
5298 or else Nkind (Parent (Expr)) = N_Parameter_Association)
5299 then
5300 return False;
5301 else
5302 return True;
5303 end if;
5305 -- The result of a membership test is always valid, since it is true or
5306 -- false, there are no other possibilities.
5308 elsif Nkind (Expr) in N_Membership_Test then
5309 return True;
5311 -- For all other cases, we do not know the expression is valid
5313 else
5314 return False;
5315 end if;
5316 end Expr_Known_Valid;
5318 ----------------
5319 -- Find_Check --
5320 ----------------
5322 procedure Find_Check
5323 (Expr : Node_Id;
5324 Check_Type : Character;
5325 Target_Type : Entity_Id;
5326 Entry_OK : out Boolean;
5327 Check_Num : out Nat;
5328 Ent : out Entity_Id;
5329 Ofs : out Uint)
5331 function Within_Range_Of
5332 (Target_Type : Entity_Id;
5333 Check_Type : Entity_Id) return Boolean;
5334 -- Given a requirement for checking a range against Target_Type, and
5335 -- and a range Check_Type against which a check has already been made,
5336 -- determines if the check against check type is sufficient to ensure
5337 -- that no check against Target_Type is required.
5339 ---------------------
5340 -- Within_Range_Of --
5341 ---------------------
5343 function Within_Range_Of
5344 (Target_Type : Entity_Id;
5345 Check_Type : Entity_Id) return Boolean
5347 begin
5348 if Target_Type = Check_Type then
5349 return True;
5351 else
5352 declare
5353 Tlo : constant Node_Id := Type_Low_Bound (Target_Type);
5354 Thi : constant Node_Id := Type_High_Bound (Target_Type);
5355 Clo : constant Node_Id := Type_Low_Bound (Check_Type);
5356 Chi : constant Node_Id := Type_High_Bound (Check_Type);
5358 begin
5359 if (Tlo = Clo
5360 or else (Compile_Time_Known_Value (Tlo)
5361 and then
5362 Compile_Time_Known_Value (Clo)
5363 and then
5364 Expr_Value (Clo) >= Expr_Value (Tlo)))
5365 and then
5366 (Thi = Chi
5367 or else (Compile_Time_Known_Value (Thi)
5368 and then
5369 Compile_Time_Known_Value (Chi)
5370 and then
5371 Expr_Value (Chi) <= Expr_Value (Clo)))
5372 then
5373 return True;
5374 else
5375 return False;
5376 end if;
5377 end;
5378 end if;
5379 end Within_Range_Of;
5381 -- Start of processing for Find_Check
5383 begin
5384 -- Establish default, in case no entry is found
5386 Check_Num := 0;
5388 -- Case of expression is simple entity reference
5390 if Is_Entity_Name (Expr) then
5391 Ent := Entity (Expr);
5392 Ofs := Uint_0;
5394 -- Case of expression is entity + known constant
5396 elsif Nkind (Expr) = N_Op_Add
5397 and then Compile_Time_Known_Value (Right_Opnd (Expr))
5398 and then Is_Entity_Name (Left_Opnd (Expr))
5399 then
5400 Ent := Entity (Left_Opnd (Expr));
5401 Ofs := Expr_Value (Right_Opnd (Expr));
5403 -- Case of expression is entity - known constant
5405 elsif Nkind (Expr) = N_Op_Subtract
5406 and then Compile_Time_Known_Value (Right_Opnd (Expr))
5407 and then Is_Entity_Name (Left_Opnd (Expr))
5408 then
5409 Ent := Entity (Left_Opnd (Expr));
5410 Ofs := UI_Negate (Expr_Value (Right_Opnd (Expr)));
5412 -- Any other expression is not of the right form
5414 else
5415 Ent := Empty;
5416 Ofs := Uint_0;
5417 Entry_OK := False;
5418 return;
5419 end if;
5421 -- Come here with expression of appropriate form, check if entity is an
5422 -- appropriate one for our purposes.
5424 if (Ekind (Ent) = E_Variable
5425 or else Is_Constant_Object (Ent))
5426 and then not Is_Library_Level_Entity (Ent)
5427 then
5428 Entry_OK := True;
5429 else
5430 Entry_OK := False;
5431 return;
5432 end if;
5434 -- See if there is matching check already
5436 for J in reverse 1 .. Num_Saved_Checks loop
5437 declare
5438 SC : Saved_Check renames Saved_Checks (J);
5440 begin
5441 if SC.Killed = False
5442 and then SC.Entity = Ent
5443 and then SC.Offset = Ofs
5444 and then SC.Check_Type = Check_Type
5445 and then Within_Range_Of (Target_Type, SC.Target_Type)
5446 then
5447 Check_Num := J;
5448 return;
5449 end if;
5450 end;
5451 end loop;
5453 -- If we fall through entry was not found
5455 return;
5456 end Find_Check;
5458 ---------------------------------
5459 -- Generate_Discriminant_Check --
5460 ---------------------------------
5462 -- Note: the code for this procedure is derived from the
5463 -- Emit_Discriminant_Check Routine in trans.c.
5465 procedure Generate_Discriminant_Check (N : Node_Id) is
5466 Loc : constant Source_Ptr := Sloc (N);
5467 Pref : constant Node_Id := Prefix (N);
5468 Sel : constant Node_Id := Selector_Name (N);
5470 Orig_Comp : constant Entity_Id :=
5471 Original_Record_Component (Entity (Sel));
5472 -- The original component to be checked
5474 Discr_Fct : constant Entity_Id :=
5475 Discriminant_Checking_Func (Orig_Comp);
5476 -- The discriminant checking function
5478 Discr : Entity_Id;
5479 -- One discriminant to be checked in the type
5481 Real_Discr : Entity_Id;
5482 -- Actual discriminant in the call
5484 Pref_Type : Entity_Id;
5485 -- Type of relevant prefix (ignoring private/access stuff)
5487 Args : List_Id;
5488 -- List of arguments for function call
5490 Formal : Entity_Id;
5491 -- Keep track of the formal corresponding to the actual we build for
5492 -- each discriminant, in order to be able to perform the necessary type
5493 -- conversions.
5495 Scomp : Node_Id;
5496 -- Selected component reference for checking function argument
5498 begin
5499 Pref_Type := Etype (Pref);
5501 -- Force evaluation of the prefix, so that it does not get evaluated
5502 -- twice (once for the check, once for the actual reference). Such a
5503 -- double evaluation is always a potential source of inefficiency,
5504 -- and is functionally incorrect in the volatile case, or when the
5505 -- prefix may have side-effects. An entity or a component of an
5506 -- entity requires no evaluation.
5508 if Is_Entity_Name (Pref) then
5509 if Treat_As_Volatile (Entity (Pref)) then
5510 Force_Evaluation (Pref, Name_Req => True);
5511 end if;
5513 elsif Treat_As_Volatile (Etype (Pref)) then
5514 Force_Evaluation (Pref, Name_Req => True);
5516 elsif Nkind (Pref) = N_Selected_Component
5517 and then Is_Entity_Name (Prefix (Pref))
5518 then
5519 null;
5521 else
5522 Force_Evaluation (Pref, Name_Req => True);
5523 end if;
5525 -- For a tagged type, use the scope of the original component to
5526 -- obtain the type, because ???
5528 if Is_Tagged_Type (Scope (Orig_Comp)) then
5529 Pref_Type := Scope (Orig_Comp);
5531 -- For an untagged derived type, use the discriminants of the parent
5532 -- which have been renamed in the derivation, possibly by a one-to-many
5533 -- discriminant constraint. For non-tagged type, initially get the Etype
5534 -- of the prefix
5536 else
5537 if Is_Derived_Type (Pref_Type)
5538 and then Number_Discriminants (Pref_Type) /=
5539 Number_Discriminants (Etype (Base_Type (Pref_Type)))
5540 then
5541 Pref_Type := Etype (Base_Type (Pref_Type));
5542 end if;
5543 end if;
5545 -- We definitely should have a checking function, This routine should
5546 -- not be called if no discriminant checking function is present.
5548 pragma Assert (Present (Discr_Fct));
5550 -- Create the list of the actual parameters for the call. This list
5551 -- is the list of the discriminant fields of the record expression to
5552 -- be discriminant checked.
5554 Args := New_List;
5555 Formal := First_Formal (Discr_Fct);
5556 Discr := First_Discriminant (Pref_Type);
5557 while Present (Discr) loop
5559 -- If we have a corresponding discriminant field, and a parent
5560 -- subtype is present, then we want to use the corresponding
5561 -- discriminant since this is the one with the useful value.
5563 if Present (Corresponding_Discriminant (Discr))
5564 and then Ekind (Pref_Type) = E_Record_Type
5565 and then Present (Parent_Subtype (Pref_Type))
5566 then
5567 Real_Discr := Corresponding_Discriminant (Discr);
5568 else
5569 Real_Discr := Discr;
5570 end if;
5572 -- Construct the reference to the discriminant
5574 Scomp :=
5575 Make_Selected_Component (Loc,
5576 Prefix =>
5577 Unchecked_Convert_To (Pref_Type,
5578 Duplicate_Subexpr (Pref)),
5579 Selector_Name => New_Occurrence_Of (Real_Discr, Loc));
5581 -- Manually analyze and resolve this selected component. We really
5582 -- want it just as it appears above, and do not want the expander
5583 -- playing discriminal games etc with this reference. Then we append
5584 -- the argument to the list we are gathering.
5586 Set_Etype (Scomp, Etype (Real_Discr));
5587 Set_Analyzed (Scomp, True);
5588 Append_To (Args, Convert_To (Etype (Formal), Scomp));
5590 Next_Formal_With_Extras (Formal);
5591 Next_Discriminant (Discr);
5592 end loop;
5594 -- Now build and insert the call
5596 Insert_Action (N,
5597 Make_Raise_Constraint_Error (Loc,
5598 Condition =>
5599 Make_Function_Call (Loc,
5600 Name => New_Occurrence_Of (Discr_Fct, Loc),
5601 Parameter_Associations => Args),
5602 Reason => CE_Discriminant_Check_Failed));
5603 end Generate_Discriminant_Check;
5605 ---------------------------
5606 -- Generate_Index_Checks --
5607 ---------------------------
5609 procedure Generate_Index_Checks (N : Node_Id) is
5611 function Entity_Of_Prefix return Entity_Id;
5612 -- Returns the entity of the prefix of N (or Empty if not found)
5614 ----------------------
5615 -- Entity_Of_Prefix --
5616 ----------------------
5618 function Entity_Of_Prefix return Entity_Id is
5619 P : Node_Id;
5621 begin
5622 P := Prefix (N);
5623 while not Is_Entity_Name (P) loop
5624 if not Nkind_In (P, N_Selected_Component,
5625 N_Indexed_Component)
5626 then
5627 return Empty;
5628 end if;
5630 P := Prefix (P);
5631 end loop;
5633 return Entity (P);
5634 end Entity_Of_Prefix;
5636 -- Local variables
5638 Loc : constant Source_Ptr := Sloc (N);
5639 A : constant Node_Id := Prefix (N);
5640 A_Ent : constant Entity_Id := Entity_Of_Prefix;
5641 Sub : Node_Id;
5643 -- Start of processing for Generate_Index_Checks
5645 begin
5646 -- Ignore call if the prefix is not an array since we have a serious
5647 -- error in the sources. Ignore it also if index checks are suppressed
5648 -- for array object or type.
5650 if not Is_Array_Type (Etype (A))
5651 or else (Present (A_Ent)
5652 and then Index_Checks_Suppressed (A_Ent))
5653 or else Index_Checks_Suppressed (Etype (A))
5654 then
5655 return;
5657 -- The indexed component we are dealing with contains 'Loop_Entry in its
5658 -- prefix. This case arises when analysis has determined that constructs
5659 -- such as
5661 -- Prefix'Loop_Entry (Expr)
5662 -- Prefix'Loop_Entry (Expr1, Expr2, ... ExprN)
5664 -- require rewriting for error detection purposes. A side effect of this
5665 -- action is the generation of index checks that mention 'Loop_Entry.
5666 -- Delay the generation of the check until 'Loop_Entry has been properly
5667 -- expanded. This is done in Expand_Loop_Entry_Attributes.
5669 elsif Nkind (Prefix (N)) = N_Attribute_Reference
5670 and then Attribute_Name (Prefix (N)) = Name_Loop_Entry
5671 then
5672 return;
5673 end if;
5675 -- Generate a raise of constraint error with the appropriate reason and
5676 -- a condition of the form:
5678 -- Base_Type (Sub) not in Array'Range (Subscript)
5680 -- Note that the reason we generate the conversion to the base type here
5681 -- is that we definitely want the range check to take place, even if it
5682 -- looks like the subtype is OK. Optimization considerations that allow
5683 -- us to omit the check have already been taken into account in the
5684 -- setting of the Do_Range_Check flag earlier on.
5686 Sub := First (Expressions (N));
5688 -- Handle string literals
5690 if Ekind (Etype (A)) = E_String_Literal_Subtype then
5691 if Do_Range_Check (Sub) then
5692 Set_Do_Range_Check (Sub, False);
5694 -- For string literals we obtain the bounds of the string from the
5695 -- associated subtype.
5697 Insert_Action (N,
5698 Make_Raise_Constraint_Error (Loc,
5699 Condition =>
5700 Make_Not_In (Loc,
5701 Left_Opnd =>
5702 Convert_To (Base_Type (Etype (Sub)),
5703 Duplicate_Subexpr_Move_Checks (Sub)),
5704 Right_Opnd =>
5705 Make_Attribute_Reference (Loc,
5706 Prefix => New_Reference_To (Etype (A), Loc),
5707 Attribute_Name => Name_Range)),
5708 Reason => CE_Index_Check_Failed));
5709 end if;
5711 -- General case
5713 else
5714 declare
5715 A_Idx : Node_Id := Empty;
5716 A_Range : Node_Id;
5717 Ind : Nat;
5718 Num : List_Id;
5719 Range_N : Node_Id;
5721 begin
5722 A_Idx := First_Index (Etype (A));
5723 Ind := 1;
5724 while Present (Sub) loop
5725 if Do_Range_Check (Sub) then
5726 Set_Do_Range_Check (Sub, False);
5728 -- Force evaluation except for the case of a simple name of
5729 -- a non-volatile entity.
5731 if not Is_Entity_Name (Sub)
5732 or else Treat_As_Volatile (Entity (Sub))
5733 then
5734 Force_Evaluation (Sub);
5735 end if;
5737 if Nkind (A_Idx) = N_Range then
5738 A_Range := A_Idx;
5740 elsif Nkind (A_Idx) = N_Identifier
5741 or else Nkind (A_Idx) = N_Expanded_Name
5742 then
5743 A_Range := Scalar_Range (Entity (A_Idx));
5745 else pragma Assert (Nkind (A_Idx) = N_Subtype_Indication);
5746 A_Range := Range_Expression (Constraint (A_Idx));
5747 end if;
5749 -- For array objects with constant bounds we can generate
5750 -- the index check using the bounds of the type of the index
5752 if Present (A_Ent)
5753 and then Ekind (A_Ent) = E_Variable
5754 and then Is_Constant_Bound (Low_Bound (A_Range))
5755 and then Is_Constant_Bound (High_Bound (A_Range))
5756 then
5757 Range_N :=
5758 Make_Attribute_Reference (Loc,
5759 Prefix =>
5760 New_Reference_To (Etype (A_Idx), Loc),
5761 Attribute_Name => Name_Range);
5763 -- For arrays with non-constant bounds we cannot generate
5764 -- the index check using the bounds of the type of the index
5765 -- since it may reference discriminants of some enclosing
5766 -- type. We obtain the bounds directly from the prefix
5767 -- object.
5769 else
5770 if Ind = 1 then
5771 Num := No_List;
5772 else
5773 Num := New_List (Make_Integer_Literal (Loc, Ind));
5774 end if;
5776 Range_N :=
5777 Make_Attribute_Reference (Loc,
5778 Prefix =>
5779 Duplicate_Subexpr_Move_Checks (A, Name_Req => True),
5780 Attribute_Name => Name_Range,
5781 Expressions => Num);
5782 end if;
5784 Insert_Action (N,
5785 Make_Raise_Constraint_Error (Loc,
5786 Condition =>
5787 Make_Not_In (Loc,
5788 Left_Opnd =>
5789 Convert_To (Base_Type (Etype (Sub)),
5790 Duplicate_Subexpr_Move_Checks (Sub)),
5791 Right_Opnd => Range_N),
5792 Reason => CE_Index_Check_Failed));
5793 end if;
5795 A_Idx := Next_Index (A_Idx);
5796 Ind := Ind + 1;
5797 Next (Sub);
5798 end loop;
5799 end;
5800 end if;
5801 end Generate_Index_Checks;
5803 --------------------------
5804 -- Generate_Range_Check --
5805 --------------------------
5807 procedure Generate_Range_Check
5808 (N : Node_Id;
5809 Target_Type : Entity_Id;
5810 Reason : RT_Exception_Code)
5812 Loc : constant Source_Ptr := Sloc (N);
5813 Source_Type : constant Entity_Id := Etype (N);
5814 Source_Base_Type : constant Entity_Id := Base_Type (Source_Type);
5815 Target_Base_Type : constant Entity_Id := Base_Type (Target_Type);
5817 begin
5818 -- First special case, if the source type is already within the range
5819 -- of the target type, then no check is needed (probably we should have
5820 -- stopped Do_Range_Check from being set in the first place, but better
5821 -- late than never in preventing junk code!
5823 if In_Subrange_Of (Source_Type, Target_Type)
5825 -- We do NOT apply this if the source node is a literal, since in this
5826 -- case the literal has already been labeled as having the subtype of
5827 -- the target.
5829 and then not
5830 (Nkind_In (N, N_Integer_Literal, N_Real_Literal, N_Character_Literal)
5831 or else
5832 (Is_Entity_Name (N)
5833 and then Ekind (Entity (N)) = E_Enumeration_Literal))
5835 -- Also do not apply this for floating-point if Check_Float_Overflow
5837 and then not
5838 (Is_Floating_Point_Type (Source_Type) and Check_Float_Overflow)
5839 then
5840 return;
5841 end if;
5843 -- We need a check, so force evaluation of the node, so that it does
5844 -- not get evaluated twice (once for the check, once for the actual
5845 -- reference). Such a double evaluation is always a potential source
5846 -- of inefficiency, and is functionally incorrect in the volatile case.
5848 if not Is_Entity_Name (N) or else Treat_As_Volatile (Entity (N)) then
5849 Force_Evaluation (N);
5850 end if;
5852 -- The easiest case is when Source_Base_Type and Target_Base_Type are
5853 -- the same since in this case we can simply do a direct check of the
5854 -- value of N against the bounds of Target_Type.
5856 -- [constraint_error when N not in Target_Type]
5858 -- Note: this is by far the most common case, for example all cases of
5859 -- checks on the RHS of assignments are in this category, but not all
5860 -- cases are like this. Notably conversions can involve two types.
5862 if Source_Base_Type = Target_Base_Type then
5863 Insert_Action (N,
5864 Make_Raise_Constraint_Error (Loc,
5865 Condition =>
5866 Make_Not_In (Loc,
5867 Left_Opnd => Duplicate_Subexpr (N),
5868 Right_Opnd => New_Occurrence_Of (Target_Type, Loc)),
5869 Reason => Reason));
5871 -- Next test for the case where the target type is within the bounds
5872 -- of the base type of the source type, since in this case we can
5873 -- simply convert these bounds to the base type of T to do the test.
5875 -- [constraint_error when N not in
5876 -- Source_Base_Type (Target_Type'First)
5877 -- ..
5878 -- Source_Base_Type(Target_Type'Last))]
5880 -- The conversions will always work and need no check
5882 -- Unchecked_Convert_To is used instead of Convert_To to handle the case
5883 -- of converting from an enumeration value to an integer type, such as
5884 -- occurs for the case of generating a range check on Enum'Val(Exp)
5885 -- (which used to be handled by gigi). This is OK, since the conversion
5886 -- itself does not require a check.
5888 elsif In_Subrange_Of (Target_Type, Source_Base_Type) then
5889 Insert_Action (N,
5890 Make_Raise_Constraint_Error (Loc,
5891 Condition =>
5892 Make_Not_In (Loc,
5893 Left_Opnd => Duplicate_Subexpr (N),
5895 Right_Opnd =>
5896 Make_Range (Loc,
5897 Low_Bound =>
5898 Unchecked_Convert_To (Source_Base_Type,
5899 Make_Attribute_Reference (Loc,
5900 Prefix =>
5901 New_Occurrence_Of (Target_Type, Loc),
5902 Attribute_Name => Name_First)),
5904 High_Bound =>
5905 Unchecked_Convert_To (Source_Base_Type,
5906 Make_Attribute_Reference (Loc,
5907 Prefix =>
5908 New_Occurrence_Of (Target_Type, Loc),
5909 Attribute_Name => Name_Last)))),
5910 Reason => Reason));
5912 -- Note that at this stage we now that the Target_Base_Type is not in
5913 -- the range of the Source_Base_Type (since even the Target_Type itself
5914 -- is not in this range). It could still be the case that Source_Type is
5915 -- in range of the target base type since we have not checked that case.
5917 -- If that is the case, we can freely convert the source to the target,
5918 -- and then test the target result against the bounds.
5920 elsif In_Subrange_Of (Source_Type, Target_Base_Type) then
5922 -- We make a temporary to hold the value of the converted value
5923 -- (converted to the base type), and then we will do the test against
5924 -- this temporary.
5926 -- Tnn : constant Target_Base_Type := Target_Base_Type (N);
5927 -- [constraint_error when Tnn not in Target_Type]
5929 -- Then the conversion itself is replaced by an occurrence of Tnn
5931 declare
5932 Tnn : constant Entity_Id := Make_Temporary (Loc, 'T', N);
5934 begin
5935 Insert_Actions (N, New_List (
5936 Make_Object_Declaration (Loc,
5937 Defining_Identifier => Tnn,
5938 Object_Definition =>
5939 New_Occurrence_Of (Target_Base_Type, Loc),
5940 Constant_Present => True,
5941 Expression =>
5942 Make_Type_Conversion (Loc,
5943 Subtype_Mark => New_Occurrence_Of (Target_Base_Type, Loc),
5944 Expression => Duplicate_Subexpr (N))),
5946 Make_Raise_Constraint_Error (Loc,
5947 Condition =>
5948 Make_Not_In (Loc,
5949 Left_Opnd => New_Occurrence_Of (Tnn, Loc),
5950 Right_Opnd => New_Occurrence_Of (Target_Type, Loc)),
5952 Reason => Reason)));
5954 Rewrite (N, New_Occurrence_Of (Tnn, Loc));
5956 -- Set the type of N, because the declaration for Tnn might not
5957 -- be analyzed yet, as is the case if N appears within a record
5958 -- declaration, as a discriminant constraint or expression.
5960 Set_Etype (N, Target_Base_Type);
5961 end;
5963 -- At this stage, we know that we have two scalar types, which are
5964 -- directly convertible, and where neither scalar type has a base
5965 -- range that is in the range of the other scalar type.
5967 -- The only way this can happen is with a signed and unsigned type.
5968 -- So test for these two cases:
5970 else
5971 -- Case of the source is unsigned and the target is signed
5973 if Is_Unsigned_Type (Source_Base_Type)
5974 and then not Is_Unsigned_Type (Target_Base_Type)
5975 then
5976 -- If the source is unsigned and the target is signed, then we
5977 -- know that the source is not shorter than the target (otherwise
5978 -- the source base type would be in the target base type range).
5980 -- In other words, the unsigned type is either the same size as
5981 -- the target, or it is larger. It cannot be smaller.
5983 pragma Assert
5984 (Esize (Source_Base_Type) >= Esize (Target_Base_Type));
5986 -- We only need to check the low bound if the low bound of the
5987 -- target type is non-negative. If the low bound of the target
5988 -- type is negative, then we know that we will fit fine.
5990 -- If the high bound of the target type is negative, then we
5991 -- know we have a constraint error, since we can't possibly
5992 -- have a negative source.
5994 -- With these two checks out of the way, we can do the check
5995 -- using the source type safely
5997 -- This is definitely the most annoying case!
5999 -- [constraint_error
6000 -- when (Target_Type'First >= 0
6001 -- and then
6002 -- N < Source_Base_Type (Target_Type'First))
6003 -- or else Target_Type'Last < 0
6004 -- or else N > Source_Base_Type (Target_Type'Last)];
6006 -- We turn off all checks since we know that the conversions
6007 -- will work fine, given the guards for negative values.
6009 Insert_Action (N,
6010 Make_Raise_Constraint_Error (Loc,
6011 Condition =>
6012 Make_Or_Else (Loc,
6013 Make_Or_Else (Loc,
6014 Left_Opnd =>
6015 Make_And_Then (Loc,
6016 Left_Opnd => Make_Op_Ge (Loc,
6017 Left_Opnd =>
6018 Make_Attribute_Reference (Loc,
6019 Prefix =>
6020 New_Occurrence_Of (Target_Type, Loc),
6021 Attribute_Name => Name_First),
6022 Right_Opnd => Make_Integer_Literal (Loc, Uint_0)),
6024 Right_Opnd =>
6025 Make_Op_Lt (Loc,
6026 Left_Opnd => Duplicate_Subexpr (N),
6027 Right_Opnd =>
6028 Convert_To (Source_Base_Type,
6029 Make_Attribute_Reference (Loc,
6030 Prefix =>
6031 New_Occurrence_Of (Target_Type, Loc),
6032 Attribute_Name => Name_First)))),
6034 Right_Opnd =>
6035 Make_Op_Lt (Loc,
6036 Left_Opnd =>
6037 Make_Attribute_Reference (Loc,
6038 Prefix => New_Occurrence_Of (Target_Type, Loc),
6039 Attribute_Name => Name_Last),
6040 Right_Opnd => Make_Integer_Literal (Loc, Uint_0))),
6042 Right_Opnd =>
6043 Make_Op_Gt (Loc,
6044 Left_Opnd => Duplicate_Subexpr (N),
6045 Right_Opnd =>
6046 Convert_To (Source_Base_Type,
6047 Make_Attribute_Reference (Loc,
6048 Prefix => New_Occurrence_Of (Target_Type, Loc),
6049 Attribute_Name => Name_Last)))),
6051 Reason => Reason),
6052 Suppress => All_Checks);
6054 -- Only remaining possibility is that the source is signed and
6055 -- the target is unsigned.
6057 else
6058 pragma Assert (not Is_Unsigned_Type (Source_Base_Type)
6059 and then Is_Unsigned_Type (Target_Base_Type));
6061 -- If the source is signed and the target is unsigned, then we
6062 -- know that the target is not shorter than the source (otherwise
6063 -- the target base type would be in the source base type range).
6065 -- In other words, the unsigned type is either the same size as
6066 -- the target, or it is larger. It cannot be smaller.
6068 -- Clearly we have an error if the source value is negative since
6069 -- no unsigned type can have negative values. If the source type
6070 -- is non-negative, then the check can be done using the target
6071 -- type.
6073 -- Tnn : constant Target_Base_Type (N) := Target_Type;
6075 -- [constraint_error
6076 -- when N < 0 or else Tnn not in Target_Type];
6078 -- We turn off all checks for the conversion of N to the target
6079 -- base type, since we generate the explicit check to ensure that
6080 -- the value is non-negative
6082 declare
6083 Tnn : constant Entity_Id := Make_Temporary (Loc, 'T', N);
6085 begin
6086 Insert_Actions (N, New_List (
6087 Make_Object_Declaration (Loc,
6088 Defining_Identifier => Tnn,
6089 Object_Definition =>
6090 New_Occurrence_Of (Target_Base_Type, Loc),
6091 Constant_Present => True,
6092 Expression =>
6093 Make_Unchecked_Type_Conversion (Loc,
6094 Subtype_Mark =>
6095 New_Occurrence_Of (Target_Base_Type, Loc),
6096 Expression => Duplicate_Subexpr (N))),
6098 Make_Raise_Constraint_Error (Loc,
6099 Condition =>
6100 Make_Or_Else (Loc,
6101 Left_Opnd =>
6102 Make_Op_Lt (Loc,
6103 Left_Opnd => Duplicate_Subexpr (N),
6104 Right_Opnd => Make_Integer_Literal (Loc, Uint_0)),
6106 Right_Opnd =>
6107 Make_Not_In (Loc,
6108 Left_Opnd => New_Occurrence_Of (Tnn, Loc),
6109 Right_Opnd =>
6110 New_Occurrence_Of (Target_Type, Loc))),
6112 Reason => Reason)),
6113 Suppress => All_Checks);
6115 -- Set the Etype explicitly, because Insert_Actions may have
6116 -- placed the declaration in the freeze list for an enclosing
6117 -- construct, and thus it is not analyzed yet.
6119 Set_Etype (Tnn, Target_Base_Type);
6120 Rewrite (N, New_Occurrence_Of (Tnn, Loc));
6121 end;
6122 end if;
6123 end if;
6124 end Generate_Range_Check;
6126 ------------------
6127 -- Get_Check_Id --
6128 ------------------
6130 function Get_Check_Id (N : Name_Id) return Check_Id is
6131 begin
6132 -- For standard check name, we can do a direct computation
6134 if N in First_Check_Name .. Last_Check_Name then
6135 return Check_Id (N - (First_Check_Name - 1));
6137 -- For non-standard names added by pragma Check_Name, search table
6139 else
6140 for J in All_Checks + 1 .. Check_Names.Last loop
6141 if Check_Names.Table (J) = N then
6142 return J;
6143 end if;
6144 end loop;
6145 end if;
6147 -- No matching name found
6149 return No_Check_Id;
6150 end Get_Check_Id;
6152 ---------------------
6153 -- Get_Discriminal --
6154 ---------------------
6156 function Get_Discriminal (E : Entity_Id; Bound : Node_Id) return Node_Id is
6157 Loc : constant Source_Ptr := Sloc (E);
6158 D : Entity_Id;
6159 Sc : Entity_Id;
6161 begin
6162 -- The bound can be a bona fide parameter of a protected operation,
6163 -- rather than a prival encoded as an in-parameter.
6165 if No (Discriminal_Link (Entity (Bound))) then
6166 return Bound;
6167 end if;
6169 -- Climb the scope stack looking for an enclosing protected type. If
6170 -- we run out of scopes, return the bound itself.
6172 Sc := Scope (E);
6173 while Present (Sc) loop
6174 if Sc = Standard_Standard then
6175 return Bound;
6177 elsif Ekind (Sc) = E_Protected_Type then
6178 exit;
6179 end if;
6181 Sc := Scope (Sc);
6182 end loop;
6184 D := First_Discriminant (Sc);
6185 while Present (D) loop
6186 if Chars (D) = Chars (Bound) then
6187 return New_Occurrence_Of (Discriminal (D), Loc);
6188 end if;
6190 Next_Discriminant (D);
6191 end loop;
6193 return Bound;
6194 end Get_Discriminal;
6196 ----------------------
6197 -- Get_Range_Checks --
6198 ----------------------
6200 function Get_Range_Checks
6201 (Ck_Node : Node_Id;
6202 Target_Typ : Entity_Id;
6203 Source_Typ : Entity_Id := Empty;
6204 Warn_Node : Node_Id := Empty) return Check_Result
6206 begin
6207 return Selected_Range_Checks
6208 (Ck_Node, Target_Typ, Source_Typ, Warn_Node);
6209 end Get_Range_Checks;
6211 ------------------
6212 -- Guard_Access --
6213 ------------------
6215 function Guard_Access
6216 (Cond : Node_Id;
6217 Loc : Source_Ptr;
6218 Ck_Node : Node_Id) return Node_Id
6220 begin
6221 if Nkind (Cond) = N_Or_Else then
6222 Set_Paren_Count (Cond, 1);
6223 end if;
6225 if Nkind (Ck_Node) = N_Allocator then
6226 return Cond;
6227 else
6228 return
6229 Make_And_Then (Loc,
6230 Left_Opnd =>
6231 Make_Op_Ne (Loc,
6232 Left_Opnd => Duplicate_Subexpr_No_Checks (Ck_Node),
6233 Right_Opnd => Make_Null (Loc)),
6234 Right_Opnd => Cond);
6235 end if;
6236 end Guard_Access;
6238 -----------------------------
6239 -- Index_Checks_Suppressed --
6240 -----------------------------
6242 function Index_Checks_Suppressed (E : Entity_Id) return Boolean is
6243 begin
6244 if Present (E) and then Checks_May_Be_Suppressed (E) then
6245 return Is_Check_Suppressed (E, Index_Check);
6246 else
6247 return Scope_Suppress.Suppress (Index_Check);
6248 end if;
6249 end Index_Checks_Suppressed;
6251 ----------------
6252 -- Initialize --
6253 ----------------
6255 procedure Initialize is
6256 begin
6257 for J in Determine_Range_Cache_N'Range loop
6258 Determine_Range_Cache_N (J) := Empty;
6259 end loop;
6261 Check_Names.Init;
6263 for J in Int range 1 .. All_Checks loop
6264 Check_Names.Append (Name_Id (Int (First_Check_Name) + J - 1));
6265 end loop;
6266 end Initialize;
6268 -------------------------
6269 -- Insert_Range_Checks --
6270 -------------------------
6272 procedure Insert_Range_Checks
6273 (Checks : Check_Result;
6274 Node : Node_Id;
6275 Suppress_Typ : Entity_Id;
6276 Static_Sloc : Source_Ptr := No_Location;
6277 Flag_Node : Node_Id := Empty;
6278 Do_Before : Boolean := False)
6280 Internal_Flag_Node : Node_Id := Flag_Node;
6281 Internal_Static_Sloc : Source_Ptr := Static_Sloc;
6283 Check_Node : Node_Id;
6284 Checks_On : constant Boolean :=
6285 (not Index_Checks_Suppressed (Suppress_Typ))
6286 or else (not Range_Checks_Suppressed (Suppress_Typ));
6288 begin
6289 -- For now we just return if Checks_On is false, however this should be
6290 -- enhanced to check for an always True value in the condition and to
6291 -- generate a compilation warning???
6293 if not Full_Expander_Active or else not Checks_On then
6294 return;
6295 end if;
6297 if Static_Sloc = No_Location then
6298 Internal_Static_Sloc := Sloc (Node);
6299 end if;
6301 if No (Flag_Node) then
6302 Internal_Flag_Node := Node;
6303 end if;
6305 for J in 1 .. 2 loop
6306 exit when No (Checks (J));
6308 if Nkind (Checks (J)) = N_Raise_Constraint_Error
6309 and then Present (Condition (Checks (J)))
6310 then
6311 if not Has_Dynamic_Range_Check (Internal_Flag_Node) then
6312 Check_Node := Checks (J);
6313 Mark_Rewrite_Insertion (Check_Node);
6315 if Do_Before then
6316 Insert_Before_And_Analyze (Node, Check_Node);
6317 else
6318 Insert_After_And_Analyze (Node, Check_Node);
6319 end if;
6321 Set_Has_Dynamic_Range_Check (Internal_Flag_Node);
6322 end if;
6324 else
6325 Check_Node :=
6326 Make_Raise_Constraint_Error (Internal_Static_Sloc,
6327 Reason => CE_Range_Check_Failed);
6328 Mark_Rewrite_Insertion (Check_Node);
6330 if Do_Before then
6331 Insert_Before_And_Analyze (Node, Check_Node);
6332 else
6333 Insert_After_And_Analyze (Node, Check_Node);
6334 end if;
6335 end if;
6336 end loop;
6337 end Insert_Range_Checks;
6339 ------------------------
6340 -- Insert_Valid_Check --
6341 ------------------------
6343 procedure Insert_Valid_Check (Expr : Node_Id) is
6344 Loc : constant Source_Ptr := Sloc (Expr);
6345 Typ : constant Entity_Id := Etype (Expr);
6346 Exp : Node_Id;
6348 begin
6349 -- Do not insert if checks off, or if not checking validity or
6350 -- if expression is known to be valid
6352 if not Validity_Checks_On
6353 or else Range_Or_Validity_Checks_Suppressed (Expr)
6354 or else Expr_Known_Valid (Expr)
6355 then
6356 return;
6357 end if;
6359 -- Do not insert checks within a predicate function. This will arise
6360 -- if the current unit and the predicate function are being compiled
6361 -- with validity checks enabled.
6363 if Present (Predicate_Function (Typ))
6364 and then Current_Scope = Predicate_Function (Typ)
6365 then
6366 return;
6367 end if;
6369 -- If we have a checked conversion, then validity check applies to
6370 -- the expression inside the conversion, not the result, since if
6371 -- the expression inside is valid, then so is the conversion result.
6373 Exp := Expr;
6374 while Nkind (Exp) = N_Type_Conversion loop
6375 Exp := Expression (Exp);
6376 end loop;
6378 -- We are about to insert the validity check for Exp. We save and
6379 -- reset the Do_Range_Check flag over this validity check, and then
6380 -- put it back for the final original reference (Exp may be rewritten).
6382 declare
6383 DRC : constant Boolean := Do_Range_Check (Exp);
6384 PV : Node_Id;
6385 CE : Node_Id;
6387 begin
6388 Set_Do_Range_Check (Exp, False);
6390 -- Force evaluation to avoid multiple reads for atomic/volatile
6392 if Is_Entity_Name (Exp)
6393 and then Is_Volatile (Entity (Exp))
6394 then
6395 Force_Evaluation (Exp, Name_Req => True);
6396 end if;
6398 -- Build the prefix for the 'Valid call
6400 PV := Duplicate_Subexpr_No_Checks (Exp, Name_Req => True);
6402 -- A rather specialized kludge. If PV is an analyzed expression
6403 -- which is an indexed component of a packed array that has not
6404 -- been properly expanded, turn off its Analyzed flag to make sure
6405 -- it gets properly reexpanded.
6407 -- The reason this arises is that Duplicate_Subexpr_No_Checks did
6408 -- an analyze with the old parent pointer. This may point e.g. to
6409 -- a subprogram call, which deactivates this expansion.
6411 if Analyzed (PV)
6412 and then Nkind (PV) = N_Indexed_Component
6413 and then Present (Packed_Array_Type (Etype (Prefix (PV))))
6414 then
6415 Set_Analyzed (PV, False);
6416 end if;
6418 -- Build the raise CE node to check for validity
6420 CE :=
6421 Make_Raise_Constraint_Error (Loc,
6422 Condition =>
6423 Make_Op_Not (Loc,
6424 Right_Opnd =>
6425 Make_Attribute_Reference (Loc,
6426 Prefix => PV,
6427 Attribute_Name => Name_Valid)),
6428 Reason => CE_Invalid_Data);
6430 -- Insert the validity check. Note that we do this with validity
6431 -- checks turned off, to avoid recursion, we do not want validity
6432 -- checks on the validity checking code itself!
6434 Insert_Action (Expr, CE, Suppress => Validity_Check);
6436 -- If the expression is a reference to an element of a bit-packed
6437 -- array, then it is rewritten as a renaming declaration. If the
6438 -- expression is an actual in a call, it has not been expanded,
6439 -- waiting for the proper point at which to do it. The same happens
6440 -- with renamings, so that we have to force the expansion now. This
6441 -- non-local complication is due to code in exp_ch2,adb, exp_ch4.adb
6442 -- and exp_ch6.adb.
6444 if Is_Entity_Name (Exp)
6445 and then Nkind (Parent (Entity (Exp))) =
6446 N_Object_Renaming_Declaration
6447 then
6448 declare
6449 Old_Exp : constant Node_Id := Name (Parent (Entity (Exp)));
6450 begin
6451 if Nkind (Old_Exp) = N_Indexed_Component
6452 and then Is_Bit_Packed_Array (Etype (Prefix (Old_Exp)))
6453 then
6454 Expand_Packed_Element_Reference (Old_Exp);
6455 end if;
6456 end;
6457 end if;
6459 -- Put back the Do_Range_Check flag on the resulting (possibly
6460 -- rewritten) expression.
6462 -- Note: it might be thought that a validity check is not required
6463 -- when a range check is present, but that's not the case, because
6464 -- the back end is allowed to assume for the range check that the
6465 -- operand is within its declared range (an assumption that validity
6466 -- checking is all about NOT assuming!)
6468 -- Note: no need to worry about Possible_Local_Raise here, it will
6469 -- already have been called if original node has Do_Range_Check set.
6471 Set_Do_Range_Check (Exp, DRC);
6472 end;
6473 end Insert_Valid_Check;
6475 -------------------------------------
6476 -- Is_Signed_Integer_Arithmetic_Op --
6477 -------------------------------------
6479 function Is_Signed_Integer_Arithmetic_Op (N : Node_Id) return Boolean is
6480 begin
6481 case Nkind (N) is
6482 when N_Op_Abs | N_Op_Add | N_Op_Divide | N_Op_Expon |
6483 N_Op_Minus | N_Op_Mod | N_Op_Multiply | N_Op_Plus |
6484 N_Op_Rem | N_Op_Subtract =>
6485 return Is_Signed_Integer_Type (Etype (N));
6487 when N_If_Expression | N_Case_Expression =>
6488 return Is_Signed_Integer_Type (Etype (N));
6490 when others =>
6491 return False;
6492 end case;
6493 end Is_Signed_Integer_Arithmetic_Op;
6495 ----------------------------------
6496 -- Install_Null_Excluding_Check --
6497 ----------------------------------
6499 procedure Install_Null_Excluding_Check (N : Node_Id) is
6500 Loc : constant Source_Ptr := Sloc (Parent (N));
6501 Typ : constant Entity_Id := Etype (N);
6503 function Safe_To_Capture_In_Parameter_Value return Boolean;
6504 -- Determines if it is safe to capture Known_Non_Null status for an
6505 -- the entity referenced by node N. The caller ensures that N is indeed
6506 -- an entity name. It is safe to capture the non-null status for an IN
6507 -- parameter when the reference occurs within a declaration that is sure
6508 -- to be executed as part of the declarative region.
6510 procedure Mark_Non_Null;
6511 -- After installation of check, if the node in question is an entity
6512 -- name, then mark this entity as non-null if possible.
6514 function Safe_To_Capture_In_Parameter_Value return Boolean is
6515 E : constant Entity_Id := Entity (N);
6516 S : constant Entity_Id := Current_Scope;
6517 S_Par : Node_Id;
6519 begin
6520 if Ekind (E) /= E_In_Parameter then
6521 return False;
6522 end if;
6524 -- Two initial context checks. We must be inside a subprogram body
6525 -- with declarations and reference must not appear in nested scopes.
6527 if (Ekind (S) /= E_Function and then Ekind (S) /= E_Procedure)
6528 or else Scope (E) /= S
6529 then
6530 return False;
6531 end if;
6533 S_Par := Parent (Parent (S));
6535 if Nkind (S_Par) /= N_Subprogram_Body
6536 or else No (Declarations (S_Par))
6537 then
6538 return False;
6539 end if;
6541 declare
6542 N_Decl : Node_Id;
6543 P : Node_Id;
6545 begin
6546 -- Retrieve the declaration node of N (if any). Note that N
6547 -- may be a part of a complex initialization expression.
6549 P := Parent (N);
6550 N_Decl := Empty;
6551 while Present (P) loop
6553 -- If we have a short circuit form, and we are within the right
6554 -- hand expression, we return false, since the right hand side
6555 -- is not guaranteed to be elaborated.
6557 if Nkind (P) in N_Short_Circuit
6558 and then N = Right_Opnd (P)
6559 then
6560 return False;
6561 end if;
6563 -- Similarly, if we are in an if expression and not part of the
6564 -- condition, then we return False, since neither the THEN or
6565 -- ELSE dependent expressions will always be elaborated.
6567 if Nkind (P) = N_If_Expression
6568 and then N /= First (Expressions (P))
6569 then
6570 return False;
6571 end if;
6573 -- If we are in a case expression, and not part of the
6574 -- expression, then we return False, since a particular
6575 -- dependent expression may not always be elaborated
6577 if Nkind (P) = N_Case_Expression
6578 and then N /= Expression (P)
6579 then
6580 return False;
6581 end if;
6583 -- While traversing the parent chain, we find that N
6584 -- belongs to a statement, thus it may never appear in
6585 -- a declarative region.
6587 if Nkind (P) in N_Statement_Other_Than_Procedure_Call
6588 or else Nkind (P) = N_Procedure_Call_Statement
6589 then
6590 return False;
6591 end if;
6593 -- If we are at a declaration, record it and exit
6595 if Nkind (P) in N_Declaration
6596 and then Nkind (P) not in N_Subprogram_Specification
6597 then
6598 N_Decl := P;
6599 exit;
6600 end if;
6602 P := Parent (P);
6603 end loop;
6605 if No (N_Decl) then
6606 return False;
6607 end if;
6609 return List_Containing (N_Decl) = Declarations (S_Par);
6610 end;
6611 end Safe_To_Capture_In_Parameter_Value;
6613 -------------------
6614 -- Mark_Non_Null --
6615 -------------------
6617 procedure Mark_Non_Null is
6618 begin
6619 -- Only case of interest is if node N is an entity name
6621 if Is_Entity_Name (N) then
6623 -- For sure, we want to clear an indication that this is known to
6624 -- be null, since if we get past this check, it definitely is not!
6626 Set_Is_Known_Null (Entity (N), False);
6628 -- We can mark the entity as known to be non-null if either it is
6629 -- safe to capture the value, or in the case of an IN parameter,
6630 -- which is a constant, if the check we just installed is in the
6631 -- declarative region of the subprogram body. In this latter case,
6632 -- a check is decisive for the rest of the body if the expression
6633 -- is sure to be elaborated, since we know we have to elaborate
6634 -- all declarations before executing the body.
6636 -- Couldn't this always be part of Safe_To_Capture_Value ???
6638 if Safe_To_Capture_Value (N, Entity (N))
6639 or else Safe_To_Capture_In_Parameter_Value
6640 then
6641 Set_Is_Known_Non_Null (Entity (N));
6642 end if;
6643 end if;
6644 end Mark_Non_Null;
6646 -- Start of processing for Install_Null_Excluding_Check
6648 begin
6649 pragma Assert (Is_Access_Type (Typ));
6651 -- No check inside a generic (why not???)
6653 if Inside_A_Generic then
6654 return;
6655 end if;
6657 -- No check needed if known to be non-null
6659 if Known_Non_Null (N) then
6660 return;
6661 end if;
6663 -- If known to be null, here is where we generate a compile time check
6665 if Known_Null (N) then
6667 -- Avoid generating warning message inside init procs
6669 if not Inside_Init_Proc then
6670 Apply_Compile_Time_Constraint_Error
6672 "null value not allowed here??",
6673 CE_Access_Check_Failed);
6674 else
6675 Insert_Action (N,
6676 Make_Raise_Constraint_Error (Loc,
6677 Reason => CE_Access_Check_Failed));
6678 end if;
6680 Mark_Non_Null;
6681 return;
6682 end if;
6684 -- If entity is never assigned, for sure a warning is appropriate
6686 if Is_Entity_Name (N) then
6687 Check_Unset_Reference (N);
6688 end if;
6690 -- No check needed if checks are suppressed on the range. Note that we
6691 -- don't set Is_Known_Non_Null in this case (we could legitimately do
6692 -- so, since the program is erroneous, but we don't like to casually
6693 -- propagate such conclusions from erroneosity).
6695 if Access_Checks_Suppressed (Typ) then
6696 return;
6697 end if;
6699 -- No check needed for access to concurrent record types generated by
6700 -- the expander. This is not just an optimization (though it does indeed
6701 -- remove junk checks). It also avoids generation of junk warnings.
6703 if Nkind (N) in N_Has_Chars
6704 and then Chars (N) = Name_uObject
6705 and then Is_Concurrent_Record_Type
6706 (Directly_Designated_Type (Etype (N)))
6707 then
6708 return;
6709 end if;
6711 -- No check needed in interface thunks since the runtime check is
6712 -- already performed at the caller side.
6714 if Is_Thunk (Current_Scope) then
6715 return;
6716 end if;
6718 -- No check needed for the Get_Current_Excep.all.all idiom generated by
6719 -- the expander within exception handlers, since we know that the value
6720 -- can never be null.
6722 -- Is this really the right way to do this? Normally we generate such
6723 -- code in the expander with checks off, and that's how we suppress this
6724 -- kind of junk check ???
6726 if Nkind (N) = N_Function_Call
6727 and then Nkind (Name (N)) = N_Explicit_Dereference
6728 and then Nkind (Prefix (Name (N))) = N_Identifier
6729 and then Is_RTE (Entity (Prefix (Name (N))), RE_Get_Current_Excep)
6730 then
6731 return;
6732 end if;
6734 -- Otherwise install access check
6736 Insert_Action (N,
6737 Make_Raise_Constraint_Error (Loc,
6738 Condition =>
6739 Make_Op_Eq (Loc,
6740 Left_Opnd => Duplicate_Subexpr_Move_Checks (N),
6741 Right_Opnd => Make_Null (Loc)),
6742 Reason => CE_Access_Check_Failed));
6744 Mark_Non_Null;
6745 end Install_Null_Excluding_Check;
6747 --------------------------
6748 -- Install_Static_Check --
6749 --------------------------
6751 procedure Install_Static_Check (R_Cno : Node_Id; Loc : Source_Ptr) is
6752 Stat : constant Boolean := Is_Static_Expression (R_Cno);
6753 Typ : constant Entity_Id := Etype (R_Cno);
6755 begin
6756 Rewrite (R_Cno,
6757 Make_Raise_Constraint_Error (Loc,
6758 Reason => CE_Range_Check_Failed));
6759 Set_Analyzed (R_Cno);
6760 Set_Etype (R_Cno, Typ);
6761 Set_Raises_Constraint_Error (R_Cno);
6762 Set_Is_Static_Expression (R_Cno, Stat);
6764 -- Now deal with possible local raise handling
6766 Possible_Local_Raise (R_Cno, Standard_Constraint_Error);
6767 end Install_Static_Check;
6769 -------------------------
6770 -- Is_Check_Suppressed --
6771 -------------------------
6773 function Is_Check_Suppressed (E : Entity_Id; C : Check_Id) return Boolean is
6774 Ptr : Suppress_Stack_Entry_Ptr;
6776 begin
6777 -- First search the local entity suppress stack. We search this from the
6778 -- top of the stack down so that we get the innermost entry that applies
6779 -- to this case if there are nested entries.
6781 Ptr := Local_Suppress_Stack_Top;
6782 while Ptr /= null loop
6783 if (Ptr.Entity = Empty or else Ptr.Entity = E)
6784 and then (Ptr.Check = All_Checks or else Ptr.Check = C)
6785 then
6786 return Ptr.Suppress;
6787 end if;
6789 Ptr := Ptr.Prev;
6790 end loop;
6792 -- Now search the global entity suppress table for a matching entry.
6793 -- We also search this from the top down so that if there are multiple
6794 -- pragmas for the same entity, the last one applies (not clear what
6795 -- or whether the RM specifies this handling, but it seems reasonable).
6797 Ptr := Global_Suppress_Stack_Top;
6798 while Ptr /= null loop
6799 if (Ptr.Entity = Empty or else Ptr.Entity = E)
6800 and then (Ptr.Check = All_Checks or else Ptr.Check = C)
6801 then
6802 return Ptr.Suppress;
6803 end if;
6805 Ptr := Ptr.Prev;
6806 end loop;
6808 -- If we did not find a matching entry, then use the normal scope
6809 -- suppress value after all (actually this will be the global setting
6810 -- since it clearly was not overridden at any point). For a predefined
6811 -- check, we test the specific flag. For a user defined check, we check
6812 -- the All_Checks flag. The Overflow flag requires special handling to
6813 -- deal with the General vs Assertion case
6815 if C = Overflow_Check then
6816 return Overflow_Checks_Suppressed (Empty);
6817 elsif C in Predefined_Check_Id then
6818 return Scope_Suppress.Suppress (C);
6819 else
6820 return Scope_Suppress.Suppress (All_Checks);
6821 end if;
6822 end Is_Check_Suppressed;
6824 ---------------------
6825 -- Kill_All_Checks --
6826 ---------------------
6828 procedure Kill_All_Checks is
6829 begin
6830 if Debug_Flag_CC then
6831 w ("Kill_All_Checks");
6832 end if;
6834 -- We reset the number of saved checks to zero, and also modify all
6835 -- stack entries for statement ranges to indicate that the number of
6836 -- checks at each level is now zero.
6838 Num_Saved_Checks := 0;
6840 -- Note: the Int'Min here avoids any possibility of J being out of
6841 -- range when called from e.g. Conditional_Statements_Begin.
6843 for J in 1 .. Int'Min (Saved_Checks_TOS, Saved_Checks_Stack'Last) loop
6844 Saved_Checks_Stack (J) := 0;
6845 end loop;
6846 end Kill_All_Checks;
6848 -----------------
6849 -- Kill_Checks --
6850 -----------------
6852 procedure Kill_Checks (V : Entity_Id) is
6853 begin
6854 if Debug_Flag_CC then
6855 w ("Kill_Checks for entity", Int (V));
6856 end if;
6858 for J in 1 .. Num_Saved_Checks loop
6859 if Saved_Checks (J).Entity = V then
6860 if Debug_Flag_CC then
6861 w (" Checks killed for saved check ", J);
6862 end if;
6864 Saved_Checks (J).Killed := True;
6865 end if;
6866 end loop;
6867 end Kill_Checks;
6869 ------------------------------
6870 -- Length_Checks_Suppressed --
6871 ------------------------------
6873 function Length_Checks_Suppressed (E : Entity_Id) return Boolean is
6874 begin
6875 if Present (E) and then Checks_May_Be_Suppressed (E) then
6876 return Is_Check_Suppressed (E, Length_Check);
6877 else
6878 return Scope_Suppress.Suppress (Length_Check);
6879 end if;
6880 end Length_Checks_Suppressed;
6882 -----------------------
6883 -- Make_Bignum_Block --
6884 -----------------------
6886 function Make_Bignum_Block (Loc : Source_Ptr) return Node_Id is
6887 M : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uM);
6889 begin
6890 return
6891 Make_Block_Statement (Loc,
6892 Declarations => New_List (
6893 Make_Object_Declaration (Loc,
6894 Defining_Identifier => M,
6895 Object_Definition =>
6896 New_Occurrence_Of (RTE (RE_Mark_Id), Loc),
6897 Expression =>
6898 Make_Function_Call (Loc,
6899 Name => New_Reference_To (RTE (RE_SS_Mark), Loc)))),
6901 Handled_Statement_Sequence =>
6902 Make_Handled_Sequence_Of_Statements (Loc,
6903 Statements => New_List (
6904 Make_Procedure_Call_Statement (Loc,
6905 Name => New_Occurrence_Of (RTE (RE_SS_Release), Loc),
6906 Parameter_Associations => New_List (
6907 New_Reference_To (M, Loc))))));
6908 end Make_Bignum_Block;
6910 ----------------------------------
6911 -- Minimize_Eliminate_Overflows --
6912 ----------------------------------
6914 -- This is a recursive routine that is called at the top of an expression
6915 -- tree to properly process overflow checking for a whole subtree by making
6916 -- recursive calls to process operands. This processing may involve the use
6917 -- of bignum or long long integer arithmetic, which will change the types
6918 -- of operands and results. That's why we can't do this bottom up (since
6919 -- it would interfere with semantic analysis).
6921 -- What happens is that if MINIMIZED/ELIMINATED mode is in effect then
6922 -- the operator expansion routines, as well as the expansion routines for
6923 -- if/case expression, do nothing (for the moment) except call the routine
6924 -- to apply the overflow check (Apply_Arithmetic_Overflow_Check). That
6925 -- routine does nothing for non top-level nodes, so at the point where the
6926 -- call is made for the top level node, the entire expression subtree has
6927 -- not been expanded, or processed for overflow. All that has to happen as
6928 -- a result of the top level call to this routine.
6930 -- As noted above, the overflow processing works by making recursive calls
6931 -- for the operands, and figuring out what to do, based on the processing
6932 -- of these operands (e.g. if a bignum operand appears, the parent op has
6933 -- to be done in bignum mode), and the determined ranges of the operands.
6935 -- After possible rewriting of a constituent subexpression node, a call is
6936 -- made to either reexpand the node (if nothing has changed) or reanalyze
6937 -- the node (if it has been modified by the overflow check processing). The
6938 -- Analyzed_Flag is set to False before the reexpand/reanalyze. To avoid
6939 -- a recursive call into the whole overflow apparatus, an important rule
6940 -- for this call is that the overflow handling mode must be temporarily set
6941 -- to STRICT.
6943 procedure Minimize_Eliminate_Overflows
6944 (N : Node_Id;
6945 Lo : out Uint;
6946 Hi : out Uint;
6947 Top_Level : Boolean)
6949 Rtyp : constant Entity_Id := Etype (N);
6950 pragma Assert (Is_Signed_Integer_Type (Rtyp));
6951 -- Result type, must be a signed integer type
6953 Check_Mode : constant Overflow_Mode_Type := Overflow_Check_Mode;
6954 pragma Assert (Check_Mode in Minimized_Or_Eliminated);
6956 Loc : constant Source_Ptr := Sloc (N);
6958 Rlo, Rhi : Uint;
6959 -- Ranges of values for right operand (operator case)
6961 Llo, Lhi : Uint;
6962 -- Ranges of values for left operand (operator case)
6964 LLIB : constant Entity_Id := Base_Type (Standard_Long_Long_Integer);
6965 -- Operands and results are of this type when we convert
6967 LLLo : constant Uint := Intval (Type_Low_Bound (LLIB));
6968 LLHi : constant Uint := Intval (Type_High_Bound (LLIB));
6969 -- Bounds of Long_Long_Integer
6971 Binary : constant Boolean := Nkind (N) in N_Binary_Op;
6972 -- Indicates binary operator case
6974 OK : Boolean;
6975 -- Used in call to Determine_Range
6977 Bignum_Operands : Boolean;
6978 -- Set True if one or more operands is already of type Bignum, meaning
6979 -- that for sure (regardless of Top_Level setting) we are committed to
6980 -- doing the operation in Bignum mode (or in the case of a case or if
6981 -- expression, converting all the dependent expressions to Bignum).
6983 Long_Long_Integer_Operands : Boolean;
6984 -- Set True if one or more operands is already of type Long_Long_Integer
6985 -- which means that if the result is known to be in the result type
6986 -- range, then we must convert such operands back to the result type.
6988 procedure Reanalyze (Typ : Entity_Id; Suppress : Boolean := False);
6989 -- This is called when we have modified the node and we therefore need
6990 -- to reanalyze it. It is important that we reset the mode to STRICT for
6991 -- this reanalysis, since if we leave it in MINIMIZED or ELIMINATED mode
6992 -- we would reenter this routine recursively which would not be good!
6993 -- The argument Suppress is set True if we also want to suppress
6994 -- overflow checking for the reexpansion (this is set when we know
6995 -- overflow is not possible). Typ is the type for the reanalysis.
6997 procedure Reexpand (Suppress : Boolean := False);
6998 -- This is like Reanalyze, but does not do the Analyze step, it only
6999 -- does a reexpansion. We do this reexpansion in STRICT mode, so that
7000 -- instead of reentering the MINIMIZED/ELIMINATED mode processing, we
7001 -- follow the normal expansion path (e.g. converting A**4 to A**2**2).
7002 -- Note that skipping reanalysis is not just an optimization, testing
7003 -- has showed up several complex cases in which reanalyzing an already
7004 -- analyzed node causes incorrect behavior.
7006 function In_Result_Range return Boolean;
7007 -- Returns True iff Lo .. Hi are within range of the result type
7009 procedure Max (A : in out Uint; B : Uint);
7010 -- If A is No_Uint, sets A to B, else to UI_Max (A, B)
7012 procedure Min (A : in out Uint; B : Uint);
7013 -- If A is No_Uint, sets A to B, else to UI_Min (A, B)
7015 ---------------------
7016 -- In_Result_Range --
7017 ---------------------
7019 function In_Result_Range return Boolean is
7020 begin
7021 if Lo = No_Uint or else Hi = No_Uint then
7022 return False;
7024 elsif Is_Static_Subtype (Etype (N)) then
7025 return Lo >= Expr_Value (Type_Low_Bound (Rtyp))
7026 and then
7027 Hi <= Expr_Value (Type_High_Bound (Rtyp));
7029 else
7030 return Lo >= Expr_Value (Type_Low_Bound (Base_Type (Rtyp)))
7031 and then
7032 Hi <= Expr_Value (Type_High_Bound (Base_Type (Rtyp)));
7033 end if;
7034 end In_Result_Range;
7036 ---------
7037 -- Max --
7038 ---------
7040 procedure Max (A : in out Uint; B : Uint) is
7041 begin
7042 if A = No_Uint or else B > A then
7043 A := B;
7044 end if;
7045 end Max;
7047 ---------
7048 -- Min --
7049 ---------
7051 procedure Min (A : in out Uint; B : Uint) is
7052 begin
7053 if A = No_Uint or else B < A then
7054 A := B;
7055 end if;
7056 end Min;
7058 ---------------
7059 -- Reanalyze --
7060 ---------------
7062 procedure Reanalyze (Typ : Entity_Id; Suppress : Boolean := False) is
7063 Svg : constant Overflow_Mode_Type :=
7064 Scope_Suppress.Overflow_Mode_General;
7065 Sva : constant Overflow_Mode_Type :=
7066 Scope_Suppress.Overflow_Mode_Assertions;
7067 Svo : constant Boolean :=
7068 Scope_Suppress.Suppress (Overflow_Check);
7070 begin
7071 Scope_Suppress.Overflow_Mode_General := Strict;
7072 Scope_Suppress.Overflow_Mode_Assertions := Strict;
7074 if Suppress then
7075 Scope_Suppress.Suppress (Overflow_Check) := True;
7076 end if;
7078 Analyze_And_Resolve (N, Typ);
7080 Scope_Suppress.Suppress (Overflow_Check) := Svo;
7081 Scope_Suppress.Overflow_Mode_General := Svg;
7082 Scope_Suppress.Overflow_Mode_Assertions := Sva;
7083 end Reanalyze;
7085 --------------
7086 -- Reexpand --
7087 --------------
7089 procedure Reexpand (Suppress : Boolean := False) is
7090 Svg : constant Overflow_Mode_Type :=
7091 Scope_Suppress.Overflow_Mode_General;
7092 Sva : constant Overflow_Mode_Type :=
7093 Scope_Suppress.Overflow_Mode_Assertions;
7094 Svo : constant Boolean :=
7095 Scope_Suppress.Suppress (Overflow_Check);
7097 begin
7098 Scope_Suppress.Overflow_Mode_General := Strict;
7099 Scope_Suppress.Overflow_Mode_Assertions := Strict;
7100 Set_Analyzed (N, False);
7102 if Suppress then
7103 Scope_Suppress.Suppress (Overflow_Check) := True;
7104 end if;
7106 Expand (N);
7108 Scope_Suppress.Suppress (Overflow_Check) := Svo;
7109 Scope_Suppress.Overflow_Mode_General := Svg;
7110 Scope_Suppress.Overflow_Mode_Assertions := Sva;
7111 end Reexpand;
7113 -- Start of processing for Minimize_Eliminate_Overflows
7115 begin
7116 -- Case where we do not have a signed integer arithmetic operation
7118 if not Is_Signed_Integer_Arithmetic_Op (N) then
7120 -- Use the normal Determine_Range routine to get the range. We
7121 -- don't require operands to be valid, invalid values may result in
7122 -- rubbish results where the result has not been properly checked for
7123 -- overflow, that's fine!
7125 Determine_Range (N, OK, Lo, Hi, Assume_Valid => False);
7127 -- If Determine_Range did not work (can this in fact happen? Not
7128 -- clear but might as well protect), use type bounds.
7130 if not OK then
7131 Lo := Intval (Type_Low_Bound (Base_Type (Etype (N))));
7132 Hi := Intval (Type_High_Bound (Base_Type (Etype (N))));
7133 end if;
7135 -- If we don't have a binary operator, all we have to do is to set
7136 -- the Hi/Lo range, so we are done
7138 return;
7140 -- Processing for if expression
7142 elsif Nkind (N) = N_If_Expression then
7143 declare
7144 Then_DE : constant Node_Id := Next (First (Expressions (N)));
7145 Else_DE : constant Node_Id := Next (Then_DE);
7147 begin
7148 Bignum_Operands := False;
7150 Minimize_Eliminate_Overflows
7151 (Then_DE, Lo, Hi, Top_Level => False);
7153 if Lo = No_Uint then
7154 Bignum_Operands := True;
7155 end if;
7157 Minimize_Eliminate_Overflows
7158 (Else_DE, Rlo, Rhi, Top_Level => False);
7160 if Rlo = No_Uint then
7161 Bignum_Operands := True;
7162 else
7163 Long_Long_Integer_Operands :=
7164 Etype (Then_DE) = LLIB or else Etype (Else_DE) = LLIB;
7166 Min (Lo, Rlo);
7167 Max (Hi, Rhi);
7168 end if;
7170 -- If at least one of our operands is now Bignum, we must rebuild
7171 -- the if expression to use Bignum operands. We will analyze the
7172 -- rebuilt if expression with overflow checks off, since once we
7173 -- are in bignum mode, we are all done with overflow checks!
7175 if Bignum_Operands then
7176 Rewrite (N,
7177 Make_If_Expression (Loc,
7178 Expressions => New_List (
7179 Remove_Head (Expressions (N)),
7180 Convert_To_Bignum (Then_DE),
7181 Convert_To_Bignum (Else_DE)),
7182 Is_Elsif => Is_Elsif (N)));
7184 Reanalyze (RTE (RE_Bignum), Suppress => True);
7186 -- If we have no Long_Long_Integer operands, then we are in result
7187 -- range, since it means that none of our operands felt the need
7188 -- to worry about overflow (otherwise it would have already been
7189 -- converted to long long integer or bignum). We reexpand to
7190 -- complete the expansion of the if expression (but we do not
7191 -- need to reanalyze).
7193 elsif not Long_Long_Integer_Operands then
7194 Set_Do_Overflow_Check (N, False);
7195 Reexpand;
7197 -- Otherwise convert us to long long integer mode. Note that we
7198 -- don't need any further overflow checking at this level.
7200 else
7201 Convert_To_And_Rewrite (LLIB, Then_DE);
7202 Convert_To_And_Rewrite (LLIB, Else_DE);
7203 Set_Etype (N, LLIB);
7205 -- Now reanalyze with overflow checks off
7207 Set_Do_Overflow_Check (N, False);
7208 Reanalyze (LLIB, Suppress => True);
7209 end if;
7210 end;
7212 return;
7214 -- Here for case expression
7216 elsif Nkind (N) = N_Case_Expression then
7217 Bignum_Operands := False;
7218 Long_Long_Integer_Operands := False;
7220 declare
7221 Alt : Node_Id;
7223 begin
7224 -- Loop through expressions applying recursive call
7226 Alt := First (Alternatives (N));
7227 while Present (Alt) loop
7228 declare
7229 Aexp : constant Node_Id := Expression (Alt);
7231 begin
7232 Minimize_Eliminate_Overflows
7233 (Aexp, Lo, Hi, Top_Level => False);
7235 if Lo = No_Uint then
7236 Bignum_Operands := True;
7237 elsif Etype (Aexp) = LLIB then
7238 Long_Long_Integer_Operands := True;
7239 end if;
7240 end;
7242 Next (Alt);
7243 end loop;
7245 -- If we have no bignum or long long integer operands, it means
7246 -- that none of our dependent expressions could raise overflow.
7247 -- In this case, we simply return with no changes except for
7248 -- resetting the overflow flag, since we are done with overflow
7249 -- checks for this node. We will reexpand to get the needed
7250 -- expansion for the case expression, but we do not need to
7251 -- reanalyze, since nothing has changed.
7253 if not (Bignum_Operands or Long_Long_Integer_Operands) then
7254 Set_Do_Overflow_Check (N, False);
7255 Reexpand (Suppress => True);
7257 -- Otherwise we are going to rebuild the case expression using
7258 -- either bignum or long long integer operands throughout.
7260 else
7261 declare
7262 Rtype : Entity_Id;
7263 New_Alts : List_Id;
7264 New_Exp : Node_Id;
7266 begin
7267 New_Alts := New_List;
7268 Alt := First (Alternatives (N));
7269 while Present (Alt) loop
7270 if Bignum_Operands then
7271 New_Exp := Convert_To_Bignum (Expression (Alt));
7272 Rtype := RTE (RE_Bignum);
7273 else
7274 New_Exp := Convert_To (LLIB, Expression (Alt));
7275 Rtype := LLIB;
7276 end if;
7278 Append_To (New_Alts,
7279 Make_Case_Expression_Alternative (Sloc (Alt),
7280 Actions => No_List,
7281 Discrete_Choices => Discrete_Choices (Alt),
7282 Expression => New_Exp));
7284 Next (Alt);
7285 end loop;
7287 Rewrite (N,
7288 Make_Case_Expression (Loc,
7289 Expression => Expression (N),
7290 Alternatives => New_Alts));
7292 Reanalyze (Rtype, Suppress => True);
7293 end;
7294 end if;
7295 end;
7297 return;
7298 end if;
7300 -- If we have an arithmetic operator we make recursive calls on the
7301 -- operands to get the ranges (and to properly process the subtree
7302 -- that lies below us!)
7304 Minimize_Eliminate_Overflows
7305 (Right_Opnd (N), Rlo, Rhi, Top_Level => False);
7307 if Binary then
7308 Minimize_Eliminate_Overflows
7309 (Left_Opnd (N), Llo, Lhi, Top_Level => False);
7310 end if;
7312 -- Record if we have Long_Long_Integer operands
7314 Long_Long_Integer_Operands :=
7315 Etype (Right_Opnd (N)) = LLIB
7316 or else (Binary and then Etype (Left_Opnd (N)) = LLIB);
7318 -- If either operand is a bignum, then result will be a bignum and we
7319 -- don't need to do any range analysis. As previously discussed we could
7320 -- do range analysis in such cases, but it could mean working with giant
7321 -- numbers at compile time for very little gain (the number of cases
7322 -- in which we could slip back from bignum mode is small).
7324 if Rlo = No_Uint or else (Binary and then Llo = No_Uint) then
7325 Lo := No_Uint;
7326 Hi := No_Uint;
7327 Bignum_Operands := True;
7329 -- Otherwise compute result range
7331 else
7332 Bignum_Operands := False;
7334 case Nkind (N) is
7336 -- Absolute value
7338 when N_Op_Abs =>
7339 Lo := Uint_0;
7340 Hi := UI_Max (abs Rlo, abs Rhi);
7342 -- Addition
7344 when N_Op_Add =>
7345 Lo := Llo + Rlo;
7346 Hi := Lhi + Rhi;
7348 -- Division
7350 when N_Op_Divide =>
7352 -- If the right operand can only be zero, set 0..0
7354 if Rlo = 0 and then Rhi = 0 then
7355 Lo := Uint_0;
7356 Hi := Uint_0;
7358 -- Possible bounds of division must come from dividing end
7359 -- values of the input ranges (four possibilities), provided
7360 -- zero is not included in the possible values of the right
7361 -- operand.
7363 -- Otherwise, we just consider two intervals of values for
7364 -- the right operand: the interval of negative values (up to
7365 -- -1) and the interval of positive values (starting at 1).
7366 -- Since division by 1 is the identity, and division by -1
7367 -- is negation, we get all possible bounds of division in that
7368 -- case by considering:
7369 -- - all values from the division of end values of input
7370 -- ranges;
7371 -- - the end values of the left operand;
7372 -- - the negation of the end values of the left operand.
7374 else
7375 declare
7376 Mrk : constant Uintp.Save_Mark := Mark;
7377 -- Mark so we can release the RR and Ev values
7379 Ev1 : Uint;
7380 Ev2 : Uint;
7381 Ev3 : Uint;
7382 Ev4 : Uint;
7384 begin
7385 -- Discard extreme values of zero for the divisor, since
7386 -- they will simply result in an exception in any case.
7388 if Rlo = 0 then
7389 Rlo := Uint_1;
7390 elsif Rhi = 0 then
7391 Rhi := -Uint_1;
7392 end if;
7394 -- Compute possible bounds coming from dividing end
7395 -- values of the input ranges.
7397 Ev1 := Llo / Rlo;
7398 Ev2 := Llo / Rhi;
7399 Ev3 := Lhi / Rlo;
7400 Ev4 := Lhi / Rhi;
7402 Lo := UI_Min (UI_Min (Ev1, Ev2), UI_Min (Ev3, Ev4));
7403 Hi := UI_Max (UI_Max (Ev1, Ev2), UI_Max (Ev3, Ev4));
7405 -- If the right operand can be both negative or positive,
7406 -- include the end values of the left operand in the
7407 -- extreme values, as well as their negation.
7409 if Rlo < 0 and then Rhi > 0 then
7410 Ev1 := Llo;
7411 Ev2 := -Llo;
7412 Ev3 := Lhi;
7413 Ev4 := -Lhi;
7415 Min (Lo,
7416 UI_Min (UI_Min (Ev1, Ev2), UI_Min (Ev3, Ev4)));
7417 Max (Hi,
7418 UI_Max (UI_Max (Ev1, Ev2), UI_Max (Ev3, Ev4)));
7419 end if;
7421 -- Release the RR and Ev values
7423 Release_And_Save (Mrk, Lo, Hi);
7424 end;
7425 end if;
7427 -- Exponentiation
7429 when N_Op_Expon =>
7431 -- Discard negative values for the exponent, since they will
7432 -- simply result in an exception in any case.
7434 if Rhi < 0 then
7435 Rhi := Uint_0;
7436 elsif Rlo < 0 then
7437 Rlo := Uint_0;
7438 end if;
7440 -- Estimate number of bits in result before we go computing
7441 -- giant useless bounds. Basically the number of bits in the
7442 -- result is the number of bits in the base multiplied by the
7443 -- value of the exponent. If this is big enough that the result
7444 -- definitely won't fit in Long_Long_Integer, switch to bignum
7445 -- mode immediately, and avoid computing giant bounds.
7447 -- The comparison here is approximate, but conservative, it
7448 -- only clicks on cases that are sure to exceed the bounds.
7450 if Num_Bits (UI_Max (abs Llo, abs Lhi)) * Rhi + 1 > 100 then
7451 Lo := No_Uint;
7452 Hi := No_Uint;
7454 -- If right operand is zero then result is 1
7456 elsif Rhi = 0 then
7457 Lo := Uint_1;
7458 Hi := Uint_1;
7460 else
7461 -- High bound comes either from exponentiation of largest
7462 -- positive value to largest exponent value, or from
7463 -- the exponentiation of most negative value to an
7464 -- even exponent.
7466 declare
7467 Hi1, Hi2 : Uint;
7469 begin
7470 if Lhi > 0 then
7471 Hi1 := Lhi ** Rhi;
7472 else
7473 Hi1 := Uint_0;
7474 end if;
7476 if Llo < 0 then
7477 if Rhi mod 2 = 0 then
7478 Hi2 := Llo ** Rhi;
7479 else
7480 Hi2 := Llo ** (Rhi - 1);
7481 end if;
7482 else
7483 Hi2 := Uint_0;
7484 end if;
7486 Hi := UI_Max (Hi1, Hi2);
7487 end;
7489 -- Result can only be negative if base can be negative
7491 if Llo < 0 then
7492 if Rhi mod 2 = 0 then
7493 Lo := Llo ** (Rhi - 1);
7494 else
7495 Lo := Llo ** Rhi;
7496 end if;
7498 -- Otherwise low bound is minimum ** minimum
7500 else
7501 Lo := Llo ** Rlo;
7502 end if;
7503 end if;
7505 -- Negation
7507 when N_Op_Minus =>
7508 Lo := -Rhi;
7509 Hi := -Rlo;
7511 -- Mod
7513 when N_Op_Mod =>
7514 declare
7515 Maxabs : constant Uint := UI_Max (abs Rlo, abs Rhi) - 1;
7516 -- This is the maximum absolute value of the result
7518 begin
7519 Lo := Uint_0;
7520 Hi := Uint_0;
7522 -- The result depends only on the sign and magnitude of
7523 -- the right operand, it does not depend on the sign or
7524 -- magnitude of the left operand.
7526 if Rlo < 0 then
7527 Lo := -Maxabs;
7528 end if;
7530 if Rhi > 0 then
7531 Hi := Maxabs;
7532 end if;
7533 end;
7535 -- Multiplication
7537 when N_Op_Multiply =>
7539 -- Possible bounds of multiplication must come from multiplying
7540 -- end values of the input ranges (four possibilities).
7542 declare
7543 Mrk : constant Uintp.Save_Mark := Mark;
7544 -- Mark so we can release the Ev values
7546 Ev1 : constant Uint := Llo * Rlo;
7547 Ev2 : constant Uint := Llo * Rhi;
7548 Ev3 : constant Uint := Lhi * Rlo;
7549 Ev4 : constant Uint := Lhi * Rhi;
7551 begin
7552 Lo := UI_Min (UI_Min (Ev1, Ev2), UI_Min (Ev3, Ev4));
7553 Hi := UI_Max (UI_Max (Ev1, Ev2), UI_Max (Ev3, Ev4));
7555 -- Release the Ev values
7557 Release_And_Save (Mrk, Lo, Hi);
7558 end;
7560 -- Plus operator (affirmation)
7562 when N_Op_Plus =>
7563 Lo := Rlo;
7564 Hi := Rhi;
7566 -- Remainder
7568 when N_Op_Rem =>
7569 declare
7570 Maxabs : constant Uint := UI_Max (abs Rlo, abs Rhi) - 1;
7571 -- This is the maximum absolute value of the result. Note
7572 -- that the result range does not depend on the sign of the
7573 -- right operand.
7575 begin
7576 Lo := Uint_0;
7577 Hi := Uint_0;
7579 -- Case of left operand negative, which results in a range
7580 -- of -Maxabs .. 0 for those negative values. If there are
7581 -- no negative values then Lo value of result is always 0.
7583 if Llo < 0 then
7584 Lo := -Maxabs;
7585 end if;
7587 -- Case of left operand positive
7589 if Lhi > 0 then
7590 Hi := Maxabs;
7591 end if;
7592 end;
7594 -- Subtract
7596 when N_Op_Subtract =>
7597 Lo := Llo - Rhi;
7598 Hi := Lhi - Rlo;
7600 -- Nothing else should be possible
7602 when others =>
7603 raise Program_Error;
7604 end case;
7605 end if;
7607 -- Here for the case where we have not rewritten anything (no bignum
7608 -- operands or long long integer operands), and we know the result.
7609 -- If we know we are in the result range, and we do not have Bignum
7610 -- operands or Long_Long_Integer operands, we can just reexpand with
7611 -- overflow checks turned off (since we know we cannot have overflow).
7612 -- As always the reexpansion is required to complete expansion of the
7613 -- operator, but we do not need to reanalyze, and we prevent recursion
7614 -- by suppressing the check.
7616 if not (Bignum_Operands or Long_Long_Integer_Operands)
7617 and then In_Result_Range
7618 then
7619 Set_Do_Overflow_Check (N, False);
7620 Reexpand (Suppress => True);
7621 return;
7623 -- Here we know that we are not in the result range, and in the general
7624 -- case we will move into either the Bignum or Long_Long_Integer domain
7625 -- to compute the result. However, there is one exception. If we are
7626 -- at the top level, and we do not have Bignum or Long_Long_Integer
7627 -- operands, we will have to immediately convert the result back to
7628 -- the result type, so there is no point in Bignum/Long_Long_Integer
7629 -- fiddling.
7631 elsif Top_Level
7632 and then not (Bignum_Operands or Long_Long_Integer_Operands)
7634 -- One further refinement. If we are at the top level, but our parent
7635 -- is a type conversion, then go into bignum or long long integer node
7636 -- since the result will be converted to that type directly without
7637 -- going through the result type, and we may avoid an overflow. This
7638 -- is the case for example of Long_Long_Integer (A ** 4), where A is
7639 -- of type Integer, and the result A ** 4 fits in Long_Long_Integer
7640 -- but does not fit in Integer.
7642 and then Nkind (Parent (N)) /= N_Type_Conversion
7643 then
7644 -- Here keep original types, but we need to complete analysis
7646 -- One subtlety. We can't just go ahead and do an analyze operation
7647 -- here because it will cause recursion into the whole MINIMIZED/
7648 -- ELIMINATED overflow processing which is not what we want. Here
7649 -- we are at the top level, and we need a check against the result
7650 -- mode (i.e. we want to use STRICT mode). So do exactly that!
7651 -- Also, we have not modified the node, so this is a case where
7652 -- we need to reexpand, but not reanalyze.
7654 Reexpand;
7655 return;
7657 -- Cases where we do the operation in Bignum mode. This happens either
7658 -- because one of our operands is in Bignum mode already, or because
7659 -- the computed bounds are outside the bounds of Long_Long_Integer,
7660 -- which in some cases can be indicated by Hi and Lo being No_Uint.
7662 -- Note: we could do better here and in some cases switch back from
7663 -- Bignum mode to normal mode, e.g. big mod 2 must be in the range
7664 -- 0 .. 1, but the cases are rare and it is not worth the effort.
7665 -- Failing to do this switching back is only an efficiency issue.
7667 elsif Lo = No_Uint or else Lo < LLLo or else Hi > LLHi then
7669 -- OK, we are definitely outside the range of Long_Long_Integer. The
7670 -- question is whether to move to Bignum mode, or stay in the domain
7671 -- of Long_Long_Integer, signalling that an overflow check is needed.
7673 -- Obviously in MINIMIZED mode we stay with LLI, since we are not in
7674 -- the Bignum business. In ELIMINATED mode, we will normally move
7675 -- into Bignum mode, but there is an exception if neither of our
7676 -- operands is Bignum now, and we are at the top level (Top_Level
7677 -- set True). In this case, there is no point in moving into Bignum
7678 -- mode to prevent overflow if the caller will immediately convert
7679 -- the Bignum value back to LLI with an overflow check. It's more
7680 -- efficient to stay in LLI mode with an overflow check (if needed)
7682 if Check_Mode = Minimized
7683 or else (Top_Level and not Bignum_Operands)
7684 then
7685 if Do_Overflow_Check (N) then
7686 Enable_Overflow_Check (N);
7687 end if;
7689 -- The result now has to be in Long_Long_Integer mode, so adjust
7690 -- the possible range to reflect this. Note these calls also
7691 -- change No_Uint values from the top level case to LLI bounds.
7693 Max (Lo, LLLo);
7694 Min (Hi, LLHi);
7696 -- Otherwise we are in ELIMINATED mode and we switch to Bignum mode
7698 else
7699 pragma Assert (Check_Mode = Eliminated);
7701 declare
7702 Fent : Entity_Id;
7703 Args : List_Id;
7705 begin
7706 case Nkind (N) is
7707 when N_Op_Abs =>
7708 Fent := RTE (RE_Big_Abs);
7710 when N_Op_Add =>
7711 Fent := RTE (RE_Big_Add);
7713 when N_Op_Divide =>
7714 Fent := RTE (RE_Big_Div);
7716 when N_Op_Expon =>
7717 Fent := RTE (RE_Big_Exp);
7719 when N_Op_Minus =>
7720 Fent := RTE (RE_Big_Neg);
7722 when N_Op_Mod =>
7723 Fent := RTE (RE_Big_Mod);
7725 when N_Op_Multiply =>
7726 Fent := RTE (RE_Big_Mul);
7728 when N_Op_Rem =>
7729 Fent := RTE (RE_Big_Rem);
7731 when N_Op_Subtract =>
7732 Fent := RTE (RE_Big_Sub);
7734 -- Anything else is an internal error, this includes the
7735 -- N_Op_Plus case, since how can plus cause the result
7736 -- to be out of range if the operand is in range?
7738 when others =>
7739 raise Program_Error;
7740 end case;
7742 -- Construct argument list for Bignum call, converting our
7743 -- operands to Bignum form if they are not already there.
7745 Args := New_List;
7747 if Binary then
7748 Append_To (Args, Convert_To_Bignum (Left_Opnd (N)));
7749 end if;
7751 Append_To (Args, Convert_To_Bignum (Right_Opnd (N)));
7753 -- Now rewrite the arithmetic operator with a call to the
7754 -- corresponding bignum function.
7756 Rewrite (N,
7757 Make_Function_Call (Loc,
7758 Name => New_Occurrence_Of (Fent, Loc),
7759 Parameter_Associations => Args));
7760 Reanalyze (RTE (RE_Bignum), Suppress => True);
7762 -- Indicate result is Bignum mode
7764 Lo := No_Uint;
7765 Hi := No_Uint;
7766 return;
7767 end;
7768 end if;
7770 -- Otherwise we are in range of Long_Long_Integer, so no overflow
7771 -- check is required, at least not yet.
7773 else
7774 Set_Do_Overflow_Check (N, False);
7775 end if;
7777 -- Here we are not in Bignum territory, but we may have long long
7778 -- integer operands that need special handling. First a special check:
7779 -- If an exponentiation operator exponent is of type Long_Long_Integer,
7780 -- it means we converted it to prevent overflow, but exponentiation
7781 -- requires a Natural right operand, so convert it back to Natural.
7782 -- This conversion may raise an exception which is fine.
7784 if Nkind (N) = N_Op_Expon and then Etype (Right_Opnd (N)) = LLIB then
7785 Convert_To_And_Rewrite (Standard_Natural, Right_Opnd (N));
7786 end if;
7788 -- Here we will do the operation in Long_Long_Integer. We do this even
7789 -- if we know an overflow check is required, better to do this in long
7790 -- long integer mode, since we are less likely to overflow!
7792 -- Convert right or only operand to Long_Long_Integer, except that
7793 -- we do not touch the exponentiation right operand.
7795 if Nkind (N) /= N_Op_Expon then
7796 Convert_To_And_Rewrite (LLIB, Right_Opnd (N));
7797 end if;
7799 -- Convert left operand to Long_Long_Integer for binary case
7801 if Binary then
7802 Convert_To_And_Rewrite (LLIB, Left_Opnd (N));
7803 end if;
7805 -- Reset node to unanalyzed
7807 Set_Analyzed (N, False);
7808 Set_Etype (N, Empty);
7809 Set_Entity (N, Empty);
7811 -- Now analyze this new node. This reanalysis will complete processing
7812 -- for the node. In particular we will complete the expansion of an
7813 -- exponentiation operator (e.g. changing A ** 2 to A * A), and also
7814 -- we will complete any division checks (since we have not changed the
7815 -- setting of the Do_Division_Check flag).
7817 -- We do this reanalysis in STRICT mode to avoid recursion into the
7818 -- MINIMIZED/ELIMINATED handling, since we are now done with that!
7820 declare
7821 SG : constant Overflow_Mode_Type :=
7822 Scope_Suppress.Overflow_Mode_General;
7823 SA : constant Overflow_Mode_Type :=
7824 Scope_Suppress.Overflow_Mode_Assertions;
7826 begin
7827 Scope_Suppress.Overflow_Mode_General := Strict;
7828 Scope_Suppress.Overflow_Mode_Assertions := Strict;
7830 if not Do_Overflow_Check (N) then
7831 Reanalyze (LLIB, Suppress => True);
7832 else
7833 Reanalyze (LLIB);
7834 end if;
7836 Scope_Suppress.Overflow_Mode_General := SG;
7837 Scope_Suppress.Overflow_Mode_Assertions := SA;
7838 end;
7839 end Minimize_Eliminate_Overflows;
7841 -------------------------
7842 -- Overflow_Check_Mode --
7843 -------------------------
7845 function Overflow_Check_Mode return Overflow_Mode_Type is
7846 begin
7847 if In_Assertion_Expr = 0 then
7848 return Scope_Suppress.Overflow_Mode_General;
7849 else
7850 return Scope_Suppress.Overflow_Mode_Assertions;
7851 end if;
7852 end Overflow_Check_Mode;
7854 --------------------------------
7855 -- Overflow_Checks_Suppressed --
7856 --------------------------------
7858 function Overflow_Checks_Suppressed (E : Entity_Id) return Boolean is
7859 begin
7860 if Present (E) and then Checks_May_Be_Suppressed (E) then
7861 return Is_Check_Suppressed (E, Overflow_Check);
7862 else
7863 return Scope_Suppress.Suppress (Overflow_Check);
7864 end if;
7865 end Overflow_Checks_Suppressed;
7867 ---------------------------------
7868 -- Predicate_Checks_Suppressed --
7869 ---------------------------------
7871 function Predicate_Checks_Suppressed (E : Entity_Id) return Boolean is
7872 begin
7873 if Present (E) and then Checks_May_Be_Suppressed (E) then
7874 return Is_Check_Suppressed (E, Predicate_Check);
7875 else
7876 return Scope_Suppress.Suppress (Predicate_Check);
7877 end if;
7878 end Predicate_Checks_Suppressed;
7880 -----------------------------
7881 -- Range_Checks_Suppressed --
7882 -----------------------------
7884 function Range_Checks_Suppressed (E : Entity_Id) return Boolean is
7885 begin
7886 if Present (E) then
7888 -- Note: for now we always suppress range checks on Vax float types,
7889 -- since Gigi does not know how to generate these checks.
7891 if Vax_Float (E) then
7892 return True;
7893 elsif Kill_Range_Checks (E) then
7894 return True;
7895 elsif Checks_May_Be_Suppressed (E) then
7896 return Is_Check_Suppressed (E, Range_Check);
7897 end if;
7898 end if;
7900 return Scope_Suppress.Suppress (Range_Check);
7901 end Range_Checks_Suppressed;
7903 -----------------------------------------
7904 -- Range_Or_Validity_Checks_Suppressed --
7905 -----------------------------------------
7907 -- Note: the coding would be simpler here if we simply made appropriate
7908 -- calls to Range/Validity_Checks_Suppressed, but that would result in
7909 -- duplicated checks which we prefer to avoid.
7911 function Range_Or_Validity_Checks_Suppressed
7912 (Expr : Node_Id) return Boolean
7914 begin
7915 -- Immediate return if scope checks suppressed for either check
7917 if Scope_Suppress.Suppress (Range_Check)
7919 Scope_Suppress.Suppress (Validity_Check)
7920 then
7921 return True;
7922 end if;
7924 -- If no expression, that's odd, decide that checks are suppressed,
7925 -- since we don't want anyone trying to do checks in this case, which
7926 -- is most likely the result of some other error.
7928 if No (Expr) then
7929 return True;
7930 end if;
7932 -- Expression is present, so perform suppress checks on type
7934 declare
7935 Typ : constant Entity_Id := Etype (Expr);
7936 begin
7937 if Vax_Float (Typ) then
7938 return True;
7939 elsif Checks_May_Be_Suppressed (Typ)
7940 and then (Is_Check_Suppressed (Typ, Range_Check)
7941 or else
7942 Is_Check_Suppressed (Typ, Validity_Check))
7943 then
7944 return True;
7945 end if;
7946 end;
7948 -- If expression is an entity name, perform checks on this entity
7950 if Is_Entity_Name (Expr) then
7951 declare
7952 Ent : constant Entity_Id := Entity (Expr);
7953 begin
7954 if Checks_May_Be_Suppressed (Ent) then
7955 return Is_Check_Suppressed (Ent, Range_Check)
7956 or else Is_Check_Suppressed (Ent, Validity_Check);
7957 end if;
7958 end;
7959 end if;
7961 -- If we fall through, no checks suppressed
7963 return False;
7964 end Range_Or_Validity_Checks_Suppressed;
7966 -------------------
7967 -- Remove_Checks --
7968 -------------------
7970 procedure Remove_Checks (Expr : Node_Id) is
7971 function Process (N : Node_Id) return Traverse_Result;
7972 -- Process a single node during the traversal
7974 procedure Traverse is new Traverse_Proc (Process);
7975 -- The traversal procedure itself
7977 -------------
7978 -- Process --
7979 -------------
7981 function Process (N : Node_Id) return Traverse_Result is
7982 begin
7983 if Nkind (N) not in N_Subexpr then
7984 return Skip;
7985 end if;
7987 Set_Do_Range_Check (N, False);
7989 case Nkind (N) is
7990 when N_And_Then =>
7991 Traverse (Left_Opnd (N));
7992 return Skip;
7994 when N_Attribute_Reference =>
7995 Set_Do_Overflow_Check (N, False);
7997 when N_Function_Call =>
7998 Set_Do_Tag_Check (N, False);
8000 when N_Op =>
8001 Set_Do_Overflow_Check (N, False);
8003 case Nkind (N) is
8004 when N_Op_Divide =>
8005 Set_Do_Division_Check (N, False);
8007 when N_Op_And =>
8008 Set_Do_Length_Check (N, False);
8010 when N_Op_Mod =>
8011 Set_Do_Division_Check (N, False);
8013 when N_Op_Or =>
8014 Set_Do_Length_Check (N, False);
8016 when N_Op_Rem =>
8017 Set_Do_Division_Check (N, False);
8019 when N_Op_Xor =>
8020 Set_Do_Length_Check (N, False);
8022 when others =>
8023 null;
8024 end case;
8026 when N_Or_Else =>
8027 Traverse (Left_Opnd (N));
8028 return Skip;
8030 when N_Selected_Component =>
8031 Set_Do_Discriminant_Check (N, False);
8033 when N_Type_Conversion =>
8034 Set_Do_Length_Check (N, False);
8035 Set_Do_Tag_Check (N, False);
8036 Set_Do_Overflow_Check (N, False);
8038 when others =>
8039 null;
8040 end case;
8042 return OK;
8043 end Process;
8045 -- Start of processing for Remove_Checks
8047 begin
8048 Traverse (Expr);
8049 end Remove_Checks;
8051 ----------------------------
8052 -- Selected_Length_Checks --
8053 ----------------------------
8055 function Selected_Length_Checks
8056 (Ck_Node : Node_Id;
8057 Target_Typ : Entity_Id;
8058 Source_Typ : Entity_Id;
8059 Warn_Node : Node_Id) return Check_Result
8061 Loc : constant Source_Ptr := Sloc (Ck_Node);
8062 S_Typ : Entity_Id;
8063 T_Typ : Entity_Id;
8064 Expr_Actual : Node_Id;
8065 Exptyp : Entity_Id;
8066 Cond : Node_Id := Empty;
8067 Do_Access : Boolean := False;
8068 Wnode : Node_Id := Warn_Node;
8069 Ret_Result : Check_Result := (Empty, Empty);
8070 Num_Checks : Natural := 0;
8072 procedure Add_Check (N : Node_Id);
8073 -- Adds the action given to Ret_Result if N is non-Empty
8075 function Get_E_Length (E : Entity_Id; Indx : Nat) return Node_Id;
8076 function Get_N_Length (N : Node_Id; Indx : Nat) return Node_Id;
8077 -- Comments required ???
8079 function Same_Bounds (L : Node_Id; R : Node_Id) return Boolean;
8080 -- True for equal literals and for nodes that denote the same constant
8081 -- entity, even if its value is not a static constant. This includes the
8082 -- case of a discriminal reference within an init proc. Removes some
8083 -- obviously superfluous checks.
8085 function Length_E_Cond
8086 (Exptyp : Entity_Id;
8087 Typ : Entity_Id;
8088 Indx : Nat) return Node_Id;
8089 -- Returns expression to compute:
8090 -- Typ'Length /= Exptyp'Length
8092 function Length_N_Cond
8093 (Expr : Node_Id;
8094 Typ : Entity_Id;
8095 Indx : Nat) return Node_Id;
8096 -- Returns expression to compute:
8097 -- Typ'Length /= Expr'Length
8099 ---------------
8100 -- Add_Check --
8101 ---------------
8103 procedure Add_Check (N : Node_Id) is
8104 begin
8105 if Present (N) then
8107 -- For now, ignore attempt to place more than 2 checks ???
8109 if Num_Checks = 2 then
8110 return;
8111 end if;
8113 pragma Assert (Num_Checks <= 1);
8114 Num_Checks := Num_Checks + 1;
8115 Ret_Result (Num_Checks) := N;
8116 end if;
8117 end Add_Check;
8119 ------------------
8120 -- Get_E_Length --
8121 ------------------
8123 function Get_E_Length (E : Entity_Id; Indx : Nat) return Node_Id is
8124 SE : constant Entity_Id := Scope (E);
8125 N : Node_Id;
8126 E1 : Entity_Id := E;
8128 begin
8129 if Ekind (Scope (E)) = E_Record_Type
8130 and then Has_Discriminants (Scope (E))
8131 then
8132 N := Build_Discriminal_Subtype_Of_Component (E);
8134 if Present (N) then
8135 Insert_Action (Ck_Node, N);
8136 E1 := Defining_Identifier (N);
8137 end if;
8138 end if;
8140 if Ekind (E1) = E_String_Literal_Subtype then
8141 return
8142 Make_Integer_Literal (Loc,
8143 Intval => String_Literal_Length (E1));
8145 elsif SE /= Standard_Standard
8146 and then Ekind (Scope (SE)) = E_Protected_Type
8147 and then Has_Discriminants (Scope (SE))
8148 and then Has_Completion (Scope (SE))
8149 and then not Inside_Init_Proc
8150 then
8151 -- If the type whose length is needed is a private component
8152 -- constrained by a discriminant, we must expand the 'Length
8153 -- attribute into an explicit computation, using the discriminal
8154 -- of the current protected operation. This is because the actual
8155 -- type of the prival is constructed after the protected opera-
8156 -- tion has been fully expanded.
8158 declare
8159 Indx_Type : Node_Id;
8160 Lo : Node_Id;
8161 Hi : Node_Id;
8162 Do_Expand : Boolean := False;
8164 begin
8165 Indx_Type := First_Index (E);
8167 for J in 1 .. Indx - 1 loop
8168 Next_Index (Indx_Type);
8169 end loop;
8171 Get_Index_Bounds (Indx_Type, Lo, Hi);
8173 if Nkind (Lo) = N_Identifier
8174 and then Ekind (Entity (Lo)) = E_In_Parameter
8175 then
8176 Lo := Get_Discriminal (E, Lo);
8177 Do_Expand := True;
8178 end if;
8180 if Nkind (Hi) = N_Identifier
8181 and then Ekind (Entity (Hi)) = E_In_Parameter
8182 then
8183 Hi := Get_Discriminal (E, Hi);
8184 Do_Expand := True;
8185 end if;
8187 if Do_Expand then
8188 if not Is_Entity_Name (Lo) then
8189 Lo := Duplicate_Subexpr_No_Checks (Lo);
8190 end if;
8192 if not Is_Entity_Name (Hi) then
8193 Lo := Duplicate_Subexpr_No_Checks (Hi);
8194 end if;
8196 N :=
8197 Make_Op_Add (Loc,
8198 Left_Opnd =>
8199 Make_Op_Subtract (Loc,
8200 Left_Opnd => Hi,
8201 Right_Opnd => Lo),
8203 Right_Opnd => Make_Integer_Literal (Loc, 1));
8204 return N;
8206 else
8207 N :=
8208 Make_Attribute_Reference (Loc,
8209 Attribute_Name => Name_Length,
8210 Prefix =>
8211 New_Occurrence_Of (E1, Loc));
8213 if Indx > 1 then
8214 Set_Expressions (N, New_List (
8215 Make_Integer_Literal (Loc, Indx)));
8216 end if;
8218 return N;
8219 end if;
8220 end;
8222 else
8223 N :=
8224 Make_Attribute_Reference (Loc,
8225 Attribute_Name => Name_Length,
8226 Prefix =>
8227 New_Occurrence_Of (E1, Loc));
8229 if Indx > 1 then
8230 Set_Expressions (N, New_List (
8231 Make_Integer_Literal (Loc, Indx)));
8232 end if;
8234 return N;
8235 end if;
8236 end Get_E_Length;
8238 ------------------
8239 -- Get_N_Length --
8240 ------------------
8242 function Get_N_Length (N : Node_Id; Indx : Nat) return Node_Id is
8243 begin
8244 return
8245 Make_Attribute_Reference (Loc,
8246 Attribute_Name => Name_Length,
8247 Prefix =>
8248 Duplicate_Subexpr_No_Checks (N, Name_Req => True),
8249 Expressions => New_List (
8250 Make_Integer_Literal (Loc, Indx)));
8251 end Get_N_Length;
8253 -------------------
8254 -- Length_E_Cond --
8255 -------------------
8257 function Length_E_Cond
8258 (Exptyp : Entity_Id;
8259 Typ : Entity_Id;
8260 Indx : Nat) return Node_Id
8262 begin
8263 return
8264 Make_Op_Ne (Loc,
8265 Left_Opnd => Get_E_Length (Typ, Indx),
8266 Right_Opnd => Get_E_Length (Exptyp, Indx));
8267 end Length_E_Cond;
8269 -------------------
8270 -- Length_N_Cond --
8271 -------------------
8273 function Length_N_Cond
8274 (Expr : Node_Id;
8275 Typ : Entity_Id;
8276 Indx : Nat) return Node_Id
8278 begin
8279 return
8280 Make_Op_Ne (Loc,
8281 Left_Opnd => Get_E_Length (Typ, Indx),
8282 Right_Opnd => Get_N_Length (Expr, Indx));
8283 end Length_N_Cond;
8285 -----------------
8286 -- Same_Bounds --
8287 -----------------
8289 function Same_Bounds (L : Node_Id; R : Node_Id) return Boolean is
8290 begin
8291 return
8292 (Nkind (L) = N_Integer_Literal
8293 and then Nkind (R) = N_Integer_Literal
8294 and then Intval (L) = Intval (R))
8296 or else
8297 (Is_Entity_Name (L)
8298 and then Ekind (Entity (L)) = E_Constant
8299 and then ((Is_Entity_Name (R)
8300 and then Entity (L) = Entity (R))
8301 or else
8302 (Nkind (R) = N_Type_Conversion
8303 and then Is_Entity_Name (Expression (R))
8304 and then Entity (L) = Entity (Expression (R)))))
8306 or else
8307 (Is_Entity_Name (R)
8308 and then Ekind (Entity (R)) = E_Constant
8309 and then Nkind (L) = N_Type_Conversion
8310 and then Is_Entity_Name (Expression (L))
8311 and then Entity (R) = Entity (Expression (L)))
8313 or else
8314 (Is_Entity_Name (L)
8315 and then Is_Entity_Name (R)
8316 and then Entity (L) = Entity (R)
8317 and then Ekind (Entity (L)) = E_In_Parameter
8318 and then Inside_Init_Proc);
8319 end Same_Bounds;
8321 -- Start of processing for Selected_Length_Checks
8323 begin
8324 if not Full_Expander_Active then
8325 return Ret_Result;
8326 end if;
8328 if Target_Typ = Any_Type
8329 or else Target_Typ = Any_Composite
8330 or else Raises_Constraint_Error (Ck_Node)
8331 then
8332 return Ret_Result;
8333 end if;
8335 if No (Wnode) then
8336 Wnode := Ck_Node;
8337 end if;
8339 T_Typ := Target_Typ;
8341 if No (Source_Typ) then
8342 S_Typ := Etype (Ck_Node);
8343 else
8344 S_Typ := Source_Typ;
8345 end if;
8347 if S_Typ = Any_Type or else S_Typ = Any_Composite then
8348 return Ret_Result;
8349 end if;
8351 if Is_Access_Type (T_Typ) and then Is_Access_Type (S_Typ) then
8352 S_Typ := Designated_Type (S_Typ);
8353 T_Typ := Designated_Type (T_Typ);
8354 Do_Access := True;
8356 -- A simple optimization for the null case
8358 if Known_Null (Ck_Node) then
8359 return Ret_Result;
8360 end if;
8361 end if;
8363 if Is_Array_Type (T_Typ) and then Is_Array_Type (S_Typ) then
8364 if Is_Constrained (T_Typ) then
8366 -- The checking code to be generated will freeze the corresponding
8367 -- array type. However, we must freeze the type now, so that the
8368 -- freeze node does not appear within the generated if expression,
8369 -- but ahead of it.
8371 Freeze_Before (Ck_Node, T_Typ);
8373 Expr_Actual := Get_Referenced_Object (Ck_Node);
8374 Exptyp := Get_Actual_Subtype (Ck_Node);
8376 if Is_Access_Type (Exptyp) then
8377 Exptyp := Designated_Type (Exptyp);
8378 end if;
8380 -- String_Literal case. This needs to be handled specially be-
8381 -- cause no index types are available for string literals. The
8382 -- condition is simply:
8384 -- T_Typ'Length = string-literal-length
8386 if Nkind (Expr_Actual) = N_String_Literal
8387 and then Ekind (Etype (Expr_Actual)) = E_String_Literal_Subtype
8388 then
8389 Cond :=
8390 Make_Op_Ne (Loc,
8391 Left_Opnd => Get_E_Length (T_Typ, 1),
8392 Right_Opnd =>
8393 Make_Integer_Literal (Loc,
8394 Intval =>
8395 String_Literal_Length (Etype (Expr_Actual))));
8397 -- General array case. Here we have a usable actual subtype for
8398 -- the expression, and the condition is built from the two types
8399 -- (Do_Length):
8401 -- T_Typ'Length /= Exptyp'Length or else
8402 -- T_Typ'Length (2) /= Exptyp'Length (2) or else
8403 -- T_Typ'Length (3) /= Exptyp'Length (3) or else
8404 -- ...
8406 elsif Is_Constrained (Exptyp) then
8407 declare
8408 Ndims : constant Nat := Number_Dimensions (T_Typ);
8410 L_Index : Node_Id;
8411 R_Index : Node_Id;
8412 L_Low : Node_Id;
8413 L_High : Node_Id;
8414 R_Low : Node_Id;
8415 R_High : Node_Id;
8416 L_Length : Uint;
8417 R_Length : Uint;
8418 Ref_Node : Node_Id;
8420 begin
8421 -- At the library level, we need to ensure that the type of
8422 -- the object is elaborated before the check itself is
8423 -- emitted. This is only done if the object is in the
8424 -- current compilation unit, otherwise the type is frozen
8425 -- and elaborated in its unit.
8427 if Is_Itype (Exptyp)
8428 and then
8429 Ekind (Cunit_Entity (Current_Sem_Unit)) = E_Package
8430 and then
8431 not In_Package_Body (Cunit_Entity (Current_Sem_Unit))
8432 and then In_Open_Scopes (Scope (Exptyp))
8433 then
8434 Ref_Node := Make_Itype_Reference (Sloc (Ck_Node));
8435 Set_Itype (Ref_Node, Exptyp);
8436 Insert_Action (Ck_Node, Ref_Node);
8437 end if;
8439 L_Index := First_Index (T_Typ);
8440 R_Index := First_Index (Exptyp);
8442 for Indx in 1 .. Ndims loop
8443 if not (Nkind (L_Index) = N_Raise_Constraint_Error
8444 or else
8445 Nkind (R_Index) = N_Raise_Constraint_Error)
8446 then
8447 Get_Index_Bounds (L_Index, L_Low, L_High);
8448 Get_Index_Bounds (R_Index, R_Low, R_High);
8450 -- Deal with compile time length check. Note that we
8451 -- skip this in the access case, because the access
8452 -- value may be null, so we cannot know statically.
8454 if not Do_Access
8455 and then Compile_Time_Known_Value (L_Low)
8456 and then Compile_Time_Known_Value (L_High)
8457 and then Compile_Time_Known_Value (R_Low)
8458 and then Compile_Time_Known_Value (R_High)
8459 then
8460 if Expr_Value (L_High) >= Expr_Value (L_Low) then
8461 L_Length := Expr_Value (L_High) -
8462 Expr_Value (L_Low) + 1;
8463 else
8464 L_Length := UI_From_Int (0);
8465 end if;
8467 if Expr_Value (R_High) >= Expr_Value (R_Low) then
8468 R_Length := Expr_Value (R_High) -
8469 Expr_Value (R_Low) + 1;
8470 else
8471 R_Length := UI_From_Int (0);
8472 end if;
8474 if L_Length > R_Length then
8475 Add_Check
8476 (Compile_Time_Constraint_Error
8477 (Wnode, "too few elements for}??", T_Typ));
8479 elsif L_Length < R_Length then
8480 Add_Check
8481 (Compile_Time_Constraint_Error
8482 (Wnode, "too many elements for}??", T_Typ));
8483 end if;
8485 -- The comparison for an individual index subtype
8486 -- is omitted if the corresponding index subtypes
8487 -- statically match, since the result is known to
8488 -- be true. Note that this test is worth while even
8489 -- though we do static evaluation, because non-static
8490 -- subtypes can statically match.
8492 elsif not
8493 Subtypes_Statically_Match
8494 (Etype (L_Index), Etype (R_Index))
8496 and then not
8497 (Same_Bounds (L_Low, R_Low)
8498 and then Same_Bounds (L_High, R_High))
8499 then
8500 Evolve_Or_Else
8501 (Cond, Length_E_Cond (Exptyp, T_Typ, Indx));
8502 end if;
8504 Next (L_Index);
8505 Next (R_Index);
8506 end if;
8507 end loop;
8508 end;
8510 -- Handle cases where we do not get a usable actual subtype that
8511 -- is constrained. This happens for example in the function call
8512 -- and explicit dereference cases. In these cases, we have to get
8513 -- the length or range from the expression itself, making sure we
8514 -- do not evaluate it more than once.
8516 -- Here Ck_Node is the original expression, or more properly the
8517 -- result of applying Duplicate_Expr to the original tree, forcing
8518 -- the result to be a name.
8520 else
8521 declare
8522 Ndims : constant Nat := Number_Dimensions (T_Typ);
8524 begin
8525 -- Build the condition for the explicit dereference case
8527 for Indx in 1 .. Ndims loop
8528 Evolve_Or_Else
8529 (Cond, Length_N_Cond (Ck_Node, T_Typ, Indx));
8530 end loop;
8531 end;
8532 end if;
8533 end if;
8534 end if;
8536 -- Construct the test and insert into the tree
8538 if Present (Cond) then
8539 if Do_Access then
8540 Cond := Guard_Access (Cond, Loc, Ck_Node);
8541 end if;
8543 Add_Check
8544 (Make_Raise_Constraint_Error (Loc,
8545 Condition => Cond,
8546 Reason => CE_Length_Check_Failed));
8547 end if;
8549 return Ret_Result;
8550 end Selected_Length_Checks;
8552 ---------------------------
8553 -- Selected_Range_Checks --
8554 ---------------------------
8556 function Selected_Range_Checks
8557 (Ck_Node : Node_Id;
8558 Target_Typ : Entity_Id;
8559 Source_Typ : Entity_Id;
8560 Warn_Node : Node_Id) return Check_Result
8562 Loc : constant Source_Ptr := Sloc (Ck_Node);
8563 S_Typ : Entity_Id;
8564 T_Typ : Entity_Id;
8565 Expr_Actual : Node_Id;
8566 Exptyp : Entity_Id;
8567 Cond : Node_Id := Empty;
8568 Do_Access : Boolean := False;
8569 Wnode : Node_Id := Warn_Node;
8570 Ret_Result : Check_Result := (Empty, Empty);
8571 Num_Checks : Integer := 0;
8573 procedure Add_Check (N : Node_Id);
8574 -- Adds the action given to Ret_Result if N is non-Empty
8576 function Discrete_Range_Cond
8577 (Expr : Node_Id;
8578 Typ : Entity_Id) return Node_Id;
8579 -- Returns expression to compute:
8580 -- Low_Bound (Expr) < Typ'First
8581 -- or else
8582 -- High_Bound (Expr) > Typ'Last
8584 function Discrete_Expr_Cond
8585 (Expr : Node_Id;
8586 Typ : Entity_Id) return Node_Id;
8587 -- Returns expression to compute:
8588 -- Expr < Typ'First
8589 -- or else
8590 -- Expr > Typ'Last
8592 function Get_E_First_Or_Last
8593 (Loc : Source_Ptr;
8594 E : Entity_Id;
8595 Indx : Nat;
8596 Nam : Name_Id) return Node_Id;
8597 -- Returns an attribute reference
8598 -- E'First or E'Last
8599 -- with a source location of Loc.
8601 -- Nam is Name_First or Name_Last, according to which attribute is
8602 -- desired. If Indx is non-zero, it is passed as a literal in the
8603 -- Expressions of the attribute reference (identifying the desired
8604 -- array dimension).
8606 function Get_N_First (N : Node_Id; Indx : Nat) return Node_Id;
8607 function Get_N_Last (N : Node_Id; Indx : Nat) return Node_Id;
8608 -- Returns expression to compute:
8609 -- N'First or N'Last using Duplicate_Subexpr_No_Checks
8611 function Range_E_Cond
8612 (Exptyp : Entity_Id;
8613 Typ : Entity_Id;
8614 Indx : Nat)
8615 return Node_Id;
8616 -- Returns expression to compute:
8617 -- Exptyp'First < Typ'First or else Exptyp'Last > Typ'Last
8619 function Range_Equal_E_Cond
8620 (Exptyp : Entity_Id;
8621 Typ : Entity_Id;
8622 Indx : Nat) return Node_Id;
8623 -- Returns expression to compute:
8624 -- Exptyp'First /= Typ'First or else Exptyp'Last /= Typ'Last
8626 function Range_N_Cond
8627 (Expr : Node_Id;
8628 Typ : Entity_Id;
8629 Indx : Nat) return Node_Id;
8630 -- Return expression to compute:
8631 -- Expr'First < Typ'First or else Expr'Last > Typ'Last
8633 ---------------
8634 -- Add_Check --
8635 ---------------
8637 procedure Add_Check (N : Node_Id) is
8638 begin
8639 if Present (N) then
8641 -- For now, ignore attempt to place more than 2 checks ???
8643 if Num_Checks = 2 then
8644 return;
8645 end if;
8647 pragma Assert (Num_Checks <= 1);
8648 Num_Checks := Num_Checks + 1;
8649 Ret_Result (Num_Checks) := N;
8650 end if;
8651 end Add_Check;
8653 -------------------------
8654 -- Discrete_Expr_Cond --
8655 -------------------------
8657 function Discrete_Expr_Cond
8658 (Expr : Node_Id;
8659 Typ : Entity_Id) return Node_Id
8661 begin
8662 return
8663 Make_Or_Else (Loc,
8664 Left_Opnd =>
8665 Make_Op_Lt (Loc,
8666 Left_Opnd =>
8667 Convert_To (Base_Type (Typ),
8668 Duplicate_Subexpr_No_Checks (Expr)),
8669 Right_Opnd =>
8670 Convert_To (Base_Type (Typ),
8671 Get_E_First_Or_Last (Loc, Typ, 0, Name_First))),
8673 Right_Opnd =>
8674 Make_Op_Gt (Loc,
8675 Left_Opnd =>
8676 Convert_To (Base_Type (Typ),
8677 Duplicate_Subexpr_No_Checks (Expr)),
8678 Right_Opnd =>
8679 Convert_To
8680 (Base_Type (Typ),
8681 Get_E_First_Or_Last (Loc, Typ, 0, Name_Last))));
8682 end Discrete_Expr_Cond;
8684 -------------------------
8685 -- Discrete_Range_Cond --
8686 -------------------------
8688 function Discrete_Range_Cond
8689 (Expr : Node_Id;
8690 Typ : Entity_Id) return Node_Id
8692 LB : Node_Id := Low_Bound (Expr);
8693 HB : Node_Id := High_Bound (Expr);
8695 Left_Opnd : Node_Id;
8696 Right_Opnd : Node_Id;
8698 begin
8699 if Nkind (LB) = N_Identifier
8700 and then Ekind (Entity (LB)) = E_Discriminant
8701 then
8702 LB := New_Occurrence_Of (Discriminal (Entity (LB)), Loc);
8703 end if;
8705 Left_Opnd :=
8706 Make_Op_Lt (Loc,
8707 Left_Opnd =>
8708 Convert_To
8709 (Base_Type (Typ), Duplicate_Subexpr_No_Checks (LB)),
8711 Right_Opnd =>
8712 Convert_To
8713 (Base_Type (Typ),
8714 Get_E_First_Or_Last (Loc, Typ, 0, Name_First)));
8716 if Nkind (HB) = N_Identifier
8717 and then Ekind (Entity (HB)) = E_Discriminant
8718 then
8719 HB := New_Occurrence_Of (Discriminal (Entity (HB)), Loc);
8720 end if;
8722 Right_Opnd :=
8723 Make_Op_Gt (Loc,
8724 Left_Opnd =>
8725 Convert_To
8726 (Base_Type (Typ), Duplicate_Subexpr_No_Checks (HB)),
8728 Right_Opnd =>
8729 Convert_To
8730 (Base_Type (Typ),
8731 Get_E_First_Or_Last (Loc, Typ, 0, Name_Last)));
8733 return Make_Or_Else (Loc, Left_Opnd, Right_Opnd);
8734 end Discrete_Range_Cond;
8736 -------------------------
8737 -- Get_E_First_Or_Last --
8738 -------------------------
8740 function Get_E_First_Or_Last
8741 (Loc : Source_Ptr;
8742 E : Entity_Id;
8743 Indx : Nat;
8744 Nam : Name_Id) return Node_Id
8746 Exprs : List_Id;
8747 begin
8748 if Indx > 0 then
8749 Exprs := New_List (Make_Integer_Literal (Loc, UI_From_Int (Indx)));
8750 else
8751 Exprs := No_List;
8752 end if;
8754 return Make_Attribute_Reference (Loc,
8755 Prefix => New_Occurrence_Of (E, Loc),
8756 Attribute_Name => Nam,
8757 Expressions => Exprs);
8758 end Get_E_First_Or_Last;
8760 -----------------
8761 -- Get_N_First --
8762 -----------------
8764 function Get_N_First (N : Node_Id; Indx : Nat) return Node_Id is
8765 begin
8766 return
8767 Make_Attribute_Reference (Loc,
8768 Attribute_Name => Name_First,
8769 Prefix =>
8770 Duplicate_Subexpr_No_Checks (N, Name_Req => True),
8771 Expressions => New_List (
8772 Make_Integer_Literal (Loc, Indx)));
8773 end Get_N_First;
8775 ----------------
8776 -- Get_N_Last --
8777 ----------------
8779 function Get_N_Last (N : Node_Id; Indx : Nat) return Node_Id is
8780 begin
8781 return
8782 Make_Attribute_Reference (Loc,
8783 Attribute_Name => Name_Last,
8784 Prefix =>
8785 Duplicate_Subexpr_No_Checks (N, Name_Req => True),
8786 Expressions => New_List (
8787 Make_Integer_Literal (Loc, Indx)));
8788 end Get_N_Last;
8790 ------------------
8791 -- Range_E_Cond --
8792 ------------------
8794 function Range_E_Cond
8795 (Exptyp : Entity_Id;
8796 Typ : Entity_Id;
8797 Indx : Nat) return Node_Id
8799 begin
8800 return
8801 Make_Or_Else (Loc,
8802 Left_Opnd =>
8803 Make_Op_Lt (Loc,
8804 Left_Opnd =>
8805 Get_E_First_Or_Last (Loc, Exptyp, Indx, Name_First),
8806 Right_Opnd =>
8807 Get_E_First_Or_Last (Loc, Typ, Indx, Name_First)),
8809 Right_Opnd =>
8810 Make_Op_Gt (Loc,
8811 Left_Opnd =>
8812 Get_E_First_Or_Last (Loc, Exptyp, Indx, Name_Last),
8813 Right_Opnd =>
8814 Get_E_First_Or_Last (Loc, Typ, Indx, Name_Last)));
8815 end Range_E_Cond;
8817 ------------------------
8818 -- Range_Equal_E_Cond --
8819 ------------------------
8821 function Range_Equal_E_Cond
8822 (Exptyp : Entity_Id;
8823 Typ : Entity_Id;
8824 Indx : Nat) return Node_Id
8826 begin
8827 return
8828 Make_Or_Else (Loc,
8829 Left_Opnd =>
8830 Make_Op_Ne (Loc,
8831 Left_Opnd =>
8832 Get_E_First_Or_Last (Loc, Exptyp, Indx, Name_First),
8833 Right_Opnd =>
8834 Get_E_First_Or_Last (Loc, Typ, Indx, Name_First)),
8836 Right_Opnd =>
8837 Make_Op_Ne (Loc,
8838 Left_Opnd =>
8839 Get_E_First_Or_Last (Loc, Exptyp, Indx, Name_Last),
8840 Right_Opnd =>
8841 Get_E_First_Or_Last (Loc, Typ, Indx, Name_Last)));
8842 end Range_Equal_E_Cond;
8844 ------------------
8845 -- Range_N_Cond --
8846 ------------------
8848 function Range_N_Cond
8849 (Expr : Node_Id;
8850 Typ : Entity_Id;
8851 Indx : Nat) return Node_Id
8853 begin
8854 return
8855 Make_Or_Else (Loc,
8856 Left_Opnd =>
8857 Make_Op_Lt (Loc,
8858 Left_Opnd =>
8859 Get_N_First (Expr, Indx),
8860 Right_Opnd =>
8861 Get_E_First_Or_Last (Loc, Typ, Indx, Name_First)),
8863 Right_Opnd =>
8864 Make_Op_Gt (Loc,
8865 Left_Opnd =>
8866 Get_N_Last (Expr, Indx),
8867 Right_Opnd =>
8868 Get_E_First_Or_Last (Loc, Typ, Indx, Name_Last)));
8869 end Range_N_Cond;
8871 -- Start of processing for Selected_Range_Checks
8873 begin
8874 if not Full_Expander_Active then
8875 return Ret_Result;
8876 end if;
8878 if Target_Typ = Any_Type
8879 or else Target_Typ = Any_Composite
8880 or else Raises_Constraint_Error (Ck_Node)
8881 then
8882 return Ret_Result;
8883 end if;
8885 if No (Wnode) then
8886 Wnode := Ck_Node;
8887 end if;
8889 T_Typ := Target_Typ;
8891 if No (Source_Typ) then
8892 S_Typ := Etype (Ck_Node);
8893 else
8894 S_Typ := Source_Typ;
8895 end if;
8897 if S_Typ = Any_Type or else S_Typ = Any_Composite then
8898 return Ret_Result;
8899 end if;
8901 -- The order of evaluating T_Typ before S_Typ seems to be critical
8902 -- because S_Typ can be derived from Etype (Ck_Node), if it's not passed
8903 -- in, and since Node can be an N_Range node, it might be invalid.
8904 -- Should there be an assert check somewhere for taking the Etype of
8905 -- an N_Range node ???
8907 if Is_Access_Type (T_Typ) and then Is_Access_Type (S_Typ) then
8908 S_Typ := Designated_Type (S_Typ);
8909 T_Typ := Designated_Type (T_Typ);
8910 Do_Access := True;
8912 -- A simple optimization for the null case
8914 if Known_Null (Ck_Node) then
8915 return Ret_Result;
8916 end if;
8917 end if;
8919 -- For an N_Range Node, check for a null range and then if not
8920 -- null generate a range check action.
8922 if Nkind (Ck_Node) = N_Range then
8924 -- There's no point in checking a range against itself
8926 if Ck_Node = Scalar_Range (T_Typ) then
8927 return Ret_Result;
8928 end if;
8930 declare
8931 T_LB : constant Node_Id := Type_Low_Bound (T_Typ);
8932 T_HB : constant Node_Id := Type_High_Bound (T_Typ);
8933 Known_T_LB : constant Boolean := Compile_Time_Known_Value (T_LB);
8934 Known_T_HB : constant Boolean := Compile_Time_Known_Value (T_HB);
8936 LB : Node_Id := Low_Bound (Ck_Node);
8937 HB : Node_Id := High_Bound (Ck_Node);
8938 Known_LB : Boolean;
8939 Known_HB : Boolean;
8941 Null_Range : Boolean;
8942 Out_Of_Range_L : Boolean;
8943 Out_Of_Range_H : Boolean;
8945 begin
8946 -- Compute what is known at compile time
8948 if Known_T_LB and Known_T_HB then
8949 if Compile_Time_Known_Value (LB) then
8950 Known_LB := True;
8952 -- There's no point in checking that a bound is within its
8953 -- own range so pretend that it is known in this case. First
8954 -- deal with low bound.
8956 elsif Ekind (Etype (LB)) = E_Signed_Integer_Subtype
8957 and then Scalar_Range (Etype (LB)) = Scalar_Range (T_Typ)
8958 then
8959 LB := T_LB;
8960 Known_LB := True;
8962 else
8963 Known_LB := False;
8964 end if;
8966 -- Likewise for the high bound
8968 if Compile_Time_Known_Value (HB) then
8969 Known_HB := True;
8971 elsif Ekind (Etype (HB)) = E_Signed_Integer_Subtype
8972 and then Scalar_Range (Etype (HB)) = Scalar_Range (T_Typ)
8973 then
8974 HB := T_HB;
8975 Known_HB := True;
8977 else
8978 Known_HB := False;
8979 end if;
8980 end if;
8982 -- Check for case where everything is static and we can do the
8983 -- check at compile time. This is skipped if we have an access
8984 -- type, since the access value may be null.
8986 -- ??? This code can be improved since you only need to know that
8987 -- the two respective bounds (LB & T_LB or HB & T_HB) are known at
8988 -- compile time to emit pertinent messages.
8990 if Known_T_LB and Known_T_HB and Known_LB and Known_HB
8991 and not Do_Access
8992 then
8993 -- Floating-point case
8995 if Is_Floating_Point_Type (S_Typ) then
8996 Null_Range := Expr_Value_R (HB) < Expr_Value_R (LB);
8997 Out_Of_Range_L :=
8998 (Expr_Value_R (LB) < Expr_Value_R (T_LB))
8999 or else
9000 (Expr_Value_R (LB) > Expr_Value_R (T_HB));
9002 Out_Of_Range_H :=
9003 (Expr_Value_R (HB) > Expr_Value_R (T_HB))
9004 or else
9005 (Expr_Value_R (HB) < Expr_Value_R (T_LB));
9007 -- Fixed or discrete type case
9009 else
9010 Null_Range := Expr_Value (HB) < Expr_Value (LB);
9011 Out_Of_Range_L :=
9012 (Expr_Value (LB) < Expr_Value (T_LB))
9013 or else
9014 (Expr_Value (LB) > Expr_Value (T_HB));
9016 Out_Of_Range_H :=
9017 (Expr_Value (HB) > Expr_Value (T_HB))
9018 or else
9019 (Expr_Value (HB) < Expr_Value (T_LB));
9020 end if;
9022 if not Null_Range then
9023 if Out_Of_Range_L then
9024 if No (Warn_Node) then
9025 Add_Check
9026 (Compile_Time_Constraint_Error
9027 (Low_Bound (Ck_Node),
9028 "static value out of range of}??", T_Typ));
9030 else
9031 Add_Check
9032 (Compile_Time_Constraint_Error
9033 (Wnode,
9034 "static range out of bounds of}??", T_Typ));
9035 end if;
9036 end if;
9038 if Out_Of_Range_H then
9039 if No (Warn_Node) then
9040 Add_Check
9041 (Compile_Time_Constraint_Error
9042 (High_Bound (Ck_Node),
9043 "static value out of range of}??", T_Typ));
9045 else
9046 Add_Check
9047 (Compile_Time_Constraint_Error
9048 (Wnode,
9049 "static range out of bounds of}??", T_Typ));
9050 end if;
9051 end if;
9052 end if;
9054 else
9055 declare
9056 LB : Node_Id := Low_Bound (Ck_Node);
9057 HB : Node_Id := High_Bound (Ck_Node);
9059 begin
9060 -- If either bound is a discriminant and we are within the
9061 -- record declaration, it is a use of the discriminant in a
9062 -- constraint of a component, and nothing can be checked
9063 -- here. The check will be emitted within the init proc.
9064 -- Before then, the discriminal has no real meaning.
9065 -- Similarly, if the entity is a discriminal, there is no
9066 -- check to perform yet.
9068 -- The same holds within a discriminated synchronized type,
9069 -- where the discriminant may constrain a component or an
9070 -- entry family.
9072 if Nkind (LB) = N_Identifier
9073 and then Denotes_Discriminant (LB, True)
9074 then
9075 if Current_Scope = Scope (Entity (LB))
9076 or else Is_Concurrent_Type (Current_Scope)
9077 or else Ekind (Entity (LB)) /= E_Discriminant
9078 then
9079 return Ret_Result;
9080 else
9081 LB :=
9082 New_Occurrence_Of (Discriminal (Entity (LB)), Loc);
9083 end if;
9084 end if;
9086 if Nkind (HB) = N_Identifier
9087 and then Denotes_Discriminant (HB, True)
9088 then
9089 if Current_Scope = Scope (Entity (HB))
9090 or else Is_Concurrent_Type (Current_Scope)
9091 or else Ekind (Entity (HB)) /= E_Discriminant
9092 then
9093 return Ret_Result;
9094 else
9095 HB :=
9096 New_Occurrence_Of (Discriminal (Entity (HB)), Loc);
9097 end if;
9098 end if;
9100 Cond := Discrete_Range_Cond (Ck_Node, T_Typ);
9101 Set_Paren_Count (Cond, 1);
9103 Cond :=
9104 Make_And_Then (Loc,
9105 Left_Opnd =>
9106 Make_Op_Ge (Loc,
9107 Left_Opnd => Duplicate_Subexpr_No_Checks (HB),
9108 Right_Opnd => Duplicate_Subexpr_No_Checks (LB)),
9109 Right_Opnd => Cond);
9110 end;
9111 end if;
9112 end;
9114 elsif Is_Scalar_Type (S_Typ) then
9116 -- This somewhat duplicates what Apply_Scalar_Range_Check does,
9117 -- except the above simply sets a flag in the node and lets
9118 -- gigi generate the check base on the Etype of the expression.
9119 -- Sometimes, however we want to do a dynamic check against an
9120 -- arbitrary target type, so we do that here.
9122 if Ekind (Base_Type (S_Typ)) /= Ekind (Base_Type (T_Typ)) then
9123 Cond := Discrete_Expr_Cond (Ck_Node, T_Typ);
9125 -- For literals, we can tell if the constraint error will be
9126 -- raised at compile time, so we never need a dynamic check, but
9127 -- if the exception will be raised, then post the usual warning,
9128 -- and replace the literal with a raise constraint error
9129 -- expression. As usual, skip this for access types
9131 elsif Compile_Time_Known_Value (Ck_Node)
9132 and then not Do_Access
9133 then
9134 declare
9135 LB : constant Node_Id := Type_Low_Bound (T_Typ);
9136 UB : constant Node_Id := Type_High_Bound (T_Typ);
9138 Out_Of_Range : Boolean;
9139 Static_Bounds : constant Boolean :=
9140 Compile_Time_Known_Value (LB)
9141 and Compile_Time_Known_Value (UB);
9143 begin
9144 -- Following range tests should use Sem_Eval routine ???
9146 if Static_Bounds then
9147 if Is_Floating_Point_Type (S_Typ) then
9148 Out_Of_Range :=
9149 (Expr_Value_R (Ck_Node) < Expr_Value_R (LB))
9150 or else
9151 (Expr_Value_R (Ck_Node) > Expr_Value_R (UB));
9153 -- Fixed or discrete type
9155 else
9156 Out_Of_Range :=
9157 Expr_Value (Ck_Node) < Expr_Value (LB)
9158 or else
9159 Expr_Value (Ck_Node) > Expr_Value (UB);
9160 end if;
9162 -- Bounds of the type are static and the literal is out of
9163 -- range so output a warning message.
9165 if Out_Of_Range then
9166 if No (Warn_Node) then
9167 Add_Check
9168 (Compile_Time_Constraint_Error
9169 (Ck_Node,
9170 "static value out of range of}??", T_Typ));
9172 else
9173 Add_Check
9174 (Compile_Time_Constraint_Error
9175 (Wnode,
9176 "static value out of range of}??", T_Typ));
9177 end if;
9178 end if;
9180 else
9181 Cond := Discrete_Expr_Cond (Ck_Node, T_Typ);
9182 end if;
9183 end;
9185 -- Here for the case of a non-static expression, we need a runtime
9186 -- check unless the source type range is guaranteed to be in the
9187 -- range of the target type.
9189 else
9190 if not In_Subrange_Of (S_Typ, T_Typ) then
9191 Cond := Discrete_Expr_Cond (Ck_Node, T_Typ);
9192 end if;
9193 end if;
9194 end if;
9196 if Is_Array_Type (T_Typ) and then Is_Array_Type (S_Typ) then
9197 if Is_Constrained (T_Typ) then
9199 Expr_Actual := Get_Referenced_Object (Ck_Node);
9200 Exptyp := Get_Actual_Subtype (Expr_Actual);
9202 if Is_Access_Type (Exptyp) then
9203 Exptyp := Designated_Type (Exptyp);
9204 end if;
9206 -- String_Literal case. This needs to be handled specially be-
9207 -- cause no index types are available for string literals. The
9208 -- condition is simply:
9210 -- T_Typ'Length = string-literal-length
9212 if Nkind (Expr_Actual) = N_String_Literal then
9213 null;
9215 -- General array case. Here we have a usable actual subtype for
9216 -- the expression, and the condition is built from the two types
9218 -- T_Typ'First < Exptyp'First or else
9219 -- T_Typ'Last > Exptyp'Last or else
9220 -- T_Typ'First(1) < Exptyp'First(1) or else
9221 -- T_Typ'Last(1) > Exptyp'Last(1) or else
9222 -- ...
9224 elsif Is_Constrained (Exptyp) then
9225 declare
9226 Ndims : constant Nat := Number_Dimensions (T_Typ);
9228 L_Index : Node_Id;
9229 R_Index : Node_Id;
9231 begin
9232 L_Index := First_Index (T_Typ);
9233 R_Index := First_Index (Exptyp);
9235 for Indx in 1 .. Ndims loop
9236 if not (Nkind (L_Index) = N_Raise_Constraint_Error
9237 or else
9238 Nkind (R_Index) = N_Raise_Constraint_Error)
9239 then
9240 -- Deal with compile time length check. Note that we
9241 -- skip this in the access case, because the access
9242 -- value may be null, so we cannot know statically.
9244 if not
9245 Subtypes_Statically_Match
9246 (Etype (L_Index), Etype (R_Index))
9247 then
9248 -- If the target type is constrained then we
9249 -- have to check for exact equality of bounds
9250 -- (required for qualified expressions).
9252 if Is_Constrained (T_Typ) then
9253 Evolve_Or_Else
9254 (Cond,
9255 Range_Equal_E_Cond (Exptyp, T_Typ, Indx));
9256 else
9257 Evolve_Or_Else
9258 (Cond, Range_E_Cond (Exptyp, T_Typ, Indx));
9259 end if;
9260 end if;
9262 Next (L_Index);
9263 Next (R_Index);
9264 end if;
9265 end loop;
9266 end;
9268 -- Handle cases where we do not get a usable actual subtype that
9269 -- is constrained. This happens for example in the function call
9270 -- and explicit dereference cases. In these cases, we have to get
9271 -- the length or range from the expression itself, making sure we
9272 -- do not evaluate it more than once.
9274 -- Here Ck_Node is the original expression, or more properly the
9275 -- result of applying Duplicate_Expr to the original tree,
9276 -- forcing the result to be a name.
9278 else
9279 declare
9280 Ndims : constant Nat := Number_Dimensions (T_Typ);
9282 begin
9283 -- Build the condition for the explicit dereference case
9285 for Indx in 1 .. Ndims loop
9286 Evolve_Or_Else
9287 (Cond, Range_N_Cond (Ck_Node, T_Typ, Indx));
9288 end loop;
9289 end;
9290 end if;
9292 else
9293 -- For a conversion to an unconstrained array type, generate an
9294 -- Action to check that the bounds of the source value are within
9295 -- the constraints imposed by the target type (RM 4.6(38)). No
9296 -- check is needed for a conversion to an access to unconstrained
9297 -- array type, as 4.6(24.15/2) requires the designated subtypes
9298 -- of the two access types to statically match.
9300 if Nkind (Parent (Ck_Node)) = N_Type_Conversion
9301 and then not Do_Access
9302 then
9303 declare
9304 Opnd_Index : Node_Id;
9305 Targ_Index : Node_Id;
9306 Opnd_Range : Node_Id;
9308 begin
9309 Opnd_Index := First_Index (Get_Actual_Subtype (Ck_Node));
9310 Targ_Index := First_Index (T_Typ);
9311 while Present (Opnd_Index) loop
9313 -- If the index is a range, use its bounds. If it is an
9314 -- entity (as will be the case if it is a named subtype
9315 -- or an itype created for a slice) retrieve its range.
9317 if Is_Entity_Name (Opnd_Index)
9318 and then Is_Type (Entity (Opnd_Index))
9319 then
9320 Opnd_Range := Scalar_Range (Entity (Opnd_Index));
9321 else
9322 Opnd_Range := Opnd_Index;
9323 end if;
9325 if Nkind (Opnd_Range) = N_Range then
9326 if Is_In_Range
9327 (Low_Bound (Opnd_Range), Etype (Targ_Index),
9328 Assume_Valid => True)
9329 and then
9330 Is_In_Range
9331 (High_Bound (Opnd_Range), Etype (Targ_Index),
9332 Assume_Valid => True)
9333 then
9334 null;
9336 -- If null range, no check needed
9338 elsif
9339 Compile_Time_Known_Value (High_Bound (Opnd_Range))
9340 and then
9341 Compile_Time_Known_Value (Low_Bound (Opnd_Range))
9342 and then
9343 Expr_Value (High_Bound (Opnd_Range)) <
9344 Expr_Value (Low_Bound (Opnd_Range))
9345 then
9346 null;
9348 elsif Is_Out_Of_Range
9349 (Low_Bound (Opnd_Range), Etype (Targ_Index),
9350 Assume_Valid => True)
9351 or else
9352 Is_Out_Of_Range
9353 (High_Bound (Opnd_Range), Etype (Targ_Index),
9354 Assume_Valid => True)
9355 then
9356 Add_Check
9357 (Compile_Time_Constraint_Error
9358 (Wnode, "value out of range of}??", T_Typ));
9360 else
9361 Evolve_Or_Else
9362 (Cond,
9363 Discrete_Range_Cond
9364 (Opnd_Range, Etype (Targ_Index)));
9365 end if;
9366 end if;
9368 Next_Index (Opnd_Index);
9369 Next_Index (Targ_Index);
9370 end loop;
9371 end;
9372 end if;
9373 end if;
9374 end if;
9376 -- Construct the test and insert into the tree
9378 if Present (Cond) then
9379 if Do_Access then
9380 Cond := Guard_Access (Cond, Loc, Ck_Node);
9381 end if;
9383 Add_Check
9384 (Make_Raise_Constraint_Error (Loc,
9385 Condition => Cond,
9386 Reason => CE_Range_Check_Failed));
9387 end if;
9389 return Ret_Result;
9390 end Selected_Range_Checks;
9392 -------------------------------
9393 -- Storage_Checks_Suppressed --
9394 -------------------------------
9396 function Storage_Checks_Suppressed (E : Entity_Id) return Boolean is
9397 begin
9398 if Present (E) and then Checks_May_Be_Suppressed (E) then
9399 return Is_Check_Suppressed (E, Storage_Check);
9400 else
9401 return Scope_Suppress.Suppress (Storage_Check);
9402 end if;
9403 end Storage_Checks_Suppressed;
9405 ---------------------------
9406 -- Tag_Checks_Suppressed --
9407 ---------------------------
9409 function Tag_Checks_Suppressed (E : Entity_Id) return Boolean is
9410 begin
9411 if Present (E)
9412 and then Checks_May_Be_Suppressed (E)
9413 then
9414 return Is_Check_Suppressed (E, Tag_Check);
9415 end if;
9417 return Scope_Suppress.Suppress (Tag_Check);
9418 end Tag_Checks_Suppressed;
9420 --------------------------
9421 -- Validity_Check_Range --
9422 --------------------------
9424 procedure Validity_Check_Range (N : Node_Id) is
9425 begin
9426 if Validity_Checks_On and Validity_Check_Operands then
9427 if Nkind (N) = N_Range then
9428 Ensure_Valid (Low_Bound (N));
9429 Ensure_Valid (High_Bound (N));
9430 end if;
9431 end if;
9432 end Validity_Check_Range;
9434 --------------------------------
9435 -- Validity_Checks_Suppressed --
9436 --------------------------------
9438 function Validity_Checks_Suppressed (E : Entity_Id) return Boolean is
9439 begin
9440 if Present (E) and then Checks_May_Be_Suppressed (E) then
9441 return Is_Check_Suppressed (E, Validity_Check);
9442 else
9443 return Scope_Suppress.Suppress (Validity_Check);
9444 end if;
9445 end Validity_Checks_Suppressed;
9447 end Checks;