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 JAVA
  17 import JavaGen          ( javaGen )
  18 import qualified PrintJava
  19 import OccurAnal        ( occurAnalyseBinds )
  20 #endif
  21
  22 import Finder           ( mkStubPaths )
  23 import PprC             ( writeCs )
  24 import CmmLint          ( cmmLint )
  25 import Packages
  26 import PackageConfig    ( rtsPackageId )
  27 import Util
  28 import FastString       ( unpackFS )
  29 import Cmm              ( Cmm )
  30 import HscTypes
  31 import DynFlags
  32
  33 import StaticFlags      ( opt_DoTickyProfiling )
  34
  35 import ErrUtils         ( dumpIfSet_dyn, showPass, ghcExit )
  36 import Outputable
  37 import Pretty           ( Mode(..), printDoc )
  38 import Module           ( Module, ModLocation(..), moduleName )
  39 import List             ( nub )
  40 import Maybes           ( firstJust )
  41
  42 import Distribution.Package     ( showPackageId )
  43 import Directory        ( doesFileExist )
  44 import Monad            ( when )
  45 import IO
  46 \end{code}
  47
  48 %************************************************************************
  49 %*                                                                      *
  50 \subsection{Steering}
  51 %*                                                                      *
  52 %************************************************************************
  53
  54 \begin{code}
  55 codeOutput :: DynFlags
  56            -> Module
  57            -> ModLocation
  58            -> ForeignStubs
  59            -> [PackageId]
  60            -> [Cmm]                     -- Compiled C--
  61            -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
  62
  63 codeOutput dflags this_mod location foreign_stubs pkg_deps flat_abstractC
  64   =
  65     -- You can have C (c_output) or assembly-language (ncg_output),
  66     -- but not both.  [Allowing for both gives a space leak on
  67     -- flat_abstractC.  WDP 94/10]
  68
  69     -- Dunno if the above comment is still meaningful now.  JRS 001024.
  70
  71     do  { when (dopt Opt_DoCmmLinting dflags) $ do
  72                 { showPass dflags "CmmLint"
  73                 ; let lints = map cmmLint flat_abstractC
  74                 ; case firstJust lints of
  75                         Just err -> do { printDump err
  76                                        ; ghcExit dflags 1
  77                                        }
  78                         Nothing  -> return ()
  79                 }
  80
  81         ; showPass dflags "CodeOutput"
  82         ; let filenm = hscOutName dflags
  83         ; stubs_exist <- outputForeignStubs dflags this_mod location foreign_stubs
  84         ; case hscTarget dflags of {
  85              HscInterpreted -> return ();
  86              HscAsm         -> outputAsm dflags filenm flat_abstractC;
  87              HscC           -> outputC dflags filenm this_mod location
  88                                  flat_abstractC stubs_exist pkg_deps
  89                                  foreign_stubs;
  90              HscJava        ->
  91 #ifdef JAVA
  92                                outputJava dflags filenm mod_name tycons core_binds;
  93 #else
  94                                panic "Java support not compiled into this ghc";
  95 #endif
  96           }
  97         ; return stubs_exist
  98         }
  99
 100 doOutput :: String -> (Handle -> IO ()) -> IO ()
 101 doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
 102 \end{code}
 103
 104
 105 %************************************************************************
 106 %*                                                                      *
 107 \subsection{C}
 108 %*                                                                      *
 109 %************************************************************************
 110
 111 \begin{code}
 112 outputC dflags filenm mod location flat_absC
 113         (stub_h_exists, _) packages foreign_stubs
 114   = do
 115        -- figure out which header files to #include in the generated .hc file:
 116        --
 117        --   * extra_includes from packages
 118        --   * -#include options from the cmdline and OPTIONS pragmas
 119        --   * the _stub.h file, if there is one.
 120        --
 121        pkg_configs <- getPreloadPackagesAnd dflags packages
 122        let pkg_names = map (showPackageId.package) pkg_configs
 123
 124        c_includes <- getPackageCIncludes pkg_configs
 125        let cmdline_includes = cmdlineHcIncludes dflags -- -#include options
 126
 127            ffi_decl_headers
 128               = case foreign_stubs of
 129                   NoStubs                 -> []
 130                   ForeignStubs _ _ fdhs _ -> map unpackFS (nub fdhs)
 131                         -- Remove duplicates, because distinct foreign import decls
 132                         -- may cite the same #include.  Order doesn't matter.
 133
 134            all_headers =  c_includes
 135                        ++ reverse cmdline_includes
 136                        ++ ffi_decl_headers
 137
 138        let cc_injects = unlines (map mk_include all_headers)
 139            mk_include h_file =
 140             case h_file of
 141                '"':_{-"-} -> "#include "++h_file
 142                '<':_      -> "#include "++h_file
 143                _          -> "#include \""++h_file++"\""
 144
 145        doOutput filenm $ \ h -> do
 146           hPutStr h ("/* GHC_PACKAGES " ++ unwords pkg_names ++ "\n*/\n")
 147           hPutStr h cc_injects
 148           when stub_h_exists $
 149              hPutStrLn h ("#include \"" ++ (filenameOf stub_h) ++ "\"")
 150           writeCs dflags h flat_absC
 151   where
 152     (_, stub_h) = mkStubPaths dflags (moduleName mod) location
 153 \end{code}
 154
 155
 156 %************************************************************************
 157 %*                                                                      *
 158 \subsection{Assembler}
 159 %*                                                                      *
 160 %************************************************************************
 161
 162 \begin{code}
 163 outputAsm dflags filenm flat_absC
 164
 165 #ifndef OMIT_NATIVE_CODEGEN
 166
 167   = do ncg_uniqs <- mkSplitUniqSupply 'n'
 168        ncg_output_d <- _scc_ "NativeCodeGen"
 169                           nativeCodeGen dflags flat_absC ncg_uniqs
 170        dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" (docToSDoc ncg_output_d)
 171        _scc_ "OutputAsm" doOutput filenm $
 172            \f -> printDoc LeftMode f ncg_output_d
 173   where
 174
 175 #else /* OMIT_NATIVE_CODEGEN */
 176
 177   = pprPanic "This compiler was built without a native code generator"
 178              (text "Use -fvia-C instead")
 179
 180 #endif
 181 \end{code}
 182
 183
 184 %************************************************************************
 185 %*                                                                      *
 186 \subsection{Java}
 187 %*                                                                      *
 188 %************************************************************************
 189
 190 \begin{code}
 191 #ifdef JAVA
 192 outputJava dflags filenm mod tycons core_binds
 193   = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
 194         -- User style printing for now to keep indentation
 195   where
 196     occ_anal_binds = occurAnalyseBinds core_binds
 197         -- Make sure we have up to date dead-var information
 198     java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
 199     pp_java   = PrintJava.compilationUnit java_code
 200 #endif
 201 \end{code}
 202
 203
 204 %************************************************************************
 205 %*                                                                      *
 206 \subsection{Foreign import/export}
 207 %*                                                                      *
 208 %************************************************************************
 209
 210 \begin{code}
 211 outputForeignStubs :: DynFlags -> Module -> ModLocation -> ForeignStubs
 212                    -> IO (Bool,         -- Header file created
 213                           Bool)         -- C file created
 214 outputForeignStubs dflags mod location stubs
 215   | NoStubs <- stubs = do
 216         -- When compiling External Core files, may need to use stub
 217         -- files from a previous compilation
 218         stub_c_exists <- doesFileExist stub_c
 219         stub_h_exists <- doesFileExist stub_h
 220         return (stub_h_exists, stub_c_exists)
 221
 222   | ForeignStubs h_code c_code _ _ <- stubs
 223   = do
 224         let
 225             stub_c_output_d = pprCode CStyle c_code
 226             stub_c_output_w = showSDoc stub_c_output_d
 227
 228             -- Header file protos for "foreign export"ed functions.
 229             stub_h_output_d = pprCode CStyle h_code
 230             stub_h_output_w = showSDoc stub_h_output_d
 231         -- in
 232
 233         createDirectoryHierarchy (directoryOf stub_c)
 234
 235         dumpIfSet_dyn dflags Opt_D_dump_foreign
 236                       "Foreign export header file" stub_h_output_d
 237
 238         -- we need the #includes from the rts package for the stub files
 239         let rts_includes =
 240                let rts_pkg = getPackageDetails (pkgState dflags) rtsPackageId in
 241                concatMap mk_include (includes rts_pkg)
 242             mk_include i = "#include \"" ++ i ++ "\"\n"
 243
 244         stub_h_file_exists
 245            <- outputForeignStubs_help stub_h stub_h_output_w
 246                 ("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
 247
 248         dumpIfSet_dyn dflags Opt_D_dump_foreign
 249                       "Foreign export stubs" stub_c_output_d
 250
 251         stub_c_file_exists
 252            <- outputForeignStubs_help stub_c stub_c_output_w
 253                 ("#define IN_STG_CODE 0\n" ++
 254                  "#include \"Rts.h\"\n" ++
 255                  rts_includes ++
 256                  cplusplus_hdr)
 257                  cplusplus_ftr
 258            -- We're adding the default hc_header to the stub file, but this
 259            -- isn't really HC code, so we need to define IN_STG_CODE==0 to
 260            -- avoid the register variables etc. being enabled.
 261
 262         return (stub_h_file_exists, stub_c_file_exists)
 263   where
 264    (stub_c, stub_h) = mkStubPaths dflags (moduleName mod) location
 265
 266 cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
 267 cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
 268
 269 -- Don't use doOutput for dumping the f. export stubs
 270 -- since it is more than likely that the stubs file will
 271 -- turn out to be empty, in which case no file should be created.
 272 outputForeignStubs_help fname ""      header footer = return False
 273 outputForeignStubs_help fname doc_str header footer
 274    = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")
 275         return True
 276 \end{code}
 277