CodeOutput.lhs 6.32 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
%
% (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
%
\section{Code output phase}

\begin{code}
module CodeOutput( codeOutput ) where

#include "HsVersions.h"

11
#ifndef OMIT_NATIVE_CODEGEN
12 13
import AsmCodeGen	( nativeCodeGen )
#endif
14

15 16 17
#ifdef ILX
import IlxGen		( ilxGen )
#endif
18

19 20 21
import JavaGen		( javaGen )
import qualified PrintJava

22 23
import TyCon		( TyCon )
import Id		( Id )
24
import CoreSyn		( CoreBind )
25
import OccurAnal	( occurAnalyseBinds )
26
import StgSyn		( StgBinding )
27
import AbsCSyn		( AbstractC )
28
import PprAbsC		( dumpRealC, writeRealC )
29
import Module		( Module )
30
import CmdLineOpts
31
import ErrUtils		( dumpIfSet_dyn, showPass )
32
import Outputable
33 34
import CmdLineOpts	( DynFlags, HscLang(..), dopt_OutName )
import TmpFiles		( newTempName )
35
import UniqSupply	( mkSplitUniqSupply )
36

37
import IO		( IOMode(..), hClose, openFile, Handle )
38 39 40
\end{code}


41 42 43 44 45 46
%************************************************************************
%*									*
\subsection{Steering}
%*									*
%************************************************************************

47
\begin{code}
48 49
codeOutput :: DynFlags
	   -> Module
50
	   -> [TyCon]			-- Local tycons
51
	   -> [CoreBind]		-- Core bindings
52
	   -> [(StgBinding,[Id])]	-- The STG program with SRTs
53 54 55
	   -> SDoc 		-- C stubs for foreign exported functions
	   -> SDoc		-- Header file prototype for foreign exported functions
	   -> AbstractC		-- Compiled abstract C
56
	   -> IO (Maybe FilePath, Maybe FilePath)
57 58
codeOutput dflags mod_name tycons core_binds stg_binds 
	   c_code h_code flat_abstractC
59 60 61 62
  = -- You can have C (c_output) or assembly-language (ncg_output),
    -- but not both.  [Allowing for both gives a space leak on
    -- flat_abstractC.  WDP 94/10]

63
    -- Dunno if the above comment is still meaningful now.  JRS 001024.
64

65 66 67 68 69 70 71 72 73 74 75
    do	{ showPass dflags "CodeOutput"
	; let filenm = dopt_OutName dflags 
	; stub_names <- outputForeignStubs dflags c_code h_code
	; case dopt_HscLang dflags of
             HscInterpreted -> return stub_names
             HscAsm         -> outputAsm dflags filenm flat_abstractC
          		       >> return stub_names
             HscC           -> outputC dflags filenm flat_abstractC	
          		       >> return stub_names
             HscJava        -> outputJava dflags filenm mod_name tycons core_binds
          		       >> return stub_names
rrt's avatar
rrt committed
76 77 78
#ifdef ILX
	     HscILX         -> outputIlx mod_name tycons stg_binds
#endif
79
	}
80

81
doOutput :: String -> (Handle -> IO ()) -> IO ()
82 83
doOutput filenm io_action
  = (do	handle <- openFile filenm WriteMode
84 85
	io_action handle
	hClose handle)
86 87
    `catch` (\err -> pprPanic "Failed to open or write code output file" 
			      (text filenm))
88 89 90 91 92 93 94 95 96 97
\end{code}


%************************************************************************
%*									*
\subsection{C}
%*									*
%************************************************************************

\begin{code}
98
outputC dflags filenm flat_absC
99
  = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
100
       doOutput filenm (\ h -> writeRealC h flat_absC)
101 102 103 104 105 106 107 108 109 110
\end{code}


%************************************************************************
%*									*
\subsection{Assembler}
%*									*
%************************************************************************

\begin{code}
111
outputAsm dflags filenm flat_absC
112

113
#ifndef OMIT_NATIVE_CODEGEN
114

115
  = do ncg_uniqs <- mkSplitUniqSupply 'n'
116 117
       let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen" 
				        nativeCodeGen flat_absC ncg_uniqs
118
       dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
119
       dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" ncg_output_d
120
       _scc_ "OutputAsm" doOutput filenm ( \f -> printForAsm f ncg_output_d)
121 122 123 124
  where

#else /* OMIT_NATIVE_CODEGEN */

125 126
  = pprPanic "This compiler was built without a native code generator"
	     (text "Use -fvia-C instead")
127 128 129

#endif
\end{code}
130 131


132 133 134 135 136
%************************************************************************
%*									*
\subsection{Java}
%*									*
%************************************************************************
137

138
\begin{code}
139
outputJava dflags filenm mod tycons core_binds
140
  = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
141
	-- User style printing for now to keep indentation
142
  where
143 144 145
    occ_anal_binds = occurAnalyseBinds core_binds
	-- Make sure we have up to date dead-var information
    java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
146 147
    pp_java   = PrintJava.compilationUnit java_code
\end{code}
148

149

rrt's avatar
rrt committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
%************************************************************************
%*									*
\subsection{Ilx}
%*									*
%************************************************************************

\begin{code}
#ifdef ILX
outputIlx mod tycons stg_binds
  =  doOutput (\ f -> printForC f pp_ilx)
  where
    pp_ilx = ilxGen mod tycons stg_binds
#endif
\end{code}


166 167 168 169 170 171 172
%************************************************************************
%*									*
\subsection{Foreign import/export}
%*									*
%************************************************************************

\begin{code}
173
outputForeignStubs dflags c_code h_code
174
  = do
175
	dumpIfSet_dyn dflags Opt_D_dump_foreign
176 177 178 179
                      "Foreign export header file" stub_h_output_d

	maybe_stub_h_file
           <- outputForeignStubs_help True{-.h output-} stub_h_output_w
180

181
	dumpIfSet_dyn dflags Opt_D_dump_foreign
182 183 184 185 186 187
                      "Foreign export stubs" stub_c_output_d

        maybe_stub_c_file
           <- outputForeignStubs_help False{-not .h-} stub_c_output_w

        return (maybe_stub_h_file, maybe_stub_c_file)
188
  where
189 190 191 192 193 194 195 196 197
    -- C stubs for "foreign export"ed functions.
    stub_c_output_d = pprCode CStyle c_code
    stub_c_output_w = showSDoc stub_c_output_d

    -- Header file protos for "foreign export"ed functions.
    stub_h_output_d = pprCode CStyle h_code
    stub_h_output_w = showSDoc stub_h_output_d


198 199 200
-- Don't use doOutput for dumping the f. export stubs
-- since it is more than likely that the stubs file will
-- turn out to be empty, in which case no file should be created.
201 202
outputForeignStubs_help is_header ""      = return Nothing
outputForeignStubs_help is_header doc_str 
203 204 205
   = do fname <- newTempName suffix
        writeFile fname (include_prefix ++ doc_str)
        return (Just fname)
206 207 208 209 210
  where
    suffix
       | is_header   = "h_stub"
       | otherwise   = "c_stub"
    include_prefix
211
       | is_header   = "#include \"HsFFI.h\"\n"
212
       | otherwise   = "#include \"RtsAPI.h\"\n"
213 214
\end{code}