CodeOutput.lhs 8.35 KB
Newer Older
1 2 3 4 5 6
%
% (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
%
\section{Code output phase}

\begin{code}
7
module CodeOutput( codeOutput, outputForeignStubs ) where
8 9 10

#include "HsVersions.h"

11
#ifndef OMIT_NATIVE_CODEGEN
12
import UniqSupply	( mkSplitUniqSupply )
13 14
import AsmCodeGen	( nativeCodeGen )
#endif
15

16 17 18
#ifdef ILX
import IlxGen		( ilxGen )
#endif
19

20
#ifdef JAVA
21
import JavaGen		( javaGen )
22
import OccurAnal	( occurAnalyseBinds )
23
import qualified PrintJava
24
import OccurAnal	( occurAnalyseBinds )
25
#endif
26

27
import Packages
28
import DriverState	( getExplicitPackagesAnd, getPackageCIncludes )
29
import FastString	( unpackFS )
30
import AbsCSyn		( AbstractC )
31
import PprAbsC		( dumpRealC, writeRealC )
32
import HscTypes
33
import CmdLineOpts
34
import ErrUtils		( dumpIfSet_dyn, showPass )
35
import Outputable
36
import Pretty		( Mode(..), printDoc )
37
import CmdLineOpts	( DynFlags, HscLang(..), dopt_OutName )
38
import Monad		( when )
39
import IO
40 41 42
\end{code}


43 44 45 46 47 48
%************************************************************************
%*									*
\subsection{Steering}
%*									*
%************************************************************************

49
\begin{code}
50
codeOutput :: DynFlags
51 52
	   -> ModGuts
	   -> AbstractC			-- Compiled abstract C
53
	   -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
54

55 56 57 58
codeOutput dflags 
	   (ModGuts {mg_module = mod_name,
		     mg_types  = type_env,
		     mg_foreign = foreign_stubs,
59
		     mg_deps	= deps,
60
		     mg_binds   = core_binds})
61
	   flat_abstractC
62
  = 
63
    -- You can have C (c_output) or assembly-language (ncg_output),
64 65 66
    -- but not both.  [Allowing for both gives a space leak on
    -- flat_abstractC.  WDP 94/10]

67
    -- Dunno if the above comment is still meaningful now.  JRS 001024.
68

69 70
    do	{ showPass dflags "CodeOutput"
	; let filenm = dopt_OutName dflags 
71 72 73 74 75 76
	; stubs_exist <- outputForeignStubs dflags foreign_stubs
	; case dopt_HscLang dflags of {
             HscInterpreted -> return ();
             HscAsm         -> outputAsm dflags filenm flat_abstractC;
             HscC           -> outputC dflags filenm flat_abstractC stubs_exist
					deps foreign_stubs;
77 78
             HscJava        -> 
#ifdef JAVA
79
			       outputJava dflags filenm mod_name tycons core_binds;
80
#else
81
                               panic "Java support not compiled into this ghc";
82
#endif
83
	     HscILX         -> 
rrt's avatar
rrt committed
84
#ifdef ILX
85
			       let tycons = typeEnvTyCons type_env in
86
	                       outputIlx dflags filenm mod_name tycons stg_binds;
87
#else
88
                               panic "ILX support not compiled into this ghc";
rrt's avatar
rrt committed
89
#endif
90 91
	  }
	; return stubs_exist
92
	}
93

94
doOutput :: String -> (Handle -> IO ()) -> IO ()
95
doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
96 97 98 99 100 101 102 103 104 105
\end{code}


%************************************************************************
%*									*
\subsection{C}
%*									*
%************************************************************************

\begin{code}
106 107
outputC dflags filenm flat_absC 
	(stub_h_exists, _) dependencies (ForeignStubs _ _ ffi_decl_headers _ ) 
108
  = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134

       -- figure out which header files to #include in the generated .hc file:
       --
       --   * extra_includes from packages
       --   * -#include options from the cmdline and OPTIONS pragmas
       --   * the _stub.h file, if there is one.
       --
       let packages = dep_pkgs dependencies
       pkg_configs <- getExplicitPackagesAnd packages
       let pkg_names = map name pkg_configs

       c_includes <- getPackageCIncludes pkg_configs
       let cmdline_includes = cmdlineHcIncludes dflags -- -#include options
       
           all_headers =  c_includes
		       ++ reverse cmdline_includes
		       ++ reverse (map unpackFS ffi_decl_headers)
			   -- reverse correct?

       let cc_injects = unlines (map mk_include all_headers)
       	   mk_include h_file = 
       	    case h_file of 
       	       '"':_{-"-} -> "#include "++h_file
       	       '<':_      -> "#include "++h_file
       	       _          -> "#include \""++h_file++"\""

135
       doOutput filenm $ \ h -> do
136 137
	  hPutStr h ("/* GHC_PACKAGES " ++ unwords pkg_names ++ "\n*/\n")
	  hPutStr h cc_injects
138 139
	  when stub_h_exists $ 
	     hPutStrLn h ("#include \"" ++ (hscStubHOutName dflags) ++ "\"")
140
	  writeRealC h flat_absC
141 142 143 144 145 146 147 148 149 150
\end{code}


%************************************************************************
%*									*
\subsection{Assembler}
%*									*
%************************************************************************

\begin{code}
151
outputAsm dflags filenm flat_absC
152

153
#ifndef OMIT_NATIVE_CODEGEN
154

155
  = do ncg_uniqs <- mkSplitUniqSupply 'n'
156 157
       let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen" 
				        nativeCodeGen flat_absC ncg_uniqs
158
       dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
159 160 161
       dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" (docToSDoc ncg_output_d)
       _scc_ "OutputAsm" doOutput filenm $
	   \f -> printDoc LeftMode f ncg_output_d
162 163 164 165
  where

#else /* OMIT_NATIVE_CODEGEN */

166 167
  = pprPanic "This compiler was built without a native code generator"
	     (text "Use -fvia-C instead")
168 169 170

#endif
\end{code}
171 172


173 174 175 176 177
%************************************************************************
%*									*
\subsection{Java}
%*									*
%************************************************************************
178

179
\begin{code}
180
#ifdef JAVA
181
outputJava dflags filenm mod tycons core_binds
182
  = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
183
	-- User style printing for now to keep indentation
184
  where
185 186 187
    occ_anal_binds = occurAnalyseBinds core_binds
	-- Make sure we have up to date dead-var information
    java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
188
    pp_java   = PrintJava.compilationUnit java_code
189
#endif
190
\end{code}
191

192

rrt's avatar
rrt committed
193 194 195 196 197 198 199 200
%************************************************************************
%*									*
\subsection{Ilx}
%*									*
%************************************************************************

\begin{code}
#ifdef ILX
201 202
outputIlx dflags filename mod tycons stg_binds
  =  doOutput filename (\ f -> printForC f pp_ilx)
rrt's avatar
rrt committed
203 204 205 206 207 208
  where
    pp_ilx = ilxGen mod tycons stg_binds
#endif
\end{code}


209 210 211 212 213 214 215
%************************************************************************
%*									*
\subsection{Foreign import/export}
%*									*
%************************************************************************

\begin{code}
216 217 218 219
outputForeignStubs :: DynFlags -> ForeignStubs
		   -> IO (Bool, 	-- Header file created
			  Bool)		-- C file created
outputForeignStubs dflags NoStubs = return (False, False)
220
outputForeignStubs dflags (ForeignStubs h_code c_code _ _)
221
  = do
222
	dumpIfSet_dyn dflags Opt_D_dump_foreign
223 224
                      "Foreign export header file" stub_h_output_d

225 226 227 228 229
	-- we need the #includes from the rts package for the stub files
	rts_pkgs <- getPackageDetails [rtsPackage]
 	let rts_includes = concatMap mk_include (concatMap c_includes rts_pkgs)
	    mk_include i = "#include \"" ++ i ++ "\"\n"

230 231
	stub_h_file_exists
           <- outputForeignStubs_help (hscStubHOutName dflags) stub_h_output_w
232
		("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
233

234
	dumpIfSet_dyn dflags Opt_D_dump_foreign
235 236
                      "Foreign export stubs" stub_c_output_d

237 238
	stub_c_file_exists
           <- outputForeignStubs_help (hscStubCOutName dflags) stub_c_output_w
239
		("#define IN_STG_CODE 0\n" ++ 
240
		 "#include \"RtsAPI.h\"\n" ++
241
		 rts_includes ++
242 243
		 cplusplus_hdr)
		 cplusplus_ftr
244
	   -- We're adding the default hc_header to the stub file, but this
245 246
	   -- isn't really HC code, so we need to define IN_STG_CODE==0 to
	   -- avoid the register variables etc. being enabled.
247 248

        return (stub_h_file_exists, stub_c_file_exists)
249
  where
250 251 252 253 254 255 256 257
    -- C stubs for "foreign export"ed functions.
    stub_c_output_d = pprCode CStyle c_code
    stub_c_output_w = showSDoc stub_c_output_d

    -- Header file protos for "foreign export"ed functions.
    stub_h_output_d = pprCode CStyle h_code
    stub_h_output_w = showSDoc stub_h_output_d

258 259
cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
260

261 262 263
-- Don't use doOutput for dumping the f. export stubs
-- since it is more than likely that the stubs file will
-- turn out to be empty, in which case no file should be created.
264 265 266
outputForeignStubs_help fname ""      header footer = return False
outputForeignStubs_help fname doc_str header footer
   = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")
267
        return True
268 269
\end{code}