[project @ 2002-02-05 17:32:24 by simonmar]
[packages/base.git] / GHC / TopHandler.lhs
1 -- -----------------------------------------------------------------------------
2 -- $Id: TopHandler.lhs,v 1.4 2002/02/05 17:32:27 simonmar Exp $
3 --
4 -- (c) The University of Glasgow, 2001
5 --
6 -- GHC.TopHandler
7 --
8 -- 'Top-level' IO actions want to catch exceptions (e.g., forkIO and 
9 -- GHC.Main.mainIO) and report them - topHandler is the exception
10 -- handler they should use for this:
11
12 -- make sure we handle errors while reporting the error!
13 -- (e.g. evaluating the string passed to 'error' might generate
14 --  another error, etc.)
15
16 -- These functions can't go in GHC.Main, because GHC.Main isn't
17 -- included in HSstd.o (because GHC.Main depends on Main, which
18 -- doesn't exist yet...).
19
20 \begin{code}
21 module GHC.TopHandler (
22    topHandler, reportStackOverflow, reportError 
23   ) where
24
25 import Prelude
26
27 import System.IO
28
29 import Foreign.C.String
30 import Foreign.Ptr
31 import GHC.IOBase
32 import GHC.Exception
33
34 topHandler :: Exception -> IO ()
35 topHandler err = catchException (real_handler err) topHandler
36
37 real_handler :: Exception -> IO ()
38 real_handler ex =
39   case ex of
40         AsyncException StackOverflow -> reportStackOverflow True
41
42         -- only the main thread gets ExitException exceptions
43         ExitException ExitSuccess     -> shutdownHaskellAndExit 0
44         ExitException (ExitFailure n) -> shutdownHaskellAndExit n
45
46         Deadlock    -> reportError True 
47                         "no threads to run:  infinite loop or deadlock?"
48   
49         ErrorCall s -> reportError True s
50         other       -> reportError True (showsPrec 0 other "\n")
51
52 -- NOTE: shutdownHaskellAndExit must be called "safe", because it *can*
53 -- re-enter Haskell land through finalizers.
54 foreign import ccall "shutdownHaskellAndExit" 
55   shutdownHaskellAndExit :: Int -> IO ()
56
57 reportStackOverflow :: Bool -> IO ()
58 reportStackOverflow bombOut = do
59    (hFlush stdout) `catchException` (\ _ -> return ())
60    callStackOverflowHook
61    if bombOut then
62      stg_exit 2
63     else
64      return ()
65
66 reportError :: Bool -> String -> IO ()
67 reportError bombOut str = do
68    (hFlush stdout) `catchException` (\ _ -> return ())
69    withCStringLen str $ \(cstr,len) -> do
70      writeErrString errorHdrHook cstr len
71      if bombOut 
72         then stg_exit 1
73         else return ()
74
75 #ifndef ILX
76 foreign label "ErrorHdrHook" errorHdrHook :: Ptr ()
77 #else
78 foreign import "ErrorHdrHook" errorHdrHook :: Ptr ()
79 #endif
80
81 foreign import ccall "writeErrString__" unsafe
82         writeErrString :: Ptr () -> CString -> Int -> IO ()
83
84 -- SUP: Are the hooks allowed to re-enter Haskell land?  If so, remove
85 -- the unsafe below.
86 foreign import ccall "stackOverflow" unsafe
87         callStackOverflowHook :: IO ()
88
89 foreign import ccall "stg_exit" unsafe
90         stg_exit :: Int -> IO ()
91 \end{code}