Fields

• hsc_dflags :: DynFlags

  The dynamic flag settings

• hsc_targets :: [Target]

  The targets (or roots) of the current session

• hsc_mod_graph :: ModuleGraph

  The module graph of the current session

• hsc_IC :: InteractiveContext

  The context for evaluating interactive statements

• hsc_HPT :: HomePackageTable

  The home package table describes already-compiled home-package modules, excluding the module we are compiling right now. (In one-shot mode the current module is the only home-package module, so hsc_HPT is empty. All other modules count as "external-package" modules. However, even in GHCi mode, hi-boot interfaces are demand-loaded into the external-package table.)

  hsc_HPT is not mutable because we only demand-load external packages; the home package is eagerly loaded, module by module, by the compilation manager.

  The HPT may contain modules compiled earlier by --make but not actually below the current module in the dependency graph.

  (This changes a previous invariant: changed Jan 05.)

• hsc_EPS :: !(IORef ExternalPackageState)

  Information about the currently loaded external packages. This is mutable because packages will be demand-loaded during a compilation run as required.

• hsc_NC :: !(IORef NameCache)

  As with hsc_EPS, this is side-effected by compiling to reflect sucking in interface files. They cache the state of external interface files, in effect.

• hsc_FC :: !(IORef FinderCache)

  The cached result of performing finding in the file system

• hsc_type_env_var :: Maybe (Module, IORef TypeEnv)

  Used for one-shot compilation only, to initialise the IfGblEnv. See tcg_type_env_var for TcGblEnv. See also Note [hsc_type_env_var hack]

• hsc_iserv :: MVar (Maybe IServ)

  interactive server process. Created the first time it is needed.

• hsc_dynLinker :: DynLinker

  dynamic linker.

Fields

• fr_paths :: [FilePath]
   
• fr_pkg :: Maybe UnitId
   
• fr_mods_hidden :: [UnitId]
   
• fr_pkgs_hidden :: [UnitId]
   
• fr_unusables :: [(UnitId, UnusablePackageReason)]
   
• fr_suggestions :: [ModuleSuggestion]
   

Fields

• targetId :: TargetId

  module or filename

• targetAllowObjCode :: Bool

  object code allowed?

• targetContents :: Maybe (InputFileBuffer, UTCTime)

  Optional in-memory buffer containing the source code GHC should use for this target instead of reading it from disk.

  Since GHC version 8.10 modules which require preprocessors such as Literate Haskell or CPP to run are also supported.

  If a corresponding source file does not exist on disk this will result in a SourceError exception if targetId = TargetModule _ is used. However together with targetId = TargetFile _ GHC will not complain about the file missing.

Fields

• hscs_guts :: CgGuts

  Information for the code generator.

• hscs_mod_location :: !ModLocation

  Module info

• hscs_partial_iface :: !PartialModIface

  Partial interface

• hscs_old_iface_hash :: !(Maybe Fingerprint)

  Old interface hash for this compilation, if an old interface file exists. Pass to hscMaybeWriteIface when writing the interface to avoid updating the existing interface when the interface isn't changed.

• hscs_iface_dflags :: !DynFlags

  Generate final iface using this DynFlags. FIXME (osa): I don't understand why this is necessary, but I spent almost two days trying to figure this out and I couldn't .. perhaps someone who understands this code better will remove this later.

Fields

• iservPipe :: Pipe
   
• iservProcess :: ProcessHandle
   
• iservLookupSymbolCache :: IORef (UniqFM (Ptr ()))
   
• iservPendingFrees :: [HValueRef]
   

Fields

• md_exports :: [AvailInfo]
   
• md_types :: !TypeEnv

  Local type environment for this particular module Includes Ids, TyCons, PatSyns

• md_insts :: ![ClsInst]

  DFunIds for the instances in this module

• md_fam_insts :: ![FamInst]
   
• md_rules :: ![CoreRule]

  Domain may include Ids from other modules

• md_anns :: ![Annotation]

  Annotations present in this module: currently they only annotate things also declared in this module

• md_complete_sigs :: [CompleteMatch]

  Complete match pragmas for this module

Fields

• mg_module :: !Module

  Module being compiled

• mg_hsc_src :: HscSource

  Whether it's an hs-boot module

