CodeOutput.lhs 7.16 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
#ifdef JAVA
21 22
import JavaGen		( javaGen )
import qualified PrintJava
23
#endif
24

25
import DriverState	( v_HCHeader )
26 27
import TyCon		( TyCon )
import Id		( Id )
28
import CoreSyn		( CoreBind )
29
import OccurAnal	( occurAnalyseBinds )
30
import StgSyn		( StgBinding )
31
import AbsCSyn		( AbstractC )
32
import PprAbsC		( dumpRealC, writeRealC )
33
import Module		( Module )
34
import CmdLineOpts
35
import ErrUtils		( dumpIfSet_dyn, showPass )
36
import Outputable
37
import CmdLineOpts	( DynFlags, HscLang(..), dopt_OutName )
38

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


45 46 47 48 49 50
%************************************************************************
%*									*
\subsection{Steering}
%*									*
%************************************************************************

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

67
    -- Dunno if the above comment is still meaningful now.  JRS 001024.
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
76
             HscC           -> outputC dflags filenm flat_abstractC stub_names
77
          		       >> return stub_names
78 79 80
             HscJava        -> 
#ifdef JAVA
			       outputJava dflags filenm mod_name tycons core_binds
81
          		       >> return stub_names
82 83 84
#else
                               panic "Java support not compiled into this ghc"
#endif
85
	     HscILX         -> 
rrt's avatar
rrt committed
86
#ifdef ILX
87
	                       outputIlx dflags filenm mod_name tycons stg_binds
88
			       >> return stub_names
89 90
#else
                               panic "ILX support not compiled into this ghc"
rrt's avatar
rrt committed
91
#endif
92
	}
93

94
doOutput :: String -> (Handle -> IO ()) -> IO ()
95
doOutput filenm io_action
96
  = (do	handle <- openFile filenm WriteMode
97 98
	io_action handle
	hClose handle)
99 100
    `catch` (\err -> pprPanic "Failed to open or write code output file" 
			      (text filenm))
101 102 103 104 105 106 107 108 109 110
\end{code}


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

\begin{code}
111
outputC dflags filenm flat_absC (stub_h_exists, _)
112
  = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
113 114 115
       header <- readIORef v_HCHeader
       doOutput filenm $ \ h -> do
	  hPutStr h header
116 117
	  when stub_h_exists $ 
	     hPutStrLn h ("#include \"" ++ (hscStubHOutName dflags) ++ "\"")
118
	  writeRealC h flat_absC
119 120 121 122 123 124 125 126 127 128
\end{code}


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

\begin{code}
129
outputAsm dflags filenm flat_absC
130

131
#ifndef OMIT_NATIVE_CODEGEN
132

133
  = do ncg_uniqs <- mkSplitUniqSupply 'n'
134 135
       let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen" 
				        nativeCodeGen flat_absC ncg_uniqs
136
       dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
137
       dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" ncg_output_d
138
       _scc_ "OutputAsm" doOutput filenm ( \f -> printForAsm f ncg_output_d)
139 140 141 142
  where

#else /* OMIT_NATIVE_CODEGEN */

143 144
  = pprPanic "This compiler was built without a native code generator"
	     (text "Use -fvia-C instead")
145 146 147

#endif
\end{code}
148 149


150 151 152 153 154
%************************************************************************
%*									*
\subsection{Java}
%*									*
%************************************************************************
155

156
\begin{code}
157
#ifdef JAVA
158
outputJava dflags filenm mod tycons core_binds
159
  = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
160
	-- User style printing for now to keep indentation
161
  where
162 163 164
    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
165
    pp_java   = PrintJava.compilationUnit java_code
166
#endif
167
\end{code}
168

169

rrt's avatar
rrt committed
170 171 172 173 174 175 176 177
%************************************************************************
%*									*
\subsection{Ilx}
%*									*
%************************************************************************

\begin{code}
#ifdef ILX
178 179
outputIlx dflags filename mod tycons stg_binds
  =  doOutput filename (\ f -> printForC f pp_ilx)
rrt's avatar
rrt committed
180 181 182 183 184 185
  where
    pp_ilx = ilxGen mod tycons stg_binds
#endif
\end{code}


186 187 188 189 190 191 192
%************************************************************************
%*									*
\subsection{Foreign import/export}
%*									*
%************************************************************************

\begin{code}
193
outputForeignStubs dflags c_code h_code
194
  = do
195
	dumpIfSet_dyn dflags Opt_D_dump_foreign
196 197
                      "Foreign export header file" stub_h_output_d

198 199
	stub_h_file_exists
           <- outputForeignStubs_help (hscStubHOutName dflags) stub_h_output_w
200
		("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
201

202
	dumpIfSet_dyn dflags Opt_D_dump_foreign
203 204
                      "Foreign export stubs" stub_c_output_d

205
        hc_header <- readIORef v_HCHeader
206

207 208
	stub_c_file_exists
           <- outputForeignStubs_help (hscStubCOutName dflags) stub_c_output_w
209 210
		("#define IN_STG_CODE 0\n" ++ 
		 hc_header ++
211 212 213
		 "#include \"RtsAPI.h\"\n" ++
		 cplusplus_hdr)
		 cplusplus_ftr
214 215 216
	   -- 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.
217 218

        return (stub_h_file_exists, stub_c_file_exists)
219
  where
220 221 222 223 224 225 226 227
    -- 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

228 229
cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
230

231 232 233
-- 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.
234 235 236
outputForeignStubs_help fname ""      header footer = return False
outputForeignStubs_help fname doc_str header footer
   = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")
237
        return True
238 239
\end{code}