%
-% (c) The GRASP/AQUA Project, Glasgow University, 1993-1995
+% (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
%
\section[MkIface]{Print an interface for a module}
\begin{code}
-#include "HsVersions.h"
+module MkIface ( completeIface ) where
-module MkIface (
- mkInterface,
+#include "HsVersions.h"
- -- and to make the interface self-sufficient...
- Bag, CE(..), GlobalSwitch, FixityDecl, Id,
- Name, PrettyRep, StgBinding, TCE(..), UniqFM, InstInfo
- ) where
+import HsSyn
+import HsCore ( HsIdInfo(..), toUfExpr, ifaceSigName )
+import HsTypes ( toHsTyVars )
+import BasicTypes ( Fixity(..), NewOrData(..),
+ Version, bumpVersion, isLoopBreaker
+ )
+import RnMonad
+import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl, RenamedRuleDecl, RenamedIfaceSig )
+import HscTypes ( VersionInfo(..), IfaceDecls(..), ModIface(..), ModDetails(..),
+ TyThing(..), DFunId )
+
+import CmdLineOpts
+import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, hasNoBinding,
+ idSpecialisation
+ )
+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, 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, tyConFamilySize
+ )
+import Class ( classExtraBigSig, DefMeth(..) )
+import FieldLabel ( fieldLabelType )
+import Type ( splitSigmaTy, tidyTopType, deNoteType )
-IMPORT_Trace -- ToDo: rm (debugging)
+import Rules ( ProtoCoreRule(..) )
-import AbsPrel ( mkLiftTy, pRELUDE_CORE, pRELUDE_BUILTIN )
-import AbsSyn ( FixityDecl(..), RenamedFixityDecl(..), MonoBinds,
- RenamedMonoBinds(..), Name, RenamedPat(..), Sig
- )
-import AbsUniType
+import Bag ( bagToList )
+import UniqFM ( lookupUFM, listToUFM )
+import SrcLoc ( noSrcLoc )
import Bag
-import CE
-import CmdLineOpts -- ( GlobalSwitch(..) )
-import FiniteMap
-import Id
-import IdInfo -- plenty from here
-import Maybes ( catMaybes, Maybe(..) )
import Outputable
-import Pretty
-import StgSyn
-import TCE
-import TcInstDcls ( InstInfo(..) )
-import Util
+
+import List ( partition )
\end{code}
+
%************************************************************************
-%* *
-\subsection[main-MkIface]{Main routine for making interfaces}
-%* *
+%* *
+\subsection{Write a new interface file}
+%* *
%************************************************************************
-Misc points:
-\begin{enumerate}
-\item
-We get the general what-to-export information from the ``environments''
-produced by the typechecker (the \tr{[RenamedFixityDecl]} through
-\tr{Bag InstInfo} arguments).
-
-\item
-{\em However:} Whereas (for example) an \tr{InstInfo} will have
-\tr{Ids} in it that identify the constant methods for that instance,
-those particular \tr{Ids} {\em do not have} the best @IdInfos@!!!
-Those @IdInfos@ were figured out long after the \tr{InstInfo} was
-created.
-
-That's why we actually look at the final \tr{PlainStgBindings} that go
-into the code-generator: they have the best @IdInfos@ on them.
-Whenever, we are about to print info about an @Id@, we look in the
-Ids-from-STG-bindings list to see if we have an ``equivalent'' @Id@
-with presumably-better @IdInfo@.
-
-\item
-We play this same game whether for values, classes (for their
-method-selectors and default-methods), or instances (for their
-@DictFunIds@ or constant-methods).
-
-Of course, for imported things, what we got from the typechecker is
-all we're gonna get.
-
-\item
-We {\em sort} things in the interface into some ``canonical'' order;
-otherwise, with heavily-recursive modules, you can have (unchanged)
-information ``move around'' in the interface file---deeply unfriendly
-to \tr{make}.
-\end{enumerate}
-
\begin{code}
-mkInterface :: (GlobalSwitch -> Bool)
- -> FAST_STRING
- -> (FAST_STRING -> Bool, -- is something in export list, explicitly?
- FAST_STRING -> Bool) -- is a module among the "dotdot" exported modules?
- -> IdEnv UnfoldingDetails
- -> FiniteMap TyCon [(Bool, [Maybe UniType])]
- -> ([RenamedFixityDecl], -- interface info from the typecheck
- [Id],
- CE,
- TCE,
- Bag InstInfo)
- -> [PlainStgBinding]
- -> Pretty
-
-mkInterface sw_chkr modname export_list_fns inline_env tycon_specs
- (fixity_decls, global_ids, ce, tce, inst_infos)
- stg_binds
+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
- -- first, gather up the things we want to export:
-
- exported_tycons = [ tc | tc <- rngTCE tce,
- isExported tc,
- is_exportable_tycon_or_class sw_chkr export_list_fns tc ]
- exported_classes = [ c | c <- rngCE ce,
- isExported c,
- is_exportable_tycon_or_class sw_chkr export_list_fns c ]
- exported_inst_infos = [ i | i <- bagToList inst_infos,
- is_exported_inst_info sw_chkr export_list_fns i ]
- exported_vals
- = [ v | v <- global_ids,
- isExported v && not (isDataCon v) && not (isClassOpId v) ]
-
- -- We also have to worry about TyCons/Classes that are
- -- *mentioned* in exported things (e.g., values' types or
- -- instances), so that we can be sure to do an import decl for
- -- them, for original-naming purposes:
-
- (mentioned_tycons, mentioned_classes)
- = foldr ( \ (tcs1, cls1) (tcs2, cls2)
- -> (tcs1 `unionBags` tcs2, cls1 `unionBags` cls2) )
- (emptyBag, emptyBag)
- (map getMentionedTyConsAndClassesFromClass exported_classes ++
- map getMentionedTyConsAndClassesFromTyCon exported_tycons ++
- map getMentionedTyConsAndClassesFromId exported_vals ++
- map getMentionedTyConsAndClassesFromInstInfo exported_inst_infos)
-
- mentionable_classes
- = filter (is_mentionable sw_chkr) (bagToList mentioned_classes)
- mentionable_tycons
- = [ tc | tc <- bagToList mentioned_tycons,
- is_mentionable sw_chkr tc,
- not (isPrimTyCon tc) ]
-
- nondup_mentioned_tycons = fst (removeDups cmpTyCon mentionable_tycons)
- nondup_mentioned_classes = fst (removeDups cmpClass mentionable_classes)
-
- -- Next: as discussed in the notes, we want the top-level
- -- Ids straight from the final STG code, so we can use
- -- their IdInfos to print pragmas; we slurp them out here,
- -- then pass them to the printing functions, which may
- -- use them.
-
- better_ids = collectExportedStgBinders stg_binds
-
- -- Make a lookup function for convenient access:
-
- better_id_fn i
- = if not (isLocallyDefined i)
- then i -- can't be among our "better_ids"
- else
- let
- eq_fn = if isTopLevId i -- can't trust uniqs
- then (\ x y -> getOrigName x == getOrigName y)
- else eqId
- in
- case [ x | x <- better_ids, x `eq_fn` i ] of
- [] -> pprPanic "better_id_fn:" (ppr PprShowAll i)
- i
- [x] -> x
- _ -> panic "better_id_fn"
-
- -- Finally, we sort everything lexically, so that we always
- -- get the same interface from the same information:
-
- sorted_mentioned_tycons = sortLt ltLexical nondup_mentioned_tycons
- sorted_mentioned_classes = sortLt ltLexical nondup_mentioned_classes
-
- sorted_tycons = sortLt ltLexical exported_tycons
- sorted_classes = sortLt ltLexical exported_classes
- sorted_vals = sortLt ltLexical exported_vals
- sorted_inst_infos = sortLt lt_lexical_inst_info exported_inst_infos
+ new_decls = declsFromDetails mod_details tidy_binds final_ids tidy_orphan_rules
in
- if (any_purely_local sorted_tycons sorted_classes sorted_vals) then
- -- this will be less of a HACK when we teach
- -- mkInterface to do I/O (WDP 94/10)
- error "Can't produce interface file because of errors!\n"
- else
--- trace ("mkIface:Ids:"++(ppShow 80 (ppr PprDebug global_ids))) (
- ppAboves
- [ppPStr SLIT("{-# GHC_PRAGMA INTERFACE VERSION 6 #-}"),
- ppCat [ppPStr SLIT("interface"), ppPStr modname, ppPStr SLIT("where")],
-
- do_import_decls sw_chkr modname
- sorted_vals sorted_mentioned_classes sorted_mentioned_tycons,
- -- Mustn't give the data constructors to do_import_decls,
- -- because they aren't explicitly imported; their tycon is.
- -- ToDo: modify if we ever add renaming properly.
-
- ppAboves (map (do_fixity sw_chkr) fixity_decls),
- ppAboves (map (pprIfaceClass sw_chkr better_id_fn inline_env) sorted_classes),
- ppAboves (map (do_tycon sw_chkr tycon_specs) sorted_tycons),
- ppAboves (map (do_value sw_chkr better_id_fn inline_env) sorted_vals),
- ppAboves (map (do_instance sw_chkr better_id_fn inline_env) sorted_inst_infos),
-
- ppChar '\n'
- ]
--- )
- where
- any_purely_local tycons classes vals
- = any bad_tc tycons || any bad_cl classes || any bad_id vals
- where
- bad_cl cl
- = case (maybePurelyLocalClass cl) of
- Nothing -> False
- Just xs -> naughty_trace cl xs
-
- bad_id id
- = case (maybePurelyLocalType (getIdUniType id)) of
- Nothing -> False
- Just xs -> naughty_trace id xs
-
- bad_tc tc
- = case (maybePurelyLocalTyCon tc) of
- Nothing -> False
- Just xs -> if exported_abs then False else naughty_trace tc xs
- where
- exported_abs = case (getExportFlag tc) of { ExportAbs -> True; _ -> False }
-
- naughty_trace x things
- = pprTrace "Can't export -- `"
- (ppBesides [ppr PprForUser x, ppStr "' mentions purely local things: ",
- ppInterleave pp'SP things])
- True
+ 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
+
+ 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[imports-MkIface]{Generating `import' declarations in an interface}
-%* *
+%* *
+\subsection{Types and classes}
+%* *
%************************************************************************
-Not handling renaming yet (ToDo)
-
-We gather up lots of (module, name) pairs for which we might print an
-import declaration. We sort them, for the usual canonicalisation
-reasons. NB: We {\em assume} the lists passed in don't have duplicates in
-them! expect).
-
-All rather horribly turgid (WDP).
-
\begin{code}
-do_import_decls
- :: (GlobalSwitch -> Bool)
- -> FAST_STRING
- -> [Id] -> [Class] -> [TyCon]
- -> Pretty
-
-do_import_decls sw_chkr mod_name vals classes tycons
- = let
- -- Conjure up (module, name, maybe_renaming) triples for all
- -- the potentially import-decls things:
-
- vals_names, classes_names, tycons_names :: [(FAST_STRING, FAST_STRING, [Maybe FAST_STRING])]
- vals_names = map get_val_triple vals
- classes_names = map get_class_triple classes
- tycons_names = map get_tycon_triple tycons
-
- -- sort the (module, name, renaming) triples and chop
- -- them into per-module groups:
-
- ie_list = sortLt lt (tycons_names ++ classes_names ++ vals_names)
-
- per_module_groups = runs same_module ie_list
- in
- ppAboves (map print_a_decl per_module_groups)
+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
- lt, same_module :: (FAST_STRING, FAST_STRING, [Maybe FAST_STRING])
- -> (FAST_STRING, FAST_STRING, [Maybe FAST_STRING]) -> Bool
-
- lt (m1, ie1, _) (m2, ie2, _)
- = case _CMP_STRING_ m1 m2 of { LT_ -> True; EQ_ -> ie1 < ie2; GT__ -> False }
-
- same_module (m1, _, _) (m2, _, _) = m1 == m2
-
- compiling_the_prelude = sw_chkr CompilingPrelude
-
- print_a_decl :: [(FAST_STRING, FAST_STRING, [Maybe FAST_STRING])] -> Pretty
- {-
- Obviously, if the module in question is this one,
- don't print an import declaration.
-
- If it's a Prelude* module, we don't print the TyCons/
- Classes, because the compiler supposedly knows about
- them already (and they are PreludeCore things anyway).
-
- But if we are compiling a Prelude module, then we
- try to do it as "normally" as possible.
- -}
- print_a_decl (ielist@((m,_,_) : _))
- | m == mod_name
- || (not compiling_the_prelude &&
- (m == pRELUDE_CORE || m == pRELUDE_BUILTIN))
- = ppNil
-
- | otherwise
- = ppBesides [ppPStr SLIT("import "), ppPStr m, ppLparen,
- ppIntersperse pp'SP{-'-} (map pp_str [n | (_,n,_) <- ielist]),
- ppRparen,
- case (grab_non_Nothings [rns | (_,_,rns) <- ielist]) of
- [] -> ppNil
- renamings -> pp_renamings renamings
- ]
- where
- isnt_tycon_ish :: FAST_STRING -> Bool
- isnt_tycon_ish str = not (isConop str)
-
- grab_non_Nothings :: [[Maybe FAST_STRING]] -> [FAST_STRING]
-
- grab_non_Nothings rns = catMaybes (concat rns)
-
- pp_str :: FAST_STRING -> Pretty
- pp_str pstr
- = if isAvarop pstr then ppStr ("("++str++")") else ppPStr pstr
- where
- str = _UNPK_ pstr
-
- pp_renamings strs
- = ppBesides [ ppPStr SLIT(" renaming "), ppLparen, ppIntersperse pp'SP{-'-} (map ppPStr strs), ppRparen ]
+ (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)
+ | 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
+ 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)
+
+ 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 (ATyCon tycon) = pprPanic "ifaceTyCls" (ppr tycon)
\end{code}
-Most of the huff and puff here is to ferret out renaming strings.
-
-\begin{code}
-get_val_triple :: Id -> (FAST_STRING, FAST_STRING, [Maybe FAST_STRING])
-get_class_triple :: Class -> (FAST_STRING, FAST_STRING, [Maybe FAST_STRING])
-get_tycon_triple :: TyCon -> (FAST_STRING, FAST_STRING, [Maybe FAST_STRING])
-
-get_val_triple id
- = case (generic_triple id) of { (a,b,rn) ->
- (a,b,[rn]) }
-
-get_class_triple clas
- = case (generic_triple clas) of { (orig_mod, orig_nm, clas_rn) ->
- let
- nm_to_print = case (getExportFlag clas) of
- ExportAll -> orig_nm _APPEND_ SLIT("(..)") -- nothing like a good HACK!
- ExportAbs -> orig_nm
- NotExported -> orig_nm
-
--- Ops don't have renaming info (bug) ToDo
--- ops = getClassOps clas
--- ops_rns = [ rn | (_,_,rn) <- map generic_triple ops ]
- in
- (orig_mod, nm_to_print, [clas_rn]) }
-
-get_tycon_triple tycon
- = case (generic_triple tycon) of { (orig_mod, orig_nm, tycon_rn) ->
- let
- nm_to_print = case (getExportFlag tycon) of
- ExportAll -> orig_nm _APPEND_ SLIT("(..)") -- nothing like a good HACK!
- ExportAbs -> orig_nm
- NotExported -> orig_nm
-
- cons = getTyConDataCons tycon
- cons_rns = [ rn | (_,_,rn) <- map generic_triple cons ]
- in
- (orig_mod, nm_to_print, tycon_rn : cons_rns) }
-
-generic_triple thing
- = case (getOrigName thing) of { (orig_mod, orig_nm) ->
- case (getOccurrenceName thing) of { occur_name ->
- (orig_mod, orig_nm,
- if orig_nm == occur_name
- then Nothing
- else Just (orig_nm _APPEND_ SLIT(" to ") _APPEND_ occur_name)
- )}}
-\end{code}
%************************************************************************
-%* *
-\subsection[fixities-MkIface]{Generating fixity declarations in an interface}
-%* *
+%* *
+\subsection{Instances and rules}
+%* *
%************************************************************************
+\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}
\begin{code}
-do_fixity :: (GlobalSwitch -> Bool) -> RenamedFixityDecl -> Pretty
-
-do_fixity sw_chkr fixity_decl
- = case (getExportFlag (get_name fixity_decl)) of
- ExportAll -> ppr (PprInterface sw_chkr) fixity_decl
- _ -> ppNil
+ifaceRules :: [ProtoCoreRule] -> IdSet -> [RenamedRuleDecl]
+ifaceRules rules emitted
+ = orphan_rules ++ local_rules
where
- get_name (InfixL n _) = n
- get_name (InfixR n _) = n
- get_name (InfixN n _) = n
+ 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}
+
%************************************************************************
-%* *
-\subsection[tycons-MkIface]{Generating tycon declarations in an interface}
-%* *
+%* *
+\subsection{Value bindings}
+%* *
%************************************************************************
\begin{code}
-do_tycon :: (GlobalSwitch -> Bool) -> FiniteMap TyCon [(Bool, [Maybe UniType])] -> TyCon -> Pretty
-
-do_tycon sw_chkr tycon_specs_map tycon
- = pprTyCon (PprInterface sw_chkr) tycon tycon_specs
+ifaceBinds :: IdSet -- These Ids are needed already
+ -> [Id] -- Ids used at code-gen time; they have better pragma info!
+ -> [CoreBind] -- In dependency order, later depend on earlier
+ -> (Bag RenamedIfaceSig, IdSet) -- Set of Ids actually spat out
+
+ifaceBinds needed_ids final_ids binds
+ = go needed_ids (reverse binds) emptyBag emptyVarSet
+ -- Reverse so that later things will
+ -- provoke earlier ones to be emitted
where
- tycon_specs = map snd (lookupWithDefaultFM tycon_specs_map [] tycon)
+ final_id_map = listToUFM [(id,id) | id <- final_ids]
+ get_idinfo id = case lookupUFM final_id_map id of
+ Just id' -> idInfo id'
+ Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $
+ idInfo id
+
+ -- 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. 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
+ (new_decls, new_emitted, extras) = go_rec needed pairs
+ decls' = new_decls `unionBags` decls
+ needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs)
+ emitted' = emitted `unionVarSet` new_emitted
+
+ go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag RenamedIfaceSig, IdSet, IdSet)
+ go_rec needed pairs
+ | null decls = (emptyBag, emptyVarSet, emptyVarSet)
+ | otherwise = (more_decls `unionBags` listToBag decls,
+ more_emitted `unionVarSet` mkVarSet (map fst needed_prs),
+ more_extras `unionVarSet` extras)
+ where
+ (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[values-MkIface]{Generating a value's signature in an interface}
-%* *
-%************************************************************************
\begin{code}
-do_value :: (GlobalSwitch -> Bool)
- -> (Id -> Id)
- -> IdEnv UnfoldingDetails
- -> Id
- -> Pretty
-
-do_value sw_chkr better_id_fn inline_env val
- = let
- sty = PprInterface sw_chkr
- better_val = better_id_fn val
- name_str = getOccurrenceName better_val -- NB: not orig name!
-
- id_info = getIdInfo better_val
-
- val_ty = let
- orig_ty = getIdUniType val
- final_ty = getIdUniType better_val
- in
--- ASSERT (orig_ty == final_ty || mkLiftTy orig_ty == final_ty)
- ASSERT (if (orig_ty == final_ty || mkLiftTy orig_ty == final_ty) then True else pprTrace "do_value:" (ppCat [ppr PprDebug val, ppr PprDebug better_val]) False)
- orig_ty
-
- -- Note: We export the type of the original val
- -- The type of an unboxed val will have been *lifted* by the desugarer
- -- In this case we export an unlifted type, but id_info which assumes
- -- a lifted Id i.e. extracted from better_val (above)
- -- The importing module must lift the Id before using the imported id_info
-
- pp_id_info
- = if sw_chkr OmitInterfacePragmas
- || boringIdInfo id_info
- then ppNil
- else ppCat [ppPStr SLIT("\t{-# GHC_PRAGMA"),
- ppIdInfo sty better_val True{-yes specs-}
- better_id_fn inline_env id_info,
- ppPStr SLIT("#-}")]
- in
- ppAbove (ppCat [ppr_non_op name_str,
- ppPStr SLIT("::"), pprUniType sty val_ty])
- pp_id_info
-
--- sadly duplicates Outputable.pprNonOp (ToDo)
-
-ppr_non_op str
- = if isAvarop str -- NOT NEEDED: || isAconop
- then ppBesides [ppLparen, ppPStr str, ppRparen]
- else ppPStr str
+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
+
+ 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 -> []
+
+ ------------ 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 = []
+
+ ------------ Unfolding --------------
+ inline_pragma = inlinePragInfo core_idinfo
+ dont_inline = isNeverInlinePrag inline_pragma
+
+ unfold_hsinfo | show_unfold = [HsUnfold inline_pragma (toUfExpr rhs)]
+ | otherwise = []
+
+ 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
+
+ rhs_is_small = couldBeSmallEnoughToInline opt_UF_HiFileThreshold rhs
+
+ ------------ Specialisations --------------
+ spec_info = specInfo core_idinfo
+
+ ------------ Occ info --------------
+ loop_breaker = isLoopBreaker (occInfo core_idinfo)
+
+ ------------ Extra free Ids --------------
+ new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet
+ | otherwise = worker_ids `unionVarSet`
+ unfold_ids `unionVarSet`
+ spec_ids
+
+ worker_ids | has_worker && interestingId work_id = unitVarSet work_id
+ -- Conceivably, the worker might come from
+ -- another module
+ | otherwise = emptyVarSet
+
+ spec_ids = filterVarSet interestingId (rulesRhsFreeVars spec_info)
+
+ 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}
+
%************************************************************************
-%* *
-\subsection[instances-MkIface]{Generating instance declarations in an interface}
-%* *
+%* *
+\subsection{Checking if the new interface is up to date
+%* *
%************************************************************************
-The types of ``dictionary functions'' (dfuns) have just the required
-info for instance declarations in interfaces. However, the dfuns that
-GHC really uses have {\em extra} dictionaries passed to them (for
-efficiency). When we print interfaces, we want to omit that
-dictionary information. (It can be reconsituted on the other end,
-from instance and class decls).
-
\begin{code}
-do_instance :: (GlobalSwitch -> Bool)
- -> (Id -> Id)
- -> IdEnv UnfoldingDetails
- -> InstInfo
- -> Pretty
-
-do_instance sw_chkr better_id_fn inline_env
- (InstInfo clas tv_tmpls ty inst_decl_theta dfun_theta dfun_id constm_ids _ from_here modname _ _)
- = let
- sty = PprInterface sw_chkr
-
- better_dfun = better_id_fn dfun_id
- better_dfun_info = getIdInfo better_dfun
- better_constms = map better_id_fn constm_ids
-
- class_op_strs = map getClassOpString (getClassOps clas)
-
- pragma_begin
- = ppCat [ppPStr SLIT("\t{-# GHC_PRAGMA"), pp_modname, ppPStr SLIT("{-dfun-}"),
- ppIdInfo sty better_dfun False{-NO specs-}
- better_id_fn inline_env better_dfun_info]
-
- pragma_end = ppPStr SLIT("#-}")
-
- pp_modname = if _NULL_ modname
- then ppNil
- else ppCat [ppStr "_M_", ppPStr modname]
-
- name_pragma_pairs
- = pp_the_list [ ppCat [ppChar '\t', ppr_non_op op, ppEquals,
- ppChar '{' ,
- ppIdInfo sty constm True{-YES, specs-}
- better_id_fn inline_env
- (getIdInfo constm),
- ppChar '}' ]
- | (op, constm) <- class_op_strs `zip` better_constms ]
-
-#ifdef DEBUG
- pp_the_list [] = panic "MkIface: no class_ops or better_constms?"
-#endif
- pp_the_list [p] = p
- pp_the_list (p:ps) = ppAbove (ppBeside p ppComma) (pp_the_list ps)
-
- real_stuff
- = ppCat [ppPStr SLIT("instance"),
- ppr sty (mkSigmaTy tv_tmpls inst_decl_theta (mkDictTy clas ty))]
- in
- if sw_chkr OmitInterfacePragmas
- || boringIdInfo better_dfun_info
- then real_stuff
- else ppAbove real_stuff
- ({-ppNest 8 -} -- ppNest does nothing
- if null better_constms
- then ppCat [pragma_begin, pragma_end]
- else ppAbove pragma_begin (ppCat [name_pragma_pairs, pragma_end])
- )
-\end{code}
+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 }
-%************************************************************************
-%* *
-\subsection[utils-InstInfos]{Utility functions for @InstInfos@}
-%* *
-%************************************************************************
+ no_output_change = no_tc_change && no_rule_change && no_export_change
+ no_usage_change = mi_usages old_iface == mi_usages new_iface
-ToDo: perhaps move.
+ 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
-Classes/TyCons are ``known,'' more-or-less. Prelude TyCons are
-``completely'' known---they don't need to be mentioned in interfaces.
-Classes usually don't need to be mentioned in interfaces, but if we're
-compiling the prelude, then we treat them without special favours.
-\begin{code}
-is_exportable_tycon_or_class sw_chkr export_list_fns tc
- = if not (fromPreludeCore tc) then
- True
- else
- in_export_list_or_among_dotdot_modules
- (sw_chkr CompilingPrelude) -- ignore M.. stuff if compiling prelude
- export_list_fns tc
-
-in_export_list_or_among_dotdot_modules ignore_Mdotdots (in_export_list, among_dotdot_modules) tc
- = if in_export_list (getOccurrenceName tc) then
- True
- else
--- pprTrace "in_export:" (ppAbove (ppr PprDebug ignore_Mdotdots) (ppPStr (getOccurrenceName tc))) (
- if ignore_Mdotdots then
- False
- else
- any among_dotdot_modules (getInformingModules tc)
--- )
-
-is_mentionable sw_chkr tc
- = not (from_PreludeCore_or_Builtin tc) || (sw_chkr CompilingPrelude)
- where
- from_PreludeCore_or_Builtin thing
- = let
- mod_name = fst (getOrigName thing)
- in
- mod_name == pRELUDE_CORE || mod_name == pRELUDE_BUILTIN
-
-is_exported_inst_info sw_chkr export_list_fns
- (InstInfo clas _ ty _ _ _ _ _ from_here _ _ _)
- = let
- is_fun_tycon = isFunType ty
+ -- 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)
- seems_exported = instanceIsExported clas ty from_here
- (tycon, _, _) = getUniDataTyCon ty
- in
- if (sw_chkr OmitReexportedInstances && not from_here) then
- False -- Flag says to violate Haskell rules, blatantly
-
- else if not (sw_chkr CompilingPrelude)
- || not (is_fun_tycon || fromPreludeCore tycon)
- || not (fromPreludeCore clas) then
- seems_exported -- take what we got
-
- else -- compiling Prelude & tycon/class are Prelude things...
- from_here
- || in_export_list_or_among_dotdot_modules True{-ignore M..s-} export_list_fns clas
- || (not is_fun_tycon
- && in_export_list_or_among_dotdot_modules True{-ignore M..s-} export_list_fns tycon)
-\end{code}
-\begin{code}
-lt_lexical_inst_info (InstInfo _ _ _ _ _ dfun1 _ _ _ _ _ _) (InstInfo _ _ _ _ _ dfun2 _ _ _ _ _ _)
- = ltLexical dfun1 dfun2
-\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}
-getMentionedTyConsAndClassesFromInstInfo (InstInfo clas _ ty _ dfun_theta _ _ _ _ _ _ _)
- = case (getMentionedTyConsAndClassesFromUniType ty) of { (ts, cs) ->
- case [ c | (c, _) <- dfun_theta ] of { theta_classes ->
- (ts, (cs `unionBags` listToBag theta_classes) `snocBag` clas)
- }}
+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}
projects / ghc-hetmet.git / blobdiff