Pass *-options and -pgmc to GHC

Refactor componentGhcOptions for pass *-options to all invoking GHC.

During the refactoring process we needed to add componentGhcOptions
to all Haskell sources. It was also worth add linkGhcOptions
to linkLibrary same as componentGhcOptions to linkExecutable, linkFLib.

Add test for PackageTests/FFI/ForeignOptsCapi to pass cc-options flags to *.h.

Add -pgmc gcc to componentGhcOptions for versions newer then 9.4.

Add more tests like PackageTests/ShowBuildInfo/Complex for -pgmc gcc and -optc-O2,-optcxx-O2,-opta-O2.

Fixes #9801 #4435

Author: zlonast

Cabal/src/Distribution/Simple/GHC.hs

@@ -60,7 +60,6 @@ module Distribution.Simple.GHC
   , hcPkgInfo
   , registerPackage
   , Internal.componentGhcOptions
-  , Internal.componentCcGhcOptions
   , getGhcAppDir
   , getLibDir
   , compilerBuildWay
@@ -825,7 +824,7 @@ libAbiHash verbosity _pkg_descr lbi lib clbi = do
           , ghcOptFPic = toFlag True
           , ghcOptHiSuffix = toFlag "dyn_hi"
           , ghcOptObjSuffix = toFlag "dyn_o"
-          , ghcOptExtra = hcOptions GHC libBi ++ hcSharedOptions GHC libBi
+          , ghcOptExtra = hcSharedOptions GHC libBi
           }
     profArgs =
       vanillaArgs
@@ -837,7 +836,7 @@ libAbiHash verbosity _pkg_descr lbi lib clbi = do
                 (withProfLibDetail lbi)
           , ghcOptHiSuffix = toFlag "p_hi"
           , ghcOptObjSuffix = toFlag "p_o"
-          , ghcOptExtra = hcOptions GHC libBi ++ hcProfOptions GHC libBi
+          , ghcOptExtra = hcProfOptions GHC libBi
           }
     profDynArgs =
       vanillaArgs
@@ -851,7 +850,7 @@ libAbiHash verbosity _pkg_descr lbi lib clbi = do
           , ghcOptFPic = toFlag True
           , ghcOptHiSuffix = toFlag "p_dyn_hi"
           , ghcOptObjSuffix = toFlag "p_dyn_o"
-          , ghcOptExtra = hcOptions GHC libBi ++ hcProfSharedOptions GHC libBi
+          , ghcOptExtra = hcProfSharedOptions GHC libBi
           }
     ghcArgs =
       let (libWays, _, _) = buildWays lbi

Cabal/src/Distribution/Simple/GHC/Build/ExtraSources.hs

@@ -17,9 +17,10 @@ import Distribution.Utils.NubList
 import Distribution.Types.BuildInfo
 import Distribution.Types.Component
 import Distribution.Types.TargetInfo
+import Distribution.Types.Version
 
 import Distribution.Simple.Build.Inputs
-import Distribution.Simple.GHC.Build.Modules
+import Distribution.Simple.BuildWay
 import Distribution.Simple.GHC.Build.Utils
 import Distribution.Simple.LocalBuildInfo
 import Distribution.Simple.Program.Types
@@ -77,7 +78,23 @@ buildCSources
 buildCSources mbMainFile =
   buildExtraSources
     "C Sources"
