%
-% (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 (
- startIface, endIface,
- ifaceMain,
- ifaceDecls
- ) where
+module MkIface ( completeIface ) where
#include "HsVersions.h"
-import IO ( Handle, hPutStr, openFile,
- hClose, hPutStrLn, IOMode(..) )
-
import HsSyn
-import RdrHsSyn ( RdrName(..) )
-import RnHsSyn ( RenamedHsModule )
-import BasicTypes ( Fixity(..), FixityDirection(..), NewOrData(..), IfaceFlavour(..),
- pprModule
+import HsCore ( HsIdInfo(..), toUfExpr, ifaceSigName )
+import HsTypes ( toHsTyVars )
+import BasicTypes ( Fixity(..), NewOrData(..),
+ Version, bumpVersion, isLoopBreaker
)
import RnMonad
-import RnEnv ( availName, ifaceFlavour )
-
-import TcInstUtil ( InstInfo(..) )
-import WorkWrap ( getWorkerIdAndCons )
+import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl, RenamedRuleDecl, RenamedIfaceSig )
+import HscTypes ( VersionInfo(..), IfaceDecls(..), ModIface(..), ModDetails(..),
+ TyThing(..), DFunId )
import CmdLineOpts
-import Id ( idType, dataConRawArgTys, dataConFieldLabels,
- idInfo, omitIfaceSigForId,
- dataConStrictMarks, StrictnessMark(..),
- IdSet, idSetToList, unionIdSets, unitIdSet, minusIdSet,
- isEmptyIdSet, elementOfIdSet, emptyIdSet, mkIdSet,
- pprId, getIdSpecialisation,
- Id
+import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, hasNoBinding,
+ idSpecialisation
)
-import IdInfo ( IdInfo, StrictnessInfo, ArityInfo, InlinePragInfo(..), inlinePragInfo,
- arityInfo, ppArityInfo, strictnessInfo, ppStrictnessInfo,
- bottomIsGuaranteed, workerExists,
+import Var ( isId )
+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 ( CoreExpr, CoreBinding, GenCoreExpr, GenCoreBinding(..) )
-import CoreUnfold ( calcUnfoldingGuidance, UnfoldingGuidance(..), Unfolding )
-import FreeVars ( exprFreeVars )
-import Name ( isLocallyDefined, isWiredInName, modAndOcc, nameModule, pprOccName,
- OccName, occNameString, nameOccName, nameString, isExported,
- Name {-instance NamedThing-}, Provenance, NamedThing(..)
+import CoreSyn ( CoreExpr, CoreBind, Bind(..), isBuiltinRule, rulesRules, rulesRhsFreeVars )
+import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars )
+import CoreUnfold ( okToUnfoldInHiFile, couldBeSmallEnoughToInline )
+import Name ( isLocallyDefined, getName, nameModule,
+ Name, NamedThing(..),
+ plusNameEnv, lookupNameEnv, emptyNameEnv, extendNameEnv, lookupNameEnv_NF, nameEnvElts
)
import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon,
- tyConTheta, tyConTyVars, tyConDataCons
+ tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize
)
-import Class ( Class, classBigSig )
-import SpecEnv ( specEnvToList )
-import FieldLabel ( fieldLabelName, fieldLabelType )
-import Type ( mkSigmaTy, splitSigmaTy, mkDictTy,
- mkTyVarTys, Type, ThetaType
- )
-
-import PprEnv -- not sure how much...
-import PprType
-import PprCore ( pprIfaceUnfolding )
-
-import Bag ( bagToList, isEmptyBag )
-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 )
-import Outputable
-\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@.
-
-\begin{code}
-startIface :: Module
- -> IO (Maybe Handle) -- Nothing <=> don't do an interface
-
-ifaceMain :: Maybe Handle
- -> InterfaceDetails
- -> IO ()
+import Class ( classExtraBigSig, DefMeth(..) )
+import FieldLabel ( fieldLabelType )
+import Type ( splitSigmaTy, tidyTopType, deNoteType )
+import Rules ( ProtoCoreRule(..) )
-ifaceDecls :: Maybe Handle
- -> [TyCon] -> [Class]
- -> Bag InstInfo
- -> [Id] -- Ids used at code-gen time; they have better pragma info!
- -> [CoreBinding] -- In dependency order, later depend on earlier
- -> IO ()
-
-endIface :: Maybe Handle -> IO ()
-\end{code}
-
-\begin{code}
-startIface mod
- = case opt_ProduceHi of
- Nothing -> return Nothing -- not producing any .hi file
- Just fn -> do
- if_hdl <- openFile fn WriteMode
- hPutStrLn if_hdl ("_interface_ "++ _UNPK_ mod ++ ' ':show (PROJECTVERSION :: Int))
- return (Just if_hdl)
-
-endIface Nothing = return ()
-endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl
-\end{code}
-
+import Bag ( bagToList )
+import UniqFM ( lookupUFM, listToUFM )
+import SrcLoc ( noSrcLoc )
+import Bag
+import Outputable
-\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 tycons classes inst_info final_ids simplified = return ()
-ifaceDecls (Just hdl)
- tycons classes
- 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" >>
- ifaceClasses hdl classes >>
- ifaceTyCons hdl tycons >>
- ifaceBinds hdl needed_ids final_ids binds >>
- return ()
- where
- null_decls = null binds &&
- null tycons &&
- null classes &&
- isEmptyBag inst_infos
+import List ( partition )
\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)
- where
- upp_uses (m, hif, mv, whats_imported)
- = hsep [pprModule m, pp_hif hif, int mv, ptext SLIT("::"),
- upp_import_versions whats_imported
- ] <> semi
-
- -- Importing the whole module is indicated by an empty list
- upp_import_versions Everything = empty
-
- -- For imported versions we do print the version number
- upp_import_versions (Specifically nvs)
- = hsep [ hsep [ppr_unqual_name n, int v] | (n,v) <- sort_versions nvs ]
-
-ifaceInstanceModules if_hdl [] = return ()
-ifaceInstanceModules if_hdl imods
- = hPutStr if_hdl "_instance_modules_\n" >>
- printForIface if_hdl (hsep (map ptext (sortLt (<) imods))) >>
- hPutStr if_hdl "\n"
-
-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 = nameModule (availName avail)
-
- -- Print one module's worth of stuff
- do_one_module (mod_name, avails@(avail1:_))
- = hsep [pp_hif (ifaceFlavour (availName avail1)),
- pprModule mod_name,
- hsep (map upp_avail (sortLt lt_avail avails))
- ] <> semi
-
--- The "!" indicates that the exported things came from a hi-boot interface
-pp_hif HiFile = empty
-pp_hif HiBootFile = char '!'
-
-ifaceFixities if_hdl [] = return ()
-ifaceFixities if_hdl fixities
- = hPutStr if_hdl "_fixities_\n" >>
- hPutCol if_hdl upp_fixity fixities
-\end{code}
%************************************************************************
%* *
-\subsection{Instance declarations}
+\subsection{Write a new interface file}
%* *
%************************************************************************
+\begin{code}
+completeModDetails :: ModDetails
+ -> [CoreBind] -> [Id] -- Final bindings, plus the top-level Ids from the
+ -- code generator; they have authoritative arity info
+ -> [ProtoCoreRule] -- Tidy orphan rules
+ -> ModDetails
+
+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
+ tidy_binds final_ids tidy_orphan_rules
+ = let
+ new_decls = declsFromDetails mod_details tidy_binds final_ids tidy_orphan_rules
+ in
+ addVersionInfo maybe_old_iface (new_iface { mi_decls = new_decls })
+
+declsFromDetails :: ModDetails -> [CoreBind] -> [Id] -> [ProtoCoreRule] -> IfaceDecls
+declsFromDetails details tidy_binds final_ids tidy_orphan_rules
+ = IfaceDecls { dcl_tycl = ty_cls_dcls ++ bagToList val_dcls,
+ dcl_insts = inst_dcls,
+ dcl_rules = rule_dcls }
+ where
+ dfun_ids = md_insts details
+ inst_dcls = map ifaceInstance dfun_ids
+ ty_cls_dcls = map ifaceTyCls (filter emitTyCls (nameEnvElts (md_types details)))
+
+ (val_dcls, emitted_ids) = ifaceBinds (mkVarSet dfun_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
-
- -------
- pp_inst (InstInfo clas tvs tys theta _ dfun_id _ _ _)
- = let
- forall_ty = mkSigmaTy tvs theta (mkDictTy clas tys)
- renumbered_ty = nmbrGlobalType forall_ty
- in
- hcat [ptext SLIT("instance "), pprType renumbered_ty,
- ptext SLIT(" = "), ppr_unqual_name dfun_id, semi]
-\end{code}
+ rule_dcls | opt_OmitInterfacePragmas = []
+ | otherwise = ifaceRules tidy_orphan_rules emitted_ids
+ orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule
+ | ProtoCoreRule _ _ rule <- tidy_orphan_rules]
+
+\end{code}
%************************************************************************
%* *
-\subsection{Printing values}
+\subsection{Types and classes}
%* *
%************************************************************************
\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 (SDoc, 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 (hsep [sig_pretty, pp_double_semi, prag_pretty], new_needed_ids)
+emitTyCls :: TyThing -> Bool
+emitTyCls (ATyCon tc) = True -- Could filter out wired in ones, but it's not
+ -- strictly necessary, and it costs extra time
+emitTyCls (AClass cl) = True
+emitTyCls (AnId _) = False
+
+
+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
- pp_double_semi = ptext SLIT(";;")
- idinfo = get_idinfo id
- inline_pragma = inlinePragInfo idinfo
-
- ty_pretty = pprType (nmbrGlobalType (idType id))
- sig_pretty = hcat [ppr (getOccName id), ptext SLIT(" _:_ "), ty_pretty]
-
- prag_pretty
- | opt_OmitInterfacePragmas = empty
- | otherwise = hsep [arity_pretty, strict_pretty, unfold_pretty,
- spec_pretty, pp_double_semi]
-
- ------------ Arity --------------
- arity_pretty = ppArityInfo (arityInfo idinfo)
-
- ------------ Strictness --------------
- strict_info = strictnessInfo idinfo
- has_worker = workerExists strict_info
- strict_pretty = ppStrictnessInfo strict_info <+> wrkr_pretty
+ (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas
- wrkr_pretty | not has_worker = empty
- | null con_list = pprId work_id
- | otherwise = pprId work_id <+>
- braces (hsep (map (pprId) con_list))
-
- (work_id, wrapper_cons) = getWorkerIdAndCons id rhs
- con_list = idSetToList wrapper_cons
+ 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)
- ------------ Unfolding --------------
- unfold_pretty | show_unfold = hsep [ptext unfold_herald, pprIfaceUnfolding rhs]
- | otherwise = empty
+ifaceTyCls (ATyCon tycon)
+ | isSynTyCon tycon
+ = TySynonym (getName tycon)(toHsTyVars tyvars) (toHsType ty) noSrcLoc
+ where
+ (tyvars, ty) = getSynTyConDefn tycon
- unfold_herald = case inline_pragma of
- IMustBeINLINEd -> SLIT("_U_")
- IWantToBeINLINEd -> SLIT("_U_")
- other -> SLIT("_u_")
+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
+ 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)
- show_unfold = not implicit_unfolding && -- Not unnecessary
- unfolding_is_ok -- Not dangerous
+ | otherwise
+ = RecCon (zipWith mk_field strict_marks field_labels)
- implicit_unfolding = has_worker ||
- bottomIsGuaranteed strict_info
+ mk_bang_ty NotMarkedStrict ty = Unbanged (toHsType ty)
+ mk_bang_ty (MarkedUnboxed _ _) ty = Unpacked (toHsType ty)
+ mk_bang_ty MarkedStrict ty = Banged (toHsType ty)
- unfolding_is_ok
- = case inline_pragma of
- IMustBeINLINEd -> True
- IWantToBeINLINEd -> True
- IMustNotBeINLINEd -> False
- NoPragmaInfo -> case guidance of
- UnfoldNever -> False -- Too big
- other -> True
+ mk_field strict_mark field_label
+ = ([getName field_label], mk_bang_ty strict_mark (fieldLabelType field_label))
- guidance = calcUnfoldingGuidance opt_InterfaceUnfoldThreshold rhs
+ifaceTyCls (ATyCon tycon) = pprPanic "ifaceTyCls" (ppr tycon)
+\end{code}
- ------------ Specialisations --------------
- spec_list = specEnvToList (getIdSpecialisation id)
- spec_pretty = hsep (map pp_spec spec_list)
- pp_spec (tyvars, tys, rhs) = hsep [ptext SLIT("_P_"),
- if null tyvars then ptext SLIT("[ ]")
- else brackets (interppSP tyvars),
- -- The lexer interprets "[]" as a CONID. Sigh.
- hsep (map pprParendType tys),
- ptext SLIT("="),
- pprIfaceUnfolding 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 `unionIdSets`
- spec_ids
+%************************************************************************
+%* *
+\subsection{Instances and rules}
+%* *
+%************************************************************************
- worker_ids | has_worker = unitIdSet work_id
- | otherwise = emptyIdSet
+\begin{code}
+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.
+\end{code}
- spec_ids = foldr add emptyIdSet spec_list
- where
- add (_, _, rhs) = unionIdSets (find_fvs rhs)
+\begin{code}
+ifaceRules :: [ProtoCoreRule] -> IdSet -> [RenamedRuleDecl]
+ifaceRules rules emitted
+ = orphan_rules ++ local_rules
+ where
+ orphan_rules = [ toHsRule fn rule | ProtoCoreRule _ fn rule <- rules ]
+ local_rules = [ toHsRule fn rule
+ | fn <- varSetElems emitted,
+ rule <- rulesRules (idSpecialisation fn),
+ not (isBuiltinRule rule),
+ -- We can't print builtin rules in interface files
+ -- Since they are built in, an importing module
+ -- will have access to them anyway
+
+ -- Sept 00: I've disabled this test. It doesn't stop many, if any, rules
+ -- from coming out, and to make it work properly we need to add ????
+ -- (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}
- unfold_ids | show_unfold = find_fvs rhs
- | otherwise = emptyIdSet
- find_fvs expr = free_vars
- where
- free_vars = exprFreeVars interesting expr
- interesting id = isLocallyDefined id &&
- 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 RenamedIfaceSig, IdSet) -- Set of Ids actually spat out
-ifaceBinds hdl needed_ids final_ids binds
- = mapIO (printForIface hdl) 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
Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $
idInfo 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:"
- (sep (map ppr (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
+ -- 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, [SDoc])
+ go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag RenamedIfaceSig, 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}
-%* *
-%************************************************************************
-
\begin{code}
-ifaceTyCons hdl tycons = hPutCol hdl upp_tycon (sortLt (<) (filter (for_iface_name . getName) tycons ))
-ifaceClasses hdl classes = hPutCol hdl upp_class (sortLt (<) (filter (for_iface_name . getName) classes))
+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
+ -> (RenamedTyClDecl, IdSet) -- The emitted stuff, plus any *extra* needed Ids
+
+ifaceId get_idinfo is_rec id rhs
+ = (IfaceSig (getName id) (toHsType id_type) hs_idinfo noSrcLoc, new_needed_ids)
+ where
+ id_type = idType id
+ core_idinfo = idInfo id
+ stg_idinfo = get_idinfo id
-for_iface_name name = isLocallyDefined name &&
- not (isWiredInName name)
-
-upp_tycon tycon = ifaceTyCon tycon
-upp_class clas = ifaceClass clas
-\end{code}
+ hs_idinfo | opt_OmitInterfacePragmas = []
+ | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++
+ strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo
+ ------------ 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 -> []
-\begin{code}
-ifaceTyCon :: TyCon -> SDoc
-ifaceTyCon tycon
- | isSynTyCon tycon
- = hsep [ ptext SLIT("type"),
- ppr (getName tycon),
- pprTyVarBndrs tyvars,
- ptext SLIT("="),
- ppr ty,
- semi
- ]
- where
- (tyvars, ty) = getSynTyConDefn tycon
+ ------------ 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 (getName work_id)]
+ | otherwise = []
-ifaceTyCon tycon
- | isAlgTyCon tycon
- = hsep [ ptext keyword,
- ppr_decl_context (tyConTheta tycon),
- ppr (getName tycon),
- pprTyVarBndrs (tyConTyVars tycon),
- ptext SLIT("="),
- hsep (punctuate (ptext SLIT(" | ")) (map ppr_con (tyConDataCons tycon))),
- semi
- ]
- where
- keyword | isNewTyCon tycon = SLIT("newtype")
- | otherwise = SLIT("data")
+ ------------ Unfolding --------------
+ inline_pragma = inlinePragInfo core_idinfo
+ dont_inline = isNeverInlinePrag inline_pragma
- ppr_con data_con
- | null field_labels
- = hsep [ ppr name,
- hsep (map ppr_arg_ty (strict_marks `zip` arg_tys))
- ]
+ unfold_hsinfo | show_unfold = [HsUnfold inline_pragma (toUfExpr rhs)]
+ | otherwise = []
- | otherwise
- = hsep [ ppr name,
- braces $ hsep $ punctuate comma (map ppr_field (strict_marks `zip` field_labels))
- ]
- where
- field_labels = dataConFieldLabels data_con
- arg_tys = dataConRawArgTys data_con
- strict_marks = dataConStrictMarks data_con
- name = getName data_con
-
- ppr_arg_ty (strict_mark, ty) = ppr_strict_mark strict_mark <> pprParendType ty
-
- ppr_strict_mark NotMarkedStrict = empty
- ppr_strict_mark MarkedStrict = ptext SLIT("! ")
- -- The extra space helps the lexical analyser that lexes
- -- interface files; it doesn't make the rigid operator/identifier
- -- distinction, so "!a" is a valid identifier so far as it is concerned
-
- ppr_field (strict_mark, field_label)
- = hsep [ ppr (fieldLabelName field_label),
- ptext SLIT("::"),
- ppr_strict_mark strict_mark <> pprParendType (fieldLabelType field_label)
- ]
-
-ifaceTyCon tycon
- = pprPanic "pprIfaceTyDecl" (ppr tycon)
-
-ifaceClass clas
- = hsep [ptext SLIT("class"),
- ppr_decl_context sc_theta,
- ppr clas, -- Print the name
- pprTyVarBndrs clas_tyvars,
- pp_ops,
- semi
- ]
- where
- (clas_tyvars, sc_theta, _, sel_ids, defms) = classBigSig clas
-
- pp_ops | null sel_ids = empty
- | otherwise = hsep [ptext SLIT("where"),
- braces (hsep (punctuate semi (zipWith ppr_classop sel_ids defms)))
- ]
-
- ppr_classop sel_id maybe_defm
- = ASSERT( sel_tyvars == clas_tyvars)
- hsep [ppr (getOccName sel_id),
- if maybeToBool maybe_defm then equals else empty,
- ptext SLIT("::"),
- ppr op_ty
- ]
- where
- (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id)
+ 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
-ppr_decl_context :: ThetaType -> SDoc
-ppr_decl_context [] = empty
-ppr_decl_context theta
- = braces (hsep (punctuate comma (map (ppr_dict) theta)))
- <>
- ptext SLIT(" =>")
- where
- ppr_dict (clas,tys) = ppr clas <+> hsep (map pprParendType tys)
-\end{code}
+ rhs_is_small = couldBeSmallEnoughToInline opt_UF_HiFileThreshold rhs
-%************************************************************************
-%* *
-\subsection{Random small things}
-%* *
-%************************************************************************
+ ------------ Specialisations --------------
+ spec_info = specInfo core_idinfo
+
+ ------------ Occ info --------------
+ loop_breaker = isLoopBreaker (occInfo core_idinfo)
-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
+ ------------ Extra free Ids --------------
+ new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet
+ | otherwise = worker_ids `unionVarSet`
+ unfold_ids `unionVarSet`
+ spec_ids
-\begin{code}
-upp_avail NotAvailable = empty
-upp_avail (Avail name) = upp_occname (getOccName name)
-upp_avail (AvailTC name []) = empty
-upp_avail (AvailTC name ns) = hcat [upp_occname (getOccName name), bang, upp_export ns']
- where
- bang | name `elem` ns = empty
- | otherwise = char '|'
- ns' = filter (/= name) ns
+ worker_ids | has_worker && interestingId work_id = unitVarSet work_id
+ -- Conceivably, the worker might come from
+ -- another module
+ | otherwise = emptyVarSet
-upp_export [] = empty
-upp_export names = parens (hsep (map (upp_occname . getOccName) names))
+ spec_ids = filterVarSet interestingId (rulesRhsFreeVars spec_info)
-upp_fixity (occ, fixity) = hcat [ppr fixity, space, upp_occname occ, semi]
+ unfold_ids | show_unfold = find_fvs rhs
+ | otherwise = emptyVarSet
-ppr_unqual_name :: NamedThing a => a -> SDoc -- Just its occurrence name
-ppr_unqual_name name = upp_occname (getOccName name)
+ find_fvs expr = exprSomeFreeVars interestingId expr
-upp_occname :: OccName -> SDoc
-upp_occname occ = ptext (occNameString occ)
+interestingId id = isId id && isLocallyDefined id && not (hasNoBinding id)
\end{code}
%************************************************************************
%* *
-\subsection{Comparisons
+\subsection{Checking if the new interface is up to date
%* *
%************************************************************************
-
-
-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
+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 $$ pp_sig_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 = sig_vers `plusNameEnv` tc_vers }
-lt_name :: Name -> Name -> Bool
-n1 `lt_name` n2 = modAndOcc n1 < modAndOcc n2
+ no_output_change = no_tc_change && no_rule_change && no_export_change
+ no_usage_change = mi_usages old_iface == mi_usages new_iface
-lt_lexical :: NamedThing a => a -> a -> Bool
-lt_lexical a1 a2 = getName a1 `lt_name` getName a2
+ 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
-lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool
-lt_imp_vers (m1,_,_,_) (m2,_,_,_) = m1 < m2
+ -- 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 (dcl_tycl old_decls) (dcl_tycl new_decls)
-sort_versions vs = sortLt lt_vers vs
-lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool
-lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2
-\end{code}
+diffDecls :: NameEnv Version -- Old version map
+ -> [RenamedTyClDecl] -> [RenamedTyClDecl] -- Old and new decls
+ -> (Bool, -- True <=> no change
+ SDoc, -- Record of differences
+ NameEnv Version) -- New version
-\begin{code}
-hPutCol :: Handle
- -> (a -> SDoc)
- -> [a]
- -> IO ()
-hPutCol hdl fmt xs = mapIO (printForIface hdl . fmt) xs
-
-mapIO :: (a -> IO b) -> [a] -> IO ()
-mapIO f [] = return ()
-mapIO f (x:xs) = f x >> mapIO f xs
+diffDecls old_vers 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` nd -> diff ok_so_far pp new_vers ods nds
+ | otherwise -> diff False (pp $$ changed od nd) new_vers' ods nds
+ where
+ od_name = get_name od
+ nd_name = get_name 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}