module DsForeign ( dsForeigns ) where
#include "HsVersions.h"
+import TcRnMonad -- temp
import CoreSyn
import DsCCall ( dsCCall, mkFCall, boxResult, unboxArg, resultWrapper )
import DsMonad
-import HsSyn ( ForeignDecl(..), ForeignExport(..),
+import HsSyn ( ForeignDecl(..), ForeignExport(..), LForeignDecl,
ForeignImport(..), CImportSpec(..) )
-import TcHsSyn ( TypecheckedForeignDecl )
import CoreUtils ( exprType, mkInlineMe )
import Id ( Id, idType, idName, mkSysLocal, setInlinePragma )
import Literal ( Literal(..) )
-import Module ( Module, moduleUserString )
+import Module ( moduleString )
import Name ( getOccString, NamedThing(..) )
import OccName ( encodeFS )
-import Type ( repType, eqType )
+import Type ( repType, eqType, typePrimRep )
import TcType ( Type, mkFunTys, mkForAllTys, mkTyConApp,
mkFunTy, tcSplitTyConApp_maybe,
tcSplitForAllTys, tcSplitFunTys, tcTyConAppArgs,
)
+import BasicTypes ( Boxity(..) )
+import HscTypes ( ForeignStubs(..) )
import ForeignCall ( ForeignCall(..), CCallSpec(..),
Safety(..), playSafe,
CExportSpec(..),
ccallConvAttribute
)
import CStrings ( CLabelString )
-import TysWiredIn ( unitTy, stablePtrTyCon )
-import TysPrim ( addrPrimTy )
-import PrelNames ( hasKey, ioTyConKey, newStablePtrName, bindIOName )
+import TysWiredIn ( unitTy, tupleTyCon )
+import TysPrim ( addrPrimTy, mkStablePtrPrimTy, alphaTy )
+import PrimRep ( getPrimRepSizeInBytes )
+import PrelNames ( hasKey, ioTyConKey, stablePtrTyConName, newStablePtrName, bindIOName,
+ checkDotnetResName )
import BasicTypes ( Activation( NeverActive ) )
-import ErrUtils ( addShortWarnLocLine )
+import SrcLoc ( Located(..), unLoc )
import Outputable
import Maybe ( fromJust )
import FastString
type Binding = (Id, CoreExpr) -- No rec/nonrec structure;
-- the occurrence analyser will sort it all out
-dsForeigns :: Module
- -> [TypecheckedForeignDecl]
- -> DsM ( [Id] -- Foreign-exported binders;
- -- we have to generate code to register these
- , [Binding]
- , SDoc -- Header file prototypes for
- -- "foreign exported" functions.
- , SDoc -- C stubs to use when calling
- -- "foreign exported" functions.
- , [FastString] -- headers that need to be included
- -- into C code generated for this module
- )
-dsForeigns mod_name fos
- = foldlDs combine ([], [], empty, empty, []) fos
+dsForeigns :: [LForeignDecl Id]
+ -> DsM (ForeignStubs, [Binding])
+dsForeigns []
+ = returnDs (NoStubs, [])
+dsForeigns fos
+ = foldlDs combine (ForeignStubs empty empty [] [], []) fos
where
- combine (acc_feb, acc_f, acc_h, acc_c, acc_header)
- (ForeignImport id _ spec depr loc)
- = dsFImport mod_name id spec `thenDs` \(bs, h, c, hd) ->
+ combine (ForeignStubs acc_h acc_c acc_hdrs acc_feb, acc_f)
+ (L loc (ForeignImport id _ spec depr))
+ = traceIf (text "fi start" <+> ppr id) `thenDs` \ _ ->
+ dsFImport (unLoc id) spec `thenDs` \ (bs, h, c, mbhd) ->
+ warnDepr depr loc `thenDs` \ _ ->
+ traceIf (text "fi end" <+> ppr id) `thenDs` \ _ ->
+ returnDs (ForeignStubs (h $$ acc_h)
+ (c $$ acc_c)
+ (addH mbhd acc_hdrs)
+ acc_feb,
+ bs ++ acc_f)
+
+ combine (ForeignStubs acc_h acc_c acc_hdrs acc_feb, acc_f)
+ (L loc (ForeignExport (L _ id) _ (CExport (CExportStatic ext_nm cconv)) depr))
+ = dsFExport id (idType id)
+ ext_nm cconv False `thenDs` \(h, c, _) ->
warnDepr depr loc `thenDs` \_ ->
- returnDs (acc_feb, bs ++ acc_f, h $$ acc_h, c $$ acc_c, hd ++ acc_header)
+ returnDs (ForeignStubs (h $$ acc_h) (c $$ acc_c) acc_hdrs (id:acc_feb),
+ acc_f)
- combine (acc_feb, acc_f, acc_h, acc_c, acc_header)
- (ForeignExport id _ (CExport (CExportStatic ext_nm cconv)) depr loc)
- = dsFExport mod_name id (idType id)
- ext_nm cconv False `thenDs` \(h, c) ->
- warnDepr depr loc `thenDs` \_ ->
- returnDs (acc_feb, acc_f, h $$ acc_h, c $$ acc_c, acc_header)
+ addH Nothing ls = ls
+ addH (Just e) ls
+ | e `elem` ls = ls
+ | otherwise = e:ls
warnDepr False _ = returnDs ()
- warnDepr True loc = dsWarn (addShortWarnLocLine loc msg)
- where
- msg = ptext SLIT("foreign declaration uses deprecated non-standard syntax")
+ warnDepr True loc = dsWarn (loc, msg)
+ where
+ msg = ptext SLIT("foreign declaration uses deprecated non-standard syntax")
\end{code}
because it exposes the boxing to the call site.
\begin{code}
-dsFImport :: Module
- -> Id
+dsFImport :: Id
-> ForeignImport
- -> DsM ([Binding], SDoc, SDoc, [FastString])
-dsFImport modName id (CImport cconv safety header lib spec)
- = dsCImport modName id spec cconv safety `thenDs` \(ids, h, c) ->
- returnDs (ids, h, c, if nullFastString header then [] else [header])
+ -> DsM ([Binding], SDoc, SDoc, Maybe FastString)
+dsFImport id (CImport cconv safety header lib spec)
+ = dsCImport id spec cconv safety no_hdrs `thenDs` \(ids, h, c) ->
+ returnDs (ids, h, c, if no_hdrs then Nothing else Just header)
+ where
+ no_hdrs = nullFastString header
+
-- FIXME: the `lib' field is needed for .NET ILX generation when invoking
-- routines that are external to the .NET runtime, but GHC doesn't
-- support such calls yet; if `nullFastString lib', the value was not given
-dsFImport modName id (DNImport spec)
- = dsFCall modName id (DNCall spec) `thenDs` \(ids, h, c) ->
- returnDs (ids, h, c, [])
+dsFImport id (DNImport spec)
+ = dsFCall id (DNCall spec) True {- No headers -} `thenDs` \(ids, h, c) ->
+ returnDs (ids, h, c, Nothing)
-dsCImport :: Module
- -> Id
+dsCImport :: Id
-> CImportSpec
-> CCallConv
-> Safety
+ -> Bool -- True <=> no headers in the f.i decl
-> DsM ([Binding], SDoc, SDoc)
-dsCImport modName id (CLabel cid) _ _
- = ASSERT(fromJust resTy `eqType` addrPrimTy) -- typechecker ensures this
- returnDs ([(id, rhs)], empty, empty)
- where
- (resTy, foRhs) = resultWrapper (idType id)
- rhs = foRhs (mkLit (MachLabel cid))
-dsCImport modName id (CFunction target) cconv safety
- = dsFCall modName id (CCall (CCallSpec target cconv safety))
-dsCImport modName id CWrapper cconv _
- = dsFExportDynamic modName id cconv
+dsCImport id (CLabel cid) _ _ no_hdrs
+ = resultWrapper (idType id) `thenDs` \ (resTy, foRhs) ->
+ ASSERT(fromJust resTy `eqType` addrPrimTy) -- typechecker ensures this
+ let rhs = foRhs (mkLit (MachLabel cid Nothing)) in
+ returnDs ([(setImpInline no_hdrs id, rhs)], empty, empty)
+dsCImport id (CFunction target) cconv safety no_hdrs
+ = dsFCall id (CCall (CCallSpec target cconv safety)) no_hdrs
+dsCImport id CWrapper cconv _ _
+ = dsFExportDynamic id cconv
+
+setImpInline :: Bool -- True <=> No #include headers
+ -- in the foreign import declaration
+ -> Id -> Id
+-- If there is a #include header in the foreign import
+-- we make the worker non-inlinable, because we currently
+-- don't keep the #include stuff in the CCallId, and hence
+-- it won't be visible in the importing module, which can be
+-- fatal.
+-- (The #include stuff is just collected from the foreign import
+-- decls in a module.)
+-- If you want to do cross-module inlining of the c-calls themselves,
+-- put the #include stuff in the package spec, not the foreign
+-- import decl.
+setImpInline True id = id
+setImpInline False id = id `setInlinePragma` NeverActive
\end{code}
%************************************************************************
\begin{code}
-dsFCall mod_Name fn_id fcall
+dsFCall fn_id fcall no_hdrs
= let
ty = idType fn_id
(tvs, fun_ty) = tcSplitForAllTys ty
-- ForeignObj#s live across a 'safe' foreign import).
maybe_arg_ids | unsafe_call fcall = work_arg_ids
| otherwise = []
+
+ forDotnet =
+ case fcall of
+ DNCall{} -> True
+ _ -> False
+
+ topConDs
+ | forDotnet =
+ dsLookupGlobalId checkDotnetResName `thenDs` \ check_id ->
+ return (Just check_id)
+ | otherwise = return Nothing
+
+ augmentResultDs
+ | forDotnet =
+ newSysLocalDs addrPrimTy `thenDs` \ err_res ->
+ returnDs (\ (mb_res_ty, resWrap) ->
+ case mb_res_ty of
+ Nothing -> (Just (mkTyConApp (tupleTyCon Unboxed 1)
+ [ addrPrimTy ]),
+ resWrap)
+ Just x -> (Just (mkTyConApp (tupleTyCon Unboxed 2)
+ [ x, addrPrimTy ]),
+ resWrap))
+ | otherwise = returnDs id
in
- boxResult maybe_arg_ids io_res_ty `thenDs` \ (ccall_result_ty, res_wrapper) ->
+ augmentResultDs `thenDs` \ augment ->
+ topConDs `thenDs` \ topCon ->
+ boxResult maybe_arg_ids augment topCon io_res_ty `thenDs` \ (ccall_result_ty, res_wrapper) ->
- getUniqueDs `thenDs` \ ccall_uniq ->
- getUniqueDs `thenDs` \ work_uniq ->
+ newUnique `thenDs` \ ccall_uniq ->
+ newUnique `thenDs` \ work_uniq ->
let
-- Build the worker
worker_ty = mkForAllTys tvs (mkFunTys (map idType work_arg_ids) 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 (encodeFS FSLIT("$wccall")) work_uniq worker_ty
+ work_id = setImpInline no_hdrs $ -- See comments with setImpInline
+ mkSysLocal (encodeFS FSLIT("$wccall")) work_uniq worker_ty
-- Build the wrapper
work_app = mkApps (mkVarApps (Var work_id) tvs) val_args
the user-written Haskell function `@M.foo@'.
\begin{code}
-dsFExport :: Module
- -> Id -- Either the exported Id,
+dsFExport :: 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
-- the first argument's stable pointer
-> DsM ( SDoc -- contents of Module_stub.h
, SDoc -- contents of Module_stub.c
+ , [Type] -- arguments expected by stub function.
)
-dsFExport mod_name fn_id ty ext_name cconv isDyn
+dsFExport fn_id ty ext_name cconv isDyn
=
let
- (tvs,sans_foralls) = tcSplitForAllTys 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!
)
`thenDs` \ (res_ty, -- t
is_IO_res_ty) -> -- Bool
- getModuleDs
- `thenDs` \ mod ->
- let
- (h_stub, c_stub)
- = mkFExportCBits (moduleUserString mod) ext_name
- (if isDyn then Nothing else Just fn_id)
- fe_arg_tys res_ty is_IO_res_ty cconv
- in
- returnDs (h_stub, c_stub)
+ returnDs $
+ mkFExportCBits ext_name
+ (if isDyn then Nothing else Just fn_id)
+ fe_arg_tys res_ty is_IO_res_ty cconv
\end{code}
@foreign export dynamic@ lets you dress up Haskell IO actions
\end{verbatim}
\begin{code}
-dsFExportDynamic :: Module
- -> Id
+dsFExportDynamic :: Id
-> CCallConv
-> DsM ([Binding], SDoc, SDoc)
-dsFExportDynamic mod_name id cconv
- = newSysLocalDs ty `thenDs` \ fe_id ->
+dsFExportDynamic id cconv
+ = newSysLocalDs ty `thenDs` \ fe_id ->
+ getModuleDs `thenDs` \ mod_name ->
let
-- hack: need to get at the name of the C stub we're about to generate.
- fe_nm = mkFastString (moduleUserString mod_name ++ "_" ++ toCName fe_id)
+ fe_nm = mkFastString (moduleString mod_name ++ "_" ++ toCName fe_id)
in
- dsFExport mod_name id export_ty fe_nm cconv True `thenDs` \ (h_code, c_code) ->
- newSysLocalDs arg_ty `thenDs` \ cback ->
- dsLookupGlobalValue newStablePtrName `thenDs` \ newStablePtrId ->
+ newSysLocalDs arg_ty `thenDs` \ cback ->
+ dsLookupGlobalId newStablePtrName `thenDs` \ newStablePtrId ->
+ dsLookupTyCon stablePtrTyConName `thenDs` \ stable_ptr_tycon ->
let
- mk_stbl_ptr_app = mkApps (Var newStablePtrId) [ Type arg_ty, Var cback ]
+ mk_stbl_ptr_app = mkApps (Var newStablePtrId) [ Type arg_ty, Var cback ]
+ stable_ptr_ty = mkTyConApp stable_ptr_tycon [arg_ty]
+ export_ty = mkFunTy stable_ptr_ty arg_ty
in
- dsLookupGlobalValue bindIOName `thenDs` \ bindIOId ->
- newSysLocalDs (mkTyConApp stablePtrTyCon [arg_ty]) `thenDs` \ stbl_value ->
+ dsLookupGlobalId bindIOName `thenDs` \ bindIOId ->
+ newSysLocalDs stable_ptr_ty `thenDs` \ stbl_value ->
+ dsFExport id export_ty fe_nm cconv True `thenDs` \ (h_code, c_code, stub_args) ->
let
- stbl_app cont ret_ty
- = mkApps (Var bindIOId)
- [ Type (mkTyConApp stablePtrTyCon [arg_ty])
- , Type ret_ty
- , mk_stbl_ptr_app
- , cont
- ]
-
+ stbl_app cont ret_ty = mkApps (Var bindIOId)
+ [ Type stable_ptr_ty
+ , Type ret_ty
+ , mk_stbl_ptr_app
+ , cont
+ ]
{-
The arguments to the external function which will
create a little bit of (template) code on the fly
-}
adj_args = [ mkIntLitInt (ccallConvToInt cconv)
, Var stbl_value
- , mkLit (MachLabel fe_nm)
+ , mkLit (MachLabel fe_nm mb_sz_args)
]
-- name of external entry point providing these services.
-- (probably in the RTS.)
- adjustor = FSLIT("createAdjustor")
+ adjustor = FSLIT("createAdjustor")
+
+ sz_args = sum (map (getPrimRepSizeInBytes . typePrimRep) stub_args)
+ mb_sz_args = case cconv of
+ StdCallConv -> Just sz_args
+ _ -> Nothing
in
- dsCCall adjustor adj_args PlayRisky False io_res_ty `thenDs` \ ccall_adj ->
+ dsCCall adjustor adj_args PlayRisky 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] $
([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)))
using the hugs/ghc rts invocation API.
\begin{code}
-mkFExportCBits :: String
- -> FastString
+mkFExportCBits :: FastString
-> Maybe Id -- Just==static, Nothing==dynamic
-> [Type]
-> Type
-> Bool -- True <=> returns an IO type
-> CCallConv
- -> (SDoc, SDoc)
-mkFExportCBits mod_nm c_nm maybe_target arg_htys res_hty is_IO_res_ty cc
- = (header_bits, c_bits)
+ -> (SDoc, SDoc, [Type])
+mkFExportCBits c_nm maybe_target arg_htys res_hty is_IO_res_ty cc
+ = (header_bits, c_bits, all_arg_tys)
where
-- Create up types and names for the real args
arg_cnames, arg_ctys :: [SDoc]
-- and also for auxiliary ones; the stable ptr in the dynamic case, and
-- a slot for the dummy return address in the dynamic + ccall case
- extra_cnames_and_ctys
+ extra_cnames_and_tys
= case maybe_target of
- Nothing -> [(text "the_stableptr", text "StgStablePtr")]
+ Nothing -> [((text "the_stableptr", text "StgStablePtr"), mkStablePtrPrimTy alphaTy)]
other -> []
++
case (maybe_target, cc) of
- (Nothing, CCallConv) -> [(text "original_return_addr", text "void*")]
+ (Nothing, CCallConv) -> [((text "original_return_addr", text "void*"), addrPrimTy)]
other -> []
all_cnames_and_ctys :: [(SDoc, SDoc)]
all_cnames_and_ctys
- = extra_cnames_and_ctys ++ zip arg_cnames arg_ctys
+ = map fst extra_cnames_and_tys ++ zip arg_cnames arg_ctys
+
+ all_arg_tys
+ = map snd extra_cnames_and_tys ++ arg_htys
-- stuff to do with the return type of the C function
res_hty_is_unit = res_hty `eqType` unitTy -- Look through any newtypes
-- various other bits for inside the fn
declareResult = text "HaskellObj ret;"
+ declareCResult | res_hty_is_unit = empty
+ | otherwise = cResType <+> text "cret;"
- return_what | res_hty_is_unit = empty
- | otherwise = parens (unpackHObj res_hty <> parens (text "ret"))
+ assignCResult | res_hty_is_unit = empty
+ | otherwise =
+ text "cret=" <> unpackHObj res_hty <> parens (text "ret") <> semi
-- an extern decl for the fn being called
extern_decl
[ lbrace
, text "SchedulerStatus rc;"
, declareResult
+ , declareCResult
+ , text "rts_lock();"
-- create the application + perform it.
- , text (if is_IO_res_ty then "rc=rts_evalIO" else "rc=rts_eval")
- <> parens (expr_to_run <+> comma <> text "&ret")
- <> semi
+ , text "rc=rts_evalIO" <> parens (
+ text "rts_apply" <> parens (
+ text "(HaskellObj)"
+ <> text (if is_IO_res_ty
+ then "runIO_closure"
+ else "runNonIO_closure")
+ <> comma
+ <> expr_to_run
+ ) <+> comma
+ <> text "&ret"
+ ) <> semi
, text "rts_checkSchedStatus" <> parens (doubleQuotes (ftext c_nm)
<> comma <> text "rc") <> semi
- , text "return" <> return_what <> semi
+ , assignCResult
+ , text "rts_unlock();"
+ , if res_hty_is_unit then empty
+ else text "return cret;"
, rbrace
]