compiler/iface/MkIface.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
   4 %
   5
   6 \begin{code}
   7 {-# OPTIONS -w #-}
   8 -- The above warning supression flag is a temporary kludge.
   9 -- While working on this module you are encouraged to remove it and fix
  10 -- any warnings in the module. See
  11 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
  12 -- for details
  13
  14 module MkIface (
  15         mkUsedNames,
  16         mkDependencies,
  17         mkIface,        -- Build a ModIface from a ModGuts,
  18                         -- including computing version information
  19
  20         mkIfaceTc,
  21
  22         writeIfaceFile, -- Write the interface file
  23
  24         checkOldIface,  -- See if recompilation is required, by
  25                         -- comparing version information
  26
  27         tyThingToIfaceDecl -- Converting things to their Iface equivalents
  28  ) where
  29 \end{code}
  30
  31         -----------------------------------------------
  32                 MkIface.lhs deals with versioning
  33         -----------------------------------------------
  34
  35 Here's the version-related info in an interface file
  36
  37   module Foo 8          -- module-version
  38              3          -- export-list-version
  39              2          -- rule-version
  40     Usages:     -- Version info for what this compilation of Foo imported
  41         Baz 3           -- Module version
  42             [4]         -- The export-list version if Foo depended on it
  43             (g,2)       -- Function and its version
  44             (T,1)       -- Type and its version
  45
  46     <version> f :: Int -> Int {- Unfolding: \x -> Wib.t[2] x -}
  47                 -- The [2] says that f's unfolding
  48                 -- mentions verison 2 of Wib.t
  49
  50         -----------------------------------------------
  51                         Basic idea
  52         -----------------------------------------------
  53
  54 Basic idea:
  55   * In the mi_usages information in an interface, we record the
  56     version number of each free variable of the module
  57
  58   * In mkIface, we compute the version number of each exported thing A.f
  59     by comparing its A.f's info with its new info, and bumping its
  60     version number if it differs.  If A.f mentions B.g, and B.g's version
  61     number has changed, then we count A.f as having changed too.
  62
  63   * In checkOldIface we compare the mi_usages for the module with
  64     the actual version info for all each thing recorded in mi_usages
  65
  66
  67 Fixities
  68 ~~~~~~~~
  69 We count A.f as changing if its fixity changes
  70
  71 Rules
  72 ~~~~~
  73 If a rule changes, we want to recompile any module that might be
  74 affected by that rule.  For non-orphan rules, this is relatively easy.
  75 If module M defines f, and a rule for f, just arrange that the version
  76 number for M.f changes if any of the rules for M.f change.  Any module
  77 that does not depend on M.f can't be affected by the rule-change
  78 either.
  79
  80 Orphan rules (ones whose 'head function' is not defined in M) are
  81 harder.  Here's what we do.
  82
  83   * We have a per-module orphan-rule version number which changes if
  84     any orphan rule changes. (It's unaffected by non-orphan rules.)
  85
  86   * We record usage info for any orphan module 'below' this one,
  87     giving the orphan-rule version number.  We recompile if this
  88     changes.
  89
  90 The net effect is that if an orphan rule changes, we recompile every
  91 module above it.  That's very conservative, but it's devilishly hard
  92 to know what it might affect, so we just have to be conservative.
  93
  94 Instance decls
  95 ~~~~~~~~~~~~~~
  96 In an iface file we have
  97      module A where
  98         instance Eq a => Eq [a]  =  dfun29
  99         dfun29 :: ...
 100
 101 We have a version number for dfun29, covering its unfolding
 102 etc. Suppose we are compiling a module M that imports A only
 103 indirectly.  If typechecking M uses this instance decl, we record the
 104 dependency on A.dfun29 as if it were a free variable of the module
 105 (via the tcg_inst_usages accumulator).  That means that A will appear
 106 in M's usage list.  If the shape of the instance declaration changes,
 107 then so will dfun29's version, triggering a recompilation.
 108
 109 Adding an instance declaration, or changing an instance decl that is
 110 not currently used, is more tricky.  (This really only makes a
 111 difference when we have overlapping instance decls, because then the
 112 new instance decl might kick in to override the old one.)  We handle
 113 this in a very similar way that we handle rules above.
 114
 115   * For non-orphan instance decls, identify one locally-defined tycon/class
 116     mentioned in the decl.  Treat the instance decl as part of the defn of that
 117     tycon/class, so that if the shape of the instance decl changes, so does the
 118     tycon/class; that in turn will force recompilation of anything that uses
 119     that tycon/class.
 120
 121   * For orphan instance decls, act the same way as for orphan rules.
 122     Indeed, we use the same global orphan-rule version number.
 123
 124 mkUsageInfo
 125 ~~~~~~~~~~~
 126 mkUsageInfo figures out what the ``usage information'' for this
 127 moudule is; that is, what it must record in its interface file as the
 128 things it uses.
 129
 130 We produce a line for every module B below the module, A, currently being
 131 compiled:
 132         import B <n> ;
 133 to record the fact that A does import B indirectly.  This is used to decide
 134 to look to look for B.hi rather than B.hi-boot when compiling a module that
 135 imports A.  This line says that A imports B, but uses nothing in it.
 136 So we'll get an early bale-out when compiling A if B's version changes.
 137
 138 The usage information records:
 139
 140 \begin{itemize}
 141 \item   (a) anything reachable from its body code
 142 \item   (b) any module exported with a @module Foo@
 143 \item   (c) anything reachable from an exported item
 144 \end{itemize}
 145
 146 Why (b)?  Because if @Foo@ changes then this module's export list
 147 will change, so we must recompile this module at least as far as
 148 making a new interface file --- but in practice that means complete
 149 recompilation.
 150
 151 Why (c)?  Consider this:
 152 \begin{verbatim}
 153         module A( f, g ) where  |       module B( f ) where
 154           import B( f )         |         f = h 3
 155           g = ...               |         h = ...
 156 \end{verbatim}
 157
 158 Here, @B.f@ isn't used in A.  Should we nevertheless record @B.f@ in
 159 @A@'s usages?  Our idea is that we aren't going to touch A.hi if it is
 160 *identical* to what it was before.  If anything about @B.f@ changes
 161 than anyone who imports @A@ should be recompiled in case they use
 162 @B.f@ (they'll get an early exit if they don't).  So, if anything
 163 about @B.f@ changes we'd better make sure that something in A.hi
 164 changes, and the convenient way to do that is to record the version
 165 number @B.f@ in A.hi in the usage list.  If B.f changes that'll force a
 166 complete recompiation of A, which is overkill but it's the only way to
 167 write a new, slightly different, A.hi.
 168
 169 But the example is tricker.  Even if @B.f@ doesn't change at all,
 170 @B.h@ may do so, and this change may not be reflected in @f@'s version
 171 number.  But with -O, a module that imports A must be recompiled if
 172 @B.h@ changes!  So A must record a dependency on @B.h@.  So we treat
 173 the occurrence of @B.f@ in the export list *just as if* it were in the
 174 code of A, and thereby haul in all the stuff reachable from it.
 175
 176         *** Conclusion: if A mentions B.f in its export list,
 177             behave just as if A mentioned B.f in its source code,
 178             and slurp in B.f and all its transitive closure ***
 179
 180 [NB: If B was compiled with -O, but A isn't, we should really *still*
 181 haul in all the unfoldings for B, in case the module that imports A *is*
 182 compiled with -O.  I think this is the case.]
 183
 184
 185 \begin{code}
 186 #include "HsVersions.h"
 187
 188 import IfaceSyn
 189 import IfaceType
 190 import LoadIface
 191 import Id
 192 import IdInfo
 193 import NewDemand
 194 import CoreSyn
 195 import CoreFVs
 196 import Class
 197 import TyCon
 198 import DataCon
 199 import Type
 200 import TcType
 201 import InstEnv
 202 import FamInstEnv
 203 import TcRnMonad
 204 import HscTypes
 205 import Finder
 206 import DynFlags
 207 import VarEnv
 208 import Var
 209 import Name
 210 import NameEnv
 211 import NameSet
 212 import OccName
 213 import Module
 214 import BinIface
 215 import Unique
 216 import ErrUtils
 217 import Digraph
 218 import SrcLoc
 219 import PackageConfig    hiding ( Version )
 220 import Outputable
 221 import BasicTypes       hiding ( SuccessFlag(..) )
 222 import UniqFM
 223 import Util             hiding ( eqListBy )
 224 import FiniteMap
 225 import FastString
 226 import Maybes
 227 import ListSetOps
 228
 229 import Control.Monad
 230 import Data.List
 231 import Data.IORef
 232 \end{code}
 233
 234
 235
 236 %************************************************************************
 237 %*                                                                      *
 238 \subsection{Completing an interface}
 239 %*                                                                      *
 240 %************************************************************************
 241
 242 \begin{code}
 243 mkIface :: HscEnv
 244         -> Maybe ModIface       -- The old interface, if we have it
 245         -> ModDetails           -- The trimmed, tidied interface
 246         -> ModGuts              -- Usages, deprecations, etc
 247         -> IO (ModIface,        -- The new one, complete with decls and versions
 248                Bool)            -- True <=> there was an old Iface, and the new one
 249                                 --          is identical, so no need to write it
 250
 251 mkIface hsc_env maybe_old_iface mod_details
 252          ModGuts{     mg_module    = this_mod,
 253                       mg_boot      = is_boot,
 254                       mg_used_names = used_names,
 255                       mg_deps      = deps,
 256                       mg_dir_imps  = dir_imp_mods,
 257                       mg_rdr_env   = rdr_env,
 258                       mg_fix_env   = fix_env,
 259                       mg_deprecs   = deprecs,
 260                       mg_hpc_info  = hpc_info }
 261         = mkIface_ hsc_env maybe_old_iface
 262                    this_mod is_boot used_names deps rdr_env
 263                    fix_env deprecs hpc_info dir_imp_mods mod_details
 264
 265 -- | make an interface from the results of typechecking only.  Useful
 266 -- for non-optimising compilation, or where we aren't generating any
 267 -- object code at all ('HscNothing').
 268 mkIfaceTc :: HscEnv
 269           -> Maybe ModIface     -- The old interface, if we have it
 270           -> ModDetails         -- gotten from mkBootModDetails, probably
 271           -> TcGblEnv           -- Usages, deprecations, etc
 272           -> IO (ModIface,
 273                  Bool)
 274 mkIfaceTc hsc_env maybe_old_iface mod_details
 275   tc_result@TcGblEnv{ tcg_mod = this_mod,
 276                       tcg_src = hsc_src,
 277                       tcg_imports = imports,
 278                       tcg_rdr_env = rdr_env,
 279                       tcg_fix_env = fix_env,
 280                       tcg_deprecs = deprecs,
 281                       tcg_hpc = other_hpc_info
 282                     }
 283   = do
 284           used_names <- mkUsedNames tc_result
 285           deps <- mkDependencies tc_result
 286           let hpc_info = emptyHpcInfo other_hpc_info
 287           mkIface_ hsc_env maybe_old_iface
 288                    this_mod (isHsBoot hsc_src) used_names deps rdr_env
 289                    fix_env deprecs hpc_info (imp_mods imports) mod_details
 290
 291
 292 mkUsedNames :: TcGblEnv -> IO NameSet
 293 mkUsedNames
 294           TcGblEnv{ tcg_inst_uses = dfun_uses_var,
 295                     tcg_dus = dus
 296                   }
 297  = do
 298         dfun_uses <- readIORef dfun_uses_var            -- What dfuns are used
 299         return (allUses dus `unionNameSets` dfun_uses)
 300
 301 mkDependencies :: TcGblEnv -> IO Dependencies
 302 mkDependencies
 303           TcGblEnv{ tcg_mod = mod,
 304                     tcg_imports = imports,
 305                     tcg_th_used = th_var
 306                   }
 307  = do
 308       th_used   <- readIORef th_var                        -- Whether TH is used
 309       let
 310         dep_mods = eltsUFM (delFromUFM (imp_dep_mods imports) (moduleName mod))
 311                 -- M.hi-boot can be in the imp_dep_mods, but we must remove
 312                 -- it before recording the modules on which this one depends!
 313                 -- (We want to retain M.hi-boot in imp_dep_mods so that
 314                 --  loadHiBootInterface can see if M's direct imports depend
 315                 --  on M.hi-boot, and hence that we should do the hi-boot consistency
 316                 --  check.)
 317
 318         dir_imp_mods = imp_mods imports
 319
 320                 -- Modules don't compare lexicographically usually,
 321                 -- but we want them to do so here.
 322         le_mod :: Module -> Module -> Bool
 323         le_mod m1 m2 = moduleNameFS (moduleName m1)
 324                            <= moduleNameFS (moduleName m2)
 325
 326         le_dep_mod :: (ModuleName, IsBootInterface)
 327                     -> (ModuleName, IsBootInterface) -> Bool
 328         le_dep_mod (m1,_) (m2,_) = moduleNameFS m1 <= moduleNameFS m2
 329
 330
 331         pkgs | th_used   = insertList thPackageId (imp_dep_pkgs imports)
 332              | otherwise = imp_dep_pkgs imports
 333
 334       return Deps { dep_mods   = sortLe le_dep_mod dep_mods,
 335                     dep_pkgs   = sortLe (<=)   pkgs,
 336                     dep_orphs  = sortLe le_mod (imp_orphs  imports),
 337                     dep_finsts = sortLe le_mod (imp_finsts imports) }
 338                 -- sort to get into canonical order
 339
 340
 341 mkIface_ hsc_env maybe_old_iface
 342          this_mod is_boot used_names deps rdr_env fix_env src_deprecs hpc_info
 343          dir_imp_mods
 344          ModDetails{  md_insts     = insts,
 345                       md_fam_insts = fam_insts,
 346                       md_rules     = rules,
 347                       md_vect_info = vect_info,
 348                       md_types     = type_env,
 349                       md_exports   = exports }
 350 -- NB:  notice that mkIface does not look at the bindings
 351 --      only at the TypeEnv.  The previous Tidy phase has
 352 --      put exactly the info into the TypeEnv that we want
 353 --      to expose in the interface
 354
 355   = do  {eps <- hscEPS hsc_env
 356
 357         ; usages <- mkUsageInfo hsc_env dir_imp_mods (dep_mods deps) used_names
 358
 359         ; let   { entities = typeEnvElts type_env ;
 360                   decls  = [ tyThingToIfaceDecl entity
 361                            | entity <- entities,
 362                              let name = getName entity,
 363                              not (isImplicitTyThing entity),
 364                                 -- No implicit Ids and class tycons in the interface file
 365                              not (isWiredInName name),
 366                                 -- Nor wired-in things; the compiler knows about them anyhow
 367                              nameIsLocalOrFrom this_mod name  ]
 368                                 -- Sigh: see Note [Root-main Id] in TcRnDriver
 369
 370                 ; fixities    = [(occ,fix) | FixItem occ fix <- nameEnvElts fix_env]
 371                 ; deprecs     = src_deprecs
 372                 ; iface_rules = map (coreRuleToIfaceRule this_mod) rules
 373                 ; iface_insts = map instanceToIfaceInst insts
 374                 ; iface_fam_insts = map famInstToIfaceFamInst fam_insts
 375                 ; iface_vect_info = flattenVectInfo vect_info
 376
 377                 ; intermediate_iface = ModIface {
 378                         mi_module   = this_mod,
 379                         mi_boot     = is_boot,
 380                         mi_deps     = deps,
 381                         mi_usages   = usages,
 382                         mi_exports  = mkIfaceExports exports,
 383
 384                         -- Sort these lexicographically, so that
 385                         -- the result is stable across compilations
 386                         mi_insts    = sortLe le_inst iface_insts,
 387                         mi_fam_insts= sortLe le_fam_inst iface_fam_insts,
 388                         mi_rules    = sortLe le_rule iface_rules,
 389
 390                         mi_vect_info = iface_vect_info,
 391
 392                         mi_fixities = fixities,
 393                         mi_deprecs  = deprecs,
 394                         mi_globals  = Just rdr_env,
 395
 396                         -- Left out deliberately: filled in by addVersionInfo
 397                         mi_mod_vers  = initialVersion,
 398                         mi_exp_vers  = initialVersion,
 399                         mi_rule_vers = initialVersion,
 400                         mi_orphan    = False,   -- Always set by addVersionInfo, but
 401                                                 -- it's a strict field, so we can't omit it.
 402                         mi_finsts    = False,   -- Ditto
 403                         mi_decls     = deliberatelyOmitted "decls",
 404                         mi_ver_fn    = deliberatelyOmitted "ver_fn",
 405                         mi_hpc       = isHpcUsed hpc_info,
 406
 407                         -- And build the cached values
 408                         mi_dep_fn = mkIfaceDepCache deprecs,
 409                         mi_fix_fn = mkIfaceFixCache fixities }
 410
 411                 -- Add version information
 412               ; ext_ver_fn = mkParentVerFun hsc_env eps
 413                 ; (new_iface, no_change_at_all, pp_diffs, pp_orphs)
 414                         = {-# SCC "versioninfo" #-}
 415                          addVersionInfo ext_ver_fn maybe_old_iface
 416                                          intermediate_iface decls
 417                 }
 418
 419                 -- Debug printing
 420         ; when (isJust pp_orphs && dopt Opt_WarnOrphans dflags)
 421                (printDump (expectJust "mkIface" pp_orphs))
 422         ; when (dopt Opt_D_dump_hi_diffs dflags) (printDump pp_diffs)
 423         ; dumpIfSet_dyn dflags Opt_D_dump_hi "FINAL INTERFACE"
 424                         (pprModIface new_iface)
 425
 426                 -- bug #1617: on reload we weren't updating the PrintUnqualified
 427                 -- correctly.  This stems from the fact that the interface had
 428                 -- not changed, so addVersionInfo returns the old ModIface
 429                 -- with the old GlobalRdrEnv (mi_globals).
 430         ; let final_iface = new_iface{ mi_globals = Just rdr_env }
 431
 432         ; return (final_iface, no_change_at_all) }
 433   where
 434      r1 `le_rule`     r2 = ifRuleName      r1    <=    ifRuleName      r2
 435      i1 `le_inst`     i2 = ifDFun          i1 `le_occ` ifDFun          i2
 436      i1 `le_fam_inst` i2 = ifFamInstTcName i1 `le_occ` ifFamInstTcName i2
 437
 438      le_occ :: Name -> Name -> Bool
 439         -- Compare lexicographically by OccName, *not* by unique, because
 440         -- the latter is not stable across compilations
 441      le_occ n1 n2 = nameOccName n1 <= nameOccName n2
 442
 443      dflags = hsc_dflags hsc_env
 444      deliberatelyOmitted x = panic ("Deliberately omitted: " ++ x)
 445      ifFamInstTcName = ifaceTyConName . ifFamInstTyCon
 446
 447      flattenVectInfo (VectInfo { vectInfoVar   = vVar
 448                                , vectInfoTyCon = vTyCon
 449                                }) =
 450        IfaceVectInfo {
 451          ifaceVectInfoVar        = [ Var.varName v
 452                                    | (v, _) <- varEnvElts vVar],
 453          ifaceVectInfoTyCon      = [ tyConName t
 454                                    | (t, t_v) <- nameEnvElts vTyCon
 455                                    , t /= t_v],
 456          ifaceVectInfoTyConReuse = [ tyConName t
 457                                    | (t, t_v) <- nameEnvElts vTyCon
 458                                    , t == t_v]
 459        }
 460
 461 -----------------------------
 462 writeIfaceFile :: DynFlags -> ModLocation -> ModIface -> IO ()
 463 writeIfaceFile dflags location new_iface
 464     = do createDirectoryHierarchy (directoryOf hi_file_path)
 465          writeBinIface dflags hi_file_path new_iface
 466     where hi_file_path = ml_hi_file location
 467
 468
 469 -- -----------------------------------------------------------------------------
 470 -- Look up parents and versions of Names
 471
 472 -- This is like a global version of the mi_ver_fn field in each ModIface.
 473 -- Given a Name, it finds the ModIface, and then uses mi_ver_fn to get
 474 -- the parent and version info.
 475
 476 mkParentVerFun
 477         :: HscEnv                       -- needed to look up versions
 478         -> ExternalPackageState         -- ditto
 479         -> (Name -> (OccName,Version))
 480 mkParentVerFun hsc_env eps
 481   = \name ->
 482       let
 483         mod = nameModule name
 484         occ = nameOccName name
 485         iface = lookupIfaceByModule (hsc_dflags hsc_env) hpt pit mod `orElse`
 486                    pprPanic "lookupVers2" (ppr mod <+> ppr occ)
 487       in
 488         mi_ver_fn iface occ `orElse`
 489                  pprPanic "lookupVers1" (ppr mod <+> ppr occ)
 490   where
 491       hpt = hsc_HPT hsc_env
 492       pit = eps_PIT eps
 493
 494 -----------------------------------------------------------------------------
 495 -- Compute version numbers for local decls
 496
 497 addVersionInfo
 498         :: (Name -> (OccName,Version))  -- lookup parents and versions of names
 499         -> Maybe ModIface  -- The old interface, read from M.hi
 500         -> ModIface        -- The new interface (lacking decls)
 501         -> [IfaceDecl]     -- The new decls
 502         -> (ModIface,   -- Updated interface
 503             Bool,          -- True <=> no changes at all; no need to write Iface
 504             SDoc,          -- Differences
 505             Maybe SDoc) -- Warnings about orphans
 506
 507 addVersionInfo ver_fn Nothing new_iface new_decls
 508 -- No old interface, so definitely write a new one!
 509   = (new_iface { mi_orphan = not (null orph_insts && null orph_rules)
 510                , mi_finsts = not . null $ mi_fam_insts new_iface
 511                , mi_decls  = [(initialVersion, decl) | decl <- new_decls]
 512                , mi_ver_fn = mkIfaceVerCache (zip (repeat initialVersion)
 513                                                   new_decls)
 514                },
 515      False,
 516      ptext SLIT("No old interface file"),
 517      pprOrphans orph_insts orph_rules)
 518   where
 519     orph_insts = filter (isNothing . ifInstOrph) (mi_insts new_iface)
 520     orph_rules = filter (isNothing . ifRuleOrph) (mi_rules new_iface)
 521
 522 addVersionInfo ver_fn (Just old_iface@(ModIface {
 523                                            mi_mod_vers  = old_mod_vers,
 524                                            mi_exp_vers  = old_exp_vers,
 525                                            mi_rule_vers = old_rule_vers,
 526                                            mi_decls     = old_decls,
 527                                            mi_ver_fn    = old_decl_vers,
 528                                            mi_fix_fn    = old_fixities }))
 529                new_iface@(ModIface { mi_fix_fn = new_fixities })
 530                new_decls
 531  | no_change_at_all
 532  = (old_iface,  True,   ptext SLIT("Interface file unchanged"), pp_orphs)
 533  | otherwise
 534  = (final_iface, False, vcat [ptext SLIT("Interface file has changed"),
 535                               nest 2 pp_diffs], pp_orphs)
 536  where
 537     final_iface = new_iface {
 538                 mi_mod_vers  = bump_unless no_output_change old_mod_vers,
 539                 mi_exp_vers  = bump_unless no_export_change old_exp_vers,
 540                 mi_rule_vers = bump_unless no_rule_change   old_rule_vers,
 541                 mi_orphan    = not (null new_orph_rules && null new_orph_insts),
 542                 mi_finsts    = not . null $ mi_fam_insts new_iface,
 543                 mi_decls     = decls_w_vers,
 544                 mi_ver_fn    = mkIfaceVerCache decls_w_vers }
 545
 546     decls_w_vers = [(add_vers decl, decl) | decl <- new_decls]
 547
 548     -------------------
 549     (old_non_orph_insts, old_orph_insts) =
 550         mkOrphMap ifInstOrph (mi_insts old_iface)
 551     (new_non_orph_insts, new_orph_insts) =
 552         mkOrphMap ifInstOrph (mi_insts new_iface)
 553     old_fam_insts = mi_fam_insts old_iface
 554     new_fam_insts = mi_fam_insts new_iface
 555     same_insts occ = eqMaybeBy  (eqListBy eqIfInst)
 556                                 (lookupOccEnv old_non_orph_insts occ)
 557                                 (lookupOccEnv new_non_orph_insts occ)
 558
 559     (old_non_orph_rules, old_orph_rules) =
 560         mkOrphMap ifRuleOrph (mi_rules old_iface)
 561     (new_non_orph_rules, new_orph_rules) =
 562         mkOrphMap ifRuleOrph (mi_rules new_iface)
 563     same_rules occ = eqMaybeBy  (eqListBy eqIfRule)
 564                                 (lookupOccEnv old_non_orph_rules occ)
 565                                 (lookupOccEnv new_non_orph_rules occ)
 566     -------------------
 567     -- Computing what changed
 568     no_output_change = no_decl_change   && no_rule_change &&
 569                        no_export_change && no_deprec_change
 570     no_export_change = mi_exports new_iface == mi_exports old_iface
 571                                 -- Kept sorted
 572     no_decl_change   = isEmptyOccSet changed_occs
 573     no_rule_change   = not (changedWrtNames changed_occs (eqListBy eqIfRule old_orph_rules new_orph_rules)
 574                          || changedWrtNames changed_occs (eqListBy eqIfInst old_orph_insts new_orph_insts)
 575                          || changedWrtNames changed_occs (eqListBy eqIfFamInst old_fam_insts new_fam_insts))
 576     no_deprec_change = mi_deprecs new_iface == mi_deprecs old_iface
 577
 578         -- If the usages havn't changed either, we don't need to write the interface file
 579     no_other_changes = mi_usages new_iface == mi_usages old_iface &&
 580                        mi_deps new_iface == mi_deps old_iface &&
 581                        mi_hpc new_iface == mi_hpc old_iface
 582     no_change_at_all = no_output_change && no_other_changes
 583
 584     pp_diffs = vcat [pp_change no_export_change "Export list"
 585                         (ppr old_exp_vers <+> arrow <+> ppr (mi_exp_vers final_iface)),
 586                      pp_change no_rule_change "Rules"
 587                         (ppr old_rule_vers <+> arrow <+> ppr (mi_rule_vers final_iface)),
 588                      pp_change no_deprec_change "Deprecations" empty,
 589                      pp_change no_other_changes  "Usages" empty,
 590                      pp_decl_diffs]
 591     pp_change True  what info = empty
 592     pp_change False what info = text what <+> ptext SLIT("changed") <+> info
 593
 594     -------------------
 595     old_decl_env = mkOccEnv [(ifName decl, decl) | (_,decl) <- old_decls]
 596     same_fixity n = bool (old_fixities n == new_fixities n)
 597
 598     -------------------
 599     -- Adding version info
 600     new_version = bumpVersion old_mod_vers
 601                         -- Start from the old module version, not from
 602                         -- zero so that if you remove f, and then add
 603                         -- it again, you don't thereby reduce f's
 604                         -- version number
 605
 606     add_vers decl | occ `elemOccSet` changed_occs = new_version
 607                   | otherwise = snd (expectJust "add_vers" (old_decl_vers occ))
 608                                 -- If it's unchanged, there jolly well
 609                   where         -- should be an old version number
 610                     occ = ifName decl
 611
 612     -------------------
 613     -- Deciding which declarations have changed
 614
 615     -- For each local decl, the IfaceEq gives the list of things that
 616     -- must be unchanged for the declaration as a whole to be unchanged.
 617     eq_info :: [(OccName, IfaceEq)]
 618     eq_info = map check_eq new_decls
 619     check_eq new_decl
 620          | Just old_decl <- lookupOccEnv old_decl_env occ
 621          = (occ, new_decl `eqIfDecl` old_decl &&& eq_indirects new_decl)
 622          | otherwise {- No corresponding old decl -}
 623          = (occ, NotEqual)
 624         where
 625           occ = ifName new_decl
 626
 627     eq_indirects :: IfaceDecl -> IfaceEq
 628                 -- When seeing if two decls are the same, remember to
 629                 -- check whether any relevant fixity or rules have changed
 630     eq_indirects (IfaceId {ifName = occ}) = eq_ind_occ occ
 631     eq_indirects (IfaceClass {ifName = cls_occ, ifSigs = sigs})
 632         = same_insts cls_occ &&&
 633           eq_ind_occs [op | IfaceClassOp op _ _ <- sigs]
 634     eq_indirects (IfaceData {ifName = tc_occ, ifCons = cons})
 635         = same_insts tc_occ &&& same_fixity tc_occ &&&  -- The TyCon can have a fixity too
 636           eq_ind_occs (map ifConOcc (visibleIfConDecls cons))
 637     eq_indirects other = Equal  -- Synonyms and foreign declarations
 638
 639     eq_ind_occ :: OccName -> IfaceEq    -- For class ops and Ids; check fixity and rules
 640     eq_ind_occ occ = same_fixity occ &&& same_rules occ
 641     eq_ind_occs = foldr ((&&&) . eq_ind_occ) Equal
 642
 643     -- The Occs of declarations that changed.
 644     changed_occs :: OccSet
 645     changed_occs = computeChangedOccs ver_fn (mi_module new_iface)
 646                          (mi_usages old_iface) eq_info
 647
 648     -------------------
 649     -- Diffs
 650     pp_decl_diffs :: SDoc       -- Nothing => no changes
 651     pp_decl_diffs
 652         | isEmptyOccSet changed_occs = empty
 653         | otherwise
 654         = vcat [ptext SLIT("Changed occs:") <+> ppr (occSetElts changed_occs),
 655                 ptext SLIT("Version change for these decls:"),
 656                 nest 2 (vcat (map show_change new_decls))]
 657
 658     eq_env = mkOccEnv eq_info
 659     show_change new_decl
 660         | not (occ `elemOccSet` changed_occs) = empty
 661         | otherwise
 662         = vcat [ppr occ <+> ppr (old_decl_vers occ) <+> arrow <+> ppr new_version,
 663                 nest 2 why]
 664         where
 665           occ = ifName new_decl
 666           why = case lookupOccEnv eq_env occ of
 667                     Just (EqBut names) -> sep [ppr occ <> colon, ptext SLIT("Free vars (only) changed:") <> ppr names,
 668                                               nest 2 (braces (fsep (map ppr (occSetElts
 669                                                 (occs `intersectOccSet` changed_occs)))))]
 670                            where occs = mkOccSet (map nameOccName (nameSetToList names))
 671                     Just NotEqual
 672                         | Just old_decl <- lookupOccEnv old_decl_env occ
 673                         -> vcat [ptext SLIT("Old:") <+> ppr old_decl,
 674                          ptext SLIT("New:") <+> ppr new_decl]
 675                         | otherwise
 676                         -> ppr occ <+> ptext SLIT("only in new interface")
 677                     other -> pprPanic "MkIface.show_change" (ppr occ)
 678
 679     pp_orphs = pprOrphans new_orph_insts new_orph_rules
 680
 681
 682 pprOrphans insts rules
 683   | null insts && null rules = Nothing
 684   | otherwise
 685   = Just $ vcat [
 686         if null insts then empty else
 687              hang (ptext SLIT("Warning: orphan instances:"))
 688                 2 (vcat (map ppr insts)),
 689         if null rules then empty else
 690              hang (ptext SLIT("Warning: orphan rules:"))
 691                 2 (vcat (map ppr rules))
 692     ]
 693
 694 computeChangedOccs
 695         :: (Name -> (OccName,Version))     -- get parents and versions
 696         -> Module                       -- This module
 697         -> [Usage]                      -- Usages from old iface
 698         -> [(OccName, IfaceEq)]         -- decl names, equality conditions
 699         -> OccSet                       -- set of things that have changed
 700 computeChangedOccs ver_fn this_module old_usages eq_info
 701   = foldl add_changes emptyOccSet (stronglyConnComp edges)
 702   where
 703
 704     -- return True if an external name has changed
 705     name_changed :: Name -> Bool
 706     name_changed nm
 707         | Just ents <- lookupUFM usg_modmap (moduleName mod),
 708           Just v    <- lookupUFM ents parent_occ
 709         = v < new_version
 710         | modulePackageId mod == this_pkg
 711         = WARN(True, ptext SLIT("computeChangedOccs") <+> ppr nm) True
 712         -- should really be a panic, see #1959.  The problem is that the usages doesn't
 713         -- contain all the names that might be referred to by unfoldings.  So as a
 714         -- conservative workaround we just assume these names have changed.
 715         | otherwise = False -- must be in another package
 716       where
 717          mod = nameModule nm
 718          (parent_occ, new_version) = ver_fn nm
 719
 720     this_pkg = modulePackageId this_module
 721
 722     -- Turn the usages from the old ModIface into a mapping
 723     usg_modmap = listToUFM [ (usg_name usg, listToUFM (usg_entities usg))
 724                            | usg <- old_usages ]
 725
 726     get_local_eq_info :: GenIfaceEq NameSet -> GenIfaceEq OccSet
 727     get_local_eq_info Equal = Equal
 728     get_local_eq_info NotEqual = NotEqual
 729     get_local_eq_info (EqBut ns) = foldNameSet f Equal ns
 730         where f name eq | nameModule name == this_module =
 731                           EqBut (unitOccSet (nameOccName name)) `and_occifeq` eq
 732                         | name_changed name = NotEqual
 733                         | otherwise = eq
 734
 735     local_eq_infos = mapSnd get_local_eq_info eq_info
 736
 737     edges :: [((OccName, OccIfaceEq), Unique, [Unique])]
 738     edges = [ (node, getUnique occ, map getUnique occs)
 739             | node@(occ, iface_eq) <- local_eq_infos
 740             , let occs = case iface_eq of
 741                            EqBut occ_set -> occSetElts occ_set
 742                            other -> [] ]
 743
 744     -- Changes in declarations
 745     add_changes :: OccSet -> SCC (OccName, OccIfaceEq) -> OccSet
 746     add_changes so_far (AcyclicSCC (occ, iface_eq))
 747         | changedWrt so_far iface_eq -- This one has changed
 748         = extendOccSet so_far occ
 749     add_changes so_far (CyclicSCC pairs)
 750         | changedWrt so_far (foldr1 and_occifeq iface_eqs)
 751                 -- One of this group has changed
 752         = extendOccSetList so_far occs
 753         where (occs, iface_eqs) = unzip pairs
 754     add_changes so_far other = so_far
 755
 756 type OccIfaceEq = GenIfaceEq OccSet
 757
 758 instance Outputable OccIfaceEq where
 759   ppr Equal          = ptext SLIT("Equal")
 760   ppr NotEqual       = ptext SLIT("NotEqual")
 761   ppr (EqBut occset) = ptext SLIT("EqBut") <+> ppr (occSetElts occset)
 762
 763 changedWrt :: OccSet -> OccIfaceEq -> Bool
 764 changedWrt so_far Equal        = False
 765 changedWrt so_far NotEqual     = True
 766 changedWrt so_far (EqBut kids) = so_far `intersectsOccSet` kids
 767
 768 changedWrtNames :: OccSet -> IfaceEq -> Bool
 769 changedWrtNames so_far Equal        = False
 770 changedWrtNames so_far NotEqual     = True
 771 changedWrtNames so_far (EqBut kids) =
 772   so_far `intersectsOccSet` mkOccSet (map nameOccName (nameSetToList kids))
 773
 774 and_occifeq :: OccIfaceEq -> OccIfaceEq -> OccIfaceEq
 775 Equal       `and_occifeq` x         = x
 776 NotEqual    `and_occifeq` x         = NotEqual
 777 EqBut nms   `and_occifeq` Equal       = EqBut nms
 778 EqBut nms   `and_occifeq` NotEqual    = NotEqual
 779 EqBut nms1  `and_occifeq` EqBut nms2  = EqBut (nms1 `unionOccSets` nms2)
 780
 781 ----------------------
 782 -- mkOrphMap partitions instance decls or rules into
 783 --      (a) an OccEnv for ones that are not orphans,
 784 --          mapping the local OccName to a list of its decls
 785 --      (b) a list of orphan decls
 786 mkOrphMap :: (decl -> Maybe OccName)    -- (Just occ) for a non-orphan decl, keyed by occ
 787                                         -- Nothing for an orphan decl
 788           -> [decl]                     -- Sorted into canonical order
 789           -> (OccEnv [decl],            -- Non-orphan decls associated with their key;
 790                                         --      each sublist in canonical order
 791               [decl])                   -- Orphan decls; in canonical order
 792 mkOrphMap get_key decls
 793   = foldl go (emptyOccEnv, []) decls
 794   where
 795     go (non_orphs, orphs) d
 796         | Just occ <- get_key d
 797         = (extendOccEnv_C (\ ds _ -> d:ds) non_orphs occ [d], orphs)
 798         | otherwise = (non_orphs, d:orphs)
 799
 800 ----------------------
 801 bump_unless :: Bool -> Version -> Version
 802 bump_unless True  v = v -- True <=> no change
 803 bump_unless False v = bumpVersion v
 804 \end{code}
 805
 806
 807 %*********************************************************
 808 %*                                                      *
 809 \subsection{Keeping track of what we've slurped, and version numbers}
 810 %*                                                      *
 811 %*********************************************************
 812
 813
 814 \begin{code}
 815 mkUsageInfo :: HscEnv
 816             -> ModuleEnv (Module, [(ModuleName, Bool, SrcSpan)])
 817             -> [(ModuleName, IsBootInterface)]
 818             -> NameSet -> IO [Usage]
 819 mkUsageInfo hsc_env dir_imp_mods dep_mods used_names
 820   = do  { eps <- hscEPS hsc_env
 821         ; let usages = mk_usage_info (eps_PIT eps) hsc_env
 822                                      dir_imp_mods dep_mods used_names
 823         ; usages `seqList`  return usages }
 824          -- seq the list of Usages returned: occasionally these
 825          -- don't get evaluated for a while and we can end up hanging on to
 826          -- the entire collection of Ifaces.
 827
 828 mk_usage_info :: PackageIfaceTable
 829               -> HscEnv
 830               -> ModuleEnv (Module, [(ModuleName, Bool, SrcSpan)])
 831               -> [(ModuleName, IsBootInterface)]
 832               -> NameSet
 833               -> [Usage]
 834 mk_usage_info pit hsc_env dir_imp_mods dep_mods used_names
 835   = mapCatMaybes mkUsage dep_mods
 836         -- ToDo: do we need to sort into canonical order?
 837   where
 838     hpt = hsc_HPT hsc_env
 839     dflags = hsc_dflags hsc_env
 840
 841     -- ent_map groups together all the things imported and used
 842     -- from a particular module in this package
 843     ent_map :: ModuleEnv [OccName]
 844     ent_map  = foldNameSet add_mv emptyModuleEnv used_names
 845     add_mv name mv_map
 846         | isWiredInName name = mv_map  -- ignore wired-in names
 847         | otherwise
 848         = case nameModule_maybe name of
 849              Nothing  -> mv_map         -- ignore internal names
 850              Just mod -> extendModuleEnv_C add_item mv_map mod [occ]
 851                    where
 852                      occ = nameOccName name
 853                      add_item occs _ = occ:occs
 854
 855     depend_on_exports mod = case lookupModuleEnv dir_imp_mods mod of
 856                                 Just (_, xs) -> any (\(_, no_imp, _) -> not no_imp) xs
 857                                 Nothing          -> True
 858
 859     -- We want to create a Usage for a home module if
 860     --  a) we used something from; has something in used_names
 861     --  b) we imported all of it, even if we used nothing from it
 862     --          (need to recompile if its export list changes: export_vers)
 863     --  c) is a home-package orphan or family-instance module (need to
 864     --          recompile if its instance decls change: rules_vers)
 865     mkUsage :: (ModuleName, IsBootInterface) -> Maybe Usage
 866     mkUsage (mod_name, _)
 867       |  isNothing maybe_iface          -- We can't depend on it if we didn't
 868       || (null used_occs                -- load its interface.
 869           && isNothing export_vers
 870           && not orphan_mod
 871           && not finsts_mod)
 872       = Nothing                 -- Record no usage info
 873
 874       | otherwise
 875       = Just (Usage { usg_name     = mod_name,
 876                       usg_mod      = mod_vers,
 877                       usg_exports  = export_vers,
 878                       usg_entities = fmToList ent_vers,
 879                       usg_rules    = rules_vers })
 880       where
 881         maybe_iface  = lookupIfaceByModule dflags hpt pit mod
 882                 -- In one-shot mode, the interfaces for home-package
 883                 -- modules accumulate in the PIT not HPT.  Sigh.
 884
 885         mod = mkModule (thisPackage dflags) mod_name
 886
 887         Just iface   = maybe_iface
 888         orphan_mod   = mi_orphan    iface
 889         finsts_mod   = mi_finsts    iface
 890         version_env  = mi_ver_fn    iface
 891         mod_vers     = mi_mod_vers  iface
 892         rules_vers   = mi_rule_vers iface
 893         export_vers | depend_on_exports mod = Just (mi_exp_vers iface)
 894                     | otherwise             = Nothing
 895
 896         used_occs = lookupModuleEnv ent_map mod `orElse` []
 897
 898         -- Making a FiniteMap here ensures that (a) we remove duplicates
 899         -- when we have usages on several subordinates of a single parent,
 900         -- and (b) that the usages emerge in a canonical order, which
 901         -- is why we use FiniteMap rather than OccEnv: FiniteMap works
 902         -- using Ord on the OccNames, which is a lexicographic ordering.
 903         ent_vers :: FiniteMap OccName Version
 904         ent_vers = listToFM (map lookup_occ used_occs)
 905
 906         lookup_occ occ =
 907             case version_env occ of
 908                 Nothing -> pprTrace "hmm, strange" (ppr mod <+> ppr occ) $
 909                            (occ, initialVersion) -- does this ever happen?
 910                 Just (parent, version) -> (parent, version)
 911 \end{code}
 912
 913 \begin{code}
 914 mkIfaceExports :: [AvailInfo]
 915                -> [(Module, [GenAvailInfo OccName])]
 916   -- Group by module and sort by occurrence
 917   -- This keeps the list in canonical order
 918 mkIfaceExports exports
 919   = [ (mod, eltsFM avails)
 920     | (mod, avails) <- fmToList groupFM
 921     ]
 922   where
 923         -- Group by the module where the exported entities are defined
 924         -- (which may not be the same for all Names in an Avail)
 925         -- Deliberately use FiniteMap rather than UniqFM so we
 926         -- get a canonical ordering
 927     groupFM :: ModuleEnv (FiniteMap FastString (GenAvailInfo OccName))
 928     groupFM = foldl add emptyModuleEnv exports
 929
 930     add_one :: ModuleEnv (FiniteMap FastString (GenAvailInfo OccName))
 931             -> Module -> GenAvailInfo OccName
 932             -> ModuleEnv (FiniteMap FastString (GenAvailInfo OccName))
 933     add_one env mod avail
 934       =  extendModuleEnv_C plusFM env mod
 935                 (unitFM (occNameFS (availName avail)) avail)
 936
 937         -- NB: we should not get T(X) and T(Y) in the export list
 938         --     else the plusFM will simply discard one!  They
 939         --     should have been combined by now.
 940     add env (Avail n)
 941       = add_one env (nameModule n) (Avail (nameOccName n))
 942
 943     add env (AvailTC tc ns)
 944       = foldl add_for_mod env mods
 945       where
 946         tc_occ = nameOccName tc
 947         mods   = nub (map nameModule ns)
 948                 -- Usually just one, but see Note [Original module]
 949
 950         add_for_mod env mod
 951             = add_one env mod (AvailTC tc_occ (sort names_from_mod))
 952               -- NB. sort the children, we need a canonical order
 953             where
 954               names_from_mod = [nameOccName n | n <- ns, nameModule n == mod]
 955 \end{code}
 956
 957 Note [Orignal module]
 958 ~~~~~~~~~~~~~~~~~~~~~
 959 Consider this:
 960         module X where { data family T }
 961         module Y( T(..) ) where { import X; data instance T Int = MkT Int }
 962 The exported Avail from Y will look like
 963         X.T{X.T, Y.MkT}
 964 That is, in Y,
 965   - only MkT is brought into scope by the data instance;
 966   - but the parent (used for grouping and naming in T(..) exports) is X.T
 967   - and in this case we export X.T too
 968
 969 In the result of MkIfaceExports, the names are grouped by defining module,
 970 so we may need to split up a single Avail into multiple ones.
 971
 972
 973 %************************************************************************
 974 %*                                                                      *
 975         Load the old interface file for this module (unless
 976         we have it aleady), and check whether it is up to date
 977
 978 %*                                                                      *
 979 %************************************************************************
 980
 981 \begin{code}
 982 checkOldIface :: HscEnv
 983               -> ModSummary
 984               -> Bool                   -- Source unchanged
 985               -> Maybe ModIface         -- Old interface from compilation manager, if any
 986               -> IO (RecompileRequired, Maybe ModIface)
 987
 988 checkOldIface hsc_env mod_summary source_unchanged maybe_iface
 989   = do  { showPass (hsc_dflags hsc_env)
 990                    ("Checking old interface for " ++
 991                         showSDoc (ppr (ms_mod mod_summary))) ;
 992
 993         ; initIfaceCheck hsc_env $
 994           check_old_iface hsc_env mod_summary source_unchanged maybe_iface
 995      }
 996
 997 check_old_iface hsc_env mod_summary source_unchanged maybe_iface
 998  =  do  -- CHECK WHETHER THE SOURCE HAS CHANGED
 999     { ifM (not source_unchanged)
1000            (traceHiDiffs (nest 4 (text "Source file changed or recompilation check turned off")))
1001
1002      -- If the source has changed and we're in interactive mode, avoid reading
1003      -- an interface; just return the one we might have been supplied with.
1004     ; let dflags = hsc_dflags hsc_env
1005     ; if not (isObjectTarget (hscTarget dflags)) && not source_unchanged then
1006          return (outOfDate, maybe_iface)
1007       else
1008       case maybe_iface of {
1009         Just old_iface -> do -- Use the one we already have
1010           { traceIf (text "We already have the old interface for" <+> ppr (ms_mod mod_summary))
1011           ; recomp <- checkVersions hsc_env source_unchanged mod_summary old_iface
1012           ; return (recomp, Just old_iface) }
1013
1014       ; Nothing -> do
1015
1016         -- Try and read the old interface for the current module
1017         -- from the .hi file left from the last time we compiled it
1018     { let iface_path = msHiFilePath mod_summary
1019     ; read_result <- readIface (ms_mod mod_summary) iface_path False
1020     ; case read_result of {
1021          Failed err -> do       -- Old interface file not found, or garbled; give up
1022                 { traceIf (text "FYI: cannot read old interface file:"
1023                                  $$ nest 4 err)
1024                 ; return (outOfDate, Nothing) }
1025
1026       ;  Succeeded iface -> do
1027
1028         -- We have got the old iface; check its versions
1029     { traceIf (text "Read the interface file" <+> text iface_path)
1030     ; recomp <- checkVersions hsc_env source_unchanged mod_summary iface
1031     ; returnM (recomp, Just iface)
1032     }}}}}
1033
1034 \end{code}
1035
1036 @recompileRequired@ is called from the HscMain.   It checks whether
1037 a recompilation is required.  It needs access to the persistent state,
1038 finder, etc, because it may have to load lots of interface files to
1039 check their versions.
1040
1041 \begin{code}
1042 type RecompileRequired = Bool
1043 upToDate  = False       -- Recompile not required
1044 outOfDate = True        -- Recompile required
1045
1046 checkVersions :: HscEnv
1047               -> Bool           -- True <=> source unchanged
1048               -> ModSummary
1049               -> ModIface       -- Old interface
1050               -> IfG RecompileRequired
1051 checkVersions hsc_env source_unchanged mod_summary iface
1052   | not source_unchanged
1053   = returnM outOfDate
1054   | otherwise
1055   = do  { traceHiDiffs (text "Considering whether compilation is required for" <+>
1056                         ppr (mi_module iface) <> colon)
1057
1058         ; recomp <- checkDependencies hsc_env mod_summary iface
1059         ; if recomp then return outOfDate else do {
1060
1061         -- Source code unchanged and no errors yet... carry on
1062
1063         -- First put the dependent-module info, read from the old interface, into the envt,
1064         -- so that when we look for interfaces we look for the right one (.hi or .hi-boot)
1065         --
1066         -- It's just temporary because either the usage check will succeed
1067         -- (in which case we are done with this module) or it'll fail (in which
1068         -- case we'll compile the module from scratch anyhow).
1069         --
1070         -- We do this regardless of compilation mode, although in --make mode
1071         -- all the dependent modules should be in the HPT already, so it's
1072         -- quite redundant
1073           updateEps_ $ \eps  -> eps { eps_is_boot = mod_deps }
1074
1075         ; let this_pkg = thisPackage (hsc_dflags hsc_env)
1076         ; checkList [checkModUsage this_pkg u | u <- mi_usages iface]
1077     }}
1078   where
1079         -- This is a bit of a hack really
1080     mod_deps :: ModuleNameEnv (ModuleName, IsBootInterface)
1081     mod_deps = mkModDeps (dep_mods (mi_deps iface))
1082
1083
1084 -- If the direct imports of this module are resolved to targets that
1085 -- are not among the dependencies of the previous interface file,
1086 -- then we definitely need to recompile.  This catches cases like
1087 --   - an exposed package has been upgraded
1088 --   - we are compiling with different package flags
1089 --   - a home module that was shadowing a package module has been removed
1090 --   - a new home module has been added that shadows a package module
1091 -- See bug #1372.
1092 --
1093 -- Returns True if recompilation is required.
1094 checkDependencies :: HscEnv -> ModSummary -> ModIface -> IfG RecompileRequired
1095 checkDependencies hsc_env summary iface
1096  = orM (map dep_missing (ms_imps summary ++ ms_srcimps summary))
1097   where
1098    prev_dep_mods = dep_mods (mi_deps iface)
1099    prev_dep_pkgs = dep_pkgs (mi_deps iface)
1100
1101    this_pkg = thisPackage (hsc_dflags hsc_env)
1102
1103    orM = foldr f (return False)
1104     where f m rest = do b <- m; if b then return True else rest
1105
1106    dep_missing (L _ mod) = do
1107      find_res <- ioToIOEnv $ findImportedModule hsc_env mod Nothing
1108      case find_res of
1109         Found _ mod
1110           | pkg == this_pkg
1111            -> if moduleName mod `notElem` map fst prev_dep_mods
1112                  then do traceHiDiffs $
1113                            text "imported module " <> quotes (ppr mod) <>
1114                            text " not among previous dependencies"
1115                          return outOfDate
1116                  else
1117                          return upToDate
1118           | otherwise
1119            -> if pkg `notElem` prev_dep_pkgs
1120                  then do traceHiDiffs $
1121                            text "imported module " <> quotes (ppr mod) <>
1122                            text " is from package " <> quotes (ppr pkg) <>
1123                            text ", which is not among previous dependencies"
1124                          return outOfDate
1125                  else
1126                          return upToDate
1127            where pkg = modulePackageId mod
1128         _otherwise  -> return outOfDate
1129
1130 checkModUsage :: PackageId ->Usage -> IfG RecompileRequired
1131 -- Given the usage information extracted from the old
1132 -- M.hi file for the module being compiled, figure out
1133 -- whether M needs to be recompiled.
1134
1135 checkModUsage this_pkg (Usage { usg_name = mod_name, usg_mod = old_mod_vers,
1136                                 usg_rules = old_rule_vers,
1137                                 usg_exports = maybe_old_export_vers,
1138                                 usg_entities = old_decl_vers })
1139   =     -- Load the imported interface is possible
1140     let
1141         doc_str = sep [ptext SLIT("need version info for"), ppr mod_name]
1142     in
1143     traceHiDiffs (text "Checking usages for module" <+> ppr mod_name) `thenM_`
1144
1145     let
1146         mod = mkModule this_pkg mod_name
1147     in
1148     loadInterface doc_str mod ImportBySystem            `thenM` \ mb_iface ->
1149         -- Load the interface, but don't complain on failure;
1150         -- Instead, get an Either back which we can test
1151
1152     case mb_iface of {
1153         Failed exn ->  (out_of_date (sep [ptext SLIT("Can't find version number for module"),
1154                                        ppr mod_name]));
1155                 -- Couldn't find or parse a module mentioned in the
1156                 -- old interface file.  Don't complain -- it might just be that
1157                 -- the current module doesn't need that import and it's been deleted
1158
1159         Succeeded iface ->
1160     let
1161         new_mod_vers    = mi_mod_vers  iface
1162         new_decl_vers   = mi_ver_fn    iface
1163         new_export_vers = mi_exp_vers  iface
1164         new_rule_vers   = mi_rule_vers iface
1165     in
1166         -- CHECK MODULE
1167     checkModuleVersion old_mod_vers new_mod_vers        `thenM` \ recompile ->
1168     if not recompile then
1169         returnM upToDate
1170     else
1171
1172         -- CHECK EXPORT LIST
1173     if checkExportList maybe_old_export_vers new_export_vers then
1174         out_of_date_vers (ptext SLIT("  Export list changed"))
1175                          (expectJust "checkModUsage" maybe_old_export_vers)
1176                          new_export_vers
1177     else
1178
1179         -- CHECK RULES
1180     if old_rule_vers /= new_rule_vers then
1181         out_of_date_vers (ptext SLIT("  Rules changed"))
1182                          old_rule_vers new_rule_vers
1183     else
1184
1185         -- CHECK ITEMS ONE BY ONE
1186     checkList [checkEntityUsage new_decl_vers u | u <- old_decl_vers]   `thenM` \ recompile ->
1187     if recompile then
1188         returnM outOfDate       -- This one failed, so just bail out now
1189     else
1190         up_to_date (ptext SLIT("  Great!  The bits I use are up to date"))
1191     }
1192
1193 ------------------------
1194 checkModuleVersion old_mod_vers new_mod_vers
1195   | new_mod_vers == old_mod_vers
1196   = up_to_date (ptext SLIT("Module version unchanged"))
1197
1198   | otherwise
1199   = out_of_date_vers (ptext SLIT("  Module version has changed"))
1200                      old_mod_vers new_mod_vers
1201
1202 ------------------------
1203 checkExportList Nothing  new_vers = upToDate
1204 checkExportList (Just v) new_vers = v /= new_vers
1205
1206 ------------------------
1207 checkEntityUsage new_vers (name,old_vers)
1208   = case new_vers name of
1209
1210         Nothing       ->        -- We used it before, but it ain't there now
1211                           out_of_date (sep [ptext SLIT("No longer exported:"), ppr name])
1212
1213         Just (_, new_vers)      -- It's there, but is it up to date?
1214           | new_vers == old_vers -> traceHiDiffs (text "  Up to date" <+> ppr name <+> parens (ppr new_vers)) `thenM_`
1215                                     returnM upToDate
1216           | otherwise            -> out_of_date_vers (ptext SLIT("  Out of date:") <+> ppr name)
1217                                                      old_vers new_vers
1218
1219 up_to_date  msg = traceHiDiffs msg `thenM_` returnM upToDate
1220 out_of_date msg = traceHiDiffs msg `thenM_` returnM outOfDate
1221 out_of_date_vers msg old_vers new_vers
1222   = out_of_date (hsep [msg, ppr old_vers, ptext SLIT("->"), ppr new_vers])
1223
1224 ----------------------
1225 checkList :: [IfG RecompileRequired] -> IfG RecompileRequired
1226 -- This helper is used in two places
1227 checkList []             = returnM upToDate
1228 checkList (check:checks) = check        `thenM` \ recompile ->
1229                            if recompile then
1230                                 returnM outOfDate
1231                            else
1232                                 checkList checks
1233 \end{code}
1234
1235 %************************************************************************
1236 %*                                                                      *
1237                 Converting things to their Iface equivalents
1238 %*                                                                      *
1239 %************************************************************************
1240
1241 \begin{code}
1242 tyThingToIfaceDecl :: TyThing -> IfaceDecl
1243 -- Assumption: the thing is already tidied, so that locally-bound names
1244 --             (lambdas, for-alls) already have non-clashing OccNames
1245 -- Reason: Iface stuff uses OccNames, and the conversion here does
1246 --         not do tidying on the way
1247 tyThingToIfaceDecl (AnId id)
1248   = IfaceId { ifName   = getOccName id,
1249               ifType   = toIfaceType (idType id),
1250               ifIdInfo = info }
1251   where
1252     info = case toIfaceIdInfo (idInfo id) of
1253                 []    -> NoInfo
1254                 items -> HasInfo items
1255
1256 tyThingToIfaceDecl (AClass clas)
1257   = IfaceClass { ifCtxt   = toIfaceContext sc_theta,
1258                  ifName   = getOccName clas,
1259                  ifTyVars = toIfaceTvBndrs clas_tyvars,
1260                  ifFDs    = map toIfaceFD clas_fds,
1261                  ifATs    = map (tyThingToIfaceDecl . ATyCon) clas_ats,
1262                  ifSigs   = map toIfaceClassOp op_stuff,
1263                  ifRec    = boolToRecFlag (isRecursiveTyCon tycon) }
1264   where
1265     (clas_tyvars, clas_fds, sc_theta, _, clas_ats, op_stuff)
1266       = classExtraBigSig clas
1267     tycon = classTyCon clas
1268
1269     toIfaceClassOp (sel_id, def_meth)
1270         = ASSERT(sel_tyvars == clas_tyvars)
1271           IfaceClassOp (getOccName sel_id) def_meth (toIfaceType op_ty)
1272         where
1273                 -- Be careful when splitting the type, because of things
1274                 -- like         class Foo a where
1275                 --                op :: (?x :: String) => a -> a
1276                 -- and          class Baz a where
1277                 --                op :: (Ord a) => a -> a
1278           (sel_tyvars, rho_ty) = splitForAllTys (idType sel_id)
1279           op_ty                = funResultTy rho_ty
1280
1281     toIfaceFD (tvs1, tvs2) = (map getFS tvs1, map getFS tvs2)
1282
1283 tyThingToIfaceDecl (ATyCon tycon)
1284   | isSynTyCon tycon
1285   = IfaceSyn {  ifName    = getOccName tycon,
1286                 ifTyVars  = toIfaceTvBndrs tyvars,
1287                 ifOpenSyn = syn_isOpen,
1288                 ifSynRhs  = toIfaceType syn_tyki,
1289                 ifFamInst = famInstToIface (tyConFamInst_maybe tycon)
1290              }
1291
1292   | isAlgTyCon tycon
1293   = IfaceData { ifName    = getOccName tycon,
1294                 ifTyVars  = toIfaceTvBndrs tyvars,
1295                 ifCtxt    = toIfaceContext (tyConStupidTheta tycon),
1296                 ifCons    = ifaceConDecls (algTyConRhs tycon),
1297                 ifRec     = boolToRecFlag (isRecursiveTyCon tycon),
1298                 ifGadtSyntax = isGadtSyntaxTyCon tycon,
1299                 ifGeneric = tyConHasGenerics tycon,
1300                 ifFamInst = famInstToIface (tyConFamInst_maybe tycon)}
1301
1302   | isForeignTyCon tycon
1303   = IfaceForeign { ifName    = getOccName tycon,
1304                    ifExtName = tyConExtName tycon }
1305
1306   | otherwise = pprPanic "toIfaceDecl" (ppr tycon)
1307   where
1308     tyvars = tyConTyVars tycon
1309     (syn_isOpen, syn_tyki) = case synTyConRhs tycon of
1310                                OpenSynTyCon ki _ -> (True , ki)
1311                                SynonymTyCon ty   -> (False, ty)
1312
1313     ifaceConDecls (NewTyCon { data_con = con })     =
1314       IfNewTyCon  (ifaceConDecl con)
1315     ifaceConDecls (DataTyCon { data_cons = cons })  =
1316       IfDataTyCon (map ifaceConDecl cons)
1317     ifaceConDecls OpenTyCon {}                      = IfOpenDataTyCon
1318     ifaceConDecls AbstractTyCon                     = IfAbstractTyCon
1319         -- The last case happens when a TyCon has been trimmed during tidying
1320         -- Furthermore, tyThingToIfaceDecl is also used
1321         -- in TcRnDriver for GHCi, when browsing a module, in which case the
1322         -- AbstractTyCon case is perfectly sensible.
1323
1324     ifaceConDecl data_con
1325         = IfCon   { ifConOcc     = getOccName (dataConName data_con),
1326                     ifConInfix   = dataConIsInfix data_con,
1327                     ifConUnivTvs = toIfaceTvBndrs (dataConUnivTyVars data_con),
1328                     ifConExTvs   = toIfaceTvBndrs (dataConExTyVars data_con),
1329                     ifConEqSpec  = to_eq_spec (dataConEqSpec data_con),
1330                     ifConCtxt    = toIfaceContext (dataConEqTheta data_con ++ dataConDictTheta data_con),
1331                     ifConArgTys  = map toIfaceType (dataConOrigArgTys data_con),
1332                     ifConFields  = map getOccName
1333                                        (dataConFieldLabels data_con),
1334                     ifConStricts = dataConStrictMarks data_con }
1335
1336     to_eq_spec spec = [(getOccName tv, toIfaceType ty) | (tv,ty) <- spec]
1337
1338     famInstToIface Nothing                    = Nothing
1339     famInstToIface (Just (famTyCon, instTys)) =
1340       Just (toIfaceTyCon famTyCon, map toIfaceType instTys)
1341
1342 tyThingToIfaceDecl (ADataCon dc)
1343  = pprPanic "toIfaceDecl" (ppr dc)      -- Should be trimmed out earlier
1344
1345
1346 getFS x = occNameFS (getOccName x)
1347
1348 --------------------------
1349 instanceToIfaceInst :: Instance -> IfaceInst
1350 instanceToIfaceInst ispec@(Instance { is_dfun = dfun_id, is_flag = oflag,
1351                                       is_cls = cls_name, is_tcs = mb_tcs })
1352   = ASSERT( cls_name == className cls )
1353     IfaceInst { ifDFun    = dfun_name,
1354                 ifOFlag   = oflag,
1355                 ifInstCls = cls_name,
1356                 ifInstTys = map do_rough mb_tcs,
1357                 ifInstOrph = orph }
1358   where
1359     do_rough Nothing  = Nothing
1360     do_rough (Just n) = Just (toIfaceTyCon_name n)
1361
1362     dfun_name = idName dfun_id
1363     mod       = nameModule dfun_name
1364     is_local name = nameIsLocalOrFrom mod name
1365
1366         -- Compute orphanhood.  See Note [Orphans] in IfaceSyn
1367     (_, _, cls, tys) = tcSplitDFunTy (idType dfun_id)
1368                 -- Slightly awkward: we need the Class to get the fundeps
1369     (tvs, fds) = classTvsFds cls
1370     arg_names = [filterNameSet is_local (tyClsNamesOfType ty) | ty <- tys]
1371     orph | is_local cls_name = Just (nameOccName cls_name)
1372          | all isJust mb_ns  = head mb_ns
1373          | otherwise         = Nothing
1374
1375     mb_ns :: [Maybe OccName]    -- One for each fundep; a locally-defined name
1376                                 -- that is not in the "determined" arguments
1377     mb_ns | null fds   = [choose_one arg_names]
1378           | otherwise  = map do_one fds
1379     do_one (ltvs,rtvs) = choose_one [ns | (tv,ns) <- tvs `zip` arg_names
1380                                         , not (tv `elem` rtvs)]
1381
1382     choose_one :: [NameSet] -> Maybe OccName
1383     choose_one nss = case nameSetToList (unionManyNameSets nss) of
1384                         []     -> Nothing
1385                         (n:ns) -> Just (nameOccName n)
1386
1387 --------------------------
1388 famInstToIfaceFamInst :: FamInst -> IfaceFamInst
1389 famInstToIfaceFamInst fi@(FamInst { fi_tycon = tycon,
1390                                             fi_fam = fam, fi_tcs = mb_tcs })
1391   = IfaceFamInst { ifFamInstTyCon  = toIfaceTyCon tycon
1392                  , ifFamInstFam    = fam
1393                  , ifFamInstTys    = map do_rough mb_tcs }
1394   where
1395     do_rough Nothing  = Nothing
1396     do_rough (Just n) = Just (toIfaceTyCon_name n)
1397
1398 --------------------------
1399 toIfaceLetBndr id  = IfLetBndr (occNameFS (getOccName id))
1400                                (toIfaceType (idType id))
1401                                prag_info
1402   where
1403         -- Stripped-down version of tcIfaceIdInfo
1404         -- Change this if you want to export more IdInfo for
1405         -- non-top-level Ids.  Don't forget to change
1406         -- CoreTidy.tidyLetBndr too!
1407         --
1408         -- See Note [IdInfo on nested let-bindings] in IfaceSyn
1409     id_info = idInfo id
1410     inline_prag = inlinePragInfo id_info
1411     prag_info | isAlwaysActive inline_prag = NoInfo
1412               | otherwise                  = HasInfo [HsInline inline_prag]
1413
1414 --------------------------
1415 toIfaceIdInfo :: IdInfo -> [IfaceInfoItem]
1416 toIfaceIdInfo id_info
1417   = catMaybes [arity_hsinfo, caf_hsinfo, strict_hsinfo,
1418                inline_hsinfo, wrkr_hsinfo,  unfold_hsinfo]
1419   where
1420     ------------  Arity  --------------
1421     arity_info = arityInfo id_info
1422     arity_hsinfo | arity_info == 0 = Nothing
1423                  | otherwise       = Just (HsArity arity_info)
1424
1425     ------------ Caf Info --------------
1426     caf_info   = cafInfo id_info
1427     caf_hsinfo = case caf_info of
1428                    NoCafRefs -> Just HsNoCafRefs
1429                    _other    -> Nothing
1430
1431     ------------  Strictness  --------------
1432         -- No point in explicitly exporting TopSig
1433     strict_hsinfo = case newStrictnessInfo id_info of
1434                         Just sig | not (isTopSig sig) -> Just (HsStrictness sig)
1435                         _other                        -> Nothing
1436
1437     ------------  Worker  --------------
1438     work_info   = workerInfo id_info
1439     has_worker  = workerExists work_info
1440     wrkr_hsinfo = case work_info of
1441                     HasWorker work_id wrap_arity ->
1442                         Just (HsWorker ((idName work_id)) wrap_arity)
1443                     NoWorker -> Nothing
1444
1445     ------------  Unfolding  --------------
1446     -- The unfolding is redundant if there is a worker
1447     unfold_info  = unfoldingInfo id_info
1448     rhs          = unfoldingTemplate unfold_info
1449     no_unfolding = neverUnfold unfold_info
1450                         -- The CoreTidy phase retains unfolding info iff
1451                         -- we want to expose the unfolding, taking into account
1452                         -- unconditional NOINLINE, etc.  See TidyPgm.addExternal
1453     unfold_hsinfo | no_unfolding = Nothing
1454                   | has_worker   = Nothing      -- Unfolding is implicit
1455                   | otherwise    = Just (HsUnfold (toIfaceExpr rhs))
1456
1457     ------------  Inline prag  --------------
1458     inline_prag = inlinePragInfo id_info
1459     inline_hsinfo | isAlwaysActive inline_prag     = Nothing
1460                   | no_unfolding && not has_worker = Nothing
1461                         -- If the iface file give no unfolding info, we
1462                         -- don't need to say when inlining is OK!
1463                   | otherwise                      = Just (HsInline inline_prag)
1464
1465 --------------------------
1466 coreRuleToIfaceRule :: Module -> CoreRule -> IfaceRule
1467 coreRuleToIfaceRule mod (BuiltinRule { ru_fn = fn})
1468   = pprTrace "toHsRule: builtin" (ppr fn) $
1469     bogusIfaceRule fn
1470
1471 coreRuleToIfaceRule mod (Rule { ru_name = name, ru_fn = fn,
1472                                 ru_act = act, ru_bndrs = bndrs,
1473                                 ru_args = args, ru_rhs = rhs })
1474   = IfaceRule { ifRuleName  = name, ifActivation = act,
1475                 ifRuleBndrs = map toIfaceBndr bndrs,
1476                 ifRuleHead  = fn,
1477                 ifRuleArgs  = map do_arg args,
1478                 ifRuleRhs   = toIfaceExpr rhs,
1479                 ifRuleOrph  = orph }
1480   where
1481         -- For type args we must remove synonyms from the outermost
1482         -- level.  Reason: so that when we read it back in we'll
1483         -- construct the same ru_rough field as we have right now;
1484         -- see tcIfaceRule
1485     do_arg (Type ty) = IfaceType (toIfaceType (deNoteType ty))
1486     do_arg arg       = toIfaceExpr arg
1487
1488         -- Compute orphanhood.  See Note [Orphans] in IfaceSyn
1489         -- A rule is an orphan only if none of the variables
1490         -- mentioned on its left-hand side are locally defined
1491     lhs_names = fn : nameSetToList (exprsFreeNames args)
1492                 -- No need to delete bndrs, because
1493                 -- exprsFreeNames finds only External names
1494
1495     orph = case filter (nameIsLocalOrFrom mod) lhs_names of
1496                         (n:ns) -> Just (nameOccName n)
1497                         []     -> Nothing
1498
1499 bogusIfaceRule :: Name -> IfaceRule
1500 bogusIfaceRule id_name
1501   = IfaceRule { ifRuleName = FSLIT("bogus"), ifActivation = NeverActive,
1502         ifRuleBndrs = [], ifRuleHead = id_name, ifRuleArgs = [],
1503         ifRuleRhs = IfaceExt id_name, ifRuleOrph = Nothing }
1504
1505 ---------------------
1506 toIfaceExpr :: CoreExpr -> IfaceExpr
1507 toIfaceExpr (Var v)       = toIfaceVar v
1508 toIfaceExpr (Lit l)       = IfaceLit l
1509 toIfaceExpr (Type ty)     = IfaceType (toIfaceType ty)
1510 toIfaceExpr (Lam x b)     = IfaceLam (toIfaceBndr x) (toIfaceExpr b)
1511 toIfaceExpr (App f a)     = toIfaceApp f [a]
1512 toIfaceExpr (Case s x ty as) = IfaceCase (toIfaceExpr s) (getFS x) (toIfaceType ty) (map toIfaceAlt as)
1513 toIfaceExpr (Let b e)     = IfaceLet (toIfaceBind b) (toIfaceExpr e)
1514 toIfaceExpr (Cast e co)   = IfaceCast (toIfaceExpr e) (toIfaceType co)
1515 toIfaceExpr (Note n e)    = IfaceNote (toIfaceNote n) (toIfaceExpr e)
1516
1517 ---------------------
1518 toIfaceNote (SCC cc)      = IfaceSCC cc
1519 toIfaceNote InlineMe      = IfaceInlineMe
1520 toIfaceNote (CoreNote s)  = IfaceCoreNote s
1521
1522 ---------------------
1523 toIfaceBind (NonRec b r) = IfaceNonRec (toIfaceLetBndr b) (toIfaceExpr r)
1524 toIfaceBind (Rec prs)    = IfaceRec [(toIfaceLetBndr b, toIfaceExpr r) | (b,r) <- prs]
1525
1526 ---------------------
1527 toIfaceAlt (c,bs,r) = (toIfaceCon c, map getFS bs, toIfaceExpr r)
1528
1529 ---------------------
1530 toIfaceCon (DataAlt dc) | isTupleTyCon tc = IfaceTupleAlt (tupleTyConBoxity tc)
1531                         | otherwise       = IfaceDataAlt (getName dc)
1532                         where
1533                           tc = dataConTyCon dc
1534
1535 toIfaceCon (LitAlt l) = IfaceLitAlt l
1536 toIfaceCon DEFAULT    = IfaceDefault
1537
1538 ---------------------
1539 toIfaceApp (App f a) as = toIfaceApp f (a:as)
1540 toIfaceApp (Var v) as
1541   = case isDataConWorkId_maybe v of
1542         -- We convert the *worker* for tuples into IfaceTuples
1543         Just dc |  isTupleTyCon tc && saturated
1544                 -> IfaceTuple (tupleTyConBoxity tc) tup_args
1545           where
1546             val_args  = dropWhile isTypeArg as
1547             saturated = val_args `lengthIs` idArity v
1548             tup_args  = map toIfaceExpr val_args
1549             tc        = dataConTyCon dc
1550
1551         other -> mkIfaceApps (toIfaceVar v) as
1552
1553 toIfaceApp e as = mkIfaceApps (toIfaceExpr e) as
1554
1555 mkIfaceApps f as = foldl (\f a -> IfaceApp f (toIfaceExpr a)) f as
1556
1557 ---------------------
1558 toIfaceVar :: Id -> IfaceExpr
1559 toIfaceVar v
1560   | Just fcall <- isFCallId_maybe v = IfaceFCall fcall (toIfaceType (idType v))
1561           -- Foreign calls have special syntax
1562   | isExternalName name             = IfaceExt name
1563   | Just (TickBox m ix) <- isTickBoxOp_maybe v
1564                                     = IfaceTick m ix
1565   | otherwise                       = IfaceLcl (getFS name)
1566   where
1567     name = idName v
1568 \end{code}