X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=49d428f00291284cab4f097628fa7fadb8d65c89;hb=6677029a5084f59b4cd35d76ce3f19b154f2ac87;hp=87436d3079d462c00ae3d3863ef414878f100913;hpb=4435024f2be6d7c9f0ff796db6c5c9033e6403a4;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index 87436d3..49d428f 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -1,12 +1,14 @@ % % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998 % + \section[MkIface]{Print an interface for a module} \begin{code} module MkIface ( - mkModDetails, mkModDetailsFromIface, completeIface, - writeIface, pprIface, pprUsage + showIface, mkIface, mkUsageInfo, + pprIface, + ifaceTyThing, ) where #include "HsVersions.h" @@ -14,145 +16,112 @@ module MkIface ( import HsSyn import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr ) import HsTypes ( toHsTyVars ) -import BasicTypes ( Fixity(..), NewOrData(..), - Version, initialVersion, bumpVersion, +import TysPrim ( alphaTyVars ) +import BasicTypes ( NewOrData(..), Activation(..), FixitySig(..), + Version, initialVersion, bumpVersion ) -import RnMonad +import NewDemand ( isTopSig ) +import TcRnMonad +import TcRnTypes ( ImportAvails(..) ) import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) -import TcHsSyn ( TypecheckedRuleDecl ) -import HscTypes ( VersionInfo(..), ModIface(..), ModDetails(..), +import HscTypes ( VersionInfo(..), ModIface(..), + ModGuts(..), ModGuts, + GhciMode(..), HscEnv(..), Dependencies(..), + FixityEnv, lookupFixity, collectFixities, IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts, - TyThing(..), DFunId, TypeEnv, Avails, - WhatsImported(..), GenAvailInfo(..), - ImportVersion, AvailInfo, Deprecations(..), - extendTypeEnvList, lookupVersion, + TyThing(..), DFunId, + Avails, AvailInfo, GenAvailInfo(..), availName, + ExternalPackageState(..), + ParsedIface(..), Usage(..), + Deprecations(..), initialVersionInfo, + lookupVersion, lookupIfaceByModName ) import CmdLineOpts -import Id ( idType, idInfo, isImplicitId, isDictFunId, - idSpecialisation, isLocalId, idName, hasNoBinding - ) -import Var ( isId ) -import VarSet -import DataCon ( StrictnessMark(..), dataConId, dataConSig, dataConFieldLabels, dataConStrictMarks ) +import Id ( idType, idInfo, isImplicitId, idCafInfo ) +import DataCon ( dataConName, dataConSig, dataConFieldLabels, dataConStrictMarks ) import IdInfo -- Lots -import CoreSyn ( CoreBind, CoreRule(..), IdCoreRule, - isBuiltinRule, rulesRules, - bindersOf, bindersOfBinds - ) -import CoreFVs ( ruleSomeLhsFreeVars ) +import CoreSyn ( CoreRule(..), IdCoreRule ) +import CoreFVs ( ruleLhsFreeNames ) import CoreUnfold ( neverUnfold, unfoldingTemplate ) -import Name ( getName, nameModule, Name, NamedThing(..) ) -import Name -- Env -import OccName ( pprOccName ) -import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, tyConGenIds, - tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize, isClassTyCon - ) -import Class ( classExtraBigSig, classTyCon, DefMeth(..) ) +import Name ( getName, nameModule, nameModule_maybe, nameOccName, + nameIsLocalOrFrom, Name, NamedThing(..) ) +import NameEnv +import NameSet +import OccName ( OccName, pprOccName ) +import TyCon ( DataConDetails(..), tyConTyVars, tyConDataCons, tyConTheta, + isFunTyCon, isPrimTyCon, isNewTyCon, isClassTyCon, + isSynTyCon, isAlgTyCon, isForeignTyCon, + getSynTyConDefn, tyConGenInfo, tyConDataConDetails, tyConArity ) +import Class ( classExtraBigSig, classTyCon ) import FieldLabel ( fieldLabelType ) -import Type ( splitSigmaTy, tidyTopType, deNoteType ) +import TcType ( tcSplitForAllTys, tcFunResultTy, tidyTopType, deNoteType, tyClsNamesOfDFunHead, + mkSigmaTy, mkFunTys, mkTyConApp, mkTyVarTys ) import SrcLoc ( noSrcLoc ) +import Module ( Module, ModuleName, moduleNameFS, moduleName, isHomeModule, + ModLocation(..), mkSysModuleNameFS, + ModuleEnv, emptyModuleEnv, lookupModuleEnv, + extendModuleEnv_C, moduleEnvElts + ) import Outputable -import Module ( ModuleName ) +import DriverUtil ( createDirectoryHierarchy, directoryOf ) +import Util ( sortLt, dropList, seqList ) +import Binary ( getBinFileWithDict ) +import BinIface ( writeBinIface, v_IgnoreHiVersion ) +import ErrUtils ( dumpIfSet_dyn ) +import FiniteMap +import FastString + +import DATA_IOREF ( writeIORef ) +import Monad ( when ) +import Maybe ( catMaybes, isJust, isNothing ) import Maybes ( orElse ) - -import IO ( IOMode(..), openFile, hClose ) +import IO ( putStrLn ) \end{code} %************************************************************************ %* * -\subsection{Write a new interface file} +\subsection{Print out the contents of a binary interface} %* * %************************************************************************ \begin{code} -mkModDetails :: TypeEnv -- From typechecker - -> [CoreBind] -- Final bindings - -- they have authoritative arity info - -> [IdCoreRule] -- Tidy orphan rules - -> ModDetails -mkModDetails type_env tidy_binds orphan_rules - = ModDetails { md_types = new_type_env, - md_rules = rule_dcls, - md_insts = filter isDictFunId final_ids } - where - -- The competed type environment is gotten from - -- a) keeping the types and classes - -- b) removing all Ids, - -- c) adding Ids with correct IdInfo, including unfoldings, - -- gotten from the bindings - -- From (c) we keep only those Ids with Global names; - -- the CoreTidy pass makes sure these are all and only - -- the externally-accessible ones - -- This truncates the type environment to include only the - -- exported Ids and things needed from them, which saves space - -- - -- However, we do keep things like constructors, which should not appear - -- in interface files, because they are needed by importing modules when - -- using the compilation manager - new_type_env = extendTypeEnvList (filterNameEnv keep_it type_env) - (map AnId final_ids) - - -- We keep constructor workers, because they won't appear - -- in the bindings from which final_ids are derived! - keep_it (AnId id) = hasNoBinding id - keep_it other = True - - final_ids = [id | bind <- tidy_binds - , id <- bindersOf bind - , isGlobalName (idName id)] - - -- The complete rules are gotten by combining - -- a) the orphan rules - -- b) rules embedded in the top-level Ids - rule_dcls | opt_OmitInterfacePragmas = [] - | otherwise = getRules orphan_rules tidy_binds (mkVarSet final_ids) - --- This version is used when we are re-linking a module --- so we've only run the type checker on its previous interface -mkModDetailsFromIface :: TypeEnv - -> [TypecheckedRuleDecl] - -> ModDetails -mkModDetailsFromIface type_env rules - = ModDetails { md_types = type_env, - md_rules = rule_dcls, - md_insts = dfun_ids } - where - dfun_ids = [dfun_id | AnId dfun_id <- nameEnvElts type_env, isDictFunId dfun_id] - rule_dcls = [(id,rule) | IfaceRuleOut id rule <- rules] - -- All the rules from an interface are of the IfaceRuleOut form -\end{code} - -\begin{code} -getRules :: [IdCoreRule] -- Orphan rules - -> [CoreBind] -- Bindings, with rules in the top-level Ids - -> IdSet -- Ids that are exported, so we need their rules - -> [IdCoreRule] -getRules orphan_rules binds emitted - = orphan_rules ++ local_rules - where - local_rules = [ (fn, rule) - | fn <- bindersOfBinds binds, - fn `elemVarSet` emitted, - rule <- rulesRules (idSpecialisation fn), - not (isBuiltinRule rule), - -- We can't print builtin rules in interface files - -- Since they are built in, an importing module - -- will have access to them anyway - - -- Sept 00: I've disabled this test. It doesn't stop many, if any, rules - -- from coming out, and to make it work properly we need to add ???? - -- (put it back in for now) - all (`elemVarSet` emitted) (varSetElems (ruleSomeLhsFreeVars interestingId rule)) - -- Spit out a rule only if all its lhs free vars are emitted - -- This is a good reason not to do it when we emit the Id itself - ] - -interestingId id = isId id && isLocalId id +showIface :: FilePath -> IO () +showIface filename = do + -- skip the version check; we don't want to worry about profiled vs. + -- non-profiled interfaces, for example. + writeIORef v_IgnoreHiVersion True + parsed_iface <- Binary.getBinFileWithDict filename + let ParsedIface{ + pi_mod=pi_mod, pi_pkg=pi_pkg, pi_vers=pi_vers, + pi_deps=pi_deps, + pi_orphan=pi_orphan, pi_usages=pi_usages, + pi_exports=pi_exports, pi_decls=pi_decls, + pi_fixity=pi_fixity, pi_insts=pi_insts, + pi_rules=pi_rules, pi_deprecs=pi_deprecs } = parsed_iface + putStrLn (showSDoc (vcat [ + text "__interface" <+> doubleQuotes (ppr pi_pkg) + <+> ppr pi_mod <+> ppr pi_vers + <+> (if pi_orphan then char '!' else empty) + <+> ptext SLIT("where"), + -- no instance Outputable (WhatsImported): + pprExports id (snd pi_exports), + pprDeps pi_deps, + pprUsages id pi_usages, + hsep (map ppr_fix pi_fixity) <> semi, + vcat (map ppr_inst pi_insts), + vcat (map ppr_decl pi_decls), + ppr pi_rules + -- no instance Outputable (Either): + -- ppr pi_deprecs + ])) + where + ppr_fix (FixitySig n f _) = ppr f <+> ppr n + ppr_inst i = ppr i <+> semi + ppr_decl (v,d) = int v <+> ppr d <> semi \end{code} - %************************************************************************ %* * \subsection{Completing an interface} @@ -160,30 +129,116 @@ interestingId id = isId id && isLocalId id %************************************************************************ \begin{code} -completeIface :: Maybe ModIface -- The old interface, if we have it - -> ModIface -- The new one, minus the decls and versions - -> ModDetails -- The ModDetails for this module - -> (ModIface, Maybe SDoc) -- The new one, complete with decls and versions - -- The SDoc is a debug document giving differences - -- Nothing => no change - - -- NB: 'Nothing' means that even the usages havn't changed, so there's no - -- need to write a new interface file. But even if the usages have - -- changed, the module version may not have. -completeIface maybe_old_iface new_iface mod_details - = addVersionInfo maybe_old_iface (new_iface { mi_decls = new_decls }) +mkIface :: HscEnv + -> ModLocation + -> Maybe ModIface -- The old interface, if we have it + -> ModGuts -- The compiled, tidied module + -> IO ModIface -- The new one, complete with decls and versions +-- mkFinalIface +-- a) completes the interface +-- b) writes it out to a file if necessary + +mkIface hsc_env location maybe_old_iface + impl@ModGuts{ mg_module = this_mod, + mg_usages = usages, + mg_deps = deps, + mg_exports = exports, + mg_rdr_env = rdr_env, + mg_fix_env = fix_env, + mg_deprecs = deprecs, + mg_insts = insts, + mg_rules = rules, + mg_types = types } + = do { -- Sort the exports to make them easier to compare for versions + let { my_exports = groupAvails this_mod exports ; + + iface_w_decls = ModIface { mi_module = this_mod, + mi_package = opt_InPackage, + mi_version = initialVersionInfo, + mi_deps = deps, + mi_usages = usages, + mi_exports = my_exports, + mi_decls = new_decls, + mi_orphan = orphan_mod, + mi_boot = False, + mi_fixities = fix_env, + mi_globals = Just rdr_env, + mi_deprecs = deprecs } } + + -- Add version information + ; let (final_iface, maybe_diffs) = _scc_ "versioninfo" addVersionInfo maybe_old_iface iface_w_decls + + -- Write the interface file, if necessary + ; when (must_write_hi_file maybe_diffs) $ do + createDirectoryHierarchy (directoryOf hi_file_path) + writeBinIface hi_file_path final_iface + + -- Debug printing + ; write_diffs dflags final_iface maybe_diffs + + ; orphan_mod `seq` + return final_iface } + where - new_decls = mkIfaceDecls ty_cls_dcls rule_dcls inst_dcls - inst_dcls = map ifaceInstance (md_insts mod_details) - ty_cls_dcls = foldNameEnv ifaceTyCls [] (md_types mod_details) - rule_dcls = map ifaceRule (md_rules mod_details) + dflags = hsc_dflags hsc_env + ghci_mode = hsc_mode hsc_env + + must_write_hi_file Nothing = False + must_write_hi_file (Just _diffs) = ghci_mode /= Interactive + -- We must write a new .hi file if there are some changes + -- and we're not in interactive mode + -- maybe_diffs = 'Nothing' means that even the usages havn't changed, + -- so there's no need to write a new interface file. But even if + -- the usages have changed, the module version may not have. + + hi_file_path = ml_hi_file location + new_decls = mkIfaceDecls ty_cls_dcls rule_dcls inst_dcls + inst_dcls = map ifaceInstance insts + ty_cls_dcls = foldNameEnv ifaceTyThing_acc [] types + rule_dcls = map ifaceRule rules + orphan_mod = isOrphanModule impl + +write_diffs :: DynFlags -> ModIface -> Maybe SDoc -> IO () +write_diffs dflags new_iface Nothing + = do when (dopt Opt_D_dump_hi_diffs dflags) (printDump (text "INTERFACE UNCHANGED")) + dumpIfSet_dyn dflags Opt_D_dump_hi "UNCHANGED FINAL INTERFACE" (pprIface new_iface) + +write_diffs dflags new_iface (Just sdoc_diffs) + = do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "INTERFACE HAS CHANGED" sdoc_diffs + dumpIfSet_dyn dflags Opt_D_dump_hi "NEW FINAL INTERFACE" (pprIface new_iface) \end{code} +\begin{code} +isOrphanModule :: ModGuts -> Bool +isOrphanModule (ModGuts {mg_module = this_mod, mg_insts = insts, mg_rules = rules}) + = any orphan_inst insts || any orphan_rule rules + where + -- A rule is an orphan if the LHS mentions nothing defined locally + orphan_inst dfun_id = no_locals (tyClsNamesOfDFunHead (idType dfun_id)) + -- A instance is an orphan if its head mentions nothing defined locally + orphan_rule rule = no_locals (ruleLhsFreeNames rule) + + no_locals names = isEmptyNameSet (filterNameSet (nameIsLocalOrFrom this_mod) names) +\end{code} + +Implicit Ids and class tycons aren't included in interface files, so +we miss them out of the accumulating parameter here. \begin{code} -ifaceTyCls :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] -ifaceTyCls (AClass clas) so_far - = cls_decl : so_far +ifaceTyThing_acc :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] +-- Don't put implicit things into the result +ifaceTyThing_acc (ADataCon dc) so_far = so_far +ifaceTyThing_acc (AnId id) so_far | isImplicitId id = so_far +ifaceTyThing_acc (ATyCon id) so_far | isClassTyCon id = so_far +ifaceTyThing_acc other so_far = ifaceTyThing other : so_far +\end{code} + +Convert *any* TyThing into a RenamedTyClDecl. Used both for +generating interface files and for the ':info' command in GHCi. + +\begin{code} +ifaceTyThing :: TyThing -> RenamedTyClDecl +ifaceTyThing (AClass clas) = cls_decl where cls_decl = ClassDecl { tcdCtxt = toHsContext sc_theta, tcdName = getName clas, @@ -191,28 +246,25 @@ ifaceTyCls (AClass clas) so_far tcdFDs = toHsFDs clas_fds, tcdSigs = map toClassOpSig op_stuff, tcdMeths = Nothing, - tcdSysNames = sys_names, tcdLoc = noSrcLoc } (clas_tyvars, clas_fds, sc_theta, sc_sels, op_stuff) = classExtraBigSig clas tycon = classTyCon clas data_con = head (tyConDataCons tycon) - sys_names = mkClassDeclSysNames (getName tycon, getName data_con, - getName (dataConId data_con), map getName sc_sels) toClassOpSig (sel_id, def_meth) = ASSERT(sel_tyvars == clas_tyvars) - ClassOpSig (getName sel_id) def_meth' (toHsType op_ty) noSrcLoc + ClassOpSig (getName sel_id) def_meth (toHsType op_ty) noSrcLoc where - (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id) - def_meth' = case def_meth of - NoDefMeth -> NoDefMeth - GenDefMeth -> GenDefMeth - DefMeth id -> DefMeth (getName id) - -ifaceTyCls (ATyCon tycon) so_far - | isClassTyCon tycon = so_far - | otherwise = ty_decl : so_far + -- Be careful when splitting the type, because of things + -- like class Foo a where + -- op :: (?x :: String) => a -> a + -- and class Baz a where + -- op :: (Ord a) => a -> a + (sel_tyvars, rho_ty) = tcSplitForAllTys (idType sel_id) + op_ty = tcFunResultTy rho_ty + +ifaceTyThing (ATyCon tycon) = ty_decl where ty_decl | isSynTyCon tycon = TySynonym { tcdName = getName tycon, @@ -221,88 +273,106 @@ ifaceTyCls (ATyCon tycon) so_far tcdLoc = noSrcLoc } | isAlgTyCon tycon - = TyData { tcdND = new_or_data, - tcdCtxt = toHsContext (tyConTheta tycon), + = TyData { tcdND = new_or_data, + tcdCtxt = toHsContext (tyConTheta tycon), + tcdName = getName tycon, + tcdTyVars = toHsTyVars tyvars, + tcdCons = ifaceConDecls (tyConDataConDetails tycon), + tcdDerivs = Nothing, + tcdGeneric = Just (isJust (tyConGenInfo tycon)), + -- Just True <=> has generic stuff + tcdLoc = noSrcLoc } + + | isForeignTyCon tycon + = ForeignType { tcdName = getName tycon, + tcdExtName = Nothing, + tcdFoType = DNType, -- The only case at present + tcdLoc = noSrcLoc } + + | isPrimTyCon tycon || isFunTyCon tycon + -- needed in GHCi for ':info Int#', for example + = TyData { tcdND = DataType, + tcdCtxt = [], tcdName = getName tycon, - tcdTyVars = toHsTyVars tyvars, - tcdCons = map ifaceConDecl (tyConDataCons tycon), - tcdNCons = tyConFamilySize tycon, + tcdTyVars = toHsTyVars (take (tyConArity tycon) alphaTyVars), + tcdCons = Unknown, tcdDerivs = Nothing, - tcdSysNames = map getName (tyConGenIds tycon), + tcdGeneric = Just False, tcdLoc = noSrcLoc } - | otherwise = pprPanic "ifaceTyCls" (ppr tycon) + | otherwise = pprPanic "ifaceTyThing" (ppr tycon) tyvars = tyConTyVars tycon (_, syn_ty) = getSynTyConDefn tycon new_or_data | isNewTyCon tycon = NewType | otherwise = DataType + ifaceConDecls Unknown = Unknown + ifaceConDecls (HasCons n) = HasCons n + ifaceConDecls (DataCons cs) = DataCons (map ifaceConDecl cs) + ifaceConDecl data_con - = ConDecl (getName data_con) (getName (dataConId data_con)) + = ConDecl (dataConName data_con) (toHsTyVars ex_tyvars) (toHsContext ex_theta) details noSrcLoc where (tyvars1, _, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con field_labels = dataConFieldLabels data_con - strict_marks = dataConStrictMarks data_con + strict_marks = dropList ex_theta (dataConStrictMarks data_con) + -- The 'drop' is because dataConStrictMarks + -- includes the existential dictionaries details | null field_labels = ASSERT( tycon == tycon1 && tyvars == tyvars1 ) - VanillaCon (zipWith mk_bang_ty strict_marks arg_tys) + PrefixCon (zipWith BangType strict_marks (map toHsType arg_tys)) | otherwise = RecCon (zipWith mk_field strict_marks field_labels) - mk_bang_ty NotMarkedStrict ty = Unbanged (toHsType ty) - mk_bang_ty (MarkedUnboxed _ _) ty = Unpacked (toHsType ty) - mk_bang_ty MarkedStrict ty = Banged (toHsType ty) - mk_field strict_mark field_label - = ([getName field_label], mk_bang_ty strict_mark (fieldLabelType field_label)) + = (getName field_label, BangType strict_mark (toHsType (fieldLabelType field_label))) -ifaceTyCls (AnId id) so_far - | isImplicitId id = so_far - | otherwise = iface_sig : so_far +ifaceTyThing (AnId id) = iface_sig where iface_sig = IfaceSig { tcdName = getName id, tcdType = toHsType id_type, tcdIdInfo = hs_idinfo, - tcdLoc = noSrcLoc } + tcdLoc = noSrcLoc } id_type = idType id id_info = idInfo id + arity_info = arityInfo id_info + caf_info = idCafInfo id - hs_idinfo | opt_OmitInterfacePragmas = [] - | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ - strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo + hs_idinfo | opt_OmitInterfacePragmas + = [] + | otherwise + = catMaybes [arity_hsinfo, caf_hsinfo, + strict_hsinfo, wrkr_hsinfo, + unfold_hsinfo] ------------ Arity -------------- - arity_hsinfo = case arityInfo id_info of - a@(ArityExactly n) -> [HsArity a] - other -> [] + arity_hsinfo | arity_info == 0 = Nothing + | otherwise = Just (HsArity arity_info) ------------ Caf Info -------------- - caf_hsinfo = case cafInfo id_info of - NoCafRefs -> [HsNoCafRefs] - otherwise -> [] - - ------------ CPR Info -------------- - cpr_hsinfo = case cprInfo id_info of - ReturnsCPR -> [HsCprInfo] - NoCPRInfo -> [] + caf_hsinfo = case caf_info of + NoCafRefs -> Just HsNoCafRefs + _other -> Nothing ------------ Strictness -------------- - strict_hsinfo = case strictnessInfo id_info of - NoStrictnessInfo -> [] - info -> [HsStrictness info] + -- No point in explicitly exporting TopSig + strict_hsinfo = case newStrictnessInfo id_info of + Just sig | not (isTopSig sig) -> Just (HsStrictness sig) + _other -> Nothing ------------ Worker -------------- work_info = workerInfo id_info has_worker = case work_info of { HasWorker _ _ -> True; other -> False } wrkr_hsinfo = case work_info of - HasWorker work_id wrap_arity -> [HsWorker (getName work_id)] - NoWorker -> [] + HasWorker work_id wrap_arity -> + Just (HsWorker (getName work_id) wrap_arity) + NoWorker -> Nothing ------------ Unfolding -------------- -- The unfolding is redundant if there is a worker @@ -310,8 +380,25 @@ ifaceTyCls (AnId id) so_far inline_prag = inlinePragInfo id_info rhs = unfoldingTemplate unfold_info unfold_hsinfo | neverUnfold unfold_info - || has_worker = [] - | otherwise = [HsUnfold inline_prag (toUfExpr rhs)] + || has_worker = Nothing + | otherwise = Just (HsUnfold inline_prag (toUfExpr rhs)) + + +ifaceTyThing (ADataCon dc) + -- This case only happens in the call to ifaceThing in InteractiveUI + -- Otherwise DataCons are filtered out in ifaceThing_acc + = IfaceSig { tcdName = getName dc, + tcdType = toHsType full_ty, + tcdIdInfo = [], + tcdLoc = noSrcLoc } + where + (tvs, stupid_theta, ex_tvs, ex_theta, arg_tys, tycon) = dataConSig dc + + -- The "stupid context" isn't part of the wrapper-Id type + -- (for better or worse -- see note in DataCon.lhs), so we + -- have to make it up here + full_ty = mkSigmaTy (tvs ++ ex_tvs) (stupid_theta ++ ex_theta) + (mkFunTys arg_tys (mkTyConApp tycon (mkTyVarTys tvs))) \end{code} \begin{code} @@ -330,18 +417,202 @@ ifaceInstance dfun_id -- and this instance decl wouldn't get imported into a module -- that mentioned T but not Tibble. -ifaceRule (id, BuiltinRule _) +ifaceRule :: IdCoreRule -> RuleDecl Name +ifaceRule (id, BuiltinRule _ _) = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id) -ifaceRule (id, Rule name bndrs args rhs) - = IfaceRule name (map toUfBndr bndrs) (getName id) +ifaceRule (id, Rule name act bndrs args rhs) + = IfaceRule name act (map toUfBndr bndrs) (getName id) (map toUfExpr args) (toUfExpr rhs) noSrcLoc +bogusIfaceRule :: (NamedThing a) => a -> RuleDecl Name bogusIfaceRule id - = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc + = IfaceRule FSLIT("bogus") NeverActive [] (getName id) [] (UfVar (getName id)) noSrcLoc \end{code} +%********************************************************* +%* * +\subsection{Keeping track of what we've slurped, and version numbers} +%* * +%********************************************************* + +mkUsageInfo figures out what the ``usage information'' for this +moudule is; that is, what it must record in its interface file as the +things it uses. + +We produce a line for every module B below the module, A, currently being +compiled: + import B ; +to record the fact that A does import B indirectly. This is used to decide +to look to look for B.hi rather than B.hi-boot when compiling a module that +imports A. This line says that A imports B, but uses nothing in it. +So we'll get an early bale-out when compiling A if B's version changes. + +The usage information records: + +\begin{itemize} +\item (a) anything reachable from its body code +\item (b) any module exported with a @module Foo@ +\item (c) anything reachable from an exported item +\end{itemize} + +Why (b)? Because if @Foo@ changes then this module's export list +will change, so we must recompile this module at least as far as +making a new interface file --- but in practice that means complete +recompilation. + +Why (c)? Consider this: +\begin{verbatim} + module A( f, g ) where | module B( f ) where + import B( f ) | f = h 3 + g = ... | h = ... +\end{verbatim} + +Here, @B.f@ isn't used in A. Should we nevertheless record @B.f@ in +@A@'s usages? Our idea is that we aren't going to touch A.hi if it is +*identical* to what it was before. If anything about @B.f@ changes +than anyone who imports @A@ should be recompiled in case they use +@B.f@ (they'll get an early exit if they don't). So, if anything +about @B.f@ changes we'd better make sure that something in A.hi +changes, and the convenient way to do that is to record the version +number @B.f@ in A.hi in the usage list. If B.f changes that'll force a +complete recompiation of A, which is overkill but it's the only way to +write a new, slightly different, A.hi. + +But the example is tricker. Even if @B.f@ doesn't change at all, +@B.h@ may do so, and this change may not be reflected in @f@'s version +number. But with -O, a module that imports A must be recompiled if +@B.h@ changes! So A must record a dependency on @B.h@. So we treat +the occurrence of @B.f@ in the export list *just as if* it were in the +code of A, and thereby haul in all the stuff reachable from it. + + *** Conclusion: if A mentions B.f in its export list, + behave just as if A mentioned B.f in its source code, + and slurp in B.f and all its transitive closure *** + +[NB: If B was compiled with -O, but A isn't, we should really *still* +haul in all the unfoldings for B, in case the module that imports A *is* +compiled with -O. I think this is the case.] + +\begin{code} +mkUsageInfo :: HscEnv -> ExternalPackageState + -> ImportAvails -> EntityUsage + -> [Usage Name] + +mkUsageInfo hsc_env eps + (ImportAvails { imp_mods = dir_imp_mods, + imp_dep_mods = dep_mods }) + used_names + = -- seq the list of Usages returned: occasionally these + -- don't get evaluated for a while and we can end up hanging on to + -- the entire collection of Ifaces. + usages `seqList` usages + where + usages = catMaybes [ mkUsage mod_name + | (mod_name,_) <- moduleEnvElts dep_mods] + -- ToDo: do we need to sort into canonical order? + + hpt = hsc_HPT hsc_env + pit = eps_PIT eps + + import_all mod = case lookupModuleEnv dir_imp_mods mod of + Just (_,imp_all) -> imp_all + Nothing -> False + + -- ent_map groups together all the things imported and used + -- from a particular module in this package + ent_map :: ModuleEnv [Name] + ent_map = foldNameSet add_mv emptyModuleEnv used_names + add_mv name mv_map = extendModuleEnv_C add_item mv_map mod [name] + where + mod = nameModule name + add_item names _ = name:names + + -- We want to create a Usage for a home module if + -- a) we used something from; has something in used_names + -- b) we imported all of it, even if we used nothing from it + -- (need to recompile if its export list changes: export_vers) + -- c) is a home-package orphan module (need to recompile if its + -- instance decls change: rules_vers) + mkUsage :: ModuleName -> Maybe (Usage Name) + mkUsage mod_name + | isNothing maybe_iface -- We can't depend on it if we didn't + || not (isHomeModule mod) -- even open the interface! + || (null used_names + && not all_imported + && not orphan_mod) + = Nothing -- Record no usage info + + | otherwise + = Just (Usage { usg_name = moduleName mod, + usg_mod = mod_vers, + usg_exports = export_vers, + usg_entities = ent_vers, + usg_rules = rules_vers }) + where + maybe_iface = lookupIfaceByModName hpt pit mod_name + -- In one-shot mode, the interfaces for home-package + -- modules accumulate in the PIT not HPT. Sigh. + + Just iface = maybe_iface + mod = mi_module iface + version_info = mi_version iface + orphan_mod = mi_orphan iface + version_env = vers_decls version_info + mod_vers = vers_module version_info + rules_vers = vers_rules version_info + all_imported = import_all mod + export_vers | all_imported = Just (vers_exports version_info) + | otherwise = Nothing + + -- The sort is to put them into canonical order + used_names = lookupModuleEnv ent_map mod `orElse` [] + ent_vers = [(n, lookupVersion version_env n) + | n <- sortLt lt_occ used_names ] + lt_occ n1 n2 = nameOccName n1 < nameOccName n2 + -- ToDo: is '<' on OccNames the right thing; may differ between runs? +\end{code} + +\begin{code} +groupAvails :: Module -> Avails -> [(ModuleName, Avails)] + -- Group by module and sort by occurrence + -- This keeps the list in canonical order +groupAvails this_mod avails + = [ (mkSysModuleNameFS fs, sortLt lt avails) + | (fs,avails) <- fmToList groupFM + ] + where + groupFM :: FiniteMap FastString Avails + -- Deliberately use the FastString so we + -- get a canonical ordering + groupFM = foldl add emptyFM avails + + add env avail = addToFM_C combine env mod_fs [avail'] + where + mod_fs = moduleNameFS (moduleName avail_mod) + avail_mod = case nameModule_maybe (availName avail) of + Just m -> m + Nothing -> this_mod + combine old _ = avail':old + avail' = sortAvail avail + + a1 `lt` a2 = occ1 < occ2 + where + occ1 = nameOccName (availName a1) + occ2 = nameOccName (availName a2) + +sortAvail :: AvailInfo -> AvailInfo +-- Sort the sub-names into canonical order. +-- The canonical order has the "main name" at the beginning +-- (if it's there at all) +sortAvail (Avail n) = Avail n +sortAvail (AvailTC n ns) | n `elem` ns = AvailTC n (n : sortLt lt (filter (/= n) ns)) + | otherwise = AvailTC n ( sortLt lt ns) + where + n1 `lt` n2 = nameOccName n1 < nameOccName n2 +\end{code} + %************************************************************************ %* * \subsection{Checking if the new interface is up to date @@ -393,6 +664,7 @@ addVersionInfo (Just old_iface@(ModIface { mi_version = old_version, no_export_change = mi_exports old_iface == mi_exports new_iface -- Kept sorted no_rule_change = dcl_rules old_decls == dcl_rules new_decls -- Ditto + && dcl_insts old_decls == dcl_insts new_decls no_deprec_change = old_deprecs == new_deprecs -- Fill in the version number on the new declarations by looking at the old declarations. @@ -409,7 +681,7 @@ addVersionInfo (Just old_iface@(ModIface { mi_version = old_version, pp_change False what = text what <+> ptext SLIT("changed") diffDecls :: VersionInfo -- Old version - -> NameEnv Fixity -> NameEnv Fixity -- Old and new fixities + -> FixityEnv -> FixityEnv -- Old and new fixities -> [RenamedTyClDecl] -> [RenamedTyClDecl] -- Old and new decls -> (Bool, -- True <=> no change SDoc, -- Record of differences @@ -422,7 +694,7 @@ diffDecls (VersionInfo { vers_module = old_mod_vers, vers_decls = old_decls_vers -- When seeing if two decls are the same, -- remember to check whether any relevant fixity has changed eq_tc d1 d2 = d1 == d2 && all (same_fixity . fst) (tyClDeclNames d1) - same_fixity n = lookupNameEnv old_fixities n == lookupNameEnv new_fixities n + same_fixity n = lookupFixity old_fixities n == lookupFixity new_fixities n diff ok_so_far pp new_vers [] [] = (ok_so_far, pp, new_vers) diff ok_so_far pp new_vers (od:ods) [] = diff False (pp $$ only_old od) new_vers ods [] @@ -453,37 +725,26 @@ diffDecls (VersionInfo { vers_module = old_mod_vers, vers_decls = old_decls_vers \end{code} - -%************************************************************************ +b%************************************************************************ %* * \subsection{Writing an interface file} %* * %************************************************************************ \begin{code} -writeIface :: FilePath -> ModIface -> IO () -writeIface hi_path mod_iface - = do { if_hdl <- openFile hi_path WriteMode - ; printForIface if_hdl from_this_mod (pprIface mod_iface) - ; hClose if_hdl - } - where - -- Print names unqualified if they are from this module - from_this_mod n = nameModule n == this_mod - this_mod = mi_module mod_iface - pprIface :: ModIface -> SDoc pprIface iface = vcat [ ptext SLIT("__interface") - <+> doubleQuotes (ptext opt_InPackage) + <+> doubleQuotes (ftext (mi_package iface)) <+> ppr (mi_module iface) <+> ppr (vers_module version_info) <+> pp_sub_vers <+> (if mi_orphan iface then char '!' else empty) <+> int opt_HiVersion <+> ptext SLIT("where") - , vcat (map pprExport (mi_exports iface)) - , vcat (map pprUsage (mi_usages iface)) + , pprExports nameOccName (mi_exports iface) + , pprDeps (mi_deps iface) + , pprUsages nameOccName (mi_usages iface) , pprFixities (mi_fixities iface) (dcl_tycl decls) , pprIfaceDecls (vers_decls version_info) decls @@ -493,6 +754,7 @@ pprIface iface version_info = mi_version iface decls = mi_decls iface exp_vers = vers_exports version_info + rule_vers = vers_rules version_info pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty @@ -505,18 +767,22 @@ When printing export lists, we print like this: AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C \begin{code} -pprExport :: (ModuleName, Avails) -> SDoc -pprExport (mod, items) +pprExports :: Eq a => (a -> OccName) -> [(ModuleName, [GenAvailInfo a])] -> SDoc +pprExports getOcc exports = vcat (map (pprExport getOcc) exports) + +pprExport :: Eq a => (a -> OccName) -> (ModuleName, [GenAvailInfo a]) -> SDoc +pprExport getOcc (mod, items) = hsep [ ptext SLIT("__export "), ppr mod, hsep (map pp_avail items) ] <> semi where - pp_avail :: AvailInfo -> SDoc - pp_avail (Avail name) = pprOcc name - pp_avail (AvailTC n []) = empty - pp_avail (AvailTC n (n':ns)) | n==n' = pprOcc n <> pp_export ns - | otherwise = pprOcc n <> char '|' <> pp_export (n':ns) + --pp_avail :: GenAvailInfo a -> SDoc + pp_avail (Avail name) = ppr (getOcc name) + pp_avail (AvailTC _ []) = empty + pp_avail (AvailTC n (n':ns)) + | n==n' = ppr (getOcc n) <> pp_export ns + | otherwise = ppr (getOcc n) <> char '|' <> pp_export (n':ns) pp_export [] = empty - pp_export names = braces (hsep (map pprOcc names)) + pp_export names = braces (hsep (map (ppr.getOcc) names)) pprOcc :: Name -> SDoc -- Print the occurrence name only pprOcc n = pprOccName (nameOccName n) @@ -524,29 +790,39 @@ pprOcc n = pprOccName (nameOccName n) \begin{code} -pprUsage :: ImportVersion Name -> SDoc -pprUsage (m, has_orphans, is_boot, whats_imported) - = hsep [ptext SLIT("import"), ppr m, - pp_orphan, pp_boot, - pp_versions whats_imported +pprUsages :: (a -> OccName) -> [Usage a] -> SDoc +pprUsages getOcc usages = vcat (map (pprUsage getOcc) usages) + +pprUsage :: (a -> OccName) -> Usage a -> SDoc +pprUsage getOcc usage + = hsep [ptext SLIT("import"), ppr (usg_name usage), + int (usg_mod usage), + pp_export_version (usg_exports usage), + int (usg_rules usage), + pp_versions (usg_entities usage) ] <> semi where - pp_orphan | has_orphans = char '!' - | otherwise = empty - pp_boot | is_boot = char '@' - | otherwise = empty - - -- Importing the whole module is indicated by an empty list - pp_versions NothingAtAll = empty - pp_versions (Everything v) = dcolon <+> int v - pp_versions (Specifically vm ve nvs vr) = dcolon <+> int vm <+> pp_export_version ve <+> int vr - <+> hsep [ pprOcc n <+> int v | (n,v) <- nvs ] + pp_versions nvs = hsep [ ppr (getOcc n) <+> int v | (n,v) <- nvs ] pp_export_version Nothing = empty pp_export_version (Just v) = int v + + +pprDeps :: Dependencies -> SDoc +pprDeps (Deps { dep_mods = mods, dep_pkgs = pkgs, dep_orphs = orphs}) + = vcat [ptext SLIT("module dependencies:") <+> fsep (map ppr_mod mods), + ptext SLIT("package dependencies:") <+> fsep (map ppr pkgs), + ptext SLIT("orphans:") <+> fsep (map ppr orphs) + ] + where + ppr_mod (mod_name, boot) = ppr mod_name <+> ppr_boot boot + + ppr_boot True = text "[boot]" + ppr_boot False = empty \end{code} \begin{code} +pprIfaceDecls :: NameEnv Int -> IfaceDecls -> SDoc pprIfaceDecls version_map decls = vcat [ vcat [ppr i <+> semi | i <- dcl_insts decls] , vcat (map ppr_decl (dcl_tycl decls)) @@ -561,14 +837,16 @@ pprIfaceDecls version_map decls \end{code} \begin{code} +pprFixities :: FixityEnv + -> [TyClDecl Name] + -> SDoc pprFixities fixity_map decls = hsep [ ppr fix <+> ppr n - | d <- decls, - (n,_) <- tyClDeclNames d, - Just fix <- [lookupNameEnv fixity_map n]] <> semi + | FixitySig n fix _ <- collectFixities fixity_map decls ] <> semi -- Disgusting to print these two together, but that's -- the way the interface parser currently expects them. +pprRulesAndDeprecs :: (Outputable a) => [a] -> Deprecations -> SDoc pprRulesAndDeprecs [] NoDeprecs = empty pprRulesAndDeprecs rules deprecs = ptext SLIT("{-##") <+> (pp_rules rules $$ pp_deprecs deprecs) <+> ptext SLIT("##-}") @@ -576,14 +854,15 @@ pprRulesAndDeprecs rules deprecs pp_rules [] = empty pp_rules rules = ptext SLIT("__R") <+> vcat (map ppr rules) - ppr_deprecs NoDeprecs = empty - ppr_deprecs deprecs = ptext SLIT("__D") <+> guts + pp_deprecs NoDeprecs = empty + pp_deprecs deprecs = ptext SLIT("__D") <+> guts where guts = case deprecs of - DeprecAll txt -> doubleQuotes (ptext txt) - DeprecSome env -> pp_deprecs env + DeprecAll txt -> doubleQuotes (ftext txt) + DeprecSome env -> ppr_deprec_env env -pp_deprecs env = vcat (punctuate semi (map pp_deprec (nameEnvElts env))) - where - pp_deprec (name, txt) = pprOcc name <+> doubleQuotes (ptext txt) +ppr_deprec_env :: NameEnv (Name, FastString) -> SDoc +ppr_deprec_env env = vcat (punctuate semi (map pp_deprec (nameEnvElts env))) + where + pp_deprec (name, txt) = pprOcc name <+> doubleQuotes (ftext txt) \end{code}