Moduleghc-10.0.0.20260917GHC2024

GHC.Unit.Module.ModIface

17 types
85 values

Packageghc-10.0.0.20260917
Exports105
LanguageGHC2024
LicenceBSD-3-Clause
SourceModIface.hs

typetype ModIface = ModIface_ 'ModIfaceFinal

datadata ModIface_ (phase :: ModIfacePhase)

A ModIface summarises everything we know about a compiled module.

See Note [Structure of ModIface] for information about what belongs in each field.

See Note [Strictness in ModIface] to learn about why all the fields are lazy.

See Note [Private fields in ModIface] to learn why we don't export any of the fields.

Instances2Binary, NFData

Binary ModIfaceDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface
(NFData (IfaceAbiHashesExts phase), NFData (IfaceDeclExts phase)) => NFData (ModIface_ phase)Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface

valuemi_mod_info :: ModIface_ phase -> IfaceModInfo

valuemi_module :: ModIface_ phase -> Module

valuemi_sig_of :: ModIface_ phase -> Maybe Module

valuemi_hsc_src :: ModIface_ phase -> HscSource

valuemi_iface_hash :: ModIface_ phase -> Fingerprint

valuemi_deps :: ModIface_ phase -> Dependencies

valuemi_public :: ModIface_ phase -> IfacePublic_ phase

valuemi_exports :: ModIface_ phase -> [IfaceExport]

valuemi_fixities :: ModIface_ phase -> [(OccName, Fixity)]

valuemi_warns :: ModIface_ phase -> IfaceWarnings

valuemi_anns :: ModIface_ phase -> [IfaceAnnotation]

valuemi_decls :: ModIface_ phase -> [IfaceDeclExts phase]

valuemi_defaults :: ModIface_ phase -> [IfaceDefault]

valuemi_simplified_core :: ModIface_ phase -> Maybe IfaceSimplifiedCore

valuemi_top_env :: ModIface_ phase -> IfaceTopEnv

valuemi_insts :: ModIface_ phase -> [IfaceClsInst]

valuemi_fam_insts :: ModIface_ phase -> [IfaceFamInst]

valuemi_rules :: ModIface_ phase -> [IfaceRule]

valuemi_trust :: ModIface_ phase -> IfaceTrustInfo

valuemi_trust_pkg :: ModIface_ phase -> Bool

valuemi_complete_matches :: ModIface_ phase -> [IfaceCompleteMatch]

valuemi_docs :: ModIface_ phase -> Maybe Docs

valuemi_abi_hashes :: ModIface_ phase -> IfaceAbiHashesExts phase

valuemi_ext_fields :: ModIface_ phase -> ExtensibleFields

valuemi_hi_bytes :: ModIface_ phase -> IfaceBinHandle phase

valuemi_self_recomp_info :: ModIface_ phase -> Maybe IfaceSelfRecomp

valuemi_fix_fn :: ModIface_ phase -> OccName -> Maybe Fixity

valuemi_decl_warn_fn :: ModIface_ phase -> OccName -> Maybe (WarningTxt GhcRn)

valuemi_export_warn_fn :: ModIface_ phase -> Name -> Maybe (WarningTxt GhcRn)

valuemi_hash_fn :: ModIface_ phase -> OccName -> Maybe (OccName, Fingerprint)

pattern

pattern ModIface :: IfaceModInfo -> Module -> Maybe Module -> HscSource -> Fingerprint -> Dependencies -> IfacePublic_ phase -> [IfaceExport] -> [(OccName, Fixity)] -> IfaceWarnings -> [IfaceAnnotation] -> [IfaceDeclExts phase] -> Maybe IfaceSimplifiedCore -> [IfaceDefault] -> IfaceTopEnv -> [IfaceClsInst] -> [IfaceFamInst] -> [IfaceRule] -> IfaceTrustInfo -> Bool -> [IfaceCompleteMatch] -> Maybe Docs -> IfaceAbiHashesExts phase -> ExtensibleFields -> IfaceBinHandle phase -> Maybe IfaceSelfRecomp -> (OccName -> Maybe Fixity) -> (OccName -> Maybe (OccName, Fingerprint)) -> (OccName -> Maybe (WarningTxt GhcRn)) -> (Name -> Maybe (WarningTxt GhcRn)) -> ModIface_ phase

