[project @ 2001-05-24 15:10:19 by dsyme]
[ghc-hetmet.git] / ghc / compiler / main / DriverPipeline.hs
index d0bb19a..22ab424 100644 (file)
@@ -1,5 +1,5 @@
 -----------------------------------------------------------------------------
--- $Id: DriverPipeline.hs,v 1.49 2001/01/19 15:26:37 simonmar Exp $
+-- $Id: DriverPipeline.hs,v 1.69 2001/05/24 15:10:19 dsyme Exp $
 --
 -- GHC Driver
 --
@@ -36,6 +36,7 @@ import DriverPhases
 import DriverFlags
 import HscMain
 import TmpFiles
+import Finder
 import HscTypes
 import Outputable
 import Module
@@ -93,14 +94,14 @@ getGhcMode flags
        ([]   , rest) -> return (rest, DoLink,  "") -- default is to do linking
        ([(flag,one)], rest) -> return (rest, one, flag)
        (_    , _   ) -> 
-         throwDyn (OtherError 
+         throwDyn (UsageError 
                "only one of the flags -M, -E, -C, -S, -c, --make, --interactive, -mk-dll is allowed")
 
 -----------------------------------------------------------------------------
 -- genPipeline
 --
 -- Herein is all the magic about which phases to run in which order, whether
--- the intermediate files should be in /tmp or in the current directory,
+-- the intermediate files should be in TMPDIR or in the current directory,
 -- what the suffix of the intermediate files should be, etc.
 
 -- The following compilation pipeline algorithm is fairly hacky.  A
@@ -148,6 +149,7 @@ genPipeline todo stop_flag persistent_output lang filename
    keep_raw_s <- readIORef v_Keep_raw_s_files
    keep_s     <- readIORef v_Keep_s_files
    osuf       <- readIORef v_Object_suf
+   hcsuf      <- readIORef v_HC_suf
 
    let
    ----------- -----  ----   ---   --   --  -  -  -
@@ -163,8 +165,8 @@ genPipeline todo stop_flag persistent_output lang filename
     cish = cish_suffix suffix
 
        -- for a .hc file we need to force lang to HscC
-    real_lang | start_phase == HCc  = HscC
-             | otherwise           = lang
+    real_lang | start_phase == HCc || start_phase == Mangle = HscC
+             | otherwise                                   = lang
 
    let
    ----------- -----  ----   ---   --   --  -  -  -
@@ -184,26 +186,29 @@ genPipeline todo stop_flag persistent_output lang filename
 
        HscJava | split           -> not_valid
                | otherwise       -> error "not implemented: compiling via Java"
+       HscILX  | split           -> not_valid
+               | otherwise       -> [ Unlit, Cpp, Hsc ]
 
       | cish      = [ Cc, As ]
 
       | otherwise = [ ]  -- just pass this file through to the linker
 
        -- ToDo: this is somewhat cryptic
-    not_valid = throwDyn (OtherError ("invalid option combination"))
+
+    not_valid = throwDyn (UsageError ("invalid option combination"))
    ----------- -----  ----   ---   --   --  -  -  -
 
        -- this shouldn't happen.
    if start_phase /= Ln && start_phase `notElem` pipeline
-       then throwDyn (OtherError ("can't find starting phase for "
-                                   ++ filename))
+       then throwDyn (CmdLineError ("can't find starting phase for "
+                                    ++ filename))
        else do
 
    let
-   ----------- -----  ----   ---   --   --  -  -  -
-      myPhaseInputExt Ln = case osuf of Nothing -> phaseInputExt Ln
-                                       Just s  -> s
-      myPhaseInputExt other = phaseInputExt other
+       -- .o and .hc suffixes can be overriden by command-line options:
+      myPhaseInputExt Ln  | Just s <- osuf  = s
+      myPhaseInputExt HCc | Just s <- hcsuf = s
+      myPhaseInputExt other                 = phaseInputExt other
 
       annotatePipeline
         :: [Phase]             -- raw pipeline
@@ -235,7 +240,8 @@ genPipeline todo stop_flag persistent_output lang filename
                        StopBefore phase      -> phase
                        DoMkDependHS          -> Ln
                        DoLink                -> Ln
-      annotated_pipeline = annotatePipeline (pipeline ++ [ Ln ]) stop_phase
+
+      annotated_pipeline = annotatePipeline (pipeline ++ [Ln]) stop_phase
 
       phase_ne p (p1,_,_) = (p1 /= p)
    ----------- -----  ----   ---   --   --  -  -  -
@@ -246,7 +252,7 @@ genPipeline todo stop_flag persistent_output lang filename
        -- is already in linkable form (for example).
    if start_phase `elem` pipeline && 
        (stop_phase /= Ln && stop_phase `notElem` pipeline)
-      then throwDyn (OtherError 
+      then throwDyn (UsageError 
                ("flag " ++ stop_flag
                 ++ " is incompatible with source file `" ++ filename ++ "'"))
       else do
@@ -315,12 +321,7 @@ run_phase Unlit _basename _suff input_fn output_fn
 run_phase Cpp basename suff input_fn output_fn
   = do src_opts <- getOptionsFromSource input_fn
        unhandled_flags <- processArgs dynamic_flags src_opts []
-
-       when (not (null unhandled_flags)) 
-            (throwDyn (OtherError (
-                          basename ++ "." ++ suff 
-                          ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
-                          ++ unwords unhandled_flags)) (ExitFailure 1))
+       checkProcessArgsResult unhandled_flags basename suff
 
        do_cpp <- dynFlag cppFlag
        if do_cpp
@@ -335,6 +336,7 @@ run_phase Cpp basename suff input_fn output_fn
                                                        ++ pkg_include_dirs)
 
            verb <- getVerbFlag
+           (md_c_flags, _) <- machdepCCOpts
 
            runSomething "C pre-processor" 
                (unwords
@@ -343,6 +345,7 @@ run_phase Cpp basename suff input_fn output_fn
                    ++ include_paths
                    ++ hs_src_cpp_opts
                    ++ hscpp_opts
+                   ++ md_c_flags
                    ++ [ "-x", "c", input_fn, ">>", output_fn ]
                   ))
          else do
