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 )
32 import ErrUtils ( dumpIfSet_dyn, showPass, ghcExit )
35 import Maybes ( firstJust )
37 import Control.Exception
39 import System.Directory
40 import System.FilePath
44 %************************************************************************
48 %************************************************************************
51 codeOutput :: DynFlags
56 -> [RawCmm] -- Compiled C--
57 -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
59 codeOutput dflags this_mod location foreign_stubs pkg_deps 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 { when (dopt Opt_DoCmmLinting dflags) $ do
68 { showPass dflags "CmmLint"
69 ; let lints = map cmmLint flat_abstractC
70 ; case firstJust lints of
71 Just err -> do { printDump err
77 ; showPass dflags "CodeOutput"
78 ; let filenm = hscOutName dflags
79 ; stubs_exist <- outputForeignStubs dflags this_mod location foreign_stubs
80 ; case hscTarget dflags of {
81 HscInterpreted -> return ();
82 HscAsm -> outputAsm dflags filenm flat_abstractC;
83 HscC -> outputC dflags filenm flat_abstractC pkg_deps;
86 outputJava dflags filenm mod_name tycons core_binds;
88 panic "Java support not compiled into this ghc";
90 HscNothing -> panic "codeOutput: HscNothing"
95 doOutput :: String -> (Handle -> IO ()) -> IO ()
96 doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
100 %************************************************************************
104 %************************************************************************
113 outputC dflags filenm flat_absC packages
115 -- figure out which header files to #include in the generated .hc file:
117 -- * extra_includes from packages
118 -- * -#include options from the cmdline and OPTIONS pragmas
119 -- * the _stub.h file, if there is one.
121 let rts = getPackageDetails (pkgState dflags) rtsPackageId
123 let cc_injects = unlines (map mk_include (includes rts))
126 '"':_{-"-} -> "#include "++h_file
127 '<':_ -> "#include "++h_file
128 _ -> "#include \""++h_file++"\""
130 pkg_configs <- getPreloadPackagesAnd dflags packages
131 let pkg_names = map (display.sourcePackageId) pkg_configs
133 doOutput filenm $ \ h -> do
134 hPutStr h ("/* GHC_PACKAGES " ++ unwords pkg_names ++ "\n*/\n")
136 writeCs dflags h flat_absC
140 %************************************************************************
142 \subsection{Assembler}
144 %************************************************************************
147 outputAsm :: DynFlags -> FilePath -> [RawCmm] -> IO ()
149 #ifndef OMIT_NATIVE_CODEGEN
151 outputAsm dflags filenm flat_absC
152 = do ncg_uniqs <- mkSplitUniqSupply 'n'
154 {-# SCC "OutputAsm" #-} doOutput filenm $
155 \f -> {-# SCC "NativeCodeGen" #-}
156 nativeCodeGen dflags f ncg_uniqs flat_absC
159 #else /* OMIT_NATIVE_CODEGEN */
162 = pprPanic "This compiler was built without a native code generator"
163 (text "Use -fvia-C instead")
169 %************************************************************************
173 %************************************************************************
177 outputJava dflags filenm mod tycons core_binds
178 = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
179 -- User style printing for now to keep indentation
181 occ_anal_binds = occurAnalyseBinds core_binds
182 -- Make sure we have up to date dead-var information
183 java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
184 pp_java = PrintJava.compilationUnit java_code
189 %************************************************************************
191 \subsection{Foreign import/export}
193 %************************************************************************
196 outputForeignStubs :: DynFlags -> Module -> ModLocation -> ForeignStubs
197 -> IO (Bool, -- Header file created
198 Bool) -- C file created
199 outputForeignStubs dflags mod location stubs
202 -- When compiling External Core files, may need to use stub
203 -- files from a previous compilation
204 stub_c_exists <- doesFileExist stub_c
205 stub_h_exists <- doesFileExist stub_h
206 return (stub_h_exists, stub_c_exists)
208 ForeignStubs h_code c_code -> do
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 createDirectoryHierarchy (takeDirectory stub_c)
220 dumpIfSet_dyn dflags Opt_D_dump_foreign
221 "Foreign export header file" stub_h_output_d
223 -- we need the #includes from the rts package for the stub files
225 let rts_pkg = getPackageDetails (pkgState dflags) rtsPackageId in
226 concatMap mk_include (includes rts_pkg)
227 mk_include i = "#include \"" ++ i ++ "\"\n"
229 -- wrapper code mentions the ffi_arg type, which comes from ffi.h
230 ffi_includes | cLibFFI = "#include \"ffi.h\"\n"
234 <- outputForeignStubs_help stub_h stub_h_output_w
235 ("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
237 dumpIfSet_dyn dflags Opt_D_dump_foreign
238 "Foreign export stubs" stub_c_output_d
241 <- outputForeignStubs_help stub_c stub_c_output_w
242 ("#define IN_STG_CODE 0\n" ++
243 "#include \"Rts.h\"\n" ++
248 -- We're adding the default hc_header to the stub file, but this
249 -- isn't really HC code, so we need to define IN_STG_CODE==0 to
250 -- avoid the register variables etc. being enabled.
252 return (stub_h_file_exists, stub_c_file_exists)
254 (stub_c, stub_h, _) = mkStubPaths dflags (moduleName mod) location
256 cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
257 cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
260 -- Don't use doOutput for dumping the f. export stubs
261 -- since it is more than likely that the stubs file will
262 -- turn out to be empty, in which case no file should be created.
263 outputForeignStubs_help :: FilePath -> String -> String -> String -> IO Bool
264 outputForeignStubs_help _fname "" _header _footer = return False
265 outputForeignStubs_help fname doc_str header footer
266 = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")