valueset_mi_mod_info :: IfaceModInfo -> ModIface_ phase -> ModIface_ phase

valueset_mi_module :: Module -> ModIface_ phase -> ModIface_ phase

valueset_mi_sig_of :: Maybe Module -> ModIface_ phase -> ModIface_ phase

valueset_mi_hsc_src :: HscSource -> ModIface_ phase -> ModIface_ phase

valueset_mi_self_recomp

:: Maybe IfaceSelfRecomp
-> ModIface_ phase
-> ModIface_ phase

valueset_mi_hi_bytes

:: IfaceBinHandle phase
-> ModIface_ phase
-> ModIface_ phase

valueset_mi_deps :: Dependencies -> ModIface_ phase -> ModIface_ phase

valueset_mi_exports :: [IfaceExport] -> ModIface_ phase -> ModIface_ phase

valueset_mi_fixities :: [(OccName, Fixity)] -> ModIface_ phase -> ModIface_ phase

valueset_mi_warns :: IfaceWarnings -> ModIface_ phase -> ModIface_ phase

valueset_mi_anns :: [IfaceAnnotation] -> ModIface_ phase -> ModIface_ phase

valueset_mi_insts :: [IfaceClsInst] -> ModIface_ phase -> ModIface_ phase

valueset_mi_fam_insts :: [IfaceFamInst] -> ModIface_ phase -> ModIface_ phase

valueset_mi_rules :: [IfaceRule] -> ModIface_ phase -> ModIface_ phase

valueset_mi_decls :: [IfaceDeclExts phase] -> ModIface_ phase -> ModIface_ phase

valueset_mi_defaults :: [IfaceDefault] -> ModIface_ phase -> ModIface_ phase

valueset_mi_simplified_core

:: Maybe IfaceSimplifiedCore
-> ModIface_ phase
-> ModIface_ phase

valueset_mi_top_env :: IfaceTopEnv -> ModIface_ phase -> ModIface_ phase

valueset_mi_trust :: IfaceTrustInfo -> ModIface_ phase -> ModIface_ phase

valueset_mi_trust_pkg :: Bool -> ModIface_ phase -> ModIface_ phase

valueset_mi_complete_matches

:: [IfaceCompleteMatch]
-> ModIface_ phase
-> ModIface_ phase

valueset_mi_docs :: Maybe Docs -> ModIface_ phase -> ModIface_ phase

valueset_mi_abi_hashes

:: IfaceAbiHashesExts phase
-> ModIface_ phase
-> ModIface_ phase

valueset_mi_ext_fields :: ExtensibleFields -> ModIface_ phase -> ModIface_ phase

valueset_mi_caches :: IfaceCache -> ModIface_ phase -> ModIface_ phase

valueset_mi_decl_warn_fn

:: OccName -> Maybe (WarningTxt GhcRn)
-> ModIface_ phase
-> ModIface_ phase

valueset_mi_export_warn_fn

:: Name -> Maybe (WarningTxt GhcRn)
-> ModIface_ phase
-> ModIface_ phase

valueset_mi_fix_fn

:: OccName -> Maybe Fixity
-> ModIface_ phase
-> ModIface_ phase

valueset_mi_hash_fn

:: OccName -> Maybe (OccName, Fingerprint)
-> ModIface_ phase
-> ModIface_ phase

valuecompletePartialModIface

:: PartialModIface
-> Fingerprint
-> [(Fingerprint, IfaceDecl)]
-> Maybe IfaceSimplifiedCore
-> IfaceAbiHashes
-> IfaceCache
-> ModIface

Given a PartialModIface, turn it into a ModIface by completing missing fields.

datadata IfaceBinHandle (phase :: ModIfacePhase) where

In-memory byte array representation of a ModIface.

See Note [Sharing of ModIface] for why we need this.

