2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section{Tidying up Core}
7 module TidyPgm( mkBootModDetails, tidyProgram ) where
9 #include "HsVersions.h"
11 import DynFlags ( DynFlag(..), dopt )
12 import Packages ( HomeModules )
14 import CoreUnfold ( noUnfolding, mkTopUnfolding )
15 import CoreFVs ( ruleLhsFreeIds, exprSomeFreeVars )
16 import CoreTidy ( tidyExpr, tidyVarOcc, tidyRules )
17 import PprCore ( pprRules )
18 import CoreLint ( showPass, endPass )
19 import CoreUtils ( exprArity, rhsIsStatic )
22 import Var ( Id, Var )
23 import Id ( idType, idInfo, idName, idCoreRules, isGlobalId,
24 isExportedId, mkVanillaGlobal, isLocalId, isNaughtyRecordSelector,
25 idArity, idCafInfo, idUnfolding, isImplicitId, setIdInfo
27 import IdInfo {- loads of stuff -}
28 import InstEnv ( Instance, DFunId, instanceDFunId, setInstanceDFunId )
29 import NewDemand ( isBottomingSig, topSig )
30 import BasicTypes ( Arity, isNeverActive )
31 import Name ( Name, getOccName, nameOccName, mkInternalName,
32 localiseName, isExternalName, nameSrcLoc, nameParent_maybe,
33 isWiredInName, getName
35 import NameSet ( NameSet, elemNameSet )
36 import IfaceEnv ( allocateGlobalBinder )
37 import NameEnv ( filterNameEnv, mapNameEnv )
38 import OccName ( TidyOccEnv, initTidyOccEnv, tidyOccName )
39 import Type ( tidyTopType )
40 import TcType ( isFFITy )
41 import DataCon ( dataConName, dataConFieldLabels, dataConWrapId_maybe )
42 import TyCon ( TyCon, makeTyConAbstract, tyConDataCons, isNewTyCon,
43 newTyConRep, tyConSelIds, isAlgTyCon, isEnumerationTyCon )
44 import Class ( classSelIds )
45 import Module ( Module )
46 import HscTypes ( HscEnv(..), NameCache( nsUniqs ), CgGuts(..),
47 TypeEnv, typeEnvIds, typeEnvElts, typeEnvTyCons,
48 extendTypeEnvWithIds, lookupTypeEnv,
49 ModGuts(..), TyThing(..), ModDetails(..), Dependencies(..)
51 import Maybes ( orElse, mapCatMaybes )
52 import ErrUtils ( showPass, dumpIfSet_core )
53 import UniqSupply ( splitUniqSupply, uniqFromSupply )
54 import List ( partition )
55 import Maybe ( isJust )
57 import DATA_IOREF ( IORef, readIORef, writeIORef )
58 import FastTypes hiding ( fastOr )
62 Constructing the TypeEnv, Instances, Rules from which the ModIface is
63 constructed, and which goes on to subsequent modules in --make mode.
65 Most of the interface file is obtained simply by serialising the
66 TypeEnv. One important consequence is that if the *interface file*
67 has pragma info if and only if the final TypeEnv does. This is not so
68 important for *this* module, but it's essential for ghc --make:
69 subsequent compilations must not see (e.g.) the arity if the interface
70 file does not contain arity If they do, they'll exploit the arity;
71 then the arity might change, but the iface file doesn't change =>
72 recompilation does not happen => disaster.
74 For data types, the final TypeEnv will have a TyThing for the TyCon,
75 plus one for each DataCon; the interface file will contain just one
76 data type declaration, but it is de-serialised back into a collection
79 %************************************************************************
83 %************************************************************************
86 Plan A: mkBootModDetails: omit pragmas, make interfaces small
87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90 * Drop all WiredIn things from the TypeEnv
91 (we never want them in interface files)
93 * Retain all TyCons and Classes in the TypeEnv, to avoid
94 having to find which ones are mentioned in the
97 * Trim off the constructors of non-exported TyCons, both
98 from the TyCon and from the TypeEnv
100 * Drop non-exported Ids from the TypeEnv
102 * Tidy the types of the DFunIds of Instances,
103 make them into GlobalIds, (they already have External Names)
104 and add them to the TypeEnv
106 * Tidy the types of the (exported) Ids in the TypeEnv,
107 make them into GlobalIds (they already have External Names)
109 * Drop rules altogether
111 * Tidy the bindings, to ensure that the Caf and Arity
112 information is correct for each top-level binder; the
113 code generator needs it. And to ensure that local names have
114 distinct OccNames in case of object-file splitting
117 mkBootModDetails :: HscEnv -> ModGuts -> IO ModDetails
118 -- This is Plan A: make a small type env when typechecking only,
119 -- or when compiling a hs-boot file, or simply when not using -O
121 -- We don't look at the bindings at all -- there aren't any
124 mkBootModDetails hsc_env (ModGuts { mg_module = mod,
125 mg_exports = exports,
128 = do { let dflags = hsc_dflags hsc_env
129 ; showPass dflags "Tidy [hoot] type env"
131 ; let { ispecs' = tidyInstances tidyExternalId ispecs
132 ; type_env1 = filterNameEnv (not . isWiredInThing) type_env
133 ; type_env2 = mapNameEnv tidyBootThing type_env1
134 ; type_env' = extendTypeEnvWithIds type_env2
135 (map instanceDFunId ispecs')
137 ; return (ModDetails { md_types = type_env',
140 md_exports = exports })
144 isWiredInThing :: TyThing -> Bool
145 isWiredInThing thing = isWiredInName (getName thing)
147 tidyBootThing :: TyThing -> TyThing
148 -- Just externalise the Ids; keep everything
149 tidyBootThing (AnId id) | isLocalId id = AnId (tidyExternalId id)
150 tidyBootThing thing = thing
152 tidyExternalId :: Id -> Id
153 -- Takes an LocalId with an External Name,
154 -- makes it into a GlobalId with VanillaIdInfo, and tidies its type
155 -- (NB: vanillaIdInfo makes a conservative assumption about Caf-hood.)
157 = ASSERT2( isLocalId id && isExternalName (idName id), ppr id )
158 mkVanillaGlobal (idName id) (tidyTopType (idType id)) vanillaIdInfo
162 %************************************************************************
164 Plan B: tidy bindings, make TypeEnv full of IdInfo
166 %************************************************************************
168 Plan B: include pragmas, make interfaces
169 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
170 * Figure out which Ids are externally visible
172 * Tidy the bindings, externalising appropriate Ids
174 * Drop all Ids from the TypeEnv, and add all the External Ids from
175 the bindings. (This adds their IdInfo to the TypeEnv; and adds
176 floated-out Ids that weren't even in the TypeEnv before.)
178 Step 1: Figure out external Ids
179 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
180 First we figure out which Ids are "external" Ids. An
181 "external" Id is one that is visible from outside the compilation
183 a) the user exported ones
184 b) ones mentioned in the unfoldings, workers,
185 or rules of externally-visible ones
186 This exercise takes a sweep of the bindings bottom to top. Actually,
187 in Step 2 we're also going to need to know which Ids should be
188 exported with their unfoldings, so we produce not an IdSet but an
192 Step 2: Tidy the program
193 ~~~~~~~~~~~~~~~~~~~~~~~~
194 Next we traverse the bindings top to bottom. For each *top-level*
197 1. Make it into a GlobalId; its IdDetails becomes VanillaGlobal,
198 reflecting the fact that from now on we regard it as a global,
201 2. Give it a system-wide Unique.
202 [Even non-exported things need system-wide Uniques because the
203 byte-code generator builds a single Name->BCO symbol table.]
205 We use the NameCache kept in the HscEnv as the
206 source of such system-wide uniques.
208 For external Ids, use the original-name cache in the NameCache
209 to ensure that the unique assigned is the same as the Id had
210 in any previous compilation run.
212 3. If it's an external Id, make it have a External Name, otherwise
213 make it have an Internal Name.
214 This is used by the code generator to decide whether
215 to make the label externally visible
217 4. Give external Ids a "tidy" OccName. This means
218 we can print them in interface files without confusing
219 "x" (unique 5) with "x" (unique 10).
221 5. Give it its UTTERLY FINAL IdInfo; in ptic,
222 * its unfolding, if it should have one
224 * its arity, computed from the number of visible lambdas
226 * its CAF info, computed from what is free in its RHS
229 Finally, substitute these new top-level binders consistently
230 throughout, including in unfoldings. We also tidy binders in
231 RHSs, so that they print nicely in interfaces.
234 tidyProgram :: HscEnv -> ModGuts -> IO (CgGuts, ModDetails)
236 mod_impl@(ModGuts { mg_module = mod, mg_exports = exports,
237 mg_types = type_env, mg_insts = insts_tc,
239 mg_rules = imp_rules,
240 mg_dir_imps = dir_imps, mg_deps = deps,
241 mg_home_mods = home_mods,
242 mg_foreign = foreign_stubs })
244 = do { let dflags = hsc_dflags hsc_env
245 ; showPass dflags "Tidy Core"
247 ; let { omit_prags = dopt Opt_OmitInterfacePragmas dflags
248 ; ext_ids = findExternalIds omit_prags binds
251 | otherwise = findExternalRules binds imp_rules ext_ids
252 -- findExternalRules filters imp_rules to avoid binders that
253 -- aren't externally visible; but the externally-visible binders
254 -- are computed (by findExternalIds) assuming that all orphan
255 -- rules are exported (they get their Exported flag set in the desugarer)
256 -- So in fact we may export more than we need.
257 -- (It's a sort of mutual recursion.)
260 ; (tidy_env, tidy_binds) <- tidyTopBinds hsc_env home_mods mod type_env ext_ids binds
262 ; let { tidy_type_env = tidyTypeEnv omit_prags exports type_env tidy_binds
263 ; tidy_ispecs = tidyInstances (lookup_dfun tidy_type_env) insts_tc
264 -- A DFunId will have a binding in tidy_binds, and so
265 -- will now be in final_env, replete with IdInfo
266 -- Its name will be unchanged since it was born, but
267 -- we want Global, IdInfo-rich (or not) DFunId in the tidy_ispecs
269 ; tidy_rules = tidyRules tidy_env ext_rules
270 -- You might worry that the tidy_env contains IdInfo-rich stuff
271 -- and indeed it does, but if omit_prags is on, ext_rules is empty
273 ; implicit_binds = getImplicitBinds type_env
274 ; alg_tycons = filter isAlgTyCon (typeEnvTyCons type_env)
277 ; endPass dflags "Tidy Core" Opt_D_dump_simpl tidy_binds
278 ; dumpIfSet_core dflags Opt_D_dump_simpl
280 (pprRules tidy_rules)
282 ; return (CgGuts { cg_module = mod,
283 cg_tycons = alg_tycons,
284 cg_binds = implicit_binds ++ tidy_binds,
285 cg_dir_imps = dir_imps,
286 cg_foreign = foreign_stubs,
287 cg_home_mods = home_mods,
288 cg_dep_pkgs = dep_pkgs deps },
290 ModDetails { md_types = tidy_type_env,
291 md_rules = tidy_rules,
292 md_insts = tidy_ispecs,
293 md_exports = exports })
296 lookup_dfun type_env dfun_id
297 = case lookupTypeEnv type_env (idName dfun_id) of
298 Just (AnId dfun_id') -> dfun_id'
299 other -> pprPanic "lookup_dfun" (ppr dfun_id)
301 tidyTypeEnv :: Bool -> NameSet -> TypeEnv -> [CoreBind] -> TypeEnv
303 -- The competed type environment is gotten from
304 -- Dropping any wired-in things, and then
305 -- a) keeping the types and classes
306 -- b) removing all Ids,
307 -- c) adding Ids with correct IdInfo, including unfoldings,
308 -- gotten from the bindings
309 -- From (c) we keep only those Ids with External names;
310 -- the CoreTidy pass makes sure these are all and only
311 -- the externally-accessible ones
312 -- This truncates the type environment to include only the
313 -- exported Ids and things needed from them, which saves space
315 tidyTypeEnv omit_prags exports type_env tidy_binds
316 = let type_env1 = filterNameEnv keep_it type_env
317 type_env2 = extendTypeEnvWithIds type_env1 final_ids
318 type_env3 | omit_prags = mapNameEnv trim_thing type_env2
319 | otherwise = type_env2
323 final_ids = [ id | id <- bindersOfBinds tidy_binds,
324 isExternalName (idName id)]
326 -- We keep GlobalIds, because they won't appear
327 -- in the bindings from which final_ids are derived!
328 -- (The bindings bind LocalIds.)
329 keep_it thing | isWiredInThing thing = False
330 keep_it (AnId id) = isGlobalId id -- Keep GlobalIds (e.g. class ops)
331 keep_it other = True -- Keep all TyCons, DataCons, and Classes
335 ATyCon tc | mustExposeTyCon exports tc -> thing
336 | otherwise -> ATyCon (makeTyConAbstract tc)
338 AnId id | isImplicitId id -> thing
339 | otherwise -> AnId (id `setIdInfo` vanillaIdInfo)
343 mustExposeTyCon :: NameSet -- Exports
344 -> TyCon -- The tycon
345 -> Bool -- Can its rep be hidden?
346 -- We are compiling without -O, and thus trying to write as little as
347 -- possible into the interface file. But we must expose the details of
348 -- any data types whose constructors or fields are exported
349 mustExposeTyCon exports tc
350 | not (isAlgTyCon tc) -- Synonyms
352 | isEnumerationTyCon tc -- For an enumeration, exposing the constructors
353 = True -- won't lead to the need for further exposure
354 -- (This includes data types with no constructors.)
355 | otherwise -- Newtype, datatype
356 = any exported_con (tyConDataCons tc)
357 -- Expose rep if any datacon or field is exported
359 || (isNewTyCon tc && isFFITy (snd (newTyConRep tc)))
360 -- Expose the rep for newtypes if the rep is an FFI type.
361 -- For a very annoying reason. 'Foreign import' is meant to
362 -- be able to look through newtypes transparently, but it
363 -- can only do that if it can "see" the newtype representation
365 exported_con con = any (`elemNameSet` exports)
366 (dataConName con : dataConFieldLabels con)
368 tidyInstances :: (DFunId -> DFunId) -> [Instance] -> [Instance]
369 tidyInstances tidy_dfun ispecs
372 tidy ispec = setInstanceDFunId ispec $
373 tidy_dfun (instanceDFunId ispec)
375 getImplicitBinds :: TypeEnv -> [CoreBind]
376 getImplicitBinds type_env
377 = map get_defn (concatMap implicit_con_ids (typeEnvTyCons type_env)
378 ++ concatMap other_implicit_ids (typeEnvElts type_env))
379 -- Put the constructor wrappers first, because
380 -- other implicit bindings (notably the fromT functions arising
381 -- from generics) use the constructor wrappers. At least that's
382 -- what External Core likes
384 implicit_con_ids tc = mapCatMaybes dataConWrapId_maybe (tyConDataCons tc)
386 other_implicit_ids (ATyCon tc) = filter (not . isNaughtyRecordSelector) (tyConSelIds tc)
387 -- The "naughty" ones are not real functions at all
388 -- They are there just so we can get decent error messages
389 -- See Note [Naughty record selectors] in MkId.lhs
390 other_implicit_ids (AClass cl) = classSelIds cl
391 other_implicit_ids other = []
393 get_defn :: Id -> CoreBind
394 get_defn id = NonRec id (tidyExpr emptyTidyEnv rhs)
396 rhs = unfoldingTemplate (idUnfolding id)
397 -- Don't forget to tidy the body ! Otherwise you get silly things like
398 -- \ tpl -> case tpl of tpl -> (tpl,tpl) -> tpl
402 %************************************************************************
404 \subsection{Step 1: finding externals}
406 %************************************************************************
409 findExternalIds :: Bool
411 -> IdEnv Bool -- In domain => external
412 -- Range = True <=> show unfolding
413 -- Step 1 from the notes above
414 findExternalIds omit_prags binds
416 = mkVarEnv [ (id,False) | id <- bindersOfBinds binds, isExportedId id ]
419 = foldr find emptyVarEnv binds
421 find (NonRec id rhs) needed
422 | need_id needed id = addExternal (id,rhs) needed
424 find (Rec prs) needed = find_prs prs needed
426 -- For a recursive group we have to look for a fixed point
428 | null needed_prs = needed
429 | otherwise = find_prs other_prs new_needed
431 (needed_prs, other_prs) = partition (need_pr needed) prs
432 new_needed = foldr addExternal needed needed_prs
434 -- The 'needed' set contains the Ids that are needed by earlier
435 -- interface file emissions. If the Id isn't in this set, and isn't
436 -- exported, there's no need to emit anything
437 need_id needed_set id = id `elemVarEnv` needed_set || isExportedId id
438 need_pr needed_set (id,rhs) = need_id needed_set id
440 addExternal :: (Id,CoreExpr) -> IdEnv Bool -> IdEnv Bool
441 -- The Id is needed; extend the needed set
442 -- with it and its dependents (free vars etc)
443 addExternal (id,rhs) needed
444 = extendVarEnv (foldVarSet add_occ needed new_needed_ids)
447 add_occ id needed = extendVarEnv needed id False
448 -- "False" because we don't know we need the Id's unfolding
449 -- We'll override it later when we find the binding site
451 new_needed_ids = worker_ids `unionVarSet`
452 unfold_ids `unionVarSet`
456 dont_inline = isNeverActive (inlinePragInfo idinfo)
457 loop_breaker = isLoopBreaker (occInfo idinfo)
458 bottoming_fn = isBottomingSig (newStrictnessInfo idinfo `orElse` topSig)
459 spec_ids = specInfoFreeVars (specInfo idinfo)
460 worker_info = workerInfo idinfo
462 -- Stuff to do with the Id's unfolding
463 -- The simplifier has put an up-to-date unfolding
464 -- in the IdInfo, but the RHS will do just as well
465 unfolding = unfoldingInfo idinfo
466 rhs_is_small = not (neverUnfold unfolding)
468 -- We leave the unfolding there even if there is a worker
469 -- In GHCI the unfolding is used by importers
470 -- When writing an interface file, we omit the unfolding
471 -- if there is a worker
472 show_unfold = not bottoming_fn && -- Not necessary
475 rhs_is_small -- Small enough
477 unfold_ids | show_unfold = exprSomeFreeVars isLocalId rhs
478 | otherwise = emptyVarSet
480 worker_ids = case worker_info of
481 HasWorker work_id _ -> unitVarSet work_id
482 otherwise -> emptyVarSet
487 findExternalRules :: [CoreBind]
488 -> [CoreRule] -- Non-local rules (i.e. ones for imported fns)
489 -> IdEnv a -- Ids that are exported, so we need their rules
491 -- The complete rules are gotten by combining
492 -- a) the non-local rules
493 -- b) rules embedded in the top-level Ids
494 findExternalRules binds non_local_rules ext_ids
495 = filter (not . internal_rule) (non_local_rules ++ local_rules)
498 | id <- bindersOfBinds binds,
499 id `elemVarEnv` ext_ids,
500 rule <- idCoreRules id
504 = any internal_id (varSetElems (ruleLhsFreeIds rule))
505 -- Don't export a rule whose LHS mentions a locally-defined
506 -- Id that is completely internal (i.e. not visible to an
509 internal_id id = not (id `elemVarEnv` ext_ids)
514 %************************************************************************
516 \subsection{Step 2: top-level tidying}
518 %************************************************************************
522 -- TopTidyEnv: when tidying we need to know
523 -- * nc_var: The NameCache, containing a unique supply and any pre-ordained Names.
524 -- These may have arisen because the
525 -- renamer read in an interface file mentioning M.$wf, say,
526 -- and assigned it unique r77. If, on this compilation, we've
527 -- invented an Id whose name is $wf (but with a different unique)
528 -- we want to rename it to have unique r77, so that we can do easy
529 -- comparisons with stuff from the interface file
531 -- * occ_env: The TidyOccEnv, which tells us which local occurrences
534 -- * subst_env: A Var->Var mapping that substitutes the new Var for the old
536 tidyTopBinds :: HscEnv
540 -> IdEnv Bool -- Domain = Ids that should be external
541 -- True <=> their unfolding is external too
543 -> IO (TidyEnv, [CoreBind])
545 tidyTopBinds hsc_env hmods mod type_env ext_ids binds
546 = tidy init_env binds
548 nc_var = hsc_NC hsc_env
550 -- We also make sure to avoid any exported binders. Consider
551 -- f{-u1-} = 1 -- Local decl
553 -- f{-u2-} = 2 -- Exported decl
555 -- The second exported decl must 'get' the name 'f', so we
556 -- have to put 'f' in the avoids list before we get to the first
557 -- decl. tidyTopId then does a no-op on exported binders.
558 init_env = (initTidyOccEnv avoids, emptyVarEnv)
559 avoids = [getOccName name | bndr <- typeEnvIds type_env,
560 let name = idName bndr,
562 -- In computing our "avoids" list, we must include
564 -- all things with global names (assigned once and for
565 -- all by the renamer)
566 -- since their names are "taken".
567 -- The type environment is a convenient source of such things.
569 tidy env [] = return (env, [])
570 tidy env (b:bs) = do { (env1, b') <- tidyTopBind hmods mod nc_var ext_ids env b
571 ; (env2, bs') <- tidy env1 bs
572 ; return (env2, b':bs') }
574 ------------------------
575 tidyTopBind :: HomeModules
577 -> IORef NameCache -- For allocating new unique names
578 -> IdEnv Bool -- Domain = Ids that should be external
579 -- True <=> their unfolding is external too
580 -> TidyEnv -> CoreBind
581 -> IO (TidyEnv, CoreBind)
583 tidyTopBind hmods mod nc_var ext_ids tidy_env1@(occ_env1,subst1) (NonRec bndr rhs)
584 = do { (occ_env2, name') <- tidyTopName mod nc_var ext_ids occ_env1 bndr
585 ; let { (bndr', rhs') = tidyTopPair ext_ids tidy_env2 caf_info name' (bndr, rhs)
586 ; subst2 = extendVarEnv subst1 bndr bndr'
587 ; tidy_env2 = (occ_env2, subst2) }
588 ; return (tidy_env2, NonRec bndr' rhs') }
590 caf_info = hasCafRefs hmods subst1 (idArity bndr) rhs
592 tidyTopBind hmods mod nc_var ext_ids tidy_env1@(occ_env1,subst1) (Rec prs)
593 = do { (occ_env2, names') <- tidyTopNames mod nc_var ext_ids occ_env1 bndrs
594 ; let { prs' = zipWith (tidyTopPair ext_ids tidy_env2 caf_info)
596 ; subst2 = extendVarEnvList subst1 (bndrs `zip` map fst prs')
597 ; tidy_env2 = (occ_env2, subst2) }
598 ; return (tidy_env2, Rec prs') }
602 -- the CafInfo for a recursive group says whether *any* rhs in
603 -- the group may refer indirectly to a CAF (because then, they all do).
605 | or [ mayHaveCafRefs (hasCafRefs hmods subst1 (idArity bndr) rhs)
606 | (bndr,rhs) <- prs ] = MayHaveCafRefs
607 | otherwise = NoCafRefs
609 --------------------------------------------------------------------
611 -- This is where we set names to local/global based on whether they really are
612 -- externally visible (see comment at the top of this module). If the name
613 -- was previously local, we have to give it a unique occurrence name if
614 -- we intend to externalise it.
615 tidyTopNames mod nc_var ext_ids occ_env [] = return (occ_env, [])
616 tidyTopNames mod nc_var ext_ids occ_env (id:ids)
617 = do { (occ_env1, name) <- tidyTopName mod nc_var ext_ids occ_env id
618 ; (occ_env2, names) <- tidyTopNames mod nc_var ext_ids occ_env1 ids
619 ; return (occ_env2, name:names) }
621 tidyTopName :: Module -> IORef NameCache -> VarEnv Bool -> TidyOccEnv
622 -> Id -> IO (TidyOccEnv, Name)
623 tidyTopName mod nc_var ext_ids occ_env id
624 | global && internal = return (occ_env, localiseName name)
626 | global && external = return (occ_env, name)
627 -- Global names are assumed to have been allocated by the renamer,
628 -- so they already have the "right" unique
629 -- And it's a system-wide unique too
631 -- Now we get to the real reason that all this is in the IO Monad:
632 -- we have to update the name cache in a nice atomic fashion
634 | local && internal = do { nc <- readIORef nc_var
635 ; let (nc', new_local_name) = mk_new_local nc
636 ; writeIORef nc_var nc'
637 ; return (occ_env', new_local_name) }
638 -- Even local, internal names must get a unique occurrence, because
639 -- if we do -split-objs we externalise the name later, in the code generator
641 -- Similarly, we must make sure it has a system-wide Unique, because
642 -- the byte-code generator builds a system-wide Name->BCO symbol table
644 | local && external = do { nc <- readIORef nc_var
645 ; let (nc', new_external_name) = mk_new_external nc
646 ; writeIORef nc_var nc'
647 ; return (occ_env', new_external_name) }
650 external = id `elemVarEnv` ext_ids
651 global = isExternalName name
653 internal = not external
654 mb_parent = nameParent_maybe name
655 loc = nameSrcLoc name
657 (occ_env', occ') = tidyOccName occ_env (nameOccName name)
659 mk_new_local nc = (nc { nsUniqs = us2 }, mkInternalName uniq occ' loc)
661 (us1, us2) = splitUniqSupply (nsUniqs nc)
662 uniq = uniqFromSupply us1
664 mk_new_external nc = allocateGlobalBinder nc mod occ' mb_parent loc
665 -- If we want to externalise a currently-local name, check
666 -- whether we have already assigned a unique for it.
667 -- If so, use it; if not, extend the table.
668 -- All this is done by allcoateGlobalBinder.
669 -- This is needed when *re*-compiling a module in GHCi; we must
670 -- use the same name for externally-visible things as we did before.
673 -----------------------------------------------------------
674 tidyTopPair :: VarEnv Bool
675 -> TidyEnv -- The TidyEnv is used to tidy the IdInfo
676 -- It is knot-tied: don't look at it!
679 -> (Id, CoreExpr) -- Binder and RHS before tidying
681 -- This function is the heart of Step 2
682 -- The rec_tidy_env is the one to use for the IdInfo
683 -- It's necessary because when we are dealing with a recursive
684 -- group, a variable late in the group might be mentioned
685 -- in the IdInfo of one early in the group
687 tidyTopPair ext_ids rhs_tidy_env caf_info name' (bndr, rhs)
688 | isGlobalId bndr -- Injected binding for record selector, etc
689 = (bndr, tidyExpr rhs_tidy_env rhs)
693 bndr' = mkVanillaGlobal name' ty' idinfo'
694 ty' = tidyTopType (idType bndr)
695 rhs' = tidyExpr rhs_tidy_env rhs
696 idinfo' = tidyTopIdInfo rhs_tidy_env (isJust maybe_external)
697 (idInfo bndr) unfold_info arity
700 -- Expose an unfolding if ext_ids tells us to
701 -- Remember that ext_ids maps an Id to a Bool:
702 -- True to show the unfolding, False to hide it
703 maybe_external = lookupVarEnv ext_ids bndr
704 show_unfold = maybe_external `orElse` False
705 unfold_info | show_unfold = mkTopUnfolding rhs'
706 | otherwise = noUnfolding
708 -- Usually the Id will have an accurate arity on it, because
709 -- the simplifier has just run, but not always.
710 -- One case I found was when the last thing the simplifier
711 -- did was to let-bind a non-atomic argument and then float
712 -- it to the top level. So it seems more robust just to
714 arity = exprArity rhs
717 -- tidyTopIdInfo creates the final IdInfo for top-level
718 -- binders. There are two delicate pieces:
720 -- * Arity. After CoreTidy, this arity must not change any more.
721 -- Indeed, CorePrep must eta expand where necessary to make
722 -- the manifest arity equal to the claimed arity.
724 -- * CAF info. This must also remain valid through to code generation.
725 -- We add the info here so that it propagates to all
726 -- occurrences of the binders in RHSs, and hence to occurrences in
727 -- unfoldings, which are inside Ids imported by GHCi. Ditto RULES.
728 -- CoreToStg makes use of this when constructing SRTs.
730 tidyTopIdInfo tidy_env is_external idinfo unfold_info arity caf_info
731 | not is_external -- For internal Ids (not externally visible)
732 = vanillaIdInfo -- we only need enough info for code generation
733 -- Arity and strictness info are enough;
734 -- c.f. CoreTidy.tidyLetBndr
735 `setCafInfo` caf_info
737 `setAllStrictnessInfo` newStrictnessInfo idinfo
739 | otherwise -- Externally-visible Ids get the whole lot
741 `setCafInfo` caf_info
743 `setAllStrictnessInfo` newStrictnessInfo idinfo
744 `setInlinePragInfo` inlinePragInfo idinfo
745 `setUnfoldingInfo` unfold_info
746 `setWorkerInfo` tidyWorker tidy_env (workerInfo idinfo)
747 -- NB: we throw away the Rules
748 -- They have already been extracted by findExternalRules
752 ------------ Worker --------------
753 tidyWorker tidy_env (HasWorker work_id wrap_arity)
754 = HasWorker (tidyVarOcc tidy_env work_id) wrap_arity
755 tidyWorker tidy_env other
759 %************************************************************************
761 \subsection{Figuring out CafInfo for an expression}
763 %************************************************************************
765 hasCafRefs decides whether a top-level closure can point into the dynamic heap.
766 We mark such things as `MayHaveCafRefs' because this information is
767 used to decide whether a particular closure needs to be referenced
770 There are two reasons for setting MayHaveCafRefs:
771 a) The RHS is a CAF: a top-level updatable thunk.
772 b) The RHS refers to something that MayHaveCafRefs
774 Possible improvement: In an effort to keep the number of CAFs (and
775 hence the size of the SRTs) down, we could also look at the expression and
776 decide whether it requires a small bounded amount of heap, so we can ignore
777 it as a CAF. In these cases however, we would need to use an additional
778 CAF list to keep track of non-collectable CAFs.
781 hasCafRefs :: HomeModules -> VarEnv Var -> Arity -> CoreExpr -> CafInfo
782 hasCafRefs hmods p arity expr
783 | is_caf || mentions_cafs = MayHaveCafRefs
784 | otherwise = NoCafRefs
786 mentions_cafs = isFastTrue (cafRefs p expr)
787 is_caf = not (arity > 0 || rhsIsStatic hmods expr)
788 -- NB. we pass in the arity of the expression, which is expected
789 -- to be calculated by exprArity. This is because exprArity
790 -- knows how much eta expansion is going to be done by
791 -- CorePrep later on, and we don't want to duplicate that
792 -- knowledge in rhsIsStatic below.
795 -- imported Ids first:
796 | not (isLocalId id) = fastBool (mayHaveCafRefs (idCafInfo id))
797 -- now Ids local to this module:
799 case lookupVarEnv p id of
800 Just id' -> fastBool (mayHaveCafRefs (idCafInfo id'))
801 Nothing -> fastBool False
803 cafRefs p (Lit l) = fastBool False
804 cafRefs p (App f a) = fastOr (cafRefs p f) (cafRefs p) a
805 cafRefs p (Lam x e) = cafRefs p e
806 cafRefs p (Let b e) = fastOr (cafRefss p (rhssOfBind b)) (cafRefs p) e
807 cafRefs p (Case e bndr _ alts) = fastOr (cafRefs p e) (cafRefss p) (rhssOfAlts alts)
808 cafRefs p (Note n e) = cafRefs p e
809 cafRefs p (Type t) = fastBool False
811 cafRefss p [] = fastBool False
812 cafRefss p (e:es) = fastOr (cafRefs p e) (cafRefss p) es
814 -- hack for lazy-or over FastBool.
815 fastOr a f x = fastBool (isFastTrue a || isFastTrue (f x))