ghc/compiler/main/CodeOutput.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
   3 %
   4 \section{Code output phase}
   5
   6 \begin{code}
   7 module CodeOutput( codeOutput, outputForeignStubs ) where
   8
   9 #include "HsVersions.h"
  10
  11 #ifndef OMIT_NATIVE_CODEGEN
  12 import UniqSupply       ( mkSplitUniqSupply )
  13 import AsmCodeGen       ( nativeCodeGen )
  14 #endif
  15
  16 #ifdef ILX
  17 import IlxGen           ( ilxGen )
  18 #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 Module           ( Module )
  38 import ListSetOps       ( removeDupsEq )
  39
  40 import Directory ( doesFileExist )
  41 import Monad            ( when )
  42 import IO
  43 \end{code}
  44
  45
  46 %************************************************************************
  47 %*                                                                      *
  48 \subsection{Steering}
  49 %*                                                                      *
  50 %************************************************************************
  51
  52 \begin{code}
  53 codeOutput :: DynFlags
  54            -> Module
  55            -> ForeignStubs
  56            -> Dependencies
  57            -> AbstractC                 -- Compiled abstract C
  58            -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
  59
  60 codeOutput dflags this_mod foreign_stubs deps flat_abstractC
  61   =
  62     -- You can have C (c_output) or assembly-language (ncg_output),
  63     -- but not both.  [Allowing for both gives a space leak on
  64     -- flat_abstractC.  WDP 94/10]
  65
  66     -- Dunno if the above comment is still meaningful now.  JRS 001024.
  67
  68     do  { showPass dflags "CodeOutput"
  69         ; let filenm = dopt_OutName dflags
  70         ; stubs_exist <- outputForeignStubs dflags foreign_stubs
  71         ; case dopt_HscLang dflags of {
  72              HscInterpreted -> return ();
  73              HscAsm         -> outputAsm dflags filenm flat_abstractC;
  74              HscC           -> outputC dflags filenm flat_abstractC stubs_exist
  75                                         deps foreign_stubs;
  76              HscJava        ->
  77 #ifdef JAVA
  78                                outputJava dflags filenm mod_name tycons core_binds;
  79 #else
  80                                panic "Java support not compiled into this ghc";
  81 #endif
  82              HscILX         ->
  83 #ifdef ILX
  84                                let tycons = typeEnvTyCons type_env in
  85                                outputIlx dflags filenm mod_name tycons stg_binds;
  86 #else
  87                                panic "ILX support not compiled into this ghc";
  88 #endif
  89           }
  90         ; return stubs_exist
  91         }
  92
  93 doOutput :: String -> (Handle -> IO ()) -> IO ()
  94 doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
  95 \end{code}
  96
  97
  98 %************************************************************************
  99 %*                                                                      *
 100 \subsection{C}
 101 %*                                                                      *
 102 %************************************************************************
 103
 104 \begin{code}
 105 outputC dflags filenm flat_absC
 106         (stub_h_exists, _) dependencies foreign_stubs
 107   = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
 108
 109        -- figure out which header files to #include in the generated .hc file:
 110        --
 111        --   * extra_includes from packages
 112        --   * -#include options from the cmdline and OPTIONS pragmas
 113        --   * the _stub.h file, if there is one.
 114        --
 115        let packages = dep_pkgs dependencies
 116        pkg_configs <- getExplicitPackagesAnd packages
 117        let pkg_names = map name pkg_configs
 118
 119        c_includes <- getPackageCIncludes pkg_configs
 120        let cmdline_includes = cmdlineHcIncludes dflags -- -#include options
 121
 122            ffi_decl_headers
 123               = case foreign_stubs of
 124                   NoStubs                 -> []
 125                   ForeignStubs _ _ fdhs _ -> map unpackFS (fst (removeDupsEq fdhs))
 126                         -- Remove duplicates, because distinct foreign import decls
 127                         -- may cite the same #include.  Order doesn't matter.
 128
 129            all_headers =  c_includes
 130                        ++ reverse cmdline_includes
 131                        ++ ffi_decl_headers
 132
 133        let cc_injects = unlines (map mk_include all_headers)
 134            mk_include h_file =
 135             case h_file of
 136                '"':_{-"-} -> "#include "++h_file
 137                '<':_      -> "#include "++h_file
 138                _          -> "#include \""++h_file++"\""
 139
 140        doOutput filenm $ \ h -> do
 141           hPutStr h ("/* GHC_PACKAGES " ++ unwords pkg_names ++ "\n*/\n")
 142           hPutStr h cc_injects
 143           when stub_h_exists $
 144              hPutStrLn h ("#include \"" ++ (hscStubHOutName dflags) ++ "\"")
 145           writeRealC h flat_absC
 146 \end{code}
 147
 148
 149 %************************************************************************
 150 %*                                                                      *
 151 \subsection{Assembler}
 152 %*                                                                      *
 153 %************************************************************************
 154
 155 \begin{code}
 156 outputAsm dflags filenm flat_absC
 157
 158 #ifndef OMIT_NATIVE_CODEGEN
 159
 160   = do ncg_uniqs <- mkSplitUniqSupply 'n'
 161        let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen"
 162                                         nativeCodeGen flat_absC ncg_uniqs
 163        dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
 164        dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" (docToSDoc ncg_output_d)
 165        _scc_ "OutputAsm" doOutput filenm $
 166            \f -> printDoc LeftMode f ncg_output_d
 167   where
 168
 169 #else /* OMIT_NATIVE_CODEGEN */
 170
 171   = pprPanic "This compiler was built without a native code generator"
 172              (text "Use -fvia-C instead")
 173
 174 #endif
 175 \end{code}
 176
 177
 178 %************************************************************************
 179 %*                                                                      *
 180 \subsection{Java}
 181 %*                                                                      *
 182 %************************************************************************
 183
 184 \begin{code}
 185 #ifdef JAVA
 186 outputJava dflags filenm mod tycons core_binds
 187   = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
 188         -- User style printing for now to keep indentation
 189   where
 190     occ_anal_binds = occurAnalyseBinds core_binds
 191         -- Make sure we have up to date dead-var information
 192     java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
 193     pp_java   = PrintJava.compilationUnit java_code
 194 #endif
 195 \end{code}
 196
 197
 198 %************************************************************************
 199 %*                                                                      *
 200 \subsection{Ilx}
 201 %*                                                                      *
 202 %************************************************************************
 203
 204 \begin{code}
 205 #ifdef ILX
 206 outputIlx dflags filename mod tycons stg_binds
 207   =  doOutput filename (\ f -> printForC f pp_ilx)
 208   where
 209     pp_ilx = ilxGen mod tycons stg_binds
 210 #endif
 211 \end{code}
 212
 213
 214 %************************************************************************
 215 %*                                                                      *
 216 \subsection{Foreign import/export}
 217 %*                                                                      *
 218 %************************************************************************
 219
 220 \begin{code}
 221 outputForeignStubs :: DynFlags -> ForeignStubs
 222                    -> IO (Bool,         -- Header file created
 223                           Bool)         -- C file created
 224 outputForeignStubs dflags NoStubs = do
 225 -- When compiling External Core files, may need to use stub files from a
 226 -- previous compilation
 227    hFileExists <- doesFileExist (hscStubHOutName dflags)
 228    cFileExists <- doesFileExist (hscStubCOutName dflags)
 229    return (hFileExists, cFileExists)
 230 outputForeignStubs dflags (ForeignStubs h_code c_code _ _)
 231   = do
 232         dumpIfSet_dyn dflags Opt_D_dump_foreign
 233                       "Foreign export header file" stub_h_output_d
 234
 235         -- we need the #includes from the rts package for the stub files
 236         rts_pkgs <- getPackageDetails [rtsPackage]
 237         let rts_includes = concatMap mk_include (concatMap c_includes rts_pkgs)
 238             mk_include i = "#include \"" ++ i ++ "\"\n"
 239
 240         stub_h_file_exists
 241            <- outputForeignStubs_help (hscStubHOutName dflags) stub_h_output_w
 242                 ("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
 243
 244         dumpIfSet_dyn dflags Opt_D_dump_foreign
 245                       "Foreign export stubs" stub_c_output_d
 246
 247         stub_c_file_exists
 248            <- outputForeignStubs_help (hscStubCOutName dflags) stub_c_output_w
 249                 ("#define IN_STG_CODE 0\n" ++
 250                  "#include \"RtsAPI.h\"\n" ++
 251                  rts_includes ++
 252                  cplusplus_hdr)
 253                  cplusplus_ftr
 254            -- We're adding the default hc_header to the stub file, but this
 255            -- isn't really HC code, so we need to define IN_STG_CODE==0 to
 256            -- avoid the register variables etc. being enabled.
 257
 258         return (stub_h_file_exists, stub_c_file_exists)
 259   where
 260     -- C stubs for "foreign export"ed functions.
 261     stub_c_output_d = pprCode CStyle c_code
 262     stub_c_output_w = showSDoc stub_c_output_d
 263
 264     -- Header file protos for "foreign export"ed functions.
 265     stub_h_output_d = pprCode CStyle h_code
 266     stub_h_output_w = showSDoc stub_h_output_d
 267
 268 cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
 269 cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
 270
 271 -- Don't use doOutput for dumping the f. export stubs
 272 -- since it is more than likely that the stubs file will
 273 -- turn out to be empty, in which case no file should be created.
 274 outputForeignStubs_help fname ""      header footer = return False
 275 outputForeignStubs_help fname doc_str header footer
 276    = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")
 277         return True
 278 \end{code}
 279