• mg_loc :: SrcSpan

  For error messages from inner passes

• mg_exports :: ![AvailInfo]

  What it exports

• mg_deps :: !Dependencies

  What it depends on, directly or otherwise

• mg_usages :: ![Usage]

  What was used? Used for interfaces.

• mg_used_th :: !Bool

  Did we run a TH splice?

• mg_rdr_env :: !GlobalRdrEnv

  Top-level lexical environment

• mg_fix_env :: !FixityEnv

  Fixities declared in this module. Used for creating interface files.

• mg_tcs :: ![TyCon]

  TyCons declared in this module (includes TyCons for classes)

• mg_insts :: ![ClsInst]

  Class instances declared in this module

• mg_fam_insts :: ![FamInst]

  Family instances declared in this module

• mg_patsyns :: ![PatSyn]

  Pattern synonyms declared in this module

• mg_rules :: ![CoreRule]

  Before the core pipeline starts, contains See Note [Overall plumbing for rules] in Rules.hs

• mg_binds :: !CoreProgram

  Bindings for this module

• mg_foreign :: !ForeignStubs

  Foreign exports declared in this module

• mg_foreign_files :: ![(ForeignSrcLang, FilePath)]

  Files to be compiled with the C compiler

• mg_warns :: !Warnings

  Warnings declared in the module

• mg_anns :: [Annotation]

  Annotations declared in this module

• mg_complete_sigs :: [CompleteMatch]

  Complete Matches

• mg_hpc_info :: !HpcInfo

  Coverage tick boxes in the module

• mg_modBreaks :: !(Maybe ModBreaks)

  Breakpoints for the module

• mg_inst_env :: InstEnv

  Class instance environment for home-package modules (including this one); c.f. tcg_inst_env

• mg_fam_inst_env :: FamInstEnv

  Type-family instance environment for home-package modules (including this one); c.f. tcg_fam_inst_env

• mg_safe_haskell :: SafeHaskellMode

  Safe Haskell mode

• mg_trust_pkg :: Bool

  Do we need to trust our own package for Safe Haskell? See Note [RnNames . Trust Own Package]

• mg_doc_hdr :: !(Maybe HsDocString)

  Module header.

• mg_decl_docs :: !DeclDocMap

  Docs on declarations.

• mg_arg_docs :: !ArgDocMap

  Docs on arguments.

Fields

• cg_module :: !Module

  Module being compiled

• cg_tycons :: [TyCon]

  Algebraic data types (including ones that started life as classes); generate constructors and info tables. Includes newtypes, just for the benefit of External Core

• cg_binds :: CoreProgram

  The tidied main bindings, including previously-implicit bindings for record and class selectors, and data constructor wrappers. But *not* data constructor workers; reason: we regard them as part of the code-gen of tycons

• cg_foreign :: !ForeignStubs

  Foreign export stubs

• cg_foreign_files :: ![(ForeignSrcLang, FilePath)]
   
• cg_dep_pkgs :: ![InstalledUnitId]

  Dependent packages, used to generate #includes for C code gen

• cg_hpc_info :: !HpcInfo

  Program coverage tick box information

• cg_modBreaks :: !(Maybe ModBreaks)

  Module breakpoints

• cg_spt_entries :: [SptEntry]

  Static pointer table entries for static forms defined in the module. See Note [Grand plan for static forms] in StaticPtrTable

Fields

• imv_name :: ModuleName

  The name the module is imported with

• imv_span :: SrcSpan

  the source span of the whole import

• imv_is_safe :: IsSafeImport

  whether this is a safe import

• imv_is_hiding :: Bool

  whether this is an "hiding" import

