compiler/iface/MkIface.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
   3 %
   4
   5 \begin{code}
   6 module MkIface (
   7         pprModIface, showIface,         -- Print the iface in Foo.hi
   8
   9         mkUsageInfo,    -- Construct the usage info for a module
  10
  11         mkIface,        -- Build a ModIface from a ModGuts,
  12                         -- including computing version information
  13
  14         writeIfaceFile, -- Write the interface file
  15
  16         checkOldIface   -- See if recompilation is required, by
  17                         -- comparing version information
  18  ) where
  19 \end{code}
  20
  21         -----------------------------------------------
  22                 MkIface.lhs deals with versioning
  23         -----------------------------------------------
  24
  25 Here's the version-related info in an interface file
  26
  27   module Foo 8          -- module-version
  28              3          -- export-list-version
  29              2          -- rule-version
  30     Usages:     -- Version info for what this compilation of Foo imported
  31         Baz 3           -- Module version
  32             [4]         -- The export-list version if Foo depended on it
  33             (g,2)       -- Function and its version
  34             (T,1)       -- Type and its version
  35
  36     <version> f :: Int -> Int {- Unfolding: \x -> Wib.t[2] x -}
  37                 -- The [2] says that f's unfolding
  38                 -- mentions verison 2 of Wib.t
  39
  40         -----------------------------------------------
  41                         Basic idea
  42         -----------------------------------------------
  43
  44 Basic idea:
  45   * In the mi_usages information in an interface, we record the
  46     version number of each free variable of the module
  47
  48   * In mkIface, we compute the version number of each exported thing A.f
  49     by comparing its A.f's info with its new info, and bumping its
  50     version number if it differs.  If A.f mentions B.g, and B.g's version
  51     number has changed, then we count A.f as having changed too.
  52
  53   * In checkOldIface we compare the mi_usages for the module with
  54     the actual version info for all each thing recorded in mi_usages
  55
  56
  57 Fixities
  58 ~~~~~~~~
  59 We count A.f as changing if its fixity changes
  60
  61 Rules
  62 ~~~~~
  63 If a rule changes, we want to recompile any module that might be
  64 affected by that rule.  For non-orphan rules, this is relatively easy.
  65 If module M defines f, and a rule for f, just arrange that the version
  66 number for M.f changes if any of the rules for M.f change.  Any module
  67 that does not depend on M.f can't be affected by the rule-change
  68 either.
  69
  70 Orphan rules (ones whose 'head function' is not defined in M) are
  71 harder.  Here's what we do.
  72
  73   * We have a per-module orphan-rule version number which changes if
  74     any orphan rule changes. (It's unaffected by non-orphan rules.)
  75
  76   * We record usage info for any orphan module 'below' this one,
  77     giving the orphan-rule version number.  We recompile if this
  78     changes.
  79
  80 The net effect is that if an orphan rule changes, we recompile every
  81 module above it.  That's very conservative, but it's devilishly hard
  82 to know what it might affect, so we just have to be conservative.
  83
  84 Instance decls
  85 ~~~~~~~~~~~~~~
  86 In an iface file we have
  87      module A where
  88         instance Eq a => Eq [a]  =  dfun29
  89         dfun29 :: ...
  90
  91 We have a version number for dfun29, covering its unfolding
  92 etc. Suppose we are compiling a module M that imports A only
  93 indirectly.  If typechecking M uses this instance decl, we record the
  94 dependency on A.dfun29 as if it were a free variable of the module
  95 (via the tcg_inst_usages accumulator).  That means that A will appear
  96 in M's usage list.  If the shape of the instance declaration changes,
  97 then so will dfun29's version, triggering a recompilation.
  98
  99 Adding an instance declaration, or changing an instance decl that is
 100 not currently used, is more tricky.  (This really only makes a
 101 difference when we have overlapping instance decls, because then the
 102 new instance decl might kick in to override the old one.)  We handle
 103 this in a very similar way that we handle rules above.
 104
 105   * For non-orphan instance decls, identify one locally-defined tycon/class
 106     mentioned in the decl.  Treat the instance decl as part of the defn of that
 107     tycon/class, so that if the shape of the instance decl changes, so does the
 108     tycon/class; that in turn will force recompilation of anything that uses
 109     that tycon/class.
 110
 111   * For orphan instance decls, act the same way as for orphan rules.
 112     Indeed, we use the same global orphan-rule version number.
 113
 114 mkUsageInfo
 115 ~~~~~~~~~~~
 116 mkUsageInfo figures out what the ``usage information'' for this
 117 moudule is; that is, what it must record in its interface file as the
 118 things it uses.
 119
 120 We produce a line for every module B below the module, A, currently being
 121 compiled:
 122         import B <n> ;
 123 to record the fact that A does import B indirectly.  This is used to decide
 124 to look to look for B.hi rather than B.hi-boot when compiling a module that
 125 imports A.  This line says that A imports B, but uses nothing in it.
 126 So we'll get an early bale-out when compiling A if B's version changes.
 127
 128 The usage information records:
 129
 130 \begin{itemize}
 131 \item   (a) anything reachable from its body code
 132 \item   (b) any module exported with a @module Foo@
 133 \item   (c) anything reachable from an exported item
 134 \end{itemize}
 135
 136 Why (b)?  Because if @Foo@ changes then this module's export list
 137 will change, so we must recompile this module at least as far as
 138 making a new interface file --- but in practice that means complete
 139 recompilation.
 140
 141 Why (c)?  Consider this:
 142 \begin{verbatim}
 143         module A( f, g ) where  |       module B( f ) where
 144           import B( f )         |         f = h 3
 145           g = ...               |         h = ...
 146 \end{verbatim}
 147
 148 Here, @B.f@ isn't used in A.  Should we nevertheless record @B.f@ in
 149 @A@'s usages?  Our idea is that we aren't going to touch A.hi if it is
 150 *identical* to what it was before.  If anything about @B.f@ changes
 151 than anyone who imports @A@ should be recompiled in case they use
 152 @B.f@ (they'll get an early exit if they don't).  So, if anything
 153 about @B.f@ changes we'd better make sure that something in A.hi
 154 changes, and the convenient way to do that is to record the version
 155 number @B.f@ in A.hi in the usage list.  If B.f changes that'll force a
 156 complete recompiation of A, which is overkill but it's the only way to
 157 write a new, slightly different, A.hi.
 158
 159 But the example is tricker.  Even if @B.f@ doesn't change at all,
 160 @B.h@ may do so, and this change may not be reflected in @f@'s version
 161 number.  But with -O, a module that imports A must be recompiled if
 162 @B.h@ changes!  So A must record a dependency on @B.h@.  So we treat
 163 the occurrence of @B.f@ in the export list *just as if* it were in the
 164 code of A, and thereby haul in all the stuff reachable from it.
 165
 166         *** Conclusion: if A mentions B.f in its export list,
 167             behave just as if A mentioned B.f in its source code,
 168             and slurp in B.f and all its transitive closure ***
 169
 170 [NB: If B was compiled with -O, but A isn't, we should really *still*
 171 haul in all the unfoldings for B, in case the module that imports A *is*
 172 compiled with -O.  I think this is the case.]
 173
 174
 175 \begin{code}
 176 #include "HsVersions.h"
 177
 178 import HsSyn
 179 import IfaceSyn         ( IfaceDecl(..), IfaceClassOp(..), IfaceConDecl(..),
 180                           IfaceRule(..), IfaceInst(..), IfaceExtName(..),
 181                           eqIfDecl, eqIfRule, eqIfInst, IfaceEq(..), (&&&), bool,
 182                           eqMaybeBy, eqListBy, visibleIfConDecls,
 183                           tyThingToIfaceDecl, instanceToIfaceInst, coreRuleToIfaceRule )
 184 import LoadIface        ( readIface, loadInterface )
 185 import BasicTypes       ( Version, initialVersion, bumpVersion )
 186 import TcRnMonad
 187 import HscTypes         ( ModIface(..), ModDetails(..),
 188                           ModGuts(..), IfaceExport,
 189                           HscEnv(..), hscEPS, Dependencies(..), FixItem(..),
 190                           ModSummary(..), msHiFilePath,
 191                           mkIfaceDepCache, mkIfaceFixCache, mkIfaceVerCache,
 192                           typeEnvElts,
 193                           GenAvailInfo(..), availName,
 194                           ExternalPackageState(..),
 195                           Usage(..), IsBootInterface,
 196                           Deprecs(..), IfaceDeprecs, Deprecations,
 197                           lookupIfaceByModule
 198                         )
 199
 200
 201 import DynFlags         ( GhcMode(..), DynFlags(..), DynFlag(..), dopt )
 202 import StaticFlags      ( opt_HiVersion )
 203 import Name             ( Name, nameModule, nameOccName, nameParent,
 204                           isExternalName, isInternalName, nameParent_maybe, isWiredInName,
 205                           isImplicitName, NamedThing(..) )
 206 import NameEnv
 207 import NameSet
 208 import OccName          ( OccName, OccEnv, mkOccEnv, lookupOccEnv, emptyOccEnv,
 209                           extendOccEnv_C,
 210                           OccSet, emptyOccSet, elemOccSet, occSetElts,
 211                           extendOccSet, extendOccSetList,
 212                           isEmptyOccSet, intersectOccSet, intersectsOccSet,
 213                           occNameFS, isTcOcc )
 214 import Module
 215 import Outputable
 216 import Util             ( createDirectoryHierarchy, directoryOf )
 217 import Util             ( sortLe, seqList )
 218 import Binary           ( getBinFileWithDict )
 219 import BinIface         ( writeBinIface, v_IgnoreHiWay )
 220 import Unique           ( Unique, Uniquable(..) )
 221 import ErrUtils         ( dumpIfSet_dyn, showPass )
 222 import Digraph          ( stronglyConnComp, SCC(..) )
 223 import SrcLoc           ( SrcSpan )
 224 import UniqFM
 225 import PackageConfig    ( PackageId )
 226 import FiniteMap
 227 import FastString
 228
 229 import DATA_IOREF       ( writeIORef )
 230 import Monad            ( when )
 231 import List             ( insert )
 232 import Maybes           ( orElse, mapCatMaybes, isNothing, isJust,
 233                           expectJust, MaybeErr(..) )
 234 \end{code}
 235
 236
 237
 238 %************************************************************************
 239 %*                                                                      *
 240 \subsection{Completing an interface}
 241 %*                                                                      *
 242 %************************************************************************
 243
 244 \begin{code}
 245 mkIface :: HscEnv
 246         -> Maybe ModIface       -- The old interface, if we have it
 247         -> ModGuts              -- Usages, deprecations, etc
 248         -> ModDetails           -- The trimmed, tidied interface
 249         -> IO (ModIface,        -- The new one, complete with decls and versions
 250                Bool)            -- True <=> there was an old Iface, and the new one
 251                                 --          is identical, so no need to write it
 252
 253 mkIface hsc_env maybe_old_iface
 254         (ModGuts{     mg_module  = this_mod,
 255                       mg_boot    = is_boot,
 256                       mg_usages  = usages,
 257                       mg_deps    = deps,
 258                       mg_rdr_env = rdr_env,
 259                       mg_fix_env = fix_env,
 260                       mg_deprecs = src_deprecs })
 261         (ModDetails{  md_insts   = insts,
 262                       md_rules   = rules,
 263                       md_types   = type_env,
 264                       md_exports = exports })
 265
 266 -- NB:  notice that mkIface does not look at the bindings
 267 --      only at the TypeEnv.  The previous Tidy phase has
 268 --      put exactly the info into the TypeEnv that we want
 269 --      to expose in the interface
 270
 271   = do  { eps <- hscEPS hsc_env
 272         ; let   { ext_nm_rhs = mkExtNameFn hsc_env eps this_mod
 273                 ; ext_nm_lhs = mkLhsNameFn this_mod
 274
 275                 ; decls  = [ tyThingToIfaceDecl ext_nm_rhs thing
 276                            | thing <- typeEnvElts type_env,
 277                              let name = getName thing,
 278                              not (isImplicitName name || isWiredInName name) ]
 279                         -- Don't put implicit Ids and class tycons in the interface file
 280                         -- Nor wired-in things; the compiler knows about them anyhow
 281
 282                 ; fixities    = [(occ,fix) | FixItem occ fix _ <- nameEnvElts fix_env]
 283                 ; deprecs     = mkIfaceDeprec src_deprecs
 284                 ; iface_rules = map (coreRuleToIfaceRule ext_nm_lhs ext_nm_rhs) rules
 285                 ; iface_insts = map (instanceToIfaceInst ext_nm_lhs) insts
 286
 287                 ; intermediate_iface = ModIface {
 288                         mi_module   = this_mod,
 289                         mi_boot     = is_boot,
 290                         mi_deps     = deps,
 291                         mi_usages   = usages,
 292                         mi_exports  = mkIfaceExports exports,
 293                         mi_insts    = sortLe le_inst iface_insts,
 294                         mi_rules    = sortLe le_rule iface_rules,
 295                         mi_fixities = fixities,
 296                         mi_deprecs  = deprecs,
 297                         mi_globals  = Just rdr_env,
 298
 299                         -- Left out deliberately: filled in by addVersionInfo
 300                         mi_mod_vers  = initialVersion,
 301                         mi_exp_vers  = initialVersion,
 302                         mi_rule_vers = initialVersion,
 303                         mi_orphan    = False,   -- Always set by addVersionInfo, but
 304                                                 -- it's a strict field, so we can't omit it.
 305                         mi_decls     = deliberatelyOmitted "decls",
 306                         mi_ver_fn    = deliberatelyOmitted "ver_fn",
 307
 308                         -- And build the cached values
 309                         mi_dep_fn = mkIfaceDepCache deprecs,
 310                         mi_fix_fn = mkIfaceFixCache fixities }
 311
 312                 -- Add version information
 313                 ; (new_iface, no_change_at_all, pp_diffs, pp_orphs)
 314                         = _scc_ "versioninfo"
 315                          addVersionInfo maybe_old_iface intermediate_iface decls
 316                 }
 317
 318                 -- Debug printing
 319         ; when (isJust pp_orphs && dopt Opt_WarnOrphans dflags)
 320                (printDump (expectJust "mkIface" pp_orphs))
 321         ; when (dopt Opt_D_dump_hi_diffs dflags) (printDump pp_diffs)
 322         ; dumpIfSet_dyn dflags Opt_D_dump_hi "FINAL INTERFACE"
 323                         (pprModIface new_iface)
 324
 325         ; return (new_iface, no_change_at_all) }
 326   where
 327      r1 `le_rule` r2 = ifRuleName r1 <= ifRuleName r2
 328      i1 `le_inst` i2 = ifDFun     i1 <= ifDFun     i2
 329
 330      dflags = hsc_dflags hsc_env
 331      deliberatelyOmitted x = panic ("Deliberately omitted: " ++ x)
 332
 333
 334 -----------------------------
 335 writeIfaceFile :: ModLocation -> ModIface -> IO ()
 336 writeIfaceFile location new_iface
 337     = do createDirectoryHierarchy (directoryOf hi_file_path)
 338          writeBinIface hi_file_path new_iface
 339     where hi_file_path = ml_hi_file location
 340
 341
 342 -----------------------------
 343 mkExtNameFn :: HscEnv -> ExternalPackageState -> Module -> Name -> IfaceExtName
 344 mkExtNameFn hsc_env eps this_mod
 345   = ext_nm
 346   where
 347     hpt = hsc_HPT hsc_env
 348     pit = eps_PIT eps
 349
 350     ext_nm name
 351       | mod == this_mod = case nameParent_maybe name of
 352                                 Nothing  -> LocalTop occ
 353                                 Just par -> LocalTopSub occ (nameOccName par)
 354       | isWiredInName name       = ExtPkg  mod occ
 355       | is_home mod              = HomePkg mod_name occ vers
 356       | otherwise                = ExtPkg  mod occ
 357       where
 358         dflags = hsc_dflags hsc_env
 359         this_pkg = thisPackage dflags
 360         is_home mod = modulePackageId mod == this_pkg
 361
 362         mod      = nameModule name
 363         mod_name = moduleName mod
 364         occ      = nameOccName name
 365         par_occ  = nameOccName (nameParent name)
 366                 -- The version of the *parent* is the one want
 367         vers     = lookupVersion mod par_occ
 368
 369     lookupVersion :: Module -> OccName -> Version
 370         -- Even though we're looking up a home-package thing, in
 371         -- one-shot mode the imported interfaces may be in the PIT
 372     lookupVersion mod occ
 373       = mi_ver_fn iface occ `orElse`
 374         pprPanic "lookupVers1" (ppr mod <+> ppr occ)
 375       where
 376         iface = lookupIfaceByModule (hsc_dflags hsc_env) hpt pit mod `orElse`
 377                 pprPanic "lookupVers2" (ppr mod <+> ppr occ)
 378
 379
 380 ---------------------
 381 -- mkLhsNameFn ignores versioning info altogether
 382 -- It is used for the LHS of instance decls and rules, where we
 383 -- there's no point in recording version info
 384 mkLhsNameFn :: Module -> Name -> IfaceExtName
 385 mkLhsNameFn this_mod name
 386   | isInternalName name = pprTrace "mkLhsNameFn: unexpected internal" (ppr name) $
 387                           LocalTop occ  -- Should not happen
 388   | mod == this_mod = LocalTop occ
 389   | otherwise       = ExtPkg mod occ
 390   where
 391     mod = nameModule name
 392     occ = nameOccName name
 393
 394
 395 -----------------------------
 396 -- Compute version numbers for local decls
 397
 398 addVersionInfo :: Maybe ModIface        -- The old interface, read from M.hi
 399                -> ModIface              -- The new interface decls (lacking decls)
 400                -> [IfaceDecl]           -- The new decls
 401                -> (ModIface,
 402                    Bool,                -- True <=> no changes at all; no need to write new Iface
 403                    SDoc,                -- Differences
 404                    Maybe SDoc)          -- Warnings about orphans
 405
 406 addVersionInfo Nothing new_iface new_decls
 407 -- No old interface, so definitely write a new one!
 408   = (new_iface { mi_orphan = anyNothing ifInstOrph (mi_insts new_iface)
 409                           || anyNothing ifRuleOrph (mi_rules new_iface),
 410                  mi_decls  = [(initialVersion, decl) | decl <- new_decls],
 411                  mi_ver_fn = \n -> Just initialVersion },
 412      False,
 413      ptext SLIT("No old interface file"),
 414      pprOrphans orph_insts orph_rules)
 415   where
 416     orph_insts = filter (isNothing . ifInstOrph) (mi_insts new_iface)
 417     orph_rules = filter (isNothing . ifRuleOrph) (mi_rules new_iface)
 418
 419 addVersionInfo (Just old_iface@(ModIface { mi_mod_vers  = old_mod_vers,
 420                                            mi_exp_vers  = old_exp_vers,
 421                                            mi_rule_vers = old_rule_vers,
 422                                            mi_decls     = old_decls,
 423                                            mi_ver_fn    = old_decl_vers,
 424                                            mi_fix_fn    = old_fixities }))
 425                new_iface@(ModIface { mi_fix_fn = new_fixities })
 426                new_decls
 427
 428   | no_change_at_all = (old_iface,   True,  ptext SLIT("Interface file unchanged"), pp_orphs)
 429   | otherwise        = (final_iface, False, vcat [ptext SLIT("Interface file has changed"),
 430                                                   nest 2 pp_diffs], pp_orphs)
 431   where
 432     final_iface = new_iface { mi_mod_vers  = bump_unless no_output_change old_mod_vers,
 433                               mi_exp_vers  = bump_unless no_export_change old_exp_vers,
 434                               mi_rule_vers = bump_unless no_rule_change   old_rule_vers,
 435                               mi_orphan    = not (null new_orph_rules && null new_orph_insts),
 436                               mi_decls     = decls_w_vers,
 437                               mi_ver_fn    = mkIfaceVerCache decls_w_vers }
 438
 439     decls_w_vers = [(add_vers decl, decl) | decl <- new_decls]
 440
 441     -------------------
 442     (old_non_orph_insts, old_orph_insts) = mkOrphMap ifInstOrph (mi_insts old_iface)
 443     (new_non_orph_insts, new_orph_insts) = mkOrphMap ifInstOrph (mi_insts new_iface)
 444     same_insts occ = eqMaybeBy  (eqListBy eqIfInst)
 445                                 (lookupOccEnv old_non_orph_insts occ)
 446                                 (lookupOccEnv new_non_orph_insts occ)
 447
 448     (old_non_orph_rules, old_orph_rules) = mkOrphMap ifRuleOrph (mi_rules old_iface)
 449     (new_non_orph_rules, new_orph_rules) = mkOrphMap ifRuleOrph (mi_rules new_iface)
 450     same_rules occ = eqMaybeBy  (eqListBy eqIfRule)
 451                                 (lookupOccEnv old_non_orph_rules occ)
 452                                 (lookupOccEnv new_non_orph_rules occ)
 453     -------------------
 454     -- Computing what changed
 455     no_output_change = no_decl_change   && no_rule_change &&
 456                        no_export_change && no_deprec_change
 457     no_export_change = mi_exports new_iface == mi_exports old_iface     -- Kept sorted
 458     no_decl_change   = isEmptyOccSet changed_occs
 459     no_rule_change   = not (changedWrt changed_occs (eqListBy eqIfRule old_orph_rules new_orph_rules)
 460                          || changedWrt changed_occs (eqListBy eqIfInst old_orph_insts new_orph_insts))
 461     no_deprec_change = mi_deprecs new_iface == mi_deprecs old_iface
 462
 463         -- If the usages havn't changed either, we don't need to write the interface file
 464     no_other_changes = mi_usages new_iface == mi_usages old_iface &&
 465                        mi_deps new_iface == mi_deps old_iface
 466     no_change_at_all = no_output_change && no_other_changes
 467
 468     pp_diffs = vcat [pp_change no_export_change "Export list"
 469                         (ppr old_exp_vers <+> arrow <+> ppr (mi_exp_vers final_iface)),
 470                      pp_change no_rule_change "Rules"
 471                         (ppr old_rule_vers <+> arrow <+> ppr (mi_rule_vers final_iface)),
 472                      pp_change no_deprec_change "Deprecations" empty,
 473                      pp_change no_other_changes  "Usages" empty,
 474                      pp_decl_diffs]
 475     pp_change True  what info = empty
 476     pp_change False what info = text what <+> ptext SLIT("changed") <+> info
 477
 478     -------------------
 479     old_decl_env = mkOccEnv [(ifName decl, decl) | (_,decl) <- old_decls]
 480     same_fixity n = bool (old_fixities n == new_fixities n)
 481
 482     -------------------
 483     -- Adding version info
 484     new_version = bumpVersion old_mod_vers      -- Start from the old module version, not from zero
 485                                                 -- so that if you remove f, and then add it again,
 486                                                 -- you don't thereby reduce f's version number
 487     add_vers decl | occ `elemOccSet` changed_occs = new_version
 488                   | otherwise = expectJust "add_vers" (old_decl_vers occ)
 489                                 -- If it's unchanged, there jolly well
 490                   where         -- should be an old version number
 491                     occ = ifName decl
 492
 493     -------------------
 494     changed_occs :: OccSet
 495     changed_occs = computeChangedOccs eq_info
 496
 497     eq_info :: [(OccName, IfaceEq)]
 498     eq_info = map check_eq new_decls
 499     check_eq new_decl | Just old_decl <- lookupOccEnv old_decl_env occ
 500                       = (occ, new_decl `eqIfDecl` old_decl &&&
 501                               eq_indirects new_decl)
 502                       | otherwise {- No corresponding old decl -}
 503                       = (occ, NotEqual)
 504                       where
 505                         occ = ifName new_decl
 506
 507     eq_indirects :: IfaceDecl -> IfaceEq
 508                 -- When seeing if two decls are the same, remember to
 509                 -- check whether any relevant fixity or rules have changed
 510     eq_indirects (IfaceId {ifName = occ}) = eq_ind_occ occ
 511     eq_indirects (IfaceClass {ifName = cls_occ, ifSigs = sigs})
 512         = same_insts cls_occ &&&
 513           eq_ind_occs [op | IfaceClassOp op _ _ <- sigs]
 514     eq_indirects (IfaceData {ifName = tc_occ, ifCons = cons})
 515         = same_insts tc_occ &&& same_fixity tc_occ &&&  -- The TyCon can have a fixity too
 516           eq_ind_occs (map ifConOcc (visibleIfConDecls cons))
 517     eq_indirects other = Equal  -- Synonyms and foreign declarations
 518
 519     eq_ind_occ :: OccName -> IfaceEq    -- For class ops and Ids; check fixity and rules
 520     eq_ind_occ occ = same_fixity occ &&& same_rules occ
 521     eq_ind_occs = foldr ((&&&) . eq_ind_occ) Equal
 522
 523     -------------------
 524     -- Diffs
 525     pp_decl_diffs :: SDoc       -- Nothing => no changes
 526     pp_decl_diffs
 527         | isEmptyOccSet changed_occs = empty
 528         | otherwise
 529         = vcat [ptext SLIT("Changed occs:") <+> ppr (occSetElts changed_occs),
 530                 ptext SLIT("Version change for these decls:"),
 531                 nest 2 (vcat (map show_change new_decls))]
 532
 533     eq_env = mkOccEnv eq_info
 534     show_change new_decl
 535         | not (occ `elemOccSet` changed_occs) = empty
 536         | otherwise
 537         = vcat [ppr occ <+> ppr (old_decl_vers occ) <+> arrow <+> ppr new_version,
 538                 nest 2 why]
 539         where
 540           occ = ifName new_decl
 541           why = case lookupOccEnv eq_env occ of
 542                     Just (EqBut occs) -> sep [ppr occ <> colon, ptext SLIT("Free vars (only) changed:"),
 543                                               nest 2 (braces (fsep (map ppr (occSetElts
 544                                                 (occs `intersectOccSet` changed_occs)))))]
 545                     Just NotEqual
 546                         | Just old_decl <- lookupOccEnv old_decl_env occ
 547                         -> vcat [ptext SLIT("Old:") <+> ppr old_decl,
 548                          ptext SLIT("New:") <+> ppr new_decl]
 549                         | otherwise
 550                         -> ppr occ <+> ptext SLIT("only in new interface")
 551                     other -> pprPanic "MkIface.show_change" (ppr occ)
 552
 553     pp_orphs = pprOrphans new_orph_insts new_orph_rules
 554
 555 pprOrphans insts rules
 556   | null insts && null rules = Nothing
 557   | otherwise
 558   = Just $ vcat [
 559         if null insts then empty else
 560              hang (ptext SLIT("Warning: orphan instances:"))
 561                 2 (vcat (map ppr insts)),
 562         if null rules then empty else
 563              hang (ptext SLIT("Warning: orphan rules:"))
 564                 2 (vcat (map ppr rules))
 565     ]
 566
 567 computeChangedOccs :: [(OccName, IfaceEq)] -> OccSet
 568 computeChangedOccs eq_info
 569   = foldl add_changes emptyOccSet (stronglyConnComp edges)
 570   where
 571     edges :: [((OccName,IfaceEq), Unique, [Unique])]
 572     edges = [ (node, getUnique occ, map getUnique occs)
 573             | node@(occ, iface_eq) <- eq_info
 574             , let occs = case iface_eq of
 575                            EqBut occ_set -> occSetElts occ_set
 576                            other -> [] ]
 577
 578     -- Changes in declarations
 579     add_changes :: OccSet -> SCC (OccName, IfaceEq) -> OccSet
 580     add_changes so_far (AcyclicSCC (occ, iface_eq))
 581         | changedWrt so_far iface_eq                            -- This one has changed
 582         = extendOccSet so_far occ
 583     add_changes so_far (CyclicSCC pairs)
 584         | changedWrt so_far (foldr1 (&&&) (map snd pairs))      -- One of this group has changed
 585         = extendOccSetList so_far (map fst pairs)
 586     add_changes so_far other = so_far
 587
 588 changedWrt :: OccSet -> IfaceEq -> Bool
 589 changedWrt so_far Equal        = False
 590 changedWrt so_far NotEqual     = True
 591 changedWrt so_far (EqBut kids) = so_far `intersectsOccSet` kids
 592
 593 ----------------------
 594 -- mkOrphMap partitions instance decls or rules into
 595 --      (a) an OccEnv for ones that are not orphans,
 596 --          mapping the local OccName to a list of its decls
 597 --      (b) a list of orphan decls
 598 mkOrphMap :: (decl -> Maybe OccName)    -- (Just occ) for a non-orphan decl, keyed by occ
 599                                         -- Nothing for an orphan decl
 600           -> [decl]                     -- Sorted into canonical order
 601           -> (OccEnv [decl],            -- Non-orphan decls associated with their key;
 602                                         --      each sublist in canonical order
 603               [decl])                   -- Orphan decls; in canonical order
 604 mkOrphMap get_key decls
 605   = foldl go (emptyOccEnv, []) decls
 606   where
 607     go (non_orphs, orphs) d
 608         | Just occ <- get_key d
 609         = (extendOccEnv_C (\ ds _ -> d:ds) non_orphs occ [d], orphs)
 610         | otherwise = (non_orphs, d:orphs)
 611
 612 anyNothing :: (a -> Maybe b) -> [a] -> Bool
 613 anyNothing p []     = False
 614 anyNothing p (x:xs) = isNothing (p x) || anyNothing p xs
 615
 616 ----------------------
 617 mkIfaceDeprec :: Deprecations -> IfaceDeprecs
 618 mkIfaceDeprec NoDeprecs        = NoDeprecs
 619 mkIfaceDeprec (DeprecAll t)    = DeprecAll t
 620 mkIfaceDeprec (DeprecSome env) = DeprecSome (sortLe (<=) (nameEnvElts env))
 621
 622 ----------------------
 623 bump_unless :: Bool -> Version -> Version
 624 bump_unless True  v = v -- True <=> no change
 625 bump_unless False v = bumpVersion v
 626 \end{code}
 627
 628
 629 %*********************************************************
 630 %*                                                      *
 631 \subsection{Keeping track of what we've slurped, and version numbers}
 632 %*                                                      *
 633 %*********************************************************
 634
 635
 636 \begin{code}
 637 mkUsageInfo :: HscEnv
 638             -> ModuleEnv (Module, Bool, SrcSpan)
 639             -> [(ModuleName, IsBootInterface)]
 640             -> NameSet -> IO [Usage]
 641 mkUsageInfo hsc_env dir_imp_mods dep_mods used_names
 642   = do  { eps <- hscEPS hsc_env
 643         ; let usages = mk_usage_info (eps_PIT eps) hsc_env
 644                                      dir_imp_mods dep_mods used_names
 645         ; usages `seqList`  return usages }
 646          -- seq the list of Usages returned: occasionally these
 647          -- don't get evaluated for a while and we can end up hanging on to
 648          -- the entire collection of Ifaces.
 649
 650 mk_usage_info pit hsc_env dir_imp_mods dep_mods proto_used_names
 651   = mapCatMaybes mkUsage dep_mods
 652         -- ToDo: do we need to sort into canonical order?
 653   where
 654     hpt = hsc_HPT hsc_env
 655     dflags = hsc_dflags hsc_env
 656
 657     used_names = mkNameSet $                    -- Eliminate duplicates
 658                  [ nameParent n                 -- Just record usage on the 'main' names
 659                  | n <- nameSetToList proto_used_names
 660                  , not (isWiredInName n)        -- Don't record usages for wired-in names
 661                  , isExternalName n             -- Ignore internal names
 662                  ]
 663
 664     -- ent_map groups together all the things imported and used
 665     -- from a particular module in this package
 666     ent_map :: ModuleEnv [OccName]
 667     ent_map  = foldNameSet add_mv emptyModuleEnv used_names
 668     add_mv name mv_map = extendModuleEnv_C add_item mv_map mod [occ]
 669                    where
 670                      occ = nameOccName name
 671                      mod = nameModule name
 672                      add_item occs _ = occ:occs
 673
 674     depend_on_exports mod = case lookupModuleEnv dir_imp_mods mod of
 675                                 Just (_,no_imp,_) -> not no_imp
 676                                 Nothing           -> True
 677
 678     -- We want to create a Usage for a home module if
 679     --  a) we used something from; has something in used_names
 680     --  b) we imported all of it, even if we used nothing from it
 681     --          (need to recompile if its export list changes: export_vers)
 682     --  c) is a home-package orphan module (need to recompile if its
 683     --          instance decls change: rules_vers)
 684     mkUsage :: (ModuleName, IsBootInterface) -> Maybe Usage
 685     mkUsage (mod_name, _)
 686       |  isNothing maybe_iface          -- We can't depend on it if we didn't
 687       || (null used_occs                -- load its interface.
 688           && isNothing export_vers
 689           && not orphan_mod)
 690       = Nothing                 -- Record no usage info
 691
 692       | otherwise
 693       = Just (Usage { usg_name     = mod_name,
 694                       usg_mod      = mod_vers,
 695                       usg_exports  = export_vers,
 696                       usg_entities = ent_vers,
 697                       usg_rules    = rules_vers })
 698       where
 699         maybe_iface  = lookupIfaceByModule dflags hpt pit mod
 700                 -- In one-shot mode, the interfaces for home-package
 701                 -- modules accumulate in the PIT not HPT.  Sigh.
 702
 703         mod = mkModule (thisPackage dflags) mod_name
 704
 705         Just iface   = maybe_iface
 706         orphan_mod   = mi_orphan    iface
 707         version_env  = mi_ver_fn    iface
 708         mod_vers     = mi_mod_vers  iface
 709         rules_vers   = mi_rule_vers iface
 710         export_vers | depend_on_exports mod = Just (mi_exp_vers iface)
 711                     | otherwise             = Nothing
 712
 713         -- The sort is to put them into canonical order
 714         used_occs = lookupModuleEnv ent_map mod `orElse` []
 715         ent_vers :: [(OccName,Version)]
 716         ent_vers = [ (occ, version_env occ `orElse` initialVersion)
 717                    | occ <- sortLe (<=) used_occs]
 718 \end{code}
 719
 720 \begin{code}
 721 mkIfaceExports :: NameSet -> [(Module, [GenAvailInfo OccName])]
 722   -- Group by module and sort by occurrence
 723   -- This keeps the list in canonical order
 724 mkIfaceExports exports
 725   = [ (mod, eltsUFM avails)
 726     | (mod, avails) <- fmToList groupFM
 727     ]
 728   where
 729     groupFM :: ModuleEnv (UniqFM (GenAvailInfo OccName))
 730         -- Deliberately use the FastString so we
 731         -- get a canonical ordering
 732     groupFM = foldl add emptyModuleEnv (nameSetToList exports)
 733
 734     add env name = extendModuleEnv_C add_avail env mod
 735                                         (unitUFM avail_fs avail)
 736       where
 737         occ    = nameOccName name
 738         mod    = nameModule name
 739         avail | Just p <- nameParent_maybe name = AvailTC (nameOccName p) [occ]
 740               | isTcOcc occ                     = AvailTC occ [occ]
 741               | otherwise                       = Avail occ
 742         avail_fs = occNameFS (availName avail)
 743         add_avail avail_fm _ = addToUFM_C add_item avail_fm avail_fs avail
 744
 745         add_item (AvailTC p occs) _ = AvailTC p (List.insert occ occs)
 746         add_item (Avail n)        _ = pprPanic "MkIface.addAvail" (ppr n <+> ppr name)
 747 \end{code}
 748
 749
 750 %************************************************************************
 751 %*                                                                      *
 752         Load the old interface file for this module (unless
 753         we have it aleady), and check whether it is up to date
 754
 755 %*                                                                      *
 756 %************************************************************************
 757
 758 \begin{code}
 759 checkOldIface :: HscEnv
 760               -> ModSummary
 761               -> Bool                   -- Source unchanged
 762               -> Maybe ModIface         -- Old interface from compilation manager, if any
 763               -> IO (RecompileRequired, Maybe ModIface)
 764
 765 checkOldIface hsc_env mod_summary source_unchanged maybe_iface
 766   = do  { showPass (hsc_dflags hsc_env)
 767                    ("Checking old interface for " ++
 768                         showSDoc (ppr (ms_mod mod_summary))) ;
 769
 770         ; initIfaceCheck hsc_env $
 771           check_old_iface hsc_env mod_summary source_unchanged maybe_iface
 772      }
 773
 774 check_old_iface hsc_env mod_summary source_unchanged maybe_iface
 775  =      -- CHECK WHETHER THE SOURCE HAS CHANGED
 776     ifM (not source_unchanged)
 777         (traceHiDiffs (nest 4 (text "Source file changed or recompilation check turned off")))
 778                                                 `thenM_`
 779
 780      -- If the source has changed and we're in interactive mode, avoid reading
 781      -- an interface; just return the one we might have been supplied with.
 782     getGhcMode                                  `thenM` \ ghc_mode ->
 783     if (ghc_mode == Interactive || ghc_mode == JustTypecheck)
 784         && not source_unchanged then
 785          returnM (outOfDate, maybe_iface)
 786     else
 787
 788     case maybe_iface of {
 789        Just old_iface -> do -- Use the one we already have
 790         recomp <- checkVersions hsc_env source_unchanged old_iface
 791         return (recomp, Just old_iface)
 792
 793     ;  Nothing ->
 794
 795         -- Try and read the old interface for the current module
 796         -- from the .hi file left from the last time we compiled it
 797     let
 798         iface_path = msHiFilePath mod_summary
 799     in
 800     readIface (ms_mod mod_summary) iface_path False     `thenM` \ read_result ->
 801     case read_result of {
 802        Failed err ->    -- Old interface file not found, or garbled; give up
 803                    traceIf (text "FYI: cannot read old interface file:"
 804                                  $$ nest 4 err)         `thenM_`
 805                    returnM (outOfDate, Nothing)
 806
 807     ;  Succeeded iface ->
 808
 809         -- We have got the old iface; check its versions
 810     checkVersions hsc_env source_unchanged iface        `thenM` \ recomp ->
 811     returnM (recomp, Just iface)
 812     }}
 813 \end{code}
 814
 815 @recompileRequired@ is called from the HscMain.   It checks whether
 816 a recompilation is required.  It needs access to the persistent state,
 817 finder, etc, because it may have to load lots of interface files to
 818 check their versions.
 819
 820 \begin{code}
 821 type RecompileRequired = Bool
 822 upToDate  = False       -- Recompile not required
 823 outOfDate = True        -- Recompile required
 824
 825 checkVersions :: HscEnv
 826               -> Bool           -- True <=> source unchanged
 827               -> ModIface       -- Old interface
 828               -> IfG RecompileRequired
 829 checkVersions hsc_env source_unchanged iface
 830   | not source_unchanged
 831   = returnM outOfDate
 832   | otherwise
 833   = do  { traceHiDiffs (text "Considering whether compilation is required for" <+>
 834                         ppr (mi_module iface) <> colon)
 835
 836         -- Source code unchanged and no errors yet... carry on
 837
 838         -- First put the dependent-module info, read from the old interface, into the envt,
 839         -- so that when we look for interfaces we look for the right one (.hi or .hi-boot)
 840         --
 841         -- It's just temporary because either the usage check will succeed
 842         -- (in which case we are done with this module) or it'll fail (in which
 843         -- case we'll compile the module from scratch anyhow).
 844         --
 845         -- We do this regardless of compilation mode
 846         ; updateEps_ $ \eps  -> eps { eps_is_boot = mod_deps }
 847
 848         ; let this_pkg = thisPackage (hsc_dflags hsc_env)
 849         ; checkList [checkModUsage this_pkg u | u <- mi_usages iface]
 850     }
 851   where
 852         -- This is a bit of a hack really
 853     mod_deps :: ModuleNameEnv (ModuleName, IsBootInterface)
 854     mod_deps = mkModDeps (dep_mods (mi_deps iface))
 855
 856 checkModUsage :: PackageId ->Usage -> IfG RecompileRequired
 857 -- Given the usage information extracted from the old
 858 -- M.hi file for the module being compiled, figure out
 859 -- whether M needs to be recompiled.
 860
 861 checkModUsage this_pkg (Usage { usg_name = mod_name, usg_mod = old_mod_vers,
 862                                 usg_rules = old_rule_vers,
 863                                 usg_exports = maybe_old_export_vers,
 864                                 usg_entities = old_decl_vers })
 865   =     -- Load the imported interface is possible
 866     let
 867         doc_str = sep [ptext SLIT("need version info for"), ppr mod_name]
 868     in
 869     traceHiDiffs (text "Checking usages for module" <+> ppr mod_name) `thenM_`
 870
 871     let
 872         mod = mkModule this_pkg mod_name
 873     in
 874     loadInterface doc_str mod ImportBySystem            `thenM` \ mb_iface ->
 875         -- Load the interface, but don't complain on failure;
 876         -- Instead, get an Either back which we can test
 877
 878     case mb_iface of {
 879         Failed exn ->  (out_of_date (sep [ptext SLIT("Can't find version number for module"),
 880                                        ppr mod_name]));
 881                 -- Couldn't find or parse a module mentioned in the
 882                 -- old interface file.  Don't complain -- it might just be that
 883                 -- the current module doesn't need that import and it's been deleted
 884
 885         Succeeded iface ->
 886     let
 887         new_mod_vers    = mi_mod_vers  iface
 888         new_decl_vers   = mi_ver_fn    iface
 889         new_export_vers = mi_exp_vers  iface
 890         new_rule_vers   = mi_rule_vers iface
 891     in
 892         -- CHECK MODULE
 893     checkModuleVersion old_mod_vers new_mod_vers        `thenM` \ recompile ->
 894     if not recompile then
 895         returnM upToDate
 896     else
 897
 898         -- CHECK EXPORT LIST
 899     if checkExportList maybe_old_export_vers new_export_vers then
 900         out_of_date_vers (ptext SLIT("  Export list changed"))
 901                          (expectJust "checkModUsage" maybe_old_export_vers)
 902                          new_export_vers
 903     else
 904
 905         -- CHECK RULES
 906     if old_rule_vers /= new_rule_vers then
 907         out_of_date_vers (ptext SLIT("  Rules changed"))
 908                          old_rule_vers new_rule_vers
 909     else
 910
 911         -- CHECK ITEMS ONE BY ONE
 912     checkList [checkEntityUsage new_decl_vers u | u <- old_decl_vers]   `thenM` \ recompile ->
 913     if recompile then
 914         returnM outOfDate       -- This one failed, so just bail out now
 915     else
 916         up_to_date (ptext SLIT("  Great!  The bits I use are up to date"))
 917     }
 918
 919 ------------------------
 920 checkModuleVersion old_mod_vers new_mod_vers
 921   | new_mod_vers == old_mod_vers
 922   = up_to_date (ptext SLIT("Module version unchanged"))
 923
 924   | otherwise
 925   = out_of_date_vers (ptext SLIT("  Module version has changed"))
 926                      old_mod_vers new_mod_vers
 927
 928 ------------------------
 929 checkExportList Nothing  new_vers = upToDate
 930 checkExportList (Just v) new_vers = v /= new_vers
 931
 932 ------------------------
 933 checkEntityUsage new_vers (name,old_vers)
 934   = case new_vers name of
 935
 936         Nothing       ->        -- We used it before, but it ain't there now
 937                           out_of_date (sep [ptext SLIT("No longer exported:"), ppr name])
 938
 939         Just new_vers   -- It's there, but is it up to date?
 940           | new_vers == old_vers -> traceHiDiffs (text "  Up to date" <+> ppr name <+> parens (ppr new_vers)) `thenM_`
 941                                     returnM upToDate
 942           | otherwise            -> out_of_date_vers (ptext SLIT("  Out of date:") <+> ppr name)
 943                                                      old_vers new_vers
 944
 945 up_to_date  msg = traceHiDiffs msg `thenM_` returnM upToDate
 946 out_of_date msg = traceHiDiffs msg `thenM_` returnM outOfDate
 947 out_of_date_vers msg old_vers new_vers
 948   = out_of_date (hsep [msg, ppr old_vers, ptext SLIT("->"), ppr new_vers])
 949
 950 ----------------------
 951 checkList :: [IfG RecompileRequired] -> IfG RecompileRequired
 952 -- This helper is used in two places
 953 checkList []             = returnM upToDate
 954 checkList (check:checks) = check        `thenM` \ recompile ->
 955                            if recompile then
 956                                 returnM outOfDate
 957                            else
 958                                 checkList checks
 959 \end{code}
 960
 961 %************************************************************************
 962 %*                                                                      *
 963                 Printing interfaces
 964 %*                                                                      *
 965 %************************************************************************
 966
 967 \begin{code}
 968 showIface :: FilePath -> IO ()
 969 -- Read binary interface, and print it out
 970 showIface filename = do
 971    -- skip the version check; we don't want to worry about profiled vs.
 972    -- non-profiled interfaces, for example.
 973    writeIORef v_IgnoreHiWay True
 974    iface <- Binary.getBinFileWithDict filename
 975    printDump (pprModIface iface)
 976  where
 977 \end{code}
 978
 979
 980 \begin{code}
 981 pprModIface :: ModIface -> SDoc
 982 -- Show a ModIface
 983 pprModIface iface
 984  = vcat [ ptext SLIT("interface")
 985                 <+> ppr (mi_module iface) <+> pp_boot
 986                 <+> ppr (mi_mod_vers iface) <+> pp_sub_vers
 987                 <+> (if mi_orphan iface then ptext SLIT("[orphan module]") else empty)
 988                 <+> int opt_HiVersion
 989                 <+> ptext SLIT("where")
 990         , vcat (map pprExport (mi_exports iface))
 991         , pprDeps (mi_deps iface)
 992         , vcat (map pprUsage (mi_usages iface))
 993         , pprFixities (mi_fixities iface)
 994         , vcat (map pprIfaceDecl (mi_decls iface))
 995         , vcat (map ppr (mi_insts iface))
 996         , vcat (map ppr (mi_rules iface))
 997         , pprDeprecs (mi_deprecs iface)
 998         ]
 999   where
