%
-% (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 (
- startIface, endIface,
- ifaceMain,
- ifaceDecls
- ) where
+module MkIface (
+ mkModDetails, mkModDetailsFromIface, completeIface, writeIface
+ ) where
-IMP_Ubiq(){-uitous-}
-IMPORT_1_3(IO(Handle,hPutStr,openFile,hClose,IOMode(..)))
+#include "HsVersions.h"
import HsSyn
-import RdrHsSyn ( RdrName(..) )
-import RnHsSyn ( SYN_IE(RenamedHsModule) )
+import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr )
+import HsTypes ( toHsTyVars )
+import BasicTypes ( Fixity(..), NewOrData(..),
+ Version, initialVersion, bumpVersion, isLoopBreaker
+ )
import RnMonad
-import RnEnv ( availName )
-
-import TcInstUtil ( InstInfo(..) )
+import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl )
+import TcHsSyn ( TypecheckedRuleDecl )
+import HscTypes ( VersionInfo(..), IfaceDecls(..), ModIface(..), ModDetails(..),
+ TyThing(..), DFunId, TypeEnv, isTyClThing, Avails,
+ WhatsImported(..), GenAvailInfo(..),
+ ImportVersion, AvailInfo, Deprecations(..),
+ Finder, ModuleLocation(..)
+ )
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, idName, setIdInfo
)
-import IdInfo ( StrictnessInfo, ArityInfo, Unfolding,
- arityInfo, ppArityInfo, strictnessInfo, ppStrictnessInfo,
- getWorkerId_maybe, bottomIsGuaranteed
+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 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 CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars )
+import CoreUnfold ( okToUnfoldInHiFile, mkTopUnfolding, neverUnfold, unfoldingTemplate, noUnfolding )
+import Name ( isLocallyDefined, getName,
+ Name, NamedThing(..),
+ plusNameEnv, lookupNameEnv, emptyNameEnv, mkNameEnv,
+ extendNameEnv, lookupNameEnv_NF, nameEnvElts
)
-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 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 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, 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
-
-ifaceMain :: Maybe Handle
- -> InterfaceDetails
- -> IO ()
-
-
-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 ()
+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
+ 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
+ -> Maybe (ModIface, 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.
+ --
+ -- The IO in the type is solely for debug output
+ -- In particular, dumping a record of what has changed
+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 }
-endIface :: Maybe Handle -> IO ()
+ inst_dcls = map ifaceInstance (md_insts mod_details)
+ ty_cls_dcls = map ifaceTyCls (nameEnvElts (md_types mod_details))
+ rule_dcls = map ifaceRule (md_rules mod_details)
\end{code}
-\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
-\end{code}
+%************************************************************************
+%* *
+\subsection{Types and classes}
+%* *
+%************************************************************************
\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 ()
-\end{code}
+ifaceTyCls :: TyThing -> RenamedTyClDecl
+ifaceTyCls (AClass clas)
+ = ClassDecl (toHsContext sc_theta)
+ (getName clas)
+ (toHsTyVars clas_tyvars)
+ (toHsFDs clas_fds)
+ (map toClassOpSig op_stuff)
+ EmptyMonoBinds
+ [] noSrcLoc
+ where
+ (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas
-\begin{code}
-ifaceUsages if_hdl import_usages
- = hPutStr if_hdl "_usages_\n" >>
- hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages)
+ 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)
+ | isSynTyCon tycon
+ = TySynonym (getName tycon)(toHsTyVars tyvars) (toHsType ty) noSrcLoc
+ where
+ (tyvars, ty) = getSynTyConDefn tycon
+
+ifaceTyCls (ATyCon tycon)
+ | 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")
where
- upp_uses (m, mv, versions)
- = uppBesides [upp_module m, uppSP, uppInt mv, uppPStr SLIT(" :: "),
- upp_import_versions (sort_versions versions), uppSemi]
+ tyvars = tyConTyVars 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)
- -- 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 ]
+ 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))
-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"
+ifaceTyCls (ATyCon tycon) = pprPanic "ifaceTyCls" (ppr tycon)
-ifaceExports if_hdl [] = return ()
-ifaceExports if_hdl avails
- = hPutStr if_hdl "_exports_\n" >>
- hPutCol if_hdl do_one_module (fmToList export_fm)
+ifaceTyCls (AnId id)
+ = IfaceSig (getName id) (toHsType id_type) hs_idinfo noSrcLoc
where
- -- Sort them into groups by module
- export_fm :: FiniteMap Module [AvailInfo]
- export_fm = foldr insert emptyFM avails
+ id_type = idType id
+ id_info = idInfo id
- insert NotAvailable efm = efm
- insert avail efm = addToFM_C (++) efm mod [avail]
- where
- (mod,_) = modAndOcc (availName avail)
+ hs_idinfo | opt_OmitInterfacePragmas = []
+ | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++
+ strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo
- -- 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]
+ ------------ Arity --------------
+ arity_hsinfo = case arityInfo id_info of
+ a@(ArityExactly n) -> [HsArity a]
+ other -> []
-ifaceFixities if_hdl [] = return ()
-ifaceFixities if_hdl fixities
- = hPutStr if_hdl "_fixities_\n" >>
- hPutCol if_hdl upp_fixity fixities
+ ------------ Caf Info --------------
+ caf_hsinfo = case cafInfo id_info of
+ NoCafRefs -> [HsNoCafRefs]
+ otherwise -> []
-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
+ ------------ CPR Info --------------
+ cpr_hsinfo = case cprInfo id_info of
+ ReturnsCPR -> [HsCprInfo]
+ NoCPRInfo -> []
- for_iface_name name = isLocallyDefined name &&
- not (isWiredInName name)
+ ------------ 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}
- lt_decl d1 d2 = hsDeclName d1 < hsDeclName d2
-\end{code}
%************************************************************************
%* *
-\subsection{Instance declarations}
+\subsection{Instances and rules}
%* *
%************************************************************************
-
\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
-
- -------
- 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]
+ifaceInstance :: DFunId -> RenamedInstDecl
+ifaceInstance dfun_id
+ = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc
+ where
+ 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}
%************************************************************************
%* *
-\subsection{Printing values}
-%* *
+\subsection{Compute final Ids}
+%* *
%************************************************************************
+A "final Id" has exactly the IdInfo for going into an interface file, or
+exporting to another module.
+
\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)
+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
- pp_double_semi = ppPStr SLIT(";;")
- idinfo = get_idinfo id
- inline_pragma = idWantsToBeINLINEd 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 [] 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
+ = if omitIfaceSigForId id then
+ go (needed `delVarSet` id) binds (id:emitted)
+ else
+ go ((needed `unionVarSet` extras) `delVarSet` id)
+ binds
+ (new_id:emitted)
+ | otherwise
+ = go needed binds emitted
+ where
+ (new_id, extras) = mkFinalId codegen_ids False id rhs
- ty_pretty = pprType PprInterface (initNmbr (nmbrType (idType id)))
- sig_pretty = ppBesides [ppr PprInterface (getOccName id), ppPStr SLIT(" _:_ "), ty_pretty]
+ -- 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
- prag_pretty
- | opt_OmitInterfacePragmas = ppNil
- | otherwise = ppCat [arity_pretty, strict_pretty, unfold_pretty, pp_double_semi]
+ 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
- ------------ Arity --------------
- arity_pretty = ppArityInfo PprInterface (arityInfo idinfo)
+ is_needed (id,_) = need_id needed id
+\end{code}
- ------------ Strictness --------------
- strict_info = strictnessInfo idinfo
- maybe_worker = getWorkerId_maybe strict_info
- strict_pretty = ppStrictnessInfo PprInterface strict_info
+
+
+\begin{code}
+mkFinalId :: IdSet -- The Ids with arity info from the code generator
+ -> Bool -- True <=> recursive, so don't include unfolding
+ -> Id
+ -> CoreExpr -- The Id's right hand side
+ -> (Id, IdSet) -- The emitted id, plus any *extra* needed Ids
+
+mkFinalId codegen_ids is_rec id rhs
+ = (id `setIdInfo` new_idinfo, new_needed_ids)
+ where
+ core_idinfo = idInfo id
+ stg_idinfo = case lookupVarSet codegen_ids id of
+ Just id' -> idInfo id'
+ Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $
+ idInfo id
+
+ new_idinfo | opt_OmitInterfacePragmas
+ = vanillaIdInfo
+ | otherwise
+ = core_idinfo `setArityInfo` arity_info
+ `setCafInfo` cafInfo stg_idinfo
+ `setUnfoldingInfo` unfold_info
+ `setWorkerInfo` worker_info
+ `setSpecInfo` emptyCoreRules
+ -- We zap the specialisations because they are
+ -- passed on separately through the modules IdCoreRules
+
+ ------------ Arity --------------
+ arity_info = arityInfo stg_idinfo
+ stg_arity = arityLowerBound arity_info
+
+ ------------ Worker --------------
+ -- We only treat a function as having a worker if
+ -- the exported arity (which is now the number of visible lambdas)
+ -- is the same as the arity at the moment of the w/w split
+ -- If so, we can safely omit the unfolding inside the wrapper, and
+ -- instead re-generate it from the type/arity/strictness info
+ -- But if the arity has changed, we just take the simple path and
+ -- put the unfolding into the interface file, forgetting the fact
+ -- that it's a wrapper.
+ --
+ -- How can this happen? Sometimes we get
+ -- f = coerce t (\x y -> $wf x y)
+ -- at the moment of w/w split; but the eta reducer turns it into
+ -- f = coerce t $wf
+ -- which is perfectly fine except that the exposed arity so far as
+ -- the code generator is concerned (zero) differs from the arity
+ -- when we did the split (2).
+ --
+ -- All this arises because we use 'arity' to mean "exactly how many
+ -- top level lambdas are there" in interface files; but during the
+ -- compilation of this module it means "how many things can I apply
+ -- this to".
+ worker_info = case workerInfo core_idinfo of
+ info@(HasWorker work_id wrap_arity)
+ | wrap_arity == stg_arity -> info
+ | otherwise -> pprTrace "ifaceId: arity change:" (ppr id)
+ NoWorker
+ NoWorker -> NoWorker
+
+ has_worker = case worker_info of
+ HasWorker _ _ -> True
+ other -> False
+
+ HasWorker work_id _ = worker_info
------------ Unfolding --------------
- unfold_pretty | show_unfold = ppCat [ppPStr SLIT("_U_"), pprIfaceUnfolding rhs]
- | otherwise = ppNil
+ inline_pragma = inlinePragInfo core_idinfo
+ dont_inline = isNeverInlinePrag inline_pragma
+ loop_breaker = isLoopBreaker (occInfo core_idinfo)
+ bottoming_fn = isBottomingStrictness (strictnessInfo core_idinfo)
- show_unfold = not implicit_unfolding && -- Unnecessary
- (inline_pragma || not dodgy_unfolding) -- Dangerous
+ unfolding = mkTopUnfolding rhs
+ rhs_is_small = neverUnfold unfolding
- implicit_unfolding = maybeToBool maybe_worker ||
- bottomIsGuaranteed strict_info
+ unfold_info | show_unfold = unfolding
+ | otherwise = noUnfolding
- dodgy_unfolding = is_rec || -- No recursive unfoldings please!
- case guidance of -- Too big to show
- UnfoldNever -> True
- other -> False
+ 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
- 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)
+ 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}
-ifaceBinds :: Handle
- -> 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 ()
-
-ifaceBinds hdl needed_ids final_ids binds
- = hPutStr hdl (uppShow 0 (prettyToUn (ppAboves pretties))) >>
- hPutStr hdl "\n"
+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
- 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
-
- -- 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
- 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
-
- go_rec :: IdSet -> [(Id,CoreExpr)] -> (IdSet, [Pretty])
- go_rec needed pairs
- | null pretties = (needed, [])
- | otherwise = (final_needed, more_pretties ++ pretties)
- 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)
+ local_rules = [ (fn, rule)
+ | fn <- bindersOfBinds binds,
+ fn `elemVarSet` emitted,
+ rule <- rulesRules (idSpecialisation fn),
+ not (isBuiltinRule rule),
+ -- We can't print builtin rules in interface files
+ -- Since they are built in, an importing module
+ -- will have access to them anyway
+
+ -- Sept 00: I've disabled this test. It doesn't stop many, if any, rules
+ -- from coming out, and to make it work properly we need to add ????
+ -- (put it back in for now)
+ all (`elemVarSet` emitted) (varSetElems (ruleSomeLhsFreeVars interestingId rule))
+ -- Spit out a rule only if all its lhs free vars are emitted
+ -- This is a good reason not to do it when we emit the Id itself
+ ]
\end{code}
%************************************************************************
%* *
-\subsection{Random small things}
+\subsection{Checking if the new interface is up to date
%* *
%************************************************************************
-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)
+addVersionInfo :: Maybe ModIface -- The old interface, read from M.hi
+ -> ModIface -- The new interface decls
+ -> Maybe (ModIface, 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!
+ = Just (new_iface, 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
+ = Nothing
+
+ | otherwise -- Add updated version numbers
+ = Just (final_iface, pp_tc_diffs)
+
+ where
+ final_iface = new_iface { mi_version = new_version }
+ new_version = VersionInfo { vers_module = bumpVersion no_output_change (vers_module old_version),
+ vers_exports = bumpVersion no_export_change (vers_exports old_version),
+ vers_rules = bumpVersion no_rule_change (vers_rules old_version),
+ vers_decls = tc_vers }
-ppr_name :: NamedThing a => a -> Unpretty -- Its full name
-ppr_name n = uppPStr (nameString (getName n))
+ no_output_change = no_tc_change && no_rule_change && no_export_change
+ no_usage_change = mi_usages old_iface == mi_usages new_iface
-upp_occname :: OccName -> Unpretty
-upp_occname occ = uppPStr (occNameString occ)
+ 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
-upp_module :: Module -> Unpretty
-upp_module mod = uppPStr mod
+ -- 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)
-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_tyvar_bndr tv = prettyToUn (pprTyVarBndr PprInterface tv)
-ppr_decl decl = prettyToUn (ppr PprInterface decl) `uppBeside` uppSemi
+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
-renumber_ty ty = initNmbr (nmbrType ty)
+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{Comparisons
+\subsection{Writing an interface file}
%* *
%************************************************************************
-
-
-The various sorts above simply prevent unnecessary "wobbling" when
-things change that don't have to. We therefore compare lexically, not
-by unique
\begin{code}
-lt_avail :: AvailInfo -> AvailInfo -> Bool
-
-a1 `lt_avail` a2 = availName a1 `lt_name` availName a2
+writeIface :: Finder -> Maybe ModIface -> IO ()
+writeIface finder Nothing
+ = return ()
+
+writeIface finder (Just mod_iface)
+ = do { maybe_found <- finder mod_name ;
+ ; case maybe_found of {
+ Nothing -> printErrs (text "Can't write interface file for" <+> ppr mod_name) ;
+ Just (_, locn) ->
+
+ do { let filename = hi_file locn
+ ; if_hdl <- openFile filename WriteMode
+ ; printForIface if_hdl (pprIface mod_iface)
+ ; hClose if_hdl
+ }}}
+ where
+ mod_name = moduleName (mi_module mod_iface)
+
+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))
+
+ , pprIfaceDecls (vers_decls version_info)
+ (mi_fixities iface)
+ (mi_decls iface)
+
+ , pprDeprecs (mi_deprecs iface)
+ ]
+ where
+ version_info = mi_version iface
+ exp_vers = vers_exports version_info
+ rule_vers = vers_rules version_info
-lt_name :: Name -> Name -> Bool
-n1 `lt_name` n2 = modAndOcc n1 < modAndOcc n2
+ pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty
+ | otherwise = brackets (ppr exp_vers <+> ppr rule_vers)
+\end{code}
-lt_lexical :: NamedThing a => a -> a -> Bool
-lt_lexical a1 a2 = getName a1 `lt_name` getName a2
+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
-lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool
-lt_imp_vers (m1,_,_) (m2,_,_) = m1 < m2
+\begin{code}
+pprExport :: (ModuleName, Avails) -> SDoc
+pprExport (mod, items)
+ = hsep [ ptext SLIT("__export "), ppr mod, hsep (map pp_avail items) ] <> semi
+ where
+ ppr_name :: Name -> SDoc -- Print the occurrence name only
+ ppr_name n = ppr (nameOccName n)
+
+ pp_avail :: AvailInfo -> SDoc
+ pp_avail (Avail name) = ppr_name name
+ pp_avail (AvailTC name []) = empty
+ pp_avail (AvailTC name ns) = hcat [ppr_name name, bang, pp_export ns']
+ where
+ bang | name `elem` ns = empty
+ | otherwise = char '|'
+ ns' = filter (/= name) ns
+
+ pp_export [] = empty
+ pp_export names = braces (hsep (map ppr_name names))
+\end{code}
-sort_versions vs = sortLt lt_vers vs
-lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool
-lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2
+\begin{code}
+pprUsage :: ImportVersion Name -> SDoc
+pprUsage (m, has_orphans, is_boot, whats_imported)
+ = hsep [ptext SLIT("import"), ppr m,
+ pp_orphan, pp_boot,
+ pp_versions whats_imported
+ ] <> semi
+ where
+ pp_orphan | has_orphans = char '!'
+ | otherwise = empty
+ pp_boot | is_boot = char '@'
+ | otherwise = empty
+
+ -- Importing the whole module is indicated by an empty list
+ pp_versions NothingAtAll = empty
+ pp_versions (Everything v) = dcolon <+> int v
+ pp_versions (Specifically vm ve nvs vr) = dcolon <+> int vm <+> pp_export_version ve <+> int vr
+ <+> hsep [ ppr n <+> int v | (n,v) <- nvs ]
+
+ -- HACK for the moment: print the export-list version even if
+ -- we don't use it, so that syntax of interface files doesn't change
+ pp_export_version Nothing = int 1
+ pp_export_version (Just v) = int v
\end{code}
+\begin{code}
+pprIfaceDecls version_map fixity_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_fixes d
+
+ -- Print the version for the decl
+ ppr_vers d = case lookupNameEnv version_map (tyClDeclName d) of
+ Nothing -> empty
+ Just v -> int v
+
+ -- Print fixities relevant to the decl
+ ppr_fixes d = vcat [ ppr fix <+> ppr n <> semi
+ | (n,_) <- tyClDeclNames d,
+ Just fix <- [lookupNameEnv fixity_map n]
+ ]
+\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"
+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) = pprOccName (nameOccName name) <+> ptext txt
\end{code}
projects / ghc-hetmet.git / blobdiff