DriverPipeline.hs 37.5 KB
Newer Older
1
-----------------------------------------------------------------------------
sof's avatar
sof committed
2
-- $Id: DriverPipeline.hs,v 1.96 2001/08/10 23:08:25 sof Exp $
3 4 5 6 7 8 9
--
-- GHC Driver
--
-- (c) Simon Marlow 2000
--
-----------------------------------------------------------------------------

rrt's avatar
rrt committed
10 11
#include "../includes/config.h"

12
module DriverPipeline (
13 14

	-- interfaces for the batch-mode driver
15
   GhcMode(..), getGhcMode, v_GhcMode,
16
   genPipeline, runPipeline, pipeLoop,
17 18

	-- interfaces for the compilation manager (interpreted/batch-mode)
19
   preprocess, compile, CompResult(..),
20 21

	-- batch-mode linking interface
rrt's avatar
rrt committed
22 23 24
   doLink,
        -- DLL building
   doMkDLL
25 26 27 28
  ) where

#include "HsVersions.h"

29
import Packages
30 31
import CmTypes
import GetImports
32 33 34
import DriverState
import DriverUtil
import DriverMkDepend
35
import DriverPhases
36
import DriverFlags
rrt's avatar
rrt committed
37
import SysTools		( newTempName, addFilesToClean, getSysMan, unDosifyPath )
38
import qualified SysTools	
39
import HscMain
40
import Finder
41 42 43
import HscTypes
import Outputable
import Module
44
import ErrUtils
45
import CmdLineOpts
46
import Config
47
import Panic
48 49
import Util

50
import Time 		( getClockTime )
51 52
import Directory
import System
53 54 55 56 57 58 59
import IOExts
import Exception

import IO
import Monad
import Maybe

rrt's avatar
rrt committed
60 61 62
import PackedString
import MatchPS

63 64 65 66 67
-----------------------------------------------------------------------------
-- GHC modes of operation

modeFlag :: String -> Maybe GhcMode
modeFlag "-M" 		 = Just $ DoMkDependHS
rrt's avatar
rrt committed
68
modeFlag "--mk-dll"      = Just $ DoMkDLL
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
modeFlag "-E" 		 = Just $ StopBefore Hsc
modeFlag "-C" 		 = Just $ StopBefore HCc
modeFlag "-S" 		 = Just $ StopBefore As
modeFlag "-c" 		 = Just $ StopBefore Ln
modeFlag "--make"        = Just $ DoMake
modeFlag "--interactive" = Just $ DoInteractive
modeFlag _               = Nothing

getGhcMode :: [String]
	 -> IO ( [String]   -- rest of command line
	       , GhcMode
	       , String	    -- "GhcMode" flag
	       )
getGhcMode flags 
  = case my_partition modeFlag flags of
	([]   , rest) -> return (rest, DoLink,  "") -- default is to do linking
	([(flag,one)], rest) -> return (rest, one, flag)
	(_    , _   ) -> 
87
	  throwDyn (UsageError 
rrt's avatar
rrt committed
88
		"only one of the flags -M, -E, -C, -S, -c, --make, --interactive, -mk-dll is allowed")
89 90 91 92 93

-----------------------------------------------------------------------------
-- genPipeline
--
-- Herein is all the magic about which phases to run in which order, whether
rrt's avatar
rrt committed
94
-- the intermediate files should be in TMPDIR or in the current directory,
95 96 97
-- what the suffix of the intermediate files should be, etc.

-- The following compilation pipeline algorithm is fairly hacky.  A
rrt's avatar
rrt committed
98
-- better way to do this would be to express the whole compilation as a
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
-- data flow DAG, where the nodes are the intermediate files and the
-- edges are the compilation phases.  This framework would also work
-- nicely if a haskell dependency generator was included in the
-- driver.

-- It would also deal much more cleanly with compilation phases that
-- generate multiple intermediates, (eg. hsc generates .hc, .hi, and
-- possibly stub files), where some of the output files need to be
-- processed further (eg. the stub files need to be compiled by the C
-- compiler).

-- A cool thing to do would then be to execute the data flow graph
-- concurrently, automatically taking advantage of extra processors on
-- the host machine.  For example, when compiling two Haskell files
-- where one depends on the other, the data flow graph would determine
rrt's avatar
rrt committed
114 115
-- that the C compiler from the first compilation can be overlapped
-- with the hsc compilation for the second file.
116 117 118 119

data IntermediateFileType
  = Temporary
  | Persistent
120
  deriving (Eq, Show)
121 122

genPipeline
sof's avatar
sof committed
123 124 125 126 127
   :: GhcMode		 -- when to stop
   -> String		 -- "stop after" flag (for error messages)
   -> Bool		 -- True => output is persistent
   -> HscLang		 -- preferred output language for hsc
   -> (FilePath, String) -- original filename & its suffix 