-    Internal.componentCcGhcOptions
+    ( \verbosity lbi bi clbi odir filename ->
+        (Internal.sourcesGhcOptions verbosity lbi bi clbi odir filename)
+          { -- C++ compiler options: GHC >= 8.10 requires -optcxx, older requires -optc
+            -- we want to be able to support cxx-options and cc-options separately
+            -- https://gitlab.haskell.org/ghc/ghc/-/issues/16477
+            -- see example in cabal-testsuite/PackageTests/FFI/ForeignOptsC
+            ghcOptCxxOptions =
+              Internal.separateGhcOptions
+                (mkVersion [8, 10])
+                (compiler lbi)
+                (Internal.defaultGhcOptCxxOptions lbi bi)
+          , -- there are problems with linking with versions below 9.4,
+            -- that's why we need this replacement for linkGhcOptions
+            -- see example in cabal-testsuite/PackageTests/ShowBuildInfo/Complex
+            ghcOptCcProgram = Internal.defaultGhcOptCcProgram lbi
+          }
+    )
     ( \c -> do
         let cFiles = cSources (componentBuildInfo c)
         case c of
@@ -90,7 +107,23 @@ buildCSources mbMainFile =
 buildCxxSources mbMainFile =
   buildExtraSources
     "C++ Sources"
-    Internal.componentCxxGhcOptions
+    ( \verbosity lbi bi clbi odir filename ->
+        (Internal.sourcesGhcOptions verbosity lbi bi clbi odir filename)
+          { -- C++ compiler options: GHC >= 8.10 requires -optcxx, older requires -optc
+            -- we want to be able to support cxx-options and cc-options separately
+            -- https://gitlab.haskell.org/ghc/ghc/-/issues/16477
+            -- see example in cabal-testsuite/PackageTests/FFI/ForeignOptsCxx
+            ghcOptCcOptions =
+              Internal.separateGhcOptions
+                (mkVersion [8, 10])
+                (compiler lbi)
+                (Internal.defaultGhcOptCcOptions lbi bi)
+          , -- there are problems with linking with versions below 9.4,
+            -- that's why we need this replacement for linkGhcOptions
+            -- see example in cabal-testsuite/PackageTests/ShowBuildInfo/Complex
+            ghcOptCcProgram = Internal.defaultGhcOptCcProgram lbi
+          }
+    )
     ( \c -> do
         let cxxFiles = cxxSources (componentBuildInfo c)
         case c of
@@ -105,7 +138,7 @@ buildJsSources _mbMainFile ghcProg buildTargetDir neededWays verbHandles = do
   let hasJsSupport = hostArch == JavaScript
   buildExtraSources
     "JS Sources"
-    Internal.componentJsGhcOptions
+    Internal.sourcesGhcOptions
     ( \c ->
         if hasJsSupport
           then -- JS files are C-like with GHC's JS backend: they are
@@ -122,12 +155,12 @@ buildJsSources _mbMainFile ghcProg buildTargetDir neededWays verbHandles = do
 buildAsmSources _mbMainFile =
   buildExtraSources
     "Assembler Sources"
-    Internal.componentAsmGhcOptions
+    Internal.sourcesGhcOptions
     (asmSources . componentBuildInfo)
 buildCmmSources _mbMainFile =
   buildExtraSources
     "C-- Sources"
-    Internal.componentCmmGhcOptions
+    Internal.sourcesGhcOptions
     (cmmSources . componentBuildInfo)
 
 -- | Create 'PreBuildComponentRules' for a given type of extra build sources
@@ -145,9 +178,7 @@ buildExtraSources
        -> GhcOptions
      )
   -- ^ Function to determine the @'GhcOptions'@ for the
-  -- invocation of GHC when compiling these extra sources (e.g.
-  -- @'Internal.componentCxxGhcOptions'@,
-  -- @'Internal.componentCmmGhcOptions'@)
+  -- invocation of GHC when compiling these extra sources
   -> (Component -> [SymbolicPath Pkg File])
   -- ^ View the extra sources of a component, typically from
   -- the build info (e.g. @'asmSources'@, @'cSources'@).

Cabal/src/Distribution/Simple/GHC/Build/Link.hs

@@ -122,10 +122,9 @@ linkOrLoadComponent
       linkerOpts rpaths =
         mempty
           { ghcOptLinkOptions =
-              PD.ldOptions bi
-                ++ [ "-static"
-                   | withFullyStaticExe lbi
-                   ]
+              [ "-static"
+              | withFullyStaticExe lbi
+              ]
                 -- Pass extra `ld-options` given
                 -- through to GHC's linker.
                 ++ maybe
@@ -356,36 +355,11 @@ linkLibrary buildTargetDir cleanedExtraLibDirs pkg_descr verbosity runGhcProg li
     -- Right now, instead, we pass the path to each object file.
     ghcBaseLinkArgs :: GhcOptions
     ghcBaseLinkArgs =
-      mempty
-        { -- TODO: This basically duplicates componentGhcOptions.
-          -- I think we want to do the same as we do for executables: re-use the
-          -- base options, and link by module names, not object paths.
-          ghcOptExtra = hcStaticOptions GHC libBi
-        , ghcOptHideAllPackages = toFlag True
-        , ghcOptNoAutoLinkPackages = toFlag True
-        , ghcOptPackageDBs = withPackageDB lbi
-        , ghcOptThisUnitId = case clbi of
-            LibComponentLocalBuildInfo{componentCompatPackageKey = pk} ->
-              toFlag pk
-            _ -> mempty
-        , ghcOptThisComponentId = case clbi of
-            LibComponentLocalBuildInfo
-              { componentInstantiatedWith = insts
-              } ->
-                if null insts
-                  then mempty
-                  else toFlag (componentComponentId clbi)
-            _ -> mempty
-        , ghcOptInstantiatedWith = case clbi of
-            LibComponentLocalBuildInfo
-              { componentInstantiatedWith = insts
-              } ->
-                insts
-            _ -> []
-        , ghcOptPackages =
-            toNubListR $
-              Internal.mkGhcOptPackages mempty clbi
-        }
+      Internal.linkGhcOptions (verbosityLevel verbosity) lbi libBi clbi
+        <> mempty
+          { ghcOptExtra = hcStaticOptions GHC libBi
+          , ghcOptNoAutoLinkPackages = toFlag True
+          }
 
     -- After the relocation lib is created we invoke ghc -shared
     -- with the dependencies spelled out as -package arguments