CodeOutput.lhs 6.61 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
import DriverState	( v_HCHeader )
24 25
import TyCon		( TyCon )
import Id		( Id )
26
import CoreSyn		( CoreBind )
27
import OccurAnal	( occurAnalyseBinds )
28
import StgSyn		( StgBinding )
29
import AbsCSyn		( AbstractC )
30
import PprAbsC		( dumpRealC, writeRealC )
31
import Module		( Module )
32
import CmdLineOpts
33
import ErrUtils		( dumpIfSet_dyn, showPass )
34
import Outputable
35 36
import CmdLineOpts	( DynFlags, HscLang(..), dopt_OutName )
import TmpFiles		( newTempName )
37

38 39
import IOExts
import IO
40 41 42
\end{code}


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

49
\begin{code}
50 51
codeOutput :: DynFlags
	   -> Module
52
	   -> [TyCon]			-- Local tycons
53
	   -> [CoreBind]		-- Core bindings
54
	   -> [(StgBinding,[Id])]	-- The STG program with SRTs
55 56 57
	   -> SDoc 		-- C stubs for foreign exported functions
	   -> SDoc		-- Header file prototype for foreign exported functions
	   -> AbstractC		-- Compiled abstract C
58
	   -> IO (Maybe FilePath, Maybe FilePath)
59 60
codeOutput dflags mod_name tycons core_binds stg_binds 
	   c_code h_code flat_abstractC
61 62 63 64
  = -- 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]

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

67 68 69 70 71 72 73
    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
74
             HscC           -> outputC dflags filenm flat_abstractC stub_names
75 76 77
          		       >> return stub_names
             HscJava        -> outputJava dflags filenm mod_name tycons core_binds
          		       >> return stub_names
rrt's avatar
rrt committed
78
#ifdef ILX
79 80
	     HscILX         -> outputIlx dflags filenm mod_name tycons stg_binds
			       >> return stub_names
rrt's avatar
rrt committed
81
#endif
82
	}
83

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


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

\begin{code}
101
outputC dflags filenm flat_absC (maybe_stub_h, _)
102
  = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
103 104 105
       header <- readIORef v_HCHeader
       doOutput filenm $ \ h -> do
	  hPutStr h header
106 107 108
	  case maybe_stub_h of
		Nothing       -> return ()
		Just filename -> hPutStrLn h ("#include \"" ++ filename ++ "\"")
109
	  writeRealC h flat_absC
110 111 112 113 114 115 116 117 118 119
\end{code}


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

\begin{code}
120
outputAsm dflags filenm flat_absC
121

122
#ifndef OMIT_NATIVE_CODEGEN
123

124
  = do ncg_uniqs <- mkSplitUniqSupply 'n'
125 126
       let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen" 
				        nativeCodeGen flat_absC ncg_uniqs
127
       dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
128
       dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" ncg_output_d
129
       _scc_ "OutputAsm" doOutput filenm ( \f -> printForAsm f ncg_output_d)
130 131 132 133
  where

#else /* OMIT_NATIVE_CODEGEN */

134 135
  = pprPanic "This compiler was built without a native code generator"
	     (text "Use -fvia-C instead")
136 137 138

#endif
\end{code}
139 140


141 142 143 144 145
%************************************************************************
%*									*
\subsection{Java}
%*									*
%************************************************************************
146

147
\begin{code}
148
outputJava dflags filenm mod tycons core_binds
149
  = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
150
	-- User style printing for now to keep indentation
151
  where
152 153 154
    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
155 156
    pp_java   = PrintJava.compilationUnit java_code
\end{code}
157

158

rrt's avatar
rrt committed
159 160 161 162 163 164 165 166
%************************************************************************
%*									*
\subsection{Ilx}
%*									*
%************************************************************************

\begin{code}
#ifdef ILX
167 168
outputIlx dflags filename mod tycons stg_binds
  =  doOutput filename (\ f -> printForC f pp_ilx)
rrt's avatar
rrt committed
169 170 171 172 173 174
  where
    pp_ilx = ilxGen mod tycons stg_binds
#endif
\end{code}


175 176 177 178 179 180 181
%************************************************************************
%*									*
\subsection{Foreign import/export}
%*									*
%************************************************************************

\begin{code}
182
outputForeignStubs dflags c_code h_code
183
  = do
184
	dumpIfSet_dyn dflags Opt_D_dump_foreign
185 186 187 188
                      "Foreign export header file" stub_h_output_d

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

190
	dumpIfSet_dyn dflags Opt_D_dump_foreign
191 192 193 194 195 196
                      "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)
197
  where
198 199 200 201 202 203 204 205 206
    -- 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


207 208 209
-- 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.
210 211
outputForeignStubs_help is_header ""      = return Nothing
outputForeignStubs_help is_header doc_str 
212 213 214
   = do fname <- newTempName suffix
        writeFile fname (include_prefix ++ doc_str)
        return (Just fname)
215 216 217 218 219
  where
    suffix
       | is_header   = "h_stub"
       | otherwise   = "c_stub"
    include_prefix
220
       | is_header   = "#include \"HsFFI.h\"\n"
221
       | otherwise   = "#include \"RtsAPI.h\"\n"
222 223
\end{code}