[project @ 2002-05-23 15:37:32 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcForeign.lhs
index 950d8ad..b2ddda6 100644 (file)
@@ -20,27 +20,33 @@ module TcForeign
 #include "HsVersions.h"
 
 import HsSyn           ( HsDecl(..), ForeignDecl(..), HsExpr(..),
-                         MonoBinds(..), FoImport(..), FoExport(..)
+                         MonoBinds(..), ForeignImport(..), ForeignExport(..),
+                         CImportSpec(..)
                        )
 import RnHsSyn         ( RenamedHsDecl, RenamedForeignDecl )
 
 import TcMonad
-import TcEnv           ( newLocalId )
 import TcMonoType      ( tcHsSigType, UserTypeCtxt(..) )
 import TcHsSyn         ( TcMonoBinds, TypecheckedForeignDecl, TcForeignExportDecl )
-import TcExpr          ( tcPolyExpr )                  
+import TcExpr          ( tcExpr )                      
 import Inst            ( emptyLIE, LIE, plusLIE )
 
 import ErrUtils                ( Message )
-import Id              ( Id, mkLocalId )
-import Name            ( nameOccName )
-import TysWiredIn      ( isFFIArgumentTy, isFFIImportResultTy, 
-                         isFFIExportResultTy,
-                         isFFIExternalTy, isFFIDynArgumentTy, isFFIDynResultTy,
-                         isFFILabelTy
+import Id              ( Id, mkLocalId, setIdLocalExported )
+import PrimRep         ( getPrimRepSize, isFloatingRep )
+import Module          ( Module )
+import Type            ( typePrimRep )
+import OccName         ( mkForeignExportOcc )
+import Name            ( NamedThing(..), mkExternalName )
+import TcType          ( Type, tcSplitFunTys, tcSplitTyConApp_maybe,
+                         tcSplitForAllTys, 
+                         isFFIArgumentTy, isFFIImportResultTy, 
+                         isFFIExportResultTy, isFFILabelTy,
+                         isFFIExternalTy, isFFIDynArgumentTy,
+                         isFFIDynResultTy, isForeignPtrTy
                        )
-import TcType          ( Type, tcSplitFunTys, tcSplitTyConApp_maybe, tcSplitForAllTys )
-import ForeignCall     ( CCallSpec(..), CExportSpec(..), CCallTarget(..), isDynamicTarget, isCasmTarget )
+import ForeignCall     ( CExportSpec(..), CCallTarget(..),
+                         isDynamicTarget, isCasmTarget ) 
 import CStrings                ( CLabelString, isCLabelString )
 import PrelNames       ( hasKey, ioTyConKey )
 import CmdLineOpts     ( dopt_HscLang, HscLang(..) )
@@ -51,13 +57,13 @@ import Outputable
 \begin{code}
 -- Defines a binding
 isForeignImport :: ForeignDecl name -> Bool
-isForeignImport (ForeignImport _ _ _ _) = True
-isForeignImport _                      = False
+isForeignImport (ForeignImport _ _ _ _ _) = True
+isForeignImport _                        = False
 
 -- Exports a binding
 isForeignExport :: ForeignDecl name -> Bool
-isForeignExport (ForeignExport _ _ _ _) = True
-isForeignExport _                      = False
+isForeignExport (ForeignExport _ _ _ _ _) = True
+isForeignExport _                        = False
 \end{code}
 
 %************************************************************************
@@ -69,10 +75,11 @@ isForeignExport _                   = False
 \begin{code}
 tcForeignImports :: [RenamedHsDecl] -> TcM ([Id], [TypecheckedForeignDecl])
 tcForeignImports decls = 
-   mapAndUnzipTc tcFImport [ foreign_decl | ForD foreign_decl <- decls, isForeignImport foreign_decl]
+  mapAndUnzipTc tcFImport 
+    [ foreign_decl | ForD foreign_decl <- decls, isForeignImport foreign_decl]
 
 tcFImport :: RenamedForeignDecl -> TcM (Id, TypecheckedForeignDecl)
-tcFImport fo@(ForeignImport nm hs_ty imp_decl src_loc)
+tcFImport fo@(ForeignImport nm hs_ty imp_decl isDeprec src_loc)
  = tcAddSrcLoc src_loc                 $
    tcAddErrCtxt (foreignDeclCtxt fo)   $
    tcHsSigType (ForSigCtxt nm) hs_ty   `thenTc`        \ sig_ty ->
@@ -84,7 +91,9 @@ tcFImport fo@(ForeignImport nm hs_ty imp_decl src_loc)
        id                = mkLocalId nm sig_ty
    in
    tcCheckFIType sig_ty arg_tys res_ty imp_decl                `thenNF_Tc_` 
-   returnTc (id, ForeignImport id undefined imp_decl src_loc)
+   -- can't use sig_ty here because it :: Type and we need HsType Id
+   -- hence the undefined
+   returnTc (id, ForeignImport id undefined imp_decl isDeprec src_loc)
 \end{code}
 
 
@@ -93,27 +102,30 @@ tcFImport fo@(ForeignImport nm hs_ty imp_decl src_loc)
 tcCheckFIType _ _ _ (DNImport _)
   = checkCg checkDotNet
 
-tcCheckFIType sig_ty arg_tys res_ty (LblImport _)
+tcCheckFIType sig_ty arg_tys res_ty (CImport _ _ _ _ (CLabel _))
   = checkCg checkCOrAsm                `thenNF_Tc_`
     check (isFFILabelTy sig_ty) (illegalForeignTyErr empty sig_ty)
 
-tcCheckFIType sig_ty arg_tys res_ty (CDynImport _)
-  =    -- Foreign export dynamic
-       -- The first (and only!) arg has got to be a function type
-       -- and it must return IO t; result type is IO Addr
-    checkCg checkCOrAsm                `thenNF_Tc_`
+tcCheckFIType sig_ty arg_tys res_ty (CImport _ _ _ _ CWrapper)
+  =    -- Foreign wrapper (former f.e.d.)
+       -- The type must be of the form ft -> IO (FunPtr ft), where ft is a
+       -- valid foreign type.  For legacy reasons ft -> IO (Ptr ft) as well
+       -- as ft -> IO Addr is accepted, too.  The use of the latter two forms
+       -- is DEPRECATED, though.
+    checkCg checkCOrAsmOrInterp                `thenNF_Tc_`
     case arg_tys of
        [arg1_ty] -> checkForeignArgs isFFIExternalTy arg1_tys                  `thenNF_Tc_`
                     checkForeignRes nonIOok  isFFIExportResultTy res1_ty       `thenNF_Tc_`
-                    checkForeignRes mustBeIO isFFIDynResultTy    res_ty
+                    checkForeignRes mustBeIO isFFIDynResultTy    res_ty        `thenNF_Tc_`
+                    checkFEDArgs arg1_tys
                  where
                     (arg1_tys, res1_ty) = tcSplitFunTys arg1_ty
         other -> addErrTc (illegalForeignTyErr empty sig_ty)
 
-tcCheckFIType sig_ty arg_tys res_ty (CImport (CCallSpec target _ safety))
+tcCheckFIType sig_ty arg_tys res_ty (CImport _ safety _ _ (CFunction target))
   | isDynamicTarget target     -- Foreign import dynamic
   = checkCg checkCOrAsmOrInterp                `thenNF_Tc_`
-    case arg_tys of            -- The first arg must be Addr
+    case arg_tys of            -- The first arg must be Ptr, FunPtr, or Addr
       []               -> check False (illegalForeignTyErr empty sig_ty)
       (arg1_ty:arg_tys) -> getDOptsTc                                                  `thenNF_Tc` \ dflags ->
                           check (isFFIDynArgumentTy arg1_ty)
@@ -139,6 +151,41 @@ checkCTarget (CasmTarget _)
   = checkCg checkC
 \end{code}
 
+On a SPARC, with foreign export dynamic, due to a giant hack when building
+adjustor thunks, we only allow 16 bytes of arguments!
+
+So for example, args (Int,Double,Int) would be OK (1+2+1)
+as would (Int,Int,Int,Int) (1+1+1+1) but not (Int,Double,Double) (1+2+2).
+
+On an Alpha, due to a similar hack, we only allow 4 integer arguments with
+foreign export dynamic (i.e., 32 bytes of arguments after padding each
+argument to a quadword, excluding floating-point arguments).
+
+The check is needed for both via-C and native-code routes
+
+\begin{code}
+#include "nativeGen/NCG.h"
+#if sparc_TARGET_ARCH
+checkFEDArgs arg_tys
+  = check (words_of_args <= 4) err
+  where
+    words_of_args = sum (map (getPrimRepSize . typePrimRep) arg_tys)
+    err = ptext SLIT("On SPARC, I can only handle 4 words of arguments to foreign export dynamic")
+#else
+#if alpha_TARGET_ARCH
+checkFEDArgs arg_tys
+  = check (integral_args <= 4) err
+  where
+    integral_args = sum (map getPrimRepSize $
+                         filter (not . isFloatingRep) $
+                         map typePrimRep arg_tys)
+    err = ptext SLIT("On Alpha, I can only handle 4 non-floating-point arguments to foreign export dynamic")
+#else
+checkFEDArgs arg_tys = returnNF_Tc ()
+#endif
+#endif
+\end{code}
+
 
 %************************************************************************
 %*                                                                     *
@@ -147,34 +194,38 @@ checkCTarget (CasmTarget _)
 %************************************************************************
 
 \begin{code}
-tcForeignExports :: [RenamedHsDecl] -> TcM (LIE, TcMonoBinds, [TcForeignExportDecl])
-tcForeignExports decls = 
+tcForeignExports :: Module -> [RenamedHsDecl] 
+                -> TcM (LIE, TcMonoBinds, [TcForeignExportDecl])
+tcForeignExports mod decls = 
    foldlTc combine (emptyLIE, EmptyMonoBinds, [])
-                  [ foreign_decl | ForD foreign_decl <- decls, isForeignExport foreign_decl]
+     [foreign_decl | ForD foreign_decl <- decls, isForeignExport foreign_decl]
   where
    combine (lie, binds, fs) fe = 
-       tcFExport fe `thenTc ` \ (a_lie, b, f) ->
+       tcFExport mod fe `thenTc ` \ (a_lie, b, f) ->
        returnTc (lie `plusLIE` a_lie, b `AndMonoBinds` binds, f:fs)
 
-tcFExport :: RenamedForeignDecl -> TcM (LIE, TcMonoBinds, TcForeignExportDecl)
-tcFExport fo@(ForeignExport nm hs_ty spec src_loc) =
+tcFExport :: Module -> RenamedForeignDecl -> TcM (LIE, TcMonoBinds, TcForeignExportDecl)
+tcFExport mod fo@(ForeignExport nm hs_ty spec isDeprec src_loc) =
    tcAddSrcLoc src_loc                 $
    tcAddErrCtxt (foreignDeclCtxt fo)   $
 
    tcHsSigType (ForSigCtxt nm) hs_ty   `thenTc` \ sig_ty ->
-   tcPolyExpr (HsVar nm) sig_ty                `thenTc` \ (rhs, lie, _, _, _) ->
+   tcExpr (HsVar nm) sig_ty            `thenTc` \ (rhs, lie) ->
 
    tcCheckFEType sig_ty spec           `thenTc_`
 
-         -- we're exporting a function, but at a type possibly more constrained
-         -- than its declared/inferred type. Hence the need
+         -- we're exporting a function, but at a type possibly more
+         -- constrained than its declared/inferred type. Hence the need
          -- to create a local binding which will call the exported function
          -- at a particular type (and, maybe, overloading).
-   newLocalId (nameOccName nm) sig_ty src_loc  `thenNF_Tc` \ id ->
+
+   tcGetUnique                         `thenNF_Tc` \ uniq ->
    let
-       bind  = VarMonoBind id rhs
+        gnm  = mkExternalName uniq mod (mkForeignExportOcc (getOccName nm)) src_loc
+       id   = setIdLocalExported (mkLocalId gnm sig_ty)
+       bind = VarMonoBind id rhs
    in
-   returnTc (lie, bind, ForeignExport id undefined spec src_loc)
+   returnTc (lie, bind, ForeignExport id undefined spec isDeprec src_loc)
 \end{code}
 
 ------------ Checking argument types for foreign export ----------------------
@@ -203,10 +254,14 @@ tcCheckFEType sig_ty (CExport (CExportStatic str _))
 ------------ Checking argument types for foreign import ----------------------
 checkForeignArgs :: (Type -> Bool) -> [Type] -> NF_TcM ()
 checkForeignArgs pred tys
-  = mapNF_Tc go tys    `thenNF_Tc_` returnNF_Tc ()
+  = mapNF_Tc go tys            `thenNF_Tc_` 
+    returnNF_Tc ()
   where
-    go ty = check (pred ty) (illegalForeignTyErr argument ty)
-
+    go ty = check (pred ty) (illegalForeignTyErr argument ty)   `thenNF_Tc_`
+           warnTc (isForeignPtrTy ty) foreignPtrWarn
+    --
+    foreignPtrWarn = 
+      text "`ForeignPtr' as argument type in a foreign import is deprecated"
 
 ------------ Checking result types for foreign calls ----------------------
 -- Check that the type has the form 
@@ -260,9 +315,13 @@ checkCOrAsmOrDotNetOrInterp other
 
 checkCg check
  = getDOptsTc          `thenNF_Tc` \ dflags ->
-   case check (dopt_HscLang dflags) of
-       Nothing  -> returnNF_Tc ()
-       Just err -> addErrTc (text "Illegal foreign declaration:" <+> err)
+   let hscLang = dopt_HscLang dflags in
+   case hscLang of
+     HscNothing -> returnNF_Tc ()
+     otherwise  ->
+       case check hscLang of
+        Nothing  -> returnNF_Tc ()
+        Just err -> addErrTc (text "Illegal foreign declaration:" <+> err)
 \end{code} 
                           
 Warnings
@@ -289,3 +348,4 @@ foreignDeclCtxt fo
   = hang (ptext SLIT("When checking declaration:"))
          4 (ppr fo)
 \end{code}
+