DriverPipeline.hs 37.6 KB
Newer Older
1
2
3
4
-----------------------------------------------------------------------------
--
-- GHC Driver
--
5
-- (c) The University of Glasgow 2002
6
7
8
--
-----------------------------------------------------------------------------

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

11
module DriverPipeline (
12

13
	-- Interfaces for the batch-mode driver
14
   runPipeline, staticLink,
15

16
17
18
19
	-- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess, 
   compile, CompResult(..), 
   link, 
20

rrt's avatar
rrt committed
21
22
        -- DLL building
   doMkDLL
23
24
25
26
  ) where

#include "HsVersions.h"

27
import Packages
28
import GetImports
29
30
31
import DriverState
import DriverUtil
import DriverMkDepend
32
import DriverPhases
33
import DriverFlags
sof's avatar
sof committed
34
import SysTools		( newTempName, addFilesToClean, getSysMan, copy )
35
import qualified SysTools	
36
import HscMain
37
import Finder
38
39
40
import HscTypes
import Outputable
import Module
41
import ErrUtils
42
import CmdLineOpts
43
import Config
44
import Panic
45
import Util
46
import BasicTypes	( SuccessFlag(..) )
47
import Maybes		( expectJust )
48

49
50
import ParserCoreUtils ( getCoreModuleName )

51
52
53
import EXCEPTION
import DATA_IOREF	( readIORef, writeIORef )

54
#ifdef GHCI
55
import Time 		( getClockTime )
56
#endif
57
58
import Directory
import System
59
60
61
62
import IO
import Monad
import Maybe

63

64
65
-- ---------------------------------------------------------------------------
-- Pre-process
66
67
68
69
70
71
72
73

-- 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_src_file filename) 
  do restoreDynFlags	-- Restore to state of last save
74
75
76
77
     runPipeline (StopBefore Hsc) ("preprocess") 
	False{-temporary output file-}
	Nothing{-no specific output file-}
	filename
78

79
80
-- ---------------------------------------------------------------------------
-- Compile
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

-- Compile a single module, under the control of the compilation manager.
--
-- 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.

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

-- NB.  No old interface can also mean that the source has changed.

compile :: GhciMode                -- distinguish batch from interactive
	-> Module
	-> ModLocation
	-> Bool			   -- True <=> source unchanged
	-> Bool			   -- True <=> have object
        -> Maybe ModIface          -- old interface, if available
        -> HomePackageTable        -- For home-module stuff
        -> PersistentCompilerState -- persistent compiler state
        -> IO CompResult

data CompResult
   = CompOK   PersistentCompilerState	-- Updated PCS
              ModDetails 		-- New details
              ModIface			-- New iface
              (Maybe Linkable)	-- New code; Nothing => compilation was not reqd
		                --			(old code is still valid)

   | CompErrs PersistentCompilerState	-- Updated PCS


compile ghci_mode this_mod location
	source_unchanged have_object 
	old_iface hpt pcs = do 

   dyn_flags <- restoreDynFlags		-- Restore to the state of the last save

   showPass dyn_flags 
	(showSDoc (text "Compiling" <+> ppr this_mod))

   let verb	  = verbosity dyn_flags
   let input_fn   = expectJust "compile:hs" (ml_hs_file location) 
   let input_fnpp = expectJust "compile:hspp" (ml_hspp_file location)
   let mod_name   = moduleName this_mod

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

   opts <- getOptionsFromSource input_fnpp
   processArgs dynamic_flags opts []
   dyn_flags <- getDynFlags

137
   let (basename, _) = splitFilename input_fn
138
       
139
140
141
142
143
144
145
146
147
148
   -- figure out what lang we're generating
   hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
   -- figure out what the next phase should be
   next_phase <- hscNextPhase hsc_lang
   -- figure out what file to generate the output into
   get_output_fn <- genOutputFilenameFunc False Nothing next_phase basename
   output_fn <- get_output_fn next_phase

   let dyn_flags' = dyn_flags { hscLang = hsc_lang,
				hscOutName = output_fn,
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
				hscStubCOutName = basename ++ "_stub.c",
				hscStubHOutName = basename ++ "_stub.h",
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
   do_recomp <- readIORef v_Recomp
   let source_unchanged' = source_unchanged && do_recomp
       hsc_env = HscEnv { hsc_mode = ghci_mode,
			  hsc_dflags = dyn_flags',
			  hsc_HPT    = hpt }

   -- run the compiler
   hsc_result <- hscMain hsc_env pcs this_mod location
			 source_unchanged' have_object old_iface

   case hsc_result of
      HscFail pcs -> return (CompErrs pcs)

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

      HscRecomp pcs details iface
	stub_h_exists stub_c_exists maybe_interpreted_code -> do
	   let 
	   maybe_stub_o <- compileStub dyn_flags' stub_c_exists
	   let stub_unlinked = case maybe_stub_o of
				  Nothing -> []
				  Just stub_o -> [ DotO stub_o ]

	   (hs_unlinked, unlinked_time) <-
	     case hsc_lang of

		-- in interpreted mode, just return the compiled code
		-- as our "unlinked" object.
		HscInterpreted -> 
		    case maybe_interpreted_code of
