[project @ 1996-12-19 09:10:02 by simonpj]
[ghc-hetmet.git] / ghc / driver / ghc.lprl
1 %
2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
3 %
4 % *** MSUB does some substitutions here ***
5 % *** grep for $( ***
6 %
7
8 This is the driver script for the Glasgow Haskell compilation system.
9 It is written in \tr{perl}.  The first section includes a long
10 ``usage'' message that describes how the driver is supposed to work.
11
12 %************************************************************************
13 %*                                                                      *
14 \section[Driver-usage]{Usage message}
15 %*                                                                      *
16 %************************************************************************
17
18 \begin{code}
19 ($Pgm = $0) =~ s|.*/||;
20 $ShortUsage  =  "\nUsage: For basic information, try the `-help' option.\n";
21 $LongUsage = "\n" . <<EOUSAGE;
22 Use of the Glorious Haskell Compilation System driver:
23
24     $Pgm [command-line-options-and-input-files]
25
26 ------------------------------------------------------------------------
27 This driver ($Pgm) guides each input file through (some of the)
28 possible phases of a compilation:
29
30     - unlit:    extract code from a "literate program"
31     - hscpp:    run code through the C pre-processor (if -cpp flag given)
32     - hsc:      run the Haskell compiler proper
33     - gcc:      run the C compiler (if compiling via C)
34     - as:       run the assembler
35     - ld:       run the linker
36
37 For each input file, the phase to START with is determined by the
38 file's suffix:
39     - .lhs      literate Haskell: unlit
40     - .hs       illiterate Haskell: hsc
41     - .hc       C from the Haskell compiler: gcc
42     - .c        C not from the Haskell compiler: gcc
43     - .s        assembly language: as
44     - other     passed directly to the linker: ld
45
46 If no files are given on the command line, input is taken from
47 standard input, and processing is as for an .hs file.  (All output is
48 to stdout or stderr, however).
49
50 The phase at which to STOP processing is determined by a command-line
51 option:
52     -C          stop after generating C (.hc output)
53     -E          stop after generating preprocessed C (.i output)
54     -S          stop after generating assembler (.s output)
55     -c          stop after generating object files (.o output)
56
57 Other commonly-used options are:
58
59     -O          An `optimising' package of compiler flags, for faster code
60
61     -prof       Compile for cost-centre profiling
62                 (add -auto for automagic cost-centres on top-level functions)
63
64     -fglasgow-exts  Allow Glasgow extensions (unboxed types, etc.)
65
66     -H14m       Increase compiler's heap size
67
68 The User's Guide has more information about GHC's *many* options.
69
70 Given the above, here are some TYPICAL invocations of $Pgm:
71
72     # compile a Haskell module to a .o file, optimising:
73     % $Pgm -c -O Foo.hs
74     # compile a Haskell module to C (a .hc file), using a bigger heap:
75     % $Pgm -C -H16m Foo.hs
76     # compile Haskell-produced C (.hc) to assembly language:
77     % $Pgm -S Foo.hc
78     # link three .o files into an executable called "test":
79     % $Pgm -o test Foo.o Bar.o Baz.o
80 ------------------------------------------------------------------------
81 EOUSAGE
82 \end{code}
83
84 %************************************************************************
85 %*                                                                      *
86 \section[Driver-init]{Initialisation}
87 %*                                                                      *
88 %************************************************************************
89
90 Establish what executables to run for the various phases (all the
91 \tr{$(FOO)} make-variables are \tr{msub}bed for from the
92 \tr{Makefile}), what the default options are for those phases, and
93 other similar boring stuff.
94 \begin{code}
95 select(STDERR); $| = 1; select(STDOUT); # no STDERR buffering, please.
96
97 $HostPlatform   = '$(HOSTPLATFORM)';
98 $TargetPlatform = '$(TARGETPLATFORM)';
99
100 #------------------------------------------------------------------------
101 # If you are adjusting paths by hand for a binary GHC distribution,
102 # de-commenting the line to set GLASGOW_HASKELL_ROOT should do.
103 # Or you can leave it as is, and set the environment variable externally.
104 #------------------------------------------------------------------------
105 # $ENV{'GLASGOW_HASKELL_ROOT'} = '/some/absolute/path/name';
106
107 if (! $ENV{'GLASGOW_HASKELL_ROOT'}) { # good -- death to environment variables
108     $TopPwd         = '$(TOP_PWD)';
109     $InstLibDirGhc  = '$(INSTLIBDIR_GHC)';
110     $InstDataDirGhc = '$(INSTDATADIR_GHC)';
111 } else {
112     $TopPwd = $ENV{'GLASGOW_HASKELL_ROOT'};
113
114     if ('$(INSTLIBDIR_GHC)' =~ /.*(\/lib\/ghc\/\d\.\d\d\/[^-]-[^-]-[^-]\/.*)/) {
115         $InstLibDirGhc  = $ENV{'GLASGOW_HASKELL_ROOT'} . $1;
116     } else {
117         print STDERR "GLASGOW_HASKELL_ROOT environment variable is set;\nBut can't untangle $(INSTLIBDIR_GHC).\n(Installation error)\n";
118         exit(1);
119     }
120
121     if ('$(INSTDATADIR_GHC)' =~ /.*(\/lib\/ghc\/\d\.\d\d\/.*)/) {
122         $InstDataDirGhc = $ENV{'GLASGOW_HASKELL_ROOT'} . $2;
123     } else {
124         print STDERR "GLASGOW_HASKELL_ROOT environment variable is set;\nBut can't untangle $(INSTDATADIR_GHC).\n(Installation error)\n";
125         exit(1);
126     }
127 }
128
129 if ( $(INSTALLING) ) {
130     $InstSysLibDir  = $InstDataDirGhc;
131     $InstSysLibDir  =~ s/\/ghc\//\/hslibs\//;
132 } else {
133     $InstSysLibDir  = "$TopPwd/hslibs";
134 }
135
136 $Status  = 0; # just used for exit() status
137 $Verbose = '';
138
139 # set up signal handler
140 sub quit_upon_signal { &tidy_up_and_die(1, ''); }
141 $SIG{'INT'}  = 'quit_upon_signal';
142 $SIG{'QUIT'} = 'quit_upon_signal';
143
144 # where to get "require"d .prl files at runtime (poor man's dynamic loading)
145 #   (use LIB, not DATA, because we can't be sure of arch-independence)
146 @INC = ( ( $(INSTALLING) ) ? $InstLibDirGhc
147                            : "$TopPwd/$(CURRENT_DIR)" );
148
149 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
150     $Tmp_prefix = ($ENV{'TMPDIR'} . "/ghc$$");
151 } else {
152     $Tmp_prefix ="$(TMPDIR)/ghc$$";
153     $ENV{'TMPDIR'} = '$(TMPDIR)'; # set the env var as well
154 }
155
156 @Files_to_tidy = (); # files we nuke in the case of abnormal termination
157
158 $Unlit = ( $(INSTALLING) ) ? "$InstLibDirGhc/unlit"
159                              : "$TopPwd/$(CURRENT_DIR)/$(GHC_UNLIT)";
160 @Unlit_flags    = ();
161
162 $Cp   = '$(CP)';
163 $Rm   = '$(RM)';
164 $Diff = '$(CONTEXT_DIFF)';
165 $Cat  = 'cat';
166 $Cmp  = 'cmp';
167 $Time = '';
168
169 $HsCpp   = # but this is re-set to "cat" (after options) if -cpp not seen
170            ( $(INSTALLING) ) ? "$InstLibDirGhc/hscpp"
171                              : "$TopPwd/$(CURRENT_DIR)/$(GHC_HSCPP)";
172 @HsCpp_flags    = ();
173 $genSPECS_flag  = '';           # See ../utils/hscpp/hscpp.prl
174
175 $HsC     = ( $(INSTALLING) ) ? "$InstLibDirGhc/hsc"
176                              : "$TopPwd/$(CURRENT_DIR)/$(GHC_HSC)";
177
178 $SysMan  = ( $(INSTALLING) ) ? "$InstLibDirGhc/SysMan"
179                              : "$TopPwd/$(CURRENT_DIR)/$(GHC_SYSMAN)";
180
181 # HsC_rts_flags: if we want to talk to the LML runtime system
182 # NB: we don't use powers-of-2 sizes, because this may do
183 #   terrible things to cache behavior.
184 $Specific_heap_size = 6 * 1000 * 1000;
185 $Specific_stk_size  = 1000 * 1000;
186 $Scale_sizes_by     = 1.0;
187 @HsC_rts_flags      = ();
188
189 @HsP_flags      = (); # these are the flags destined solely for
190                       # the flex/yacc parser
191 @HsC_flags      = ();
192 @HsC_antiflags  = ();
193 \end{code}
194
195 The optimisations/etc to be done by the compiler are {\em normally}
196 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
197
198 \begin{code}
199 $OptLevel      = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
200 $MinusO2ForC   = 0; # set to 1 if -O2 should be given to C compiler
201 $StolenX86Regs = 4; # **HACK*** of the very worst sort
202 $CoreLint      = '';
203 \end{code}
204
205 These variables represent parts of the -O/-O2/etc ``templates,''
206 which are filled in later, using these.
207 These are the default values, which may be changed by user flags.
208 \begin{code}
209 $Oopt_UnfoldingUseThreshold     = '-fsimpl-uf-use-threshold3';
210 $Oopt_MaxSimplifierIterations   = '-fmax-simplifier-iterations4';
211 $Oopt_PedanticBottoms           = '-fpedantic-bottoms'; # ON by default
212 $Oopt_MonadEtaExpansion         = '';
213 $Oopt_FinalStgProfilingMassage  = '';
214 $Oopt_StgStats                  = '';
215 $Oopt_SpecialiseUnboxed         = '';
216 $Oopt_DoSpecialise              = ''; # ToDo:LATER: '-fspecialise';
217 $Oopt_FoldrBuild                = 0; # *Off* by default!
218 $Oopt_FB_Support                = ''; # was '-fdo-arity-expand';
219 #$Oopt_FoldrBuildWW             = 0; # Off by default
220 $Oopt_FoldrBuildInline          = ''; # was '-fdo-inline-foldr-build';
221 \end{code}
222
223 Things to do with C compilers/etc:
224 \begin{code}
225 $CcRegd         = '$(GHC_OPT_HILEV_ASM)';
226 @CcBoth_flags   = ('-S');   # flags for *any* C compilation
227 @CcInjects      = ();
228
229 # GCC flags: those for all files, those only for .c files; those only for .hc files
230 @CcRegd_flags    = ('-ansi', '-D__STG_GCC_REGS__', '-D__STG_TAILJUMPS__');
231 @CcRegd_flags_c = ();
232 @CcRegd_flags_hc = ();
233
234 $As             = ''; # "assembler" is normally GCC
235 @As_flags       = ();
236
237 $Lnkr           = ''; # "linker" is normally GCC
238 @Ld_flags       = ();
239
240 # 'nm' is used for consistency checking (ToDo: mk-world-ify)
241 # ToDo: check the OS or something ("alpha" is surely not the crucial question)
242 $Nm = ($TargetPlatform =~ /^alpha-/) ? 'nm -B' : 'nm';
243 \end{code}
244
245 What options \tr{-user-setup-a} turn into (user-defined ``packages''
246 of options).  Note that a particular user-setup implies a particular
247 Prelude ({\em including} its interface file(s)).
248 \begin{code}
249 $BuildTag       = ''; # default is sequential build w/ Appel-style GC
250
251 %BuildAvail     = ('',      '$(Build_normal)',
252                    '_p',    '$(Build_p)',
253                    '_t',    '$(Build_t)',
254                    '_u',    '$(Build_u)',
255                    '_mc',   '$(Build_mc)',
256                    '_mr',   '$(Build_mr)',
257                    '_mt',   '$(Build_mt)',
258                    '_mp',   '$(Build_mp)',
259                    '_mg',   '$(Build_mg)',
260                    '_2s',   '$(Build_2s)',
261                    '_1s',   '$(Build_1s)',
262                    '_du',   '$(Build_du)',
263                    '_a',    '$(Build_a)',
264                    '_b',    '$(Build_b)',
265                    '_c',    '$(Build_c)',
266                    '_d',    '$(Build_d)',
267                    '_e',    '$(Build_e)',
268                    '_f',    '$(Build_f)',
269                    '_g',    '$(Build_g)',
270                    '_h',    '$(Build_h)',
271                    '_i',    '$(Build_i)',
272                    '_j',    '$(Build_j)',
273                    '_k',    '$(Build_k)',
274                    '_l',    '$(Build_l)',
275                    '_m',    '$(Build_m)',
276                    '_n',    '$(Build_n)',
277                    '_o',    '$(Build_o)',
278                    '_A',    '$(Build_A)',
279                    '_B',    '$(Build_B)' );
280
281 %BuildDescr     = ('',      'normal sequential',
282                    '_p',    'profiling',
283                    '_t',    'ticky-ticky profiling',
284 #OLD:              '_u',    'unregisterized (using portable C only)',
285                    '_mc',   'concurrent',
286                    '_mr',   'profiled concurrent',
287                    '_mt',   'ticky concurrent',
288                    '_mp',   'parallel',
289                    '_mg',   'GranSim',
290                    '_2s',   '2-space GC',
291                    '_1s',   '1-space GC',
292                    '_du',   'dual-mode GC',
293                    '_a',    'user way a',
294                    '_b',    'user way b',
295                    '_c',    'user way c',
296                    '_d',    'user way d',
297                    '_e',    'user way e',
298                    '_f',    'user way f',
299                    '_g',    'user way g',
300                    '_h',    'user way h',
301                    '_i',    'user way i',
302                    '_j',    'user way j',
303                    '_k',    'user way k',
304                    '_l',    'user way l',
305                    '_m',    'user way m',
306                    '_n',    'user way n',
307                    '_o',    'user way o',
308                    '_A',    'user way A',
309                    '_B',    'user way B' );
310
311 # these are options that are "fed back" through the option processing loop
312 %UserSetupOpts  = ('_a', '$(GHC_BUILD_OPTS_a)',
313                    '_b', '$(GHC_BUILD_OPTS_b)',
314                    '_c', '$(GHC_BUILD_OPTS_c)',
315                    '_d', '$(GHC_BUILD_OPTS_d)',
316                    '_e', '$(GHC_BUILD_OPTS_e)',
317                    '_f', '$(GHC_BUILD_OPTS_f)',
318                    '_g', '$(GHC_BUILD_OPTS_g)',
319                    '_h', '$(GHC_BUILD_OPTS_h)',
320                    '_i', '$(GHC_BUILD_OPTS_i)',
321                    '_j', '$(GHC_BUILD_OPTS_j)',
322                    '_k', '$(GHC_BUILD_OPTS_k)',
323                    '_l', '$(GHC_BUILD_OPTS_l)',
324                    '_m', '$(GHC_BUILD_OPTS_m)',
325                    '_n', '$(GHC_BUILD_OPTS_n)',
326                    '_o', '$(GHC_BUILD_OPTS_o)',
327                    '_A', '$(GHC_BUILD_OPTS_A)',
328                    '_B', '$(GHC_BUILD_OPTS_B)',
329
330                    # the GC ones don't have any "fed back" options
331                    '_2s', '',
332                    '_1s', '',
333                    '_du', '' );
334
335 # per-build code fragments which are eval'd
336 %EvaldSetupOpts = ('',      '', # this one must *not* be set!
337
338                             # profiled sequential
339                    '_p',    'push(@HsC_flags,  \'-fscc-profiling\');
340                              push(@CcBoth_flags, \'-DPROFILING\');',
341
342                             #and maybe ...
343                             #push(@CcBoth_flags, '-DPROFILING_DETAIL_COUNTS');
344
345                             # ticky-ticky sequential
346                    '_t',    'push(@HsC_flags, \'-fticky-ticky\');
347                              push(@CcBoth_flags, \'-DTICKY_TICKY\');',
348
349 #OLD:                       # unregisterized (ToDo????)
350 #                  '_u',    '',
351
352                             # concurrent
353                    '_mc',   '$StkChkByPageFaultOK = 0;
354                              push(@HsC_flags,  \'-fconcurrent\');
355                              push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
356                              push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');',
357
358                             # profiled concurrent
359                    '_mr',   '$StkChkByPageFaultOK = 0;
360                              push(@HsC_flags,  \'-fconcurrent\', \'-fscc-profiling\');
361                              push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
362                              push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DPROFILING\');',
363
364                             # ticky-ticky concurrent
365                    '_mt',   '$StkChkByPageFaultOK = 0;
366                              push(@HsC_flags,  \'-fconcurrent\', \'-fticky-ticky\');
367                              push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
368                              push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DTICKY_TICKY\');',
369
370                             # parallel
371                    '_mp',   '$StkChkByPageFaultOK = 0;
372                              push(@HsC_flags,  \'-fconcurrent\');
373                              push(@HsCpp_flags,\'-D__PARALLEL_HASKELL__\',   \'-DPAR\');
374                              push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DPAR\');',
375
376                             # GranSim
377                    '_mg',   '$StkChkByPageFaultOK = 0;
378                              push(@HsC_flags,  \'-fconcurrent\', \'-fgransim\');
379                              push(@HsCpp_flags,\'-D__GRANSIM__\',   \'-DGRAN\');
380                              push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DGRAN\');',
381
382                    '_2s',   'push (@CcBoth_flags, \'-DGC2s\');',
383                    '_1s',   'push (@CcBoth_flags, \'-DGC1s\');',
384                    '_du',   'push (@CcBoth_flags, \'-DGCdu\');',
385
386                    '_a',    '', # these user-way guys should not be set!
387                    '_b',    '',
388                    '_c',    '',
389                    '_d',    '',
390                    '_e',    '',
391                    '_f',    '',
392                    '_g',    '',
393                    '_h',    '',
394                    '_i',    '',
395                    '_j',    '',
396                    '_k',    '',
397                    '_l',    '',
398                    '_m',    '',
399                    '_n',    '',
400                    '_o',    '',
401                    '_A',    '',
402                    '_B',    '' );
403 \end{code}
404
405 Import/include directories (\tr{-I} options) are sufficiently weird to
406 require special handling.
407 \begin{code}
408 @Import_dir     = ('.'); #-i things
409 @Include_dir    = ('.'); #-I things; other default(s) stuck on AFTER option processing
410
411 @SysImport_dir  = ( $(INSTALLING) )
412                     ? ( "$InstDataDirGhc/imports" )
413                     : ( "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)/ghc"
414                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)/glaExts"
415                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)/required"
416                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)/concurrent" );
417
418 # We need to look in ghc/ and glaExts/ when searching for implicitly needed .hi files, but 
419 # we should really *not* look there for explicitly imported modules.
420
421 $GhcVersionInfo  = int ($(PROJECTVERSION) * 100);
422 $Haskell1Version = 3; # i.e., Haskell 1.3
423 @Cpp_define      = ();
424
425 @UserLibrary_dir= ();   #-L things;...
426 @UserLibrary    = ();   #-l things asked for by the user
427
428 @SysLibrary_dir = ( ( $(INSTALLING) )   #-syslib things supplied by the system
429                     ? $InstLibDirGhc
430                     : ( "$TopPwd/$(CURRENT_DIR)/$(GHC_RUNTIMESRC)"
431                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_RUNTIMESRC)/gmp"
432                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)"
433                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)/cbits"
434                       )
435                   );
436 @SysLibrary = (); # will be built up as we go along
437
438 $TopClosureFile # defaults to 1.2 one; will be mangled later
439         = ( $(INSTALLING) ) ? "$InstLibDirGhc/TopClosureXXXX.o"
440                             : "$TopPwd/$(CURRENT_DIR)/$(GHC_RUNTIMESRC)/main/TopClosureXXXX.o";
441 \end{code}
442
443 We are given a list of files with various presumably-known suffixes
444 (unknown-suffix files go straight to the linker).  For each file, we
445 begin by assuming that we'll run every phase over it.  However: (1)
446 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
447 past a certain point; and (2) the file's suffix tells us what phase to
448 start with.  Linking is weird and kept track of separately.
449
450 Here are the initial defaults applied to all files:
451 \begin{code}
452 $Cpp_flag_set = 0;      # (hack)
453 $Only_preprocess_C = 0; # pretty hackish
454 $PostprocessCcOutput = 0;
455
456 # native code-gen or via C?
457 $HaveNativeCodeGen = $(GhcWithNativeCodeGen);
458 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
459 $HscOut = '-S='
460     if $HaveNativeCodeGen && $TargetPlatform =~ /^(alpha|sparc)-/; #ToDo: add |i386 !
461 $ProduceHi   = '-hifile=';
462 $HiOnStdout  = 0;
463 $HiDiff_flag = '';
464
465 $CollectingGCstats = 0;
466 $CollectGhcTimings = 0;
467 $DEBUGging = '';        # -DDEBUG and all that it entails (um... not really)
468 $PROFing = '';          # set to p or e if profiling
469 $PROFgroup = '';        # set to group if an explicit -Ggroup specified
470 $PROFauto = '';         # set to relevant hsc flag if -auto or -auto-all
471 $PROFcaf  = '';         # set to relevant hsc flag if -caf-all
472 $PROFignore_scc = '';   # set to relevant parser flag if explicit sccs ignored
473 $UNPROFscc_auto = '';   # set to relevant hsc flag if forcing auto sccs without profiling
474 $TICKYing = '';         # set to t if compiling for ticky-ticky profiling
475 $PARing = '';           # set to p if compiling for PAR
476 $CONCURing = '';        # set to c if compiling for CONCURRENT
477 $GRANing = '';          # set to g if compiling for GRAN
478 $StkChkByPageFaultOK = 1; # may be set to 0 (false) for some builds
479 $Specific_output_dir = '';      # set by -odir <dir>
480 $Specific_output_file = '';     # set by -o <file>; "-" for stdout
481 $Specific_hi_file = '';         # set by -ohi <file>; "-" for stdout
482 $Specific_dump_file = '';       # set by -odump <file>; "-" for stdout
483 $Using_dump_file = 0;
484 $Isuffix    = '';
485 $Osuffix    = '';       # default: use the normal suffix for that kind of output
486 $HiSuffix   = 'hi';
487 $SysHiSuffix= 'hi';
488 $Do_recomp_chkr = 0;    # don't use the recompilatio checker unless asked
489 $Do_cc      = -1;   # a MAGIC indeterminate value; will be set to 1 or 0.
490 $Do_as      = 1;
491 $Do_lnkr    = 1;
492 $Keep_hc_file_too = 0;
493 $Keep_s_file_too = 0;
494 $UseGhcInternals = 0; # if 1, may use GHC* modules
495 $SplitObjFiles = 0;
496 $NoOfSplitFiles = 0;
497 $Dump_parser_output = 0;
498 $Dump_raw_asm = 0;
499 $Dump_asm_splitting_info = 0;
500 $NoImplicitPrelude = 0;
501
502 # and the list of files
503 @Input_file = ();
504
505 # and files to be linked...
506 @Link_file  = ();
507 \end{code}
508
509 We inject consistency-checking information into \tr{.hc} files (both
510 when created by the Haskell compiler and when compiled by the C
511 compiler), so that we can check that an executable is made from
512 consistently-built pieces.  (The check is normally done just after
513 linking.)  The checking is done by introducing/munging
514 \tr{what(1)}-style strings.  Anyway, here are the relevant global
515 variables and their defaults:
516 \begin{code}
517 $LinkChk = 1;   # set to 0 if the link check should *not* be done
518
519 # major & minor version numbers; major numbers must always agree;
520 # minor disagreements yield a warning.
521 $HsC_major_version = 30;
522 $HsC_minor_version = 0;
523 $Cc_major_version  = 35;
524 $Cc_minor_version  = 0;
525
526 # options: these must always agree
527 $HsC_consist_options = '';    # we record, in this order:
528                               #     Build tag; debugging?
529 $Cc_consist_options  = '';    # we record, in this order:
530                               #     Build tag; debugging?
531 \end{code}
532
533 %************************************************************************
534 %*                                                                      *
535 \section[Driver-parse-argv]{Munge the command-line options}
536 %*                                                                      *
537 %************************************************************************
538
539 Now slurp through the arguments.
540 \begin{code}
541
542 #---------- user defined prelude ---------------------------------------
543
544 if (grep(/^-user-prelude$/, @ARGV)) {
545
546     # If ARGV contains -user-prelude we are compiling a piece of 
547     # prelude for the user, probably with additional specialise pragmas
548
549     # We strip out the -O -f and -user-prelude flags provided on
550     # the command line and add the ones used to compile the prelude
551     # ToDo: get these options from a common definition in mkworld
552
553     # We also enable any options forced through with -user-prelude-force
554
555     # Hey, Check out this grep statement ;-)  (PS)
556
557     @ARGV = grep((!/^-O/ && !/^-f/ && !/^-user-prelude$/) || s/^-user-prelude-force//,
558                  @ARGV);
559
560     unshift(@ARGV,
561         '-fcompiling-ghc-internals=???', # ToDo!!!!
562         '-O',
563         '-fshow-pragma-name-errs',
564         '-fshow-import-specs',
565         '-fglasgow-exts',
566         '-genSPECS',
567         '-DUSE_FOLDR_BUILD',
568         '-dcore-lint');
569
570     print STDERR "ghc: -user-prelude options:\n", "@ARGV", "\n";
571 }
572
573 # can't use getopt(s); what we want is too complicated
574 arg: while($_ = $ARGV[0]) {
575     shift(@ARGV);
576
577     #---------- help -------------------------------------------------------
578     if (/^-\?$/ || /^-help$/) { print $LongUsage; exit $Status; }
579
580     #---------- verbosity and such -----------------------------------------
581     /^-v$/          && do { $Verbose = '-v'; $Time = 'time'; next arg; };
582
583     #---------- what phases are to be run ----------------------------------
584     /^-recomp/      && do { $Do_recomp_chkr = 1; next arg; };
585
586     /^-cpp$/        && do { $Cpp_flag_set = 1; next arg; };
587     # change the global default:
588     # we won't run cat; we'll run the real thing
589         
590     /^-C$/          && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
591                             next arg; };
592     # stop after generating C
593         
594     /^-noC$/        && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
595                             $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
596                             next arg; };
597     # leave out actual C generation (debugging) [also turns off interface gen]
598
599     /^-hi$/         && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
600     # _do_ generate an interface; usually used as: -noC -hi
601
602     /^-nohi$/       && do { $ProduceHi = '-nohifile='; next arg; };
603     # don't generate an interface (even if generating C)
604
605     /^-hi-diffs$/ &&             do { $HiDiff_flag = 'normal'; next arg; };
606     /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
607     /^-no-hi-diffs$/ &&          do { $HiDiff_flag = '';       next arg; };
608     # show/disable diffs if the interface file changes
609
610     /^-E$/          && do { push(@CcBoth_flags, '-E');
611                             $Only_preprocess_C = 1;
612                             $Do_as = 0; $Do_lnkr = 0; next arg; };
613     # stop after preprocessing C
614
615     /^-S$/          && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
616     # stop after generating assembler
617         
618     /^-c$/          && do { $Do_lnkr = 0; next arg; };
619     # stop after generating .o files
620         
621     /^-link-chk$/    && do { $LinkChk = 1; next arg; };
622     /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
623     # don't do consistency-checking after a link
624
625     /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg('-tmpdir', '');
626                         $Tmp_prefix = "$Tmp_prefix/ghc$$";
627                         $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
628                         next arg; };
629     # use an alternate directory for temp files
630
631     #---------- redirect output --------------------------------------------
632
633     # -o <file>; applies to the last phase, whatever it is
634     # "-o -" sends it to stdout
635     # if <file> has a directory component, that dir must already exist
636
637     /^-odir$/       && do { $Specific_output_dir = &grab_arg_arg('-odir', '');
638                             if (! -d $Specific_output_dir) {
639                                 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
640                                 $Status++;
641                             }
642                             next arg; };
643
644     /^-o$/          && do { $Specific_output_file = &grab_arg_arg('-o', '');
645                             if ($Specific_output_file ne '-'
646                              && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
647                                 local($dir_part) = $1;
648                                 if (! -d $dir_part) {
649                                     print STDERR "$Pgm: no such directory: $dir_part\n";
650                                     $Status++;
651                                 }
652                             }
653                             next arg; };
654
655     # NB: -isuf not documented yet (because it doesn't work yet)
656     /^-isuf$/       && do { $Isuffix  = &grab_arg_arg('-isuf', '');
657                             if ($Isuffix =~ /\./ ) {
658                                 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
659                                 $Status++;
660                             }
661                             next arg; };
662
663     /^-osuf$/       && do { $Osuffix  = &grab_arg_arg('-osuf', '');
664                             if ($Osuffix =~ /\./ ) {
665                                 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
666                                 $Status++;
667                             }
668                             next arg; };
669
670     # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
671     /^-ohi$/        && do { $Specific_hi_file = &grab_arg_arg('-ohi', '');
672                             if ($Specific_hi_file ne '-'
673                              && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
674                                 local($dir_part) = $1;
675                                 if (! -d $dir_part) {
676                                     print STDERR "$Pgm: no such directory: $dir_part\n";
677                                     $Status++;
678                                 }
679                             }
680                             next arg; };
681
682     /^-hisuf$/      && do { $HiSuffix = &grab_arg_arg('-hisuf', '');
683                             if ($HiSuffix =~ /\./ ) {
684                                 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
685                                 $Status++;
686                             }
687                             next arg; };
688     /^-hisuf-prelude$/ && do { # as esoteric as they come...
689                             $SysHiSuffix = &grab_arg_arg('-hisuf-prelude', '');
690                             if ($SysHiSuffix =~ /\./ ) {
691                                 print STDERR "$Pgm: -hisuf-prelude suffix shouldn't contain a .\n";
692                                 $Status++;
693                             }
694                             next arg; };
695
696     /^-odump$/      && do { $Specific_dump_file = &grab_arg_arg('-odump', '');
697                             if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
698                                 local($dir_part) = $1;
699                                 if (! -d $dir_part) {
700                                     print STDERR "$Pgm: no such directory: $dir_part\n";
701                                     $Status++;
702                                 }
703                             }
704                             next arg; };
705
706     #-------------- scc & Profiling Stuff ----------------------------------
707
708     /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
709
710     /^-auto/ && do {
711                 # generate auto SCCs on top level bindings
712                 # -auto-all = all top level bindings
713                 # -auto     = only top level exported bindings
714                 $PROFauto = ( /-all/ )
715                             ? '-fauto-sccs-on-all-toplevs'
716                             : '-fauto-sccs-on-exported-toplevs';
717                 next arg; };
718
719     /^-caf-all/ && do { # generate individual CAF SCC annotations
720                 $PROFcaf = '-fauto-sccs-on-individual-cafs';
721                 next arg; };
722
723     /^-ignore-scc$/ && do {
724                 # forces ignore of scc annotations even if profiling
725                 $PROFignore_scc = '-W';
726                 next arg; };
727
728     /^-G(.*)$/  && do { push(@HsC_flags, "-G=$1");   # set group for cost centres
729                         next arg; };
730
731     /^-unprof-scc-auto/ && do {
732                 # generate auto SCCs on top level bindings when not profiling
733                 # used to measure optimisation effects of presence of sccs
734                 $UNPROFscc_auto = ( /-all/ )
735                             ? '-fauto-sccs-on-all-toplevs'
736                             : '-fauto-sccs-on-exported-toplevs';
737                 next arg; };
738
739     #--------- ticky/concurrent/parallel -----------------------------------
740     # we sort out the details a bit later on
741
742     /^-concurrent$/ && do { $CONCURing = 'c'; next arg; }; # concurrent Haskell
743     /^-gransim$/    && do { $GRANing   = 'g'; next arg; }; # GranSim
744     /^-ticky$/      && do { $TICKYing  = 't'; next arg; }; # ticky-ticky
745     /^-parallel$/   && do { $PARing    = 'p'; next arg; } ; # parallel Haskell
746
747     #-------------- "user ways" --------------------------------------------
748
749     (/^-user-setup-([a-oA-Z])$/
750     || /^$(GHC_BUILD_FLAG_a)$/
751     || /^$(GHC_BUILD_FLAG_b)$/
752     || /^$(GHC_BUILD_FLAG_c)$/
753     || /^$(GHC_BUILD_FLAG_d)$/
754     || /^$(GHC_BUILD_FLAG_e)$/
755     || /^$(GHC_BUILD_FLAG_f)$/
756     || /^$(GHC_BUILD_FLAG_g)$/
757     || /^$(GHC_BUILD_FLAG_h)$/
758     || /^$(GHC_BUILD_FLAG_i)$/
759     || /^$(GHC_BUILD_FLAG_j)$/
760     || /^$(GHC_BUILD_FLAG_k)$/
761     || /^$(GHC_BUILD_FLAG_l)$/
762     || /^$(GHC_BUILD_FLAG_m)$/
763     || /^$(GHC_BUILD_FLAG_n)$/
764     || /^$(GHC_BUILD_FLAG_o)$/
765     || /^$(GHC_BUILD_FLAG_A)$/
766     || /^$(GHC_BUILD_FLAG_B)$/
767
768     || /^$(GHC_BUILD_FLAG_2s)$/ # GC ones...
769     || /^$(GHC_BUILD_FLAG_1s)$/
770     || /^$(GHC_BUILD_FLAG_du)$/
771     ) && do {
772                 /^-user-setup-([a-oA-Z])$/  && do { $BuildTag = "_$1"; };
773
774                 /^$(GHC_BUILD_FLAG_a)$/  && do { $BuildTag = '_a';  };
775                 /^$(GHC_BUILD_FLAG_b)$/  && do { $BuildTag = '_b';  };
776                 /^$(GHC_BUILD_FLAG_c)$/  && do { $BuildTag = '_c';  };
777                 /^$(GHC_BUILD_FLAG_d)$/  && do { $BuildTag = '_d';  };
778                 /^$(GHC_BUILD_FLAG_e)$/  && do { $BuildTag = '_e';  };
779                 /^$(GHC_BUILD_FLAG_f)$/  && do { $BuildTag = '_f';  };
780                 /^$(GHC_BUILD_FLAG_g)$/  && do { $BuildTag = '_g';  };
781                 /^$(GHC_BUILD_FLAG_h)$/  && do { $BuildTag = '_h';  };
782                 /^$(GHC_BUILD_FLAG_i)$/  && do { $BuildTag = '_i';  };
783                 /^$(GHC_BUILD_FLAG_j)$/  && do { $BuildTag = '_j';  };
784                 /^$(GHC_BUILD_FLAG_k)$/  && do { $BuildTag = '_k';  };
785                 /^$(GHC_BUILD_FLAG_l)$/  && do { $BuildTag = '_l';  };
786                 /^$(GHC_BUILD_FLAG_m)$/  && do { $BuildTag = '_m';  };
787                 /^$(GHC_BUILD_FLAG_n)$/  && do { $BuildTag = '_n';  };
788                 /^$(GHC_BUILD_FLAG_o)$/  && do { $BuildTag = '_o';  };
789                 /^$(GHC_BUILD_FLAG_A)$/  && do { $BuildTag = '_A';  };
790                 /^$(GHC_BUILD_FLAG_B)$/  && do { $BuildTag = '_B';  };
791
792                 /^$(GHC_BUILD_FLAG_2s)$/ && do { $BuildTag = '_2s'; };
793                 /^$(GHC_BUILD_FLAG_1s)$/ && do { $BuildTag = '_1s'; };
794                 /^$(GHC_BUILD_FLAG_du)$/ && do { $BuildTag = '_du'; };
795
796                 local($stuff) = $UserSetupOpts{$BuildTag};
797                 local(@opts)  = split(/\s+/, $stuff);
798                 
799                 # feed relevant ops into the arg-processing loop (if any)
800                 unshift(@ARGV, @opts) if $#opts >= 0;
801
802                 next arg; };
803
804     #---------- set search paths for libraries and things ------------------
805
806     # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
807     # prepends the items to the list); -I is for including C .h files.
808
809     /^-i$/          && do { @Import_dir = ();  # import path cleared!
810                             @SysImport_dir = ();
811                             print STDERR "WARNING: import paths cleared by `-i'\n";
812                             next arg; };
813
814     /^-i(.*)/       && do { local(@new_items)
815                               = split( /:/, &grab_arg_arg('-i', $1));
816                             unshift(@Import_dir, @new_items);
817                             next arg; };
818
819     /^-I(.*)/       && do { push(@Include_dir,     &grab_arg_arg('-I', $1)); next arg; };
820     /^-L(.*)/       && do { push(@UserLibrary_dir, &grab_arg_arg('-L', $1)); next arg; };
821     /^-l(.*)/       && do { push(@UserLibrary,'-l'.&grab_arg_arg('-l', $1)); next arg; };
822
823     /^-syslib(.*)/  && do { local($syslib) = &grab_arg_arg('-syslib',$1);
824                             print STDERR "$Pgm: no such system library (-syslib): $syslib\n",
825                               $Status++ unless $syslib =~ /^(hbc|ghc|posix|contrib)$/;
826
827                             unshift(@SysImport_dir,
828                                 $(INSTALLING)
829                                 ? "$InstSysLibDir/$syslib/imports"
830                                 : "$TopPwd/hslibs/$syslib/src");
831
832                             if ( $(INSTALLING) ) {
833                                 push(@SysLibrary_dir,
834                                         ("$InstSysLibDir/$TargetPlatform"));
835                             } else {
836                                 push(@SysLibrary_dir,
837                                         ("$TopPwd/hslibs/$syslib"
838                                         ,"$TopPwd/hslibs/$syslib/cbits"));
839                             }
840
841                             push(@SysLibrary, "-lHS$syslib");
842                             push(@SysLibrary, "-lHS${syslib}_cbits")
843                               unless $syslib eq 'contrib'; #HACK! it has no cbits
844
845                             next arg; };
846
847     #=======================================================================
848     # various flags that we can harmlessly send to one program or another
849     # (we will later "reclaim" some of the compiler ones now sent to gcc)
850     #=======================================================================
851
852     #---------- this driver itself (ghc) -----------------------------------
853     # these change what executable is run for each phase:
854     /^-pgmL(.*)$/   && do { $Unlit   = $1; next arg; };
855     /^-pgmP(.*)$/   && do { $HsCpp   = $1; next arg; };
856     /^-pgmC(.*)$/   && do { $HsC     = $1; next arg; };
857     /^-pgmcO?(.*)$/ && do { $CcRegd  = $1; next arg; }; # the O? for back compat
858     /^-pgma(.*)$/   && do { $As      = $1; next arg; };
859     /^-pgml(.*)$/   && do { $Lnkr    = $1; next arg; };
860
861     #---------- the get-anything-through opts (all pgms) -------------------
862     # these allow arbitrary option-strings to go to any phase:
863     /^-optL(.*)$/   && do { push(@Unlit_flags,   $1); next arg; };
864     /^-optP(.*)$/   && do { push(@HsCpp_flags,   $1); next arg; };
865     /^-optCrts(.*)$/&& do { push(@HsC_rts_flags, $1); next arg; };
866     /^-optC(.*)$/   && do { push(@HsC_flags,     $1); next arg; };
867     /^-optc(.*)$/   && do { push(@CcBoth_flags,  $1); next arg; };
868     /^-opta(.*)$/   && do { push(@As_flags,      $1); next arg; };
869     /^-optl(.*)$/   && do { push(@Ld_flags,      $1); next arg; };
870
871     #---------- Haskell C pre-processor (hscpp) ----------------------------
872     /^-D(.*)/       && do { push(@HsCpp_flags, "'-D".&grab_arg_arg('-D',$1)."'"); next arg; };
873     /^-U(.*)/       && do { push(@HsCpp_flags, "'-U".&grab_arg_arg('-U',$1)."'"); next arg; };
874
875     /^-genSPECS/   && do { $Cpp_flag_set = 1;
876                            $genSPECS_flag = $_;
877                             next arg; };
878
879     #---------- post-Haskell "assembler"------------------------------------
880     /^-ddump-raw-asm$/            && do { $Dump_raw_asm        = 1; next arg; };
881     /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
882
883     #---------- Haskell compiler (hsc) -------------------------------------
884
885     /^-keep-hc-files?-too$/     && do { $Keep_hc_file_too = 1; next arg; };
886     /^-keep-s-files?-too$/      && do { $Keep_s_file_too = 1;  next arg; };
887
888     /^-fhaskell-1\.3$/          && do { next arg; }; # a no-op right now
889
890     /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
891
892     /^-fno-implicit-prelude$/      && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
893
894     # ToDo: rename to -fcompiling-ghc-internals=<module>
895     # NB: not documented
896     /^-fcompiling-ghc-internals(.*)/    && do { local($m) = &grab_arg_arg('-fcompiling-ghc-internals',$1);
897                                         push(@HsC_flags, "-fcompiling-ghc-internals=$m");
898                                         next arg; };
899
900     # NB: not really put to use and not documented
901     /^-fusing-ghc-internals$/ && do { $UsingGhcInternals = 1; next arg; };
902
903     /^-user-prelude-force/      && do { # ignore if not -user-prelude
904                                         next arg; };
905
906     /^-split-objs/      && do {
907                         if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|sparc)-/ ) {
908                             $SplitObjFiles = 0;
909                             print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
910                         } else {
911                             $SplitObjFiles = 1;
912                             $HscOut = '-C=';
913
914                             push(@HsC_flags, "-fglobalise-toplev-names"); 
915                             push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
916
917                             require('ghc-split.prl')
918                              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
919                         }
920                         next arg; };
921
922     /^-fglasgow-exts$/
923                 && do { push(@HsC_flags, $_);
924                         push(@HsP_flags, '-N');
925
926 #                       push(@HsC_flags, '-fshow-import-specs');
927
928                         next arg; };
929
930     /^-fspeciali[sz]e-unboxed$/
931                 && do { $Oopt_DoSpecialise      = '-fspecialise';
932                         $Oopt_SpecialiseUnboxed = '-fspecialise-unboxed';
933                         next arg; };
934     /^-fspeciali[sz]e$/
935                 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
936     /^-fno-speciali[sz]e$/
937                 && do { $Oopt_DoSpecialise = ''; next arg; };
938
939
940 # Now the foldr/build options, which are *on* by default (for -O).
941
942     /^-ffoldr-build$/
943                     && do { $Oopt_FoldrBuild = 1; 
944                             $Oopt_FB_Support = '-fdo-arity-expand';
945                             #print "Yes F/B\n";
946                             next arg; };
947
948     /^-fno-foldr-build$/
949                     && do { $Oopt_FoldrBuild = 0; 
950                             $Oopt_FB_Support = ''; 
951                             next arg; };
952
953     /^-fno-foldr-build-rule$/
954                     && do { $Oopt_FoldrBuild = 0; 
955                             next arg; };
956
957     /^-fno-enable-tech$/
958                     && do { $Oopt_FB_Support = ''; 
959                             next arg; };
960
961     /^-fno-snapback-to-append$/
962                     && do { $Oopt_FoldrBuildInline .= ' -fdo-not-fold-back-append '; 
963                             #print "No Foldback of append\n";
964                             next arg; };
965
966     # ---------------
967
968     /^-fasm-(.*)$/  && do { $HscOut = '-S='; next arg; }; # force using nativeGen
969     /^-fvia-C$/     && do { $HscOut = '-C='; next arg; }; # force using C compiler
970
971     # ---------------
972
973     /^(-fsimpl-uf-use-threshold)(.*)$/
974                     && do { $Oopt_UnfoldingUseThreshold = $1 . &grab_arg_arg($1, $2);
975                             next arg; };
976
977     /^(-fmax-simplifier-iterations)(.*)$/
978                     && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg($1, $2);
979                             next arg; };
980
981     /^-fno-pedantic-bottoms$/
982                     && do { $Oopt_PedanticBottoms = ''; next arg; };
983
984     /^-fdo-monad-eta-expansion$/
985                     && do { $Oopt_MonadEtaExpansion = $_; next arg; };
986
987     /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
988                     && do { push(@HsC_flags, $_); next arg; };
989
990     /^(-freturn-in-regs-threshold)(.*)$/
991                     && do { local($what) = $1;
992                             local($num)  = &grab_arg_arg($what, $2);
993                             if ($num < 2 || $num > 8) {
994                                 die "Bad experimental flag: $_\n";
995                             } else {
996                                 $HscOut = '-C='; # force using C compiler
997                                 push(@HsC_flags, "$what$num");
998                                 push(@CcRegd_flags, "-D__STG_REGS_AVAIL__=$num");
999                             }
1000                             next arg; };
1001
1002     # ---------------
1003
1004     /^-fno-(.*)$/   && do { push(@HsC_antiflags, "-f$1");
1005                             &squashHscFlag("-f$1");
1006                             next arg; };
1007
1008     /^-f(show-import-specs)/
1009                     && do { push(@HsC_flags, $_); next arg; };
1010
1011     # ---------------
1012
1013     /^-mlong-calls$/ && do { # for GCC for HP-PA boxes
1014                             unshift(@CcBoth_flags, ( $_ ));
1015                             next arg; };
1016
1017     /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
1018                      && do { # for GCC for SPARCs
1019                             unshift(@CcBoth_flags, ( $_ ));
1020                             next arg; };
1021
1022     /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
1023                             $StolenX86Regs = $1;
1024                             next arg; };
1025
1026     #*************** ... and lots of debugging ones (form: -d* )
1027
1028     # -d(no-)core-lint is done this way so it is turn-off-able.
1029     /^-dcore-lint/       && do { $CoreLint = '-dcore-lint'; next arg; };
1030     /^-dno-core-lint/    && do { $CoreLint = '';            next arg; };
1031
1032     /^-d(dump|ppr)-/         && do { push(@HsC_flags, $_); next arg; };
1033     /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
1034     /^-dshow-passes/         && do { push(@HsC_flags, $_); next arg; };
1035     /^-dshow-rn-trace/       && do { push(@HsC_flags, $_); next arg; };
1036     /^-dsource-stats/        && do { push(@HsC_flags, $_); next arg; };
1037     /^-dsimplifier-stats/    && do { push(@HsC_flags, $_); next arg; };
1038     /^-dstg-stats/           && do { $Oopt_StgStats = $_; next arg; };
1039
1040     #*************** ... and now all these -R* ones for its runtime system...
1041
1042     /^-Rscale-sizes?(.*)/ && do {
1043         $Scale_sizes_by = &grab_arg_arg('-Rscale-sizes', $1);
1044         next arg; };
1045
1046     /^(-H|-Rmax-heapsize)(.*)/ && do {
1047         local($heap_size) = &grab_arg_arg($1, $2);
1048         if ($heap_size =~ /(\d+)[Kk]$/) {
1049             $heap_size = $1 * 1000;
1050         } elsif ($heap_size =~ /(\d+)[Mm]$/) {
1051             $heap_size = $1 * 1000 * 1000;
1052         } elsif ($heap_size =~ /(\d+)[Gg]$/) {
1053             $heap_size = $1 * 1000 * 1000 * 1000;
1054         }
1055         if ($heap_size <= 0) {
1056             print STDERR "$Pgm: resetting heap-size to zero!!!\n";
1057             $Specific_heap_size = 0;
1058         
1059         # if several heap sizes given, take the largest...
1060         } elsif ($heap_size >= $Specific_heap_size) {
1061             $Specific_heap_size = $heap_size;
1062         } else {
1063             print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
1064         }
1065         next arg; };
1066
1067     /^-(K|Rmax-(stk|stack)size)(.*)/ && do {
1068         local($stk_size) = &grab_arg_arg('-Rmax-stksize', $3);
1069         if ($stk_size =~ /(\d+)[Kk]$/) {
1070             $stk_size = $1 * 1000;
1071         } elsif ($stk_size =~ /(\d+)[Mm]$/) {
1072             $stk_size = $1 * 1000 * 1000;
1073         } elsif ($stk_size =~ /(\d+)[Gg]$/) {
1074             $stk_size = $1 * 1000 * 1000 * 1000;
1075         }
1076         if ($stk_size <= 0) {
1077             print STDERR "$Pgm: resetting stack-size to zero!!!\n";
1078             $Specific_stk_size = 0;
1079
1080         # if several stack sizes given, take the largest...
1081         } elsif ($stk_size >= $Specific_stk_size) {
1082             $Specific_stk_size = $stk_size;
1083         } else {
1084             print STDERR "$Pgm: ignoring stack-size-setting option (-Rmax-stksize $stk_size)...not the largest seen\n";
1085         }
1086         next arg; };
1087
1088     /^-Rgc-stats$/ && do {  $CollectingGCstats++;
1089                             # the two RTSs do this diff ways; we will try to compensate
1090                             next arg; };
1091
1092     /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
1093
1094     #---------- C high-level assembler (gcc) -------------------------------
1095     /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
1096
1097     # -dgcc-lint is a useful way of making GCC very fussy.
1098     # From alan@spri.levels.unisa.edu.au (Alan Modra).
1099     /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
1100     # An alternate set, from mark@sgcs.com (Mark W. Snitily)
1101     # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
1102
1103     # inject "#include <wurble>" into the compiler's C output!
1104
1105     /^-#include(.*)/    && do {
1106         local($to_include) = &grab_arg_arg('-#include', $1);
1107         push(@CcInjects, "#include $to_include\n");
1108         next arg; };
1109
1110     #---------- Linker (gcc, really) ---------------------------------------
1111
1112     /^-static$/         && do { push(@Ld_flags, $_); next arg; };
1113
1114     #---------- mixed cc and linker magic ----------------------------------
1115     # this optimisation stuff is finally sorted out later on...
1116
1117     /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
1118
1119     /^-O[1-2]?$/ && do {
1120 #               print STDERR "$Pgm: NOTE: this version of GHC doesn't support -O or -O2\n";
1121                 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
1122                 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
1123
1124                 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
1125                 next arg; };
1126
1127     /^-Onot$/   && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
1128
1129     /^-Ofile(.*)/ && do {
1130                 $OptLevel = 3;
1131                 local($ofile) = &grab_arg_arg('-Ofile', $1);
1132                 @HsC_minusO3_flags = ();
1133
1134                 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
1135                 while (<OFILE>) {
1136                     chop;
1137                     s/\#.*//;       # death to comments
1138                     s/[ \t]+//g;    # death to whitespace
1139                     next if /^$/;   # ditto, blank lines
1140                     s/([()*{}])/\\$1/g;    # protect shell metacharacters
1141                     if ( /^C:(.*)/ ) {
1142                         push(@CcBoth_flags, $1);
1143                     } else {
1144                         push(@HsC_minusO3_flags, $_);
1145                     }
1146                 }
1147                 close(OFILE);
1148                 next arg; };
1149
1150     /^-debug$/  && do { # all this does is mark a .hc/.o as "debugging"
1151                         # in the consistency info
1152                         $DEBUGging = 'd';
1153                         next arg; };
1154
1155     #---------- linking .a file --------------------------------------------
1156
1157     /^-Main(.*)/ && do {
1158                 # specifies main or mainPrimIO to be linked
1159                 $Ld_main = $1;
1160                 next arg; }; 
1161
1162     #---------- catch unrecognized flags -----------------------------------
1163
1164     /^-./ && do {
1165         print STDERR "$Pgm: unrecognised option: $_\n";
1166         $Status++;
1167         next arg; };
1168
1169     #---------- anything else is considered an input file ------------------
1170     # (well, .o and .a files are immediately queued up as linker fodder..)
1171     if (/\.[oa]$/) {
1172         push(@Link_file, $_);
1173     } else {
1174         push(@Input_file, $_);
1175     }
1176
1177     # input files must exist:
1178     if (! -f $_) {
1179         print STDERR "$Pgm: input file doesn't exist: $_\n";
1180         $Status++;
1181     }
1182 }
1183
1184 # if there are several input files,
1185 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
1186 # (except if linking, of course)
1187
1188 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
1189     if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
1190       || ($Specific_hi_file ne ''     && $Specific_hi_file ne '-') ) {
1191         print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
1192         print STDERR "\tPerhaps the -odir option will do what you want.\n";
1193         $Status++;
1194     }
1195 }
1196
1197 # check for various pathological -o and -odir combinations...
1198 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
1199     if ($Specific_output_file eq '-') {
1200         print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
1201         $Status++;
1202     } else { # amalgamate...
1203         $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
1204         # ToDo: check we haven't got a junk name now...
1205         $Specific_output_dir  = ''; # reset
1206     }
1207 }
1208
1209 # PROFILING stuff after argv mangling:
1210 if ( ! $PROFing ) {
1211     # warn about any scc exprs found (in case scc used as identifier)
1212     push(@HsP_flags, '-W');
1213
1214     # add -auto sccs even if not profiling !
1215     push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
1216
1217 } else {
1218     push(@HsC_flags, $PROFauto) if $PROFauto;
1219     push(@HsC_flags, $PROFcaf)  if $PROFcaf;
1220     #push(@HsC_flags, $PROFdict) if $PROFdict;
1221
1222     $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
1223
1224     push(@HsP_flags, (($PROFignore_scc) ? $PROFignore_scc : '-S'));
1225
1226     if ( $SplitObjFiles ) {
1227         # can't split with cost centres -- would need global and externs
1228         print STDERR "$Pgm: WARNING: splitting objects when profiling will *BREAK* if any _scc_s are present!\n";
1229         # (but it's fine if there aren't any _scc_s around...)
1230 #       $SplitObjFiles = 0; # unset
1231         #not an error: for now: $Status++;
1232     }
1233 }
1234
1235 # crash and burn if there were errors
1236 if ( $Status > 0 ) {
1237     print STDERR $ShortUsage;
1238     exit $Status;
1239 }
1240 \end{code}
1241
1242 %************************************************************************
1243 %*                                                                      *
1244 \section[Driver-post-argv-mangling]{Setup after reading options}
1245 %*                                                                      *
1246 %************************************************************************
1247
1248 %************************************************************************
1249 %*                                                                      *
1250 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
1251 %*                                                                      *
1252 %************************************************************************
1253
1254 We come now to the default ``wads of options'' that are turned on by
1255 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
1256 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
1257 more important).
1258
1259 The user can also specify his/her own list of options in a file; in
1260 that case, the work is already done (see stuff about @minusO3@,
1261 earlier...).
1262
1263 GHC allows very precise control of what happens during a compilation.
1264 Core-to-Core and STG-to-STG passes can be run in any order, as many
1265 times as you like.  Individual transformations can be turned on or
1266 disabled.
1267
1268 Sadly, however, there are some interdependencies \& Things You Must
1269 Not Do.  Here is the list.
1270
1271 CORE-TO-CORE PASSES:
1272 \begin{description}
1273 \item[\tr{-fspecialise}:]
1274 The specialiser must have dependency-analysed input; but if you run
1275 the simplifier to do this, you must not let it toss away unused
1276 bindings!  (The typechecker conveys some specialisation info via
1277 ``unused'' bindings...)
1278
1279 \item[\tr{-ffloat-inwards}:]
1280 Floating inwards should be done before strictness analysis, because
1281 the latter will give better results.
1282
1283 \item[\tr{-fstatic-args}:]
1284 The static-arguments-transformation pass {\em must} have the
1285 simplifier run right after it.
1286
1287 \item[\tr{-fcalc-inlinings[12]}:]
1288 Not required, but there may be slight gains by re-simplifying after
1289 this is done.  (You could then \tr{-fcalc-inlinings} again, just for
1290 fun.)
1291
1292 \item[\tr{-ffull-laziness}:]
1293 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
1294 that's run.  (Um, well, howzabout the simplifier just once more...)
1295 \end{description}
1296
1297 STG-TO-STG PASSES:
1298 \begin{description}
1299 \item[\tr{-fupdate-analysis}:]
1300 It really really wants to be the last STG-to-STG pass that is run.
1301 \end{description}
1302
1303 \begin{code}
1304 @HsC_minusNoO_flags
1305   = (   '-fsimplify',
1306           '\(',
1307           $Oopt_FB_Support,
1308 #         '-falways-float-lets-from-lets',      # no idea why this was here (WDP 95/09)
1309           '-ffloat-lets-exposing-whnf',
1310           '-ffloat-primops-ok',
1311           '-fcase-of-case',
1312 #         '-fdo-lambda-eta-expansion',  # too complicated
1313           '-freuse-con',
1314 #         '-flet-to-case',      # no strictness analysis, so...
1315           $Oopt_PedanticBottoms,
1316 #         $Oopt_MonadEtaExpansion,      # no thanks
1317           '-fsimpl-uf-use-threshold0',
1318           '-fessential-unfoldings-only',
1319 #         $Oopt_UnfoldingUseThreshold,  # no thanks
1320           $Oopt_MaxSimplifierIterations,
1321           '\)',
1322         $Oopt_AddAutoSccs,
1323 #       '-ffull-laziness',      # removed 95/04 WDP following Andr\'e's lead
1324         
1325         $Oopt_FinalStgProfilingMassage
1326     );
1327
1328 @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
1329   = (
1330         # initial simplify: mk specialiser happy: minimum effort please
1331         '-fsimplify',
1332           '\(', 
1333           $Oopt_FB_Support,
1334           '-fkeep-spec-pragma-ids',     # required before specialisation
1335           '-fsimpl-uf-use-threshold0',
1336           '-fessential-unfoldings-only',
1337           '-fmax-simplifier-iterations1',
1338           $Oopt_PedanticBottoms,
1339           '\)',
1340
1341         ($Oopt_DoSpecialise) ? (
1342           '-fspecialise-overloaded',
1343           $Oopt_SpecialiseUnboxed,
1344           $Oopt_DoSpecialise,
1345         ) : (),
1346
1347         '-fsimplify',                   # need dependency anal after specialiser ...
1348           '\(',                         # need tossing before calc-inlinings ...
1349           $Oopt_FB_Support,
1350           '-ffloat-lets-exposing-whnf',
1351           '-ffloat-primops-ok',
1352           '-fcase-of-case',
1353           '-fdo-case-elim',
1354           '-fcase-merge',
1355           '-fdo-eta-reduction',
1356           '-fdo-lambda-eta-expansion',
1357           '-freuse-con',
1358           $Oopt_PedanticBottoms,
1359           $Oopt_MonadEtaExpansion,
1360           $Oopt_UnfoldingUseThreshold,
1361           $Oopt_MaxSimplifierIterations,
1362           '\)',
1363
1364 #LATER: '-fcalc-inlinings1', -- pointless for 2.01
1365
1366 #       ($Oopt_FoldrBuildWW) ? (
1367 #               '-ffoldr-build-ww-anal',
1368 #               '-ffoldr-build-worker-wrapper',
1369 #               '-fsimplify', 
1370 #                 '\(', 
1371 #                 $Oopt_FB_Support,
1372 #                 '-ffloat-lets-exposing-whnf',
1373 #                 '-ffloat-primops-ok',
1374 #                 '-fcase-of-case',
1375 #                 '-fdo-case-elim',
1376 #                 '-fcase-merge',
1377 #                 '-fdo-eta-reduction',
1378 #                 '-fdo-lambda-eta-expansion',
1379 #                 '-freuse-con',
1380 #                 $Oopt_PedanticBottoms,
1381 #                 $Oopt_MonadEtaExpansion,
1382 #                 $Oopt_UnfoldingUseThreshold,
1383 #                 $Oopt_MaxSimplifierIterations,
1384 #                 '\)',
1385 #        ) : (),
1386
1387         # this pass-ordering sequence was agreed by Simon and Andr\'e
1388         # (WDP 94/07, 94/11).
1389         '-ffull-laziness',
1390
1391         ($Oopt_FoldrBuild) ? (
1392           '-ffoldr-build-on',           # desugar list comprehensions for foldr/build
1393
1394           '-fsimplify', 
1395             '\(', 
1396             '-fignore-inline-pragma',   # **** NB!
1397             '-fdo-foldr-build',         # NB
1398             $Oopt_FB_Support,
1399             '-ffloat-lets-exposing-whnf',
1400             '-ffloat-primops-ok',
1401             '-fcase-of-case',
1402             '-fdo-case-elim',
1403             '-fcase-merge',
1404             '-fdo-eta-reduction',
1405             '-fdo-lambda-eta-expansion',        # After full laziness
1406             '-freuse-con',
1407             $Oopt_PedanticBottoms,
1408             $Oopt_MonadEtaExpansion,
1409             $Oopt_UnfoldingUseThreshold,
1410             $Oopt_MaxSimplifierIterations,
1411             '\)',
1412         ) : (),
1413
1414         '-ffloat-inwards',
1415
1416         '-fsimplify',
1417           '\(', 
1418           $Oopt_FB_Support,
1419           '-ffloat-lets-exposing-whnf',
1420           '-ffloat-primops-ok',
1421           '-fcase-of-case',
1422           '-fdo-case-elim',
1423           '-fcase-merge',
1424           '-fdo-eta-reduction',
1425           '-fdo-lambda-eta-expansion',
1426           '-freuse-con',
1427           ($Oopt_FoldrBuildInline),
1428                         # you need to inline foldr and build
1429           ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (), 
1430                         # but do reductions if you see them!
1431           $Oopt_PedanticBottoms,
1432           $Oopt_MonadEtaExpansion,
1433           $Oopt_UnfoldingUseThreshold,
1434           $Oopt_MaxSimplifierIterations,
1435           '\)',
1436
1437         '-fstrictness',
1438
1439         '-fsimplify',
1440           '\(', 
1441           $Oopt_FB_Support,
1442           '-ffloat-lets-exposing-whnf',
1443           '-ffloat-primops-ok',
1444           '-fcase-of-case',
1445           '-fdo-case-elim',
1446           '-fcase-merge',
1447           '-fdo-eta-reduction',
1448           '-fdo-lambda-eta-expansion',
1449           '-freuse-con',
1450           '-flet-to-case',              # Aha! Only done after strictness analysis
1451           $Oopt_PedanticBottoms,
1452           $Oopt_MonadEtaExpansion,
1453           $Oopt_UnfoldingUseThreshold,
1454           $Oopt_MaxSimplifierIterations,
1455           '\)',
1456
1457         '-ffloat-inwards',
1458
1459 # Case-liberation for -O2.  This should be after
1460 # strictness analysis and the simplification which follows it.
1461
1462 #       ( ($OptLevel != 2)
1463 #        ? ''
1464 #       : "-fliberate-case -fsimplify \\( $Oopt_FB_Support -ffloat-lets-exposing-whnf -ffloat-primops-ok -fcase-of-case -fdo-case-elim -fcase-merge -fdo-eta-reduction -fdo-lambda-eta-expansion -freuse-con -flet-to-case $Oopt_PedanticBottoms $Oopt_MonadEtaExpansion $Oopt_UnfoldingUseThreshold $Oopt_MaxSimplifierIterations \\)" ),
1465
1466 # Final clean-up simplification:
1467
1468         '-fsimplify',
1469           '\(', 
1470           $Oopt_FB_Support,
1471           '-ffloat-lets-exposing-whnf',
1472           '-ffloat-primops-ok',
1473           '-fcase-of-case',
1474           '-fdo-case-elim',
1475           '-fcase-merge',
1476           '-fdo-eta-reduction',
1477           '-fdo-lambda-eta-expansion',
1478           '-freuse-con',
1479           '-flet-to-case',
1480           '-fignore-inline-pragma',     # **** NB!
1481           $Oopt_FoldrBuildInline,       
1482           ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (), 
1483                         # but still do reductions if you see them!
1484           $Oopt_PedanticBottoms,
1485           $Oopt_MonadEtaExpansion,
1486           $Oopt_UnfoldingUseThreshold,
1487           $Oopt_MaxSimplifierIterations,
1488           '\)',
1489
1490       # '-fstatic-args',
1491
1492 #LATER: '-fcalc-inlinings2', -- pointless for 2.01
1493
1494       # stg2stg passes
1495         '-fupdate-analysis',
1496         '-flambda-lift',
1497         $Oopt_FinalStgProfilingMassage,
1498         $Oopt_StgStats,
1499
1500       # flags for stg2stg
1501         '-flet-no-escape',
1502
1503       # SPECIAL FLAGS for -O2
1504         ($OptLevel == 2) ? (
1505           '-fsemi-tagging',
1506         ) : (),
1507     );
1508 \end{code}
1509
1510 Sort out what we're going to do about optimising.  First, the @hsc@
1511 flags and regular @cc@ flags to worry about:
1512 \begin{code}
1513 if ( $OptLevel <= 0 ) {
1514
1515     # for this level, we tell the parser -fignore-interface-pragmas
1516     push(@HsC_flags, '-fignore-interface-pragmas');
1517     # and tell the compiler not to produce them
1518     push(@HsC_flags, '-fomit-interface-pragmas');
1519
1520     &add_Hsc_flags( @HsC_minusNoO_flags );
1521     push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
1522
1523 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
1524
1525     &add_Hsc_flags( @HsC_minusO_flags );
1526     push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
1527     # -O? to GCC is not optional! -O2 probably isn't worth it generally,
1528     # but it *is* useful in compiling the garbage collectors (so said
1529     # Patrick many moons ago...).
1530
1531 } else { # -Ofile, then...
1532
1533     &add_Hsc_flags( @HsC_minusO3_flags );
1534     push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
1535 }
1536 \end{code}
1537
1538 %************************************************************************
1539 %*                                                                      *
1540 \subsection{Check for consistency, etc.}
1541 %*                                                                      *
1542 %************************************************************************
1543
1544 Sort out @$BuildTag@, @$PROFing@, @$CONCURing@, @$PARing@,
1545 @$GRANing@, @$TICKYing@:
1546 \begin{code}
1547 if ( $BuildTag ne '' ) {
1548     local($b) = $BuildDescr{$BuildTag};
1549     if ($CONCURing eq 'c') { print STDERR "$Pgm: Can't mix $b with -concurrent.\n"; exit 1; }
1550     if ($PARing    eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
1551     if ($GRANing   eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
1552     if ($TICKYing  eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
1553
1554     # ok to have a user-way profiling build
1555     # eval the profiling opts ... but leave user-way BuildTag 
1556     if ($PROFing   eq 'p') { eval($EvaldSetupOpts{'_p'}); }
1557
1558 } elsif ( $PROFing eq 'p' ) {
1559     if ($PARing   eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
1560     if ($GRANing  eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
1561     if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
1562     $BuildTag = ($CONCURing eq 'c') ? '_mr' : '_p' ; # possibly "profiled concurrent"...
1563
1564 } elsif ( $CONCURing eq 'c' ) {
1565     if ($PARing  eq 'p') { print STDERR "$Pgm: Can't mix -concurrent with -parallel.\n"; exit 1; }
1566     if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -concurrent with -gransim.\n"; exit 1; }
1567     $BuildTag = ($TICKYing eq 't')  ? '_mt' : '_mc' ; # possibly "ticky concurrent"...
1568     # "profiled concurrent" already acct'd for...
1569
1570 } elsif ( $PARing eq 'p' ) {
1571     if ($GRANing  eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
1572     if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
1573     $BuildTag = '_mp';
1574
1575     if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
1576         print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
1577         exit(1);
1578     }
1579
1580 } elsif ( $GRANing eq 'g' ) {
1581     if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
1582     $BuildTag = '_mg';
1583
1584 } elsif ( $TICKYing eq 't' ) {
1585     $BuildTag = '_t';
1586 }
1587 \end{code}
1588
1589 \begin{code}
1590 if ( $BuildTag ne '' ) { # something other than normal sequential...
1591
1592     push(@HsP_flags, "-syshisuffix=$BuildTag.hi"); # use appropriate Prelude .hi files
1593
1594     $HscOut = '-C='; # must go via C
1595
1596     eval($EvaldSetupOpts{$BuildTag});
1597 }
1598 \end{code}
1599
1600 Decide what the consistency-checking options are in force for this run:
1601 \begin{code}
1602 $HsC_consist_options = "${BuildTag},${DEBUGging}";
1603 $Cc_consist_options  = "${BuildTag},${DEBUGging}";
1604 \end{code}
1605
1606 %************************************************************************
1607 %*                                                                      *
1608 \subsection{Add on machine-specific C-compiler flags}
1609 %*                                                                      *
1610 %************************************************************************
1611
1612 Shove on magical machine-specific options.  We use \tr{unshift} to
1613 stick them on the {\em front} of the arrays, so that ``later''
1614 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
1615
1616 Note: a few ``always apply'' flags were set at the very beginning.
1617
1618 \begin{code}
1619 if ($TargetPlatform =~ /^alpha-/) {
1620     # we know how to *mangle* asm for alpha
1621     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1622     unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1623     unshift(@CcBoth_flags,  ('-static'));
1624
1625 } elsif ($TargetPlatform =~ /^hppa/) {
1626     # we know how to *mangle* asm for hppa
1627     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1628     unshift(@CcBoth_flags,  ('-static'));
1629     # We don't put in '-mlong-calls', because it's only
1630     # needed for very big modules (sigh), and we don't want
1631     # to hobble ourselves further on all the other modules
1632     # (most of them).
1633     unshift(@CcBoth_flags,  ('-D_HPUX_SOURCE'));
1634         # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
1635         # (very nice, but too bad the HP /usr/include files don't agree.)
1636
1637 } elsif ($TargetPlatform =~ /^i386-/) {
1638     # we know how to *mangle* asm for X86
1639     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1640     unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1641
1642     # -fno-defer-pop : basically the same game as for m68k
1643     #
1644     # -fomit-frame-pointer : *must* ; because we're stealing
1645     #   the fp (%ebp) for our register maps.  *All* register
1646     #   maps (in MachRegs.lh) must steal it.
1647
1648     unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1649     unshift(@CcRegd_flags,    '-fomit-frame-pointer');
1650     unshift(@CcRegd_flags,    "-DSTOLEN_X86_REGS=$StolenX86Regs");
1651
1652 } elsif ($TargetPlatform =~ /^m68k-/) {
1653     # we know how to *mangle* asm for m68k
1654     unshift (@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1655     unshift (@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1656
1657     # -fno-defer-pop : for the .hc files, we want all the pushing/
1658     #     popping of args to routines to be explicit; if we let things
1659     #     be deferred 'til after an STGJUMP, imminent death is certain!
1660     #
1661     # -fomit-frame-pointer : *don't*
1662     #     It's better to have a6 completely tied up being a frame pointer
1663     #     rather than let GCC pick random things to do with it.
1664     #     (If we want to steal a6, then we would try to do things
1665     #     as on iX86, where we *do* steal the frame pointer [%ebp].)
1666
1667     unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1668     unshift(@CcRegd_flags,    '-fno-omit-frame-pointer');
1669         # maybe gives reg alloc a better time
1670         # also: -fno-defer-pop is not sufficiently well-behaved without it
1671
1672 } elsif ($TargetPlatform =~ /^mips-/) {
1673     # we (hope to) know how to *mangle* asm for MIPSen
1674     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1675     unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1676     unshift(@CcBoth_flags,  ('-static'));
1677
1678 } elsif ($TargetPlatform =~ /^powerpc-/) {
1679     # we know how to *mangle* asm for PowerPC
1680     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1681     unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1682     unshift(@CcBoth_flags,  ('-static')); # always easier to start with
1683     unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1684
1685 } elsif ($TargetPlatform =~ /^sparc-/) {
1686     # we know how to *mangle* asm for SPARC
1687     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1688     unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1689
1690 }
1691 \end{code}
1692
1693 Same unshifting magic, but for special linker flags.
1694
1695 Should really be whether or not we prepend underscores to global symbols,
1696 not an architecture test.  (JSM)
1697
1698 \begin{code}
1699 $Under = (   $TargetPlatform =~ /^alpha-/
1700           || $TargetPlatform =~ /^hppa/
1701           || $TargetPlatform =~ /^mips-sgi-irix/
1702           || $TargetPlatform =~ /^powerpc-/
1703           || $TargetPlatform =~ /-solaris/
1704           || $TargetPlatform =~ /-linux$/
1705          )
1706          ? '' : '_';
1707
1708 unshift(@Ld_flags,
1709       (($Ld_main) ? (
1710         '-u', "${Under}Main_" . $Ld_main . '_closure',
1711        ) : ()
1712 #       , '-u', "${Under}STbase_unsafePerformPrimIO_fast1"
1713 #       , '-u', "${Under}Prelude_Z91Z93_closure"         # i.e., []
1714 #       , '-u', "${Under}Prelude_IZh_static_info"
1715 #       , '-u', "${Under}Prelude_False_inregs_info"
1716 #       , '-u', "${Under}Prelude_True_inregs_info"
1717 #       , '-u', "${Under}Prelude_CZh_static_info"
1718 #       , '-u', "${Under}DEBUG_REGS"
1719         ))
1720        ; # just for fun, now...
1721 \end{code}
1722
1723 %************************************************************************
1724 %*                                                                      *
1725 \subsection{Set up include paths and system-library enslurpment}
1726 %*                                                                      *
1727 %************************************************************************
1728
1729 Now that we know what garbage-collector, etc., are required, we can
1730 finalise our list of libraries to slurp through, and generally Get
1731 Ready for Business.
1732
1733 \begin{code}
1734 # default includes must be added AFTER option processing
1735 if ( ! $(INSTALLING) ) {
1736     push (@Include_dir, "$TopPwd/$(CURRENT_DIR)/$(GHC_INCLUDESRC)");
1737 } else {
1738     push (@Include_dir, "$InstLibDirGhc/includes");
1739     push (@Include_dir, "$InstDataDirGhc/includes");
1740 }
1741 \end{code}
1742
1743 \begin{code}
1744 push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1745
1746 local($f);
1747 foreach $f (@SysLibrary) {
1748     next if $f =~ /_cbits/;
1749     $f .= $BuildTag if $f =~ /^-lHS/;
1750 }
1751
1752 # fiddle the TopClosure file name...
1753 $TopClosureFile =~ s/XXXX//;
1754
1755 # Push library HSrts, plus boring clib bit
1756 push(@SysLibrary, "-lHSrts${BuildTag}");
1757 push(@SysLibrary, '-lHSclib');
1758
1759 # Push the pvm libraries
1760 if ($BuildTag eq '_mp') {
1761     $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1762     push(@SysLibrary, "-L$pvmlib", '-lpvm3', '-lgpvm3');
1763     if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1764         push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1765     } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1766         push(@SysLibrary, '-lsocket', '-lnsl');
1767     }
1768 }
1769
1770 # Push the GNU multi-precision arith lib; and the math library
1771 push(@SysLibrary, '-lgmp');
1772 push(@SysLibrary, '-lm');
1773 \end{code}
1774
1775 %************************************************************************
1776 %*                                                                      *
1777 \subsection{Check that this system was built to do what we are asking}
1778 %*                                                                      *
1779 %************************************************************************
1780
1781 Before continuing we check that the appropriate build is available.
1782
1783 \begin{code}
1784 die "$Pgm: no BuildAvail?? $BuildTag\n" if ! $BuildAvail{$BuildTag}; # sanity
1785
1786 if ( $BuildAvail{$BuildTag} =~ /^NO$/ ) {
1787     print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1788         "' \"build\" is not available with your GHC setup.\n";
1789     print STDERR "(It was not configured for it at your site.)\n";
1790     print STDERR $ShortUsage;
1791     exit 1;
1792 }
1793 \end{code}
1794
1795 %************************************************************************
1796 %*                                                                      *
1797 \subsection{Final miscellaneous setup bits before we start going}
1798 %*                                                                      *
1799 %************************************************************************
1800
1801 Record largest specific heapsize, if any.
1802 \begin{code}
1803 $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1804 push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1805 $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1806 push(@HsC_rts_flags, "-K$Specific_stk_size");
1807
1808 # hack to avoid running hscpp
1809 $HsCpp = $Cat if ! $Cpp_flag_set;
1810 \end{code}
1811
1812 If no input or link files seen, then we let 'em feed in stdin; this is
1813 mainly for debugging.
1814 \begin{code}
1815 if ($#Input_file < 0 && $#Link_file < 0) {
1816     @Input_file = ( '-' );
1817
1818     open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1819     print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n";
1820     while (<>) { print INF $_; }
1821     close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1822 }
1823 \end{code}
1824
1825 Tell the world who we are, if they asked.
1826 \begin{code}
1827 print STDERR "$(PROJECTNAME), version $(PROJECTVERSION) $(PROJECTPATCHLEVEL)\n"
1828     if $Verbose;
1829 \end{code}
1830
1831 %************************************************************************
1832 %*                                                                      *
1833 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1834 %*                                                                      *
1835 %************************************************************************
1836
1837 Process the input files; don't continue with linking if there are
1838 problems (global variable @$Status@ non-zero).
1839 \begin{code}
1840 foreach $ifile (@Input_file) {
1841     &ProcessInputFile($ifile);
1842 }
1843
1844 if ( $Status > 0 ) { # don't link if there were errors...
1845     print STDERR $ShortUsage;
1846     &tidy_up();
1847     exit $Status;
1848 }
1849 \end{code}
1850
1851 Link if appropriate.
1852 \begin{code}
1853 if ($Do_lnkr) {
1854     local($libdirs) = '';
1855
1856     # glue them together:
1857     push(@UserLibrary_dir, @SysLibrary_dir);
1858
1859     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1860
1861     # for a linker, use an explicitly given one, or the going C compiler ...
1862     local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1863
1864     local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1865     @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1866
1867     local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1868     &run_something($to_do, 'Linker');
1869
1870     # finally, check the consistency info in the binary
1871     local($executable) = $Files_to_tidy[0];
1872     @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1873
1874     if ( $LinkChk ) {
1875         # dynamically load consistency-chking code; then do it.
1876         require('ghc-consist.prl')
1877             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1878
1879         &chk_consistency_info ( $executable );
1880     }
1881
1882     # if PVM parallel stuff, we do truly weird things.
1883     # Essentially: (1) move the executable over to where PVM expects
1884     # to find it.  (2) create a script in place of the executable
1885     # which will cause the program to be run, via SysMan.
1886     if ( $PARing eq 'p' ) {
1887         local($pvm_executable) = $executable;
1888         local($pvm_executable_base);
1889
1890         if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1891             local($pwd) = `pwd`;
1892             chop($pwd);
1893             $pwd =~ s/^\/tmp_mnt//;
1894             $pvm_executable = "$pwd/$pvm_executable";
1895         }
1896
1897         $pvm_executable =~ s|/|=|g; # make /s into =s
1898         $pvm_executable_base = $pvm_executable;
1899
1900         $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1901                         . "/$pvm_executable";
1902
1903         &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1904
1905         # OK, now create the magic script for "$executable"
1906         open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1907         print EXEC <<EOSCRIPT1;
1908 #!$(PERL)
1909 # =!=!=!=!=!=!=!=!=!=!=!
1910 # This script is automatically generated: DO NOT EDIT!!!
1911 # Generated by Glasgow Haskell, version $(PROJECTVERSION) $(PROJECTPATCHLEVEL)
1912 #
1913 \$pvm_executable      = '$pvm_executable';
1914 \$pvm_executable_base = '$pvm_executable_base';
1915 \$SysMan = '$SysMan';
1916 EOSCRIPT1
1917
1918         print EXEC <<\EOSCRIPT2;
1919 # first, some magical shortcuts to run "commands" on the binary
1920 # (which is hidden)
1921 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1922     local($cmd) = $1;
1923     system("$cmd $pvm_executable");
1924     exit(0); # all done
1925 }
1926
1927 # OK, really run it; process the args first
1928 $ENV{'PE'} = $pvm_executable_base;
1929 $debug = '';
1930 $nprocessors = 2; # the default
1931 @nonPVM_args = ();
1932 $in_RTS_args = 0;
1933
1934 # ToDo: handle --RTS
1935 args: while ($a = shift(@ARGV)) {
1936     if ( $a eq '+RTS' ) {
1937         $in_RTS_args = 1;
1938     } elsif ( $a eq '-RTS' ) {
1939         $in_RTS_args = 0;
1940     }
1941     if ( $a eq '-d' && $in_RTS_args ) {
1942         $debug = '-';
1943     } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1944         $nprocessors = $1;
1945     } else {
1946         push(@nonPVM_args, $a);
1947     }
1948 }
1949
1950 local($return_val) = 0;
1951 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1952 $return_val = $?;
1953 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1954 exit($return_val);
1955 EOSCRIPT2
1956         close(EXEC) || die "Failed closing $executable\n";
1957         chmod 0755, $executable;
1958     }
1959 }
1960
1961 # that...  that's all, folks!
1962 &tidy_up();
1963 exit $Status; # will still be 0 if all went well
1964 \end{code}
1965
1966 %************************************************************************
1967 %*                                                                      *
1968 \section[Driver-do-one-file]{How to process a single input file}
1969 %*                                                                      *
1970 %************************************************************************
1971
1972 \begin{code}
1973 sub ProcessInputFile {
1974     local($ifile) = @_;   # input file name
1975     local($ifile_root);   # root of or basename of input file
1976     local($ofile_target); # ultimate output file we hope to produce
1977                           # from input file (need to know for recomp
1978                           # checking purposes)
1979     local($hifile_target);# ditto (but .hi file)
1980 \end{code}
1981
1982 Handle the weirdity of input from stdin.
1983 \begin{code}
1984     if ($ifile ne '-') {
1985         ($ifile_root  = $ifile) =~ s/\.[^\.\/]+$//;
1986         $ofile_target = # may be reset later...
1987                         ($Specific_output_file ne '' && ! $Do_lnkr)
1988                         ? $Specific_output_file
1989                         : &odir_ify($ifile_root, 'o');
1990         $hifile_target= ($Specific_hi_file ne '')
1991                         ? $Specific_hi_file
1992                         : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1993                         # NB: may change if $ifile_root isn't module name (??)
1994     } else {
1995         $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1996         $ifile_root   = '_stdin';
1997         $ofile_target = '_stdout'; # gratuitous?
1998         $hifile_target= '_stdout'; # ditto?
1999     }
2000 \end{code}
2001
2002 We need to decide what phases of the compilation system we will run
2003 over this file.  The defaults are the ones established when processing
2004 flags.  (That established what the last phase run for all files is.)
2005
2006 We do the pre-recompilation-checker phases here; the rest later.
2007 \begin{code}
2008 \end{code}
2009
2010 Look at the suffix and decide what initial phases of compilation may
2011 be dropped off for this file.  Also the rather boring business of
2012 which files are coming-in/going-out.
2013
2014 Again, we'll do the post-recompilation-checker parts of this later.
2015 \begin{code}
2016     local($do_lit2pgm)  = ($ifile =~ /\.lhs$/) ? 1 : 0;
2017     local($do_hscpp)    = 1; # but "hscpp" might really be "cat"
2018     local($do_hsc)      = 1;
2019     local($do_cc)       = ( $Do_cc != -1) # i.e., it was set explicitly
2020                           ? $Do_cc
2021                           : ( ($HscOut eq '-C=') ? 1 : 0 );
2022     local($do_as)       = $Do_as;
2023
2024     # names of the files to stuff between phases
2025     # defaults are temporaries
2026     local($in_lit2pgm)    = $ifile;
2027     local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
2028     local($hscpp_hsc)     = "$Tmp_prefix.cpp";
2029     local($hsc_out)       = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
2030     local($hsc_hi)        = "$Tmp_prefix.hi";
2031     local($cc_as_o)       = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
2032     local($cc_as)         = "$Tmp_prefix.s";     # mangled or hsc-produced .s code
2033     local($as_out)        = $ofile_target;
2034
2035     local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
2036
2037     if ($ifile =~ /\.lhs$/) {
2038         ; # nothing to change
2039     } elsif ($ifile =~ /\.hs$/) {
2040         $do_lit2pgm = 0;
2041         $lit2pgm_hscpp = $ifile;
2042     } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
2043         $do_lit2pgm = 0; $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
2044         $hsc_out = $ifile;    
2045     } elsif ($ifile =~ /\.c$/) {
2046         $do_lit2pgm = 0; $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
2047         $hsc_out = $ifile; $is_hc_file = 0;
2048     } elsif ($ifile =~ /\.s$/) {
2049         $do_lit2pgm = 0; $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
2050         $cc_as = $ifile;    
2051     } else { # don't know what it is, but nothing to do herein...
2052         $do_lit2pgm = 0; $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
2053     }
2054
2055     # OK, have a bash on the first two phases:
2056     &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
2057         if $do_lit2pgm;
2058
2059     &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc)
2060         if $do_hscpp;
2061 \end{code}
2062
2063 We now think about whether to run hsc/cc or not (when hsc produces .s
2064 stuff, it effectively takes the place of both phases).
2065
2066 To get the output file name right: for each phase that we are {\em
2067 not} going to run, set its input (i.e., the output of its preceding
2068 phase) to @"$ifile_root.<suffix>"@.
2069 \begin{code}
2070     local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
2071
2072     if (! $do_cc && ! $do_as) { # stopping after hsc
2073         $hsc_out = ($Specific_output_file ne '')
2074                  ? $Specific_output_file
2075                  : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
2076
2077         $ofile_target = $hsc_out; # reset
2078     }
2079
2080     if (! $do_as) { # stopping after gcc (or hsc)
2081         $cc_as = ($Specific_output_file ne '')
2082                  ? $Specific_output_file
2083                  : &odir_ify($ifile_root, ( $Only_preprocess_C ) ? 'i' : 's');
2084
2085         $ofile_target = $cc_as; # reset
2086     }
2087
2088 \end{code}
2089
2090
2091 Now the Haskell compiler, C compiler, and assembler
2092
2093 \begin{code}
2094    if ($do_hsc) {
2095         &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root, 
2096                                      $ofile_target, $hifile_target);
2097     }
2098
2099     if ($do_cc) {
2100         &runGcc    ($is_hc_file, $hsc_out, $cc_as_o);
2101         &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root);
2102     }
2103
2104     &split_asm_file($cc_as)  if $do_as && $SplitObjFiles;
2105
2106     &runAs($as_out, $ifile_root) if $do_as;
2107 \end{code}
2108
2109 Finally, decide what to queue up for linker input.
2110 \begin{code}
2111     # tentatively assume we will eventually produce linker input:
2112     push(@Link_file, &odir_ify($ifile_root, 'o'));
2113
2114 #ToDo:    local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
2115
2116     if ( $ifile !~ /\.(lhs|hs|hc|c|s)$/ && $ifile !~ /_hc$/ ) {
2117         print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n"
2118             if $ifile !~ /\.a$/;
2119
2120         # oops; we tentatively pushed the wrong thing; fix & do the right thing
2121         pop(@Link_file); push(@Link_file, $ifile);
2122     }
2123
2124 } # end of ProcessInputFile
2125 \end{code}
2126
2127 %************************************************************************
2128 %*                                                                      *
2129 \section[Driver-run-phases]{Routines to run the various phases}
2130 %*                                                                      *
2131 %************************************************************************
2132
2133 \begin{code}
2134 sub runLit2pgm {
2135     local($in_lit2pgm, $lit2pgm_hscpp) = @_;
2136
2137     local($to_do) = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && ".
2138                     "$Unlit @Unlit_flags $in_lit2pgm -  >> $lit2pgm_hscpp";
2139     @Files_to_tidy = ( $lit2pgm_hscpp );
2140
2141     &run_something($to_do, 'literate pre-processor');
2142 }
2143 \end{code}
2144
2145 \begin{code}
2146 sub runHscpp {
2147     local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
2148
2149     local($to_do);
2150
2151     if ($HsCpp eq $Cat) {
2152         $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $hscpp_hsc && ".
2153                         "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
2154         @Files_to_tidy = ( $hscpp_hsc );
2155         &run_something($to_do, 'Ineffective C pre-processor');
2156     } else {
2157         local($includes) = '-I' . join(' -I',@Include_dir);
2158         $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $hscpp_hsc && ".
2159                         "$HsCpp $Verbose $genSPECS_flag @HsCpp_flags -D__HASKELL1__=$Haskell1Version -D__GLASGOW_HASKELL__=$GhcVersionInfo $includes $lit2pgm_hscpp >> $hscpp_hsc";
2160         @Files_to_tidy = ( $hscpp_hsc );
2161         &run_something($to_do, 'Haskellised C pre-processor');
2162     }
2163 }
2164 \end{code}
2165
2166 \begin{code}
2167 sub runHscAndProcessInterfaces {
2168     local($ifile, $hscpp_hsc, $ifiel_root, $ofile_target, $hifile_target) = @_;
2169
2170         # $ifile                is the original input file
2171         # $hscpp_hsc            post-unlit, post-cpp, etc., input file
2172         # $ifile_root           input filename minus suffix
2173         # $ofile_target         the output file that we ultimately hope to produce
2174         # $hifile_target        the .hi file ... (ditto)
2175         
2176     local($source_unchanged) = 1;
2177
2178 # Check if the source file is up to date relative to the target; in
2179 #  that case we say "source is unchanged" and let the compiler bale out
2180 # early if the import usage information allows it.
2181
2182     ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
2183      $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
2184
2185     if ( ! -f $ofile_target ) {
2186         print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n";
2187         $source_unchanged = 0;
2188     }
2189
2190     ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
2191      $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
2192
2193     if ( ! -f $hifile_target ) {
2194         print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n";
2195         $source_unchanged = 0;
2196     }
2197
2198     ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
2199      $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
2200
2201     if ($i_mtime > $o_mtime) {
2202         print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n";
2203         $source_unchanged = 0;
2204     }
2205
2206     # So if source_unchanged is still "1", we pass on the good news to the compiler
2207     # The -recomp flag can disable this, forcing recompilation
2208     if ($Do_recomp_chkr && $source_unchanged) {
2209         push(@HsC_flags, '-fsource-unchanged'); 
2210     }   
2211
2212 # Run the compiler
2213
2214     &runHsc($ifile_root, $hsc_out, $hsc_hi, $going_interactive);
2215
2216 # See if it baled out early, saying nothing needed doing.  
2217 # We work this out by seeing if it created an output .hi file
2218
2219     if ( ! -f $hsc_hi ) {
2220         # Doesn't exist, so we baled out early.
2221         # Tell the C compiler and assembler not to run
2222         $do_cc = 0; $do_as = 0;
2223
2224         # Update dependency info
2225         &run_something("touch $ofile_target", "Touch $ofile_target, to propagate dependencies");
2226
2227     } else {    
2228
2229 # Didn't bale out early (new .hi file) so we thunder on
2230     
2231         # If non-interactive, heave in the consistency info at the end
2232         # NB: pretty hackish (depends on how $output is set)
2233         if ( ! $going_interactive ) {
2234             if ( $HscOut eq '-C=' ) {
2235             $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
2236     
2237             } elsif ( $HscOut eq '-S=' ) {
2238                 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
2239                 $consist =~ s/,/./g;
2240                 $consist =~ s/\//./g;
2241                 $consist =~ s/-/_/g;
2242                 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
2243                 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
2244             }
2245             &run_something($to_do, 'Pin on Haskell consistency info');  
2246         }   
2247
2248
2249         # Interface-handling is important enough to live off by itself
2250         require('ghc-iface.prl')
2251             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
2252         
2253         &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
2254         
2255         # save a copy of the .hc file, even if we are carrying on...
2256         if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
2257             local($to_do) = "$Rm $ifile_root.hc; $Cp $hsc_out $ifile_root.hc";
2258             &run_something($to_do, 'Saving copy of .hc file');
2259         }
2260         
2261         # save a copy of the .s file, even if we are carrying on...
2262         if ($HscOut eq '-S=' && $do_as && $Keep_s_file_too) {
2263             local($to_do) = "$Rm $ifile_root.s; $Cp $hsc_out $ifile_root.s";
2264             &run_something($to_do, 'Saving copy of .s file');
2265         }
2266         
2267         # if we're going to split up object files,
2268         # we inject split markers into the .hc file now
2269         if ( $HscOut eq '-C=' && $SplitObjFiles ) {
2270             &inject_split_markers ( $hsc_out );
2271         }
2272     }
2273 }
2274 \end{code}
2275
2276
2277 \begin{code}
2278 sub runHsc {
2279     local($ifile_root, $hsc_out, $hsc_hi, $going_interactive) = @_;
2280
2281     # prepend comma to HsP flags (so hsc can tell them apart...)
2282     foreach $a ( @HsP_flags ) { $a = ",$a" unless $a =~ /^,/; }
2283
2284     &makeHiMap() unless $HiMapDone;
2285 #    print STDERR "HiIncludes: $HiIncludeString\n";
2286     push(@HsC_flags, "-himap=$HiIncludeString");
2287 #    push(@HsC_flags, "-himap=$HiMapFile");
2288
2289     # here, we may produce .hc/.s and/or .hi files
2290     local($output) = '';
2291     @Files_to_tidy = ();
2292
2293     if ( $going_interactive ) {
2294         # don't need .hi unless going to show it on stdout:
2295         $ProduceHi = '-nohifile=' if ! $HiOnStdout;
2296         $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
2297     }
2298
2299     # set up for producing output/.hi; note that flag twiddling
2300     # may mean that nothing will actually be produced:
2301     $output = "$ProduceHi$hsc_hi $HscOut$hsc_out";
2302     @Files_to_tidy = ( $hsc_hi, $hsc_out );
2303
2304     # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
2305     if ( $CollectingGCstats ) {
2306         push(@HsC_rts_flags, "-S$ifile_root.stat");
2307         push(@Files_to_tidy, "$ifile_root.stat");
2308     }
2309
2310     if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
2311         # emit nofibbish time/bytes-alloc stats to stderr;
2312         # see later .stat file post-processing
2313         push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
2314         push(@Files_to_tidy, "$Tmp_prefix.stat");
2315     }
2316
2317     local($dump) = '';
2318     if ($Specific_dump_file ne '') {
2319         $dump = "2>> $Specific_dump_file";
2320         $Using_dump_file = 1;
2321     }
2322
2323     local($to_do);
2324     $to_do = "$HsC @HsP_flags ,$hscpp_hsc $dump @HsC_flags $CoreLint $Verbose $output +RTS @HsC_rts_flags";
2325     &run_something($to_do, 'Haskell compiler');
2326
2327     # finish business w/ nofibbish time/bytes-alloc stats
2328     &process_ghc_timings() if $CollectGhcTimings;
2329 }
2330 \end{code}
2331
2332 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
2333 of (module-name, pathname) pairs, one per line, separated by a space.
2334 \begin{code}
2335 %HiMap     = ();
2336 $HiMapDone = 0;
2337 $HiMapFile = '';
2338 $HiIncludeString = ();          # dir1:dir2:dir3, to pass to GHC
2339
2340 sub makeHiMap {
2341
2342     # collect in %HiMap; write later; also used elsewhere in driver
2343
2344     local($mod, $path, $d, $e);
2345     
2346     foreach $d ( @Import_dir ) {
2347         if ($HiIncludeString) { $HiIncludeString = "$HiIncludeString:$d";
2348         } else { $HiIncludeString = $d; }
2349
2350         opendir(DIR, $d) || &tidy_up_and_die(1,"$Pgm: error when reading directory: $d\n");
2351         local(@entry) = readdir(DIR);
2352         foreach $e ( @entry ) {
2353             next unless $e =~ /\b([A-Z][A-Za-z0-9_]*)\.$HiSuffix$/o;
2354             $mod  = $1;
2355             $path = "$d/$e";
2356             $path =~ s,^\./,,;
2357
2358             if ( ! defined($HiMap{$mod}) ) {
2359                 $HiMap{$mod} = $path;
2360             } else {
2361                 &already_mapped_err($mod, $HiMap{$mod}, $path);
2362             }
2363         }
2364         closedir(DIR); # || &tidy_up_and_die(1,"$Pgm: error when closing directory: $d\n");
2365     }
2366
2367     foreach $d ( @SysImport_dir ) {
2368         if ($HiIncludeString) { $HiIncludeString = "$HiIncludeString:$d";
2369         } else { $HiIncludeString = $d; }
2370
2371         opendir(DIR, $d) || &tidy_up_and_die(1,"$Pgm: error when reading directory: $d\n");
2372         local(@entry) = readdir(DIR);
2373         foreach $e ( @entry ) {
2374             next unless $e =~ /([A-Z][A-Za-z0-9_]*)\.$SysHiSuffix$/o;
2375             next if $NoImplicitPrelude && $e =~ /Prelude\.$SysHiSuffix$/o;
2376
2377             $mod  = $1;
2378             $path = "$d/$e";
2379             $path =~ s,^\./,,;
2380
2381             if ( ! defined($HiMap{$mod}) ) {
2382                 $HiMap{$mod} = $path;
2383             } elsif ( $mod ne 'Main' )  { # saves useless warnings...
2384                 &already_mapped_err($mod, $HiMap{$mod}, $path);
2385             }
2386         }
2387         closedir(DIR); # || &tidy_up_and_die(1,"$Pgm: error when closing directory: $d\n");
2388     }
2389
2390     $HiMapFile = "$Tmp_prefix.himap";
2391     unlink($HiMapFile);
2392     open(HIMAP, "> $HiMapFile") || &tidy_up_and_die(1,"$Pgm: can't open $HiMapFile\n");
2393     foreach $d (keys %HiMap) {
2394         print HIMAP $d, ' ', $HiMap{$d}, "\n";
2395     }
2396     close(HIMAP) || &tidy_up_and_die(1,"$Pgm: error when closing $HiMapFile\n");
2397
2398     $HiMapDone = 1;
2399 }
2400
2401 sub already_mapped_err {
2402     local($mod, $mapped_to, $path) = @_;
2403
2404     # OK, it isn't really an error if $mapped_to and $path turn
2405     # out to be the same thing.
2406     ($m_dev,$m_ino,$m_mode,$m_nlink,$m_uid,$m_gid,$m_rdev,$m_size,
2407      $m_atime,$m_mtime,$m_ctime,$m_blksize,$m_blocks) = stat($mapped_to);
2408     ($p_dev,$p_ino,$p_mode,$p_nlink,$p_uid,$p_gid,$p_rdev,$p_size,
2409      $p_atime,$p_mtime,$p_ctime,$p_blksize,$p_blocks) = stat($path);
2410
2411     return if $m_ino == $p_ino; # same inode number
2412
2413     print STDERR "$Pgm: module $mod already mapped to $mapped_to";
2414     print STDERR ";\n\tignoring: $path\n";
2415 }
2416 \end{code}
2417
2418 %************************************************************************
2419 %*                                                                      *
2420 \section[Driver-misc-utils]{Miscellaneous utilities}
2421 %*                                                                      *
2422 %************************************************************************
2423
2424 %************************************************************************
2425 %*                                                                      *
2426 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2427 %*                                                                      *
2428 %************************************************************************
2429
2430 \begin{code}
2431 sub osuf_ify {
2432     local($ofile,$def_suffix) = @_;
2433
2434     return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2435 }
2436
2437 sub odir_ify {
2438     local($orig_file, $def_suffix) = @_;
2439     if ($Specific_output_dir eq '') {   # do nothing
2440         &osuf_ify($orig_file, $def_suffix);
2441     } else {
2442         local ($orig_file_only);
2443         ($orig_file_only = $orig_file) =~ s|.*/||;
2444         &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2445     }
2446 }
2447 \end{code}
2448
2449 \begin{code}
2450 sub runGcc {
2451     local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2452
2453     local($includes) = '-I' . join(' -I', @Include_dir);
2454     local($cc);
2455     local($s_output);
2456     local($c_flags) = "@CcBoth_flags";
2457     local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2458
2459     # "input" files to use that are not in some weird directory;
2460     # to help C compilers grok .hc files [ToDo: de-hackify]
2461     local($cc_help)   = "ghc$$.c";
2462     local($cc_help_s) = "ghc$$.s";
2463
2464     $cc       = $CcRegd;
2465     $s_output = ($is_hc_file || $TargetPlatform =~ /^(hppa|i386)/) ? $cc_as_o : $cc_as;
2466     $c_flags .= " @CcRegd_flags";
2467     $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc"  : " @CcRegd_flags_c";
2468
2469     # C compiler won't like the .hc extension.  So we create
2470     # a tmp .c file which #include's the needful.
2471     open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2472     if ( $is_hc_file ) {
2473         print TMP <<EOINCL;
2474 #ifdef __STG_GCC_REGS__
2475 # if ! (defined(MAIN_REG_MAP) || defined(MARK_REG_MAP) || defined(SCAN_REG_MAP) || defined(SCAV_REG_MAP) || defined(FLUSH_REG_MAP))
2476 #  define MAIN_REG_MAP
2477 # endif
2478 #endif
2479 #include "stgdefs.h"
2480 EOINCL
2481         # user may have asked for #includes to be injected...
2482         print TMP @CcInjects if $#CcInjects >= 0;
2483     }
2484     # heave in the consistency info
2485     print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2486
2487     # and #include the real source
2488     print TMP "#include \"$hsc_out\"\n";
2489     close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2490
2491     local($to_do) = "$cc $Verbose $ddebug_flag $c_flags @Cpp_define -D__HASKELL1__=$Haskell1Version $includes $cc_help > $Tmp_prefix.ccout 2>&1 && ( if [ $cc_help_s != $s_output ] ; then mv $cc_help_s $s_output ; else exit 0 ; fi )";
2492     # note: __GLASGOW_HASKELL__ is pointedly *not* #defined at the C level.
2493     if ( $Only_preprocess_C ) { # HACK ALERT!
2494         $to_do =~ s/ -S\b//g;
2495     }
2496     @Files_to_tidy = ( $cc_help, $cc_help_s, $s_output );
2497     $PostprocessCcOutput = 1;   # hack, dear hack...
2498     &run_something($to_do, 'C compiler');
2499     $PostprocessCcOutput = 0;
2500     unlink($cc_help, $cc_help_s);
2501 }
2502 \end{code}
2503
2504 \begin{code}
2505 sub runMangler {
2506     local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2507
2508     if ( $is_hc_file ) {
2509         # dynamically load assembler-fiddling code, which we are about to use:
2510         require('ghc-asm.prl')
2511         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2512     }
2513
2514     print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2515
2516     if ($is_hc_file) {
2517         # post-process the assembler [.hc files only]
2518         &mangle_asm($cc_as_o, $cc_as);
2519
2520 #OLD: for sanity:
2521 #OLD:   local($target) = 'oops';
2522 #OLD:   $target = '-alpha'      if $TargetPlatform =~ /^alpha-/;
2523 #OLD:   $target = '-hppa'       if $TargetPlatform =~ /^hppa/;
2524 #OLD:   $target = '-old-asm'    if $TargetPlatform =~ /^i386-/;
2525 #OLD:   $target = '-m68k'       if $TargetPlatform =~ /^m68k-/;
2526 #OLD:   $target = '-mips'       if $TargetPlatform =~ /^mips-/;
2527 #OLD:   $target = ''            if $TargetPlatform =~ /^powerpc-/;
2528 #OLD:   $target = '-solaris'    if $TargetPlatform =~ /^sparc-sun-solaris2/;
2529 #OLD:   $target = '-sparc'      if $TargetPlatform =~ /^sparc-sun-sunos4/;
2530 #OLD:
2531 #OLD:   if ( $target ne '' ) {
2532 #OLD:       require("ghc-asm$target.prl")
2533 #OLD:       || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm$target.prl!\n");
2534 #OLD:       &mangle_asm($cc_as_o, "$cc_as-2"); # the OLD one!
2535 #OLD:       &run_something("$Cmp -s $cc_as-2 $cc_as || $Diff $cc_as-2 $cc_as 1>&2 || exit 0",
2536 #OLD:           "Diff'ing old and new mangled .s files"); # NB: to stderr
2537 #OLD:   }
2538
2539     } elsif ($TargetPlatform =~ /^hppa/) {
2540         # minor mangling of non-threaded files for hp-pa only
2541         require('ghc-asm.prl')
2542         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2543         &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2544
2545     } elsif ($TargetPlatform =~ /^i386/) {
2546         # extremely-minor OFFENSIVE mangling of non-threaded just one file
2547         require('ghc-asm.prl')
2548         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2549         &mini_mangle_asm_i386($cc_as_o, $cc_as);
2550     }
2551
2552     # save a copy of the .s file, even if we are carrying on...
2553     if ($do_as && $Keep_s_file_too) {
2554         local($to_do) = "$Rm $ifile_root.s; $Cp $cc_as $ifile_root.s";
2555         &run_something($to_do, 'Saving copy of .s file');
2556     }
2557 }
2558 \end{code}
2559
2560 \begin{code}
2561 sub runAs {
2562     local($as_out, $ifile_root) = @_;
2563
2564     local($asmblr) = ( $As ) ? $As : $CcRegd;
2565
2566     if ( ! $SplitObjFiles ) {
2567         local($to_do)  = "$asmblr -o $as_out -c @As_flags $cc_as";
2568         @Files_to_tidy = ( $as_out );
2569         &run_something($to_do, 'Unix assembler');
2570
2571     } else { # more complicated split-ification...
2572
2573         # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2574
2575         for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2576             local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2577             local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2578             @Files_to_tidy = ( $split_out );
2579
2580             &run_something($to_do, 'Unix assembler');
2581         }
2582     }
2583 }
2584 \end{code}
2585
2586 %************************************************************************
2587 %*                                                                      *
2588 \subsection[Driver-run-something]{@run_something@: Run a phase}
2589 %*                                                                      *
2590 %************************************************************************
2591
2592 \begin{code}
2593 sub run_something {
2594     local($str_to_do, $tidy_name) = @_;
2595
2596     print STDERR "\n$tidy_name:\n\t" if $Verbose;
2597     print STDERR "$str_to_do\n" if $Verbose;
2598
2599     if ($Using_dump_file) {
2600         open(DUMP, ">> $Specific_dump_file")
2601             || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2602         print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2603         close(DUMP) 
2604             || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2605     }
2606
2607     local($return_val) = 0;
2608     system("$Time $str_to_do");
2609     $return_val = $?;
2610
2611     if ( $PostprocessCcOutput ) { # hack, continued
2612         open(CCOUT, "< $Tmp_prefix.ccout")
2613             || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2614         while ( <CCOUT> ) {
2615             next if /attribute directive ignored/;
2616             next if /call-clobbered/;
2617             next if /from .*COptRegs\.lh/;
2618             next if /from .*(stg|rts)defs\.h:/;
2619             next if /from ghc\d+.c:\d+:/;
2620             next if /from .*\.lc/;
2621             next if /from .*SMinternal\.l?h/;
2622             next if /ANSI C does not support \`long long\'/;
2623             next if /warning:.*was declared \`extern\' and later \`static\'/;
2624             next if /warning: assignment discards \`const\' from pointer target type/;
2625             next if /: At top level:$/;
2626             next if /: In function \`.*\':$/;
2627             next if /\`ghc_cc_ID\' defined but not used/;
2628             print STDERR $_;
2629         }
2630         close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2631     }
2632
2633     if ($return_val != 0) {
2634         if ($Using_dump_file) {
2635             print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2636         }
2637
2638         &tidy_up_and_die($return_val, '');
2639     }
2640     $Using_dump_file = 0;
2641 }
2642 \end{code}
2643
2644 %************************************************************************
2645 %*                                                                      *
2646 \subsection[Driver-ghctiming]{Emit nofibbish GHC timings}
2647 %*                                                                      *
2648 %************************************************************************
2649
2650 NB: nearly the same as in @runstdtest@ script.
2651
2652 \begin{code}
2653 sub process_ghc_timings {
2654     local($StatsFile) = "$Tmp_prefix.stat";
2655     local($SysSpecificTiming) = 'ghc';
2656
2657     open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2658     local($tot_live) = 0; # for calculating avg residency
2659
2660     while (<STATS>) {
2661         $tot_live += $1 if /^\s*\d+\s+\d+\s+\d+\.\d+\%\s+(\d+)\s+\d+\.\d+\%/;
2662
2663         $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2664
2665         if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2666             $MaxResidency = $1; $ResidencySamples = $2;
2667         }
2668
2669         $GCs = $1 if /^\s*([0-9,]+) garbage collections? performed/;
2670
2671         if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2672             $InitTime = $1; $InitElapsed = $2;
2673         } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2674             $MutTime = $1; $MutElapsed = $2;
2675         } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2676             $GcTime = $1; $GcElapsed = $2;
2677         }
2678     }
2679     close(STATS) || die "Failed when closing $StatsFile\n";
2680     if ( defined($ResidencySamples) && $ResidencySamples > 0 ) {
2681         $AvgResidency = int ($tot_live / $ResidencySamples) ;
2682     }
2683
2684     # warn about what we didn't find
2685     print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2686     print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2687     print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2688     print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2689     print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2690     print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2691     print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2692     print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2693
2694     # things we didn't necessarily expect to find
2695     $MaxResidency     = 0 unless defined($MaxResidency);
2696     $AvgResidency     = 0 unless defined($AvgResidency);
2697     $ResidencySamples = 0 unless defined($ResidencySamples);
2698
2699     # a bit of tidying
2700     $BytesAlloc =~ s/,//g;
2701     $MaxResidency =~ s/,//g;
2702     $GCs =~ s/,//g;
2703     $InitTime =~ s/,//g;
2704     $InitElapsed =~ s/,//g;
2705     $MutTime =~ s/,//g;
2706     $MutElapsed =~ s/,//g;
2707     $GcTime =~ s/,//g;
2708     $GcElapsed =~ s/,//g;
2709
2710     # print out what we found
2711     print STDERR "<<$SysSpecificTiming: ",
2712         "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2713         " :$SysSpecificTiming>>\n";
2714
2715     # OK, party over
2716     unlink $StatsFile;
2717 }
2718 \end{code}
2719
2720 %************************************************************************
2721 %*                                                                      *
2722 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2723 %*                                                                      *
2724 %************************************************************************
2725
2726 \begin{code}
2727 sub tidy_up {
2728     local($to_do) = "\n$Rm $Tmp_prefix*";
2729     if ( $Tmp_prefix !~ /^\s*$/ ) {
2730         print STDERR "$to_do\n" if $Verbose;
2731         system($to_do);
2732     }
2733 }
2734
2735 sub tidy_up_and_die {
2736     local($return_val, $msg) = @_;
2737
2738     # delete any files to tidy
2739     print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2740     unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2741
2742     &tidy_up();
2743     print STDERR $msg;
2744     exit (($return_val == 0) ? 0 : 1);
2745 }
2746 \end{code}
2747
2748 %************************************************************************
2749 %*                                                                      *
2750 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2751 %*                                                                      *
2752 %************************************************************************
2753
2754 Some command-line arguments take an argument, e.g.,
2755 \tr{-Rmax-heapsize} expects a number to follow.  This can either be
2756 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2757 next argument (\tr{-Rmax-heapsize 8M}).  We allow both cases.
2758
2759 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2760 gobble the second argument (and probably set the heapsize to something
2761 nonsensical).
2762 \begin{code}
2763 sub grab_arg_arg {
2764     local($option, $rest_of_arg) = @_;
2765     
2766     if ($rest_of_arg) {
2767         return($rest_of_arg);
2768     } elsif ($#ARGV >= 0) {
2769         local($temp) = $ARGV[0]; shift(@ARGV); 
2770         return($temp);
2771     } else {
2772         print STDERR "$Pgm: no argument following $option option\n";
2773         $Status++;
2774     }
2775 }
2776 \end{code}
2777
2778 \begin{code}
2779 sub isntAntiFlag {
2780     local($flag) = @_;
2781     local($f);
2782
2783 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2784
2785     foreach $f ( @HsC_antiflags ) {
2786         return(0) if $flag eq $f;
2787     }
2788 #    foreach $f ( @HsC_flags ) {
2789 #       return(0) if $flag eq $f;
2790 #    }
2791     return(1);
2792 }
2793
2794 sub squashHscFlag {  # pretty terrible
2795     local($flag) = @_;
2796     local($f);
2797
2798     foreach $f ( @HsC_flags ) {
2799         if ($flag eq $f) { $f = ''; }
2800     }
2801 }
2802
2803 sub add_Hsc_flags {
2804     local(@flags) = @_;
2805     local($f);
2806
2807     foreach $f ( @flags ) {
2808         push( @HsC_flags, $f ) if &isntAntiFlag($f);
2809     }
2810 }
2811 \end{code}
2812