-fno-code shouldn't be a mode.
[ghc-hetmet.git] / ghc / compiler / main / CodeOutput.lhs
index 3953410..0148ca4 100644 (file)
@@ -4,7 +4,7 @@
 \section{Code output phase}
 
 \begin{code}
-module CodeOutput( codeOutput ) where
+module CodeOutput( codeOutput, outputForeignStubs ) where
 
 #include "HsVersions.h"
 
@@ -20,29 +20,31 @@ import IlxGen               ( ilxGen )
 #ifdef JAVA
 import JavaGen         ( javaGen )
 import qualified PrintJava
+import OccurAnal       ( occurAnalyseBinds )
 #endif
 
-import DriverState     ( v_HCHeader )
-import TyCon           ( TyCon )
-import Id              ( Id )
-import CoreSyn         ( CoreBind )
-import OccurAnal       ( occurAnalyseBinds )
-import StgSyn          ( StgBinding )
-import AbsCSyn         ( AbstractC )
-import PprAbsC         ( dumpRealC, writeRealC )
-import Module          ( Module )
-import CmdLineOpts
-import ErrUtils                ( dumpIfSet_dyn, showPass )
+import Finder          ( mkStubPaths )
+import PprC            ( writeCs )
+import CmmLint         ( cmmLint )
+import Packages
+import Util
+import FastString      ( unpackFS )
+import Cmm             ( Cmm )
+import HscTypes
+import DynFlags
+import ErrUtils                ( dumpIfSet_dyn, showPass, ghcExit )
 import Outputable
 import Pretty          ( Mode(..), printDoc )
-import CmdLineOpts     ( DynFlags, HscLang(..), dopt_OutName )
+import Module          ( Module, ModLocation(..) )
+import List            ( nub )
+import Maybes          ( firstJust )
 
-import IOExts
+import Distribution.Package    ( showPackageId )
+import Directory       ( doesFileExist )
 import Monad           ( when )
 import IO
 \end{code}
 
-
 %************************************************************************
 %*                                                                     *
 \subsection{Steering}
@@ -52,53 +54,59 @@ import IO
 \begin{code}
 codeOutput :: DynFlags
           -> Module
-          -> [TyCon]                   -- Local tycons
-          -> [CoreBind]                -- Core bindings
-          -> [(StgBinding,[Id])]       -- The STG program with SRTs
-          -> SDoc              -- C stubs for foreign exported functions
-          -> SDoc              -- Header file prototype for foreign exported functions
-          -> AbstractC         -- Compiled abstract C
+          -> ModLocation
+          -> ForeignStubs
+          -> [PackageId]
+          -> [Cmm]                     -- Compiled C--
           -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
-codeOutput dflags mod_name tycons core_binds stg_binds 
-          c_code h_code flat_abstractC
-  = -- You can have C (c_output) or assembly-language (ncg_output),
+
+codeOutput dflags this_mod location foreign_stubs pkg_deps flat_abstractC
+  = 
+    -- 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]
 
     -- Dunno if the above comment is still meaningful now.  JRS 001024.
 
-    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 stub_names
-                              >> return stub_names
+    do { when (dopt Opt_DoCmmLinting dflags) $ do
+               { showPass dflags "CmmLint"
+               ; let lints = map cmmLint flat_abstractC
+               ; case firstJust lints of
+                       Just err -> do { printDump err
+                                      ; ghcExit dflags 1
+                                      }
+                       Nothing  -> return ()
+               }
+
+       ; showPass dflags "CodeOutput"
+       ; let filenm = hscOutName dflags 
+       ; stubs_exist <- outputForeignStubs dflags this_mod location foreign_stubs
+       ; case hscTarget dflags of {
+             HscInterpreted -> return ();
+             HscAsm         -> outputAsm dflags filenm flat_abstractC;
+             HscC           -> outputC dflags filenm this_mod location 
+                                flat_abstractC stubs_exist pkg_deps
+                                foreign_stubs;
              HscJava        -> 
 #ifdef JAVA
-                              outputJava dflags filenm mod_name tycons core_binds
-                              >> return stub_names
+                              outputJava dflags filenm mod_name tycons core_binds;
 #else
-                               panic "Java support not compiled into this ghc"
+                               panic "Java support not compiled into this ghc";
 #endif
             HscILX         -> 
 #ifdef ILX
-                              outputIlx dflags filenm mod_name tycons stg_binds
-                              >> return stub_names
+                              let tycons = typeEnvTyCons type_env in
+                              outputIlx dflags filenm mod_name tycons stg_binds;
 #else
-                               panic "ILX support not compiled into this ghc"
+                               panic "ILX support not compiled into this ghc";
 #endif
+             HscNothing     -> return ();
+         }
+       ; return stubs_exist
        }
 
 doOutput :: String -> (Handle -> IO ()) -> IO ()
-doOutput filenm io_action
-  = (do        handle <- openFile filenm WriteMode
-       io_action handle
-       hClose handle)
-    `catch` (\err -> pprPanic "Failed to open or write code output file" 
-                             (text filenm))
+doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
 \end{code}
 
 
@@ -109,14 +117,47 @@ doOutput filenm io_action
 %************************************************************************
 
 \begin{code}
