Per-component new-build support (no Custom support yet).

A bit of a megapatch.  Here's what's in it:

* First, a few miscellaneous utility functions and reexports
  in Cabal.  I could have split these into a separate commit
  but I was too lazy to.

* Distribution.Client.Install got refactored:
  instead of using PackageFixedDeps, it uses IsUnit
  instead.  This is because we weren't using ComponentDeps
  in a nontrivial way; we just need some graph structure
  and IsNode (with UnitId keys) fulfills that. I also removed the
  invariant checking and error reporting because it was
  being annoying (we check the invariants already in
  SolverInstallPlan).

* Look at Distribution.Client.ProjectPlanning.Types.
  This contains the primary type change: ElaboratedConfiguredPackage
  is now EITHER a monolithic ElaboratedPackage, or a per-component
  ElaboratedComponent (it should get renamed but I didn't do that
  in this patch.)  These are what we're going to store in our
  plans: if a package we're building has a Setup script which supports
  per-component builds, we'll explode it into a component.  Otherwise
  we'll keep it as a package.  We'll see codepaths for both
  throughout.

* OK, so the expansion happens in ProjectPlanning, mostly in
  'elaborateAndExpandSolverPackage'.  You should review the
  package hash computation code closely.  When we can separate
  components, we compute a hash for each INDEPENDENTLY.  This
  is good: we get more sharing.

* We need to adjust the target resolution and pruning code
  in ProjectOrchestration and ProjectPlanning.  I did a dumb
  but easy idea: if a user mentions 'packagename' in a
  target name, I spray the PackageTarget on every
  possibly relevant IPID in buildTargets', and then pare
  it down later.

* And of course there's code in ProjectBuilding to actual
  do a configure and then build.

* We change the layout of build directories so that we can
  track each component separately.  While I was doing that,
  I also added compiler and platform information.

Custom doesn't work yet because I need to give them their own
separate component, and teach Cabal how to build them specially.

Signed-off-by: Edward Z. Yang <[email protected]>

Author: ezyang

Cabal/Distribution/Package.hs

