DriverPipeline.hs 36.6 KB
Newer Older
1
-----------------------------------------------------------------------------
2
-- $Id: DriverPipeline.hs,v 1.73 2001/05/31 11:32:25 simonmar 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"

rrt's avatar
rrt committed
29
import CmStaticInfo
30 31
import CmTypes
import GetImports
32 33 34
import DriverState
import DriverUtil
import DriverMkDepend
35
import DriverPhases
36
import DriverFlags
37
import HscMain
38
import TmpFiles
39
import Finder
40 41 42
import HscTypes
import Outputable
import Module
43
import ErrUtils
44
import CmdLineOpts
45
import Config
46
import Panic
47 48
import Util

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

import IO
import Monad
import Maybe

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

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

data GhcMode
  = DoMkDependHS			-- ghc -M
rrt's avatar
rrt committed
67
  | DoMkDLL				-- ghc --mk-dll
68 69 70 71 72 73 74 75 76 77
  | StopBefore Phase			-- ghc -E | -C | -S | -c
  | DoMake				-- ghc --make
  | DoInteractive			-- ghc --interactive
  | DoLink				-- [ the default ]
  deriving (Eq)

GLOBAL_VAR(v_GhcMode, error "todo", GhcMode)

modeFlag :: String -> Maybe GhcMode
modeFlag "-M" 		 = Just $ DoMkDependHS
rrt's avatar
rrt committed
78
modeFlag "--mk-dll"      = Just $ DoMkDLL
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
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)
	(_    , _   ) -> 
97
	  throwDyn (UsageError 
rrt's avatar
rrt committed
98
		"only one of the flags -M, -E, -C, -S, -c, --make, --interactive, -mk-dll is allowed")
99 100 101 102 103

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

-- The following compilation pipeline algorithm is fairly hacky.  A
rrt's avatar
rrt committed
108
-- better way to do this would be to express the whole compilation as a
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
-- 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
124 125
-- that the C compiler from the first compilation can be overlapped
-- with the hsc compilation for the second file.
126 127 128 129

data IntermediateFileType
  = Temporary
  | Persistent
130
  deriving (Eq, Show)
131 132 133 134

genPipeline
   :: GhcMode		-- when to stop
   -> String		-- "stop after" flag (for error messages)
135
   -> Bool		-- True => output is persistent
136
   -> HscLang		-- preferred output language for hsc
137 138 139 140 141 142 143
   -> String		-- original filename
   -> IO [ 		-- list of phases to run for this file
	     (Phase,
	      IntermediateFileType,  -- keep the output from this phase?
	      String)   	     -- output file suffix
         ]	

144
genPipeline todo stop_flag persistent_output lang filename 
145
 = do
146 147 148 149 150
   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
151
   osuf       <- readIORef v_Object_suf
152
   hcsuf      <- readIORef v_HC_suf
153 154 155 156 157

   let
   ----------- -----  ----   ---   --   --  -  -  -
    (_basename, suffix) = splitFilename filename

158 159 160 161 162
    start = startPhase suffix

      -- special case for mkdependHS: .hspp files go through MkDependHS
    start_phase | todo == DoMkDependHS && start == Hsc  = MkDependHS
	        | otherwise = start
163 164 165 166

    haskellish = haskellish_suffix suffix
    cish = cish_suffix suffix

167
       -- for a .hc file we need to force lang to HscC
168 169
    real_lang | start_phase == HCc || start_phase == Mangle = HscC
	      | otherwise                                   = lang
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188

   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
189 190
	HscILX  | split           -> not_valid
		| otherwise       -> [ Unlit, Cpp, Hsc ]
191 192 193 194 195 196

      | cish      = [ Cc, As ]

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

	-- ToDo: this is somewhat cryptic
197

198
    not_valid = throwDyn (UsageError ("invalid option combination"))
199 200 201 202
   ----------- -----  ----   ---   --   --  -  -  -

	-- this shouldn't happen.
   if start_phase /= Ln && start_phase `notElem` pipeline
203 204
	then throwDyn (CmdLineError ("can't find starting phase for "
				     ++ filename))
205 206 207
	else do

   let
208 209 210 211
	-- .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
212

213 214 215 216 217 218 219
      annotatePipeline
	 :: [Phase]		-- raw pipeline
	 -> Phase		-- phase to stop before
     	 -> [(Phase, IntermediateFileType, String{-file extension-})]
      annotatePipeline []     _    = []
      annotatePipeline (Ln:_) _    = []
      annotatePipeline (phase:next_phase:ps) stop = 
