TidyPgm.lhs 60.9 KB
Newer Older
Simon Marlow's avatar
Simon Marlow committed
1

2
3
4
5
6
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section{Tidying up Core}

\begin{code}
7
8
{-# LANGUAGE CPP #-}

9
10
11
module TidyPgm (
       mkBootModDetailsTc, tidyProgram, globaliseAndTidyId
   ) where
12
13
14

#include "HsVersions.h"

Simon Marlow's avatar
Simon Marlow committed
15
import TcRnTypes
Simon Marlow's avatar
Simon Marlow committed
16
import DynFlags
17
import CoreSyn
Simon Marlow's avatar
Simon Marlow committed
18
19
20
import CoreUnfold
import CoreFVs
import CoreTidy
21
import CoreMonad
22
import CorePrep
Simon Marlow's avatar
Simon Marlow committed
23
import CoreUtils
24
import Literal
25
import Rules
26
27
import PatSyn
import ConLike
28
import CoreArity        ( exprArity, exprBotStrictness_maybe )
29
30
import VarEnv
import VarSet
31
import Var
Simon Marlow's avatar
Simon Marlow committed
32
import Id
33
import MkId             ( mkDictSelRhs )
Simon Marlow's avatar
Simon Marlow committed
34
35
import IdInfo
import InstEnv
36
import FamInstEnv
Simon Peyton Jones's avatar
Simon Peyton Jones committed
37
import Type             ( tidyTopType )
38
import Demand           ( appIsBottom, isNopSig, isBottomingSig )
Simon Marlow's avatar
Simon Marlow committed
39
import BasicTypes
40
import Name hiding (varName)
Simon Marlow's avatar
Simon Marlow committed
41
42
import NameSet
import NameEnv
43
44
import Avail
import IfaceEnv
45
46
import TcEnv
import TcRnMonad
Simon Marlow's avatar
Simon Marlow committed
47
48
import DataCon
import TyCon
49
import Class
50
import Module
51
import Packages( isDllName )
52
import HscTypes
Simon Marlow's avatar
Simon Marlow committed
53
54
import Maybes
import UniqSupply
55
import ErrUtils (Severity(..))
56
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
57
import FastBool hiding ( fastOr )
58
import SrcLoc
59
import FastString
60
import qualified ErrUtils as Err
Simon Marlow's avatar
Simon Marlow committed
61

62
import Control.Monad
Ian Lynagh's avatar
Ian Lynagh committed
63
import Data.Function
64
import Data.List        ( sortBy )
65
import Data.IORef       ( atomicModifyIORef )
66
67
68
\end{code}


69
70
71
Constructing the TypeEnv, Instances, Rules, VectInfo from which the
ModIface is constructed, and which goes on to subsequent modules in
--make mode.
72
73
74
75
76
77
78
79

Most of the interface file is obtained simply by serialising the
TypeEnv.  One important consequence is that if the *interface file*
has pragma info if and only if the final TypeEnv does. This is not so
important for *this* module, but it's essential for ghc --make:
subsequent compilations must not see (e.g.) the arity if the interface
file does not contain arity If they do, they'll exploit the arity;
then the arity might change, but the iface file doesn't change =>
80
recompilation does not happen => disaster.
81
82
83
84
85
86
87

For data types, the final TypeEnv will have a TyThing for the TyCon,
plus one for each DataCon; the interface file will contain just one
data type declaration, but it is de-serialised back into a collection
of TyThings.

%************************************************************************
88
89
90
%*                                                                      *
                Plan A: simpleTidyPgm
%*                                                                      *
91
92
93
%************************************************************************


94
Plan A: mkBootModDetails: omit pragmas, make interfaces small
95
96
97
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Ignore the bindings

98
99
* Drop all WiredIn things from the TypeEnv
        (we never want them in interface files)
100
101

* Retain all TyCons and Classes in the TypeEnv, to avoid
102
103
        having to find which ones are mentioned in the
        types of exported Ids
104
105

* Trim off the constructors of non-exported TyCons, both
106
        from the TyCon and from the TypeEnv
107
108
109

* Drop non-exported Ids from the TypeEnv

110
* Tidy the types of the DFunIds of Instances,
111
112
113
114
115
116
117
118
  make them into GlobalIds, (they already have External Names)
  and add them to the TypeEnv

* Tidy the types of the (exported) Ids in the TypeEnv,
  make them into GlobalIds (they already have External Names)

* Drop rules altogether

119
* Tidy the bindings, to ensure that the Caf and Arity
120
  information is correct for each top-level binder; the
121
122
  code generator needs it. And to ensure that local names have
  distinct OccNames in case of object-file splitting
123
124
125
126

\begin{code}
-- This is Plan A: make a small type env when typechecking only,
-- or when compiling a hs-boot file, or simply when not using -O
127
128
129
--
-- We don't look at the bindings at all -- there aren't any
-- for hs-boot files
130

Simon Marlow's avatar
Simon Marlow committed
131
mkBootModDetailsTc :: HscEnv -> TcGblEnv -> IO ModDetails
132
mkBootModDetailsTc hsc_env
Simon Marlow's avatar
Simon Marlow committed
133
        TcGblEnv{ tcg_exports   = exports,
134
135
                  tcg_type_env  = type_env, -- just for the Ids
                  tcg_tcs       = tcs,
136
                  tcg_patsyns   = pat_syns,
Simon Marlow's avatar
Simon Marlow committed
137
138
139
                  tcg_insts     = insts,
                  tcg_fam_insts = fam_insts
                }
140
  = do  { let dflags = hsc_dflags hsc_env
141
        ; showPass dflags CoreTidy
142

143
        ; let { insts'      = map (tidyClsInstDFun globaliseAndTidyId) insts
144
              ; type_env1  = mkBootTypeEnv (availsToNameSet exports)
145
                                           (typeEnvIds type_env) tcs fam_insts
146
147
148
149
              ; pat_syns'   = map (tidyPatSynIds   globaliseAndTidyId) pat_syns
              ; type_env2  = extendTypeEnvWithPatSyns pat_syns' type_env1
              ; dfun_ids    = map instanceDFunId insts'
              ; type_env'  = extendTypeEnvWithIds type_env2 dfun_ids
150
151
152
153
154
155
156
              }
        ; return (ModDetails { md_types     = type_env'
                             , md_insts     = insts'
                             , md_fam_insts = fam_insts
                             , md_rules     = []
                             , md_anns      = []
                             , md_exports   = exports
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
157
                             , md_vect_info = noVectInfo
158
                             })
159
        }
160
161
  where

162
mkBootTypeEnv :: NameSet -> [Id] -> [TyCon] -> [FamInst] -> TypeEnv
dreixel's avatar
dreixel committed
163
mkBootTypeEnv exports ids tcs fam_insts
164
  = tidyTypeEnv True $
dreixel's avatar
dreixel committed
165
       typeEnvFromEntities final_ids tcs fam_insts
166
  where
167
        -- Find the LocalIds in the type env that are exported
168
169
170
171
172
173
        -- Make them into GlobalIds, and tidy their types
        --
        -- It's very important to remove the non-exported ones
        -- because we don't tidy the OccNames, and if we don't remove
        -- the non-exported ones we'll get many things with the
        -- same name in the interface file, giving chaos.
174
175
176
177
178
179
180
181
        --
        -- Do make sure that we keep Ids that are already Global.
        -- When typechecking an .hs-boot file, the Ids come through as
        -- GlobalIds.
    final_ids = [ if isLocalId id then globaliseAndTidyId id
                                  else id
                | id <- ids
                , keep_it id ]
182
183
184
185
186

        -- default methods have their export flag set, but everything
        -- else doesn't (yet), because this is pre-desugaring, so we
        -- must test both.
    keep_it id = isExportedId id || idName id `elemNameSet` exports
187
188


189
190

globaliseAndTidyId :: Id -> Id
191
192
-- Takes an LocalId with an External Name,
-- makes it into a GlobalId
193
194
195
--     * unchanged Name (might be Internal or External)
--     * unchanged details
--     * VanillaIdInfo (makes a conservative assumption about Caf-hood)
196
globaliseAndTidyId id
197
198
199
  = Id.setIdType (globaliseId id) tidy_type
  where
    tidy_type = tidyTopType (idType id)
200
201
202
\end{code}


203
%************************************************************************
204
205
206
%*                                                                      *
        Plan B: tidy bindings, make TypeEnv full of IdInfo
%*                                                                      *
207
208
%************************************************************************

209
Plan B: include pragmas, make interfaces
210
211
212
213
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Figure out which Ids are externally visible

* Tidy the bindings, externalising appropriate Ids
214

215
* Drop all Ids from the TypeEnv, and add all the External Ids from
216
217
  the bindings.  (This adds their IdInfo to the TypeEnv; and adds
  floated-out Ids that weren't even in the TypeEnv before.)
218
219
220

Step 1: Figure out external Ids
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221
222
Note [choosing external names]

Simon Marlow's avatar
Simon Marlow committed
223
224
See also the section "Interface stability" in the
RecompilationAvoidance commentary:
225
  http://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/RecompilationAvoidance
Simon Marlow's avatar
Simon Marlow committed
226

227
228
229
First we figure out which Ids are "external" Ids.  An
"external" Id is one that is visible from outside the compilation
unit.  These are
230
  a) the user exported ones
231
  b) ones mentioned in the unfoldings, workers,
