DriverPipeline.hs 39.1 KB
Newer Older
1 2 3 4 5 6 7 8
-----------------------------------------------------------------------------
--
-- GHC Driver
--
-- (c) Simon Marlow 2000
--
-----------------------------------------------------------------------------

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

11
module DriverPipeline (
12 13

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

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

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

#include "HsVersions.h"

28
import Packages
29 30
import CmTypes
import GetImports
31 32 33
import DriverState
import DriverUtil
import DriverMkDepend
34
import DriverPhases
35
import DriverFlags
rrt's avatar
rrt committed
36
import SysTools		( newTempName, addFilesToClean, getSysMan, unDosifyPath )
37
import qualified SysTools	
38
import HscMain
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

modeFlag :: String -> Maybe GhcMode
modeFlag "-M" 		 = Just $ DoMkDependHS
rrt's avatar
rrt committed
67
modeFlag "--mk-dll"      = Just $ DoMkDLL
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
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)
	(_    , _   ) -> 
86
	  throwDyn (UsageError 
rrt's avatar
rrt committed
87
		"only one of the flags -M, -E, -C, -S, -c, --make, --interactive, -mk-dll is allowed")
88 89 90 91 92

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

-- The following compilation pipeline algorithm is fairly hacky.  A
rrt's avatar
rrt committed
97
-- better way to do this would be to express the whole compilation as a
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
-- 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
113 114
-- that the C compiler from the first compilation can be overlapped
-- with the hsc compilation for the second file.
115 116 117 118

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

genPipeline
sof's avatar
sof committed
122 123 124 125 126
   :: 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 
127 128 129 130 131 132
   -> 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
133
genPipeline todo stop_flag persistent_output lang (filename,suffix)
134
 = do
135 136 137
   split      <- readIORef v_Split_object_files
   mangle     <- readIORef v_Do_asm_mangling
   keep_hc    <- readIORef v_Keep_hc_files
rrt's avatar
rrt committed
138
   keep_il    <- readIORef v_Keep_il_files
139 140
   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"
177
#ifdef ILX
rrt's avatar
rrt committed
178
	HscILX  | split           -> not_valid
rrt's avatar
rrt committed
179
		| otherwise       -> [ Unlit, Cpp, Hsc, Ilx2Il, Ilasm ]
180
#endif
apt's avatar
apt committed
181
	HscNothing 		  -> [ Unlit, Cpp, Hsc ]
182 183 184 185 186 187

      | cish      = [ Cc, As ]

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

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

    stop_phase = case todo of 
			StopBefore As | split -> SplitAs
192
#ifdef ILX
rrt's avatar
rrt committed
193
                                      | real_lang == HscILX -> Ilasm
194
#endif
195 196 197
			StopBefore phase      -> phase
			DoMkDependHS	      -> Ln
			DoLink                -> Ln
198 199 200 201
   ----------- -----  ----   ---   --   --  -  -  -

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

206 207 208 209 210 211 212 213 214 215 216
	-- 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

217
   let
218 219 220 221
	-- .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
222

223 224 225 226 227 228 229
      annotatePipeline
	 :: [Phase]		-- raw pipeline
	 -> Phase		-- phase to stop before
     	 -> [(Phase, IntermediateFileType, String{-file extension-})]
      annotatePipeline []     _    = []
      annotatePipeline (Ln:_) _    = []
      annotatePipeline (phase:next_phase:ps) stop = 
230
     	  (phase, keep_this_output, myPhaseInputExt next_phase)
231 232 233
	     : annotatePipeline (next_phase:ps) stop
     	  where
     		keep_this_output
234 235 236 237
     		     | next_phase == stop 
                     = if persistent_output then Persistent else Temporary
     		     | otherwise
     		     = case next_phase of
238 239 240 241
     			     Ln -> Persistent
     			     Mangle | keep_raw_s -> Persistent
     			     As     | keep_s     -> Persistent
     			     HCc    | keep_hc    -> Persistent
242
#ifdef ILX
rrt's avatar
rrt committed
243
			     Ilasm  | keep_il    -> Persistent
244
#endif
245 246 247 248 249 250
     			     _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.
