1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2007, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Atree; use Atree;
27 with Casing; use Casing;
28 with Errout; use Errout;
29 with Debug; use Debug;
30 with Fname; use Fname;
31 with Fname.UF; use Fname.UF;
34 with Sinfo; use Sinfo;
35 with Sinput; use Sinput;
36 with Snames; use Snames;
37 with Uname; use Uname;
39 package body Restrict is
41 Restricted_Profile_Result : Boolean := False;
42 -- This switch memoizes the result of Restricted_Profile function
43 -- calls for improved efficiency. Its setting is valid only if
44 -- Restricted_Profile_Cached is True. Note that if this switch
45 -- is ever set True, it need never be turned off again.
47 Restricted_Profile_Cached : Boolean := False;
48 -- This flag is set to True if the Restricted_Profile_Result
49 -- contains the correct cached result of Restricted_Profile calls.
51 -----------------------
52 -- Local Subprograms --
53 -----------------------
55 procedure Restriction_Msg (Msg : String; R : String; N : Node_Id);
56 -- Output error message at node N with given text, replacing the
57 -- '%' in the message with the name of the restriction given as R,
58 -- cased according to the current identifier casing. We do not use
59 -- the normal insertion mechanism, since this requires an entry
60 -- in the Names table, and this table will be locked if we are
61 -- generating a message from gigi.
63 function Same_Unit (U1, U2 : Node_Id) return Boolean;
64 -- Returns True iff U1 and U2 represent the same library unit. Used for
65 -- handling of No_Dependence => Unit restriction case.
67 function Suppress_Restriction_Message (N : Node_Id) return Boolean;
68 -- N is the node for a possible restriction violation message, but
69 -- the message is to be suppressed if this is an internal file and
70 -- this file is not the main unit.
76 function Abort_Allowed return Boolean is
78 if Restrictions.Set (No_Abort_Statements)
79 and then Restrictions.Set (Max_Asynchronous_Select_Nesting)
80 and then Restrictions.Value (Max_Asynchronous_Select_Nesting) = 0
88 -------------------------
89 -- Check_Compiler_Unit --
90 -------------------------
92 procedure Check_Compiler_Unit (N : Node_Id) is
94 if Is_Compiler_Unit (Get_Source_Unit (N)) then
95 Error_Msg_N ("use of construct not allowed in compiler", N);
97 end Check_Compiler_Unit;
99 ------------------------------------
100 -- Check_Elaboration_Code_Allowed --
101 ------------------------------------
103 procedure Check_Elaboration_Code_Allowed (N : Node_Id) is
105 Check_Restriction (No_Elaboration_Code, N);
106 end Check_Elaboration_Code_Allowed;
108 -----------------------------------------
109 -- Check_Implicit_Dynamic_Code_Allowed --
110 -----------------------------------------
112 procedure Check_Implicit_Dynamic_Code_Allowed (N : Node_Id) is
114 Check_Restriction (No_Implicit_Dynamic_Code, N);
115 end Check_Implicit_Dynamic_Code_Allowed;
117 ----------------------------------
118 -- Check_No_Implicit_Heap_Alloc --
119 ----------------------------------
121 procedure Check_No_Implicit_Heap_Alloc (N : Node_Id) is
123 Check_Restriction (No_Implicit_Heap_Allocations, N);
124 end Check_No_Implicit_Heap_Alloc;
126 ---------------------------
127 -- Check_Restricted_Unit --
128 ---------------------------
130 procedure Check_Restricted_Unit (U : Unit_Name_Type; N : Node_Id) is
132 if Suppress_Restriction_Message (N) then
135 elsif Is_Spec_Name (U) then
137 Fnam : constant File_Name_Type :=
138 Get_File_Name (U, Subunit => False);
143 Get_Name_String (Fnam);
145 -- Nothing to do if name not at least 5 characters long ending
146 -- in .ads or .adb extension, which we strip.
149 or else (Name_Buffer (Name_Len - 3 .. Name_Len) /= ".ads"
151 Name_Buffer (Name_Len - 4 .. Name_Len) /= ".adb")
156 -- Strip extension and pad to eight characters
158 Name_Len := Name_Len - 4;
159 while Name_Len < 8 loop
160 Name_Len := Name_Len + 1;
161 Name_Buffer (Name_Len) := ' ';
164 -- If predefined unit, check the list of restricted units
166 if Is_Predefined_File_Name (Fnam) then
167 for J in Unit_Array'Range loop
169 and then Name_Buffer (1 .. 8) = Unit_Array (J).Filenm
171 Check_Restriction (Unit_Array (J).Res_Id, N);
175 -- If not predefied unit, then one special check still remains.
176 -- GNAT.Current_Exception is not allowed if we have restriction
177 -- No_Exception_Propagation active.
180 if Name_Buffer (1 .. 8) = "g-curexc" then
181 Check_Restriction (No_Exception_Propagation, N);
186 end Check_Restricted_Unit;
188 -----------------------
189 -- Check_Restriction --
190 -----------------------
192 procedure Check_Restriction
195 V : Uint := Uint_Minus_1)
197 Rimage : constant String := Restriction_Id'Image (R);
200 -- V converted to integer form. If V is greater than Integer'Last,
201 -- it is reset to minus 1 (unknown value).
203 procedure Update_Restrictions (Info : in out Restrictions_Info);
204 -- Update violation information in Info.Violated and Info.Count
206 -------------------------
207 -- Update_Restrictions --
208 -------------------------
210 procedure Update_Restrictions (Info : in out Restrictions_Info) is
212 -- If not violated, set as violated now
214 if not Info.Violated (R) then
215 Info.Violated (R) := True;
217 if R in All_Parameter_Restrictions then
219 Info.Unknown (R) := True;
222 Info.Count (R) := VV;
226 -- Otherwise if violated already and a parameter restriction,
227 -- update count by maximizing or summing depending on restriction.
229 elsif R in All_Parameter_Restrictions then
231 -- If new value is unknown, result is unknown
234 Info.Unknown (R) := True;
236 -- If checked by maximization, do maximization
238 elsif R in Checked_Max_Parameter_Restrictions then
239 Info.Count (R) := Integer'Max (Info.Count (R), VV);
241 -- If checked by adding, do add, checking for overflow
243 elsif R in Checked_Add_Parameter_Restrictions then
245 pragma Unsuppress (Overflow_Check);
247 Info.Count (R) := Info.Count (R) + VV;
249 when Constraint_Error =>
250 Info.Count (R) := Integer'Last;
251 Info.Unknown (R) := True;
254 -- Should not be able to come here, known counts should only
255 -- occur for restrictions that are Checked_max or Checked_Sum.
261 end Update_Restrictions;
263 -- Start of processing for Check_Restriction
266 if UI_Is_In_Int_Range (V) then
267 VV := Integer (UI_To_Int (V));
272 -- Count can only be specified in the checked val parameter case
274 pragma Assert (VV < 0 or else R in Checked_Val_Parameter_Restrictions);
276 -- Nothing to do if value of zero specified for parameter restriction
282 -- Update current restrictions
284 Update_Restrictions (Restrictions);
286 -- If in main extended unit, update main restrictions as well
288 if Current_Sem_Unit = Main_Unit
289 or else In_Extended_Main_Source_Unit (N)
291 Update_Restrictions (Main_Restrictions);
294 -- Nothing to do if restriction message suppressed
296 if Suppress_Restriction_Message (N) then
299 -- If restriction not set, nothing to do
301 elsif not Restrictions.Set (R) then
304 -- Here if restriction set, check for violation (either this is a
305 -- Boolean restriction, or a parameter restriction with a value of
306 -- zero and an unknown count, or a parameter restriction with a
307 -- known value that exceeds the restriction count).
309 elsif R in All_Boolean_Restrictions
310 or else (Restrictions.Unknown (R)
311 and then Restrictions.Value (R) = 0)
312 or else Restrictions.Count (R) > Restrictions.Value (R)
314 Error_Msg_Sloc := Restrictions_Loc (R);
316 -- If we have a location for the Restrictions pragma, output it
318 if Error_Msg_Sloc > No_Location
319 or else Error_Msg_Sloc = System_Location
321 if Restriction_Warnings (R) then
322 Restriction_Msg ("|violation of restriction %#?", Rimage, N);
324 Restriction_Msg ("|violation of restriction %#", Rimage, N);
327 -- Otherwise we have the case of an implicit restriction
328 -- (e.g. a restriction implicitly set by another pragma)
332 ("|violation of implicit restriction %", Rimage, N);
335 end Check_Restriction;
337 -------------------------------------
338 -- Check_Restriction_No_Dependence --
339 -------------------------------------
341 procedure Check_Restriction_No_Dependence (U : Node_Id; Err : Node_Id) is
345 for J in No_Dependence.First .. No_Dependence.Last loop
346 DU := No_Dependence.Table (J).Unit;
348 if Same_Unit (U, DU) then
349 Error_Msg_Sloc := Sloc (DU);
350 Error_Msg_Node_1 := DU;
352 if No_Dependence.Table (J).Warn then
354 ("?violation of restriction `No_Dependence '='> &`#",
358 ("|violation of restriction `No_Dependence '='> &`#",
365 end Check_Restriction_No_Dependence;
367 ----------------------------------------
368 -- Cunit_Boolean_Restrictions_Restore --
369 ----------------------------------------
371 procedure Cunit_Boolean_Restrictions_Restore
372 (R : Save_Cunit_Boolean_Restrictions)
375 for J in Cunit_Boolean_Restrictions loop
376 Restrictions.Set (J) := R (J);
378 end Cunit_Boolean_Restrictions_Restore;
380 -------------------------------------
381 -- Cunit_Boolean_Restrictions_Save --
382 -------------------------------------
384 function Cunit_Boolean_Restrictions_Save
385 return Save_Cunit_Boolean_Restrictions
387 R : Save_Cunit_Boolean_Restrictions;
390 for J in Cunit_Boolean_Restrictions loop
391 R (J) := Restrictions.Set (J);
392 Restrictions.Set (J) := False;
396 end Cunit_Boolean_Restrictions_Save;
398 ------------------------
399 -- Get_Restriction_Id --
400 ------------------------
402 function Get_Restriction_Id
403 (N : Name_Id) return Restriction_Id
407 Set_Casing (All_Upper_Case);
409 for J in All_Restrictions loop
411 S : constant String := Restriction_Id'Image (J);
413 if S = Name_Buffer (1 .. Name_Len) then
419 return Not_A_Restriction_Id;
420 end Get_Restriction_Id;
422 -------------------------------
423 -- No_Exception_Handlers_Set --
424 -------------------------------
426 function No_Exception_Handlers_Set return Boolean is
428 return (No_Run_Time_Mode or else Configurable_Run_Time_Mode)
429 and then (Restrictions.Set (No_Exception_Handlers)
431 Restrictions.Set (No_Exception_Propagation));
432 end No_Exception_Handlers_Set;
434 -------------------------------------
435 -- No_Exception_Propagation_Active --
436 -------------------------------------
438 function No_Exception_Propagation_Active return Boolean is
440 return (No_Run_Time_Mode
441 or else Configurable_Run_Time_Mode
442 or else Debug_Flag_Dot_G)
443 and then Restriction_Active (No_Exception_Propagation);
444 end No_Exception_Propagation_Active;
446 ----------------------------------
447 -- Process_Restriction_Synonyms --
448 ----------------------------------
450 -- Note: body of this function must be coordinated with list of
451 -- renaming declarations in System.Rident.
453 function Process_Restriction_Synonyms (N : Node_Id) return Name_Id
455 Old_Name : constant Name_Id := Chars (N);
460 when Name_Boolean_Entry_Barriers =>
461 New_Name := Name_Simple_Barriers;
463 when Name_Max_Entry_Queue_Depth =>
464 New_Name := Name_Max_Entry_Queue_Length;
466 when Name_No_Dynamic_Interrupts =>
467 New_Name := Name_No_Dynamic_Attachment;
469 when Name_No_Requeue =>
470 New_Name := Name_No_Requeue_Statements;
472 when Name_No_Task_Attributes =>
473 New_Name := Name_No_Task_Attributes_Package;
479 if Warn_On_Obsolescent_Feature then
480 Error_Msg_Name_1 := Old_Name;
481 Error_Msg_N ("restriction identifier % is obsolescent?", N);
482 Error_Msg_Name_1 := New_Name;
483 Error_Msg_N ("|use restriction identifier % instead", N);
487 end Process_Restriction_Synonyms;
489 ------------------------
490 -- Restricted_Profile --
491 ------------------------
493 function Restricted_Profile return Boolean is
495 if Restricted_Profile_Cached then
496 return Restricted_Profile_Result;
499 Restricted_Profile_Result := True;
500 Restricted_Profile_Cached := True;
503 R : Restriction_Flags renames Profile_Info (Restricted).Set;
504 V : Restriction_Values renames Profile_Info (Restricted).Value;
506 for J in R'Range loop
508 and then (Restrictions.Set (J) = False
509 or else Restriction_Warnings (J)
511 (J in All_Parameter_Restrictions
512 and then Restrictions.Value (J) > V (J)))
514 Restricted_Profile_Result := False;
519 return Restricted_Profile_Result;
522 end Restricted_Profile;
524 ------------------------
525 -- Restriction_Active --
526 ------------------------
528 function Restriction_Active (R : All_Restrictions) return Boolean is
530 return Restrictions.Set (R) and then not Restriction_Warnings (R);
531 end Restriction_Active;
533 ---------------------
534 -- Restriction_Msg --
535 ---------------------
537 procedure Restriction_Msg (Msg : String; R : String; N : Node_Id) is
538 B : String (1 .. Msg'Length + 2 * R'Length + 1);
542 Name_Buffer (1 .. R'Last) := R;
543 Name_Len := R'Length;
544 Set_Casing (Identifier_Casing (Get_Source_File_Index (Sloc (N))));
547 for J in Msg'Range loop
548 if Msg (J) = '%' then
552 -- Put characters of image in message, quoting upper case letters
554 for J in 1 .. Name_Len loop
555 if Name_Buffer (J) in 'A' .. 'Z' then
561 B (P) := Name_Buffer (J);
573 Error_Msg_N (B (1 .. P), N);
580 function Same_Unit (U1, U2 : Node_Id) return Boolean is
582 if Nkind (U1) = N_Identifier then
583 return Nkind (U2) = N_Identifier and then Chars (U1) = Chars (U2);
585 elsif Nkind (U2) = N_Identifier then
588 elsif (Nkind (U1) = N_Selected_Component
589 or else Nkind (U1) = N_Expanded_Name)
591 (Nkind (U2) = N_Selected_Component
592 or else Nkind (U2) = N_Expanded_Name)
594 return Same_Unit (Prefix (U1), Prefix (U2))
595 and then Same_Unit (Selector_Name (U1), Selector_Name (U2));
601 ------------------------------
602 -- Set_Profile_Restrictions --
603 ------------------------------
605 procedure Set_Profile_Restrictions
610 R : Restriction_Flags renames Profile_Info (P).Set;
611 V : Restriction_Values renames Profile_Info (P).Value;
614 for J in R'Range loop
617 Already_Restricted : constant Boolean := Restriction_Active (J);
620 -- Set the restriction
622 if J in All_Boolean_Restrictions then
623 Set_Restriction (J, N);
625 Set_Restriction (J, N, V (J));
628 -- Set warning flag, except that we do not set the warning
629 -- flag if the restriction was already active and this is
630 -- the warning case. That avoids a warning overriding a real
631 -- restriction, which should never happen.
633 if not (Warn and Already_Restricted) then
634 Restriction_Warnings (J) := Warn;
639 end Set_Profile_Restrictions;
641 ---------------------
642 -- Set_Restriction --
643 ---------------------
645 -- Case of Boolean restriction
647 procedure Set_Restriction
648 (R : All_Boolean_Restrictions;
652 -- Restriction No_Elaboration_Code must be enforced on a unit by unit
653 -- basis. Hence, we avoid setting the restriction when processing an
654 -- unit which is not the main one being compiled (or its corresponding
655 -- spec). It can happen, for example, when processing an inlined body
656 -- (the package containing the inlined subprogram is analyzed,
657 -- including its pragma Restrictions).
659 -- This seems like a very nasty kludge??? This is not the only per unit
660 -- restriction why is this treated specially ???
662 if R = No_Elaboration_Code
663 and then Current_Sem_Unit /= Main_Unit
664 and then Cunit (Current_Sem_Unit) /= Library_Unit (Cunit (Main_Unit))
669 Restrictions.Set (R) := True;
671 if Restricted_Profile_Cached and Restricted_Profile_Result then
674 Restricted_Profile_Cached := False;
677 -- Set location, but preserve location of system
678 -- restriction for nice error msg with run time name
680 if Restrictions_Loc (R) /= System_Location then
681 Restrictions_Loc (R) := Sloc (N);
684 -- Record the restriction if we are in the main unit, or in the extended
685 -- main unit. The reason that we test separately for Main_Unit is that
686 -- gnat.adc is processed with Current_Sem_Unit = Main_Unit, but nodes in
687 -- gnat.adc do not appear to be in the extended main source unit (they
688 -- probably should do ???)
690 if Current_Sem_Unit = Main_Unit
691 or else In_Extended_Main_Source_Unit (N)
693 if not Restriction_Warnings (R) then
694 Main_Restrictions.Set (R) := True;
699 -- Case of parameter restriction
701 procedure Set_Restriction
702 (R : All_Parameter_Restrictions;
707 if Restricted_Profile_Cached and Restricted_Profile_Result then
710 Restricted_Profile_Cached := False;
713 if Restrictions.Set (R) then
714 if V < Restrictions.Value (R) then
715 Restrictions.Value (R) := V;
716 Restrictions_Loc (R) := Sloc (N);
720 Restrictions.Set (R) := True;
721 Restrictions.Value (R) := V;
722 Restrictions_Loc (R) := Sloc (N);
725 -- Record the restriction if we are in the main unit,
726 -- or in the extended main unit. The reason that we
727 -- test separately for Main_Unit is that gnat.adc is
728 -- processed with Current_Sem_Unit = Main_Unit, but
729 -- nodes in gnat.adc do not appear to be the extended
730 -- main source unit (they probably should do ???)
732 if Current_Sem_Unit = Main_Unit
733 or else In_Extended_Main_Source_Unit (N)
735 if Main_Restrictions.Set (R) then
736 if V < Main_Restrictions.Value (R) then
737 Main_Restrictions.Value (R) := V;
740 elsif not Restriction_Warnings (R) then
741 Main_Restrictions.Set (R) := True;
742 Main_Restrictions.Value (R) := V;
747 -----------------------------------
748 -- Set_Restriction_No_Dependence --
749 -----------------------------------
751 procedure Set_Restriction_No_Dependence
756 -- Loop to check for duplicate entry
758 for J in No_Dependence.First .. No_Dependence.Last loop
760 -- Case of entry already in table
762 if Same_Unit (Unit, No_Dependence.Table (J).Unit) then
764 -- Error has precedence over warning
767 No_Dependence.Table (J).Warn := False;
774 -- Entry is not currently in table
776 No_Dependence.Append ((Unit, Warn));
777 end Set_Restriction_No_Dependence;
779 ----------------------------------
780 -- Suppress_Restriction_Message --
781 ----------------------------------
783 function Suppress_Restriction_Message (N : Node_Id) return Boolean is
785 -- We only output messages for the extended main source unit
787 if In_Extended_Main_Source_Unit (N) then
790 -- If loaded by rtsfind, then suppress message
792 elsif Sloc (N) <= No_Location then
795 -- Otherwise suppress message if internal file
798 return Is_Internal_File_Name (Unit_File_Name (Get_Source_Unit (N)));
800 end Suppress_Restriction_Message;
802 ---------------------
803 -- Tasking_Allowed --
804 ---------------------
806 function Tasking_Allowed return Boolean is
808 return not Restrictions.Set (No_Tasking)
809 and then (not Restrictions.Set (Max_Tasks)
810 or else Restrictions.Value (Max_Tasks) > 0);