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

\begin{code}
module CodeOutput( codeOutput ) where

#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 21 22
import JavaGen		( javaGen )
import qualified PrintJava

23 24
import TyCon		( TyCon )
import Id		( Id )
25
import CoreSyn		( CoreBind )
26
import OccurAnal	( occurAnalyseBinds )
27
import StgSyn		( StgBinding )
28
import AbsCSyn		( AbstractC )
29
import PprAbsC		( dumpRealC, writeRealC )
30
import Module		( Module )
31
import CmdLineOpts
32
import ErrUtils		( dumpIfSet_dyn, showPass )
33
import Outputable
34 35
import CmdLineOpts	( DynFlags, HscLang(..), dopt_OutName )
import TmpFiles		( newTempName )
36

37
import IO		( IOMode(..), hClose, openFile, Handle )
38
import IO		( hPutStr, stderr) 	-- Debugging
39 40 41
\end{code}


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

48
\begin{code}
49 50
codeOutput :: DynFlags
	   -> Module
51
	   -> [TyCon]			-- Local tycons
52
	   -> [CoreBind]		-- Core bindings
53
	   -> [(StgBinding,[Id])]	-- The STG program with SRTs
54 55 56
	   -> SDoc 		-- C stubs for foreign exported functions
	   -> SDoc		-- Header file prototype for foreign exported functions
	   -> AbstractC		-- Compiled abstract C
57
	   -> IO (Maybe FilePath, Maybe FilePath)
58 59
codeOutput dflags mod_name tycons core_binds stg_binds 
	   c_code h_code flat_abstractC
60 61 62 63
  = -- You can have C (c_output) or assembly-language (ncg_output),
    -- 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 68 69 70 71 72 73 74 75 76
    do	{ showPass dflags "CodeOutput"
	; let filenm = dopt_OutName dflags 
	; stub_names <- outputForeignStubs dflags c_code h_code
	; case dopt_HscLang dflags of
             HscInterpreted -> return stub_names
             HscAsm         -> outputAsm dflags filenm flat_abstractC
          		       >> return stub_names
             HscC           -> outputC dflags filenm flat_abstractC	
          		       >> return stub_names
             HscJava        -> outputJava dflags filenm mod_name tycons core_binds
          		       >> return stub_names
rrt's avatar
rrt committed
77
#ifdef ILX
78 79
	     HscILX         -> outputIlx dflags filenm mod_name tycons stg_binds
			       >> return stub_names
rrt's avatar
rrt committed
80
#endif
81
	}
82

83
doOutput :: String -> (Handle -> IO ()) -> IO ()
84
doOutput filenm io_action
85
  = (do	handle <- openFile filenm WriteMode
86 87
	io_action handle
	hClose handle)
88 89
    `catch` (\err -> pprPanic "Failed to open or write code output file" 
			      (text filenm))
90 91 92 93 94 95 96 97 98 99
\end{code}


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

\begin{code}
100
outputC dflags filenm flat_absC
101
  = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
102
       doOutput filenm (\ h -> writeRealC h flat_absC)
103 104 105 106 107 108 109 110 111 112
\end{code}


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

\begin{code}
113
outputAsm dflags filenm flat_absC
114

115
#ifndef OMIT_NATIVE_CODEGEN
116

117
  = do ncg_uniqs <- mkSplitUniqSupply 'n'
118 119
       let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen" 
				        nativeCodeGen flat_absC ncg_uniqs
120
       dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
121
       dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" ncg_output_d
122
       _scc_ "OutputAsm" doOutput filenm ( \f -> printForAsm f ncg_output_d)
123 124 125 126
  where

#else /* OMIT_NATIVE_CODEGEN */

127 128
  = pprPanic "This compiler was built without a native code generator"
	     (text "Use -fvia-C instead")
129 130 131

#endif
\end{code}
132 133


134 135 136 137 138
%************************************************************************
%*									*
\subsection{Java}
%*									*
%************************************************************************
139

140
\begin{code}
141
outputJava dflags filenm mod tycons core_binds
142
  = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
143
	-- User style printing for now to keep indentation
144
  where
145 146 147
    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
148 149
    pp_java   = PrintJava.compilationUnit java_code
\end{code}
150

151

rrt's avatar
rrt committed
152 153 154 155 156 157 158 159
%************************************************************************
%*									*
\subsection{Ilx}
%*									*
%************************************************************************

\begin{code}
#ifdef ILX
160 161
outputIlx dflags filename mod tycons stg_binds
  =  doOutput filename (\ f -> printForC f pp_ilx)
rrt's avatar
rrt committed
162 163 164 165 166 167
  where
    pp_ilx = ilxGen mod tycons stg_binds
#endif
\end{code}


168 169 170 171 172 173 174
%************************************************************************
%*									*
\subsection{Foreign import/export}
%*									*
%************************************************************************

\begin{code}
175
outputForeignStubs dflags c_code h_code
176
  = do
177
	dumpIfSet_dyn dflags Opt_D_dump_foreign
178 179 180 181
                      "Foreign export header file" stub_h_output_d

	maybe_stub_h_file
           <- outputForeignStubs_help True{-.h output-} stub_h_output_w
182

183
	dumpIfSet_dyn dflags Opt_D_dump_foreign
184 185 186 187 188 189
                      "Foreign export stubs" stub_c_output_d

        maybe_stub_c_file
           <- outputForeignStubs_help False{-not .h-} stub_c_output_w

        return (maybe_stub_h_file, maybe_stub_c_file)
190
  where
191 192 193 194 195 196 197 198 199
    -- 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


200 201 202
-- 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.
203 204
outputForeignStubs_help is_header ""      = return Nothing
outputForeignStubs_help is_header doc_str 
205 206 207
   = do fname <- newTempName suffix
        writeFile fname (include_prefix ++ doc_str)
        return (Just fname)
208 209 210 211 212
  where
    suffix
       | is_header   = "h_stub"
       | otherwise   = "c_stub"
    include_prefix
213
       | is_header   = "#include \"HsFFI.h\"\n"
214
       | otherwise   = "#include \"RtsAPI.h\"\n"
215 216
\end{code}