DriverPipeline.hs 31.2 KB
Newer Older
1
-----------------------------------------------------------------------------
rrt's avatar
rrt committed
2
-- $Id: DriverPipeline.hs,v 1.52 2001/02/27 12:36:37 rrt Exp $
3 4 5 6 7 8 9
--
-- GHC Driver
--
-- (c) Simon Marlow 2000
--
-----------------------------------------------------------------------------

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

12
module DriverPipeline (
13 14

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

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

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

#include "HsVersions.h"

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

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

import IO
import Monad
import Maybe

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

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

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

GLOBAL_VAR(v_GhcMode, error "todo", GhcMode)

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

-----------------------------------------------------------------------------
-- genPipeline
--
-- Herein is all the magic about which phases to run in which order, whether
-- the intermediate files should be in /tmp or in the current directory,
-- what the suffix of the intermediate files should be, etc.

-- The following compilation pipeline algorithm is fairly hacky.  A
rrt's avatar
rrt committed
108
-- better way to do this would be to express the whole compilation as a
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
-- data flow DAG, where the nodes are the intermediate files and the
-- edges are the compilation phases.  This framework would also work
-- nicely if a haskell dependency generator was included in the
-- driver.

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

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

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

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

144
genPipeline todo stop_flag persistent_output lang filename 
145
 = do
146 147 148 149 150
   split      <- readIORef v_Split_object_files
   mangle     <- readIORef v_Do_asm_mangling
   keep_hc    <- readIORef v_Keep_hc_files
   keep_raw_s <- readIORef v_Keep_raw_s_files
   keep_s     <- readIORef v_Keep_s_files
151
   osuf       <- readIORef v_Object_suf
152 153 154 155 156

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

157 158 159 160 161
    start = startPhase suffix

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

    haskellish = haskellish_suffix suffix
    cish = cish_suffix suffix

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

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

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

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

	HscJava	| split	          -> not_valid
		| otherwise       -> error "not implemented: compiling via Java"
rrt's avatar
rrt committed
188 189 190 191
#ifdef ILX
	HscILX  | split           -> not_valid
		| otherwise       -> [ Unlit, Cpp, Hsc ]
#endif
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208

      | cish      = [ Cc, As ]

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

	-- ToDo: this is somewhat cryptic
    not_valid = throwDyn (OtherError ("invalid option combination"))
   ----------- -----  ----   ---   --   --  -  -  -

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

   let
   ----------- -----  ----   ---   --   --  -  -  -
209 210 211 212
      myPhaseInputExt Ln = case osuf of Nothing -> phaseInputExt Ln
					Just s  -> s
      myPhaseInputExt other = phaseInputExt other

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

	-- add information about output files to the pipeline
	-- the suffix on an output file is determined by the next phase
	-- in the pipeline, so we add linking to the end of the pipeline
	-- to force the output from the final phase to be a .o file.
238 239 240 241 242
      stop_phase = case todo of 
			StopBefore As | split -> SplitAs
			StopBefore phase      -> phase
			DoMkDependHS	      -> Ln
			DoLink                -> Ln
243 244 245 246 247
      annotated_pipeline = annotatePipeline (pipeline ++ [ Ln ]) stop_phase

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

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

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


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

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

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

     output_fn <- outputFileName (null phases) keep o_suffix

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

     pipeLoop phases output_fn do_linking use_ofile orig_basename orig_suffix

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

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

run_phase Unlit _basename _suff input_fn output_fn
310
  = do unlit <- readIORef v_Pgm_L
311
       unlit_flags <- getOpts opt_L
312
       runSomething "Literate pre-processor"
313 314 315 316 317 318 319
	  ("echo '# 1 \"" ++input_fn++"\"' > "++output_fn++" && "
	   ++ unlit ++ ' ':input_fn ++ " - >> " ++ output_fn)
       return True

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

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

       when (not (null unhandled_flags)) 
            (throwDyn (OtherError (
                          basename ++ "." ++ suff 
                          ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
                          ++ unwords unhandled_flags)) (ExitFailure 1))
329

330
       do_cpp <- dynFlag cppFlag
331 332
       if do_cpp
          then do
333
       	    cpp <- readIORef v_Pgm_P
334
	    hscpp_opts <- getOpts opt_P
335
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
336

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

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

	    runSomething "C pre-processor" 
346
		(unwords
347
       	    	   (["echo '{-# LINE 1 \"" ++ input_fn ++ "\" #-}'", ">", output_fn, "&&",
348 349 350 351
		     cpp, verb] 
		    ++ include_paths
		    ++ hs_src_cpp_opts
		    ++ hscpp_opts
rrt's avatar
rrt committed
352
		    ++ md_c_flags
353 354 355
		    ++ [ "-x", "c", input_fn, ">>", output_fn ]
		   ))
	  else do
356
	    runSomething "Ineffective C pre-processor"
357
	           ("echo '{-# LINE 1 \""  ++ input_fn ++ "\" #-}' > " 
358 359 360 361 362 363 364 365 366
		    ++ output_fn ++ " && cat " ++ input_fn
		    ++ " >> " ++ output_fn)
       return True

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

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

369 370 371
   deps_sources <- mapM (findDependency True basename)  import_sources
   deps_normals <- mapM (findDependency False basename) import_normals
   let deps = deps_sources ++ deps_normals
372

373
   osuf_opt <- readIORef v_Object_suf
374
   let osuf = case osuf_opt of
375
			Nothing -> phaseInputExt Ln
376 377
			Just s  -> s

378
   extra_suffixes <- readIORef v_Dep_suffixes
379 380 381 382 383
   let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
       ofiles = map (\suf -> basename ++ '.':suf) suffixes
   	   
   objs <- mapM odir_ify ofiles
   
384
   hdl <- readIORef v_Dep_tmp_hdl
385

386
	-- std dependency of the object(s) on the source file
387 388 389 390 391
   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
392
	  hisuf <- readIORef v_Hi_suf
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
	  let dep_base = remove_suffix '.' dep
	      deps = (dep_base ++ hisuf)
		     : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
		  -- length objs should be == length deps
	  sequence_ (zipWith (\o d -> hPutStrLn hdl (o ++ " : " ++ d)) objs deps)

   mapM genDep [ d | Just d <- deps ]

   return True

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

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

424 425
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
426
run_phase Hsc basename suff input_fn output_fn
427
  = do
428 429 430 431 432 433
	
  -- 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
	
434 435
	paths <- readIORef v_Include_paths
	writeIORef v_Include_paths (current_dir : paths)
436 437
	
  -- figure out where to put the .hi file
438 439
	ohi    <- readIORef v_Output_hi
	hisuf  <- readIORef v_Hi_suf
440
	let hifile = case ohi of
441
			   Nothing -> basename ++ '.':hisuf
442
			   Just fn -> fn
443 444 445 446 447

  -- 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?)
  --
