DriverPipeline.hs 34.7 KB
Newer Older
1
-----------------------------------------------------------------------------
rrt's avatar
rrt committed
2
-- $Id: DriverPipeline.hs,v 1.86 2001/07/03 16:46:21 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"

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

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

import IO
import Monad
import Maybe

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

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

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

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

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

data IntermediateFileType
  = Temporary
  | Persistent
120
  deriving (Eq, Show)
121 122 123 124

genPipeline
   :: GhcMode		-- when to stop
   -> String		-- "stop after" flag (for error messages)
125
   -> Bool		-- True => output is persistent
126
   -> HscLang		-- preferred output language for hsc
127 128 129 130 131 132 133
   -> String		-- original filename
   -> IO [ 		-- list of phases to run for this file
	     (Phase,
	      IntermediateFileType,  -- keep the output from this phase?
	      String)   	     -- output file suffix
         ]	

134
genPipeline todo stop_flag persistent_output lang filename 
135
 = do
136 137 138 139 140
   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
141
   osuf       <- readIORef v_Object_suf
142
   hcsuf      <- readIORef v_HC_suf
143 144 145 146 147

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

148 149 150 151 152
    start = startPhase suffix

      -- special case for mkdependHS: .hspp files go through MkDependHS
    start_phase | todo == DoMkDependHS && start == Hsc  = MkDependHS
	        | otherwise = start
153 154 155 156

    haskellish = haskellish_suffix suffix
    cish = cish_suffix suffix

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

   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