220
     	  (phase, keep_this_output, myPhaseInputExt next_phase)
221 222 223
	     : annotatePipeline (next_phase:ps) stop
     	  where
     		keep_this_output
224 225 226 227
     		     | next_phase == stop 
                     = if persistent_output then Persistent else Temporary
     		     | otherwise
     		     = case next_phase of
228 229 230 231 232 233 234 235 236 237
     			     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.
238 239 240 241 242
      stop_phase = case todo of 
			StopBefore As | split -> SplitAs
			StopBefore phase      -> phase
			DoMkDependHS	      -> Ln
			DoLink                -> Ln
243 244

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

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

249 250 251 252 253 254
	-- 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)
255
      then throwDyn (UsageError 
256 257 258 259 260 261 262 263 264
		("flag " ++ stop_flag
		 ++ " is incompatible with source file `" ++ filename ++ "'"))
      else do

   return (
     takeWhile (phase_ne stop_phase ) $
     dropWhile (phase_ne start_phase) $
     annotated_pipeline
    )
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297


runPipeline
  :: [ (Phase, IntermediateFileType, String) ] -- phases to run
  -> String			-- input file
  -> Bool			-- doing linking afterward?
  -> Bool			-- take into account -o when generating output?
  -> IO String			-- return final filename

runPipeline pipeline input_fn do_linking use_ofile
  = pipeLoop pipeline input_fn do_linking use_ofile basename suffix
  where (basename, suffix) = splitFilename input_fn

pipeLoop [] input_fn _ _ _ _ = return input_fn
pipeLoop ((phase, keep, o_suffix):phases) 
	input_fn do_linking use_ofile orig_basename orig_suffix
  = do

     output_fn <- outputFileName (null phases) keep o_suffix

     carry_on <- run_phase phase orig_basename orig_suffix input_fn output_fn
	-- sometimes we bail out early, eg. when the compiler's recompilation
	-- checker has determined that recompilation isn't necessary.
     if not carry_on 
	then do let (_,keep,final_suffix) = last phases
	        ofile <- outputFileName True keep final_suffix
		return ofile
	else do -- carry on ...

     pipeLoop phases output_fn do_linking use_ofile orig_basename orig_suffix

  where
     outputFileName last_phase keep suffix
298
  	= do o_file <- readIORef v_Output_file
299 300 301 302 303
   	     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
304
   			   then odir_ify (orig_basename ++ '.':suffix)
305 306 307 308 309 310
   			   else newTempName suffix

-------------------------------------------------------------------------------
-- Unlit phase 

run_phase Unlit _basename _suff input_fn output_fn
311
  = do unlit <- readIORef v_Pgm_L
312
       unlit_flags <- getOpts opt_L
313
       runSomething "Literate pre-processor"
sof's avatar
sof committed
314 315 316 317
       	  (unlit ++ unwords unlit_flags ++ 
	  	    " -h " ++ input_fn ++ 
		    ' ':input_fn ++ 
		    ' ':output_fn)
318 319 320 321 322
       return True

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

323
run_phase Cpp basename suff input_fn output_fn
324
  = do src_opts <- getOptionsFromSource input_fn
325
       unhandled_flags <- processArgs dynamic_flags src_opts []
326
       checkProcessArgsResult unhandled_flags basename suff
327

328
       do_cpp <- dynFlag cppFlag
329 330
       if do_cpp
          then do
sof's avatar
sof committed
331
       	    cpp <- readIORef v_Pgm_P >>= prependToolDir
332
	    hscpp_opts <- getOpts opt_P
333
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
334

335
	    cmdline_include_paths <- readIORef v_Include_paths
336 337 338 339
	    pkg_include_dirs <- getPackageIncludePath
	    let include_paths = map (\p -> "-I"++p) (cmdline_include_paths
							++ pkg_include_dirs)

340
	    verb <- getVerbFlag
rrt's avatar
rrt committed
341
	    (md_c_flags, _) <- machdepCCOpts
342 343

	    runSomething "C pre-processor" 
344
		(unwords
sof's avatar
sof committed
345
       	    	   ([cpp, verb] 
346 347 348
		    ++ include_paths
		    ++ hs_src_cpp_opts
		    ++ hscpp_opts
rrt's avatar
rrt committed
349
		    ++ md_c_flags
sof's avatar
sof committed
350
		    ++ [ "-x", "c", input_fn, "-o", output_fn ]
351
		   ))
