gcc/ada/s-intman.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                GNU ADA RUN-TIME LIBRARY (GNARL) COMPONENTS               --
   4 --                                                                          --
   5 --            S Y S T E M . I N T E R R U P T _ M A N A G E M E N T         --
   6 --                                                                          --
   7 --                                  S p e c                                 --
   8 --                                                                          --
   9 --                             $Revision$
  10 --                                                                          --
  11 --          Copyright (C) 1991-2001 Free Software Foundation, Inc.          --
  12 --                                                                          --
  13 -- GNARL is free software; you can  redistribute it  and/or modify it under --
  14 -- terms of the  GNU General Public License as published  by the Free Soft- --
  15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16 -- sion. GNARL is distributed in the hope that it will be useful, but WITH- --
  17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19 -- for  more details.  You should have  received  a copy of the GNU General --
  20 -- Public License  distributed with GNARL; see file COPYING.  If not, write --
  21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22 -- MA 02111-1307, USA.                                                      --
  23 --                                                                          --
  24 -- As a special exception,  if other files  instantiate  generics from this --
  25 -- unit, or you link  this unit with other files  to produce an executable, --
  26 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  27 -- covered  by the  GNU  General  Public  License.  This exception does not --
  28 -- however invalidate  any other reasons why  the executable file  might be --
  29 -- covered by the  GNU Public License.                                      --
  30 --                                                                          --
  31 -- GNARL was developed by the GNARL team at Florida State University. It is --
  32 -- now maintained by Ada Core Technologies Inc. in cooperation with Florida --
  33 -- State University (http://www.gnat.com).                                  --
  34 --                                                                          --
  35 ------------------------------------------------------------------------------
  36
  37 --  This package encapsulates and centralizes information about
  38 --  all uses of interrupts (or signals), including the
  39 --  target-dependent mapping of interrupts (or signals) to exceptions.
  40
  41 --  PLEASE DO NOT add any with-clauses to this package.
  42 --  This is designed to work for both tasking and non-tasking systems,
  43 --  without pulling in any of the tasking support.
  44
  45 --  PLEASE DO NOT remove the Elaborate_Body pragma from this package.
  46 --  Elaboration of this package should happen early, as most other
  47 --  initializations depend on it.
  48 --  Forcing immediate elaboration of the body also helps to enforce
  49 --  the design assumption that this is a second-level
  50 --  package, just one level above System.OS_Interface, with no
  51 --  cross-dependences.
  52
  53 --  PLEASE DO NOT put any subprogram declarations with arguments of
  54 --  type Interrupt_ID into the visible part of this package.
  55 --  The type Interrupt_ID is used to derive the type in Ada.Interrupts,
  56 --  and adding more operations to that type would be illegal according
  57 --  to the Ada Reference Manual.  (This is the reason why the signals sets
  58 --  below are implemented as visible arrays rather than functions.)
  59
  60 with System.OS_Interface;
  61 --  used for Signal
  62 --           sigset_t
  63
  64 package System.Interrupt_Management is
  65
  66    pragma Elaborate_Body;
  67
  68    type Interrupt_Mask is limited private;
  69
  70    type Interrupt_ID is new System.OS_Interface.Signal;
  71
  72    type Interrupt_Set is array (Interrupt_ID) of Boolean;
  73
  74    --  The following objects serve as constants, but are initialized
  75    --  in the body to aid portability.  This permits us
  76    --  to use more portable names for interrupts,
  77    --  where distinct names may map to the same interrupt ID value.
  78    --  For example, suppose SIGRARE is a signal that is not defined on
  79    --  all systems, but is always reserved when it is defined.
  80    --  If we have the convention that ID zero is not used for any "real"
  81    --  signals, and SIGRARE = 0 when SIGRARE is not one of the locally
  82    --  supported signals, we can write
  83    --     Reserved (SIGRARE) := true;
  84    --  and the initialization code will be portable.
  85
  86    Abort_Task_Interrupt : Interrupt_ID;
  87    --  The interrupt that is used to implement task abortion,
  88    --  if an interrupt is used for that purpose.
  89    --  This is one of the reserved interrupts.
  90
  91    Keep_Unmasked : Interrupt_Set := (others => False);
  92    --  Keep_Unmasked (I) is true iff the interrupt I is
  93    --  one that must be kept unmasked at all times,
  94    --  except (perhaps) for short critical sections.
  95    --  This includes interrupts that are mapped to exceptions
  96    --  (see System.Interrupt_Exceptions.Is_Exception), but may also
  97    --  include interrupts (e.g. timer) that need to be kept unmasked
  98    --  for other reasons.
  99    --  Where interrupts are implemented as OS signals, and signal masking
 100    --  is per-task, the interrupt should be unmasked in ALL TASKS.
 101
 102    Reserve : Interrupt_Set := (others => False);
 103    --  Reserve (I) is true iff the interrupt I is one that
 104    --  cannot be permitted to be attached to a user handler.
 105    --  The possible reasons are many.  For example,
 106    --  it may be mapped to an exception, used to implement task abortion,
 107    --  or used to implement time delays.
 108
 109    Keep_Masked : Interrupt_Set := (others => False);
 110    --  Keep_Masked (I) is true iff the interrupt I must always be masked.
 111    --  Where interrupts are implemented as OS signals, and signal masking
 112    --  is per-task, the interrupt should be masked in ALL TASKS.
 113    --  There might not be any interrupts in this class, depending on
 114    --  the environment.  For example, if interrupts are OS signals
 115    --  and signal masking is per-task, use of the sigwait operation
 116    --  requires the signal be masked in all tasks.
 117
 118    procedure Initialize_Interrupts;
 119    --  On systems where there is no signal inheritance between tasks (e.g
 120    --  VxWorks, GNU/LinuxThreads), this procedure is used to initialize
 121    --  interrupts handling in each task. Otherwise this function should
 122    --  only be called by initialize in this package body.
 123
 124 private
 125    type Interrupt_Mask is new System.OS_Interface.sigset_t;
 126    --  in some implementation Interrupt_Mask can be represented
 127    --  as a linked list.
 128 end System.Interrupt_Management;