[project @ 2005-03-07 16:46:08 by simonpj]
[ghc-hetmet.git] / ghc / compiler / main / CodeOutput.lhs
index 727f771..b01b668 100644 (file)
@@ -4,11 +4,12 @@
 \section{Code output phase}
 
 \begin{code}
-module CodeOutput( codeOutput ) where
+module CodeOutput( codeOutput, outputForeignStubs ) where
 
 #include "HsVersions.h"
 
 #ifndef OMIT_NATIVE_CODEGEN
+import UniqSupply      ( mkSplitUniqSupply )
 import AsmCodeGen      ( nativeCodeGen )
 #endif
 
@@ -16,28 +17,33 @@ import AsmCodeGen   ( nativeCodeGen )
 import IlxGen          ( ilxGen )
 #endif
 
+#ifdef JAVA
 import JavaGen         ( javaGen )
 import qualified PrintJava
+import OccurAnal       ( occurAnalyseBinds )
+#endif
 
-import TyCon           ( TyCon )
-import Id              ( Id )
-import Class           ( Class )
-import CoreSyn         ( CoreBind )
-import StgSyn          ( StgBinding )
-import AbsCSyn         ( AbstractC )
-import PprAbsC         ( dumpRealC, writeRealC )
-import UniqSupply      ( UniqSupply )
-import Module          ( Module )
+import Distribution.Package    ( showPackageId )
+import PprC            ( writeCs )
+import CmmLint         ( cmmLint )
+import Packages
+import DriverUtil      ( filenameOf )
+import FastString      ( unpackFS )
+import Cmm             ( Cmm )
+import HscTypes
 import CmdLineOpts
-import ErrUtils                ( dumpIfSet_dyn )
+import ErrUtils                ( dumpIfSet_dyn, showPass, ghcExit )
 import Outputable
-import CmdLineOpts     ( DynFlags(..), HscLang(..) )
-import TmpFiles                ( newTmpName )
+import Pretty          ( Mode(..), printDoc )
+import Module          ( Module )
+import ListSetOps      ( removeDupsEq )
+import Maybes          ( firstJust )
 
-import IO              ( IOMode(..), hClose, openFile, Handle )
+import Directory       ( doesFileExist )
+import Monad           ( when )
+import IO
 \end{code}
 
-
 %************************************************************************
 %*                                                                     *
 \subsection{Steering}
@@ -47,39 +53,56 @@ import IO           ( IOMode(..), hClose, openFile, Handle )
 \begin{code}
 codeOutput :: DynFlags
           -> Module
-          -> [TyCon] -> [Class]        -- Local tycons and classes
-          -> [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
-          -> UniqSupply
-          -> IO (Maybe FilePath, Maybe FilePath)
-codeOutput dflags mod_name tycons classes core_binds stg_binds 
-          c_code h_code flat_abstractC ncg_uniqs
-  = -- You can have C (c_output) or assembly-language (ncg_output),
+          -> ForeignStubs
+          -> Dependencies
+          -> [Cmm]                     -- Compiled C--
+          -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
+
+codeOutput dflags this_mod foreign_stubs 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 stub_names <- outputForeignStubs c_code h_code
-       case dopt_HscLang dflags of
-          HscInterpreter -> return stub_names
-          HscAsm  filenm -> outputAsm dflags filenm flat_abstractC ncg_uniqs
-                            >> return stub_names
-          HscC    filenm -> outputC dflags filenm flat_abstractC       
-                            >> return stub_names
-          HscJava filenm -> outputJava dflags filenm mod_name tycons core_binds
-                            >> return stub_names
-
-doOutput :: (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))
+    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 1
+                                      }
+                       Nothing  -> return ()
+               }
+
+       ; showPass dflags "CodeOutput"
+       ; let filenm = dopt_OutName dflags 
+       ; stubs_exist <- outputForeignStubs dflags foreign_stubs
+       ; case dopt_HscTarget dflags of {
+             HscInterpreted -> return ();
+             HscAsm         -> outputAsm dflags filenm flat_abstractC;
+             HscC           -> outputC dflags filenm flat_abstractC stubs_exist
+                                       deps foreign_stubs;
+             HscJava        -> 
+#ifdef JAVA
+                              outputJava dflags filenm mod_name tycons core_binds;
+#else
+                               panic "Java support not compiled into this ghc";
+#endif
+            HscILX         -> 
+#ifdef ILX
+                              let tycons = typeEnvTyCons type_env in
+                              outputIlx dflags filenm mod_name tycons stg_binds;
+#else
+                               panic "ILX support not compiled into this ghc";
+#endif
+         }
+       ; return stubs_exist
+       }
+
+doOutput :: String -> (Handle -> IO ()) -> IO ()
+doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
 \end{code}
 
 
@@ -90,9 +113,46 @@ doOutput filenm io_action
 %************************************************************************
 
 \begin{code}