sof's avatar
sof committed
352 353 354 355 356 357 358 359 360 361 362 363
	-- ToDo: switch away from using 'echo' alltogether (but need
	-- a faster alternative than what's done below).
#if defined(mingw32_TARGET_OS) && defined(MINIMAL_UNIX_DEPS)
	  else (do
	    h <- openFile output_fn WriteMode
	    hPutStrLn h ("{-# LINE 1 \"" ++ input_fn ++ "\" #-}")
	    ls <- readFile input_fn -- inefficient, but it'll do for now.
	    			    -- ToDo: speed up via slurping.
	    hPutStrLn h ls
	    hClose h) `catchAllIO`
	    	        (\_ -> throwDyn (PhaseFailed "Ineffective C pre-processor" (ExitFailure 1)))
#else
364
	  else do
365
	    runSomething "Ineffective C pre-processor"
366
	           ("echo '{-# LINE 1 \""  ++ input_fn ++ "\" #-}' > " 
367 368
		    ++ output_fn ++ " && cat " ++ input_fn
		    ++ " >> " ++ output_fn)
sof's avatar
sof committed
369
#endif
370 371 372 373 374 375 376
       return True

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

run_phase MkDependHS basename suff input_fn _output_fn = do 
   src <- readFile input_fn
377
   let (import_sources, import_normals, module_name) = getImports src
378

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

384
   osuf_opt <- readIORef v_Object_suf
385
   let osuf = case osuf_opt of
386
			Nothing -> phaseInputExt Ln
387 388
			Just s  -> s

389
   extra_suffixes <- readIORef v_Dep_suffixes
390 391 392 393 394
   let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
       ofiles = map (\suf -> basename ++ '.':suf) suffixes
   	   
   objs <- mapM odir_ify ofiles
   
395
   hdl <- readIORef v_Dep_tmp_hdl
396

397
	-- std dependency of the object(s) on the source file
398 399 400 401 402
   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
403
	  hisuf <- readIORef v_Hi_suf
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
	  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 ]

   return True

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

435 436
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
437
run_phase Hsc basename suff input_fn output_fn
438
  = do
439 440 441 442 443 444
	
  -- 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
	
445 446
	paths <- readIORef v_Include_paths
	writeIORef v_Include_paths (current_dir : paths)
447
	
448 449 450 451 452
  -- 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 
453
				 (c_includes ++ reverse cmdline_includes))
