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