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

\begin{code}
7
module CodeOutput( codeOutput, outputForeignStubs ) where
8 9 10

#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 Pretty		( Mode(..), printDoc )
38
import CmdLineOpts	( DynFlags, HscLang(..), dopt_OutName )
39

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


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

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

68
    -- Dunno if the above comment is still meaningful now.  JRS 001024.
69

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

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


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

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


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

\begin{code}
130
outputAsm dflags filenm flat_absC
131

132
#ifndef OMIT_NATIVE_CODEGEN
133

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

#else /* OMIT_NATIVE_CODEGEN */

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

#endif
\end{code}
150 151


152 153 154 155 156
%************************************************************************
%*									*
\subsection{Java}
%*									*
%************************************************************************
157

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

171

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

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


188 189 190 191 192 193 194
%************************************************************************
%*									*
\subsection{Foreign import/export}
%*									*
%************************************************************************

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

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

204
	dumpIfSet_dyn dflags Opt_D_dump_foreign
205 206
                      "Foreign export stubs" stub_c_output_d

207
        hc_header <- readIORef v_HCHeader
208

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

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

230 231
cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
232

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