128 129 130 131 132 133
   -> IO [ 		-- list of phases to run for this file
	     (Phase,
	      IntermediateFileType,  -- keep the output from this phase?
	      String)   	     -- output file suffix
         ]	

sof's avatar
sof committed
134
genPipeline todo stop_flag persistent_output lang (filename,suffix)
135
 = do
136 137 138 139 140
   split      <- readIORef v_Split_object_files
   mangle     <- readIORef v_Do_asm_mangling
   keep_hc    <- readIORef v_Keep_hc_files
   keep_raw_s <- readIORef v_Keep_raw_s_files
   keep_s     <- readIORef v_Keep_s_files
141
   osuf       <- readIORef v_Object_suf
142
   hcsuf      <- readIORef v_HC_suf
143 144 145

   let
   ----------- -----  ----   ---   --   --  -  -  -
146 147 148 149 150
    start = startPhase suffix

      -- special case for mkdependHS: .hspp files go through MkDependHS
    start_phase | todo == DoMkDependHS && start == Hsc  = MkDependHS
	        | otherwise = start
151 152 153 154

    haskellish = haskellish_suffix suffix
    cish = cish_suffix suffix

155
       -- for a .hc file we need to force lang to HscC
156 157
    real_lang | start_phase == HCc || start_phase == Mangle = HscC
	      | otherwise                                   = lang
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176

   let
   ----------- -----  ----   ---   --   --  -  -  -
    pipeline
      | todo == DoMkDependHS = [ Unlit, Cpp, MkDependHS ]

      | haskellish = 
       case real_lang of
	HscC    | split && mangle -> [ Unlit, Cpp, Hsc, HCc, Mangle, 
					SplitMangle, SplitAs ]
	        | mangle          -> [ Unlit, Cpp, Hsc, HCc, Mangle, As ]
	        | split	       	  -> not_valid
	        | otherwise       -> [ Unlit, Cpp, Hsc, HCc, As ]

	HscAsm  | split           -> [ Unlit, Cpp, Hsc, SplitMangle, SplitAs ]
	        | otherwise       -> [ Unlit, Cpp, Hsc, As ]

	HscJava	| split	          -> not_valid
		| otherwise       -> error "not implemented: compiling via Java"
rrt's avatar
rrt committed
177 178
	HscILX  | split           -> not_valid
		| otherwise       -> [ Unlit, Cpp, Hsc ]
179 180 181 182 183 184

      | cish      = [ Cc, As ]

      | otherwise = [ ]  -- just pass this file through to the linker

	-- ToDo: this is somewhat cryptic
185
    not_valid = throwDyn (UsageError ("invalid option combination"))
186 187 188 189 190 191

    stop_phase = case todo of 
			StopBefore As | split -> SplitAs
			StopBefore phase      -> phase
			DoMkDependHS	      -> Ln
			DoLink                -> Ln
192 193 194 195
   ----------- -----  ----   ---   --   --  -  -  -

	-- this shouldn't happen.
   if start_phase /= Ln && start_phase `notElem` pipeline
196 197
	then throwDyn (CmdLineError ("can't find starting phase for "
				     ++ filename))
198 199
	else do

200 201 202 203 204 205 206 207 208 209 210
	-- if we can't find the phase we're supposed to stop before,
	-- something has gone wrong.  This test carefully avoids the
	-- case where we aren't supposed to do any compilation, because the file
	-- is already in linkable form (for example).
   if start_phase `elem` pipeline && 
 	(stop_phase /= Ln && stop_phase `notElem` pipeline)
      then throwDyn (UsageError 
		("flag " ++ stop_flag
		 ++ " is incompatible with source file `" ++ filename ++ "'"))
      else do

211
   let
212 213 214 215
	-- .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
216

217 218 219 220 221 222 223
      annotatePipeline
	 :: [Phase]		-- raw pipeline
	 -> Phase		-- phase to stop before
     	 -> [(Phase, IntermediateFileType, String{-file extension-})]
      annotatePipeline []     _    = []
      annotatePipeline (Ln:_) _    = []
      annotatePipeline (phase:next_phase:ps) stop = 
224
     	  (phase, keep_this_output, myPhaseInputExt next_phase)
225 226 227
	     : annotatePipeline (next_phase:ps) stop
     	  where
     		keep_this_output
228 229 230 231
     		     | next_phase == stop 
                     = if persistent_output then Persistent else Temporary
     		     | otherwise
     		     = case next_phase of
