2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
4 \section{Code output phase}
7 module CodeOutput( codeOutput, outputForeignStubs ) where
9 #include "HsVersions.h"
11 #ifndef OMIT_NATIVE_CODEGEN
12 import UniqSupply ( mkSplitUniqSupply )
13 import AsmCodeGen ( nativeCodeGen )
17 import IlxGen ( ilxGen )
21 import JavaGen ( javaGen )
22 import qualified PrintJava
23 import OccurAnal ( occurAnalyseBinds )
26 import DriverState ( v_HCHeader )
27 import TyCon ( TyCon )
29 import CoreSyn ( CoreBind )
30 import StgSyn ( StgBinding )
31 import AbsCSyn ( AbstractC )
32 import PprAbsC ( dumpRealC, writeRealC )
33 import Module ( Module )
35 import ErrUtils ( dumpIfSet_dyn, showPass )
37 import Pretty ( Mode(..), printDoc )
38 import CmdLineOpts ( DynFlags, HscLang(..), dopt_OutName )
40 import DATA_IOREF ( readIORef )
47 %************************************************************************
51 %************************************************************************
54 codeOutput :: DynFlags
56 -> [TyCon] -- Local tycons
57 -> [CoreBind] -- Core bindings
58 -> [(StgBinding,[Id])] -- The STG program with SRTs
59 -> SDoc -- C stubs for foreign exported functions
60 -> SDoc -- Header file prototype for foreign exported functions
61 -> AbstractC -- Compiled abstract C
62 -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
63 codeOutput dflags mod_name tycons core_binds stg_binds
64 c_code h_code flat_abstractC
65 = -- You can have C (c_output) or assembly-language (ncg_output),
66 -- but not both. [Allowing for both gives a space leak on
67 -- flat_abstractC. WDP 94/10]
69 -- Dunno if the above comment is still meaningful now. JRS 001024.
71 do { showPass dflags "CodeOutput"
72 ; let filenm = dopt_OutName dflags
73 ; stub_names <- outputForeignStubs dflags c_code h_code
74 ; case dopt_HscLang dflags of
75 HscInterpreted -> return stub_names
76 HscAsm -> outputAsm dflags filenm flat_abstractC
78 HscC -> outputC dflags filenm flat_abstractC stub_names
82 outputJava dflags filenm mod_name tycons core_binds
85 panic "Java support not compiled into this ghc"
89 outputIlx dflags filenm mod_name tycons stg_binds
92 panic "ILX support not compiled into this ghc"
96 doOutput :: String -> (Handle -> IO ()) -> IO ()
97 doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
101 %************************************************************************
105 %************************************************************************
108 outputC dflags filenm flat_absC (stub_h_exists, _)
109 = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
110 header <- readIORef v_HCHeader
111 doOutput filenm $ \ h -> do
114 hPutStrLn h ("#include \"" ++ (hscStubHOutName dflags) ++ "\"")
115 writeRealC h flat_absC
119 %************************************************************************
121 \subsection{Assembler}
123 %************************************************************************
126 outputAsm dflags filenm flat_absC
128 #ifndef OMIT_NATIVE_CODEGEN
130 = do ncg_uniqs <- mkSplitUniqSupply 'n'
131 let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen"
132 nativeCodeGen flat_absC ncg_uniqs
133 dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
134 dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" (docToSDoc ncg_output_d)
135 _scc_ "OutputAsm" doOutput filenm $
136 \f -> printDoc LeftMode f ncg_output_d
139 #else /* OMIT_NATIVE_CODEGEN */
141 = pprPanic "This compiler was built without a native code generator"
142 (text "Use -fvia-C instead")
148 %************************************************************************
152 %************************************************************************
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
160 occ_anal_binds = occurAnalyseBinds core_binds
161 -- Make sure we have up to date dead-var information
162 java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
163 pp_java = PrintJava.compilationUnit java_code
168 %************************************************************************
172 %************************************************************************
176 outputIlx dflags filename mod tycons stg_binds
177 = doOutput filename (\ f -> printForC f pp_ilx)
179 pp_ilx = ilxGen mod tycons stg_binds
184 %************************************************************************
186 \subsection{Foreign import/export}
188 %************************************************************************
191 outputForeignStubs dflags c_code h_code
193 dumpIfSet_dyn dflags Opt_D_dump_foreign
194 "Foreign export header file" stub_h_output_d
197 <- outputForeignStubs_help (hscStubHOutName dflags) stub_h_output_w
198 ("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
200 dumpIfSet_dyn dflags Opt_D_dump_foreign
201 "Foreign export stubs" stub_c_output_d
203 hc_header <- readIORef v_HCHeader
206 <- outputForeignStubs_help (hscStubCOutName dflags) stub_c_output_w
207 ("#define IN_STG_CODE 0\n" ++
209 "#include \"RtsAPI.h\"\n" ++
212 -- we're adding the default hc_header to the stub file, but this
213 -- isn't really HC code, so we need to define IN_STG_CODE==0 to
214 -- avoid the register variables etc. being enabled.
216 return (stub_h_file_exists, stub_c_file_exists)
218 -- C stubs for "foreign export"ed functions.
219 stub_c_output_d = pprCode CStyle c_code
220 stub_c_output_w = showSDoc stub_c_output_d
222 -- Header file protos for "foreign export"ed functions.
223 stub_h_output_d = pprCode CStyle h_code
224 stub_h_output_w = showSDoc stub_h_output_d
226 cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
227 cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
229 -- Don't use doOutput for dumping the f. export stubs
230 -- since it is more than likely that the stubs file will
231 -- turn out to be empty, in which case no file should be created.
232 outputForeignStubs_help fname "" header footer = return False
233 outputForeignStubs_help fname doc_str header footer
234 = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")