• imv_all_exports :: !GlobalRdrEnv

  all the things the module could provide NB. BangPattern here: otherwise this leaks. (#15111)

• imv_qualified :: Bool

  whether this is a qualified import

Fields

• ms_mod :: Module

  Identity of the module

• ms_hsc_src :: HscSource

  The module source either plain Haskell or hs-boot

• ms_location :: ModLocation

  Location of the various files belonging to the module

• ms_hs_date :: UTCTime

  Timestamp of source file

• ms_obj_date :: Maybe UTCTime

  Timestamp of object, if we have one

• ms_iface_date :: Maybe UTCTime

  Timestamp of hi file, if we *only* are typechecking (it is Nothing otherwise. See Note [Recompilation checking in -fno-code mode] and #9243

• ms_hie_date :: Maybe UTCTime

  Timestamp of hie file, if we have one

• ms_srcimps :: [(Maybe FastString, Located ModuleName)]

  Source imports of the module

• ms_textual_imps :: [(Maybe FastString, Located ModuleName)]

  Non-source imports of the module from the module *text*

• ms_parsed_mod :: Maybe HsParsedModule

  The parsed, nonrenamed source, if we have it. This is also used to support "inline module syntax" in Backpack files.

• ms_hspp_file :: FilePath

  Filename of preprocessed source file

• ms_hspp_opts :: DynFlags

  Cached flags from OPTIONS, INCLUDE and LANGUAGE pragmas in the modules source code

• ms_hspp_buf :: Maybe StringBuffer

  The actual preprocessed source, if we have it

Fields

• hm_iface :: !ModIface

  The basic loaded interface file: every loaded module has one of these, even if it is imported from another package

• hm_details :: !ModDetails

  Extra information that has been created from the ModIface for the module, typically during typechecking

• hm_linkable :: !(Maybe Linkable)

  The actual artifact we would like to link to access things in this module.

  hm_linkable might be Nothing:

  1. If this is an .hs-boot module
  2. Temporarily during compilation if we pruned away the old linkable because it was out of date.

  After a complete compilation (load), all hm_linkable fields in the HomePackageTable will be Just.

  When re-linking a module (HscNoRecomp), we construct the HomeModInfo by building a new ModDetails from the old ModIface (only).

Fields

• eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface))

  In OneShot mode (only), home-package modules accumulate in the external package state, and are sucked in lazily. For these home-pkg modules (only) we need to record which are boot modules. We set this field after loading all the explicitly-imported interfaces, but before doing anything else

  The ModuleName part is not necessary, but it's useful for debug prints, and it's convenient because this field comes direct from imp_dep_mods

• eps_PIT :: !PackageIfaceTable

  The ModIfaces for modules in external packages whose interfaces we have opened. The declarations in these interface files are held in the eps_decls, eps_inst_env, eps_fam_inst_env and eps_rules fields of this record, not in the mi_decls fields of the interface we have sucked in.

  What is in the PIT is:

  • The Module
  • Fingerprint info
  • Its exports
  • Fixities
  • Deprecations and warnings
• eps_free_holes :: InstalledModuleEnv (UniqDSet ModuleName)

  Cache for mi_free_holes. Ordinarily, we can rely on the eps_PIT for this information, EXCEPT that when we do dependency analysis, we need to look at the Dependencies of our imports to determine what their precise free holes are (moduleFreeHolesPrecise). We don't want to repeatedly reread in the interface for every import, so cache it here. When the PIT gets filled in we can drop these entries.

• eps_PTE :: !PackageTypeEnv

  Result of typechecking all the external package interface files we have sucked in. The domain of the mapping is external-package modules

• eps_inst_env :: !PackageInstEnv

  The total InstEnv accumulated from all the external-package modules

• eps_fam_inst_env :: !PackageFamInstEnv

  The total FamInstEnv accumulated from all the external-package modules

• eps_rule_base :: !PackageRuleBase

  The total RuleEnv accumulated from all the external-package modules

• eps_ann_env :: !PackageAnnEnv

  The total AnnEnv accumulated from all the external-package modules

• eps_complete_matches :: !PackageCompleteMatchMap

  The total CompleteMatchMap accumulated from all the external-package modules

• eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv)

  The family instances accumulated from external packages, keyed off the module that declared them

• eps_stats :: !EpsStats

  Stastics about what was loaded from external packages

Fields

• n_ifaces_in, n_decls_in, n_decls_out, n_rules_in, n_rules_out, n_insts_in, n_insts_out :: !Int
   

Fields

• ic_dflags :: DynFlags

  The DynFlags used to evaluate interative expressions and statements.

• ic_mod_index :: Int

  Each GHCi stmt or declaration brings some new things into scope. We give them names like interactive:Ghci9.T, where the ic_index is the '9'. The ic_mod_index is incremented whenever we add something to ic_tythings See Note [The interactive package]

