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