DriverPipeline.hs 40.4 KB
Newer Older
1 2 3 4
-----------------------------------------------------------------------------
--
-- GHC Driver
--
5
-- (c) The University of Glasgow 2002
6 7 8
--
-----------------------------------------------------------------------------

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

11
module DriverPipeline (
12 13

	-- interfaces for the batch-mode driver
14
   genPipeline, runPipeline, pipeLoop,
15 16

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

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

#include "HsVersions.h"

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

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

import IO
import Monad
import Maybe

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

61 62 63 64
-----------------------------------------------------------------------------
-- genPipeline
--
-- Herein is all the magic about which phases to run in which order, whether
rrt's avatar
rrt committed
65
-- the intermediate files should be in TMPDIR or in the current directory,
66 67 68
-- what the suffix of the intermediate files should be, etc.

-- The following compilation pipeline algorithm is fairly hacky.  A
rrt's avatar
rrt committed
69
-- better way to do this would be to express the whole compilation as a
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
-- 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
85 86
-- that the C compiler from the first compilation can be overlapped
-- with the hsc compilation for the second file.
87 88 89 90

data IntermediateFileType
  = Temporary
  | Persistent
91
  deriving (Eq, Show)
92 93

genPipeline
sof's avatar
sof committed
94 95 96 97 98
   :: 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 
99 100 101 102 103 104
   -> 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
105
genPipeline todo stop_flag persistent_output lang (filename,suffix)
106
 = do
107 108 109
   split      <- readIORef v_Split_object_files
   mangle     <- readIORef v_Do_asm_mangling
   keep_hc    <- readIORef v_Keep_hc_files
sof's avatar
sof committed
110
#ifdef ILX
rrt's avatar
rrt committed
111
   keep_il    <- readIORef v_Keep_il_files
sof's avatar
sof committed
112 113
   keep_ilx   <- readIORef v_Keep_ilx_files
#endif
114 115
   keep_raw_s <- readIORef v_Keep_raw_s_files
   keep_s     <- readIORef v_Keep_s_files
116
   osuf       <- readIORef v_Object_suf
117
   hcsuf      <- readIORef v_HC_suf
118 119 120

   let
   ----------- -----  ----   ---   --   --  -  -  -
121 122 123 124 125
    start = startPhase suffix

      -- special case for mkdependHS: .hspp files go through MkDependHS
    start_phase | todo == DoMkDependHS && start == Hsc  = MkDependHS
	        | otherwise = start
126 127 128 129

    haskellish = haskellish_suffix suffix
    cish = cish_suffix suffix

130
       -- for a .hc file we need to force lang to HscC
131 132
    real_lang | start_phase == HCc || start_phase == Mangle = HscC
	      | otherwise                                   = lang
133 134 135

   let
   ----------- -----  ----   ---   --   --  -  -  -
136 137 138 139 140 141 142 143 144 145
    pipeline = preprocess ++ compile

    preprocess
	| haskellish = [ Unlit, Cpp, HsPp ]
	| otherwise  = [ ]

    compile
      | todo == DoMkDependHS = [ MkDependHS ]

      | cish = [ Cc, As ]
146 147 148

      | haskellish = 
       case real_lang of
149 150
	HscC    | split && mangle -> [ Hsc, HCc, Mangle, SplitMangle, SplitAs ]
	        | mangle          -> [ Hsc, HCc, Mangle, As ]
151
	        | split	       	  -> not_valid
152
	        | otherwise       -> [ Hsc, HCc, As ]
153

154 155
	HscAsm  | split           -> [ Hsc, SplitMangle, SplitAs ]
	        | otherwise       -> [ Hsc, As ]
156 157 158

	HscJava	| split	          -> not_valid
		| otherwise       -> error "not implemented: compiling via Java"
159
#ifdef ILX
rrt's avatar
rrt committed
160
	HscILX  | split           -> not_valid
161
		| otherwise       -> [ Hsc, Ilx2Il, Ilasm ]
162
#endif
163
	HscNothing		  -> [ Hsc, HCc ] -- HCc is a dummy stop phase
164 165 166 167

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

	-- ToDo: this is somewhat cryptic
168
    not_valid = throwDyn (UsageError ("invalid option combination"))
169 170 171

    stop_phase = case todo of 
			StopBefore As | split -> SplitAs
172
#ifdef ILX
rrt's avatar
rrt committed
173
                                      | real_lang == HscILX -> Ilasm
174
#endif
175 176 177
			StopBefore phase      -> phase
			DoMkDependHS	      -> Ln
			DoLink                -> Ln
sof's avatar
sof committed
178
			DoMkDLL               -> Ln
179 180 181
   ----------- -----  ----   ---   --   --  -  -  -

	-- this shouldn't happen.
sof's avatar
sof committed
182 183 184
   when (start_phase /= Ln && start_phase `notElem` pipeline)
	(throwDyn (CmdLineError ("can't find starting phase for "
			         ++ filename)))
185 186 187 188
	-- 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).
