2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[StgSyn]{Shared term graph (STG) syntax for spineless-tagless code generation}
6 This data type represents programs just before code generation
7 (conversion to @AbstractC@): basically, what we have is a stylised
8 form of @CoreSyntax@, the style being one that happens to be ideally
9 suited to spineless tagless code generation.
16 GenStgBinding(..), GenStgExpr(..), GenStgRhs(..),
17 GenStgAlt, AltType(..),
19 UpdateFlag(..), isUpdatable,
22 noBinderInfo, stgSatOcc, stgUnsatOcc, satCallsOnly,
25 -- a set of synonyms for the most common (only :-) parameterisation
27 StgBinding, StgExpr, StgRhs, StgAlt,
36 stgBindHasCafRefs, stgArgHasCafRefs, stgRhsArity,
37 isDllConApp, isStgTypeArg,
40 pprStgBinding, pprStgBindings, pprStgBindingsWithSRTs
47 #include "HsVersions.h"
49 import CostCentre ( CostCentreStack, CostCentre )
50 import VarSet ( IdSet, isEmptyVarSet )
52 import Id ( Id, idName, idType, idCafInfo )
53 import IdInfo ( mayHaveCafRefs )
54 import Packages ( isDllName )
55 import Literal ( Literal, literalType )
56 import ForeignCall ( ForeignCall )
57 import DataCon ( DataCon, dataConName )
58 import CoreSyn ( AltCon )
59 import PprCore ( {- instances -} )
60 import PrimOp ( PrimOp )
64 import TyCon ( TyCon )
66 import Unique ( Unique )
68 import StaticFlags ( opt_SccProfilingOn )
73 %************************************************************************
75 \subsection{@GenStgBinding@}
77 %************************************************************************
79 As usual, expressions are interesting; other things are boring. Here
80 are the boring things [except note the @GenStgRhs@], parameterised
81 with respect to binder and occurrence information (just as in
84 There is one SRT for each group of bindings.
87 data GenStgBinding bndr occ
88 = StgNonRec bndr (GenStgRhs bndr occ)
89 | StgRec [(bndr, GenStgRhs bndr occ)]
92 %************************************************************************
94 \subsection{@GenStgArg@}
96 %************************************************************************
102 | StgTypeArg Type -- For when we want to preserve all type info
106 isStgTypeArg :: StgArg -> Bool
107 isStgTypeArg (StgTypeArg _) = True
108 isStgTypeArg _ = False
110 isDllArg :: PackageId -> StgArg -> Bool
111 -- Does this argument refer to something in a different DLL?
112 isDllArg this_pkg (StgVarArg v) = isDllName this_pkg (idName v)
115 isDllConApp :: PackageId -> DataCon -> [StgArg] -> Bool
116 -- Does this constructor application refer to
117 -- anything in a different DLL?
118 -- If so, we can't allocate it statically
119 isDllConApp this_pkg con args
120 = isDllName this_pkg (dataConName con) || any (isDllArg this_pkg) args
122 stgArgType :: StgArg -> Type
123 -- Very half baked becase we have lost the type arguments
124 stgArgType (StgVarArg v) = idType v
125 stgArgType (StgLitArg lit) = literalType lit
126 stgArgType (StgTypeArg _) = panic "stgArgType called on stgTypeArg"
129 %************************************************************************
131 \subsection{STG expressions}
133 %************************************************************************
135 The @GenStgExpr@ data type is parameterised on binder and occurrence
138 %************************************************************************
140 \subsubsection{@GenStgExpr@ application}
142 %************************************************************************
144 An application is of a function to a list of atoms [not expressions].
145 Operationally, we want to push the arguments on the stack and call the
146 function. (If the arguments were expressions, we would have to build
147 their closures first.)
149 There is no constructor for a lone variable; it would appear as
152 type GenStgLiveVars occ = UniqSet occ
154 data GenStgExpr bndr occ
157 [GenStgArg occ] -- arguments; may be empty
160 %************************************************************************
162 \subsubsection{@StgConApp@ and @StgPrimApp@---saturated applications}
164 %************************************************************************
166 There are a specialised forms of application, for
167 constructors, primitives, and literals.
171 -- StgConApp is vital for returning unboxed tuples
172 -- which can't be let-bound first
174 [GenStgArg occ] -- Saturated
176 | StgOpApp StgOp -- Primitive op or foreign call
177 [GenStgArg occ] -- Saturated
179 -- We need to know this so that we can
180 -- assign result registers
183 %************************************************************************
185 \subsubsection{@StgLam@}
187 %************************************************************************
189 StgLam is used *only* during CoreToStg's work. Before CoreToStg has finished
190 it encodes (\x -> e) as (let f = \x -> e in f)
194 Type -- Type of whole lambda (useful when making a binder for it)
196 StgExpr -- Body of lambda
200 %************************************************************************
202 \subsubsection{@GenStgExpr@: case-expressions}
204 %************************************************************************
206 This has the same boxed/unboxed business as Core case expressions.
209 (GenStgExpr bndr occ)
210 -- the thing to examine
212 (GenStgLiveVars occ) -- Live vars of whole case expression,
213 -- plus everything that happens after the case
214 -- i.e., those which mustn't be overwritten
216 (GenStgLiveVars occ) -- Live vars of RHSs (plus what happens afterwards)
217 -- i.e., those which must be saved before eval.
219 -- note that an alt's constructor's
220 -- binder-variables are NOT counted in the
221 -- free vars for the alt's RHS
223 bndr -- binds the result of evaluating the scrutinee
225 SRT -- The SRT for the continuation
229 [GenStgAlt bndr occ] -- The DEFAULT case is always *first*
230 -- if it is there at all
233 %************************************************************************
235 \subsubsection{@GenStgExpr@: @let(rec)@-expressions}
237 %************************************************************************
239 The various forms of let(rec)-expression encode most of the
240 interesting things we want to do.
244 let-closure x = [free-vars] expr [args]
249 let x = (\free-vars -> \args -> expr) free-vars
251 \tr{args} may be empty (and is for most closures). It isn't under
252 circumstances like this:
258 let-closure x = [z] [y] (y+z)
260 The idea is that we compile code for @(y+z)@ in an environment in which
261 @z@ is bound to an offset from \tr{Node}, and @y@ is bound to an
262 offset from the stack pointer.
264 (A let-closure is an @StgLet@ with a @StgRhsClosure@ RHS.)
268 let-constructor x = Constructor [args]
272 (A let-constructor is an @StgLet@ with a @StgRhsCon@ RHS.)
275 Letrec-expressions are essentially the same deal as
276 let-closure/let-constructor, so we use a common structure and
277 distinguish between them with an @is_recursive@ boolean flag.
281 let-unboxed u = an arbitrary arithmetic expression in unboxed values
284 All the stuff on the RHS must be fully evaluated. No function calls either!
286 (We've backed away from this toward case-expressions with
287 suitably-magical alts ...)
290 ~[Advanced stuff here! Not to start with, but makes pattern matching
291 generate more efficient code.]
294 let-escapes-not fail = expr
297 Here the idea is that @e'@ guarantees not to put @fail@ in a data structure,
298 or pass it to another function. All @e'@ will ever do is tail-call @fail@.
299 Rather than build a closure for @fail@, all we need do is to record the stack
300 level at the moment of the @let-escapes-not@; then entering @fail@ is just
301 a matter of adjusting the stack pointer back down to that point and entering
306 f x y = let z = huge-expression in
312 (A let-escapes-not is an @StgLetNoEscape@.)
315 We may eventually want:
317 let-literal x = Literal
321 (ToDo: is this obsolete?)
324 And so the code for let(rec)-things:
327 (GenStgBinding bndr occ) -- right hand sides (see below)
328 (GenStgExpr bndr occ) -- body
330 | StgLetNoEscape -- remember: ``advanced stuff''
331 (GenStgLiveVars occ) -- Live in the whole let-expression
332 -- Mustn't overwrite these stack slots
333 -- *Doesn't* include binders of the let(rec).
335 (GenStgLiveVars occ) -- Live in the right hand sides (only)
336 -- These are the ones which must be saved on
337 -- the stack if they aren't there already
338 -- *Does* include binders of the let(rec) if recursive.
340 (GenStgBinding bndr occ) -- right hand sides (see below)
341 (GenStgExpr bndr occ) -- body
344 %************************************************************************
346 \subsubsection{@GenStgExpr@: @scc@ expressions}
348 %************************************************************************
350 Finally for @scc@ expressions we introduce a new STG construct.
354 CostCentre -- label of SCC expression
355 (GenStgExpr bndr occ) -- scc expression
358 %************************************************************************
360 \subsubsection{@GenStgExpr@: @hpc@ expressions}
362 %************************************************************************
364 Finally for @scc@ expressions we introduce a new STG construct.
368 Module -- the module of the source of this tick
370 (GenStgExpr bndr occ) -- sub expression
374 %************************************************************************
376 \subsection{STG right-hand sides}
378 %************************************************************************
380 Here's the rest of the interesting stuff for @StgLet@s; the first
381 flavour is for closures:
383 data GenStgRhs bndr occ
385 CostCentreStack -- CCS to be attached (default is CurrentCCS)
386 StgBinderInfo -- Info about how this binder is used (see below)
387 [occ] -- non-global free vars; a list, rather than
388 -- a set, because order is important
389 !UpdateFlag -- ReEntrant | Updatable | SingleEntry
390 SRT -- The SRT reference
391 [bndr] -- arguments; if empty, then not a function;
392 -- as above, order is important.
393 (GenStgExpr bndr occ) -- body
395 An example may be in order. Consider:
397 let t = \x -> \y -> ... x ... y ... p ... q in e
399 Pulling out the free vars and stylising somewhat, we get the equivalent:
401 let t = (\[p,q] -> \[x,y] -> ... x ... y ... p ...q) p q
403 Stg-operationally, the @[x,y]@ are on the stack, the @[p,q]@ are
404 offsets from @Node@ into the closure, and the code ptr for the closure
405 will be exactly that in parentheses above.
407 The second flavour of right-hand-side is for constructors (simple but important):
410 CostCentreStack -- CCS to be attached (default is CurrentCCS).
411 -- Top-level (static) ones will end up with
412 -- DontCareCCS, because we don't count static
413 -- data in heap profiles, and we don't set CCCS
414 -- from static closure.
415 DataCon -- constructor
416 [GenStgArg occ] -- args
420 stgRhsArity :: StgRhs -> Int
421 stgRhsArity (StgRhsClosure _ _ _ _ _ bndrs _) = count isId bndrs
422 -- The arity never includes type parameters, so
423 -- when keeping type arguments and binders in the Stg syntax
424 -- (opt_RuntimeTypes) we have to fliter out the type binders.
425 stgRhsArity (StgRhsCon _ _ _) = 0
429 stgBindHasCafRefs :: GenStgBinding bndr Id -> Bool
430 stgBindHasCafRefs (StgNonRec _ rhs) = rhsHasCafRefs rhs
431 stgBindHasCafRefs (StgRec binds) = any rhsHasCafRefs (map snd binds)
433 rhsHasCafRefs :: GenStgRhs bndr Id -> Bool
434 rhsHasCafRefs (StgRhsClosure _ _ _ upd srt _ _)
435 = isUpdatable upd || nonEmptySRT srt
436 rhsHasCafRefs (StgRhsCon _ _ args)
437 = any stgArgHasCafRefs args
439 stgArgHasCafRefs :: GenStgArg Id -> Bool
440 stgArgHasCafRefs (StgVarArg id) = mayHaveCafRefs (idCafInfo id)
441 stgArgHasCafRefs _ = False
444 Here's the @StgBinderInfo@ type, and its combining op:
448 | SatCallsOnly -- All occurrences are *saturated* *function* calls
449 -- This means we don't need to build an info table and
450 -- slow entry code for the thing
451 -- Thunks never get this value
453 noBinderInfo, stgUnsatOcc, stgSatOcc :: StgBinderInfo
454 noBinderInfo = NoStgBinderInfo
455 stgUnsatOcc = NoStgBinderInfo
456 stgSatOcc = SatCallsOnly
458 satCallsOnly :: StgBinderInfo -> Bool
459 satCallsOnly SatCallsOnly = True
460 satCallsOnly NoStgBinderInfo = False
462 combineStgBinderInfo :: StgBinderInfo -> StgBinderInfo -> StgBinderInfo
463 combineStgBinderInfo SatCallsOnly SatCallsOnly = SatCallsOnly
464 combineStgBinderInfo _ _ = NoStgBinderInfo
467 pp_binder_info :: StgBinderInfo -> SDoc
468 pp_binder_info NoStgBinderInfo = empty
469 pp_binder_info SatCallsOnly = ptext SLIT("sat-only")
472 %************************************************************************
474 \subsection[Stg-case-alternatives]{STG case alternatives}
476 %************************************************************************
478 Very like in @CoreSyntax@ (except no type-world stuff).
480 The type constructor is guaranteed not to be abstract; that is, we can
481 see its representation. This is important because the code generator
482 uses it to determine return conventions etc. But it's not trivial
483 where there's a moduule loop involved, because some versions of a type
484 constructor might not have all the constructors visible. So
485 mkStgAlgAlts (in CoreToStg) ensures that it gets the TyCon from the
486 constructors or literals (which are guaranteed to have the Real McCoy)
487 rather than from the scrutinee type.
490 type GenStgAlt bndr occ
491 = (AltCon, -- alts: data constructor,
492 [bndr], -- constructor's parameters,
493 [Bool], -- "use mask", same length as
494 -- parameters; a True in a
495 -- param's position if it is
497 GenStgExpr bndr occ) -- ...right-hand side.
500 = PolyAlt -- Polymorphic (a type variable)
501 | UbxTupAlt TyCon -- Unboxed tuple
502 | AlgAlt TyCon -- Algebraic data type; the AltCons will be DataAlts
503 | PrimAlt TyCon -- Primitive data type; the AltCons will be LitAlts
506 %************************************************************************
508 \subsection[Stg]{The Plain STG parameterisation}
510 %************************************************************************
512 This happens to be the only one we use at the moment.
515 type StgBinding = GenStgBinding Id Id
516 type StgArg = GenStgArg Id
517 type StgLiveVars = GenStgLiveVars Id
518 type StgExpr = GenStgExpr Id Id
519 type StgRhs = GenStgRhs Id Id
520 type StgAlt = GenStgAlt Id Id
523 %************************************************************************
525 \subsubsection[UpdateFlag-datatype]{@UpdateFlag@}
527 %************************************************************************
529 This is also used in @LambdaFormInfo@ in the @ClosureInfo@ module.
531 A @ReEntrant@ closure may be entered multiple times, but should not be
532 updated or blackholed. An @Updatable@ closure should be updated after
533 evaluation (and may be blackholed during evaluation). A @SingleEntry@
534 closure will only be entered once, and so need not be updated but may
535 safely be blackholed.
538 data UpdateFlag = ReEntrant | Updatable | SingleEntry
540 instance Outputable UpdateFlag where
542 = char (case u of { ReEntrant -> 'r'; Updatable -> 'u'; SingleEntry -> 's' })
544 isUpdatable :: UpdateFlag -> Bool
545 isUpdatable ReEntrant = False
546 isUpdatable SingleEntry = False
547 isUpdatable Updatable = True
550 %************************************************************************
552 \subsubsection{StgOp}
554 %************************************************************************
556 An StgOp allows us to group together PrimOps and ForeignCalls.
557 It's quite useful to move these around together, notably
558 in StgOpApp and COpStmt.
561 data StgOp = StgPrimOp PrimOp
563 | StgFCallOp ForeignCall Unique
564 -- The Unique is occasionally needed by the C pretty-printer
565 -- (which lacks a unique supply), notably when generating a
566 -- typedef for foreign-export-dynamic
570 %************************************************************************
572 \subsubsection[Static Reference Tables]{@SRT@}
574 %************************************************************************
576 There is one SRT per top-level function group. Each local binding and
577 case expression within this binding group has a subrange of the whole
578 SRT, expressed as an offset and length.
580 In CoreToStg we collect the list of CafRefs at each SRT site, which is later
581 converted into the length and offset form by the SRT pass.
586 -- generated by CoreToStg
587 | SRT !Int{-offset-} !Int{-length-} !Bitmap{-bitmap-}
588 -- generated by computeSRTs
590 nonEmptySRT :: SRT -> Bool
591 nonEmptySRT NoSRT = False
592 nonEmptySRT (SRTEntries vs) = not (isEmptyVarSet vs)
595 pprSRT :: SRT -> SDoc
596 pprSRT (NoSRT) = ptext SLIT("_no_srt_")
597 pprSRT (SRTEntries ids) = text "SRT:" <> ppr ids
598 pprSRT (SRT off _ _) = parens (ppr off <> comma <> text "*bitmap*")
601 %************************************************************************
603 \subsection[Stg-pretty-printing]{Pretty-printing}
605 %************************************************************************
607 Robin Popplestone asked for semi-colon separators on STG binds; here's
608 hoping he likes terminators instead... Ditto for case alternatives.
611 pprGenStgBinding :: (Outputable bndr, Outputable bdee, Ord bdee)
612 => GenStgBinding bndr bdee -> SDoc
614 pprGenStgBinding (StgNonRec bndr rhs)
615 = hang (hsep [ppr bndr, equals])
616 4 ((<>) (ppr rhs) semi)
618 pprGenStgBinding (StgRec pairs)
619 = vcat ((ifPprDebug (ptext SLIT("{- StgRec (begin) -}"))) :
620 (map (ppr_bind) pairs) ++ [(ifPprDebug (ptext SLIT("{- StgRec (end) -}")))])
622 ppr_bind (bndr, expr)
623 = hang (hsep [ppr bndr, equals])
624 4 ((<>) (ppr expr) semi)
626 pprStgBinding :: StgBinding -> SDoc
627 pprStgBinding bind = pprGenStgBinding bind
629 pprStgBindings :: [StgBinding] -> SDoc
630 pprStgBindings binds = vcat (map pprGenStgBinding binds)
632 pprGenStgBindingWithSRT
633 :: (Outputable bndr, Outputable bdee, Ord bdee)
634 => (GenStgBinding bndr bdee,[(Id,[Id])]) -> SDoc
636 pprGenStgBindingWithSRT (bind,srts)
637 = vcat (pprGenStgBinding bind : map pprSRT srts)
638 where pprSRT (id,srt) =
639 ptext SLIT("SRT") <> parens (ppr id) <> ptext SLIT(": ") <> ppr srt
641 pprStgBindingsWithSRTs :: [(StgBinding,[(Id,[Id])])] -> SDoc
642 pprStgBindingsWithSRTs binds = vcat (map pprGenStgBindingWithSRT binds)
646 instance (Outputable bdee) => Outputable (GenStgArg bdee) where
649 instance (Outputable bndr, Outputable bdee, Ord bdee)
650 => Outputable (GenStgBinding bndr bdee) where
651 ppr = pprGenStgBinding
653 instance (Outputable bndr, Outputable bdee, Ord bdee)
654 => Outputable (GenStgExpr bndr bdee) where
657 instance (Outputable bndr, Outputable bdee, Ord bdee)
658 => Outputable (GenStgRhs bndr bdee) where
659 ppr rhs = pprStgRhs rhs
663 pprStgArg :: (Outputable bdee) => GenStgArg bdee -> SDoc
665 pprStgArg (StgVarArg var) = ppr var
666 pprStgArg (StgLitArg con) = ppr con
667 pprStgArg (StgTypeArg ty) = char '@' <+> ppr ty
671 pprStgExpr :: (Outputable bndr, Outputable bdee, Ord bdee)
672 => GenStgExpr bndr bdee -> SDoc
674 pprStgExpr (StgLit lit) = ppr lit
677 pprStgExpr (StgApp func args)
679 4 (sep (map (ppr) args))
683 pprStgExpr (StgConApp con args)
684 = hsep [ ppr con, brackets (interppSP args)]
686 pprStgExpr (StgOpApp op args _)
687 = hsep [ pprStgOp op, brackets (interppSP args)]
689 pprStgExpr (StgLam _ bndrs body)
690 =sep [ char '\\' <+> ppr bndrs <+> ptext SLIT("->"),
695 -- special case: let v = <very specific thing>
701 -- Very special! Suspicious! (SLPJ)
704 pprStgExpr (StgLet srt (StgNonRec bndr (StgRhsClosure cc bi free_vars upd_flag args rhs))
707 (hang (hcat [ptext SLIT("let { "), ppr bndr, ptext SLIT(" = "),
710 ptext SLIT(" ["), ifPprDebug (interppSP free_vars), ptext SLIT("] \\"),
711 ppr upd_flag, ptext SLIT(" ["),
712 interppSP args, char ']'])
713 8 (sep [hsep [ppr rhs, ptext SLIT("} in")]]))
717 -- special case: let ... in let ...
719 pprStgExpr (StgLet bind expr@(StgLet _ _))
721 (sep [hang (ptext SLIT("let {"))
722 2 (hsep [pprGenStgBinding bind, ptext SLIT("} in")])])
726 pprStgExpr (StgLet bind expr)
727 = sep [hang (ptext SLIT("let {")) 2 (pprGenStgBinding bind),
728 hang (ptext SLIT("} in ")) 2 (ppr expr)]
730 pprStgExpr (StgLetNoEscape lvs_whole lvs_rhss bind expr)
731 = sep [hang (ptext SLIT("let-no-escape {"))
732 2 (pprGenStgBinding bind),
733 hang ((<>) (ptext SLIT("} in "))
736 hcat [ptext SLIT("-- lvs: ["), interppSP (uniqSetToList lvs_whole),
737 ptext SLIT("]; rhs lvs: ["), interppSP (uniqSetToList lvs_rhss),
741 pprStgExpr (StgSCC cc expr)
742 = sep [ hsep [ptext SLIT("_scc_"), ppr cc],
745 pprStgExpr (StgTick m n expr)
746 = sep [ hsep [ptext SLIT("_tick_"), pprModule m,text (show n)],
749 pprStgExpr (StgCase expr lvs_whole lvs_rhss bndr srt alt_type alts)
750 = sep [sep [ptext SLIT("case"),
751 nest 4 (hsep [pprStgExpr expr,
752 ifPprDebug (dcolon <+> ppr alt_type)]),
753 ptext SLIT("of"), ppr bndr, char '{'],
756 hcat [ptext SLIT("-- lvs: ["), interppSP (uniqSetToList lvs_whole),
757 ptext SLIT("]; rhs lvs: ["), interppSP (uniqSetToList lvs_rhss),
760 nest 2 (vcat (map pprStgAlt alts)),
763 pprStgAlt :: (Outputable bndr, Outputable occ, Ord occ)
764 => GenStgAlt bndr occ -> SDoc
765 pprStgAlt (con, params, _use_mask, expr)
766 = hang (hsep [ppr con, interppSP params, ptext SLIT("->")])
769 pprStgOp :: StgOp -> SDoc
770 pprStgOp (StgPrimOp op) = ppr op
771 pprStgOp (StgFCallOp op _) = ppr op
773 instance Outputable AltType where
774 ppr PolyAlt = ptext SLIT("Polymorphic")
775 ppr (UbxTupAlt tc) = ptext SLIT("UbxTup") <+> ppr tc
776 ppr (AlgAlt tc) = ptext SLIT("Alg") <+> ppr tc
777 ppr (PrimAlt tc) = ptext SLIT("Prim") <+> ppr tc
782 pprStgLVs :: Outputable occ => GenStgLiveVars occ -> SDoc
784 = getPprStyle $ \ sty ->
785 if userStyle sty || isEmptyUniqSet lvs then
788 hcat [text "{-lvs:", interpp'SP (uniqSetToList lvs), text "-}"]
793 pprStgRhs :: (Outputable bndr, Outputable bdee, Ord bdee)
794 => GenStgRhs bndr bdee -> SDoc
797 pprStgRhs (StgRhsClosure cc bi [free_var] upd_flag srt [{-no args-}] (StgApp func []))
800 brackets (ifPprDebug (ppr free_var)),
801 ptext SLIT(" \\"), ppr upd_flag, pprMaybeSRT srt, ptext SLIT(" [] "), ppr func ]
804 pprStgRhs (StgRhsClosure cc bi free_vars upd_flag srt args body)
805 = hang (hsep [if opt_SccProfilingOn then ppr cc else empty,
807 ifPprDebug (brackets (interppSP free_vars)),
808 char '\\' <> ppr upd_flag, pprMaybeSRT srt, brackets (interppSP args)])
811 pprStgRhs (StgRhsCon cc con args)
813 space, ppr con, ptext SLIT("! "), brackets (interppSP args)]
815 pprMaybeSRT :: SRT -> SDoc
816 pprMaybeSRT (NoSRT) = empty
817 pprMaybeSRT srt = ptext SLIT("srt:") <> pprSRT srt