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 JavaGen ( javaGen )
18 import qualified PrintJava
19 import OccurAnal ( occurAnalyseBinds )
22 import Finder ( mkStubPaths )
23 import PprC ( writeCs )
24 import CmmLint ( cmmLint )
26 import PackageConfig ( rtsPackageId )
28 import FastString ( unpackFS )
33 import ErrUtils ( dumpIfSet_dyn, showPass, ghcExit )
35 import Pretty ( Mode(..), printDoc )
36 import Module ( Module, ModLocation(..), moduleName )
38 import Maybes ( firstJust )
40 import Distribution.Package ( showPackageId )
41 import Directory ( doesFileExist )
46 %************************************************************************
50 %************************************************************************
53 codeOutput :: DynFlags
58 -> [RawCmm] -- Compiled C--
59 -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
61 codeOutput dflags this_mod location foreign_stubs pkg_deps flat_abstractC
63 -- You can have C (c_output) or assembly-language (ncg_output),
64 -- but not both. [Allowing for both gives a space leak on
65 -- flat_abstractC. WDP 94/10]
67 -- Dunno if the above comment is still meaningful now. JRS 001024.
69 do { when (dopt Opt_DoCmmLinting dflags) $ do
70 { showPass dflags "CmmLint"
71 ; let lints = map cmmLint flat_abstractC
72 ; case firstJust lints of
73 Just err -> do { printDump err
79 ; showPass dflags "CodeOutput"
80 ; let filenm = hscOutName dflags
81 ; stubs_exist <- outputForeignStubs dflags this_mod location foreign_stubs
82 ; case hscTarget dflags of {
83 HscInterpreted -> return ();
84 HscAsm -> outputAsm dflags filenm flat_abstractC;
85 HscC -> outputC dflags filenm this_mod location
86 flat_abstractC stubs_exist pkg_deps
90 outputJava dflags filenm mod_name tycons core_binds;
92 panic "Java support not compiled into this ghc";
98 doOutput :: String -> (Handle -> IO ()) -> IO ()
99 doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
103 %************************************************************************
107 %************************************************************************
110 outputC dflags filenm mod location flat_absC
111 (stub_h_exists, _) packages foreign_stubs
113 -- figure out which header files to #include in the generated .hc file:
115 -- * extra_includes from packages
116 -- * -#include options from the cmdline and OPTIONS pragmas
117 -- * the _stub.h file, if there is one.
119 pkg_configs <- getPreloadPackagesAnd dflags packages
120 let pkg_names = map (showPackageId.package) pkg_configs
122 c_includes <- getPackageCIncludes pkg_configs
123 let cmdline_includes = cmdlineHcIncludes dflags -- -#include options
126 = case foreign_stubs of
128 ForeignStubs _ _ fdhs _ -> map unpackFS (nub fdhs)
129 -- Remove duplicates, because distinct foreign import decls
130 -- may cite the same #include. Order doesn't matter.
132 all_headers = c_includes
133 ++ reverse cmdline_includes
136 let cc_injects = unlines (map mk_include all_headers)
139 '"':_{-"-} -> "#include "++h_file
140 '<':_ -> "#include "++h_file
141 _ -> "#include \""++h_file++"\""
143 doOutput filenm $ \ h -> do
144 hPutStr h ("/* GHC_PACKAGES " ++ unwords pkg_names ++ "\n*/\n")
147 hPutStrLn h ("#include \"" ++ (filenameOf stub_h) ++ "\"")
148 writeCs dflags h flat_absC
150 (_, stub_h) = mkStubPaths dflags (moduleName mod) location
154 %************************************************************************
156 \subsection{Assembler}
158 %************************************************************************
161 outputAsm dflags filenm flat_absC
163 #ifndef OMIT_NATIVE_CODEGEN
165 = do ncg_uniqs <- mkSplitUniqSupply 'n'
166 ncg_output_d <- _scc_ "NativeCodeGen"
167 nativeCodeGen dflags flat_absC ncg_uniqs
168 dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" (docToSDoc ncg_output_d)
169 _scc_ "OutputAsm" doOutput filenm $
170 \f -> printDoc LeftMode f ncg_output_d
173 #else /* OMIT_NATIVE_CODEGEN */
175 = pprPanic "This compiler was built without a native code generator"
176 (text "Use -fvia-C instead")
182 %************************************************************************
186 %************************************************************************
190 outputJava dflags filenm mod tycons core_binds
191 = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
192 -- User style printing for now to keep indentation
194 occ_anal_binds = occurAnalyseBinds core_binds
195 -- Make sure we have up to date dead-var information
196 java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
197 pp_java = PrintJava.compilationUnit java_code
202 %************************************************************************
204 \subsection{Foreign import/export}
206 %************************************************************************
209 outputForeignStubs :: DynFlags -> Module -> ModLocation -> ForeignStubs
210 -> IO (Bool, -- Header file created
211 Bool) -- C file created
212 outputForeignStubs dflags mod location stubs
213 | NoStubs <- stubs = do
214 -- When compiling External Core files, may need to use stub
215 -- files from a previous compilation
216 stub_c_exists <- doesFileExist stub_c
217 stub_h_exists <- doesFileExist stub_h
218 return (stub_h_exists, stub_c_exists)
220 | ForeignStubs h_code c_code _ _ <- stubs
223 stub_c_output_d = pprCode CStyle c_code
224 stub_c_output_w = showSDoc stub_c_output_d
226 -- Header file protos for "foreign export"ed functions.
227 stub_h_output_d = pprCode CStyle h_code
228 stub_h_output_w = showSDoc stub_h_output_d
231 createDirectoryHierarchy (directoryOf stub_c)
233 dumpIfSet_dyn dflags Opt_D_dump_foreign
234 "Foreign export header file" stub_h_output_d
236 -- we need the #includes from the rts package for the stub files
238 let rts_pkg = getPackageDetails (pkgState dflags) rtsPackageId in
239 concatMap mk_include (includes rts_pkg)
240 mk_include i = "#include \"" ++ i ++ "\"\n"
243 <- outputForeignStubs_help stub_h stub_h_output_w
244 ("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
246 dumpIfSet_dyn dflags Opt_D_dump_foreign
247 "Foreign export stubs" stub_c_output_d
250 <- outputForeignStubs_help stub_c stub_c_output_w
251 ("#define IN_STG_CODE 0\n" ++
252 "#include \"Rts.h\"\n" ++
256 -- We're adding the default hc_header to the stub file, but this
257 -- isn't really HC code, so we need to define IN_STG_CODE==0 to
258 -- avoid the register variables etc. being enabled.
260 return (stub_h_file_exists, stub_c_file_exists)
262 (stub_c, stub_h) = mkStubPaths dflags (moduleName mod) location
264 cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
265 cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
267 -- Don't use doOutput for dumping the f. export stubs
268 -- since it is more than likely that the stubs file will
269 -- turn out to be empty, in which case no file should be created.
270 outputForeignStubs_help fname "" header footer = return False
271 outputForeignStubs_help fname doc_str header footer
272 = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")