sof's avatar
sof committed
189 190 191
   when (start_phase `elem` pipeline && 
   	 (stop_phase /= Ln && stop_phase `notElem` pipeline))
        (throwDyn (UsageError 
192 193 194
		    ("flag `" ++ stop_flag
		     ++ "' is incompatible with source file `"
		     ++ filename ++ "'" ++ show pipeline ++ show stop_phase)))
195
   let
196 197 198 199
	-- .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
200

201 202 203 204 205 206 207
      annotatePipeline
	 :: [Phase]		-- raw pipeline
	 -> Phase		-- phase to stop before
     	 -> [(Phase, IntermediateFileType, String{-file extension-})]
      annotatePipeline []     _    = []
      annotatePipeline (Ln:_) _    = []
      annotatePipeline (phase:next_phase:ps) stop = 
208
     	  (phase, keep_this_output, myPhaseInputExt next_phase)
209 210 211
	     : annotatePipeline (next_phase:ps) stop
     	  where
     		keep_this_output
212 213 214 215
     		     | next_phase == stop 
                     = if persistent_output then Persistent else Temporary
     		     | otherwise
     		     = case next_phase of
216 217 218 219
     			     Ln -> Persistent
     			     Mangle | keep_raw_s -> Persistent
     			     As     | keep_s     -> Persistent
     			     HCc    | keep_hc    -> Persistent
220
#ifdef ILX
sof's avatar
sof committed
221
			     Ilx2Il | keep_ilx   -> Persistent
rrt's avatar
rrt committed
222
			     Ilasm  | keep_il    -> Persistent
223
#endif
224 225 226 227 228 229
     			     _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.
230 231

      annotated_pipeline = annotatePipeline (pipeline ++ [Ln]) stop_phase
232 233 234 235

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

236 237 238 239 240
   return (
     takeWhile (phase_ne stop_phase ) $
     dropWhile (phase_ne start_phase) $
     annotated_pipeline
    )
241 242 243 244


runPipeline
  :: [ (Phase, IntermediateFileType, String) ] -- phases to run
sof's avatar
sof committed
245
  -> (String,String)		-- input file
246 247
  -> Bool			-- doing linking afterward?
  -> Bool			-- take into account -o when generating output?
sof's avatar
sof committed
248
  -> IO (String, String)	-- return final filename
249

sof's avatar
sof committed
250 251 252
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
253 254

pipeLoop [] input_fn _ _ _ _ = return input_fn
apt's avatar
apt committed
255
pipeLoop (all_phases@((phase, keep, o_suffix):phases))
sof's avatar
sof committed
256
	(input_fn,real_suff) do_linking use_ofile orig_basename orig_suffix
257 258 259 260
  = do

     output_fn <- outputFileName (null phases) keep o_suffix