454 455 456 457 458 459 460 461
	    mk_include h_file = 
		case h_file of 
		   '"':_{-"-} -> "#include "++h_file
		   '<':_      -> "#include "++h_file
		   _          -> "#include \""++h_file++"\""

	writeIORef v_HCHeader cc_injects

462 463 464 465 466 467 468 469 470 471 472 473
  -- gather the imports and module name
        (srcimps,imps,mod_name) <- getImportsFromFile input_fn

  -- build a ModuleLocation to pass to hscMain.
	Just (mod, location')
	   <- mkHomeModuleLocn mod_name basename (basename ++ '.':suff)

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

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

498 499 500
  -- get the DynFlags
        dyn_flags <- readIORef v_DynFlags

501 502 503 504
        let dyn_flags' = dyn_flags { hscOutName = output_fn,
		   		     hscStubCOutName = basename ++ "_stub.c",
				     hscStubHOutName = basename ++ "_stub.h" }

505
  -- run the compiler!
506
        pcs <- initPersistentCompilerState
507
	result <- hscMain OneShot
508
                          dyn_flags' mod
509
			  location{ ml_hspp_file=Just input_fn }
510
			  source_unchanged
511
			  False
512 513 514 515
			  Nothing	 -- no iface
			  emptyModuleEnv -- HomeSymbolTable
			  emptyModuleEnv -- HomeIfaceTable
			  pcs
516 517 518

	case result of {

519
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
520

521 522
            HscNoRecomp pcs details iface -> 
	        do {
sof's avatar
sof committed
523 524 525 526
#if defined(mingw32_TARGET_OS) && defined(MINIMAL_UNIX_DEPS)
		  touch <- readIORef v_Pgm_T;
		  runSomething "Touching object file" (unwords [dosifyPath touch, dosifyPath o_file]);
#else
sof's avatar
sof committed
527
		  runSomething "Touching object file" (unwords [cTOUCH, o_file]);
sof's avatar
sof committed
528
#endif
529 530
		  return False;
		};
531

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

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

541
	return True
542
    }
543 544 545 546 547 548 549

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

550
run_phase cc_phase basename suff input_fn output_fn
551
   | cc_phase == Cc || cc_phase == HCc
sof's avatar
sof committed
552
   = do	cc  <- readIORef v_Pgm_c >>= prependToolDir >>= appendInstallDir
553
       	cc_opts <- (getOpts opt_c)
554
       	cmdline_include_dirs <- readIORef v_Include_paths
555 556 557 558 559 560 561 562 563 564

        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
	let include_paths = map (\p -> "-I"++p) (cmdline_include_dirs 
							++ pkg_include_dirs)

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
581
	runSomething "C Compiler"
582
	 (unwords ([ cc, "-x", "c", input_fn, "-o", output_fn ]
583 584 585 586 587 588 589
		   ++ md_c_flags
		   ++ (if cc_phase == HCc && mangle
			 then md_regd_c_flags
			 else [])
		   ++ [ verb, "-S", "-Wimplicit", opt_flag ]
		   ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		   ++ cc_opts
590
		   ++ split_opt
591 592 593 594 595 596 597 598 599 600 601 602
		   ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		   ++ include_paths
		   ++ pkg_extra_cc_opts
		   ))
	return True

	-- ToDo: postprocess the output from gcc

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

run_phase Mangle _basename _suff input_fn output_fn
603
  = do mangler <- readIORef v_Pgm_m
604 605 606
       mangler_opts <- getOpts opt_m
       machdep_opts <-
	 if (prefixMatch "i386" cTARGETPLATFORM)
607
	    then do n_regs <- dynFlag stolen_x86_regs
608 609
		    return [ show n_regs ]
	    else return []
sof's avatar
sof committed
610 611 612 613 614 615
#if defined(mingw32_TARGET_OS) && defined(MINIMAL_UNIX_DEPS)
       perl_path <- prependToolDir ("perl")
       let real_mangler = unwords [perl_path, mangler]
#else
       let real_mangler = mangler
#endif
616
       runSomething "Assembly Mangler"
sof's avatar
sof committed
617
	(unwords (real_mangler : mangler_opts
618 619 620 621 622 623 624 625 626
		  ++ [ input_fn, output_fn ]
		  ++ machdep_opts
		))
       return True

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

run_phase SplitMangle _basename _suff input_fn _output_fn
627
  = do  splitter <- readIORef v_Pgm_s
628 629
	-- this is the prefix used for the split .s files
	tmp_pfx <- readIORef v_TmpDir
630
	x <- myGetProcessID
631
	let split_s_prefix = tmp_pfx ++ "/ghc" ++ show x
632
	writeIORef v_Split_prefix split_s_prefix
633 634 635 636 637
	addFilesToClean [split_s_prefix ++ "__*"] -- d:-)

	-- allocate a tmp file to put the no. of split .s files in (sigh)
	n_files <- newTempName "n_files"

sof's avatar
sof committed
638 639 640 641 642 643
#if defined(mingw32_TARGET_OS) && defined(MINIMAL_UNIX_DEPS)
        perl_path <- prependToolDir ("perl")
        let real_splitter = unwords [perl_path, splitter]
#else
        let real_splitter = splitter
#endif
644
	runSomething "Split Assembly File"
sof's avatar
sof committed
645
	 (unwords [ real_splitter
646 647 648 649 650 651 652 653
		  , input_fn
		  , split_s_prefix
		  , n_files ]
	 )

	-- save the number of split files for future references
	s <- readFile n_files
	let n = read s :: Int
654
	writeIORef v_N_split_files n
655 656 657 658 659 660
	return True

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

run_phase As _basename _suff input_fn output_fn
sof's avatar
sof committed
661
  = do	as <- readIORef v_Pgm_a >>= prependToolDir >>= appendInstallDir
662 663
        as_opts <- getOpts opt_a

664
        cmdline_include_paths <- readIORef v_Include_paths
665
        let cmdline_include_flags = map (\p -> "-I"++p) cmdline_include_paths
666
        runSomething "Assembler"
667 668 669 670 671 672 673
	   (unwords (as : as_opts
		       ++ cmdline_include_flags
		       ++ [ "-c", input_fn, "-o",  output_fn ]
		    ))
	return True