Constructors

PartialIfaceBinHandle :: IfaceBinHandle 'ModIfaceCore
A partial ModIface cannot be serialised to disk.
FullIfaceBinHandle :: !Maybe FullBinData -> IfaceBinHandle 'ModIfaceFinal
Optional FullBinData that can be serialised to disk directly.
See Note [Private fields in ModIface] for when this fields needs to be cleared (e.g., set to Nothing).

typetype PartialModIface = ModIface_ 'ModIfaceCore

datadata IfaceAbiHashes

Extends a PartialModIface with hashes of the ABI.

The mi_mod_hash is the hash of the entire ABI
THe other fields are more specific hashes of parts of the ABI

Constructors

IfaceAbiHashes
- mi_abi_mod_hash :: !Fingerprint
  Hash of the ABI only
- mi_abi_orphan :: !WhetherHasOrphans
  Whether this module has orphans
- mi_abi_finsts :: !WhetherHasFamInst
  Whether this module has family instances. See Note [The type family instance consistency story].
- mi_abi_export_avails_hash :: !Fingerprint
  Hash of the exported avails (does not include e.g. instances)
- mi_abi_orphan_like_hash :: !Fingerprint
  Orphans, together with (non-orphan) type family instances of dependencies and a few other things; see Note [Orphan-like hash].
  If this changes, we must recompile due to the impact on instance resolution.
- mi_abi_orphan_hash :: !Fingerprint
  Hash for orphan rules, class and family instances combined NOT transitive

Instances2NFData, Binary

NFData IfaceAbiHashesDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface
Binary IfaceAbiHashesDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface

datadata IfaceSelfRecomp

The information for a module which is only used when deciding whether to recompile itself.

See Note [Self recompilation information in interface files]

Constructors

IfaceSelfRecomp
- mi_sr_src_hash :: !Fingerprint
  Hash of the .hs source, used for recompilation checking.
- mi_sr_usages :: [Usage]
  Usages; kept sorted so that it's easy to decide whether to write a new iface file (changing usages doesn't affect the hash of this module) NOT STRICT! we read this field lazily from the interface file It is *only* consulted by the recompilation checker
- mi_sr_flag_hash :: !FingerprintWithValue IfaceDynFlags
  Hash of the important flags used when compiling the module, excluding optimisation flags
- mi_sr_opt_hash :: !Fingerprint
  Hash of optimisation flags
- mi_sr_hpc_hash :: !Fingerprint
  Hash of hpc flags
- mi_sr_plugin_hash :: !Fingerprint
  Hash of plugins

Instances3NFData, Outputable, Binary

NFData IfaceSelfRecompDefined in ghc-10.0.0.20260917 · GHC.Iface.Recomp.Types
Outputable IfaceSelfRecompDefined in ghc-10.0.0.20260917 · GHC.Iface.Recomp.Types
Binary IfaceSelfRecompDefined in ghc-10.0.0.20260917 · GHC.Iface.Recomp.Types

datadata IfaceCache

Constructors

IfaceCache
- mi_cache_decl_warn_fn :: !OccName -> Maybe (WarningTxt GhcRn)
  Cached lookup for mi_warns for declaration deprecations
- mi_cache_export_warn_fn :: !Name -> Maybe (WarningTxt GhcRn)
  Cached lookup for mi_warns for export deprecations
- mi_cache_fix_fn :: !OccName -> Maybe Fixity
  Cached lookup for mi_fixities
- mi_cache_hash_fn :: !OccName -> Maybe (OccName, Fingerprint)
  Cached lookup for mi_decls. The Nothing in mi_hash_fn means that the thing isn't in decls. It's useful to know that when seeing if we are up to date wrt. the old interface. The OccName is the parent of the name, if it has one.

Instances1NFData

NFData IfaceCacheDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface

datadata IfaceSimplifiedCore

The information needed to restart bytecode generation. Enabled by `-fwrite-if-simplified-core`.

Constructors

