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