CodeOutput.lhs 8.3 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 38
import Module		( Module )

39
import Monad		( when )
40
import IO
41 42 43
\end{code}


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

50
\begin{code}
51
codeOutput :: DynFlags
52 53 54
	   -> Module
	   -> ForeignStubs
	   -> Dependencies
55
	   -> AbstractC			-- Compiled abstract C
56
	   -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
57

58
codeOutput dflags this_mod foreign_stubs deps flat_abstractC
59
  = 
60
    -- You can have C (c_output) or assembly-language (ncg_output),
61 62 63
    -- but not both.  [Allowing for both gives a space leak on
    -- flat_abstractC.  WDP 94/10]

64
    -- Dunno if the above comment is still meaningful now.  JRS 001024.
65

66 67
    do	{ showPass dflags "CodeOutput"
	; let filenm = dopt_OutName dflags 
68 69 70 71 72 73
	; 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;
74 75
             HscJava        -> 
#ifdef JAVA
76
			       outputJava dflags filenm mod_name tycons core_binds;
77
#else
78
                               panic "Java support not compiled into this ghc";
79
#endif
80
	     HscILX         -> 
rrt's avatar
rrt committed
81
#ifdef ILX
82
			       let tycons = typeEnvTyCons type_env in
83
	                       outputIlx dflags filenm mod_name tycons stg_binds;
84
#else
85
                               panic "ILX support not compiled into this ghc";
rrt's avatar
rrt committed
86
#endif
87 88
	  }
	; return stubs_exist
89
	}
90

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


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

\begin{code}
103
outputC dflags filenm flat_absC 
104
	(stub_h_exists, _) dependencies foreign_stubs
105
  = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
106 107 108 109 110 111 112 113 114 115 116 117 118 119

       -- 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
       
120 121 122 123
	   ffi_decl_headers = case foreign_stubs of
				NoStubs 		-> []
				ForeignStubs _ _ fdhs _ -> fdhs 

124 125 126 127 128 129 130 131 132 133 134 135
           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++"\""

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


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

\begin{code}
152
outputAsm dflags filenm flat_absC
153

154
#ifndef OMIT_NATIVE_CODEGEN
155

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

#else /* OMIT_NATIVE_CODEGEN */

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

#endif
\end{code}
172 173


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

180
\begin{code}
181
#ifdef JAVA
182
outputJava dflags filenm mod tycons core_binds
183
  = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
184
	-- User style printing for now to keep indentation
185
  where
186 187 188
    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
189
    pp_java   = PrintJava.compilationUnit java_code
190
#endif
191
\end{code}
192

193

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

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


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

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

226 227 228 229 230
	-- 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"

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

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

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

        return (stub_h_file_exists, stub_c_file_exists)
250
  where
251 252 253 254 255 256 257 258
    -- 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

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

262 263 264
-- 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.
265 266 267
outputForeignStubs_help fname ""      header footer = return False
outputForeignStubs_help fname doc_str header footer
   = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")
268
        return True
269 270
\end{code}