compiler/vectorise/Vectorise.hs

   1 module Vectorise( vectorise )
   2 where
   3
   4 #include "HsVersions.h"
   5
   6 import VectMonad
   7 import VectUtils
   8 import VectType
   9
  10 import DynFlags
  11 import HscTypes
  12
  13 import CoreLint             ( showPass, endPass )
  14 import CoreSyn
  15 import CoreUtils
  16 import CoreFVs
  17 import SimplMonad           ( SimplCount, zeroSimplCount )
  18 import Rules                ( RuleBase )
  19 import DataCon
  20 import TyCon
  21 import Type
  22 import FamInstEnv           ( extendFamInstEnvList )
  23 import InstEnv              ( extendInstEnvList )
  24 import Var
  25 import VarEnv
  26 import VarSet
  27 import Name                 ( mkSysTvName, getName )
  28 import NameEnv
  29 import Id
  30 import MkId                 ( unwrapFamInstScrut )
  31 import OccName
  32
  33 import DsMonad hiding (mapAndUnzipM)
  34 import DsUtils              ( mkCoreTup, mkCoreTupTy )
  35
  36 import PrelNames
  37 import TysWiredIn
  38 import TysPrim              ( intPrimTy )
  39 import BasicTypes           ( Boxity(..) )
  40
  41 import Outputable
  42 import FastString
  43 import Control.Monad        ( liftM, liftM2, mapAndUnzipM )
  44
  45 vectorise :: HscEnv -> UniqSupply -> RuleBase -> ModGuts
  46           -> IO (SimplCount, ModGuts)
  47 vectorise hsc_env _ _ guts
  48   = do
  49       showPass dflags "Vectorisation"
  50       eps <- hscEPS hsc_env
  51       let info = hptVectInfo hsc_env `plusVectInfo` eps_vect_info eps
  52       Just (info', guts') <- initV hsc_env guts info (vectModule guts)
  53       endPass dflags "Vectorisation" Opt_D_dump_vect (mg_binds guts')
  54       return (zeroSimplCount dflags, guts' { mg_vect_info = info' })
  55   where
  56     dflags = hsc_dflags hsc_env
  57
  58 vectModule :: ModGuts -> VM ModGuts
  59 vectModule guts
  60   = do
  61       (types', fam_insts, insts) <- vectTypeEnv (mg_types guts)
  62
  63       let fam_inst_env' = extendFamInstEnvList (mg_fam_inst_env guts) fam_insts
  64           inst_env'     = extendInstEnvList (mg_inst_env guts) insts
  65       updGEnv (setInstEnvs inst_env' fam_inst_env')
  66
  67       binds' <- mapM vectTopBind (mg_binds guts)
  68       return $ guts { mg_types        = types'
  69                     , mg_binds        = binds'
  70                     , mg_inst_env     = inst_env'
  71                     , mg_fam_inst_env = fam_inst_env'
  72                     , mg_insts        = mg_insts guts ++ insts
  73                     , mg_fam_insts    = mg_fam_insts guts ++ fam_insts
  74                     }
  75
  76 vectTopBind :: CoreBind -> VM CoreBind
  77 vectTopBind b@(NonRec var expr)
  78   = do
  79       var'  <- vectTopBinder var
  80       expr' <- vectTopRhs expr
  81       hs    <- takeHoisted
  82       return . Rec $ (var, expr) : (var', expr') : hs
  83   `orElseV`
  84     return b
  85
  86 vectTopBind b@(Rec bs)
  87   = do
  88       vars'  <- mapM vectTopBinder vars
  89       exprs' <- mapM vectTopRhs exprs
  90       hs     <- takeHoisted
  91       return . Rec $ bs ++ zip vars' exprs' ++ hs
  92   `orElseV`
  93     return b
  94   where
  95     (vars, exprs) = unzip bs
  96
  97 vectTopBinder :: Var -> VM Var
  98 vectTopBinder var
  99   = do
 100       vty <- vectType (idType var)
 101       name <- cloneName mkVectOcc (getName var)
 102       let var' | isExportedId var = Id.mkExportedLocalId name vty
 103                | otherwise        = Id.mkLocalId         name vty
 104       defGlobalVar var var'
 105       return var'
 106
 107 vectTopRhs :: CoreExpr -> VM CoreExpr
 108 vectTopRhs = liftM fst . closedV . vectPolyExpr (panic "Empty lifting context") . freeVars
 109
 110 -- ----------------------------------------------------------------------------
 111 -- Bindings
 112
 113 vectBndr :: Var -> VM (Var, Var)
 114 vectBndr v
 115   = do
 116       vty <- vectType (idType v)
 117       lty <- mkPArrayType vty
 118       let vv = v `Id.setIdType` vty
 119           lv = v `Id.setIdType` lty
 120       updLEnv (mapTo vv lv)
 121       return (vv, lv)
 122   where
 123     mapTo vv lv env = env { local_vars = extendVarEnv (local_vars env) v (Var vv, Var lv) }
 124
 125 vectBndrIn :: Var -> VM a -> VM (Var, Var, a)
 126 vectBndrIn v p
 127   = localV
 128   $ do
 129       (vv, lv) <- vectBndr v
 130       x <- p
 131       return (vv, lv, x)
 132
 133 vectBndrsIn :: [Var] -> VM a -> VM ([Var], [Var], a)
 134 vectBndrsIn vs p
 135   = localV
 136   $ do
 137       (vvs, lvs) <- mapAndUnzipM vectBndr vs
 138       x <- p
 139       return (vvs, lvs, x)
 140
 141 -- ----------------------------------------------------------------------------
 142 -- Expressions
 143
 144 capply :: (CoreExpr, CoreExpr) -> (CoreExpr, CoreExpr) -> VM (CoreExpr, CoreExpr)
 145 capply (vfn, lfn) (varg, larg)
 146   = do
 147       apply  <- builtin applyClosureVar
 148       applyP <- builtin applyClosurePVar
 149       return (mkApps (Var apply)  [Type arg_ty, Type res_ty, vfn, varg],
 150               mkApps (Var applyP) [Type arg_ty, Type res_ty, lfn, larg])
 151   where
 152     fn_ty            = exprType vfn
 153     (arg_ty, res_ty) = splitClosureTy fn_ty
 154
 155 vectVar :: CoreExpr -> Var -> VM (CoreExpr, CoreExpr)
 156 vectVar lc v
 157   = do
 158       r <- lookupVar v
 159       case r of
 160         Local es     -> return es
 161         Global vexpr -> do
 162                           lexpr <- replicatePA vexpr lc
 163                           return (vexpr, lexpr)
 164
 165 vectPolyVar :: CoreExpr -> Var -> [Type] -> VM (CoreExpr, CoreExpr)
 166 vectPolyVar lc v tys
 167   = do
 168       r <- lookupVar v
 169       case r of
 170         Local (vexpr, lexpr) -> liftM2 (,) (mk_app vexpr) (mk_app lexpr)
 171         Global poly          -> do
 172                                   vexpr <- mk_app poly
 173                                   lexpr <- replicatePA vexpr lc
 174                                   return (vexpr, lexpr)
 175   where
 176     mk_app e = applyToTypes e =<< mapM vectType tys
 177
 178 vectPolyExpr :: CoreExpr -> CoreExprWithFVs -> VM (CoreExpr, CoreExpr)
 179 vectPolyExpr lc expr
 180   = localV
 181   . abstractOverTyVars tvs $ \mk_lams ->
 182     -- FIXME: shadowing (tvs in lc)
 183     do
 184       (vmono, lmono) <- vectExpr lc mono
 185       return $ (mk_lams vmono, mk_lams lmono)
 186   where
 187     (tvs, mono) = collectAnnTypeBinders expr
 188
 189 vectExpr :: CoreExpr -> CoreExprWithFVs -> VM (CoreExpr, CoreExpr)
 190 vectExpr lc (_, AnnType ty)
 191   = do
 192       vty <- vectType ty
 193       return (Type vty, Type vty)
 194
 195 vectExpr lc (_, AnnVar v)   = vectVar lc v
 196
 197 vectExpr lc (_, AnnLit lit)
 198   = do
 199       let vexpr = Lit lit
 200       lexpr <- replicatePA vexpr lc
 201       return (vexpr, lexpr)
 202
 203 vectExpr lc (_, AnnNote note expr)
 204   = do
 205       (vexpr, lexpr) <- vectExpr lc expr
 206       return (Note note vexpr, Note note lexpr)
 207
 208 vectExpr lc e@(_, AnnApp _ arg)
 209   | isAnnTypeArg arg
 210   = vectTyAppExpr lc fn tys
 211   where
 212     (fn, tys) = collectAnnTypeArgs e
 213
 214 vectExpr lc (_, AnnApp fn arg)
 215   = do
 216       fn'  <- vectExpr lc fn
 217       arg' <- vectExpr lc arg
 218       capply fn' arg'
 219
 220 vectExpr lc (_, AnnCase expr bndr ty alts)
 221   = panic "vectExpr: case"
 222
 223 vectExpr lc (_, AnnLet (AnnNonRec bndr rhs) body)
 224   = do
 225       (vrhs, lrhs) <- vectPolyExpr lc rhs
 226       (vbndr, lbndr, (vbody, lbody)) <- vectBndrIn bndr (vectExpr lc body)
 227       return (Let (NonRec vbndr vrhs) vbody,
 228               Let (NonRec lbndr lrhs) lbody)
 229
 230 vectExpr lc (_, AnnLet (AnnRec prs) body)
 231   = do
 232       (vbndrs, lbndrs, (vrhss, vbody, lrhss, lbody)) <- vectBndrsIn bndrs vect
 233       return (Let (Rec (zip vbndrs vrhss)) vbody,
 234               Let (Rec (zip lbndrs lrhss)) lbody)
 235   where
 236     (bndrs, rhss) = unzip prs
 237
 238     vect = do
 239              (vrhss, lrhss) <- mapAndUnzipM (vectExpr lc) rhss
 240              (vbody, lbody) <- vectPolyExpr lc body
 241              return (vrhss, vbody, lrhss, lbody)
 242
 243 vectExpr lc e@(_, AnnLam bndr body)
 244   | isTyVar bndr = pprPanic "vectExpr" (ppr $ deAnnotate e)
 245
 246 vectExpr lc (fvs, AnnLam bndr body)
 247   = do
 248       tyvars <- localTyVars
 249       info <- mkCEnvInfo fvs bndr body
 250       (poly_vfn, poly_lfn) <- mkClosureFns info tyvars bndr body
 251
 252       vfn_var <- hoistExpr FSLIT("vfn") poly_vfn
 253       lfn_var <- hoistExpr FSLIT("lfn") poly_lfn
 254
 255       let (venv, lenv) = mkClosureEnvs info lc
 256
 257       let env_ty = cenv_vty info
 258
 259       pa_dict <- paDictOfType env_ty
 260
 261       arg_ty <- vectType (varType bndr)
 262       res_ty <- vectType (exprType $ deAnnotate body)
 263
 264       -- FIXME: move the functions to the top level
 265       mono_vfn <- applyToTypes (Var vfn_var) (mkTyVarTys tyvars)
 266       mono_lfn <- applyToTypes (Var lfn_var) (mkTyVarTys tyvars)
 267
 268       mk_clo <- builtin mkClosureVar
 269       mk_cloP <- builtin mkClosurePVar
 270
 271       let vclo = Var mk_clo  `mkTyApps` [arg_ty, res_ty, env_ty]
 272                              `mkApps`   [pa_dict, mono_vfn, mono_lfn, venv]
 273
 274           lclo = Var mk_cloP `mkTyApps` [arg_ty, res_ty, env_ty]
 275                              `mkApps`   [pa_dict, mono_vfn, mono_lfn, lenv]
 276
 277       return (vclo, lclo)
 278
 279
 280 data CEnvInfo = CEnvInfo {
 281                cenv_vars         :: [Var]
 282              , cenv_values       :: [(CoreExpr, CoreExpr)]
 283              , cenv_vty          :: Type
 284              , cenv_lty          :: Type
 285              , cenv_repr_tycon   :: TyCon
 286              , cenv_repr_tyargs  :: [Type]
 287              , cenv_repr_datacon :: DataCon
 288              }
 289
 290 mkCEnvInfo :: VarSet -> Var -> CoreExprWithFVs -> VM CEnvInfo
 291 mkCEnvInfo fvs arg body
 292   = do
 293       locals <- readLEnv local_vars
 294       let
 295           (vars, vals) = unzip
 296                  [(var, val) | var      <- varSetElems fvs
 297                              , Just val <- [lookupVarEnv locals var]]
 298       vtys <- mapM (vectType . varType) vars
 299
 300       (vty, repr_tycon, repr_tyargs, repr_datacon) <- mk_env_ty vtys
 301       lty <- mkPArrayType vty
 302
 303       return $ CEnvInfo {
 304                  cenv_vars         = vars
 305                , cenv_values       = vals
 306                , cenv_vty          = vty
 307                , cenv_lty          = lty
 308                , cenv_repr_tycon   = repr_tycon
 309                , cenv_repr_tyargs  = repr_tyargs
 310                , cenv_repr_datacon = repr_datacon
 311                }
 312   where
 313     mk_env_ty [vty]
 314       = return (vty, error "absent cinfo_repr_tycon"
 315                    , error "absent cinfo_repr_tyargs"
 316                    , error "absent cinfo_repr_datacon")
 317
 318     mk_env_ty vtys
 319       = do
 320           let ty = mkCoreTupTy vtys
 321           (repr_tc, repr_tyargs) <- lookupPArrayFamInst ty
 322           let [repr_con] = tyConDataCons repr_tc
 323           return (ty, repr_tc, repr_tyargs, repr_con)
 324
 325
 326
 327 mkClosureEnvs :: CEnvInfo -> CoreExpr -> (CoreExpr, CoreExpr)
 328 mkClosureEnvs info lc
 329   | [] <- vals
 330   = (Var unitDataConId, mkApps (Var $ dataConWrapId (cenv_repr_datacon info))
 331                                [lc, Var unitDataConId])
 332
 333   | [(vval, lval)] <- vals
 334   = (vval, lval)
 335
 336   | otherwise
 337   = (mkCoreTup vvals, Var (dataConWrapId $ cenv_repr_datacon info)
 338                       `mkTyApps` cenv_repr_tyargs info
 339                       `mkApps`   (lc : lvals))
 340
 341   where
 342     vals = cenv_values info
 343     (vvals, lvals) = unzip vals
 344
 345 mkClosureFns :: CEnvInfo -> [TyVar] -> Var -> CoreExprWithFVs
 346              -> VM (CoreExpr, CoreExpr)
 347 mkClosureFns info tyvars arg body
 348   = closedV
 349   . abstractOverTyVars tyvars
 350   $ \mk_tlams ->
 351   do
 352     (vfn, lfn) <- mkClosureMonoFns info arg body
 353     return (mk_tlams vfn, mk_tlams lfn)
 354
 355 mkClosureMonoFns :: CEnvInfo -> Var -> CoreExprWithFVs -> VM (CoreExpr, CoreExpr)
 356 mkClosureMonoFns info arg body
 357   = do
 358       lc_bndr <- newLocalVar FSLIT("lc") intPrimTy
 359       (varg : vbndrs, larg : lbndrs, (vbody, lbody))
 360         <- vectBndrsIn (arg : cenv_vars info)
 361                        (vectExpr (Var lc_bndr) body)
 362
 363       venv_bndr <- newLocalVar FSLIT("env") vty
 364       lenv_bndr <- newLocalVar FSLIT("env") lty
 365
 366       let vcase = bind_venv (Var venv_bndr) vbody vbndrs
 367       lcase <- bind_lenv (Var lenv_bndr) lbody lc_bndr lbndrs
 368       return (mkLams [venv_bndr, varg] vcase, mkLams [lenv_bndr, larg] lcase)
 369   where
 370     vty = cenv_vty info
 371     lty = cenv_lty info
 372
 373     arity = length (cenv_vars info)
 374
 375     bind_venv venv vbody []      = vbody
 376     bind_venv venv vbody [vbndr] = Let (NonRec vbndr venv) vbody
 377     bind_venv venv vbody vbndrs
 378       = Case venv (mkWildId vty) (exprType vbody)
 379              [(DataAlt (tupleCon Boxed arity), vbndrs, vbody)]
 380
 381     bind_lenv lenv lbody lc_bndr [lbndr]
 382       = do
 383           len <- lengthPA (Var lbndr)
 384           return . Let (NonRec lbndr lenv)
 385                  $ Case len
 386                         lc_bndr
 387                         (exprType lbody)
 388                         [(DEFAULT, [], lbody)]
 389
 390     bind_lenv lenv lbody lc_bndr lbndrs
 391       = let scrut = unwrapFamInstScrut (cenv_repr_tycon info)
 392                                        (cenv_repr_tyargs info)
 393                                        lenv
 394             lbndrs' | null lbndrs = [mkWildId unitTy]
 395                     | otherwise   = lbndrs
 396         in
 397         return
 398       $ Case scrut
 399              (mkWildId (exprType scrut))
 400              (exprType lbody)
 401              [(DataAlt (cenv_repr_datacon info), lc_bndr : lbndrs', lbody)]
 402
 403 vectTyAppExpr :: CoreExpr -> CoreExprWithFVs -> [Type] -> VM (CoreExpr, CoreExpr)
 404 vectTyAppExpr lc (_, AnnVar v) tys = vectPolyVar lc v tys
 405 vectTyAppExpr lc e tys = pprPanic "vectTyAppExpr" (ppr $ deAnnotate e)
 406