#ifdef GHCI
		       Just comp_bc -> do tm <- getClockTime 
                                          return ([BCOs comp_bc], tm)
#endif
		       Nothing -> panic "compile: no interpreted code"

		-- we're in batch mode: finish the compilation pipeline.
191
192
193
194
195
196
197
198
199
200
201
202
		_other -> do
		   let object_filename = ml_obj_file location
		       object_dir = directoryOf object_filename

		   -- create the object dir if it doesn't exist
		   createDirectoryHierarchy object_dir

		   runPipeline (StopBefore Ln) ""
			True (Just object_filename) output_fn

		   o_time <- getModificationTime object_filename
		   return ([DotO object_filename], o_time)
203
204
205
206
207
208

	   let linkable = LM unlinked_time mod_name
			     (hs_unlinked ++ stub_unlinked)

	   return (CompOK pcs details iface (Just linkable))

209
-----------------------------------------------------------------------------
210
211
212
213
214
215
216
-- stub .h and .c files (for foreign export support)

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
217
218
219
220
	stub_o <- runPipeline (StopBefore Ln) "stub-compile"
			True{-persistent output-} 
			Nothing{-no specific output file-}
			stub_c
221
222
223
	return (Just stub_o)


224
225
-- ---------------------------------------------------------------------------
-- Link
226
227
228
229

link :: GhciMode		-- interactive or batch
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
230
     -> HomePackageTable	-- what to link
231
232
233
234
235
236
237
238
239
240
     -> IO SuccessFlag

-- For the moment, in the batch linker, we don't bother to tell doLink
-- which packages to link -- it just tries all that are available.
-- batch_attempt_linking should only be *looked at* in batch mode.  It
-- should only be True if the upsweep was successful and someone
-- exports main, i.e., we have good reason to believe that linking
-- will succeed.

#ifdef GHCI
241
242
link Interactive dflags batch_attempt_linking hpt
    = do -- Not Linking...(demand linker will do the job)
243
244
245
	 return Succeeded
#endif

246
link Batch dflags batch_attempt_linking hpt
247
   | batch_attempt_linking
248
   = do 
249
250
251
252
253
254
255
256
257
258
259
260
261
	let 
	    home_mod_infos = moduleEnvElts hpt

	    -- the packages we depend on
	    pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos

	    -- the linkables to link
	    linkables = map hm_linkable home_mod_infos

        when (verb >= 3) $ do
	     hPutStrLn stderr "link: linkables are ..."
             hPutStrLn stderr (showSDoc (vcat (map ppr linkables)))

262
263
264
265
266
267
268
269
270
271
	-- check for the -no-link flag
	omit_linking <- readIORef v_NoLink
	if omit_linking 
	  then do when (verb >= 3) $
		    hPutStrLn stderr "link(batch): linking omitted (-no-link flag given)."
	          return Succeeded
	  else do

	when (verb >= 1) $
             hPutStrLn stderr "Linking ..."
272

273
274
275
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

276
	-- Don't showPass in Batch mode; doLink will do that for us.
277
278
279
        staticLink obj_files pkg_deps

        when (verb >= 3) (hPutStrLn stderr "link: done")
280
281
282
283
284
285
286
287
288
289
290

	-- staticLink only returns if it succeeds
        return Succeeded

   | otherwise
   = do when (verb >= 3) $ do
	    hPutStrLn stderr "link(batch): upsweep (partially) failed OR"
            hPutStrLn stderr "   Main.main not exported; not linking."
        return Succeeded
   where
      verb = verbosity dflags
291
      
292
293
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
294

295
296
297
298
299
300
301
302
303
304
305
306
307
runPipeline
  :: GhcMode		-- when to stop
  -> String		-- "stop after" flag
  -> Bool		-- final output is persistent?
  -> Maybe FilePath	-- where to put the output, optionally
  -> FilePath 		-- input filename
  -> IO FilePath	-- output filename

runPipeline todo stop_flag keep_output maybe_output_filename input_fn
  = do
  split <- readIORef v_Split_object_files
  let (basename, suffix) = splitFilename input_fn
      start_phase = startPhase suffix