448
  -- Setting source_unchanged to True means that M.o seems
449 450
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
451
  -- Setting source_unchanged to False tells the compiler that M.o is out of
452
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
453
	do_recomp <- readIORef v_Recomp
454
	todo <- readIORef v_GhcMode
rrt's avatar
rrt committed
455
        o_file' <- odir_ify (basename ++ '.':phaseInputExt Ln)
rrt's avatar
rrt committed
456
        o_file <- osuf_ify o_file'
457 458
	source_unchanged <- 
          if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
459
	     then return False
460 461 462
	     else do t1 <- getModificationTime (basename ++ '.':suff)
		     o_file_exists <- doesFileExist o_file
		     if not o_file_exists
463
		        then return False	-- Need to recompile
464 465
			else do t2 <- getModificationTime o_file
			        if t2 > t1
466 467
				  then return True
				  else return False
468

469 470 471 472 473 474
	 -- build a ModuleLocation to pass to hscMain.
        modsrc <- readFile input_fn
        let (srcimps,imps,mod_name) = getImports modsrc

	Just (mod, location)
	   <- mkHomeModuleLocn mod_name basename (basename ++ '.':suff)
475

476 477 478
  -- get the DynFlags
        dyn_flags <- readIORef v_DynFlags

479
  -- run the compiler!
