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