232 233 234 235 236 237 238 239 240 241
     			     Ln -> Persistent
     			     Mangle | keep_raw_s -> Persistent
     			     As     | keep_s     -> Persistent
     			     HCc    | keep_hc    -> Persistent
     			     _other              -> Temporary

	-- add information about output files to the pipeline
	-- the suffix on an output file is determined by the next phase
	-- in the pipeline, so we add linking to the end of the pipeline
	-- to force the output from the final phase to be a .o file.
242 243

      annotated_pipeline = annotatePipeline (pipeline ++ [Ln]) stop_phase
244 245 246 247

      phase_ne p (p1,_,_) = (p1 /= p)
   ----------- -----  ----   ---   --   --  -  -  -

248 249 250 251 252
   return (
     takeWhile (phase_ne stop_phase ) $
     dropWhile (phase_ne start_phase) $
     annotated_pipeline
    )
253 254 255 256


runPipeline
  :: [ (Phase, IntermediateFileType, String) ] -- phases to run
sof's avatar
sof committed
257
  -> (String,String)		-- input file
258 259
  -> Bool			-- doing linking afterward?
  -> Bool			-- take into account -o when generating output?
sof's avatar
sof committed
260
  -> IO (String, String)	-- return final filename
261

sof's avatar
sof committed
262 263 264
runPipeline pipeline (input_fn,suffix) do_linking use_ofile
  = pipeLoop pipeline (input_fn,suffix) do_linking use_ofile basename suffix
  where (basename, _) = splitFilename input_fn
265 266 267

pipeLoop [] input_fn _ _ _ _ = return input_fn
pipeLoop ((phase, keep, o_suffix):phases) 
sof's avatar
sof committed
268
	(input_fn,real_suff) do_linking use_ofile orig_basename orig_suffix
269 270 271 272
  = do

     output_fn <- outputFileName (null phases) keep o_suffix

sof's avatar
sof committed
273
     mbCarryOn <- run_phase phase orig_basename orig_suffix input_fn output_fn 
274 275
	-- sometimes we bail out early, eg. when the compiler's recompilation
	-- checker has determined that recompilation isn't necessary.
sof's avatar
sof committed
276 277 278 279
     case mbCarryOn of
       Nothing -> do
	      let (_,keep,final_suffix) = last phases
	      ofile <- outputFileName True keep final_suffix
sof's avatar
sof committed
280
	      return (ofile, final_suffix)
sof's avatar
sof committed
281
          -- carry on ...