480
        pcs <- initPersistentCompilerState
481 482
	result <- hscMain OneShot
                          dyn_flags{ hscOutName = output_fn }
483 484
			  mod
			  location{ ml_hspp_file=Just input_fn }
485
			  source_unchanged
486 487 488 489
			  Nothing	 -- no iface
			  emptyModuleEnv -- HomeSymbolTable
			  emptyModuleEnv -- HomeIfaceTable
			  pcs
490 491 492

	case result of {

493
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
494

495 496 497 498 499
            HscNoRecomp pcs details iface -> 
	        do {
		  runSomething "Touching object file" ("touch " ++ o_file);
		  return False;
		};
500 501 502

	    HscRecomp pcs details iface maybe_stub_h maybe_stub_c 
		      _maybe_interpreted_code -> do
503

504
	    -- deal with stubs
505
	maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
506
	case maybe_stub_o of
507
		Nothing -> return ()
508
		Just stub_o -> add v_Ld_inputs stub_o
509

510
	return True
511
    }
512 513 514 515 516 517 518 519 520

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

run_phase cc_phase _basename _suff input_fn output_fn
   | cc_phase == Cc || cc_phase == HCc
521
   = do	cc <- readIORef v_Pgm_c
522
       	cc_opts <- (getOpts opt_c)
523
       	cmdline_include_dirs <- readIORef v_Include_paths
524 525 526 527 528 529 530 531 532 533 534

        let hcc = cc_phase == HCc

		-- add package include paths even if we're just compiling
		-- .c files; this is the Value Add(TM) that using
		-- ghc instead of gcc gives you :)
        pkg_include_dirs <- getPackageIncludePath
	let include_paths = map (\p -> "-I"++p) (cmdline_include_dirs 
							++ pkg_include_dirs)

	c_includes <- getPackageCIncludes
535
	cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553

	let cc_injects | hcc = unlines (map mk_include 
					(c_includes ++ reverse cmdline_includes))
		       | otherwise = ""
	    mk_include h_file = 
		case h_file of 
		   '"':_{-"-} -> "#include "++h_file
		   '<':_      -> "#include "++h_file
		   _          -> "#include \""++h_file++"\""

	cc_help <- newTempName "c"
	h <- openFile cc_help WriteMode
	hPutStr h cc_injects
	hPutStrLn h ("#include \"" ++ input_fn ++ "\"\n")
	hClose h

	ccout <- newTempName "ccout"

554
	mangle <- readIORef v_Do_asm_mangling
555 556
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

557
        verb <- getVerbFlag
558

559
	o2 <- readIORef v_minus_o2_for_C
560 561 562 563 564
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

	pkg_extra_cc_opts <- getPackageExtraCcOpts

565 566 567 568
	split_objs <- readIORef v_Split_object_files
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]

569
	excessPrecision <- readIORef v_Excess_precision
570

571
	runSomething "C Compiler"
572 573 574 575 576 577 578 579
	 (unwords ([ cc, "-x", "c", cc_help, "-o", output_fn ]
		   ++ md_c_flags
		   ++ (if cc_phase == HCc && mangle
			 then md_regd_c_flags
			 else [])
		   ++ [ verb, "-S", "-Wimplicit", opt_flag ]
		   ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		   ++ cc_opts
580
		   ++ split_opt
581 582 583 584 585 586 587 588 589 590 591 592 593
		   ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		   ++ include_paths
		   ++ pkg_extra_cc_opts
--		   ++ [">", ccout]
		   ))
	return True

	-- ToDo: postprocess the output from gcc

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

run_phase Mangle _basename _suff input_fn output_fn
594
  = do mangler <- readIORef v_Pgm_m
595 596 597
       mangler_opts <- getOpts opt_m
       machdep_opts <-
	 if (prefixMatch "i386" cTARGETPLATFORM)
598
	    then do n_regs <- dynFlag stolen_x86_regs
599 600
		    return [ show n_regs ]
	    else return []
601
       runSomething "Assembly Mangler"