@@ -359,8 +362,9 @@ run_phase MkDependHS basename suff input_fn _output_fn = do
    src <- readFile input_fn
    let (import_sources, import_normals, module_name) = getImports src
 
-   deps_sources <- mapM (findDependency True basename)  import_sources
-   deps_normals <- mapM (findDependency False basename) import_normals
+   let orig_fn = basename ++ '.':suff
+   deps_sources <- mapM (findDependency True  orig_fn) import_sources
+   deps_normals <- mapM (findDependency False orig_fn) import_normals
    let deps = deps_sources ++ deps_normals
 
    osuf_opt <- readIORef v_Object_suf
@@ -434,6 +438,20 @@ run_phase Hsc basename suff input_fn output_fn
                           Nothing -> basename ++ '.':hisuf
                           Just fn -> fn
 
+  -- figure out which header files to #include in a generated .hc file
+       c_includes <- getPackageCIncludes
+       cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
+
+       let cc_injects = unlines (map mk_include 
+                                (c_includes ++ reverse cmdline_includes))
+           mk_include h_file = 
+               case h_file of 
+                  '"':_{-"-} -> "#include "++h_file
+                  '<':_      -> "#include "++h_file
+                  _          -> "#include \""++h_file++"\""
+
+       writeIORef v_HCHeader cc_injects
+
   -- figure out if the source has changed, for recompilation avoidance.
   -- only do this if we're eventually going to generate a .o file.
   -- (ToDo: do when generating .hc files too?)
@@ -459,23 +477,26 @@ run_phase Hsc basename suff input_fn output_fn
                                  then return True
                                  else return False
 
-   -- build a ModuleLocation to pass to hscMain.
-        let location = ModuleLocation {
-                          ml_hs_file   = Nothing,
-                          ml_hspp_file = Just input_fn,
-                          ml_hi_file   = Just hifile,
-                          ml_obj_file  = Just o_file
-                       }
+        -- build a ModuleLocation to pass to hscMain.
+        (srcimps,imps,mod_name) <- getImportsFromFile input_fn
+
+       Just (mod, location)
+          <- mkHomeModuleLocn mod_name basename (basename ++ '.':suff)
 
   -- get the DynFlags
         dyn_flags <- readIORef v_DynFlags
 
+        let dyn_flags' = dyn_flags { hscOutName = output_fn,
+                                    hscStubCOutName = basename ++ "_stub.c",
+                                    hscStubHOutName = basename ++ "_stub.h" }
+
   -- run the compiler!
         pcs <- initPersistentCompilerState
        result <- hscMain OneShot