179 180
	HscILX  | split           -> not_valid
		| otherwise       -> [ 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 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


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

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

run_phase Unlit _basename _suff input_fn output_fn
301 302
  = do unlit_flags <- getOpts opt_L
       SysTools.runUnlit (unlit_flags ++ ["-h", input_fn, input_fn, output_fn])
303 304 305 306 307
       return True

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

308
run_phase Cpp basename suff input_fn output_fn
309
  = do src_opts <- getOptionsFromSource input_fn
310
       unhandled_flags <- processArgs dynamic_flags src_opts []
311
       checkProcessArgsResult unhandled_flags basename suff
312

313
       do_cpp <- dynFlag cppFlag
314 315
       if do_cpp
          then do
316
	    hscpp_opts	    <- getOpts opt_P
317
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
318

319
	    cmdline_include_paths <- readIORef v_Include_paths
320 321 322 323
	    pkg_include_dirs <- getPackageIncludePath
	    let include_paths = map (\p -> "-I"++p) (cmdline_include_paths
							++ pkg_include_dirs)

324
	    verb <- getVerbFlag
rrt's avatar
rrt committed
325
	    (md_c_flags, _) <- machdepCCOpts
326

327 328 329 330 331 332 333
	    SysTools.runCpp ([verb]
			    ++ include_paths
			    ++ hs_src_cpp_opts
			    ++ hscpp_opts
			    ++ md_c_flags
			    ++ [ "-x", "c", input_fn, "-o", output_fn ])

rrt's avatar
rrt committed
334
	-- ToDo: switch away from using 'echo' altogether (but need
sof's avatar
sof committed
335
	-- a faster alternative than what's done below).
rrt's avatar
rrt committed
336
#if defined(mingw32_TARGET_OS)
rrt's avatar
rrt committed
337
	  else do
sof's avatar
sof committed
338 339 340 341 342
	    h <- openFile output_fn WriteMode
	    hPutStrLn h ("{-# LINE 1 \"" ++ input_fn ++ "\" #-}")
	    ls <- readFile input_fn -- inefficient, but it'll do for now.
	    			    -- ToDo: speed up via slurping.
	    hPutStrLn h ls
rrt's avatar
rrt committed
343
	    hClose h
sof's avatar
sof committed
344
#else
345
	  else do
346
	    SysTools.runSomething "Ineffective C pre-processor"
347
	           ("echo '{-# LINE 1 \""  ++ input_fn ++ "\" #-}' > " 
348
		    ++ output_fn ++ " && cat " ++ input_fn
349
		    ++ " >> " ++ output_fn) []
sof's avatar
sof committed
350
#endif
351 352 353 354 355 356 357
       return True

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

run_phase MkDependHS basename suff input_fn _output_fn = do 
   src <- readFile input_fn
358
   let (import_sources, import_normals, _) = getImports src
359

360 361 362
   let orig_fn = basename ++ '.':suff
   deps_sources <- mapM (findDependency True  orig_fn) import_sources
   deps_normals <- mapM (findDependency False orig_fn) import_normals
363
   let deps = deps_sources ++ deps_normals
364

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

370
   extra_suffixes <- readIORef v_Dep_suffixes
371 372 373 374 375
   let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
       ofiles = map (\suf -> basename ++ '.':suf) suffixes
   	   
   objs <- mapM odir_ify ofiles
   
376
	-- Handle for file that accumulates dependencies 
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 431 432 433 434
  -- 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 
435
				 (c_includes ++ reverse cmdline_includes))
436 437 438 439 440 441 442 443
	    mk_include h_file = 
		case h_file of 
		   '"':_{-"-} -> "#include "++h_file
		   '<':_      -> "#include "++h_file
		   _          -> "#include \""++h_file++"\""

	writeIORef v_HCHeader cc_injects

444 445 446 447 448
  -- gather the imports and module name
        (srcimps,imps,mod_name) <- getImportsFromFile input_fn

  -- build a ModuleLocation to pass to hscMain.
	Just (mod, location')
449
	   <- mkHomeModuleLocn mod_name basename (Just (basename ++ '.':suff))
450 451 452 453 454 455

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

456 457 458 459
  -- 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?)
  --
460
  -- Setting source_unchanged to True means that M.o seems
461 462
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
463
  -- Setting source_unchanged to False tells the compiler that M.o is out of
464
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
sof's avatar
sof committed
465 466 467 468 469 470 471
	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
472 473
	source_unchanged <- 
          if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
474
	     then return False
475 476 477
	     else do t1 <- getModificationTime (basename ++ '.':suff)
		     o_file_exists <- doesFileExist o_file
		     if not o_file_exists
478
		        then return False	-- Need to recompile
479 480
			else do t2 <- getModificationTime o_file
			        if t2 > t1
481 482
				  then return True
				  else return False
483

484
  -- get the DynFlags
485
        dyn_flags <- getDynFlags
486

487 488
        let dyn_flags' = dyn_flags { hscOutName = output_fn,
		   		     hscStubCOutName = basename ++ "_stub.c",
apt's avatar
apt committed
489 490
				     hscStubHOutName = basename ++ "_stub.h",
				     extCoreName = basename ++ ".core" }
491

492
  -- run the compiler!
493
        pcs <- initPersistentCompilerState
494
	result <- hscMain OneShot
495
                          dyn_flags' mod
496
			  location{ ml_hspp_file=Just input_fn }
497
			  source_unchanged
498
			  False
499 500 501 502
			  Nothing	 -- no iface
			  emptyModuleEnv -- HomeSymbolTable
			  emptyModuleEnv -- HomeIfaceTable
			  pcs
503 504 505

	case result of {

506
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
507

508 509
            HscNoRecomp pcs details iface -> do { SysTools.touch "Touching object file" o_file
						; return False } ;
510

511
	    HscRecomp pcs details iface stub_h_exists stub_c_exists
512
		      _maybe_interpreted_code -> do
513

514
	    -- deal with stubs
515
	maybe_stub_o <- compileStub dyn_flags' stub_c_exists
516
	case maybe_stub_o of
517
		Nothing -> return ()
518
		Just stub_o -> add v_Ld_inputs stub_o
519

520
	return True
521
    }
522 523 524 525 526 527 528

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

529
run_phase cc_phase basename suff input_fn output_fn
530
   | cc_phase == Cc || cc_phase == HCc
531
   = do	cc_opts		     <- getOpts opt_c
532
       	cmdline_include_dirs <- readIORef v_Include_paths
533 534 535 536 537 538 539 540 541 542

        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)

