summaryrefslogtreecommitdiff
path: root/compiler/vectorise/Vectorise/Env.hs
blob: 5014fd6272f383deb64dc16e2f06f5409e2e68e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212

module Vectorise.Env (
	Scope(..),

	-- * Local Environments
	LocalEnv(..),
	emptyLocalEnv,
	
	-- * Global Environments
	GlobalEnv(..),
	initGlobalEnv,
	extendImportedVarsEnv,
	extendScalars,
	setFamEnv,
        extendFamEnv,
	extendTyConsEnv,
	extendDataConsEnv,
	extendPAFunsEnv,
	setPRFunsEnv,
	setBoxedTyConsEnv,
	updVectInfo
) where

import HscTypes
import InstEnv
import FamInstEnv
import CoreSyn
import Type
import TyCon
import DataCon
import VarEnv
import VarSet
import Var
import Name
import NameEnv
import FastString


-- | Indicates what scope something (a variable) is in.
data Scope a b 
	= Global a 
	| Local  b


-- LocalEnv -------------------------------------------------------------------
-- | The local environment.
data LocalEnv
	= LocalEnv {
        -- Mapping from local variables to their vectorised and lifted versions.
            local_vars		:: VarEnv (Var, Var)

        -- In-scope type variables.
        , local_tyvars		:: [TyVar]

        -- Mapping from tyvars to their PA dictionaries.
        , local_tyvar_pa	:: VarEnv CoreExpr

        -- Local binding name.
        , local_bind_name	:: FastString
        }


-- | Create an empty local environment.
emptyLocalEnv :: LocalEnv
emptyLocalEnv = LocalEnv {
                   local_vars     = emptyVarEnv
                 , local_tyvars   = []
                 , local_tyvar_pa = emptyVarEnv
                 , local_bind_name  = fsLit "fn"
                 }


-- GlobalEnv ------------------------------------------------------------------
-- | The global environment.
--      These are things the exist at top-level.
data GlobalEnv 
        = GlobalEnv {
        -- | Mapping from global variables to their vectorised versions — aka the /vectorisation
        --   map/.
          global_vars           :: VarEnv Var

        -- | Mapping from global variables that have a vectorisation declaration to the right-hand
        --   side of that declaration and its type.  This mapping only applies to non-scalar
        --   vectorisation declarations.  All variables with a scalar vectorisation declaration are
        --   mentioned in 'global_scalars'.
        , global_vect_decls     :: VarEnv (Type, CoreExpr)

        -- | Purely scalar variables. Code which mentions only these variables doesn't have to be
        --   lifted.  This includes variables from the current module that have a scalar
        --   vectorisation declaration and those that the vectoriser determines to be scalar.
        , global_scalars        :: VarSet

        -- | Exported variables which have a vectorised version.
        , global_exported_vars	:: VarEnv (Var, Var)

        -- | Mapping from TyCons to their vectorised versions.
        --   TyCons which do not have to be vectorised are mapped to themselves.
        , global_tycons		:: NameEnv TyCon

        -- | Mapping from DataCons to their vectorised versions.
        , global_datacons       :: NameEnv DataCon

        -- | Mapping from TyCons to their PA dfuns.
        , global_pa_funs        :: NameEnv Var

        -- | Mapping from TyCons to their PR dfuns.
        , global_pr_funs	:: NameEnv Var

        -- | Mapping from unboxed TyCons to their boxed versions.
        , global_boxed_tycons	:: NameEnv TyCon

        -- | External package inst-env & home-package inst-env for class instances.
        , global_inst_env	:: (InstEnv, InstEnv)

        -- | External package inst-env & home-package inst-env for family instances.
        , global_fam_inst_env	:: FamInstEnvs

        -- | Hoisted bindings.
        , global_bindings	:: [(Var, CoreExpr)]
        }