602 603 604 605 606 607 608 609 610 611 612
	(unwords (mangler : 
		     mangler_opts
		  ++ [ input_fn, output_fn ]
		  ++ machdep_opts
		))
       return True

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

run_phase SplitMangle _basename _suff input_fn _output_fn
613
  = do  splitter <- readIORef v_Pgm_s
614 615 616

	-- this is the prefix used for the split .s files
	tmp_pfx <- readIORef v_TmpDir
617
	x <- myGetProcessID
618
	let split_s_prefix = tmp_pfx ++ "/ghc" ++ show x
619
	writeIORef v_Split_prefix split_s_prefix
620 621 622 623 624
	addFilesToClean [split_s_prefix ++ "__*"] -- d:-)

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

625
	runSomething "Split Assembly File"
626 627 628 629 630 631 632 633 634
	 (unwords [ splitter
		  , input_fn
		  , split_s_prefix
		  , n_files ]
	 )

	-- save the number of split files for future references
	s <- readFile n_files
	let n = read s :: Int
635
	writeIORef v_N_split_files n
636 637 638 639 640 641
	return True

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

run_phase As _basename _suff input_fn output_fn
642
  = do	as <- readIORef v_Pgm_a
643 644
        as_opts <- getOpts opt_a

645
        cmdline_include_paths <- readIORef v_Include_paths
646
        let cmdline_include_flags = map (\p -> "-I"++p) cmdline_include_paths
647
        runSomething "Assembler"
648 649 650 651 652 653 654
	   (unwords (as : as_opts
		       ++ cmdline_include_flags
		       ++ [ "-c", input_fn, "-o",  output_fn ]
		    ))
	return True

run_phase SplitAs basename _suff _input_fn _output_fn
655
  = do  as <- readIORef v_Pgm_a
656 657
        as_opts <- getOpts opt_a

658 659
	split_s_prefix <- readIORef v_Split_prefix
	n <- readIORef v_N_split_files
660

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

	let assemble_file n = do
		    let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
		    let output_o = newdir real_odir 
					(basename ++ "__" ++ show n ++ ".o")
		    real_o <- osuf_ify output_o
671
		    runSomething "Assembler" 
672 673 674 675 676 677 678 679 680 681 682 683
			    (unwords (as : as_opts
				      ++ [ "-c", "-o", real_o, input_s ]
			    ))
	
	mapM_ assemble_file [1..n]
	return True

-----------------------------------------------------------------------------
-- Linking

doLink :: [String] -> IO ()
doLink o_files = do
684
    ln <- readIORef v_Pgm_l
685
    verb <- getVerbFlag
686 687 688 689
    static <- readIORef v_Static
    let imp = if static then "" else "_imp"
    no_hs_main <- readIORef v_NoHsMain

690
    o_file <- readIORef v_Output_file
691 692 693 694 695
    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

696
    lib_paths <- readIORef v_Library_paths
697 698 699
    let lib_path_opts = map ("-L"++) lib_paths

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

702
    libs <- readIORef v_Cmdline_libraries
703 704 705 706 707 708
    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
709
    extra_ld_inputs <- readIORef v_Ld_inputs
710 711

	-- opts from -optl-<blah>
712
    extra_ld_opts <- getStaticOpts v_Opt_l
713

714 715 716 717 718
    rts_pkg <- getPackageDetails ["rts"]
    std_pkg <- getPackageDetails ["std"]
#ifdef mingw32_TARGET_OS
    let extra_os = if static || no_hs_main
                   then []
rrt's avatar
rrt committed
719 720
                   else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
                          head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
721 722
#endif
    (md_c_flags, _) <- machdepCCOpts
723
    runSomething "Linker"
724
       (unwords
725
	 ([ ln, verb, "-o", output_fn ]
726
	 ++ md_c_flags
727
	 ++ o_files
728 729 730
#ifdef mingw32_TARGET_OS
	 ++ extra_os
#endif
731 732 733 734 735 736 737
	 ++ extra_ld_inputs
	 ++ lib_path_opts
	 ++ lib_opts
	 ++ pkg_lib_path_opts
	 ++ pkg_lib_opts
	 ++ pkg_extra_ld_opts
	 ++ extra_ld_opts
738 739 740 741 742
#ifdef mingw32_TARGET_OS
         ++ if static then [ "-u _PrelMain_mainIO_closure" , "-u ___init_PrelMain"] else []
#else
	 ++ [ "-u PrelMain_mainIO_closure" , "-u __init_PrelMain"]
#endif
743 744 745
	)
       )

