CodeOutput.lhs 7.14 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
import OccurAnal	( occurAnalyseBinds )
24
#endif
25

26
import DriverState	( v_HCHeader )
27 28
import TyCon		( TyCon )
import Id		( Id )
29
import CoreSyn		( CoreBind )
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 41
import DATA_IOREF	( readIORef )

42
import Monad		( when )
43
import IO
44 45 46
\end{code}


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

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

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

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

96
doOutput :: String -> (Handle -> IO ()) -> IO ()
97
doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
98 99 100 101 102 103 104 105 106 107
\end{code}


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

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


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

\begin{code}
126
outputAsm dflags filenm flat_absC
127

128
#ifndef OMIT_NATIVE_CODEGEN
129

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

#else /* OMIT_NATIVE_CODEGEN */

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

#endif
\end{code}
146 147


148 149 150 151 152
%************************************************************************
%*									*
\subsection{Java}
%*									*
%************************************************************************
153

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

167

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

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


184 185 186 187 188 189 190
%************************************************************************
%*									*
\subsection{Foreign import/export}
%*									*
%************************************************************************

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

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

200
	dumpIfSet_dyn dflags Opt_D_dump_foreign
201 202
                      "Foreign export stubs" stub_c_output_d

203
        hc_header <- readIORef v_HCHeader
204

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

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

226 227
cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
228

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