251 252

      annotated_pipeline = annotatePipeline (pipeline ++ [Ln]) stop_phase
253 254 255 256

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

257 258 259 260 261
   return (
     takeWhile (phase_ne stop_phase ) $
     dropWhile (phase_ne start_phase) $
     annotated_pipeline
    )
262 263 264 265


runPipeline
  :: [ (Phase, IntermediateFileType, String) ] -- phases to run
sof's avatar
sof committed
266
  -> (String,String)		-- input file
267 268
  -> Bool			-- doing linking afterward?
  -> Bool			-- take into account -o when generating output?
sof's avatar
sof committed
269
  -> IO (String, String)	-- return final filename
270

sof's avatar
sof committed
271 272 273
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
274 275

pipeLoop [] input_fn _ _ _ _ = return input_fn
apt's avatar
apt committed
276
pipeLoop (all_phases@((phase, keep, o_suffix):phases))
sof's avatar
sof committed
277
	(input_fn,real_suff) do_linking use_ofile orig_basename orig_suffix
278 279 280 281
  = do

     output_fn <- outputFileName (null phases) keep o_suffix

sof's avatar
sof committed
282
     mbCarryOn <- run_phase phase orig_basename orig_suffix input_fn output_fn 
283 284
	-- sometimes we bail out early, eg. when the compiler's recompilation
	-- checker has determined that recompilation isn't necessary.
sof's avatar
sof committed
285 286
     case mbCarryOn of
       Nothing -> do
apt's avatar
apt committed
287
	      let (_,keep,final_suffix) = last all_phases
sof's avatar
sof committed
288
	      ofile <- outputFileName True keep final_suffix
sof's avatar
sof committed
289
	      return (ofile, final_suffix)
sof's avatar
sof committed
290
          -- carry on ...
sof's avatar
sof committed
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
       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
311 312
  where
     outputFileName last_phase keep suffix
313
  	= do o_file <- readIORef v_Output_file
314 315 316 317 318
   	     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
319
   			   then odir_ify (orig_basename ++ '.':suffix)
320 321
   			   else newTempName suffix

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

run_phase Unlit _basename _suff input_fn output_fn
335
  = do unlit_flags <- getOpts opt_L
rrt's avatar
rrt committed
336 337 338
       -- 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
339 340 341
       SysTools.runUnlit (map SysTools.Option unlit_flags ++
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
342 343
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
344
			  ])
sof's avatar
sof committed
345
       return (Just output_fn)
346 347 348 349

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

350
run_phase Cpp basename suff input_fn output_fn
351
  = do src_opts <- getOptionsFromSource input_fn
352
       unhandled_flags <- processArgs dynamic_flags src_opts []
353
       checkProcessArgsResult unhandled_flags basename suff
354

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

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

369
	    verb <- getVerbFlag
rrt's avatar
rrt committed
370
	    (md_c_flags, _) <- machdepCCOpts
371

sof's avatar
sof committed
372 373 374 375 376
	    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
377 378
			    ++ [ SysTools.Option     "-x"
			       , SysTools.Option     "c"
sof's avatar
sof committed
379
			       , SysTools.FileOption "" input_fn
sof's avatar
sof committed
380
			       , SysTools.Option     "-o"
sof's avatar
sof committed
381
			       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
382
			       ])
sof's avatar
sof committed
383
	    return (Just output_fn)
384 385 386 387

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

sof's avatar
sof committed
388
run_phase MkDependHS basename suff input_fn output_fn = do 
389
   src <- readFile input_fn
390
   let (import_sources, import_normals, _) = getImports src
391

392 393 394
   let orig_fn = basename ++ '.':suff
   deps_sources <- mapM (findDependency True  orig_fn) import_sources
   deps_normals <- mapM (findDependency False orig_fn) import_normals
395
   let deps = deps_sources ++ deps_normals
396

397
   osuf_opt <- readIORef v_Object_suf
398
   let osuf = case osuf_opt of
399
			Nothing -> phaseInputExt Ln
400 401
			Just s  -> s

402
   extra_suffixes <- readIORef v_Dep_suffixes
403 404 405 406 407
   let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
       ofiles = map (\suf -> basename ++ '.':suf) suffixes
   	   
   objs <- mapM odir_ify ofiles
   
