TcForeign.lhs 12 KB
Newer Older
sof's avatar
sof committed
1
%
2
% (c) The University of Glasgow 2006
sof's avatar
sof committed
3 4 5 6 7 8 9 10 11 12 13 14
% (c) The AQUA Project, Glasgow University, 1998
%
\section[TcForeign]{Typechecking \tr{foreign} declarations}

A foreign declaration is used to either give an externally
implemented function a Haskell type (and calling interface) or
give a Haskell function an external calling interface. Either way,
the range of argument and result types these functions can accommodate
is restricted to what the outside world understands (read C), and this
module checks to see if a foreign declaration has got a legal type.

\begin{code}
15
{-# OPTIONS -w #-}
16 17 18
-- 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
Ian Lynagh's avatar
Ian Lynagh committed
19
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
20 21
-- for details

sof's avatar
sof committed
22 23 24 25 26 27
module TcForeign 
	( 
	  tcForeignImports
        , tcForeignExports
	) where

28 29
#include "HsVersions.h"

30
import HsSyn
sof's avatar
sof committed
31

32
import TcRnMonad
33 34
import TcHsType
import TcExpr
sof's avatar
sof committed
35

36 37 38
import ForeignCall
import ErrUtils
import Id
39
#if alpha_TARGET_ARCH
40 41 42
import Type
import SMRep
import MachOp
43
#endif
44
import Name
45
import OccName
46 47
import TcType
import DynFlags
sof's avatar
sof committed
48
import Outputable
49 50
import SrcLoc
import Bag
51
import Unique
52
import FastString
sof's avatar
sof committed
53 54
\end{code}

55 56
\begin{code}
-- Defines a binding
57
isForeignImport :: LForeignDecl name -> Bool
Simon Marlow's avatar
Simon Marlow committed
58
isForeignImport (L _ (ForeignImport _ _ _)) = True
59
isForeignImport _			      = False
60 61

-- Exports a binding
62
isForeignExport :: LForeignDecl name -> Bool
Simon Marlow's avatar
Simon Marlow committed
63
isForeignExport (L _ (ForeignExport _ _ _)) = True
64
isForeignExport _	  	              = False
65 66 67 68 69 70 71 72
\end{code}

%************************************************************************
%*									*
\subsection{Imports}
%*									*
%************************************************************************

sof's avatar
sof committed
73
\begin{code}
74
tcForeignImports :: [LForeignDecl Name] -> TcM ([Id], [LForeignDecl Id])
75
tcForeignImports decls
76
  = mapAndUnzipM (wrapLocSndM tcFImport) (filter isForeignImport decls)
sof's avatar
sof committed
77

78
tcFImport :: ForeignDecl Name -> TcM (Id, ForeignDecl Id)
Simon Marlow's avatar
Simon Marlow committed
79
tcFImport fo@(ForeignImport (L loc nm) hs_ty imp_decl)
80 81
 = addErrCtxt (foreignDeclCtxt fo)  $ do
   sig_ty <- tcHsSigType (ForSigCtxt nm) hs_ty
82 83 84
   let 
      -- drop the foralls before inspecting the structure
      -- of the foreign type.
85 86
	(_, t_ty)	  = tcSplitForAllTys sig_ty
	(arg_tys, res_ty) = tcSplitFunTys t_ty
87 88 89 90
	id		  = mkLocalId nm sig_ty
 		-- Use a LocalId to obey the invariant that locally-defined 
		-- things are LocalIds.  However, it does not need zonking,
		-- (so TcHsSyn.zonkForeignExports ignores it).
91 92
   
   imp_decl' <- tcCheckFIType sig_ty arg_tys res_ty imp_decl
93 94
   -- can't use sig_ty here because it :: Type and we need HsType Id
   -- hence the undefined
95
   return (id, ForeignImport (L loc id) undefined imp_decl')
96 97 98 99 100
\end{code}


------------ Checking types for foreign import ----------------------
\begin{code}
101 102 103 104 105 106 107
tcCheckFIType _ arg_tys res_ty (DNImport spec) = do
    checkCg checkDotnet
    dflags <- getDOpts
    checkForeignArgs (isFFIDotnetTy dflags) arg_tys
    checkForeignRes True{-non IO ok-} (isFFIDotnetTy dflags) res_ty
    let (DNCallSpec isStatic kind _ _ _ _) = spec
    case kind of
sof's avatar
sof committed
108 109 110 111 112
       DNMethod | not isStatic ->
         case arg_tys of
	   [] -> addErrTc illegalDNMethodSig
	   _  
	    | not (isFFIDotnetObjTy (last arg_tys)) -> addErrTc illegalDNMethodSig
113 114 115
	    | otherwise -> return ()
       _ -> return ()
    return (DNImport (withDNTypes spec (map toDNType arg_tys) (toDNType res_ty)))
sof's avatar
sof committed
116

117 118 119
tcCheckFIType sig_ty arg_tys res_ty idecl@(CImport _ _ _ _ (CLabel _)) = do
    checkCg checkCOrAsm
    check (isFFILabelTy sig_ty) (illegalForeignTyErr empty sig_ty)
sof's avatar
sof committed
120
    return idecl
121

122 123
tcCheckFIType sig_ty arg_tys res_ty idecl@(CImport cconv _ _ _ CWrapper) = do
   	-- Foreign wrapper (former f.e.d.)
chak's avatar
chak committed
124 125 126 127
   	-- 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.
128 129 130 131 132 133 134 135 136 137
    checkCg checkCOrAsmOrInterp
    checkCConv cconv
    case arg_tys of
        [arg1_ty] -> do checkForeignArgs isFFIExternalTy arg1_tys
                        checkForeignRes nonIOok  isFFIExportResultTy res1_ty
                        checkForeignRes mustBeIO isFFIDynResultTy    res_ty
                        checkFEDArgs arg1_tys
                  where
                     (arg1_tys, res1_ty) = tcSplitFunTys arg1_ty
        other -> addErrTc (illegalForeignTyErr empty sig_ty)
sof's avatar
sof committed
138
    return idecl
139

140
tcCheckFIType sig_ty arg_tys res_ty idecl@(CImport cconv safety _ _ (CFunction target))
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
  | isDynamicTarget target = do -- Foreign import dynamic
      checkCg checkCOrAsmOrInterp
      checkCConv cconv
      case arg_tys of           -- The first arg must be Ptr, FunPtr, or Addr
        []                -> do
          check False (illegalForeignTyErr empty sig_ty)
          return idecl
        (arg1_ty:arg_tys) -> do
          dflags <- getDOpts
          check (isFFIDynArgumentTy arg1_ty)
                (illegalForeignTyErr argument arg1_ty)
          checkForeignArgs (isFFIArgumentTy dflags safety) arg_tys
          checkForeignRes nonIOok (isFFIImportResultTy dflags) res_ty
          return idecl
  | otherwise = do              -- Normal foreign import
      checkCg (checkCOrAsmOrDotNetOrInterp)
      checkCConv cconv
      checkCTarget target
      dflags <- getDOpts
      checkForeignArgs (isFFIArgumentTy dflags safety) arg_tys
      checkForeignRes nonIOok (isFFIImportResultTy dflags) res_ty
      return idecl
163 164 165

-- This makes a convenient place to check
-- that the C identifier is valid for C
166 167
checkCTarget (StaticTarget str) = do
    checkCg checkCOrAsmOrDotNetOrInterp
168
    check (isCLabelString str) (badCName str)
169
\end{code}
170

171 172
On an Alpha, with foreign export dynamic, due to a giant hack when
building adjustor thunks, we only allow 4 integer arguments with
ken's avatar
ken committed
173 174 175
foreign export dynamic (i.e., 32 bytes of arguments after padding each
argument to a quadword, excluding floating-point arguments).

176 177 178 179
The check is needed for both via-C and native-code routes

\begin{code}
#include "nativeGen/NCG.h"
180
#if alpha_TARGET_ARCH
ken's avatar
ken committed
181
checkFEDArgs arg_tys
182
  = check (integral_args <= 32) err
ken's avatar
ken committed
183
  where
184 185 186
    integral_args = sum [ (machRepByteWidth . argMachRep . primRepToCgRep) prim_rep
			| prim_rep <- map typePrimRep arg_tys,
			  primRepHint prim_rep /= FloatHint ]
Ian Lynagh's avatar
Ian Lynagh committed
187
    err = ptext (sLit "On Alpha, I can only handle 32 bytes of non-floating-point arguments to foreign export dynamic")
188
#else
189
checkFEDArgs arg_tys = return ()
190 191
#endif
\end{code}
192 193 194 195 196 197 198 199 200


%************************************************************************
%*									*
\subsection{Exports}
%*									*
%************************************************************************

\begin{code}
201 202
tcForeignExports :: [LForeignDecl Name] 
    		 -> TcM (LHsBinds TcId, [LForeignDecl TcId])
203
tcForeignExports decls
204
  = foldlM combine (emptyLHsBinds, []) (filter isForeignExport decls)
sof's avatar
sof committed
205
  where
206 207 208
   combine (binds, fs) fe = do
       (b, f) <- wrapLocSndM tcFExport fe
       return (b `consBag` binds, f:fs)
sof's avatar
sof committed
209

210
tcFExport :: ForeignDecl Name -> TcM (LHsBind Id, ForeignDecl Id)
Simon Marlow's avatar
Simon Marlow committed
211
tcFExport fo@(ForeignExport (L loc nm) hs_ty spec) =
212
   addErrCtxt (foreignDeclCtxt fo)      $ do
sof's avatar
sof committed
213

214 215
   sig_ty <- tcHsSigType (ForSigCtxt nm) hs_ty
   rhs <- tcPolyExpr (nlHsVar nm) sig_ty
216

217
   tcCheckFEType sig_ty spec
sof's avatar
sof committed
218

chak's avatar
chak committed
219 220
	  -- we're exporting a function, but at a type possibly more
	  -- constrained than its declared/inferred type. Hence the need
sof's avatar
sof committed
221 222
	  -- to create a local binding which will call the exported function
	  -- at a particular type (and, maybe, overloading).
223

224 225
   uniq <- newUnique
   mod <- getModule
226
   let
227 228 229 230 231 232 233 234 235 236 237
          -- We need to give a name to the new top-level binding that
          -- is *stable* (i.e. the compiler won't change it later),
          -- because this name will be referred to by the C code stub.
          -- Furthermore, the name must be unique (see #1533).  If the
          -- same function is foreign-exported multiple times, the
          -- top-level bindings generated must not have the same name.
          -- Hence we create an External name (doesn't change), and we
          -- append a Unique to the string right here.
        uniq_str = showSDoc (pprUnique uniq)
        occ = mkVarOcc (occNameString (getOccName nm) ++ '_' : uniq_str)
        gnm  = mkExternalName uniq mod (mkForeignExportOcc occ) loc
238
	id   = mkExportedLocalId gnm sig_ty
239
	bind = L loc (VarBind id rhs)
240 241

   return (bind, ForeignExport (L loc id) undefined spec)
242 243 244
\end{code}

------------ Checking argument types for foreign export ----------------------
sof's avatar
sof committed
245

246
\begin{code}
247 248 249
tcCheckFEType sig_ty (CExport (CExportStatic str _)) = do
    check (isCLabelString str) (badCName str)
    checkForeignArgs isFFIExternalTy arg_tys
250 251 252 253
    checkForeignRes nonIOok isFFIExportResultTy res_ty
  where
      -- Drop the foralls before inspecting n
      -- the structure of the foreign type.
254 255
    (_, t_ty) = tcSplitForAllTys sig_ty
    (arg_tys, res_ty) = tcSplitFunTys t_ty
sof's avatar
sof committed
256 257 258
\end{code}


259 260 261 262 263 264 265

%************************************************************************
%*									*
\subsection{Miscellaneous}
%*									*
%************************************************************************

sof's avatar
sof committed
266
\begin{code}
267
------------ Checking argument types for foreign import ----------------------
268
checkForeignArgs :: (Type -> Bool) -> [Type] -> TcM ()
269
checkForeignArgs pred tys
270
  = mapM_ go tys
271
  where
272
    go ty = check (pred ty) (illegalForeignTyErr argument ty)
273 274

------------ Checking result types for foreign calls ----------------------
sof's avatar
sof committed
275
-- Check that the type has the form 
276
--    (IO t) or (t) , and that t satisfies the given predicate.
sof's avatar
sof committed
277
--
278
checkForeignRes :: Bool -> (Type -> Bool) -> Type -> TcM ()
279 280 281 282

nonIOok  = True
mustBeIO = False

283
checkForeignRes non_io_result_ok pred_res_ty ty
284
	-- (IO t) is ok, and so is any newtype wrapping thereof
285
  | Just (io, res_ty, _) <- tcSplitIOType_maybe ty,
286
    pred_res_ty res_ty
287
  = return ()
288 289 290 291
 
  | otherwise
  = check (non_io_result_ok && pred_res_ty ty) 
	  (illegalForeignTyErr result ty)
sof's avatar
sof committed
292 293
\end{code}

294
\begin{code}
sof's avatar
sof committed
295 296 297 298 299 300
#if defined(mingw32_TARGET_OS)
checkDotnet HscC   = Nothing
checkDotnet _      = Just (text "requires C code generation (-fvia-C)")
#else
checkDotnet other  = Just (text "requires .NET support (-filx or win32)")
#endif
301 302 303

checkCOrAsm HscC   = Nothing
checkCOrAsm HscAsm = Nothing
304 305 306 307 308 309 310 311
checkCOrAsm other  
   = Just (text "requires via-C or native code generation (-fvia-C)")

checkCOrAsmOrInterp HscC           = Nothing
checkCOrAsmOrInterp HscAsm         = Nothing
checkCOrAsmOrInterp HscInterpreted = Nothing
checkCOrAsmOrInterp other  
   = Just (text "requires interpreted, C or native code generation")
312

313 314 315 316
checkCOrAsmOrDotNetOrInterp HscC           = Nothing
checkCOrAsmOrDotNetOrInterp HscAsm         = Nothing
checkCOrAsmOrDotNetOrInterp HscInterpreted = Nothing
checkCOrAsmOrDotNetOrInterp other  
317
   = Just (text "requires interpreted, C or native code generation")
318

319 320 321
checkCg check = do
   dflags <- getDOpts
   let target = hscTarget dflags
322
   case target of
323
     HscNothing -> return ()
chak's avatar
chak committed
324
     otherwise  ->
325
       case check target of
326
	 Nothing  -> return ()
chak's avatar
chak committed
327
	 Just err -> addErrTc (text "Illegal foreign declaration:" <+> err)
SamB's avatar
SamB committed
328
\end{code}
329
			   
330 331 332 333 334 335 336 337 338 339 340 341
Calling conventions

\begin{code}
checkCConv :: CCallConv -> TcM ()
checkCConv CCallConv  = return ()
#if i386_TARGET_ARCH
checkCConv StdCallConv = return ()
#else
checkCConv StdCallConv = addErrTc (text "calling convention not supported on this architecture: stdcall")
#endif
\end{code}

sof's avatar
sof committed
342 343 344
Warnings

\begin{code}
345
check :: Bool -> Message -> TcM ()
346
check True _	   = return ()
347
check _    the_err = addErrTc the_err
348

349
illegalForeignTyErr arg_or_res ty
Ian Lynagh's avatar
Ian Lynagh committed
350 351
  = hang (hsep [ptext (sLit "Unacceptable"), arg_or_res, 
                ptext (sLit "type in foreign declaration:")])
352
	 4 (hsep [ppr ty])
sof's avatar
sof committed
353

354 355 356 357 358
-- Used for 'arg_or_res' argument to illegalForeignTyErr
argument = text "argument"
result   = text "result"

badCName :: CLabelString -> Message
359
badCName target 
Ian Lynagh's avatar
Ian Lynagh committed
360
   = sep [quotes (ppr target) <+> ptext (sLit "is not a valid C identifier")]
361 362

foreignDeclCtxt fo
Ian Lynagh's avatar
Ian Lynagh committed
363
  = hang (ptext (sLit "When checking declaration:"))
364
         4 (ppr fo)
sof's avatar
sof committed
365 366

illegalDNMethodSig 
Ian Lynagh's avatar
Ian Lynagh committed
367
  = ptext (sLit "'This pointer' expected as last argument")
sof's avatar
sof committed
368

sof's avatar
sof committed
369
\end{code}
370