-outputC dflags filenm flat_absC (stub_h_exists, _)
-  = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
-       header <- readIORef v_HCHeader
+outputC dflags filenm mod location flat_absC 
+       (stub_h_exists, _) packages foreign_stubs
+  = do 
+       -- figure out which header files to #include in the generated .hc file:
+       --
+       --   * extra_includes from packages
+       --   * -#include options from the cmdline and OPTIONS pragmas
+       --   * the _stub.h file, if there is one.
+       --
+       pkg_configs <- getExplicitPackagesAnd dflags packages
+       let pkg_names = map (showPackageId.package) pkg_configs
+
+       c_includes <- getPackageCIncludes pkg_configs
+       let cmdline_includes = cmdlineHcIncludes dflags -- -#include options
+       
+          ffi_decl_headers 
+             = case foreign_stubs of
+                 NoStubs                 -> []
+                 ForeignStubs _ _ fdhs _ -> map unpackFS (nub fdhs)
+                       -- Remove duplicates, because distinct foreign import decls
+                       -- may cite the same #include.  Order doesn't matter.
+
+           all_headers =  c_includes
+                      ++ reverse cmdline_includes
+                      ++ ffi_decl_headers
+
+       let cc_injects = unlines (map mk_include all_headers)
+                  mk_include h_file = 
+                   case h_file of 
+                      '"':_{-"-} -> "#include "++h_file
+                      '<':_      -> "#include "++h_file
+                      _          -> "#include \""++h_file++"\""
+
        doOutput filenm $ \ h -> do
-         hPutStr h header
+         hPutStr h ("/* GHC_PACKAGES " ++ unwords pkg_names ++ "\n*/\n")
+         hPutStr h cc_injects
          when stub_h_exists $ 
-            hPutStrLn h ("#include \"" ++ (hscStubHOutName dflags) ++ "\"")
-         writeRealC h flat_absC
+            hPutStrLn h ("#include \"" ++ (filenameOf stub_h) ++ "\"")
+         writeCs dflags h flat_absC
+  where
+    (_, stub_h) = mkStubPaths dflags mod location
 \end{code}
 
 
@@ -132,9 +173,8 @@ outputAsm dflags filenm flat_absC
 #ifndef OMIT_NATIVE_CODEGEN
 
   = do ncg_uniqs <- mkSplitUniqSupply 'n'
-       let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen" 
-                                       nativeCodeGen flat_absC ncg_uniqs
-       dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
+       ncg_output_d <- _scc_ "NativeCodeGen" 
+                         nativeCodeGen dflags flat_absC ncg_uniqs
        dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" (docToSDoc ncg_output_d)
        _scc_ "OutputAsm" doOutput filenm $
           \f -> printDoc LeftMode f ncg_output_d
@@ -192,40 +232,63 @@ outputIlx dflags filename mod tycons stg_binds
 %************************************************************************
 
 \begin{code}
-outputForeignStubs dflags c_code h_code
+outputForeignStubs :: DynFlags -> Module -> ModLocation -> ForeignStubs
+                  -> IO (Bool,         -- Header file created
+                         Bool)         -- C file created
+outputForeignStubs dflags mod location stubs
+  | NoStubs <- stubs = do
+       -- When compiling External Core files, may need to use stub
+       -- files from a previous compilation
+       stub_c_exists <- doesFileExist stub_c
+       stub_h_exists <- doesFileExist stub_h
+       return (stub_h_exists, stub_c_exists)
+
+  | ForeignStubs h_code c_code _ _ <- stubs
   = do
+       let
+           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
+       -- in
+
+       createDirectoryHierarchy (directoryOf stub_c)
+
        dumpIfSet_dyn dflags Opt_D_dump_foreign
                       "Foreign export header file" stub_h_output_d
 
+       -- we need the #includes from the rts package for the stub files
+       let rtsid = rtsPackageId (pkgState dflags)
+           rts_includes 
+               | ExtPackage pid <- rtsid = 
+                       let rts_pkg = getPackageDetails (pkgState dflags) pid in
+                       concatMap mk_include (includes rts_pkg)
+               | otherwise = []
+           mk_include i = "#include \"" ++ i ++ "\"\n"
+
        stub_h_file_exists
-           <- outputForeignStubs_help (hscStubHOutName dflags) stub_h_output_w
+           <- outputForeignStubs_help stub_h stub_h_output_w
                ("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
 
        dumpIfSet_dyn dflags Opt_D_dump_foreign
                       "Foreign export stubs" stub_c_output_d
 
-        hc_header <- readIORef v_HCHeader
-
        stub_c_file_exists
-           <- outputForeignStubs_help (hscStubCOutName dflags) stub_c_output_w
+           <- outputForeignStubs_help stub_c stub_c_output_w
                ("#define IN_STG_CODE 0\n" ++ 
-                hc_header ++
-                "#include \"RtsAPI.h\"\n" ++
+                "#include \"Rts.h\"\n" ++
+                rts_includes ++
                 cplusplus_hdr)
                 cplusplus_ftr
-          -- we're adding the default hc_header to the stub file, but this
+          -- We're adding the default hc_header to the stub file, but this
           -- isn't really HC code, so we need to define IN_STG_CODE==0 to
           -- avoid the register variables etc. being enabled.
 
         return (stub_h_file_exists, stub_c_file_exists)
   where
-    -- 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
+   (stub_c, stub_h) = mkStubPaths dflags mod location
 
 cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
 cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"