sof's avatar
sof committed
261 262
     mbCarryOn <- run_phase phase orig_basename orig_suffix
     			    input_fn output_fn 
263 264
	-- sometimes we bail out early, eg. when the compiler's recompilation
	-- checker has determined that recompilation isn't necessary.
sof's avatar
sof committed
265 266
     case mbCarryOn of
       Nothing -> do
apt's avatar
apt committed
267
	      let (_,keep,final_suffix) = last all_phases
sof's avatar
sof committed
268
	      ofile <- outputFileName True keep final_suffix
sof's avatar
sof committed
269
	      return (ofile, final_suffix)
sof's avatar
sof committed
270
          -- carry on ...
sof's avatar
sof committed
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
       Just fn -> do
		{-
		  Check to see whether we've reached the end of the
		  pipeline, but did so with an ineffective last stage.
		  (i.e., it returned the input_fn as the output filename).
		  
		  If we did and the output is persistent, copy the contents
		  of input_fn into the file where the pipeline's output is
		  expected to end up.
		-}
	      atEnd <- finalStage (null phases)
	      when (atEnd && fn == input_fn)
	      	   (copy "Saving away compilation pipeline's output"
		   	 input_fn
			 output_fn)
sof's avatar
sof committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
              {-
	       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
305
  where
sof's avatar
sof committed
306 307 308 309
     finalStage lastPhase = do
       o_file <- readIORef v_Output_file
       return (lastPhase && not do_linking && use_ofile && isJust o_file)

310
     outputFileName last_phase keep suffix
311
  	= do o_file <- readIORef v_Output_file
sof's avatar
sof committed
312 313
	     atEnd  <- finalStage last_phase
   	     if atEnd
314 315 316 317
   	       then case o_file of 
   		       Just s  -> return s
   		       Nothing -> error "outputFileName"
   	       else if keep == Persistent
318
   			   then odir_ify (orig_basename ++ '.':suffix)
319 320
   			   else newTempName suffix

sof's avatar
sof committed
321 322 323 324 325 326 327 328 329
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').
330 331 332 333
-------------------------------------------------------------------------------
-- Unlit phase 

run_phase Unlit _basename _suff input_fn output_fn
334
  = do unlit_flags <- getOpts opt_L
rrt's avatar
rrt committed
335
       -- The -h option passes the file name for unlit to put in a #line directive
sof's avatar
sof committed
336 337 338
       SysTools.runUnlit (map SysTools.Option unlit_flags ++
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
339 340
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
341
			  ])
sof's avatar
sof committed
342
       return (Just output_fn)
343 344 345 346

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

347
run_phase Cpp basename suff input_fn output_fn
348
  = do src_opts <- getOptionsFromSource input_fn
349
       unhandled_flags <- processArgs dynamic_flags src_opts []
350
       checkProcessArgsResult unhandled_flags basename suff
351

352
       do_cpp <- dynFlag cppFlag
sof's avatar
sof committed
353 354 355 356 357
       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
358
	    hscpp_opts	    <- getOpts opt_P
359
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
360

361
	    cmdline_include_paths <- readIORef v_Include_paths
362
	    pkg_include_dirs <- getPackageIncludePath
rrt's avatar
rrt committed
363 364
	    let include_paths = foldr (\ x xs -> "-I" : x : xs) []
				  (cmdline_include_paths ++ pkg_include_dirs)
365

366
	    verb <- getVerbFlag
rrt's avatar
rrt committed
367
	    (md_c_flags, _) <- machdepCCOpts
368

sof's avatar
sof committed
369 370 371 372 373
	    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