543
	mangle <- readIORef v_Do_asm_mangling
544 545
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

546
        verb <- getVerbFlag
547

548
	o2 <- readIORef v_minus_o2_for_C
549 550 551 552 553
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

	pkg_extra_cc_opts <- getPackageExtraCcOpts

554 555 556 557
	split_objs <- readIORef v_Split_object_files
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]

558
	excessPrecision <- readIORef v_Excess_precision
559 560 561 562 563 564 565 566 567 568 569 570 571
	SysTools.runCc ([ "-x", "c", input_fn, "-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
		       ++ split_opt
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
		       )
572 573 574 575 576 577 578 579
	return True

	-- ToDo: postprocess the output from gcc

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

run_phase Mangle _basename _suff input_fn output_fn
580 581 582 583 584 585 586 587 588
  = 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 []

       SysTools.runMangle (mangler_opts
		          ++ [ input_fn, output_fn ]
		          ++ machdep_opts)
589 590 591 592 593 594
       return True

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

run_phase SplitMangle _basename _suff input_fn _output_fn
595 596 597 598
  = 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
599

600 601 602 603 604 605 606 607 608 609
	SysTools.runSplit [input_fn, split_s_prefix, n_files_fn]

	-- 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]]
610 611 612 613 614 615 616

	return True

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

run_phase As _basename _suff input_fn output_fn
617
  = do	as_opts		      <- getOpts opt_a
618
        cmdline_include_paths <- readIORef v_Include_paths
619 620 621 622

	SysTools.runAs (as_opts
		       ++ [ "-I" ++ p | p <- cmdline_include_paths ]
		       ++ [ "-c", input_fn, "-o",  output_fn ])
623 624 625
	return True

run_phase SplitAs basename _suff _input_fn _output_fn
626
  = do  as_opts <- getOpts opt_a
627

628
	(split_s_prefix, n) <- readIORef v_Split_info
629

630
	odir <- readIORef v_Output_dir
631 632 633 634
	let real_odir = case odir of
				Nothing -> basename
				Just d  -> d

635 636
	let assemble_file n
	      = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
637 638 639
		    let output_o = newdir real_odir 
					(basename ++ "__" ++ show n ++ ".o")
		    real_o <- osuf_ify output_o
640
		    SysTools.runAs (as_opts ++ ["-c", "-o", real_o, input_s])
641 642 643 644
	
	mapM_ assemble_file [1..n]
	return True

645 646 647 648 649 650 651 652 653 654 655 656 657
-----------------------------------------------------------------------------
-- 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	
658
        sysMan   <- getSysMan
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
        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);"
 ]

729 730 731 732
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

checkProcessArgsResult flags basename suff
733
  = do when (not (null flags)) (throwDyn (ProgramError (
734 735 736 737
           basename ++ "." ++ suff 
           ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
           ++ unwords flags)) (ExitFailure 1))

738 739 740 741 742
-----------------------------------------------------------------------------
-- Linking

doLink :: [String] -> IO ()
doLink o_files = do
743 744
    verb       <- getVerbFlag
    static     <- readIORef v_Static
745 746
    no_hs_main <- readIORef v_NoHsMain

747
    o_file <- readIORef v_Output_file
748 749 750 751 752
    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

753
    lib_paths <- readIORef v_Library_paths
754 755 756
    let lib_path_opts = map ("-L"++) lib_paths

    pkg_libs <- getPackageLibraries
757 758
    let imp	     = if static then "" else "_imp"
        pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
759

760
    libs <- readIORef v_Cmdline_libraries
761 762 763 764 765 766
    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
767
    extra_ld_inputs <- readIORef v_Ld_inputs
