Panic.lhs 5.32 KB
Newer Older
1
%
2
% (c) The GRASP Project, Glasgow University, 1992-2000
3 4 5 6 7 8 9 10 11
%
\section{Panic error messages}

Defines basic funtions for printing error messages.

It's hard to put these functions anywhere else without causing
some unnecessary loops in the module dependency graph.

\begin{code}
12 13 14
module Panic  
   ( 
     GhcException(..), ghcError, progName, 
sof's avatar
sof committed
15
     panic, panic#, assertPanic, trace,
16
     showException, showGhcException, tryMost,
17
     installSignalHandlers,
18 19 20 21

#if __GLASGOW_HASKELL__ <= 408
     catchJust, ioErrors, throwTo,
#endif
22
   ) where
23

24 25
#include "HsVersions.h"

26
import Config
27
import FastTypes
28

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
#if __GLASGOW_HASKELL__ > 504
import System.Posix.Signals
#else
import Posix		( Handler(Catch), installHandler, sigINT, sigQUIT )
#endif

#ifndef mingw32_HOST_OS
import CONCURRENT	( myThreadId )

# if __GLASGOW_HASKELL__ < 500
import EXCEPTION        ( raiseInThread )
#define throwTo  raiseInThread
# else
import EXCEPTION	( throwTo )
# endif
#endif

46
import DYNAMIC
47
import qualified EXCEPTION as Exception
48 49
import TRACE		( trace )
import UNSAFE_IO	( unsafePerformIO )
50 51

import System
52 53
\end{code}

54 55 56 57
GHC's own exception type.

\begin{code}
ghcError :: GhcException -> a
58
ghcError e = Exception.throwDyn e
59

60 61 62 63 64 65 66 67 68
-- error messages all take the form
--
--	<location>: <error>
--
-- If the location is on the command line, or in GHC itself, then 
-- <location>="ghc".  All of the error types below correspond to 
-- a <location> of "ghc", except for ProgramError (where the string is
-- assumed to contain a location already, so we don't print one).

69
data GhcException
sof's avatar
sof committed
70 71
  = PhaseFailed String		-- name of phase 
  		ExitCode	-- an external phase (eg. cpp) failed
72
  | Interrupted			-- someone pressed ^C
73
  | UsageError String		-- prints the short usage msg after the error
74
  | CmdLineError String		-- cmdline prob, but doesn't print usage
75
  | Panic String		-- the `impossible' happened
76 77
  | InstallationError String	-- an installation problem
  | ProgramError String		-- error in the user's code, probably
78 79 80 81 82 83 84
  deriving Eq

progName = unsafePerformIO (getProgName)
{-# NOINLINE progName #-}

short_usage = "Usage: For basic information, try the `--help' option."
   
85
showException :: Exception.Exception -> String
86
-- Show expected dynamic exceptions specially
87 88 89
showException (Exception.DynException d) | Just e <- fromDynamic d 
					 = show (e::GhcException)
showException other_exn	       	 	 = show other_exn
90

91
instance Show GhcException where
92 93
  showsPrec _ e@(ProgramError _) = showGhcException e
  showsPrec _ e = showString progName . showString ": " . showGhcException e
94

95
showGhcException (UsageError str)
96
   = showString str . showChar '\n' . showString short_usage
97
showGhcException (PhaseFailed phase code)
sof's avatar
sof committed
98 99 100 101 102 103 104 105
   = showString "phase `" . showString phase . 
     showString "' failed (exitcode = " . shows int_code . 
     showString ")"
  where
    int_code = 
      case code of
        ExitSuccess   -> (0::Int)
	ExitFailure x -> x
106 107 108 109 110 111 112
showGhcException (CmdLineError str)
   = showString str
showGhcException (ProgramError str)
   = showString str
showGhcException (InstallationError str)
   = showString str
showGhcException (Interrupted)
113
   = showString "interrupted"
114
showGhcException (Panic s)
115 116
   = showString ("panic! (the `impossible' happened, GHC version "
		 ++ cProjectVersion ++ "):\n\t"
117 118
	         ++ s ++ "\n\n"
	         ++ "Please report it as a compiler bug "
119 120
	         ++ "to glasgow-haskell-bugs@haskell.org,\n"
		 ++ "or http://sourceforge.net/projects/ghc/.\n\n")
121 122 123 124 125 126 127 128 129

ghcExceptionTc = mkTyCon "GhcException"
{-# NOINLINE ghcExceptionTc #-}
instance Typeable GhcException where
  typeOf _ = mkAppTy ghcExceptionTc []
\end{code}

Panics and asserts.

130 131
\begin{code}
panic :: String -> a
132
panic x = Exception.throwDyn (Panic x)
133 134 135 136 137

-- #-versions because panic can't return an unboxed int, and that's
-- what TAG_ is with GHC at the moment.  Ugh. (Simon)
-- No, man -- Too Beautiful! (Will)

138 139
panic# :: String -> FastInt
panic# s = case (panic s) of () -> _ILIT 0
140 141

assertPanic :: String -> Int -> a
142
assertPanic file line = 
143
  Exception.throw (Exception.AssertionFailed 
144
           ("ASSERT failed! file " ++ file ++ ", line " ++ show line))
145
\end{code}
146 147 148 149 150 151

\begin{code}
-- | tryMost is like try, but passes through Interrupted and Panic
-- exceptions.  Used when we want soft failures when reading interface
-- files, for example.

152
tryMost :: IO a -> IO (Either Exception.Exception a)
153
tryMost action = do r <- myTry action; filter r
154
  where
155
   filter (Left e@(Exception.DynException d))
156 157
	    | Just ghc_ex <- fromDynamic d
		= case ghc_ex of
158 159
		    Interrupted -> Exception.throw e
		    Panic _     -> Exception.throw e
160 161 162 163 164
		    _other      -> return (Left e)
   filter other 
     = return other

#if __GLASGOW_HASKELL__ <= 408
165
myTry = Exception.tryAllIO
166
#else
167
myTry = Exception.try
168 169 170 171 172 173 174
#endif
\end{code}	

Compatibility stuff:

\begin{code}
#if __GLASGOW_HASKELL__ <= 408
sof's avatar
sof committed
175 176 177
catchJust = Exception.catchIO
ioErrors  = Exception.justIoErrors
throwTo   = Exception.raiseInThread
178 179
#endif
\end{code}
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196

Standard signal handlers for catching ^C, which just throw an
exception in the main thread.  NOTE: must be called from the main
thread.

\begin{code}
installSignalHandlers :: IO ()
installSignalHandlers = do
#ifndef mingw32_HOST_OS
  main_thread <- myThreadId
  let sig_handler = Catch (throwTo main_thread 
				(Exception.DynException (toDyn Interrupted)))
  installHandler sigQUIT sig_handler Nothing 
  installHandler sigINT  sig_handler Nothing
#endif
  return ()
\end{code}