sof's avatar
sof committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
       Just fn -> 
              {-
	       Notice that in order to keep the invariant that we can
	       determine a compilation pipeline's 'start phase' just
	       by looking at the input filename, the input filename
	       to the next stage/phase is associated here with the suffix
	       of the output file, *even* if it does not have that
	       suffix in reality.
	       
	       Why is this important? Because we may run a compilation
	       pipeline in stages (cf. Main.main.compileFile's two stages),
	       so when generating the next stage we need to be precise
	       about what kind of file (=> suffix) is given as input.

	       [Not having to generate a pipeline in stages seems like
	        the right way to go, but I've punted on this for now --sof]
	       
	      -}
              pipeLoop phases (fn, o_suffix) do_linking use_ofile
       			orig_basename orig_suffix
302 303
  where
     outputFileName last_phase keep suffix
304
  	= do o_file <- readIORef v_Output_file
305 306 307 308 309
   	     if last_phase && not do_linking && use_ofile && isJust o_file
   	       then case o_file of 
   		       Just s  -> return s
   		       Nothing -> error "outputFileName"
   	       else if keep == Persistent
310
   			   then odir_ify (orig_basename ++ '.':suffix)
311 312
   			   else newTempName suffix

sof's avatar
sof committed
313 314 315 316 317 318 319 320 321
run_phase :: Phase
	  -> String                -- basename of original input source
	  -> String		   -- its extension
	  -> FilePath		   -- name of file which contains the input to this phase.
	  -> FilePath              -- where to stick the result.
	  -> IO (Maybe FilePath)
	  	  -- Nothing => stop the compilation pipeline
		  -- Just fn => the result of this phase can be found in 'fn'
		  --            (this can either be 'input_fn' or 'output_fn').
322 323 324 325
-------------------------------------------------------------------------------
-- Unlit phase 

run_phase Unlit _basename _suff input_fn output_fn
326
  = do unlit_flags <- getOpts opt_L
rrt's avatar
rrt committed
327 328 329
       -- The -h option passes the file name for unlit to put in a #line directive;
       -- we undosify it so that it doesn't contain backslashes in Windows, which
       -- would disappear in error messages
sof's avatar
sof committed
330 331 332 333 334 335
       SysTools.runUnlit (map SysTools.Option unlit_flags ++
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
			  , SysTools.FileOption input_fn
			  , SysTools.FileOption output_fn
			  ])
sof's avatar
sof committed
336
       return (Just output_fn)
337 338 339 340

-------------------------------------------------------------------------------
-- Cpp phase 

341
run_phase Cpp basename suff input_fn output_fn
342
  = do src_opts <- getOptionsFromSource input_fn
343
       unhandled_flags <- processArgs dynamic_flags src_opts []
344
       checkProcessArgsResult unhandled_flags basename suff
345

346
       do_cpp <- dynFlag cppFlag
sof's avatar
sof committed
347 348 349 350 351
       if not do_cpp then
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
          return (Just input_fn)
	else do
352
	    hscpp_opts	    <- getOpts opt_P
353
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
354

355
	    cmdline_include_paths <- readIORef v_Include_paths
356
	    pkg_include_dirs <- getPackageIncludePath
rrt's avatar
rrt committed
357 358
	    let include_paths = foldr (\ x xs -> "-I" : x : xs) []
				  (cmdline_include_paths ++ pkg_include_dirs)
359

360
	    verb <- getVerbFlag
rrt's avatar
rrt committed
361
	    (md_c_flags, _) <- machdepCCOpts
362

sof's avatar
sof committed
363 364 365 366 367 368 369 370 371 372
	    SysTools.runCpp ([SysTools.Option verb]
			    ++ map SysTools.Option include_paths
			    ++ map SysTools.Option hs_src_cpp_opts
			    ++ map SysTools.Option hscpp_opts
			    ++ map SysTools.Option md_c_flags
			    ++ [ SysTools.Option     "-x c"
			       , SysTools.FileOption input_fn
			       , SysTools.Option     "-o"
			       , SysTools.FileOption output_fn
			       ])
sof's avatar
sof committed
373
	    return (Just output_fn)
374 375 376 377

-----------------------------------------------------------------------------
-- MkDependHS phase

sof's avatar
sof committed
378
run_phase MkDependHS basename suff input_fn output_fn = do 
379
   src <- readFile input_fn
380
   let (import_sources, import_normals, _) = getImports src
381

382 383 384
   let orig_fn = basename ++ '.':suff
   deps_sources <- mapM (findDependency True  orig_fn) import_sources
   deps_normals <- mapM (findDependency False orig_fn) import_normals
385
   let deps = deps_sources ++ deps_normals
386

387
   osuf_opt <- readIORef v_Object_suf
388
   let osuf = case osuf_opt of
389
			Nothing -> phaseInputExt Ln
390 391
			Just s  -> s

392
   extra_suffixes <- readIORef v_Dep_suffixes
393 394 395 396 397
   let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
       ofiles = map (\suf -> basename ++ '.':suf) suffixes
   	   
   objs <- mapM odir_ify ofiles
   
398
	-- Handle for file that accumulates dependencies 
399
   hdl <- readIORef v_Dep_tmp_hdl
400

401
	-- std dependency of the object(s) on the source file
402 403 404 405 406
   hPutStrLn hdl (unwords objs ++ " : " ++ basename ++ '.':suff)

   let genDep (dep, False {- not an hi file -}) = 
	  hPutStrLn hdl (unwords objs ++ " : " ++ dep)
       genDep (dep, True  {- is an hi file -}) = do
407
	  hisuf <- readIORef v_Hi_suf
408 409 410 411 412 413 414 415
	  let dep_base = remove_suffix '.' dep
	      deps = (dep_base ++ hisuf)
		     : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
		  -- length objs should be == length deps
	  sequence_ (zipWith (\o d -> hPutStrLn hdl (o ++ " : " ++ d)) objs deps)

   mapM genDep [ d | Just d <- deps ]

sof's avatar
sof committed
416
   return (Just output_fn)
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438

-- add the lines to dep_makefile:
	   -- always:
		   -- this.o : this.hs

  	   -- if the dependency is on something other than a .hi file:
   		   -- this.o this.p_o ... : dep
   	   -- otherwise
   		   -- if the import is {-# SOURCE #-}
   			   -- this.o this.p_o ... : dep.hi-boot[-$vers]
   			   
   		   -- else
   			   -- this.o ...   : dep.hi
   			   -- this.p_o ... : dep.p_hi
   			   -- ...
   
   	   -- (where .o is $osuf, and the other suffixes come from
   	   -- the cmdline -s options).
   
-----------------------------------------------------------------------------
-- Hsc phase

439 440
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
441
run_phase Hsc basename suff input_fn output_fn
442
  = do
443 444 445 446 447 448
	
  -- we add the current directory (i.e. the directory in which
  -- the .hs files resides) to the import path, since this is
  -- what gcc does, and it's probably what you want.
	let current_dir = getdir basename
	
449 450
	paths <- readIORef v_Include_paths
	writeIORef v_Include_paths (current_dir : paths)
451
	
452 453 454 455 456
  -- 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 
457
				 (c_includes ++ reverse cmdline_includes))
458 459 460 461 462 463 464 465
	    mk_include h_file = 
		case h_file of 
		   '"':_{-"-} -> "#include "++h_file
		   '<':_      -> "#include "++h_file
		   _          -> "#include \""++h_file++"\""

	writeIORef v_HCHeader cc_injects

466 467 468 469
  -- gather the imports and module name
        (srcimps,imps,mod_name) <- getImportsFromFile input_fn

  -- build a ModuleLocation to pass to hscMain.
sof's avatar
sof committed
470
	(mod, location')
471
	   <- mkHomeModuleLocn mod_name basename (Just (basename ++ '.':suff))
472 473 474 475 476 477

  -- take -ohi into account if present
	ohi <- readIORef v_Output_hi
	let location | Just fn <- ohi = location'{ ml_hi_file = fn }
		     | otherwise      = location'

478 479 480 481
  -- 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?)
  --
482
  -- Setting source_unchanged to True means that M.o seems
483 484
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
485
  -- Setting source_unchanged to False tells the compiler that M.o is out of
486
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
sof's avatar
sof committed
487 488 489 490 491 492 493
	do_recomp   <- readIORef v_Recomp
	todo        <- readIORef v_GhcMode
	expl_o_file <- readIORef v_Output_file
        let o_file = 
		case expl_o_file of
		  Nothing -> unJust "source_unchanged" (ml_obj_file location)
		  Just x  -> x
494 495
	source_unchanged <- 
          if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
496
	     then return False
497 498 499
	     else do t1 <- getModificationTime (basename ++ '.':suff)
		     o_file_exists <- doesFileExist o_file
		     if not o_file_exists
500
		        then return False	-- Need to recompile
501 502
			else do t2 <- getModificationTime o_file
			        if t2 > t1
503 504
				  then return True
				  else return False
505

506
  -- get the DynFlags
507
        dyn_flags <- getDynFlags
508

509 510
        let dyn_flags' = dyn_flags { hscOutName = output_fn,
		   		     hscStubCOutName = basename ++ "_stub.c",
apt's avatar
apt committed
511 512
				     hscStubHOutName = basename ++ "_stub.h",
				     extCoreName = basename ++ ".core" }
513

514
  -- run the compiler!
515
        pcs <- initPersistentCompilerState
516
	result <- hscMain OneShot
517
                          dyn_flags' mod
518
			  location{ ml_hspp_file=Just input_fn }
519
			  source_unchanged
520
			  False
521 522 523 524
			  Nothing	 -- no iface
			  emptyModuleEnv -- HomeSymbolTable
			  emptyModuleEnv -- HomeIfaceTable
			  pcs
525 526 527

	case result of {

528
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
529

530
            HscNoRecomp pcs details iface -> do { SysTools.touch "Touching object file" o_file
sof's avatar
sof committed
531
						; return Nothing } ;
532

533
	    HscRecomp pcs details iface stub_h_exists stub_c_exists
534
		      _maybe_interpreted_code -> do
535

536
	    -- deal with stubs
537
	maybe_stub_o <- compileStub dyn_flags' stub_c_exists
538
	case maybe_stub_o of
539
		Nothing -> return ()
540
		Just stub_o -> add v_Ld_inputs stub_o
541

sof's avatar
sof committed
542
	return (Just output_fn)
543
    }
544 545 546 547 548 549 550

-----------------------------------------------------------------------------
-- Cc phase

-- 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.

551
run_phase cc_phase basename suff input_fn output_fn
552
   | cc_phase == Cc || cc_phase == HCc
553
   = do	cc_opts		     <- getOpts opt_c
rrt's avatar
rrt committed
554
       	cmdline_include_paths <- readIORef v_Include_paths
555 556 557 558 559 560 561

        let hcc = cc_phase == HCc

		-- add package include paths even if we're just compiling
		-- .c files; this is the Value Add(TM) that using
		-- ghc instead of gcc gives you :)
        pkg_include_dirs <- getPackageIncludePath
