Change dist-newstyle layout from build/pid to build/ipkgid.

Sorry, all you folks who have finger-macroed
dist-newstyle/build/pkg-1.0; the format will now
be dist-newstyle/build/pkg-1.0-inplace (or perhaps
even further mangled.)  Although "inplace" is seemingly
redundant, it won't be when we build components individually
(build/pkg-1.0-inplace-exename) where each component needs
a separate dist-directory.  If we change our inplace
identifiers to be more detailed (see haskell#3343) then it
permits inplace builds to handle all situations where
package identifiers do not sufficiently disambiguate.

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

Author: ezyang

cabal-install/Distribution/Client/DistDirLayout.hs

@@ -9,7 +9,7 @@ module Distribution.Client.DistDirLayout where
 
 import System.FilePath
 import Distribution.Package
-         ( PackageId )
+         ( PackageId, UnitId )
 import Distribution.Compiler
 import Distribution.Simple.Compiler (PackageDB(..))
 import Distribution.Text
@@ -31,11 +31,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           :: UnitId -> FilePath,
        distBuildRootDirectory       :: FilePath,
 
        -- | The directory under dist where we put the unpacked sources of
@@ -55,8 +55,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         :: UnitId -> String -> FilePath,
+       distPackageCacheDirectory    :: UnitId -> FilePath,
 
        distTempDirectory            :: FilePath,
        distBinDirectory             :: FilePath,
@@ -88,7 +88,7 @@ defaultDistDirLayout projectRootDirectory =
     --TODO: switch to just dist at some point, or some other new name
 
     distBuildRootDirectory   = distDirectory </> "build"
-    distBuildDirectory pkgid = distBuildRootDirectory </> display pkgid
+    distBuildDirectory uid = distBuildRootDirectory </> display uid
 
     distUnpackedSrcRootDirectory   = distDirectory </> "src"
     distUnpackedSrcDirectory pkgid = distUnpackedSrcRootDirectory
@@ -97,8 +97,8 @@ defaultDistDirLayout projectRootDirectory =
     distProjectCacheDirectory = distDirectory </> "cache"
     distProjectCacheFile name = distProjectCacheDirectory </> name
 
-    distPackageCacheDirectory pkgid = distBuildDirectory pkgid </> "cache"
-    distPackageCacheFile pkgid name = distPackageCacheDirectory pkgid </> name
+    distPackageCacheDirectory uid = distBuildDirectory uid </> "cache"
+    distPackageCacheFile uid name = distPackageCacheDirectory uid </> name
 
     distTempDirectory = distDirectory </> "tmp"
 

cabal-install/Distribution/Client/ProjectBuilding.hs

@@ -303,7 +303,7 @@ rebuildTargetsDryRun distDirLayout@DistDirLayout{..} = \installPlan -> do
             return (BuildStatusUpToDate buildSuccess)
       where
         packageFileMonitor =
-          newPackageFileMonitor distDirLayout (packageId pkg)
+          newPackageFileMonitor distDirLayout (installedUnitId pkg)
 
 
 -- | A specialised traversal over the packages in an install plan.
@@ -393,22 +393,22 @@ data PackageFileMonitor = PackageFileMonitor {
 --
 type BuildSuccessMisc = (DocsResult, TestsResult)
 
-newPackageFileMonitor :: DistDirLayout -> PackageId -> PackageFileMonitor
-newPackageFileMonitor DistDirLayout{distPackageCacheFile} pkgid =
+newPackageFileMonitor :: DistDirLayout -> UnitId -> PackageFileMonitor
+newPackageFileMonitor DistDirLayout{distPackageCacheFile} ipkgid =
     PackageFileMonitor {
       pkgFileMonitorConfig =
-        newFileMonitor (distPackageCacheFile pkgid "config"),
+        newFileMonitor (distPackageCacheFile ipkgid "config"),
 
       pkgFileMonitorBuild =
         FileMonitor {
-          fileMonitorCacheFile = distPackageCacheFile pkgid "build",
+          fileMonitorCacheFile = distPackageCacheFile ipkgid "build",
           fileMonitorKeyValid  = \componentsToBuild componentsAlreadyBuilt ->
             componentsToBuild `Set.isSubsetOf` componentsAlreadyBuilt,
           fileMonitorCheckIfOnlyValueChanged = True
         },
 
       pkgFileMonitorReg =
-        newFileMonitor (distPackageCacheFile pkgid "registration")
+        newFileMonitor (distPackageCacheFile ipkgid "registration")
     }
 
 -- | Helper function for 'checkPackageFileMonitorChanged',
@@ -686,7 +686,7 @@ rebuildTarget verbosity
     unpackTarballPhase tarball =
         withTarballLocalDirectory
           verbosity distDirLayout tarball
-          (packageId pkg) (pkgBuildStyle pkg)
+          (packageId pkg) (installedPackageId pkg) (pkgBuildStyle pkg)
           (pkgDescriptionOverride pkg) $
 
           case pkgBuildStyle pkg of
@@ -704,7 +704,7 @@ rebuildTarget verbosity
 
           buildInplace buildStatus srcdir builddir
       where
-        builddir = distBuildDirectory (packageId pkg)
+        builddir = distBuildDirectory (installedUnitId pkg)
 
     buildAndInstall srcdir builddir =
         buildAndInstallUnpackedPackage
@@ -790,19 +790,22 @@ downloadedSourceLocation pkgloc =
 
 
 -- | Ensure that the package is unpacked in an appropriate directory, either
--- a temporary one or a persistent one under the shared dist directory. 
+-- a temporary one or a persistent one under the shared dist directory.
 --
 withTarballLocalDirectory
   :: Verbosity
   -> DistDirLayout
   -> FilePath
   -> PackageId
+  -> UnitId
   -> BuildStyle
   -> Maybe CabalFileText
-  -> (FilePath -> FilePath -> IO a)
+  -> (FilePath -> -- Source directory
+      FilePath -> -- Build directory
+      IO a)
   -> IO a
 withTarballLocalDirectory verbosity distDirLayout@DistDirLayout{..}
-                          tarball pkgid buildstyle pkgTextOverride
+                          tarball pkgid ipkgid buildstyle pkgTextOverride
                           buildPkg  =
       case buildstyle of
         -- In this case we make a temp dir, unpack the tarball to there and
@@ -822,15 +825,15 @@ withTarballLocalDirectory verbosity distDirLayout@DistDirLayout{..}
         BuildInplaceOnly -> do
           let srcrootdir = distUnpackedSrcRootDirectory
               srcdir     = distUnpackedSrcDirectory pkgid
-              builddir   = distBuildDirectory pkgid
+              builddir   = distBuildDirectory ipkgid
           -- TODO: [nice to have] use a proper file monitor rather than this dir exists test
           exists <- doesDirectoryExist srcdir
           unless exists $ do
             createDirectoryIfMissingVerbose verbosity False srcrootdir
             unpackPackageTarball verbosity tarball srcrootdir
                                  pkgid pkgTextOverride
             moveTarballShippedDistDirectory verbosity distDirLayout
-                                            srcrootdir pkgid
+                                            srcrootdir pkgid ipkgid
           buildPkg srcdir builddir
 
 
@@ -876,9 +879,9 @@ unpackPackageTarball verbosity tarball parentdir pkgid pkgTextOverride =
 -- system, though we'll still need to keep this hack for older packages.
 --
 moveTarballShippedDistDirectory :: Verbosity -> DistDirLayout
-                                -> FilePath -> PackageId -> IO ()
+                                -> FilePath -> PackageId -> UnitId -> IO ()
 moveTarballShippedDistDirectory verbosity DistDirLayout{distBuildDirectory}
-                                parentdir pkgid = do
+                                parentdir pkgid uid = do
     distDirExists <- doesDirectoryExist tarballDistDir
     when distDirExists $ do
       debug verbosity $ "Moving '" ++ tarballDistDir ++ "' to '"
@@ -887,7 +890,7 @@ moveTarballShippedDistDirectory verbosity DistDirLayout{distBuildDirectory}
       renameDirectory tarballDistDir targetDistDir
   where
     tarballDistDir = parentdir </> display pkgid </> "dist"
-    targetDistDir  = distBuildDirectory pkgid
+    targetDistDir  = distBuildDirectory uid
 
 
 buildAndInstallUnpackedPackage :: Verbosity
@@ -1065,8 +1068,9 @@ buildInplaceUnpackedPackage verbosity
 
         --TODO: [code cleanup] there is duplication between the distdirlayout and the builddir here
         --      builddir is not enough, we also need the per-package cachedir
+        let uid = installedUnitId pkg
         createDirectoryIfMissingVerbose verbosity False builddir
-        createDirectoryIfMissingVerbose verbosity False (distPackageCacheDirectory pkgid)
+        createDirectoryIfMissingVerbose verbosity False (distPackageCacheDirectory uid)
 
         -- Configure phase
         --
@@ -1132,12 +1136,11 @@ buildInplaceUnpackedPackage verbosity
         return (BuildOk docsResult testsResult mipkg)
 
   where
-    pkgid  = packageId rpkg
     ipkgid = installedPackageId rpkg
 
     isParallelBuild = buildSettingNumJobs >= 2
 
-    packageFileMonitor = newPackageFileMonitor distDirLayout pkgid
+    packageFileMonitor = newPackageFileMonitor distDirLayout ipkgid
 
     whenReConfigure action = case buildStatus of
       BuildStatusConfigure _ -> action