2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
4 \section{Code output phase}
7 module CodeOutput( codeOutput ) where
9 #include "HsVersions.h"
11 #ifndef OMIT_NATIVE_CODEGEN
12 import UniqSupply ( mkSplitUniqSupply )
13 import AsmCodeGen ( nativeCodeGen )
17 import IlxGen ( ilxGen )
20 import JavaGen ( javaGen )
21 import qualified PrintJava
23 import DriverState ( v_HCHeader )
24 import TyCon ( TyCon )
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 )
33 import ErrUtils ( dumpIfSet_dyn, showPass )
35 import CmdLineOpts ( DynFlags, HscLang(..), dopt_OutName )
43 %************************************************************************
47 %************************************************************************
50 codeOutput :: DynFlags
52 -> [TyCon] -- Local tycons
53 -> [CoreBind] -- Core bindings
54 -> [(StgBinding,[Id])] -- The STG program with SRTs
55 -> SDoc -- C stubs for foreign exported functions
56 -> SDoc -- Header file prototype for foreign exported functions
57 -> AbstractC -- Compiled abstract C
58 -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
59 codeOutput dflags mod_name tycons core_binds stg_binds
60 c_code h_code flat_abstractC
61 = -- You can have C (c_output) or assembly-language (ncg_output),
62 -- but not both. [Allowing for both gives a space leak on
63 -- flat_abstractC. WDP 94/10]
65 -- Dunno if the above comment is still meaningful now. JRS 001024.
67 do { showPass dflags "CodeOutput"
68 ; let filenm = dopt_OutName dflags
69 ; stub_names <- outputForeignStubs dflags c_code h_code
70 ; case dopt_HscLang dflags of
71 HscInterpreted -> return stub_names
72 HscAsm -> outputAsm dflags filenm flat_abstractC
74 HscC -> outputC dflags filenm flat_abstractC stub_names
76 HscJava -> outputJava dflags filenm mod_name tycons core_binds
80 outputIlx dflags filenm mod_name tycons stg_binds
83 panic "ILX support not compiled into this ghc"
87 doOutput :: String -> (Handle -> IO ()) -> IO ()
88 doOutput filenm io_action
89 = (do handle <- openFile filenm WriteMode
92 `catch` (\err -> pprPanic "Failed to open or write code output file"
97 %************************************************************************
101 %************************************************************************
104 outputC dflags filenm flat_absC (stub_h_exists, _)
105 = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
106 header <- readIORef v_HCHeader
107 doOutput filenm $ \ h -> do
110 hPutStrLn h ("#include \"" ++ (hscStubHOutName dflags) ++ "\"")
111 writeRealC h flat_absC
115 %************************************************************************
117 \subsection{Assembler}
119 %************************************************************************
122 outputAsm dflags filenm flat_absC
124 #ifndef OMIT_NATIVE_CODEGEN
126 = do ncg_uniqs <- mkSplitUniqSupply 'n'
127 let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen"
128 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)
134 #else /* OMIT_NATIVE_CODEGEN */
136 = pprPanic "This compiler was built without a native code generator"
137 (text "Use -fvia-C instead")
143 %************************************************************************
147 %************************************************************************
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
154 occ_anal_binds = occurAnalyseBinds core_binds
155 -- Make sure we have up to date dead-var information
156 java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
157 pp_java = PrintJava.compilationUnit java_code
161 %************************************************************************
165 %************************************************************************
169 outputIlx dflags filename mod tycons stg_binds
170 = doOutput filename (\ f -> printForC f pp_ilx)
172 pp_ilx = ilxGen mod tycons stg_binds
177 %************************************************************************
179 \subsection{Foreign import/export}
181 %************************************************************************
184 outputForeignStubs dflags c_code h_code
186 dumpIfSet_dyn dflags Opt_D_dump_foreign
187 "Foreign export header file" stub_h_output_d
190 <- outputForeignStubs_help (hscStubHOutName dflags) stub_h_output_w
191 "#include \"HsFFI.h\"\n"
193 dumpIfSet_dyn dflags Opt_D_dump_foreign
194 "Foreign export stubs" stub_c_output_d
196 hc_header <- readIORef v_HCHeader
199 <- outputForeignStubs_help (hscStubCOutName dflags) stub_c_output_w
200 ("#define IN_STG_CODE 0\n" ++
202 "#include \"RtsAPI.h\"\n")
203 -- we're adding the default hc_header to the stub file, but this
204 -- isn't really HC code, so we need to define IN_STG_CODE==0 to
205 -- avoid the register variables etc. being enabled.
207 return (stub_h_file_exists, stub_c_file_exists)
209 -- C stubs for "foreign export"ed functions.
210 stub_c_output_d = pprCode CStyle c_code
211 stub_c_output_w = showSDoc stub_c_output_d
213 -- Header file protos for "foreign export"ed functions.
214 stub_h_output_d = pprCode CStyle h_code
215 stub_h_output_w = showSDoc stub_h_output_d
218 -- Don't use doOutput for dumping the f. export stubs
219 -- since it is more than likely that the stubs file will
220 -- turn out to be empty, in which case no file should be created.
221 outputForeignStubs_help fname "" injects = return False
222 outputForeignStubs_help fname doc_str injects
223 = do writeFile fname (injects ++ doc_str)