run_phase SplitAs basename _suff _input_fn _output_fn
674
  = do  as <- readIORef v_Pgm_a
675 676
        as_opts <- getOpts opt_a

677 678
	split_s_prefix <- readIORef v_Split_prefix
	n <- readIORef v_N_split_files
679

680
	odir <- readIORef v_Output_dir
681 682 683 684 685 686 687 688 689
	let real_odir = case odir of
				Nothing -> basename
				Just d  -> d

	let assemble_file n = do
		    let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
		    let output_o = newdir real_odir 
					(basename ++ "__" ++ show n ++ ".o")
		    real_o <- osuf_ify output_o
690
		    runSomething "Assembler" 
691 692 693 694 695 696 697
			    (unwords (as : as_opts
				      ++ [ "-c", "-o", real_o, input_s ]
			    ))
	
	mapM_ assemble_file [1..n]
	return True

698 699 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 770 771 772 773 774 775 776 777 778 779 780 781 782
-----------------------------------------------------------------------------
-- 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);"
 ]

783 784 785 786
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

checkProcessArgsResult flags basename suff
787
  = do when (not (null flags)) (throwDyn (ProgramError (
788 789 790 791
           basename ++ "." ++ suff 
           ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
           ++ unwords flags)) (ExitFailure 1))

792 793 794 795 796
-----------------------------------------------------------------------------
-- Linking

doLink :: [String] -> IO ()
doLink o_files = do
sof's avatar
sof committed
797
    ln <- readIORef v_Pgm_l >>= prependToolDir >>= appendInstallDir
798
    verb <- getVerbFlag
799 800 801 802
    static <- readIORef v_Static
    let imp = if static then "" else "_imp"
    no_hs_main <- readIORef v_NoHsMain

803
    o_file <- readIORef v_Output_file
804 805 806 807 808
    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

809
    lib_paths <- readIORef v_Library_paths
810 811 812
    let lib_path_opts = map ("-L"++) lib_paths

    pkg_libs <- getPackageLibraries
813
    let pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
814

815
    libs <- readIORef v_Cmdline_libraries
816 817 818 819 820 821
    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
822
    extra_ld_inputs <- readIORef v_Ld_inputs
823 824

	-- opts from -optl-<blah>
825
    extra_ld_opts <- getStaticOpts v_Opt_l
826

827 828 829 830 831
    rts_pkg <- getPackageDetails ["rts"]
    std_pkg <- getPackageDetails ["std"]
#ifdef mingw32_TARGET_OS
    let extra_os = if static || no_hs_main
                   then []
rrt's avatar
rrt committed
832 833
                   else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
                          head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
834 835
#endif
    (md_c_flags, _) <- machdepCCOpts
836
    runSomething "Linker"
837
       (unwords
838
	 ([ ln, verb, "-o", output_fn ]
839
	 ++ md_c_flags
840
	 ++ o_files
841 842 843
#ifdef mingw32_TARGET_OS
	 ++ extra_os
#endif
844 845 846 847 848 849 850
	 ++ extra_ld_inputs
	 ++ lib_path_opts
	 ++ lib_opts
	 ++ pkg_lib_path_opts
	 ++ pkg_lib_opts
	 ++ pkg_extra_ld_opts
	 ++ extra_ld_opts
851 852 853 854 855
#ifdef mingw32_TARGET_OS
         ++ if static then [ "-u _PrelMain_mainIO_closure" , "-u ___init_PrelMain"] else []
#else
	 ++ [ "-u PrelMain_mainIO_closure" , "-u __init_PrelMain"]
#endif
856 857
	)
       )
858 859 860 861 862
    -- 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 ()
863
                                             else throwDyn (InstallationError ("cannot move binary to PVM dir")))
864

rrt's avatar
rrt committed
865 866 867 868 869 870 871
-----------------------------------------------------------------------------
-- Making a DLL

-- only for Win32, but bits that are #ifdefed in doLn are still #ifdefed here
-- in a vain attempt to aid future portability
doMkDLL :: [String] -> IO ()
doMkDLL o_files = do
sof's avatar
sof committed
872
    ln <- readIORef v_Pgm_dll >>= prependToolDir >>= appendInstallDir
rrt's avatar
rrt committed
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
    verb <- getVerbFlag
    static <- readIORef v_Static
    let imp = if static then "" else "_imp"
    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
    let pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs

    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"]