408
	-- Handle for file that accumulates dependencies 
409
   hdl <- readIORef v_Dep_tmp_hdl
410

411
	-- std dependency of the object(s) on the source file
412 413 414 415 416
   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
417
	  hisuf <- readIORef v_Hi_suf
418 419 420 421 422 423 424 425
	  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
426
   return (Just output_fn)
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448

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

449 450
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
451
run_phase Hsc basename suff input_fn output_fn
452
  = do
453 454 455 456 457 458
	
  -- 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
	
459 460
	paths <- readIORef v_Include_paths
	writeIORef v_Include_paths (current_dir : paths)
461
	
462 463 464 465 466
  -- 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 
467
				 (c_includes ++ reverse cmdline_includes))
468 469 470 471 472 473 474 475
	    mk_include h_file = 
		case h_file of 
		   '"':_{-"-} -> "#include "++h_file
		   '<':_      -> "#include "++h_file
		   _          -> "#include \""++h_file++"\""

	writeIORef v_HCHeader cc_injects

476 477 478 479
  -- 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
480
	(mod, location')
sof's avatar
sof committed
481
	   <- mkHomeModuleLocn mod_name basename (basename ++ '.':suff)
482 483 484 485 486 487

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

488 489 490 491
  -- 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?)
  --
492
  -- Setting source_unchanged to True means that M.o seems
493 494
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
495
  -- Setting source_unchanged to False tells the compiler that M.o is out of
496
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
sof's avatar
sof committed
497 498 499 500 501 502 503
	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
504 505
	source_unchanged <- 
          if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
506
	     then return False
507 508 509
	     else do t1 <- getModificationTime (basename ++ '.':suff)
		     o_file_exists <- doesFileExist o_file
		     if not o_file_exists
510
		        then return False	-- Need to recompile
511 512
			else do t2 <- getModificationTime o_file
			        if t2 > t1
513 514
				  then return True
				  else return False
515

516
  -- get the DynFlags
517
        dyn_flags <- getDynFlags
518

519 520
        let dyn_flags' = dyn_flags { hscOutName = output_fn,
		   		     hscStubCOutName = basename ++ "_stub.c",
apt's avatar
apt committed
521
				     hscStubHOutName = basename ++ "_stub.h",
apt's avatar
apt committed
522
				     extCoreName = basename ++ ".hcr" }
523

524
  -- run the compiler!
525
        pcs <- initPersistentCompilerState
526
	result <- hscMain OneShot
527
                          dyn_flags' mod
528
			  location{ ml_hspp_file=Just input_fn }
529
			  source_unchanged
530
			  False
531 532 533 534
			  Nothing	 -- no iface
			  emptyModuleEnv -- HomeSymbolTable
			  emptyModuleEnv -- HomeIfaceTable
			  pcs
535 536 537

	case result of {

538
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
539

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

543
	    HscRecomp pcs details iface stub_h_exists stub_c_exists
544
		      _maybe_interpreted_code -> do
545

apt's avatar
apt committed
546 547 548 549 550 551 552 553
			    -- 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)
554
    }
555 556 557 558 559 560 561

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

562
run_phase cc_phase basename suff input_fn output_fn
563
   | cc_phase == Cc || cc_phase == HCc
564
   = do	cc_opts		     <- getOpts opt_c
rrt's avatar
rrt committed
565
       	cmdline_include_paths <- readIORef v_Include_paths
566 567 568 569 570 571 572

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

576
	mangle <- readIORef v_Do_asm_mangling
577 578
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

579
        verb <- getVerbFlag
580

581
	o2 <- readIORef v_minus_o2_for_C
582 583 584 585 586
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

	pkg_extra_cc_opts <- getPackageExtraCcOpts

587 588 589 590
	split_objs <- readIORef v_Split_object_files
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]

591
	excessPrecision <- readIORef v_Excess_precision
