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