sof's avatar
sof committed
374 375
			    ++ [ SysTools.Option     "-x"
			       , SysTools.Option     "c"
376 377 378 379 380 381 382 383 384
			       , SysTools.Option     input_fn
	-- We hackily use Option instead of FileOption here, so that the file
	-- name is not back-slashed on Windows.  cpp is capable of
	-- dealing with / in filenames, so it works fine.  Furthermore
	-- if we put in backslashes, cpp outputs #line directives
	-- with *double* backslashes.   And that in turn means that
	-- our error messages get double backslashes in them.
	-- In due course we should arrange that the lexer deals
	-- with these \\ escapes properly.
sof's avatar
sof committed
385
			       , SysTools.Option     "-o"
sof's avatar
sof committed
386
			       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
387
			       ])
sof's avatar
sof committed
388
	    return (Just output_fn)
389

sof's avatar
sof committed
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
-------------------------------------------------------------------------------
-- HsPp phase 
run_phase HsPp basename suff input_fn output_fn
  = do src_opts <- getOptionsFromSource input_fn
       unhandled_flags <- processArgs dynamic_flags src_opts []
       checkProcessArgsResult unhandled_flags basename suff

       let orig_fn = basename ++ '.':suff
       do_pp   <- dynFlag ppFlag
       if not do_pp then
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
          return (Just input_fn)
	else do
	    hspp_opts	   <- getOpts opt_F
       	    hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
	    SysTools.runPp ( [ SysTools.Option     orig_fn
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hs_src_pp_opts ++
			     map SysTools.Option hspp_opts
			   )
	    return (Just output_fn)

415 416 417
-----------------------------------------------------------------------------
-- MkDependHS phase

sof's avatar
sof committed
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
run_phase MkDependHS basename suff input_fn output_fn 
 = do src <- readFile input_fn
      let (import_sources, import_normals, _) = getImports src
      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
      let osuf = case osuf_opt of
		   Nothing -> phaseInputExt Ln
		   Just s  -> s

      extra_suffixes <- readIORef v_Dep_suffixes
      let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
          ofiles = map (\suf -> basename ++ '.':suf) suffixes

      objs <- mapM odir_ify ofiles

437
	-- Handle for file that accumulates dependencies 
sof's avatar
sof committed
438
      hdl <- readIORef v_Dep_tmp_hdl
439

440
	-- std dependency of the object(s) on the source file
sof's avatar
sof committed
441 442 443 444 445 446 447 448 449
      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
	     hisuf <- readIORef v_Hi_suf
	     let dep_base = remove_suffix '.' dep
	         deps = (dep_base ++ hisuf)
		        : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
450
		  -- length objs should be == length deps
sof's avatar
sof committed
451
	     sequence_ (zipWith (\o d -> hPutStrLn hdl (o ++ " : " ++ d)) objs deps)
452

sof's avatar
sof committed
453 454
      sequence_ (map genDep [ d | Just d <- deps ])
      return (Just output_fn)
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476

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

477 478
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
479
run_phase Hsc basename suff input_fn output_fn
480
  = do
481 482 483 484 485 486
	
  -- 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
	
487 488
	paths <- readIORef v_Include_paths
	writeIORef v_Include_paths (current_dir : paths)
489
	
490 491 492 493 494
  -- 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 
495
				 (c_includes ++ reverse cmdline_includes))
496 497 498 499 500 501 502 503
	    mk_include h_file = 
		case h_file of 
		   '"':_{-"-} -> "#include "++h_file
		   '<':_      -> "#include "++h_file
		   _          -> "#include \""++h_file++"\""

	writeIORef v_HCHeader cc_injects

504 505 506 507
  -- 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
508
	(mod, location')
sof's avatar
sof committed
509
	   <- mkHomeModuleLocn mod_name basename (basename ++ '.':suff)
510 511 512 513 514 515

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

516 517 518 519
  -- 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?)
  --
520
  -- Setting source_unchanged to True means that M.o seems
521 522
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
523
  -- Setting source_unchanged to False tells the compiler that M.o is out of
524
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
sof's avatar
sof committed
525 526 527 528 529 530 531
	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
532 533
	source_unchanged <- 
          if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
534
	     then return False
535 536 537
	     else do t1 <- getModificationTime (basename ++ '.':suff)
		     o_file_exists <- doesFileExist o_file
		     if not o_file_exists
538
		        then return False	-- Need to recompile
539 540
			else do t2 <- getModificationTime o_file
			        if t2 > t1
541 542
				  then return True
				  else return False
543

544
  -- get the DynFlags
545
        dyn_flags <- getDynFlags
546

547 548
        let dyn_flags' = dyn_flags { hscOutName = output_fn,
		   		     hscStubCOutName = basename ++ "_stub.c",
apt's avatar
apt committed
549
				     hscStubHOutName = basename ++ "_stub.h",
apt's avatar
apt committed
550
				     extCoreName = basename ++ ".hcr" }