IfaceSimplifiedCore
- mi_sc_extra_decls :: [IfaceBindingX IfaceMaybeRhs IfaceTopBndrInfo]
  Extra variable definitions which are **NOT** exposed but when combined with mi_decls allows us to restart code generation. See Note [Interface Files with Core Definitions] and Note [Interface File with Core: Sharing RHSs]
- mi_sc_modBreaks :: Maybe ModBreaks
  If breakpoints are present in mi_sc_extra_decls this field provides this field provides the metadata required by the bytecode debugger.
- mi_sc_foreign :: IfaceForeign
  Foreign stubs and files to supplement mi_extra_decls_. See Note [Foreign stubs and TH bytecode linking]

Instances2NFData, Binary

NFData IfaceSimplifiedCoreDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface
Binary IfaceSimplifiedCoreDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface

valuewithSelfRecomp :: ModIface_ phase -> r -> (IfaceSelfRecomp -> r) -> r

familytype family IfaceDeclExts (phase :: ModIfacePhase) where

Selects a IfaceDecl representation. For fully instantiated interfaces we also maintain a fingerprint, which is used for recompilation checks.

Equations

IfaceDeclExts 'ModIfaceCore = IfaceDecl
IfaceDeclExts 'ModIfaceFinal = (Fingerprint, IfaceDecl)

familytype family IfaceAbiHashesExts (phase :: ModIfacePhase) where

Equations

IfaceAbiHashesExts 'ModIfaceCore = ()
IfaceAbiHashesExts 'ModIfaceFinal = IfaceAbiHashes

typetype IfaceExport = AvailInfo

datadata IfacePublic_ (phase :: ModIfacePhase)

The public interface of a module which are used by other modules when importing this module. The ABI of a module.

Constructors

IfacePublic
- mi_exports_ :: [IfaceExport]
  Exports Kept sorted by (mod,occ), to make version comparisons easier Records the modules that are the declaration points for things exported by this module, and the OccNames of those things
- mi_fixities_ :: [(OccName, Fixity)]
  Fixities NOT STRICT! we read this field lazily from the interface file
- mi_warns_ :: IfaceWarnings
  Warnings NOT STRICT! we read this field lazily from the interface file
- mi_anns_ :: [IfaceAnnotation]
  Annotations NOT STRICT! we read this field lazily from the interface file
- mi_decls_ :: [IfaceDeclExts phase]
  Type, class and variable declarations The hash of an Id changes if its fixity or deprecations change (as well as its type of course) Ditto data constructors, class operations, except that the hash of the parent class/tycon changes
- mi_defaults_ :: [IfaceDefault]
  default declarations exported by the module
- mi_insts_ :: [IfaceClsInst]
  Sorted class instance
- mi_fam_insts_ :: [IfaceFamInst]
  Sorted family instances
- mi_rules_ :: [IfaceRule]
  Sorted rules
- mi_trust_ :: IfaceTrustInfo
  Safe Haskell Trust information for this module.
