\begin{code}
module DsForeign ( dsForeigns ) where
-
#include "HsVersions.h"
import CoreSyn
-import DsCCall ( getIoOkDataCon, boxResult, unboxArg,
- can'tSeeDataConsPanic, wrapUnboxedValue
- )
+import DsCCall ( dsCCall, boxResult, unboxArg, wrapUnboxedValue )
import DsMonad
import DsUtils
import HsSyn ( ExtName(..), ForeignDecl(..), isDynamic, ForKind(..) )
import CallConv
-import TcHsSyn ( maybeBoxedPrimType, TypecheckedForeignDecl )
+import TcHsSyn ( TypecheckedForeignDecl )
import CoreUtils ( coreExprType )
-import Id ( Id, dataConArgTys, idType, idName,
- mkVanillaId, dataConRawArgTys,
- dataConTyCon, mkIdVisible
+import Const ( Con(..), mkMachInt )
+import DataCon ( DataCon, dataConId )
+import Id ( Id, idType, idName,
+ mkIdVisible, mkWildId
)
-import IdInfo ( noIdInfo )
-import Literal ( Literal(..), mkMachInt )
-import Maybes ( maybeToBool )
-import Name ( nameString, occNameString, nameOccName, nameUnique )
-import PrelVals ( packStringForCId, eRROR_ID, realWorldPrimId )
-import PrimOp ( PrimOp(..) )
-import Type ( isUnpointedType, splitAlgTyConApp_maybe,
+import Const ( Literal(..) )
+import Name ( getOccString, NamedThing(..) )
+import PrelVals ( realWorldPrimId )
+import PrelInfo ( deRefStablePtr_NAME, bindIO_NAME, makeStablePtr_NAME )
+import Type ( splitAlgTyConApp_maybe,
splitTyConApp_maybe, splitFunTys, splitForAllTys,
- Type, mkFunTys, applyTy, mkForAllTys, mkTyConApp,
- typePrimRep, mkTyVarTy, mkFunTy, splitAppTy
+ Type, mkFunTys, mkForAllTys, mkTyConApp,
+ mkTyVarTy, mkFunTy, splitAppTy
)
-import PrimRep ( showPrimRepToUser, PrimRep(..) )
-import TyVar ( TyVar )
-import TyCon ( tyConDataCons )
-import TysPrim ( byteArrayPrimTy, realWorldStatePrimTy,
- byteArrayPrimTyCon, mutableByteArrayPrimTyCon,
- realWorldTy, addrPrimTy, mkStablePtrPrimTy,
- intPrimTy
- )
-import TysWiredIn ( getStatePairingConInfo,
- unitDataCon, stringTy,
- realWorldStateTy, stateDataCon,
- isFFIArgumentTy, unitTy,
- addrTy, stablePtrTyCon,
- stateAndPtrPrimDataCon,
- addrDataCon
+import PrimOp ( PrimOp(..) )
+import Var ( TyVar )
+import TysPrim ( realWorldStatePrimTy, addrPrimTy )
+import TysWiredIn ( unitTyCon, addrTy, stablePtrTyCon,
+ unboxedTupleCon, addrDataCon
)
import Unique
import Outputable
\begin{code}
dsForeigns :: [TypecheckedForeignDecl]
- -> DsM ( [CoreBinding] -- desugared foreign imports
- , [CoreBinding] -- helper functions for foreign exports
- , SDoc -- auxilliary code to emit into .hc file
- , SDoc -- Header file prototypes for "foreign exported" functions.
- , SDoc -- C stubs to use when calling "foreign exported" funs.
+ -> DsM ( [CoreBind] -- desugared foreign imports
+ , [CoreBind] -- helper functions for foreign exports
+ , SDoc -- Header file prototypes for "foreign exported" functions.
+ , SDoc -- C stubs to use when calling "foreign exported" funs.
)
-dsForeigns fos = foldlDs combine ([],[],empty,empty,empty) fos
+dsForeigns fos = foldlDs combine ([],[],empty,empty) fos
where
- combine (acc_fi, acc_fe, acc_hc, acc_h, acc_c) fo@(ForeignDecl i imp_exp _ ext_nm cconv _)
- | isForeignImport =
+ combine (acc_fi, acc_fe, 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` \ b ->
- returnDs (b:acc_fi, acc_fe, acc_hc, acc_h, acc_c)
+ returnDs (b:acc_fi, acc_fe, acc_h, acc_c)
| isForeignLabel =
dsFLabel i ext_nm `thenDs` \ b ->
- returnDs (b:acc_fi, acc_fe, acc_hc, acc_h, acc_c)
+ returnDs (b:acc_fi, acc_fe, acc_h, acc_c)
| isDynamic ext_nm =
- dsFExportDynamic i (idType i) ext_nm cconv `thenDs` \ (fi,fe,hc,h,c) ->
- returnDs (fi:acc_fi, fe:acc_fe, hc $$ acc_hc, h $$ acc_h, c $$ acc_c)
- | otherwise =
- dsFExport i (idType i) ext_nm cconv False `thenDs` \ (fe,hc,h,c) ->
- returnDs (acc_fi, fe:acc_fe, hc $$ acc_hc, h $$ acc_h, c $$ acc_c)
+ dsFExportDynamic i (idType i) ext_nm cconv `thenDs` \ (fi,fe,h,c) ->
+ returnDs (fi:acc_fi, fe:acc_fe, h $$ acc_h, c $$ acc_c)
+ | otherwise = -- foreign export
+ dsFExport i (idType i) ext_nm cconv False `thenDs` \ (fe,h,c) ->
+ returnDs (acc_fi, fe:acc_fe, h $$ acc_h, c $$ acc_c)
where
isForeignImport =
case imp_exp of
-> Bool -- True <=> might cause Haskell GC
-> ExtName
-> CallConv
- -> DsM CoreBinding
+ -> DsM CoreBind
dsFImport nm ty may_not_gc ext_name cconv =
newSysLocalDs realWorldStatePrimTy `thenDs` \ old_s ->
- mkArgs ty `thenDs` \ (tvs, args, io_res_ty) ->
- mapAndUnzipDs unboxArg args `thenDs` \ (unboxed_args, arg_wrappers) ->
+ splitForeignTyDs ty `thenDs` \ (tvs, args, mbIoDataCon, io_res_ty) ->
let
the_state_arg
| is_io_action = old_s
| otherwise = realWorldPrimId
- final_args = Var the_state_arg : unboxed_args
- (ioOkDataCon, ioDataCon, result_ty) = getIoOkDataCon io_res_ty
+ arg_exprs = map (Var) args
is_io_action =
- case (splitTyConApp_maybe io_res_ty) of
- Just (iot,[_]) -> (uniqueOf iot) == ioTyConKey
- _ -> False
+ case mbIoDataCon of
+ Nothing -> False
+ _ -> True
in
+ mapAndUnzipDs unboxArg arg_exprs `thenDs` \ (unboxed_args, arg_wrappers) ->
(if not is_io_action then
- newSysLocalDs realWorldStatePrimTy `thenDs` \ state_tok ->
- wrapUnboxedValue io_res_ty `thenDs` \ (state_and_foo, state_and_foo_ty, v, res_v) ->
- let the_alt = (state_and_foo, [state_tok,v], res_v) in
- returnDs (state_and_foo_ty, \ prim_app -> Case prim_app (AlgAlts [the_alt] NoDefault))
+ newSysLocalDs realWorldStatePrimTy `thenDs` \ state_tok ->
+ wrapUnboxedValue io_res_ty `thenDs` \ (ccall_result_ty, v, res_v) ->
+ returnDs ( ccall_result_ty
+ , \ prim_app -> Case prim_app (mkWildId ccall_result_ty)
+ [(DataCon (unboxedTupleCon 2), [state_tok, v], res_v)])
else
- boxResult ioOkDataCon result_ty) `thenDs` \ (final_result_ty, res_wrapper) ->
+ boxResult io_res_ty) `thenDs` \ (final_result_ty, res_wrapper) ->
(case ext_name of
Dynamic -> getUniqueDs `thenDs` \ u ->
returnDs (Right u)
- ExtName fs _ -> returnDs (Left fs)) `thenDs` \ label ->
+ ExtName fs _ -> returnDs (Left fs)) `thenDs` \ label ->
let
+ val_args = Var the_state_arg : unboxed_args
+ final_args = Type inst_ty : val_args
+
+ -- A CCallOp has type (forall a. a), so we must instantiate
+ -- it at the full type, including the state argument
+ inst_ty = mkFunTys (map coreExprType val_args) final_result_ty
+
the_ccall_op = CCallOp label False (not may_not_gc) cconv
- (map coreExprType final_args)
- final_result_ty
- in
- mkPrimDs the_ccall_op (map VarArg final_args) `thenDs` \ the_prim_app ->
- let
- body = foldr ($) (res_wrapper the_prim_app) arg_wrappers
- the_body
+ the_prim_app = mkPrimApp the_ccall_op (final_args :: [CoreArg])
+
+ body = foldr ($) (res_wrapper the_prim_app) arg_wrappers
+
+ the_body
| not is_io_action = body
- | otherwise = mkValLam [old_s] body
+ | otherwise = Lam old_s body
in
newSysLocalDs (coreExprType the_body) `thenDs` \ ds ->
let
- io_app
- | is_io_action = mkValApp (mkTyApp (Var ioDataCon) [result_ty]) [VarArg ds]
- | otherwise = Var ds
-
- fo_rhs = mkTyLam tvs $
- mkValLam (map (\ (Var x) -> x) args)
- (mkCoLetAny (NonRec ds the_body) io_app)
+ io_app =
+ case mbIoDataCon of
+ Nothing -> Var ds
+ Just ioDataCon ->
+ mkApps (Var (dataConId ioDataCon))
+ [Type io_res_ty, Var ds]
+
+ fo_rhs = mkLams (tvs ++ args)
+ (Let (NonRec ds (the_body::CoreExpr)) io_app)
in
returnDs (NonRec nm fo_rhs)
+\end{code}
+
+Given the type of a foreign import declaration, split it up into
+its constituent parts.
-mkArgs :: Type -> DsM ([TyVar], [CoreExpr], Type)
-mkArgs ty =
- case splitFunTys sans_foralls of
- (arg_tys, res_ty) ->
- newSysLocalsDs arg_tys `thenDs` \ ds_args ->
- returnDs (tvs, map Var ds_args, res_ty)
+\begin{code}
+splitForeignTyDs :: Type -> DsM ([TyVar], [Id], Maybe DataCon, Type)
+splitForeignTyDs ty =
+ newSysLocalsDs arg_tys `thenDs` \ ds_args ->
+ case splitAlgTyConApp_maybe res_ty of
+ Just (_,(io_res_ty:_),(ioCon:_)) -> -- .... -> IO t
+ returnDs (tvs, ds_args, Just ioCon, io_res_ty)
+ _ -> -- .... -> t
+ returnDs (tvs, ds_args, Nothing, res_ty)
where
+ (arg_tys, res_ty) = splitFunTys sans_foralls
(tvs, sans_foralls) = splitForAllTys ty
-
+
\end{code}
+foreign labels
\begin{code}
-dsFLabel :: Id -> ExtName -> DsM CoreBinding
-dsFLabel nm ext_name =
- returnDs (NonRec nm fo_rhs)
+dsFLabel :: Id -> ExtName -> DsM CoreBind
+dsFLabel nm ext_name = returnDs (NonRec nm fo_rhs)
where
- fo_rhs = mkCon addrDataCon [] [LitArg (MachLitLit enm AddrRep)]
+ fo_rhs = mkConApp addrDataCon [mkLit (MachLitLit enm addrPrimTy)]
enm =
case ext_name of
ExtName f _ -> f
+ Dynamic -> panic "dsFLabel: Dynamic - shouldn't ever happen."
\end{code}
-
+The function that does most of the work for 'foreign export' declarations.
+(see below for the boilerplate code a 'foreign export' declaration expands
+ into.)
\begin{code}
dsFExport :: Id
-> CallConv
-> Bool -- True => invoke IO action that's hanging off
-- the first argument's stable pointer
- -> DsM (CoreBinding, SDoc, SDoc, SDoc)
+ -> DsM ( CoreBind
+ , SDoc
+ , SDoc
+ )
dsFExport i ty ext_name cconv isDyn =
- newSysLocalDs realWorldStatePrimTy `thenDs` \ s1 ->
- newSysLocalDs realWorldStatePrimTy `thenDs` \ s3 ->
newSysLocalDs helper_ty `thenDs` \ f_helper ->
- newSysLocalsDs helper_arg_tys `thenDs` \ helper_args ->
- newSysLocalDs res_ty `thenDs` \ v1 ->
- unboxResult the_prim_result_ty res_ty s3 v1 `thenDs` \ (state_and_prim_ty, unpack_result) ->
- zipWithDs boxArg fe_arg_tys helper_args `thenDs` \ stuff ->
+ newSysLocalsDs fe_arg_tys `thenDs` \ fe_args ->
(if isDyn then
- newSysLocalDs realWorldStatePrimTy `thenDs` \ s11 ->
newSysLocalDs stbl_ptr_ty `thenDs` \ stbl_ptr ->
- newSysLocalDs stbl_ptr_to_ty `thenDs` \ f ->
- mkPrimDs DeRefStablePtrOp
- [TyArg stbl_ptr_to_ty,
- VarArg (Var stbl_ptr),
- VarArg (Var s1)] `thenDs` \ the_deref_app ->
+ newSysLocalDs stbl_ptr_to_ty `thenDs` \ stbl_value ->
+ dsLookupGlobalValue deRefStablePtr_NAME `thenDs` \ deRefStablePtrId ->
let
- stbl_app = \ cont ->
- Case the_deref_app
- (AlgAlts [(stateAndPtrPrimDataCon, [s11, f], cont)]
- NoDefault)
+ the_deref_app = mkApps (Var deRefStablePtrId)
+ [ Type stbl_ptr_to_ty, Var stbl_ptr ]
in
- returnDs (f, stbl_app, s11, stbl_ptr)
+ newSysLocalDs (coreExprType the_deref_app) `thenDs` \ x_deref_app ->
+ dsLookupGlobalValue bindIO_NAME `thenDs` \ bindIOId ->
+ newSysLocalDs (mkFunTy stbl_ptr_to_ty
+ (mkTyConApp ioTyCon [res_ty])) `thenDs` \ x_cont ->
+ let
+ stbl_app = \ cont ->
+ bindNonRec x_cont (mkLams [stbl_value] cont) $
+ bindNonRec x_deref_app the_deref_app
+ (mkApps (Var bindIOId)
+ [ Type stbl_ptr_to_ty
+ , Type res_ty
+ , Var x_deref_app
+ , Var x_cont])
+ in
+ returnDs (stbl_value, stbl_app, stbl_ptr)
else
returnDs (i,
\ body -> body,
- s1,
panic "stbl_ptr" -- should never be touched.
- )) `thenDs` \ (i, getFun_wrapper, s2, stbl_ptr) ->
+ )) `thenDs` \ (i, getFun_wrapper, stbl_ptr) ->
let
- (boxed_args, arg_wrappers) = unzip stuff
-
wrapper_args
- | isDyn = stbl_ptr:helper_args
- | otherwise = helper_args
+ | isDyn = stbl_ptr:fe_args
+ | otherwise = fe_args
wrapper_arg_tys
| isDyn = stbl_ptr_ty:helper_arg_tys
| otherwise = helper_arg_tys
- fe_app = mkGenApp (Var i) (map (TyArg . mkTyVarTy) tvs ++ map VarArg boxed_args)
the_app =
- getFun_wrapper $
- mkValApp (Note (Coerce io_result_ty io_res) fe_app)
- [VarArg s2]
+ getFun_wrapper $
+ mkApps (Var i) (map (Type . mkTyVarTy) tvs ++ map Var fe_args)
in
- newFailLocalDs (coreExprType the_app) `thenDs` \ wild ->
- getModuleAndGroupDs `thenDs` \ (mod,_) ->
- getUniqueDs `thenDs` \ uniq ->
+ getModuleAndGroupDs `thenDs` \ (mod,_) ->
+ getUniqueDs `thenDs` \ uniq ->
let
-
- the_body =
- mkTyLam tvs $
- mkValLam wrapper_args $
- mkValLam [s1] $
- foldr ($) (perform_and_unpack) arg_wrappers
-
- perform_and_unpack =
- Case the_app (AlgAlts [(ioOkDataCon, [s3, v1], unpack_result)]
- (BindDefault wild err))
+ the_body = mkLams (tvs ++ wrapper_args) the_app
c_nm =
case ext_name of
ExtName fs _ -> fs
+ Dynamic -> panic "dsFExport: Dynamic - shouldn't ever happen."
- full_msg = "Exception caught: " ++ _UNPK_ (nameString (idName i))
- msg = NoRepStr (_PK_ full_msg)
- err = mkApp (Var eRROR_ID) [state_and_prim_ty] [LitArg msg]
-
- f_helper_glob = (mkIdVisible mod uniq f_helper)
- (hc_stub, h_stub, c_stub) = fexportEntry c_nm f_helper_glob wrapper_arg_tys the_prim_result_ty cconv
+ f_helper_glob = mkIdVisible mod uniq f_helper
+ (h_stub, c_stub) = fexportEntry c_nm f_helper_glob wrapper_arg_tys the_result_ty cconv
in
- returnDs (NonRec f_helper_glob the_body, hc_stub, h_stub, c_stub)
+ returnDs (NonRec f_helper_glob the_body, h_stub, c_stub)
+
where
- (tvs,sans_foralls) = splitForAllTys ty
- (fe_arg_tys', io_res) = splitFunTys sans_foralls
- (ioOkDataCon, ioDataCon, res_ty) = getIoOkDataCon io_res
- maybe_data_type = splitAlgTyConApp_maybe res_ty
- Just (tycon, tycon_arg_tys, data_cons) = maybe_data_type
- (the_data_con : other_data_cons) = data_cons
+ (tvs,sans_foralls) = splitForAllTys ty
+ (fe_arg_tys', io_res) = splitFunTys sans_foralls
- data_con_arg_tys = dataConArgTys the_data_con tycon_arg_tys
- (prim_result_ty : other_args_tys) = data_con_arg_tys
- ioDataConTy = idType ioDataCon
- (io_tvs, ioDataConTy') = splitForAllTys ioDataConTy
- ([arg_ty], _) = splitFunTys ioDataConTy'
- io_result_ty = applyTy (mkForAllTys io_tvs arg_ty) res_ty
+ Just (ioTyCon, [res_ty]) = splitTyConApp_maybe io_res
(_, stbl_ptr_ty') = splitForAllTys stbl_ptr_ty
(_, stbl_ptr_to_ty) = splitAppTy stbl_ptr_ty'
| otherwise = fe_arg_tys'
(stbl_ptr_ty, helper_arg_tys) =
- case (map unboxTy fe_arg_tys') of
+ case fe_arg_tys' of
(x:xs) | isDyn -> (x,xs)
ls -> (error "stbl_ptr_ty", ls)
helper_ty =
mkForAllTys tvs $
- mkFunTys (arg_tys ++ [realWorldStatePrimTy])
- state_and_prim_ty
+ mkFunTys arg_tys io_res
where
arg_tys
| isDyn = stbl_ptr_ty : helper_arg_tys
| otherwise = helper_arg_tys
- the_prim_result_ty
- | null data_con_arg_tys = Nothing
- | otherwise = Just prim_result_ty
-
- state_and_prim_ty
- | (null other_data_cons) &&
- (null data_con_arg_tys) = realWorldStateTy
- | otherwise = snd (getStatePairingConInfo (unboxTy res_ty))
+ the_result_ty =
+ case splitTyConApp_maybe io_res of
+ Just (_,[res_ty]) ->
+ case splitTyConApp_maybe res_ty of
+ Just (tc,_) | getUnique tc /= getUnique unitTyCon -> Just res_ty
+ _ -> Nothing
+ _ -> Nothing
+
\end{code}
"foreign export dynamic" lets you dress up Haskell IO actions
-> Type -- Type of foreign export.
-> ExtName
-> CallConv
- -> DsM (CoreBinding, CoreBinding, SDoc, SDoc, SDoc)
+ -> DsM (CoreBind, CoreBind, SDoc, SDoc)
dsFExportDynamic i ty ext_name 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 = toCName fe_id
+ fe_nm = toCName fe_id
fe_ext_name = ExtName (_PK_ fe_nm) Nothing
in
- dsFExport i export_ty fe_ext_name cconv True `thenDs` \ (fe@(NonRec fe_helper fe_expr), hc_code, h_code, c_code) ->
- newSysLocalDs realWorldStatePrimTy `thenDs` \ s1 ->
- newSysLocalDs realWorldStatePrimTy `thenDs` \ s2 ->
- newSysLocalDs realWorldStatePrimTy `thenDs` \ s3 ->
- newSysLocalDs arg_ty `thenDs` \ cback_arg ->
- newSysLocalDs arg_ty `thenDs` \ cback ->
- newSysLocalDs (mkStablePtrPrimTy arg_ty) `thenDs` \ stbl ->
- newSysLocalDs addrPrimTy `thenDs` \ addrPrim ->
- newSysLocalDs addrTy `thenDs` \ addr ->
- mkPrimDs MakeStablePtrOp [TyArg arg_ty,
- VarArg (Var cback),
- VarArg (Var s1)] `thenDs` \ mkStablePtr_app ->
- mkPrimDs Addr2IntOp [VarArg (Var addrPrim)] `thenDs` \ the_addr2Int_app ->
- boxArg addrTy addrPrim `thenDs` \ (addr_result, addrPrim_wrapper) ->
+ dsFExport i export_ty fe_ext_name cconv True `thenDs` \ (fe@(NonRec fe_helper fe_expr), h_code, c_code) ->
+ newSysLocalDs arg_ty `thenDs` \ cback ->
+ dsLookupGlobalValue makeStablePtr_NAME `thenDs` \ makeStablePtrId ->
let
- (stateAndStablePtrPrimDataCon, _) = getStatePairingConInfo (mkStablePtrPrimTy arg_ty)
- (stateAndAddrPrimDataCon, stateAndAddrPrimTy) = getStatePairingConInfo addrPrimTy
-
- cc
- | cconv == stdCallConv = 1
- | otherwise = 0
-
- ccall_args = [Var s2, Lit (mkMachInt cc),
- Var stbl,
- Lit (MachLitLit (_PK_ fe_nm) AddrRep)]
-
- label = Left SLIT("createAdjustor")
- the_ccall_op = CCallOp label False False{-won't GC-} cCallConv
- (map coreExprType ccall_args)
- stateAndAddrPrimTy
+ mk_stbl_ptr_app = mkApps (Var makeStablePtrId) [ Type arg_ty, Var cback ]
+ mk_stbl_ptr_app_ty = coreExprType mk_stbl_ptr_app
in
- mkPrimDs the_ccall_op (map VarArg ccall_args) `thenDs` \ the_ccall_app ->
- mkConDs ioOkDataCon
- [TyArg res_ty, VarArg (Var s3), VarArg (Var addr_result)]
- `thenDs` \ ioOkApp ->
- newSysLocalDs intPrimTy `thenDs` \ default_val ->
+ newSysLocalDs mk_stbl_ptr_app_ty `thenDs` \ x_mk_stbl_ptr_app ->
+ dsLookupGlobalValue bindIO_NAME `thenDs` \ bindIOId ->
+ newSysLocalDs (mkTyConApp stablePtrTyCon [arg_ty]) `thenDs` \ stbl_value ->
let
- the_mkStablePtr = \ cont ->
- Case mkStablePtr_app
- (AlgAlts [(stateAndStablePtrPrimDataCon, [s2, stbl], cont)]
- NoDefault)
-
- the_ccall = \ cont ->
- Case the_ccall_app
- (AlgAlts [(stateAndAddrPrimDataCon, [s3, addrPrim], cont)]
- NoDefault)
- the_addr2Int = \ cont ->
- Case the_addr2Int_app
- (PrimAlts [(mkMachInt 0, io_fail)]
- (BindDefault default_val cont))
-
- io_fail = mkApp (Var eRROR_ID) [coreExprType wrap_res] [LitArg msg]
- full_msg = "Exception caught: " ++ _UNPK_ (nameString (idName i))
- msg = NoRepStr (_PK_ full_msg)
-
- wrap_res = addrPrim_wrapper ioOkApp
- the_body =
- mkTyLam tvs $
- mkValLam [cback,s1] $
- the_mkStablePtr $
- the_ccall $
- the_addr2Int wrap_res
-
- in
- newSysLocalDs (coreExprType the_body) `thenDs` \ ds ->
- newSysLocalDs (mkFunTy realWorldStatePrimTy
- (coreExprType ioOkApp)) `thenDs` \ ap ->
- let
- io_app = mkValApp (mkTyApp (Var ioDataCon) [res_ty]) [VarArg ap]
- io_action =
- mkTyLam tvs $
- mkValLam [cback_arg] $
- mkCoLetAny (NonRec ds the_body) $
- mkCoLetAny (NonRec ap (mkValApp (mkTyApp (Var ds) (map mkTyVarTy tvs)) [VarArg cback_arg])) $
- io_app
- in
- returnDs (NonRec i io_action, fe, hc_code, h_code, c_code)
+ stbl_app = \ x_cont cont ret_ty ->
+ bindNonRec x_cont cont $
+ bindNonRec x_mk_stbl_ptr_app mk_stbl_ptr_app $
+ (mkApps (Var bindIOId)
+ [ Type (mkTyConApp stablePtrTyCon [arg_ty])
+ , Type ret_ty
+ , Var x_mk_stbl_ptr_app
+ , Var x_cont
+ ])
+
+ {-
+ The arguments to the external function which will
+ create a little bit of (template) code on the fly
+ for allowing the (stable pointed) Haskell closure
+ to be entered using an external calling convention
+ (stdcall, ccall).
+ -}
+ adj_args = [ mkLit (mkMachInt (fromInt (callConvToInt cconv)))
+ , Var stbl_value
+ , mkLit (MachLitLit (_PK_ fe_nm) addrPrimTy)
+ ]
+ -- name of external entry point providing these services.
+ -- (probably in the RTS.)
+ adjustor = SLIT("createAdjustor")
+ in
+ dsCCall adjustor adj_args False False addrTy `thenDs` \ ccall_adj ->
+ let ccall_adj_ty = coreExprType ccall_adj
+ in
+ newSysLocalDs ccall_adj_ty `thenDs` \ x_ccall_adj ->
+ let ccall_io_adj =
+ mkLams [stbl_value] $
+ bindNonRec x_ccall_adj ccall_adj $
+ Note (Coerce (mkTyConApp ioTyCon [res_ty]) ccall_adj_ty)
+ (Var x_ccall_adj)
+ in
+ newSysLocalDs (coreExprType ccall_io_adj) `thenDs` \ x_ccall_io_adj ->
+ let io_app = mkLams tvs $
+ mkLams [cback] $
+ stbl_app x_ccall_io_adj ccall_io_adj addrTy
+ in
+ returnDs (NonRec i io_app, fe, h_code, c_code)
+
where
(tvs,sans_foralls) = splitForAllTys ty
([arg_ty], io_res) = splitFunTys sans_foralls
- (ioOkDataCon, ioDataCon, res_ty) = getIoOkDataCon io_res
- ioDataConTy = idType ioDataCon
- (io_tvs, ioDataConTy') = splitForAllTys ioDataConTy
--- ([arg_ty], _) = splitFunTys ioDataConTy'
- io_result_ty = applyTy (mkForAllTys io_tvs arg_ty) res_ty
+ Just (ioTyCon, [res_ty]) = splitTyConApp_maybe io_res
export_ty = mkFunTy (mkTyConApp stablePtrTyCon [arg_ty]) arg_ty
%*
%
-\subsection{Helper functions}
-%
-%*
-
-@boxArg@ boxes up an argument in preparation for calling
-a function that maybe expects a boxed version of it, i.e.,
-
-\begin{verbatim}
-boxArg Addr a# ==> let ds_foo :: Addr ; ds_foo = A# a# in f ...ds_foo..
-\end{verbatim}
-
-\begin{code}
-boxArg :: Type -- Expected type after possible boxing of arg.
- -> Id -- The (unboxed) argument
- -> DsM (Id, -- To pass as the actual, boxed argument
- CoreExpr -> CoreExpr -- Wrapper to box the arg
- )
-boxArg box_ty prim_arg
- | isUnpointedType box_ty = returnDs (prim_arg, \body -> body)
- -- Data types with a single constructor,
- -- which has a single, primitive-typed arg
- | otherwise
- = newSysLocalDs box_ty `thenDs` \ box_arg ->
- returnDs ( box_arg
- , Let (NonRec box_arg (mkCon box_data_con tys_applied [VarArg prim_arg]))
- )
- where
- maybe_boxed_prim_arg_ty = maybeBoxedPrimType box_ty
- (Just (_,tys_applied,_)) = splitAlgTyConApp_maybe box_ty
- (Just (box_data_con, _)) = maybe_boxed_prim_arg_ty
-\end{code}
-
-@foreign export@ed functions may return a value back to the outside world.
-@unboxResult@ takes care of converting from the (boxed) value that the
-exported action returns to the (unboxed) value that is returned across
-the border.
-
-\begin{code}
-unboxResult :: Maybe Type -- the (unboxed) type we want to return (along with the state token)
- -- Nothing => no result, just the state token.
- -> Type -- the (boxed) type we have in our hand.
- -> Id -- the state token
- -> Id -- boxed arg
- -> DsM (Type, -- type of returned expression.
- CoreExpr) -- expr that unboxes result and returns state+unboxed result.
-
-unboxResult mb_res_uboxed_ty res_ty new_s v_boxed
- | not (maybeToBool mb_res_uboxed_ty)
- = -- no result, just return state token
- mkConDs stateDataCon [ TyArg realWorldTy
- , VarArg (Var new_s)] `thenDs` \ the_st ->
- returnDs (realWorldStateTy, the_st)
-
- | null data_cons
- -- oops! can't see the data constructors
- = can'tSeeDataConsPanic "result" res_ty
-
- | (maybeToBool maybe_data_type) && -- Data type
- (null other_data_cons) && -- - with one constructor,
- isUnpointedType res_uboxed_ty -- - and of primitive type.
- -- (Glasgow extension)
- =
- newSysLocalDs res_uboxed_ty `thenDs` \ v_unboxed ->
- mkConDs state_and_prim_datacon
- ((TyArg realWorldTy):map (TyArg ) tycon_arg_tys ++
- [ VarArg (Var new_s)
- , VarArg (Var v_unboxed)]) `thenDs` \ the_result ->
- let
- the_alt = (the_data_con, [v_unboxed], the_result)
- in
- returnDs (state_and_prim_ty,
- Case (Var v_boxed) (AlgAlts [the_alt] NoDefault))
-
- | otherwise
- = pprPanic "unboxResult: " (ppr res_ty)
- where
- (Just res_uboxed_ty) = mb_res_uboxed_ty
-
- maybe_data_type = splitAlgTyConApp_maybe res_ty
- Just (tycon, tycon_arg_tys, data_cons) = maybe_data_type
- (the_data_con : other_data_cons) = data_cons
-
- (state_and_prim_datacon, state_and_prim_ty) = getStatePairingConInfo res_uboxed_ty
-
-\end{code}
-
-Returned the unboxed type of a (primitive) type:
-
-\begin{code}
-unboxTy :: Type -> Type
-unboxTy ty
- | isUnpointedType ty || (ty == unitTy) = ty
- | otherwise =
- ASSERT( isFFIArgumentTy ty ) -- legal arg types subsume result types.
- case splitTyConApp_maybe ty of
- Just (tyc,ts) ->
- case (tyConDataCons tyc) of
- [dc] -> case (dataConArgTys dc ts) of
- [ubox] -> ubox
- -- HACK: for the array types, the prim type is
- -- the second tycon arg.
- [_,ubox] -> ubox
- _ -> pprPanic "unboxTy: " (ppr ty)
- _ -> pprPanic "unboxTy: " (ppr ty)
- _ -> pprPanic "unboxTy: " (ppr ty)
-
-\end{code}
-
-%*
-%
\subsection{Generating @foreign export@ stubs}
%
%*
-[Severe hack to get @foreign export@ off the ground:]
-
-For each @foreign export@ function, a C stub together with a @.hc@ stub
-is generated. The C stub enters the .hc stub, setting up the passing of
-parameters from C land to STG land through the use of global variables
-(don't worry, this just a temporary solution!). Ditto for the result.
-
-[
-The generation of .hc code will go once the transition is
-made over to the new rts. Hence the hack, instead of extending
-AbsCSyn to cope with the .hc code generated.
-]
+For each @foreign export@ function, a C stub function is generated.
+The C stub constructs the application of the exported Haskell function
+using the hugs/ghc rts invocation API.
\begin{code}
-fexportEntry :: FAST_STRING -> Id -> [Type] -> Maybe Type -> CallConv -> (SDoc, SDoc, SDoc)
-fexportEntry c_nm helper args res cc =
- ( paramArea $$ stopTemplate $$ startTemplate $$ vtblTemplate, h_code, c_code )
+fexportEntry :: FAST_STRING -> Id -> [Type] -> Maybe Type -> CallConv -> (SDoc, SDoc)
+fexportEntry c_nm helper args res cc = (header_bits, c_bits)
where
- (h_code, c_code) = mkCStub c_nm h_stub_nm args res cc
-
- paramArea =
- vcat (zipWith declVar ( res_ty : param_tys ) ( res_name : param_names ) )
-
-- name of the (Haskell) helper function generated by the desugarer.
- h_nm = ppr helper
- h_stub_nm = text foreign_export_prefix <> h_nm
- closure = h_nm <> text "_closure"
+ h_nm = ppr helper <> text "_closure"
+ -- prototype for the exported function.
+ header_bits = ptext SLIT("extern") <+> fun_proto <> semi
- param_names = zipWith (\ i _ -> h_stub_nm <> text ('_':show i)) [1..] args
- param_tys = map (ppr.typePrimRep) args
+ fun_proto = cResType <+> pprCconv <+> ptext c_nm <>
+ parens (hsep (punctuate comma (zipWith (<+>) cParamTypes c_args)))
- (res_name, res_ty) =
- case res of
- Nothing -> (empty, empty)
- Just t -> (h_stub_nm <> text "_res", ppr (typePrimRep t))
-
- startTemplate =
+ c_bits =
+ externDecl $$
+ fun_proto $$
vcat
- [ text "extern void* realWorldZh_closure;"
- , ptext SLIT("STGFUN") <> parens (h_stub_nm)
- , lbrace
- , ptext SLIT("FUNBEGIN;")
- , text "RestoreAllStgRegs();"
- , stackCheck param_names
- , pushRetReg
- , pushCont
- , pushRealWorld
- , vcat (map pushArg (reverse param_names))
- , text "Node=" <> closure <> semi
- , text "ENT_VIA_NODE();" -- ticky count
- , text "InfoPtr=(D_)(INFO_PTR(Node));"
- , text "JMP_(ENTRY_CODE(InfoPtr));"
- , text "FUNEND;"
- , rbrace
- ]
-
- stopTemplate =
- vcat
- [ ptext SLIT("STGFUN") <> parens (text "stop" <> h_stub_nm <> text "DirectReturn")
- , lbrace
- , ptext SLIT("FUNBEGIN;")
- , assignResult
- , popRetReg
- , text "#if defined(__STG_GCC_REGS__)"
- , text "SaveAllStgRegs();"
- , text "#else"
- , text "SAVE_Hp = Hp;"
- , text "SAVE_HpLim = HpLim;"
- , text "#endif"
- , text "JMP_(miniInterpretEnd);"
- , text "FUNEND;"
- , rbrace
- ]
-
- vtblTemplate =
- vcat
- [ text "const W_ vtbl_" <> h_stub_nm <> text "[] = {"
- , vcat (punctuate comma (replicate 8 dir_ret))
- , text "};"
- ]
- where
- dir_ret = text "(W_)stop" <> h_stub_nm <> text "DirectReturn"
-
- assignResult =
- case res of
- Nothing -> empty
- Just _ -> res_name <> equals <> text "R3.i;" -- wrong
-
- pushRetReg =
- text "SpB -= BREL(1);" $$
- text "*SpB = (W_)RetReg;"
-
- popRetReg =
- text "RetReg=(StgRetAddr)*SpB;" $$
- text "SpB += BREL(1);"
-
- pushCont =
- text "RetReg=(StgRetAddr)UNVEC(stop" <> h_stub_nm <>
- text "DirectReturn,vtbl_" <> h_stub_nm <> text ");"
-
- pushRealWorld =
- text "SpB -= BREL(1);" $$
- text "*SpB = (W_)realWorldZh_closure;"
+ [ lbrace
+ , text "SchedulerStatus rc;"
+ , declareResult
+ -- create the application + perform it.
+ , text "rc=rts_evalIO" <>
+ parens (foldl appArg (text "(StgClosure*)&" <> h_nm) (zip args c_args) <> comma <> text "&ret") <> semi
+ , returnResult
+ , rbrace
+ ]
+ appArg acc (a,c_a) =
+ text "rts_apply" <> parens (acc <> comma <> mkHObj a <> parens c_a)
- pushArg nm =
- text "SpB -= BREL(1);" $$
- text "*SpB = (W_)" <> nm <> semi
+ cParamTypes = map showStgType args
- stackCheck args =
- text "STK_CHK(LivenessReg,0," <> sz <> text ",0,0,0,0);"
- where
- sz = parens $
- hsep $ punctuate (text " + ") (text "1":(map sizer args))
-
- sizer x = text "BYTES_TO_STGWORDS" <> parens (text "sizeof" <> parens x)
-
-foreign_export_prefix :: String
-foreign_export_prefix = "__fexp_"
-
-mkCStub :: FAST_STRING -> SDoc -> [Type] -> Maybe Type -> CallConv -> (SDoc, SDoc)
-mkCStub c_nm h_stub_nm args res cc =
- ( hsep [ ptext SLIT("extern")
- , cResType
- , pprCconv
- , ptext c_nm
- , parens (hsep (punctuate comma (zipWith (<+>) stubParamTypes stubArgs)))
- , semi
- ]
- , vcat
- [ externDecls
- , cResType
- , pprCconv
- , ptext c_nm <> parens (hsep (punctuate comma stubArgs))
- , vcat (zipWith declVar stubParamTypes stubArgs)
- , lbrace
- , vcat (zipWith assignArgs param_names c_args)
- , text "miniInterpret" <> parens (parens (text "StgFunPtr") <> h_stub_nm) <> semi
- , returnResult
- , rbrace
- ]
- )
- where
- -- tedious hack to let us deal with caller-cleans-up-stack
- -- discipline that the C calling convention uses.
- stubParamTypes
- | cc == cCallConv = ptext SLIT("void*") : cParamTypes
- | otherwise = cParamTypes
- stubArgs
- | cc == cCallConv = ptext SLIT("_a0") : c_args
- | otherwise = c_args
-
- param_names = zipWith (\ i _ -> h_stub_nm <> text ('_':show i)) [1..] args
- cParamTypes = map (text.showPrimRepToUser.typePrimRep) args
- (cResType, cResDecl) =
+ cResType =
case res of
- Nothing -> (text "void", empty)
- Just t -> (text (showPrimRepToUser (typePrimRep t)),
- text "extern" <+> cResType <+> res_name <> semi)
+ Nothing -> text "void"
+ Just t -> showStgType t
pprCconv
| cc == cCallConv = empty
| otherwise = pprCallConv cc
- externDecls =
- vcat (zipWith mkExtern cParamTypes param_names) $$
- cResDecl $$
- text "extern void" <+> h_stub_nm <> text "();"
+ declareResult = text "HaskellObj ret;"
- mkExtern ty nm = text "extern" <+> ty <+> nm <> semi
-
- c_args = zipWith (\ _ n -> text ('a':show n)) args [0..]
+ externDecl = mkExtern (text "HaskellObj") h_nm
- assignArgs p_nm c_arg = p_nm <+> equals <+> c_arg <> semi
+ mkExtern ty nm = text "extern" <+> ty <+> nm <> semi
returnResult =
+ text "rts_checkSchedStatus" <>
+ parens (doubleQuotes (ptext c_nm) <> comma <> text "rc") <> semi $$
+ (case res of
+ Nothing -> text "return"
+ Just _ -> text "return" <> parens (res_name)) <> semi
+
+ res_name =
case res of
Nothing -> empty
- Just _ -> text "return" <+> res_name <> semi
+ Just t -> unpackHObj t <> parens (text "ret")
- (res_name, res_ty) =
- case res of
- Nothing -> (empty, empty)
- Just t -> (h_stub_nm <> text "_res", ppr (typePrimRep t))
+ c_args = zipWith (\ _ n -> text ('a':show n)) args [0..]
-declVar :: SDoc -> SDoc -> SDoc
-declVar ty var = ty <+> var <> semi
+mkHObj :: Type -> SDoc
+mkHObj t = text "rts_mk" <> showFFIType t
-\end{code}
+unpackHObj :: Type -> SDoc
+unpackHObj t = text "rts_get" <> showFFIType t
+
+showStgType :: Type -> SDoc
+showStgType t = text "Stg" <> showFFIType t
-When exporting
-
- f :: Int -> Int -> Int -> IO Int
-
-we'll emit the following stuff into the .hc file
-
-\begin{pseudocode}
-StgInt __f_param_1;
-StgInt __f_param_2;
-StgInt __f_param_3;
-StgInt __f_res;
-
-STGFUN(ds_f)
-{
- FUNBEGIN;
- RestoreAllStgRegs();
- STK_CHK(LivenessReg,0/*A*/,(SIZE_IN_WORDS(StgInt) +
- SIZE_IN_WORDS(StgInt) +
- SIZE_IN_WORDS(StgInt) + 1)/*B*/, 0, 0, 0/*prim*/, 0/*re-enter*/);
- RetReg = (StgRetAddr) UNVEC(stopds_fDirectReturn,vtbl_stopds_f);
- SpB -= BREL(1);
- *SpB = (W_)__f_param_3;
- SpB -= BREL(1);
- *SpB = (W_)__f_param_2;
- SpB -= BREL(1);
- *SpB = (W_)__f_param_1;
-
- SpB -= BREL(1);
- *SpB = (W_) realWorldZh_closure;
-
- Node = ds_f_helper_closure;
- ENT_VIA_NODE();
- InfoPtr=(D_)(INFO_PTR(Node));
- JMP_(ENTRY_CODE(InfoPtr));
- FUNEND;
-}
-
-STGFUN(stop_ds_fDirectReturn)
-{
- FUNBEGIN;
- __f_res=R1.i;
- SaveAllStgRegs();
- RESUME(miniInterpretEnd);
- FUNEND;
-}
-
-const W_ vtbl_stopds_f[] = {
- (W_) stopds_fDirectReturn,
- (W_) stopds_fDirectReturn,
- (W_) stopds_fDirectReturn,
- (W_) stopds_fDirectReturn,
- (W_) stopds_fDirectReturn,
- (W_) stopds_fDirectReturn,
- (W_) stopds_fDirectReturn,
- (W_) stopds_fDirectReturn
-};
-
-\end{pseudocode}
-
-and a C stub
-
-\begin{pseudocode}
-extern StgInt __f_param_1;
-extern StgInt __f_param_2;
-extern StgInt __f_param_3;
-extern StgInt __f_res;
-
-extern void ds_f();
-extern void miniInterpret(StgAddr);
-
-int
-f(a1,a2,a3)
-int a1;
-int a2;
-int a3;
-{
- __f_param_1=a1;
- __f_param_2=a2;
- __f_param_3=a3;
- miniInterpret((StgAddr)ds_f);
- return (__f_res);
-}
-
-\end{pseudocode}
+showFFIType :: Type -> SDoc
+showFFIType t = text (getOccString (getName tc))
+ where
+ tc = case splitTyConApp_maybe t of
+ Just (tc,_) -> tc
+ Nothing -> pprPanic "showFFIType" (ppr t)
+\end{code}
projects / ghc-hetmet.git / blobdiff