X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=9ba3a2fca0f7ba664bd9291cf634476d74b704f4;hb=31285afea6a7b553380fd0a01e0a8ce0d7e50878;hp=7370529ffa3c49ed067d4a7b8220a9d90cc3e504;hpb=495ef8bd9ef30bffe50ea399b91e3ba09646b59a;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index 7370529..9ba3a2f 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -1,379 +1,305 @@ % % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998 % + \section[MkIface]{Print an interface for a module} \begin{code} -module MkIface ( writeIface ) where +module MkIface ( + mkFinalIface, + pprModDetails, pprIface, pprUsage, + ifaceTyCls, + ) 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 TysPrim ( alphaTyVars ) +import BasicTypes ( Fixity(..), NewOrData(..), + Version, initialVersion, bumpVersion, ) import RnMonad -import RnEnv ( availName ) - -import TcInstUtil ( InstInfo(..) ) +import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) +import HscTypes ( VersionInfo(..), ModIface(..), ModDetails(..), + ModuleLocation(..), GhciMode(..), + IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts, + TyThing(..), DFunId, Avails, + WhatsImported(..), GenAvailInfo(..), + ImportVersion, AvailInfo, Deprecations(..), + lookupVersion, + ) import CmdLineOpts -import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, - idSpecialisation - ) -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 CoreSyn ( CoreExpr, CoreBind, Bind(..), isBuiltinRule, rulesRules, rulesRhsFreeVars ) -import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) -import CoreUnfold ( okToUnfoldInHiFile, couldBeSmallEnoughToInline ) -import Module ( moduleString, pprModule, pprModuleName ) -import RdrName ( RdrName ) -import Name ( isLocallyDefined, isWiredInName, toRdrName, nameModule, - Name, NamedThing(..) +import Id ( idType, idInfo, isImplicitId, idCgInfo, + isLocalId, idName, ) -import OccName ( OccName, pprOccName ) -import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, - tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize +import DataCon ( dataConId, dataConSig, dataConFieldLabels, dataConStrictMarks ) +import IdInfo -- Lots +import CoreSyn ( CoreRule(..) ) +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, tyConGenIds, tyConTheta, tyConTyVars, + tyConDataCons, tyConFamilySize, isPrimTyCon, + isClassTyCon, isForeignTyCon, tyConArity ) -import Class ( Class, classExtraBigSig ) -import FieldLabel ( fieldLabelName, fieldLabelType ) -import Type ( mkSigmaTy, splitSigmaTy, mkDictTy, tidyTopType, - deNoteType, classesToPreds, - Type, ThetaType, PredType(..), ClassContext - ) - -import PprType -import FunDeps ( pprFundeps ) -import Rules ( pprProtoCoreRule, ProtoCoreRule(..) ) - -import Bag ( bagToList, isEmptyBag ) -import Maybes ( catMaybes, maybeToBool ) -import FiniteMap ( emptyFM, addToFM, addToFM_C, fmToList, FiniteMap ) -import UniqFM ( lookupUFM, listToUFM ) -import UniqSet ( uniqSetToList ) -import Util ( sortLt, mapAccumL ) +import Class ( classExtraBigSig, classTyCon, DefMeth(..) ) +import FieldLabel ( fieldLabelType ) +import TcType ( tcSplitSigmaTy, tidyTopType, deNoteType, namesOfDFunHead ) import SrcLoc ( noSrcLoc ) -import Bag import Outputable -\end{code} - - -%************************************************************************ -%* * -\subsection{Write a new interface file} -%* * -%************************************************************************ +import Module ( ModuleName ) +import Util ( sortLt ) +import ErrUtils ( dumpIfSet_dyn ) -\begin{code} -writeIface this_mod old_iface new_iface - local_tycons local_classes inst_info - final_ids tidy_binds tidy_orphan_rules - = case opt_ProduceHi of { - Nothing -> return () ; -- not producing any .hi file - - Just filename -> - - case checkIface old_iface full_new_iface of { - Nothing -> do { putStrLn "Interface file unchanged" ; - return () } ; -- 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 - if mod_vers_unchanged - then putStrLn "Module version unchanged, but usages differ; hence need new hi file" - else return () - - if_hdl <- openFile filename WriteMode - printForIface if_hdl (pprIface final_iface) - hClose if_hdl - }} - where - full_new_iface = completeIface new_iface local_tycons local_classes - inst_info final_ids tidy_binds - tidy_orphan_rules +import Monad ( when ) +import IO ( IOMode(..), openFile, hClose ) \end{code} %************************************************************************ %* * -\subsection{Checking if the new interface is up to date +\subsection{Completing an interface} %* * %************************************************************************ \begin{code} -checkIface :: Maybe ParsedIface -- The old interface, read from M.hi - -> ParsedIface -- The new interface; but with all version numbers = 1 - -> Maybe ParsedIface -- Nothing => no change; no need to write new Iface - -- Just pi => 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 -checkIface Nothing new_iface --- No old interface, so definitely write a new one! - = Just new_iface -checkIface (Just iface) new_iface - | no_output_change && no_usage_change - = Nothing +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 - | otherwise -- Add updated version numbers - = -{- pprTrace "checkIface" ( - vcat [ppr no_decl_changed <+> ppr no_export_change <+> ppr no_usage_change, - text "--------", - vcat (map ppr (pi_decls iface)), - text "--------", - vcat (map ppr (pi_decls new_iface)) - ]) $ --} - Just (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 - }) - - where - no_usage_change = pi_usages iface == pi_usages new_iface +mkFinalIface ghci_mode dflags location + maybe_old_iface new_iface new_details + = do { + -- Add the new declarations, and the is-orphan flag + let iface_w_decls = new_iface { mi_decls = new_decls, + mi_orphan = orphan_mod } - no_output_change = no_decl_changed && - new_fixity_vers == fixity_vers && - new_rules_vers == rules_vers && - no_export_change + -- Add version information + ; let (final_iface, maybe_diffs) = addVersionInfo maybe_old_iface iface_w_decls - no_export_change = pi_exports iface == pi_exports new_iface + -- Write the interface file, if necessary + ; when (must_write_hi_file maybe_diffs) + (writeIface hi_file_path final_iface) - new_mod_vers | no_output_change = mod_vers - | otherwise = bumpVersion mod_vers + -- Debug printing + ; write_diffs dflags final_iface maybe_diffs - mod_vers = pi_vers iface + ; return final_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, final_decls) = merge_decls True [] (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 acc [] [] = (ok_so_far, reverse acc) - merge_decls ok_so_far acc old [] = (False, reverse acc) - merge_decls ok_so_far acc [] (nvd:nvds) = merge_decls False (nvd:acc) [] nvds - merge_decls ok_so_far acc (vd@(v,d):vds) (nvd@(_,nd):nvds) - = case d_name `compare` nd_name of - LT -> merge_decls False acc vds (nvd:nvds) - GT -> merge_decls False (nvd:acc) (vd:vds) nvds - EQ | d == nd -> merge_decls ok_so_far (vd:acc) vds nvds - | otherwise -> merge_decls False ((bumpVersion v, nd):acc) vds nvds - where - d_name = hsDeclName d - nd_name = hsDeclName nd -\end{code} - - - -%************************************************************************ -%* * -\subsection{Printing the interface} -%* * -%************************************************************************ - -\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 - ] 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) + 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 (md_insts new_details) + ty_cls_dcls = foldNameEnv ifaceTyCls_acc [] (md_types new_details) + rule_dcls = map ifaceRule (md_rules new_details) + orphan_mod = isOrphanModule (mi_module new_iface) new_details + +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} -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 :: ExportItem -> SDoc -pprExport (mod, items) - = hsep [ ptext SLIT("__export "), ppr mod, hsep (map upp_avail items) ] <> semi +isOrphanModule this_mod (ModDetails {md_insts = insts, md_rules = rules}) + = any orphan_inst insts || any orphan_rule rules 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)) + 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. \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 - - -- 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 ] +ifaceTyCls_acc :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] +ifaceTyCls_acc (AnId id) so_far | isImplicitId id = so_far +ifaceTyCls_acc (ATyCon id) so_far | isClassTyCon id = so_far +ifaceTyCls_acc other so_far = ifaceTyCls 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} -pprFixities [] = empty -pprFixities fixes = hsep (map ppr fixes) <> semi +ifaceTyCls :: TyThing -> RenamedTyClDecl +ifaceTyCls (AClass clas) = cls_decl + where + cls_decl = ClassDecl { tcdCtxt = toHsContext sc_theta, + tcdName = getName clas, + tcdTyVars = toHsTyVars clas_tyvars, + tcdFDs = toHsFDs clas_fds, + tcdSigs = map toClassOpSig op_stuff, + tcdMeths = Nothing, + tcdSysNames = sys_names, + tcdLoc = noSrcLoc } + + (clas_tyvars, clas_fds, sc_theta, sc_sels, op_stuff) = classExtraBigSig clas + tycon = classTyCon clas + data_con = head (tyConDataCons tycon) + sys_names = mkClassDeclSysNames (getName tycon, getName data_con, + getName (dataConId data_con), map getName sc_sels) + + toClassOpSig (sel_id, def_meth) + = ASSERT(sel_tyvars == clas_tyvars) + ClassOpSig (getName sel_id) def_meth' (toHsType op_ty) noSrcLoc + where + (sel_tyvars, _, op_ty) = tcSplitSigmaTy (idType sel_id) + def_meth' = case def_meth of + NoDefMeth -> NoDefMeth + GenDefMeth -> GenDefMeth + DefMeth id -> DefMeth (getName id) -pprRules [] = empty -pprRules rules = hsep [ptext SLIT("{-## __R"), hsep (map ppr rules), ptext SLIT("##-}")] +ifaceTyCls (ATyCon tycon) = ty_decl + where + ty_decl | isSynTyCon tycon + = TySynonym { tcdName = getName tycon, + tcdTyVars = toHsTyVars tyvars, + tcdSynRhs = toHsType syn_ty, + tcdLoc = noSrcLoc } + + | isAlgTyCon tycon + = TyData { tcdND = new_or_data, + tcdCtxt = toHsContext (tyConTheta tycon), + tcdName = getName tycon, + tcdTyVars = toHsTyVars tyvars, + tcdCons = map ifaceConDecl (tyConDataCons tycon), + tcdNCons = tyConFamilySize tycon, + tcdDerivs = Nothing, + tcdSysNames = map getName (tyConGenIds tycon), + tcdLoc = noSrcLoc } + + | isForeignTyCon tycon + = ForeignType { tcdName = getName tycon, + tcdFoType = DNType, -- The only case at present + tcdLoc = noSrcLoc } + + | isPrimTyCon tycon + -- needed in GHCi for ':info Int#', for example + = TyData { tcdND = DataType, + tcdCtxt = [], + tcdName = getName tycon, + tcdTyVars = toHsTyVars (take (tyConArity tycon) alphaTyVars), + tcdCons = [], + tcdNCons = 0, + tcdDerivs = Nothing, + tcdSysNames = [], + tcdLoc = noSrcLoc } + + | otherwise = pprPanic "ifaceTyCls" (ppr tycon) + + tyvars = tyConTyVars tycon + (_, syn_ty) = getSynTyConDefn tycon + new_or_data | isNewTyCon tycon = NewType + | otherwise = DataType -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} + ifaceConDecl data_con + = ConDecl (getName data_con) (getName (dataConId data_con)) + (toHsTyVars ex_tyvars) + (toHsContext ex_theta) + details noSrcLoc + where + (tyvars1, _, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con + field_labels = dataConFieldLabels data_con + strict_marks = drop (length 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 BangType strict_marks (map toHsType arg_tys)) + | otherwise + = RecCon (zipWith mk_field strict_marks field_labels) -%************************************************************************ -%* * -\subsection{Completing the new interface} -%* * -%************************************************************************ + mk_field strict_mark field_label + = ([getName field_label], BangType strict_mark (toHsType (fieldLabelType field_label))) -\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) - } +ifaceTyCls (AnId id) = iface_sig 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) + iface_sig = IfaceSig { tcdName = getName id, + tcdType = toHsType id_type, + tcdIdInfo = hs_idinfo, + tcdLoc = noSrcLoc } - (val_dcls, emitted_ids) = ifaceBinds (inst_ids `unionVarSet` orphan_rule_ids) - final_ids tidy_binds + id_type = idType id + id_info = idInfo id + cg_info = idCgInfo id + arity_info = cgArity cg_info + caf_info = cgCafInfo cg_info - rule_dcls | opt_OmitInterfacePragmas = [] - | otherwise = ifaceRules tidy_orphan_rules emitted_ids + hs_idinfo | opt_OmitInterfacePragmas = [] + | otherwise = arity_hsinfo ++ caf_hsinfo ++ + strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo - orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule - | ProtoCoreRule _ _ rule <- tidy_orphan_rules] + ------------ Arity -------------- + arity_hsinfo | arity_info == 0 = [] + | otherwise = [HsArity arity_info] -lt_inst_decl (InstDecl _ _ _ dfun_id1 _) (InstDecl _ _ _ dfun_id2 _) - = dfun_id1 < dfun_id2 - -- The dfuns are assigned names df1, df2, etc, - -- in order of original textual - -- occurrence, and this makes as good a sort order as any + ------------ Caf Info -------------- + caf_hsinfo = case caf_info of + NoCafRefs -> [HsNoCafRefs] + otherwise -> [] -lt_decl d1 d2 = hsDeclName d1 < hsDeclName d2 -\end{code} + ------------ Strictness -------------- + strict_hsinfo = case newStrictnessInfo id_info of + Nothing -> [] + Just sig -> [HsStrictness sig] + ------------ Worker -------------- + work_info = workerInfo id_info + has_worker = case work_info of { HasWorker _ _ -> True; other -> False } + wrkr_hsinfo = case work_info of + HasWorker work_id wrap_arity -> + [HsWorker (getName work_id) wrap_arity] + NoWorker -> [] -%************************************************************************ -%* * -\subsection{Completion stuff} -%* * -%************************************************************************ + ------------ Unfolding -------------- + -- The unfolding is redundant if there is a worker + unfold_info = unfoldingInfo id_info + inline_prag = inlinePragInfo id_info + rhs = unfoldingTemplate unfold_info + unfold_hsinfo | neverUnfold unfold_info + || has_worker = [] + | otherwise = [HsUnfold inline_prag (toUfExpr rhs)] +\end{code} \begin{code} -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 - 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 @@ -383,263 +309,308 @@ 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 [] (toRdrName dfun_id) noSrcLoc + +ifaceRule (id, BuiltinRule _ _) + = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id) + +ifaceRule (id, Rule name bndrs args rhs) + = IfaceRule name (map toUfBndr bndrs) (getName id) + (map toUfExpr args) (toUfExpr rhs) noSrcLoc + +bogusIfaceRule id + = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc \end{code} + +%************************************************************************ +%* * +\subsection{Checking if the new interface is up to date +%* * +%************************************************************************ + \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 +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 - 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) +-- 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")) - | otherwise - = RecCon (zipWith mk_field strict_marks field_labels) +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 }) - mk_bang_ty NotMarkedStrict ty = Unbanged (toHsType ty) - mk_bang_ty (MarkedUnboxed _ _) ty = Unpacked (toHsType ty) - mk_bang_ty MarkedStrict ty = Banged (toHsType ty) + | no_output_change && no_usage_change + = (new_iface, Nothing) + -- don't return the old iface because it may not have an + -- mi_globals field set to anything reasonable. - 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 - ) + | otherwise -- Add updated version numbers + = --pprTrace "completeIface" (ppr (dcl_tycl old_decls)) + (final_iface, Just pp_diffs) + where - bogus = error "ifaceClass" - (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas + final_iface = new_iface { mi_version = new_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_deprec_change + no_usage_change = mi_usages old_iface == mi_usages new_iface - toClassOpSig (sel_id, dm_id, explicit_dm) - = ASSERT( sel_tyvars == clas_tyvars) - ClassOpSig (toRdrName sel_id) bogus explicit_dm (toHsType op_ty) noSrcLoc + 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. + (no_tc_change, pp_tc_diffs, tc_vers) = diffDecls old_version old_fixities new_fixities + (dcl_tycl old_decls) (dcl_tycl new_decls) + pp_diffs = vcat [pp_tc_diffs, + pp_change no_export_change "Export list", + pp_change no_rule_change "Rules", + pp_change no_deprec_change "Deprecations", + pp_change no_usage_change "Usages"] + pp_change True what = empty + pp_change False what = text what <+> ptext SLIT("changed") + +diffDecls :: VersionInfo -- Old version + -> 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 map + +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 + + diff ok_so_far pp new_vers [] [] = (ok_so_far, pp, new_vers) + diff ok_so_far pp new_vers (od:ods) [] = diff False (pp $$ only_old od) new_vers ods [] + diff ok_so_far pp new_vers [] (nd:nds) = diff False (pp $$ only_new nd) new_vers_with_new [] nds where - (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id) + 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 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_with_diff ods nds + where + od_name = tyClDeclName od + nd_name = tyClDeclName nd + 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 od nd = ptext SLIT("Changed in iface: ") <+> ((ptext SLIT("Old:") <+> ppr od) $$ + (ptext SLIT("New:") <+> ppr nd)) \end{code} + %************************************************************************ %* * -\subsection{Value bindings} +\subsection{Writing ModDetails} %* * %************************************************************************ \begin{code} -ifaceBinds :: IdSet -- These Ids are needed already - -> [Id] -- Ids used at code-gen time; they have better pragma info! - -> [CoreBind] -- In dependency order, later depend on earlier - -> (Bag RdrNameHsDecl, IdSet) -- Set of Ids actually spat out - -ifaceBinds needed_ids final_ids binds - = go needed_ids (reverse binds) emptyBag emptyVarSet - -- Reverse so that later things will - -- provoke earlier ones to be emitted +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 dfun_ids type_env + = text "TYPE SIGNATURES" $$ nest 4 (dump_sigs ids) 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 - - go needed [] decls 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 - = case ifaceId get_idinfo needed False id rhs of - Nothing -> go needed binds decls emitted - Just (decl, extras) -> let - needed' = (needed `unionVarSet` extras) `delVarSet` id - -- 'extras' can include the Id itself via a rule - emitted' = emitted `extendVarSet` id - in - go needed' binds (decl `consBag` decls) emitted' - - -- Recursive groups are a bit more of a pain. We may only need one to - -- start with, but it may call out the next one, and so on. So we - -- have to look for a fixed point. - go needed (Rec pairs : binds) decls emitted - = go needed' binds decls' emitted' - where - (new_decls, new_emitted, extras) = go_rec needed pairs - decls' = new_decls `unionBags` decls - needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs) - emitted' = emitted `unionVarSet` new_emitted - - go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag RdrNameHsDecl, IdSet, IdSet) - go_rec needed pairs - | null decls = (emptyBag, emptyVarSet, emptyVarSet) - | otherwise = (more_decls `unionBags` listToBag decls, - more_emitted `unionVarSet` mkVarSet emitted, - more_extras `unionVarSet` extras) - where - maybes = map do_one pairs - emitted = [id | ((id,_), Just _) <- pairs `zip` maybes] - reduced_pairs = [pair | (pair, Nothing) <- pairs `zip` maybes] - (decls, extras_s) = unzip (catMaybes maybes) - extras = unionVarSets extras_s - (more_decls, more_emitted, more_extras) = go_rec extras reduced_pairs - - do_one (id,rhs) = ifaceId get_idinfo needed True id rhs + ids = [id | AnId id <- nameEnvElts 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 [] = empty +dump_insts dfun_ids = text "INSTANCES" $$ nest 4 (dump_sigs dfun_ids) + +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 [] = empty +dump_rules rs = vcat [ptext SLIT("{-# RULES"), + nest 4 (vcat (map pprIdCoreRule rs)), + ptext SLIT("#-}")] \end{code} +%************************************************************************ +%* * +\subsection{Writing an interface file} +%* * +%************************************************************************ + \begin{code} -ifaceId :: (Id -> IdInfo) -- This function "knows" the extra info added - -- by the STG passes. Sigh - - -> IdSet -- Set of Ids that are needed by earlier interface - -- file emissions. If the Id isn't in this set, and isn't - -- exported, there's no need to emit anything - -> Bool -- True <=> recursive, so don't print unfolding - -> Id - -> CoreExpr -- The Id's right hand side - -> Maybe (RdrNameHsDecl, IdSet) -- The emitted stuff, plus any *extra* needed Ids - -ifaceId get_idinfo needed_ids is_rec id rhs - | not (id `elemVarSet` needed_ids || -- Needed [no id in needed_ids has omitIfaceSigForId] - (isUserExportedId id && not (omitIfaceSigForId id))) -- or exported and not to be omitted - = Nothing -- Well, that was easy! - -ifaceId get_idinfo needed_ids is_rec id rhs - = ASSERT2( arity_matches_strictness, ppr id ) - Just (SigD (IfaceSig (toRdrName id) (toHsType id_type) hs_idinfo noSrcLoc), - new_needed_ids) +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 - id_type = idType id - core_idinfo = idInfo id - stg_idinfo = get_idinfo id + -- 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") - hs_idinfo | opt_OmitInterfacePragmas = [] - | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ - strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo + , vcat (map pprExport (mi_exports iface)) + , vcat (map pprUsage (mi_usages iface)) - ------------ Arity -------------- - arity_info = arityInfo stg_idinfo - arity_hsinfo = case arityInfo stg_idinfo of - a@(ArityExactly n) -> [HsArity a] - other -> [] + , pprFixities (mi_fixities iface) (dcl_tycl decls) + , pprIfaceDecls (vers_decls version_info) decls + , pprRulesAndDeprecs (dcl_rules decls) (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 - ------------ Caf Info -------------- - caf_hsinfo = case cafInfo stg_idinfo of - NoCafRefs -> [HsNoCafRefs] - otherwise -> [] + pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty + | otherwise = brackets (ppr exp_vers <+> ppr rule_vers) +\end{code} - ------------ CPR Info -------------- - cpr_hsinfo = case cprInfo core_idinfo of - ReturnsCPR -> [HsCprInfo] - NoCPRInfo -> [] +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 - ------------ Strictness -------------- - strict_info = strictnessInfo core_idinfo - bottoming_fn = isBottomingStrictness strict_info - strict_hsinfo = case strict_info of - NoStrictnessInfo -> [] - info -> [HsStrictness info] +\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} - ------------ Worker -------------- - work_info = workerInfo core_idinfo - has_worker = workerExists work_info - wrkr_hsinfo = case work_info of - HasWorker work_id _ -> [HsWorker (toRdrName work_id)] - other -> [] - ------------ Unfolding -------------- - inline_pragma = inlinePragInfo core_idinfo - dont_inline = isNeverInlinePrag inline_pragma +\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 - unfold_hsinfo | show_unfold = [HsUnfold inline_pragma (toUfExpr rhs)] - | otherwise = [] + -- 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 ] - 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 + pp_export_version Nothing = empty + pp_export_version (Just v) = int v +\end{code} - rhs_is_small = couldBeSmallEnoughToInline opt_UF_HiFileThreshold rhs +\begin{code} +pprIfaceDecls version_map decls + = vcat [ vcat [ppr i <+> semi | i <- dcl_insts decls] + , vcat (map ppr_decl (dcl_tycl decls)) + ] + where + ppr_decl d = ppr_vers d <+> ppr d <> semi - ------------ Specialisations -------------- - spec_info = specInfo core_idinfo - - ------------ Occ info -------------- - loop_breaker = isLoopBreaker (occInfo core_idinfo) - - ------------ Extra free Ids -------------- - new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet - | otherwise = worker_ids `unionVarSet` - unfold_ids `unionVarSet` - spec_ids - - worker_ids = case work_info of - HasWorker work_id _ | interestingId work_id -> unitVarSet work_id - -- Conceivably, the worker might come from - -- another module - other -> 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 (omitIfaceSigForId id) + -- 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 + +-- Disgusting to print these two together, but that's +-- the way the interface parser currently expects them. +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 env = vcat (punctuate semi (map pp_deprec (nameEnvElts env))) + where + pp_deprec (name, txt) = pprOcc name <+> doubleQuotes (ptext txt) +\end{code}