compiler/typecheck/TcForeign.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The AQUA Project, Glasgow University, 1998
   4 %
   5 \section[TcForeign]{Typechecking \tr{foreign} declarations}
   6
   7 A foreign declaration is used to either give an externally
   8 implemented function a Haskell type (and calling interface) or
   9 give a Haskell function an external calling interface. Either way,
  10 the range of argument and result types these functions can accommodate
  11 is restricted to what the outside world understands (read C), and this
  12 module checks to see if a foreign declaration has got a legal type.
  13
  14 \begin{code}
  15 module TcForeign
  16         (
  17           tcForeignImports
  18         , tcForeignExports
  19         ) where
  20
  21 #include "HsVersions.h"
  22
  23 import HsSyn
  24
  25 import TcRnMonad
  26 import TcHsType
  27 import TcExpr
  28 import TcEnv
  29
  30 import ForeignCall
  31 import ErrUtils
  32 import Id
  33 #if alpha_TARGET_ARCH
  34 import Type
  35 import SMRep
  36 #endif
  37 import Name
  38 import TcType
  39 import DynFlags
  40 import Outputable
  41 import SrcLoc
  42 import Bag
  43 import FastString
  44 \end{code}
  45
  46 \begin{code}
  47 -- Defines a binding
  48 isForeignImport :: LForeignDecl name -> Bool
  49 isForeignImport (L _ (ForeignImport _ _ _)) = True
  50 isForeignImport _                             = False
  51
  52 -- Exports a binding
  53 isForeignExport :: LForeignDecl name -> Bool
  54 isForeignExport (L _ (ForeignExport _ _ _)) = True
  55 isForeignExport _                             = False
  56 \end{code}
  57
  58 %************************************************************************
  59 %*                                                                      *
  60 \subsection{Imports}
  61 %*                                                                      *
  62 %************************************************************************
  63
  64 \begin{code}
  65 tcForeignImports :: [LForeignDecl Name] -> TcM ([Id], [LForeignDecl Id])
  66 tcForeignImports decls
  67   = mapAndUnzipM (wrapLocSndM tcFImport) (filter isForeignImport decls)
  68
  69 tcFImport :: ForeignDecl Name -> TcM (Id, ForeignDecl Id)
  70 tcFImport fo@(ForeignImport (L loc nm) hs_ty imp_decl)
  71  = addErrCtxt (foreignDeclCtxt fo)  $
  72    do { sig_ty <- tcHsSigType (ForSigCtxt nm) hs_ty
  73       ; let
  74           -- Drop the foralls before inspecting the
  75           -- structure of the foreign type.
  76             (_, t_ty)         = tcSplitForAllTys sig_ty
  77             (arg_tys, res_ty) = tcSplitFunTys t_ty
  78             id                = mkLocalId nm sig_ty
  79                 -- Use a LocalId to obey the invariant that locally-defined
  80                 -- things are LocalIds.  However, it does not need zonking,
  81                 -- (so TcHsSyn.zonkForeignExports ignores it).
  82
  83       ; imp_decl' <- tcCheckFIType sig_ty arg_tys res_ty imp_decl
  84          -- Can't use sig_ty here because sig_ty :: Type and
  85          -- we need HsType Id hence the undefined
  86       ; return (id, ForeignImport (L loc id) undefined imp_decl') }
  87 tcFImport d = pprPanic "tcFImport" (ppr d)
  88 \end{code}
  89
  90
  91 ------------ Checking types for foreign import ----------------------
  92 \begin{code}
  93 tcCheckFIType :: Type -> [Type] -> Type -> ForeignImport -> TcM ForeignImport
  94
  95 tcCheckFIType sig_ty arg_tys res_ty idecl@(CImport _ safety _ (CLabel _))
  96   = ASSERT( null arg_tys )
  97     do { checkCg checkCOrAsm
  98        ; checkSafety safety
  99        ; check (isFFILabelTy res_ty) (illegalForeignTyErr empty sig_ty)
 100        ; return idecl }      -- NB check res_ty not sig_ty!
 101                              --    In case sig_ty is (forall a. ForeignPtr a)
 102
 103 tcCheckFIType sig_ty arg_tys res_ty idecl@(CImport cconv safety _ CWrapper) = do
 104         -- Foreign wrapper (former f.e.d.)
 105         -- The type must be of the form ft -> IO (FunPtr ft), where ft is a
 106         -- valid foreign type.  For legacy reasons ft -> IO (Ptr ft) as well
 107         -- as ft -> IO Addr is accepted, too.  The use of the latter two forms
 108         -- is DEPRECATED, though.
 109     checkCg checkCOrAsmOrInterp
 110     checkCConv cconv
 111     checkSafety safety
 112     case arg_tys of
 113         [arg1_ty] -> do checkForeignArgs isFFIExternalTy arg1_tys
 114                         checkForeignRes nonIOok  isFFIExportResultTy res1_ty
 115                         checkForeignRes mustBeIO isFFIDynResultTy    res_ty
 116                         checkFEDArgs arg1_tys
 117                   where
 118                      (arg1_tys, res1_ty) = tcSplitFunTys arg1_ty
 119         _ -> addErrTc (illegalForeignTyErr empty sig_ty)
 120     return idecl
 121
 122 tcCheckFIType sig_ty arg_tys res_ty idecl@(CImport cconv safety _ (CFunction target))
 123   | isDynamicTarget target = do -- Foreign import dynamic
 124       checkCg checkCOrAsmOrInterp
 125       checkCConv cconv
 126       checkSafety safety
 127       case arg_tys of           -- The first arg must be Ptr, FunPtr, or Addr
 128         []                -> do
 129           check False (illegalForeignTyErr empty sig_ty)
 130           return idecl
 131         (arg1_ty:arg_tys) -> do
 132           dflags <- getDOpts
 133           check (isFFIDynArgumentTy arg1_ty)
 134                 (illegalForeignTyErr argument arg1_ty)
 135           checkForeignArgs (isFFIArgumentTy dflags safety) arg_tys
 136           checkForeignRes nonIOok (isFFIImportResultTy dflags) res_ty
 137           return idecl
 138   | cconv == PrimCallConv = do
 139       dflags <- getDOpts
 140       check (dopt Opt_GHCForeignImportPrim dflags)
 141             (text "Use -XGHCForeignImportPrim to allow `foreign import prim'.")
 142       checkCg (checkCOrAsmOrDotNetOrInterp)
 143       checkCTarget target
 144       check (playSafe safety)
 145             (text "The safe/unsafe annotation should not be used with `foreign import prim'.")
 146       checkForeignArgs (isFFIPrimArgumentTy dflags) arg_tys
 147       -- prim import result is more liberal, allows (#,,#)
 148       checkForeignRes nonIOok (isFFIPrimResultTy dflags) res_ty
 149       return idecl
 150   | otherwise = do              -- Normal foreign import
 151       checkCg (checkCOrAsmOrDotNetOrInterp)
 152       checkCConv cconv
 153       checkSafety safety
 154       checkCTarget target
 155       dflags <- getDOpts
 156       checkForeignArgs (isFFIArgumentTy dflags safety) arg_tys
 157       checkForeignRes nonIOok (isFFIImportResultTy dflags) res_ty
 158       checkMissingAmpersand dflags arg_tys res_ty
 159       return idecl
 160
 161 -- This makes a convenient place to check
 162 -- that the C identifier is valid for C
 163 checkCTarget :: CCallTarget -> TcM ()
 164 checkCTarget (StaticTarget str) = do
 165     checkCg checkCOrAsmOrDotNetOrInterp
 166     check (isCLabelString str) (badCName str)
 167 checkCTarget DynamicTarget = panic "checkCTarget DynamicTarget"
 168
 169 checkMissingAmpersand :: DynFlags -> [Type] -> Type -> TcM ()
 170 checkMissingAmpersand dflags arg_tys res_ty
 171   | null arg_tys && isFunPtrTy res_ty &&
 172     dopt Opt_WarnDodgyForeignImports dflags
 173   = addWarn (ptext (sLit "possible missing & in foreign import of FunPtr"))
 174   | otherwise
 175   = return ()
 176 \end{code}
 177
 178 On an Alpha, with foreign export dynamic, due to a giant hack when
 179 building adjustor thunks, we only allow 4 integer arguments with
 180 foreign export dynamic (i.e., 32 bytes of arguments after padding each
 181 argument to a quadword, excluding floating-point arguments).
 182
 183 The check is needed for both via-C and native-code routes
 184
 185 \begin{code}
 186 #include "nativeGen/NCG.h"
 187
 188 checkFEDArgs :: [Type] -> TcM ()
 189 #if alpha_TARGET_ARCH
 190 checkFEDArgs arg_tys
 191   = check (integral_args <= 32) err
 192   where
 193     integral_args = sum [ (widthInBytes . argMachRep . primRepToCgRep) prim_rep
 194                         | prim_rep <- map typePrimRep arg_tys,
 195                           primRepHint prim_rep /= FloatHint ]
 196     err = ptext (sLit "On Alpha, I can only handle 32 bytes of non-floating-point arguments to foreign export dynamic")
 197 #else
 198 checkFEDArgs _ = return ()
 199 #endif
 200 \end{code}
 201
 202
 203 %************************************************************************
 204 %*                                                                      *
 205 \subsection{Exports}
 206 %*                                                                      *
 207 %************************************************************************
 208
 209 \begin{code}
 210 tcForeignExports :: [LForeignDecl Name]
 211                  -> TcM (LHsBinds TcId, [LForeignDecl TcId])
 212 tcForeignExports decls
 213   = foldlM combine (emptyLHsBinds, []) (filter isForeignExport decls)
 214   where
 215    combine (binds, fs) fe = do
 216        (b, f) <- wrapLocSndM tcFExport fe
 217        return (b `consBag` binds, f:fs)
 218
 219 tcFExport :: ForeignDecl Name -> TcM (LHsBind Id, ForeignDecl Id)
 220 tcFExport fo@(ForeignExport (L loc nm) hs_ty spec) =
 221    addErrCtxt (foreignDeclCtxt fo)      $ do
 222
 223    sig_ty <- tcHsSigType (ForSigCtxt nm) hs_ty
 224    rhs <- tcPolyExpr (nlHsVar nm) sig_ty
 225
 226    tcCheckFEType sig_ty spec
 227
 228           -- we're exporting a function, but at a type possibly more
 229           -- constrained than its declared/inferred type. Hence the need
 230           -- to create a local binding which will call the exported function
 231           -- at a particular type (and, maybe, overloading).
 232
 233
 234    -- We need to give a name to the new top-level binding that
 235    -- is *stable* (i.e. the compiler won't change it later),
 236    -- because this name will be referred to by the C code stub.
 237    id  <- mkStableIdFromName nm sig_ty loc mkForeignExportOcc
 238    return (L loc (VarBind id rhs), ForeignExport (L loc id) undefined spec)
 239 tcFExport d = pprPanic "tcFExport" (ppr d)
 240 \end{code}
 241
 242 ------------ Checking argument types for foreign export ----------------------
 243
 244 \begin{code}
 245 tcCheckFEType :: Type -> ForeignExport -> TcM ()
 246 tcCheckFEType sig_ty (CExport (CExportStatic str cconv)) = do
 247     check (isCLabelString str) (badCName str)
 248     checkCConv cconv
 249     checkForeignArgs isFFIExternalTy arg_tys
 250     checkForeignRes nonIOok isFFIExportResultTy res_ty
 251   where
 252       -- Drop the foralls before inspecting n
 253       -- the structure of the foreign type.
 254     (_, t_ty) = tcSplitForAllTys sig_ty
 255     (arg_tys, res_ty) = tcSplitFunTys t_ty
 256 \end{code}
 257
 258
 259
 260 %************************************************************************
 261 %*                                                                      *
 262 \subsection{Miscellaneous}
 263 %*                                                                      *
 264 %************************************************************************
 265
 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 ----------------------
 275 -- Check that the type has the form
 276 --    (IO t) or (t) , and that t satisfies the given predicate.
 277 --
 278 checkForeignRes :: Bool -> (Type -> Bool) -> Type -> TcM ()
 279
 280 nonIOok, mustBeIO :: Bool
 281 nonIOok  = True
 282 mustBeIO = False
 283
 284 checkForeignRes non_io_result_ok pred_res_ty ty
 285         -- (IO t) is ok, and so is any newtype wrapping thereof
 286   | Just (_, res_ty, _) <- tcSplitIOType_maybe ty,
 287     pred_res_ty res_ty
 288   = return ()
 289
 290   | otherwise
 291   = check (non_io_result_ok && pred_res_ty ty)
 292           (illegalForeignTyErr result ty)
 293 \end{code}
 294
 295 \begin{code}
 296 checkCOrAsm :: HscTarget -> Maybe SDoc
 297 checkCOrAsm HscC   = Nothing
 298 checkCOrAsm HscAsm = Nothing
 299 checkCOrAsm _
 300    = Just (text "requires via-C or native code generation (-fvia-C)")
 301
 302 checkCOrAsmOrInterp :: HscTarget -> Maybe SDoc
 303 checkCOrAsmOrInterp HscC           = Nothing
 304 checkCOrAsmOrInterp HscAsm         = Nothing
 305 checkCOrAsmOrInterp HscInterpreted = Nothing
 306 checkCOrAsmOrInterp _
 307    = Just (text "requires interpreted, C or native code generation")
 308
 309 checkCOrAsmOrDotNetOrInterp :: HscTarget -> Maybe SDoc
 310 checkCOrAsmOrDotNetOrInterp HscC           = Nothing
 311 checkCOrAsmOrDotNetOrInterp HscAsm         = Nothing
 312 checkCOrAsmOrDotNetOrInterp HscInterpreted = Nothing
 313 checkCOrAsmOrDotNetOrInterp _
 314    = Just (text "requires interpreted, C or native code generation")
 315
 316 checkCg :: (HscTarget -> Maybe SDoc) -> TcM ()
 317 checkCg check = do
 318    dflags <- getDOpts
 319    let target = hscTarget dflags
 320    case target of
 321      HscNothing -> return ()
 322      _ ->
 323        case check target of
 324          Nothing  -> return ()
 325          Just err -> addErrTc (text "Illegal foreign declaration:" <+> err)
 326 \end{code}
 327
 328 Calling conventions
 329
 330 \begin{code}
 331 checkCConv :: CCallConv -> TcM ()
 332 checkCConv CCallConv  = return ()
 333 #if i386_TARGET_ARCH
 334 checkCConv StdCallConv = return ()
 335 #else
 336 checkCConv StdCallConv = addErrTc (text "calling convention not supported on this platform: stdcall")
 337 #endif
 338 checkCConv PrimCallConv = addErrTc (text "The `prim' calling convention can only be used with `foreign import'")
 339 checkCConv CmmCallConv = panic "checkCConv CmmCallConv"
 340 \end{code}
 341
 342 Deprecated "threadsafe" calls
 343
 344 \begin{code}
 345 checkSafety :: Safety -> TcM ()
 346 checkSafety (PlaySafe True) = addWarn (text "The `threadsafe' foreign import style is deprecated. Use `safe' instead.")
 347 checkSafety _               = return ()
 348 \end{code}
 349
 350 Warnings
 351
 352 \begin{code}
 353 check :: Bool -> Message -> TcM ()
 354 check True _       = return ()
 355 check _    the_err = addErrTc the_err
 356
 357 illegalForeignTyErr :: SDoc -> Type -> SDoc
 358 illegalForeignTyErr arg_or_res ty
 359   = hang (hsep [ptext (sLit "Unacceptable"), arg_or_res,
 360                 ptext (sLit "type in foreign declaration:")])
 361          4 (hsep [ppr ty])
 362
 363 -- Used for 'arg_or_res' argument to illegalForeignTyErr
 364 argument, result :: SDoc
 365 argument = text "argument"
 366 result   = text "result"
 367
 368 badCName :: CLabelString -> Message
 369 badCName target
 370    = sep [quotes (ppr target) <+> ptext (sLit "is not a valid C identifier")]
 371
 372 foreignDeclCtxt :: ForeignDecl Name -> SDoc
 373 foreignDeclCtxt fo
 374   = hang (ptext (sLit "When checking declaration:"))
 375          4 (ppr fo)
 376 \end{code}
 377