768 769

	-- opts from -optl-<blah>
770
    extra_ld_opts <- getStaticOpts v_Opt_l
771

772 773 774 775
    rts_pkg <- getPackageDetails ["rts"]
    std_pkg <- getPackageDetails ["std"]
    let extra_os = if static || no_hs_main
                   then []
rrt's avatar
rrt committed
776 777
                   else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
                          head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
778

779
    (md_c_flags, _) <- machdepCCOpts
780 781 782 783 784 785 786 787 788 789 790
    SysTools.runLink ( [verb, "-o", output_fn]
		      ++ md_c_flags
	 	      ++ 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
791
	              ++ if static && not no_hs_main then
792 793 794 795 796 797 798 799
#ifdef LEADING_UNDERSCORE
			    [ "-u _PrelMain_mainIO_closure" ,
			      "-u ___init_PrelMain"] 
#else
			    [ "-u PrelMain_mainIO_closure" ,
			      "-u __init_PrelMain"] 
#endif
			 else [])
800

801 802
    -- parallel only: move binary to another dir -- HWL
    ways_ <- readIORef v_Ways
803 804 805 806
    when (WayPar `elem` ways_)
	 (do success <- run_phase_MoveBinary output_fn
             if success then return ()
                        else throwDyn (InstallationError ("cannot move binary to PVM dir")))
807

rrt's avatar
rrt committed
808
-----------------------------------------------------------------------------
809
-- Making a DLL (only for Win32)
rrt's avatar
rrt committed
810 811 812

doMkDLL :: [String] -> IO ()
doMkDLL o_files = do
813 814
    verb       <- getVerbFlag
    static     <- readIORef v_Static
rrt's avatar
rrt committed
815 816 817 818 819 820 821 822 823 824 825 826
    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
827 828
    let imp = if static then "" else "_imp"
        pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
rrt's avatar
rrt committed
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843

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

rrt's avatar
rrt committed
845 846 847 848
    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" ]
849

rrt's avatar
rrt committed
850
    (md_c_flags, _) <- machdepCCOpts
851 852
    SysTools.runMkDLL
	 ([ verb, "-o", output_fn ]
rrt's avatar
rrt committed
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
	 ++ md_c_flags
	 ++ 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
	)

869 870 871 872 873 874
-----------------------------------------------------------------------------
-- 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 =
875
  ASSERT(haskellish_src_file filename) 
876
  do restoreDynFlags	-- Restore to state of last save
877
     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
878
			     defaultHscLang filename
879
     runPipeline pipeline filename False{-no linking-} False{-no -o flag-}
880 881

-----------------------------------------------------------------------------
882
-- Compile a single module, under the control of the compilation manager.
883 884 885 886 887 888
--
-- 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.

889 890 891 892 893 894
-- 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.

895 896 897 898
-- NB.  No old interface can also mean that the source has changed.

compile :: GhciMode                -- distinguish batch from interactive
        -> ModSummary              -- summary, including source
899 900
	-> Bool			   -- True <=> source unchanged
	-> Bool			   -- True <=> have object
901
        -> Maybe ModIface          -- old interface, if available
902 903
        -> HomeSymbolTable         -- for home module ModDetails
	-> HomeIfaceTable	   -- for home module Ifaces
904 905 906
        -> PersistentCompilerState -- persistent compiler state
        -> IO CompResult

907
data CompResult
908 909 910 911 912 913
   = 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)
914 915 916 917

   | CompErrs PersistentCompilerState	-- updated PCS


918 919
compile ghci_mode summary source_unchanged have_object 
	old_iface hst hit pcs = do 
920 921
   dyn_flags <- restoreDynFlags		-- Restore to the state of the last save

922

923
   showPass dyn_flags 
924
	(showSDoc (text "Compiling" <+> ppr (name_of_summary summary)))
925

926
   let verb	  = verbosity dyn_flags