-                          dyn_flags{ hscOutName = output_fn }
+                          dyn_flags' mod
+                         location{ ml_hspp_file=Just input_fn }
                          source_unchanged
-                         location
+                         False
                          Nothing        -- no iface
                          emptyModuleEnv -- HomeSymbolTable
                          emptyModuleEnv -- HomeIfaceTable
@@ -491,11 +512,11 @@ run_phase Hsc basename suff input_fn output_fn
                  return False;
                };
 
-           HscRecomp pcs details iface maybe_stub_h maybe_stub_c 
+           HscRecomp pcs details iface stub_h_exists stub_c_exists
                      _maybe_interpreted_code -> do
 
            -- deal with stubs
-       maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
+       maybe_stub_o <- compileStub dyn_flags' stub_c_exists
        case maybe_stub_o of
                Nothing -> return ()
                Just stub_o -> add v_Ld_inputs stub_o
@@ -509,7 +530,7 @@ run_phase Hsc basename suff input_fn output_fn
 -- we don't support preprocessing .c files (with -E) now.  Doing so introduces
 -- way too many hacks, and I can't say I've ever used it anyway.
 
-run_phase cc_phase _basename _suff input_fn output_fn
+run_phase cc_phase basename suff input_fn output_fn
    | cc_phase == Cc || cc_phase == HCc
    = do        cc <- readIORef v_Pgm_c
                cc_opts <- (getOpts opt_c)
@@ -524,26 +545,6 @@ run_phase cc_phase _basename _suff input_fn output_fn
        let include_paths = map (\p -> "-I"++p) (cmdline_include_dirs 
                                                        ++ pkg_include_dirs)
 
