ghc/compiler/deSugar/DsCCall.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1994-1998
   3 %
   4 \section[DsCCall]{Desugaring \tr{_ccall_}s and \tr{_casm_}s}
   5
   6 \begin{code}
   7 module DsCCall
   8         ( dsCCall
   9         , mkFCall
  10         , unboxArg
  11         , boxResult
  12         , resultWrapper
  13         ) where
  14
  15 #include "HsVersions.h"
  16
  17 import CoreSyn
  18
  19 import DsMonad
  20
  21 import CoreUtils        ( exprType )
  22 import Id               ( Id, mkWildId, idType )
  23 import MkId             ( mkFCallId, realWorldPrimId, mkPrimOpId )
  24 import Maybes           ( maybeToBool )
  25 import ForeignCall      ( ForeignCall(..), CCallSpec(..), CCallTarget(..), Safety, CCallConv(..) )
  26 import DataCon          ( splitProductType_maybe, dataConSourceArity, dataConWrapId )
  27 import ForeignCall      ( ForeignCall, CCallTarget(..) )
  28
  29 import TcType           ( Type, isUnLiftedType, mkFunTys, mkFunTy,
  30                           tyVarsOfType, mkForAllTys, mkTyConApp,
  31                           isBoolTy, isUnitTy, isPrimitiveType,
  32                           tcSplitTyConApp_maybe
  33                         )
  34 import Type             ( repType, eqType )     -- Sees the representation type
  35 import PrimOp           ( PrimOp(TouchOp) )
  36 import TysPrim          ( realWorldStatePrimTy,
  37                           byteArrayPrimTyCon, mutableByteArrayPrimTyCon,
  38                           intPrimTy, foreignObjPrimTy
  39                         )
  40 import TyCon            ( tyConDataCons )
  41 import TysWiredIn       ( unitDataConId,
  42                           unboxedSingletonDataCon, unboxedPairDataCon,
  43                           unboxedSingletonTyCon, unboxedPairTyCon,
  44                           trueDataCon, falseDataCon,
  45                           trueDataConId, falseDataConId
  46                         )
  47 import Literal          ( mkMachInt )
  48 import CStrings         ( CLabelString )
  49 import PrelNames        ( Unique, hasKey, ioTyConKey )
  50 import VarSet           ( varSetElems )
  51 import Outputable
  52 \end{code}
  53
  54 Desugaring of @ccall@s consists of adding some state manipulation,
  55 unboxing any boxed primitive arguments and boxing the result if
  56 desired.
  57
  58 The state stuff just consists of adding in
  59 @PrimIO (\ s -> case s of { S# s# -> ... })@ in an appropriate place.
  60
  61 The unboxing is straightforward, as all information needed to unbox is
  62 available from the type.  For each boxed-primitive argument, we
  63 transform:
  64 \begin{verbatim}
  65    _ccall_ foo [ r, t1, ... tm ] e1 ... em
  66    |
  67    |
  68    V
  69    case e1 of { T1# x1# ->
  70    ...
  71    case em of { Tm# xm# -> xm#
  72    ccall# foo [ r, t1#, ... tm# ] x1# ... xm#
  73    } ... }
  74 \end{verbatim}
  75
  76 The reboxing of a @_ccall_@ result is a bit tricker: the types don't
  77 contain information about the state-pairing functions so we have to
  78 keep a list of \tr{(type, s-p-function)} pairs.  We transform as
  79 follows:
  80 \begin{verbatim}
  81    ccall# foo [ r, t1#, ... tm# ] e1# ... em#
  82    |
  83    |
  84    V
  85    \ s# -> case (ccall# foo [ r, t1#, ... tm# ] s# e1# ... em#) of
  86           (StateAnd<r># result# state#) -> (R# result#, realWorld#)
  87 \end{verbatim}
  88
  89 \begin{code}
  90 dsCCall :: CLabelString -- C routine to invoke
  91         -> [CoreExpr]   -- Arguments (desugared)
  92         -> Safety       -- Safety of the call
  93         -> Bool         -- True <=> really a "_casm_"
  94         -> Type         -- Type of the result: IO t
  95         -> DsM CoreExpr
  96
  97 dsCCall lbl args may_gc is_asm result_ty
  98   = mapAndUnzipDs unboxArg args `thenDs` \ (unboxed_args, arg_wrappers) ->
  99     boxResult [] ({-repType-} result_ty)        `thenDs` \ (ccall_result_ty, res_wrapper) ->
 100     getUniqueDs                 `thenDs` \ uniq ->
 101     let
 102         target | is_asm    = CasmTarget lbl
 103                | otherwise = StaticTarget lbl
 104         the_fcall    = CCall (CCallSpec target CCallConv may_gc)
 105         the_prim_app = mkFCall uniq the_fcall unboxed_args ccall_result_ty
 106     in
 107     returnDs (foldr ($) (res_wrapper the_prim_app) arg_wrappers)
 108
 109 mkFCall :: Unique -> ForeignCall
 110         -> [CoreExpr]   -- Args
 111         -> Type         -- Result type
 112         -> CoreExpr
 113 -- Construct the ccall.  The only tricky bit is that the ccall Id should have
 114 -- no free vars, so if any of the arg tys do we must give it a polymorphic type.
 115 --      [I forget *why* it should have no free vars!]
 116 -- For example:
 117 --      mkCCall ... [s::StablePtr (a->b), x::Addr, c::Char]
 118 --
 119 -- Here we build a ccall thus
 120 --      (ccallid::(forall a b.  StablePtr (a -> b) -> Addr -> Char -> IO Addr))
 121 --                      a b s x c
 122 mkFCall uniq the_fcall val_args res_ty
 123   = mkApps (mkVarApps (Var the_fcall_id) tyvars) val_args
 124   where
 125     arg_tys = map exprType val_args
 126     body_ty = (mkFunTys arg_tys res_ty)
 127     tyvars  = varSetElems (tyVarsOfType body_ty)
 128     ty      = mkForAllTys tyvars body_ty
 129     the_fcall_id = mkFCallId uniq the_fcall ty
 130 \end{code}
 131
 132 \begin{code}
 133 unboxArg :: CoreExpr                    -- The supplied argument
 134          -> DsM (CoreExpr,              -- To pass as the actual argument
 135                  CoreExpr -> CoreExpr   -- Wrapper to unbox the arg
 136                 )
 137 -- Example: if the arg is e::Int, unboxArg will return
 138 --      (x#::Int#, \W. case x of I# x# -> W)
 139 -- where W is a CoreExpr that probably mentions x#
 140
 141 unboxArg arg
 142   -- Primtive types: nothing to unbox
 143   | isPrimitiveType arg_ty
 144   = returnDs (arg, \body -> body)
 145
 146   -- Booleans
 147   | isBoolTy arg_ty
 148   = newSysLocalDs intPrimTy             `thenDs` \ prim_arg ->
 149     returnDs (Var prim_arg,
 150               \ body -> Case (Case arg (mkWildId arg_ty)
 151                                        [(DataAlt falseDataCon,[],mkIntLit 0),
 152                                         (DataAlt trueDataCon, [],mkIntLit 1)])
 153                              prim_arg
 154                              [(DEFAULT,[],body)])
 155
 156   -- Data types with a single constructor, which has a single, primitive-typed arg
 157   -- This deals with Int, Float etc
 158   | is_product_type && data_con_arity == 1
 159   = ASSERT(isUnLiftedType data_con_arg_ty1 )    -- Typechecker ensures this
 160     newSysLocalDs arg_ty                `thenDs` \ case_bndr ->
 161     newSysLocalDs data_con_arg_ty1      `thenDs` \ prim_arg ->
 162     returnDs (Var prim_arg,
 163               \ body -> Case arg case_bndr [(DataAlt data_con,[prim_arg],body)]
 164     )
 165
 166   -- Byte-arrays, both mutable and otherwise; hack warning
 167   -- We're looking for values of type ByteArray, MutableByteArray
 168   --    data ByteArray          ix = ByteArray        ix ix ByteArray#
 169   --    data MutableByteArray s ix = MutableByteArray ix ix (MutableByteArray# s)
 170   | is_product_type &&
 171     data_con_arity == 3 &&
 172     maybeToBool maybe_arg3_tycon &&
 173     (arg3_tycon ==  byteArrayPrimTyCon ||
 174      arg3_tycon ==  mutableByteArrayPrimTyCon)
 175     -- and, of course, it is an instance of CCallable
 176   = newSysLocalDs arg_ty                `thenDs` \ case_bndr ->
 177     newSysLocalsDs data_con_arg_tys     `thenDs` \ vars@[l_var, r_var, arr_cts_var] ->
 178     returnDs (Var arr_cts_var,
 179               \ body -> Case arg case_bndr [(DataAlt data_con,vars,body)]
 180     )
 181
 182   | otherwise
 183   = getSrcLocDs `thenDs` \ l ->
 184     pprPanic "unboxArg: " (ppr l <+> ppr arg_ty)
 185   where
 186     arg_ty                                      = repType (exprType arg)
 187         -- The repType looks through any newtype or
 188         -- implicit-parameter wrappings on the argument;
 189         -- this is necessary, because isBoolTy (in particular) does not.
 190
 191     maybe_product_type                          = splitProductType_maybe arg_ty
 192     is_product_type                             = maybeToBool maybe_product_type
 193     Just (_, _, data_con, data_con_arg_tys)     = maybe_product_type
 194     data_con_arity                              = dataConSourceArity data_con
 195     (data_con_arg_ty1 : _)                      = data_con_arg_tys
 196
 197     (_ : _ : data_con_arg_ty3 : _) = data_con_arg_tys
 198     maybe_arg3_tycon               = tcSplitTyConApp_maybe data_con_arg_ty3
 199     Just (arg3_tycon,_)            = maybe_arg3_tycon
 200 \end{code}
 201
 202
 203 \begin{code}
 204 boxResult :: [Id] -> Type -> DsM (Type, CoreExpr -> CoreExpr)
 205
 206 -- Takes the result of the user-level ccall:
 207 --      either (IO t),
 208 --      or maybe just t for an side-effect-free call
 209 -- Returns a wrapper for the primitive ccall itself, along with the
 210 -- type of the result of the primitive ccall.  This result type
 211 -- will be of the form
 212 --      State# RealWorld -> (# State# RealWorld, t' #)
 213 -- where t' is the unwrapped form of t.  If t is simply (), then
 214 -- the result type will be
 215 --      State# RealWorld -> (# State# RealWorld #)
 216
 217 -- Here is where we arrange that ForeignPtrs which are passed to a 'safe'
 218 -- foreign import don't get finalized until the call returns.  For each
 219 -- argument of type ForeignObj# we arrange to touch# the argument after
 220 -- the call.  The arg_ids passed in are the Ids passed to the actual ccall.
 221
 222 boxResult arg_ids result_ty
 223   = case tcSplitTyConApp_maybe result_ty of
 224         -- This split absolutely has to be a tcSplit, because we must
 225         -- see the IO type; and it's a newtype which is transparent to splitTyConApp.
 226
 227         -- The result is IO t, so wrap the result in an IO constructor
 228         Just (io_tycon, [io_res_ty]) | io_tycon `hasKey` ioTyConKey
 229                 -> mk_alt return_result
 230                           (resultWrapper io_res_ty)     `thenDs` \ (ccall_res_ty, the_alt) ->
 231                    newSysLocalDs  realWorldStatePrimTy   `thenDs` \ state_id ->
 232                    let
 233                         io_data_con = head (tyConDataCons io_tycon)
 234                         wrap = \ the_call ->
 235                                  mkApps (Var (dataConWrapId io_data_con))
 236                                            [ Type io_res_ty,
 237                                              Lam state_id $
 238                                               Case (App the_call (Var state_id))
 239                                                    (mkWildId ccall_res_ty)
 240                                                    [the_alt]
 241                                            ]
 242                    in
 243                    returnDs (realWorldStatePrimTy `mkFunTy` ccall_res_ty, wrap)
 244                 where
 245                    return_result state ans = mkConApp unboxedPairDataCon
 246                                                       [Type realWorldStatePrimTy, Type io_res_ty,
 247                                                        state, ans]
 248
 249         -- It isn't, so do unsafePerformIO
 250         -- It's not conveniently available, so we inline it
 251         other -> mk_alt return_result
 252                         (resultWrapper result_ty) `thenDs` \ (ccall_res_ty, the_alt) ->
 253                  let
 254                     wrap = \ the_call -> Case (App the_call (Var realWorldPrimId))
 255                                               (mkWildId ccall_res_ty)
 256                                               [the_alt]
 257                  in
 258                  returnDs (realWorldStatePrimTy `mkFunTy` ccall_res_ty, wrap)
 259               where
 260                  return_result state ans = ans
 261   where
 262     mk_alt return_result (Nothing, wrap_result)
 263         =       -- The ccall returns ()
 264           let
 265                 rhs_fun state_id = return_result (Var state_id)
 266                                         (wrap_result (panic "boxResult"))
 267           in
 268           newSysLocalDs realWorldStatePrimTy    `thenDs` \ state_id ->
 269           mkTouches arg_ids state_id rhs_fun    `thenDs` \ the_rhs ->
 270           let
 271                 ccall_res_ty = mkTyConApp unboxedSingletonTyCon [realWorldStatePrimTy]
 272                 the_alt      = (DataAlt unboxedSingletonDataCon, [state_id], the_rhs)
 273           in
 274           returnDs (ccall_res_ty, the_alt)
 275
 276     mk_alt return_result (Just prim_res_ty, wrap_result)
 277         =       -- The ccall returns a non-() value
 278           newSysLocalDs prim_res_ty             `thenDs` \ result_id ->
 279           let
 280                 rhs_fun state_id = return_result (Var state_id)
 281                                         (wrap_result (Var result_id))
 282           in
 283           newSysLocalDs realWorldStatePrimTy    `thenDs` \ state_id ->
 284           mkTouches arg_ids state_id rhs_fun    `thenDs` \ the_rhs ->
 285           let
 286                 ccall_res_ty = mkTyConApp unboxedPairTyCon [realWorldStatePrimTy, prim_res_ty]
 287                 the_alt      = (DataAlt unboxedPairDataCon, [state_id, result_id], the_rhs)
 288           in
 289           returnDs (ccall_res_ty, the_alt)
 290
 291 touchzh = mkPrimOpId TouchOp
 292
 293 mkTouches []     s cont = returnDs (cont s)
 294 mkTouches (v:vs) s cont
 295   | not (idType v `eqType` foreignObjPrimTy) = mkTouches vs s cont
 296   | otherwise = newSysLocalDs realWorldStatePrimTy `thenDs` \s' ->
 297                 mkTouches vs s' cont `thenDs` \ rest ->
 298                 returnDs (Case (mkApps (Var touchzh) [Type foreignObjPrimTy,
 299                                                       Var v, Var s]) s'
 300                                 [(DEFAULT, [], rest)])
 301
 302 resultWrapper :: Type
 303               -> (Maybe Type,           -- Type of the expected result, if any
 304                   CoreExpr -> CoreExpr) -- Wrapper for the result
 305 resultWrapper result_ty
 306   -- Base case 1: primitive types
 307   | isPrimitiveType result_ty_rep
 308   = (Just result_ty, \e -> e)
 309
 310   -- Base case 2: the unit type ()
 311   | isUnitTy result_ty_rep
 312   = (Nothing, \e -> Var unitDataConId)
 313
 314   -- Base case 3: the boolean type
 315   | isBoolTy result_ty_rep
 316   = (Just intPrimTy, \e -> Case e (mkWildId intPrimTy)
 317                                   [(DEFAULT             ,[],Var trueDataConId ),
 318                                    (LitAlt (mkMachInt 0),[],Var falseDataConId)])
 319
 320   -- Data types with a single constructor, which has a single arg
 321   | Just (_, tycon_arg_tys, data_con, data_con_arg_tys) <- splitProductType_maybe result_ty_rep,
 322     dataConSourceArity data_con == 1
 323   = let
 324         (maybe_ty, wrapper)    = resultWrapper unwrapped_res_ty
 325         (unwrapped_res_ty : _) = data_con_arg_tys
 326     in
 327     (maybe_ty, \e -> mkApps (Var (dataConWrapId data_con))
 328                             (map Type tycon_arg_tys ++ [wrapper e]))
 329
 330   | otherwise
 331   = pprPanic "resultWrapper" (ppr result_ty)
 332   where
 333     result_ty_rep = repType result_ty   -- Look through any newtypes/implicit parameters
 334 \end{code}