DriverPipeline.hs 31.2 KB
Newer Older
1
-----------------------------------------------------------------------------
2
-- $Id: DriverPipeline.hs,v 1.48 2001/01/16 21:05:51 qrczak 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 40 41
import HscTypes
import Outputable
import Module
42
import ErrUtils
43
import CmdLineOpts
44
import Config
45
import Panic
46 47
import Util

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

import IO
import Monad
import Maybe

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

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

data GhcMode
  = DoMkDependHS			-- ghc -M
rrt's avatar
rrt committed
66
  | DoMkDLL				-- ghc --mk-dll
67 68 69 70 71 72 73 74 75 76
  | 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
77
modeFlag "--mk-dll"      = Just $ DoMkDLL
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
modeFlag "-E" 		 = Just $ StopBefore Hsc
modeFlag "-C" 		 = Just $ StopBefore HCc
modeFlag "-S" 		 = Just $ StopBefore As
modeFlag "-c" 		 = Just $ StopBefore Ln
modeFlag "--make"        = Just $ DoMake
modeFlag "--interactive" = Just $ DoInteractive
modeFlag _               = Nothing

getGhcMode :: [String]
	 -> IO ( [String]   -- rest of command line
	       , GhcMode
	       , String	    -- "GhcMode" flag
	       )
getGhcMode flags 
  = case my_partition modeFlag flags of
	([]   , rest) -> return (rest, DoLink,  "") -- default is to do linking
	([(flag,one)], rest) -> return (rest, one, flag)
	(_    , _   ) -> 
	  throwDyn (OtherError 
rrt's avatar
rrt committed
97
		"only one of the flags -M, -E, -C, -S, -c, --make, --interactive, -mk-dll is allowed")
98 99 100 101 102 103 104 105 106

-----------------------------------------------------------------------------
-- 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
107
-- better way to do this would be to express the whole compilation as a
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
-- 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
123 124
-- that the C compiler from the first compilation can be overlapped
-- with the hsc compilation for the second file.
125 126 127 128

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

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

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

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

156 157 158 159 160
    start = startPhase suffix

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

    haskellish = haskellish_suffix suffix
    cish = cish_suffix suffix

165
       -- for a .hc file we need to force lang to HscC
166 167
    real_lang | start_phase == HCc  = HscC
	      | otherwise           = lang
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

   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"

      | 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
   ----------- -----  ----   ---   --   --  -  -  -
204 205 206 207
      myPhaseInputExt Ln = case osuf of Nothing -> phaseInputExt Ln
					Just s  -> s
      myPhaseInputExt other = phaseInputExt other

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

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

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
	-- 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
    )
259 260 261 262 263 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


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
292
  	= do o_file <- readIORef v_Output_file
293 294 295 296 297
   	     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
298
   			   then odir_ify (orig_basename ++ '.':suffix)
299 300 301 302 303 304
   			   else newTempName suffix

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

run_phase Unlit _basename _suff input_fn output_fn
305
  = do unlit <- readIORef v_Pgm_L
306
       unlit_flags <- getOpts opt_L
307
       runSomething "Literate pre-processor"
308 309 310 311 312 313 314
	  ("echo '# 1 \"" ++input_fn++"\"' > "++output_fn++" && "
	   ++ unlit ++ ' ':input_fn ++ " - >> " ++ output_fn)
       return True

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

315
run_phase Cpp basename suff input_fn output_fn
316
  = do src_opts <- getOptionsFromSource input_fn
317 318 319 320 321 322 323
       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))
324 325 326 327

       do_cpp <- readState cpp_flag
       if do_cpp
          then do
328
       	    cpp <- readIORef v_Pgm_P
329
	    hscpp_opts <- getOpts opt_P
330
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
331

332
	    cmdline_include_paths <- readIORef v_Include_paths
333 334 335 336
	    pkg_include_dirs <- getPackageIncludePath
	    let include_paths = map (\p -> "-I"++p) (cmdline_include_paths
							++ pkg_include_dirs)

337 338 339
	    verb <- getVerbFlag

	    runSomething "C pre-processor" 
340
		(unwords
341
       	    	   (["echo '{-# LINE 1 \"" ++ input_fn ++ "\" #-}'", ">", output_fn, "&&",
342 343 344 345 346 347 348
		     cpp, verb] 
		    ++ include_paths
		    ++ hs_src_cpp_opts
		    ++ hscpp_opts
		    ++ [ "-x", "c", input_fn, ">>", output_fn ]
		   ))
	  else do
