compiler/main/CodeOutput.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
   3 %
   4 \section{Code output phase}
   5
   6 \begin{code}
   7 module CodeOutput( codeOutput, outputForeignStubs ) where
   8
   9 #include "HsVersions.h"
  10
  11 import AsmCodeGen ( nativeCodeGen )
  12 import LlvmCodeGen ( llvmCodeGen )
  13
  14 import UniqSupply       ( mkSplitUniqSupply )
  15
  16 #ifdef JAVA
  17 import JavaGen          ( javaGen )
  18 import qualified PrintJava
  19 import OccurAnal        ( occurAnalyseBinds )
  20 #endif
  21
  22 import Finder           ( mkStubPaths )
  23 import PprC             ( writeCs )
  24 import CmmLint          ( cmmLint )
  25 import Packages
  26 import Util
  27 import OldCmm           ( RawCmm )
  28 import HscTypes
  29 import DynFlags
  30 import Config
  31 import SysTools
  32
  33 import ErrUtils         ( dumpIfSet_dyn, showPass, ghcExit )
  34 import Outputable
  35 import Module
  36 import Maybes           ( firstJusts )
  37
  38 import Control.Exception
  39 import Control.Monad
  40 import System.Directory
  41 import System.FilePath
  42 import System.IO
  43 \end{code}
  44
  45 %************************************************************************
  46 %*                                                                      *
  47 \subsection{Steering}
  48 %*                                                                      *
  49 %************************************************************************
  50
  51 \begin{code}
  52 codeOutput :: DynFlags
  53            -> Module
  54            -> ModLocation
  55            -> ForeignStubs
  56            -> [PackageId]
  57            -> [RawCmm]                  -- Compiled C--
  58            -> IO (Bool{-stub_h_exists-}, Maybe FilePath{-stub_c_exists-})
  59
  60 codeOutput dflags this_mod location foreign_stubs pkg_deps flat_abstractC
  61   =
  62     -- You can have C (c_output) or assembly-language (ncg_output),
  63     -- but not both.  [Allowing for both gives a space leak on
  64     -- flat_abstractC.  WDP 94/10]
  65
  66     -- Dunno if the above comment is still meaningful now.  JRS 001024.
  67
  68     do  { when (dopt Opt_DoCmmLinting dflags) $ do
  69                 { showPass dflags "CmmLint"
  70                 ; let lints = map cmmLint flat_abstractC
  71                 ; case firstJusts lints of
  72                         Just err -> do { printDump err
  73                                        ; ghcExit dflags 1
  74                                        }
  75                         Nothing  -> return ()
  76                 }
  77
  78         ; showPass dflags "CodeOutput"
  79         ; let filenm = hscOutName dflags
  80         ; stubs_exist <- outputForeignStubs dflags this_mod location foreign_stubs
  81         ; case hscTarget dflags of {
  82              HscInterpreted -> return ();
  83              HscAsm         -> outputAsm dflags filenm flat_abstractC;
  84              HscC           -> outputC dflags filenm flat_abstractC pkg_deps;
  85              HscLlvm        -> outputLlvm dflags filenm flat_abstractC;
  86              HscJava        ->
  87 #ifdef JAVA
  88                                outputJava dflags filenm mod_name tycons core_binds;
  89 #else
  90                                panic "Java support not compiled into this ghc";
  91 #endif
  92              HscNothing     -> panic "codeOutput: HscNothing"
  93           }
  94         ; return stubs_exist
  95         }
  96
  97 doOutput :: String -> (Handle -> IO ()) -> IO ()
  98 doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
  99 \end{code}
 100
 101
 102 %************************************************************************
 103 %*                                                                      *
 104 \subsection{C}
 105 %*                                                                      *
 106 %************************************************************************
 107
 108 \begin{code}
 109 outputC :: DynFlags
 110         -> FilePath
 111         -> [RawCmm]
 112         -> [PackageId]
 113         -> IO ()
 114
 115 outputC dflags filenm flat_absC packages
 116   = do
 117        -- figure out which header files to #include in the generated .hc file:
 118        --
 119        --   * extra_includes from packages
 120        --   * -#include options from the cmdline and OPTIONS pragmas
 121        --   * the _stub.h file, if there is one.
 122        --
 123        let rts = getPackageDetails (pkgState dflags) rtsPackageId
 124
 125        let cc_injects = unlines (map mk_include (includes rts))
 126            mk_include h_file =
 127             case h_file of
 128                '"':_{-"-} -> "#include "++h_file
 129                '<':_      -> "#include "++h_file
 130                _          -> "#include \""++h_file++"\""
 131
 132        pkg_configs <- getPreloadPackagesAnd dflags packages
 133        let pkg_names = map (display.sourcePackageId) pkg_configs
 134
 135        doOutput filenm $ \ h -> do
 136           hPutStr h ("/* GHC_PACKAGES " ++ unwords pkg_names ++ "\n*/\n")
 137           hPutStr h cc_injects
 138           writeCs dflags h flat_absC
 139 \end{code}
 140
 141
 142 %************************************************************************
 143 %*                                                                      *
 144 \subsection{Assembler}
 145 %*                                                                      *
 146 %************************************************************************
 147
 148 \begin{code}
 149 outputAsm :: DynFlags -> FilePath -> [RawCmm] -> IO ()
 150 outputAsm dflags filenm flat_absC
 151  | cGhcWithNativeCodeGen == "YES"
 152   = do ncg_uniqs <- mkSplitUniqSupply 'n'
 153
 154        {-# SCC "OutputAsm" #-} doOutput filenm $
 155            \f -> {-# SCC "NativeCodeGen" #-}
 156                  nativeCodeGen dflags f ncg_uniqs flat_absC
 157
 158  | otherwise
 159   = pprPanic "This compiler was built without a native code generator"
 160              (text "Use -fvia-C instead")
 161 \end{code}
 162
 163
 164 %************************************************************************
 165 %*                                                                      *
 166 \subsection{LLVM}
 167 %*                                                                      *
 168 %************************************************************************
 169
 170 \begin{code}
 171 outputLlvm :: DynFlags -> FilePath -> [RawCmm] -> IO ()
 172 outputLlvm dflags filenm flat_absC
 173   = do ncg_uniqs <- mkSplitUniqSupply 'n'
 174        doOutput filenm $ \f -> llvmCodeGen dflags f ncg_uniqs flat_absC
 175 \end{code}
 176
 177
 178 %************************************************************************
 179 %*                                                                      *
 180 \subsection{Java}
 181 %*                                                                      *
 182 %************************************************************************
 183
 184 \begin{code}
 185 #ifdef JAVA
 186 outputJava dflags filenm mod tycons core_binds
 187   = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
 188         -- User style printing for now to keep indentation
 189   where
 190     occ_anal_binds = occurAnalyseBinds core_binds
 191         -- Make sure we have up to date dead-var information
 192     java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
 193     pp_java   = PrintJava.compilationUnit java_code
 194 #endif
 195 \end{code}
 196
 197
 198 %************************************************************************
 199 %*                                                                      *
 200 \subsection{Foreign import/export}
 201 %*                                                                      *
 202 %************************************************************************
 203
 204 \begin{code}
 205 outputForeignStubs :: DynFlags -> Module -> ModLocation -> ForeignStubs
 206                    -> IO (Bool,         -- Header file created
 207                           Maybe FilePath) -- C file created
 208 outputForeignStubs dflags mod location stubs
 209  = do
 210    let stub_h = mkStubPaths dflags (moduleName mod) location
 211    stub_c <- newTempName dflags "c"
 212
 213    case stubs of
 214      NoStubs -> do
 215         -- When compiling External Core files, may need to use stub
 216         -- files from a previous compilation
 217         stub_h_exists <- doesFileExist stub_h
 218         return (stub_h_exists, Nothing)
 219
 220      ForeignStubs h_code c_code -> do
 221         let
 222             stub_c_output_d = pprCode CStyle c_code
 223             stub_c_output_w = showSDoc stub_c_output_d
 224
 225             -- Header file protos for "foreign export"ed functions.
 226             stub_h_output_d = pprCode CStyle h_code
 227             stub_h_output_w = showSDoc stub_h_output_d
 228         -- in
 229
 230         createDirectoryHierarchy (takeDirectory stub_h)
 231
 232         dumpIfSet_dyn dflags Opt_D_dump_foreign
 233                       "Foreign export header file" stub_h_output_d
 234
 235         -- we need the #includes from the rts package for the stub files
 236         let rts_includes =
 237                let rts_pkg = getPackageDetails (pkgState dflags) rtsPackageId in
 238                concatMap mk_include (includes rts_pkg)
 239             mk_include i = "#include \"" ++ i ++ "\"\n"
 240
 241             -- wrapper code mentions the ffi_arg type, which comes from ffi.h
 242             ffi_includes | cLibFFI   = "#include \"ffi.h\"\n"
 243                          | otherwise = ""
 244
 245         stub_h_file_exists
 246            <- outputForeignStubs_help stub_h stub_h_output_w
 247                 ("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
 248
 249         dumpIfSet_dyn dflags Opt_D_dump_foreign
 250                       "Foreign export stubs" stub_c_output_d
 251
 252         stub_c_file_exists
 253            <- outputForeignStubs_help stub_c stub_c_output_w
 254                 ("#define IN_STG_CODE 0\n" ++
 255                  "#include \"Rts.h\"\n" ++
 256                  rts_includes ++
 257                  ffi_includes ++
 258                  cplusplus_hdr)
 259                  cplusplus_ftr
 260            -- We're adding the default hc_header to the stub file, but this
 261            -- isn't really HC code, so we need to define IN_STG_CODE==0 to
 262            -- avoid the register variables etc. being enabled.
 263
 264         return (stub_h_file_exists, if stub_c_file_exists
 265                                        then Just stub_c
 266                                        else Nothing )
 267  where
 268    cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
 269    cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
 270
 271
 272 -- Don't use doOutput for dumping the f. export stubs
 273 -- since it is more than likely that the stubs file will
 274 -- turn out to be empty, in which case no file should be created.
 275 outputForeignStubs_help :: FilePath -> String -> String -> String -> IO Bool
 276 outputForeignStubs_help _fname ""      _header _footer = return False
 277 outputForeignStubs_help fname doc_str header footer
 278    = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")
 279         return True
 280 \end{code}
 281