TcForeign.lhs 12.2 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 15 16 17 18 19 20
% (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}
module TcForeign 
	( 
	  tcForeignImports
        , tcForeignExports
	) where

21 22
#include "HsVersions.h"

23
import HsSyn
sof's avatar
sof committed
24

25
import TcRnMonad
26 27
import TcHsType
import TcExpr
28
import TcEnv
sof's avatar
sof committed
29

30 31 32
import ForeignCall
import ErrUtils
import Id
33
#if alpha_TARGET_ARCH
34 35
import Type
import SMRep
36
#endif
37
import Name
38
import OccName
39 40
import TcType
import DynFlags
sof's avatar
sof committed
41
import Outputable
42 43
import SrcLoc
import Bag
44
import FastString
sof's avatar
sof committed
45 46
\end{code}

47 48
\begin{code}
-- Defines a binding
49
isForeignImport :: LForeignDecl name -> Bool
Simon Marlow's avatar
Simon Marlow committed
50
isForeignImport (L _ (ForeignImport _ _ _)) = True
51
isForeignImport _			      = False
52 53

-- Exports a binding
54
isForeignExport :: LForeignDecl name -> Bool
Simon Marlow's avatar
Simon Marlow committed
55
isForeignExport (L _ (ForeignExport _ _ _)) = True
56
isForeignExport _	  	              = False
57 58 59 60 61 62 63 64
\end{code}

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

sof's avatar
sof committed
65
\begin{code}
66
tcForeignImports :: [LForeignDecl Name] -> TcM ([Id], [LForeignDecl Id])
67
tcForeignImports decls
68
  = mapAndUnzipM (wrapLocSndM tcFImport) (filter isForeignImport decls)
sof's avatar
sof committed
69

70
tcFImport :: ForeignDecl Name -> TcM (Id, ForeignDecl Id)
Simon Marlow's avatar
Simon Marlow committed
71
tcFImport fo@(ForeignImport (L loc nm) hs_ty imp_decl)
72 73
 = addErrCtxt (foreignDeclCtxt fo)  $ do
   sig_ty <- tcHsSigType (ForSigCtxt nm) hs_ty
74 75 76
   let 
      -- drop the foralls before inspecting the structure
      -- of the foreign type.
77 78
	(_, t_ty)	  = tcSplitForAllTys sig_ty
	(arg_tys, res_ty) = tcSplitFunTys t_ty
79 80 81 82
	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).
83 84
   
   imp_decl' <- tcCheckFIType sig_ty arg_tys res_ty imp_decl
85 86
   -- can't use sig_ty here because it :: Type and we need HsType Id
   -- hence the undefined
