X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=1d709efb64c9a42e5f693eb51862c2ff21ebe46b;hb=5cbfe81e433d1ca3aed41d5b5522bc1377e6af94;hp=15bb56964489af51a94c6d5ae6910481c37afb96;hpb=1fb1ab5d53a09607e7f6d2450806760688396387;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index 15bb569..1d709ef 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -1,471 +1,673 @@ % -% (c) The GRASP/AQUA Project, Glasgow University, 1993-1996 +% (c) The GRASP/AQUA Project, Glasgow University, 1993-1998 % \section[MkIface]{Print an interface for a module} \begin{code} -#include "HsVersions.h" +module MkIface ( writeIface ) where -module MkIface ( - startIface, endIface, - ifaceMain, - ifaceDecls - ) where +#include "HsVersions.h" -IMP_Ubiq(){-uitous-} -IMPORT_1_3(IO(Handle,hPutStr,openFile,hClose,IOMode(..))) +import IO ( openFile, hClose, IOMode(..) ) import HsSyn -import RdrHsSyn ( RdrName(..) ) -import RnHsSyn ( SYN_IE(RenamedHsModule) ) +import HsCore ( HsIdInfo(..), toUfExpr ) +import RdrHsSyn ( RdrNameRuleDecl, mkTyData ) +import HsPragmas ( DataPragmas(..), ClassPragmas(..) ) +import HsTypes ( toHsTyVars ) +import BasicTypes ( Fixity(..), NewOrData(..), + Version, bumpVersion, initialVersion, isLoopBreaker + ) import RnMonad -import RnEnv ( availName ) import TcInstUtil ( InstInfo(..) ) import CmdLineOpts -import Id ( idType, dataConRawArgTys, dataConFieldLabels, isDataCon, - getIdInfo, idWantsToBeINLINEd, omitIfaceSigForId, - dataConStrictMarks, StrictnessMark(..), - SYN_IE(IdSet), idSetToList, unionIdSets, unitIdSet, minusIdSet, - isEmptyIdSet, elementOfIdSet, emptyIdSet, mkIdSet, - GenId{-instance NamedThing/Outputable-} +import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, hasNoBinding, + idSpecialisation ) -import IdInfo ( StrictnessInfo, ArityInfo, Unfolding, - arityInfo, ppArityInfo, strictnessInfo, ppStrictnessInfo, - getWorkerId_maybe, bottomIsGuaranteed +import Var ( isId, varName ) +import VarSet +import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks ) +import IdInfo ( IdInfo, StrictnessInfo(..), ArityInfo(..), + CprInfo(..), CafInfo(..), + inlinePragInfo, arityInfo, arityLowerBound, + strictnessInfo, isBottomingStrictness, + cafInfo, specInfo, cprInfo, + occInfo, isNeverInlinePrag, + workerInfo, WorkerInfo(..) ) -import CoreSyn ( SYN_IE(CoreExpr), SYN_IE(CoreBinding), GenCoreExpr, GenCoreBinding(..) ) -import CoreUnfold ( calcUnfoldingGuidance, UnfoldingGuidance(..) ) -import FreeVars ( addExprFVs ) -import Name ( isLocallyDefined, isWiredInName, modAndOcc, getName, pprOccName, - OccName, occNameString, nameOccName, nameString, isExported, pprNonSym, - Name {-instance NamedThing-}, Provenance +import CoreSyn ( CoreExpr, CoreBind, Bind(..), isBuiltinRule, rulesRules, rulesRhsFreeVars ) +import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) +import CoreUnfold ( okToUnfoldInHiFile, couldBeSmallEnoughToInline ) +import Module ( pprModuleName, moduleUserString ) +import Name ( isLocallyDefined, isWiredInName, toRdrName, nameModule, + Name, NamedThing(..) ) -import TyCon ( TyCon{-instance NamedThing-} ) -import Class ( GenClass(..){-instance NamedThing-}, GenClassOp, classOpLocalType ) -import FieldLabel ( FieldLabel{-instance NamedThing-} ) -import Type ( mkSigmaTy, mkDictTy, getAppTyCon, splitForAllTy ) -import TyVar ( GenTyVar {- instance Eq -} ) -import Unique ( Unique {- instance Eq -} ) - -import PprEnv -- not sure how much... -import PprStyle ( PprStyle(..) ) -import PprType -import PprCore ( pprIfaceUnfolding ) -import Pretty -import Unpretty -- ditto +import OccName ( OccName, pprOccName ) +import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, + tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize + ) +import Class ( classExtraBigSig, DefMeth(..) ) +import FieldLabel ( fieldLabelType ) +import Type ( mkSigmaTy, splitSigmaTy, mkDictTy, tidyTopType, + deNoteType, classesToPreds + ) +import Rules ( ProtoCoreRule(..) ) import Bag ( bagToList ) -import Maybes ( catMaybes, maybeToBool ) -import FiniteMap ( emptyFM, addToFM, addToFM_C, lookupFM, fmToList, eltsFM, FiniteMap ) -import UniqFM ( UniqFM, lookupUFM, listToUFM ) -import Util ( sortLt, zipWithEqual, zipWith3Equal, mapAccumL, - assertPanic, panic{-ToDo:rm-}, pprTrace ) - +import UniqFM ( lookupUFM, listToUFM ) +import Util ( sortLt ) +import SrcLoc ( noSrcLoc ) +import Bag +import Outputable +import ErrUtils ( dumpIfSet ) + +import Maybe ( isNothing ) +import List ( partition ) +import Monad ( when ) \end{code} -We have a function @startIface@ to open the output file and put -(something like) ``interface Foo'' in it. It gives back a handle -for subsequent additions to the interface file. -We then have one-function-per-block-of-interface-stuff, e.g., -@ifaceExportList@ produces the @__exports__@ section; it appends -to the handle provided by @startIface@. +%************************************************************************ +%* * +\subsection{Write a new interface file} +%* * +%************************************************************************ \begin{code} -startIface :: Module - -> IO (Maybe Handle) -- Nothing <=> don't do an interface +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 + } + where + full_new_iface = completeIface new_iface local_tycons local_classes + inst_info final_ids tidy_binds + tidy_orphan_rules +\end{code} -ifaceMain :: Maybe Handle - -> InterfaceDetails - -> IO () +%************************************************************************ +%* * +\subsection{Checking if the new interface is up to date +%* * +%************************************************************************ -ifaceDecls :: Maybe Handle - -> RenamedHsModule - -> Bag InstInfo - -> [Id] -- Ids used at code-gen time; they have better pragma info! - -> [CoreBinding] -- In dependency order, later depend on earlier - -> IO () +\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 final_iface )} + + 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 -endIface :: Maybe Handle -> IO () + 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{Printing the interface} +%* * +%************************************************************************ + \begin{code} -startIface mod - = case opt_ProduceHi of - Nothing -> return Nothing -- not producing any .hi file - Just fn -> - openFile fn WriteMode >>= \ if_hdl -> - hPutStr if_hdl ("{-# GHC_PRAGMA INTERFACE VERSION 20 #-}\n_interface_ "++ _UNPK_ mod ++ "\n") >> - return (Just if_hdl) - -endIface Nothing = return () -endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl +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) \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} -ifaceMain Nothing iface_stuff = return () -ifaceMain (Just if_hdl) - (import_usages, ExportEnv avails fixities, instance_modules) - = - ifaceInstanceModules if_hdl instance_modules >> - ifaceUsages if_hdl import_usages >> - ifaceExports if_hdl avails >> - ifaceFixities if_hdl fixities >> - return () - -ifaceDecls Nothing rn_mod inst_info final_ids simplified = return () -ifaceDecls (Just hdl) - (HsModule _ _ _ _ _ decls _) - inst_infos - final_ids binds - | null decls = return () - -- You could have a module with just (re-)exports/instances in it - | otherwise - = ifaceInstances hdl inst_infos >>= \ needed_ids -> - hPutStr hdl "_declarations_\n" >> - ifaceTCDecls hdl decls >> - ifaceBinds hdl needed_ids final_ids binds >> - return () +pprExport :: ExportItem -> SDoc +pprExport (mod, items) + = hsep [ ptext SLIT("__export "), ppr mod, hsep (map upp_avail items) ] <> semi + 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} + \begin{code} -ifaceUsages if_hdl import_usages - = hPutStr if_hdl "_usages_\n" >> - hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages) +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 - upp_uses (m, mv, versions) - = uppBesides [upp_module m, uppSP, uppInt mv, uppPStr SLIT(" :: "), - upp_import_versions (sort_versions versions), uppSemi] - - -- For imported versions we do print the version number - upp_import_versions nvs - = uppIntersperse uppSP [ uppCat [ppr_unqual_name n, uppInt v] | (n,v) <- nvs ] + 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 ] +\end{code} -ifaceInstanceModules if_hdl [] = return () -ifaceInstanceModules if_hdl imods - = hPutStr if_hdl "_instance_modules_\n" >> - hPutStr if_hdl (uppShow 0 (uppCat (map uppPStr imods))) >> - hPutStr if_hdl "\n" +\begin{code} +pprFixities [] = empty +pprFixities fixes = hsep (map ppr fixes) <> semi -ifaceExports if_hdl [] = return () -ifaceExports if_hdl avails - = hPutStr if_hdl "_exports_\n" >> - hPutCol if_hdl do_one_module (fmToList export_fm) - where - -- Sort them into groups by module - export_fm :: FiniteMap Module [AvailInfo] - export_fm = foldr insert emptyFM avails - - insert NotAvailable efm = efm - insert avail efm = addToFM_C (++) efm mod [avail] - where - (mod,_) = modAndOcc (availName avail) - - -- Print one module's worth of stuff - do_one_module (mod_name, avails) - = uppBesides [upp_module mod_name, uppSP, - uppCat (map upp_avail (sortLt lt_avail avails)), - uppSemi] - -ifaceFixities if_hdl [] = return () -ifaceFixities if_hdl fixities - = hPutStr if_hdl "_fixities_\n" >> - hPutCol if_hdl upp_fixity fixities - -ifaceTCDecls if_hdl decls - = hPutCol if_hdl ppr_decl tc_decls_for_iface - where - tc_decls_for_iface = sortLt lt_decl (filter for_iface decls) - for_iface decl@(ClD _) = for_iface_name (hsDeclName decl) - for_iface decl@(TyD _) = for_iface_name (hsDeclName decl) - for_iface other_decl = False +pprRules [] = empty +pprRules rules = hsep [ptext SLIT("{-## __R"), hsep (map ppr rules), ptext SLIT("##-}")] - for_iface_name name = isLocallyDefined name && - not (isWiredInName name) +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} - lt_decl d1 d2 = hsDeclName d1 < hsDeclName d2 -\end{code} %************************************************************************ %* * -\subsection{Instance declarations} +\subsection{Completing the new interface} %* * %************************************************************************ +\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) + + (val_dcls, emitted_ids) = ifaceBinds (inst_ids `unionVarSet` orphan_rule_ids) + final_ids tidy_binds -\begin{code} -ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet -- The IdSet is the needed dfuns -ifaceInstances if_hdl inst_infos - | null togo_insts = return emptyIdSet - | otherwise = hPutStr if_hdl "_instances_\n" >> - hPutCol if_hdl pp_inst (sortLt lt_inst togo_insts) >> - return needed_ids - where - togo_insts = filter is_togo_inst (bagToList inst_infos) - needed_ids = mkIdSet [dfun_id | InstInfo _ _ _ _ _ dfun_id _ _ _ <- togo_insts] - is_togo_inst (InstInfo _ _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id - - ------- - lt_inst (InstInfo _ _ _ _ _ dfun_id1 _ _ _) - (InstInfo _ _ _ _ _ dfun_id2 _ _ _) - = getOccName dfun_id1 < getOccName dfun_id2 - -- The dfuns are assigned names df1, df2, etc, in order of original textual - -- occurrence, and this makes as good a sort order as any + rule_dcls | opt_OmitInterfacePragmas = [] + | otherwise = ifaceRules tidy_orphan_rules emitted_ids - ------- - pp_inst (InstInfo clas tvs ty theta _ dfun_id _ _ _) - = let - forall_ty = mkSigmaTy tvs theta (mkDictTy clas ty) - renumbered_ty = renumber_ty forall_ty - in - uppBesides [uppPStr SLIT("instance "), ppr_ty renumbered_ty, - uppPStr SLIT(" = "), ppr_unqual_name dfun_id, uppSemi] + orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule + | ProtoCoreRule _ _ rule <- tidy_orphan_rules] + +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 \end{code} %************************************************************************ %* * -\subsection{Printing values} +\subsection{Completion stuff} %* * %************************************************************************ \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 (Pretty, IdSet) -- The emitted stuff, plus a possibly-augmented set of needed Ids - -ifaceId get_idinfo needed_ids is_rec id rhs - | not (id `elementOfIdSet` needed_ids || -- Needed [no id in needed_ids has omitIfaceSigForId] - (isExported id && not (omitIfaceSigForId id))) -- or exported and not to be omitted - = Nothing -- Well, that was easy! - -ifaceId get_idinfo needed_ids is_rec id rhs - = Just (ppCat [sig_pretty, pp_double_semi, prag_pretty], new_needed_ids) +ifaceRules :: [ProtoCoreRule] -> IdSet -> [RdrNameRuleDecl] +ifaceRules rules emitted + = orphan_rules ++ local_rules where - pp_double_semi = ppPStr SLIT(";;") - idinfo = get_idinfo id - inline_pragma = idWantsToBeINLINEd id - - ty_pretty = pprType PprInterface (initNmbr (nmbrType (idType id))) - sig_pretty = ppBesides [ppr PprInterface (getOccName id), ppPStr SLIT(" _:_ "), ty_pretty] - - prag_pretty - | opt_OmitInterfacePragmas = ppNil - | otherwise = ppCat [arity_pretty, strict_pretty, unfold_pretty, pp_double_semi] - - ------------ Arity -------------- - arity_pretty = ppArityInfo PprInterface (arityInfo idinfo) - - ------------ Strictness -------------- - strict_info = strictnessInfo idinfo - maybe_worker = getWorkerId_maybe strict_info - strict_pretty = ppStrictnessInfo PprInterface strict_info + 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} - ------------ Unfolding -------------- - unfold_pretty | show_unfold = ppCat [ppPStr SLIT("_U_"), pprIfaceUnfolding rhs] - | otherwise = ppNil +\begin{code} +ifaceInstances :: Bag InstInfo -> ([RdrNameInstDecl], IdSet) + -- The IdSet is the needed dfuns - show_unfold = not implicit_unfolding && -- Unnecessary - (inline_pragma || not dodgy_unfolding) -- Dangerous +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 + -- 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 + -- from interface files that the 'gating' mechanism works properly. + -- Otherwise you could have + -- type Tibble = T Int + -- instance Foo Tibble where ... + -- and this instance decl wouldn't get imported into a module + -- that mentioned T but not Tibble. + forall_ty = mkSigmaTy tvs theta (deNoteType (mkDictTy clas tys)) + tidy_ty = tidyTopType forall_ty + in + InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (toRdrName dfun_id)) noSrcLoc +\end{code} - implicit_unfolding = maybeToBool maybe_worker || - bottomIsGuaranteed strict_info +\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 (mkTyData 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 + + 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) + + 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 + [] noSrcLoc + ) + where + bogus = error "ifaceClass" + (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas - dodgy_unfolding = is_rec || -- No recursive unfoldings please! - case guidance of -- Too big to show - UnfoldNever -> True - other -> False + toClassOpSig (sel_id, def_meth) = + ASSERT(sel_tyvars == clas_tyvars) + ClassOpSig (toRdrName 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 (toRdrName id) +\end{code} - guidance = calcUnfoldingGuidance inline_pragma - opt_InterfaceUnfoldThreshold - rhs - - ------------ Extra free Ids -------------- - new_needed_ids = (needed_ids `minusIdSet` unitIdSet id) `unionIdSets` - extra_ids - - extra_ids | opt_OmitInterfacePragmas = emptyIdSet - | otherwise = worker_ids `unionIdSets` - unfold_ids - - worker_ids = case maybe_worker of - Just wkr -> unitIdSet wkr - Nothing -> emptyIdSet - - unfold_ids | show_unfold = free_vars - | otherwise = emptyIdSet - where - (_,free_vars) = addExprFVs interesting emptyIdSet rhs - interesting bound id = isLocallyDefined id && - not (id `elementOfIdSet` bound) && - not (omitIfaceSigForId id) -\end{code} +%************************************************************************ +%* * +\subsection{Value bindings} +%* * +%************************************************************************ \begin{code} -ifaceBinds :: Handle - -> IdSet -- These Ids are needed already +ifaceBinds :: IdSet -- These Ids are needed already -> [Id] -- Ids used at code-gen time; they have better pragma info! - -> [CoreBinding] -- In dependency order, later depend on earlier - -> IO () + -> [CoreBind] -- In dependency order, later depend on earlier + -> (Bag RdrNameHsDecl, IdSet) -- Set of Ids actually spat out -ifaceBinds hdl needed_ids final_ids binds - = hPutStr hdl (uppShow 0 (prettyToUn (ppAboves pretties))) >> - hPutStr hdl "\n" +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 where final_id_map = listToUFM [(id,id) | id <- final_ids] get_idinfo id = case lookupUFM final_id_map id of - Just id' -> getIdInfo id' - Nothing -> pprTrace "ifaceBinds not found:" (ppr PprDebug id) $ - getIdInfo id - - pretties = go needed_ids (reverse binds) -- Reverse so that later things will - -- provoke earlier ones to be emitted - go needed [] = if not (isEmptyIdSet needed) then - pprTrace "ifaceBinds: free vars:" - (ppSep (map (ppr PprDebug) (idSetToList needed))) $ - [] - else - [] - - go needed (NonRec id rhs : binds) - = case ifaceId get_idinfo needed False id rhs of - Nothing -> go needed binds - Just (pretty, needed') -> pretty : go needed' binds + 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 + | 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 + where + (decl, extras) = ifaceId get_idinfo False id rhs -- Recursive groups are a bit more of a pain. We may only need one to -- start with, but it may call out the next one, and so on. So we - -- have to look for a fixed point. - go needed (Rec pairs : binds) - = pretties ++ go needed'' binds + -- 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' where - (needed', pretties) = go_rec needed pairs - needed'' = needed' `minusIdSet` mkIdSet (map fst pairs) - -- Later ones may spuriously cause earlier ones to be "needed" again + (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)] -> (IdSet, [Pretty]) + go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag RdrNameHsDecl, IdSet, IdSet) go_rec needed pairs - | null pretties = (needed, []) - | otherwise = (final_needed, more_pretties ++ pretties) + | null decls = (emptyBag, emptyVarSet, emptyVarSet) + | otherwise = (more_decls `unionBags` listToBag decls, + more_emitted `unionVarSet` mkVarSet (map fst needed_prs), + more_extras `unionVarSet` extras) where - reduced_pairs = [pair | (pair,Nothing) <- pairs `zip` maybes] - pretties = catMaybes maybes - (needed', maybes) = mapAccumL do_one needed pairs - (final_needed, more_pretties) = go_rec needed' reduced_pairs - - do_one needed (id,rhs) = case ifaceId get_idinfo needed True id rhs of - Nothing -> (needed, Nothing) - Just (pretty, needed') -> (needed', Just pretty) + (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 + is_needed (id,_) = need_id needed id \end{code} -%************************************************************************ -%* * -\subsection{Random small things} -%* * -%************************************************************************ - -When printing export lists, we print like this: - Avail f f - AvailTC C [C, x, y] C(x,y) - AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C - \begin{code} -upp_avail NotAvailable = uppNil -upp_avail (Avail name) = upp_occname (getOccName name) -upp_avail (AvailTC name []) = uppNil -upp_avail (AvailTC name ns) = uppBesides [upp_occname (getOccName name), bang, upp_export ns'] - where - bang | name `elem` ns = uppNil - | otherwise = uppChar '!' - ns' = filter (/= name) ns - -upp_export [] = uppNil -upp_export names = uppBesides [uppChar '(', - uppIntersperse uppSP (map (upp_occname . getOccName) names), - uppChar ')'] - -upp_fixity (occ, (Fixity prec dir, prov)) = uppBesides [upp_dir dir, uppSP, - uppInt prec, uppSP, - upp_occname occ, uppSemi] -upp_dir InfixR = uppPStr SLIT("infixr") -upp_dir InfixL = uppPStr SLIT("infixl") -upp_dir InfixN = uppPStr SLIT("infix") - -ppr_unqual_name :: NamedThing a => a -> Unpretty -- Just its occurrence name -ppr_unqual_name name = upp_occname (getOccName name) - -ppr_name :: NamedThing a => a -> Unpretty -- Its full name -ppr_name n = uppPStr (nameString (getName n)) - -upp_occname :: OccName -> Unpretty -upp_occname occ = uppPStr (occNameString occ) - -upp_module :: Module -> Unpretty -upp_module mod = uppPStr mod +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) + where + id_type = idType id + core_idinfo = idInfo id + stg_idinfo = get_idinfo id -uppSemid x = uppBeside (prettyToUn (ppr PprInterface x)) uppSemi -- micro util + hs_idinfo | opt_OmitInterfacePragmas = [] + | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ + strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo -ppr_ty ty = prettyToUn (pprType PprInterface ty) -ppr_tyvar tv = prettyToUn (ppr PprInterface tv) -ppr_tyvar_bndr tv = prettyToUn (pprTyVarBndr PprInterface tv) + ------------ 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 -> [] -ppr_decl decl = prettyToUn (ppr PprInterface decl) `uppBeside` uppSemi + ------------ Strictness -------------- + strict_info = strictnessInfo core_idinfo + bottoming_fn = isBottomingStrictness strict_info + strict_hsinfo = case strict_info of + NoStrictnessInfo -> [] + info -> [HsStrictness 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". + work_info = workerInfo core_idinfo + HasWorker work_id _ = work_info + + 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 + + wrkr_hsinfo | has_worker = [HsWorker (toRdrName work_id)] + | otherwise = [] -renumber_ty ty = initNmbr (nmbrType ty) -\end{code} + ------------ Unfolding -------------- + inline_pragma = inlinePragInfo core_idinfo + dont_inline = isNeverInlinePrag inline_pragma + unfold_hsinfo | show_unfold = [HsUnfold inline_pragma (toUfExpr rhs)] + | otherwise = [] -%************************************************************************ -%* * -\subsection{Comparisons -%* * -%************************************************************************ - + 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 -The various sorts above simply prevent unnecessary "wobbling" when -things change that don't have to. We therefore compare lexically, not -by unique + rhs_is_small = couldBeSmallEnoughToInline opt_UF_HiFileThreshold rhs -\begin{code} -lt_avail :: AvailInfo -> AvailInfo -> Bool + ------------ Specialisations -------------- + spec_info = specInfo core_idinfo + + ------------ Occ info -------------- + loop_breaker = isLoopBreaker (occInfo core_idinfo) -a1 `lt_avail` a2 = availName a1 `lt_name` availName a2 + ------------ Extra free Ids -------------- + new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet + | otherwise = worker_ids `unionVarSet` + unfold_ids `unionVarSet` + spec_ids -lt_name :: Name -> Name -> Bool -n1 `lt_name` n2 = modAndOcc n1 < modAndOcc n2 + worker_ids | has_worker && interestingId work_id = unitVarSet work_id + -- Conceivably, the worker might come from + -- another module + | otherwise = emptyVarSet -lt_lexical :: NamedThing a => a -> a -> Bool -lt_lexical a1 a2 = getName a1 `lt_name` getName a2 + spec_ids = filterVarSet interestingId (rulesRhsFreeVars spec_info) -lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool -lt_imp_vers (m1,_,_) (m2,_,_) = m1 < m2 + unfold_ids | show_unfold = find_fvs rhs + | otherwise = emptyVarSet -sort_versions vs = sortLt lt_vers vs + find_fvs expr = exprSomeFreeVars interestingId expr -lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool -lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2 +interestingId id = isId id && isLocallyDefined id && not (hasNoBinding id) \end{code} - -\begin{code} -hPutCol :: Handle - -> (a -> Unpretty) - -> [a] - -> IO () -hPutCol hdl fmt xs = hPutStr hdl (uppShow 0 (uppAboves (map fmt xs))) >> - hPutStr hdl "\n" -\end{code}