X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=a77ce516bedd746d88191ffbd788dccb33cfaf6f;hb=52eed22df83f01b4fbe3d1c67abc5e3893e47d39;hp=e823e478e6b7f29ac55c50b79d4bab0853823ba9;hpb=9d787ef5a8072b6c1f576f2de1b66edfa59813ed;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index e823e47..a77ce51 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -4,251 +4,321 @@ \section[MkIface]{Print an interface for a module} \begin{code} -module MkIface ( - startIface, endIface, ifaceDecls - ) where +module MkIface ( + mkModDetails, mkModDetailsFromIface, completeIface, + writeIface, pprIface + ) where #include "HsVersions.h" -import IO ( Handle, hPutStr, openFile, - hClose, hPutStrLn, IOMode(..) ) - import HsSyn -import BasicTypes ( Fixity(..), FixityDirection(..), NewOrData(..) ) +import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr ) +import HsTypes ( toHsTyVars ) +import BasicTypes ( Fixity(..), NewOrData(..), + Version, initialVersion, bumpVersion, + ) import RnMonad -import RnEnv ( availName ) - -import TcInstUtil ( InstInfo(..) ) +import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) +import TcHsSyn ( TypecheckedRuleDecl ) +import HscTypes ( VersionInfo(..), ModIface(..), ModDetails(..), + IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts, + TyThing(..), DFunId, TypeEnv, Avails, + WhatsImported(..), GenAvailInfo(..), + ImportVersion, AvailInfo, Deprecations(..), + extendTypeEnvList + ) import CmdLineOpts -import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, - getIdSpecialisation +import Id ( idType, idInfo, isImplicitId, isDictFunId, + idSpecialisation, isLocalId, idName, hasNoBinding ) import Var ( isId ) import VarSet -import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks ) -import IdInfo ( IdInfo, StrictnessInfo, ArityInfo, InlinePragInfo(..), inlinePragInfo, - arityInfo, ppArityInfo, - strictnessInfo, ppStrictnessInfo, isBottomingStrictness, - cafInfo, ppCafInfo, specInfo, - cprInfo, ppCprInfo, - workerExists, workerInfo, ppWorkerInfo +import DataCon ( StrictnessMark(..), dataConId, dataConSig, dataConFieldLabels, dataConStrictMarks ) +import IdInfo -- Lots +import CoreSyn ( CoreBind, CoreRule(..), IdCoreRule, + isBuiltinRule, rulesRules, + bindersOf, bindersOfBinds ) -import CoreSyn ( CoreExpr, CoreBind, Bind(..), rulesRules, rulesRhsFreeVars ) -import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) -import CoreUnfold ( calcUnfoldingGuidance, okToUnfoldInHiFile, couldBeSmallEnoughToInline ) -import Module ( moduleString, pprModule, pprModuleName ) -import Name ( isLocallyDefined, isWiredInName, nameRdrName, nameModule, - Name, NamedThing(..) +import CoreFVs ( ruleSomeLhsFreeVars ) +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 OccName ( OccName, pprOccName ) -import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, - tyConTheta, tyConTyVars, tyConDataCons - ) -import Class ( Class, classBigSig ) -import FieldLabel ( fieldLabelName, fieldLabelType ) -import Type ( mkSigmaTy, splitSigmaTy, mkDictTy, tidyTopType, deNoteType, - Type, ThetaType - ) - -import PprType -import PprCore ( pprIfaceUnfolding, pprCoreRule ) -import Rules ( pprProtoCoreRule, ProtoCoreRule(..) ) - -import Bag ( bagToList, isEmptyBag ) -import Maybes ( catMaybes, maybeToBool ) -import FiniteMap ( emptyFM, addToFM, addToFM_C, fmToList, FiniteMap ) -import UniqFM ( lookupUFM, listToUFM ) -import UniqSet ( uniqSetToList ) -import Util ( sortLt, mapAccumL ) -import Bag +import Class ( classExtraBigSig, classTyCon, DefMeth(..) ) +import FieldLabel ( fieldLabelType ) +import Type ( splitSigmaTy, tidyTopType, deNoteType ) +import SrcLoc ( noSrcLoc ) import Outputable +import Module ( ModuleName ) + +import IO ( IOMode(..), openFile, hClose ) \end{code} -We have a function @startIface@ to open the output file and put -(something like) ``interface Foo'' in it. It gives back a handle -for subsequent additions to the interface file. -We then have one-function-per-block-of-interface-stuff, e.g., -@ifaceExportList@ produces the @__exports__@ section; it appends -to the handle provided by @startIface@. +%************************************************************************ +%* * +\subsection{Write a new interface file} +%* * +%************************************************************************ \begin{code} -startIface :: Module -> InterfaceDetails - -> IO (Maybe Handle) -- Nothing <=> don't do an interface - -ifaceDecls :: Maybe Handle - -> [TyCon] -> [Class] - -> Bag InstInfo - -> [Id] -- Ids used at code-gen time; they have better pragma info! - -> [CoreBind] -- In dependency order, later depend on earlier - -> [ProtoCoreRule] -- Rules - -> IO () - -endIface :: Maybe Handle -> IO () +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} -startIface mod (has_orphans, import_usages, ExportEnv avails fixities) - = case opt_ProduceHi of - Nothing -> return Nothing ; -- not producing any .hi file - - Just fn -> do - if_hdl <- openFile fn WriteMode - hPutStr if_hdl ("__interface " ++ moduleString mod) - hPutStr if_hdl (' ' : show (opt_HiVersion :: Int) ++ orphan_indicator) - hPutStrLn if_hdl " where" - ifaceExports if_hdl avails - ifaceImports if_hdl import_usages - ifaceFixities if_hdl fixities - return (Just if_hdl) +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 - orphan_indicator | has_orphans = " !" - | otherwise = "" - -endIface Nothing = return () -endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl + 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 \end{code} +%************************************************************************ +%* * +\subsection{Completing an interface} +%* * +%************************************************************************ + \begin{code} -ifaceDecls Nothing tycons classes inst_info final_ids simplified rules = return () -ifaceDecls (Just hdl) - tycons classes - inst_infos - final_ids binds - orphan_rules -- Rules defined locally for an Id that is *not* defined locally - | null_decls = return () - -- You could have a module with just (re-)exports/instances in it - | otherwise - = ifaceClasses hdl classes >> - ifaceInstances hdl inst_infos >>= \ inst_ids -> - ifaceTyCons hdl tycons >> - ifaceBinds hdl (inst_ids `unionVarSet` orphan_rule_ids) - final_ids binds >>= \ emitted_ids -> - ifaceRules hdl orphan_rules emitted_ids >> - return () +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 }) where - orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule - | ProtoCoreRule _ _ rule <- orphan_rules] - - null_decls = null binds && - null tycons && - null classes && - isEmptyBag inst_infos && - null orphan_rules + 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) \end{code} + \begin{code} -ifaceImports if_hdl import_usages - = hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages) +ifaceTyCls :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] +ifaceTyCls (AClass clas) so_far + = cls_decl : so_far where - upp_uses (m, mv, has_orphans, whats_imported) - = hsep [ptext SLIT("import"), pprModuleName m, - int mv, pp_orphan, - upp_import_versions whats_imported - ] <> semi - where - pp_orphan | has_orphans = ptext SLIT("!") - | otherwise = empty - - -- Importing the whole module is indicated by an empty list - upp_import_versions Everything = empty - - -- For imported versions we do print the version number - upp_import_versions (Specifically nvs) - = dcolon <+> hsep [ hsep [ppr_unqual_name n, int v] | (n,v) <- sort_versions nvs ] - -ifaceModuleDeps if_hdl [] = return () -ifaceModuleDeps if_hdl mod_deps - = let - lines = map ppr_mod_dep mod_deps - ppr_mod_dep (mod, contains_orphans) - | contains_orphans = pprModuleName mod <+> ptext SLIT("!") - | otherwise = pprModuleName mod - in - printForIface if_hdl (ptext SLIT("__depends") <+> vcat lines <> ptext SLIT(" ;")) >> - hPutStr if_hdl "\n" - -ifaceExports if_hdl [] = return () -ifaceExports if_hdl avails - = hPutCol if_hdl do_one_module (fmToList export_fm) + cls_decl = ClassDecl { tcdCtxt = toHsContext sc_theta, + tcdName = getName clas, + tcdTyVars = toHsTyVars clas_tyvars, + 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 + 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 where - -- Sort them into groups by module - export_fm :: FiniteMap Module [AvailInfo] - export_fm = foldr insert emptyFM avails - - insert avail efm = addToFM_C (++) efm mod [avail] - where - mod = nameModule (availName avail) + ty_decl | isSynTyCon tycon + = TySynonym { tcdName = getName tycon, + tcdTyVars = toHsTyVars tyvars, + tcdSynRhs = toHsType syn_ty, + tcdLoc = noSrcLoc } + + | isAlgTyCon tycon + = TyData { tcdND = new_or_data, + tcdCtxt = toHsContext (tyConTheta tycon), + tcdName = getName tycon, + tcdTyVars = toHsTyVars tyvars, + tcdCons = map ifaceConDecl (tyConDataCons tycon), + tcdNCons = tyConFamilySize tycon, + tcdDerivs = Nothing, + tcdSysNames = map getName (tyConGenIds tycon), + tcdLoc = noSrcLoc } + + | otherwise = pprPanic "ifaceTyCls" (ppr tycon) + + tyvars = tyConTyVars tycon + (_, syn_ty) = getSynTyConDefn tycon + new_or_data | isNewTyCon tycon = NewType + | otherwise = DataType + + ifaceConDecl data_con + = ConDecl (getName data_con) (getName (dataConId 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 + details | null field_labels + = ASSERT( tycon == tycon1 && tyvars == tyvars1 ) + VanillaCon (zipWith mk_bang_ty strict_marks 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)) + +ifaceTyCls (AnId id) so_far + | isImplicitId id = so_far + | otherwise = iface_sig : so_far + where + iface_sig = IfaceSig { tcdName = getName id, + tcdType = toHsType id_type, + tcdIdInfo = hs_idinfo, + tcdLoc = noSrcLoc } - -- Print one module's worth of stuff - do_one_module :: (Module, [AvailInfo]) -> SDoc - do_one_module (mod_name, avails@(avail1:_)) - = ptext SLIT("__export ") <> - hsep [pprModule mod_name, - hsep (map upp_avail (sortLt lt_avail avails)) - ] <> semi + id_type = idType id + id_info = idInfo id -ifaceFixities if_hdl [] = return () -ifaceFixities if_hdl fixities - = hPutCol if_hdl upp_fixity fixities + hs_idinfo | opt_OmitInterfacePragmas = [] + | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ + strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo -ifaceRules if_hdl rules emitted - | null orphan_rule_pretties && null local_id_pretties - = return () - | otherwise - = do printForIface if_hdl (vcat [ - ptext SLIT("{-## __R"), + ------------ Arity -------------- + arity_hsinfo = case arityInfo id_info of + a@(ArityExactly n) -> [HsArity a] + other -> [] - vcat orphan_rule_pretties, + ------------ Caf Info -------------- + caf_hsinfo = case cafInfo id_info of + NoCafRefs -> [HsNoCafRefs] + otherwise -> [] - vcat local_id_pretties, + ------------ CPR Info -------------- + cpr_hsinfo = case cprInfo id_info of + ReturnsCPR -> [HsCprInfo] + NoCPRInfo -> [] - ptext SLIT("##-}") - ]) - - return () - where - orphan_rule_pretties = [ pprCoreRule (Just fn) rule <+> semi - | ProtoCoreRule _ fn rule <- rules - ] - local_id_pretties = [ pprCoreRule (Just fn) rule <+> semi - | fn <- varSetElems emitted, - rule <- rulesRules (getIdSpecialisation fn), - all (`elemVarSet` emitted) (varSetElems (ruleSomeLhsFreeVars interestingId rule)) - -- Spit out a rule only if all its lhs free vars are eemitted - ] -\end{code} + ------------ Strictness -------------- + strict_hsinfo = case strictnessInfo id_info of + NoStrictnessInfo -> [] + info -> [HsStrictness info] -%************************************************************************ -%* * -\subsection{Instance declarations} -%* * -%************************************************************************ + ------------ 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 -> [] + ------------ Unfolding -------------- + -- The unfolding is redundant if there is a worker + unfold_info = unfoldingInfo id_info + inline_prag = inlinePragInfo id_info + rhs = unfoldingTemplate unfold_info + unfold_hsinfo | neverUnfold unfold_info + || has_worker = [] + | otherwise = [HsUnfold inline_prag (toUfExpr rhs)] +\end{code} -\begin{code} -ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet -- The IdSet is the needed dfuns -ifaceInstances if_hdl inst_infos - | null togo_insts = return emptyVarSet - | otherwise = hPutCol if_hdl pp_inst (sortLt lt_inst togo_insts) >> - return needed_ids - where - togo_insts = filter is_togo_inst (bagToList inst_infos) - needed_ids = mkVarSet [dfun_id | InstInfo _ _ _ _ dfun_id _ _ _ <- togo_insts] - is_togo_inst (InstInfo _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id - - ------- - lt_inst (InstInfo _ _ _ _ dfun_id1 _ _ _) - (InstInfo _ _ _ _ dfun_id2 _ _ _) - = getOccName dfun_id1 < getOccName dfun_id2 - -- The dfuns are assigned names df1, df2, etc, in order of original textual - -- occurrence, and this makes as good a sort order as any - - ------- - pp_inst (InstInfo clas tvs tys theta dfun_id _ _ _) - = let +\begin{code} +ifaceInstance :: DFunId -> RenamedInstDecl +ifaceInstance dfun_id + = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc + where + tidy_ty = tidyTopType (deNoteType (idType dfun_id)) -- The deNoteType is very important. It removes all type -- synonyms from the instance type in interface files. -- That in turn makes sure that when reading in instance decls @@ -258,382 +328,248 @@ ifaceInstances if_hdl inst_infos -- instance Foo Tibble where ... -- and this instance decl wouldn't get imported into a module -- that mentioned T but not Tibble. - forall_ty = mkSigmaTy tvs theta (deNoteType (mkDictTy clas tys)) - renumbered_ty = tidyTopType forall_ty - in - hcat [ptext SLIT("instance "), pprType renumbered_ty, - ptext SLIT(" = "), ppr_unqual_name dfun_id, semi] + +ifaceRule (id, BuiltinRule _) + = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id) + +ifaceRule (id, Rule name bndrs args rhs) + = IfaceRule name (map toUfBndr bndrs) (getName id) + (map toUfExpr args) (toUfExpr rhs) noSrcLoc + +bogusIfaceRule id + = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc \end{code} %************************************************************************ %* * -\subsection{Printing values} +\subsection{Checking if the new interface is up to date %* * %************************************************************************ \begin{code} -ifaceId :: (Id -> IdInfo) -- This function "knows" the extra info added - -- by the STG passes. Sigh - - -> IdSet -- Set of Ids that are needed by earlier interface - -- file emissions. If the Id isn't in this set, and isn't - -- exported, there's no need to emit anything - -> Bool -- True <=> recursive, so don't print unfolding - -> Id - -> CoreExpr -- The Id's right hand side - -> Maybe (SDoc, IdSet) -- The emitted stuff, plus any *extra* needed Ids - -ifaceId get_idinfo needed_ids is_rec id rhs - | not (id `elemVarSet` needed_ids || -- Needed [no id in needed_ids has omitIfaceSigForId] - (isUserExportedId id && not (omitIfaceSigForId id))) -- or exported and not to be omitted - = Nothing -- Well, that was easy! - -ifaceId get_idinfo needed_ids is_rec id rhs - = Just (hsep [sig_pretty, prag_pretty, char ';'], new_needed_ids) +addVersionInfo :: Maybe ModIface -- The old interface, read from M.hi + -> ModIface -- The new interface decls + -> (ModIface, Maybe SDoc) -- Nothing => no change; no need to write new Iface + -- Just mi => Here is the new interface to write + -- with correct version numbers + +-- NB: the fixities, declarations, rules are all assumed +-- to be sorted by increasing order of hsDeclName, so that +-- we can compare for equality + +addVersionInfo Nothing new_iface +-- No old interface, so definitely write a new one! + = (new_iface, Just (text "No old interface available")) + +addVersionInfo (Just old_iface@(ModIface { mi_version = old_version, + mi_decls = old_decls, + mi_fixities = old_fixities, + mi_deprecs = old_deprecs })) + new_iface@(ModIface { mi_decls = new_decls, + mi_fixities = new_fixities, + mi_deprecs = new_deprecs }) + + | no_output_change && no_usage_change + = (new_iface, Nothing) + -- don't return the old iface because it may not have an + -- mi_globals field set to anything reasonable. + + | otherwise -- Add updated version numbers + = --pprTrace "completeIface" (ppr (dcl_tycl old_decls)) + (final_iface, Just pp_diffs) + where - core_idinfo = idInfo id - stg_idinfo = get_idinfo id - - ty_pretty = pprType (idType id) - sig_pretty = hsep [ppr (getOccName id), dcolon, ty_pretty] - - prag_pretty - | opt_OmitInterfacePragmas = empty - | otherwise = hsep [ptext SLIT("{-##"), - arity_pretty, - caf_pretty, - cpr_pretty, - strict_pretty, - wrkr_pretty, - unfold_pretty, - ptext SLIT("##-}")] - - ------------ Arity -------------- - arity_pretty = ppArityInfo (arityInfo stg_idinfo) - - ------------ Caf Info -------------- - caf_pretty = ppCafInfo (cafInfo stg_idinfo) - - ------------ CPR Info -------------- - cpr_pretty = ppCprInfo (cprInfo core_idinfo) - - ------------ Strictness -------------- - strict_info = strictnessInfo core_idinfo - bottoming_fn = isBottomingStrictness strict_info - strict_pretty = ppStrictnessInfo strict_info - - ------------ Worker -------------- - work_info = workerInfo core_idinfo - has_worker = workerExists work_info - wrkr_pretty = ppWorkerInfo work_info - Just work_id = work_info - - - ------------ Unfolding -------------- - inline_pragma = inlinePragInfo core_idinfo - dont_inline = case inline_pragma of - IMustNotBeINLINEd -> True - IAmALoopBreaker -> True - other -> False - - unfold_pretty | show_unfold = ptext SLIT("__U") <+> pprIfaceUnfolding rhs - | otherwise = empty - - show_unfold = not has_worker && -- Not unnecessary - not bottoming_fn && -- Not necessary - not dont_inline && - rhs_is_small && -- Small enough - okToUnfoldInHiFile rhs -- No casms etc - - rhs_is_small = couldBeSmallEnoughToInline (calcUnfoldingGuidance opt_UF_HiFileThreshold rhs) - - ------------ Specialisations -------------- - spec_info = specInfo core_idinfo - - ------------ Extra free Ids -------------- - new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet - | otherwise = worker_ids `unionVarSet` - unfold_ids `unionVarSet` - spec_ids - - worker_ids | has_worker && interestingId work_id = unitVarSet work_id - -- Conceivably, the worker might come from - -- another module - | otherwise = emptyVarSet - - spec_ids = filterVarSet interestingId (rulesRhsFreeVars spec_info) - - unfold_ids | show_unfold = find_fvs rhs - | otherwise = emptyVarSet - - find_fvs expr = exprSomeFreeVars interestingId expr - -interestingId id = isId id && isLocallyDefined id && - not (omitIfaceSigForId id) -\end{code} - -\begin{code} -ifaceBinds :: Handle - -> IdSet -- These Ids are needed already - -> [Id] -- Ids used at code-gen time; they have better pragma info! - -> [CoreBind] -- In dependency order, later depend on earlier - -> IO IdSet -- Set of Ids actually spat out - -ifaceBinds hdl needed_ids final_ids binds - = mapIO (printForIface hdl) (bagToList pretties) >> - hPutStr hdl "\n" >> - return emitted + final_iface = new_iface { mi_version = new_version } + new_version = VersionInfo { vers_module = bumpVersion no_output_change (vers_module old_version), + vers_exports = bumpVersion no_export_change (vers_exports old_version), + vers_rules = bumpVersion no_rule_change (vers_rules old_version), + vers_decls = tc_vers } + + no_output_change = no_tc_change && no_rule_change && no_export_change && no_deprec_change + no_usage_change = mi_usages old_iface == mi_usages new_iface + + 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 + no_deprec_change = old_deprecs == new_deprecs + + -- Fill in the version number on the new declarations by looking at the old declarations. + -- Set the flag if anything changes. + -- Assumes that the decls are sorted by hsDeclName. + old_vers_decls = vers_decls old_version + (no_tc_change, pp_tc_diffs, tc_vers) = diffDecls old_vers_decls old_fixities new_fixities + (dcl_tycl old_decls) (dcl_tycl new_decls) + pp_diffs = vcat [pp_tc_diffs, + pp_change no_export_change "Export list", + pp_change no_rule_change "Rules", + pp_change no_deprec_change "Deprecations", + pp_change no_usage_change "Usages"] + pp_change True what = empty + pp_change False what = text what <+> ptext SLIT("changed") + +diffDecls :: NameEnv Version -- Old version map + -> NameEnv Fixity -> NameEnv Fixity -- Old and new fixities + -> [RenamedTyClDecl] -> [RenamedTyClDecl] -- Old and new decls + -> (Bool, -- True <=> no change + SDoc, -- Record of differences + NameEnv Version) -- New version + +diffDecls old_vers old_fixities new_fixities old new + = diff True empty emptyNameEnv old new where - final_id_map = listToUFM [(id,id) | id <- final_ids] - get_idinfo id = case lookupUFM final_id_map id of - Just id' -> idInfo id' - Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $ - idInfo id - - (pretties, emitted) = go needed_ids (reverse binds) emptyBag emptyVarSet - -- Reverse so that later things will - -- provoke earlier ones to be emitted - go needed [] pretties emitted - | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:" - (sep (map ppr (varSetElems needed))) - (pretties, emitted) - | otherwise = (pretties, emitted) - - go needed (NonRec id rhs : binds) pretties emitted - = case ifaceId get_idinfo needed False id rhs of - Nothing -> go needed binds pretties emitted - Just (pretty, extras) -> let - needed' = (needed `unionVarSet` extras) `delVarSet` id - -- 'extras' can include the Id itself via a rule - emitted' = emitted `extendVarSet` id - in - go needed' binds (pretty `consBag` pretties) emitted' - - -- Recursive groups are a bit more of a pain. We may only need one to - -- start with, but it may call out the next one, and so on. So we - -- have to look for a fixed point. - go needed (Rec pairs : binds) pretties emitted - = go needed' binds pretties' emitted' - where - (new_pretties, new_emitted, extras) = go_rec needed pairs - pretties' = new_pretties `unionBags` pretties - needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs) - emitted' = emitted `unionVarSet` new_emitted - - go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag SDoc, IdSet, IdSet) - go_rec needed pairs - | null pretties = (emptyBag, emptyVarSet, emptyVarSet) - | otherwise = (more_pretties `unionBags` listToBag pretties, - more_emitted `unionVarSet` mkVarSet emitted, - more_extras `unionVarSet` extras) + -- 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 + + 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 [] + diff ok_so_far pp new_vers [] (nd:nds) = diff False (pp $$ only_new nd) new_vers [] nds + diff ok_so_far pp new_vers (od:ods) (nd:nds) + = case od_name `compare` nd_name of + LT -> diff False (pp $$ only_old od) new_vers ods (nd:nds) + GT -> diff False (pp $$ only_new nd) new_vers (od:ods) nds + EQ | od `eq_tc` nd -> diff ok_so_far pp new_vers ods nds + | otherwise -> diff False (pp $$ changed od nd) new_vers' ods nds where - maybes = map do_one pairs - emitted = [id | ((id,_), Just _) <- pairs `zip` maybes] - reduced_pairs = [pair | (pair, Nothing) <- pairs `zip` maybes] - (pretties, extras_s) = unzip (catMaybes maybes) - extras = unionVarSets extras_s - (more_pretties, more_emitted, more_extras) = go_rec extras reduced_pairs - - do_one (id,rhs) = ifaceId get_idinfo needed True id rhs + od_name = tyClDeclName od + nd_name = tyClDeclName nd + new_vers' = extendNameEnv new_vers nd_name + (bumpVersion False (lookupNameEnv_NF old_vers od_name)) + + only_old d = ptext SLIT("Only in old iface:") <+> ppr d + only_new d = ptext SLIT("Only in new iface:") <+> ppr d + changed od nd = ptext SLIT("Changed in iface: ") <+> ((ptext SLIT("Old:") <+> ppr od) $$ + (ptext SLIT("New:") <+> ppr nd)) \end{code} + %************************************************************************ %* * -\subsection{Random small things} +\subsection{Writing an interface file} %* * %************************************************************************ \begin{code} -ifaceTyCons hdl tycons = hPutCol hdl upp_tycon (sortLt (<) (filter (for_iface_name . getName) tycons )) -ifaceClasses hdl classes = hPutCol hdl upp_class (sortLt (<) (filter (for_iface_name . getName) classes)) - -for_iface_name name = isLocallyDefined name && - not (isWiredInName name) - -upp_tycon tycon = ifaceTyCon tycon -upp_class clas = ifaceClass clas -\end{code} - - -\begin{code} -ifaceTyCon :: TyCon -> SDoc -ifaceTyCon tycon - | isSynTyCon tycon - = hsep [ ptext SLIT("type"), - ppr (getName tycon), - pprTyVarBndrs tyvars, - ptext SLIT("="), - ppr ty, - semi - ] +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 - (tyvars, ty) = getSynTyConDefn tycon - -ifaceTyCon tycon - | isAlgTyCon tycon - = hsep [ ptext keyword, - ppr_decl_context (tyConTheta tycon), - ppr (getName tycon), - pprTyVarBndrs (tyConTyVars tycon), - ptext SLIT("="), - hsep (punctuate (ptext SLIT(" | ")) (map ppr_con (tyConDataCons tycon))), - semi - ] + -- 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) + <+> 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)) + + , pprFixities (mi_fixities iface) (dcl_tycl decls) + , pprIfaceDecls (vers_decls version_info) decls + , pprDeprecs (mi_deprecs iface) + ] where - keyword | isNewTyCon tycon = SLIT("newtype") - | otherwise = SLIT("data") - - tyvars = tyConTyVars tycon - - ppr_con data_con - | null field_labels - = ASSERT( tycon == tycon1 && tyvars == tyvars1 ) - hsep [ ppr_ex ex_tyvars ex_theta, - ppr name, - hsep (map ppr_arg_ty (strict_marks `zip` arg_tys)) - ] - - | otherwise - = hsep [ ppr_ex ex_tyvars ex_theta, - ppr name, - braces $ hsep $ punctuate comma (map ppr_field (strict_marks `zip` field_labels)) - ] - where - (tyvars1, theta1, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con - field_labels = dataConFieldLabels data_con - strict_marks = dataConStrictMarks data_con - name = getName data_con - - ppr_ex [] ex_theta = ASSERT( null ex_theta ) empty - ppr_ex ex_tvs ex_theta = ptext SLIT("__forall") <+> brackets (pprTyVarBndrs ex_tvs) - <+> pprIfaceTheta ex_theta <+> ptext SLIT("=>") - - ppr_arg_ty (strict_mark, ty) = ppr_strict_mark strict_mark <> pprParendType ty - - ppr_strict_mark NotMarkedStrict = empty - ppr_strict_mark (MarkedUnboxed _ _) = ptext SLIT("! ! ") - ppr_strict_mark MarkedStrict = ptext SLIT("! ") - - ppr_field (strict_mark, field_label) - = hsep [ ppr (fieldLabelName field_label), - dcolon, - ppr_strict_mark strict_mark <> pprParendType (fieldLabelType field_label) - ] - -ifaceTyCon tycon - = pprPanic "pprIfaceTyDecl" (ppr tycon) - -ifaceClass clas - = hsep [ptext SLIT("class"), - ppr_decl_context sc_theta, - ppr clas, -- Print the name - pprTyVarBndrs clas_tyvars, - pp_ops, - semi - ] - where - (clas_tyvars, sc_theta, _, sel_ids, defms) = classBigSig clas - - pp_ops | null sel_ids = empty - | otherwise = hsep [ptext SLIT("where"), - braces (hsep (punctuate semi (zipWith ppr_classop sel_ids defms))) - ] - - ppr_classop sel_id maybe_defm - = ASSERT( sel_tyvars == clas_tyvars) - hsep [ppr (getOccName sel_id), - if maybeToBool maybe_defm then equals else empty, - dcolon, - ppr op_ty - ] - where - (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id) + version_info = mi_version iface + decls = mi_decls iface + exp_vers = vers_exports version_info + rule_vers = vers_rules version_info -ppr_decl_context :: ThetaType -> SDoc -ppr_decl_context [] = empty -ppr_decl_context theta = pprIfaceTheta theta <+> ptext SLIT(" =>") - -pprIfaceTheta :: ThetaType -> SDoc -- Use braces rather than parens in interface files -pprIfaceTheta [] = empty -pprIfaceTheta theta = braces (hsep (punctuate comma [pprConstraint c tys | (c,tys) <- theta])) + pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty + | otherwise = brackets (ppr exp_vers <+> ppr rule_vers) \end{code} -%************************************************************************ -%* * -\subsection{Random small things} -%* * -%************************************************************************ - When printing export lists, we print like this: Avail f f AvailTC C [C, x, y] C(x,y) AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C \begin{code} -upp_avail :: AvailInfo -> SDoc -upp_avail (Avail name) = pprOccName (getOccName name) -upp_avail (AvailTC name []) = empty -upp_avail (AvailTC name ns) = hcat [pprOccName (getOccName name), bang, upp_export ns'] - where - bang | name `elem` ns = empty - | otherwise = char '|' - ns' = filter (/= name) ns - -upp_export :: [Name] -> SDoc -upp_export [] = empty -upp_export names = braces (hsep (map (pprOccName . getOccName) names)) - -upp_fixity :: (Name, Fixity) -> SDoc -upp_fixity (name, fixity) = hsep [ptext SLIT("0"), ppr fixity, ppr name, semi] - -- Dummy version number! - -ppr_unqual_name :: NamedThing a => a -> SDoc -- Just its occurrence name -ppr_unqual_name name = pprOccName (getOccName name) -\end{code} - +pprExport :: (ModuleName, Avails) -> SDoc +pprExport (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_export [] = empty + pp_export names = braces (hsep (map pprOcc names)) -%************************************************************************ -%* * -\subsection{Comparisons} -%* * -%************************************************************************ - +pprOcc :: Name -> SDoc -- Print the occurrence name only +pprOcc n = pprOccName (nameOccName n) +\end{code} -The various sorts above simply prevent unnecessary "wobbling" when -things change that don't have to. We therefore compare lexically, not -by unique \begin{code} -lt_avail :: AvailInfo -> AvailInfo -> Bool +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 + ] <> semi + where + pp_orphan | has_orphans = char '!' + | otherwise = empty + pp_boot | is_boot = char '@' + | otherwise = empty -a1 `lt_avail` a2 = availName a1 `lt_name` availName a2 + -- 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 ] -lt_name :: Name -> Name -> Bool -n1 `lt_name` n2 = nameRdrName n1 < nameRdrName n2 + pp_export_version Nothing = empty + pp_export_version (Just v) = int v +\end{code} -lt_lexical :: NamedThing a => a -> a -> Bool -lt_lexical a1 a2 = getName a1 `lt_name` getName a2 +\begin{code} +pprIfaceDecls version_map decls + = vcat [ vcat [ppr i <+> semi | i <- dcl_insts decls] + , vcat (map ppr_decl (dcl_tycl decls)) + , pprRules (dcl_rules decls) + ] + where + ppr_decl d = ppr_vers d <+> ppr d <> semi -lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool -lt_imp_vers (m1,_,_,_) (m2,_,_,_) = m1 < m2 + -- Print the version for the decl + ppr_vers d = case lookupNameEnv version_map (tyClDeclName d) of + Nothing -> empty + Just v -> int v +\end{code} -sort_versions vs = sortLt lt_vers vs +\begin{code} +pprFixities fixity_map decls + = hsep [ ppr fix <+> ppr n + | d <- decls, + (n,_) <- tyClDeclNames d, + Just fix <- [lookupNameEnv fixity_map n]] <> semi -lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool -lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2 -\end{code} +pprRules [] = empty +pprRules rules = hsep [ptext SLIT("{-## __R"), vcat (map ppr rules), ptext SLIT("##-}")] +pprDeprecs NoDeprecs = empty +pprDeprecs deprecs = ptext SLIT("{-## __D") <+> guts <+> ptext SLIT("##-}") + where + guts = case deprecs of + DeprecAll txt -> doubleQuotes (ptext txt) + DeprecSome env -> pp_deprecs env -\begin{code} -hPutCol :: Handle - -> (a -> SDoc) - -> [a] - -> IO () -hPutCol hdl fmt xs = mapIO (printForIface hdl . fmt) xs - -mapIO :: (a -> IO b) -> [a] -> IO () -mapIO f [] = return () -mapIO f (x:xs) = f x >> mapIO f xs +pp_deprecs env = vcat (punctuate semi (map pp_deprec (nameEnvElts env))) + where + pp_deprec (name, txt) = pprOcc name <+> doubleQuotes (ptext txt) \end{code}