308

309
310
311
312
313
314
      stop_phase = case todo of 
			StopBefore As | split -> SplitAs
			StopBefore phase      -> phase
			DoMkDependHS	      -> Ln
			DoLink                -> Ln
			DoMkDLL               -> Ln
315

316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
  -- We want to catch cases of "you can't get there from here" before
  -- we start the pipeline, because otherwise it will just run off the
  -- end.
  --
  -- There is a partial ordering on phases, where A < B iff A occurs
  -- before B in a normal compilation pipeline.
  --
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
		    ("flag `" ++ stop_flag
		     ++ "' is incompatible with source file `"
		     ++ input_fn ++ "'"))

  -- generate a function which will be used to calculate output file names
  -- as we go along.
  get_output_fn <- genOutputFilenameFunc keep_output maybe_output_filename
			stop_phase basename

  -- and execute the pipeline...
  output_fn <- pipeLoop start_phase stop_phase input_fn basename suffix 
		 get_output_fn

  -- sometimes, a compilation phase doesn't actually generate any output
  -- (eg. the CPP phase when -fcpp is not turned on).  If we end on this
  -- stage, but we wanted to keep the output, then we have to explicitly
  -- copy the file.
  if keep_output
	then do final_fn <- get_output_fn stop_phase
	        when (final_fn /= output_fn) $
	 	  copy ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
			++ "'") output_fn final_fn
	        return final_fn
	else
	     return output_fn


pipeLoop :: Phase -> Phase -> FilePath -> String -> Suffix
  -> (Phase -> IO FilePath) -> IO FilePath
354

355
356
pipeLoop phase stop_phase input_fn orig_basename orig_suff get_output_fn
  | phase == stop_phase  =  return input_fn  -- all done
357
358
359
360
361
362
363
364
365

  | not (phase `happensBefore` stop_phase)  = 
	-- Something has gone wrong.  We'll try to cover all the cases when
	-- this could happen, so if we reach here it is a panic.
	-- eg. it might happen if the -C flag is used on a source file that
	-- has {-# OPTIONS -fasm #-}.
	panic ("pipeLoop: at phase " ++ show phase ++ 
		" but I wanted to stop at phase " ++ show stop_phase)

366
367
368
369
  | otherwise = do
	maybe_next_phase <- runPhase phase orig_basename orig_suff input_fn
				get_output_fn
	case maybe_next_phase of
370
371
372
373
374
	  (Nothing, output_fn) -> 
		-- we stopped early, but return the *final* filename
		-- (it presumably already exists)
		get_output_fn stop_phase
	  (Just next_phase, output_fn) ->
375
376
377
378
379
380
381
		pipeLoop next_phase stop_phase output_fn
			orig_basename orig_suff get_output_fn

  
genOutputFilenameFunc :: Bool -> Maybe FilePath -> Phase -> String
  -> IO (Phase{-next phase-} -> IO FilePath)
genOutputFilenameFunc keep_output maybe_output_filename stop_phase basename
382
 = do
383
   hcsuf      <- readIORef v_HC_suf
384
   odir       <- readIORef v_Output_dir
385
   osuf       <- readIORef v_Object_suf
386
   keep_hc    <- readIORef v_Keep_hc_files
sof's avatar
sof committed
387
#ifdef ILX
rrt's avatar
rrt committed
388
   keep_il    <- readIORef v_Keep_il_files
sof's avatar
sof committed
389
390
   keep_ilx   <- readIORef v_Keep_ilx_files
#endif
391
392
   keep_raw_s <- readIORef v_Keep_raw_s_files
   keep_s     <- readIORef v_Keep_s_files
393
   let
394
395
396
397
398
399
400
401
        myPhaseInputExt HCc | Just s <- hcsuf = s
        myPhaseInputExt Ln    = osuf
        myPhaseInputExt other = phaseInputExt other

	func next_phase
     		| next_phase == stop_phase
                     = case maybe_output_filename of
			     Just file -> return file
402
403
404
405
			     Nothing
				 | Ln <- next_phase -> return odir_persistent
				 | keep_output      -> return persistent
				 | otherwise        -> newTempName suffix
406
407
			-- sometimes, we keep output from intermediate stages
     		| otherwise
408
     		     = case next_phase of
409
     			     Ln                  -> return odir_persistent
410
411
412
413
414
415
416
     			     Mangle | keep_raw_s -> return persistent
     			     As     | keep_s     -> return persistent
     			     HCc    | keep_hc    -> return persistent
     			     _other              -> newTempName suffix
	   where
		suffix = myPhaseInputExt next_phase
		persistent = basename ++ '.':suffix
417

418
419
420
421
		odir_persistent
		   | Just d <- odir = replaceFilenameDirectory persistent d
		   | otherwise      = persistent

422
   return func
423
424


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
-- -----------------------------------------------------------------------------
-- Each phase in the pipeline returns the next phase to execute, and the
-- name of the file in which the output was placed.
--
-- We must do things dynamically this way, because we often don't know
-- what the rest of the phases will be until part-way through the
-- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
-- of a source file can change the latter stages of the pipeline from
-- taking the via-C route to using the native code generator.

runPhase :: Phase
	  -> String	-- basename of original input source
	  -> String	-- its extension
	  -> FilePath	-- name of file which contains the input to this phase.
	  -> (Phase -> IO FilePath)	-- how to calculate the output filename
	  -> IO (Maybe Phase,   -- next phase
		 FilePath)	-- output filename
442
443
444
445

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

446
runPhase Unlit _basename _suff input_fn get_output_fn
447
  = do unlit_flags <- getOpts opt_L
rrt's avatar
rrt committed
448
       -- The -h option passes the file name for unlit to put in a #line directive
449
450
       output_fn <- get_output_fn Cpp

sof's avatar
sof committed
451
452
453
       SysTools.runUnlit (map SysTools.Option unlit_flags ++
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
454
455
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
456
			  ])
