Moduleghc-lib-parser-9.14.1.20251220GHC2021

GHC.Unit.Module.Deps

Dependencies and Usage of a module

6 types
14 values

Packageghc-lib-parser-9.14.1.20251220
Exports21
LanguageGHC2021
LicenceBSD-3-Clause
SourceDeps.hs

datadata Dependencies

Dependency information about ALL modules and packages below this one in the import hierarchy. This is the serialisable version of ImportAvails.

Invariant: the dependencies of a module M never includes M.

Invariant: none of the lists contain duplicates.

Invariant: lists are ordered canonically (e.g. using stableModuleCmp)

See Note [Transitive Information in Dependencies]

Instances3Eq, NFData, Binary

Eq DependenciesDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
NFData DependenciesDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
Binary DependenciesDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps

valuedep_direct_mods

:: Dependencies
-> Set (IfaceImportLevel, UnitId, ModuleNameWithIsBoot)

valuedep_direct_pkgs :: Dependencies -> Set (IfaceImportLevel, UnitId)

valuedep_sig_mods :: Dependencies -> [ModuleName]

valuedep_trusted_pkgs :: Dependencies -> Set UnitId

valuedep_orphs :: Dependencies -> [Module]

valuedep_plugin_pkgs :: Dependencies -> Set UnitId

valuedep_finsts :: Dependencies -> [Module]

valuedep_boot_mods :: Dependencies -> Set (UnitId, ModuleNameWithIsBoot)

pattern

pattern Dependencies :: Set (IfaceImportLevel, UnitId, ModuleNameWithIsBoot) -> Set (IfaceImportLevel, UnitId) -> Set UnitId -> [ModuleName] -> Set UnitId -> Set (UnitId, ModuleNameWithIsBoot) -> [Module] -> [Module] -> Dependencies

valuedep_orphs_update

:: Monad m
=> Dependencies
-> [Module] -> m [Module]
-> m Dependencies

Update module dependencies containing orphans (used by Backpack)

valuedep_finsts_update

:: Monad m
=> Dependencies
-> [Module] -> m [Module]
-> m Dependencies

Update module dependencies containing family instances (used by Backpack)

valuemkDependencies

:: HomeUnit
-> Module
-> ImportAvails
-> [Module]
-> Dependencies

Extract information from the rename and typecheck phases to produce a dependencies information for the module being compiled.

The fourth argument is a list of plugin modules.

valuenoDependencies :: Dependencies

valuepprDeps :: UnitState -> Dependencies -> SDoc

Pretty-print unit dependencies

datadata Usage

Records modules for which changes may force recompilation of this module See wiki: https://gitlab.haskell.org/ghc/ghc/wikis/commentary/compiler/recompilation-avoidance

This differs from Dependencies. A module X may be in the dep_mods of this module (via an import chain) but if we don't use anything from X it won't appear in our Usage

Constructors

UsagePackageModule
Module from another package
- usg_mod :: Module
  External package module depended on
- usg_mod_hash :: Fingerprint
  Cached module ABI fingerprint (corresponds to mi_mod_hash)
- usg_safe :: IsSafeImport
  Was this module imported as a safe import
UsageHomeModule
Module from the current package
- usg_mod_name :: ModuleName
  Name of the module
- usg_unit_id :: UnitId
  UnitId of the HomeUnit the module is from
- usg_mod_hash :: Fingerprint
  Cached module ABI fingerprint (corresponds to mi_mod_hash)
- 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 HomeModImport
  What we depend on from the exports of the module; see HomeModImport.
- usg_safe :: IsSafeImport
  Was this module imported as a safe import
UsageFile
A file upon which the module depends, e.g. a CPP #include, or using TH's addDependentFile
- usg_file_path :: FastString
  External file dependency. From a CPP #include or TH addDependentFile. Should be absolute.
- usg_file_hash :: Fingerprint
  Fingerprint of the file contents.
- usg_file_label :: Maybe String
  An optional string which is used in recompilation messages if file in question has changed.
UsageHomeModuleInterface
- usg_mod_name :: ModuleName
  Name of the module
- usg_unit_id :: UnitId
  UnitId of the HomeUnit the module is from
- usg_iface_hash :: Fingerprint
  The *interface* hash of the module, not the ABI hash. This changes when anything about the interface (and hence the module) has changed.
