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 --          Copyright (C) 1991-2001 Free Software Foundation, Inc.          --
  10 --                                                                          --
  11 -- GNARL 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. GNARL 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 GNARL; see file COPYING.  If not, write --
  19 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  20 -- MA 02111-1307, 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 -- GNARL was developed by the GNARL team at Florida State University.       --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  This package encapsulates and centralizes information about
  35 --  all uses of interrupts (or signals), including the
  36 --  target-dependent mapping of interrupts (or signals) to exceptions.
  37
  38 --  PLEASE DO NOT add any with-clauses to this package.
  39 --  This is designed to work for both tasking and non-tasking systems,
  40 --  without pulling in any of the tasking support.
  41
  42 --  PLEASE DO NOT remove the Elaborate_Body pragma from this package.
  43 --  Elaboration of this package should happen early, as most other
  44 --  initializations depend on it.
  45 --  Forcing immediate elaboration of the body also helps to enforce
  46 --  the design assumption that this is a second-level
  47 --  package, just one level above System.OS_Interface, with no
  48 --  cross-dependences.
  49
  50 --  PLEASE DO NOT put any subprogram declarations with arguments of
  51 --  type Interrupt_ID into the visible part of this package.
  52 --  The type Interrupt_ID is used to derive the type in Ada.Interrupts,
  53 --  and adding more operations to that type would be illegal according
  54 --  to the Ada Reference Manual.  (This is the reason why the signals sets
  55 --  below are implemented as visible arrays rather than functions.)
  56
  57 with System.OS_Interface;
  58 --  used for Signal
  59 --           sigset_t
  60
  61 package System.Interrupt_Management is
  62
  63    pragma Elaborate_Body;
  64
  65    type Interrupt_Mask is limited private;
  66
  67    type Interrupt_ID is new System.OS_Interface.Signal;
  68
  69    type Interrupt_Set is array (Interrupt_ID) of Boolean;
  70
  71    --  The following objects serve as constants, but are initialized
  72    --  in the body to aid portability.  This permits us
  73    --  to use more portable names for interrupts,
  74    --  where distinct names may map to the same interrupt ID value.
  75    --  For example, suppose SIGRARE is a signal that is not defined on
  76    --  all systems, but is always reserved when it is defined.
  77    --  If we have the convention that ID zero is not used for any "real"
  78    --  signals, and SIGRARE = 0 when SIGRARE is not one of the locally
  79    --  supported signals, we can write
  80    --     Reserved (SIGRARE) := true;
  81    --  and the initialization code will be portable.
  82
  83    Abort_Task_Interrupt : Interrupt_ID;
  84    --  The interrupt that is used to implement task abortion,
  85    --  if an interrupt is used for that purpose.
  86    --  This is one of the reserved interrupts.
  87
  88    Keep_Unmasked : Interrupt_Set := (others => False);
  89    --  Keep_Unmasked (I) is true iff the interrupt I is
  90    --  one that must be kept unmasked at all times,
  91    --  except (perhaps) for short critical sections.
  92    --  This includes interrupts that are mapped to exceptions
  93    --  (see System.Interrupt_Exceptions.Is_Exception), but may also
  94    --  include interrupts (e.g. timer) that need to be kept unmasked
  95    --  for other reasons.
  96    --  Where interrupts are implemented as OS signals, and signal masking
  97    --  is per-task, the interrupt should be unmasked in ALL TASKS.
  98
  99    Reserve : Interrupt_Set := (others => False);
 100    --  Reserve (I) is true iff the interrupt I is one that
 101    --  cannot be permitted to be attached to a user handler.
 102    --  The possible reasons are many.  For example,
 103    --  it may be mapped to an exception, used to implement task abortion,
 104    --  or used to implement time delays.
 105
 106    Keep_Masked : Interrupt_Set := (others => False);
 107    --  Keep_Masked (I) is true iff the interrupt I must always be masked.
 108    --  Where interrupts are implemented as OS signals, and signal masking
 109    --  is per-task, the interrupt should be masked in ALL TASKS.
 110    --  There might not be any interrupts in this class, depending on
 111    --  the environment.  For example, if interrupts are OS signals
 112    --  and signal masking is per-task, use of the sigwait operation
 113    --  requires the signal be masked in all tasks.
 114
 115    procedure Initialize_Interrupts;
 116    --  On systems where there is no signal inheritance between tasks (e.g
 117    --  VxWorks, GNU/LinuxThreads), this procedure is used to initialize
 118    --  interrupts handling in each task. Otherwise this function should
 119    --  only be called by initialize in this package body.
 120
 121 private
 122    type Interrupt_Mask is new System.OS_Interface.sigset_t;
 123    --  in some implementation Interrupt_Mask can be represented
 124    --  as a linked list.
 125 end System.Interrupt_Management;