- mi_trust_pkg_ :: Bool
  Do we require the package this module resides in be trusted to trust this module? This is used for the situation where a module is Safe (so doesn't require the package be trusted itself) but imports some trustworthy modules from its own package (which does require its own package be trusted). See Note [Trust Own Package] in GHC.Rename.Names
- mi_complete_matches_ :: [IfaceCompleteMatch]
  {-# COMPLETE #-} declarations
- mi_caches_ :: IfaceCache
  Cached lookups of some parts of mi_public
- mi_abi_hashes_ :: IfaceAbiHashesExts phase
  Either () or IfaceAbiHashes for a fully instantiated interface. These fields are hashes of different parts of the public interface.

Instances2NFData, Binary

(NFData (IfaceAbiHashesExts phase), NFData (IfaceDeclExts phase)) => NFData (IfacePublic_ phase)Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface
Binary (IfacePublic_ 'ModIfaceFinal)Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface

typetype IfacePublic = IfacePublic_ 'ModIfaceFinal

typetype PartialIfacePublic = IfacePublic_ 'ModIfaceCore

datadata IfaceModInfo

Meta information about the module the interface file is for

Constructors

IfaceModInfo
- mi_mod_info_module :: Module
  Name of the module we are for
- mi_mod_info_sig_of :: Maybe Module
  Are we a sig of another mod?
- mi_mod_info_hsc_src :: HscSource
  Boot? Signature?

Instances2NFData, Binary

NFData IfaceModInfoDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface
Binary IfaceModInfoDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface

typetype WhetherHasOrphans = Bool

Records whether a module has orphans. An "orphan" is one of:

An instance declaration in a module other than the definition module for one of the type constructors or classes in the instance head
A rewrite rule in a module other than the one defining the function in the head of the rule

typetype WhetherHasFamInst = Bool

Does this module define family instances?

datadata IfaceTopEnv

Constructors

IfaceTopEnv
- ifaceTopExports :: DetOrdAvails
  all top level things in this module, including unexported stuff
- ifaceImports :: [IfaceImport]
  all the imports in this module

Instances2NFData, Binary

NFData IfaceTopEnvDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface
Binary IfaceTopEnvDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.ModIface

datadata IfaceImport

Constructors

IfaceImport ImpDeclSpec ImpIfaceList

Instances2NFData, Binary

NFData IfaceImportDefined in ghc-10.0.0.20260917 · GHC.Iface.Syntax
Binary IfaceImportDefined in ghc-10.0.0.20260917 · GHC.Iface.Syntax

valuemi_boot :: ModIface -> IsBootInterface

Old-style accessor for whether or not the ModIface came from an hs-boot file.

valuemi_fix :: ModIface -> OccName -> Fixity

Lookups up a (possibly cached) fixity from a ModIface. If one cannot be found, defaultFixity is returned instead.

valuemi_semantic_module :: ModIface_ a -> Module

valuemi_mod_info_semantic_module :: IfaceModInfo -> Module

The semantic module for this interface; e.g., if it's a interface for a signature, if mi_module is p[A=A]:A, mi_semantic_module will be A.

valuemi_free_holes :: ModIface -> UniqDSet ModuleName

The "precise" free holes, e.g., the signatures that this ModIface depends on.

valuemi_mnwib :: ModIface -> ModuleNameWithIsBoot

valuemi_flag_hash

:: ModIface_ phase
-> Maybe (FingerprintWithValue IfaceDynFlags)

valuemi_opt_hash :: ModIface_ phase -> Maybe Fingerprint

valuemi_hpc_hash :: ModIface_ phase -> Maybe Fingerprint

valuemi_plugin_hash :: ModIface_ phase -> Maybe Fingerprint

valuemi_src_hash :: ModIface_ phase -> Maybe Fingerprint

valuemi_usages :: ModIface_ phase -> Maybe [Usage]

valuemi_mod_hash :: ModIface -> Fingerprint

Accessor for the module hash of the ABI from a ModIface.

valuemi_orphan :: ModIface -> WhetherHasOrphans

Accessor for whether this module has orphans from a ModIface.

valuemi_finsts :: ModIface -> WhetherHasFamInst

Accessor for whether this module has family instances from a ModIface.

valuemi_export_avails_hash :: ModIface -> Fingerprint

Accessor for the hash of exported avails.

valuemi_orphan_like_hash :: ModIface -> Fingerprint

Accessor for the hash of orphans and dependencies.

See Note [Orphan-like hash].

valuemi_orphan_hash :: ModIface -> Fingerprint

Accessor for the hash of orphan rules, class and family instances combined from a ModIface.

valuerenameFreeHoles

Given a set of free holes, and a unit identifier, rename the free holes according to the instantiation of the unit identifier. For example, if we have A and B free, and our unit identity is p[A=C,B=impl:B], the renamed free holes are just C.

valueemptyPartialModIface :: Module -> PartialModIface

valueemptyFullModIface :: Module -> ModIface

valuemkIfaceHashCache

Constructs cache for the mi_hash_fn field of a ModIface

valueemptyIfaceHashCache :: OccName -> Maybe (OccName, Fingerprint)

valueforceModIface :: ModIface -> IO ()