551

552
  -- run the compiler!
553
        pcs <- initPersistentCompilerState
554
	result <- hscMain OneShot
555
                          dyn_flags' mod
556
			  location{ ml_hspp_file=Just input_fn }
557
			  source_unchanged
558
			  False
559 560 561 562
			  Nothing	 -- no iface
			  emptyModuleEnv -- HomeSymbolTable
			  emptyModuleEnv -- HomeIfaceTable
			  pcs
563 564 565

	case result of {

566
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
567

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

571
	    HscRecomp pcs details iface stub_h_exists stub_c_exists
572
		      _maybe_interpreted_code -> do
573

apt's avatar
apt committed
574 575 576 577 578 579 580 581
			    -- deal with stubs
			    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
			    case hscLang dyn_flags of
                              HscNothing -> return Nothing
			      _ -> return (Just output_fn)
582
    }
583 584 585 586 587 588 589

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

590
run_phase cc_phase basename suff input_fn output_fn
591
   | cc_phase == Cc || cc_phase == HCc
592
   = do	cc_opts		     <- getOpts opt_c
rrt's avatar
rrt committed
593
       	cmdline_include_paths <- readIORef v_Include_paths
594 595 596 597 598 599 600

        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
601 602
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
603

604
	mangle <- readIORef v_Do_asm_mangling
605 606
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

607
        verb <- getVerbFlag
608

609
	o2 <- readIORef v_minus_o2_for_C
610 611 612 613 614
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

	pkg_extra_cc_opts <- getPackageExtraCcOpts

615 616
	split_objs <- readIORef v_Split_object_files

617
	excessPrecision <- readIORef v_Excess_precision
618 619 620 621 622 623 624 625 626

	-- force the C compiler to interpret this file as C when
	-- compiling .hc files, by adding the -x c option.
	let langopt
		| cc_phase == HCc = [ SysTools.Option "-x", SysTools.Option "c"]
		| otherwise       = [ ]

	SysTools.runCc (langopt ++
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
627
			, SysTools.Option "-o"
sof's avatar
sof committed
628
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
629 630 631
			]
		       ++ map SysTools.Option (
		          md_c_flags
632 633 634 635 636 637 638 639 640
		       ++ (if cc_phase == HCc && mangle
		  	     then md_regd_c_flags
		  	     else [])
		       ++ [ verb, "-S", "-Wimplicit", opt_flag ]
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
641
		       ))
sof's avatar
sof committed
642
	return (Just output_fn)
643 644 645 646 647 648 649

	-- ToDo: postprocess the output from gcc

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

run_phase Mangle _basename _suff input_fn output_fn
650 651 652 653 654 655
  = 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
656
       SysTools.runMangle (map SysTools.Option mangler_opts
sof's avatar
sof committed
657 658
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
659 660
			     ]
			  ++ map SysTools.Option machdep_opts)
sof's avatar
sof committed
661
       return (Just output_fn)
662 663 664 665

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

sof's avatar
sof committed
666
run_phase SplitMangle _basename _suff input_fn output_fn
667 668 669 670
  = 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
671

sof's avatar
sof committed
672 673 674
	SysTools.runSplit [ SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
675
			  ]