rrt's avatar
rrt committed
562 563
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
564

565
	mangle <- readIORef v_Do_asm_mangling
566 567
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

568
        verb <- getVerbFlag
569

570
	o2 <- readIORef v_minus_o2_for_C
571 572 573 574 575
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

	pkg_extra_cc_opts <- getPackageExtraCcOpts

576 577 578 579
	split_objs <- readIORef v_Split_object_files
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]

580
	excessPrecision <- readIORef v_Excess_precision
sof's avatar
sof committed
581 582 583 584 585 586 587
	SysTools.runCc ([ SysTools.Option "-x c"
	                , SysTools.FileOption input_fn
			, SysTools.Option "-o"
			, SysTools.FileOption output_fn
			]
		       ++ map SysTools.Option (
		          md_c_flags
588 589 590 591 592 593 594 595 596 597
		       ++ (if cc_phase == HCc && mangle
		  	     then md_regd_c_flags
		  	     else [])
		       ++ [ verb, "-S", "-Wimplicit", opt_flag ]
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
		       ++ split_opt
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
598
		       ))
sof's avatar
sof committed
599
	return (Just output_fn)
600 601 602 603 604 605 606

	-- ToDo: postprocess the output from gcc

-----------------------------------------------------------------------------
-- Mangle phase

run_phase Mangle _basename _suff input_fn output_fn
607 608 609 610 611 612
  = do mangler_opts <- getOpts opt_m
       machdep_opts <- if (prefixMatch "i386" cTARGETPLATFORM)
		       then do n_regs <- dynFlag stolen_x86_regs
			       return [ show n_regs ]
		       else return []