457
458

       return (Just Cpp, output_fn)
459
460
461
462

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

463
runPhase Cpp basename suff input_fn get_output_fn
464
  = do src_opts <- getOptionsFromSource input_fn
465
       unhandled_flags <- processArgs dynamic_flags src_opts []
466
       checkProcessArgsResult unhandled_flags basename suff
467

468
       do_cpp <- dynFlag cppFlag
sof's avatar
sof committed
469
470
471
       if not do_cpp then
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
472
          return (Just HsPp, input_fn)
sof's avatar
sof committed
473
	else do
474
	    hscpp_opts	    <- getOpts opt_P
475
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
476

477
	    cmdline_include_paths <- readIORef v_Include_paths
478
479

	    pkg_include_dirs <- getPackageIncludePath []
rrt's avatar
rrt committed
480
481
	    let include_paths = foldr (\ x xs -> "-I" : x : xs) []
				  (cmdline_include_paths ++ pkg_include_dirs)
482

483
	    verb <- getVerbFlag
rrt's avatar
rrt committed
484
	    (md_c_flags, _) <- machdepCCOpts
485

486
487
	    output_fn <- get_output_fn HsPp

sof's avatar
sof committed
488
489
490
491
492
	    SysTools.runCpp ([SysTools.Option verb]
			    ++ map SysTools.Option include_paths
			    ++ map SysTools.Option hs_src_cpp_opts
			    ++ map SysTools.Option hscpp_opts
			    ++ map SysTools.Option md_c_flags
sof's avatar
sof committed
493
494
			    ++ [ SysTools.Option     "-x"
			       , SysTools.Option     "c"
495
496
497
498
499
500
501
502
503
			       , SysTools.Option     input_fn
	-- We hackily use Option instead of FileOption here, so that the file
	-- name is not back-slashed on Windows.  cpp is capable of
	-- dealing with / in filenames, so it works fine.  Furthermore
	-- if we put in backslashes, cpp outputs #line directives
	-- with *double* backslashes.   And that in turn means that
	-- our error messages get double backslashes in them.
	-- In due course we should arrange that the lexer deals
	-- with these \\ escapes properly.
sof's avatar
sof committed
504
			       , SysTools.Option     "-o"
sof's avatar
sof committed
505
			       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
506
			       ])
507
508

	    return (Just HsPp, output_fn)
509

sof's avatar
sof committed
510
511
512
-------------------------------------------------------------------------------
-- HsPp phase 

513
514
runPhase HsPp basename suff input_fn get_output_fn
  = do do_pp   <- dynFlag ppFlag
sof's avatar
sof committed
515
516
517
       if not do_pp then
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
518
          return (Just Hsc, input_fn)
sof's avatar
sof committed
519
520
521
	else do
	    hspp_opts	   <- getOpts opt_F
       	    hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
522
523
	    let orig_fn = basename ++ '.':suff
	    output_fn <- get_output_fn Hsc