232
233
     rules of externally-visible ones ,
     or vectorised versions of externally-visible ones
234

235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
While figuring out which Ids are external, we pick a "tidy" OccName
for each one.  That is, we make its OccName distinct from the other
external OccNames in this module, so that in interface files and
object code we can refer to it unambiguously by its OccName.  The
OccName for each binder is prefixed by the name of the exported Id
that references it; e.g. if "f" references "x" in its unfolding, then
"x" is renamed to "f_x".  This helps distinguish the different "x"s
from each other, and means that if "f" is later removed, things that
depend on the other "x"s will not need to be recompiled.  Of course,
if there are multiple "f_x"s, then we have to disambiguate somehow; we
use "f_x0", "f_x1" etc.

As far as possible we should assign names in a deterministic fashion.
Each time this module is compiled with the same options, we should end
up with the same set of external names with the same types.  That is,
the ABI hash in the interface should not change.  This turns out to be
quite tricky, since the order of the bindings going into the tidy
phase is already non-deterministic, as it is based on the ordering of
Uniques, which are assigned unpredictably.

To name things in a stable way, we do a depth-first-search of the
bindings, starting from the exports sorted by name.  This way, as long
as the bindings themselves are deterministic (they sometimes aren't!),
the order in which they are presented to the tidying phase does not
affect the names we assign.
260
261
262
263
264
265

Step 2: Tidy the program
~~~~~~~~~~~~~~~~~~~~~~~~
Next we traverse the bindings top to bottom.  For each *top-level*
binder

266
267
 1. Make it into a GlobalId; its IdDetails becomes VanillaGlobal,
    reflecting the fact that from now on we regard it as a global,
268
    not local, Id
269
270
271
272
273

 2. Give it a system-wide Unique.
    [Even non-exported things need system-wide Uniques because the
    byte-code generator builds a single Name->BCO symbol table.]

274
    We use the NameCache kept in the HscEnv as the
275
276
    source of such system-wide uniques.

277
    For external Ids, use the original-name cache in the NameCache
278
    to ensure that the unique assigned is the same as the Id had
279
    in any previous compilation run.
280
281
282
283
284
285

 3. Rename top-level Ids according to the names we chose in step 1.
    If it's an external Id, make it have a External Name, otherwise
    make it have an Internal Name.  This is used by the code generator
    to decide whether to make the label externally visible

286
287
288
289
290
291
 4. Give it its UTTERLY FINAL IdInfo; in ptic,
        * its unfolding, if it should have one

        * its arity, computed from the number of visible lambdas

        * its CAF info, computed from what is free in its RHS
292
293
294
295
296
297
298


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}
299
tidyProgram :: HscEnv -> ModGuts -> IO (CgGuts, ModDetails)
300
301
tidyProgram hsc_env  (ModGuts { mg_module    = mod
                              , mg_exports   = exports
302
                              , mg_tcs       = tcs
303
304
305
                              , mg_insts     = insts
                              , mg_fam_insts = fam_insts
                              , mg_binds     = binds
Gergő Érdi's avatar
Gergő Érdi committed
306
                              , mg_patsyns   = patsyns
307
308
309
                              , mg_rules     = imp_rules
                              , mg_vect_info = vect_info
                              , mg_anns      = anns
310
                              , mg_deps      = deps
311
312
                              , mg_foreign   = foreign_stubs
                              , mg_hpc_info  = hpc_info
313
                              , mg_modBreaks = modBreaks
314
315
316
                              })

  = do  { let { dflags     = hsc_dflags hsc_env
ian@well-typed.com's avatar
ian@well-typed.com committed
317
318
              ; omit_prags = gopt Opt_OmitInterfacePragmas dflags
              ; expose_all = gopt Opt_ExposeAllUnfoldings  dflags
319
              }
320
        ; showPass dflags CoreTidy
321

dreixel's avatar
dreixel committed
322
        ; let { type_env = typeEnvFromEntities [] tcs fam_insts
323
324
325
326
327

              ; implicit_binds
                  = concatMap getClassImplicitBinds (typeEnvClasses type_env) ++
                    concatMap getTyConImplicitBinds (typeEnvTyCons type_env)
              }
328

329
        ; (unfold_env, tidy_occ_env)
330
              <- chooseExternalIds hsc_env mod omit_prags expose_all
331
                                   binds implicit_binds imp_rules (vectInfoVar vect_info)
332
333
        ; let { (trimmed_binds, trimmed_rules) 
                    = findExternalRules omit_prags binds imp_rules unfold_env }
334

335
        ; (tidy_env, tidy_binds)
336
                 <- tidyTopBinds hsc_env mod unfold_env tidy_occ_env trimmed_binds
337

338
        ; let { final_ids  = [ id | id <- bindersOfBinds tidy_binds,
339
                                    isExternalName (idName id)]
340
              ; type_env1  = extendTypeEnvWithIds type_env final_ids
341

342
343
344
345
346
              ; tidy_insts = map (tidyClsInstDFun (lookup_aux_id tidy_type_env)) insts
                -- A DFunId will have a binding in tidy_binds, and so will now be in
                -- tidy_type_env, replete with IdInfo.  Its name will be unchanged since
                -- it was born, but we want Global, IdInfo-rich (or not) DFunId in the
                -- tidy_insts.  Similarly the Ids inside a PatSyn.
347

348
              ; tidy_rules = tidyRules tidy_env trimmed_rules
349
350
351
                -- You might worry that the tidy_env contains IdInfo-rich stuff
                -- and indeed it does, but if omit_prags is on, ext_rules is
                -- empty
352

353
354
              ; tidy_vect_info = tidyVectInfo tidy_env vect_info

355
356
357
358
359
                -- Tidy the Ids inside each PatSyn, very similarly to DFunIds
                -- and then override the PatSyns in the type_env with the new tidy ones
                -- This is really the only reason we keep mg_patsyns at all; otherwise
                -- they could just stay in type_env
              ; tidy_patsyns = map (tidyPatSynIds (lookup_aux_id tidy_type_env)) patsyns
360
              ; type_env2    = extendTypeEnvWithPatSyns tidy_patsyns type_env1
361
362
363

              ; tidy_type_env = tidyTypeEnv omit_prags type_env2

364
365
              -- See Note [Injecting implicit bindings]
              ; all_tidy_binds = implicit_binds ++ tidy_binds
366

367
368
369
370
371
372
373
374
              -- get the TyCons to generate code for.  Careful!  We must use
              -- the untidied TypeEnv here, because we need
              --  (a) implicit TyCons arising from types and classes defined
              --      in this module
              --  (b) wired-in TyCons, which are normally removed from the
              --      TypeEnv we put in the ModDetails
              --  (c) Constructors even if they are not exported (the
              --      tidied TypeEnv has trimmed these away)
375
376
              ; alg_tycons = filter isAlgTyCon (typeEnvTyCons type_env)
              }
377

378
        ; endPass hsc_env CoreTidy all_tidy_binds tidy_rules
379

380
381
          -- If the endPass didn't print the rules, but ddump-rules is
          -- on, print now
382
        ; unless (dopt Opt_D_dump_simpl dflags) $
383
384
385
            Err.dumpIfSet_dyn dflags Opt_D_dump_rules
              (showSDoc dflags (ppr CoreTidy <+> ptext (sLit "rules")))
              (pprRulesForUser tidy_rules)
386

387
388
          -- Print one-line size info
        ; let cs = coreBindsStats tidy_binds
389
        ; when (dopt Opt_D_dump_core_stats dflags)
Ian Lynagh's avatar
Ian Lynagh committed
390
               (log_action dflags dflags SevDump noSrcSpan defaultDumpStyle
391
                          (ptext (sLit "Tidy size (terms,types,coercions)")
392
393
394
                           <+> ppr (moduleName mod) <> colon
                           <+> int (cs_tm cs)
                           <+> int (cs_ty cs)
395
396
                           <+> int (cs_co cs) ))

397
398
399
400
        ; return (CgGuts { cg_module   = mod,
                           cg_tycons   = alg_tycons,
                           cg_binds    = all_tidy_binds,
                           cg_foreign  = foreign_stubs,
401
402
                           cg_dep_pkgs = map fst $ dep_pkgs deps,
                           cg_hpc_info = hpc_info,
403
                           cg_modBreaks = modBreaks },
404

405
                   ModDetails { md_types     = tidy_type_env,
406
407
                                md_rules     = tidy_rules,
                                md_insts     = tidy_insts,
408
409
                                md_vect_info = tidy_vect_info,
                                md_fam_insts = fam_insts,
410
411
                                md_exports   = exports,
                                md_anns      = anns      -- are already tidy
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
412
                              })
413
        }
