DriverPipeline.hs 38.8 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 138 139
   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
140
   osuf       <- readIORef v_Object_suf
141
   hcsuf      <- readIORef v_HC_suf
142 143 144

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

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

    haskellish = haskellish_suffix suffix
    cish = cish_suffix suffix

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

   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"
176
#ifdef ILX
rrt's avatar
rrt committed
177
	HscILX  | split           -> not_valid
rrt's avatar
rrt committed
178
		| otherwise       -> [ Unlit, Cpp, Hsc, Ilx2Il, Ilasm ]
179
#endif
apt's avatar
apt committed
180
	HscNothing 		  -> [ Unlit, Cpp, Hsc ]
181 182 183 184 185 186

      | cish      = [ Cc, As ]

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

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

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

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

202 203 204 205 206 207 208 209 210 211 212
	-- 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

213
   let
214 215 216 217
	-- .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
218

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

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

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

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


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

sof's avatar
sof committed
264 265 266
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
267 268 269

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

     output_fn <- outputFileName (null phases) keep o_suffix

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

sof's avatar
sof committed
315 316 317 318 319 320 321 322 323
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').
324 325 326 327
-------------------------------------------------------------------------------
-- Unlit phase 

run_phase Unlit _basename _suff input_fn output_fn
328
  = do unlit_flags <- getOpts opt_L
rrt's avatar
rrt committed
329 330 331
       -- 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
332 333 334
       SysTools.runUnlit (map SysTools.Option unlit_flags ++
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
335 336
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
337
			  ])
sof's avatar
sof committed
338
       return (Just output_fn)
339 340 341 342

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

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

348
       do_cpp <- dynFlag cppFlag
sof's avatar
sof committed
349 350 351 352 353
       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
354
	    hscpp_opts	    <- getOpts opt_P
355
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
356

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

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

sof's avatar
sof committed
365 366 367 368 369
	    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
370 371
			    ++ [ SysTools.Option     "-x"
			       , SysTools.Option     "c"
sof's avatar
sof committed
372
			       , SysTools.FileOption "" input_fn
sof's avatar
sof committed
373
			       , SysTools.Option     "-o"
sof's avatar
sof committed
374
			       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
375
			       ])
sof's avatar
sof committed
376
	    return (Just output_fn)
377 378 379 380

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

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

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

390
   osuf_opt <- readIORef v_Object_suf
391
   let osuf = case osuf_opt of
392
			Nothing -> phaseInputExt Ln
393 394
			Just s  -> s

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

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

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

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

	writeIORef v_HCHeader cc_injects

469 470 471 472
  -- 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
473
	(mod, location')
sof's avatar
sof committed
474
	   <- mkHomeModuleLocn mod_name basename (basename ++ '.':suff)
475 476 477 478 479 480

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

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

509
  -- get the DynFlags
510
        dyn_flags <- getDynFlags
511

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

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

	case result of {

531
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
532

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

536
	    HscRecomp pcs details iface stub_h_exists stub_c_exists
537
		      _maybe_interpreted_code -> do
538

apt's avatar
apt committed
539 540 541 542 543 544 545 546
			    -- 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)
547
    }
548 549 550 551 552 553 554

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

555
run_phase cc_phase basename suff input_fn output_fn
556
   | cc_phase == Cc || cc_phase == HCc
557
   = do	cc_opts		     <- getOpts opt_c
rrt's avatar
rrt committed
558
       	cmdline_include_paths <- readIORef v_Include_paths
559 560 561 562 563 564 565

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

569
	mangle <- readIORef v_Do_asm_mangling
570 571
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

572
        verb <- getVerbFlag
573

574
	o2 <- readIORef v_minus_o2_for_C
575 576 577 578 579
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

	pkg_extra_cc_opts <- getPackageExtraCcOpts

580 581 582 583
	split_objs <- readIORef v_Split_object_files
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]

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

	-- ToDo: postprocess the output from gcc

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

run_phase Mangle _basename _suff input_fn output_fn
611 612 613 614 615 616
  = 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
617
       SysTools.runMangle (map SysTools.Option mangler_opts
sof's avatar
sof committed
618 619
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
620 621
			     ]
			  ++ map SysTools.Option machdep_opts)
sof's avatar
sof committed
622
       return (Just output_fn)
623 624 625 626

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

sof's avatar
sof committed
627
run_phase SplitMangle _basename _suff input_fn output_fn
628 629 630 631
  = 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
632

sof's avatar
sof committed
633 634 635
	SysTools.runSplit [ SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
636
			  ]
637 638 639 640 641 642 643 644 645

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

sof's avatar
sof committed
647
	return (Just output_fn)
648 649 650 651 652

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

run_phase As _basename _suff input_fn output_fn
653
  = do	as_opts		      <- getOpts opt_a
654
        cmdline_include_paths <- readIORef v_Include_paths
655

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

sof's avatar
sof committed
665
run_phase SplitAs basename _suff _input_fn output_fn
666
  = do  as_opts <- getOpts opt_a
667

668
	(split_s_prefix, n) <- readIORef v_Split_info
669

670
	odir <- readIORef v_Output_dir
671 672 673 674
	let real_odir = case odir of
				Nothing -> basename
				Just d  -> d

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

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

#endif -- ILX