sof's avatar
sof committed
613 614 615 616 617
       SysTools.runMangle (map SysTools.Option mangler_opts
		          ++ [ SysTools.FileOption input_fn
			     , SysTools.FileOption output_fn
			     ]
			  ++ map SysTools.Option machdep_opts)
sof's avatar
sof committed
618
       return (Just output_fn)
619 620 621 622

-----------------------------------------------------------------------------
-- Splitting phase

sof's avatar
sof committed
623
run_phase SplitMangle _basename _suff input_fn output_fn
624 625 626 627
  = do  -- tmp_pfx is the prefix used for the split .s files
	-- We also use it as the file to contain the no. of split .s files (sigh)
	split_s_prefix <- SysTools.newTempName "split"
	let n_files_fn = split_s_prefix
628

sof's avatar
sof committed
629 630 631 632
	SysTools.runSplit [ SysTools.FileOption input_fn
			  , SysTools.FileOption split_s_prefix
			  , SysTools.FileOption n_files_fn
			  ]
633 634 635 636 637 638 639 640 641

	-- Save the number of split files for future references
	s <- readFile n_files_fn
	let n_files = read s :: Int
	writeIORef v_Split_info (split_s_prefix, n_files)

	-- Remember to delete all these files
	addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
			| n <- [1..n_files]]
642

sof's avatar
sof committed
643
	return (Just output_fn)
644 645 646 647 648

-----------------------------------------------------------------------------
-- As phase

run_phase As _basename _suff input_fn output_fn
649
  = do	as_opts		      <- getOpts opt_a
650
        cmdline_include_paths <- readIORef v_Include_paths
651

sof's avatar
sof committed
652 653 654 655 656 657 658
	SysTools.runAs (map SysTools.Option as_opts
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
		          , SysTools.FileOption input_fn
			  , SysTools.Option "-o"
			  , SysTools.FileOption output_fn
			  ])
sof's avatar
sof committed
659
	return (Just output_fn)
660

sof's avatar
sof committed
661
run_phase SplitAs basename _suff _input_fn output_fn
662
  = do  as_opts <- getOpts opt_a
663

664
	(split_s_prefix, n) <- readIORef v_Split_info
665

666
	odir <- readIORef v_Output_dir
667 668 669 670
	let real_odir = case odir of
				Nothing -> basename
				Just d  -> d

671 672
	let assemble_file n
	      = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
673 674 675
		    let output_o = newdir real_odir 
					(basename ++ "__" ++ show n ++ ".o")
		    real_o <- osuf_ify output_o
sof's avatar
sof committed
676 677 678 679 680 681
		    SysTools.runAs (map SysTools.Option as_opts ++
		    		    [ SysTools.Option "-c"
				    , SysTools.Option "-o"
				    , SysTools.FileOption real_o
				    , SysTools.FileOption input_s
				    ])
682 683
	
	mapM_ assemble_file [1..n]
sof's avatar
sof committed
684
	return (Just output_fn)
685

686 687 688 689 690 691 692 693 694 695 696 697 698
-----------------------------------------------------------------------------
-- 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	
699
        sysMan   <- getSysMan
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
        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
        -- 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);"
 ]

770 771 772 773
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

checkProcessArgsResult flags basename suff
774
  = do when (not (null flags)) (throwDyn (ProgramError (
775 776 777 778
           basename ++ "." ++ suff 
           ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
           ++ unwords flags)) (ExitFailure 1))

779 780 781 782 783
-----------------------------------------------------------------------------
-- Linking

doLink :: [String] -> IO ()
doLink o_files = do
784 785
    verb       <- getVerbFlag
    static     <- readIORef v_Static
786 787
    no_hs_main <- readIORef v_NoHsMain

788
    o_file <- readIORef v_Output_file
789 790 791 792 793
    let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }

    pkg_lib_paths <- getPackageLibraryPath
    let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths

794
    lib_paths <- readIORef v_Library_paths
