OSDN Git Service

PR bootstrap/38262
[pf3gnuchains/gcc-fork.git] / gcc / ada / s-rident.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                         S Y S T E M . R I D E N T                        --
6 --                                                                          --
7 --                                 S p e c                                  --
8 --                                                                          --
9 --          Copyright (C) 1992-2008, 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 2,  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 COPYING.  If not, write --
19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
20 -- Boston, MA 02110-1301, USA.                                              --
21 --                                                                          --
22 -- As a special exception,  if other files  instantiate  generics from this --
23 -- unit, or you link  this unit with other files  to produce an executable, --
24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
25 -- covered  by the  GNU  General  Public  License.  This exception does not --
26 -- however invalidate  any other reasons why  the executable file  might be --
27 -- covered by the GNU Public License.                                       --
28 --                                                                          --
29 -- GNAT was originally developed  by the GNAT team at  New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
31 --                                                                          --
32 ------------------------------------------------------------------------------
33
34 --  This package defines the set of restriction identifiers. It is a generic
35 --  package that is instantiated by the compiler/binder in package Rident, and
36 --  is instantiated in package System.Restrictions for use at run-time.
37
38 --  The reason that we make this a generic package is so that in the case of
39 --  the instantiation in Rident for use at compile time and bind time, we can
40 --  generate normal image tables for the enumeration types, which are needed
41 --  for diagnostic and informational messages. At run-time we really do not
42 --  want to waste the space for these image tables, and they are not needed,
43 --  so we can do the instantiation under control of Discard_Names to remove
44 --  the tables.
45
46 generic
47 package System.Rident is
48    pragma Preelaborate;
49
50    --  The following enumeration type defines the set of restriction
51    --  identifiers that are implemented in GNAT.
52
53    --  To add a new restriction identifier, add an entry with the name to be
54    --  used in the pragma, and add calls to the Restrict.Check_Restriction
55    --  routine as appropriate.
56
57    type Restriction_Id is
58
59       --  The following cases are checked for consistency in the binder. The
60       --  binder will check that every unit either has the restriction set, or
61       --  does not violate the restriction.
62
63      (Simple_Barriers,                         -- GNAT (Ravenscar)
64       No_Abort_Statements,                     -- (RM D.7(5), H.4(3))
65       No_Access_Subprograms,                   -- (RM H.4(17))
66       No_Allocators,                           -- (RM H.4(7))
67       No_Asynchronous_Control,                 -- (RM D.7(10))
68       No_Calendar,                             -- GNAT
69       No_Delay,                                -- (RM H.4(21))
70       No_Direct_Boolean_Operators,             -- GNAT
71       No_Dispatch,                             -- (RM H.4(19))
72       No_Dispatching_Calls,                    -- GNAT
73       No_Dynamic_Attachment,                   -- GNAT
74       No_Dynamic_Priorities,                   -- (RM D.9(9))
75       No_Enumeration_Maps,                     -- GNAT
76       No_Entry_Calls_In_Elaboration_Code,      -- GNAT
77       No_Entry_Queue,                          -- GNAT (Ravenscar)
78       No_Exception_Handlers,                   -- GNAT
79       No_Exception_Propagation,                -- GNAT
80       No_Exception_Registration,               -- GNAT
81       No_Exceptions,                           -- (RM H.4(12))
82       No_Finalization,                         -- GNAT
83       No_Fixed_Point,                          -- (RM H.4(15))
84       No_Floating_Point,                       -- (RM H.4(14))
85       No_IO,                                   -- (RM H.4(20))
86       No_Implicit_Conditionals,                -- GNAT
87       No_Implicit_Dynamic_Code,                -- GNAT
88       No_Implicit_Heap_Allocations,            -- (RM D.8(8), H.4(3))
89       No_Implicit_Loops,                       -- GNAT
90       No_Initialize_Scalars,                   -- GNAT
91       No_Local_Allocators,                     -- (RM H.4(8))
92       No_Local_Timing_Events,                  -- (RM D.7(10.2/2))
93       No_Local_Protected_Objects,              -- GNAT
94       No_Nested_Finalization,                  -- (RM D.7(4))
95       No_Protected_Type_Allocators,            -- GNAT
96       No_Protected_Types,                      -- (RM H.4(5))
97       No_Recursion,                            -- (RM H.4(22))
98       No_Reentrancy,                           -- (RM H.4(23))
99       No_Relative_Delay,                       -- GNAT (Ravenscar)
100       No_Requeue_Statements,                   -- GNAT
101       No_Secondary_Stack,                      -- GNAT
102       No_Select_Statements,                    -- GNAT (Ravenscar)
103       No_Specific_Termination_Handlers,        -- (RM D.7(10.7/2))
104       No_Standard_Storage_Pools,               -- GNAT
105       No_Stream_Optimizations,                 -- GNAT
106       No_Streams,                              -- GNAT
107       No_Task_Allocators,                      -- (RM D.7(7))
108       No_Task_Attributes_Package,              -- GNAT
109       No_Task_Hierarchy,                       -- (RM D.7(3), H.4(3))
110       No_Task_Termination,                     -- GNAT (Ravenscar)
111       No_Tasking,                              -- GNAT
112       No_Terminate_Alternatives,               -- (RM D.7(6))
113       No_Unchecked_Access,                     -- (RM H.4(18))
114       No_Unchecked_Conversion,                 -- (RM H.4(16))
115       No_Unchecked_Deallocation,               -- (RM H.4(9))
116       Static_Priorities,                       -- GNAT
117       Static_Storage_Size,                     -- GNAT
118
119       --  The following require consistency checking with special rules. See
120       --  individual routines in unit Bcheck for details of what is required.
121
122       No_Default_Initialization,               -- GNAT
123
124       --  The following cases do not require consistency checking
125
126       Immediate_Reclamation,                   -- (RM H.4(10))
127       No_Implementation_Attributes,            -- Ada 2005 AI-257
128       No_Implementation_Pragmas,               -- Ada 2005 AI-257
129       No_Implementation_Restrictions,          -- GNAT
130       No_Elaboration_Code,                     -- GNAT
131       No_Obsolescent_Features,                 -- Ada 2005 AI-368
132       No_Wide_Characters,                      -- GNAT
133
134       --  The following cases require a parameter value
135
136       --  The following entries are fully checked at compile/bind time, which
137       --  means that the compiler can in general tell the minimum value which
138       --  could be used with a restrictions pragma. The binder can deduce the
139       --  appropriate minimum value for the partition by taking the maximum
140       --  value required by any unit.
141
142       Max_Protected_Entries,                   -- (RM D.7(14))
143       Max_Select_Alternatives,                 -- (RM D.7(12))
144       Max_Task_Entries,                        -- (RM D.7(13), H.4(3))
145
146       --  The following entries are also fully checked at compile/bind time,
147       --  and the compiler can also at least in some cases tell the minimum
148       --  value which could be used with a restriction pragma. The difference
149       --  is that the contributions are additive, so the binder deduces this
150       --  value by adding the unit contributions.
151
152       Max_Tasks,                               -- (RM D.7(19), H.4(3))
153
154       --  The following entries are checked at compile time only for zero/
155       --  nonzero entries. This means that the compiler can tell at compile
156       --  time if a restriction value of zero is (would be) violated, but that
157       --  the compiler cannot distinguish between different non-zero values.
158
159       Max_Asynchronous_Select_Nesting,         -- (RM D.7(18), H.4(3))
160       Max_Entry_Queue_Length,                  -- GNAT
161
162       --  The remaining entries are not checked at compile/bind time
163
164       Max_Storage_At_Blocking,                 -- (RM D.7(17))
165
166       Not_A_Restriction_Id);
167
168    --  Synonyms permitted for historical purposes of compatibility.
169    --  Must be coordinated with Restrict.Process_Restriction_Synonym.
170
171    Boolean_Entry_Barriers : Restriction_Id renames Simple_Barriers;
172    Max_Entry_Queue_Depth  : Restriction_Id renames Max_Entry_Queue_Length;
173    No_Dynamic_Interrupts  : Restriction_Id renames No_Dynamic_Attachment;
174    No_Requeue             : Restriction_Id renames No_Requeue_Statements;
175    No_Task_Attributes     : Restriction_Id renames No_Task_Attributes_Package;
176
177    subtype All_Restrictions is Restriction_Id range
178      Simple_Barriers .. Max_Storage_At_Blocking;
179    --  All restrictions (excluding only Not_A_Restriction_Id)
180
181    subtype All_Boolean_Restrictions is Restriction_Id range
182      Simple_Barriers .. No_Wide_Characters;
183    --  All restrictions which do not take a parameter
184
185    subtype Partition_Boolean_Restrictions is All_Boolean_Restrictions range
186      Simple_Barriers .. Static_Storage_Size;
187    --  Boolean restrictions that are checked for partition consistency.
188    --  Note that all parameter restrictions are checked for partition
189    --  consistency by default, so this distinction is only needed in the
190    --  case of Boolean restrictions.
191
192    subtype Cunit_Boolean_Restrictions is All_Boolean_Restrictions range
193      Immediate_Reclamation .. No_Wide_Characters;
194    --  Boolean restrictions that are not checked for partition consistency
195    --  and that thus apply only to the current unit. Note that for these
196    --  restrictions, the compiler does not apply restrictions found in
197    --  with'ed units, parent specs etc. to the main unit.
198
199    subtype All_Parameter_Restrictions is
200      Restriction_Id range
201        Max_Protected_Entries .. Max_Storage_At_Blocking;
202    --  All restrictions that take a parameter
203
204    subtype Checked_Parameter_Restrictions is
205      All_Parameter_Restrictions range
206        Max_Protected_Entries .. Max_Entry_Queue_Length;
207    --  These are the parameter restrictions that can be at least partially
208    --  checked at compile/binder time. Minimally, the compiler can detect
209    --  violations of a restriction pragma with a value of zero reliably.
210
211    subtype Checked_Max_Parameter_Restrictions is
212      Checked_Parameter_Restrictions range
213        Max_Protected_Entries .. Max_Task_Entries;
214    --  Restrictions with parameters that can be checked in some cases by
215    --  maximizing among statically detected instances where the compiler
216    --  can determine the count.
217
218    subtype Checked_Add_Parameter_Restrictions is
219      Checked_Parameter_Restrictions range
220        Max_Tasks .. Max_Tasks;
221    --  Restrictions with parameters that can be checked in some cases by
222    --  summing the statically detected instances where the compiler can
223    --  determine the count.
224
225    subtype Checked_Val_Parameter_Restrictions is
226      Checked_Parameter_Restrictions range
227        Max_Protected_Entries .. Max_Tasks;
228    --  Restrictions with parameter where the count is known at least in some
229    --  cases by the compiler/binder.
230
231    subtype Checked_Zero_Parameter_Restrictions is
232      Checked_Parameter_Restrictions range
233        Max_Asynchronous_Select_Nesting .. Max_Entry_Queue_Length;
234    --  Restrictions with parameters where the compiler can detect the use of
235    --  the feature, and hence violations of a restriction specifying a value
236    --  of zero, but cannot detect specific values other than zero/nonzero.
237
238    subtype Unchecked_Parameter_Restrictions is
239      All_Parameter_Restrictions range
240        Max_Storage_At_Blocking .. Max_Storage_At_Blocking;
241    --  Restrictions with parameters where the compiler cannot ever detect
242    --  corresponding compile time usage, so the binder and compiler never
243    --  detect violations of any restriction.
244
245    -------------------------------------
246    -- Restriction Status Declarations --
247    -------------------------------------
248
249    --  The following declarations are used to record the current status or
250    --  restrictions (for the current unit, or related units, at compile time,
251    --  and for all units in a partition at bind time or run time).
252
253    type Restriction_Flags  is array (All_Restrictions)           of Boolean;
254    type Restriction_Values is array (All_Parameter_Restrictions) of Natural;
255    type Parameter_Flags    is array (All_Parameter_Restrictions) of Boolean;
256
257    type Restrictions_Info is record
258       Set : Restriction_Flags;
259       --  An entry is True in the Set array if a restrictions pragma has been
260       --  encountered for the given restriction. If the value is True for a
261       --  parameter restriction, then the corresponding entry in the Value
262       --  array gives the minimum value encountered for any such restriction.
263
264       Value : Restriction_Values;
265       --  If the entry for a parameter restriction in Set is True (i.e. a
266       --  restrictions pragma for the restriction has been encountered), then
267       --  the corresponding entry in the Value array is the minimum value
268       --  specified by any such restrictions pragma. Note that a restrictions
269       --  pragma specifying a value greater than Int'Last is simply ignored.
270
271       Violated : Restriction_Flags;
272       --  An entry is True in the violations array if the compiler has detected
273       --  a violation of the restriction. For a parameter restriction, the
274       --  Count and Unknown arrays have additional information.
275
276       Count : Restriction_Values;
277       --  If an entry for a parameter restriction is True in Violated, the
278       --  corresponding entry in the Count array may record additional
279       --  information. If the actual minimum count is known (by taking
280       --  maximums, or sums, depending on the restriction), it will be
281       --  recorded in this array. If not, then the value will remain zero.
282       --  The value is also zero for a non-violated restriction.
283
284       Unknown : Parameter_Flags;
285       --  If an entry for a parameter restriction is True in Violated, the
286       --  corresponding entry in the Unknown array may record additional
287       --  information. If the actual count is not known by the compiler (but
288       --  is known to be non-zero), then the entry in Unknown will be True.
289       --  This indicates that the value in Count is not known to be exact,
290       --  and the actual violation count may be higher.
291
292       --  Note: If Violated (K) is True, then either Count (K) > 0 or
293       --  Unknown (K) = True. It is possible for both these to be set.
294       --  For example, if Count (K) = 3 and Unknown (K) is True, it means
295       --  that the actual violation count is at least 3 but might be higher.
296    end record;
297
298    No_Restrictions : constant Restrictions_Info :=
299      (Set      => (others => False),
300       Value    => (others => 0),
301       Violated => (others => False),
302       Count    => (others => 0),
303       Unknown  => (others => False));
304    --  Used to initialize Restrictions_Info variables
305
306    ----------------------------------
307    -- Profile Definitions and Data --
308    ----------------------------------
309
310    type Profile_Name is (No_Profile, Ravenscar, Restricted);
311    --  Names of recognized profiles. No_Profile is used to indicate that a
312    --  restriction came from pragma Restrictions[_Warning], as opposed to
313    --  pragma Profile[_Warning].
314
315    subtype Profile_Name_Actual is Profile_Name range Ravenscar .. Restricted;
316    --  Actual used profile names
317
318    type Profile_Data is record
319       Set : Restriction_Flags;
320       --  Set to True if given restriction must be set for the profile, and
321       --  False if it need not be set (False does not mean that it must not be
322       --  set, just that it need not be set). If the flag is True for a
323       --  parameter restriction, then the Value array gives the maximum value
324       --  permitted by the profile.
325
326       Value : Restriction_Values;
327       --  An entry in this array is meaningful only if the corresponding flag
328       --  in Set is True. In that case, the value in this array is the maximum
329       --  value of the parameter permitted by the profile.
330    end record;
331
332    Profile_Info : array (Profile_Name_Actual) of Profile_Data :=
333
334                      --  Restricted Profile
335
336                     (Restricted =>
337
338                         --  Restrictions for Restricted profile
339
340                        (Set   =>
341                           (No_Abort_Statements             => True,
342                            No_Asynchronous_Control         => True,
343                            No_Dynamic_Attachment           => True,
344                            No_Dynamic_Priorities           => True,
345                            No_Entry_Queue                  => True,
346                            No_Local_Protected_Objects      => True,
347                            No_Protected_Type_Allocators    => True,
348                            No_Requeue_Statements           => True,
349                            No_Task_Allocators              => True,
350                            No_Task_Attributes_Package      => True,
351                            No_Task_Hierarchy               => True,
352                            No_Terminate_Alternatives       => True,
353                            Max_Asynchronous_Select_Nesting => True,
354                            Max_Protected_Entries           => True,
355                            Max_Select_Alternatives         => True,
356                            Max_Task_Entries                => True,
357                            others                          => False),
358
359                         --  Value settings for Restricted profile
360
361                         Value =>
362                           (Max_Asynchronous_Select_Nesting => 0,
363                            Max_Protected_Entries           => 1,
364                            Max_Select_Alternatives         => 0,
365                            Max_Task_Entries                => 0,
366                            others                          => 0)),
367
368                      --  Ravenscar Profile
369
370                      --  Note: the table entries here only represent the
371                      --  required restriction profile for Ravenscar. The
372                      --  full Ravenscar profile also requires:
373
374                      --    pragma Dispatching_Policy (FIFO_Within_Priorities);
375                      --    pragma Locking_Policy (Ceiling_Locking);
376                      --    pragma Detect_Blocking
377
378                      Ravenscar  =>
379
380                      --  Restrictions for Ravenscar = Restricted profile ..
381
382                        (Set   =>
383                           (No_Abort_Statements             => True,
384                            No_Asynchronous_Control         => True,
385                            No_Dynamic_Attachment           => True,
386                            No_Dynamic_Priorities           => True,
387                            No_Entry_Queue                  => True,
388                            No_Local_Protected_Objects      => True,
389                            No_Protected_Type_Allocators    => True,
390                            No_Requeue_Statements           => True,
391                            No_Task_Allocators              => True,
392                            No_Task_Attributes_Package      => True,
393                            No_Task_Hierarchy               => True,
394                            No_Terminate_Alternatives       => True,
395                            Max_Asynchronous_Select_Nesting => True,
396                            Max_Protected_Entries           => True,
397                            Max_Select_Alternatives         => True,
398                            Max_Task_Entries                => True,
399
400                            --  plus these additional restrictions:
401
402                            No_Calendar                     => True,
403                            No_Implicit_Heap_Allocations    => True,
404                            No_Relative_Delay               => True,
405                            No_Select_Statements            => True,
406                            No_Task_Termination             => True,
407                            Simple_Barriers                 => True,
408                            others                          => False),
409
410                         --  Value settings for Ravenscar (same as Restricted)
411
412                         Value =>
413                           (Max_Asynchronous_Select_Nesting => 0,
414                            Max_Protected_Entries           => 1,
415                            Max_Select_Alternatives         => 0,
416                            Max_Task_Entries                => 0,
417                            others                          => 0)));
418
419 end System.Rident;