87
   return (id, ForeignImport (L loc id) undefined imp_decl')
Ian Lynagh's avatar
Ian Lynagh committed
88
tcFImport d = pprPanic "tcFImport" (ppr d)
89 90 91 92 93
\end{code}


------------ Checking types for foreign import ----------------------
\begin{code}
Ian Lynagh's avatar
Ian Lynagh committed
94
tcCheckFIType :: Type -> [Type] -> Type -> ForeignImport -> TcM ForeignImport
95 96 97 98
tcCheckFIType _ arg_tys res_ty (DNImport spec) = do
    checkCg checkDotnet
    dflags <- getDOpts
    checkForeignArgs (isFFIDotnetTy dflags) arg_tys
99
    checkForeignRes nonIOok (isFFIDotnetTy dflags) res_ty
100 101
    let (DNCallSpec isStatic kind _ _ _ _) = spec
    case kind of
sof's avatar
sof committed
102 103 104 105 106
       DNMethod | not isStatic ->
         case arg_tys of
	   [] -> addErrTc illegalDNMethodSig
	   _  
	    | not (isFFIDotnetObjTy (last arg_tys)) -> addErrTc illegalDNMethodSig
107 108 109
	    | otherwise -> return ()
       _ -> return ()
    return (DNImport (withDNTypes spec (map toDNType arg_tys) (toDNType res_ty)))
sof's avatar
sof committed
110

Ian Lynagh's avatar
Ian Lynagh committed
111
tcCheckFIType sig_ty _ _ idecl@(CImport _ _ _ _ (CLabel _)) = do
112 113
    checkCg checkCOrAsm
    check (isFFILabelTy sig_ty) (illegalForeignTyErr empty sig_ty)
sof's avatar
sof committed
114
    return idecl
115

116 117
tcCheckFIType sig_ty arg_tys res_ty idecl@(CImport cconv _ _ _ CWrapper) = do
   	-- Foreign wrapper (former f.e.d.)
chak's avatar
chak committed
118 119 120 121
   	-- 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.
122 123 124 125 126 127 128 129 130
    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
Ian Lynagh's avatar
Ian Lynagh committed
131
        _ -> addErrTc (illegalForeignTyErr empty sig_ty)
sof's avatar
sof committed
132
    return idecl
133

134
tcCheckFIType sig_ty arg_tys res_ty idecl@(CImport cconv safety _ _ (CFunction target))
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
  | 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
156
      checkMissingAmpersand dflags arg_tys res_ty
157
      return idecl
158 159 160

-- This makes a convenient place to check
-- that the C identifier is valid for C
Ian Lynagh's avatar
Ian Lynagh committed
161
checkCTarget :: CCallTarget -> TcM ()
162 163
checkCTarget (StaticTarget str) = do
    checkCg checkCOrAsmOrDotNetOrInterp
164
    check (isCLabelString str) (badCName str)
Ian Lynagh's avatar
Ian Lynagh committed
165
checkCTarget DynamicTarget = panic "checkCTarget DynamicTarget"
166 167 168 169 170 171 172 173

checkMissingAmpersand :: DynFlags -> [Type] -> Type -> TcM ()
checkMissingAmpersand dflags arg_tys res_ty
  | null arg_tys && isFunPtrTy res_ty &&
    dopt Opt_WarnDodgyForeignImports dflags
  = addWarn (ptext (sLit "possible missing & in foreign import of FunPtr"))
  | otherwise
  = return ()
174
\end{code}
175

176 177
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
178 179 180
foreign export dynamic (i.e., 32 bytes of arguments after padding each
argument to a quadword, excluding floating-point arguments).

181 182 183 184
The check is needed for both via-C and native-code routes

\begin{code}
#include "nativeGen/NCG.h"
Ian Lynagh's avatar
Ian Lynagh committed
185 186

checkFEDArgs :: [Type] -> TcM ()
187
#if alpha_TARGET_ARCH
ken's avatar
ken committed
188
checkFEDArgs arg_tys
189
  = check (integral_args <= 32) err
ken's avatar
ken committed
190
  where
191
    integral_args = sum [ (widthInBytes . argMachRep . primRepToCgRep) prim_rep
192 193
			| prim_rep <- map typePrimRep arg_tys,
			  primRepHint prim_rep /= FloatHint ]
Ian Lynagh's avatar
Ian Lynagh committed
194
    err = ptext (sLit "On Alpha, I can only handle 32 bytes of non-floating-point arguments to foreign export dynamic")
195
#else
Ian Lynagh's avatar
Ian Lynagh committed
196
checkFEDArgs _ = return ()
197 198
#endif
\end{code}
199 200 201 202 203 204 205 206 207


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

\begin{code}
208 209
tcForeignExports :: [LForeignDecl Name] 
    		 -> TcM (LHsBinds TcId, [LForeignDecl TcId])
210
tcForeignExports decls
211
  = foldlM combine (emptyLHsBinds, []) (filter isForeignExport decls)
sof's avatar
sof committed
212
  where
213 214 215
   combine (binds, fs) fe = do
       (b, f) <- wrapLocSndM tcFExport fe
       return (b `consBag` binds, f:fs)
sof's avatar
sof committed
216

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

221 222
   sig_ty <- tcHsSigType (ForSigCtxt nm) hs_ty
   rhs <- tcPolyExpr (nlHsVar nm) sig_ty
223

224
   tcCheckFEType sig_ty spec
sof's avatar
sof committed
225

chak's avatar
chak committed
226 227
	  -- 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
228 229
	  -- to create a local binding which will call the exported function
	  -- at a particular type (and, maybe, overloading).
230

231 232 233 234 235

   -- 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.
   id  <- mkStableIdFromName nm sig_ty loc mkForeignExportOcc
Simon Marlow's avatar
Simon Marlow committed
236
   return (L loc (VarBind id rhs), ForeignExport (L loc id) undefined spec)
Ian Lynagh's avatar
Ian Lynagh committed
237
tcFExport d = pprPanic "tcFExport" (ppr d)
238 239 240
\end{code}

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

242
\begin{code}
Ian Lynagh's avatar
Ian Lynagh committed
243
tcCheckFEType :: Type -> ForeignExport -> TcM ()
244 245 246
tcCheckFEType sig_ty (CExport (CExportStatic str _)) = do
    check (isCLabelString str) (badCName str)
    checkForeignArgs isFFIExternalTy arg_tys
247 248 249 250
    checkForeignRes nonIOok isFFIExportResultTy res_ty
  where
      -- Drop the foralls before inspecting n
      -- the structure of the foreign type.
251 252
    (_, t_ty) = tcSplitForAllTys sig_ty
    (arg_tys, res_ty) = tcSplitFunTys t_ty
Ian Lynagh's avatar
Ian Lynagh committed
253
tcCheckFEType _ d = pprPanic "tcCheckFEType" (ppr d)
sof's avatar
sof committed
254 255 256
\end{code}


257 258 259 260 261 262 263

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
278
nonIOok, mustBeIO :: Bool
279 280 281
nonIOok  = True
mustBeIO = False

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

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

Ian Lynagh's avatar
Ian Lynagh committed
302
checkCOrAsm :: HscTarget -> Maybe SDoc
303 304
checkCOrAsm HscC   = Nothing
checkCOrAsm HscAsm = Nothing
Ian Lynagh's avatar
Ian Lynagh committed
305
checkCOrAsm _
306 307
   = Just (text "requires via-C or native code generation (-fvia-C)")

Ian Lynagh's avatar
Ian Lynagh committed
308
checkCOrAsmOrInterp :: HscTarget -> Maybe SDoc
309 310 311
checkCOrAsmOrInterp HscC           = Nothing
checkCOrAsmOrInterp HscAsm         = Nothing
checkCOrAsmOrInterp HscInterpreted = Nothing
Ian Lynagh's avatar
Ian Lynagh committed
312
checkCOrAsmOrInterp _
313
   = Just (text "requires interpreted, C or native code generation")
314

Ian Lynagh's avatar
Ian Lynagh committed
315
checkCOrAsmOrDotNetOrInterp :: HscTarget -> Maybe SDoc
316 317 318
checkCOrAsmOrDotNetOrInterp HscC           = Nothing
checkCOrAsmOrDotNetOrInterp HscAsm         = Nothing
checkCOrAsmOrDotNetOrInterp HscInterpreted = Nothing
Ian Lynagh's avatar
Ian Lynagh committed
319
checkCOrAsmOrDotNetOrInterp _
320
   = Just (text "requires interpreted, C or native code generation")
321

Ian Lynagh's avatar
Ian Lynagh committed
322
checkCg :: (HscTarget -> Maybe SDoc) -> TcM ()
323 324 325
checkCg check = do
   dflags <- getDOpts
   let target = hscTarget dflags
326
   case target of
327
     HscNothing -> return ()
Ian Lynagh's avatar
Ian Lynagh committed
328
     _ ->
329
       case check target of
330
	 Nothing  -> return ()
chak's avatar
chak committed
331
	 Just err -> addErrTc (text "Illegal foreign declaration:" <+> err)
SamB's avatar
SamB committed
332
\end{code}
333
			   
334 335 336 337 338 339 340 341 342 343
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
Ian Lynagh's avatar
Ian Lynagh committed
344
checkCConv CmmCallConv = panic "checkCConv CmmCallConv"
345 346
\end{code}

sof's avatar
sof committed
347 348 349
Warnings

\begin{code}
350
check :: Bool -> Message -> TcM ()
351
check True _	   = return ()
352
check _    the_err = addErrTc the_err
353

Ian Lynagh's avatar
Ian Lynagh committed
354
illegalForeignTyErr :: SDoc -> Type -> SDoc
355
illegalForeignTyErr arg_or_res ty
Ian Lynagh's avatar
Ian Lynagh committed
356 357
  = hang (hsep [ptext (sLit "Unacceptable"), arg_or_res, 
                ptext (sLit "type in foreign declaration:")])
358
	 4 (hsep [ppr ty])
sof's avatar
sof committed
359

360
-- Used for 'arg_or_res' argument to illegalForeignTyErr
Ian Lynagh's avatar
Ian Lynagh committed
361
argument, result :: SDoc
362 363 364 365
argument = text "argument"
result   = text "result"

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

Ian Lynagh's avatar
Ian Lynagh committed
369
foreignDeclCtxt :: ForeignDecl Name -> SDoc
370
foreignDeclCtxt fo
Ian Lynagh's avatar
Ian Lynagh committed
371
  = hang (ptext (sLit "When checking declaration:"))
372
         4 (ppr fo)
sof's avatar
sof committed
373

Ian Lynagh's avatar
Ian Lynagh committed
374 375
illegalDNMethodSig :: SDoc
illegalDNMethodSig
Ian Lynagh's avatar
Ian Lynagh committed
376
  = ptext (sLit "'This pointer' expected as last argument")
sof's avatar
sof committed
377

sof's avatar
sof committed
378
\end{code}
379