rrt's avatar
rrt committed
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 811 812 813
-----------------------------------------------------------------------------
-- Making a DLL

-- only for Win32, but bits that are #ifdefed in doLn are still #ifdefed here
-- in a vain attempt to aid future portability
doMkDLL :: [String] -> IO ()
doMkDLL o_files = do
    ln <- readIORef v_Pgm_dll
    verb <- getVerbFlag
    static <- readIORef v_Static
    let imp = if static then "" else "_imp"
    no_hs_main <- readIORef v_NoHsMain

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

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

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

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

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

    pkg_extra_ld_opts <- getPackageExtraLdOpts

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

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

    rts_pkg <- getPackageDetails ["rts"]
    std_pkg <- getPackageDetails ["std"]
#ifdef mingw32_TARGET_OS
    let extra_os = if static || no_hs_main
                   then []
                   else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
                          head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
#endif
    (md_c_flags, _) <- machdepCCOpts
    runSomething "DLL creator"
       (unwords
	 ([ ln, verb, "-o", output_fn ]
	 ++ md_c_flags
	 ++ o_files
#ifdef mingw32_TARGET_OS
	 ++ extra_os
	 ++ [ "--target=i386-mingw32" ]
#endif
	 ++ extra_ld_inputs
	 ++ lib_path_opts
	 ++ lib_opts
	 ++ pkg_lib_path_opts
	 ++ pkg_lib_opts
	 ++ pkg_extra_ld_opts
         ++ (case findPS (packString (concat extra_ld_opts)) (packString "--def") of
               Nothing -> [ "--export-all" ]
	       Just _  -> [ "" ])
	 ++ extra_ld_opts
	)
       )

814 815 816 817 818 819 820
-----------------------------------------------------------------------------
-- 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 =
  ASSERT(haskellish_file filename) 
821 822
  do init_dyn_flags <- readIORef v_InitDynFlags
     writeIORef v_DynFlags init_dyn_flags
823
     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
824
			defaultHscLang filename
825
     runPipeline pipeline filename False{-no linking-} False{-no -o flag-}
826 827

-----------------------------------------------------------------------------
828
-- Compile a single module, under the control of the compilation manager.
829 830 831 832 833 834
--
-- 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.

835 836 837 838 839 840
-- 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.

841 842 843 844 845
-- NB.  No old interface can also mean that the source has changed.

compile :: GhciMode                -- distinguish batch from interactive
        -> ModSummary              -- summary, including source
	-> Bool			   -- source unchanged?
846
        -> Maybe ModIface          -- old interface, if available
847 848
        -> HomeSymbolTable         -- for home module ModDetails
	-> HomeIfaceTable	   -- for home module Ifaces
849 850 851
        -> PersistentCompilerState -- persistent compiler state
        -> IO CompResult

852
data CompResult
853 854 855 856 857 858
   = 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)
859 860 861 862

   | CompErrs PersistentCompilerState	-- updated PCS


863
compile ghci_mode summary source_unchanged old_iface hst hit pcs = do 
864 865
   init_dyn_flags <- readIORef v_InitDynFlags
   writeIORef v_DynFlags init_dyn_flags
866

867 868
   showPass init_dyn_flags 
	(showSDoc (text "Compiling" <+> ppr (name_of_summary summary)))
869 870

   let verb = verbosity init_dyn_flags
871
   let location   = ms_location summary
872 873
   let input_fn   = unJust "compile:hs" (ml_hs_file location) 
   let input_fnpp = unJust "compile:hspp" (ml_hspp_file location)
874

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

877
   opts <- getOptionsFromSource input_fnpp
878 879 880
   processArgs dynamic_flags opts []
   dyn_flags <- readIORef v_DynFlags

881
   let hsc_lang = hscLang dyn_flags
