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
|
{-# LANGUAGE TupleSections #-}
-----------------------------------------------------------------------------
-- |
-- Module : GHC.StgToJS.ExprCtx
-- Copyright : (c) The University of Glasgow 2001
-- License : BSD-style (see the file LICENSE)
--
-- Maintainer : Jeffrey Young <jeffrey.young@iohk.io>
-- Luite Stegeman <luite.stegeman@iohk.io>
-- Sylvain Henry <sylvain.henry@iohk.io>
-- Josh Meredith <josh.meredith@iohk.io>
-- Stability : experimental
--
-- TODO: Write my description!
-----------------------------------------------------------------------------
module GHC.StgToJS.ExprCtx
( ExprCtx
, initExprCtx
, ctxIsEvaluated
, ctxSetSrcSpan
, ctxSrcSpan
, ctxSetTop
, ctxTarget
, ctxSetTarget
-- * Let-no-escape
, ctxClearLneFrame
, ctxUpdateLneFrame
, ctxLneFrameVars
, ctxLneFrameSize
, ctxIsLneBinding
, ctxIsLneLiveVar
, ctxLneBindingStackSize
, ctxLneShrinkStack
)
where
import GHC.Prelude
import GHC.StgToJS.Types
import GHC.Types.Unique.FM
import GHC.Types.Var
import GHC.Types.SrcLoc
import GHC.Types.Id
import GHC.Types.Id.Info
import GHC.Stg.InferTags.TagSig
import GHC.Utils.Outputable
import GHC.Utils.Panic
import Data.Maybe
-- | Context into which an expression is evaluated
data ExprCtx = ExprCtx
{ ctxTop :: Id
-- ^ Top-level binding Id
, ctxTarget :: [TypedExpr]
-- ^ Target variables for the evaluated expression
, ctxSrcSpan :: Maybe RealSrcSpan
-- ^ Source location
----------------------------
-- Handling of let-no-escape
, ctxLneFrameBs :: UniqFM Id Int
-- ^ LNE bindings with their expected stack size.
--
-- The Int is the size of the stack when the LNE binding was defined.
-- We need to shrink the stack back to this size when we enter one of the
-- associated binder rhs: it expects its free variables at certain offsets
-- in the stack.
, ctxLneFrameVars :: [(Id,Int)]
-- ^ Contents of current LNE frame
--
-- Variables and their index on the stack
, ctxLneFrameSize :: {-# UNPACK #-} !Int
-- ^ Cache the length of `ctxLneFrameVars`
}
-- | Initialize an expression context in the context of the given top-level
-- binding Id
initExprCtx :: Id -> ExprCtx
initExprCtx i = ExprCtx
{ ctxTop = i
, ctxTarget = []
, ctxLneFrameBs = emptyUFM
, ctxLneFrameVars = []
, ctxLneFrameSize = 0
, ctxSrcSpan = Nothing
}
-- | Set target
ctxSetTarget :: [TypedExpr] -> ExprCtx -> ExprCtx
ctxSetTarget t ctx = ctx { ctxTarget = t }
-- | Set top-level binding Id
ctxSetTop :: Id -> ExprCtx -> ExprCtx
ctxSetTop i ctx = ctx { ctxTop = i }
-- | Set source location
ctxSetSrcSpan :: RealSrcSpan -> ExprCtx -> ExprCtx
ctxSetSrcSpan span ctx = ctx { ctxSrcSpan = Just span }
-- | Update let-no-escape frame
ctxUpdateLneFrame :: [(Id,Int)] -> [Id] -> ExprCtx -> ExprCtx
ctxUpdateLneFrame new_spilled_vars new_lne_ids ctx =
let old_frame_size = ctxLneFrameSize ctx
new_frame_size = old_frame_size + length new_spilled_vars
in ctx
{ ctxLneFrameBs = addListToUFM (ctxLneFrameBs ctx) (map (,new_frame_size) new_lne_ids)
, ctxLneFrameSize = new_frame_size
, ctxLneFrameVars = ctxLneFrameVars ctx ++ new_spilled_vars
}
-- | Remove information about the current LNE frame
ctxClearLneFrame :: ExprCtx -> ExprCtx
ctxClearLneFrame ctx =
ctx
{ ctxLneFrameBs = emptyUFM
, ctxLneFrameVars = []
, ctxLneFrameSize = 0
}
-- | Predicate: do we know for sure that the given Id is evaluated?
ctxIsEvaluated :: Id -> Bool
ctxIsEvaluated i =
maybe False isTaggedSig (idTagSig_maybe i)
&& go (idDetails i)
where
go JoinId{} = False
go _ = True
-- DFunId new_type -> not new_type
-- -- DFuns terminate, unless the dict is implemented
-- -- with a newtype in which case they may not
-- DataConWorkId {} -> True
-- ClassOpId {} -> False
-- -- suppose an argument, and we don't have one
-- PrimOpId op _ -> primop_ok op
-- -- probably already handled by StgOpApp
-- JoinId {} -> False
-- -- Don't speculate join points
-- TickBoxOpId {} -> False
-- -- Don't speculate box ticking
-- -- Tagged (evaluated) ids
-- _ | Just sig <- idTagSig_maybe i
-- , isTaggedSig sig
-- -> True
-- _ -> False
-- | Does the given Id correspond to a LNE binding
ctxIsLneBinding :: ExprCtx -> Id -> Bool
ctxIsLneBinding ctx i = isJust (ctxLneBindingStackSize ctx i)
-- | Does the given Id correspond to a LNE live var on the stack
ctxIsLneLiveVar :: ExprCtx -> Id -> Bool
ctxIsLneLiveVar ctx i = i `elem` map fst (ctxLneFrameVars ctx)
-- | Return the LNE stack size associated to the given Id.
-- Return Nothing when the Id doesn't correspond to a LNE binding.
ctxLneBindingStackSize :: ExprCtx -> Id -> Maybe Int
ctxLneBindingStackSize ctx i = lookupUFM (ctxLneFrameBs ctx) i
-- | Shrink the LNE stack to the given size
ctxLneShrinkStack :: ExprCtx -> Int -> ExprCtx
ctxLneShrinkStack ctx n =
let l = ctxLneFrameSize ctx
in assertPpr
(l >= n)
(vcat [ text "ctxLneShrinkStack: let-no-escape stack too short:"
, ppr l
, text " < "
, ppr n
])
(ctx { ctxLneFrameVars = take n (ctxLneFrameVars ctx)
, ctxLneFrameSize = n
}
)
|