-- | Create an initial global environment
initGlobalEnv :: VectInfo -> [CoreVect] -> (InstEnv, InstEnv) -> FamInstEnvs -> GlobalEnv
initGlobalEnv info vectDecls instEnvs famInstEnvs
  = GlobalEnv 
  { global_vars          = mapVarEnv snd $ vectInfoVar info
  , global_vect_decls    = mkVarEnv vects
  , global_scalars       = mkVarSet scalars
  , global_exported_vars = emptyVarEnv
  , global_tycons        = mapNameEnv snd $ vectInfoTyCon info
  , global_datacons      = mapNameEnv snd $ vectInfoDataCon info
  , global_pa_funs       = mapNameEnv snd $ vectInfoPADFun info
  , global_pr_funs       = emptyNameEnv
  , global_boxed_tycons  = emptyNameEnv
  , global_inst_env      = instEnvs
  , global_fam_inst_env  = famInstEnvs
  , global_bindings      = []
  }
  where
    vects   = [(var, (varType var, exp)) | Vect var (Just exp) <- vectDecls]
    scalars = [var                       | Vect var Nothing    <- vectDecls]


-- Operators on Global Environments -------------------------------------------
-- | Extend the list of global variables in an environment.
extendImportedVarsEnv :: [(Var, Var)] -> GlobalEnv -> GlobalEnv
extendImportedVarsEnv ps genv
  = genv { global_vars	 = extendVarEnvList (global_vars genv) ps }

-- | Extend the set of scalar variables in an environment.
extendScalars :: [Var] -> GlobalEnv -> GlobalEnv
extendScalars vs genv
  = genv { global_scalars = extendVarSetList (global_scalars genv) vs }

-- | Set the list of type family instances in an environment.
setFamEnv :: FamInstEnv -> GlobalEnv -> GlobalEnv
setFamEnv l_fam_inst genv
  = genv { global_fam_inst_env = (g_fam_inst, l_fam_inst) }
  where (g_fam_inst, _) = global_fam_inst_env genv

extendFamEnv :: [FamInst] -> GlobalEnv -> GlobalEnv
extendFamEnv new genv
  = genv { global_fam_inst_env = (g_fam_inst, extendFamInstEnvList l_fam_inst new) }
  where (g_fam_inst, l_fam_inst) = global_fam_inst_env genv


-- | Extend the list of type constructors in an environment.
extendTyConsEnv :: [(Name, TyCon)] -> GlobalEnv -> GlobalEnv
extendTyConsEnv ps genv
  = genv { global_tycons = extendNameEnvList (global_tycons genv) ps }


-- | Extend the list of data constructors in an environment.
extendDataConsEnv :: [(Name, DataCon)] -> GlobalEnv -> GlobalEnv
extendDataConsEnv ps genv
  = genv { global_datacons = extendNameEnvList (global_datacons genv) ps }


-- | Extend the list of PA functions in an environment.
extendPAFunsEnv :: [(Name, Var)] -> GlobalEnv -> GlobalEnv
extendPAFunsEnv ps genv
  = genv { global_pa_funs = extendNameEnvList (global_pa_funs genv) ps }


-- | Set the list of PR functions in an environment.
setPRFunsEnv :: [(Name, Var)] -> GlobalEnv -> GlobalEnv
setPRFunsEnv ps genv
  = genv { global_pr_funs = mkNameEnv ps }


-- | Set the list of boxed type constructor in an environment.
setBoxedTyConsEnv :: [(Name, TyCon)] -> GlobalEnv -> GlobalEnv
setBoxedTyConsEnv ps genv
  = genv { global_boxed_tycons = mkNameEnv ps }


-- | TODO: What is this for?
updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
updVectInfo env tyenv info
  = info 
    { vectInfoVar     = global_exported_vars env
    , vectInfoTyCon   = mk_env typeEnvTyCons global_tycons
    , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
    , vectInfoPADFun  = mk_env typeEnvTyCons global_pa_funs
    }
  where
    mk_env from_tyenv from_env 
	= mkNameEnv [(name, (from,to))
                        | from     <- from_tyenv tyenv
                        , let name =  getName from
                        , Just to  <- [lookupNameEnv (from_env env) name]]