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 OccurAnal ( occurAnalyseBinds )
23 import qualified PrintJava
24 import OccurAnal ( occurAnalyseBinds )
27 import FastString ( unpackFS )
28 import DriverState ( v_HCHeader )
30 import StgSyn ( StgBinding )
31 import AbsCSyn ( AbstractC )
32 import PprAbsC ( dumpRealC, writeRealC )
33 import HscTypes ( ModGuts(..), ModGuts, ForeignStubs(..), typeEnvTyCons )
35 import ErrUtils ( dumpIfSet_dyn, showPass )
37 import Pretty ( Mode(..), printDoc )
38 import CmdLineOpts ( DynFlags, HscLang(..), dopt_OutName )
39 import DATA_IOREF ( readIORef, writeIORef )
45 %************************************************************************
49 %************************************************************************
52 codeOutput :: DynFlags
54 -> [(StgBinding,[Id])] -- The STG program with SRTs
55 -> AbstractC -- Compiled abstract C
56 -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
58 (ModGuts {mg_module = mod_name,
60 mg_foreign = foreign_stubs,
61 mg_binds = core_binds})
62 stg_binds flat_abstractC
64 tycons = typeEnvTyCons type_env
66 -- You can have C (c_output) or assembly-language (ncg_output),
67 -- but not both. [Allowing for both gives a space leak on
68 -- flat_abstractC. WDP 94/10]
70 -- Dunno if the above comment is still meaningful now. JRS 001024.
72 do { showPass dflags "CodeOutput"
73 ; let filenm = dopt_OutName dflags
74 ; stub_names <- outputForeignStubs dflags foreign_stubs
75 ; case dopt_HscLang dflags of
76 HscInterpreted -> return stub_names
77 HscAsm -> outputAsm dflags filenm flat_abstractC
79 HscC -> outputC dflags filenm flat_abstractC stub_names
83 outputJava dflags filenm mod_name tycons core_binds
86 panic "Java support not compiled into this ghc"
90 outputIlx dflags filenm mod_name tycons stg_binds
93 panic "ILX support not compiled into this ghc"
97 doOutput :: String -> (Handle -> IO ()) -> IO ()
98 doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
102 %************************************************************************
106 %************************************************************************
109 outputC dflags filenm flat_absC (stub_h_exists, _)
110 = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
111 header <- readIORef v_HCHeader
112 doOutput filenm $ \ h -> do
115 hPutStrLn h ("#include \"" ++ (hscStubHOutName dflags) ++ "\"")
116 writeRealC h flat_absC
120 %************************************************************************
122 \subsection{Assembler}
124 %************************************************************************
127 outputAsm dflags filenm flat_absC
129 #ifndef OMIT_NATIVE_CODEGEN
131 = do ncg_uniqs <- mkSplitUniqSupply 'n'
132 let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen"
133 nativeCodeGen flat_absC ncg_uniqs
134 dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
135 dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" (docToSDoc ncg_output_d)
136 _scc_ "OutputAsm" doOutput filenm $
137 \f -> printDoc LeftMode f ncg_output_d
140 #else /* OMIT_NATIVE_CODEGEN */
142 = pprPanic "This compiler was built without a native code generator"
143 (text "Use -fvia-C instead")
149 %************************************************************************
153 %************************************************************************
157 outputJava dflags filenm mod tycons core_binds
158 = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
159 -- User style printing for now to keep indentation
161 occ_anal_binds = occurAnalyseBinds core_binds
162 -- Make sure we have up to date dead-var information
163 java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
164 pp_java = PrintJava.compilationUnit java_code
169 %************************************************************************
173 %************************************************************************
177 outputIlx dflags filename mod tycons stg_binds
178 = doOutput filename (\ f -> printForC f pp_ilx)
180 pp_ilx = ilxGen mod tycons stg_binds
185 %************************************************************************
187 \subsection{Foreign import/export}
189 %************************************************************************
192 -- Turn the list of headers requested in foreign import
193 -- declarations into a string suitable for emission into generated
195 mkForeignHeaders headers
197 . map (\fname -> "#include \"" ++ unpackFS fname ++ "\"")
201 outputForeignStubs :: DynFlags -> ForeignStubs
202 -> IO (Bool, -- Header file created
203 Bool) -- C file created
204 outputForeignStubs dflags NoStubs = return (False, False)
205 outputForeignStubs dflags (ForeignStubs h_code c_code hdrs _)
207 dumpIfSet_dyn dflags Opt_D_dump_foreign
208 "Foreign export header file" stub_h_output_d
211 <- outputForeignStubs_help (hscStubHOutName dflags) stub_h_output_w
212 ("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
214 dumpIfSet_dyn dflags Opt_D_dump_foreign
215 "Foreign export stubs" stub_c_output_d
217 -- Extend the list of foreign headers (used in outputC)
218 fhdrs <- readIORef v_HCHeader
219 let new_fhdrs = fhdrs ++ mkForeignHeaders hdrs
220 writeIORef v_HCHeader new_fhdrs
223 <- outputForeignStubs_help (hscStubCOutName dflags) stub_c_output_w
224 ("#define IN_STG_CODE 0\n" ++
226 "#include \"RtsAPI.h\"\n" ++
229 -- We're adding the default hc_header to the stub file, but this
230 -- isn't really HC code, so we need to define IN_STG_CODE==0 to
231 -- avoid the register variables etc. being enabled.
233 return (stub_h_file_exists, stub_c_file_exists)
235 -- C stubs for "foreign export"ed functions.
236 stub_c_output_d = pprCode CStyle c_code
237 stub_c_output_w = showSDoc stub_c_output_d
239 -- Header file protos for "foreign export"ed functions.
240 stub_h_output_d = pprCode CStyle h_code
241 stub_h_output_w = showSDoc stub_h_output_d
243 cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
244 cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
246 -- Don't use doOutput for dumping the f. export stubs
247 -- since it is more than likely that the stubs file will
248 -- turn out to be empty, in which case no file should be created.
249 outputForeignStubs_help fname "" header footer = return False
250 outputForeignStubs_help fname doc_str header footer
251 = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")