795 796 797
    let lib_path_opts = map ("-L"++) lib_paths

    pkg_libs <- getPackageLibraries
798 799
    let imp	     = if static then "" else "_imp"
        pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
800

801
    libs <- readIORef v_Cmdline_libraries
802 803 804 805 806 807
    let lib_opts = map ("-l"++) (reverse libs)
	 -- reverse because they're added in reverse order from the cmd line

    pkg_extra_ld_opts <- getPackageExtraLdOpts

	-- probably _stub.o files
808
    extra_ld_inputs <- readIORef v_Ld_inputs
809 810

	-- opts from -optl-<blah>
811
    extra_ld_opts <- getStaticOpts v_Opt_l
812

813 814 815 816
    rts_pkg <- getPackageDetails ["rts"]
    std_pkg <- getPackageDetails ["std"]
    let extra_os = if static || no_hs_main
                   then []
rrt's avatar
rrt committed
817 818
                   else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
                          head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
819

820
    (md_c_flags, _) <- machdepCCOpts
sof's avatar
sof committed
821 822 823 824 825 826
    SysTools.runLink ( [ SysTools.Option verb
    		       , SysTools.Option "-o"
		       , SysTools.FileOption output_fn
		       ]
		      ++ map SysTools.Option (
		         md_c_flags
827 828 829 830 831 832 833 834 835
	 	      ++ o_files
		      ++ extra_os
		      ++ extra_ld_inputs
	 	      ++ lib_path_opts
	 	      ++ lib_opts
	 	      ++ pkg_lib_path_opts
	 	      ++ pkg_lib_opts
	 	      ++ pkg_extra_ld_opts
	 	      ++ extra_ld_opts
sof's avatar
sof committed
836
	              ++ if static && not no_hs_main then
837
#ifdef LEADING_UNDERSCORE
rrt's avatar
rrt committed
838 839
			    [ "-u", "_PrelMain_mainIO_closure" ,
			      "-u", "___init_PrelMain"] 
840
#else
sof's avatar
sof committed
841 842
			    [ "-u", prefixUnderscore "PrelMain_mainIO_closure" ,
			      "-u", prefixUnderscore "__init_PrelMain"] 
843
#endif
sof's avatar
sof committed
844
			 else []))
845

846 847
    -- parallel only: move binary to another dir -- HWL
    ways_ <- readIORef v_Ways
848 849 850 851
    when (WayPar `elem` ways_)
	 (do success <- run_phase_MoveBinary output_fn
             if success then return ()
                        else throwDyn (InstallationError ("cannot move binary to PVM dir")))
852

rrt's avatar
rrt committed
853
-----------------------------------------------------------------------------
854
-- Making a DLL (only for Win32)
rrt's avatar
rrt committed
855 856 857

doMkDLL :: [String] -> IO ()
doMkDLL o_files = do
858 859
    verb       <- getVerbFlag
    static     <- readIORef v_Static
rrt's avatar
rrt committed
860 861 862 863 864 865 866 867 868 869 870 871
    no_hs_main <- readIORef v_NoHsMain

    o_file <- readIORef v_Output_file
    let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }

    pkg_lib_paths <- getPackageLibraryPath
    let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths

    lib_paths <- readIORef v_Library_paths
    let lib_path_opts = map ("-L"++) lib_paths

    pkg_libs <- getPackageLibraries
872 873
    let imp = if static then "" else "_imp"
        pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
rrt's avatar
rrt committed
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888

    libs <- readIORef v_Cmdline_libraries
    let lib_opts = map ("-l"++) (reverse libs)
	 -- reverse because they're added in reverse order from the cmd line

    pkg_extra_ld_opts <- getPackageExtraLdOpts

	-- probably _stub.o files
    extra_ld_inputs <- readIORef v_Ld_inputs

	-- opts from -optdll-<blah>
    extra_ld_opts <- getStaticOpts v_Opt_dll

    rts_pkg <- getPackageDetails ["rts"]
    std_pkg <- getPackageDetails ["std"]
889

rrt's avatar
rrt committed
890 891 892 893
    let extra_os = if static || no_hs_main
                   then []
                   else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
                          head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
894

rrt's avatar
rrt committed
895
    (md_c_flags, _) <- machdepCCOpts
896
    SysTools.runMkDLL