349
	    runSomething "Ineffective C pre-processor"
350
	           ("echo '{-# LINE 1 \""  ++ input_fn ++ "\" #-}' > " 
351 352 353 354 355 356 357 358 359
		    ++ 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
360
   let (import_sources, import_normals, module_name) = getImports src
361

362 363 364
   deps_sources <- mapM (findDependency True basename)  import_sources
   deps_normals <- mapM (findDependency False basename) import_normals
   let deps = deps_sources ++ deps_normals
365

366
   osuf_opt <- readIORef v_Object_suf
367
   let osuf = case osuf_opt of
368
			Nothing -> phaseInputExt Ln
369 370
			Just s  -> s

371
   extra_suffixes <- readIORef v_Dep_suffixes
372 373 374 375 376
   let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
       ofiles = map (\suf -> basename ++ '.':suf) suffixes
   	   
   objs <- mapM odir_ify ofiles
   
377
   hdl <- readIORef v_Dep_tmp_hdl
378

379
	-- std dependency of the object(s) on the source file
380 381 382 383 384
   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
385
	  hisuf <- readIORef v_Hi_suf
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
	  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

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

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

462
   -- build a ModuleLocation to pass to hscMain.
463
        let location = ModuleLocation {
464 465 466 467
                          ml_hs_file   = Nothing,
                          ml_hspp_file = Just input_fn,
                          ml_hi_file   = Just hifile,
                          ml_obj_file  = Just o_file
468
                       }
469

470 471 472
  -- get the DynFlags
        dyn_flags <- readIORef v_DynFlags

473
  -- run the compiler!
474
        pcs <- initPersistentCompilerState
475 476
	result <- hscMain OneShot
                          dyn_flags{ hscOutName = output_fn }
477
			  source_unchanged
478
			  location
479 480 481 482
			  Nothing	 -- no iface
			  emptyModuleEnv -- HomeSymbolTable
			  emptyModuleEnv -- HomeIfaceTable
			  pcs
483 484 485

	case result of {

486
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
487

488 489 490 491 492
            HscNoRecomp pcs details iface -> 
	        do {
		  runSomething "Touching object file" ("touch " ++ o_file);
		  return False;
		};
493 494 495

	    HscRecomp pcs details iface maybe_stub_h maybe_stub_c 
		      _maybe_interpreted_code -> do
496

497
	    -- deal with stubs
498
	maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
499
	case maybe_stub_o of
500
		Nothing -> return ()
501
		Just stub_o -> add v_Ld_inputs stub_o
502

503
	return True
504
    }
505 506 507 508 509 510 511 512 513

-----------------------------------------------------------------------------
-- 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
514
   = do	cc <- readIORef v_Pgm_c
515
       	cc_opts <- (getOpts opt_c)
516
       	cmdline_include_dirs <- readIORef v_Include_paths
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546

        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
	cmdline_includes <- readState cmdline_hc_includes -- -#include options

	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"

547
	mangle <- readIORef v_Do_asm_mangling
548 549
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

550
        verb <- getVerbFlag
551

552
	o2 <- readIORef v_minus_o2_for_C
553 554 555 556 557
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

	pkg_extra_cc_opts <- getPackageExtraCcOpts

558 559 560 561
	split_objs <- readIORef v_Split_object_files
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]

562
	excessPrecision <- readIORef v_Excess_precision
563

564
	runSomething "C Compiler"
