GitLab

David Eichmann pushed to branch wip/davide/hadrian_avoid_response_files at Glasgow Haskell Compiler / GHC

Commits:

ac4102d3

by David Eichmann at 2026-06-01T10:43:44+01:00

Hadrian: disable response files for GHC/Haddock builders on non-Windows

This makes debugging build errors easier on non-windows hosts.
See issue #27230

2 changed files:

hadrian/src/Builder.hs
hadrian/src/Hadrian/Utilities.hs

Changes:

hadrian/src/Builder.hs

@@ -39,7 +39,6 @@ import Packages
  import GHC.IO.Encoding (getFileSystemEncoding)
  import qualified Data.ByteString as BS
  import qualified GHC.Foreign as GHC
 -import GHC.ResponseFile
  import GHC.Toolchain (Target(..))
  import qualified GHC.Toolchain as Toolchain
@@ -346,7 +345,15 @@ instance H.Builder Builder where
                  Haddock BuildPackage -> runHaddock path buildArgs buildInputs
 -                Ghc _ _ -> runGhcWithResponse path buildArgs buildInputs buildOptions
 +                Ghc _ _ ->
 +                  -- Use a response file for ghc invocations to avoid issues with command line
 +                  -- size limit on Windows (#26637).
 +                  -- NB: we can't put the buildArgs in a response file, because some flags require
 +                  -- empty arguments (such as the -dep-suffix flag), but that isn't supported
 +                  -- yet due to #26560.
 +                  withResponseFileOnWindows
 +                    (\buildInputs' -> cmd [path] buildArgs buildInputs' buildOptions)
 +                    buildInputs
                  HsCpp    -> captureStdout
@@ -380,29 +387,15 @@ instance H.Builder Builder where
                  _  -> cmd' [path] buildArgs buildOptions
 --- | Invoke @haddock@ given a path to it and a list of arguments. The arguments
 --- are passed in a response file.
 +-- | Invoke @haddock@ given a path to it and a list of arguments. On windows,
 +-- the input file arguments are passed as a response file.
  runHaddock :: FilePath    -- ^ path to @haddock@
        -> [String]
        -> [FilePath]  -- ^ input file paths
        -> Action ()
 -runHaddock haddockPath flagArgs fileInputs = withResponseFile $ \tmp -> do
 -    writeFile' tmp $ escapeArgs fileInputs
 -    cmd [haddockPath] flagArgs ('@' : tmp)
+-
 --- | Use a response file for ghc invocations to avoid issues with command line
 --- size limit on Windows (#26637).
 -runGhcWithResponse :: FilePath -- ^ Path to ghc
 -  -> [String] -- ^ Arguments passed on the command line
 -  -> [FilePath] -- ^ Input file paths (passed via response file)
 -  -> [CmdOption]
 -  -> Action ()
 -runGhcWithResponse ghcPath buildArgs buildInputs buildOptions = withResponseFile $ \tmp -> do
 -  -- We can't put the buildArgs in a response file, because some flags require
 -  -- empty arguments (such as the -dep-suffix flag), but that isn't supported
 -  -- yet due to #26560.
 -  writeFile' tmp (escapeArgs buildInputs)
 -  cmd [ghcPath] buildArgs ('@' : tmp) buildOptions
 +runHaddock haddockPath flagArgs fileInputs = withResponseFileOnWindows
 +  (cmd [haddockPath] flagArgs)
 +  fileInputs
  -- TODO: Some builders are required only on certain platforms. For example,
  -- 'Objdump' is only required on OpenBSD and AIX. Add support for platform

hadrian/src/Hadrian/Utilities.hs

@@ -14,7 +14,7 @@ module Hadrian.Utilities (
      -- * Paths
      BuildRoot (..), buildRoot, buildRootRules, isGeneratedSource,
 -    KeepResponseFiles (..), keepResponseFiles, withResponseFile,
 +    KeepResponseFiles (..), keepResponseFiles, withResponseFile, withResponseFileOnWindows,
      -- * File system operations
      copyFile, copyFileUntracked, createFileLink, fixFile,
@@ -48,8 +48,11 @@ import Data.Typeable (TypeRep, typeOf)
  import Development.Shake hiding (Normal)
  import Development.Shake.Classes
  import Development.Shake.FilePath
 +import GHC.ResponseFile (escapeArgs)
  import System.Environment (lookupEnv)
 +import System.Info.Extra (isWindows)
  import System.IO (hClose, openTempFile)
 +import System.IO.Error (isPermissionError)
  import qualified Data.ByteString        as BS
  import qualified Control.Exception.Base as IO
@@ -57,8 +60,7 @@ import qualified Data.HashMap.Strict    as Map
  import qualified System.Directory.Extra as IO
  import qualified System.Info.Extra      as IO
  import qualified System.IO              as IO
 -import System.IO.Error (isPermissionError)
 -import qualified System.FilePath.Posix as Posix
 +import qualified System.FilePath.Posix  as Posix
  -- | Extract a value from a singleton list, or terminate with an error message
  -- if the list does not contain exactly one value.
@@ -328,6 +330,21 @@ keepResponseFiles = do
      KeepResponseFiles keep <- userSetting (KeepResponseFiles False)
      return keep
 +-- | Run an action either with command arguments direcly or by, on Windows,
 +-- placing those arguments into a response file escaped with @GHC.ResponseFile.escapeArgs@.
 +--
 +-- With @--keep-response-files@, the file is left on disk (if used)
 +withResponseFileOnWindows ::
 +    ([String] -> Action a)  -- ^ Action to perform given arguments (of the form @["\@reponseFilePath"]@ on Windows)
 +    -> [String]             -- ^ Command arguments
 +    -> Action a
 +withResponseFileOnWindows action commandArgs = do
 +    if isWindows
 +        then withResponseFile $ \tmp -> do
 +                writeFile' tmp (escapeArgs commandArgs)
 +                action ['@' : tmp]
 +        else action commandArgs
++
  -- | Run an action with a response file path.
  --
  -- With @--keep-response-files@, the file is left on disk.