-
-%************************************************************************
-%* *
-\subsection{What goes on}
-%* *
-%************************************************************************
-
-[SLPJ: 19 Nov 00]
-
-The plan is this.
-
-Step 1: Figure out external Ids
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-First we figure out which Ids are "external" Ids. An
-"external" Id is one that is visible from outside the compilation
-unit. These are
- a) the user exported ones
- b) ones mentioned in the unfoldings, workers,
- or rules of externally-visible ones
-This exercise takes a sweep of the bindings bottom to top. Actually,
-in Step 2 we're also going to need to know which Ids should be
-exported with their unfoldings, so we produce not an IdSet but an
-IdEnv Bool
-
-
-
-Step 2: Tidy the program
-~~~~~~~~~~~~~~~~~~~~~~~~
-Next we traverse the bindings top to bottom. For each top-level
-binder
-
- - Make all external Ids have Global names and vice versa
- This is used by the code generator to decide whether
- to make the label externally visible
-
- - Give external ids a "tidy" occurrence name. This means
- we can print them in interface files without confusing
- "x" (unique 5) with "x" (unique 10).
-
- - Give external Ids the same Unique as they had before
- if the name is in the renamer's name cache
-
- - Give the Id its final IdInfo; in ptic,
- * Its flavour becomes ConstantId, reflecting the fact that
- from now on we regard it as a constant, not local, Id
- * its unfolding, if it should have one
-
-Finally, substitute these new top-level binders consistently
-throughout, including in unfoldings. We also tidy binders in
-RHSs, so that they print nicely in interfaces.
-
-\begin{code}
-tidyCorePgm :: DynFlags -> Module
- -> PersistentCompilerState
- -> [CoreBind] -> [IdCoreRule]
- -> IO (PersistentCompilerState, [CoreBind], [IdCoreRule])
-tidyCorePgm dflags mod pcs binds_in orphans_in
- = do { showPass dflags "Tidy Core"
-
- ; let ext_ids = findExternalSet binds_in orphans_in
-
- ; let ((orig_env', occ_env, subst_env), binds_out)
- = mapAccumL (tidyTopBind mod ext_ids) init_tidy_env binds_in
-
- ; let orphans_out = tidyIdRules (occ_env,subst_env) orphans_in
-
- ; let pcs' = pcs { pcs_PRS = prs { prsOrig = orig { origNames = orig_env' }}}
-
- ; endPass dflags "Tidy Core" (dopt Opt_D_dump_simpl dflags ||
- dopt Opt_D_verbose_core2core dflags)
- binds_out
-
- ; return (pcs', binds_out, orphans_out)
- }
- where
- -- We also make sure to avoid any exported binders. Consider
- -- f{-u1-} = 1 -- Local decl
- -- ...
- -- f{-u2-} = 2 -- Exported decl
- --
- -- The second exported decl must 'get' the name 'f', so we
- -- have to put 'f' in the avoids list before we get to the first
- -- decl. tidyTopId then does a no-op on exported binders.
- prs = pcs_PRS pcs
- orig = prsOrig prs
- orig_env = origNames orig
-
- init_tidy_env = (orig_env, initTidyOccEnv avoids, emptyVarEnv)
- avoids = [getOccName bndr | bndr <- bindersOfBinds binds_in,
- isGlobalName (idName bndr)]
-\end{code}
-
-
-%************************************************************************
-%* *
-\subsection{Step 1: finding externals}
-%* *
-%************************************************************************
-
-\begin{code}
-findExternalSet :: [CoreBind] -> [IdCoreRule]
- -> IdEnv Bool -- True <=> show unfolding
- -- Step 1 from the notes above
-findExternalSet binds orphan_rules
- = foldr find init_needed binds
- where
- orphan_rule_ids :: IdSet
- orphan_rule_ids = unionVarSets [ ruleSomeFreeVars isIdAndLocal rule
- | (_, rule) <- orphan_rules]
- init_needed :: IdEnv Bool
- init_needed = mapUFM (\_ -> False) orphan_rule_ids
- -- The mapUFM is a bit cheesy. It is a cheap way
- -- to turn the set of orphan_rule_ids, which we use to initialise
- -- the sweep, into a mapping saying 'don't expose unfolding'
- -- (When we come to the binding site we may change our mind, of course.)
-
- find (NonRec id rhs) needed
- | need_id needed id = addExternal (id,rhs) needed
- | otherwise = needed
- find (Rec prs) needed = find_prs prs needed
-
- -- For a recursive group we have to look for a fixed point
- find_prs prs needed
- | null needed_prs = needed
- | otherwise = find_prs other_prs new_needed
- where
- (needed_prs, other_prs) = partition (need_pr needed) prs
- new_needed = foldr addExternal needed needed_prs
-
- -- The 'needed' set contains the Ids that are needed by earlier
- -- interface file emissions. If the Id isn't in this set, and isn't
- -- exported, there's no need to emit anything
- need_id needed_set id = id `elemVarEnv` needed_set || isExportedId id
- need_pr needed_set (id,rhs) = need_id needed_set id
-
-isIdAndLocal id = isId id && isLocalId id
-
-addExternal :: (Id,CoreExpr) -> IdEnv Bool -> IdEnv Bool
--- The Id is needed; extend the needed set
--- with it and its dependents (free vars etc)
-addExternal (id,rhs) needed
- = extendVarEnv (foldVarSet add_occ needed new_needed_ids)
- id show_unfold
- where
- add_occ id needed = extendVarEnv needed id False
- -- "False" because we don't know we need the Id's unfolding
- -- We'll override it later when we find the binding site
-
- new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet
- | otherwise = worker_ids `unionVarSet`
- unfold_ids `unionVarSet`
- spec_ids
-
- idinfo = idInfo id
- dont_inline = isNeverInlinePrag (inlinePragInfo idinfo)
- loop_breaker = isLoopBreaker (occInfo idinfo)
- bottoming_fn = isBottomingStrictness (strictnessInfo idinfo)
- spec_ids = rulesRhsFreeVars (specInfo idinfo)
- worker_info = workerInfo idinfo
-
- -- Stuff to do with the Id's unfolding
- -- The simplifier has put an up-to-date unfolding
- -- in the IdInfo, but the RHS will do just as well
- unfolding = unfoldingInfo idinfo
- rhs_is_small = not (neverUnfold unfolding)
-
- -- We leave the unfolding there even if there is a worker
- -- In GHCI the unfolding is used by importers
- -- When writing an interface file, we omit the unfolding
- -- if there is a worker
- show_unfold = not bottoming_fn && -- Not necessary
- not dont_inline &&
- not loop_breaker &&
- rhs_is_small && -- Small enough
- okToUnfoldInHiFile rhs -- No casms etc
-
- unfold_ids | show_unfold = exprSomeFreeVars isIdAndLocal rhs
- | otherwise = emptyVarSet
-
- worker_ids = case worker_info of
- HasWorker work_id _ -> unitVarSet work_id
- otherwise -> emptyVarSet
-\end{code}
-