TcForeign.lhs 12.5 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
sof's avatar
sof committed
28

29 30 31
import ForeignCall
import ErrUtils
import Id
32
#if alpha_TARGET_ARCH
33 34 35
import Type
import SMRep
import MachOp
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 Unique
45
import FastString
sof's avatar
sof committed
46 47
\end{code}

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

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

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

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

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


------------ Checking types for foreign import ----------------------
\begin{code}
Ian Lynagh's avatar
Ian Lynagh committed
95
tcCheckFIType :: Type -> [Type] -> Type -> ForeignImport -> TcM ForeignImport
96 97 98 99 100 101 102
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
103 104 105 106 107
       DNMethod | not isStatic ->
         case arg_tys of
	   [] -> addErrTc illegalDNMethodSig
	   _  
	    | not (isFFIDotnetObjTy (last arg_tys)) -> addErrTc illegalDNMethodSig
108 109 110
	    | otherwise -> return ()
       _ -> return ()
    return (DNImport (withDNTypes spec (map toDNType arg_tys) (toDNType res_ty)))
sof's avatar
sof committed
111

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

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

135
tcCheckFIType sig_ty arg_tys res_ty idecl@(CImport cconv safety _ _ (CFunction target))
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
  | 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
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
\end{code}
167

168 169
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
170 171 172
foreign export dynamic (i.e., 32 bytes of arguments after padding each
argument to a quadword, excluding floating-point arguments).

173 174 175 176
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
177 178

checkFEDArgs :: [Type] -> TcM ()
179
#if alpha_TARGET_ARCH
ken's avatar
ken committed
180
checkFEDArgs arg_tys
181
  = check (integral_args <= 32) err
ken's avatar
ken committed
182
  where
183 184 185
    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
186
    err = ptext (sLit "On Alpha, I can only handle 32 bytes of non-floating-point arguments to foreign export dynamic")
187
#else
Ian Lynagh's avatar
Ian Lynagh committed
188
checkFEDArgs _ = return ()
189 190
#endif
\end{code}
191 192 193 194 195 196 197 198 199


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

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

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

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

216
   tcCheckFEType sig_ty spec
sof's avatar
sof committed
217

chak's avatar
chak committed
218 219
	  -- 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
220 221
	  -- to create a local binding which will call the exported function
	  -- at a particular type (and, maybe, overloading).
222

223 224
   uniq <- newUnique
   mod <- getModule
225
   let
226 227 228 229 230 231 232 233 234 235 236
          -- 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
237
	id   = mkExportedLocalId gnm sig_ty
238
	bind = L loc (VarBind id rhs)
239 240

   return (bind, ForeignExport (L loc id) undefined spec)
Ian Lynagh's avatar
Ian Lynagh committed
241
tcFExport d = pprPanic "tcFExport" (ppr d)
242 243 244
\end{code}

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

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


261 262 263 264 265 266 267

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
282
nonIOok, mustBeIO :: Bool
283 284 285
nonIOok  = True
mustBeIO = False

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

297
\begin{code}
Ian Lynagh's avatar
Ian Lynagh committed
298
checkDotnet :: HscTarget -> Maybe SDoc
sof's avatar
sof committed
299 300 301 302
#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
303
checkDotnet _      = Just (text "requires .NET support (-filx or win32)")
sof's avatar
sof committed
304
#endif
305

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

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

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

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

sof's avatar
sof committed
351 352 353
Warnings

\begin{code}
354
check :: Bool -> Message -> TcM ()
355
check True _	   = return ()
356
check _    the_err = addErrTc the_err
357

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

364
-- Used for 'arg_or_res' argument to illegalForeignTyErr
Ian Lynagh's avatar
Ian Lynagh committed
365
argument, result :: SDoc
366 367 368 369
argument = text "argument"
result   = text "result"

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

Ian Lynagh's avatar
Ian Lynagh committed
373
foreignDeclCtxt :: ForeignDecl Name -> SDoc
374
foreignDeclCtxt fo
Ian Lynagh's avatar
Ian Lynagh committed
375
  = hang (ptext (sLit "When checking declaration:"))
376
         4 (ppr fo)
sof's avatar
sof committed
377

Ian Lynagh's avatar
Ian Lynagh committed
378 379
illegalDNMethodSig :: SDoc
illegalDNMethodSig
Ian Lynagh's avatar
Ian Lynagh committed
380
  = ptext (sLit "'This pointer' expected as last argument")
sof's avatar
sof committed
381

sof's avatar
sof committed
382
\end{code}
383