ghc/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 ) where
   8
   9 #include "HsVersions.h"
  10
  11 #ifndef OMIT_NATIVE_CODEGEN
  12 import UniqSupply       ( mkSplitUniqSupply )
  13 import AsmCodeGen       ( nativeCodeGen )
  14 #endif
  15
  16 #ifdef ILX
  17 import IlxGen           ( ilxGen )
  18 #endif
  19
  20 import JavaGen          ( javaGen )
  21 import qualified PrintJava
  22
  23 import DriverState      ( v_HCHeader )
  24 import TyCon            ( TyCon )
  25 import Id               ( Id )
  26 import CoreSyn          ( CoreBind )
  27 import OccurAnal        ( occurAnalyseBinds )
  28 import StgSyn           ( StgBinding )
  29 import AbsCSyn          ( AbstractC )
  30 import PprAbsC          ( dumpRealC, writeRealC )
  31 import Module           ( Module )
  32 import CmdLineOpts
  33 import ErrUtils         ( dumpIfSet_dyn, showPass )
  34 import Outputable
  35 import CmdLineOpts      ( DynFlags, HscLang(..), dopt_OutName )
  36 import TmpFiles         ( newTempName )
  37
  38 import IOExts
  39 import IO
  40 \end{code}
  41
  42
  43 %************************************************************************
  44 %*                                                                      *
  45 \subsection{Steering}
  46 %*                                                                      *
  47 %************************************************************************
  48
  49 \begin{code}
  50 codeOutput :: DynFlags
  51            -> Module
  52            -> [TyCon]                   -- Local tycons
  53            -> [CoreBind]                -- Core bindings
  54            -> [(StgBinding,[Id])]       -- The STG program with SRTs
  55            -> SDoc              -- C stubs for foreign exported functions
  56            -> SDoc              -- Header file prototype for foreign exported functions
  57            -> AbstractC         -- Compiled abstract C
  58            -> IO (Maybe FilePath, Maybe FilePath)
  59 codeOutput dflags mod_name tycons core_binds stg_binds
  60            c_code h_code flat_abstractC
  61   = -- You can have C (c_output) or assembly-language (ncg_output),
  62     -- but not both.  [Allowing for both gives a space leak on
  63     -- flat_abstractC.  WDP 94/10]
  64
  65     -- Dunno if the above comment is still meaningful now.  JRS 001024.
  66
  67     do  { showPass dflags "CodeOutput"
  68         ; let filenm = dopt_OutName dflags
  69         ; stub_names <- outputForeignStubs dflags c_code h_code
  70         ; case dopt_HscLang dflags of
  71              HscInterpreted -> return stub_names
  72              HscAsm         -> outputAsm dflags filenm flat_abstractC
  73                                >> return stub_names
  74              HscC           -> outputC dflags filenm flat_abstractC stub_names
  75                                >> return stub_names
  76              HscJava        -> outputJava dflags filenm mod_name tycons core_binds
  77                                >> return stub_names
  78 #ifdef ILX
  79              HscILX         -> outputIlx dflags filenm mod_name tycons stg_binds
  80                                >> return stub_names
  81 #endif
  82         }
  83
  84 doOutput :: String -> (Handle -> IO ()) -> IO ()
  85 doOutput filenm io_action
  86   = (do handle <- openFile filenm WriteMode
  87         io_action handle
  88         hClose handle)
  89     `catch` (\err -> pprPanic "Failed to open or write code output file"
  90                               (text filenm))
  91 \end{code}
  92
  93
  94 %************************************************************************
  95 %*                                                                      *
  96 \subsection{C}
  97 %*                                                                      *
  98 %************************************************************************
  99
 100 \begin{code}
 101 outputC dflags filenm flat_absC (maybe_stub_h, _)
 102   = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
 103        header <- readIORef v_HCHeader
 104        doOutput filenm $ \ h -> do
 105           hPutStr h header
 106           case maybe_stub_h of
 107                 Nothing       -> return ()
 108                 Just filename -> hPutStrLn h ("#include \"" ++ filename ++ "\"")
 109           writeRealC h flat_absC
 110 \end{code}
 111
 112
 113 %************************************************************************
 114 %*                                                                      *
 115 \subsection{Assembler}
 116 %*                                                                      *
 117 %************************************************************************
 118
 119 \begin{code}
 120 outputAsm dflags filenm flat_absC
 121
 122 #ifndef OMIT_NATIVE_CODEGEN
 123
 124   = do ncg_uniqs <- mkSplitUniqSupply 'n'
 125        let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen"
 126                                         nativeCodeGen flat_absC ncg_uniqs
 127        dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
 128        dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" ncg_output_d
 129        _scc_ "OutputAsm" doOutput filenm ( \f -> printForAsm f ncg_output_d)
 130   where
 131
 132 #else /* OMIT_NATIVE_CODEGEN */
 133
 134   = pprPanic "This compiler was built without a native code generator"
 135              (text "Use -fvia-C instead")
 136
 137 #endif
 138 \end{code}
 139
 140
 141 %************************************************************************
 142 %*                                                                      *
 143 \subsection{Java}
 144 %*                                                                      *
 145 %************************************************************************
 146
 147 \begin{code}
 148 outputJava dflags filenm mod tycons core_binds
 149   = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
 150         -- User style printing for now to keep indentation
 151   where
 152     occ_anal_binds = occurAnalyseBinds core_binds
 153         -- Make sure we have up to date dead-var information
 154     java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
 155     pp_java   = PrintJava.compilationUnit java_code
 156 \end{code}
 157
 158
 159 %************************************************************************
 160 %*                                                                      *
 161 \subsection{Ilx}
 162 %*                                                                      *
 163 %************************************************************************
 164
 165 \begin{code}
 166 #ifdef ILX
 167 outputIlx dflags filename mod tycons stg_binds
 168   =  doOutput filename (\ f -> printForC f pp_ilx)
 169   where
 170     pp_ilx = ilxGen mod tycons stg_binds
 171 #endif
 172 \end{code}
 173
 174
 175 %************************************************************************
 176 %*                                                                      *
 177 \subsection{Foreign import/export}
 178 %*                                                                      *
 179 %************************************************************************
 180
 181 \begin{code}
 182 outputForeignStubs dflags c_code h_code
 183   = do
 184         dumpIfSet_dyn dflags Opt_D_dump_foreign
 185                       "Foreign export header file" stub_h_output_d
 186
 187         maybe_stub_h_file
 188            <- outputForeignStubs_help True{-.h output-} stub_h_output_w
 189
 190         dumpIfSet_dyn dflags Opt_D_dump_foreign
 191                       "Foreign export stubs" stub_c_output_d
 192
 193         maybe_stub_c_file
 194            <- outputForeignStubs_help False{-not .h-} stub_c_output_w
 195
 196         return (maybe_stub_h_file, maybe_stub_c_file)
 197   where
 198     -- C stubs for "foreign export"ed functions.
 199     stub_c_output_d = pprCode CStyle c_code
 200     stub_c_output_w = showSDoc stub_c_output_d
 201
 202     -- Header file protos for "foreign export"ed functions.
 203     stub_h_output_d = pprCode CStyle h_code
 204     stub_h_output_w = showSDoc stub_h_output_d
 205
 206
 207 -- Don't use doOutput for dumping the f. export stubs
 208 -- since it is more than likely that the stubs file will
 209 -- turn out to be empty, in which case no file should be created.
 210 outputForeignStubs_help is_header ""      = return Nothing
 211 outputForeignStubs_help is_header doc_str
 212    = do fname <- newTempName suffix
 213         writeFile fname (include_prefix ++ doc_str)
 214         return (Just fname)
 215   where
 216     suffix
 217        | is_header   = "h_stub"
 218        | otherwise   = "c_stub"
 219     include_prefix
 220        | is_header   = "#include \"HsFFI.h\"\n"
 221        | otherwise   = "#include \"RtsAPI.h\"\n"
 222 \end{code}
 223