1000     pp_boot | mi_boot iface = ptext SLIT("[boot]")
1001             | otherwise     = empty
1002
1003     exp_vers  = mi_exp_vers iface
1004     rule_vers = mi_rule_vers iface
1005
1006     pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty
1007                 | otherwise = brackets (ppr exp_vers <+> ppr rule_vers)
1008 \end{code}
1009
1010 When printing export lists, we print like this:
1011         Avail   f               f
1012         AvailTC C [C, x, y]     C(x,y)
1013         AvailTC C [x, y]        C!(x,y)         -- Exporting x, y but not C
1014
1015 \begin{code}
1016 pprExport :: IfaceExport -> SDoc
1017 pprExport (mod, items)
1018  = hsep [ ptext SLIT("export"), ppr mod, hsep (map pp_avail items) ]
1019   where
1020     pp_avail :: GenAvailInfo OccName -> SDoc
1021     pp_avail (Avail occ)    = ppr occ
1022     pp_avail (AvailTC _ []) = empty
1023     pp_avail (AvailTC n (n':ns))
1024         | n==n'     = ppr n <> pp_export ns
1025         | otherwise = ppr n <> char '|' <> pp_export (n':ns)
1026
1027     pp_export []    = empty
1028     pp_export names = braces (hsep (map ppr names))
1029
1030 pprUsage :: Usage -> SDoc
1031 pprUsage usage
1032   = hsep [ptext SLIT("import"), ppr (usg_name usage),
1033           int (usg_mod usage),
1034           pp_export_version (usg_exports usage),
1035           int (usg_rules usage),
1036           pp_versions (usg_entities usage) ]
1037   where
1038     pp_versions nvs = hsep [ ppr n <+> int v | (n,v) <- nvs ]
1039     pp_export_version Nothing  = empty
1040     pp_export_version (Just v) = int v
1041
1042 pprDeps :: Dependencies -> SDoc
1043 pprDeps (Deps { dep_mods = mods, dep_pkgs = pkgs, dep_orphs = orphs})
1044   = vcat [ptext SLIT("module dependencies:") <+> fsep (map ppr_mod mods),
1045           ptext SLIT("package dependencies:") <+> fsep (map ppr pkgs),
1046           ptext SLIT("orphans:") <+> fsep (map ppr orphs)
1047         ]
1048   where
1049     ppr_mod (mod_name, boot) = ppr mod_name <+> ppr_boot boot
1050     ppr_boot True  = text "[boot]"
1051     ppr_boot False = empty
1052
1053 pprIfaceDecl :: (Version, IfaceDecl) -> SDoc
1054 pprIfaceDecl (ver, decl)
1055   = ppr_vers ver <+> ppr decl
1056   where
1057         -- Print the version for the decl
1058     ppr_vers v | v == initialVersion = empty
1059                | otherwise           = int v
1060
1061 pprFixities :: [(OccName, Fixity)] -> SDoc
1062 pprFixities []    = empty
1063 pprFixities fixes = ptext SLIT("fixities") <+> pprWithCommas pprFix fixes
1064                   where
1065                     pprFix (occ,fix) = ppr fix <+> ppr occ
1066
1067 pprDeprecs NoDeprecs        = empty
1068 pprDeprecs (DeprecAll txt)  = ptext SLIT("Deprecate all") <+> doubleQuotes (ftext txt)
1069 pprDeprecs (DeprecSome prs) = ptext SLIT("Deprecate") <+> vcat (map pprDeprec prs)
1070                             where
1071                               pprDeprec (name, txt) = ppr name <+> doubleQuotes (ftext txt)
1072 \end{code}