sof's avatar
sof committed
524
525
526
527
528
529
530
	    SysTools.runPp ( [ SysTools.Option     orig_fn
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hs_src_pp_opts ++
			     map SysTools.Option hspp_opts
			   )
531
	    return (Just Hsc, output_fn)
532

533
534
535
-----------------------------------------------------------------------------
-- Hsc phase

536
537
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
538
539
540
541
542
543
544
545
546
runPhase Hsc basename suff input_fn get_output_fn = do
  todo <- readIORef v_GhcMode
  if todo == DoMkDependHS then do
       doMkDependHSPhase basename suff input_fn
       return (Nothing, input_fn)  -- Ln is a dummy stop phase 

   else do
      -- normal Hsc mode, not mkdependHS

547
548
549
  -- 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.
550
	let current_dir = directoryOf basename
551
	
552
553
	paths <- readIORef v_Include_paths
	writeIORef v_Include_paths (current_dir : paths)
554
	
555
  -- gather the imports and module name
556
        (_,_,mod_name) <- 
557
558
559
560
561
562
563
            if extcoreish_suffix suff
	     then do
               -- no explicit imports in ExtCore input.
	       m <- getCoreModuleName input_fn
	       return ([], [], mkModuleName m)
	     else 
  	       getImportsFromFile input_fn
564

565
  -- build a ModLocation to pass to hscMain.
566
567
	let (path,file) = splitFilenameDir basename
	(mod, location') <- mkHomeModLocation mod_name True path file suff
568
569
570
571
572
573

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

574
575
576
577
  -- 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?)
  --
578
  -- Setting source_unchanged to True means that M.o seems
579
580
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
581
  -- Setting source_unchanged to False tells the compiler that M.o is out of
582
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
sof's avatar
sof committed
583
584
	do_recomp   <- readIORef v_Recomp
	expl_o_file <- readIORef v_Output_file
585
586
587
588
589

	let o_file -- if the -o option is given and IT IS THE OBJECT FILE FOR
		   -- THIS COMPILATION, then use that to determine if the 
		   -- source is unchanged.
		| Just x <- expl_o_file, todo == StopBefore Ln  =  x
590
		| otherwise = ml_obj_file location
591

592
593
	source_unchanged <- 
          if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
594
	     then return False
595
596
597
	     else do t1 <- getModificationTime (basename ++ '.':suff)
		     o_file_exists <- doesFileExist o_file
		     if not o_file_exists
598
		        then return False	-- Need to recompile
599
600
			else do t2 <- getModificationTime o_file
			        if t2 > t1
601
602
				  then return True
				  else return False
603

604
  -- get the DynFlags
605
        dyn_flags <- getDynFlags
606
607
	hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
	next_phase <- hscNextPhase hsc_lang
608
	output_fn <- get_output_fn next_phase
609

610
611
        let dyn_flags' = dyn_flags { hscLang = hsc_lang,
				     hscOutName = output_fn,
612
		   		     hscStubCOutName = basename ++ "_stub.c",
apt's avatar
apt committed
613
				     hscStubHOutName = basename ++ "_stub.h",
apt's avatar
apt committed
614
				     extCoreName = basename ++ ".hcr" }
615
616
617
618
	    hsc_env = HscEnv { hsc_mode = OneShot,
			       hsc_dflags = dyn_flags',
			       hsc_HPT    = emptyHomePackageTable }
			
619

620
  -- run the compiler!
621
        pcs <- initPersistentCompilerState
622
	result <- hscMain hsc_env pcs mod
623
			  location{ ml_hspp_file=Just input_fn }
624
			  source_unchanged
625
			  False
626
			  Nothing	 -- no iface
627

628
	case result of
629

630
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
631

632
633
634
            HscNoRecomp pcs details iface -> do
		SysTools.touch "Touching object file" o_file
		return (Nothing, output_fn)
635

636
	    HscRecomp _pcs _details _iface stub_h_exists stub_c_exists
637
		      _maybe_interpreted_code -> do
638

639
640
641
642
643
644
645
646
		-- deal with stubs
		maybe_stub_o <- compileStub dyn_flags' stub_c_exists
		case maybe_stub_o of
		      Nothing -> return ()
		      Just stub_o -> add v_Ld_inputs stub_o
		case hscLang dyn_flags of
                      HscNothing -> return (Nothing, output_fn)
		      _ -> return (Just next_phase, output_fn)
647
648
649
650
651
652
653

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

654
runPhase cc_phase basename suff input_fn get_output_fn
655
   | cc_phase == Cc || cc_phase == HCc
656
   = do	cc_opts <- getOpts opt_c
rrt's avatar
rrt committed
657
       	cmdline_include_paths <- readIORef v_Include_paths
658

659
660
661
	split  <- readIORef v_Split_object_files
	mangle <- readIORef v_Do_asm_mangling

662
663
        let hcc = cc_phase == HCc

664
665
666
667
668
669
	    next_phase
		| hcc && mangle     = Mangle
		| otherwise         = As

	output_fn <- get_output_fn next_phase