-       c_includes <- getPackageCIncludes
-       cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
-
-       let cc_injects | hcc = unlines (map mk_include 
-                                       (c_includes ++ reverse cmdline_includes))
-                      | otherwise = ""
-           mk_include h_file = 
-               case h_file of 
-                  '"':_{-"-} -> "#include "++h_file
-                  '<':_      -> "#include "++h_file
-                  _          -> "#include \""++h_file++"\""
-
-       cc_help <- newTempName "c"
-       h <- openFile cc_help WriteMode
-       hPutStr h cc_injects
-       hPutStrLn h ("#include \"" ++ input_fn ++ "\"\n")
-       hClose h
-
-       ccout <- newTempName "ccout"
-
        mangle <- readIORef v_Do_asm_mangling
        (md_c_flags, md_regd_c_flags) <- machdepCCOpts
 
@@ -562,7 +563,7 @@ run_phase cc_phase _basename _suff input_fn output_fn
        excessPrecision <- readIORef v_Excess_precision
 
        runSomething "C Compiler"
-        (unwords ([ cc, "-x", "c", cc_help, "-o", output_fn ]
+        (unwords ([ cc, "-x", "c", input_fn, "-o", output_fn ]
                   ++ md_c_flags
                   ++ (if cc_phase == HCc && mangle
                         then md_regd_c_flags
@@ -574,7 +575,6 @@ run_phase cc_phase _basename _suff input_fn output_fn
                   ++ (if excessPrecision then [] else [ "-ffloat-store" ])
                   ++ include_paths
                   ++ pkg_extra_cc_opts
---                ++ [">", ccout]
                   ))
        return True
 
@@ -670,6 +670,100 @@ run_phase SplitAs basename _suff _input_fn _output_fn
        return True
 
 -----------------------------------------------------------------------------
+-- MoveBinary sort-of-phase
+-- After having produced a binary, move it somewhere else and generate a
+-- wrapper script calling the binary. Currently, we need this only in 
+-- a parallel way (i.e. in GUM), because PVM expects the binary in a
+-- central directory.
+-- This is called from doLink below, after linking. I haven't made it
+-- a separate phase to minimise interfering with other modules, and
+-- we don't need the generality of a phase (MoveBinary is always
+-- done after linking and makes only sense in a parallel setup)   -- HWL
+
+run_phase_MoveBinary input_fn
+  = do 
+        top_dir <- readIORef v_TopDir
+        pvm_root <- getEnv "PVM_ROOT"
+        pvm_arch <- getEnv "PVM_ARCH"
+        let 
+           pvm_executable_base = "=" ++ input_fn
+           pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
+           sysMan = top_dir ++ "/ghc/rts/parallel/SysMan";
+        -- nuke old binary; maybe use configur'ed names for cp and rm?
+        system ("rm -f " ++ pvm_executable)
+        -- move the newly created binary into PVM land
+        system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
+        -- generate a wrapper script for running a parallel prg under PVM
+        writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
+       return True
+
+-- generates a Perl skript starting a parallel prg under PVM
+mk_pvm_wrapper_script :: String -> String -> String -> String
+mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
+ [
+  "eval 'exec perl -S $0 ${1+\"$@\"}'", 
+  "  if $running_under_some_shell;",
+  "# =!=!=!=!=!=!=!=!=!=!=!",
+  "# This script is automatically generated: DO NOT EDIT!!!",
+  "# Generated by Glasgow Haskell Compiler",
+  "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
+  "#",
+  "$pvm_executable      = '" ++ pvm_executable ++ "';",
+  "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
+  "$SysMan = '" ++ sysMan ++ "';",
+  "",
+  {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
+  "# first, some magical shortcuts to run "commands" on the binary",
+  "# (which is hidden)",
+  "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
+  "    local($cmd) = $1;",
+  "    system("$cmd $pvm_executable");",
+  "    exit(0); # all done",
+  "}", -}
+  "",
+  "# Now, run the real binary; process the args first",
+  "$ENV{'PE'} = $pvm_executable_base;", --  ++ pvm_executable_base,
+  "$debug = '';",
+  "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
+  "@nonPVM_args = ();",
+  "$in_RTS_args = 0;",
+  "",
+  "args: while ($a = shift(@ARGV)) {",
+  "    if ( $a eq '+RTS' ) {",
+  "    $in_RTS_args = 1;",
+  "    } elsif ( $a eq '-RTS' ) {",
+  "    $in_RTS_args = 0;",
+  "    }",
+  "    if ( $a eq '-d' && $in_RTS_args ) {",
+  "    $debug = '-';",
+  "    } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
+  "    $nprocessors = $1;",
+  "    } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
+  "    $nprocessors = $1;",
+  "    } else {",
+  "    push(@nonPVM_args, $a);",
+  "    }",
+  "}",
+  "",
+  "local($return_val) = 0;",
+  "# Start the parallel execution by calling SysMan",
+  "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
+  "$return_val = $?;",
+  "# ToDo: fix race condition moving files and flushing them!!",
+  "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
+  "exit($return_val);"
+ ]
+
+-----------------------------------------------------------------------------
+-- Complain about non-dynamic flags in OPTIONS pragmas
+
+checkProcessArgsResult flags basename suff
+  = do when (not (null flags)) (throwDyn (ProgramError (
+           basename ++ "." ++ suff 
+           ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
+           ++ unwords flags)) (ExitFailure 1))
+
+-----------------------------------------------------------------------------
 -- Linking
 
 doLink :: [String] -> IO ()
@@ -735,6 +829,12 @@ doLink o_files = do
 #endif
        )
        )
+    -- parallel only: move binary to another dir -- HWL
+    ways_ <- readIORef v_Ways
+    when (WayPar `elem` ways_) (do 
+                                  success <- run_phase_MoveBinary output_fn
+                                  if success then return ()
+                                             else throwDyn (InstallationError ("cannot move binary to PVM dir")))
 
 -----------------------------------------------------------------------------
 -- Making a DLL
@@ -810,7 +910,7 @@ doMkDLL o_files = do
 
 preprocess :: FilePath -> IO FilePath
 preprocess filename =
-  ASSERT(haskellish_file filename) 
+  ASSERT(haskellish_src_file filename) 
   do init_dyn_flags <- readIORef v_InitDynFlags
      writeIORef v_DynFlags init_dyn_flags
      pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
@@ -835,7 +935,8 @@ preprocess filename =
 
 compile :: GhciMode                -- distinguish batch from interactive
         -> ModSummary              -- summary, including source
-       -> Bool                    -- source unchanged?
+       -> Bool                    -- True <=> source unchanged
+       -> Bool                    -- True <=> have object
         -> Maybe ModIface          -- old interface, if available
         -> HomeSymbolTable         -- for home module ModDetails
        -> HomeIfaceTable          -- for home module Ifaces
@@ -853,7 +954,8 @@ data CompResult
    | CompErrs PersistentCompilerState  -- updated PCS
 
 
-compile ghci_mode summary source_unchanged old_iface hst hit pcs = do 
+compile ghci_mode summary source_unchanged have_object 
+       old_iface hst hit pcs = do 
    init_dyn_flags <- readIORef v_InitDynFlags
    writeIORef v_DynFlags init_dyn_flags
 
@@ -876,12 +978,32 @@ compile ghci_mode summary source_unchanged old_iface hst hit pcs = do
                    HscAsm         -> newTempName (phaseInputExt As)
                    HscC           -> newTempName (phaseInputExt HCc)
                    HscJava        -> newTempName "java" -- ToDo
+                   HscILX         -> newTempName "ilx" -- ToDo
                    HscInterpreted -> return (error "no output file")
 
+   let (basename, _) = splitFilename input_fn
+       dyn_flags' = dyn_flags { hscOutName = output_fn,
+                               hscStubCOutName = basename ++ "_stub.c",
+                               hscStubHOutName = basename ++ "_stub.h" }
+
+   -- figure out which header files to #include in a generated .hc file
+   c_includes <- getPackageCIncludes
+   cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
+
+   let cc_injects = unlines (map mk_include 
+                                 (c_includes ++ reverse cmdline_includes))
+       mk_include h_file = 
+       case h_file of 
+           '"':_{-"-} -> "#include "++h_file
+           '<':_      -> "#include "++h_file
+           _          -> "#include \""++h_file++"\""
+
+   writeIORef v_HCHeader cc_injects
+
    -- run the compiler
-   hsc_result <- hscMain ghci_mode dyn_flags{ hscOutName = output_fn } 
-                        source_unchanged
-                         location old_iface hst hit pcs
+   hsc_result <- hscMain ghci_mode dyn_flags'
+                        (ms_mod summary) location
+                        source_unchanged have_object old_iface hst hit pcs
 
    case hsc_result of
       HscFail pcs -> return (CompErrs pcs)
@@ -889,10 +1011,10 @@ compile ghci_mode summary source_unchanged old_iface hst hit pcs = do
       HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)
 
       HscRecomp pcs details iface
