X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=8540f9f5f4936e1e315e4ff166e8057f414749dc;hb=2ffefc1bfca0c8924825cd15750e7ced457f3c81;hp=e5604554deefba4673644c0289ec59fcb551a554;hpb=9d4c03805bafb6b1e1d47306b6a6c591c998e517;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index e560455..8540f9f 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -1,486 +1,732 @@ % -% (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} +module MkIface ( + mkModDetails, mkModDetailsFromIface, completeIface, + writeIface, pprIface + ) where + #include "HsVersions.h" -module MkIface ( - startIface, endIface, - ifaceUsages, - ifaceVersions, - ifaceExportList, - ifaceFixities, - ifaceInstanceModules, - ifaceDecls, - ifaceInstances, - ifacePragmas - ) where - -IMP_Ubiq(){-uitous-} -IMPORT_1_3(IO(Handle,hPutStr,openFile,hClose,IOMode(..))) - -import Bag ( bagToList ) -import Class ( GenClass(..){-instance NamedThing-}, GenClassOp(..) ) -import CmdLineOpts ( opt_ProduceHi ) -import FieldLabel ( FieldLabel{-instance NamedThing-} ) -import FiniteMap ( emptyFM, addToFM, lookupFM, fmToList, eltsFM, FiniteMap ) import HsSyn -import Id ( idType, dataConRawArgTys, dataConFieldLabels, - dataConStrictMarks, StrictnessMark(..), - GenId{-instance NamedThing/Outputable-} +import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr ) +import HsTypes ( toHsTyVars ) +import BasicTypes ( Fixity(..), NewOrData(..), + Version, initialVersion, bumpVersion, isLoopBreaker + ) +import RnMonad +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, idName, setIdInfo ) -import Maybes ( maybeToBool ) -import Name ( origName, nameOf, moduleOf, - exportFlagOn, nameExportFlag, ExportFlag(..), - isLexSym, isLocallyDefined, isWiredInName, - RdrName(..){-instance Outputable-}, - OrigName(..){-instance Ord-}, - Name{-instance NamedThing-} +import Var ( isId ) +import VarSet +import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks ) +import IdInfo -- Lots +import CoreSyn ( CoreExpr, CoreBind, Bind(..), CoreRule(..), IdCoreRule, + isBuiltinRule, rulesRules, rulesRhsFreeVars, emptyCoreRules, + bindersOfBinds ) -import ParseUtils ( UsagesMap(..), VersionsMap(..) ) -import PprEnv -- not sure how much... -import PprStyle ( PprStyle(..) ) -import PprType -- most of it (??) ---import PrelMods ( modulesWithBuiltins ) -import PrelInfo ( builtinNameInfo ) -import Pretty ( prettyToUn ) -import Unpretty -- ditto -import RnHsSyn ( isRnConstr, SYN_IE(RenamedHsModule), RnName{-instance NamedThing-} ) -import TcModule ( SYN_IE(TcIfaceInfo) ) -import TcInstUtil ( InstInfo(..) ) -import TyCon ( TyCon(..){-instance NamedThing-}, NewOrData(..) ) -import Type ( mkSigmaTy, mkDictTy, getAppTyCon, splitForAllTy ) -import Util ( sortLt, removeDups, zipWithEqual, zipWith3Equal, assertPanic, panic{-ToDo:rm-}, pprTrace{-ToDo:rm-} ) - -uppSemid x = uppBeside (prettyToUn (ppr PprInterface x)) uppSemi -- micro util -ppr_ty ty = prettyToUn (pprType PprInterface ty) -ppr_tyvar tv = prettyToUn (ppr PprInterface tv) -ppr_name n - = case (origName "ppr_name" n) of { OrigName m s -> - uppBesides [uppPStr m, uppChar '.', uppPStr s] } +import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) +import CoreUnfold ( okToUnfoldInHiFile, mkTopUnfolding, neverUnfold, unfoldingTemplate, noUnfolding ) +import Name ( isLocallyDefined, getName, + Name, NamedThing(..) + ) +import Name -- Env +import OccName ( pprOccName ) +import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, + tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize + ) +import Class ( classExtraBigSig, DefMeth(..) ) +import FieldLabel ( fieldLabelType ) +import Type ( splitSigmaTy, tidyTopType, deNoteType ) +import SrcLoc ( noSrcLoc ) +import Outputable +import Module ( ModuleName ) + +import List ( partition ) +import IO ( IOMode(..), openFile, hClose ) \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 -endIface :: Maybe Handle -> IO () -ifaceUsages - :: Maybe Handle - -> UsagesMap - -> IO () -ifaceVersions - :: Maybe Handle - -> VersionsMap - -> IO () -ifaceExportList - :: Maybe Handle - -> (Name -> ExportFlag) - -> RenamedHsModule - -> IO () -ifaceFixities - :: Maybe Handle - -> RenamedHsModule - -> IO () -ifaceInstanceModules - :: Maybe Handle - -> [Module] - -> IO () -ifaceDecls :: Maybe Handle - -> TcIfaceInfo -- info produced by typechecker, for interfaces - -> IO () -ifaceInstances - :: Maybe Handle - -> TcIfaceInfo -- as above - -> IO () -ifacePragmas - :: Maybe Handle - -> IO () -ifacePragmas = panic "ifacePragmas" -- stub +mkModDetails :: TypeEnv -> [DFunId] -- From typechecker + -> [CoreBind] -> [Id] -- Final bindings, plus the top-level Ids from the + -- code generator; they have authoritative arity info + -> [IdCoreRule] -- Tidy orphan rules + -> ModDetails +mkModDetails type_env dfun_ids tidy_binds stg_ids orphan_rules + = ModDetails { md_types = new_type_env, + md_rules = rule_dcls, + md_insts = dfun_ids } + where + -- The competed type environment is gotten from + -- a) keeping the types and classes + -- b) removing all Ids, and Ids with correct IdInfo + -- gotten from the bindings + -- From (b) we keep only those Ids with Global names, plus Ids + -- accessible from them (notably via unfoldings) + -- This truncates the type environment to include only the + -- exported Ids and things needed from them, which saves space + -- + -- However, we do keep things like constructors, which should not appear + -- in interface files, because they are needed by importing modules when + -- using the compilation manager + new_type_env = mkNameEnv [(getName tycl, tycl) | tycl <- orig_type_env, isTyClThing tycl] + `plusNameEnv` + mkNameEnv [(idName id, AnId id) | id <- final_ids] + + orig_type_env = nameEnvElts type_env + + final_ids = bindsToIds (mkVarSet dfun_ids `unionVarSet` orphan_rule_ids) + (mkVarSet stg_ids) + tidy_binds + + -- The complete rules are gotten by combining + -- a) the orphan rules + -- b) rules embedded in the top-level Ids + rule_dcls | opt_OmitInterfacePragmas = [] + | otherwise = getRules orphan_rules tidy_binds (mkVarSet final_ids) + + orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule + | (_, rule) <- orphan_rules] + + +-- This version is used when we are re-linking a module +-- so we've only run the type checker on its previous interface +mkModDetailsFromIface :: TypeEnv -> [DFunId] -- From typechecker + -> [TypecheckedRuleDecl] + -> ModDetails +mkModDetailsFromIface type_env dfun_ids rules + = ModDetails { md_types = type_env, + md_rules = rule_dcls, + md_insts = dfun_ids } + where + rule_dcls = [(id,rule) | IfaceRuleOut id rule <- rules] + -- All the rules from an interface are of the IfaceRuleOut form + + +completeIface :: Maybe ModIface -- The old interface, if we have it + -> ModIface -- The new one, minus the decls and versions + -> ModDetails -- The ModDetails for this module + -> (ModIface, Maybe SDoc) -- The new one, complete with decls and versions + -- The SDoc is a debug document giving differences + -- Nothing => no change + + -- NB: 'Nothing' means that even the usages havn't changed, so there's no + -- need to write a new interface file. But even if the usages have + -- changed, the module version may not have. +completeIface maybe_old_iface new_iface mod_details + = addVersionInfo maybe_old_iface (new_iface { mi_decls = new_decls }) + where + new_decls = IfaceDecls { dcl_tycl = ty_cls_dcls, + dcl_insts = inst_dcls, + dcl_rules = rule_dcls } + + inst_dcls = map ifaceInstance (md_insts mod_details) + ty_cls_dcls = foldNameEnv ifaceTyCls [] (md_types mod_details) + rule_dcls = map ifaceRule (md_rules mod_details) \end{code} + +%************************************************************************ +%* * +\subsection{Types and classes} +%* * +%************************************************************************ + \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 ("interface "++ _UNPK_ mod) >> - return (Just if_hdl) - -endIface Nothing = return () -endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl +ifaceTyCls :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] +ifaceTyCls (AClass clas) so_far + = cls_decl : so_far + where + cls_decl = ClassDecl (toHsContext sc_theta) + (getName clas) + (toHsTyVars clas_tyvars) + (toHsFDs clas_fds) + (map toClassOpSig op_stuff) + EmptyMonoBinds + [] noSrcLoc + + (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas + + 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) + +ifaceTyCls (ATyCon tycon) so_far + = ty_decl : so_far + + where + 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) + + | otherwise + = RecCon (zipWith mk_field strict_marks field_labels) + + mk_bang_ty NotMarkedStrict ty = Unbanged (toHsType ty) + mk_bang_ty (MarkedUnboxed _ _) ty = Unpacked (toHsType ty) + mk_bang_ty MarkedStrict ty = Banged (toHsType ty) + + mk_field strict_mark field_label + = ([getName field_label], mk_bang_ty strict_mark (fieldLabelType field_label)) + +ifaceTyCls (AnId id) so_far + | omitIfaceSigForId id = so_far + | otherwise = iface_sig : so_far + where + iface_sig = IfaceSig (getName id) (toHsType id_type) hs_idinfo noSrcLoc + + id_type = idType id + id_info = idInfo id + + hs_idinfo | opt_OmitInterfacePragmas = [] + | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ + strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo + + ------------ Arity -------------- + arity_hsinfo = case arityInfo id_info of + a@(ArityExactly n) -> [HsArity a] + other -> [] + + ------------ Caf Info -------------- + caf_hsinfo = case cafInfo id_info of + NoCafRefs -> [HsNoCafRefs] + otherwise -> [] + + ------------ CPR Info -------------- + cpr_hsinfo = case cprInfo id_info of + ReturnsCPR -> [HsCprInfo] + NoCPRInfo -> [] + + ------------ Strictness -------------- + strict_hsinfo = case strictnessInfo id_info of + NoStrictnessInfo -> [] + info -> [HsStrictness info] + + + ------------ Worker -------------- + wrkr_hsinfo = case workerInfo id_info of + HasWorker work_id wrap_arity -> [HsWorker (getName work_id)] + NoWorker -> [] + + ------------ Unfolding -------------- + unfold_info = unfoldingInfo id_info + inline_prag = inlinePragInfo id_info + rhs = unfoldingTemplate unfold_info + unfold_hsinfo | neverUnfold unfold_info = [] + | otherwise = [HsUnfold inline_prag (toUfExpr rhs)] \end{code} -\begin{code} -ifaceUsages Nothing{-no iface handle-} _ = return () -ifaceUsages (Just if_hdl) usages - | null usages_list - = return () - | otherwise - = hPutStr if_hdl "\n__usages__\n" >> - hPutStr if_hdl (uppShow 0 (uppAboves (map upp_uses usages_list))) +%************************************************************************ +%* * +\subsection{Instances and rules} +%* * +%************************************************************************ + +\begin{code} +ifaceInstance :: DFunId -> RenamedInstDecl +ifaceInstance dfun_id + = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc where - usages_list = fmToList usages -- NO: filter has_no_builtins (...) + 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 + -- 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. + +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} --- has_no_builtins (m, _) --- = m `notElem` modulesWithBuiltins --- -- Don't *have* to do this; save gratuitous spillage in --- -- every interface. Could be flag-controlled... - upp_uses (m, (mv, versions)) - = uppBesides [uppPStr m, uppSP, uppInt mv, uppPStr SLIT(" :: "), - upp_versions (fmToList versions), uppSemi] +%************************************************************************ +%* * +\subsection{Compute final Ids} +%* * +%************************************************************************ - upp_versions nvs - = uppIntersperse uppSP [ uppCat [uppPStr n, uppInt v] | (n,v) <- nvs ] -\end{code} +A "final Id" has exactly the IdInfo for going into an interface file, or +exporting to another module. \begin{code} -ifaceVersions Nothing{-no iface handle-} _ = return () - -ifaceVersions (Just if_hdl) version_info - | null version_list - = return () - | otherwise - = hPutStr if_hdl "\n__versions__\n" >> - hPutStr if_hdl (uppShow 0 (upp_versions version_list)) - -- NB: when compiling Prelude.hs, this will spew out - -- stuff for [], (), (,), etc. [i.e., builtins], which - -- we'd rather it didn't. The version-mangling in - -- the driver will ignore them. +bindsToIds :: IdSet -- These Ids are needed already + -> IdSet -- Ids used at code-gen time; they have better pragma info! + -> [CoreBind] -- In dependency order, later depend on earlier + -> [Id] -- Set of Ids actually spat out, complete with exactly the IdInfo + -- they need for exporting to another module + +bindsToIds needed_ids codegen_ids binds + = go needed_ids (reverse binds) [] + -- Reverse so that later things will + -- provoke earlier ones to be emitted where - version_list = fmToList version_info - - upp_versions nvs - = uppAboves [ uppPStr n | (n,v) <- nvs ] + -- The 'needed' set contains the Ids that are needed by earlier + -- interface file emissions. If the Id isn't in this set, and isn't + -- exported, there's no need to emit anything + need_id needed_set id = id `elemVarSet` needed_set || isUserExportedId id + + go needed [] emitted + | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:" + (sep (map ppr (varSetElems needed))) + emitted + | otherwise = emitted + + go needed (NonRec id rhs : binds) emitted + | need_id needed id = go new_needed binds (new_id:emitted) + | otherwise = go needed binds emitted + where + (new_id, extras) = mkFinalId codegen_ids False id rhs + new_needed = (needed `unionVarSet` extras) `delVarSet` id + + -- Recursive groups are a bit more of a pain. We may only need one to + -- start with, but it may call out the next one, and so on. So we + -- have to look for a fixed point. We don't want necessarily them all, + -- because without -O we may only need the first one (if we don't emit + -- its unfolding) + go needed (Rec pairs : binds) emitted + = go needed' binds emitted' + where + (new_emitted, extras) = go_rec needed pairs + needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs) + emitted' = new_emitted ++ emitted + + go_rec :: IdSet -> [(Id,CoreExpr)] -> ([Id], IdSet) + go_rec needed pairs + | null needed_prs = ([], emptyVarSet) + | otherwise = (emitted ++ more_emitted, + extras `unionVarSet` more_extras) + where + (needed_prs,leftover_prs) = partition is_needed pairs + (emitted, extras_s) = unzip [ mkFinalId codegen_ids True id rhs + | (id,rhs) <- needed_prs, not (omitIfaceSigForId id)] + extras = unionVarSets extras_s + (more_emitted, more_extras) = go_rec extras leftover_prs + + is_needed (id,_) = need_id needed id \end{code} -\begin{code} -ifaceInstanceModules Nothing{-no iface handle-} _ = return () -ifaceInstanceModules (Just _) [] = return () -ifaceInstanceModules (Just if_hdl) imods - = hPutStr if_hdl "\n__instance_modules__\n" >> - hPutStr if_hdl (uppShow 0 (uppCat (map uppPStr imods))) -\end{code} -Export list: grab the Names of things that are marked Exported, sort -(so the interface file doesn't ``wobble'' from one compilation to the -next...), and print. Note that the ``module'' now contains all the -imported things that we are dealing with, thus including any entities -that we are re-exporting from somewhere else. \begin{code} -ifaceExportList Nothing{-no iface handle-} _ _ = return () - -ifaceExportList (Just if_hdl) - export_fn -- sadly, just the HsModule isn't enough, - -- because it will have no record of exported - -- wired-in names. - (HsModule _ _ _ _ _ typedecls _ classdecls _ _ _ binds sigs _) - = let - (vals_wired, tcs_wired) - = case builtinNameInfo of { ((vals_fm,tcs_fm), _, _) -> - (eltsFM vals_fm, eltsFM tcs_fm) } - - name_flag_pairs :: FiniteMap OrigName ExportFlag - name_flag_pairs - = foldr (from_wired True{-val-ish-}) - (foldr (from_wired False{-tycon-ish-}) - (foldr from_ty - (foldr from_cls - (foldr from_sig - (from_binds binds emptyFM{-init accum-}) - sigs) - classdecls) - typedecls) - tcs_wired) - vals_wired - - sorted_pairs = sortLt lexical_lt (fmToList name_flag_pairs) - - in - hPutStr if_hdl "\n__exports__\n" >> - hPutStr if_hdl (uppShow 0 (uppAboves (map upp_pair sorted_pairs))) +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 - from_ty (TyData _ n _ _ _ _ _) acc = maybe_add acc n - from_ty (TyNew _ n _ _ _ _ _) acc = maybe_add acc n - from_ty (TySynonym n _ _ _) acc = maybe_add acc n - - from_cls (ClassDecl _ n _ _ _ _ _) acc = maybe_add acc n - - from_sig (Sig n _ _ _) acc = maybe_add acc n - - from_binds bs acc = maybe_add_list acc (collectTopLevelBinders bs) - - -------------- - from_wired is_val_ish rn acc - | on_in_acc = acc -- if already in acc (presumably from real decl), - -- don't take the dubious export flag from the - -- wired-in chappy - | is_val_ish && isRnConstr rn - = acc -- these things don't cause export-ery - | exportFlagOn ef = addToFM acc on ef - | otherwise = acc - where - n = getName rn - ef = export_fn n - on = origName "from_wired" n - (OrigName _ str) = on - on_in_acc = maybeToBool (lookupFM acc on) - - -------------- - maybe_add :: FiniteMap OrigName ExportFlag -> RnName -> FiniteMap OrigName ExportFlag - - maybe_add acc rn - | on_in_acc = trace "maybe_add?" acc -- surprising! - | exportFlagOn ef = addToFM acc on ef - | otherwise = acc - where - ef = nameExportFlag n - n = getName rn - on = origName "maybe_add" n - on_in_acc = maybeToBool (lookupFM acc on) - - -------------- - maybe_add_list acc [] = acc - maybe_add_list acc (n:ns) = maybe_add (maybe_add_list acc ns) n - - -------------- - lexical_lt (n1,_) (n2,_) = n1 < n2 - - -------------- - upp_pair (OrigName m n, ef) - = uppBesides [uppPStr m, uppSP, uppPStr n, uppSP, upp_export ef] - where - upp_export ExportAll = uppPStr SLIT("(..)") - upp_export ExportAbs = uppNil + core_idinfo = idInfo id + stg_idinfo = case lookupVarSet codegen_ids id of + Just id' -> idInfo id' + Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $ + idInfo id + + new_idinfo | opt_OmitInterfacePragmas + = vanillaIdInfo + | otherwise + = core_idinfo `setArityInfo` arity_info + `setCafInfo` cafInfo stg_idinfo + `setUnfoldingInfo` unfold_info + `setWorkerInfo` worker_info + `setSpecInfo` emptyCoreRules + -- We zap the specialisations because they are + -- passed on separately through the modules IdCoreRules + + ------------ Arity -------------- + arity_info = arityInfo stg_idinfo + stg_arity = arityLowerBound arity_info + + ------------ Worker -------------- + -- We only treat a function as having a worker if + -- the exported arity (which is now the number of visible lambdas) + -- is the same as the arity at the moment of the w/w split + -- If so, we can safely omit the unfolding inside the wrapper, and + -- instead re-generate it from the type/arity/strictness info + -- But if the arity has changed, we just take the simple path and + -- put the unfolding into the interface file, forgetting the fact + -- that it's a wrapper. + -- + -- How can this happen? Sometimes we get + -- f = coerce t (\x y -> $wf x y) + -- at the moment of w/w split; but the eta reducer turns it into + -- f = coerce t $wf + -- which is perfectly fine except that the exposed arity so far as + -- the code generator is concerned (zero) differs from the arity + -- when we did the split (2). + -- + -- All this arises because we use 'arity' to mean "exactly how many + -- top level lambdas are there" in interface files; but during the + -- compilation of this module it means "how many things can I apply + -- this to". + worker_info = case workerInfo core_idinfo of + info@(HasWorker work_id wrap_arity) + | wrap_arity == stg_arity -> info + | otherwise -> pprTrace "ifaceId: arity change:" (ppr id) + NoWorker + NoWorker -> NoWorker + + has_worker = case worker_info of + HasWorker _ _ -> True + other -> False + + HasWorker work_id _ = worker_info + + ------------ Unfolding -------------- + inline_pragma = inlinePragInfo core_idinfo + dont_inline = isNeverInlinePrag inline_pragma + loop_breaker = isLoopBreaker (occInfo core_idinfo) + bottoming_fn = isBottomingStrictness (strictnessInfo core_idinfo) + + unfolding = mkTopUnfolding rhs + rhs_is_small = neverUnfold unfolding + + unfold_info | show_unfold = unfolding + | otherwise = noUnfolding + + show_unfold = not has_worker && -- Not unnecessary + not bottoming_fn && -- Not necessary + not dont_inline && + not loop_breaker && + rhs_is_small && -- Small enough + okToUnfoldInHiFile rhs -- No casms etc + + + ------------ Extra free Ids -------------- + new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet + | otherwise = worker_ids `unionVarSet` + unfold_ids `unionVarSet` + spec_ids + + spec_ids = filterVarSet interestingId (rulesRhsFreeVars (specInfo core_idinfo)) + + worker_ids | has_worker && interestingId work_id = unitVarSet work_id + -- Conceivably, the worker might come from + -- another module + | otherwise = emptyVarSet + + unfold_ids | show_unfold = find_fvs rhs + | otherwise = emptyVarSet + + find_fvs expr = exprSomeFreeVars interestingId expr + +interestingId id = isId id && isLocallyDefined id && not (hasNoBinding id) \end{code} + \begin{code} -ifaceFixities Nothing{-no iface handle-} _ = return () - -ifaceFixities (Just if_hdl) (HsModule _ _ _ _ fixities _ _ _ _ _ _ _ _ _) - = let - pp_fixities = foldr go [] fixities - in - if null pp_fixities then - return () - else - hPutStr if_hdl "\n__fixities__\n" >> - hPutStr if_hdl (uppShow 0 (uppAboves pp_fixities)) +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 - go (InfixL v i) acc = (if isLocallyDefined v then (:) (print_fix "l" i v) else id) acc - go (InfixR v i) acc = (if isLocallyDefined v then (:) (print_fix "r" i v) else id) acc - go (InfixN v i) acc = (if isLocallyDefined v then (:) (print_fix "" i v) else id) acc - - print_fix suff prec var - = uppBesides [uppPStr SLIT("infix"), uppStr suff, uppSP, uppInt prec, uppSP, ppr_name var, uppSemi] + 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} -\begin{code} -non_wired x = not (isWiredInName (getName x)) --ToDo:move? - -ifaceDecls Nothing{-no iface handle-} _ = return () - -ifaceDecls (Just if_hdl) (vals, tycons, classes, _) - = ASSERT(all isLocallyDefined vals) - ASSERT(all isLocallyDefined tycons) - ASSERT(all isLocallyDefined classes) - let - nonwired_classes = filter non_wired classes - nonwired_tycons = filter non_wired tycons - nonwired_vals = filter non_wired vals - - lt_lexical a b = origName "lt_lexical" a < origName "lt_lexical" b - - sorted_classes = sortLt lt_lexical nonwired_classes - sorted_tycons = sortLt lt_lexical nonwired_tycons - sorted_vals = sortLt lt_lexical nonwired_vals - in - if (null sorted_classes && null sorted_tycons && null sorted_vals) then - -- You could have a module with just (re-)exports/instances in it - return () - else - hPutStr if_hdl "\n__declarations__\n" >> - hPutStr if_hdl (uppShow 0 (uppAboves [ - uppAboves (map ppr_class sorted_classes), - uppAboves (map ppr_tycon sorted_tycons), - uppAboves [ppr_val v (idType v) | v <- sorted_vals]])) -\end{code} + +%************************************************************************ +%* * +\subsection{Checking if the new interface is up to date +%* * +%************************************************************************ \begin{code} -ifaceInstances Nothing{-no iface handle-} _ = return () - -ifaceInstances (Just if_hdl) (_, _, _, insts) - = let - togo_insts = filter is_togo_inst (bagToList insts) - - sorted_insts = sortLt lt_inst togo_insts - in - if null togo_insts then - return () - else - hPutStr if_hdl "\n__instances__\n" >> - hPutStr if_hdl (uppShow 0 (uppAboves (map pp_inst sorted_insts))) +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 - is_togo_inst (InstInfo clas _ ty _ _ _ _ _ from_here _ _ _) - = from_here -- && ... - - ------- - lt_inst (InstInfo clas1 _ ty1 _ _ _ _ _ _ _ _ _) - (InstInfo clas2 _ ty2 _ _ _ _ _ _ _ _ _) - = let - tycon1 = fst (getAppTyCon ty1) - tycon2 = fst (getAppTyCon ty2) - in - case (origName "lt_inst" clas1 `cmp` origName "lt_inst" clas2) of - LT_ -> True - GT_ -> False - EQ_ -> origName "lt_inst2" tycon1 < origName "lt_inst2" tycon2 - - ------- - pp_inst (InstInfo clas tvs ty theta _ _ _ _ _ _ _ _) - = let - forall_ty = mkSigmaTy tvs theta (mkDictTy clas ty) - renumbered_ty = initNmbr (nmbrType forall_ty) - in - case (splitForAllTy renumbered_ty) of { (rtvs, rrho_ty) -> - uppBesides [uppPStr SLIT("instance "), ppr_forall rtvs, ppr_ty rrho_ty, uppSemi] } + 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{Printing tycons, classes, ...} -%* * +%* * +\subsection{Writing an interface file} +%* * %************************************************************************ \begin{code} -ppr_class :: Class -> Unpretty - -ppr_class c - = --pprTrace "ppr_class:" (ppr PprDebug c) $ - case (initNmbr (nmbrClass c)) of { -- renumber it! - Class _ n tyvar super_classes sdsels ops sels defms insts links -> - - uppCat [uppPStr SLIT("class"), ppr_context tyvar super_classes, - ppr_name n, ppr_tyvar tyvar, - if null ops - then uppSemi - else uppCat [uppStr "where {", uppCat (map ppr_op ops), uppStr "};"]] - } +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 - ppr_context :: TyVar -> [Class] -> Unpretty - - ppr_context tv [] = uppNil --- ppr_context tv [sc] = uppBeside (ppr_assert tv sc) (uppPStr SLIT(" =>")) - ppr_context tv super_classes - = uppBesides [uppStr "{{", - uppIntersperse upp'SP{-'-} (map (ppr_assert tv) super_classes), - uppStr "}} =>"] + version_info = mi_version iface + decls = mi_decls iface + exp_vers = vers_exports version_info + rule_vers = vers_rules version_info - ppr_assert tv (Class _ n _ _ _ _ _ _ _ _) = uppCat [ppr_name n, ppr_tyvar tv] + pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty + | otherwise = brackets (ppr exp_vers <+> ppr rule_vers) +\end{code} - clas_mod = moduleOf (origName "ppr_class" c) +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 - ppr_op (ClassOp o _ ty) = pp_sig (Qual clas_mod o) ty +\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} -ppr_val v ty -- renumber the type first! - = --pprTrace "ppr_val:" (ppr PprDebug v) $ - pp_sig v (initNmbr (nmbrType ty)) +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} -pp_sig op ty - = case (splitForAllTy ty) of { (tvs, rho_ty) -> - uppBesides [ppr_name op, uppPStr SLIT(" :: "), ppr_forall tvs, ppr_ty rho_ty, uppSemi] } +\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 -ppr_forall [] = uppNil -ppr_forall tvs = uppBesides [ uppStr "__forall__ [", uppInterleave uppComma (map ppr_tyvar tvs), uppStr "] " ] + -- 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} -ppr_tycon tycon - = --pprTrace "ppr_tycon:" (ppr PprDebug tycon) $ - ppr_tc (initNmbr (nmbrTyCon tycon)) - ------------------------- -ppr_tc (PrimTyCon _ n _ _) - = uppCat [ uppStr "{- data", ppr_name n, uppStr " *built-in* -}" ] - -ppr_tc FunTyCon - = uppCat [ uppStr "{- data", ppr_name FunTyCon, uppStr " *built-in* -}" ] - -ppr_tc (TupleTyCon _ n _) - = uppCat [ uppStr "{- ", ppr_name n, uppStr "-}" ] - -ppr_tc (SynTyCon _ n _ _ tvs expand) - = let - pp_tyvars = map ppr_tyvar tvs - in - uppBesides [uppPStr SLIT("type "), ppr_name n, uppSP, uppIntersperse uppSP pp_tyvars, - uppPStr SLIT(" = "), ppr_ty expand, uppSemi] - -ppr_tc this_tycon@(DataTyCon u n k tvs ctxt cons derivings data_or_new) - = uppCat [pp_data_or_new, - ppr_context ctxt, - ppr_name n, - uppIntersperse uppSP (map ppr_tyvar tvs), - uppEquals, pp_condecls, - uppSemi] - -- NB: we do not print deriving info in interfaces - where - pp_data_or_new = case data_or_new of - DataType -> uppPStr SLIT("data") - NewType -> uppPStr SLIT("newtype") - - ppr_context [] = uppNil --- ppr_context [(c,t)] = uppCat [ppr_name c, ppr_ty t, uppPStr SLIT("=>")] - ppr_context cs - = uppBesides[uppStr "{{", - uppInterleave uppComma [uppCat [ppr_name c, ppr_ty t] | (c,t) <- cs], - uppStr "}}", uppPStr SLIT(" =>")] - - pp_condecls - = let - (c:cs) = cons - in - uppCat ((ppr_con c) : (map ppr_next_con cs)) - - ppr_next_con con = uppCat [uppChar '|', ppr_con con] - - ppr_con con - = let - con_arg_tys = dataConRawArgTys con - labels = dataConFieldLabels con -- none if not a record - strict_marks = dataConStrictMarks con - in - uppCat [ppr_name con, ppr_fields labels strict_marks con_arg_tys] - - ppr_fields labels strict_marks con_arg_tys - = if null labels then -- not a record thingy - uppIntersperse uppSP (zipWithEqual "ppr_fields" ppr_bang_ty strict_marks con_arg_tys) - else - uppCat [ uppChar '{', - uppInterleave uppComma (zipWith3Equal "ppr_field" ppr_field labels strict_marks con_arg_tys), - uppChar '}' ] - - ppr_bang_ty b t - = uppBeside (case b of { MarkedStrict -> uppChar '!'; _ -> uppNil }) - (prettyToUn (pprParendType PprInterface t)) - - ppr_field l b t - = uppBesides [ppr_name l, uppPStr SLIT(" :: "), - case b of { MarkedStrict -> uppChar '!'; _ -> uppNil }, - ppr_ty t] +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}