X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=9ff18cbceb8b61cdb6b650eb4a918bdce8c88302;hb=292c077de7dbe98eb44911648f16e243b40db2ac;hp=5b6373a27a8fcc3ca76e905fcdd3ff78f18f8133;hpb=4a91d102be99778efcab80211ca5de3f2cf6619a;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index 5b6373a..9ff18cb 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -4,59 +4,58 @@ \section[MkIface]{Print an interface for a module} \begin{code} -module MkIface ( completeIface ) where +module MkIface ( + mkModDetails, mkModDetailsFromIface, completeIface, + writeIface, pprIface + ) where #include "HsVersions.h" import HsSyn -import HsCore ( HsIdInfo(..), toUfExpr, ifaceSigName ) +import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr ) import HsTypes ( toHsTyVars ) import BasicTypes ( Fixity(..), NewOrData(..), - Version, bumpVersion, isLoopBreaker + Version, initialVersion, bumpVersion, isLoopBreaker ) import RnMonad -import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl, RenamedRuleDecl, RenamedIfaceSig ) -import HscTypes ( VersionInfo(..), IfaceDecls(..), ModIface(..), ModDetails(..), - TyThing(..), DFunId ) +import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) +import TcHsSyn ( TypecheckedRuleDecl ) +import HscTypes ( VersionInfo(..), ModIface(..), ModDetails(..), + IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts, + TyThing(..), DFunId, TypeEnv, isTyClThing, Avails, + WhatsImported(..), GenAvailInfo(..), + ImportVersion, AvailInfo, Deprecations(..) + ) import CmdLineOpts -import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, hasNoBinding, - idSpecialisation +import Id ( Id, idType, idInfo, omitIfaceSigForId, isExportedId, hasNoBinding, + idSpecialisation, idName, setIdInfo ) import Var ( isId ) import VarSet import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks ) -import IdInfo ( IdInfo, StrictnessInfo(..), ArityInfo(..), - CprInfo(..), CafInfo(..), - inlinePragInfo, arityInfo, arityLowerBound, - strictnessInfo, isBottomingStrictness, - cafInfo, specInfo, cprInfo, - occInfo, isNeverInlinePrag, - workerInfo, WorkerInfo(..) - ) -import CoreSyn ( CoreExpr, CoreBind, Bind(..), isBuiltinRule, rulesRules, rulesRhsFreeVars ) -import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) -import CoreUnfold ( okToUnfoldInHiFile, couldBeSmallEnoughToInline ) -import Name ( isLocallyDefined, getName, nameModule, - Name, NamedThing(..), - plusNameEnv, lookupNameEnv, emptyNameEnv, extendNameEnv, lookupNameEnv_NF, nameEnvElts +import IdInfo -- Lots +import CoreSyn ( CoreExpr, CoreBind, Bind(..), CoreRule(..), IdCoreRule, + isBuiltinRule, rulesRules, rulesRhsFreeVars, emptyCoreRules, + bindersOfBinds ) +import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars, mustHaveLocalBinding ) +import CoreUnfold ( okToUnfoldInHiFile, mkTopUnfolding, neverUnfold, unfoldingTemplate, noUnfolding ) +import Name ( getName, nameModule, Name, NamedThing(..) ) +import Name -- Env +import OccName ( pprOccName ) import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, - tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize + tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize, isClassTyCon ) import Class ( classExtraBigSig, DefMeth(..) ) import FieldLabel ( fieldLabelType ) import Type ( splitSigmaTy, tidyTopType, deNoteType ) - -import Rules ( ProtoCoreRule(..) ) - -import Bag ( bagToList ) -import UniqFM ( lookupUFM, listToUFM ) import SrcLoc ( noSrcLoc ) -import Bag import Outputable +import Module ( ModuleName ) import List ( partition ) +import IO ( IOMode(..), openFile, hClose ) \end{code} @@ -67,53 +66,83 @@ import List ( partition ) %************************************************************************ \begin{code} +mkModDetails :: TypeEnv -> [DFunId] -- From typechecker + -> [CoreBind] -> [Id] -- Final bindings, plus the top-level Ids from the + -- code generator; they have authoritative arity info + -> [IdCoreRule] -- Tidy orphan rules + -> ModDetails +mkModDetails type_env dfun_ids tidy_binds stg_ids orphan_rules + = ModDetails { md_types = new_type_env, + md_rules = rule_dcls, + md_insts = dfun_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, plus Ids + -- accessible from them (notably via unfoldings) + -- 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 = mkNameEnv [(getName tycl, tycl) | tycl <- orig_type_env, isTyClThing tycl] + `plusNameEnv` + mkNameEnv [(idName id, AnId id) | id <- final_ids] + + orig_type_env = nameEnvElts type_env + + final_ids = bindsToIds (mkVarSet dfun_ids `unionVarSet` orphan_rule_ids) + (mkVarSet stg_ids) + tidy_binds + + -- 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) + + orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule + | (_, rule) <- orphan_rules] + + +-- 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 -> [DFunId] -- From typechecker + -> [TypecheckedRuleDecl] + -> ModDetails +mkModDetailsFromIface type_env dfun_ids rules + = ModDetails { md_types = type_env, + md_rules = rule_dcls, + md_insts = dfun_ids } + where + rule_dcls = [(id,rule) | IfaceRuleOut id rule <- rules] + -- All the rules from an interface are of the IfaceRuleOut form + + 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 - -> [CoreBind] -> [Id] -- Final bindings, plus the top-level Ids from the - -- code generator; they have authoritative arity info - -> [ProtoCoreRule] -- Tidy orphan rules - - -> Maybe (ModIface, SDoc) -- The new one, complete with decls and versions + -> (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. - -- - -- The IO in the type is solely for debug output - -- In particular, dumping a record of what has changed completeIface maybe_old_iface new_iface mod_details - tidy_binds final_ids tidy_orphan_rules - = let - new_decls = declsFromDetails mod_details tidy_binds final_ids tidy_orphan_rules - in - addVersionInfo maybe_old_iface (new_iface { mi_decls = new_decls }) - -declsFromDetails :: ModDetails -> [CoreBind] -> [Id] -> [ProtoCoreRule] -> IfaceDecls -declsFromDetails details tidy_binds final_ids tidy_orphan_rules - = IfaceDecls { dcl_tycl = ty_cls_dcls, - dcl_insts = inst_dcls, - dcl_sigs = bagToList val_dcls, - dcl_rules = rule_dcls } - where - dfun_ids = md_insts details - inst_dcls = map ifaceInstance dfun_ids - ty_cls_dcls = map ifaceTyCls (filter emitTyCls (nameEnvElts (md_types details))) - - (val_dcls, emitted_ids) = ifaceBinds (mkVarSet dfun_ids `unionVarSet` orphan_rule_ids) - final_ids tidy_binds - - rule_dcls | opt_OmitInterfacePragmas = [] - | otherwise = ifaceRules tidy_orphan_rules emitted_ids - - orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule - | ProtoCoreRule _ _ rule <- tidy_orphan_rules] - + = addVersionInfo maybe_old_iface (new_iface { mi_decls = new_decls }) + 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) \end{code} + %************************************************************************ %* * \subsection{Types and classes} @@ -121,26 +150,21 @@ declsFromDetails details tidy_binds final_ids tidy_orphan_rules %************************************************************************ \begin{code} -emitTyCls :: TyThing -> Bool -emitTyCls (ATyCon tc) = True -- Could filter out wired in ones, but it's not - -- strictly necessary, and it costs extra time -emitTyCls (AClass cl) = True -emitTyCls (AnId _) = False - - -ifaceTyCls :: TyThing -> RenamedTyClDecl -ifaceTyCls (AClass clas) - = ClassDecl (toHsContext sc_theta) - (getName clas) - (toHsTyVars clas_tyvars) - (toHsFDs clas_fds) - (map toClassOpSig op_stuff) - EmptyMonoBinds - [] noSrcLoc +ifaceTyCls :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] +ifaceTyCls (AClass clas) so_far + = cls_decl : so_far where - (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas + cls_decl = ClassDecl (toHsContext sc_theta) + (getName clas) + (toHsTyVars clas_tyvars) + (toHsFDs clas_fds) + (map toClassOpSig op_stuff) + EmptyMonoBinds + [] noSrcLoc + + (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas - toClassOpSig (sel_id, def_meth) + toClassOpSig (sel_id, def_meth) = ASSERT(sel_tyvars == clas_tyvars) ClassOpSig (getName sel_id) (Just def_meth') (toHsType op_ty) noSrcLoc where @@ -150,22 +174,26 @@ ifaceTyCls (AClass clas) GenDefMeth -> GenDefMeth DefMeth id -> DefMeth (getName id) -ifaceTyCls (ATyCon tycon) - | isSynTyCon tycon - = TySynonym (getName tycon)(toHsTyVars tyvars) (toHsType ty) noSrcLoc +ifaceTyCls (ATyCon tycon) so_far + | isClassTyCon tycon = so_far + | otherwise = ty_decl : so_far where - (tyvars, ty) = getSynTyConDefn tycon - -ifaceTyCls (ATyCon tycon) - | isAlgTyCon tycon - = TyData new_or_data (toHsContext (tyConTheta tycon)) - (getName tycon) - (toHsTyVars tyvars) - (map ifaceConDecl (tyConDataCons tycon)) - (tyConFamilySize tycon) - Nothing noSrcLoc (panic "gen1") (panic "gen2") - where - tyvars = tyConTyVars tycon + ty_decl | isSynTyCon tycon + = TySynonym (getName tycon)(toHsTyVars tyvars) + (toHsType syn_ty) noSrcLoc + + | isAlgTyCon tycon + = TyData new_or_data (toHsContext (tyConTheta tycon)) + (getName tycon) + (toHsTyVars tyvars) + (map ifaceConDecl (tyConDataCons tycon)) + (tyConFamilySize tycon) + Nothing noSrcLoc (panic "gen1") (panic "gen2") + + | otherwise = pprPanic "ifaceTyCls" (ppr tycon) + + tyvars = tyConTyVars tycon + (_, syn_ty) = getSynTyConDefn tycon new_or_data | isNewTyCon tycon = NewType | otherwise = DataType @@ -192,7 +220,51 @@ ifaceTyCls (ATyCon tycon) mk_field strict_mark field_label = ([getName field_label], mk_bang_ty strict_mark (fieldLabelType field_label)) -ifaceTyCls (ATyCon tycon) = pprPanic "ifaceTyCls" (ppr tycon) +ifaceTyCls (AnId id) so_far + | omitIfaceSigForId id = so_far + | otherwise = iface_sig : so_far + where + iface_sig = IfaceSig (getName id) (toHsType id_type) hs_idinfo noSrcLoc + + id_type = idType id + id_info = idInfo id + + hs_idinfo | opt_OmitInterfacePragmas = [] + | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ + strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo + + ------------ Arity -------------- + arity_hsinfo = case arityInfo id_info of + a@(ArityExactly n) -> [HsArity a] + other -> [] + + ------------ Caf Info -------------- + caf_hsinfo = case cafInfo id_info of + NoCafRefs -> [HsNoCafRefs] + otherwise -> [] + + ------------ CPR Info -------------- + cpr_hsinfo = case cprInfo id_info of + ReturnsCPR -> [HsCprInfo] + NoCPRInfo -> [] + + ------------ Strictness -------------- + strict_hsinfo = case strictnessInfo id_info of + NoStrictnessInfo -> [] + info -> [HsStrictness info] + + + ------------ Worker -------------- + wrkr_hsinfo = case workerInfo id_info of + HasWorker work_id wrap_arity -> [HsWorker (getName work_id)] + NoWorker -> [] + + ------------ Unfolding -------------- + unfold_info = unfoldingInfo id_info + inline_prag = inlinePragInfo id_info + rhs = unfoldingTemplate unfold_info + unfold_hsinfo | neverUnfold unfold_info = [] + | otherwise = [HsUnfold inline_prag (toUfExpr rhs)] \end{code} @@ -202,7 +274,7 @@ ifaceTyCls (ATyCon tycon) = pprPanic "ifaceTyCls" (ppr tycon) %* * %************************************************************************ -\begin{code} +\begin{code} ifaceInstance :: DFunId -> RenamedInstDecl ifaceInstance dfun_id = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc @@ -217,152 +289,120 @@ ifaceInstance dfun_id -- instance Foo Tibble where ... -- and this instance decl wouldn't get imported into a module -- that mentioned T but not Tibble. -\end{code} -\begin{code} -ifaceRules :: [ProtoCoreRule] -> IdSet -> [RenamedRuleDecl] -ifaceRules rules emitted - = orphan_rules ++ local_rules - where - orphan_rules = [ toHsRule fn rule | ProtoCoreRule _ fn rule <- rules ] - local_rules = [ toHsRule fn rule - | fn <- varSetElems 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 +ifaceRule (id, BuiltinRule _) + = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id) - -- 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 - ] +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{Value bindings} +\subsection{Compute final Ids} %* * %************************************************************************ +A "final Id" has exactly the IdInfo for going into an interface file, or +exporting to another module. + \begin{code} -ifaceBinds :: IdSet -- These Ids are needed already - -> [Id] -- Ids used at code-gen time; they have better pragma info! +bindsToIds :: IdSet -- These Ids are needed already + -> IdSet -- Ids used at code-gen time; they have better pragma info! -> [CoreBind] -- In dependency order, later depend on earlier - -> (Bag RenamedIfaceSig, IdSet) -- Set of Ids actually spat out + -> [Id] -- Set of Ids actually spat out, complete with exactly the IdInfo + -- they need for exporting to another module -ifaceBinds needed_ids final_ids binds - = go needed_ids (reverse binds) emptyBag emptyVarSet +bindsToIds needed_ids codegen_ids binds + = go needed_ids (reverse binds) [] -- Reverse so that later things will -- provoke earlier ones to be emitted 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 - -- The 'needed' set contains the 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 - need_id needed_set id = id `elemVarSet` needed_set || isUserExportedId id + need_id needed_set id = id `elemVarSet` needed_set || isExportedId id - go needed [] decls emitted + go needed [] emitted | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:" (sep (map ppr (varSetElems needed))) - (decls, emitted) - | otherwise = (decls, emitted) - - go needed (NonRec id rhs : binds) decls emitted - | need_id needed id - = if omitIfaceSigForId id then - go (needed `delVarSet` id) binds decls (emitted `extendVarSet` id) - else - go ((needed `unionVarSet` extras) `delVarSet` id) - binds - (decl `consBag` decls) - (emitted `extendVarSet` id) - | otherwise - = go needed binds decls emitted + emitted + | otherwise = emitted + + go needed (NonRec id rhs : binds) emitted + | need_id needed id = go new_needed binds (new_id:emitted) + | otherwise = go needed binds emitted where - (decl, extras) = ifaceId get_idinfo False id rhs + (new_id, extras) = mkFinalId codegen_ids False id rhs + new_needed = (needed `unionVarSet` extras) `delVarSet` id -- 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. We don't want necessarily them all, -- because without -O we may only need the first one (if we don't emit -- its unfolding) - go needed (Rec pairs : binds) decls emitted - = go needed' binds decls' emitted' + go needed (Rec pairs : binds) emitted + = go needed' binds emitted' where - (new_decls, new_emitted, extras) = go_rec needed pairs - decls' = new_decls `unionBags` decls + (new_emitted, extras) = go_rec needed pairs needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs) - emitted' = emitted `unionVarSet` new_emitted + emitted' = new_emitted ++ emitted - go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag RenamedIfaceSig, IdSet, IdSet) + go_rec :: IdSet -> [(Id,CoreExpr)] -> ([Id], IdSet) go_rec needed pairs - | null decls = (emptyBag, emptyVarSet, emptyVarSet) - | otherwise = (more_decls `unionBags` listToBag decls, - more_emitted `unionVarSet` mkVarSet (map fst needed_prs), - more_extras `unionVarSet` extras) + | null needed_prs = ([], emptyVarSet) + | otherwise = (emitted ++ more_emitted, + extras `unionVarSet` more_extras) where - (needed_prs,leftover_prs) = partition is_needed pairs - (decls, extras_s) = unzip [ifaceId get_idinfo True id rhs - | (id,rhs) <- needed_prs, not (omitIfaceSigForId id)] - extras = unionVarSets extras_s - (more_decls, more_emitted, more_extras) = go_rec extras leftover_prs + (needed_prs,leftover_prs) = partition is_needed pairs + (emitted, extras_s) = unzip [ mkFinalId codegen_ids True id rhs + | (id,rhs) <- needed_prs, not (omitIfaceSigForId id)] + extras = unionVarSets extras_s + (more_emitted, more_extras) = go_rec extras leftover_prs + is_needed (id,_) = need_id needed id \end{code} + \begin{code} -ifaceId :: (Id -> IdInfo) -- This function "knows" the extra info added - -- by the STG passes. Sigh - -> Bool -- True <=> recursive, so don't print unfolding - -> Id - -> CoreExpr -- The Id's right hand side - -> (RenamedIfaceSig, IdSet) -- The emitted stuff, plus any *extra* needed Ids - -ifaceId get_idinfo is_rec id rhs - = (IfaceSig (getName id) (toHsType id_type) hs_idinfo noSrcLoc, new_needed_ids) +mkFinalId :: IdSet -- The Ids with arity info from the code generator + -> Bool -- True <=> recursive, so don't include unfolding + -> Id + -> CoreExpr -- The Id's right hand side + -> (Id, IdSet) -- The emitted id, plus any *extra* needed Ids + +mkFinalId codegen_ids is_rec id rhs + | omitIfaceSigForId id + = (id, emptyVarSet) -- An optimisation for top-level constructors and suchlike + | otherwise + = (id `setIdInfo` new_idinfo, new_needed_ids) where - id_type = idType id core_idinfo = idInfo id - stg_idinfo = get_idinfo id + stg_idinfo = case lookupVarSet codegen_ids id of + Just id' -> idInfo id' + Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $ + idInfo id - hs_idinfo | opt_OmitInterfacePragmas = [] - | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ - strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo + new_idinfo | opt_OmitInterfacePragmas + = constantIdInfo + | otherwise + = core_idinfo `setArityInfo` arity_info + `setCafInfo` cafInfo stg_idinfo + `setUnfoldingInfo` unfold_info + `setWorkerInfo` worker_info + `setSpecInfo` emptyCoreRules + -- We zap the specialisations because they are + -- passed on separately through the modules IdCoreRules ------------ Arity -------------- - arity_info = arityInfo stg_idinfo - stg_arity = arityLowerBound arity_info - arity_hsinfo = case arityInfo stg_idinfo of - a@(ArityExactly n) -> [HsArity a] - other -> [] - - ------------ Caf Info -------------- - caf_hsinfo = case cafInfo stg_idinfo of - NoCafRefs -> [HsNoCafRefs] - otherwise -> [] - - ------------ CPR Info -------------- - cpr_hsinfo = case cprInfo core_idinfo of - ReturnsCPR -> [HsCprInfo] - NoCPRInfo -> [] - - ------------ Strictness -------------- - strict_info = strictnessInfo core_idinfo - bottoming_fn = isBottomingStrictness strict_info - strict_hsinfo = case strict_info of - NoStrictnessInfo -> [] - info -> [HsStrictness info] - + arity_info = arityInfo stg_idinfo + stg_arity = arityLowerBound arity_info ------------ Worker -------------- -- We only treat a function as having a worker if @@ -386,26 +426,30 @@ ifaceId get_idinfo is_rec id rhs -- top level lambdas are there" in interface files; but during the -- compilation of this module it means "how many things can I apply -- this to". - work_info = workerInfo core_idinfo - HasWorker work_id _ = work_info + worker_info = case workerInfo core_idinfo of + info@(HasWorker work_id wrap_arity) + | wrap_arity == stg_arity -> info + | otherwise -> pprTrace "ifaceId: arity change:" (ppr id) + NoWorker + NoWorker -> NoWorker - has_worker = case work_info of - HasWorker work_id wrap_arity - | wrap_arity == stg_arity -> True - | otherwise -> pprTrace "ifaceId: arity change:" (ppr id) - False - - other -> False + has_worker = case worker_info of + HasWorker _ _ -> True + other -> False - wrkr_hsinfo | has_worker = [HsWorker (getName work_id)] - | otherwise = [] + HasWorker work_id _ = worker_info ------------ Unfolding -------------- inline_pragma = inlinePragInfo core_idinfo dont_inline = isNeverInlinePrag inline_pragma + loop_breaker = isLoopBreaker (occInfo core_idinfo) + bottoming_fn = isBottomingStrictness (strictnessInfo core_idinfo) - unfold_hsinfo | show_unfold = [HsUnfold inline_pragma (toUfExpr rhs)] - | otherwise = [] + unfolding = mkTopUnfolding rhs + rhs_is_small = not (neverUnfold unfolding) + + unfold_info | show_unfold = unfolding + | otherwise = noUnfolding show_unfold = not has_worker && -- Not unnecessary not bottoming_fn && -- Not necessary @@ -414,13 +458,6 @@ ifaceId get_idinfo is_rec id rhs rhs_is_small && -- Small enough okToUnfoldInHiFile rhs -- No casms etc - rhs_is_small = couldBeSmallEnoughToInline opt_UF_HiFileThreshold rhs - - ------------ Specialisations -------------- - spec_info = specInfo core_idinfo - - ------------ Occ info -------------- - loop_breaker = isLoopBreaker (occInfo core_idinfo) ------------ Extra free Ids -------------- new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet @@ -428,19 +465,46 @@ ifaceId get_idinfo is_rec id rhs unfold_ids `unionVarSet` spec_ids + spec_ids = filterVarSet interestingId (rulesRhsFreeVars (specInfo core_idinfo)) + 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 (hasNoBinding id) +interestingId id = isId id && mustHaveLocalBinding id +\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 + ] \end{code} @@ -453,7 +517,7 @@ interestingId id = isId id && isLocallyDefined id && not (hasNoBinding id) \begin{code} addVersionInfo :: Maybe ModIface -- The old interface, read from M.hi -> ModIface -- The new interface decls - -> Maybe (ModIface, SDoc) -- Nothing => no change; no need to write new Iface + -> (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 @@ -463,7 +527,7 @@ addVersionInfo :: Maybe ModIface -- The old interface, read from M.hi addVersionInfo Nothing new_iface -- No old interface, so definitely write a new one! - = Just (new_iface, text "No old interface available") + = (new_iface, Just (text "No old interface available")) addVersionInfo (Just old_iface@(ModIface { mi_version = old_version, mi_decls = old_decls, @@ -472,19 +536,19 @@ addVersionInfo (Just old_iface@(ModIface { mi_version = old_version, mi_fixities = new_fixities }) | no_output_change && no_usage_change - = Nothing + = (old_iface, Nothing) | otherwise -- Add updated version numbers - = Just (final_iface, pp_tc_diffs $$ pp_sig_diffs) + = (final_iface, Just pp_tc_diffs) where 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 = sig_vers `plusNameEnv` tc_vers } + vers_decls = tc_vers } - no_output_change = no_sig_change && no_tc_change && no_rule_change && no_export_change + no_output_change = no_tc_change && no_rule_change && no_export_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 @@ -494,42 +558,38 @@ addVersionInfo (Just old_iface@(ModIface { mi_version = old_version, -- Set the flag if anything changes. -- Assumes that the decls are sorted by hsDeclName. old_vers_decls = vers_decls old_version - (no_sig_change, pp_sig_diffs, sig_vers) = diffDecls ifaceSigName eq_sig old_vers_decls - (dcl_sigs old_decls) (dcl_sigs new_decls) - (no_tc_change, pp_tc_diffs, tc_vers) = diffDecls tyClDeclName eq_tc old_vers_decls - (dcl_tycl old_decls) (dcl_tycl new_decls) + (no_tc_change, pp_tc_diffs, tc_vers) = diffDecls old_vers_decls old_fixities new_fixities + (dcl_tycl old_decls) (dcl_tycl new_decls) - -- When seeing if two decls are the same, - -- remember to check whether any relevant fixity has changed - eq_sig i1 i2 = i1 == i2 && same_fixity (ifaceSigName i1) - eq_tc d1 d2 = d1 == d2 && all (same_fixity . fst) (tyClDeclNames d1) - same_fixity n = lookupNameEnv old_fixities n == lookupNameEnv new_fixities n -diffDecls :: (Outputable decl) - => (decl->Name) - -> (decl->decl->Bool) -- True if no change - -> NameEnv Version -- Old version map - -> [decl] -> [decl] -- Old and new decls +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 get_name eq old_vers old new +diffDecls old_vers old_fixities new_fixities old new = diff True empty emptyNameEnv old new where + -- 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 old [] = (False, pp, new_vers) 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 + = case nameOccName od_name `compare` nameOccName 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` nd -> diff ok_so_far pp new_vers ods nds - | otherwise -> diff False (pp $$ changed od nd) new_vers' 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 - od_name = get_name od - nd_name = get_name nd + od_name = tyClDeclName od + nd_name = tyClDeclName nd new_vers' = extendNameEnv new_vers nd_name (bumpVersion True (lookupNameEnv_NF old_vers od_name)) @@ -538,3 +598,136 @@ diffDecls get_name eq old_vers old new changed d nd = ptext SLIT("Changed in iface: ") <+> ((ptext SLIT("Old:") <+> ppr d) $$ (ptext SLIT("New:") <+> ppr nd)) \end{code} + + + +%************************************************************************ +%* * +\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) + <+> 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 + 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 + | otherwise = brackets (ppr exp_vers <+> ppr rule_vers) +\end{code} + +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} +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)) + +pprOcc :: Name -> SDoc -- Print the occurrence name only +pprOcc n = pprOccName (nameOccName n) +\end{code} + + +\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 + ] <> 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 ] + + -- HACK for the moment: print the export-list version even if + -- we don't use it, so that syntax of interface files doesn't change + pp_export_version Nothing = int 1 + pp_export_version (Just v) = int v +\end{code} + +\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 + + -- Print the version for the decl + ppr_vers d = case lookupNameEnv version_map (tyClDeclName d) of + Nothing -> empty + Just v -> int v +\end{code} + +\begin{code} +pprFixities fixity_map decls + = hsep [ ppr fix <+> ppr n + | d <- decls, + (n,_) <- tyClDeclNames d, + Just fix <- [lookupNameEnv fixity_map n]] <> semi + +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 + +pp_deprecs env = vcat (punctuate semi (map pp_deprec (nameEnvElts env))) + where + pp_deprec (name, txt) = pprOcc name <+> doubleQuotes (ptext txt) +\end{code}