565 566 567 568 569 570 571 572
	 (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
573
		   ++ split_opt
574 575 576 577 578 579 580 581 582 583 584 585 586
		   ++ (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
587
  = do mangler <- readIORef v_Pgm_m
588 589 590 591 592 593
       mangler_opts <- getOpts opt_m
       machdep_opts <-
	 if (prefixMatch "i386" cTARGETPLATFORM)
	    then do n_regs <- readState stolen_x86_regs
		    return [ show n_regs ]
	    else return []
594
       runSomething "Assembly Mangler"
595 596 597 598 599 600 601 602 603 604 605
	(unwords (mangler : 
		     mangler_opts
		  ++ [ input_fn, output_fn ]
		  ++ machdep_opts
		))
       return True

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

run_phase SplitMangle _basename _suff input_fn _output_fn
606
  = do  splitter <- readIORef v_Pgm_s
607 608 609

	-- this is the prefix used for the split .s files
	tmp_pfx <- readIORef v_TmpDir
610
	x <- myGetProcessID
611
	let split_s_prefix = tmp_pfx ++ "/ghc" ++ show x
612
	writeIORef v_Split_prefix split_s_prefix
613 614 615 616 617
	addFilesToClean [split_s_prefix ++ "__*"] -- d:-)

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

618
	runSomething "Split Assembly File"
619 620 621 622 623 624 625 626 627
	 (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
628
	writeIORef v_N_split_files n
629 630 631 632 633 634
	return True

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

run_phase As _basename _suff input_fn output_fn
635
  = do	as <- readIORef v_Pgm_a
636 637
        as_opts <- getOpts opt_a

638
        cmdline_include_paths <- readIORef v_Include_paths
639
        let cmdline_include_flags = map (\p -> "-I"++p) cmdline_include_paths
640
        runSomething "Assembler"
641 642 643 644 645 646 647
	   (unwords (as : as_opts
		       ++ cmdline_include_flags
		       ++ [ "-c", input_fn, "-o",  output_fn ]
		    ))
	return True

run_phase SplitAs basename _suff _input_fn _output_fn
648
  = do  as <- readIORef v_Pgm_a
649 650
        as_opts <- getOpts opt_a

651 652
	split_s_prefix <- readIORef v_Split_prefix
	n <- readIORef v_N_split_files
653

654
	odir <- readIORef v_Output_dir
655 656 657 658 659 660 661 662 663
	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
664
		    runSomething "Assembler" 
665 666 667 668 669 670 671 672 673 674 675 676
			    (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
677
    ln <- readIORef v_Pgm_l
678
    verb <- getVerbFlag
679 680 681 682
    static <- readIORef v_Static
    let imp = if static then "" else "_imp"
    no_hs_main <- readIORef v_NoHsMain

683
    o_file <- readIORef v_Output_file
684 685 686 687 688
    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

689
    lib_paths <- readIORef v_Library_paths
690 691 692
    let lib_path_opts = map ("-L"++) lib_paths

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

695
    libs <- readIORef v_Cmdline_libraries
696 697 698 699 700 701
    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
702
    extra_ld_inputs <- readIORef v_Ld_inputs
703 704

	-- opts from -optl-<blah>
705
    extra_ld_opts <- getStaticOpts v_Opt_l
706

707 708 709 710 711
    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
712 713
                   else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
                          head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
714 715
#endif
    (md_c_flags, _) <- machdepCCOpts
716
    runSomething "Linker"
717
       (unwords
718
	 ([ ln, verb, "-o", output_fn ]
719
	 ++ md_c_flags
720
	 ++ o_files
721 722 723
#ifdef mingw32_TARGET_OS
	 ++ extra_os
#endif
724 725 726 727 728 729 730
	 ++ extra_ld_inputs
	 ++ lib_path_opts
	 ++ lib_opts
	 ++ pkg_lib_path_opts
	 ++ pkg_lib_opts
	 ++ pkg_extra_ld_opts
	 ++ extra_ld_opts
731 732 733 734 735
#ifdef mingw32_TARGET_OS
         ++ if static then [ "-u _PrelMain_mainIO_closure" , "-u ___init_PrelMain"] else []
#else
	 ++ [ "-u PrelMain_mainIO_closure" , "-u __init_PrelMain"]
#endif
736 737 738
	)
       )

rrt's avatar
rrt committed
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 804 805 806
-----------------------------------------------------------------------------
-- 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
	)
       )

807 808 809 810 811 812 813
-----------------------------------------------------------------------------
-- 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) 
814 815 816 817
  do init_driver_state <- readIORef v_InitDriverState
     writeIORef v_Driver_state init_driver_state

     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
818
			defaultHscLang filename
819
     runPipeline pipeline filename False{-no linking-} False{-no -o flag-}
820

821

822
-----------------------------------------------------------------------------
823
-- Compile a single module, under the control of the compilation manager.
824 825 826 827 828 829
--
-- 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.

830 831 832 833 834 835
-- 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.

836 837 838 839 840
-- 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?
841
        -> Maybe ModIface          -- old interface, if available
