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