• ic_imports :: [InteractiveImport]

  The GHCi top-level scope (ic_rn_gbl_env) is extended with these imports

  This field is only stored here so that the client can retrieve it with GHC.getContext. GHC itself doesn't use it, but does reset it to empty sometimes (such as before a GHC.load). The context is set with GHC.setContext.

• ic_tythings :: [TyThing]

  TyThings defined by the user, in reverse order of definition (ie most recent at the front) See Note [ic_tythings]

• ic_rn_gbl_env :: GlobalRdrEnv

  The cached GlobalRdrEnv, built by setContext and updated regularly It contains everything in scope at the command line, including everything in ic_tythings

• ic_instances :: ([ClsInst], [FamInst])

  All instances and family instances created during this session. These are grabbed en masse after each update to be sure that proper overlapping is retained. That is, rather than re-check the overlapping each time we update the context, we just take the results from the instance code that already does that.

• ic_fix_env :: FixityEnv

  Fixities declared in let statements

• ic_default :: Maybe [Type]

  The current default types, set by a 'default' declaration

• ic_resume :: [Resume]

  The stack of breakpoint contexts

• ic_monad :: Name

  The monad that GHCi is executing in

• ic_int_print :: Name

  The function that is used for printing results of expressions in ghci and -e mode.

• ic_cwd :: Maybe FilePath
   

Fields

• mi_module :: !Module

  Name of the module we are for

• mi_sig_of :: !(Maybe Module)

  Are we a sig of another mod?

• mi_hsc_src :: !HscSource

  Boot? Signature?

• mi_deps :: Dependencies

  The dependencies of the module. This is consulted for directly-imported modules, but not for anything else (hence lazy)