sof's avatar
sof committed
897 898 899 900 901 902
	 ([ SysTools.Option verb
	  , SysTools.Option "-o"
	  , SysTools.FileOption output_fn
	  ]
	 ++ map SysTools.Option (
	    md_c_flags
rrt's avatar
rrt committed
903 904 905 906 907 908 909 910 911 912 913 914 915
	 ++ o_files
	 ++ extra_os
	 ++ [ "--target=i386-mingw32" ]
	 ++ extra_ld_inputs
	 ++ lib_path_opts
	 ++ lib_opts
	 ++ pkg_lib_path_opts
	 ++ pkg_lib_opts
	 ++ pkg_extra_ld_opts
         ++ (case findPS (packString (concat extra_ld_opts)) (packString "--def") of
               Nothing -> [ "--export-all" ]
	       Just _  -> [ "" ])
	 ++ extra_ld_opts
sof's avatar
sof committed
916
	))
rrt's avatar
rrt committed
917

918 919 920 921 922 923
-----------------------------------------------------------------------------
-- Just preprocess a file, put the result in a temp. file (used by the
-- compilation manager during the summary phase).

preprocess :: FilePath -> IO FilePath
preprocess filename =
924
  ASSERT(haskellish_src_file filename) 
925
  do restoreDynFlags	-- Restore to state of last save
926
     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
sof's avatar
sof committed
927 928 929 930
			     defaultHscLang (filename, getFileSuffix filename)
     (fn,_)   <- runPipeline pipeline (filename,getFileSuffix filename)
     	                     False{-no linking-} False{-no -o flag-}
     return fn
931 932

-----------------------------------------------------------------------------
933
-- Compile a single module, under the control of the compilation manager.
934 935 936 937 938 939
--
-- This is the interface between the compilation manager and the
-- compiler proper (hsc), where we deal with tedious details like
-- reading the OPTIONS pragma from the source file, and passing the
-- output of hsc through the C compiler.

940 941 942 943 944 945
-- The driver sits between 'compile' and 'hscMain', translating calls
-- to the former into calls to the latter, and results from the latter
-- into results from the former.  It does things like preprocessing
-- the .hs file if necessary, and compiling up the .stub_c files to
-- generate Linkables.

946 947 948 949
-- NB.  No old interface can also mean that the source has changed.

compile :: GhciMode                -- distinguish batch from interactive
        -> ModSummary              -- summary, including source
950 951
	-> Bool			   -- True <=> source unchanged
	-> Bool			   -- True <=> have object
952
        -> Maybe ModIface          -- old interface, if available
953 954
        -> HomeSymbolTable         -- for home module ModDetails
	-> HomeIfaceTable	   -- for home module Ifaces
955 956 957
        -> PersistentCompilerState -- persistent compiler state
        -> IO CompResult

958
data CompResult
959 960 961 962 963 964
   = CompOK   PersistentCompilerState	-- updated PCS
              ModDetails  -- new details (HST additions)
              ModIface    -- new iface   (HIT additions)
              (Maybe Linkable)
                       -- new code; Nothing => compilation was not reqd
                       -- (old code is still valid)
965 966 967 968

   | CompErrs PersistentCompilerState	-- updated PCS


969 970
compile ghci_mode summary source_unchanged have_object 
	old_iface hst hit pcs = do 
971 972
   dyn_flags <- restoreDynFlags		-- Restore to the state of the last save

973

974
   showPass dyn_flags 
975
	(showSDoc (text "Compiling" <+> ppr (name_of_summary summary)))
976

977
   let verb	  = verbosity dyn_flags
978
   let location   = ms_location summary
979 980
   let input_fn   = unJust "compile:hs" (ml_hs_file location) 
   let input_fnpp = unJust "compile:hspp" (ml_hspp_file location)
981

982
   when (verb >= 2) (hPutStrLn stderr ("compile: input file " ++ input_fnpp))
983

984
   opts <- getOptionsFromSource input_fnpp
985
   processArgs dynamic_flags opts []
986
   dyn_flags <- getDynFlags
987

988
   let hsc_lang      = hscLang dyn_flags
989 990
       (basename, _) = splitFilename input_fn
       
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
   keep_hc <- readIORef v_Keep_hc_files
   keep_s  <- readIORef v_Keep_s_files

   output_fn <- 
	case hsc_lang of
	   HscAsm  | keep_s    -> return (basename ++ '.':phaseInputExt As)
		   | otherwise -> newTempName (phaseInputExt As)
	   HscC    | keep_hc   -> return (basename ++ '.':phaseInputExt HCc)
		   | otherwise -> newTempName (phaseInputExt HCc)
           HscJava             -> newTempName "java" -- ToDo
	   HscILX              -> return (basename ++ ".ilx") 	
	   			    -- newTempName "ilx"	-- ToDo
	   HscInterpreted      -> return (error "no output file")
1004

1005
   let dyn_flags' = dyn_flags { hscOutName = output_fn,
1006
				hscStubCOutName = basename ++ "_stub.c",
apt's avatar
apt committed
1007 1008
				hscStubHOutName = basename ++ "_stub.h",
				extCoreName = basename ++ ".core" }
1009

1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
   -- 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++"\""