X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FdeSugar%2FDsForeign.lhs;h=133e1d6b7d4ada386be43948d2390189233680b8;hb=225d251337438e2f7870f0ec2781b1c616ef7462;hp=a5dbf5316651fae152df68ca2d39dc88fad01638;hpb=99073d876ea762016683fb0b22b9d343ff864eb4;p=ghc-hetmet.git diff --git a/ghc/compiler/deSugar/DsForeign.lhs b/ghc/compiler/deSugar/DsForeign.lhs index a5dbf53..133e1d6 100644 --- a/ghc/compiler/deSugar/DsForeign.lhs +++ b/ghc/compiler/deSugar/DsForeign.lhs @@ -12,33 +12,40 @@ module DsForeign ( dsForeigns ) where import CoreSyn -import DsCCall ( dsCCall, mkCCall, boxResult, unboxArg, resultWrapper ) +import DsCCall ( dsCCall, mkFCall, boxResult, unboxArg, resultWrapper ) import DsMonad -import HsSyn ( ExtName(..), ForeignDecl(..), isDynamicExtName, ForKind(..) ) -import HsDecls ( extNameStatic ) -import CallConv +import HsSyn ( ForeignDecl(..), FoExport(..), FoImport(..) ) import TcHsSyn ( TypecheckedForeignDecl ) import CoreUtils ( exprType, mkInlineMe ) -import Id ( Id, idType, idName, mkVanillaId, mkSysLocal, +import Id ( Id, idType, idName, mkVanillaGlobal, mkSysLocal, setInlinePragma ) -import IdInfo ( neverInlinePrag ) +import IdInfo ( neverInlinePrag, vanillaIdInfo ) import Literal ( Literal(..) ) import Module ( Module, moduleUserString ) import Name ( mkGlobalName, nameModule, nameOccName, getOccString, mkForeignExportOcc, isLocalName, NamedThing(..), ) -import Type ( unUsgTy, repType, - splitTyConApp_maybe, splitFunTys, splitForAllTys, - Type, mkFunTys, mkForAllTys, mkTyConApp, - mkFunTy, splitAppTy, applyTy, funResultTy + +import Type ( repType, eqType ) +import TcType ( Type, mkFunTys, mkForAllTys, mkTyConApp, + mkFunTy, applyTy, + tcSplitForAllTys, tcSplitFunTys, tcTyConAppArgs, + tcSplitTyConApp_maybe, tcSplitAppTy, + tcFunResultTy + ) + +import ForeignCall ( ForeignCall(..), CCallSpec(..), + Safety(..), playSafe, + CExportSpec(..), + CCallConv(..), ccallConvToInt ) -import PrimOp ( CCall(..), CCallTarget(..), dynamicTarget ) -import TysWiredIn ( unitTy, addrTy, stablePtrTyCon ) +import CStrings ( CLabelString ) +import TysWiredIn ( addrTy, unitTy, stablePtrTyCon ) import TysPrim ( addrPrimTy ) -import PrelNames ( hasKey, ioTyConKey, deRefStablePtrName, - bindIOName, returnIOName, makeStablePtrName +import PrelNames ( hasKey, ioTyConKey, deRefStablePtrName, newStablePtrName, + bindIOName, returnIOName ) import Outputable @@ -72,37 +79,25 @@ dsForeigns :: Module , SDoc -- C stubs to use when calling -- "foreign exported" functions. ) -dsForeigns mod_name fos = foldlDs combine ([], [], empty, empty) fos +dsForeigns mod_name fos + = foldlDs combine ([], [], empty, empty) fos where - combine (acc_feb, acc_f, acc_h, acc_c) fo@(ForeignDecl i imp_exp _ ext_nm cconv _) - | isForeignImport = -- foreign import (dynamic)? - dsFImport i (idType i) uns ext_nm cconv `thenDs` \ bs -> - returnDs (acc_feb, bs ++ acc_f, acc_h, acc_c) - | isForeignLabel = - dsFLabel i (idType i) ext_nm `thenDs` \ b -> - returnDs (acc_feb, b:acc_f, acc_h, acc_c) - | isDynamicExtName ext_nm = - dsFExportDynamic i (idType i) mod_name ext_nm cconv `thenDs` \ (feb,bs,h,c) -> - returnDs (feb:acc_feb, bs ++ acc_f, h $$ acc_h, c $$ acc_c) - - | otherwise = -- foreign export - dsFExport i (idType i) mod_name ext_nm cconv False `thenDs` \ (feb,fe,h,c) -> - returnDs (feb:acc_feb, fe:acc_f, h $$ acc_h, c $$ acc_c) - where - isForeignImport = - case imp_exp of - FoImport _ -> True - _ -> False - - isForeignLabel = - case imp_exp of - FoLabel -> True - _ -> False - - (FoImport uns) = imp_exp + combine (acc_feb, acc_f, acc_h, acc_c) (ForeignImport id _ spec _) + = dsFImport mod_name id spec `thenDs` \ (bs, h, c) -> + returnDs (acc_feb, bs ++ acc_f, h $$ acc_h, c $$ acc_c) + combine (acc_feb, acc_f, acc_h, acc_c) (ForeignExport id _ (CExport (CExportStatic ext_nm cconv)) _) + = dsFExport mod_name id (idType id) ext_nm cconv False `thenDs` \ (feb, b, h, c) -> + returnDs (feb:acc_feb, b : acc_f, h $$ acc_h, c $$ acc_c) \end{code} + +%************************************************************************ +%* * +\subsection{Foreign import} +%* * +%************************************************************************ + Desugaring foreign imports is just the matter of creating a binding that on its RHS unboxes its arguments, performs the external call (using the @CCallOp@ primop), before boxing the result up and returning it. @@ -123,33 +118,58 @@ because it exposes the boxing to the call site. \begin{code} -dsFImport :: Id - -> Type -- Type of foreign import. - -> Bool -- True <=> might cause Haskell GC - -> ExtName - -> CallConv - -> DsM [Binding] -dsFImport fn_id ty may_not_gc ext_name cconv +dsFImport :: Module + -> Id + -> FoImport + -> DsM ([Binding], SDoc, SDoc) +dsFImport mod_name lbl_id (LblImport ext_nm) + = ASSERT(fromJust res_ty `eqType` addrPrimTy) -- typechecker ensures this + returnDs ([(lbl_id, rhs)], empty, empty) + where + (res_ty, fo_rhs) = resultWrapper (idType lbl_id) + rhs = fo_rhs (mkLit (MachLabel ext_nm)) + +dsFImport mod_name fn_id (CImport spec) = dsFCall mod_name fn_id (CCall spec) +dsFImport mod_name fn_id (DNImport spec) = dsFCall mod_name fn_id (DNCall spec) +dsFImport mod_name fn_id (CDynImport cconv) = dsFExportDynamic mod_name fn_id cconv +\end{code} + + +%************************************************************************ +%* * +\subsection{Foreign calls} +%* * +%************************************************************************ + +\begin{code} +dsFCall mod_Name fn_id fcall = let - (tvs, fun_ty) = splitForAllTys ty - (arg_tys, io_res_ty) = splitFunTys fun_ty + ty = idType fn_id + (tvs, fun_ty) = tcSplitForAllTys ty + (arg_tys, io_res_ty) = tcSplitFunTys fun_ty + -- Must use tcSplit* functions because we want to + -- see that (IO t) in the corner in newSysLocalsDs arg_tys `thenDs` \ args -> mapAndUnzipDs unboxArg (map Var args) `thenDs` \ (val_args, arg_wrappers) -> - boxResult io_res_ty `thenDs` \ (ccall_result_ty, res_wrapper) -> - getUniqueDs `thenDs` \ ccall_uniq -> - getUniqueDs `thenDs` \ work_uniq -> let - lbl = case ext_name of - Dynamic -> dynamicTarget - ExtName fs _ -> StaticTarget fs + work_arg_ids = [v | Var v <- val_args] -- All guaranteed to be vars + + -- These are the ids we pass to boxResult, which are used to decide + -- whether to touch# an argument after the call (used to keep + -- ForeignObj#s live across a 'safe' foreign import). + maybe_arg_ids | unsafe_call fcall = work_arg_ids + | otherwise = [] + in + boxResult maybe_arg_ids io_res_ty `thenDs` \ (ccall_result_ty, res_wrapper) -> + getUniqueDs `thenDs` \ ccall_uniq -> + getUniqueDs `thenDs` \ work_uniq -> + let -- Build the worker - work_arg_ids = [v | Var v <- val_args] -- All guaranteed to be vars worker_ty = mkForAllTys tvs (mkFunTys (map idType work_arg_ids) ccall_result_ty) - the_ccall = CCall lbl False (not may_not_gc) cconv - the_ccall_app = mkCCall ccall_uniq the_ccall val_args ccall_result_ty + the_ccall_app = mkFCall ccall_uniq fcall val_args ccall_result_ty work_rhs = mkLams tvs (mkLams work_arg_ids the_ccall_app) work_id = mkSysLocal SLIT("$wccall") work_uniq worker_ty @@ -158,20 +178,18 @@ dsFImport fn_id ty may_not_gc ext_name cconv wrapper_body = foldr ($) (res_wrapper work_app) arg_wrappers wrap_rhs = mkInlineMe (mkLams (tvs ++ args) wrapper_body) in - returnDs [(work_id, work_rhs), (fn_id, wrap_rhs)] + returnDs ([(work_id, work_rhs), (fn_id, wrap_rhs)], empty, empty) + +unsafe_call (CCall (CCallSpec _ _ safety)) = playSafe safety +unsafe_call (DNCall _) = False \end{code} -Foreign labels -\begin{code} -dsFLabel :: Id -> Type -> ExtName -> DsM Binding -dsFLabel nm ty ext_name = - ASSERT(fromJust res_ty == addrPrimTy) -- typechecker ensures this - returnDs (nm, fo_rhs (mkLit (MachLabel enm))) - where - (res_ty, fo_rhs) = resultWrapper ty - enm = extNameStatic ext_name -\end{code} +%************************************************************************ +%* * +\subsection{Foreign export} +%* * +%************************************************************************ The function that does most of the work for `@foreign export@' declarations. (see below for the boilerplate code a `@foreign export@' declaration expands @@ -185,24 +203,29 @@ For each `@foreign export foo@' in a module M we generate: the user-written Haskell function `@M.foo@'. \begin{code} -dsFExport :: Id - -> Type -- Type of foreign export. - -> Module - -> ExtName - -> CallConv - -> Bool -- True => invoke IO action that's hanging off - -- the first argument's stable pointer +dsFExport :: Module + -> Id -- Either the exported Id, + -- or the foreign-export-dynamic constructor + -> Type -- The type of the thing callable from C + -> CLabelString -- The name to export to C land + -> CCallConv + -> Bool -- True => foreign export dynamic + -- so invoke IO action that's hanging off + -- the first argument's stable pointer -> DsM ( Id -- The foreign-exported Id , Binding , SDoc , SDoc ) -dsFExport fn_id ty mod_name ext_name cconv isDyn +dsFExport mod_name fn_id ty ext_name cconv isDyn = -- BUILD THE returnIO WRAPPER, if necessary -- Look at the result type of the exported function, orig_res_ty -- If it's IO t, return (\x.x, IO t, t) -- If it's plain t, return (\x.returnIO x, IO t, t) - (case splitTyConApp_maybe orig_res_ty of + (case tcSplitTyConApp_maybe orig_res_ty of + -- We must use tcSplit here so that we see the (IO t) in + -- the type. [IO t is transparent to plain splitTyConApp.] + Just (ioTyCon, [res_ty]) -> ASSERT( ioTyCon `hasKey` ioTyConKey ) -- The function already returns IO t @@ -211,7 +234,7 @@ dsFExport fn_id ty mod_name ext_name cconv isDyn other -> -- The function returns t, so wrap the call in returnIO dsLookupGlobalValue returnIOName `thenDs` \ retIOId -> returnDs (\body -> mkApps (Var retIOId) [Type orig_res_ty, body], - funResultTy (applyTy (idType retIOId) orig_res_ty), + tcFunResultTy (applyTy (idType retIOId) orig_res_ty), -- We don't have ioTyCon conveniently to hand orig_res_ty) @@ -259,7 +282,7 @@ dsFExport fn_id ty mod_name ext_name cconv isDyn helper_ty = mkForAllTys tvs $ mkFunTys wrapper_arg_tys io_res_ty - f_helper_glob = mkVanillaId helper_name helper_ty + f_helper_glob = mkVanillaGlobal helper_name helper_ty vanillaIdInfo where name = idName fn_id mod @@ -271,26 +294,29 @@ dsFExport fn_id ty mod_name ext_name cconv isDyn the_app = getFun_wrapper (return_io_wrapper (mkVarApps (Var i) (tvs ++ fe_args))) the_body = mkLams (tvs ++ wrapper_args) the_app - c_nm = extNameStatic ext_name (h_stub, c_stub) = fexportEntry (moduleUserString mod) - c_nm f_helper_glob - wrapper_arg_tys res_ty cconv isDyn + ext_name f_helper_glob + wrapper_arg_tys res_ty cconv isDyn in returnDs (f_helper_glob, (f_helper_glob, the_body), h_stub, c_stub) where - (tvs,sans_foralls) = splitForAllTys ty - (fe_arg_tys', orig_res_ty) = splitFunTys sans_foralls - - (_, stbl_ptr_ty') = splitForAllTys stbl_ptr_ty - (_, stbl_ptr_to_ty) = splitAppTy stbl_ptr_ty' + (tvs,sans_foralls) = tcSplitForAllTys ty + (fe_arg_tys', orig_res_ty) = tcSplitFunTys sans_foralls + -- We must use tcSplits here, because we want to see + -- the (IO t) in the corner of the type! fe_arg_tys | isDyn = tail fe_arg_tys' | otherwise = fe_arg_tys' stbl_ptr_ty | isDyn = head fe_arg_tys' | otherwise = error "stbl_ptr_ty" + + (_, stbl_ptr_ty') = tcSplitForAllTys stbl_ptr_ty + (_, stbl_ptr_to_ty) = tcSplitAppTy stbl_ptr_ty' + -- Again, stable pointers are just newtypes, + -- so we must see them! Hence tcSplit* \end{code} @foreign export dynamic@ lets you dress up Haskell IO actions @@ -305,7 +331,7 @@ foreign export dynamic f :: (Addr -> Int -> IO Int) -> IO Addr f :: (Addr -> Int -> IO Int) -> IO Addr f cback = - bindIO (makeStablePtr cback) + bindIO (newStablePtr cback) (\StablePtr sp# -> IO (\s1# -> case _ccall_ createAdjustor cconv sp# ``f_helper'' s1# of (# s2#, a# #) -> (# s2#, A# a# #))) @@ -316,25 +342,21 @@ foreign export "f_helper" f_helper :: StablePtr (Addr -> Int -> IO Int) -> Addr \end{verbatim} \begin{code} -dsFExportDynamic :: Id - -> Type -- Type of foreign export. - -> Module - -> ExtName - -> CallConv - -> DsM (Id, [Binding], SDoc, SDoc) -dsFExportDynamic i ty mod_name ext_name cconv = - newSysLocalDs ty `thenDs` \ fe_id -> +dsFExportDynamic :: Module + -> Id + -> CCallConv + -> DsM ([Binding], SDoc, SDoc) +dsFExportDynamic mod_name id cconv + = newSysLocalDs ty `thenDs` \ fe_id -> let -- hack: need to get at the name of the C stub we're about to generate. - fe_nm = moduleUserString mod_name ++ "_" ++ toCName fe_id - fe_ext_name = ExtName (_PK_ fe_nm) Nothing + fe_nm = _PK_ (moduleUserString mod_name ++ "_" ++ toCName fe_id) in - dsFExport i export_ty mod_name fe_ext_name cconv True - `thenDs` \ (feb, fe, h_code, c_code) -> - newSysLocalDs arg_ty `thenDs` \ cback -> - dsLookupGlobalValue makeStablePtrName `thenDs` \ makeStablePtrId -> + dsFExport mod_name id export_ty fe_nm cconv True `thenDs` \ (feb, fe, h_code, c_code) -> + newSysLocalDs arg_ty `thenDs` \ cback -> + dsLookupGlobalValue newStablePtrName `thenDs` \ newStablePtrId -> let - mk_stbl_ptr_app = mkApps (Var makeStablePtrId) [ Type arg_ty, Var cback ] + mk_stbl_ptr_app = mkApps (Var newStablePtrId) [ Type arg_ty, Var cback ] in dsLookupGlobalValue bindIOName `thenDs` \ bindIOId -> newSysLocalDs (mkTyConApp stablePtrTyCon [arg_ty]) `thenDs` \ stbl_value -> @@ -354,39 +376,36 @@ dsFExportDynamic i ty mod_name ext_name cconv = to be entered using an external calling convention (stdcall, ccall). -} - adj_args = [ mkIntLitInt (callConvToInt cconv) + adj_args = [ mkIntLitInt (ccallConvToInt cconv) , Var stbl_value - , mkLit (MachLabel (_PK_ fe_nm)) + , mkLit (MachLabel fe_nm) ] -- name of external entry point providing these services. -- (probably in the RTS.) adjustor = SLIT("createAdjustor") in - dsCCall adjustor adj_args False False io_res_ty `thenDs` \ ccall_adj -> + dsCCall adjustor adj_args PlayRisky False io_res_ty `thenDs` \ ccall_adj -> + -- PlayRisky: the adjustor doesn't allocate in the Haskell heap or do a callback let ccall_adj_ty = exprType ccall_adj ccall_io_adj = mkLams [stbl_value] $ - Note (Coerce io_res_ty (unUsgTy ccall_adj_ty)) + Note (Coerce io_res_ty ccall_adj_ty) ccall_adj - in - let io_app = mkLams tvs $ + io_app = mkLams tvs $ mkLams [cback] $ stbl_app ccall_io_adj res_ty - fed = (i `setInlinePragma` neverInlinePrag, io_app) + fed = (id `setInlinePragma` neverInlinePrag, io_app) -- Never inline the f.e.d. function, because the litlit -- might not be in scope in other modules. in - returnDs (feb, [fed, fe], h_code, c_code) + returnDs ([fed, fe], h_code, c_code) where - (tvs,sans_foralls) = splitForAllTys ty - ([arg_ty], io_res_ty) = splitFunTys sans_foralls - - Just (ioTyCon, [res_ty]) = splitTyConApp_maybe io_res_ty - - export_ty = mkFunTy (mkTyConApp stablePtrTyCon [arg_ty]) arg_ty - - ioAddrTy :: Type -- IO Addr - ioAddrTy = mkTyConApp ioTyCon [addrTy] + ty = idType id + (tvs,sans_foralls) = tcSplitForAllTys ty + ([arg_ty], io_res_ty) = tcSplitFunTys sans_foralls + [res_ty] = tcTyConAppArgs io_res_ty + -- Must use tcSplit* to see the (IO t), which is a newtype + export_ty = mkFunTy (mkTyConApp stablePtrTyCon [arg_ty]) arg_ty toCName :: Id -> String toCName i = showSDoc (pprCode CStyle (ppr (idName i))) @@ -408,7 +427,7 @@ fexportEntry :: String -> Id -> [Type] -> Type - -> CallConv + -> CCallConv -> Bool -> (SDoc, SDoc) fexportEntry mod_nm c_nm helper args res_ty cc isDyn = (header_bits, c_bits) @@ -442,14 +461,14 @@ fexportEntry mod_nm c_nm helper args res_ty cc isDyn = (header_bits, c_bits) cParamTypes = map showStgType real_args - res_ty_is_unit = res_ty == unitTy + res_ty_is_unit = res_ty `eqType` unitTy -- Look through any newtypes cResType | res_ty_is_unit = text "void" | otherwise = showStgType res_ty - pprCconv - | cc == cCallConv = empty - | otherwise = pprCallConv cc + pprCconv = case cc of + CCallConv -> empty + StdCallConv -> ppr cc declareResult = text "HaskellObj ret;" @@ -470,9 +489,10 @@ fexportEntry mod_nm c_nm helper args res_ty cc isDyn = (header_bits, c_bits) needed by the Adjustor.c code to get the stack cleanup right. -} (proto_args, real_args) - | cc == cCallConv && isDyn = ( text "a0" : text "a_" : mkCArgNames 1 (tail args) - , head args : addrTy : tail args) - | otherwise = (mkCArgNames 0 args, args) + = case cc of + CCallConv | isDyn -> ( text "a0" : text "a_" : mkCArgNames 1 (tail args) + , head args : addrTy : tail args) + other -> (mkCArgNames 0 args, args) mkCArgNames :: Int -> [a] -> [SDoc] mkCArgNames n as = zipWith (\ _ n -> text ('a':show n)) as [n..] @@ -484,12 +504,12 @@ unpackHObj :: Type -> SDoc unpackHObj t = text "rts_get" <> text (showFFIType t) showStgType :: Type -> SDoc -showStgType t = text "Stg" <> text (showFFIType t) +showStgType t = text "Hs" <> text (showFFIType t) showFFIType :: Type -> String showFFIType t = getOccString (getName tc) where - tc = case splitTyConApp_maybe (repType t) of + tc = case tcSplitTyConApp_maybe (repType t) of Just (tc,_) -> tc Nothing -> pprPanic "showFFIType" (ppr t) \end{code}