#ifdef mingw32_TARGET_OS
    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" ]
#endif
    (md_c_flags, _) <- machdepCCOpts
    runSomething "DLL creator"
       (unwords
	 ([ ln, verb, "-o", output_fn ]
	 ++ md_c_flags
	 ++ o_files
#ifdef mingw32_TARGET_OS
	 ++ extra_os
	 ++ [ "--target=i386-mingw32" ]
#endif
	 ++ 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
	)
       )

933 934 935 936 937 938
-----------------------------------------------------------------------------
-- 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 =
939
  ASSERT(haskellish_src_file filename) 
940 941
  do init_dyn_flags <- readIORef v_InitDynFlags
     writeIORef v_DynFlags init_dyn_flags
942
     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
943
			defaultHscLang filename
944
     runPipeline pipeline filename False{-no linking-} False{-no -o flag-}
945 946

-----------------------------------------------------------------------------
947
-- Compile a single module, under the control of the compilation manager.
948 949 950 951 952 953
--
-- 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.

954 955 956 957 958 959
-- 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.

960 961 962 963
-- NB.  No old interface can also mean that the source has changed.

compile :: GhciMode                -- distinguish batch from interactive
        -> ModSummary              -- summary, including source
964 965
	-> Bool			   -- True <=> source unchanged
	-> Bool			   -- True <=> have object
966
        -> Maybe ModIface          -- old interface, if available
967 968
        -> HomeSymbolTable         -- for home module ModDetails
	-> HomeIfaceTable	   -- for home module Ifaces
969 970 971
        -> PersistentCompilerState -- persistent compiler state
        -> IO CompResult

972
data CompResult
973 974 975 976 977 978
   = 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)
979 980 981 982

   | CompErrs PersistentCompilerState	-- updated PCS


983 984
compile ghci_mode summary source_unchanged have_object 
	old_iface hst hit pcs = do 
985 986
   init_dyn_flags <- readIORef v_InitDynFlags
   writeIORef v_DynFlags init_dyn_flags
987

988 989
   showPass init_dyn_flags 
	(showSDoc (text "Compiling" <+> ppr (name_of_summary summary)))
990 991

   let verb = verbosity init_dyn_flags
992
   let location   = ms_location summary
993 994
   let input_fn   = unJust "compile:hs" (ml_hs_file location) 
   let input_fnpp = unJust "compile:hspp" (ml_hspp_file location)
995

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

998
   opts <- getOptionsFromSource input_fnpp
999 1000 1001
   processArgs dynamic_flags opts []
   dyn_flags <- readIORef v_DynFlags

1002
   let hsc_lang = hscLang dyn_flags
1003 1004
       (basename, _) = splitFilename input_fn
       
1005 1006 1007 1008
   output_fn <- case hsc_lang of
		    HscAsm         -> newTempName (phaseInputExt As)
		    HscC           -> newTempName (phaseInputExt HCc)
        	    HscJava        -> newTempName "java" -- ToDo
1009
		    HscILX         -> return (basename ++ ".ilx") 	-- newTempName "ilx"	-- ToDo
1010
		    HscInterpreted -> return (error "no output file")
1011

1012
   let dyn_flags' = dyn_flags { hscOutName = output_fn,
1013 1014 1015
				hscStubCOutName = basename ++ "_stub.c",
				hscStubHOutName = basename ++ "_stub.h" }

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
   -- 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

1030
   -- run the compiler
1031
   hsc_result <- hscMain ghci_mode dyn_flags'
1032
			 (ms_mod summary) location
1033
			 source_unchanged have_object old_iface hst hit pcs
1034

1035 1036
   case hsc_result of
      HscFail pcs -> return (CompErrs pcs)
1037

1038
      HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)
1039

1040
      HscRecomp pcs details iface
1041
	stub_h_exists stub_c_exists maybe_interpreted_code -> do
1042
	   
1043 1044
	   let 
	   maybe_stub_o <- compileStub dyn_flags' stub_c_exists
1045 1046 1047
	   let stub_unlinked = case maybe_stub_o of
				  Nothing -> []
				  Just stub_o -> [ DotO stub_o ]
1048

1049
	   (hs_unlinked, unlinked_time) <-
1050 1051 1052 1053
	     case hsc_lang of

		-- in interpreted mode, just return the compiled code
		-- as our "unlinked" object.
1054
		HscInterpreted -> 
1055
		    case maybe_interpreted_code of