CodeOutput.lhs 6.81 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
import UniqSupply	( mkSplitUniqSupply )
13 14
import AsmCodeGen	( nativeCodeGen )
#endif
15

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

20 21 22
import JavaGen		( javaGen )
import qualified PrintJava

23
import DriverState	( v_HCHeader )
24 25
import TyCon		( TyCon )
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

37
import IOExts
38
import Monad		( when )
39
import IO
40 41 42
\end{code}


43 44 45 46 47 48
%************************************************************************
%*									*
\subsection{Steering}
%*									*
%************************************************************************

49
\begin{code}
50 51
codeOutput :: DynFlags
	   -> Module
52
	   -> [TyCon]			-- Local tycons
53
	   -> [CoreBind]		-- Core bindings
54
	   -> [(StgBinding,[Id])]	-- The STG program with SRTs
55 56 57
	   -> SDoc 		-- C stubs for foreign exported functions
	   -> SDoc		-- Header file prototype for foreign exported functions
	   -> AbstractC		-- Compiled abstract C
58
	   -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
59 60
codeOutput dflags mod_name tycons core_binds stg_binds 
	   c_code h_code flat_abstractC
61 62 63 64
  = -- 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]

65
    -- Dunno if the above comment is still meaningful now.  JRS 001024.
66

67 68 69 70 71 72 73
    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
74
             HscC           -> outputC dflags filenm flat_abstractC stub_names
75 76 77
          		       >> return stub_names
             HscJava        -> outputJava dflags filenm mod_name tycons core_binds
          		       >> return stub_names
78
	     HscILX         -> 
rrt's avatar
rrt committed
79
#ifdef ILX
80
	                       outputIlx dflags filenm mod_name tycons stg_binds
81
			       >> return stub_names
82 83
#else
                               panic "ILX support not compiled into this ghc"
rrt's avatar
rrt committed
84
#endif
85
	}
86

87
doOutput :: String -> (Handle -> IO ()) -> IO ()
88
doOutput filenm io_action
89
  = (do	handle <- openFile filenm WriteMode
90 91
	io_action handle
	hClose handle)
92 93
    `catch` (\err -> pprPanic "Failed to open or write code output file" 
			      (text filenm))
94 95 96 97 98 99 100 101 102 103
\end{code}


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

\begin{code}
104
outputC dflags filenm flat_absC (stub_h_exists, _)
105
  = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
106 107 108
       header <- readIORef v_HCHeader
       doOutput filenm $ \ h -> do
	  hPutStr h header
109 110
	  when stub_h_exists $ 
	     hPutStrLn h ("#include \"" ++ (hscStubHOutName dflags) ++ "\"")
111
	  writeRealC h flat_absC
112 113 114 115 116 117 118 119 120 121
\end{code}


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

\begin{code}
122
outputAsm dflags filenm flat_absC
123

124
#ifndef OMIT_NATIVE_CODEGEN
125

126
  = do ncg_uniqs <- mkSplitUniqSupply 'n'
127 128
       let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen" 
				        nativeCodeGen flat_absC ncg_uniqs
129
       dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
130
       dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" ncg_output_d
131
       _scc_ "OutputAsm" doOutput filenm ( \f -> printForAsm f ncg_output_d)
132 133 134 135
  where

#else /* OMIT_NATIVE_CODEGEN */

136 137
  = pprPanic "This compiler was built without a native code generator"
	     (text "Use -fvia-C instead")
138 139 140

#endif
\end{code}
141 142


143 144 145 146 147
%************************************************************************
%*									*
\subsection{Java}
%*									*
%************************************************************************
148

149
\begin{code}
150
outputJava dflags filenm mod tycons core_binds
151
  = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
152
	-- User style printing for now to keep indentation
153
  where
154 155 156
    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
157 158
    pp_java   = PrintJava.compilationUnit java_code
\end{code}
159

160

rrt's avatar
rrt committed
161 162 163 164 165 166 167 168
%************************************************************************
%*									*
\subsection{Ilx}
%*									*
%************************************************************************

\begin{code}
#ifdef ILX
169 170
outputIlx dflags filename mod tycons stg_binds
  =  doOutput filename (\ f -> printForC f pp_ilx)
rrt's avatar
rrt committed
171 172 173 174 175 176
  where
    pp_ilx = ilxGen mod tycons stg_binds
#endif
\end{code}


177 178 179 180 181 182 183
%************************************************************************
%*									*
\subsection{Foreign import/export}
%*									*
%************************************************************************

\begin{code}
184
outputForeignStubs dflags c_code h_code
185
  = do
186
	dumpIfSet_dyn dflags Opt_D_dump_foreign
187 188
                      "Foreign export header file" stub_h_output_d

189 190 191
	stub_h_file_exists
           <- outputForeignStubs_help (hscStubHOutName dflags) stub_h_output_w
		"#include \"HsFFI.h\"\n"
192

193
	dumpIfSet_dyn dflags Opt_D_dump_foreign
194 195
                      "Foreign export stubs" stub_c_output_d

196
        hc_header <- readIORef v_HCHeader
197

198 199
	stub_c_file_exists
           <- outputForeignStubs_help (hscStubCOutName dflags) stub_c_output_w
200 201 202 203 204 205
		("#define IN_STG_CODE 0\n" ++ 
		 hc_header ++
		 "#include \"RtsAPI.h\"\n")
	   -- we're adding the default hc_header to the stub file, but this
	   -- isn't really HC code, so we need to define IN_STG_CODE==0 to
	   -- avoid the register variables etc. being enabled.
206 207

        return (stub_h_file_exists, stub_c_file_exists)
208
  where
209 210 211 212 213 214 215 216 217
    -- 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


218 219 220
-- 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.
221 222
outputForeignStubs_help fname "" injects     = return False
outputForeignStubs_help fname doc_str injects
sof's avatar
sof committed
223
   = do writeFile fname (injects ++ doc_str ++ "\n")
224
        return True
225 226
\end{code}