• mi_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_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_used_th :: !Bool

  Module required TH splices when it was compiled. This disables recompilation avoidance (see #481).

• mi_fixities :: [(OccName, Fixity)]

  Fixities NOT STRICT! we read this field lazily from the interface file

• mi_warns :: Warnings

  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_globals :: !(Maybe GlobalRdrEnv)

  Binds all the things defined at the top level in the original source code for this module. which is NOT the same as mi_exports, nor mi_decls (which may contains declarations for things not actually defined by the user). Used for GHCi and for inspecting the contents of modules via the GHC API only.

  (We need the source file to figure out the top-level environment, if we didn't compile this module from source then this field contains Nothing).

  Strictly speaking this field should live in the HomeModInfo, but that leads to more plumbing.

• mi_insts :: [IfaceClsInst]

  Sorted class instance

• mi_fam_insts :: [IfaceFamInst]

  Sorted family instances

• mi_rules :: [IfaceRule]

  Sorted rules

• mi_hpc :: !AnyHpcUsage

  True if this program uses Hpc at any point in the program.

• 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 [RnNames . Trust Own Package]

• mi_complete_sigs :: [IfaceCompleteMatch]
   
• mi_doc_hdr :: Maybe HsDocString

  Module header.

• mi_decl_docs :: DeclDocMap

  Docs on declarations.

• mi_arg_docs :: ArgDocMap

  Docs on arguments.

• mi_final_exts :: !(IfaceBackendExts phase)

  Either () or ModIfaceBackend for a fully instantiated interface.

Fields

• mi_iface_hash :: !Fingerprint

  Hash of the whole interface

• mi_mod_hash :: !Fingerprint

  Hash of the ABI only

• mi_flag_hash :: !Fingerprint

  Hash of the important flags used when compiling the module, excluding optimisation flags

• mi_opt_hash :: !Fingerprint

  Hash of optimisation flags

• mi_hpc_hash :: !Fingerprint

  Hash of hpc flags

• mi_plugin_hash :: !Fingerprint

  Hash of plugins

• mi_orphan :: !WhetherHasOrphans

  Whether this module has orphans

• mi_finsts :: !WhetherHasFamInst

  Whether this module has family instances. See Note [The type family instance consistency story].

• mi_exp_hash :: !Fingerprint

  Hash of export list

• mi_orphan_hash :: !Fingerprint

  Hash for orphan rules, class and family instances combined

• mi_warn_fn :: !(OccName -> Maybe WarningTxt)

  Cached lookup for mi_warns

• mi_fix_fn :: !(OccName -> Maybe Fixity)

  Cached lookup for mi_fixities

• mi_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.

Fields

• usg_mod :: Module

  External package module depended on

• usg_mod_hash :: Fingerprint

  Cached module fingerprint

• usg_safe :: IsSafeImport

  Was this module imported as a safe import

Fields

• usg_mod_name :: ModuleName

  Name of the module

• usg_mod_hash :: Fingerprint

  Cached module fingerprint

• usg_entities :: [(OccName, Fingerprint)]

  Entities we depend on, sorted by occurrence name and fingerprinted. NB: usages are for parent names only, e.g. type constructors but not the associated data constructors.

• usg_exports :: Maybe Fingerprint

  Fingerprint for the export list of this module, if we directly imported it (and hence we depend on its export list)

• usg_safe :: IsSafeImport

  Was this module imported as a safe import

Fields

• usg_file_path :: FilePath

  External file dependency. From a CPP #include or TH addDependentFile. Should be absolute.

• usg_file_hash :: Fingerprint

  Fingerprint of the file contents.

Fields

• usg_mod :: Module

  External package module depended on

• usg_mod_hash :: Fingerprint

  Cached module fingerprint

Fields

• dep_mods :: [(ModuleName, IsBootInterface)]

  All home-package modules transitively below this one I.e. modules that this one imports, or that are in the dep_mods of those directly-imported modules

• dep_pkgs :: [(InstalledUnitId, Bool)]

  All packages transitively below this module I.e. packages to which this module's direct imports belong, or that are in the dep_pkgs of those modules The bool indicates if the package is required to be trusted when the module is imported as a safe import (Safe Haskell). See Note [RnNames . Tracking Trust Transitively]

• dep_orphs :: [Module]

  Transitive closure of orphan modules (whether home or external pkg).

  (Possible optimization: don't include family instance orphans as they are anyway included in dep_finsts. But then be careful about code which relies on dep_orphs having the complete list!) This does NOT include us, unlike imp_orphs.

• dep_finsts :: [Module]

  Transitive closure of depended upon modules which contain family instances (whether home or external). This is used by checkFamInstConsistency. This does NOT include us, unlike imp_finsts. See Note [The type family instance consistency story].

• dep_plgins :: [ModuleName]

  All the plugins used while compiling this module.

Fields

• linkableTime :: UTCTime

  Time at which this linkable was built (i.e. when the bytecodes were produced, or the mod date on the files)

• linkableModule :: Module

  The linkable module itself

• linkableUnlinked :: [Unlinked]

  Those files and chunks of code we have yet to link.

  INVARIANT: A valid linkable always has at least one Unlinked item. If this list is empty, the Linkable represents a fake linkable, which is generated in HscNothing mode to avoid recompiling modules.

  ToDo: Do items get removed from this list when they get linked?

Fields

• hpcInfoTickCount :: Int
   
• hpcInfoHash :: Int
   

Fields

• hpcUsed :: AnyHpcUsage

  Is hpc used anywhere on the module *tree*?

Fields

• modBreaks_flags :: ForeignRef BreakArray

  The array of flags, one per breakpoint, indicating which breakpoints are enabled.

• modBreaks_locs :: !(Array BreakIndex SrcSpan)

  An array giving the source span of each breakpoint.

• modBreaks_vars :: !(Array BreakIndex [OccName])

  An array giving the names of the free variables at each breakpoint.

• modBreaks_decls :: !(Array BreakIndex [String])

  An array giving the names of the declarations enclosing each breakpoint.

• modBreaks_ccs :: !(Array BreakIndex (RemotePtr CostCentre))

  Array pointing to cost centre for each breakpoint

• modBreaks_breakInfo :: IntMap CgBreakInfo

  info about each breakpoint from the bytecode generator

Fields

• hpm_module :: Located (HsModule GhcPs)
   
• hpm_src_files :: [FilePath]

  extra source files (e.g. from #includes). The lexer collects these from '# file line' pragmas, which the C preprocessor leaves behind. These files and their timestamps are stored in the .hi file, so that we can force recompilation if any of them change (#3589)

• hpm_annotations :: ApiAnns
   

Fields

• completeMatchConLikes :: [Name]

  The ConLikes that form a covering family (e.g. Nothing, Just)

• completeMatchTyCon :: Name

  The TyCon that they cover (e.g. Maybe)