sof's avatar
sof committed
592
	SysTools.runCc ([ SysTools.Option "-x", SysTools.Option "c"
sof's avatar
sof committed
593
	                , SysTools.FileOption "" input_fn
sof's avatar
sof committed
594
			, SysTools.Option "-o"
sof's avatar
sof committed
595
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
596 597 598
			]
		       ++ map SysTools.Option (
		          md_c_flags
599 600 601 602 603 604 605 606 607 608
		       ++ (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
609
		       ))
sof's avatar
sof committed
610
	return (Just output_fn)
611 612 613 614 615 616 617

	-- ToDo: postprocess the output from gcc

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

run_phase Mangle _basename _suff input_fn output_fn
618 619 620 621 622 623
  = 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
624
       SysTools.runMangle (map SysTools.Option mangler_opts
sof's avatar
sof committed
625 626
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
627 628
			     ]
			  ++ map SysTools.Option machdep_opts)
sof's avatar
sof committed
629
       return (Just output_fn)
630 631 632 633

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

sof's avatar
sof committed
634
run_phase SplitMangle _basename _suff input_fn output_fn
635 636 637 638
  = 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
639

sof's avatar
sof committed
640 641 642
	SysTools.runSplit [ SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
643
			  ]
644 645 646 647 648 649 650 651 652

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

sof's avatar
sof committed
654
	return (Just output_fn)
655 656 657 658 659

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

run_phase As _basename _suff input_fn output_fn
660
  = do	as_opts		      <- getOpts opt_a
661
        cmdline_include_paths <- readIORef v_Include_paths
662

sof's avatar
sof committed
663 664 665
	SysTools.runAs (map SysTools.Option as_opts
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
666
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
667
			  , SysTools.Option "-o"
sof's avatar
sof committed
668
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
669
			  ])
sof's avatar
sof committed
670
	return (Just output_fn)
671

sof's avatar
sof committed
672
run_phase SplitAs basename _suff _input_fn output_fn
673
  = do  as_opts <- getOpts opt_a
674

675
	(split_s_prefix, n) <- readIORef v_Split_info
676

677
	odir <- readIORef v_Output_dir
678 679 680 681
	let real_odir = case odir of
				Nothing -> basename
				Just d  -> d

682 683
	let assemble_file n
	      = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
684 685 686
		    let output_o = newdir real_odir 
					(basename ++ "__" ++ show n ++ ".o")
		    real_o <- osuf_ify output_o
sof's avatar
sof committed
687 688 689
		    SysTools.runAs (map SysTools.Option as_opts ++
		    		    [ SysTools.Option "-c"
				    , SysTools.Option "-o"
sof's avatar
sof committed
690 691
				    , SysTools.FileOption "" real_o
				    , SysTools.FileOption "" input_s
sof's avatar
sof committed
692
				    ])
693 694
	
	mapM_ assemble_file [1..n]
sof's avatar
sof committed
695
	return (Just output_fn)
696

rrt's avatar
rrt committed
697 698 699 700 701 702 703
#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
704 705 706 707
        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
708 709
				SysTools.FileOption "" output_fn,
				SysTools.FileOption "" input_fn ])
rrt's avatar
rrt committed
710 711 712 713 714 715 716 717
	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
718 719 720
        SysTools.runIlasm (map SysTools.Option ilasm_opts
		           ++ [ SysTools.Option "/QUIET",
				SysTools.Option "/DLL",
sof's avatar
sof committed
721 722
				SysTools.FileOption "/OUT=" output_fn,
				SysTools.FileOption "" input_fn ])
rrt's avatar
rrt committed
723 724 725 726
	return (Just output_fn)

#endif -- ILX

727 728 729 730 731 732 733 734 735 736 737 738 739
-----------------------------------------------------------------------------
-- 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	
740
        sysMan   <- getSysMan
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 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
        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);"
 ]

811 812 813 814
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

checkProcessArgsResult flags basename suff
815
  = do when (not (null flags)) (throwDyn (ProgramError (
816 817 818 819
           basename ++ "." ++ suff 
           ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
           ++ unwords flags)) (ExitFailure 1))

820 821 822 823 824
-----------------------------------------------------------------------------
-- Linking

doLink :: [String] -> IO ()
doLink o_files = do
825 826
    verb       <- getVerbFlag
    static     <- readIORef v_Static
827 828
    no_hs_main <- readIORef v_NoHsMain

829
    o_file <- readIORef v_Output_file
830 831 832 833 834
    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