720 721 722 723 724 725 726 727 728 729 730 731 732
-----------------------------------------------------------------------------
-- 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	
733
        sysMan   <- getSysMan
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 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
        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);"
 ]

804 805 806 807
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

checkProcessArgsResult flags basename suff
808
  = do when (not (null flags)) (throwDyn (ProgramError (
809 810 811 812
           basename ++ "." ++ suff 
           ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
           ++ unwords flags)) (ExitFailure 1))

813 814 815 816 817
-----------------------------------------------------------------------------
-- Linking

doLink :: [String] -> IO ()
doLink o_files = do
818 819
    verb       <- getVerbFlag
    static     <- readIORef v_Static
820 821
    no_hs_main <- readIORef v_NoHsMain

822
    o_file <- readIORef v_Output_file
823 824 825 826 827
    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

828
    lib_paths <- readIORef v_Library_paths
829 830 831
    let lib_path_opts = map ("-L"++) lib_paths

    pkg_libs <- getPackageLibraries
832 833
    let imp	     = if static then "" else "_imp"
        pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
834

835
    libs <- readIORef v_Cmdline_libraries
836 837 838 839 840 841
    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
842
    extra_ld_inputs <- readIORef v_Ld_inputs
843 844

	-- opts from -optl-<blah>
845
    extra_ld_opts <- getStaticOpts v_Opt_l
846

847 848 849 850
    rts_pkg <- getPackageDetails ["rts"]
    std_pkg <- getPackageDetails ["std"]
    let extra_os = if static || no_hs_main
                   then []
rrt's avatar
rrt committed
851 852
                   else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
                          head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
853

854
    (md_c_flags, _) <- machdepCCOpts
sof's avatar
sof committed
855 856
    SysTools.runLink ( [ SysTools.Option verb
    		       , SysTools.Option "-o"
sof's avatar
sof committed
857
		       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
858 859 860
		       ]
		      ++ map SysTools.Option (
		         md_c_flags
861 862 863 864 865 866 867 868 869
	 	      ++ 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
870
	              ++ if static && not no_hs_main then
sof's avatar
sof committed
871 872
			    [ "-u", prefixUnderscore "PrelMain_mainIO_closure" ,
			      "-u", prefixUnderscore "__init_PrelMain"] 
sof's avatar
sof committed
873
			 else []))
874

875 876
    -- parallel only: move binary to another dir -- HWL
    ways_ <- readIORef v_Ways
877 878 879 880
    when (WayPar `elem` ways_)
	 (do success <- run_phase_MoveBinary output_fn
             if success then return ()
                        else throwDyn (InstallationError ("cannot move binary to PVM dir")))
881

rrt's avatar
rrt committed
882
-----------------------------------------------------------------------------
883
-- Making a DLL (only for Win32)
rrt's avatar
rrt committed
884 885 886

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

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

rrt's avatar
rrt committed
919 920 921 922
    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" ]
923

rrt's avatar
rrt committed
924
    (md_c_flags, _) <- machdepCCOpts
925
    SysTools.runMkDLL
sof's avatar
sof committed
926 927
	 ([ SysTools.Option verb
	  , SysTools.Option "-o"
sof's avatar
sof committed
928
	  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
929 930 931
	  ]
	 ++ map SysTools.Option (
	    md_c_flags
rrt's avatar
rrt committed
932 933 934 935 936 937 938 939 940 941 942 943 944
	 ++ 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
945
	))
rrt's avatar
rrt committed
946

947 948 949 950 951 952
-----------------------------------------------------------------------------
-- 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 =
953
  ASSERT(haskellish_src_file filename) 
954
  do restoreDynFlags	-- Restore to state of last save
955
     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
sof's avatar
sof committed
956 957 958 959
			     defaultHscLang (filename, getFileSuffix filename)
     (fn,_)   <- runPipeline pipeline (filename,getFileSuffix filename)
     	                     False{-no linking-} False{-no -o flag-}
     return fn
960 961

-----------------------------------------------------------------------------
962
-- Compile a single module, under the control of the compilation manager.
963 964 965 966 967 968
--
-- 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.

969 970 971 972 973 974
-- 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.

975 976 977 978
-- NB.  No old interface can also mean that the source has changed.

compile :: GhciMode                -- distinguish batch from interactive
        -> ModSummary              -- summary, including source
979 980
	-> Bool			   -- True <=> source unchanged
	-> Bool			   -- True <=> have object
981
        -> Maybe ModIface          -- old interface, if available
982 983
        -> HomeSymbolTable         -- for home module ModDetails
	-> HomeIfaceTable	   -- for home module Ifaces
984 985 986
        -> PersistentCompilerState -- persistent compiler state
        -> IO CompResult

987
data CompResult
988 989 990 991 992 993
   = 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)
994 995 996 997

   | CompErrs PersistentCompilerState	-- updated PCS


998 999
compile ghci_mode summary source_unchanged have_object 
	old_iface hst hit pcs = do 
1000 1001
   dyn_flags <- restoreDynFlags		-- Restore to the state of the last save

1002

1003
   showPass dyn_flags 
1004
	(showSDoc (text "Compiling" <+> ppr (name_of_summary summary)))
1005

1006
   let verb	  = verbosity dyn_flags