670
671
672
673
674
675
676
	-- HC files have the dependent packages stamped into them
	pkgs <- if hcc then getHCFilePackages input_fn else return []

	-- 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 pkgs
rrt's avatar
rrt committed
677
678
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
679

680
	mangle <- readIORef v_Do_asm_mangling
681
682
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

683
        verb <- getVerbFlag
684

685
	o2 <- readIORef v_minus_o2_for_C
686
687
688
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

689
	pkg_extra_cc_opts <- getPackageExtraCcOpts pkgs
690

691
	split_objs <- readIORef v_Split_object_files
sof's avatar
sof committed
692
693
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]
694

695
	excessPrecision <- readIORef v_Excess_precision
696
697
698
699
700
701
702
703
704

	-- force the C compiler to interpret this file as C when
	-- compiling .hc files, by adding the -x c option.
	let langopt
		| cc_phase == HCc = [ SysTools.Option "-x", SysTools.Option "c"]
		| otherwise       = [ ]

	SysTools.runCc (langopt ++
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
705
			, SysTools.Option "-o"
sof's avatar
sof committed
706
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
707
708
709
			]
		       ++ map SysTools.Option (
		          md_c_flags
710
711
712
713
714
715
		       ++ (if cc_phase == HCc && mangle
		  	     then md_regd_c_flags
		  	     else [])
		       ++ [ verb, "-S", "-Wimplicit", opt_flag ]
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
716
		       ++ split_opt
717
718
719
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
720
		       ))
721
722

	return (Just next_phase, output_fn)
723
724
725
726
727
728

	-- ToDo: postprocess the output from gcc

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

729
730
731
732
733
734
735
736
737
738
739
740
runPhase Mangle _basename _suff input_fn get_output_fn
   = 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 []

	split <- readIORef v_Split_object_files
	let next_phase
		| split = SplitMangle
		| otherwise = As
	output_fn <- get_output_fn next_phase
741

742
	SysTools.runMangle (map SysTools.Option mangler_opts
sof's avatar
sof committed
743
744
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
745
746
			     ]
			  ++ map SysTools.Option machdep_opts)
747
748

	return (Just next_phase, output_fn)
749
750
751
752

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

753
runPhase SplitMangle _basename _suff input_fn get_output_fn
754
755
756
757
  = 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
758

sof's avatar
sof committed
759
760
761
	SysTools.runSplit [ SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
762
			  ]
763
764
765
766
767
768
769
770
771

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

773
	return (Just SplitAs, "**splitmangle**")  -- we don't use the filename
774
775
776
777

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

778
runPhase As _basename _suff input_fn get_output_fn
779
  = do	as_opts		      <- getOpts opt_a
780
        cmdline_include_paths <- readIORef v_Include_paths
781

782
783
	output_fn <- get_output_fn Ln

sof's avatar
sof committed
784
785
786
	SysTools.runAs (map SysTools.Option as_opts
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
787
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
788
			  , SysTools.Option "-o"
sof's avatar
sof committed
789
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
790
			  ])
791

792
793
794
795
	return (Just Ln, output_fn)


runPhase SplitAs basename _suff _input_fn get_output_fn
796
  = do  as_opts <- getOpts opt_a
797

798
	(split_s_prefix, n) <- readIORef v_Split_info
799

800
	odir <- readIORef v_Output_dir
801
	let real_odir = case odir of
802
				Nothing -> basename ++ "_split"
803
804
				Just d  -> d

805
806
	let assemble_file n
	      = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
807
		    let output_o = replaceFilenameDirectory
808
					(basename ++ "__" ++ show n ++ ".o")
809
					 real_odir
810
		    real_o <- osuf_ify output_o
sof's avatar
sof committed
811
812
813
		    SysTools.runAs (map SysTools.Option as_opts ++
		    		    [ SysTools.Option "-c"
				    , SysTools.Option "-o"
sof's avatar
sof committed
814
815
				    , SysTools.FileOption "" real_o
				    , SysTools.FileOption "" input_s
sof's avatar
sof committed
816
				    ])
817
818
	
	mapM_ assemble_file [1..n]
819

820
821
	output_fn <- get_output_fn Ln
	return (Just Ln, output_fn)
822

rrt's avatar
rrt committed
823
824
825
826
827
#ifdef ILX
-----------------------------------------------------------------------------
-- Ilx2Il phase
-- Run ilx2il over the ILX output, getting an IL file

828
runPhase Ilx2Il _basename _suff input_fn get_output_fn
rrt's avatar
rrt committed
829
  = do	ilx2il_opts <- getOpts opt_I