676 677 678 679 680 681 682 683 684

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

sof's avatar
sof committed
686
	return (Just output_fn)
687 688 689 690 691

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

run_phase As _basename _suff input_fn output_fn
692
  = do	as_opts		      <- getOpts opt_a
693
        cmdline_include_paths <- readIORef v_Include_paths
694

sof's avatar
sof committed
695 696 697
	SysTools.runAs (map SysTools.Option as_opts
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
698
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
699
			  , SysTools.Option "-o"
sof's avatar
sof committed
700
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
701
			  ])
sof's avatar
sof committed
702
	return (Just output_fn)
703

sof's avatar
sof committed
704
run_phase SplitAs basename _suff _input_fn output_fn
705
  = do  as_opts <- getOpts opt_a
706

707
	(split_s_prefix, n) <- readIORef v_Split_info
708

709
	odir <- readIORef v_Output_dir
710 711 712 713
	let real_odir = case odir of
				Nothing -> basename
				Just d  -> d

714 715
	let assemble_file n
	      = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
716 717 718
		    let output_o = newdir real_odir 
					(basename ++ "__" ++ show n ++ ".o")
		    real_o <- osuf_ify output_o
sof's avatar
sof committed
719 720 721
		    SysTools.runAs (map SysTools.Option as_opts ++
		    		    [ SysTools.Option "-c"
				    , SysTools.Option "-o"
sof's avatar
sof committed
722 723
				    , SysTools.FileOption "" real_o
				    , SysTools.FileOption "" input_s
sof's avatar
sof committed
724
				    ])
725 726
	
	mapM_ assemble_file [1..n]
sof's avatar
sof committed
727
	return (Just output_fn)
728

rrt's avatar
rrt committed
729 730 731 732 733 734 735
#ifdef ILX
-----------------------------------------------------------------------------
-- Ilx2Il phase
-- Run ilx2il over the ILX output, getting an IL file

run_phase Ilx2Il _basename _suff input_fn output_fn
  = do	ilx2il_opts <- getOpts opt_I
rrt's avatar
rrt committed
736 737 738 739
        SysTools.runIlx2il (map SysTools.Option ilx2il_opts
                           ++ [ SysTools.Option "--no-add-suffix-to-assembly",
				SysTools.Option "mscorlib",
				SysTools.Option "-o",
sof's avatar
sof committed
740 741
				SysTools.FileOption "" output_fn,
				SysTools.FileOption "" input_fn ])
rrt's avatar
rrt committed
742 743 744 745 746 747 748 749
	return (Just output_fn)

-----------------------------------------------------------------------------
-- Ilasm phase
-- Run ilasm over the IL, getting a DLL

run_phase Ilasm _basename _suff input_fn output_fn
  = do	ilasm_opts <- getOpts opt_i
rrt's avatar
rrt committed
750 751 752
        SysTools.runIlasm (map SysTools.Option ilasm_opts
		           ++ [ SysTools.Option "/QUIET",
				SysTools.Option "/DLL",
sof's avatar
sof committed
753 754
				SysTools.FileOption "/OUT=" output_fn,
				SysTools.FileOption "" input_fn ])
rrt's avatar
rrt committed
755 756 757 758
	return (Just output_fn)

#endif -- ILX

759 760 761 762 763 764 765 766 767 768 769 770 771
-----------------------------------------------------------------------------
-- 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	
772
        sysMan   <- getSysMan
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
        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);"
 ]

843 844 845 846
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

checkProcessArgsResult flags basename suff
847
  = do when (not (null flags)) (throwDyn (ProgramError (
848 849 850 851
           basename ++ "." ++ suff 
           ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
           ++ unwords flags)) (ExitFailure 1))

852 853 854 855 856
-----------------------------------------------------------------------------
-- Linking

doLink :: [String] -> IO ()
doLink o_files = do
857 858
    verb       <- getVerbFlag
    static     <- readIORef v_Static
