Strip.hs

{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE RankNTypes #-}

-----------------------------------------------------------------------------

-- |
-- Module      :  Distribution.Simple.Program.Strip
--
-- Maintainer  :  cabal-devel@haskell.org
-- Portability :  portable
--
-- This module provides an library interface to the @strip@ program.
module Distribution.Simple.Program.Strip (stripLib, stripExe)
where

import Distribution.Compat.Prelude
import Prelude ()

import Distribution.Simple.Program
import Distribution.Simple.Utils
import Distribution.System
import Distribution.Verbosity
import Distribution.Version

import System.FilePath (takeBaseName)

runStrip :: Verbosity -> ProgramDb -> FilePath -> [String] -> IO ()
runStrip verbosity progDb path args =
  case lookupProgram stripProgram progDb of
    Just strip -> runProgram verbosity strip (args ++ [path])
    Nothing ->
      unless (buildOS == Windows) $
        -- Don't bother warning on windows, we don't expect them to
        -- have the strip program anyway.
        warn verbosity $
          "Unable to strip executable or library '"
            ++ (takeBaseName path)
            ++ "' (missing the 'strip' program)"

stripExe :: Verbosity -> Platform -> ProgramDb -> FilePath -> IO ()
stripExe verbosity (Platform _arch os) progdb path =
  runStrip verbosity progdb path args
  where
    args = case os of
      OSX -> ["-x"] -- By default, stripping the ghc binary on at least
      -- some OS X installations causes:
      --     HSbase-3.0.o: unknown symbol `_environ'"
      -- The -x flag fixes that.
      _ -> []

stripLib :: Verbosity -> Platform -> ProgramDb -> FilePath -> IO ()
stripLib verbosity (Platform arch os) progdb path = do
  case os of
    OSX ->
      -- '--strip-unneeded' is not supported on OS X, iOS, AIX, or
      -- Solaris. See #1630.
      return ()
    IOS -> return ()
    AIX -> return ()
    Solaris -> return ()
    OpenBSD ->
      -- '--strip-unneeded' sometimes strips too much on OpenBSD.
      -- -- See https://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/ports/lang/ghc/patches/patch-libraries_Cabal_Cabal_Distribution_Simple_Program_Strip_hs
      return ()
    Windows ->
      -- Stripping triggers a bug in 'strip.exe' for
      -- libraries with lots identically named modules. See
      -- #1784.
      return ()
    Linux
      | arch == I386 ->
          -- Versions of 'strip' on 32-bit Linux older than 2.18 are
          -- broken. See #2339.
          let okVersion = orLaterVersion (mkVersion [2, 18])
           in case programVersion =<< lookupProgram stripProgram progdb of
                Just v
                  | withinRange v okVersion ->
                      runStrip verbosity progdb path args
                _ ->
                  warn verbosity $
                    "Unable to strip library '"
                      ++ (takeBaseName path)
                      ++ "' (version of 'strip' too old; "
                      ++ "requires >= 2.18 on 32-bit Linux)"
    _ -> runStrip verbosity progdb path args
  where
    args = ["--strip-unneeded"]