@@ -27,6 +27,7 @@ module Distribution.Package (
         UnitId(..),
         mkUnitId,
         mkLegacyUnitId,
+        unitIdComponentId,
         getHSLibraryName,
         InstalledPackageId, -- backwards compat
 
@@ -176,6 +177,10 @@ mkUnitId = SimpleUnitId . ComponentId
 mkLegacyUnitId :: PackageId -> UnitId
 mkLegacyUnitId = SimpleUnitId . ComponentId . display
 
+-- | Extract 'ComponentId' from 'UnitId'.
+unitIdComponentId :: UnitId -> ComponentId
+unitIdComponentId (SimpleUnitId cid) = cid
+
 -- ------------------------------------------------------------
 -- * Package source dependencies
 -- ------------------------------------------------------------

Cabal/Distribution/Simple/Configure.hs

@@ -35,6 +35,8 @@ module Distribution.Simple.Configure (configure,
                                       tryGetPersistBuildConfig,
                                       maybeGetPersistBuildConfig,
                                       findDistPref, findDistPrefOrDefault,
+                                      mkComponentsGraph,
+                                      getInternalPackages,
                                       computeComponentId,
                                       computeCompatPackageKey,
                                       computeCompatPackageName,

Cabal/Distribution/Types/ComponentEnabledSpec.hs

@@ -54,7 +54,7 @@ data ComponentEnabledSpec
     = ComponentEnabledSpec { testsEnabled :: Bool,
                              benchmarksEnabled :: Bool }
     | OneComponentEnabledSpec ComponentName
-  deriving (Generic, Read, Show)
+  deriving (Generic, Read, Show, Eq)
 instance Binary ComponentEnabledSpec
 
 -- | The default set of enabled components.  Historically tests and

Cabal/Distribution/Types/PackageDescription.hs

@@ -43,6 +43,7 @@ module Distribution.Types.PackageDescription (
     updatePackageDescription,
     pkgComponents,
     pkgBuildableComponents,
+    enabledComponents,
     lookupComponent,
     getComponent,
   ) where
@@ -57,6 +58,7 @@ import Distribution.Types.Benchmark
 
 import Distribution.Types.Component
 import Distribution.Types.ComponentName
+import Distribution.Types.ComponentEnabledSpec
 import Distribution.Types.SetupBuildInfo
 import Distribution.Types.BuildInfo
 import Distribution.Types.BuildType
@@ -346,6 +348,13 @@ pkgComponents pkg =
 pkgBuildableComponents :: PackageDescription -> [Component]
 pkgBuildableComponents = filter componentBuildable . pkgComponents
 
+-- | A list of all components in the package that are enabled.
+--
+-- @since 2.0.0.0
+--
+enabledComponents :: PackageDescription -> ComponentEnabledSpec -> [Component]
+enabledComponents pkg enabled = filter (componentEnabled enabled) $ pkgBuildableComponents pkg
+
 lookupComponent :: PackageDescription -> ComponentName -> Maybe Component
 lookupComponent pkg CLibName = fmap CLib (library pkg)
 lookupComponent pkg (CSubLibName name) =

cabal-install/Distribution/Client/CmdBuild.hs

@@ -63,6 +63,7 @@ buildAction (configFlags, configExFlags, installFlags, haddockFlags)
     -- repl targets (as opposed to say repl or haddock targets).
     selectBuildTargets =
       selectTargets
+        verbosity
         BuildDefaultComponents
         BuildSpecificComponent
 

cabal-install/Distribution/Client/CmdFreeze.hs

@@ -7,13 +7,11 @@ module Distribution.Client.CmdFreeze (
   ) where
 
 import Distribution.Client.ProjectPlanning
-         ( ElaboratedInstallPlan, rebuildInstallPlan )
 import Distribution.Client.ProjectConfig
          ( ProjectConfig(..), ProjectConfigShared(..)
          , commandLineFlagsToProjectConfig, writeProjectLocalFreezeConfig
          , findProjectRoot )
 import Distribution.Client.ProjectPlanning.Types
-         ( ElaboratedConfiguredPackage(..) )
 import Distribution.Client.Targets
          ( UserConstraint(..) )
 import Distribution.Solver.Types.ConstraintSource
@@ -149,16 +147,18 @@ projectFreezeConstraints plan =
     flagAssignments =
       Map.fromList
         [ (pkgname, flags)
-        | InstallPlan.Configured pkg <- InstallPlan.toList plan
-        , let flags   = pkgFlagAssignment pkg
+        | InstallPlan.Configured pkg_or_comp <- InstallPlan.toList plan
+        , let pkg     = getElaboratedPackage pkg_or_comp
+              flags   = pkgFlagAssignment pkg
               pkgname = packageName pkg
         , not (null flags) ]
 
     localPackages :: Map PackageName ()
     localPackages =
       Map.fromList
         [ (packageName pkg, ())
-        | InstallPlan.Configured pkg <- InstallPlan.toList plan
+        | InstallPlan.Configured pkg_or_comp <- InstallPlan.toList plan
+        , let pkg = getElaboratedPackage pkg_or_comp
         , pkgLocalToProject pkg
         ]
 

cabal-install/Distribution/Client/CmdRepl.hs

@@ -67,6 +67,7 @@ replAction (configFlags, configExFlags, installFlags, haddockFlags)
     -- repl targets (as opposed to say build or haddock targets).
     selectReplTargets =
       selectTargets
+        verbosity
         ReplDefaultComponent
         ReplSpecificComponent
 

cabal-install/Distribution/Client/DistDirLayout.hs

@@ -5,17 +5,43 @@
 -- The layout of the .\/dist\/ directory where cabal keeps all of it's state
 -- and build artifacts.
 --
-module Distribution.Client.DistDirLayout where
+module Distribution.Client.DistDirLayout (
+    -- 'DistDirLayout'
+    DistDirLayout(..),
+    DistDirParams(..),
+    defaultDistDirLayout,
+
+    -- * 'CabalDirLayout'
+    CabalDirLayout(..),
+    defaultCabalDirLayout,
+) where
 
 import System.FilePath
 import Distribution.Package
-         ( PackageId )
+         ( PackageId, UnitId(..) )
 import Distribution.Compiler
 import Distribution.Simple.Compiler (PackageDB(..))
 import Distribution.Text
+import Distribution.Types.ComponentName
+import Distribution.System
 import Distribution.Client.Types
          ( InstalledPackageId )
 
+-- | Information which can be used to construct the path to
+-- the build directory of a build.  This is LESS fine-grained
+-- than what goes into the hashed 'InstalledPackageId',
+-- and for good reason: we don't want this path to change if
+-- the user, say, adds a dependency to their project.
+data DistDirParams = DistDirParams {
+    distParamUnitId         :: UnitId,
+    distParamPackageId      :: PackageId,
+    distParamComponentName  :: Maybe ComponentName,
+    distParamCompilerId     :: CompilerId,
+    distParamPlatform       :: Platform
+    -- TODO (see #3343):
+    --  Flag assignments
+    --  Optimization
+    }
 
 
 -- | The layout of the project state directory. Traditionally this has been
@@ -31,11 +57,11 @@ data DistDirLayout = DistDirLayout {
        -- | The directory under dist where we keep the build artifacts for a
        -- package we're building from a local directory.
        --
-       -- This uses a 'PackageId' not just a 'PackageName' because technically
+       -- This uses a 'UnitId' not just a 'PackageName' because technically
        -- we can have multiple instances of the same package in a solution
        -- (e.g. setup deps).
        --
-       distBuildDirectory           :: PackageId -> FilePath,
+       distBuildDirectory           :: DistDirParams -> FilePath,
        distBuildRootDirectory       :: FilePath,
 
        -- | The directory under dist where we put the unpacked sources of
@@ -55,8 +81,8 @@ data DistDirLayout = DistDirLayout {
        -- | The location for package-specific cache files (e.g. state used in
        -- incremental rebuilds).
        --
-       distPackageCacheFile         :: PackageId -> String -> FilePath,
-       distPackageCacheDirectory    :: PackageId -> FilePath,
+       distPackageCacheFile         :: DistDirParams -> String -> FilePath,
+       distPackageCacheDirectory    :: DistDirParams -> FilePath,
 
        distTempDirectory            :: FilePath,
        distBinDirectory             :: FilePath,
@@ -88,7 +114,17 @@ defaultDistDirLayout projectRootDirectory =
     --TODO: switch to just dist at some point, or some other new name
 
     distBuildRootDirectory   = distDirectory </> "build"
-    distBuildDirectory pkgid = distBuildRootDirectory </> display pkgid
+    distBuildDirectory params =
+        distBuildRootDirectory </>
+        display (distParamPlatform params) </>
+        display (distParamCompilerId params) </>
+        display (distParamPackageId params) </>
+        (case fmap componentNameString (distParamComponentName params) of
+            Nothing         -> ""
+            Just Nothing    -> ""
+            Just (Just str) -> "c" </> str) </>
+        (case distParamUnitId params of -- For Backpack
+            SimpleUnitId _ -> "")
 
     distUnpackedSrcRootDirectory   = distDirectory </> "src"
     distUnpackedSrcDirectory pkgid = distUnpackedSrcRootDirectory
@@ -97,8 +133,8 @@ defaultDistDirLayout projectRootDirectory =
     distProjectCacheDirectory = distDirectory </> "cache"
     distProjectCacheFile name = distProjectCacheDirectory </> name
 
-    distPackageCacheDirectory pkgid = distBuildDirectory pkgid </> "cache"
-    distPackageCacheFile pkgid name = distPackageCacheDirectory pkgid </> name
+    distPackageCacheDirectory params = distBuildDirectory params </> "cache"
+    distPackageCacheFile params name = distPackageCacheDirectory params </> name
 
     distTempDirectory = distDirectory </> "tmp"
 

cabal-install/Distribution/Client/Install.hs

@@ -116,7 +116,6 @@ import           Distribution.Solver.Types.ConstraintSource
 import           Distribution.Solver.Types.LabeledPackageConstraint
 import           Distribution.Solver.Types.OptionalStanza
 import qualified Distribution.Solver.Types.PackageIndex as SourcePackageIndex
-import           Distribution.Solver.Types.PackageFixedDeps
 import           Distribution.Solver.Types.PkgConfigDb
                    ( PkgConfigDb, readPkgConfigDb )
 import           Distribution.Solver.Types.SourcePackage as SourcePackage
@@ -614,12 +613,12 @@ packageStatus installedPkgIndex cpkg =
     changes :: Installed.InstalledPackageInfo
             -> ReadyPackage
             -> [MergeResult PackageIdentifier PackageIdentifier]
-    changes pkg pkg' = filter changed $
+    changes pkg (ReadyPackage pkg') = filter changed $
       mergeBy (comparing packageName)
         -- deps of installed pkg
         (resolveInstalledIds $ Installed.depends pkg)
         -- deps of configured pkg
-        (resolveInstalledIds $ CD.nonSetupDeps (depends pkg'))
+        (resolveInstalledIds $ map confInstId (CD.nonSetupDeps (confPkgDeps pkg')))
 
     -- convert to source pkg ids via index
     resolveInstalledIds :: [UnitId] -> [PackageIdentifier]