CodeOutput.lhs 5.9 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 13
import AsmCodeGen	( nativeCodeGen )
#endif
14

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

19 20 21
import JavaGen		( javaGen )
import qualified PrintJava

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

37
import IO		( IOMode(..), hClose, openFile, Handle )
38 39 40
\end{code}


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

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

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

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
	}
77

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


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

\begin{code}
95
outputC dflags filenm flat_absC
96
  = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
97
       doOutput filenm (\ h -> writeRealC h flat_absC)
98 99 100 101 102 103 104 105 106 107
\end{code}


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

\begin{code}
108
outputAsm dflags filenm flat_absC
109

110
#ifndef OMIT_NATIVE_CODEGEN
111

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

#else /* OMIT_NATIVE_CODEGEN */

122 123
  = pprPanic "This compiler was built without a native code generator"
	     (text "Use -fvia-C instead")
124 125 126

#endif
\end{code}
127 128


129 130 131 132 133
%************************************************************************
%*									*
\subsection{Java}
%*									*
%************************************************************************
134

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

146 147 148 149 150 151 152 153

%************************************************************************
%*									*
\subsection{Foreign import/export}
%*									*
%************************************************************************

\begin{code}
154
outputForeignStubs dflags c_code h_code
155
  = do
156
	dumpIfSet_dyn dflags Opt_D_dump_foreign
157 158 159 160
                      "Foreign export header file" stub_h_output_d

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

162
	dumpIfSet_dyn dflags Opt_D_dump_foreign
163 164 165 166 167 168
                      "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)
169
  where
170 171 172 173 174 175 176 177 178
    -- 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


179 180 181
-- 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.
182 183
outputForeignStubs_help is_header ""      = return Nothing
outputForeignStubs_help is_header doc_str 
184 185 186
   = do fname <- newTempName suffix
        writeFile fname (include_prefix ++ doc_str)
        return (Just fname)
187 188 189 190 191
  where
    suffix
       | is_header   = "h_stub"
       | otherwise   = "c_stub"
    include_prefix
192
       | is_header   = "#include \"HsFFI.h\"\n"
193
       | otherwise   = "#include \"RtsAPI.h\"\n"
194 195
\end{code}