X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;ds=sidebyside;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=8540f9f5f4936e1e315e4ff166e8057f414749dc;hb=2ffefc1bfca0c8924825cd15750e7ced457f3c81;hp=678aaec0801b0ec72f81e89099992290bd6013f0;hpb=cae34044d89a87bd3da83b0e867b4a5d6994079a;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index 678aaec..8540f9f 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -4,73 +4,59 @@ \section[MkIface]{Print an interface for a module} \begin{code} -module MkIface ( writeIface ) where +module MkIface ( + mkModDetails, mkModDetailsFromIface, completeIface, + writeIface, pprIface + ) where #include "HsVersions.h" -import IO ( Handle, hPutStr, openFile, - hClose, hPutStrLn, IOMode(..) ) - import HsSyn -import HsCore ( HsIdInfo(..), toUfExpr ) -import RdrHsSyn ( RdrNameRuleDecl ) -import HsPragmas ( DataPragmas(..), ClassPragmas(..) ) +import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr ) import HsTypes ( toHsTyVars ) -import BasicTypes ( Fixity(..), FixityDirection(..), NewOrData(..), - Version, bumpVersion, initialVersion, isLoopBreaker +import BasicTypes ( Fixity(..), NewOrData(..), + Version, initialVersion, bumpVersion, isLoopBreaker ) import RnMonad - -import TcInstUtil ( InstInfo(..) ) +import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) +import TcHsSyn ( TypecheckedRuleDecl ) +import HscTypes ( VersionInfo(..), IfaceDecls(..), ModIface(..), ModDetails(..), + TyThing(..), DFunId, TypeEnv, isTyClThing, Avails, + WhatsImported(..), GenAvailInfo(..), + ImportVersion, AvailInfo, Deprecations(..) + ) import CmdLineOpts import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, hasNoBinding, - idSpecialisation + idSpecialisation, idName, setIdInfo ) import Var ( isId ) import VarSet import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks ) -import IdInfo ( IdInfo, StrictnessInfo(..), ArityInfo(..), InlinePragInfo(..), - CprInfo(..), CafInfo(..), - inlinePragInfo, arityInfo, arityLowerBound, - strictnessInfo, isBottomingStrictness, - cafInfo, specInfo, cprInfo, - occInfo, isNeverInlinePrag, - workerExists, workerInfo, WorkerInfo(..) +import IdInfo -- Lots +import CoreSyn ( CoreExpr, CoreBind, Bind(..), CoreRule(..), IdCoreRule, + isBuiltinRule, rulesRules, rulesRhsFreeVars, emptyCoreRules, + bindersOfBinds ) -import CoreSyn ( CoreExpr, CoreBind, Bind(..), isBuiltinRule, rulesRules, rulesRhsFreeVars ) import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) -import CoreUnfold ( okToUnfoldInHiFile, couldBeSmallEnoughToInline ) -import Module ( moduleString, pprModule, pprModuleName, moduleUserString ) -import Name ( isLocallyDefined, isWiredInName, toRdrName, nameModule, +import CoreUnfold ( okToUnfoldInHiFile, mkTopUnfolding, neverUnfold, unfoldingTemplate, noUnfolding ) +import Name ( isLocallyDefined, getName, Name, NamedThing(..) ) -import OccName ( OccName, pprOccName ) +import Name -- Env +import OccName ( pprOccName ) import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize ) -import Class ( Class, classExtraBigSig ) -import FieldLabel ( fieldLabelName, fieldLabelType ) -import Type ( mkSigmaTy, splitSigmaTy, mkDictTy, tidyTopType, - deNoteType, classesToPreds, - Type, ThetaType, PredType(..), ClassContext - ) - -import PprType -import Rules ( pprProtoCoreRule, ProtoCoreRule(..) ) - -import Bag ( bagToList, isEmptyBag ) -import Maybes ( catMaybes, maybeToBool ) -import UniqFM ( lookupUFM, listToUFM ) -import Util ( sortLt, mapAccumL ) +import Class ( classExtraBigSig, DefMeth(..) ) +import FieldLabel ( fieldLabelType ) +import Type ( splitSigmaTy, tidyTopType, deNoteType ) import SrcLoc ( noSrcLoc ) -import Bag import Outputable -import ErrUtils ( dumpIfSet ) +import Module ( ModuleName ) -import Maybe ( isNothing ) import List ( partition ) -import Monad ( when ) +import IO ( IOMode(..), openFile, hClose ) \end{code} @@ -81,310 +67,222 @@ import Monad ( when ) %************************************************************************ \begin{code} -writeIface this_mod old_iface new_iface - local_tycons local_classes inst_info - final_ids tidy_binds tidy_orphan_rules - = - if isNothing opt_HiDir && isNothing opt_HiFile - then return () -- not producing any .hi file - else - - let - hi_suf = case opt_HiSuf of { Nothing -> "hi"; Just suf -> suf } - filename = case opt_HiFile of { - Just f -> f; - Nothing -> - case opt_HiDir of { - Just dir -> dir ++ '/':moduleUserString this_mod - ++ '.':hi_suf; - Nothing -> panic "writeIface" - }} - in - - do maybe_final_iface <- checkIface old_iface full_new_iface - case maybe_final_iface of { - Nothing -> when opt_D_dump_rn_trace $ - putStrLn "Interface file unchanged" ; -- No need to update .hi file - - Just final_iface -> - - do let mod_vers_unchanged = case old_iface of - Just iface -> pi_vers iface == pi_vers final_iface - Nothing -> False - when (mod_vers_unchanged && opt_D_dump_rn_trace) $ - putStrLn "Module version unchanged, but usages differ; hence need new hi file" - - if_hdl <- openFile filename WriteMode - printForIface if_hdl (pprIface final_iface) - hClose if_hdl - } +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 - full_new_iface = completeIface new_iface local_tycons local_classes - inst_info final_ids tidy_binds - tidy_orphan_rules -\end{code} - - -%************************************************************************ -%* * -\subsection{Checking if the new interface is up to date -%* * -%************************************************************************ - -\begin{code} -checkIface :: Maybe ParsedIface -- The old interface, read from M.hi - -> ParsedIface -- The new interface; but with all version numbers = 1 - -> IO (Maybe ParsedIface) -- Nothing => no change; no need to write new Iface - -- Just pi => Here is the new interface to write - -- with correct version numbers - -- The I/O part is just so it can print differences - --- NB: the fixities, declarations, rules are all assumed --- to be sorted by increasing order of hsDeclName, so that --- we can compare for equality - -checkIface Nothing new_iface --- No old interface, so definitely write a new one! - = return (Just new_iface) - -checkIface (Just iface) new_iface - | no_output_change && no_usage_change - = return Nothing - - | otherwise -- Add updated version numbers - = do { dumpIfSet opt_D_dump_hi_diffs "Interface file changes" pp_diffs ; - return (Just new_iface )} - + -- 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 } where - final_iface = new_iface { pi_vers = new_mod_vers, - pi_fixity = (new_fixity_vers, new_fixities), - pi_rules = (new_rules_vers, new_rules), - pi_decls = final_decls } - - no_usage_change = pi_usages iface == pi_usages new_iface - - no_output_change = no_decl_changed && - new_fixity_vers == fixity_vers && - new_rules_vers == rules_vers && - no_export_change - - no_export_change = pi_exports iface == pi_exports new_iface - - new_mod_vers | no_output_change = mod_vers - | otherwise = bumpVersion mod_vers - - mod_vers = pi_vers iface - - (fixity_vers, fixities) = pi_fixity iface - (_, new_fixities) = pi_fixity new_iface - new_fixity_vers | fixities == new_fixities = fixity_vers - | otherwise = bumpVersion fixity_vers - - (rules_vers, rules) = pi_rules iface - (_, new_rules) = pi_rules new_iface - new_rules_vers | rules == new_rules = rules_vers - | otherwise = bumpVersion rules_vers - - (no_decl_changed, pp_diffs, final_decls) = merge_decls True empty [] (pi_decls iface) (pi_decls new_iface) - - -- 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 - merge_decls ok_so_far pp acc [] [] = (ok_so_far, pp, reverse acc) - merge_decls ok_so_far pp acc old [] = (False, pp, reverse acc) - merge_decls ok_so_far pp acc [] (nvd:nvds) = merge_decls False (pp $$ only_new nvd) (nvd:acc) [] nvds - merge_decls ok_so_far pp acc (vd@(v,d):vds) (nvd@(_,nd):nvds) - = case d_name `compare` nd_name of - LT -> merge_decls False (pp $$ only_old vd) acc vds (nvd:nvds) - GT -> merge_decls False (pp $$ only_new nvd) (nvd:acc) (vd:vds) nvds - EQ | d == nd -> merge_decls ok_so_far pp (vd:acc) vds nvds - | otherwise -> merge_decls False (pp $$ changed d nd) ((bumpVersion v, nd):acc) vds nvds - where - d_name = hsDeclName d - nd_name = hsDeclName nd + 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 }) + where + new_decls = IfaceDecls { dcl_tycl = ty_cls_dcls, + dcl_insts = inst_dcls, + dcl_rules = rule_dcls } - 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)) + 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{Printing the interface} +\subsection{Types and classes} %* * %************************************************************************ \begin{code} -pprIface (ParsedIface { pi_mod = mod, pi_vers = mod_vers, pi_orphan = orphan, - pi_usages = usages, pi_exports = exports, - pi_fixity = (fix_vers, fixities), - pi_insts = insts, pi_decls = decls, - pi_rules = (rule_vers, rules), pi_deprecs = deprecs }) - = vcat [ ptext SLIT("__interface") - <+> doubleQuotes (ptext opt_InPackage) - <+> ppr mod <+> ppr mod_vers <+> pp_sub_vers - <+> (if orphan then char '!' else empty) - <+> int opt_HiVersion - <+> ptext SLIT("where") - , vcat (map pprExport exports) - , vcat (map pprUsage usages) - , pprFixities fixities - , vcat [ppr i <+> semi | i <- insts] - , vcat [ppr_vers v <+> ppr d <> semi | (v,d) <- decls] - , pprRules rules - , pprDeprecs deprecs - ] +ifaceTyCls :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] +ifaceTyCls (AClass clas) so_far + = cls_decl : so_far where - ppr_vers v | v == initialVersion = empty - | otherwise = int v - pp_sub_vers - | fix_vers == initialVersion && rule_vers == initialVersion = empty - | otherwise = brackets (ppr fix_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 + 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) + = ASSERT(sel_tyvars == clas_tyvars) + ClassOpSig (getName sel_id) (Just 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) -\begin{code} -pprExport :: ExportItem -> SDoc -pprExport (mod, items) - = hsep [ ptext SLIT("__export "), ppr mod, hsep (map upp_avail items) ] <> semi +ifaceTyCls (ATyCon tycon) so_far + = ty_decl : so_far + where - upp_avail :: RdrAvailInfo -> SDoc - upp_avail (Avail name) = pprOccName name - upp_avail (AvailTC name []) = empty - upp_avail (AvailTC name ns) = hcat [pprOccName name, bang, upp_export ns'] - where - bang | name `elem` ns = empty - | otherwise = char '|' - ns' = filter (/= name) ns - - upp_export [] = empty - upp_export names = braces (hsep (map pprOccName names)) -\end{code} + 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 + ifaceConDecl data_con + = ConDecl (getName data_con) (error "ifaceConDecl") + (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) -\begin{code} -pprUsage :: ImportVersion OccName -> SDoc -pprUsage (m, has_orphans, is_boot, whats_imported) - = hsep [ptext SLIT("import"), pprModuleName m, - pp_orphan, pp_boot, - upp_import_versions whats_imported - ] <> semi - where - pp_orphan | has_orphans = char '!' - | otherwise = empty - pp_boot | is_boot = char '@' - | otherwise = empty + | otherwise + = RecCon (zipWith mk_field strict_marks field_labels) - -- Importing the whole module is indicated by an empty list - upp_import_versions NothingAtAll = empty - upp_import_versions (Everything v) = dcolon <+> int v - upp_import_versions (Specifically vm vf vr nvs) - = dcolon <+> int vm <+> int vf <+> int vr <+> hsep [ ppr n <+> int v | (n,v) <- nvs ] -\end{code} + 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)) -\begin{code} -pprFixities [] = empty -pprFixities fixes = hsep (map ppr fixes) <> semi +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 -pprRules [] = empty -pprRules rules = hsep [ptext SLIT("{-## __R"), hsep (map ppr rules), ptext SLIT("##-}")] + id_type = idType id + id_info = idInfo id -pprDeprecs [] = empty -pprDeprecs deps = hsep [ ptext SLIT("{-## __D"), guts, ptext SLIT("##-}")] - where - guts = hsep [ ppr ie <+> doubleQuotes (ppr txt) <> semi - | Deprecation ie txt _ <- deps ] -\end{code} + 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 -> [] -%************************************************************************ -%* * -\subsection{Completing the new interface} -%* * -%************************************************************************ + ------------ Caf Info -------------- + caf_hsinfo = case cafInfo id_info of + NoCafRefs -> [HsNoCafRefs] + otherwise -> [] -\begin{code} -completeIface new_iface local_tycons local_classes - inst_info final_ids tidy_binds - tidy_orphan_rules - = new_iface { pi_decls = [(initialVersion,d) | d <- sortLt lt_decl all_decls], - pi_insts = sortLt lt_inst_decl inst_dcls, - pi_rules = (initialVersion, rule_dcls) - } - where - all_decls = cls_dcls ++ ty_dcls ++ bagToList val_dcls - (inst_dcls, inst_ids) = ifaceInstances inst_info - cls_dcls = map ifaceClass local_classes - - ty_dcls = map ifaceTyCon (filter (not . isWiredInName . getName) local_tycons) + ------------ CPR Info -------------- + cpr_hsinfo = case cprInfo id_info of + ReturnsCPR -> [HsCprInfo] + NoCPRInfo -> [] - (val_dcls, emitted_ids) = ifaceBinds (inst_ids `unionVarSet` orphan_rule_ids) - final_ids tidy_binds + ------------ Strictness -------------- + strict_hsinfo = case strictnessInfo id_info of + NoStrictnessInfo -> [] + info -> [HsStrictness info] - rule_dcls | opt_OmitInterfacePragmas = [] - | otherwise = ifaceRules tidy_orphan_rules emitted_ids - orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule - | ProtoCoreRule _ _ rule <- tidy_orphan_rules] + ------------ Worker -------------- + wrkr_hsinfo = case workerInfo id_info of + HasWorker work_id wrap_arity -> [HsWorker (getName work_id)] + NoWorker -> [] -lt_decl d1 d2 = hsDeclName d1 < hsDeclName d2 -lt_inst_decl d1 d2 = instDeclName d1 < instDeclName d2 - -- Even instance decls have names, namely the dfun name + ------------ 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} %************************************************************************ %* * -\subsection{Completion stuff} +\subsection{Instances and rules} %* * %************************************************************************ \begin{code} -ifaceRules :: [ProtoCoreRule] -> IdSet -> [RdrNameRuleDecl] -ifaceRules rules emitted - = orphan_rules ++ local_rules +ifaceInstance :: DFunId -> RenamedInstDecl +ifaceInstance dfun_id + = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc 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 - - -- 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 - 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} - -\begin{code} -ifaceInstances :: Bag InstInfo -> ([RdrNameInstDecl], IdSet) - -- The IdSet is the needed dfuns - -ifaceInstances inst_infos - = (decls, needed_ids) - where - decls = map to_decl togo_insts - 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 - - ------- - to_decl (InstInfo clas tvs tys theta dfun_id _ _ _) - = let + 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 @@ -394,204 +292,120 @@ ifaceInstances 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 (classesToPreds theta) - (deNoteType (mkDictTy clas tys)) - tidy_ty = tidyTopType forall_ty - in - InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (toRdrName dfun_id)) noSrcLoc -\end{code} -\begin{code} -ifaceTyCon :: TyCon -> RdrNameHsDecl -ifaceTyCon tycon - | isSynTyCon tycon - = TyClD (TySynonym (toRdrName tycon) - (toHsTyVars tyvars) (toHsType ty) - noSrcLoc) - where - (tyvars, ty) = getSynTyConDefn tycon - -ifaceTyCon tycon - | isAlgTyCon tycon - = TyClD (TyData new_or_data (toHsContext (tyConTheta tycon)) - (toRdrName tycon) - (toHsTyVars tyvars) - (map ifaceConDecl (tyConDataCons tycon)) - (tyConFamilySize tycon) - Nothing NoDataPragmas noSrcLoc) - where - tyvars = tyConTyVars tycon - new_or_data | isNewTyCon tycon = NewType - | otherwise = DataType +ifaceRule (id, BuiltinRule _) + = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id) - ifaceConDecl data_con - = ConDecl (toRdrName data_con) (error "ifaceConDecl") - (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) +ifaceRule (id, Rule name bndrs args rhs) + = IfaceRule name (map toUfBndr bndrs) (getName id) + (map toUfExpr args) (toUfExpr rhs) noSrcLoc - mk_field strict_mark field_label - = ([toRdrName field_label], mk_bang_ty strict_mark (fieldLabelType field_label)) - -ifaceTyCon tycon - = pprPanic "pprIfaceTyDecl" (ppr tycon) - -ifaceClass clas - = TyClD (ClassDecl (toHsContext sc_theta) - (toRdrName clas) - (toHsTyVars clas_tyvars) - (toHsFDs clas_fds) - (map toClassOpSig op_stuff) - EmptyMonoBinds NoClassPragmas - bogus bogus bogus [] noSrcLoc - ) - where - bogus = error "ifaceClass" - (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas - - toClassOpSig (sel_id, dm_id, explicit_dm) - = ASSERT( sel_tyvars == clas_tyvars) - ClassOpSig (toRdrName sel_id) (Just (bogus, explicit_dm)) (toHsType op_ty) noSrcLoc - where - (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id) +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 RdrNameHsDecl, 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 - 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 RdrNameHsDecl, 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 - -> (RdrNameHsDecl, IdSet) -- The emitted stuff, plus any *extra* needed Ids - -ifaceId get_idinfo is_rec id rhs - = (SigD (IfaceSig (toRdrName 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 + = 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 - 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 @@ -615,26 +429,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 (toRdrName 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) + + unfolding = mkTopUnfolding rhs + rhs_is_small = neverUnfold unfolding - unfold_hsinfo | show_unfold = [HsUnfold inline_pragma (toUfExpr rhs)] - | otherwise = [] + unfold_info | show_unfold = unfolding + | otherwise = noUnfolding show_unfold = not has_worker && -- Not unnecessary not bottoming_fn && -- Not necessary @@ -643,13 +461,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 @@ -657,26 +468,265 @@ 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 - ------------ Sanity checking -------------- - -- The arity of a wrapper function should match its strictness, - -- or else an importing module will get very confused indeed. - arity_matches_strictness - = case work_info of - HasWorker _ wrap_arity -> wrap_arity == arityLowerBound arity_info - other -> True - 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 + ] +\end{code} + + +%************************************************************************ +%* * +\subsection{Checking if the new interface is up to date +%* * +%************************************************************************ + +\begin{code} +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 })) + new_iface@(ModIface { mi_decls = new_decls, + mi_fixities = new_fixities }) + + | no_output_change && no_usage_change + = (old_iface, Nothing) + + | otherwise -- Add updated version numbers + = (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 = tc_vers } + + 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 + no_rule_change = dcl_rules old_decls == dcl_rules new_decls -- Ditto + + -- 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) + + + +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 + -- 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 + 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 + od_name = tyClDeclName od + nd_name = tyClDeclName nd + new_vers' = extendNameEnv new_vers nd_name + (bumpVersion True (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 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 (pprIface mod_iface) + ; hClose if_hdl + } + +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 -> 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 +\end{code}