414

415
416
417
418
419
lookup_aux_id :: TypeEnv -> Var -> Id
lookup_aux_id type_env id
  = case lookupTypeEnv type_env (idName id) of
        Just (AnId id') -> id'
        _other          -> pprPanic "lookup_axu_id" (ppr id)
420
421
422
423
\end{code}


\begin{code}
424
tidyTypeEnv :: Bool       -- Compiling without -O, so omit prags
425
            -> TypeEnv -> TypeEnv
426

427
-- The competed type environment is gotten from
428
429
--      a) the types and classes defined here (plus implicit things)
--      b) adding Ids with correct IdInfo, including unfoldings,
430
--              gotten from the bindings
431
-- From (b) we keep only those Ids with External names;
432
433
434
--          the CoreTidy pass makes sure these are all and only
--          the externally-accessible ones
-- This truncates the type environment to include only the
435
-- exported Ids and things needed from them, which saves space
436
437
--
-- See Note [Don't attempt to trim data types]
438

439
tidyTypeEnv omit_prags type_env
440
441
442
 = let
        type_env1 = filterNameEnv (not . isWiredInName . getName) type_env
          -- (1) remove wired-in things
443
        type_env2 | omit_prags = mapNameEnv trimThing type_env1
444
445
446
447
                  | otherwise  = type_env1
          -- (2) trimmed if necessary
    in
    type_env2
448
449

--------------------------
450
trimThing :: TyThing -> TyThing
451
-- Trim off inessentials, for boot files and no -O
452
trimThing (AnId id)
453
   | not (isImplicitId id)
454
   = AnId (id `setIdInfo` vanillaIdInfo)
455

456
trimThing other_thing
457
  = other_thing
458
459
460
461

extendTypeEnvWithPatSyns :: [PatSyn] -> TypeEnv -> TypeEnv
extendTypeEnvWithPatSyns tidy_patsyns type_env
  = extendTypeEnvList type_env [AConLike (PatSynCon ps) | ps <- tidy_patsyns ]
462
463
\end{code}

464
465
\begin{code}
tidyVectInfo :: TidyEnv -> VectInfo -> VectInfo
466
tidyVectInfo (_, var_env) info@(VectInfo { vectInfoVar          = vars
467
                                         , vectInfoParallelVars = parallelVars
468
469
                                         })
  = info { vectInfoVar          = tidy_vars
470
         , vectInfoParallelVars = tidy_parallelVars
471
         }
472
  where
473
474
      -- we only export mappings whose domain and co-domain is exported (otherwise, the iface is
      -- inconsistent)
475
476
477
478
    tidy_vars = mkVarEnv [ (tidy_var, (tidy_var, tidy_var_v))
                         | (var, var_v) <- varEnvElts vars
                         , let tidy_var   = lookup_var var
                               tidy_var_v = lookup_var var_v
479
480
                         , isExternalId tidy_var   && isExportedId tidy_var
                         , isExternalId tidy_var_v && isExportedId tidy_var_v
481
                         , isDataConWorkId var || not (isImplicitId var)
482
483
                         ]

484
    tidy_parallelVars = mkVarSet [ tidy_var
485
                                 | var <- varSetElems parallelVars
486
                                 , let tidy_var = lookup_var var
487
488
                                 , isExternalId tidy_var && isExportedId tidy_var
                                 ]
489

490
    lookup_var var = lookupWithDefaultVarEnv var_env var var
491
    
492
493
    -- We need to make sure that all names getting into the iface version of 'VectInfo' are
    -- external; otherwise, 'MkIface' will bomb out.
494
    isExternalId = isExternalName . idName
495
496
\end{code}

497
498
499
500
501
Note [Don't attempt to trim data types]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For some time GHC tried to avoid exporting the data constructors
of a data type if it wasn't strictly necessary to do so; see Trac #835.
But "strictly necessary" accumulated a longer and longer list 
Gabor Greif's avatar
typos    
Gabor Greif committed
502
of exceptions, and finally I gave up the battle:
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523

    commit 9a20e540754fc2af74c2e7392f2786a81d8d5f11
    Author: Simon Peyton Jones <simonpj@microsoft.com>
    Date:   Thu Dec 6 16:03:16 2012 +0000

    Stop attempting to "trim" data types in interface files
    
    Without -O, we previously tried to make interface files smaller
    by not including the data constructors of data types.  But
    there are a lot of exceptions, notably when Template Haskell is
    involved or, more recently, DataKinds.
    
    However Trac #7445 shows that even without TemplateHaskell, using
    the Data class and invoking Language.Haskell.TH.Quote.dataToExpQ
    is enough to require us to expose the data constructors.
    
    So I've given up on this "optimisation" -- it's probably not
    important anyway.  Now I'm simply not attempting to trim off
    the data constructors.  The gain in simplicity is worth the
    modest cost in interface file growth, which is limited to the
    bits reqd to describe those data constructors.
524

525
%************************************************************************
526
527
528
%*                                                                      *
        Implicit bindings
%*                                                                      *
529
530
531
532
%************************************************************************

Note [Injecting implicit bindings]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Edward Z. Yang's avatar
Edward Z. Yang committed
533
We inject the implicit bindings right at the end, in CoreTidy.
534
535
Some of these bindings, notably record selectors, are not
constructed in an optimised form.  E.g. record selector for
536
        data T = MkT { x :: {-# UNPACK #-} !Int }
537
Then the unfolding looks like
538
        x = \t. case t of MkT x1 -> let x = I# x1 in x
539
540
541
542
543
This generates bad code unless it's first simplified a bit.  That is
why CoreUnfold.mkImplicitUnfolding uses simleExprOpt to do a bit of
optimisation first.  (Only matters when the selector is used curried;
eg map x ys.)  See Trac #2070.

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
544
545
546
547
548
[Oct 09: in fact, record selectors are no longer implicit Ids at all,
because we really do want to optimise them properly. They are treated
much like any other Id.  But doing "light" optimisation on an implicit
Id still makes sense.]

549
550
At one time I tried injecting the implicit bindings *early*, at the
beginning of SimplCore.  But that gave rise to real difficulty,
Gabor Greif's avatar
typos    
Gabor Greif committed
551
because GlobalIds are supposed to have *fixed* IdInfo, but the
552
553
554
555
556
557
simplifier and other core-to-core passes mess with IdInfo all the
time.  The straw that broke the camels back was when a class selector
got the wrong arity -- ie the simplifier gave it arity 2, whereas
importing modules were expecting it to have arity 1 (Trac #2844).
It's much safer just to inject them right at the end, after tidying.

558
Oh: two other reasons for injecting them late:
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
559

560
561
  - If implicit Ids are already in the bindings when we start TidyPgm,
    we'd have to be careful not to treat them as external Ids (in
562
    the sense of chooseExternalIds); else the Ids mentioned in *their*
563
    RHSs will be treated as external and you get an interface file
564
    saying      a18 = <blah>
565
    but nothing refererring to a18 (because the implicit Id is the
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
566
    one that does, and implicit Ids don't appear in interface files).
567
568
569
570

  - More seriously, the tidied type-envt will include the implicit
    Id replete with a18 in its unfolding; but we won't take account
    of a18 when computing a fingerprint for the class; result chaos.
571

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
572
573
574
There is one sort of implicit binding that is injected still later,
namely those for data constructor workers. Reason (I think): it's
really just a code generation trick.... binding itself makes no sense.
575
See Note [Data constructor workers] in CorePrep.
576
577

\begin{code}
578
getTyConImplicitBinds :: TyCon -> [CoreBind]
Icelandjack's avatar
Icelandjack committed
579
getTyConImplicitBinds tc = map get_defn (mapMaybe dataConWrapId_maybe (tyConDataCons tc))
580
581

getClassImplicitBinds :: Class -> [CoreBind]
582
583
584
getClassImplicitBinds cls
  = [ NonRec op (mkDictSelRhs cls val_index)
    | (op, val_index) <- classAllSelIds cls `zip` [0..] ]
585
586
587

get_defn :: Id -> CoreBind
get_defn id = NonRec id (unfoldingTemplate (realIdUnfolding id))
588
589
590
\end{code}


591
%************************************************************************
592
%*                                                                      *
593
\subsection{Step 1: finding externals}
594
%*                                                                      *
595
596
%************************************************************************

597
See Note [Choosing external names].
598

599
\begin{code}
600
type UnfoldEnv  = IdEnv (Name{-new name-}, Bool {-show unfolding-})
601
602
  -- Maps each top-level Id to its new Name (the Id is tidied in step 2)
  -- The Unique is unchanged.  If the new Name is external, it will be
603
  -- visible in the interface file.
Simon Marlow's avatar
Simon Marlow committed
604
605
  --
  -- Bool => expose unfolding or not.
606
607
608

chooseExternalIds :: HscEnv
                  -> Module
609
                  -> Bool -> Bool
610
                  -> [CoreBind]
611
612
613
                  -> [CoreBind]
                  -> [CoreRule]
                  -> VarEnv (Var, Var)
614
                  -> IO (UnfoldEnv, TidyOccEnv)
615
                  -- Step 1 from the notes above
616

617
chooseExternalIds hsc_env mod omit_prags expose_all binds implicit_binds imp_id_rules vect_vars
618
619
620
  = do { (unfold_env1,occ_env1) <- search init_work_list emptyVarEnv init_occ_env
       ; let internal_ids = filter (not . (`elemVarEnv` unfold_env1)) binders
       ; tidy_internal internal_ids unfold_env1 occ_env1 }
621
 where
622
  nc_var = hsc_NC hsc_env
623

624
625
  -- init_ext_ids is the intial list of Ids that should be
  -- externalised.  It serves as the starting point for finding a
626
627
  -- deterministic, tidy, renaming for all external Ids in this
  -- module.
628
  --
629
630
631
632
633
634
635
  -- It is sorted, so that it has adeterministic order (i.e. it's the
  -- same list every time this module is compiled), in contrast to the
  -- bindings, which are ordered non-deterministically.
  init_work_list = zip init_ext_ids init_ext_ids
  init_ext_ids   = sortBy (compare `on` getOccName) $
                   filter is_external binders

636
637
638
  -- An Id should be external if either (a) it is exported,
  -- (b) it appears in the RHS of a local rule for an imported Id, or
  -- (c) it is the vectorised version of an imported Id
639
  -- See Note [Which rules to expose]
640
  is_external id = isExportedId id || id `elemVarSet` rule_rhs_vars || id `elemVarSet` vect_var_vs
641
  rule_rhs_vars  = mapUnionVarSet ruleRhsFreeVars imp_id_rules
642
  vect_var_vs    = mkVarSet [var_v | (var, var_v) <- nameEnvElts vect_vars, isGlobalId var]
643
644

  binders          = bindersOfBinds binds
645
  implicit_binders = bindersOfBinds implicit_binds
646
  binder_set       = mkVarSet binders
647

648
  avoids   = [getOccName name | bndr <- binders ++ implicit_binders,
649
                                let name = idName bndr,
650
                                isExternalName name ]
651
652
653
654
655
656
                -- In computing our "avoids" list, we must include
                --      all implicit Ids
                --      all things with global names (assigned once and for
                --                                      all by the renamer)
                -- since their names are "taken".
                -- The type environment is a convenient source of such things.
657
658
                -- In particular, the set of binders doesn't include
                -- implicit Ids at this stage.
659

660
661
662
663
664
665
666
667
        -- 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.
668
669
670
  init_occ_env = initTidyOccEnv avoids


671
  search :: [(Id,Id)]    -- The work-list: (external id, referrring id)
672
                         -- Make a tidy, external Name for the external id,
673
674
                         --   add it to the UnfoldEnv, and do the same for the
                         --   transitive closure of Ids it refers to
675
676
                         -- The referring id is used to generate a tidy
                         ---  name for the external id
677
678
679
680
681
682
         -> UnfoldEnv    -- id -> (new Name, show_unfold)
         -> TidyOccEnv   -- occ env for choosing new Names
         -> IO (UnfoldEnv, TidyOccEnv)

  search [] unfold_env occ_env = return (unfold_env, occ_env)

683
684
  search ((idocc,referrer) : rest) unfold_env occ_env
    | idocc `elemVarEnv` unfold_env = search rest unfold_env occ_env
685
    | otherwise = do
686
      (occ_env', name') <- tidyTopName mod nc_var (Just referrer) occ_env idocc
687
      let
688
689
          (new_ids, show_unfold)
                | omit_prags = ([], False)
690
                | otherwise  = addExternal expose_all refined_id
691

692
693
694
                -- add vectorised version if any exists
          new_ids' = new_ids ++ maybeToList (fmap snd $ lookupVarEnv vect_vars idocc)
          
695
696
                -- 'idocc' is an *occurrence*, but we need to see the
                -- unfolding in the *definition*; so look up in binder_set
697
698
699
700
701
702
703
          refined_id = case lookupVarSet binder_set idocc of
                         Just id -> id
                         Nothing -> WARN( True, ppr idocc ) idocc

          unfold_env' = extendVarEnv unfold_env idocc (name',show_unfold)
          referrer' | isExportedId refined_id = refined_id
                    | otherwise               = referrer
704
      --
705
      search (zip new_ids' (repeat referrer') ++ rest) unfold_env' occ_env'
706
707
708
709
710
711
712
713
714

  tidy_internal :: [Id] -> UnfoldEnv -> TidyOccEnv
                -> IO (UnfoldEnv, TidyOccEnv)
  tidy_internal []       unfold_env occ_env = return (unfold_env,occ_env)
  tidy_internal (id:ids) unfold_env occ_env = do
      (occ_env', name') <- tidyTopName mod nc_var Nothing occ_env id
      let unfold_env' = extendVarEnv unfold_env id (name',False)
      tidy_internal ids unfold_env' occ_env'

715
addExternal :: Bool -> Id -> ([Id], Bool)
716
addExternal expose_all id = (new_needed_ids, show_unfold)
717
  where
718
    new_needed_ids = bndrFvsInOrder show_unfold id
719
    idinfo         = idInfo id
720
    show_unfold    = show_unfolding (unfoldingInfo idinfo)
721
    never_active   = isNeverActive (inlinePragmaActivation (inlinePragInfo idinfo))
722
    loop_breaker   = isStrongLoopBreaker (occInfo idinfo)
723
    bottoming_fn   = isBottomingSig (strictnessInfo idinfo)
724

725
726
727
        -- Stuff to do with the Id's unfolding
        -- We leave the unfolding there even if there is a worker
        -- In GHCi the unfolding is used by importers
728
729

    show_unfolding (CoreUnfolding { uf_src = src, uf_guidance = guidance })
730
731
       =  expose_all         -- 'expose_all' says to expose all
                             -- unfoldings willy-nilly
732

733
734
       || isStableSource src     -- Always expose things whose
                                 -- source is an inline rule
735

736
737
738
739
       || not (bottoming_fn      -- No need to inline bottom functions
           || never_active       -- Or ones that say not to
           || loop_breaker       -- Or that are loop breakers
           || neverUnfoldGuidance guidance)
740
741
742
    show_unfolding (DFunUnfolding {}) = True
    show_unfolding _                  = False
\end{code}
743

744
%************************************************************************
745
%*                                                                      *
746
               Deterministic free variables
747
%*                                                                      *
748
%************************************************************************
749

750
751
752
753
We want a deterministic free-variable list.  exprFreeVars gives us
a VarSet, which is in a non-deterministic order when converted to a
list.  Hence, here we define a free-variable finder that returns
the free variables in the order that they are encountered.
754

755
See Note [Choosing external names]
756

757
758
759
760
\begin{code}
bndrFvsInOrder :: Bool -> Id -> [Id]
bndrFvsInOrder show_unfold id
  = run (dffvLetBndr show_unfold id)
761

762
763
764
765
run :: DFFV () -> [Id]
run (DFFV m) = case m emptyVarSet (emptyVarSet, []) of
                 ((_,ids),_) -> ids

766
767
newtype DFFV a
  = DFFV (VarSet              -- Envt: non-top-level things that are in scope
768
                              -- we don't want to record these as free vars
769
      -> (VarSet, [Var])      -- Input State: (set, list) of free vars so far
770
      -> ((VarSet,[Var]),a))  -- Output state
771

Austin Seipp's avatar
Austin Seipp committed
772
773
774
775
776
777
778
instance Functor DFFV where
    fmap = liftM

instance Applicative DFFV where
    pure = return
    (<*>) = ap

779
instance Monad DFFV where
780
781
782
783
784
785
786
787
788
789
790
  return a = DFFV $ \_ st -> (st, a)
  (DFFV m) >>= k = DFFV $ \env st ->
    case m env st of
       (st',a) -> case k a of
                     DFFV f -> f env st'

extendScope :: Var -> DFFV a -> DFFV a
extendScope v (DFFV f) = DFFV (\env st -> f (extendVarSet env v) st)

extendScopeList :: [Var] -> DFFV a -> DFFV a
extendScopeList vs (DFFV f) = DFFV (\env st -> f (extendVarSetList env vs) st)
791
792

insert :: Var -> DFFV ()
793
794
insert v = DFFV $ \ env (set, ids) ->
           let keep_me = isLocalId v &&
795
                         not (v `elemVarSet` env) &&
796
797
                           not (v `elemVarSet` set)
           in if keep_me
798
799
800
              then ((extendVarSet set v, v:ids), ())
              else ((set,                ids),   ())

801
802

dffvExpr :: CoreExpr -> DFFV ()
803
dffvExpr (Var v)              = insert v
804
805
dffvExpr (App e1 e2)          = dffvExpr e1 >> dffvExpr e2
dffvExpr (Lam v e)            = extendScope v (dffvExpr e)
806
807
dffvExpr (Tick (Breakpoint _ ids) e) = mapM_ insert ids >> dffvExpr e
dffvExpr (Tick _other e)    = dffvExpr e
808
dffvExpr (Cast e _)           = dffvExpr e
809
810
811
812
813
814
815
816
817
818
dffvExpr (Let (NonRec x r) e) = dffvBind (x,r) >> extendScope x (dffvExpr e)
dffvExpr (Let (Rec prs) e)    = extendScopeList (map fst prs) $
                                (mapM_ dffvBind prs >> dffvExpr e)
dffvExpr (Case e b _ as)      = dffvExpr e >> extendScope b (mapM_ dffvAlt as)
dffvExpr _other               = return ()

dffvAlt :: (t, [Var], CoreExpr) -> DFFV ()
dffvAlt (_,xs,r) = extendScopeList xs (dffvExpr r)

dffvBind :: (Id, CoreExpr) -> DFFV ()
819
dffvBind(x,r)
820
821
  | not (isId x) = dffvExpr r
  | otherwise    = dffvLetBndr False x >> dffvExpr r
822
823
                -- Pass False because we are doing the RHS right here
                -- If you say True you'll get *exponential* behaviour!
824
825

dffvLetBndr :: Bool -> Id -> DFFV ()
826
827
828
829
830
831
832
833
834
835
836
837
-- Gather the free vars of the RULES and unfolding of a binder
-- We always get the free vars of a *stable* unfolding, but
-- for a *vanilla* one (InlineRhs), the flag controls what happens:
--   True <=> get fvs of even a *vanilla* unfolding
--   False <=> ignore an InlineRhs
-- For nested bindings (call from dffvBind) we always say "False" because
--       we are taking the fvs of the RHS anyway
-- For top-level bindings (call from addExternal, via bndrFvsInOrder)
--       we say "True" if we are exposing that unfolding
dffvLetBndr vanilla_unfold id
  = do { go_unf (unfoldingInfo idinfo)
       ; mapM_ go_rule (specInfoRules (specInfo idinfo)) }
838
  where
839
840
841
842
    idinfo = idInfo id

    go_unf (CoreUnfolding { uf_tmpl = rhs, uf_src = src })
       = case src of
843
844
           InlineRhs | vanilla_unfold -> dffvExpr rhs
                     | otherwise      -> return ()
845
           _                          -> dffvExpr rhs
846

847
848
    go_unf (DFunUnfolding { df_bndrs = bndrs, df_args = args }) 
             = extendScopeList bndrs $ mapM_ dffvExpr args
849
850
851
852
853
    go_unf _ = return ()

    go_rule (BuiltinRule {}) = return ()
    go_rule (Rule { ru_bndrs = bndrs, ru_rhs = rhs })
      = extendScopeList bndrs (dffvExpr rhs)
854
855
856
\end{code}


857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
%************************************************************************
%*                                                                      *
               findExternalRules
%*                                                                      *
%************************************************************************

Note [Finding external rules]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The complete rules are gotten by combining
   a) local rules for imported Ids
   b) rules embedded in the top-level Ids

There are two complications:
  * Note [Which rules to expose]
  * Note [Trimming auto-rules]

Note [Which rules to expose]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The function 'expose_rule' filters out rules that mention, on the LHS,
Ids that aren't externally visible; these rules can't fire in a client
module.

The externally-visible binders are computed (by chooseExternalIds)
assuming that all orphan rules are externalised (see init_ext_ids in
function 'search'). So in fact it's a bit conservative and we may
export more than we need.  (It's a sort of mutual recursion.)

Note [Trimming auto-rules]
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Second, with auto-specialisation we may specialise local or imported
dfuns or INLINE functions, and then later inline them.  That may leave
behind something like
   RULE "foo" forall d. f @ Int d = f_spec
where f is either local or imported, and there is no remaining
reference to f_spec except from the RULE.

Now that RULE *might* be useful to an importing module, but that is
purely speculative, and meanwhile the code is taking up space and
codegen time.  So is seeems better to drop the binding for f_spec if
the auto-generated rule is the *only* reason that it is being kept
alive.

(The RULE still might have been useful in the past; that is, it was
the right thing to have generated it in the first place.  See Note
[Inline specialisations] in Specialise.  But now it has served its
purpose, and can be discarded.)

So findExternalRules does this:
  * Remove all bindings that are kept alive *only* by isAutoRule rules
      (this is done in trim_binds)
  * Remove all auto rules that mention bindings that have been removed
      (this is done by filtering by keep_rule)

So if a binding is kept alive for some *other* reason (e.g. f_spec is
called in the final code), we keep the rule too.

I found that binary sizes jumped by 6-10% when I started to specialise
INLINE functions (again, Note [Inline specialisations] in Specialise).
Adding trimAutoRules removed all this bloat.


\begin{code}
findExternalRules :: Bool       -- Omit pragmas
                  -> [CoreBind]
                  -> [CoreRule] -- Local rules for imported fns
                  -> UnfoldEnv  -- Ids that are exported, so we need their rules
                  -> ([CoreBind], [CoreRule])
-- See Note [Finding external rules]
findExternalRules omit_prags binds imp_id_rules unfold_env
  = (trimmed_binds, filter keep_rule all_rules)
  where
    imp_rules         = filter expose_rule imp_id_rules
929
    imp_user_rule_fvs = mapUnionVarSet user_rule_rhs_fvs imp_rules
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985

    user_rule_rhs_fvs rule | isAutoRule rule = emptyVarSet
                           | otherwise       = ruleRhsFreeVars rule

    (trimmed_binds, local_bndrs, _, all_rules) = trim_binds binds

    keep_rule rule = ruleFreeVars rule `subVarSet` local_bndrs
        -- Remove rules that make no sense, because they mention a
        -- local binder (on LHS or RHS) that we have now discarded.
        -- (NB: ruleFreeVars only includes LocalIds)
        --
        -- LHS: we have alrady filtered out rules that mention internal Ids
        --     on LHS but that isn't enough because we might have by now
        --     discarded a binding with an external Id. (How?
        --     chooseExternalIds is a bit conservative.)
        --
        -- RHS: the auto rules that might mention a binder that has
        --      been discarded; see Note [Trimming auto-rules]

    expose_rule rule
        | omit_prags = False
        | otherwise  = all is_external_id (varSetElems (ruleLhsFreeIds rule))
                -- Don't expose a rule whose LHS mentions a locally-defined
                -- Id that is completely internal (i.e. not visible to an
                -- importing module).  NB: ruleLhsFreeIds only returns LocalIds.
                -- See Note [Which rules to expose]

    is_external_id id = case lookupVarEnv unfold_env id of
                          Just (name, _) -> isExternalName name
                          Nothing        -> False

    trim_binds :: [CoreBind]
               -> ( [CoreBind]   -- Trimmed bindings
                  , VarSet       -- Binders of those bindings
                  , VarSet       -- Free vars of those bindings + rhs of user rules
                                 -- (we don't bother to delete the binders)
                  , [CoreRule])  -- All rules, imported + from the bindings
    -- This function removes unnecessary bindings, and gathers up rules from
    -- the bindings we keep.  See Note [Trimming auto-rules]
    trim_binds []  -- Base case, start with imp_user_rule_fvs
       = ([], emptyVarSet, imp_user_rule_fvs, imp_rules)

    trim_binds (bind:binds)
       | any needed bndrs    -- Keep binding
       = ( bind : binds', bndr_set', needed_fvs', local_rules ++ rules )
       | otherwise           -- Discard binding altogether
       = stuff
       where
         stuff@(binds', bndr_set, needed_fvs, rules)
                       = trim_binds binds
         needed bndr   = isExportedId bndr || bndr `elemVarSet` needed_fvs

         bndrs         = bindersOf  bind
         rhss          = rhssOfBind bind
         bndr_set'     = bndr_set `extendVarSetList` bndrs

986
987
         needed_fvs'   = needed_fvs                                   `unionVarSet`
                         mapUnionVarSet idUnfoldingVars   bndrs       `unionVarSet`
988
                              -- Ignore type variables in the type of bndrs
989
990
                         mapUnionVarSet exprFreeVars      rhss        `unionVarSet`
                         mapUnionVarSet user_rule_rhs_fvs local_rules
991
992
993
994
995
996
997
998
999
            -- In needed_fvs', we don't bother to delete binders from the fv set

         local_rules  = [ rule
                        | id <- bndrs
                        , is_external_id id   -- Only collect rules for external Ids
                        , rule <- idCoreRules id
                        , expose_rule rule ]  -- and ones that can fire in a client
\end{code}

1000
%************************************************************************
1001
%*                                                                      *
1002
               tidyTopName
1003
%*                                                                      *
1004
1005
%************************************************************************

1006
This is where we set names to local/global based on whether they really are
1007
1008
1009
externally visible (see comment at the top of this module).  If the name
was previously local, we have to give it a unique occurrence name if
we intend to externalise it.
1010
1011
1012

\begin{code}
tidyTopName :: Module -> IORef NameCache -> Maybe Id -> TidyOccEnv
1013
            -> Id -> IO (TidyOccEnv, Name)
1014
1015
1016
1017
tidyTopName mod nc_var maybe_ref occ_env id
  | global && internal = return (occ_env, localiseName name)

  | global && external = return (occ_env, name)
1018
1019
1020
        -- Global names are assumed to have been allocated by the renamer,
        -- so they already have the "right" unique
        -- And it's a system-wide unique too
1021
1022
1023
1024

  -- Now we get to the real reason that all this is in the IO Monad:
  -- we have to update the name cache in a nice atomic fashion

1025
  | local  && internal = do { new_local_name <- atomicModifyIORef nc_var mk_new_local
1026
1027
1028
1029
1030
1031
                            ; return (occ_env', new_local_name) }
        -- Even local, internal names must get a unique occurrence, because
        -- if we do -split-objs we externalise the name later, in the code generator
        --
        -- Similarly, we must make sure it has a system-wide Unique, because
        -- the byte-code generator builds a system-wide Name->BCO symbol table
1032

1033
  | local  && external = do { new_external_name <- atomicModifyIORef nc_var mk_new_external
1034
                            ; return (occ_env', new_external_name) }
1035
1036
1037

  | otherwise = panic "tidyTopName"
  where
1038
    name        = idName id
1039
    external    = isJust maybe_ref
1040
1041
1042
1043
    global      = isExternalName name
    local       = not global
    internal    = not external
    loc         = nameSrcSpan name
1044
1045
1046

    old_occ     = nameOccName name
    new_occ
1047
      | Just ref <- maybe_ref, ref /= id =
1048
          mkOccName (occNameSpace old_occ) $
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
             let
                 ref_str = occNameString (getOccName ref)
                 occ_str = occNameString old_occ
             in
             case occ_str of
               '$':'w':_ -> occ_str
                  -- workers: the worker for a function already
                  -- includes the occname for its parent, so there's
                  -- no need to prepend the referrer.
               _other | isSystemName name -> ref_str
                      | otherwise         -> ref_str ++ '_' : occ_str
                  -- If this name was system-generated, then don't bother
                  -- to retain its OccName, just use the referrer.  These
                  -- system-generated names will become "f1", "f2", etc. for
                  -- a referrer "f".
1064
1065
1066
1067
      | otherwise = old_occ

    (occ_env', occ') = tidyOccName occ_env new_occ

1068
    mk_new_local nc = (nc { nsUniqs = us }, mkInternalName uniq occ' loc)
1069
1070
                    where
                      (uniq, us) = takeUniqFromSupply (nsUniqs nc)
1071
1072

    mk_new_external nc = allocateGlobalBinder nc mod occ' loc
1073
1074
1075
1076
1077
1078
        -- If we want to externalise a currently-local name, check
        -- whether we have already assigned a unique for it.
        -- If so, use it; if not, extend the table.
        -- All this is done by allcoateGlobalBinder.
        -- This is needed when *re*-compiling a module in GHCi; we must
        -- use the same name for externally-visible things as we did before.
1079
1080
\end{code}

1081

1082
%************************************************************************
1083
%*                                                                      *
1084
\subsection{Step 2: top-level tidying}
1085
%*                                                                      *
1086
1087
1088
1089
1090
%************************************************************************


\begin{code}
-- TopTidyEnv: when tidying we need to know
1091
1092
1093
1094
1095
1096
1097
--   * nc_var: The NameCache, containing a unique supply and any pre-ordained Names.
--        These may have arisen because the
--        renamer read in an interface file mentioning M.$wf, say,
--        and assigned it unique r77.  If, on this compilation, we've
--        invented an Id whose name is $wf (but with a different unique)
--        we want to rename it to have unique r77, so that we can do easy
--        comparisons with stuff from the interface file
1098
--
1099
--   * occ_env: The TidyOccEnv, which tells us which local occurrences
1100
1101
1102
1103
--     are 'used'
--
--   * subst_env: A Var->Var mapping that substitutes the new Var for the old

1104
tidyTopBinds :: HscEnv
1105
             -> Module
1106
             -> UnfoldEnv
1107
             -> TidyOccEnv
1108
             -> CoreProgram
1109
             -> IO (TidyEnv, CoreProgram)
1110

1111
tidyTopBinds hsc_env this_mod unfold_env init_occ_env binds
1112
  = do mkIntegerId <- lookupMkIntegerName dflags hsc_env
1113
       return $ tidy mkIntegerId init_env binds
1114
  where
ian@well-typed.com's avatar
ian@well-typed.com committed
1115
    dflags = hsc_dflags hsc_env
1116