compiler/vectorise/Vectorise.hs

   1 module Vectorise( vectorise )
   2 where
   3
   4 #include "HsVersions.h"
   5
   6 import DynFlags
   7 import HscTypes
   8
   9 import CoreLint             ( showPass, endPass )
  10 import CoreSyn
  11 import CoreUtils
  12 import CoreFVs
  13 import TyCon
  14 import Type
  15 import TypeRep
  16 import Var
  17 import VarEnv
  18 import Name                 ( mkSysTvName )
  19 import NameEnv
  20 import Id
  21
  22 import DsMonad hiding (mapAndUnzipM)
  23
  24 import PrelNames
  25
  26 import Outputable
  27 import FastString
  28 import Control.Monad        ( liftM, liftM2, mapAndUnzipM )
  29
  30 vectorise :: HscEnv -> ModGuts -> IO ModGuts
  31 vectorise hsc_env guts
  32   | not (Opt_Vectorise `dopt` dflags) = return guts
  33   | otherwise
  34   = do
  35       showPass dflags "Vectorisation"
  36       eps <- hscEPS hsc_env
  37       let info = hptVectInfo hsc_env `plusVectInfo` eps_vect_info eps
  38       Just guts' <- initDs hsc_env (mg_module guts)
  39                                    (mg_rdr_env guts)
  40                                    (mg_types guts)
  41                                    (vectoriseModule info guts)
  42       endPass dflags "Vectorisation" Opt_D_dump_vect (mg_binds guts')
  43       return guts'
  44   where
  45     dflags = hsc_dflags hsc_env
  46
  47 -- ----------------------------------------------------------------------------
  48 -- Vectorisation monad
  49
  50 data Builtins = Builtins {
  51                   parrayTyCon      :: TyCon
  52                 , paTyCon          :: TyCon
  53                 , closureTyCon     :: TyCon
  54                 , mkClosureVar     :: Var
  55                 , applyClosureVar  :: Var
  56                 , mkClosurePVar    :: Var
  57                 , applyClosurePVar :: Var
  58                 , closurePAVar     :: Var
  59                 , lengthPAVar      :: Var
  60                 , replicatePAVar   :: Var
  61                 }
  62
  63 initBuiltins :: DsM Builtins
  64 initBuiltins
  65   = do
  66       parrayTyCon  <- dsLookupTyCon parrayTyConName
  67       paTyCon      <- dsLookupTyCon paTyConName
  68       closureTyCon <- dsLookupTyCon closureTyConName
  69
  70       mkClosureVar     <- dsLookupGlobalId mkClosureName
  71       applyClosureVar  <- dsLookupGlobalId applyClosureName
  72       mkClosurePVar    <- dsLookupGlobalId mkClosurePName
  73       applyClosurePVar <- dsLookupGlobalId applyClosurePName
  74       closurePAVar     <- dsLookupGlobalId closurePAName
  75       lengthPAVar      <- dsLookupGlobalId lengthPAName
  76       replicatePAVar   <- dsLookupGlobalId replicatePAName
  77
  78       return $ Builtins {
  79                  parrayTyCon      = parrayTyCon
  80                , paTyCon          = paTyCon
  81                , closureTyCon     = closureTyCon
  82                , mkClosureVar     = mkClosureVar
  83                , applyClosureVar  = applyClosureVar
  84                , mkClosurePVar    = mkClosurePVar
  85                , applyClosurePVar = applyClosurePVar
  86                , closurePAVar     = closurePAVar
  87                , lengthPAVar      = lengthPAVar
  88                , replicatePAVar   = replicatePAVar
  89                }
  90
  91 data GlobalEnv = GlobalEnv {
  92                   -- Mapping from global variables to their vectorised versions.
  93                   --
  94                   global_vars :: VarEnv CoreExpr
  95
  96                   -- Exported variables which have a vectorised version
  97                   --
  98                 , global_exported_vars :: VarEnv (Var, Var)
  99
 100                   -- Mapping from TyCons to their vectorised versions.
 101                   -- TyCons which do not have to be vectorised are mapped to
 102                   -- themselves.
 103                   --
 104                 , global_tycons :: NameEnv TyCon
 105
 106                   -- Mapping from TyCons to their PA dictionaries
 107                   --
 108                 , global_tycon_pa :: NameEnv CoreExpr
 109                 }
 110
 111 data LocalEnv = LocalEnv {
 112                  -- Mapping from local variables to their vectorised and
 113                  -- lifted versions
 114                  --
 115                  local_vars :: VarEnv (CoreExpr, CoreExpr)
 116
 117                  -- Mapping from tyvars to their PA dictionaries
 118                , local_tyvar_pa :: VarEnv CoreExpr
 119                }
 120
 121
 122 initGlobalEnv :: VectInfo -> GlobalEnv
 123 initGlobalEnv info
 124   = GlobalEnv {
 125       global_vars          = mapVarEnv  (Var . snd) $ vectInfoCCVar   info
 126     , global_exported_vars = emptyVarEnv
 127     , global_tycons        = mapNameEnv snd $ vectInfoCCTyCon info
 128     , global_tycon_pa      = emptyNameEnv
 129     }
 130
 131 emptyLocalEnv = LocalEnv {
 132                    local_vars     = emptyVarEnv
 133                  , local_tyvar_pa = emptyVarEnv
 134                  }
 135
 136 -- FIXME
 137 updVectInfo :: GlobalEnv -> ModGuts -> ModGuts
 138 updVectInfo env guts = guts { mg_vect_info = info' }
 139   where
 140     info' = info {
 141               vectInfoCCVar   = global_exported_vars env
 142             , vectInfoCCTyCon = tc_env
 143             }
 144
 145     info  = mg_vect_info guts
 146     tyenv = mg_types guts
 147
 148     tc_env = mkNameEnv [(tc_name, (tc,tc')) | tc <- typeEnvTyCons tyenv
 149                                             , let tc_name = tyConName tc
 150                                             , Just tc' <- [lookupNameEnv (global_tycons env) tc_name]]
 151
 152 data VResult a = Yes GlobalEnv LocalEnv a | No
 153
 154 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
 155
 156 instance Monad VM where
 157   return x   = VM $ \bi genv lenv -> return (Yes genv lenv x)
 158   VM p >>= f = VM $ \bi genv lenv -> do
 159                                       r <- p bi genv lenv
 160                                       case r of
 161                                         Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
 162                                         No                -> return No
 163
 164 noV :: VM a
 165 noV = VM $ \_ _ _ -> return No
 166
 167 tryV :: VM a -> VM (Maybe a)
 168 tryV (VM p) = VM $ \bi genv lenv ->
 169   do
 170     r <- p bi genv lenv
 171     case r of
 172       Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
 173       No                -> return (Yes genv  lenv  Nothing)
 174
 175 maybeV :: VM (Maybe a) -> VM a
 176 maybeV p = maybe noV return =<< p
 177
 178 orElseV :: VM a -> VM a -> VM a
 179 orElseV p q = maybe q return =<< tryV p
 180
 181 localV :: VM a -> VM a
 182 localV p = do
 183              env <- readLEnv id
 184              x <- p
 185              setLEnv env
 186              return x
 187
 188 liftDs :: DsM a -> VM a
 189 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
 190
 191 builtin :: (Builtins -> a) -> VM a
 192 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
 193
 194 readGEnv :: (GlobalEnv -> a) -> VM a
 195 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
 196
 197 setGEnv :: GlobalEnv -> VM ()
 198 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
 199
 200 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
 201 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
 202
 203 readLEnv :: (LocalEnv -> a) -> VM a
 204 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
 205
 206 setLEnv :: LocalEnv -> VM ()
 207 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
 208
 209 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
 210 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
 211
 212 newTyVar :: FastString -> Kind -> VM Var
 213 newTyVar fs k
 214   = do
 215       u <- liftDs newUnique
 216       return $ mkTyVar (mkSysTvName u fs) k
 217
 218 lookupTyCon :: TyCon -> VM (Maybe TyCon)
 219 lookupTyCon tc = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
 220
 221 -- ----------------------------------------------------------------------------
 222 -- Bindings
 223
 224 vectoriseModule :: VectInfo -> ModGuts -> DsM ModGuts
 225 vectoriseModule info guts
 226   = do
 227       builtins <- initBuiltins
 228       r <- runVM (vectModule guts) builtins (initGlobalEnv info) emptyLocalEnv
 229       case r of
 230         Yes genv _ guts' -> return $ updVectInfo genv guts'
 231         No               -> return guts
 232
 233 vectModule :: ModGuts -> VM ModGuts
 234 vectModule guts = return guts
 235
 236
 237
 238 vectBndr :: Var -> VM (Var, Var)
 239 vectBndr v
 240   = do
 241       vty <- vectType (idType v)
 242       lty <- mkPArrayTy vty
 243       let vv = v `Id.setIdType` vty
 244           lv = v `Id.setIdType` lty
 245       updLEnv (mapTo vv lv)
 246       return (vv, lv)
 247   where
 248     mapTo vv lv env = env { local_vars = extendVarEnv (local_vars env) v (Var vv, Var lv) }
 249
 250 vectBndrIn :: Var -> VM a -> VM (Var, Var, a)
 251 vectBndrIn v p
 252   = localV
 253   $ do
 254       (vv, lv) <- vectBndr v
 255       x <- p
 256       return (vv, lv, x)
 257
 258 vectBndrsIn :: [Var] -> VM a -> VM ([Var], [Var], a)
 259 vectBndrsIn vs p
 260   = localV
 261   $ do
 262       (vvs, lvs) <- mapAndUnzipM vectBndr vs
 263       x <- p
 264       return (vvs, lvs, x)
 265
 266 -- ----------------------------------------------------------------------------
 267 -- Expressions
 268
 269 replicateP :: CoreExpr -> CoreExpr -> VM CoreExpr
 270 replicateP expr len
 271   = do
 272       pa  <- paOfType ty
 273       rep <- builtin replicatePAVar
 274       return $ mkApps (Var rep) [Type ty, pa, expr, len]
 275   where
 276     ty = exprType expr
 277
 278 capply :: (CoreExpr, CoreExpr) -> (CoreExpr, CoreExpr) -> VM (CoreExpr, CoreExpr)
 279 capply (vfn, lfn) (varg, larg)
 280   = do
 281       apply  <- builtin applyClosureVar
 282       applyP <- builtin applyClosurePVar
 283       return (mkApps (Var apply)  [Type arg_ty, Type res_ty, vfn, varg],
 284               mkApps (Var applyP) [Type arg_ty, Type res_ty, lfn, larg])
 285   where
 286     fn_ty            = exprType vfn
 287     (arg_ty, res_ty) = splitClosureTy fn_ty
 288
 289 vectVar :: CoreExpr -> Var -> VM (CoreExpr, CoreExpr)
 290 vectVar lc v = local v `orElseV` global v
 291   where
 292     local  v = maybeV (readLEnv $ \env -> lookupVarEnv (local_vars env) v)
 293     global v = do
 294                  vexpr <- maybeV (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
 295                  lexpr <- replicateP vexpr lc
 296                  return (vexpr, lexpr)
 297
 298 vectExpr :: CoreExpr -> CoreExprWithFVs -> VM (CoreExpr, CoreExpr)
 299 vectExpr lc (_, AnnType ty)
 300   = do
 301       vty <- vectType ty
 302       return (Type vty, Type vty)
 303 vectExpr lc (_, AnnVar v)   = vectVar lc v
 304 vectExpr lc (_, AnnLit lit)
 305   = do
 306       let vexpr = Lit lit
 307       lexpr <- replicateP vexpr lc
 308       return (vexpr, lexpr)
 309 vectExpr lc (_, AnnNote note expr)
 310   = do
 311       (vexpr, lexpr) <- vectExpr lc expr
 312       return (Note note vexpr, Note note lexpr)
 313 vectExpr lc (_, AnnApp fn arg)
 314   = do
 315       fn'  <- vectExpr lc fn
 316       arg' <- vectExpr lc arg
 317       capply fn' arg'
 318 vectExpr lc (_, AnnCase expr bndr ty alts)
 319   = panic "vectExpr: case"
 320 vectExpr lc (_, AnnLet (AnnNonRec bndr rhs) body)
 321   = do
 322       (vrhs, lrhs) <- vectExpr lc rhs
 323       (vbndr, lbndr, (vbody, lbody)) <- vectBndrIn bndr (vectExpr lc body)
 324       return (Let (NonRec vbndr vrhs) vbody,
 325               Let (NonRec lbndr lrhs) lbody)
 326 vectExpr lc (_, AnnLet (AnnRec prs) body)
 327   = do
 328       (vbndrs, lbndrs, (vrhss, vbody, lrhss, lbody)) <- vectBndrsIn bndrs vect
 329       return (Let (Rec (zip vbndrs vrhss)) vbody,
 330               Let (Rec (zip lbndrs lrhss)) lbody)
 331   where
 332     (bndrs, rhss) = unzip prs
 333
 334     vect = do
 335              (vrhss, lrhss) <- mapAndUnzipM (vectExpr lc) rhss
 336              (vbody, lbody) <- vectExpr lc body
 337              return (vrhss, vbody, lrhss, lbody)
 338
 339 -- ----------------------------------------------------------------------------
 340 -- PA dictionaries
 341
 342 paArgType :: Type -> Kind -> VM (Maybe Type)
 343 paArgType ty k
 344   | Just k' <- kindView k = paArgType ty k'
 345
 346 -- Here, we assume that for a kind (k1 -> k2) to be valid, k1 and k2 can only
 347 -- be made up of * and (->), i.e., they can't be coercion kinds or #.
 348 paArgType ty (FunTy k1 k2)
 349   = do
 350       tv  <- newTyVar FSLIT("a") k1
 351       ty1 <- paArgType' (TyVarTy tv) k1
 352       ty2 <- paArgType' (AppTy ty (TyVarTy tv)) k2
 353       return . Just $ ForAllTy tv (FunTy ty1 ty2)
 354
 355 paArgType ty k
 356   | isLiftedTypeKind k
 357   = do
 358       tc <- builtin paTyCon
 359       return . Just $ TyConApp tc [ty]
 360
 361   | otherwise
 362   = return Nothing
 363
 364 paArgType' :: Type -> Kind -> VM Type
 365 paArgType' ty k
 366   = do
 367       r <- paArgType ty k
 368       case r of
 369         Just ty' -> return ty'
 370         Nothing  -> pprPanic "paArgType'" (ppr ty)
 371
 372 paOfTyCon :: TyCon -> VM CoreExpr
 373 -- FIXME: just for now
 374 paOfTyCon tc = maybeV (readGEnv $ \env -> lookupNameEnv (global_tycon_pa env) (tyConName tc))
 375
 376 paOfType :: Type -> VM CoreExpr
 377 paOfType ty | Just ty' <- coreView ty = paOfType ty'
 378
 379 paOfType (TyVarTy tv) = maybeV (readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv)
 380 paOfType (AppTy ty1 ty2)
 381   = do
 382       e1 <- paOfType ty1
 383       e2 <- paOfType ty2
 384       return $ mkApps e1 [Type ty2, e2]
 385 paOfType (TyConApp tc tys)
 386   = do
 387       e  <- paOfTyCon tc
 388       es <- mapM paOfType tys
 389       return $ mkApps e [arg | (t,e) <- zip tys es, arg <- [Type t, e]]
 390 paOfType (FunTy ty1 ty2) = paOfType (TyConApp funTyCon [ty1,ty2])
 391 paOfType t@(ForAllTy tv ty) = pprPanic "paOfType:" (ppr t)
 392 paOfType ty = pprPanic "paOfType:" (ppr ty)
 393
 394
 395
 396 -- ----------------------------------------------------------------------------
 397 -- Types
 398
 399 vectTyCon :: TyCon -> VM TyCon
 400 vectTyCon tc
 401   | isFunTyCon tc        = builtin closureTyCon
 402   | isBoxedTupleTyCon tc = return tc
 403   | isUnLiftedTyCon tc   = return tc
 404   | otherwise = do
 405                   r <- lookupTyCon tc
 406                   case r of
 407                     Just tc' -> return tc'
 408
 409                     -- FIXME: just for now
 410                     Nothing  -> pprTrace "ccTyCon:" (ppr tc) $ return tc
 411
 412 vectType :: Type -> VM Type
 413 vectType ty | Just ty' <- coreView ty = vectType ty
 414 vectType (TyVarTy tv) = return $ TyVarTy tv
 415 vectType (AppTy ty1 ty2) = liftM2 AppTy (vectType ty1) (vectType ty2)
 416 vectType (TyConApp tc tys) = liftM2 TyConApp (vectTyCon tc) (mapM vectType tys)
 417 vectType (FunTy ty1 ty2)   = liftM2 TyConApp (builtin closureTyCon)
 418                                              (mapM vectType [ty1,ty2])
 419 vectType (ForAllTy tv ty)
 420   = do
 421       r   <- paArgType (TyVarTy tv) (tyVarKind tv)
 422       ty' <- vectType ty
 423       return . ForAllTy tv $ case r of { Just paty -> FunTy paty ty'; Nothing -> ty' }
 424
 425 vectType ty = pprPanic "vectType:" (ppr ty)
 426
 427 isClosureTyCon :: TyCon -> Bool
 428 isClosureTyCon tc = tyConUnique tc == closureTyConKey
 429
 430 splitClosureTy :: Type -> (Type, Type)
 431 splitClosureTy ty
 432   | Just (tc, [arg_ty, res_ty]) <- splitTyConApp_maybe ty
 433   , isClosureTyCon tc
 434   = (arg_ty, res_ty)
 435
 436   | otherwise = pprPanic "splitClosureTy" (ppr ty)
 437
 438 mkPArrayTy :: Type -> VM Type
 439 mkPArrayTy ty = do
 440                   tc <- builtin parrayTyCon
 441                   return $ TyConApp tc [ty]
 442