rrt's avatar
rrt committed
830
831
832
833
        SysTools.runIlx2il (map SysTools.Option ilx2il_opts
                           ++ [ SysTools.Option "--no-add-suffix-to-assembly",
				SysTools.Option "mscorlib",
				SysTools.Option "-o",
sof's avatar
sof committed
834
835
				SysTools.FileOption "" output_fn,
				SysTools.FileOption "" input_fn ])
836
	return True
rrt's avatar
rrt committed
837
838
839
840
841

-----------------------------------------------------------------------------
-- Ilasm phase
-- Run ilasm over the IL, getting a DLL

842
runPhase Ilasm _basename _suff input_fn get_output_fn
rrt's avatar
rrt committed
843
  = do	ilasm_opts <- getOpts opt_i
rrt's avatar
rrt committed
844
845
846
        SysTools.runIlasm (map SysTools.Option ilasm_opts
		           ++ [ SysTools.Option "/QUIET",
				SysTools.Option "/DLL",
sof's avatar
sof committed
847
848
				SysTools.FileOption "/OUT=" output_fn,
				SysTools.FileOption "" input_fn ])
849
	return True
rrt's avatar
rrt committed
850

ross's avatar
ross committed
851
#endif /* ILX */
rrt's avatar
rrt committed
852

853
854
855
856
857
858
-----------------------------------------------------------------------------
-- 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.
859
-- This is called from staticLink below, after linking. I haven't made it
860
861
862
863
-- 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

864
runPhase_MoveBinary input_fn
865
  = do	
866
        sysMan   <- getSysMan
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
        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);"
 ]

937
938
939
940
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

checkProcessArgsResult flags basename suff
sof's avatar
sof committed
941
  = do when (notNull flags) (throwDyn (ProgramError (
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
	  showSDoc (hang (text basename <> text ('.':suff) <> char ':')
		      4 (text "unknown flags in  {-# OPTIONS #-} pragma:" <+>
			  hsep (map text flags)))
	)))

-----------------------------------------------------------------------------
-- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file

getHCFilePackages :: FilePath -> IO [PackageName]
getHCFilePackages filename =
  EXCEPTION.bracket (openFile filename ReadMode) hClose $ \h -> do
    l <- hGetLine h
    case l of
      '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
	  return (map mkPackageName (words rest))
      _other ->
	  return []
959

960
-----------------------------------------------------------------------------
961
-- Static linking, of .o files
962

963
964
965
966
967
968
969
970
971
972
973
974
-- The list of packages passed to link is the list of packages on
-- which this program depends, as discovered by the compilation
-- manager.  It is combined with the list of packages that the user
-- specifies on the command line with -package flags.  
--
-- In one-shot linking mode, we can't discover the package
-- dependencies (because we haven't actually done any compilation or
-- read any interface files), so the user must explicitly specify all
-- the packages.

staticLink :: [FilePath] -> [PackageName] -> IO ()
staticLink o_files dep_packages = do
975
976
    verb       <- getVerbFlag
    static     <- readIORef v_Static
977
978
    no_hs_main <- readIORef v_NoHsMain

979
980
981
982
    -- get the full list of packages to link with, by combining the
    -- explicit packages with the auto packages and all of their
    -- dependencies, and eliminating duplicates.

983
    o_file <- readIORef v_Output_file
984
985
    let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }

986
    pkg_lib_paths <- getPackageLibraryPath dep_packages
987
988
    let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths

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

992
    pkg_link_opts <- getPackageLinkOpts dep_packages
993

994
#ifdef darwin_TARGET_OS
995
    pkg_framework_paths <- getPackageFrameworkPath dep_packages
996
997
998
999
1000
    let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths

    framework_paths <- readIORef v_Framework_paths
    let framework_path_opts = map ("-F"++) framework_paths

1001
    pkg_frameworks <- getPackageFrameworks dep_packages
1002
    let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1003
1004

    frameworks <- readIORef v_Cmdline_frameworks
1005
    let framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1006
1007
1008
	 -- reverse because they're added in reverse order from the cmd line
#endif

1009
	-- probably _stub.o files
1010
    extra_ld_inputs <- readIORef v_Ld_inputs
1011

1012
	-- opts from -optl-<blah> (including -l<blah> options)
1013
    extra_ld_opts <- getStaticOpts v_Opt_l
1014

