X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=7055df9bba0f59f9e4229068cf8548467add2495;hb=711e4d7a4d65472a3a1fb35bcad8e1c9a109c728;hp=adf89db91481e5a8ace55cfb821338b8bc094634;hpb=4680bc5660fd0623f4e12af8d4a3a06af25a78f5;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index adf89db..7055df9 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 + mkFinalIface, + pprModDetails, pprIface, pprUsage, + ifaceTyThing, ) where #include "HsVersions.h" @@ -14,267 +16,296 @@ module MkIface ( import HsSyn import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr ) import HsTypes ( toHsTyVars ) -import BasicTypes ( Fixity(..), NewOrData(..), - Version, initialVersion, bumpVersion, isLoopBreaker +import TysPrim ( alphaTyVars ) +import BasicTypes ( NewOrData(..), Activation(..), + Version, initialVersion, bumpVersion ) +import NewDemand ( isTopSig ) import RnMonad import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) -import TcHsSyn ( TypecheckedRuleDecl ) import HscTypes ( VersionInfo(..), ModIface(..), ModDetails(..), + ModuleLocation(..), GhciMode(..), FixityEnv, lookupFixity, IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts, - TyThing(..), DFunId, TypeEnv, isTyClThing, Avails, + TyThing(..), DFunId, Avails, TypeEnv, WhatsImported(..), GenAvailInfo(..), - ImportVersion, AvailInfo, Deprecations(..) + ImportVersion, AvailInfo, Deprecations(..), + lookupVersion, typeEnvIds ) import CmdLineOpts -import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, hasNoBinding, - idSpecialisation, idName, setIdInfo +import Id ( idType, idInfo, isImplicitId, idCgInfo, + isLocalId, idName, ) -import Var ( isId ) -import VarSet -import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks ) +import DataCon ( dataConId, dataConSig, dataConFieldLabels, dataConStrictMarks ) import IdInfo -- Lots -import CoreSyn ( CoreExpr, CoreBind, Bind(..), CoreRule(..), IdCoreRule, - isBuiltinRule, rulesRules, rulesRhsFreeVars, emptyCoreRules, - bindersOfBinds - ) -import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) -import CoreUnfold ( okToUnfoldInHiFile, mkTopUnfolding, neverUnfold, unfoldingTemplate, noUnfolding ) -import Name ( isLocallyDefined, getName, - Name, NamedThing(..) - ) -import Name -- Env +import Var ( Var ) +import CoreSyn ( CoreRule(..), IdCoreRule ) +import CoreFVs ( ruleLhsFreeNames ) +import CoreUnfold ( neverUnfold, unfoldingTemplate ) +import PprCore ( pprIdCoreRule ) +import Name ( getName, nameModule, toRdrName, isGlobalName, + nameIsLocalOrFrom, Name, NamedThing(..) ) +import NameEnv +import NameSet import OccName ( pprOccName ) -import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, - tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize - ) -import Class ( classExtraBigSig, DefMeth(..) ) +import TyCon +import Class ( classExtraBigSig, classTyCon, DefMeth(..) ) import FieldLabel ( fieldLabelType ) -import Type ( splitSigmaTy, tidyTopType, deNoteType ) +import TcType ( tcSplitSigmaTy, tidyTopType, deNoteType, namesOfDFunHead ) import SrcLoc ( noSrcLoc ) import Outputable import Module ( ModuleName ) +import Util ( sortLt, dropList ) +import ErrUtils ( dumpIfSet_dyn ) -import List ( partition ) +import Monad ( when ) +import Maybe ( catMaybes ) import IO ( IOMode(..), openFile, hClose ) \end{code} %************************************************************************ %* * -\subsection{Write a new interface file} +\subsection{Completing an interface} %* * %************************************************************************ \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, and Ids with correct IdInfo - -- gotten from the bindings - -- From (b) 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 } + + + +mkFinalIface :: GhciMode + -> DynFlags + -> ModuleLocation + -> Maybe ModIface -- The old interface, if we have it + -> ModIface -- The new one, minus the decls and versions + -> ModDetails -- The ModDetails for this 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 + +mkFinalIface ghci_mode dflags location maybe_old_iface + new_iface@ModIface{ mi_module=mod } + new_details@ModDetails{ md_insts=insts, + md_rules=rules, + md_types=types } + = do { + -- Add the new declarations, and the is-orphan flag + let iface_w_decls = new_iface { mi_decls = new_decls, + mi_orphan = orphan_mod } + + -- 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) + (writeIface hi_file_path final_iface) + + -- Debug printing + ; write_diffs dflags final_iface maybe_diffs + + ; orphan_mod `seq` + return final_iface } + 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 - -> (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 }) + 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 mod new_details + +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 :: Module -> ModDetails -> Bool +isOrphanModule this_mod (ModDetails {md_insts = insts, md_rules = rules}) + = any orphan_inst insts || any orphan_rule rules 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) + orphan_inst dfun_id = no_locals (namesOfDFunHead (idType dfun_id)) + 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. -%************************************************************************ -%* * -\subsection{Types and classes} -%* * -%************************************************************************ +\begin{code} +ifaceTyThing_acc :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] +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} -ifaceTyCls :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] -ifaceTyCls (AClass clas) so_far - = cls_decl : so_far +ifaceTyThing :: TyThing -> RenamedTyClDecl +ifaceTyThing (AClass clas) = cls_decl where - 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 + 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) (Just 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) + (sel_tyvars, _, op_ty) = tcSplitSigmaTy (idType sel_id) def_meth' = case def_meth of NoDefMeth -> NoDefMeth GenDefMeth -> GenDefMeth DefMeth id -> DefMeth (getName id) -ifaceTyCls (ATyCon tycon) so_far - = ty_decl : so_far - +ifaceTyThing (ATyCon tycon) = ty_decl where ty_decl | isSynTyCon tycon - = TySynonym (getName tycon)(toHsTyVars tyvars) - (toHsType syn_ty) noSrcLoc + = TySynonym { tcdName = getName tycon, + tcdTyVars = toHsTyVars tyvars, + tcdSynRhs = toHsType syn_ty, + tcdLoc = 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) + = TyData { tcdND = new_or_data, + tcdCtxt = toHsContext (tyConTheta tycon), + tcdName = getName tycon, + tcdTyVars = toHsTyVars tyvars, + tcdCons = ifaceConDecls (tyConDataConDetails tycon), + tcdDerivs = Nothing, + tcdSysNames = map getName (tyConGenIds tycon), + 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 (take (tyConArity tycon) alphaTyVars), + tcdCons = Unknown, + tcdDerivs = Nothing, + tcdSysNames = [], + tcdLoc = noSrcLoc } + + | 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) (error "ifaceConDecl") + = 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 + 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) + VanillaCon (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 - | omitIfaceSigForId id = so_far - | otherwise = iface_sig : so_far +ifaceTyThing (AnId id) = iface_sig where - iface_sig = IfaceSig (getName id) (toHsType id_type) hs_idinfo noSrcLoc + iface_sig = IfaceSig { tcdName = getName id, + tcdType = toHsType id_type, + tcdIdInfo = hs_idinfo, + tcdLoc = noSrcLoc } id_type = idType id id_info = idInfo id + cg_info = idCgInfo id + arity_info = arityInfo id_info + caf_info = cgCafInfo cg_info - 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 -------------- - wrkr_hsinfo = case workerInfo id_info of - HasWorker work_id wrap_arity -> [HsWorker (getName work_id)] - NoWorker -> [] + 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 -> + Just (HsWorker (getName work_id) wrap_arity) + NoWorker -> Nothing ------------ 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 = [] - | otherwise = [HsUnfold inline_prag (toUfExpr rhs)] + unfold_hsinfo | neverUnfold unfold_info + || has_worker = Nothing + | otherwise = Just (HsUnfold inline_prag (toUfExpr rhs)) \end{code} - -%************************************************************************ -%* * -\subsection{Instances and rules} -%* * -%************************************************************************ - \begin{code} ifaceInstance :: DFunId -> RenamedInstDecl ifaceInstance dfun_id @@ -291,221 +322,17 @@ 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 pat +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 pat bogusIfaceRule id - = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc -\end{code} - - -%************************************************************************ -%* * -\subsection{Compute final Ids} -%* * -%************************************************************************ - -A "final Id" has exactly the IdInfo for going into an interface file, or -exporting to another module. - -\begin{code} -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 - -> [Id] -- Set of Ids actually spat out, complete with exactly the IdInfo - -- they need for exporting to another module - -bindsToIds needed_ids codegen_ids binds - = go needed_ids (reverse binds) [] - -- Reverse so that later things will - -- provoke earlier ones to be emitted - where - -- 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 - - go needed [] emitted - | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:" - (sep (map ppr (varSetElems needed))) - 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 - (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) emitted - = go needed' binds emitted' - where - (new_emitted, extras) = go_rec needed pairs - needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs) - emitted' = new_emitted ++ emitted - - go_rec :: IdSet -> [(Id,CoreExpr)] -> ([Id], IdSet) - go_rec needed pairs - | null needed_prs = ([], emptyVarSet) - | otherwise = (emitted ++ more_emitted, - extras `unionVarSet` more_extras) - where - (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} -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 - core_idinfo = idInfo id - stg_idinfo = case lookupVarSet codegen_ids id of - Just id' -> idInfo id' - Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $ - idInfo id - - new_idinfo | opt_OmitInterfacePragmas - = vanillaIdInfo - | 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 - - ------------ Worker -------------- - -- We only treat a function as having a worker if - -- the exported arity (which is now the number of visible lambdas) - -- is the same as the arity at the moment of the w/w split - -- If so, we can safely omit the unfolding inside the wrapper, and - -- instead re-generate it from the type/arity/strictness info - -- But if the arity has changed, we just take the simple path and - -- put the unfolding into the interface file, forgetting the fact - -- that it's a wrapper. - -- - -- How can this happen? Sometimes we get - -- f = coerce t (\x y -> $wf x y) - -- at the moment of w/w split; but the eta reducer turns it into - -- f = coerce t $wf - -- which is perfectly fine except that the exposed arity so far as - -- the code generator is concerned (zero) differs from the arity - -- when we did the split (2). - -- - -- All this arises because we use 'arity' to mean "exactly how many - -- 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". - 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 worker_info of - HasWorker _ _ -> True - other -> False - - 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) - - 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 - not dont_inline && - not loop_breaker && - rhs_is_small && -- Small enough - okToUnfoldInHiFile rhs -- No casms etc - - - ------------ Extra free Ids -------------- - new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet - | otherwise = worker_ids `unionVarSet` - 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 - - unfold_ids | show_unfold = find_fvs rhs - | otherwise = emptyVarSet - - find_fvs expr = exprSomeFreeVars interestingId expr - -interestingId id = isId id && isLocallyDefined id && not (hasNoBinding 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 - ] + = IfaceRule SLIT("bogus") NeverActive [] (getName id) [] (UfVar (getName id)) noSrcLoc \end{code} @@ -530,80 +357,150 @@ 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 })) - new_iface@(ModIface { mi_decls = new_decls, - mi_fixities = new_fixities }) +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 - = (old_iface, Nothing) + = (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 - = (final_iface, Just pp_tc_diffs) + = --pprTrace "completeIface" (ppr (dcl_tycl old_decls)) + (final_iface, Just pp_diffs) where final_iface = new_iface { mi_version = new_version } - new_version = VersionInfo { vers_module = bumpVersion no_output_change (vers_module old_version), + old_mod_vers = vers_module old_version + new_version = VersionInfo { vers_module = bumpVersion no_output_change old_mod_vers, 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_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 + (no_tc_change, pp_tc_diffs, tc_vers) = diffDecls old_version old_fixities new_fixities (dcl_tycl old_decls) (dcl_tycl new_decls) - - - -diffDecls :: NameEnv Version -- Old version map - -> NameEnv Fixity -> NameEnv Fixity -- Old and new fixities + 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 :: VersionInfo -- Old version + -> FixityEnv -> FixityEnv -- Old and new fixities -> [RenamedTyClDecl] -> [RenamedTyClDecl] -- Old and new decls -> (Bool, -- True <=> no change SDoc, -- Record of differences - NameEnv Version) -- New version + NameEnv Version) -- New version map -diffDecls old_vers old_fixities new_fixities old new +diffDecls (VersionInfo { vers_module = old_mod_vers, vers_decls = old_decls_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 + 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 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) [] = 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_with_new [] nds + where + new_vers_with_new = extendNameEnv new_vers (tyClDeclName nd) (bumpVersion False old_mod_vers) + -- When adding a new item, start from the old module version + -- This way, if you have version 4 of f, then delete f, then add f again, + -- you'll get version 6 of f, which will (correctly) force recompilation of + -- clients + diff ok_so_far pp new_vers (od:ods) (nd:nds) - = case nameOccName od_name `compare` nameOccName nd_name of + = 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 + EQ | od `eq_tc` nd -> diff ok_so_far pp new_vers ods nds + | otherwise -> diff False (pp $$ changed od nd) new_vers_with_diff ods nds where od_name = tyClDeclName od nd_name = tyClDeclName nd - new_vers' = extendNameEnv new_vers nd_name - (bumpVersion True (lookupNameEnv_NF old_vers od_name)) + new_vers_with_diff = extendNameEnv new_vers nd_name (bumpVersion False old_version) + old_version = lookupVersion old_decls_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 d nd = ptext SLIT("Changed in iface: ") <+> ((ptext SLIT("Old:") <+> ppr d) $$ - (ptext SLIT("New:") <+> ppr nd)) + 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{Writing ModDetails} +%* * +%************************************************************************ + +\begin{code} +pprModDetails :: ModDetails -> SDoc +pprModDetails (ModDetails { md_types = type_env, md_insts = dfun_ids, md_rules = rules }) + = vcat [ dump_types dfun_ids type_env + , dump_insts dfun_ids + , dump_rules rules] + +dump_types :: [Var] -> TypeEnv -> SDoc +dump_types dfun_ids type_env + = text "TYPE SIGNATURES" $$ nest 4 (dump_sigs ids) + where + ids = [id | id <- typeEnvIds type_env, want_sig id] + want_sig id | opt_PprStyle_Debug = True + | otherwise = isLocalId id && + isGlobalName (idName id) && + not (id `elem` dfun_ids) + -- isLocalId ignores data constructors, records selectors etc + -- The isGlobalName ignores local dictionary and method bindings + -- that the type checker has invented. User-defined things have + -- Global names. + +dump_insts :: [Var] -> SDoc +dump_insts [] = empty +dump_insts dfun_ids = text "INSTANCES" $$ nest 4 (dump_sigs dfun_ids) + +dump_sigs :: [Var] -> SDoc +dump_sigs ids + -- Print type signatures + -- Convert to HsType so that we get source-language style printing + -- And sort by RdrName + = vcat $ map ppr_sig $ sortLt lt_sig $ + [ (toRdrName id, toHsType (idType id)) + | id <- ids ] + where + lt_sig (n1,_) (n2,_) = n1 < n2 + ppr_sig (n,t) = ppr n <+> dcolon <+> ppr t + +dump_rules :: [IdCoreRule] -> SDoc +dump_rules [] = empty +dump_rules rs = vcat [ptext SLIT("{-# RULES"), + nest 4 (vcat (map pprIdCoreRule rs)), + ptext SLIT("#-}")] +\end{code} + + +%************************************************************************ +%* * \subsection{Writing an interface file} %* * %************************************************************************ @@ -612,14 +509,18 @@ diffDecls old_vers old_fixities new_fixities old new writeIface :: FilePath -> ModIface -> IO () writeIface hi_path mod_iface = do { if_hdl <- openFile hi_path WriteMode - ; printForIface if_hdl (pprIface mod_iface) + ; 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 (ptext (mi_package iface)) <+> ppr (mi_module iface) <+> ppr (vers_module version_info) <+> pp_sub_vers <+> (if mi_orphan iface then char '!' else empty) @@ -631,7 +532,7 @@ pprIface iface , pprFixities (mi_fixities iface) (dcl_tycl decls) , pprIfaceDecls (vers_decls version_info) decls - , pprDeprecs (mi_deprecs iface) + , pprRulesAndDeprecs (dcl_rules decls) (mi_deprecs iface) ] where version_info = mi_version iface @@ -655,7 +556,7 @@ pprExport (mod, items) where pp_avail :: AvailInfo -> SDoc pp_avail (Avail name) = pprOcc name - pp_avail (AvailTC n []) = empty + pp_avail (AvailTC _ []) = empty pp_avail (AvailTC n (n':ns)) | n==n' = pprOcc n <> pp_export ns | otherwise = pprOcc n <> char '|' <> pp_export (n':ns) @@ -686,17 +587,15 @@ pprUsage (m, has_orphans, is_boot, whats_imported) 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 Nothing = empty pp_export_version (Just v) = int v \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)) - , pprRules (dcl_rules decls) ] where ppr_decl d = ppr_vers d <+> ppr d <> semi @@ -708,23 +607,35 @@ pprIfaceDecls version_map decls \end{code} \begin{code} +pprFixities :: (Outputable a) + => NameEnv a + -> [TyClDecl Name pat] + -> SDoc 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 -> 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 <+> ptext txt +-- 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("##-}") + where + pp_rules [] = empty + pp_rules rules = ptext SLIT("__R") <+> vcat (map ppr rules) + + pp_deprecs NoDeprecs = empty + pp_deprecs deprecs = ptext SLIT("__D") <+> guts + where + guts = case deprecs of + DeprecAll txt -> doubleQuotes (ptext txt) + DeprecSome env -> ppr_deprec_env env + +ppr_deprec_env :: NameEnv (Name, FAST_STRING) -> SDoc +ppr_deprec_env env = vcat (punctuate semi (map pp_deprec (nameEnvElts env))) + where + pp_deprec (name, txt) = pprOcc name <+> doubleQuotes (ptext txt) \end{code}