927
   let location   = ms_location summary
928 929
   let input_fn   = unJust "compile:hs" (ml_hs_file location) 
   let input_fnpp = unJust "compile:hspp" (ml_hspp_file location)
930

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

933
   opts <- getOptionsFromSource input_fnpp
934
   processArgs dynamic_flags opts []
935
   dyn_flags <- getDynFlags
936

937
   let hsc_lang      = hscLang dyn_flags
938 939
       (basename, _) = splitFilename input_fn
       
940 941 942 943
   output_fn <- case hsc_lang of
		    HscAsm         -> newTempName (phaseInputExt As)
		    HscC           -> newTempName (phaseInputExt HCc)
        	    HscJava        -> newTempName "java" -- ToDo
944
		    HscILX         -> return (basename ++ ".ilx") 	-- newTempName "ilx"	-- ToDo
945
		    HscInterpreted -> return (error "no output file")
946

947
   let dyn_flags' = dyn_flags { hscOutName = output_fn,
948
				hscStubCOutName = basename ++ "_stub.c",
apt's avatar
apt committed
949 950
				hscStubHOutName = basename ++ "_stub.h",
				extCoreName = basename ++ ".core" }
951

952 953 954 955 956 957 958 959 960 961 962 963 964 965
   -- 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 
                                 (c_includes ++ reverse cmdline_includes))
       mk_include h_file = 
	case h_file of 
           '"':_{-"-} -> "#include "++h_file
           '<':_      -> "#include "++h_file
           _          -> "#include \""++h_file++"\""

   writeIORef v_HCHeader cc_injects

966
   -- run the compiler
967
   hsc_result <- hscMain ghci_mode dyn_flags'
968
			 (ms_mod summary) location
969
			 source_unchanged have_object old_iface hst hit pcs
970

971 972
   case hsc_result of
      HscFail pcs -> return (CompErrs pcs)
973

974
      HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)
975

976
      HscRecomp pcs details iface
977
	stub_h_exists stub_c_exists maybe_interpreted_code -> do
978
	   
979 980
	   let 
	   maybe_stub_o <- compileStub dyn_flags' stub_c_exists
981 982 983
	   let stub_unlinked = case maybe_stub_o of
				  Nothing -> []
				  Just stub_o -> [ DotO stub_o ]
984

985
	   (hs_unlinked, unlinked_time) <-
986 987 988 989
	     case hsc_lang of

		-- in interpreted mode, just return the compiled code
		-- as our "unlinked" object.
990
		HscInterpreted -> 
991
		    case maybe_interpreted_code of
992 993
		       Just (bcos,itbl_env) -> do tm <- getClockTime 
                                                  return ([BCOs bcos itbl_env], tm)
994
		       Nothing -> panic "compile: no interpreted code"
995 996

		-- we're in batch mode: finish the compilation pipeline.
997 998
		_other -> do pipe <- genPipeline (StopBefore Ln) "" True 
					hsc_lang output_fn
999 1000 1001 1002
                             -- 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
1003 1004 1005 1006
			     o_file <- pipeLoop pipe output_fn False False 
                                                basename suffix
                             o_time <- getModificationTime o_file
			     return ([DotO o_file], o_time)
1007

1008 1009
	   let linkable = LM unlinked_time (moduleName (ms_mod summary)) 
			     (hs_unlinked ++ stub_unlinked)
1010

1011 1012
	   return (CompOK pcs details iface (Just linkable))

1013 1014 1015 1016

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

1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
compileStub dflags stub_c_exists
  | not stub_c_exists = return Nothing
  | stub_c_exists = do
	-- compile the _stub.c file w/ gcc
	let stub_c = hscStubCOutName dflags
	pipeline <- genPipeline (StopBefore Ln) "" True defaultHscLang stub_c
	stub_o <- runPipeline pipeline stub_c False{-no linking-} 
			False{-no -o option-}

	return (Just stub_o)