1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2008, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 -- Package containing routines used to deal with runtime checks. These
27 -- routines are used both by the semantics and by the expander. In some
28 -- cases, checks are enabled simply by setting flags for gigi, and in
29 -- other cases the code for the check is expanded.
31 -- The approach used for range and length checks, in regards to suppressed
32 -- checks, is to attempt to detect at compilation time that a constraint
33 -- error will occur. If this is detected a warning or error is issued and the
34 -- offending expression or statement replaced with a constraint error node.
35 -- This always occurs whether checks are suppressed or not. Dynamic range
36 -- checks are, of course, not inserted if checks are suppressed.
38 with Namet; use Namet;
40 with Types; use Types;
41 with Uintp; use Uintp;
46 -- Called for each new main source program, to initialize internal
47 -- variables used in the package body of the Checks unit.
49 function Access_Checks_Suppressed (E : Entity_Id) return Boolean;
50 function Accessibility_Checks_Suppressed (E : Entity_Id) return Boolean;
51 function Alignment_Checks_Suppressed (E : Entity_Id) return Boolean;
52 function Discriminant_Checks_Suppressed (E : Entity_Id) return Boolean;
53 function Division_Checks_Suppressed (E : Entity_Id) return Boolean;
54 function Elaboration_Checks_Suppressed (E : Entity_Id) return Boolean;
55 function Index_Checks_Suppressed (E : Entity_Id) return Boolean;
56 function Length_Checks_Suppressed (E : Entity_Id) return Boolean;
57 function Overflow_Checks_Suppressed (E : Entity_Id) return Boolean;
58 function Range_Checks_Suppressed (E : Entity_Id) return Boolean;
59 function Storage_Checks_Suppressed (E : Entity_Id) return Boolean;
60 function Tag_Checks_Suppressed (E : Entity_Id) return Boolean;
61 function Validity_Checks_Suppressed (E : Entity_Id) return Boolean;
62 -- These functions check to see if the named check is suppressed, either
63 -- by an active scope suppress setting, or because the check has been
64 -- specifically suppressed for the given entity. If no entity is relevant
65 -- for the current check, then Empty is used as an argument. Note: the
66 -- reason we insist on specifying Empty is to force the caller to think
67 -- about whether there is any relevant entity that should be checked.
69 -------------------------------------------
70 -- Procedures to Activate Checking Flags --
71 -------------------------------------------
73 procedure Activate_Division_Check (N : Node_Id);
74 pragma Inline (Activate_Division_Check);
75 -- Sets Do_Division_Check flag in node N, and handles possible local raise.
76 -- Always call this routine rather than calling Set_Do_Division_Check to
77 -- set an explicit value of True, to ensure handling the local raise case.
79 procedure Activate_Overflow_Check (N : Node_Id);
80 pragma Inline (Activate_Overflow_Check);
81 -- Sets Do_Overflow_Check flag in node N, and handles possible local raise.
82 -- Always call this routine rather than calling Set_Do_Overflow_Check to
83 -- set an explicit value of True, to ensure handling the local raise case.
85 procedure Activate_Range_Check (N : Node_Id);
86 pragma Inline (Activate_Range_Check);
87 -- Sets Do_Range_Check flag in node N, and handles possible local raise
88 -- Always call this routine rather than calling Set_Do_Range_Check to
89 -- set an explicit value of True, to ensure handling the local raise case.
91 --------------------------------
92 -- Procedures to Apply Checks --
93 --------------------------------
95 -- General note on following checks. These checks are always active if
96 -- Expander_Active and not Inside_A_Generic. They are inactive and have
97 -- no effect Inside_A_Generic. In the case where not Expander_Active
98 -- and not Inside_A_Generic, most of them are inactive, but some of them
99 -- operate anyway since they may generate useful compile time warnings.
101 procedure Apply_Access_Check (N : Node_Id);
102 -- Determines whether an expression node requires a runtime access
103 -- check and if so inserts the appropriate run-time check.
105 procedure Apply_Accessibility_Check
108 Insert_Node : Node_Id);
109 -- Given a name N denoting an access parameter, emits a run-time
110 -- accessibility check (if necessary), checking that the level of
111 -- the object denoted by the access parameter is not deeper than the
112 -- level of the type Typ. Program_Error is raised if the check fails.
113 -- Insert_Node indicates the node where the check should be inserted.
115 procedure Apply_Address_Clause_Check (E : Entity_Id; N : Node_Id);
116 -- E is the entity for an object which has an address clause. If checks
117 -- are enabled, then this procedure generates a check that the specified
118 -- address has an alignment consistent with the alignment of the object,
119 -- raising PE if this is not the case. The resulting check (if one is
120 -- generated) is inserted before node N. check is also made for the case of
121 -- a clear overlay situation that the size of the overlaying object is not
122 -- larger than the overlaid object.
124 procedure Apply_Arithmetic_Overflow_Check (N : Node_Id);
125 -- Given a binary arithmetic operator (+ - *) expand a software integer
126 -- overflow check using range checks on a larger checking type or a call
127 -- to an appropriate runtime routine. This is used for all three operators
128 -- for the signed integer case, and for +/- in the fixed-point case. The
129 -- check is expanded only if Software_Overflow_Checking is enabled and
130 -- Do_Overflow_Check is set on node N. Note that divide is handled
131 -- separately using Apply_Arithmetic_Divide_Overflow_Check.
133 procedure Apply_Constraint_Check
136 No_Sliding : Boolean := False);
137 -- Top-level procedure, calls all the others depending on the class of Typ.
138 -- Checks that expression N satisfies the constraint of type Typ.
139 -- No_Sliding is only relevant for constrained array types, if set to True,
140 -- it checks that indexes are in range.
142 procedure Apply_Discriminant_Check
145 Lhs : Node_Id := Empty);
146 -- Given an expression N of a discriminated type, or of an access type
147 -- whose designated type is a discriminanted type, generates a check to
148 -- ensure that the expression can be converted to the subtype given as
149 -- the second parameter. Lhs is empty except in the case of assignments,
150 -- where the target object may be needed to determine the subtype to
151 -- check against (such as the cases of unconstrained formal parameters
152 -- and unconstrained aliased objects). For the case of unconstrained
153 -- formals, the check is peformed only if the corresponding actual is
154 -- constrained, i.e., whether Lhs'Constrained is True.
156 function Build_Discriminant_Checks
160 -- Subsidiary routine for Apply_Discriminant_Check. Builds the expression
161 -- that compares discriminants of the expression with discriminants of the
162 -- type. Also used directly for membership tests (see Exp_Ch4.Expand_N_In).
164 procedure Apply_Divide_Check (N : Node_Id);
165 -- The node kind is N_Op_Divide, N_Op_Mod, or N_Op_Rem. An appropriate
166 -- check is generated to ensure that the right operand is non-zero. In
167 -- the divide case, we also check that we do not have the annoying case
168 -- of the largest negative number divided by minus one.
170 procedure Apply_Type_Conversion_Checks (N : Node_Id);
171 -- N is an N_Type_Conversion node. A type conversion actually involves
172 -- two sorts of checks. The first check is the checks that ensures that
173 -- the operand in the type conversion fits onto the base type of the
174 -- subtype it is being converted to (see RM 4.6 (28)-(50)). The second
175 -- check is there to ensure that once the operand has been converted to
176 -- a value of the target type, this converted value meets the
177 -- constraints imposed by the target subtype (see RM 4.6 (51)).
179 procedure Apply_Universal_Integer_Attribute_Checks (N : Node_Id);
180 -- The argument N is an attribute reference node intended for processing
181 -- by gigi. The attribute is one that returns a universal integer, but
182 -- the attribute reference node is currently typed with the expected
183 -- result type. This routine deals with range and overflow checks needed
184 -- to make sure that the universal result is in range.
186 procedure Determine_Range
191 Assume_Valid : Boolean := False);
192 -- N is a node for a subexpression. If N is of a discrete type with no
193 -- error indications, and no other peculiarities (e.g. missing type
194 -- fields), then OK is True on return, and Lo and Hi are set to a
195 -- conservative estimate of the possible range of values of N. Thus if OK
196 -- is True on return, the value of the subexpression N is known to like in
197 -- the range Lo .. Hi (inclusive). If the expression is not of a discrete
198 -- type, or some kind of error condition is detected, then OK is False on
199 -- exit, and Lo/Hi are set to No_Uint. Thus the significance of OK being
200 -- False on return is that no useful information is available on the range
201 -- of the expression. Assume_Valid determines whether the processing is
202 -- allowed to assume that values are in range of their subtypes. If it is
203 -- set to True, then this assumption is valid, if False, then processing
204 -- is done using base types to allow invalid values.
206 procedure Install_Null_Excluding_Check (N : Node_Id);
207 -- Determines whether an access node requires a runtime access check and
208 -- if so inserts the appropriate run-time check.
210 -------------------------------------------------------
211 -- Control and Optimization of Range/Overflow Checks --
212 -------------------------------------------------------
214 -- Range checks are controlled by the Do_Range_Check flag. The front end
215 -- is responsible for setting this flag in relevant nodes. Originally
216 -- the back end generated all corresponding range checks. But later on
217 -- we decided to generate all range checks in the front end. We are now
218 -- in the transitional phase where some of these checks are still done
219 -- by the back end, but many are done by the front end.
221 -- Overflow checks are similarly controlled by the Do_Overflow_Check flag.
222 -- The difference here is that if back end overflow checks are inactive
223 -- (Backend_Overflow_Checks_On_Target set False), then the actual overflow
224 -- checks are generated by the front end, but if back end overflow checks
225 -- are active (Backend_Overflow_Checks_On_Target set True), then the back
226 -- end does generate the checks.
228 -- The following two routines are used to set these flags, they allow
229 -- for the possibility of eliminating checks. Checks can be eliminated
230 -- if an identical check has already been performed.
232 procedure Enable_Overflow_Check (N : Node_Id);
233 -- First this routine determines if an overflow check is needed by doing
234 -- an appropriate range check. If a check is not needed, then the call
235 -- has no effect. If a check is needed then this routine sets the flag
236 -- Do_Overflow_Check in node N to True, unless it can be determined that
237 -- the check is not needed. The only condition under which this is the
238 -- case is if there was an identical check earlier on.
240 procedure Enable_Range_Check (N : Node_Id);
241 -- Set Do_Range_Check flag in node N True, unless it can be determined
242 -- that the check is not needed. The only condition under which this is
243 -- the case is if there was an identical check earlier on. This routine
244 -- is not responsible for doing range analysis to determine whether or
245 -- not such a check is needed -- the caller is expected to do this. The
246 -- one other case in which the request to set the flag is ignored is
247 -- when Kill_Range_Check is set in an N_Unchecked_Conversion node.
249 -- The following routines are used to keep track of processing sequences
250 -- of statements (e.g. the THEN statements of an IF statement). A check
251 -- that appears within such a sequence can eliminate an identical check
252 -- within this sequence of statements. However, after the end of the
253 -- sequence of statements, such a check is no longer of interest, since
254 -- it may not have been executed.
256 procedure Conditional_Statements_Begin;
257 -- This call marks the start of processing of a sequence of statements.
258 -- Every call to this procedure must be followed by a matching call to
259 -- Conditional_Statements_End.
261 procedure Conditional_Statements_End;
262 -- This call removes from consideration all saved checks since the
263 -- corresponding call to Conditional_Statements_Begin. These two
264 -- procedures operate in a stack like manner.
266 -- The mechanism for optimizing checks works by remembering checks
267 -- that have already been made, but certain conditions, for example
268 -- an assignment to a variable involved in a check, may mean that the
269 -- remembered check is no longer valid, in the sense that if the same
270 -- expression appears again, another check is required because the
271 -- value may have changed.
273 -- The following routines are used to note conditions which may render
274 -- some or all of the stored and remembered checks to be invalidated.
276 procedure Kill_Checks (V : Entity_Id);
277 -- This procedure records an assignment or other condition that causes
278 -- the value of the variable to be changed, invalidating any stored
279 -- checks that reference the value. Note that all such checks must
280 -- be discarded, even if they are not in the current statement range.
282 procedure Kill_All_Checks;
283 -- This procedure kills all remembered checks
285 -----------------------------
286 -- Length and Range Checks --
287 -----------------------------
289 -- In the following procedures, there are three arguments which have
290 -- a common meaning as follows:
292 -- Expr The expression to be checked. If a check is required,
293 -- the appropriate flag will be placed on this node. Whether
294 -- this node is further examined depends on the setting of
295 -- the parameter Source_Typ, as described below.
297 -- ??? Apply_Length_Check and Apply_Range_Check do not have an Expr
300 -- ??? Apply_Length_Check and Apply_Range_Check have a Ck_Node formal
301 -- which is undocumented, is it the same as Expr?
303 -- Target_Typ The target type on which the check is to be based. For
304 -- example, if we have a scalar range check, then the check
305 -- is that we are in range of this type.
307 -- Source_Typ Normally Empty, but can be set to a type, in which case
308 -- this type is used for the check, see below.
310 -- The checks operate in one of two modes:
312 -- If Source_Typ is Empty, then the node Expr is examined, at the very
313 -- least to get the source subtype. In addition for some of the checks,
314 -- the actual form of the node may be examined. For example, a node of
315 -- type Integer whose actual form is an Integer conversion from a type
316 -- with range 0 .. 3 can be determined to have a value in range 0 .. 3.
318 -- If Source_Typ is given, then nothing can be assumed about the Expr,
319 -- and indeed its contents are not examined. In this case the check is
320 -- based on the assumption that Expr can be an arbitrary value of the
323 -- Currently, the only case in which a Source_Typ is explicitly supplied
324 -- is for the case of Out and In_Out parameters, where, for the conversion
325 -- on return (the Out direction), the types must be reversed. This is
326 -- handled by the caller.
328 procedure Apply_Length_Check
330 Target_Typ : Entity_Id;
331 Source_Typ : Entity_Id := Empty);
332 -- This procedure builds a sequence of declarations to do a length check
333 -- that checks if the lengths of the two arrays Target_Typ and source type
334 -- are the same. The resulting actions are inserted at Node using a call
335 -- to Insert_Actions.
337 -- For access types, the Directly_Designated_Type is retrieved and
338 -- processing continues as enumerated above, with a guard against null
341 -- Note: calls to Apply_Length_Check currently never supply an explicit
342 -- Source_Typ parameter, but Apply_Length_Check takes this parameter and
343 -- processes it as described above for consistency with the other routines
346 procedure Apply_Range_Check
348 Target_Typ : Entity_Id;
349 Source_Typ : Entity_Id := Empty);
350 -- For a Node of kind N_Range, constructs a range check action that tests
351 -- first that the range is not null and then that the range is contained in
352 -- the Target_Typ range.
354 -- For scalar types, constructs a range check action that first tests that
355 -- the expression is contained in the Target_Typ range. The difference
356 -- between this and Apply_Scalar_Range_Check is that the latter generates
357 -- the actual checking code in gigi against the Etype of the expression.
359 -- For constrained array types, construct series of range check actions
360 -- to check that each Expr range is properly contained in the range of
363 -- For a type conversion to an unconstrained array type, constructs a range
364 -- check action to check that the bounds of the source type are within the
365 -- constraints imposed by the Target_Typ.
367 -- For access types, the Directly_Designated_Type is retrieved and
368 -- processing continues as enumerated above, with a guard against null
371 -- The source type is used by type conversions to unconstrained array
372 -- types to retrieve the corresponding bounds.
374 procedure Apply_Static_Length_Check
376 Target_Typ : Entity_Id;
377 Source_Typ : Entity_Id := Empty);
378 -- Tries to determine statically whether the two array types source type
379 -- and Target_Typ have the same length. If it can be determined at compile
380 -- time that they do not, then an N_Raise_Constraint_Error node replaces
381 -- Expr, and a warning message is issued.
383 procedure Apply_Scalar_Range_Check
385 Target_Typ : Entity_Id;
386 Source_Typ : Entity_Id := Empty;
387 Fixed_Int : Boolean := False);
388 -- For scalar types, determines whether an expression node should be
389 -- flagged as needing a runtime range check. If the node requires such a
390 -- check, the Do_Range_Check flag is turned on. The Fixed_Int flag if set
391 -- causes any fixed-point values to be treated as though they were discrete
392 -- values (i.e. the underlying integer value is used).
394 type Check_Result is private;
395 -- Type used to return result of Get_Range_Checks call, for later use in
396 -- call to Insert_Range_Checks procedure.
398 function Get_Range_Checks
400 Target_Typ : Entity_Id;
401 Source_Typ : Entity_Id := Empty;
402 Warn_Node : Node_Id := Empty) return Check_Result;
403 -- Like Apply_Range_Check, except it does not modify anything. Instead
404 -- it returns an encapsulated result of the check operations for later
405 -- use in a call to Insert_Range_Checks. If Warn_Node is non-empty, its
406 -- Sloc is used, in the static case, for the generated warning or error.
407 -- Additionally, it is used rather than Expr (or Low/High_Bound of Expr)
408 -- in constructing the check.
410 procedure Append_Range_Checks
411 (Checks : Check_Result;
413 Suppress_Typ : Entity_Id;
414 Static_Sloc : Source_Ptr;
415 Flag_Node : Node_Id);
416 -- Called to append range checks as returned by a call to Get_Range_Checks.
417 -- Stmts is a list to which either the dynamic check is appended or the
418 -- raise Constraint_Error statement is appended (for static checks).
419 -- Static_Sloc is the Sloc at which the raise CE node points, Flag_Node is
420 -- used as the node at which to set the Has_Dynamic_Check flag. Checks_On
421 -- is a boolean value that says if range and index checking is on or not.
423 procedure Insert_Range_Checks
424 (Checks : Check_Result;
426 Suppress_Typ : Entity_Id;
427 Static_Sloc : Source_Ptr := No_Location;
428 Flag_Node : Node_Id := Empty;
429 Do_Before : Boolean := False);
430 -- Called to insert range checks as returned by a call to Get_Range_Checks.
431 -- Node is the node after which either the dynamic check is inserted or
432 -- the raise Constraint_Error statement is inserted (for static checks).
433 -- Suppress_Typ is the type to check to determine if checks are suppressed.
434 -- Static_Sloc, if passed, is the Sloc at which the raise CE node points,
435 -- otherwise Sloc (Node) is used. The Has_Dynamic_Check flag is normally
436 -- set at Node. If Flag_Node is present, then this is used instead as the
437 -- node at which to set the Has_Dynamic_Check flag. Normally the check is
438 -- inserted after, if Do_Before is True, the check is inserted before
441 -----------------------
442 -- Expander Routines --
443 -----------------------
445 -- Some of the earlier processing for checks results in temporarily setting
446 -- the Do_Range_Check flag rather than actually generating checks. Now we
447 -- are moving the generation of such checks into the front end for reasons
448 -- of efficiency and simplicity (there were difficulties in handling this
449 -- in the back end when side effects were present in the expressions being
452 -- Probably we could eliminate the Do_Range_Check flag entirely and
453 -- generate the checks earlier, but this is a delicate area and it
454 -- seemed safer to implement the following routines, which are called
455 -- late on in the expansion process. They check the Do_Range_Check flag
456 -- and if it is set, generate the actual checks and reset the flag.
458 procedure Generate_Range_Check
460 Target_Type : Entity_Id;
461 Reason : RT_Exception_Code);
462 -- This procedure is called to actually generate and insert a range check.
463 -- A check is generated to ensure that the value of N lies within the range
464 -- of the target type. Note that the base type of N may be different from
465 -- the base type of the target type. This happens in the conversion case.
466 -- The Reason parameter is the exception code to be used for the exception
469 -- Note on the relation of this routine to the Do_Range_Check flag. Mostly
470 -- for historical reasons, we often set the Do_Range_Check flag and then
471 -- later we call Generate_Range_Check if this flag is set. Most probably we
472 -- could eliminate this intermediate setting of the flag (historically the
473 -- back end dealt with range checks, using this flag to indicate if a check
474 -- was required, then we moved checks into the front end).
476 procedure Generate_Index_Checks (N : Node_Id);
477 -- This procedure is called to generate index checks on the subscripts for
478 -- the indexed component node N. Each subscript expression is examined, and
479 -- if the Do_Range_Check flag is set, an appropriate index check is
480 -- generated and the flag is reset.
482 -- Similarly, we set the flag Do_Discriminant_Check in the semantic
483 -- analysis to indicate that a discriminant check is required for selected
484 -- component of a discriminated type. The following routine is called from
485 -- the expander to actually generate the call.
487 procedure Generate_Discriminant_Check (N : Node_Id);
488 -- N is a selected component for which a discriminant check is required to
489 -- make sure that the discriminants have appropriate values for the
490 -- selection. This is done by calling the appropriate discriminant checking
491 -- routine for the selector.
493 -----------------------
494 -- Validity Checking --
495 -----------------------
497 -- In (RM 13.9.1(9-11)) we have the following rules on invalid values
499 -- If the representation of a scalar object does not represent value of
500 -- the object's subtype (perhaps because the object was not initialized),
501 -- the object is said to have an invalid representation. It is a bounded
502 -- error to evaluate the value of such an object. If the error is
503 -- detected, either Constraint_Error or Program_Error is raised.
504 -- Otherwise, execution continues using the invalid representation. The
505 -- rules of the language outside this subclause assume that all objects
506 -- have valid representations. The semantics of operations on invalid
507 -- representations are as follows:
509 -- 10 If the representation of the object represents a value of the
510 -- object's type, the value of the type is used.
512 -- 11 If the representation of the object does not represent a value
513 -- of the object's type, the semantics of operations on such
514 -- representations is implementation-defined, but does not by
515 -- itself lead to erroneous or unpredictable execution, or to
516 -- other objects becoming abnormal.
518 -- We quote the rules in full here since they are quite delicate. Most
519 -- of the time, we can just compute away with wrong values, and get a
520 -- possibly wrong result, which is well within the range of allowed
521 -- implementation defined behavior. The two tricky cases are subscripted
522 -- array assignments, where we don't want to do wild stores, and case
523 -- statements where we don't want to do wild jumps.
525 -- In GNAT, we control validity checking with a switch -gnatV that can take
526 -- three parameters, n/d/f for None/Default/Full. These modes have the
527 -- following meanings:
529 -- None (no validity checking)
531 -- In this mode, there is no specific checking for invalid values
532 -- and the code generator assumes that all stored values are always
533 -- within the bounds of the object subtype. The consequences are as
536 -- For case statements, an out of range invalid value will cause
537 -- Constraint_Error to be raised, or an arbitrary one of the case
538 -- alternatives will be executed. Wild jumps cannot result even
539 -- in this mode, since we always do a range check
541 -- For subscripted array assignments, wild stores will result in
542 -- the expected manner when addresses are calculated using values
543 -- of subscripts that are out of range.
545 -- It could perhaps be argued that this mode is still conformant with
546 -- the letter of the RM, since implementation defined is a rather
547 -- broad category, but certainly it is not in the spirit of the
548 -- RM requirement, since wild stores certainly seem to be a case of
549 -- erroneous behavior.
551 -- Default (default standard RM-compatible validity checking)
553 -- In this mode, which is the default, minimal validity checking is
554 -- performed to ensure no erroneous behavior as follows:
556 -- For case statements, an out of range invalid value will cause
557 -- Constraint_Error to be raised.
559 -- For subscripted array assignments, invalid out of range
560 -- subscript values will cause Constraint_Error to be raised.
562 -- Full (Full validity checking)
564 -- In this mode, the protections guaranteed by the standard mode are
565 -- in place, and the following additional checks are made:
567 -- For every assignment, the right side is checked for validity
569 -- For every call, IN and IN OUT parameters are checked for validity
571 -- For every subscripted array reference, both for stores and loads,
572 -- all subscripts are checked for validity.
574 -- These checks are not required by the RM, but will in practice
575 -- improve the detection of uninitialized variables, particularly
576 -- if used in conjunction with pragma Normalize_Scalars.
578 -- In the above description, we talk about performing validity checks,
579 -- but we don't actually generate a check in a case where the compiler
580 -- can be sure that the value is valid. Note that this assurance must
581 -- be achieved without assuming that any uninitialized value lies within
582 -- the range of its type. The following are cases in which values are
583 -- known to be valid. The flag Is_Known_Valid is used to keep track of
584 -- some of these cases.
586 -- If all possible stored values are valid, then any uninitialized
587 -- value must be valid.
589 -- Literals, including enumeration literals, are clearly always valid
591 -- Constants are always assumed valid, with a validity check being
592 -- performed on the initializing value where necessary to ensure that
595 -- For variables, the status is set to known valid if there is an
596 -- initializing expression. Again a check is made on the initializing
597 -- value if necessary to ensure that this assumption is valid. The
598 -- status can change as a result of local assignments to a variable.
599 -- If a known valid value is unconditionally assigned, then we mark
600 -- the left side as known valid. If a value is assigned that is not
601 -- known to be valid, then we mark the left side as invalid. This
602 -- kind of processing does NOT apply to non-local variables since we
603 -- are not following the flow graph (more properly the flow of actual
604 -- processing only corresponds to the flow graph for local assignments).
605 -- For non-local variables, we preserve the current setting, i.e. a
606 -- validity check is performed when assigning to a knonwn valid global.
608 -- Note: no validity checking is required if range checks are suppressed
609 -- regardless of the setting of the validity checking mode.
611 -- The following procedures are used in handling validity checking
613 procedure Apply_Subscript_Validity_Checks (Expr : Node_Id);
614 -- Expr is the node for an indexed component. If validity checking and
615 -- range checking are enabled, all subscripts for this indexed component
616 -- are checked for validity.
618 procedure Check_Valid_Lvalue_Subscripts (Expr : Node_Id);
619 -- Expr is a lvalue, i.e. an expression representing the target of an
620 -- assignment. This procedure checks for this expression involving an
621 -- assignment to an array value. We have to be sure that all the subscripts
622 -- in such a case are valid, since according to the rules in (RM
623 -- 13.9.1(9-11)) such assignments are not permitted to result in erroneous
624 -- behavior in the case of invalid subscript values.
626 procedure Ensure_Valid (Expr : Node_Id; Holes_OK : Boolean := False);
627 -- Ensure that Expr represents a valid value of its type. If this type
628 -- is not a scalar type, then the call has no effect, since validity
629 -- is only an issue for scalar types. The effect of this call is to
630 -- check if the value is known valid, if so, nothing needs to be done.
631 -- If this is not known, then either Expr is set to be range checked,
632 -- or specific checking code is inserted so that an exception is raised
633 -- if the value is not valid.
635 -- The optional argument Holes_OK indicates whether it is necessary to
636 -- worry about enumeration types with non-standard representations leading
637 -- to "holes" in the range of possible representations. If Holes_OK is
638 -- True, then such values are assumed valid (this is used when the caller
639 -- will make a separate check for this case anyway). If Holes_OK is False,
640 -- then this case is checked, and code is inserted to ensure that Expr is
641 -- valid, raising Constraint_Error if the value is not valid.
643 function Expr_Known_Valid (Expr : Node_Id) return Boolean;
644 -- This function tests it the value of Expr is known to be valid in the
645 -- sense of RM 13.9.1(9-11). In the case of GNAT, it is only discrete types
646 -- which are a concern, since for non-discrete types we simply continue
647 -- computation with invalid values, which does not lead to erroneous
648 -- behavior. Thus Expr_Known_Valid always returns True if the type of Expr
649 -- is non-discrete. For discrete types the value returned is True only if
650 -- it can be determined that the value is Valid. Otherwise False is
653 procedure Insert_Valid_Check (Expr : Node_Id);
654 -- Inserts code that will check for the value of Expr being valid, in
655 -- the sense of the 'Valid attribute returning True. Constraint_Error
656 -- will be raised if the value is not valid.
658 procedure Null_Exclusion_Static_Checks (N : Node_Id);
659 -- Ada 2005 (AI-231): Check bad usages of the null-exclusion issue
661 procedure Remove_Checks (Expr : Node_Id);
662 -- Remove all checks from Expr except those that are only executed
663 -- conditionally (on the right side of And Then/Or Else. This call
664 -- removes only embedded checks (Do_Range_Check, Do_Overflow_Check).
666 procedure Validity_Check_Range (N : Node_Id);
667 -- If N is an N_Range node, then Ensure_Valid is called on its bounds,
668 -- if validity checking of operands is enabled.
670 -----------------------------
671 -- Handling of Check Names --
672 -----------------------------
674 -- The following table contains Name_Id's for recognized checks. The first
675 -- entries (corresponding to the values of the subtype Predefined_Check_Id)
676 -- contain the Name_Id values for the checks that are predefined, including
677 -- All_Checks (see Types). Remaining entries are those that are introduced
678 -- by pragma Check_Names.
680 package Check_Names is new Table.Table (
681 Table_Component_Type => Name_Id,
682 Table_Index_Type => Check_Id,
683 Table_Low_Bound => 1,
685 Table_Increment => 200,
686 Table_Name => "Name_Check_Names");
688 function Get_Check_Id (N : Name_Id) return Check_Id;
689 -- Function to search above table for matching name. If found returns the
690 -- corresponding Check_Id value in the range 1 .. Check_Name.Last. If not
691 -- found returns No_Check_Id.
695 type Check_Result is array (Positive range 1 .. 2) of Node_Id;
696 -- There are two cases for the result returned by Range_Check:
698 -- For the static case the result is one or two nodes that should cause
699 -- a Constraint_Error. Typically these will include Expr itself or the
700 -- direct descendents of Expr, such as Low/High_Bound (Expr)). It is the
701 -- responsibility of the caller to rewrite and substitute the nodes with
702 -- N_Raise_Constraint_Error nodes.
704 -- For the non-static case a single N_Raise_Constraint_Error node with a
705 -- non-empty Condition field is returned.
707 -- Unused entries in Check_Result, if any, are simply set to Empty For
708 -- external clients, the required processing on this result is achieved
709 -- using the Insert_Range_Checks routine.
711 pragma Inline (Apply_Length_Check);
712 pragma Inline (Apply_Range_Check);
713 pragma Inline (Apply_Static_Length_Check);
projects / gcc.git / blob