UsageMergedRequirement
A requirement which was merged into this one.
- usg_mod :: Module
  External package module depended on
- usg_mod_hash :: Fingerprint
  Cached module ABI fingerprint (corresponds to mi_mod_hash)

Instances3Eq, NFData, Binary

Eq UsageDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
NFData UsageDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
Binary UsageDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps

datadata HomeModImport

Records the imports that we depend on from a home module, for recompilation checking.

See Note [When to recompile when export lists change?] in GHC.Iface.Recomp.

Constructors

HomeModImport
- hmiu_orphanLikeHash :: Fingerprint
  Hash of orphans, dependencies, orphans of dependencies etc...
  See Note [Orphan-like hash].
  If this changes, we definitely need to recompile.
- hmiu_importedAvails :: HomeModImportedAvails
  The avails we are importing; see HomeModImportedAvails.

Instances4Eq, NFData, Outputable, Binary

Eq HomeModImportDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
NFData HomeModImportDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
Outputable HomeModImportDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
Binary HomeModImportDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps

datadata HomeModImportedAvails

Records all the Avails we are importing from a home module.

Constructors

HMIA_Explicit
All import lists are explicit import lists, but some identifiers may still be implicitly imported, e.g. import M(a, b, T(..)).
In this case, recompilation is keyed by the names we are importing, with their Avail structure.
- hmia_imported_avails :: DetOrdAvails
  The avails we are importing
- hmia_parents_with_implicits :: NameSet
  The Names of all AvailTC imports which implicitly import children
HMIA_Implicit
One import is a whole module import, or a import module M hiding(..) import.
In this case, recompilation is keyed on the hash of the exported avails of the module we are importing.
- hmia_exportedAvailsHash :: Fingerprint
  The export avails hash of the module we are importing

Instances4Eq, NFData, Outputable, Binary

Eq HomeModImportedAvailsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
NFData HomeModImportedAvailsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
Outputable HomeModImportedAvailsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
Binary HomeModImportedAvailsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps

datadata ImportAvails

ImportAvails summarises what was imported from where, irrespective of whether the imported things are actually used or not. It is used:

when processing the export list,
when constructing usage info for the interface file,
to identify the list of directly imported modules for initialisation purposes and for optimised overlap checking of family instances,
when figuring out what things are really unused

Constructors

ImportAvails
- imp_mods :: ImportedMods
  Domain is all directly-imported modules
  See the documentation on ImportedModsVal in GHC.Unit.Module.Imported for the meaning of the fields.
  We need a full ModuleEnv rather than a ModuleNameEnv here, because we might be importing modules of the same name from different packages. (currently not the case, but might be in the future).
- imp_direct_dep_mods :: InstalledModuleEnv (Set ImportLevel, ModuleNameWithIsBoot)
  Home-package modules directly imported by the module being compiled.
- imp_dep_direct_pkgs :: Set (ImportLevel, UnitId)
  Packages directly needed by the module being compiled
- imp_trust_own_pkg :: Bool
  Do we require that our own package is trusted? This is to handle efficiently the case where a Safe module imports a Trustworthy module that resides in the same package as it. See Note [Trust Own Package] in GHC.Rename.Names
- imp_trust_pkgs :: Set UnitId
  This records the packages the current module needs to trust for Safe Haskell compilation to succeed. A package is required to be trusted if we are dependent on a trustworthy module in that package. See Note [Tracking Trust Transitively] in GHC.Rename.Names
- imp_boot_mods :: InstalledModuleEnv ModuleNameWithIsBoot
  Domain is all modules which have hs-boot files, and whether we should import the boot version of interface file. Only used in one-shot mode to populate eps_is_boot.
- imp_sig_mods :: [ModuleName]
  Signature modules below this one
- imp_orphs :: [Module]
  Orphan modules below us in the import tree (and maybe including us for imported modules)
- imp_finsts :: [Module]
  Family instance modules below us in the import tree (and maybe including us for imported modules)

newtypenewtype IfaceImportLevel

Constructors

IfaceImportLevel ImportLevel

Instances5Eq, Ord, NFData, Outputable, Binary

Eq IfaceImportLevelDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
Ord IfaceImportLevelDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
NFData IfaceImportLevelDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
Outputable IfaceImportLevelDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps
Binary IfaceImportLevelDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Deps

valuetcImportLevel :: IfaceImportLevel -> ImportLevel