OSDN Git Service

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