Add {-# OPTIONS_GHC -w #-} and some blurb to all compiler modules
[ghc-hetmet.git] / compiler / codeGen / CgForeignCall.hs
index 10f41bd..23b68d8 100644 (file)
@@ -2,10 +2,17 @@
 --
 -- Code generation for foreign calls.
 --
--- (c) The University of Glasgow 2004
+-- (c) The University of Glasgow 2004-2006
 --
 -----------------------------------------------------------------------------
 
+{-# OPTIONS_GHC -w #-}
+-- The above warning supression flag is a temporary kludge.
+-- While working on this module you are encouraged to remove it and fix
+-- any warnings in the module. See
+--     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
+-- for details
+
 module CgForeignCall (
   cgForeignCall,
   emitForeignCall,
@@ -19,31 +26,31 @@ module CgForeignCall (
 
 #include "HsVersions.h"
 
-import StgSyn          ( StgLiveVars, StgArg, stgArgType )
-import CgProf          ( curCCS, curCCSAddr )
-import CgBindery       ( getVolatileRegs, getArgAmodes )
+import StgSyn
+import CgProf
+import CgBindery
 import CgMonad
-import CgUtils         ( cmmOffsetW, cmmOffsetB, cmmLoadIndexW, newTemp,
-                         assignTemp )
-import Type            ( tyConAppTyCon, repType )
+import CgUtils
+import Type
 import TysPrim
-import CLabel          ( mkForeignLabel, mkRtsCodeLabel )
+import CLabel
 import Cmm
 import CmmUtils
 import MachOp
 import SMRep
 import ForeignCall
+import ClosureInfo
 import Constants
-import StaticFlags     ( opt_SccProfilingOn )
+import StaticFlags
 import Outputable
 
-import Monad           ( when )
+import Control.Monad
 
 -- -----------------------------------------------------------------------------
 -- Code generation for Foreign Calls
 
 cgForeignCall
-       :: [(CmmReg,MachHint)]  -- where to put the results
+       :: CmmHintFormals       -- where to put the results
        -> ForeignCall          -- the op
        -> [StgArg]             -- arguments
        -> StgLiveVars  -- live vars, in case we need to save them
@@ -63,7 +70,7 @@ cgForeignCall results fcall stg_args live
 
 
 emitForeignCall
-       :: [(CmmReg,MachHint)]  -- where to put the results
+       :: CmmHintFormals       -- where to put the results
        -> ForeignCall          -- the op
        -> [(CmmExpr,MachHint)] -- arguments
        -> StgLiveVars  -- live vars, in case we need to save them
@@ -71,8 +78,9 @@ emitForeignCall
 
 emitForeignCall results (CCall (CCallSpec target cconv safety)) args live
   = do vols <- getVolatileRegs live
+       srt <- getSRTInfo
        emitForeignCall' safety results
-               (CmmForeignCall cmm_target cconv) call_args (Just vols)
+         (CmmCallee cmm_target cconv) call_args (Just vols) srt CmmMayReturn
   where
       (call_args, cmm_target)
        = case target of
@@ -91,44 +99,58 @@ emitForeignCall results (CCall (CCallSpec target cconv safety)) args live
        -- ToDo: this might not be correct for 64-bit API
       arg_size rep = max (machRepByteWidth rep) wORD_SIZE
 
-emitForeignCall results (DNCall _) args live
+emitForeignCall _ (DNCall _) _ _
   = panic "emitForeignCall: DNCall"
 
 
 -- alternative entry point, used by CmmParse
 emitForeignCall'
        :: Safety
-       -> [(CmmReg,MachHint)]  -- where to put the results
+       -> CmmHintFormals       -- where to put the results
        -> CmmCallTarget        -- the op
        -> [(CmmExpr,MachHint)] -- arguments
        -> Maybe [GlobalReg]    -- live vars, in case we need to save them
+        -> C_SRT                -- the SRT of the calls continuation
+        -> CmmReturnInfo
        -> Code
-emitForeignCall' safety results target args vols 
+emitForeignCall' safety results target args vols srt ret
   | not (playSafe safety) = do
     temp_args <- load_args_into_temps args
-    stmtC (CmmCall target results temp_args vols)
+    let (caller_save, caller_load) = callerSaveVolatileRegs vols
+    stmtsC caller_save
+    stmtC (CmmCall target results temp_args CmmUnsafe ret)
+    stmtsC caller_load
 
   | otherwise = do
-    id <- newTemp wordRep
+    -- Both 'id' and 'new_base' are KindNonPtr because they're
+    -- RTS only objects and are not subject to garbage collection
+    id <- newNonPtrTemp wordRep
+    new_base <- newNonPtrTemp (cmmRegRep (CmmGlobal BaseReg))
     temp_args <- load_args_into_temps args
+    temp_target <- load_target_into_temp target
+    let (caller_save, caller_load) = callerSaveVolatileRegs vols
     emitSaveThreadState
-    stmtC (CmmCall (CmmForeignCall suspendThread CCallConv) 
-                       [(id,PtrHint)]
+    stmtsC caller_save
+    -- The CmmUnsafe arguments are only correct because this part
+    -- of the code hasn't been moved into the CPS pass yet.
+    -- Once that happens, this function will just emit a (CmmSafe srt) call,
+    -- and the CPS will will be the one to convert that
+    -- to this sequence of three CmmUnsafe calls.
+    stmtC (CmmCall (CmmCallee suspendThread CCallConv) 
+                       [ (id,PtrHint) ]
                        [ (CmmReg (CmmGlobal BaseReg), PtrHint) ] 
-                       vols
-                       )
-    stmtC (CmmCall target results temp_args vols)
-    stmtC (CmmCall (CmmForeignCall resumeThread CCallConv) 
-                       [ (CmmGlobal BaseReg, PtrHint) ]
-                               -- Assign the result to BaseReg: we
-                               -- might now have a different
-                               -- Capability!
-                       [ (CmmReg id, PtrHint) ]
-                       vols
-                       )
+                       CmmUnsafe ret)
+    stmtC (CmmCall temp_target results temp_args CmmUnsafe ret)
+    stmtC (CmmCall (CmmCallee resumeThread CCallConv) 
+                       [ (new_base, PtrHint) ]
+                       [ (CmmReg (CmmLocal id), PtrHint) ]
+                       CmmUnsafe ret)
+    -- Assign the result to BaseReg: we
+    -- might now have a different Capability!
+    stmtC (CmmAssign (CmmGlobal BaseReg) (CmmReg (CmmLocal new_base)))
+    stmtsC caller_load
     emitLoadThreadState
 
-
 suspendThread = CmmLit (CmmLabel (mkRtsCodeLabel SLIT("suspendThread")))
 resumeThread  = CmmLit (CmmLabel (mkRtsCodeLabel SLIT("resumeThread")))
 
@@ -140,16 +162,26 @@ resumeThread  = CmmLit (CmmLabel (mkRtsCodeLabel SLIT("resumeThread")))
 --
 -- This is a HACK; really it should be done in the back end, but
 -- it's easier to generate the temporaries here.
-load_args_into_temps args = mapM maybe_assignTemp args
+load_args_into_temps = mapM arg_assign_temp
+  where arg_assign_temp (e,hint) = do
+          tmp <- maybe_assign_temp e
+          return (tmp,hint)
        
-maybe_assignTemp (e, hint)
-  | hasNoGlobalRegs e = return (e, hint)
+load_target_into_temp (CmmCallee expr conv) = do 
+  tmp <- maybe_assign_temp expr
+  return (CmmCallee tmp conv)
+load_target_into_temp other_target =
+  return other_target
+
+maybe_assign_temp e
+  | hasNoGlobalRegs e = return e
   | otherwise          = do 
        -- don't use assignTemp, it uses its own notion of "trivial"
-       -- expressions, which are wrong here
-       reg <- newTemp (cmmExprRep e)
-       stmtC (CmmAssign reg e)
-       return (CmmReg reg, hint)
+       -- expressions, which are wrong here.
+        -- this is a NonPtr because it only duplicates an existing
+       reg <- newNonPtrTemp (cmmExprRep e) --TODO FIXME NOW
+       stmtC (CmmAssign (CmmLocal reg) e)
+       return (CmmReg (CmmLocal reg))
 
 -- -----------------------------------------------------------------------------
 -- Save/restore the thread state in the TSO
@@ -169,22 +201,22 @@ emitSaveThreadState = do
 emitCloseNursery = stmtC $ CmmStore nursery_bdescr_free (cmmOffsetW stgHp 1)
 
 emitLoadThreadState = do
-  tso <- newTemp wordRep
+  tso <- newNonPtrTemp wordRep -- TODO FIXME NOW
   stmtsC [
        -- tso = CurrentTSO;
-       CmmAssign tso stgCurrentTSO,
+       CmmAssign (CmmLocal tso) stgCurrentTSO,
        -- Sp = tso->sp;
-       CmmAssign sp (CmmLoad (cmmOffset (CmmReg tso) tso_SP)
+       CmmAssign sp (CmmLoad (cmmOffset (CmmReg (CmmLocal tso)) tso_SP)
                              wordRep),
        -- SpLim = tso->stack + RESERVED_STACK_WORDS;
-       CmmAssign spLim (cmmOffsetW (cmmOffset (CmmReg tso) tso_STACK)
+       CmmAssign spLim (cmmOffsetW (cmmOffset (CmmReg (CmmLocal tso)) tso_STACK)
                                    rESERVED_STACK_WORDS)
     ]
   emitOpenNursery
   -- and load the current cost centre stack from the TSO when profiling:
   when opt_SccProfilingOn $
        stmtC (CmmStore curCCSAddr 
-               (CmmLoad (cmmOffset (CmmReg tso) tso_CCCS) wordRep))
+               (CmmLoad (cmmOffset (CmmReg (CmmLocal tso)) tso_CCCS) wordRep))
 
 emitOpenNursery = stmtsC [
         -- Hp = CurrentNursery->free - 1;