1015
    [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
1016

1017
1018
    let extra_os = if static || no_hs_main
                   then []
1019
1020
                   else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
                          head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
1021

1022
    (md_c_flags, _) <- machdepCCOpts
sof's avatar
sof committed
1023
1024
    SysTools.runLink ( [ SysTools.Option verb
    		       , SysTools.Option "-o"
sof's avatar
sof committed
1025
		       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
1026
1027
1028
		       ]
		      ++ map SysTools.Option (
		         md_c_flags
1029
1030
1031
1032
	 	      ++ o_files
		      ++ extra_os
		      ++ extra_ld_inputs
	 	      ++ lib_path_opts
1033
	 	      ++ extra_ld_opts
1034
1035
1036
1037
#ifdef darwin_TARGET_OS
	 	      ++ framework_path_opts
	 	      ++ framework_opts
#endif
1038
	 	      ++ pkg_lib_path_opts
1039
	 	      ++ pkg_link_opts
1040
1041
1042
1043
#ifdef darwin_TARGET_OS
	 	      ++ pkg_framework_path_opts
	 	      ++ pkg_framework_opts
#endif
sof's avatar
sof committed
1044
	              ++ if static && not no_hs_main then
1045
			    [ "-u", prefixUnderscore "Main_zdmain_closure"] 
sof's avatar
sof committed
1046
			 else []))
1047

1048
1049
    -- parallel only: move binary to another dir -- HWL
    ways_ <- readIORef v_Ways
1050
    when (WayPar `elem` ways_)
1051
	 (do success <- runPhase_MoveBinary output_fn
1052
1053
             if success then return ()
                        else throwDyn (InstallationError ("cannot move binary to PVM dir")))
1054

rrt's avatar
rrt committed
1055
-----------------------------------------------------------------------------
1056
-- Making a DLL (only for Win32)
rrt's avatar
rrt committed
1057

sof's avatar
sof committed
1058
1059
doMkDLL :: [String] -> [PackageName] -> IO ()
doMkDLL o_files dep_packages = do
1060
1061
    verb       <- getVerbFlag
    static     <- readIORef v_Static
rrt's avatar
rrt committed
1062
1063
1064
1065
1066
    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"; }

sof's avatar
sof committed
1067
    pkg_lib_paths <- getPackageLibraryPath dep_packages
rrt's avatar
rrt committed
1068
1069
1070
1071
1072
    let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths

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

sof's avatar
sof committed
1073
    pkg_link_opts <- getPackageLinkOpts dep_packages
rrt's avatar
rrt committed
1074
1075
1076
1077
1078
1079
1080

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

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

1081
    [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
1082

rrt's avatar
rrt committed
1083
1084
    let extra_os = if static || no_hs_main
                   then []
1085
1086
                   else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
                          head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
1087

rrt's avatar
rrt committed
1088
    (md_c_flags, _) <- machdepCCOpts
1089
    SysTools.runMkDLL
sof's avatar
sof committed
1090
1091
	 ([ SysTools.Option verb
	  , SysTools.Option "-o"
sof's avatar
sof committed
1092
	  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
1093
1094
1095
	  ]
	 ++ map SysTools.Option (
	    md_c_flags
rrt's avatar
rrt committed
1096
1097
1098
1099
1100
	 ++ o_files
	 ++ extra_os
	 ++ [ "--target=i386-mingw32" ]
	 ++ extra_ld_inputs
	 ++ lib_path_opts
1101
	 ++ extra_ld_opts
rrt's avatar
rrt committed
1102
	 ++ pkg_lib_path_opts
1103
	 ++ pkg_link_opts
1104
1105
1106
         ++ (if "--def" `elem` (concatMap words extra_ld_opts)
	       then [ "" ]
               else [ "--export-all" ])
sof's avatar
sof committed
1107
	))
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118

-- -----------------------------------------------------------------------------
-- Misc.

hscNextPhase :: HscLang -> IO Phase
hscNextPhase hsc_lang = do
  split <- readIORef v_Split_object_files
  return (case hsc_lang of
		HscC -> HCc
		HscAsm | split -> SplitMangle
		       | otherwise -> As
1119
1120
1121
		HscNothing     -> HCc  -- dummy (no output will be generated)
		HscInterpreted -> HCc  -- "" ""
		_other         -> HCc  -- "" ""
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
	)

hscMaybeAdjustLang :: HscLang -> IO HscLang
hscMaybeAdjustLang current_hsc_lang = do
  todo    <- readIORef v_GhcMode
  keep_hc <- readIORef v_Keep_hc_files
  let hsc_lang
	-- don't change the lang if we're interpreting
	 | current_hsc_lang == HscInterpreted = current_hsc_lang
	-- force -fvia-C if we are being asked for a .hc file
	 | todo == StopBefore HCc  || keep_hc = HscC
1133
1134
	-- force -fvia-C when profiling or ticky-ticky is on
	 | opt_SccProfilingOn || opt_DoTickyProfiling = HscC
1135
1136
1137
	-- otherwise, stick to the plan
	 | otherwise = current_hsc_lang
  return hsc_lang