859 860
    no_hs_main <- readIORef v_NoHsMain

861
    o_file <- readIORef v_Output_file
862 863 864 865 866
    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

867
    lib_paths <- readIORef v_Library_paths
868 869 870
    let lib_path_opts = map ("-L"++) lib_paths

    pkg_libs <- getPackageLibraries
871 872
    let imp	     = if static then "" else "_imp"
        pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
873

874
    libs <- readIORef v_Cmdline_libraries
875 876 877 878 879 880
    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
881
    extra_ld_inputs <- readIORef v_Ld_inputs
882 883

	-- opts from -optl-<blah>
884
    extra_ld_opts <- getStaticOpts v_Opt_l
885

886 887 888 889
    rts_pkg <- getPackageDetails ["rts"]
    std_pkg <- getPackageDetails ["std"]
    let extra_os = if static || no_hs_main
                   then []
rrt's avatar
rrt committed
890 891
                   else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
                          head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
892

893
    (md_c_flags, _) <- machdepCCOpts
sof's avatar
sof committed
894 895
    SysTools.runLink ( [ SysTools.Option verb
    		       , SysTools.Option "-o"
sof's avatar
sof committed
896
		       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
897 898 899
		       ]
		      ++ map SysTools.Option (
		         md_c_flags
900 901 902 903 904 905 906 907 908
	 	      ++ 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
909
	              ++ if static && not no_hs_main then
rrt's avatar
rrt committed
910
			    [ "-u", prefixUnderscore "PrelMain_mainIO_closure",
ken's avatar
ken committed
911
			      "-u", prefixUnderscore "__stginit_PrelMain"] 
sof's avatar
sof committed
912
			 else []))
913

914 915
    -- parallel only: move binary to another dir -- HWL
    ways_ <- readIORef v_Ways
916 917 918 919
    when (WayPar `elem` ways_)
	 (do success <- run_phase_MoveBinary output_fn
             if success then return ()
                        else throwDyn (InstallationError ("cannot move binary to PVM dir")))
920

rrt's avatar
rrt committed
921
-----------------------------------------------------------------------------
922
-- Making a DLL (only for Win32)
rrt's avatar
rrt committed
923 924 925

doMkDLL :: [String] -> IO ()
doMkDLL o_files = do
926 927
    verb       <- getVerbFlag
    static     <- readIORef v_Static
rrt's avatar
rrt committed
928 929 930 931 932 933 934 935 936 937 938 939
    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
940 941
    let imp = if static then "" else "_imp"
        pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
rrt's avatar
rrt committed
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956

    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"]
957

rrt's avatar
rrt committed
958 959 960 961
    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" ]
962

rrt's avatar
rrt committed
963
    (md_c_flags, _) <- machdepCCOpts
964
    SysTools.runMkDLL
sof's avatar
sof committed
965 966
	 ([ SysTools.Option verb
	  , SysTools.Option "-o"
sof's avatar
sof committed
967
	  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
968 969 970
	  ]
	 ++ map SysTools.Option (
	    md_c_flags
rrt's avatar
rrt committed
971 972 973 974 975 976 977 978 979 980 981 982 983
	 ++ 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
984
	))
rrt's avatar
rrt committed
985

986 987 988 989 990 991
-----------------------------------------------------------------------------
-- 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 =
992
  ASSERT(haskellish_src_file filename) 
993
  do restoreDynFlags	-- Restore to state of last save
sof's avatar
sof committed
994
     let fInfo = (filename, getFileSuffix filename)
995
     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
sof's avatar
sof committed
996 997
			     defaultHscLang fInfo
     (fn,_)   <- runPipeline pipeline fInfo
sof's avatar
sof committed
998 999
     	                     False{-no linking-} False{-no -o flag-}
     return fn
1000 1001

-----------------------------------------------------------------------------
1002
-- Compile a single module,