-outputC dflags filenm flat_absC
-  = do dumpIfSet_dyn Opt_D_dump_realC dflags "Real C" (dumpRealC flat_absC)
-       doOutput filenm (\ h -> writeRealC h flat_absC)
+outputC dflags filenm flat_absC 
+       (stub_h_exists, _) dependencies 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.
+       --
+       let packages = dep_pkgs dependencies
+       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 (fst (removeDupsEq 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 ("/* GHC_PACKAGES " ++ unwords pkg_names ++ "\n*/\n")
+         hPutStr h cc_injects
+         when stub_h_exists $ 
+            hPutStrLn h ("#include \"" ++ (filenameOf (hscStubHOutName dflags)) ++ "\"")
+         writeCs h flat_absC
 \end{code}
 
 
@@ -103,15 +163,17 @@ outputC dflags filenm flat_absC
 %************************************************************************
 
 \begin{code}
-outputAsm dflags filenm flat_absC ncg_uniqs
+outputAsm dflags filenm flat_absC
 
 #ifndef OMIT_NATIVE_CODEGEN
 
-  = do dumpIfSet_dyn Opt_D_dump_stix dflags "Final stix code" stix_final
-       dumpIfSet_dyn Opt_D_dump_asm dflags "Asm code" ncg_output_d
-       doOutput filenm ( \f -> printForAsm f ncg_output_d)
+  = do ncg_uniqs <- mkSplitUniqSupply 'n'
+       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
   where
-    (stix_final, ncg_output_d) = nativeCodeGen flat_absC ncg_uniqs
 
 #else /* OMIT_NATIVE_CODEGEN */
 
@@ -129,12 +191,32 @@ outputAsm dflags filenm flat_absC ncg_uniqs
 %************************************************************************
 
 \begin{code}
+#ifdef JAVA
 outputJava dflags filenm mod tycons core_binds
-  = doOutput filenm (\ f -> printForUser f pp_java)
+  = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
        -- User style printing for now to keep indentation
   where
-    java_code = javaGen mod [{- Should be imports-}] tycons core_binds
+    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
     pp_java   = PrintJava.compilationUnit java_code
+#endif
+\end{code}
+
+
+%************************************************************************
+%*                                                                     *
+\subsection{Ilx}
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+#ifdef ILX
+outputIlx dflags filename mod tycons stg_binds
+  =  doOutput filename (\ f -> printForC f pp_ilx)
+  where
+    pp_ilx = ilxGen mod tycons stg_binds
+#endif
 \end{code}
 
 
@@ -145,21 +227,48 @@ outputJava dflags filenm mod tycons core_binds
 %************************************************************************
 
 \begin{code}
-outputForeignStubs dflags c_code h_code
+outputForeignStubs :: DynFlags -> ForeignStubs
+                  -> IO (Bool,         -- Header file created
+                         Bool)         -- C file created
+outputForeignStubs dflags NoStubs = do
+-- When compiling External Core files, may need to use stub files from a 
+-- previous compilation
+   hFileExists <- doesFileExist (hscStubHOutName dflags)
+   cFileExists <- doesFileExist (hscStubCOutName dflags)
+   return (hFileExists, cFileExists)
+outputForeignStubs dflags (ForeignStubs h_code c_code _ _)
   = do
-       dumpIfSet_dyn Opt_D_dump_foreign dflags 
+       dumpIfSet_dyn dflags Opt_D_dump_foreign
                       "Foreign export header file" stub_h_output_d
 
-       maybe_stub_h_file
-           <- outputForeignStubs_help True{-.h output-} stub_h_output_w
+       -- 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"
 
-       dumpIfSet_dyn Opt_D_dump_foreign dflags 
-                      "Foreign export stubs" stub_c_output_d
+       stub_h_file_exists
+           <- outputForeignStubs_help (hscStubHOutName dflags) stub_h_output_w
+               ("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
 
-        maybe_stub_c_file
-           <- outputForeignStubs_help False{-not .h-} stub_c_output_w
+       dumpIfSet_dyn dflags Opt_D_dump_foreign
+                      "Foreign export stubs" stub_c_output_d
 
-        return (maybe_stub_h_file, maybe_stub_c_file)
+       stub_c_file_exists
+           <- outputForeignStubs_help (hscStubCOutName dflags) stub_c_output_w
+               ("#define IN_STG_CODE 0\n" ++ 
+                "#include \"Rts.h\"\n" ++
+                rts_includes ++
+                cplusplus_hdr)
+                cplusplus_ftr
+          -- 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
@@ -169,23 +278,15 @@ outputForeignStubs dflags c_code h_code
     stub_h_output_d = pprCode CStyle h_code
     stub_h_output_w = showSDoc stub_h_output_d
 
+cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
+cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
 
 -- 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.
-outputForeignStubs_help is_header switch ""      = return Nothing
-outputForeignStubs_help is_header switch doc_str =
-  case switch of
-    Nothing    -> return Nothing
-    Just fname -> newTempName suffix >>= \ fname ->
-                  writeFile fname (include_prefix ++ doc_str) >>
-                  return (Just suffix)
-  where
-    suffix
-       | is_header   = "h_stub"
-       | otherwise   = "c_stub"
-    include_prefix
-       | is_header   = "#include \"Rts.h\"\n"
-       | otherwise   = "#include \"RtsAPI.h\"\n"
+outputForeignStubs_help fname ""      header footer = return False
+outputForeignStubs_help fname doc_str header footer
+   = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")
+        return True
 \end{code}