882 883 884 885
   output_fn <- case hsc_lang of
		    HscAsm         -> newTempName (phaseInputExt As)
		    HscC           -> newTempName (phaseInputExt HCc)
        	    HscJava        -> newTempName "java" -- ToDo
rrt's avatar
rrt committed
886 887 888
#ifdef ILX
		    HscILX         -> newTempName (phaseInputExt Ilx)
#endif
889
		    HscInterpreted -> return (error "no output file")
890 891

   -- run the compiler
892
   hsc_result <- hscMain ghci_mode dyn_flags{ hscOutName = output_fn } 
893 894
			 (ms_mod summary) location
			 source_unchanged old_iface hst hit pcs
895

896 897
   case hsc_result of
      HscFail pcs -> return (CompErrs pcs)
898

899
      HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)
900

901 902 903
      HscRecomp pcs details iface
	maybe_stub_h maybe_stub_c maybe_interpreted_code -> do
	   
904
	   let (basename, _) = splitFilename input_fn
905
	   maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
906 907 908
	   let stub_unlinked = case maybe_stub_o of
				  Nothing -> []
				  Just stub_o -> [ DotO stub_o ]
909

910
	   (hs_unlinked, unlinked_time) <-
911 912 913 914
	     case hsc_lang of

		-- in interpreted mode, just return the compiled code
		-- as our "unlinked" object.
915
		HscInterpreted -> 
916
		    case maybe_interpreted_code of
917 918
		       Just (bcos,itbl_env) -> do tm <- getClockTime 
                                                  return ([BCOs bcos itbl_env], tm)
919
		       Nothing -> panic "compile: no interpreted code"
920 921

		-- we're in batch mode: finish the compilation pipeline.
922 923
		_other -> do pipe <- genPipeline (StopBefore Ln) "" True 
					hsc_lang output_fn
924 925 926 927
                             -- runPipeline takes input_fn so it can split off 
                             -- the base name and use it as the base of 
                             -- the output object file.
                             let (basename, suffix) = splitFilename input_fn
928 929 930 931
			     o_file <- pipeLoop pipe output_fn False False 
                                                basename suffix
                             o_time <- getModificationTime o_file
			     return ([DotO o_file], o_time)
932

933 934
	   let linkable = LM unlinked_time (moduleName (ms_mod summary)) 
			     (hs_unlinked ++ stub_unlinked)
935

936 937
	   return (CompOK pcs details iface (Just linkable))

938 939 940 941 942 943 944 945 946 947 948 949 950

-----------------------------------------------------------------------------
-- stub .h and .c files (for foreign export support)

dealWithStubs basename maybe_stub_h maybe_stub_c

 = do	let stub_h = basename ++ "_stub.h"
	let stub_c = basename ++ "_stub.c"

  -- copy the .stub_h file into the current dir if necessary
	case maybe_stub_h of
	   Nothing -> return ()
	   Just tmp_stub_h -> do
951
	      	runSomething "Copy stub .h file"
952 953 954 955 956 957 958 959 960
				("cp " ++ tmp_stub_h ++ ' ':stub_h)
	
			-- #include <..._stub.h> in .hc file
		addCmdlineHCInclude tmp_stub_h	-- hack

  -- copy the .stub_c file into the current dir, and compile it, if necessary
	case maybe_stub_c of
	   Nothing -> return Nothing
	   Just tmp_stub_c -> do  -- copy the _stub.c file into the current dir
961
		runSomething "Copy stub .c file" 
962 963
		    (unwords [ 
			"rm -f", stub_c, "&&",
rrt's avatar
rrt committed
964
			"echo \'#include \"Stg.h\"\n#include \""++stub_h++"\"\' >"++stub_c, " &&",
965 966 967 968
			"cat", tmp_stub_c, ">> ", stub_c
			])

			-- compile the _stub.c file w/ gcc
969 970
		pipeline <- genPipeline (StopBefore Ln) "" True 
				defaultHscLang stub_c
971 972 973 974
		stub_o <- runPipeline pipeline stub_c False{-no linking-} 
				False{-no -o option-}

		return (Just stub_o)