-       maybe_stub_h maybe_stub_c maybe_interpreted_code -> do
+       stub_h_exists stub_c_exists maybe_interpreted_code -> do
           
-          let (basename, _) = splitFilename input_fn
-          maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
+          let 
+          maybe_stub_o <- compileStub dyn_flags' stub_c_exists
           let stub_unlinked = case maybe_stub_o of
                                  Nothing -> []
                                  Just stub_o -> [ DotO stub_o ]
@@ -929,36 +1051,13 @@ compile ghci_mode summary source_unchanged old_iface hst hit pcs = do
 -----------------------------------------------------------------------------
 -- stub .h and .c files (for foreign export support)
 
-dealWithStubs basename maybe_stub_h maybe_stub_c
+compileStub dflags stub_c_exists
+  | not stub_c_exists = return Nothing
+  | stub_c_exists = do
+       -- compile the _stub.c file w/ gcc
+       let stub_c = hscStubCOutName dflags
+       pipeline <- genPipeline (StopBefore Ln) "" True defaultHscLang stub_c
+       stub_o <- runPipeline pipeline stub_c False{-no linking-} 
+                       False{-no -o option-}
 
- = do  let stub_h = basename ++ "_stub.h"
-       let stub_c = basename ++ "_stub.c"
-
-  -- copy the .stub_h file into the current dir if necessary
-       case maybe_stub_h of
-          Nothing -> return ()
-          Just tmp_stub_h -> do
-               runSomething "Copy stub .h file"
-                               ("cp " ++ tmp_stub_h ++ ' ':stub_h)
-       
-                       -- #include <..._stub.h> in .hc file
-               addCmdlineHCInclude tmp_stub_h  -- hack
-
-  -- copy the .stub_c file into the current dir, and compile it, if necessary
-       case maybe_stub_c of
-          Nothing -> return Nothing
-          Just tmp_stub_c -> do  -- copy the _stub.c file into the current dir
-               runSomething "Copy stub .c file" 
-                   (unwords [ 
-                       "rm -f", stub_c, "&&",
-                       "echo \'#include \"Stg.h\"\n#include \""++stub_h++"\"\' >"++stub_c, " &&",
-                       "cat", tmp_stub_c, ">> ", stub_c
-                       ])
-
-                       -- compile the _stub.c file w/ gcc
-               pipeline <- genPipeline (StopBefore Ln) "" True 
-                               defaultHscLang stub_c
-               stub_o <- runPipeline pipeline stub_c False{-no linking-} 
-                               False{-no -o option-}
-
-               return (Just stub_o)
+       return (Just stub_o)