835
    lib_paths <- readIORef v_Library_paths
836 837 838
    let lib_path_opts = map ("-L"++) lib_paths

    pkg_libs <- getPackageLibraries
839 840
    let imp	     = if static then "" else "_imp"
        pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
841

842
    libs <- readIORef v_Cmdline_libraries
843 844 845 846 847 848
    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
849
    extra_ld_inputs <- readIORef v_Ld_inputs
850 851

	-- opts from -optl-<blah>
852
    extra_ld_opts <- getStaticOpts v_Opt_l
853

854 855 856 857
    rts_pkg <- getPackageDetails ["rts"]
    std_pkg <- getPackageDetails ["std"]
    let extra_os = if static || no_hs_main
                   then []
rrt's avatar
rrt committed
858 859
                   else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
                          head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
860

861
    (md_c_flags, _) <- machdepCCOpts
sof's avatar
sof committed
862 863
    SysTools.runLink ( [ SysTools.Option verb
    		       , SysTools.Option "-o"
sof's avatar
sof committed
864
		       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
865 866 867
		       ]
		      ++ map SysTools.Option (
		         md_c_flags
868 869 870 871 872 873 874 875 876
	 	      ++ 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
877
	              ++ if static && not no_hs_main then
rrt's avatar
rrt committed
878
			    [ "-u", prefixUnderscore "PrelMain_mainIO_closure",
ken's avatar
ken committed
879
			      "-u", prefixUnderscore "__stginit_PrelMain"] 
sof's avatar
sof committed
880
			 else []))
881

882 883
    -- parallel only: move binary to another dir -- HWL
    ways_ <- readIORef v_Ways
884 885 886 887
    when (WayPar `elem` ways_)
	 (do success <- run_phase_MoveBinary output_fn
             if success then return ()
                        else throwDyn (InstallationError ("cannot move binary to PVM dir")))
888

rrt's avatar
rrt committed
889
-----------------------------------------------------------------------------
890
-- Making a DLL (only for Win32)
rrt's avatar
rrt committed
891 892 893

doMkDLL :: [String] -> IO ()
doMkDLL o_files = do
894 895
    verb       <- getVerbFlag
    static     <- readIORef v_Static
rrt's avatar
rrt committed
896 897 898 899 900 901 902 903 904 905 906 907
    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
908 909
    let imp = if static then "" else "_imp"
        pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
rrt's avatar
rrt committed
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924

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

rrt's avatar
rrt committed
926 927 928 929
    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" ]
930

rrt's avatar
rrt committed
931
    (md_c_flags, _) <- machdepCCOpts
932
    SysTools.runMkDLL
sof's avatar
sof committed
933 934
	 ([ SysTools.Option verb
	  , SysTools.Option "-o"
sof's avatar
sof committed
935
	  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
936 937 938
	  ]
	 ++ map SysTools.Option (
	    md_c_flags
rrt's avatar
rrt committed
939 940 941 942 943 944 945 946 947 948 949 950 951
	 ++ 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
952
	))
rrt's avatar
rrt committed
953

954 955 956 957 958 959
-----------------------------------------------------------------------------
-- 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 =
960
  ASSERT(haskellish_src_file filename) 
961
  do restoreDynFlags	-- Restore to state of last save
962
     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
sof's avatar
sof committed
963 964 965 966
			     defaultHscLang (filename, getFileSuffix filename)
     (fn,_)   <- runPipeline pipeline (filename,getFileSuffix filename)
     	                     False{-no linking-} False{-no -o flag-}
     return fn
967 968

-----------------------------------------------------------------------------
969
-- Compile a single module, under the control of the compilation manager.
970 971 972 973 974 975
--
-- 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.

976 977 978 979 980 981
-- 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.

982 983 984 985
-- NB.  No old interface can also mean that the source has changed.

compile :: GhciMode                -- distinguish batch from interactive
        -> ModSummary              -- summary, including source
986 987
	-> Bool			   -- True <=> source unchanged
	-> Bool			   -- True <=> have object
988
        -> Maybe ModIface          -- old interface, if available
989 990
        -> HomeSymbolTable         -- for home module ModDetails
	-> HomeIfaceTable	   -- for home module Ifaces
991 992 993