e87bac67419e8dea4a9b23d5614015cb5be21654
[ghc-hetmet.git] / compiler / main / TidyPgm.lhs
1
2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
3 %
4 \section{Tidying up Core}
5
6 \begin{code}
7 module TidyPgm( mkBootModDetailsDs, mkBootModDetailsTc, 
8                 tidyProgram, globaliseAndTidyId ) where
9
10 #include "HsVersions.h"
11
12 import TcRnTypes
13 import FamInstEnv
14 import DynFlags
15 import CoreSyn
16 import CoreUnfold
17 import CoreFVs
18 import CoreTidy
19 import PprCore
20 import CoreLint
21 import CoreUtils
22 import CoreArity        ( exprArity )
23 import Class            ( classSelIds )
24 import VarEnv
25 import VarSet
26 import Var
27 import Id
28 import IdInfo
29 import InstEnv
30 import NewDemand
31 import BasicTypes
32 import Name
33 import NameSet
34 import IfaceEnv
35 import NameEnv
36 import TcType
37 import DataCon
38 import TyCon
39 import Module
40 import HscTypes
41 import Maybes
42 import ErrUtils
43 import UniqSupply
44 import Outputable
45 import FastBool hiding ( fastOr )
46 import Util
47
48 import Data.List        ( sortBy )
49 import Data.IORef       ( IORef, readIORef, writeIORef )
50 \end{code}
51
52
53 Constructing the TypeEnv, Instances, Rules from which the ModIface is
54 constructed, and which goes on to subsequent modules in --make mode.
55
56 Most of the interface file is obtained simply by serialising the
57 TypeEnv.  One important consequence is that if the *interface file*
58 has pragma info if and only if the final TypeEnv does. This is not so
59 important for *this* module, but it's essential for ghc --make:
60 subsequent compilations must not see (e.g.) the arity if the interface
61 file does not contain arity If they do, they'll exploit the arity;
62 then the arity might change, but the iface file doesn't change =>
63 recompilation does not happen => disaster. 
64
65 For data types, the final TypeEnv will have a TyThing for the TyCon,
66 plus one for each DataCon; the interface file will contain just one
67 data type declaration, but it is de-serialised back into a collection
68 of TyThings.
69
70 %************************************************************************
71 %*                                                                      *
72                 Plan A: simpleTidyPgm
73 %*                                                                      * 
74 %************************************************************************
75
76
77 Plan A: mkBootModDetails: omit pragmas, make interfaces small
78 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79 * Ignore the bindings
80
81 * Drop all WiredIn things from the TypeEnv 
82         (we never want them in interface files)
83
84 * Retain all TyCons and Classes in the TypeEnv, to avoid
85         having to find which ones are mentioned in the
86         types of exported Ids
87
88 * Trim off the constructors of non-exported TyCons, both
89         from the TyCon and from the TypeEnv
90
91 * Drop non-exported Ids from the TypeEnv
92
93 * Tidy the types of the DFunIds of Instances, 
94   make them into GlobalIds, (they already have External Names)
95   and add them to the TypeEnv
96
97 * Tidy the types of the (exported) Ids in the TypeEnv,
98   make them into GlobalIds (they already have External Names)
99
100 * Drop rules altogether
101
102 * Tidy the bindings, to ensure that the Caf and Arity
103   information is correct for each top-level binder; the 
104   code generator needs it. And to ensure that local names have
105   distinct OccNames in case of object-file splitting
106
107 \begin{code}
108 -- This is Plan A: make a small type env when typechecking only,
109 -- or when compiling a hs-boot file, or simply when not using -O
110 --
111 -- We don't look at the bindings at all -- there aren't any
112 -- for hs-boot files
113
114 mkBootModDetailsTc :: HscEnv -> TcGblEnv -> IO ModDetails
115 mkBootModDetailsTc hsc_env 
116         TcGblEnv{ tcg_exports   = exports,
117                   tcg_type_env  = type_env,
118                   tcg_insts     = insts,
119                   tcg_fam_insts = fam_insts
120                 }
121   = mkBootModDetails hsc_env exports type_env insts fam_insts
122
123 mkBootModDetailsDs :: HscEnv -> ModGuts -> IO ModDetails
124 mkBootModDetailsDs hsc_env 
125         ModGuts{ mg_exports   = exports,
126                  mg_types     = type_env,
127                  mg_insts     = insts,
128                  mg_fam_insts = fam_insts
129                 }
130   = mkBootModDetails hsc_env exports type_env insts fam_insts
131   
132 mkBootModDetails :: HscEnv -> [AvailInfo] -> NameEnv TyThing
133                  -> [Instance] -> [FamInstEnv.FamInst] -> IO ModDetails
134 mkBootModDetails hsc_env exports type_env insts fam_insts
135   = do  { let dflags = hsc_dflags hsc_env 
136         ; showPass dflags "Tidy [hoot] type env"
137
138         ; let { insts'     = tidyInstances globaliseAndTidyId insts
139               ; dfun_ids   = map instanceDFunId insts'
140               ; type_env1  = tidyBootTypeEnv (availsToNameSet exports) type_env
141               ; type_env'  = extendTypeEnvWithIds type_env1 dfun_ids
142               }
143         ; return (ModDetails { md_types     = type_env'
144                              , md_insts     = insts'
145                              , md_fam_insts = fam_insts
146                              , md_rules     = []
147                              , md_anns      = []
148                              , md_exports   = exports
149                              , md_vect_info = noVectInfo
150                              })
151         }
152   where
153
154 tidyBootTypeEnv :: NameSet -> TypeEnv -> TypeEnv
155 tidyBootTypeEnv exports type_env 
156   = tidyTypeEnv True False exports type_env final_ids
157   where
158         -- Find the LocalIds in the type env that are exported
159         -- Make them into GlobalIds, and tidy their types
160         --
161         -- It's very important to remove the non-exported ones
162         -- because we don't tidy the OccNames, and if we don't remove
163         -- the non-exported ones we'll get many things with the
164         -- same name in the interface file, giving chaos.
165     final_ids = [ globaliseAndTidyId id
166                 | id <- typeEnvIds type_env
167                 , isLocalId id
168                 , keep_it id ]
169
170         -- default methods have their export flag set, but everything
171         -- else doesn't (yet), because this is pre-desugaring, so we
172         -- must test both.
173     keep_it id = isExportedId id || idName id `elemNameSet` exports
174
175
176
177 globaliseAndTidyId :: Id -> Id
178 -- Takes an LocalId with an External Name, 
179 -- makes it into a GlobalId 
180 --     * unchanged Name (might be Internal or External)
181 --     * unchanged details
182 --     * VanillaIdInfo (makes a conservative assumption about Caf-hood)
183 globaliseAndTidyId id   
184   = Id.setIdType (globaliseId id) tidy_type
185   where
186     tidy_type = tidyTopType (idType id)
187 \end{code}
188
189
190 %************************************************************************
191 %*                                                                      *
192         Plan B: tidy bindings, make TypeEnv full of IdInfo
193 %*                                                                      * 
194 %************************************************************************
195
196 Plan B: include pragmas, make interfaces 
197 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198 * Figure out which Ids are externally visible
199
200 * Tidy the bindings, externalising appropriate Ids
201
202 * Drop all Ids from the TypeEnv, and add all the External Ids from 
203   the bindings.  (This adds their IdInfo to the TypeEnv; and adds
204   floated-out Ids that weren't even in the TypeEnv before.)
205
206 Step 1: Figure out external Ids
207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
208 Note [choosing external names]
209
210 See also the section "Interface stability" in the
211 RecompilationAvoidance commentary:
212   http://hackage.haskell.org/trac/ghc/wiki/Commentary/Compiler/RecompilationAvoidance
213
214 First we figure out which Ids are "external" Ids.  An
215 "external" Id is one that is visible from outside the compilation
216 unit.  These are
217         a) the user exported ones
218         b) ones mentioned in the unfoldings, workers, 
219            or rules of externally-visible ones 
220
221 While figuring out which Ids are external, we pick a "tidy" OccName
222 for each one.  That is, we make its OccName distinct from the other
223 external OccNames in this module, so that in interface files and
224 object code we can refer to it unambiguously by its OccName.  The
225 OccName for each binder is prefixed by the name of the exported Id
226 that references it; e.g. if "f" references "x" in its unfolding, then
227 "x" is renamed to "f_x".  This helps distinguish the different "x"s
228 from each other, and means that if "f" is later removed, things that
229 depend on the other "x"s will not need to be recompiled.  Of course,
230 if there are multiple "f_x"s, then we have to disambiguate somehow; we
231 use "f_x0", "f_x1" etc.
232
233 As far as possible we should assign names in a deterministic fashion.
234 Each time this module is compiled with the same options, we should end
235 up with the same set of external names with the same types.  That is,
236 the ABI hash in the interface should not change.  This turns out to be
237 quite tricky, since the order of the bindings going into the tidy
238 phase is already non-deterministic, as it is based on the ordering of
239 Uniques, which are assigned unpredictably.
240
241 To name things in a stable way, we do a depth-first-search of the
242 bindings, starting from the exports sorted by name.  This way, as long
243 as the bindings themselves are deterministic (they sometimes aren't!),
244 the order in which they are presented to the tidying phase does not
245 affect the names we assign.
246
247 Step 2: Tidy the program
248 ~~~~~~~~~~~~~~~~~~~~~~~~
249 Next we traverse the bindings top to bottom.  For each *top-level*
250 binder
251
252  1. Make it into a GlobalId; its IdDetails becomes VanillaGlobal, 
253     reflecting the fact that from now on we regard it as a global, 
254     not local, Id
255
256  2. Give it a system-wide Unique.
257     [Even non-exported things need system-wide Uniques because the
258     byte-code generator builds a single Name->BCO symbol table.]
259
260     We use the NameCache kept in the HscEnv as the
261     source of such system-wide uniques.
262
263     For external Ids, use the original-name cache in the NameCache
264     to ensure that the unique assigned is the same as the Id had 
265     in any previous compilation run.
266
267  3. Rename top-level Ids according to the names we chose in step 1.
268     If it's an external Id, make it have a External Name, otherwise
269     make it have an Internal Name.  This is used by the code generator
270     to decide whether to make the label externally visible
271
272  4. Give it its UTTERLY FINAL IdInfo; in ptic, 
273         * its unfolding, if it should have one
274         
275         * its arity, computed from the number of visible lambdas
276
277         * its CAF info, computed from what is free in its RHS
278
279                 
280 Finally, substitute these new top-level binders consistently
281 throughout, including in unfoldings.  We also tidy binders in
282 RHSs, so that they print nicely in interfaces.
283
284 \begin{code}
285 tidyProgram :: HscEnv -> ModGuts -> IO (CgGuts, ModDetails)
286 tidyProgram hsc_env  (ModGuts { mg_module = mod, mg_exports = exports, 
287                                 mg_types = type_env, 
288                                 mg_insts = insts, mg_fam_insts = fam_insts,
289                                 mg_binds = binds, 
290                                 mg_rules = imp_rules,
291                                 mg_vect_info = vect_info,
292                                 mg_dir_imps = dir_imps, 
293                                 mg_anns = anns,
294                                 mg_deps = deps, 
295                                 mg_foreign = foreign_stubs,
296                                 mg_hpc_info = hpc_info,
297                                 mg_modBreaks = modBreaks })
298
299   = do  { let dflags = hsc_dflags hsc_env
300         ; showPass dflags "Tidy Core"
301
302         ; let { omit_prags = dopt Opt_OmitInterfacePragmas dflags
303               ; th         = dopt Opt_TemplateHaskell      dflags
304               }
305
306         ; let { implicit_binds = getImplicitBinds type_env }
307
308         ; (unfold_env, tidy_occ_env)
309               <- chooseExternalIds hsc_env mod omit_prags binds implicit_binds
310
311         ; let { ext_rules 
312                    | omit_prags = []
313                    | otherwise  = findExternalRules binds imp_rules unfold_env
314                 -- findExternalRules filters imp_rules to avoid binders that 
315                 -- aren't externally visible; but the externally-visible binders 
316                 -- are computed (by findExternalIds) assuming that all orphan
317                 -- rules are exported (they get their Exported flag set in the desugarer)
318                 -- So in fact we may export more than we need. 
319                 -- (It's a sort of mutual recursion.)
320         }
321
322         ; let { (tidy_env, tidy_binds)
323                  = tidyTopBinds hsc_env unfold_env tidy_occ_env binds }
324
325         ; let { export_set = availsToNameSet exports
326               ; final_ids  = [ id | id <- bindersOfBinds tidy_binds, 
327                                     isExternalName (idName id)]
328               ; tidy_type_env = tidyTypeEnv omit_prags th export_set
329                                             type_env final_ids
330               ; tidy_insts    = tidyInstances (lookup_dfun tidy_type_env) insts
331                 -- A DFunId will have a binding in tidy_binds, and so
332                 -- will now be in final_env, replete with IdInfo
333                 -- Its name will be unchanged since it was born, but
334                 -- we want Global, IdInfo-rich (or not) DFunId in the
335                 -- tidy_insts
336
337               ; tidy_rules = tidyRules tidy_env ext_rules
338                 -- You might worry that the tidy_env contains IdInfo-rich stuff
339                 -- and indeed it does, but if omit_prags is on, ext_rules is
340                 -- empty
341
342               -- See Note [Injecting implicit bindings]
343               ; all_tidy_binds = implicit_binds ++ tidy_binds
344
345               ; alg_tycons = filter isAlgTyCon (typeEnvTyCons type_env)
346               }
347
348         ; endPass dflags "Tidy Core" Opt_D_dump_simpl all_tidy_binds
349         ; dumpIfSet_core dflags Opt_D_dump_simpl
350                 "Tidy Core Rules"
351                 (pprRules tidy_rules)
352
353         ; let dir_imp_mods = moduleEnvKeys dir_imps
354
355         ; return (CgGuts { cg_module   = mod, 
356                            cg_tycons   = alg_tycons,
357                            cg_binds    = all_tidy_binds,
358                            cg_dir_imps = dir_imp_mods,
359                            cg_foreign  = foreign_stubs,
360                            cg_dep_pkgs = dep_pkgs deps,
361                            cg_hpc_info = hpc_info,
362                            cg_modBreaks = modBreaks }, 
363
364                    ModDetails { md_types     = tidy_type_env,
365                                 md_rules     = tidy_rules,
366                                 md_insts     = tidy_insts,
367                                 md_fam_insts = fam_insts,
368                                 md_exports   = exports,
369                                 md_anns      = anns,     -- are already tidy
370                                 md_vect_info = vect_info --
371                               })
372         }
373
374 lookup_dfun :: TypeEnv -> Var -> Id
375 lookup_dfun type_env dfun_id
376   = case lookupTypeEnv type_env (idName dfun_id) of
377         Just (AnId dfun_id') -> dfun_id'
378         _other -> pprPanic "lookup_dfun" (ppr dfun_id)
379
380 --------------------------
381 tidyTypeEnv :: Bool     -- Compiling without -O, so omit prags
382             -> Bool     -- Template Haskell is on
383             -> NameSet -> TypeEnv -> [Id] -> TypeEnv
384
385 -- The competed type environment is gotten from
386 --      Dropping any wired-in things, and then
387 --      a) keeping the types and classes
388 --      b) removing all Ids, 
389 --      c) adding Ids with correct IdInfo, including unfoldings,
390 --              gotten from the bindings
391 -- From (c) we keep only those Ids with External names;
392 --          the CoreTidy pass makes sure these are all and only
393 --          the externally-accessible ones
394 -- This truncates the type environment to include only the 
395 -- exported Ids and things needed from them, which saves space
396
397 tidyTypeEnv omit_prags th exports type_env final_ids
398  = let  type_env1 = filterNameEnv keep_it type_env
399         type_env2 = extendTypeEnvWithIds type_env1 final_ids
400         type_env3 | omit_prags = mapNameEnv (trimThing th exports) type_env2
401                   | otherwise  = type_env2
402     in 
403     type_env3
404   where
405         -- We keep GlobalIds, because they won't appear 
406         -- in the bindings from which final_ids are derived!
407         -- (The bindings bind LocalIds.)
408     keep_it thing | isWiredInThing thing = False
409     keep_it (AnId id) = isGlobalId id   -- Keep GlobalIds (e.g. class ops)
410     keep_it _other    = True            -- Keep all TyCons, DataCons, and Classes
411
412 --------------------------
413 isWiredInThing :: TyThing -> Bool
414 isWiredInThing thing = isWiredInName (getName thing)
415
416 --------------------------
417 trimThing :: Bool -> NameSet -> TyThing -> TyThing
418 -- Trim off inessentials, for boot files and no -O
419 trimThing th exports (ATyCon tc)
420    | not th && not (mustExposeTyCon exports tc)
421    = ATyCon (makeTyConAbstract tc)      -- Note [Trimming and Template Haskell]
422
423 trimThing _th _exports (AnId id)
424    | not (isImplicitId id) 
425    = AnId (id `setIdInfo` vanillaIdInfo)
426
427 trimThing _th _exports other_thing 
428   = other_thing
429
430
431 {- Note [Trimming and Template Haskell]
432    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
433 Consider (Trac #2386) this
434         module M(T, makeOne) where
435           data T = Yay String
436           makeOne = [| Yay "Yep" |]
437 Notice that T is exported abstractly, but makeOne effectively exports it too!
438 A module that splices in $(makeOne) will then look for a declartion of Yay,
439 so it'd better be there.  Hence, brutally but simply, we switch off type
440 constructor trimming if TH is enabled in this module. -}
441
442
443 mustExposeTyCon :: NameSet      -- Exports
444                 -> TyCon        -- The tycon
445                 -> Bool         -- Can its rep be hidden?
446 -- We are compiling without -O, and thus trying to write as little as 
447 -- possible into the interface file.  But we must expose the details of
448 -- any data types whose constructors or fields are exported
449 mustExposeTyCon exports tc
450   | not (isAlgTyCon tc)         -- Synonyms
451   = True
452   | isEnumerationTyCon tc       -- For an enumeration, exposing the constructors
453   = True                        -- won't lead to the need for further exposure
454                                 -- (This includes data types with no constructors.)
455   | isOpenTyCon tc              -- Open type family
456   = True
457
458   | otherwise                   -- Newtype, datatype
459   = any exported_con (tyConDataCons tc)
460         -- Expose rep if any datacon or field is exported
461
462   || (isNewTyCon tc && isFFITy (snd (newTyConRhs tc)))
463         -- Expose the rep for newtypes if the rep is an FFI type.  
464         -- For a very annoying reason.  'Foreign import' is meant to
465         -- be able to look through newtypes transparently, but it
466         -- can only do that if it can "see" the newtype representation
467   where
468     exported_con con = any (`elemNameSet` exports) 
469                            (dataConName con : dataConFieldLabels con)
470
471 tidyInstances :: (DFunId -> DFunId) -> [Instance] -> [Instance]
472 tidyInstances tidy_dfun ispecs
473   = map tidy ispecs
474   where
475     tidy ispec = setInstanceDFunId ispec $
476                  tidy_dfun (instanceDFunId ispec)
477 \end{code}
478
479
480 %************************************************************************
481 %*                                                                      *
482         Implicit bindings
483 %*                                                                      *
484 %************************************************************************
485
486 Note [Injecting implicit bindings]
487 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
488 We inject the implict bindings right at the end, in CoreTidy.
489 Some of these bindings, notably record selectors, are not
490 constructed in an optimised form.  E.g. record selector for
491         data T = MkT { x :: {-# UNPACK #-} !Int }
492 Then the unfolding looks like
493         x = \t. case t of MkT x1 -> let x = I# x1 in x
494 This generates bad code unless it's first simplified a bit.  That is
495 why CoreUnfold.mkImplicitUnfolding uses simleExprOpt to do a bit of
496 optimisation first.  (Only matters when the selector is used curried;
497 eg map x ys.)  See Trac #2070.
498
499 [Oct 09: in fact, record selectors are no longer implicit Ids at all,
500 because we really do want to optimise them properly. They are treated
501 much like any other Id.  But doing "light" optimisation on an implicit
502 Id still makes sense.]
503
504 At one time I tried injecting the implicit bindings *early*, at the
505 beginning of SimplCore.  But that gave rise to real difficulty,
506 becuase GlobalIds are supposed to have *fixed* IdInfo, but the
507 simplifier and other core-to-core passes mess with IdInfo all the
508 time.  The straw that broke the camels back was when a class selector
509 got the wrong arity -- ie the simplifier gave it arity 2, whereas
510 importing modules were expecting it to have arity 1 (Trac #2844).
511 It's much safer just to inject them right at the end, after tidying.
512
513 Oh: two other reasons for injecting them late:
514
515   - If implicit Ids are already in the bindings when we start TidyPgm,
516     we'd have to be careful not to treat them as external Ids (in
517     the sense of findExternalIds); else the Ids mentioned in *their*
518     RHSs will be treated as external and you get an interface file 
519     saying      a18 = <blah>
520     but nothing refererring to a18 (because the implicit Id is the 
521     one that does, and implicit Ids don't appear in interface files).
522
523   - More seriously, the tidied type-envt will include the implicit
524     Id replete with a18 in its unfolding; but we won't take account
525     of a18 when computing a fingerprint for the class; result chaos.
526     
527 There is one sort of implicit binding that is injected still later,
528 namely those for data constructor workers. Reason (I think): it's
529 really just a code generation trick.... binding itself makes no sense.
530 See CorePrep Note [Data constructor workers].
531
532 \begin{code}
533 getImplicitBinds :: TypeEnv -> [CoreBind]
534 getImplicitBinds type_env
535   = map get_defn (concatMap implicit_ids (typeEnvElts type_env))
536   where
537     implicit_ids (ATyCon tc)  = mapCatMaybes dataConWrapId_maybe (tyConDataCons tc)
538     implicit_ids (AClass cls) = classSelIds cls
539     implicit_ids _            = []
540     
541     get_defn :: Id -> CoreBind
542     get_defn id = NonRec id (unfoldingTemplate (idUnfolding id))
543 \end{code}
544
545
546 %************************************************************************
547 %*                                                                      *
548 \subsection{Step 1: finding externals}
549 %*                                                                      * 
550 %************************************************************************
551
552 Sete Note [choosing external names].
553
554 \begin{code}
555 type UnfoldEnv  = IdEnv (Name{-new name-}, Bool {-show unfolding-})
556   -- maps each top-level Id to its new Name (the Id is tidied in step 2)
557   -- The Unique is unchanged.  If the new Id is external, it will be
558   -- visible in the interface file.  
559   --
560   -- Bool => expose unfolding or not.
561
562 chooseExternalIds :: HscEnv
563                   -> Module
564                   -> Bool
565                   -> [CoreBind]
566                   -> [CoreBind]
567                   -> IO (UnfoldEnv, TidyOccEnv)
568         -- Step 1 from the notes above
569
570 chooseExternalIds hsc_env mod omit_prags binds implicit_binds
571   = do
572     (unfold_env1,occ_env1) 
573         <- search (zip sorted_exports sorted_exports) emptyVarEnv init_occ_env
574     let internal_ids = filter (not . (`elemVarEnv` unfold_env1)) binders
575     tidy_internal internal_ids unfold_env1 occ_env1
576  where
577   nc_var = hsc_NC hsc_env 
578
579   -- the exports, sorted by OccName.  This is a deterministic list of
580   -- Ids (i.e. it's the same list every time this module is compiled),
581   -- in contrast to the bindings, which are ordered
582   -- non-deterministically.
583   --
584   -- This list will serve as a starting point for finding a
585   -- deterministic, tidy, renaming for all external Ids in this
586   -- module.
587   sorted_exports = sortBy (compare `on` getOccName) $
588                      filter isExportedId binders
589
590   binders = bindersOfBinds binds
591   implicit_binders = bindersOfBinds implicit_binds
592
593   bind_env :: IdEnv (Id,CoreExpr)
594   bind_env = mkVarEnv (zip (map fst bs) bs) where bs = flattenBinds binds
595
596   avoids   = [getOccName name | bndr <- binders ++ implicit_binders,
597                                 let name = idName bndr,
598                                 isExternalName name ]
599                 -- In computing our "avoids" list, we must include
600                 --      all implicit Ids
601                 --      all things with global names (assigned once and for
602                 --                                      all by the renamer)
603                 -- since their names are "taken".
604                 -- The type environment is a convenient source of such things.
605                 -- In particular, the set of binders doesn't include
606                 -- implicit Ids at this stage.
607
608         -- We also make sure to avoid any exported binders.  Consider
609         --      f{-u1-} = 1     -- Local decl
610         --      ...
611         --      f{-u2-} = 2     -- Exported decl
612         --
613         -- The second exported decl must 'get' the name 'f', so we
614         -- have to put 'f' in the avoids list before we get to the first
615         -- decl.  tidyTopId then does a no-op on exported binders.
616   init_occ_env = initTidyOccEnv avoids
617
618
619   search :: [(Id,Id)]    -- (external id, referrring id)
620          -> UnfoldEnv    -- id -> (new Name, show_unfold)
621          -> TidyOccEnv   -- occ env for choosing new Names
622          -> IO (UnfoldEnv, TidyOccEnv)
623
624   search [] unfold_env occ_env = return (unfold_env, occ_env)
625
626   search ((idocc,referrer) : rest) unfold_env occ_env
627     | idocc `elemVarEnv` unfold_env = search rest unfold_env occ_env
628     | otherwise = do
629       (occ_env', name') <- tidyTopName mod nc_var (Just referrer) occ_env idocc
630       let 
631           (id, rhs) = expectJust (showSDoc (text "chooseExternalIds: " <>
632                                             ppr idocc)) $
633                                  lookupVarEnv bind_env idocc
634           -- NB. idocc might be an *occurrence* of an Id, whereas we want
635           -- the Id from the binding site, because only the latter is
636           -- guaranteed to have the unfolding attached.  This is why we
637           -- keep binding site Ids in the bind_env.
638           (new_ids, show_unfold)
639                 | omit_prags = ([], False)
640                 | otherwise  = addExternal id rhs
641           unfold_env' = extendVarEnv unfold_env id (name',show_unfold)
642           referrer' | isExportedId id = id
643                     | otherwise       = referrer
644       --
645       search (zip new_ids (repeat referrer') ++ rest) unfold_env' occ_env'
646
647   tidy_internal :: [Id] -> UnfoldEnv -> TidyOccEnv
648                 -> IO (UnfoldEnv, TidyOccEnv)
649   tidy_internal []       unfold_env occ_env = return (unfold_env,occ_env)
650   tidy_internal (id:ids) unfold_env occ_env = do
651       (occ_env', name') <- tidyTopName mod nc_var Nothing occ_env id
652       let unfold_env' = extendVarEnv unfold_env id (name',False)
653       tidy_internal ids unfold_env' occ_env'
654
655 addExternal :: Id -> CoreExpr -> ([Id],Bool)
656 addExternal id rhs = (new_needed_ids, show_unfold)
657   where
658     new_needed_ids = unfold_ids ++
659                      filter (\id -> isLocalId id &&
660                                     not (id `elemVarSet` unfold_set))
661                        (varSetElems worker_ids ++ 
662                         varSetElems spec_ids) -- XXX non-det ordering
663
664     idinfo         = idInfo id
665     dont_inline    = isNeverActive (inlinePragmaActivation (inlinePragInfo idinfo))
666     loop_breaker   = isNonRuleLoopBreaker (occInfo idinfo)
667     bottoming_fn   = isBottomingSig (newStrictnessInfo idinfo `orElse` topSig)
668     spec_ids       = specInfoFreeVars (specInfo idinfo)
669     worker_info    = workerInfo idinfo
670
671         -- Stuff to do with the Id's unfolding
672         -- The simplifier has put an up-to-date unfolding
673         -- in the IdInfo, but the RHS will do just as well
674     unfolding    = unfoldingInfo idinfo
675     rhs_is_small = not (neverUnfold unfolding)
676
677         -- We leave the unfolding there even if there is a worker
678         -- In GHCI the unfolding is used by importers
679         -- When writing an interface file, we omit the unfolding 
680         -- if there is a worker
681     show_unfold = not bottoming_fn       &&     -- Not necessary
682                   not dont_inline        &&
683                   not loop_breaker       &&
684                   rhs_is_small                  -- Small enough
685
686     (unfold_set, unfold_ids)
687                | show_unfold = freeVarsInDepthFirstOrder rhs
688                | otherwise   = (emptyVarSet, [])
689
690     worker_ids = case worker_info of
691                    HasWorker work_id _ -> unitVarSet work_id
692                    _otherwise          -> emptyVarSet
693
694
695 -- We want a deterministic free-variable list.  exprFreeVars gives us
696 -- a VarSet, which is in a non-deterministic order when converted to a
697 -- list.  Hence, here we define a free-variable finder that returns
698 -- the free variables in the order that they are encountered.
699 --
700 -- Note [choosing external names]
701
702 freeVarsInDepthFirstOrder :: CoreExpr -> (VarSet, [Id])
703 freeVarsInDepthFirstOrder e = 
704   case dffvExpr e of
705     DFFV m -> case m emptyVarSet [] of
706                 (set,ids,_) -> (set,ids)
707
708 newtype DFFV a = DFFV (VarSet -> [Var] -> (VarSet,[Var],a))
709
710 instance Monad DFFV where
711   return a = DFFV $ \set ids -> (set, ids, a)
712   (DFFV m) >>= k = DFFV $ \set ids ->
713     case m set ids of
714        (set',ids',a) -> case k a of
715                           DFFV f -> f set' ids' 
716
717 insert :: Var -> DFFV ()
718 insert v = DFFV $ \ set ids  -> case () of 
719  _ | v `elemVarSet` set -> (set,ids,())
720    | otherwise          -> (extendVarSet set v, v:ids, ())
721
722 dffvExpr :: CoreExpr -> DFFV ()
723 dffvExpr e = go emptyVarSet e
724   where
725     go scope e = case e of
726       Var v | isLocalId v && not (v `elemVarSet` scope) -> insert v
727       App e1 e2          -> do go scope e1; go scope e2
728       Lam v e            -> go (extendVarSet scope v) e
729       Note _ e           -> go scope e
730       Cast e _           -> go scope e
731       Let (NonRec x r) e -> do go scope r; go (extendVarSet scope x) e
732       Let (Rec prs) e    -> do let scope' = extendVarSetList scope (map fst prs)
733                                mapM_ (go scope') (map snd prs)
734                                go scope' e
735       Case e b _ as      -> do go scope e
736                                mapM_ (go_alt (extendVarSet scope b)) as
737       _other             -> return ()
738
739     go_alt scope (_,xs,r) = go (extendVarSetList scope xs) r
740 \end{code}
741
742
743 --------------------------------------------------------------------
744 --              tidyTopName
745 -- This is where we set names to local/global based on whether they really are 
746 -- externally visible (see comment at the top of this module).  If the name
747 -- was previously local, we have to give it a unique occurrence name if
748 -- we intend to externalise it.
749
750 \begin{code}
751 tidyTopName :: Module -> IORef NameCache -> Maybe Id -> TidyOccEnv
752             -> Id -> IO (TidyOccEnv, Name)
753 tidyTopName mod nc_var maybe_ref occ_env id
754   | global && internal = return (occ_env, localiseName name)
755
756   | global && external = return (occ_env, name)
757         -- Global names are assumed to have been allocated by the renamer,
758         -- so they already have the "right" unique
759         -- And it's a system-wide unique too
760
761   -- Now we get to the real reason that all this is in the IO Monad:
762   -- we have to update the name cache in a nice atomic fashion
763
764   | local  && internal = do { nc <- readIORef nc_var
765                             ; let (nc', new_local_name) = mk_new_local nc
766                             ; writeIORef nc_var nc'
767                             ; return (occ_env', new_local_name) }
768         -- Even local, internal names must get a unique occurrence, because
769         -- if we do -split-objs we externalise the name later, in the code generator
770         --
771         -- Similarly, we must make sure it has a system-wide Unique, because
772         -- the byte-code generator builds a system-wide Name->BCO symbol table
773
774   | local  && external = do { nc <- readIORef nc_var
775                             ; let (nc', new_external_name) = mk_new_external nc
776                             ; writeIORef nc_var nc'
777                             ; return (occ_env', new_external_name) }
778
779   | otherwise = panic "tidyTopName"
780   where
781     name        = idName id
782     external    = isJust maybe_ref
783     global      = isExternalName name
784     local       = not global
785     internal    = not external
786     loc         = nameSrcSpan name
787
788     old_occ     = nameOccName name
789     new_occ
790       | Just ref <- maybe_ref, ref /= id = 
791           mkOccName (occNameSpace old_occ) $
792              let
793                  ref_str = occNameString (getOccName ref)
794                  occ_str = occNameString old_occ
795              in
796              case occ_str of
797                '$':'w':_ -> occ_str
798                   -- workers: the worker for a function already
799                   -- includes the occname for its parent, so there's
800                   -- no need to prepend the referrer.
801                _other | isSystemName name -> ref_str
802                       | otherwise         -> ref_str ++ '_' : occ_str
803                   -- If this name was system-generated, then don't bother
804                   -- to retain its OccName, just use the referrer.  These
805                   -- system-generated names will become "f1", "f2", etc. for
806                   -- a referrer "f".
807       | otherwise = old_occ
808
809     (occ_env', occ') = tidyOccName occ_env new_occ
810
811     mk_new_local nc = (nc { nsUniqs = us2 }, mkInternalName uniq occ' loc)
812                     where
813                       (us1, us2) = splitUniqSupply (nsUniqs nc)
814                       uniq       = uniqFromSupply us1
815
816     mk_new_external nc = allocateGlobalBinder nc mod occ' loc
817         -- If we want to externalise a currently-local name, check
818         -- whether we have already assigned a unique for it.
819         -- If so, use it; if not, extend the table.
820         -- All this is done by allcoateGlobalBinder.
821         -- This is needed when *re*-compiling a module in GHCi; we must
822         -- use the same name for externally-visible things as we did before.
823 \end{code}
824
825 \begin{code}
826 findExternalRules :: [CoreBind]
827                   -> [CoreRule] -- Non-local rules (i.e. ones for imported fns)
828                   -> UnfoldEnv  -- Ids that are exported, so we need their rules
829                   -> [CoreRule]
830   -- The complete rules are gotten by combining
831   --    a) the non-local rules
832   --    b) rules embedded in the top-level Ids
833 findExternalRules binds non_local_rules unfold_env
834   = filter (not . internal_rule) (non_local_rules ++ local_rules)
835   where
836     local_rules  = [ rule
837                    | id <- bindersOfBinds binds,
838                      external_id id,
839                      rule <- idCoreRules id
840                    ]
841
842     internal_rule rule
843         =  any (not . external_id) (varSetElems (ruleLhsFreeIds rule))
844                 -- Don't export a rule whose LHS mentions a locally-defined
845                 --  Id that is completely internal (i.e. not visible to an
846                 -- importing module)
847
848     external_id id
849       | Just (name,_) <- lookupVarEnv unfold_env id = isExternalName name
850       | otherwise = False
851 \end{code}
852
853
854
855 %************************************************************************
856 %*                                                                      *
857 \subsection{Step 2: top-level tidying}
858 %*                                                                      *
859 %************************************************************************
860
861
862 \begin{code}
863 -- TopTidyEnv: when tidying we need to know
864 --   * nc_var: The NameCache, containing a unique supply and any pre-ordained Names.  
865 --        These may have arisen because the
866 --        renamer read in an interface file mentioning M.$wf, say,
867 --        and assigned it unique r77.  If, on this compilation, we've
868 --        invented an Id whose name is $wf (but with a different unique)
869 --        we want to rename it to have unique r77, so that we can do easy
870 --        comparisons with stuff from the interface file
871 --
872 --   * occ_env: The TidyOccEnv, which tells us which local occurrences 
873 --     are 'used'
874 --
875 --   * subst_env: A Var->Var mapping that substitutes the new Var for the old
876
877 tidyTopBinds :: HscEnv
878              -> UnfoldEnv
879              -> TidyOccEnv
880              -> [CoreBind]
881              -> (TidyEnv, [CoreBind])
882
883 tidyTopBinds hsc_env unfold_env init_occ_env binds
884   = tidy init_env binds
885   where
886     init_env = (init_occ_env, emptyVarEnv)
887
888     this_pkg = thisPackage (hsc_dflags hsc_env)
889
890     tidy env []     = (env, [])
891     tidy env (b:bs) = let (env1, b')  = tidyTopBind this_pkg unfold_env env b
892                           (env2, bs') = tidy env1 bs
893                       in
894                           (env2, b':bs')
895
896 ------------------------
897 tidyTopBind  :: PackageId
898              -> UnfoldEnv
899              -> TidyEnv
900              -> CoreBind
901              -> (TidyEnv, CoreBind)
902
903 tidyTopBind this_pkg unfold_env (occ_env,subst1) (NonRec bndr rhs)
904   = (tidy_env2,  NonRec bndr' rhs')
905   where
906     Just (name',show_unfold) = lookupVarEnv unfold_env bndr
907     caf_info      = hasCafRefs this_pkg subst1 (idArity bndr) rhs
908     (bndr', rhs') = tidyTopPair show_unfold tidy_env2 caf_info name' (bndr, rhs)
909     subst2        = extendVarEnv subst1 bndr bndr'
910     tidy_env2     = (occ_env, subst2)
911
912 tidyTopBind this_pkg unfold_env (occ_env,subst1) (Rec prs)
913   = (tidy_env2, Rec prs')
914   where
915     prs' = [ tidyTopPair show_unfold tidy_env2 caf_info name' (id,rhs)
916            | (id,rhs) <- prs,
917              let (name',show_unfold) = 
918                     expectJust "tidyTopBind" $ lookupVarEnv unfold_env id
919            ]
920
921     subst2    = extendVarEnvList subst1 (bndrs `zip` map fst prs')
922     tidy_env2 = (occ_env, subst2)
923
924     bndrs = map fst prs
925
926         -- the CafInfo for a recursive group says whether *any* rhs in
927         -- the group may refer indirectly to a CAF (because then, they all do).
928     caf_info 
929         | or [ mayHaveCafRefs (hasCafRefs this_pkg subst1 (idArity bndr) rhs)
930              | (bndr,rhs) <- prs ] = MayHaveCafRefs
931         | otherwise                = NoCafRefs
932
933 -----------------------------------------------------------
934 tidyTopPair :: Bool  -- show unfolding
935             -> TidyEnv  -- The TidyEnv is used to tidy the IdInfo
936                         -- It is knot-tied: don't look at it!
937             -> CafInfo
938             -> Name             -- New name
939             -> (Id, CoreExpr)   -- Binder and RHS before tidying
940             -> (Id, CoreExpr)
941         -- This function is the heart of Step 2
942         -- The rec_tidy_env is the one to use for the IdInfo
943         -- It's necessary because when we are dealing with a recursive
944         -- group, a variable late in the group might be mentioned
945         -- in the IdInfo of one early in the group
946
947 tidyTopPair show_unfold rhs_tidy_env caf_info name' (bndr, rhs)
948   = (bndr', rhs')
949   where
950     bndr' = mkGlobalId details name' ty' idinfo'
951     details = idDetails bndr    -- Preserve the IdDetails
952     ty'     = tidyTopType (idType bndr)
953     rhs'    = tidyExpr rhs_tidy_env rhs
954     idinfo  = idInfo bndr
955     idinfo' = tidyTopIdInfo (isExternalName name')
956                             idinfo unfold_info worker_info
957                             arity caf_info
958
959     unfold_info | show_unfold = mkTopUnfolding rhs'
960                 | otherwise   = noUnfolding
961     worker_info = tidyWorker rhs_tidy_env show_unfold (workerInfo idinfo)
962
963     -- Usually the Id will have an accurate arity on it, because
964     -- the simplifier has just run, but not always. 
965     -- One case I found was when the last thing the simplifier
966     -- did was to let-bind a non-atomic argument and then float
967     -- it to the top level. So it seems more robust just to
968     -- fix it here.
969     arity = exprArity rhs
970
971
972 -- tidyTopIdInfo creates the final IdInfo for top-level
973 -- binders.  There are two delicate pieces:
974 --
975 --  * Arity.  After CoreTidy, this arity must not change any more.
976 --      Indeed, CorePrep must eta expand where necessary to make
977 --      the manifest arity equal to the claimed arity.
978 --
979 --  * CAF info.  This must also remain valid through to code generation.
980 --      We add the info here so that it propagates to all
981 --      occurrences of the binders in RHSs, and hence to occurrences in
982 --      unfoldings, which are inside Ids imported by GHCi. Ditto RULES.
983 --      CoreToStg makes use of this when constructing SRTs.
984 tidyTopIdInfo :: Bool -> IdInfo -> Unfolding
985               -> WorkerInfo -> ArityInfo -> CafInfo
986               -> IdInfo
987 tidyTopIdInfo is_external idinfo unfold_info worker_info arity caf_info
988   | not is_external     -- For internal Ids (not externally visible)
989   = vanillaIdInfo       -- we only need enough info for code generation
990                         -- Arity and strictness info are enough;
991                         --      c.f. CoreTidy.tidyLetBndr
992         `setCafInfo`           caf_info
993         `setArityInfo`         arity
994         `setAllStrictnessInfo` newStrictnessInfo idinfo
995
996   | otherwise           -- Externally-visible Ids get the whole lot
997   = vanillaIdInfo
998         `setCafInfo`           caf_info
999         `setArityInfo`         arity
1000         `setAllStrictnessInfo` newStrictnessInfo idinfo
1001         `setInlinePragInfo`    inlinePragInfo idinfo
1002         `setUnfoldingInfo`     unfold_info
1003         `setWorkerInfo`        worker_info
1004                 -- NB: we throw away the Rules
1005                 -- They have already been extracted by findExternalRules
1006
1007
1008
1009 ------------  Worker  --------------
1010 tidyWorker :: TidyEnv -> Bool -> WorkerInfo -> WorkerInfo
1011 tidyWorker _tidy_env _show_unfold NoWorker
1012   = NoWorker
1013 tidyWorker tidy_env show_unfold (HasWorker work_id wrap_arity) 
1014   | show_unfold = HasWorker (tidyVarOcc tidy_env work_id) wrap_arity
1015   | otherwise   = NoWorker
1016     -- NB: do *not* expose the worker if show_unfold is off,
1017     --     because that means this thing is a loop breaker or
1018     --     marked NOINLINE or something like that
1019     -- This is important: if you expose the worker for a loop-breaker
1020     -- then you can make the simplifier go into an infinite loop, because
1021     -- in effect the unfolding is exposed.  See Trac #1709
1022     -- 
1023     -- You might think that if show_unfold is False, then the thing should
1024     -- not be w/w'd in the first place.  But a legitimate reason is this:
1025     --    the function returns bottom
1026     -- In this case, show_unfold will be false (we don't expose unfoldings
1027     -- for bottoming functions), but we might still have a worker/wrapper
1028     -- split (see Note [Worker-wrapper for bottoming functions] in WorkWrap.lhs
1029 \end{code}
1030
1031 %************************************************************************
1032 %*                                                                      *
1033 \subsection{Figuring out CafInfo for an expression}
1034 %*                                                                      *
1035 %************************************************************************
1036
1037 hasCafRefs decides whether a top-level closure can point into the dynamic heap.
1038 We mark such things as `MayHaveCafRefs' because this information is
1039 used to decide whether a particular closure needs to be referenced
1040 in an SRT or not.
1041
1042 There are two reasons for setting MayHaveCafRefs:
1043         a) The RHS is a CAF: a top-level updatable thunk.
1044         b) The RHS refers to something that MayHaveCafRefs
1045
1046 Possible improvement: In an effort to keep the number of CAFs (and 
1047 hence the size of the SRTs) down, we could also look at the expression and 
1048 decide whether it requires a small bounded amount of heap, so we can ignore 
1049 it as a CAF.  In these cases however, we would need to use an additional
1050 CAF list to keep track of non-collectable CAFs.  
1051
1052 \begin{code}
1053 hasCafRefs  :: PackageId -> VarEnv Var -> Arity -> CoreExpr -> CafInfo
1054 hasCafRefs this_pkg p arity expr 
1055   | is_caf || mentions_cafs 
1056                             = MayHaveCafRefs
1057   | otherwise               = NoCafRefs
1058  where
1059   mentions_cafs = isFastTrue (cafRefs p expr)
1060   is_caf = not (arity > 0 || rhsIsStatic this_pkg expr)
1061
1062   -- NB. we pass in the arity of the expression, which is expected
1063   -- to be calculated by exprArity.  This is because exprArity
1064   -- knows how much eta expansion is going to be done by 
1065   -- CorePrep later on, and we don't want to duplicate that
1066   -- knowledge in rhsIsStatic below.
1067
1068 cafRefs :: VarEnv Id -> Expr a -> FastBool
1069 cafRefs p (Var id)
1070         -- imported Ids first:
1071   | not (isLocalId id) = fastBool (mayHaveCafRefs (idCafInfo id))
1072         -- now Ids local to this module:
1073   | otherwise =
1074      case lookupVarEnv p id of
1075         Just id' -> fastBool (mayHaveCafRefs (idCafInfo id'))
1076         Nothing  -> fastBool False
1077
1078 cafRefs _ (Lit _)              = fastBool False
1079 cafRefs p (App f a)            = fastOr (cafRefs p f) (cafRefs p) a
1080 cafRefs p (Lam _ e)            = cafRefs p e
1081 cafRefs p (Let b e)            = fastOr (cafRefss p (rhssOfBind b)) (cafRefs p) e
1082 cafRefs p (Case e _bndr _ alts) = fastOr (cafRefs p e) (cafRefss p) (rhssOfAlts alts)
1083 cafRefs p (Note _n e)          = cafRefs p e
1084 cafRefs p (Cast e _co)         = cafRefs p e
1085 cafRefs _ (Type _)             = fastBool False
1086
1087 cafRefss :: VarEnv Id -> [Expr a] -> FastBool
1088 cafRefss _ []     = fastBool False
1089 cafRefss p (e:es) = fastOr (cafRefs p e) (cafRefss p) es
1090
1091 fastOr :: FastBool -> (a -> FastBool) -> a -> FastBool
1092 -- hack for lazy-or over FastBool.
1093 fastOr a f x = fastBool (isFastTrue a || isFastTrue (f x))
1094 \end{code}