842 843
        -> HomeSymbolTable         -- for home module ModDetails
	-> HomeIfaceTable	   -- for home module Ifaces
844 845 846
        -> PersistentCompilerState -- persistent compiler state
        -> IO CompResult

847
data CompResult
848 849 850 851 852 853
   = 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)
854 855 856 857

   | CompErrs PersistentCompilerState	-- updated PCS


858
compile ghci_mode summary source_unchanged old_iface hst hit pcs = do 
859 860
   init_dyn_flags <- readIORef v_InitDynFlags
   writeIORef v_DynFlags init_dyn_flags
861 862
   init_driver_state <- readIORef v_InitDriverState
   writeIORef v_Driver_state init_driver_state
863

864 865
   showPass init_dyn_flags 
	(showSDoc (text "Compiling" <+> ppr (name_of_summary summary)))
866 867

   let verb = verbosity init_dyn_flags
868
   let location   = ms_location summary
869 870
   let input_fn   = unJust "compile:hs" (ml_hs_file location) 
   let input_fnpp = unJust "compile:hspp" (ml_hspp_file location)
871

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

874
   opts <- getOptionsFromSource input_fnpp
875 876 877
   processArgs dynamic_flags opts []
   dyn_flags <- readIORef v_DynFlags

878
   let hsc_lang = hscLang dyn_flags
879 880 881 882
   output_fn <- case hsc_lang of
		    HscAsm         -> newTempName (phaseInputExt As)
		    HscC           -> newTempName (phaseInputExt HCc)
        	    HscJava        -> newTempName "java" -- ToDo
883
		    HscInterpreted -> return (error "no output file")
884 885

   -- run the compiler
886 887
   hsc_result <- hscMain ghci_mode dyn_flags{ hscOutName = output_fn } 
			 source_unchanged
888
                         location old_iface hst hit pcs
889

890 891
   case hsc_result of
      HscFail pcs -> return (CompErrs pcs)
892

893
      HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)
894

895 896 897
      HscRecomp pcs details iface
	maybe_stub_h maybe_stub_c maybe_interpreted_code -> do
	   
898
	   let (basename, _) = splitFilename input_fn
899
	   maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
900 901 902
	   let stub_unlinked = case maybe_stub_o of
				  Nothing -> []
				  Just stub_o -> [ DotO stub_o ]
903

904
	   (hs_unlinked, unlinked_time) <-
905 906 907 908
	     case hsc_lang of

		-- in interpreted mode, just return the compiled code
		-- as our "unlinked" object.
909
		HscInterpreted -> 
910
		    case maybe_interpreted_code of
911 912
		       Just (bcos,itbl_env) -> do tm <- getClockTime 
                                                  return ([BCOs bcos itbl_env], tm)
913
		       Nothing -> panic "compile: no interpreted code"
914 915

		-- we're in batch mode: finish the compilation pipeline.
916 917
		_other -> do pipe <- genPipeline (StopBefore Ln) "" True 
					hsc_lang output_fn
918 919 920 921
                             -- 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
922 923 924 925
			     o_file <- pipeLoop pipe output_fn False False 
                                                basename suffix
                             o_time <- getModificationTime o_file
			     return ([DotO o_file], o_time)
926

927 928
	   let linkable = LM unlinked_time (moduleName (ms_mod summary)) 
			     (hs_unlinked ++ stub_unlinked)
929

930 931
	   return (CompOK pcs details iface (Just linkable))

932 933 934 935 936 937 938 939 940 941 942 943 944

-----------------------------------------------------------------------------
-- 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
945
	      	runSomething "Copy stub .h file"
946 947 948 949 950 951 952 953 954
				("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
955
		runSomething "Copy stub .c file" 
956 957
		    (unwords [ 
			"rm -f", stub_c, "&&",
rrt's avatar
rrt committed
958
			"echo \'#include \"Stg.h\"\n#include \""++stub_h++"\"\' >"++stub_c, " &&",
959 960 961 962
			"cat", tmp_stub_c, ">> ", stub_c
			])

			-- compile the _stub.c file w/ gcc
963 964
		pipeline <- genPipeline (StopBefore Ln) "" True 
				defaultHscLang stub_c
965 966 967 968
		stub_o <- runPipeline pipeline stub_c False{-no linking-} 
				False{-no -o option-}

		return (Just stub_o)